From ef312564ca84a2b49fc291434d8fb2f8501bb618 Mon Sep 17 00:00:00 2001
From: Sébastien Dailly <sebastien@chimrod.com>
Date: Tue, 15 Nov 2016 13:00:01 +0100
Subject: Initial commit

---
 sheet.mli | 73 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 73 insertions(+)
 create mode 100755 sheet.mli

(limited to 'sheet.mli')

diff --git a/sheet.mli b/sheet.mli
new file mode 100755
index 0000000..59a1fa7
--- /dev/null
+++ b/sheet.mli
@@ -0,0 +1,73 @@
+(** This module represent a sheet *)
+
+type cell = int * int
+  
+module Raw: sig
+
+  exception Cycle
+  
+  type t
+  
+  (** Create a new sheet *)
+  val create: t
+  
+  (** Add a new value in the sheet. The previous value is replaced 
+    @return All the successors to update and the new sheet.
+  *)
+  val add: cell -> Expression.t -> t -> Cell.Set.t * t
+  
+  val remove: cell -> t -> Cell.Set.t * t
+  
+  val get_value: cell -> t -> ScTypes.result
+  
+  val get_expr: cell -> t -> Expression.t
+
+  val get_sink: cell -> t -> Cell.Set.t
+  
+  val fold: ('a -> cell -> (Expression.t * ScTypes.result ) -> 'a) -> 'a -> t -> 'a
+
+end
+
+type yank
+
+type t = {
+  selected: Selection.t;    (* The selected cell *)
+  data: Raw.t;
+  history: t list;          (* Unlimited history *)
+  yank: yank list           (* All the selected cells *)
+}
+
+type search = [
+  | `Pattern of ScTypes.result
+  | `Next
+  | `Previous
+]
+
+(** Undo the last action and return the previous state, if any *)
+val undo: t -> t option
+
+(** Move the cursor in one direction, return the state updated if the move is
+    allowed *) 
+val move: Actions.direction -> t -> t option
+
+(** Delete the content of selected cells.
+    @return The sheet and the number of cells deleted
+*)
+val delete: t -> t * int
+
+(** Copy the selected cells 
+    @return The sheet and the number of cells deleted
+*)
+val yank: t -> t * int
+
+(** Search for a pattern on the sheet 
+    @return The state updated if the pattern has been found. *)
+val search: search -> t -> t option
+
+val paste: t -> t * int
+
+val add: Expression.t -> t -> Cell.Set.t * t
+
+(** Create an empty sheet *)
+val create: Raw.t -> t
+
-- 
cgit v1.2.3