[REBME] First draft of the APIapi

1 files changed, 28 insertions, 0 deletions

diff --git a/src/TamasheqLib.mli b/src/TamasheqLib.mli
new file mode 100644
index 0000000..32f53c7
--- /dev/null
+++ b/src/TamasheqLib.mli
@@ -0,0 +1,28 @@
+(*
+Copyright (c) 2014, Grégoire Duchêne <gduchene@awhk.org>
+
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted, provided that the
+above copyright notice and this permission notice appear in all
+copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+*)
+
+type env
+and  finalize_fun = env -> result
+and  hook         = string * init_fun * finalize_fun
+and  init_fun     = term list -> result
+and  result       = [ `Abort of string option
+                    | `Continue
+                    | `Warn of string option ]
+and  term         = Lambda.lambda
+
+val register_hook : hook -> unit