highlight::LanguageDefinition Class Reference

Contains specific data of the programming language being processed. More...

List of all members.

Public Member Functions

string & getSymbolString ()
unsigned char getRawStringPrefix ()
unsigned char getContinuationChar ()
bool getSyntaxHighlight ()
bool isIgnoreCase ()
int isKeyword (const string &s)
bool load (const string &langDefPath, bool clear=true)
bool isVHDL ()
bool allowNestedMLComments ()
bool highlightingDisabled ()
bool needsReload (const string &langDefPath)
bool enableReformatting ()
bool allowExtEscSeq ()
unsigned int getDelimPrefixClassID (const string &prefix)
const KeywordMapgetKeywords () const
const vector< string > & getKeywordClasses () const
vector< RegexElement * > & getRegexElements ()


Detailed Description

Contains specific data of the programming language being processed.

The load() method will only read a new language definition if the given file path is not equal to the path of the current language definition.

Author:
Andre Simon


Member Function Documentation

string & highlight::LanguageDefinition::getSymbolString (  ) 

Returns:
Symbol string, containg all known symbols with the referencing state ids

unsigned char highlight::LanguageDefinition::getRawStringPrefix (  ) 

Returns:
Prefix of raw strings

unsigned char highlight::LanguageDefinition::getContinuationChar (  ) 

Returns:
Continuation Character

bool highlight::LanguageDefinition::getSyntaxHighlight (  ) 

Returns:
true if syntax highlighting is enabled

bool highlight::LanguageDefinition::isIgnoreCase (  ) 

Returns:
True if language is case sensitive

int highlight::LanguageDefinition::isKeyword ( const string &  s  ) 

Parameters:
s String
Returns:
class id of keyword, 0 if s is not a keyword

bool highlight::LanguageDefinition::load ( const string &  langDefPath,
bool  clear = true 
)

Load new language definition

Parameters:
langDefPath Path of language definition
clear Test if former data should be deleted
Returns:
True if successfull

bool highlight::LanguageDefinition::isVHDL (  ) 

Returns:
True if programming language is VHDL

bool highlight::LanguageDefinition::allowNestedMLComments (  ) 

Returns:
True if multi line comments may be nested

bool highlight::LanguageDefinition::highlightingDisabled (  ) 

Returns:
True if highlighting is disabled

bool highlight::LanguageDefinition::needsReload ( const string &  langDefPath  ) 

Returns:
True the next load() call will load a new language definition
Parameters:
langDefPath Path to language definition

bool highlight::LanguageDefinition::enableReformatting (  ) 

Returns:
True if current language may be reformatted (c, c++, c#, java)

bool highlight::LanguageDefinition::allowExtEscSeq (  ) 

Returns:
True if escape sequences are allowed outsde of strings

unsigned int highlight::LanguageDefinition::getDelimPrefixClassID ( const string &  prefix  ) 

Returns:
Class ID of given keyword delimiter prefix
Parameters:
prefix Keyword delimiter prefix

const KeywordMap & highlight::LanguageDefinition::getKeywords (  )  const

Returns:
keywords

const vector< string > & highlight::LanguageDefinition::getKeywordClasses (  )  const

Returns:
keyword classes

vector<RegexElement*>& highlight::LanguageDefinition::getRegexElements (  )  [inline]

Returns:
regular expressions


The documentation for this class was generated from the following files:
Generated on Fri Apr 27 13:12:36 2007 for Highlight Code Converter by  doxygen 1.5.2