The main listener class for the Bash++ compiler. More...

#include <BashppListener.h>

Inheritance diagram for BashppListener:

Collaboration diagram for BashppListener:

Classes
struct	code_segment
	A struct to hold (compiled) code segments. More...

Public Member Functions
void	set_source_file (std::string source_file)

void	set_include_paths (std::shared_ptr< std::vector< std::string >> include_paths)

void	set_dynamic_linking (bool dynamic_linking)

void	set_included (bool included)

void	set_included_from (BashppListener *included_from)
	Sets the included_from pointer to the given listener. More...

void	set_errors ()
	Sets the program_has_errors flag to true. More...

void	set_output_stream (std::shared_ptr< std::ostream > output_stream)

void	set_output_file (std::string output_file)

void	set_run_on_exit (bool run_on_exit)

void	set_suppress_warnings (bool suppress_warnings)

void	set_arguments (std::vector< char * > arguments)

std::shared_ptr< bpp::bpp_program >	get_program ()

std::set< std::string >	get_included_files ()

std::stack< std::string >	get_include_stack ()

code_segment	generate_supershell_code (const std::string &code_to_run_in_supershell)
	Generates a supershell code segment for executing a bash command. More...

code_segment	generate_delete_code (std::shared_ptr< bpp::bpp_object > object, const std::string &object_reference_string, bool force_pointer=false)
	Generates a code segment for deleting an object. More...

code_segment	generate_method_call_code (const std::string &reference_code, const std::string &method_name, std::shared_ptr< bpp::bpp_class > assumed_class)
	Generates a code segment for calling a method. More...

code_segment	generate_dynamic_cast_code (const std::string &reference_code, const std::string &class_name)
	Generates a code segment for performing a dynamic cast. More...

void	enterProgram (BashppParser::ProgramContext *ctx) override

void	exitProgram (BashppParser::ProgramContext *ctx) override

void	enterInclude_statement (BashppParser::Include_statementContext *ctx) override

void	exitInclude_statement (BashppParser::Include_statementContext *ctx) override

void	enterClass_definition (BashppParser::Class_definitionContext *ctx) override

void	exitClass_definition (BashppParser::Class_definitionContext *ctx) override

void	enterMember_declaration (BashppParser::Member_declarationContext *ctx) override

void	exitMember_declaration (BashppParser::Member_declarationContext *ctx) override

void	enterObject_instantiation (BashppParser::Object_instantiationContext *ctx) override

void	exitObject_instantiation (BashppParser::Object_instantiationContext *ctx) override

void	enterPointer_declaration (BashppParser::Pointer_declarationContext *ctx) override

void	exitPointer_declaration (BashppParser::Pointer_declarationContext *ctx) override

void	enterValue_assignment (BashppParser::Value_assignmentContext *ctx) override

void	exitValue_assignment (BashppParser::Value_assignmentContext *ctx) override

void	enterMethod_definition (BashppParser::Method_definitionContext *ctx) override

void	exitMethod_definition (BashppParser::Method_definitionContext *ctx) override

void	enterConstructor_definition (BashppParser::Constructor_definitionContext *ctx) override

void	exitConstructor_definition (BashppParser::Constructor_definitionContext *ctx) override

void	enterDestructor_definition (BashppParser::Destructor_definitionContext *ctx) override

void	exitDestructor_definition (BashppParser::Destructor_definitionContext *ctx) override

void	enterSelf_reference (BashppParser::Self_referenceContext *ctx) override

void	exitSelf_reference (BashppParser::Self_referenceContext *ctx) override

void	enterSelf_reference_as_lvalue (BashppParser::Self_reference_as_lvalueContext *ctx) override

void	exitSelf_reference_as_lvalue (BashppParser::Self_reference_as_lvalueContext *ctx) override

void	enterStatement (BashppParser::StatementContext *ctx) override

void	exitStatement (BashppParser::StatementContext *ctx) override

void	enterClass_body_statement (BashppParser::Class_body_statementContext *ctx) override

void	exitClass_body_statement (BashppParser::Class_body_statementContext *ctx) override

void	enterGeneral_statement (BashppParser::General_statementContext *ctx) override

void	exitGeneral_statement (BashppParser::General_statementContext *ctx) override

void	enterObject_assignment (BashppParser::Object_assignmentContext *ctx) override

void	exitObject_assignment (BashppParser::Object_assignmentContext *ctx) override

void	enterPointer_dereference (BashppParser::Pointer_dereferenceContext *ctx) override

void	exitPointer_dereference (BashppParser::Pointer_dereferenceContext *ctx) override

void	enterObject_address (BashppParser::Object_addressContext *ctx) override

void	exitObject_address (BashppParser::Object_addressContext *ctx) override

void	enterObject_reference (BashppParser::Object_referenceContext *ctx) override

void	exitObject_reference (BashppParser::Object_referenceContext *ctx) override

void	enterObject_reference_as_lvalue (BashppParser::Object_reference_as_lvalueContext *ctx) override

void	exitObject_reference_as_lvalue (BashppParser::Object_reference_as_lvalueContext *ctx) override

void	enterNullptr_ref (BashppParser::Nullptr_refContext *ctx) override

void	exitNullptr_ref (BashppParser::Nullptr_refContext *ctx) override

void	enterNew_statement (BashppParser::New_statementContext *ctx) override

void	exitNew_statement (BashppParser::New_statementContext *ctx) override

void	enterDelete_statement (BashppParser::Delete_statementContext *ctx) override

void	exitDelete_statement (BashppParser::Delete_statementContext *ctx) override

void	enterDynamic_cast_statement (BashppParser::Dynamic_cast_statementContext *ctx) override

void	exitDynamic_cast_statement (BashppParser::Dynamic_cast_statementContext *ctx) override

