gresource.c 44.2 KB
Newer Older
1 2 3 4 5 6 7
/* GIO - GLib Input, Output and Streaming Library
 *
 * Copyright © 2011 Red Hat, Inc
 *
 * 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
8
 * version 2.1 of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * 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
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18 19 20 21 22 23 24 25 26
 *
 * Authors: Alexander Larsson <alexl@redhat.com>
 */

#include "config.h"

#include <string.h>

#include "gresource.h"
#include <gvdb/gvdb-reader.h>
Stanislav Brabec's avatar
Stanislav Brabec committed
27
#include <gi18n-lib.h>
28 29 30
#include <gstdio.h>
#include <gio/gfile.h>
#include <gio/gioerror.h>
31 32 33 34 35 36 37 38 39 40 41
#include <gio/gmemoryinputstream.h>
#include <gio/gzlibdecompressor.h>
#include <gio/gconverterinputstream.h>

struct _GResource
{
  int ref_count;

  GvdbTable *table;
};

42
static void register_lazy_static_resources (void);
43

44 45 46 47 48 49 50
G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)

/**
 * SECTION:gresource
 * @short_description: Resource framework
 * @include: gio/gio.h
 *
51 52
 * Applications and libraries often contain binary or textual data that is
 * really part of the application, rather than user data. For instance
53
 * #GtkBuilder .ui files, splashscreen images, GMenu markup XML, CSS files,
54
 * icons, etc. These are often shipped as files in `$datadir/appname`, or
55 56
 * manually included as literal strings in the code.
 *
57
 * The #GResource API and the [glib-compile-resources][glib-compile-resources] program
58 59 60 61 62 63 64
 * provide a convenient and efficient alternative to this which has some nice properties. You
 * maintain the files as normal files, so its 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 are 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.
 *
Kalev Lember's avatar
Kalev Lember committed
65
 * Resource files can also be marked as compressed. Such files will be included in the resource bundle
66 67 68
 * 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.
 *
69
 * Resource files can also be marked to be preprocessed, by setting the value of the
70
 * `preprocess` attribute to a comma-separated list of preprocessing options.
71 72
 * The only options currently supported are:
 *
73
 * `xml-stripblanks` which will use the xmllint command
74
 * to strip ignorable whitespace from the XML file. For this to work,
75 76 77
 * 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.
78
 *
79
 * `to-pixdata` which will use the gdk-pixbuf-pixdata command to convert
80
 * images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
81
 * the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata
82
 * program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be
83 84
 * set to the full path to the gdk-pixbuf-pixdata executable; otherwise the resource compiler will
 * abort.
85
 *
86 87 88 89 90 91 92
 * Resource files will be exported in the GResource namespace using the
 * combination of the given `prefix` and the filename from the `file` element.
 * The `alias` attribute can be used to alter the filename to expose them at a
 * different location in the resource namespace. Typically, this is used to
 * include files from a different source directory without exposing the source
 * directory in the resource namespace, as in the example below.
 *
93
 * Resource bundles are created by the [glib-compile-resources][glib-compile-resources] program
94
 * which takes an XML file that describes the bundle, and a set of files that the XML references. These
95 96
 * are combined into a binary resource bundle.
 *
97 98
 * An example resource description:
 * |[
99 100 101 102 103
 * <?xml version="1.0" encoding="UTF-8"?>
 * <gresources>
 *   <gresource prefix="/org/gtk/Example">
 *     <file>data/splashscreen.png</file>
 *     <file compressed="true">dialog.ui</file>
104
 *     <file preprocess="xml-stripblanks">menumarkup.xml</file>
105
 *     <file alias="example.css">data/example.css</file>
106 107
 *   </gresource>
 * </gresources>
108
 * ]|
109 110
 *
 * This will create a resource bundle with the following files:
111
 * |[
112 113 114
 * /org/gtk/Example/data/splashscreen.png
 * /org/gtk/Example/dialog.ui
 * /org/gtk/Example/menumarkup.xml
115
 * /org/gtk/Example/example.css
116
 * ]|
117
 *
118
 * Note that all resources in the process share the same namespace, so use Java-style
119 120
 * path prefixes (like in the above example) to avoid conflicts.
 *
121
 * You can then use [glib-compile-resources][glib-compile-resources] to compile the XML to a
122 123
 * binary bundle that you can load with g_resource_load(). However, its more common to use the --generate-source and
 * --generate-header arguments to create a source file and header to link directly into your application.
124 125 126 127 128 129
 * This will generate `get_resource()`, `register_resource()` and
 * `unregister_resource()` functions, prefixed by the `--c-name` argument passed
 * to [glib-compile-resources][glib-compile-resources]. `get_resource()` returns
 * the generated #GResource object. The register and unregister functions
 * register the resource so its files can be accessed using
 * g_resources_lookup_data().
130 131 132
 *
 * Once a #GResource has been created and registered all the data in it can be accessed globally in the process by
 * using API calls like g_resources_open_stream() to stream the data or g_resources_lookup_data() to get a direct pointer
133
 * to the data. You can also use URIs like "resource:///org/gtk/Example/data/splashscreen.png" with #GFile to access
134 135
 * the resource data.
 *
136 137 138 139
 * Some higher-level APIs, such as #GtkApplication, will automatically load
 * resources from certain well-known paths in the resource namespace as a
 * convenience. See the documentation for those APIs for details.
 *
140
 * There are two forms of the generated source, the default version uses the compiler support for constructor
141
 * and destructor functions (where available) to automatically create and register the #GResource on startup
142 143 144
 * or library load time. If you pass `--manual-register`, two functions to register/unregister the resource are created
 * instead. This requires an explicit initialization call in your application/library, but it works on all platforms,
 * even on the minor ones where constructors are not supported. (Constructor support is available for at least Win32, Mac OS and Linux.)
145 146 147 148
 *
 * 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
149
 * are for your own resources, and resource data is often used once, during parsing, and then released.
150
 *
151 152
 * When debugging a program or testing a change to an installed version, it is often useful to be able to
 * replace resources in the program or library, without recompiling, for debugging or quick hacking and testing
153
 * purposes. Since GLib 2.50, it is possible to use the `G_RESOURCE_OVERLAYS` environment variable to selectively overlay
154
 * resources with replacements from the filesystem.  It is a %G_SEARCHPATH_SEPARATOR-separated list of substitutions to perform
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
 * during resource lookups.
 *
 * A substitution has the form
 *
 * |[
 *    /org/gtk/libgtk=/home/desrt/gtk-overlay
 * ]|
 *
 * The part before the `=` is the resource subpath for which the overlay applies.  The part after is a
 * filesystem path which contains files and subdirectories as you would like to be loaded as resources with the
 * equivalent names.
 *
 * In the example above, if an application tried to load a resource with the resource path
 * `/org/gtk/libgtk/ui/gtkdialog.ui` then GResource would check the filesystem path
 * `/home/desrt/gtk-overlay/ui/gtkdialog.ui`.  If a file was found there, it would be used instead.  This is an
 * overlay, not an outright replacement, which means that if a file is not found at that path, the built-in
 * version will be used instead.  Whiteouts are not currently supported.
 *
 * Substitutions must start with a slash, and must not contain a trailing slash before the '='.  The path after
 * the slash should ideally be absolute, but this is not strictly required.  It is possible to overlay the
 * location of a single resource with an individual file.
 *
177 178 179
 * Since: 2.32
 */

