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:

[legend]

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
tagFile *	ctags_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_name	the name of the ctags file
	pos	where the reference should be generated

Exceptions:

IOException

if 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:

	word	the word to collect tag information about
	infos	where to store the information
	fileInfo	information 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:

• ctagscollector.h
• ctagscollector.cpp