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, see <http://www.gnu.org/licenses/>.
17 * Author: Alexander Larsson <alexl@redhat.com>
38 #include <gio/gmemoryoutputstream.h>
39 #include <gio/gzlibcompressor.h>
40 #include <gio/gconverteroutputstream.h>
43 #include "gvdb/gvdb-builder.h"
45 #include "gconstructor_as_data.h"
48 #include "glib/glib-private.h"
62 GHashTable
*table
; /* resource path -> FileData */
64 gboolean collect_data
;
72 char *preproc_options
;
74 GString
*string
; /* non-NULL when accepting text */
77 static gchar
**sourcedirs
= NULL
;
78 static gchar
*xmllint
= NULL
;
79 static gchar
*gdk_pixbuf_pixdata
= NULL
;
82 file_data_free (FileData
*data
)
84 g_free (data
->filename
);
85 g_free (data
->content
);
90 start_element (GMarkupParseContext
*context
,
91 const gchar
*element_name
,
92 const gchar
**attribute_names
,
93 const gchar
**attribute_values
,
97 ParseState
*state
= user_data
;
98 const GSList
*element_stack
;
99 const gchar
*container
;
101 element_stack
= g_markup_parse_context_get_element_stack (context
);
102 container
= element_stack
->next
? element_stack
->next
->data
: NULL
;
104 #define COLLECT(first, ...) \
105 g_markup_collect_attributes (element_name, \
106 attribute_names, attribute_values, error, \
107 first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
108 #define OPTIONAL G_MARKUP_COLLECT_OPTIONAL
109 #define STRDUP G_MARKUP_COLLECT_STRDUP
110 #define STRING G_MARKUP_COLLECT_STRING
111 #define BOOL G_MARKUP_COLLECT_BOOLEAN
112 #define NO_ATTRS() COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
114 if (container
== NULL
)
116 if (strcmp (element_name
, "gresources") == 0)
119 else if (strcmp (container
, "gresources") == 0)
121 if (strcmp (element_name
, "gresource") == 0)
123 COLLECT (OPTIONAL
| STRDUP
,
124 "prefix", &state
->prefix
);
128 else if (strcmp (container
, "gresource") == 0)
130 if (strcmp (element_name
, "file") == 0)
132 COLLECT (OPTIONAL
| STRDUP
, "alias", &state
->alias
,
133 OPTIONAL
| BOOL
, "compressed", &state
->compressed
,
134 OPTIONAL
| STRDUP
, "preprocess", &state
->preproc_options
);
135 state
->string
= g_string_new ("");
141 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_UNKNOWN_ELEMENT
,
142 _("Element <%s> not allowed inside <%s>"),
143 element_name
, container
);
145 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_UNKNOWN_ELEMENT
,
146 _("Element <%s> not allowed at toplevel"), element_name
);
151 get_parent (GHashTable
*table
,
155 GvdbItem
*grandparent
, *parent
;
160 while (key
[--length
- 1] != '/');
163 parent
= g_hash_table_lookup (table
, key
);
167 parent
= gvdb_hash_table_insert (table
, key
);
169 grandparent
= get_parent (table
, key
, length
);
171 if (grandparent
!= NULL
)
172 gvdb_item_set_parent (parent
, grandparent
);
179 find_file (const gchar
*filename
)
185 if (g_path_is_absolute (filename
))
186 return g_strdup (filename
);
188 /* search all the sourcedirs for the correct files in order */
189 for (i
= 0; sourcedirs
[i
] != NULL
; i
++)
191 real_file
= g_build_path ("/", sourcedirs
[i
], filename
, NULL
);
192 exists
= g_file_test (real_file
, G_FILE_TEST_EXISTS
);
201 end_element (GMarkupParseContext
*context
,
202 const gchar
*element_name
,
206 ParseState
*state
= user_data
;
207 GError
*my_error
= NULL
;
209 if (strcmp (element_name
, "gresource") == 0)
211 g_free (state
->prefix
);
212 state
->prefix
= NULL
;
215 else if (strcmp (element_name
, "file") == 0)
218 gchar
*real_file
= NULL
;
220 FileData
*data
= NULL
;
221 char *tmp_file
= NULL
;
222 char *tmp_file2
= NULL
;
224 file
= state
->string
->str
;
230 key
= g_build_path ("/", "/", state
->prefix
, key
, NULL
);
232 key
= g_build_path ("/", "/", key
, NULL
);
234 if (g_hash_table_lookup (state
->table
, key
) != NULL
)
236 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_INVALID_CONTENT
,
237 _("File %s appears multiple times in the resource"),
242 if (sourcedirs
!= NULL
)
244 real_file
= find_file (file
);
245 if (real_file
== NULL
&& state
->collect_data
)
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
);
256 if (!exists
&& state
->collect_data
)
258 g_set_error (error
, G_IO_ERROR
, G_IO_ERROR_FAILED
,
259 _("Failed to locate '%s' in current directory"), file
);
264 if (real_file
== NULL
)
265 real_file
= g_strdup (file
);
267 data
= g_new0 (FileData
, 1);
268 data
->filename
= g_strdup (real_file
);
269 if (!state
->collect_data
)
272 if (state
->preproc_options
)
276 gboolean xml_stripblanks
= FALSE
;
277 gboolean to_pixdata
= FALSE
;
279 options
= g_strsplit (state
->preproc_options
, ",", -1);
281 for (i
= 0; options
[i
]; i
++)
283 if (!strcmp (options
[i
], "xml-stripblanks"))
284 xml_stripblanks
= TRUE
;
285 else if (!strcmp (options
[i
], "to-pixdata"))
289 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_INVALID_CONTENT
,
290 _("Unknown processing option \"%s\""), options
[i
]);
291 g_strfreev (options
);
295 g_strfreev (options
);
297 if (xml_stripblanks
&& xmllint
!= NULL
)
302 tmp_file
= g_strdup ("resource-XXXXXXXX");
303 if ((fd
= g_mkstemp (tmp_file
)) == -1)
307 g_set_error (error
, G_IO_ERROR
, g_io_error_from_errno (errsv
),
308 _("Failed to create temp file: %s"),
316 proc
= g_subprocess_new (G_SUBPROCESS_FLAGS_STDOUT_SILENCE
, error
,
317 xmllint
, "--nonet", "--noblanks", "--output", tmp_file
, real_file
, NULL
);
324 if (!g_subprocess_wait_check (proc
, NULL
, error
))
326 g_object_unref (proc
);
330 g_object_unref (proc
);
332 real_file
= g_strdup (tmp_file
);
340 if (gdk_pixbuf_pixdata
== NULL
)
342 g_set_error_literal (error
, G_IO_ERROR
, G_IO_ERROR_FAILED
,
343 "to-pixbuf preprocessing requested but GDK_PIXBUF_PIXDATA "
344 "not set and gdk-pixbuf-pixdata not found in path");
348 tmp_file2
= g_strdup ("resource-XXXXXXXX");
349 if ((fd
= g_mkstemp (tmp_file2
)) == -1)
353 g_set_error (error
, G_IO_ERROR
, g_io_error_from_errno (errsv
),
354 _("Failed to create temp file: %s"),
362 proc
= g_subprocess_new (G_SUBPROCESS_FLAGS_STDOUT_SILENCE
, error
,
363 gdk_pixbuf_pixdata
, real_file
, tmp_file2
, NULL
);
367 if (!g_subprocess_wait_check (proc
, NULL
, error
))
369 g_object_unref (proc
);
373 g_object_unref (proc
);
375 real_file
= g_strdup (tmp_file2
);
379 if (!g_file_get_contents (real_file
, &data
->content
, &data
->size
, &my_error
))
381 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_INVALID_CONTENT
,
382 _("Error reading file %s: %s"),
383 real_file
, my_error
->message
);
384 g_clear_error (&my_error
);
387 /* Include zero termination in content_size for uncompressed files (but not in size) */
388 data
->content_size
= data
->size
+ 1;
390 if (state
->compressed
)
392 GOutputStream
*out
= g_memory_output_stream_new (NULL
, 0, g_realloc
, g_free
);
393 GZlibCompressor
*compressor
=
394 g_zlib_compressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB
, 9);
395 GOutputStream
*out2
= g_converter_output_stream_new (out
, G_CONVERTER (compressor
));
397 if (!g_output_stream_write_all (out2
, data
->content
, data
->size
,
399 !g_output_stream_close (out2
, NULL
, NULL
))
401 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_INVALID_CONTENT
,
402 _("Error compressing file %s"),
407 g_free (data
->content
);
408 data
->content_size
= g_memory_output_stream_get_size (G_MEMORY_OUTPUT_STREAM (out
));
409 data
->content
= g_memory_output_stream_steal_data (G_MEMORY_OUTPUT_STREAM (out
));
411 g_object_unref (compressor
);
412 g_object_unref (out
);
413 g_object_unref (out2
);
415 data
->flags
|= G_RESOURCE_FLAGS_COMPRESSED
;
420 g_hash_table_insert (state
->table
, key
, data
);
426 g_free (state
->alias
);
428 g_string_free (state
->string
, TRUE
);
429 state
->string
= NULL
;
430 g_free (state
->preproc_options
);
431 state
->preproc_options
= NULL
;
448 file_data_free (data
);
453 text (GMarkupParseContext
*context
,
459 ParseState
*state
= user_data
;
462 for (i
= 0; i
< text_len
; i
++)
463 if (!g_ascii_isspace (text
[i
]))
466 g_string_append_len (state
->string
, text
, text_len
);
469 g_set_error (error
, G_MARKUP_ERROR
, G_MARKUP_ERROR_INVALID_CONTENT
,
470 _("text may not appear inside <%s>"),
471 g_markup_parse_context_get_element (context
));
478 parse_resource_file (const gchar
*filename
,
479 gboolean collect_data
)
481 GMarkupParser parser
= { start_element
, end_element
, text
};
482 ParseState state
= { 0, };
483 GMarkupParseContext
*context
;
484 GError
*error
= NULL
;
486 GHashTable
*table
= NULL
;
489 if (!g_file_get_contents (filename
, &contents
, &size
, &error
))
491 g_printerr ("%s\n", error
->message
);
492 g_clear_error (&error
);
496 state
.table
= g_hash_table_new_full (g_str_hash
, g_str_equal
, g_free
, (GDestroyNotify
)file_data_free
);
497 state
.collect_data
= collect_data
;
499 context
= g_markup_parse_context_new (&parser
,
500 G_MARKUP_TREAT_CDATA_AS_TEXT
|
501 G_MARKUP_PREFIX_ERROR_POSITION
,
504 if (!g_markup_parse_context_parse (context
, contents
, size
, &error
) ||
505 !g_markup_parse_context_end_parse (context
, &error
))
507 g_printerr ("%s: %s.\n", filename
, error
->message
);
508 g_clear_error (&error
);
510 else if (collect_data
)
518 GVariantBuilder builder
;
521 table
= gvdb_hash_table_new (NULL
, NULL
);
523 g_hash_table_iter_init (&iter
, state
.table
);
524 while (g_hash_table_iter_next (&iter
, (gpointer
*)&key
, (gpointer
*)&data
))
526 key_len
= strlen (key
);
527 mykey
= g_strdup (key
);
529 item
= gvdb_hash_table_insert (table
, key
);
530 gvdb_item_set_parent (item
,
531 get_parent (table
, mykey
, key_len
));
535 g_variant_builder_init (&builder
, G_VARIANT_TYPE ("(uuay)"));
537 g_variant_builder_add (&builder
, "u", data
->size
); /* Size */
538 g_variant_builder_add (&builder
, "u", data
->flags
); /* Flags */
540 v_data
= g_variant_new_from_data (G_VARIANT_TYPE("ay"),
541 data
->content
, data
->content_size
, TRUE
,
542 g_free
, data
->content
);
543 g_variant_builder_add_value (&builder
, v_data
);
544 data
->content
= NULL
; /* Take ownership */
546 gvdb_item_set_value (item
,
547 g_variant_builder_end (&builder
));
552 table
= g_hash_table_ref (state
.table
);
555 g_hash_table_unref (state
.table
);
556 g_markup_parse_context_free (context
);
563 write_to_file (GHashTable
*table
,
564 const gchar
*filename
,
569 success
= gvdb_table_write_contents (table
, filename
,
570 G_BYTE_ORDER
!= G_LITTLE_ENDIAN
,
577 main (int argc
, char **argv
)
582 gchar
*target
= NULL
;
583 gchar
*binary_target
= NULL
;
584 gboolean generate_automatic
= FALSE
;
585 gboolean generate_source
= FALSE
;
586 gboolean generate_header
= FALSE
;
587 gboolean manual_register
= FALSE
;
588 gboolean internal
= FALSE
;
589 gboolean generate_dependencies
= FALSE
;
591 char *c_name_no_underscores
;
592 const char *linkage
= "extern";
593 GOptionContext
*context
;
594 GOptionEntry entries
[] = {
595 { "target", 0, 0, G_OPTION_ARG_FILENAME
, &target
, N_("name of the output file"), N_("FILE") },
596 { "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") },
597 { "generate", 0, 0, G_OPTION_ARG_NONE
, &generate_automatic
, N_("Generate output in the format selected for by the target filename extension"), NULL
},
598 { "generate-header", 0, 0, G_OPTION_ARG_NONE
, &generate_header
, N_("Generate source header"), NULL
},
599 { "generate-source", 0, 0, G_OPTION_ARG_NONE
, &generate_source
, N_("Generate sourcecode used to link in the resource file into your code"), NULL
},
600 { "generate-dependencies", 0, 0, G_OPTION_ARG_NONE
, &generate_dependencies
, N_("Generate dependency list"), NULL
},
601 { "manual-register", 0, 0, G_OPTION_ARG_NONE
, &manual_register
, N_("Don't automatically create and register resource"), NULL
},
602 { "internal", 0, 0, G_OPTION_ARG_NONE
, &internal
, N_("Don't export functions; declare them G_GNUC_INTERNAL"), NULL
},
603 { "c-name", 0, 0, G_OPTION_ARG_STRING
, &c_name
, N_("C identifier name used for the generated source code"), NULL
},
611 setlocale (LC_ALL
, "");
612 textdomain (GETTEXT_PACKAGE
);
615 tmp
= _glib_get_locale_dir ();
616 bindtextdomain (GETTEXT_PACKAGE
, tmp
);
619 bindtextdomain (GETTEXT_PACKAGE
, GLIB_LOCALE_DIR
);
622 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
623 bind_textdomain_codeset (GETTEXT_PACKAGE
, "UTF-8");
626 context
= g_option_context_new (N_("FILE"));
627 g_option_context_set_translation_domain (context
, GETTEXT_PACKAGE
);
628 g_option_context_set_summary (context
,
629 N_("Compile a resource specification into a resource file.\n"
630 "Resource specification files have the extension .gresource.xml,\n"
631 "and the resource file have the extension called .gresource."));
632 g_option_context_add_main_entries (context
, entries
, GETTEXT_PACKAGE
);
635 if (!g_option_context_parse (context
, &argc
, &argv
, &error
))
637 g_printerr ("%s\n", error
->message
);
641 g_option_context_free (context
);
645 g_printerr (_("You should give exactly one file name\n"));
651 linkage
= "G_GNUC_INTERNAL";
655 xmllint
= g_strdup (g_getenv ("XMLLINT"));
657 xmllint
= g_find_program_in_path ("xmllint");
659 g_printerr ("XMLLINT not set and xmllint not found in path; skipping xml preprocessing.\n");
661 gdk_pixbuf_pixdata
= g_strdup (g_getenv ("GDK_PIXBUF_PIXDATA"));
662 if (gdk_pixbuf_pixdata
== NULL
)
663 gdk_pixbuf_pixdata
= g_find_program_in_path ("gdk-pixbuf-pixdata");
667 char *dirname
= g_path_get_dirname (srcfile
);
668 char *base
= g_path_get_basename (srcfile
);
669 char *target_basename
;
670 if (g_str_has_suffix (base
, ".xml"))
671 base
[strlen(base
) - strlen (".xml")] = 0;
675 if (g_str_has_suffix (base
, ".gresource"))
676 base
[strlen(base
) - strlen (".gresource")] = 0;
677 target_basename
= g_strconcat (base
, ".c", NULL
);
679 else if (generate_header
)
681 if (g_str_has_suffix (base
, ".gresource"))
682 base
[strlen(base
) - strlen (".gresource")] = 0;
683 target_basename
= g_strconcat (base
, ".h", NULL
);
687 if (g_str_has_suffix (base
, ".gresource"))
688 target_basename
= g_strdup (base
);
690 target_basename
= g_strconcat (base
, ".gresource", NULL
);
693 target
= g_build_filename (dirname
, target_basename
, NULL
);
694 g_free (target_basename
);
698 else if (generate_automatic
)
700 if (g_str_has_suffix (target
, ".c"))
701 generate_source
= TRUE
;
702 else if (g_str_has_suffix (target
, ".h"))
703 generate_header
= TRUE
;
704 else if (g_str_has_suffix (target
, ".gresource"))
708 if ((table
= parse_resource_file (srcfile
, !generate_dependencies
)) == NULL
)
715 if (generate_dependencies
)
721 g_hash_table_iter_init (&iter
, table
);
722 while (g_hash_table_iter_next (&iter
, &key
, &data
))
725 g_print ("%s\n",file_data
->filename
);
728 else if (generate_source
|| generate_header
)
732 int fd
= g_file_open_tmp (NULL
, &binary_target
, NULL
);
735 g_printerr ("Can't open temp file\n");
744 char *base
= g_path_get_basename (srcfile
);
749 /* Remove extensions */
750 dot
= strchr (base
, '.');
754 s
= g_string_new ("");
756 for (i
= 0; base
[i
] != 0; i
++)
758 const char *first
= G_CSET_A_2_Z G_CSET_a_2_z
"_";
759 const char *rest
= G_CSET_A_2_Z G_CSET_a_2_z G_CSET_DIGITS
"_";
760 if (strchr ((i
== 0) ? first
: rest
, base
[i
]) != NULL
)
761 g_string_append_c (s
, base
[i
]);
762 else if (base
[i
] == '-')
763 g_string_append_c (s
, '_');
767 c_name
= g_string_free (s
, FALSE
);
771 binary_target
= g_strdup (target
);
773 c_name_no_underscores
= c_name
;
774 while (c_name_no_underscores
&& *c_name_no_underscores
== '_')
775 c_name_no_underscores
++;
777 if (binary_target
!= NULL
&&
778 !write_to_file (table
, binary_target
, &error
))
780 g_printerr ("%s\n", error
->message
);
790 file
= fopen (target
, "w");
793 g_printerr ("can't write to file %s", target
);
799 "#ifndef __RESOURCE_%s_H__\n"
800 "#define __RESOURCE_%s_H__\n"
802 "#include <gio/gio.h>\n"
804 "%s GResource *%s_get_resource (void);\n",
805 c_name
, c_name
, linkage
, c_name
);
810 "%s void %s_register_resource (void);\n"
811 "%s void %s_unregister_resource (void);\n"
813 linkage
, c_name
, linkage
, c_name
);
820 else if (generate_source
)
827 if (!g_file_get_contents (binary_target
, (char **)&data
,
830 g_printerr ("can't read back temporary file");
834 g_unlink (binary_target
);
836 file
= fopen (target
, "w");
839 g_printerr ("can't write to file %s", target
);
845 "#include <gio/gio.h>\n"
847 "#if defined (__ELF__) && ( __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ >= 6))\n"
848 "# define SECTION __attribute__ ((section (\".gresource.%s\"), aligned (8)))\n"
853 "static const SECTION union { const guint8 data[%"G_GSIZE_FORMAT
"]; const double alignment; void * const ptr;} %s_resource_data = { {\n",
854 c_name_no_underscores
, data_size
, c_name
);
856 for (i
= 0; i
< data_size
; i
++) {
859 fprintf (file
, "0x%2.2x", (int)data
[i
]);
860 if (i
!= data_size
- 1)
861 fprintf (file
, ", ");
862 if ((i
% 8 == 7) || (i
== data_size
- 1))
863 fprintf (file
, "\n");
866 fprintf (file
, "} };\n");
870 "static GStaticResource static_resource = { %s_resource_data.data, sizeof (%s_resource_data.data), NULL, NULL, NULL };\n"
871 "%s GResource *%s_get_resource (void);\n"
872 "GResource *%s_get_resource (void)\n"
874 " return g_static_resource_get_resource (&static_resource);\n"
876 c_name
, c_name
, linkage
, c_name
, c_name
);
883 "%s void %s_unregister_resource (void);\n"
884 "void %s_unregister_resource (void)\n"
886 " g_static_resource_fini (&static_resource);\n"
889 "%s void %s_register_resource (void);\n"
890 "void %s_register_resource (void)\n"
892 " g_static_resource_init (&static_resource);\n"
894 linkage
, c_name
, c_name
, linkage
, c_name
, c_name
);
898 fprintf (file
, "%s", gconstructor_code
);
901 "#ifdef G_HAS_CONSTRUCTORS\n"
903 "#ifdef G_DEFINE_CONSTRUCTOR_NEEDS_PRAGMA\n"
904 "#pragma G_DEFINE_CONSTRUCTOR_PRAGMA_ARGS(resource_constructor)\n"
906 "G_DEFINE_CONSTRUCTOR(resource_constructor)\n"
907 "#ifdef G_DEFINE_DESTRUCTOR_NEEDS_PRAGMA\n"
908 "#pragma G_DEFINE_DESTRUCTOR_PRAGMA_ARGS(resource_destructor)\n"
910 "G_DEFINE_DESTRUCTOR(resource_destructor)\n"
913 "#warning \"Constructor not supported on this compiler, linking in resources will not work\"\n"
916 "static void resource_constructor (void)\n"
918 " g_static_resource_init (&static_resource);\n"
921 "static void resource_destructor (void)\n"
923 " g_static_resource_fini (&static_resource);\n"
932 g_free (binary_target
);
934 g_hash_table_destroy (table
);