CmdLineOptions Class Reference

handle command line options More...

List of all members.

Public Member Functions

 CmdLineOptions (const int argc, const char *argv[])
const string & getSingleOutFilename ()
const string & getSingleInFilename () const
const string & getOutDirectory ()
const string getStyleOutFilename () const
const string & getStyleInFilename () const
const string & getEncoding () const
const string & getSVGWidth () const
const string & getSVGHeight () const
int getNumberSpaces () const
bool printVersion () const
bool printHelp () const
bool printDebugInfo () const
bool printConfigInfo () const
bool includeStyleDef () const
bool printLineNumbers () const
bool useCRDelimiter () const
string getThemeName () const
int helpLanguage () const
bool enableBatchMode () const
bool fragmentOutput () const
string getOutFileSuffix () const
bool attachLineAnchors () const
bool showThemes () const
bool showLangdefs () const
bool outDirGiven () const
bool dataDirGiven () const
bool additionalDataDirGiven () const
bool printIndexFile () const
bool replaceQuotes () const
bool disableBabelShorthands () const
bool useFNamesAsAnchors () const
const string & getDataDir () const
const string & getAdditionalDataDir () const
const string & getAdditionalConfDir () const
const string & getConfigFilePath () const
bool syntaxGiven () const
bool quietMode () const
bool printProgress () const
bool fillLineNrZeroes () const
const string & getLanguage () const
highlight::WrapMode getWrappingStyle () const
const vector< string > & getInputFileNames () const
const map< int, string > & getMarkLines ()
string getIndentScheme () const
const string & getPageSize () const
highlight::OutputType getOutputType () const
bool formatSupportsExtStyle ()
bool styleOutPathDefined () const
bool omitEncoding () const
bool forceOutput () const
bool orderedList () const
bool hasBaseFont () const
bool validateInput () const
bool inlineCSS () const
bool enclosePreTag () const
bool includeCharStyles () const
bool prettySymbols () const
bool printOnlyStyle () const
const string & getBaseFont () const
const string & getDocumentTitle () const
const string & getAnchorPrefix () const
const string & getClassName () const
const string & getTagsFile () const
bool hasBaseFontSize () const
bool disableTrailingNL () const
const string & getBaseFontSize () const
const string & getStartNestedLang () const
int getNumberWidth ()
int getLineLength ()
int getNumberStart ()
StringTools::KeywordCase getKeywordCase () const
bool isSkippedExt (const string &ext)


Detailed Description

handle command line options

Constructor & Destructor Documentation

CmdLineOptions::CmdLineOptions ( const int  argc,
const char *  argv[] 
)

Constructor

Parameters:
argc Argument count
argv Argument strings

References StringTools::CASE_CAPITALIZE, StringTools::CASE_LOWER, StringTools::CASE_UPPER, StringTools::change_case(), and printDebugInfo().


Member Function Documentation

bool CmdLineOptions::additionalDataDirGiven (  )  const

Returns:
True if an additional data directory is given

bool CmdLineOptions::attachLineAnchors (  )  const

Returns:
True if anchors should be attached to line numbers

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::dataDirGiven (  )  const

Returns:
True if refomatting is enabled

True if a new data directory is given

bool CmdLineOptions::disableBabelShorthands (  )  const

Returns:
True if shorthands of LaTeX Babel package should be disabled

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::disableTrailingNL (  )  const

Returns:
True if trailing nl should be omitted

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::enableBatchMode (  )  const

Returns:
True if batch mode is active

Referenced by getOutDirectory(), and HLCmdLineApp::run().

bool CmdLineOptions::enclosePreTag (  )  const

Returns:
True if fragmented html output should be enclosed with pre tags

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::fillLineNrZeroes (  )  const

Returns:
True if line numbers are filled with leading zeroes

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::forceOutput (  )  const

Returns:
True if output should be generated if languege type is unknown

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::formatSupportsExtStyle (  ) 

Returns:
True if chosen output format supports referenced style files

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::fragmentOutput (  )  const

Returns:
True if output shluld be fragmented

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getAdditionalConfDir (  )  const

Returns:
Additional config data directory

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getAdditionalDataDir (  )  const

Returns:
Additional data directory

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getAnchorPrefix (  )  const

Returns:
anchor prefix

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getBaseFont (  )  const

Returns:
The given base font, empty string by default

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getBaseFontSize (  )  const

Returns:
The given base font size, empty string by default

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getClassName (  )  const

Returns:
class name

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getConfigFilePath (  )  const

Returns:
path of user config file

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getDataDir (  )  const

Returns:
Data directory

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getDocumentTitle (  )  const

Returns:
Document title

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getEncoding (  )  const

Returns:
Char set

Referenced by HLCmdLineApp::run().

string CmdLineOptions::getIndentScheme (  )  const

Returns:
indentation and reformatting scheme

References StringTools::change_case().

Referenced by HLCmdLineApp::run().

const vector< string > & CmdLineOptions::getInputFileNames (  )  const

Returns:
List of input file names

Referenced by HLCmdLineApp::run().

