[bison.git] / src / muscle-tab.h

/* Muscle table manager for Bison,

   Copyright (C) 2001-2003, 2006-2007, 2009-2012 Free Software
   Foundation, Inc.

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

   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
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   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
   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */

#ifndef MUSCLE_TAB_H_
# define MUSCLE_TAB_H_

# include "location.h"

void muscle_init (void);
void muscle_insert (char const *key, char const *value);
char const *muscle_find_const (char const *key);
char *muscle_find (char const *key);
void muscle_free (void);


/* An obstack dedicated to receive muscle keys and values.  */
extern struct obstack muscle_obstack;

#define MUSCLE_INSERT_BOOL(Key, Value)				\
do {								\
  int v = Value;						\
  MUSCLE_INSERT_INT (Key, v);					\
} while(0)

#define MUSCLE_INSERT_INT(Key, Value)				\
do {								\
  obstack_fgrow1 (&muscle_obstack, "%d", Value);		\
  obstack_1grow (&muscle_obstack, 0);				\
  muscle_insert (Key, obstack_finish (&muscle_obstack));	\
} while(0)

#define MUSCLE_INSERT_LONG_INT(Key, Value)			\
do {								\
  obstack_fgrow1 (&muscle_obstack, "%ld", Value);		\
  obstack_1grow (&muscle_obstack, 0);				\
  muscle_insert (Key, obstack_finish (&muscle_obstack));	\
} while(0)

#define MUSCLE_INSERT_STRING_RAW(Key, Value)			\
do {								\
  obstack_sgrow (&muscle_obstack, Value);			\
  obstack_1grow (&muscle_obstack, 0);				\
  muscle_insert (Key, obstack_finish (&muscle_obstack));	\
} while(0)

#define MUSCLE_INSERT_STRING(Key, Value)			\
do {								\
  MUSCLE_OBSTACK_SGROW (&muscle_obstack, Value);                \
  obstack_1grow (&muscle_obstack, 0);				\
  muscle_insert (Key, obstack_finish (&muscle_obstack));	\
} while(0)

#define MUSCLE_OBSTACK_SGROW(Obstack, Value)			\
do {								\
  char const *p;						\
  for (p = Value; *p; p++)					\
    switch (*p)							\
      {								\
      case '$':	obstack_sgrow (Obstack, "$]["); break;		\
      case '@':	obstack_sgrow (Obstack, "@@" ); break;		\
      case '[':	obstack_sgrow (Obstack, "@{" ); break;		\
      case ']':	obstack_sgrow (Obstack, "@}" ); break;		\
      default: obstack_1grow (Obstack, *p); break;		\
      }								\
} while(0)

#define MUSCLE_INSERT_C_STRING(Key, Value)			\
do {								\
  MUSCLE_OBSTACK_SGROW (&muscle_obstack,			\
			quotearg_style (c_quoting_style,	\
					Value));		\
  obstack_1grow (&muscle_obstack, 0);				\
  muscle_insert (Key, obstack_finish (&muscle_obstack));	\
} while(0)

/* Append VALUE to the current value of KEY.  If KEY did not already
   exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
   associated value.  Copy VALUE and SEPARATOR.  */

void muscle_grow (const char *key, const char *value, const char *separator);


/* Append VALUE to the current value of KEY, using muscle_grow.  But
   in addition, issue a synchronization line for the location LOC.  */

void muscle_code_grow (const char *key, const char *value, location loc);


/* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
   (A1, A2) after escaping both values with digraphs.  Note that because the
   muscle values are output *double* quoted, one needs to strip the first level
   of quotes to reach the list itself.  */
void muscle_pair_list_grow (const char *muscle,
			    const char *a1, const char *a2);

/* In the format `[[file_name:line.column]], [[file_name:line.column]]', append
   LOC to MUSCLE.  Use digraphs for special characters in each file name.  */
void muscle_location_grow (char const *key, location loc);

