Source-highlight Library
srchilite::CTagsManager Class Reference

Takes care of running ctags and to generate a CTagsFormmatter. More...

#include <ctagsmanager.h>

Collaboration diagram for srchilite::CTagsManager:

Public Member Functions

 CTagsManager (const std::string &_ctagsFile, const std::string &_ctagsCmd, bool _runCTags, RefPosition _refPosition)
 
void runCTagsCmd ()
 Runs the ctags program. More...
 
CTagsFormattercreateCTagsFormatter (const TextStyles::RefTextStyle &r)
 Creates a CTagsFormatter (if required, it previously run the ctags command). More...
 

Private Attributes

std::string ctagsFile
 the ctags file name
 
std::string ctagsCmd
 the possible ctags command to execute
 
bool runCTags
 whether to run ctags command
 
RefPosition refPosition
 the position for generated references
 
CTagsCollectorctagsCollector
 the shared instance shared by all the created CTagsFormatters
 

Detailed Description

Takes care of running ctags and to generate a CTagsFormmatter.

Constructor & Destructor Documentation

srchilite::CTagsManager::CTagsManager ( const std::string &  _ctagsFile,
const std::string &  _ctagsCmd,
bool  _runCTags,
RefPosition  _refPosition 
)
Parameters
_ctagsFilethe ctags file name
_ctagsCmdthe ctags line command
_runCTagswhether to run the ctags command
_refPositionthe position for generated references

Member Function Documentation

CTagsFormatter * srchilite::CTagsManager::createCTagsFormatter ( const TextStyles::RefTextStyle r)

Creates a CTagsFormatter (if required, it previously run the ctags command).

Parameters
rthe style for references and anchors
Exceptions
IOExceptionif running the ctags command fails
void srchilite::CTagsManager::runCTagsCmd ( )

Runs the ctags program.

Exceptions
IOExceptionif the run fails

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