void	enterSupershell (BashppParser::SupershellContext *ctx) override

void	exitSupershell (BashppParser::SupershellContext *ctx) override

void	enterSubshell (BashppParser::SubshellContext *ctx) override

void	exitSubshell (BashppParser::SubshellContext *ctx) override

void	enterDeprecated_subshell (BashppParser::Deprecated_subshellContext *ctx) override

void	exitDeprecated_subshell (BashppParser::Deprecated_subshellContext *ctx) override

void	enterBash_arithmetic (BashppParser::Bash_arithmeticContext *ctx) override

void	exitBash_arithmetic (BashppParser::Bash_arithmeticContext *ctx) override

void	enterString (BashppParser::StringContext *ctx) override

void	exitString (BashppParser::StringContext *ctx) override

void	enterSinglequote_string (BashppParser::Singlequote_stringContext *ctx) override

void	exitSinglequote_string (BashppParser::Singlequote_stringContext *ctx) override

void	enterParameter (BashppParser::ParameterContext *ctx) override

void	exitParameter (BashppParser::ParameterContext *ctx) override

void	enterOther_statement (BashppParser::Other_statementContext *ctx) override

void	exitOther_statement (BashppParser::Other_statementContext *ctx) override

void	enterRaw_rvalue (BashppParser::Raw_rvalueContext *ctx) override

void	exitRaw_rvalue (BashppParser::Raw_rvalueContext *ctx) override

void	enterArray_value (BashppParser::Array_valueContext *ctx) override

void	exitArray_value (BashppParser::Array_valueContext *ctx) override

void	enterArray_index (BashppParser::Array_indexContext *ctx) override

void	exitArray_index (BashppParser::Array_indexContext *ctx) override

void	enterBash_if_statement (BashppParser::Bash_if_statementContext *ctx) override

void	exitBash_if_statement (BashppParser::Bash_if_statementContext *ctx) override

void	enterBash_if_root_branch (BashppParser::Bash_if_root_branchContext *ctx) override

void	exitBash_if_root_branch (BashppParser::Bash_if_root_branchContext *ctx) override

void	enterBash_if_else_branch (BashppParser::Bash_if_else_branchContext *ctx) override

void	exitBash_if_else_branch (BashppParser::Bash_if_else_branchContext *ctx) override

void	enterBash_if_condition (BashppParser::Bash_if_conditionContext *ctx) override

void	exitBash_if_condition (BashppParser::Bash_if_conditionContext *ctx) override

void	enterBash_case_statement (BashppParser::Bash_case_statementContext *ctx) override

void	exitBash_case_statement (BashppParser::Bash_case_statementContext *ctx) override

void	enterBash_case_pattern (BashppParser::Bash_case_patternContext *ctx) override

void	exitBash_case_pattern (BashppParser::Bash_case_patternContext *ctx) override

void	enterBash_case_pattern_header (BashppParser::Bash_case_pattern_headerContext *ctx) override

void	exitBash_case_pattern_header (BashppParser::Bash_case_pattern_headerContext *ctx) override

void	enterBash_while_loop (BashppParser::Bash_while_loopContext *ctx) override

void	exitBash_while_loop (BashppParser::Bash_while_loopContext *ctx) override

void	enterBash_while_condition (BashppParser::Bash_while_conditionContext *ctx) override

void	exitBash_while_condition (BashppParser::Bash_while_conditionContext *ctx) override

void	enterBash_for_loop (BashppParser::Bash_for_loopContext *ctx) override

void	exitBash_for_loop (BashppParser::Bash_for_loopContext *ctx) override

void	enterBash_for_header (BashppParser::Bash_for_headerContext *ctx) override

void	exitBash_for_header (BashppParser::Bash_for_headerContext *ctx) override

void	enterHeredoc (BashppParser::HeredocContext *ctx) override

void	exitHeredoc (BashppParser::HeredocContext *ctx) override

void	enterHeredoc_header (BashppParser::Heredoc_headerContext *ctx) override

void	exitHeredoc_header (BashppParser::Heredoc_headerContext *ctx) override

void	enterExtra_statement (BashppParser::Extra_statementContext *ctx) override

void	exitExtra_statement (BashppParser::Extra_statementContext *ctx) override

void	enterTerminal_token (BashppParser::Terminal_tokenContext *ctx) override

void	exitTerminal_token (BashppParser::Terminal_tokenContext *ctx) override

Private Member Functions
bool	is_protected_keyword (const std::string &keyword)

Private Attributes
std::string	source_file
	Path to the source file being compiled (used for error reporting) More...

bool	included = false

std::shared_ptr< std::vector< std::string > >	include_paths = nullptr
	A list of paths to search for included files. More...

bool	dynamic_linking = false

bool	suppress_warnings = false

std::set< std::string >	included_files = {}
	A set of (unique) included files (used for '@include_once' directives) More...

BashppListener *	included_from = nullptr

std::stack< std::string >	include_stack
	A chain of included files, from the main file to the current file (used for error reporting) More...

std::shared_ptr< std::ostream >	output_stream
	Pointer to the output stream to write the compiled code to. More...

std::string	output_file

bool	run_on_exit = false

std::vector< char * >	arguments = {}
	Command-line arguments to pass to the compiled program if run_on_exit is true. More...

std::shared_ptr< bpp::bpp_program >	program = std::make_shared<bpp::bpp_program>()

bool	in_comment = false

bool	in_singlequote_string = false

bool	in_while_condition = false

std::shared_ptr< bpp::bash_while_condition >	current_while_condition = nullptr

std::stack< std::shared_ptr< bpp::bpp_entity > >	entity_stack
	A stack to keep track of the current entity being processed. More...

std::shared_ptr< bpp::bpp_class >	primitive

bool	error_thrown = false

antlr4::ParserRuleContext *	error_context = nullptr

