Menhir parser

.ocamlformat

@@ -1,3 +1,3 @@
 module-item-spacing=preserve
-version=0.26.1
+version=0.26.2
 ocaml-version=4.02

dune-project

@@ -4,14 +4,16 @@
 
 (documentation "https://ocaml.org/p/odoc")
 
+(using menhir 2.1)
+
 (source
  (github ocaml/odoc))
 
 (license ISC)
 
 (authors
  "Anton Bachin <antonbachin@yahoo.com>"
- "Daniel B\195\188nzli <daniel.buenzli@erratique.ch>"
+ "Daniel Bünzli <daniel.buenzli@erratique.ch>"
  "David Sheets <sheets@alum.mit.edu>"
  "Jon Ludlam <jon@recoil.org>"
  "Jules Aguillon <juloo.dsi@gmail.com>"
@@ -23,10 +25,10 @@
  "Emile Trotignon <emile.trotignon@gmail.com>")
 
 (maintainers
- "Daniel B\195\188nzli <daniel.buenzli@erratique.ch>"
+ "Daniel Bünzli <daniel.buenzli@erratique.ch>"
  "Jon Ludlam <jon@recoil.org>"
  "Jules Aguillon <juloo.dsi@gmail.com>"
- "Paul-Elliot Angl\195\168s d'Auriac <paul-elliot@tarides.com>")
+ "Paul-Elliot Anglès d'Auriac <paul-elliot@tarides.com>")
 
 (cram enable)
 

src/parser/ast.ml

@@ -1,5 +1,17 @@
 (** Abstract syntax tree representing ocamldoc comments *)
 
+(* TODO: (@faycarsons)
+   We no longer need polymorphism in the parser, so for performance and
+   simplicity's sake the AST should (probably, assuming no issues in other
+   parts of Odoc) be refactored to use nominal sum types
+*)
+
+type list_kind = [ `Ordered | `Unordered ]
+type list_syntax = [ `Light | `Heavy ]
+type list_item = [ `Li | `Dash ]
+
+type table_cell_kind = [ `Header | `Data ]
+
 (** This is a syntactic representation of ocamldoc comments. See
     {{:https://ocaml.org/releases/4.12/htmlman/ocamldoc.html}The manual} for a detailed
     description of the syntax understood. Note that there is no attempt at semantic
@@ -40,8 +52,8 @@ type code_block_meta = {
   tags : string with_location option;
 }
 
-type media = Token.media
-type media_href = Token.media_href
+type media = [ `Audio | `Video | `Image ]
+type media_href = [ `Reference of string | `Link of string ]
 
 type code_block = {
   meta : code_block_meta option;
@@ -56,9 +68,7 @@ and nestable_block_element =
   | `Verbatim of string
   | `Modules of string with_location list
   | `List of
-    [ `Unordered | `Ordered ]
-    * [ `Light | `Heavy ]
-    * nestable_block_element with_location list list
+    list_kind * list_syntax * nestable_block_element with_location list list
   | `Table of table
   | `Math_block of string  (** @since 2.0.0 *)
   | `Media of reference_kind * media_href with_location * string * media

src/parser/dune

@@ -1,5 +1,9 @@
 (ocamllex lexer)
 
+(menhir
+ (modules parser)
+ (flags --table --external-tokens Tokens --explain ))
+
 (library
  (name odoc_parser)
  (public_name odoc-parser)
@@ -9,4 +13,4 @@
   (backend bisect_ppx))
  (flags
   (:standard -w -50))
- (libraries astring result camlp-streams))
+ (libraries astring result camlp-streams menhirLib))

src/parser/lexer.mli

@@ -3,8 +3,7 @@
 type input = {
   file : string;
   offset_to_location : int -> Loc.point;
-  warnings : Warning.t list ref;
-  lexbuf : Lexing.lexbuf;
+  mutable warnings : Warning.t list;
 }
 
-val token : input -> Lexing.lexbuf -> Token.t Loc.with_location
+val token : input -> Lexing.lexbuf -> Parser.token