Source-highlight Library
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
[detail level 123]
oNsrchiliteC++ class: doctemplate.h
|oNsrchilite
|oCBufferedOutputThe main class for writing into the output
|oCCharTranslatorTranslates specific character sequences into corresponding ones; it can also use regular expression for the characters to be translated
|oCColorMapSimple map for colors (maps a color constant string to the corresponding color of the output format)
|oCRefEntryInternal struct to store information about references
|oCCTagsInfoInformation about a tag
|oCCTagsCollectorCollects the tags information generated by the ctags program for a given word
|oCCTagsFormatterResultsStores the result of the CTagsFormatter
|oCCTagsFormatterFormatter for information gathered from ctags
|oCCTagsManagerTakes care of running ctags and to generate a CTagsFormmatter
|oCDebugListenerImplementation of highlight events that prints debug information
|oCDelimitedLangElem
|oCDocGeneratorGiven a DocTemplate it generates the start of the document and the end, using variables such as title, file_name, header, etc
|oCDocTemplate
|oCEventGeneratorA generic event generator, for listeners of type EventListener and events of type EventType
|oCFileInfoInformation about the file we are processing
|oCFormatterThe base abstract class for formatting strings
|oCFormatterFactoryThe generic abstract factory to create Formatter objects, during the parsing of style files
|oCFormatterManagerAssociates to an element name the corresponding formatter
|oCFormatterParamsAdditional parameters that can be passed to a formatter
|oCHighlightBuilderException
|oCHighlightEventEvent concerning an highlighting operation (e.g., formatting, entering a new state, exiting a state, etc.)
|oCHighlightEventListenerBase class for listeners of HighlightEvent
|oCHighlightRuleBase class for highlight rules
|oCHighlightRuleFactoryAbstract factory for highlighting rules
|oCHighlightStateRepresents a state during the highlighting (e.g., comment state, string state, etc.)
|oCHighlightStateBuilderBuilds an HighlightState from the language definition file collected structures
|oCHighlightStatePrinterPrints an HighlightState (and all its rules)
|oCHighlightTokenToken containing information for performing the highlight
|oCInstancesThis class contains static and singleton instances for some utility classes for LangDefManagers, LangMap, etc
|oCIOExceptionException representing an error in an input/output operation
|oCLangDefManagerHandles langdef language definition files
|oCLangElem
|oCLangElemsCollection of LangElem objects
|oCLangElemsPrinterPrints all the language elements
|oCLangMapA map stored in a file with the format key = elem
|oCLanguageInferTries to infer the language by inspecting the input file
|oCLineBufferA buffer for a line to be generated
|oCLineNumGeneratorGenerates line numbers in the output
|oCLineRangesFunctionalities for detecting whether a line is in one of the stored line ranges (or in the context of a range)
|oCMatchingParametersStructure for passing parameters to the matching algorithm, for instance, "not beginning of line", etc
|oCNamedSubExpsLangElemAn element with subparts (subexpressions), each with a possible different name
|oCParserExceptionRepresents an exception during parsing, for instance, syntax errors
|oCParserInfoStores information about the file name and the line number of a generic element created during parsing
|oCParseStruct
|oCPreFormatterPreformats text to be generated
|oCRegexHighlightRuleAn implementation of HighlightRule using Boost regex library
|oCsubexpressions_info
|oCRegexPreProcessorPreprocess a regular expression, e.g., transform "()" into "(?:)"
|oCRegexRangesStores possible separators implemented as regular expressions and provides functionalities to search for such occurrences in lines
|oCRegexRuleFactoryImplementation of the abstract factory, creating highlighting rules based on boost::regex regular expressions
|oCSettingsHandles the settings for source-highlight (and its library)
|oCSourceFileHighlighterHighlights the contents of a file relying on a SourceHighlighter
|oCSourceHighlightThe main class performing highlighting of an input file generating an output file
|oCSourceHighlighterThe main class performing the highlighting of a single line
|oCSourceHighlightUtilsClass with some utility static methods
|oCUntabifierPerFormratter to convert tabs to spaces before generation
|oCStateLangElemLanguage element that introduces a new state pattern Composite
|oCStateStartLangElemA language element that may start a new state/environment
|oCStopWatchRecords elapsed time
|oCStringDefRepresent a string for a language definition file's element
|oCStringDefsA collection (list) of StringDef's
|oCStringListLangElemA language element consisting of a list of strings
|oCStringTableStores dynamically allocated strings (used by the scanners), so that, later on, we can easily free all the memory for these strings
|oCStyleFileParserA utility class with static methods to parse style files
|oCTextStyleRepresents a formatting template where there can be some variables (starting with $, e.g., $style, $text, etc.) that will be replaced with specific elements, e.g., the actual style for the formatting, the text to format, etc
|oCTextStyleBuilderGiven TextStyle objects build a new one, adding a starting part, and ending part, and separating them
|oCTextStyleFormatterAn implementation of Formatter, based on source-highlight TextStyle
|oCTextStyleFormatterFactoryGenerates TextStyleFormatters based on TextStyles
|oCTextStylesContains TextStyle objects for all formats (e.g., bold, italics, etc), and other templates (e.g., for the document header, etc.); it also contains the color map and the char translator
|oCToLower
|oCToUpper
|oCUtilsGeneric utils functions (e.g., string manipulation)
|oCVarDefinitionsStore definitions of strings and regular expressions representing language elements
|oCVerbosityUtility class to output messages in case of verbose option is requested
|oCVersionsUtility functions for version numbers
|\CWordTokenizerTokenizes a paragraph separating words from spaces
oCElementNamesList
oCKey
oCsTagFile
oCtagEntry
oCtagExtensionField
oCtagFileInfo
oCvstring
oCyy_buffer_state
oCyy_trans_info
oCyyalloc
oCYYLTYPE
\CYYSTYPE