Move general templates from source code into files.

Load general templates from system path instead of creating them in
the user's config dir.



git-svn-id: https://geany.svn.sourceforge.net/svnroot/geany/branches/unstable@5012 ea778897-0a13-0410-b9d1-a72fbfd435f5

ChangeLog

+2010-06-09  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
+
+ * src/templates.c, data/templates/gpl, data/templates/function,
+   data/templates/changelog, data/templates/bsd,
+   data/templates/fileheader, wscript, Makefile.am:
+   Move general templates from source code into files.
+   Load general templates from system path instead of creating them in
+   the user's config dir.
+
+
 2010-06-08  Nick Treleaven  <nick(dot)treleaven(at)btinternet(dot)com>
 
  * Makefile.am:

Makefile.am

@@ -22,6 +22,7 @@ SYS_DATA_FILES = \
 	data/filetype_extensions.conf \
 	data/snippets.conf \
 	data/ui_toolbar.xml \
+	$(srcdir)/data/templates/* \
 	$(srcdir)/data/templates/files/*
 
 EXTRA_DIST = \
@@ -63,6 +64,11 @@ install-data-local:
 	  fi \
 	done
 	$(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/templates;
+	for file in $(srcdir)/data/templates/*; do \
+	  if test -f $$file; then \
+	    $(INSTALL_DATA) $$file $(DESTDIR)$(pkgdatadir)/templates/; \
+	  fi \
+	done
 	$(mkinstalldirs) $(DESTDIR)$(pkgdatadir)/templates/files;
 	for file in $(srcdir)/data/templates/files/*; do \
 	  if test -f $$file; then \

data/templates/bsd

+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above
+  copyright notice, this list of conditions and the following disclaimer
+  in the documentation and/or other materials provided with the
+  distribution.
+* Neither the name of the {company} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/templates/changelog

+{date}  {developer}  <{mail}>
+
+ * 
+
+
+

data/templates/fileheader

+{filename}
+
+Copyright {year} {developer} <{mail}>
+
+{gpl}

data/templates/function

+
+name: {functionname}
+@param
+@return
+

data/templates/gpl

+This program is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
+MA 02110-1301, USA.
+

src/templates.c

@@ -102,11 +102,6 @@ name: {functionname}\n\
 @return\n\
 ";
 
-static const gchar templates_multiline[] = "\
- \n\
- \n\
-";
-
 static const gchar templates_fileheader[] = "\
 {filename}\n\
 \n\
@@ -145,24 +140,30 @@ static void templates_replace_command(GString *text, const gchar *file_name,
 	g_file_get_contents(fname, contents_ptr, NULL, NULL);
 
 
-static void create_template_file_if_necessary(const gchar *filename, const gchar *content)
+static void read_template(const gchar *name, gint id)
 {
-	if (! g_file_test(filename, G_FILE_TEST_EXISTS))
+	gchar *fname = TEMPLATES_GET_FILENAME(name);
+
+	/* try system if user template doesn't exist */
+	if (!g_file_test(fname, G_FILE_TEST_EXISTS))
+		setptr(fname, g_strconcat(app->datadir,
+			G_DIR_SEPARATOR_S GEANY_TEMPLATES_SUBDIR G_DIR_SEPARATOR_S, name, NULL));
+
+	TEMPLATES_READ_FILE(fname, &templates[id]);
+
+	/* FIXME: we should replace the line ends on insertion with doc pref, not on loading */
+	if (file_prefs.default_eol_character != SC_EOL_LF)
 	{
-		if (file_prefs.default_eol_character != SC_EOL_LF)
-		{
-			/* Replace the \n characters in the default template text by the proper
-			 * platform-specific line ending characters. */
-			GString *tmp = g_string_new(content);
-			const gchar *eol_str = (file_prefs.default_eol_character == SC_EOL_CR) ? "\r" : "\r\n";
-
-			utils_string_replace_all(tmp, "\n", eol_str);
-			utils_write_file(filename, tmp->str);
-			g_string_free(tmp, TRUE);
-		}
-		else
-			utils_write_file(filename, content);
+		/* Replace the \n characters in the default template text by the proper
+		 * platform-specific line ending characters. */
+		GString *tmp = g_string_new(templates[id]);
+		const gchar *eol_str = (file_prefs.default_eol_character == SC_EOL_CR) ? "\r" : "\r\n";
+
+		utils_string_replace_all(tmp, "\n", eol_str);
+		setptr(templates[id], tmp->str);
+		g_string_free(tmp, FALSE);
 	}