/* In the format `file_name:line.column', append BOUND to MUSCLE.  Use digraphs
   for special characters in the file name.  */
void muscle_boundary_grow (char const *key, boundary bound);

/* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
   use with b4_check_user_names in ../data/bison.m4.  USER_NAME is not escaped
   with digraphs, so it must not contain `[' or `]'.  */
void muscle_user_name_list_grow (char const *key, char const *user_name,
                                 location loc);

/* Indicates whether a variable's value was specified with -D/--define, with
   -F/--force-define, or in the grammar file.  */
typedef enum {
  MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F,
  MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
} muscle_percent_define_how;

/* Define the muscles for %define variable VARIABLE with VALUE specified
   at VARIABLE_LOC in the manner HOW unless it was specified in the
   grammar file while the previous definition for VARIABLE was specified
   with -F/--force-define.  Complain if a previous definition is being
   overridden and the new definition is specified in the grammar file.
   (These rules support the documented behavior as long as command-line
   definitions are processed before grammar file definitions.)  Record
   this as a user occurrence of VARIABLE by invoking
   muscle_user_name_list_grow.  */
void muscle_percent_define_insert (char const *variable, location variable_loc,
                                   char const *value,
                                   muscle_percent_define_how how);

/* Mimic b4_percent_define_get in ../data/bison.m4 exactly.  That is, if the
   %define variable VARIABLE is defined, return its value.  Otherwise, return
   the empty string.  Also, record Bison's usage of VARIABLE by defining
   b4_percent_define_bison_variables(VARIABLE).  The caller is responsible for
   freeing the memory of the returned string.  */
char *muscle_percent_define_get (char const *variable);

/* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly.  That is,
   if the %define variable VARIABLE is undefined, complain fatally since that's
   a Bison error.  Otherwise, return its definition location in a form
   approriate for the first argument of warn_at, complain_at, or fatal_at.
   Don't record this as a Bison usage of VARIABLE as there's no reason to
   suspect that the user-supplied value has yet influenced the output.  */
location muscle_percent_define_get_loc (char const *variable);

/* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly.  That
   is, if the %define variable VARIABLE is undefined, complain fatally since
   that's a Bison error.  Otherwise, return its definition location as a
   b4_syncline invocation.  Don't record this as a Bison usage of VARIABLE as
   there's no reason to suspect that the user-supplied value has yet influenced
   the output.  */
char const *muscle_percent_define_get_syncline (char const *variable);

/* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly.  That is, if the
   %define variable VARIABLE is defined, return true.  Otherwise, return false.
   Also, record Bison's usage of VARIABLE by defining
   b4_percent_define_bison_variables(VARIABLE).  */
bool muscle_percent_define_ifdef (char const *variable);

/* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly.  That is, if
   the %define variable VARIABLE is defined to "" or "true", return true.  If
   it is defined to "false", return false.  Complain if it is undefined (a
   Bison error since the default value should have been set already) or defined
   to any other value (possibly a user error).  Also, record Bison's usage of
   VARIABLE by defining b4_percent_define_bison_variables(VARIABLE).  */
bool muscle_percent_define_flag_if (char const *variable);

/* Mimic b4_percent_define_default in ../data/bison.m4 exactly.  That is, if
   the %define variable VARIABLE is undefined, set its value to VALUE.
   Don't record this as a Bison usage of VARIABLE as there's no reason to
   suspect that the value has yet influenced the output.  */
void muscle_percent_define_default (char const *variable, char const *value);

/* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
   the VALUES structure is more appropriate for C.  That is, VALUES points to a
   list of strings that is partitioned into sublists by NULL's, one terminating
   each sublist.  The last sublist is followed by a second NULL.  For each
   sublist, the first string is the name of a %define variable, and all
   remaining strings in that sublist are the valid values for that variable.
   Complain if such a variable is undefined (a Bison error since the default
   value should have been set already) or defined to any other value (possibly
   a user error).  Don't record this as a Bison usage of the variable as
   there's no reason to suspect that the value has yet influenced the
   output.  */