StringTools::KeywordCase CmdLineOptions::getKeywordCase (  )  const

Returns:
Keyword Case (upper, lower, unchanged)

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getLanguage (  )  const

Returns:
programming syntax

Referenced by HLCmdLineApp::run().

int CmdLineOptions::getLineLength (  ) 

Returns:
line length

Referenced by HLCmdLineApp::run().

const map< int, string > & CmdLineOptions::getMarkLines (  ) 

Returns:
Map of marked lines

Referenced by HLCmdLineApp::run().

int CmdLineOptions::getNumberSpaces (  )  const

Returns:
Number of spaces to replace a tab

Referenced by HLCmdLineApp::run().

int CmdLineOptions::getNumberStart (  ) 

Returns:
Line number start count

Referenced by HLCmdLineApp::run().

int CmdLineOptions::getNumberWidth (  ) 

Returns:
line number width

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getOutDirectory (  ) 

Returns:
Output directory

References enableBatchMode().

Referenced by HLCmdLineApp::run().

string CmdLineOptions::getOutFileSuffix (  )  const

Returns:
output file suffix

Referenced by getSingleOutFilename(), and HLCmdLineApp::run().

highlight::OutputType CmdLineOptions::getOutputType (  )  const

Returns:
Output file format

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getPageSize (  )  const

Returns:
RTF page size

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getSingleInFilename (  )  const

Returns:
Single input file name

Referenced by getSingleOutFilename(), and HLCmdLineApp::run().

const string & CmdLineOptions::getSingleOutFilename (  ) 

Returns:
Single output file name

References getOutFileSuffix(), and getSingleInFilename().

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getStartNestedLang (  )  const

Returns:
name of nested syntax which starts the input

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getStyleInFilename (  )  const

Returns:
Style input file name

Referenced by HLCmdLineApp::run().

const string CmdLineOptions::getStyleOutFilename (  )  const

Returns:
Style output file name

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getSVGHeight (  )  const

Returns:
SVG height

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getSVGWidth (  )  const

Returns:
SVG width

Referenced by HLCmdLineApp::run().

const string & CmdLineOptions::getTagsFile (  )  const

Returns:
ctags file name

Referenced by HLCmdLineApp::run().

string CmdLineOptions::getThemeName (  )  const

Returns:
colour theme name

Referenced by HLCmdLineApp::run().

highlight::WrapMode CmdLineOptions::getWrappingStyle (  )  const

Returns:
Wrapping style

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::hasBaseFont (  )  const

Returns:
True if a base font has been given

bool CmdLineOptions::hasBaseFontSize (  )  const

Returns:
True if a base font size has been given

int CmdLineOptions::helpLanguage (  )  const

gibt true zurck, falls deutsche Hilfe ausgegeben werden soll

bool CmdLineOptions::includeCharStyles (  )  const

Returns:
True if RTF output should include character styles

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::includeStyleDef (  )  const

Returns:
True if Style definition should be included in output

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::inlineCSS (  )  const

Returns:
True if CSS should be outputted within tag elements

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::omitEncoding (  )  const

Returns:
True if encoding specification should be omitted in output

References StringTools::change_case().

bool CmdLineOptions::orderedList (  )  const

Returns:
True if line numbers should be replaced by ordered list (HTML)

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::outDirGiven (  )  const

Returns:
True if loutput directory is given

bool CmdLineOptions::prettySymbols (  )  const

Returns:
True if LaTeX output should includ fancier symbols

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printConfigInfo (  )  const

Returns:
True if configuration information should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printDebugInfo (  )  const

Returns:
True if debug information should be printed

Referenced by CmdLineOptions(), and HLCmdLineApp::run().

bool CmdLineOptions::printHelp (  )  const

Returns:
True if help information should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printIndexFile (  )  const

Returns:
True if index file should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printLineNumbers (  )  const

Returns:
True if line numbers should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printOnlyStyle (  )  const

Returns:
True if style should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printProgress (  )  const

Returns:
True if progress bar should be printed in batch mode

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::printVersion (  )  const

Returns:
True if version information should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::quietMode (  )  const

Returns:
True if quiet mode is active

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::replaceQuotes (  )  const

Returns:
True if quotes should be replaced by /dq in LaTeX

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::showLangdefs (  )  const

Returns:
True if list of installed language definitions should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::showThemes (  )  const

Returns:
True if list of installed themes should be printed

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::styleOutPathDefined (  )  const [inline]

Returns:
True if style output path was defined by user

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::syntaxGiven (  )  const

Returns:
True if language syntax is given

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::useCRDelimiter (  )  const

Returns:
True if CR is eol delimiter

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::useFNamesAsAnchors (  )  const

Returns:
True if input file name should be used as anchor name

Referenced by HLCmdLineApp::run().

bool CmdLineOptions::validateInput (  )  const

Returns:
True if input should be validated

Referenced by HLCmdLineApp::run().


The documentation for this class was generated from the following files:

Generated on Tue Oct 26 19:44:48 2010 for Highlight Code Converter by  doxygen 1.5.7.1