Implement -mmemcpy-strategy= and -mmemset-strategy= options
[official-gcc.git] / gcc / ada / g-souinf.ads
blob54c106db9387f1e1238751757dadd02c8cddc915
1 ------------------------------------------------------------------------------
2 -- --
3 -- GNAT RUN-TIME COMPONENTS --
4 -- --
5 -- G N A T . S O U R C E _ I N F O --
6 -- --
7 -- S p e c --
8 -- --
9 -- Copyright (C) 2000-2005 AdaCore --
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. --
17 -- --
18 -- As a special exception under Section 7 of GPL version 3, you are granted --
19 -- additional permissions described in the GCC Runtime Library Exception, --
20 -- version 3.1, as published by the Free Software Foundation. --
21 -- --
22 -- You should have received a copy of the GNU General Public License and --
23 -- a copy of the GCC Runtime Library Exception along with this program; --
24 -- see the files COPYING3 and COPYING.RUNTIME respectively. If not, see --
25 -- <http://www.gnu.org/licenses/>. --
26 -- --
27 -- GNAT was originally developed by the GNAT team at New York University. --
28 -- Extensive contributions were provided by Ada Core Technologies Inc. --
29 -- --
30 ------------------------------------------------------------------------------
32 -- This package provides some useful utility subprograms that provide access
33 -- to source code information known at compile time. These subprograms are
34 -- intrinsic operations that provide information known to the compiler in
35 -- a form that can be embedded into the source program for identification
36 -- and logging purposes. For example, an exception handler can print out
37 -- the name of the source file in which the exception is handled.
39 package GNAT.Source_Info is
40 pragma Pure;
42 function File return String;
43 -- Return the name of the current file, not including the path information.
44 -- The result is considered to be a static string constant.
46 function Line return Positive;
47 -- Return the current input line number. The result is considered to be a
48 -- static expression.
50 function Source_Location return String;
51 -- Return a string literal of the form "name:line", where name is the
52 -- current source file name without path information, and line is the
53 -- current line number. In the event that instantiations are involved,
54 -- additional suffixes of the same form are appended after the separating
55 -- string " instantiated at ". The result is considered to be a static
56 -- string constant.
58 function Enclosing_Entity return String;
59 -- Return the name of the current subprogram, package, task, entry or
60 -- protected subprogram. The string is in exactly the form used for the
61 -- declaration of the entity (casing and encoding conventions), and is
62 -- considered to be a static string constant. The name is fully qualified
63 -- using periods where possible (this is not always possible, notably in
64 -- the case of entities appearing in unnamed block statements.)
66 -- Note: if this function is used at the outer level of a generic package,
67 -- the string returned will be the name of the instance, not the generic
68 -- package itself. This is useful in identifying and logging information
69 -- from within generic templates.
71 private
72 pragma Import (Intrinsic, File);
73 pragma Import (Intrinsic, Line);
74 pragma Import (Intrinsic, Source_Location);
75 pragma Import (Intrinsic, Enclosing_Entity);
76 end GNAT.Source_Info;