Editors: Centralize creation of EditLocation for history

Change-Id: I05387ccf444351de4002b706f7c03027fdd9adaf
Reviewed-by: David Schulz <david.schulz@qt.io>

src/plugins/coreplugin/editormanager/editormanager.cpp

@@ -3444,18 +3444,7 @@ void EditorManager::addCurrentPositionToNavigationHistory(const QByteArray &save
 */
 void EditorManager::setLastEditLocation(const IEditor* editor)
 {
-    IDocument *document = editor->document();
+    d->m_globalLastEditLocation = EditLocation::forEditor(editor);
-    if (!document)
-        return;
-
-    const QByteArray &state = editor->saveState();
-    EditLocation location;
-    location.document = document;
-    location.filePath = document->filePath();
-    location.id = document->id();
-    location.state = state;
-
-    d->m_globalLastEditLocation = location;
 }
 
 /*!

src/plugins/coreplugin/editormanager/editorview.cpp

@@ -262,20 +262,10 @@ bool EditorView::canGoBack() const
 
 void EditorView::updateEditorHistory(IEditor *editor, QList<EditLocation> &history)
 {
-    if (!editor)
+    IDocument *document = editor ? editor->document() : nullptr;
-        return;
+    QTC_ASSERT(document, return);
-    IDocument *document = editor->document();
 
-    if (!document)
+    const auto location = EditLocation::forEditor(editor);
-        return;
-
-    QByteArray state = editor->saveState();
-
-    EditLocation location;
-    location.document = document;
-    location.filePath = document->filePath();
-    location.id = document->id();
-    location.state = state;
 
     for (int i = 0; i < history.size(); ++i) {
         const EditLocation &item = history.at(i);
@@ -491,24 +481,11 @@ constexpr int navigationHistorySize = 100;
 void EditorView::addCurrentPositionToNavigationHistory(const QByteArray &saveState)
 {
     IEditor *editor = currentEditor();
-    if (!editor)
-        return;
-    IDocument *document = editor->document();
 
-    if (!document)
+    if (!editor || !editor->document())
         return;
 
-    QByteArray state;
+    const auto location = EditLocation::forEditor(editor, saveState);
-    if (saveState.isNull())
-        state = editor->saveState();
-    else
-        state = saveState;
-
-    EditLocation location;
-    location.document = document;
-    location.filePath = document->filePath();
-    location.id = document->id();
-    location.state = state;
     m_currentNavigationHistoryPosition = qMin(m_currentNavigationHistoryPosition, m_navigationHistory.size()); // paranoia
     m_navigationHistory.insert(m_currentNavigationHistoryPosition, location);
     ++m_currentNavigationHistoryPosition;
@@ -552,7 +529,6 @@ void EditorView::updateCurrentPositionInNavigationHistory()
     if (!editor || !editor->document())
         return;
 
-    IDocument *document = editor->document();
     EditLocation *location;
     if (m_currentNavigationHistoryPosition < m_navigationHistory.size()) {
         location = &m_navigationHistory[m_currentNavigationHistoryPosition];
@@ -560,10 +536,7 @@ void EditorView::updateCurrentPositionInNavigationHistory()
         m_navigationHistory.append(EditLocation());
         location = &m_navigationHistory[m_navigationHistory.size()-1];
     }
-    location->document = document;
+    *location = EditLocation::forEditor(editor);
-    location->filePath = document->filePath();
-    location->id = document->id();
-    location->state = editor->saveState();
 }
 
 static bool fileNameWasRemoved(const FilePath &filePath)
@@ -1033,4 +1006,22 @@ EditLocation EditLocation::load(const QByteArray &data)
     return loc;
 }
 
+EditLocation EditLocation::forEditor(const IEditor *editor, const QByteArray &saveState)
+{
+    QTC_ASSERT(editor, return EditLocation());
+
+    IDocument *document = editor->document();
+    QTC_ASSERT(document, return EditLocation());
+
+    const QByteArray &state = saveState.isEmpty() ? editor->saveState() : saveState;
+
+    EditLocation location;
+    location.document = document;
+    location.filePath = document->filePath();
+    location.id = document->id();
+    location.state = state;
+
+    return location;
+}
+
 } // Core::Internal

src/plugins/coreplugin/editormanager/editorview.h

@@ -40,6 +40,7 @@ class EditLocation
 public:
     QByteArray save() const;
     static EditLocation load(const QByteArray &data);
+    static EditLocation forEditor(const IEditor *editor, const QByteArray &saveState = {});
 
     QPointer<IDocument> document;
     Utils::FilePath filePath;