Source

TagHighlight / plugin / TagHighlight / data / options.txt

Full commit
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
#####################
# Vim-only options: #
#####################

language_detection_method:
	VimOptionMap:LanguageDetectionMethods
	Type:list
	Default:Extension
	Help:Specify methods to use for determining language for the file when reading highlight definitions.

filetype_language_overrides:
	VimOptionMap:FileTypeLanguageOverrides
	Type:dict
	Default:{}
	Help:Match file types to languages manually (if FileType language detection method is enabled).

extension_language_overrides:
	VimOptionMap:ExtensionLanguageOverrides
	Type:dict
	Default:{}
	Help:Match extensions to languages manually (if Extension language detection method is enabled).

syntax_language_overrides:
	VimOptionMap:SyntaxLanguageOverrides
	Type:dict
	Default:{}
	Help:Match syntaxes to languages manually (if Syntax language detection method is enabled).

disable_type_parsing:
	VimOptionMap:DisableTypeParsing
	Type:bool
	Default:False
	Help:Do not read types when opening a file

parsing_skip_list:
	VimOptionMap:ParsingSkipList
	Type:list
	Default:[]
	Help:List of files for which the type reading should be disabled

def_dir_mode_priority:
	VimOptionMap:DefaultDirModePriority
	Type:list
	Default:[]
	Help:List of methods (in order) to use when searching for tags/types etc
	Note:Default is overridden in TagHighlight#Option#GetOption()

max_dir_search_levels:
	VimOptionMap:MaxDirSearchLevels
	Type:int
	Default:0
	Help:How far up to search in UpFromFile or UpFromCurrent mode

config_file_name:
	VimOptionMap:ProjectConfigFileName
	Type:string
	Default:taghl_config.txt
	Help:File name for project specific configuration items

tag_dir_mode_priority:
	VimOptionMap:TagFileDirModePriority
	Type:list
	Default:Default
	Help:Optional override for dir mode priority for tag files specifically

types_dir_mode_priority:
	VimOptionMap:TypesFileDirModePriority
	Type:list
	Default:Default
	Help:Optional override for dir mode priority for types files specifically

config_dir_mode_priority:
	VimOptionMap:ProjectConfigFileDirModePriority
	Type:list
	Default:Default
	Help:Optional override for dir mode priority for project config files specifically

tag_file_directory:
	VimOptionMap:TagFileDirectory
	Type:string
	Default:None
	Help:Explicitly specified location for tag file (corresponding to Explicit search mode)

disable_tag_manager:
	VimOptionMap:DisableTagManager
	Type:bool
	Default:False
	Help:Disable automatic management of tags option

types_file_directory:
	VimOptionMap:TypesFileDirectory
	Type:string
	Default:None
	Help:Explicitly specified location for types file (corresponding to Explicit search mode)

config_file_directory:
	VimOptionMap:ProjectConfigFileDirectory
	Type:string
	Default:None
	Help:Explicitly specified location for project config file (corresponding to Explicit search mode)

