1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
|
/*
SPDX-FileCopyrightText: 2012 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
*/
#include "phpdocsmodel.h"
#include "phpdocsdebug.h"
#include <language/duchain/duchain.h>
#include <language/duchain/declaration.h>
#include <language/duchain/duchainlock.h>
#include <language/duchain/types/structuretype.h>
#include <interfaces/icore.h>
#include <interfaces/ilanguagecontroller.h>
#include <language/backgroundparser/backgroundparser.h>
#include <language/backgroundparser/parsejob.h>
#include <KLocalizedString>
#include <QStandardPaths>
#include <QRegularExpression>
using namespace KDevelop;
PhpDocsModel::PhpDocsModel(QObject* parent)
: QAbstractListModel(parent), m_internalFunctionsFile(QStandardPaths::locate(QStandardPaths::GenericDataLocation, QStringLiteral("kdevphpsupport/phpfunctions.php")))
{
// make sure the php plugin is loaded
auto phpLangPlugin = ICore::self()->languageController()->language(QStringLiteral("Php"));
if ( !phpLangPlugin ) {
qCWarning(DOCS) << "could not load PHP language support plugin";
return;
}
DUChain::self()->updateContextForUrl(internalFunctionFile(), TopDUContext::AllDeclarationsAndContexts, this, -10);
}
PhpDocsModel::~PhpDocsModel()
{
}
IndexedString PhpDocsModel::internalFunctionFile() const
{
return m_internalFunctionsFile;
}
void PhpDocsModel::updateReady(const IndexedString& file, const ReferencedTopDUContext& top)
{
if ( file == m_internalFunctionsFile && top ) {
fillModel(top);
}
}
void PhpDocsModel::fillModel(const ReferencedTopDUContext& top)
{
DUChainReadLocker lock;
if (!top) {
return;
}
qCDebug(DOCS) << "filling model";
typedef QPair<Declaration*, int> DeclDepthPair;
foreach ( DeclDepthPair declpair, top->allDeclarations(top->range().end, top) ) {
if ( declpair.first->abstractType() && declpair.first->abstractType()->modifiers() & AbstractType::ConstModifier ) {
// filter global constants, since they are hard to find in the documentation
continue;
}
m_declarations << DeclarationPointer(declpair.first);
if ( StructureType::Ptr type = declpair.first->type<StructureType>() ) {
foreach ( Declaration* dec, type->internalContext(top)->localDeclarations() ) {
m_declarations << DeclarationPointer(dec);
}
}
}
}
bool PhpDocsModel::hasChildren(const QModelIndex& parent) const
{
// only the top-level has children
return parent == QModelIndex();
}
QVariant PhpDocsModel::data(const QModelIndex& index, int role) const
{
switch ( role ) {
case Qt::DisplayRole:
case Qt::EditRole: {
DUChainReadLocker lock;
DeclarationPointer dec = declarationForIndex(index);
if (!dec.data()) {
return i18n("<lost declaration>");
}
QString ret = dec->toString();
if ( dec->isFunctionDeclaration() ) {
static const auto functionArgsPattern = QRegularExpression(QStringLiteral("\\(.+\\)"));
static const auto returnTypePattern = QRegularExpression(QStringLiteral("^[^ ]+ "));
ret.remove(functionArgsPattern).remove(returnTypePattern);
}
return ret;
}
case DeclarationRole: {
DeclarationPointer dec = declarationForIndex(index);
return QVariant::fromValue<DeclarationPointer>(dec);
}
/*
case Qt::ToolTipRole:
case Qt::AccessibleTextRole:
case Qt::AccessibleDescriptionRole:
*/
default:
return QVariant();
}
}
int PhpDocsModel::rowCount(const QModelIndex& parent) const
{
if (parent.isValid())
return 0;
return m_declarations.count();
}
DeclarationPointer PhpDocsModel::declarationForIndex(const QModelIndex& index) const
{
Q_ASSERT(m_declarations.size() > index.row());
return m_declarations[index.row()];
}
#include "moc_phpdocsmodel.cpp"
|