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
31struct xkb_context {
32    int refcnt;
33
34    ATTR_PRINTF(3, 0) void (*log_fn)(struct xkb_context *ctx,
35                                     enum xkb_log_level level,
36                                     const char *fmt, va_list args);
37    enum xkb_log_level log_level;
38    int log_verbosity;
39    void *user_data;
40
41    struct xkb_rule_names names_dflt;
42
43    darray(char *) includes;
44    darray(char *) failed_includes;
45
46    struct atom_table *atom_table;
47
48    /* Buffer for the *Text() functions. */
49    char text_buffer[2048];
50    size_t text_next;
51
52    unsigned int use_environment_names : 1;
53};
54
55unsigned int
56xkb_context_num_failed_include_paths(struct xkb_context *ctx);
57
58const char *
59xkb_context_failed_include_path_get(struct xkb_context *ctx,
60                                    unsigned int idx);
61
62/*
63 * Returns XKB_ATOM_NONE if @string was not previously interned,
64 * otherwise returns the atom.
65 */
66xkb_atom_t
67xkb_atom_lookup(struct xkb_context *ctx, const char *string);
68
69xkb_atom_t
70xkb_atom_intern(struct xkb_context *ctx, const char *string, size_t len);
71
72#define xkb_atom_intern_literal(ctx, literal) \
73    xkb_atom_intern((ctx), (literal), sizeof(literal) - 1)
74
75/**
76 * If @string is dynamically allocated, NUL-terminated, free'd immediately
77 * after being interned, and not used afterwards, use this function
78 * instead of xkb_atom_intern to avoid some unnecessary allocations.
79 * The caller should not use or free the passed in string afterwards.
80 */
81xkb_atom_t
82xkb_atom_steal(struct xkb_context *ctx, char *string);
83
84const char *
85xkb_atom_text(struct xkb_context *ctx, xkb_atom_t atom);
86
87char *
88xkb_context_get_buffer(struct xkb_context *ctx, size_t size);
89
90ATTR_PRINTF(4, 5) void
91xkb_log(struct xkb_context *ctx, enum xkb_log_level level, int verbosity,
92        const char *fmt, ...);
93
94void
95xkb_context_sanitize_rule_names(struct xkb_context *ctx,
96                                struct xkb_rule_names *rmlvo);
97
98/*
99 * The format is not part of the argument list in order to avoid the
100 * "ISO C99 requires rest arguments to be used" warning when only the
101 * format is supplied without arguments. Not supplying it would still
102 * result in an error, though.
103 */
104#define log_dbg(ctx, ...) \
105    xkb_log((ctx), XKB_LOG_LEVEL_DEBUG, 0, __VA_ARGS__)
106#define log_info(ctx, ...) \
107    xkb_log((ctx), XKB_LOG_LEVEL_INFO, 0, __VA_ARGS__)
108#define log_warn(ctx, ...) \
109    xkb_log((ctx), XKB_LOG_LEVEL_WARNING, 0,  __VA_ARGS__)
110#define log_err(ctx, ...) \
111    xkb_log((ctx), XKB_LOG_LEVEL_ERROR, 0,  __VA_ARGS__)
112#define log_wsgo(ctx, ...) \
113    xkb_log((ctx), XKB_LOG_LEVEL_CRITICAL, 0, __VA_ARGS__)
114#define log_vrb(ctx, vrb, ...) \
115    xkb_log((ctx), XKB_LOG_LEVEL_WARNING, (vrb), __VA_ARGS__)
116
117/*
118 * Variants which are prefixed by the name of the function they're
119 * called from.
120 * Here we must have the silly 1 variant.
121 */
122#define log_err_func(ctx, fmt, ...) \
123    log_err(ctx, "%s: " fmt, __func__, __VA_ARGS__)
124#define log_err_func1(ctx, fmt) \
125    log_err(ctx, "%s: " fmt, __func__)
126
127#endif
128