forked from STEllAR-GROUP/hpx
/
inspect.cpp
1161 lines (1006 loc) · 33.1 KB
/
inspect.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
// inspect program -------------------------------------------------------------------//
// Copyright Beman Dawes 2002.
// Copyright Rene Rivera 2004-2006.
// Copyright Gennaro Prota 2006.
// Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at
// http://www.boost.org/LICENSE_1_0.txt)
// This program recurses through sub-directories looking for various problems.
// It contains some Boost specific features, like ignoring "CVS" and "bin",
// and the code that identifies library names assumes the Boost directory
// structure.
// See http://www.boost.org/tools/inspect/ for more information.
const char* hpx_no_inspect = "hpx-" "no-inspect";
// Directories with a file name of the hpx_no_inspect value are not inspected.
// Files that contain the hpx_no_inspect value are not inspected.
#include <vector>
#include <list>
#include <algorithm>
#include <cstring>
#include <iostream>
#include <fstream>
#include <limits>
#include <string>
#include "boost/shared_ptr.hpp"
#include "boost/lexical_cast.hpp"
#include "boost/filesystem/operations.hpp"
#include "boost/filesystem/fstream.hpp"
#include "boost/program_options.hpp"
#include "function_hyper.hpp"
#include <stdio.h> // for popen, pclose
#if defined(_MSC_VER)
# define POPEN _popen
# define PCLOSE _pclose
#else
# define POPEN popen
# define PCLOSE pclose
#endif
#include "time_string.hpp"
#include "inspector.hpp"
// the inspectors
#include "copyright_check.hpp"
#include "crlf_check.hpp"
#include "end_check.hpp"
#include "license_check.hpp"
#include "link_check.hpp"
#include "path_name_check.hpp"
#include "tab_check.hpp"
#include "ascii_check.hpp"
#include "apple_macro_check.hpp"
#include "assert_macro_check.hpp"
#include "deprecated_macro_check.hpp"
#include "minmax_check.hpp"
#include "unnamed_namespace_check.hpp"
#include "endline_whitespace_check.hpp"
#include "length_check.hpp"
//#include "cvs_iterator.hpp"
#if !defined(INSPECT_USE_BOOST_TEST)
#define INSPECT_USE_BOOST_TEST 0
#endif
#if INSPECT_USE_BOOST_TEST
#include "boost/test/included/prg_exec_monitor.hpp"
#endif
namespace fs = boost::filesystem;
using namespace boost::inspect;
namespace
{
fs::path search_root = fs::initial_path();
class inspector_element
{
typedef boost::shared_ptr< boost::inspect::inspector > inspector_ptr;
public:
inspector_ptr inspector;
explicit
inspector_element( boost::inspect::inspector * p ) : inspector(p) {}
};
typedef std::list< inspector_element > inspector_list;
long file_count = 0;
long directory_count = 0;
long error_count = 0;
const int max_offenders = 5; // maximum "worst offenders" to display
boost::inspect::string_set content_signatures;
struct error_msg
{
string library;
string rel_path;
string msg;
std::size_t line_number;
bool operator<( const error_msg & rhs ) const
{
if ( library < rhs.library ) return true;
if ( library > rhs.library ) return false;
if ( rel_path < rhs.rel_path ) return true;
if ( rel_path > rhs.rel_path ) return false;
if ( line_number < rhs.line_number ) return true;
if ( line_number > rhs.line_number ) return false;
return msg < rhs.msg;
}
};
typedef std::vector< error_msg > error_msg_vector;
error_msg_vector msgs;
struct lib_error_count
{
int error_count;
string library;
bool operator<( const lib_error_count & rhs ) const
{
return error_count > rhs.error_count;
}
};
typedef std::vector< lib_error_count > lib_error_count_vector;
lib_error_count_vector libs;
// run subversion to get revisions info ------------------------------------//
//
// implemented as function object that can be passed to boost::execution_monitor
// in order to swallow any errors from 'svn info'.
// struct svn_check
// {
// explicit svn_check(const fs::path & inspect_root) :
// inspect_root(inspect_root), fp(0) {}
//
// int operator()() {
// string rev("unknown");
// string repos("unknown");
// string command("cd ");
// command += inspect_root.string() + " && svn info";
//
// fp = (POPEN(command.c_str(), "r"));
// if (fp)
// {
// static const int line_max = 128;
// char line[line_max];
// while (fgets(line, line_max, fp) != NULL)
// {
// string ln(line);
// string::size_type pos;
// if ((pos = ln.find("Revision: ")) != string::npos)
// rev = ln.substr(pos + 10);
// else if ((pos = ln.find("URL: ")) != string::npos)
// repos = ln.substr(pos + 5);
// }
// }
//
// result = repos + " at revision " + rev;
// return 0;
// }
//
// ~svn_check() { if (fp) PCLOSE(fp); }
//
// const fs::path & inspect_root;
// std::string result;
// FILE* fp;
// private:
// svn_check(svn_check const&);
// svn_check const& operator=(svn_check const&);
// };
// Small helper class because svn_check can't be passed by copy.
template <typename F, typename R>
struct nullary_function_ref
{
explicit nullary_function_ref(F& f) : f(f) {}
R operator()() const { return f(); }
F& f;
};
// get info (as a string) if inspect_root is svn working copy --------------//
// string info( const fs::path & inspect_root )
// {
// svn_check check(inspect_root);
//
// #if !INSPECT_USE_BOOST_TEST
// check();
// #else
//
// try {
// boost::execution_monitor e;
// e.execute(nullary_function_ref<svn_check, int>(check));
// }
// catch(boost::execution_exception const& e) {
// if (e.code() == boost::execution_exception::system_error) {
// // There was an error running 'svn info' - it probably
// // wasn't run in a subversion repo.
// return string("unknown");
// }
// else {
// throw;
// }
// }
//
// #endif
//
// return check.result;
// }
// visit_predicate (determines which directories are visited) --------------//
typedef bool(*pred_type)(const path&);
bool visit_predicate( const path & pth )
{
string local( boost::inspect::relative_to( pth, search_root_path() ) );
string leaf( pth.leaf().string() );
if (leaf[0] == '.') // ignore hidden by convention directories such as
return false; // .htaccess, .git, .svn, .bzr, .DS_Store, etc.
return
// so we can inspect a GIT checkout
leaf != ".git"
// don't look at binaries
&& leaf != "bin"
&& leaf != "bin.v2"
&& leaf != "build"
// no point in checking doxygen xml output
&& local.find("doc/xml") != 0
&& local.find("doc\\xml") != 0
// ignore if tag file present
&& !boost::filesystem::exists(pth / hpx_no_inspect)
;
}
// library_from_content ----------------------------------------------------//
string library_from_content( const string & content )
{
const string unknown_library ( "unknown" );
const string lib_root ( "www.boost.org/libs/" );
string::size_type pos( content.find( lib_root ) );
string lib = unknown_library;
if ( pos != string::npos ) {
pos += lib_root.length();
const char delims[] = " " // space and...
"/\n\r\t";
string::size_type n = content.find_first_of( string(delims), pos );
if (n != string::npos)
lib = string(content, pos, n - pos);
}
return lib;
}
// find_signature ----------------------------------------------------------//
bool find_signature( const path & file_path,
const boost::inspect::string_set & signatures )
{
string name( file_path.leaf().string() );
if ( signatures.find( name ) == signatures.end() )
{
string::size_type pos( name.rfind( '.' ) );
if ( pos == string::npos
|| signatures.find( name.substr( pos ) )
== signatures.end() ) return false;
}
return true;
}
// load_content ------------------------------------------------------------//
void load_content( const path & file_path, string & target )
{
target = "";
if ( !find_signature( file_path, content_signatures ) ) return;
fs::ifstream fin( file_path, std::ios_base::in|std::ios_base::binary );
if ( !fin )
throw string( "could not open input file: " ) + file_path.string();
std::getline( fin, target, '\0' ); // read the whole file
}
// check -------------------------------------------------------------------//
void check( const string & lib,
const path & pth, const string & content, const inspector_list & insp_list )
{
// invoke each inspector
for ( inspector_list::const_iterator itr = insp_list.begin();
itr != insp_list.end(); ++itr )
{
itr->inspector->inspect( lib, pth ); // always call two-argument form
if ( find_signature( pth, itr->inspector->signatures() ) )
{
itr->inspector->inspect( lib, pth, content );
}
}
}
// visit_all ---------------------------------------------------------------//
template< class DirectoryIterator >
void visit_all( const string & lib,
const path & dir_path, const inspector_list & insps )
{
static DirectoryIterator end_itr;
++directory_count;
for ( DirectoryIterator itr( dir_path ); itr != end_itr; ++itr )
{
if ( fs::is_directory( *itr ) )
{
if ( visit_predicate( *itr ) )
{
string cur_lib( boost::inspect::impute_library( *itr ) );
check( cur_lib, *itr, "", insps );
visit_all<DirectoryIterator>( cur_lib, *itr, insps );
}
}
else if (itr->path().leaf().string()[0] != '.') // ignore if hidden
{
++file_count;
string content;
load_content( *itr, content );
if (content.find(hpx_no_inspect) == string::npos)
check( lib.empty() ? library_from_content( content ) : lib,
*itr, content, insps );
}
}
}
// display -----------------------------------------------------------------//
enum display_format_type
{
display_html, display_text
}
display_format = display_html;
enum display_mode_type
{
display_full, display_brief
}
display_mode = display_full;
// display_summary_helper --------------------------------------------------//
void display_summary_helper(std::ostream& out, const string & current_library,
int err_count )
{
if (display_format == display_text)
{
out << " " << current_library << " (" << err_count << ")\n";
}
else
{
out
<< " <a href=\"#"
<< current_library // what about malformed for URI refs? [gps]
<< "\">" << current_library
<< "</a> ("
<< err_count << ")<br>\n";
}
}
// display_summary ---------------------------------------------------------//
void display_summary(std::ostream& out)
{
if (display_format == display_text)
{
out << "Summary:\n";
}
else
{
out <<
"<h2>Summary</h2>\n"
"<blockquote>\n"
;
}
string current_library( msgs.begin()->library );
int err_count = 0;
for ( error_msg_vector::iterator itr ( msgs.begin() );
itr != msgs.end(); ++itr )
{
if ( current_library != itr->library )
{
display_summary_helper( out, current_library, err_count );
current_library = itr->library;
err_count = 0;
}
++err_count;
}
display_summary_helper( out, current_library, err_count );
if (display_format == display_text)
out << "\n";
else
out << "</blockquote>\n";
}
// html_encode -------------------------------------------------------------//
std::string html_encode(std::string const& text)
{
std::string result;
for(std::string::const_iterator it = text.begin(),
end = text.end(); it != end; ++it)
{
switch(*it) {
case '<':
result += "<";
break;
case '>':
result += ">";
break;
case '&':
result += "&";
break;
// and are used to force html formatting when needed, as these obscure ascii characters are practically unused
case '':
result += "<";
break;
case '':
result += ">";
break;
default:
result += *it;
}
}
return result;
}
// display_details ---------------------------------------------------------//
void display_details(std::ostream& out)
{
if (display_format == display_text)
{
// display error messages with group indication
error_msg current;
string sep;
for ( error_msg_vector::iterator itr ( msgs.begin() );
itr != msgs.end(); ++itr )
{
if ( current.library != itr->library )
{
if ( display_full == display_mode )
out << "\n|" << itr->library << "|\n";
else
out << "\n\n|" << itr->library << '|';
}
if ( current.library != itr->library
|| current.rel_path != itr->rel_path )
{
if ( display_full == display_mode )
{
out << " " << itr->rel_path << ":\n";
}
else
{
path current_rel_path(current.rel_path);
path this_rel_path(itr->rel_path);
if (current_rel_path.branch_path() != this_rel_path.branch_path())
{
out << "\n " << this_rel_path.branch_path().string() << '/';
}
out << "\n " << this_rel_path.leaf() << ':';
}
}
if ( current.library != itr->library
|| current.rel_path != itr->rel_path
|| current.msg != itr->msg )
{
const string m = itr->msg;
if ( display_full == display_mode )
out << " " << m << '\n';
else
out << ' ' << m;
}
current.library = itr->library;
current.rel_path = itr->rel_path;
current.msg = itr->msg;
}
out << "\n";
}
else // html
{
// display error messages with group indication
error_msg current;
bool first_sep = true;
bool first = true;
for ( error_msg_vector::iterator itr ( msgs.begin() );
itr != msgs.end(); ++itr )
{
if ( current.library != itr->library )
{
if ( !first ) out << "</pre>\n";
out << "\n<h3><a name=\"" << itr->library
<< "\">" << itr->library << "</a></h3>\n<pre>";
}
if ( current.library != itr->library
|| current.rel_path != itr->rel_path )
{
out << "\n";
out << itr->rel_path;
first_sep = true;
}
if ( current.library != itr->library
|| current.rel_path != itr->rel_path
|| current.msg != itr->msg )
{
std::string sep;
if (first_sep)
if (itr->line_number) sep = ":<br> ";
else sep = ": ";
else
if (itr->line_number) sep = "<br> ";
else sep = ", ";
// print the message
if (itr->line_number)
{
string line = std::to_string(itr->line_number);
const path & full_path = itr->library;
string link = linelink(full_path, line);
out << sep << "(line " << link << ") " << html_encode(itr->msg);
}
else out << sep << html_encode(itr->msg);
first_sep = false;
}
current.library = itr->library;
current.rel_path = itr->rel_path;
current.msg = itr->msg;
first = false;
}
out << "</pre>\n";
}
}
// worst_offenders_count_helper --------------------------------------------------//
void worst_offenders_count_helper( const string & current_library, int err_count )
{
lib_error_count lec;
lec.library = current_library;
lec.error_count = err_count;
libs.push_back( lec );
}
// worst_offenders_count -----------------------------------------------------//
void worst_offenders_count()
{
if ( msgs.empty() )
{
return;
}
string current_library( msgs.begin()->library );
int err_count = 0;
for ( error_msg_vector::iterator itr ( msgs.begin() );
itr != msgs.end(); ++itr )
{
if ( current_library != itr->library )
{
worst_offenders_count_helper( current_library, err_count );
current_library = itr->library;
err_count = 0;
}
++err_count;
}
worst_offenders_count_helper( current_library, err_count );
}
// display_worst_offenders -------------------------------------------------//
void display_worst_offenders(std::ostream& out)
{
if (display_mode == display_brief)
return;
if (display_format == display_text)
{
out << "Worst Offenders:\n";
}
else
{
out <<
"<h2>Worst Offenders</h2>\n"
"<blockquote>\n"
;
}
int display_count = 0;
int last_error_count = 0;
for ( lib_error_count_vector::iterator itr ( libs.begin() );
itr != libs.end()
&& (display_count < max_offenders
|| itr->error_count == last_error_count);
++itr, ++display_count )
{
if (display_format == display_text)
{
out << itr->library << " " << itr->error_count << "\n";
}
else
{
out
<< " <a href=\"#"
<< itr->library
<< "\">" << itr->library
<< "</a> ("
<< itr->error_count << ")<br>\n";
}
last_error_count = itr->error_count;
}
if (display_format == display_text)
out << "\n";
else
out << "</blockquote>\n";
}
const char * doctype_declaration()
{
return
"<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\"\n"
"\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">"
;
}
// std::string validator_link(const std::string & text)
// {
// return
// // with link to validation service
// "<a href=\"http://validator.w3.org/check?uri=referer\">"
// + text
// + "</a>"
// ;
// }
} // unnamed namespace
namespace boost
{
namespace inspect
{
// line_break --------------------------------------------------------------//
const char * line_break()
{
return display_format ? "\n" : "<br>\n";
}
// search_root_path --------------------------------------------------------//
path search_root_path()
{
return search_root;
}
// register_signature ------------------------------------------------------//
void inspector::register_signature( const string & signature )
{
m_signatures.insert( signature );
content_signatures.insert( signature );
}
// error -------------------------------------------------------------------//
void inspector::error( const string & library_name,
const path & full_path, const string & msg, std::size_t line_number)
{
++error_count;
error_msg err_msg;
err_msg.library = library_name;
err_msg.rel_path = relative_to( full_path, search_root_path() );
err_msg.msg = msg;
err_msg.line_number = line_number;
msgs.push_back( err_msg );
// std::cout << library_name << ": "
// << full_path.string() << ": "
// << msg << '\n';
}
source_inspector::source_inspector()
{
// C/C++ source code...
register_signature( ".c" );
register_signature( ".cpp" );
register_signature( ".css" );
register_signature( ".cxx" );
register_signature( ".h" );
register_signature( ".hpp" );
register_signature( ".hxx" );
register_signature( ".inc" );
register_signature( ".ipp" );
// Boost.Build BJam source code...
// register_signature( "Jamfile" );
// register_signature( ".jam" );
// register_signature( ".v2" );
// Other scripts; Python, shell, autoconfig, etc.
// register_signature( "configure.in" );
// register_signature( "GNUmakefile" );
// register_signature( "Makefile" );
register_signature( ".bat" );
register_signature( ".mak" );
register_signature( ".pl" );
register_signature( ".py" );
register_signature( ".sh" );
register_signature( "CMakeText.txt" );
register_signature( ".cmake" );
register_signature( ".yml" );
register_signature( ".editorconfig" );
register_signature( ".gitattributes" );
register_signature( ".gitignore" );
// Hypertext, Boost.Book, and other text...
register_signature( "news" );
register_signature( "readme" );
register_signature( "todo" );
register_signature( "NEWS" );
register_signature( "README" );
register_signature( "TODO" );
register_signature( ".boostbook" );
register_signature( ".htm" );
register_signature( ".html" );
register_signature( ".rst" );
register_signature( ".md" );
register_signature( ".sgml" );
register_signature( ".shtml" );
register_signature( ".txt" );
register_signature( ".xml" );
register_signature( ".xsd" );
register_signature( ".xsl" );
register_signature( ".qbk" );
}
hypertext_inspector::hypertext_inspector()
{
register_signature( ".htm" );
register_signature( ".html" );
register_signature( ".shtml" );
}
// impute_library ----------------------------------------------------------//
// may return an empty string [gps]
string impute_library( const path & full_dir_path )
{
path relative( relative_to( full_dir_path, search_root_path() ) );
if ( relative.empty() ) return "boost-root";
string first( (*relative.begin()).string() );
string second = // borland 5.61 requires op=
++relative.begin() == relative.end()
? string() : (*++relative.begin()).string();
if ( first == "boost" )
return second;
return (( first == "libs" || first == "tools" ) && !second.empty())
? second : first;
}
} // namespace inspect
} // namespace boost
// forward declaration only
void print_output(std::ostream& out, inspector_list const& inspectors);
// cpp_main() --------------------------------------------------------------//
#if !INSPECT_USE_BOOST_TEST
int main( int argc_param, char * argv_param[] )
#else
int cpp_main( int argc_param, char * argv_param[] )
#endif
{
using namespace boost::program_options;
options_description desc_commandline(
"Usage: inspect [dir [dir ...]] [options]");
bool license_ck = false;
bool copyright_ck = false;
bool crlf_ck = false;
bool end_ck = false;
bool link_ck = false;
bool path_name_ck = false;
bool tab_ck = false;
bool ascii_ck = false;
bool apple_ck = false;
bool assert_ck = false;
bool deprecated_ck = false;
bool minmax_ck = false;
bool unnamed_ck = false;
bool whitespace_ck = false;
bool length_ck = false;
desc_commandline.add_options()
("help,h", "print some command line help")
("output,o", value<std::string>(),
"the filename to write the output to (default: stdout)")
("text,t", "write a text file (default: html)")
("brief,b", "write a short report only (default: comprehensive)")
("limit,l", value<std::size_t>(), "set limit to the length check tool (default: 90)")
("license", value<bool>(&license_ck)->implicit_value(false),
"check for Boost license violations (default: off)")
("copyright", value<bool>(©right_ck)->implicit_value(false),
"check for copyright violations (default: off)")
("crlf", value<bool>(&crlf_ck)->implicit_value(false),
"check for crlf (line endings) violations (default: off)")
("end", value<bool>(&end_ck)->implicit_value(false),
"check for missing newline at end of file violations (default: off)")
("link", value<bool>(&link_ck)->implicit_value(false),
"check for unlinked files violations (default: off)")
("path_name", value<bool>(&path_name_ck)->implicit_value(false),
"check for path name violations (default: off)")
("tab", value<bool>(&tab_ck)->implicit_value(false),
"check for tab violations (default: off)")
("ascii", value<bool>(&ascii_ck)->implicit_value(false),
"check for non-ascii character usage violations (default: off)")
("apple_macro", value<bool>(&apple_ck)->implicit_value(false),
"check for apple macro violations (default: off)")
("assert_macro", value<bool>(&assert_ck)->implicit_value(false),
"check for plain assert usage violations (default: off)")
("deprecated_macro", value<bool>(&deprecated_ck)->implicit_value(false),
"check for deprecated Boost configuration macro usage violations "
"(default: off)")
("minmax", value<bool>(&minmax_ck)->implicit_value(false),
"check for minmax usage violations (default: off)")
("unnamed", value<bool>(&unnamed_ck)->implicit_value(false),
"check for unnamed namespace usage violations (default: off)")
("whitespace", value<bool>(&whitespace_ck)->implicit_value(false),
"check for endline whitespace violations (default: off)")
("length", value<bool>(&length_ck)->implicit_value(false),
"check for exceeding character limit (default: off)")
("all,a", "check for all violations (default: no checks are performed)")
;
positional_options_description pd;
pd.add("hpx:positional", -1);
options_description cmdline;
cmdline.add(desc_commandline);
cmdline.add_options()
("hpx:positional", value<std::vector<std::string> >()->composing(),
"positional options")
;
variables_map vm;
parsed_options opts(
command_line_parser(argc_param, argv_param)
.options(cmdline)
.positional(pd)
.style(command_line_style::unix_style)
.run()
);
store(opts, vm);
std::size_t limit;
if (vm.count("limit"))
{
limit = vm["limit"].as<std::size_t>();
}
else
{
limit = 90;
}
if (vm.count("help"))
{
std::clog << desc_commandline << std::endl;
return 0;
}
std::vector<fs::path> search_roots;
if (vm.count("hpx:positional"))
{
for (auto const& s: vm["hpx:positional"].as<std::vector<std::string> >())
search_roots.push_back(fs::canonical(fs::absolute(s, fs::initial_path())));
}
else
{
search_roots.push_back(fs::canonical(fs::absolute(".", fs::initial_path())));
}
if (vm.count("text"))
display_format = display_text;
if (vm.count("text"))
display_mode = display_brief;
if (vm.count("all"))
{
license_ck = true;
copyright_ck = true;
crlf_ck = true;
end_ck = true;
link_ck = true;
path_name_ck = true;
tab_ck = true;
ascii_ck = true;
apple_ck = true;
assert_ck = true;
deprecated_ck = true;
minmax_ck = true;
unnamed_ck = true;
whitespace_ck = true;
length_ck = true;
}
std::string output_path("-");
if (vm.count("output"))
output_path = vm["output"].as<std::string>();
// since this is in its own block; reporting will happen
// automatically, from each registered inspector, when
// leaving, due to destruction of the inspector_list object
inspector_list inspectors;
if ( license_ck )
inspectors.push_back( inspector_element( new boost::inspect::license_check ) );
if ( copyright_ck )
inspectors.push_back( inspector_element( new boost::inspect::copyright_check ) );
if ( crlf_ck )
inspectors.push_back( inspector_element( new boost::inspect::crlf_check ) );
if ( end_ck )
inspectors.push_back( inspector_element( new boost::inspect::end_check ) );
if ( link_ck )
inspectors.push_back( inspector_element( new boost::inspect::link_check ) );
if ( path_name_ck )
inspectors.push_back( inspector_element( new boost::inspect::file_name_check ) );
if ( tab_ck )
inspectors.push_back( inspector_element( new boost::inspect::tab_check ) );
if ( ascii_ck )
inspectors.push_back( inspector_element( new boost::inspect::ascii_check ) );
if ( apple_ck )
inspectors.push_back( inspector_element( new boost::inspect::apple_macro_check ) );
if ( assert_ck )
inspectors.push_back( inspector_element( new boost::inspect::assert_macro_check ) );
if ( deprecated_ck )
inspectors.push_back( inspector_element( new boost::inspect::deprecated_macro_check ) );
if ( minmax_ck )
inspectors.push_back( inspector_element( new boost::inspect::minmax_check ) );
if ( unnamed_ck )
inspectors.push_back( inspector_element( new boost::inspect::unnamed_namespace_check ) );
if ( whitespace_ck )
inspectors.push_back( inspector_element( new boost::inspect::whitespace_check) );
if ( length_ck)
inspectors.push_back(inspector_element ( new boost::inspect::length_check(limit)) );
//// perform the actual inspection, using the requested type of iteration
for(auto const& search_root: search_roots)
{
visit_all<fs::directory_iterator>( search_root.leaf().string(),
search_root, inspectors );
}
// close