/* Parser definitions for GDB.
- Copyright (C) 1986, 1989-2000, 2002, 2007-2012 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 "doublest.h"
-#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". */
-extern struct expression *expout;
-extern int expout_size;
-extern int expout_ptr;
-
-#define parse_gdbarch (expout->gdbarch)
-#define parse_language (expout->language_defn)
-
-/* If this is nonzero, this block is used as the lexical context
- for symbol names. */
-
-extern const struct block *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. */
-extern CORE_ADDR expression_context_pc;
-
-/* The innermost context required by the stack and register variables
- we've encountered so far. */
-extern const struct block *innermost_block;
-
-/* 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 const struct block *block_found;
-
-/* Number of arguments seen so far in innermost function call. */
-extern int arglist_len;
-
-/* A string token, either a char-string or bit-string. Char-strings are
- used, for example, for the names of symbols. */
-
-struct stoken
- {
- /* 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;
- };
+struct expr_builder
+{
+ /* Constructor. LANG is the language used to parse the expression.
+ And GDBARCH is the gdbarch to use during parsing. */
-struct typed_stoken
+ expr_builder (const struct language_defn *lang,
+ struct gdbarch *gdbarch)
+ : expout (new expression (lang, gdbarch))
{
- /* 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;
- };
+ }
-struct stoken_vector
- {
- int len;
- struct typed_stoken *tokens;
- };
+ DISABLE_COPY_AND_ASSIGN (expr_builder);
-struct ttype
+ /* 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 ()
{
- struct stoken stoken;
- struct type *type;
- };
+ return std::move (expout);
+ }
-struct symtoken
- {
- struct stoken stoken;
- struct symbol *sym;
- int is_a_field_of_this;
- };
+ /* Return the gdbarch that was passed to the constructor. */
-struct objc_class_str
+ struct gdbarch *gdbarch ()
{
- struct stoken stoken;
- struct type *type;
- int class;
- };
+ return expout->gdbarch;
+ }
-typedef struct type *type_ptr;
-DEF_VEC_P (type_ptr);
+ /* Return the language that was passed to the constructor. */
-/* For parsing of complicated types.
- An array should be preceded in the list by the size of the array. */
-enum type_pieces
+ const struct language_defn *language ()
{
- tp_end = -1,
- tp_pointer,
- tp_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
+ return expout->language_defn;
+ }
+
+ /* Set the root operation of the expression that is currently being
+ built. */
+ void set_operation (expr::operation_up &&op)
{
- enum type_pieces piece;
- int int_val;
- struct type_stack *stack_val;
- VEC (type_ptr) *typelist_val;
- };
+ expout->op = std::move (op);
+ }
-/* The type stack is an instance of this structure. */
+ /* The expression related to this parser state. */
-struct type_stack
-{
- /* Elements on the stack. */
- union type_stack_elt *elements;
- /* Current stack depth. */
- int depth;
- /* Allocated size of stack. */
- int size;
+ expression_up expout;
};
-/* Helper function to initialize the expout, expout_size, expout_ptr
- trio before it is used to store expression elements created during
- the parsing of an expression. 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. */
-
-extern void initialize_expout (int, const struct language_defn *,
- struct gdbarch *);
-
-/* Helper function that frees any unsed space in the expout array.
- It is generally used when the parser has just been parsed and
- created. */
+/* Complete an expression that references a field, like "x->y". */
-extern void reallocate_expout (void);
-
-/* 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. */
+struct expr_complete_structop : public expr_completion_base
+{
+ explicit expr_complete_structop (expr::structop_base_operation *op)
+ : m_op (op)
+ {
+ }
-extern int prefixify_expression (struct expression *expr);
+ bool complete (struct expression *exp,
+ completion_tracker &tracker) override
+ {
+ return m_op->complete (exp, tracker);
+ }
-extern void write_exp_elt_opcode (enum exp_opcode);
+private:
-extern void write_exp_elt_sym (struct symbol *);
+ /* 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;
+};
-extern void write_exp_elt_longcst (LONGEST);
+/* Complete a tag name in an expression. This is used for something
+ like "enum abc<TAB>". */
-extern void write_exp_elt_dblcst (DOUBLEST);
+struct expr_complete_tag : public expr_completion_base
+{
+ 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);
+ }
-extern void write_exp_elt_decfloatcst (gdb_byte *);
+ bool complete (struct expression *exp,
+ completion_tracker &tracker) override;
-extern void write_exp_elt_type (struct type *);
+private:
-extern void write_exp_elt_intern (struct internalvar *);
+ /* The kind of tag to complete. */
+ enum type_code m_code;
-extern void write_exp_string (struct stoken);
+ /* The token for tagged type name completion. */
+ gdb::unique_xmalloc_ptr<char> m_name;
+};
-void write_exp_string_vector (int type, struct stoken_vector *vec);
+/* 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. */
-extern void write_exp_bitstring (struct stoken);
+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,
+ 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)
+ {
+ }
-extern void write_exp_elt_block (const struct block *);
+ DISABLE_COPY_AND_ASSIGN (parser_state);
-extern void write_exp_elt_objfile (struct objfile *objfile);
+ /* Begin counting arguments for a function call,
+ saving the data about any containing call. */
-extern void write_exp_msymbol (struct minimal_symbol *);
+ void start_arglist ()
+ {
+ m_funcall_chain.push_back (arglist_len);
+ arglist_len = 0;
+ }
-extern void write_dollar_variable (struct stoken str);
+ /* Return the number of arguments in a function call just terminated,
+ and restore the data for the containing function call. */
-extern void mark_struct_expression (void);
+ int end_arglist ()
+ {
+ int val = arglist_len;
+ arglist_len = m_funcall_chain.back ();
+ m_funcall_chain.pop_back ();
+ return val;
+ }
-extern char *find_template_name_end (char *);
+ /* Mark the given operation as the starting location of a structure
+ expression. This is used when completing on field names. */
-extern void start_arglist (void);
+ void mark_struct_expression (expr::structop_base_operation *op);
-extern int end_arglist (void);
+ /* 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. */
-extern char *copy_name (struct stoken);
+ void mark_completion_tag (enum type_code tag, const char *ptr, int length);
-extern void insert_type (enum type_pieces);
+ /* Mark for completion, using an arbitrary completer. */
-extern void push_type (enum type_pieces);
+ void mark_completion (std::unique_ptr<expr_completion_base> completer)
+ {
+ gdb_assert (m_completion_state == nullptr);
+ m_completion_state = std::move (completer);
+ }
-extern void push_type_int (int);
+ /* Push an operation on the stack. */
+ void push (expr::operation_up &&op)
+ {
+ m_operations.push_back (std::move (op));
+ }
-extern void insert_type_address_space (char *);
+ /* 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 enum type_pieces pop_type (void);
+ /* Push a new C string operation. */
+ void push_c_string (int, struct stoken_vector *vec);
-extern int pop_type_int (void);
+ /* Push a symbol reference. If SYM is nullptr, look for a minimal
+ symbol. */
+ void push_symbol (const char *name, block_symbol sym);
-extern struct type_stack *get_type_stack (void);
+ /* 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 struct type_stack *append_type_stack (struct type_stack *to,
- struct type_stack *from);
+ /* 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 push_type_stack (struct type_stack *stack);
+ /* 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 type_stack_cleanup (void *arg);
+ /* If this is nonzero, this block is used as the lexical context for
+ symbol names. */
-extern void push_typelist (VEC (type_ptr) *typelist);
+ const struct block * const expression_context_block;
-extern int length_of_subexp (struct expression *, int);
+ /* 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 int dump_subexp (struct expression *, struct ui_file *, int);
+ /* During parsing of a C expression, the pointer to the next character
+ is in this variable. */
-extern int dump_subexp_body_standard (struct expression *,
- struct ui_file *, int);
+ const char *lexptr;
-extern void operator_length (const struct expression *, int, int *, int *);
+ /* After a token has been recognized, this variable points to it.
+ Currently used only for error reporting. */
+ const char *prev_lexptr = nullptr;
-extern void operator_length_standard (const struct expression *, int, int *,
- int *);
+ /* Number of arguments seen so far in innermost function call. */
-extern int operator_check_standard (struct expression *exp, int pos,
- int (*objfile_func)
- (struct objfile *objfile, void *data),
- void *data);
+ int arglist_len = 0;
-extern char *op_name_standard (enum exp_opcode);
+ /* Completion state is updated here. */
+ std::unique_ptr<expr_completion_base> m_completion_state;
-extern struct type *follow_types (struct type *);
+ /* The innermost block tracker. */
+ innermost_block_tracker *block_tracker;
-extern void null_post_parser (struct expression **, int);
+ /* Nonzero means stop parsing on first comma (if not within parentheses). */
+ bool comma_terminates;
-extern int parse_float (const char *p, int len, DOUBLEST *d,
- const char **suffix);
+ /* True if parsing an expression to attempt completion. */
+ bool parse_completion;
-extern int parse_c_float (struct gdbarch *gdbarch, const char *p, int len,
- DOUBLEST *d, struct type **t);
+ /* True if no value is expected from the expression. */
+ bool void_context_p;
-/* During parsing of a C expression, the pointer to the next character
- is in this variable. */
+ /* True if parser debugging should be enabled. */
+ bool debug;
-extern char *lexptr;
+private:
-/* After a token has been recognized, this variable points to it.
- Currently used only for error reporting. */
-extern char *prev_lexptr;
+ /* Data structure for saving values of arglist_len for function calls whose
+ arguments contain other function calls. */
-/* Current depth in parentheses within the expression. */
+ std::vector<int> m_funcall_chain;
-extern int paren_depth;
+ /* Stack of operations. */
+ std::vector<expr::operation_up> m_operations;
+};
-/* Nonzero means stop parsing on first comma (if not within parentheses). */
+/* A string token, either a char-string or bit-string. Char-strings are
+ used, for example, for the names of symbols. */
-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
+struct stoken
{
- 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
+ /* 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;
};
-/* Table mapping opcodes into strings for printing operators
- and precedences of the operators. */
-
-struct op_print
+struct typed_stoken
{
- 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;
+ /* 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;
};
-/* Information needed to print, prefixify, and evaluate expressions for
- a given language. */
+struct stoken_vector
+ {
+ int len;
+ struct typed_stoken *tokens;
+ };
-struct exp_descriptor
+struct ttype
{
- /* 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 TYPE_FUNC and OBJFILE_FUNC for any TYPE and OBJFILE found being
- referenced by the single operator of EXP at position POS. Operator
- parameters are located at positive (POS + number) offsets in EXP.
- The functions should never be called with NULL TYPE or NULL OBJFILE.
- Functions should get passed an arbitrary caller supplied DATA pointer.
- If any of the functions 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). */
- 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);
+ struct stoken stoken;
+ struct type *type;
};
+struct symtoken
+ {
+ struct stoken stoken;
+ struct block_symbol sym;
+ int is_a_field_of_this;
+ };
-/* Default descriptor containing standard definitions of all
- elements. */
-extern const struct exp_descriptor exp_descriptor_standard;
+struct objc_class_str
+ {
+ struct stoken stoken;
+ struct type *type;
+ int theclass;
+ };
-/* Functions used by language-specific extended operators to (recursively)
- print/dump subexpressions. */
+extern const char *find_template_name_end (const char *);
-extern void print_subexp (struct expression *, int *, struct ui_file *,
- enum precedence);
+extern std::string copy_name (struct stoken);
-extern void print_subexp_standard (struct expression *, int *,
- struct ui_file *, enum precedence);
+extern bool parse_float (const char *p, int len,
+ const struct type *type, gdb_byte *data);
+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
/* 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);
-
#endif /* PARSER_DEFS_H */
+