src/naive_tree.ml

   1 (***********************************************************************)
   2 (*                                                                     *)
   3 (*                               TAToo                                 *)
   4 (*                                                                     *)
   5 (*                     Kim Nguyen, LRI UMR8623                         *)
   6 (*                   Université Paris-Sud & CNRS                       *)
   7 (*                                                                     *)
   8 (*  Copyright 2010-2012 Université Paris-Sud and Centre National de la *)
   9 (*  Recherche Scientifique. All rights reserved.  This file is         *)
  10 (*  distributed under the terms of the GNU Lesser General Public       *)
  11 (*  License, with the special exception on linking described in file   *)
  12 (*  ../LICENSE.                                                        *)
  13 (*                                                                     *)
  14 (***********************************************************************)
  15
  16 type node = {
  17   tag : QName.t;
  18   preorder : int;
  19   mutable kind : Tree.NodeKind.t;
  20   mutable data : string;
  21   mutable first_child : node;
  22   mutable next_sibling : node;
  23   mutable parent: node;
  24 }
  25
  26
  27
  28 let rec nil = {
  29   tag = QName.nil;
  30   kind = Tree.NodeKind.Element;
  31   preorder = -1;
  32   data = "";
  33   first_child = nil;
  34   next_sibling = nil;
  35   parent = nil;
  36 }
  37
  38 let dummy_tag = QName.of_string "#dummy"
  39 let rec dummy = {
  40   tag = dummy_tag;
  41   kind = Tree.NodeKind.Element;
  42   preorder = -1;
  43   data = "";
  44   first_child = dummy;
  45   next_sibling = dummy;
  46   parent = dummy;
  47 }
  48
  49
  50 type t = {
  51   root : node;
  52   size : int;
  53   by_preorder : node array;
  54   (* TODO add other intersting stuff *)
  55 }
  56
  57
  58
  59 module Parser =
  60 struct
  61
  62   type context = {
  63     mutable stack : node list;
  64     text_buffer : Buffer.t;
  65     mutable current_preorder : int;
  66   }
  67
  68   let print_node_ptr fmt n =
  69     Format.fprintf fmt "<%s>"
  70       (if n == nil then "NIL" else
  71         if n == dummy then "DUMMY" else
  72           "NODE " ^  string_of_int n.preorder)
  73
  74   let debug_node fmt node =
  75     Format.fprintf fmt
  76       "{ tag=%s; preorder=%i; data=%S;\
  77 first_child=%a; next_sibling=%a; parent=%a }"
  78       (QName.to_string node.tag)
  79       node.preorder
  80       node.data
  81       print_node_ptr node.first_child
  82       print_node_ptr node.next_sibling
  83       print_node_ptr node.parent
  84
  85
  86   let debug_ctx fmt ctx =
  87     Format.fprintf fmt "Current context: { preorder = %i\n; stack = \n%a\n }\
  88 \n-------------\n"
  89       ctx.current_preorder
  90       (Pretty.print_list ~sep:";\n" debug_node) ctx.stack
  91
  92
  93   let push n ctx = ctx.stack <- n :: ctx.stack
  94   let pop ctx =
  95     match ctx.stack with
  96       [] -> failwith "XML parse error"
  97     | e :: l -> ctx.stack <- l; e
  98
  99   let top ctx = match ctx.stack with
 100     | [] -> failwith "XML parse error"
 101     | e :: _ -> e
 102
 103   let next ctx =
 104     let i = ctx.current_preorder in
 105     ctx.current_preorder <- 1 + i;
 106     i
 107
 108   let is_left n = n.next_sibling == dummy
 109
 110
 111   let text_string = QName.to_string QName.text
 112   let comment_string = QName.to_string QName.comment
 113
 114
 115   let rec start_element_handler parser_ ctx tag attr_list =
 116     do_text parser_ ctx;
 117     let parent = top ctx in
 118     let n = { tag = QName.of_string tag;
 119               kind = Tree.NodeKind.Element;
 120               preorder = next ctx;
 121               data = "";
 122               first_child = dummy;
 123               next_sibling = dummy;
 124               parent = parent;
 125             }
 126     in
 127     if parent.first_child == dummy then parent.first_child <- n
 128     else parent.next_sibling <- n;
 129     push n ctx;
 130     List.iter (do_attribute parser_ ctx) attr_list
 131
 132   and do_attribute parser_ ctx (att, value) =
 133     let att_tag = QName.to_string (QName.attribute (QName.of_string att)) in
 134     start_element_handler parser_ ctx att_tag [];
 135     let n = top ctx in
 136     n.data <- value;
 137     n.kind <- Tree.NodeKind.Attribute;
 138     end_element_handler parser_ ctx att_tag
 139
 140   and consume_closing ctx n =
 141     if n.next_sibling != dummy then
 142       let _ = pop ctx in consume_closing ctx (top ctx)
 143
 144   and end_element_handler parser_ ctx _ =
 145     do_text parser_ ctx;
 146     let node = top ctx in
 147     if node.first_child == dummy then node.first_child <- nil
 148     else begin
 149       node.next_sibling <- nil;
 150       consume_closing ctx node
 151     end
 152
 153   and do_text parser_ ctx =
 154     if Buffer.length ctx.text_buffer != 0 then
 155       let s = Buffer.contents ctx.text_buffer in
 156       Buffer.clear  ctx.text_buffer;
 157       start_element_handler parser_ ctx text_string [];
 158       let node = top ctx in
 159       node.data <- s;
 160       node.kind <- Tree.NodeKind.Text;
 161       end_element_handler parser_ ctx text_string
 162
 163   and comment_handler parser_ ctx s =
 164     do_text parser_ ctx;
 165     start_element_handler parser_ ctx comment_string [];
 166     let node = top ctx in
 167     node.data <- s;
 168     node.kind <- Tree.NodeKind.Comment;
 169     end_element_handler parser_ ctx comment_string
 170
 171   and processing_instruction_handler parser_ ctx tag data =
 172     do_text parser_ ctx;
 173     let pi = QName.to_string
 174       (QName.processing_instruction (QName.of_string tag))
 175     in
 176     start_element_handler parser_ ctx pi [];
 177     let node = top ctx in
 178     node.data <- data;
 179     node.kind <- Tree.NodeKind.ProcessingInstruction;
 180     end_element_handler parser_ ctx pi
 181
 182
 183   let character_data_handler _parser ctx text =
 184     Buffer.add_string ctx.text_buffer text
 185
 186   let create_parser () =
 187     let ctx = { text_buffer = Buffer.create 512;
 188                 current_preorder = 0;
 189                 stack = [] } in
 190     let psr = Expat.parser_create ~encoding:None in
 191     Expat.set_start_element_handler psr (start_element_handler psr ctx);
 192     Expat.set_end_element_handler psr (end_element_handler psr ctx);
 193     Expat.set_character_data_handler
 194       psr (character_data_handler psr ctx);
 195     Expat.set_comment_handler psr (comment_handler psr ctx);
 196     Expat.set_processing_instruction_handler psr
 197       (processing_instruction_handler psr ctx);
 198     push { tag = QName.document;
 199            preorder = next ctx;
 200            kind = Tree.NodeKind.Document;
 201            data = "";
 202            first_child = dummy;
 203            next_sibling = dummy;
 204            parent = nil;
 205          } ctx;
 206     (psr,
 207      fun () ->
 208        let node = top ctx in
 209        node.next_sibling <- nil;
 210        consume_closing ctx node;
 211        Expat.final psr;
 212        let root = List.hd ctx.stack in
 213        root.next_sibling <- nil;
 214        let a = Array.create ctx.current_preorder nil in
 215        let rec loop n =
 216          if n != nil then
 217            begin
 218              a.(n.preorder) <- n;
 219              loop n.first_child;
 220              loop n.next_sibling;
 221            end
 222        in
 223        loop root;
 224        { root = root;
 225          size = ctx.current_preorder;
 226          by_preorder = a
 227        }
 228     )
 229
 230   let error e parser_ =
 231     let msg = Printf.sprintf "%i.%i %s"
 232       (Expat.get_current_line_number parser_)
 233       (Expat.get_current_column_number parser_)
 234       (Expat.xml_error_to_string e)
 235     in
 236     raise (Tree.Parse_error msg)
 237
 238   let parse_string s =
 239     let parser_, finalize = create_parser () in
 240     try
 241       Expat.parse parser_ s;
 242       finalize ()
 243     with
 244       Expat.Expat_error e -> error e parser_
 245
 246   let parse_file fd =
 247     let buffer = String.create 4096 in
 248     let parser_, finalize = create_parser () in
 249     let rec loop () =
 250       let read = input fd buffer 0 4096 in
 251       if read != 0 then
 252         let () = Expat.parse_sub parser_ buffer 0 read in
 253         loop ()
 254     in try
 255          loop (); finalize ()
 256       with
 257         Expat.Expat_error e -> error e parser_
 258
 259 end
 260
 261
 262 let load_xml_file = Parser.parse_file
 263 let load_xml_string = Parser.parse_string
 264
 265 let output_escape_string out s =
 266   for i = 0 to String.length s - 1 do
 267     match s.[i] with
 268     | '<' -> output_string out "&lt;"
 269     | '>' -> output_string out "&gt;"
 270     | '&' -> output_string out "&amp;"
 271     | '"' -> output_string out "&quot;"
 272     | '\'' -> output_string out "&apos;"
 273     | c -> output_char out c
 274   done
 275
 276
 277 let rec print_attributes ?(sep=true) out tree_ node =
 278   if (node.kind == Tree.NodeKind.Attribute) then
 279     let tag = QName.to_string (QName.remove_prefix node.tag) in
 280     if sep then output_char out ' ';
 281     output_string out tag;
 282     output_string out "=\"";
 283     output_escape_string out node.data;
 284     output_char out '\"';
 285     print_attributes out tree_ node.next_sibling
 286   else
 287     node
 288
 289 let rec print_xml out tree_ node =
 290   if node != nil then
 291   let () =
 292     let open Tree.NodeKind in
 293     match node.kind with
 294     | Node -> ()
 295     | Text -> output_escape_string out node.data
 296     | Element | Document ->
 297         let tag = QName.to_string node.tag in
 298         output_char out '<';
 299         output_string out tag;
 300         let fchild = print_attributes out tree_ node.first_child in
 301         if fchild == nil then output_string out "/>"
 302         else begin
 303           output_char out '>';
 304           print_xml out tree_ fchild;
 305           output_string out "</";
 306           output_string out tag;
 307           output_char out '>'
 308         end
 309     | Attribute -> ignore (print_attributes ~sep:false out tree_ node)
 310     | Comment ->
 311         output_string out "<!--";
 312         output_string out node.data;
 313         output_string out "-->"
 314     | ProcessingInstruction ->
 315         output_string out "<?";
 316         output_string out (QName.to_string (QName.remove_prefix node.tag));
 317         output_char out ' ';
 318         output_string out node.data;
 319         output_string out "?>"
 320   in
 321   print_xml out tree_ node.next_sibling
 322
 323 let print_xml out tree_ node =
 324   let nnode =  { node with next_sibling = nil } in print_xml out tree_ nnode
 325
 326 let root t = t.root
 327 let size t = t.size
 328 let first_child _ n = n.first_child
 329 let next_sibling _ n = n.next_sibling
 330 let parent _ n = n.parent
 331 let tag _ n = n.tag
 332 let data _ n = n.data
 333 let kind _ n = n.kind
 334 let preorder _ n = n.preorder
 335 let by_preorder t i =
 336  if i >= 0 && i < t.size then Array.unsafe_get t.by_preorder i
 337  else let e = Invalid_argument "by_preorder" in raise e
 338 let print_node fmt n = Parser.debug_node fmt n