Logo Search packages:      
Sourcecode: highlight version File versions  Download package

highlight::HtmlGenerator Class Reference

#include <htmlgenerator.h>

Inheritance diagram for highlight::HtmlGenerator:

highlight::CodeGenerator highlight::XHtmlGenerator

List of all members.


Detailed Description

This class generates HTML.

It contains information about the resulting document structure (document header and footer), the colour system, white space handling and text formatting attributes.

Author:
Andre Simon

Definition at line 52 of file htmlgenerator.h.


Public Member Functions

void addMarkedLine (int lineNo, string &helpTxt)
bool formattingDisabled ()
bool formattingIsPossible ()
ParseError generateFile (const string &inFileName, const string &outFileName)
string generateString (const string &input)
string generateStringFromFile (const string &inFileName)
const string getBaseFont () const
const string & getBaseFontSize ()
bool getFragmentCode ()
const LanguageDefinitiongetLanguage ()
int getLineNumberWidth ()
bool getPrintLineNumbers ()
bool getPrintZeroes ()
const string & getStyleInputPath ()
const string & getStyleName ()
const string & getStyleOutputPath ()
string getTitle ()
bool getValidateInput ()
bool hasWhiteBGColour ()
bool initIndentationScheme (const string &indentScheme)
LoadResult initLanguage (const string &langDefPath)
bool initTagInformation (const string &ctagsPath)
bool initTheme (const string &themePath)
LoadResult loadLanguage (const string &langDefPath)
bool printExternalStyle (const string &outFile)
bool printIndexFile (const vector< string > &fileList, const string &outPath)
void setBaseFont (const string &s)
void setBaseFontSize (const string &s)
void setEncoding (const string &encodingName)
void setFragmentCode (bool flag)
void setHTMLAnchorPrefix (const string &prefix)
void setHTMLAttachAnchors (bool b)
void setHTMLClassName (const string &name)
void setHTMLEnclosePreTag (bool b)
void setHTMLInlineCSS (bool b)
void setHTMLOrderedList (bool b)
void setIncludeStyle (bool flag)
void setKeyWordCase (StringTools::KeywordCase keyCase)
virtual void setLATEXNoShorthands (bool)
virtual void setLATEXPrettySymbols (bool)
virtual void setLATEXReplaceQuotes (bool)
void setLineNumberWidth (int w)
void setMaxInputLineCnt (unsigned int cnt)
void setPreformatting (WrapMode lineWrappingStyle, unsigned int lineLength, int numberSpaces)
void setPrintLineNumbers (bool flag, unsigned int startCnt=1)
void setPrintZeroes (bool flag)
virtual void setRTFCharStyles (bool)
virtual void setRTFPageSize (const string &)
void setStyleInputPath (const string &path)
void setStyleOutputPath (const string &path)
virtual void setSVGSize (const string &, const string &)
void setTitle (const string &title)
void setValidateInput (bool flag)
bool styleFound ()
virtual ~HtmlGenerator ()

Static Public Member Functions

static void deleteInstance (CodeGenerator *inst)
static CodeGeneratorgetInstance (OutputType type)

Protected Member Functions

bool encodingDefined ()
void flushWs ()
string getGeneratorComment ()
virtual string getHeaderStart (const string &title)
unsigned int getLineIndex ()
unsigned int getLineNumber ()
State getState (const string &s, unsigned int searchPos)
string getStyleDefinition ()
unsigned int getStyleID (State s, unsigned int kwClassID=0)
void maskString (ostream &ss, const string &s)
void processRootState ()
string readUserStyleDef ()

Protected Attributes

string baseFont
string baseFontSize
string brTag
 break tag
string cssClassName
 css class name prefix
unsigned int currentKeywordClass
State currentState
DocumentStyle docStyle
string docTitle
bool enclosePreTag
string encoding
bool excludeWs
string fileSuffix
 filename extension
bool fragmentOutput
string hrTag
 horizontal ruler tag
string idAttr
 ID tag.
istream * in
bool includeStyleDef
string inFile
 input file name
LanguageDefinition langInfo
string line
unsigned int lineNumber
bool lineNumberFillZeroes
int lineNumberOffset
map< int, string > markLines
bool maskWs
string maskWsBegin
 open whitespace mask
string maskWsEnd
 close whitespace mask
CTagsReader metaInfo
string newLineTag
bool orderedList
ostream * out
string outFile
 output file name
PreFormatter preFormatter
bool showLineNumbers
string spacer
string styleCommentClose
 close comment delimiter
string styleCommentOpen
 open comment delimiter
string styleDefinitionCache
vector< string > styleTagClose
 list of format delimiters (close format descriptions)
vector< string > styleTagOpen
 list of format delimiters (open new format descriptions)
bool useInlineCSS
string wsBuffer

Static Protected Attributes

static const unsigned int NUMBER_BUILTIN_STATES = 10
 number of token states (without keyword group IDs)

Private Member Functions

string getAttributes (const string &elemName, const ElementStyle &elem)
string getFooter ()
string getHeader ()
string getMatchingCloseTag (unsigned int styleID)
string getMatchingOpenTag (unsigned int styleID)
string getMetaInfoCloseTag ()
string getMetaInfoOpenTag (const TagInfo &info)
string getNewLine ()
string getOpenTag (const ElementStyle &elem)
string getOpenTag (const string &styleName)
virtual void insertLineNumber (bool insertNewLine=true)
virtual string maskCharacter (unsigned char)
void printBody ()

Private Attributes

string anchorPrefix
bool attachAnchors

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

Generated by  Doxygen 1.6.0   Back to index