path: root/tvix/eval/src/builtins/mod.rs

//! This module implements the builtins exposed in the Nix language.
//!
//! See //tvix/eval/docs/builtins.md for a some context on the
//! available builtins in Nix.

use std::{
    collections::{BTreeMap, HashMap},
    rc::Rc,
};

use crate::{
    errors::ErrorKind,
    value::{Builtin, NixAttrs, NixString, Value},
};

fn pure_builtins() -> Vec<Builtin> {
    vec![
        Builtin::new("abort", 1, |mut args| {
            return Err(
                ErrorKind::Abort(args.pop().unwrap().to_string()?.as_str().to_owned()).into(),
            );
        }),
        Builtin::new("isNull", 1, |args| {
            Ok(Value::Bool(matches!(args[0], Value::Null)))
        }),
        Builtin::new("throw", 1, |mut args| {
            return Err(
                ErrorKind::Throw(args.pop().unwrap().to_string()?.as_str().to_owned()).into(),
            );
        }),
        Builtin::new("toString", 1, |args| {
            // TODO: toString is actually not the same as Display
            Ok(Value::String(format!("{}", args[0]).into()))
        }),
    ]
}

fn builtins_set() -> NixAttrs {
    let mut map: BTreeMap<NixString, Value> = BTreeMap::new();

    for builtin in pure_builtins() {
        map.insert(builtin.name().into(), Value::Builtin(builtin));
    }

    NixAttrs::from_map(map)
}

/// Set of Nix builtins that are globally available.
pub fn global_builtins() -> HashMap<&'static str, Value> {
    let builtins = builtins_set();
    let mut globals: HashMap<&'static str, Value> = HashMap::new();

    // known global builtins from the builtins set.
    for global in &[
        "abort",
        "baseNameOf",
        "derivation",
        "derivationStrict",
        "dirOf",
        "fetchGit",
        "fetchMercurial",
        "fetchTarball",
        "fromTOML",
        "import",
        "isNull",
        "map",
        "placeholder",
        "removeAttrs",
        "scopedImport",
        "throw",
        "toString",
    ] {
        if let Some(builtin) = builtins.select(global) {
            globals.insert(global, builtin.clone());
        }
    }

    globals.insert("builtins", Value::Attrs(Rc::new(builtins)));

    globals
}