C++: added quickfix to insert a method definition.

Reviewed-by: Christian Kamm

src/libs/cplusplus/cplusplus-lib.pri

@@ -48,8 +48,7 @@ HEADERS += \
     $$PWD/pp-cctype.h \
     $$PWD/pp-engine.h \
     $$PWD/pp-macro-expander.h \
-    $$PWD/pp-scanner.h \
-    $$PWD/InsertionPointLocator.h
+    $$PWD/pp-scanner.h
 
 SOURCES += \
     $$PWD/SimpleLexer.cpp \
@@ -73,7 +72,6 @@ SOURCES += \
     $$PWD/Macro.cpp \
     $$PWD/pp-engine.cpp \
     $$PWD/pp-macro-expander.cpp \
-    $$PWD/pp-scanner.cpp \
-    $$PWD/InsertionPointLocator.cpp
+    $$PWD/pp-scanner.cpp
 
 RESOURCES += $$PWD/cplusplus.qrc

src/plugins/cppeditor/cppeditor.pro

@@ -15,7 +15,6 @@ HEADERS += cppplugin.h \
     cppeditor_global.h \
     cppclasswizard.h \
     cppquickfix.h \
-    cpprefactoringchanges.h \
     cppchecksymbols.h \
     cppsemanticinfo.h \
     cppoutline.h \
@@ -31,7 +30,6 @@ SOURCES += cppplugin.cpp \
     cppclasswizard.cpp \
     cppquickfix.cpp \
     cppquickfixes.cpp \
-    cpprefactoringchanges.cpp \
     cppchecksymbols.cpp \
     cppsemanticinfo.cpp \
     cppoutline.cpp \

src/plugins/cppeditor/cppinsertdecldef.h

@@ -56,11 +56,6 @@ class DefFromDecl: public CppQuickFixFactory
 {
 public:
     virtual QList<CppQuickFixOperation::Ptr> match(const CppQuickFixState &state);
-
-protected:
-    static QString generateDefinition(const CppQuickFixState &state,
-                                      CPlusPlus::Function *method,
-                                      CPlusPlus::ClassOrNamespace *targetBinding);
 };
 
 } // namespace Internal

src/plugins/cppeditor/cppquickfix.cpp

@@ -43,7 +43,7 @@
 #include <cplusplus/CppRewriter.h>
 
 #include <cppeditor/cppeditor.h>
-#include <cppeditor/cpprefactoringchanges.h>
+#include <cpptools/cpprefactoringchanges.h>
 #include <cpptools/cpptoolsconstants.h>
 #include <cpptools/cppmodelmanagerinterface.h>
 #include <extensionsystem/pluginmanager.h>
@@ -52,6 +52,7 @@
 
 using namespace CppEditor;
 using namespace CppEditor::Internal;
+using namespace CppTools;
 using namespace TextEditor;
 using namespace CPlusPlus;
 using namespace Utils;

src/plugins/cppeditor/cppquickfix.h

@@ -30,11 +30,12 @@
 #ifndef CPPQUICKFIX_H
 #define CPPQUICKFIX_H
 
-#include "cpprefactoringchanges.h"
+#include "cppeditor_global.h"
 #include "cppsemanticinfo.h"
 
 #include <ASTfwd.h>
 #include <cplusplus/CppDocument.h>
+#include <cpptools/cpprefactoringchanges.h>
 #include <texteditor/icompletioncollector.h>
 #include <texteditor/quickfix.h>
 #include <utils/changeset.h>
@@ -69,7 +70,7 @@ public:
     CppEditor::Internal::SemanticInfo semanticInfo() const;
     const CPlusPlus::LookupContext &context() const;
 
-    const CppRefactoringFile currentFile() const;
+    const CppTools::CppRefactoringFile currentFile() const;
 
     bool isCursorOn(unsigned tokenIndex) const
     { return currentFile().isCursorOn(tokenIndex); }
@@ -94,7 +95,8 @@ public:
     virtual void perform();
 
 protected:
-    virtual void performChanges(CppRefactoringFile *currentFile, CppRefactoringChanges *refactoring) = 0;
+    virtual void performChanges(CppTools::CppRefactoringFile *currentFile,
+                                CppTools::CppRefactoringChanges *refactoring) = 0;
 
     QString fileName() const;
 

src/plugins/cppeditor/cppquickfixes.cpp

@@ -58,6 +58,7 @@
 
 using namespace CppEditor;
 using namespace CppEditor::Internal;
+using namespace CppTools;
 using namespace TextEditor;
 using namespace CPlusPlus;
 using namespace Utils;

src/plugins/cppeditor/cpprefactoringchanges.cpp → src/plugins/cpptools/cpprefactoringchanges.cpp

@@ -37,8 +37,8 @@
 
 #include <QtGui/QTextBlock>
 
-using namespace CppEditor;
 using namespace CPlusPlus;
