Files
carbon-lang/toolchain/codegen/codegen.h
T
Jon Ross-Perkins 1974e44fd9 Rename factory functions from 'Create' to 'Make' (#3706)
Similar to #3705, we actually have a mix of `Make` and `Create` in
factory functions too, so this PR is normalizing on `Make`. It's
intended to be consistent with the naming choice for Carbon factory
functions.

Note, MakeSyntheticBlock is the only one I feel a little weird about
because llvm's own APIs use Create, and this is essentially wrapping
LLVM calls. But the flipside is it also feels like a vague line to draw,
when we also differ from LLVM coding style in other ways.
2024-02-14 18:26:56 +00:00

52 lines
1.7 KiB
C++

// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
// Exceptions. See /LICENSE for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
#ifndef CARBON_TOOLCHAIN_CODEGEN_CODEGEN_H_
#define CARBON_TOOLCHAIN_CODEGEN_CODEGEN_H_
#include "llvm/IR/Module.h"
#include "llvm/Target/TargetMachine.h"
namespace Carbon {
class CodeGen {
public:
static auto Make(llvm::Module& module, llvm::StringRef target_triple,
llvm::raw_pwrite_stream& errors) -> std::optional<CodeGen>;
// Generates the object code file.
// Returns false in case of failure, and any information about the failure is
// printed to the error stream.
//
// Note that unlike the error stream, this requires a `pwrite` stream to allow
// patching the output.
auto EmitObject(llvm::raw_pwrite_stream& out) -> bool;
// Prints the assembly to stdout.
// Returns false in case of failure, and any information about the failure is
// printed to the error stream.
//
// Note that unlike the error stream, this requires a `pwrite` stream to allow
// patching the output.
auto EmitAssembly(llvm::raw_pwrite_stream& out) -> bool;
private:
explicit CodeGen(llvm::Module& module, llvm::raw_pwrite_stream& errors)
: module_(module), errors_(errors) {}
// Using the llvm pass emits either assembly or object code to dest.
// Returns false in case of failure, and any information about the failure is
// printed to the error stream.
auto EmitCode(llvm::raw_pwrite_stream& out, llvm::CodeGenFileType file_type)
-> bool;
llvm::Module& module_;
llvm::raw_pwrite_stream& errors_;
std::unique_ptr<llvm::TargetMachine> target_machine_;
};
} // namespace Carbon
#endif // CARBON_TOOLCHAIN_CODEGEN_CODEGEN_H_