glib/gquark.h

   1 /* GLIB - Library of useful routines for C programming
   2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
   3  *
   4  * SPDX-License-Identifier: LGPL-2.1-or-later
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_QUARK_H__
  28 #define __G_QUARK_H__
  29
  30 #if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
  31 #error "Only <glib.h> can be included directly."
  32 #endif
  33
  34 #include <glib/gtypes.h>
  35
  36 G_BEGIN_DECLS
  37
  38 typedef guint32 GQuark;
  39
  40 /* Quarks (string<->id association)
  41  */
  42 GLIB_AVAILABLE_IN_ALL
  43 GQuark                g_quark_try_string         (const gchar *string);
  44 GLIB_AVAILABLE_IN_ALL
  45 GQuark                g_quark_from_static_string (const gchar *string);
  46 GLIB_AVAILABLE_IN_ALL
  47 GQuark                g_quark_from_string        (const gchar *string);
  48 GLIB_AVAILABLE_IN_ALL
  49 const gchar *         g_quark_to_string          (GQuark       quark) G_GNUC_CONST;
  50
  51 #define G_DEFINE_QUARK(QN, q_n)                                         \
  52 GQuark                                                                  \
  53 q_n##_quark (void)                                                      \
  54 {                                                                       \
  55   static GQuark q;                                                      \
  56                                                                         \
  57   if G_UNLIKELY (q == 0)                                                \
  58     q = g_quark_from_static_string (#QN);                               \
  59                                                                         \
  60   return q;                                                             \
  61 }
  62
  63 GLIB_AVAILABLE_IN_ALL
  64 const gchar *         g_intern_string            (const gchar *string);
  65 GLIB_AVAILABLE_IN_ALL
  66 const gchar *         g_intern_static_string     (const gchar *string);
  67
  68 G_END_DECLS
  69
  70 #endif /* __G_QUARK_H__ */