use remote-utils facilities for baud_rate
[deliverable/binutils-gdb.git] / gdb / defs.h
index 35151c7134efd1adc3d055a353829d435e760f21..f7b3d6129cd40238a18f15fa1d07232d5efb6121 100644 (file)
@@ -23,28 +23,24 @@ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.  */
 #include <stdio.h>
 
 /* First include ansidecl.h so we can use the various macro definitions
-   in all subsequent file inclusions.  FIXME:  This inclusion can now
-   be removed from all files that include defs.h */
+   here and in all subsequent file inclusions.  */
 
 #include "ansidecl.h"
 
-/* We could use the EXFUN macro in ansidecl.h to handle prototypes, but
-   the name is misleading the the result is ugly.  So just define a simple
-   macro to handle the parameter lists. */
-
-#ifdef __STDC__
-#define PARAMS(paramlist) paramlist
-#else
-#define PARAMS(paramlist) ()
-#endif
-
 /* An address in the program being debugged.  Host byte order.  */
 typedef unsigned int CORE_ADDR;
 
 #define min(a, b) ((a) < (b) ? (a) : (b))
 #define max(a, b) ((a) > (b) ? (a) : (b))
 
-/* The character C++ uses to build identifiers that must be unique from
+/* Gdb does *lots* of string compares.  Use macros to speed them up by
+   avoiding function calls if the first characters are not the same. */
+
+#define STRCMP(a,b) (*(a) == *(b) ? strcmp ((a), (b)) : (int)*(a) - (int)*(b))
+#define STREQ(a,b) (*(a) == *(b) ? !strcmp ((a), (b)) : 0)
+#define STREQN(a,b,c) (*(a) == *(b) ? !strncmp ((a), (b), (c)) : 0)
+
+/* The character GNU C++ uses to build identifiers that must be unique from
    the program's identifiers (such as $this and $$vptr).  */
 #define CPLUS_MARKER '$'       /* May be overridden to '.' for SysV */
 
@@ -52,14 +48,18 @@ typedef unsigned int CORE_ADDR;
 
 extern int quit_flag;
 extern int immediate_quit;
+extern int sevenbit_strings;
 
 extern void
 quit PARAMS ((void));
 
 #define QUIT { if (quit_flag) quit (); }
 
-/* Notes on classes: class_alias is for alias commands which are not
-   abbreviations of the original command.  */
+/* Command classes are top-level categories into which commands are broken
+   down for "help" purposes.  
+   Notes on classes: class_alias is for alias commands which are not
+   abbreviations of the original command.  class-pseudo is for commands
+   which are not really commands nor help topics ("stop").  */
 
 enum command_class
 {
@@ -68,7 +68,23 @@ enum command_class
   /* Classes of commands */
   no_class = -1, class_run = 0, class_vars, class_stack,
   class_files, class_support, class_info, class_breakpoint,
-  class_alias, class_obscure, class_user
+  class_alias, class_obscure, class_user, class_maintenance,
+  class_pseudo
+};
+
+/* Languages represented in the symbol table and elsewhere.
+   This should probably be in language.h, but since enum's can't
+   be forward declared to satisfy opaque references before their
+   actual definition, needs to be here. */
+
+enum language 
+{
+   language_unknown,           /* Language not known */
+   language_auto,              /* Placeholder for automatic setting */
+   language_c,                         /* C */
+   language_cplus,             /* C++ */
+   language_chill,             /* Chill */
+   language_m2                 /* Modula-2 */
 };
 
 /* the cleanup list records things that have to be undone
@@ -99,7 +115,12 @@ inside_entry_file PARAMS ((CORE_ADDR addr));
 extern int
 inside_main_func PARAMS ((CORE_ADDR pc));
 
-/* From cplus-dem.c */
+/* From ch-lang.c, for the moment. (FIXME) */
+
+extern char *
+chill_demangle PARAMS ((const char *));
+
+/* From libiberty.a */
 
 extern char *
 cplus_demangle PARAMS ((const char *, int));
@@ -132,9 +153,6 @@ mmalloc_getkey PARAMS ((PTR, int));
 
 /* From utils.c */
 
-extern char *
-demangle_and_match PARAMS ((const char *, const char *, int));
-
 extern int
 strcmp_iw PARAMS ((const char *, const char *));
 
@@ -145,7 +163,7 @@ extern char *
 safe_strsignal PARAMS ((int));
 
 extern void
-init_malloc PARAMS ((PTR));
+init_malloc PARAMS ((void *));
 
 extern void
 request_quit PARAMS ((int));
