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"
59 GHashTable *table; /* resource path -> FileData */
61 gboolean collect_data;
69 char *preproc_options;
71 GString *string; /* non-NULL when accepting text */
74 static gchar *sourcedir = NULL;
75 static gchar *xmllint = NULL;
78 file_data_free (FileData *data)
80 g_free (data->filename);
81 g_free (data->content);
86 start_element (GMarkupParseContext *context,
87 const gchar *element_name,
88 const gchar **attribute_names,
89 const gchar **attribute_values,
93 ParseState *state = user_data;
94 const GSList *element_stack;
95 const gchar *container;
97 element_stack = g_markup_parse_context_get_element_stack (context);
98 container = element_stack->next ? element_stack->next->data : NULL;
100 #define COLLECT(first, ...) \
101 g_markup_collect_attributes (element_name, \
102 attribute_names, attribute_values, error, \
103 first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
104 #define OPTIONAL G_MARKUP_COLLECT_OPTIONAL
105 #define STRDUP G_MARKUP_COLLECT_STRDUP
106 #define STRING G_MARKUP_COLLECT_STRING
107 #define BOOL G_MARKUP_COLLECT_BOOLEAN
108 #define NO_ATTRS() COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
110 if (container == NULL)
112 if (strcmp (element_name, "gresources") == 0)
115 else if (strcmp (container, "gresources") == 0)
117 if (strcmp (element_name, "gresource") == 0)
119 COLLECT (OPTIONAL | STRDUP,
120 "prefix", &state->prefix);
124 else if (strcmp (container, "gresource") == 0)
126 if (strcmp (element_name, "file") == 0)
128 COLLECT (OPTIONAL | STRDUP, "alias", &state->alias,
129 OPTIONAL | BOOL, "compressed", &state->compressed,
130 OPTIONAL | STRDUP, "preprocess", &state->preproc_options);
131 state->string = g_string_new ("");
137 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
138 _("Element <%s> not allowed inside <%s>"),
139 element_name, container);
141 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
142 _("Element <%s> not allowed at toplevel"), element_name);
147 get_parent (GHashTable *table,
151 GvdbItem *grandparent, *parent;
156 while (key[--length - 1] != '/');
159 parent = g_hash_table_lookup (table, key);
163 parent = gvdb_hash_table_insert (table, key);
165 grandparent = get_parent (table, key, length);
167 if (grandparent != NULL)
168 gvdb_item_set_parent (parent, grandparent);
175 end_element (GMarkupParseContext *context,
176 const gchar *element_name,
180 ParseState *state = user_data;
181 GError *my_error = NULL;
183 if (strcmp (element_name, "gresource") == 0)
185 g_free (state->prefix);
186 state->prefix = NULL;
189 else if (strcmp (element_name, "file") == 0)
191 gchar *file, *real_file;
194 char *tmp_file = NULL;
196 file = state->string->str;
202 key = g_build_path ("/", "/", state->prefix, key, NULL);
204 key = g_build_path ("/", "/", key, NULL);
206 if (g_hash_table_lookup (state->table, key) != NULL)
208 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
209 _("File %s appears multiple times in the resource"),
214 data = g_new0 (FileData, 1);
216 if (sourcedir != NULL)
217 real_file = g_build_filename (sourcedir, file, NULL);
219 real_file = g_strdup (file);
221 data->filename = g_strdup (real_file);
222 if (!state->collect_data)
225 if (state->preproc_options)
229 gboolean xml_stripblanks = FALSE;
231 options = g_strsplit (state->preproc_options, ",", -1);
233 for (i = 0; options[i]; i++)
235 if (!strcmp (options[i], "xml-stripblanks"))
236 xml_stripblanks = TRUE;
239 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
240 _("Unknown proprocessing options \"%s\""), options[i]);
241 g_strfreev (options);
245 g_strfreev (options);
247 if (xml_stripblanks && xmllint != NULL)
250 int status, fd, argc;
252 tmp_file = g_strdup ("resource-XXXXXXXX");
253 if ((fd = g_mkstemp (tmp_file)) == -1)
257 g_set_error (error, G_IO_ERROR, g_io_error_from_errno (errsv),
258 _("Failed to create temp file: %s"),
267 argv[argc++] = (gchar *) xmllint;
268 argv[argc++] = "--nonet";
269 argv[argc++] = "--noent";
270 argv[argc++] = "--noblanks";
271 argv[argc++] = "--output";
272 argv[argc++] = tmp_file;
273 argv[argc++] = real_file;
275 g_assert (argc <= G_N_ELEMENTS (argv));
277 if (!g_spawn_sync (NULL /* cwd */, argv, NULL /* envv */,
278 G_SPAWN_STDOUT_TO_DEV_NULL |
279 G_SPAWN_STDERR_TO_DEV_NULL,
280 NULL, NULL, NULL, NULL, &status, &my_error))
282 g_propagate_error (error, my_error);
285 #ifdef HAVE_SYS_WAIT_H
286 if (!WIFEXITED (status) || WEXITSTATUS (status) != 0)
288 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_FAILED,
289 _("Error processing input file with xmllint"));
295 real_file = g_strdup (tmp_file);
299 if (!g_file_get_contents (real_file, &data->content, &data->size, &my_error))
301 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
302 _("Error reading file %s: %s"),
303 real_file, my_error->message);
304 g_clear_error (&my_error);
307 /* Include zero termination in content_size for uncompressed files (but not in size) */
308 data->content_size = data->size + 1;
310 if (state->compressed)
312 GOutputStream *out = g_memory_output_stream_new (NULL, 0, g_realloc, g_free);
313 GZlibCompressor *compressor =
314 g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB, 9);
315 GOutputStream *out2 = g_converter_output_stream_new (out, G_CONVERTER (compressor));
317 if (!g_output_stream_write_all (out2, data->content, data->size,
319 !g_output_stream_close (out2, NULL, NULL))
321 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
322 _("Error compressing file %s"),
327 g_free (data->content);
328 data->content_size = g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out));
329 data->content = g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out));
331 g_object_unref (compressor);
332 g_object_unref (out);
333 g_object_unref (out2);
335 data->flags |= G_RESOURCE_FLAGS_COMPRESSED;
340 g_hash_table_insert (state->table, key, data);
345 g_free (state->alias);
347 g_string_free (state->string, TRUE);
348 state->string = NULL;
349 g_free (state->preproc_options);
350 state->preproc_options = NULL;
362 text (GMarkupParseContext *context,
368 ParseState *state = user_data;
371 for (i = 0; i < text_len; i++)
372 if (!g_ascii_isspace (text[i]))
375 g_string_append_len (state->string, text, text_len);
378 g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
379 _("text may not appear inside <%s>"),
380 g_markup_parse_context_get_element (context));
387 parse_resource_file (const gchar *filename,
388 gboolean collect_data)
390 GMarkupParser parser = { start_element, end_element, text };
391 ParseState state = { 0, };
392 GMarkupParseContext *context;
393 GError *error = NULL;
395 GHashTable *table = NULL;
398 if (!g_file_get_contents (filename, &contents, &size, &error))
400 g_printerr ("%s\n", error->message);
401 g_clear_error (&error);
405 state.table = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, (GDestroyNotify)file_data_free);
406 state.collect_data = collect_data;
408 context = g_markup_parse_context_new (&parser,
409 G_MARKUP_TREAT_CDATA_AS_TEXT |
410 G_MARKUP_PREFIX_ERROR_POSITION,
413 if (!g_markup_parse_context_parse (context, contents, size, &error) ||
414 !g_markup_parse_context_end_parse (context, &error))
416 g_printerr ("%s: %s.\n", filename, error->message);
417 g_clear_error (&error);
419 else if (collect_data)
427 GVariantBuilder builder;
430 table = gvdb_hash_table_new (NULL, NULL);
432 g_hash_table_iter_init (&iter, state.table);
433 while (g_hash_table_iter_next (&iter, (gpointer *)&key, (gpointer *)&data))
435 key_len = strlen (key);
436 mykey = g_strdup (key);
438 item = gvdb_hash_table_insert (table, key);
439 gvdb_item_set_parent (item,
440 get_parent (table, mykey, key_len));
444 g_variant_builder_init (&builder, G_VARIANT_TYPE ("(uuay)"));
446 g_variant_builder_add (&builder, "u", data->size); /* Size */
447 g_variant_builder_add (&builder, "u", data->flags); /* Flags */
449 v_data = g_variant_new_from_data (G_VARIANT_TYPE("ay"),
450 data->content, data->content_size, TRUE,
451 g_free, data->content);
452 g_variant_builder_add_value (&builder, v_data);
453 data->content = NULL; /* Take ownership */
455 gvdb_item_set_value (item,
456 g_variant_builder_end (&builder));
461 table = g_hash_table_ref (state.table);
464 g_hash_table_unref (state.table);
465 g_markup_parse_context_free (context);
472 write_to_file (GHashTable *table,
473 const gchar *filename,
478 success = gvdb_table_write_contents (table, filename,
479 G_BYTE_ORDER != G_LITTLE_ENDIAN,
486 main (int argc, char **argv)
491 gchar *target = NULL;
492 gchar *binary_target = NULL;
493 gboolean generate_source = FALSE;
494 gboolean generate_header = FALSE;
495 gboolean manual_register = FALSE;
496 gboolean generate_dependencies = FALSE;
498 char *c_name_no_underscores;
499 GOptionContext *context;
500 GOptionEntry entries[] = {
501 { "target", 0, 0, G_OPTION_ARG_FILENAME, &target, N_("name of the output file"), N_("FILE") },
502 { "sourcedir", 0, 0, G_OPTION_ARG_FILENAME, &sourcedir, N_("The directory where files are to be read from (default to current directory)"), N_("DIRECTORY") },
503 { "generate-header", 0, 0, G_OPTION_ARG_NONE, &generate_header, N_("Generate source header"), NULL },
504 { "generate-source", 0, 0, G_OPTION_ARG_NONE, &generate_source, N_("Generate sourcecode used to link in the resource file into your code"), NULL },
505 { "generate-dependencies", 0, 0, G_OPTION_ARG_NONE, &generate_dependencies, N_("Generate dependency list"), NULL },
506 { "manual-register", 0, 0, G_OPTION_ARG_NONE, &manual_register, N_("Don't automatically create and register resource"), NULL },
507 { "c-name", 0, 0, G_OPTION_ARG_STRING, &c_name, N_("C identifier name used for the generated source code"), NULL },
512 extern gchar *_glib_get_locale_dir (void);
516 setlocale (LC_ALL, "");
517 textdomain (GETTEXT_PACKAGE);
520 tmp = _glib_get_locale_dir ();
521 bindtextdomain (GETTEXT_PACKAGE, tmp);
524 bindtextdomain (GETTEXT_PACKAGE, GLIB_LOCALE_DIR);
527 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
528 bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");
533 context = g_option_context_new (N_("FILE"));
534 g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
535 g_option_context_set_summary (context,
536 N_("Compile a resource specification into a resource file.\n"
537 "Resource specification files have the extension .gresource.xml,\n"
538 "and the resource file have the extension called .gresource."));
539 g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
542 if (!g_option_context_parse (context, &argc, &argv, &error))
544 g_printerr ("%s\n", error->message);
548 g_option_context_free (context);
552 g_printerr (_("You should give exactly one file name\n"));
558 if (sourcedir == NULL)
561 xmllint = g_strdup (g_getenv ("XMLLINT"));
563 xmllint = g_find_program_in_path ("xmllint");
565 g_printerr ("XMLLINT not set and xmllint not found in path; skipping xml preprocessing.\n");
569 char *dirname = g_path_get_dirname (srcfile);
570 char *base = g_path_get_basename (srcfile);
571 char *target_basename;
572 if (g_str_has_suffix (base, ".xml"))
573 base[strlen(base) - strlen (".xml")] = 0;
577 if (g_str_has_suffix (base, ".gresource"))
578 base[strlen(base) - strlen (".gresource")] = 0;
579 target_basename = g_strconcat (base, ".c", NULL);
583 if (g_str_has_suffix (base, ".gresource"))
584 target_basename = g_strdup (base);
586 target_basename = g_strconcat (base, ".gresource", NULL);
589 target = g_build_filename (dirname, target_basename, NULL);
590 g_free (target_basename);
595 if ((table = parse_resource_file (srcfile, !generate_dependencies)) == NULL)
601 if (generate_dependencies)
607 g_hash_table_iter_init (&iter, table);
608 while (g_hash_table_iter_next (&iter, &key, &data))
611 g_print ("%s\n",file_data->filename);
614 else if (generate_source || generate_header)
618 int fd = g_file_open_tmp (NULL, &binary_target, NULL);
621 g_printerr ("Can't open temp file\n");
629 char *base = g_path_get_basename (srcfile);
634 /* Remove extensions */
635 dot = strchr (base, '.');
639 s = g_string_new ("");
641 for (i = 0; base[i] != 0; i++)
643 const char *first = G_CSET_A_2_Z G_CSET_a_2_z "_";
644 const char *rest = G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS "_";
645 if (strchr ((i == 0) ? first : rest, base[i]) != NULL)
646 g_string_append_c (s, base[i]);
647 else if (base[i] == '-')
648 g_string_append_c (s, '_');
652 c_name = g_string_free (s, FALSE);
656 binary_target = g_strdup (target);
658 c_name_no_underscores = c_name;
659 while (c_name_no_underscores && *c_name_no_underscores == '_')
660 c_name_no_underscores++;
662 if (binary_target != NULL &&
663 !write_to_file (table, binary_target, &error))
665 g_printerr ("%s\n", error->message);
674 file = fopen (target, "w");
677 g_printerr ("can't write to file %s", target);
682 "#ifndef __RESOURCE_%s_H__\n"
683 "#define __RESOURCE_%s_H__\n"
685 "#include <gio/gio.h>\n"
687 "extern GResource *%s_resource;\n",
688 c_name, c_name, c_name);
693 "extern void %s_register_resource (void);\n"
694 "extern void %s_unregister_resource (void);\n"
703 else if (generate_source)
711 if (!g_file_get_contents (binary_target, (char **)&data,
714 g_printerr ("can't read back temporary file");
717 g_unlink (binary_target);
719 file = fopen (target, "w");
722 g_printerr ("can't write to file %s", target);
727 "#include <gio/gio.h>\n"
729 "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
730 "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
735 "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT"]; const double alignment; void * const ptr;} %s_resource_data = { {\n",
736 c_name_no_underscores, data_size, c_name);
738 for (i = 0; i < data_size; i++) {
741 fprintf (file, "0x%2.2x", (int)data[i]);
742 if (i != data_size - 1)
743 fprintf (file, ", ");
744 if ((i % 8 == 7) || (i == data_size - 1))
745 fprintf (file, "\n");
748 fprintf (file, "} };\n");
756 static_str = "static ";
759 "#ifdef G_HAS_CONSTRUCTORS\n"
761 "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
762 "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
764 "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
765 "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
766 "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
768 "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
771 "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
778 "GResource *%s_resource = NULL;\n"
780 "%svoid %s_unregister_resource (void)\n"
782 " if (%s_resource)\n"
784 " g_resources_unregister (%s_resource);\n"
785 " g_resource_unref (%s_resource);\n"
786 " %s_resource = NULL;\n"
790 "%svoid %s_register_resource (void)\n"
792 " if (%s_resource == NULL)\n"
794 " GBytes *bytes = g_bytes_new_static (%s_resource_data.data, sizeof (%s_resource_data.data));\n"
795 " %s_resource = g_resource_new_from_data (bytes, NULL);\n"
796 " if (%s_resource)\n"
797 " g_resources_register (%s_resource);\n"
798 " g_bytes_unref (bytes);\n"
800 "}\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);
802 if (!manual_register)
805 "static void resource_constructor (void)\n"
807 " %s_register_resource ();\n"
810 "static void resource_destructor (void)\n"
812 " %s_unregister_resource ();\n"
813 "}\n", c_name, c_name);
820 g_free (binary_target);
822 g_hash_table_destroy (table);