diff options
Diffstat (limited to 'lib/xml_utils.mli')
-rw-r--r-- | lib/xml_utils.mli | 93 |
1 files changed, 0 insertions, 93 deletions
diff --git a/lib/xml_utils.mli b/lib/xml_utils.mli deleted file mode 100644 index 4a4a1309..00000000 --- a/lib/xml_utils.mli +++ /dev/null @@ -1,93 +0,0 @@ -(* - * Xml Light, an small Xml parser/printer with DTD support. - * Copyright (C) 2003 Nicolas Cannasse (ncannasse@motion-twin.com) - * - * This library is free software; you can redistribute it and/or - * modify it under the terms of the GNU Lesser General Public - * License as published by the Free Software Foundation; either - * version 2.1 of the License, or (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU - * Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public - * License along with this library; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA - *) - -(** Xml Light - - Xml Light is a minimal Xml parser & printer for OCaml. - It provide few functions to parse a basic Xml document into - an OCaml data structure and to print back the data structures - to an Xml document. - - Xml Light has also support for {b DTD} (Document Type Definition). - - {i (c)Copyright 2002-2003 Nicolas Cannasse} -*) - -open Xml_parser - -(** {6 Xml Functions} *) - -exception Not_element of xml -exception Not_pcdata of xml -exception No_attribute of string - -(** [tag xdata] returns the tag value of the xml node. - Raise {!Xml.Not_element} if the xml is not an element *) -val tag : xml -> string - -(** [pcdata xdata] returns the PCData value of the xml node. - Raise {!Xml.Not_pcdata} if the xml is not a PCData *) -val pcdata : xml -> string - -(** [attribs xdata] returns the attribute list of the xml node. - First string if the attribute name, second string is attribute value. - Raise {!Xml.Not_element} if the xml is not an element *) -val attribs : xml -> (string * string) list - -(** [attrib xdata "href"] returns the value of the ["href"] - attribute of the xml node (attribute matching is case-insensitive). - Raise {!Xml.No_attribute} if the attribute does not exists in the node's - attribute list - Raise {!Xml.Not_element} if the xml is not an element *) -val attrib : xml -> string -> string - -(** [children xdata] returns the children list of the xml node - Raise {!Xml.Not_element} if the xml is not an element *) -val children : xml -> xml list - -(*** [enum xdata] returns the children enumeration of the xml node - Raise {!Xml.Not_element} if the xml is not an element *) -(* val enum : xml -> xml Enum.t *) - -(** [iter f xdata] calls f on all children of the xml node. - Raise {!Xml.Not_element} if the xml is not an element *) -val iter : (xml -> unit) -> xml -> unit - -(** [map f xdata] is equivalent to [List.map f (Xml.children xdata)] - Raise {!Xml.Not_element} if the xml is not an element *) -val map : (xml -> 'a) -> xml -> 'a list - -(** [fold f init xdata] is equivalent to - [List.fold_left f init (Xml.children xdata)] - Raise {!Xml.Not_element} if the xml is not an element *) -val fold : ('a -> xml -> 'a) -> 'a -> xml -> 'a - -(** {6 Xml Printing} *) - -(** Print the xml data structure to a channel into a compact xml string (without - any user-readable formating ). *) -val print_xml : out_channel -> 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 |