How to add a new built in function

Gabriel Gonzalez edited this page Jan 8, 2019 · 4 revisions

You can use the Haskell API to extend the Dhall configuration language with new built-in functions. This section contains a simple Haskell recipe to add a new Natural/equal built-in function of type:

Natural/equal : Natural  Natural  Bool

To do so, we:

  • extend the type-checking context to include the type of Natural/equal
  • extend the normalizer to evaluate all occurrences of Natural/equal

... like this:

-- example.hs

{-# LANGUAGE OverloadedStrings #-}

module Main where

import Dhall.Core (Expr(..), ReifiedNormalizer(..))

import qualified Data.Text.IO
import qualified Dhall
import qualified Dhall.Context
import qualified Lens.Family   as Lens

main :: IO ()
main = do
    text <- Data.Text.IO.getContents

    let startingContext = transform Dhall.Context.empty
            transform = Dhall.Context.insert "Natural/equal" naturalEqualType

            naturalEqualType =
                Pi "_" Natural (Pi "_" Natural Bool)

    let normalizer (App (App (Var "Natural/equal") (NaturalLit x)) (NaturalLit y)) =
            Just (BoolLit (x == y))
        normalizer _ =

    let inputSettings = transform Dhall.defaultInputSettings
            transform =
                  Lens.set Dhall.normalizer      (ReifiedNormalizer (pure . normalizer))
                . Lens.set Dhall.startingContext startingContext

    x <- Dhall.inputWithSettings inputSettings text

    Data.Text.IO.putStrLn x

Here is an example use of the above program:

$ ./example <<< 'if Natural/equal 2 (1 + 1) then "Equal" else "Not equal"'

Note that existing Dhall tools that type-check expressions will reject expressions containing unexpected free variable such as Natural/equal:

$ dhall <<< 'Natural/equal 2 (1 + 1)'

Use "dhall --explain" for detailed errors

Error: Unbound variable



You will need to either:

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.