helm/software/components/grafite_parser/grafiteWalker.mli

   1 (* Copyright (C) 2006, 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 statement_test =
  27   GrafiteParser.ast_statement GrafiteParser.localized_option -> bool
  28
  29   (** @param status initial status, defaults to LexiconEngine.initial_status
  30    * @param callback if given it will be invoked as soon as a matching
  31    * statement is found (i.e. it provides incremental notification in case
  32    * grepping takes a while) *)
  33 val grep_statement:
  34   ?status: LexiconEngine.status ->
  35   ?callback: (string -> unit) ->
  36   fname:string ->
  37   include_paths: string list ->
  38   statement_test ->
  39     string list
  40
  41   (** As above, but act on all file (recursively) located under directory
  42    * dirname whose name matches fname_test. Default test matches files with
  43    * extension ".ma".
  44    * @return list of pairs <fname, raw statement>, as "grep -H" would do *)
  45 val rgrep_statement:
  46   ?status: LexiconEngine.status ->
  47   ?callback: (string * string -> unit) ->
  48   ?fname_test:(string -> bool) -> dirname:string ->
  49   include_paths: string list ->
  50   statement_test ->
  51     (string * string) list
  52