180 181 182 183 184 185
/**
 * GStaticResource:
 *
 * #GStaticResource is an opaque data structure and can only be accessed
 * using the following functions.
 **/
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
typedef gboolean (* CheckCandidate) (const gchar *candidate, gpointer user_data);

static gboolean
open_overlay_stream (const gchar *candidate,
                     gpointer     user_data)
{
  GInputStream **res = (GInputStream **) user_data;
  GError *error = NULL;
  GFile *file;

  file = g_file_new_for_path (candidate);
  *res = (GInputStream *) g_file_read (file, NULL, &error);

  if (*res)
    {
      g_message ("Opened file '%s' as a resource overlay", candidate);
    }
  else
    {
      if (!g_error_matches (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
        g_warning ("Can't open overlay file '%s': %s", candidate, error->message);
      g_error_free (error);
    }

  g_object_unref (file);

  return *res != NULL;
}

static gboolean
get_overlay_bytes (const gchar *candidate,
                   gpointer     user_data)
{
  GBytes **res = (GBytes **) user_data;
  GMappedFile *mapped_file;
  GError *error = NULL;

  mapped_file = g_mapped_file_new (candidate, FALSE, &error);

  if (mapped_file)
    {
      g_message ("Mapped file '%s' as a resource overlay", candidate);
      *res = g_mapped_file_get_bytes (mapped_file);
      g_mapped_file_unref (mapped_file);
    }
  else
    {
      if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
        g_warning ("Can't mmap overlay file '%s': %s", candidate, error->message);
      g_error_free (error);
    }

  return *res != NULL;
}

static gboolean
enumerate_overlay_dir (const gchar *candidate,
                       gpointer     user_data)
{
  GHashTable **hash = (GHashTable **) user_data;
  GError *error = NULL;
  GDir *dir;
  const gchar *name;

  dir = g_dir_open (candidate, 0, &error);
  if (dir)
    {
      if (*hash == NULL)
        /* note: keep in sync with same line below */
        *hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);

      g_message ("Enumerating directory '%s' as resource overlay", candidate);

      while ((name = g_dir_read_name (dir)))
        {
          gchar *fullname = g_build_filename (candidate, name, NULL);

          /* match gvdb behaviour by suffixing "/" on dirs */
264
          if (g_file_test (fullname, G_FILE_TEST_IS_DIR))
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
            g_hash_table_add (*hash, g_strconcat (name, "/", NULL));
          else
            g_hash_table_add (*hash, g_strdup (name));

          g_free (fullname);
        }

      g_dir_close (dir);
    }
  else
    {
      if (!g_error_matches (error, G_FILE_ERROR, G_FILE_ERROR_NOENT))
        g_warning ("Can't enumerate overlay directory '%s': %s", candidate, error->message);
      g_error_free (error);
      return FALSE;
    }

  /* We may want to enumerate results from more than one overlay
   * directory.
   */
  return FALSE;
}

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
typedef struct {
  gsize size;
  guint32 flags;
} InfoData;

static gboolean
get_overlay_info (const gchar *candidate,
                  gpointer     user_data)
{
  InfoData *info = user_data;
  GStatBuf buf;

  if (g_stat (candidate, &buf) < 0)
    return FALSE;

  info->size = buf.st_size;
  info->flags = G_RESOURCE_FLAGS_NONE;

  return TRUE;
}

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
static gboolean
g_resource_find_overlay (const gchar    *path,
                         CheckCandidate  check,
                         gpointer        user_data)
{
  /* This is a null-terminated array of replacement strings (with '=' inside) */
  static const gchar * const *overlay_dirs;
  gboolean res = FALSE;
  gint path_len = -1;
  gint i;

  /* We try to be very fast in case there are no overlays.  Otherwise,
   * we can take a bit more time...
   */

  if (g_once_init_enter (&overlay_dirs))
    {
      const gchar * const *result;
      const gchar *envvar;

      envvar = g_getenv ("G_RESOURCE_OVERLAYS");
      if (envvar != NULL)
        {
          gchar **parts;
          gint i, j;

335
          parts = g_strsplit (envvar, G_SEARCHPATH_SEPARATOR_S, 0);
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380

          /* Sanity check the parts, dropping those that are invalid.
           * 'i' may grow faster than 'j'.
           */
          for (i = j = 0; parts[i]; i++)
            {
              gchar *part = parts[i];
              gchar *eq;

              eq = strchr (part, '=');
              if (eq == NULL)
                {
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' lacks '='.  Ignoring.", part);
                  g_free (part);
                  continue;
                }

              if (eq == part)
                {
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' lacks path before '='.  Ignoring.", part);
                  g_free (part);
                  continue;
                }

              if (eq[1] == '\0')
                {
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' lacks path after '='.  Ignoring", part);
                  g_free (part);
                  continue;
                }

              if (part[0] != '/')
                {
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' lacks leading '/'.  Ignoring.", part);
                  g_free (part);
                  continue;
                }

              if (eq[-1] == '/')
                {
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' has trailing '/' before '='.  Ignoring", part);
                  g_free (part);
                  continue;
                }

381
              if (!g_path_is_absolute (eq + 1))
382
                {
383
                  g_critical ("G_RESOURCE_OVERLAYS segment '%s' does not have an absolute path after '='.  Ignoring", part);
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
                  g_free (part);
                  continue;
                }

              g_message ("Adding GResources overlay '%s'", part);
              parts[j++] = part;
            }

          parts[j] = NULL;

          result = (const gchar **) parts;
        }
      else
        {
          /* We go out of the way to avoid malloc() in the normal case
           * where the environment variable is not set.
           */
          static const gchar * const empty_strv[0 + 1];
          result = empty_strv;
        }

      g_once_init_leave (&overlay_dirs, result);
    }

  for (i = 0; overlay_dirs[i]; i++)
    {
      const gchar *src;
      gint src_len;
      const gchar *dst;
      gint dst_len;
      gchar *candidate;

      {
        gchar *eq;

        /* split the overlay into src/dst */
        src = overlay_dirs[i];
        eq = strchr (src, '=');
        g_assert (eq); /* we checked this already */
        src_len = eq - src;
        dst = eq + 1;
        /* hold off on dst_len because we will probably fail the checks below */
      }

      if (path_len == -1)
        path_len = strlen (path);

      /* The entire path is too short to match the source */
      if (path_len < src_len)
        continue;

      /* It doesn't match the source */
      if (memcmp (path, src, src_len) != 0)
        continue;

      /* The prefix matches, but it's not a complete path component */
      if (path[src_len] && path[src_len] != '/')
        continue;

      /* OK.  Now we need this. */
      dst_len = strlen (dst);

      /* The candidate will be composed of:
       *
       *    dst + remaining_path + nul
       */
      candidate = g_malloc (dst_len + (path_len - src_len) + 1);
      memcpy (candidate, dst, dst_len);
      memcpy (candidate + dst_len, path + src_len, path_len - src_len);
      candidate[dst_len + (path_len - src_len)] = '\0';

      /* No matter what, 'r' is what we need, including the case where
       * we are trying to enumerate a directory.
       */
      res = (* check) (candidate, user_data);
      g_free (candidate);

      if (res)
        break;
    }

  return res;
}
467

468 469 470 471 472
/**
 * g_resource_error_quark:
 *
 * Gets the #GResource Error Quark.
 *
473
 * Returns: a #GQuark
474 475 476
 *
 * Since: 2.32
 */
477
G_DEFINE_QUARK (g-resource-error-quark, g_resource_error)
478 479 480

/**
 * g_resource_ref:
Matthias Clasen's avatar
Matthias Clasen committed
481
 * @resource: A #GResource
482
 *
483
 * Atomically increments the reference count of @resource by one. This
484 485
 * function is MT-safe and may be called from any thread.
 *
Matthias Clasen's avatar
Matthias Clasen committed
486
 * Returns: The passed in #GResource
487 488 489 490 491 492 493 494 495 496 497 498
 *
 * Since: 2.32
 **/
GResource *
g_resource_ref (GResource *resource)
{
  g_atomic_int_inc (&resource->ref_count);
  return resource;
}

/**
 * g_resource_unref:
Matthias Clasen's avatar
Matthias Clasen committed
499
 * @resource: A #GResource
500 501
 *
 * Atomically decrements the reference count of @resource by one. If the
502
 * reference count drops to 0, all memory allocated by the resource is
503 504 505 506 507 508 509 510 511 512
 * released. This function is MT-safe and may be called from any
 * thread.
 *
 * Since: 2.32
 **/
void
g_resource_unref (GResource *resource)
{
  if (g_atomic_int_dec_and_test (&resource->ref_count))
    {
513
      gvdb_table_free (resource->table);
514 515 516 517
      g_free (resource);
    }
}

518
/*< internal >
519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
 * g_resource_new_from_table:
 * @table: (transfer full): a GvdbTable
 *
 * Returns: (transfer full): a new #GResource for @table
 */
static GResource *
g_resource_new_from_table (GvdbTable *table)
{
  GResource *resource;

  resource = g_new (GResource, 1);
  resource->ref_count = 1;
  resource->table = table;

  return resource;
}

536 537 538 539 540 541 542 543 544 545 546 547 548
static void
g_resource_error_from_gvdb_table_error (GError **g_resource_error,
                                        GError  *gvdb_table_error  /* (transfer full) */)
{
  if (g_error_matches (gvdb_table_error, G_FILE_ERROR, G_FILE_ERROR_INVAL))
    g_set_error_literal (g_resource_error,
                         G_RESOURCE_ERROR, G_RESOURCE_ERROR_INTERNAL,
                         gvdb_table_error->message);
  else
    g_propagate_error (g_resource_error, g_steal_pointer (&gvdb_table_error));
  g_clear_error (&gvdb_table_error);
}

549 550
/**
 * g_resource_new_from_data:
Matthias Clasen's avatar
Matthias Clasen committed
551 552
 * @data: A #GBytes
 * @error: return location for a #GError, or %NULL
553 554 555 556 557 558 559 560
 *
 * Creates a GResource from a reference to the binary resource bundle.
 * This will keep a reference to @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().
 *
561
 * Note: @data must be backed by memory that is at least pointer aligned.
562 563
 * Otherwise this function will internally create a copy of the memory since
 * GLib 2.56, or in older versions fail and exit the process.
564
 *
565 566
 * If @data is empty or corrupt, %G_RESOURCE_ERROR_INTERNAL will be returned.
 *
567
 * Returns: (transfer full): a new #GResource, or %NULL on error
568 569 570 571
 *
 * Since: 2.32
 **/
GResource *
Matthias Clasen's avatar
Matthias Clasen committed
572 573
g_resource_new_from_data (GBytes  *data,
                          GError **error)
574 575
{
  GvdbTable *table;
576
  gboolean unref_data = FALSE;
577
  GError *local_error = NULL;
578 579 580 581 582 583 584

  if (((guintptr) g_bytes_get_data (data, NULL)) % sizeof (gpointer) != 0)
    {
      data = g_bytes_new (g_bytes_get_data (data, NULL),
                          g_bytes_get_size (data));
      unref_data = TRUE;
    }
585

586
  table = gvdb_table_new_from_bytes (data, TRUE, &local_error);
587

588 589 590
  if (unref_data)
    g_bytes_unref (data);

591
  if (table == NULL)
592 593 594 595
    {
      g_resource_error_from_gvdb_table_error (error, g_steal_pointer (&local_error));
      return NULL;
    }
596

597
  return g_resource_new_from_table (table);
598 599 600 601
}

/**
 * g_resource_load:
Matthias Clasen's avatar
Matthias Clasen committed
602 603
 * @filename: (type filename): the path of a filename to load, in the GLib filename encoding
 * @error: return location for a #GError, or %NULL
604 605 606 607 608 609 610
 *
 * Loads a binary resource bundle and creates a #GResource 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().
 *
611 612 613 614 615
 * If @filename is empty or the data in it is corrupt,
 * %G_RESOURCE_ERROR_INTERNAL will be returned. If @filename doesn’t exist, or
 * there is an error in reading it, an error from g_mapped_file_new() will be
 * returned.
 *
616
 * Returns: (transfer full): a new #GResource, or %NULL on error
617 618 619 620
 *
 * Since: 2.32
 **/
GResource *
Matthias Clasen's avatar
Matthias Clasen committed
621 622
g_resource_load (const gchar  *filename,
                 GError      **error)
623 624
{
  GvdbTable *table;
625
  GError *local_error = NULL;
626

627
  table = gvdb_table_new (filename, FALSE, &local_error);
628
  if (table == NULL)
629 630 631 632
    {
      g_resource_error_from_gvdb_table_error (error, g_steal_pointer (&local_error));
      return NULL;
    }
633

634
  return g_resource_new_from_table (table);
635 636
}

637 638 639 640 641 642 643 644 645
static gboolean
do_lookup (GResource             *resource,
           const gchar           *path,
           GResourceLookupFlags   lookup_flags,
           gsize                 *size,
           guint32               *flags,
           const void           **data,
           gsize                 *data_size,
           GError               **error)
646 647 648 649 650 651
{
  char *free_path = NULL;
  gsize path_len;
  gboolean res = FALSE;
  GVariant *value;

652
  /* Drop any trailing slash. */
653
  path_len = strlen (path);
654
  if (path_len >= 1 && path[path_len-1] == '/')
655 656 657 658 659
    {
      path = free_path = g_strdup (path);
      free_path[path_len-1] = 0;
    }

660
  value = gvdb_table_get_raw_value (resource->table, path);
661 662 663 664

  if (value == NULL)
    {
      g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
665
                   _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
666
                   path);
667 668 669 670 671 672 673
    }
  else
    {
      guint32 _size, _flags;
      GVariant *array;

      g_variant_get (value, "(uu@ay)",
Matthias Clasen's avatar
Matthias Clasen committed
674 675 676
                     &_size,
                     &_flags,
                     &array);
677

678 679 680
      _size = GUINT32_FROM_LE (_size);
      _flags = GUINT32_FROM_LE (_flags);

681 682 683 684 685 686 687 688 689 690 691 692 693 694 695
      if (size)
        *size = _size;
      if (flags)
        *flags = _flags;
      if (data)
        *data = g_variant_get_data (array);
      if (data_size)
        {
          /* Don't report trailing newline that non-compressed files has */
          if (_flags & G_RESOURCE_FLAGS_COMPRESSED)
            *data_size = g_variant_get_size (array);
          else
            *data_size = g_variant_get_size (array) - 1;
        }
      g_variant_unref (array);
696
      g_variant_unref (value);
697 698

      res = TRUE;
699 700 701 702 703 704 705 706
    }

  g_free (free_path);
  return res;
}

