source: src/Common/CodeLocationTools.cpp@ c19edd1

ADT ast-experimental pthread-emulation qualifiedEnum
Last change on this file since c19edd1 was 7675f58, checked in by Andrew Beach <ajbeach@…>, 3 years ago

Labels on statements (not all Labels in the AST) now have all their locations filled.
  • Property mode set to 100644
File size: 8.0 KB
Line 
1//
2// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
3//
4// The contents of this file are covered under the licence agreement in the
5// file "LICENCE" distributed with Cforall.
6//
7// CodeLocationTools.cpp -- Additional tools for code locations.
8//
9// Author : Andrew Beach
10// Created On : Fri Dec 4 15:42:00 2020
11// Last Modified By : Andrew Beach
12// Last Modified On : Wed May 11 16:16:00 2022
13// Update Count : 5
14//
15
16#include "CodeLocationTools.hpp"
17
18#include <type_traits>
19
20#include "AST/Pass.hpp"
21#include "AST/TranslationUnit.hpp"
22#include "Common/CodeLocation.h"
23
24namespace {
25
26// Fill every location with a nearby (parent) location.
27class FillCore : public ast::WithGuards {
28 CodeLocation const * parent;
29
30 template<typename node_t>
31 node_t const * parse_visit( node_t const * node ) {
32 if ( node->location.isUnset() ) {
33 assert( parent );
34 node_t * newNode = ast::mutate( node );
35 newNode->location = *parent;
36 return newNode;
37 }
38 GuardValue( parent ) = &node->location;
39 return node;
40 }
41
42 bool hasUnsetLabels( const ast::Stmt * stmt ) {
43 for ( const ast::Label& label : stmt->labels ) {
44 if ( label.location.isUnset() ) {
45 return true;
46 }
47 }
48 return false;
49 }
50
51 template<typename node_t>
52 node_t const * stmt_visit( node_t const * node ) {
53 assert( node->location.isSet() );
54
55 if ( hasUnsetLabels( node ) ) {
56 node_t * newNode = ast::mutate( node );
57 for ( ast::Label& label : newNode->labels ) {
58 if ( label.location.isUnset() ) {
59 label.location = newNode->location;
60 }
61 }
62 return newNode;
63 }
64 return node;
65 }
66
67 template<typename node_t>
68 auto visit( node_t const * node, long ) {
69 return node;
70 }
71
72 template<typename node_t>
73 auto visit( node_t const * node, int ) -> typename
74 std::remove_reference< decltype( node->location, node ) >::type {
75 return parse_visit( node );
76 }
77
78 template<typename node_t>
79 auto visit( node_t const * node, char ) -> typename
80 std::remove_reference< decltype( node->labels, node ) >::type {
81 return stmt_visit( parse_visit( node ) );
82 }
83
84public:
85 FillCore() : parent( nullptr ) {}
86 FillCore( const CodeLocation& location ) : parent( &location ) {
87 assert( location.isSet() );
88 }
89
90 template<typename node_t>
91 node_t const * previsit( node_t const * node ) {
92 return visit( node, '\0' );
93 }
94};
95
96// ALL_VISITS(macro)
97// Expands `macro(node_type, return_type)` for every visit method of the
98// ast::Visitor class where node_type is the name of the parameter and
99// return_type is the name of the return type; not including the namespace,
100// pointer or const qualifiers.
101#define ALL_VISITS(macro) \
102 macro(ObjectDecl, DeclWithType) \
103 macro(FunctionDecl, DeclWithType) \
104 macro(StructDecl, Decl) \
105 macro(UnionDecl, Decl) \
106 macro(EnumDecl, Decl) \
107 macro(TraitDecl, Decl) \
108 macro(TypeDecl, Decl) \
109 macro(TypedefDecl, Decl) \
110 macro(AsmDecl, AsmDecl) \
111 macro(DirectiveDecl, DirectiveDecl) \
112 macro(StaticAssertDecl, StaticAssertDecl) \
113 macro(CompoundStmt, CompoundStmt) \
114 macro(ExprStmt, Stmt) \
115 macro(AsmStmt, Stmt) \
116 macro(DirectiveStmt, Stmt) \
117 macro(IfStmt, Stmt) \
118 macro(WhileDoStmt, Stmt) \
119 macro(ForStmt, Stmt) \
120 macro(SwitchStmt, Stmt) \
121 macro(CaseClause, CaseClause) \
122 macro(BranchStmt, Stmt) \
123 macro(ReturnStmt, Stmt) \
124 macro(ThrowStmt, Stmt) \
125 macro(TryStmt, Stmt) \
126 macro(CatchClause, CatchClause) \
127 macro(FinallyClause, FinallyClause) \
128 macro(SuspendStmt, Stmt) \
129 macro(WaitForStmt, Stmt) \
130 macro(WaitForClause, WaitForClause) \
131 macro(WithStmt, Decl) \
132 macro(NullStmt, NullStmt) \
133 macro(DeclStmt, Stmt) \
134 macro(ImplicitCtorDtorStmt, Stmt) \
135 macro(MutexStmt, Stmt) \
136 macro(ApplicationExpr, Expr) \
137 macro(UntypedExpr, Expr) \
138 macro(NameExpr, Expr) \
139 macro(AddressExpr, Expr) \
140 macro(LabelAddressExpr, Expr) \
141 macro(CastExpr, Expr) \
142 macro(KeywordCastExpr, Expr) \
143 macro(VirtualCastExpr, Expr) \
144 macro(UntypedMemberExpr, Expr) \
145 macro(MemberExpr, Expr) \
146 macro(VariableExpr, Expr) \
147 macro(ConstantExpr, Expr) \
148 macro(SizeofExpr, Expr) \
149 macro(AlignofExpr, Expr) \
150 macro(UntypedOffsetofExpr, Expr) \
151 macro(OffsetofExpr, Expr) \
152 macro(OffsetPackExpr, Expr) \
153 macro(LogicalExpr, Expr) \
154 macro(ConditionalExpr, Expr) \
155 macro(CommaExpr, Expr) \
156 macro(TypeExpr, Expr) \
157 macro(DimensionExpr, Expr) \
158 macro(AsmExpr, Expr) \
159 macro(ImplicitCopyCtorExpr, Expr) \
160 macro(ConstructorExpr, Expr) \
161 macro(CompoundLiteralExpr, Expr) \
162 macro(RangeExpr, Expr) \
163 macro(UntypedTupleExpr, Expr) \
164 macro(TupleExpr, Expr) \
165 macro(TupleIndexExpr, Expr) \
166 macro(TupleAssignExpr, Expr) \
167 macro(StmtExpr, Expr) \
168 macro(UniqueExpr, Expr) \
169 macro(UntypedInitExpr, Expr) \
170 macro(InitExpr, Expr) \
171 macro(DeletedExpr, Expr) \
172 macro(DefaultArgExpr, Expr) \
173 macro(GenericExpr, Expr) \
174 macro(VoidType, Type) \
175 macro(BasicType, Type) \
176 macro(PointerType, Type) \
177 macro(ArrayType, Type) \
178 macro(ReferenceType, Type) \
179 macro(QualifiedType, Type) \
180 macro(FunctionType, Type) \
181 macro(StructInstType, Type) \
182 macro(UnionInstType, Type) \
183 macro(EnumInstType, Type) \
184 macro(TraitInstType, Type) \
185 macro(TypeInstType, Type) \
186 macro(TupleType, Type) \
187 macro(TypeofType, Type) \
188 macro(VTableType, Type) \
189 macro(VarArgsType, Type) \
190 macro(ZeroType, Type) \
191 macro(OneType, Type) \
192 macro(GlobalScopeType, Type) \
193 macro(Designation, Designation) \
194 macro(SingleInit, Init) \
195 macro(ListInit, Init) \
196 macro(ConstructorInit, Init) \
197 macro(Attribute, Attribute) \
198 macro(TypeSubstitution, TypeSubstitution)
199
200// These could even go into the ast namespace.
201enum class LeafKind {
202#define VISIT(node_type, return_type) node_type,
203 ALL_VISITS(VISIT)
204#undef VISIT
205};
206
207struct LeafKindVisitor : public ast::Visitor {
208 LeafKind kind;
209
210#define VISIT(node_type, return_type) \
211 const ast::return_type * visit( const ast::node_type * ) final { \
212 kind = LeafKind::node_type; \
213 return nullptr; \
214 }
215 ALL_VISITS(VISIT)
216#undef VISIT
217};
218
219constexpr size_t leaf_kind_count = (1 + (size_t)LeafKind::TypeSubstitution);
220
221LeafKind get_leaf_kind( ast::Node const * node ) {
222 LeafKindVisitor visitor;
223 node->accept( visitor );
224 return visitor.kind;
225}
226
227const char * leaf_kind_names[leaf_kind_count] = {
228#define VISIT(node_type, return_type) #node_type,
229 ALL_VISITS(VISIT)
230#undef VISIT
231};
232
233// Collect pointers to all the nodes with unset code locations.
234class CollectCore {
235 std::list< ast::ptr< ast::Node > > & unset;
236public:
237 CollectCore( std::list< ast::ptr< ast::Node > > & unset ) :
238 unset( unset )
239 {}
240
241 template<typename node_t>
242 auto previsit( node_t const * node ) -> decltype( node->location, void() ) {
243 if ( node->location.isUnset() ) {
244 unset.push_back( node );
245 }
246 }
247};
248
249} // namespace
250
251void checkAllCodeLocations( ast::TranslationUnit const & unit ) {
252 checkAllCodeLocations( "unknown location", unit );
253}
254
255void checkAllCodeLocations( char const * label, ast::TranslationUnit const & unit ) {
256 std::list< ast::ptr< ast::Node > > unsetNodes;
257 {
258 ast::Pass<CollectCore> collector( unsetNodes );
259 for ( auto node : unit.decls ) {
260 node->accept( collector );
261 }
262 }
263 if ( unsetNodes.empty() ) {
264 return;
265 }
266
267 std::cerr << "Code Location check at " << label << " failed." << std::endl;
268 std::cerr << "Total nodes without a set code location: "
269 << unsetNodes.size() << std::endl;
270
271 size_t node_counts[leaf_kind_count] = {0};
272 for ( auto unset : unsetNodes ) {
273 node_counts[(size_t)get_leaf_kind(unset)] += 1;
274 }
275 for ( size_t i = 0 ; i < leaf_kind_count ; ++i ) {
276 if ( node_counts[i] ) {
277 std::cerr << '\t' << node_counts[i]
278 << " of type " << leaf_kind_names[i] << std::endl;
279 }
280 }
281
282 assert( unsetNodes.empty() );
283}
284
285void forceFillCodeLocations( ast::TranslationUnit & unit ) {
286 ast::Pass<FillCore>::run( unit );
287}
288
289ast::Node const * localFillCodeLocations(
290 CodeLocation const & location , ast::Node const * node ) {
291 ast::Pass<FillCore> visitor( location );
292 return node->accept( visitor );
293}
Note: See TracBrowser for help on using the repository browser.