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>
33 #ifdef HAVE_SYS_WAIT_H
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 *sourcedir = 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 end_element (GMarkupParseContext *context,
179 const gchar *element_name,
183 ParseState *state = user_data;
184 GError *my_error = NULL;
186 if (strcmp (element_name, "gresource") == 0)
188 g_free (state->prefix);
189 state->prefix = NULL;
192 else if (strcmp (element_name, "file") == 0)
194 gchar *file, *real_file;
197 char *tmp_file = NULL;
198 char *tmp_file2 = NULL;
200 file = state->string->str;
206 key = g_build_path ("/", "/", state->prefix, key, NULL);
208 key = g_build_path ("/", "/", key, NULL);
210 if (g_hash_table_lookup (state->table, key) != NULL)
212 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
213 _("File %s appears multiple times in the resource"),
218 data = g_new0 (FileData, 1);
220 if (sourcedir != NULL)
221 real_file = g_build_filename (sourcedir, file, NULL);
223 real_file = g_strdup (file);
225 data->filename = g_strdup (real_file);
226 if (!state->collect_data)
229 if (state->preproc_options)
233 gboolean xml_stripblanks = FALSE;
234 gboolean to_pixdata = FALSE;
236 options = g_strsplit (state->preproc_options, ",", -1);
238 for (i = 0; options[i]; i++)
240 if (!strcmp (options[i], "xml-stripblanks"))
241 xml_stripblanks = TRUE;
242 else if (!strcmp (options[i], "to-pixdata"))
246 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
247 _("Unknown proprocessing options \"%s\""), options[i]);
248 g_strfreev (options);
252 g_strfreev (options);
254 if (xml_stripblanks && xmllint != NULL)
257 int status, fd, argc;
259 tmp_file = g_strdup ("resource-XXXXXXXX");
260 if ((fd = g_mkstemp (tmp_file)) == -1)
264 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
265 _("Failed to create temp file: %s"),
274 argv[argc++] = (gchar *) xmllint;
275 argv[argc++] = "--nonet";
276 argv[argc++] = "--noent";
277 argv[argc++] = "--noblanks";
278 argv[argc++] = "--output";
279 argv[argc++] = tmp_file;
280 argv[argc++] = real_file;
282 g_assert (argc <= G_N_ELEMENTS (argv));
284 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
285 G_SPAWN_STDOUT_TO_DEV_NULL |
286 G_SPAWN_STDERR_TO_DEV_NULL,
287 NULL, NULL, NULL, NULL, &status, &my_error))
289 g_propagate_error (error, my_error);
292 #ifdef HAVE_SYS_WAIT_H
293 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
295 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
296 _("Error processing input file with xmllint"));
302 real_file = g_strdup (tmp_file);
308 int status, fd, argc;
310 if (gdk_pixbuf_pixdata == NULL)
312 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
313 "to-pixbuf preprocessing requested but GDK_PIXBUF_PIXDATA "
314 "not set and gdk-pixbuf-pixdata not found in path");
318 tmp_file2 = g_strdup ("resource-XXXXXXXX");
319 if ((fd = g_mkstemp (tmp_file2)) == -1)
323 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
324 _("Failed to create temp file: %s"),
333 argv[argc++] = (gchar *) gdk_pixbuf_pixdata;
334 argv[argc++] = real_file;
335 argv[argc++] = tmp_file2;
337 g_assert (argc <= G_N_ELEMENTS (argv));
339 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
340 G_SPAWN_STDOUT_TO_DEV_NULL |
341 G_SPAWN_STDERR_TO_DEV_NULL,
342 NULL, NULL, NULL, NULL, &status, &my_error))
344 g_propagate_error (error, my_error);
347 #ifdef HAVE_SYS_WAIT_H
348 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
350 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
351 _("Error processing input file with xmllint"));
357 real_file = g_strdup (tmp_file2);
361 if (!g_file_get_contents (real_file, &data->content, &data->size, &my_error))
363 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
364 _("Error reading file %s: %s"),
365 real_file, my_error->message);
366 g_clear_error (&my_error);
369 /* Include zero termination in content_size for uncompressed files (but not in size) */
370 data->content_size = data->size + 1;
372 if (state->compressed)
374 GOutputStream *out = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
375 GZlibCompressor *compressor =
376 g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB, 9);
377 GOutputStream *out2 = g_converter_output_stream_new (out, G_CONVERTER (compressor));
379 if (!g_output_stream_write_all (out2, data->content, data->size,
381 !g_output_stream_close (out2, NULL, NULL))
383 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
384 _("Error compressing file %s"),
389 g_free (data->content);
390 data->content_size = g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out));
391 data->content = g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out));
393 g_object_unref (compressor);
394 g_object_unref (out);
395 g_object_unref (out2);
397 data->flags |= G_RESOURCE_FLAGS_COMPRESSED;
402 g_hash_table_insert (state->table, key, data);
407 g_free (state->alias);
409 g_string_free (state->string, TRUE);
410 state->string = NULL;
411 g_free (state->preproc_options);
412 state->preproc_options = NULL;
431 text (GMarkupParseContext *context,
437 ParseState *state = user_data;
440 for (i = 0; i < text_len; i++)
441 if (!g_ascii_isspace (text[i]))
444 g_string_append_len (state->string, text, text_len);
447 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
448 _("text may not appear inside <%s>"),
449 g_markup_parse_context_get_element (context));
456 parse_resource_file (const gchar *filename,
457 gboolean collect_data)
459 GMarkupParser parser = { start_element, end_element, text };
460 ParseState state = { 0, };
461 GMarkupParseContext *context;
462 GError *error = NULL;
464 GHashTable *table = NULL;
467 if (!g_file_get_contents (filename, &contents, &size, &error))
469 g_printerr ("%s\n", error->message);
470 g_clear_error (&error);
474 state.table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)file_data_free);
475 state.collect_data = collect_data;
477 context = g_markup_parse_context_new (&parser,
478 G_MARKUP_TREAT_CDATA_AS_TEXT |
479 G_MARKUP_PREFIX_ERROR_POSITION,
482 if (!g_markup_parse_context_parse (context, contents, size, &error) ||
483 !g_markup_parse_context_end_parse (context, &error))
485 g_printerr ("%s: %s.\n", filename, error->message);
486 g_clear_error (&error);
488 else if (collect_data)
496 GVariantBuilder builder;
499 table = gvdb_hash_table_new (NULL, NULL);
501 g_hash_table_iter_init (&iter, state.table);
502 while (g_hash_table_iter_next (&iter, (gpointer *)&key, (gpointer *)&data))
504 key_len = strlen (key);
505 mykey = g_strdup (key);
507 item = gvdb_hash_table_insert (table, key);
508 gvdb_item_set_parent (item,
509 get_parent (table, mykey, key_len));
513 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuay)"));
515 g_variant_builder_add (&builder, "u", data->size); /* Size */
516 g_variant_builder_add (&builder, "u", data->flags); /* Flags */
518 v_data = g_variant_new_from_data (G_VARIANT_TYPE("ay"),
519 data->content, data->content_size, TRUE,
520 g_free, data->content);
521 g_variant_builder_add_value (&builder, v_data);
522 data->content = NULL; /* Take ownership */
524 gvdb_item_set_value (item,
525 g_variant_builder_end (&builder));
530 table = g_hash_table_ref (state.table);
533 g_hash_table_unref (state.table);
534 g_markup_parse_context_free (context);
541 write_to_file (GHashTable *table,
542 const gchar *filename,
547 success = gvdb_table_write_contents (table, filename,
548 G_BYTE_ORDER != G_LITTLE_ENDIAN,
555 main (int argc, char **argv)
560 gchar *target = NULL;
561 gchar *binary_target = NULL;
562 gboolean generate_automatic = FALSE;
563 gboolean generate_source = FALSE;
564 gboolean generate_header = FALSE;
565 gboolean manual_register = FALSE;
566 gboolean generate_dependencies = FALSE;
568 char *c_name_no_underscores;
569 GOptionContext *context;
570 GOptionEntry entries[] = {
571 { "target", 0, 0, G_OPTION_ARG_FILENAME, &target, N_("name of the output file"), N_("FILE") },
572 { "sourcedir", 0, 0, G_OPTION_ARG_FILENAME, &sourcedir, N_("The directory where files are to be read from (default to current directory)"), N_("DIRECTORY") },
573 { "generate", 0, 0, G_OPTION_ARG_NONE, &generate_automatic, N_("Generate output in the format selected for by the target filename extension"), NULL },
574 { "generate-header", 0, 0, G_OPTION_ARG_NONE, &generate_header, N_("Generate source header"), NULL },
575 { "generate-source", 0, 0, G_OPTION_ARG_NONE, &generate_source, N_("Generate sourcecode used to link in the resource file into your code"), NULL },
576 { "generate-dependencies", 0, 0, G_OPTION_ARG_NONE, &generate_dependencies, N_("Generate dependency list"), NULL },
577 { "manual-register", 0, 0, G_OPTION_ARG_NONE, &manual_register, N_("Don't automatically create and register resource"), NULL },
578 { "c-name", 0, 0, G_OPTION_ARG_STRING, &c_name, N_("C identifier name used for the generated source code"), NULL },
583 extern gchar *_glib_get_locale_dir (void);
587 setlocale (LC_ALL, "");
588 textdomain (GETTEXT_PACKAGE);
591 tmp = _glib_get_locale_dir ();
592 bindtextdomain (GETTEXT_PACKAGE, tmp);
595 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
598 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
599 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
604 context = g_option_context_new (N_("FILE"));
605 g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
606 g_option_context_set_summary (context,
607 N_("Compile a resource specification into a resource file.\n"
608 "Resource specification files have the extension .gresource.xml,\n"
609 "and the resource file have the extension called .gresource."));
610 g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
613 if (!g_option_context_parse (context, &argc, &argv, &error))
615 g_printerr ("%s\n", error->message);
619 g_option_context_free (context);
623 g_printerr (_("You should give exactly one file name\n"));
629 if (sourcedir == NULL)
632 xmllint = g_strdup (g_getenv ("XMLLINT"));
634 xmllint = g_find_program_in_path ("xmllint");
636 g_printerr ("XMLLINT not set and xmllint not found in path; skipping xml preprocessing.\n");
638 gdk_pixbuf_pixdata = g_strdup (g_getenv ("GDK_PIXBUF_PIXDATA"));
639 if (gdk_pixbuf_pixdata == NULL)
640 gdk_pixbuf_pixdata = g_find_program_in_path ("gdk-pixbuf-pixdata");
644 char *dirname = g_path_get_dirname (srcfile);
645 char *base = g_path_get_basename (srcfile);
646 char *target_basename;
647 if (g_str_has_suffix (base, ".xml"))
648 base[strlen(base) - strlen (".xml")] = 0;
652 if (g_str_has_suffix (base, ".gresource"))
653 base[strlen(base) - strlen (".gresource")] = 0;
654 target_basename = g_strconcat (base, ".c", NULL);
658 if (g_str_has_suffix (base, ".gresource"))
659 target_basename = g_strdup (base);
661 target_basename = g_strconcat (base, ".gresource", NULL);
664 target = g_build_filename (dirname, target_basename, NULL);
665 g_free (target_basename);
669 else if (generate_automatic)
671 if (g_str_has_suffix (target, ".c"))
672 generate_source = TRUE;
673 else if (g_str_has_suffix (target, ".h"))
674 generate_header = TRUE;
675 else if (g_str_has_suffix (target, ".gresource"))
679 if ((table = parse_resource_file (srcfile, !generate_dependencies)) == NULL)
685 if (generate_dependencies)
691 g_hash_table_iter_init (&iter, table);
692 while (g_hash_table_iter_next (&iter, &key, &data))
695 g_print ("%s\n",file_data->filename);
698 else if (generate_source || generate_header)
702 int fd = g_file_open_tmp (NULL, &binary_target, NULL);
705 g_printerr ("Can't open temp file\n");
713 char *base = g_path_get_basename (srcfile);
718 /* Remove extensions */
719 dot = strchr (base, '.');
723 s = g_string_new ("");
725 for (i = 0; base[i] != 0; i++)
727 const char *first = G_CSET_A_2_Z G_CSET_a_2_z "_";
728 const char *rest = G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_";
729 if (strchr ((i == 0) ? first : rest, base[i]) != NULL)
730 g_string_append_c (s, base[i]);
731 else if (base[i] == '-')
732 g_string_append_c (s, '_');
736 c_name = g_string_free (s, FALSE);
740 binary_target = g_strdup (target);
742 c_name_no_underscores = c_name;
743 while (c_name_no_underscores && *c_name_no_underscores == '_')
744 c_name_no_underscores++;
746 if (binary_target != NULL &&
747 !write_to_file (table, binary_target, &error))
749 g_printerr ("%s\n", error->message);
758 file = fopen (target, "w");
761 g_printerr ("can't write to file %s", target);
766 "#ifndef __RESOURCE_%s_H__\n"
767 "#define __RESOURCE_%s_H__\n"
769 "#include <gio/gio.h>\n"
771 "extern GResource *%s_get_resource (void);\n",
772 c_name, c_name, c_name);
777 "extern void %s_register_resource (void);\n"
778 "extern void %s_unregister_resource (void);\n"
787 else if (generate_source)
794 if (!g_file_get_contents (binary_target, (char **)&data,
797 g_printerr ("can't read back temporary file");
800 g_unlink (binary_target);
802 file = fopen (target, "w");
805 g_printerr ("can't write to file %s", target);
810 "#include <gio/gio.h>\n"
812 "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
813 "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
818 "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT"]; const double alignment; void * const ptr;} %s_resource_data = { {\n",
819 c_name_no_underscores, data_size, c_name);
821 for (i = 0; i < data_size; i++) {
824 fprintf (file, "0x%2.2x", (int)data[i]);
825 if (i != data_size - 1)
826 fprintf (file, ", ");
827 if ((i % 8 == 7) || (i == data_size - 1))
828 fprintf (file, "\n");
831 fprintf (file, "} };\n");
835 "static GStaticResource static_resource = { %s_resource_data.data, sizeof (%s_resource_data.data) };\n"
836 "extern GResource *%s_get_resource (void);\n"
837 "GResource *%s_get_resource (void)\n"
839 " return g_static_resource_get_resource (&static_resource);\n"
841 c_name, c_name, c_name, c_name);
848 "extern void %s_unregister_resource (void);\n"
849 "void %s_unregister_resource (void)\n"
851 " g_static_resource_fini (&static_resource);\n"
854 "extern void %s_register_resource (void);\n"
855 "void %s_register_resource (void)\n"
857 " g_static_resource_init (&static_resource);\n"
859 c_name, c_name, c_name, c_name);
863 fprintf (file, "%s", gconstructor_code);
866 "#ifdef G_HAS_CONSTRUCTORS\n"
868 "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
869 "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
871 "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
872 "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
873 "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
875 "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
878 "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
881 "static void resource_constructor (void)\n"
883 " g_static_resource_init (&static_resource);\n"
886 "static void resource_destructor (void)\n"
888 " g_static_resource_fini (&static_resource);\n"
897 g_free (binary_target);
899 g_hash_table_destroy (table);