src/templates.c

   1 /*
   2  *      templates.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  * Templates to insert into the current document, or file templates to create a new
  24  * document from.
  25  */
  26
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include "templates.h"
  32
  33 #include "app.h"
  34 #include "document.h"
  35 #include "encodingsprivate.h"
  36 #include "filetypes.h"
  37 #include "geany.h"
  38 #include "geanymenubuttonaction.h"
  39 #include "geanyobject.h"
  40 #include "spawn.h"
  41 #include "support.h"
  42 #include "toolbar.h"
  43 #include "ui_utils.h"
  44 #include "utils.h"
  45
  46 #include "gtkcompat.h"
  47
  48 #include <time.h>
  49 #include <string.h>
  50
  51
  52 GeanyTemplatePrefs template_prefs;
  53
  54 static GtkWidget *new_with_template_menu = NULL;
  55 static GtkWidget *new_with_template_toolbar_menu = NULL;
  56
  57 /* TODO: implement custom insertion templates instead? */
  58 static gchar *templates[GEANY_MAX_TEMPLATES];
  59
  60
  61 static void replace_static_values(GString *text);
  62 static gchar *get_template_fileheader(GeanyFiletype *ft);
  63
  64 /* called by templates_replace_common */
  65 static void templates_replace_default_dates(GString *text);
  66 static void templates_replace_command(GString *text, const gchar *file_name,
  67         const gchar *file_type, const gchar *func_name);
  68
  69
  70 static gchar *read_file(const gchar *locale_fname)
  71 {
  72         gchar *contents;
  73         gsize length;
  74         GString *str;
  75
  76         if (! g_file_get_contents(locale_fname, &contents, &length, NULL))
  77                 return NULL;
  78
  79         if (! encodings_convert_to_utf8_auto(&contents, &length, NULL, NULL, NULL, NULL))
  80         {
  81                 gchar *utf8_fname = utils_get_utf8_from_locale(locale_fname);
  82
  83                 ui_set_statusbar(TRUE, _("Failed to convert template file \"%s\" to UTF-8"), utf8_fname);
  84                 g_free(utf8_fname);
  85                 g_free(contents);
  86                 return NULL;
  87         }
  88
  89         str = g_string_new(contents);
  90         g_free(contents);
  91
  92         /* convert to LF endings for consistency in mixing templates */
  93         utils_ensure_same_eol_characters(str, SC_EOL_LF);
  94         return g_string_free(str, FALSE);
  95 }
  96
  97
  98 static void read_template(const gchar *name, gint id)
  99 {
 100         gchar *fname = g_build_path(G_DIR_SEPARATOR_S, app->configdir,
 101                 GEANY_TEMPLATES_SUBDIR, name, NULL);
 102
 103         /* try system if user template doesn't exist */
 104         if (!g_file_test(fname, G_FILE_TEST_EXISTS))
 105                 SETPTR(fname, g_build_path(G_DIR_SEPARATOR_S, app->datadir,
 106                         GEANY_TEMPLATES_SUBDIR, name, NULL));
 107
 108         templates[id] = read_file(fname);
 109         g_free(fname);
 110 }
 111
 112
 113 /* called when inserting templates into an existing document */
 114 static void convert_eol_characters(GString *template, GeanyDocument *doc)
 115 {
 116         gint doc_eol_mode;
 117
 118         g_return_if_fail(doc == NULL || doc->is_valid);
 119
 120         if (doc == NULL)
 121                 doc = document_get_current();
 122
 123         g_return_if_fail(doc != NULL);
 124
 125         doc_eol_mode = editor_get_eol_char_mode(doc->editor);
 126         utils_ensure_same_eol_characters(template, doc_eol_mode);
 127 }
 128
 129
 130 static void init_general_templates(void)
 131 {
 132         /* read the contents */
 133         read_template("fileheader", GEANY_TEMPLATE_FILEHEADER);
 134         read_template("gpl", GEANY_TEMPLATE_GPL);
 135         read_template("bsd", GEANY_TEMPLATE_BSD);
 136         read_template("function", GEANY_TEMPLATE_FUNCTION);
 137         read_template("changelog", GEANY_TEMPLATE_CHANGELOG);
 138 }
 139
 140
 141 void templates_replace_common(GString *tmpl, const gchar *fname,
 142                                                           GeanyFiletype *ft, const gchar *func_name)
 143 {
 144         gchar *shortname;
 145
 146         if (fname == NULL)
 147         {
 148                 if (!ft->extension)
 149                         shortname = g_strdup(GEANY_STRING_UNTITLED);
 150                 else
 151                         shortname = g_strconcat(GEANY_STRING_UNTITLED, ".", ft->extension, NULL);
 152         }
 153         else
 154                 shortname = g_path_get_basename(fname);
 155
 156         templates_replace_valist(tmpl,
 157                 "{filename}", shortname,
 158                 "{project}", app->project ? app->project->name : "",
 159                 "{description}", app->project ? app->project->description : "",
 160                 NULL);
 161         g_free(shortname);
 162
 163         templates_replace_default_dates(tmpl);
 164         templates_replace_command(tmpl, fname, ft->name, func_name);
 165         /* Bug: command results could have {ob} {cb} strings in! */
 166         /* replace braces last */
 167         templates_replace_valist(tmpl,
 168                 "{ob}", "{",
 169                 "{cb}", "}",
 170                 NULL);
 171 }
 172
 173
 174 static gchar *get_template_from_file(const gchar *locale_fname, const gchar *doc_filename,
 175                                                                          GeanyFiletype *ft)
 176 {
 177         gchar *content;
 178
 179         content = read_file(locale_fname);
 180
 181         if (content != NULL)
 182         {
 183                 gchar *file_header;
 184                 GString *template = g_string_new(content);
 185
 186                 file_header = get_template_fileheader(ft);
 187                 templates_replace_valist(template,
 188                         "{fileheader}", file_header,
 189                         NULL);
 190                 templates_replace_common(template, doc_filename, ft, NULL);
 191
 192                 utils_free_pointers(2, file_header, content, NULL);
 193                 return g_string_free(template, FALSE);
 194         }
 195         return NULL;
 196 }
 197
 198
 199 static void
 200 on_new_with_file_template(GtkMenuItem *menuitem, G_GNUC_UNUSED gpointer user_data)
 201 {
 202         gchar *fname = ui_menu_item_get_text(menuitem);
 203         GeanyFiletype *ft;
 204         gchar *template;
 205         const gchar *extension = strrchr(fname, '.'); /* easy way to get the file extension */
 206         gchar *new_filename = g_strconcat(GEANY_STRING_UNTITLED, extension, NULL);
 207         gchar *path;
 208
 209         ft = filetypes_detect_from_extension(fname);
 210         SETPTR(fname, utils_get_locale_from_utf8(fname));
 211
 212         /* fname is just the basename from the menu item, so prepend the custom files path */
 213         path = g_build_path(G_DIR_SEPARATOR_S, app->configdir, GEANY_TEMPLATES_SUBDIR,
 214                 "files", fname, NULL);
 215         template = get_template_from_file(path, new_filename, ft);
 216         if (!template)
 217         {
 218                 /* try the system path */
 219                 g_free(path);
 220                 path = g_build_path(G_DIR_SEPARATOR_S, app->datadir, GEANY_TEMPLATES_SUBDIR,
 221                         "files", fname, NULL);
 222                 template = get_template_from_file(path, new_filename, ft);
 223         }
 224         if (template)
 225         {
 226                 /* line endings will be converted */
 227                 document_new_file(new_filename, ft, template);
 228         }
 229         else
 230         {
 231                 SETPTR(fname, utils_get_utf8_from_locale(fname));
 232                 ui_set_statusbar(TRUE, _("Could not find file '%s'."), fname);
 233         }
 234         g_free(template);
 235         g_free(path);
 236         g_free(new_filename);
 237         g_free(fname);
 238 }
 239
 240
 241 static void add_file_item(const gchar *fname, GtkWidget *menu)
 242 {
 243         GtkWidget *tmp_button;
 244         gchar *label;
 245
 246         g_return_if_fail(fname);
 247         g_return_if_fail(menu);
 248
 249         label = utils_get_utf8_from_locale(fname);
 250
 251         tmp_button = gtk_menu_item_new_with_label(label);
 252         gtk_widget_show(tmp_button);
 253         gtk_container_add(GTK_CONTAINER(menu), tmp_button);
 254         g_signal_connect(tmp_button, "activate", G_CALLBACK(on_new_with_file_template), NULL);
 255
 256         g_free(label);
 257 }
 258
 259
 260 static void populate_file_template_menu(GtkWidget *menu)
 261 {
 262         GSList *list = utils_get_config_files(GEANY_TEMPLATES_SUBDIR G_DIR_SEPARATOR_S "files");
 263         GSList *node;
 264
 265         foreach_slist(node, list)
 266         {
 267                 gchar *fname = node->data;
 268
 269                 add_file_item(fname, menu);
 270                 g_free(fname);
 271         }
 272         g_slist_free(list);
 273 }
 274
 275
 276 static void create_file_template_menu(void)
 277 {
 278         GtkWidget *item;
 279
 280         new_with_template_menu = gtk_menu_new();
 281         item = ui_lookup_widget(main_widgets.window, "menu_new_with_template1");
 282         gtk_menu_item_set_submenu(GTK_MENU_ITEM(item), new_with_template_menu);
 283
 284         new_with_template_toolbar_menu = gtk_menu_new();
 285         g_object_ref(new_with_template_toolbar_menu);
 286         geany_menu_button_action_set_menu(GEANY_MENU_BUTTON_ACTION(toolbar_get_action_by_name("New")),
 287                 new_with_template_toolbar_menu);
 288 }
 289
 290
 291 /* reload templates if any file in the templates path is saved */
 292 static void on_document_save(G_GNUC_UNUSED GObject *object, GeanyDocument *doc)
 293 {
 294         gchar *path;
 295
 296         g_return_if_fail(!EMPTY(doc->real_path));
 297
 298         path = g_build_filename(app->configdir, GEANY_TEMPLATES_SUBDIR, NULL);
 299         if (strncmp(doc->real_path, path, strlen(path)) == 0)
 300         {
 301                 /* reload templates */
 302                 templates_free_templates();
 303                 templates_init();
 304         }
 305         g_free(path);
 306 }
 307
 308
 309 /* warning: also called when reloading template settings */
 310 void templates_init(void)
 311 {
 312         static gboolean init_done = FALSE;
 313
 314         init_general_templates();
 315
 316         if (!init_done)
 317         {
 318                 create_file_template_menu();
 319                 g_signal_connect(geany_object, "document-save", G_CALLBACK(on_document_save), NULL);
 320                 init_done = TRUE;
 321         }
 322
 323         populate_file_template_menu(new_with_template_menu);
 324         populate_file_template_menu(new_with_template_toolbar_menu);
 325 }
 326
 327
 328 /* indent is used to make some whitespace between comment char and real start of the line
 329  * e.g. indent = 8 prints " *     here comes the text of the line"
 330  * indent is meant to be the whole amount of characters before the real line content follows, i.e.
 331  * 6 characters are filled with whitespace when the comment characters include " *" */
 332 static void make_comment_block(GString *comment_text, gint filetype_idx, guint indent)
 333 {
 334         gchar *frame_start;                     /* to add before comment_text */
 335         gchar *frame_end;                       /* to add after comment_text */
 336         const gchar *line_prefix;       /* to add before every line in comment_text */
 337         gchar *tmp;
 338         gchar *prefix;
 339         gchar **lines;
 340         gsize i, len;
 341         gint template_eol_mode;
 342         const gchar *template_eol_char;
 343         GeanyFiletype *ft = filetypes_index(filetype_idx);
 344         const gchar *co;
 345         const gchar *cc;
 346
 347         g_return_if_fail(comment_text != NULL);
 348         g_return_if_fail(ft != NULL);
 349
 350         template_eol_mode = utils_get_line_endings(comment_text->str, comment_text->len);
 351         template_eol_char = utils_get_eol_char(template_eol_mode);
 352
 353         filetype_get_comment_open_close(ft, FALSE, &co, &cc);
 354         if (!EMPTY(co))
 355         {
 356                 if (!EMPTY(cc))
 357                 {
 358                         frame_start = g_strconcat(co, template_eol_char, NULL);
 359                         frame_end = g_strconcat(cc, template_eol_char, NULL);
 360                         line_prefix = "";
 361                 }
 362                 else
 363                 {
 364                         frame_start = NULL;
 365                         frame_end = NULL;
 366                         line_prefix = co;
 367                 }
 368         }
 369         else
 370         {       /* use C-like multi-line comments as fallback */
 371                 frame_start = g_strconcat("/*", template_eol_char, NULL);
 372                 frame_end = g_strconcat("*/", template_eol_char, NULL);
 373                 line_prefix = "";
 374         }
 375
 376         /* do some magic to nicely format C-like multi-line comments */
 377         if (!EMPTY(frame_start) && frame_start[1] == '*')
 378         {
 379                 /* prefix the string with a space */
 380                 SETPTR(frame_end, g_strconcat(" ", frame_end, NULL));
 381                 line_prefix = " *";
 382         }
 383
 384         /* construct the real prefix with given amount of whitespace */
 385         i = (indent > strlen(line_prefix)) ? (indent - strlen(line_prefix)) : strlen(line_prefix);
 386         tmp = g_strnfill(i, ' ');
 387         prefix = g_strconcat(line_prefix, tmp, NULL);
 388         g_free(tmp);
 389
 390         /* add line_prefix to every line of comment_text */
 391         lines = g_strsplit(comment_text->str, template_eol_char, -1);
 392         len = g_strv_length(lines);
 393         if (len > 0)    /* prevent unsigned wraparound if comment_text is empty */
 394         {
 395                 for (i = 0; i < len - 1; i++)
 396                 {
 397                         tmp = lines[i];
 398                         lines[i] = g_strconcat(prefix, tmp, NULL);
 399                         g_free(tmp);
 400                 }
 401         }
 402         tmp = g_strjoinv(template_eol_char, lines);
 403
 404         /* clear old contents */
 405         g_string_erase(comment_text, 0, -1);
 406
 407         /* add frame_end */
 408         if (frame_start != NULL)
 409                 g_string_append(comment_text, frame_start);
 410         /* add the new main content */
 411         g_string_append(comment_text, tmp);
 412         /* add frame_start  */
 413         if (frame_end != NULL)
 414                 g_string_append(comment_text, frame_end);
 415
 416         utils_free_pointers(4, prefix, tmp, frame_start, frame_end, NULL);
 417         g_strfreev(lines);
 418 }
 419
 420
 421 gchar *templates_get_template_licence(GeanyDocument *doc, gint licence_type)
 422 {
 423         GString *template;
 424
 425         g_return_val_if_fail(DOC_VALID(doc), NULL);
 426         g_return_val_if_fail(licence_type == GEANY_TEMPLATE_GPL || licence_type == GEANY_TEMPLATE_BSD, NULL);
 427
 428         template = g_string_new(templates[licence_type]);
 429         replace_static_values(template);
 430         templates_replace_default_dates(template);
 431         templates_replace_command(template, DOC_FILENAME(doc), doc->file_type->name, NULL);
 432
 433         make_comment_block(template, doc->file_type->id, GEANY_TEMPLATES_INDENT);
 434         convert_eol_characters(template, doc);
 435
 436         return g_string_free(template, FALSE);
 437 }
 438
 439
 440 static gchar *get_template_fileheader(GeanyFiletype *ft)
 441 {
 442         GString *template = g_string_new(templates[GEANY_TEMPLATE_FILEHEADER]);
 443
 444         filetypes_load_config(ft->id, FALSE);   /* load any user extension setting */
 445
 446         templates_replace_valist(template,
 447                 "{gpl}", templates[GEANY_TEMPLATE_GPL],
 448                 "{bsd}", templates[GEANY_TEMPLATE_BSD],
 449                 NULL);
 450
 451         /* we don't replace other wildcards here otherwise they would get done twice for files */
 452         make_comment_block(template, ft->id, GEANY_TEMPLATES_INDENT);
 453         return g_string_free(template, FALSE);
 454 }
 455
 456
 457 /* TODO change the signature to take a GeanyDocument? this would break plugin API/ABI */
 458 GEANY_API_SYMBOL
 459 gchar *templates_get_template_fileheader(gint filetype_idx, const gchar *fname)
 460 {
 461         GeanyFiletype *ft = filetypes[filetype_idx];
 462         gchar *str = get_template_fileheader(ft);
 463         GString *template = g_string_new(str);
 464
 465         g_free(str);
 466         templates_replace_common(template, fname, ft, NULL);
 467         convert_eol_characters(template, NULL);
 468         return g_string_free(template, FALSE);
 469 }
 470
 471
 472 gchar *templates_get_template_function(GeanyDocument *doc, const gchar *func_name)
 473 {
 474         GString *text;
 475
 476         func_name = (func_name != NULL) ? func_name : "";
 477         text = g_string_new(templates[GEANY_TEMPLATE_FUNCTION]);
 478
 479         templates_replace_valist(text, "{functionname}", func_name, NULL);
 480         templates_replace_default_dates(text);
 481         templates_replace_command(text, DOC_FILENAME(doc), doc->file_type->name, func_name);
 482
 483         make_comment_block(text, doc->file_type->id, GEANY_TEMPLATES_INDENT);
 484         convert_eol_characters(text, doc);
 485
 486         return g_string_free(text, FALSE);
 487 }
 488
 489
 490 gchar *templates_get_template_changelog(GeanyDocument *doc)
 491 {
 492         GString *result;
 493         const gchar *file_type_name;
 494
 495         g_return_val_if_fail(DOC_VALID(doc), NULL);
 496
 497         result = g_string_new(templates[GEANY_TEMPLATE_CHANGELOG]);
 498         file_type_name = (doc->file_type != NULL) ? doc->file_type->name : "";
 499         replace_static_values(result);
 500         templates_replace_default_dates(result);
 501         templates_replace_command(result, DOC_FILENAME(doc), file_type_name, NULL);
 502         convert_eol_characters(result, doc);
 503
 504         return g_string_free(result, FALSE);
 505 }
 506
 507
 508 static void free_template_menu_items(GtkWidget *menu)
 509 {
 510         GList *children, *item;
 511
 512         children = gtk_container_get_children(GTK_CONTAINER(menu));
 513         foreach_list(item, children)
 514                 gtk_widget_destroy(GTK_WIDGET(item->data));
 515         g_list_free(children);
 516 }
 517
 518
 519 void templates_free_templates(void)
 520 {
 521         gint i;
 522
 523         for (i = 0; i < GEANY_MAX_TEMPLATES; i++)
 524                 g_free(templates[i]);
 525         free_template_menu_items(new_with_template_menu);
 526         free_template_menu_items(new_with_template_toolbar_menu);
 527 }
 528
 529
 530 static void replace_static_values(GString *text)
 531 {
 532         utils_string_replace_all(text, "{version}", template_prefs.version);
 533         utils_string_replace_all(text, "{initial}", template_prefs.initials);
 534         utils_string_replace_all(text, "{developer}", template_prefs.developer);
 535         utils_string_replace_all(text, "{mail}", template_prefs.mail);
 536         utils_string_replace_all(text, "{company}", template_prefs.company);
 537         utils_string_replace_all(text, "{untitled}", GEANY_STRING_UNTITLED);
 538         utils_string_replace_all(text, "{geanyversion}", "Geany " VERSION);
 539 }
 540
 541
 542 /* Replaces all static template wildcards (version, mail, company, name, ...)
 543  * plus those wildcard, value pairs which are passed, e.g.
 544  *
 545  * templates_replace_valist(text, "{some_wildcard}", "some value",
 546  *      "{another_wildcard}", "another value", NULL);
 547  *
 548  * The argument list must be terminated with NULL. */
 549 void templates_replace_valist(GString *text, const gchar *first_wildcard, ...)
 550 {
 551         va_list args;
 552         const gchar *key, *value;
 553
 554         g_return_if_fail(text != NULL);
 555
 556         va_start(args, first_wildcard);
 557
 558         key = first_wildcard;
 559         value = va_arg(args, gchar*);
 560
 561         while (key != NULL)
 562         {
 563                 utils_string_replace_all(text, key, value);
 564
 565                 key = va_arg(args, gchar*);
 566                 if (key == NULL || text == NULL)
 567                         break;
 568                 value = va_arg(args, gchar*);
 569         }
 570         va_end(args);
 571
 572         replace_static_values(text);
 573 }
 574
 575
 576 static void templates_replace_default_dates(GString *text)
 577 {
 578         gchar *year = utils_get_date_time(template_prefs.year_format, NULL);
 579         gchar *date = utils_get_date_time(template_prefs.date_format, NULL);
 580         gchar *datetime = utils_get_date_time(template_prefs.datetime_format, NULL);
 581
 582         g_return_if_fail(text != NULL);
 583
 584         templates_replace_valist(text,
 585                 "{year}", year,
 586                 "{date}", date,
 587                 "{datetime}", datetime,
 588                 NULL);
 589
 590         utils_free_pointers(3, year, date, datetime, NULL);
 591 }
 592
 593
 594 static gchar *run_command(const gchar *command, const gchar *file_name,
 595                                                   const gchar *file_type, const gchar *func_name)
 596 {
 597         GString *output = g_string_new(NULL);
 598         gchar *result = NULL;
 599         GError *error = NULL;
 600         gchar **env;
 601
 602         file_name = (file_name != NULL) ? file_name : "";
 603         file_type = (file_type != NULL) ? file_type : "";
 604         func_name = (func_name != NULL) ? func_name : "";
 605
 606         env = utils_copy_environment(NULL,
 607                 "GEANY_FILENAME", file_name,
 608                 "GEANY_FILETYPE", file_type,
 609                 "GEANY_FUNCNAME", func_name,
 610                 NULL);
 611
 612         if (spawn_sync(NULL, command, NULL, env, NULL, output, NULL, NULL, &error))
 613         {
 614                 result = g_string_free(output, FALSE);
 615         }
 616         else
 617         {
 618                 g_warning(_("Cannot execute template command \"%s\". "
 619                         "Hint: incorrect paths in the command are a common cause of errors. "
 620                         "Error: %s."), command, error->message);
 621                 g_error_free(error);
 622         }
 623
 624         g_strfreev(env);
 625         return result;
 626 }
 627
 628
 629 static void templates_replace_command(GString *text, const gchar *file_name,
 630                                                            const gchar *file_type, const gchar *func_name)
 631 {
 632         gchar *match;
 633
 634         g_return_if_fail(text != NULL);
 635
 636         while ((match = strstr(text->str, "{command:")) != NULL)
 637         {
 638                 gchar *wildcard;
 639                 gchar *cmd = match;
 640                 gchar *result;
 641
 642                 while (*match != '}' && *match != '\0')
 643                         match++;
 644
 645                 wildcard = g_strndup(cmd, (gsize) (match - cmd + 1));
 646                 cmd = g_strndup(wildcard + 9, strlen(wildcard) - 10);
 647
 648                 result = run_command(cmd, file_name, file_type, func_name);
 649                 if (result != NULL)
 650                 {
 651                         result = g_strstrip(result);
 652                         utils_string_replace_first(text, wildcard, result);
 653                         g_free(result);
 654                 }
 655                 else
 656                         utils_string_replace_first(text, wildcard, "");
 657
 658                 g_free(wildcard);
 659                 g_free(cmd);
 660         }
 661 }