source: src/SymTab/Validate.cc @ a9a259c

aaron-thesisarm-ehcleanup-dtorsctordeferred_resndemanglerenumforall-pointer-decaygc_noraiijacob/cs343-translationjenkins-sandboxmemorynew-astnew-ast-unique-exprnew-envno_listpersistent-indexerpthread-emulationqualifiedEnumresolv-newwith_gc
Last change on this file since a9a259c was a9a259c, checked in by Rob Schluntz <rschlunt@…>, 7 years ago

autogenerate union ctor/dtors, autogenerate struct copy ctor, temporarily allow explicit calls to autogenerated ctors, add copy ctor to type constraints

  • Property mode set to 100644
File size: 51.1 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 : Rob Schluntz
12// Last Modified On : Mon Feb 22 12:26:37 2016
13// Update Count     : 297
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; neither do tuple types.  A function
26//   taking no arguments has no argument types, and tuples are flattened.
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 <list>
41#include <iterator>
42#include "Validate.h"
43#include "SynTree/Visitor.h"
44#include "SynTree/Mutator.h"
45#include "SynTree/Type.h"
46#include "SynTree/Statement.h"
47#include "SynTree/TypeSubstitution.h"
48#include "Indexer.h"
49#include "FixFunction.h"
50// #include "ImplementationType.h"
51#include "Common/utility.h"
52#include "Common/UniqueName.h"
53#include "AddVisit.h"
54#include "MakeLibCfa.h"
55#include "TypeEquality.h"
56#include "ResolvExpr/typeops.h"
57
58#define debugPrint( x ) if ( doDebug ) { std::cout << x; }
59
60namespace SymTab {
61        class HoistStruct : public Visitor {
62          public:
63                /// Flattens nested struct types
64                static void hoistStruct( std::list< Declaration * > &translationUnit );
65
66                std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
67
68                virtual void visit( StructDecl *aggregateDecl );
69                virtual void visit( UnionDecl *aggregateDecl );
70
71                virtual void visit( CompoundStmt *compoundStmt );
72                virtual void visit( IfStmt *ifStmt );
73                virtual void visit( WhileStmt *whileStmt );
74                virtual void visit( ForStmt *forStmt );
75                virtual void visit( SwitchStmt *switchStmt );
76                virtual void visit( ChooseStmt *chooseStmt );
77                virtual void visit( CaseStmt *caseStmt );
78                virtual void visit( CatchStmt *catchStmt );
79          private:
80                HoistStruct();
81
82                template< typename AggDecl > void handleAggregate( AggDecl *aggregateDecl );
83
84                std::list< Declaration * > declsToAdd;
85                bool inStruct;
86        };
87
88        /// Replaces enum types by int, and function or array types in function parameter and return lists by appropriate pointers.
89        class Pass1 : public Visitor {
90                typedef Visitor Parent;
91                virtual void visit( EnumDecl *aggregateDecl );
92                virtual void visit( FunctionType *func );
93        };
94
95        /// Associates forward declarations of aggregates with their definitions
96        class Pass2 : public Indexer {
97                typedef Indexer Parent;
98          public:
99                Pass2( bool doDebug, const Indexer *indexer );
100          private:
101                virtual void visit( StructInstType *structInst );
102                virtual void visit( UnionInstType *unionInst );
103                virtual void visit( ContextInstType *contextInst );
104                virtual void visit( StructDecl *structDecl );
105                virtual void visit( UnionDecl *unionDecl );
106                virtual void visit( TypeInstType *typeInst );
107
108                const Indexer *indexer;
109
110                typedef std::map< std::string, std::list< StructInstType * > > ForwardStructsType;
111                typedef std::map< std::string, std::list< UnionInstType * > > ForwardUnionsType;
112                ForwardStructsType forwardStructs;
113                ForwardUnionsType forwardUnions;
114        };
115
116        /// Replaces array and function types in forall lists by appropriate pointer type
117        class Pass3 : public Indexer {
118                typedef Indexer Parent;
119          public:
120                Pass3( const Indexer *indexer );
121          private:
122                virtual void visit( ObjectDecl *object );
123                virtual void visit( FunctionDecl *func );
124
125                const Indexer *indexer;
126        };
127
128        class AutogenerateRoutines : public Visitor {
129          public:
130                /// Generates assignment operators for aggregate types as required
131                static void autogenerateRoutines( std::list< Declaration * > &translationUnit );
132
133                std::list< Declaration * > &get_declsToAdd() { return declsToAdd; }
134
135                virtual void visit( EnumDecl *enumDecl );
136                virtual void visit( StructDecl *structDecl );
137                virtual void visit( UnionDecl *structDecl );
138                virtual void visit( TypeDecl *typeDecl );
139                virtual void visit( ContextDecl *ctxDecl );
140                virtual void visit( FunctionDecl *functionDecl );
141
142                virtual void visit( FunctionType *ftype );
143                virtual void visit( PointerType *ftype );
144
145                virtual void visit( CompoundStmt *compoundStmt );
146                virtual void visit( IfStmt *ifStmt );
147                virtual void visit( WhileStmt *whileStmt );
148                virtual void visit( ForStmt *forStmt );
149                virtual void visit( SwitchStmt *switchStmt );
150                virtual void visit( ChooseStmt *chooseStmt );
151                virtual void visit( CaseStmt *caseStmt );
152                virtual void visit( CatchStmt *catchStmt );
153
154                AutogenerateRoutines() : functionNesting( 0 ) {}
155          private:
156                template< typename StmtClass > void visitStatement( StmtClass *stmt );
157
158                std::list< Declaration * > declsToAdd;
159                std::set< std::string > structsDone;
160                unsigned int functionNesting;                   // current level of nested functions
161        };
162
163        class ReturnChecker : public Visitor {
164          public:
165                /// Checks that return statements return nothing if their return type is void
166                /// and return something if the return type is non-void.
167                static void checkFunctionReturns( std::list< Declaration * > & translationUnit );
168
169          private:
170                virtual void visit( FunctionDecl * functionDecl );
171
172                virtual void visit( ReturnStmt * returnStmt );
173
174                std::list< DeclarationWithType * > returnVals;
175        };
176
177        class EliminateTypedef : public Mutator {
178          public:
179                EliminateTypedef() : scopeLevel( 0 ) {}
180                /// Replaces typedefs by forward declarations
181                static void eliminateTypedef( std::list< Declaration * > &translationUnit );
182          private:
183                virtual Declaration *mutate( TypedefDecl *typeDecl );
184                virtual TypeDecl *mutate( TypeDecl *typeDecl );
185                virtual DeclarationWithType *mutate( FunctionDecl *funcDecl );
186                virtual DeclarationWithType *mutate( ObjectDecl *objDecl );
187                virtual CompoundStmt *mutate( CompoundStmt *compoundStmt );
188                virtual Type *mutate( TypeInstType *aggregateUseType );
189                virtual Expression *mutate( CastExpr *castExpr );
190
191                virtual Declaration *mutate( StructDecl * structDecl );
192                virtual Declaration *mutate( UnionDecl * unionDecl );
193                virtual Declaration *mutate( EnumDecl * enumDecl );
194                virtual Declaration *mutate( ContextDecl * contextDecl );
195
196                template<typename AggDecl>
197                AggDecl *handleAggregate( AggDecl * aggDecl );
198
199                typedef std::map< std::string, std::pair< TypedefDecl *, int > > TypedefMap;
200                TypedefMap typedefNames;
201                int scopeLevel;
202        };
203
204        class VerifyCtorDtor : public Visitor {
205        public:
206                /// ensure that constructors and destructors have at least one
207                /// parameter, the first of which must be a pointer, and no
208                /// return values.
209                static void verify( std::list< Declaration * > &translationUnit );
210
211                // VerifyCtorDtor() {}
212
213                virtual void visit( FunctionDecl *funcDecl );
214        private:
215        };
216
217        void validate( std::list< Declaration * > &translationUnit, bool doDebug ) {
218                Pass1 pass1;
219                Pass2 pass2( doDebug, 0 );
220                Pass3 pass3( 0 );
221                EliminateTypedef::eliminateTypedef( translationUnit );
222                HoistStruct::hoistStruct( translationUnit );
223                acceptAll( translationUnit, pass1 );
224                acceptAll( translationUnit, pass2 );
225                ReturnChecker::checkFunctionReturns( translationUnit );
226                AutogenerateRoutines::autogenerateRoutines( translationUnit );
227                acceptAll( translationUnit, pass3 );
228                VerifyCtorDtor::verify( translationUnit );
229        }
230
231        void validateType( Type *type, const Indexer *indexer ) {
232                Pass1 pass1;
233                Pass2 pass2( false, indexer );
234                Pass3 pass3( indexer );
235                type->accept( pass1 );
236                type->accept( pass2 );
237                type->accept( pass3 );
238        }
239
240        template< typename Visitor >
241        void acceptAndAdd( std::list< Declaration * > &translationUnit, Visitor &visitor, bool addBefore ) {
242                std::list< Declaration * >::iterator i = translationUnit.begin();
243                while ( i != translationUnit.end() ) {
244                        (*i)->accept( visitor );
245                        std::list< Declaration * >::iterator next = i;
246                        next++;
247                        if ( ! visitor.get_declsToAdd().empty() ) {
248                                translationUnit.splice( addBefore ? i : next, visitor.get_declsToAdd() );
249                        } // if
250                        i = next;
251                } // while
252        }
253
254        void HoistStruct::hoistStruct( std::list< Declaration * > &translationUnit ) {
255                HoistStruct hoister;
256                acceptAndAdd( translationUnit, hoister, true );
257        }
258
259        HoistStruct::HoistStruct() : inStruct( false ) {
260        }
261
262        void filter( std::list< Declaration * > &declList, bool (*pred)( Declaration * ), bool doDelete ) {
263                std::list< Declaration * >::iterator i = declList.begin();
264                while ( i != declList.end() ) {
265                        std::list< Declaration * >::iterator next = i;
266                        ++next;
267                        if ( pred( *i ) ) {
268                                if ( doDelete ) {
269                                        delete *i;
270                                } // if
271                                declList.erase( i );
272                        } // if
273                        i = next;
274                } // while
275        }
276
277        bool isStructOrUnion( Declaration *decl ) {
278                return dynamic_cast< StructDecl * >( decl ) || dynamic_cast< UnionDecl * >( decl );
279        }
280
281        template< typename AggDecl >
282        void HoistStruct::handleAggregate( AggDecl *aggregateDecl ) {
283                if ( inStruct ) {
284                        // Add elements in stack order corresponding to nesting structure.
285                        declsToAdd.push_front( aggregateDecl );
286                        Visitor::visit( aggregateDecl );
287                } else {
288                        inStruct = true;
289                        Visitor::visit( aggregateDecl );
290                        inStruct = false;
291                } // if
292                // Always remove the hoisted aggregate from the inner structure.
293                filter( aggregateDecl->get_members(), isStructOrUnion, false );
294        }
295
296        void HoistStruct::visit( StructDecl *aggregateDecl ) {
297                handleAggregate( aggregateDecl );
298        }
299
300        void HoistStruct::visit( UnionDecl *aggregateDecl ) {
301                handleAggregate( aggregateDecl );
302        }
303
304        void HoistStruct::visit( CompoundStmt *compoundStmt ) {
305                addVisit( compoundStmt, *this );
306        }
307
308        void HoistStruct::visit( IfStmt *ifStmt ) {
309                addVisit( ifStmt, *this );
310        }
311
312        void HoistStruct::visit( WhileStmt *whileStmt ) {
313                addVisit( whileStmt, *this );
314        }
315
316        void HoistStruct::visit( ForStmt *forStmt ) {
317                addVisit( forStmt, *this );
318        }
319
320        void HoistStruct::visit( SwitchStmt *switchStmt ) {
321                addVisit( switchStmt, *this );
322        }
323
324        void HoistStruct::visit( ChooseStmt *switchStmt ) {
325                addVisit( switchStmt, *this );
326        }
327
328        void HoistStruct::visit( CaseStmt *caseStmt ) {
329                addVisit( caseStmt, *this );
330        }
331
332        void HoistStruct::visit( CatchStmt *cathStmt ) {
333                addVisit( cathStmt, *this );
334        }
335
336        void Pass1::visit( EnumDecl *enumDecl ) {
337                // Set the type of each member of the enumeration to be EnumConstant
338
339                for ( std::list< Declaration * >::iterator i = enumDecl->get_members().begin(); i != enumDecl->get_members().end(); ++i ) {
340                        ObjectDecl * obj = dynamic_cast< ObjectDecl * >( *i );
341                        assert( obj );
342                        // obj->set_type( new EnumInstType( Type::Qualifiers( true, false, false, false, false, false ), enumDecl->get_name() ) );
343                        BasicType * enumType = new BasicType( Type::Qualifiers(), BasicType::SignedInt );
344                        obj->set_type( enumType ) ;
345                } // for
346                Parent::visit( enumDecl );
347        }
348
349        namespace {
350                template< typename DWTIterator >
351                void fixFunctionList( DWTIterator begin, DWTIterator end, FunctionType *func ) {
352                        // the only case in which "void" is valid is where it is the only one in the list; then it should be removed
353                        // entirely other fix ups are handled by the FixFunction class
354                        if ( begin == end ) return;
355                        FixFunction fixer;
356                        DWTIterator i = begin;
357                        *i = (*i )->acceptMutator( fixer );
358                        if ( fixer.get_isVoid() ) {
359                                DWTIterator j = i;
360                                ++i;
361                                func->get_parameters().erase( j );
362                                if ( i != end ) {
363                                        throw SemanticError( "invalid type void in function type ", func );
364                                } // if
365                        } else {
366                                ++i;
367                                for ( ; i != end; ++i ) {
368                                        FixFunction fixer;
369                                        *i = (*i )->acceptMutator( fixer );
370                                        if ( fixer.get_isVoid() ) {
371                                                throw SemanticError( "invalid type void in function type ", func );
372                                        } // if
373                                } // for
374                        } // if
375                }
376        }
377
378        void Pass1::visit( FunctionType *func ) {
379                // Fix up parameters and return types
380                fixFunctionList( func->get_parameters().begin(), func->get_parameters().end(), func );
381                fixFunctionList( func->get_returnVals().begin(), func->get_returnVals().end(), func );
382                Visitor::visit( func );
383        }
384
385        Pass2::Pass2( bool doDebug, const Indexer *other_indexer ) : Indexer( doDebug ) {
386                if ( other_indexer ) {
387                        indexer = other_indexer;
388                } else {
389                        indexer = this;
390                } // if
391        }
392
393        void Pass2::visit( StructInstType *structInst ) {
394                Parent::visit( structInst );
395                StructDecl *st = indexer->lookupStruct( structInst->get_name() );
396                // it's not a semantic error if the struct is not found, just an implicit forward declaration
397                if ( st ) {
398                        //assert( ! structInst->get_baseStruct() || structInst->get_baseStruct()->get_members().empty() || ! st->get_members().empty() );
399                        structInst->set_baseStruct( st );
400                } // if
401                if ( ! st || st->get_members().empty() ) {
402                        // use of forward declaration
403                        forwardStructs[ structInst->get_name() ].push_back( structInst );
404                } // if
405        }
406
407        void Pass2::visit( UnionInstType *unionInst ) {
408                Parent::visit( unionInst );
409                UnionDecl *un = indexer->lookupUnion( unionInst->get_name() );
410                // it's not a semantic error if the union is not found, just an implicit forward declaration
411                if ( un ) {
412                        unionInst->set_baseUnion( un );
413                } // if
414                if ( ! un || un->get_members().empty() ) {
415                        // use of forward declaration
416                        forwardUnions[ unionInst->get_name() ].push_back( unionInst );
417                } // if
418        }
419
420        void Pass2::visit( ContextInstType *contextInst ) {
421                Parent::visit( contextInst );
422                ContextDecl *ctx = indexer->lookupContext( contextInst->get_name() );
423                if ( ! ctx ) {
424                        throw SemanticError( "use of undeclared context " + contextInst->get_name() );
425                } // if
426                for ( std::list< TypeDecl * >::const_iterator i = ctx->get_parameters().begin(); i != ctx->get_parameters().end(); ++i ) {
427                        for ( std::list< DeclarationWithType * >::const_iterator assert = (*i )->get_assertions().begin(); assert != (*i )->get_assertions().end(); ++assert ) {
428                                if ( ContextInstType *otherCtx = dynamic_cast< ContextInstType * >(*assert ) ) {
429                                        cloneAll( otherCtx->get_members(), contextInst->get_members() );
430                                } else {
431                                        contextInst->get_members().push_back( (*assert )->clone() );
432                                } // if
433                        } // for
434                } // for
435
436                if ( ctx->get_parameters().size() != contextInst->get_parameters().size() ) {
437                        throw SemanticError( "incorrect number of context parameters: ", contextInst );
438                } // if
439
440                applySubstitution( ctx->get_parameters().begin(), ctx->get_parameters().end(), contextInst->get_parameters().begin(), ctx->get_members().begin(), ctx->get_members().end(), back_inserter( contextInst->get_members() ) );
441        }
442
443        void Pass2::visit( StructDecl *structDecl ) {
444                if ( ! structDecl->get_members().empty() ) {
445                        ForwardStructsType::iterator fwds = forwardStructs.find( structDecl->get_name() );
446                        if ( fwds != forwardStructs.end() ) {
447                                for ( std::list< StructInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
448                                        (*inst )->set_baseStruct( structDecl );
449                                } // for
450                                forwardStructs.erase( fwds );
451                        } // if
452                } // if
453                Indexer::visit( structDecl );
454        }
455
456        void Pass2::visit( UnionDecl *unionDecl ) {
457                if ( ! unionDecl->get_members().empty() ) {
458                        ForwardUnionsType::iterator fwds = forwardUnions.find( unionDecl->get_name() );
459                        if ( fwds != forwardUnions.end() ) {
460                                for ( std::list< UnionInstType * >::iterator inst = fwds->second.begin(); inst != fwds->second.end(); ++inst ) {
461                                        (*inst )->set_baseUnion( unionDecl );
462                                } // for
463                                forwardUnions.erase( fwds );
464                        } // if
465                } // if
466                Indexer::visit( unionDecl );
467        }
468
469        void Pass2::visit( TypeInstType *typeInst ) {
470                if ( NamedTypeDecl *namedTypeDecl = lookupType( typeInst->get_name() ) ) {
471                        if ( TypeDecl *typeDecl = dynamic_cast< TypeDecl * >( namedTypeDecl ) ) {
472                                typeInst->set_isFtype( typeDecl->get_kind() == TypeDecl::Ftype );
473                        } // if
474                } // if
475        }
476
477        Pass3::Pass3( const Indexer *other_indexer ) :  Indexer( false ) {
478                if ( other_indexer ) {
479                        indexer = other_indexer;
480                } else {
481                        indexer = this;
482                } // if
483        }
484
485        /// Fix up assertions
486        void forallFixer( Type *func ) {
487                for ( std::list< TypeDecl * >::iterator type = func->get_forall().begin(); type != func->get_forall().end(); ++type ) {
488                        std::list< DeclarationWithType * > toBeDone, nextRound;
489                        toBeDone.splice( toBeDone.end(), (*type )->get_assertions() );
490                        while ( ! toBeDone.empty() ) {
491                                for ( std::list< DeclarationWithType * >::iterator assertion = toBeDone.begin(); assertion != toBeDone.end(); ++assertion ) {
492                                        if ( ContextInstType *ctx = dynamic_cast< ContextInstType * >( (*assertion )->get_type() ) ) {
493                                                for ( std::list< Declaration * >::const_iterator i = ctx->get_members().begin(); i != ctx->get_members().end(); ++i ) {
494                                                        DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *i );
495                                                        assert( dwt );
496                                                        nextRound.push_back( dwt->clone() );
497                                                }
498                                                delete ctx;
499                                        } else {
500                                                FixFunction fixer;
501                                                *assertion = (*assertion )->acceptMutator( fixer );
502                                                if ( fixer.get_isVoid() ) {
503                                                        throw SemanticError( "invalid type void in assertion of function ", func );
504                                                }
505                                                (*type )->get_assertions().push_back( *assertion );
506                                        } // if
507                                } // for
508                                toBeDone.clear();
509                                toBeDone.splice( toBeDone.end(), nextRound );
510                        } // while
511                } // for
512        }
513
514        void Pass3::visit( ObjectDecl *object ) {
515                forallFixer( object->get_type() );
516                if ( PointerType *pointer = dynamic_cast< PointerType * >( object->get_type() ) ) {
517                        forallFixer( pointer->get_base() );
518                } // if
519                Parent::visit( object );
520                object->fixUniqueId();
521        }
522
523        void Pass3::visit( FunctionDecl *func ) {
524                forallFixer( func->get_type() );
525                Parent::visit( func );
526                func->fixUniqueId();
527        }
528
529        static const std::list< std::string > noLabels;
530
531        void AutogenerateRoutines::autogenerateRoutines( std::list< Declaration * > &translationUnit ) {
532                AutogenerateRoutines visitor;
533                acceptAndAdd( translationUnit, visitor, false );
534        }
535
536        template< typename OutputIterator >
537        void makeScalarFunction( ObjectDecl *srcParam, ObjectDecl *dstParam, DeclarationWithType *member, std::string fname, OutputIterator out ) {
538                ObjectDecl *obj = dynamic_cast<ObjectDecl *>( member );
539                // unnamed bit fields are not copied as they cannot be accessed
540                if ( obj != NULL && obj->get_name() == "" && obj->get_bitfieldWidth() != NULL ) return;
541
542                // want to be able to generate assignment, ctor, and dtor generically,
543                // so fname is either ?=?, ?{}, or ^?{}
544                UntypedExpr *fExpr = new UntypedExpr( new NameExpr( fname ) );
545
546                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
547                derefExpr->get_args().push_back( new VariableExpr( dstParam ) );
548
549                // do something special for unnamed members
550                Expression *dstselect = new AddressExpr( new MemberExpr( member, derefExpr ) );
551                fExpr->get_args().push_back( dstselect );
552
553                Expression *srcselect = new MemberExpr( member, new VariableExpr( srcParam ) );
554                fExpr->get_args().push_back( srcselect );
555
556                *out++ = new ExprStmt( noLabels, fExpr );
557        }
558
559        template< typename OutputIterator >
560        void makeArrayFunction( ObjectDecl *srcParam, ObjectDecl *dstParam, DeclarationWithType *member, ArrayType *array, std::string fname, OutputIterator out ) {
561                static UniqueName indexName( "_index" );
562
563                // for a flexible array member nothing is done -- user must define own assignment
564                if ( ! array->get_dimension() ) return;
565
566                ObjectDecl *index = new ObjectDecl( indexName.newName(), DeclarationNode::NoStorageClass, LinkageSpec::C, 0, new BasicType( Type::Qualifiers(), BasicType::SignedInt ), 0 );
567                *out++ = new DeclStmt( noLabels, index );
568
569                UntypedExpr *init = new UntypedExpr( new NameExpr( "?=?" ) );
570                init->get_args().push_back( new AddressExpr( new VariableExpr( index ) ) );
571                init->get_args().push_back( new NameExpr( "0" ) );
572                Statement *initStmt = new ExprStmt( noLabels, init );
573                std::list<Statement *> initList;
574                initList.push_back( initStmt );
575
576                UntypedExpr *cond = new UntypedExpr( new NameExpr( "?<?" ) );
577                cond->get_args().push_back( new VariableExpr( index ) );
578                cond->get_args().push_back( array->get_dimension()->clone() );
579
580                UntypedExpr *inc = new UntypedExpr( new NameExpr( "++?" ) );
581                inc->get_args().push_back( new AddressExpr( new VariableExpr( index ) ) );
582
583                // want to be able to generate assignment, ctor, and dtor generically,
584                // so fname is either ?=?, ?{}, or ^?{}
585                UntypedExpr *fExpr = new UntypedExpr( new NameExpr( fname ) );
586
587                UntypedExpr *derefExpr = new UntypedExpr( new NameExpr( "*?" ) );
588                derefExpr->get_args().push_back( new VariableExpr( dstParam ) );
589
590                Expression *dstselect = new MemberExpr( member, derefExpr );
591                UntypedExpr *dstIndex = new UntypedExpr( new NameExpr( "?+?" ) );
592                dstIndex->get_args().push_back( dstselect );
593                dstIndex->get_args().push_back( new VariableExpr( index ) );
594                fExpr->get_args().push_back( dstIndex );
595
596                Expression *srcselect = new MemberExpr( member, new VariableExpr( srcParam ) );
597                UntypedExpr *srcIndex = new UntypedExpr( new NameExpr( "?[?]" ) );
598                srcIndex->get_args().push_back( srcselect );
599                srcIndex->get_args().push_back( new VariableExpr( index ) );
600                fExpr->get_args().push_back( srcIndex );
601
602                *out++ = new ForStmt( noLabels, initList, cond, inc, new ExprStmt( noLabels, fExpr ) );
603        }
604
605        template< typename OutputIterator >
606        void makeUnionFieldsAssignment( ObjectDecl *srcParam, ObjectDecl *dstParam, UnionInstType *unionType, OutputIterator out ) {
607                UntypedExpr *copy = new UntypedExpr( new NameExpr( "__builtin_memcpy" ) );
608                copy->get_args().push_back( new VariableExpr( dstParam ) );
609                copy->get_args().push_back( new AddressExpr( new VariableExpr( srcParam ) ) );
610                copy->get_args().push_back( new SizeofExpr( unionType ) );
611
612                *out++ = new ExprStmt( noLabels, copy );
613        }
614
615        //E ?=?(E volatile*, int),
616        //  ?=?(E _Atomic volatile*, int);
617        void makeEnumAssignment( EnumDecl *enumDecl, EnumInstType *refType, unsigned int functionNesting, std::list< Declaration * > &declsToAdd ) {
618                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
619
620                ObjectDecl *returnVal = new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, refType->clone(), 0 );
621                assignType->get_returnVals().push_back( returnVal );
622
623                // need two assignment operators with different types
624                FunctionType * assignType2 = assignType->clone();
625
626                // E ?=?(E volatile *, E)
627                Type *etype = refType->clone();
628                // etype->get_qualifiers() += Type::Qualifiers(false, true, false, false, false, false);
629
630                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), etype ), 0 );
631                assignType->get_parameters().push_back( dstParam );
632
633                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, etype->clone(), 0 );
634                assignType->get_parameters().push_back( srcParam );
635
636                // E ?=?(E volatile *, int)
637                assignType2->get_parameters().push_back( dstParam->clone() );
638                BasicType * paramType = new BasicType(Type::Qualifiers(), BasicType::SignedInt);
639                ObjectDecl *srcParam2 = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, paramType, 0 );
640                assignType2->get_parameters().push_back( srcParam2 );
641
642                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
643                // because each unit generates copies of the default routines for each aggregate.
644
645                // since there is no definition, these should not be inline
646                // make these intrinsic so that the code generator does not make use of them
647                FunctionDecl *assignDecl = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::Intrinsic, assignType, 0, false, false );
648                assignDecl->fixUniqueId();
649                FunctionDecl *assignDecl2 = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::Intrinsic, assignType2, 0, false, false );
650                assignDecl2->fixUniqueId();
651
652                // these should be built in the same way that the prelude
653                // functions are, so build a list containing the prototypes
654                // and allow MakeLibCfa to autogenerate the bodies.
655                std::list< Declaration * > assigns;
656                assigns.push_back( assignDecl );
657                assigns.push_back( assignDecl2 );
658
659                LibCfa::makeLibCfa( assigns );
660
661                // need to remove the prototypes, since this may be nested in a routine
662                for (int start = 0, end = assigns.size()/2; start < end; start++) {
663                        delete assigns.front();
664                        assigns.pop_front();
665                } // for
666
667                declsToAdd.insert( declsToAdd.begin(), assigns.begin(), assigns.end() );
668        }
669
670        /// Clones a reference type, replacing any parameters it may have with a clone of the provided list
671        template< typename GenericInstType >
672        GenericInstType *cloneWithParams( GenericInstType *refType, const std::list< Expression* >& params ) {
673                GenericInstType *clone = refType->clone();
674                clone->get_parameters().clear();
675                cloneAll( params, clone->get_parameters() );
676                return clone;
677        }
678
679        /// Creates a new type decl that's the same as src, but renamed and with only the ?=? assertion (for complete types only)
680        TypeDecl *cloneAndRename( TypeDecl *src, const std::string &name ) {
681                TypeDecl *dst = new TypeDecl( name, src->get_storageClass(), 0, src->get_kind() );
682
683                if ( src->get_kind() == TypeDecl::Any ) {
684                        // just include assignment operator assertion
685                        TypeInstType *assignParamType = new TypeInstType( Type::Qualifiers(), name, dst );
686                        FunctionType *assignFunctionType = new FunctionType( Type::Qualifiers(), false );
687                        assignFunctionType->get_returnVals().push_back(
688                                new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, assignParamType->clone(), 0 ) );
689                        assignFunctionType->get_parameters().push_back(
690                                new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), assignParamType->clone() ), 0 ) );
691                        assignFunctionType->get_parameters().push_back(
692                                new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, assignParamType, 0 ) );
693                        FunctionDecl *assignAssert = new FunctionDecl( "?=?", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, assignFunctionType, 0, false, false );
694                        dst->get_assertions().push_back( assignAssert );
695                }
696
697                return dst;
698        }
699
700        Declaration *makeStructAssignment( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting ) {
701                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
702
703                // Make function polymorphic in same parameters as generic struct, if applicable
704                bool isGeneric = false;  // NOTE this flag is an incredibly ugly kludge; we should fix the assignment signature instead (ditto for union)
705                std::list< TypeDecl* >& genericParams = aggregateDecl->get_parameters();
706                std::list< Expression* > structParams;  // List of matching parameters to put on types
707                TypeSubstitution genericSubs; // Substitutions to make to member types of struct
708                for ( std::list< TypeDecl* >::const_iterator param = genericParams.begin(); param != genericParams.end(); ++param ) {
709                        isGeneric = true;
710                        TypeDecl *typeParam = cloneAndRename( *param, "_autoassign_" + aggregateDecl->get_name() + "_" + (*param)->get_name() );
711                        assignType->get_forall().push_back( typeParam );
712                        TypeInstType *newParamType = new TypeInstType( Type::Qualifiers(), typeParam->get_name(), typeParam );
713                        genericSubs.add( (*param)->get_name(), newParamType );
714                        structParams.push_back( new TypeExpr( newParamType ) );
715                }
716
717                ObjectDecl *returnVal = new ObjectDecl( "_ret", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, structParams ), 0 );
718                assignType->get_returnVals().push_back( returnVal );
719
720                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), cloneWithParams( refType, structParams ) ), 0 );
721                assignType->get_parameters().push_back( dstParam );
722
723                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, structParams ), 0 );
724                assignType->get_parameters().push_back( srcParam );
725
726                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
727                // because each unit generates copies of the default routines for each aggregate.
728                FunctionDecl *assignDecl = new FunctionDecl( "?=?", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, assignType, new CompoundStmt( noLabels ), true, false );
729                assignDecl->fixUniqueId();
730
731                for ( std::list< Declaration * >::const_iterator member = aggregateDecl->get_members().begin(); member != aggregateDecl->get_members().end(); ++member ) {
732                        if ( DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member ) ) {
733                                // query the type qualifiers of this field and skip assigning it if it is marked const.
734                                // If it is an array type, we need to strip off the array layers to find its qualifiers.
735                                Type * type = dwt->get_type();
736                                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
737                                        type = at->get_base();
738                                }
739
740                                if ( type->get_qualifiers().isConst ) {
741                                        // don't assign const members
742                                        continue;
743                                }
744
745                                if ( isGeneric ) {
746                                        // rewrite member type in terms of the type variables on this operator
747                                        DeclarationWithType *fixedMember = dwt->clone();
748                                        genericSubs.apply( fixedMember );
749
750                                        // assign to both destination and return value
751                                        if ( ArrayType *array = dynamic_cast< ArrayType * >( fixedMember->get_type() ) ) {
752                                                makeArrayFunction( srcParam, dstParam, fixedMember, array, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
753                                                makeArrayFunction( srcParam, returnVal, fixedMember, array, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
754                                        } else {
755                                                makeScalarFunction( srcParam, dstParam, fixedMember, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
756                                                makeScalarFunction( srcParam, returnVal, fixedMember, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
757                                        } // if
758                                } else {
759                                        // assign to destination
760                                        if ( ArrayType *array = dynamic_cast< ArrayType * >( dwt->get_type() ) ) {
761                                                makeArrayFunction( srcParam, dstParam, dwt, array, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
762                                        } else {
763                                                makeScalarFunction( srcParam, dstParam, dwt, "?=?", back_inserter( assignDecl->get_statements()->get_kids() ) );
764                                        } // if
765                                } // if
766                        } // if
767                } // for
768                if ( ! isGeneric ) assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
769
770                return assignDecl;
771        }
772
773        void makeStructCtorDtor( StructDecl *aggregateDecl, StructInstType *refType, unsigned int functionNesting, std::list< Declaration * > & declsToAdd ) {
774                FunctionType *ctorType = new FunctionType( Type::Qualifiers(), false );
775
776                // Make function polymorphic in same parameters as generic struct, if applicable
777                bool isGeneric = false;  // NOTE this flag is an incredibly ugly kludge; we should fix the assignment signature instead (ditto for union)
778                std::list< TypeDecl* >& genericParams = aggregateDecl->get_parameters();
779                std::list< Expression* > structParams;  // List of matching parameters to put on types
780                for ( std::list< TypeDecl* >::const_iterator param = genericParams.begin(); param != genericParams.end(); ++param ) {
781                        isGeneric = true;
782                        TypeDecl *typeParam = (*param)->clone();
783                        ctorType->get_forall().push_back( typeParam );
784                        structParams.push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeParam->get_name(), typeParam ) ) );
785                }
786
787                ObjectDecl *thisParam = new ObjectDecl( "_this", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), cloneWithParams( refType, structParams ) ), 0 );
788                ctorType->get_parameters().push_back( thisParam );
789
790                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
791                // because each unit generates copies of the default routines for each aggregate.
792                FunctionDecl *ctorDecl = new FunctionDecl( "?{}", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, ctorType, 0, true, false );
793                FunctionDecl *copyCtorDecl = new FunctionDecl( "?{}", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, ctorType->clone(), 0, true, false );
794                FunctionDecl *dtorDecl = new FunctionDecl( "^?{}", functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, ctorType->clone(), 0, true, false );
795                ctorDecl->fixUniqueId();
796                copyCtorDecl->fixUniqueId();
797                dtorDecl->fixUniqueId();
798
799                // add definitions
800                // TODO: add in calls to default constructors and destructors for fields
801                ctorDecl->set_statements( new CompoundStmt( noLabels ) );
802                copyCtorDecl->set_statements( new CompoundStmt( noLabels ) );
803                dtorDecl->set_statements( new CompoundStmt( noLabels ) );
804                declsToAdd.push_back( ctorDecl );
805                declsToAdd.push_back( copyCtorDecl );
806                declsToAdd.push_back( dtorDecl );
807
808                ObjectDecl * srcParam = new ObjectDecl( "_other", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, structParams ), 0 );
809                copyCtorDecl->get_functionType()->get_parameters().push_back( srcParam );
810                for ( std::list< Declaration * >::const_iterator member = aggregateDecl->get_members().begin(); member != aggregateDecl->get_members().end(); ++member ) {
811                        if ( DeclarationWithType *dwt = dynamic_cast< DeclarationWithType * >( *member ) ) {
812                                // query the type qualifiers of this field and skip assigning it if it is marked const.
813                                // If it is an array type, we need to strip off the array layers to find its qualifiers.
814                                Type * type = dwt->get_type();
815                                while ( ArrayType * at = dynamic_cast< ArrayType * >( type ) ) {
816                                        type = at->get_base();
817                                }
818
819                                if ( type->get_qualifiers().isConst ) {
820                                        // don't assign const members
821                                        continue;
822                                }
823
824                                if ( ArrayType *array = dynamic_cast< ArrayType * >( dwt->get_type() ) ) {
825                                        makeArrayFunction( srcParam, thisParam, dwt, array, "?{}", back_inserter( copyCtorDecl->get_statements()->get_kids() ) );
826                                        // if ( isGeneric ) makeArrayFunction( srcParam, returnVal, dwt, array, back_inserter( copyCtorDecl->get_statements()->get_kids() ) );
827                                } else {
828                                        makeScalarFunction( srcParam, thisParam, dwt, "?{}", back_inserter( copyCtorDecl->get_statements()->get_kids() ) );
829                                        // if ( isGeneric ) makeScalarCtor( srcParam, returnVal, dwt, back_inserter( copyCtorDecl->get_statements()->get_kids() ) );
830                                } // if
831                        } // if
832                } // for
833                // if ( ! isGeneric ) assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
834        }
835
836        void makeUnionFunctions( UnionDecl *aggregateDecl, UnionInstType *refType, unsigned int functionNesting, std::list< Declaration * > & declsToAdd ) {
837                FunctionType *assignType = new FunctionType( Type::Qualifiers(), false );
838
839                // Make function polymorphic in same parameters as generic union, if applicable
840                bool isGeneric = false;  // NOTE this flag is an incredibly ugly kludge; we should fix the assignment signature instead (ditto for struct)
841                std::list< TypeDecl* >& genericParams = aggregateDecl->get_parameters();
842                std::list< Expression* > unionParams;  // List of matching parameters to put on types
843                for ( std::list< TypeDecl* >::const_iterator param = genericParams.begin(); param != genericParams.end(); ++param ) {
844                        isGeneric = true;
845                        TypeDecl *typeParam = cloneAndRename( *param, "_autoassign_" + aggregateDecl->get_name() + "_" + (*param)->get_name() );
846                        assignType->get_forall().push_back( typeParam );
847                        unionParams.push_back( new TypeExpr( new TypeInstType( Type::Qualifiers(), typeParam->get_name(), typeParam ) ) );
848                }
849
850                ObjectDecl *dstParam = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), cloneWithParams( refType, unionParams ) ), 0 );
851                assignType->get_parameters().push_back( dstParam );
852
853                // default ctor/dtor need only first parameter
854                FunctionType * ctorType = assignType->clone();
855                FunctionType * dtorType = assignType->clone();
856
857                ObjectDecl *srcParam = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, unionParams ), 0 );
858                assignType->get_parameters().push_back( srcParam );
859
860                // copy ctor needs both parameters
861                FunctionType * copyCtorType = assignType->clone();
862
863                // assignment needs both and return value
864                ObjectDecl *returnVal = new ObjectDecl( "_ret", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, cloneWithParams( refType, unionParams ), 0 );
865                assignType->get_returnVals().push_back( returnVal );
866
867                // Routines at global scope marked "static" to prevent multiple definitions is separate translation units
868                // because each unit generates copies of the default routines for each aggregate.
869                FunctionDecl *assignDecl = new FunctionDecl( "?=?",  functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, assignType, new CompoundStmt( noLabels ), true, false );
870                FunctionDecl *ctorDecl = new FunctionDecl( "?{}",  functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, ctorType, new CompoundStmt( noLabels ), true, false );
871                FunctionDecl *copyCtorDecl = new FunctionDecl( "?{}",  functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, copyCtorType, NULL, true, false );
872                FunctionDecl *dtorDecl = new FunctionDecl( "^?{}",  functionNesting > 0 ? DeclarationNode::NoStorageClass : DeclarationNode::Static, LinkageSpec::AutoGen, dtorType, new CompoundStmt( noLabels ), true, false );
873
874                assignDecl->fixUniqueId();
875                ctorDecl->fixUniqueId();
876                copyCtorDecl->fixUniqueId();
877                dtorDecl->fixUniqueId();
878
879                makeUnionFieldsAssignment( srcParam, dstParam, cloneWithParams( refType, unionParams ), back_inserter( assignDecl->get_statements()->get_kids() ) );
880                if ( isGeneric ) makeUnionFieldsAssignment( srcParam, returnVal, cloneWithParams( refType, unionParams ), back_inserter( assignDecl->get_statements()->get_kids() ) );
881
882                if ( ! isGeneric ) assignDecl->get_statements()->get_kids().push_back( new ReturnStmt( noLabels, new VariableExpr( srcParam ) ) );
883
884                // body of assignment and copy ctor is the same
885                copyCtorDecl->set_statements( assignDecl->get_statements()->clone() );
886
887                declsToAdd.push_back( assignDecl );
888                declsToAdd.push_back( ctorDecl );
889                declsToAdd.push_back( copyCtorDecl );
890                declsToAdd.push_back( dtorDecl );
891        }
892
893        void AutogenerateRoutines::visit( EnumDecl *enumDecl ) {
894                if ( ! enumDecl->get_members().empty() ) {
895                        EnumInstType *enumInst = new EnumInstType( Type::Qualifiers(), enumDecl->get_name() );
896                        // enumInst->set_baseEnum( enumDecl );
897                        // declsToAdd.push_back(
898                        makeEnumAssignment( enumDecl, enumInst, functionNesting, declsToAdd );
899                }
900        }
901
902        void AutogenerateRoutines::visit( StructDecl *structDecl ) {
903                if ( ! structDecl->get_members().empty() && structsDone.find( structDecl->get_name() ) == structsDone.end() ) {
904                        StructInstType structInst( Type::Qualifiers(), structDecl->get_name() );
905                        structInst.set_baseStruct( structDecl );
906
907                        declsToAdd.push_back( makeStructAssignment( structDecl, &structInst, functionNesting ) );
908                        makeStructCtorDtor( structDecl, &structInst, functionNesting, declsToAdd );
909                        structsDone.insert( structDecl->get_name() );
910                } // if
911        }
912
913        void AutogenerateRoutines::visit( UnionDecl *unionDecl ) {
914                if ( ! unionDecl->get_members().empty() ) {
915                        UnionInstType unionInst( Type::Qualifiers(), unionDecl->get_name() );
916                        unionInst.set_baseUnion( unionDecl );
917                        makeUnionFunctions( unionDecl, &unionInst, functionNesting, declsToAdd );
918                } // if
919        }
920
921        void AutogenerateRoutines::visit( TypeDecl *typeDecl ) {
922                CompoundStmt *stmts = 0;
923                TypeInstType *typeInst = new TypeInstType( Type::Qualifiers(), typeDecl->get_name(), false );
924                typeInst->set_baseType( typeDecl );
925                ObjectDecl *src = new ObjectDecl( "_src", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, typeInst->clone(), 0 );
926                ObjectDecl *dst = new ObjectDecl( "_dst", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, new PointerType( Type::Qualifiers(), typeInst->clone() ), 0 );
927                if ( typeDecl->get_base() ) {
928                        stmts = new CompoundStmt( std::list< Label >() );
929                        UntypedExpr *assign = new UntypedExpr( new NameExpr( "?=?" ) );
930                        assign->get_args().push_back( new CastExpr( new VariableExpr( dst ), new PointerType( Type::Qualifiers(), typeDecl->get_base()->clone() ) ) );
931                        assign->get_args().push_back( new CastExpr( new VariableExpr( src ), typeDecl->get_base()->clone() ) );
932                        stmts->get_kids().push_back( new ReturnStmt( std::list< Label >(), assign ) );
933                } // if
934                FunctionType *type = new FunctionType( Type::Qualifiers(), false );
935                type->get_returnVals().push_back( new ObjectDecl( "", DeclarationNode::NoStorageClass, LinkageSpec::Cforall, 0, typeInst, 0 ) );
936                type->get_parameters().push_back( dst );
937                type->get_parameters().push_back( src );
938                FunctionDecl *func = new FunctionDecl( "?=?", DeclarationNode::NoStorageClass, LinkageSpec::AutoGen, type, stmts, false, false );
939                declsToAdd.push_back( func );
940        }
941
942        void addDecls( std::list< Declaration * > &declsToAdd, std::list< Statement * > &statements, std::list< Statement * >::iterator i ) {
943                for ( std::list< Declaration * >::iterator decl = declsToAdd.begin(); decl != declsToAdd.end(); ++decl ) {
944                        statements.insert( i, new DeclStmt( noLabels, *decl ) );
945                } // for
946                declsToAdd.clear();
947        }
948
949        void AutogenerateRoutines::visit( FunctionType *) {
950                // ensure that we don't add assignment ops for types defined as part of the function
951        }
952
953        void AutogenerateRoutines::visit( PointerType *) {
954                // ensure that we don't add assignment ops for types defined as part of the pointer
955        }
956
957        void AutogenerateRoutines::visit( ContextDecl *) {
958                // ensure that we don't add assignment ops for types defined as part of the context
959        }
960
961        template< typename StmtClass >
962        inline void AutogenerateRoutines::visitStatement( StmtClass *stmt ) {
963                std::set< std::string > oldStructs = structsDone;
964                addVisit( stmt, *this );
965                structsDone = oldStructs;
966        }
967
968        void AutogenerateRoutines::visit( FunctionDecl *functionDecl ) {
969                maybeAccept( functionDecl->get_functionType(), *this );
970                acceptAll( functionDecl->get_oldDecls(), *this );
971                functionNesting += 1;
972                maybeAccept( functionDecl->get_statements(), *this );
973                functionNesting -= 1;
974        }
975
976        void AutogenerateRoutines::visit( CompoundStmt *compoundStmt ) {
977                visitStatement( compoundStmt );
978        }
979
980        void AutogenerateRoutines::visit( IfStmt *ifStmt ) {
981                visitStatement( ifStmt );
982        }
983
984        void AutogenerateRoutines::visit( WhileStmt *whileStmt ) {
985                visitStatement( whileStmt );
986        }
987
988        void AutogenerateRoutines::visit( ForStmt *forStmt ) {
989                visitStatement( forStmt );
990        }
991
992        void AutogenerateRoutines::visit( SwitchStmt *switchStmt ) {
993                visitStatement( switchStmt );
994        }
995
996        void AutogenerateRoutines::visit( ChooseStmt *switchStmt ) {
997                visitStatement( switchStmt );
998        }
999
1000        void AutogenerateRoutines::visit( CaseStmt *caseStmt ) {
1001                visitStatement( caseStmt );
1002        }
1003
1004        void AutogenerateRoutines::visit( CatchStmt *cathStmt ) {
1005                visitStatement( cathStmt );
1006        }
1007
1008        void ReturnChecker::checkFunctionReturns( std::list< Declaration * > & translationUnit ) {
1009                ReturnChecker checker;
1010                acceptAll( translationUnit, checker );
1011        }
1012
1013        void ReturnChecker::visit( FunctionDecl * functionDecl ) {
1014                std::list< DeclarationWithType * > oldReturnVals = returnVals;
1015                returnVals = functionDecl->get_functionType()->get_returnVals();
1016                Visitor::visit( functionDecl );
1017                returnVals = oldReturnVals;
1018        }
1019
1020        void ReturnChecker::visit( ReturnStmt * returnStmt ) {
1021                if ( returnStmt->get_expr() == NULL && returnVals.size() != 0 ) {
1022                        throw SemanticError( "Non-void function returns no values: " , returnStmt );
1023                } else if ( returnStmt->get_expr() != NULL && returnVals.size() == 0 ) {
1024                        throw SemanticError( "void function returns values: " , returnStmt );
1025                }
1026        }
1027
1028
1029        bool isTypedef( Declaration *decl ) {
1030                return dynamic_cast< TypedefDecl * >( decl );
1031        }
1032
1033        void EliminateTypedef::eliminateTypedef( std::list< Declaration * > &translationUnit ) {
1034                EliminateTypedef eliminator;
1035                mutateAll( translationUnit, eliminator );
1036                filter( translationUnit, isTypedef, true );
1037        }
1038
1039        Type *EliminateTypedef::mutate( TypeInstType * typeInst ) {
1040                // instances of typedef types will come here. If it is an instance
1041                // of a typdef type, link the instance to its actual type.
1042                TypedefMap::const_iterator def = typedefNames.find( typeInst->get_name() );
1043                if ( def != typedefNames.end() ) {
1044                        Type *ret = def->second.first->get_base()->clone();
1045                        ret->get_qualifiers() += typeInst->get_qualifiers();
1046                        // place instance parameters on the typedef'd type
1047                        if ( ! typeInst->get_parameters().empty() ) {
1048                                ReferenceToType *rtt = dynamic_cast<ReferenceToType*>(ret);
1049                                if ( ! rtt ) {
1050                                        throw SemanticError("cannot apply type parameters to base type of " + typeInst->get_name());
1051                                }
1052                                rtt->get_parameters().clear();
1053                                cloneAll(typeInst->get_parameters(), rtt->get_parameters());
1054                        } // if
1055                        delete typeInst;
1056                        return ret;
1057                } // if
1058                return typeInst;
1059        }
1060
1061        Declaration *EliminateTypedef::mutate( TypedefDecl * tyDecl ) {
1062                Declaration *ret = Mutator::mutate( tyDecl );
1063                if ( typedefNames.count( tyDecl->get_name() ) == 1 && typedefNames[ tyDecl->get_name() ].second == scopeLevel ) {
1064                        // typedef to the same name from the same scope
1065                        // must be from the same type
1066
1067                        Type * t1 = tyDecl->get_base();
1068                        Type * t2 = typedefNames[ tyDecl->get_name() ].first->get_base();
1069                        if ( ! ResolvExpr::typesCompatible( t1, t2, Indexer() ) ) {
1070                                throw SemanticError( "cannot redefine typedef: " + tyDecl->get_name() );
1071                        }
1072                } else {
1073                        typedefNames[ tyDecl->get_name() ] = std::make_pair( tyDecl, scopeLevel );
1074                } // if
1075
1076                // When a typedef is a forward declaration:
1077                //    typedef struct screen SCREEN;
1078                // the declaration portion must be retained:
1079                //    struct screen;
1080                // because the expansion of the typedef is:
1081                //    void rtn( SCREEN *p ) => void rtn( struct screen *p )
1082                // hence the type-name "screen" must be defined.
1083                // Note, qualifiers on the typedef are superfluous for the forward declaration.
1084                if ( StructInstType *aggDecl = dynamic_cast< StructInstType * >( tyDecl->get_base() ) ) {
1085                        return new StructDecl( aggDecl->get_name() );
1086                } else if ( UnionInstType *aggDecl = dynamic_cast< UnionInstType * >( tyDecl->get_base() ) ) {
1087                        return new UnionDecl( aggDecl->get_name() );
1088                } else {
1089                        return ret;
1090                } // if
1091        }
1092
1093        TypeDecl *EliminateTypedef::mutate( TypeDecl * typeDecl ) {
1094                TypedefMap::iterator i = typedefNames.find( typeDecl->get_name() );
1095                if ( i != typedefNames.end() ) {
1096                        typedefNames.erase( i ) ;
1097                } // if
1098                return typeDecl;
1099        }
1100
1101        DeclarationWithType *EliminateTypedef::mutate( FunctionDecl * funcDecl ) {
1102                TypedefMap oldNames = typedefNames;
1103                DeclarationWithType *ret = Mutator::mutate( funcDecl );
1104                typedefNames = oldNames;
1105                return ret;
1106        }
1107
1108        DeclarationWithType *EliminateTypedef::mutate( ObjectDecl * objDecl ) {
1109                TypedefMap oldNames = typedefNames;
1110                DeclarationWithType *ret = Mutator::mutate( objDecl );
1111                typedefNames = oldNames;
1112                // is the type a function?
1113                if ( FunctionType *funtype = dynamic_cast<FunctionType *>( ret->get_type() ) ) {
1114                        // replace the current object declaration with a function declaration
1115                        return new FunctionDecl( ret->get_name(), ret->get_storageClass(), ret->get_linkage(), funtype, 0, ret->get_isInline(), ret->get_isNoreturn() );
1116                } else if ( objDecl->get_isInline() || objDecl->get_isNoreturn() ) {
1117                        throw SemanticError( "invalid inline or _Noreturn specification in declaration of ", objDecl );
1118                } // if
1119                return ret;
1120        }
1121
1122        Expression *EliminateTypedef::mutate( CastExpr * castExpr ) {
1123                TypedefMap oldNames = typedefNames;
1124                Expression *ret = Mutator::mutate( castExpr );
1125                typedefNames = oldNames;
1126                return ret;
1127        }
1128
1129        CompoundStmt *EliminateTypedef::mutate( CompoundStmt * compoundStmt ) {
1130                TypedefMap oldNames = typedefNames;
1131                scopeLevel += 1;
1132                CompoundStmt *ret = Mutator::mutate( compoundStmt );
1133                scopeLevel -= 1;
1134                std::list< Statement * >::iterator i = compoundStmt->get_kids().begin();
1135                while ( i != compoundStmt->get_kids().end() ) {
1136                        std::list< Statement * >::iterator next = i+1;
1137                        if ( DeclStmt *declStmt = dynamic_cast< DeclStmt * >( *i ) ) {
1138                                if ( dynamic_cast< TypedefDecl * >( declStmt->get_decl() ) ) {
1139                                        delete *i;
1140                                        compoundStmt->get_kids().erase( i );
1141                                } // if
1142                        } // if
1143                        i = next;
1144                } // while
1145                typedefNames = oldNames;
1146                return ret;
1147        }
1148
1149        // there may be typedefs nested within aggregates
1150        // in order for everything to work properly, these
1151        // should be removed as well
1152        template<typename AggDecl>
1153        AggDecl *EliminateTypedef::handleAggregate( AggDecl * aggDecl ) {
1154                std::list<Declaration *>::iterator it = aggDecl->get_members().begin();
1155                for ( ; it != aggDecl->get_members().end(); ) {
1156                        std::list< Declaration * >::iterator next = it+1;
1157                        if ( dynamic_cast< TypedefDecl * >( *it ) ) {
1158                                delete *it;
1159                                aggDecl->get_members().erase( it );
1160                        } // if
1161                        it = next;
1162                }
1163                return aggDecl;
1164        }
1165
1166        Declaration *EliminateTypedef::mutate( StructDecl * structDecl ) {
1167                Mutator::mutate( structDecl );
1168                return handleAggregate( structDecl );
1169        }
1170
1171        Declaration *EliminateTypedef::mutate( UnionDecl * unionDecl ) {
1172                Mutator::mutate( unionDecl );
1173                return handleAggregate( unionDecl );
1174        }
1175
1176        Declaration *EliminateTypedef::mutate( EnumDecl * enumDecl ) {
1177                Mutator::mutate( enumDecl );
1178                return handleAggregate( enumDecl );
1179        }
1180
1181                Declaration *EliminateTypedef::mutate( ContextDecl * contextDecl ) {
1182                Mutator::mutate( contextDecl );
1183                return handleAggregate( contextDecl );
1184        }
1185
1186        void VerifyCtorDtor::verify( std::list< Declaration * > & translationUnit ) {
1187                VerifyCtorDtor verifier;
1188                acceptAll( translationUnit, verifier );
1189        }
1190
1191        void VerifyCtorDtor::visit( FunctionDecl * funcDecl ) {
1192                FunctionType * funcType = funcDecl->get_functionType();
1193                std::list< DeclarationWithType * > &returnVals = funcType->get_returnVals();
1194                std::list< DeclarationWithType * > &params = funcType->get_parameters();
1195
1196                if ( funcDecl->get_name() == "?{}" || funcDecl->get_name() == "^?{}" ) {
1197                        if ( params.size() == 0 ) {
1198                                throw SemanticError( "Constructors and destructors require at least one parameter ", funcDecl );
1199                        }
1200                        if ( ! dynamic_cast< PointerType * >( params.front()->get_type() ) ) {
1201                                throw SemanticError( "First parameter of a constructor or destructor must be a pointer ", funcDecl );
1202                        }
1203                        if ( returnVals.size() != 0 ) {
1204                                throw SemanticError( "Constructors and destructors cannot have explicit return values ", funcDecl );
1205                        }
1206                }
1207
1208                Visitor::visit( funcDecl );
1209                // original idea: modify signature of ctor/dtors and insert appropriate return statements
1210                // to cause desired behaviour
1211                // new idea: add comma exprs to every ctor call to produce first parameter.
1212                // this requires some memoization of the first parameter, because it can be a
1213                // complicated expression with side effects (see: malloc). idea: add temporary variable
1214                // that is assigned address of constructed object in ctor argument position and
1215                // return the temporary. It should also be done after all implicit ctors are
1216                // added, so not in this pass!
1217        }
1218} // namespace SymTab
1219
1220// Local Variables: //
1221// tab-width: 4 //
1222// mode: c++ //
1223// compile-command: "make install" //
1224// End: //
Note: See TracBrowser for help on using the repository browser.