Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document builtin constants #14276

Merged
merged 3 commits into from
Jan 31, 2024
Merged

Document builtin constants #14276

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
31bb2ad
Document builtin constants
straight-shoota Jan 30, 2024
00de3a0
Skip unless building docs
straight-shoota Jan 30, 2024
7041fd6
fixup
straight-shoota Jan 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 66 additions & 25 deletions src/compiler/crystal/program.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -275,36 +275,77 @@ module Crystal
# Defines a predefined constant in the Crystal module, such as BUILD_DATE and VERSION.
private def define_crystal_constants
if build_commit = Crystal::Config.build_commit
define_crystal_string_constant "BUILD_COMMIT", build_commit
build_commit_const = define_crystal_string_constant "BUILD_COMMIT", build_commit
else
define_crystal_nil_constant "BUILD_COMMIT"
build_commit_const = define_crystal_nil_constant "BUILD_COMMIT"
end

define_crystal_string_constant "BUILD_DATE", Crystal::Config.date
define_crystal_string_constant "CACHE_DIR", CacheDir.instance.dir
define_crystal_string_constant "DEFAULT_PATH", Crystal::Config.path
define_crystal_string_constant "DESCRIPTION", Crystal::Config.description
define_crystal_string_constant "PATH", Crystal::CrystalPath.default_path
define_crystal_string_constant "LIBRARY_PATH", Crystal::CrystalLibraryPath.default_path
define_crystal_string_constant "LIBRARY_RPATH", Crystal::CrystalLibraryPath.default_rpath
define_crystal_string_constant "VERSION", Crystal::Config.version
define_crystal_string_constant "LLVM_VERSION", Crystal::Config.llvm_version
define_crystal_string_constant "HOST_TRIPLE", Crystal::Config.host_target.to_s
define_crystal_string_constant "TARGET_TRIPLE", Crystal::Config.host_target.to_s
end

private def define_crystal_string_constant(name, value)
define_crystal_constant name, StringLiteral.new(value).tap(&.set_type(string))
end

private def define_crystal_nil_constant(name)
define_crystal_constant name, NilLiteral.new.tap(&.set_type(self.nil))
end

private def define_crystal_constant(name, value)
build_commit_const.doc = <<-MD if wants_doc?
The build commit identifier of the Crystal compiler.
MD

define_crystal_string_constant "BUILD_DATE", Crystal::Config.date, <<-MD
The build date of the Crystal compiler.
MD
define_crystal_string_constant "CACHE_DIR", CacheDir.instance.dir, <<-MD
The cache directory configured for the Crystal compiler.

The value is defined by the environment variable `CRYSTAL_CACHE_DIR` and
defaults to the user's configured cache directory.
MD
define_crystal_string_constant "DEFAULT_PATH", Crystal::Config.path, <<-MD
The default Crystal path configured in the compiler. This value is baked
into the compiler and usually points to the accompanying version of the
standard library.
MD
define_crystal_string_constant "DESCRIPTION", Crystal::Config.description, <<-MD
Full version information of the Crystal compiler. Equivalent to `crystal --version`.
MD
define_crystal_string_constant "PATH", Crystal::CrystalPath.default_path, <<-MD
Colon-separated paths where the compiler searches for required source files.

The value is defined by the environment variable `CRYSTAL_PATH`
and defaults to `DEFAULT_PATH`.
MD
define_crystal_string_constant "LIBRARY_PATH", Crystal::CrystalLibraryPath.default_path, <<-MD
Colon-separated paths where the compiler searches for (binary) libraries.

The value is defined by the environment variables `CRYSTAL_LIBRARY_PATH`.
MD
define_crystal_string_constant "LIBRARY_RPATH", Crystal::CrystalLibraryPath.default_rpath, <<-MD
Colon-separated paths where the loader searches for dynamic libraries at runtime.

The value is defined by the environment variables `CRYSTAL_LIBRARY_RPATH`.
MD
define_crystal_string_constant "VERSION", Crystal::Config.version, <<-MD
The version of the Crystal compiler.
MD
define_crystal_string_constant "LLVM_VERSION", Crystal::Config.llvm_version, <<-MD
The version of LLVM used by the Crystal compiler.
MD
define_crystal_string_constant "HOST_TRIPLE", Crystal::Config.host_target.to_s, <<-MD
The LLVM target triple of the host system (the machine that the compiler runs on).
MD
define_crystal_string_constant "TARGET_TRIPLE", Crystal::Config.host_target.to_s, <<-MD
The LLVM target triple of the target system (the machine that the compiler builds for).
MD
end

private def define_crystal_string_constant(name, value, doc = nil)
define_crystal_constant name, StringLiteral.new(value).tap(&.set_type(string)), doc
end

private def define_crystal_nil_constant(name, doc = nil)
define_crystal_constant name, NilLiteral.new.tap(&.set_type(self.nil)), doc
end

private def define_crystal_constant(name, value, doc = nil) : Const
crystal.types[name] = const = Const.new self, crystal, name, value
const.no_init_flag = true
if doc && wants_doc?
const.doc = doc
end
predefined_constants << const
const
end

property(target_machine : LLVM::TargetMachine) { codegen_target.to_target_machine }
Expand Down
Loading