gdb: fix python/lib/gdb/__init__.py formatting
[deliverable/binutils-gdb.git] / gdb / parser-defs.h
index f03f53700961c96aaa79f919c0a4ff5ae24574b3..e58dc12303f57539155c41920ded20802b23e4bb 100644 (file)
@@ -1,7 +1,6 @@
 /* Parser definitions for GDB.
 
-   Copyright 1986, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996,
-   1997, 1998, 1999, 2000, 2002 Free Software Foundation, Inc.
+   Copyright (C) 1986-2021 Free Software Foundation, Inc.
 
    Modified from expread.y by the Department of Computer Science at the
    State University of New York at Buffalo.
@@ -10,7 +9,7 @@
 
    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 2 of the License, or
+   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,
    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, 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/>.  */
 
 #if !defined (PARSER_DEFS_H)
 #define PARSER_DEFS_H 1
 
-#include "doublest.h"
+#include "expression.h"
+#include "symtab.h"
+#include "expop.h"
 
 struct block;
+struct language_defn;
+struct internalvar;
+class innermost_block_tracker;
 
-extern struct expression *expout;
-extern int expout_size;
-extern int expout_ptr;
+extern bool parser_debug;
 
-/* If this is nonzero, this block is used as the lexical context
-   for symbol names.  */
+/* A class that can be used to build a "struct expression".  */
 
-extern struct block *expression_context_block;
+struct expr_builder
+{
+  /* Constructor.  LANG is the language used to parse the expression.
+     And GDBARCH is the gdbarch to use during parsing.  */
 
-/* If expression_context_block is non-zero, then this is the PC within
-   the block that we want to evaluate expressions at.  When debugging
-   C or C++ code, we use this to find the exact line we're at, and
-   then look up the macro definitions active at that point.  */
-extern CORE_ADDR expression_context_pc;
+  expr_builder (const struct language_defn *lang,
+               struct gdbarch *gdbarch)
+    : expout (new expression (lang, gdbarch))
+  {
+  }
 
-/* The innermost context required by the stack and register variables
-   we've encountered so far. */
-extern struct block *innermost_block;
+  DISABLE_COPY_AND_ASSIGN (expr_builder);
 
-/* The block in which the most recently discovered symbol was found.
-   FIXME: Should be declared along with lookup_symbol in symtab.h; is not
-   related specifically to parsing.  */
-extern struct block *block_found;
+  /* Resize the allocated expression to the correct size, and return
+     it as an expression_up -- passing ownership to the caller.  */
+  ATTRIBUTE_UNUSED_RESULT expression_up release ()
+  {
+    return std::move (expout);
+  }
 
-/* Number of arguments seen so far in innermost function call.  */
-extern int arglist_len;
+  /* Return the gdbarch that was passed to the constructor.  */
 
-/* A string token, either a char-string or bit-string.  Char-strings are
-   used, for example, for the names of symbols. */
-
-struct stoken
+  struct gdbarch *gdbarch ()
   {
-    /* Pointer to first byte of char-string or first bit of bit-string */
-    char *ptr;
-    /* Length of string in bytes for char-string or bits for bit-string */
-    int length;
-  };
+    return expout->gdbarch;
+  }
 
-struct ttype
+  /* Return the language that was passed to the constructor.  */
+
+  const struct language_defn *language ()
   {
-    struct stoken stoken;
-    struct type *type;
-  };
+    return expout->language_defn;
+  }
 
-struct symtoken
+  /* Set the root operation of the expression that is currently being
+     built.  */
+  void set_operation (expr::operation_up &&op)
   {
-    struct stoken stoken;
-    struct symbol *sym;
-    int is_a_field_of_this;
-  };
+    expout->op = std::move (op);
+  }
+
+  /* The expression related to this parser state.  */
+
+  expression_up expout;
+};
+
+/* This is used for expression completion.  */
+
+struct expr_completion_state
+{
+  /* The last struct expression directly before a '.' or '->'.  This
+     is set when parsing and is only used when completing a field
+     name.  It is nullptr if no dereference operation was found.  */
+  expr::structop_base_operation *expout_last_op = nullptr;
+
+  /* If we are completing a tagged type name, this will be nonzero.  */
+  enum type_code expout_tag_completion_type = TYPE_CODE_UNDEF;
+
+  /* The token for tagged type name completion.  */
+  gdb::unique_xmalloc_ptr<char> expout_completion_name;
+};
+
+/* An instance of this type is instantiated during expression parsing,
+   and passed to the appropriate parser.  It holds both inputs to the
+   parser, and result.  */
+
+struct parser_state : public expr_builder
+{
+  /* Constructor.  LANG is the language used to parse the expression.
+     And GDBARCH is the gdbarch to use during parsing.  */
+
+  parser_state (const struct language_defn *lang,
+               struct gdbarch *gdbarch,
+               const struct block *context_block,
+               CORE_ADDR context_pc,
+               int comma,
+               const char *input,
+               bool completion,
+               innermost_block_tracker *tracker,
+               bool void_p)
+    : expr_builder (lang, gdbarch),
+      expression_context_block (context_block),
+      expression_context_pc (context_pc),
+      comma_terminates (comma),
+      lexptr (input),
+      parse_completion (completion),
+      block_tracker (tracker),
+      void_context_p (void_p)
+  {
+  }
 
-struct objc_class_str
+  DISABLE_COPY_AND_ASSIGN (parser_state);
+
+  /* Begin counting arguments for a function call,
+     saving the data about any containing call.  */
+
+  void start_arglist ()
   {
-    struct stoken stoken;
-    struct type *type;
-    int class;
-  };
+    m_funcall_chain.push_back (arglist_len);
+    arglist_len = 0;
+  }
 
+  /* Return the number of arguments in a function call just terminated,
+     and restore the data for the containing function call.  */
 
-/* For parsing of complicated types.
-   An array should be preceded in the list by the size of the array.  */
-enum type_pieces
+  int end_arglist ()
   {
-    tp_end = -1, 
-    tp_pointer, 
-    tp_reference, 
-    tp_array, 
-    tp_function, 
-    tp_const, 
-    tp_volatile, 
-    tp_space_identifier
-  };
-/* The stack can contain either an enum type_pieces or an int.  */
-union type_stack_elt
+    int val = arglist_len;
+    arglist_len = m_funcall_chain.back ();
+    m_funcall_chain.pop_back ();
+    return val;
+  }
+
+  /* Mark the given operation as the starting location of a structure
+     expression.  This is used when completing on field names.  */
+
+  void mark_struct_expression (expr::structop_base_operation *op);
+
+  /* Indicate that the current parser invocation is completing a tag.
+     TAG is the type code of the tag, and PTR and LENGTH represent the
+     start of the tag name.  */
+
+  void mark_completion_tag (enum type_code tag, const char *ptr, int length);
+
+  /* Push an operation on the stack.  */
+  void push (expr::operation_up &&op)
   {
-    enum type_pieces piece;
-    int int_val;
-  };
-extern union type_stack_elt *type_stack;
-extern int type_stack_depth, type_stack_size;
+    m_operations.push_back (std::move (op));
+  }
 
-extern void write_exp_elt (union exp_element);
+  /* Create a new operation and push it on the stack.  */
+  template<typename T, typename... Arg>
+  void push_new (Arg... args)
+  {
+    m_operations.emplace_back (new T (std::forward<Arg> (args)...));
+  }
 
-extern void write_exp_elt_opcode (enum exp_opcode);
+  /* Push a new C string operation.  */
+  void push_c_string (int, struct stoken_vector *vec);
 
-extern void write_exp_elt_sym (struct symbol *);
+  /* Push a symbol reference.  If SYM is nullptr, look for a minimal
+     symbol.  */
+  void push_symbol (const char *name, block_symbol sym);
 
-extern void write_exp_elt_longcst (LONGEST);
+  /* Push a reference to $mumble.  This may result in a convenience
+     variable, a history reference, or a register.  */
+  void push_dollar (struct stoken str);
 
-extern void write_exp_elt_dblcst (DOUBLEST);
+  /* Pop an operation from the stack.  */
+  expr::operation_up pop ()
+  {
+    expr::operation_up result = std::move (m_operations.back ());
+    m_operations.pop_back ();
+    return result;
+  }
 
