#include <codemodel.h>

Public Types | |
enum | Kind { File, Namespace, Class, Function, Variable, Argument, FunctionDefinition, Enum, Enumerator, TypeAlias, Custom = 1000 } |
enum | Access { Public, Protected, Private } |
typedef ItemDom | Ptr |
Public Member Functions | |
void | update (const CodeModelItem *i) |
bool | canUpdate (const CodeModelItem *i) const |
virtual | ~CodeModelItem () |
int | kind () const |
void | setKind (int kind) |
TQString | name () const |
TQString | comment () const |
void | setComment (TQString comment) |
void | setName (const TQString &name) |
FileDom | file () |
const FileDom | file () const |
TQString | fileName () const |
void | setFileName (const TQString &fileName) |
void | getStartPosition (int *line, int *col) const |
void | setStartPosition (int line, int col) |
void | getEndPosition (int *line, int *col) const |
void | setEndPosition (int line, int col) |
virtual bool | isFile () const |
virtual bool | isNamespace () const |
virtual bool | isClass () const |
virtual bool | isFunction () const |
virtual bool | isFunctionDefinition () const |
virtual bool | isVariable () const |
virtual bool | isArgument () const |
virtual bool | isEnum () const |
virtual bool | isEnumerator () const |
virtual bool | isTypeAlias () const |
virtual bool | isCustom () const |
virtual bool | isTemplateable () const |
virtual void | read (TQDataStream &stream) |
virtual void | write (TQDataStream &stream) const |
virtual void | dump (std::ostream &file, bool recurse=false, TQString Info="") |
CodeModel * | codeModel () |
const CodeModel * | codeModel () const |
Protected Member Functions | |
CodeModelItem (int kind, CodeModel *model) | |
Detailed Description
Item in code model (symbol store).
Item is a symbol in a store. Code model provides several predefined classes for predefined item types (files, namespaces, classes, functions and function definitions, variables, arguments, enums and enumerators, type aliases.
Instances of this class should be created using CodeModel::create method but usually it is better to create instances of derived classes like ClassModel, NamespaceModel, FileModel, etc.
Definition at line 461 of file codemodel.h.
Member Typedef Documentation
◆ Ptr
typedef ItemDom CodeModelItem::Ptr |
A definition of safe pointer to the code model item.
Definition at line 465 of file codemodel.h.
Member Enumeration Documentation
◆ Access
An access to the code model item.
Enumerator | |
---|---|
Public | Public. |
Protected | Protected. |
Private | Private. |
Definition at line 486 of file codemodel.h.
◆ Kind
enum CodeModelItem::Kind |
A type of a code model item.
Definition at line 468 of file codemodel.h.
Constructor & Destructor Documentation
◆ CodeModelItem()
|
protected |
Constructor.
- Parameters
-
kind The type, see also CodeModelItem::Kind. model Code model which stores this item.
Definition at line 581 of file codemodel.cpp.
◆ ~CodeModelItem()
|
virtual |
Destructor.
Definition at line 591 of file codemodel.cpp.
Member Function Documentation
◆ codeModel() [1/2]
|
inline |
- Returns
- The code model for this item.
Definition at line 598 of file codemodel.h.
◆ codeModel() [2/2]
|
inline |
- Note
- This is a const version provided for convenience.
- Returns
- The code model for this item
Definition at line 602 of file codemodel.h.
◆ dump()
|
virtual |
just to get rid of the warning
Reimplemented in TypeAliasModel, EnumeratorModel, EnumModel, VariableModel, and ArgumentModel.
Definition at line 165 of file codemodel.cpp.
◆ file() [1/2]
FileDom CodeModelItem::file | ( | ) |
Gets the file of the item.
- Returns
- The FileDom object for the item.
Definition at line 610 of file codemodel.cpp.
◆ file() [2/2]
const FileDom CodeModelItem::file | ( | ) | const |
Gets the file of the item This is a const version provided for convenience.
- Returns
- The FileDom object for the item.
Definition at line 605 of file codemodel.cpp.
◆ fileName()
TQString CodeModelItem::fileName | ( | ) | const |
- Returns
- The filename of the item.
Definition at line 615 of file codemodel.cpp.
◆ getEndPosition()
void CodeModelItem::getEndPosition | ( | int * | line, |
int * | col | ||
) | const |
Get the end position of the item.
- Parameters
-
line Will be set to the line number of the items end position. Pass 0 if line number is not necessary. col Will be set to the column number of the items end position. Pass 0 if column number is not necessary.
Definition at line 637 of file codemodel.cpp.
◆ getStartPosition()
void CodeModelItem::getStartPosition | ( | int * | line, |
int * | col | ||
) | const |
Gets the start position of the item.
- Parameters
-
line Will be set to the line number of the items start position. Pass 0 if line number is not necessary. col Will be set to the column number of the items start position. Pass 0 if column number is not necessary.
Definition at line 625 of file codemodel.cpp.
◆ isArgument()
|
inlinevirtual |
- Returns
- true if an item is an ArgumentModel.
Reimplemented in ArgumentModel.
Definition at line 576 of file codemodel.h.
◆ isClass()
|
inlinevirtual |
- Returns
- true if an item is a ClassModel.
Reimplemented in NamespaceModel, and ClassModel.
Definition at line 568 of file codemodel.h.
◆ isCustom()
|
inlinevirtual |
- Returns
- true if an item is a custom item.
Definition at line 584 of file codemodel.h.
◆ isEnum()
|
inlinevirtual |
- Returns
- true if an item is a EnumModel.
Reimplemented in EnumModel.
Definition at line 578 of file codemodel.h.
◆ isEnumerator()
|
inlinevirtual |
- Returns
- true if an item is a EnumeratorModel.
Reimplemented in EnumeratorModel.
Definition at line 580 of file codemodel.h.
◆ isFile()
|
inlinevirtual |
- Returns
- true if an item is a FileModel.
Reimplemented in FileModel.
Definition at line 564 of file codemodel.h.
◆ isFunction()
|
inlinevirtual |
- Returns
- true if an item is a FunctionModel.
Reimplemented in FunctionModel.
Definition at line 570 of file codemodel.h.
◆ isFunctionDefinition()
|
inlinevirtual |
- Returns
- true if an item is a FileDefinitionModel.
Reimplemented in FunctionDefinitionModel.
Definition at line 572 of file codemodel.h.
◆ isNamespace()
|
inlinevirtual |
- Returns
- true if an item is a NamespaceModel.
Reimplemented in NamespaceModel.
Definition at line 566 of file codemodel.h.
◆ isTypeAlias()
|
inlinevirtual |
- Returns
- true if an item is a TypeAliasModel.
Reimplemented in TypeAliasModel.
Definition at line 582 of file codemodel.h.
◆ isVariable()
|
inlinevirtual |
- Returns
- true if an item is a VariableModel.
Reimplemented in VariableModel.
Definition at line 574 of file codemodel.h.
◆ kind()
|
inline |
- Returns
- The type (kind) of item.
Definition at line 506 of file codemodel.h.
◆ name()
TQString CodeModelItem::name | ( | ) | const |
- Returns
- The name of the item.
Definition at line 595 of file codemodel.cpp.
◆ read()
|
virtual |
Reads an item from the stream.
- Parameters
-
stream The stream to read from.
Reimplemented in TypeAliasModel, EnumeratorModel, EnumModel, VariableModel, FunctionModel, ArgumentModel, FileModel, NamespaceModel, and ClassModel.
Definition at line 1285 of file codemodel.cpp.
◆ setEndPosition()
void CodeModelItem::setEndPosition | ( | int | line, |
int | col | ||
) |
Set the end position of the item.
- Parameters
-
line Line number. col Column number.
Definition at line 643 of file codemodel.cpp.
◆ setFileName()
void CodeModelItem::setFileName | ( | const TQString & | fileName | ) |
Sets the filename of the item.
- Parameters
-
fileName The file name.
Definition at line 620 of file codemodel.cpp.
◆ setKind()
|
inline |
Sets the type (kind) of item.
- Parameters
-
kind The type, see also CodeModelItem::Kind.
Definition at line 510 of file codemodel.h.
◆ setName()
void CodeModelItem::setName | ( | const TQString & | name | ) |
◆ setStartPosition()
void CodeModelItem::setStartPosition | ( | int | line, |
int | col | ||
) |
Sets the start position of the item.
- Parameters
-
line Line number. col Column number.
Definition at line 631 of file codemodel.cpp.
◆ write()
|
virtual |
Writes an item to the stream.
- Parameters
-
stream The stream to write to.
Reimplemented in TypeAliasModel, EnumeratorModel, EnumModel, VariableModel, FunctionModel, ArgumentModel, FileModel, NamespaceModel, and ClassModel.
Definition at line 1304 of file codemodel.cpp.
The documentation for this class was generated from the following files: