use common bottleneck

[wxWidgets.git] / src / common / docview.cpp

diff --git a/src/common/docview.cpp b/src/common/docview.cpp
index 34df0b1c277cf538f86387eca2540c97e8000023..fc1c256337baa61a4766a83b34d5bf24dc56f954 100644 (file)
--- a/src/common/docview.cpp
+++ b/src/common/docview.cpp
@@ -60,6 +60,7 @@
 #include "wx/vector.h"
 #include "wx/scopedarray.h"
 #include "wx/scopedptr.h"
 #include "wx/vector.h"
 #include "wx/scopedarray.h"
 #include "wx/scopedptr.h"

+#include "wx/scopeguard.h"

 #include "wx/except.h"
 
 #if wxUSE_STD_IOSTREAM
 #include "wx/except.h"
 
 #if wxUSE_STD_IOSTREAM


@@ -75,8 +76,6 @@
     #include "wx/wfstream.h"
 #endif
 
     #include "wx/wfstream.h"
 #endif
 

-typedef wxVector<wxDocTemplate *> wxDocTemplates;
-

 // ----------------------------------------------------------------------------
 // wxWidgets macros
 // ----------------------------------------------------------------------------
 // ----------------------------------------------------------------------------
 // wxWidgets macros
 // ----------------------------------------------------------------------------


@@ -122,8 +121,12 @@ wxString FindExtension(const wxString& path)
 wxDocument::wxDocument(wxDocument *parent)
 {
     m_documentModified = false;
 wxDocument::wxDocument(wxDocument *parent)
 {
     m_documentModified = false;

-    m_documentParent = parent;

     m_documentTemplate = NULL;
     m_documentTemplate = NULL;

+
+    m_documentParent = parent;
+    if ( parent )
+        parent->m_childDocuments.push_back(this);
+

     m_commandProcessor = NULL;
     m_savedYet = false;
 }
     m_commandProcessor = NULL;
     m_savedYet = false;
 }


@@ -140,6 +143,9 @@ wxDocument::~wxDocument()
     if (GetDocumentManager())
         GetDocumentManager()->RemoveDocument(this);
 
     if (GetDocumentManager())
         GetDocumentManager()->RemoveDocument(this);
 

+    if ( m_documentParent )
+        m_documentParent->m_childDocuments.remove(this);
+

     // Not safe to do here, since it'll invoke virtual view functions
     // expecting to see valid derived objects: and by the time we get here,
     // we've called destructors higher up.
     // Not safe to do here, since it'll invoke virtual view functions
     // expecting to see valid derived objects: and by the time we get here,
     // we've called destructors higher up.


@@ -151,6 +157,40 @@ bool wxDocument::Close()
     if ( !OnSaveModified() )
         return false;
 
     if ( !OnSaveModified() )
         return false;
 

+    // When the parent document closes, its children must be closed as well as
+    // they can't exist without the parent.
+
+    // As usual, first check if all children can be closed.
+    DocsList::const_iterator it = m_childDocuments.begin();
+    for ( DocsList::const_iterator end = m_childDocuments.end(); it != end; ++it )
+    {
+        if ( !(*it)->OnSaveModified() )
+        {
+            // Leave the parent document opened if a child can't close.
+            return false;
+        }
+    }
+
+    // Now that they all did, do close them: as m_childDocuments is modified as
+    // we iterate over it, don't use the usual for-style iteration here.
+    while ( !m_childDocuments.empty() )
+    {
+        wxDocument * const childDoc = m_childDocuments.front();
+
+        // This will call OnSaveModified() once again but it shouldn't do
+        // anything as the document was just saved or marked as not needing to
+        // be saved by the call to OnSaveModified() that returned true above.
+        if ( !childDoc->Close() )
+        {
+            wxFAIL_MSG( "Closing the child document unexpectedly failed "
+                        "after its OnSaveModified() returned true" );
+        }
+
+        // Delete the child document by deleting all its views.
+        childDoc->DeleteAllViews();
+    }
+
+

     return OnCloseDocument();
 }
 
     return OnCloseDocument();
 }
 


@@ -231,6 +271,12 @@ void wxDocument::Modify(bool mod)
 
 wxDocManager *wxDocument::GetDocumentManager() const
 {
 
 wxDocManager *wxDocument::GetDocumentManager() const
 {

+    // For child documents we use the same document manager as the parent, even
+    // though we don't have our own template (as children are not opened/saved
+    // directly).
+    if ( m_documentParent )
+        return m_documentParent->GetDocumentManager();
+

     return m_documentTemplate ? m_documentTemplate->GetDocumentManager() : NULL;
 }
 
     return m_documentTemplate ? m_documentTemplate->GetDocumentManager() : NULL;
 }
 


@@ -350,6 +396,9 @@ bool wxDocument::OnSaveDocument(const wxString& file)
     if ( !DoSaveDocument(file) )
         return false;
 
     if ( !DoSaveDocument(file) )
         return false;
 

+    if ( m_commandProcessor )
+        m_commandProcessor->MarkAsSaved();
+

     Modify(false);
     SetFilename(file);
     SetDocumentSaved(true);
     Modify(false);
     SetFilename(file);
     SetDocumentSaved(true);


@@ -809,17 +858,19 @@ wxDocument *wxDocTemplate::CreateDocument(const wxString& path, long flags)
 bool
 wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
 {
 bool
 wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
 {

+    wxScopeGuard g = wxMakeObjGuard(*doc, &wxDocument::DeleteAllViews);
+

     doc->SetFilename(path);
     doc->SetDocumentTemplate(this);
     GetDocumentManager()->AddDocument(doc);
     doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
 
     doc->SetFilename(path);
     doc->SetDocumentTemplate(this);
     GetDocumentManager()->AddDocument(doc);
     doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
 

-    if (doc->OnCreate(path, flags))
-        return true;
+    if ( !doc->OnCreate(path, flags) )
+        return false;

 
 

-    if (GetDocumentManager()->GetDocuments().Member(doc))
-        doc->DeleteAllViews();
-    return false;
+    g.Dismiss(); // no need to call DeleteAllViews() anymore
+
+    return true;

 }
 
 wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
 }
 
 wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)


@@ -895,7 +946,7 @@ BEGIN_EVENT_TABLE(wxDocManager, wxEvtHandler)
     EVT_UPDATE_UI(wxID_REVERT, wxDocManager::OnUpdateFileRevert)
     EVT_UPDATE_UI(wxID_NEW, wxDocManager::OnUpdateFileNew)
     EVT_UPDATE_UI(wxID_SAVE, wxDocManager::OnUpdateFileSave)
     EVT_UPDATE_UI(wxID_REVERT, wxDocManager::OnUpdateFileRevert)
     EVT_UPDATE_UI(wxID_NEW, wxDocManager::OnUpdateFileNew)
     EVT_UPDATE_UI(wxID_SAVE, wxDocManager::OnUpdateFileSave)

-    EVT_UPDATE_UI(wxID_SAVEAS, wxDocManager::OnUpdateDisableIfNoDoc)
+    EVT_UPDATE_UI(wxID_SAVEAS, wxDocManager::OnUpdateFileSaveAs)

     EVT_UPDATE_UI(wxID_UNDO, wxDocManager::OnUpdateUndo)
     EVT_UPDATE_UI(wxID_REDO, wxDocManager::OnUpdateRedo)
 
     EVT_UPDATE_UI(wxID_UNDO, wxDocManager::OnUpdateUndo)
     EVT_UPDATE_UI(wxID_REDO, wxDocManager::OnUpdateRedo)
 


