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>
37 #include <gio/gmemoryoutputstream.h>
38 #include <gio/gzlibcompressor.h>
39 #include <gio/gconverteroutputstream.h>
46 #include "gvdb/gvdb-builder.h"
48 #include "gconstructor_as_data.h"
61 GHashTable *table; /* resource path -> FileData */
63 gboolean collect_data;
71 char *preproc_options;
73 GString *string; /* non-NULL when accepting text */
76 static gchar **sourcedirs = NULL;
77 static gchar *xmllint = NULL;
78 static gchar *gdk_pixbuf_pixdata = NULL;
81 file_data_free (FileData *data)
83 g_free (data->filename);
84 g_free (data->content);
89 start_element (GMarkupParseContext *context,
90 const gchar *element_name,
91 const gchar **attribute_names,
92 const gchar **attribute_values,
96 ParseState *state = user_data;
97 const GSList *element_stack;
98 const gchar *container;
100 element_stack = g_markup_parse_context_get_element_stack (context);
101 container = element_stack->next ? element_stack->next->data : NULL;
103 #define COLLECT(first, ...) \
104 g_markup_collect_attributes (element_name, \
105 attribute_names, attribute_values, error, \
106 first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
107 #define OPTIONAL G_MARKUP_COLLECT_OPTIONAL
108 #define STRDUP G_MARKUP_COLLECT_STRDUP
109 #define STRING G_MARKUP_COLLECT_STRING
110 #define BOOL G_MARKUP_COLLECT_BOOLEAN
111 #define NO_ATTRS() COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
113 if (container == NULL)
115 if (strcmp (element_name, "gresources") == 0)
118 else if (strcmp (container, "gresources") == 0)
120 if (strcmp (element_name, "gresource") == 0)
122 COLLECT (OPTIONAL | STRDUP,
123 "prefix", &state->prefix);
127 else if (strcmp (container, "gresource") == 0)
129 if (strcmp (element_name, "file") == 0)
131 COLLECT (OPTIONAL | STRDUP, "alias", &state->alias,
132 OPTIONAL | BOOL, "compressed", &state->compressed,
133 OPTIONAL | STRDUP, "preprocess", &state->preproc_options);
134 state->string = g_string_new ("");
140 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
141 _("Element <%s> not allowed inside <%s>"),
142 element_name, container);
144 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
145 _("Element <%s> not allowed at toplevel"), element_name);
150 get_parent (GHashTable *table,
154 GvdbItem *grandparent, *parent;
159 while (key[--length - 1] != '/');
162 parent = g_hash_table_lookup (table, key);
166 parent = gvdb_hash_table_insert (table, key);
168 grandparent = get_parent (table, key, length);
170 if (grandparent != NULL)
171 gvdb_item_set_parent (parent, grandparent);
178 find_file (const gchar *filename)
184 if (g_path_is_absolute (filename))
185 return g_strdup (filename);
187 /* search all the sourcedirs for the correct files in order */
188 for (i = 0; sourcedirs[i] != NULL; i++)
190 real_file = g_build_filename (sourcedirs[i], filename, NULL);
191 exists = g_file_test (real_file, G_FILE_TEST_EXISTS);
200 end_element (GMarkupParseContext *context,
201 const gchar *element_name,
205 ParseState *state = user_data;
206 GError *my_error = NULL;
208 if (strcmp (element_name, "gresource") == 0)
210 g_free (state->prefix);
211 state->prefix = NULL;
214 else if (strcmp (element_name, "file") == 0)
216 gchar *file, *real_file;
219 char *tmp_file = NULL;
220 char *tmp_file2 = NULL;
222 file = state->string->str;
228 key = g_build_path ("/", "/", state->prefix, key, NULL);
230 key = g_build_path ("/", "/", key, NULL);
232 if (g_hash_table_lookup (state->table, key) != NULL)
234 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
235 _("File %s appears multiple times in the resource"),
240 data = g_new0 (FileData, 1);
242 if (sourcedirs != NULL)
244 real_file = find_file (file);
245 if (real_file == NULL)
247 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
248 _("Failed to locate '%s' in any source directory"), file);
255 exists = g_file_test (file, G_FILE_TEST_EXISTS);
258 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
259 _("Failed to locate '%s' in current directory"), file);
262 real_file = g_strdup (file);
265 data->filename = g_strdup (real_file);
266 if (!state->collect_data)
269 if (state->preproc_options)
273 gboolean xml_stripblanks = FALSE;
274 gboolean to_pixdata = FALSE;
276 options = g_strsplit (state->preproc_options, ",", -1);
278 for (i = 0; options[i]; i++)
280 if (!strcmp (options[i], "xml-stripblanks"))
281 xml_stripblanks = TRUE;
282 else if (!strcmp (options[i], "to-pixdata"))
286 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
287 _("Unknown processing option \"%s\""), options[i]);
288 g_strfreev (options);
292 g_strfreev (options);
294 if (xml_stripblanks && xmllint != NULL)
297 int status, fd, argc;
298 gchar *stderr_child = NULL;
300 tmp_file = g_strdup ("resource-XXXXXXXX");
301 if ((fd = g_mkstemp (tmp_file)) == -1)
305 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
306 _("Failed to create temp file: %s"),
315 argv[argc++] = (gchar *) xmllint;
316 argv[argc++] = "--nonet";
317 argv[argc++] = "--noblanks";
318 argv[argc++] = "--output";
319 argv[argc++] = tmp_file;
320 argv[argc++] = real_file;
322 g_assert (argc <= G_N_ELEMENTS (argv));
324 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
325 G_SPAWN_STDOUT_TO_DEV_NULL,
326 NULL, NULL, NULL, &stderr_child, &status, &my_error))
328 g_propagate_error (error, my_error);
332 /* Ugly...we shoud probably just let stderr be inherited */
333 if (!g_spawn_check_exit_status (status, NULL))
335 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
336 _("Error processing input file with xmllint:\n%s"), stderr_child);
337 g_free (stderr_child);
341 g_free (stderr_child);
343 real_file = g_strdup (tmp_file);
349 gchar *stderr_child = NULL;
350 int status, fd, argc;
352 if (gdk_pixbuf_pixdata == NULL)
354 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
355 "to-pixbuf preprocessing requested but GDK_PIXBUF_PIXDATA "
356 "not set and gdk-pixbuf-pixdata not found in path");
360 tmp_file2 = g_strdup ("resource-XXXXXXXX");
361 if ((fd = g_mkstemp (tmp_file2)) == -1)
365 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
366 _("Failed to create temp file: %s"),
375 argv[argc++] = (gchar *) gdk_pixbuf_pixdata;
376 argv[argc++] = real_file;
377 argv[argc++] = tmp_file2;
379 g_assert (argc <= G_N_ELEMENTS (argv));
381 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
382 G_SPAWN_STDOUT_TO_DEV_NULL,
383 NULL, NULL, NULL, &stderr_child, &status, &my_error))
385 g_propagate_error (error, my_error);
389 if (!g_spawn_check_exit_status (status, NULL))
391 g_set_error (error, G_IO_ERROR, G_IO_ERROR_FAILED,
392 _("Error processing input file with to-pixdata:\n%s"), stderr_child);
393 g_free (stderr_child);
397 g_free (stderr_child);
399 real_file = g_strdup (tmp_file2);
403 if (!g_file_get_contents (real_file, &data->content, &data->size, &my_error))
405 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
406 _("Error reading file %s: %s"),
407 real_file, my_error->message);
408 g_clear_error (&my_error);
411 /* Include zero termination in content_size for uncompressed files (but not in size) */
412 data->content_size = data->size + 1;
414 if (state->compressed)
416 GOutputStream *out = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
417 GZlibCompressor *compressor =
418 g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB, 9);
419 GOutputStream *out2 = g_converter_output_stream_new (out, G_CONVERTER (compressor));
421 if (!g_output_stream_write_all (out2, data->content, data->size,
423 !g_output_stream_close (out2, NULL, NULL))
425 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
426 _("Error compressing file %s"),
431 g_free (data->content);
432 data->content_size = g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out));
433 data->content = g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out));
435 g_object_unref (compressor);
436 g_object_unref (out);
437 g_object_unref (out2);
439 data->flags |= G_RESOURCE_FLAGS_COMPRESSED;
444 g_hash_table_insert (state->table, key, data);
449 g_free (state->alias);
451 g_string_free (state->string, TRUE);
452 state->string = NULL;
453 g_free (state->preproc_options);
454 state->preproc_options = NULL;
473 text (GMarkupParseContext *context,
479 ParseState *state = user_data;
482 for (i = 0; i < text_len; i++)
483 if (!g_ascii_isspace (text[i]))
486 g_string_append_len (state->string, text, text_len);
489 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
490 _("text may not appear inside <%s>"),
491 g_markup_parse_context_get_element (context));
498 parse_resource_file (const gchar *filename,
499 gboolean collect_data)
501 GMarkupParser parser = { start_element, end_element, text };
502 ParseState state = { 0, };
503 GMarkupParseContext *context;
504 GError *error = NULL;
506 GHashTable *table = NULL;
509 if (!g_file_get_contents (filename, &contents, &size, &error))
511 g_printerr ("%s\n", error->message);
512 g_clear_error (&error);
516 state.table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)file_data_free);
517 state.collect_data = collect_data;
519 context = g_markup_parse_context_new (&parser,
520 G_MARKUP_TREAT_CDATA_AS_TEXT |
521 G_MARKUP_PREFIX_ERROR_POSITION,
524 if (!g_markup_parse_context_parse (context, contents, size, &error) ||
525 !g_markup_parse_context_end_parse (context, &error))
527 g_printerr ("%s: %s.\n", filename, error->message);
528 g_clear_error (&error);
530 else if (collect_data)
538 GVariantBuilder builder;
541 table = gvdb_hash_table_new (NULL, NULL);
543 g_hash_table_iter_init (&iter, state.table);
544 while (g_hash_table_iter_next (&iter, (gpointer *)&key, (gpointer *)&data))
546 key_len = strlen (key);
547 mykey = g_strdup (key);
549 item = gvdb_hash_table_insert (table, key);
550 gvdb_item_set_parent (item,
551 get_parent (table, mykey, key_len));
555 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuay)"));
557 g_variant_builder_add (&builder, "u", data->size); /* Size */
558 g_variant_builder_add (&builder, "u", data->flags); /* Flags */
560 v_data = g_variant_new_from_data (G_VARIANT_TYPE("ay"),
561 data->content, data->content_size, TRUE,
562 g_free, data->content);
563 g_variant_builder_add_value (&builder, v_data);
564 data->content = NULL; /* Take ownership */
566 gvdb_item_set_value (item,
567 g_variant_builder_end (&builder));
572 table = g_hash_table_ref (state.table);
575 g_hash_table_unref (state.table);
576 g_markup_parse_context_free (context);
583 write_to_file (GHashTable *table,
584 const gchar *filename,
589 success = gvdb_table_write_contents (table, filename,
590 G_BYTE_ORDER != G_LITTLE_ENDIAN,
597 main (int argc, char **argv)
602 gchar *target = NULL;
603 gchar *binary_target = NULL;
604 gboolean generate_automatic = FALSE;
605 gboolean generate_source = FALSE;
606 gboolean generate_header = FALSE;
607 gboolean manual_register = FALSE;
608 gboolean generate_dependencies = FALSE;
610 char *c_name_no_underscores;
611 GOptionContext *context;
612 GOptionEntry entries[] = {
613 { "target", 0, 0, G_OPTION_ARG_FILENAME, &target, N_("name of the output file"), N_("FILE") },
614 { "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") },
615 { "generate", 0, 0, G_OPTION_ARG_NONE, &generate_automatic, N_("Generate output in the format selected for by the target filename extension"), NULL },
616 { "generate-header", 0, 0, G_OPTION_ARG_NONE, &generate_header, N_("Generate source header"), NULL },
617 { "generate-source", 0, 0, G_OPTION_ARG_NONE, &generate_source, N_("Generate sourcecode used to link in the resource file into your code"), NULL },
618 { "generate-dependencies", 0, 0, G_OPTION_ARG_NONE, &generate_dependencies, N_("Generate dependency list"), NULL },
619 { "manual-register", 0, 0, G_OPTION_ARG_NONE, &manual_register, N_("Don't automatically create and register resource"), NULL },
620 { "c-name", 0, 0, G_OPTION_ARG_STRING, &c_name, N_("C identifier name used for the generated source code"), NULL },
625 extern gchar *_glib_get_locale_dir (void);
629 setlocale (LC_ALL, "");
630 textdomain (GETTEXT_PACKAGE);
633 tmp = _glib_get_locale_dir ();
634 bindtextdomain (GETTEXT_PACKAGE, tmp);
637 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
640 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
641 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
644 context = g_option_context_new (N_("FILE"));
645 g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
646 g_option_context_set_summary (context,
647 N_("Compile a resource specification into a resource file.\n"
648 "Resource specification files have the extension .gresource.xml,\n"
649 "and the resource file have the extension called .gresource."));
650 g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
653 if (!g_option_context_parse (context, &argc, &argv, &error))
655 g_printerr ("%s\n", error->message);
659 g_option_context_free (context);
663 g_printerr (_("You should give exactly one file name\n"));
669 xmllint = g_strdup (g_getenv ("XMLLINT"));
671 xmllint = g_find_program_in_path ("xmllint");
673 g_printerr ("XMLLINT not set and xmllint not found in path; skipping xml preprocessing.\n");
675 gdk_pixbuf_pixdata = g_strdup (g_getenv ("GDK_PIXBUF_PIXDATA"));
676 if (gdk_pixbuf_pixdata == NULL)
677 gdk_pixbuf_pixdata = g_find_program_in_path ("gdk-pixbuf-pixdata");
681 char *dirname = g_path_get_dirname (srcfile);
682 char *base = g_path_get_basename (srcfile);
683 char *target_basename;
684 if (g_str_has_suffix (base, ".xml"))
685 base[strlen(base) - strlen (".xml")] = 0;
689 if (g_str_has_suffix (base, ".gresource"))
690 base[strlen(base) - strlen (".gresource")] = 0;
691 target_basename = g_strconcat (base, ".c", NULL);
695 if (g_str_has_suffix (base, ".gresource"))
696 target_basename = g_strdup (base);
698 target_basename = g_strconcat (base, ".gresource", NULL);
701 target = g_build_filename (dirname, target_basename, NULL);
702 g_free (target_basename);
706 else if (generate_automatic)
708 if (g_str_has_suffix (target, ".c"))
709 generate_source = TRUE;
710 else if (g_str_has_suffix (target, ".h"))
711 generate_header = TRUE;
712 else if (g_str_has_suffix (target, ".gresource"))
716 if ((table = parse_resource_file (srcfile, !generate_dependencies)) == NULL)
722 if (generate_dependencies)
728 g_hash_table_iter_init (&iter, table);
729 while (g_hash_table_iter_next (&iter, &key, &data))
732 g_print ("%s\n",file_data->filename);
735 else if (generate_source || generate_header)
739 int fd = g_file_open_tmp (NULL, &binary_target, NULL);
742 g_printerr ("Can't open temp file\n");
750 char *base = g_path_get_basename (srcfile);
755 /* Remove extensions */
756 dot = strchr (base, '.');
760 s = g_string_new ("");
762 for (i = 0; base[i] != 0; i++)
764 const char *first = G_CSET_A_2_Z G_CSET_a_2_z "_";
765 const char *rest = G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_";
766 if (strchr ((i == 0) ? first : rest, base[i]) != NULL)
767 g_string_append_c (s, base[i]);
768 else if (base[i] == '-')
769 g_string_append_c (s, '_');
773 c_name = g_string_free (s, FALSE);
777 binary_target = g_strdup (target);
779 c_name_no_underscores = c_name;
780 while (c_name_no_underscores && *c_name_no_underscores == '_')
781 c_name_no_underscores++;
783 if (binary_target != NULL &&
784 !write_to_file (table, binary_target, &error))
786 g_printerr ("%s\n", error->message);
795 file = fopen (target, "w");
798 g_printerr ("can't write to file %s", target);
803 "#ifndef __RESOURCE_%s_H__\n"
804 "#define __RESOURCE_%s_H__\n"
806 "#include <gio/gio.h>\n"
808 "extern GResource *%s_get_resource (void);\n",
809 c_name, c_name, c_name);
814 "extern void %s_register_resource (void);\n"
815 "extern void %s_unregister_resource (void);\n"
824 else if (generate_source)
831 if (!g_file_get_contents (binary_target, (char **)&data,
834 g_printerr ("can't read back temporary file");
837 g_unlink (binary_target);
839 file = fopen (target, "w");
842 g_printerr ("can't write to file %s", target);
847 "#include <gio/gio.h>\n"
849 "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
850 "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
855 "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT"]; const double alignment; void * const ptr;} %s_resource_data = { {\n",
856 c_name_no_underscores, data_size, c_name);
858 for (i = 0; i < data_size; i++) {
861 fprintf (file, "0x%2.2x", (int)data[i]);
862 if (i != data_size - 1)
863 fprintf (file, ", ");
864 if ((i % 8 == 7) || (i == data_size - 1))
865 fprintf (file, "\n");
868 fprintf (file, "} };\n");
872 "static GStaticResource static_resource = { %s_resource_data.data, sizeof (%s_resource_data.data) };\n"
873 "extern GResource *%s_get_resource (void);\n"
874 "GResource *%s_get_resource (void)\n"
876 " return g_static_resource_get_resource (&static_resource);\n"
878 c_name, c_name, c_name, c_name);
885 "extern void %s_unregister_resource (void);\n"
886 "void %s_unregister_resource (void)\n"
888 " g_static_resource_fini (&static_resource);\n"
891 "extern void %s_register_resource (void);\n"
892 "void %s_register_resource (void)\n"
894 " g_static_resource_init (&static_resource);\n"
896 c_name, c_name, c_name, c_name);
900 fprintf (file, "%s", gconstructor_code);
903 "#ifdef G_HAS_CONSTRUCTORS\n"
905 "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
906 "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
908 "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
909 "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
910 "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
912 "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
915 "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
918 "static void resource_constructor (void)\n"
920 " g_static_resource_init (&static_resource);\n"
923 "static void resource_destructor (void)\n"
925 " g_static_resource_fini (&static_resource);\n"
934 g_free (binary_target);
936 g_hash_table_destroy (table);