src/context.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  21  * DEALINGS IN THE SOFTWARE.
  22  *
  23  * Author: Daniel Stone <daniel@fooishbar.org>
  24  */
  25
  26 #ifndef CONTEXT_H
  27 #define CONTEXT_H
  28
  29 #include "atom.h"
  30
  31 unsigned
  32 xkb_context_take_file_id(struct xkb_context *ctx);
  33
  34 unsigned int
  35 xkb_context_num_failed_include_paths(struct xkb_context *ctx);
  36
  37 const char *
  38 xkb_context_failed_include_path_get(struct xkb_context *ctx,
  39                                     unsigned int idx);
  40
  41 /*
  42  * Returns XKB_ATOM_NONE if @string was not previously interned,
  43  * otherwise returns the atom.
  44  */
  45 xkb_atom_t
  46 xkb_atom_lookup(struct xkb_context *ctx, const char *string);
  47
  48 xkb_atom_t
  49 xkb_atom_intern(struct xkb_context *ctx, const char *string);
  50
  51 /**
  52  * If @string is dynamically allocated, free'd immediately after
  53  * being interned, and not used afterwards, use this function
  54  * instead of xkb_atom_intern to avoid some unnecessary allocations.
  55  * The caller should not use or free the passed in string afterwards.
  56  */
  57 xkb_atom_t
  58 xkb_atom_steal(struct xkb_context *ctx, char *string);
  59
  60 char *
  61 xkb_atom_strdup(struct xkb_context *ctx, xkb_atom_t atom);
  62
  63 const char *
  64 xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
  65
  66 char *
  67 xkb_context_get_buffer(struct xkb_context *ctx, size_t size);
  68
  69 ATTR_PRINTF(3, 4) void
  70 xkb_log(struct xkb_context *ctx, enum xkb_log_level level,
  71         const char *fmt, ...);
  72
  73 #define xkb_log_cond_level(ctx, level, ...) do { \
  74     if (xkb_context_get_log_level(ctx) >= (level)) \
  75     xkb_log((ctx), (level), __VA_ARGS__); \
  76 } while (0)
  77
  78 #define xkb_log_cond_verbosity(ctx, level, vrb, ...) do { \
  79     if (xkb_context_get_log_verbosity(ctx) >= (vrb)) \
  80     xkb_log_cond_level((ctx), (level), __VA_ARGS__); \
  81 } while (0)
  82
  83 /*
  84  * The format is not part of the argument list in order to avoid the
  85  * "ISO C99 requires rest arguments to be used" warning when only the
  86  * format is supplied without arguments. Not supplying it would still
  87  * result in an error, though.
  88  */
  89 #define log_dbg(ctx, ...) \
  90     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_DEBUG, __VA_ARGS__)
  91 #define log_info(ctx, ...) \
  92     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_INFO, __VA_ARGS__)
  93 #define log_warn(ctx, ...) \
  94     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_WARNING, __VA_ARGS__)
  95 #define log_err(ctx, ...) \
  96     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_ERROR, __VA_ARGS__)
  97 #define log_wsgo(ctx, ...) \
  98     xkb_log_cond_level((ctx), XKB_LOG_LEVEL_CRITICAL, __VA_ARGS__)
  99 #define log_vrb(ctx, vrb, ...) \
 100     xkb_log_cond_verbosity((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
 101
 102 #endif