tests: minor refactoring

[bison.git] / src / uniqstr.h

diff --git a/src/uniqstr.h b/src/uniqstr.h
index 90961d9c38dbf6b68521627e52067710f9318b2e..143f7aae3ed725d79f43669cc0eb4f55a4e54146 100644 (file)
--- a/src/uniqstr.h
+++ b/src/uniqstr.h
@@ -1,22 +1,21 @@
 /* Keeping a unique copy of strings.
 /* Keeping a unique copy of strings.

-   Copyright (C) 2002 Free Software Foundation, Inc.
+
+   Copyright (C) 2002-2003, 2008-2013 Free Software Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    This file is part of Bison, the GNU Compiler Compiler.
 

-   Bison is free software; you can redistribute it and/or modify
+   This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by
    it under the terms of the GNU General Public License as published by

-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.

 
 

-   Bison is distributed in the hope that it will be useful,
+   This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License

-   along with Bison; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

 
 #ifndef UNIQSTR_H_
 # define UNIQSTR_H_
 
 #ifndef UNIQSTR_H_
 # define UNIQSTR_H_


@@ -27,22 +26,69 @@
 
 typedef char const *uniqstr;
 
 
 typedef char const *uniqstr;
 

-/* Return the uniqstr for S.  */
-uniqstr uniqstr_new (char const *s);
+/* Return the uniqstr for STR.  */
+uniqstr uniqstr_new (char const *str);
+
+/* Return a uniqstr built by vsprintf.  In order to simply concatenate
+   strings, use UNIQSTR_CONCAT, which is a convenient wrapper around
+   this function.  */
+uniqstr uniqstr_vsprintf (char const *format, ...)
+  __attribute__ ((__format__ (__printf__, 1, 2)));
+
+/* Two uniqstr values have the same value iff they are the same.  */
+# define UNIQSTR_EQ(Ustr1, Ustr2) (!!((Ustr1) == (Ustr2)))
+
+/* Compare two uniqstr a la strcmp: negative for <, nul for =, and
+   positive for >.  Undefined order, relies on addresses.  */
+int uniqstr_cmp(uniqstr u1, uniqstr u2);
+
+/* Die if STR is not a uniqstr.  */
+void uniqstr_assert (char const *str);

 
 

-/* Two uniqstr have the same value iff they are the same.  */
-#define UNIQSTR_EQ(S1, S2) ((S1) == (S2))
+/*----------------.
+| Concatenation.  |
+`----------------*/

 
 

-/*--------------------------------------.
-| Initializing, destroying, debugging.  |
-`--------------------------------------*/
+/* Concatenate at most 20 strings and return a uniqstr.  The goal of
+   this macro is to make the caller's code a little more succinct
+   without a trivial uniqstr_vsprintf format string to maintain
+   (for example, "%s%s%s") while still benefitting from gcc's type
+   checking.  Unfortunately, because of the missing format string in the
+   macro invocation, the argument number reported by gcc for a bad
+   argument type is 1 too large.  */
+# define UNIQSTR_CONCAT(...)                                            \
+  uniqstr_vsprintf (UNIQSTR_GEN_FORMAT (__VA_ARGS__,                    \
+                                        "%s", "%s", "%s", "%s", "%s",   \
+                                        "%s", "%s", "%s", "%s", "%s",   \
+                                        "%s", "%s", "%s", "%s", "%s",   \
+                                        "%s", "%s", "%s", "%s", "%s"),  \
+                    __VA_ARGS__)
+
+# define UNIQSTR_GEN_FORMAT(F1,  F2,  F3,  F4,  F5,     \
+                           F6,  F7,  F8,  F9,  F10,     \
+                           F11, F12, F13, F14, F15,     \
+                           F16, F17, F18, F19, F20,     \
+                           ...)                         \
+  UNIQSTR_GEN_FORMAT_ (__VA_ARGS__,                     \
+                       "", "", "", "", "",              \
+                       "", "", "", "", "",              \
+                       "", "", "", "", "",              \
+                       "", "", "", "", "")
+
+# define UNIQSTR_GEN_FORMAT_(F1,  F2,  F3,  F4,  F5,            \
+                            F6,  F7,  F8,  F9,  F10,            \
+                            F11, F12, F13, F14, F15,            \
+                            F16, F17, F18, F19, F20, ...)       \
+  F1  F2  F3  F4  F5  F6  F7  F8  F9  F10                       \
+  F11 F12 F13 F14 F15 F16 F17 F18 F19 F20
+
+/*--------------------.
+| Table of uniqstrs.  |
+`--------------------*/

 
 /* Create the string table.  */
 void uniqstrs_new (void);
 
 
 /* Create the string table.  */
 void uniqstrs_new (void);
 

-/* Die if S is not a uniqstr.  */
-void uniqstr_assert (char const *s);
-

 /* Free all the memory allocated for symbols.  */
 void uniqstrs_free (void);
 
 /* Free all the memory allocated for symbols.  */
 void uniqstrs_free (void);