#include "general.h"
#include "options_p.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <ctype.h>
#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 "error_p.h"
#include "interactive_p.h"
#include "writer_p.h"
#include "trace.h"

Include dependency graph for options.c:

Classes
struct	sOptionDescription

struct	parametricOption

struct	sBooleanOption

struct	localOptionValues

struct	Feature

struct	preloadPathElt

Macros
#define	OPTION_WRITE

#define	_GNU_SOURCE /* for asprintf */

#define	INVOCATION "Usage: %s [options] [file(s)]\n"

#define	CTAGS_ENVIRONMENT "CTAGS"

#define	ETAGS_ENVIRONMENT "ETAGS"

#define	ETAGS "etags" /* name which causes default use of to -e */

#define	EXTENSION_SEPARATOR '.'

#define	PATTERN_START '('

#define	PATTERN_STOP ')'

#define	IGNORE_SEPARATORS ", \t\n"

#define	DEFAULT_FILE_FORMAT 2

#define	isCompoundOption(c) (bool) (strchr ("fohiILpdDb", (c)) != NULL)

#define	ENTER(STAGE)

#define	ACCEPT(STAGE) (1UL << OptionLoadingStage##STAGE)

#define	STAGE_ANY ~0UL

#define	va_copy(dest, src) (dest = src)

#define	PREFIX "fields-"

#define	PREFIX_LEN strlen(PREFIX)

#define	PREFIX "extras-"

#define	PREFIX_LEN strlen(PREFIX)

Typedefs
typedef struct sOptionDescription	optionDescription

typedef void(*	parametricOptionHandler) (const char const option, const char const parameter)

typedef const struct sBooleanOption	booleanOption

typedef stringList	searchPathList

typedef char (	preloadMakePathFunc) (const char , const char )

Enumerations
enum	eOptionLimits { MaxHeaderExtensions = 100 , MaxSupportedTagFormat = 2 }

Functions
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)

int	asprintf (char *strp, const char fmt,...)

void	verbose (const char *const format,...)

void	notice (const char *const format,...)

static char *	stringCopy (const char *const string)

static void	freeString (char **const pString)

void	freeList (stringList **const pList)

void	setDefaultTagFileName (void)

bool	filesRequired (void)

void	checkOptions (void)

langType	getLanguageComponentInOptionFull (const char const option, const char const prefix, bool noPretending)

langType	getLanguageComponentInOption (const char const option, const char const prefix)

static void	setEtagsMode (void)

void	testEtagsInvocation (void)

static void	setXrefMode (void)

static void	parseShortOption (cookedArgs *const args)

static void	parseLongOption (cookedArgs const args, const char item)

static void	cArgRead (cookedArgs *const current)

cookedArgs *	cArgNewFromString (const char *string)

cookedArgs *	cArgNewFromArgv (char const const argv)

cookedArgs *	cArgNewFromFile (FILE *const fp)

cookedArgs *	cArgNewFromLineFile (FILE *const fp)

void	cArgDelete (cookedArgs *const current)

static bool	cArgOptionPending (cookedArgs *const current)

bool	cArgOff (cookedArgs *const current)

bool	cArgIsOption (cookedArgs *const current)

const char *	cArgItem (cookedArgs *const current)

void	cArgForth (cookedArgs *const current)

static void	addExtensionList (stringList const slist, const char const elist, const bool clear)

static bool	isFalse (const char *parameter)

static bool	isTrue (const char *parameter)

bool	paramParserBool (const char value, bool fallback, const char errWhat, const char *errCategory)

bool	isIncludeFile (const char *const fileName)

static void	processEtagsInclude (const char const option, const char const parameter)

static void	processExcludeOptionCommon (stringList *list, const char const optname, const char *const parameter)

static void	processExcludeOption (const char const option, const char const parameter)

static void	processExcludeExceptionOption (const char const option, const char const parameter)

bool	isExcludedFile (const char *const name, bool falseIfExceptionsAreDefeind)

static void	processExcmdOption (const char const option, const char const parameter)

static void	resetXtags (langType lang, bool mode)

static void	processExtraTagsOption (const char const option, const char const parameter)

static void	resetFieldsOption (langType lang, bool mode)

static void	processFieldsOption (const char const option, const char const parameter)

static void	processFilterTerminatorOption (const char const option, const char const parameter)

static void	processFormatOption (const char const option, const char const parameter)

static void	printInvocationDescription (void)

static void	printOptionDescriptions (const optionDescription *const optDesc)

static int	excludesCompare (struct colprintLine a, struct colprintLine b)

static void	processListExcludesOption (const char const option, const char const parameter)

static void	printFeatureList (void)

static int	featureCompare (struct colprintLine a, struct colprintLine b)

static void	processListFeaturesOption (const char const option, const char const parameter)

static void	processListFieldsOption (const char const option, const char const parameter)

static void	printProgramIdentification (void)

static void	processHelpOptionCommon (const char const option, const char const parameter, bool includingExperimentalOptions)

static void	processHelpOption (const char const option, const char const parameter)

static void	processHelpFullOption (const char const option, const char const parameter)

static void	processIf0Option (const char const option, const char const parameter)

static void	processLanguageForceOption (const char const option, const char const parameter)

static char *	skipPastMap (char *p)

static char *	extractMapFromParameter (const langType language, char parameter, char tail, bool pattern_p, char (skip)(char *))

static char *	addLanguageMap (const langType language, char *map_parameter, bool exclusiveInAllLanguages)

static char *	removeLanguageMap (const langType language, char *map_parameter)

static char *	processLanguageMap (char *map)

static void	processLanguageMapOption (const char const option, const char const parameter)

static void	processLanguagesOption (const char const option, const char const parameter)

bool	processMapOption (const char const option, const char const parameter)

bool	processParamOption (const char const option, const char const value)

static void	processLicenseOption (const char const option, const char const parameter)

static void	processListAliasesOption (const char const option, const char const parameter)

static void	processListExtrasOption (const char const option, const char const parameter)

static void	processListKindsOption (const char const option, const char const parameter)

static void	processListParametersOption (const char const option, const char const parameter)

static void	processListMapsOptionForType (const char const option, const char const parameter, langmapType type)

static void	processListMapExtensionsOption (const char const option, const char const parameter)

static void	processListMapPatternsOption (const char const option, const char const parameter)

static void	processListMapsOption (const char const option, const char const parameter)

static void	processListLanguagesOption (const char const option, const char const parameter)

static void	processListPseudoTagsOptions (const char const option, const char const parameter)

static void	processListRegexFlagsOptions (const char const option, const char const parameter)

static void	processListMultilineRegexFlagsOptions (const char const option, const char const parameter)

static void	processListMultitableRegexFlagsOptions (const char const option, const char const parameter)

static void	processListLangdefFlagsOptions (const char const option, const char const parameter)

static void	processListKinddefFlagsOptions (const char const option, const char const parameter)

static void	processListRolesOptions (const char const option, const char const parameter)

static void	processListSubparsersOptions (const char const option, const char const parameter)

static void	freeSearchPathList (searchPathList **pathList)

static vString *	expandOnSearchPathList (searchPathList pathList, const char leaf, bool(check)(const char const))

static vString *	expandOnOptlibPathList (const char *leaf)

static void	processOptionFileCommon (const char const option, const char const parameter, bool allowNonExistingFile)

static void	processOptionFile (const char const option, const char const parameter)

static void	processOptionFileMaybe (const char const option, const char const parameter)

static void	processOutputFormat (const char const option, const char const parameter)

static void	processPseudoTags (const char const option, const char const parameter)

static void	processSortOption (const char const option, const char const parameter)

static void	processTagRelative (const char const option, const char const parameter)

static void	processTotals (const char const option, const char const parameter)

static void	installHeaderListDefaults (void)

static void	processHeaderListOption (const int option, const char *parameter)

static void	readIgnoreList (const char *const list)

static void	addIgnoreListFromFile (const char *const fileName)

static void	processIgnoreOption (const char *const list, int IgnoreOrDefine)

static void	processAnonHashOption (const char const option, const char const parameter)

static void	processDumpKeywordsOption (const char const option, const char const parameter)

static void	processEchoOption (const char const option, const char const parameter)

static void	processForceInitOption (const char const option, const char const parameter)

static void	processForceQuitOption (const char const option, const char const parameter)

static void	processVersionOption (const char const option, const char const parameter)

static void	processXformatOption (const char const option, const char const parameter)