void muscle_percent_define_check_values (char const * const *values);

/* Grow the muscle for the %code qualifier QUALIFIER appearing at
   QUALIFIER_LOC with code CODE appearing at CODE_LOC.  Record this as a
   user occurrence of QUALIFIER by invoking
   muscle_user_name_list_grow.  */
void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
                               char const *code, location code_loc);

void muscles_m4_output (FILE *out);

#endif /* not MUSCLE_TAB_H_ */
Commit	Line	Data
ae7453f2	1	/* Muscle table manager for Bison,
6e30ede8	2
c932d613	3	Copyright (C) 2001-2003, 2006-2007, 2009-2012 Free Software
ea0a7676	4	Foundation, Inc.
f753cd62 MA	5
	6	This file is part of Bison, the GNU Compiler Compiler.
	7
f16b0819	8	This program is free software: you can redistribute it and/or modify
f753cd62	9	it under the terms of the GNU General Public License as published by
f16b0819 PE	10	the Free Software Foundation, either version 3 of the License, or
f16b0819 PE	11	(at your option) any later version.
f753cd62	12
f16b0819	13	This program is distributed in the hope that it will be useful,
f753cd62 MA	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
f16b0819	19	along with this program. If not, see <http://www.gnu.org/licenses/>. */
f753cd62 MA	20
f753cd62 MA	21	#ifndef MUSCLE_TAB_H_
f7737e2e	22	# define MUSCLE_TAB_H_
f753cd62	23
cd3684cf AD	24	# include "location.h"
cd3684cf AD	25
d33cb3ae	26	void muscle_init (void);
eb095650	27	void muscle_insert (char const key, char const value);
7eb8a0bc	28	char const muscle_find_const (char const key);
9611cfa2	29	char muscle_find (char const key);
d33cb3ae	30	void muscle_free (void);
592e8d4d AD	31
	32
	33	/* An obstack dedicated to receive muscle keys and values. */
	34	extern struct obstack muscle_obstack;
f753cd62	35
d0829076	36	#define MUSCLE_INSERT_BOOL(Key, Value) \
90b9908d	37	do { \
d0829076 PE	38	int v = Value; \
d0829076 PE	39	MUSCLE_INSERT_INT (Key, v); \
90b9908d	40	} while(0)
d0829076	41
9b3add5b	42	#define MUSCLE_INSERT_INT(Key, Value) \
90b9908d	43	do { \
04098407	44	obstack_fgrow1 (&muscle_obstack, "%d", Value); \
9b3add5b RA	45	obstack_1grow (&muscle_obstack, 0); \
9b3add5b RA	46	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
90b9908d	47	} while(0)
9b3add5b	48
680e8701	49	#define MUSCLE_INSERT_LONG_INT(Key, Value) \
90b9908d	50	do { \
04098407	51	obstack_fgrow1 (&muscle_obstack, "%ld", Value); \
680e8701 AD	52	obstack_1grow (&muscle_obstack, 0); \
680e8701 AD	53	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
90b9908d	54	} while(0)
680e8701	55
bd9d212b	56	#define MUSCLE_INSERT_STRING_RAW(Key, Value) \
90b9908d	57	do { \
9b3add5b RA	58	obstack_sgrow (&muscle_obstack, Value); \
	59	obstack_1grow (&muscle_obstack, 0); \
	60	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
90b9908d	61	} while(0)
9b3add5b	62
bd9d212b JD	63	#define MUSCLE_INSERT_STRING(Key, Value) \
	64	do { \
	65	MUSCLE_OBSTACK_SGROW (&muscle_obstack, Value); \
	66	obstack_1grow (&muscle_obstack, 0); \
	67	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
	68	} while(0)
	69
a027c30d	70	#define MUSCLE_OBSTACK_SGROW(Obstack, Value) \
90b9908d	71	do { \
a737b216 PE	72	char const *p; \
	73	for (p = Value; *p; p++) \
	74	switch (*p) \
a027c30d PE	75	{ \
	76	case '$': obstack_sgrow (Obstack, "$]["); break; \
	77	case '@': obstack_sgrow (Obstack, "@@" ); break; \
	78	case '[': obstack_sgrow (Obstack, "@{" ); break; \
	79	case ']': obstack_sgrow (Obstack, "@}" ); break; \
a737b216	80	default: obstack_1grow (Obstack, *p); break; \
a027c30d	81	} \
90b9908d	82	} while(0)
a027c30d PE	83
a027c30d PE	84	#define MUSCLE_INSERT_C_STRING(Key, Value) \
90b9908d	85	do { \
a027c30d PE	86	MUSCLE_OBSTACK_SGROW (&muscle_obstack, \
	87	quotearg_style (c_quoting_style, \
	88	Value)); \
ae7453f2 AD	89	obstack_1grow (&muscle_obstack, 0); \
ae7453f2 AD	90	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
90b9908d	91	} while(0)
9b3add5b	92
50a33993 JD	93	/* Append VALUE to the current value of KEY. If KEY did not already
	94	exist, create it. Use MUSCLE_OBSTACK. De-allocate the previously
	95	associated value. Copy VALUE and SEPARATOR. */
ae7453f2	96
d33cb3ae	97	void muscle_grow (const char key, const char value, const char *separator);
ae7453f2	98
cd3684cf AD	99
	100	/* Append VALUE to the current value of KEY, using muscle_grow. But
	101	in addition, issue a synchronization line for the location LOC. */
	102
	103	void muscle_code_grow (const char key, const char value, location loc);
	104
	105
ae7453f2	106	/* MUSCLE is an M4 list of pairs. Create or extend it with the pair
7ecec4dd JD	107	(A1, A2) after escaping both values with digraphs. Note that because the
	108	muscle values are output double quoted, one needs to strip the first level
	109	of quotes to reach the list itself. */
d33cb3ae PE	110	void muscle_pair_list_grow (const char *muscle,
d33cb3ae PE	111	const char a1, const char a2);
be2a1a68	112
9611cfa2 JD	113	/* In the format `[[file_name:line.column]], [[file_name:line.column]]', append
	114	LOC to MUSCLE. Use digraphs for special characters in each file name. */
	115	void muscle_location_grow (char const *key, location loc);
be2a1a68	116
3fc65ead JD	117	/* In the format `file_name:line.column', append BOUND to MUSCLE. Use digraphs
	118	for special characters in the file name. */
	119	void muscle_boundary_grow (char const *key, boundary bound);
	120
6afc30cc JD	121	/* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
	122	use with b4_check_user_names in ../data/bison.m4. USER_NAME is not escaped
	123	with digraphs, so it must not contain `[' or `]'. */
9611cfa2	124	void muscle_user_name_list_grow (char const key, char const user_name,
7eb8a0bc JD	125	location loc);
7eb8a0bc JD	126
34d41938 JD	127	/* Indicates whether a variable's value was specified with -D/--define, with
	128	-F/--force-define, or in the grammar file. */
	129	typedef enum {
	130	MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F,
	131	MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
	132	} muscle_percent_define_how;
	133
	134	/* Define the muscles for %define variable VARIABLE with VALUE specified
	135	at VARIABLE_LOC in the manner HOW unless it was specified in the
	136	grammar file while the previous definition for VARIABLE was specified
e3a33f7c	137	with -F/--force-define. Complain if a previous definition is being
34d41938 JD	138	overridden and the new definition is specified in the grammar file.
	139	(These rules support the documented behavior as long as command-line
	140	definitions are processed before grammar file definitions.) Record
	141	this as a user occurrence of VARIABLE by invoking
246c4efa	142	muscle_user_name_list_grow. */
9611cfa2	143	void muscle_percent_define_insert (char const *variable, location variable_loc,
34d41938 JD	144	char const *value,
34d41938 JD	145	muscle_percent_define_how how);
9611cfa2	146
f124d423 JD	147	/* Mimic b4_percent_define_get in ../data/bison.m4 exactly. That is, if the
	148	%define variable VARIABLE is defined, return its value. Otherwise, return
	149	the empty string. Also, record Bison's usage of VARIABLE by defining
	150	b4_percent_define_bison_variables(VARIABLE). The caller is responsible for
	151	freeing the memory of the returned string. */
	152	char muscle_percent_define_get (char const variable);
	153
