README.md

PEGTL Documentation

• Project
• Getting Started
• Installing and Using
  • Requirements
  • Disabling Exceptions
  • Disabling RTTI
  • Installation Packages
  • Using Vcpkg
  • Using Conan
  • Using CMake
    • CMake Installation
    • find_package
    • add_subdirectory
    • Mixing find_package and add_subdirectory
  • Manual Installation
  • Embedding the PEGTL
    • Embedding in Binaries
    • Embedding in Libraries
    • Embedding in Library Interfaces
• Rules and Grammars
  • Combining Existing Rules
  • Toy S-Expression Grammar
  • Creating New Rules
    • Simple Rules
    • Complex Rules
• Actions and States
  • Overview
  • Example
  • States
  • Apply
  • Apply0
  • Inheriting
  • Specialising
  • Changing Actions
    • Via Rules
    • Via Actions
  • Changing States
    • Via Rules
    • Via Actions
  • Changing Actions and States
  • Match
  • Nothing
  • Backtracking
  • Troubleshooting
    • Boolean Return
    • State Mismatch
  • Legacy Actions
• Errors and Exceptions
  • Global Failure
  • Local to Global Failure
    • Intrusive Local to Global Failure
    • Non-Intrusive 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
  • Unicode Rules
    • ICU Support
    • Basic ICU Rules
    • ICU Rules for Binary Properties
    • ICU Rules for Enumerated Properties
    • ICU Rules for Value Properties
  • Binary Rules
  • Full Index
  • Example Tables
• Inputs and Parsing
  • Tracking Mode
  • Line Ending
  • Source
  • File Input
  • Memory Input
  • String Input
  • Stream Inputs
  • Argument Input
  • Parse Function
  • Nested Parsing
  • Incremental Input
    • Buffer Size
    • Discard Buffer
    • Custom Rules
    • Custom Readers
    • Buffer Details
  • Error Reporting
  • Deduction Guides
• Control and Debug
  • Normal Control
  • Control Functions
  • Exception Throwing
  • Advanced Control
  • Changing Control
• Parse Tree
  • Full Parse Tree
  • Partial Parse Tree
  • Transforming Nodes
  • Transformer
  • tao::pegtl::parse_tree::node
  • Custom Node Class
  • Requirements
• Meta Data and Visit
  • Internals
  • Rule Type
  • Sub Rules
  • Grammar Visit
  • Grammar Print
  • Rule Coverage
• Contrib and Examples
  • Contrib
  • Examples
• Grammar Analysis
  • Running
  • Example
  • Requirements
  • Limitations
• Changelog
• Migration Guide

Rule Reference Index

