geany  1.38
About: Geany is a text editor (using GTK2) with basic features of an integrated development environment (syntax highlighting, code folding, symbol name auto-completion, ...). F: office T: editor programming GTK+ IDE
  Fossies Dox: geany-1.38.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

tm_tag.h File Reference
#include "tm_source_file.h"
#include "tm_parser.h"
#include <glib-object.h>
Include dependency graph for tm_tag.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  TMTag
 The TMTag structure represents a single tag in the tag manager. More...
 

Macros

#define TM_TAG(tag)   ((TMTag *) tag)
 Use the TM_TAG() macro to cast a pointer to (TMTag *) More...
 
#define TAG_ACCESS_PUBLIC   'p'
 Tag access type for C++/Java member functions and variables. More...
 
#define TAG_ACCESS_PROTECTED   'r'
 Protected member. More...
 
#define TAG_ACCESS_PRIVATE   'v'
 Private member. More...
 
#define TAG_ACCESS_FRIEND   'f'
 Friend members/functions. More...
 
#define TAG_ACCESS_DEFAULT   'd'
 Default access (Java) More...
 
#define TAG_ACCESS_UNKNOWN   'x'
 Unknown access type. More...
 
#define TAG_IMPL_VIRTUAL   'v'
 Tag implementation type for functions. More...
 
#define TAG_IMPL_UNKNOWN   'x'
 Unknown implementation. More...
 
#define TM_TYPE_TAG   (tm_tag_get_type())
 

Typedefs

typedef struct TMTag TMTag
 The TMTag structure represents a single tag in the tag manager. More...
 

Enumerations

enum  TMTagAttrType {
  tm_tag_attr_none_t = 0 , tm_tag_attr_name_t = 1 , tm_tag_attr_type_t = 2 , tm_tag_attr_file_t = 4 ,
  tm_tag_attr_line_t = 8 , tm_tag_attr_pos_t = 16 , tm_tag_attr_scope_t = 32 , tm_tag_attr_inheritance_t = 64 ,
  tm_tag_attr_arglist_t = 128 , tm_tag_attr_local_t = 256 , tm_tag_attr_time_t = 512 , tm_tag_attr_vartype_t = 1024 ,
  tm_tag_attr_access_t = 2048 , tm_tag_attr_impl_t = 4096 , tm_tag_attr_lang_t = 8192 , tm_tag_attr_inactive_t = 16384 ,
  tm_tag_attr_pointer_t = 32768 , tm_tag_attr_max_t = 65535
}
 Tag Attributes. More...
 

Functions

GType tm_tag_get_type (void) G_GNUC_CONST
 Gets the GType for a TMTag. More...
 

Macro Definition Documentation

◆ TAG_ACCESS_DEFAULT

#define TAG_ACCESS_DEFAULT   'd'

Default access (Java)

Definition at line 77 of file tm_tag.h.

◆ TAG_ACCESS_FRIEND

#define TAG_ACCESS_FRIEND   'f'

Friend members/functions.

Definition at line 76 of file tm_tag.h.

◆ TAG_ACCESS_PRIVATE

#define TAG_ACCESS_PRIVATE   'v'

Private member.

Definition at line 75 of file tm_tag.h.

◆ TAG_ACCESS_PROTECTED

#define TAG_ACCESS_PROTECTED   'r'

Protected member.

Definition at line 74 of file tm_tag.h.

◆ TAG_ACCESS_PUBLIC

#define TAG_ACCESS_PUBLIC   'p'

Tag access type for C++/Java member functions and variables.

Public member

Definition at line 73 of file tm_tag.h.

◆ TAG_ACCESS_UNKNOWN

#define TAG_ACCESS_UNKNOWN   'x'

Unknown access type.

Definition at line 78 of file tm_tag.h.

◆ TAG_IMPL_UNKNOWN

#define TAG_IMPL_UNKNOWN   'x'

Unknown implementation.

Definition at line 82 of file tm_tag.h.

◆ TAG_IMPL_VIRTUAL

#define TAG_IMPL_VIRTUAL   'v'

Tag implementation type for functions.

Virtual implementation

Definition at line 81 of file tm_tag.h.

◆ TM_TAG

#define TM_TAG (   tag)    ((TMTag *) tag)

Use the TM_TAG() macro to cast a pointer to (TMTag *)

Definition at line 40 of file tm_tag.h.

◆ TM_TYPE_TAG

#define TM_TYPE_TAG   (tm_tag_get_type())

Definition at line 108 of file tm_tag.h.

Typedef Documentation

◆ TMTag

typedef struct TMTag TMTag

The TMTag structure represents a single tag in the tag manager.

Enumeration Type Documentation

◆ TMTagAttrType

Tag Attributes.

Note that some attributes are available to file pseudotags only. Attributes are useful for specifying as arguments to the builtin sort and dedup functions, and during printing or writing to file, since these functions can operate on the given set of attributes only. Tag attributes are bitmasks and can be 'OR'-ed bitwise to represent any combination (line TMTagType).

Enumerator
tm_tag_attr_none_t 

Undefined.

tm_tag_attr_name_t 

Tag Name.

tm_tag_attr_type_t 

Tag Type.

tm_tag_attr_file_t 

File in which tag exists.

tm_tag_attr_line_t 

Line number of tag.

tm_tag_attr_pos_t 

Byte position of tag in the file (Obsolete)

tm_tag_attr_scope_t 

Scope of the tag.

tm_tag_attr_inheritance_t 

Parent classes.

tm_tag_attr_arglist_t 

Argument list.

tm_tag_attr_local_t 

If it has local scope.

tm_tag_attr_time_t 

Modification time (File tag only)

tm_tag_attr_vartype_t 

Variable Type.

tm_tag_attr_access_t 

Access type (public/protected/private)

tm_tag_attr_impl_t 

Implementation (e.g.

virtual)

tm_tag_attr_lang_t 

Language (File tag only)

tm_tag_attr_inactive_t 

Inactive file (File tag only, obsolete)

tm_tag_attr_pointer_t 

Pointer type.

tm_tag_attr_max_t 

Maximum value.

Definition at line 50 of file tm_tag.h.

Function Documentation

◆ tm_tag_get_type()

GType tm_tag_get_type ( void  )

Gets the GType for a TMTag.

Returns
TMTag type
Since
1.32 (API 233)

Definition at line 91 of file tm_tag.c.

References tm_tag_ref(), and tm_tag_unref().