/**
 * g_resource_open_stream:
Matthias Clasen's avatar
Matthias Clasen committed
707 708 709 710
 * @resource: A #GResource
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
711 712 713 714 715 716 717
 *
 * Looks for a file at the specified @path in the resource and
 * returns a #GInputStream that lets you read the data.
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (transfer full): #GInputStream or %NULL on error.
Matthias Clasen's avatar
Matthias Clasen committed
718
 *     Free the returned object with g_object_unref()
719 720 721 722
 *
 * Since: 2.32
 **/
GInputStream *
Matthias Clasen's avatar
Matthias Clasen committed
723 724 725 726
g_resource_open_stream (GResource             *resource,
                        const gchar           *path,
                        GResourceLookupFlags   lookup_flags,
                        GError               **error)
727 728 729 730 731 732 733 734 735 736 737
{
  const void *data;
  gsize data_size;
  guint32 flags;
  GInputStream *stream, *stream2;

  if (!do_lookup (resource, path, lookup_flags, NULL, &flags, &data, &data_size, error))
    return NULL;

  stream = g_memory_input_stream_new_from_data (data, data_size, NULL);
  g_object_set_data_full (G_OBJECT (stream), "g-resource",
Matthias Clasen's avatar
Matthias Clasen committed
738 739
                          g_resource_ref (resource),
                          (GDestroyNotify)g_resource_unref);
740 741 742 743

  if (flags & G_RESOURCE_FLAGS_COMPRESSED)
    {
      GZlibDecompressor *decompressor =
Matthias Clasen's avatar
Matthias Clasen committed
744
        g_zlib_decompressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB);
745 746 747 748 749 750 751 752 753 754 755 756

      stream2 = g_converter_input_stream_new (stream, G_CONVERTER (decompressor));
      g_object_unref (decompressor);
      g_object_unref (stream);
      stream = stream2;
    }

  return stream;
}

