README.md

Idris 2

This is the bootstrapping version of Idris 2, the successor to Idris. Its sole purpose is to build Idris 2 proper. Most likely, you will want to install that directly, unless you're following the bootstrapping path from scratch.

*** Please note: To build, this requires Idris version 1.3.2 ***

Idris 2 is mostly backwards compatible with Idris 1, with some minor exceptions. The most notable user visible differences, which might cause Idris 1 programs to fail to type check, are:

• Unbound implicit arguments are always erased, so it is a type error to attempt to pattern match on one.

• Simplified resolution of ambiguous names, which might mean you need to explicitly disambiguate more often. As a general rule, Idris 2 will be able to disambiguate between names which have different concrete return types (such as data constructors), or which have different concrete argument types (such as record projections). It may struggle to resolve ambiguities if one name requires an interface to be resolved.

• Minor differences in the meaning of export modifiers private, export, and public export, which now refer to visibility of names from other namespaces rather than visibility from other files.

• Module names must match the filename in which they are defined (unless the module's name is "Main").

• Anything which uses a %language pragma in Idris 1 is likely to be different. Notably, elaborator reflection will exist, but most likely in a slightly different form because the internal details of the elaborator are different.

• The Prelude is much smaller (and easier to replace with an alternative).

• let x = val in e no longer computes with x in e, instead being essentially equivalent to (\x => e) val. This is to make the behaviour of let consistent in the presence of case and with (where it is hard to push the computation inside the case/with efficiently). Instead, you can define functions locally with let, which do have computational force, as follows:

  let x : ?
      x = val in
      e
  

Watch this space for more details and the rationale for the changes, as I get around to writing it...

Summary of new features:

• A core language based on "Quantitative Type Theory" which allows explicit annotation of erased types, and linear types.
• let bindings are now more expressive, and can be used to define pattern matching functions locally.
• Names which are in scope in a type are also always in scope in the body of the corresponding definition.
• Better inference. Holes are global to a source file, rather than local to a definition, meaning that some holes can be left in function types to be inferred by the type checker. This also gives better inference for the types of case expressions, and means fewer annotations are needed in interface declarations.
• Better type checker implementation which minimises the need for compile time evaluation.
• New Chez Scheme based back end which both compiles and runs faster than the default Idris 1 back end. (Also, optionally, Racket and Gambit can be used as targets).
• Everything works faster :).

A significant change in the implementation is that there is an intermediate language TTImp, which is essentially a desugared Idris, and is cleanly separated from the high level language which means it is potentially usable as a core language for other high level syntaxes.

Installation

To build and install what exists of it so far:

• Optionally, set the PREFIX in Makefile
• make idris2
• make install

You'll need to set your PATH to $PREFIX/bin You may also want to set IDRIS_CC to clang, since this seems to build the generated C significantly faster.

Note: If you edit idris2.ipkg to use the opts with optimisation set (--cg-opt -O2) you'll find it runs about twice as fast, at the cost of taking a couple of minutes to generate the idris2 executable.

You can check that building succeeded by running

• make test

I make no promises how well this works yet, but you are welcome to have a play. Good luck :).

Information about external dependencies are presented in INSTALL.md.

Build with Maven

• To install with tests: mvn install
• To install without tests mvn install -DskipTests
• To recompile libraries without building compiler mvn install -DskipIdrisCompile
• To recompile without building libraries mvn install -DskipIdrisInstallLibrary
• To run all JVM tests mvn -f jvm-assembler/pom.xml exec:exec@idris-test -Didris.tests="only=jvm"
• To run a single JVM test mvn -f jvm-assembler/pom.xml exec:exec@idris-test -Didris.tests="only=jvm/jvm001"

Things still missing

• Disambiguation via 'with'
• Cumulativity (so we currently have Type : Type! Bear that in mind when you think you've proved something :))
• 'rewrite' doesn't yet work on dependent types
• Parts of the ide-mode, particularly syntax highlighting
• Documentation strings and HTML documentation generation
• ':search' and ':apropos' at the REPL
• Metaprogramming (reflection, partial evaluation)

Talks