1 // go-linemap.h -- interface to location tracking -*- C++ -*-
3 // Copyright 2011 The Go Authors. All rights reserved.
4 // Use of this source code is governed by a BSD-style
5 // license that can be found in the LICENSE file.
10 #include "go-system.h"
12 // The backend must define a type named Location which holds
13 // information about a location in a source file. The only thing the
14 // frontend does with instances of Location is pass them back to the
15 // backend interface. The Location type must be assignable, and it
16 // must be comparable: i.e., it must support operator= and operator<.
17 // The type is normally passed by value rather than by reference, and
18 // it should support that efficiently. The type should be defined in
20 #include "go-location.h"
22 // The Linemap class is a pure abstract interface, plus some static
23 // convenience functions. The backend must implement the interface.
30 // Only one instance of Linemap is allowed to exist.
31 go_assert(Linemap::instance_
== NULL
);
32 Linemap::instance_
= this;
36 ~Linemap() { Linemap::instance_
= NULL
; }
38 // Subsequent Location values will come from the file named
39 // FILE_NAME, starting at LINE_BEGIN. Normally LINE_BEGIN will be
40 // 0, but it will be non-zero if the Go source has a //line comment.
42 start_file(const char* file_name
, unsigned int line_begin
) = 0;
44 // Subsequent Location values will come from the line LINE_NUMBER,
45 // in the current file. LINE_SIZE is the size of the line in bytes.
46 // This will normally be called for every line in a source file.
48 start_line(unsigned int line_number
, unsigned int line_size
) = 0;
50 // Get a Location representing column position COLUMN on the current
51 // line in the current file.
53 get_location(unsigned int column
) = 0;
55 // Stop generating Location values. This will be called after all
56 // input files have been read, in case any cleanup is required.
60 // Produce a human-readable description of a Location, e.g.
61 // "foo.go:10". Returns an empty string for predeclared, builtin or
64 to_string(Location
) = 0;
66 // Return the file name for a given location.
68 location_file(Location
) = 0;
70 // Return the line number for a given location.
72 location_line(Location
) = 0;
75 // Return a special Location used for predeclared identifiers. This
76 // Location should be different from that for any actual source
77 // file. This location will be used for various different types,
78 // functions, and objects created by the frontend.
80 get_predeclared_location() = 0;
82 // Return a special Location which indicates that no actual location
83 // is known. This is used for undefined objects and for errors.
85 get_unknown_location() = 0;
87 // Return whether the argument is the Location returned by
88 // get_predeclared_location.
90 is_predeclared(Location
) = 0;
92 // Return whether the argument is the Location returned by
93 // get_unknown_location.
95 is_unknown(Location
) = 0;
97 // The single existing instance of Linemap.
98 static Linemap
*instance_
;
101 // Following are convenience static functions, which allow us to
102 // access some virtual functions without explicitly passing around
103 // an instance of Linemap.
105 // Return the special Location used for predeclared identifiers.
107 predeclared_location()
109 go_assert(Linemap::instance_
!= NULL
);
110 return Linemap::instance_
->get_predeclared_location();
113 // Return the special Location used when no location is known.
117 go_assert(Linemap::instance_
!= NULL
);
118 return Linemap::instance_
->get_unknown_location();
121 // Return whether the argument is the special location used for
122 // predeclared identifiers.
124 is_predeclared_location(Location loc
)
126 go_assert(Linemap::instance_
!= NULL
);
127 return Linemap::instance_
->is_predeclared(loc
);
130 // Return whether the argument is the special location used when no
131 // location is known.
133 is_unknown_location(Location loc
)
135 go_assert(Linemap::instance_
!= NULL
);
136 return Linemap::instance_
->is_unknown(loc
);
139 // Produce a human-readable description of a Location.
141 location_to_string(Location loc
)
143 go_assert(Linemap::instance_
!= NULL
);
144 return Linemap::instance_
->to_string(loc
);
147 // Return the file name of a location.
149 location_to_file(Location loc
)
151 go_assert(Linemap::instance_
!= NULL
);
152 return Linemap::instance_
->location_file(loc
);
155 // Return line number of a location.
157 location_to_line(Location loc
)
159 go_assert(Linemap::instance_
!= NULL
);
160 return Linemap::instance_
->location_line(loc
);
164 #endif // !defined(GO_LINEMAP_H)