source: src/Parser/TypeData.cc @ 409433da

//
// Cforall Version 1.0.0 Copyright (C) 2015 University of Waterloo
//
// The contents of this file are covered under the licence agreement in the
// file "LICENCE" distributed with Cforall.
//
// TypeData.cc --
//
// Author           : Rodolfo G. Esteves
// Created On       : Sat May 16 15:12:51 2015
// Last Modified By : Peter A. Buhr
// Last Modified On : Fri Mar 17 15:52:43 2017
// Update Count     : 563
//

#include <cassert>
#include <algorithm>
#include <iterator>
#include "Common/utility.h"
#include "TypeData.h"
#include "SynTree/Type.h"
#include "SynTree/Declaration.h"
#include "SynTree/Expression.h"
#include "SynTree/Statement.h"
#include "SynTree/Initializer.h"
using namespace std;

TypeData::TypeData( Kind k ) : kind( k ), base( nullptr ), forall( nullptr ) /*, PTR1( (void*)(0xdeadbeefdeadbeef)), PTR2( (void*)(0xdeadbeefdeadbeef) ) */ {
        switch ( kind ) {
          case Unknown:
          case Pointer:
          case EnumConstant:
                // nothing else to initialize
                break;
          case Basic:
                // basic = new Basic_t;
                break;
          case Array:
                // array = new Array_t;
                array.dimension = nullptr;
                array.isVarLen = false;
                array.isStatic = false;
                break;
          case Function:
                // function = new Function_t;
                function.params = nullptr;
                function.idList = nullptr;
                function.oldDeclList = nullptr;
                function.body = nullptr;
                function.newStyle = false;
                break;
                // Enum is an Aggregate, so both structures are initialized together.
          case Enum:
                // enumeration = new Enumeration_t;
                enumeration.name = nullptr;
                enumeration.constants = nullptr;
                enumeration.body = false;
          case Aggregate:
                // aggregate = new Aggregate_t;
                aggregate.name = nullptr;
                aggregate.params = nullptr;
                aggregate.actuals = nullptr;
                aggregate.fields = nullptr;
                aggregate.body = false;
                break;
          case AggregateInst:
                // aggInst = new AggInst_t;
                aggInst.aggregate = nullptr;
                aggInst.params = nullptr;
                aggInst.hoistType = false;;
                break;
          case Symbolic:
          case SymbolicInst:
                // symbolic = new Symbolic_t;
                symbolic.name = nullptr;
                symbolic.params = nullptr;
                symbolic.actuals = nullptr;
                symbolic.assertions = nullptr;
                break;
          case Tuple:
                // tuple = new Tuple_t;
                tuple = nullptr;
                break;
          case Typeof:
                // typeexpr = new Typeof_t;
                typeexpr = nullptr;
                break;
          case Builtin:
                // builtin = new Builtin_t;
                break;
        } // switch
} // TypeData::TypeData

TypeData::~TypeData() {
        delete base;
        delete forall;

        switch ( kind ) {
          case Unknown:
          case Pointer:
          case EnumConstant:
                // nothing to destroy
                break;
          case Basic:
                // delete basic;
                break;
          case Array:
                delete array.dimension;
                // delete array;
                break;
          case Function:
                delete function.params;
                delete function.idList;
                delete function.oldDeclList;
                delete function.body;
                // delete function;
                break;
          case Aggregate:
                delete aggregate.name;
                delete aggregate.params;
                delete aggregate.actuals;
                delete aggregate.fields;
                // delete aggregate;
                break;
          case AggregateInst:
                delete aggInst.aggregate;
                delete aggInst.params;
                // delete aggInst;
                break;
          case Enum:
                delete enumeration.name;
                delete enumeration.constants;
                // delete enumeration;
                break;
          case Symbolic:
          case SymbolicInst:
                delete symbolic.name;
                delete symbolic.params;
                delete symbolic.actuals;
                delete symbolic.assertions;
                // delete symbolic;
                break;
          case Tuple:
                // delete tuple->members;
                delete tuple;
                break;
          case Typeof:
                // delete typeexpr->expr;
                delete typeexpr;
                break;
          case Builtin:
                // delete builtin;
                break;
        } // switch
} // TypeData::~TypeData

