tagmanager/src/tm_tag.h

   1 /*
   2 *
   3 *   Copyright (c) 2001-2002, Biswapesh Chattopadhyay
   4 *
   5 *   This source code is released for free distribution under the terms of the
   6 *   GNU General Public License.
   7 *
   8 */
   9
  10 #ifndef TM_TAG_H
  11 #define TM_TAG_H
  12
  13 /* @file
  14  The TMTag structure and the associated functions are used to manipulate
  15  tags and arrays of tags. Normally, you should not create tags individually
  16  but through an external interface such as tm_source_file_parse(), which generates
  17  an array of tags for the given source file. Once the tag list is generated,
  18  you can do various operations such as:
  19         -# Extract relevant tags using tm_tags_extract()
  20         -# Sort an array of tags using tm_tags_sort()
  21         -# Deduplicate an array of tags using tm_tags_dedup().
  22
  23  An important thing to remember here is that the tags operations such as extraction,
  24  sorting and deduplication do not change the tag itself in any way, but rather,
  25  manipulate pointers to the tags structure. The tags themselves are owned by the
  26  TMSourceFile structure which created them during parsing. So, be careful, for example,
  27  while deduping the tags array of a source file directly, since this might lead to
  28  'dangling' tags whose pointers have been removed from the array. If you need to
  29  deduplicate, create a copy of the tag pointer array using tm_tags_extract().
  30 */
  31
  32 #include "tm_source_file.h"
  33 #include <glib-object.h>
  34
  35 #ifdef __cplusplus
  36 extern "C"
  37 {
  38 #endif
  39
  40 /** Use the TM_TAG() macro to cast a pointer to (TMTag *) */
  41 #define TM_TAG(tag) ((TMTag *) tag)
  42
  43 /**
  44  Types of tags. It is a bitmask so that multiple tag types can
  45  be used simultaneously by 'OR'-ing them bitwise.
  46  e.g. tm_tag_class_t | tm_tag_struct_t
  47 */
  48 typedef enum
  49 {
  50         tm_tag_undef_t = 0, /**< Unknown type */
  51         tm_tag_class_t = 1, /**< Class declaration */
  52         tm_tag_enum_t = 2, /**< Enum declaration */
  53         tm_tag_enumerator_t = 4, /**< Enumerator value */
  54         tm_tag_field_t = 8, /**< Field (Java only) */
  55         tm_tag_function_t = 16, /**< Function definition */
  56         tm_tag_interface_t = 32, /**< Interface (Java only) */
  57         tm_tag_member_t = 64, /**< Member variable of class/struct */
  58         tm_tag_method_t = 128, /**< Class method (Java only) */
  59         tm_tag_namespace_t = 256, /**< Namespace declaration */
  60         tm_tag_package_t = 512, /**< Package (Java only) */
  61         tm_tag_prototype_t = 1024, /**< Function prototype */
  62         tm_tag_struct_t = 2048, /**< Struct declaration */
  63         tm_tag_typedef_t = 4096, /**< Typedef */
  64         tm_tag_union_t = 8192, /**< Union */
  65         tm_tag_variable_t = 16384, /**< Variable */
  66         tm_tag_externvar_t = 32768, /**< Extern or forward declaration */
  67         tm_tag_macro_t = 65536, /**<  Macro (without arguments) */
  68         tm_tag_macro_with_arg_t = 131072, /**< Parameterized macro */
  69         tm_tag_file_t = 262144, /**< File (Pseudo tag) - obsolete */
  70         tm_tag_other_t = 524288, /**< Other (non C/C++/Java tag) */
  71         tm_tag_max_t = 1048575 /**< Maximum value of TMTagType */
  72 } TMTagType;
  73
  74 /**
  75  Tag Attributes. Note that some attributes are available to file
  76  pseudotags only. Attributes are useful for specifying as arguments
  77  to the builtin sort and dedup functions, and during printing or writing
  78  to file, since these functions can operate on the given set of attributes
  79  only. Tag attributes are bitmasks and can be 'OR'-ed bitwise to represent
  80  any combination (line TMTagType).
  81 */
  82 typedef enum
  83 {
  84         tm_tag_attr_none_t = 0, /**< Undefined */
  85         tm_tag_attr_name_t = 1, /**< Tag Name */
  86         tm_tag_attr_type_t = 2, /**< Tag Type */
  87         tm_tag_attr_file_t = 4, /**< File in which tag exists */
  88         tm_tag_attr_line_t = 8, /**< Line number of tag */
  89         tm_tag_attr_pos_t = 16, /**< Byte position of tag in the file (Obsolete) */
  90         tm_tag_attr_scope_t = 32, /**< Scope of the tag */
  91         tm_tag_attr_inheritance_t = 64, /**< Parent classes */
  92         tm_tag_attr_arglist_t = 128, /**< Argument list */
  93         tm_tag_attr_local_t = 256, /**< If it has local scope */
  94         tm_tag_attr_time_t = 512, /**< Modification time (File tag only) */
  95         tm_tag_attr_vartype_t = 1024, /**< Variable Type */
  96         tm_tag_attr_access_t = 2048, /**< Access type (public/protected/private) */
  97         tm_tag_attr_impl_t = 4096, /**< Implementation (e.g. virtual) */
  98         tm_tag_attr_lang_t = 8192, /**< Language (File tag only) */
  99         tm_tag_attr_inactive_t = 16384, /**< Inactive file (File tag only, obsolete) */
 100         tm_tag_attr_pointer_t = 32768, /**< Pointer type */
 101         tm_tag_attr_max_t = 65535 /**< Maximum value */
 102 } TMTagAttrType;
 103
 104 /** Tag access type for C++/Java member functions and variables */
 105 #define TAG_ACCESS_PUBLIC 'p' /**< Public member */
 106 #define TAG_ACCESS_PROTECTED 'r' /**< Protected member */
 107 #define TAG_ACCESS_PRIVATE 'v' /**< Private member */
 108 #define TAG_ACCESS_FRIEND 'f' /**< Friend members/functions */
 109 #define TAG_ACCESS_DEFAULT 'd' /**< Default access (Java) */
 110 #define TAG_ACCESS_UNKNOWN 'x' /**< Unknown access type */
 111
 112 /** Tag implementation type for functions */
 113 #define TAG_IMPL_VIRTUAL 'v' /**< Virtual implementation */
 114 #define TAG_IMPL_UNKNOWN 'x' /**< Unknown implementation */
 115
 116 /**
 117  This structure holds all information about a tag, including the file
 118  pseudo tag. It should always be created indirectly with one of the tag
 119  creation functions such as tm_source_file_parse() or tm_tag_new_from_file().
 120  Once created, they can be sorted, deduped, etc. using functions such as
 121  tm_tags_sort() or tm_tags_dedup()
 122 */
 123 typedef struct _TMTag
 124 {
 125         char *name; /**< Name of tag */
 126         TMTagType type; /**< Tag Type */
 127         gint refcount; /* the reference count of the tag */
 128
 129         /** These are tag attributes */
 130         TMSourceFile *file; /**< File in which the tag occurs; NULL for global tags */
 131         gulong line; /**< Line number of the tag */
 132         gboolean local; /**< Is the tag of local scope */
 133         guint pointerOrder;
 134         char *arglist; /**< Argument list (functions/prototypes/macros) */
 135         char *scope; /**< Scope of tag */
 136         char *inheritance; /**< Parent classes */
 137         char *var_type; /**< Variable type (maps to struct for typedefs) */
 138         char access; /**< Access type (public/protected/private/etc.) */
 139         char impl; /**< Implementation (e.g. virtual) */
 140         TMParserType lang; /* Programming language of the file */
 141 } TMTag;
 142
 143
 144 #ifdef GEANY_PRIVATE
 145
 146 extern const TMTagType TM_GLOBAL_TYPE_MASK;
 147
 148
 149 typedef enum {
 150         TM_FILE_FORMAT_TAGMANAGER,
 151         TM_FILE_FORMAT_PIPE,
 152         TM_FILE_FORMAT_CTAGS
 153 } TMFileFormat;
 154
 155
 156 /* The GType for a TMTag */
 157 #define TM_TYPE_TAG (tm_tag_get_type())
 158
 159 GType tm_tag_get_type(void) G_GNUC_CONST;
 160
 161 TMTag *tm_tag_new(TMSourceFile *file, const tagEntryInfo *tag_entry);
 162
 163 TMTag *tm_tag_new_from_file(TMSourceFile *file, FILE *fp, TMParserType mode, TMFileFormat format);
 164
 165 gboolean tm_tag_write(TMTag *tag, FILE *file, guint attrs);
 166
 167 void tm_tags_remove_file_tags(TMSourceFile *source_file, GPtrArray *tags_array);
 168
 169 GPtrArray *tm_tags_merge(GPtrArray *big_array, GPtrArray *small_array,
 170         TMTagAttrType *sort_attributes, gboolean unref_duplicates);
 171
 172 gboolean tm_tags_sort(GPtrArray *tags_array, TMTagAttrType *sort_attributes,
 173         gboolean dedup, gboolean unref_duplicates);
 174
 175 GPtrArray *tm_tags_extract(GPtrArray *tags_array, guint tag_types);
 176
 177 gboolean tm_tags_prune(GPtrArray *tags_array);
 178
 179 gboolean tm_tags_dedup(GPtrArray *tags_array, TMTagAttrType *sort_attributes, gboolean unref_duplicates);
 180
 181 TMTag **tm_tags_find(const GPtrArray *tags_array, const char *name,
 182                 gboolean partial, guint * tagCount);
 183
 184 void tm_tags_array_free(GPtrArray *tags_array, gboolean free_all);
 185
 186 const TMTag *tm_get_current_tag(GPtrArray *file_tags, const gulong line, const TMTagType tag_types);
 187
 188 void tm_tag_unref(TMTag *tag);
 189
 190 TMTag *tm_tag_ref(TMTag *tag);
 191
 192 gboolean tm_tags_equal(const TMTag *a, const TMTag *b);
 193
 194 const gchar *tm_tag_context_separator(TMParserType lang);
 195
 196 gboolean tm_tag_is_anon(const TMTag *tag);
 197
 198 gboolean tm_tag_langs_compatible(TMParserType lang, TMParserType other);
 199
 200 #ifdef TM_DEBUG /* various debugging functions */
 201
 202 const char *tm_tag_type_name(const TMTag *tag);
 203
 204 TMTagType tm_tag_name_type(const char* tag_name);
 205
 206 void tm_tag_print(TMTag *tag, FILE *fp);
 207
 208 void tm_tags_array_print(GPtrArray *tags, FILE *fp);
 209
 210 gint tm_tag_scope_depth(const TMTag *t);
 211
 212 #endif /* TM_DEBUG */
 213
 214 #endif /* GEANY_PRIVATE */
 215
 216 #ifdef __cplusplus
 217 }
 218 #endif
 219
 220 #endif /* TM_TAG_H */