@@ -190,6 +208,9 @@ myread PARAMS ((int, char *, int));
 extern int
 query ();
 
+extern void
+begin_line PARAMS ((void));
+
 extern void
 wrap_here PARAMS ((char *));
 
@@ -205,12 +226,24 @@ fputs_filtered PARAMS ((const char *, FILE *));
 extern void
 puts_filtered PARAMS ((char *));
 
+extern void
+vprintf_filtered ();
+
+extern void
+vfprintf_filtered ();
+
 extern void
 fprintf_filtered ();
 
+extern void
+fprintfi_filtered ();
+
 extern void
 printf_filtered ();
 
+extern void
+printfi_filtered ();
+
 extern void
 print_spaces PARAMS ((int, FILE *));
 
@@ -221,13 +254,10 @@ extern char *
 n_spaces PARAMS ((int));
 
 extern void
-printchar PARAMS ((int, FILE *, int));
-
-extern void
-fprint_symbol PARAMS ((FILE *, char *));
+gdb_printchar PARAMS ((int, FILE *, int));
 
 extern void
-fputs_demangled PARAMS ((char *, FILE *, int));
+fprintf_symbol_filtered PARAMS ((FILE *, char *, enum language, int));
 
 extern void
 perror_with_name PARAMS ((char *));
@@ -265,9 +295,6 @@ batch_mode PARAMS ((void));
 extern int
 input_from_terminal_p PARAMS ((void));
 
-extern int
-catch_errors PARAMS ((int (*) (char *), char *, char *));
-
 /* From printcmd.c */
 
 extern void
@@ -326,47 +353,31 @@ extern char *current_directory;
 extern unsigned input_radix;
 extern unsigned output_radix;
 
-/* Baud rate specified for communication with serial target systems.  */
-extern char *baud_rate;
-
-/* Languages represented in the symbol table and elsewhere. */
+/* Possibilities for prettyprint parameters to routines which print
+   things.  Like enum language, this should be in value.h, but needs
+   to be here for the same reason.  FIXME:  If we can eliminate this
+   as an arg to LA_VAL_PRINT, then we can probably move it back to
+   value.h. */
 
-enum language 
+enum val_prettyprint
 {
-   language_unknown,           /* Language not known */
-   language_auto,              /* Placeholder for automatic setting */
-   language_c,                         /* C */
-   language_cplus,             /* C++ */
-   language_m2                 /* Modula-2 */
+  Val_no_prettyprint = 0,
+  Val_prettyprint,
+  /* Use the default setting which the user has specified.  */
+  Val_pretty_default
 };
 
-/* Return a format string for printf that will print a number in the local
-   (language-specific) hexadecimal format.  Result is static and is
-   overwritten by the next call.  local_hex_format_custom takes printf
-   options like "08" or "l" (to produce e.g. %08x or %lx).  */
-
-#define local_hex_format() (current_language->la_hex_format)
-
-extern char *
-local_hex_format_custom PARAMS ((char *));     /* language.c */
-
-/* Return a string that contains a number formatted in the local
-   (language-specific) hexadecimal format.  Result is static and is
-   overwritten by the next call.  local_hex_string_custom takes printf
-   options like "08" or "l".  */
-
-extern char *
-local_hex_string PARAMS ((int));               /* language.c */
-
-extern char *
-local_hex_string_custom PARAMS ((int, char *));        /* language.c */
-
 \f
 /* Host machine definition.  This will be a symlink to one of the
    xm-*.h files, built by the `configure' script.  */
 
 #include "xm.h"
 
+/* Native machine support.  This will be a symlink to one of the
+   nm-*.h files, built by the `configure' script.  */
+
+#include "nm.h"
+
 /* If the xm.h file did not define the mode string used to open the
    files, assume that binary files are opened the same way as text
    files */
@@ -401,32 +412,52 @@ local_hex_string_custom PARAMS ((int, char *));   /* language.c */
 #endif /* STDC */
 #endif /* volatile */
 
+#if 1
+#define NORETURN /*nothing*/
+#else /* not 1 */
+/* FIXME: This is bogus.  Having "volatile void" mean a function doesn't
+   return is a gcc extension and should be based on #ifdef __GNUC__.
+   Also, as of Sep 93 I'm told gcc is changing the syntax for ansi
+   reasons (so declaring exit here as "volatile void" and as "void" in
+   a system header loses).  Using the new "__attributes__ ((noreturn));"
+   syntax would lose for old versions of gcc; using
+     typedef void exit_fn_type PARAMS ((int));
+     volatile exit_fn_type exit;
+   would win.  */
 /* Some compilers (many AT&T SVR4 compilers for instance), do not accept
    declarations of functions that never return (exit for instance) as
    "volatile void".  For such compilers "NORETURN" can be defined away
    to keep them happy */
 
 #ifndef NORETURN
