Source-highlight Library
ctagscollector.h
1//
2// Author: Lorenzo Bettini <http://www.lorenzobettini.it>, (C) 2004-2009
3//
4// Copyright: See COPYING file that comes with this distribution
5//
6
7#ifndef CTAGSCOLLECTOR_H_
8#define CTAGSCOLLECTOR_H_
9
10#include <string>
11#include <list>
12
13#include "refposition.h"
14#include "readtags.h"
15
16namespace srchilite {
17
18struct FormatterParams;
19
24struct CTagsInfo {
26 std::string fileName;
27
29 std::string lineNumber;
30
33
36
45 CTagsInfo(const std::string &_fileName, const std::string &_lineNumber,
46 RefPosition _refposition, bool _isAnchor) :
47 fileName(_fileName), lineNumber(_lineNumber),
48 refposition(_refposition), isAnchor(_isAnchor) {
49
50 }
51};
52
56typedef std::list<CTagsInfo> CTagsInfos;
57
65
68
71
72public:
78 CTagsCollector(const std::string &ctags_file_name, RefPosition pos);
80
89 bool collectTags(const std::string &word, CTagsInfos &infos,
90 const FormatterParams *fileInfo);
91
96 refposition = r;
97 }
98};
99
100}
101
102#endif /*CTAGSCOLLECTOR_H_*/
Collects the tags information generated by the ctags program for a given word.
Definition: ctagscollector.h:62
void setRefPosition(RefPosition r)
where references should be positioned
Definition: ctagscollector.h:95
tagFileInfo info
information about the ctags being examined (not really used)
Definition: ctagscollector.h:70
tagFile * ctags_file
the ctags file
Definition: ctagscollector.h:67
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.
Definition: ctagscollector.cpp:42
RefPosition refposition
where references should be positioned
Definition: ctagscollector.h:64
CTagsCollector(const std::string &ctags_file_name, RefPosition pos)
Definition: ctagscollector.cpp:28
C++ class: doctemplate.h.
Definition: bufferedoutput.cpp:13
std::list< CTagsInfo > CTagsInfos
The collection of information about a tag.
Definition: ctagscollector.h:56
RefPosition
where a reference must be put
Definition: refposition.h:7
Definition: readtags.c:42
Information about a tag.
Definition: ctagscollector.h:24
std::string lineNumber
the line number
Definition: ctagscollector.h:29
std::string fileName
the filename of a tag
Definition: ctagscollector.h:26
CTagsInfo(const std::string &_fileName, const std::string &_lineNumber, RefPosition _refposition, bool _isAnchor)
Definition: ctagscollector.h:45
RefPosition refposition
where the reference should be positioned (only valid if !isAnchor)
Definition: ctagscollector.h:32
bool isAnchor
whether the information concerns an anchor and not a reference
Definition: ctagscollector.h:35
Additional parameters that can be passed to a formatter.
Definition: formatterparams.h:18
Definition: readtags.h:55