File indexing completed on 2024-05-12 04:39:13
0001 /* 0002 SPDX-FileCopyrightText: 2007 David Nolden <david.nolden.kdevelop@art-master.de> 0003 SPDX-FileCopyrightText: 2014 Kevin Funk <kfunk@kde.org> 0004 0005 SPDX-License-Identifier: LGPL-2.0-only 0006 */ 0007 0008 #include "macronavigationcontext.h" 0009 0010 #include "util/clangdebug.h" 0011 #include "util/clangutils.h" 0012 0013 #include <language/duchain/duchain.h> 0014 #include <language/duchain/declaration.h> 0015 0016 using namespace KDevelop; 0017 0018 MacroNavigationContext::MacroNavigationContext(const MacroDefinition::Ptr& macro, 0019 const KDevelop::DocumentCursor& /* expansionLocation */) 0020 : m_macro(macro) 0021 { 0022 } 0023 0024 MacroNavigationContext::~MacroNavigationContext() 0025 { 0026 } 0027 0028 QString MacroNavigationContext::name() const 0029 { 0030 return m_macro->identifier().toString(); 0031 } 0032 0033 static QString parameterListString(const MacroDefinition& macro) 0034 { 0035 // A function-like macro can have 0 parameters, e.g. `#define m() 1`. 0036 // Check isFunctionLike() rather than parametersSize() here in order to display "()" in this case. 0037 if (!macro.isFunctionLike()) { 0038 Q_ASSERT(macro.parametersSize() == 0); 0039 return QString(); 0040 } 0041 0042 QStringList parameterList; 0043 parameterList.reserve(macro.parametersSize()); 0044 FOREACH_FUNCTION (const auto& parameter, macro.parameters) { 0045 parameterList << parameter.str(); 0046 } 0047 0048 return QLatin1Char('(') + parameterList.join(QLatin1String(", ")) + QLatin1Char(')'); 0049 } 0050 0051 QString MacroNavigationContext::html(bool shorten) 0052 { 0053 Q_UNUSED(shorten); 0054 clear(); 0055 0056 modifyHtml() += QStringLiteral("<html><body><p>"); 0057 0058 const QUrl url = m_macro->url().toUrl(); 0059 const QString path = url.toLocalFile(); 0060 KTextEditor::Cursor cursor(m_macro->rangeInCurrentRevision().start()); 0061 NavigationAction action(url, cursor); 0062 modifyHtml() += i18nc("%1: macro type, i.e.: 'Function macro' or just 'Macro'" 0063 "%2: the macro name and arguments", 0064 "%1: %2", 0065 (m_macro->isFunctionLike() ? i18n("Function macro") : i18n("Macro")), 0066 importantHighlight(name()) + parameterListString(*m_macro)); 0067 modifyHtml() += QStringLiteral("<br/>"); 0068 modifyHtml() += i18nc("%1: the link to the definition", "Defined in: %1", 0069 createLink(QStringLiteral("%1 :%2").arg(url.fileName()).arg(cursor.line()+1), path, action)); 0070 0071 modifyHtml() += QStringLiteral(" "); //The action name _must_ stay "show_uses", since that is also used from outside 0072 makeLink(i18n("Show uses"), QStringLiteral("show_uses"), NavigationAction(m_macro.dynamicCast<Declaration>(), NavigationAction::NavigateUses)); 0073 0074 auto code = m_macro->definition().str(); 0075 modifyHtml() += QLatin1String("<p>") + i18n("Body: "); 0076 modifyHtml() += QLatin1String("<tt>") + code.toHtmlEscaped().replace(QLatin1Char('\n'), QStringLiteral("<br/>")) + QLatin1String("</tt>"); 0077 modifyHtml() += QStringLiteral("</p>"); 0078 0079 modifyHtml() += QStringLiteral("</p></body></html>"); 0080 return currentHtml(); 0081 } 0082 0083 QString MacroNavigationContext::retrievePreprocessedBody(const DocumentCursor& /*expansionLocation*/) const 0084 { 0085 const TopDUContext* topContext = m_macro->topContext(); 0086 if (!topContext) { 0087 return QString(); 0088 } 0089 0090 // TODO: Implement me. Still not exactly sure what do to here... 0091 return QString(); 0092 } 0093 0094 #include "moc_macronavigationcontext.cpp"