When given a quoted reference to a Lexer, for example [|lexer|], this function will synthesise an IsString instance that will allow string literals to serve as Parsec (). These literals will parse symbols in the language associated with the lexer, followed by consuming valid whitespace.

Since: 0.2.2.0

Generates the specified lexer combinators using a quoted Lexer, for example, [|lexer|].

The generated combinators will behave like their counterparts in Text.Gigaparsec.Token.Lexer, except they won't require a lexer (or subcomponents thereof) to be supplied as an argument.

Usage:

import Text.Gigaparsec.Token.Lexer qualified as Lexer
import Text.Gigaparsec.Token.Lexer (Lexer)
lexer :: Lexer
$(lexerCombinators [| lexer |] ['Lexer.lexeme, 'Lexer.fully, 'Lexer.identifier, 'Lexer.stringLiteral])

lexeme :: Lexeme
fully :: ∀ a . Parsec a -> Parsec a
identifier :: Parsec String
stringLiteral :: TextParsers String

Since: 0.4.0.0

Generates the specified lexer combinators with the given names using a quoted Lexer, for example, [|lexer|].

The generated combinators will behave like their counterparts in Text.Gigaparsec.Token.Lexer, except they won't require a lexer (or subcomponents thereof) to be supplied as an argument.

Usage:

import Text.Gigaparsec.Token.Lexer qualified as Lexer
import Text.Gigaparsec.Token.Lexer (Lexer)
lexer :: Lexer
$(lexerCombinatorsWithNames [| lexer |] [('Lexer.lexeme, "myLexeme"), ('Lexer.fully, "myFully")])

myLexeme :: Lexeme
myFully :: ∀ a . Parsec a -> Parsec a

Since: 0.4.0.0

This function automatically generates lexer combinators for handling signed or unsigned integers.

See IntegerParserConfig for how to configure which combinators are generated.

Note: Due to staging restrictions in Template Haskell, the IntegerParserConfig must be defined in a separate module to where this function is used. Multiple configs can be defined in the same module.

Usage:

{-# LANGUAGE TemplateHaskell, OverloadedLists #-}
module IntegerConfigs where
…
uIntCfg :: IntegerParserConfig
uIntCfg = emptyUnsignedIntegerParserConfig {
    prefix = "u",
    widths = [(B8, [t| Word8 |]), (B32, [t| Word32 |])],
    bases = [Hexadecimal, Decimal, Binary],
    includeUnbounded = False,
    signedOrUnsigned = Unsigned,
    collatedParser = Just "natural"
  }

{-# LANGUAGE TemplateHaskell #-}
module Lexer where
import IntegerConfigs (uIntCfg)
…
lexer :: Lexer
lexer = …

$(generateIntegerParsers [| lexer |] uIntCfg)

   ubinary8 :: Parsec Word8
   udecimal8 :: Parsec Word8
   uhexadecimal8 :: Parsec Word8
   ubinary32 :: Parsec Word32
   udecimal3 :: Parsec Word32
   uhexadecimal32 :: Parsec Word32
   natural8 :: Parsec Word8
   natural32 :: Parsec Word32

Since: 0.4.0.0

This type describes how to generate numeric parsers with generateIntegerParsers. This includes configuration for which bases and bitwidths to support, and whether to generate parsers that can handle multiple bases.

See the emptyIntegerParserConfig smart constructor to define a IntegerParserConfig.

Since: 0.4.0.0

The string to prepend to each generated parser's name (except for the collatedParser, if specified).

Since: 0.4.0.0

The fixed bit-widths (8-bit, 16-bit, etc/) for which to generate parsers.

Since: 0.4.0.0

The numeric bases (binary, octal, etc) for which to generate parsers.

Since: 0.4.0.0

When True, generate the unbounded integer parsers (e.g. decimal) for each base specified in bases.

Since: 0.4.0.0

Whether or not the parsers to generate are for Signed or Unsigned integers.

Since: 0.4.0.0

Generate a generic integer parser with the given name, at each width (including unbounded) specified by widths, that is able to parse each base specified in bases.

• If Nothing, do not generate such a parser.
• If Just "", then the default name will be "natural" or "integer" when signedOrUnsigned is Unsigned or Signed, respectively.

Since: 0.4.0.0

An empty IntegerParserConfig, which will generate nothing when given to generateIntegerParsers. Extend this using record updates, to tailor a config to your liking.

By default, the prefix field is the empty string, which will likely cause issues if you do not override this.

Since: 0.4.0.0

An empty IntegerParserConfig for Signed integers, which will generate nothing when given to generateIntegerParsers. Extend this using record updates, to tailor a config to your liking.

By default, the prefix field is the empty string, which will likely cause issues if you do not override this.

Since: 0.4.0.0

An empty IntegerParserConfig for Unsigned integers, which will generate nothing when given to generateIntegerParsers. Extend this using record updates, to tailor a config to your liking.

By default, the prefix field is the empty string, which will likely cause issues if you do not override this.

Since: 0.4.0.0

Determines if the combinators are for Signed or Unsigned int literals.

Since: 0.4.0.0

Set of all possible IntLitBases.

Since: 0.4.0.0

The base of a numeric literal.

Used in IntegerParserConfig to specify which parsers for which bases should be generated.

Since: 0.4.0.0