src/templates.h

   1 /*
   2  *      templates.h - 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
  18  *      along with this program; if not, write to the Free Software
  19  *      Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  */
  21
  22 /**
  23  * @file templates.h
  24  * Templates (prefs).
  25  **/
  26
  27
  28 #ifndef GEANY_TEMPLATES_H
  29 #define GEANY_TEMPLATES_H 1
  30
  31 G_BEGIN_DECLS
  32
  33 #define GEANY_TEMPLATES_INDENT 3
  34
  35 enum
  36 {
  37         GEANY_TEMPLATE_GPL = 0,
  38         GEANY_TEMPLATE_BSD,
  39         GEANY_TEMPLATE_FILEHEADER,
  40         GEANY_TEMPLATE_CHANGELOG,
  41         GEANY_TEMPLATE_FUNCTION,
  42         GEANY_MAX_TEMPLATES
  43 };
  44
  45
  46 /** Template preferences. */
  47 typedef struct GeanyTemplatePrefs
  48 {
  49         gchar                   *developer;     /**< Name */
  50         gchar                   *company;       /**< Company */
  51         gchar                   *mail;          /**< Email */
  52         gchar                   *initials;      /**< Initials */
  53         gchar                   *version;       /**< Initial version */
  54         gchar                   *year_format;
  55         gchar                   *date_format;
  56         gchar                   *datetime_format;
  57 }
  58 GeanyTemplatePrefs;
  59
  60 extern GeanyTemplatePrefs template_prefs;
  61
  62
  63 struct filetype;
  64
  65 void templates_init(void);
  66
  67 gchar *templates_get_template_fileheader(gint filetype_idx, const gchar *fname);
  68
  69 gchar *templates_get_template_changelog(GeanyDocument *doc);
  70
  71 gchar *templates_get_template_function(GeanyDocument *doc, const gchar *func_name);
  72
  73 gchar *templates_get_template_licence(GeanyDocument *doc, gint licence_type);
  74
  75 void templates_replace_common(GString *tmpl, const gchar *fname,
  76         GeanyFiletype *ft, const gchar *func_name);
  77
  78 void templates_replace_valist(GString *text,
  79         const gchar *first_wildcard, ...) G_GNUC_NULL_TERMINATED;
  80
  81 void templates_free_templates(void);
  82
  83 G_END_DECLS
  84
  85 #endif