+using namespace CppTools;
 using namespace Utils;
 
 CppRefactoringChanges::CppRefactoringChanges(const Snapshot &snapshot)

src/plugins/cppeditor/cpprefactoringchanges.h → src/plugins/cpptools/cpprefactoringchanges.h

@@ -35,15 +35,15 @@
 #include <cplusplus/LookupContext.h>
 
 #include <cpptools/cppmodelmanagerinterface.h>
-#include <cppeditor/cppeditor_global.h>
+#include <cpptools/cpptools_global.h>
 
 #include <texteditor/refactoringchanges.h>
 
-namespace CppEditor {
+namespace CppTools {
 
 class CppRefactoringChanges;
 
-class CPPEDITOR_EXPORT CppRefactoringFile: public TextEditor::RefactoringFile
+class CPPTOOLS_EXPORT CppRefactoringFile: public TextEditor::RefactoringFile
 {
 public:
     CppRefactoringFile();
@@ -79,7 +79,7 @@ private:
     mutable CPlusPlus::Document::Ptr m_cppDocument;
 };
 
-class CPPEDITOR_EXPORT CppRefactoringChanges: public TextEditor::RefactoringChanges
+class CPPTOOLS_EXPORT CppRefactoringChanges: public TextEditor::RefactoringChanges
 {
 public:
     CppRefactoringChanges(const CPlusPlus::Snapshot &snapshot);
@@ -99,6 +99,6 @@ private:
     CppTools::CppModelManagerInterface::WorkingCopy m_workingCopy;
 };
 
-} // namespace CppEditor
+} // namespace CppTools
 
 #endif // CPPREFACTORINGCHANGES_H

src/plugins/cpptools/cpptools.pro

@@ -25,7 +25,9 @@ HEADERS += completionsettingspage.h \
     cppfilesettingspage.h \
     cppfindreferences.h \
     cppcodeformatter.h \
-    symbolsfindfilter.h
+    symbolsfindfilter.h \
+    insertionpointlocator.h \
+    cpprefactoringchanges.h
 
 SOURCES += completionsettingspage.cpp \
     cppclassesfilter.cpp \
@@ -42,7 +44,9 @@ SOURCES += completionsettingspage.cpp \
     abstracteditorsupport.cpp \
     cppfindreferences.cpp \
     cppcodeformatter.cpp \
-    symbolsfindfilter.cpp
+    symbolsfindfilter.cpp \
+    insertionpointlocator.cpp \
+    cpprefactoringchanges.cpp
 
 FORMS += completionsettingspage.ui \
     cppfilesettingspage.ui

src/libs/cplusplus/InsertionPointLocator.cpp → src/plugins/cpptools/insertionpointlocator.cpp

@@ -27,6 +27,8 @@
 **
 **************************************************************************/
 
+#include "CppToolsPlugin.h"
+#include "cpprefactoringchanges.h"
 #include "InsertionPointLocator.h"
 
 #include <AST.h>
@@ -34,6 +36,7 @@
 #include <TranslationUnit.h>
 
 using namespace CPlusPlus;
+using namespace CppTools;
 
 namespace {
 
@@ -150,7 +153,8 @@ protected:
         if (needsSuffix)
             suffix = QLatin1Char('\n');
 
-        _result = InsertionLocation(prefix, suffix, line, column);
+        _result = InsertionLocation(_doc->fileName(), prefix, suffix,
+                                    line, column);
         return false;
     }
 
@@ -264,16 +268,19 @@ InsertionLocation::InsertionLocation()
     , m_column(0)
 {}
 
