1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223 | -- -*- coding: utf-8 -*-
--
-- ZanyBlue, an Ada library and framework for finite element analysis.
--
-- Copyright (c) 2017, Michael Rohan <mrohan@zanyblue.com>
-- All rights reserved.
--
-- Redistribution and use in source and binary forms, with or without
-- modification, are permitted provided that the following conditions
-- are met:
--
-- * Redistributions of source code must retain the above copyright
-- notice, this list of conditions and the following disclaimer.
--
-- * Redistributions in binary form must reproduce the above copyright
-- notice, this list of conditions and the following disclaimer in the
-- documentation and/or other materials provided with the distribution.
--
-- * Neither the name of ZanyBlue nor the names of its contributors may
-- be used to endorse or promote products derived from this software
-- without specific prior written permission.
--
-- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-- HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
-- TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-- PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-- LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-- NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-- SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
--
--
-- This is a simple wrapper package around the standard Ada.Directories
-- package with String arguments and functions. The underlying
-- Strings from Ada.Directories are simply interpreted as UTF-8 encoded
-- strings and are decoded to UXStrings.
--
with Ada.Calendar;
with Ada.Directories;
with Ada.IO_Exceptions;
package ZanyBlue.Directories is
function Current_Directory return String;
-- Returns the full directory name for the current default directory.
procedure Set_Directory (Directory : String);
-- Sets the current default directory.
procedure Create_Directory
(New_Directory : String;
Form : String := "");
-- Creates a directory with name New_Directory.
procedure Delete_Directory (Directory : String);
-- Deletes an existing empty directory with name Directory.
procedure Create_Path
(New_Directory : String;
Form : String := "");
-- Creates zero or more directories with name New_Directory.
procedure Delete_Tree (Directory : String);
-- Deletes an existing directory with name Directory.
procedure Delete_File (Name : String);
-- Deletes an existing ordinary or special file with Name.
procedure Rename (Old_Name, New_Name : String);
-- Renames an existing external file with Old_Name to New_Name.
procedure Copy_File
(Source_Name : String;
Target_Name : String;
Form : String := "");
-- Copies the contents of the existing external file with Source_Name
-- to Target_Name.
function Full_Name
(Name : String)
return String;
-- Returns the full name corresponding to the file name specified by Name.
function Simple_Name
(Name : String)
return String;
-- Returns the simple name portion of the file name specified by Name.
function Containing_Directory
(Name : String)
return String;
-- Returns the name of the containing directory of the external file
-- (including directories) identified by Name.
function Extension
(Name : String)
return String;
-- Returns the extension name corresponding to Name.
function Base_Name
(Name : String)
return String;
-- Returns the base name corresponding to Name.
function Compose
(Containing_Directory : String := "";
Name : String;
Extension : String := "")
return String;
-- Returns the name of the external file with the specified
-- Containing_Directory, Name, and Extension.
subtype File_Kind is Ada.Directories.File_Kind;
-- The type File_Kind represents the kind of file represented by an
-- external file or directory.
subtype File_Size is Ada.Directories.File_Size;
-- The type File_Size represents the size of an external file
function Exists
(Name : String)
return Boolean;
-- Returns True if external file represented by Name exists, and False
-- otherwise.
function Kind
(Name : String)
return File_Kind;
-- Returns the kind of external file represented by Name.
function Size
(Name : String)
return File_Size;
-- Returns the size of the external file represented by Name.
function Modification_Time
(Name : String)
return Ada.Calendar.Time;
-- Returns the time that the external file represented by Name was most
-- recently modified.
subtype Directory_Entry_Type is Ada.Directories.Directory_Entry_Type;
-- The type Directory_Entry_Type represents a single item in a directory.
subtype Filter_Type is Ada.Directories.Filter_Type;
-- The type Filter_Type specifies which directory entries are provided from
-- a search operation.
subtype Search_Type is Ada.Directories.Search_Type;
-- The type Search_Type contains the state of a directory search.
procedure Start_Search
(Search : in out Search_Type;
Directory : String;
Pattern : String;
Filter : Filter_Type := (others => True));
-- Starts a search in the directory entry in the directory named by
-- Directory for entries matching Pattern. Pattern represents a file name
-- matching pattern.
procedure End_Search (Search : in out Search_Type);
-- Ends the search represented by Search.
function More_Entries
(Search : Search_Type)
return Boolean;
-- Returns True if more entries are available to be returned by a call
-- to Get_Next_Entry for the specified search object, and False otherwise.
procedure Get_Next_Entry
(Search : in out Search_Type;
Directory_Entry : out Directory_Entry_Type);
-- Returns the next Directory_Entry for the search described by Search that
-- matches the pattern and filter.
procedure Search
(Directory : String;
Pattern : String;
Filter : Filter_Type := (others => True);
Process : not null access procedure
(Directory_Entry : Directory_Entry_Type));
-- Searches in the directory named by Directory for entries matching
-- Pattern.
function Simple_Name
(Directory_Entry : Directory_Entry_Type)
return String;
-- Returns the simple external name of the external file (including
-- directories) represented by Directory_Entry.
function Full_Name
(Directory_Entry : Directory_Entry_Type)
return String;
-- Returns the full external name of the external file (including
-- directories) represented by Directory_Entry.
function Kind
(Directory_Entry : Directory_Entry_Type)
return File_Kind;
-- Returns the kind of external file represented by Directory_Entry.
function Size
(Directory_Entry : Directory_Entry_Type)
return File_Size;
-- Returns the size of the external file represented by Directory_Entry.
function Modification_Time
(Directory_Entry : Directory_Entry_Type)
return Ada.Calendar.Time;
-- Returns the time that the external file represented by Directory_Entry
-- was most recently modified.
Status_Error : exception renames Ada.IO_Exceptions.Status_Error;
Name_Error : exception renames Ada.IO_Exceptions.Name_Error;
Use_Error : exception renames Ada.IO_Exceptions.Use_Error;
Device_Error : exception renames Ada.IO_Exceptions.Device_Error;
end ZanyBlue.Directories;
|