libgrew.ml 14 KB
Newer Older
bguillaum's avatar
bguillaum committed
1 2 3 4 5 6 7 8 9 10
(**********************************************************************************)
(*    Libcaml-grew - a Graph Rewriting library dedicated to NLP applications      *)
(*                                                                                *)
(*    Copyright 2011-2013 Inria, Université de Lorraine                           *)
(*                                                                                *)
(*    Webpage: http://grew.loria.fr                                               *)
(*    License: CeCILL (see LICENSE folder or "http://www.cecill.info")            *)
(*    Authors: see AUTHORS file                                                   *)
(**********************************************************************************)

bguillaum's avatar
bguillaum committed
11
open Printf
pj2m's avatar
pj2m committed
12
open Log
13
open Conll
pj2m's avatar
pj2m committed
14

bguillaum's avatar
bguillaum committed
15
let libgrew_debug_mode () = Grew_base.Global.debug := true
bguillaum's avatar
bguillaum committed
16
let get_version () = VERSION
bguillaum's avatar
bguillaum committed
17

bguillaum's avatar
bguillaum committed
18
(* ==================================================================================================== *)
bguillaum's avatar
bguillaum committed
19
(** {2 Location} *)
bguillaum's avatar
bguillaum committed
20 21 22 23 24 25 26 27
(* ==================================================================================================== *)
module Loc = struct
  type t = Grew_base.Loc.t
  let to_string = Grew_base.Loc.to_string
  let to_line = Grew_base.Loc.to_line
end

(* ==================================================================================================== *)
bguillaum's avatar
bguillaum committed
28
(** {2 Exceptions} *)
bguillaum's avatar
bguillaum committed
29
(* ==================================================================================================== *)
30
exception File_not_found of string
bguillaum's avatar
bguillaum committed
31 32 33 34
exception Parsing_err of string * Loc.t option
exception Build of string * Loc.t option
exception Run of string * Loc.t option
exception Bug of string * Loc.t option
pj2m's avatar
pj2m committed
35

36 37
let handle ?(name="") ?(file="No file defined") fct () =
  try fct () with
bguillaum's avatar
typo  
bguillaum committed
38
    (* Raise again already caught exceptions *)
bguillaum's avatar
bguillaum committed
39 40 41 42
    | Parsing_err (msg,loc_opt) -> raise (Parsing_err (msg,loc_opt))
    | Build (msg,loc_opt) -> raise (Build (msg,loc_opt))
    | Bug (msg, loc_opt) -> raise (Bug (msg,loc_opt))
    | Run (msg, loc_opt) -> raise (Run (msg,loc_opt))
43
    | File_not_found file -> raise (File_not_found file)
44 45

    (* Catch new exceptions *)
46
    | Grew_base.Error.Parse (msg, loc_opt) -> raise (Parsing_err (msg, loc_opt))
bguillaum's avatar
bguillaum committed
47 48 49
    | Grew_base.Error.Build (msg, loc_opt) -> raise (Build (msg, loc_opt))
    | Grew_base.Error.Bug (msg, loc_opt) -> raise (Bug (msg,loc_opt))
    | Grew_base.Error.Run (msg, loc_opt) -> raise (Run (msg,loc_opt))
50

bguillaum's avatar
bguillaum committed
51 52
    | Conll.Error msg -> raise (Parsing_err (msg,None))

bguillaum's avatar
typo  
bguillaum committed
53
    | exc -> raise (Bug (sprintf "[Libgrew.%s] UNCAUGHT EXCEPTION: %s" name (Printexc.to_string exc), None))
pj2m's avatar
pj2m committed
54

bguillaum's avatar
bguillaum committed
55

bguillaum's avatar
bguillaum committed
56
(* ==================================================================================================== *)
57
(** {2 Domain} *)
bguillaum's avatar
bguillaum committed
58 59 60
(* ==================================================================================================== *)
module Domain = struct
  type t = Grew_types.Domain.t
61

bguillaum's avatar
bguillaum committed
62 63
  let load filename =
    let ast = Grew_loader.Loader.domain filename in
bguillaum's avatar
bguillaum committed
64
    Grew_grs.Grs.domain_build ast
65

bguillaum's avatar
bguillaum committed
66
  let feature_names domain =  handle ~name:"feature_names" (fun () -> Grew_types.Domain.feature_names domain) ()
bguillaum's avatar
bguillaum committed
67 68 69 70 71 72 73 74
end

(* ==================================================================================================== *)
(** {2 Patterns} *)
(* ==================================================================================================== *)
module Pattern = struct
  type t = Grew_rule.Rule.pattern

bguillaum's avatar
bguillaum committed
75 76
  let load ?domain file =
  handle ~name:"Pattern.load" (fun () -> Grew_rule.Rule.build_pattern ?domain (Grew_loader.Loader.pattern file)) ()
77 78 79

  let parse ?domain desc =
  handle ~name:"Pattern.load" (fun () -> Grew_rule.Rule.build_pattern ?domain (Grew_loader.Parser.pattern desc)) ()
bguillaum's avatar
bguillaum committed
80 81 82 83 84 85 86
end

(* ==================================================================================================== *)
(** {2 Matching} *)
(* ==================================================================================================== *)
module Matching = struct
  type t = Grew_rule.Rule.matching
87 88

  let to_python pattern graph t = Grew_rule.Rule.to_python pattern graph t
bguillaum's avatar
bguillaum committed
89 90 91 92 93 94 95 96 97 98 99
end

(* ==================================================================================================== *)
(** {2 Deco} *)
(* ==================================================================================================== *)
module Deco = struct
  type t = Grew_graph.G_deco.t
  let build pattern matching = Grew_rule.Rule.match_deco pattern matching
end

(* ==================================================================================================== *)
bguillaum's avatar
bguillaum committed
100
(** {2 Graph} *)
bguillaum's avatar
bguillaum committed
101 102 103 104 105 106
(* ==================================================================================================== *)
module Graph = struct


type t = Grew_graph.G_graph.t

bguillaum's avatar
bguillaum committed
107
  let load_gr ?domain file =
bguillaum's avatar
bguillaum committed
108
    if not (Sys.file_exists file)
109
    then raise (File_not_found file)
bguillaum's avatar
bguillaum committed
110 111 112 113
    else
      handle ~name:"Graph.load_gr" ~file
        (fun () ->
          let gr_ast = Grew_loader.Loader.gr file in
bguillaum's avatar
bguillaum committed
114
          Grew_graph.G_graph.build ?domain gr_ast
bguillaum's avatar
bguillaum committed
115
        ) ()
bguillaum's avatar
bguillaum committed
116

bguillaum's avatar
bguillaum committed
117
  let load_conll ?domain file =
bguillaum's avatar
bguillaum committed
118
    handle ~name:"Graph.load_conll" ~file
119
      (fun () ->
bguillaum's avatar
bguillaum committed
120
        Grew_graph.G_graph.of_conll ?domain (Conll.load file)
121
      ) ()
pj2m's avatar
pj2m committed
122

bguillaum's avatar
bguillaum committed
123
  let load_brown ?domain file =
bguillaum's avatar
bguillaum committed
124 125 126
    handle ~name:"Graph.load_brown"
      (fun () ->
        let brown = Grew_base.File.load file in
bguillaum's avatar
bguillaum committed
127
        Grew_graph.G_graph.of_brown ?domain brown
bguillaum's avatar
bguillaum committed
128
      ) ()
129

130
  let load_pst ?domain file =
131 132 133
    if not (Sys.file_exists file)
    then raise (File_not_found file)
    else
134
      handle ~name:"load_pst" ~file
135
        (fun () ->
136 137
          let const_ast = Grew_loader.Loader.phrase_structure_tree file in
          Grew_graph.G_graph.of_pst ?domain const_ast
138 139
        ) ()

bguillaum's avatar
bguillaum committed
140
  let load ?domain file =
bguillaum's avatar
bguillaum committed
141 142 143
    handle ~name:"Graph.load_graph" ~file
      (fun () ->
        match Grew_base.File.get_suffix file with
bguillaum's avatar
bguillaum committed
144 145 146
        | Some ".gr" -> load_gr ?domain file
        | Some ".conll" -> load_conll ?domain file
        | Some ".br" | Some ".melt" -> load_brown ?domain file
147
        | Some ".cst" -> load_pst ?domain file
bguillaum's avatar
bguillaum committed
148 149 150 151
        | _ ->
            Log.fwarning "Unknown file format for input graph '%s', try to guess..." file;
            let rec loop = function
            | [] -> Log.fcritical "[Libgrew.load_graph] Cannot guess input file format of file '%s'. Use .gr or .conll file extension" file
bguillaum's avatar
bguillaum committed
152
            | load_fct :: tail -> try load_fct ?domain file with _ -> loop tail in
153
            loop [load_gr; load_conll; load_brown; load_pst]
bguillaum's avatar
bguillaum committed
154
      ) ()
bguillaum's avatar
bguillaum committed
155

bguillaum's avatar
bguillaum committed
156 157
  let of_gr ?domain ?(grewpy=false) gr_string =
    handle ~name:"Graph.of_gr" (fun () -> Grew_graph.G_graph.build ?domain ~grewpy (Grew_loader.Parser.gr gr_string)) ()
158

bguillaum's avatar
bguillaum committed
159 160
  let of_conll ?domain conll =
    handle ~name:"Graph.of_conll" (fun () -> Grew_graph.G_graph.of_conll ?domain conll) ()
161

162 163
  let of_pst ?domain pst_string =
    handle ~name:"of_pst"
164
      (fun () ->
165 166 167 168 169 170 171 172 173 174
        let pst_ast = Grew_loader.Parser.phrase_structure_tree pst_string in
        (Grew_graph.G_graph.of_pst ?domain pst_ast)
      ) ()

  let sentence_of_pst ?domain pst_string =
    handle ~name:"of_pst"
      (fun () ->
        let pst_ast = Grew_loader.Parser.phrase_structure_tree pst_string in
        let word_list = Grew_ast.Ast.word_list pst_ast in
        Sentence.fr_clean_spaces (String.concat " " word_list)
175 176
      ) ()

bguillaum's avatar
bguillaum committed
177 178
  let of_brown ?domain ?sentid brown =
    handle ~name:"Graph.of_brown" (fun () -> Grew_graph.G_graph.of_brown ?domain ?sentid brown) ()
bguillaum's avatar
bguillaum committed
179

bguillaum's avatar
bguillaum committed
180 181
  let to_dot ?domain ?main_feat ?(deco=Grew_graph.G_deco.empty) graph =
    handle ~name:"Graph.to_dot" (fun () -> Grew_graph.G_graph.to_dot ?domain ?main_feat graph ~deco) ()
bguillaum's avatar
bguillaum committed
182

bguillaum's avatar
bguillaum committed
183 184
  let to_dep ?domain ?filter ?main_feat ?(deco=Grew_graph.G_deco.empty) graph =
    handle ~name:"Graph.to_dep" (fun () -> Grew_graph.G_graph.to_dep ?domain ?filter ?main_feat ~deco graph) ()
bguillaum's avatar
bguillaum committed
185

bguillaum's avatar
bguillaum committed
186 187
  let to_gr ?domain graph =
    handle ~name:"Graph.to_gr" (fun () -> Grew_graph.G_graph.to_gr ?domain graph) ()
bguillaum's avatar
bguillaum committed
188

bguillaum's avatar
bguillaum committed
189 190
  let to_conll_string ?domain graph =
    handle ~name:"Graph.to_conll_string" (fun () -> Grew_graph.G_graph.to_conll_string ?domain graph) ()
bguillaum's avatar
bguillaum committed
191

bguillaum's avatar
bguillaum committed
192 193 194 195 196
  let to_sentence ?main_feat gr =
    handle ~name:"Graph.to_sentence"
      (fun () ->
        Grew_graph.G_graph.to_sentence ?main_feat gr
      ) ()
bguillaum's avatar
bguillaum committed
197

bguillaum's avatar
bguillaum committed
198
  let save_conll ?domain filename graph =
bguillaum's avatar
bguillaum committed
199 200
    handle ~name:"Graph.save_conll" (fun () ->
      let out_ch = open_out filename in
bguillaum's avatar
bguillaum committed
201
      fprintf out_ch "%s" (Grew_graph.G_graph.to_conll_string ?domain graph);
bguillaum's avatar
bguillaum committed
202
      close_out out_ch
bguillaum's avatar
bguillaum committed
203 204
    ) ()

bguillaum's avatar
bguillaum committed
205
  let search_pattern ?domain pattern graph = Grew_rule.Rule.match_in_graph ?domain pattern graph
bguillaum's avatar
bguillaum committed
206

207 208
  let node_matching pattern graph matching  = Grew_rule.Rule.node_matching pattern graph matching

bguillaum's avatar
bguillaum committed
209
end
210

bguillaum's avatar
bguillaum committed
211
(* ==================================================================================================== *)
212
(** {2 Graph Rewriting System} *)
bguillaum's avatar
bguillaum committed
213 214 215
(* ==================================================================================================== *)
module Grs = struct
  type t = Grew_grs.Grs.t
216

bguillaum's avatar
bguillaum committed
217
  let empty = Grew_grs.Grs.empty
218

bguillaum's avatar
bguillaum committed
219 220 221 222
  let load file =
    handle ~name:"Grs.load" ~file
      (fun () ->
        if not (Sys.file_exists file)
223
        then raise (File_not_found file)
bguillaum's avatar
bguillaum committed
224 225
        else Grew_grs.Grs.build file
      ) ()
226

bguillaum's avatar
bguillaum committed
227 228 229 230 231
  let get_sequence_names grs =
    handle ~name:"Grs.get_sequence_names"
      (fun () ->
        Grew_grs.Grs.sequence_names grs
      ) ()
232

bguillaum's avatar
bguillaum committed
233 234 235 236 237 238 239
  let build_html_doc ?(corpus=false) dir grs =
    handle ~name:"Grs.build_doc [with Dep2pict]"
      (fun () ->
        Grew_html.Html_doc.build ~corpus ~dep:true dir grs;

        (* draw pattern graphs for all rules and all filters *)
        let fct module_ rule_ =
bguillaum's avatar
bguillaum committed
240
          let dep_code = Grew_rule.Rule.to_dep ?domain:(Grew_grs.Grs.get_domain grs) rule_ in
bguillaum's avatar
bguillaum committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
          let dep_png_file = sprintf "%s/%s_%s-patt.png" dir module_ (Grew_rule.Rule.get_name rule_) in
          let d2p = Dep2pict.Dep2pict.from_dep ~dep:dep_code in
          Dep2pict.Dep2pict.save_png ~filename:dep_png_file d2p in
        Grew_grs.Grs.rule_iter fct grs;
        Grew_grs.Grs.filter_iter fct grs
      ) ()

  let get_domain grs = Grew_grs.Grs.get_domain grs
end

(* ==================================================================================================== *)
(** {2 Rewrite} *)
(* ==================================================================================================== *)
module Rewrite = struct
  type display = Libgrew_types.rew_display
  type history = Grew_grs.Rewrite_history.t

258 259 260
  let set_max_depth_det value = Grew_rule.Rule.set_max_depth_det value
  let set_max_depth_non_det value = Grew_rule.Rule.set_max_depth_non_det value

bguillaum's avatar
bguillaum committed
261 262
  let set_debug_loop () = Grew_rule.Rule.set_debug_loop ()

bguillaum's avatar
bguillaum committed
263 264 265 266 267 268 269 270
  let display ~gr ~grs ~seq =
    handle ~name:"Rewrite.display" (fun () -> Grew_grs.Grs.build_rew_display grs seq gr) ()

  let set_timeout t = Grew_base.Timeout.timeout := t

  let rewrite ~gr ~grs ~seq =
    handle ~name:"Rewrite.rewrite" (fun () -> Grew_grs.Grs.rewrite grs seq gr) ()

271 272 273
  let get_graphs rh =
    handle ~name:"Rewrite.get_graphs" (fun () -> Grew_grs.Rewrite_history.get_graphs rh) ()

bguillaum's avatar
bguillaum committed
274 275 276 277 278 279 280 281 282
  let is_empty rh =
    handle ~name:"Rewrite.is_empty" (fun () -> Grew_grs.Rewrite_history.is_empty rh) ()

  let num_sol rh =
    handle ~name:"Rewrite.num_sol" (fun () -> Grew_grs.Rewrite_history.num_sol rh) ()

  let write_stat filename rew_hist =
    handle ~name:"Rewrite.write_stat" (fun () -> Grew_html.Gr_stat.save filename (Grew_html.Gr_stat.from_rew_history rew_hist)) ()

bguillaum's avatar
bguillaum committed
283 284
  let write_annot ?domain ~title static_dir annot_dir base_name_rew_hist_list =
    handle ~name:"Rewrite.write_annot" (fun () -> Grew_html.Html_annot.build ?domain ~title static_dir annot_dir base_name_rew_hist_list) ()
bguillaum's avatar
bguillaum committed
285 286 287 288

  let save_index ~dirname ~base_names =
    handle ~name:"Rewrite.save_index" (fun () ->
      let out_ch = open_out (Filename.concat dirname "index") in
289
      Array.iter (fun f -> fprintf out_ch "%s\n" f) base_names;
bguillaum's avatar
bguillaum committed
290
      close_out out_ch
291 292
    ) ()

bguillaum's avatar
bguillaum committed
293 294
  let save_gr ?domain base rew_hist =
    handle ~name:"Rewrite.save_gr" (fun () -> Grew_grs.Rewrite_history.save_gr ?domain base rew_hist) ()
bguillaum's avatar
bguillaum committed
295

bguillaum's avatar
bguillaum committed
296 297
  let save_conll ?domain base rew_hist =
    handle ~name:"Rewrite.save_conll" (fun () -> Grew_grs.Rewrite_history.save_conll ?domain base rew_hist) ()
bguillaum's avatar
bguillaum committed
298

bguillaum's avatar
bguillaum committed
299 300
  let save_full_conll ?domain base rew_hist =
    handle ~name:"Rewrite.save_full_conll" (fun () -> Grew_grs.Rewrite_history.save_full_conll ?domain base rew_hist) ()
bguillaum's avatar
bguillaum committed
301

bguillaum's avatar
bguillaum committed
302 303
  let save_det_gr ?domain base rew_hist =
    handle ~name:"Rewrite.save_det_gr" (fun () -> Grew_grs.Rewrite_history.save_det_gr ?domain base rew_hist) ()
bguillaum's avatar
bguillaum committed
304

bguillaum's avatar
bguillaum committed
305 306
  let save_det_conll ?domain ?header base rew_hist =
    handle ~name:"Rewrite.save_det_conll" (fun () -> Grew_grs.Rewrite_history.save_det_conll ?domain ?header base rew_hist) ()
bguillaum's avatar
bguillaum committed
307

bguillaum's avatar
bguillaum committed
308 309
  let det_dep_string ?domain rew_hist =
    handle ~name:"Rewrite.det_dep_string" (fun () -> Grew_grs.Rewrite_history.det_dep_string ?domain rew_hist) ()
bguillaum's avatar
bguillaum committed
310

bguillaum's avatar
bguillaum committed
311 312
  let conll_dep_string ?domain ?keep_empty_rh rew_hist =
    handle ~name:"Rewrite.conll_dep_string" (fun () -> Grew_grs.Rewrite_history.conll_dep_string ?domain ?keep_empty_rh rew_hist) ()
bguillaum's avatar
bguillaum committed
313

bguillaum's avatar
bguillaum committed
314
  let write_html ?domain ?(no_init=false) ?(out_gr=false) ?filter ?main_feat ?dot ~header ?graph_file rew_hist output_base =
bguillaum's avatar
bguillaum committed
315 316
    handle ~name:"Rewrite.write_html" (fun () ->
      ignore (
bguillaum's avatar
bguillaum committed
317
        Grew_html.Html_rh.build ?domain ?filter ?main_feat ?dot ~out_gr ~init_graph: (not no_init) ~header ?graph_file output_base rew_hist
bguillaum's avatar
bguillaum committed
318 319 320
      )
    ) ()

bguillaum's avatar
bguillaum committed
321
  let error_html ?domain ?(no_init=false) ?main_feat ?dot ~header msg ?init output_base =
bguillaum's avatar
bguillaum committed
322 323
    handle ~name:"Rewrite.error_html" (fun () ->
      ignore (
bguillaum's avatar
bguillaum committed
324
        Grew_html.Html_rh.error ?domain ?main_feat ?dot ~init_graph: (not no_init) ~header output_base msg init
bguillaum's avatar
bguillaum committed
325 326 327 328 329 330 331
      )
    ) ()

  let make_index ~title ~grs_file ~html ~grs ~seq ~input_dir ~output_dir ~base_names  =
    handle ~name:"Rewrite.make_index" (fun () ->
      let init = Grew_html.Corpus_stat.empty grs seq in
      let corpus_stat =
332
        Array.fold_left
bguillaum's avatar
bguillaum committed
333 334 335 336 337
          (fun acc base_name ->
            Grew_html.Corpus_stat.add_gr_stat base_name (Grew_html.Gr_stat.load (Filename.concat output_dir (base_name^".stat"))) acc
          ) init base_names in
      Grew_html.Corpus_stat.save_html title grs_file input_dir output_dir corpus_stat
    ) ()
bguillaum's avatar
bguillaum committed
338

bguillaum's avatar
bguillaum committed
339 340
  let html_sentences ~title = handle ~name:"Rewrite.html_sentences" (fun () -> Grew_html.Html_sentences.build ~title) ()
end