mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-05-15 13:48:57 +08:00
96 lines
4.7 KiB
Plaintext
Executable File
96 lines
4.7 KiB
Plaintext
Executable File
-- Created on: 2001-04-26
|
|
-- Created by: OCC Team
|
|
-- Copyright (c) 2001-2012 OPEN CASCADE SAS
|
|
--
|
|
-- The content of this file is subject to the Open CASCADE Technology Public
|
|
-- License Version 6.5 (the "License"). You may not use the content of this file
|
|
-- except in compliance with the License. Please obtain a copy of the License
|
|
-- at http://www.opencascade.org and read it completely before using this file.
|
|
--
|
|
-- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
|
|
-- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
|
|
--
|
|
-- The Original Code and all software distributed under the License is
|
|
-- distributed on an "AS IS" basis, without warranty of any kind, and the
|
|
-- Initial Developer hereby disclaims all such warranties, including without
|
|
-- limitation, any warranties of merchantability, fitness for a particular
|
|
-- purpose or non-infringement. Please see the License for the specific terms
|
|
-- and conditions governing the rights and limitations under the License.
|
|
|
|
|
|
|
|
class MsgFile from Message
|
|
|
|
---Purpose: 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.
|
|
|
|
uses
|
|
|
|
CString,
|
|
AsciiString from TCollection,
|
|
ExtendedString from TCollection
|
|
|
|
is
|
|
|
|
Load (myclass; theDirName, theFileName: CString) returns Boolean;
|
|
---Purpose: Load message file <theFileName> from directory <theDirName>
|
|
-- or its sub-directory
|
|
|
|
|
|
LoadFile (myclass; theFName: CString) returns Boolean;
|
|
---Purpose: 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.
|
|
|
|
LoadFromEnv (myclass; envname: CString; filename: CString; ext: CString = "");
|
|
---Purpose: 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".
|
|
|
|
AddMsg (myclass; key: AsciiString from TCollection;
|
|
text: ExtendedString from TCollection) returns Boolean;
|
|
---Purpose: 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.
|
|
|
|
Msg (myclass; key: CString) returns ExtendedString from TCollection;
|
|
---C++: return const &
|
|
Msg (myclass; key: AsciiString from TCollection) returns ExtendedString from TCollection;
|
|
---C++: return const &
|
|
---Purpose: 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.
|
|
|
|
end MsgFile;
|