-extern void write_exp_elt_type (struct type *);
+  /* Pop N elements from the stack and return a vector.  */
+  std::vector<expr::operation_up> pop_vector (int n)
+  {
+    std::vector<expr::operation_up> result (n);
+    for (int i = 1; i <= n; ++i)
+      result[n - i] = pop ();
+    return result;
+  }
+
+  /* A helper that pops an operation, wraps it in some other
+     operation, and pushes it again.  */
+  template<typename T>
+  void wrap ()
+  {
+    using namespace expr;
+    operation_up v = ::expr::make_operation<T> (pop ());
+    push (std::move (v));
+  }
+
+  /* A helper that pops two operations, wraps them in some other
+     operation, and pushes the result.  */
+  template<typename T>
+  void wrap2 ()
+  {
+    expr::operation_up rhs = pop ();
+    expr::operation_up lhs = pop ();
+    push (expr::make_operation<T> (std::move (lhs), std::move (rhs)));
+  }
 
-extern void write_exp_elt_intern (struct internalvar *);
+  /* If this is nonzero, this block is used as the lexical context for
+     symbol names.  */
 
-extern void write_exp_string (struct stoken);
+  const struct block * const expression_context_block;
 
-extern void write_exp_bitstring (struct stoken);
+  /* If expression_context_block is non-zero, then this is the PC
+     within the block that we want to evaluate expressions at.  When
+     debugging C or C++ code, we use this to find the exact line we're
+     at, and then look up the macro definitions active at that
+     point.  */
+  const CORE_ADDR expression_context_pc;
 
-extern void write_exp_elt_block (struct block *);
+  /* Nonzero means stop parsing on first comma (if not within parentheses).  */
 
-extern void write_exp_msymbol (struct minimal_symbol *,
-                              struct type *, struct type *);
+  int comma_terminates;
 
-extern void write_dollar_variable (struct stoken str);
+  /* During parsing of a C expression, the pointer to the next character
+     is in this variable.  */
 
-extern struct symbol *parse_nested_classes_for_hpacc (char *, int, char **,
-                                                     int *, char **);
+  const char *lexptr;
 
-extern char *find_template_name_end (char *);
+  /* After a token has been recognized, this variable points to it.
+     Currently used only for error reporting.  */
+  const char *prev_lexptr = nullptr;
 
-extern void start_arglist (void);
+  /* Number of arguments seen so far in innermost function call.  */
 
-extern int end_arglist (void);
+  int arglist_len = 0;
 
-extern char *copy_name (struct stoken);
+  /* True if parsing an expression to attempt completion.  */
+  bool parse_completion;
 
-extern void push_type (enum type_pieces);
+  /* Completion state is updated here.  */
+  expr_completion_state m_completion_state;
 
-extern void push_type_int (int);
+  /* The innermost block tracker.  */
+  innermost_block_tracker *block_tracker;
 
-extern void push_type_address_space (char *);
+  /* True if no value is expected from the expression.  */
+  bool void_context_p;
 
-extern enum type_pieces pop_type (void);
+private:
 
-extern int pop_type_int (void);
+  /* Data structure for saving values of arglist_len for function calls whose
+     arguments contain other function calls.  */
 
-extern int length_of_subexp (struct expression *, int);
+  std::vector<int> m_funcall_chain;
 
-extern struct type *follow_types (struct type *);
+  /* Stack of operations.  */
+  std::vector<expr::operation_up> m_operations;
+};
 
-/* During parsing of a C expression, the pointer to the next character
-   is in this variable.  */
+/* When parsing expressions we track the innermost block that was
+   referenced.  */
 
-extern char *lexptr;
+class innermost_block_tracker
+{
+public:
+  innermost_block_tracker (innermost_block_tracker_types types
+                          = INNERMOST_BLOCK_FOR_SYMBOLS)
+    : m_types (types),
+      m_innermost_block (NULL)
+  { /* Nothing.  */ }
 
-/* After a token has been recognized, this variable points to it.  
-   Currently used only for error reporting.  */
-extern char *prev_lexptr;
+  /* Update the stored innermost block if the new block B is more inner
+     than the currently stored block, or if no block is stored yet.  The
+     type T tells us whether the block B was for a symbol or for a
+     register.  The stored innermost block is only updated if the type T is
+     a type we are interested in, the types we are interested in are held
+     in M_TYPES and set during RESET.  */
+  void update (const struct block *b, innermost_block_tracker_types t);
 
-/* Tokens that refer to names do so with explicit pointer and length,
-   so they can share the storage that lexptr is parsing.
+  /* Overload of main UPDATE method which extracts the block from BS.  */
+  void update (const struct block_symbol &bs)
+  {
+    update (bs.block, INNERMOST_BLOCK_FOR_SYMBOLS);
+  }
 
-   When it is necessary to pass a name to a function that expects
-   a null-terminated string, the substring is copied out
-   into a block of storage that namecopy points to.
+  /* Return the stored innermost block.  Can be nullptr if no symbols or
+     registers were found during an expression parse, and so no innermost
+     block was defined.  */
+  const struct block *block () const
+  {
+    return m_innermost_block;
+  }
 
-   namecopy is allocated once, guaranteed big enough, for each parsing.  */
+private:
+  /* The type of innermost block being looked for.  */
+  innermost_block_tracker_types m_types;
 
-extern char *namecopy;
+  /* The currently stored innermost block found while parsing an
+     expression.  */
+  const struct block *m_innermost_block;
+};
 
