/usr/include/oce/Message_MsgFile.hxx is in liboce-foundation-dev 0.17.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | // This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to
// this header file considered to be the "object code" form of the original source.
#ifndef _Message_MsgFile_HeaderFile
#define _Message_MsgFile_HeaderFile
#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Macro.hxx>
#include <Standard_Boolean.hxx>
#include <Standard_CString.hxx>
class TCollection_AsciiString;
class TCollection_ExtendedString;
//! A tool providing facility to load definitions of message strings from
//! resource file(s).
//!
//! The message file is an ASCII file which defines a set of messages.
//! Each message is identified by its keyword (string).
//!
//! All lines in the file starting with the exclamation sign
//! (perhaps preceeding by spaces and/or tabs) are ignored as comments.
//!
//! Each line in the file starting with the dot character "."
//! (perhaps preceeding by spaces and/or tabs) defines the keyword.
//! The keyword is a string starting from the next symbol after dot
//! and ending at the symbol preceeding ending newline character "\n".
//!
//! All the lines in the file after the keyword and before next
//! keyword (and which are not comments) define the message for that
//! keyword. If the message consists of several lines, the message
//! string will contain newline symbols "\n" between parts (but not
//! at the end).
//!
//! The experimental support of Unicode message files is provided.
//! These are distinguished by two bytes FF.FE or FE.FF at the beginning.
//!
//! The loaded messages are stored in static data map; all methods of that
//! class are also static.
class Message_MsgFile
{
public:
DEFINE_STANDARD_ALLOC
//! Load message file <theFileName> from directory <theDirName>
//! or its sub-directory
Standard_EXPORT static Standard_Boolean Load (const Standard_CString theDirName, const Standard_CString theFileName) ;
//! Load the messages from the given file, additive to any previously
//! loaded messages. Messages with same keywords, if already present,
//! are replaced with the new ones.
Standard_EXPORT static Standard_Boolean LoadFile (const Standard_CString theFName) ;
//! Loads the messages from the file with name (without extension)
//! given by environment variable.
//! Extension of the file name is given separately. If its not
//! defined, it is taken:
//! - by default from environment CSF_LANGUAGE,
//! - if not defined either, as "us".
Standard_EXPORT static void LoadFromEnv (const Standard_CString envname, const Standard_CString filename, const Standard_CString ext = "") ;
//! Adds new message to the map. Parameter <key> gives
//! the key of the message, <text> defines the message itself.
//! If there already was defined the message identified by the
//! same keyword, it is replaced with the new one.
Standard_EXPORT static Standard_Boolean AddMsg (const TCollection_AsciiString& key, const TCollection_ExtendedString& text) ;
//! Returns True if message with specified keyword is registered
Standard_EXPORT static Standard_Boolean HasMsg (const TCollection_AsciiString& key) ;
Standard_EXPORT static const TCollection_ExtendedString& Msg (const Standard_CString key) ;
//! Gives the text for the message identified by the keyword <key>
//! If there are no messages with such keyword defined,
//! the error message is returned.
//! In that case reference to static string is returned, it can
//! be chenged with next call(s) to Msg().
//! Note: The error message is constructed like 'Unknown message: <key>', and can
//! itself be customized by defining message with key Message_Msg_BadKeyword.
Standard_EXPORT static const TCollection_ExtendedString& Msg (const TCollection_AsciiString& key) ;
protected:
private:
};
#endif // _Message_MsgFile_HeaderFile
|