package ocamlformat-mlx-lib
OCaml .mlx Code Formatter
Install
Dune Dependency
Authors
Maintainers
Sources
ocamlformat-mlx-0.27.0.tbz
sha256=6a40faa182faee55f32bc92387b7e7f97818e160e0f4ef0e0032c0b8b70b86d1
sha512=7df487ebdcddff3529886e034fa9d5476c765c60926b11b8d86fb0e42bea3ee41f693c898e7f95bfc19ca9fa0116825c040a3e027c1e3b7505ebe6c6508540ec
doc/src/ocamlformat-mlx-lib.odoc_parser/token.ml.html
Source file token.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 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
(* This module contains the token type, emitted by the lexer, and consumed by the comment syntax parser. It also contains two functions that format tokens for error messages. *) type section_heading = [ `Begin_section_heading of int * string option ] type style = [ `Bold | `Italic | `Emphasis | `Superscript | `Subscript ] type paragraph_style = [ `Left | `Center | `Right ] type tag = [ `Tag of [ `Author of string | `Deprecated | `Param of string | `Raise of string | `Return | `See of [ `Url | `File | `Document ] * string | `Since of string | `Before of string | `Version of string | `Canonical of string | `Children_order | `Short_title | `Inline | `Open | `Closed | `Hidden ] ] type media = [ `Audio | `Video | `Image ] type media_href = [ `Reference of string | `Link of string ] type media_markup = [ `Simple_media of media_href * media | `Media_with_replacement_text of media_href * media * string ] let s_of_media kind media = match (kind, media) with | `Simple, `Audio -> "{audio!" | `Simple, `Video -> "{video!" | `Simple, `Image -> "{image!" | `Replaced, `Audio -> "{{audio!" | `Replaced, `Video -> "{{video!" | `Replaced, `Image -> "{{image!" type t = [ (* End of input. *) `End | (* Runs of whitespace. [Blank_line] is any run of whitespace that contains two or more newline characters. [Single_newline] is any run of whitespace that contains exactly one newline character. [Space] is any run of whitespace that contains no newline characters. It is an important invariant in the parser that no adjacent whitespace tokens are emitted by the lexer. Otherwise, there would be the need for unbounded lookahead, a (co-?)ambiguity between [Single_newline Single_newline] and [Blank_line], and other problems. *) `Space of string | `Single_newline of string | `Blank_line of string | (* A right curly brace ([}]), i.e. end of markup. *) `Right_brace | `Right_code_delimiter | (* Words are anything that is not whitespace or markup. Markup symbols can be be part of words if escaped. Words can contain plus and minus symbols, but those are emitted as [Plus] and [Minus] tokens. The parser combines plus and minus into words, except when they appear first on a line, in which case the tokens are list item bullets. *) `Word of string | `Code_span of string | `Raw_markup of string option * string | `Math_span of string | `Math_block of string | `Begin_style of style | `Begin_paragraph_style of paragraph_style | (* Other inline element markup. *) `Simple_reference of string | `Begin_reference_with_replacement_text of string | `Simple_link of string | `Begin_link_with_replacement_text of string | media_markup | (* Leaf block element markup. *) `Code_block of (string Loc.with_location * string Loc.with_location option) option * string * string Loc.with_location * bool | `Verbatim of string | `Modules of string | (* List markup. *) `Begin_list of [ `Unordered | `Ordered ] | `Begin_list_item of [ `Li | `Dash ] | (* Table markup. *) `Begin_table_light | `Begin_table_heavy | `Begin_table_row | `Begin_table_cell of [ `Header | `Data ] | `Minus | `Plus | `Bar | section_heading | tag ] let print : [< t ] -> string = function | `Begin_paragraph_style `Left -> "'{L'" | `Begin_paragraph_style `Center -> "'{C'" | `Begin_paragraph_style `Right -> "'{R'" | `Begin_style `Bold -> "'{b'" | `Begin_style `Italic -> "'{i'" | `Begin_style `Emphasis -> "'{e'" | `Begin_style `Superscript -> "'{^'" | `Begin_style `Subscript -> "'{_'" | `Begin_reference_with_replacement_text _ -> "'{{!'" | `Begin_link_with_replacement_text _ -> "'{{:'" | `Begin_list_item `Li -> "'{li ...}'" | `Begin_list_item `Dash -> "'{- ...}'" | `Begin_table_light -> "{t" | `Begin_table_heavy -> "{table" | `Begin_table_row -> "'{tr'" | `Begin_table_cell `Header -> "'{th'" | `Begin_table_cell `Data -> "'{td'" | `Minus -> "'-'" | `Plus -> "'+'" | `Bar -> "'|'" | `Begin_section_heading (level, label) -> let label = match label with None -> "" | Some label -> ":" ^ label in Printf.sprintf "'{%i%s'" level label | `Tag (`Author _) -> "'@author'" | `Tag `Deprecated -> "'@deprecated'" | `Tag (`Param _) -> "'@param'" | `Tag (`Raise _) -> "'@raise'" | `Tag `Return -> "'@return'" | `Tag `Children_order -> "'@children_order'" | `Tag `Short_title -> "'@short_title'" | `Tag (`See _) -> "'@see'" | `Tag (`Since _) -> "'@since'" | `Tag (`Before _) -> "'@before'" | `Tag (`Version _) -> "'@version'" | `Tag (`Canonical _) -> "'@canonical'" | `Tag `Inline -> "'@inline'" | `Tag `Open -> "'@open'" | `Tag `Closed -> "'@closed'" | `Tag `Hidden -> "'@hidden" | `Raw_markup (None, _) -> "'{%...%}'" | `Raw_markup (Some target, _) -> "'{%" ^ target ^ ":...%}'" | `Simple_media (`Reference _, `Image) -> "{image!...}" | `Simple_media (`Reference _, `Audio) -> "{audio!...}" | `Simple_media (`Reference _, `Video) -> "{video!...}" | `Simple_media (`Link _, `Image) -> "{image:...}" | `Simple_media (`Link _, `Audio) -> "{audio:...}" | `Simple_media (`Link _, `Video) -> "{video:...}" | `Media_with_replacement_text (`Reference _, `Image, _) -> "{{image!...} ...}" | `Media_with_replacement_text (`Reference _, `Audio, _) -> "{{audio!...} ...}" | `Media_with_replacement_text (`Reference _, `Video, _) -> "{{video!...} ...}" | `Media_with_replacement_text (`Link _, `Image, _) -> "{{image:...} ...}" | `Media_with_replacement_text (`Link _, `Audio, _) -> "{{audio:...} ...}" | `Media_with_replacement_text (`Link _, `Video, _) -> "{{video:...} ...}" (* [`Minus] and [`Plus] are interpreted as if they start list items. Therefore, for error messages based on [Token.describe] to be accurate, formatted [`Minus] and [`Plus] should always be plausibly list item bullets. *) let describe : [< t | `Comment ] -> string = function | `Word w -> Printf.sprintf "'%s'" w | `Code_span _ -> "'[...]' (code)" | `Raw_markup _ -> "'{%...%}' (raw markup)" | `Begin_paragraph_style `Left -> "'{L ...}' (left alignment)" | `Begin_paragraph_style `Center -> "'{C ...}' (center alignment)" | `Begin_paragraph_style `Right -> "'{R ...}' (right alignment)" | `Begin_style `Bold -> "'{b ...}' (boldface text)" | `Begin_style `Italic -> "'{i ...}' (italic text)" | `Begin_style `Emphasis -> "'{e ...}' (emphasized text)" | `Begin_style `Superscript -> "'{^...}' (superscript)" | `Begin_style `Subscript -> "'{_...}' (subscript)" | `Math_span _ -> "'{m ...}' (math span)" | `Math_block _ -> "'{math ...}' (math block)" | `Simple_reference _ -> "'{!...}' (cross-reference)" | `Begin_reference_with_replacement_text _ -> "'{{!...} ...}' (cross-reference)" | `Simple_media (`Reference _, `Image) -> "'{image!...}' (image-reference)" | `Simple_media (`Reference _, `Audio) -> "'{audio!...}' (audio-reference)" | `Simple_media (`Reference _, `Video) -> "'{video!...}' (video-reference)" | `Simple_media (`Link _, `Image) -> "'{image:...}' (image-link)" | `Simple_media (`Link _, `Audio) -> "'{audio:...}' (audio-link)" | `Simple_media (`Link _, `Video) -> "'{video:...}' (video-link)" | `Media_with_replacement_text (`Reference _, `Image, _) -> "'{{image!...} ...}' (image-reference)" | `Media_with_replacement_text (`Reference _, `Audio, _) -> "'{{audio!...} ...}' (audio-reference)" | `Media_with_replacement_text (`Reference _, `Video, _) -> "'{{video!...} ...}' (video-reference)" | `Media_with_replacement_text (`Link _, `Image, _) -> "'{{image:...} ...}' (image-link)" | `Media_with_replacement_text (`Link _, `Audio, _) -> "'{{audio:...} ...}' (audio-link)" | `Media_with_replacement_text (`Link _, `Video, _) -> "'{{video:...} ...}' (video-link)" | `Simple_link _ -> "'{:...} (external link)'" | `Begin_link_with_replacement_text _ -> "'{{:...} ...}' (external link)" | `End -> "end of text" | `Space _ -> "whitespace" | `Single_newline _ -> "line break" | `Blank_line _ -> "blank line" | `Right_brace -> "'}'" | `Right_code_delimiter -> "']}'" | `Code_block _ -> "'{[...]}' (code block)" | `Verbatim _ -> "'{v ... v}' (verbatim text)" | `Modules _ -> "'{!modules ...}'" | `Begin_list `Unordered -> "'{ul ...}' (bulleted list)" | `Begin_list `Ordered -> "'{ol ...}' (numbered list)" | `Begin_list_item `Li -> "'{li ...}' (list item)" | `Begin_list_item `Dash -> "'{- ...}' (list item)" | `Begin_table_light -> "'{t ...}' (table)" | `Begin_table_heavy -> "'{table ...}' (table)" | `Begin_table_row -> "'{tr ...}' (table row)" | `Begin_table_cell `Header -> "'{th ... }' (table header cell)" | `Begin_table_cell `Data -> "'{td ... }' (table data cell)" | `Minus -> "'-' (bulleted list item)" | `Plus -> "'+' (numbered list item)" | `Bar -> "'|'" | `Begin_section_heading (level, _) -> Printf.sprintf "'{%i ...}' (section heading)" level | `Tag (`Author _) -> "'@author'" | `Tag `Deprecated -> "'@deprecated'" | `Tag (`Param _) -> "'@param'" | `Tag (`Raise _) -> "'@raise'" | `Tag `Return -> "'@return'" | `Tag (`See _) -> "'@see'" | `Tag (`Since _) -> "'@since'" | `Tag (`Before _) -> "'@before'" | `Tag (`Version _) -> "'@version'" | `Tag (`Canonical _) -> "'@canonical'" | `Tag `Inline -> "'@inline'" | `Tag `Open -> "'@open'" | `Tag `Closed -> "'@closed'" | `Tag `Hidden -> "'@hidden" | `Tag `Children_order -> "'@children_order" | `Tag `Short_title -> "'@short_title" | `Comment -> "top-level text" let describe_element = function | `Reference (`Simple, _, _) -> describe (`Simple_reference "") | `Reference (`With_text, _, _) -> describe (`Begin_reference_with_replacement_text "") | `Link _ -> describe (`Begin_link_with_replacement_text "") | `Heading (level, _, _) -> describe (`Begin_section_heading (level, None))
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>