TypeData * TypeData::clone() const {
        TypeData * newtype = new TypeData( kind );
        newtype->qualifiers = qualifiers;
        newtype->base = maybeClone( base );
        newtype->forall = maybeClone( forall );

        switch ( kind ) {
          case Unknown:
          case EnumConstant:
          case Pointer:
                // nothing else to copy
                break;
          case Basic:
                newtype->basictype = basictype;
                newtype->complextype = complextype;
                newtype->signedness = signedness;
                newtype->length = length;
                break;
          case Array:
                newtype->array.dimension = maybeClone( array.dimension );
                newtype->array.isVarLen = array.isVarLen;
                newtype->array.isStatic = array.isStatic;
                break;
          case Function:
                newtype->function.params = maybeClone( function.params );
                newtype->function.idList = maybeClone( function.idList );
                newtype->function.oldDeclList = maybeClone( function.oldDeclList );
                newtype->function.body = maybeClone( function.body );
                newtype->function.newStyle = function.newStyle;
                break;
          case Aggregate:
                newtype->aggregate.name = aggregate.name ? new string( *aggregate.name ) : nullptr;
                newtype->aggregate.params = maybeClone( aggregate.params );
                newtype->aggregate.actuals = maybeClone( aggregate.actuals );
                newtype->aggregate.fields = maybeClone( aggregate.fields );
                newtype->aggregate.kind = aggregate.kind;
                newtype->aggregate.body = aggregate.body;
                break;
          case AggregateInst:
                newtype->aggInst.aggregate = maybeClone( aggInst.aggregate );
                newtype->aggInst.params = maybeClone( aggInst.params );
                newtype->aggInst.hoistType = aggInst.hoistType;
                break;
          case Enum:
                newtype->enumeration.name = enumeration.name ? new string( *enumeration.name ) : nullptr;
                newtype->enumeration.constants = maybeClone( enumeration.constants );
                newtype->enumeration.body = enumeration.body;
                break;
          case Symbolic:
          case SymbolicInst:
                newtype->symbolic.name = symbolic.name ? new string( *symbolic.name ) : nullptr;
                newtype->symbolic.params = maybeClone( symbolic.params );
                newtype->symbolic.actuals = maybeClone( symbolic.actuals );
                newtype->symbolic.assertions = maybeClone( symbolic.assertions );
                newtype->symbolic.isTypedef = symbolic.isTypedef;
                break;
          case Tuple:
                newtype->tuple = maybeClone( tuple );
                break;
          case Typeof:
                newtype->typeexpr = maybeClone( typeexpr );
                break;
          case Builtin:
                assert( builtintype == DeclarationNode::Zero || builtintype == DeclarationNode::One );
                newtype->builtintype = builtintype;
                break;
        } // switch
        return newtype;
} // TypeData::clone