-# define NORETURN volatile
+# ifdef __lucid
+#   define NORETURN /*nothing*/
+# else
+#   define NORETURN volatile
+# endif
 #endif
+#endif /* not 1 */
 
 /* Defaults for system-wide constants (if not defined by xm.h, we fake it).  */
 
 #if !defined (UINT_MAX)
-#define UINT_MAX 0xffffffff
-#endif
-
-#if !defined (LONG_MAX)
-#define LONG_MAX 0x7fffffff
+#define        UINT_MAX ((unsigned int)(~0))           /* 0xFFFFFFFF for 32-bits */
 #endif
 
 #if !defined (INT_MAX)
-#define INT_MAX 0x7fffffff
+#define        INT_MAX ((int)(UINT_MAX >> 1))          /* 0x7FFFFFFF for 32-bits */
 #endif
 
 #if !defined (INT_MIN)
-/* Two's complement, 32 bit.  */
-#define INT_MIN -0x80000000
+#define INT_MIN (-INT_MAX - 1)                 /* 0x80000000 for 32-bits */
+#endif
+
+#if !defined (ULONG_MAX)
+#define        ULONG_MAX ((unsigned long)(~0L))        /* 0xFFFFFFFF for 32-bits */
+#endif
+
+#if !defined (LONG_MAX)
+#define        LONG_MAX ((long)(ULONG_MAX >> 1))       /* 0x7FFFFFFF for 32-bits */
 #endif
 
 /* Number of bits in a char or unsigned char for the target machine.
@@ -485,29 +516,59 @@ local_hex_string_custom PARAMS ((int, char *));   /* language.c */
 #define TARGET_PTR_BIT TARGET_INT_BIT
 #endif
 
-/* Convert a LONGEST to an int.  This is used in contexts (e.g. number
-   of arguments to a function, number in a value history, register
-   number, etc.) where the value must not be larger than can fit
-   in an int.  */
-#if !defined (longest_to_int)
-#if defined (LONG_LONG)
-#define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
-                          ? (error ("Value out of range."),0) : (int) (x))
-#else /* No LONG_LONG.  */
-/* Assume sizeof (int) == sizeof (long).  */
-#define longest_to_int(x) ((int) (x))
-#endif /* No LONG_LONG.  */
-#endif /* No longest_to_int.  */
-
-/* This should not be a typedef, because "unsigned LONGEST" needs
-   to work. LONG_LONG is defined if the host has "long long".  */
+/* Default to support for "long long" if the host compiler being used is gcc.
+   Config files must define CC_HAS_LONG_LONG to use other host compilers
+   that are capable of supporting "long long", and to cause gdb to use that
+   support.  Not defining CC_HAS_LONG_LONG will suppress use of "long long"
+   regardless of what compiler is used.
+
+   FIXME: For now, automatic selection of "long long" as the default when
+   gcc is used is disabled, pending further testing.  Concerns include the
+   impact on gdb performance and the universality of bugfree long long
+   support on platforms that do have gcc.  Compiling with FORCE_LONG_LONG
+   will select "long long" use for testing purposes.  -fnf */
+
+#ifndef CC_HAS_LONG_LONG
+#  if defined (__GNUC__) && defined (FORCE_LONG_LONG) /* See FIXME above */
+#    define CC_HAS_LONG_LONG 1
+#  endif
+#endif
+       
+/* LONGEST should not be a typedef, because "unsigned LONGEST" needs to work.
+   CC_HAS_LONG_LONG is defined if the host compiler supports "long long"
+   variables and we wish to make use of that support.  */
 
 #ifndef LONGEST
