6 #ifndef SRC_LISTENER_BASHPPLISTENER_H_
7 #define SRC_LISTENER_BASHPPLISTENER_H_
15 #include <antlr4-runtime.h>
17 #include "../antlr/BashppParserBaseListener.h"
21 #include "../bpp_include/bpp_codegen.h"
28 #include "../bpp_include/bpp.h"
30 #include "../syntax_error.h"
31 #include "../internal_error.h"
33 #define skip_syntax_errors if (error_thrown) { \
34 if (error_context == ctx) { \
35 error_thrown = false; \
36 error_context = nullptr; \
61 class BashppListener :
public BashppParserBaseListener, std::enable_shared_from_this<BashppListener> {
83 std::shared_ptr<std::set<std::string>>
included_files = std::make_shared<std::set<std::string>>();
107 std::shared_ptr<bpp::bpp_program>
program = std::make_shared<bpp::bpp_program>();
127 "class",
"constructor",
"delete",
"destructor",
128 "dynamic_cast",
"include",
"include_once",
"method",
129 "new",
"nullptr",
"primitive",
"private",
130 "protected",
"public",
"super",
"this",
"virtual"
142 #define set_error_context error_thrown = true; error_context = ctx;
144 #define output_syntax_error(symbol, msg) \
145 antlr4::CommonToken* token = dynamic_cast<antlr4::CommonToken*>(symbol); \
149 if (token == nullptr) { \
150 line = static_cast<int>(symbol->getLine()); \
151 column = static_cast<int>(symbol->getCharPositionInLine()); \
152 text = symbol->getText(); \
154 line = static_cast<int>(token->getLine()); \
155 column = static_cast<int>(token->getCharPositionInLine()); \
156 text = token->getText(); \
158 print_syntax_error_or_warning(source_file, line, column, text, msg, get_include_stack()); \
159 program_has_errors = true;
161 #define throw_syntax_error_sym(symbol, msg) \
162 output_syntax_error(symbol, msg) \
166 #define throw_syntax_error(token, msg) antlr4::Token* symbol = token->getSymbol(); \
167 throw_syntax_error_sym(symbol, msg) \
171 #define throw_syntax_error_from_exitRule(token, msg) antlr4::Token* symbol = token->getSymbol(); \
172 output_syntax_error(symbol, msg) \
175 #define show_warning_sym(symbol, msg) \
176 if (!suppress_warnings) { \
177 int line = static_cast<int>(symbol->getLine()); \
178 int column = static_cast<int>(symbol->getCharPositionInLine()); \
179 std::string text = symbol->getText(); \
180 print_syntax_error_or_warning(source_file, line, column, text, msg, get_include_stack(), true); \
183 #define show_warning(token, msg) antlr4::Token* symbol = token->getSymbol(); \
184 show_warning_sym(symbol, msg)
207 void enterProgram(BashppParser::ProgramContext *ctx)
override;
208 void exitProgram(BashppParser::ProgramContext *ctx)
override;
243 void enterStatement(BashppParser::StatementContext *ctx)
override;
244 void exitStatement(BashppParser::StatementContext *ctx)
override;
281 void exitSupershell(BashppParser::SupershellContext *ctx)
override;
283 void enterSubshell(BashppParser::SubshellContext *ctx)
override;
284 void exitSubshell(BashppParser::SubshellContext *ctx)
override;
292 void enterString(BashppParser::StringContext *ctx)
override;
293 void exitString(BashppParser::StringContext *ctx)
override;
298 void enterParameter(BashppParser::ParameterContext *ctx)
override;
299 void exitParameter(BashppParser::ParameterContext *ctx)
override;
305 void exitRaw_rvalue(BashppParser::Raw_rvalueContext *ctx)
override;
349 void enterHeredoc(BashppParser::HeredocContext *ctx)
override;
350 void exitHeredoc(BashppParser::HeredocContext *ctx)
override;
bpp::code_segment code_segment
Definition: BashppListener.h:22
The main listener class for the Bash++ compiler.
Definition: BashppListener.h:61
void enterValue_assignment(BashppParser::Value_assignmentContext *ctx) override
Definition: value_assignment.cpp:8
void enterBash_while_loop(BashppParser::Bash_while_loopContext *ctx) override
Definition: bash_while_loop.cpp:14
void enterArray_index(BashppParser::Array_indexContext *ctx) override
Definition: array_index.cpp:8
bool in_method
Definition: BashppListener.h:111
void exitBash_for_header(BashppParser::Bash_for_headerContext *ctx) override
Definition: bash_for_loop.cpp:63
std::shared_ptr< bpp::bash_while_condition > current_while_condition
Definition: BashppListener.h:110
void exitObject_assignment(BashppParser::Object_assignmentContext *ctx) override
Definition: object_assignment.cpp:17
void exitBash_if_root_branch(BashppParser::Bash_if_root_branchContext *ctx) override
Definition: bash_if_statement.cpp:136
void exitDelete_statement(BashppParser::Delete_statementContext *ctx) override
Definition: delete_statement.cpp:29
void enterBash_case_statement(BashppParser::Bash_case_statementContext *ctx) override
Definition: bash_case_statement.cpp:15
void enterBash_if_root_branch(BashppParser::Bash_if_root_branchContext *ctx) override
Definition: bash_if_statement.cpp:117
void enterMember_declaration(BashppParser::Member_declarationContext *ctx) override
Definition: member_declaration.cpp:8
bool run_on_exit
Definition: BashppListener.h:99
void exitArray_value(BashppParser::Array_valueContext *ctx) override
Definition: array_value.cpp:33
std::stack< std::string > include_stack
A chain of included files, from the main file to the current file (used for error reporting)
Definition: BashppListener.h:90
bool error_thrown
Definition: BashppListener.h:137
void set_include_paths(std::shared_ptr< std::vector< std::string >> include_paths)
Definition: BashppListener.cpp:12
void set_output_file(std::string output_file)
Definition: BashppListener.cpp:53
void exitRaw_rvalue(BashppParser::Raw_rvalueContext *ctx) override
Definition: raw_rvalue.cpp:17
bool program_has_errors
Definition: BashppListener.h:140
void exitBash_case_statement(BashppParser::Bash_case_statementContext *ctx) override
Definition: bash_case_statement.cpp:46
void exitSelf_reference(BashppParser::Self_referenceContext *ctx) override
Definition: self_reference.cpp:38
void enterHeredoc_header(BashppParser::Heredoc_headerContext *ctx) override
Definition: heredoc.cpp:47
void enterBash_while_condition(BashppParser::Bash_while_conditionContext *ctx) override
Definition: bash_while_loop.cpp:59
void set_run_on_exit(bool run_on_exit)
Definition: BashppListener.cpp:57
void enterInclude_statement(BashppParser::Include_statementContext *ctx) override
Handles.
Definition: include_statement.cpp:29
void enterSubshell(BashppParser::SubshellContext *ctx) override
Definition: subshell.cpp:8
std::shared_ptr< std::ostream > code_buffer
Definition: BashppListener.h:96
void exitSinglequote_string(BashppParser::Singlequote_stringContext *ctx) override
Definition: singlequote_string.cpp:19
void exitTerminal_token(BashppParser::Terminal_tokenContext *ctx) override
Definition: terminal_token.cpp:18
void enterPointer_dereference(BashppParser::Pointer_dereferenceContext *ctx) override
Definition: pointer_dereference.cpp:8
std::vector< char * > arguments
Command-line arguments to pass to the compiled program if run_on_exit is true.
Definition: BashppListener.h:105
void enterClass_definition(BashppParser::Class_definitionContext *ctx) override
Definition: class_definition.cpp:8
void enterArray_value(BashppParser::Array_valueContext *ctx) override
Definition: array_value.cpp:8
void exitNullptr_ref(BashppParser::Nullptr_refContext *ctx) override
Definition: nullptr_ref.cpp:25
void enterSelf_reference(BashppParser::Self_referenceContext *ctx) override
Definition: self_reference.cpp:8
void exitClass_definition(BashppParser::Class_definitionContext *ctx) override
Definition: class_definition.cpp:53
void exitConstructor_definition(BashppParser::Constructor_definitionContext *ctx) override
Definition: constructor_definition.cpp:31
void set_source_file(std::string source_file)
Definition: BashppListener.cpp:8
void set_output_stream(std::shared_ptr< std::ostream > output_stream)
Definition: BashppListener.cpp:49
void exitObject_reference_as_lvalue(BashppParser::Object_reference_as_lvalueContext *ctx) override
Definition: object_reference_as_lvalue.cpp:215
void exitBash_if_statement(BashppParser::Bash_if_statementContext *ctx) override
Definition: bash_if_statement.cpp:89
void enterSelf_reference_as_lvalue(BashppParser::Self_reference_as_lvalueContext *ctx) override
Definition: self_reference_as_lvalue.cpp:8
void set_errors()
Sets the program_has_errors flag to true.
Definition: BashppListener.cpp:41
bool in_while_condition
Definition: BashppListener.h:109
void enterDelete_statement(BashppParser::Delete_statementContext *ctx) override
Definition: delete_statement.cpp:8
void enterBash_for_loop(BashppParser::Bash_for_loopContext *ctx) override
Definition: bash_for_loop.cpp:14
void enterOther_statement(BashppParser::Other_statementContext *ctx) override
Definition: other_statement.cpp:8
void set_included(bool included)
Definition: BashppListener.cpp:16
std::shared_ptr< std::ostream > output_stream
Pointer to the output stream to write the compiled code to.
Definition: BashppListener.h:97
void enterBash_function(BashppParser::Bash_functionContext *ctx) override
Definition: bash_function.cpp:8
void exitBash_arithmetic(BashppParser::Bash_arithmeticContext *ctx) override
Definition: bash_arithmetic.cpp:33
void set_included_from(BashppListener *included_from)
Sets the included_from pointer to the given listener.
Definition: BashppListener.cpp:23
void enterMethod_definition(BashppParser::Method_definitionContext *ctx) override
Definition: method_definition.cpp:8
void exitHeredoc_header(BashppParser::Heredoc_headerContext *ctx) override
Definition: heredoc.cpp:61
std::string output_file
Definition: BashppListener.h:98
void exitDynamic_cast_statement(BashppParser::Dynamic_cast_statementContext *ctx) override
Definition: dynamic_cast.cpp:41
void enterExtra_statement(BashppParser::Extra_statementContext *ctx) override
Definition: extra_statement.cpp:8
void enterStatement(BashppParser::StatementContext *ctx) override
Definition: statement.cpp:8
void exitBash_for_loop(BashppParser::Bash_for_loopContext *ctx) override
Definition: bash_for_loop.cpp:28
void enterObject_instantiation(BashppParser::Object_instantiationContext *ctx) override
Definition: object_instantiation.cpp:8
void exitObject_address(BashppParser::Object_addressContext *ctx) override
Definition: object_address.cpp:30
void exitMember_declaration(BashppParser::Member_declarationContext *ctx) override
Definition: member_declaration.cpp:65
bool included
Definition: BashppListener.h:69
void exitExtra_statement(BashppParser::Extra_statementContext *ctx) override
Definition: extra_statement.cpp:18
void exitParameter(BashppParser::ParameterContext *ctx) override
Definition: parameter.cpp:68
bool suppress_warnings
Definition: BashppListener.h:77
void set_arguments(std::vector< char * > arguments)
Definition: BashppListener.cpp:65
antlr4::ParserRuleContext * error_context
Definition: BashppListener.h:138
void enterSinglequote_string(BashppParser::Singlequote_stringContext *ctx) override
Definition: singlequote_string.cpp:8
void enterParameter(BashppParser::ParameterContext *ctx) override
Definition: parameter.cpp:8
void enterObject_reference(BashppParser::Object_referenceContext *ctx) override
Definition: object_reference.cpp:8
std::stack< std::shared_ptr< bpp::bpp_entity > > entity_stack
A stack to keep track of the current entity being processed.
Definition: BashppListener.h:124
void set_code_buffer(std::shared_ptr< std::ostream > code_buffer)
Definition: BashppListener.cpp:45
std::shared_ptr< std::set< std::string > > included_files
A set of (unique) included files (used for '@include_once' directives)
Definition: BashppListener.h:83
void enterNullptr_ref(BashppParser::Nullptr_refContext *ctx) override
Definition: nullptr_ref.cpp:8
void exitBash_case_pattern(BashppParser::Bash_case_patternContext *ctx) override
Definition: bash_case_statement.cpp:84
void enterNew_statement(BashppParser::New_statementContext *ctx) override
Definition: new_statement.cpp:8
void enterBash_if_condition(BashppParser::Bash_if_conditionContext *ctx) override
Definition: bash_if_statement.cpp:198
void enterBash_if_else_branch(BashppParser::Bash_if_else_branchContext *ctx) override
Definition: bash_if_statement.cpp:155
void exitObject_instantiation(BashppParser::Object_instantiationContext *ctx) override
Definition: object_instantiation.cpp:81
void enterBash_if_statement(BashppParser::Bash_if_statementContext *ctx) override
Definition: bash_if_statement.cpp:16
void exitHeredoc(BashppParser::HeredocContext *ctx) override
Definition: heredoc.cpp:28
bool is_protected_keyword(const std::string &keyword)
Definition: BashppListener.cpp:104
void enterTerminal_token(BashppParser::Terminal_tokenContext *ctx) override
Definition: terminal_token.cpp:8
void enterObject_assignment(BashppParser::Object_assignmentContext *ctx) override
Definition: object_assignment.cpp:8
BashppListener * included_from
Definition: BashppListener.h:84
void enterBash_arithmetic(BashppParser::Bash_arithmeticContext *ctx) override
Definition: bash_arithmetic.cpp:8
void enterHeredoc(BashppParser::HeredocContext *ctx) override
Definition: heredoc.cpp:14
std::shared_ptr< bpp::bpp_code_entity > latest_code_entity()
Definition: BashppListener.cpp:81
std::shared_ptr< std::vector< std::string > > include_paths
A list of paths to search for included files.
Definition: BashppListener.h:75
void exitBash_while_loop(BashppParser::Bash_while_loopContext *ctx) override
Definition: bash_while_loop.cpp:28
void enterDestructor_definition(BashppParser::Destructor_definitionContext *ctx) override
Definition: destructor_definition.cpp:8
void set_suppress_warnings(bool suppress_warnings)
Definition: BashppListener.cpp:61
void enterBash_case_pattern(BashppParser::Bash_case_patternContext *ctx) override
Definition: bash_case_statement.cpp:67
void enterGeneral_statement(BashppParser::General_statementContext *ctx) override
Definition: general_statement.cpp:8
void enterString(BashppParser::StringContext *ctx) override
Definition: string.cpp:8
void enterDynamic_cast_statement(BashppParser::Dynamic_cast_statementContext *ctx) override
Definition: dynamic_cast.cpp:8
void exitSupershell(BashppParser::SupershellContext *ctx) override
Definition: supershell.cpp:29
void exitOther_statement(BashppParser::Other_statementContext *ctx) override
Definition: other_statement.cpp:25
void exitNew_statement(BashppParser::New_statementContext *ctx) override
Definition: new_statement.cpp:51
void enterSupershell(BashppParser::SupershellContext *ctx) override
Definition: supershell.cpp:8
std::shared_ptr< bpp::bpp_class > primitive
Definition: BashppListener.h:135
void enterBash_case_pattern_header(BashppParser::Bash_case_pattern_headerContext *ctx) override
Definition: bash_case_statement.cpp:107
void exitBash_while_condition(BashppParser::Bash_while_conditionContext *ctx) override
Definition: bash_while_loop.cpp:78
void exitGeneral_statement(BashppParser::General_statementContext *ctx) override
Definition: general_statement.cpp:19
void exitPointer_dereference(BashppParser::Pointer_dereferenceContext *ctx) override
Definition: pointer_dereference.cpp:43
void exitProgram(BashppParser::ProgramContext *ctx) override
Definition: program.cpp:30
void exitSubshell(BashppParser::SubshellContext *ctx) override
Definition: subshell.cpp:26
void enterPointer_declaration(BashppParser::Pointer_declarationContext *ctx) override
Definition: pointer_declaration.cpp:8
void exitArray_index(BashppParser::Array_indexContext *ctx) override
Definition: array_index.cpp:34
std::shared_ptr< std::set< std::string > > get_included_files()
Definition: BashppListener.cpp:73
void exitBash_case_pattern_header(BashppParser::Bash_case_pattern_headerContext *ctx) override
Definition: bash_case_statement.cpp:122
void exitClass_body_statement(BashppParser::Class_body_statementContext *ctx) override
Definition: class_body_statement.cpp:39
void exitString(BashppParser::StringContext *ctx) override
Definition: string.cpp:30
void enterRaw_rvalue(BashppParser::Raw_rvalueContext *ctx) override
Definition: raw_rvalue.cpp:8
void enterProgram(BashppParser::ProgramContext *ctx) override
Definition: program.cpp:13
void exitDestructor_definition(BashppParser::Destructor_definitionContext *ctx) override
Definition: destructor_definition.cpp:31
void enterDeprecated_subshell(BashppParser::Deprecated_subshellContext *ctx) override
Definition: deprecated_subshell.cpp:8
void exitObject_reference(BashppParser::Object_referenceContext *ctx) override
Definition: object_reference.cpp:35
void exitBash_function(BashppParser::Bash_functionContext *ctx) override
Definition: bash_function.cpp:48
void exitInclude_statement(BashppParser::Include_statementContext *ctx) override
Definition: include_statement.cpp:219
void set_included_files(std::shared_ptr< std::set< std::string >> included_files)
Sets the included_files pointer to the given set of included files.
Definition: BashppListener.cpp:32
std::shared_ptr< bpp::bpp_program > program
Definition: BashppListener.h:107
void enterObject_reference_as_lvalue(BashppParser::Object_reference_as_lvalueContext *ctx) override
Definition: object_reference_as_lvalue.cpp:8
std::string source_file
Path to the source file being compiled (used for error reporting)
Definition: BashppListener.h:67
void enterConstructor_definition(BashppParser::Constructor_definitionContext *ctx) override
Definition: constructor_definition.cpp:8
void enterClass_body_statement(BashppParser::Class_body_statementContext *ctx) override
Definition: class_body_statement.cpp:8
std::shared_ptr< bpp::bpp_program > get_program()
Definition: BashppListener.cpp:69
void exitValue_assignment(BashppParser::Value_assignmentContext *ctx) override
Definition: value_assignment.cpp:25
void enterBash_for_header(BashppParser::Bash_for_headerContext *ctx) override
Definition: bash_for_loop.cpp:49
void exitStatement(BashppParser::StatementContext *ctx) override
Definition: statement.cpp:12
void exitBash_if_else_branch(BashppParser::Bash_if_else_branchContext *ctx) override
Definition: bash_if_statement.cpp:179
void exitPointer_declaration(BashppParser::Pointer_declarationContext *ctx) override
Definition: pointer_declaration.cpp:85
void exitSelf_reference_as_lvalue(BashppParser::Self_reference_as_lvalueContext *ctx) override
Definition: self_reference_as_lvalue.cpp:172
void enterObject_address(BashppParser::Object_addressContext *ctx) override
Definition: object_address.cpp:8
static constexpr const char * protected_keywords[]
Definition: BashppListener.h:126
void exitBash_if_condition(BashppParser::Bash_if_conditionContext *ctx) override
Definition: bash_if_statement.cpp:215
std::stack< std::string > get_include_stack()
Definition: BashppListener.cpp:77
void exitMethod_definition(BashppParser::Method_definitionContext *ctx) override
Definition: method_definition.cpp:60
void exitDeprecated_subshell(BashppParser::Deprecated_subshellContext *ctx) override
Definition: deprecated_subshell.cpp:26
code_segment generate_supershell_code(const std::string &code_to_run, bool in_while_condition, std::shared_ptr< bash_while_condition > current_while_condition, std::shared_ptr< bpp::bpp_program > program)
Generates a supershell code segment for executing a bash command.
Definition: bpp_codegen.cpp:27
code_segment generate_dynamic_cast_code(const std::string &reference_code, const std::string &class_name, std::shared_ptr< bpp::bpp_program > program)
Generates a code segment for performing a dynamic cast.
Definition: bpp_codegen.cpp:170
code_segment generate_delete_code(std::shared_ptr< bpp::bpp_object > object, const std::string &object_ref, std::shared_ptr< bpp::bpp_program > program)
Generates a code segment for deleting an object.
Definition: bpp_codegen.cpp:75
code_segment generate_method_call_code(const std::string &reference_code, const std::string &method_name, std::shared_ptr< bpp::bpp_class > assumed_class, bool force_static_reference, std::shared_ptr< bpp::bpp_program > program)
Generates a code segment for calling a method.
Definition: bpp_codegen.cpp:113
A struct to hold (compiled) code segments.
Definition: bpp_codegen.h:39