void TypeData::print( ostream &os, int indent ) const {
        for ( int i = 0; i < Type::NumTypeQualifier; i += 1 ) {
                if ( qualifiers[i] ) os << Type::QualifiersNames[ i ] << ' ';
        } // for

        if ( forall ) {
                os << "forall " << endl;
                forall->printList( os, indent + 4 );
        } // if

        switch ( kind ) {
          case Unknown:
                os << "entity of unknown type ";
                break;
          case Pointer:
                os << "pointer ";
                if ( base ) {
                        os << "to ";
                        base->print( os, indent );
                } // if
                break;
          case EnumConstant:
                os << "enumeration constant ";
                break;
          case Basic:
                if ( signedness != DeclarationNode::NoSignedness ) os << DeclarationNode::signednessNames[ signedness ] << " ";
                if ( length != DeclarationNode::NoLength ) os << DeclarationNode::lengthNames[ length ] << " ";
                assert( basictype != DeclarationNode::NoBasicType );
                os << DeclarationNode::basicTypeNames[ basictype ] << " ";
                if ( complextype != DeclarationNode::NoComplexType ) os << DeclarationNode::complexTypeNames[ complextype ] << " ";
                break;
          case Array:
                if ( array.isStatic ) {
                        os << "static ";
                } // if
                if ( array.dimension ) {
                        os << "array of ";
                        array.dimension->printOneLine( os, indent );
                } else if ( array.isVarLen ) {
                        os << "variable-length array of ";
                } else {
                        os << "open array of ";
                } // if
                if ( base ) {
                        base->print( os, indent );
                } // if
                break;
          case Function:
                os << "function" << endl;
                if ( function.params ) {
                        os << string( indent + 2, ' ' ) << "with parameters " << endl;
                        function.params->printList( os, indent + 4 );
                } else {
                        os << string( indent + 2, ' ' ) << "with no parameters " << endl;
                } // if
                if ( function.idList ) {
                        os << string( indent + 2, ' ' ) << "with old-style identifier list " << endl;
                        function.idList->printList( os, indent + 4 );
                } // if
                if ( function.oldDeclList ) {
                        os << string( indent + 2, ' ' ) << "with old-style declaration list " << endl;
                        function.oldDeclList->printList( os, indent + 4 );
                } // if
                os << string( indent + 2, ' ' ) << "returning ";
                if ( base ) {
                        base->print( os, indent + 4 );
                } else {
                        os << "nothing ";
                } // if
                os << endl;
                if ( function.body ) {
                        os << string( indent + 2, ' ' ) << "with body " << endl;
                        function.body->printList( os, indent + 2 );
                } // if
                break;
          case Aggregate:
                os << DeclarationNode::aggregateNames[ aggregate.kind ] << ' ' << *aggregate.name << endl;
                if ( aggregate.params ) {
                        os << string( indent + 2, ' ' ) << "with type parameters " << endl;
                        aggregate.params->printList( os, indent + 4 );
                } // if
                if ( aggregate.actuals ) {
                        os << string( indent + 2, ' ' ) << "instantiated with actual parameters " << endl;
                        aggregate.actuals->printList( os, indent + 4 );
                } // if
                if ( aggregate.fields ) {
                        os << string( indent + 2, ' ' ) << "with members " << endl;
                        aggregate.fields->printList( os, indent + 4 );
                } // if
                if ( aggregate.body ) {
                        os << string( indent + 2, ' ' ) << " with body " << endl;
                } // if
                break;
          case AggregateInst:
                if ( aggInst.aggregate ) {
                        os << "instance of " ;
                        aggInst.aggregate->print( os, indent );
                } else {
                        os << "instance of an unspecified aggregate ";
                } // if
                if ( aggInst.params ) {
                        os << string( indent + 2, ' ' ) << "with parameters " << endl;
                        aggInst.params->printList( os, indent + 2 );
                } // if
                break;
          case Enum:
                os << "enumeration ";
                if ( enumeration.constants ) {
                        os << "with constants" << endl;
                        enumeration.constants->printList( os, indent + 2 );
                } // if
                if ( enumeration.body ) {
                        os << string( indent + 2, ' ' ) << " with body " << endl;
                } // if
                break;
          case SymbolicInst:
                os << "instance of type " << *symbolic.name;
                if ( symbolic.actuals ) {
                        os << " with parameters" << endl;
                        symbolic.actuals->printList( os, indent + 2 );
                } // if
                break;
          case Symbolic:
                if ( symbolic.isTypedef ) {
                        os << "typedef definition ";
                } else {
                        os << "type definition ";
                } // if
                if ( symbolic.params ) {
                        os << endl << string( indent + 2, ' ' ) << "with parameters" << endl;
                        symbolic.params->printList( os, indent + 2 );
                } // if
                if ( symbolic.assertions ) {
                        os << endl << string( indent + 2, ' ' ) << "with assertions" << endl;
                        symbolic.assertions->printList( os, indent + 4 );
                        os << string( indent + 2, ' ' );
                } // if
                if ( base ) {
                        os << "for ";
                        base->print( os, indent + 2 );
                } // if
                break;
          case Tuple:
                os << "tuple ";
                if ( tuple ) {
                        os << "with members " << endl;
                        tuple->printList( os, indent + 2 );
                } // if
                break;
          case Typeof:
                os << "type-of expression ";
                if ( typeexpr ) {
                        typeexpr->print( os, indent + 2 );
                } // if
                break;
          case Builtin:
                os << "gcc builtin type";
                break;
          default:
                os << "internal error: TypeData::print " << kind << endl;
                assert( false );
        } // switch
} // TypeData::print

