aboutsummaryrefslogtreecommitdiffstats
path: root/src/files_map.ads
diff options
context:
space:
mode:
authorTristan Gingold <tgingold@free.fr>2019-06-20 08:34:09 +0200
committerTristan Gingold <tgingold@free.fr>2019-06-20 08:34:09 +0200
commit45bec6292a41661320e209ac343362599df9feef (patch)
treebb35f65e21f3015b431f5444a2e42b949f7a3e73 /src/files_map.ads
parent76f0c844d07a3b0bdefed6aa066c2ab7fc2cf871 (diff)
downloadghdl-45bec6292a41661320e209ac343362599df9feef.tar.gz
ghdl-45bec6292a41661320e209ac343362599df9feef.tar.bz2
ghdl-45bec6292a41661320e209ac343362599df9feef.zip
files_map: add comments.
Diffstat (limited to 'src/files_map.ads')
-rw-r--r--src/files_map.ads7
1 files changed, 5 insertions, 2 deletions
diff --git a/src/files_map.ads b/src/files_map.ads
index e2b66fd7d..41e37751e 100644
--- a/src/files_map.ads
+++ b/src/files_map.ads
@@ -49,6 +49,7 @@ package Files_Map is
return Source_File_Entry;
-- Reserve an entry, but do not read any file.
+ -- The length should includes the two terminal EOT.
function Reserve_Source_File
(Directory : Name_Id; Name : Name_Id; Length : Source_Ptr)
return Source_File_Entry;
@@ -102,11 +103,13 @@ package Files_Map is
function Get_File_Buffer (File : Source_File_Entry) return File_Buffer_Ptr;
-- Set/Get the length of the file (which is less than the size of the
- -- file buffer). Set also append two EOT at the end of the file.
+ -- file buffer). The gap is not included in the length.
+ -- Set also append two EOT at the end of the file.
procedure Set_File_Length (File : Source_File_Entry; Length : Source_Ptr);
function Get_File_Length (File : Source_File_Entry) return Source_Ptr;
- -- Get the length of the buffer, which includes the gap.
+ -- Get the length of the buffer, which includes the gap, but not the
+ -- two terminal EOT.
function Get_Buffer_Length (File : Source_File_Entry) return Source_Ptr;
-- Return the name of the file.