README.md

PEGTL Documentation

• Project
• Getting Started
• Installing and Using
  • Requirements
  • Installation Packages
  • Linux Packages
  • macOS Packages
  • CMake Installation
  • Manual Installation
  • Embedding the PEGTL
  • Embedding in Binaries
  • Embedding in Libraries
  • Embedding in Library Interfaces
  • Limitations
• Rules and Grammars
  • Combining Existing Rules
  • Toy S-Expression Grammar
  • Creating New Rules
  • Simple Rules
  • Complex Rules
• Actions and States
  • Actions
  • Apply0
  • Apply
  • States
  • Action Specialisation
  • Changing Actions
  • Changing State
  • No Switching
  • Intrusive Switching
  • External Switching
• Errors and Exceptions
  • Local to Global Failure
  • Global to Local Failure
  • Examples for Must Rules
  • Custom Exception Messages
• Rule Reference
  • Meta Rules
  • Combinators
  • Convenience
  • Action Rules
  • Atomic Rules
  • ASCII Rules
  • UTF-8 Rules
  • UTF-16 Rules
  • UTF-32 Rules
  • Full Index
• Inputs and Parsing
  • Tracking Mode
  • Line Ending
  • Source
  • File Input
  • Memory Input
  • String Input
  • Stream Inputs
  • Argument Input
  • Parse Function
  • Nested Parsing
  • Incremental Input
  • Grammars and Buffering
  • Custom Data Sources
• Contrib and Examples
  • Contrib
  • Examples
• Control and Debug
  • Normal Control
  • Control Functions
  • Exception Throwing
  • Advanced Control
  • Changing Control
• Grammar Analysis
• Changelog
• Migration Guide

Copyright (c) 2014-2017 Dr. Colin Hirsch and Daniel Frey