template< typename ForallList >
void buildForall( const DeclarationNode * firstNode, ForallList &outputList ) {
        buildList( firstNode, outputList );
        for ( typename ForallList::iterator i = outputList.begin(); i != outputList.end(); ++i ) {
                TypeDecl * td = static_cast<TypeDecl *>(*i);
                if ( td->get_kind() == TypeDecl::Any ) {
                        // add assertion parameters to `type' tyvars in reverse order
                        // add dtor:  void ^?{}(T *)
                        FunctionType * dtorType = new FunctionType( Type::Qualifiers(), false );
                        dtorType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new PointerType( Type::Qualifiers(), new TypeInstType( Type::Qualifiers(), td->get_name(), *i ) ), nullptr ) );
                        td->get_assertions().push_front( new FunctionDecl( "^?{}", Type::StorageClasses(), LinkageSpec::Cforall, dtorType, nullptr ) );

                        // add copy ctor:  void ?{}(T *, T)
                        FunctionType * copyCtorType = new FunctionType( Type::Qualifiers(), false );
                        copyCtorType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new PointerType( Type::Qualifiers(), new TypeInstType( Type::Qualifiers(), td->get_name(), *i ) ), nullptr ) );
                        copyCtorType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new TypeInstType( Type::Qualifiers(), td->get_name(), *i ), nullptr ) );
                        td->get_assertions().push_front( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, copyCtorType, nullptr ) );

                        // add default ctor:  void ?{}(T *)
                        FunctionType * ctorType = new FunctionType( Type::Qualifiers(), false );
                        ctorType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new PointerType( Type::Qualifiers(), new TypeInstType( Type::Qualifiers(), td->get_name(), *i ) ), nullptr ) );
                        td->get_assertions().push_front( new FunctionDecl( "?{}", Type::StorageClasses(), LinkageSpec::Cforall, ctorType, nullptr ) );

                        // add assignment operator:  T * ?=?(T *, T)
                        FunctionType * assignType = new FunctionType( Type::Qualifiers(), false );
                        assignType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new PointerType( Type::Qualifiers(), new TypeInstType( Type::Qualifiers(), td->get_name(), *i ) ), nullptr ) );
                        assignType->get_parameters().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new TypeInstType( Type::Qualifiers(), td->get_name(), *i ), nullptr ) );
                        assignType->get_returnVals().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new TypeInstType( Type::Qualifiers(), td->get_name(), *i ), nullptr ) );
                        td->get_assertions().push_front( new FunctionDecl( "?=?", Type::StorageClasses(), LinkageSpec::Cforall, assignType, nullptr ) );
                } // if
        } // for
}

Type * typebuild( const TypeData * td ) {
        assert( td );
        switch ( td->kind ) {
          case TypeData::Unknown:
                // fill in implicit int
                return new BasicType( buildQualifiers( td ), BasicType::SignedInt );
          case TypeData::Basic:
                return buildBasicType( td );
          case TypeData::Pointer:
                return buildPointer( td );
          case TypeData::Array:
                return buildArray( td );
          case TypeData::Function:
                return buildFunction( td );
          case TypeData::AggregateInst:
                return buildAggInst( td );
          case TypeData::EnumConstant:
                // the name gets filled in later -- by SymTab::Validate
                return new EnumInstType( buildQualifiers( td ), "" );
          case TypeData::SymbolicInst:
                return buildSymbolicInst( td );;
          case TypeData::Tuple:
                return buildTuple( td );
          case TypeData::Typeof:
                return buildTypeof( td );
          case TypeData::Builtin:
                if(td->builtintype == DeclarationNode::Zero) {
                        return new ZeroType( emptyQualifiers );
                }
                else if(td->builtintype == DeclarationNode::One) {
                        return new OneType( emptyQualifiers );
                }
                else {
                        return new VarArgsType( buildQualifiers( td ) );
                }
          case TypeData::Symbolic:
          case TypeData::Enum:
          case TypeData::Aggregate:
                assert( false );
        } // switch
        return nullptr;
} // typebuild

TypeData * typeextractAggregate( const TypeData * td, bool toplevel ) {
        TypeData * ret = nullptr;

        switch ( td->kind ) {
          case TypeData::Aggregate:
                if ( ! toplevel && td->aggregate.fields ) {
                        ret = td->clone();
                } // if
                break;
          case TypeData::Enum:
                if ( ! toplevel && td->enumeration.constants ) {
                        ret = td->clone();
                } // if
                break;
          case TypeData::AggregateInst:
                if ( td->aggInst.aggregate ) {
                        ret = typeextractAggregate( td->aggInst.aggregate, false );
                } // if
                break;
          default:
                if ( td->base ) {
                        ret = typeextractAggregate( td->base, false );
                } // if
        } // switch
        return ret;
} // typeextractAggregate

Type::Qualifiers buildQualifiers( const TypeData * td ) {
        return td->qualifiers;
} // buildQualifiers

