src/muscle_tab.h

/* Muscle table manager for Bison,
   Copyright (C) 2001, 2002, 2003, 2006, 2007 Free Software Foundation, Inc.

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

   Bison 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 2, or (at your option)
   any later version.

   Bison 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 Bison; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.  */

#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);

/* Define the muscle for the %define variable VARIABLE appearing at
   VARIABLE_LOC in the grammar file with value VALUE.  Warn if VARIABLE is
   already defined.  Record this as a grammar occurrence of VARIABLE by
   invoking muscle_user_name_list_grow.  */
void muscle_percent_define_insert (char const *variable, location variable_loc,
                                   char const *value);

/* 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);

/* Grow the muscle for the %code qualifier QUALIFIER appearing at QUALIFIER_LOC
   in the grammar file with code CODE appearing at CODE_LOC.  Record this as a
   grammar occurrence of VARIABLE 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
	1	/* Muscle table manager for Bison,
	2	Copyright (C) 2001, 2002, 2003, 2006, 2007 Free Software Foundation, Inc.
	3
	4	This file is part of Bison, the GNU Compiler Compiler.
	5
	6	Bison is free software; you can redistribute it and/or modify
	7	it under the terms of the GNU General Public License as published by
	8	the Free Software Foundation; either version 2, or (at your option)
	9	any later version.
	10
	11	Bison is distributed in the hope that it will be useful,
	12	but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	GNU General Public License for more details.
	15
	16	You should have received a copy of the GNU General Public License
	17	along with Bison; see the file COPYING. If not, write to
	18	the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
	19	Boston, MA 02110-1301, USA. */
	20
	21	#ifndef MUSCLE_TAB_H_
	22	# define MUSCLE_TAB_H_
	23
	24	# include "location.h"
	25
	26	void muscle_init (void);
	27	void muscle_insert (char const key, char const value);
	28	char const muscle_find_const (char const key);
	29	char muscle_find (char const key);
	30	void muscle_free (void);
	31
	32
	33	/* An obstack dedicated to receive muscle keys and values. */
	34	extern struct obstack muscle_obstack;
	35
	36	#define MUSCLE_INSERT_BOOL(Key, Value) \
	37	do { \
	38	int v = Value; \
	39	MUSCLE_INSERT_INT (Key, v); \
	40	} while(0)
	41
	42	#define MUSCLE_INSERT_INT(Key, Value) \
	43	do { \
	44	obstack_fgrow1 (&muscle_obstack, "%d", Value); \
	45	obstack_1grow (&muscle_obstack, 0); \
	46	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
	47	} while(0)
	48
	49	#define MUSCLE_INSERT_LONG_INT(Key, Value) \
	50	do { \
	51	obstack_fgrow1 (&muscle_obstack, "%ld", Value); \
	52	obstack_1grow (&muscle_obstack, 0); \
	53	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
	54	} while(0)
	55
	56	#define MUSCLE_INSERT_STRING_RAW(Key, Value) \
	57	do { \
	58	obstack_sgrow (&muscle_obstack, Value); \
	59	obstack_1grow (&muscle_obstack, 0); \
	60	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
	61	} while(0)
	62
	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
	70	#define MUSCLE_OBSTACK_SGROW(Obstack, Value) \
	71	do { \
	72	char const *p; \
	73	for (p = Value; *p; p++) \
	74	switch (*p) \
	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; \
	80	default: obstack_1grow (Obstack, *p); break; \
	81	} \
	82	} while(0)
	83
	84	#define MUSCLE_INSERT_C_STRING(Key, Value) \
	85	do { \
	86	MUSCLE_OBSTACK_SGROW (&muscle_obstack, \
	87	quotearg_style (c_quoting_style, \
	88	Value)); \
	89	obstack_1grow (&muscle_obstack, 0); \
	90	muscle_insert (Key, obstack_finish (&muscle_obstack)); \
	91	} while(0)
	92
	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. */
	96
	97	void muscle_grow (const char key, const char value, const char *separator);
	98
	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
	106	/* MUSCLE is an M4 list of pairs. Create or extend it with the pair
	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. */
	110	void muscle_pair_list_grow (const char *muscle,
	111	const char a1, const char a2);
	112
	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);
	116
	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
	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 `]'. */
	124	void muscle_user_name_list_grow (char const key, char const user_name,
	125	location loc);
	126
	127	/* Define the muscle for the %define variable VARIABLE appearing at
	128	VARIABLE_LOC in the grammar file with value VALUE. Warn if VARIABLE is
	129	already defined. Record this as a grammar occurrence of VARIABLE by
	130	invoking muscle_user_name_list_grow. */
	131	void muscle_percent_define_insert (char const *variable, location variable_loc,
	132	char const *value);
	133
	134	/* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly. That is, if
	135	the %define variable VARIABLE is defined to "" or "true", return true. If
	136	it is defined to "false", return false. Complain if it is undefined (a
	137	Bison error since the default value should have been set already) or defined
	138	to any other value (possibly a user error). Also, record Bison's usage of
	139	VARIABLE by defining b4_percent_define_bison_variables(VARIABLE). */
	140	bool muscle_percent_define_flag_if (char const *variable);
	141
	142	/* Mimic b4_percent_define_default in ../data/bison.m4 exactly. That is, if
	143	the %define variable VARIABLE is undefined, set its value to VALUE.
	144	Don't record this as a Bison usage of VARIABLE as there's no reason to
	145	suspect that the value has yet influenced the output. */
	146	void muscle_percent_define_default (char const variable, char const value);
	147
	148	/* Grow the muscle for the %code qualifier QUALIFIER appearing at QUALIFIER_LOC
	149	in the grammar file with code CODE appearing at CODE_LOC. Record this as a
	150	grammar occurrence of VARIABLE by invoking muscle_user_name_list_grow. */
	151	void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
	152	char const *code, location code_loc);
	153
	154	void muscles_m4_output (FILE *out);
	155
	156	#endif /* not MUSCLE_TAB_H_ */