35b8730d JD	154	/* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly. That is,
	155	if the %define variable VARIABLE is undefined, complain fatally since that's
	156	a Bison error. Otherwise, return its definition location in a form
	157	approriate for the first argument of warn_at, complain_at, or fatal_at.
	158	Don't record this as a Bison usage of VARIABLE as there's no reason to
	159	suspect that the user-supplied value has yet influenced the output. */
	160	location muscle_percent_define_get_loc (char const *variable);
	161
	162	/* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly. That
	163	is, if the %define variable VARIABLE is undefined, complain fatally since
	164	that's a Bison error. Otherwise, return its definition location as a
	165	b4_syncline invocation. Don't record this as a Bison usage of VARIABLE as
	166	there's no reason to suspect that the user-supplied value has yet influenced
	167	the output. */
	168	char const muscle_percent_define_get_syncline (char const variable);
	169
f124d423 JD	170	/* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly. That is, if the
	171	%define variable VARIABLE is defined, return true. Otherwise, return false.
	172	Also, record Bison's usage of VARIABLE by defining
	173	b4_percent_define_bison_variables(VARIABLE). */
	174	bool muscle_percent_define_ifdef (char const *variable);
	175
9611cfa2 JD	176	/* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly. That is, if
	177	the %define variable VARIABLE is defined to "" or "true", return true. If
	178	it is defined to "false", return false. Complain if it is undefined (a
	179	Bison error since the default value should have been set already) or defined
	180	to any other value (possibly a user error). Also, record Bison's usage of
	181	VARIABLE by defining b4_percent_define_bison_variables(VARIABLE). */
	182	bool muscle_percent_define_flag_if (char const *variable);
	183
	184	/* Mimic b4_percent_define_default in ../data/bison.m4 exactly. That is, if
	185	the %define variable VARIABLE is undefined, set its value to VALUE.
	186	Don't record this as a Bison usage of VARIABLE as there's no reason to
	187	suspect that the value has yet influenced the output. */
	188	void muscle_percent_define_default (char const variable, char const value);
	189
d782395d JD	190	/* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
	191	the VALUES structure is more appropriate for C. That is, VALUES points to a
	192	list of strings that is partitioned into sublists by NULL's, one terminating
	193	each sublist. The last sublist is followed by a second NULL. For each
	194	sublist, the first string is the name of a %define variable, and all
	195	remaining strings in that sublist are the valid values for that variable.
	196	Complain if such a variable is undefined (a Bison error since the default
	197	value should have been set already) or defined to any other value (possibly
	198	a user error). Don't record this as a Bison usage of the variable as
	199	there's no reason to suspect that the value has yet influenced the
	200	output. */
b1a81613	201	void muscle_percent_define_check_values (char const * const *values);
f124d423	202
246c4efa JD	203	/* Grow the muscle for the %code qualifier QUALIFIER appearing at
	204	QUALIFIER_LOC with code CODE appearing at CODE_LOC. Record this as a
	205	user occurrence of QUALIFIER by invoking
	206	muscle_user_name_list_grow. */
9611cfa2 JD	207	void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
	208	char const *code, location code_loc);
	209
	210	void muscles_m4_output (FILE *out);
	211
f753cd62	212	#endif /* not MUSCLE_TAB_H_ */