Type * buildBasicType( const TypeData * td ) {
        BasicType::Kind ret;

        switch ( td->basictype ) {
          case DeclarationNode::Void:
                if ( td->signedness != DeclarationNode::NoSignedness && td->length != DeclarationNode::NoLength ) {
                        throw SemanticError( "invalid type specifier \"void\" in type: ", td );
                } // if

                return new VoidType( buildQualifiers( td ) );
                break;

          case DeclarationNode::Bool:
                if ( td->signedness != DeclarationNode::NoSignedness ) {
                        throw SemanticError( string( "invalid type specifier " ) + DeclarationNode::signednessNames[ td->signedness ] + " in type: ", td );
                } // if
                if ( td->length != DeclarationNode::NoLength ) {
                        throw SemanticError( string( "invalid type specifier " ) + DeclarationNode::lengthNames[ td->length ] + " in type: ", td );
                } // if

                ret = BasicType::Bool;
                break;

          case DeclarationNode::Char:
                // C11 Standard 6.2.5.15: The three types char, signed char, and unsigned char are collectively called the
                // character types. The implementation shall define char to have the same range, representation, and behavior as
                // either signed char or unsigned char.
                static BasicType::Kind chartype[] = { BasicType::SignedChar, BasicType::UnsignedChar, BasicType::Char };

                if ( td->length != DeclarationNode::NoLength ) {
                        throw SemanticError( string( "invalid type specifier " ) + DeclarationNode::lengthNames[ td->length ] + " in type: ", td );
                } // if

                ret = chartype[ td->signedness ];
                break;

          case DeclarationNode::Int:
                static BasicType::Kind inttype[2][4] = {
                        { BasicType::ShortSignedInt, BasicType::LongSignedInt, BasicType::LongLongSignedInt, BasicType::SignedInt },
                        { BasicType::ShortUnsignedInt, BasicType::LongUnsignedInt, BasicType::LongLongUnsignedInt, BasicType::UnsignedInt },
                };

          Integral: ;
                if ( td->signedness == DeclarationNode::NoSignedness ) {
                        const_cast<TypeData *>(td)->signedness = DeclarationNode::Signed;
                } // if
                ret = inttype[ td->signedness ][ td->length ];
                break;

          case DeclarationNode::Float:
          case DeclarationNode::Double:
          case DeclarationNode::LongDouble:                                     // not set until below
                static BasicType::Kind floattype[3][3] = {
                        { BasicType::FloatComplex, BasicType::DoubleComplex, BasicType::LongDoubleComplex },
                        { BasicType::FloatImaginary, BasicType::DoubleImaginary, BasicType::LongDoubleImaginary },
                        { BasicType::Float, BasicType::Double, BasicType::LongDouble },
                };

          FloatingPoint: ;
                if ( td->signedness != DeclarationNode::NoSignedness ) {
                        throw SemanticError( string( "invalid type specifier " ) + DeclarationNode::signednessNames[ td->signedness ] + " in type: ", td );
                } // if
                if ( td->length == DeclarationNode::Short || td->length == DeclarationNode::LongLong ) {
                        throw SemanticError( string( "invalid type specifier " ) + DeclarationNode::lengthNames[ td->length ] + " in type: ", td );
                } // if
                if ( td->basictype == DeclarationNode::Float && td->length == DeclarationNode::Long ) {
                        throw SemanticError( "invalid type specifier \"long\" in type: ", td );
                } // if
                if ( td->length == DeclarationNode::Long ) {
                        const_cast<TypeData *>(td)->basictype = DeclarationNode::LongDouble;
                } // if

                ret = floattype[ td->complextype ][ td->basictype - DeclarationNode::Float ];
                break;

          case DeclarationNode::NoBasicType:
                // No basic type in declaration => default double for Complex/Imaginary and int type for integral types
                if ( td->complextype == DeclarationNode::Complex || td->complextype == DeclarationNode::Imaginary ) {
                        const_cast<TypeData *>(td)->basictype = DeclarationNode::Double;
                        goto FloatingPoint;
                } // if

                const_cast<TypeData *>(td)->basictype = DeclarationNode::Int;
                goto Integral;
          default:
                assert(false);
                return nullptr;
        } // switch

        BasicType * bt = new BasicType( buildQualifiers( td ), ret );
        buildForall( td->forall, bt->get_forall() );
        return bt;
} // buildBasicType

PointerType * buildPointer( const TypeData * td ) {
        PointerType * pt;
        if ( td->base ) {
                pt = new PointerType( buildQualifiers( td ), typebuild( td->base ) );
        } else {
                pt = new PointerType( buildQualifiers( td ), new BasicType( Type::Qualifiers(), BasicType::SignedInt ) );
        } // if
        buildForall( td->forall, pt->get_forall() );
        return pt;
} // buildPointer

