]> git.saurik.com Git - bison.git/blame - src/uniqstr.h
maint: git now ignores rpcalc
[bison.git] / src / uniqstr.h
CommitLineData
5bab03fc 1/* Keeping a unique copy of strings.
a737b216 2
7d6bad19 3 Copyright (C) 2002-2003, 2008-2013 Free Software Foundation, Inc.
5bab03fc
PE
4
5 This file is part of Bison, the GNU Compiler Compiler.
6
f16b0819 7 This program is free software: you can redistribute it and/or modify
5bab03fc 8 it under the terms of the GNU General Public License as published by
f16b0819
PE
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
5bab03fc 11
f16b0819 12 This program is distributed in the hope that it will be useful,
5bab03fc
PE
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
f16b0819 18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
5bab03fc
PE
19
20#ifndef UNIQSTR_H_
21# define UNIQSTR_H_
22
23/*-----------------------------------------.
24| Pointers to unique copies of C strings. |
25`-----------------------------------------*/
26
27typedef char const *uniqstr;
28
a737b216
PE
29/* Return the uniqstr for STR. */
30uniqstr uniqstr_new (char const *str);
5bab03fc 31
0ab402b4
JD
32/* Return a uniqstr built by vsprintf. In order to simply concatenate
33 strings, use UNIQSTR_CONCAT, which is a convenient wrapper around
34 this function. */
35uniqstr uniqstr_vsprintf (char const *format, ...)
36 __attribute__ ((__format__ (__printf__, 1, 2)));
37
a737b216 38/* Two uniqstr values have the same value iff they are the same. */
e3810658 39# define UNIQSTR_EQ(Ustr1, Ustr2) (!!((Ustr1) == (Ustr2)))
5bab03fc 40
95d176ff
AD
41/* Compare two uniqstr a la strcmp: negative for <, nul for =, and
42 positive for >. Undefined order, relies on addresses. */
c0ef22ab 43int uniqstr_cmp (uniqstr u1, uniqstr u2);
95d176ff 44
a737b216
PE
45/* Die if STR is not a uniqstr. */
46void uniqstr_assert (char const *str);
5bab03fc 47
0ab402b4
JD
48/*----------------.
49| Concatenation. |
50`----------------*/
51
52/* Concatenate at most 20 strings and return a uniqstr. The goal of
53 this macro is to make the caller's code a little more succinct
54 without a trivial uniqstr_vsprintf format string to maintain
55 (for example, "%s%s%s") while still benefitting from gcc's type
56 checking. Unfortunately, because of the missing format string in the
57 macro invocation, the argument number reported by gcc for a bad
58 argument type is 1 too large. */
a99ec53e
AD
59# define UNIQSTR_CONCAT(...) \
60 uniqstr_vsprintf (UNIQSTR_GEN_FORMAT (__VA_ARGS__, \
61 "%s", "%s", "%s", "%s", "%s", \
62 "%s", "%s", "%s", "%s", "%s", \
63 "%s", "%s", "%s", "%s", "%s", \
64 "%s", "%s", "%s", "%s", "%s"), \
0ab402b4
JD
65 __VA_ARGS__)
66
a99ec53e
AD
67# define UNIQSTR_GEN_FORMAT(F1, F2, F3, F4, F5, \
68 F6, F7, F8, F9, F10, \
69 F11, F12, F13, F14, F15, \
70 F16, F17, F18, F19, F20, \
71 ...) \
72 UNIQSTR_GEN_FORMAT_ (__VA_ARGS__, \
73 "", "", "", "", "", \
74 "", "", "", "", "", \
75 "", "", "", "", "", \
0ab402b4
JD
76 "", "", "", "", "")
77
a99ec53e
AD
78# define UNIQSTR_GEN_FORMAT_(F1, F2, F3, F4, F5, \
79 F6, F7, F8, F9, F10, \
80 F11, F12, F13, F14, F15, \
81 F16, F17, F18, F19, F20, ...) \
82 F1 F2 F3 F4 F5 F6 F7 F8 F9 F10 \
0ab402b4
JD
83 F11 F12 F13 F14 F15 F16 F17 F18 F19 F20
84
e3810658
AD
85/*--------------------.
86| Table of uniqstrs. |
87`--------------------*/
88
89/* Create the string table. */
90void uniqstrs_new (void);
91
92/* Free all the memory allocated for symbols. */
93void uniqstrs_free (void);
94
95/* Report them all. */
96void uniqstrs_print (void);
97
5bab03fc 98#endif /* ! defined UNIQSTR_H_ */