-InsertionLocation::InsertionLocation(const QString &prefix, const QString &suffix,
+InsertionLocation::InsertionLocation(const QString &fileName,
+                                     const QString &prefix,
+                                     const QString &suffix,
                                      unsigned line, unsigned column)
-    : m_prefix(prefix)
+    : m_fileName(fileName)
+    , m_prefix(prefix)
     , m_suffix(suffix)
     , m_line(line)
     , m_column(column)
 {}
 
-InsertionPointLocator::InsertionPointLocator(const Snapshot &snapshot)
-    : m_snapshot(snapshot)
+InsertionPointLocator::InsertionPointLocator(CppRefactoringChanges *refactoringChanges)
+    : m_refactoringChanges(refactoringChanges)
 {
 }
 
@@ -282,7 +289,7 @@ InsertionLocation InsertionPointLocator::methodDeclarationInClass(
     const Class *clazz,
     AccessSpec xsSpec) const
 {
-    const Document::Ptr doc = m_snapshot.document(fileName);
+    const Document::Ptr doc = m_refactoringChanges->file(fileName).cppDocument();
     if (doc) {
         FindInClass find(doc, clazz, xsSpec);
         return find();
@@ -293,11 +300,30 @@ InsertionLocation InsertionPointLocator::methodDeclarationInClass(
 
 /// Currently, we return the end of fileName.cpp
 QList<InsertionLocation> InsertionPointLocator::methodDefinition(
-    const QString &/*fileName*/) const
+    Declaration *declaration) const
 {
     QList<InsertionLocation> result;
+    if (!declaration)
+        return result;
+
+    Internal::CppToolsPlugin *cpptools = Internal::CppToolsPlugin::instance();
+
+    const QString declFileName = QLatin1String(declaration->fileName());
+    QString target = cpptools->correspondingHeaderOrSource(declFileName);
+    Document::Ptr doc = m_refactoringChanges->file(target).cppDocument();
+    if (doc.isNull())
+        return result;
 
+    TranslationUnit *xUnit = doc->translationUnit();
+    unsigned tokenCount = xUnit->tokenCount();
+    if (tokenCount < 2) // no tokens available
+        return result;
+
+    unsigned line = 0, column = 0;
+    xUnit->getTokenEndPosition(xUnit->tokenCount() - 2, &line, &column);
 
+    const QLatin1String prefix("\n\n");
+    result.append(InsertionLocation(target, prefix, QString(), line, column));
 
     return result;
 }

src/libs/cplusplus/InsertionPointLocator.h → src/plugins/cpptools/insertionpointlocator.h

@@ -30,19 +30,27 @@
 #ifndef INSERTIONPOINTLOCATOR_H
 #define INSERTIONPOINTLOCATOR_H
 
+#include "cpptools_global.h"
+
 #include <ASTfwd.h>
 #include <CPlusPlusForwardDeclarations.h>
 #include <Symbols.h>
 
-#include "CppDocument.h"
+#include <cplusplus/CppDocument.h>
+
+namespace CppTools {
 
-namespace CPlusPlus {
+class CppRefactoringChanges;
 
-class CPLUSPLUS_EXPORT InsertionLocation
+class CPPTOOLS_EXPORT InsertionLocation
 {
 public:
     InsertionLocation();
-    InsertionLocation(const QString &prefix, const QString &suffix, unsigned line, unsigned column);
+    InsertionLocation(const QString &fileName, const QString &prefix,
+                      const QString &suffix, unsigned line, unsigned column);
+
+    QString fileName() const
+    { return m_fileName; }
 
     /// \returns The prefix to insert before any other text.
     QString prefix() const
@@ -61,16 +69,17 @@ public:
     { return m_column; }
 
     bool isValid() const
-    { return m_line > 0 && m_column > 0; }
+    { return !m_fileName.isEmpty() && m_line > 0 && m_column > 0; }
 
 private:
+    QString m_fileName;
     QString m_prefix;
     QString m_suffix;
     unsigned m_line;
     unsigned m_column;
 };
 
-class CPLUSPLUS_EXPORT InsertionPointLocator
+class CPPTOOLS_EXPORT InsertionPointLocator
 {
 public:
     enum AccessSpec {
@@ -89,18 +98,18 @@ public:
     };
 
 public:
-    InsertionPointLocator(const Snapshot &snapshot);
+    InsertionPointLocator(CppRefactoringChanges *refactoringChanges);
 
     InsertionLocation methodDeclarationInClass(const QString &fileName,
-                                               const Class *clazz,
+                                               const CPlusPlus::Class *clazz,
                                                AccessSpec xsSpec) const;
 
-    QList<InsertionLocation> methodDefinition(const QString &fileName) const;
+    QList<InsertionLocation> methodDefinition(CPlusPlus::Declaration *declaration) const;
 
 private:
-    Snapshot m_snapshot;
+    CppRefactoringChanges *m_refactoringChanges;
 };
 
-} // namespace CPlusPlus
+} // namespace CppTools
 
 #endif // INSERTIONPOINTLOCATOR_H

src/plugins/designer/qtcreatorintegration.cpp

@@ -37,8 +37,9 @@
 #include <widgethost.h>
 
 #include <cpptools/cppmodelmanagerinterface.h>
+#include <cpptools/cpprefactoringchanges.h>
 #include <cpptools/cpptoolsconstants.h>
-#include <cplusplus/InsertionPointLocator.h>
+#include <cpptools/insertionpointlocator.h>
 #include <cplusplus/Symbols.h>
 #include <cplusplus/Overview.h>
 #include <cplusplus/CoreTypes.h>
@@ -282,9 +283,10 @@ static void addDeclaration(const Snapshot &snapshot,
     declaration += functionName;
     declaration += QLatin1String(";\n");
 
-    InsertionPointLocator find(snapshot);
-    const InsertionLocation loc = find.methodDeclarationInClass(
-                fileName, cl, InsertionPointLocator::PrivateSlot);
+    CppTools::CppRefactoringChanges refactoring(snapshot);
+    CppTools::InsertionPointLocator find(&refactoring);
+    const CppTools::InsertionLocation loc = find.methodDeclarationInClass(
+                fileName, cl, CppTools::InsertionPointLocator::PrivateSlot);
 
     //
     //! \todo change this to use the Refactoring changes.