polserver/pol-core/bscript/compiler/codegen/InstructionEmitter.h
Kevin Eady e41f70d72e
Add support for interpolated strings ("interstrings") (#369)
* Update grammar to support interpolated strings

* Struct initializers, case switchs are regular strings

* Initial stub for interpolated string in AST
This splits the previous STRING_LITERAL terminal into a production,
stringLiteral, to handle REGULAR_STRING terminal and interpolatedString
production.

* Change interpolated strings to expressions

* Fix mode handling in grammar

* Grammar fixes
- Fix mode handling in lexer
- Interpolated strings only have one expression

* Can successfully parse, stub compile interstrings
$"He {there + print("hello")}";

* Add formatting string to grammar

* Fix tests, and add test stubs

* Rename curleys to brace; better AST generation

* initial work interstring instruction

* Initial work on formatted string instruction: emit

* Formatted string instruction: execution

* Add simple formatted string test

* Add formatted string test src

* Review changes #1
- Rename `FormattedString` to `FormatExpression`
- Rename overloaded `try_to_format()` to `get_formatted()`

* Review changes part 2
- Rename `InterpolatedString` ast node to `InterpolateString`

* Review changes part 3
- Modify `ins_interpolate_string`

* Review changes part 4
- Remove unused formal parameter

* Add negative tests

* Spruce up positive tests

* Fix braces, escape chars inside interstring

* Fix, add tests for escaped char and double brace

* Address differences for new lines in tests

* Update Escript version

* Make empty expression an error

* Add documentation for interpolated strings

* Quick touchup on docs
2021-03-11 22:48:16 +01:00

139 lines
4.5 KiB
C++

#ifndef POLSERVER_INSTRUCTIONEMITTER_H
#define POLSERVER_INSTRUCTIONEMITTER_H
#include <memory>
#include <string>
#include <vector>
#ifndef OBJMEMBERS_H
#include "objmembers.h"
#endif
#ifndef OBJMETHODS_H
#include "objmethods.h"
#endif
#ifndef __TOKENS_H
#include "tokens.h"
#endif
#include "bscript/compiler/codegen/CodeEmitter.h"
#include "bscript/compiler/codegen/DataEmitter.h"
#include "bscript/compiler/representation/CompiledScript.h"
#include "bscript/compiler/representation/DebugStore.h"
namespace Pol::Bscript
{
class StoredToken;
}
namespace Pol::Bscript::Compiler
{
class CaseJumpDataBlock;
class CompiledScript;
class FlowControlLabel;
class LocalVariableScopeInfo;
class ModuleDeclarationRegistrar;
class ModuleFunctionDeclaration;
class Node;
class Variable;
class SourceLocation;
class InstructionEmitter
{
public:
InstructionEmitter( CodeSection& code, DataSection& data, DebugStore& debug,
ExportedFunctions& exported_functions, ModuleDeclarationRegistrar& );
void initialize_data();
void register_exported_function( FlowControlLabel& label, const std::string& name,
unsigned arguments );
unsigned enter_debug_block( const LocalVariableScopeInfo& );
void set_debug_block( unsigned );
void access_variable( const Variable& );
void array_append();
void array_create();
void array_declare();
void assign();
void assign_subscript_consume();
void assign_subscript();
void assign_multisubscript( unsigned indexes );
void assign_variable( const Variable& );
void basic_for_init( FlowControlLabel& );
void basic_for_next( FlowControlLabel& );
void binary_operator( BTokenId token_id );
void call_method( const std::string& name, unsigned argument_count );
void call_method_id( MethodID method_id, unsigned argument_count );
void call_modulefunc( const ModuleFunctionDeclaration& );
void call_userfunc( FlowControlLabel& );
unsigned casejmp();
unsigned case_dispatch_table( const CaseJumpDataBlock& );
void consume();
void ctrl_statementbegin( unsigned file_index, unsigned file_offset,
const std::string& source_text );
void declare_variable( const Variable& );
void dictionary_create();
void dictionary_add_member();
void error_create();
void exit();
void foreach_init( FlowControlLabel& );
void foreach_step( FlowControlLabel& );
void function_reference( unsigned parameter_count, FlowControlLabel& );
void get_arg( const std::string& name );
void get_member( const std::string& name );
void get_member_id( MemberID );
void jmp_always( FlowControlLabel& );
void jmp_if_false( FlowControlLabel& );
void jmp_if_true( FlowControlLabel& );
void label( FlowControlLabel& );
void leaveblock( unsigned local_vars_to_remove );
void makelocal();
void pop_param( const std::string& name );
void pop_param_byref( const std::string& name );
void progend();
void return_from_user_function();
unsigned skip_if_true_else_consume();
void set_member( const std::string& name );
void set_member_id( MemberID member_id );
void set_member_id_consume( MemberID member_id );
void set_member_consume( const std::string& name );
void set_member_by_operator( BTokenId, MemberID );
void struct_create();
void struct_add_uninit_member( const std::string& name );
void struct_add_member( const std::string& name );
void subscript_single();
void subscript_multiple( unsigned indexes );
void unary_operator( BTokenId );
void uninit();
void value( double );
void value( int );
void value( const std::string& );
void interpolate_string( unsigned count );
void format_expression();
void debug_file_line( unsigned file_index, unsigned line_number );
void debug_statementbegin();
unsigned next_instruction_address();
void debug_user_function( const std::string& name, unsigned first_address,
unsigned last_address );
void patch_offset( unsigned index, unsigned offset );
private:
unsigned emit_data( const std::string& );
unsigned emit_token( BTokenId id, BTokenType type, unsigned offset = 0 );
unsigned append_token( StoredToken& );
void register_with_label( FlowControlLabel&, unsigned offset );
CodeEmitter code_emitter;
DataEmitter data_emitter;
DebugStore& debug;
ExportedFunctions& exported_functions;
ModuleDeclarationRegistrar& module_declaration_registrar;
DebugStore::InstructionInfo debug_instruction_info{};
};
} // namespace Pol::Bscript::Compiler
#endif // POLSERVER_INSTRUCTIONEMITTER_H