bool	program_has_errors = false

Static Private Attributes
static constexpr const char *	protected_keywords []

Detailed Description

The main listener class for the Bash++ compiler.

This class is the main listener for the Bash++ compiler. This is where the main logic for the compiler is implemented by walking the parse tree generated by the ANTLR parser.

The listener is responsible for generating the compiled Bash code from the parsed Bash++ code. The listener is also responsible for handling errors and warnings.

A brief run-down of how the parse tree works:

The parse tree is a tree representation of the parsed code.
When the parser encounters a new statement, it creates a new node in the parse tree.
If Statement A is inside Statement B, then Statement A is a child of Statement B in the parse tree.
The listener walks the parse tree, visiting each node in the tree in a depth-first manner.
When the listener visits a node, it executes the corresponding function in the listener class.

When we enter a node in the parse tree, we execute the enter* function for that node. When we exit a node in the parse tree, we execute the exit* function for that node.

Member Function Documentation

◆ enterArray_index()

void BashppListener::enterArray_index ( BashppParser::Array_indexContext * ctx )

override

Array indices take the form: [...] Where the contents of the brackets are the array index And can be any valid sequence of statements

◆ enterArray_value()

void BashppListener::enterArray_value ( BashppParser::Array_valueContext * ctx )

override

Array values are rvalues in assignment operations which take the form (...) Where the contents of the parentheses are the array elements Empty arrays are written as ()

◆ enterBash_arithmetic()

void BashppListener::enterBash_arithmetic ( BashppParser::Bash_arithmeticContext * ctx )

override

Bash arithmetic is a series of arithmetic operations that are enclosed in $((...)) They do not run in a subshell. So, unlike with the subshell rule, We can preserve objects instantiated within the arithmetic context, etc

◆ enterBash_case_pattern()

void BashppListener::enterBash_case_pattern ( BashppParser::Bash_case_patternContext * ctx )

override

◆ enterBash_case_pattern_header()

void BashppListener::enterBash_case_pattern_header ( BashppParser::Bash_case_pattern_headerContext * ctx )

override

◆ enterBash_case_statement()

void BashppListener::enterBash_case_statement ( BashppParser::Bash_case_statementContext * ctx )

override

Bash case statements take the form case (something) in pattern1) ... ;; ... esac

The code to handle each pattern will be caught by the Bash_case_pattern context These will be children of the Bash_case_statement context in the parse tree

The patterns to be matched will be caught by the Bash_case_pattern_header context These will be children of the Bash_case_pattern context in the parse tree

◆ enterBash_for_header()

void BashppListener::enterBash_for_header ( BashppParser::Bash_for_headerContext * ctx )

override

◆ enterBash_for_loop()

void BashppListener::enterBash_for_loop ( BashppParser::Bash_for_loopContext * ctx )

override

◆ enterBash_if_condition()

void BashppListener::enterBash_if_condition ( BashppParser::Bash_if_conditionContext * ctx )

override

◆ enterBash_if_else_branch()

void BashppListener::enterBash_if_else_branch ( BashppParser::Bash_if_else_branchContext * ctx )

override

◆ enterBash_if_root_branch()

void BashppListener::enterBash_if_root_branch ( BashppParser::Bash_if_root_branchContext * ctx )

override

◆ enterBash_if_statement()

void BashppListener::enterBash_if_statement ( BashppParser::Bash_if_statementContext * ctx )

override

Bash if statement take the form if CONDITION; then ... elif CONDITION; then ... else ... fi

The elif/else branches will be caught by the Bash_if_root_branch and Bash_if_else_branch contexts Both of those will be children of the Bash_if_statement context in the parse tree

The only thing that we need to be careful about is this: All of the pre-code which is generated INSIDE of the if CONDITION Should be placed before the if statement altogether, not only before the condition Likewise all of the post-code for the condition should be placed after the if statement

For example, consider the following code: if [[ -f "@this.filePath" ]]; then ... elif [[ -f "@this.otherFilePath" ]]; then ... fi

Pre-code has to be generated in order to access @this.filePath and @this.otherFilePath The pre-code converts these references into ordinary variable references which we can substitute directly into the if condition As in, for example, swapping 'if [[ -f "@this.filePath" ]]' with 'if [[ -f "$filePath" ]]' Although we have better naming conventions for the variables, this is just an example

If we weren't careful, and just placed the pre-code the way we always do, we would end up with something like this: $filePath={whatever we need to do to access @this.filePath} if [[ -f "$filePath" ]]; then ... $otherFilePath={whatever we need to do to access @this.otherFilePath} elif [[ -f "$otherFilePath" ]]; then ... fi

As you can tell from the above, the $otherFilePath assignment is INSIDE the first branch of the if statement And therefore is completely useless – if the first branch is taken, the second branch will never be taken And in the event that the second branch IS taken, $otherFilePath will not be defined

So, what we have to do instead is a bit more like: $filePath={whatever we need to do to access @this.filePath} $otherFilePath={whatever we need to do to access @this.otherFilePath} if [[ -f "$filePath" ]]; then ... elif [[ -f "$otherFilePath" ]]; then ... fi

◆ enterBash_while_condition()

void BashppListener::enterBash_while_condition ( BashppParser::Bash_while_conditionContext * ctx )

override

◆ enterBash_while_loop()

void BashppListener::enterBash_while_loop ( BashppParser::Bash_while_loopContext * ctx )

override

◆ enterClass_body_statement()

void BashppListener::enterClass_body_statement ( BashppParser::Class_body_statementContext * ctx )

override

◆ enterClass_definition()

void BashppListener::enterClass_definition ( BashppParser::Class_definitionContext * ctx )

override

◆ enterConstructor_definition()

void BashppListener::enterConstructor_definition ( BashppParser::Constructor_definitionContext * ctx )

