src/tagmanager/tm_parser.h

   1 /*
   2 *
   3 *   Copyright (c) 2014 The Geany contributors
   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_PARSER_H
  11 #define TM_PARSER_H
  12
  13 #include <glib.h>
  14
  15 G_BEGIN_DECLS
  16
  17 /**
  18  Types of tags. It is a bitmask so that multiple tag types can
  19  be used simultaneously by 'OR'-ing them bitwise.
  20  e.g. tm_tag_class_t | tm_tag_struct_t
  21 */
  22 typedef enum
  23 {
  24         tm_tag_undef_t = 0, /**< Unknown type */
  25         tm_tag_class_t = 1, /**< Class declaration */
  26         tm_tag_enum_t = 2, /**< Enum declaration */
  27         tm_tag_enumerator_t = 4, /**< Enumerator value */
  28         tm_tag_field_t = 8, /**< Field (Java only) */
  29         tm_tag_function_t = 16, /**< Function definition */
  30         tm_tag_interface_t = 32, /**< Interface (Java only) */
  31         tm_tag_member_t = 64, /**< Member variable of class/struct */
  32         tm_tag_method_t = 128, /**< Class method (Java only) */
  33         tm_tag_namespace_t = 256, /**< Namespace declaration */
  34         tm_tag_package_t = 512, /**< Package (Java only) */
  35         tm_tag_prototype_t = 1024, /**< Function prototype */
  36         tm_tag_struct_t = 2048, /**< Struct declaration */
  37         tm_tag_typedef_t = 4096, /**< Typedef */
  38         tm_tag_union_t = 8192, /**< Union */
  39         tm_tag_variable_t = 16384, /**< Variable */
  40         tm_tag_externvar_t = 32768, /**< Extern or forward declaration */
  41         tm_tag_macro_t = 65536, /**<  Macro (without arguments) */
  42         tm_tag_macro_with_arg_t = 131072, /**< Parameterized macro */
  43         tm_tag_local_var_t = 262144, /**< Local variable (inside function) */
  44         tm_tag_other_t = 524288, /**< Other (non C/C++/Java tag) */
  45         tm_tag_max_t = 1048575 /**< Maximum value of TMTagType */
  46 } TMTagType;
  47
  48
  49 /** @gironly
  50  * A integral type which can hold known parser type IDs
  51  **/
  52 typedef gint TMParserType;
  53
  54
  55 #ifdef GEANY_PRIVATE
  56
  57 /* keep in sync with tm_parsers.h and parser_map in tm_parser.c */
  58 enum
  59 {
  60         TM_PARSER_NONE = -2, /* keep in sync with ctags LANG_IGNORE */
  61         TM_PARSER_C = 0,
  62         TM_PARSER_CPP,
  63         TM_PARSER_JAVA,
  64         TM_PARSER_MAKEFILE,
  65         TM_PARSER_PASCAL,
  66         TM_PARSER_PERL,
  67         TM_PARSER_PHP,
  68         TM_PARSER_PYTHON,
  69         TM_PARSER_LATEX,
  70         TM_PARSER_ASM,
  71         TM_PARSER_CONF,
  72         TM_PARSER_SQL,
  73         TM_PARSER_DOCBOOK,
  74         TM_PARSER_ERLANG,
  75         TM_PARSER_CSS,
  76         TM_PARSER_RUBY,
  77         TM_PARSER_TCL,
  78         TM_PARSER_SH,
  79         TM_PARSER_D,
  80         TM_PARSER_FORTRAN,
  81         TM_PARSER_GDSCRIPT,
  82         TM_PARSER_DIFF,
  83         TM_PARSER_VHDL,
  84         TM_PARSER_LUA,
  85         TM_PARSER_JAVASCRIPT,
  86         TM_PARSER_HASKELL,
  87         TM_PARSER_CSHARP,
  88         TM_PARSER_FREEBASIC,
  89         TM_PARSER_HAXE,
  90         TM_PARSER_REST,
  91         TM_PARSER_HTML,
  92         TM_PARSER_ADA,
  93         TM_PARSER_CUDA,
  94         TM_PARSER_MATLAB,
  95         TM_PARSER_VALA,
  96         TM_PARSER_ACTIONSCRIPT,
  97         TM_PARSER_NSIS,
  98         TM_PARSER_MARKDOWN,
  99         TM_PARSER_TXT2TAGS,
 100         TM_PARSER_ABC,
 101         TM_PARSER_VERILOG,
 102         TM_PARSER_R,
 103         TM_PARSER_COBOL,
 104         TM_PARSER_OBJC,
 105         TM_PARSER_ASCIIDOC,
 106         TM_PARSER_ABAQUS,
 107         TM_PARSER_RUST,
 108         TM_PARSER_GO,
 109         TM_PARSER_JSON,
 110         TM_PARSER_ZEPHIR,
 111         TM_PARSER_POWERSHELL,
 112         TM_PARSER_JULIA,
 113         TM_PARSER_BIBTEX,
 114         TM_PARSER_CPREPROCESSOR,
 115         TM_PARSER_TCLOO,
 116         TM_PARSER_CLOJURE,
 117         TM_PARSER_LISP,
 118         TM_PARSER_TYPESCRIPT,
 119         TM_PARSER_COUNT
 120 };
 121
 122 /* keep in sync with icon names in symbols.c */
 123 enum
 124 {
 125         TM_ICON_CLASS,
 126         TM_ICON_MACRO,
 127         TM_ICON_MEMBER,
 128         TM_ICON_METHOD,
 129         TM_ICON_NAMESPACE,
 130         TM_ICON_OTHER,
 131         TM_ICON_STRUCT,
 132         TM_ICON_VAR,
 133         TM_ICON_NONE,
 134         TM_N_ICONS = TM_ICON_NONE
 135 };
 136
 137 void tm_parser_verify_type_mappings(void);
 138
 139 TMTagType tm_parser_get_tag_type(gchar kind, TMParserType lang);
 140
 141 gchar tm_parser_get_tag_kind(TMTagType type, TMParserType lang);
 142
 143 gint tm_parser_get_sidebar_group(TMParserType lang, TMTagType type);
 144
 145 const gchar *tm_parser_get_sidebar_info(TMParserType lang, gint group, guint *icon);
 146
 147 TMTagType tm_parser_get_subparser_type(TMParserType lang, TMParserType sublang, TMTagType type);
 148
 149 gint tm_parser_scope_autocomplete_suffix(TMParserType lang, const gchar *str);
 150
 151 const gchar *tm_parser_get_constructor_method(TMParserType lang);
 152
 153 gboolean tm_parser_is_anon_name(TMParserType lang, gchar *name);
 154
 155 gchar *tm_parser_update_scope(TMParserType lang, gchar *scope);
 156
 157 gboolean tm_parser_enable_role(TMParserType lang, gchar kind);
 158
 159 gboolean tm_parser_enable_kind(TMParserType lang, gchar kind);
 160
 161 gchar *tm_parser_format_variable(TMParserType lang, const gchar *name, const gchar *type);
 162
 163 gchar *tm_parser_format_function(TMParserType lang, const gchar *fname, const gchar *args,
 164         const gchar *retval, const gchar *scope);
 165
 166 const gchar *tm_parser_scope_separator(TMParserType lang);
 167
 168 const gchar *tm_parser_scope_separator_printable(TMParserType lang);
 169
 170 gboolean tm_parser_has_full_scope(TMParserType lang);
 171
 172 gboolean tm_parser_langs_compatible(TMParserType lang, TMParserType other);
 173
 174 #endif /* GEANY_PRIVATE */
 175
 176 G_END_DECLS
 177
 178 #endif /* TM_PARSER_H */