duchainutils.h

Go to the documentation of this file.

/*
 * DUChain Utilities
 *
 * Copyright 2007 Hamish Rodda <[email protected]>
 * Copyright 2007-2009 David Nolden <[email protected]>
 *
 * 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 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 KDEVPLATFORM_DUCHAINUTILS_H
#define KDEVPLATFORM_DUCHAINUTILS_H
 
#include <QUrl>
 
#include <language/languageexport.h>
#include <language/duchain/problem.h>
#include <language/duchain/topducontext.h>
 
#include <KTextEditor/CodeCompletionModel>
 
class QIcon;
 
namespace KTextEditor {
class Cursor;
}
 
namespace KDevelop {
class Declaration;
class DUChainBase;
class DUContext;
class IndexedString;
class TopDUContext;
class IndexedDeclaration;
 
namespace DUChainUtils {
KDEVPLATFORMLANGUAGE_EXPORT KTextEditor::CodeCompletionModel::CompletionProperties completionProperties(
    const Declaration* dec);
KDEVPLATFORMLANGUAGE_EXPORT QIcon iconForProperties(KTextEditor::CodeCompletionModel::CompletionProperties p);
KDEVPLATFORMLANGUAGE_EXPORT QIcon iconForDeclaration(const Declaration* dec);
KDEVPLATFORMLANGUAGE_EXPORT KDevelop::TopDUContext* standardContextForUrl(const QUrl& url,
                                                                          bool preferProxyContext = false);
KDEVPLATFORMLANGUAGE_EXPORT TopDUContext* contentContextFromProxyContext(TopDUContext* top);
struct KDEVPLATFORMLANGUAGE_EXPORT ItemUnderCursor
{
    Declaration* declaration; // found declaration (either declared/defined or used)
    DUContext* context; // context in which the declaration, definition, or use was found
    KTextEditor::Range range; // range of the declaration/definition/use
};
KDEVPLATFORMLANGUAGE_EXPORT ItemUnderCursor itemUnderCursor(const QUrl& url, const KTextEditor::Cursor& cursor);
KDEVPLATFORMLANGUAGE_EXPORT Declaration* declarationForDefinition(Declaration* definition,
                                                                  TopDUContext* topContext = nullptr);
KDEVPLATFORMLANGUAGE_EXPORT Declaration* declarationInLine(const KTextEditor::Cursor& cursor, KDevelop::DUContext* ctx);
 
class KDEVPLATFORMLANGUAGE_EXPORT DUChainItemFilter
{
public:
    virtual bool accept(Declaration* decl) = 0;
    //Should return whether processing should be deepened into the given context
    virtual bool accept(DUContext* ctx) = 0;
    virtual ~DUChainItemFilter();
};
KDEVPLATFORMLANGUAGE_EXPORT void collectItems(DUContext* context, DUChainItemFilter& filter);
 
KDEVPLATFORMLANGUAGE_EXPORT DUContext* argumentContext(Declaration* decl);
 
KDEVPLATFORMLANGUAGE_EXPORT QList<IndexedDeclaration> collectAllVersions(Declaration* decl);
 
KDEVPLATFORMLANGUAGE_EXPORT QList<Declaration*> inheriters(const Declaration* decl, uint& maxAllowedSteps,
                                                           bool collectVersions = true);
 
KDEVPLATFORMLANGUAGE_EXPORT QList<Declaration*> overriders(const Declaration* currentClass,
                                                           const Declaration* overriddenDeclaration,
                                                           uint& maxAllowedSteps);
 
KDEVPLATFORMLANGUAGE_EXPORT bool contextHasUse(DUContext* context, Declaration* declaration);
 
KDEVPLATFORMLANGUAGE_EXPORT uint contextCountUses(DUContext* context, Declaration* declaration);
 
KDEVPLATFORMLANGUAGE_EXPORT Declaration* overridden(const Declaration* decl);
 
KDEVPLATFORMLANGUAGE_EXPORT DUContext* functionContext(Declaration* decl);
 
KDEVPLATFORMLANGUAGE_EXPORT QVector<KDevelop::Problem::Ptr> allProblemsForContext(const ReferencedTopDUContext& top);
}
}
 
#endif // KDEVPLATFORM_DUCHAINUTILS_H