Source-highlight Library
srchilite::CTagsFormatter Class Reference

Formatter for information gathered from ctags. More...

#include <ctagsformatter.h>

Collaboration diagram for srchilite::CTagsFormatter:

Public Member Functions

 CTagsFormatter (PreFormatter *pre, const TextStyles::RefTextStyle &r, CTagsCollector *ctagsC)
 
void setPreFormatter (PreFormatter *pre)
 
void setFileInfo (const std::string &input, const std::string &output)
 Sets the information about input file and output file. More...
 
bool formatCTags (const std::string &word, CTagsFormatterResults &result, const FormatterParams *params)
 Formats an anchor or references concerning the passed word. More...
 

Private Attributes

std::string inputFile
 the input file name
 
std::string inputFileName
 the input file name (without path)
 
std::string outputFile
 the output file name
 
std::string outputFileExtension
 the output file name extension
 
PreFormatterpreFormatter
 the preformatter
 
TextStyles::RefTextStyle refstyle
 for actually formatting anchors and references
 
CTagsCollectorctagsCollector
 collect information about the tags
 

Detailed Description

Formatter for information gathered from ctags.

Member Function Documentation

bool srchilite::CTagsFormatter::formatCTags ( const std::string &  word,
CTagsFormatterResults result,
const FormatterParams params 
)

Formats an anchor or references concerning the passed word.

Parameters
word
resultwhere formatting results will be stored
paramsadditional parameters for the formatter
Returns
true if some ctags about the word were found and formatted
void srchilite::CTagsFormatter::setFileInfo ( const std::string &  input,
const std::string &  output 
)

Sets the information about input file and output file.

Parameters
inputinput file (with path)
outputoutput file (with path)

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