PureScript Parsing

https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/
Admin
PureScript Parsing is a monadic parser combinator library based on Haskell’s Parsec, providing tools...
Tokens:1,205
Snippets:15
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Example Usage of makeTokenParser

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Demonstrates how to use `makeTokenParser` with a language definition (like `haskellDef`) to create a token parser. It shows how to extract specific parsers like `parens`, `braces`, `identifier`, and `reserved` from the generated `TokenParser`.

```purescript
module Main where

import Parsing.Language (haskellDef)
import Parsing.Token (makeTokenParser)

-- The parser
expr = parens expr
   <|> identifier
   <|> ...


-- The lexer
tokenParser = makeTokenParser haskellDef
parens      = tokenParser.parens
braces      = tokenParser.braces
identifier  = tokenParser.identifier
reserved    = tokenParser.reserved
...
```

--------------------------------

### Match Specific Token - ParserT

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that matches a specific token at the head of the stream. It requires the token type to be an instance of `Eq`.

```purescript
match :: forall a m. Eq a => (a -> Position) -> a -> ParserT (List a) m a
```

--------------------------------

### Generate Token Parser - GenTokenParser

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Creates a `GenTokenParser` record from a `GenLanguageDef`. This record contains various lexical parsers for different token types like operators, identifiers, and literals.

```purescript
makeTokenParser :: forall m. GenLanguageDef String m -> GenTokenParser String m
```

--------------------------------

### Parse One of Characters - ParserT String

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that attempts to match one of the specified BMP `Char`s from a `String` input stream. It takes an array of characters to match against.

```purescript
oneOf :: forall m. Array Char -> ParserT String m Char
```

--------------------------------

### Parse First Token - ParserT

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that returns the first token in the stream. It takes a function to determine the position of a token.

```purescript
token :: forall m a. (a -> Position) -> ParserT (List a) m a
```

--------------------------------

### Match End-of-File - ParserT

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that matches the end of the input stream. It does not consume any input and returns `Unit`.

```purescript
eof :: forall a m. ParserT (List a) m Unit
```

--------------------------------

### Parse Space Character - ParserT String

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that attempts to parse a space character from a `String` input stream. It matches any character that satisfies `Data.CodePoint.Unicode.isSpace`.

```purescript
space :: forall m. ParserT String m Char
```

--------------------------------

### Parse Token Satisfying Predicate - ParserT

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that matches any token satisfying a given predicate. It takes a function to determine the position of a token and a predicate function.

```purescript
when :: forall m a. (a -> Position) -> (a -> Boolean) -> ParserT (List a) m a
```

--------------------------------

### Parse Uppercase Letter - ParserT String

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

A parser that attempts to parse an uppercase letter from a `String` input stream. It matches any character that satisfies `Data.CodePoint.Unicode.isUpper`.

```purescript
upper :: forall m. ParserT String m Char
```

--------------------------------

### Parse Decimal Digit - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses a single character that is a decimal digit. This function utilizes `Data.CodePoint.Unicode.isDecDigit` for character validation. It returns the parsed decimal digit character.

```purescript
digit :: forall m. ParserT String m Char
digit = "digit"
```

--------------------------------

### Parse Alphabetic Character - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses a single character that is an alphabetic character. The parser checks if the character satisfies `Data.CodePoint.Unicode.isAlpha`. It returns the parsed alphabetic character.

```purescript
letter :: forall m. ParserT String m Char
letter = "letter"
```

--------------------------------

### Parse Alphanumeric Character - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses a single character that is either an alphabetic or a numeric character. This parser uses `Data.CodePoint.Unicode.isAlphaNum` to perform the check. It returns the matched alphanumeric character.

```purescript
alphaNum :: forall m. ParserT String m Char
alphaNum = "alphaNum"
```

--------------------------------

### Parse Character Not in Set - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses any BMP (Basic Multilingual Plane) `Char` that is not present in the provided array of characters. This is useful for matching characters that fall outside a specific set. It returns the parsed character.

```purescript
noneOf :: forall m. Array Char -> ParserT String m Char
noneOf = "noneOf"
```

--------------------------------

### Parse Hexadecimal Digit - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses a single character that is a hexadecimal digit. This parser uses `Data.CodePoint.Unicode.isHexDigit` to validate the character. It returns the matched hexadecimal character.

```purescript
hexDigit :: forall m. ParserT String m Char
hexDigit = "hexDigit"
```

--------------------------------

### Parse Octal Digit - PureScript

Source: https://pursuit.purescript.org/packages/purescript-parsing/10.3.1/docs/Parsing

Parses a single character that is an octal digit. This function relies on the `Data.CodePoint.Unicode.isOctDigit` function to determine if a character is an octal digit. It returns the parsed character.

```purescript
octDigit :: forall m. ParserT String m Char
octDigit = "octDigit"
```
Tokens:
Raw