annotate gcc/ada/libgnat/g-diopit.ads @ 131:84e7813d76e9

gcc-8.2
author mir3636
date Thu, 25 Oct 2018 07:37:49 +0900
parents 04ced10e8804
children 1830386684a0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
111
kono
parents:
diff changeset
1 ------------------------------------------------------------------------------
kono
parents:
diff changeset
2 -- --
kono
parents:
diff changeset
3 -- GNAT COMPILER COMPONENTS --
kono
parents:
diff changeset
4 -- --
kono
parents:
diff changeset
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 --
kono
parents:
diff changeset
6 -- --
kono
parents:
diff changeset
7 -- S p e c --
kono
parents:
diff changeset
8 -- --
131
84e7813d76e9 gcc-8.2
mir3636
parents: 111
diff changeset
9 -- Copyright (C) 2001-2018, AdaCore --
111
kono
parents:
diff changeset
10 -- --
kono
parents:
diff changeset
11 -- GNAT is free software; you can redistribute it and/or modify it under --
kono
parents:
diff changeset
12 -- terms of the GNU General Public License as published by the Free Soft- --
kono
parents:
diff changeset
13 -- ware Foundation; either version 3, or (at your option) any later ver- --
kono
parents:
diff changeset
14 -- sion. GNAT is distributed in the hope that it will be useful, but WITH- --
kono
parents:
diff changeset
15 -- OUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY --
kono
parents:
diff changeset
16 -- or FITNESS FOR A PARTICULAR PURPOSE. --
kono
parents:
diff changeset
17 -- --
kono
parents:
diff changeset
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
kono
parents:
diff changeset
19 -- additional permissions described in the GCC Runtime Library Exception, --
kono
parents:
diff changeset
20 -- version 3.1, as published by the Free Software Foundation. --
kono
parents:
diff changeset
21 -- --
kono
parents:
diff changeset
22 -- You should have received a copy of the GNU General Public License and --
kono
parents:
diff changeset
23 -- a copy of the GCC Runtime Library Exception along with this program; --
kono
parents:
diff changeset
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
kono
parents:
diff changeset
25 -- <http://www.gnu.org/licenses/>. --
kono
parents:
diff changeset
26 -- --
kono
parents:
diff changeset
27 -- GNAT was originally developed by the GNAT team at New York University. --
kono
parents:
diff changeset
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
kono
parents:
diff changeset
29 -- --
kono
parents:
diff changeset
30 ------------------------------------------------------------------------------
kono
parents:
diff changeset
31
kono
parents:
diff changeset
32 -- Iterators among files
kono
parents:
diff changeset
33
kono
parents:
diff changeset
34 package GNAT.Directory_Operations.Iteration is
kono
parents:
diff changeset
35
kono
parents:
diff changeset
36 generic
kono
parents:
diff changeset
37 with procedure Action
kono
parents:
diff changeset
38 (Item : String;
kono
parents:
diff changeset
39 Index : Positive;
kono
parents:
diff changeset
40 Quit : in out Boolean);
kono
parents:
diff changeset
41 procedure Find
kono
parents:
diff changeset
42 (Root_Directory : Dir_Name_Str;
kono
parents:
diff changeset
43 File_Pattern : String);
kono
parents:
diff changeset
44 -- Recursively searches the directory structure rooted at Root_Directory.
kono
parents:
diff changeset
45 -- This provides functionality similar to the UNIX 'find' command.
kono
parents:
diff changeset
46 -- Action will be called for every item matching the regular expression
kono
parents:
diff changeset
47 -- File_Pattern (see GNAT.Regexp). Item is the full pathname to the file
kono
parents:
diff changeset
48 -- starting with Root_Directory that has been matched. Index is set to one
kono
parents:
diff changeset
49 -- for the first call and is incremented by one at each call. The iterator
kono
parents:
diff changeset
50 -- will pass in the value False on each call to Action. The iterator will
kono
parents:
diff changeset
51 -- terminate after passing the last matched path to Action or after
kono
parents:
diff changeset
52 -- returning from a call to Action which sets Quit to True.
kono
parents:
diff changeset
53 -- Raises GNAT.Regexp.Error_In_Regexp if File_Pattern is ill formed.
kono
parents:
diff changeset
54
kono
parents:
diff changeset
55 generic
kono
parents:
diff changeset
56 with procedure Action
kono
parents:
diff changeset
57 (Item : String;
kono
parents:
diff changeset
58 Index : Positive;
kono
parents:
diff changeset
59 Quit : in out Boolean);
kono
parents:
diff changeset
60 procedure Wildcard_Iterator (Path : Path_Name);
kono
parents:
diff changeset
61 -- Calls Action for each path matching Path. Path can include wildcards '*'
kono
parents:
diff changeset
62 -- and '?' and [...]. The rules are:
kono
parents:
diff changeset
63 --
kono
parents:
diff changeset
64 -- * can be replaced by any sequence of characters
kono
parents:
diff changeset
65 -- ? can be replaced by a single character
kono
parents:
diff changeset
66 -- [a-z] match one character in the range 'a' through 'z'
kono
parents:
diff changeset
67 -- [abc] match either character 'a', 'b' or 'c'
kono
parents:
diff changeset
68 --
kono
parents:
diff changeset
69 -- Item is the filename that has been matched. Index is set to one for the
kono
parents:
diff changeset
70 -- first call and is incremented by one at each call. The iterator's
kono
parents:
diff changeset
71 -- termination can be controlled by setting Quit to True. It is by default
kono
parents:
diff changeset
72 -- set to False.
kono
parents:
diff changeset
73 --
kono
parents:
diff changeset
74 -- For example, if we have the following directory structure:
kono
parents:
diff changeset
75 -- /boo/
kono
parents:
diff changeset
76 -- foo.ads
kono
parents:
diff changeset
77 -- /sed/
kono
parents:
diff changeset
78 -- foo.ads
kono
parents:
diff changeset
79 -- file/
kono
parents:
diff changeset
80 -- foo.ads
kono
parents:
diff changeset
81 -- /sid/
kono
parents:
diff changeset
82 -- foo.ads
kono
parents:
diff changeset
83 -- file/
kono
parents:
diff changeset
84 -- foo.ads
kono
parents:
diff changeset
85 -- /life/
kono
parents:
diff changeset
86 --
kono
parents:
diff changeset
87 -- A call with expression "/s*/file/*" will call Action for the following
kono
parents:
diff changeset
88 -- items:
kono
parents:
diff changeset
89 -- /sed/file/foo.ads
kono
parents:
diff changeset
90 -- /sid/file/foo.ads
kono
parents:
diff changeset
91
kono
parents:
diff changeset
92 end GNAT.Directory_Operations.Iteration;