-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathUCOPTS_2_7DEV.ini
More file actions
516 lines (481 loc) · 17.8 KB
/
UCOPTS_2_7DEV.ini
File metadata and controls
516 lines (481 loc) · 17.8 KB
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
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
;-----------------------------------------------------------------------
; NAME: UCOPTS_2_7DEV.ini
;
; ORIG: RussellDS - 05/12/2004
; DESC: PSL Compiler Environment Options Specification File
; DEST: Development environment at PSL code compliance level 2.7
; **********************************************************************
; **** DO NOT DELETE THIS FILE; IT IS NEEDED BY PSL ****
; **********************************************************************
;---- Comments ---------------------------------------------------------
; This file is derived from UCOPTS.ini to contain the settings that
; apply to a Development environment at PSL code compliance level 2.7.
;
; To use this file on a permanent basis, pull it from StarTeam into the
; application's root directory, and rename the file to UCOPTS.ini, then
; re-create UCOPTS.m as described below.
;
; To use the file as a temporary override, e.g. to validate that a PSL
; source module meets the requirements of this type of environment at
; this code compliance level, pull it from StarTeam, and point the
; environment variable $SCAU_UCOPTS to this file.
;
; This file defines PSL compiler options for a particular environment.
;
; The PSL bootstrap proces, that will be called by the Profile
; installation utilities, expects this file in the application's "top"
; directory, as specified by the environment variable SCAU_DIR.
; The bootstrap process will read and interpret this file to create the
; M routine UCOPTS. The UCOPTS routine will contain two entry points:
;
; void ^UCOPTS( String Options())
; This entrypoint defines the PSL compiler options for a
; particular environment. It is called by UCINIT^UCDTAUTL.
; Options that are not set up here are given default values by the
; caller.
;
; Primitive $$getPslValue^UCOPTS( String name)
; This function will return the value of the specified PSL
; property that is in effect in this environemnt.
; This function is called from several places in the PSL compiler,
; the SQL engine, and other code-generating Framework routines.
;
; If the options for a specific environment, e.g., a customer site, need
; to be customized, then perform the following steps:
; 1) modify THIS file
; 2) call bootUCOPTS^UCGMCU() to create a new UCOPTS routine
; 3) re-compile the application
;
; Although the proces that interprets the settings will deal with
; character case mismatches, it is strongly recommended to adhere to the
; exact spelling provided in this file.
;---- Revision History -------------------------------------------------
; 01/03/08 - Frans S.C. Witte - CR: 27800
; * Added #PSL Version and its description
; * Removed #OPTION AllowGOTO
; * Removed old history
;
; 08/31/06 - Frans S.C. Witte - CRs: 22720 / 22274
; Added standard setting for #OPTION ResultClass
;
; 04/28/06 - Frans S.C. Witte - CRs: 21394 / 21395
; Turned UCOPTS.proc into file UCOPTS.ini to be used to generate
; UCOPTS.m, and added support for INFO settings.
; **********************************************************************
; * PSL settings *
; **********************************************************************
;
; The PSL compiler relies on the certain environment settings in order
; to produce correct and consistent code. These settings are defined by
; the #PSL compiler command.
;
; Because the values of these settings are essential for the PSL
; compiler, the generated UCOPTS routine will contain code that returns
; a value for every #PSL setting described below, even if the UCOPTS.ini
; file does not contain an explicit value.
;
; The PSL compiler expects the following PSL settings:
;---- BooleanMask
; This setting is reserved to define the default mask for the future
; extensions Boolean.toString() and String.toBoolean().
;
; The special value "" indicates that the mask will be supplied by:
; SELECT MSK FROM DBCTLDVFM WHERE TYP='L'
; at compile time.
;
; resultClass = String, defaultValue = ""
;
; Recommended settings:
; - All Profile environments: ""
;
#PSL BooleanMask ""
;---- CompileSummary
; This setting specifies if the compiler shall provide a summary of the
; number of errors, warnings, and informational messages at the end of
; the compilation.
;
; resultClass = Boolean, defaultValue = true
;
; Recommended settings:
; - All environments: true
;
#PSL CompileSummary true
;---- DateMask
; This setting defines the default mask for Date.toString() and
; String.toDate(). Please consult the PSL Help for the layout of
; a date mask.
;
; The special value "" indicates that the mask will be supplied by:
; SELECT MSK FROM DBCTLDVFM WHERE TYP='D'
; at compile time.
;
; resultClass = String, defaultValue = ""
;
; Recommended settings:
; - All Profile environments: ""
;
#PSL DateMask ""
;---- TimeMask
; This setting defines the default mask for Time.toString(). Please
; consult the PSL Help for the layout of a time mask.
;
; The special value "" indicates that the mask will be supplied by:
; SELECT MSK FROM DBCTLDVFM WHERE TYP='T'
; at compile time.
;
; resultClass = String, defaultValue = ""
;
; Recommended settings:
; - All Profile environments: ""
;
#PSL TimeMask ""
;---- Version
; The PSL compiler expects source code to match a certain code
; compliance level, and is capable to compile PSL source code that
; matches a lower code compliance level than the PSL compiler itself.
; The code compliance level is a (PSL) Number between 2.6 and the
; current PSL compiler version (inclusive).
; Please refer to the PSL Help for a detailed list of PSL Versions.
;
; You can use a PSL V3.0 compiler to compile Profile V6.4 source code by
; setting the PSL Version to 2.6, and change a number of the #WARN and
; #OPTION settings (see the recommended settings of the individual
; entries). Code compliance level 2.6 is a virtual compliance level, not
; associated with any Profile release, specifically intended for this
; purpose.
; Note however that the SQL engine per Framework V2.7 will reject a
; number of DQ constructs that were replaced during the migration to
; Profile V7.0 and are no longer supported (such as [TABLE]COLUMN). This
; is likely to result in PSL compile errors for certain occurrences of
; the methods of the Db class.
;
; Never use Framework V3.0 to compile source code of Profile V6.3 or
; lower. It generates code that is substantially different from the code
; generated by the PSL compiler embedded in that Profile version. It is
; very unlikely that the M routines of that Profile version can interact
; with the code generated be the Framework V.30 compiler, even if the
; code compliance level is set to 2.6.
;
; Recommended Settings:
; - Profile Version 6.4: 2.6
; - Profile Version 7.0: 2.7
; - Profile Version 7.1: 2.7
; - Profile Version 7.2: 2.7
; - Profile Framework: 3
;
#PSL Version 2.7
; **********************************************************************
; * WARN settings *
; **********************************************************************
;
; The PSL compiler can supply warnings about potential problems in the
; source code. Every possible warning is categorized in a group. All
; warnings of a group can be turned on or off.
; Turning on a warning group will cause the compiler to print an
; appropriate warning messages if it encounters a condition in the
; specified group.
;
; Note that individual procedures, or sections of procedure code, can turn
; individual warning options on or off.
;
; The PSL compiler recognizes the following warning groups:
;---- ACCESS
; Subroutine not accessible by external routine
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for Version 6.4: OFF
; - Development environments for Version 7.0 and higher: ON
;
#WARN ACCESS ON
;---- BYPASS
; #BYPASS compiler command encountered
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN BYPASS ON
;---- DATABASE
; Method is not database independent
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN DATABASE ON
;---- DEAD
; Dead code
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN DEAD ON
;---- DEPRECATED
; Deprecated feature detected
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for Version 6.4: OFF
; - Development environments for Version 7.0 and higher: ON
;
#WARN DEPRECATED ON
;---- DYNAMIC
; Dynamic SQL statement or other dynamic construct
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN DYNAMIC ON
;---- FUNCTION
; Extrinsic function replaced
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments with code compliance level 2.6 or 2.7: OFF
; - Development environments with code compliance level 3: ON
;
#WARN FUNCTION OFF
;---- GLOBAL
; M Global Reference
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN GLOBAL ON
;---- LENGTH
; Indicates that a maximum length is exceeded.
; This will be reported for names of labels and names of routines.
; Note that exceeding the maximum length of a local variable name is
; considered an error if the subroutine contains another name that
; cannot be distinguished at the target language level.
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN LENGTH ON
;---- MISMATCH
; Parameter type mismatch in function or subroutine
; call, or datatype mismatch in assignment
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN MISMATCH ON
;---- PRECEDENCE
; Ambiguous operator precedence
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN PRECEDENCE ON
;---- READ
; Restricted command (READ)
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments with code compliance level 2.6 or 2.7: OFF
; - Development environments with code compliance level 3: ON
;
#WARN READ OFF
;---- RECEXISTS
; Possible runtime error RECEXISTS
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN RECEXISTS ON
;---- SCOPE
; Scope of variable is not defined
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for Version 6.4: OFF
; - Development environments for Version 7.0 and higher: ON
;
#WARN SCOPE ON
;---- SYNTAX
; A syntax error has been corrected by the compiler
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN SYNTAX ON
;---- SYSVAR
; Assigning system variable
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN SYSVAR ON
;---- XECUTE
; Restricted command - runtime Xecute
;
; Recommended settings:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#WARN XECUTE ON
; **********************************************************************
; * INFO settings *
; **********************************************************************
;
; The PSL compiler can supply information messages about the code that
; it will generate. Like warnings, all informational messages are
; categorized in groups. All messages of a group can be turned on or
; off.
; Turning on an information group will cause the compiler to print an
; appropriate information message if it encounters a condition in the
; specified group.
;
; Note that individual procedures, or sections of procedure code, can
; turn individual info options on or off.
;
; The INFO groups that are recognized by the PSL compiler are the same
; as the WARN groups listed above.
;
; Recommended settings for all INFO groups:
; - Production environments for all versions: OFF
; - Development environments for all versions: ON
;
#INFO * ON
; **********************************************************************
; * OPTIMIZE settings *
; **********************************************************************
;
; Indicates to PSL whether to optimize code or not.
;
; Note that individual procedures can turn this on or off.
;
; Options are:
;---- FUNCTIONS
; replace extrinsic or intrinsic functions by methods
;
; Recommended settings:
; - Production environments for all versions: ON
; - Development environments for all versions: ON
;
#OPTIMIZE FUNCTIONS ON
;---- OBJECTS
; Optimize access to objects by replacing vobj(,) entries by individual
; local variables. This option applies to instances of class ResultSet,
; and to all non-abstract descendants of class Record
;
; Recommended settings:
; - Production environments for all versions: ON
; - Development environments for all versions: ON
;
#OPTIMIZE OBJECTS ON
;
; **********************************************************************
; * Options settings *
; **********************************************************************
;
; In addition to WARN and OPTIMIZE options, the PSL compiler supports a
; number of miscelaneous options.
; Unlike WARN and OPTIMIZE settings, the spelling of #OPTION values is
; case sensitive.
;
; Note that individual procedures can turn this on or off.
;
; Options are:
;
;---- AutoPublicERRM
;
; Indicates that ER and RM should be considered automatically
; "type public". Prevents warnings regarding their undeclared use in
; earlier versions.
;
; Recommended settings:
; - Production environments for Version 6.4: ON
; - Production environments for Version 7.0 and higher: OFF
; - Development environments for Version 6.4: ON
; - Development environments for Version 7.0 and higher: OFF
;
#OPTION AutoPublicERRM OFF
;
;---- $GetEFD
;
; Indicates whether to convert %EffectiveDate references to $G(%EffectiveDate),
; and EFD references to $G(EFD).
;
; Recommended settings:
; - Production environments for Version 6.4: ON
; - Production environments for Version 7.0 and higher: OFF
; - Development environments for Version 6.4: ON
; - Development environments for Version 7.0 and higher: OFF
;
#OPTION $GetEFD OFF
;
;---- ResultClass
;
; Indicates whether PSL label declarations will specify the class of the
; result returned by the function (or void if the label does not return
; a value). The resultclass is specified after the optional access
; keyword and before the name of the label.
; PSL source code that specifies the ResultClass is syntactically
; incompatible with PSL source code that does not specify the
; ResultClass, so this option must be turned ON or OFF on a PSL source
; code function basis.
;
; Note that this setting is ignored and ON for Class Definition Modules.
;
; Recommended settings:
; - Production environments for Version 6.4: OFF
; - Production environments for Version 7.0 and higher: OFF
; - Development environments for Version 6.4: OFF
; - Development environments for Version 7.0 and higher: OFF
;
#OPTION ResultClass OFF
; **********************************************************************
; * PSL Property Value *
; **********************************************************************
;
; The PSL compiler uses a number of adjustable constants that are
; formally defined as properties of class PSL.
; Function $$getPslValue^UCOPTS() is used to retrieve the property
; values that apply for the current environment.
;
; The PSL compiler distinguishes multiple classes of property values.
; Values that are immutable for a given environment are not listed in
; this file. They will be included automatically in the generated UCOPTS
; routine.
;
;---- PSL.batchCommitCount
; For Oracle and other non-M databases, the logic that is generated
; for the Runtime.commit() method when transactionID="BA" provides
; the ability to delay commits to the underlying database until a
; specific number have been accumulated. This provides for improved
; performance.
;
#DEFINE batchCommitCount 500
;---- PSL.maxCacheSize
; This value indicates the maximum number of entries in a class Cache
; structure. When a Cache.getRecord or an implied incremental load will
; increase the number of nodes above this limits, the cache will be
; purged before the node is loaded.
;
#DEFINE maxCacheSize 100
;---- PSL.maxDataLength
; This value indicates the maximum length of that will be used when
; storing data in MDB tables. In particular, this value is used to
; split large data such as column values of type Memo and Blob.
; Please make sure that the value does not exceed limits imposed by the
; definition of the GT.M region that will store the data.
;
; If the environment is set up for UTF-8 encoded Unicode characters,
; please be aware of the fact that this value specifies the number of
; characters that are allowed in a data string. The actual number of
; bytes needed to store the string will be greater than the number of
; characters if the string does contain non-ASCII characters.
;
#DEFINE maxDataLength 450