forked from reedhedges/AriaCoda
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ArConfig.cpp
3676 lines (3004 loc) · 114 KB
/
ArConfig.cpp
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
/*
Adept MobileRobots Robotics Interface for Applications (ARIA)
Copyright (C) 2004-2005 ActivMedia Robotics LLC
Copyright (C) 2006-2010 MobileRobots Inc.
Copyright (C) 2011-2015 Adept Technology, Inc.
Copyright (C) 2016-2018 Omron Adept Technologies, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
If you wish to redistribute ARIA under different terms, contact
Adept MobileRobots for information about a commercial version of ARIA at
Adept MobileRobots, 10 Columbia Drive, Amherst, NH 03031; +1-603-881-7960
*/
#include "ArExport.h"
#include "ariaOSDef.h"
#include "ArConfig.h"
#include "ArArgumentBuilder.h"
#include "ArLog.h"
#include <string>
//#define ARDEBUG_CONFIG
#if (defined(ARDEBUG_CONFIG))
//#if (defined(_DEBUG) && defined(ARDEBUG_CONFIG))
#define IFDEBUG(code) {code;}
#else
#define IFDEBUG(code)
#endif
const char *ArConfig::CURRENT_CONFIG_VERSION = "2.0";
const char *ArConfig::CONFIG_VERSION_TAG = "ConfigVersion";
const char *ArConfig::CURRENT_RESOURCE_VERSION = "1.1";
const char *ArConfig::RESOURCE_VERSION_TAG = "ConfigResourceVersion";
AREXPORT const char *ArConfig::CATEGORY_ROBOT_INTERFACE = "Robot Interface";
AREXPORT const char *ArConfig::CATEGORY_ROBOT_OPERATION = "Robot Operation";
AREXPORT const char *ArConfig::CATEGORY_ROBOT_PHYSICAL = "Robot Physical";
AREXPORT const char *ArConfig::CATEGORY_FLEET = "Enterprise";
AREXPORT const char *ArConfig::CATEGORY_SECURITY = "Security";
AREXPORT const char *ArConfig::CATEGORY_DEBUG = "Debug";
AREXPORT const char *ArConfig::toCategoryName(const char *categoryName)
{
if (categoryName == NULL) {
return NULL;
}
// KMC 8/15/13 Obviously this should be improved to be less cut-and-paste
// error prone
if (ArUtil::strcasecmp(categoryName, CATEGORY_ROBOT_INTERFACE) == 0) {
return CATEGORY_ROBOT_INTERFACE;
}
if (ArUtil::strcasecmp(categoryName, CATEGORY_ROBOT_OPERATION) == 0) {
return CATEGORY_ROBOT_OPERATION;
}
if (ArUtil::strcasecmp(categoryName, CATEGORY_ROBOT_PHYSICAL) == 0) {
return CATEGORY_ROBOT_PHYSICAL;
}
if (ArUtil::strcasecmp(categoryName, CATEGORY_FLEET) == 0) {
return CATEGORY_FLEET;
}
if (ArUtil::strcasecmp(categoryName, CATEGORY_DEBUG) == 0) {
return CATEGORY_DEBUG;
}
return NULL;
} // end method toCategoryName
/**
@param baseDirectory a directory to search for files in
@param noBlanksBetweenParams if there should not be blank lines between params in output
@param ignoreBounds if this is true bounds checking will be ignored when the file is read in. this should ONLY be used by developers debugging
@param failOnBadSection if this is true and there is a bad section, then parseFile will fail
@param saveUnknown if this is true and there are unknown parameters or sections then they will be saved, if false then they will be ignored (can also be set with setSaveUnknown())
**/
AREXPORT ArConfig::ArConfig(const char *baseDirectory,
bool noBlanksBetweenParams,
bool ignoreBounds,
bool failOnBadSection,
bool saveUnknown) :
myRobotName(""),
myConfigName(""),
myLogPrefix("ArConfig: "),
myArgumentParser(NULL),
myProcessFileCBList(),
myNoBlanksBetweenParams(noBlanksBetweenParams),
myConfigVersion(),
myTranslator(NULL),
myCsvSeparatorChar('\t'), // Or tab?
mySection(),
mySectionsToParse(NULL),
mySectionsNotToParse(),
myHighestPriorityToParse(ArPriority::FIRST_PRIORITY),
myLowestPriorityToParse(ArPriority::LAST_PRIORITY),
myRestartLevelNeeded(ArConfigArg::NO_RESTART),
myCheckingForRestartLevel(true),
mySectionBroken(false),
mySectionIgnored(false),
myUsingSections(false),
myParsingListNames(),
myIsParsingListBroken(false),
myFileName(),
myBaseDirectory(), // setBaseDirectory() is called in ctor
myParser(NULL),
myIgnoreBounds(ignoreBounds),
myFailOnBadSection(failOnBadSection),
myDuplicateParams(false),
mySaveUnknown(saveUnknown),
myIsQuiet(false),
myPermissionAllowFactory(true),
myPermissionSaveUnknown(saveUnknown),
myProcessFileCallbacksLogLevel(ArLog::Verbose),
myCategoryToSectionsMap(),
mySections(),
myParserCB(this, &ArConfig::parseArgument),
myVersionCB(this, &ArConfig::parseVersion),
mySectionCB(this, &ArConfig::parseSection),
myListBeginCB(this, &ArConfig::parseListBegin),
myListEndCB(this, &ArConfig::parseListEnd),
myUnknownCB(this, &ArConfig::parseUnknown)
{
/* taking this part out and just calling 'addParsrHandler' so all the codes in one spot
if (!myParser.addHandlerWithError("section", &mySectionCB))
{
ArLog::log(ArLog::Normal, "Could not add section to file parser, horrific failure");
}*/
addParserHandlers();
myPermissionAllowFactory = true;
myPermissionSaveUnknown = saveUnknown;
myArgumentParser = NULL;
mySaveUnknown = saveUnknown;
myIsQuiet = false;
setBaseDirectory(baseDirectory);
myIgnoreBounds = ignoreBounds;
myFailOnBadSection = failOnBadSection;
myProcessFileCallbacksLogLevel = ArLog::Verbose;
myUsingSections = false;
mySectionBroken = false;
mySectionIgnored = false;
myDuplicateParams = false;
myParserCB.setName("ArConfig::parseArgument");
myVersionCB.setName("ArConfig::parseVersion");
mySectionCB.setName("ArConfig::parseSection");
myListBeginCB.setName("ArConfig::parseListBegin");
myListEndCB.setName("ArConfig::parseListEnd");
myUnknownCB.setName("ArConfig::parseUnknown");
mySection = "";
}
AREXPORT ArConfig::~ArConfig()
{
clearAll();
}
AREXPORT ArConfig::ArConfig(const ArConfig &config) :
myRobotName(""),
myConfigName(""),
myLogPrefix("ArConfig: "),
myArgumentParser(NULL),
myProcessFileCBList(),
myNoBlanksBetweenParams(config.myNoBlanksBetweenParams),
myConfigVersion(config.myConfigVersion),
myTranslator(config.myTranslator),
myCsvSeparatorChar(config.myCsvSeparatorChar),
mySection(config.mySection),
mySectionsToParse(NULL),
mySectionsNotToParse(config.mySectionsNotToParse),
myHighestPriorityToParse(config.myHighestPriorityToParse),
myLowestPriorityToParse(config.myLowestPriorityToParse),
myRestartLevelNeeded(ArConfigArg::NO_RESTART),
myCheckingForRestartLevel(true),
mySectionBroken(config.mySectionBroken),
mySectionIgnored(config.mySectionIgnored),
myUsingSections(config.myUsingSections),
myParsingListNames(),
myIsParsingListBroken(false),
myFileName(),
myBaseDirectory(), // setBaseDirectory() is called in ctor
myParser(NULL),
myIgnoreBounds(config.myIgnoreBounds),
myFailOnBadSection(config.myFailOnBadSection),
myDuplicateParams(config.myDuplicateParams),
mySaveUnknown(config.mySaveUnknown),
myIsQuiet(config.myIsQuiet),
myPermissionAllowFactory(config.myPermissionAllowFactory),
myPermissionSaveUnknown(config.myPermissionSaveUnknown),
myProcessFileCallbacksLogLevel(config.myProcessFileCallbacksLogLevel),
myCategoryToSectionsMap(config.myCategoryToSectionsMap),
mySections(),
myParserCB(this, &ArConfig::parseArgument),
myVersionCB(this, &ArConfig::parseVersion),
mySectionCB(this, &ArConfig::parseSection),
myListBeginCB(this, &ArConfig::parseListBegin),
myListEndCB(this, &ArConfig::parseListEnd),
myUnknownCB(this, &ArConfig::parseUnknown)
{
myArgumentParser = NULL;
setBaseDirectory(config.getBaseDirectory());
std::list<ArConfigSection *>::const_iterator it;
for (it = config.mySections.begin();
it != config.mySections.end();
it++)
{
mySections.push_back(new ArConfigSection(*(*it)));
}
copySectionsToParse(config.mySectionsToParse);
myParserCB.setName("ArConfig::parseArgument");
myVersionCB.setName("ArConfig::parseVersion");
mySectionCB.setName("ArConfig::parseSection");
myListBeginCB.setName("ArConfig::parseListBegin");
myListEndCB.setName("ArConfig::parseListEnd");
myUnknownCB.setName("ArConfig::parseUnknown");
myParser.setQuiet(myIsQuiet);
remParserHandlers();
addParserHandlers();
}
AREXPORT ArConfig &ArConfig::operator=(const ArConfig &config)
{
if (this != &config) {
// Note that the name is not copied...
IFDEBUG(ArLog::log(ArLog::Verbose,
"%soperator= (from %s) begins",
myLogPrefix.c_str(),
config.myLogPrefix.c_str()));
// TODO: The following attributes also need to be copied (or
// something) -- ditto for copy ctor:
// myProcessFileCBList
// myParser
// The callbacks should not be copied
// myParserCB
// myVersionCB
// mySectionCB
myArgumentParser = NULL;
setBaseDirectory(config.getBaseDirectory());
myNoBlanksBetweenParams = config.myNoBlanksBetweenParams;
myConfigVersion = config.myConfigVersion;
myIgnoreBounds = config.myIgnoreBounds;
myFailOnBadSection = config.myFailOnBadSection;
mySection = config.mySection;
mySectionBroken = config.mySectionBroken;
mySectionIgnored = config.mySectionIgnored;
myUsingSections = config.myUsingSections;
myDuplicateParams = config.myDuplicateParams;
// KMC 7/13/12 Not copying the myParsingListNames because they are
// transient internal pointers only used while parsing.
myIsParsingListBroken = config.myIsParsingListBroken;
myPermissionAllowFactory = config.myPermissionAllowFactory;
myPermissionSaveUnknown = config.myPermissionSaveUnknown;
myCategoryToSectionsMap.clear();
myCategoryToSectionsMap = config.myCategoryToSectionsMap;
clearSections();
std::list<ArConfigSection *>::const_iterator it;
for (it = config.mySections.begin();
it != config.mySections.end();
it++)
{
mySections.push_back(new ArConfigSection(*(*it)));
}
copySectionsToParse(config.mySectionsToParse);
mySectionsNotToParse = config.mySectionsNotToParse;
myHighestPriorityToParse = config.myHighestPriorityToParse;
myLowestPriorityToParse = config.myLowestPriorityToParse;
myRestartLevelNeeded = config.myRestartLevelNeeded;
myCheckingForRestartLevel = config.myCheckingForRestartLevel;
remParserHandlers();
addParserHandlers();
IFDEBUG(ArLog::log(ArLog::Verbose,
"%soperator= (from %s) ends",
myLogPrefix.c_str(),
config.myLogPrefix.c_str()));
}
return *this;
}
AREXPORT void ArConfig::copyAndDetach(const ArConfig &config)
{
if (this != &config) {
// Note that the name is not copied...
IFDEBUG(ArLog::log(ArLog::Verbose,
"%soperator= (from %s) begins",
myLogPrefix.c_str(),
config.myLogPrefix.c_str()));
// TODO: The following attributes also need to be copied (or
// something) -- ditto for copy ctor:
// myProcessFileCBList
// myParser
// The callbacks should not be copied
// myParserCB
// myVersionCB
// mySectionCB
myArgumentParser = NULL;
setBaseDirectory(config.getBaseDirectory());
myNoBlanksBetweenParams = config.myNoBlanksBetweenParams;
myConfigVersion = config.myConfigVersion;
myIgnoreBounds = config.myIgnoreBounds;
myFailOnBadSection = config.myFailOnBadSection;
mySection = config.mySection;
mySectionBroken = config.mySectionBroken;
mySectionIgnored = config.mySectionIgnored;
myUsingSections = config.myUsingSections;
myDuplicateParams = config.myDuplicateParams;
// KMC 7/13/12 Not copying the myParsingListNames because they are
// transient internal pointers only used while parsing.
myIsParsingListBroken = config.myIsParsingListBroken;
myPermissionAllowFactory = config.myPermissionAllowFactory;
myPermissionSaveUnknown = config.myPermissionSaveUnknown;
myCategoryToSectionsMap.clear();
myCategoryToSectionsMap = config.myCategoryToSectionsMap;
clearSections();
std::list<ArConfigSection *>::const_iterator it;
for (it = config.mySections.begin();
it != config.mySections.end();
it++)
{
ArConfigSection *sectionCopy = new ArConfigSection();
sectionCopy->setQuiet(myIsQuiet);
sectionCopy->copyAndDetach(*(*it));
mySections.push_back(sectionCopy);
//mySections.push_back(new ArConfigSection(*(*it)));
}
copySectionsToParse(config.mySectionsToParse);
myHighestPriorityToParse = config.myHighestPriorityToParse;
myLowestPriorityToParse = config.myLowestPriorityToParse;
myRestartLevelNeeded = config.myRestartLevelNeeded;
myCheckingForRestartLevel = config.myCheckingForRestartLevel;
mySectionsNotToParse = config.mySectionsNotToParse;
remParserHandlers();
addParserHandlers();
IFDEBUG(ArLog::log(ArLog::Verbose,
"%soperator= (from %s) ends",
myLogPrefix.c_str(),
config.myLogPrefix.c_str()));
}
// Hmmm... Is there any use in returning... ? return *this;
} // end method copyAndDetach
/**
* These names are used solely for log messages.
*
* @param configName a char * descriptive name of the ArConfig instance
* (e.g. Server or Default)
* @param robotName an optional char * identifier of the robot that has
* the config
**/
AREXPORT void ArConfig::setConfigName(const char *configName,
const char *robotName)
{
myConfigName = ((configName != NULL) ? configName : "");
myRobotName = ((robotName != NULL) ? robotName : "");
myLogPrefix = "";
if (!myRobotName.empty()) {
myLogPrefix = myRobotName + ": ";
}
myLogPrefix += "ArConfig";
if (!myConfigName.empty()) {
myLogPrefix += " (" + myConfigName + ")";
}
myLogPrefix += ": ";
}
AREXPORT void ArConfig::setQuiet(bool isQuiet)
{
myIsQuiet = isQuiet;
myParser.setQuiet(isQuiet);
}
AREXPORT void ArConfig::setTranslator(ArConfig *xlatorConfig)
{
myTranslator = xlatorConfig;
if (myTranslator != NULL) {
if (!mySections.empty()) {
ArLog::log(ArLog::Normal,
"%sArConfig::setTranslator() sections already created",
myLogPrefix.c_str());
for (std::list<ArConfigSection *>::iterator iter = mySections.begin();
iter != mySections.end();
iter++) {
translateSection(*iter);
}
}
}
} // end method setTranslator
AREXPORT ArConfig *ArConfig::getTranslator() const
{
return myTranslator;
} // end method getTranslator
/**
* @param isSummary a bool set to true if only the section names and parameter counts
* should be logged; false to log detailed parameter information
* @param sectionNameList a list of the string section names to be logged; if NULL,
* then the data for all sections are logged
* @param logPrefix String to prepend to log messages. E.g. "ArConfig::"
**/
AREXPORT void ArConfig::log(bool isSummary,
std::list<std::string> *sectionNameList,
const char *logPrefix)
{
std::string origLogPrefix = myLogPrefix;
if (!ArUtil::isStrEmpty(logPrefix)) {
myLogPrefix = logPrefix;
}
std::list<ArConfigArg> *params = NULL;
ArLog::log(ArLog::Normal,
"%slog",
myLogPrefix.c_str());
for (std::list<ArConfigSection *>::const_iterator it = mySections.begin();
it != mySections.end();
it++)
{
params = (*it)->getParams();
// If the section names were specified and the current section isn't in the
// list, then skip the section...
if (sectionNameList != NULL) {
if (!ArUtil::isStrInList((*it)->getName(), *sectionNameList)) {
continue;
}
} // end if section names specified
if (params == NULL) {
ArLog::log(ArLog::Normal, " Section %s has NULL params",
(*it)->getName());
continue;
}
if (isSummary) {
ArLog::log(ArLog::Normal, " Section %s has %i params",
(*it)->getName(), params->size());
continue;
}
ArLog::log(ArLog::Normal, " Section %s:",
(*it)->getName());
for (std::list<ArConfigArg>::iterator pit = params->begin(); pit != params->end(); pit++)
{
(*pit).log(false, 1, myLogPrefix.c_str());
}
} // end for each section
ArLog::log(ArLog::Normal,
"%send",
myLogPrefix.c_str());
myLogPrefix = origLogPrefix;
} // end method log
AREXPORT void ArConfig::clearSections(void)
{
IFDEBUG(ArLog::log(ArLog::Verbose,
"%sclearSections() begin",
myLogPrefix.c_str()));
while (mySections.begin() != mySections.end())
{
delete mySections.front();
mySections.pop_front();
}
// Clear this just in case...
if (mySectionsToParse != NULL)
{
delete mySectionsToParse;
mySectionsToParse = NULL;
}
IFDEBUG(ArLog::log(ArLog::Verbose,
"%sclearSections() end",
myLogPrefix.c_str()));
}
AREXPORT void ArConfig::clearAll(void)
{
clearSections();
ArUtil::deleteSetPairs(myProcessFileCBList.begin(),
myProcessFileCBList.end());
myProcessFileCBList.clear();
}
void ArConfig::addParserHandlers(void)
{
std::list<ArConfigSection *>::const_iterator it;
std::list<ArConfigArg> *params;
std::list<ArConfigArg>::iterator pit;
if (!myParser.addHandlerWithError(CONFIG_VERSION_TAG, &myVersionCB)) {
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose,
"%sCould not add ConfigVersion parser (probably unimportant)",
myLogPrefix.c_str());
}
}
if (!myParser.addHandlerWithError("section", &mySectionCB)) {
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose,
"%sCould not add section parser (probably unimportant)",
myLogPrefix.c_str());
}
}
if (!myParser.addHandlerWithError(ArConfigArg::LIST_BEGIN_TAG, &myListBeginCB)) {
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose,
"%sCould not add _listBegin parser",
myLogPrefix.c_str());
}
}
if (!myParser.addHandlerWithError(ArConfigArg::LIST_END_TAG, &myListEndCB)) {
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose,
"%sCould not add _listEnd parser",
myLogPrefix.c_str());
}
}
for (it = mySections.begin();
it != mySections.end();
it++)
{
params = (*it)->getParams();
if (params == NULL)
continue;
for (pit = params->begin(); pit != params->end(); pit++)
{
(*pit).addToFileParser(&myParser,
&myParserCB,
myLogPrefix.c_str(),
myIsQuiet);
//if (!myParser.addHandlerWithError((*pit).getName(), &myParserCB)) {
// if (!myIsQuiet) {
// ArLog::log(ArLog::Verbose,
// "%sCould not add keyword %s (probably unimportant)",
// myLogPrefix.c_str(),
// (*pit).getName());
// }
//}
}
}
// add our parser for unknown params
if (!myParser.addHandlerWithError(NULL, &myUnknownCB)) {
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose,
"%sCould not add unknown param parser (probably unimportant)",
myLogPrefix.c_str());
}
}
}
void ArConfig::remParserHandlers(void)
{
myParser.remHandler(&myParserCB);
myParser.remHandler(&myVersionCB);
myParser.remHandler(&mySectionCB);
myParser.remHandler(&myListBeginCB);
myParser.remHandler(&myListEndCB);
myParser.remHandler(&myUnknownCB);
} // end method remParserHandlers
AREXPORT bool ArConfig::addSection(const char *categoryName,
const char *sectionName,
const char *sectionDescription)
{
// KMC 8/10/12 Allowing empty category names for unclassified sections
if ((categoryName == NULL) || ArUtil::isStrEmpty(sectionName)) {
// if (ArUtil::isStrEmpty(categoryName) || ArUtil::isStrEmpty(sectionName)) {
ArLog::log(ArLog::Normal,
"%sFailed to add section '%s' to category '%s'",
myLogPrefix.c_str(),
((sectionName != NULL) ? sectionName : "NULL"),
((categoryName != NULL) ? categoryName : "NULL"));
return false;
}
ArConfigSection *section = findSection(sectionName);
std::string origCategoryName;
if ((section != NULL) && (!ArUtil::isStrEmpty(section->getCategoryName())))
{
translateSection(section);
ArLog::log(ArLog::Normal,
"%sFailed to add section '%s' to category '%s', already defined in category '%s'",
myLogPrefix.c_str(),
((sectionName != NULL) ? sectionName : "NULL"),
((categoryName != NULL) ? categoryName : "NULL"),
section->getCategoryName());
return false;
}
if (section == NULL) {
ArLog::log(ArLog::Verbose, "%sMaking new section '%s' in category '%s'",
myLogPrefix.c_str(), sectionName, categoryName);
section = new ArConfigSection(sectionName,
sectionDescription,
myIsQuiet,
categoryName);
mySections.push_back(section);
}
else {
ArLog::log(ArLog::Verbose, "%sAssigning existing section '%s' to category '%s'",
myLogPrefix.c_str(), sectionName, categoryName);
origCategoryName = (section->getCategoryName() != NULL ?
section->getCategoryName() : "");
section->setCategoryName(categoryName);
section->setComment(sectionDescription);
}
translateSection(section);
// If the section was in a different category, then remove it.
if (!origCategoryName.empty() &&
(ArUtil::strcasecmp(origCategoryName, categoryName) != 0))
{
std::map<std::string, std::list<std::string> >::iterator origCatIter = myCategoryToSectionsMap.find(origCategoryName);
if (origCatIter != myCategoryToSectionsMap.end()) {
std::list<std::string> *origSectionList = &(origCatIter->second);
if (origSectionList != NULL) {
for (std::list<std::string>::iterator remIter = origSectionList->begin();
remIter != origSectionList->end();
remIter++) {
if (ArUtil::strcasecmp(sectionName, *remIter) == 0) {
origSectionList->erase(remIter);
break;
}
} // end for each
}
}
} // end if already in a different category
// Make sure that the section is not already stored in the category map
std::list<std::string> *sectionList = NULL;
std::map<std::string, std::list<std::string> >::iterator catIter = myCategoryToSectionsMap.find(categoryName);
if (catIter != myCategoryToSectionsMap.end()) {
sectionList = &(catIter->second);
}
bool isSectionFound = false;
if (sectionList != NULL) {
isSectionFound = ArUtil::isStrInList(sectionName, *sectionList);
}
// If the section is not already in the map, then add it.
if (!isSectionFound) {
myCategoryToSectionsMap[categoryName].push_back(sectionName);
}
return true;
} // end method addSection
/**
Set the comment string associated with a section. If the section doesn't
exist then it is created.
@deprecated use addSection instead
@warning The section name must not contain any characters with
special meaning when saved and loaded from a config file, such as '#', ';',
tab, or newline. The comment must not contain tab or newline, but '#' and
';' are OK within a comment.
**/
AREXPORT void ArConfig::setSectionComment(const char *sectionName,
const char *comment)
{
ArConfigSection *section = findSection(sectionName);
if (section == NULL)
{
ArLog::log(ArLog::Verbose, "%sMaking new section '%s' (for comment)",
myLogPrefix.c_str(), sectionName);
section = new ArConfigSection(sectionName, comment, myIsQuiet);
mySections.push_back(section);
}
else {
section->setComment(comment);
}
translateSection(section);
}
/**
Add a flag to a section. If the section doesn't
exist then it is created.
@warning The section name and flags must not contain any characters with
special meaning when saved and loaded from a config file, such as '#', ';',
tab, or newline.
**/
AREXPORT bool ArConfig::addSectionFlags(const char *sectionName,
const char *flags)
{
ArConfigSection *section = findSection(sectionName);
if (section == NULL)
{
ArLog::log(ArLog::Verbose, "%sMaking new section '%s' (flags)",
myLogPrefix.c_str(), sectionName);
section = new ArConfigSection(sectionName, NULL, myIsQuiet);
section->addFlags(flags, myIsQuiet);
translateSection(section);
mySections.push_back(section);
}
else
section->addFlags(flags, myIsQuiet);
return true;
}
/**
Add a flag to a section. If the section doesn't
exist then it is created.
**/
AREXPORT bool ArConfig::remSectionFlag(const char *sectionName,
const char *flag)
{
ArConfigSection *section = findSection(sectionName);
if (section == NULL)
return false;
section->remFlag(flag);
return true;
}
/** Add a parameter.
* @param arg Object containing key, description and value type of this parameter. This object will be copied.... it must already have the priority, display hint, restart level, and other things like that already set.
* @param sectionName Name of the section to put this parameter in.
*/
AREXPORT bool ArConfig::addParamAsIs(const ArConfigArg &arg,
const char *sectionName)
{
return addParam(arg, sectionName,
arg.getConfigPriority(),
arg.getDisplayHint(),
arg.getRestartLevel());
}
/** Add a parameter.
* @param arg Object containing key, description and value type of this parameter. This object will be copied.
* @param sectionName Name of the section to put this parameter in.
* @param priority Priority or importance of this parameter to a user.
* @param displayHint Suggest an appropriate UI control for editing this parameter's value. See ArConfigArg::setDisplayHint() for description of display hint format.
* @param restart restart level
@warning The parameter name and value must not contain any characters with
special meaning when saved and loaded from a config file, such as '#', ';',
tab, or newline.
*/
AREXPORT bool ArConfig::addParam(const ArConfigArg &arg,
const char *sectionName,
ArPriority::Priority priority,
const char *displayHint,
ArConfigArg::RestartLevel restart)
{
ArConfigSection *section = findSection(sectionName);
ArConfigSection *xltrSection = NULL;
ArConfigArg *xltrArg = NULL;
if ((myTranslator != NULL) &&
(arg.getType() != ArConfigArg::SEPARATOR))
{
xltrSection = myTranslator->findSection(sectionName);
if (xltrSection != NULL) {
xltrArg = xltrSection->findParam(arg.getName(),
true); // allow string holders
if (xltrArg != NULL) {
IFDEBUG(ArLog::log(ArLog::Normal,
"ArConfig::addParam() found translation arg for %s, %s",
sectionName,
arg.getName()));
}
else {
IFDEBUG(ArLog::log(ArLog::Normal,
"ArConfig::addParam() cannot find translation arg for %s, %s",
sectionName,
arg.getName()));
}
}
else {
IFDEBUG(ArLog::log(ArLog::Normal,
"ArConfig::addParam() cannot find translation section for %s",
sectionName));
}
}
//printf("SECTION '%s' name '%s' desc '%s'\n", sectionName, arg.getName(), arg.getDescription());
if (section == NULL)
{
ArLog::log(ArLog::Verbose, "ArConfigArg %s: Making new section '%s' (for param)",
myLogPrefix.c_str(), sectionName);
section = new ArConfigSection(sectionName, NULL, myIsQuiet);
translateSection(section);
mySections.push_back(section);
}
std::list<ArConfigArg> *params = section->getParams();
if (params == NULL)
{
ArLog::log(ArLog::Terse, "%sSomething has gone hideously wrong in ArConfig::addParam",
myLogPrefix.c_str());
return false;
}
// Don't add consecutive separators
if (arg.getType() == ArConfigArg::SEPARATOR &&
!params->empty() && params->back().getType() == ArConfigArg::SEPARATOR)
{
//ArLog::log(ArLog::Verbose, "Last parameter a sep, so is this one, ignoring it");
return true;
}
// see if we have this parameter in another section so we can require sections
std::list<ArConfigSection *>::iterator sectionIt;
for (sectionIt = mySections.begin();
sectionIt != mySections.end();
sectionIt++)
{
ArConfigSection *curSection = *sectionIt;
ArConfigArg *existingParam = NULL;
if (!ArUtil::isStrEmpty(arg.getName())) {
existingParam = curSection->findParam(arg.getName());
}
// if we have an argument of this name but we don't have see if
// this section is our own, if its not then note we have
// duplicates
if (existingParam != NULL)
{
if (strcasecmp(curSection->getName(), section->getName()) != 0) {
ArLog::log(ArLog::Verbose,
"%sParameter %s (type %s) name duplicated in section %s and %s",
myLogPrefix.c_str(),
arg.getName(),
ArConfigArg::toString(arg.getType()),
curSection->getName(), section->getName());
myDuplicateParams = true;
}
else {
ArLog::log(((!existingParam->isPlaceholder()) ? ArLog::Normal : ArLog::Verbose),
"%sParameter %s (type %s) already exists in section %s (placeholder = %i)",
myLogPrefix.c_str(),
arg.getName(),
ArConfigArg::toString(arg.getType()),
section->getName(),
existingParam->isPlaceholder());
}
}
} // end for each section
// now make sure we can add it to the file parser (with the section
// stuff its okay if we can't)
if (!myParser.addHandlerWithError(arg.getName(), &myParserCB))
{
if (!myIsQuiet) {
ArLog::log(ArLog::Verbose, "%sCould not add parameter '%s' to file parser, probably already there.",
myLogPrefix.c_str(), arg.getName());
}
//return false;
}
// now we add all the list names to the parser too (the function
// makes sure it's a list)
addListNamesToParser(arg);
// remove any string and list holders for this param
section->remStringHolder(arg.getName());
// KMC 12/8/13 This comment is incorrect. I believe that we intentionally allow duplicate
// names so that multiple objects can reference the same param value. (True?)