components/metadata/metadataExtractor.mli

   1 (* Copyright (C) 2004, 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 val compute:
  27   body:Cic.term option ->
  28   ty:Cic.term ->
  29     MetadataTypes.metadata list
  30
  31     (** @return tuples <uri, shortname, metadata> *)
  32 val compute_obj:
  33   UriManager.uri ->
  34     (UriManager.uri * string * MetadataTypes.metadata list) list
  35
  36 module IntSet: Set.S with type elt = int
  37
  38   (** given a term, returns a pair of sets corresponding respectively to the set
  39     * of meta numbers occurring in term's conclusion and the set of meta numbers
  40     * occurring in term's hypotheses *)
  41 val compute_metas: Cic.term -> IntSet.t * IntSet.t
  42