~ubuntu-branches/ubuntu/utopic/kdevelop-php/utopic

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

 *   This file is part of KDevelop                                         *

 *   Copyright 2008 Niko Sams <niko.sams@gmail.com>                        *

 *                                                                         *

 *   This program is free software; you can redistribute it and/or modify  *

 *   it under the terms of the GNU Library General Public License as       *

 *   published by the Free Software Foundation; either version 2 of the    *

 *   License, or (at your option) any later version.                       *

 *                                                                         *

 *   This program is distributed in the hope that it will be useful,       *

 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *

 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *

 *   GNU General Public License for more details.                          *

 *                                                                         *

 *   You should have received a copy of the GNU Library General Public     *

 *   License along with this program; if not, write to the                 *

 *   Free Software Foundation, Inc.,                                       *

 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.         *

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

 

#ifndef CONTEXTBUILDER_H

#define CONTEXTBUILDER_H

 

#include "phpdefaultvisitor.h"

#include <language/duchain/builders/abstractcontextbuilder.h>

 

#include "phpduchainexport.h"

#include "editorintegrator.h"

#include "helper.h"

 

 

namespace Php

{

class EditorIntegrator;

class ParseSession;

 

typedef KDevelop::AbstractContextBuilder<AstNode, IdentifierAst> ContextBuilderBase;

 

/// first is the "pretty" identifier used for printing

/// second comes the all-lowercase identifier used for storage

typedef QPair<QString, KDevelop::QualifiedIdentifier> IdentifierPair;

 

class KDEVPHPDUCHAIN_EXPORT ContextBuilder: public ContextBuilderBase, public DefaultVisitor

{

 

public:

    ContextBuilder();

    virtual ~ContextBuilder();

 

    void setEditor(EditorIntegrator* editor);

    void setEditor(ParseSession* session);

    virtual KDevelop::ReferencedTopDUContext build(const KDevelop::IndexedString& url, AstNode* node,

            KDevelop::ReferencedTopDUContext updateContext

            = KDevelop::ReferencedTopDUContext(), bool useSmart = true);

protected:

    EditorIntegrator* editor() const;

 

    virtual KDevelop::DUContext* newContext(const KDevelop::SimpleRange& range);

    virtual KDevelop::TopDUContext* newTopContext(const KDevelop::SimpleRange& range, KDevelop::ParsingEnvironmentFile* file = 0);

 

    virtual void startVisiting(AstNode* node);

    virtual void setContextOnNode(AstNode* node, KDevelop::DUContext* ctx);

    virtual KDevelop::DUContext* contextFromNode(AstNode* node);

    virtual KTextEditor::Range editorFindRange(AstNode* fromRange, AstNode* toRange);

 

    virtual KDevelop::QualifiedIdentifier identifierForNode(IdentifierAst* id);

    KDevelop::QualifiedIdentifier identifierForNode(VariableIdentifierAst* id);

    IdentifierPair identifierPairForNode(IdentifierAst* id);

    QString stringForNode(IdentifierAst* node) const;

    QString stringForNode(VariableIdentifierAst* node) const;

 

    virtual void visitClassDeclarationStatement(ClassDeclarationStatementAst*);

    virtual void visitInterfaceDeclarationStatement(InterfaceDeclarationStatementAst* node);

    virtual void visitClassStatement(ClassStatementAst *node);

    virtual void visitFunctionDeclarationStatement(FunctionDeclarationStatementAst* node);

    virtual void visitUnaryExpression(UnaryExpressionAst* node);

 

    virtual void addBaseType(IdentifierAst * identifier);

 

    virtual void classContextOpened(KDevelop::DUContext* context);

 

    /// Report @p errorMsg with the range of @p node

    /// @see void reportError(const QString& errorMsg, KTextEditor::Range range);

    void reportError(const QString& errorMsg, AstNode* node,

                        KDevelop::ProblemData::Severity severity = KDevelop::ProblemData::Error);

    /// Report @p errorMsg with the range encompassing all nodes in @p nodes

    /// @see void reportError(const QString& errorMsg, KTextEditor::Range range);

    void reportError(const QString& errorMsg, QList<AstNode*> nodes,

                        KDevelop::ProblemData::Severity severity = KDevelop::ProblemData::Error);

    /// Report @p errorMsg with range @p range

    void reportError(const QString& errorMsg, KTextEditor::Range range,

                        KDevelop::ProblemData::Severity severity = KDevelop::ProblemData::Error);

 

    KDevelop::Declaration* findDeclarationImport(DeclarationType declarationType, IdentifierAst* node);

    KDevelop::Declaration* findDeclarationImport(DeclarationType declarationType, VariableIdentifierAst* node);

    KDevelop::Declaration* findDeclarationImport(DeclarationType declarationType, const KDevelop::QualifiedIdentifier &identifier, AstNode* node);

 

    /// InternalFunctions.php should not be checked for errors and can get some optimizations

    bool m_isInternalFunctions;

    /// Whether semantic problems should get reported

    bool m_reportErrors;

    ///TODO: push this into kdevplatform

    bool m_mapAst;

};

 

}

 

#endif