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
|
-------------------------------------------------------------------------------
-- (C) Altran Praxis Limited
-------------------------------------------------------------------------------
--
-- The SPARK toolset is free software; you can redistribute it and/or modify it
-- under terms of the GNU General Public License as published by the Free
-- Software Foundation; either version 3, or (at your option) any later
-- version. The SPARK toolset is distributed in the hope that it will be
-- useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General
-- Public License for more details. You should have received a copy of the GNU
-- General Public License distributed with the SPARK toolset; see file
-- COPYING3. If not, go to http://www.gnu.org/licenses for a complete copy of
-- the license.
--
--=============================================================================
--------------------------------------------------------------------------------
--Synopsis: --
-- --
--Platform dependent package supplying low level filing utilities. FindFiles --
--is separate to prevent cyclic interpackage dependencies --
-- --
--------------------------------------------------------------------------------
with E_Strings;
--# inherit E_Strings,
--# SPARK_IO;
package OSFiling
--# own File_Structure;
--# initializes File_Structure;
is
-- Return the filename from the string given, without drive or directory
-- designation.
-- Not guaranteed to work correctly if soft links are in the path.
function Base_Filename (Path : E_Strings.T) return E_Strings.T;
-- Return the directory from the string given, without drive or full path
-- designation. If a string such as "." or ".." is given then the actual
-- directory name is returned.
-- Not guaranteed to work correctly if soft links are in the path.
function Base_Dir_Name (Path : E_Strings.T) return E_Strings.T;
function Default_Report_Extn return E_Strings.T;
-- this function combines the inputs to produce the path to the
-- subdirectory
function Down_Directory (Path : E_Strings.T;
Sub_Directory : E_Strings.T) return E_Strings.T;
-- this function combines the inputs to produce a full file name
function Full_Filename (Path : E_Strings.T;
Filename : E_Strings.T) return E_Strings.T;
function Get_Working_Directory return E_Strings.T;
--# global in File_Structure;
-- true iff the specified name is a directory
function Is_Directory (Name : E_Strings.T) return Boolean;
--# global in File_Structure;
-- true iff the specified name exists and is not a directory
function Is_File (Name : E_Strings.T) return Boolean;
--# global in File_Structure;
-- return which name comes first in dictionary order
-- with the quirk that on the VAX, the file [spark]pogs
-- immediately preceeds the directory [spark.pogs]
function Order (First_Name, Second_Name : E_Strings.T) return E_Strings.Order_Types;
-- remove the file extension: on the VAX this includes removing the
-- file version number, but the reverse scan for a '.' must not go
-- past the ']' because there are '.'s in dir specifications
procedure Remove_File_Extension (Filename : in out E_Strings.T);
--# derives Filename from *;
-- NOTE: Please update Is_Relevant_File if you add/remove/change
-- any of the functions of the form *_File_Extension.
-- return the file extension for a simplified VC file
function Simplified_VC_File_Extension return E_Strings.T;
-- return the file extension for a victor results file
function Victored_VC_File_Extension return E_Strings.T;
-- return the file extension for a victor log file
function Victor_Log_File_Extension return E_Strings.T;
-- return the file extension for a Riposte summary file
function Riposte_Summary_File_Extension return E_Strings.T;
-- this function removes the last directory name from the supplied string
function Dir_Name (Path : E_Strings.T) return E_Strings.T;
-- return the file extension for a VC file
function VC_File_Extension return E_Strings.T;
-- return the file extension for a Proof Log file
function Proof_Log_File_Extension return E_Strings.T;
-- return the file extension for a Review file
function Review_File_Extension return E_Strings.T;
-- return the file extension for a Simplifier Log file
function Simplifier_Log_File_Extension return E_Strings.T;
-- return the file extension for DPC file
function DPC_File_Extension return E_Strings.T;
function Summary_DP_File_Extension return E_Strings.T;
-- return the platform specific directory separator
function Directory_Separator return Character;
-- based on the extension of the file, decide if it is relevant to
-- us. when adding / removing *_File_Extension functions, please
-- also update this function.
function Is_Relevant_File (Name : in E_Strings.T) return Boolean;
end OSFiling;
|
