blob: 7e4b58c9a69ca70c70fd824a7ca785ef62018c55 (
plain)
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
|
(************************************************************************)
(* v * The Coq Proof Assistant / The Coq Development Team *)
(* <O___,, * INRIA - CNRS - LIX - LRI - PPS - Copyright 1999-2015 *)
(* \VV/ **************************************************************)
(* // * This file is distributed under the terms of the *)
(* * GNU Lesser General Public License Version 2.1 *)
(************************************************************************)
(** This module offers semi-structured pretty-printing. *)
(** Each annotation of the semi-structured document refers to the
substring it annotates. *)
type 'annotation located = {
annotation : 'annotation option;
startpos : int;
endpos : int
}
(** [rich_pp get_annotations ppcmds] returns the interpretation
of [ppcmds] as a semi-structured document
that represents (located) annotations of this string.
The [get_annotations] function is used to convert tags into the desired
annotation. *)
val rich_pp :
(Pp.Tag.t -> 'annotation option) -> Pp.std_ppcmds ->
'annotation located Xml_datatype.gxml
(** [annotations_positions ssdoc] returns a list associating each
annotations with its position in the string from which [ssdoc] is
built. *)
val annotations_positions :
'annotation located Xml_datatype.gxml ->
('annotation * (int * int)) list
(** [xml_of_rich_pp ssdoc] returns an XML representation of the
semi-structured document [ssdoc]. *)
val xml_of_rich_pp :
('annotation -> string) ->
('annotation -> (string * string) list) ->
'annotation located Xml_datatype.gxml ->
Xml_datatype.xml
(** {5 Enriched text} *)
type richpp
(** Type of text with style annotations *)
val richpp_of_pp : Pp.std_ppcmds -> richpp
(** Extract style information from formatted text *)
val richpp_of_xml : Xml_datatype.xml -> richpp
(** Do not use outside of dedicated areas *)
val richpp_of_string : string -> richpp
(** Make a styled text out of a normal string *)
val repr : richpp -> Xml_datatype.xml
(** Observe the styled text as XML *)
(** {5 Serialization} *)
val of_richpp : richpp -> Xml_datatype.xml
val to_richpp : Xml_datatype.xml -> richpp
(** Represent the semi-structured document as a string, dropping any additional
information. *)
val raw_print : richpp -> string
|