@@ -1106,26 +1157,27 @@ void wxDocManager::DoOpenMRUFile(unsigned n)
     wxString errMsg; // must contain exactly one "%s" if non-empty
     if ( wxFile::Exists(filename) )
     {
     wxString errMsg; // must contain exactly one "%s" if non-empty
     if ( wxFile::Exists(filename) )
     {

-        // try to open it
-        if ( CreateDocument(filename, wxDOC_SILENT) )
-            return;
-
-        errMsg = _("The file '%s' couldn't be opened.");
+        // Try to open it but don't give an error if it failed: this could be
+        // normal, e.g. because the user cancelled opening it, and we don't
+        // have any useful information to put in the error message anyhow, so
+        // we assume that in case of an error the appropriate message had been
+        // already logged.
+        (void)CreateDocument(filename, wxDOC_SILENT);

     }
     else // file doesn't exist
     {
     }
     else // file doesn't exist
     {

-        errMsg = _("The file '%s' doesn't exist and couldn't be opened.");
+        OnMRUFileNotExist(n, filename);

     }
     }

+}

 
 

-
-    wxASSERT_MSG( !errMsg.empty(), "should have an error message" );
-
+void wxDocManager::OnMRUFileNotExist(unsigned n, const wxString& filename)
+{

     // remove the file which we can't open from the MRU list
     RemoveFileFromHistory(n);
 
     // and tell the user about it
     // remove the file which we can't open from the MRU list
     RemoveFileFromHistory(n);
 
     // and tell the user about it

-    wxLogError(errMsg + '\n' +
-               _("It has been removed from the most recently used files list."),
+    wxLogError(_("The file '%s' doesn't exist and couldn't be opened.\n"
+                 "It has been removed from the most recently used files list."),

                filename);
 }
 
                filename);
 }
 


@@ -1133,7 +1185,7 @@ void wxDocManager::DoOpenMRUFile(unsigned n)
 
 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
 {
 
 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
 {

-    wxView *view = GetActiveView();
+    wxView *view = GetAnyUsableView();

     if (!view)
         return;
 
     if (!view)
         return;
 


@@ -1167,7 +1219,7 @@ wxPreviewFrame* wxDocManager::CreatePreviewFrame(wxPrintPreviewBase* preview,
 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
 {
     wxBusyCursor busy;
 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
 {
     wxBusyCursor busy;

-    wxView *view = GetActiveView();
+    wxView *view = GetAnyUsableView();

     if (!view)
         return;
 
     if (!view)
         return;
 


@@ -1254,7 +1306,13 @@ void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent& event)
 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
 {
     wxDocument * const doc = GetCurrentDocument();
 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
 {
     wxDocument * const doc = GetCurrentDocument();

-    event.Enable( doc && !doc->AlreadySaved() );
+    event.Enable( doc && !doc->IsChildDocument() && !doc->AlreadySaved() );
+}
+
+void wxDocManager::OnUpdateFileSaveAs(wxUpdateUIEvent& event)
+{
+    wxDocument * const doc = GetCurrentDocument();
+    event.Enable( doc && !doc->IsChildDocument() );

 }
 
 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
 }
 
 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)


@@ -1262,10 +1320,14 @@ void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
     if ( !cmdproc )
     {
     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
     if ( !cmdproc )
     {

-        event.Enable(false);
+        // If we don't have any document at all, the menu item should really be
+        // disabled.
+        if ( !GetCurrentDocument() )
+            event.Enable(false);
+        else // But if we do have it, it might handle wxID_UNDO on its own
+            event.Skip();

         return;
     }
         return;
     }

-

     event.Enable(cmdproc->CanUndo());
     cmdproc->SetMenuStrings();
 }
     event.Enable(cmdproc->CanUndo());
     cmdproc->SetMenuStrings();
 }


@@ -1275,15 +1337,18 @@ void wxDocManager::OnUpdateRedo(wxUpdateUIEvent& event)
     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
     if ( !cmdproc )
     {
     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
     if ( !cmdproc )
     {

-        event.Enable(false);
+        // Use same logic as in OnUpdateUndo() above.
+        if ( !GetCurrentDocument() )
+            event.Enable(false);
+        else
+            event.Skip();

         return;
     }
         return;
     }

-

     event.Enable(cmdproc->CanRedo());
     cmdproc->SetMenuStrings();
 }
 
     event.Enable(cmdproc->CanRedo());
     cmdproc->SetMenuStrings();
 }
 