• action< A, R... > ^{(meta rules)}
• alnum ^{(ascii rules)}
• alpha ^{(ascii rules)}
• alphabetic ^{(icu rules)}
• any ^{(ascii rules)}
• any ^{(unicode rules)}
• any ^{(binary rules)}
• apply< A... > ^{(action rules)}
• apply0< A... > ^{(action rules)}
• ascii_hex_digit ^{(icu rules)}
• at< R... > ^{(combinators)}
• bidi_class< V > ^{(icu rules)}
• bidi_control ^{(icu rules)}
• bidi_mirrored ^{(icu rules)}
• binary_property< P > ^{(icu rules)}
• binary_property< P, V > ^{(icu rules)}
• blank ^{(ascii rules)}
• block< V > ^{(icu rules)}
• bof ^{(atomic rules)}
• bol ^{(atomic rules)}
• bom ^{(unicode rules)}
• bytes< Num > ^{(atomic rules)}
• canonical_combining_class< V > ^{(icu rules)}
• case_sensitive ^{(icu rules)}
• control< C, R... > ^{(meta rules)}
• dash ^{(icu rules)}
• decomposition_type< V > ^{(icu rules)}
• default_ignorable_code_point ^{(icu rules)}
• deprecated ^{(icu rules)}
• diacritic ^{(icu rules)}
• digit ^{(ascii rules)}
• disable< R... > ^{(meta rules)}
• discard ^{(meta rules)}
• east_asian_width< V > ^{(icu rules)}
• enable< R... > ^(meta-rules)
• eof ^{(atomic rules)}
• eol ^{(atomic rules)}
• eolf ^{(atomic rules)}
• everything ^{(atomic rules)}
• extender ^{(icu rules)}
• failure ^{(atomic rules)}
• forty_two< C... > ^{(ascii rules)}
• full_composition_exclusion ^{(icu rules)}
• general_category< V > ^{(icu rules)}
• grapheme_base ^{(icu rules)}
• grapheme_cluster_break< V > ^{(icu rules)}
• grapheme_extend ^{(icu rules)}
• grapheme_link ^{(icu rules)}
• hangul_syllable_type< V > ^{(icu rules)}
• hex_digit ^{(icu rules)}
• hyphen ^{(icu rules)}
• id_continue ^{(icu rules)}
• id_start ^{(icu rules)}
• identifier_first ^{(ascii rules)}
• identifier_other ^{(ascii rules)}
• identifier ^{(ascii rules)}
• ideographic ^{(icu rules)}
• ids_binary_operator ^{(icu rules)}
• ids_trinary_operator ^{(icu rules)}
• if_apply< R, A... > ^{(action rules)}
• if_must< R, S... > ^{(convenience)}
• if_must_else< R, S, T > ^{(convenience)}
• if_then_else< R, S, T > ^{(convenience)}
• istring< C... > ^{(ascii rules)}
• join_control ^{(icu rules)}
• joining_group< V > ^{(icu rules)}
• joining_type< V > ^{(icu rules)}
• keyword< C... > ^{(ascii rules)}
• lead_canonical_combining_class< V > ^{(icu rules)}
• line_break< V > ^{(icu rules)}
• list< R, S > ^{(convenience)}
• list< R, S, P > ^{(convenience)}
• list_must< R, S > ^{(convenience)}
• list_must< R, S, P > ^{(convenience)}
• list_tail< R, S > ^{(convenience)}
• list_tail< R, S, P > ^{(convenience)}
• logical_order_exception ^{(icu rules)}
• lower ^{(ascii rules)}
• lowercase ^{(icu rules)}
• mask_not_one< M, C... > ^{(binary rules)}
• mask_not_range< M, C, D > ^{(binary rules)}
• mask_one< M, C... > ^{(binary rules)}
• mask_range< M, C, D > ^{(binary rules)}
• mask_ranges< M, C1, D1, C2, D2, ... > ^{(binary rules)}
• mask_ranges< M, C1, D1, C2, D2, ..., E > ^{(binary rules)}
• mask_string< M, C... > ^{(binary rules)}
• math ^{(icu rules)}
• minus< M, S > ^{(convenience)}
• must< R... > ^{(convenience)}
• nfc_inert ^{(icu rules)}
• nfd_inert ^{(icu rules)}
• nfkc_inert ^{(icu rules)}
• nfkd_inert ^{(icu rules)}
• noncharacter_code_point ^{(icu rules)}
• not_at< R... > ^{(combinators)}
• not_one< C... > ^{(ascii rules)}
• not_one< C... > ^{(unicode rules)}
• not_one< C... > ^{(binary rules)}
• not_range< C, D > ^{(ascii rules)}
• not_range< C, D > ^{(unicode rules)}
• not_range< C, D > ^{(binary rules)}
• nul ^{(ascii rules)}
• numeric_type< V > ^{(icu rules)}
• odigit ^{(ascii rules)}
• one< C... > ^{(ascii rules)}
• one< C... > ^{(unicode rules)}
• one< C... > ^{(binary rules)}
• opt< R... > ^{(combinators)}
• opt_must< R, S...> ^{(convenience)}
• pad< R, S, T = S > ^{(convenience)}
• pad_opt< R, P > ^{(convenience)}
• partial< R... > ^{(convenience)}
• pattern_syntax ^{(icu rules)}
• pattern_white_space ^{(icu rules)}
• plus< R... > ^{(combinators)}
• posix_alnum ^{(icu rules)}
• posix_blank ^{(icu rules)}
• posix_graph ^{(icu rules)}
• posix_print ^{(icu rules)}
• posix_xdigit ^{(icu rules)}
• print ^{(ascii rules)}
• property_value< P, V > ^{(icu rules)}
• quotation_mark ^{(icu rules)}
• radical ^{(icu rules)}
• raise< T > ^{(atomic rules)}
• raise_message< C... > ^{(atomic rules)}
• range< C, D > ^{(ascii rules)}
• range< C, D > ^{(unicode rules)}
• range< C, D > ^{(binary rules)}
• ranges< C1, D1, C2, D2, ... > ^{(ascii rules)}
• ranges< C1, D1, C2, D2, ... > ^{(unicode rules)}
• ranges< C1, D1, C2, D2, ... > ^{(binary rules)}
• ranges< C1, D1, C2, D2, ..., E > ^{(ascii rules)}
• ranges< C1, D1, C2, D2, ..., E > ^{(unicode rules)}
• ranges< C1, D1, C2, D2, ..., E > ^{(binary rules)}
• rematch< R, S... > ^{(convenience)}
• rep< Num, R... > ^{(convenience)}
• rep_max< Max, R... > ^{(convenience)}
• rep_min< Min, R... > ^{(convenience)}
• rep_min_max< Min, Max, R... > ^{(convenience)}
• rep_opt< Num, R... > ^{(convenience)}
• require< Num > ^(meta-rules)
• s_term ^{(icu rules)}
• segment_starter ^{(icu rules)}
• sentence_break< V > ^{(icu rules)}
• seq< R... > ^{(combinators)}
• seven ^{(ascii rules)}
• shebang ^{(ascii rules)}
• soft_dotted ^{(icu rules)}
• sor< R... > ^{(combinators)}
• space ^{(ascii rules)}
• star< R... > ^{(combinators)}
• star_must< R, S... > ^{(convenience)}
• star_partial< R... > ^{(convenience)}
• star_strict< R... > ^{(convenience)}
• state< S, R... > ^{(meta rules)}
• strict< R... > ^{(convenience)}
• string< C... > ^{(ascii rules)}
• string< C... > ^{(unicode rules)}
• string< C... > ^{(binary rules)}
• success ^{(atomic rules)}
• TAO_PEGTL_ISTRING( "..." ) ^{(ascii rules)}
• TAO_PEGTL_KEYWORD( "..." ) ^{(ascii rules)}
• TAO_PEGTL_RAISE_MESSAGE( "..." ) ^{(atomic rules)}
• TAO_PEGTL_STRING( "..." ) ^{(ascii rules)}
• terminal_punctuation ^{(icu rules)}
• three< C > ^{(ascii rules)}
• trail_canonical_combining_class< V > ^{(icu rules)}
• try_catch_any_raise_nested< R... > ^{(convenience)}
• try_catch_any_return_false< R... > ^{(convenience)}
• try_catch_raise_nested< R... > ^{(convenience)}
• try_catch_return_false< R... > ^{(convenience)}
• try_catch_std_raise_nested< R... > ^{(convenience)}
• try_catch_std_return_false< R... > ^{(convenience)}
• try_catch_type_raise_nested< E, R... > ^{(convenience)}
• try_catch_type_return_false< E, R... > ^{(convenience)}
• two< C > ^{(ascii rules)}
• unified_ideograph ^{(icu rules)}
• until< R > ^{(convenience)}
• until< R, S... > ^{(convenience)}
• upper ^{(ascii rules)}
• uppercase ^{(icu rules)}
• variation_selector ^{(icu rules)}
• white_space ^{(icu rules)}
• word_break< V > ^{(icu rules)}
• xdigit ^{(ascii rules)}
• xid_continue ^{(icu rules)}
• xid_start ^{(icu rules)}

---

This document is part of the PEGTL.

Copyright (c) 2014-2023 Dr. Colin Hirsch and Daniel Frey Distributed under the Boost Software License, Version 1.0
See accompanying file LICENSE_1_0.txt or copy at https://www.boost.org/LICENSE_1_0.txt