Merge pull request #1961 from masatake/cleanup-inclusions

Defining interface for parsers (part 5 of N)
universal-ctags · Dec 28, 2018 · 18bf3a4 · 18bf3a4
2 parents 5728abe + ec40f18
commit 18bf3a4
Show file tree

Hide file tree

Showing 44 changed files with 418 additions and 206 deletions.
diff --git a/main/debug.c b/main/debug.c
@@ -23,6 +23,7 @@
 #include "options.h"
 #include "parse_p.h"
 #include "read.h"
+#include "read_p.h"
 
 /*
 *   FUNCTION DEFINITIONS

diff --git a/main/entry.c b/main/entry.c
@@ -43,11 +43,12 @@
 #include "field.h"
 #include "fmt_p.h"
 #include "kind.h"
-#include "main.h"
+#include "main_p.h"
 #include "nestlevel.h"
 #include "options_p.h"
 #include "ptag_p.h"
 #include "read.h"
+#include "read_p.h"
 #include "routines.h"
 #include "routines_p.h"
 #include "parse_p.h"
@@ -57,7 +58,7 @@
 #include "subparser_p.h"
 #include "trashbox.h"
 #include "writer_p.h"
-#include "xtag.h"
+#include "xtag_p.h"
 
 /*
 *   MACROS

diff --git a/main/entry.h b/main/entry.h
@@ -20,6 +20,8 @@
 #include "field.h"
 #include "xtag.h"
 #include "mio.h"
+#include "ptrarray.h"
+#include "nestlevel.h"
 
 /*
 *   MACROS
@@ -142,12 +144,4 @@ extern bool isTagExtraBitMarked (const tagEntryInfo *const tag, xtagType extra);
 extern void attachParserField (tagEntryInfo *const tag, fieldType ftype, const char* value);
 extern void attachParserFieldToCorkEntry (int index, fieldType ftype, const char* value);
 
-CTAGS_INLINE roleBitsType makeRoleBit(int roleIndex)
-{
-	if (roleIndex == ROLE_INDEX_DEFINITION)
-		return 0;
-	else
-		return ((roleBitsType)1) << roleIndex;
-}
-
 #endif  /* CTAGS_MAIN_ENTRY_H */
diff --git a/main/entry_p.h b/main/entry_p.h
@@ -65,4 +65,13 @@ extern void makeFileTag (const char *const fileName);
 
 extern const tagField* getParserField (const tagEntryInfo * tag, int index);
 
+
+CTAGS_INLINE roleBitsType makeRoleBit(int roleIndex)
+{
+	if (roleIndex == ROLE_INDEX_DEFINITION)
+		return 0;
+	else
+		return ((roleBitsType)1) << roleIndex;
+}
+
 #endif	/* CTAGS_PRIVATE_ENTRY_H */
diff --git a/main/field.c b/main/field.c
@@ -27,6 +27,7 @@
 #include "read.h"
 #include "routines.h"
 #include "trashbox.h"