override

Constructor definitions take the form @constructor { ... }

◆ enterDelete_statement()

void BashppListener::enterDelete_statement ( BashppParser::Delete_statementContext * ctx )

override

Delete statements take the form @delete @object Where object is the name of the object to delete

This statement calls the __delete function for the object and the object's destructor if it exists If the destructor exists, it will be called first (before __delete) It then unsets the object

◆ enterDeprecated_subshell()

void BashppListener::enterDeprecated_subshell ( BashppParser::Deprecated_subshellContext * ctx )

override

◆ enterDestructor_definition()

void BashppListener::enterDestructor_definition ( BashppParser::Destructor_definitionContext * ctx )

override

Destructor definitions take the form @destructor { ... }

◆ enterDynamic_cast_statement()

void BashppListener::enterDynamic_cast_statement ( BashppParser::Dynamic_cast_statementContext * ctx )

override

Dynamic cast statements take the form @dynamic_cast<ClassName> Object Where ClassName is the name of the class to cast to And Object is the object to cast

This statement performs a runtime check to verify the cast is valid And substitutes either the address of the cast object or the @nullptr value

◆ enterExtra_statement()

void BashppListener::enterExtra_statement ( BashppParser::Extra_statementContext * ctx )

override

◆ enterGeneral_statement()

void BashppListener::enterGeneral_statement ( BashppParser::General_statementContext * ctx )

override

◆ enterHeredoc()

void BashppListener::enterHeredoc ( BashppParser::HeredocContext * ctx )

override

◆ enterHeredoc_header()

void BashppListener::enterHeredoc_header ( BashppParser::Heredoc_headerContext * ctx )

override

◆ enterInclude_statement()

void BashppListener::enterInclude_statement ( BashppParser::Include_statementContext * ctx )

override

◆ enterMember_declaration()

void BashppListener::enterMember_declaration ( BashppParser::Member_declarationContext * ctx )

override

This will either be:

A primitive
An object
A pointer If it's a primitive, then IDENTIFIER will be set If it's an object, then object_instantiation will be set, and we'll handle that in the object_instantiation rule If it's a pointer, then pointer_declaration will be set, and we'll handle that in the pointer_declaration rule

◆ enterMethod_definition()

void BashppListener::enterMethod_definition ( BashppParser::Method_definitionContext * ctx )

override

◆ enterNew_statement()

void BashppListener::enterNew_statement ( BashppParser::New_statementContext * ctx )

override

New statements take the form @new ClassName Where ClassName is the name of the class to instantiate

This statement creates a new object of the specified class And replaces the "@new ClassName" statement with the address of the new object

◆ enterNullptr_ref()

void BashppListener::enterNullptr_ref ( BashppParser::Nullptr_refContext * ctx )

override

Nullptr references take the form @nullptr

This reference will be replaced with the value of the nullptr constant

◆ enterObject_address()

void BashppListener::enterObject_address ( BashppParser::Object_addressContext * ctx )

override

Object addresses take the form &@IDENTIFIER.IDENTIFIER... Or &@this.IDENTIFIER.IDENTIFIER...

This reference will be replaced with the memory address of the object

◆ enterObject_assignment()

void BashppListener::enterObject_assignment ( BashppParser::Object_assignmentContext * ctx )

override

◆ enterObject_instantiation()

void BashppListener::enterObject_instantiation ( BashppParser::Object_instantiationContext * ctx )

override

The object type will be stored in one of either IDENTIFIER_LVALUE or IDENTIFIER(0) If IDENTIFIER_LVALUE, then the object name will be in IDENTIFIER(0) If IDENTIFIER(0), then the object name will be in IDENTIFIER(1)

◆ enterObject_reference()

void BashppListener::enterObject_reference ( BashppParser::Object_referenceContext * ctx )

override

Object references take the form @IDENTIFIER.IDENTIFIER.IDENTIFIER... Where each IDENTIFIER following a dot is a member of the object referenced by the preceding IDENTIFIER

This reference may resolve to either an object or a method If it's a primitive object, treat this as an rvalue and get the value of the primitive object If it's a non-primitive object, this is a method call to .toPrimitive If it's a method, call the method in a supershell and substitute the result

◆ enterObject_reference_as_lvalue()

void BashppListener::enterObject_reference_as_lvalue ( BashppParser::Object_reference_as_lvalueContext * ctx )

override

Lvalue object references take the form @IDENTIFIER_LVALUE.IDENTIFIER.IDENTIFIER... Where each IDENTIFIER following a dot is a member of the object referenced by the preceding IDENTIFIER

This reference may resolve to either an object or a method If it's a primitive object, replace the reference with the address of the primitive object If it's a non-primitive object, this is a method call to .toPrimitive If it's a method, replace the reference with a call to the method There is no need to call the method in a supershell for lvalues. We can (and must) just call it directly

◆ enterOther_statement()

void BashppListener::enterOther_statement ( BashppParser::Other_statementContext * ctx )

override

◆ enterParameter()

void BashppListener::enterParameter ( BashppParser::ParameterContext * ctx )

override

◆ enterPointer_declaration()

void BashppListener::enterPointer_declaration ( BashppParser::Pointer_declarationContext * ctx )

override

The pointer type will be stored in one of either IDENTIFIER_LVALUE or IDENTIFIER(0) If IDENTIFIER_LVALUE, then the pointer name will be in IDENTIFIER(0) If IDENTIFIER(0), then the pointer name will be in IDENTIFIER(1)

◆ enterPointer_dereference()

void BashppListener::enterPointer_dereference ( BashppParser::Pointer_dereferenceContext * ctx )

override