static void	prependToOptlibPathList (const char *const dir, bool report_in_verbose)

static void	resetOptlibPathList (bool report_in_verbose)

static void	processOptlibDir (const char const option, const char const parameter)

static void	processMaxRecursionDepthOption (const char const option, const char const parameter)

static void	processPatternLengthLimit (const char const option, const char const parameter)

bool	ptagMakePatternLengthLimit (ptagDesc pdesc, langType language, const void data)

static void	setBooleanToXtagWithWarning (booleanOption *const option, bool value)

static void	processDumpOptionsOption (const char const option, const char const parameter)

static void	checkOptionOrder (const char *const option, bool longOption)

static bool	processParametricOption (const char const option, const char const parameter)

static bool	processBooleanOption (const char const option, const char const parameter)

static void	enableLanguageField (langType language, const char *field, bool mode)

static void	enableLanguageXtag (langType language, const char *xtag, bool mode)

static bool	processLangSpecificFieldsOption (const char const option, const char const parameter)

static bool	processLangSpecificExtraOption (const char const option, const char const parameter)

static bool	processRegexOption (const char const option, const char const parameter)

static bool	processMultilineRegexOption (const char const option, const char const parameter)

static bool	processMultitableRegexOption (const char const option, const char const parameter)

static bool	processMultitableExtendingOption (const char const option, const char const parameter)

static void	processLongOption (const char const option, const char const parameter)

static void	processShortOption (const char const option, const char const parameter)

static void	parseOption (cookedArgs *const args)

static void	parseOptions (cookedArgs *const args)

void	parseCmdlineOptions (cookedArgs *const args)

static bool	checkSameFile (const char const fileName, void userData)

void	previewFirstOption (cookedArgs *const args)

static char *	prependEnvvar (const char path, const char envvar)

static char *	getConfigForXDG (const char path, const char extra)

static void	preload (struct preloadPathElt *pathList)

static void	parseConfigurationFileOptions (void)

static void	parseEnvironmentOptions (void)

void	readOptionConfiguration (void)

void	initOptions (void)

void	freeOptionResources (void)

bool	inSandbox (void)

bool	canUseLineNumberAsLocator (void)

bool	isDestinationStdout (void)

Variables
static bool	NonOptionEncountered = false

static stringList *	OptionFiles

static searchPathList *	OptlibPathList

static stringList *	Excluded

static stringList *	ExcludedException

static bool	FilesRequired = true

static bool	SkipConfiguration

static const char *const	HeaderExtensions []

long	ctags_debugLevel = 0L

bool	ctags_verbose = false

optionValues	Option

struct localOptionValues	localOption

static OptionLoadingStage	Stage = OptionLoadingStageNone

static optionDescription	LongOptionDescription []

static optionDescription	ExperimentalLongOptionDescription []

static const char *const	License1

static const char *const	License2

static struct Feature	Features []

static const char *const	StageDescription []

static parametricOption	ParametricOptions []

static booleanOption	BooleanOptions []

static struct preloadPathElt	preload_path_list []

Macro Definition Documentation

◆ _GNU_SOURCE

#define _GNU_SOURCE /* for asprintf */

Definition at line 19 of file options.c.

◆ ACCEPT

#define ACCEPT ( STAGE ) (1UL << OptionLoadingStage##STAGE)

Definition at line 83 of file options.c.

◆ CTAGS_ENVIRONMENT

#define CTAGS_ENVIRONMENT "CTAGS"

Definition at line 51 of file options.c.

◆ DEFAULT_FILE_FORMAT

#define DEFAULT_FILE_FORMAT 2

Definition at line 66 of file options.c.

◆ ENTER

#define ENTER ( STAGE )

