source: src/SymTab/Validate.cc @ c1ed2ee

arm-ehjacob/cs343-translationjenkins-sandboxnew-astnew-ast-unique-expr
Last change on this file since c1ed2ee was c1ed2ee, checked in by Aaron Moss <a3moss@…>, 3 years ago

Continued resolver porting

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