ArrayType * buildArray( const TypeData * td ) {
        ArrayType * at;
        if ( td->base ) {
                at = new ArrayType( buildQualifiers( td ), typebuild( td->base ), maybeBuild< Expression >( td->array.dimension ),
                                                        td->array.isVarLen, td->array.isStatic );
        } else {
                at = new ArrayType( buildQualifiers( td ), new BasicType( Type::Qualifiers(), BasicType::SignedInt ),
                                                        maybeBuild< Expression >( td->array.dimension ), td->array.isVarLen, td->array.isStatic );
        } // if
        buildForall( td->forall, at->get_forall() );
        return at;
} // buildPointer

AggregateDecl * buildAggregate( const TypeData * td, std::list< Attribute * > attributes ) {
        assert( td->kind == TypeData::Aggregate );
        AggregateDecl * at;
        switch ( td->aggregate.kind ) {
          case DeclarationNode::Struct:
          case DeclarationNode::Coroutine:
          case DeclarationNode::Monitor:
          case DeclarationNode::Thread:
                at = new StructDecl( *td->aggregate.name, td->aggregate.kind, attributes );
                buildForall( td->aggregate.params, at->get_parameters() );
                break;
          case DeclarationNode::Union:
                at = new UnionDecl( *td->aggregate.name, attributes );
                buildForall( td->aggregate.params, at->get_parameters() );
                break;
          case DeclarationNode::Trait:
                at = new TraitDecl( *td->aggregate.name, attributes );
                buildList( td->aggregate.params, at->get_parameters() );
                break;
          default:
                assert( false );
        } // switch

        buildList( td->aggregate.fields, at->get_members() );
        at->set_body( td->aggregate.body );

        return at;
} // buildAggregate

ReferenceToType * buildComAggInst( const TypeData * type, std::list< Attribute * > attributes ) {
        switch ( type->kind ) {
          case TypeData::Enum: {
                  if ( type->enumeration.body ) {
                          EnumDecl * typedecl = buildEnum( type, attributes );
                          return new EnumInstType( buildQualifiers( type ), typedecl );
                  } else {
                          return new EnumInstType( buildQualifiers( type ), *type->enumeration.name );
                  } // if
          }
          case TypeData::Aggregate: {
                  ReferenceToType * ret;
                  if ( type->aggregate.body ) {
                          AggregateDecl * typedecl = buildAggregate( type, attributes );
                          switch ( type->aggregate.kind ) {
                                case DeclarationNode::Struct:
                                case DeclarationNode::Coroutine:
                                case DeclarationNode::Monitor:
                                case DeclarationNode::Thread:
                                  ret = new StructInstType( buildQualifiers( type ), (StructDecl *)typedecl );
                                  break;
                                case DeclarationNode::Union:
                                  ret = new UnionInstType( buildQualifiers( type ), (UnionDecl *)typedecl );
                                  break;
                                case DeclarationNode::Trait:
                                  assert( false );
                                  //ret = new TraitInstType( buildQualifiers( type ), (TraitDecl *)typedecl );
                                  break;
                                default:
                                  assert( false );
                          } // switch
                  } else {
                          switch ( type->aggregate.kind ) {
                                case DeclarationNode::Struct:
                                case DeclarationNode::Coroutine:
                                case DeclarationNode::Monitor:
                                case DeclarationNode::Thread:
                                  ret = new StructInstType( buildQualifiers( type ), *type->aggregate.name );
                                  break;
                                case DeclarationNode::Union:
                                  ret = new UnionInstType( buildQualifiers( type ), *type->aggregate.name );
                                  break;
                                case DeclarationNode::Trait:
                                  ret = new TraitInstType( buildQualifiers( type ), *type->aggregate.name );
                                  break;
                                default:
                                  assert( false );
                          } // switch
                  } // if
                  return ret;
          }
          default:
                assert( false );
        } // switch
} // buildAggInst

