aboutsummaryrefslogtreecommitdiffhomepage
path: root/ide/protocol/xml_printer.mli
diff options
context:
space:
mode:
authorGravatar Pierre-Marie Pédrot <pierre-marie.pedrot@inria.fr>2018-05-26 20:20:33 +0200
committerGravatar Pierre-Marie Pédrot <pierre-marie.pedrot@inria.fr>2018-05-26 20:20:33 +0200
commit71557d5499fcf78d023eefc8d7a2b7a118b81ed5 (patch)
treea54a50a8b7758823709ee776b4825702e3003dcf /ide/protocol/xml_printer.mli
parentac2c4bc19afe7d68918cbc6f605a9bcfcdbf0f35 (diff)
parent5a564f986b5dcb74e347fbdc571d9e1a9980c2a4 (diff)
Merge PR #7543: [ide] Move common protocol library to its own folder/object.
Diffstat (limited to 'ide/protocol/xml_printer.mli')
-rw-r--r--ide/protocol/xml_printer.mli31
1 files changed, 31 insertions, 0 deletions
diff --git a/ide/protocol/xml_printer.mli b/ide/protocol/xml_printer.mli
new file mode 100644
index 000000000..178f7c808
--- /dev/null
+++ b/ide/protocol/xml_printer.mli
@@ -0,0 +1,31 @@
+(************************************************************************)
+(* * The Coq Proof Assistant / The Coq Development Team *)
+(* v * INRIA, CNRS and contributors - Copyright 1999-2018 *)
+(* <O___,, * (see CREDITS file for the list of authors) *)
+(* \VV/ **************************************************************)
+(* // * This file is distributed under the terms of the *)
+(* * GNU Lesser General Public License Version 2.1 *)
+(* * (see LICENSE file for the text of the license) *)
+(************************************************************************)
+
+type xml = Xml_datatype.xml
+
+type t
+type target = TChannel of out_channel | TBuffer of Buffer.t
+
+val make : target -> t
+
+(** Print the xml data structure to a source into a compact xml string (without
+ any user-readable formating ). *)
+val print : t -> xml -> unit
+
+(** Print the xml data structure into a compact xml string (without
+ any user-readable formating ). *)
+val to_string : xml -> string
+
+(** Print the xml data structure into an user-readable string with
+ tabs and lines break between different nodes. *)
+val to_string_fmt : xml -> string
+
+(** Print PCDATA as a string by escaping XML entities. *)
+val pcdata_to_string : string -> string