1 ------------------------------------------------------------------------------
3 -- GNAT COMPILER COMPONENTS --
5 -- G N A T . D I R E C T O R Y _ O P E R A T I O N S . I T E R A T I O N --
9 -- Copyright (C) 2001-2005, AdaCore --
11 -- GNAT is free software; you can redistribute it and/or modify it under --
12 -- terms of the GNU General Public License as published by the Free Soft- --
13 -- ware Foundation; either version 2, or (at your option) any later ver- --
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
16 -- or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License --
17 -- for more details. You should have received a copy of the GNU General --
18 -- Public License distributed with GNAT; see file COPYING. If not, write --
19 -- to the Free Software Foundation, 51 Franklin Street, Fifth Floor, --
20 -- Boston, MA 02110-1301, USA. --
22 -- As a special exception, if other files instantiate generics from this --
23 -- unit, or you link this unit with other files to produce an executable, --
24 -- this unit does not by itself cause the resulting executable to be --
25 -- covered by the GNU General Public License. This exception does not --
26 -- however invalidate any other reasons why the executable file might be --
27 -- covered by the GNU Public License. --
29 -- GNAT was originally developed by the GNAT team at New York University. --
30 -- Extensive contributions were provided by Ada Core Technologies Inc. --
32 ------------------------------------------------------------------------------
34 -- Iterators among files
36 package GNAT
.Directory_Operations
.Iteration
is
42 Quit
: in out Boolean);
44 (Root_Directory
: Dir_Name_Str
;
45 File_Pattern
: String);
46 -- Recursively searches the directory structure rooted at Root_Directory.
47 -- This provides functionality similar to the UNIX 'find' command.
48 -- Action will be called for every item matching the regular expression
49 -- File_Pattern (see GNAT.Regexp). Item is the full pathname to the file
50 -- starting with Root_Directory that has been matched. Index is set to one
51 -- for the first call and is incremented by one at each call. The iterator
52 -- will pass in the value False on each call to Action. The iterator will
53 -- terminate after passing the last matched path to Action or after
54 -- returning from a call to Action which sets Quit to True.
55 -- Raises GNAT.Regexp.Error_In_Regexp if File_Pattern is ill formed.
61 Quit
: in out Boolean);
62 procedure Wildcard_Iterator
(Path
: Path_Name
);
63 -- Calls Action for each path matching Path. Path can include wildcards '*'
64 -- and '?' and [...]. The rules are:
66 -- * can be replaced by any sequence of characters
67 -- ? can be replaced by a single character
68 -- [a-z] match one character in the range 'a' through 'z'
69 -- [abc] match either character 'a', 'b' or 'c'
71 -- Item is the filename that has been matched. Index is set to one for the
72 -- first call and is incremented by one at each call. The iterator's
73 -- termination can be controlled by setting Quit to True. It is by default
76 -- For example, if we have the following directory structure:
89 -- A call with expression "/s*/file/*" will call Action for the following
94 end GNAT
.Directory_Operations
.Iteration
;