package octavius

  1. Overview
  2. Docs

Source file octErrors.ml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
(*
 * Copyright (c) 2015 Leo White <leo@lpw25.net>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *)

type position =
  { line: int;
    column: int; }

type location =
  { start: position;
    finish: position; }

type parser_error =
  | Unclosed of
      { opening_loc: location;
        opening: string;
        items: string;
        closing: string; }
  | Expecting of string

type lexer_error =
  | Unmatched_target
  | Unmatched_code
  | Unmatched_pre_code
  | Unmatched_html_code
  | Unterminated_verbatim
  | Unterminated_target
  | Unterminated_code
  | Unterminated_pre_code
  | Unterminated_ref
  | Unterminated_html_code
  | Nested_verbatim
  | Nested_target
  | Nested_pre_code
  | Nested_html_code
  | Expected_see
  | Unterminated_see_url
  | Unterminated_see_file
  | Unterminated_see_doc
  | Expected_ident
  | Expected_string
  | Expected_version

type error =
  | Lexer of lexer_error
  | Parser of parser_error

type t =
  { error: error;
    location: location; }

let lexer_message = function
  | Unmatched_target ->
      "unmatched '%%}'"
  | Unmatched_code ->
      "unmatched ']'"
  | Unmatched_pre_code ->
      "unmatched ']}'"
  | Unmatched_html_code ->
      "unmatched '</code>'"
  | Unterminated_verbatim ->
      "unterminated '{v'"
  | Unterminated_target ->
      "unterminated '{%%'"
  | Unterminated_code ->
      "unterminated '['"
  | Unterminated_pre_code ->
      "unterminated '{['"
  | Unterminated_ref ->
      "unterminated '{!'"
  | Unterminated_html_code ->
      "unterminated '<code>'"
  | Nested_verbatim ->
      "nested '{v'"
  | Nested_target ->
      "nested '{%%'"
  | Nested_pre_code ->
      "nested '{['"
  | Nested_html_code ->
      "nested '<code>'"
  | Expected_see ->
      "expected < url >, 'filename' or \"document\""
  | Unterminated_see_url ->
      "unterminated url"
  | Unterminated_see_file ->
      "unterminated filename"
  | Unterminated_see_doc ->
      "unterminated document name"
  | Expected_ident ->
      "expected identifier"
  | Expected_string ->
      "expected string"
  | Expected_version ->
      "expected version string"

let parser_message = function
  | Unclosed { opening_loc = _; opening; items; closing } ->
      "'" ^ opening ^ "' not closed, expected "
      ^ items ^ " or '" ^ closing ^ "'"
  | Expecting nonterm ->
      nonterm ^ " expected"

let message = function
  | Lexer x -> lexer_message x
  | Parser x -> parser_message x