/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the Qt Mobility Components.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

// Copyright (c) 2008 Roberto Raggi <roberto.raggi@gmail.com>

//

// Permission is hereby granted, free of charge, to any person obtaining a copy

// of this software and associated documentation files (the "Software"), to deal

// in the Software without restriction, including without limitation the rights

// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

// copies of the Software, and to permit persons to whom the Software is

// furnished to do so, subject to the following conditions:

//

// The above copyright notice and this permission notice shall be included in

// all copies or substantial portions of the Software.

//

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

// THE SOFTWARE.

#include "Control.h"

#include "Literals.h"

#include "LiteralTable.h"

#include "TranslationUnit.h"

#include "CoreTypes.h"

#include "Symbols.h"

#include "Names.h"

#include "Array.h"

#include "TypeMatcher.h"

#include <map>

#include <set>

using namespace CPlusPlus;

namespace {

template <typename _Tp>

struct Compare;

template <> struct Compare<IntegerType>

{

    bool operator()(const IntegerType &ty, const IntegerType &otherTy) const

    { return ty.kind() < otherTy.kind(); }

};

template <> struct Compare<FloatType>

{

    bool operator()(const FloatType &ty, const FloatType &otherTy) const

    { return ty.kind() < otherTy.kind(); }

};

template <> struct Compare<PointerToMemberType>

{

    bool operator()(const PointerToMemberType &ty, const PointerToMemberType &otherTy) const

    {

        if (ty.memberName() < otherTy.memberName())

            return true;

        else if (ty.memberName() == otherTy.memberName())

            return ty.elementType() < otherTy.elementType();

        return false;

    }

};

template <> struct Compare<PointerType>

{

    bool operator()(const PointerType &ty, const PointerType &otherTy) const

    {

        return ty.elementType() < otherTy.elementType();

    }

};

template <> struct Compare<ReferenceType>

{

    bool operator()(const ReferenceType &ty, const ReferenceType &otherTy) const

    {

        return ty.elementType() < otherTy.elementType();

    }

};

template <> struct Compare<NamedType>

{

    bool operator()(const NamedType &ty, const NamedType &otherTy) const

    {

        return ty.name() < otherTy.name();

    }

};

template <> struct Compare<ArrayType>

{

    bool operator()(const ArrayType &ty, const ArrayType &otherTy) const

    {

        if (ty.size() < otherTy.size())

            return true;

        else if (ty.size() == otherTy.size())

            return ty.elementType() < otherTy.elementType();

        return false;

    }

};

template <> struct Compare<NameId>

{

    bool operator()(const NameId &name, const NameId &otherName) const

    {

        return name.identifier() < otherName.identifier();

    }

};

template <> struct Compare<DestructorNameId>

{

    bool operator()(const DestructorNameId &name, const DestructorNameId &otherName) const

    {

        return name.identifier() < otherName.identifier();

    }

};

template <> struct Compare<OperatorNameId>

{

    bool operator()(const OperatorNameId &name, const OperatorNameId &otherName) const

    {

        return name.kind() < otherName.kind();

    }

};

template <> struct Compare<ConversionNameId>

{

    bool operator()(const ConversionNameId &name, const ConversionNameId &otherName) const

    {

        return name.type() < otherName.type();

    }

};

template <> struct Compare<TemplateNameId>

{

    bool operator()(const TemplateNameId &name, const TemplateNameId &otherName) const

    {

        const Identifier *id = name.identifier();

        const Identifier *otherId = otherName.identifier();

        if (id == otherId)

            return std::lexicographical_compare(name.firstTemplateArgument(), name.lastTemplateArgument(),

                                                otherName.firstTemplateArgument(), otherName.lastTemplateArgument());

        return id < otherId;

    }

};

template <> struct Compare<QualifiedNameId>

{

    bool operator()(const QualifiedNameId &name, const QualifiedNameId &otherName) const

    {

        if (name.isGlobal() == otherName.isGlobal())

            return std::lexicographical_compare(name.firstName(), name.lastName(),

                                                otherName.firstName(), otherName.lastName());

        return name.isGlobal() < otherName.isGlobal();

    }

};

template <> struct Compare<SelectorNameId>

{

    bool operator()(const SelectorNameId &name, const SelectorNameId &otherName) const

    {

        if (name.hasArguments() == otherName.hasArguments())

            return std::lexicographical_compare(name.firstName(), name.lastName(),

                                                otherName.firstName(), otherName.lastName());

        return name.hasArguments() < otherName.hasArguments();

    }

};

template <typename _Tp>

class Table: public std::set<_Tp, Compare<_Tp> >

{

    typedef std::set<_Tp, Compare<_Tp> > _Base;

public:

    _Tp *intern(const _Tp &element)

    { return const_cast<_Tp *>(&*_Base::insert(element).first); }

};

} // end of anonymous namespace

