grew_rule.mli 5.22 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                                                   *)
(**********************************************************************************)

11
open Grew_base
12
open Grew_types
13
open Grew_domain
bguillaum's avatar
bguillaum committed
14 15
open Grew_graph
open Grew_command
pj2m's avatar
pj2m committed
16 17
open Grew_edge
open Grew_fs
bguillaum's avatar
bguillaum committed
18
open Grew_ast
pj2m's avatar
pj2m committed
19

20
(* ================================================================================ *)
pj2m's avatar
pj2m committed
21 22
module Instance : sig
  type t = {
23 24 25
    graph: G_graph.t;
    history: Command.h list;
    rules: string list;
26
    big_step: Libgrew_types.big_step option;
27 28
  }

Bruno Guillaume's avatar
Bruno Guillaume committed
29 30
  val swap: t -> t

31 32
  (** [from_graph graph] return a fresh instance based on the input [graph]. *)
  val from_graph: G_graph.t -> t
bguillaum's avatar
bguillaum committed
33

34 35
  (** [rev_steps t] reverses the small step list: during rewriting, the last rule
      is in the head of the list and the reverse is needed for display. *)
pj2m's avatar
pj2m committed
36 37
  val rev_steps: t -> t

38 39 40 41
  (** [refresh t] returns a fresh representation of the graph.
      Graphs are refreshed after each module. *)
  val refresh: t -> t

42
  (** [to_gr t] returns a string which contains the "gr" code of the current graph *)
43
  val to_gr: t -> string
44

45
  (** [to_conll_string t] returns a string which contains the "conll" code of the current graph *)
46
  val to_conll_string: t -> string
bguillaum's avatar
bguillaum committed
47

48
  (** [save_dot_png base t] writes a file "base.png" with the dot representation of [t] *)
49
  val save_dot_png: ?filter: (string -> bool) -> ?main_feat: string -> string -> t -> unit
50
end (* module Instance *)
pj2m's avatar
pj2m committed
51

52
(* ================================================================================ *)
pj2m's avatar
pj2m committed
53 54
module Instance_set : Set.S with type elt = Instance.t

55
(* ================================================================================ *)
pj2m's avatar
pj2m committed
56 57 58
module Rule : sig
  type t

59 60 61 62 63 64
  (** [set_max_depth_det value] set the maximum rewriting depth in deterministic application of a module. *)
  val set_max_depth_det: int -> unit

  (** [set_max_depth_non_det value] set the maximum rewriting depth in non-deterministic application of a module. *)
  val set_max_depth_non_det: int -> unit

bguillaum's avatar
bguillaum committed
65 66 67 68
  (** [set_debug_loop ()] turns the debug mode on for loop: when the bound is reached, the graph is considered as a normal form.
      This is a kind of hack to be able to explore loops in GUI. *)
  val set_debug_loop: unit -> unit

69
  (** [get_name t] returns the name of the rule [t]. *)
bguillaum's avatar
bguillaum committed
70 71
  val get_name: t -> string

bguillaum's avatar
bguillaum committed
72
  (** [get_loc t] returns the file location of the rule [t]. *)
73 74
  val get_loc: t -> Loc.t

75 76
  val to_json: ?domain:Domain.t -> t -> Yojson.Basic.json

bguillaum's avatar
bguillaum committed
77
  (** [to_dep t] returns a string in the [dep] language describing the match basic of the rule *)
bguillaum's avatar
bguillaum committed
78
  val to_dep: ?domain:Domain.t -> t -> string
bguillaum's avatar
bguillaum committed
79

80
  (** [build domain ?local dir ast_rule] returns the Rule.t value corresponding to [ast_rule].
81
      [dir] is used for localisation of lp files *)
Bruno Guillaume's avatar
Bruno Guillaume committed
82
  val build: ?domain:Domain.t -> string -> Ast.rule -> t
pj2m's avatar
pj2m committed
83

Bruno Guillaume's avatar
Bruno Guillaume committed
84
  (** [normalize domain module_name ?deterministic rule_list instance] returns a set of normal forms *)
pj2m's avatar
pj2m committed
85
  (* raise Stop if some command fails to apply *)
86
  val normalize:
bguillaum's avatar
bguillaum committed
87
    ?domain:Domain.t ->
88
    string -> (* module name *)
89
    ?deterministic:bool ->
90
    t list -> (* rule list *)
pj2m's avatar
pj2m committed
91
    Instance.t ->
Bruno Guillaume's avatar
Bruno Guillaume committed
92
      Instance_set.t
bguillaum's avatar
bguillaum committed
93

Bruno Guillaume's avatar
Bruno Guillaume committed
94 95
  val one_step: ?domain: Domain.t -> Instance.t -> t list -> Instance_set.t
  val conf_one_step: ?domain: Domain.t -> Instance.t -> t list -> Instance.t option
bguillaum's avatar
bguillaum committed
96

bguillaum's avatar
bguillaum committed
97 98
  (** the type matching encodes the graph morphism from a pattern to a graph *)
  (* NB: it was made public for the grep mode *)
bguillaum's avatar
bguillaum committed
99
  type matching
100 101
  type pattern

102
  val pid_name_list: pattern -> Id.name list
103 104 105

  val to_python: pattern -> G_graph.t -> matching -> string

bguillaum's avatar
bguillaum committed
106
  val build_pattern: ?domain:Domain.t -> Ast.pattern -> pattern
bguillaum's avatar
bguillaum committed
107

108
  (** [node_matching pattern graph matching] return a assoc list (pid_name, gid.position) *)
109
  val node_matching: pattern -> G_graph.t -> matching -> (string * float) list
110

bguillaum's avatar
bguillaum committed
111
  (** [match_in_graph rule graph] returns the list of matching of the pattern of the rule into the graph *)
bguillaum's avatar
bguillaum committed
112
  val match_in_graph: ?domain:Domain.t -> ?param:Lex_par.t -> pattern -> G_graph.t -> matching list
bguillaum's avatar
bguillaum committed
113

114
  (** [match_deco rule matching] builds the decoration of the [graph] illustrating the given [matching] of the [rule] *)
bguillaum's avatar
bguillaum committed
115
  (* NB: it can be computed independly from the graph itself! *)
116
  val match_deco: pattern -> matching -> G_deco.t
Bruno Guillaume's avatar
Bruno Guillaume committed
117 118 119 120 121 122 123 124




  val apply: ?domain: Domain.t -> t -> Instance.t -> Instance_set.t
  val det_apply: ?domain: Domain.t -> t -> Instance.t -> Instance.t option


125 126 127
  val wrd_apply: ?domain: Domain.t -> t -> (G_graph.t * Libgrew_types.big_step option) -> (G_graph.t * Libgrew_types.big_step) option


Bruno Guillaume's avatar
Bruno Guillaume committed
128

129 130 131 132 133
  val onf_apply: ?domain: Domain.t -> t -> G_graph.t -> G_graph.t option
  val gwh_apply: ?domain: Domain.t -> t -> Graph_with_history.t -> Graph_with_history_set.t



Bruno Guillaume's avatar
Bruno Guillaume committed
134

135
end (* module Rule *)