-# ifdef LONG_LONG
-#  define LONGEST long long
-# else
-#  define LONGEST long
-# endif
+#  ifdef CC_HAS_LONG_LONG
+#    define LONGEST long long
+#  else
+#    define LONGEST long
+#  endif
+#endif
+
+/* Convert a LONGEST to an int.  This is used in contexts (e.g. number of
+   arguments to a function, number in a value history, register number, etc.)
+   where the value must not be larger than can fit in an int.  */
+
+#ifndef longest_to_int
+#  ifdef CC_HAS_LONG_LONG
+#    define longest_to_int(x) (((x) > INT_MAX || (x) < INT_MIN) \
+                              ? (error ("Value out of range."),0) : (int) (x))
+#  else
+     /* Assume sizeof (int) == sizeof (long).  */
+#    define longest_to_int(x) ((int) (x))
+#  endif
+#endif
+
+/* If we picked up a copy of CHAR_BIT from a configuration file
+   (which may get it by including <limits.h>) then use it to set
+   the number of bits in a host char.  If not, use the same size
+   as the target. */
+
+#if defined (CHAR_BIT)
+#define HOST_CHAR_BIT CHAR_BIT
+#else
+#define HOST_CHAR_BIT TARGET_CHAR_BIT
 #endif
 
 /* Assorted functions we can declare, now that const and volatile are 
@@ -558,7 +619,7 @@ mmtrace PARAMS ((void));
 extern int
 parse_escape PARAMS ((char **));
 
-extern char *reg_names[];
+extern const char * const reg_names[];
 
 extern NORETURN void                   /* Does not return to the caller.  */
 error ();
@@ -572,8 +633,25 @@ exit PARAMS ((int));                       /* 4.10.4.3 */
 extern NORETURN void                   /* Does not return to the caller.  */
 nomem PARAMS ((long));
 
+/* Reasons for calling return_to_top_level.  */
+enum return_reason {
+  /* User interrupt.  */
+  RETURN_QUIT,
+
+  /* Any other error.  */
+  RETURN_ERROR
+};
+
+#define RETURN_MASK_QUIT (1 << (int)RETURN_QUIT)
+#define RETURN_MASK_ERROR (1 << (int)RETURN_ERROR)
+#define RETURN_MASK_ALL (RETURN_MASK_QUIT | RETURN_MASK_ERROR)
+typedef int return_mask;
+
 extern NORETURN void                   /* Does not return to the caller.  */
-return_to_top_level PARAMS ((void));
+return_to_top_level PARAMS ((enum return_reason));
+
+extern int catch_errors PARAMS ((int (*) (char *), void *, char *,
+                                return_mask));
 
 extern void
 warning_setup PARAMS ((void));
@@ -588,7 +666,7 @@ extern char *
 basename PARAMS ((char *));
 
 extern char *
-getenv PARAMS ((CONST char *));
+getenv PARAMS ((const char *));
 
 extern char **
 buildargv PARAMS ((char *));
@@ -621,7 +699,7 @@ strsignal PARAMS ((int));
 
 #ifndef PSIGNAL_IN_SIGNAL_H
 extern void
-psignal PARAMS ((unsigned, char *));
+psignal PARAMS ((unsigned, const char *));
 #endif
 
 /* For now, we can't include <stdlib.h> because it conflicts with
@@ -647,6 +725,9 @@ perror PARAMS ((const char *));                             /* 4.9.10.4 */
 extern double
 atof PARAMS ((const char *nptr));                      /* 4.10.1.1 */
 
+extern int
+atoi PARAMS ((const char *));                          /* 4.10.1.2 */
+
 #ifndef MALLOC_INCOMPATIBLE
 
 extern PTR
@@ -665,6 +746,14 @@ qsort PARAMS ((void *base, size_t nmemb,           /* 4.10.5.2 */
               size_t size,
               int (*comp)(const void *, const void *)));
 
+#ifndef        MEM_FNS_DECLARED        /* Some non-ANSI use void *, not char *.  */
+extern PTR
+memcpy PARAMS ((void *, const void *, size_t));                /* 4.11.2.1 */
+
+extern int
+memcmp PARAMS ((const void *, const void *, size_t));  /* 4.11.4.1 */
+#endif
+
 extern char *
 strchr PARAMS ((const char *, int));                   /* 4.11.5.2 */
 
@@ -677,6 +766,11 @@ strstr PARAMS ((const char *, const char *));              /* 4.11.5.7 */
 extern char *
 strtok PARAMS ((char *, const char *));                        /* 4.11.5.8 */
 
+#ifndef        MEM_FNS_DECLARED        /* Some non-ANSI use void *, not char *.  */
+extern PTR
+memset PARAMS ((void *, int, size_t));                 /* 4.11.6.1 */
+#endif
+
 extern char *
 strerror PARAMS ((int));                               /* 4.11.6.2 */
 
@@ -686,13 +780,17 @@ strerror PARAMS ((int));                          /* 4.11.6.2 */
 #  define alloca __builtin_alloca
 # else
 #  ifdef sparc