Pointer dereferences take the form *@IDENTIFIER.IDENTIFIER... Or *@this.IDENTIFIER.IDENTIFIER... The result should be the object pointed to by the pointer For instance, @MyClass myObject=*@myPointer Should copy the object pointed to by myPointer into myObject Or: var=*@myPointer Should store the output of the object's toPrimitive method in var

◆ enterProgram()

void BashppListener::enterProgram ( BashppParser::ProgramContext * ctx )

override

◆ enterRaw_rvalue()

void BashppListener::enterRaw_rvalue ( BashppParser::Raw_rvalueContext * ctx )

override

◆ enterSelf_reference()

void BashppListener::enterSelf_reference ( BashppParser::Self_referenceContext * ctx )

override

Self references take the form @this.IDENTIFIER.IDENTIFIER... Where each IDENTIFIER following a dot is a member of the object referenced by the preceding IDENTIFIER

This reference may resolve to either an object or a method If it's a primitive object, treat this as an rvalue and get the value of the primitive object If it's a non-primitive object, this is a method call to .toPrimitive If it's a method, call the method in a supershell and substitute the result

◆ enterSelf_reference_as_lvalue()

void BashppListener::enterSelf_reference_as_lvalue ( BashppParser::Self_reference_as_lvalueContext * ctx )

override

Self references take the form @this.IDENTIFIER.IDENTIFIER... Where each IDENTIFIER following a dot is a member of the object referenced by the preceding IDENTIFIER

This reference may resolve to either an object or a method If it's a primitive object, replace the reference with the address of the primitive object If it's a non-primitive object, this is a method call to .toPrimitive If it's a method, replace the reference with a call to the method There is no need to call the method in a supershell for lvalues. We can (and must) just call it directly

◆ enterSinglequote_string()

void BashppListener::enterSinglequote_string ( BashppParser::Singlequote_stringContext * ctx )

override

◆ enterStatement()

void BashppListener::enterStatement ( BashppParser::StatementContext * ctx )

override

◆ enterString()

void BashppListener::enterString ( BashppParser::StringContext * ctx )

override

◆ enterSubshell()

void BashppListener::enterSubshell ( BashppParser::SubshellContext * ctx )

override

◆ enterSupershell()

void BashppListener::enterSupershell ( BashppParser::SupershellContext * ctx )

override

Supershells take the form @(...) Where ... is a series of commands to be executed in a supershell Supershells can be nested

◆ enterTerminal_token()

void BashppListener::enterTerminal_token ( BashppParser::Terminal_tokenContext * ctx )

override

◆ enterValue_assignment()

void BashppListener::enterValue_assignment ( BashppParser::Value_assignmentContext * ctx )

override

◆ exitArray_index()

void BashppListener::exitArray_index ( BashppParser::Array_indexContext * ctx )

override

◆ exitArray_value()

void BashppListener::exitArray_value ( BashppParser::Array_valueContext * ctx )

override

◆ exitBash_arithmetic()

void BashppListener::exitBash_arithmetic ( BashppParser::Bash_arithmeticContext * ctx )

override

◆ exitBash_case_pattern()

void BashppListener::exitBash_case_pattern ( BashppParser::Bash_case_patternContext * ctx )

override

◆ exitBash_case_pattern_header()

void BashppListener::exitBash_case_pattern_header ( BashppParser::Bash_case_pattern_headerContext * ctx )

override

◆ exitBash_case_statement()

void BashppListener::exitBash_case_statement ( BashppParser::Bash_case_statementContext * ctx )

override

◆ exitBash_for_header()

void BashppListener::exitBash_for_header ( BashppParser::Bash_for_headerContext * ctx )

override

◆ exitBash_for_loop()

void BashppListener::exitBash_for_loop ( BashppParser::Bash_for_loopContext * ctx )

override

◆ exitBash_if_condition()

void BashppListener::exitBash_if_condition ( BashppParser::Bash_if_conditionContext * ctx )

override

◆ exitBash_if_else_branch()

void BashppListener::exitBash_if_else_branch ( BashppParser::Bash_if_else_branchContext * ctx )

override

◆ exitBash_if_root_branch()

void BashppListener::exitBash_if_root_branch ( BashppParser::Bash_if_root_branchContext * ctx )

override

◆ exitBash_if_statement()

void BashppListener::exitBash_if_statement ( BashppParser::Bash_if_statementContext * ctx )

override

◆ exitBash_while_condition()

void BashppListener::exitBash_while_condition ( BashppParser::Bash_while_conditionContext * ctx )

override

◆ exitBash_while_loop()

void BashppListener::exitBash_while_loop ( BashppParser::Bash_while_loopContext * ctx )

override

◆ exitClass_body_statement()

void BashppListener::exitClass_body_statement ( BashppParser::Class_body_statementContext * ctx )

override

◆ exitClass_definition()

void BashppListener::exitClass_definition ( BashppParser::Class_definitionContext * ctx )

override

◆ exitConstructor_definition()

void BashppListener::exitConstructor_definition ( BashppParser::Constructor_definitionContext * ctx )

override

◆ exitDelete_statement()

void BashppListener::exitDelete_statement ( BashppParser::Delete_statementContext * ctx )

override

◆ exitDeprecated_subshell()

void BashppListener::exitDeprecated_subshell ( BashppParser::Deprecated_subshellContext * ctx )

override

◆ exitDestructor_definition()

void BashppListener::exitDestructor_definition ( BashppParser::Destructor_definitionContext * ctx )

override

◆ exitDynamic_cast_statement()

void BashppListener::exitDynamic_cast_statement ( BashppParser::Dynamic_cast_statementContext * ctx )

override

◆ exitExtra_statement()

void BashppListener::exitExtra_statement ( BashppParser::Extra_statementContext * ctx )

override

◆ exitGeneral_statement()

void BashppListener::exitGeneral_statement ( BashppParser::General_statementContext * ctx )

override