ReferenceToType * buildAggInst( const TypeData * td ) {
        assert( td->kind == TypeData::AggregateInst );

        // ReferenceToType * ret = buildComAggInst( td->aggInst.aggregate, std::list< Attribute * >() );
        ReferenceToType * ret = nullptr;
        TypeData * type = td->aggInst.aggregate;
        switch ( type->kind ) {
          case TypeData::Enum: {
                  return new EnumInstType( buildQualifiers( type ), *type->enumeration.name );
          }
          case TypeData::Aggregate: {
                  switch ( type->aggregate.kind ) {
                        case DeclarationNode::Struct:
                        case DeclarationNode::Coroutine:
                        case DeclarationNode::Monitor:
                        case DeclarationNode::Thread:
                          ret = new StructInstType( buildQualifiers( type ), *type->aggregate.name );
                          break;
                        case DeclarationNode::Union:
                          ret = new UnionInstType( buildQualifiers( type ), *type->aggregate.name );
                          break;
                        case DeclarationNode::Trait:
                          ret = new TraitInstType( buildQualifiers( type ), *type->aggregate.name );
                          break;
                        default:
                          assert( false );
                  } // switch
          }
          break;
          default:
                assert( false );
        } // switch

        ret->set_hoistType( td->aggInst.hoistType );
        buildList( td->aggInst.params, ret->get_parameters() );
        buildForall( td->forall, ret->get_forall() );
        return ret;
} // buildAggInst

NamedTypeDecl * buildSymbolic( const TypeData * td, const string & name, Type::StorageClasses scs ) {
        assert( td->kind == TypeData::Symbolic );
        NamedTypeDecl * ret;
        assert( td->base );
        if ( td->symbolic.isTypedef ) {
                ret = new TypedefDecl( name, scs, typebuild( td->base ) );
        } else {
                ret = new TypeDecl( name, scs, typebuild( td->base ), TypeDecl::Any );
        } // if
        buildList( td->symbolic.params, ret->get_parameters() );
        buildList( td->symbolic.assertions, ret->get_assertions() );
        return ret;
} // buildSymbolic

EnumDecl * buildEnum( const TypeData * td, std::list< Attribute * > attributes ) {
        assert( td->kind == TypeData::Enum );
        EnumDecl * ret = new EnumDecl( *td->enumeration.name, attributes );
        buildList( td->enumeration.constants, ret->get_members() );
        list< Declaration * >::iterator members = ret->get_members().begin();
        for ( const DeclarationNode * cur = td->enumeration. constants; cur != nullptr; cur = dynamic_cast< DeclarationNode * >( cur->get_next() ), ++members ) {
                if ( cur->has_enumeratorValue() ) {
                        ObjectDecl * member = dynamic_cast< ObjectDecl * >(* members);
                        member->set_init( new SingleInit( maybeMoveBuild< Expression >( cur->consume_enumeratorValue() ), list< Expression * >() ) );
                } // if
        } // for
        ret->set_body( td->enumeration.body );
        return ret;
} // buildEnum

TypeInstType * buildSymbolicInst( const TypeData * td ) {
        assert( td->kind == TypeData::SymbolicInst );
        TypeInstType * ret = new TypeInstType( buildQualifiers( td ), *td->symbolic.name, false );
        buildList( td->symbolic.actuals, ret->get_parameters() );
        buildForall( td->forall, ret->get_forall() );
        return ret;
} // buildSymbolicInst

TupleType * buildTuple( const TypeData * td ) {
        assert( td->kind == TypeData::Tuple );
        TupleType * ret = new TupleType( buildQualifiers( td ) );
        buildTypeList( td->tuple, ret->get_types() );
        buildForall( td->forall, ret->get_forall() );
        return ret;
} // buildTuple

TypeofType * buildTypeof( const TypeData * td ) {
        assert( td->kind == TypeData::Typeof );
        assert( td->typeexpr );
        // assert( td->typeexpr->expr );
        return new TypeofType( buildQualifiers( td ), td->typeexpr->build() );
} // buildTypeof

Declaration * buildDecl( const TypeData * td, const string &name, Type::StorageClasses scs, Expression * bitfieldWidth, Type::FuncSpecifiers funcSpec, LinkageSpec::Spec linkage, ConstantExpr *asmName, Initializer * init, std::list< Attribute * > attributes ) {
        if ( td->kind == TypeData::Function ) {
                if ( td->function.idList ) {                                    // KR function ?
                        buildKRFunction( td->function );                        // transform into C11 function
                } // if

                FunctionDecl * decl;
                Statement * stmt = maybeBuild<Statement>( td->function.body );
                CompoundStmt * body = dynamic_cast< CompoundStmt * >( stmt );
                decl = new FunctionDecl( name, scs, linkage, buildFunction( td ), body, attributes, funcSpec );
                return decl->set_asmName( asmName );
        } else if ( td->kind == TypeData::Aggregate ) {
                return buildAggregate( td, attributes );
        } else if ( td->kind == TypeData::Enum ) {
                return buildEnum( td, attributes );
        } else if ( td->kind == TypeData::Symbolic ) {
                return buildSymbolic( td, name, scs );
        } else {
                return (new ObjectDecl( name, scs, linkage, bitfieldWidth, typebuild( td ), init, attributes ))->set_asmName( asmName );
        } // if
        return nullptr;
} // buildDecl

