grew_types.ml 19.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
(**********************************************************************************)
(*    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                                                   *)
(**********************************************************************************)

open Log
open Printf

open Grew_base

type feature_name = string (* cat, num, ... *)
type feature_atom = string (* V, N, inf, ... *)
type feature_value = string (* V, 4, "free text", ... *)
type suffix = string

bguillaum's avatar
bguillaum committed
21 22 23 24 25 26 27 28 29 30 31
type value = String of string | Float of float

let string_of_value = function
  | String s -> Str.global_replace (Str.regexp "\"") "\\\""
    (Str.global_replace (Str.regexp "\\\\") "\\\\\\\\" s)
  | Float i -> String_.of_float i

let conll_string_of_value = function
  | String s -> s
  | Float i -> String_.of_float i

bguillaum's avatar
bguillaum committed
32 33 34 35 36 37
let dot_color string =
  match (string.[0], String.length string) with
  | ('#', 4) -> sprintf "\"#%c%c%c%c%c%c\"" string.[1] string.[1] string.[2] string.[2] string.[3] string.[3]
  | ('#', 7) -> sprintf "\"%s\"" string
  | _ -> string

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116
(* ================================================================================ *)
module Pid = struct
  (* type t = int *)
  type t = Pos of int | Neg of int

  let compare = Pervasives.compare

  let to_id = function
    | Pos i -> sprintf "p_%d" i
    | Neg i -> sprintf "n_%d" i

  let to_string = function
    | Pos i -> sprintf "Pos %d" i
    | Neg i -> sprintf "Neg %d" i
end (* module Pid *)

(* ================================================================================ *)
module Pid_map =
  struct
    include Map.Make (Pid)

    exception True

    let exists fct map =
      try
        iter
          (fun key value ->
            if fct key value
            then raise True
          ) map;
        false
      with True -> true

    (* union of two maps*)
    let union_map m m' = fold (fun k v m'' -> (add k v m'')) m m'
end (* module Pid_map *)

(* ================================================================================ *)
module Pid_set = Set.Make (Pid)

(* ================================================================================ *)
module Gid = struct
  type t =
    | Old of int
    | New of (int * int) (* identifier for "created nodes" *)
    | Act of (int * string)  (* identifier for "activated nodes" *)

  (* a compare function which ensures that new nodes are at the "end" of the graph *)
  let compare t1 t2 = match (t1,t2) with
    | Old o1, Old o2 -> Pervasives.compare o1 o2

    | Old _ , New _ -> -1
    | New _, Old _ -> 1
    | New n1, New n2 -> Pervasives.compare n1 n2

    | Old _ , Act _ -> -1
    | Act _, Old _ -> 1
    | Act n1, Act n2 -> Pervasives.compare n1 n2

    | Act _ , New _ -> -1
    | New _, Act _ -> 1

  let to_string = function
    | Old i -> sprintf "%d" i
    | New (i,j) -> sprintf"%d__%d" i j
    | Act (i,n) -> sprintf"%d____%s" i n
end (* module Gid *)

(* ================================================================================ *)
module Gid_map = Map.Make (Gid)

(* ================================================================================ *)
module Massoc_gid = Massoc_make (Gid)

(* ================================================================================ *)
module Massoc_pid = Massoc_make (Pid)

(* ================================================================================ *)
module Label = struct
117 118 119 120 121 122 123 124 125 126
  (** describe the display style of a label *)
  type line = Solid | Dot | Dash
  type style = {
    text: string;
    bottom: bool;
    color: string option;
    bgcolor: string option;
    line: line;
  }

127 128
  (** Global names and display styles are recorded in two aligned arrays *)
  let full = ref None
129
  let styles = ref ([||] : style array)
130 131 132 133 134

  (** Internal representation of labels *)
  type t =
    | Global of int       (* globally defined labels: their names are in the [full] array *)
    | Local of int        (* locally defined labels: names array should be provided! UNTESTED *)
135 136 137 138 139 140 141 142
    | Pattern of string

  let match_ p_label g_label = match (p_label, g_label, !full) with
    | (Global p, Global g, _) when p=g -> true
    | (Pattern p, Global i, Some table) when String_.match_star_re p table.(i) -> true
    | _ -> false

  let match_list p_label_list g_label = List.exists (fun p_label -> match_ p_label g_label) p_label_list
143 144 145 146 147 148

  (** [to_string t] returns a string for the label *)
  let to_string ?(locals=[||]) t =
    match (!full, t) with
      | (Some table, Global i) -> table.(i)
      | (Some _, Local i) -> fst locals.(i)
149
      | (_, Pattern s) -> s
150
      | _ -> Error.bug "[Label.to_string] labels were not properly initialized"
151 152 153 154 155 156 157 158 159 160 161

  let to_int = function
    | Global i -> Some i
    | _ -> None

  (** The [default] style value *)
  let default = { text="UNSET"; bottom=false; color=None; bgcolor=None; line=Solid }

  let get_style = function
    | Global i -> !styles.(i)
    | Local i -> Log.warning "Style of locally defined labels is not implemented"; default
162
    | Pattern _ -> default
163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208

  (** Computes the style of a label from its options and maybe its shape (like I:...). *)
  let parse_option string_label options =
    let init_style = match Str.bounded_split (Str.regexp ":") string_label 2 with
      | ["S"; l] -> {default with text=l; color=Some "red"}
      | ["D"; l] -> {default with text=l; color=Some "blue"; bottom=true}
      | ["I"; l] -> {default with text=l; color=Some "grey"}
      | _ -> {default with text=string_label} in
      List.fold_left
        (fun acc_style -> function
            | "@bottom" -> {acc_style with bottom=true}
            | "@dash" -> {acc_style with line=Dash}
            | "@dot" -> {acc_style with line=Dot}
            | s when String.length s > 4 && String.sub s 0 4 = "@bg_" ->
              let color = String.sub s 4 ((String.length s) - 4) in
              {acc_style with bgcolor=Some color}
            | s -> {acc_style with color=Some (String_.rm_first_char s)}
        ) init_style options

  (** [decl] is the type for a label declaration: the name and a list of display styles *)
  type decl = string * string list

  (* [init decl_list] updates global arrays [full] and [styles] *)
  let init decl_list =
    let slist = List.sort (fun (x,_) (y,_) -> compare x y) decl_list in
    let (labels, opts) = List.split slist in
    let labels_array = Array.of_list labels in
    full := Some labels_array;
    styles := Array.mapi (fun i opt -> parse_option labels_array.(i) opt) (Array.of_list opts)

  let to_dep ?(deco=false) t =
    let style = get_style t in
    let dep_items =
      (if style.bottom then ["bottom"] else [])
      @ (match style.color with Some c -> ["color="^c; "forecolor="^c] | None -> [])
      @ (match style.bgcolor with Some c -> ["bgcolor="^c] | None -> [])
      @ (match style.line with
        | Dot -> ["style=dot"]
        | Dash -> ["style=dash"]
        | Solid when deco -> ["bgcolor=yellow"]
        | Solid -> []) in
    sprintf "{ label = \"%s\"; %s}" style.text (String.concat "; " dep_items)

  let to_dot ?(deco=false) t =
    let style = get_style t in
    let dot_items =
bguillaum's avatar
bguillaum committed
209
      (match style.color with Some c -> let d = dot_color c in ["color="^d; "fontcolor="^d] | None -> [])
210 211 212 213 214 215 216 217
      @ (match style.line with
        | Dot -> ["style=dotted"]
        | Dash -> ["style=dashed"]
        | Solid when deco -> ["style=dotted"]
        | Solid -> []) in
    sprintf "[label=\"%s\", %s]" style.text (String.concat ", " dot_items)

  let from_string ?loc ?(locals=[||]) string =
218 219 220 221 222 223 224 225 226 227
    if String.contains string '*'
    then Pattern string
    else
      match !full with
        | None -> Error.bug "[Label.from_string] labels were not properly initialized"
        | Some table ->
          try Global (Id.build ?loc string table)
          with Not_found (* TODO (CANNOT BE RAISED) *) ->
            try Local (Array_.dicho_find_assoc string locals)
            with Not_found -> Error.build "[Label.from_string] unknown edge label '%s'" string
228 229
end (* module Label *)

bguillaum's avatar
bguillaum committed
230 231 232 233 234 235 236
(* ================================================================================ *)
(** The module [Label_cst] defines contraints on label edges *)
module Label_cst = struct
  type t =
  | Pos of Label.t list
  | Neg of Label.t list

bguillaum's avatar
bguillaum committed
237 238 239 240
  let to_string = function
    | Pos l -> (List_.to_string Label.to_string "|" l)
    | Neg l -> "^"^(List_.to_string Label.to_string "|" l)

bguillaum's avatar
bguillaum committed
241 242 243 244 245 246 247
  let all = Neg []

  let match_ edge = function
    | Pos labels -> Label.match_list labels edge
    | Neg labels -> not (Label.match_list labels edge)

  let build ?loc ?locals = function
bguillaum's avatar
bguillaum committed
248 249
  | (edge_labels, true) -> Neg (List.sort compare (List.map (Label.from_string ?loc ?locals) edge_labels))
  | (edge_labels, false) -> Pos (List.sort compare (List.map (Label.from_string ?loc ?locals) edge_labels))
bguillaum's avatar
bguillaum committed
250 251 252
end (* module Label_cst *)


bguillaum's avatar
bguillaum committed
253
(* ================================================================================ *)
bguillaum's avatar
bguillaum committed
254 255 256 257
module Domain = struct
  type feature_spec =
    | Closed of feature_name * feature_atom list (* cat:V,N *)
    | Open of feature_name (* phon, lemma, ... *)
bguillaum's avatar
bguillaum committed
258
    | Num of feature_name (* position *)
bguillaum's avatar
bguillaum committed
259

bguillaum's avatar
bguillaum committed
260
  type t = feature_spec list
bguillaum's avatar
bguillaum committed
261

262 263 264 265
  let (current: t option ref) = ref None

  let reset () = current := None

bguillaum's avatar
bguillaum committed
266 267 268 269
  let is_defined feature_name domain =
    List.exists (function
      | Closed (fn,_) when fn = feature_name -> true
      | Open fn when fn = feature_name -> true
bguillaum's avatar
bguillaum committed
270
      | Num fn when fn = feature_name -> true
bguillaum's avatar
bguillaum committed
271 272 273
      | _ -> false
    ) domain

274 275 276 277 278 279 280 281
  let get feature_name domain =
    List.find (function
      | Closed (fn,_) when fn = feature_name -> true
      | Open fn when fn = feature_name -> true
      | Num fn when fn = feature_name -> true
      | _ -> false
    ) domain

282 283 284 285 286 287 288 289 290 291 292
  let check_feature_name ?loc name =
    match !current with
      | None -> ()
      | Some dom when is_defined name dom -> ()
      | _ -> Error.build ?loc "The feature name \"%s\" in not defined in the domain" name

  let is_open name =
      match !current with
      | None -> true
      | Some dom -> List.exists (function Open n when n=name -> true | _ -> false) dom

bguillaum's avatar
bguillaum committed
293
  let rec normalize_domain = function
bguillaum's avatar
bguillaum committed
294 295
    | [] -> [Num "position"]
    | (Num "position") :: tail -> Log.warning "[Domain] declaration of the feature name \"position\" in useless"; normalize_domain tail
bguillaum's avatar
bguillaum committed
296 297 298
    | (Open "position") :: _
    | (Closed ("position",_)) :: _ ->
      Error.build "[Domain] The feature named \"position\" is reserved and must be types 'integer', you cannot not redefine it"
bguillaum's avatar
bguillaum committed
299
    | (Num fn) :: tail |  (Open fn) :: tail |  Closed (fn,_) :: tail when is_defined fn tail ->
bguillaum's avatar
bguillaum committed
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
      Error.build "[Domain] The feature named \"%s\" is defined several times" fn
    | x :: tail -> x :: (normalize_domain tail)

  let init domain =
    current := Some (normalize_domain domain)

  let build ?loc name unsorted_values =
    let values = List.sort Pervasives.compare unsorted_values in
    match (name.[0], !current) with
      | ('_', _) (* no check on feat_name starting with '_' *)
      | (_, None) -> List.map (fun s -> String s) values (* no domain defined *)
      | (_, Some dom) ->
        let rec loop = function
          | [] -> Error.build ?loc "[GRS] Unknown feature name '%s'" name
          | ((Open n)::_) when n = name ->
            List.map (fun s -> String s) values
bguillaum's avatar
bguillaum committed
316
          | ((Num n)::_) when n = name ->
bguillaum's avatar
bguillaum committed
317 318 319 320 321 322 323
            (try List.map (fun s -> Float (String_.to_float s)) values
            with Failure _ -> Error.build ?loc "[GRS] The feature '%s' is of type int" name)
          | ((Closed (n,vs))::_) when n = name ->
            (match List_.sort_diff values vs with
              | [] -> List.map (fun s -> String s) values
              | l when List.for_all (fun x -> x.[0] = '_') l -> List.map (fun s -> String s) values
              | l -> Error.build ?loc "Unknown feature values '%s' for feature name '%s'"
324
                  (List_.to_string (fun x->x) ", " l)
bguillaum's avatar
bguillaum committed
325 326 327 328 329 330 331 332 333 334
          name
            )
          | _::t -> loop t in
        loop dom

  let build_one ?loc name value =
    match build ?loc name [value] with
      | [x] -> x
      | _ -> Error.bug ?loc "[Domain.build_one]"

335 336 337
  let check_feature ?loc name value =
    ignore (build ?loc name [value])

bguillaum's avatar
bguillaum committed
338 339 340
  let feature_names () =
    match !current with
      | None -> None
bguillaum's avatar
bguillaum committed
341
      | Some dom -> Some (List.map (function Closed (fn, _) | Open fn | Num fn -> fn) dom)
342 343 344 345 346 347 348 349 350 351 352 353

  let sub name1 name2 =
    match !current with
      | None -> true
      | Some dom ->
      match (get name1 dom, get name2 dom) with
        | (_, Open _) -> true
        | (Closed (_,l1), Closed (_,l2)) -> List_.sort_include l1 l2
        | (Num _, Num _) -> true
        | _ -> false


354 355 356 357 358 359 360 361 362 363 364 365
  let build_closed feature_name feature_values =
    let sorted_list = List.sort Pervasives.compare feature_values in
    let without_duplicate =
      let rec loop = function
        | [] -> []
        | x::y::tail when x=y ->
          Log.fwarning "In the declaration of the feature name \"%s\", the value \"%s\" appears more than once" feature_name x;
          loop (y::tail)
        | x::tail -> x:: (loop tail)
      in loop sorted_list in
    Closed (feature_name, without_duplicate)

bguillaum's avatar
bguillaum committed
366 367
end (* Domain *)

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
(* ================================================================================ *)
module Conll = struct
  type line = {
      line_num: int;
      num: string;
      phon: string;
      lemma: string;
      pos1: string;
      pos2: string;
      morph: (string * string) list;
      deps: (string * string ) list;
    }

  let root = { line_num = -1; num="0"; phon="ROOT"; lemma="__"; pos1="_X"; pos2=""; morph=[]; deps=[] }

  let line_to_string l =
    let (gov_list, lab_list) = List.split l.deps in
    sprintf "%s\t%s\t%s\t%s\t%s\t%s\t%s\t%s"
      l.num l.phon l.lemma l.pos1 l.pos2
      (match l.morph with [] -> "_" | list -> String.concat "|" (List.map (fun (f,v) -> sprintf "%s=%s" f v) list))
      (String.concat "|" (gov_list))
      (String.concat "|" (lab_list))

  let parse_morph file_name line_num = function
    | "_" -> []
    | morph ->
      List.map
        (fun feat ->
          match Str.split (Str.regexp "=") feat with
            | [feat_name] -> (feat_name, "true")
            | [feat_name; feat_value] -> (feat_name, feat_value)
bguillaum's avatar
bguillaum committed
399
            | _ -> Error.build ~loc:(Loc.file_line file_name line_num) "[Conll.load] illegal morphology \n>>>>>%s<<<<<<" morph
400 401 402
        ) (Str.split (Str.regexp "|") morph)

  let underscore s = if s = "" then "_" else s
bguillaum's avatar
bguillaum committed
403 404 405 406 407 408

  exception Dash
  let contain_dash s =
    try String.iter (function '-' -> raise Dash | _ -> ()) s; false
    with Dash -> true

409 410
  let parse_line file_name (line_num, line) =
    match Str.split (Str.regexp "\t") line with
bguillaum's avatar
bguillaum committed
411
      | num :: _ when contain_dash num -> None
412 413 414 415 416 417
      | [ num; phon; lemma; pos1; pos2; morph; govs; dep_labs; _; _ ] ->
        begin
          try
            let gov_list = if govs = "_" then [] else Str.split (Str.regexp "|") govs
            and lab_list = if dep_labs = "_" then [] else Str.split (Str.regexp "|") dep_labs in
            let deps = List.combine gov_list lab_list in
bguillaum's avatar
bguillaum committed
418 419 420 421 422 423 424 425 426
            Some {
              line_num = line_num;
              num = num;
              phon = underscore phon;
              lemma = underscore lemma;
              pos1 = underscore pos1;
              pos2 = underscore pos2;
              morph = parse_morph file_name line_num morph;
              deps = deps;
427
            }
bguillaum's avatar
bguillaum committed
428
          with exc -> Error.build ~loc:(Loc.file_line file_name line_num) "[Conll.load] illegal line, exc=%s\n>>>>>%s<<<<<<" (Printexc.to_string exc) line
429
        end
bguillaum's avatar
bguillaum committed
430
      | l -> Error.build ~loc:(Loc.file_line file_name line_num) "[Conll.load] illegal line, %d fields (10 are expected)\n>>>>>%s<<<<<<" (List.length l) line
431 432 433

  let load file_name =
    let lines = File.read_ln file_name in
bguillaum's avatar
bguillaum committed
434
    List_.opt_map (parse_line file_name) lines
435

bguillaum's avatar
bguillaum committed
436
  let parse file_name lines = List_.opt_map (parse_line file_name) lines
437 438 439 440 441 442 443 444 445 446 447 448 449

    (* We would prefer to compare the float equivalent of l1.num l2.num but this would break the dicho_find function *)
  let compare l1 l2 = Pervasives.compare ((* float_of_string *) l1.num) ((* float_of_string *) l2.num)
end (* module Conll *)

(* ================================================================================ *)
(* This module defines a type for lexical parameter (i.e. one line in a lexical file) *)
module Lex_par = struct

  type item = string list * string list (* first list: pattern parameters $id , second list command parameters @id *)

  type t = item list

bguillaum's avatar
bguillaum committed
450
  let size = List.length
451 452
  let append = List.append

bguillaum's avatar
bguillaum committed
453 454 455 456
  let signature = function
    | [] -> Error.bug "[Lex_par.signature] empty data"
    | (pp,cp)::_ -> (List.length pp,List.length cp)

457 458 459 460 461 462 463 464 465
  let dump t =
    printf "[Lex_par.dump] --> size = %d\n" (List.length t);
    List.iter (fun (pp,cp) ->
      printf "%s##%s\n"
        (String.concat "#" pp)
        (String.concat "#" cp)
    ) t

  let parse_line ?loc nb_p nb_c line =
bguillaum's avatar
bguillaum committed
466
    let line = String_.rm_peripheral_white line in
467 468 469
    if line = "" || line.[0] = '%'
    then None
    else
470
      let line = Str.global_replace (Str.regexp "\\\\%") "%" line in
471 472 473 474
      match Str.split (Str.regexp "##") line with
        | [args] when nb_c = 0 ->
          (match Str.split (Str.regexp "#") args with
            | l when List.length l = nb_p -> Some (l,[])
bguillaum's avatar
bguillaum committed
475
            | _ -> Error.build ?loc
476 477 478 479 480
              "Illegal lexical parameter line: \"%s\" doesn't contain %d args"
              line nb_p)
        | [args; values] ->
          (match (Str.split (Str.regexp "#") args, Str.split (Str.regexp "#") values) with
            | (lp,lc) when List.length lp = nb_p && List.length lc = nb_c -> Some (lp,lc)
bguillaum's avatar
bguillaum committed
481
            | _ -> Error.build ?loc
482 483
              "Illegal lexical parameter line: \"%s\" doesn't contain %d args and %d values"
              line nb_p nb_c)
bguillaum's avatar
bguillaum committed
484
        | _ -> Error.build ?loc "Illegal param line: '%s'" line
485

bguillaum's avatar
bguillaum committed
486 487 488 489
  let from_lines ?loc nb_p nb_c lines =
    match List_.opt_map (parse_line ?loc nb_p nb_c) lines with
    | [] -> Error.build ?loc "Empty lexical parameter list"
    | l -> l
490 491 492 493 494 495 496 497

  let load ?loc dir nb_p nb_c file =
    try
      let full_file =
        if Filename.is_relative file
        then Filename.concat dir file
        else file in
      let lines = File.read full_file in
bguillaum's avatar
bguillaum committed
498 499 500
      match List_.opt_mapi (fun i line -> parse_line ~loc:(Loc.file_line full_file i) nb_p nb_c line) lines with
      | [] -> Error.build ?loc "Empty lexical parameter file '%s'" file
      | l -> l
501 502
    with Sys_error _ -> Error.build ?loc "External lexical file '%s' not found" file

bguillaum's avatar
bguillaum committed
503
  let select index atom t =
504 505 506 507
    match
      List_.opt_map
        (fun (p_par, c_par) ->
          let par = List.nth p_par index in
bguillaum's avatar
bguillaum committed
508
          if atom = par
509
          then Some (p_par, c_par)
bguillaum's avatar
bguillaum committed
510
          else None
511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
        ) t
    with
    | [] -> None
    | t -> Some t

  let get_param_value index = function
    | [] -> Error.bug "[Lex_par.get_command_value] empty parameter"
    | (params,_)::_ -> List.nth params index

  let get_command_value index = function
    | [(_,one)] -> List.nth one index
    | [] -> Error.bug "[Lex_par.get_command_value] empty parameter"
    | (_,[sing])::tail when index=0 ->
        Printf.sprintf "%s/%s"
          sing
          (List_.to_string
             (function
               | (_,[s]) -> s
               | _ -> Error.bug "[Lex_par.get_command_value] inconsistent param"
             ) "/" tail
          )
    | l -> Error.run "Lexical parameter are not functionnal"
end (* module Lex_par *)
bguillaum's avatar
bguillaum committed
534 535 536 537 538 539 540 541

(* ================================================================================ *)
module Concat_item = struct
  type t =
    | Feat of (Gid.t * feature_name)
    | String of string
end (* module Concat_item *)