2003-06-03 H.J. Lu <hongjiu.lu@intel.com>
[binutils-gdb.git] / gas / macro.h
index cdeea4ad3b475076194090b73dde36766e0248e0..77102150737cf3ac9e9d30b53ca70c391bf8990c 100644 (file)
@@ -1,5 +1,6 @@
-/* macro.h - header file for macro support for gas and gasp
-   Copyright (C) 1994, 95, 96, 97, 1998 Free Software Foundation, Inc.
+/* macro.h - header file for macro support for gas
+   Copyright 1994, 1995, 1996, 1997, 1998, 2000, 2002
+   Free Software Foundation, Inc.
 
    Written by Steve and Judy Chamberlain of Cygnus Support,
       sac@cygnus.com
@@ -19,7 +20,7 @@
    You should have received a copy of the GNU General Public License
    along with GAS; see the file COPYING.  If not, write to the Free
    Software Foundation, 59 Temple Place - Suite 330, Boston, MA
-   02111-1307, USA. */
+   02111-1307, USA.  */
 
 #ifndef MACRO_H
 
 #include "ansidecl.h"
 #include "sb.h"
 
+/* Structures used to store macros.
+
+   Each macro knows its name and included text.  It gets built with a
+   list of formal arguments, and also keeps a hash table which points
+   into the list to speed up formal search.  Each formal knows its
+   name and its default value.  Each time the macro is expanded, the
+   formals get the actual values attatched to them.  */
+
+/* Describe the formal arguments to a macro.  */
+
+typedef struct formal_struct {
+  struct formal_struct *next;  /* Next formal in list.  */
+  sb name;                     /* Name of the formal.  */
+  sb def;                      /* The default value.  */
+  sb actual;                   /* The actual argument (changed on each expansion).  */
+  int index;                   /* The index of the formal 0..formal_count - 1.  */
+} formal_entry;
+
+/* Other values found in the index field of a formal_entry.  */
+#define QUAL_INDEX (-1)
+#define NARG_INDEX (-2)
+#define LOCAL_INDEX (-3)
+
+/* Describe the macro.  */
+
+typedef struct macro_struct
+{
+  sb sub;                              /* Substitution text.  */
+  int formal_count;                    /* Number of formal args.  */
+  formal_entry *formals;               /* Pointer to list of formal_structs.  */
+  struct hash_control *formal_hash;    /* Hash table of formals.  */
+} macro_entry;
+
 /* Whether any macros have been defined.  */
 
 extern int macro_defined;
@@ -39,15 +73,16 @@ extern int macro_nest;
 extern int buffer_and_nest
   PARAMS ((const char *, const char *, sb *, int (*) PARAMS ((sb *))));
 extern void macro_init
-  PARAMS ((int alternate, int mri, int strip_at,
-          int (*) PARAMS ((const char *, int, sb *, int *))));
-extern void macro_mri_mode PARAMS ((int));
+  PARAMS ((int, int, int, int (*) PARAMS ((const char *, int, sb *, int *))));
+extern void macro_mri_mode
+  PARAMS ((int));
 extern const char *define_macro
-  PARAMS ((int idx, sb *in, sb *label, int (*get_line) PARAMS ((sb *)),
-          const char **namep));
-extern int check_macro PARAMS ((const char *, sb *, int, const char **));
-extern void delete_macro PARAMS ((const char *));
+  PARAMS ((int, sb *, sb *, int (*) PARAMS ((sb *)), const char **));
+extern int check_macro
+  PARAMS ((const char *, sb *, const char **, macro_entry **));
+extern void delete_macro
+  PARAMS ((const char *));
 extern const char *expand_irp
-  PARAMS ((int, int, sb *, sb *, int (*) PARAMS ((sb *)), int));
+  PARAMS ((int, int, sb *, sb *, int (*) PARAMS ((sb *))));
 
 #endif