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

aaron-thesisarm-ehcleanup-dtorsdeferred_resnenumforall-pointer-decayjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-exprno_listpersistent-indexerpthread-emulation
Last change on this file since 2b79a70 was 2b79a70, checked in by Rob Schluntz <rschlunt@…>, 4 years ago

Resolve typeof earlier so that constructors are chosen appropriately [fixes #102]

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