+	g_free(fname);
 }
 
 
@@ -189,41 +190,18 @@ static gchar *replace_all(gchar *text, const gchar *year, const gchar *date, con
 
 static void init_general_templates(const gchar *year, const gchar *date, const gchar *datetime)
 {
-	gchar *template_filename_fileheader = TEMPLATES_GET_FILENAME("fileheader");
-	gchar *template_filename_gpl = TEMPLATES_GET_FILENAME("gpl");
-	gchar *template_filename_bsd = TEMPLATES_GET_FILENAME("bsd");
-	gchar *template_filename_function = TEMPLATES_GET_FILENAME("function");
-	gchar *template_filename_changelog = TEMPLATES_GET_FILENAME("changelog");
-
-	/* create the template files in the configuration directory, if they don't exist */
-	create_template_file_if_necessary(template_filename_fileheader, templates_fileheader);
-	create_template_file_if_necessary(template_filename_gpl, templates_gpl_notice);
-	create_template_file_if_necessary(template_filename_bsd, templates_bsd_notice);
-	create_template_file_if_necessary(template_filename_function, templates_function_description);
-	create_template_file_if_necessary(template_filename_changelog, templates_changelog);
+	guint id;
 
 	/* read the contents */
-	TEMPLATES_READ_FILE(template_filename_fileheader, &templates[GEANY_TEMPLATE_FILEHEADER]);
-	templates[GEANY_TEMPLATE_FILEHEADER] = replace_all(templates[GEANY_TEMPLATE_FILEHEADER], year, date, datetime);
-
-	TEMPLATES_READ_FILE(template_filename_gpl, &templates[GEANY_TEMPLATE_GPL]);
-	templates[GEANY_TEMPLATE_GPL] = replace_all(templates[GEANY_TEMPLATE_GPL], year, date, datetime);
-
-	TEMPLATES_READ_FILE(template_filename_bsd, &templates[GEANY_TEMPLATE_BSD]);
-	templates[GEANY_TEMPLATE_BSD] = replace_all(templates[GEANY_TEMPLATE_BSD], year, date, datetime);
-
-	TEMPLATES_READ_FILE(template_filename_function, &templates[GEANY_TEMPLATE_FUNCTION]);
-	templates[GEANY_TEMPLATE_FUNCTION] = replace_all(templates[GEANY_TEMPLATE_FUNCTION], year, date, datetime);
-
-	TEMPLATES_READ_FILE(template_filename_changelog, &templates[GEANY_TEMPLATE_CHANGELOG]);
-	templates[GEANY_TEMPLATE_CHANGELOG] = replace_all(templates[GEANY_TEMPLATE_CHANGELOG], year, date, datetime);
-
-	/* free the whole stuff */
-	g_free(template_filename_fileheader);
-	g_free(template_filename_gpl);
-	g_free(template_filename_bsd);
-	g_free(template_filename_function);
-	g_free(template_filename_changelog);
+	read_template("fileheader", GEANY_TEMPLATE_FILEHEADER);
+	read_template("gpl", GEANY_TEMPLATE_GPL);
+	read_template("bsd", GEANY_TEMPLATE_BSD);
+	read_template("function", GEANY_TEMPLATE_FUNCTION);
+	read_template("changelog", GEANY_TEMPLATE_CHANGELOG);
+
+	/* FIXME: we should replace the dates on insertion, not on loading */
+	for (id = 0; id < GEANY_MAX_TEMPLATES; id++)
+		templates[id] = replace_all(templates[id], year, date, datetime);
 }
 
 

wscript

@@ -518,6 +518,7 @@ def build(bld):
 	bld.install_files('${DATADIR}/%s' % dir, 'data/*.tags')
 	bld.install_files('${DATADIR}/%s' % dir, 'data/snippets.conf')
 	bld.install_files('${DATADIR}/%s' % dir, 'data/ui_toolbar.xml')
+	bld.install_files('${DATADIR}/%s/templates' % dir, 'data/templates/*')
 	bld.install_files('${DATADIR}/%s/templates/files' % dir, 'data/templates/files/*.*')
 	bld.install_as('${DATADIR}/%s/GPL-2' % dir, 'COPYING')
 	# Icons