docs/syntax/macros.md
Enso provides a macro system that allows users to perform AST to AST transformations on the provided pieces of code. While many languages' macros provide their users with access to the compilation and type-checking phases (scala, for example), there are a few reasons that we don't want to:
<!-- MarkdownTOC levels="2,3" autolink="true" --> <!-- /MarkdownTOC -->The actionables for this section are:
- Fully specify the macro system.
- Fully specify the interactions between the parser-based macro system and the runtime.
Much like annotations on the JVM, annotations in Enso are tags that perform a purely syntactic transformation on the entity to which they are applied. The implementation of this requires both parser changes and support for user-defined macros, but for now it would be possible to work only with a set of hard-coded annotation macros.
Annotations can be arbitrarily nested, so a set of annotation macros become implicitly nested inside each other:
@derive Eq Debug
@make_magic
type Maybe a
use Nothing
type Just
The above example is logically translated to:
derive Eq Debug
make_magic
type Maybe a
use Nothing
type Just (value : a)
In the presence of annotations and macros, it becomes more and more important
that we are able to reserve words such as type to ensure that users can always
have a good sense of what the most common constructs in the language mean,
rather than allowing them to be overridden outside of the stdlib.
The naming of annotations follows the standard rules that Enso uses for naming its identifiers. This means that they can be in both referent or variable form as the annotation head is not a pattern context.
In order to make the language easier to debug, we have all types automatically
derive an interface DebugShow. This interface provides a function that will
print all the significant information about the value (e.g. locations, types,
source information, etc).