A description of a symbol as extracted by the cpptagdb.exe program. The description includes the type of the symbol, its full namespace name, its member name, the file and line where it is defined, and the kind of symbol it is: function, variable, namespace, etc. More...
#include <cpptagdb.h>
Public Types | |
typedef std::multimap < std::string, SymbolInfo > | Children |
typedef Children::const_iterator | const_iterator |
typedef Children::iterator | iterator |
enum | Type { Function, Variable, Class, Enum, Enumeration, Typedef, Namespace, FileScope, Used, Define, unknownType } |
Public Member Functions | |
std::string | annotatedName (bool member=false) const |
return the member name with annotations | |
Type | computeTypeId (std::string const &typeName) |
Update the typeId_ member appropriately based on the name of the symbol type identifier read from the .tagpp file. | |
void | output (std::ostream &s, std::string indent) const |
Output this SymbolInfo object to a stream and include all its children indented underneath it. A start indentation string should be provided. | |
SymbolInfo (std::string const &symbol, std::string const &member, std::string const &type, std::string const &file, int line) | |
SymbolInfo () | |
char | typeChar () const |
return a 1 character type id for this member | |
Public Attributes | |
Children | children_ |
nested direct submembers of this symbol, assuming it is a class, struct, union, or namespace | |
std::string | file_ |
name of the file defining the symbol | |
std::string | fullname_ |
full symbol name: namespace::class::member | |
int | line_ |
line within file_ where the symbol is defined | |
std::string | member_ |
member name only: member | |
std::string | type_ |
cpptagdb.exe supplied type string | |
Type | typeId_ |
integer "type" of the symbol | |
Friends | |
std::ostream & | operator<< (std::ostream &s, SymbolInfo const &me) |
ostreams. |
A description of a symbol as extracted by the cpptagdb.exe program. The description includes the type of the symbol, its full namespace name, its member name, the file and line where it is defined, and the kind of symbol it is: function, variable, namespace, etc.
Definition at line 42 of file cpptagdb.h.
typedef std::multimap<std::string, SymbolInfo> Children |
Definition at line 90 of file cpptagdb.h.
Definition at line 96 of file cpptagdb.h.
typedef Children::iterator iterator |
Definition at line 95 of file cpptagdb.h.
enum Type |
Function | |
Variable | |
Class | |
Enum | |
Enumeration | |
Typedef | |
Namespace | |
FileScope | |
Used | |
Define | |
unknownType |
Definition at line 48 of file cpptagdb.h.
SymbolInfo | ( | ) |
Definition at line 70 of file cpptagdb.h.
SymbolInfo | ( | std::string const & | symbol, | |
std::string const & | member, | |||
std::string const & | type, | |||
std::string const & | file, | |||
int | line | |||
) |
Definition at line 75 of file cpptagdb.h.
std::string annotatedName | ( | bool | member = false |
) | const |
return the member name with annotations
Definition at line 160 of file cpptagdb.cxx.
SymbolInfo::Type computeTypeId | ( | std::string const & | typeName | ) |
Update the typeId_ member appropriately based on the name of the symbol type identifier read from the .tagpp file.
Definition at line 74 of file cpptagdb.cxx.
void output | ( | std::ostream & | s, | |
std::string | indent | |||
) | const |
Output this SymbolInfo object to a stream and include all its children indented underneath it. A start indentation string should be provided.
Definition at line 44 of file cpptagdb.cxx.
char typeChar | ( | ) | const |
return a 1 character type id for this member
Definition at line 135 of file cpptagdb.cxx.
std::ostream& operator<< | ( | std::ostream & | s, | |
SymbolInfo const & | me | |||
) | [friend] |
ostreams.
s | The ostream stream on which data will be written | |
me | The SymbolInfo object to write to the stream. |
me | Global free functioon to print SymbolInfo objects to |
Definition at line 103 of file cpptagdb.h.
nested direct submembers of this symbol, assuming it is a class, struct, union, or namespace
Definition at line 92 of file cpptagdb.h.
std::string file_ |
name of the file defining the symbol
Definition at line 66 of file cpptagdb.h.
std::string fullname_ |
full symbol name: namespace::class::member
Definition at line 63 of file cpptagdb.h.
int line_ |
line within file_ where the symbol is defined
Definition at line 67 of file cpptagdb.h.
std::string member_ |
member name only: member
Definition at line 64 of file cpptagdb.h.
std::string type_ |
cpptagdb.exe supplied type string
Definition at line 65 of file cpptagdb.h.
integer "type" of the symbol
Definition at line 68 of file cpptagdb.h.