2 * filetypes.h - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005-2012 Enrico Tröger <enrico(dot)troeger(at)uvena(dot)de>
5 * Copyright 2006-2012 Nick Treleaven <nick(dot)treleaven(at)btinternet(dot)com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #ifndef GEANY_FILETYPES_H
24 #define GEANY_FILETYPES_H 1
26 #include "geany.h" /* for GEANY() macro */
27 #include "tm_source_file.h" /* for langType */
29 #include "gtkcompat.h" /* Needed by ScintillaWidget.h */
30 #include "Scintilla.h" /* Needed by ScintillaWidget.h */
31 #include "ScintillaWidget.h" /* for ScintillaObject */
38 /* Forward-declared to avoid including document.h since it includes this header */
41 /** IDs of known filetypes
43 * @ref filetypes will contain an item for each. Use GeanyData::filetypes_array to
44 * determine the known filetypes at runtime */
47 GEANY_FILETYPES_NONE
= 0, /* first filetype is always None & must be 0 */
50 GEANY_FILETYPES_BASIC
, /* FreeBasic */
51 GEANY_FILETYPES_MATLAB
,
54 GEANY_FILETYPES_FERITE
,
65 GEANY_FILETYPES_HASKELL
,
72 GEANY_FILETYPES_PYTHON
,
76 GEANY_FILETYPES_PASCAL
,
77 GEANY_FILETYPES_LATEX
,
83 GEANY_FILETYPES_FORTRAN
,
86 GEANY_FILETYPES_DOCBOOK
,
91 GEANY_FILETYPES_CMAKE
,
92 GEANY_FILETYPES_MARKDOWN
,
93 GEANY_FILETYPES_TXT2TAGS
,
95 GEANY_FILETYPES_VERILOG
,
96 GEANY_FILETYPES_FORTH
,
98 GEANY_FILETYPES_ERLANG
,
99 GEANY_FILETYPES_COBOL
,
100 GEANY_FILETYPES_OBJECTIVEC
,
101 GEANY_FILETYPES_ASCIIDOC
,
102 GEANY_FILETYPES_ABAQUS
,
103 GEANY_FILETYPES_BATCH
,
104 GEANY_FILETYPES_POWERSHELL
,
105 GEANY_FILETYPES_RUST
,
106 GEANY_FILETYPES_COFFEESCRIPT
,
108 GEANY_FILETYPES_ZEPHIR
,
109 /* ^ append items here */
110 GEANY_MAX_BUILT_IN_FILETYPES
/* Don't use this, use filetypes_array->len instead */
114 #define filetype_id GeanyFiletypeID /* compat define - should be removed in the future */
117 * Filetype categories
119 * These are used to provide submenus for each category in the GUI */
122 GEANY_FILETYPE_GROUP_NONE
,
123 GEANY_FILETYPE_GROUP_COMPILED
,
124 GEANY_FILETYPE_GROUP_SCRIPT
,
125 GEANY_FILETYPE_GROUP_MARKUP
,
126 GEANY_FILETYPE_GROUP_MISC
,
127 GEANY_FILETYPE_GROUP_COUNT
129 GeanyFiletypeGroupID
;
132 /* Safe wrapper to get the id field of a possibly NULL filetype pointer.
133 * This shouldn't be necessary since GeanyDocument::file_type is always non-NULL. */
134 #define FILETYPE_ID(filetype_ptr) \
135 (((filetype_ptr) != NULL) ? (filetype_ptr)->id : GEANY_FILETYPES_NONE)
137 /** Represents a filetype. */
138 typedef struct GeanyFiletype
140 GeanyFiletypeID id
; /**< Index in @ref filetypes. */
141 /** Represents the langType of tagmanager (see the table
142 * in tagmanager/parsers.h), -1 represents all, -2 none. */
144 /** Untranslated short name, such as "C", "None".
145 * Must not be translated as it's used for hash table lookups - use
146 * filetypes_get_display_name() instead. */
148 /** Shown in the file open dialog, such as "C source file". */
150 gchar
*extension
; /**< Default file extension for new files, or @c NULL. */
151 gchar
**pattern
; /**< Array of filename-matching wildcard strings. */
152 gchar
*context_action_cmd
;
154 gchar
*comment_close
;
155 gboolean comment_use_indent
;
156 GeanyFiletypeGroupID group
;
157 gchar
*error_regex_string
;
158 struct GeanyFiletype
*lexer_filetype
;
161 gchar
*comment_single
; /* single-line comment */
162 /* filetype indent settings, -1 if not set */
166 struct GeanyFiletypePrivate
*priv
; /* must be last, append fields before this item */
170 /** Wraps @ref GeanyData::filetypes_array so it can be used with C array syntax.
171 * Example: filetypes[GEANY_FILETYPES_C]->name = ...;
172 * @see filetypes_index(). */
173 #define filetypes ((GeanyFiletype **)GEANY(filetypes_array)->pdata)
176 GeanyFiletype
*filetypes_detect_from_file(const gchar
*utf8_filename
);
178 GeanyFiletype
*filetypes_lookup_by_name(const gchar
*name
);
180 GeanyFiletype
*filetypes_index(gint idx
);
182 const gchar
*filetypes_get_display_name(GeanyFiletype
*ft
);
184 const GSList
*filetypes_get_sorted_by_name(void);
189 extern GPtrArray
*filetypes_array
;
191 extern GSList
*filetypes_by_title
;
194 GeanyFiletype
*filetypes_find(GCompareFunc predicate
, gpointer user_data
);
197 void filetypes_init(void);
199 void filetypes_init_types(void);
201 void filetypes_reload_extensions(void);
203 void filetypes_reload(void);
206 GeanyFiletype
*filetypes_detect_from_document(struct GeanyDocument
*doc
);
208 GeanyFiletype
*filetypes_detect_from_extension(const gchar
*utf8_filename
);
210 void filetypes_free_types(void);
212 void filetypes_load_config(guint ft_id
, gboolean reload
);
214 void filetypes_save_commands(GeanyFiletype
*ft
);
216 void filetypes_select_radio_item(const GeanyFiletype
*ft
);
218 GtkFileFilter
*filetypes_create_file_filter(const GeanyFiletype
*ft
);
220 GtkFileFilter
*filetypes_create_file_filter_all_source(void);
222 gboolean
filetype_has_tags(GeanyFiletype
*ft
);
224 gboolean
filetypes_parse_error_message(GeanyFiletype
*ft
, const gchar
*message
,
225 gchar
**filename
, gint
*line
);
227 gboolean
filetype_get_comment_open_close(const GeanyFiletype
*ft
, gboolean single_first
,
228 const gchar
**co
, const gchar
**cc
);
230 #endif /* GEANY_PRIVATE */
234 #endif /* GEANY_FILETYPES_H */