functions.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-misc/pointers.hpp>
#include <gyoji-mir/types.hpp>
#include <gyoji-mir/operations.hpp>
 
#include <string>
#include <map>
#include <vector>
 
namespace Gyoji::mir {
    class Function;
    class SimpleStatement;
    class BasicBlock;
    class OperationVisitor;
    
    class Functions {
    public:
    Functions();
 
    ~Functions();
 
    void add_function(Gyoji::owned<Function> _function);
 
    const std::vector<Gyoji::owned<Function>> & get_functions() const;
 
    void dump(FILE *out) const;
    
    private:
    std::vector<Gyoji::owned<Function>> functions;
    };
    
    class BasicBlock {
    public:
    BasicBlock();
    ~BasicBlock();
 
    void add_operation(Gyoji::owned<Operation> operation);
 
    size_t size() const;
 
    void insert_operation(size_t position, Gyoji::owned<Operation> operation);
    
    const std::vector<Gyoji::owned<Operation>> & get_operations() const;
 
    void dump(FILE *out) const;
 
    bool contains_terminator() const;
 
    std::vector<size_t> get_connections() const;
 
    const std::vector<size_t> & get_reachable_from() const;
    
    bool is_reachable() const;
    void add_reachable_from(size_t other_block);
    private:
    std::vector<Gyoji::owned<Operation>> operations;
    std::vector<size_t> reachable_from;
    bool start_block;
    };
 
    class FunctionArgument {
    public:
    FunctionArgument(
        std::string & _name,
        const Type *_type,
        const Gyoji::context::SourceReference & _name_source_ref,
        const Gyoji::context::SourceReference & _type_source_ref
        );
    FunctionArgument(const FunctionArgument & _other);
    ~FunctionArgument();
 
    const std::string & get_name() const;
    
    const Type * get_type() const;
 
    const Gyoji::context::SourceReference & get_type_source_ref() const;
    const Gyoji::context::SourceReference & get_name_source_ref() const;
    
    private:
    std::string name;
    const Type * type;
    const Gyoji::context::SourceReference & name_source_ref;
    const Gyoji::context::SourceReference & type_source_ref;
    };
 
    class Function {
    public:
    Function(
        std::string _name,
        const Type *_return_type,
        const std::vector<FunctionArgument> & _arguments,
        bool _is_unsafe,
        const Gyoji::context::SourceReference & _source_ref
        );
    ~Function();
 
    const std::string & get_name() const;
 
    const Type *get_return_type() const;
    
    const std::vector<FunctionArgument> & get_arguments() const;
 
    const BasicBlock & get_basic_block(size_t blockid) const;
 
    void add_operation(size_t blockid, Gyoji::owned<Operation> operation);
 
    void insert_operation(size_t blockid, size_t operation_index, Gyoji::owned<Operation> operation);
    
    size_t add_block();
 
    const std::map<size_t, Gyoji::owned<BasicBlock>> & get_blocks() const;
 
    void dump(FILE *out) const;
 
    const Gyoji::context::SourceReference & get_source_ref() const;
 
    bool is_unsafe() const;
 
    const Type *tmpvar_get(size_t tmpvar_id) const;
    size_t tmpvar_define(const Type *tmpvar_type);
 
    const Operation * tmpvar_get_operation(size_t tmpvar) const;
 
    size_t tmpvar_duplicate(size_t tmpvar_id);
    
    void calculate_block_reachability();
 
    void iterate_operations(OperationVisitor & visitor) const;
    
    private:
    const std::string name;
    const Type *return_type;
    std::vector<FunctionArgument> arguments;
    bool m_is_unsafe;
    
    const Gyoji::context::SourceReference & source_ref;
    
    // Holds the max blockid
    // as we build them.
    size_t blockid;
    std::map<size_t, Gyoji::owned<BasicBlock>> blocks;
    std::vector<const Type*> tmpvars;
    std::map<size_t, Operation*> tmpvar_operations;
    };
 
    class OperationVisitor {
    public:
    OperationVisitor();
    ~OperationVisitor();
    virtual void visit(
        size_t block_id,
        const BasicBlock & block,
        size_t operation_index,
        const Operation & operation
        ) = 0;
    };
    
};