◆ exitHeredoc()

void BashppListener::exitHeredoc ( BashppParser::HeredocContext * ctx )

override

◆ exitHeredoc_header()

void BashppListener::exitHeredoc_header ( BashppParser::Heredoc_headerContext * ctx )

override

◆ exitInclude_statement()

void BashppListener::exitInclude_statement ( BashppParser::Include_statementContext * ctx )

override

◆ exitMember_declaration()

void BashppListener::exitMember_declaration ( BashppParser::Member_declarationContext * ctx )

override

◆ exitMethod_definition()

void BashppListener::exitMethod_definition ( BashppParser::Method_definitionContext * ctx )

override

◆ exitNew_statement()

void BashppListener::exitNew_statement ( BashppParser::New_statementContext * ctx )

override

◆ exitNullptr_ref()

void BashppListener::exitNullptr_ref ( BashppParser::Nullptr_refContext * ctx )

override

◆ exitObject_address()

void BashppListener::exitObject_address ( BashppParser::Object_addressContext * ctx )

override

◆ exitObject_assignment()

void BashppListener::exitObject_assignment ( BashppParser::Object_assignmentContext * ctx )

override

◆ exitObject_instantiation()

void BashppListener::exitObject_instantiation ( BashppParser::Object_instantiationContext * ctx )

override

◆ exitObject_reference()

void BashppListener::exitObject_reference ( BashppParser::Object_referenceContext * ctx )

override

Suppose we have an 'object' with a datamember 'array' which is an array of primitives Accessing index 'i' of that array would, in Bash++, take the form: @object.array[$i] And the compiled code's version of the reference: ${bpp__objectClass__object__array[$i]}

Suppose however that 'object' has a non-primitive datamember 'inner' which has a datamember 'array' which is an array of primitives (In this case, we're nesting – the array is not a datamember of 'object', but of 'object.inner') Accessing index 'i' of that array would, in Bash++, take the form: @object.inner.array[$i] But the compiled code's version of the reference would have to take a slightly different form, Since we have to dereference the pointer to 'inner' before we can access 'array': bpp__objectClass__object__inner__array=${bpp__objectClass__object__inner}__array This "bpp__objectClass__object__inner__array" evaluates to a STRING which is the variable name where the array is actually stored We then have to evaluate that string to get the actual values stored in the array: bpp__objectClass__object__inner__arrayString="${bpp__objectClass__object__inner__array}[${i}]"

This first line gives us a string such as "actual_array_variable_name[$i]"

This string is not a variable reference, but a string which represents the variable reference

eval bpp__objectClass__object__inner__arrayIndex="\${${bpp__objectClass__object__inner__arrayString}"}"

This second line gives us the actual value stored in the array at index 'i'

So, we have to follow a different procedure based on whether or not we have to dereference a pointer

To make this code less disgraceful, at some point, object references should be re-worked altogether In the meantime, we can do a HACKY fix by checking the size of the IDENTIFIER list If it's greater than 2, we're guaranteed to have to dereference a pointer If it's not, we're guaranteed not to have to dereference a pointer (unless the very first identifier refers to a pointer)

TODO(@rail5): Fix this. Really just fix object references from the ground-up

◆ exitObject_reference_as_lvalue()

void BashppListener::exitObject_reference_as_lvalue ( BashppParser::Object_reference_as_lvalueContext * ctx )

override

◆ exitOther_statement()

void BashppListener::exitOther_statement ( BashppParser::Other_statementContext * ctx )

override

◆ exitParameter()

void BashppListener::exitParameter ( BashppParser::ParameterContext * ctx )

override

◆ exitPointer_declaration()

void BashppListener::exitPointer_declaration ( BashppParser::Pointer_declarationContext * ctx )

override

◆ exitPointer_dereference()

void BashppListener::exitPointer_dereference ( BashppParser::Pointer_dereferenceContext * ctx )

override

◆ exitProgram()

void BashppListener::exitProgram ( BashppParser::ProgramContext * ctx )

override

◆ exitRaw_rvalue()

void BashppListener::exitRaw_rvalue ( BashppParser::Raw_rvalueContext * ctx )

override

◆ exitSelf_reference()

void BashppListener::exitSelf_reference ( BashppParser::Self_referenceContext * ctx )

override

◆ exitSelf_reference_as_lvalue()

void BashppListener::exitSelf_reference_as_lvalue ( BashppParser::Self_reference_as_lvalueContext * ctx )

override

◆ exitSinglequote_string()

void BashppListener::exitSinglequote_string ( BashppParser::Singlequote_stringContext * ctx )

override

◆ exitStatement()

void BashppListener::exitStatement ( BashppParser::StatementContext * ctx )

override

◆ exitString()

void BashppListener::exitString ( BashppParser::StringContext * ctx )

override

◆ exitSubshell()

void BashppListener::exitSubshell ( BashppParser::SubshellContext * ctx )

override

◆ exitSupershell()

void BashppListener::exitSupershell ( BashppParser::SupershellContext * ctx )

override

◆ exitTerminal_token()

void BashppListener::exitTerminal_token ( BashppParser::Terminal_tokenContext * ctx )

override

◆ exitValue_assignment()

void BashppListener::exitValue_assignment ( BashppParser::Value_assignmentContext * ctx )

override

Value assignments will appear in the following contexts:

Member declarations
Object instantiations
Pointer declarations
Object assignments

◆ generate_delete_code()

BashppListener::code_segment BashppListener::generate_delete_code	(	std::shared_ptr< bpp::bpp_object >	object,
		const std::string &	object_reference_string,
		bool	force_pointer = `false`
	)

Generates a code segment for deleting an object.

This function constructs a code segment to delete an object. The generated code includes:

A call to the object's destructor if it has one.
A call to the object's delete function.

Parameters