-#   include <alloca.h>
+#   include <alloca.h>         /* NOTE:  Doesn't declare alloca() */
 #  endif
+#  ifdef __STDC__
+   extern void *alloca (size_t);
+#  else /* __STDC__ */
    extern char *alloca ();
+#  endif
 # endif
 #endif
 
-/* TARGET_BYTE_ORDER and HOST_BYTE_ORDER should be defined to one of these.  */
+/* TARGET_BYTE_ORDER and HOST_BYTE_ORDER must be defined to one of these.  */
 
 #if !defined (BIG_ENDIAN)
 #define BIG_ENDIAN 4321
@@ -702,18 +800,12 @@ strerror PARAMS ((int));                          /* 4.11.6.2 */
 #define LITTLE_ENDIAN 1234
 #endif
 
-/* Target-system-dependent parameters for GDB.
-
-   The standard thing is to include defs.h.  However, files that are
-   specific to a particular target can define TM_FILE_OVERRIDE before
-   including defs.h, then can include any particular tm-file they desire.  */
+/* Target-system-dependent parameters for GDB. */
 
 /* Target machine definition.  This will be a symlink to one of the
    tm-*.h files, built by the `configure' script.  */
 
-#ifndef TM_FILE_OVERRIDE
 #include "tm.h"
-#endif
 
 /* The bit byte-order has to do just with numbering of bits in
    debugging symbols and such.  Conceptually, it's quite separate
@@ -729,7 +821,10 @@ strerror PARAMS ((int));                           /* 4.11.6.2 */
 #endif /* Little endian.  */
 #endif /* BITS_BIG_ENDIAN not defined.  */
 
-/* Swap LEN bytes at BUFFER between target and host byte-order.  */
+/* Swap LEN bytes at BUFFER between target and host byte-order.  This is
+   the wrong way to do byte-swapping because it assumes that you have a way
+   to have a host variable of exactly the right size.
+   extract_* are the right way.  */
 #if TARGET_BYTE_ORDER == HOST_BYTE_ORDER
 #define SWAP_TARGET_AND_HOST(buffer,len)
 #else /* Target and host byte order differ.  */
@@ -747,12 +842,24 @@ strerror PARAMS ((int));                          /* 4.11.6.2 */
   }
 #endif /* Target and host byte order differ.  */
 
+/* In findvar.c.  */
+LONGEST extract_signed_integer PARAMS ((void *, int));
+unsigned LONGEST extract_unsigned_integer PARAMS ((void *, int));
+CORE_ADDR extract_address PARAMS ((void *, int));
+
+void store_signed_integer PARAMS ((void *, int, LONGEST));
+void store_unsigned_integer PARAMS ((void *, int, unsigned LONGEST));
+void store_address PARAMS ((void *, int, CORE_ADDR));
+\f
 /* On some machines there are bits in addresses which are not really
    part of the address, but are used by the kernel, the hardware, etc.
    for special purposes.  ADDR_BITS_REMOVE takes out any such bits
    so we get a "real" address such as one would find in a symbol
    table.  ADDR_BITS_SET sets those bits the way the system wants
-   them.  */
+   them.  This is used only for addresses of instructions, and even then
+   I'm not sure it's used in all contexts.  It exists to deal with there
+   being a few stray bits in the PC which would mislead us, not as some sort
+   of generic thing to handle alignment or segmentation.  */
 #if !defined (ADDR_BITS_REMOVE)
 #define ADDR_BITS_REMOVE(addr) (addr)
 #define ADDR_BITS_SET(addr) (addr)
@@ -771,4 +878,19 @@ push_word PARAMS ((CORE_ADDR, REGISTER_TYPE));
 extern CORE_ADDR
 push_word ();
 
+/* Some parts of gdb might be considered optional, in the sense that they
+   are not essential for being able to build a working, usable debugger
+   for a specific environment.  For example, the maintenance commands
+   are there for the benefit of gdb maintainers.  As another example,
+   some environments really don't need gdb's that are able to read N
+   different object file formats.  In order to make it possible (but
+   not necessarily recommended) to build "stripped down" versions of
+   gdb, the following defines control selective compilation of those
+   parts of gdb which can be safely left out when necessary.  Note that
+   the default is to include everything. */
+
+#ifndef MAINTENANCE_CMDS
+#define MAINTENANCE_CMDS 1
+#endif
+
 #endif /* !defined (DEFS_H) */
This page took 0.028891 seconds and 4 git commands to generate.