/**
 * g_resource_lookup_data:
Matthias Clasen's avatar
Matthias Clasen committed
757 758 759 760
 * @resource: A #GResource
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
 *
 * Looks for a file at the specified @path in the resource and
 * returns a #GBytes 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.
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (transfer full): #GBytes or %NULL on error.
Matthias Clasen's avatar
Matthias Clasen committed
778
 *     Free the returned object with g_bytes_unref()
779 780 781 782
 *
 * Since: 2.32
 **/
GBytes *
Matthias Clasen's avatar
Matthias Clasen committed
783 784 785 786
g_resource_lookup_data (GResource             *resource,
                        const gchar           *path,
                        GResourceLookupFlags   lookup_flags,
                        GError               **error)
787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
{
  const void *data;
  guint32 flags;
  gsize data_size;
  gsize size;

  if (!do_lookup (resource, path, lookup_flags, &size, &flags, &data, &data_size, error))
    return NULL;

  if (flags & G_RESOURCE_FLAGS_COMPRESSED)
    {
      char *uncompressed, *d;
      const char *s;
      GConverterResult res;
      gsize d_size, s_size;
      gsize bytes_read, bytes_written;


      GZlibDecompressor *decompressor =
Matthias Clasen's avatar
Matthias Clasen committed
806
        g_zlib_decompressor_new (G_ZLIB_COMPRESSOR_FORMAT_ZLIB);
807 808 809 810 811 812 813 814 815

      uncompressed = g_malloc (size + 1);

      s = data;
      s_size = data_size;
      d = uncompressed;
      d_size = size;

      do
Matthias Clasen's avatar
Matthias Clasen committed
816 817 818 819 820 821 822 823 824 825 826
        {
          res = g_converter_convert (G_CONVERTER (decompressor),
                                     s, s_size,
                                     d, d_size,
                                     G_CONVERTER_INPUT_AT_END,
                                     &bytes_read,
                                     &bytes_written,
                                     NULL);
          if (res == G_CONVERTER_ERROR)
            {
              g_free (uncompressed);
827 828
              g_object_unref (decompressor);

Matthias Clasen's avatar
Matthias Clasen committed
829
              g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_INTERNAL,
830
                           _("The resource at “%s” failed to decompress"),
Matthias Clasen's avatar
Matthias Clasen committed
831 832 833 834 835 836 837 838 839
                           path);
              return NULL;

            }
          s += bytes_read;
          s_size -= bytes_read;
          d += bytes_written;
          d_size -= bytes_written;
        }
840 841 842 843
      while (res != G_CONVERTER_FINISHED);

      uncompressed[size] = 0; /* Zero terminate */

844 845
      g_object_unref (decompressor);

846 847 848 849 850 851 852 853
      return g_bytes_new_take (uncompressed, size);
    }
  else
    return g_bytes_new_with_free_func (data, data_size, (GDestroyNotify)g_resource_unref, g_resource_ref (resource));
}