object	The object to be deleted.
object_reference_string	The string representing the object's reference in the compiled code.
force_pointer	Whether to force the object to be treated as a pointer.

Returns

A code_segment structure containing the complete deletion code:

pre_code: The setup code including the destructor call.
post_code: The code for cleaning up the object's reference.
code: The expression to delete the object.

◆ generate_dynamic_cast_code()

BashppListener::code_segment BashppListener::generate_dynamic_cast_code	(	const std::string &	reference_code,
		const std::string &	class_name
	)

Generates a code segment for performing a dynamic cast.

This function constructs a code segment to perform a dynamic cast on an object. The generated code includes:

A runtime check to verify the cast is valid.
A substitution of either the address of the cast object or the nullptr value.

Parameters

reference_code	The code representing the object reference
class_name	The type to which we want to cast

Returns

A code segment structure containing the complete dynamic cast code:

pre_code: Call to the runtime dynamic cast function
post_code: Code for cleaning up the dynamic cast's temporary variable
code: The temporary variable containing the result of the dynamic cast (either the address or the @nullptr value)

◆ generate_method_call_code()

BashppListener::code_segment BashppListener::generate_method_call_code	(	const std::string &	reference_code,
		const std::string &	method_name,
		std::shared_ptr< bpp::bpp_class >	assumed_class
	)

Generates a code segment for calling a method.

This function constructs a code segment to call a method on an object. The generated code includes:

A lookup in the object's vTable if the method is virtual.
A call to the method.

Parameters

reference_code	The code representing the object reference.
method_name	The name of the method to be called.
assumed_class	The class to which the object is assumed to belong at compile-time.

Returns

A code_segment structure containing the complete method call code:

pre_code: The setup code including the vTable lookup.
post_code: The code for cleaning up the vTable lookup.
code: The expression to call the method.

◆ generate_supershell_code()

BashppListener::code_segment BashppListener::generate_supershell_code ( const std::string & code_to_run_in_supershell )

Generates a supershell code segment for executing a bash command.

This function constructs a code segment to run a specified command in a supershell. It creates a unique function name and output variable using a global counter. The generated code includes:

A bash function definition wrapping the given command.
A command to invoke the function and store its output, either appended to a while condition or added to the precode.
Cleanup commands that unset the dynamically created function and output variable.

Parameters

code_to_run_in_supershell The bash command to be executed within the supershell.

Returns

A code_segment structure containing the complete supershell execution code:

pre_code: The setup code including the function definition and invocation.
post_code: The code for cleaning up the defined environment.
code: An expression referencing the supershell output variable.

◆ get_include_stack()

std::stack< std::string > BashppListener::get_include_stack ( )

◆ get_included_files()

std::set< std::string > BashppListener::get_included_files ( )

◆ get_program()

std::shared_ptr< bpp::bpp_program > BashppListener::get_program ( )

◆ is_protected_keyword()

bool BashppListener::is_protected_keyword ( const std::string & keyword )

inlineprivate

◆ set_arguments()

void BashppListener::set_arguments ( std::vector< char * > arguments )

◆ set_dynamic_linking()

void BashppListener::set_dynamic_linking ( bool dynamic_linking )

◆ set_errors()

void BashppListener::set_errors ( )

Sets the program_has_errors flag to true.

This function is called when a syntax error is encountered during parsing.

◆ set_include_paths()

void BashppListener::set_include_paths ( std::shared_ptr< std::vector< std::string >> include_paths )

◆ set_included()

void BashppListener::set_included ( bool included )

◆ set_included_from()

void BashppListener::set_included_from ( BashppListener * included_from )

Sets the included_from pointer to the given listener.

◆ set_output_file()

void BashppListener::set_output_file ( std::string output_file )

◆ set_output_stream()

void BashppListener::set_output_stream ( std::shared_ptr< std::ostream > output_stream )

◆ set_run_on_exit()

void BashppListener::set_run_on_exit ( bool run_on_exit )

◆ set_source_file()

void BashppListener::set_source_file ( std::string source_file )

◆ set_suppress_warnings()

void BashppListener::set_suppress_warnings ( bool suppress_warnings )

Member Data Documentation

◆ arguments

BashppListener::arguments = {}

private

Command-line arguments to pass to the compiled program if run_on_exit is true.

◆ current_while_condition

std::shared_ptr<bpp::bash_while_condition> BashppListener::current_while_condition = nullptr

private

◆ dynamic_linking

bool BashppListener::dynamic_linking = false

private

◆ entity_stack

BashppListener::entity_stack

private

A stack to keep track of the current entity being processed.

For example, when we encounter a class definition, we push the class onto the entity_stack. Then, inside that class, when we encounter a method definition, we push the method onto the entity_stack. Inside that method, when we encounter a value assignment, we push the value assignment onto the entity_stack. When we're done with the value assignment, we pop it off the entity_stack, so that the method is now at the top of the stack. When we're done with the method, we pop it off the entity_stack, so that the class is now at the top of the stack. When we're done with the class, we pop it off the entity_stack, so that the program is now at the top of the stack.

◆ error_context

antlr4::ParserRuleContext* BashppListener::error_context = nullptr

private

◆ error_thrown

bool BashppListener::error_thrown = false

private

◆ in_comment

bool BashppListener::in_comment = false

private

◆ in_singlequote_string

bool BashppListener::in_singlequote_string = false

private

◆ in_while_condition

bool BashppListener::in_while_condition = false

private

◆ include_paths

BashppListener::include_paths = nullptr

private

A list of paths to search for included files.

◆ include_stack

BashppListener::include_stack

private

A chain of included files, from the main file to the current file (used for error reporting)

◆ included

bool BashppListener::included = false

private

◆ included_files

BashppListener::included_files = {}

private

