Initial version of glib-compile-resources

This is the basic utility to create resource files, either binary
versions or source files that can be compiled into your app.

gio/Makefile.am

@@ -642,7 +642,18 @@ gioenumtypes.c: $(gio_headers) gioenumtypes.c.template
 gio-2.0.lib: libgio-2.0.la gio.def
 	lib -machine:@LIB_EXE_MACHINE_FLAG@ -name:libgio-2.0-$(LT_CURRENT_MINUS_AGE).dll -def:gio.def -out:$@
 
-bin_PROGRAMS = gio-querymodules glib-compile-schemas gsettings
+bin_PROGRAMS = gio-querymodules glib-compile-schemas glib-compile-resources gsettings
+
+glib_compile_resources_LDADD = \
+	$(top_builddir)/glib/libglib-2.0.la \
+	$(top_builddir)/gobject/libgobject-2.0.la	\
+	libgio-2.0.la
+
+glib_compile_resources_SOURCES = \
+	gvdb/gvdb-format.h		\
+	gvdb/gvdb-builder.h		\
+	gvdb/gvdb-builder.c		\
+	glib-compile-resources.c
 
 gio_querymodules_SOURCES = gio-querymodules.c
 gio_querymodules_LDADD	 = \

gio/glib-compile-resources.c

@@ -0,0 +1,693 @@
+/*
+ * Copyright © 2011 Red Hat, Inc
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the licence, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ *
+ * Author: Alexander Larsson <alexl@redhat.com>
+ */
+
+#include "config.h"
+
+#include <gstdio.h>
+#include <gi18n.h>
+#include <gioenums.h>
+
+#include <string.h>
+#include <stdio.h>
+#include <locale.h>
+
+#include <gio/gmemoryoutputstream.h>
+#include <gio/gzlibcompressor.h>
+#include <gio/gconverteroutputstream.h>
+
+#ifdef HAVE_UNISTD_H
+#include <unistd.h>
+#endif
+
+#include <glib.h>
+#include "gvdb/gvdb-builder.h"
+
+typedef struct
+{
+  char *content;
+  gsize content_size;
+  gsize size;
+  guint32 flags;
+} FileData;
+
+typedef struct
+{
+  GHashTable *table; /* resource path -> FileData */
+
+  /* per gresource */
+  char *prefix;
+
+  /* per file */
+  char *alias;
+  gboolean compressed;
+
+  GString *string;  /* non-NULL when accepting text */
+} ParseState;
+
+gchar *sourcedir = NULL;
+
+static void
+file_data_free (FileData *data)
+{
+  g_free (data->content);
+  g_free (data);
+}
+
+static void
+start_element (GMarkupParseContext  *context,
+	       const gchar          *element_name,
+	       const gchar         **attribute_names,
+	       const gchar         **attribute_values,
+	       gpointer              user_data,
+	       GError              **error)
+{
+  ParseState *state = user_data;
+  const GSList *element_stack;
+  const gchar *container;
+
+  element_stack = g_markup_parse_context_get_element_stack (context);
+  container = element_stack->next ? element_stack->next->data : NULL;
+
+#define COLLECT(first, ...) \
+  g_markup_collect_attributes (element_name,                                 \
+			       attribute_names, attribute_values, error,     \
+			       first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
+#define OPTIONAL   G_MARKUP_COLLECT_OPTIONAL
+#define STRDUP     G_MARKUP_COLLECT_STRDUP
+#define STRING     G_MARKUP_COLLECT_STRING
+#define BOOL       G_MARKUP_COLLECT_BOOLEAN
+#define NO_ATTRS()  COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
+
+  if (container == NULL)
+    {
+      if (strcmp (element_name, "gresources") == 0)
+	return;
+    }
+  else if (strcmp (container, "gresources") == 0)
+    {
+      if (strcmp (element_name, "gresource") == 0)
+	{
+	  COLLECT (OPTIONAL | STRDUP,
+		   "prefix", &state->prefix);
+	  return;
+	}
+    }
+  else if (strcmp (container, "gresource") == 0)
+    {
+      if (strcmp (element_name, "file") == 0)
+	{
+	  COLLECT (OPTIONAL | STRDUP, "alias", &state->alias,
+		   OPTIONAL | BOOL, "compressed", &state->compressed);
+	  state->string = g_string_new ("");
+	  return;
+	}
+    }
+
+  if (container)
+    g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
+		 _("Element <%s> not allowed inside <%s>"),
+		 element_name, container);
+  else
+    g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
+		 _("Element <%s> not allowed at toplevel"), element_name);
+
+}
+
+static GvdbItem *
+get_parent (GHashTable *table,
+	    gchar      *key,
+	    gint        length)
+{
+  GvdbItem *grandparent, *parent;
+
+  if (length == 1)
+    return NULL;
+
+  while (key[--length - 1] != '/');
+  key[length] = '\0';
+
+  parent = g_hash_table_lookup (table, key);
+
+  if (parent == NULL)
+    {
+      parent = gvdb_hash_table_insert (table, key);
+
+      grandparent = get_parent (table, key, length);
+
+      if (grandparent != NULL)
+	gvdb_item_set_parent (parent, grandparent);
+    }
+
+  return parent;
+}
+
+static void
+end_element (GMarkupParseContext  *context,
+	     const gchar          *element_name,
+	     gpointer              user_data,
+	     GError              **error)
+{
+  ParseState *state = user_data;
+  GError *my_error = NULL;
+
+  if (strcmp (element_name, "gresource") == 0)
+    {
+      g_free (state->prefix);
+      state->prefix = NULL;
+    }
+
+  else if (strcmp (element_name, "file") == 0)
+    {
+      gchar *file, *real_file;
+      gchar *key;
+      FileData *data;
+
+      file = state->string->str;
+      key = file;
+      if (state->alias)
+	key = state->alias;
+
+      if (state->prefix)
+	key = g_build_path ("/", "/", state->prefix, key, NULL);
+      else
+	key = g_build_path ("/", "/", key, NULL);
+
+      if (g_hash_table_lookup (state->table, key) != NULL)
+	{
+	  g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
+		       _("File %s appears multiple times in the resource"),
+		       key);
+	  return;
+	}
+
+      data = g_new0 (FileData, 1);
+
+      if (sourcedir != NULL)
+	real_file = g_build_filename (sourcedir, file, NULL);
+      else
+	real_file = g_strdup (file);
+
+      if (!g_file_get_contents (real_file, &data->content, &data->size, &my_error))
+	{
+	  g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
+		       _("Error reading file %s: %s"),
+		       real_file, my_error->message);
+	  g_clear_error (&my_error);
+	  return;
+	}
+      /* Include zero termination in content_size for uncompressed files (but not in size) */
+      data->content_size = data->size + 1;
+
+      if (state->compressed)
+	{
+	  GOutputStream *out = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
+	  GZlibCompressor *compressor =
+	    g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB, 9);
+	  GOutputStream *out2 = g_converter_output_stream_new (out, G_CONVERTER (compressor));
+
+	  if (!g_output_stream_write_all (out2, data->content, data->size,
+					  NULL, NULL, NULL) ||
+	      !g_output_stream_close (out2, NULL, NULL))
+	    {
+	      g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
+			   _("Error compressing file %s"),
+			   real_file);
+	      return;
+	    }
+
+	  g_free (data->content);
+	  data->content_size = g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out));
+	  data->content = g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out));
+
+	  g_object_unref (compressor);
+	  g_object_unref (out);
+	  g_object_unref (out2);
+
+	  data->flags |= G_RESOURCE_FLAGS_COMPRESSED;
+	}
+
+      g_free (real_file);
+
+      g_hash_table_insert (state->table, key, data);
+
+      /* Cleanup */
+
+      g_free (state->alias);
+      state->alias = NULL;
+      g_string_free (state->string, TRUE);
+      state->string = NULL;
+    }
+}
+
+static void
+text (GMarkupParseContext  *context,
+      const gchar          *text,
+      gsize                 text_len,
+      gpointer              user_data,
+      GError              **error)
+{
+  ParseState *state = user_data;
+  gsize i;
+
+  for (i = 0; i < text_len; i++)
+    if (!g_ascii_isspace (text[i]))
+      {
+	if (state->string)
+	  g_string_append_len (state->string, text, text_len);
+
+	else
+	  g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
+		       _("text may not appear inside <%s>"),
+		       g_markup_parse_context_get_element (context));
+
+	break;
+      }
+}
+
+static GHashTable *
+parse_resource_file (const gchar *filename)
+{
+  GMarkupParser parser = { start_element, end_element, text };
+  ParseState state = { 0, };
+  GMarkupParseContext *context;
+  GError *error = NULL;
+  gchar *contents;
+  GHashTable *table = NULL;
+  gsize size;
+
+  if (!g_file_get_contents (filename, &contents, &size, &error))
+    {
+      g_printerr ("%s\n", error->message);
+      g_clear_error (&error);
+      return NULL;
+    }
+
+  state.table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)file_data_free);
+
+  context = g_markup_parse_context_new (&parser,
+					G_MARKUP_TREAT_CDATA_AS_TEXT |
+					G_MARKUP_PREFIX_ERROR_POSITION,
+					&state, NULL);
+
+  if (!g_markup_parse_context_parse (context, contents, size, &error) ||
+      !g_markup_parse_context_end_parse (context, &error))
+    {
+      g_printerr ("%s: %s.\n", filename, error->message);
+      g_clear_error (&error);
+    }
+  else
+    {
+      GHashTableIter iter;
+      const char *key;
+      char *mykey;
+      gsize key_len;
+      FileData *data;
+      GVariant *v_data;
+      GVariantBuilder builder;
+      GvdbItem *item;
+
+      table = gvdb_hash_table_new (NULL, NULL);
+
+      g_hash_table_iter_init (&iter, state.table);
+      while (g_hash_table_iter_next (&iter, (gpointer *)&key, (gpointer *)&data))
+	{
+	  key_len = strlen (key);
+	  mykey = g_strdup (key);
+
+	  item = gvdb_hash_table_insert (table, key);
+	  gvdb_item_set_parent (item,
+				get_parent (table, mykey, key_len));
+
+	  g_free (mykey);
+
+	  g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuay)"));
+
+	  g_variant_builder_add (&builder, "u", data->size); /* Size */
+	  g_variant_builder_add (&builder, "u", data->flags); /* Flags */
+
+	  v_data = g_variant_new_from_data (G_VARIANT_TYPE("ay"),
+					    data->content, data->content_size, TRUE,
+					    g_free, data->content);
+	  g_variant_builder_add_value (&builder, v_data);
+	  data->content = NULL; /* Take ownership */
+
+	  gvdb_item_set_value (item,
+			       g_variant_builder_end (&builder));
+	}
+    }
+
+  g_hash_table_destroy (state.table);
+  g_markup_parse_context_free (context);
+  g_free (contents);
+
+  return table;
+}
+
+static gboolean
+write_to_file (GHashTable   *table,
+	       const gchar  *filename,
+	       GError      **error)
+{
+  gboolean success;
+
+  success = gvdb_table_write_contents (table, filename,
+				       G_BYTE_ORDER != G_LITTLE_ENDIAN,
+				       error);
+
+  return success;
+}
+
+int
+main (int argc, char **argv)
+{
+  GError *error;
+  GHashTable *table;
+  gchar *srcfile;
+  gchar *target = NULL;
+  gchar *binary_target;
+  gboolean generate_source = FALSE;
+  gboolean generate_header = FALSE;
+  gboolean manual_register = FALSE;
+  char *c_name = NULL;
+  GOptionContext *context;
+  GOptionEntry entries[] = {
+    { "target", 0, 0, G_OPTION_ARG_FILENAME, &target, N_("name of the output file"), N_("FILE") },
+    { "sourcedir", 0, 0, G_OPTION_ARG_FILENAME, &sourcedir, N_("The directory where files are to be read from (default to current directory)"), N_("DIRECTORY") },
+    { "generate-header", 0, 0, G_OPTION_ARG_NONE, &generate_header, N_("Generate source header"), NULL },
+    { "generate-source", 0, 0, G_OPTION_ARG_NONE, &generate_source, N_("Generate sourcecode used to link in the resource file into your code"), NULL },
+    { "manual-register", 0, 0, G_OPTION_ARG_NONE, &manual_register, N_("Don't automatically create and register resource"), NULL },
+    { "c-name", 0, 0, G_OPTION_ARG_STRING, &c_name, N_("C identifier name used for the generated source code"), NULL },
+    { NULL }
+  };
+
+#ifdef G_OS_WIN32
+  extern gchar *_glib_get_locale_dir (void);
+  gchar *tmp;
+#endif
+
+  setlocale (LC_ALL, "");
+  textdomain (GETTEXT_PACKAGE);
+
+#ifdef G_OS_WIN32
+  tmp = _glib_get_locale_dir ();
+  bindtextdomain (GETTEXT_PACKAGE, tmp);
+  g_free (tmp);
+#else
+  bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
+#endif
+
+#ifdef HAVE_BIND_TEXTDOMAIN_CODESET
+  bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
+#endif
+
+  g_type_init ();
+
+  context = g_option_context_new (N_("FILE"));
+  g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
+  g_option_context_set_summary (context,
+    N_("Compile a resource specification into a resource file.\n"
+       "Resource specification files have the extension .gresource.xml,\n"
+       "and the resource file have the extension called .gresource."));
+  g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
+
+  error = NULL;
+  if (!g_option_context_parse (context, &argc, &argv, &error))
+    {
+      g_printerr ("%s\n", error->message);
+      return 1;
+    }
+
+  g_option_context_free (context);
+
+  if (argc != 2)
+    {
+      g_printerr (_("You should give exactly one file name\n"));
+      return 1;
+    }
+
+  srcfile = argv[1];
+
+  if (sourcedir == NULL)
+    sourcedir = "";
+
+  if (target == NULL)
+    {
+      char *dirname = g_path_get_dirname (srcfile);
+      char *base = g_path_get_basename (srcfile);
+      char *target_basename;
+      if (g_str_has_suffix (base, ".xml"))
+	base[strlen(base) - strlen (".xml")] = 0;
+
+      if (generate_source)
+	{
+	  if (g_str_has_suffix (base, ".gresource"))
+	    base[strlen(base) - strlen (".gresource")] = 0;
+	  target_basename = g_strconcat (base, ".c", NULL);
+	}
+      else
+	{
+	  if (g_str_has_suffix (base, ".gresource"))
+	    target_basename = g_strdup (base);
+	  else
+	    target_basename = g_strconcat (base, ".gresource", NULL);
+	}
+
+      target = g_build_filename (dirname, target_basename, NULL);
+      g_free (target_basename);
+      g_free (dirname);
+      g_free (base);
+    }
+
+  if ((table = parse_resource_file (srcfile)) == NULL)
+    {
+      g_free (target);
+      return 1;
+    }
+
+  if (generate_source || generate_header)
+    {
+      if (generate_source)
+	{
+	  int fd = g_file_open_tmp (NULL, &binary_target, NULL);
+	  if (fd == -1)
+	    {
+	      g_printerr ("Can't open temp file\n");
+	      return 1;
+	    }
+	  close (fd);
+	}
+      else
+	binary_target = NULL;
+
+      if (c_name == NULL)
+	{
+	  char *base = g_path_get_basename (srcfile);
+	  GString *s;
+	  char *dot;
+	  int i;
+
+	  /* Remove extensions */
+	  dot = strchr (base, '.');
+	  if (dot)
+	    *dot = 0;
+
+	  s = g_string_new ("");
+
+	  for (i = 0; base[i] != 0; i++)
+	    {
+	      const char *first = G_CSET_A_2_Z G_CSET_a_2_z "_";
+	      const char *rest = G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_";
+	      if (strchr ((i == 0) ? first : rest, base[i]) != NULL)
+		g_string_append_c (s, base[i]);
+	      else if (base[i] == '-')
+		g_string_append_c (s, '_');
+
+	    }
+
+	  c_name = g_string_free (s, FALSE);
+	}
+    }
+  else
+    binary_target = g_strdup (target);
+
+  if (binary_target != NULL &&
+      !write_to_file (table, binary_target, &error))
+    {
+      g_printerr ("%s\n", error->message);
+      g_free (target);
+      return 1;
+    }
+
+  if (generate_header)
+    {
+      FILE *file;
+
+      file = fopen (target, "w");
+      if (file == NULL)
+	{
+	  g_printerr ("can't write to file %s", target);
+	  return 1;
+	}
+
+      fprintf (file,
+	       "#ifndef __RESOURCE_%s_H__\n"
+	       "#define __RESOURCE_%s_H__\n"
+	       "\n"
+	       "#include <gio/gio.h>\n"
+	       "\n"
+	       "extern GResource *%s_resource;\n",
+	       c_name, c_name, c_name);
+
+      if (manual_register)
+	fprintf (file,
+		 "\n"
+		 "extern void %s_register_resource (void);\n"
+		 "extern void %s_unregister_resource (void);\n"
+		 "\n",
+		 c_name, c_name);
+
+      fprintf (file,
+	       "#endif\n");
+
+      fclose (file);
+    }
+  else if (generate_source)
+    {
+      FILE *file;
+      guint8 *data;
+      gsize data_size;
+      gsize i;
+      char *static_str;
+
+      if (!g_file_get_contents (binary_target, (char **)&data,
+				&data_size, NULL))
+	{
+	  g_printerr ("can't read back temporary file");
+	  return 1;
+	}
+      g_unlink (binary_target);
+
+      file = fopen (target, "w");
+      if (file == NULL)
+	{
+	  g_printerr ("can't write to file %s", target);
+	  return 1;
+	}
+
+      fprintf (file,
+	       "#include <gio/gio.h>\n"
+	       "\n"
+	       "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
+	       "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
+	       "#else\n"
+	       "# define SECTION\n"
+	       "#endif\n"
+	       "\n"
+	       "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT"]; const double alignment; void * const ptr;}  %s_resource_data = { {\n",
+	       c_name, data_size, c_name);
+
+      for (i = 0; i < data_size; i++) {
+	if (i % 8 == 0)
+	  fprintf (file, "  ");
+	fprintf (file, "0x%2.2x", (int)data[i]);
+	if (i != data_size - 1)
+	  fprintf (file, ", ");
+	if ((i % 8 == 7) || (i == data_size - 1))
+	  fprintf (file, "\n");
+      }
+
+      fprintf (file, "} };\n");
+
+      if (manual_register)
+	{
+	  static_str = "";
+	}
+      else
+	{
+	  static_str = "static ";
+	  fprintf (file,
+		   "\n"
+		   "#ifdef G_HAS_CONSTRUCTORS\n"
+		   "\n"
+		   "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
+		   "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
+		   "#endif\n"
+		   "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
+		   "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
+		   "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
+		   "#endif\n"
+		   "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
+		   "\n"
+		   "#else\n"
+		   "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
+		   "#endif\n"
+		   "\n");
+	}
+
+      fprintf (file,
+	       "\n"
+	       "GResource *%s_resource = NULL;\n"
+	       "\n"
+	       "%svoid %s_unregister_resource (void)\n"
+	       "{\n"
+	       "  if (%s_resource)\n"
+	       "    {\n"
+	       "      g_resources_unregister (%s_resource);\n"
+	       "      g_resource_unref (%s_resource);\n"
+	       "      %s_resource = NULL;\n"
+	       "    }\n"
+	       "}\n"
+	       "\n"
+	       "%svoid %s_register_resource (void)\n"
+	       "{\n"
+	       "  if (%s_resource == NULL)\n"
+	       "    {\n"
+	       "      GBytes *bytes = g_bytes_new_static (%s_resource_data.data, sizeof (%s_resource_data.data));\n"
+	       "      %s_resource = g_resource_new_from_data (bytes, NULL);\n"
+	       "      if (%s_resource)\n"
+	       "        g_resources_register (%s_resource);\n"
+	       "       g_bytes_unref (bytes);\n"
+	       "    }\n"
+	       "}\n", c_name, static_str, c_name, c_name, c_name, c_name, c_name, static_str, c_name, c_name, c_name, c_name, c_name, c_name, c_name);
+
+      if (!manual_register)
+	fprintf (file,
+		 "\n"
+		 "static void resource_constructor (void)\n"
+		 "{\n"
+		 "  %s_register_resource ();\n"
+		 "}\n"
+		 "\n"
+		 "static void resource_destructor (void)\n"
+		 "{\n"
+		 "  %s_unregister_resource ();\n"
+		 "}\n", c_name, c_name);
+
+      fclose (file);
+    }
+
+  g_free (binary_target);
+
+
+  g_free (target);
+
+  return 0;
+}