/**
 * g_resource_get_info:
Matthias Clasen's avatar
Matthias Clasen committed
854 855 856
 * @resource: A #GResource
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
857
 * @size:  (out) (optional): a location to place the length of the contents of the file,
858
 *    or %NULL if the length is not needed
859
 * @flags:  (out) (optional): a location to place the flags about the file,
860
 *    or %NULL if the length is not needed
Matthias Clasen's avatar
Matthias Clasen committed
861
 * @error: return location for a #GError, or %NULL
862 863 864 865 866 867
 *
 * Looks for a file at the specified @path in the resource and
 * if found returns information about it.
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
Matthias Clasen's avatar
Matthias Clasen committed
868
 * Returns: %TRUE if the file was found. %FALSE if there were errors
869 870 871 872
 *
 * Since: 2.32
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
873 874 875 876 877 878
g_resource_get_info (GResource             *resource,
                     const gchar           *path,
                     GResourceLookupFlags   lookup_flags,
                     gsize                 *size,
                     guint32               *flags,
                     GError               **error)
879 880 881 882 883 884
{
  return do_lookup (resource, path, lookup_flags, size, flags, NULL, NULL, error);
}

/**
 * g_resource_enumerate_children:
Matthias Clasen's avatar
Matthias Clasen committed
885 886 887 888
 * @resource: A #GResource
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
889 890 891 892 893
 *
 * Returns all the names of children at the specified @path in the resource.
 * The return result is a %NULL terminated list of strings which should
 * be released with g_strfreev().
 *
894 895 896
 * If @path is invalid or does not exist in the #GResource,
 * %G_RESOURCE_ERROR_NOT_FOUND will be returned.
 *
897 898 899 900 901 902
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (array zero-terminated=1) (transfer full): an array of constant strings
 *
 * Since: 2.32
 **/
Matthias Clasen's avatar
Matthias Clasen committed
903 904 905 906 907
gchar **
g_resource_enumerate_children (GResource             *resource,
                               const gchar           *path,
                               GResourceLookupFlags   lookup_flags,
                               GError               **error)
908
{
909 910
  gchar local_str[256];
  const gchar *path_with_slash;
911
  gchar **children;
912
  gchar *free_path = NULL;
913
  gsize path_len;
914 915 916 917 918 919

  /*
   * Size of 256 is arbitrarily chosen based on being large enough
   * for pretty much everything we come across, but not cumbersome
   * on the stack. It also matches common cacheline sizes.
   */
920 921 922 923

  if (*path == 0)
    {
      g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
924
                   _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
925
                   path);
926 927 928 929
      return NULL;
    }

  path_len = strlen (path);
