-
Notifications
You must be signed in to change notification settings - Fork 620
/
options.c
3998 lines (3566 loc) · 108 KB
/
options.c
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
/*
* Copyright (c) 1996-2003, Darren Hiebert
*
* This source code is released for free distribution under the terms of the
* GNU General Public License version 2 or (at your option) any later version.
*
* This module contains functions to process command line options.
*/
/*
* INCLUDE FILES
*/
#include "general.h" /* must always come first */
#define OPTION_WRITE
#include "options_p.h"
#ifndef _GNU_SOURCE
# define _GNU_SOURCE /* for asprintf */
#endif
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <ctype.h> /* to declare isspace () */
#include "ctags.h"
#include "debug.h"
#include "entry_p.h"
#include "field_p.h"
#include "gvars.h"
#include "keyword_p.h"
#include "parse_p.h"
#include "ptag_p.h"
#include "routines_p.h"
#include "xtag_p.h"
#include "param_p.h"
#include "param.h"
#include "error_p.h"
#include "interactive_p.h"
#include "writer_p.h"
#include "trace.h"
#ifdef HAVE_JANSSON
#include <jansson.h>
#endif
/*
* MACROS
*/
#define INVOCATION "Usage: %s [options] [file(s)]\n"
#define CTAGS_ENVIRONMENT "CTAGS"
#define ETAGS_ENVIRONMENT "ETAGS"
#ifndef ETAGS
# define ETAGS "etags" /* name which causes default use of to -e */
#endif
/* The following separators are permitted for list options.
*/
#define EXTENSION_SEPARATOR '.'
#define PATTERN_START '('
#define PATTERN_STOP ')'
#define IGNORE_SEPARATORS ", \t\n"
#ifndef DEFAULT_FILE_FORMAT
# define DEFAULT_FILE_FORMAT 2
#endif
#if defined (HAVE_OPENDIR) || defined (HAVE__FINDFIRST)
# define RECURSE_SUPPORTED
#endif
#define isCompoundOption(c) (bool) (strchr ("fohiILpdDb", (c)) != NULL)
#define ENTER(STAGE) do { \
Assert (Stage <= OptionLoadingStage##STAGE); \
if (Stage != OptionLoadingStage##STAGE) \
{ \
Stage = OptionLoadingStage##STAGE; \
verbose ("Entering configuration stage: loading %s\n", StageDescription[Stage]); \
} \
} while (0)
/*
* Data declarations
*/
enum eOptionLimits {
MaxHeaderExtensions = 100, /* maximum number of extensions in -h option */
MaxSupportedTagFormat = 2
};
typedef struct sOptionDescription {
int usedByEtags;
int experimentalOption;
const char *description;
} optionDescription;
typedef void (*parametricOptionHandler) (const char *const option, const char *const parameter);
typedef const struct {
const char* name; /* name of option as specified by user */
parametricOptionHandler handler; /* routine to handle option */
bool initOnly; /* option must be specified before any files */
unsigned long acceptableStages;
} parametricOption;
typedef const struct sBooleanOption {
const char* name; /* name of option as specified by user */
bool* pValue; /* pointer to option value */
bool initOnly; /* option must be specified before any files */
unsigned long acceptableStages;
void (* set) (const struct sBooleanOption *const option, bool value);
} booleanOption;
/*
* DATA DEFINITIONS
*/
static bool NonOptionEncountered = false;
static stringList *OptionFiles;
typedef stringList searchPathList;
static searchPathList *OptlibPathList;
static stringList *Excluded, *ExcludedException;
static bool FilesRequired = true;
static bool SkipConfiguration;
static const char *const HeaderExtensions [] = {
"h", "H", "hh", "hpp", "hxx", "h++", "inc", "def", NULL
};
long ctags_debugLevel = 0L;
bool ctags_verbose = false;
optionValues Option = {
.append = false,
.backward = false,
.etags = false,
.locate =
#ifdef MACROS_USE_PATTERNS
EX_PATTERN
#else
EX_MIX
#endif
,
.recurse = false,
.sorted = SO_SORTED,
.xref = false,
.customXfmt = NULL,
.fileList = NULL,
.tagFileName = NULL,
.headerExt = NULL,
.etagsInclude = NULL,
.tagFileFormat = DEFAULT_FILE_FORMAT,
#ifdef HAVE_ICONV
.inputEncoding= NULL,
.outputEncoding = NULL,
#endif
.language = LANG_AUTO,
.followLinks = true,
.filter = false,
.filterTerminator = NULL,
.tagRelative = TREL_NO,
.printTotals = 0,
.lineDirectives = false,
.printLanguage =false,
.guessLanguageEagerly = false,
.quiet = false,
.fatalWarnings = false,
.patternLengthLimit = 96,
.putFieldPrefix = false,
.maxRecursionDepth = 0xffffffff,
.interactive = false,
.fieldsReset = false,
#ifdef _WIN32
.useSlashAsFilenameSeparator = FILENAME_SEP_UNSET,
#endif
#ifdef DEBUG
.breakLine = 0,
#endif
};
struct localOptionValues {
bool machinable; /* --machinable */
bool withListHeader; /* --with-list-header */
} localOption = {
.machinable = false,
.withListHeader = true,
};
typedef enum eOptionLoadingStage {
OptionLoadingStageNone,
OptionLoadingStageCustom,
OptionLoadingStageXdg,
OptionLoadingStageHomeDir,
OptionLoadingStageCurrentDir,
OptionLoadingStageEnvVar,
OptionLoadingStageCmdline,
} OptionLoadingStage;
static OptionLoadingStage Stage = OptionLoadingStageNone;
#define STAGE_ANY ~0UL
/*
- Locally used only
*/
static optionDescription LongOptionDescription [] = {
{1,0,"Input/Output Options"},
{1,0," --exclude=<pattern>"},
{1,0," Exclude files and directories matching <pattern>."},
{1,0," See also --exclude-exception option."},
{1,0," --exclude-exception=<pattern>"},
{1,0," Don't exclude files and directories matching <pattern> even if"},
{1,0," they match the pattern specified with --exclude option."},
{1,0," --filter[=(yes|no)]"},
{1,0," Behave as a filter, reading file names from standard input and"},
{1,0," writing tags to standard output [no]."},
{1,0," --filter-terminator=<string>"},
{1,0," Specify <string> to print to stdout following the tags for each file"},
{1,0," parsed when --filter is enabled."},
{1,0," --links[=(yes|no)]"},
{1,0," Indicate whether symbolic links should be followed [yes]."},
{1,0," --maxdepth=<N>"},
#ifdef RECURSE_SUPPORTED
{1,0," Specify maximum recursion depth."},
#else
{1,0," Not supported on this platform."},
#endif
{1,0," --recurse[=(yes|no)]"},
#ifdef RECURSE_SUPPORTED
{1,0," Recurse into directories supplied on command line [no]."},
{1,0," -R Equivalent to --recurse."},
#else
{1,0," Not supported on this platform."},
{1,0," -R Not supported on this platform."},
#endif
{1,0," -L <file>"},
{1,0," A list of input file names is read from the specified <file>."},
{1,0," If specified as \"-\", then standard input is read."},
{1,0," --append[=(yes|no)]"},
{1,0," Should tags should be appended to existing tag file [no]?"},
{1,0," -a Append the tags to an existing tag file."},
{1,0," -f <tagfile>"},
{1,0," Write tags to specified <tagfile>. Value of \"-\" writes tags to stdout"},
{1,0," [\"tags\"; or \"TAGS\" when -e supplied]."},
{1,0," -o Alternative for -f."},
{1,0,""},
{1,0,"Output Format Options"},
{0,0," --format=(1|2)"},
#if DEFAULT_FILE_FORMAT == 1
{0,0," Force output of specified tag file format [1]."},
#else
{0,0," Force output of specified tag file format [2]."},
#endif
#ifdef HAVE_JANSSON
{0,0," --output-format=(u-ctags|e-ctags|etags|xref|json)"},
#else
{0,0," --output-format=(u-ctags|e-ctags|etags|xref)"},
#endif
{0,0," Specify the output format. [u-ctags]"},
{0,0," -e Output tag file for use with Emacs."},
{1,0," -x Print a tabular cross reference file to standard output."},
{0,0," --sort=(yes|no|foldcase)"},
{0,0," Should tags be sorted (optionally ignoring case) [yes]?"},
{0,0," -u Equivalent to --sort=no."},
{1,0," --etags-include=<file>"},
{1,0," Include reference to <file> in Emacs-style tag file (requires -e)."},
#ifdef HAVE_ICONV
{1,0," --input-encoding=<encoding>"},
{1,0," Specify <encoding> of all input files."},
{1,0," --input-encoding-<LANG>=<encoding>"},
{1,0," Specify <encoding> of the <LANG> input files."},
{1,0," --output-encoding=<encoding>"},
{1,0," The <encoding> to write the tag file in. Defaults to UTF-8 if --input-encoding"},
{1,0," is specified, otherwise no conversion is performed."},
#endif
{1,1," --_xformat=<field_format>"},
{1,1," Specify custom format for tabular cross reference (-x)."},
{1,1," Fields can be specified with letter listed in --list-fields."},
{1,1," e.g. --_xformat=%10N %10l:%K @ %-20F:%-20n"},
{1,0,""},
{1,0,"Language Selection and Mapping Options"},
{1,0," --language-force=(<language>|auto)"},
{1,0," Force all files to be interpreted using specified <language>."},
{1,0," --languages=[+|-](<list>|all)"},
{1,0," Restrict files scanned for tags to those mapped to languages"},
{1,0," specified in the comma-separated <list>. The list can contain any"},
{1,0," built-in or user-defined language [all]."},
{1,0," --alias-<LANG>=[+|-](<pattern>|default)"},
{1,0," Add a <pattern> detecting a name, can be used as an alternative name"},
{1,0," for <LANG>."},
{1,0," --guess-language-eagerly"},
{1,0," Guess the language of input file more eagerly"},
{1,0," (but taking longer time for guessing):"},
{1,0," o shebang, even if the input file is not executable,"},
{1,0," o emacs mode specification at the beginning and end of input file, and"},
{1,0," o vim syntax specification at the end of input file."},
{1,0," -G Equivalent to --guess-language-eagerly."},
{1,0," --langmap=<map>[,<map>[...]]"},
{1,0," Override default mapping of language to input file extension."},
{1,0," e.g. --langmap=c:.c.x,java:+.j,make:([Mm]akefile).mak"},
{1,0," --map-<LANG>=[+|-]<extension>|<pattern>"},
{1,0," Set, add(+) or remove(-) the map for <LANG>."},
{1,0," Unlike --langmap, this doesn't take a list; only one file name <pattern>"},
{1,0," or one file <extension> can be specified at once."},
{1,0," Unlike --langmap the change with this option affects mapping of <LANG> only."},
{1,0,""},
{1,0,"Tags File Contents Options"},
{0,0," --excmd=(number|pattern|mix|combine)"},
#ifdef MACROS_USE_PATTERNS
{0,0," Uses the specified type of EX command to locate tags [pattern]."},
#else
{0,0," Uses the specified type of EX command to locate tags [mix]."},
#endif
{0,0," -n Equivalent to --excmd=number."},
{0,0," -N Equivalent to --excmd=pattern."},
{1,0," --extras=[+|-][<flags>|*]"},
{1,0," Include extra tag entries for selected information (<flags>: \"fFgpqrs\") [F]."},
{1,0," --extras-(<LANG>|all)=[+|-][<flags>|*]"},
{1,0," Include <LANG> own extra tag entries for selected information"},
{1,0," (<flags>: see the output of --list-extras=<LANG> option)."},
{1,0," --fields=[+|-][<flags>|*]"},
{1,0," Include selected extension fields (<flags>: \"aCeEfFikKlmnNpPrRsStxzZ\") [fks]."},
{1,0," --fields-(<LANG>|all)=[+|-][<flags>|*]"},
{1,0," Include selected <LANG> own extension fields"},
{1,0," (<flags>: see the output of --list-fields=<LANG> option)."},
{1,0," --kinds-(<LANG>|all)=[+|-](<kinds>|*)"},
{1,0," Enable/disable tag <kinds> for language <LANG>."},
{0,0," --pattern-length-limit=<N>"},
{0,0," Cutoff patterns of tag entries after <N> characters. Disable by setting to 0. [96]"},
{0,0," --pseudo-tags=[+|-](<pseudo-tag>|*)"},
{0,0," Enable/disable emitting pseudo tag named <pseudo-tag>."},
{0,0," if '*' is given, enable emitting all pseudo tags."},
{0,0," --put-field-prefix"},
{0,0," Put \"" CTAGS_FIELD_PREFIX "\" as prefix for the name of fields newly introduced in"},
{0,0," universal-ctags."},
{1,0," --roles-(<LANG>|all).(<kind>|*)=[+|-][<roles>|*]"},
{1,0," Enable/disable tag roles for kinds of language <LANG>."},
{0,0," --tag-relative=(yes|no|always|never)"},
{0,0," Should paths be relative to location of tag file [no; yes when -e]?"},
{0,0," always: be relative even if input files are passed in with absolute paths" },
{0,0," never: be absolute even if input files are passed in with relative paths" },
#ifdef _WIN32
{1,0," --use-slash-as-filename-separator[=(yes|no)]"},
{1,0," Use slash as filename separator [yes] for u-ctags output format."},
#endif
{0,0," -B Use backward searching patterns (?...?)."},
{0,0," -F Use forward searching patterns (/.../; default)."},
{1,0,""},
{1,0,"Option File Options"},
{1,0," --options=<pathname>"},
{1,0," Specify file (or directory) <pathname> from which command line options should be read."},
{1,0," --options-maybe=<pathname>"},
{1,0," Do the same as --options but this doesn't make an error for non-existing file."},
{1,0," --optlib-dir=[+]<directory>"},
{1,0," Add or set <directory> to optlib search path."},
{1,1," --_echo=<msg>"},
{1,1," Echo <msg> to standard error. Useful to debug the chain"},
{1,1," of loading option files."},
{1,1," --_force-quit[=<num>]"},
{1,1," Quit when loading the option files is processed."},
{1,1," Useful to debug the chain of loading option files."},
{1,0,""},
{1,0,"optlib Options"},
{1,0," --kinddef-<LANG>=<letter>,<name>,<description>"},
{1,0," Define new kind for <LANG>."},
{1,0," --langdef=<name>"},
{1,0," Define a new language to be parsed with regular expressions."},
{1,0," --mline-regex-<LANG>=/<line_pattern>/<name_pattern>/<kind-spec>/[<flags>]"},
{1,0," Define multiline regular expression for locating tags in specific language."},
{1,0," --regex-<LANG>=/<line_pattern>/<name_pattern>/<kind-spec>/[<flags>]"},
{1,0," Define single-line regular expression for locating tags in specific language."},
{1,1," --_extradef-<LANG>=<name>,<description>"},
{1,1," Define new extra for <LANG>. --extras-<LANG>=+{name} enables it."},
{1,1," --_fielddef-<LANG>=<name>,<description>"},
{1,1," Define new field for <LANG>."},
{1,1," --_mtable-extend-<LANG>=disttable+srctable."},
{1,1," Copy patterns of a regex table to another regex table."},
{1,1," --_mtable-regex-<LANG>=<table>/<line_pattern>/<name_pattern>/[<flags>]"},
{1,1," Define multitable regular expression for locating tags in specific language."},
{1,1," --_paramdef-<LANG>=<name>,<description>"},
{1,1," Define new param for <LANG>."},
{1,1," --_prelude-<LANG>={{ optscript-code }}"},
{1,1," Specify code run before parsing with <LANG> parser."},
{1,1," --_pretend-<NEWLANG>=<OLDLANG>"},
{1,1," Make NEWLANG parser pretend OLDLANG parser in lang: field."},
{1,1," --_roledef-<LANG>.<kind>=<name>,<description>"},
{1,1," Define new role for the kind in <LANG>."},
{1,1," --_scopesep-<LANG>=[<parent_kind_letter>|*]/(<child_kind_letter>|*):<separator>"},
{1,1," Specify scope separator between <PARENT_KIND> and <KIND>."},
{1,1," --_sequel-<LANG>={{ optscript-code }}"},
{1,1," Specify code run after parsing with <LANG> parser."},
{1,1," --_tabledef-<LANG>=<name>"},
{1,1," Define new regex table for <LANG>."},
{1,0,""},
{1,0,"Language Specific Options"},
{1,0," --if0[=(yes|no)]"},
{1,0," Should code within #if 0 conditional branches be parsed [no]?"},
{0,0," --line-directives[=(yes|no)]"},
{0,0," Should '#line' directives be processed [no]?"},
{1,0," -D <macro>=<definition>"},
{1,0," (CPreProcessor) Give <definition> for <macro>."},
{1,0," -h (<list>|default)"},
{1,0," Specify a <list> of file extensions to be treated as include files"},
{1,0," [\".h.H.hh.hpp.hxx.h++.inc.def\"]."},
{1,0," -I [+|-]<list>|@<file>"},
{1,0," A <list> of tokens to be specially handled is read from either the"},
{1,0," command line or the specified <file>."},
{1,0," --param-<LANG>.<name>=<argument>"},
{1,0," Set <LANG> specific parameter. Available parameters can be listed with --list-params."},
{1,0,""},
{1,0,"Listing Options"},
{1,0," --list-aliases[=(<language>|all)]"},
{1,0," Output list of alias patterns."},
{1,0," --list-excludes"},
{1,0," Output list of exclude patterns for excluding files/directories."},
{1,0," --list-extras[=(<language>|all)]"},
{1,0," Output list of extra tag flags."},
{1,0," --list-features"},
{1,0," Output list of compiled features."},
{1,0," --list-fields[=(<language>|all)]"},
{1,0," Output list of fields."},
{1,0," --list-kinds[=(<language>|all)]"},
{1,0," Output a list of all tag kinds for specified <language> or all."},
{1,0," --list-kinds-full[=(<language>|all)]"},
{1,0," List the details of all tag kinds for specified <language> or all"},
{1,0," For each line, associated language name is printed when \"all\" is"},
{1,0," specified as language."},
{1,0," --list-languages"},
{1,0," Output list of supported languages."},
{1,0," --list-map-extensions[=(<language>|all)]"},
{1,0," Output list of language extensions in mapping."},
{1,0," --list-map-patterns[=(<language>|all)]"},
{1,0," Output list of language patterns in mapping."},
{1,0," --list-maps[=(<language>|all)]"},
{1,0," Output list of language mappings (both extensions and patterns)."},
{1,0," --list-mline-regex-flags"},
{1,0," Output list of flags which can be used in a multiline regex parser definition."},
{1,0," --list-params[=(<language>|all)]"},
{1,0," Output list of language parameters. This works with --machinable."},
{0,0," --list-pseudo-tags"},
{0,0," Output list of pseudo tags."},
{1,0," --list-regex-flags"},
{1,0," Output list of flags which can be used in a regex parser definition."},
{1,0," --list-roles[=(<language>|all)[.(<kindspecs>|*)]]"},
{1,0," Output list of all roles of tag kind(s) specified for <language>."},
{1,0," Both letters and names can be used in <kindspecs>."},
{1,0," e.g. --list-roles=C.{header}d"},
{1,0," --list-subparsers[=(<baselang>|all)]"},
{1,0," Output list of subparsers for the base language."},
{1,0," --machinable[=(yes|no)]"},
{1,0," Use tab separated representation in --list-* option output. [no]"},
{1,0," --list-{aliases,extras,features,fields,kind-full,langdef-flags,params," },
{1,0," pseudo-tags,regex-flags,roles,subparsers} support this option."},
{1,0," Suitable for scripting. Specify before --list-* option."},
{1,0," --with-list-header[=(yes|no)]"},
{1,0," Prepend the column descriptions in --list- output. [yes]"},
{1,0," --list-{aliases,extras,features,fields,kind-full,langdef-flags,params," },
{1,0," pseudo-tags,regex-flags,roles,subparsers} support this option."},
{1,0," Specify before --list-* option."},
{1,1," --_list-kinddef-flags"},
{1,1," Output list of flags which can be used with --kinddef option."},
{1,1," --_list-langdef-flags"},
{1,1," Output list of flags which can be used with --langdef option."},
{1,1," --_list-mtable-regex-flags"},
{1,1," Output list of flags which can be used in a multitable regex parser definition."},
{1,1," --_list-operators"},
{1,1," Output list of optscript operators."},
{1,0,""},
{1,0,"Miscellaneous Options"},
{1,0," --help"},
{1,0," Print this option summary."},
{1,0," -? Print this option summary."},
{1,0," --help-full"},
{1,0," Print this option summary including experimental features."},
{1,0," --license"},
{1,0," Print details of software license."},
{0,0," --print-language"},
{0,0," Don't make tags file but just print the guessed language name for"},
{0,0," input file."},
{1,0," --quiet[=(yes|no)]"},
{0,0," Don't print NOTICE class messages [no]."},
{1,0," --totals[=(yes|no|extra)]"},
{1,0," Print statistics about input and tag files [no]."},
{1,0," --verbose[=(yes|no)]"},
{1,0," Enable verbose messages describing actions on each input file."},
{1,0," --version[=<language>]"},
{1,0," Print version identifier of the program to standard output."},
{1,0," Print version identifier of the parser for <language>."},
{1,0," -V Equivalent to --verbose."},
#ifdef DEBUG
{1,0," -b <line>"},
{1,0," Set break line. (for DEBUG)"},
{1,0," -d <level>"},
{1,0," Set debug level. (for DEBUG)"},
#endif
{1,1," --_anonhash=<fname>"},
{1,1," Used in u-ctags test harness"},
{1,1," --_dump-keywords"},
{1,1," Dump keywords of initialized parser(s)."},
{1,1," --_dump-options"},
{1,1," Dump options."},
{1,1," --_dump-prelude"},
{1,1," Dump contents of optscript prelude."},
{1,1," --_fatal-warnings"},
{1,1," Make all warnings fatal."},
{1,1," --_force-initializing"},
{1,1," Initialize all parsers in early stage"},
#ifdef HAVE_JANSSON
{0,1," --_interactive"
#ifdef HAVE_SECCOMP
"[=(default|sandbox)]"
#endif
},
{0,1," Enter interactive mode (JSON over stdio)."},
#ifdef HAVE_SECCOMP
{0,1," Enter file I/O limited interactive mode if sandbox is specified. [default]"},
#endif
#endif
#ifdef DO_TRACING
{1,1," --_trace=<list>"},
{1,1," Trace parsers for the languages."},
#endif
{1,1, NULL}
};
static const char* const License1 =
"This program is free software; you can redistribute it and/or\n"
"modify it under the terms of the GNU General Public License\n"
"as published by the Free Software Foundation; either version 2"
"of the License, or (at your option) any later version.\n"
"\n";
static const char* const License2 =
"This program is distributed in the hope that it will be useful,\n"
"but WITHOUT ANY WARRANTY; without even the implied warranty of\n"
"MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n"
"GNU General Public License for more details.\n"
"\n"
"You should have received a copy of the GNU General Public License\n"
"along with this program; if not, write to the Free Software\n"
"Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\n";
/* Contains a set of strings describing the set of "features" compiled into
* the code.
*/
static struct Feature {
const char *name;
const char *description;
} Features [] = {
#ifdef _WIN32
{"win32", "TO BE WRITTEN"},
#endif
/* Following two features are always available on universal ctags */
{"wildcards", "can use glob matching"},
{"regex", "can use regular expression based pattern matching"},
#ifdef USE_GNULIB_FNMATCH
{"gnulib_fnmatch", "linked with the Gnulib fnmatch library"},
#endif
/* https://lists.gnu.org/archive/html/bug-gnulib/2011-07/msg00435.html */
#ifdef _REGEX_INCLUDE_LIMITS_H
{"gnulib_regex", "linked with the Gnulib regular expression library"},
#endif
#ifndef EXTERNAL_SORT
{"internal-sort", "uses internal sort routine instead of invoking sort command"},
#endif
#ifdef CUSTOM_CONFIGURATION_FILE
{"custom-conf", "read \"" CUSTOM_CONFIGURATION_FILE "\" as config file"},
#endif
#if defined (_WIN32)
{"unix-path-separator", "can use '/' as file name separator"},
#endif
#ifdef HAVE_ICONV
{"iconv", "can convert input/output encodings"},
#endif
#ifdef DEBUG
{"debug", "TO BE WRITTEN"},
#endif
#if defined (HAVE_DIRENT_H) || defined (_MSC_VER)
{"option-directory", "TO BE WRITTEN"},
#endif
#ifdef HAVE_LIBXML
{"xpath", "linked with library for parsing xml input"},
#endif
#ifdef HAVE_JANSSON
{"json", "supports json format output"},
{"interactive", "accepts source code from stdin"},
#endif
#ifdef HAVE_SECCOMP
{"sandbox", "linked with code for system call level sandbox"},
#endif
#ifdef HAVE_LIBYAML
{"yaml", "linked with library for parsing yaml input"},
#endif
#ifdef CASE_INSENSITIVE_FILENAMES
{"case-insensitive-filenames", "TO BE WRITTEN"},
#endif
#ifdef ENABLE_GCOV
{"gcov", "linked with code for coverage analysis"},
#endif
#ifdef HAVE_PACKCC
/* The test harnesses use this as hints for skipping test cases */
{"packcc", "has peg based parser(s)"},
#ifdef HAVE_PEGOF
{"pegof", "makes peg based parser(s) optimized (experimental)"},
#endif
#endif
{"optscript", "can use the interpreter"},
#ifdef HAVE_PCRE2
{"pcre2", "has pcre2 regex engine"},
#endif
{NULL,}
};
static const char *const StageDescription [] = {
[OptionLoadingStageNone] = "not initialized",
[OptionLoadingStageCustom] = "custom file",
[OptionLoadingStageXdg] = "file(s) under $XDG_CONFIG_HOME and $HOME/.config",
[OptionLoadingStageHomeDir] = "file(s) under $HOME",
[OptionLoadingStageCurrentDir] = "file(s) under the current directory",
[OptionLoadingStageCmdline] = "command line",
};
/*
* FUNCTION PROTOTYPES
*/
static bool parseFileOptions (const char *const fileName);
static bool parseAllConfigurationFilesOptionsInDirectory (const char *const fileName,
stringList* const already_loaded_files);
static bool getBooleanOption (const char *const option, const char *const parameter);
/*
* FUNCTION DEFINITIONS
*/
#ifndef HAVE_ASPRINTF
/* Some versions of MinGW are missing _vscprintf's declaration, although they
* still provide the symbol in the import library.
*/
#ifdef __MINGW32__
_CRTIMP int _vscprintf(const char *format, va_list argptr);
#endif
#ifndef va_copy
#define va_copy(dest, src) (dest = src)
#endif
int asprintf(char **strp, const char *fmt, ...)
{
va_list args;
va_list args_copy;
int length;
size_t size;
va_start(args, fmt);
va_copy(args_copy, args);
#ifdef _WIN32
/* We need to use _vscprintf to calculate the length as vsnprintf returns -1
* if the number of characters to write is greater than count.
*/
length = _vscprintf(fmt, args_copy);
#else
char dummy;
length = vsnprintf(&dummy, sizeof dummy, fmt, args_copy);
#endif
va_end(args_copy);
Assert(length >= 0);
size = length + 1;
*strp = malloc(size);
if (!*strp) {
return -1;
}
va_start(args, fmt);
vsnprintf(*strp, size, fmt, args);
va_end(args);
return length;
}
#endif
extern void verbose (const char *const format, ...)
{
if (ctags_verbose)
{
va_list ap;
va_start (ap, format);
vfprintf (stderr, format, ap);
va_end (ap);
}
}
static char *stringCopy (const char *const string)
{
char* result = NULL;
if (string != NULL)
result = eStrdup (string);
return result;
}
static void freeString (char **const pString)
{
if (*pString != NULL)
{
eFree (*pString);
*pString = NULL;
}
}
extern void freeList (stringList** const pList)
{
if (*pList != NULL)
{
stringListDelete (*pList);
*pList = NULL;
}
}
extern void setDefaultTagFileName (void)
{
if (Option.filter || Option.interactive)
return;
if (Option.tagFileName == NULL)
{
const char *tmp = outputDefaultFileName ();
if (tmp == NULL)
tmp = "-";
Option.tagFileName = stringCopy (tmp);
}
}
extern bool filesRequired (void)
{
bool result = FilesRequired;
if (Option.recurse)
result = false;
return result;
}
extern void checkOptions (void)
{
const char* notice;
if (Option.xref && (Option.customXfmt == NULL))
{
notice = "xref output";
if (isXtagEnabled(XTAG_FILE_NAMES))
{
error (WARNING, "%s disables file name tags", notice);
enableXtag (XTAG_FILE_NAMES, false);
}
}
if (Option.append)
{
notice = "append mode is not compatible with";
if (isDestinationStdout ())
error (FATAL, "%s tags to stdout", notice);
}
if (Option.filter)
{
notice = "filter mode";
if (Option.printTotals)
{
error (WARNING, "%s disables totals", notice);
Option.printTotals = 0;
}
if (Option.tagFileName != NULL)
error (WARNING, "%s ignores output tag file name", notice);
}
writerCheckOptions (Option.fieldsReset);
}
extern langType getLanguageComponentInOptionFull (const char *const option,
const char *const prefix,
bool noPretending)
{
size_t prefix_len;
langType language;
const char *lang;
char *sep = NULL;
size_t lang_len = 0;
Assert (prefix && prefix[0]);
Assert (option);
prefix_len = strlen (prefix);
if (strncmp (option, prefix, prefix_len) != 0)
return LANG_IGNORE;
else
{
lang = option + prefix_len;
if (lang [0] == '\0')
return LANG_IGNORE;
}
/* Extract <LANG> from
* --param-<LANG>.<PARAM>=..., and
* --_roledef-<LANG>.<KIND>=... */
/* `:' is only for keeping self compatibility. */
sep = strpbrk (lang, ":.");
if (sep)
{
if (*sep == ':')
error (WARNING, "using `:' as a separator is obsolete; use `.' instead: --%s", option);
lang_len = sep - lang;
}
language = getNamedLanguageFull (lang, lang_len, noPretending, false);
if (language == LANG_IGNORE)
{
const char *langName = (lang_len == 0)? lang: eStrndup (lang, lang_len);
error (FATAL, "Unknown language \"%s\" in \"%s\" option", langName, option);
}
return language;
}
extern langType getLanguageComponentInOption (const char *const option,
const char *const prefix)
{
return getLanguageComponentInOptionFull (option, prefix, false);
}
static void setEtagsMode (void)
{
Option.etags = true;
Option.sorted = SO_UNSORTED;
Option.lineDirectives = false;
Option.tagRelative = TREL_YES;
enableLanguage (LANG_FALLBACK, true);
setTagWriter (WRITER_ETAGS, NULL);
}
extern void testEtagsInvocation (void)
{
char* const execName = eStrdup (getExecutableName ());
char* const etags = eStrdup (ETAGS);
#ifdef CASE_INSENSITIVE_FILENAMES
toLowerString (execName);
toLowerString (etags);
#endif
if (strstr (execName, etags) != NULL)
{
verbose ("Running in etags mode\n");
setEtagsMode ();
}
eFree (execName);
eFree (etags);
}
static void setXrefMode (void)
{
Option.xref = true;
setTagWriter (WRITER_XREF, NULL);
}
#ifdef HAVE_JANSSON
static void setJsonMode (void)
{
enablePtag (PTAG_JSON_OUTPUT_VERSION, true);
enablePtag (PTAG_OUTPUT_MODE, false);
enablePtag (PTAG_FILE_FORMAT, false);
setTagWriter (WRITER_JSON, NULL);
}
#endif
/*
* Cooked argument parsing
*/
static void parseShortOption (cookedArgs *const args)
{
args->simple [0] = *args->shortOptions++;
args->simple [1] = '\0';
args->item = eStrdup (args->simple);
if (! isCompoundOption (*args->simple))
args->parameter = "";
else if (*args->shortOptions == '\0')
{
argForth (args->args);
if (argOff (args->args))
args->parameter = NULL;
else
args->parameter = argItem (args->args);
args->shortOptions = NULL;
}
else
{
args->parameter = args->shortOptions;
args->shortOptions = NULL;
}
}
static void parseLongOption (cookedArgs *const args, const char *item)
{
const char* const equal = strchr (item, '=');
if (equal == NULL)
{
args->item = eStrdup (item);
args->parameter = "";
}
else
{
args->item = eStrndup (item, equal - item);
args->parameter = equal + 1;
}
Assert (args->item != NULL);
Assert (args->parameter != NULL);
}
static void cArgRead (cookedArgs *const current)
{
char* item;
Assert (current != NULL);
if (! argOff (current->args))
{
item = argItem (current->args);
current->shortOptions = NULL;
Assert (item != NULL);
if (strncmp (item, "--", (size_t) 2) == 0)
{
current->isOption = true;
current->longOption = true;
parseLongOption (current, item + 2);
Assert (current->item != NULL);
Assert (current->parameter != NULL);
}
else if (*item == '-')
{
current->isOption = true;
current->longOption = false;
current->shortOptions = item + 1;
parseShortOption (current);
}
else
{
current->isOption = false;
current->longOption = false;
current->item = eStrdup (item);
current->parameter = NULL;
}
}
}
extern cookedArgs* cArgNewFromString (const char* string)
{
cookedArgs* const result = xMalloc (1, cookedArgs);
memset (result, 0, sizeof (cookedArgs));
result->args = argNewFromString (string);
cArgRead (result);
return result;
}
extern cookedArgs* cArgNewFromArgv (char* const* const argv)
{
cookedArgs* const result = xMalloc (1, cookedArgs);
memset (result, 0, sizeof (cookedArgs));
result->args = argNewFromArgv (argv);
cArgRead (result);
return result;
}
extern cookedArgs* cArgNewFromFile (FILE* const fp)
{
cookedArgs* const result = xMalloc (1, cookedArgs);
memset (result, 0, sizeof (cookedArgs));
result->args = argNewFromFile (fp);
cArgRead (result);
return result;
}
extern cookedArgs* cArgNewFromLineFile (FILE* const fp)
{
cookedArgs* const result = xMalloc (1, cookedArgs);
memset (result, 0, sizeof (cookedArgs));
result->args = argNewFromLineFile (fp);
cArgRead (result);
return result;
}
extern void cArgDelete (cookedArgs* const current)
{
Assert (current != NULL);
argDelete (current->args);
if (current->item != NULL)
eFree (current->item);
memset (current, 0, sizeof (cookedArgs));