test branch

[helm.git] / helm / ocaml / mathql_generator / mQGUtil.mli

diff --git a/helm/ocaml/mathql_generator/mQGUtil.mli b/helm/ocaml/mathql_generator/mQGUtil.mli
new file mode 100644 (file)
index 0000000..065abb1
--- /dev/null
+++ b/helm/ocaml/mathql_generator/mQGUtil.mli
@@ -0,0 +1,69 @@
+(* Copyright (C) 2000, HELM Team.
+ * 
+ * This file is part of HELM, an Hypertextual, Electronic
+ * Library of Mathematics, developed at the Computer Science
+ * Department, University of Bologna, Italy.
+ * 
+ * HELM is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ * 
+ * HELM is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with HELM; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
+ * MA  02111-1307, USA.
+ * 
+ * For details, see the HELM World-Wide-Web page,
+ * http://cs.unibo.it/helm/.
+ *)
+
+(*  AUTOR: Ferruccio Guidi <fguidi@cs.unibo.it>
+ *)
+
+(* low level functions  *****************************************************)
+
+(* these functions give the string representation used in the db  ----------*)
+
+val string_of_position : MQGTypes.position -> string
+val string_of_depth    : MQGTypes.depth -> string
+val string_of_sort     : MQGTypes.sort -> string
+
+(* these functions give the string representation used in MathQL  ----------*)
+
+val mathql_of_position : MQGTypes.position -> string
+val mathql_of_depth    : MQGTypes.depth -> string
+val mathql_of_uri      : MQGTypes.uri -> string
+val mathql_of_sort     : MQGTypes.sort -> string
+
+val mathql_of_specs    : (string -> unit) -> MQGTypes.spec list -> unit
+
+val position_of_mathql : string -> MQGTypes.position
+val depth_of_mathql    : string -> MQGTypes.depth
+val uri_of_mathql      : string -> MQGTypes.uri
+val sort_of_mathql     : string -> MQGTypes.sort
+
+(* high level functions  ****************************************************)
+
+(* these functions give the textual representation used by umans  ----------*)
+
+val text_of_position : MQGTypes.full_position -> string
+val text_of_depth    : MQGTypes.full_position -> string -> string
+val text_of_sort     : MQGTypes.sort -> string
+
+(* these functions classify the positions  ---------------------------------*)
+
+val is_main_position : MQGTypes.full_position -> bool
+val is_conclusion    : MQGTypes.full_position -> bool
+
+(* these function apply changes to positions  ------------------------------*)
+
+val set_full_position : MQGTypes.full_position -> MQGTypes.optional_depth ->
+                        MQGTypes.full_position
+val set_main_position : MQGTypes.main_position -> MQGTypes.optional_depth ->
+                        MQGTypes.main_position