// Generated by gmmproc 2.66.3 -- DO NOT MODIFY! #ifndef _GIOMM_RESOURCE_H #define _GIOMM_RESOURCE_H #include #include /* Copyright (C) 2012 The gtkmm Development Team * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library. If not, see . */ #include #include #include #include #include #include #ifndef DOXYGEN_SHOULD_SKIP_THIS typedef struct _GResource GResource; #endif namespace Gio { /** %Exception class for resource file handling errors. * * @newin{2,34} */ class GIOMM_API ResourceError : public Glib::Error { public: /** @var Code NOT_FOUND * No file was found at the requested path. * * @var Code INTERNAL * Unknown error. * * @enum Code * * An error code used with G_RESOURCE_ERROR in a Error returned * from a Resource routine. * * @newin{2,34} */ enum Code { NOT_FOUND, INTERNAL }; ResourceError(Code error_code, const Glib::ustring& error_message); explicit ResourceError(GError* gobject); Code code() const; #ifndef DOXYGEN_SHOULD_SKIP_THIS private: static void throw_func(GError* gobject); friend GIOMM_API void wrap_init(); // uses throw_func() #endif //DOXYGEN_SHOULD_SKIP_THIS }; /** @addtogroup giommEnums giomm Enums and Flags */ /** * @var ResourceFlags RESOURCE_FLAGS_NONE * No flags set. * * @var ResourceFlags RESOURCE_FLAGS_COMPRESSED * The file is compressed. * * @enum ResourceFlags * * GResourceFlags give information about a particular file inside a resource * bundle. * * @newin{2,44} * * @ingroup giommEnums * @par Bitwise operators: * %ResourceFlags operator|(ResourceFlags, ResourceFlags)
* %ResourceFlags operator&(ResourceFlags, ResourceFlags)
* %ResourceFlags operator^(ResourceFlags, ResourceFlags)
* %ResourceFlags operator~(ResourceFlags)
* %ResourceFlags& operator|=(ResourceFlags&, ResourceFlags)
* %ResourceFlags& operator&=(ResourceFlags&, ResourceFlags)
* %ResourceFlags& operator^=(ResourceFlags&, ResourceFlags)
*/ enum ResourceFlags { RESOURCE_FLAGS_NONE = 0x0, RESOURCE_FLAGS_COMPRESSED = (1<<0) }; /** @ingroup giommEnums */ inline ResourceFlags operator|(ResourceFlags lhs, ResourceFlags rhs) { return static_cast(static_cast(lhs) | static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceFlags operator&(ResourceFlags lhs, ResourceFlags rhs) { return static_cast(static_cast(lhs) & static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceFlags operator^(ResourceFlags lhs, ResourceFlags rhs) { return static_cast(static_cast(lhs) ^ static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceFlags operator~(ResourceFlags flags) { return static_cast(~static_cast(flags)); } /** @ingroup giommEnums */ inline ResourceFlags& operator|=(ResourceFlags& lhs, ResourceFlags rhs) { return (lhs = static_cast(static_cast(lhs) | static_cast(rhs))); } /** @ingroup giommEnums */ inline ResourceFlags& operator&=(ResourceFlags& lhs, ResourceFlags rhs) { return (lhs = static_cast(static_cast(lhs) & static_cast(rhs))); } /** @ingroup giommEnums */ inline ResourceFlags& operator^=(ResourceFlags& lhs, ResourceFlags rhs) { return (lhs = static_cast(static_cast(lhs) ^ static_cast(rhs))); } } // namespace Gio #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class GIOMM_API Value : public Glib::Value_Flags { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gio { /** * @var ResourceLookupFlags RESOURCE_LOOKUP_FLAGS_NONE * No flags set. * * @enum ResourceLookupFlags * * GResourceLookupFlags determine how resource path lookups are handled. * * @newin{2,44} * * @ingroup giommEnums * @par Bitwise operators: * %ResourceLookupFlags operator|(ResourceLookupFlags, ResourceLookupFlags)
* %ResourceLookupFlags operator&(ResourceLookupFlags, ResourceLookupFlags)
* %ResourceLookupFlags operator^(ResourceLookupFlags, ResourceLookupFlags)
* %ResourceLookupFlags operator~(ResourceLookupFlags)
* %ResourceLookupFlags& operator|=(ResourceLookupFlags&, ResourceLookupFlags)
* %ResourceLookupFlags& operator&=(ResourceLookupFlags&, ResourceLookupFlags)
* %ResourceLookupFlags& operator^=(ResourceLookupFlags&, ResourceLookupFlags)
*/ enum ResourceLookupFlags { RESOURCE_LOOKUP_FLAGS_NONE = 0x0 }; /** @ingroup giommEnums */ inline ResourceLookupFlags operator|(ResourceLookupFlags lhs, ResourceLookupFlags rhs) { return static_cast(static_cast(lhs) | static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceLookupFlags operator&(ResourceLookupFlags lhs, ResourceLookupFlags rhs) { return static_cast(static_cast(lhs) & static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceLookupFlags operator^(ResourceLookupFlags lhs, ResourceLookupFlags rhs) { return static_cast(static_cast(lhs) ^ static_cast(rhs)); } /** @ingroup giommEnums */ inline ResourceLookupFlags operator~(ResourceLookupFlags flags) { return static_cast(~static_cast(flags)); } /** @ingroup giommEnums */ inline ResourceLookupFlags& operator|=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs) { return (lhs = static_cast(static_cast(lhs) | static_cast(rhs))); } /** @ingroup giommEnums */ inline ResourceLookupFlags& operator&=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs) { return (lhs = static_cast(static_cast(lhs) & static_cast(rhs))); } /** @ingroup giommEnums */ inline ResourceLookupFlags& operator^=(ResourceLookupFlags& lhs, ResourceLookupFlags rhs) { return (lhs = static_cast(static_cast(lhs) ^ static_cast(rhs))); } } // namespace Gio #ifndef DOXYGEN_SHOULD_SKIP_THIS namespace Glib { template <> class GIOMM_API Value : public Glib::Value_Flags { public: static GType value_type() G_GNUC_CONST; }; } // namespace Glib #endif /* DOXYGEN_SHOULD_SKIP_THIS */ namespace Gio { /** %Resource framework. * * Applications and libraries often contain binary or textual data that is * really part of the application, rather than user data. For instance * Gtk::Builder .ui files, splashscreen images, Gio::Menu markup xml, CSS files, * icons, etc. These are often shipped as files in `$datadir/appname`, or * manually included as literal strings in the code. * * The Gio::Resource API and the glib-compile-resources program * provide a convenient and efficient alternative to this which has some nice properties. You * maintain the files as normal files, so it's easy to edit them, but during the build the files * are combined into a binary bundle that is linked into the executable. This means that loading * the resource files is efficient (as they are already in memory, shared with other instances) and * simple (no need to check for things like I/O errors or locate the files in the filesystem). It * also makes it easier to create relocatable applications. * * %Resource files can also be marked as compressed. Such files will be included in the resource bundle * in a compressed form, but will be automatically uncompressed when the resource is used. This * is very useful e.g. for larger text files that are parsed once (or rarely) and then thrown away. * * %Resource files can also be marked to be preprocessed, by setting the value of the * `preprocess` attribute to a comma-separated list of preprocessing options. * The only options currently supported are: * *
*
xml-stripblanks
*
which will use the xmllint command * to strip ignorable whitespace from the xml file. For this to work, * the `XMLLINT` environment variable must be set to the full path to * the xmllint executable, or xmllint must be in the `PATH`; otherwise * the preprocessing step is skipped.
* *
to-pixdata
*
which will use the gdk-pixbuf-pixdata command to convert * images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside * the resource file, rather than an (uncompressed) copy of it. For this, the gdk-pixbuf-pixdata * program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be * set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will * abort.
*
* * %Resource bundles are created by the glib-compile-resources program * which takes an xml file that describes the bundle, and a set of files that the xml references. These * are combined into a binary resource bundle. * * An example resource description: * @code * * * * data/splashscreen.png * dialog.ui * menumarkup.xml * * * @endcode * * This will create a resource bundle with the following files: * @code * /org/gtk/Example/data/splashscreen.png * /org/gtk/Example/dialog.ui * /org/gtk/Example/menumarkup.xml * @endcode * * Note that all resources in the process share the same namespace, so use java-style * path prefixes (like in the above example) to avoid conflicts. * * You can then use glib-compile-resources to compile the xml to a binary bundle * that you can load with Gio::Resource::create_from_file(). However, it's more common to use the --generate-source and * --generate-header arguments to create a source file and header to link directly into your application. * * Once a Gio::Resource has been created and registered all the data in it can be accessed globally in the process by * using API calls like Gio::Resource::open_stream_from_global_resources() to stream the data * or Gio::Resource::lookup_data_in_global_resources() to get a direct pointer * to the data. You can also use uris like "resource:///org/gtk/Example/data/splashscreen.png" with Gio::File to access * the resource data. * * There are two forms of the generated source, the default version uses the compiler support for constructor * and destructor functions (where available) to automatically create and register the Gio::Resource on startup * or library load time. If you pass --manual-register, two functions to register/unregister the resource is instead * created. This requires an explicit initialization call in your application/library, but it works on all platforms, * even on the minor ones where this is not available. (Constructor support is available for at least Win32, MacOS and Linux.) * * Note that resource data can point directly into the data segment of e.g. a library, so if you are unloading libraries * during runtime you need to be very careful with keeping around pointers to data from a resource, as this goes away * when the library is unloaded. However, in practice this is not generally a problem, since most resource accesses * is for your own resources, and resource data is often used once, during parsing, and then released. * * @newin{2,44} */ class GIOMM_API Resource final { public: #ifndef DOXYGEN_SHOULD_SKIP_THIS using CppObjectType = Resource; using BaseObjectType = GResource; #endif /* DOXYGEN_SHOULD_SKIP_THIS */ /** Increment the reference count for this object. * You should never need to do this manually - use the object via a RefPtr instead. */ void reference() const; /** Decrement the reference count for this object. * You should never need to do this manually - use the object via a RefPtr instead. */ void unreference() const; ///Provides access to the underlying C instance. GResource* gobj(); ///Provides access to the underlying C instance. const GResource* gobj() const; ///Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. GResource* gobj_copy() const; Resource() = delete; // noncopyable Resource(const Resource&) = delete; Resource& operator=(const Resource&) = delete; protected: // Do not derive this. Gio::Resource can neither be constructed nor deleted. void operator delete(void*, std::size_t); private: public: /** Creates a GResource from a reference to the binary resource bundle. * This will keep a reference to @a data while the resource lives, so * the data should not be modified or freed. * * If you want to use this resource in the global resource namespace you need * to register it with g_resources_register(). * * @note @a data must be backed by memory that is at least pointer aligned. * Otherwise this function will internally create a copy of the memory since * GLib 2.56, or in older versions fail and exit the process. * * If @a data is empty or corrupt, RESOURCE_ERROR_INTERNAL will be returned. * * @newin{2,44} * * @param data A Bytes. * @return A new Resource, or nullptr on error. * * @throws Glib::Error */ static Glib::RefPtr create_from_data(const Glib::RefPtr& data); /** Loads a binary resource bundle and creates a Resource representation of it, allowing * you to query it for data. * * If you want to use this resource in the global resource namespace you need * to register it with g_resources_register(). * * If @a filename is empty or the data in it is corrupt, * RESOURCE_ERROR_INTERNAL will be returned. If @a filename doesn’t exist, or * there is an error in reading it, an error from Glib::mapped_file_new() will be * returned. * * @newin{2,44} * * @param filename The path of a filename to load, in the GLib filename encoding. * @return A new Resource, or nullptr on error. * * @throws Glib::Error */ static Glib::RefPtr create_from_file(const std::string& filename); /** Looks for a file at the specified @a path in the resource and * returns a InputStream that lets you read the data. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return InputStream or nullptr on error. * Free the returned object with Glib::object_unref(). * * @throws Glib::Error */ Glib::RefPtr open_stream(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; /** Looks for a file at the specified @a path in the resource and * returns a Bytes that lets you directly access the data in * memory. * * The data is always followed by a zero byte, so you * can safely use the data as a C string. However, that byte * is not included in the size of the GBytes. * * For uncompressed resource files this is a pointer directly into * the resource bundle, which is typically in some readonly data section * in the program binary. For compressed files we allocate memory on * the heap and automatically uncompress the data. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return Bytes or nullptr on error. * Free the returned object with Glib::bytes_unref(). * * @throws Glib::Error */ Glib::RefPtr lookup_data(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; /** Returns all the names of children at the specified @a path in the resource. * * If @a path is invalid or does not exist in the Resource, * RESOURCE_ERROR_NOT_FOUND will be returned. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return An array of constant strings. * * @throws Glib::Error */ std::vector enumerate_children(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; /** Looks for a file at the specified @a path in the resource and * if found returns information about it. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param[out] size A location to place the length of the contents of the file. * @param[out] flags A location to place the flags about the file. * @param lookup_flags A ResourceLookupFlags. * @throw Gio::ResourceError if the file was not found. */ void get_info(const std::string& path, gsize& size, ResourceFlags& flags, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; /** Looks for a file at the specified @a path in the resource. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @throw Gio::ResourceError if the file was not found. */ void get_file_exists(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; /** Looks for a file at the specified @a path in the resource. * * @a lookup_flags controls the behaviour of the lookup. * This method returns a bool instead of throwing in exception in case of errors. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return true if the file was found, false if there were errors. */ bool get_file_exists_nothrow(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE) const; // 'register' is a keyword. Can't be the name of a method. /** Registers the resource with the process-global set of resources. * Once a resource is registered the files in it can be accessed * with the global resource lookup functions like g_resources_lookup_data(). * * @newin{2,44} */ void register_global(); /** Unregisters the resource from the process-global set of resources. * * @newin{2,44} */ void unregister_global(); /** Looks for a file at the specified @a path in the set of * globally registered resources and returns a InputStream * that lets you read the data. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return InputStream or nullptr on error. * Free the returned object with Glib::object_unref(). * * @throws Glib::Error */ static Glib::RefPtr open_stream_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); /** Looks for a file at the specified @a path in the set of * globally registered resources and returns a Bytes that * lets you directly access the data in memory. * * The data is always followed by a zero byte, so you * can safely use the data as a C string. However, that byte * is not included in the size of the GBytes. * * For uncompressed resource files this is a pointer directly into * the resource bundle, which is typically in some readonly data section * in the program binary. For compressed files we allocate memory on * the heap and automatically uncompress the data. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return Bytes or nullptr on error. * Free the returned object with Glib::bytes_unref(). * * @throws Glib::Error */ static Glib::RefPtr lookup_data_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); /** Returns all the names of children at the specified @a path in the set of * globally registered resources. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return An array of constant strings. * * @throws Glib::Error */ static std::vector enumerate_children_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); /** Looks for a file at the specified @a path in the set of * globally registered resources and if found returns information about it. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param[out] size A location to place the length of the contents of the file. * @param[out] flags A location to place the flags about the file. * @param lookup_flags A ResourceLookupFlags. * @throw Gio::ResourceError if the file was not found. */ static void get_info_global(const std::string& path, gsize& size, ResourceFlags& flags, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); /** Looks for a file at the specified @a path in the set of * globally registered resources. * * @a lookup_flags controls the behaviour of the lookup. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @throw Gio::ResourceError if the file was not found. */ static void get_file_exists_global(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); /** Looks for a file at the specified @a path in the set of * globally registered resources. * * @a lookup_flags controls the behaviour of the lookup. * This method returns a bool instead of throwing in exception in case of errors. * * @newin{2,44} * * @param path A pathname inside the resource. * @param lookup_flags A ResourceLookupFlags. * @return true if the file was found, false if there were errors. */ static bool get_file_exists_global_nothrow(const std::string& path, ResourceLookupFlags lookup_flags = RESOURCE_LOOKUP_FLAGS_NONE); }; } // namespace Gio namespace Glib { /** A Glib::wrap() method for this object. * * @param object The C instance. * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref. * @result A C++ instance that wraps this C instance. * * @relates Gio::Resource */ GIOMM_API Glib::RefPtr wrap(GResource* object, bool take_copy = false); } // namespace Glib #endif /* _GIOMM_RESOURCE_H */