2 * Copyright © 2011 Red Hat, Inc
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Alexander Larsson <alexl@redhat.com>
36 #ifdef HAVE_SYS_WAIT_H
40 #include <gio/gmemoryoutputstream.h>
41 #include <gio/gzlibcompressor.h>
42 #include <gio/gconverteroutputstream.h>
49 #include "gvdb/gvdb-builder.h"
51 #include "gconstructor_as_data.h"
64 GHashTable *table; /* resource path -> FileData */
66 gboolean collect_data;
74 char *preproc_options;
76 GString *string; /* non-NULL when accepting text */
79 static gchar **sourcedirs = NULL;
80 static gchar *xmllint = NULL;
81 static gchar *gdk_pixbuf_pixdata = NULL;
84 file_data_free (FileData *data)
86 g_free (data->filename);
87 g_free (data->content);
92 start_element (GMarkupParseContext *context,
93 const gchar *element_name,
94 const gchar **attribute_names,
95 const gchar **attribute_values,
99 ParseState *state = user_data;
100 const GSList *element_stack;
101 const gchar *container;
103 element_stack = g_markup_parse_context_get_element_stack (context);
104 container = element_stack->next ? element_stack->next->data : NULL;
106 #define COLLECT(first, ...) \
107 g_markup_collect_attributes (element_name, \
108 attribute_names, attribute_values, error, \
109 first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
110 #define OPTIONAL G_MARKUP_COLLECT_OPTIONAL
111 #define STRDUP G_MARKUP_COLLECT_STRDUP
112 #define STRING G_MARKUP_COLLECT_STRING
113 #define BOOL G_MARKUP_COLLECT_BOOLEAN
114 #define NO_ATTRS() COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
116 if (container == NULL)
118 if (strcmp (element_name, "gresources") == 0)
121 else if (strcmp (container, "gresources") == 0)
123 if (strcmp (element_name, "gresource") == 0)
125 COLLECT (OPTIONAL | STRDUP,
126 "prefix", &state->prefix);
130 else if (strcmp (container, "gresource") == 0)
132 if (strcmp (element_name, "file") == 0)
134 COLLECT (OPTIONAL | STRDUP, "alias", &state->alias,
135 OPTIONAL | BOOL, "compressed", &state->compressed,
136 OPTIONAL | STRDUP, "preprocess", &state->preproc_options);
137 state->string = g_string_new ("");
143 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
144 _("Element <%s> not allowed inside <%s>"),
145 element_name, container);
147 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
148 _("Element <%s> not allowed at toplevel"), element_name);
153 get_parent (GHashTable *table,
157 GvdbItem *grandparent, *parent;
162 while (key[--length - 1] != '/');
165 parent = g_hash_table_lookup (table, key);
169 parent = gvdb_hash_table_insert (table, key);
171 grandparent = get_parent (table, key, length);
173 if (grandparent != NULL)
174 gvdb_item_set_parent (parent, grandparent);
181 find_file (const gchar *filename)
187 if (g_path_is_absolute (filename))
188 return g_strdup (filename);
190 /* search all the sourcedirs for the correct files in order */
191 for (i = 0; sourcedirs[i] != NULL; i++)
193 real_file = g_build_filename (sourcedirs[i], filename, NULL);
194 exists = g_file_test (real_file, G_FILE_TEST_EXISTS);
203 end_element (GMarkupParseContext *context,
204 const gchar *element_name,
208 ParseState *state = user_data;
209 GError *my_error = NULL;
211 if (strcmp (element_name, "gresource") == 0)
213 g_free (state->prefix);
214 state->prefix = NULL;
217 else if (strcmp (element_name, "file") == 0)
219 gchar *file, *real_file;
222 char *tmp_file = NULL;
223 char *tmp_file2 = NULL;
225 file = state->string->str;
231 key = g_build_path ("/", "/", state->prefix, key, NULL);
233 key = g_build_path ("/", "/", key, NULL);
235 if (g_hash_table_lookup (state->table, key) != NULL)
237 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
238 _("File %s appears multiple times in the resource"),
243 data = g_new0 (FileData, 1);
245 if (sourcedirs != NULL)
247 real_file = find_file (file);
248 if (real_file == NULL)
250 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
251 _("Failed to locate '%s' in any source directory"), file);
258 exists = g_file_test (file, G_FILE_TEST_EXISTS);
261 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
262 _("Failed to locate '%s' in current directory"), file);
265 real_file = g_strdup (file);
268 data->filename = g_strdup (real_file);
269 if (!state->collect_data)
272 if (state->preproc_options)
275 gchar *stderr_child = NULL;
277 gboolean xml_stripblanks = FALSE;
278 gboolean to_pixdata = FALSE;
280 options = g_strsplit (state->preproc_options, ",", -1);
282 for (i = 0; options[i]; i++)
284 if (!strcmp (options[i], "xml-stripblanks"))
285 xml_stripblanks = TRUE;
286 else if (!strcmp (options[i], "to-pixdata"))
290 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
291 _("Unknown processing option \"%s\""), options[i]);
292 g_strfreev (options);
296 g_strfreev (options);
298 if (xml_stripblanks && xmllint != NULL)
301 int status, fd, argc;
303 tmp_file = g_strdup ("resource-XXXXXXXX");
304 if ((fd = g_mkstemp (tmp_file)) == -1)
308 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
309 _("Failed to create temp file: %s"),
318 argv[argc++] = (gchar *) xmllint;
319 argv[argc++] = "--nonet";
320 argv[argc++] = "--noblanks";
321 argv[argc++] = "--output";
322 argv[argc++] = tmp_file;
323 argv[argc++] = real_file;
325 g_assert (argc <= G_N_ELEMENTS (argv));
327 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
328 G_SPAWN_STDOUT_TO_DEV_NULL,
329 NULL, NULL, NULL, &stderr_child, &status, &my_error))
331 g_propagate_error (error, my_error);
334 #ifdef HAVE_SYS_WAIT_H
335 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
337 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
338 _("Error processing input file with xmllint:\n%s"), stderr_child);
343 g_free (stderr_child);
345 real_file = g_strdup (tmp_file);
351 gchar *stderr_child = NULL;
352 int status, fd, argc;
354 if (gdk_pixbuf_pixdata == NULL)
356 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
357 "to-pixbuf preprocessing requested but GDK_PIXBUF_PIXDATA "
358 "not set and gdk-pixbuf-pixdata not found in path");
362 tmp_file2 = g_strdup ("resource-XXXXXXXX");
363 if ((fd = g_mkstemp (tmp_file2)) == -1)
367 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
368 _("Failed to create temp file: %s"),
377 argv[argc++] = (gchar *) gdk_pixbuf_pixdata;
378 argv[argc++] = real_file;
379 argv[argc++] = tmp_file2;
381 g_assert (argc <= G_N_ELEMENTS (argv));
383 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
384 G_SPAWN_STDOUT_TO_DEV_NULL,
385 NULL, NULL, NULL, &stderr_child, &status, &my_error))
387 g_propagate_error (error, my_error);
390 #ifdef HAVE_SYS_WAIT_H
391 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
393 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
394 _("Error processing input file with to-pixdata:\n%s"), stderr_child);
399 g_free (stderr_child);
401 real_file = g_strdup (tmp_file2);
405 if (!g_file_get_contents (real_file, &data->content, &data->size, &my_error))
407 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
408 _("Error reading file %s: %s"),
409 real_file, my_error->message);
410 g_clear_error (&my_error);
413 /* Include zero termination in content_size for uncompressed files (but not in size) */
414 data->content_size = data->size + 1;
416 if (state->compressed)
418 GOutputStream *out = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
419 GZlibCompressor *compressor =
420 g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB, 9);
421 GOutputStream *out2 = g_converter_output_stream_new (out, G_CONVERTER (compressor));
423 if (!g_output_stream_write_all (out2, data->content, data->size,
425 !g_output_stream_close (out2, NULL, NULL))
427 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
428 _("Error compressing file %s"),
433 g_free (data->content);
434 data->content_size = g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out));
435 data->content = g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out));
437 g_object_unref (compressor);
438 g_object_unref (out);
439 g_object_unref (out2);
441 data->flags |= G_RESOURCE_FLAGS_COMPRESSED;
446 g_hash_table_insert (state->table, key, data);
451 g_free (state->alias);
453 g_string_free (state->string, TRUE);
454 state->string = NULL;
455 g_free (state->preproc_options);
456 state->preproc_options = NULL;
475 text (GMarkupParseContext *context,
481 ParseState *state = user_data;
484 for (i = 0; i < text_len; i++)
485 if (!g_ascii_isspace (text[i]))
488 g_string_append_len (state->string, text, text_len);
491 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
492 _("text may not appear inside <%s>"),
493 g_markup_parse_context_get_element (context));
500 parse_resource_file (const gchar *filename,
501 gboolean collect_data)
503 GMarkupParser parser = { start_element, end_element, text };
504 ParseState state = { 0, };
505 GMarkupParseContext *context;
506 GError *error = NULL;
508 GHashTable *table = NULL;
511 if (!g_file_get_contents (filename, &contents, &size, &error))
513 g_printerr ("%s\n", error->message);
514 g_clear_error (&error);
518 state.table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)file_data_free);
519 state.collect_data = collect_data;
521 context = g_markup_parse_context_new (&parser,
522 G_MARKUP_TREAT_CDATA_AS_TEXT |
523 G_MARKUP_PREFIX_ERROR_POSITION,
526 if (!g_markup_parse_context_parse (context, contents, size, &error) ||
527 !g_markup_parse_context_end_parse (context, &error))
529 g_printerr ("%s: %s.\n", filename, error->message);
530 g_clear_error (&error);
532 else if (collect_data)
540 GVariantBuilder builder;
543 table = gvdb_hash_table_new (NULL, NULL);
545 g_hash_table_iter_init (&iter, state.table);
546 while (g_hash_table_iter_next (&iter, (gpointer *)&key, (gpointer *)&data))
548 key_len = strlen (key);
549 mykey = g_strdup (key);
551 item = gvdb_hash_table_insert (table, key);
552 gvdb_item_set_parent (item,
553 get_parent (table, mykey, key_len));
557 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuay)"));
559 g_variant_builder_add (&builder, "u", data->size); /* Size */
560 g_variant_builder_add (&builder, "u", data->flags); /* Flags */
562 v_data = g_variant_new_from_data (G_VARIANT_TYPE("ay"),
563 data->content, data->content_size, TRUE,
564 g_free, data->content);
565 g_variant_builder_add_value (&builder, v_data);
566 data->content = NULL; /* Take ownership */
568 gvdb_item_set_value (item,
569 g_variant_builder_end (&builder));
574 table = g_hash_table_ref (state.table);
577 g_hash_table_unref (state.table);
578 g_markup_parse_context_free (context);
585 write_to_file (GHashTable *table,
586 const gchar *filename,
591 success = gvdb_table_write_contents (table, filename,
592 G_BYTE_ORDER != G_LITTLE_ENDIAN,
599 main (int argc, char **argv)
604 gchar *target = NULL;
605 gchar *binary_target = NULL;
606 gboolean generate_automatic = FALSE;
607 gboolean generate_source = FALSE;
608 gboolean generate_header = FALSE;
609 gboolean manual_register = FALSE;
610 gboolean generate_dependencies = FALSE;
612 char *c_name_no_underscores;
613 GOptionContext *context;
614 GOptionEntry entries[] = {
615 { "target", 0, 0, G_OPTION_ARG_FILENAME, &target, N_("name of the output file"), N_("FILE") },
616 { "sourcedir", 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &sourcedirs, N_("The directories where files are to be read from (default to current directory)"), N_("DIRECTORY") },
617 { "generate", 0, 0, G_OPTION_ARG_NONE, &generate_automatic, N_("Generate output in the format selected for by the target filename extension"), NULL },
618 { "generate-header", 0, 0, G_OPTION_ARG_NONE, &generate_header, N_("Generate source header"), NULL },
619 { "generate-source", 0, 0, G_OPTION_ARG_NONE, &generate_source, N_("Generate sourcecode used to link in the resource file into your code"), NULL },
620 { "generate-dependencies", 0, 0, G_OPTION_ARG_NONE, &generate_dependencies, N_("Generate dependency list"), NULL },
621 { "manual-register", 0, 0, G_OPTION_ARG_NONE, &manual_register, N_("Don't automatically create and register resource"), NULL },
622 { "c-name", 0, 0, G_OPTION_ARG_STRING, &c_name, N_("C identifier name used for the generated source code"), NULL },
627 extern gchar *_glib_get_locale_dir (void);
631 setlocale (LC_ALL, "");
632 textdomain (GETTEXT_PACKAGE);
635 tmp = _glib_get_locale_dir ();
636 bindtextdomain (GETTEXT_PACKAGE, tmp);
639 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
642 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
643 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
648 context = g_option_context_new (N_("FILE"));
649 g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
650 g_option_context_set_summary (context,
651 N_("Compile a resource specification into a resource file.\n"
652 "Resource specification files have the extension .gresource.xml,\n"
653 "and the resource file have the extension called .gresource."));
654 g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
657 if (!g_option_context_parse (context, &argc, &argv, &error))
659 g_printerr ("%s\n", error->message);
663 g_option_context_free (context);
667 g_printerr (_("You should give exactly one file name\n"));
673 xmllint = g_strdup (g_getenv ("XMLLINT"));
675 xmllint = g_find_program_in_path ("xmllint");
677 g_printerr ("XMLLINT not set and xmllint not found in path; skipping xml preprocessing.\n");
679 gdk_pixbuf_pixdata = g_strdup (g_getenv ("GDK_PIXBUF_PIXDATA"));
680 if (gdk_pixbuf_pixdata == NULL)
681 gdk_pixbuf_pixdata = g_find_program_in_path ("gdk-pixbuf-pixdata");
685 char *dirname = g_path_get_dirname (srcfile);
686 char *base = g_path_get_basename (srcfile);
687 char *target_basename;
688 if (g_str_has_suffix (base, ".xml"))
689 base[strlen(base) - strlen (".xml")] = 0;
693 if (g_str_has_suffix (base, ".gresource"))
694 base[strlen(base) - strlen (".gresource")] = 0;
695 target_basename = g_strconcat (base, ".c", NULL);
699 if (g_str_has_suffix (base, ".gresource"))
700 target_basename = g_strdup (base);
702 target_basename = g_strconcat (base, ".gresource", NULL);
705 target = g_build_filename (dirname, target_basename, NULL);
706 g_free (target_basename);
710 else if (generate_automatic)
712 if (g_str_has_suffix (target, ".c"))
713 generate_source = TRUE;
714 else if (g_str_has_suffix (target, ".h"))
715 generate_header = TRUE;
716 else if (g_str_has_suffix (target, ".gresource"))
720 if ((table = parse_resource_file (srcfile, !generate_dependencies)) == NULL)
726 if (generate_dependencies)
732 g_hash_table_iter_init (&iter, table);
733 while (g_hash_table_iter_next (&iter, &key, &data))
736 g_print ("%s\n",file_data->filename);
739 else if (generate_source || generate_header)
743 int fd = g_file_open_tmp (NULL, &binary_target, NULL);
746 g_printerr ("Can't open temp file\n");
754 char *base = g_path_get_basename (srcfile);
759 /* Remove extensions */
760 dot = strchr (base, '.');
764 s = g_string_new ("");
766 for (i = 0; base[i] != 0; i++)
768 const char *first = G_CSET_A_2_Z G_CSET_a_2_z "_";
769 const char *rest = G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_";
770 if (strchr ((i == 0) ? first : rest, base[i]) != NULL)
771 g_string_append_c (s, base[i]);
772 else if (base[i] == '-')
773 g_string_append_c (s, '_');
777 c_name = g_string_free (s, FALSE);
781 binary_target = g_strdup (target);
783 c_name_no_underscores = c_name;
784 while (c_name_no_underscores && *c_name_no_underscores == '_')
785 c_name_no_underscores++;
787 if (binary_target != NULL &&
788 !write_to_file (table, binary_target, &error))
790 g_printerr ("%s\n", error->message);
799 file = fopen (target, "w");
802 g_printerr ("can't write to file %s", target);
807 "#ifndef __RESOURCE_%s_H__\n"
808 "#define __RESOURCE_%s_H__\n"
810 "#include <gio/gio.h>\n"
812 "extern GResource *%s_get_resource (void);\n",
813 c_name, c_name, c_name);
818 "extern void %s_register_resource (void);\n"
819 "extern void %s_unregister_resource (void);\n"
828 else if (generate_source)
835 if (!g_file_get_contents (binary_target, (char **)&data,
838 g_printerr ("can't read back temporary file");
841 g_unlink (binary_target);
843 file = fopen (target, "w");
846 g_printerr ("can't write to file %s", target);
851 "#include <gio/gio.h>\n"
853 "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
854 "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
859 "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT"]; const double alignment; void * const ptr;} %s_resource_data = { {\n",
860 c_name_no_underscores, data_size, c_name);
862 for (i = 0; i < data_size; i++) {
865 fprintf (file, "0x%2.2x", (int)data[i]);
866 if (i != data_size - 1)
867 fprintf (file, ", ");
868 if ((i % 8 == 7) || (i == data_size - 1))
869 fprintf (file, "\n");
872 fprintf (file, "} };\n");
876 "static GStaticResource static_resource = { %s_resource_data.data, sizeof (%s_resource_data.data) };\n"
877 "extern GResource *%s_get_resource (void);\n"
878 "GResource *%s_get_resource (void)\n"
880 " return g_static_resource_get_resource (&static_resource);\n"
882 c_name, c_name, c_name, c_name);
889 "extern void %s_unregister_resource (void);\n"
890 "void %s_unregister_resource (void)\n"
892 " g_static_resource_fini (&static_resource);\n"
895 "extern void %s_register_resource (void);\n"
896 "void %s_register_resource (void)\n"
898 " g_static_resource_init (&static_resource);\n"
900 c_name, c_name, c_name, c_name);
904 fprintf (file, "%s", gconstructor_code);
907 "#ifdef G_HAS_CONSTRUCTORS\n"
909 "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
910 "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
912 "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
913 "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
914 "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
916 "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
919 "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
922 "static void resource_constructor (void)\n"
924 " g_static_resource_init (&static_resource);\n"
927 "static void resource_destructor (void)\n"
929 " g_static_resource_fini (&static_resource);\n"
938 g_free (binary_target);
940 g_hash_table_destroy (table);