function-lowering.hpp

/* Copyright 2025 Jonathan S. Arney
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      https://github.com/jarney/gyoji/blob/master/LICENSE
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
#pragma once
 
#include <gyoji-mir.hpp>
#include <gyoji-frontend.hpp>
#include <gyoji-frontend/function-scope.hpp>
 
 
namespace Gyoji::frontend::lowering {
    class TypeLowering;
 
    class FunctionDefinitionLowering {
    public:
    FunctionDefinitionLowering(
        Gyoji::context::CompilerContext & _compiler_context,
        const Gyoji::frontend::tree::FileStatementFunctionDefinition & _function_definition,
        Gyoji::mir::MIR & _mir,
        TypeLowering & _type_lowering
        );
    ~FunctionDefinitionLowering();
 
    bool lower();
 
    private:
    // Private members
    Gyoji::context::CompilerContext & compiler_context;
    const Gyoji::frontend::tree::FileStatementFunctionDefinition & function_definition;
    Gyoji::mir::MIR & mir;
    TypeLowering & type_lowering;
        ScopeTracker scope_tracker;
    const Gyoji::mir::Type * class_type;
    const Gyoji::mir::Type * class_pointer_type;
    const Gyoji::mir::TypeMethod *method;
 
    bool is_method() const;
    
    Gyoji::owned<Gyoji::mir::Function> function;
    size_t current_block;
 
    // Private Methods
 
    // Returns the current point in the current block
    // where the 'unwindings' a 'goto' statement
    // will be placed.
    FunctionPoint get_current_point() const;
    
    bool numeric_widen(
        const Gyoji::context::SourceReference & _src_ref,
        size_t & _widen_var,
        const Gyoji::mir::Type *widen_to
        );
 
    
    bool create_constant_integer(
        const Gyoji::frontend::integers::ParseLiteralIntResult & parse_result,
        size_t & returned_tmpvar,
        const Gyoji::context::SourceReference & _src_ref
        );
    
    bool create_constant_integer_one(
        const Gyoji::mir::Type *type,
        size_t & returned_tmpvar,
        const Gyoji::context::SourceReference & _src_ref
        );
    
    bool create_incdec_operation(
        const Gyoji::context::SourceReference & src_ref,
        size_t & returned_tmpvar,
        const size_t & operand_tmpvar,
        bool is_increment,
        bool is_postfix
        );
    
    bool local_declare_or_error(
        const Gyoji::mir::Type *mir_type,
        const std::string & name,
        const Gyoji::context::SourceReference & source_ref
        );
 
    // Widen the shorter
    // of the two operands to be the
    // larger one.
    bool numeric_widen_binary_operation(
        const Gyoji::context::SourceReference & _src_ref,
        size_t & a_tmpvar,
        size_t & b_tmpvar,
        const Gyoji::mir::Type *atype,
        const Gyoji::mir::Type *btype,
        const Gyoji::mir::Type **widened
        );
    
    bool handle_binary_operation_arithmetic(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
    
    bool handle_binary_operation_logical(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
    
    bool handle_binary_operation_bitwise(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
 
    bool handle_binary_operation_shift(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
 
    bool handle_binary_operation_compare(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
 
    bool handle_binary_operation_assignment(
        const Gyoji::context::SourceReference & _src_ref,
        Gyoji::mir::Operation::OperationType type,
        size_t & returned_tmpvar,
        size_t a_tmpvar,
        size_t b_tmpvar
        );
 
    bool extract_from_expression_primary_identifier(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryIdentifier & expression);
    
    bool extract_from_expression_primary_nested(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryNested & expression);
    
    bool extract_from_expression_primary_literal_char(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryLiteralChar & expression);
    
    bool extract_from_expression_primary_literal_string(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryLiteralString & expression);
    
    bool extract_from_expression_primary_literal_int(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryLiteralInt & expression);
    
    bool extract_from_expression_primary_literal_float(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPrimaryLiteralFloat & expression);
    
    bool extract_from_expression_postfix_array_index(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPostfixArrayIndex & expression);
    
    bool check_function_call_signature(
        bool is_method,
        const std::vector<size_t> & passed_arguments,
        const std::vector<const Gyoji::context::SourceReference *> & passed_src_refs,
        const Gyoji::mir::Type *function_pointer_type,
        const Gyoji::context::SourceReference & src_ref    
        );
    
    bool extract_from_expression_postfix_function_call(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPostfixFunctionCall & expression);
    
    bool extract_from_expression_postfix_dot(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPostfixDot & expression);
    
    bool extract_from_expression_postfix_arrow(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPostfixArrow & expression);
    
    bool extract_from_expression_postfix_incdec(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionPostfixIncDec & expression);
    
    bool extract_from_expression_unary_prefix(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionUnaryPrefix & expression);
    
    bool extract_from_expression_unary_sizeof_type(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionUnarySizeofType & expression);
    
    bool extract_from_expression_binary(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionBinary & expression);
    
    bool extract_from_expression_trinary(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionTrinary & expression);
    
    bool extract_from_expression_cast(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::ExpressionCast & expression);
    
    bool extract_from_expression(
        size_t & returned_tmpvar,
        const Gyoji::frontend::tree::Expression & expression
        );
 
    bool extract_from_struct_initializer(
        size_t & initial_value_tmpvar,
        const Gyoji::frontend::tree::StructInitializerExpression & struct_initializer_expression
        );
    
    bool extract_from_statement_variable_declaration(
        const Gyoji::frontend::tree::StatementVariableDeclaration & statement
        );
    
    bool extract_from_statement_ifelse(
        const Gyoji::frontend::tree::StatementIfElse & statement
        );
    
    bool extract_from_statement_while(
        const Gyoji::frontend::tree::StatementWhile & statement
        );
    
    bool extract_from_statement_for(
        const Gyoji::frontend::tree::StatementFor & statement
        );
    
    bool extract_from_statement_switch(
        const Gyoji::frontend::tree::StatementSwitch & statement
        );
    
    bool extract_from_statement_label(
        const Gyoji::frontend::tree::StatementLabel & statement
        );
    
    bool extract_from_statement_break(
        const Gyoji::frontend::tree::StatementBreak & statement
        );
    
    bool extract_from_statement_continue(
        const Gyoji::frontend::tree::StatementContinue & statement
        );
    
    bool extract_from_statement_goto(
        const Gyoji::frontend::tree::StatementGoto & statement
        );
    
    bool extract_from_statement_return(
        const Gyoji::frontend::tree::StatementReturn & statement
        );
 
    size_t undeclare_local(
        const std::string & variable_name,
        const Gyoji::mir::Type *class_type,
        size_t basic_block_id,
        size_t location,
        const Gyoji::context::SourceReference & src_ref
        );
 
    void leave_scope(
        std::vector<std::string> & unwind,
        const Gyoji::context::SourceReference & src_ref
        );
    
    bool extract_from_statement_list(
        bool automatic_unwind,
        const Gyoji::frontend::tree::StatementList & statement_list
        );
    
    };
 
    class FunctionLowering {
    public:
    FunctionLowering(
        Gyoji::context::CompilerContext & _compiler_context,
        const Gyoji::frontend::ParseResult & _parse_result,
        Gyoji::mir::MIR & _mir,
        TypeLowering & _type_lowering
        );
    
    ~FunctionLowering();
 
    bool lower();
    private:
    Gyoji::context::CompilerContext & compiler_context;
    const Gyoji::frontend::ParseResult & parse_result;
    Gyoji::mir::MIR & mir;
    TypeLowering & type_lowering;
    
    bool extract_from_class_definition(const Gyoji::frontend::tree::ClassDefinition & definition);
    bool extract_from_namespace(
        const Gyoji::frontend::tree::FileStatementNamespace & namespace_declaration
        );
    bool extract_functions(const std::vector<Gyoji::owned<Gyoji::frontend::tree::FileStatement>> & statements);
    
    };
    
};