source: src/SymTab/Validate.cc @ 80eefcb

no_list
Last change on this file since 80eefcb was 80eefcb, checked in by Thierry Delisle <tdelisle@…>, 3 years ago

Forall list now uses vector

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