/* Parser definitions for GDB.
- Copyright (C) 1986-2019 Free Software Foundation, Inc.
+ Copyright (C) 1986-2023 Free Software Foundation, Inc.
Modified from expread.y by the Department of Computer Science at the
State University of New York at Buffalo.
#if !defined (PARSER_DEFS_H)
#define PARSER_DEFS_H 1
-#include "vec.h"
#include "expression.h"
+#include "symtab.h"
+#include "expop.h"
struct block;
struct language_defn;
struct internalvar;
+class innermost_block_tracker;
-extern int parser_debug;
+/* A class that can be used to build a "struct expression". */
-#define parse_gdbarch(ps) ((ps)->expout->gdbarch)
-#define parse_language(ps) ((ps)->expout->language_defn)
-
-struct parser_state
+struct expr_builder
{
- /* Constructor. INITIAL_SIZE is the initial size of the expout
- array. LANG is the language used to parse the expression. And
- GDBARCH is the gdbarch to use during parsing. */
+ /* Constructor. LANG is the language used to parse the expression.
+ And GDBARCH is the gdbarch to use during parsing. */
- parser_state (size_t initial_size, const struct language_defn *lang,
- struct gdbarch *gdbarch);
+ expr_builder (const struct language_defn *lang,
+ struct gdbarch *gdbarch)
+ : expout (new expression (lang, gdbarch))
+ {
+ }
- DISABLE_COPY_AND_ASSIGN (parser_state);
+ DISABLE_COPY_AND_ASSIGN (expr_builder);
/* Resize the allocated expression to the correct size, and return
it as an expression_up -- passing ownership to the caller. */
- expression_up release ();
+ ATTRIBUTE_UNUSED_RESULT expression_up release ()
+ {
+ return std::move (expout);
+ }
- /* The size of the expression above. */
+ /* Return the gdbarch that was passed to the constructor. */
- size_t expout_size;
+ struct gdbarch *gdbarch ()
+ {
+ return expout->gdbarch;
+ }
+
+ /* Return the language that was passed to the constructor. */
+
+ const struct language_defn *language ()
+ {
+ return expout->language_defn;
+ }
+
+ /* Set the root operation of the expression that is currently being
+ built. */
+ void set_operation (expr::operation_up &&op)
+ {
+ expout->op = std::move (op);
+ }
/* The expression related to this parser state. */
expression_up expout;
+};
- /* The number of elements already in the expression. This is used
- to know where to put new elements. */
+/* Complete an expression that references a field, like "x->y". */
- size_t expout_ptr;
-};
+struct expr_complete_structop : public expr_completion_base
+{
+ explicit expr_complete_structop (expr::structop_base_operation *op)
+ : m_op (op)
+ {
+ }
-/* If this is nonzero, this block is used as the lexical context
- for symbol names. */
+ bool complete (struct expression *exp,
+ completion_tracker &tracker) override
+ {
+ return m_op->complete (exp, tracker);
+ }
-extern const struct block *expression_context_block;
+private:
-/* 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;
+ /* 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 *m_op = nullptr;
+};
-/* While parsing expressions we need to track the innermost lexical block
- that we encounter. In some situations we need to track the innermost
- block just for symbols, and in other situations we want to track the
- innermost block for symbols and registers. These flags are used by the
- innermost block tracker to control which blocks we consider for the
- innermost block. These flags can be combined together as needed. */
+/* Complete a tag name in an expression. This is used for something
+ like "enum abc<TAB>". */
-enum innermost_block_tracker_type
+struct expr_complete_tag : public expr_completion_base
{
- /* Track the innermost block for symbols within an expression. */
- INNERMOST_BLOCK_FOR_SYMBOLS = (1 << 0),
+ expr_complete_tag (enum type_code code,
+ gdb::unique_xmalloc_ptr<char> name)
+ : m_code (code),
+ m_name (std::move (name))
+ {
+ /* Parsers should enforce this statically. */
+ gdb_assert (code == TYPE_CODE_ENUM
+ || code == TYPE_CODE_UNION
+ || code == TYPE_CODE_STRUCT);
+ }
+
+ bool complete (struct expression *exp,
+ completion_tracker &tracker) override;
+
+private:
- /* Track the innermost block for registers within an expression. */
- INNERMOST_BLOCK_FOR_REGISTERS = (1 << 1)
+ /* The kind of tag to complete. */
+ enum type_code m_code;
+
+ /* The token for tagged type name completion. */
+ gdb::unique_xmalloc_ptr<char> m_name;
};
-DEF_ENUM_FLAGS_TYPE (enum innermost_block_tracker_type,
- innermost_block_tracker_types);
-/* When parsing expressions we track the innermost block that was
- referenced. */
+/* 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. */
-class innermost_block_tracker
+struct parser_state : public expr_builder
{
-public:
- innermost_block_tracker ()
- : m_types (INNERMOST_BLOCK_FOR_SYMBOLS),
- m_innermost_block (NULL)
- { /* Nothing. */ }
-
- /* Reset the currently stored innermost block. Usually called before
- parsing a new expression. As the most common case is that we only
- want to gather the innermost block for symbols in an expression, this
- becomes the default block tracker type. */
- void reset (innermost_block_tracker_types t = INNERMOST_BLOCK_FOR_SYMBOLS)
+ /* 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,
+ parser_flags flags,
+ const char *input,
+ bool completion,
+ innermost_block_tracker *tracker)
+ : expr_builder (lang, gdbarch),
+ expression_context_block (context_block),
+ expression_context_pc (context_pc),
+ lexptr (input),
+ block_tracker (tracker),
+ comma_terminates ((flags & PARSER_COMMA_TERMINATES) != 0),
+ parse_completion (completion),
+ void_context_p ((flags & PARSER_VOID_CONTEXT) != 0),
+ debug ((flags & PARSER_DEBUG) != 0)
+ {
+ }
+
+ DISABLE_COPY_AND_ASSIGN (parser_state);
+
+ /* Begin counting arguments for a function call,
+ saving the data about any containing call. */
+
+ void start_arglist ()
+ {
+ 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. */
+
+ int end_arglist ()
+ {
+ 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);
+
+ /* Mark for completion, using an arbitrary completer. */
+
+ void mark_completion (std::unique_ptr<expr_completion_base> completer)
+ {
+ gdb_assert (m_completion_state == nullptr);
+ m_completion_state = std::move (completer);
+ }
+
+ /* Push an operation on the stack. */
+ void push (expr::operation_up &&op)
+ {
+ m_operations.push_back (std::move (op));
+ }
+
+ /* 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)...));
+ }
+
+ /* Push a new C string operation. */
+ void push_c_string (int, struct stoken_vector *vec);
+
+ /* Push a symbol reference. If SYM is nullptr, look for a minimal
+ symbol. */
+ void push_symbol (const char *name, block_symbol sym);
+
+ /* Push a reference to $mumble. This may result in a convenience
+ variable, a history reference, or a register. */
+ void push_dollar (struct stoken str);
+
+ /* Pop an operation from the stack. */
+ expr::operation_up pop ()
{
- m_types = t;
- m_innermost_block = NULL;
+ expr::operation_up result = std::move (m_operations.back ());
+ m_operations.pop_back ();
+ return result;
}
- /* 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);
+ /* 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;
+ }
- /* Overload of main UPDATE method which extracts the block from BS. */
- void update (const struct block_symbol &bs)
+ /* A helper that pops an operation, wraps it in some other
+ operation, and pushes it again. */
+ template<typename T>
+ void wrap ()
{
- update (bs.block, INNERMOST_BLOCK_FOR_SYMBOLS);
+ using namespace expr;
+ operation_up v = ::expr::make_operation<T> (pop ());
+ push (std::move (v));
}
- /* 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
+ /* A helper that pops two operations, wraps them in some other
+ operation, and pushes the result. */
+ template<typename T>
+ void wrap2 ()
{
- return m_innermost_block;
+ expr::operation_up rhs = pop ();
+ expr::operation_up lhs = pop ();
+ push (expr::make_operation<T> (std::move (lhs), std::move (rhs)));
}
+ /* If this is nonzero, this block is used as the lexical context for
+ symbol names. */
+
+ const struct block * const expression_context_block;
+
+ /* 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;
+
+ /* During parsing of a C expression, the pointer to the next character
+ is in this variable. */
+
+ const char *lexptr;
+
+ /* After a token has been recognized, this variable points to it.
+ Currently used only for error reporting. */
+ const char *prev_lexptr = nullptr;
+
+ /* Number of arguments seen so far in innermost function call. */
+
+ int arglist_len = 0;
+
+ /* Completion state is updated here. */
+ std::unique_ptr<expr_completion_base> m_completion_state;
+
+ /* The innermost block tracker. */
+ innermost_block_tracker *block_tracker;
+
+ /* Nonzero means stop parsing on first comma (if not within parentheses). */
+ bool comma_terminates;
+
+ /* True if parsing an expression to attempt completion. */
+ bool parse_completion;
+
+ /* True if no value is expected from the expression. */
+ bool void_context_p;
+
+ /* True if parser debugging should be enabled. */
+ bool debug;
+
private:
- /* The type of innermost block being looked for. */
- innermost_block_tracker_types m_types;
- /* The currently stored innermost block found while parsing an
- expression. */
- const struct block *m_innermost_block;
-};
+ /* Data structure for saving values of arglist_len for function calls whose
+ arguments contain other function calls. */
-/* The innermost context required by the stack and register variables
- we've encountered so far. This should be cleared before parsing an
- expression, and queried once the parse is complete. */
-extern innermost_block_tracker innermost_block;
+ std::vector<int> m_funcall_chain;
-/* Number of arguments seen so far in innermost function call. */
-extern int arglist_len;
+ /* Stack of operations. */
+ std::vector<expr::operation_up> m_operations;
+};
/* A string token, either a char-string or bit-string. Char-strings are
used, for example, for the names of symbols. */
int theclass;
};
-typedef struct type *type_ptr;
-DEF_VEC_P (type_ptr);
-
-/* For parsing of complicated types.
- An array should be preceded in the list by the size of the array. */
-enum type_pieces
- {
- tp_end = -1,
- tp_pointer,
- tp_reference,
- tp_rvalue_reference,
- tp_array,
- tp_function,
- tp_function_with_arguments,
- tp_const,
- tp_volatile,
- tp_space_identifier,
- tp_type_stack
- };
-/* The stack can contain either an enum type_pieces or an int. */
-union type_stack_elt
- {
- enum type_pieces piece;
- int int_val;
- struct type_stack *stack_val;
- VEC (type_ptr) *typelist_val;
- };
-
-/* The type stack is an instance of this structure. */
-
-struct type_stack
-{
- /* Elements on the stack. */
- std::vector<union type_stack_elt> elements;
-};
-
-/* Reverse an expression from suffix form (in which it is constructed)
- to prefix form (in which we can conveniently print or execute it).
- Ordinarily this always returns -1. However, if EXPOUT_LAST_STRUCT
- is not -1 (i.e., we are trying to complete a field name), it will
- return the index of the subexpression which is the left-hand-side
- of the struct operation at EXPOUT_LAST_STRUCT. */
-
-extern int prefixify_expression (struct expression *expr);
-
-extern void write_exp_elt_opcode (struct parser_state *, enum exp_opcode);
-
-extern void write_exp_elt_sym (struct parser_state *, struct symbol *);
-
-extern void write_exp_elt_longcst (struct parser_state *, LONGEST);
-
-extern void write_exp_elt_floatcst (struct parser_state *, const gdb_byte *);
-
-extern void write_exp_elt_type (struct parser_state *, struct type *);
-
-extern void write_exp_elt_intern (struct parser_state *, struct internalvar *);
-
-extern void write_exp_string (struct parser_state *, struct stoken);
-
-void write_exp_string_vector (struct parser_state *, int type,
- struct stoken_vector *vec);
-
-extern void write_exp_bitstring (struct parser_state *, struct stoken);
-
-extern void write_exp_elt_block (struct parser_state *, const struct block *);
-
-extern void write_exp_elt_objfile (struct parser_state *,
- struct objfile *objfile);
-
-extern void write_exp_msymbol (struct parser_state *,
- struct bound_minimal_symbol);
-
-extern void write_dollar_variable (struct parser_state *, struct stoken str);
-
-extern void mark_struct_expression (struct parser_state *);
-
extern const char *find_template_name_end (const char *);
-extern void start_arglist (void);
-
-extern int end_arglist (void);
-
-extern char *copy_name (struct stoken);
-
-extern void insert_type (enum type_pieces);
-
-extern void push_type (enum type_pieces);
-
-extern void push_type_int (int);
-
-extern void insert_type_address_space (struct parser_state *, char *);
-
-extern enum type_pieces pop_type (void);
-
-extern int pop_type_int (void);
-
-extern struct type_stack *get_type_stack (void);
-
-extern struct type_stack *append_type_stack (struct type_stack *to,
- struct type_stack *from);
-
-extern void push_type_stack (struct type_stack *stack);
-
-extern void type_stack_cleanup (void *arg);
-
-extern void push_typelist (VEC (type_ptr) *typelist);
-
-extern int dump_subexp (struct expression *, struct ui_file *, int);
-
-extern int dump_subexp_body_standard (struct expression *,
- struct ui_file *, int);
-
-extern void operator_length (const struct expression *, int, int *, int *);
-
-extern void operator_length_standard (const struct expression *, int, int *,
- int *);
-
-extern int operator_check_standard (struct expression *exp, int pos,
- int (*objfile_func)
- (struct objfile *objfile, void *data),
- void *data);
-
-extern const char *op_name_standard (enum exp_opcode);
-
-extern struct type *follow_types (struct type *);
-
-extern type_instance_flags follow_type_instance_flags ();
-
-extern void null_post_parser (expression_up *, int);
+extern std::string copy_name (struct stoken);
extern bool parse_float (const char *p, int len,
const struct type *type, gdb_byte *data);
-
-/* During parsing of a C expression, the pointer to the next character
- is in this variable. */
-
-extern const char *lexptr;
-
-/* After a token has been recognized, this variable points to it.
- Currently used only for error reporting. */
-extern const char *prev_lexptr;
-
-/* Current depth in parentheses within the expression. */
-
-extern int paren_depth;
-
-/* Nonzero means stop parsing on first comma (if not within parentheses). */
-
-extern int comma_terminates;
+extern bool fits_in_type (int n_sign, ULONGEST n, int type_bits,
+ bool type_signed_p);
+extern bool fits_in_type (int n_sign, const gdb_mpz &n, int type_bits,
+ bool type_signed_p);
\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
- };
-
-/* Table mapping opcodes into strings for printing operators
- and precedences of the operators. */
-
-struct op_print
- {
- const char *string;
- enum exp_opcode opcode;
- /* Precedence of operator. These values are used only by comparisons. */
- enum precedence precedence;
-
- /* For a binary operator: 1 iff right associate.
- For a unary operator: 1 iff postfix. */
- int right_assoc;
- };
-
-/* Information needed to print, prefixify, and evaluate expressions for
- a given language. */
-
-struct exp_descriptor
- {
- /* Print subexpression. */
- void (*print_subexp) (struct expression *, int *, struct ui_file *,
- enum precedence);
-
- /* Returns number of exp_elements needed to represent an operator and
- the number of subexpressions it takes. */
- void (*operator_length) (const struct expression*, int, int*, int *);
-
- /* Call OBJFILE_FUNC for any objfile found being referenced by the
- single operator of EXP at position POS. Operator parameters are
- located at positive (POS + number) offsets in EXP. OBJFILE_FUNC
- should never be called with NULL OBJFILE. OBJFILE_FUNC should
- get passed an arbitrary caller supplied DATA pointer. If it
- returns non-zero value then (any other) non-zero value should be
- immediately returned to the caller. Otherwise zero should be
- returned. */
- int (*operator_check) (struct expression *exp, int pos,
- int (*objfile_func) (struct objfile *objfile,
- void *data),
- void *data);
-
- /* Name of this operator for dumping purposes.
- The returned value should never be NULL, even if EXP_OPCODE is
- an unknown opcode (a string containing an image of the numeric
- value of the opcode can be returned, for instance). */
- const char *(*op_name) (enum exp_opcode);
-
- /* Dump the rest of this (prefix) expression after the operator
- itself has been printed. See dump_subexp_body_standard in
- (expprint.c). */
- int (*dump_subexp_body) (struct expression *, struct ui_file *, int);
-
- /* Evaluate an expression. */
- struct value *(*evaluate_exp) (struct type *, struct expression *,
- int *, enum noside);
- };
-
-
-/* Default descriptor containing standard definitions of all
- elements. */
-extern const struct exp_descriptor exp_descriptor_standard;
-
-/* Functions used by language-specific extended operators to (recursively)
- print/dump subexpressions. */
-
-extern void print_subexp (struct expression *, int *, struct ui_file *,
- enum precedence);
-
-extern void print_subexp_standard (struct expression *, int *,
- struct ui_file *, enum precedence);
/* Function used to avoid direct calls to fprintf
in the code generated by the bison parser. */
extern void parser_fprintf (FILE *, const char *, ...) ATTRIBUTE_PRINTF (2, 3);
-extern int exp_uses_objfile (struct expression *exp, struct objfile *objfile);
-
-extern void mark_completion_tag (enum type_code, const char *ptr,
- int length);
-
-/* Reallocate the `expout' pointer inside PS so that it can accommodate
- at least LENELT expression elements. This function does nothing if
- there is enough room for the elements. */
-
-extern void increase_expout_size (struct parser_state *ps, size_t lenelt);
-
#endif /* PARSER_DEFS_H */