930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951

  if G_UNLIKELY (path[path_len-1] != '/')
    {
      if (path_len < sizeof (local_str) - 2)
        {
          /*
           * We got a path that does not have a trailing /. It is not the
           * ideal use of this API as we require trailing / for our lookup
           * into gvdb. Some degenerate application configurations can hit
           * this code path quite a bit, so we try to avoid using the
           * g_strconcat()/g_free().
           */
          memcpy (local_str, path, path_len);
          local_str[path_len] = '/';
          local_str[path_len+1] = 0;
          path_with_slash = local_str;
        }
      else
        {
          path_with_slash = free_path = g_strconcat (path, "/", NULL);
        }
    }
952
  else
953 954 955
    {
      path_with_slash = path;
    }
956 957

  children = gvdb_table_list (resource->table, path_with_slash);
958
  g_free (free_path);
959 960 961 962

  if (children == NULL)
    {
      g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
963
                   _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
964
                   path);
965 966 967 968 969 970 971
      return NULL;
    }

  return children;
}

static GRWLock resources_lock;
Alexander Larsson's avatar
Alexander Larsson committed
972
static GList *registered_resources;
973

974 975 976 977 978 979 980
/* This is updated atomically, so we can append to it and check for NULL outside the
   lock, but all other accesses are done under the write lock */
static GStaticResource *lazy_register_resources;

static void
g_resources_register_unlocked (GResource *resource)
{
Matthias Clasen's avatar
Matthias Clasen committed
981
  registered_resources = g_list_prepend (registered_resources, g_resource_ref (resource));
982 983 984 985 986 987 988
}

static void
g_resources_unregister_unlocked (GResource *resource)
{
  if (g_list_find (registered_resources, resource) == NULL)
    {
989
      g_warning ("Tried to remove not registered resource");
990 991 992
    }
  else
    {
Matthias Clasen's avatar
Matthias Clasen committed
993
      registered_resources = g_list_remove (registered_resources, resource);
994 995 996 997
      g_resource_unref (resource);
    }
}

998 999
/**
 * g_resources_register:
Matthias Clasen's avatar
Matthias Clasen committed
1000
 * @resource: A #GResource
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011
 *
 * 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().
 *
 * Since: 2.32
 **/
void
g_resources_register (GResource *resource)
{
  g_rw_lock_writer_lock (&resources_lock);
1012
  g_resources_register_unlocked (resource);
1013 1014 1015 1016 1017
  g_rw_lock_writer_unlock (&resources_lock);
}

/**
 * g_resources_unregister:
Matthias Clasen's avatar
Matthias Clasen committed
1018
 * @resource: A #GResource
1019 1020 1021 1022 1023 1024 1025 1026 1027
 *
 * Unregisters the resource from the process-global set of resources.
 *
 * Since: 2.32
 **/
void
g_resources_unregister (GResource *resource)
{
  g_rw_lock_writer_lock (&resources_lock);
1028
  g_resources_unregister_unlocked (resource);
1029 1030 1031 1032 1033
  g_rw_lock_writer_unlock (&resources_lock);
}

/**
 * g_resources_open_stream:
Matthias Clasen's avatar
Matthias Clasen committed
1034 1035 1036
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
1037 1038
 *
 * Looks for a file at the specified @path in the set of
1039
 * globally registered resources and returns a #GInputStream
1040 1041 1042 1043 1044
 * that lets you read the data.
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (transfer full): #GInputStream or %NULL on error.
Matthias Clasen's avatar
Matthias Clasen committed
1045
 *     Free the returned object with g_object_unref()
1046 1047 1048 1049
 *
 * Since: 2.32
 **/
GInputStream *
Matthias Clasen's avatar
Matthias Clasen committed
1050 1051 1052
g_resources_open_stream (const gchar           *path,
                         GResourceLookupFlags   lookup_flags,
                         GError               **error)
1053 1054 1055 1056 1057
{
  GInputStream *res = NULL;
  GList *l;
  GInputStream *stream;

1058 1059 1060
  if (g_resource_find_overlay (path, open_overlay_stream, &res))
    return res;

1061 1062
  register_lazy_static_resources ();

1063 1064
  g_rw_lock_reader_lock (&resources_lock);

Alexander Larsson's avatar
Alexander Larsson committed
1065
  for (l = registered_resources; l != NULL; l = l->next)
1066 1067 1068 1069 1070 1071
    {
      GResource *r = l->data;
      GError *my_error = NULL;

      stream = g_resource_open_stream (r, path, lookup_flags, &my_error);
      if (stream == NULL &&
Matthias Clasen's avatar
Matthias Clasen committed
1072 1073 1074 1075
          g_error_matches (my_error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND))
        {
          g_clear_error (&my_error);
        }
1076
      else
Matthias Clasen's avatar
Matthias Clasen committed
1077 1078 1079 1080 1081 1082
        {
          if (stream == NULL)
            g_propagate_error (error, my_error);
          res = stream;
          break;
        }
1083 1084 1085 1086
    }

  if (l == NULL)
    g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
1087
                 _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
1088
                 path);
1089 1090 1091 1092 1093 1094 1095 1096

  g_rw_lock_reader_unlock (&resources_lock);

  return res;
}

/**
 * g_resources_lookup_data:
Matthias Clasen's avatar
Matthias Clasen committed
1097 1098 1099
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
1100 1101
 *
 * Looks for a file at the specified @path in the set of
1102
 * globally registered resources and returns a #GBytes that
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116
 * 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.
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (transfer full): #GBytes or %NULL on error.
Matthias Clasen's avatar
Matthias Clasen committed
1117
 *     Free the returned object with g_bytes_unref()
1118 1119 1120 1121
 *
 * Since: 2.32
 **/
GBytes *
Matthias Clasen's avatar
Matthias Clasen committed
1122 1123 1124
g_resources_lookup_data (const gchar           *path,
                         GResourceLookupFlags   lookup_flags,
                         GError               **error)
