qt-creator/src/shared/cplusplus/Semantic.cpp

/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** 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.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
// 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 "Semantic.h"
#include "TranslationUnit.h"
#include "Control.h"
#include "Scope.h"
#include "Symbols.h"
#include "Token.h"
#include "AST.h"
#include "CheckSpecifier.h"
#include "CheckDeclaration.h"
#include "CheckDeclarator.h"
#include "CheckStatement.h"
#include "CheckExpression.h"
#include "CheckName.h"

using namespace CPlusPlus;

SemanticClient::SemanticClient(Semantic *semantic)
    : _semantic(semantic)
{
}

SemanticClient::~SemanticClient()
{
}

Semantic *SemanticClient::semantic() const
{
    return _semantic;
}

class Semantic::Data
{
public:
    Data(Semantic *semantic, TranslationUnit *translationUnit)
        : semantic(semantic),
          translationUnit(translationUnit),
          control(translationUnit->control()),
          semanticClient(0),
          skipFunctionBodies(false),
          visibility(Symbol::Public),
          ojbcVisibility(Symbol::Protected),
          methodKey(Function::NormalMethod),
          declaringClass(0),
          checkSpecifier(0),
          checkDeclaration(0),
          checkDeclarator(0),
          checkExpression(0),
          checkStatement(0),
          checkName(0)
    { }

    ~Data()
    {
        delete checkSpecifier;
        delete checkDeclaration;
        delete checkDeclarator;
        delete checkExpression;
        delete checkStatement;
        delete checkName;
    }

    Semantic *semantic;
    TranslationUnit *translationUnit;
    Control *control;
    SemanticClient *semanticClient;
    bool skipFunctionBodies;
    int visibility;
    int ojbcVisibility;
    int methodKey;
    ClassSpecifierAST *declaringClass;
    CheckSpecifier *checkSpecifier;
    CheckDeclaration *checkDeclaration;
    CheckDeclarator *checkDeclarator;
    CheckExpression *checkExpression;
    CheckStatement *checkStatement;
    CheckName *checkName;
    std::vector<FunctionDefinitionAST *> functionsToProcess;
};

Semantic::Semantic(TranslationUnit *translationUnit)
{
    d = new Data(this, translationUnit);
    d->checkSpecifier = new CheckSpecifier(this);
    d->checkDeclaration = new CheckDeclaration(this);
    d->checkDeclarator = new CheckDeclarator(this);
    d->checkExpression = new CheckExpression(this);
    d->checkStatement = new CheckStatement(this);
    d->checkName = new CheckName(this);
}

Semantic::~Semantic()
{ delete d; }

SemanticClient *Semantic::semanticClient() const
{ return d->semanticClient; }

void Semantic::setSemanticClient(SemanticClient *client)
{ d->semanticClient = client; }

TranslationUnit *Semantic::translationUnit() const
{ return d->translationUnit; }

Control *Semantic::control() const
{ return d->control; }

FullySpecifiedType Semantic::check(SpecifierListAST *specifier, Scope *scope,
                                   const FullySpecifiedType &type)
{ return d->checkSpecifier->check(specifier, scope, type); }

void Semantic::check(DeclarationAST *declaration, Scope *scope)
{ d->checkDeclaration->check(declaration, scope); }

FullySpecifiedType Semantic::check(DeclaratorAST *declarator, const FullySpecifiedType &type,
                                   Scope *scope, const Name **name)
{ return d->checkDeclarator->check(declarator, type, scope, name); }

FullySpecifiedType Semantic::check(PtrOperatorListAST *ptrOperators, const FullySpecifiedType &type, Scope *scope)
{ return d->checkDeclarator->check(ptrOperators, type, scope); }

FullySpecifiedType Semantic::check(ObjCMethodPrototypeAST *methodPrototype, Scope *scope)
{ return d->checkDeclarator->check(methodPrototype, scope); }

void Semantic::check(ObjCMessageArgumentDeclarationAST *arg, Scope *scope)
{ return d->checkName->check(arg, scope); }

FullySpecifiedType Semantic::check(ExpressionAST *expression, Scope *scope)
{ return d->checkExpression->check(expression, scope); }

FullySpecifiedType Semantic::check(StatementAST *statement, Scope *scope)
{ return d->checkStatement->check(statement, scope); }

const Name *Semantic::check(NameAST *name, Scope *scope)
{ return d->checkName->check(name, scope); }

const Name *Semantic::check(NestedNameSpecifierListAST *name, Scope *scope)
{ return d->checkName->check(name, scope); }

void Semantic::checkFunctionDefinition(FunctionDefinitionAST *ast)
{
    if (d->declaringClass != 0)
        d->functionsToProcess.push_back(ast);
    else
        finishFunctionDefinition(ast);
}

