Welcome to CoCoNut’s documentation!

CoCoNut is a framework to ease the construction of a compiler by providing a DSL to define the common compiler structure. From this specification, CoCoNut generates the boilerplate to work with the defined structure. The structure is defined using several compiler primitives: enums, nodes, nodesets, passes, traversals and phases. This documentation starts with an explanation of the DSL, continues with the generated code from the structure, and then shows how to communicate with the CoCoNut driver from within your compiler, and, finally, walk through an example building a simple REPL calculator.

Contents:

• CoCoNut DSL
  • Types
  • Actions
• Codegen
  • Enum
  • Nodes
  • Passes
  • Traversals
  • Traversal Data
  • Generated Skeleton
  • Files
• Working With CoCoNut
  • Traversals
  • Cycles
  • Nodes
  • Error signals
• Primitive types
• Reserved
• Copra
  • phase_driver.h
  • dynamic_core.h
• Palm
  • str.h
  • hash_table.h
  • dbug.h
  • memory.h
  • ctinfo.h
• Calculator Example
  • Adding a binop node
  • Adding a traversal
  • Fully using CoCoNut
• Attribute Grammars in CoCoNut
  • Introduction
  • Adding attributes to the DSL file
  • Visit generation
  • Evaluation rules
  • More information
• FAQ
  • Can cycles have a gate?
  • Do unreachable nodes need to be handled?
  • How do I create a png of my AST?
  • Can I define a user type for attributes?
  • Can I have syntax highlighting for the DSL files in vscode?
• Bugs
  • Dot does not handle nodesets well
  • Circular phase definitions

Indices and tables

• Index

• Search Page