#ifdef ICHECK_BUILD

//Symbian compiler has some difficulties to understand the templates.

static void delete_array_entries(std::vector<Symbol *> vt)

{

    std::vector<Symbol *>::iterator it;

    for (it = vt.begin(); it != vt.end(); ++it) {

        delete *it;

    }

}

#else

template <typename _Iterator>

static void delete_array_entries(_Iterator first, _Iterator last)

{

    for (; first != last; ++first)

        delete *first;

}

template <typename _Array>

static void delete_array_entries(const _Array &a)

{ delete_array_entries(a.begin(), a.end()); }

#endif

class Control::Data

{

public:

    Data(Control *control)

        : control(control),

          translationUnit(0),

          diagnosticClient(0)

    {}

    ~Data()

    {

        // symbols

        delete_array_entries(symbols);

    }

    const NameId *findOrInsertNameId(const Identifier *id)

    {

        if (! id)

            return 0;

        return nameIds.intern(NameId(id));

    }

    template <typename _Iterator>

    const TemplateNameId *findOrInsertTemplateNameId(const Identifier *id, _Iterator first, _Iterator last)

    {

        return templateNameIds.intern(TemplateNameId(id, first, last));

    }

    const DestructorNameId *findOrInsertDestructorNameId(const Identifier *id)

    {

        return destructorNameIds.intern(DestructorNameId(id));

    }

    const OperatorNameId *findOrInsertOperatorNameId(int kind)

    {

        return operatorNameIds.intern(OperatorNameId(kind));

    }

    const ConversionNameId *findOrInsertConversionNameId(const FullySpecifiedType &type)

    {

        return conversionNameIds.intern(ConversionNameId(type));

    }

    template <typename _Iterator>

    const QualifiedNameId *findOrInsertQualifiedNameId(_Iterator first, _Iterator last, bool isGlobal)

    {

        return qualifiedNameIds.intern(QualifiedNameId(first, last, isGlobal));

    }

    template <typename _Iterator>

    const SelectorNameId *findOrInsertSelectorNameId(_Iterator first, _Iterator last, bool hasArguments)

    {

        return selectorNameIds.intern(SelectorNameId(first, last, hasArguments));

    }

    IntegerType *findOrInsertIntegerType(int kind)

    {

        return integerTypes.intern(IntegerType(kind));

    }

    FloatType *findOrInsertFloatType(int kind)

    {

        return floatTypes.intern(FloatType(kind));

    }

    PointerToMemberType *findOrInsertPointerToMemberType(const Name *memberName, const FullySpecifiedType &elementType)

    {

        return pointerToMemberTypes.intern(PointerToMemberType(memberName, elementType));

    }

    PointerType *findOrInsertPointerType(const FullySpecifiedType &elementType)

    {

        return pointerTypes.intern(PointerType(elementType));

    }

    ReferenceType *findOrInsertReferenceType(const FullySpecifiedType &elementType)

    {

        return referenceTypes.intern(ReferenceType(elementType));

    }

    ArrayType *findOrInsertArrayType(const FullySpecifiedType &elementType, unsigned size)

    {

        return arrayTypes.intern(ArrayType(elementType, size));

    }

    NamedType *findOrInsertNamedType(const Name *name)

    {

        return namedTypes.intern(NamedType(name));

    }

    Declaration *newDeclaration(unsigned sourceLocation, const Name *name)

    {

        Declaration *declaration = new Declaration(translationUnit,

                                                   sourceLocation, name);

        symbols.push_back(declaration);

        return declaration;

    }

    Argument *newArgument(unsigned sourceLocation, const Name *name)

    {

        Argument *argument = new Argument(translationUnit,

                                          sourceLocation, name);

        symbols.push_back(argument);

        return argument;

    }

    TypenameArgument *newTypenameArgument(unsigned sourceLocation, const Name *name)

    {

        TypenameArgument *argument = new TypenameArgument(translationUnit,

                                                          sourceLocation, name);

        symbols.push_back(argument);

        return argument;

    }

    Function *newFunction(unsigned sourceLocation, const Name *name)

    {

        Function *function = new Function(translationUnit,

                                          sourceLocation, name);

        symbols.push_back(function);

        return function;

    }

    BaseClass *newBaseClass(unsigned sourceLocation, const Name *name)

    {

        BaseClass *baseClass = new BaseClass(translationUnit,

                                             sourceLocation, name);

        symbols.push_back(baseClass);

        return baseClass;

    }

    Block *newBlock(unsigned sourceLocation)

    {

        Block *block = new Block(translationUnit, sourceLocation);

        symbols.push_back(block);

        return block;

    }

    Class *newClass(unsigned sourceLocation, const Name *name)

    {

        Class *klass = new Class(translationUnit,

                                 sourceLocation, name);

        symbols.push_back(klass);

        return klass;

    }

    Namespace *newNamespace(unsigned sourceLocation, const Name *name)

