src/tree.mli

   1
   2 type node = [ `Tree ] Node.t
   3 type t
   4 (** The type for documents *)
   5
   6 val parse_xml_uri : string -> t
   7 val parse_xml_string : string -> t
   8 val save : t -> string ->  unit
   9 val load : ?sample:int -> ?load_text:bool -> string -> t
  10 val tag_pool : t -> Tag.pool
  11
  12
  13 val nil : node
  14 val root : node
  15 val size : t -> int
  16 val is_root : node -> bool
  17 val is_nil : node -> bool
  18
  19 type unordered_set
  20
  21 val unordered_set_of_set : Ptset.Int.t -> unordered_set
  22
  23 val first_child : t -> node -> node
  24 val first_element : t -> node -> node
  25 val tagged_child : t -> node -> Tag.t -> node
  26 val select_child : t -> node -> unordered_set -> node
  27
  28
  29 val next_sibling : t -> node -> node
  30 val prev_sibling : t -> node -> node
  31 val next_element : t -> node -> node
  32 val next_node_before : t -> node -> node -> node
  33 val tagged_following_sibling : t -> node ->  Tag.t -> node
  34 val select_following_sibling : t -> node -> unordered_set -> node
  35
  36 val tagged_descendant : t -> node -> Tag.t -> node
  37 val tagged_next : t -> node -> Tag.t -> node
  38 val select_descendant : t -> node -> unordered_set -> node
  39
  40 val tagged_following_before : t -> node -> Tag.t -> node ->  node
  41 val select_following_before : t -> node -> unordered_set -> node -> node
  42
  43 val parent : t -> node -> node
  44 val binary_parent : t -> node -> node
  45 val is_first_child : t -> node -> bool
  46 val is_right_descendant : t -> node -> node -> bool
  47
  48 val tag : t -> node -> Tag.t
  49
  50 val attribute_tags : t -> Ptset.Int.t
  51
  52 val element_tags : t -> Ptset.Int.t
  53
  54 val node_tags : t -> Ptset.Int.t
  55
  56 val tags : t ->  Tag.t  -> Ptset.Int.t*Ptset.Int.t*Ptset.Int.t*Ptset.Int.t
  57
  58 val dump_tag_table : t -> unit
  59
  60 val subtree_tags : t -> node -> Tag.t -> int
  61
  62 val subtree_size : t -> node -> int
  63
  64 val subtree_elements : t -> node -> int
  65
  66 val closing : t -> node -> node
  67
  68 val stats : t -> unit
  69
  70 val num_tags : t -> int
  71 val tag_pool : t -> Tag.pool
  72
  73 val print_xml : t -> node -> Unix.file_descr -> unit
  74 val flush : t -> Unix.file_descr -> unit
  75
  76 module Predicate : Hcons.S with type data = (t -> node -> bool) ref
  77
  78 val mk_pred : [ `Prefix | `Suffix | `Equals | `Contains ] -> string -> Predicate.t
  79
  80 val full_text_query : [ `Prefix | `Suffix | `Equals | `Contains ] -> t -> string -> node array
  81
  82 val full_text_prefix : t -> string -> node array
  83
  84 val full_text_suffix : t -> string -> node array
  85
  86 val full_text_equals : t -> string -> node array
  87
  88 val full_text_contains : t -> string -> node array