package batteries

  1. Overview
  2. Docs
package batteries
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Languages.MakeSource

Create a lexer from a language definition

Parameters

module M : Definition

Signature

High-level API

Drop comments, present reserved operators and reserved names as Kwd, operators and identifiers as Ident, integer numbers as Int, floating-point numbers as Float and characters as Char.

If the language is not case_sensitive, identifiers and keywords are returned in lower-case.

Medium-level API

Remove any leading whitespaces

Sourceval ident : (char, string, BatCharParser.position) BatParserCo.t

Accepts any non-reserved identifier/operator. If the language is not case_sensitive, the identifier is returned in lower-case.

Accepts any identifier. If the language is not case_sensitive, the identifier is returned in lower-case.

Sourceval identifier : string -> (char, unit, BatCharParser.position) BatParserCo.t
Sourceval keyword : string -> (char, unit, BatCharParser.position) BatParserCo.t
Sourceval char_literal : (char, char, BatCharParser.position) BatParserCo.t

Accepts a character literal, i.e. one character (or an escape) between two quotes.

Sourceval string_literal : (char, string, BatCharParser.position) BatParserCo.t

Accepts a string, i.e. one sequence of characters or escapes between two double quotes, on one line.

Sourceval integer : (char, int, BatCharParser.position) BatParserCo.t

Parse an integer.

Sourceval float : (char, float, BatCharParser.position) BatParserCo.t

Parse a floating-point number.

Sourceval number : (char, [ `Float of float | `Integer of int ], BatCharParser.position) BatParserCo.t

Parse either an integer or a floating-point number.

Sourceval char : char -> (char, char, BatCharParser.position) BatParserCo.t

Low-level API

As CharParser.char, but case-insensitive if specified by case_sensitive.

Sourceval string : string -> (char, string, BatCharParser.position) BatParserCo.t

As CharParser.string, but case-insensitive if specified by case_sensitive.

Sourceval line_comment : (char, unit, BatCharParser.position) BatParserCo.t
Sourceval multiline_comment : (char, unit, BatCharParser.position) BatParserCo.t
Sourceval comment : (char, unit, BatCharParser.position) BatParserCo.t
Sourceval whitespaces : (char, unit, BatCharParser.position) BatParserCo.t

Apply this filter to your own parsers if you want them to ignore following comments.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct