grew_ast.mli 8.24 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 Grew_base
12
open Grew_types
13

bguillaum's avatar
bguillaum committed
14
module Ast : sig
15 16

  (* ---------------------------------------------------------------------- *)
bguillaum's avatar
bguillaum committed
17
  (* simple_ident: cat or V *)
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
  type simple_ident = Id.name
  val parse_simple_ident: string -> simple_ident
  val is_simple_ident: string -> bool
  val dump_simple_ident: simple_ident -> string

  (* ---------------------------------------------------------------------- *)
  (* label_ident: D:mod.dis *)
  type label_ident = string
  val parse_label_ident: string -> label_ident
  val dump_label_ident: label_ident -> string

  (* ---------------------------------------------------------------------- *)
  (* pattern_label_ident: D:mod.* *)
  type pattern_label_ident = string
  val parse_pattern_label_ident: string -> pattern_label_ident
  val dump_pattern_label_ident: pattern_label_ident -> string

35 36 37 38 39 40
  (* ---------------------------------------------------------------------- *)
  (* node_ident: W0.5 *)
  type node_ident = string
  val parse_node_ident: string -> node_ident
  val dump_node_ident: node_ident -> string

41 42 43 44 45 46
  (* ---------------------------------------------------------------------- *)
  (* feature_ident: V.cat *)
  type feature_ident = Id.name * feature_name
  val parse_feature_ident: string -> feature_ident
  val dump_feature_ident: feature_ident -> string

bguillaum's avatar
bguillaum committed
47 48 49 50 51 52
  (* ---------------------------------------------------------------------- *)
  (* simple_or_feature_ident: union of simple_ident and feature_ident *)
  (* Note: used for parsing of "X < Y" and "X.feat < Y.feat" without conflicts *)
  type simple_or_feature_ident = Id.name * feature_name option
  val parse_simple_or_feature_ident: string -> simple_or_feature_ident

53
  (* ---------------------------------------------------------------------- *)
54
  type feature_kind =
55 56
    | Equality of feature_value list
    | Disequality of feature_value list
bguillaum's avatar
bguillaum committed
57
    | Equal_param of string (* $ident *)
bguillaum's avatar
bguillaum committed
58
    | Absent
bguillaum's avatar
bguillaum committed
59 60

  type u_feature = {
61 62 63
    name: feature_name;
    kind: feature_kind;
  }
bguillaum's avatar
bguillaum committed
64 65
  type feature = u_feature * Loc.t

66 67
  val default_fs: ?loc:Loc.t -> string -> feature list

bguillaum's avatar
bguillaum committed
68 69
  type u_node = {
      node_id: Id.name;
70
      position: float option;
bguillaum's avatar
bguillaum committed
71 72 73 74
      fs: feature list;
    }
  type node = u_node * Loc.t

75 76
  val grewpy_compare: node -> node -> int

77 78
  type edge_label = string (* p_obj.agt:suj *)

79 80 81 82
  type edge_label_cst =
    | Pos_list of edge_label list (*  X|Y|Z    *)
    | Neg_list of edge_label list (*  ^X|Y|Z   *)
    | Regexp of string            (*  re"a.*"  *)
bguillaum's avatar
bguillaum committed
83

bguillaum's avatar
bguillaum committed
84 85 86
  type u_edge = {
      edge_id: Id.name option;
      src: Id.name;
bguillaum's avatar
bguillaum committed
87
      edge_label_cst: edge_label_cst;
bguillaum's avatar
bguillaum committed
88 89 90 91
      tar: Id.name;
    }
  type edge = u_edge * Loc.t

bguillaum's avatar
bguillaum committed
92 93 94
  type ineq = Lt | Gt | Le | Ge
  val string_of_ineq: ineq -> string

95
  type u_const =
96 97
    | Cst_out of Id.name * edge_label_cst
    | Cst_in of Id.name * edge_label_cst
98 99 100
    | Features_eq of feature_ident * feature_ident
    | Features_diseq of feature_ident * feature_ident
    | Features_ineq of ineq * feature_ident * feature_ident
101
    | Feature_ineq_cst of ineq * feature_ident * float
102
    | Feature_eq_float of feature_ident * float
bguillaum's avatar
bguillaum committed
103 104
    | Feature_diff_float of feature_ident * float

105 106
    | Feature_eq_regexp of feature_ident * string
    | Feature_eq_cst of feature_ident * string
bguillaum's avatar
bguillaum committed
107 108
    | Feature_diff_cst of feature_ident * string

109 110
    | Immediate_prec of Id.name * Id.name
    | Large_prec of Id.name * Id.name
bguillaum's avatar
bguillaum committed
111 112
  type const = u_const * Loc.t

bguillaum's avatar
bguillaum committed
113
  type basic = {
bguillaum's avatar
bguillaum committed
114 115 116 117 118
      pat_nodes: node list;
      pat_edges: edge list;
      pat_const: const list;
    }

119 120 121 122 123
  type pattern = {
      pat_pos: basic;
      pat_negs: basic list;
    }

124 125 126 127
  (* [check for duplicate edge identifier in pos part and
     remove edge identifier in neg part] *)
  val normalize_pattern : pattern -> pattern

128 129
  val complete_pattern : pattern -> pattern

bguillaum's avatar
bguillaum committed
130
  type concat_item =
131
    | Qfn_item of feature_ident
bguillaum's avatar
bguillaum committed
132
    | String_item of string
133
    | Param_item of string
134

135
  type u_command =
bguillaum's avatar
bguillaum committed
136
    | Del_edge_expl of (Id.name * Id.name * edge_label)
bguillaum's avatar
bguillaum committed
137
    | Del_edge_name of string
bguillaum's avatar
bguillaum committed
138
    | Add_edge of (Id.name * Id.name * edge_label)
139 140

    (* 4 args: source, target, labels, flag true iff negative cst *)
bguillaum's avatar
bguillaum committed
141 142 143
    | Shift_in of (Id.name * Id.name * edge_label_cst)
    | Shift_out of (Id.name * Id.name * edge_label_cst)
    | Shift_edge of (Id.name * Id.name * edge_label_cst)
144

bguillaum's avatar
bguillaum committed
145 146
    | Merge_node of (Id.name * Id.name)
    | New_neighbour of (Id.name * Id.name * edge_label)
bguillaum's avatar
bguillaum committed
147 148 149 150 151

    | New_node of Id.name
    | New_before of (Id.name * Id.name)
    | New_after of (Id.name * Id.name)

bguillaum's avatar
bguillaum committed
152
    | Del_node of Id.name
153

bguillaum's avatar
bguillaum committed
154 155
    | Del_feat of feature_ident
    | Update_feat of feature_ident * concat_item list
bguillaum's avatar
bguillaum committed
156
  val string_of_u_command:  u_command -> string
bguillaum's avatar
bguillaum committed
157
  type command = u_command * Loc.t
bguillaum's avatar
bguillaum committed
158

bguillaum's avatar
bguillaum committed
159 160 161 162


  val replace_new_neighbour: command list -> command list

bguillaum's avatar
bguillaum committed
163 164
  type rule = {
      rule_id:Id.name;
165
      pattern: pattern;
bguillaum's avatar
bguillaum committed
166
      commands: command list;
167
      param: (string list * string list) option; (* (files, vars) *)
bguillaum's avatar
bguillaum committed
168
      lex_par: string list option; (* lexical parameters in the file *)
bguillaum's avatar
bguillaum committed
169
      rule_doc:string list;
bguillaum's avatar
bguillaum committed
170 171
      rule_loc: Loc.t;
    }
172

bguillaum's avatar
bguillaum committed
173 174
  type modul = {
      module_id:Id.name;
175
      local_labels: (string * string list) list;
bguillaum's avatar
bguillaum committed
176
      rules: rule list;
177
      deterministic: bool;
bguillaum's avatar
bguillaum committed
178
      module_doc:string list;
bguillaum's avatar
bguillaum committed
179
      mod_loc:Loc.t;
180
      mod_dir: string; (* the directory where the module is defined (for lp file localisation) *)
bguillaum's avatar
bguillaum committed
181
    }
182 183

  type module_or_include =
bguillaum's avatar
bguillaum committed
184
    | Modul of modul
185
    | Includ of (string * Loc.t)
bguillaum's avatar
bguillaum committed
186

187 188 189 190 191 192 193
  type feature_spec =
    | Closed of feature_name * feature_atom list (* cat:V,N *)
    | Open of feature_name (* phon, lemma, ... *)
    | Num of feature_name (* position *)

  val build_closed: feature_name -> feature_atom list -> feature_spec

194
  type domain = {
195
      feature_domain: feature_spec list;
196 197 198
      label_domain: (string * string list) list;
    }

199 200
  type domain_wi = Dom of domain | Dom_file of string

201 202 203 204 205
  type strat_def = (* /!\ The list must not be empty in the Seq or Plus constructor *)
    | Ref of string            (* reference to a module name or to another strategy *)
    | Seq of strat_def list    (* a sequence of strategies to apply one after the other *)
    | Plus of strat_def list   (* a set of strategies to apply in parallel *)
    | Star of strat_def        (* a strategy to apply iteratively *)
206 207 208
    | Bang of strat_def        (* a strategy to apply iteratively and deterministically *)
    | Pick of strat_def        (* pick one normal form a the given strategy; return 0 if nf *)
    | Try of strat_def         (* pick one normal form a the given strategy; return input if nf *)
209 210 211 212 213 214 215 216 217 218 219 220 221 222
    | Sequence of string list  (* compatibility mode with old code *)

  val strat_def_to_string: strat_def -> string

  val strat_def_flatten: strat_def -> strat_def

  (* a strategy is given by its descrition in the grs file and the 4 fields: *)
  type strategy = {
    strat_name:string;       (* a unique name of the stratgy *)
    strat_def:strat_def;     (* the definition itself *)
    strat_doc:string list;   (* lines of docs (if any in the GRS file) *)
    strat_loc:Loc.t;         (* the location of the [name] of the strategy *)
  }

223
  type grs_wi = {
bguillaum's avatar
bguillaum committed
224
      domain_wi: domain_wi option;
225
      modules_wi: module_or_include list;
226
      strategies_wi: strategy list;
bguillaum's avatar
bguillaum committed
227 228
    }

229
  (* a GRS: graph rewriting system *)
bguillaum's avatar
bguillaum committed
230
  type grs = {
bguillaum's avatar
bguillaum committed
231
      domain: domain option;
bguillaum's avatar
bguillaum committed
232
      modules: modul list;
233
      strategies: strategy list;
bguillaum's avatar
bguillaum committed
234
    }
235
  val empty_grs: grs
bguillaum's avatar
bguillaum committed
236 237

  type gr = {
238
    meta: string list;
239 240 241
    nodes: node list;
    edges: edge list;
  }
242 243
  val complete_graph: gr -> gr

244 245 246 247 248 249
  (* phrase structure tree *)
  type pst =
  | Leaf of (Loc.t * string) (* phon *)
  | T of (Loc.t * string * pst list)
  val word_list: pst -> string list
end (* module Ast *)