ptag_p.h File Reference

#include "general.h"
#include "types.h"

Include dependency graph for ptag_p.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	sPtagDesc

Macros
#define	PSEUDO_TAG_PREFIX   "!_"
#define	PSEUDO_TAG_SEPARATOR   "!"

Typedefs
typedef enum ePtagType	ptagType
typedef enum ePtagFlag	ptagFlag

Enumerations
enum	ePtagType {   PTAG_UNKNOWN = -1 , PTAG_JSON_OUTPUT_VERSION , PTAG_FILE_FORMAT , PTAG_FILE_SORTED ,   PTAG_PROGRAM_AUTHOR , PTAG_PROGRAM_NAME , PTAG_PROGRAM_URL , PTAG_PROGRAM_VERSION ,   PTAG_KIND_SEPARATOR , PTAG_KIND_DESCRIPTION , PTAG_FIELD_DESCRIPTION , PTAG_EXTRA_DESCRIPTION ,   PTAG_OUTPUT_MODE , PTAG_OUTPUT_FILESEP , PTAG_PATTERN_TRUNCATION , PTAG_PROC_CWD ,   PTAG_OUTPUT_EXCMD , PTAG_COUNT }
enum	ePtagFlag { PTAGF_COMMON = 1 << 0 , PTAGF_PARSER = 1 << 1 }

Functions
bool	makePtagIfEnabled (ptagType type, langType language, const void *data)
ptagDesc *	getPtagDesc (ptagType type)
ptagType	getPtagTypeForName (const char *name)
void	printPtags (bool withListHeader, bool machinable, FILE *fp)
bool	isPtagEnabled (ptagType type)
bool	isPtagCommonInParsers (ptagType type)
bool	isPtagParserSpecific (ptagType type)
bool	enablePtag (ptagType type, bool state)

Macro Definition Documentation

PSEUDO_TAG_PREFIX

#define PSEUDO_TAG_PREFIX   "!_"

Definition at line 18 of file ptag_p.h.

PSEUDO_TAG_SEPARATOR

#define PSEUDO_TAG_SEPARATOR   "!"

Definition at line 19 of file ptag_p.h.

Typedef Documentation

ptagFlag

typedef enum ePtagFlag ptagFlag

ptagType

typedef enum ePtagType ptagType

Enumeration Type Documentation

ePtagFlag

enum ePtagFlag

Enumerator
PTAGF_COMMON
PTAGF_PARSER

Definition at line 48 of file ptag_p.h.

ePtagType

enum ePtagType

Enumerator
PTAG_UNKNOWN
PTAG_JSON_OUTPUT_VERSION
PTAG_FILE_FORMAT
PTAG_FILE_SORTED
PTAG_PROGRAM_AUTHOR
PTAG_PROGRAM_NAME
PTAG_PROGRAM_URL
PTAG_PROGRAM_VERSION
PTAG_KIND_SEPARATOR
PTAG_KIND_DESCRIPTION
PTAG_FIELD_DESCRIPTION
PTAG_EXTRA_DESCRIPTION
PTAG_OUTPUT_MODE
PTAG_OUTPUT_FILESEP
PTAG_PATTERN_TRUNCATION
PTAG_PROC_CWD
PTAG_OUTPUT_EXCMD
PTAG_COUNT

Definition at line 21 of file ptag_p.h.

Function Documentation

enablePtag()

bool enablePtag	(	ptagType	type,
		bool	state
	)

Definition at line 225 of file ptag.c.

References Assert, sPtagDesc::enabled, PTAG_COUNT, and ptagDescs.

Referenced by processPseudoTags().

getPtagDesc()

ptagDesc * getPtagDesc

(

ptagType

type

)

Definition at line 238 of file ptag.c.

References NULL, PTAG_COUNT, PTAG_UNKNOWN, and ptagDescs.

Referenced by isPtagCommonInParsers(), and isPtagParserSpecific().

getPtagTypeForName()

ptagType getPtagTypeForName

(

const char *

name

)

Definition at line 247 of file ptag.c.

References Assert, name, PTAG_COUNT, PTAG_UNKNOWN, and ptagDescs.

Referenced by processPseudoTags().

isPtagCommonInParsers()

bool isPtagCommonInParsers

(

ptagType

type

)

Definition at line 258 of file ptag.c.

References sPtagDesc::flags, getPtagDesc(), and PTAGF_COMMON.

Referenced by addCommonPseudoTags().

isPtagEnabled()

bool isPtagEnabled

(

ptagType

type

)

Definition at line 214 of file ptag.c.

References Assert, sPtagDesc::enabled, PTAG_COUNT, and ptagDescs.

isPtagParserSpecific()

bool isPtagParserSpecific

(

ptagType

type

)

Definition at line 264 of file ptag.c.

References sPtagDesc::flags, getPtagDesc(), and PTAGF_PARSER.

Referenced by addParserPseudoTags().

makePtagIfEnabled()

bool makePtagIfEnabled	(	ptagType	type,
		langType	language,
		const void *	data
	)

Definition at line 201 of file ptag.c.

References Assert, sPtagDesc::enabled, sPtagDesc::makeTag, PTAG_COUNT, and ptagDescs.

Referenced by addCommonPseudoTags(), and addParserPseudoTags().

printPtags()

void printPtags	(	bool	withListHeader,
		bool	machinable,
		FILE *	fp
	)

Definition at line 277 of file ptag.c.

References colprintLineAppendColumnCString(), colprintTableDelete(), colprintTableGetNewLine(), colprintTableNew(), colprintTablePrint(), colprintTableSort(), line, name, NULL, PTAG_COUNT, ptagCompare(), and ptagDescs.

Referenced by processListPseudoTagsOptions().