Source-highlight Library
Class List
Here are the classes, structs, unions and interfaces with brief descriptions:
srchilite::BufferedOutputThe main class for writing into the output
srchilite::CharTranslatorTranslates specific character sequences into corresponding ones; it can also use regualr expression for the characters to be translated
srchilite::ColorMapSimple map for colors (maps a color constant string to the corresponding color of the output format)
srchilite::CTagsCollectorCollects the tags information generated by the ctags program for a given word
srchilite::CTagsFormatterFormatter for information gathered from ctags
srchilite::CTagsFormatterResultsStores the result of the CTagsFormatter
srchilite::CTagsInfoInformation about a tag
srchilite::CTagsManagerTakes care of running ctags and to generate a CTagsFormmatter
srchilite::DebugListenerImplementation of highlight events that prints debug information
srchilite::DocGeneratorGiven a DocTemplate it generates the start of the document and the end, using variables such as title, file_name, header, etc
srchilite::EventGenerator< EventListener, EventType >A generic event generator, for listeners of type EventListener and events of type EventType
srchilite::FileInfoInformation about the file we are processing
srchilite::FormatterThe base abstract class for formatting strings
srchilite::FormatterFactoryThe generic abstract factory to create Formatter objects, during the parsing of style files
srchilite::FormatterManagerAssociates to an element name the corresponding formatter
srchilite::FormatterParamsAdditional parameters that can be passed to a formatter
srchilite::HighlightEventEvent concerning an highlighting operation (e.g., formatting, entering a new state, exiting a state, etc.)
srchilite::HighlightEventListenerBase class for listeners of HighlightEvent
srchilite::HighlightRuleBase class for highlight rules
srchilite::HighlightRuleFactoryAbstract factory for highlighting rules
srchilite::HighlightStateRepresents a state during the highlighting (e.g., comment state, string state, etc.)
srchilite::srchilite::HighlightStateRepresents a state during the highlighting (e.g., comment state, string state, etc.)
srchilite::HighlightStateBuilderBuilds an HighlightState from the language definition file collected structures
srchilite::HighlightStatePrinterPrints an HighlightState (and all its rules)
srchilite::HighlightTokenToken containing information for performing the highlight
srchilite::InstancesThis class contains static and singleton instances for some utility classes for LangDefManagers, LangMap, etc
srchilite::IOExceptionException representing an error in an input/output operation
srchilite::LangDefManagerHandles langdef language definition files
srchilite::srchilite::LangElemsCollection of LangElem objects
srchilite::LangElemsCollection of LangElem objects
srchilite::LangElemsPrinterPrints all the language elements
srchilite::LangMapA map stored in a file with the format key = elem
srchilite::LanguageInferTries to infer the language by inspecting the input file
srchilite::LineBufferA buffer for a line to be generated
srchilite::LineNumGeneratorGenerates line numbers in the output
srchilite::LineRangesFunctionalities for detecting whether a line is in one of the stored line ranges (or in the context of a range)
srchilite::MatchingParametersStructure for passing parameters to the matching algorithm, for instance, "not beginning of line", etc
srchilite::srchilite::NamedSubExpsLangElemAn element with subparts (subexpressions), each with a possible different name
srchilite::NamedSubExpsLangElemAn element with subparts (subexpressions), each with a possible different name
srchilite::ParserExceptionRepresents an exception during parsing, for instance, syntax errors
srchilite::srchilite::ParserInfoStores information about the file name and the line number of a generic element created during parsing
srchilite::ParserInfoStores information about the file name and the line number of a generic element created during parsing
srchilite::PreFormatterPreformats text to be generated
srchilite::RefEntryInternal struct to store information about references
srchilite::TextStyles::RefTextStyleThe TextStyle objects for reference formatting
srchilite::RegexHighlightRuleAn implementation of HighlightRule using Boost regex library
srchilite::RegexPreProcessorPreprocess a regular expression, e.g., transform "()" into "(?:)"
srchilite::RegexRangesStores possible separators implemented as regular expressions and provides functionalities to search for such occurrences in lines
srchilite::RegexRuleFactoryImplementation of the abstract factory, creating highlighting rules based on boost::regex regular expressions
srchilite::SettingsHandles the settings for source-highlight (and its library)
srchilite::SourceFileHighlighterHighlights the contents of a file relying on a SourceHighlighter
srchilite::SourceHighlightThe main class performing highlighting of an input file generating an output file
srchilite::SourceHighlighterThe main class performing the highlighting of a single line
srchilite::SourceHighlightUtilsClass with some utility static methods
srchilite::srchilite::StateLangElemLanguage element that introduces a new state pattern Composite
srchilite::StateLangElemLanguage element that introduces a new state pattern Composite
srchilite::srchilite::StateStartLangElemA language element that may start a new state/environment
srchilite::StateStartLangElemA language element that may start a new state/environment
srchilite::StopWatchRecords elapsed time
srchilite::StringDefRepresent a string for a language definition file's element
srchilite::StringDefsA collection (list) of StringDef's
srchilite::srchilite::StringListLangElemA language element consisting of a list of strings
srchilite::StringListLangElemA language element consisting of a list of strings
srchilite::StringTableStores dynamically allocated strings (used by the scanners), so that, later on, we can easily free all the memory for these strings
srchilite::StyleFileParserA utility class with static methods to parse style files
srchilite::TextStyleRepresents 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
srchilite::TextStyleBuilderGiven TextStyle objects build a new one, adding a starting part, and ending part, and separating them
srchilite::TextStyleFormatterAn implementation of Formatter, based on source-highlight TextStyle
srchilite::TextStyleFormatterFactoryGenerates TextStyleFormatters based on TextStyles
srchilite::TextStylesContains 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
srchilite::UntabifierPerFormratter to convert tabs to spaces before generation
srchilite::UtilsGeneric utils functions (e.g., string manipulation)
srchilite::VarDefinitionsStore definitions of strings and regular expressions representing language elements
srchilite::VerbosityUtility class to output messages in case of verbose option is requested
srchilite::VersionsUtility functions for version numbers
srchilite::WordTokenizerTokenizes a paragraph separating words from spaces