]> git.saurik.com Git - bison.git/blame_incremental - src/uniqstr.h
Some code and documentation improvements.
[bison.git] / src / uniqstr.h
... / ...
CommitLineData
1/* Keeping a unique copy of strings.
2
3 Copyright (C) 2002, 2003, 2008, 2009 Free Software Foundation, Inc.
4
5 This file is part of Bison, the GNU Compiler Compiler.
6
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
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
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
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
29/* Return the uniqstr for STR. */
30uniqstr uniqstr_new (char const *str);
31
32/* Two uniqstr values have the same value iff they are the same. */
33#define UNIQSTR_EQ(USTR1, USTR2) ((USTR1) == (USTR2))
34
35/* Compare two uniqstr a la strcmp: negative for <, nul for =, and
36 positive for >. Undefined order, relies on addresses. */
37#define UNIQSTR_CMP(USTR1, USTR2) ((USTR1) - (USTR2))
38
39/*--------------------------------------.
40| Initializing, destroying, debugging. |
41`--------------------------------------*/
42
43/* Create the string table. */
44void uniqstrs_new (void);
45
46/* Die if STR is not a uniqstr. */
47void uniqstr_assert (char const *str);
48
49/* Free all the memory allocated for symbols. */
50void uniqstrs_free (void);
51
52/* Report them all. */
53void uniqstrs_print (void);
54
55#endif /* ! defined UNIQSTR_H_ */