Mercurial > octave
view libinterp/parse-tree/parse.h @ 28267:4ee43852f5b6
maint: merge stable to default.
author | John W. Eaton <jwe@octave.org> |
---|---|
date | Wed, 06 May 2020 13:34:22 -0400 |
parents | 376ca9022b7e ce7a5b60e102 |
children | c74a48d9b8ee |
line wrap: on
line source
//////////////////////////////////////////////////////////////////////// // // Copyright (C) 1993-2020 The Octave Project Developers // // See the file COPYRIGHT.md in the top-level directory of this // distribution or <https://octave.org/copyright/>. // // This file is part of Octave. // // Octave 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 3 of the License, or // (at your option) any later version. // // Octave is distributed in the hope that it will be useful, but // WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Octave; see the file COPYING. If not, see // <https://www.gnu.org/licenses/>. // //////////////////////////////////////////////////////////////////////// #if ! defined (octave_parse_h) #define octave_parse_h 1 #include "octave-config.h" #include <cstdio> #include <deque> #include <map> #include <memory> #include <set> #include <string> #include "input.h" #include "lex.h" #include "pt-misc.h" #include "symscope.h" #include "token.h" class octave_function; class octave_user_function; namespace octave { class comment_list; class tree; class tree_anon_fcn_handle; class tree_argument_list; class tree_array_list; class tree_cell; class tree_classdef; class tree_classdef_attribute_list; class tree_classdef_body; class tree_classdef_enum_block; class tree_classdef_enum_list; class tree_classdef_events_block; class tree_classdef_events_list; class tree_classdef_methods_block; class tree_classdef_methods_list; class tree_classdef_properties_block; class tree_classdef_property_list; class tree_classdef_superclass_list; class tree_colon_expression; class tree_command; class tree_constant; class tree_decl_command; class tree_decl_init_list; class tree_expression; class tree_fcn_handle; class tree_function_def; class tree_identifier; class tree_if_clause; class tree_if_command; class tree_if_command_list; class tree_index_expression; class tree_matrix; class tree_matrix; class tree_parameter_list; class tree_statement; class tree_statement_list; class tree_statement_listtree_statement; class tree_switch_case; class tree_switch_case_list; class tree_switch_command; } #include "ovl.h" // Nonzero means print parser debugging info (-d). extern int octave_debug; namespace octave { class base_parser { private: class parent_scope_info { public: typedef std::pair<symbol_scope, std::string> value_type; typedef std::deque<value_type>::iterator iterator; typedef std::deque<value_type>::const_iterator const_iterator; typedef std::deque<value_type>::reverse_iterator reverse_iterator; typedef std::deque<value_type>::const_reverse_iterator const_reverse_iterator; parent_scope_info (void) = default; parent_scope_info (const parent_scope_info&) = default; parent_scope_info& operator = (const parent_scope_info&) = default; ~parent_scope_info (void) = default; size_t size (void) const; void push (const value_type& elt); void push (const symbol_scope& id); void pop (void); bool name_ok (const std::string& name); bool name_current_scope (const std::string& name); symbol_scope parent_scope (void) const; std::string parent_name (void) const; void clear (void); private: std::deque<value_type> m_info; std::set<std::string> m_all_names; }; public: base_parser (base_lexer& lxr); // No copying! base_parser (const base_parser&) = delete; base_parser& operator = (const base_parser&) = delete; ~base_parser (void); base_lexer& get_lexer (void) const { return m_lexer; } bool at_end_of_input (void) const { return m_lexer.m_end_of_input; } void reset (void); void classdef_object (const std::shared_ptr<tree_classdef>& obj) { m_classdef_object = obj; } std::shared_ptr<tree_classdef> classdef_object (void) const { return m_classdef_object; } void statement_list (const std::shared_ptr<tree_statement_list>& lst) { m_stmt_list = lst; } std::shared_ptr<tree_statement_list> statement_list (void) const { return m_stmt_list; } void parsing_local_functions (bool flag) { m_parsing_local_functions = flag; } bool parsing_local_functions (void) const { return m_parsing_local_functions; } void endfunction_found (bool flag) { m_endfunction_found = flag; } bool endfunction_found (void) const { return m_endfunction_found; } // Error messages for mismatched end tokens. void end_token_error (token *tok, token::end_tok_type expected); // Check to see that end tokens are properly matched. bool end_token_ok (token *tok, token::end_tok_type expected); // Handle pushing symbol table for new function scope. bool push_fcn_symtab (void); // Build a constant. tree_constant * make_constant (int op, token *tok_val); // Build a function handle. tree_fcn_handle * make_fcn_handle (token *tok_val); // Build an anonymous function handle. tree_anon_fcn_handle * make_anon_fcn_handle (tree_parameter_list *param_list, tree_expression * expr, const filepos& at_pos); // Build a colon expression. tree_expression * make_colon_expression (tree_expression *base, tree_expression *limit, tree_expression *incr = nullptr); // Build a binary expression. tree_expression * make_binary_op (int op, tree_expression *op1, token *tok_val, tree_expression *op2); // Build a boolean expression. tree_expression * make_boolean_op (int op, tree_expression *op1, token *tok_val, tree_expression *op2); // Build a prefix expression. tree_expression * make_prefix_op (int op, tree_expression *op1, token *tok_val); // Build a postfix expression. tree_expression * make_postfix_op (int op, tree_expression *op1, token *tok_val); // Build an unwind-protect command. tree_command * make_unwind_command (token *unwind_tok, tree_statement_list *body, tree_statement_list *cleanup, token *end_tok, comment_list *lc, comment_list *mc); // Build a try-catch command. tree_command * make_try_command (token *try_tok, tree_statement_list *body, char catch_sep, tree_statement_list *cleanup, token *end_tok, comment_list *lc, comment_list *mc); // Build a while command. tree_command * make_while_command (token *while_tok, tree_expression *expr, tree_statement_list *body, token *end_tok, comment_list *lc); // Build a do-until command. tree_command * make_do_until_command (token *until_tok, tree_statement_list *body, tree_expression *expr, comment_list *lc); // Build a for command. tree_command * make_for_command (int tok_id, token *for_tok, tree_argument_list *lhs, tree_expression *expr, tree_expression *maxproc, tree_statement_list *body, token *end_tok, comment_list *lc); // Build a break command. tree_command * make_break_command (token *break_tok); // Build a continue command. tree_command * make_continue_command (token *continue_tok); // Build a return command. tree_command * make_return_command (token *return_tok); // Start an if command. tree_if_command_list * start_if_command (tree_expression *expr, tree_statement_list *list); // Finish an if command. tree_if_command * finish_if_command (token *if_tok, tree_if_command_list *list, token *end_tok, comment_list *lc); // Build an elseif clause. tree_if_clause * make_elseif_clause (token *elseif_tok, tree_expression *expr, tree_statement_list *list, comment_list *lc); // Finish a switch command. tree_switch_command * finish_switch_command (token *switch_tok, tree_expression *expr, tree_switch_case_list *list, token *end_tok, comment_list *lc); // Build a switch case. tree_switch_case * make_switch_case (token *case_tok, tree_expression *expr, tree_statement_list *list, comment_list *lc); // Build an assignment to a variable. tree_expression * make_assign_op (int op, tree_argument_list *lhs, token *eq_tok, tree_expression *rhs); // Define a script. void make_script (tree_statement_list *cmds, tree_statement *end_script); // Handle identifier that is recognized as a function name. tree_identifier * make_fcn_name (tree_identifier *id); // Define a function. tree_function_def * make_function (token *fcn_tok, tree_parameter_list *ret_list, tree_identifier *id, tree_parameter_list *param_list, tree_statement_list *body, tree_statement *end_fcn_stmt, comment_list *lc); // Begin defining a function. octave_user_function * start_function (tree_identifier *id, tree_parameter_list *param_list, tree_statement_list *body, tree_statement *end_function); // Create a no-op statement for end_function. tree_statement * make_end (const std::string& type, bool eof, const filepos& beg_pos, const filepos& end_pos); // Do most of the work for defining a function. octave_user_function * frob_function (tree_identifier *id, octave_user_function *fcn); // Finish defining a function. tree_function_def * finish_function (tree_parameter_list *ret_list, octave_user_function *fcn, comment_list *lc, int l, int c); // Reset state after parsing function. void recover_from_parsing_function (void); tree_classdef * make_classdef (token *tok_val, tree_classdef_attribute_list *a, tree_identifier *id, tree_classdef_superclass_list *sc, tree_classdef_body *body, token *end_tok, comment_list *lc); tree_classdef_properties_block * make_classdef_properties_block (token *tok_val, tree_classdef_attribute_list *a, tree_classdef_property_list *plist, token *end_tok, comment_list *lc); tree_classdef_methods_block * make_classdef_methods_block (token *tok_val, tree_classdef_attribute_list *a, tree_classdef_methods_list *mlist, token *end_tok, comment_list *lc); tree_classdef_events_block * make_classdef_events_block (token *tok_val, tree_classdef_attribute_list *a, tree_classdef_events_list *elist, token *end_tok, comment_list *lc); tree_classdef_enum_block * make_classdef_enum_block (token *tok_val, tree_classdef_attribute_list *a, tree_classdef_enum_list *elist, token *end_tok, comment_list *lc); octave_user_function * start_classdef_external_method (tree_identifier *id, tree_parameter_list *pl); tree_function_def * finish_classdef_external_method (octave_user_function *fcn, tree_parameter_list *ret_list, comment_list *cl); void finish_classdef_file (tree_classdef *cls, tree_statement_list *local_fcns); // Make an index expression. tree_index_expression * make_index_expression (tree_expression *expr, tree_argument_list *args, char type); // Make an indirect reference expression. tree_index_expression * make_indirect_ref (tree_expression *expr, const std::string&); // Make an indirect reference expression with dynamic field name. tree_index_expression * make_indirect_ref (tree_expression *expr, tree_expression *field); // Make a declaration command. tree_decl_command * make_decl_command (int tok, token *tok_val, tree_decl_init_list *lst); // Validate an function parameter list. bool validate_param_list (tree_parameter_list *lst, tree_parameter_list::in_or_out type); // Validate matrix or cell bool validate_array_list (tree_expression *e); // Validate matrix object used in "[lhs] = ..." assignments. tree_argument_list * validate_matrix_for_assignment (tree_expression *e); // Finish building an array_list (common action for finish_matrix // and finish_cell). tree_expression * finish_array_list (tree_array_list *a, token *open_delim, token *close_delim); // Finish building a matrix list. tree_expression * finish_matrix (tree_matrix *m, token *open_delim, token *close_delim); // Finish building a cell list. tree_expression * finish_cell (tree_cell *c, token *open_delim, token *close_delim); // Set the print flag for a statement based on the separator type. tree_statement_list * set_stmt_print_flag (tree_statement_list *, char, bool); // Finish building a statement. template <typename T> tree_statement * make_statement (T *arg); // Create a statement list. tree_statement_list * make_statement_list (tree_statement *stmt); // Append a statement to an existing statement list. tree_statement_list * append_statement_list (tree_statement_list *list, char sep, tree_statement *stmt, bool warn_missing_semi); // Don't allow parsing command syntax. If the parser/lexer is // reset, this setting is also reset to the default (allow command // syntax). void disallow_command_syntax (void); // Generic error messages. void bison_error (const std::string& s); void bison_error (const std::string& s, const filepos& pos); void bison_error (const std::string& s, int line, int column); friend octave_value parse_fcn_file (interpreter& interp, const std::string& full_file, const std::string& file, const std::string& dir_name, const std::string& dispatch_type, const std::string& package_name, bool require_file, bool force_script, bool autoload, bool relative_lookup); // Thih interface allows push or pull parsers to be used // equivalently, provided that the push parser also owns its input // method (see below). Alternatively, the push parser interface may // use a separate run method and completely separate input from // lexical analysis and parsing. virtual int run (void) = 0; protected: // Contains error message if Bison-generated parser returns non-zero // status. std::string m_parse_error_msg; // Have we found an explicit end to a function? bool m_endfunction_found; // TRUE means we are in the process of autoloading a function. bool m_autoloading; // TRUE means the current function file was found in a relative path // element. bool m_fcn_file_from_relative_lookup; // FALSE if we are still at the primary function. Subfunctions can // only be declared inside function files. bool m_parsing_subfunctions; // TRUE if we are parsing local functions defined at after a // classdef block. Local functions can only be declared inside // classdef files. bool m_parsing_local_functions; // Maximum function depth detected. Used to determine whether // we have nested functions or just implicitly ended subfunctions. int m_max_fcn_depth; // = 0 currently outside any function. // = 1 inside the primary function or a subfunction. // > 1 means we are looking at a function definition that seems to be // inside a function. Note that the function still might not be a // nested function. int m_curr_fcn_depth; // Scope where we install all subfunctions and nested functions. Only // used while reading function files. symbol_scope m_primary_fcn_scope; // Name of the current class when we are parsing class methods or // constructors. std::string m_curr_class_name; // Name of the current package when we are parsing an element contained // in a package directory (+-directory). std::string m_curr_package_name; // Nested function scopes and names currently being parsed. parent_scope_info m_function_scopes; // Pointer to the primary user function or user script function. octave_value m_primary_fcn; // List of subfunction names, initially in the order they are // installed in the symbol table, then ordered as they appear in the // file. Eventually stashed in the primary function object. std::list<std::string> m_subfunction_names; // Pointer to the classdef object we just parsed, if any. std::shared_ptr<tree_classdef> m_classdef_object; // Result of parsing input. std::shared_ptr <tree_statement_list> m_stmt_list; // State of the lexer. base_lexer& m_lexer; // Internal state of the Bison parser. void *m_parser_state; private: // Maybe print a warning if an assignment expression is used as the // test in a logical expression. void maybe_warn_assign_as_truth_value (tree_expression *expr); // Maybe print a warning about switch labels that aren't constants. void maybe_warn_variable_switch_label (tree_expression *expr); // Maybe print a warning. void maybe_warn_missing_semi (tree_statement_list *); }; // Publish externally used friend functions. extern OCTAVE_API octave_value parse_fcn_file (interpreter& interp, const std::string& full_file, const std::string& file, const std::string& dir_name, const std::string& dispatch_type, const std::string& package_name, bool require_file, bool force_script, bool autoload, bool relative_lookup); class parser : public base_parser { public: parser (interpreter& interp) : base_parser (*(new lexer (interp))) { } parser (FILE *file, interpreter& interp) : base_parser (*(new lexer (file, interp))) { } parser (const std::string& eval_string, interpreter& interp) : base_parser (*(new lexer (eval_string, interp))) { } // The lexer must be allocated with new. The parser object // takes ownership of and deletes the lexer object in its // destructor. parser (lexer *lxr) : base_parser (*lxr) { } // No copying! parser (const parser&) = delete; parser& operator = (const parser&) = delete; ~parser (void) = default; int run (void); }; class push_parser : public base_parser { public: push_parser (interpreter& interp) : base_parser (*(new push_lexer (interp))), m_interpreter (interp), m_reader () { } // The parser assumes ownership of READER, which must be created // with new. push_parser (interpreter& interp, input_reader *reader) : base_parser (*(new push_lexer (interp))), m_interpreter (interp), m_reader (reader) { } // No copying! push_parser (const push_parser&) = delete; push_parser& operator = (const push_parser&) = delete; ~push_parser (void) = default; // Use the push parser in the same way as the pull parser. The // parser arranges for input through the M_READER object. See, for // example, interpreter::main_loop. int run (void); // Parse INPUT. M_READER is not used. The user is responsible for // collecting input. int run (const std::string& input, bool eof); private: interpreter& m_interpreter; std::shared_ptr<input_reader> m_reader; }; extern OCTINTERP_API std::string get_help_from_file (const std::string& nm, bool& symbol_found, std::string& file); extern OCTINTERP_API std::string get_help_from_file (const std::string& nm, bool& symbol_found); extern OCTINTERP_API octave_value load_fcn_from_file (const std::string& file_name, const std::string& dir_name = "", const std::string& dispatch_type = "", const std::string& package_name = "", const std::string& fcn_name = "", bool autoload = false); extern OCTINTERP_API void source_file (const std::string& file_name, const std::string& context = "", bool verbose = false, bool require_file = true); extern OCTINTERP_API octave_value_list feval (const char *name, const octave_value_list& args = octave_value_list (), int nargout = 0); extern OCTINTERP_API octave_value_list feval (const std::string& name, const octave_value_list& args = octave_value_list (), int nargout = 0); extern OCTINTERP_API octave_value_list feval (octave_function *fcn, const octave_value_list& args = octave_value_list (), int nargout = 0); extern OCTINTERP_API octave_value_list feval (const octave_value& val, const octave_value_list& args = octave_value_list (), int nargout = 0); extern OCTINTERP_API octave_value_list feval (const octave_value_list& args, int nargout = 0); extern OCTINTERP_API void cleanup_statement_list (tree_statement_list **lst); } #endif