gyoji-analysis.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-context.hpp>
 
namespace Gyoji::analysis {
 
    // Ultimately, we will want to
    // define a relation on program points
    // so that:
    //      pp(x, a) < pp(x, a)
    //      pp(x, a) < pp(x, a+1)
    // for all a.  and pp(x,y) < pp(w,z)
    // if and only if w is reachable from
    // x through the control-flow graph.
    
    class ProgramPoint {
    public:
    ProgramPoint(size_t _block_id, size_t _operation_index);
    ProgramPoint(const ProgramPoint & other);
    ~ProgramPoint();
    size_t block_id;
    size_t operation_index;
    };
    
    class AnalysisPass {
    public:
    AnalysisPass(Gyoji::context::CompilerContext & _compiler_context, std::string _name);
    virtual ~AnalysisPass();
    virtual void check(const Gyoji::mir::MIR & mir) const = 0;
    
    Gyoji::context::CompilerContext & get_compiler_context() const;
    const std::string & get_name() const;
    private:
    Gyoji::context::CompilerContext & compiler_context;
    std::string name;
    };
 
    class AnalysisPassTypeResolution : public AnalysisPass {
    public:
    AnalysisPassTypeResolution(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassTypeResolution();
    
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    void check_type(const Gyoji::mir::Type & type) const;
    };
 
    class AnalysisPassUnreachable : public AnalysisPass {
    public:
    AnalysisPassUnreachable(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassUnreachable();
    
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    void check(const Gyoji::mir::Function & function) const;
    void check_all_blocks_reachable(
        const Gyoji::mir::Function & function
        ) const;
    };
 
    class AnalysisPassBorrowChecker : public AnalysisPass {
    public:
    AnalysisPassBorrowChecker(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassBorrowChecker();
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    void check(const Gyoji::mir::Function & function) const;
    };
 
    class AnalysisPassReturnValues : public AnalysisPass {
    public:
    AnalysisPassReturnValues(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassReturnValues();
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    void check(const Gyoji::mir::Function & function) const;
    };
    
    class AnalysisPassVariableScopePairing : public AnalysisPass {
    public:
    AnalysisPassVariableScopePairing(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassVariableScopePairing();
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    void check(const Gyoji::mir::Function & function) const;
    };
 
    class AnalysisPassUseBeforeAssignment : public AnalysisPass {
    public:
    AnalysisPassUseBeforeAssignment(Gyoji::context::CompilerContext & _compiler_context);
    virtual ~AnalysisPassUseBeforeAssignment();
    virtual void check(const Gyoji::mir::MIR & mir) const;
    private:
    bool true_at(
        const Gyoji::mir::Function & function,
        std::map<size_t, bool> & already_checked,
        const std::vector<ProgramPoint> & true_points,
        const ProgramPoint & check_at
        ) const;
    
    void check(const Gyoji::mir::Function & function) const;
    };
    
};