+#include "xtag_p.h"
 
 
 typedef struct sFieldObject {

diff --git a/main/kind.h b/main/kind.h
@@ -8,10 +8,17 @@
 #ifndef CTAGS_MAIN_KIND_H
 #define CTAGS_MAIN_KIND_H
 
+/*
+*   INCLUDE FILES
+*/
+
 #include "general.h"
 #include "types.h"
 #include "routines.h"
-#include "vstring.h"
+
+/*
+*   DATA DECLARATIONS
+*/
 
 struct sRoleDefinition {
 	bool enabled;
@@ -21,9 +28,6 @@ struct sRoleDefinition {
 	int id;
 };
 
-typedef void (* freeRoleDefFunc) (roleDefinition *);
-extern const char *renderRole (const roleDefinition* const def, vString* b);
-
 /*
  * Predefined kinds
  */
@@ -81,49 +85,10 @@ struct sKindDefinition {
 #define ATTACH_ROLES(RS) .nRoles = ARRAY_SIZE(RS), .roles = RS
 #define ATTACH_SEPARATORS(S) .separators = S, .separatorCount = ARRAY_SIZE(S)
 
-/* for the obsolete --list-kinds option */
-extern void printKind (const kindDefinition* const kind, bool indent);
+/*
+*   FUNCTION PROTOTYPES
+*/
 
 extern const char *scopeSeparatorFor (langType lang, int kindIndex, int parentKindIndex);
 
-extern void enableKind (kindDefinition *kind, bool enable);
-
-struct kindControlBlock;
-typedef void (* freeKindDefFunc) (kindDefinition *);
-extern struct kindControlBlock* allocKindControlBlock (parserDefinition *parser);
-extern void freeKindControlBlock (struct kindControlBlock* kcb);
-extern int  defineKind (struct kindControlBlock* kcb, kindDefinition *def,
-						freeKindDefFunc freeKindDef);
-extern int defineRole (struct kindControlBlock* kcb, int kindIndex,
-					   roleDefinition *def, freeRoleDefFunc freeRoleDef);
-extern bool isRoleEnabled (struct kindControlBlock* kcb, int kindIndex, int roleIndex);
-
-extern unsigned int countKinds (struct kindControlBlock* kcb);
-extern unsigned int countRoles (struct kindControlBlock* kcb, int kindIndex);
-extern kindDefinition *getKind (struct kindControlBlock* kcb, int kindIndex);
-extern kindDefinition *getKindForLetter (struct kindControlBlock* kcb, int letter);
-extern kindDefinition *getKindForName (struct kindControlBlock* kcb, const char* name);
-extern roleDefinition* getRole(struct kindControlBlock* kcb, int kindIndex, int roleIndex);
-extern roleDefinition* getRoleForName(struct kindControlBlock* kcb, int kindIndex, const char* name);
-extern void linkKindDependency (struct kindControlBlock *masterKCB,
-								struct kindControlBlock *slaveKCB);
-
-/* for --list-kinds-full option. LANGUAGE must be initialized. */
-extern struct colprintTable * kindColprintTableNew (void);
-extern void kindColprintAddLanguageLines (struct colprintTable *table,
-										  struct kindControlBlock* kcb);
-extern void kindColprintTablePrint (struct colprintTable *table, bool noparser,
-									bool withListHeader, bool machinable, FILE *fp);
-
-extern struct colprintTable * roleColprintTableNew (void);
-extern void roleColprintAddRoles (struct colprintTable *table,
-								  struct kindControlBlock* kcb,
-								  const char *kindspecs);
-extern void roleColprintTablePrint (struct colprintTable *table, bool noparser,
-									bool withListHeader, bool machinable, FILE *fp);
-
-#ifdef DEBUG
-extern bool doesParserUseKind (struct kindControlBlock* kcb, char letter);
-#endif
-
 #endif	/* CTAGS_MAIN_KIND_H */
diff --git a/main/kind_p.h b/main/kind_p.h
@@ -0,0 +1,74 @@
+/*
+*   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.
+*
+*/
+#ifndef CTAGS_MAIN_KIND_PRIVATE_H
+#define CTAGS_MAIN_KIND_PRIVATE_H
+
+/*
+*   INCLUDE FILES
+*/
+
+#include "general.h"
+#include "vstring.h"
+
+
+/*
+*   DATA DECLARATIONS
+*/
+
+struct kindControlBlock;
+typedef void (* freeKindDefFunc) (kindDefinition *);
+typedef void (* freeRoleDefFunc) (roleDefinition *);
+
+
+/*
+*   FUNCTION PROTOTYPES
+*/
+extern void enableKind (kindDefinition *kind, bool enable);
+extern const char *renderRole (const roleDefinition* const def, vString* b);
+
+extern struct kindControlBlock* allocKindControlBlock (parserDefinition *parser);
+extern void freeKindControlBlock (struct kindControlBlock* kcb);
+
+extern int  defineKind (struct kindControlBlock* kcb, kindDefinition *def,
+						freeKindDefFunc freeKindDef);
+extern int defineRole (struct kindControlBlock* kcb, int kindIndex,
+					   roleDefinition *def, freeRoleDefFunc freeRoleDef);
+extern bool isRoleEnabled (struct kindControlBlock* kcb, int kindIndex, int roleIndex);
+
+extern unsigned int countKinds (struct kindControlBlock* kcb);
+extern unsigned int countRoles (struct kindControlBlock* kcb, int kindIndex);
+extern kindDefinition *getKind (struct kindControlBlock* kcb, int kindIndex);
+extern kindDefinition *getKindForLetter (struct kindControlBlock* kcb, int letter);
+extern kindDefinition *getKindForName (struct kindControlBlock* kcb, const char* name);
+extern roleDefinition* getRole(struct kindControlBlock* kcb, int kindIndex, int roleIndex);
+extern roleDefinition* getRoleForName(struct kindControlBlock* kcb, int kindIndex, const char* name);
+extern void linkKindDependency (struct kindControlBlock *masterKCB,
+								struct kindControlBlock *slaveKCB);
+
+/* for the obsolete --list-kinds option */
+extern void printKind (const kindDefinition* const kind, bool indent);
+
+/* for --list-kinds-full option. LANGUAGE must be initialized. */
+extern struct colprintTable * kindColprintTableNew (void);
+extern void kindColprintAddLanguageLines (struct colprintTable *table,
+										  struct kindControlBlock* kcb);
+extern void kindColprintTablePrint (struct colprintTable *table, bool noparser,
+									bool withListHeader, bool machinable, FILE *fp);
+
+extern struct colprintTable * roleColprintTableNew (void);
+extern void roleColprintAddRoles (struct colprintTable *table,
+								  struct kindControlBlock* kcb,
+								  const char *kindspecs);
+extern void roleColprintTablePrint (struct colprintTable *table, bool noparser,
+									bool withListHeader, bool machinable, FILE *fp);
+
+#ifdef DEBUG
+extern bool doesParserUseKind (struct kindControlBlock* kcb, char letter);
+#endif
+
+#endif	/* CTAGS_MAIN_KIND_PRIVATE_H */
diff --git a/main/lregex.c b/main/lregex.c
@@ -27,16 +27,18 @@
 
 #include "debug.h"
 #include "colprint_p.h"
-#include "entry.h"
+#include "entry_p.h"
 #include "flags_p.h"
 #include "htable.h"
 #include "kind.h"
 #include "options.h"
 #include "parse_p.h"
 #include "read.h"
+#include "read_p.h"
 #include "routines.h"
 #include "routines_p.h"
 #include "trashbox.h"
+#include "xtag_p.h"
 
 static bool regexAvailable = false;
 

diff --git a/main/lregex_p.h b/main/lregex_p.h
@@ -19,6 +19,7 @@
 *   INCLUDE FILES
 */
 #include "general.h"
+#include "kind_p.h"
 #include "lregex.h"
 
 /*

diff --git a/main/lxpath.c b/main/lxpath.c
@@ -14,6 +14,7 @@
 #include "options.h"
 #include "parse_p.h"
 #include "read.h"
+#include "read_p.h"
 #include "routines.h"
 #include "xtag.h"
 

diff --git a/main/lxpath.h b/main/lxpath.h
@@ -10,6 +10,10 @@
 #ifndef CTAGS_LXPATH_PARSE_H
 #define CTAGS_LXPATH_PARSE_H
 
+/*
+*   INCLUDE FILES
+*/
+
 #include "general.h"  /* must always come first */
 #include "types.h"
 
@@ -22,6 +26,11 @@
 #define xmlXPathContext void
 #endif
 
+
+/*
+*   DATA DECLARATIONS
+*/
+
 typedef struct sTagXpathMakeTagSpec {
 	int   kind;
 	int   role;
@@ -72,10 +81,14 @@ typedef struct sXpathFileSpec {
 	const char *rootNSHref;
 } xpathFileSpec;
 
+
+/*
+*   FUNCTION PROTOTYPES
+*/
+
 /* Xpath interface */
 extern void findXMLTags (xmlXPathContext *ctx, xmlNode *root,
 			 const tagXpathTableTable *xpathTableTable,
 			 const kindDefinition* const kinds, void *userData);
-extern void addTagXpath (const langType language, tagXpathTable *xpathTable);
 
 #endif  /* CTAGS_LXPATH_PARSE_H */
diff --git a/main/lxpath_p.h b/main/lxpath_p.h
@@ -0,0 +1,27 @@
+/*
+*   Copyright (c) 2016, Masatake YAMATO
+*   Copyright (c) 2016, Red Hat, Inc.
+*
+*   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.
+*
+*   Xpath based parer API for the main part
+*/
+#ifndef CTAGS_LXPATH_PARSE_PRIVATE_H
+#define CTAGS_LXPATH_PARSE_PRIVATE_H
+
+/*
+*   INCLUDE FILES
+*/
+
+#include "general.h"  /* must always come first */
+#include "types.h"
+
+
+/*
+*   FUNCTION PROTOTYPES
+*/
+
+extern void addTagXpath (const langType language, tagXpathTable *xpathTable);
+
+#endif  /* CTAGS_LXPATH_PARSE_PRIVATE_H */
diff --git a/main/main.c b/main/main.c
@@ -67,14 +67,15 @@
 #include "error_p.h"
 #include "field.h"
 #include "keyword_p.h"
-#include "main.h"
+#include "main_p.h"
 #include "options_p.h"
 #include "parse_p.h"
-#include "read.h"
+#include "read_p.h"
 #include "routines_p.h"
 #include "trace.h"
-#include "trashbox.h"
+#include "trashbox_p.h"
 #include "writer_p.h"
+#include "xtag_p.h"
 
 #ifdef HAVE_JANSSON
 #include "interactive_p.h"

diff --git a/main/main.h → main/main_p.h b/main/main.h → main/main_p.h
@@ -4,23 +4,21 @@
 *   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.
 *
-*   External interface to main.c
+*   Main part private interface to main.c
 */
-#ifndef CTAGS_MAIN_MAIN_H
-#define CTAGS_MAIN_MAIN_H
+#ifndef CTAGS_MAIN_MAIN_PRIVATE_H
+#define CTAGS_MAIN_MAIN_PRIVATE_H
 
 /*
 *   INCLUDE FILES
 */
 #include "general.h"  /* must always come first */
 
-#include <stdio.h>
-
 /*
 *   FUNCTION PROTOTYPES
 */
 extern void addTotals (const unsigned int files, const long unsigned int lines, const long unsigned int bytes);
 extern bool isDestinationStdout (void);
 extern int main (int argc, char **argv);
 
-#endif  /* CTAGS_MAIN_MAIN_H */
+#endif  /* CTAGS_MAIN_MAIN_PRIVATE_H */
diff --git a/main/nestlevel.c b/main/nestlevel.c
@@ -13,7 +13,6 @@
 */
 #include "general.h"  /* must always come first */
 
-#include "main.h"
 #include "debug.h"
 #include "entry.h"
 #include "routines.h"

diff --git a/main/nestlevel.h b/main/nestlevel.h
@@ -20,6 +20,7 @@
 /*
 *   DATA DECLARATIONS
 */
+typedef struct NestingLevel NestingLevel;
 typedef struct NestingLevels NestingLevels;
 
 struct NestingLevel