A set of (unique) included files (used for '@include_once' directives)

◆ included_from

BashppListener* BashppListener::included_from = nullptr

private

◆ output_file

std::string BashppListener::output_file

private

◆ output_stream

BashppListener::output_stream

private

Pointer to the output stream to write the compiled code to.

◆ primitive

std::shared_ptr<bpp::bpp_class> BashppListener::primitive

private

◆ program

std::shared_ptr<bpp::bpp_program> BashppListener::program = std::make_shared<bpp::bpp_program>()

private

◆ program_has_errors

bool BashppListener::program_has_errors = false

private

◆ protected_keywords

constexpr const char* BashppListener::protected_keywords[]

staticconstexprprivate

Initial value:

= {
            "class", "constructor", "delete", "destructor",
            "dynamic_cast", "include", "include_once", "method",
            "new", "nullptr", "primitive", "private",
            "protected", "public", "this", "virtual"
        }

◆ run_on_exit

bool BashppListener::run_on_exit = false

private

◆ source_file

BashppListener::source_file

private

Path to the source file being compiled (used for error reporting)

◆ suppress_warnings

bool BashppListener::suppress_warnings = false

private

The documentation for this class was generated from the following files:

src/listener/BashppListener.h
src/listener/BashppListener.cpp
src/listener/handlers/array_index.cpp
src/listener/handlers/array_value.cpp
src/listener/handlers/bash_arithmetic.cpp
src/listener/handlers/bash_case_statement.cpp
src/listener/handlers/bash_for_loop.cpp
src/listener/handlers/bash_if_statement.cpp
src/listener/handlers/bash_while_loop.cpp
src/listener/handlers/class_body_statement.cpp
src/listener/handlers/class_definition.cpp
src/listener/handlers/constructor_definition.cpp
src/listener/handlers/delete_statement.cpp
src/listener/handlers/deprecated_subshell.cpp
src/listener/handlers/destructor_definition.cpp
src/listener/handlers/dynamic_cast.cpp
src/listener/handlers/extra_statement.cpp
src/listener/handlers/general_statement.cpp
src/listener/handlers/heredoc.cpp
src/listener/handlers/include_statement.cpp
src/listener/handlers/member_declaration.cpp
src/listener/handlers/method_definition.cpp
src/listener/handlers/new_statement.cpp
src/listener/handlers/nullptr_ref.cpp
src/listener/handlers/object_address.cpp
src/listener/handlers/object_assignment.cpp
src/listener/handlers/object_instantiation.cpp
src/listener/handlers/object_reference.cpp
src/listener/handlers/object_reference_as_lvalue.cpp
src/listener/handlers/other_statement.cpp
src/listener/handlers/parameter.cpp
src/listener/handlers/pointer_declaration.cpp
src/listener/handlers/pointer_dereference.cpp
src/listener/handlers/program.cpp
src/listener/handlers/raw_rvalue.cpp
src/listener/handlers/self_reference.cpp
src/listener/handlers/self_reference_as_lvalue.cpp
src/listener/handlers/singlequote_string.cpp
src/listener/handlers/statement.cpp
src/listener/handlers/string.cpp
src/listener/handlers/subshell.cpp
src/listener/handlers/supershell.cpp
src/listener/handlers/terminal_token.cpp
src/listener/handlers/value_assignment.cpp

Classes

Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ enterArray_index()

◆ enterArray_value()

◆ enterBash_arithmetic()

◆ enterBash_case_pattern()

◆ enterBash_case_pattern_header()

◆ enterBash_case_statement()

◆ enterBash_for_header()

◆ enterBash_for_loop()

◆ enterBash_if_condition()

◆ enterBash_if_else_branch()

◆ enterBash_if_root_branch()

◆ enterBash_if_statement()

◆ enterBash_while_condition()

◆ enterBash_while_loop()

◆ enterClass_body_statement()

◆ enterClass_definition()

◆ enterConstructor_definition()

◆ enterDelete_statement()

◆ enterDeprecated_subshell()

◆ enterDestructor_definition()

◆ enterDynamic_cast_statement()

◆ enterExtra_statement()

◆ enterGeneral_statement()

◆ enterHeredoc()

◆ enterHeredoc_header()

◆ enterInclude_statement()

◆ enterMember_declaration()

◆ enterMethod_definition()

◆ enterNew_statement()

◆ enterNullptr_ref()

◆ enterObject_address()

◆ enterObject_assignment()

◆ enterObject_instantiation()

◆ enterObject_reference()

◆ enterObject_reference_as_lvalue()

◆ enterOther_statement()

◆ enterParameter()

◆ enterPointer_declaration()

◆ enterPointer_dereference()

◆ enterProgram()

◆ enterRaw_rvalue()

◆ enterSelf_reference()

◆ enterSelf_reference_as_lvalue()

◆ enterSinglequote_string()

◆ enterStatement()

◆ enterString()

◆ enterSubshell()

◆ enterSupershell()

◆ enterTerminal_token()

◆ enterValue_assignment()

◆ exitArray_index()

◆ exitArray_value()

◆ exitBash_arithmetic()

◆ exitBash_case_pattern()

◆ exitBash_case_pattern_header()

◆ exitBash_case_statement()

◆ exitBash_for_header()

◆ exitBash_for_loop()

◆ exitBash_if_condition()

◆ exitBash_if_else_branch()

◆ exitBash_if_root_branch()

◆ exitBash_if_statement()

◆ exitBash_while_condition()

◆ exitBash_while_loop()

◆ exitClass_body_statement()

◆ exitClass_definition()

◆ exitConstructor_definition()

◆ exitDelete_statement()

◆ exitDeprecated_subshell()

◆ exitDestructor_definition()

◆ exitDynamic_cast_statement()

◆ exitExtra_statement()

◆ exitGeneral_statement()