File : get_scos.ads
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT COMPILER COMPONENTS --
4 -- --
5 -- G E T _ S C O S --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 2009-2011, Free Software Foundation, Inc. --
10 -- --
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 3, 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 COPYING3. If not, go to --
19 -- http://www.gnu.org/licenses for a complete copy of the license. --
20 -- --
21 -- GNAT was originally developed by the GNAT team at New York University. --
22 -- Extensive contributions were provided by Ada Core Technologies Inc. --
23 -- --
24 ------------------------------------------------------------------------------
25
26 -- This package contains the function used to read SCO information from an ALI
27 -- file and populate the tables defined in package SCOs with the result.
28
29 generic
30 -- These subprograms provide access to the ALI file. Locating, opening and
31 -- providing access to the ALI file is the callers' responsibility.
32
33 with function Getc return Character is <>;
34 -- Get next character, positioning the ALI file ready to read the following
35 -- character (equivalent to calling Nextc, then Skipc). If the end of file
36 -- is encountered, the value Types.EOF is returned.
37
38 with function Nextc return Character is <>;
39 -- Look at the next character, and return it, leaving the position of the
40 -- file unchanged, so that a subsequent call to Getc or Nextc will return
41 -- this same character. If the file is positioned at the end of file, then
42 -- Types.EOF is returned.
43
44 with procedure Skipc is <>;
45 -- Skip past the current character (which typically was read with Nextc),
46 -- and position to the next character, which will be returned by the next
47 -- call to Getc or Nextc.
48
49 procedure Get_SCOs;
50 -- Load SCO information from ALI file text format into internal SCO tables
51 -- (SCOs.SCO_Table and SCOs.SCO_Unit_Table). On entry the input file is
52 -- positioned to the initial 'C' of the first SCO line in the ALI file.
53 -- On return, the file is positioned either to the end of file, or to the
54 -- first character of the line following the SCO information (which will
55 -- never start with a 'C').
56 --
57 -- If a format error is detected in the input, then an exception is raised
58 -- (Ada.IO_Exceptions.Data_Error), with the file positioned to the error.