1125 1126 1127 1128 1129
{
  GBytes *res = NULL;
  GList *l;
  GBytes *data;

1130 1131 1132
  if (g_resource_find_overlay (path, get_overlay_bytes, &res))
    return res;

1133 1134
  register_lazy_static_resources ();

1135 1136
  g_rw_lock_reader_lock (&resources_lock);

Alexander Larsson's avatar
Alexander Larsson committed
1137
  for (l = registered_resources; l != NULL; l = l->next)
1138 1139 1140 1141 1142 1143
    {
      GResource *r = l->data;
      GError *my_error = NULL;

      data = g_resource_lookup_data (r, path, lookup_flags, &my_error);
      if (data == NULL &&
Matthias Clasen's avatar
Matthias Clasen committed
1144 1145 1146 1147
          g_error_matches (my_error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND))
        {
          g_clear_error (&my_error);
        }
1148
      else
Matthias Clasen's avatar
Matthias Clasen committed
1149 1150 1151 1152 1153 1154
        {
          if (data == NULL)
            g_propagate_error (error, my_error);
          res = data;
          break;
        }
1155 1156 1157 1158
    }

  if (l == NULL)
    g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
1159
                 _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
1160
                 path);
1161 1162 1163 1164 1165 1166 1167 1168

  g_rw_lock_reader_unlock (&resources_lock);

  return res;
}

/**
 * g_resources_enumerate_children:
Matthias Clasen's avatar
Matthias Clasen committed
1169 1170 1171
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
 * @error: return location for a #GError, or %NULL
1172 1173
 *
 * Returns all the names of children at the specified @path in the set of
1174
 * globally registered resources.
1175 1176 1177 1178 1179 1180 1181 1182 1183
 * The return result is a %NULL terminated list of strings which should
 * be released with g_strfreev().
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
 * Returns: (array zero-terminated=1) (transfer full): an array of constant strings
 *
 * Since: 2.32
 **/
Matthias Clasen's avatar
Matthias Clasen committed
1184 1185 1186 1187
gchar **
g_resources_enumerate_children (const gchar           *path,
                                GResourceLookupFlags   lookup_flags,
                                GError               **error)
1188 1189 1190 1191 1192 1193
{
  GHashTable *hash = NULL;
  GList *l;
  char **children;
  int i;

1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204
  /* This will enumerate actual files found in overlay directories but
   * will not enumerate the overlays themselves.  For example, if we
   * have an overlay "/org/gtk=/path/to/files" and we enumerate "/org"
   * then we will not see "gtk" in the result set unless it is provided
   * by another resource file.
   *
   * This is probably not going to be a problem since if we are doing
   * such an overlay, we probably will already have that path.
   */
  g_resource_find_overlay (path, enumerate_overlay_dir, &hash);

1205 1206
  register_lazy_static_resources ();

1207 1208
  g_rw_lock_reader_lock (&resources_lock);

Alexander Larsson's avatar
Alexander Larsson committed
1209
  for (l = registered_resources; l != NULL; l = l->next)
1210 1211 1212 1213 1214 1215
    {
      GResource *r = l->data;

      children = g_resource_enumerate_children (r, path, 0, NULL);

      if (children != NULL)
Matthias Clasen's avatar
Matthias Clasen committed
1216 1217
        {
          if (hash == NULL)
1218
            /* note: keep in sync with same line above */
Matthias Clasen's avatar
Matthias Clasen committed
1219 1220 1221
            hash = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);

          for (i = 0; children[i] != NULL; i++)
1222
            g_hash_table_add (hash, children[i]);
Matthias Clasen's avatar
Matthias Clasen committed
1223 1224
          g_free (children);
        }
1225 1226 1227 1228 1229 1230 1231
    }

  g_rw_lock_reader_unlock (&resources_lock);

  if (hash == NULL)
    {
      g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
1232
                   _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
1233
                   path);
1234 1235 1236 1237
      return NULL;
    }
  else
    {
1238 1239
      children = (gchar **) g_hash_table_get_keys_as_array (hash, NULL);
      g_hash_table_steal_all (hash);
1240 1241 1242 1243 1244 1245 1246 1247
      g_hash_table_destroy (hash);

      return children;
    }
}