    {

        Namespace *ns = new Namespace(translationUnit,

                                      sourceLocation, name);

        symbols.push_back(ns);

        return ns;

    }

    UsingNamespaceDirective *newUsingNamespaceDirective(unsigned sourceLocation, const Name *name)

    {

        UsingNamespaceDirective *u = new UsingNamespaceDirective(translationUnit,

                                                                 sourceLocation, name);

        symbols.push_back(u);

        return u;

    }

    ForwardClassDeclaration *newForwardClassDeclaration(unsigned sourceLocation, const Name *name)

    {

        ForwardClassDeclaration *c = new ForwardClassDeclaration(translationUnit,

                                                                 sourceLocation, name);

        symbols.push_back(c);

        return c;

    }

    ObjCBaseClass *newObjCBaseClass(unsigned sourceLocation, const Name *name)

    {

        ObjCBaseClass *c = new ObjCBaseClass(translationUnit, sourceLocation, name);

        symbols.push_back(c);

        return c;

    }

    ObjCBaseProtocol *newObjCBaseProtocol(unsigned sourceLocation, const Name *name)

    {

        ObjCBaseProtocol *p = new ObjCBaseProtocol(translationUnit, sourceLocation, name);

        symbols.push_back(p);

        return p;

    }

    ObjCClass *newObjCClass(unsigned sourceLocation, const Name *name)

    {

        ObjCClass *c = new ObjCClass(translationUnit, sourceLocation, name);

        symbols.push_back(c);

        return c;

    }

    ObjCForwardClassDeclaration *newObjCForwardClassDeclaration(unsigned sourceLocation, const Name *name)

    {

        ObjCForwardClassDeclaration *fwd = new ObjCForwardClassDeclaration(translationUnit, sourceLocation, name);

        symbols.push_back(fwd);

        return fwd;

    }

    ObjCProtocol *newObjCProtocol(unsigned sourceLocation, const Name *name)

    {

        ObjCProtocol *p = new ObjCProtocol(translationUnit, sourceLocation, name);

        symbols.push_back(p);

        return p;

    }

    ObjCForwardProtocolDeclaration *newObjCForwardProtocolDeclaration(unsigned sourceLocation, const Name *name)

    {

        ObjCForwardProtocolDeclaration *fwd = new ObjCForwardProtocolDeclaration(translationUnit, sourceLocation, name);

        symbols.push_back(fwd);

        return fwd;

    }

    ObjCMethod *newObjCMethod(unsigned sourceLocation, const Name *name)

    {

        ObjCMethod *method = new ObjCMethod(translationUnit, sourceLocation, name);

        symbols.push_back(method);

        return method;

    }

    ObjCPropertyDeclaration *newObjCPropertyDeclaration(unsigned sourceLocation, const Name *name)

    {

        ObjCPropertyDeclaration *decl = new ObjCPropertyDeclaration(translationUnit, sourceLocation, name);

        symbols.push_back(decl);

        return decl;

    }

    Enum *newEnum(unsigned sourceLocation, const Name *name)

    {

        Enum *e = new Enum(translationUnit,

                           sourceLocation, name);

        symbols.push_back(e);

        return e;

    }

    UsingDeclaration *newUsingDeclaration(unsigned sourceLocation, const Name *name)

    {

        UsingDeclaration *u = new UsingDeclaration(translationUnit,

                                                   sourceLocation, name);

        symbols.push_back(u);

        return u;

    }

    Control *control;

    TranslationUnit *translationUnit;

    DiagnosticClient *diagnosticClient;

    TypeMatcher matcher;

    LiteralTable<Identifier> identifiers;

    LiteralTable<StringLiteral> stringLiterals;

    LiteralTable<NumericLiteral> numericLiterals;

    // ### replace std::map with lookup tables. ASAP!

    // names

    Table<NameId> nameIds;

    Table<DestructorNameId> destructorNameIds;

    Table<OperatorNameId> operatorNameIds;

    Table<ConversionNameId> conversionNameIds;

    Table<TemplateNameId> templateNameIds;

    Table<QualifiedNameId> qualifiedNameIds;

    Table<SelectorNameId> selectorNameIds;

    // types

    VoidType voidType;

    Table<IntegerType> integerTypes;

    Table<FloatType> floatTypes;

    Table<PointerToMemberType> pointerToMemberTypes;

    Table<PointerType> pointerTypes;

    Table<ReferenceType> referenceTypes;

    Table<ArrayType> arrayTypes;

    Table<NamedType> namedTypes;

    // symbols

    std::vector<Symbol *> symbols;

    // ObjC context keywords:

    const Identifier *objcGetterId;

    const Identifier *objcSetterId;

    const Identifier *objcReadwriteId;

    const Identifier *objcReadonlyId;

    const Identifier *objcAssignId;

    const Identifier *objcRetainId;