/
FlagsUtil.mo
1908 lines (1751 loc) · 65.5 KB
/
FlagsUtil.mo
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
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-CurrentYear, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
encapsulated package FlagsUtil
" file: FlagsUtil.mo
package: FlagsUtil
description: Tools for using compiler flags.
This package contains function for using the compiler flags in Flags.mo."
import Flags;
protected
import Corba;
import Error;
import ErrorExt;
import Global;
import List;
import Print;
import Settings;
import StringUtil;
import System;
import Util;
// This is a list of all debug flags, to keep track of which flags are used. A
// flag can not be used unless it's in this list, and the list is checked at
// initialization so that all flags are sorted by index (and thus have unique
// indices).
protected
constant list<Flags.DebugFlag> allDebugFlags = {
Flags.FAILTRACE,
Flags.CEVAL,
Flags.CHECK_BACKEND_DAE,
Flags.PARMODAUTO,
Flags.PTHREADS,
Flags.EVENTS,
Flags.DUMP_INLINE_SOLVER,
Flags.EVAL_FUNC,
Flags.GEN,
Flags.DYN_LOAD,
Flags.GENERATE_CODE_CHEAT,
Flags.CGRAPH_GRAPHVIZ_FILE,
Flags.CGRAPH_GRAPHVIZ_SHOW,
Flags.GC_PROF,
Flags.CHECK_DAE_CREF_TYPE,
Flags.CHECK_ASUB,
Flags.INSTANCE,
Flags.CACHE,
Flags.RML,
Flags.TAIL,
Flags.LOOKUP,
Flags.PATTERNM_SKIP_FILTER_UNUSED_AS_BINDINGS,
Flags.PATTERNM_ALL_INFO,
Flags.PATTERNM_DCE,
Flags.PATTERNM_MOVE_LAST_EXP,
Flags.EXPERIMENTAL_REDUCTIONS,
Flags.EVAL_PARAM,
Flags.TYPES,
Flags.SHOW_STATEMENT,
Flags.DUMP,
Flags.DUMP_GRAPHVIZ,
Flags.EXEC_STAT,
Flags.TRANSFORMS_BEFORE_DUMP,
Flags.DAE_DUMP_GRAPHV,
Flags.INTERACTIVE_TCP,
Flags.INTERACTIVE_CORBA,
Flags.INTERACTIVE_DUMP,
Flags.RELIDX,
Flags.DUMP_REPL,
Flags.DUMP_FP_REPL,
Flags.DUMP_PARAM_REPL,
Flags.DUMP_PP_REPL,
Flags.DUMP_EA_REPL,
Flags.DEBUG_ALIAS,
Flags.TEARING_DUMP,
Flags.JAC_DUMP,
Flags.JAC_DUMP2,
Flags.JAC_DUMP_EQN,
Flags.JAC_WARNINGS,
Flags.DUMP_SPARSE,
Flags.DUMP_SPARSE_VERBOSE,
Flags.BLT_DUMP,
Flags.DUMMY_SELECT,
Flags.DUMP_DAE_LOW,
Flags.DUMP_INDX_DAE,
Flags.OPT_DAE_DUMP,
Flags.EXEC_HASH,
Flags.PARAM_DLOW_DUMP,
Flags.DUMP_ENCAPSULATECONDITIONS,
Flags.ON_RELAXATION,
Flags.SHORT_OUTPUT,
Flags.COUNT_OPERATIONS,
Flags.CGRAPH,
Flags.UPDMOD,
Flags.STATIC,
Flags.TPL_PERF_TIMES,
Flags.CHECK_SIMPLIFY,
Flags.SCODE_INST,
Flags.WRITE_TO_BUFFER,
Flags.DUMP_BACKENDDAE_INFO,
Flags.GEN_DEBUG_SYMBOLS,
Flags.DUMP_STATESELECTION_INFO,
Flags.DUMP_EQNINORDER,
Flags.SEMILINEAR,
Flags.UNCERTAINTIES,
Flags.SHOW_START_ORIGIN,
Flags.DUMP_SIMCODE,
Flags.DUMP_INITIAL_SYSTEM,
Flags.GRAPH_INST,
Flags.GRAPH_INST_RUN_DEP,
Flags.GRAPH_INST_GEN_GRAPH,
Flags.GRAPH_INST_SHOW_GRAPH,
Flags.DUMP_CONST_REPL,
Flags.SHOW_EQUATION_SOURCE,
Flags.LS_ANALYTIC_JACOBIAN,
Flags.NLS_ANALYTIC_JACOBIAN,
Flags.INLINE_SOLVER,
Flags.HPCOM,
Flags.INITIALIZATION,
Flags.INLINE_FUNCTIONS,
Flags.DUMP_SCC_GRAPHML,
Flags.TEARING_DUMPVERBOSE,
Flags.DISABLE_SINGLE_FLOW_EQ,
Flags.DUMP_DISCRETEVARS_INFO,
Flags.ADDITIONAL_GRAPHVIZ_DUMP,
Flags.INFO_XML_OPERATIONS,
Flags.HPCOM_DUMP,
Flags.RESOLVE_LOOPS_DUMP,
Flags.DISABLE_WINDOWS_PATH_CHECK_WARNING,
Flags.DISABLE_RECORD_CONSTRUCTOR_OUTPUT,
Flags.DUMP_TRANSFORMED_MODELICA_MODEL,
Flags.EVALUATE_CONST_FUNCTIONS,
Flags.IMPL_ODE,
Flags.EVAL_FUNC_DUMP,
Flags.PRINT_STRUCTURAL,
Flags.ITERATION_VARS,
Flags.ALLOW_RECORD_TOO_MANY_FIELDS,
Flags.HPCOM_MEMORY_OPT,
Flags.DUMP_SYNCHRONOUS,
Flags.STRIP_PREFIX,
Flags.DO_SCODE_DEP,
Flags.SHOW_INST_CACHE_INFO,
Flags.DUMP_UNIT,
Flags.DUMP_EQ_UNIT,
Flags.DUMP_EQ_UNIT_STRUCT,
Flags.SHOW_DAE_GENERATION,
Flags.RESHUFFLE_POST,
Flags.SHOW_EXPANDABLE_INFO,
Flags.DUMP_HOMOTOPY,
Flags.OMC_RELOCATABLE_FUNCTIONS,
Flags.GRAPHML,
Flags.USEMPI,
Flags.DUMP_CSE,
Flags.DUMP_CSE_VERBOSE,
Flags.ADD_DER_ALIASES,
Flags.DISABLE_COMSUBEXP,
Flags.NO_START_CALC,
Flags.NO_PARTITIONING,
Flags.CONSTJAC,
Flags.REDUCE_DYN_OPT,
Flags.VISUAL_XML,
Flags.ADD_SCALED_VARS,
Flags.ADD_SCALED_VARS_INPUT,
Flags.VECTORIZE,
Flags.CHECK_EXT_LIBS,
Flags.RUNTIME_STATIC_LINKING,
Flags.SORT_EQNS_AND_VARS,
Flags.DUMP_SIMPLIFY_LOOPS,
Flags.DUMP_RTEARING,
Flags.DIS_SIMP_FUN,
Flags.DIS_SYMJAC_FMI20,
Flags.EVAL_OUTPUT_ONLY,
Flags.HARDCODED_START_VALUES,
Flags.DUMP_FUNCTIONS,
Flags.DEBUG_DIFFERENTIATION,
Flags.DEBUG_DIFFERENTIATION_VERBOSE,
Flags.FMU_EXPERIMENTAL,
Flags.DUMP_DGESV,
Flags.MULTIRATE_PARTITION,
Flags.DUMP_EXCLUDED_EXP,
Flags.DEBUG_ALGLOOP_JACOBIAN,
Flags.DISABLE_JACSCC,
Flags.FORCE_NLS_ANALYTIC_JACOBIAN,
Flags.DUMP_LOOPS,
Flags.DUMP_LOOPS_VERBOSE,
Flags.SKIP_INPUT_OUTPUT_SYNTACTIC_SUGAR,
Flags.OMC_RECORD_ALLOC_WORDS,
Flags.TOTAL_TEARING_DUMP,
Flags.TOTAL_TEARING_DUMPVERBOSE,
Flags.PARALLEL_CODEGEN,
Flags.SERIALIZED_SIZE,
Flags.BACKEND_KEEP_ENV_GRAPH,
Flags.DUMPBACKENDINLINE,
Flags.DUMPBACKENDINLINE_VERBOSE,
Flags.BLT_MATRIX_DUMP,
Flags.LIST_REVERSE_WRONG_ORDER,
Flags.PARTITION_INITIALIZATION,
Flags.EVAL_PARAM_DUMP,
Flags.NF_UNITCHECK,
Flags.DISABLE_COLORING,
Flags.MERGE_ALGORITHM_SECTIONS,
Flags.WARN_NO_NOMINAL,
Flags.REDUCE_DAE,
Flags.IGNORE_CYCLES,
Flags.ALIAS_CONFLICTS,
Flags.SUSAN_MATCHCONTINUE_DEBUG,
Flags.OLD_FE_UNITCHECK,
Flags.EXEC_STAT_EXTRA_GC,
Flags.DEBUG_DAEMODE,
Flags.NF_SCALARIZE,
Flags.NF_EVAL_CONST_ARG_FUNCS,
Flags.NF_EXPAND_OPERATIONS,
Flags.NF_API,
Flags.NF_API_DYNAMIC_SELECT,
Flags.NF_API_NOISE,
Flags.FMI20_DEPENDENCIES,
Flags.WARNING_MINMAX_ATTRIBUTES,
Flags.NF_EXPAND_FUNC_ARGS,
Flags.DUMP_JL,
Flags.DUMP_ASSC,
Flags.SPLIT_CONSTANT_PARTS_SYMJAC,
Flags.NF_DUMP_FLAT,
Flags.DUMP_FORCE_FMI_ATTRIBUTES,
Flags.DUMP_DATARECONCILIATION,
Flags.ARRAY_CONNECT,
Flags.ZMQ_LISTEN_TO_ALL
};
protected
// This is a list of all configuration flags. A flag can not be used unless it's
// in this list, and the list is checked at initialization so that all flags are
// sorted by index (and thus have unique indices).
constant list<Flags.ConfigFlag> allConfigFlags = {
Flags.DEBUG,
Flags.HELP,
Flags.RUNNING_TESTSUITE,
Flags.SHOW_VERSION,
Flags.TARGET,
Flags.GRAMMAR,
Flags.ANNOTATION_VERSION,
Flags.LANGUAGE_STANDARD,
Flags.SHOW_ERROR_MESSAGES,
Flags.SHOW_ANNOTATIONS,
Flags.NO_SIMPLIFY,
Flags.PRE_OPT_MODULES,
Flags.CHEAPMATCHING_ALGORITHM,
Flags.MATCHING_ALGORITHM,
Flags.INDEX_REDUCTION_METHOD,
Flags.POST_OPT_MODULES,
Flags.SIMCODE_TARGET,
Flags.ORDER_CONNECTIONS,
Flags.TYPE_INFO,
Flags.KEEP_ARRAYS,
Flags.MODELICA_OUTPUT,
Flags.SILENT,
Flags.CORBA_SESSION,
Flags.NUM_PROC,
Flags.LATENCY,
Flags.BANDWIDTH,
Flags.INST_CLASS,
Flags.VECTORIZATION_LIMIT,
Flags.SIMULATION_CG,
Flags.EVAL_PARAMS_IN_ANNOTATIONS,
Flags.CHECK_MODEL,
Flags.CEVAL_EQUATION,
Flags.UNIT_CHECKING,
Flags.TRANSLATE_DAE_STRING,
Flags.GENERATE_LABELED_SIMCODE,
Flags.REDUCE_TERMS,
Flags.REDUCTION_METHOD,
Flags.DEMO_MODE,
Flags.LOCALE_FLAG,
Flags.DEFAULT_OPENCL_DEVICE,
Flags.MAXTRAVERSALS,
Flags.DUMP_TARGET,
Flags.DELAY_BREAK_LOOP,
Flags.TEARING_METHOD,
Flags.TEARING_HEURISTIC,
Flags.DISABLE_LINEAR_TEARING,
Flags.SCALARIZE_MINMAX,
Flags.STRICT,
Flags.SCALARIZE_BINDINGS,
Flags.CORBA_OBJECT_REFERENCE_FILE_PATH,
Flags.HPCOM_SCHEDULER,
Flags.HPCOM_CODE,
Flags.REWRITE_RULES_FILE,
Flags.REPLACE_HOMOTOPY,
Flags.GENERATE_SYMBOLIC_JACOBIAN,
Flags.GENERATE_SYMBOLIC_LINEARIZATION,
Flags.INT_ENUM_CONVERSION,
Flags.PROFILING_LEVEL,
Flags.RESHUFFLE,
Flags.GENERATE_DYN_OPTIMIZATION_PROBLEM,
Flags.CSE_CALL,
Flags.CSE_BINARY,
Flags.CSE_EACHCALL,
Flags.MAX_SIZE_FOR_SOLVE_LINIEAR_SYSTEM,
Flags.CPP_FLAGS,
Flags.REMOVE_SIMPLE_EQUATIONS,
Flags.DYNAMIC_TEARING,
Flags.SYM_SOLVER,
Flags.ADD_TIME_AS_STATE,
Flags.LOOP2CON,
Flags.FORCE_TEARING,
Flags.SIMPLIFY_LOOPS,
Flags.RTEARING,
Flags.FLOW_THRESHOLD,
Flags.MATRIX_FORMAT,
Flags.PARTLINTORN,
Flags.INIT_OPT_MODULES,
Flags.MAX_MIXED_DETERMINED_INDEX,
Flags.USE_LOCAL_DIRECTION,
Flags.DEFAULT_OPT_MODULES_ORDERING,
Flags.PRE_OPT_MODULES_ADD,
Flags.PRE_OPT_MODULES_SUB,
Flags.POST_OPT_MODULES_ADD,
Flags.POST_OPT_MODULES_SUB,
Flags.INIT_OPT_MODULES_ADD,
Flags.INIT_OPT_MODULES_SUB,
Flags.PERMISSIVE,
Flags.HETS,
Flags.DEFAULT_CLOCK_PERIOD,
Flags.INST_CACHE_SIZE,
Flags.MAX_SIZE_LINEAR_TEARING,
Flags.MAX_SIZE_NONLINEAR_TEARING,
Flags.NO_TEARING_FOR_COMPONENT,
Flags.CT_STATE_MACHINES,
Flags.DAE_MODE,
Flags.INLINE_METHOD,
Flags.SET_TEARING_VARS,
Flags.SET_RESIDUAL_EQNS,
Flags.IGNORE_COMMAND_LINE_OPTIONS_ANNOTATION,
Flags.CALCULATE_SENSITIVITIES,
Flags.ALARM,
Flags.TOTAL_TEARING,
Flags.IGNORE_SIMULATION_FLAGS_ANNOTATION,
Flags.DYNAMIC_TEARING_FOR_INITIALIZATION,
Flags.PREFER_TVARS_WITH_START_VALUE,
Flags.EQUATIONS_PER_FILE,
Flags.EVALUATE_FINAL_PARAMS,
Flags.EVALUATE_PROTECTED_PARAMS,
Flags.REPLACE_EVALUATED_PARAMS,
Flags.CONDENSE_ARRAYS,
Flags.WFC_ADVANCED,
Flags.GRAPHICS_EXP_MODE,
Flags.TEARING_STRICTNESS,
Flags.INTERACTIVE,
Flags.ZEROMQ_FILE_SUFFIX,
Flags.HOMOTOPY_APPROACH,
Flags.IGNORE_REPLACEABLE,
Flags.LABELED_REDUCTION,
Flags.DISABLE_EXTRA_LABELING,
Flags.LOAD_MSL_MODEL,
Flags.Load_PACKAGE_FILE,
Flags.BUILDING_FMU,
Flags.BUILDING_MODEL,
Flags.POST_OPT_MODULES_DAE,
Flags.EVAL_LOOP_LIMIT,
Flags.EVAL_RECURSION_LIMIT,
Flags.SINGLE_INSTANCE_AGLSOLVER,
Flags.SHOW_STRUCTURAL_ANNOTATIONS,
Flags.INITIAL_STATE_SELECTION,
Flags.LINEARIZATION_DUMP_LANGUAGE,
Flags.NO_ASSC,
Flags.FULL_ASSC,
Flags.MAX_SIZE_ASSC,
Flags.USE_ZEROMQ_IN_SIM,
Flags.ZEROMQ_PUB_PORT,
Flags.ZEROMQ_SUB_PORT,
Flags.ZEROMQ_JOB_ID,
Flags.ZEROMQ_SERVER_ID,
Flags.ZEROMQ_CLIENT_ID,
Flags.FMI_VERSION,
Flags.FLAT_MODELICA,
Flags.FMI_FILTER,
Flags.FMI_SOURCES,
Flags.FMI_FLAGS,
Flags.NEW_BACKEND,
Flags.INTERACTIVE_PORT
};
public function new
"Create a new flags structure and read the given arguments."
input list<String> inArgs;
output list<String> outArgs;
algorithm
_ := loadFlags();
outArgs := readArgs(inArgs);
end new;
public function saveFlags
"Saves the flags with setGlobalRoot."
input Flags.Flag inFlags;
algorithm
setGlobalRoot(Global.flagsIndex, inFlags);
end saveFlags;
protected function createConfigFlags
output array<Flags.FlagData> configFlags;
algorithm
configFlags := listArray(list(flag.defaultValue for flag in allConfigFlags));
end createConfigFlags;
protected function createDebugFlags
output array<Boolean> debugFlags;
algorithm
debugFlags := listArray(list(flag.default for flag in allDebugFlags));
end createDebugFlags;
public function loadFlags
"Loads the flags with getGlobalRoot. Creates a new flags structure if it
hasn't been created yet."
input Boolean initialize = true;
output Flags.Flag flags;
algorithm
try
flags := Flags.getFlags();
else
if initialize then
checkDebugFlags();
checkConfigFlags();
flags := Flags.FLAGS(createDebugFlags(), createConfigFlags());
saveFlags(flags);
else
print("Flag loading failed!\n");
flags := Flags.NO_FLAGS();
end if;
end try;
end loadFlags;
public function backupFlags
"Creates a copy of the existing flags."
output Flags.Flag outFlags;
protected
array<Boolean> debug_flags;
array<Flags.FlagData> config_flags;
algorithm
Flags.FLAGS(debug_flags, config_flags) := loadFlags();
outFlags := Flags.FLAGS(arrayCopy(debug_flags), arrayCopy(config_flags));
end backupFlags;
public function resetDebugFlags
"Resets all debug flags to their default values."
protected
array<Boolean> debug_flags;
array<Flags.FlagData> config_flags;
algorithm
Flags.FLAGS(_, config_flags) := loadFlags();
debug_flags := createDebugFlags();
saveFlags(Flags.FLAGS(debug_flags, config_flags));
end resetDebugFlags;
public function resetConfigFlags
"Resets all configuration flags to their default values."
protected
array<Boolean> debug_flags;
array<Flags.FlagData> config_flags;
algorithm
Flags.FLAGS(debug_flags, _) := loadFlags();
config_flags := createConfigFlags();
saveFlags(Flags.FLAGS(debug_flags, config_flags));
end resetConfigFlags;
protected function checkDebugFlags
"Checks that the flags listed in allDebugFlags have sequential and unique indices."
protected
Integer index = 0;
String err_str;
algorithm
for flag in allDebugFlags loop
index := index + 1;
// If the flag indices are borked, print an error and terminate the compiler.
// Only failing here could cause an infinite loop of trying to load the flags.
if flag.index <> index then
err_str := "Invalid flag '" + flag.name + "' with index " + String(flag.index) + " (expected " + String(index) +
") in Flags.allDebugFlags. Make sure that all flags are present and ordered correctly!";
Error.terminateError(err_str, sourceInfo());
end if;
end for;
end checkDebugFlags;
protected function checkConfigFlags
"Checks that the flags listed in allConfigFlags have sequential and unique indices."
protected
Integer index = 0;
String err_str;
algorithm
for flag in allConfigFlags loop
index := index + 1;
// If the flag indices are borked, print an error and terminate the compiler.
// Only failing here could cause an infinite loop of trying to load the flags.
if flag.index <> index then
err_str := "Invalid flag '" + flag.name + "' with index " + String(flag.index) + " (expected " + String(index) +
") in Flags.allConfigFlags. Make sure that all flags are present and ordered correctly!";
Error.terminateError(err_str, sourceInfo());
end if;
end for;
end checkConfigFlags;
public function set
"Sets the value of a debug flag, and returns the old value."
input Flags.DebugFlag inFlag;
input Boolean inValue;
output Boolean outOldValue;
protected
array<Boolean> debug_flags;
array<Flags.FlagData> config_flags;
algorithm
Flags.FLAGS(debug_flags, config_flags) := loadFlags();
(debug_flags, outOldValue) := updateDebugFlagArray(debug_flags, inValue, inFlag);
saveFlags(Flags.FLAGS(debug_flags, config_flags));
end set;
public function enableDebug
"Enables a debug flag."
input Flags.DebugFlag inFlag;
output Boolean outOldValue;
algorithm
outOldValue := set(inFlag, true);
end enableDebug;
public function disableDebug
"Disables a debug flag."
input Flags.DebugFlag inFlag;
output Boolean outOldValue;
algorithm
outOldValue := set(inFlag, false);
end disableDebug;
function getConfigOptionsStringList
"Returns the valid options of a single-string configuration flag."
input Flags.ConfigFlag inFlag;
output list<String> outOptions;
output list<String> outComments;
algorithm
(outOptions,outComments) := match inFlag
local
list<tuple<String, Gettext.TranslatableContent>> options;
list<String> flags;
case Flags.CONFIG_FLAG(validOptions=SOME(Flags.STRING_DESC_OPTION(options)))
then (List.map(options,Util.tuple21),List.mapMap(options, Util.tuple22, Gettext.translateContent));
case Flags.CONFIG_FLAG(validOptions=SOME(Flags.STRING_OPTION(flags)))
then (flags,List.fill("",listLength(flags)));
end match;
end getConfigOptionsStringList;
protected function updateDebugFlagArray
"Updates the value of a debug flag in the debug flag array."
input array<Boolean> inFlags;
input Boolean inValue;
input Flags.DebugFlag inFlag;
output array<Boolean> outFlags;
output Boolean outOldValue;
protected
Integer index;
algorithm
Flags.DEBUG_FLAG(index = index) := inFlag;
outOldValue := arrayGet(inFlags, index);
outFlags := arrayUpdate(inFlags, index, inValue);
end updateDebugFlagArray;
protected function updateConfigFlagArray
"Updates the value of a configuration flag in the configuration flag array."
input array<Flags.FlagData> inFlags;
input Flags.FlagData inValue;
input Flags.ConfigFlag inFlag;
output array<Flags.FlagData> outFlags;
protected
Integer index;
algorithm
Flags.CONFIG_FLAG(index = index) := inFlag;
outFlags := arrayUpdate(inFlags, index, inValue);
applySideEffects(inFlag, inValue);
end updateConfigFlagArray;
public function readArgs
"Reads the command line arguments to the compiler and sets the flags
accordingly. Returns a list of arguments that were not consumed, such as the
model filename."
input list<String> inArgs;
output list<String> outArgs = {};
protected
Flags.Flag flags;
Integer numError;
String arg;
list<String> rest_args = inArgs;
algorithm
numError := Error.getNumErrorMessages();
flags := loadFlags();
while not listEmpty(rest_args) loop
arg :: rest_args := rest_args;
if arg == "--" then
// Stop parsing arguments if -- is encountered.
break;
else
if not readArg(arg, flags) then
outArgs := arg :: outArgs;
end if;
end if;
end while;
outArgs := List.append_reverse(outArgs, rest_args);
_ := List.map2(outArgs, System.iconv, "UTF-8", "UTF-8");
Error.assertionOrAddSourceMessage(numError == Error.getNumErrorMessages(), Error.UTF8_COMMAND_LINE_ARGS, {}, Util.dummyInfo);
saveFlags(flags);
// after reading all flags, handle the deprecated ones
handleDeprecatedFlags();
end readArgs;
protected function readArg
"Reads a single command line argument. Returns true if the argument was
consumed, otherwise false."
input String inArg;
input Flags.Flag inFlags;
output Boolean outConsumed;
protected
String flagtype;
Integer len;
algorithm
flagtype := stringGetStringChar(inArg, 1);
len := stringLength(inArg);
// Flags beginning with + can be both short and long, i.e. +h or +help.
if flagtype == "+" then
if len == 1 then
// + alone is not a valid flag.
parseFlag(inArg, Flags.NO_FLAGS());
else
parseFlag(System.substring(inArg, 2, len), inFlags, flagtype);
end if;
outConsumed := true;
// Flags beginning with - must have another - for long flags, i.e. -h or --help.
elseif flagtype == "-" then
if len == 1 then
// - alone is not a valid flag.
parseFlag(inArg, Flags.NO_FLAGS());
elseif len == 2 then
// Short flag without argument, i.e. -h.
parseFlag(System.substring(inArg, 2, 2), inFlags, flagtype);
elseif stringGetStringChar(inArg, 2) == "-" then
if len < 4 or stringGetStringChar(inArg, 4) == "=" then
// Short flags may not be used with --, i.e. --h or --h=debug.
parseFlag(inArg, Flags.NO_FLAGS());
else
// Long flag, i.e. --help or --help=debug.
parseFlag(System.substring(inArg, 3, len), inFlags, "--");
end if;
else
if stringGetStringChar(inArg, 3) == "=" then
// Short flag with argument, i.e. -h=debug.
parseFlag(System.substring(inArg, 2, len), inFlags, flagtype);
else
// Long flag used with -, i.e. -help, which is not allowed.
parseFlag(inArg, Flags.NO_FLAGS());
end if;
end if;
outConsumed := true;
else
// Arguments that don't begin with + or - are not flags, ignore them.
outConsumed := false;
end if;
end readArg;
protected function parseFlag
"Parses a single flag."
input String inFlag;
input Flags.Flag inFlags;
input String inFlagPrefix = "";
protected
String flag;
list<String> values;
algorithm
flag :: values := System.strtok(inFlag, "=");
values := List.flatten(List.map1(values, System.strtok, ","));
parseConfigFlag(flag, values, inFlags, inFlagPrefix);
end parseFlag;
protected function parseConfigFlag
"Tries to look up the flag with the given name, and set it to the given value."
input String inFlag;
input list<String> inValues;
input Flags.Flag inFlags;
input String inFlagPrefix;
protected
Flags.ConfigFlag config_flag;
algorithm
config_flag := lookupConfigFlag(inFlag, inFlagPrefix);
evaluateConfigFlag(config_flag, inValues, inFlags);
end parseConfigFlag;
protected function lookupConfigFlag
"Lookup up the flag with the given name in the list of configuration flags."
input String inFlag;
input String inFlagPrefix;
output Flags.ConfigFlag outFlag;
algorithm
try
outFlag := List.getMemberOnTrue(inFlag, allConfigFlags, matchConfigFlag);
else
Error.addMessage(Error.UNKNOWN_OPTION, {inFlagPrefix + inFlag});
fail();
end try;
end lookupConfigFlag;
protected function configFlagEq
input Flags.ConfigFlag inFlag1;
input Flags.ConfigFlag inFlag2;
output Boolean eq;
algorithm
eq := match(inFlag1, inFlag2)
local
Integer index1, index2;
case(Flags.CONFIG_FLAG(index=index1), Flags.CONFIG_FLAG(index=index2))
then index1 == index2;
end match;
end configFlagEq;
protected function setAdditionalOptModules
input Flags.ConfigFlag inFlag;
input Flags.ConfigFlag inOppositeFlag;
input list<String> inValues;
protected
list<String> values;
algorithm
for value in inValues loop
// remove value from inOppositeFlag
values := Flags.getConfigStringList(inOppositeFlag);
values := List.removeOnTrue(value, stringEq, values);
setConfigStringList(inOppositeFlag, values);
// add value to inFlag
values := Flags.getConfigStringList(inFlag);
values := List.removeOnTrue(value, stringEq, values);
setConfigStringList(inFlag, value::values);
end for;
end setAdditionalOptModules;
protected function evaluateConfigFlag
"Evaluates a given flag and it's arguments."
input Flags.ConfigFlag inFlag;
input list<String> inValues;
input Flags.Flag inFlags;
algorithm
_ := match(inFlag, inFlags)
local
array<Boolean> debug_flags;
array<Flags.FlagData> config_flags;
list<String> values;
// Special case for +d, +debug, set the given debug flags.
case (Flags.CONFIG_FLAG(index = 1), Flags.FLAGS(debugFlags = debug_flags))
equation
List.map1_0(inValues, setDebugFlag, debug_flags);
then
();
// Special case for +h, +help, show help text.
case (Flags.CONFIG_FLAG(index = 2), _)
equation
values = List.map(inValues, System.tolower);
System.gettextInit(if Flags.getConfigString(Flags.RUNNING_TESTSUITE) == "" then Flags.getConfigString(Flags.LOCALE_FLAG) else "C");
print(printHelp(values));
setConfigString(Flags.HELP, "omc");
then
();
// Special case for --preOptModules+=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.PRE_OPT_MODULES_ADD))
equation
setAdditionalOptModules(Flags.PRE_OPT_MODULES_ADD, Flags.PRE_OPT_MODULES_SUB, inValues);
then
();
// Special case for --preOptModules-=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.PRE_OPT_MODULES_SUB))
equation
setAdditionalOptModules(Flags.PRE_OPT_MODULES_SUB, Flags.PRE_OPT_MODULES_ADD, inValues);
then
();
// Special case for --postOptModules+=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.POST_OPT_MODULES_ADD))
equation
setAdditionalOptModules(Flags.POST_OPT_MODULES_ADD, Flags.POST_OPT_MODULES_SUB, inValues);
then
();
// Special case for --postOptModules-=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.POST_OPT_MODULES_SUB))
equation
setAdditionalOptModules(Flags.POST_OPT_MODULES_SUB, Flags.POST_OPT_MODULES_ADD, inValues);
then
();
// Special case for --initOptModules+=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.INIT_OPT_MODULES_ADD))
equation
setAdditionalOptModules(Flags.INIT_OPT_MODULES_ADD, Flags.INIT_OPT_MODULES_SUB, inValues);
then
();
// Special case for --initOptModules-=<value>
case (_, _) guard(configFlagEq(inFlag, Flags.INIT_OPT_MODULES_SUB))
equation
setAdditionalOptModules(Flags.INIT_OPT_MODULES_SUB, Flags.INIT_OPT_MODULES_ADD, inValues);
then
();
// All other configuration flags, set the flag to the given values.
case (_, Flags.FLAGS(configFlags = config_flags))
equation
setConfigFlag(inFlag, config_flags, inValues);
then
();
end match;
end evaluateConfigFlag;
protected function setDebugFlag
"Enables a debug flag given as a string, or disables it if it's prefixed with -."
input String inFlag;
input array<Boolean> inFlags;
protected
Boolean negated,neg1,neg2;
String flag_str;
algorithm
neg1 := stringEq(stringGetStringChar(inFlag, 1), "-");
neg2 := System.strncmp("no",inFlag,2) == 0;
negated := neg1 or neg2;
flag_str := if negated then Util.stringRest(inFlag) else inFlag;
flag_str := if neg2 then Util.stringRest(flag_str) else flag_str;
setDebugFlag2(flag_str, not negated, inFlags);
end setDebugFlag;
protected function setDebugFlag2
input String inFlag;
input Boolean inValue;
input array<Boolean> inFlags;
algorithm
_ := matchcontinue(inFlag, inValue, inFlags)
local
Flags.DebugFlag flag;
case (_, _, _)
equation
flag = List.getMemberOnTrue(inFlag, allDebugFlags, matchDebugFlag);
(_, _) = updateDebugFlagArray(inFlags, inValue, flag);
then
();
else
equation
Error.addMessage(Error.UNKNOWN_DEBUG_FLAG, {inFlag});
then
fail();
end matchcontinue;
end setDebugFlag2;
protected function matchDebugFlag
"Returns true if the given flag has the given name, otherwise false."
input String inFlagName;
input Flags.DebugFlag inFlag;
output Boolean outMatches;
protected
String name;
algorithm
Flags.DEBUG_FLAG(name = name) := inFlag;
outMatches := stringEq(inFlagName, name);
end matchDebugFlag;
protected function matchConfigFlag
"Returns true if the given flag has the given name, otherwise false."
input String inFlagName;
input Flags.ConfigFlag inFlag;
output Boolean outMatches;
protected
Option<String> opt_shortname;
String name, shortname;
algorithm
// A configuration flag may have two names, one long and one short.
Flags.CONFIG_FLAG(name = name, shortname = opt_shortname) := inFlag;
shortname := Util.getOptionOrDefault(opt_shortname, "");
outMatches := stringEq(inFlagName, shortname) or
stringEq(System.tolower(inFlagName), System.tolower(name));
end matchConfigFlag;
protected function setConfigFlag
"Sets the value of a configuration flag, where the value is given as a list of
strings."
input Flags.ConfigFlag inFlag;
input array<Flags.FlagData> inConfigData;
input list<String> inValues;
protected
Flags.FlagData data, default_value;
String name;
Option<Flags.ValidOptions> validOptions;
algorithm
Flags.CONFIG_FLAG(name = name, defaultValue = default_value, validOptions = validOptions) := inFlag;
data := stringFlagData(inValues, default_value, validOptions, name);
_ := updateConfigFlagArray(inConfigData, data, inFlag);
end setConfigFlag;
protected function stringFlagData
"Converts a list of strings into a FlagData value. The expected type is also
given so that the value can be typechecked."
input list<String> inValues;
input Flags.FlagData inExpectedType;
input Option<Flags.ValidOptions> validOptions;
input String inName;
output Flags.FlagData outValue;
algorithm
outValue := matchcontinue(inValues, inExpectedType, validOptions, inName)
local
Boolean b;
Integer i;
list<Integer> ilst;
String s, et, at;
list<tuple<String, Integer>> enums;
list<String> flags, slst;
Flags.ValidOptions options;
// A boolean value.
case ({s}, Flags.BOOL_FLAG(), _, _)
equation
b = Util.stringBool(s);
then
Flags.BOOL_FLAG(b);
// No value, but a boolean flag => enable the flag.
case ({}, Flags.BOOL_FLAG(), _, _) then Flags.BOOL_FLAG(true);
// An integer value.
case ({s}, Flags.INT_FLAG(), _, _)
equation
i = stringInt(s);
true = stringEq(intString(i), s);
then
Flags.INT_FLAG(i);
// integer list.
case (slst, Flags.INT_LIST_FLAG(), _, _)
equation
ilst = List.map(slst,stringInt);
then
Flags.INT_LIST_FLAG(ilst);
// A real value.
case ({s}, Flags.REAL_FLAG(), _, _)
then Flags.REAL_FLAG(System.stringReal(s));
// A string value.
case ({s}, Flags.STRING_FLAG(), SOME(options), _)
equation
flags = getValidStringOptions(options);
true = listMember(s,flags);
then Flags.STRING_FLAG(s);
case ({s}, Flags.STRING_FLAG(), NONE(), _) then Flags.STRING_FLAG(s);
// A multiple-string value.
case (_, Flags.STRING_LIST_FLAG(), _, _) then Flags.STRING_LIST_FLAG(inValues);
// An enumeration value.
case ({s}, Flags.ENUM_FLAG(validValues = enums), _, _)
equation