matita/matitamakeLib.mli

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 type development
  27
  28 (* initialize_development [name] [dir]
  29  * ask matitamake to recorder [dir] as the root for thedevelopment [name] *)
  30 val initialize_development: string -> string -> development option
  31 (* make target [default all] *)
  32 val build_development: ?matita_flags:string -> ?target:string -> development -> bool
  33 (* make target [default all], the refresh cb is called after every output *)
  34 val build_development_in_bg:
  35   ?matita_flags:string -> ?target:string -> (unit -> unit) -> development -> bool
  36 (* make clean *)
  37 val clean_development: ?matita_flags:string -> development -> bool
  38 val clean_development_in_bg: ?matita_flags:string -> (unit -> unit) -> development -> bool
  39
  40 val publish_development_in_bg: (unit -> unit) -> development -> bool
  41 val publish_development: development -> bool
  42
  43 (* return the development that handles dir *)
  44 val development_for_dir: string -> development option
  45 (* return the development *)
  46 val development_for_name: string -> development option
  47 (* return the known list of name, development_root *)
  48 val list_known_developments: unit -> (string * string ) list
  49 (* cleans the development, forgetting about it *)
  50 val destroy_development: ?matita_flags:string -> development -> unit
  51 val destroy_development_in_bg: ?matita_flags:string -> (unit -> unit) -> development -> unit
  52 (* initiale internal data structures *)
  53 val initialize : unit -> unit
  54 (* gives back the root *)
  55 val root_for_development : development -> string
  56 (* gives back the name *)
  57 val name_for_development : development -> string
  58
  59 (** @return dot file for a given development, if it exists *)
  60 val dot_for_development : development -> string option
  61
  62 val normalize_path: string -> string