Skip to Content
DocumentationDocumentation

Documentation

This describes the structure and the main content of the documentation for Typir.

  • Getting started helps you to directly use Typir by describing the entry points of Typir.
  • Design describes the overall architecture of Typir and its main design decisions.
  • Use cases collects descriptions for the usual type checking use cases including validation and linking.

Services for type checking

Predefined types

The current set of predefined types:

  • Top and bottom types
  • Primitive types
  • Structurally typed classes
  • Custom types
  • Function types
  • Operators (are internally mappped to function types)

Bindings

While Typir (core) is language workbench-independent in general, some Typir bindings are provided for type-checking languages which are developed with a dedicated language workbench. Bindings usually provide all features of Typir core and add some more features and APIs to ease type checking with the target language workbench.

  • Typir (core) for any languages, developed with or without a language workbench
  • Typir-Langium for languages developed with Langium 
  • Test fixtures: some predefined AST nodes and adapted Typir service implementations to ease writing internal test cases for Typir itself, see predefined-language-nodes.ts

Customization

Typir provides a default implementation for all services, which are fine for many languages. To create type systems for languages where these default implementations are not enough, the customization section describes how to adapt nearly all parts of Typir in general. Beyond that, the sections about the services give some hints for interesting customizations in more detail.

If the predefined types are not enough for the current language, Typir provides an API to define custom types for your language.

Examples

This repository contains the following stand-alone applications. Read their linked README.md files to learn more about them:

  • LOX - static type checking for LOX, implemented with Typir-Langium
  • OX - a reduced version of LOX, implemented with Typir-Langium
  • Expressions - static type checking for a hand-written reduced expression language, implemented with Typir (core)

Some of the internal test cases developed in packages/typir/test/ demonstrate some features of Typir in more detail.

Last updated on
Typir-Langium