2 * templates.c - this file is part of Geany, a fast and lightweight IDE
4 * Copyright 2005 The Geany contributors
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 * Templates to insert into the current document, or file templates to create a new
30 #include "templates.h"
34 #include "encodingsprivate.h"
35 #include "filetypes.h"
37 #include "geanymenubuttonaction.h"
38 #include "geanyobject.h"
50 GeanyTemplatePrefs template_prefs
;
52 static GtkWidget
*new_with_template_menu
= NULL
;
53 static GtkWidget
*new_with_template_toolbar_menu
= NULL
;
55 /* TODO: implement custom insertion templates instead? */
56 static gchar
*templates
[GEANY_MAX_TEMPLATES
];
59 static void replace_static_values(GString
*text
);
60 static gchar
*get_template_fileheader(GeanyFiletype
*ft
);
62 /* called by templates_replace_common */
63 static void templates_replace_default_dates(GString
*text
);
64 static void templates_replace_command(GString
*text
, const gchar
*file_name
,
65 const gchar
*file_type
, const gchar
*func_name
);
68 static gchar
*read_file(const gchar
*locale_fname
)
74 if (! g_file_get_contents(locale_fname
, &contents
, &length
, NULL
))
77 if (! encodings_convert_to_utf8_auto(&contents
, &length
, NULL
, NULL
, NULL
, NULL
))
79 gchar
*utf8_fname
= utils_get_utf8_from_locale(locale_fname
);
81 ui_set_statusbar(TRUE
, _("Failed to convert template file \"%s\" to UTF-8"), utf8_fname
);
87 str
= g_string_new(contents
);
90 /* convert to LF endings for consistency in mixing templates */
91 utils_ensure_same_eol_characters(str
, SC_EOL_LF
);
92 return g_string_free(str
, FALSE
);
96 static void read_template(const gchar
*name
, gint id
)
98 gchar
*fname
= g_build_path(G_DIR_SEPARATOR_S
, app
->configdir
,
99 GEANY_TEMPLATES_SUBDIR
, name
, NULL
);
101 /* try system if user template doesn't exist */
102 if (!g_file_test(fname
, G_FILE_TEST_EXISTS
))
103 SETPTR(fname
, g_build_path(G_DIR_SEPARATOR_S
, app
->datadir
,
104 GEANY_TEMPLATES_SUBDIR
, name
, NULL
));
106 templates
[id
] = read_file(fname
);
111 /* called when inserting templates into an existing document */
112 static void convert_eol_characters(GString
*template, GeanyDocument
*doc
)
116 g_return_if_fail(doc
== NULL
|| doc
->is_valid
);
119 doc
= document_get_current();
121 g_return_if_fail(doc
!= NULL
);
123 doc_eol_mode
= editor_get_eol_char_mode(doc
->editor
);
124 utils_ensure_same_eol_characters(template, doc_eol_mode
);
128 static void init_general_templates(void)
130 /* read the contents */
131 read_template("fileheader", GEANY_TEMPLATE_FILEHEADER
);
132 read_template("gpl", GEANY_TEMPLATE_GPL
);
133 read_template("bsd", GEANY_TEMPLATE_BSD
);
134 read_template("function", GEANY_TEMPLATE_FUNCTION
);
135 read_template("changelog", GEANY_TEMPLATE_CHANGELOG
);
139 void templates_replace_common(GString
*tmpl
, const gchar
*fname
,
140 GeanyFiletype
*ft
, const gchar
*func_name
)
147 shortname
= g_strdup(GEANY_STRING_UNTITLED
);
149 shortname
= g_strconcat(GEANY_STRING_UNTITLED
, ".", ft
->extension
, NULL
);
152 shortname
= g_path_get_basename(fname
);
154 templates_replace_valist(tmpl
,
155 "{filename}", shortname
,
156 "{project}", app
->project
? app
->project
->name
: "",
157 "{description}", app
->project
? app
->project
->description
: "",
161 templates_replace_default_dates(tmpl
);
162 templates_replace_command(tmpl
, fname
, ft
->name
, func_name
);
163 /* Bug: command results could have {ob} {cb} strings in! */
164 /* replace braces last */
165 templates_replace_valist(tmpl
,
172 static gchar
*get_template_from_file(const gchar
*locale_fname
, const gchar
*doc_filename
,
177 content
= read_file(locale_fname
);
182 GString
*template = g_string_new(content
);
184 file_header
= get_template_fileheader(ft
);
185 templates_replace_valist(template,
186 "{fileheader}", file_header
,
188 templates_replace_common(template, doc_filename
, ft
, NULL
);
190 utils_free_pointers(2, file_header
, content
, NULL
);
191 return g_string_free(template, FALSE
);
198 on_new_with_file_template(GtkMenuItem
*menuitem
, G_GNUC_UNUSED gpointer user_data
)
200 gchar
*fname
= ui_menu_item_get_text(menuitem
);
203 const gchar
*extension
= strrchr(fname
, '.'); /* easy way to get the file extension */
204 gchar
*new_filename
= g_strconcat(GEANY_STRING_UNTITLED
, extension
, NULL
);
207 ft
= filetypes_detect_from_extension(fname
);
208 SETPTR(fname
, utils_get_locale_from_utf8(fname
));
210 /* fname is just the basename from the menu item, so prepend the custom files path */
211 path
= g_build_path(G_DIR_SEPARATOR_S
, app
->configdir
, GEANY_TEMPLATES_SUBDIR
,
212 "files", fname
, NULL
);
213 template = get_template_from_file(path
, new_filename
, ft
);
216 /* try the system path */
218 path
= g_build_path(G_DIR_SEPARATOR_S
, app
->datadir
, GEANY_TEMPLATES_SUBDIR
,
219 "files", fname
, NULL
);
220 template = get_template_from_file(path
, new_filename
, ft
);
224 /* line endings will be converted */
225 document_new_file(new_filename
, ft
, template);
229 SETPTR(fname
, utils_get_utf8_from_locale(fname
));
230 ui_set_statusbar(TRUE
, _("Could not find file '%s'."), fname
);
234 g_free(new_filename
);
239 static void add_file_item(const gchar
*fname
, GtkWidget
*menu
)
241 GtkWidget
*tmp_button
;
244 g_return_if_fail(fname
);
245 g_return_if_fail(menu
);
247 label
= utils_get_utf8_from_locale(fname
);
249 tmp_button
= gtk_menu_item_new_with_label(label
);
250 gtk_widget_show(tmp_button
);
251 gtk_container_add(GTK_CONTAINER(menu
), tmp_button
);
252 g_signal_connect(tmp_button
, "activate", G_CALLBACK(on_new_with_file_template
), NULL
);
258 static void populate_file_template_menu(GtkWidget
*menu
)
260 GSList
*list
= utils_get_config_files(GEANY_TEMPLATES_SUBDIR G_DIR_SEPARATOR_S
"files");
263 foreach_slist(node
, list
)
265 gchar
*fname
= node
->data
;
267 add_file_item(fname
, menu
);
274 static void create_file_template_menu(void)
278 new_with_template_menu
= gtk_menu_new();
279 item
= ui_lookup_widget(main_widgets
.window
, "menu_new_with_template1");
280 gtk_menu_item_set_submenu(GTK_MENU_ITEM(item
), new_with_template_menu
);
282 new_with_template_toolbar_menu
= gtk_menu_new();
283 g_object_ref(new_with_template_toolbar_menu
);
284 geany_menu_button_action_set_menu(GEANY_MENU_BUTTON_ACTION(toolbar_get_action_by_name("New")),
285 new_with_template_toolbar_menu
);
289 /* reload templates if any file in the templates path is saved */
290 static void on_document_save(G_GNUC_UNUSED GObject
*object
, GeanyDocument
*doc
)
294 g_return_if_fail(!EMPTY(doc
->real_path
));
296 path
= g_build_filename(app
->configdir
, GEANY_TEMPLATES_SUBDIR
, NULL
);
297 if (strncmp(doc
->real_path
, path
, strlen(path
)) == 0)
299 /* reload templates */
300 templates_free_templates();
307 /* warning: also called when reloading template settings */
308 void templates_init(void)
310 static gboolean init_done
= FALSE
;
312 init_general_templates();
316 create_file_template_menu();
317 g_signal_connect(geany_object
, "document-save", G_CALLBACK(on_document_save
), NULL
);
321 populate_file_template_menu(new_with_template_menu
);
322 populate_file_template_menu(new_with_template_toolbar_menu
);
326 /* indent is used to make some whitespace between comment char and real start of the line
327 * e.g. indent = 8 prints " * here comes the text of the line"
328 * indent is meant to be the whole amount of characters before the real line content follows, i.e.
329 * 6 characters are filled with whitespace when the comment characters include " *" */
330 static void make_comment_block(GString
*comment_text
, gint filetype_idx
, guint indent
)
332 gchar
*frame_start
; /* to add before comment_text */
333 gchar
*frame_end
; /* to add after comment_text */
334 const gchar
*line_prefix
; /* to add before every line in comment_text */
339 gint template_eol_mode
;
340 const gchar
*template_eol_char
;
341 GeanyFiletype
*ft
= filetypes_index(filetype_idx
);
345 g_return_if_fail(comment_text
!= NULL
);
346 g_return_if_fail(ft
!= NULL
);
348 template_eol_mode
= utils_get_line_endings(comment_text
->str
, comment_text
->len
);
349 template_eol_char
= utils_get_eol_char(template_eol_mode
);
351 filetype_get_comment_open_close(ft
, FALSE
, &co
, &cc
);
356 frame_start
= g_strconcat(co
, template_eol_char
, NULL
);
357 frame_end
= g_strconcat(cc
, template_eol_char
, NULL
);
368 { /* use C-like multi-line comments as fallback */
369 frame_start
= g_strconcat("/*", template_eol_char
, NULL
);
370 frame_end
= g_strconcat("*/", template_eol_char
, NULL
);
374 /* do some magic to nicely format C-like multi-line comments */
375 if (!EMPTY(frame_start
) && frame_start
[1] == '*')
377 /* prefix the string with a space */
378 SETPTR(frame_end
, g_strconcat(" ", frame_end
, NULL
));
382 /* construct the real prefix with given amount of whitespace */
383 i
= (indent
> strlen(line_prefix
)) ? (indent
- strlen(line_prefix
)) : strlen(line_prefix
);
384 tmp
= g_strnfill(i
, ' ');
385 prefix
= g_strconcat(line_prefix
, tmp
, NULL
);
388 /* add line_prefix to every line of comment_text */
389 lines
= g_strsplit(comment_text
->str
, template_eol_char
, -1);
390 len
= g_strv_length(lines
);
391 if (len
> 0) /* prevent unsigned wraparound if comment_text is empty */
393 for (i
= 0; i
< len
- 1; i
++)
396 lines
[i
] = g_strconcat(prefix
, tmp
, NULL
);
400 tmp
= g_strjoinv(template_eol_char
, lines
);
402 /* clear old contents */
403 g_string_erase(comment_text
, 0, -1);
406 if (frame_start
!= NULL
)
407 g_string_append(comment_text
, frame_start
);
408 /* add the new main content */
409 g_string_append(comment_text
, tmp
);
410 /* add frame_start */
411 if (frame_end
!= NULL
)
412 g_string_append(comment_text
, frame_end
);
414 utils_free_pointers(4, prefix
, tmp
, frame_start
, frame_end
, NULL
);
419 gchar
*templates_get_template_licence(GeanyDocument
*doc
, gint licence_type
)
423 g_return_val_if_fail(DOC_VALID(doc
), NULL
);
424 g_return_val_if_fail(licence_type
== GEANY_TEMPLATE_GPL
|| licence_type
== GEANY_TEMPLATE_BSD
, NULL
);
426 template = g_string_new(templates
[licence_type
]);
427 replace_static_values(template);
428 templates_replace_default_dates(template);
429 templates_replace_command(template, DOC_FILENAME(doc
), doc
->file_type
->name
, NULL
);
431 make_comment_block(template, doc
->file_type
->id
, GEANY_TEMPLATES_INDENT
);
432 convert_eol_characters(template, doc
);
434 return g_string_free(template, FALSE
);
438 static gchar
*get_template_fileheader(GeanyFiletype
*ft
)
440 GString
*template = g_string_new(templates
[GEANY_TEMPLATE_FILEHEADER
]);
442 filetypes_load_config(ft
->id
, FALSE
); /* load any user extension setting */
444 templates_replace_valist(template,
445 "{gpl}", templates
[GEANY_TEMPLATE_GPL
],
446 "{bsd}", templates
[GEANY_TEMPLATE_BSD
],
449 /* we don't replace other wildcards here otherwise they would get done twice for files */
450 make_comment_block(template, ft
->id
, GEANY_TEMPLATES_INDENT
);
451 return g_string_free(template, FALSE
);
455 /* TODO change the signature to take a GeanyDocument? this would break plugin API/ABI */
457 gchar
*templates_get_template_fileheader(gint filetype_idx
, const gchar
*fname
)
459 GeanyFiletype
*ft
= filetypes
[filetype_idx
];
460 gchar
*str
= get_template_fileheader(ft
);
461 GString
*template = g_string_new(str
);
464 templates_replace_common(template, fname
, ft
, NULL
);
465 convert_eol_characters(template, NULL
);
466 return g_string_free(template, FALSE
);
470 gchar
*templates_get_template_function(GeanyDocument
*doc
, const gchar
*func_name
)
474 func_name
= (func_name
!= NULL
) ? func_name
: "";
475 text
= g_string_new(templates
[GEANY_TEMPLATE_FUNCTION
]);
477 templates_replace_valist(text
, "{functionname}", func_name
, NULL
);
478 templates_replace_default_dates(text
);
479 templates_replace_command(text
, DOC_FILENAME(doc
), doc
->file_type
->name
, func_name
);
481 make_comment_block(text
, doc
->file_type
->id
, GEANY_TEMPLATES_INDENT
);
482 convert_eol_characters(text
, doc
);
484 return g_string_free(text
, FALSE
);
488 gchar
*templates_get_template_changelog(GeanyDocument
*doc
)
491 const gchar
*file_type_name
;
493 g_return_val_if_fail(DOC_VALID(doc
), NULL
);
495 result
= g_string_new(templates
[GEANY_TEMPLATE_CHANGELOG
]);
496 file_type_name
= (doc
->file_type
!= NULL
) ? doc
->file_type
->name
: "";
497 replace_static_values(result
);
498 templates_replace_default_dates(result
);
499 templates_replace_command(result
, DOC_FILENAME(doc
), file_type_name
, NULL
);
500 convert_eol_characters(result
, doc
);
502 return g_string_free(result
, FALSE
);
506 static void free_template_menu_items(GtkWidget
*menu
)
508 GList
*children
, *item
;
510 children
= gtk_container_get_children(GTK_CONTAINER(menu
));
511 foreach_list(item
, children
)
512 gtk_widget_destroy(GTK_WIDGET(item
->data
));
513 g_list_free(children
);
517 void templates_free_templates(void)
521 for (i
= 0; i
< GEANY_MAX_TEMPLATES
; i
++)
522 g_free(templates
[i
]);
523 free_template_menu_items(new_with_template_menu
);
524 free_template_menu_items(new_with_template_toolbar_menu
);
528 static void replace_static_values(GString
*text
)
530 utils_string_replace_all(text
, "{version}", template_prefs
.version
);
531 utils_string_replace_all(text
, "{initial}", template_prefs
.initials
);
532 utils_string_replace_all(text
, "{developer}", template_prefs
.developer
);
533 utils_string_replace_all(text
, "{mail}", template_prefs
.mail
);
534 utils_string_replace_all(text
, "{company}", template_prefs
.company
);
535 utils_string_replace_all(text
, "{untitled}", GEANY_STRING_UNTITLED
);
536 utils_string_replace_all(text
, "{geanyversion}", "Geany " VERSION
);
540 /* Replaces all static template wildcards (version, mail, company, name, ...)
541 * plus those wildcard, value pairs which are passed, e.g.
543 * templates_replace_valist(text, "{some_wildcard}", "some value",
544 * "{another_wildcard}", "another value", NULL);
546 * The argument list must be terminated with NULL. */
547 void templates_replace_valist(GString
*text
, const gchar
*first_wildcard
, ...)
550 const gchar
*key
, *value
;
552 g_return_if_fail(text
!= NULL
);
554 va_start(args
, first_wildcard
);
556 key
= first_wildcard
;
557 value
= va_arg(args
, gchar
*);
561 utils_string_replace_all(text
, key
, value
);
563 key
= va_arg(args
, gchar
*);
564 if (key
== NULL
|| text
== NULL
)
566 value
= va_arg(args
, gchar
*);
570 replace_static_values(text
);
574 static void templates_replace_default_dates(GString
*text
)
576 gchar
*year
= utils_get_date_time(template_prefs
.year_format
, NULL
);
577 gchar
*date
= utils_get_date_time(template_prefs
.date_format
, NULL
);
578 gchar
*datetime
= utils_get_date_time(template_prefs
.datetime_format
, NULL
);
580 g_return_if_fail(text
!= NULL
);
582 templates_replace_valist(text
,
585 "{datetime}", datetime
,
588 utils_free_pointers(3, year
, date
, datetime
, NULL
);
592 static gchar
*run_command(const gchar
*command
, const gchar
*file_name
,
593 const gchar
*file_type
, const gchar
*func_name
)
595 GString
*output
= g_string_new(NULL
);
596 gchar
*result
= NULL
;
597 GError
*error
= NULL
;
600 file_name
= (file_name
!= NULL
) ? file_name
: "";
601 file_type
= (file_type
!= NULL
) ? file_type
: "";
602 func_name
= (func_name
!= NULL
) ? func_name
: "";
604 env
= utils_copy_environment(NULL
,
605 "GEANY_FILENAME", file_name
,
606 "GEANY_FILETYPE", file_type
,
607 "GEANY_FUNCNAME", func_name
,
610 if (spawn_sync(NULL
, command
, NULL
, env
, NULL
, output
, NULL
, NULL
, &error
))
612 result
= g_string_free(output
, FALSE
);
616 g_warning(_("Cannot execute template command \"%s\". "
617 "Hint: incorrect paths in the command are a common cause of errors. "
618 "Error: %s."), command
, error
->message
);
627 static void templates_replace_command(GString
*text
, const gchar
*file_name
,
628 const gchar
*file_type
, const gchar
*func_name
)
632 g_return_if_fail(text
!= NULL
);
634 while ((match
= strstr(text
->str
, "{command:")) != NULL
)
640 while (*match
!= '}' && *match
!= '\0')
643 wildcard
= g_strndup(cmd
, (gsize
) (match
- cmd
+ 1));
644 cmd
= g_strndup(wildcard
+ 9, strlen(wildcard
) - 10);
646 result
= run_command(cmd
, file_name
, file_type
, func_name
);
649 result
= g_strstrip(result
);
650 utils_string_replace_first(text
, wildcard
, result
);
654 utils_string_replace_first(text
, wildcard
, "");