-/* Current depth in parentheses within the expression.  */
+/* A string token, either a char-string or bit-string.  Char-strings are
+   used, for example, for the names of symbols.  */
 
-extern int paren_depth;
+struct stoken
+  {
+    /* Pointer to first byte of char-string or first bit of bit-string.  */
+    const char *ptr;
+    /* Length of string in bytes for char-string or bits for bit-string.  */
+    int length;
+  };
 
-/* Nonzero means stop parsing on first comma (if not within parentheses).  */
+struct typed_stoken
+  {
+    /* A language-specific type field.  */
+    int type;
+    /* Pointer to first byte of char-string or first bit of bit-string.  */
+    char *ptr;
+    /* Length of string in bytes for char-string or bits for bit-string.  */
+    int length;
+  };
 
-extern int comma_terminates;
-\f
-/* These codes indicate operator precedences for expression printing,
-   least tightly binding first.  */
-/* Adding 1 to a precedence value is done for binary operators,
-   on the operand which is more tightly bound, so that operators
-   of equal precedence within that operand will get parentheses.  */
-/* PREC_HYPER and PREC_ABOVE_COMMA are not the precedence of any operator;
-   they are used as the "surrounding precedence" to force
-   various kinds of things to be parenthesized.  */
-enum precedence
-  {
-    PREC_NULL, PREC_COMMA, PREC_ABOVE_COMMA, PREC_ASSIGN, PREC_LOGICAL_OR,
-    PREC_LOGICAL_AND, PREC_BITWISE_IOR, PREC_BITWISE_AND, PREC_BITWISE_XOR,
-    PREC_EQUAL, PREC_ORDER, PREC_SHIFT, PREC_ADD, PREC_MUL, PREC_REPEAT,
-    PREC_HYPER, PREC_PREFIX, PREC_SUFFIX, PREC_BUILTIN_FUNCTION
+struct stoken_vector
+  {
+    int len;
+    struct typed_stoken *tokens;
   };
 
-/* Table mapping opcodes into strings for printing operators
-   and precedences of the operators.  */
+struct ttype
+  {
+    struct stoken stoken;
+    struct type *type;
+  };
 
-struct op_print
+struct symtoken
   {
-    char *string;
-    enum exp_opcode opcode;
-    /* Precedence of operator.  These values are used only by comparisons.  */
-    enum precedence precedence;
+    struct stoken stoken;
+    struct block_symbol sym;
+    int is_a_field_of_this;
+  };
 
-    /* For a binary operator:  1 iff right associate.
-       For a unary operator:  1 iff postfix. */
-    int right_assoc;
+struct objc_class_str
+  {
+    struct stoken stoken;
+    struct type *type;
+    int theclass;
   };
 
+extern const char *find_template_name_end (const char *);
+
+extern std::string copy_name (struct stoken);
+
+extern bool parse_float (const char *p, int len,
+                        const struct type *type, gdb_byte *data);
+\f
+
 /* Function used to avoid direct calls to fprintf
    in the code generated by the bison parser.  */
 
-extern void parser_fprintf (FILE *, const char *, ...) ATTR_FORMAT (printf, 2 ,3);
+extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
+
+extern bool exp_uses_objfile (struct expression *exp, struct objfile *objfile);
 
 #endif /* PARSER_DEFS_H */
+
This page took 0.027887 seconds and 4 git commands to generate.