Compiler_Frontend.H

Go to the documentation of this file.

/*
                          Aleph_w
 
  Data structures & Algorithms
  version 2.0.0b
  https://github.com/lrleon/Aleph-w
 
  This file is part of Aleph-w library
 
  Copyright (c) 2002-2026 Leandro Rabindranath Leon
 
  Permission is hereby granted, free of charge, to any person obtaining a copy
  of this software and associated documentation files (the "Software"), to deal
  in the Software without restriction, including without limitation the rights
  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  copies of the Software, and to permit persons to whom the Software is
  furnished to do so, subject to the following conditions:
 
  The above copyright notice and this permission notice shall be included in all
  copies or substantial portions of the Software.
 
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  SOFTWARE.
*/
 
#ifndef COMPILER_FRONTEND_H
#define COMPILER_FRONTEND_H
 
#include <string_view>
 
#include <Compiler_Driver_Contracts.H>
#include <Compiler_IR_Model.H>
#include <Compiler_Module_Metadata.H>
#include <Compiler_Module_Resolver.H>
#include <ah-diagnostics.H>
 
namespace Aleph
{
  class Compiler_Frontend
  {
  public:
    virtual ~Compiler_Frontend() = default;
 
    [[nodiscard]] virtual const char *
    name() const noexcept = 0;
 
    virtual void
    clear() noexcept = 0;
 
    virtual bool
    load_sources(const DynArray<Compiler_Driver_Source> & inputs) = 0;
 
    virtual bool
    parse() = 0;
 
    virtual bool
    analyze() = 0;
 
    virtual bool
    lower_hir() = 0;
 
    virtual bool
    lower_ir() = 0;
 
    [[nodiscard]] virtual Diagnostic_Engine *
    diagnostic_engine() noexcept = 0;
 
    [[nodiscard]] virtual const Diagnostic_Engine *
    diagnostic_engine() const noexcept = 0;
 
    [[nodiscard]] virtual const Compiler_Type_Context *
    type_context() const noexcept = 0;
 
    [[nodiscard]] virtual const Compiler_HIR_Module *
    hir_module() const noexcept = 0;
 
    [[nodiscard]] virtual const Compiler_IR_Module *
    ir_module() const noexcept = 0;
 
    [[nodiscard]] virtual const DynArray<Compiler_Module_Descriptor> &
    module_descriptors() const noexcept
    {
      static const DynArray<Compiler_Module_Descriptor> empty;
      return empty;
    }
 
    [[nodiscard]] virtual const DynArray<size_t> &
    module_merge_order() const noexcept
    {
      static const DynArray<size_t> empty;
      return empty;
    }
 
    [[nodiscard]] virtual const DynArray<Compiler_Module_Metadata> &
    module_metadata() const noexcept
    {
      static const DynArray<Compiler_Module_Metadata> empty;
      return empty;
    }
 
    [[nodiscard]] virtual const DynArray<Compiler_Driver_Artifact> &
    artifacts() const noexcept = 0;
 
    [[nodiscard]] virtual const Compiler_Driver_Artifact *
    find_artifact(std::string_view label) const noexcept = 0;
 
    [[nodiscard]] virtual const DynArray<std::string> &
    errors() const noexcept = 0;
 
    [[nodiscard]] virtual const DynArray<std::string> &
    warnings() const noexcept = 0;
  };
}
 
#endif