codegenerator.h

Go to the documentation of this file.

/*
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */

#ifndef KDEVPLATFORM_CODEGENERATOR_H
#define KDEVPLATFORM_CODEGENERATOR_H

#include <serialization/indexedstring.h>
#include "../duchain/topducontext.h"
#include "../duchain/duchain.h"

#include "language/interfaces/iastcontainer.h"
#include <debug.h>

namespace KDevelop {
template <class AstNode>
class AstChangeSet;

class DUContext;
class DUChainChangeSet;
class DocumentChangeSet;
class DocumentRange;
class CodeGeneratorBasePrivate;

class KDEVPLATFORMLANGUAGE_EXPORT CodeGeneratorBase
{
public:
    CodeGeneratorBase();
    virtual ~CodeGeneratorBase();

    enum State {
        Precondition,
        UserInput,
        Processing,
        Review,
        Finished
    };

    virtual bool checkPreconditions(DUContext* context, const DocumentRange& position) = 0;

    virtual bool gatherInformation() = 0;

    virtual bool process() = 0;

    const QString& errorText() const;

    // Implementation from kJob
    bool execute();

    void autoGenerate(DUContext* context, const DocumentRange* range);

    DocumentChangeSet& documentChangeSet();

protected:

    void addChangeSet(DUChainChangeSet* duChainChange);

    void addChangeSet(DocumentChangeSet& docChangeSet);

    void setErrorText(const QString& error);

    bool autoGeneration() const;

    void clearChangeSets();

private:
    bool displayChanges();

private:
    const QScopedPointer<class CodeGeneratorBasePrivate> d_ptr;
    Q_DECLARE_PRIVATE(CodeGeneratorBase)
};

template <typename AstContainer>
class CodeGenerator
    : public CodeGeneratorBase
{
public:
    ~CodeGenerator()
    {
        clearChangeSets();
    }

protected:

    using TopAstNode = typename AstContainer::TopAstNode ;
    using LanguageChangeSet = AstChangeSet<TopAstNode>;

    TopAstNode* ast(const IndexedString& file)
    {
        return astContainer(file)->topAstNode();
    }

    TopAstNode* ast(const TopDUContext& context)
    {
        return astContainer(context)->topAstNode();
    }

    typename AstContainer::Ptr astContainer(const IndexedString& file)
    {
        if (!m_AstContainers.contains(file)) {
            qCDebug(LANGUAGE) << "Ast requested for: " << file.str();

            TopDUContext* context = DUChain::self()->waitForUpdate(file, KDevelop::TopDUContext::AST).data();

            Q_ASSERT(context);
            m_AstContainers[file] = AstContainer::Ptr::template staticCast<IAstContainer>(context->ast());
        }

        return m_AstContainers[file];
    }

    typename AstContainer::Ptr astContainer(const TopDUContext& context)
    {
        return astContainer(context.url());
    }

    void addChangeSet(DUChainChangeSet* duChainChange)
    {
        CodeGeneratorBase::addChangeSet(duChainChange);
    }

    void addChangeSet(DocumentChangeSet& doc)
    {
        CodeGeneratorBase::addChangeSet(doc);
    }

    void addChangeSet(LanguageChangeSet* astChange);

    void clearChangeSets()
    {
        CodeGeneratorBase::clearChangeSets();
    }

    bool autoGeneration() const
    {
        return CodeGeneratorBase::autoGeneration();
    }

    void setErrorText(const QString& error)
    {
        CodeGeneratorBase::setErrorText(error);
    }

private:
    using AstContainerMap = QMap<IndexedString, typename AstContainer::Ptr>;
    AstContainerMap m_AstContainers;
};
}

#endif // KDEVPLATFORM_CODEGENERATOR_H