void Semantic::finishFunctionDefinition(FunctionDefinitionAST *ast)
{
    const int previousVisibility = switchVisibility(Symbol::Public);
    const int previousMethodKey = switchMethodKey(Function::NormalMethod);

    Function *fun = ast->symbol;
    d->checkDeclaration->check(ast->ctor_initializer, fun->scope());

    if (ast->function_body) {
        check(ast->function_body, fun);

        if (CompoundStatementAST *c = ast->function_body->asCompoundStatement())
            fun->setBlock(c->symbol);
    }

    switchMethodKey(previousMethodKey);
    switchVisibility(previousVisibility);
}

bool Semantic::skipFunctionBodies() const
{ return d->skipFunctionBodies; }

void Semantic::setSkipFunctionBodies(bool skipFunctionBodies)
{ d->skipFunctionBodies = skipFunctionBodies; }

int Semantic::currentVisibility() const
{ return d->visibility; }

int Semantic::switchVisibility(int visibility)
{
    int previousVisibility = d->visibility;
    d->visibility = visibility;
    return previousVisibility;
}

int Semantic::currentObjCVisibility() const
{ return d->ojbcVisibility; }

int Semantic::switchObjCVisibility(int visibility)
{
    int previousOjbCVisibility = d->ojbcVisibility;
    d->ojbcVisibility = visibility;
    return previousOjbCVisibility;
}

int Semantic::currentMethodKey() const
{ return d->methodKey; }

int Semantic::switchMethodKey(int methodKey)
{
    int previousMethodKey = d->methodKey;
    d->methodKey = methodKey;
    return previousMethodKey;
}

ClassSpecifierAST *Semantic::declatingClass() const
{ return d->declaringClass; }

ClassSpecifierAST *Semantic::switchDeclaringClass(ClassSpecifierAST *ast)
{
    ClassSpecifierAST *previous = d->declaringClass;
    d->declaringClass = ast;

    if (! ast && ! d->functionsToProcess.empty()) {
        const std::vector<FunctionDefinitionAST *> todo = d->functionsToProcess;
        d->functionsToProcess.clear();

        for (std::vector<FunctionDefinitionAST *>::const_iterator it = todo.begin(); it != todo.end(); ++it)
            finishFunctionDefinition(*it);
    }

    return previous;
}

int Semantic::visibilityForAccessSpecifier(int tokenKind) const
{
    switch (tokenKind) {
    case T_PUBLIC:
        return Symbol::Public;
    case T_PROTECTED:
        return Symbol::Protected;
    case T_PRIVATE:
        return Symbol::Private;
    case T_Q_SIGNALS:
        return Symbol::Protected;
    default:
        return Symbol::Public;
    }
}

int Semantic::visibilityForObjCAccessSpecifier(int tokenKind) const
{
    switch (tokenKind) {
    case T_AT_PUBLIC:
        return Symbol::Public;
    case T_AT_PROTECTED:
        return Symbol::Protected;
    case T_AT_PRIVATE:
        return Symbol::Private;
    case T_AT_PACKAGE:
        return Symbol::Package;
    default:
        return Symbol::Protected;
    }
}

bool Semantic::isObjCClassMethod(int tokenKind) const
{
    switch (tokenKind) {
    case T_PLUS:
        return true;
    case T_MINUS:
    default:
        return false;
    }
}

int Semantic::visibilityForClassKey(int tokenKind) const
{
    switch (tokenKind) {
    case T_CLASS:
        return Symbol::Private;
    case T_STRUCT:
    case T_UNION:
        return Symbol::Public;
    default:
        return Symbol::Public;
    }
}

unsigned Semantic::location(DeclaratorAST *ast) const
{
    if (! ast)
        return 0;

    else if (CPlusPlus::CoreDeclaratorAST *core = ast->core_declarator)
        return location(core);

    return ast->firstToken();
}

unsigned Semantic::location(CoreDeclaratorAST *ast) const
{
    if (! ast)
        return 0;

    else if (CPlusPlus::DeclaratorIdAST *declaratorId = ast->asDeclaratorId())
        return location(declaratorId->name);

    else if (CPlusPlus::NestedDeclaratorAST *nested = ast->asNestedDeclarator())
        return location(nested->declarator);

    return ast->firstToken();
}

unsigned Semantic::location(NameAST *ast) const
{
    if (! ast)
        return 0;

    else if (CPlusPlus::QualifiedNameAST *qualifiedName = ast->asQualifiedName())
        return location(qualifiedName->unqualified_name);

    return ast->firstToken();
}