default_dir_mode_search_wildcards:
	VimOptionMap:DefaultDirModeSearchWildcards
	Type:list
	Default:OPT(TagFileName),OPT(ProjectConfigFileName)
	Help:When searching directories, wildcards to match against (if any matches, we'll use this directory)

config_dir_mode_search_wildcards:
	VimOptionMap:ProjectConfigFileSearchWildcards
	Type:list
	Default:Default
	Help:When searching directories for project config files, wildcards to match against (if any matches, we'll use this directory)

tag_dir_mode_search_wildcards:
	VimOptionMap:TagFileSearchWildcards
	Type:list
	Default:Default
	Help:When searching directories for tag files, wildcards to match against (if any matches, we'll use this directory)

types_dir_mode_search_wildcards:
	VimOptionMap:TypesFileSearchWildcards
	Type:list
	Default:Default
	Help:When searching directories for types files, wildcards to match against (if any matches, we'll use this directory)

ctags_executable:
	VimOptionMap:CtagsExecutable
	Type:string
	Default:None
	Help:Name of the ctags executable, or full path to it

forced_python_variant:
	VimOptionMap:ForcedPythonVariant
	Type:string
	Default:None
	Help:Force the use of a specific variant (see help for PythonVariantPriority)

python_variant_priority:
	VimOptionMap:PythonVariantPriority
	Type:list
	Default:if_pyth3,if_pyth,python,compiled
	Help:Search order for deciding which variant to use

path_to_python:
	VimOptionMap:PathToPython
	Type:string
	Default:None
	Help:Location of the python executable or None to search the path

pre_read_hooks:
	VimOptionMap:PreReadHooks
	Type:list
	Default:[]
	Help:List of function names to run before reading types.

post_read_hooks:
	VimOptionMap:PostReadHooks
	Type:list
	Default:[]
	Help:List of function names to run after reading types.

pre_update_hooks:
	VimOptionMap:PreUpdateHooks
	Type:list
	Default:[]
	Help:List of function names to run before updating types.

post_update_hooks:
	VimOptionMap:PostUpdateHooks
	Type:list
	Default:[]
	Help:List of function names to run after updating types.

hooks:
	VimOptionMap:Hooks
	Type:dict
	Default:{'PreUpdate': [], 'PostUpdate': [], 'PreRead': [], 'PostRead': []}
	Help:Hooks dictionary (each entry is a list of strings containing functions to call; read functions take current file name and types suffix as parameters).

forced_standard_libraries:
	VimOptionMap:ForcedStandardLibraries
	Type:list
	Default:[]
	Help:List of standard libraries which we should load regardless of whether the matchers match (as long as suffix is correct).

disable_standard_libraries:
	VimOptionMap:DisableStandardLibraries
	Type:bool
	Default:False
	Help:Don't try to load standard libraries.

user_libraries:
	VimOptionMap:UserLibraries
	Type:list
	Default:[]
	Help:List of user libraries to load (either relative to UserLibraryDir or absolute).

user_library_dir:
	VimOptionMap:UserLibraryDir
	Type:string
	Default:.
	Help:Location of user libraries that are specified with relative paths.

use_existing_tagfile_if_present:
	VimOptionMap:DoNotGenerateTagsIfPresent
	Type:bool
	Default:False
	Help:Do not generate tags if a tag file already exists.

only_generate_types_if_present:
	VimOptionMap:OnlyGenerateTypesIfPresent
	Type:bool
	Default:False
	Help:Only generate tags/types if a types file already exists.

reload_colour_scheme:
	VimOptionMap:ReloadColourScheme
	Type:bool
	Default:False
	Help:Reload the colour scheme after reading types file (in case colours don't work properly)

##########################
# Python script options: #
##########################

debug_level:
	CommandLineSwitches:--debug
	VimOptionMap:DebugLevel
	Type:string
	Default:Error
	Help:Debug level for printing (how much debug output to produce)

debug_file:
	CommandLineSwitches:--debug-file
	VimOptionMap:DebugFile
	Type:string
	Default:None
	Help:Debug log file into which messages should be stored

debug_print_time:
	CommandLineSwitches:--print-time-with-debug
	VimOptionMap:DebugPrintTime
	Type:bool
	Default:False
	Help:Print the time with each debug message in the log

source_root:
	CommandLineSwitches:-d,--source-root
	VimOptionMap:SourceDir
	Type:string
	Default:None
	Help:Location of source files to scan

recurse:
	CommandLineSwitches:--no-recurse
	VimOptionMap:Recurse
	Type:bool
	Default:True
	Help:Recurse into subdirectories
 
ctags_file:
	CommandLineSwitches:--ctags-file
	VimOptionMap:TagFileName
	Type:string
	Default:tags
	Help:CTAGS output filename

ctags_file_dir:
	CommandLineSwitches:--ctags-file-dir
	VimOptionMap:CtagsFileLocation
	Type:string
	Default:.
	Help:Location in which to store or find CTAGS output file

types_file_name_override:
	CommandLineSwitches:--types-file-name-override
	VimOptionMap:TypesFileNameForce
	Type:string
	Default:None
	Help:Force types filename to be a specific string (as opposed to prefix + _ + suffix + . + extension).

types_file_prefix:
	CommandLineSwitches:--types-file-prefix
	VimOptionMap:TypesFilePrefix
	Type:string
	Default:types
	Help:Vim Types file prefix

types_file_extension:
	CommandLineSwitches:--types-file-extension
	VimOptionMap:TypesFileExtension
	Type:string
	Default:taghl
	Help:Extension for types file (by default 'taghl', which with default prefix gives types_c.taghl for C files).

skip_patterns:
	CommandLineSwitches:--add-skip-pattern
	VimOptionMap:SkipPatterns
	Type:list
	Default:[]
	Help:List of (Python) regular expressions to match against keywords which should be excluded from the types file.

skip_reserved_keywords:
	CommandLineSwitches:--skip-reserved-keywords
	VimOptionMap:SkipReservedKeywords
	Type:bool
	Default:True
	Help:Don't highlight keywords that are reserved in a given language.
 
ctags_exe_full:
	CommandLineSwitches:--ctags-exe-full-path
	VimOptionMap:CtagsExeFull
	Type:string
	Default:ctags
	Help:CTAGS Executable Directory

ctags_arguments:
	CommandLineSwitches:--add-ctags-argument
	VimOptionMap:CtagsArguments
	Type:list
	Default:[]
	Help:Explicit list of arguments to pass to ctags (for use with non-recognised ctags implementations).

ctags_extra_arguments:
	CommandLineSwitches:--add-extra-ctags-argument
	VimOptionMap:CtagsExtraArguments
	Type:list
	Default:[]
	Help:List of extra arguments to pass to ctags.

ctags_variant:
	CommandLineSwitches:--ctags-variant
	VimOptionMap:CtagsVariant
	Type:string
	Default:exuberant
	Help:Tells TagHighlight which variant of ctags is being used: some have different requirements for their arguments.
 
include_docs:
	CommandLineSwitches:--include-docs
	Type:bool
	Default:False
	Help:Include docs or Documentation directory (stripped by default for speed)
 
check_keywords:
	CommandLineSwitches:--do-not-check-keywords
	Type:bool
	Default:True
	Help:Do not check validity of keywords (for speed)
 
include_matches:
	CommandLineSwitches:--include-invalid-keywords-as-matches
	VimOptionMap:IncludeSynMatches
	Type:bool
	Default:False
	Help:Include invalid keywords as regular expression matches (may slow it loading)
 
skip_vimkeywords:
	CommandLineSwitches:--exclude-vim-keywords
	VimOptionMap:SkipVimKeywords
	Type:bool
	Default:False
	Help:Don't include Vim keywords (they have to be matched with regular expression matches, which is slower)
 
parse_constants:
	CommandLineSwitches:--do-not-analyse-constants
	Type:bool
	Default:True
	Help:Do not treat constants as separate entries
 
languages:
	CommandLineSwitches:--include-language
	VimOptionMap:Languages
	Type:list
	Default:[]
	Help:Only include specified languages
 
types_file_location:
	CommandLineSwitches:--types-file-location
	VimOptionMap:TypesFileLocation
	Type:string
	Default:.
	Help:Specify the location for the generated types files
 
include_locals:
	CommandLineSwitches:--include-locals
	VimOptionMap:IncludeLocals
	Type:bool
	Default:False
	Help:Include local variables in the database
 
use_existing_tagfile:
	CommandLineSwitches:--use-existing-tagfile
	VimOptionMap:DoNotGenerateTags
	Type:bool
	Default:False
	Help:Do not generate tags: use an existing file
 
print_py_version:
	CommandLineSwitches:--pyversion
	Type:bool
	Default:False
	Help:Just print the version of python

print_config:
	CommandLineSwitches:--print-config
	Type:bool
	Default:False
	Help:Parse the various options and then print the configuration and exit (for debugging)

# vim: ff=unix:noet