Source-highlight Library
srchilite::CTagsCollector Class Reference

Collects the tags information generated by the ctags program for a given word. More...

#include <ctagscollector.h>

Collaboration diagram for srchilite::CTagsCollector:

List of all members.

Public Member Functions

 CTagsCollector (const std::string &ctags_file_name, RefPosition pos)
bool collectTags (const std::string &word, CTagsInfos &infos, const FormatterParams *fileInfo)
 Collects the tag information about the specified word and stores them into the passed collection.
void setRefPosition (RefPosition r)
 where references should be positioned

Private Attributes

RefPosition refposition
 where references should be positioned
tagFilectags_file
 the ctags file
tagFileInfo info
 information about the ctags being examined (not really used)

Detailed Description

Collects the tags information generated by the ctags program for a given word.


Constructor & Destructor Documentation

srchilite::CTagsCollector::CTagsCollector ( const std::string &  ctags_file_name,
RefPosition  pos 
)
Parameters:
ctags_file_namethe name of the ctags file
poswhere the reference should be generated
Exceptions:
IOExceptionif the file cannot be opened

Member Function Documentation

bool srchilite::CTagsCollector::collectTags ( const std::string &  word,
CTagsInfos infos,
const FormatterParams fileInfo 
)

Collects the tag information about the specified word and stores them into the passed collection.

Parameters:
wordthe word to collect tag information about
infoswhere to store the information
fileInfoinformation about the word being processed
Returns:
false whether we did not find any information about the passed word

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