mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
appConfigurator.cpp
Go to the documentation of this file.
1/** \file appConfigurator.cpp
2 * \author Jared R. Males
3 * \brief Implementation of An application configuration manager
4 *
5 * \ingroup mxApp_files
6 *
7 */
8
9//***********************************************************************//
10// Copyright 2021 Jared R. Males (jaredmales@gmail.com)
11//
12// This file is part of mxlib.
13//
14// mxlib is free software: you can redistribute it and/or modify
15// it under the terms of the GNU General Public License as published by
16// the Free Software Foundation, either version 3 of the License, or
17// (at your option) any later version.
18//
19// mxlib is distributed in the hope that it will be useful,
20// but WITHOUT ANY WARRANTY; without even the implied warranty of
21// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22// GNU General Public License for more details.
23//
24// You should have received a copy of the GNU General Public License
25// along with mxlib. If not, see <http://www.gnu.org/licenses/>.
26//***********************************************************************//
27
28#include "app/appConfigurator.hpp"
29
30namespace mx
31{
32namespace app
33{
34
35void appConfigurator::clear()
36{
37 m_targets.clear();
38 clOnlyTargets.clear();
39 nonOptions.clear();
40 m_unusedConfigs.clear();
41}
42
43void appConfigurator::add( const configTarget &tgt )
44{
45
46 // First check for duplicate name and command line only
47 if( m_targets.count( tgt.name ) > 0 && tgt.section == "" && tgt.keyword == "" )
48 {
49 clOnlyTargets.push_back( tgt );
50 clOnlyTargets.back().orderAdded = nAdded;
51 }
52 else
53 {
54 std::pair<targetIterator, bool> res = m_targets.insert( { tgt.name, tgt } );
55 res.first->second.orderAdded = nAdded;
56 }
57
58 ++nAdded;
59}
60
61void appConfigurator::add( const std::string &n,
62 const std::string &so,
63 const std::string &lo,
64 int clt,
65 const std::string &s,
66 const std::string &kw,
67 bool isReq,
68 const std::string &ht,
69 const std::string &he )
70{
71 add( configTarget( n, so, lo, clt, s, kw, isReq, ht, he ) );
72}
73
74void appConfigurator::parseCommandLine( int argc, char **argv, const std::string &oneTarget )
75{
76 if( argc == 0 )
77 return;
78
79 clOptions clOpts;
80
81 // First load the options into the clOptions parser
82 targetIterator it;
83 for( it = m_targets.begin(); it != m_targets.end(); ++it )
84 {
85 if( it->second.shortOpt == "" && it->second.longOpt == "" )
86 continue; // No command line opts specified.
87
88 clOpts.add( it->second.name, it->second.shortOpt.c_str(), it->second.longOpt.c_str(), it->second.clType );
89 }
90
91 // Then load the command-line-only options.
92 clOnlyTargetIterator cloit;
93 for( cloit = clOnlyTargets.begin(); cloit != clOnlyTargets.end(); ++cloit )
94 {
95 if( cloit->shortOpt == "" && cloit->longOpt == "" )
96 continue; // Nothing to add?
97
98 clOpts.add( cloit->name, cloit->shortOpt.c_str(), cloit->longOpt.c_str(), cloit->clType );
99 }
100
101 // Now we parse
102 clOpts.parse( argc, argv, &nonOptions );
103
104 if( clOpts.numUnknown() > 0 )
105 {
106 std::vector<std::string> unk;
107 clOpts.unknown( unk );
108
109 for( size_t n = 0; n < unk.size(); ++n )
110 {
111 // Insert or update existing
112 m_unusedConfigs[unk[n]].name = unk[n];
113 if( m_sources )
114 m_unusedConfigs[unk[n]].sources.push_back( "command line" );
115 m_unusedConfigs[unk[n]].set = true;
116 }
117 }
118
119 // If nothing more to do, get out
120 if( clOpts.nOpts == 0 )
121 {
122 return;
123 }
124 // And then load the results in the config target map.
125 for( it = m_targets.begin(); it != m_targets.end(); ++it )
126 {
127 if( oneTarget != "" && it->second.name != oneTarget )
128 continue;
129
130 if( clOpts.optSet( it->second.name ) )
131 {
132 std::vector<std::string> args;
133
134 clOpts.getAll( args, it->second.name );
135
136 it->second.values.insert( it->second.values.end(), args.begin(), args.end() );
137 if( m_sources )
138 {
139 for( size_t n = 0; n < args.size(); ++n )
140 it->second.sources.push_back( "command line" );
141 }
142
143 it->second.verbosity = clOpts.count( it->second.name );
144 it->second.set = true;
145 }
146 }
147}
148
149int appConfigurator::readConfig( const std::string &fname, bool reportFileNotFound )
150{
151 // Handle empty string quietly
152 if( fname == "" )
153 return 0;
154
155 iniFile iF;
156
157 ///\todo update error handling to include >0 (line numer of parse error) and -2 memory allocation error.
158 int prv = iF.parse( fname );
159
160 if( prv == -1 )
161 {
162 if( !reportFileNotFound )
163 return -1;
164
165 mxError( "appConfigurator: ", MXE_FILENOTFOUND, "The file " + fname + " was not found" );
166 return -1;
167 }
168
169 if( prv == -2 )
170 {
171 mxError( "appConfigurator: ", MXE_ALLOCERR, "Memory allocation error in config file parser" );
172 return -1;
173 }
174
175 if( prv > 0 )
176 {
177 mxError( "appConfigurator: ", MXE_PARSEERR, "Parsing error in " + fname + " at line " + std::to_string( prv ) );
178 return -1;
179 }
180
181 targetIterator it;
182
183 for( it = m_targets.begin(); it != m_targets.end(); ++it )
184 {
185 if( iF.count( it->second.section, it->second.keyword ) > 0 )
186 {
187 it->second.values.push_back( iF( it->second.section, it->second.keyword ) );
188 if( m_sources )
189 {
190 it->second.sources.push_back( fname );
191 }
192 it->second.set = true;
193
194 iF.erase( it->second.section, it->second.keyword ); // Erase it from the iniFile map.
195 }
196 }
197
198 // here set aside non-deleted iF entries
199 for( auto iFit = iF.names.begin(); iFit != iF.names.end(); ++iFit )
200 {
201 // Insert or update existing
202 m_unusedConfigs[iFit->first].name = iFit->first;
203
204 std::string sect, nam;
205 iniFile::parseKey( sect, nam, iFit->first );
206 m_unusedConfigs[iFit->first].section = sect;
207 m_unusedConfigs[iFit->first].keyword = nam;
208
209 m_unusedConfigs[iFit->first].values.push_back( iFit->second );
210
211 if( m_sources )
212 m_unusedConfigs[iFit->first].sources.push_back( fname );
213
214 m_unusedConfigs[iFit->first].set = true;
215 }
216
217 return 0;
218}
219
220bool appConfigurator::isSet( const std::string &name, std::unordered_map<std::string, configTarget> &targets )
221{
222 if( targets.count( name ) == 0 )
223 return false;
224
225 targets[name].used = true;
226
227 return targets[name].set;
228}
229
230bool appConfigurator::isSet( const std::string &name )
231{
232 return isSet( name, m_targets );
233}
234
235int appConfigurator::count( const std::string &name, std::unordered_map<std::string, configTarget> &targets )
236{
237 targets[name].used = true;
238 return targets[name].values.size();
239}
240
241int appConfigurator::count( const std::string &name )
242{
243 return count( name, m_targets );
244}
245
246int appConfigurator::verbosity( const std::string &name, std::unordered_map<std::string, configTarget> &targets )
247{
248 targets[name].used = true;
249 return targets[name].verbosity;
250}
251
252int appConfigurator::verbosity( const std::string &name )
253{
254 return verbosity( name, m_targets );
255}
256
257//+++++++++++++++++++++++++++++++++++++
258// Explicit instants:
259//+++++++++++++++++++++++++++++++++++++
260
261template int appConfigurator::get<char>( char &v,
262 const std::string &name,
263 size_t i,
264 std::unordered_map<std::string, configTarget> &targets );
265
266template int appConfigurator::get<signed char>( signed char &v,
267 const std::string &name,
268 size_t i,
269 std::unordered_map<std::string, configTarget> &targets );
270
271template int appConfigurator::get<short>( short &v,
272 const std::string &name,
273 size_t i,
274 std::unordered_map<std::string, configTarget> &targets );
275
276template int appConfigurator::get<int>( int &v,
277 const std::string &name,
278 size_t i,
279 std::unordered_map<std::string, configTarget> &targets );
280
281template int appConfigurator::get<long>( long &v,
282 const std::string &name,
283 size_t i,
284 std::unordered_map<std::string, configTarget> &targets );
285
286template int appConfigurator::get<long long>( long long &v,
287 const std::string &name,
288 size_t i,
289 std::unordered_map<std::string, configTarget> &targets );
290
291template int appConfigurator::get<unsigned char>( unsigned char &v,
292 const std::string &name,
293 size_t i,
294 std::unordered_map<std::string, configTarget> &targets );
295
296template int appConfigurator::get<unsigned short>( unsigned short &v,
297 const std::string &name,
298 size_t i,
299 std::unordered_map<std::string, configTarget> &targets );
300
301template int appConfigurator::get<unsigned int>( unsigned int &v,
302 const std::string &name,
303 size_t i,
304 std::unordered_map<std::string, configTarget> &targets );
305
306template int appConfigurator::get<unsigned long>( unsigned long &v,
307 const std::string &name,
308 size_t i,
309 std::unordered_map<std::string, configTarget> &targets );
310
311template int appConfigurator::get<unsigned long long>( unsigned long long &v,
312 const std::string &name,
313 size_t i,
314 std::unordered_map<std::string, configTarget> &targets );
315
316template int appConfigurator::get<float>( float &v,
317 const std::string &name,
318 size_t i,
319 std::unordered_map<std::string, configTarget> &targets );
320
321template int appConfigurator::get<double>( double &v,
322 const std::string &name,
323 size_t i,
324 std::unordered_map<std::string, configTarget> &targets );
325
326template int appConfigurator::get<long double>( long double &v,
327 const std::string &name,
328 size_t i,
329 std::unordered_map<std::string, configTarget> &targets );
330
331#ifdef HASQUAD
332template int appConfigurator::get<__float128>( __float128 &v,
333 const std::string &name,
334 size_t i,
335 std::unordered_map<std::string, configTarget> &targets );
336#endif
337
338template int appConfigurator::get<bool>( bool &v,
339 const std::string &name,
340 size_t i,
341 std::unordered_map<std::string, configTarget> &targets );
342
343template int appConfigurator::get<std::string>( std::string &v,
344 const std::string &name,
345 size_t i,
346 std::unordered_map<std::string, configTarget> &targets );
347
348//+++++++++++++++++++++++++++++++++++++
349
350template int appConfigurator::get<char>( char &v, const std::string &name, size_t i );
351
352template int appConfigurator::get<signed char>( signed char &v, const std::string &name, size_t i );
353
354template int appConfigurator::get<short>( short &v, const std::string &name, size_t i );
355
356template int appConfigurator::get<int>( int &v, const std::string &name, size_t i );
357
358template int appConfigurator::get<long>( long &v, const std::string &name, size_t i );
359
360template int appConfigurator::get<long long>( long long &v, const std::string &name, size_t i );
361
362template int appConfigurator::get<unsigned char>( unsigned char &v, const std::string &name, size_t i );
363
364template int appConfigurator::get<unsigned short>( unsigned short &v, const std::string &name, size_t i );
365
366template int appConfigurator::get<unsigned int>( unsigned int &v, const std::string &name, size_t i );
367
368template int appConfigurator::get<unsigned long>( unsigned long &v, const std::string &name, size_t i );
369
370template int appConfigurator::get<unsigned long long>( unsigned long long &v, const std::string &name, size_t i );
371
372template int appConfigurator::get<float>( float &v, const std::string &name, size_t i );
373
374template int appConfigurator::get<double>( double &v, const std::string &name, size_t i );
375
376template int appConfigurator::get<long double>( long double &v, const std::string &name, size_t i );
377
378#ifdef HASQUAD
379template int appConfigurator::get<__float128>( __float128 &v, const std::string &name, size_t i );
380#endif
381
382template int appConfigurator::get<bool>( bool &v, const std::string &name, size_t i );
383
384template int appConfigurator::get<std::string>( std::string &v, const std::string &name, size_t i );
385
386//+++++++++++++++++++++++++++++++++++++
387
388template int
389appConfigurator::get<char>( char &v, const std::string &name, std::unordered_map<std::string, configTarget> &targets );
390
391template int appConfigurator::get<signed char>( signed char &v,
392 const std::string &name,
393 std::unordered_map<std::string, configTarget> &targets );
394
395template int appConfigurator::get<short>( short &v,
396 const std::string &name,
397 std::unordered_map<std::string, configTarget> &targets );
398
399template int
400appConfigurator::get<int>( int &v, const std::string &name, std::unordered_map<std::string, configTarget> &targets );
401
402template int
403appConfigurator::get<long>( long &v, const std::string &name, std::unordered_map<std::string, configTarget> &targets );
404
405template int appConfigurator::get<long long>( long long &v,
406 const std::string &name,
407 std::unordered_map<std::string, configTarget> &targets );
408
409template int appConfigurator::get<unsigned char>( unsigned char &v,
410 const std::string &name,
411 std::unordered_map<std::string, configTarget> &targets );
412
413template int appConfigurator::get<unsigned short>( unsigned short &v,
414 const std::string &name,
415 std::unordered_map<std::string, configTarget> &targets );
416
417template int appConfigurator::get<unsigned int>( unsigned int &v,
418 const std::string &name,
419 std::unordered_map<std::string, configTarget> &targets );
420
421template int appConfigurator::get<unsigned long>( unsigned long &v,
422 const std::string &name,
423 std::unordered_map<std::string, configTarget> &targets );
424
425template int appConfigurator::get<unsigned long long>( unsigned long long &v,
426 const std::string &name,
427 std::unordered_map<std::string, configTarget> &targets );
428
429template int appConfigurator::get<float>( float &v,
430 const std::string &name,
431 std::unordered_map<std::string, configTarget> &targets );
432
433template int appConfigurator::get<double>( double &v,
434 const std::string &name,
435 std::unordered_map<std::string, configTarget> &targets );
436
437template int appConfigurator::get<long double>( long double &v,
438 const std::string &name,
439 std::unordered_map<std::string, configTarget> &targets );
440
441#ifdef HASQUAD
442template int appConfigurator::get<__float128>( __float128 &v,
443 const std::string &name,
444 std::unordered_map<std::string, configTarget> &targets );
445#endif
446
447template int
448appConfigurator::get<bool>( bool &v, const std::string &name, std::unordered_map<std::string, configTarget> &targets );
449
450template int appConfigurator::get<std::string>( std::string &v,
451 const std::string &name,
452 std::unordered_map<std::string, configTarget> &targets );
453
454//+++++++++++++++++++++++++++++++++++++
455
456template int appConfigurator::get<char>( char &v, const std::string &name );
457
458template int appConfigurator::get<signed char>( signed char &v, const std::string &name );
459
460template int appConfigurator::get<short>( short &v, const std::string &name );
461
462template int appConfigurator::get<int>( int &v, const std::string &name );
463
464template int appConfigurator::get<long>( long &v, const std::string &name );
465
466template int appConfigurator::get<long long>( long long &v, const std::string &name );
467
468template int appConfigurator::get<unsigned char>( unsigned char &v, const std::string &name );
469
470template int appConfigurator::get<unsigned short>( unsigned short &v, const std::string &name );
471
472template int appConfigurator::get<unsigned int>( unsigned int &v, const std::string &name );
473
474template int appConfigurator::get<unsigned long>( unsigned long &v, const std::string &name );
475
476template int appConfigurator::get<unsigned long long>( unsigned long long &v, const std::string &name );
477
478template int appConfigurator::get<float>( float &v, const std::string &name );
479
480template int appConfigurator::get<double>( double &v, const std::string &name );
481
482template int appConfigurator::get<long double>( long double &v, const std::string &name );
483
484#ifdef HASQUAD
485template int appConfigurator::get<__float128>( __float128 &v, const std::string &name );
486#endif
487
488template int appConfigurator::get<bool>( bool &v, const std::string &name );
489
490template int appConfigurator::get<std::string>( std::string &v, const std::string &name );
491
492//++++++++++++++++++++++++++++++++++++++++++++++
493
494template int appConfigurator::get<char>( std::vector<char> &v,
495 const std::string &name,
496 size_t i,
497 std::unordered_map<std::string, configTarget> &targets );
498
499template int appConfigurator::get<signed char>( std::vector<signed char> &v,
500 const std::string &name,
501 size_t i,
502 std::unordered_map<std::string, configTarget> &targets );
503
504template int appConfigurator::get<short>( std::vector<short> &v,
505 const std::string &name,
506 size_t i,
507 std::unordered_map<std::string, configTarget> &targets );
508
509template int appConfigurator::get<int>( std::vector<int> &v,
510 const std::string &name,
511 size_t i,
512 std::unordered_map<std::string, configTarget> &targets );
513
514template int appConfigurator::get<long>( std::vector<long> &v,
515 const std::string &name,
516 size_t i,
517 std::unordered_map<std::string, configTarget> &targets );
518
519template int appConfigurator::get<long long>( std::vector<long long> &v,
520 const std::string &name,
521 size_t i,
522 std::unordered_map<std::string, configTarget> &targets );
523
524template int appConfigurator::get<unsigned char>( std::vector<unsigned char> &v,
525 const std::string &name,
526 size_t i,
527 std::unordered_map<std::string, configTarget> &targets );
528
529template int appConfigurator::get<unsigned short>( std::vector<unsigned short> &v,
530 const std::string &name,
531 size_t i,
532 std::unordered_map<std::string, configTarget> &targets );
533
534template int appConfigurator::get<unsigned int>( std::vector<unsigned int> &v,
535 const std::string &name,
536 size_t i,
537 std::unordered_map<std::string, configTarget> &targets );
538
539template int appConfigurator::get<unsigned long>( std::vector<unsigned long> &v,
540 const std::string &name,
541 size_t i,
542 std::unordered_map<std::string, configTarget> &targets );
543
544template int appConfigurator::get<unsigned long long>( std::vector<unsigned long long> &v,
545 const std::string &name,
546 size_t i,
547 std::unordered_map<std::string, configTarget> &targets );
548
549template int appConfigurator::get<float>( std::vector<float> &v,
550 const std::string &name,
551 size_t i,
552 std::unordered_map<std::string, configTarget> &targets );
553
554template int appConfigurator::get<double>( std::vector<double> &v,
555 const std::string &name,
556 size_t i,
557 std::unordered_map<std::string, configTarget> &targets );
558
559template int appConfigurator::get<long double>( std::vector<long double> &v,
560 const std::string &name,
561 size_t i,
562 std::unordered_map<std::string, configTarget> &targets );
563
564#ifdef HASQUAD
565template int appConfigurator::get<__float128>( std::vector<__float128> &v,
566 const std::string &name,
567 size_t i,
568 std::unordered_map<std::string, configTarget> &targets );
569#endif
570
571template int appConfigurator::get<bool>( std::vector<bool> &v,
572 const std::string &name,
573 size_t i,
574 std::unordered_map<std::string, configTarget> &targets );
575
576template int appConfigurator::get<std::string>( std::vector<std::string> &v,
577 const std::string &name,
578 size_t i,
579 std::unordered_map<std::string, configTarget> &targets );
580
581//+++++++++++++++++++++++++++++++++++++
582
583template int appConfigurator::get<char>( std::vector<char> &v, const std::string &name, size_t i );
584
585template int appConfigurator::get<signed char>( std::vector<signed char> &v, const std::string &name, size_t i );
586
587template int appConfigurator::get<short>( std::vector<short> &v, const std::string &name, size_t i );
588
589template int appConfigurator::get<int>( std::vector<int> &v, const std::string &name, size_t i );
590
591template int appConfigurator::get<long>( std::vector<long> &v, const std::string &name, size_t i );
592
593template int appConfigurator::get<long long>( std::vector<long long> &v, const std::string &name, size_t i );
594
595template int appConfigurator::get<unsigned char>( std::vector<unsigned char> &v, const std::string &name, size_t i );
596
597template int appConfigurator::get<unsigned short>( std::vector<unsigned short> &v, const std::string &name, size_t i );
598
599template int appConfigurator::get<unsigned int>( std::vector<unsigned int> &v, const std::string &name, size_t i );
600
601template int appConfigurator::get<unsigned long>( std::vector<unsigned long> &v, const std::string &name, size_t i );
602
603template int
604appConfigurator::get<unsigned long long>( std::vector<unsigned long long> &v, const std::string &name, size_t i );
605
606template int appConfigurator::get<float>( std::vector<float> &v, const std::string &name, size_t i );
607
608template int appConfigurator::get<double>( std::vector<double> &v, const std::string &name, size_t i );
609
610template int appConfigurator::get<long double>( std::vector<long double> &v, const std::string &name, size_t i );
611
612#ifdef HASQUAD
613template int appConfigurator::get<__float128>( std::vector<__float128> &v, const std::string &name, size_t i );
614#endif
615
616template int appConfigurator::get<bool>( std::vector<bool> &v, const std::string &name, size_t i );
617
618template int appConfigurator::get<std::string>( std::vector<std::string> &v, const std::string &name, size_t i );
619
620//+++++++++++++++++++++++++++++++++++++++++++++++
621template int appConfigurator::get<char>( std::vector<char> &v,
622 const std::string &name,
623 std::unordered_map<std::string, configTarget> &targets );
624
625template int appConfigurator::get<signed char>( std::vector<signed char> &v,
626 const std::string &name,
627 std::unordered_map<std::string, configTarget> &targets );
628
629template int appConfigurator::get<short>( std::vector<short> &v,
630 const std::string &name,
631 std::unordered_map<std::string, configTarget> &targets );
632
633template int appConfigurator::get<int>( std::vector<int> &v,
634 const std::string &name,
635 std::unordered_map<std::string, configTarget> &targets );
636
637template int appConfigurator::get<long>( std::vector<long> &v,
638 const std::string &name,
639 std::unordered_map<std::string, configTarget> &targets );
640
641template int appConfigurator::get<long long>( std::vector<long long> &v,
642 const std::string &name,
643 std::unordered_map<std::string, configTarget> &targets );
644
645template int appConfigurator::get<unsigned char>( std::vector<unsigned char> &v,
646 const std::string &name,
647 std::unordered_map<std::string, configTarget> &targets );
648
649template int appConfigurator::get<unsigned short>( std::vector<unsigned short> &v,
650 const std::string &name,
651 std::unordered_map<std::string, configTarget> &targets );
652
653template int appConfigurator::get<unsigned int>( std::vector<unsigned int> &v,
654 const std::string &name,
655 std::unordered_map<std::string, configTarget> &targets );
656
657template int appConfigurator::get<unsigned long>( std::vector<unsigned long> &v,
658 const std::string &name,
659 std::unordered_map<std::string, configTarget> &targets );
660
661template int appConfigurator::get<unsigned long long>( std::vector<unsigned long long> &v,
662 const std::string &name,
663 std::unordered_map<std::string, configTarget> &targets );
664
665template int appConfigurator::get<float>( std::vector<float> &v,
666 const std::string &name,
667 std::unordered_map<std::string, configTarget> &targets );
668
669template int appConfigurator::get<double>( std::vector<double> &v,
670 const std::string &name,
671 std::unordered_map<std::string, configTarget> &targets );
672
673template int appConfigurator::get<long double>( std::vector<long double> &v,
674 const std::string &name,
675 std::unordered_map<std::string, configTarget> &targets );
676
677#ifdef HASQUAD
678template int appConfigurator::get<__float128>( std::vector<__float128> &v,
679 const std::string &name,
680 std::unordered_map<std::string, configTarget> &targets );
681#endif
682
683template int appConfigurator::get<bool>( std::vector<bool> &v,
684 const std::string &name,
685 std::unordered_map<std::string, configTarget> &targets );
686
687template int appConfigurator::get<std::string>( std::vector<std::string> &v,
688 const std::string &name,
689 std::unordered_map<std::string, configTarget> &targets );
690//+++++++++++++++++++++++++++++++++++++
691
692template int appConfigurator::get<char>( std::vector<char> &v, const std::string &name );
693
694template int appConfigurator::get<signed char>( std::vector<signed char> &v, const std::string &name );
695
696template int appConfigurator::get<short>( std::vector<short> &v, const std::string &name );
697
698template int appConfigurator::get<int>( std::vector<int> &v, const std::string &name );
699
700template int appConfigurator::get<long>( std::vector<long> &v, const std::string &name );
701
702template int appConfigurator::get<long long>( std::vector<long long> &v, const std::string &name );
703
704template int appConfigurator::get<unsigned char>( std::vector<unsigned char> &v, const std::string &name );
705
706template int appConfigurator::get<unsigned short>( std::vector<unsigned short> &v, const std::string &name );
707
708template int appConfigurator::get<unsigned int>( std::vector<unsigned int> &v, const std::string &name );
709
710template int appConfigurator::get<unsigned long>( std::vector<unsigned long> &v, const std::string &name );
711
712template int appConfigurator::get<unsigned long long>( std::vector<unsigned long long> &v, const std::string &name );
713
714template int appConfigurator::get<float>( std::vector<float> &v, const std::string &name );
715
716template int appConfigurator::get<double>( std::vector<double> &v, const std::string &name );
717
718template int appConfigurator::get<long double>( std::vector<long double> &v, const std::string &name );
719
720#ifdef HASQUAD
721template int appConfigurator::get<__float128>( std::vector<__float128> &v, const std::string &name );
722#endif
723
724template int appConfigurator::get<bool>( std::vector<bool> &v, const std::string &name );
725
726template int appConfigurator::get<std::string>( std::vector<std::string> &v, const std::string &name );
727
728//+++++++++++++++++++++++++++++++++++++++
729
730template int appConfigurator::operator()<char>( char &v, const std::string &name );
731
732template int appConfigurator::operator()<signed char>( signed char &v, const std::string &name );
733
734template int appConfigurator::operator()<short>( short &v, const std::string &name );
735
736template int appConfigurator::operator()<int>( int &v, const std::string &name );
737
738template int appConfigurator::operator()<long>( long &v, const std::string &name );
739
740template int appConfigurator::operator()<long long>( long long &v, const std::string &name );
741
742template int appConfigurator::operator()<unsigned char>( unsigned char &v, const std::string &name );
743
744template int appConfigurator::operator()<unsigned short>( unsigned short &v, const std::string &name );
745
746template int appConfigurator::operator()<unsigned int>( unsigned int &v, const std::string &name );
747
748template int appConfigurator::operator()<unsigned long>( unsigned long &v, const std::string &name );
749
750template int appConfigurator::operator()<unsigned long long>( unsigned long long &v, const std::string &name );
751
752template int appConfigurator::operator()<float>( float &v, const std::string &name );
753
754template int appConfigurator::operator()<double>( double &v, const std::string &name );
755
756template int appConfigurator::operator()<long double>( long double &v, const std::string &name );
757
758#ifdef HASQUAD
759template int appConfigurator::operator()<__float128>( __float128 &v, const std::string &name );
760#endif
761
762template int appConfigurator::operator()<bool>( bool &v, const std::string &name );
763
764template int appConfigurator::operator()<std::string>( std::string &v, const std::string &name );
765
766//++++++++++++++++++++++++++++++++++++++++++++++
767
768template int appConfigurator::configUnused<char>( char &v, const std::string &key );
769
770template int appConfigurator::configUnused<signed char>( signed char &v, const std::string &key );
771
772template int appConfigurator::configUnused<short>( short &v, const std::string &key );
773
774template int appConfigurator::configUnused<int>( int &v, const std::string &key );
775
776template int appConfigurator::configUnused<long>( long &v, const std::string &key );
777
778template int appConfigurator::configUnused<long long>( long long &v, const std::string &key );
779
780template int appConfigurator::configUnused<unsigned char>( unsigned char &v, const std::string &key );
781
782template int appConfigurator::configUnused<unsigned short>( unsigned short &v, const std::string &key );
783
784template int appConfigurator::configUnused<unsigned int>( unsigned int &v, const std::string &key );
785
786template int appConfigurator::configUnused<unsigned long>( unsigned long &v, const std::string &key );
787
788template int appConfigurator::configUnused<unsigned long long>( unsigned long long &v, const std::string &key );
789
790template int appConfigurator::configUnused<float>( float &v, const std::string &key );
791
792template int appConfigurator::configUnused<double>( double &v, const std::string &key );
793
794template int appConfigurator::configUnused<long double>( long double &v, const std::string &key );
795
796#ifdef HASQUAD
797template int appConfigurator::configUnused<__float128>( __float128 &v, const std::string &key );
798#endif
799
800template int appConfigurator::configUnused<bool>( bool &v, const std::string &key );
801
802template int appConfigurator::configUnused<std::string>( std::string &v, const std::string &key );
803
804//+++++++++++++++++++++++++++++++++++++++++++++++++++++
805
806template int appConfigurator::configUnused<char>( char &v, const std::string &section, const std::string &keyword );
807
808template int
809appConfigurator::configUnused<signed char>( signed char &v, const std::string &section, const std::string &keyword );
810
811template int appConfigurator::configUnused<short>( short &v, const std::string &section, const std::string &keyword );
812
813template int appConfigurator::configUnused<int>( int &v, const std::string &section, const std::string &keyword );
814
815template int appConfigurator::configUnused<long>( long &v, const std::string &section, const std::string &keyword );
816
817template int
818appConfigurator::configUnused<long long>( long long &v, const std::string &section, const std::string &keyword );
819
820template int appConfigurator::configUnused<unsigned char>( unsigned char &v,
821 const std::string &section,
822 const std::string &keyword );
823
824template int appConfigurator::configUnused<unsigned short>( unsigned short &v,
825 const std::string &section,
826 const std::string &keyword );
827
828template int
829appConfigurator::configUnused<unsigned int>( unsigned int &v, const std::string &section, const std::string &keyword );
830
831template int appConfigurator::configUnused<unsigned long>( unsigned long &v,
832 const std::string &section,
833 const std::string &keyword );
834
835template int appConfigurator::configUnused<unsigned long long>( unsigned long long &v,
836 const std::string &section,
837 const std::string &keyword );
838
839template int appConfigurator::configUnused<float>( float &v, const std::string &section, const std::string &keyword );
840
841template int appConfigurator::configUnused<double>( double &v, const std::string &section, const std::string &keyword );
842
843template int
844appConfigurator::configUnused<long double>( long double &v, const std::string &section, const std::string &keyword );
845
846#ifdef HASQUAD
847template int
848appConfigurator::configUnused<__float128>( __float128 &v, const std::string &section, const std::string &keyword );
849#endif
850
851template int appConfigurator::configUnused<bool>( bool &v, const std::string &section, const std::string &keyword );
852
853template int
854appConfigurator::configUnused<std::string>( std::string &v, const std::string &section, const std::string &keyword );
855
856//+++++++++++++++++++++++++++++++++++++
857
858int appConfigurator::unusedSections( std::vector<std::string> &sections )
859{
860 sections.clear();
861
862 // Wind through all the targets
863 for( auto it = m_unusedConfigs.begin(); it != m_unusedConfigs.end(); ++it )
864 {
865 std::string sect = it->second.section;
866
867 bool add = true;
868
869 // Check if this section is already in the vector -- is there a std::algorithms way to do this?
870 for( size_t i = 0; i < sections.size(); ++i )
871 {
872 if( sections[i] == sect )
873 {
874 add = false;
875 break;
876 }
877 }
878
879 // Add it if it wasn't found.
880 if( add )
881 sections.push_back( sect );
882 }
883
884 return 0;
885}
886
887int appConfigurator::isSetUnused( const std::string &name )
888{
889 return isSet( name, m_unusedConfigs );
890}
891
892void writeConfigFile( const std::string &fname,
893 const std::vector<std::string> &sections,
894 const std::vector<std::string> &keywords,
895 const std::vector<std::string> &values )
896{
897 std::ofstream fout;
898
899 fout.open( fname );
900
901 std::string lastSection;
902 for( size_t i = 0; i < sections.size(); ++i )
903 {
904 std::string currSection = sections[i];
905
906 if( currSection != lastSection && currSection != "" )
907 {
908 fout << "\n[" << currSection << "]\n";
909 }
910
911 if(keywords.size() >= i && values.size() >= i)
912 {
913 if(keywords[i] != "")
914 {
915 fout << keywords[i] << "=" << values[i] << "\n";
916 }
917 }
918 lastSection = currSection;
919 }
920
921 fout.close();
922
923 return;
924}
925
926} // namespace app
927} // namespace mx
appConfigurator.hpp
An application configuration manager.
mx::app::writeConfigFile
void writeConfigFile(const std::string &fname, const std::vector< std::string > &sections, const std::vector< std::string > &keywords, const std::vector< std::string > &values)
A simple config file writing function, useful for testing.
Definition appConfigurator.cpp:892
mx
The mxlib c++ namespace.
Definition mxError.hpp:106
mx::app::appConfigurator::m_targets
std::unordered_map< std::string, configTarget > m_targets
The targets are stored in an unordered_map for fast access by key.
Definition appConfigurator.hpp:94
mx::app::appConfigurator::readConfig
int readConfig(const std::string &fname, bool reportFileNotFound=true)
Read and parse a config/ini file, updating the targets.
Definition appConfigurator.cpp:149
mx::app::appConfigurator::add
void add(const configTarget &tgt)
Add a configTarget.
Definition appConfigurator.cpp:43
mx::app::appConfigurator::m_sources
bool m_sources
Flag controlling whether or not to record config sources.
Definition appConfigurator.hpp:110
mx::app::appConfigurator::nonOptions
std::vector< std::string > nonOptions
Non-option arguments from the command line.
Definition appConfigurator.hpp:104
mx::app::appConfigurator::verbosity
int verbosity(const std::string &name, std::unordered_map< std::string, configTarget > &targets)
Get the command line verbosity count for this option.
Definition appConfigurator.cpp:246
mx::app::appConfigurator::targetIterator
std::unordered_map< std::string, configTarget >::iterator targetIterator
Iterator for the targets unordered_map.
Definition appConfigurator.hpp:88
mx::app::appConfigurator::isSetUnused
int isSetUnused(const std::string &name)
Check if a target has been set in the unused configuration.
Definition appConfigurator.cpp:887
mx::app::appConfigurator::isSet
bool isSet(const std::string &name, std::unordered_map< std::string, configTarget > &targets)
Check if a target has been set by the configuration.
Definition appConfigurator.cpp:220
mx::app::appConfigurator::clear
void clear()
Clear the containers and free up the associated memory.
Definition appConfigurator.cpp:35
mx::app::appConfigurator::unusedSections
int unusedSections(std::vector< std::string > &sections)
Get the unique sections in the unused config targets.
Definition appConfigurator.cpp:858
mx::app::appConfigurator::clOnlyTargets
std::list< configTarget > clOnlyTargets
Targets which are only for the command line are stored separately in a list.
Definition appConfigurator.hpp:101
mx::app::appConfigurator::count
int count(const std::string &name, std::unordered_map< std::string, configTarget > &targets)
Get the number of different values set for the specified config target.
Definition appConfigurator.cpp:235
mx::app::appConfigurator::parseCommandLine
void parseCommandLine(int argc, char **argv, const std::string &oneTarget="")
Parse the command line, updating the targets.
Definition appConfigurator.cpp:74
mx::app::appConfigurator::nAdded
int nAdded
Running count of options added, used to track order.
Definition appConfigurator.hpp:107
mx::app::appConfigurator::m_unusedConfigs
std::unordered_map< std::string, configTarget > m_unusedConfigs
Definition appConfigurator.hpp:98
mx::app::appConfigurator::clOnlyTargetIterator
std::list< configTarget >::iterator clOnlyTargetIterator
Iterator for the clOnlyTargets list.
Definition appConfigurator.hpp:91
mx::app::clOptions
Command line options parser.
Definition clOptions.hpp:59
mx::app::clOptions::parse
void parse(int argc, char **argv, std::vector< std::string > *nonOptions=0)
Parse the command line.
Definition clOptions.cpp:99
mx::app::clOptions::numUnknown
int numUnknown()
Get the number of unknown options found by the parser.
Definition clOptions.cpp:253
mx::app::clOptions::add
void add(const std::string &optName, const char *const shortOpt, const char *const longOpt, int argT)
Add a command line option target.
Definition clOptions.cpp:71
mx::app::clOptions::count
int count(const std::string &key)
Get the number of times the option was set on the command line.
Definition clOptions.cpp:166
mx::app::clOptions::nOpts
unsigned int nOpts
The number of options added.
Definition clOptions.hpp:70
mx::app::clOptions::getAll
void getAll(std::vector< std::string > &args, const std::string &key)
Fill a vector of strings with the arguments supplied for key, last to first.
Definition clOptions.cpp:176
mx::app::clOptions::unknown
int unknown(std::vector< std::string > &unk)
Get a vector of the unknown options found by the parser.
Definition clOptions.cpp:259
mx::app::clOptions::optSet
bool optSet(const std::string &key)
Test whether this option was set.
Definition clOptions.cpp:241
mx::app::configTarget
A configuration target.
Definition configTarget.hpp:53
mx::app::configTarget::keyword
std::string keyword
The config file keyword, read in a "keyword=value" pair.
Definition configTarget.hpp:60
mx::app::configTarget::section
std::string section
The config file section name, can be empty "".
Definition configTarget.hpp:59
mx::app::configTarget::name
std::string name
The name of the target.
Definition configTarget.hpp:54
mx::app::iniFile
A wrapper for the ini functions.
Definition iniFile.hpp:47
mx::app::iniFile::count
size_t count(const std::string &section, const std::string &name)
Get the number of entries for the given section and name.
Definition iniFile.hpp:142
mx::app::iniFile::erase
int erase(const std::string &section, const std::string &name)
Erase the entry for the given section and name.
Definition iniFile.hpp:154
mx::app::iniFile::names
nameMapT names
The map of section=name keys to values.
Definition iniFile.hpp:50
mx::app::iniFile::parseKey
static int parseKey(std::string &section, std::string &name, const std::string &key)
Parse a key into its section and name consituents.
Definition iniFile.hpp:70
mx::app::iniFile::parse
int parse(const std::string &fname)
Calls the inih parse function with this->handler.
Definition iniFile.hpp:95