-wxView *wxDocManager::GetActiveView() const
+wxView *wxDocManager::GetAnyUsableView() const

 {
     wxView *view = GetCurrentView();
 
 {
     wxView *view = GetCurrentView();
 


@@ -1309,7 +1374,7 @@ wxView *wxDocManager::GetActiveView() const
 
 bool wxDocManager::TryBefore(wxEvent& event)
 {
 
 bool wxDocManager::TryBefore(wxEvent& event)
 {

-    wxView * const view = GetActiveView();
+    wxView * const view = GetAnyUsableView();

     return view && view->ProcessEventLocally(event);
 }
 
     return view && view->ProcessEventLocally(event);
 }
 


@@ -1317,11 +1382,11 @@ namespace
 {
 
 // helper function: return only the visible templates
 {
 
 // helper function: return only the visible templates

-wxDocTemplates GetVisibleTemplates(const wxList& allTemplates)
+wxDocTemplateVector GetVisibleTemplates(const wxList& allTemplates)

 {
     // select only the visible templates
     const size_t totalNumTemplates = allTemplates.GetCount();
 {
     // select only the visible templates
     const size_t totalNumTemplates = allTemplates.GetCount();

-    wxDocTemplates templates;
+    wxDocTemplateVector templates;

     if ( totalNumTemplates )
     {
         templates.reserve(totalNumTemplates);
     if ( totalNumTemplates )
     {
         templates.reserve(totalNumTemplates);


@@ -1342,15 +1407,28 @@ wxDocTemplates GetVisibleTemplates(const wxList& allTemplates)
 
 } // anonymous namespace
 
 
 } // anonymous namespace
 

-void wxDocManager::ActivateDocument(wxDocument *doc)
+void wxDocument::Activate()

 {
 {

-    wxView * const view = doc->GetFirstView();
+    wxView * const view = GetFirstView();

     if ( !view )
         return;
 
     view->Activate(true);
     if ( wxWindow *win = view->GetFrame() )
     if ( !view )
         return;
 
     view->Activate(true);
     if ( wxWindow *win = view->GetFrame() )

-        win->SetFocus();
+        win->Raise();
+}
+
+wxDocument* wxDocManager::FindDocumentByPath(const wxString& path) const
+{
+    const wxFileName fileName(path);
+    for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
+    {
+        wxDocument * const doc = wxStaticCast(*i, wxDocument);
+
+        if ( fileName == wxFileName(doc->GetFilename()) )
+            return doc;
+    }
+    return NULL;

 }
 
 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
 }
 
 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)


@@ -1358,7 +1436,7 @@ wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
     // this ought to be const but SelectDocumentType/Path() are not
     // const-correct and can't be changed as, being virtual, this risks
     // breaking user code overriding them
     // this ought to be const but SelectDocumentType/Path() are not
     // const-correct and can't be changed as, being virtual, this risks
     // breaking user code overriding them

-    wxDocTemplates templates(GetVisibleTemplates(m_templates));
+    wxDocTemplateVector templates(GetVisibleTemplates(m_templates));

     const size_t numTemplates = templates.size();
     if ( !numTemplates )
     {
     const size_t numTemplates = templates.size();
     if ( !numTemplates )
     {


@@ -1399,21 +1477,15 @@ wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
     // check whether the document with this path is already opened
     if ( !path.empty() )
     {
     // check whether the document with this path is already opened
     if ( !path.empty() )
     {

-        const wxFileName fn(path);
-        for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
+        wxDocument * const doc = FindDocumentByPath(path);
+        if (doc)

         {
         {

-            wxDocument * const doc = (wxDocument*)*i;
-
-            if ( fn == doc->GetFilename() )
-            {
-                // file already open, just activate it and return
-                ActivateDocument(doc);
-                return doc;
-            }
+            // file already open, just activate it and return
+            doc->Activate();
+            return doc;

         }
     }
 
         }
     }
 

-

     // no, we need to create a new document
 
 
     // no, we need to create a new document
 
 


@@ -1458,14 +1530,14 @@ wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
     // at least under Mac (where views are top level windows) it seems to be
     // necessary to manually activate the new document to bring it to the
     // forefront -- and it shouldn't hurt doing this under the other platforms
     // at least under Mac (where views are top level windows) it seems to be
     // necessary to manually activate the new document to bring it to the
     // forefront -- and it shouldn't hurt doing this under the other platforms

-    ActivateDocument(docNew);
+    docNew->Activate();

 
     return docNew;
 }
 
 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
 {
 
     return docNew;
 }
 
 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
 {

-    wxDocTemplates templates(GetVisibleTemplates(m_templates));
+    wxDocTemplateVector templates(GetVisibleTemplates(m_templates));

     const size_t numTemplates = templates.size();
 
     if ( numTemplates == 0 )
     const size_t numTemplates = templates.size();
 
     if ( numTemplates == 0 )


@@ -1498,7 +1570,7 @@ bool wxDocManager::FlushDoc(wxDocument *WXUNUSED(doc))
 
 wxDocument *wxDocManager::GetCurrentDocument() const
 {
 
 wxDocument *wxDocManager::GetCurrentDocument() const
 {

-    wxView * const view = GetActiveView();
+    wxView * const view = GetAnyUsableView();

     return view ? view->GetDocument() : NULL;
 }
 
     return view ? view->GetDocument() : NULL;
 }
 


@@ -1942,6 +2014,26 @@ void wxDocManager::ActivateView(wxView *view, bool activate)
 // wxDocChildFrameAnyBase
 // ----------------------------------------------------------------------------
 
 // wxDocChildFrameAnyBase
 // ----------------------------------------------------------------------------
 

+bool wxDocChildFrameAnyBase::TryProcessEvent(wxEvent& event)
+{
+    if ( !m_childView )
+    {
+        // We must be being destroyed, don't forward events anywhere as
+        // m_childDocument could be invalid by now.
+        return false;
+    }
+
+    // Forward the event to the document manager which will, in turn, forward
+    // it to its active view which must be our m_childView.
+    //
+    // Notice that we do things in this roundabout way to guarantee the correct
+    // event handlers call order: first the document, then the new and then the
+    // document manager itself. And if we forwarded the event directly to the
+    // view, then the document manager would do it once again when we forwarded
+    // it to it.
+    return m_childDocument->GetDocumentManager()->ProcessEventLocally(event);
+}
+

 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
 {
     if ( m_childView )
 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
 {
     if ( m_childView )


@@ -1974,6 +2066,44 @@ bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
 // wxDocParentFrameAnyBase
 // ----------------------------------------------------------------------------
 
 // wxDocParentFrameAnyBase
 // ----------------------------------------------------------------------------
 

+bool wxDocParentFrameAnyBase::TryProcessEvent(wxEvent& event)
+{
+    if ( !m_docManager )
+        return false;
+
+    // If we have an active view, its associated child frame may have
+    // already forwarded the event to wxDocManager, check for this:
+    if ( wxView* const view = m_docManager->GetAnyUsableView() )
+    {
+        wxWindow* win = view->GetFrame();
+        if ( win && win != m_frame )
+        {
+            // Notice that we intentionally don't use wxGetTopLevelParent()
+            // here because we want to check both for the case of a child
+            // "frame" (e.g. MDI child frame or notebook page) inside this TLW
+            // and a separate child TLW frame (as used in the SDI mode) here.
+            for ( win = win->GetParent(); win; win = win->GetParent() )
+            {
+                if ( win == m_frame )
+                    return false;
+            }
+        }
+        //else: This view is directly associated with the parent frame (which
+        //      can happen in the so called "single" mode in which only one
+        //      document can be opened and so is managed by the parent frame
+        //      itself), there can be no child frame in play so we must forward
+        //      the event to wxDocManager ourselves.
+    }
+
+    // But forward the event to wxDocManager ourselves if there are no views at
+    // all or if we are the frame's view ourselves.
+    return m_docManager->ProcessEventLocally(event);
+}
+
+// ----------------------------------------------------------------------------
+// Printing support
+// ----------------------------------------------------------------------------
+

 #if wxUSE_PRINTING_ARCHITECTURE
 
 namespace
 #if wxUSE_PRINTING_ARCHITECTURE
 
 namespace