module Crystal

Defined in:

crystal/datum.cr
crystal/dwarf.cr
crystal/dwarf/abbrev.cr
crystal/dwarf/info.cr
crystal/dwarf/line_numbers.cr
crystal/dwarf/strings.cr
crystal/elf.cr
crystal/main.cr
crystal/small_deque.cr
crystal/tracing.cr

Constant Summary

BUILD_COMMIT = "dacd97bcc"

The build commit identifier of the Crystal compiler.

BUILD_DATE = "2024-10-09"

The build date of the Crystal compiler.

CACHE_DIR = "/home/crystaldoc/.cache/crystal"

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.

DEFAULT_PATH = "$ORIGIN/../share/crystal/src"

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.

DESCRIPTION = "Crystal 1.14.0 [dacd97bcc] (2024-10-09)\n\nLLVM: 18.1.6\nDefault target: x86_64-unknown-linux-gnu\n"

Full version information of the Crystal compiler. Equivalent to crystal --version.

HOST_TRIPLE = "x86_64-unknown-linux-gnu"

The LLVM target triple of the host system (the machine that the compiler runs on).

LIBRARY_PATH = "/usr/bin/../lib/crystal"

Colon-separated paths where the compiler searches for (binary) libraries.

The value is defined by the environment variables CRYSTAL_LIBRARY_PATH.

LLVM_VERSION = "18.1.6"

The version of LLVM used by the Crystal compiler.

PATH = "lib:/srv/crystaldoc.info/github-crystal-lang-crystal-1.14.0/src"

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.

TARGET_TRIPLE = "x86_64-unknown-linux-gnu"

The LLVM target triple of the target system (the machine that the compiler builds for).

VERSION = "1.14.0"

The version of the Crystal compiler.

Class Method Summary

Class Method Detail

def self.main(&) #

Defines the main routine run by normal Crystal programs:

  • Initializes the GC
  • Invokes the given block
  • Handles unhandled exceptions
  • Invokes at_exit handlers
  • Flushes STDOUT and STDERR

This method can be invoked if you need to define a custom main (as in C main) function, doing all the above steps.

For example:

fun main(argc : Int32, argv : UInt8**) : Int32
  Crystal.main do
    elapsed = Time.measure do
      Crystal.main_user_code(argc, argv)
    end
    puts "Time to execute program: #{elapsed}"
  end
end

Note that the above is really just an example, almost the same can be accomplished with at_exit. But in some cases redefinition of C's main is needed.


[View source]
def self.main(argc : Int32, argv : Pointer(Pointer(UInt8))) #

Main method run by all Crystal programs at startup.

This setups up the GC, invokes your program, rescuing any handled exception, and then runs at_exit handlers.

This method is automatically invoked for you, so you don't need to invoke it.

However, if you need to define a special main C function, you can redefine main and invoke Crystal.main from it:

fun main(argc : Int32, argv : UInt8**) : Int32
  # some setup before Crystal main
  Crystal.main(argc, argv)
  # some cleanup logic after Crystal main
end

The Crystal.main can also be passed as a callback:

fun main(argc : Int32, argv : UInt8**) : Int32
  LibFoo.init_foo_and_invoke_main(argc, argv, ->Crystal.main(Int32, UInt8**))
end

Note that before Crystal.main is invoked the GC is not setup yet, so nothing that allocates memory in Crystal (like new for classes) can be used.


[View source]
def self.main_user_code(argc : Int32, argv : Pointer(Pointer(UInt8))) #

Executes the main user code. This normally is executed after initializing the GC and before executing at_exit handlers.

You should never invoke this method unless you need to redefine C's main function. See Crystal.main for more details.


[View source]
def self.trace(section : Tracing::Section, operation : String, time : UInt64 | Nil = nil, **metadata, &) #

[View source]
def self.trace(section : Tracing::Section, operation : String, time : UInt64 | Nil = nil, **metadata) #

[View source]