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 | --
-- Copyright (C) 2014-2022, AdaCore
-- SPDX-License-Identifier: Apache-2.0
--
with Ada.Strings; use Ada.Strings;
with Ada.Strings.Fixed;
with Gpr_Parser_Support.Text; use Gpr_Parser_Support.Text;
-- This package provides types and associated operation to handle source
-- locations.
package Gpr_Parser_Support.Slocs is
type Line_Number is mod 2 ** 32;
type Column_Number is mod 2 ** 16;
type Relative_Position is (Before, Inside, After);
-- Where some source location is with respect to another/a source location
-- range.
type Source_Location is record
Line : Line_Number;
-- Line for this source location
Column : Column_Number;
-- Column for this source location
end record;
-- Type representing a location in the source
type Source_Location_Range is record
Start_Line, End_Line : Line_Number;
-- Start and end lines for this source location
Start_Column, End_Column : Column_Number;
-- Start and end columns for this source location
end record;
-- Type representing a range in the source
No_Source_Location : constant Source_Location := (0, 0);
No_Source_Location_Range : constant Source_Location_Range := (0, 0, 0, 0);
--------------------------
-- Constructors/getters --
--------------------------
function Start_Sloc
(Sloc_Range : Source_Location_Range) return Source_Location
is ((Line => Sloc_Range.Start_Line, Column => Sloc_Range.Start_Column));
function End_Sloc
(Sloc_Range : Source_Location_Range) return Source_Location
is ((Line => Sloc_Range.End_Line, Column => Sloc_Range.End_Column));
function Make_Range
(Start_Sloc, End_Sloc : Source_Location) return Source_Location_Range
is ((Start_Line => Start_Sloc.Line,
End_Line => End_Sloc.Line,
Start_Column => Start_Sloc.Column,
End_Column => End_Sloc.Column));
--------------------------
-- Location comparisons --
--------------------------
function Compare
(Reference, Compared : Source_Location) return Relative_Position
with Pre => (Reference /= No_Source_Location
and then Compared /= No_Source_Location);
-- Tell where Compared is with respect to Reference (before, inside = same
-- sloc, after).
function "<" (L, R : Source_Location) return Boolean is
(Compare (L, R) = After);
function "<=" (L, R : Source_Location) return Boolean is
(Compare (L, R) in After | Inside);
function ">" (L, R : Source_Location) return Boolean is
(Compare (L, R) = Before);
function ">=" (L, R : Source_Location) return Boolean is
(Compare (L, R) in Before | Inside);
function Compare
(Sloc_Range : Source_Location_Range;
Sloc : Source_Location) return Relative_Position
with Pre => (Sloc_Range /= No_Source_Location_Range
and then Sloc /= No_Source_Location);
-- Tell where Sloc is with respect to Sloc_Range
------------------------
-- String conversions --
------------------------
-- All functions below assume that the textual representation of
-- Source_Location values have the form "L:C" (L being the line number, C
-- the column number) and Source_Location_Range have the form
-- "L1:C1-L2:C2" (L1 and C1 are numbers for the start sloc, L2 and C2 are
-- the numbers for the end sloc).
function Image (Sloc : Source_Location) return String is
(Ada.Strings.Fixed.Trim (Line_Number'Image (Sloc.Line), Left) & ':'
& Ada.Strings.Fixed.Trim (Column_Number'Image (Sloc.Column), Left));
function Image (Sloc_Range : Source_Location_Range) return String is
(Image (Start_Sloc (Sloc_Range)) & '-'
& Image (End_Sloc (Sloc_Range)));
function Image (Sloc : Source_Location) return Text_Type
is (To_Text (Image (Sloc)));
function Image (Sloc_Range : Source_Location_Range) return Text_Type
is (To_Text (Image (Sloc_Range)));
function Value (T : Text_Type) return Source_Location;
function Value (S : String) return Source_Location
is (Value (To_Text (S)));
function Value (T : Text_Type) return Source_Location_Range;
function Value (S : String) return Source_Location_Range
is (Value (To_Text (S)));
---------------------------------
-- Sloc computations from text --
---------------------------------
Default_Tab_Stop : constant Positive := 8;
-- Value that will be used for the default tab stop if none is passed
-- during the initialization of a ``Token_Data_Handler``.
function Column_Count
(Line : Text_Type;
Tab_Stop : Positive := Default_Tab_Stop) return Column_Number;
-- Return the number of columns in ``Line``, according to the given
-- ``Tab_Stop`` to expand horizontal tabulations.
end Gpr_Parser_Support.Slocs;
|