FunctionType * buildFunction( const TypeData * td ) {
        assert( td->kind == TypeData::Function );
        bool hasEllipsis = td->function.params ? td->function.params->get_hasEllipsis() : true;
        if ( ! td->function.params ) hasEllipsis = ! td->function.newStyle;
        FunctionType * ft = new FunctionType( buildQualifiers( td ), hasEllipsis );
        buildList( td->function.params, ft->get_parameters() );
        buildForall( td->forall, ft->get_forall() );
        if ( td->base ) {
                switch ( td->base->kind ) {
                  case TypeData::Tuple:
                        buildList( td->base->tuple, ft->get_returnVals() );
                        break;
                  default:
                        ft->get_returnVals().push_back( dynamic_cast< DeclarationWithType * >( buildDecl( td->base, "", Type::StorageClasses(), nullptr, Type::FuncSpecifiers(), LinkageSpec::Cforall, nullptr ) ) );
                } // switch
        } else {
                ft->get_returnVals().push_back( new ObjectDecl( "", Type::StorageClasses(), LinkageSpec::Cforall, nullptr, new BasicType( Type::Qualifiers(), BasicType::SignedInt ), nullptr ) );
        } // if
        return ft;
} // buildFunction

// Transform KR routine declarations into C99 routine declarations:
//
//    rtn( a, b, c ) int a, c; double b {}  =>  int rtn( int a, double c, int b ) {}
//
// The type information for each post-declaration is moved to the corresponding pre-parameter and the post-declaration
// is deleted. Note, the order of the parameter names may not be the same as the declaration names. Duplicate names and
// extra names are disallowed.
//
// Note, there is no KR routine-prototype syntax:
//
//    rtn( a, b, c ) int a, c; double b; // invalid KR prototype
//    rtn(); // valid KR prototype

void buildKRFunction( const TypeData::Function_t & function ) {
        assert( ! function.params );
        // loop over declaration first as it is easier to spot errors
        for ( DeclarationNode * decl = function.oldDeclList; decl != nullptr; decl = dynamic_cast< DeclarationNode * >( decl->get_next() ) ) {
                // scan ALL parameter names for each declaration name to check for duplicates
                for ( DeclarationNode * param = function.idList; param != nullptr; param = dynamic_cast< DeclarationNode * >( param->get_next() ) ) {
                        if ( *decl->name == *param->name ) {
                                // type set => parameter name already transformed by a declaration names so there is a duplicate
                                // declaration name attempting a second transformation
                                if ( param->type ) throw SemanticError( string( "duplicate declaration name " ) + *param->name );
                                // declaration type reset => declaration already transformed by a parameter name so there is a duplicate
                                // parameter name attempting a second transformation
                                if ( ! decl->type ) throw SemanticError( string( "duplicate parameter name " ) + *param->name );
                                param->type = decl->type;                               // set copy declaration type to parameter type
                                decl->type = nullptr;                                   // reset declaration type
                                param->attributes.splice( param->attributes.end(), decl->attributes ); // copy and reset attributes from declaration to parameter
                        } // if
                } // for
                // declaration type still set => type not moved to a matching parameter so there is a missing parameter name
                if ( decl->type ) throw SemanticError( string( "missing name in parameter list " ) + *decl->name );
        } // for

        // Parameter names without a declaration default to type int:
        //
        //    rtb( a, b, c ) const char * b; {} => int rtn( int a, const char * b, int c ) {}

        for ( DeclarationNode * param = function.idList; param != nullptr; param = dynamic_cast< DeclarationNode * >( param->get_next() ) ) {
                if ( ! param->type ) {                                                  // generate type int for empty parameter type
                        param->type = new TypeData( TypeData::Basic );
                        param->type->basictype = DeclarationNode::Int;
                } // if
        } // for

        function.params = function.idList;                                      // newly modified idList becomes parameters
        function.idList = nullptr;                                                      // idList now empty
        delete function.oldDeclList;                                            // deletes entire list
        function.oldDeclList = nullptr;                                         // reset
} // buildKRFunction

// Local Variables: //
// tab-width: 4 //
// mode: c++ //
// compile-command: "make install" //
// End: //