mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-09 13:22:24 +03:00
d5f74e42d6
License statement text corrected; compiler warnings caused by Bison 2.41 disabled for MSVC; a few other compiler warnings on 54-bit Windows eliminated by appropriate type cast Wrong license statements corrected in several files. Copyright and license statements added in XSD and GLSL files. Copyright year updated in some files. Obsolete documentation files removed from DrawResources.
225 lines
10 KiB
Plaintext
225 lines
10 KiB
Plaintext
-- Created on: 1995-03-08
|
|
-- Created by: Christian CAILLET
|
|
-- Copyright (c) 1995-1999 Matra Datavision
|
|
-- Copyright (c) 1999-2014 OPEN CASCADE SAS
|
|
--
|
|
-- This file is part of Open CASCADE Technology software library.
|
|
--
|
|
-- This library is free software; you can redistribute it and/or modify it under
|
|
-- the terms of the GNU Lesser General Public License version 2.1 as published
|
|
-- by the Free Software Foundation, with special exception defined in the file
|
|
-- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
-- distribution for complete text of the license and disclaimer of any warranty.
|
|
--
|
|
-- Alternatively, this file may be used under the terms of Open CASCADE
|
|
-- commercial license or contractual agreement.
|
|
|
|
class MSG from Interface
|
|
|
|
---Purpose : This class gives a set of functions to manage and use a list
|
|
-- of translated messages (messagery)
|
|
--
|
|
-- Keys are strings, their corresponding (i.e. translated) items
|
|
-- are strings, managed by a dictionary (a global one).
|
|
--
|
|
-- If the dictionary is not set, or if a key is not recorded,
|
|
-- the key is returned as item, and it is possible to :
|
|
-- - trace or not this fail, record or not it for further trace
|
|
--
|
|
-- It is also possible to suspend the translation (keys are then
|
|
-- always returned as items)
|
|
--
|
|
-- This class also provides a file format for loading :
|
|
-- It is made of couples of lines, the first one begins by '@'
|
|
-- the following is the key, the second one is the message
|
|
-- Lines which are empty or which begin by '@@' are skipped
|
|
|
|
|
|
uses Character, CString , OStream, IStream
|
|
|
|
raises DomainError
|
|
|
|
is
|
|
|
|
Create (key : CString) returns MSG;
|
|
---Purpose : A MSG is created to write a "functional code" in conjunction
|
|
-- with operator () attached to Value
|
|
-- Then, to have a translated message, write in C++ :
|
|
--
|
|
-- Interface_MSG("...mykey...") which returns a CString
|
|
-- See also some help which follow
|
|
|
|
Create (key : CString; i1 : Integer) returns MSG;
|
|
---Purpose : Translates a message which contains one integer variable
|
|
-- It is just a help which avoid the following :
|
|
-- char mess[100]; sprintf(mess,Interface_MSG("code"),ival);
|
|
-- then AddFail(mess);
|
|
-- replaced by AddFail (Interface_MSG("code",ival));
|
|
--
|
|
-- The basic message is intended to be in C-sprintf format,
|
|
-- with one %d form in it
|
|
|
|
Create (key : CString; i1,i2 : Integer) returns MSG;
|
|
---Purpose : Translates a message which contains two integer variables
|
|
-- As for one integer, it is just a writing help
|
|
--
|
|
-- The basic message is intended to be in C-sprintf format
|
|
-- with two %d forms in it
|
|
|
|
Create (key : CString; r1 : Real; intervals : Integer = -1) returns MSG;
|
|
---Purpose : Translates a message which contains one real variable
|
|
-- <intervals> if set, commands the variable to be rounded to an
|
|
-- interval (see below, method Intervals)
|
|
-- As for one integer, it is just a writing help
|
|
--
|
|
-- The basic message is intended to be in C-sprintf format
|
|
-- with one %f form (or equivalent : %e etc) in it
|
|
|
|
Create (key : CString; str : CString) returns MSG;
|
|
---Purpose : Translates a message which contains one string variable
|
|
-- As for one integer, it is just a writing help
|
|
--
|
|
-- The basic message is intended to be in C-sprintf format
|
|
-- with one %s form in it
|
|
|
|
Create (key : CString; ival : Integer; str : CString) returns MSG;
|
|
---Purpose : Translates a message which contains one integer and one
|
|
-- string variables
|
|
-- As for one integer, it is just a writing help
|
|
-- Used for instance to say "Param n0.<ival> i.e. <str> is not.."
|
|
--
|
|
-- The basic message is intended to be in C-sprintf format
|
|
-- with one %d then one %s forms in it
|
|
|
|
Destroy (me : in out);
|
|
---Purpose : Optimised destructor (applies for additional forms of Create)
|
|
---C++ : alias ~
|
|
|
|
Value (me) returns CString is static;
|
|
---Purpose : Returns the translated message, in a functional form with
|
|
-- operator ()
|
|
-- was C++ : return const
|
|
---C++ : alias "operator Standard_CString() const;"
|
|
|
|
Read (myclass; S : in out IStream) returns Integer;
|
|
---Purpose : Reads a list of messages from a stream, returns read count
|
|
-- 0 means empty file, -1 means error
|
|
|
|
Read (myclass; file : CString) returns Integer;
|
|
---Purpose : Reads a list of messages from a file defined by its name
|
|
|
|
Write (myclass; S : in out OStream; rootkey : CString = "") returns Integer;
|
|
---Purpose : Writes the list of messages recorded to be translated, to a
|
|
-- stream. Writes all the list (Default) or only keys which begin
|
|
-- by <rootkey>. Returns the count of written messages
|
|
|
|
IsKey (myclass; mess : CString) returns Boolean;
|
|
---Purpose : Returns True if a given message is surely a key
|
|
-- (according to the form adopted for keys)
|
|
-- (before activating messages, answer is false)
|
|
|
|
Translated (myclass; key : CString) returns CString
|
|
---Purpose : Returns the item recorded for a key.
|
|
-- Returns the key itself if :
|
|
-- - it is not recorded (then, the trace system is activated)
|
|
-- - MSG has been required to be hung on
|
|
raises DomainError;
|
|
-- Raises an exception if not found and if <raising> mode is True
|
|
|
|
Record (myclass; key : CString; item : CString)
|
|
---Purpose : Fills the dictionary with a couple (key-item)
|
|
-- If a key is already recorded, it is possible to :
|
|
-- - keep the last definition, and activate the trace system
|
|
raises DomainError;
|
|
-- - or raise an exception
|
|
|
|
SetTrace (myclass; toprint, torecord : Boolean);
|
|
---Purpose : Sets the trace system to work when activated, as follow :
|
|
-- - if <toprint> is True, print immediately on standard output
|
|
-- - if <torecord> is True, record it for further print
|
|
|
|
SetMode (myclass; running, raising : Boolean);
|
|
---Purpose : Sets the main modes for MSG :
|
|
-- - if <running> is True, translation works normally
|
|
-- - if <running> is False, translated item equate keys
|
|
-- - if <raising> is True, errors (from Record or Translate)
|
|
-- cause MSG to raise an exception
|
|
-- - if <raising> is False, MSG runs without exception, then
|
|
-- see also Trace Modes above
|
|
|
|
PrintTrace (myclass; S : in out OStream);
|
|
---Purpose : Prints the recorded errors (without title; can be empty, this
|
|
-- is the normally expected case)
|
|
|
|
-- some helps : printing rounded floating values
|
|
|
|
Intervalled (myclass; val : Real; order : Integer = 3;
|
|
upper : Boolean = Standard_False)
|
|
returns Real;
|
|
---Purpose : Returns an "intervalled" value from a starting real <val> :
|
|
-- i.e. a value which is rounded on an interval limit
|
|
-- Interval limits are defined to be in a coarsely "geometric"
|
|
-- progression (two successive intervals are inside a limit ratio)
|
|
--
|
|
-- <order> gives the count of desired intervals in a range <1-10>
|
|
-- <upper> False, returns the first lower interval (D)
|
|
-- <upper> True, returns the first upper interval
|
|
-- Values of Intervals according <order> :
|
|
-- 0,1 : 1 10 100 ...
|
|
-- 2 : 1 3 10 30 100 ...
|
|
-- 3(D): 1 2 5 10 20 50 100 ...
|
|
-- 4 : 1 2 3 6 10 20 30 60 100 ...
|
|
-- 6 : 1 1.5 2 3 5 7 10 15 20 ...
|
|
-- 10 : 1 1.2 1.5 2 2.5 3 4 5 6 8 10 12 15 20 25 ...
|
|
|
|
-- coding/decoding dates with strings --
|
|
|
|
TDate (myclass; text : CString; yy,mm,dd,hh,mn,ss : Integer;
|
|
format : CString = "");
|
|
---Purpose : Codes a date as a text, from its numeric value (-> seconds) :
|
|
-- YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros
|
|
-- Another format can be provided, as follows :
|
|
-- C:%d ... C like format, preceeded by C:
|
|
-- S:... format to call system (not yet implemented)
|
|
|
|
NDate (myclass; text : CString; yy,mm,dd,hh,mn,ss : out Integer) returns Boolean;
|
|
---Purpose : Decodes a date to numeric integer values
|
|
-- Returns True if OK, False if text does not fit with required
|
|
-- format. Incomplete forms are allowed (for instance, for only
|
|
-- YYYY-MM-DD, hour is zero)
|
|
|
|
CDate (myclass; text1, text2 : CString) returns Integer;
|
|
---Purpose : Returns a value about comparison of two dates
|
|
-- 0 : equal. <0 text1 anterior. >0 text1 posterior
|
|
|
|
Blanks (myclass; val : Integer; max : Integer) returns CString;
|
|
---Purpose : Returns a blank string, of length between 0 and <max>, to fill
|
|
-- the printing of a numeric value <val>, i.e. :
|
|
-- If val < 10 , max-1 blanks
|
|
-- If val between 10 and 99, max-2 blanks ... etc...
|
|
|
|
Blanks (myclass; val : CString; max : Integer) returns CString;
|
|
---Purpose : Returns a blank string, to complete a given string <val> up to
|
|
-- <max> characters :
|
|
-- If strlen(val) is 0, max blanks
|
|
-- If strlen(val) is 5, max-5 blanks etc...
|
|
|
|
Blanks (myclass; count : Integer) returns CString;
|
|
---Purpose : Returns a blank string of <count> blanks (mini 0, maxi 76)
|
|
|
|
Print (myclass; S : in out OStream;
|
|
val : CString; max : Integer; just : Integer = -1);
|
|
---Purpose : Prints a String on an Output Stream, as follows :
|
|
-- Accompagned with blanks, to give up to <max> charis at all,
|
|
-- justified according just :
|
|
-- -1 (D) : left 0 : center 1 : right
|
|
-- Maximum 76 characters
|
|
|
|
fields
|
|
|
|
thekey : CString;
|
|
theval : PCharacter; -- only if translation is done
|
|
-- thecont : Character[30]; -- for a short local definition
|
|
|
|
end MSG;
|