source: src/SymTab/Validate.cc @ 2c04369

arm-ehcleanup-dtorsenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since 2c04369 was 2c04369, checked in by Andrew Beach <ajbeach@…>, 3 years ago

Fixed some problems in convert. One of which was better solved by removing the FindSpecialDeclarations? hack.

  • Property mode set to 100644
File size: 52.8 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// Validate.cc --
8//
9// Author           : Richard C. Bilson
10// Created On       : Sun May 17 21:50:04 2015
11// Last Modified By : Andrew Beach
12// Last Modified On : Tue May 28 11:07:00 2019
13// Update Count     : 360
14//
15
16// The "validate" phase of translation is used to take a syntax tree and convert it into a standard form that aims to be
17// as regular in structure as possible.  Some assumptions can be made regarding the state of the tree after this pass is
18// complete, including:
19//
20// - No nested structure or union definitions; any in the input are "hoisted" to the level of the containing struct or
21//   union.
22//
23// - All enumeration constants have type EnumInstType.
24//
25// - The type "void" never occurs in lists of function parameter or return types.  A function
26//   taking no arguments has no argument types.
27//
28// - No context instances exist; they are all replaced by the set of declarations signified by the context, instantiated
29//   by the particular set of type arguments.
30//
31// - Every declaration is assigned a unique id.
32//
33// - No typedef declarations or instances exist; the actual type is substituted for each instance.
34//
35// - Each type, struct, and union definition is followed by an appropriate assignment operator.
36//
37// - Each use of a struct or union is connected to a complete definition of that struct or union, even if that
38//   definition occurs later in the input.
39
40#include "Validate.h"
41
42#include <cassert>                     // for assertf, assert
43#include <cstddef>                     // for size_t
44#include <list>                        // for list
45#include <string>                      // for string
46#include <utility>                     // for pair
47
48#include "CodeGen/CodeGenerator.h"     // for genName
49#include "CodeGen/OperatorTable.h"     // for isCtorDtor, isCtorDtorAssign
50#include "ControlStruct/Mutate.h"      // for ForExprMutator
51#include "Common/Stats.h"              // for Stats::Heap
52#include "Common/PassVisitor.h"        // for PassVisitor, WithDeclsToAdd
53#include "Common/ScopedMap.h"          // for ScopedMap
54#include "Common/SemanticError.h"      // for SemanticError
55#include "Common/UniqueName.h"         // for UniqueName
56#include "Common/utility.h"            // for operator+, cloneAll, deleteAll
57#include "Concurrency/Keywords.h"      // for applyKeywords
58#include "FixFunction.h"               // for FixFunction
59#include "Indexer.h"                   // for Indexer
60#include "InitTweak/GenInit.h"         // for fixReturnStatements
61#include "InitTweak/InitTweak.h"       // for isCtorDtorAssign
62#include "Parser/LinkageSpec.h"        // for C
63#include "ResolvExpr/typeops.h"        // for typesCompatible
64#include "ResolvExpr/Resolver.h"       // for findSingleExpression
65#include "ResolvExpr/ResolveTypeof.h"  // for resolveTypeof
66#include "SymTab/Autogen.h"            // for SizeType
67#include "SynTree/Attribute.h"         // for noAttributes, Attribute
68#include "SynTree/Constant.h"          // for Constant
69#include "SynTree/Declaration.h"       // for ObjectDecl, DeclarationWithType
70#include "SynTree/Expression.h"        // for CompoundLiteralExpr, Expressio...
71#include "SynTree/Initializer.h"       // for ListInit, Initializer
72#include "SynTree/Label.h"             // for operator==, Label
73#include "SynTree/Mutator.h"           // for Mutator
74#include "SynTree/Type.h"              // for Type, TypeInstType, EnumInstType
75#include "SynTree/TypeSubstitution.h"  // for TypeSubstitution
76#include "SynTree/Visitor.h"           // for Visitor
77#include "Validate/HandleAttributes.h" // for handleAttributes
78
79class CompoundStmt;
80class ReturnStmt;
81class SwitchStmt;
82
83#define debugPrint( x ) if ( doDebug ) x
84
85namespace SymTab {
86        /// hoists declarations that are difficult to hoist while parsing
87        struct HoistTypeDecls final : public WithDeclsToAdd {
88                void previsit( SizeofExpr * );
89                void previsit( AlignofExpr * );
90                void previsit( UntypedOffsetofExpr * );
91                void previsit( CompoundLiteralExpr * );
92                void handleType( Type * );
93        };
94
95        struct FixQualifiedTypes final : public WithIndexer {
96                Type * postmutate( QualifiedType * );
97        };
98
99        struct HoistStruct final : public WithDeclsToAdd, public WithGuards {
100                /// Flattens nested struct types
101                static void hoistStruct( std::list< Declaration * > &translationUnit );
102
103                void previsit( StructDecl * aggregateDecl );
104                void previsit( UnionDecl * aggregateDecl );
105                void previsit( StaticAssertDecl * assertDecl );
106                void previsit( StructInstType * type );
107                void previsit( UnionInstType * type );
108                void previsit( EnumInstType * type );
109
110          private:
111                template< typename AggDecl > void handleAggregate( AggDecl *aggregateDecl );
112
113                AggregateDecl * parentAggr = nullptr;
114        };
115
116        /// Fix return types so that every function returns exactly one value
117        struct ReturnTypeFixer {
118                static void fix( std::list< Declaration * > &translationUnit );
119
120                void postvisit( FunctionDecl * functionDecl );
121                void postvisit( FunctionType * ftype );
122        };
123
124        /// Replaces enum types by int, and function or array types in function parameter and return lists by appropriate pointers.
125        struct EnumAndPointerDecay {
126                void previsit( EnumDecl *aggregateDecl );
127                void previsit( FunctionType *func );
128        };
129
130        /// Associates forward declarations of aggregates with their definitions
131        struct LinkReferenceToTypes final : public WithIndexer, public WithGuards, public WithVisitorRef<LinkReferenceToTypes>, public WithShortCircuiting {
132                LinkReferenceToTypes( const Indexer *indexer );
133                void postvisit( TypeInstType *typeInst );
134
135                void postvisit( EnumInstType *enumInst );
136                void postvisit( StructInstType *structInst );
137                void postvisit( UnionInstType *unionInst );
138                void postvisit( TraitInstType *traitInst );
139                void previsit( QualifiedType * qualType );
140                void postvisit( QualifiedType * qualType );
141
142                void postvisit( EnumDecl *enumDecl );
143                void postvisit( StructDecl *structDecl );
144                void postvisit( UnionDecl *unionDecl );
145                void postvisit( TraitDecl * traitDecl );
146
147                void previsit( StructDecl *structDecl );
148                void previsit( UnionDecl *unionDecl );
149
150                void renameGenericParams( std::list< TypeDecl * > & params );
151
152          private:
153                const Indexer *local_indexer;
154
155                typedef std::map< std::string, std::list< EnumInstType * > > ForwardEnumsType;
156                typedef std::map< std::string, std::list< StructInstType * > > ForwardStructsType;
157                typedef std::map< std::string, std::list< UnionInstType * > > ForwardUnionsType;
158                ForwardEnumsType forwardEnums;
159                ForwardStructsType forwardStructs;
160                ForwardUnionsType forwardUnions;
161                /// true if currently in a generic type body, so that type parameter instances can be renamed appropriately
162                bool inGeneric = false;
163        };
164
165        /// Replaces array and function types in forall lists by appropriate pointer type and assigns each Object and Function declaration a unique ID.
166        struct ForallPointerDecay final {
167                void previsit( ObjectDecl * object );
168                void previsit( FunctionDecl * func );
169                void previsit( FunctionType * ftype );
170                void previsit( StructDecl * aggrDecl );
171                void previsit( UnionDecl * aggrDecl );
172        };
173
174        struct ReturnChecker : public WithGuards {
175                /// Checks that return statements return nothing if their return type is void
176                /// and return something if the return type is non-void.
177                static void checkFunctionReturns( std::list< Declaration * > & translationUnit );
178
179                void previsit( FunctionDecl * functionDecl );
180                void previsit( ReturnStmt * returnStmt );
181
182                typedef std::list< DeclarationWithType * > ReturnVals;
183                ReturnVals returnVals;
184        };
185
186        struct ReplaceTypedef final : public WithVisitorRef<ReplaceTypedef>, public WithGuards, public WithShortCircuiting, public WithDeclsToAdd {
187                ReplaceTypedef() : scopeLevel( 0 ) {}
188                /// Replaces typedefs by forward declarations
189                static void replaceTypedef( std::list< Declaration * > &translationUnit );
190
191                void premutate( QualifiedType * );
192                Type * postmutate( QualifiedType * qualType );
193                Type * postmutate( TypeInstType * aggregateUseType );
194                Declaration * postmutate( TypedefDecl * typeDecl );
195                void premutate( TypeDecl * typeDecl );
196                void premutate( FunctionDecl * funcDecl );
197                void premutate( ObjectDecl * objDecl );
198                DeclarationWithType * postmutate( ObjectDecl * objDecl );
199
200                void premutate( CastExpr * castExpr );
201
202                void premutate( CompoundStmt * compoundStmt );
203
204                void premutate( StructDecl * structDecl );
205                void premutate( UnionDecl * unionDecl );
206                void premutate( EnumDecl * enumDecl );
207                void premutate( TraitDecl * );
208
209                void premutate( FunctionType * ftype );
210
211          private:
212                template<typename AggDecl>
213                void addImplicitTypedef( AggDecl * aggDecl );
214                template< typename AggDecl >
215                void handleAggregate( AggDecl * aggr );
216
217                typedef std::unique_ptr<TypedefDecl> TypedefDeclPtr;
218                typedef ScopedMap< std::string, std::pair< TypedefDeclPtr, int > > TypedefMap;
219                typedef ScopedMap< std::string, TypeDecl * > TypeDeclMap;
220                TypedefMap typedefNames;
221                TypeDeclMap typedeclNames;
222                int scopeLevel;
223                bool inFunctionType = false;
224        };
225
226        struct EliminateTypedef {
227                /// removes TypedefDecls from the AST
228                static void eliminateTypedef( std::list< Declaration * > &translationUnit );
229
230                template<typename AggDecl>
231                void handleAggregate( AggDecl *aggregateDecl );
232
233                void previsit( StructDecl * aggregateDecl );
234                void previsit( UnionDecl * aggregateDecl );
235                void previsit( CompoundStmt * compoundStmt );
236        };
237
238        struct VerifyCtorDtorAssign {
239                /// ensure that constructors, destructors, and assignment have at least one
240                /// parameter, the first of which must be a pointer, and that ctor/dtors have no
241                /// return values.
242                static void verify( std::list< Declaration * > &translationUnit );
243
244                void previsit( FunctionDecl *funcDecl );
245        };
246
247        /// ensure that generic types have the correct number of type arguments
248        struct ValidateGenericParameters {
249                void previsit( StructInstType * inst );
250                void previsit( UnionInstType * inst );
251        };
252
253        struct FixObjectType : public WithIndexer {
254                /// resolves typeof type in object, function, and type declarations
255                static void fix( std::list< Declaration * > & translationUnit );
256
257                void previsit( ObjectDecl * );
258                void previsit( FunctionDecl * );
259                void previsit( TypeDecl * );
260        };
261
262        struct ArrayLength : public WithIndexer {
263                /// for array types without an explicit length, compute the length and store it so that it
264                /// is known to the rest of the phases. For example,
265                ///   int x[] = { 1, 2, 3 };
266                ///   int y[][2] = { { 1, 2, 3 }, { 1, 2, 3 } };
267                /// here x and y are known at compile-time to have length 3, so change this into
268                ///   int x[3] = { 1, 2, 3 };
269                ///   int y[3][2] = { { 1, 2, 3 }, { 1, 2, 3 } };
270                static void computeLength( std::list< Declaration * > & translationUnit );
271
272                void previsit( ObjectDecl * objDecl );
273                void previsit( ArrayType * arrayType );
274        };
275
276        struct CompoundLiteral final : public WithDeclsToAdd, public WithVisitorRef<CompoundLiteral> {
277                Type::StorageClasses storageClasses;
278
279                void premutate( ObjectDecl *objectDecl );
280                Expression * postmutate( CompoundLiteralExpr *compLitExpr );
281        };
282
283        struct LabelAddressFixer final : public WithGuards {
284                std::set< Label > labels;
285
286                void premutate( FunctionDecl * funcDecl );
287                Expression * postmutate( AddressExpr * addrExpr );
288        };
289
290        void validate( std::list< Declaration * > &translationUnit, __attribute__((unused)) bool doDebug ) {
291                PassVisitor<EnumAndPointerDecay> epc;
292                PassVisitor<LinkReferenceToTypes> lrt( nullptr );
293                PassVisitor<ForallPointerDecay> fpd;
294                PassVisitor<CompoundLiteral> compoundliteral;
295                PassVisitor<ValidateGenericParameters> genericParams;
296                PassVisitor<LabelAddressFixer> labelAddrFixer;
297                PassVisitor<HoistTypeDecls> hoistDecls;
298                PassVisitor<FixQualifiedTypes> fixQual;
299
300                {
301                        Stats::Heap::newPass("validate-A");
302                        Stats::Time::BlockGuard guard("validate-A");
303                        acceptAll( translationUnit, hoistDecls );
304                        ReplaceTypedef::replaceTypedef( translationUnit );
305                        ReturnTypeFixer::fix( translationUnit ); // must happen before autogen
306                        acceptAll( translationUnit, epc ); // must happen before VerifyCtorDtorAssign, because void return objects should not exist; before LinkReferenceToTypes because it is an indexer and needs correct types for mangling
307                }
308                {
309                        Stats::Heap::newPass("validate-B");
310                        Stats::Time::BlockGuard guard("validate-B");
311                        Stats::Time::TimeBlock("Link Reference To Types", [&]() {
312                                acceptAll( translationUnit, lrt ); // must happen before autogen, because sized flag needs to propagate to generated functions
313                        });
314                        Stats::Time::TimeBlock("Fix Qualified Types", [&]() {
315                                mutateAll( translationUnit, fixQual ); // must happen after LinkReferenceToTypes, because aggregate members are accessed
316                        });
317                        Stats::Time::TimeBlock("Hoist Structs", [&]() {
318                                HoistStruct::hoistStruct( translationUnit ); // must happen after EliminateTypedef, so that aggregate typedefs occur in the correct order
319                        });
320                        Stats::Time::TimeBlock("Eliminate Typedefs", [&]() {
321                                EliminateTypedef::eliminateTypedef( translationUnit ); //
322                        });
323                }
324                {
325                        Stats::Heap::newPass("validate-C");
326                        Stats::Time::BlockGuard guard("validate-C");
327                        acceptAll( translationUnit, genericParams );  // check as early as possible - can't happen before LinkReferenceToTypes
328                        VerifyCtorDtorAssign::verify( translationUnit );  // must happen before autogen, because autogen examines existing ctor/dtors
329                        ReturnChecker::checkFunctionReturns( translationUnit );
330                        InitTweak::fixReturnStatements( translationUnit ); // must happen before autogen
331                }
332                {
333                        Stats::Heap::newPass("validate-D");
334                        Stats::Time::BlockGuard guard("validate-D");
335                        Stats::Time::TimeBlock("Apply Concurrent Keywords", [&]() {
336                                Concurrency::applyKeywords( translationUnit );
337                        });
338                        Stats::Time::TimeBlock("Forall Pointer Decay", [&]() {
339                                acceptAll( translationUnit, fpd ); // must happen before autogenerateRoutines, after Concurrency::applyKeywords because uniqueIds must be set on declaration before resolution
340                        });
341                        Stats::Time::TimeBlock("Hoist Control Declarations", [&]() {
342                                ControlStruct::hoistControlDecls( translationUnit );  // hoist initialization out of for statements; must happen before autogenerateRoutines
343                        });
344                        Stats::Time::TimeBlock("Generate Autogen routines", [&]() {
345                                autogenerateRoutines( translationUnit ); // moved up, used to be below compoundLiteral - currently needs EnumAndPointerDecay
346                        });
347                }
348                {
349                        Stats::Heap::newPass("validate-E");
350                        Stats::Time::BlockGuard guard("validate-E");
351                        Stats::Time::TimeBlock("Implement Mutex Func", [&]() {
352                                Concurrency::implementMutexFuncs( translationUnit );
353                        });
354                        Stats::Time::TimeBlock("Implement Thread Start", [&]() {
355                                Concurrency::implementThreadStarter( translationUnit );
356                        });
357                        Stats::Time::TimeBlock("Compound Literal", [&]() {
358                                mutateAll( translationUnit, compoundliteral );
359                        });
360                        Stats::Time::TimeBlock("Resolve With Expressions", [&]() {
361                                ResolvExpr::resolveWithExprs( translationUnit ); // must happen before FixObjectType because user-code is resolved and may contain with variables
362                        });
363                }
364                {
365                        Stats::Heap::newPass("validate-F");
366                        Stats::Time::BlockGuard guard("validate-F");
367                        Stats::Time::TimeBlock("Fix Object Type", [&]() {
368                                FixObjectType::fix( translationUnit );
369                        });
370                        Stats::Time::TimeBlock("Array Length", [&]() {
371                                ArrayLength::computeLength( translationUnit );
372                        });
373                        Stats::Time::TimeBlock("Fix Label Address", [&]() {
374                                mutateAll( translationUnit, labelAddrFixer );
375                        });
376                        Stats::Time::TimeBlock("Handle Attributes", [&]() {
377                                Validate::handleAttributes( translationUnit );
378                        });
379                }
380        }
381
382        void validateType( Type *type, const Indexer *indexer ) {
383                PassVisitor<EnumAndPointerDecay> epc;
384                PassVisitor<LinkReferenceToTypes> lrt( indexer );
385                PassVisitor<ForallPointerDecay> fpd;
386                type->accept( epc );
387                type->accept( lrt );
388                type->accept( fpd );
389        }
390
391
392        void HoistTypeDecls::handleType( Type * type ) {
393                // some type declarations are buried in expressions and not easy to hoist during parsing; hoist them here
394                AggregateDecl * aggr = nullptr;
395                if ( StructInstType * inst = dynamic_cast< StructInstType * >( type ) ) {
396                        aggr = inst->baseStruct;
397                } else if ( UnionInstType * inst = dynamic_cast< UnionInstType * >( type ) ) {
398                        aggr = inst->baseUnion;
399                } else if ( EnumInstType * inst = dynamic_cast< EnumInstType * >( type ) ) {
400                        aggr = inst->baseEnum;
401                }
402                if ( aggr && aggr->body ) {
403                        declsToAddBefore.push_front( aggr );
404                }
405        }
406
407        void HoistTypeDecls::previsit( SizeofExpr * expr ) {
408                handleType( expr->type );
409        }
410
411        void HoistTypeDecls::previsit( AlignofExpr * expr ) {
412                handleType( expr->type );
413        }
414
415        void HoistTypeDecls::previsit( UntypedOffsetofExpr * expr ) {
416                handleType( expr->type );
417        }
418
419        void HoistTypeDecls::previsit( CompoundLiteralExpr * expr ) {
420                handleType( expr->result );
421        }
422
423
424        Type * FixQualifiedTypes::postmutate( QualifiedType * qualType ) {
425                Type * parent = qualType->parent;
426                Type * child = qualType->child;
427                if ( dynamic_cast< GlobalScopeType * >( qualType->parent ) ) {
428                        // .T => lookup T at global scope
429                        if ( TypeInstType * inst = dynamic_cast< TypeInstType * >( child ) ) {
430                                auto td = indexer.globalLookupType( inst->name );
431                                if ( ! td ) {
432                                        SemanticError( qualType->location, toString("Use of undefined global type ", inst->name) );
433                                }
434                                auto base = td->base;
435                                assert( base );
436                                Type * ret = base->clone();
437                                ret->get_qualifiers() = qualType->get_qualifiers();
438                                return ret;
439                        } else {
440                                // .T => T is not a type name
441                                assertf( false, "unhandled global qualified child type: %s", toCString(child) );
442                        }
443                } else {
444                        // S.T => S must be an aggregate type, find the declaration for T in S.
445                        AggregateDecl * aggr = nullptr;
446                        if ( StructInstType * inst = dynamic_cast< StructInstType * >( parent ) ) {
447                                aggr = inst->baseStruct;
448                        } else if ( UnionInstType * inst = dynamic_cast< UnionInstType * > ( parent ) ) {
449                                aggr = inst->baseUnion;
450                        } else {
451                                SemanticError( qualType->location, toString("Qualified type requires an aggregate on the left, but has: ", parent) );
452                        }
453                        assert( aggr ); // TODO: need to handle forward declarations
454                        for ( Declaration * member : aggr->members ) {
455                                if ( TypeInstType * inst = dynamic_cast< TypeInstType * >( child ) ) {
456                                        // name on the right is a typedef
457                                        if ( NamedTypeDecl * aggr = dynamic_cast< NamedTypeDecl * > ( member ) ) {
458                                                if ( aggr->name == inst->name ) {
459                                                        assert( aggr->base );
460                                                        Type * ret = aggr->base->clone();
461                                                        ret->get_qualifiers() = qualType->get_qualifiers();
462                                                        TypeSubstitution sub = parent->genericSubstitution();
463                                                        sub.apply(ret);
464                                                        return ret;
465                                                }
466                                        }
467                                } else {
468                                        // S.T - S is not an aggregate => error
469                                        assertf( false, "unhandled qualified child type: %s", toCString(qualType) );
470                                }
471                        }
472                        // failed to find a satisfying definition of type
473                        SemanticError( qualType->location, toString("Undefined type in qualified type: ", qualType) );
474                }
475
476                // ... may want to link canonical SUE definition to each forward decl so that it becomes easier to lookup?
477        }
478
479
480        void HoistStruct::hoistStruct( std::list< Declaration * > &translationUnit ) {
481                PassVisitor<HoistStruct> hoister;
482                acceptAll( translationUnit, hoister );
483        }
484
485        bool shouldHoist( Declaration *decl ) {
486                return dynamic_cast< StructDecl * >( decl ) || dynamic_cast< UnionDecl * >( decl ) || dynamic_cast< StaticAssertDecl * >( decl );
487        }
488
489        namespace {
490                void qualifiedName( AggregateDecl * aggr, std::ostringstream & ss ) {
491                        if ( aggr->parent ) qualifiedName( aggr->parent, ss );
492                        ss << "__" << aggr->name;
493                }
494
495                // mangle nested type names using entire parent chain
496                std::string qualifiedName( AggregateDecl * aggr ) {
497                        std::ostringstream ss;
498                        qualifiedName( aggr, ss );
499                        return ss.str();
500                }
501        }
502
503        template< typename AggDecl >
504        void HoistStruct::handleAggregate( AggDecl *aggregateDecl ) {
505                if ( parentAggr ) {
506                        aggregateDecl->parent = parentAggr;
507                        aggregateDecl->name = qualifiedName( aggregateDecl );
508                        // Add elements in stack order corresponding to nesting structure.
509                        declsToAddBefore.push_front( aggregateDecl );
510                } else {
511                        GuardValue( parentAggr );
512                        parentAggr = aggregateDecl;
513                } // if
514                // Always remove the hoisted aggregate from the inner structure.
515                GuardAction( [aggregateDecl]() { filter( aggregateDecl->members, shouldHoist, false ); } );
516        }
517
518        void HoistStruct::previsit( StaticAssertDecl * assertDecl ) {
519                if ( parentAggr ) {
520                        declsToAddBefore.push_back( assertDecl );
521                }
522        }
523
524        void HoistStruct::previsit( StructDecl * aggregateDecl ) {
525                handleAggregate( aggregateDecl );
526        }
527
528        void HoistStruct::previsit( UnionDecl * aggregateDecl ) {
529                handleAggregate( aggregateDecl );
530        }
531
532        void HoistStruct::previsit( StructInstType * type ) {
533                // need to reset type name after expanding to qualified name
534                assert( type->baseStruct );
535                type->name = type->baseStruct->name;
536        }
537
538        void HoistStruct::previsit( UnionInstType * type ) {
539                assert( type->baseUnion );
540                type->name = type->baseUnion->name;
541        }
542
543        void HoistStruct::previsit( EnumInstType * type ) {
544                assert( type->baseEnum );
545                type->name = type->baseEnum->name;
546        }
547
548
549        bool isTypedef( Declaration *decl ) {
550                return dynamic_cast< TypedefDecl * >( decl );
551        }
552
553        void EliminateTypedef::eliminateTypedef( std::list< Declaration * > &translationUnit ) {
554                PassVisitor<EliminateTypedef> eliminator;
555                acceptAll( translationUnit, eliminator );
556                filter( translationUnit, isTypedef, true );
557        }
558
559        template< typename AggDecl >
560        void EliminateTypedef::handleAggregate( AggDecl *aggregateDecl ) {
561                filter( aggregateDecl->members, isTypedef, true );
562        }
563
564        void EliminateTypedef::previsit( StructDecl * aggregateDecl ) {
565                handleAggregate( aggregateDecl );
566        }
567
568        void EliminateTypedef::previsit( UnionDecl * aggregateDecl ) {
569                handleAggregate( aggregateDecl );
570        }
571
572        void EliminateTypedef::previsit( CompoundStmt * compoundStmt ) {
573                // remove and delete decl stmts
574                filter( compoundStmt->kids, [](Statement * stmt) {
575                        if ( DeclStmt *declStmt = dynamic_cast< DeclStmt * >( stmt ) ) {
576                                if ( dynamic_cast< TypedefDecl * >( declStmt->decl ) ) {
577                                        return true;
578                                } // if
579                        } // if
580                        return false;
581                }, true);
582        }
583
584        void EnumAndPointerDecay::previsit( EnumDecl *enumDecl ) {
585                // Set the type of each member of the enumeration to be EnumConstant
586                for ( std::list< Declaration * >::iterator i = enumDecl->members.begin(); i != enumDecl->members.end(); ++i ) {
587                        ObjectDecl * obj = dynamic_cast< ObjectDecl * >( *i );
588                        assert( obj );
589                        obj->set_type( new EnumInstType( Type::Qualifiers( Type::Const ), enumDecl->name ) );
590                } // for
591        }
592
593        namespace {
594                template< typename DWTList >
595                void fixFunctionList( DWTList & dwts, bool isVarArgs, FunctionType * func ) {
596                        auto nvals = dwts.size();
597                        bool containsVoid = false;
598                        for ( auto & dwt : dwts ) {
599                                // fix each DWT and record whether a void was found
600                                containsVoid |= fixFunction( dwt );
601                        }
602
603                        // the only case in which "void" is valid is where it is the only one in the list
604                        if ( containsVoid && ( nvals > 1 || isVarArgs ) ) {
605                                SemanticError( func, "invalid type void in function type " );
606                        }
607
608                        // one void is the only thing in the list; remove it.
609                        if ( containsVoid ) {
610                                delete dwts.front();
611                                dwts.clear();
612                        }
613                }
614        }
615
616        void EnumAndPointerDecay::previsit( FunctionType *func ) {
617                // Fix up parameters and return types
618                fixFunctionList( func->parameters, func->isVarArgs, func );
619                fixFunctionList( func->returnVals, false, func );
620        }
621
622        LinkReferenceToTypes::LinkReferenceToTypes( const Indexer *other_indexer ) {
623                if ( other_indexer ) {
624                        local_indexer = other_indexer;
625                } else {
626                        local_indexer = &indexer;
627                } // if
628        }
629
630        void LinkReferenceToTypes::postvisit( EnumInstType *enumInst ) {
631                EnumDecl *st = local_indexer->lookupEnum( enumInst->name );
632                // it's not a semantic error if the enum is not found, just an implicit forward declaration
633                if ( st ) {
634                        enumInst->baseEnum = st;
635                } // if
636                if ( ! st || ! st->body ) {
637                        // use of forward declaration
638                        forwardEnums[ enumInst->name ].push_back( enumInst );
639                } // if
640        }
641
642        void checkGenericParameters( ReferenceToType * inst ) {
643                for ( Expression * param : inst->parameters ) {
644                        if ( ! dynamic_cast< TypeExpr * >( param ) ) {
645                                SemanticError( inst, "Expression parameters for generic types are currently unsupported: " );
646                        }
647                }
648        }
649
650        void LinkReferenceToTypes::postvisit( StructInstType *structInst ) {
651                StructDecl *st = local_indexer->lookupStruct( structInst->name );
652                // it's not a semantic error if the struct is not found, just an implicit forward declaration
653                if ( st ) {
654                        structInst->baseStruct = st;
655                } // if
656                if ( ! st || ! st->body ) {
657                        // use of forward declaration
658                        forwardStructs[ structInst->name ].push_back( structInst );
659                } // if
660                checkGenericParameters( structInst );
661        }
662
663        void LinkReferenceToTypes::postvisit( UnionInstType *unionInst ) {
664                UnionDecl *un = local_indexer->lookupUnion( unionInst->name );
665                // it's not a semantic error if the union is not found, just an implicit forward declaration
666                if ( un ) {
667                        unionInst->baseUnion = un;
668                } // if
669                if ( ! un || ! un->body ) {
670                        // use of forward declaration
671                        forwardUnions[ unionInst->name ].push_back( unionInst );
672                } // if
673                checkGenericParameters( unionInst );
674        }
675
676        void LinkReferenceToTypes::previsit( QualifiedType * ) {
677                visit_children = false;
678        }
679
680        void LinkReferenceToTypes::postvisit( QualifiedType * qualType ) {
681                // linking only makes sense for the 'oldest ancestor' of the qualified type
682                qualType->parent->accept( *visitor );
683        }
684
685        template< typename Decl >
686        void normalizeAssertions( std::list< Decl * > & assertions ) {
687                // ensure no duplicate trait members after the clone
688                auto pred = [](Decl * d1, Decl * d2) {
689                        // only care if they're equal
690                        DeclarationWithType * dwt1 = dynamic_cast<DeclarationWithType *>( d1 );
691                        DeclarationWithType * dwt2 = dynamic_cast<DeclarationWithType *>( d2 );
692                        if ( dwt1 && dwt2 ) {
693                                if ( dwt1->name == dwt2->name && ResolvExpr::typesCompatible( dwt1->get_type(), dwt2->get_type(), SymTab::Indexer() ) ) {
694                                        // std::cerr << "=========== equal:" << std::endl;
695                                        // std::cerr << "d1: " << d1 << std::endl;
696                                        // std::cerr << "d2: " << d2 << std::endl;
697                                        return false;
698                                }
699                        }
700                        return d1 < d2;
701                };
702                std::set<Decl *, decltype(pred)> unique_members( assertions.begin(), assertions.end(), pred );
703                // if ( unique_members.size() != assertions.size() ) {
704                //      std::cerr << "============different" << std::endl;
705                //      std::cerr << unique_members.size() << " " << assertions.size() << std::endl;
706                // }
707
708                std::list< Decl * > order;
709                order.splice( order.end(), assertions );
710                std::copy_if( order.begin(), order.end(), back_inserter( assertions ), [&]( Decl * decl ) {
711                        return unique_members.count( decl );
712                });
713        }
714
715        // expand assertions from trait instance, performing the appropriate type variable substitutions
716        template< typename Iterator >
717        void expandAssertions( TraitInstType * inst, Iterator out ) {
718                assertf( inst->baseTrait, "Trait instance not linked to base trait: %s", toCString( inst ) );
719                std::list< DeclarationWithType * > asserts;
720                for ( Declaration * decl : inst->baseTrait->members ) {
721                        asserts.push_back( strict_dynamic_cast<DeclarationWithType *>( decl->clone() ) );
722                }
723                // substitute trait decl parameters for instance parameters
724                applySubstitution( inst->baseTrait->parameters.begin(), inst->baseTrait->parameters.end(), inst->parameters.begin(), asserts.begin(), asserts.end(), out );
725        }
726
727        void LinkReferenceToTypes::postvisit( TraitDecl * traitDecl ) {
728                if ( traitDecl->name == "sized" ) {
729                        // "sized" is a special trait - flick the sized status on for the type variable
730                        assertf( traitDecl->parameters.size() == 1, "Built-in trait 'sized' has incorrect number of parameters: %zd", traitDecl->parameters.size() );
731                        TypeDecl * td = traitDecl->parameters.front();
732                        td->set_sized( true );
733                }
734
735                // move assertions from type parameters into the body of the trait
736                for ( TypeDecl * td : traitDecl->parameters ) {
737                        for ( DeclarationWithType * assert : td->assertions ) {
738                                if ( TraitInstType * inst = dynamic_cast< TraitInstType * >( assert->get_type() ) ) {
739                                        expandAssertions( inst, back_inserter( traitDecl->members ) );
740                                } else {
741                                        traitDecl->members.push_back( assert->clone() );
742                                }
743                        }
744                        deleteAll( td->assertions );
745                        td->assertions.clear();
746                } // for
747        }
748
749        void LinkReferenceToTypes::postvisit( TraitInstType * traitInst ) {
750                // handle other traits
751                TraitDecl *traitDecl = local_indexer->lookupTrait( traitInst->name );
752                if ( ! traitDecl ) {
753                        SemanticError( traitInst->location, "use of undeclared trait " + traitInst->name );
754                } // if
755                if ( traitDecl->parameters.size() != traitInst->parameters.size() ) {
756                        SemanticError( traitInst, "incorrect number of trait parameters: " );
757                } // if
758                traitInst->baseTrait = traitDecl;
759
760                // need to carry over the 'sized' status of each decl in the instance
761                for ( auto p : group_iterate( traitDecl->parameters, traitInst->parameters ) ) {
762                        TypeExpr * expr = dynamic_cast< TypeExpr * >( std::get<1>(p) );
763                        if ( ! expr ) {
764                                SemanticError( std::get<1>(p), "Expression parameters for trait instances are currently unsupported: " );
765                        }
766                        if ( TypeInstType * inst = dynamic_cast< TypeInstType * >( expr->get_type() ) ) {
767                                TypeDecl * formalDecl = std::get<0>(p);
768                                TypeDecl * instDecl = inst->baseType;
769                                if ( formalDecl->get_sized() ) instDecl->set_sized( true );
770                        }
771                }
772                // normalizeAssertions( traitInst->members );
773        }
774
775        void LinkReferenceToTypes::postvisit( EnumDecl *enumDecl ) {
776                // visit enum members first so that the types of self-referencing members are updated properly
777                if ( enumDecl->body ) {
778                        ForwardEnumsType::iterator fwds = forwardEnums.find( enumDecl->name );
779                        if ( fwds != forwardEnums.end() ) {
780                                for ( std::list< EnumInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
781                                        (*inst)->baseEnum = enumDecl;
782                                } // for
783                                forwardEnums.erase( fwds );
784                        } // if
785
786                        for ( Declaration * member : enumDecl->members ) {
787                                ObjectDecl * field = strict_dynamic_cast<ObjectDecl *>( member );
788                                if ( field->init ) {
789                                        // need to resolve enumerator initializers early so that other passes that determine if an expression is constexpr have the appropriate information.
790                                        SingleInit * init = strict_dynamic_cast<SingleInit *>( field->init );
791                                        ResolvExpr::findSingleExpression( init->value, new BasicType( Type::Qualifiers(), BasicType::SignedInt ), indexer );
792                                }
793                        }
794                } // if
795        }
796
797        void LinkReferenceToTypes::renameGenericParams( std::list< TypeDecl * > & params ) {
798                // rename generic type parameters uniquely so that they do not conflict with user-defined function forall parameters, e.g.
799                //   forall(otype T)
800                //   struct Box {
801                //     T x;
802                //   };
803                //   forall(otype T)
804                //   void f(Box(T) b) {
805                //     ...
806                //   }
807                // The T in Box and the T in f are different, so internally the naming must reflect that.
808                GuardValue( inGeneric );
809                inGeneric = ! params.empty();
810                for ( TypeDecl * td : params ) {
811                        td->name = "__" + td->name + "_generic_";
812                }
813        }
814
815        void LinkReferenceToTypes::previsit( StructDecl * structDecl ) {
816                renameGenericParams( structDecl->parameters );
817        }
818
819        void LinkReferenceToTypes::previsit( UnionDecl * unionDecl ) {
820                renameGenericParams( unionDecl->parameters );
821        }
822
823        void LinkReferenceToTypes::postvisit( StructDecl *structDecl ) {
824                // visit struct members first so that the types of self-referencing members are updated properly
825                // xxx - need to ensure that type parameters match up between forward declarations and definition (most importantly, number of type parameters and their defaults)
826                if ( structDecl->body ) {
827                        ForwardStructsType::iterator fwds = forwardStructs.find( structDecl->name );
828                        if ( fwds != forwardStructs.end() ) {
829                                for ( std::list< StructInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
830                                        (*inst)->baseStruct = structDecl;
831                                } // for
832                                forwardStructs.erase( fwds );
833                        } // if
834                } // if
835        }
836
837        void LinkReferenceToTypes::postvisit( UnionDecl *unionDecl ) {
838                if ( unionDecl->body ) {
839                        ForwardUnionsType::iterator fwds = forwardUnions.find( unionDecl->name );
840                        if ( fwds != forwardUnions.end() ) {
841                                for ( std::list< UnionInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
842                                        (*inst)->baseUnion = unionDecl;
843                                } // for
844                                forwardUnions.erase( fwds );
845                        } // if
846                } // if
847        }
848
849        void LinkReferenceToTypes::postvisit( TypeInstType *typeInst ) {
850                // ensure generic parameter instances are renamed like the base type
851                if ( inGeneric && typeInst->baseType ) typeInst->name = typeInst->baseType->name;
852                if ( NamedTypeDecl *namedTypeDecl = local_indexer->lookupType( typeInst->name ) ) {
853                        if ( TypeDecl *typeDecl = dynamic_cast< TypeDecl * >( namedTypeDecl ) ) {
854                                typeInst->set_isFtype( typeDecl->get_kind() == TypeDecl::Ftype );
855                        } // if
856                } // if
857        }
858
859        /// Fix up assertions - flattens assertion lists, removing all trait instances
860        void forallFixer( std::list< TypeDecl * > & forall, BaseSyntaxNode * node ) {
861                for ( TypeDecl * type : forall ) {
862                        std::list< DeclarationWithType * > asserts;
863                        asserts.splice( asserts.end(), type->assertions );
864                        // expand trait instances into their members
865                        for ( DeclarationWithType * assertion : asserts ) {
866                                if ( TraitInstType *traitInst = dynamic_cast< TraitInstType * >( assertion->get_type() ) ) {
867                                        // expand trait instance into all of its members
868                                        expandAssertions( traitInst, back_inserter( type->assertions ) );
869                                        delete traitInst;
870                                } else {
871                                        // pass other assertions through
872                                        type->assertions.push_back( assertion );
873                                } // if
874                        } // for
875                        // apply FixFunction to every assertion to check for invalid void type
876                        for ( DeclarationWithType *& assertion : type->assertions ) {
877                                bool isVoid = fixFunction( assertion );
878                                if ( isVoid ) {
879                                        SemanticError( node, "invalid type void in assertion of function " );
880                                } // if
881                        } // for
882                        // normalizeAssertions( type->assertions );
883                } // for
884        }
885
886        void ForallPointerDecay::previsit( ObjectDecl *object ) {
887                // ensure that operator names only apply to functions or function pointers
888                if ( CodeGen::isOperator( object->name ) && ! dynamic_cast< FunctionType * >( object->type->stripDeclarator() ) ) {
889                        SemanticError( object->location, toCString( "operator ", object->name.c_str(), " is not a function or function pointer." )  );
890                }
891                object->fixUniqueId();
892        }
893
894        void ForallPointerDecay::previsit( FunctionDecl *func ) {
895                func->fixUniqueId();
896        }
897
898        void ForallPointerDecay::previsit( FunctionType * ftype ) {
899                forallFixer( ftype->forall, ftype );
900        }
901
902        void ForallPointerDecay::previsit( StructDecl * aggrDecl ) {
903                forallFixer( aggrDecl->parameters, aggrDecl );
904        }
905
906        void ForallPointerDecay::previsit( UnionDecl * aggrDecl ) {
907                forallFixer( aggrDecl->parameters, aggrDecl );
908        }
909
910        void ReturnChecker::checkFunctionReturns( std::list< Declaration * > & translationUnit ) {
911                PassVisitor<ReturnChecker> checker;
912                acceptAll( translationUnit, checker );
913        }
914
915        void ReturnChecker::previsit( FunctionDecl * functionDecl ) {
916                GuardValue( returnVals );
917                returnVals = functionDecl->get_functionType()->get_returnVals();
918        }
919
920        void ReturnChecker::previsit( ReturnStmt * returnStmt ) {
921                // Previously this also checked for the existence of an expr paired with no return values on
922                // the  function return type. This is incorrect, since you can have an expression attached to
923                // a return statement in a void-returning function in C. The expression is treated as if it
924                // were cast to void.
925                if ( ! returnStmt->get_expr() && returnVals.size() != 0 ) {
926                        SemanticError( returnStmt, "Non-void function returns no values: " );
927                }
928        }
929
930
931        void ReplaceTypedef::replaceTypedef( std::list< Declaration * > &translationUnit ) {
932                PassVisitor<ReplaceTypedef> eliminator;
933                mutateAll( translationUnit, eliminator );
934                if ( eliminator.pass.typedefNames.count( "size_t" ) ) {
935                        // grab and remember declaration of size_t
936                        SizeType = eliminator.pass.typedefNames["size_t"].first->base->clone();
937                } else {
938                        // xxx - missing global typedef for size_t - default to long unsigned int, even though that may be wrong
939                        // eventually should have a warning for this case.
940                        SizeType = new BasicType( Type::Qualifiers(), BasicType::LongUnsignedInt );
941                }
942        }
943
944        void ReplaceTypedef::premutate( QualifiedType * ) {
945                visit_children = false;
946        }
947
948        Type * ReplaceTypedef::postmutate( QualifiedType * qualType ) {
949                // replacing typedefs only makes sense for the 'oldest ancestor' of the qualified type
950                qualType->parent = qualType->parent->acceptMutator( *visitor );
951                return qualType;
952        }
953
954        Type * ReplaceTypedef::postmutate( TypeInstType * typeInst ) {
955                // instances of typedef types will come here. If it is an instance
956                // of a typdef type, link the instance to its actual type.
957                TypedefMap::const_iterator def = typedefNames.find( typeInst->name );
958                if ( def != typedefNames.end() ) {
959                        Type *ret = def->second.first->base->clone();
960                        ret->location = typeInst->location;
961                        ret->get_qualifiers() |= typeInst->get_qualifiers();
962                        // attributes are not carried over from typedef to function parameters/return values
963                        if ( ! inFunctionType ) {
964                                ret->attributes.splice( ret->attributes.end(), typeInst->attributes );
965                        } else {
966                                deleteAll( ret->attributes );
967                                ret->attributes.clear();
968                        }
969                        // place instance parameters on the typedef'd type
970                        if ( ! typeInst->parameters.empty() ) {
971                                ReferenceToType *rtt = dynamic_cast<ReferenceToType*>(ret);
972                                if ( ! rtt ) {
973                                        SemanticError( typeInst->location, "Cannot apply type parameters to base type of " + typeInst->name );
974                                }
975                                rtt->parameters.clear();
976                                cloneAll( typeInst->parameters, rtt->parameters );
977                                mutateAll( rtt->parameters, *visitor );  // recursively fix typedefs on parameters
978                        } // if
979                        delete typeInst;
980                        return ret;
981                } else {
982                        TypeDeclMap::const_iterator base = typedeclNames.find( typeInst->name );
983                        if ( base == typedeclNames.end() ) {
984                                SemanticError( typeInst->location, toString("Use of undefined type ", typeInst->name) );
985                        }
986                        typeInst->set_baseType( base->second );
987                        return typeInst;
988                } // if
989                assert( false );
990        }
991
992        struct VarLenChecker : WithShortCircuiting {
993                void previsit( FunctionType * ) { visit_children = false; }
994                void previsit( ArrayType * at ) {
995                        isVarLen |= at->isVarLen;
996                }
997                bool isVarLen = false;
998        };
999
1000        bool isVariableLength( Type * t ) {
1001                PassVisitor<VarLenChecker> varLenChecker;
1002                maybeAccept( t, varLenChecker );
1003                return varLenChecker.pass.isVarLen;
1004        }
1005
1006        Declaration * ReplaceTypedef::postmutate( TypedefDecl * tyDecl ) {
1007                if ( typedefNames.count( tyDecl->name ) == 1 && typedefNames[ tyDecl->name ].second == scopeLevel ) {
1008                        // typedef to the same name from the same scope
1009                        // must be from the same type
1010
1011                        Type * t1 = tyDecl->base;
1012                        Type * t2 = typedefNames[ tyDecl->name ].first->base;
1013                        if ( ! ResolvExpr::typesCompatible( t1, t2, Indexer() ) ) {
1014                                SemanticError( tyDecl->location, "Cannot redefine typedef: " + tyDecl->name );
1015                        }
1016                        // Cannot redefine VLA typedefs. Note: this is slightly incorrect, because our notion of VLAs
1017                        // at this point in the translator is imprecise. In particular, this will disallow redefining typedefs
1018                        // with arrays whose dimension is an enumerator or a cast of a constant/enumerator. The effort required
1019                        // to fix this corner case likely outweighs the utility of allowing it.
1020                        if ( isVariableLength( t1 ) || isVariableLength( t2 ) ) {
1021                                SemanticError( tyDecl->location, "Cannot redefine typedef: " + tyDecl->name );
1022                        }
1023                } else {
1024                        typedefNames[ tyDecl->name ] = std::make_pair( TypedefDeclPtr( tyDecl ), scopeLevel );
1025                } // if
1026
1027                // When a typedef is a forward declaration:
1028                //    typedef struct screen SCREEN;
1029                // the declaration portion must be retained:
1030                //    struct screen;
1031                // because the expansion of the typedef is:
1032                //    void rtn( SCREEN *p ) => void rtn( struct screen *p )
1033                // hence the type-name "screen" must be defined.
1034                // Note, qualifiers on the typedef are superfluous for the forward declaration.
1035
1036                Type *designatorType = tyDecl->base->stripDeclarator();
1037                if ( StructInstType *aggDecl = dynamic_cast< StructInstType * >( designatorType ) ) {
1038                        declsToAddBefore.push_back( new StructDecl( aggDecl->name, DeclarationNode::Struct, noAttributes, tyDecl->linkage ) );
1039                } else if ( UnionInstType *aggDecl = dynamic_cast< UnionInstType * >( designatorType ) ) {
1040                        declsToAddBefore.push_back( new UnionDecl( aggDecl->name, noAttributes, tyDecl->linkage ) );
1041                } else if ( EnumInstType *enumDecl = dynamic_cast< EnumInstType * >( designatorType ) ) {
1042                        declsToAddBefore.push_back( new EnumDecl( enumDecl->name, noAttributes, tyDecl->linkage ) );
1043                } // if
1044                return tyDecl->clone();
1045        }
1046
1047        void ReplaceTypedef::premutate( TypeDecl * typeDecl ) {
1048                TypedefMap::iterator i = typedefNames.find( typeDecl->name );
1049                if ( i != typedefNames.end() ) {
1050                        typedefNames.erase( i ) ;
1051                } // if
1052
1053                typedeclNames.insert( typeDecl->name, typeDecl );
1054        }
1055
1056        void ReplaceTypedef::premutate( FunctionDecl * ) {
1057                GuardScope( typedefNames );
1058                GuardScope( typedeclNames );
1059        }
1060
1061        void ReplaceTypedef::premutate( ObjectDecl * ) {
1062                GuardScope( typedefNames );
1063                GuardScope( typedeclNames );
1064        }
1065
1066        DeclarationWithType * ReplaceTypedef::postmutate( ObjectDecl * objDecl ) {
1067                if ( FunctionType *funtype = dynamic_cast<FunctionType *>( objDecl->type ) ) { // function type?
1068                        // replace the current object declaration with a function declaration
1069                        FunctionDecl * newDecl = new FunctionDecl( objDecl->name, objDecl->get_storageClasses(), objDecl->linkage, funtype, 0, objDecl->attributes, objDecl->get_funcSpec() );
1070                        objDecl->attributes.clear();
1071                        objDecl->set_type( nullptr );
1072                        delete objDecl;
1073                        return newDecl;
1074                } // if
1075                return objDecl;
1076        }
1077
1078        void ReplaceTypedef::premutate( CastExpr * ) {
1079                GuardScope( typedefNames );
1080                GuardScope( typedeclNames );
1081        }
1082
1083        void ReplaceTypedef::premutate( CompoundStmt * ) {
1084                GuardScope( typedefNames );
1085                GuardScope( typedeclNames );
1086                scopeLevel += 1;
1087                GuardAction( [this](){ scopeLevel -= 1; } );
1088        }
1089
1090        template<typename AggDecl>
1091        void ReplaceTypedef::addImplicitTypedef( AggDecl * aggDecl ) {
1092                if ( typedefNames.count( aggDecl->get_name() ) == 0 ) {
1093                        Type *type = nullptr;
1094                        if ( StructDecl * newDeclStructDecl = dynamic_cast< StructDecl * >( aggDecl ) ) {
1095                                type = new StructInstType( Type::Qualifiers(), newDeclStructDecl->get_name() );
1096                        } else if ( UnionDecl * newDeclUnionDecl = dynamic_cast< UnionDecl * >( aggDecl ) ) {
1097                                type = new UnionInstType( Type::Qualifiers(), newDeclUnionDecl->get_name() );
1098                        } else if ( EnumDecl * newDeclEnumDecl = dynamic_cast< EnumDecl * >( aggDecl )  ) {
1099                                type = new EnumInstType( Type::Qualifiers(), newDeclEnumDecl->get_name() );
1100                        } // if
1101                        TypedefDeclPtr tyDecl( new TypedefDecl( aggDecl->get_name(), aggDecl->location, Type::StorageClasses(), type, aggDecl->get_linkage() ) );
1102                        typedefNames[ aggDecl->get_name() ] = std::make_pair( std::move( tyDecl ), scopeLevel );
1103                        // add the implicit typedef to the AST
1104                        declsToAddBefore.push_back( new TypedefDecl( aggDecl->get_name(), aggDecl->location, Type::StorageClasses(), type->clone(), aggDecl->get_linkage() ) );
1105                } // if
1106        }
1107
1108        template< typename AggDecl >
1109        void ReplaceTypedef::handleAggregate( AggDecl * aggr ) {
1110                SemanticErrorException errors;
1111
1112                ValueGuard< std::list<Declaration * > > oldBeforeDecls( declsToAddBefore );
1113                ValueGuard< std::list<Declaration * > > oldAfterDecls ( declsToAddAfter  );
1114                declsToAddBefore.clear();
1115                declsToAddAfter.clear();
1116
1117                GuardScope( typedefNames );
1118                GuardScope( typedeclNames );
1119                mutateAll( aggr->parameters, *visitor );
1120
1121                // unroll mutateAll for aggr->members so that implicit typedefs for nested types are added to the aggregate body.
1122                for ( std::list< Declaration * >::iterator i = aggr->members.begin(); i != aggr->members.end(); ++i ) {
1123                        if ( !declsToAddAfter.empty() ) { aggr->members.splice( i, declsToAddAfter ); }
1124
1125                        try {
1126                                *i = maybeMutate( *i, *visitor );
1127                        } catch ( SemanticErrorException &e ) {
1128                                errors.append( e );
1129                        }
1130
1131                        if ( !declsToAddBefore.empty() ) { aggr->members.splice( i, declsToAddBefore ); }
1132                }
1133
1134                if ( !declsToAddAfter.empty() ) { aggr->members.splice( aggr->members.end(), declsToAddAfter ); }
1135                if ( !errors.isEmpty() ) { throw errors; }
1136        }
1137
1138        void ReplaceTypedef::premutate( StructDecl * structDecl ) {
1139                visit_children = false;
1140                addImplicitTypedef( structDecl );
1141                handleAggregate( structDecl );
1142        }
1143
1144        void ReplaceTypedef::premutate( UnionDecl * unionDecl ) {
1145                visit_children = false;
1146                addImplicitTypedef( unionDecl );
1147                handleAggregate( unionDecl );
1148        }
1149
1150        void ReplaceTypedef::premutate( EnumDecl * enumDecl ) {
1151                addImplicitTypedef( enumDecl );
1152        }
1153
1154        void ReplaceTypedef::premutate( FunctionType * ) {
1155                GuardValue( inFunctionType );
1156                inFunctionType = true;
1157        }
1158
1159        void ReplaceTypedef::premutate( TraitDecl * ) {
1160                GuardScope( typedefNames );
1161                GuardScope( typedeclNames);
1162        }
1163
1164        void VerifyCtorDtorAssign::verify( std::list< Declaration * > & translationUnit ) {
1165                PassVisitor<VerifyCtorDtorAssign> verifier;
1166                acceptAll( translationUnit, verifier );
1167        }
1168
1169        void VerifyCtorDtorAssign::previsit( FunctionDecl * funcDecl ) {
1170                FunctionType * funcType = funcDecl->get_functionType();
1171                std::list< DeclarationWithType * > &returnVals = funcType->get_returnVals();
1172                std::list< DeclarationWithType * > &params = funcType->get_parameters();
1173
1174                if ( CodeGen::isCtorDtorAssign( funcDecl->get_name() ) ) { // TODO: also check /=, etc.
1175                        if ( params.size() == 0 ) {
1176                                SemanticError( funcDecl, "Constructors, destructors, and assignment functions require at least one parameter " );
1177                        }
1178                        ReferenceType * refType = dynamic_cast< ReferenceType * >( params.front()->get_type() );
1179                        if ( ! refType ) {
1180                                SemanticError( funcDecl, "First parameter of a constructor, destructor, or assignment function must be a reference " );
1181                        }
1182                        if ( CodeGen::isCtorDtor( funcDecl->get_name() ) && returnVals.size() != 0 ) {
1183                                SemanticError( funcDecl, "Constructors and destructors cannot have explicit return values " );
1184                        }
1185                }
1186        }
1187
1188        template< typename Aggr >
1189        void validateGeneric( Aggr * inst ) {
1190                std::list< TypeDecl * > * params = inst->get_baseParameters();
1191                if ( params ) {
1192                        std::list< Expression * > & args = inst->get_parameters();
1193
1194                        // insert defaults arguments when a type argument is missing (currently only supports missing arguments at the end of the list).
1195                        // A substitution is used to ensure that defaults are replaced correctly, e.g.,
1196                        //   forall(otype T, otype alloc = heap_allocator(T)) struct vector;
1197                        //   vector(int) v;
1198                        // after insertion of default values becomes
1199                        //   vector(int, heap_allocator(T))
1200                        // and the substitution is built with T=int so that after substitution, the result is
1201                        //   vector(int, heap_allocator(int))
1202                        TypeSubstitution sub;
1203                        auto paramIter = params->begin();
1204                        for ( size_t i = 0; paramIter != params->end(); ++paramIter, ++i ) {
1205                                if ( i < args.size() ) {
1206                                        TypeExpr * expr = strict_dynamic_cast< TypeExpr * >( *std::next( args.begin(), i ) );
1207                                        sub.add( (*paramIter)->get_name(), expr->get_type()->clone() );
1208                                } else if ( i == args.size() ) {
1209                                        Type * defaultType = (*paramIter)->get_init();
1210                                        if ( defaultType ) {
1211                                                args.push_back( new TypeExpr( defaultType->clone() ) );
1212                                                sub.add( (*paramIter)->get_name(), defaultType->clone() );
1213                                        }
1214                                }
1215                        }
1216
1217                        sub.apply( inst );
1218                        if ( args.size() < params->size() ) SemanticError( inst, "Too few type arguments in generic type " );
1219                        if ( args.size() > params->size() ) SemanticError( inst, "Too many type arguments in generic type " );
1220                }
1221        }
1222
1223        void ValidateGenericParameters::previsit( StructInstType * inst ) {
1224                validateGeneric( inst );
1225        }
1226
1227        void ValidateGenericParameters::previsit( UnionInstType * inst ) {
1228                validateGeneric( inst );
1229        }
1230
1231        void CompoundLiteral::premutate( ObjectDecl *objectDecl ) {
1232                storageClasses = objectDecl->get_storageClasses();
1233        }
1234
1235        Expression *CompoundLiteral::postmutate( CompoundLiteralExpr *compLitExpr ) {
1236                // transform [storage_class] ... (struct S){ 3, ... };
1237                // into [storage_class] struct S temp =  { 3, ... };
1238                static UniqueName indexName( "_compLit" );
1239
1240                ObjectDecl *tempvar = new ObjectDecl( indexName.newName(), storageClasses, LinkageSpec::C, nullptr, compLitExpr->get_result(), compLitExpr->get_initializer() );
1241                compLitExpr->set_result( nullptr );
1242                compLitExpr->set_initializer( nullptr );
1243                delete compLitExpr;
1244                declsToAddBefore.push_back( tempvar );                                  // add modified temporary to current block
1245                return new VariableExpr( tempvar );
1246        }
1247
1248        void ReturnTypeFixer::fix( std::list< Declaration * > &translationUnit ) {
1249                PassVisitor<ReturnTypeFixer> fixer;
1250                acceptAll( translationUnit, fixer );
1251        }
1252
1253        void ReturnTypeFixer::postvisit( FunctionDecl * functionDecl ) {
1254                FunctionType * ftype = functionDecl->get_functionType();
1255                std::list< DeclarationWithType * > & retVals = ftype->get_returnVals();
1256                assertf( retVals.size() == 0 || retVals.size() == 1, "Function %s has too many return values: %zu", functionDecl->get_name().c_str(), retVals.size() );
1257                if ( retVals.size() == 1 ) {
1258                        // ensure all function return values have a name - use the name of the function to disambiguate (this also provides a nice bit of help for debugging).
1259                        // ensure other return values have a name.
1260                        DeclarationWithType * ret = retVals.front();
1261                        if ( ret->get_name() == "" ) {
1262                                ret->set_name( toString( "_retval_", CodeGen::genName( functionDecl ) ) );
1263                        }
1264                        ret->get_attributes().push_back( new Attribute( "unused" ) );
1265                }
1266        }
1267
1268        void ReturnTypeFixer::postvisit( FunctionType * ftype ) {
1269                // xxx - need to handle named return values - this information needs to be saved somehow
1270                // so that resolution has access to the names.
1271                // Note that this pass needs to happen early so that other passes which look for tuple types
1272                // find them in all of the right places, including function return types.
1273                std::list< DeclarationWithType * > & retVals = ftype->get_returnVals();
1274                if ( retVals.size() > 1 ) {
1275                        // generate a single return parameter which is the tuple of all of the return values
1276                        TupleType * tupleType = strict_dynamic_cast< TupleType * >( ResolvExpr::extractResultType( ftype ) );
1277                        // ensure return value is not destructed by explicitly creating an empty ListInit node wherein maybeConstruct is false.
1278                        ObjectDecl * newRet = new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, 0, tupleType, new ListInit( std::list<Initializer*>(), noDesignators, false ) );
1279                        deleteAll( retVals );
1280                        retVals.clear();
1281                        retVals.push_back( newRet );
1282                }
1283        }
1284
1285        void FixObjectType::fix( std::list< Declaration * > & translationUnit ) {
1286                PassVisitor<FixObjectType> fixer;
1287                acceptAll( translationUnit, fixer );
1288        }
1289
1290        void FixObjectType::previsit( ObjectDecl * objDecl ) {
1291                Type *new_type = ResolvExpr::resolveTypeof( objDecl->get_type(), indexer );
1292                new_type->get_qualifiers() -= Type::Lvalue; // even if typeof is lvalue, variable can never have lvalue-qualified type
1293                objDecl->set_type( new_type );
1294        }
1295
1296        void FixObjectType::previsit( FunctionDecl * funcDecl ) {
1297                Type *new_type = ResolvExpr::resolveTypeof( funcDecl->type, indexer );
1298                new_type->get_qualifiers() -= Type::Lvalue; // even if typeof is lvalue, variable can never have lvalue-qualified type
1299                funcDecl->set_type( new_type );
1300        }
1301
1302        void FixObjectType::previsit( TypeDecl *typeDecl ) {
1303                if ( typeDecl->get_base() ) {
1304                        Type *new_type = ResolvExpr::resolveTypeof( typeDecl->get_base(), indexer );
1305                        new_type->get_qualifiers() -= Type::Lvalue; // even if typeof is lvalue, variable can never have lvalue-qualified type
1306                        typeDecl->set_base( new_type );
1307                } // if
1308        }
1309
1310        void ArrayLength::computeLength( std::list< Declaration * > & translationUnit ) {
1311                PassVisitor<ArrayLength> len;
1312                acceptAll( translationUnit, len );
1313        }
1314
1315        void ArrayLength::previsit( ObjectDecl * objDecl ) {
1316                if ( ArrayType * at = dynamic_cast< ArrayType * >( objDecl->type ) ) {
1317                        if ( at->dimension ) return;
1318                        if ( ListInit * init = dynamic_cast< ListInit * >( objDecl->init ) ) {
1319                                at->dimension = new ConstantExpr( Constant::from_ulong( init->initializers.size() ) );
1320                        }
1321                }
1322        }
1323
1324        void ArrayLength::previsit( ArrayType * type ) {
1325                if ( type->dimension ) {
1326                        // need to resolve array dimensions early so that constructor code can correctly determine
1327                        // if a type is a VLA (and hence whether its elements need to be constructed)
1328                        ResolvExpr::findSingleExpression( type->dimension, SymTab::SizeType->clone(), indexer );
1329
1330                        // must re-evaluate whether a type is a VLA, now that more information is available
1331                        // (e.g. the dimension may have been an enumerator, which was unknown prior to this step)
1332                        type->isVarLen = ! InitTweak::isConstExpr( type->dimension );
1333                }
1334        }
1335
1336        struct LabelFinder {
1337                std::set< Label > & labels;
1338                LabelFinder( std::set< Label > & labels ) : labels( labels ) {}
1339                void previsit( Statement * stmt ) {
1340                        for ( Label & l : stmt->labels ) {
1341                                labels.insert( l );
1342                        }
1343                }
1344        };
1345
1346        void LabelAddressFixer::premutate( FunctionDecl * funcDecl ) {
1347                GuardValue( labels );
1348                PassVisitor<LabelFinder> finder( labels );
1349                funcDecl->accept( finder );
1350        }
1351
1352        Expression * LabelAddressFixer::postmutate( AddressExpr * addrExpr ) {
1353                // convert &&label into label address
1354                if ( AddressExpr * inner = dynamic_cast< AddressExpr * >( addrExpr->arg ) ) {
1355                        if ( NameExpr * nameExpr = dynamic_cast< NameExpr * >( inner->arg ) ) {
1356                                if ( labels.count( nameExpr->name ) ) {
1357                                        Label name = nameExpr->name;
1358                                        delete addrExpr;
1359                                        return new LabelAddressExpr( name );
1360                                }
1361                        }
1362                }
1363                return addrExpr;
1364        }
1365} // namespace SymTab
1366
1367// Local Variables: //
1368// tab-width: 4 //
1369// mode: c++ //
1370// compile-command: "make install" //
1371// End: //
Note: See TracBrowser for help on using the repository browser.