Value:

        do {                                                \
        Assert (Stage <= OptionLoadingStage##STAGE);                    \
        if (Stage != OptionLoadingStage##STAGE)                         \
        {                                                               \
            Stage = OptionLoadingStage##STAGE;                          \
            verbose ("Entering configuration stage: loading %s\n", StageDescription[Stage]); \
        }                                                               \
    } while (0)

Definition at line 75 of file options.c.

◆ ETAGS

#define ETAGS "etags" /* name which causes default use of to -e */

Definition at line 55 of file options.c.

◆ ETAGS_ENVIRONMENT

#define ETAGS_ENVIRONMENT "ETAGS"

Definition at line 52 of file options.c.

◆ EXTENSION_SEPARATOR

#define EXTENSION_SEPARATOR '.'

Definition at line 60 of file options.c.

◆ IGNORE_SEPARATORS

#define IGNORE_SEPARATORS ", \t\n"

Definition at line 63 of file options.c.

◆ INVOCATION

#define INVOCATION "Usage: %s [options] [file(s)]\n"

Definition at line 49 of file options.c.

◆ isCompoundOption

#define isCompoundOption ( c ) (bool) (strchr ("fohiILpdDb", (c)) != NULL)

Definition at line 73 of file options.c.

◆ OPTION_WRITE

#define OPTION_WRITE

Definition at line 15 of file options.c.

◆ PATTERN_START

#define PATTERN_START '('

Definition at line 61 of file options.c.

◆ PATTERN_STOP

#define PATTERN_STOP ')'

Definition at line 62 of file options.c.

◆ PREFIX [1/2]

#define PREFIX "fields-"

◆ PREFIX [2/2]

#define PREFIX "extras-"

◆ PREFIX_LEN [1/2]

#define PREFIX_LEN strlen(PREFIX)

◆ PREFIX_LEN [2/2]

#define PREFIX_LEN strlen(PREFIX)

◆ STAGE_ANY

#define STAGE_ANY ~0UL

Definition at line 193 of file options.c.

◆ va_copy

#define va_copy	(	dest,
		src
	)	(dest = src)

Definition at line 613 of file options.c.

Typedef Documentation

◆ booleanOption

typedef const struct sBooleanOption booleanOption

◆ optionDescription

typedef struct sOptionDescription optionDescription

◆ parametricOptionHandler

typedef void(* parametricOptionHandler) (const char *const option, const char *const parameter)

Definition at line 99 of file options.c.

◆ preloadMakePathFunc

typedef char *(* preloadMakePathFunc) (const char *, const char *)

Definition at line 3610 of file options.c.

◆ searchPathList

typedef stringList searchPathList

Definition at line 123 of file options.c.

Enumeration Type Documentation

◆ eOptionLimits

enum eOptionLimits

Enumerator
MaxHeaderExtensions
MaxSupportedTagFormat

Definition at line 89 of file options.c.

Function Documentation

◆ addExtensionList()

static void addExtensionList	(	stringList *const	slist,
		const char *const	elist,
		const bool	clear
	)

static

Definition at line 1031 of file options.c.

References BEGIN_VERBOSE, clear(), END_VERBOSE, eStrdup(), EXTENSION_SEPARATOR, NULL, stringListAdd(), stringListClear(), stringListPrint(), verbose(), and vStringNewInit().

Referenced by processHeaderListOption().

◆ addIgnoreListFromFile()

static void addIgnoreListFromFile ( const char *const fileName )

static

Definition at line 2567 of file options.c.

References applyParameter(), error(), FATAL, getNamedLanguage(), NULL, PERROR, stringListCount(), stringListDelete(), stringListItem(), stringListNewFromFile(), and vStringValue.

Referenced by processIgnoreOption().

◆ addLanguageMap()

static char * addLanguageMap	(	const langType	language,
		char *	map_parameter,
		bool	exclusiveInAllLanguages
	)

static

Definition at line 1777 of file options.c.

References addLanguageExtensionMap(), addLanguagePatternMap(), eFree(), error(), extractMapFromParameter(), FATAL, getLanguageName(), NULL, and skipPastMap().

Referenced by processLanguageMap(), and processMapOption().

◆ asprintf()

int asprintf	(	char **	strp,
		const char *	fmt,
			...
	)

Definition at line 616 of file options.c.

References Assert, dummy, and va_copy.

◆ canUseLineNumberAsLocator()

bool canUseLineNumberAsLocator ( void )

Definition at line 3913 of file options.c.

References EX_PATTERN, sOptionValues::locate, and Option.

Referenced by makeFortranTag().

◆ cArgDelete()

void cArgDelete ( cookedArgs *const current )

Definition at line 965 of file options.c.

References argDelete(), sCookedArgs::args, Assert, eFree(), sCookedArgs::item, and NULL.

Referenced by createTagsFromFileInput(), ctags_cli_main(), parseEnvironmentOptions(), and parseFileOptions().

◆ cArgForth()

void cArgForth ( cookedArgs *const current )

Definition at line 1002 of file options.c.

References argForth(), argOff(), sCookedArgs::args, Assert, cArgOff(), cArgOptionPending(), cArgRead(), eFree(), sCookedArgs::isOption, sCookedArgs::item, sCookedArgs::longOption, NULL, sCookedArgs::parameter, parseShortOption(), and sCookedArgs::shortOptions.

Referenced by createTagsForArgs(), createTagsFromFileInput(), parseOption(), and previewFirstOption().

◆ cArgIsOption()

bool cArgIsOption ( cookedArgs *const current )

Definition at line 990 of file options.c.

References Assert, sCookedArgs::isOption, and NULL.

Referenced by parseOptions(), and previewFirstOption().

◆ cArgItem()

const char * cArgItem ( cookedArgs *const current )

Definition at line 996 of file options.c.

References Assert, sCookedArgs::item, and NULL.

Referenced by createTagsForArgs(), and createTagsFromFileInput().

◆ cArgNewFromArgv()

cookedArgs * cArgNewFromArgv ( char *const *const argv )

Definition at line 938 of file options.c.

References argNewFromArgv(), sCookedArgs::args, cArgRead(), and xMalloc.

Referenced by ctags_cli_main().

◆ cArgNewFromFile()

cookedArgs * cArgNewFromFile ( FILE *const fp )

Definition at line 947 of file options.c.

References argNewFromFile(), sCookedArgs::args, cArgRead(), and xMalloc.

◆ cArgNewFromLineFile()

cookedArgs * cArgNewFromLineFile ( FILE *const fp )

Definition at line 956 of file options.c.

References argNewFromLineFile(), sCookedArgs::args, cArgRead(), and xMalloc.

Referenced by createTagsFromFileInput(), and parseFileOptions().

◆ cArgNewFromString()

cookedArgs * cArgNewFromString ( const char * string )

Definition at line 929 of file options.c.

References argNewFromString(), sCookedArgs::args, cArgRead(), and xMalloc.

Referenced by parseEnvironmentOptions().

◆ cArgOff()

bool cArgOff ( cookedArgs *const current )

Definition at line 984 of file options.c.

References argOff(), sCookedArgs::args, Assert, cArgOptionPending(), and NULL.

Referenced by batchMakeTags(), cArgForth(), createTagsForArgs(), createTagsFromFileInput(), parseOption(), and parseOptions().

◆ cArgOptionPending()

static bool cArgOptionPending ( cookedArgs *const current )

static

Definition at line 975 of file options.c.

References NULL, and sCookedArgs::shortOptions.

Referenced by cArgForth(), and cArgOff().

◆ cArgRead()

static void cArgRead ( cookedArgs *const current )

static

Definition at line 894 of file options.c.

References argItem(), argOff(), sCookedArgs::args, Assert, eStrdup(), sCookedArgs::isOption, sCookedArgs::item, sCookedArgs::longOption, NULL, sCookedArgs::parameter, parseLongOption(), parseShortOption(), and sCookedArgs::shortOptions.

Referenced by cArgForth(), cArgNewFromArgv(), cArgNewFromFile(), cArgNewFromLineFile(), and cArgNewFromString().

◆ checkOptionOrder()

static void checkOptionOrder	(	const char *const	option,
		bool	longOption
	)

static

Definition at line 2900 of file options.c.

References error(), FATAL, and NonOptionEncountered.

Referenced by processBooleanOption(), processParametricOption(), and processShortOption().

◆ checkOptions()

void checkOptions ( void )

Definition at line 730 of file options.c.

References sOptionValues::append, sOptionValues::customXfmt, enableXtag(), error(), FATAL, sOptionValues::filter, isDestinationStdout(), isXtagEnabled(), notice(), NULL, Option, sOptionValues::printTotals, sOptionValues::tagFileName, WARNING, writerCheckOptions(), sOptionValues::xref, and XTAG_FILE_NAMES.

Referenced by ctags_cli_main().

◆ checkSameFile()

static bool checkSameFile	(	const char *const	fileName,
		void *	userData
	)

static

Definition at line 3470 of file options.c.

References isSameFile().

Referenced by parseFileOptions().

◆ enableLanguageField()

static void enableLanguageField	(	langType	language,
		const char *	field,
		bool	mode
	)

static

Definition at line 2971 of file options.c.

References enableField(), error(), FATAL, field, FIELD_UNKNOWN, getFieldTypeForNameAndLanguage(), LANG_AUTO, and nextSiblingField().

Referenced by processLangSpecificFieldsOption().

◆ enableLanguageXtag()

static void enableLanguageXtag	(	langType	language,
		const char *	xtag,
		bool	mode
	)

static

Definition at line 2989 of file options.c.

References enableXtag(), error(), FATAL, getXtagTypeForNameAndLanguage(), LANG_AUTO, nextSiblingXtag(), and XTAG_UNKNOWN.

Referenced by processLangSpecificExtraOption().

◆ excludesCompare()

static int excludesCompare	(	struct colprintLine *	a,
		struct colprintLine *	b
	)

static

Definition at line 1467 of file options.c.

References colprintLineGetColumn().

Referenced by processListExcludesOption().

◆ expandOnOptlibPathList()

static vString * expandOnOptlibPathList ( const char * leaf )

static

Definition at line 2317 of file options.c.

References doesFileExist(), expandOnSearchPathList(), and OptlibPathList.

Referenced by processOptionFileCommon().

◆ expandOnSearchPathList()

static vString * expandOnSearchPathList	(	searchPathList *	pathList,
		const char *	leaf,
		bool()(const char const)	check
	)

static

Definition at line 2296 of file options.c.

References combinePathAndFile(), eFree(), NULL, stringListCount(), stringListItem(), vStringNewOwn(), and vStringValue.

Referenced by expandOnOptlibPathList().

◆ extractMapFromParameter()

static char * extractMapFromParameter	(	const langType	language,
		char *	parameter,
		char **	tail,
		bool *	pattern_p,
		char ()(char *)	skip
	)

static

Definition at line 1717 of file options.c.

References error(), eStrdup(), EXTENSION_SEPARATOR, FATAL, getLanguageName(), NULL, PATTERN_START, PATTERN_STOP, and tail().

Referenced by addLanguageMap(), and removeLanguageMap().

◆ featureCompare()

static int featureCompare	(	struct colprintLine *	a,
		struct colprintLine *	b
	)

static

Definition at line 1517 of file options.c.

References colprintLineGetColumn().

Referenced by processListFeaturesOption().

◆ filesRequired()

bool filesRequired ( void )

Definition at line 722 of file options.c.

References FilesRequired, Option, and sOptionValues::recurse.

Referenced by batchMakeTags().

◆ freeList()

void freeList ( stringList **const pList )

Definition at line 697 of file options.c.

References NULL, and stringListDelete().

Referenced by freeOptionResources(), freeParserResources(), and processExcludeOptionCommon().

◆ freeOptionResources()

void freeOptionResources ( void )

Definition at line 3881 of file options.c.

References sOptionValues::etagsInclude, Excluded, ExcludedException, sOptionValues::fileList, sOptionValues::filterTerminator, freeList(), freeSearchPathList(), freeString(), sOptionValues::headerExt, Option, OptionFiles, OptlibPathList, and sOptionValues::tagFileName.

Referenced by ctags_cli_main().

◆ freeSearchPathList()

static void freeSearchPathList ( searchPathList ** pathList )

static

Definition at line 2289 of file options.c.

References NULL, stringListClear(), and stringListDelete().

Referenced by freeOptionResources(), and resetOptlibPathList().

◆ freeString()

static void freeString ( char **const pString )

static

Definition at line 688 of file options.c.

References eFree(), and NULL.

Referenced by freeOptionResources(), processFilterTerminatorOption(), and processShortOption().

◆ getBooleanOption()

static bool getBooleanOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2933 of file options.c.

References paramParserBool().

Referenced by processBooleanOption(), and processIf0Option().

◆ getConfigForXDG()

static char * getConfigForXDG	(	const char *	path,
		const char *	extra
	)

static

Definition at line 3632 of file options.c.

References prependEnvvar().

◆ getLanguageComponentInOption()

langType getLanguageComponentInOption	(	const char *const	option,
		const char *const	prefix
	)

Definition at line 801 of file options.c.

References getLanguageComponentInOptionFull().

Referenced by processAliasOption(), processExtradefOption(), processFielddefOption(), processKinddefOption(), processMapOption(), processMultilineRegexOption(), processMultitableExtendingOption(), processMultitableRegexOption(), processParamOption(), processRegexOption(), processRoledefOption(), processScopesepOption(), and processTabledefOption().

◆ getLanguageComponentInOptionFull()

langType getLanguageComponentInOptionFull	(	const char *const	option,
		const char *const	prefix,
		bool	noPretending
	)

Definition at line 762 of file options.c.

References Assert, error(), eStrndup(), FATAL, getNamedLanguageFull(), LANG_IGNORE, and NULL.

Referenced by getLanguageComponentInOption(), and processPretendOption().

◆ initOptions()

void initOptions ( void )

Definition at line 3804 of file options.c.

References installHeaderListDefaults(), installLanguageAliasesDefaults(), installLanguageMapDefaults(), NULL, OptionFiles, OptlibPathList, processExcludeOption(), stringListNew(), and verbose().

Referenced by ctags_cli_main(), and tm_ctags_init().

◆ inSandbox()

bool inSandbox ( void )

Definition at line 3908 of file options.c.

References sOptionValues::interactive, and Option.

◆ installHeaderListDefaults()

static void installHeaderListDefaults ( void )

static

Definition at line 2512 of file options.c.

References BEGIN_VERBOSE, END_VERBOSE, sOptionValues::headerExt, HeaderExtensions, Option, stringListNewFromArgv(), and stringListPrint().

Referenced by initOptions(), and processHeaderListOption().

◆ isDestinationStdout()

bool isDestinationStdout ( void )

Definition at line 3918 of file options.c.

References sOptionValues::filter, sOptionValues::interactive, NULL, Option, outputDefaultFileName(), and sOptionValues::tagFileName.

Referenced by checkOptions(), isPseudoTagsEnabled(), and openTagFile().

◆ isExcludedFile()

bool isExcludedFile	(	const char *const	name,
		bool	falseIfExceptionsAreDefeind
	)

Definition at line 1184 of file options.c.

References baseFilename(), Excluded, ExcludedException, name, NULL, stringListCount(), and stringListFileMatched().

Referenced by createTagsForEntry().

◆ isFalse()

static bool isFalse ( const char * parameter )

static

Definition at line 1073 of file options.c.

References strcasecmp.

Referenced by LexerCPP::EvaluateExpression(), paramParserBool(), processSortOption(), processTagRelative(), and processTotals().

◆ isIncludeFile()

bool isIncludeFile ( const char *const fileName )

Definition at line 1114 of file options.c.

References fileExtension(), sOptionValues::headerExt, NULL, Option, and stringListExtensionMatched().

Referenced by setInputFileParametersCommon().

◆ isTrue()

static bool isTrue ( const char * parameter )

static

Definition at line 1083 of file options.c.

References strcasecmp.

Referenced by paramParserBool(), processSortOption(), processTagRelative(), and processTotals().

◆ notice()

void notice	(	const char *const	format,
			...
	)

Definition at line 666 of file options.c.

References format, getExecutableName(), Option, and sOptionValues::quiet.

Referenced by checkOptions(), previewFirstOption(), and processEchoOption().

◆ paramParserBool()

bool paramParserBool	(	const char *	value,
		bool	fallback,
		const char *	errWhat,
		const char *	errCategory
	)

Definition at line 1093 of file options.c.

References error(), fallback, FATAL, isFalse(), and isTrue().

Referenced by getBooleanOption().

◆ parseAllConfigurationFilesOptionsInDirectory()

static bool parseAllConfigurationFilesOptionsInDirectory	(	const char *const	fileName,
		stringList *const	already_loaded_files
	)

static

Definition at line 3603 of file options.c.

Referenced by preload(), and processOptionFileCommon().

◆ parseCmdlineOptions()

void parseCmdlineOptions ( cookedArgs *const args )

Definition at line 3464 of file options.c.

References ENTER, and parseOptions().

Referenced by createTagsForArgs(), createTagsFromFileInput(), and ctags_cli_main().

◆ parseConfigurationFileOptions()

static void parseConfigurationFileOptions ( void )

static

Definition at line 3759 of file options.c.

References preload(), and preload_path_list.

Referenced by readOptionConfiguration().

◆ parseEnvironmentOptions()

static void parseEnvironmentOptions ( void )

static

Definition at line 3764 of file options.c.

References cArgDelete(), cArgNewFromString(), CTAGS_ENVIRONMENT, ENTER, error(), sOptionValues::etags, ETAGS_ENVIRONMENT, NonOptionEncountered, NULL, Option, parseOptions(), verbose(), and WARNING.

Referenced by readOptionConfiguration().

◆ parseFileOptions()

static bool parseFileOptions ( const char *const fileName )

static

Definition at line 3475 of file options.c.

References cArgDelete(), cArgNewFromLineFile(), checkSameFile(), error(), format, NonOptionEncountered, NULL, OptionFiles, parseOptions(), stringListAdd(), stringListHasTest(), verbose(), vStringNewInit(), and WARNING.

Referenced by preload(), and processOptionFileCommon().

◆ parseLongOption()

static void parseLongOption	(	cookedArgs *const	args,
		const char *	item
	)

static

Definition at line 877 of file options.c.

References Assert, eStrdup(), eStrndup(), sCookedArgs::item, NULL, and sCookedArgs::parameter.

Referenced by cArgRead().

◆ parseOption()

static void parseOption ( cookedArgs *const args )

static

Definition at line 3438 of file options.c.

References Assert, cArgForth(), cArgOff(), sCookedArgs::isOption, sCookedArgs::item, sCookedArgs::longOption, sCookedArgs::parameter, processLongOption(), and processShortOption().

Referenced by parseOptions(), and previewFirstOption().

◆ parseOptions()

static void parseOptions ( cookedArgs *const args )

static

Definition at line 3456 of file options.c.

References cArgIsOption(), cArgOff(), NonOptionEncountered, and parseOption().

Referenced by parseCmdlineOptions(), parseEnvironmentOptions(), and parseFileOptions().

◆ parseShortOption()

static void parseShortOption ( cookedArgs *const args )

static

Definition at line 854 of file options.c.

References argForth(), argItem(), argOff(), sCookedArgs::args, eStrdup(), isCompoundOption, sCookedArgs::item, NULL, sCookedArgs::parameter, sCookedArgs::shortOptions, and sCookedArgs::simple.

Referenced by cArgForth(), and cArgRead().

◆ preload()

static void preload ( struct preloadPathElt * pathList )

static

Definition at line 3670 of file options.c.

References Assert, eFree(), preloadPathElt::extra, preloadPathElt::isDirectory, loaded, preloadPathElt::makePath, NULL, parseAllConfigurationFilesOptionsInDirectory(), parseFileOptions(), preloadPathElt::path, Stage, preloadPathElt::stage, StageDescription, stringListClear(), stringListDelete(), stringListNew(), and verbose().

Referenced by parseConfigurationFileOptions().

◆ prependEnvvar()

static char * prependEnvvar	(	const char *	path,
		const char *	envvar
	)

static

Definition at line 3620 of file options.c.

References combinePathAndFile(), and NULL.

Referenced by getConfigForXDG().

◆ prependToOptlibPathList()

static void prependToOptlibPathList	(	const char *const	dir,
		bool	report_in_verbose
	)

static

Definition at line 2703 of file options.c.

References OptlibPathList, stringListAdd(), verbose(), and vStringNewInit().

Referenced by processOptlibDir().

◆ previewFirstOption()

void previewFirstOption ( cookedArgs *const args )

Definition at line 3507 of file options.c.

References cArgForth(), cArgIsOption(), sCookedArgs::item, notice(), sCookedArgs::parameter, parseOption(), RSV_NONE, and SkipConfiguration.

Referenced by ctags_cli_main().

◆ printFeatureList()

static void printFeatureList ( void )

static

Definition at line 1497 of file options.c.

References checkRegex(), Features, Feature::name, name, and NULL.

Referenced by printProgramIdentification().

◆ printInvocationDescription()

static void printInvocationDescription ( void )

static

Definition at line 1451 of file options.c.

References getExecutableName(), and INVOCATION.

Referenced by processHelpOptionCommon().

◆ printOptionDescriptions()

static void printOptionDescriptions ( const optionDescription *const optDesc )

static

Definition at line 1456 of file options.c.

References sOptionDescription::description, sOptionValues::etags, NULL, Option, and sOptionDescription::usedByEtags.

Referenced by processHelpOptionCommon().

◆ printProgramIdentification()

static void printProgramIdentification ( void )

static

Definition at line 1581 of file options.c.

References AUTHOR_NAME, ctags_repoinfo, NULL, printFeatureList(), PROGRAM_COPYRIGHT, PROGRAM_NAME, PROGRAM_URL, and PROGRAM_VERSION.

Referenced by processHelpOptionCommon(), processLicenseOption(), and processVersionOption().

◆ processAnonHashOption()

static void processAnonHashOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2608 of file options.c.

References anonHashString(), error(), FATAL, and NULL.

◆ processBooleanOption()

static bool processBooleanOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2939 of file options.c.

References BooleanOptions, checkOptionOrder(), count, entry, error(), getBooleanOption(), Stage, StageDescription, and WARNING.

Referenced by processLongOption().

◆ processDumpKeywordsOption()

static void processDumpKeywordsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2619 of file options.c.

References dumpKeywordTable().

◆ processDumpOptionsOption()

static void processDumpOptionsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3897 of file options.c.

References ARRAY_SIZE, BooleanOptions, name, and ParametricOptions.

◆ processEchoOption()

static void processEchoOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2624 of file options.c.

References error(), FATAL, notice(), and NULL.

◆ processEtagsInclude()

static void processEtagsInclude	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1127 of file options.c.

References error(), sOptionValues::etags, sOptionValues::etagsInclude, FATAL, FilesRequired, NULL, Option, stringListAdd(), stringListNew(), and vStringNewInit().

◆ processExcludeExceptionOption()

static void processExcludeExceptionOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1178 of file options.c.

References ExcludedException, and processExcludeOptionCommon().

◆ processExcludeOption()

static void processExcludeOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1172 of file options.c.

References Excluded, and processExcludeOptionCommon().

Referenced by initOptions().

◆ processExcludeOptionCommon()

static void processExcludeOptionCommon	(	stringList **	list,
		const char *const	optname,
		const char *const	parameter
	)

static

Definition at line 1142 of file options.c.

References error(), FATAL, freeList(), list, NULL, OUTPUT_PATH_SEPARATOR, PATH_SEPARATOR, PERROR, stringListAdd(), stringListCombine(), stringListNew(), stringListNewFromFile(), verbose(), vStringNewInit(), and vStringTranslate().

Referenced by processExcludeExceptionOption(), and processExcludeOption().

◆ processExcmdOption()

static void processExcmdOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1216 of file options.c.

References error(), EX_COMBINE, EX_LINENUM, EX_MIX, EX_PATTERN, FATAL, sOptionValues::locate, and Option.

◆ processExtraTagsOption()

static void processExtraTagsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1241 of file options.c.

References enableXtag(), error(), FATAL, getXtagTypeForLetter(), getXtagTypeForNameAndLanguage(), LANG_IGNORE, resetXtags(), vStringClear, vStringNewOrClearWithAutoRelease(), vStringPut(), vStringValue, WARNING, and XTAG_UNKNOWN.

◆ processFieldsOption()

static void processFieldsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1331 of file options.c.

References default, enableField(), error(), FATAL, FIELD_UNKNOWN, getFieldTypeForNameAndLanguage(), getFieldTypeForOption(), LANG_IGNORE, resetFieldsOption(), vStringClear, vStringNewOrClearWithAutoRelease(), vStringPut(), vStringValue, and WARNING.

◆ processFilterTerminatorOption()

static void processFilterTerminatorOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1408 of file options.c.

References sOptionValues::filterTerminator, freeString(), Option, and stringCopy().

◆ processForceInitOption()

static void processForceInitOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2631 of file options.c.

References initializeParser(), LANG_AUTO, and verbose().

◆ processForceQuitOption()

static void processForceQuitOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2638 of file options.c.

References NULL, and strToInt().

◆ processFormatOption()

static void processFormatOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1415 of file options.c.

References error(), FATAL, format, MaxSupportedTagFormat, Option, and sOptionValues::tagFileFormat.

◆ processHeaderListOption()

static void processHeaderListOption	(	const int	option,
		const char *	parameter
	)

static

Definition at line 2525 of file options.c.

References addExtensionList(), clear(), doesFileExist(), error(), FATAL, sOptionValues::headerExt, installHeaderListDefaults(), NULL, Option, stringListNew(), and verbose().

Referenced by processShortOption().

◆ processHelpFullOption()

static void processHelpFullOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1623 of file options.c.

References processHelpOptionCommon().

◆ processHelpOption()

static void processHelpOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1615 of file options.c.

References processHelpOptionCommon().

Referenced by processShortOption().

◆ processHelpOptionCommon()

static void processHelpOptionCommon	(	const char *const	option,
		const char *const	parameter,
		bool	includingExperimentalOptions
	)

static

Definition at line 1601 of file options.c.

References ExperimentalLongOptionDescription, LongOptionDescription, printInvocationDescription(), printOptionDescriptions(), and printProgramIdentification().

Referenced by processHelpFullOption(), and processHelpOption().

◆ processIf0Option()

static void processIf0Option	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1678 of file options.c.

References applyParameter(), getBooleanOption(), and getNamedLanguage().

◆ processIgnoreOption()

static void processIgnoreOption	(	const char *const	list,
		int	IgnoreOrDefine
	)

static

Definition at line 2587 of file options.c.

References addIgnoreListFromFile(), applyParameter(), getNamedLanguage(), list, NULL, and readIgnoreList().

Referenced by processShortOption().

◆ processLangSpecificExtraOption()

static bool processLangSpecificExtraOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3107 of file options.c.

References enableLanguageXtag(), error(), FATAL, getNamedLanguage(), initializeParser(), LANG_AUTO, LANG_IGNORE, PREFIX, PREFIX_LEN, resetXtags(), RSV_LANG_ALL, vStringClear, vStringNewOrClearWithAutoRelease(), vStringPut(), vStringValue, and WARNING.

Referenced by processLongOption().

◆ processLangSpecificFieldsOption()

static bool processLangSpecificFieldsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3007 of file options.c.

References enableLanguageField(), error(), FATAL, getNamedLanguage(), initializeParser(), LANG_AUTO, LANG_IGNORE, PREFIX, PREFIX_LEN, resetFieldsOption(), RSV_LANG_ALL, vStringClear, vStringNewOrClearWithAutoRelease(), vStringPut(), vStringValue, and WARNING.

Referenced by processLongOption().

◆ processLanguageForceOption()

static void processLanguageForceOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1688 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, sOptionValues::language, Option, RSV_LANG_AUTO, strcasecmp, and WARNING.

◆ processLanguageMap()

static char * processLanguageMap ( char * map )

static

Definition at line 1818 of file options.c.

References addLanguageMap(), clear(), clearLanguageMap(), getLanguageName(), getNamedLanguage(), installLanguageMapDefault(), LANG_IGNORE, list, NULL, RSV_LANGMAP_DEFAULT, strncasecmp, and verbose().

Referenced by processLanguageMapOption().

◆ processLanguageMapOption()

static void processLanguageMapOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1866 of file options.c.

References eFree(), error(), eStrdup(), installLanguageMapDefaults(), NULL, processLanguageMap(), RSV_LANGMAP_DEFAULT, verbose(), and WARNING.

◆ processLanguagesOption()

static void processLanguagesOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1887 of file options.c.

References eFree(), enableLanguage(), enableLanguages(), error(), eStrdup(), getNamedLanguage(), LANG_IGNORE, NULL, RSV_LANG_ALL, verbose(), and WARNING.

◆ processLicenseOption()

static void processLicenseOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2018 of file options.c.

References License1, License2, and printProgramIdentification().

◆ processListAliasesOption()

static void processListAliasesOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2029 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, printLanguageAliases(), RSV_LANG_ALL, strcasecmp, and localOptionValues::withListHeader.

◆ processListExcludesOption()

static void processListExcludesOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1472 of file options.c.

References colprintLineAppendColumnVString(), colprintTableDelete(), colprintTableGetNewLine(), colprintTableNew(), colprintTablePrint(), colprintTableSort(), Excluded, excludesCompare(), line, localOption, localOptionValues::machinable, max, NULL, stringListCount(), stringListItem(), and localOptionValues::withListHeader.

◆ processListExtrasOption()

static void processListExtrasOption	(	const char *const	option,
		const char *const	parameter
	)

static

◆ processListFeaturesOption()

static void processListFeaturesOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 1523 of file options.c.

References checkRegex(), colprintLineAppendColumnCString(), colprintTableDelete(), colprintTableGetNewLine(), colprintTableNew(), colprintTablePrint(), colprintTableSort(), featureCompare(), Features, line, localOption, localOptionValues::machinable, Feature::name, name, NULL, and localOptionValues::withListHeader.

◆ processListFieldsOption()

static void processListFieldsOption	(	const char *const	option,
		const char *const	parameter
	)

static

◆ processListKinddefFlagsOptions()

static void processListKinddefFlagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2207 of file options.c.

References localOption, localOptionValues::machinable, printKinddefFlags(), and localOptionValues::withListHeader.

◆ processListKindsOption()

static void processListKindsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2078 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, printLanguageKinds(), RSV_LANG_ALL, strcasecmp, and localOptionValues::withListHeader.

◆ processListLangdefFlagsOptions()

static void processListLangdefFlagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2199 of file options.c.

References localOption, localOptionValues::machinable, printLangdefFlags(), and localOptionValues::withListHeader.

◆ processListLanguagesOption()

static void processListLanguagesOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2159 of file options.c.

References printLanguageList().

◆ processListMapExtensionsOption()

static void processListMapExtensionsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2140 of file options.c.

References LMAP_EXTENSION, LMAP_TABLE_OUTPUT, and processListMapsOptionForType().

◆ processListMapPatternsOption()

static void processListMapPatternsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2146 of file options.c.

References LMAP_PATTERN, LMAP_TABLE_OUTPUT, and processListMapsOptionForType().

◆ processListMapsOption()

static void processListMapsOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2152 of file options.c.

References LMAP_ALL, and processListMapsOptionForType().

◆ processListMapsOptionForType()

static void processListMapsOptionForType	(	const char *const	option,
		const char *const	parameter,
		langmapType	type
	)

static

Definition at line 2119 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, printLanguageMaps(), RSV_LANG_ALL, strcasecmp, and localOptionValues::withListHeader.

Referenced by processListMapExtensionsOption(), processListMapPatternsOption(), and processListMapsOption().

◆ processListMultilineRegexFlagsOptions()

static void processListMultilineRegexFlagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2183 of file options.c.

References localOption, localOptionValues::machinable, printMultilineRegexFlags(), and localOptionValues::withListHeader.

◆ processListMultitableRegexFlagsOptions()

static void processListMultitableRegexFlagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2191 of file options.c.

References localOption, localOptionValues::machinable, printMultitableRegexFlags(), and localOptionValues::withListHeader.

◆ processListParametersOption()

static void processListParametersOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2098 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, printLanguageParameters(), RSV_LANG_ALL, strcasecmp, and localOptionValues::withListHeader.

◆ processListPseudoTagsOptions()

static void processListPseudoTagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2167 of file options.c.

References localOption, localOptionValues::machinable, printPtags(), and localOptionValues::withListHeader.

◆ processListRegexFlagsOptions()

static void processListRegexFlagsOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2175 of file options.c.

References localOption, localOptionValues::machinable, printRegexFlags(), and localOptionValues::withListHeader.

◆ processListRolesOptions()

static void processListRolesOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2215 of file options.c.

References error(), eStrndup(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, NULL, printLanguageRoles(), processListRolesOptions(), vStringCatS(), vStringNewInit(), vStringValue, and localOptionValues::withListHeader.

Referenced by processListRolesOptions().

◆ processListSubparsersOptions()

static void processListSubparsersOptions	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2264 of file options.c.

References error(), FATAL, getNamedLanguage(), LANG_AUTO, LANG_IGNORE, localOption, localOptionValues::machinable, NULL, printLanguageSubparsers(), RSV_LANG_ALL, and localOptionValues::withListHeader.

◆ processLongOption()

static void processLongOption	(	const char *const	option,
		const char *const	parameter
	)

static

◆ processMapOption()

bool processMapOption	(	const char *const	option,
		const char *const	parameter
	)

Definition at line 1939 of file options.c.

References addLanguageMap(), Assert, clear(), clearLanguageMap(), eFree(), error(), eStrdup(), FATAL, getLanguageComponentInOption(), getLanguageName(), LANG_IGNORE, NULL, removeLanguageMap(), and verbose().

Referenced by processLongOption().

◆ processMaxRecursionDepthOption()

static void processMaxRecursionDepthOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2747 of file options.c.

References error(), FATAL, sOptionValues::maxRecursionDepth, NULL, and Option.

◆ processMultilineRegexOption()

static bool processMultilineRegexOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3220 of file options.c.

References getLanguageComponentInOption(), LANG_IGNORE, processLanguageRegexOption(), and REG_PARSER_MULTI_LINE.

Referenced by processLongOption().

◆ processMultitableExtendingOption()

static bool processMultitableExtendingOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3248 of file options.c.

References getLanguageComponentInOption(), LANG_IGNORE, and processLanguageMultitableExtendingOption().

Referenced by processLongOption().

◆ processMultitableRegexOption()

static bool processMultitableRegexOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3234 of file options.c.

References getLanguageComponentInOption(), LANG_IGNORE, processLanguageRegexOption(), and REG_PARSER_MULTI_TABLE.

Referenced by processLongOption().

◆ processOptionFile()

static void processOptionFile	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2365 of file options.c.

References processOptionFileCommon().

◆ processOptionFileCommon()

static void processOptionFileCommon	(	const char *const	option,
		const char *const	parameter,
		bool	allowNonExistingFile
	)

static

Definition at line 2324 of file options.c.

References error(), eStat(), eStatFree(), fileStatus::exists, expandOnOptlibPathList(), FATAL, fileStatus::isDirectory, NULL, parseAllConfigurationFilesOptionsInDirectory(), parseFileOptions(), PERROR, vStringDelete(), and vStringValue.

Referenced by processOptionFile(), and processOptionFileMaybe().

◆ processOptionFileMaybe()

static void processOptionFileMaybe	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2371 of file options.c.

References processOptionFileCommon().

◆ processOptlibDir()

static void processOptlibDir	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2722 of file options.c.

References Assert, prependToOptlibPathList(), and resetOptlibPathList().

◆ processOutputFormat()

static void processOutputFormat	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2377 of file options.c.

References error(), FATAL, NULL, setEtagsMode(), setTagWriter(), setXrefMode(), and WRITER_E_CTAGS.

◆ processParametricOption()

static bool processParametricOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2906 of file options.c.

References checkOptionOrder(), count, entry, error(), ParametricOptions, Stage, StageDescription, and WARNING.

Referenced by processLongOption().

◆ processParamOption()

bool processParamOption	(	const char *const	option,
		const char *const	value
	)

Definition at line 1994 of file options.c.

References applyParameter(), error(), FATAL, getLanguageComponentInOption(), getLanguageName(), LANG_IGNORE, name, and NULL.

Referenced by processLongOption().

◆ processPatternLengthLimit()

static void processPatternLengthLimit	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2758 of file options.c.

References error(), FATAL, NULL, Option, sOptionValues::patternLengthLimit, and strToUInt().

◆ processPseudoTags()

static void processPseudoTags	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2399 of file options.c.

References enablePtag(), error(), FATAL, getPtagTypeForName(), name, PTAG_COUNT, PTAG_UNKNOWN, vStringClear, vStringCopyS(), vStringDelete(), vStringLength, vStringNew(), vStringPut(), and vStringValue.

◆ processRegexOption()

static bool processRegexOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 3206 of file options.c.

References getLanguageComponentInOption(), LANG_IGNORE, processLanguageRegexOption(), and REG_PARSER_SINGLE_LINE.

Referenced by processLongOption().

◆ processShortOption()

static void processShortOption	(	const char *const	option,
		const char *const	parameter
	)

static

◆ processSortOption()

static void processSortOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2469 of file options.c.

References error(), FATAL, isFalse(), isTrue(), Option, SO_FOLDSORTED, SO_SORTED, SO_UNSORTED, sOptionValues::sorted, and strcasecmp.

◆ processTagRelative()

static void processTagRelative	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2484 of file options.c.

References error(), FATAL, isFalse(), isTrue(), Option, strcasecmp, sOptionValues::tagRelative, TREL_ALWAYS, TREL_NEVER, TREL_NO, and TREL_YES.

◆ processTotals()

static void processTotals	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2499 of file options.c.

References error(), FATAL, isFalse(), isTrue(), Option, sOptionValues::printTotals, and strcasecmp.

◆ processVersionOption()

static void processVersionOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2647 of file options.c.

References printProgramIdentification().

◆ processXformatOption()

static void processXformatOption	(	const char *const	option,
		const char *const	parameter
	)

static

Definition at line 2694 of file options.c.

References sOptionValues::customXfmt, fmtDelete(), fmtNew(), and Option.

◆ ptagMakePatternLengthLimit()

bool ptagMakePatternLengthLimit	(	ptagDesc *	pdesc,
		langType	language,
		const void *	data
	)

Definition at line 2767 of file options.c.

References NULL, sOptionValues::patternLengthLimit, and writePseudoTag().

◆ readIgnoreList()

static void readIgnoreList ( const char *const list )

static

Definition at line 2553 of file options.c.

References applyParameter(), eFree(), getNamedLanguage(), IGNORE_SEPARATORS, list, NULL, and stringCopy().

Referenced by processIgnoreOption().

◆ readOptionConfiguration()

void readOptionConfiguration ( void )

Definition at line 3791 of file options.c.

References parseConfigurationFileOptions(), parseEnvironmentOptions(), and SkipConfiguration.

Referenced by ctags_cli_main().

◆ removeLanguageMap()

static char * removeLanguageMap	(	const langType	language,
		char *	map_parameter
	)

static

Definition at line 1798 of file options.c.

References eFree(), error(), extractMapFromParameter(), FATAL, getLanguageName(), NULL, removeLanguageExtensionMap(), removeLanguagePatternMap(), and skipPastMap().

Referenced by processMapOption().

◆ resetFieldsOption()

static void resetFieldsOption	(	langType	lang,
		bool	mode
	)

static

Definition at line 1322 of file options.c.

References countFields(), enableField(), getFieldOwner(), and LANG_AUTO.

Referenced by processFieldsOption(), and processLangSpecificFieldsOption().

◆ resetOptlibPathList()

static void resetOptlibPathList ( bool report_in_verbose )

static

Definition at line 2714 of file options.c.

References freeSearchPathList(), OptlibPathList, stringListNew(), and verbose().

Referenced by processOptlibDir().

◆ resetXtags()

static void resetXtags	(	langType	lang,
		bool	mode
	)

static

Definition at line 1233 of file options.c.

References countXtags(), enableXtag(), getXtagOwner(), and LANG_AUTO.

Referenced by processExtraTagsOption(), and processLangSpecificExtraOption().

◆ setBooleanToXtagWithWarning()

static void setBooleanToXtagWithWarning	(	booleanOption *const	option,
		bool	value
	)

static

Definition at line 2778 of file options.c.

References enableXtag(), error(), sBooleanOption::name, sBooleanOption::pValue, and WARNING.

◆ setDefaultTagFileName()

void setDefaultTagFileName ( void )

Definition at line 706 of file options.c.

References sOptionValues::filter, sOptionValues::interactive, NULL, Option, outputDefaultFileName(), stringCopy(), and sOptionValues::tagFileName.

Referenced by openTagFile().

◆ setEtagsMode()

static void setEtagsMode ( void )

static

Definition at line 807 of file options.c.

References enableLanguage(), sOptionValues::etags, LANG_FALLBACK, sOptionValues::lineDirectives, NULL, Option, setTagWriter(), SO_UNSORTED, sOptionValues::sorted, sOptionValues::tagRelative, TREL_YES, and WRITER_ETAGS.

Referenced by processOutputFormat(), processShortOption(), and testEtagsInvocation().

◆ setXrefMode()

static void setXrefMode ( void )

static

Definition at line 834 of file options.c.

References NULL, Option, setTagWriter(), WRITER_XREF, and sOptionValues::xref.

Referenced by processOutputFormat(), and processShortOption().

◆ skipPastMap()

static char * skipPastMap ( char * p )

static

Definition at line 1706 of file options.c.

References EXTENSION_SEPARATOR, and PATTERN_START.

Referenced by addLanguageMap(), and removeLanguageMap().

◆ stringCopy()

static char * stringCopy ( const char *const string )

static

Definition at line 680 of file options.c.

References eStrdup(), and NULL.

Referenced by processFilterTerminatorOption(), processShortOption(), readIgnoreList(), and setDefaultTagFileName().

◆ testEtagsInvocation()

void testEtagsInvocation ( void )

Definition at line 817 of file options.c.

References eFree(), eStrdup(), ETAGS, getExecutableName(), NULL, setEtagsMode(), strstr(), toLowerString(), and verbose().

Referenced by ctags_cli_main().

◆ verbose()

void verbose	(	const char *const	format,
			...
	)

Definition at line 655 of file options.c.

References ctags_verbose, and format.

Referenced by addExtensionList(), analyzePostParens(), batchMakeTags(), chooseExclusiveSubparser(), corkSymtabPut(), createTags(), createTagsForEntry(), ctags_cli_main(), defineKind(), defineScopeSeparator(), defineXtag(), doesParserRequireMemoryStream(), enableField(), extendRegexTable(), findCTags(), findFortranTags(), foreachEntriesInScope(), getFileLanguageForRequestInternal(), getSpecLanguageCommon(), guestRequestSubmit(), handleUnicodeCodePoint(), initializeParserOne(), initializeParsing(), initializeParsingCommon(), initOptions(), installLanguageAliasesDefaults(), installLanguageMapDefaults(), matchMultitableRegexTable(), openInputFile(), parseEnvironmentOptions(), parseFileOptions(), parseFileWithMio(), parseString(), pickLanguageBySelection(), popNarrowedInputStream(), preload(), prependToOptlibPathList(), processAliasOption(), processExcludeOptionCommon(), processForceInitOption(), processHeaderListOption(), processLangAliasOption(), processLanguageMap(), processLanguageMapOption(), processLanguagesOption(), processLongOption(), processMapOption(), processPretendOption(), processShortOption(), processTagRegexOption(), pushNarrowedInputStream(), recurseIntoDirectory(), removeLanguageExtensionMap1(), removeLanguagePatternMap1(), renderEscapedName(), resetOptlibPathList(), runParserInNarrowedInputStream(), scheduleRunningBaseparser(), skipInitializer(), skipToMatch(), sortTagFile(), tasteLanguage(), testEtagsInvocation(), and verboseReportCandidate().

Variable Documentation

◆ BooleanOptions

booleanOption BooleanOptions[]

static

Initial value:

= {
    { "append",         &Option.append,                 true,   ~0UL  },
    { "file-scope",     ((bool *)XTAG_FILE_SCOPE),   false,  ~0UL , setBooleanToXtagWithWarning },
    { "file-tags",      ((bool *)XTAG_FILE_NAMES),   false,  ~0UL , setBooleanToXtagWithWarning },
    { "filter",         &Option.filter,                 true,   ~0UL  },
    { "guess-language-eagerly", &Option.guessLanguageEagerly, false,  ~0UL  },
    { "line-directives",&Option.lineDirectives,         false,  ~0UL  },
    { "links",          &Option.followLinks,            false,  ~0UL  },
    { "machinable",     &localOption.machinable,             true,   ~0UL  },
    { "put-field-prefix", &Option.putFieldPrefix,       false,  ~0UL  },
    { "print-language", &Option.printLanguage,          true,   ~0UL  },
    { "quiet",          &Option.quiet,                  false,  ~0UL  },
 
 
 
    { "verbose",        &ctags_verbose,                false,  ~0UL  },
 
 
 
    { "with-list-header", &localOption.withListHeader,       true,   ~0UL  },
    { "_fatal-warnings",&Option.fatalWarnings,          false,  ~0UL  },
}

Definition at line 2873 of file options.c.

Referenced by processBooleanOption(), and processDumpOptionsOption().

◆ ctags_debugLevel

long ctags_debugLevel = 0L

Definition at line 134 of file options.c.

Referenced by processShortOption().

◆ ctags_verbose

bool ctags_verbose = false

Definition at line 135 of file options.c.

Referenced by processShortOption(), and verbose().

◆ Excluded

stringList* Excluded

static

Definition at line 126 of file options.c.

Referenced by freeOptionResources(), isExcludedFile(), processExcludeOption(), and processListExcludesOption().

◆ ExcludedException

stringList * ExcludedException

static

Definition at line 126 of file options.c.

Referenced by freeOptionResources(), isExcludedFile(), and processExcludeExceptionOption().

◆ ExperimentalLongOptionDescription

optionDescription ExperimentalLongOptionDescription[]

static

Definition at line 441 of file options.c.

Referenced by processHelpOptionCommon().

◆ Features

struct Feature Features[]

static

Referenced by printFeatureList(), and processListFeaturesOption().

◆ FilesRequired

bool FilesRequired = true

static

Definition at line 127 of file options.c.

Referenced by filesRequired(), and processEtagsInclude().

◆ HeaderExtensions

const char* const HeaderExtensions[]

static

Initial value:

= {
    "h", "H", "hh", "hpp", "hxx", "h++", "inc", "def", NULL
}

Definition at line 130 of file options.c.

Referenced by installHeaderListDefaults().

◆ License1

const char* const License1

static

Initial value:

=
"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"

Definition at line 503 of file options.c.

Referenced by processLicenseOption().

◆ License2

const char* const License2

static

Initial value:

=
"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"

Definition at line 509 of file options.c.

Referenced by processLicenseOption().

◆ localOption

struct localOptionValues localOption

Initial value:

= {
    .machinable = false,
    .withListHeader = true,
}

Referenced by processListAliasesOption(), processListExcludesOption(), processListExtrasOption(), processListFeaturesOption(), processListFieldsOption(), processListKinddefFlagsOptions(), processListKindsOption(), processListLangdefFlagsOptions(), processListMapsOptionForType(), processListMultilineRegexFlagsOptions(), processListMultitableRegexFlagsOptions(), processListParametersOption(), processListPseudoTagsOptions(), processListRegexFlagsOptions(), processListRolesOptions(), and processListSubparsersOptions().

◆ LongOptionDescription

optionDescription LongOptionDescription[]

static

Definition at line 199 of file options.c.

Referenced by processHelpOptionCommon().

◆ NonOptionEncountered

bool NonOptionEncountered = false

static

Definition at line 120 of file options.c.

Referenced by checkOptionOrder(), parseEnvironmentOptions(), parseFileOptions(), and parseOptions().

◆ Option

optionValues Option

Definition at line 137 of file options.c.

Referenced by addCommonPseudoTags(), appendInputLine(), batchMakeTags(), canUseLineNumberAsLocator(), checkOptions(), closeInputFile(), closeTagFile(), createTagsForEntry(), createTagsFromFileInput(), ctags_cli_main(), Scintilla::OptionSet< T >::DefineProperty(), doesContainAnyCharInInput(), etagsInclude(), fileNewline(), filesRequired(), freeOptionResources(), getFieldName(), getFileLanguageForRequest(), getFileLanguageForRequestInternal(), hasTagEntryTabOrNewlineChar(), iFileGetLine(), initializeParserStats(), initTagEntryFull(), inSandbox(), installHeaderListDefaults(), internalSortTags(), isDestinationStdout(), isIncludeFile(), makeDefineTag(), makePatternStringCommon(), notice(), openTagFile(), parseEnvironmentOptions(), parseFileWithMio(), printGuessedParser(), printOptionDescriptions(), processEtagsInclude(), processExcmdOption(), processFilterTerminatorOption(), processFormatOption(), processHeaderListOption(), processLanguageForceOption(), processMaxRecursionDepthOption(), processPatternLengthLimit(), processShortOption(), processSortOption(), processTagRelative(), processTotals(), processXformatOption(), recurseIntoDirectory(), renderFieldInput(), renderFieldInputNoEscape(), renderFieldLanguage(), renderFieldLineNumber(), setDefaultTagFileName(), setEtagsMode(), setInputFileParametersCommon(), setXrefMode(), sortTagFile(), stderrDefaultErrorPrinter(), updateSortedFlag(), writeCtagsEntry(), writeEtagsEntry(), writeEtagsIncludes(), writeLineNumberEntry(), writeSortedTags(), writeTagEntry(), and writeXrefEntry().

◆ OptionFiles

stringList* OptionFiles

static

Definition at line 121 of file options.c.

Referenced by freeOptionResources(), initOptions(), and parseFileOptions().

◆ OptlibPathList

searchPathList* OptlibPathList

static

Definition at line 124 of file options.c.

Referenced by expandOnOptlibPathList(), freeOptionResources(), initOptions(), prependToOptlibPathList(), and resetOptlibPathList().

◆ ParametricOptions

parametricOption ParametricOptions[]

static

Definition at line 2803 of file options.c.

Referenced by processDumpOptionsOption(), and processParametricOption().

◆ preload_path_list

struct preloadPathElt preload_path_list[]

static

Definition at line 3708 of file options.c.

Referenced by parseConfigurationFileOptions().

◆ SkipConfiguration

bool SkipConfiguration

static

Definition at line 128 of file options.c.

Referenced by previewFirstOption(), and readOptionConfiguration().

◆ Stage

OptionLoadingStage Stage = OptionLoadingStageNone

static

Definition at line 192 of file options.c.

Referenced by preload(), processBooleanOption(), and processParametricOption().

◆ StageDescription

const char* const StageDescription[]

static

Initial value:

= {
    [OptionLoadingStageNone]   = "not initialized",
    [OptionLoadingStageCustom] = "custom file",
    [OptionLoadingStageDosCnf] = "DOS .cnf file",
    [OptionLoadingStageEtc] = "file under /etc (e.g. ctags.conf)",
    [OptionLoadingStageLocalEtc] = "file under /usr/local/etc (e.g. ctags.conf)",
    [OptionLoadingStageXdg] = "file(s) under $XDG_CONFIG_HOME and $HOME/.config",
    [OptionLoadingStageHomeRecursive] = "file(s) under $HOME",
    [OptionLoadingStageCurrentRecursive] = "file(s) under the current directory",
    [OptionLoadingStagePreload] = "optlib preload files",
    [OptionLoadingStageEnvVar] = "environment variable",
    [OptionLoadingStageCmdline] = "command line",
}

Definition at line 577 of file options.c.

Referenced by preload(), processBooleanOption(), and processParametricOption().

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

◆ _GNU_SOURCE

◆ ACCEPT

◆ CTAGS_ENVIRONMENT

◆ DEFAULT_FILE_FORMAT

◆ ENTER

◆ ETAGS

◆ ETAGS_ENVIRONMENT

◆ EXTENSION_SEPARATOR

◆ IGNORE_SEPARATORS

◆ INVOCATION

◆ isCompoundOption

◆ OPTION_WRITE

◆ PATTERN_START

◆ PATTERN_STOP

◆ PREFIX [1/2]

◆ PREFIX [2/2]

◆ PREFIX_LEN [1/2]

◆ PREFIX_LEN [2/2]

◆ STAGE_ANY

◆ va_copy

Typedef Documentation

◆ booleanOption

◆ optionDescription

◆ parametricOptionHandler

◆ preloadMakePathFunc

◆ searchPathList

Enumeration Type Documentation

◆ eOptionLimits

Function Documentation

◆ addExtensionList()

◆ addIgnoreListFromFile()

◆ addLanguageMap()

◆ asprintf()

◆ canUseLineNumberAsLocator()

◆ cArgDelete()

◆ cArgForth()

◆ cArgIsOption()

◆ cArgItem()

◆ cArgNewFromArgv()

◆ cArgNewFromFile()

◆ cArgNewFromLineFile()

◆ cArgNewFromString()

◆ cArgOff()

◆ cArgOptionPending()

◆ cArgRead()

◆ checkOptionOrder()

◆ checkOptions()

◆ checkSameFile()

◆ enableLanguageField()

◆ enableLanguageXtag()

◆ excludesCompare()

◆ expandOnOptlibPathList()

◆ expandOnSearchPathList()

◆ extractMapFromParameter()

◆ featureCompare()

◆ filesRequired()

◆ freeList()

◆ freeOptionResources()

◆ freeSearchPathList()

◆ freeString()

◆ getBooleanOption()

◆ getConfigForXDG()

◆ getLanguageComponentInOption()

◆ getLanguageComponentInOptionFull()

◆ initOptions()

◆ inSandbox()

◆ installHeaderListDefaults()

◆ isDestinationStdout()

◆ isExcludedFile()

◆ isFalse()

◆ isIncludeFile()

◆ isTrue()

◆ notice()