package ocamlformat-mlx-lib
OCaml .mlx Code Formatter
Install
Dune Dependency
Authors
Maintainers
Sources
0.26.2.0.tar.gz
md5=4b32d3b57da54157a0cd8f772094f4bc
sha512=367eeb5d81060a3efb584796cc72cc75d974975bb9b18be6284a86f5937edb90927368fd80e00b3f4c1894e609b4a1503c20d4495c624560243e5055f905390a
doc/src/ocamlformat-mlx-lib.parser_extended/docstrings.ml.html
Source file docstrings.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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
(**************************************************************************) (* *) (* OCaml *) (* *) (* Leo White *) (* *) (* Copyright 1996 Institut National de Recherche en Informatique et *) (* en Automatique. *) (* *) (* All rights reserved. This file is distributed under the terms of *) (* the GNU Lesser General Public License version 2.1, with the *) (* special exception on linking described in the file LICENSE. *) (* *) (**************************************************************************) open Location (* Docstrings *) (* A docstring is "attached" if it has been inserted in the AST. This is used for generating unexpected docstring warnings. *) type ds_attached = | Unattached (* Not yet attached anything.*) | Info (* Attached to a field or constructor. *) | Docs (* Attached to an item or as floating text. *) (* A docstring is "associated" with an item if there are no blank lines between them. This is used for generating docstring ambiguity warnings. *) type ds_associated = | Zero (* Not associated with an item *) | One (* Associated with one item *) | Many (* Associated with multiple items (ambiguity) *) type docstring = { ds_body: string; ds_loc: Location.t; mutable ds_attached: ds_attached; mutable ds_associated: ds_associated; } (* List of docstrings *) let docstrings : docstring list ref = ref [] (* Warn for unused and ambiguous docstrings *) let warn_bad_docstrings () = if Warnings.is_active (Warnings.Unexpected_docstring true) then begin List.iter (fun ds -> match ds.ds_attached with | Info -> () | Unattached -> prerr_warning ds.ds_loc (Warnings.Unexpected_docstring true) | Docs -> match ds.ds_associated with | Zero | One -> () | Many -> prerr_warning ds.ds_loc (Warnings.Unexpected_docstring false)) (List.rev !docstrings) end (* Docstring constructors and destructors *) let docstring body loc = let ds = { ds_body = body; ds_loc = loc; ds_attached = Unattached; ds_associated = Zero; } in ds let register ds = docstrings := ds :: !docstrings let docstring_body ds = ds.ds_body let docstring_loc ds = ds.ds_loc (* Docstrings attached to items *) type docs = { docs_pre: docstring option; docs_post: docstring option; } let empty_docs = { docs_pre = None; docs_post = None } let doc_loc = {txt = "ocaml.doc"; loc = Location.none} let docs_attr ds = let open Parsetree in let body = ds.ds_body in let loc = ds.ds_loc in let const = { pconst_desc= Pconst_string(body,loc,None); pconst_loc= loc } in let exp = { pexp_desc = Pexp_constant const; pexp_loc = loc; pexp_loc_stack = []; pexp_attributes = []; } in let item = { pstr_desc = Pstr_eval (exp, []); pstr_loc = loc } in { attr_name = doc_loc; attr_payload = PStr [item]; attr_loc = loc } let add_docs_attrs docs attrs = let attrs = match docs.docs_pre with | None | Some { ds_body=""; _ } -> attrs | Some ds -> docs_attr ds :: attrs in let attrs = match docs.docs_post with | None | Some { ds_body=""; _ } -> attrs | Some ds -> attrs @ [docs_attr ds] in attrs (* Docstrings attached to constructors or fields *) type info = docstring option let empty_info = None let info_attr = docs_attr let add_info_attrs info attrs = match info with | None | Some {ds_body=""; _} -> attrs | Some ds -> attrs @ [info_attr ds] (* Docstrings not attached to a specific item *) type text = docstring list let empty_text = [] let empty_text_lazy = lazy [] let text_loc = {txt = "ocaml.text"; loc = Location.none} let text_attr ds = let open Parsetree in let body = ds.ds_body in let loc = ds.ds_loc in let const = { pconst_desc= Pconst_string(body,loc,None); pconst_loc= loc } in let exp = { pexp_desc = Pexp_constant const; pexp_loc = loc; pexp_loc_stack = []; pexp_attributes = []; } in let item = { pstr_desc = Pstr_eval (exp, []); pstr_loc = loc } in { attr_name = text_loc; attr_payload = PStr [item]; attr_loc = loc } let add_text_attrs dsl attrs = let fdsl = List.filter (function {ds_body=""} -> false| _ ->true) dsl in (List.map text_attr fdsl) @ attrs (* Find the first non-info docstring in a list, attach it and return it *) let get_docstring ~info dsl = let rec loop = function | [] -> None | {ds_attached = Info; _} :: rest -> loop rest | ds :: _ -> ds.ds_attached <- if info then Info else Docs; Some ds in loop dsl (* Find all the non-info docstrings in a list, attach them and return them *) let get_docstrings dsl = let rec loop acc = function | [] -> List.rev acc | {ds_attached = Info; _} :: rest -> loop acc rest | ds :: rest -> ds.ds_attached <- Docs; loop (ds :: acc) rest in loop [] dsl (* "Associate" all the docstrings in a list *) let associate_docstrings dsl = List.iter (fun ds -> match ds.ds_associated with | Zero -> ds.ds_associated <- One | (One | Many) -> ds.ds_associated <- Many) dsl (* Map from positions to pre docstrings *) let pre_table : (Lexing.position, docstring list) Hashtbl.t = Hashtbl.create 50 let set_pre_docstrings pos dsl = if dsl <> [] then Hashtbl.add pre_table pos dsl let get_pre_docs pos = try let dsl = Hashtbl.find pre_table pos in associate_docstrings dsl; get_docstring ~info:false dsl with Not_found -> None let mark_pre_docs pos = try let dsl = Hashtbl.find pre_table pos in associate_docstrings dsl with Not_found -> () (* Map from positions to post docstrings *) let post_table : (Lexing.position, docstring list) Hashtbl.t = Hashtbl.create 50 let set_post_docstrings pos dsl = if dsl <> [] then Hashtbl.add post_table pos dsl let get_post_docs pos = try let dsl = Hashtbl.find post_table pos in associate_docstrings dsl; get_docstring ~info:false dsl with Not_found -> None let mark_post_docs pos = try let dsl = Hashtbl.find post_table pos in associate_docstrings dsl with Not_found -> () let get_info pos = try let dsl = Hashtbl.find post_table pos in get_docstring ~info:true dsl with Not_found -> None (* Map from positions to floating docstrings *) let floating_table : (Lexing.position, docstring list) Hashtbl.t = Hashtbl.create 50 let set_floating_docstrings pos dsl = if dsl <> [] then Hashtbl.add floating_table pos dsl let get_text pos = try let dsl = Hashtbl.find floating_table pos in get_docstrings dsl with Not_found -> [] let get_post_text pos = try let dsl = Hashtbl.find post_table pos in get_docstrings dsl with Not_found -> [] (* Maps from positions to extra docstrings *) let pre_extra_table : (Lexing.position, docstring list) Hashtbl.t = Hashtbl.create 50 let set_pre_extra_docstrings pos dsl = if dsl <> [] then Hashtbl.add pre_extra_table pos dsl let get_pre_extra_text pos = try let dsl = Hashtbl.find pre_extra_table pos in get_docstrings dsl with Not_found -> [] let post_extra_table : (Lexing.position, docstring list) Hashtbl.t = Hashtbl.create 50 let set_post_extra_docstrings pos dsl = if dsl <> [] then Hashtbl.add post_extra_table pos dsl let get_post_extra_text pos = try let dsl = Hashtbl.find post_extra_table pos in get_docstrings dsl with Not_found -> [] (* Docstrings from parser actions *) module WithParsing = struct let symbol_docs () = { docs_pre = get_pre_docs (Parsing.symbol_start_pos ()); docs_post = get_post_docs (Parsing.symbol_end_pos ()); } let symbol_docs_lazy () = let p1 = Parsing.symbol_start_pos () in let p2 = Parsing.symbol_end_pos () in lazy { docs_pre = get_pre_docs p1; docs_post = get_post_docs p2; } let rhs_docs pos1 pos2 = { docs_pre = get_pre_docs (Parsing.rhs_start_pos pos1); docs_post = get_post_docs (Parsing.rhs_end_pos pos2); } let rhs_docs_lazy pos1 pos2 = let p1 = Parsing.rhs_start_pos pos1 in let p2 = Parsing.rhs_end_pos pos2 in lazy { docs_pre = get_pre_docs p1; docs_post = get_post_docs p2; } let mark_symbol_docs () = mark_pre_docs (Parsing.symbol_start_pos ()); mark_post_docs (Parsing.symbol_end_pos ()) let mark_rhs_docs pos1 pos2 = mark_pre_docs (Parsing.rhs_start_pos pos1); mark_post_docs (Parsing.rhs_end_pos pos2) let symbol_info () = get_info (Parsing.symbol_end_pos ()) let rhs_info pos = get_info (Parsing.rhs_end_pos pos) let symbol_text () = get_text (Parsing.symbol_start_pos ()) let symbol_text_lazy () = let pos = Parsing.symbol_start_pos () in lazy (get_text pos) let rhs_text pos = get_text (Parsing.rhs_start_pos pos) let rhs_post_text pos = get_post_text (Parsing.rhs_end_pos pos) let rhs_text_lazy pos = let pos = Parsing.rhs_start_pos pos in lazy (get_text pos) let symbol_pre_extra_text () = get_pre_extra_text (Parsing.symbol_start_pos ()) let symbol_post_extra_text () = get_post_extra_text (Parsing.symbol_end_pos ()) let rhs_pre_extra_text pos = get_pre_extra_text (Parsing.rhs_start_pos pos) let rhs_post_extra_text pos = get_post_extra_text (Parsing.rhs_end_pos pos) end include WithParsing module WithMenhir = struct let symbol_docs (startpos, endpos) = { docs_pre = get_pre_docs startpos; docs_post = get_post_docs endpos; } let symbol_docs_lazy (p1, p2) = lazy { docs_pre = get_pre_docs p1; docs_post = get_post_docs p2; } let rhs_docs pos1 pos2 = { docs_pre = get_pre_docs pos1; docs_post = get_post_docs pos2; } let rhs_docs_lazy p1 p2 = lazy { docs_pre = get_pre_docs p1; docs_post = get_post_docs p2; } let mark_symbol_docs (startpos, endpos) = mark_pre_docs startpos; mark_post_docs endpos; () let mark_rhs_docs pos1 pos2 = mark_pre_docs pos1; mark_post_docs pos2; () let symbol_info endpos = get_info endpos let rhs_info endpos = get_info endpos let symbol_text startpos = get_text startpos let symbol_text_lazy startpos = lazy (get_text startpos) let rhs_text pos = get_text pos let rhs_post_text pos = get_post_text pos let rhs_text_lazy pos = lazy (get_text pos) let symbol_pre_extra_text startpos = get_pre_extra_text startpos let symbol_post_extra_text endpos = get_post_extra_text endpos let rhs_pre_extra_text pos = get_pre_extra_text pos let rhs_post_extra_text pos = get_post_extra_text pos end (* (Re)Initialise all comment state *) let init () = docstrings := []; Hashtbl.reset pre_table; Hashtbl.reset post_table; Hashtbl.reset floating_table; Hashtbl.reset pre_extra_table; Hashtbl.reset post_extra_table
sectionYPositions = computeSectionYPositions($el), 10)"
x-init="setTimeout(() => sectionYPositions = computeSectionYPositions($el), 10)"
>