/**
 * g_resources_get_info:
Matthias Clasen's avatar
Matthias Clasen committed
1248 1249
 * @path: A pathname inside the resource
 * @lookup_flags: A #GResourceLookupFlags
1250
 * @size:  (out) (optional): a location to place the length of the contents of the file,
1251
 *    or %NULL if the length is not needed
1252 1253
 * @flags:  (out) (optional): a location to place the #GResourceFlags about the file,
 *    or %NULL if the flags are not needed
Matthias Clasen's avatar
Matthias Clasen committed
1254
 * @error: return location for a #GError, or %NULL
1255 1256
 *
 * Looks for a file at the specified @path in the set of
1257
 * globally registered resources and if found returns information about it.
1258 1259 1260
 *
 * @lookup_flags controls the behaviour of the lookup.
 *
Matthias Clasen's avatar
Matthias Clasen committed
1261
 * Returns: %TRUE if the file was found. %FALSE if there were errors
1262 1263 1264 1265
 *
 * Since: 2.32
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
1266 1267 1268 1269 1270
g_resources_get_info (const gchar           *path,
                      GResourceLookupFlags   lookup_flags,
                      gsize                 *size,
                      guint32               *flags,
                      GError               **error)
1271 1272 1273 1274
{
  gboolean res = FALSE;
  GList *l;
  gboolean r_res;
1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285
  InfoData info;

  if (g_resource_find_overlay (path, get_overlay_info, &info))
    {
      if (size)
        *size = info.size;
      if (flags)
        *flags = info.flags;

      return TRUE;
    }
1286

1287 1288
  register_lazy_static_resources ();

1289 1290
  g_rw_lock_reader_lock (&resources_lock);

Alexander Larsson's avatar
Alexander Larsson committed
1291
  for (l = registered_resources; l != NULL; l = l->next)
1292 1293 1294 1295 1296 1297
    {
      GResource *r = l->data;
      GError *my_error = NULL;

      r_res = g_resource_get_info (r, path, lookup_flags, size, flags, &my_error);
      if (!r_res &&
Matthias Clasen's avatar
Matthias Clasen committed
1298 1299 1300 1301
          g_error_matches (my_error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND))
        {
          g_clear_error (&my_error);
        }
1302
      else
Matthias Clasen's avatar
Matthias Clasen committed
1303 1304 1305 1306 1307 1308
        {
          if (!r_res)
            g_propagate_error (error, my_error);
          res = r_res;
          break;
        }
1309 1310 1311 1312
    }

  if (l == NULL)
    g_set_error (error, G_RESOURCE_ERROR, G_RESOURCE_ERROR_NOT_FOUND,
1313
                 _("The resource at “%s” does not exist"),
Matthias Clasen's avatar
Matthias Clasen committed
1314
                 path);
1315 1316 1317 1318 1319

  g_rw_lock_reader_unlock (&resources_lock);

  return res;
}
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341

/* This code is to handle registration of resources very early, from a constructor.
 * At that point we'd like to do minimal work, to avoid ordering issues. For instance,
 * we're not allowed to use g_malloc, as the user need to be able to call g_mem_set_vtable
 * before the first call to g_malloc.
 *
 * So, what we do at construction time is that we just register a static structure on
 * a list of resources that need to be initialized, and then later, when doing any lookups
 * in the global list of registered resources, or when getting a reference to the
 * lazily initialized resource we lazily create and register all the GResources on
 * the lazy list.
 *
 * To avoid having to use locks in the constructor, and having to grab the writer lock
 * when checking the lazy registering list we update lazy_register_resources in
 * a lock-less fashion (atomic prepend-only, atomic replace with NULL). However, all
 * operations except:
 *  * check if there are any resources to lazily initialize
 *  * Add a static resource to the lazy init list
 * Do use the full writer lock for protection.
 */

static void
Matthias Clasen's avatar
Matthias Clasen committed
1342
register_lazy_static_resources_unlocked (void)
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354
{
  GStaticResource *list;

  do
    list = lazy_register_resources;
  while (!g_atomic_pointer_compare_and_exchange (&lazy_register_resources, list, NULL));

  while (list != NULL)
    {
      GBytes *bytes = g_bytes_new_static (list->data, list->data_len);
      GResource *resource = g_resource_new_from_data (bytes, NULL);
      if (resource)
Matthias Clasen's avatar
Matthias Clasen committed
1355 1356 1357 1358
        {
          g_resources_register_unlocked (resource);
          g_atomic_pointer_set (&list->resource, resource);
        }
1359 1360 1361 1362 1363 1364 1365
      g_bytes_unref (bytes);

      list = list->next;
    }
}

static void
Matthias Clasen's avatar
Matthias Clasen committed
1366
register_lazy_static_resources (void)
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
{
  if (g_atomic_pointer_get (&lazy_register_resources) == NULL)
    return;

  g_rw_lock_writer_lock (&resources_lock);
  register_lazy_static_resources_unlocked ();
  g_rw_lock_writer_unlock (&resources_lock);
}

/**
 * g_static_resource_init:
Matthias Clasen's avatar
Matthias Clasen committed
1378
 * @static_resource: pointer to a static #GStaticResource
1379 1380 1381 1382 1383
 *
 * Initializes a GResource from static data using a
 * GStaticResource.
 *
 * This is normally used by code generated by
1384
 * [glib-compile-resources][glib-compile-resources]
Matthias Clasen's avatar
Matthias Clasen committed
1385
 * and is not typically used by other code.
1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
 *
 * Since: 2.32
 **/
void
g_static_resource_init (GStaticResource *static_resource)
{
  gpointer next;

  do
    {
      next = lazy_register_resources;
      static_resource->next = next;
    }
  while (!g_atomic_pointer_compare_and_exchange (&lazy_register_resources, next, static_resource));
}

/**
 * g_static_resource_fini:
Matthias Clasen's avatar
Matthias Clasen committed
1404
 * @static_resource: pointer to a static #GStaticResource
1405
 *
Matthias Clasen's avatar
Matthias Clasen committed
1406
 * Finalized a GResource initialized by g_static_resource_init().
1407 1408
 *
 * This is normally used by code generated by
1409
 * [glib-compile-resources][glib-compile-resources]
Matthias Clasen's avatar
Matthias Clasen committed
1410
 * and is not typically used by other code.
1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
 *
 * Since: 2.32
 **/
void
g_static_resource_fini (GStaticResource *static_resource)
{
  GResource *resource;

  g_rw_lock_writer_lock (&resources_lock);

  register_lazy_static_resources_unlocked ();

  resource = g_atomic_pointer_get (&static_resource->resource);
  if (resource)
    {
      g_atomic_pointer_set (&static_resource->resource, NULL);
      g_resources_unregister_unlocked (resource);
      g_resource_unref (resource);
    }

  g_rw_lock_writer_unlock (&resources_lock);
}

/**
 * g_static_resource_get_resource:
Matthias Clasen's avatar
Matthias Clasen committed
1436
 * @static_resource: pointer to a static #GStaticResource
1437
 *
1438
 * Gets the GResource that was registered by a call to g_static_resource_init().
1439 1440
 *
 * This is normally used by code generated by
1441
 * [glib-compile-resources][glib-compile-resources]
Matthias Clasen's avatar
Matthias Clasen committed
1442
 * and is not typically used by other code.
1443
 *
1444
 * Returns:  (transfer none): a #GResource
1445 1446 1447 1448
 *
 * Since: 2.32
 **/
GResource *
Matthias Clasen's avatar
Matthias Clasen committed
1449
g_static_resource_get_resource (GStaticResource *static_resource)
1450 1451 1452 1453 1454
{
  register_lazy_static_resources ();

  return g_atomic_pointer_get (&static_resource->resource);
}