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
|
/*
* Copyright (c) 1998-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.
*
* Private definitions for parsing support.
*/
#ifndef CTAGS_MAIN_PARSE_PRIVATE_H
#define CTAGS_MAIN_PARSE_PRIVATE_H
/*
* INCLUDE FILES
*/
#include "general.h" /* must always come first */
#include "kind.h"
#include "lregex_p.h"
#include "parse.h"
#include "parsers_p.h" /* contains list of parsers */
#include "strlist.h"
#ifdef EXTERNAL_PARSER_LIST_FILE
#include EXTERNAL_PARSER_LIST_FILE
#endif
/*
* MACROS
*/
#define LANG_FALLBACK (1)
/*
* DATA DECLARATIONS
*/
typedef enum {
LMAP_PATTERN = 1 << 0,
LMAP_EXTENSION = 1 << 1,
LMAP_ALL = LMAP_PATTERN | LMAP_EXTENSION,
LMAP_TABLE_OUTPUT = 1 << 2,
} langmapType;
enum parserCategory
{
PARSER_CATEGORY_NONE,
PARSER_CATEGORY_LIBXML,
PARSER_CATEGORY_LIBYAML,
PARSER_CATEGORY_PACKCC,
};
/*
* FUNCTION PROTOTYPES
*/
/* Each parsers' definition function is called. The routine is expected to
* return a structure allocated using parserNew(). This structure must,
* at minimum, set the `parser' field.
*/
#ifdef EXTERNAL_PARSER_LIST
extern parserDefinitionFunc EXTERNAL_PARSER_LIST;
#else /* ! EXTERNAL_PARSER_LIST */
extern parserDefinitionFunc PARSER_LIST;
#ifdef HAVE_LIBXML
extern parserDefinitionFunc XML_PARSER_LIST;
#endif
#ifdef HAVE_LIBYAML
extern parserDefinitionFunc YAML_PARSER_LIST;
#endif
#ifdef HAVE_PACKCC
extern parserDefinitionFunc PEG_PARSER_LIST;
#endif
#ifdef HAVE_PCRE2
extern parserDefinitionFunc OPTLIB2C_PCRE2_PARSER_LIST;
#endif
#endif /* EXTERNAL_PARSER_LIST */
extern bool doesLanguageAllowNullTag (const langType language);
extern bool doesLanguageRequestAutomaticFQTag (const langType language);
extern langType getNamedLanguageFull (const char *const name, size_t len, bool noPretending, bool include_aliases);
extern kindDefinition* getLanguageKind(const langType language, int kindIndex);
extern kindDefinition* getLanguageKindForLetter (const langType language, char kindLetter);
extern roleDefinition* getLanguageRole(const langType language, int kindIndex, int roleIndex);
extern unsigned int getLanguageVersionCurrent (const langType language);
extern unsigned int getLanguageVersionAge (const langType language);
extern int defineLanguageKind (const langType language, kindDefinition *def,
freeKindDefFunc freeKindDef);
extern unsigned int countLanguageKinds (const langType language);
extern unsigned int countLanguageRoles (const langType language, int kindIndex);
extern bool isLanguageKindRefOnly (const langType language, int kindIndex);
extern bool isLanguageVisible (const langType language);
extern void installLanguageMapDefault (const langType language);
extern void installLanguageMapDefaults (void);
extern void clearLanguageMap (const langType language);
extern bool removeLanguageExtensionMap (const langType language, const char *const extension);
extern void addLanguageExtensionMap (const langType language, const char* extension,
bool exclusiveInAllLanguages);
extern bool removeLanguagePatternMap (const langType language, const char *const pattern);
extern void addLanguagePatternMap (const langType language, const char* ptrn,
bool exclusiveInAllLanguages);
extern void installLanguageAliasesDefault (const langType language);
extern void installLanguageAliasesDefaults (void);
extern void clearLanguageAliases (const langType language);
extern void addLanguageAlias (const langType language, const char* alias);
extern void printLanguageMaps (const langType language, langmapType type,
bool withListHeader, bool machinable, FILE *fp);
extern void enableLanguages (const bool state);
extern void enableLanguage (const langType language, const bool state);
extern void initializeParsing (void);
extern unsigned int countParsers (void);
extern void freeParserResources (void);
extern void enableDefaultFileKind (bool state);
extern void printLanguageKinds (const langType language, bool allKindFields,
bool withListHeader, bool machinable, FILE *fp);
extern void printLanguageRoles (const langType language, const char* letters,
bool withListHeader, bool machinable, FILE *fp);
extern void printLanguageAliases (const langType language,
bool withListHeader, bool machinable, FILE *fp);
extern void printLanguageList (enum parserCategory category);
extern void printLanguageParams (const langType language,
bool withListHeader, bool machinable, FILE *fp);
extern void printLanguageSubparsers (const langType language,
bool withListHeader, bool machinable, FILE *fp);
extern void printLangdefFlags (bool withListHeader, bool machinable, FILE *fp);
extern void printKinddefFlags (bool withListHeader, bool machinable, FILE *fp);
extern void printFielddefFlags (bool withListHeader, bool machinable, FILE *fp);
extern bool doesParserRequireMemoryStream (const langType language);
extern bool parseFile (const char *const fileName);
extern bool parseFileWithMio (const char *const fileName, MIO *mio, void *clientData);
extern bool parseRawBuffer(const char *fileName, unsigned char *buffer,
size_t bufferSize, const langType language, void *clientData);
extern bool runParserInArea (const langType language,
unsigned long startLine, long startCharOffset,
unsigned long endLine, long endCharOffset,
unsigned long sourceLineOffset,
int promise);
#ifdef HAVE_ICONV
extern void freeEncodingResources (void);
#endif
extern bool doesLanguageHaveForeignDependency (const langType language, const langType foreign_lang);
/* Regex interface */
extern bool processLanguageRegexOption (langType language, enum regexParserType regptype, const char *const parameter);
extern void notifyLanguageRegexInputStart (langType language);
extern void notifyLanguageRegexInputEnd (langType language);
extern bool hasLanguagePostRunRegexPatterns (const langType language);
extern void matchLanguageRegex (const langType language, const vString* const line, bool postrun);
extern void freeRegexResources (void);
extern bool checkRegex (void);
extern void useRegexMethod (const langType language);
extern void printRegexFlags (bool withListHeader, bool machinable, const char *flags, FILE *fp);
extern void printMultilineRegexFlags (bool withListHeader, bool machinable, const char *flags, FILE *fp);
extern void printMultitableRegexFlags (bool withListHeader, bool machinable, const char *flags, FILE *fp);
extern bool doesLanguageExpectCorkInRegex (const langType language);
/* Multiline Regex Interface */
extern bool hasLanguageMultilineRegexPatterns (const langType language);
extern void matchLanguageMultilineRegex (const langType language, const vString* const allLines);
extern void matchLanguageMultitableRegex (const langType language, const vString* const allLines);
extern void processLanguageMultitableExtendingOption (langType language, const char *const parameter);
extern unsigned int getXpathFileSpecCount (const langType language);
extern xpathFileSpec* getXpathFileSpec (const langType language, unsigned int nth);
const tagXpathTableTable *getXpathTableTable (const langType language, unsigned int nth);
extern bool makeKindSeparatorsPseudoTags (const langType language,
const ptagDesc *pdesc);
extern bool makeKindDescriptionsPseudoTags (const langType language,
const ptagDesc *pdesc);
extern bool makeFieldDescriptionsPseudoTags (const langType language,
const ptagDesc *pdesc);
extern bool makeExtraDescriptionsPseudoTags (const langType language,
const ptagDesc *pdesc);
extern bool makeRoleDescriptionsPseudoTags (const langType language,
const ptagDesc *pdesc);
extern bool makeParserVersionPseudoTags (const langType language,
const ptagDesc *pdesc);
extern void printLanguageMultitableStatistics (langType language);
extern void printParserStatisticsIfUsed (langType lang);
/* For keeping the API compatibility with Geany, we use a macro here. */
#define applyLanguageParam applyParameter
#endif /* CTAGS_MAIN_PARSE_PRIVATE_H */
|
