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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
|
// 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 _Interface_MSG_HeaderFile
#define _Interface_MSG_HeaderFile
#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif
#ifndef _Standard_CString_HeaderFile
#include <Standard_CString.hxx>
#endif
#ifndef _Standard_PCharacter_HeaderFile
#include <Standard_PCharacter.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Standard_Real_HeaderFile
#include <Standard_Real.hxx>
#endif
#ifndef _Standard_IStream_HeaderFile
#include <Standard_IStream.hxx>
#endif
#ifndef _Standard_OStream_HeaderFile
#include <Standard_OStream.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class Standard_DomainError;
//! This class gives a set of functions to manage and use a list <br>
//! of translated messages (messagery) <br>
//! <br>
//! Keys are strings, their corresponding (i.e. translated) items <br>
//! are strings, managed by a dictionary (a global one). <br>
//! <br>
//! If the dictionary is not set, or if a key is not recorded, <br>
//! the key is returned as item, and it is possible to : <br>
//! - trace or not this fail, record or not it for further trace <br>
//! <br>
//! It is also possible to suspend the translation (keys are then <br>
//! always returned as items) <br>
//! <br>
//! This class also provides a file format for loading : <br>
//! It is made of couples of lines, the first one begins by '@' <br>
//! the following is the key, the second one is the message <br>
//! Lines which are empty or which begin by '@@' are skipped <br>
class Interface_MSG {
public:
void* operator new(size_t,void* anAddress)
{
return anAddress;
}
void* operator new(size_t size)
{
return Standard::Allocate(size);
}
void operator delete(void *anAddress)
{
if (anAddress) Standard::Free((Standard_Address&)anAddress);
}
//! A MSG is created to write a "functional code" in conjunction <br>
//! with operator () attached to Value <br>
//! Then, to have a translated message, write in C++ : <br>
//! <br>
//! Interface_MSG("...mykey...") which returns a CString <br>
//! See also some help which follow <br>
Standard_EXPORT Interface_MSG(const Standard_CString key);
//! Translates a message which contains one integer variable <br>
//! It is just a help which avoid the following : <br>
//! char mess[100]; sprintf(mess,Interface_MSG("code"),ival); <br>
//! then AddFail(mess); <br>
//! replaced by AddFail (Interface_MSG("code",ival)); <br>
//! <br>
//! The basic message is intended to be in C-sprintf format, <br>
//! with one %d form in it <br>
Standard_EXPORT Interface_MSG(const Standard_CString key,const Standard_Integer i1);
//! Translates a message which contains two integer variables <br>
//! As for one integer, it is just a writing help <br>
//! <br>
//! The basic message is intended to be in C-sprintf format <br>
//! with two %d forms in it <br>
Standard_EXPORT Interface_MSG(const Standard_CString key,const Standard_Integer i1,const Standard_Integer i2);
//! Translates a message which contains one real variable <br>
//! <intervals> if set, commands the variable to be rounded to an <br>
//! interval (see below, method Intervals) <br>
//! As for one integer, it is just a writing help <br>
//! <br>
//! The basic message is intended to be in C-sprintf format <br>
//! with one %f form (or equivalent : %e etc) in it <br>
Standard_EXPORT Interface_MSG(const Standard_CString key,const Standard_Real r1,const Standard_Integer intervals = -1);
//! Translates a message which contains one string variable <br>
//! As for one integer, it is just a writing help <br>
//! <br>
//! The basic message is intended to be in C-sprintf format <br>
//! with one %s form in it <br>
Standard_EXPORT Interface_MSG(const Standard_CString key,const Standard_CString str);
//! Translates a message which contains one integer and one <br>
//! string variables <br>
//! As for one integer, it is just a writing help <br>
//! Used for instance to say "Param n0.<ival> i.e. <str> is not.." <br>
//! <br>
//! The basic message is intended to be in C-sprintf format <br>
//! with one %d then one %s forms in it <br>
Standard_EXPORT Interface_MSG(const Standard_CString key,const Standard_Integer ival,const Standard_CString str);
//! Optimised destructor (applies for additional forms of Create) <br>
Standard_EXPORT void Destroy() ;
~Interface_MSG()
{
Destroy();
}
//! Returns the translated message, in a functional form with <br>
//! operator () <br>
//! was C++ : return const <br>
Standard_EXPORT Standard_CString Value() const;
operator Standard_CString() const;
//! Reads a list of messages from a stream, returns read count <br>
//! 0 means empty file, -1 means error <br>
Standard_EXPORT static Standard_Integer Read(Standard_IStream& S) ;
//! Reads a list of messages from a file defined by its name <br>
Standard_EXPORT static Standard_Integer Read(const Standard_CString file) ;
//! Writes the list of messages recorded to be translated, to a <br>
//! stream. Writes all the list (Default) or only keys which begin <br>
//! by <rootkey>. Returns the count of written messages <br>
Standard_EXPORT static Standard_Integer Write(Standard_OStream& S,const Standard_CString rootkey = "") ;
//! Returns True if a given message is surely a key <br>
//! (according to the form adopted for keys) <br>
//! (before activating messages, answer is false) <br>
Standard_EXPORT static Standard_Boolean IsKey(const Standard_CString mess) ;
//! Returns the item recorded for a key. <br>
//! Returns the key itself if : <br>
//! - it is not recorded (then, the trace system is activated) <br>
//! - MSG has been required to be hung on <br>
Standard_EXPORT static Standard_CString Translated(const Standard_CString key) ;
//! Fills the dictionary with a couple (key-item) <br>
//! If a key is already recorded, it is possible to : <br>
//! - keep the last definition, and activate the trace system <br>
Standard_EXPORT static void Record(const Standard_CString key,const Standard_CString item) ;
//! Sets the trace system to work when activated, as follow : <br>
//! - if <toprint> is True, print immediately on standard output <br>
//! - if <torecord> is True, record it for further print <br>
Standard_EXPORT static void SetTrace(const Standard_Boolean toprint,const Standard_Boolean torecord) ;
//! Sets the main modes for MSG : <br>
//! - if <running> is True, translation works normally <br>
//! - if <running> is False, translated item equate keys <br>
//! - if <raising> is True, errors (from Record or Translate) <br>
//! cause MSG to raise an exception <br>
//! - if <raising> is False, MSG runs without exception, then <br>
//! see also Trace Modes above <br>
Standard_EXPORT static void SetMode(const Standard_Boolean running,const Standard_Boolean raising) ;
//! Prints the recorded errors (without title; can be empty, this <br>
//! is the normally expected case) <br>
Standard_EXPORT static void PrintTrace(Standard_OStream& S) ;
//! Returns an "intervalled" value from a starting real <val> : <br>
//! i.e. a value which is rounded on an interval limit <br>
//! Interval limits are defined to be in a coarsely "geometric" <br>
//! progression (two successive intervals are inside a limit ratio) <br>
//! <br>
//! <order> gives the count of desired intervals in a range <1-10> <br>
//! <upper> False, returns the first lower interval (D) <br>
//! <upper> True, returns the first upper interval <br>
//! Values of Intervals according <order> : <br>
//! 0,1 : 1 10 100 ... <br>
//! 2 : 1 3 10 30 100 ... <br>
//! 3(D): 1 2 5 10 20 50 100 ... <br>
//! 4 : 1 2 3 6 10 20 30 60 100 ... <br>
//! 6 : 1 1.5 2 3 5 7 10 15 20 ... <br>
//! 10 : 1 1.2 1.5 2 2.5 3 4 5 6 8 10 12 15 20 25 ... <br>
Standard_EXPORT static Standard_Real Intervalled(const Standard_Real val,const Standard_Integer order = 3,const Standard_Boolean upper = Standard_False) ;
//! Codes a date as a text, from its numeric value (-> seconds) : <br>
//! YYYY-MM-DD:HH-MN-SS fixed format, completed by leading zeros <br>
//! Another format can be provided, as follows : <br>
//! C:%d ... C like format, preceeded by C: <br>
//! S:... format to call system (not yet implemented) <br>
Standard_EXPORT static void TDate(const Standard_CString text,const Standard_Integer yy,const Standard_Integer mm,const Standard_Integer dd,const Standard_Integer hh,const Standard_Integer mn,const Standard_Integer ss,const Standard_CString format = "") ;
//! Decodes a date to numeric integer values <br>
//! Returns True if OK, False if text does not fit with required <br>
//! format. Incomplete forms are allowed (for instance, for only <br>
//! YYYY-MM-DD, hour is zero) <br>
Standard_EXPORT static Standard_Boolean NDate(const Standard_CString text,Standard_Integer& yy,Standard_Integer& mm,Standard_Integer& dd,Standard_Integer& hh,Standard_Integer& mn,Standard_Integer& ss) ;
//! Returns a value about comparison of two dates <br>
//! 0 : equal. <0 text1 anterior. >0 text1 posterior <br>
Standard_EXPORT static Standard_Integer CDate(const Standard_CString text1,const Standard_CString text2) ;
//! Returns a blank string, of length between 0 and <max>, to fill <br>
//! the printing of a numeric value <val>, i.e. : <br>
//! If val < 10 , max-1 blanks <br>
//! If val between 10 and 99, max-2 blanks ... etc... <br>
Standard_EXPORT static Standard_CString Blanks(const Standard_Integer val,const Standard_Integer max) ;
//! Returns a blank string, to complete a given string <val> up to <br>
//! <max> characters : <br>
//! If strlen(val) is 0, max blanks <br>
//! If strlen(val) is 5, max-5 blanks etc... <br>
Standard_EXPORT static Standard_CString Blanks(const Standard_CString val,const Standard_Integer max) ;
//! Returns a blank string of <count> blanks (mini 0, maxi 76) <br>
Standard_EXPORT static Standard_CString Blanks(const Standard_Integer count) ;
//! Prints a String on an Output Stream, as follows : <br>
//! Accompagned with blanks, to give up to <max> charis at all, <br>
//! justified according just : <br>
//! -1 (D) : left 0 : center 1 : right <br>
//! Maximum 76 characters <br>
Standard_EXPORT static void Print(Standard_OStream& S,const Standard_CString val,const Standard_Integer max,const Standard_Integer just = -1) ;
protected:
private:
Standard_CString thekey;
Standard_PCharacter theval;
};
// other Inline functions and methods (like "C++: function call" methods)
#endif
|
