?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Move some documentation to show up in API docs.
[geany-mirror.git] / src / filetypes.c
blob1fa986eaa249b43e6c27b988f1ba86bd6437900b
1 /*
2 * filetypes.c - this file is part of Geany, a fast and lightweight IDE
3 *
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>
6 *
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.
11 *
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.
16 *
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.
20 */
21
22 /**
23 * @file filetypes.h
24 * Filetype detection, file extensions and filetype menu items.
25 */
26
27 /* Note: we use GeanyFiletypeID for some function arguments, but GeanyFiletype is better; we should
28 * only use GeanyFiletype for API functions. */
29
30 #ifdef HAVE_CONFIG_H
31 # include "config.h"
32 #endif
33
34 #include "filetypes.h"
35
36 #include "app.h"
37 #include "callbacks.h" /* FIXME: for ignore_callback */
38 #include "document.h"
39 #include "filetypesprivate.h"
40 #include "geany.h"
41 #include "geanyobject.h"
42 #include "highlighting.h"
43 #include "projectprivate.h"
44 #include "sciwrappers.h"
45 #include "support.h"
46 #include "symbols.h"
47 #include "tm_parser.h"
48 #include "utils.h"
49 #include "ui_utils.h"
50
51 #include <stdlib.h>
52 #include <string.h>
53
54 #include <glib/gstdio.h>
55
56 #define GEANY_FILETYPE_SEARCH_LINES 2 /* lines of file to search for filetype */
57
58 GPtrArray *filetypes_array = NULL;
59 static GHashTable *filetypes_hash = NULL; /* Hash of filetype pointers based on name keys */
60 GSList *filetypes_by_title = NULL;
61
62
63 static void create_radio_menu_item(GtkWidget *menu, GeanyFiletype *ftype);
64
65 static gchar *filetypes_get_conf_extension(const GeanyFiletype *ft);
66 static void read_filetype_config(void);
67 static void create_set_filetype_menu(gboolean config);
68 static gchar *filetypes_get_filename(GeanyFiletype *ft, gboolean user);
69
70
71 enum TitleType
72 {
73 TITLE_NONE,
74 TITLE_SOURCE_FILE,
75 TITLE_FILE,
76 TITLE_SCRIPT,
77 TITLE_DOCUMENT
78 };
79
80 /* Save adding many translation strings if the filetype name doesn't need translating */
81 static gchar *filetype_make_title(const char *name, enum TitleType type)
82 {
83 g_return_val_if_fail(name != NULL, NULL);
84
85 switch (type)
86 {
87 case TITLE_SOURCE_FILE: return g_strdup_printf(_("%s source file"), name);
88 case TITLE_FILE: return g_strdup_printf(_("%s file"), name);
89 case TITLE_SCRIPT: return g_strdup_printf(_("%s script"), name);
90 case TITLE_DOCUMENT: return g_strdup_printf(_("%s document"), name);
91 case TITLE_NONE: /* fall through */
92 default: return g_strdup(name);
93 }
94 }
95
96
97 /* name argument (ie filetype name) must not be translated as it is used for
98 * filetype lookup. Use filetypes_get_display_name() instead.*/
99 static void ft_init(GeanyFiletypeID ft_id, TMParserType lang, const char *name,
100 const char *title_name, enum TitleType title_type,
101 GeanyFiletypeGroupID group_id)
102 {
103 GeanyFiletype *ft = filetypes[ft_id];
104 ft->lang = lang;
105 ft->name = g_strdup(name);
106 ft->title = filetype_make_title((title_name != NULL) ? title_name : ft->name, title_type);
107 ft->group = group_id;
108 }
109
110 /* Evil macro to save typing and make init_builtin_filetypes() more readable */
111 #define FT_INIT(ft_id, parser_id, name, title_name, title_type, group_id) \
112 ft_init(GEANY_FILETYPES_##ft_id, TM_PARSER_##parser_id, name, title_name, \
113 TITLE_##title_type, GEANY_FILETYPE_GROUP_##group_id)
114
115
116 /* Note: remember to update HACKING if this function is renamed. */
117 static void init_builtin_filetypes(void)
118 {
119 /* Column legend:
120 * [0] = Filetype constant (GEANY_FILETYPES_*)
121 * [1] = CTags parser (TM_PARSER_*)
122 * [2] = Non-translated filetype name (*not* label for display)
123 * [3] = Translatable human filetype title prefix or NULL to use [2]
124 * [4] = Title type (TITLE_*) constant (ex. TITLE_SOURCE_FILE is 'source file' suffix)
125 * [5] = The filetype group constant (GEANY_FILETYPE_GROUP_*)
126 * --------------------------------------------------------------------------------------------------------------------------
127 * [0] [1] [2] [3] [4] [5] */
128 FT_INIT( NONE, NONE, "None", _("None"), NONE, NONE );
129 FT_INIT( C, C, "C", NULL, SOURCE_FILE, COMPILED );
130 FT_INIT( CPP, CPP, "C++", NULL, SOURCE_FILE, COMPILED );
131 FT_INIT( OBJECTIVEC, OBJC, "Objective-C", NULL, SOURCE_FILE, COMPILED );
132 FT_INIT( CS, CSHARP, "C#", NULL, SOURCE_FILE, COMPILED );
133 FT_INIT( VALA, VALA, "Vala", NULL, SOURCE_FILE, COMPILED );
134 FT_INIT( D, D, "D", NULL, SOURCE_FILE, COMPILED );
135 FT_INIT( JAVA, JAVA, "Java", NULL, SOURCE_FILE, COMPILED );
136 FT_INIT( PASCAL, PASCAL, "Pascal", NULL, SOURCE_FILE, COMPILED );
137 FT_INIT( ASM, ASM, "ASM", "Assembler", SOURCE_FILE, COMPILED );
138 FT_INIT( BASIC, FREEBASIC, "FreeBasic", NULL, SOURCE_FILE, COMPILED );
139 FT_INIT( FORTRAN, FORTRAN, "Fortran", "Fortran (F90)", SOURCE_FILE, COMPILED );
140 FT_INIT( F77, F77, "F77", "Fortran (F77)", SOURCE_FILE, COMPILED );
141 FT_INIT( GLSL, GLSL, "GLSL", NULL, SOURCE_FILE, COMPILED );
142 FT_INIT( CAML, NONE, "CAML", "(O)Caml", SOURCE_FILE, COMPILED );
143 FT_INIT( PERL, PERL, "Perl", NULL, SOURCE_FILE, SCRIPT );
144 FT_INIT( PHP, PHP, "PHP", NULL, SOURCE_FILE, SCRIPT );
145 FT_INIT( JS, JAVASCRIPT, "Javascript", NULL, SOURCE_FILE, SCRIPT );
146 FT_INIT( PYTHON, PYTHON, "Python", NULL, SOURCE_FILE, SCRIPT );
147 FT_INIT( RUBY, RUBY, "Ruby", NULL, SOURCE_FILE, SCRIPT );
148 FT_INIT( TCL, TCL, "Tcl", NULL, SOURCE_FILE, SCRIPT );
149 FT_INIT( LUA, LUA, "Lua", NULL, SOURCE_FILE, SCRIPT );
150 FT_INIT( FERITE, FERITE, "Ferite", NULL, SOURCE_FILE, SCRIPT );
151 FT_INIT( HASKELL, HASKELL, "Haskell", NULL, SOURCE_FILE, COMPILED );
152 FT_INIT( MARKDOWN, MARKDOWN, "Markdown", NULL, SOURCE_FILE, MARKUP );
153 FT_INIT( TXT2TAGS, TXT2TAGS, "Txt2tags", NULL, SOURCE_FILE, MARKUP );
154 FT_INIT( ABC, ABC, "Abc", NULL, FILE, MISC );
155 FT_INIT( SH, SH, "Sh", _("Shell"), SCRIPT, SCRIPT );
156 FT_INIT( MAKE, MAKEFILE, "Make", _("Makefile"), NONE, SCRIPT );
157 FT_INIT( XML, NONE, "XML", NULL, DOCUMENT, MARKUP );
158 FT_INIT( DOCBOOK, DOCBOOK, "Docbook", NULL, DOCUMENT, MARKUP );
159 FT_INIT( HTML, HTML, "HTML", NULL, DOCUMENT, MARKUP );
160 FT_INIT( CSS, CSS, "CSS", _("Cascading Stylesheet"), NONE, MARKUP ); /* not really markup but fit quite well to HTML */
161 FT_INIT( SQL, SQL, "SQL", NULL, FILE, MISC );
162 FT_INIT( COBOL, COBOL, "COBOL", NULL, SOURCE_FILE, COMPILED );
163 FT_INIT( LATEX, LATEX, "LaTeX", NULL, SOURCE_FILE, MARKUP );
164 FT_INIT( VHDL, VHDL, "VHDL", NULL, SOURCE_FILE, COMPILED );
165 FT_INIT( VERILOG, VERILOG, "Verilog", NULL, SOURCE_FILE, COMPILED );
166 FT_INIT( DIFF, DIFF, "Diff", NULL, FILE, MISC );
167 FT_INIT( LISP, NONE, "Lisp", NULL, SOURCE_FILE, SCRIPT );
168 FT_INIT( ERLANG, ERLANG, "Erlang", NULL, SOURCE_FILE, COMPILED );
169 FT_INIT( CONF, CONF, "Conf", _("Config"), FILE, MISC );
170 FT_INIT( PO, NONE, "Po", _("Gettext translation"), FILE, MISC );
171 FT_INIT( HAXE, HAXE, "Haxe", NULL, SOURCE_FILE, COMPILED );
172 FT_INIT( AS, ACTIONSCRIPT, "ActionScript", NULL, SOURCE_FILE, SCRIPT );
173 FT_INIT( R, R, "R", NULL, SOURCE_FILE, SCRIPT );
174 FT_INIT( REST, REST, "reStructuredText", NULL, SOURCE_FILE, MARKUP );
175 FT_INIT( MATLAB, MATLAB, "Matlab/Octave", NULL, SOURCE_FILE, SCRIPT );
176 FT_INIT( YAML, NONE, "YAML", NULL, FILE, MISC );
177 FT_INIT( CMAKE, NONE, "CMake", NULL, SOURCE_FILE, SCRIPT );
178 FT_INIT( NSIS, NSIS, "NSIS", NULL, SOURCE_FILE, SCRIPT );
179 FT_INIT( ADA, NONE, "Ada", NULL, SOURCE_FILE, COMPILED );
180 FT_INIT( FORTH, NONE, "Forth", NULL, SOURCE_FILE, SCRIPT );
181 FT_INIT( ASCIIDOC, ASCIIDOC, "Asciidoc", NULL, SOURCE_FILE, MARKUP );
182 FT_INIT( ABAQUS, ABAQUS, "Abaqus", NULL, SOURCE_FILE, SCRIPT );
183 FT_INIT( BATCH, NONE, "Batch", NULL, SCRIPT, SCRIPT );
184 FT_INIT( POWERSHELL, POWERSHELL, "PowerShell", NULL, SOURCE_FILE, SCRIPT );
185 FT_INIT( RUST, RUST, "Rust", NULL, SOURCE_FILE, COMPILED );
186 FT_INIT( COFFEESCRIPT, NONE, "CoffeeScript", NULL, SOURCE_FILE, SCRIPT );
187 FT_INIT( GO, GO, "Go", NULL, SOURCE_FILE, COMPILED );
188 FT_INIT( ZEPHIR, ZEPHIR, "Zephir", NULL, SOURCE_FILE, COMPILED );
189 }
190
191
192 /* initialize fields. */
193 static GeanyFiletype *filetype_new(void)
194 {
195 GeanyFiletype *ft = g_new0(GeanyFiletype, 1);
196
197 ft->group = GEANY_FILETYPE_GROUP_NONE;
198 ft->lang = TM_PARSER_NONE; /* assume no tagmanager parser */
199 /* pattern must not be null */
200 ft->pattern = g_new0(gchar*, 1);
201 ft->indent_width = -1;
202 ft->indent_type = -1;
203
204 ft->priv = g_new0(GeanyFiletypePrivate, 1);
205 ft->priv->project_list_entry = -1; /* no entry */
206
207 return ft;
208 }
209
210
211 static gint cmp_filetype(gconstpointer pft1, gconstpointer pft2, gpointer data)
212 {
213 gboolean by_name = GPOINTER_TO_INT(data);
214 const GeanyFiletype *ft1 = pft1, *ft2 = pft2;
215
216 if (G_UNLIKELY(ft1->id == GEANY_FILETYPES_NONE))
217 return -1;
218 if (G_UNLIKELY(ft2->id == GEANY_FILETYPES_NONE))
219 return 1;
220
221 return by_name ?
222 utils_str_casecmp(ft1->name, ft2->name) :
223 utils_str_casecmp(ft1->title, ft2->title);
224 }
225
226
227 /** Gets a list of filetype pointers sorted by name.
228 * The list does not change on subsequent calls.
229 * @return @elementtype{GeanyFiletype} @transfer{none} The list - do not free.
230 * @see filetypes_by_title. */
231 GEANY_API_SYMBOL
232 const GSList *filetypes_get_sorted_by_name(void)
233 {
234 static GSList *list = NULL;
235
236 g_return_val_if_fail(filetypes_by_title, NULL);
237
238 if (!list)
239 {
240 list = g_slist_copy(filetypes_by_title);
241 list = g_slist_sort_with_data(list, cmp_filetype, GINT_TO_POINTER(TRUE));
242 }
243 return list;
244 }
245
246
247 /* Add a filetype pointer to the lists of available filetypes,
248 * and set the filetype::id field. */
249 static void filetype_add(GeanyFiletype *ft)
250 {
251 g_return_if_fail(ft);
252 g_return_if_fail(ft->name);
253
254 ft->id = filetypes_array->len; /* len will be the index for filetype_array */
255 g_ptr_array_add(filetypes_array, ft);
256 g_hash_table_insert(filetypes_hash, ft->name, ft);
257
258 /* list will be sorted later */
259 filetypes_by_title = g_slist_prepend(filetypes_by_title, ft);
260 }
261
262
263 static void add_custom_filetype(const gchar *filename)
264 {
265 gchar *fn = utils_strdupa(strstr(filename, ".") + 1);
266 gchar *dot = g_strrstr(fn, ".conf");
267 GeanyFiletype *ft;
268
269 g_return_if_fail(dot);
270
271 *dot = 0x0;
272
273 if (g_hash_table_lookup(filetypes_hash, fn))
274 return;
275
276 ft = filetype_new();
277 ft->name = g_strdup(fn);
278 ft->title = filetype_make_title(ft->name, TITLE_FILE);
279 ft->priv->custom = TRUE;
280 filetype_add(ft);
281 geany_debug("Added filetype %s (%d).", ft->name, ft->id);
282 }
283
284
285 static void init_custom_filetypes(const gchar *path)
286 {
287 GDir *dir;
288 const gchar *filename;
289
290 g_return_if_fail(path);
291
292 dir = g_dir_open(path, 0, NULL);
293 if (dir == NULL)
294 return;
295
296 foreach_dir(filename, dir)
297 {
298 const gchar prefix[] = "filetypes.";
299
300 if (g_str_has_prefix(filename, prefix) &&
301 g_str_has_suffix(filename + strlen(prefix), ".conf"))
302 {
303 add_custom_filetype(filename);
304 }
305 }
306 g_dir_close(dir);
307 }
308
309
310 /* Create the filetypes array and fill it with the known filetypes.
311 * Warning: GTK isn't necessarily initialized yet. */
312 void filetypes_init_types(void)
313 {
314 GeanyFiletypeID ft_id;
315 gchar *f;
316
317 g_return_if_fail(filetypes_array == NULL);
318 g_return_if_fail(filetypes_hash == NULL);
319
320 filetypes_array = g_ptr_array_sized_new(GEANY_MAX_BUILT_IN_FILETYPES);
321 filetypes_hash = g_hash_table_new(g_str_hash, g_str_equal);
322
323 /* Create built-in filetypes */
324 for (ft_id = 0; ft_id < GEANY_MAX_BUILT_IN_FILETYPES; ft_id++)
325 {
326 filetypes[ft_id] = filetype_new();
327 }
328 init_builtin_filetypes();
329
330 /* Add built-in filetypes to the hash now the name fields are set */
331 for (ft_id = 0; ft_id < GEANY_MAX_BUILT_IN_FILETYPES; ft_id++)
332 {
333 filetype_add(filetypes[ft_id]);
334 }
335 init_custom_filetypes(app->datadir);
336 f = g_build_filename(app->configdir, GEANY_FILEDEFS_SUBDIR, NULL);
337 init_custom_filetypes(f);
338 g_free(f);
339
340 /* sort last instead of on insertion to prevent exponential time */
341 filetypes_by_title = g_slist_sort_with_data(filetypes_by_title,
342 cmp_filetype, GINT_TO_POINTER(FALSE));
343
344 read_filetype_config();
345 }
346
347
348 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
349 {
350 gchar *f, *basename;
351
352 g_return_if_fail(!EMPTY(doc->real_path));
353
354 f = g_build_filename(app->configdir, "filetype_extensions.conf", NULL);
355 if (utils_str_equal(doc->real_path, f))
356 filetypes_reload_extensions();
357 g_free(f);
358
359 basename = g_path_get_basename(doc->real_path);
360 if (g_str_has_prefix(basename, "filetypes."))
361 {
362 guint i;
363
364 for (i = 0; i < filetypes_array->len; i++)
365 {
366 GeanyFiletype *ft = filetypes[i];
367
368 f = filetypes_get_filename(ft, TRUE);
369 if (utils_str_equal(doc->real_path, f))
370 {
371 guint j;
372
373 /* Note: we don't reload other filetypes, even though the named styles may have changed.
374 * The user can do this manually with 'Tools->Reload Configuration' */
375 filetypes_load_config(i, TRUE);
376
377 foreach_document(j)
378 document_reload_config(documents[j]);
379
380 g_free(f);
381 break;
382 }
383 g_free(f);
384 }
385 }
386 g_free(basename);
387 }
388
389
390 static void setup_config_file_menus(void)
391 {
392 gchar *f;
393
394 f = g_build_filename(app->configdir, "filetype_extensions.conf", NULL);
395 ui_add_config_file_menu_item(f, NULL, NULL);
396 SETPTR(f, g_build_filename(app->configdir, GEANY_FILEDEFS_SUBDIR, "filetypes.common", NULL));
397 ui_add_config_file_menu_item(f, NULL, NULL);
398 g_free(f);
399
400 create_set_filetype_menu(TRUE);
401
402 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
403 }
404
405
406 static GtkWidget *create_sub_menu(GtkWidget *parent, const gchar *title)
407 {
408 GtkWidget *menu, *item;
409
410 menu = gtk_menu_new();
411 item = gtk_menu_item_new_with_mnemonic((title));
412 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), menu);
413 gtk_container_add(GTK_CONTAINER(parent), item);
414 gtk_widget_show(item);
415
416 return menu;
417 }
418
419
420 static void create_set_filetype_menu(gboolean config)
421 {
422 GtkWidget *group_menus[GEANY_FILETYPE_GROUP_COUNT] = {NULL};
423 GSList *node;
424 GtkWidget *menu;
425
426 menu = config ? ui_widgets.config_files_filetype_menu :
427 ui_lookup_widget(main_widgets.window, "set_filetype1_menu");
428
429 group_menus[GEANY_FILETYPE_GROUP_COMPILED] = create_sub_menu(menu, _("_Programming Languages"));
430 group_menus[GEANY_FILETYPE_GROUP_SCRIPT] = create_sub_menu(menu, _("_Scripting Languages"));
431 group_menus[GEANY_FILETYPE_GROUP_MARKUP] = create_sub_menu(menu, _("_Markup Languages"));
432 group_menus[GEANY_FILETYPE_GROUP_MISC] = create_sub_menu(menu, _("M_iscellaneous"));
433
434 /* Append all filetypes to the menu */
435 foreach_slist(node, filetypes_by_title)
436 {
437 GeanyFiletype *ft = node->data;
438 GtkWidget *parent = (ft->group != GEANY_FILETYPE_GROUP_NONE) ? group_menus[ft->group] : menu;
439
440 /* we already have filetypes.common config entry */
441 if (config && ft->id == GEANY_FILETYPES_NONE)
442 continue;
443
444 if (config)
445 {
446 gchar *filename = filetypes_get_filename(ft, TRUE);
447
448 ui_add_config_file_menu_item(filename, NULL, GTK_CONTAINER(parent));
449 g_free(filename);
450 }
451 else
452 create_radio_menu_item(parent, ft);
453 }
454 }
455
456
457 void filetypes_init(void)
458 {
459 filetypes_init_types();
460 create_set_filetype_menu(FALSE);
461 setup_config_file_menus();
462 }
463
464
465 /* Find a filetype that predicate returns TRUE for, otherwise return NULL. */
466 GeanyFiletype *filetypes_find(GCompareFunc predicate, gpointer user_data)
467 {
468 guint i;
469
470 for (i = 0; i < filetypes_array->len; i++)
471 {
472 GeanyFiletype *ft = filetypes[i];
473
474 if (predicate(ft, user_data))
475 return ft;
476 }
477 return NULL;
478 }
479
480
481 static gboolean match_basename(gconstpointer pft, gconstpointer user_data)
482 {
483 const GeanyFiletype *ft = pft;
484 const gchar *base_filename = user_data;
485 gint j;
486 gboolean ret = FALSE;
487
488 if (G_UNLIKELY(ft->id == GEANY_FILETYPES_NONE))
489 return FALSE;
490
491 for (j = 0; ft->pattern[j] != NULL; j++)
492 {
493 GPatternSpec *pattern = g_pattern_spec_new(ft->pattern[j]);
494
495 if (g_pattern_match_string(pattern, base_filename))
496 {
497 ret = TRUE;
498 g_pattern_spec_free(pattern);
499 break;
500 }
501 g_pattern_spec_free(pattern);
502 }
503 return ret;
504 }
505
506
507 static GeanyFiletype *check_builtin_filenames(const gchar *utf8_filename)
508 {
509 gchar *lfn = NULL;
510 gchar *path;
511 gboolean found = FALSE;
512
513 #ifdef G_OS_WIN32
514 /* use lower case basename */
515 lfn = g_utf8_strdown(utf8_filename, -1);
516 #else
517 lfn = g_strdup(utf8_filename);
518 #endif
519 SETPTR(lfn, utils_get_locale_from_utf8(lfn));
520
521 path = g_build_filename(app->configdir, GEANY_FILEDEFS_SUBDIR, "filetypes.", NULL);
522 if (g_str_has_prefix(lfn, path))
523 found = TRUE;
524
525 SETPTR(path, g_build_filename(app->datadir, "filetypes.", NULL));
526 if (g_str_has_prefix(lfn, path))
527 found = TRUE;
528
529 g_free(path);
530 g_free(lfn);
531 return found ? filetypes[GEANY_FILETYPES_CONF] : NULL;
532 }
533
534
535 /* Detect filetype only based on the filename extension.
536 * utf8_filename can include the full path. */
537 GeanyFiletype *filetypes_detect_from_extension(const gchar *utf8_filename)
538 {
539 gchar *base_filename;
540 GeanyFiletype *ft;
541
542 ft = check_builtin_filenames(utf8_filename);
543 if (ft)
544 return ft;
545
546 /* to match against the basename of the file (because of Makefile*) */
547 base_filename = g_path_get_basename(utf8_filename);
548 #ifdef G_OS_WIN32
549 /* use lower case basename */
550 SETPTR(base_filename, g_utf8_strdown(base_filename, -1));
551 #endif
552
553 ft = filetypes_find(match_basename, base_filename);
554 if (ft == NULL)
555 ft = filetypes[GEANY_FILETYPES_NONE];
556
557 g_free(base_filename);
558 return ft;
559 }
560
561
562 /* This detects the filetype of the file pointed by 'utf8_filename' and a list of filetype id's,
563 * terminated by -1.
564 * The detected filetype of the file is checked against every id in the passed list and if
565 * there is a match, TRUE is returned. */
566 static gboolean shebang_find_and_match_filetype(const gchar *utf8_filename, gint first, ...)
567 {
568 GeanyFiletype *ft = NULL;
569 gint test;
570 gboolean result = FALSE;
571 va_list args;
572
573 ft = filetypes_detect_from_extension(utf8_filename);
574 if (ft == NULL || ft->id >= filetypes_array->len)
575 return FALSE;
576
577 va_start(args, first);
578 test = first;
579 while (1)
580 {
581 if (test == -1)
582 break;
583
584 if (ft->id == (guint) test)
585 {
586 result = TRUE;
587 break;
588 }
589 test = va_arg(args, gint);
590 }
591 va_end(args);
592
593 return result;
594 }
595
596
597 static GeanyFiletype *find_shebang(const gchar *utf8_filename, const gchar *line)
598 {
599 GeanyFiletype *ft = NULL;
600
601 if (strlen(line) > 2 && line[0] == '#' && line[1] == '!')
602 {
603 static const struct {
604 const gchar *name;
605 GeanyFiletypeID filetype;
606 } intepreter_map[] = {
607 { "sh", GEANY_FILETYPES_SH },
608 { "bash", GEANY_FILETYPES_SH },
609 { "dash", GEANY_FILETYPES_SH },
610 { "perl", GEANY_FILETYPES_PERL },
611 { "python", GEANY_FILETYPES_PYTHON },
612 { "php", GEANY_FILETYPES_PHP },
613 { "ruby", GEANY_FILETYPES_RUBY },
614 { "tcl", GEANY_FILETYPES_TCL },
615 { "make", GEANY_FILETYPES_MAKE },
616 { "zsh", GEANY_FILETYPES_SH },
617 { "ksh", GEANY_FILETYPES_SH },
618 { "mksh", GEANY_FILETYPES_SH },
619 { "csh", GEANY_FILETYPES_SH },
620 { "tcsh", GEANY_FILETYPES_SH },
621 { "ash", GEANY_FILETYPES_SH },
622 { "dmd", GEANY_FILETYPES_D },
623 { "wish", GEANY_FILETYPES_TCL },
624 { "node", GEANY_FILETYPES_JS },
625 { "rust", GEANY_FILETYPES_RUST }
626 };
627 gchar *tmp = g_path_get_basename(line + 2);
628 gchar *basename_interpreter = tmp;
629 guint i;
630
631 if (g_str_has_prefix(tmp, "env "))
632 { /* skip "env" and read the following interpreter */
633 basename_interpreter += 4;
634 }
635
636 for (i = 0; ! ft && i < G_N_ELEMENTS(intepreter_map); i++)
637 {
638 if (g_str_has_prefix(basename_interpreter, intepreter_map[i].name))
639 ft = filetypes[intepreter_map[i].filetype];
640 }
641 g_free(tmp);
642 }
643 /* detect HTML files */
644 if (g_str_has_prefix(line, "<!DOCTYPE html") || g_str_has_prefix(line, "<html"))
645 {
646 /* PHP, Perl and Python files might also start with <html, so detect them based on filename
647 * extension and use the detected filetype, else assume HTML */
648 if (! shebang_find_and_match_filetype(utf8_filename,
649 GEANY_FILETYPES_PERL, GEANY_FILETYPES_PHP, GEANY_FILETYPES_PYTHON, -1))
650 {
651 ft = filetypes[GEANY_FILETYPES_HTML];
652 }
653 }
654 /* detect XML files */
655 else if (utf8_filename && g_str_has_prefix(line, "<?xml"))
656 {
657 /* HTML and DocBook files might also start with <?xml, so detect them based on filename
658 * extension and use the detected filetype, else assume XML */
659 if (! shebang_find_and_match_filetype(utf8_filename,
660 GEANY_FILETYPES_HTML, GEANY_FILETYPES_DOCBOOK,
661 /* Perl, Python and PHP only to be safe */
662 GEANY_FILETYPES_PERL, GEANY_FILETYPES_PHP, GEANY_FILETYPES_PYTHON, -1))
663 {
664 ft = filetypes[GEANY_FILETYPES_XML];
665 }
666 }
667 else if (g_str_has_prefix(line, "<?php"))
668 {
669 ft = filetypes[GEANY_FILETYPES_PHP];
670 }
671 return ft;
672 }
673
674
675 /* Detect the filetype checking for a shebang, then filename extension.
676 * @lines: an strv of the lines to scan (must containing at least one line) */
677 static GeanyFiletype *filetypes_detect_from_file_internal(const gchar *utf8_filename,
678 gchar **lines)
679 {
680 GeanyFiletype *ft;
681 gint i;
682 GRegex *ft_regex;
683 GMatchInfo *match;
684 GError *regex_error = NULL;
685
686 /* try to find a shebang and if found use it prior to the filename extension
687 * also checks for <?xml */
688 ft = find_shebang(utf8_filename, lines[0]);
689 if (ft != NULL)
690 return ft;
691
692 /* try to extract the filetype using a regex capture */
693 ft_regex = g_regex_new(file_prefs.extract_filetype_regex,
694 G_REGEX_RAW | G_REGEX_MULTILINE, 0, &regex_error);
695 if (ft_regex != NULL)
696 {
697 for (i = 0; ft == NULL && lines[i] != NULL; i++)
698 {
699 if (g_regex_match(ft_regex, lines[i], 0, &match))
700 {
701 gchar *capture = g_match_info_fetch(match, 1);
702 if (capture != NULL)
703 {
704 ft = filetypes_lookup_by_name(capture);
705 g_free(capture);
706 }
707 }
708 g_match_info_free(match);
709 }
710 g_regex_unref(ft_regex);
711 }
712 else if (regex_error != NULL)
713 {
714 geany_debug("Filetype extract regex ignored: %s", regex_error->message);
715 g_error_free(regex_error);
716 }
717 if (ft != NULL)
718 return ft;
719
720 if (utf8_filename == NULL)
721 return filetypes[GEANY_FILETYPES_NONE];
722
723 return filetypes_detect_from_extension(utf8_filename);
724 }
725
726
727 /* Detect the filetype for the document, checking for a shebang, then filename extension. */
728 GeanyFiletype *filetypes_detect_from_document(GeanyDocument *doc)
729 {
730 GeanyFiletype *ft;
731 gchar *lines[GEANY_FILETYPE_SEARCH_LINES + 1];
732 gint i;
733
734 g_return_val_if_fail(doc == NULL || doc->is_valid, filetypes[GEANY_FILETYPES_NONE]);
735
736 if (doc == NULL)
737 return filetypes[GEANY_FILETYPES_NONE];
738
739 for (i = 0; i < GEANY_FILETYPE_SEARCH_LINES; ++i)
740 {
741 lines[i] = sci_get_line(doc->editor->sci, i);
742 }
743 lines[i] = NULL;
744 ft = filetypes_detect_from_file_internal(doc->file_name, lines);
745 for (i = 0; i < GEANY_FILETYPE_SEARCH_LINES; ++i)
746 {
747 g_free(lines[i]);
748 }
749 return ft;
750 }
751
752
753 #ifdef HAVE_PLUGINS
754 /* Currently only used by external plugins (e.g. geanyprj). */
755 /**
756 * Detects filetype based on a shebang line in the file or the filename extension.
757 *
758 * @param utf8_filename The filename in UTF-8 encoding.
759 *
760 * @return @transfer{none} The detected filetype for @a utf8_filename or
761 * @c filetypes[GEANY_FILETYPES_NONE] if it could not be detected.
762 **/
763 GEANY_API_SYMBOL
764 GeanyFiletype *filetypes_detect_from_file(const gchar *utf8_filename)
765 {
766 gchar line[1024];
767 gchar *lines[2];
768 FILE *f;
769 gchar *locale_name = utils_get_locale_from_utf8(utf8_filename);
770
771 f = g_fopen(locale_name, "r");
772 g_free(locale_name);
773 if (f != NULL)
774 {
775 if (fgets(line, sizeof(line), f) != NULL)
776 {
777 fclose(f);
778 lines[0] = line;
779 lines[1] = NULL;
780 return filetypes_detect_from_file_internal(utf8_filename, lines);
781 }
782 fclose(f);
783 }
784 return filetypes_detect_from_extension(utf8_filename);
785 }
786 #endif
787
788
789 void filetypes_select_radio_item(const GeanyFiletype *ft)
790 {
791 /* ignore_callback has to be set by the caller */
792 g_return_if_fail(ignore_callback);
793
794 if (ft == NULL)
795 ft = filetypes[GEANY_FILETYPES_NONE];
796
797 gtk_check_menu_item_set_active(GTK_CHECK_MENU_ITEM(ft->priv->menu_item), TRUE);
798 }
799
800
801 static void
802 on_filetype_change(GtkCheckMenuItem *menuitem, gpointer user_data)
803 {
804 GeanyDocument *doc = document_get_current();
805 if (ignore_callback || doc == NULL || ! gtk_check_menu_item_get_active(menuitem))
806 return;
807
808 document_set_filetype(doc, (GeanyFiletype*)user_data);
809 }
810
811
812 static void create_radio_menu_item(GtkWidget *menu, GeanyFiletype *ftype)
813 {
814 static GSList *group = NULL;
815 GtkWidget *tmp;
816
817 tmp = gtk_radio_menu_item_new_with_label(group, ftype->title);
818 group = gtk_radio_menu_item_get_group(GTK_RADIO_MENU_ITEM(tmp));
819 ftype->priv->menu_item = tmp;
820 gtk_widget_show(tmp);
821 gtk_container_add(GTK_CONTAINER(menu), tmp);
822 g_signal_connect(tmp, "activate", G_CALLBACK(on_filetype_change), (gpointer) ftype);
823 }
824
825
826 static void filetype_free(gpointer data, G_GNUC_UNUSED gpointer user_data)
827 {
828 GeanyFiletype *ft = data;
829
830 g_return_if_fail(ft != NULL);
831
832 g_free(ft->name);
833 g_free(ft->title);
834 g_free(ft->extension);
835 g_free(ft->mime_type);
836 g_free(ft->comment_open);
837 g_free(ft->comment_close);
838 g_free(ft->comment_single);
839 g_free(ft->context_action_cmd);
840 g_free(ft->priv->filecmds);
841 g_free(ft->priv->ftdefcmds);
842 g_free(ft->priv->execcmds);
843 g_free(ft->error_regex_string);
844 if (ft->icon)
845 g_object_unref(ft->icon);
846 g_strfreev(ft->pattern);
847
848 if (ft->priv->error_regex)
849 g_regex_unref(ft->priv->error_regex);
850 g_slist_foreach(ft->priv->tag_files, (GFunc) g_free, NULL);
851 g_slist_free(ft->priv->tag_files);
852
853 g_free(ft->priv);
854 g_free(ft);
855 }
856
857
858 /* frees the array and all related pointers */
859 void filetypes_free_types(void)
860 {
861 g_return_if_fail(filetypes_array != NULL);
862 g_return_if_fail(filetypes_hash != NULL);
863
864 g_ptr_array_foreach(filetypes_array, filetype_free, NULL);
865 g_ptr_array_free(filetypes_array, TRUE);
866 g_hash_table_destroy(filetypes_hash);
867 }
868
869
870 static void load_indent_settings(GeanyFiletype *ft, GKeyFile *config, GKeyFile *configh)
871 {
872 ft->indent_width = utils_get_setting(integer, configh, config, "indentation", "width", -1);
873 ft->indent_type = utils_get_setting(integer, configh, config, "indentation", "type", -1);
874 /* check whether the indent type is OK */
875 switch (ft->indent_type)
876 {
877 case GEANY_INDENT_TYPE_TABS:
878 case GEANY_INDENT_TYPE_SPACES:
879 case GEANY_INDENT_TYPE_BOTH:
880 case -1:
881 break;
882
883 default:
884 g_warning("Invalid indent type %d in file type %s", ft->indent_type, ft->name);
885 ft->indent_type = -1;
886 break;
887 }
888 }
889
890
891 static void load_settings(guint ft_id, GKeyFile *config, GKeyFile *configh)
892 {
893 GeanyFiletype *ft = filetypes[ft_id];
894 gchar *result;
895
896 /* default extension */
897 result = utils_get_setting(string, configh, config, "settings", "extension", NULL);
898 if (result != NULL)
899 {
900 SETPTR(filetypes[ft_id]->extension, result);
901 }
902
903 /* MIME type */
904 result = utils_get_setting(string, configh, config, "settings", "mime_type", "text/plain");
905 SETPTR(filetypes[ft_id]->mime_type, result);
906
907 /* read comment notes */
908 result = utils_get_setting(string, configh, config, "settings", "comment_open", NULL);
909 if (result != NULL)
910 {
911 SETPTR(filetypes[ft_id]->comment_open, result);
912 }
913
914 result = utils_get_setting(string, configh, config, "settings", "comment_close", NULL);
915 if (result != NULL)
916 {
917 SETPTR(filetypes[ft_id]->comment_close, result);
918 }
919
920 result = utils_get_setting(string, configh, config, "settings", "comment_single", NULL);
921 if (result != NULL)
922 {
923 SETPTR(filetypes[ft_id]->comment_single, result);
924 }
925 /* import correctly filetypes that use old-style single comments */
926 else if (EMPTY(filetypes[ft_id]->comment_close))
927 {
928 SETPTR(filetypes[ft_id]->comment_single, filetypes[ft_id]->comment_open);
929 filetypes[ft_id]->comment_open = NULL;
930 }
931
932 filetypes[ft_id]->comment_use_indent = utils_get_setting(boolean, configh, config,
933 "settings", "comment_use_indent", FALSE);
934
935 /* read context action */
936 result = utils_get_setting(string, configh, config, "settings", "context_action_cmd", NULL);
937 if (result != NULL)
938 {
939 SETPTR(filetypes[ft_id]->context_action_cmd, result);
940 }
941
942 result = utils_get_setting(string, configh, config, "settings", "tag_parser", NULL);
943 if (result != NULL)
944 {
945 ft->lang = tm_source_file_get_named_lang(result);
946 if (ft->lang == TM_PARSER_NONE)
947 geany_debug("Cannot find tags parser '%s' for custom filetype '%s'.", result, ft->name);
948 g_free(result);
949 }
950
951 result = utils_get_setting(string, configh, config, "settings", "lexer_filetype", NULL);
952 if (result != NULL)
953 {
954 ft->lexer_filetype = filetypes_lookup_by_name(result);
955 if (!ft->lexer_filetype)
956 geany_debug("Cannot find lexer filetype '%s' for custom filetype '%s'.", result, ft->name);
957 g_free(result);
958 }
959
960 ft->priv->symbol_list_sort_mode = utils_get_setting(integer, configh, config, "settings",
961 "symbol_list_sort_mode", SYMBOLS_SORT_USE_PREVIOUS);
962 ft->priv->xml_indent_tags = utils_get_setting(boolean, configh, config, "settings",
963 "xml_indent_tags", FALSE);
964
965 /* read indent settings */
966 load_indent_settings(ft, config, configh);
967
968 /* read build settings */
969 build_load_menu(config, GEANY_BCS_FT, (gpointer)ft);
970 build_load_menu(configh, GEANY_BCS_HOME_FT, (gpointer)ft);
971 }
972
973
974 static void copy_keys(GKeyFile *dest, const gchar *dest_group,
975 GKeyFile *src, const gchar *src_group)
976 {
977 gchar **keys = g_key_file_get_keys(src, src_group, NULL, NULL);
978 gchar **ptr;
979
980 foreach_strv(ptr, keys)
981 {
982 gchar *key = *ptr;
983 gchar *value = g_key_file_get_value(src, src_group, key, NULL);
984
985 g_key_file_set_value(dest, dest_group, key, value);
986 g_free(value);
987 }
988 g_strfreev(keys);
989 }
990
991
992 static gchar *filetypes_get_filename(GeanyFiletype *ft, gboolean user)
993 {
994 gchar *ext = filetypes_get_conf_extension(ft);
995 gchar *base_name = g_strconcat("filetypes.", ext, NULL);
996 gchar *file_name;
997
998 if (user)
999 file_name = g_build_filename(app->configdir, GEANY_FILEDEFS_SUBDIR, base_name, NULL);
1000 else
1001 file_name = g_build_filename(app->datadir, base_name, NULL);
1002
1003 g_free(ext);
1004 g_free(base_name);
1005
1006 return file_name;
1007 }
1008
1009
1010 static void add_group_keys(GKeyFile *kf, const gchar *group, GeanyFiletype *ft)
1011 {
1012 gchar *files[2];
1013 gboolean loaded = FALSE;
1014 guint i;
1015
1016 files[0] = filetypes_get_filename(ft, FALSE);
1017 files[1] = filetypes_get_filename(ft, TRUE);
1018
1019 for (i = 0; i < G_N_ELEMENTS(files); i++)
1020 {
1021 GKeyFile *src = g_key_file_new();
1022
1023 if (g_key_file_load_from_file(src, files[i], G_KEY_FILE_NONE, NULL))
1024 {
1025 copy_keys(kf, group, src, group);
1026 loaded = TRUE;
1027 }
1028 g_key_file_free(src);
1029 }
1030
1031 if (!loaded)
1032 geany_debug("Could not read config file %s for [%s=%s]!", files[0], group, ft->name);
1033
1034 g_free(files[0]);
1035 g_free(files[1]);
1036 }
1037
1038
1039 static void copy_ft_groups(GKeyFile *kf)
1040 {
1041 gchar **groups = g_key_file_get_groups(kf, NULL);
1042 gchar **ptr;
1043
1044 foreach_strv(ptr, groups)
1045 {
1046 gchar *group = *ptr;
1047 gchar *old_group;
1048 gchar *name = strchr(*ptr, '=');
1049 GeanyFiletype *ft;
1050
1051 if (!name || !name[1]) /* no name or no parent name */
1052 continue;
1053
1054 old_group = g_strdup(group);
1055
1056 /* terminate group at '=' */
1057 *name = 0;
1058 name++;
1059
1060 ft = filetypes_lookup_by_name(name);
1061 if (ft)
1062 {
1063 add_group_keys(kf, group, ft);
1064 /* move old group keys (foo=bar) to proper group name (foo) */
1065 copy_keys(kf, group, kf, old_group);
1066 }
1067 g_free(old_group);
1068 }
1069 g_strfreev(groups);
1070 }
1071
1072
1073 /* simple wrapper function to print file errors in DEBUG mode */
1074 static void load_system_keyfile(GKeyFile *key_file, const gchar *file, GKeyFileFlags flags,
1075 GeanyFiletype *ft)
1076 {
1077 GError *error = NULL;
1078 gboolean done = g_key_file_load_from_file(key_file, file, flags, &error);
1079
1080 if (error != NULL)
1081 {
1082 if (!done && !ft->priv->custom)
1083 geany_debug("Failed to open %s (%s)", file, error->message);
1084
1085 g_error_free(error);
1086 error = NULL;
1087 }
1088 }
1089
1090
1091 /* Load the configuration file for the associated filetype id.
1092 * This should only be called when the filetype is needed, to save loading
1093 * 20+ configuration files all at once. */
1094 void filetypes_load_config(guint ft_id, gboolean reload)
1095 {
1096 GKeyFile *config, *config_home;
1097 GeanyFiletypePrivate *pft;
1098 GeanyFiletype *ft;
1099
1100 g_return_if_fail(ft_id < filetypes_array->len);
1101
1102 ft = filetypes[ft_id];
1103 pft = ft->priv;
1104
1105 /* when reloading, proceed only if the settings were already loaded */
1106 if (G_UNLIKELY(reload && ! pft->keyfile_loaded))
1107 return;
1108
1109 /* when not reloading, load the settings only once */
1110 if (G_LIKELY(! reload && pft->keyfile_loaded))
1111 return;
1112 pft->keyfile_loaded = TRUE;
1113
1114 config = g_key_file_new();
1115 config_home = g_key_file_new();
1116 {
1117 /* highlighting uses GEANY_FILETYPES_NONE for common settings */
1118 gchar *f;
1119
1120 f = filetypes_get_filename(ft, FALSE);
1121 load_system_keyfile(config, f, G_KEY_FILE_KEEP_COMMENTS, ft);
1122
1123 SETPTR(f, filetypes_get_filename(ft, TRUE));
1124 g_key_file_load_from_file(config_home, f, G_KEY_FILE_KEEP_COMMENTS, NULL);
1125 g_free(f);
1126 }
1127 /* Copy keys for any groups with [group=C] from system keyfile */
1128 copy_ft_groups(config);
1129 copy_ft_groups(config_home);
1130
1131 load_settings(ft_id, config, config_home);
1132 highlighting_init_styles(ft_id, config, config_home);
1133
1134 if (ft->icon)
1135 g_object_unref(ft->icon);
1136 ft->icon = ui_get_mime_icon(ft->mime_type);
1137
1138 g_key_file_free(config);
1139 g_key_file_free(config_home);
1140 }
1141
1142
1143 static gchar *filetypes_get_conf_extension(const GeanyFiletype *ft)
1144 {
1145 gchar *result;
1146
1147 if (ft->priv->custom)
1148 return g_strconcat(ft->name, ".conf", NULL);
1149
1150 /* Handle any special extensions different from lowercase filetype->name */
1151 switch (ft->id)
1152 {
1153 case GEANY_FILETYPES_CPP: result = g_strdup("cpp"); break;
1154 case GEANY_FILETYPES_CS: result = g_strdup("cs"); break;
1155 case GEANY_FILETYPES_MAKE: result = g_strdup("makefile"); break;
1156 case GEANY_FILETYPES_NONE: result = g_strdup("common"); break;
1157 /* name is Matlab/Octave */
1158 case GEANY_FILETYPES_MATLAB: result = g_strdup("matlab"); break;
1159 /* name is Objective-C, and we don't want the hyphen */
1160 case GEANY_FILETYPES_OBJECTIVEC: result = g_strdup("objectivec"); break;
1161 default:
1162 result = g_ascii_strdown(ft->name, -1);
1163 break;
1164 }
1165 return result;
1166 }
1167
1168
1169 void filetypes_save_commands(GeanyFiletype *ft)
1170 {
1171 GKeyFile *config_home;
1172 gchar *fname, *data;
1173
1174 fname = filetypes_get_filename(ft, TRUE);
1175 config_home = g_key_file_new();
1176 g_key_file_load_from_file(config_home, fname, G_KEY_FILE_KEEP_COMMENTS, NULL);
1177 build_save_menu(config_home, ft, GEANY_BCS_HOME_FT);
1178 data = g_key_file_to_data(config_home, NULL, NULL);
1179 utils_write_file(fname, data);
1180 g_free(data);
1181 g_key_file_free(config_home);
1182 g_free(fname);
1183 }
1184
1185
1186 /* create one file filter which has each file pattern of each filetype */
1187 GtkFileFilter *filetypes_create_file_filter_all_source(void)
1188 {
1189 GtkFileFilter *new_filter;
1190 guint i, j;
1191
1192 new_filter = gtk_file_filter_new();
1193 gtk_file_filter_set_name(new_filter, _("All Source"));
1194
1195 for (i = 0; i < filetypes_array->len; i++)
1196 {
1197 if (G_UNLIKELY(i == GEANY_FILETYPES_NONE))
1198 continue;
1199
1200 for (j = 0; filetypes[i]->pattern[j]; j++)
1201 {
1202 gtk_file_filter_add_pattern(new_filter, filetypes[i]->pattern[j]);
1203 }
1204 }
1205 return new_filter;
1206 }
1207
1208
1209 GtkFileFilter *filetypes_create_file_filter(const GeanyFiletype *ft)
1210 {
1211 GtkFileFilter *new_filter;
1212 gint i;
1213 const gchar *title;
1214
1215 g_return_val_if_fail(ft != NULL, NULL);
1216
1217 new_filter = gtk_file_filter_new();
1218 title = ft->id == GEANY_FILETYPES_NONE ? _("All files") : ft->title;
1219 gtk_file_filter_set_name(new_filter, title);
1220
1221 for (i = 0; ft->pattern[i]; i++)
1222 {
1223 gtk_file_filter_add_pattern(new_filter, ft->pattern[i]);
1224 }
1225
1226 return new_filter;
1227 }
1228
1229
1230 /* Indicates whether there is a tag parser for the filetype or not.
1231 * Only works for custom filetypes if the filetype settings have been loaded. */
1232 gboolean filetype_has_tags(GeanyFiletype *ft)
1233 {
1234 g_return_val_if_fail(ft != NULL, FALSE);
1235
1236 return ft->lang != TM_PARSER_NONE;
1237 }
1238
1239
1240 /** Finds a filetype pointer from its @a name field.
1241 * @param name Filetype name.
1242 * @return @transfer{none} @nullable The filetype found, or @c NULL.
1243 *
1244 * @since 0.15
1245 **/
1246 GEANY_API_SYMBOL
1247 GeanyFiletype *filetypes_lookup_by_name(const gchar *name)
1248 {
1249 GeanyFiletype *ft;
1250
1251 g_return_val_if_fail(!EMPTY(name), NULL);
1252
1253 ft = g_hash_table_lookup(filetypes_hash, name);
1254 if (G_UNLIKELY(ft == NULL))
1255 geany_debug("Could not find filetype '%s'.", name);
1256 return ft;
1257 }
1258
1259
1260 static void compile_regex(GeanyFiletype *ft, gchar *regstr)
1261 {
1262 GError *error = NULL;
1263 GRegex *regex = g_regex_new(regstr, 0, 0, &error);
1264
1265 if (!regex)
1266 {
1267 ui_set_statusbar(TRUE, _("Bad regex for filetype %s: %s"),
1268 filetypes_get_display_name(ft), error->message);
1269 g_error_free(error);
1270 }
1271 if (ft->priv->error_regex)
1272 g_regex_unref(ft->priv->error_regex);
1273 ft->priv->error_regex = regex;
1274 }
1275
1276
1277 gboolean filetypes_parse_error_message(GeanyFiletype *ft, const gchar *message,
1278 gchar **filename, gint *line)
1279 {
1280 gchar *regstr;
1281 gchar **tmp;
1282 GeanyDocument *doc;
1283 GMatchInfo *minfo;
1284 gint i, n_match_groups;
1285 gchar *first, *second;
1286
1287 if (ft == NULL)
1288 {
1289 doc = document_get_current();
1290 if (doc != NULL)
1291 ft = doc->file_type;
1292 }
1293 tmp = build_get_regex(build_info.grp, ft, NULL);
1294 if (tmp == NULL)
1295 return FALSE;
1296 regstr = *tmp;
1297
1298 *filename = NULL;
1299 *line = -1;
1300
1301 if (G_UNLIKELY(EMPTY(regstr)))
1302 return FALSE;
1303
1304 if (!ft->priv->error_regex || regstr != ft->priv->last_error_pattern)
1305 {
1306 compile_regex(ft, regstr);
1307 ft->priv->last_error_pattern = regstr;
1308 }
1309 if (!ft->priv->error_regex)
1310 return FALSE;
1311
1312 if (!g_regex_match(ft->priv->error_regex, message, 0, &minfo))
1313 {
1314 g_match_info_free(minfo);
1315 return FALSE;
1316 }
1317
1318 n_match_groups = g_match_info_get_match_count(minfo);
1319 first = second = NULL;
1320
1321 for (i = 1; i < n_match_groups; i++)
1322 {
1323 gint start_pos;
1324
1325 g_match_info_fetch_pos(minfo, i, &start_pos, NULL);
1326 if (start_pos != -1)
1327 {
1328 if (first == NULL)
1329 first = g_match_info_fetch(minfo, i);
1330 else
1331 {
1332 second = g_match_info_fetch(minfo, i);
1333 break;
1334 }
1335 }
1336 }
1337
1338 if (second)
1339 {
1340 gchar *end;
1341 glong l;
1342
1343 l = strtol(first, &end, 10);
1344 if (*end == '\0') /* first is purely decimals */
1345 {
1346 *line = l;
1347 g_free(first);
1348 *filename = second;
1349 }
1350 else
1351 {
1352 l = strtol(second, &end, 10);
1353 if (*end == '\0')
1354 {
1355 *line = l;
1356 g_free(second);
1357 *filename = first;
1358 }
1359 else
1360 {
1361 g_free(first);
1362 g_free(second);
1363 }
1364 }
1365 }
1366 else
1367 g_free(first);
1368
1369 g_match_info_free(minfo);
1370 return *filename != NULL;
1371 }
1372
1373
1374 #ifdef G_OS_WIN32
1375 static void convert_filetype_extensions_to_lower_case(gchar **patterns, gsize len)
1376 {
1377 guint i;
1378 for (i = 0; i < len; i++)
1379 {
1380 SETPTR(patterns[i], g_ascii_strdown(patterns[i], -1));
1381 }
1382 }
1383 #endif
1384
1385
1386 static void read_extensions(GKeyFile *sysconfig, GKeyFile *userconfig)
1387 {
1388 guint i;
1389 gsize len = 0;
1390
1391 /* read the keys */
1392 for (i = 0; i < filetypes_array->len; i++)
1393 {
1394 gboolean userset =
1395 g_key_file_has_key(userconfig, "Extensions", filetypes[i]->name, NULL);
1396 gchar **list = g_key_file_get_string_list(
1397 (userset) ? userconfig : sysconfig, "Extensions", filetypes[i]->name, &len, NULL);
1398
1399 g_strfreev(filetypes[i]->pattern);
1400 /* Note: we allow 'Foo=' to remove all patterns */
1401 if (!list)
1402 list = g_new0(gchar*, 1);
1403 filetypes[i]->pattern = list;
1404
1405 #ifdef G_OS_WIN32
1406 convert_filetype_extensions_to_lower_case(filetypes[i]->pattern, len);
1407 #endif
1408 }
1409 }
1410
1411
1412 static void read_group(GKeyFile *config, const gchar *group_name, GeanyFiletypeGroupID group_id)
1413 {
1414 gchar **names = g_key_file_get_string_list(config, "Groups", group_name, NULL, NULL);
1415 gchar **name;
1416
1417 foreach_strv(name, names)
1418 {
1419 GeanyFiletype *ft = filetypes_lookup_by_name(*name);
1420
1421 if (ft)
1422 {
1423 ft->group = group_id;
1424 if (ft->priv->custom &&
1425 (group_id == GEANY_FILETYPE_GROUP_COMPILED || group_id == GEANY_FILETYPE_GROUP_SCRIPT))
1426 {
1427 SETPTR(ft->title, filetype_make_title(ft->name, TITLE_SOURCE_FILE));
1428 }
1429 }
1430 else
1431 geany_debug("Filetype '%s' not found for group '%s'!", *name, group_name);
1432 }
1433 g_strfreev(names);
1434 }
1435
1436
1437 static void read_groups(GKeyFile *config)
1438 {
1439 read_group(config, "Programming", GEANY_FILETYPE_GROUP_COMPILED);
1440 read_group(config, "Script", GEANY_FILETYPE_GROUP_SCRIPT);
1441 read_group(config, "Markup", GEANY_FILETYPE_GROUP_MARKUP);
1442 read_group(config, "Misc", GEANY_FILETYPE_GROUP_MISC);
1443 read_group(config, "None", GEANY_FILETYPE_GROUP_NONE);
1444 }
1445
1446
1447 static void read_filetype_config(void)
1448 {
1449 gchar *sysconfigfile = g_build_filename(app->datadir, "filetype_extensions.conf", NULL);
1450 gchar *userconfigfile = g_build_filename(app->configdir, "filetype_extensions.conf", NULL);
1451 GKeyFile *sysconfig = g_key_file_new();
1452 GKeyFile *userconfig = g_key_file_new();
1453
1454 g_key_file_load_from_file(sysconfig, sysconfigfile, G_KEY_FILE_NONE, NULL);
1455 g_key_file_load_from_file(userconfig, userconfigfile, G_KEY_FILE_NONE, NULL);
1456
1457 read_extensions(sysconfig, userconfig);
1458 read_groups(sysconfig);
1459 read_groups(userconfig);
1460
1461 g_free(sysconfigfile);
1462 g_free(userconfigfile);
1463 g_key_file_free(sysconfig);
1464 g_key_file_free(userconfig);
1465 }
1466
1467
1468 void filetypes_reload_extensions(void)
1469 {
1470 guint i;
1471
1472 read_filetype_config();
1473
1474 /* Redetect filetype of any documents with none set */
1475 foreach_document(i)
1476 {
1477 GeanyDocument *doc = documents[i];
1478 if (doc->file_type->id != GEANY_FILETYPES_NONE)
1479 continue;
1480 document_set_filetype(doc, filetypes_detect_from_document(doc));
1481 }
1482 }
1483
1484
1485 /** Accessor function for @ref GeanyData::filetypes_array items.
1486 * Example: @code ft = filetypes_index(GEANY_FILETYPES_C); @endcode
1487 * @param idx @c filetypes_array index.
1488 * @return @transfer{none} @nullable The filetype, or @c NULL if @a idx is out of range.
1489 *
1490 * @since 0.16
1491 */
1492 GEANY_API_SYMBOL
1493 GeanyFiletype *filetypes_index(gint idx)
1494 {
1495 return (idx >= 0 && idx < (gint) filetypes_array->len) ? filetypes[idx] : NULL;
1496 }
1497
1498
1499 void filetypes_reload(void)
1500 {
1501 guint i;
1502 GeanyDocument *current_doc;
1503
1504 /* reload filetype configs */
1505 for (i = 0; i < filetypes_array->len; i++)
1506 {
1507 /* filetypes_load_config() will skip not loaded filetypes */
1508 filetypes_load_config(i, TRUE);
1509 }
1510
1511 current_doc = document_get_current();
1512 if (!current_doc)
1513 return;
1514
1515 /* update document styling */
1516 foreach_document(i)
1517 {
1518 if (current_doc != documents[i])
1519 document_reload_config(documents[i]);
1520 }
1521 /* process the current document at last */
1522 document_reload_config(current_doc);
1523 }
1524
1525
1526 /** Gets @c ft->name or a translation for filetype None.
1527 * @param ft .
1528 * @return .
1529 * @since Geany 0.20 */
1530 GEANY_API_SYMBOL
1531 const gchar *filetypes_get_display_name(GeanyFiletype *ft)
1532 {
1533 return ft->id == GEANY_FILETYPES_NONE ? _("None") : ft->name;
1534 }
1535
1536
1537 /* gets comment_open/comment_close/comment_single strings from the filetype
1538 * @param single_first: whether single comment is preferred if both available
1539 * returns true if at least comment_open is set, false otherwise */
1540 gboolean filetype_get_comment_open_close(const GeanyFiletype *ft, gboolean single_first,
1541 const gchar **co, const gchar **cc)
1542 {
1543 g_return_val_if_fail(ft != NULL, FALSE);
1544 g_return_val_if_fail(co != NULL, FALSE);
1545 g_return_val_if_fail(cc != NULL, FALSE);
1546
1547 if (single_first)
1548 {
1549 *co = ft->comment_single;
1550 if (!EMPTY(*co))
1551 *cc = NULL;
1552 else
1553 {
1554 *co = ft->comment_open;
1555 *cc = ft->comment_close;
1556 }
1557 }
1558 else
1559 {
1560 *co = ft->comment_open;
1561 if (!EMPTY(*co))
1562 *cc = ft->comment_close;
1563 else
1564 {
1565 *co = ft->comment_single;
1566 *cc = NULL;
1567 }
1568 }
1569
1570 return !EMPTY(*co);
1571 }
A fast and lightweight IDE