src/common/docview.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/docview.cpp
   3 // Purpose:     Document/view classes
   4 // Author:      Julian Smart
   5 // Modified by: Vadim Zeitlin
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 #if wxUSE_DOC_VIEW_ARCHITECTURE
  28
  29 #include "wx/docview.h"
  30
  31 #ifndef WX_PRECOMP
  32     #include "wx/list.h"
  33     #include "wx/string.h"
  34     #include "wx/utils.h"
  35     #include "wx/app.h"
  36     #include "wx/dc.h"
  37     #include "wx/dialog.h"
  38     #include "wx/menu.h"
  39     #include "wx/filedlg.h"
  40     #include "wx/intl.h"
  41     #include "wx/log.h"
  42     #include "wx/msgdlg.h"
  43     #include "wx/mdi.h"
  44     #include "wx/choicdlg.h"
  45 #endif
  46
  47 #if wxUSE_PRINTING_ARCHITECTURE
  48     #include "wx/prntbase.h"
  49     #include "wx/printdlg.h"
  50 #endif
  51
  52 #include "wx/confbase.h"
  53 #include "wx/filename.h"
  54 #include "wx/file.h"
  55 #include "wx/ffile.h"
  56 #include "wx/cmdproc.h"
  57 #include "wx/tokenzr.h"
  58 #include "wx/filename.h"
  59 #include "wx/stdpaths.h"
  60 #include "wx/vector.h"
  61 #include "wx/scopedarray.h"
  62 #include "wx/scopedptr.h"
  63 #include "wx/except.h"
  64
  65 #if wxUSE_STD_IOSTREAM
  66     #include "wx/ioswrap.h"
  67     #include "wx/beforestd.h"
  68     #if wxUSE_IOSTREAMH
  69         #include <fstream.h>
  70     #else
  71         #include <fstream>
  72     #endif
  73     #include "wx/afterstd.h"
  74 #else
  75     #include "wx/wfstream.h"
  76 #endif
  77
  78 typedef wxVector<wxDocTemplate *> wxDocTemplates;
  79
  80 // ----------------------------------------------------------------------------
  81 // wxWidgets macros
  82 // ----------------------------------------------------------------------------
  83
  84 IMPLEMENT_ABSTRACT_CLASS(wxDocument, wxEvtHandler)
  85 IMPLEMENT_ABSTRACT_CLASS(wxView, wxEvtHandler)
  86 IMPLEMENT_ABSTRACT_CLASS(wxDocTemplate, wxObject)
  87 IMPLEMENT_DYNAMIC_CLASS(wxDocManager, wxEvtHandler)
  88 IMPLEMENT_CLASS(wxDocChildFrame, wxFrame)
  89 IMPLEMENT_CLASS(wxDocParentFrame, wxFrame)
  90
  91 #if wxUSE_PRINTING_ARCHITECTURE
  92     IMPLEMENT_DYNAMIC_CLASS(wxDocPrintout, wxPrintout)
  93 #endif
  94
  95 // ============================================================================
  96 // implementation
  97 // ============================================================================
  98
  99 // ----------------------------------------------------------------------------
 100 // private helpers
 101 // ----------------------------------------------------------------------------
 102
 103 namespace
 104 {
 105
 106 wxString FindExtension(const wxString& path)
 107 {
 108     wxString ext;
 109     wxFileName::SplitPath(path, NULL, NULL, &ext);
 110
 111     // VZ: extensions are considered not case sensitive - is this really a good
 112     //     idea?
 113     return ext.MakeLower();
 114 }
 115
 116 } // anonymous namespace
 117
 118 // ----------------------------------------------------------------------------
 119 // Definition of wxDocument
 120 // ----------------------------------------------------------------------------
 121
 122 wxDocument::wxDocument(wxDocument *parent)
 123 {
 124     m_documentModified = false;
 125     m_documentTemplate = NULL;
 126
 127     m_documentParent = parent;
 128     if ( parent )
 129         parent->m_childDocuments.push_back(this);
 130
 131     m_commandProcessor = NULL;
 132     m_savedYet = false;
 133 }
 134
 135 bool wxDocument::DeleteContents()
 136 {
 137     return true;
 138 }
 139
 140 wxDocument::~wxDocument()
 141 {
 142     delete m_commandProcessor;
 143
 144     if (GetDocumentManager())
 145         GetDocumentManager()->RemoveDocument(this);
 146
 147     if ( m_documentParent )
 148         m_documentParent->m_childDocuments.remove(this);
 149
 150     // Not safe to do here, since it'll invoke virtual view functions
 151     // expecting to see valid derived objects: and by the time we get here,
 152     // we've called destructors higher up.
 153     //DeleteAllViews();
 154 }
 155
 156 bool wxDocument::Close()
 157 {
 158     if ( !OnSaveModified() )
 159         return false;
 160
 161     // When the parent document closes, its children must be closed as well as
 162     // they can't exist without the parent.
 163
 164     // As usual, first check if all children can be closed.
 165     DocsList::const_iterator it = m_childDocuments.begin();
 166     for ( DocsList::const_iterator end = m_childDocuments.end(); it != end; ++it )
 167     {
 168         if ( !(*it)->OnSaveModified() )
 169         {
 170             // Leave the parent document opened if a child can't close.
 171             return false;
 172         }
 173     }
 174
 175     // Now that they all did, do close them: as m_childDocuments is modified as
 176     // we iterate over it, don't use the usual for-style iteration here.
 177     while ( !m_childDocuments.empty() )
 178     {
 179         wxDocument * const childDoc = m_childDocuments.front();
 180
 181         // This will call OnSaveModified() once again but it shouldn't do
 182         // anything as the document was just saved or marked as not needing to
 183         // be saved by the call to OnSaveModified() that returned true above.
 184         if ( !childDoc->Close() )
 185         {
 186             wxFAIL_MSG( "Closing the child document unexpectedly failed "
 187                         "after its OnSaveModified() returned true" );
 188         }
 189
 190         // Delete the child document by deleting all its views.
 191         childDoc->DeleteAllViews();
 192     }
 193
 194
 195     return OnCloseDocument();
 196 }
 197
 198 bool wxDocument::OnCloseDocument()
 199 {
 200     // Tell all views that we're about to close
 201     NotifyClosing();
 202     DeleteContents();
 203     Modify(false);
 204     return true;
 205 }
 206
 207 // Note that this implicitly deletes the document when the last view is
 208 // deleted.
 209 bool wxDocument::DeleteAllViews()
 210 {
 211     wxDocManager* manager = GetDocumentManager();
 212
 213     // first check if all views agree to be closed
 214     const wxList::iterator end = m_documentViews.end();
 215     for ( wxList::iterator i = m_documentViews.begin(); i != end; ++i )
 216     {
 217         wxView *view = (wxView *)*i;
 218         if ( !view->Close() )
 219             return false;
 220     }
 221
 222     // all views agreed to close, now do close them
 223     if ( m_documentViews.empty() )
 224     {
 225         // normally the document would be implicitly deleted when the last view
 226         // is, but if don't have any views, do it here instead
 227         if ( manager && manager->GetDocuments().Member(this) )
 228             delete this;
 229     }
 230     else // have views
 231     {
 232         // as we delete elements we iterate over, don't use the usual "from
 233         // begin to end" loop
 234         for ( ;; )
 235         {
 236             wxView *view = (wxView *)*m_documentViews.begin();
 237
 238             bool isLastOne = m_documentViews.size() == 1;
 239
 240             // this always deletes the node implicitly and if this is the last
 241             // view also deletes this object itself (also implicitly, great),
 242             // so we can't test for m_documentViews.empty() after calling this!
 243             delete view;
 244
 245             if ( isLastOne )
 246                 break;
 247         }
 248     }
 249
 250     return true;
 251 }
 252
 253 wxView *wxDocument::GetFirstView() const
 254 {
 255     if ( m_documentViews.empty() )
 256         return NULL;
 257
 258     return static_cast<wxView *>(m_documentViews.GetFirst()->GetData());
 259 }
 260
 261 void wxDocument::Modify(bool mod)
 262 {
 263     if (mod != m_documentModified)
 264     {
 265         m_documentModified = mod;
 266
 267         // Allow views to append asterix to the title
 268         wxView* view = GetFirstView();
 269         if (view) view->OnChangeFilename();
 270     }
 271 }
 272
 273 wxDocManager *wxDocument::GetDocumentManager() const
 274 {
 275     // For child documents we use the same document manager as the parent, even
 276     // though we don't have our own template (as children are not opened/saved
 277     // directly).
 278     if ( m_documentParent )
 279         return m_documentParent->GetDocumentManager();
 280
 281     return m_documentTemplate ? m_documentTemplate->GetDocumentManager() : NULL;
 282 }
 283
 284 bool wxDocument::OnNewDocument()
 285 {
 286     // notice that there is no need to neither reset nor even check the
 287     // modified flag here as the document itself is a new object (this is only
 288     // called from CreateDocument()) and so it shouldn't be saved anyhow even
 289     // if it is modified -- this could happen if the user code creates
 290     // documents pre-filled with some user-entered (and which hence must not be
 291     // lost) information
 292
 293     SetDocumentSaved(false);
 294
 295     const wxString name = GetDocumentManager()->MakeNewDocumentName();
 296     SetTitle(name);
 297     SetFilename(name, true);
 298
 299     return true;
 300 }
 301
 302 bool wxDocument::Save()
 303 {
 304     if ( AlreadySaved() )
 305         return true;
 306
 307     if ( m_documentFile.empty() || !m_savedYet )
 308         return SaveAs();
 309
 310     return OnSaveDocument(m_documentFile);
 311 }
 312
 313 bool wxDocument::SaveAs()
 314 {
 315     wxDocTemplate *docTemplate = GetDocumentTemplate();
 316     if (!docTemplate)
 317         return false;
 318
 319 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
 320     wxString filter = docTemplate->GetDescription() + wxT(" (") +
 321         docTemplate->GetFileFilter() + wxT(")|") +
 322         docTemplate->GetFileFilter();
 323
 324     // Now see if there are some other template with identical view and document
 325     // classes, whose filters may also be used.
 326     if (docTemplate->GetViewClassInfo() && docTemplate->GetDocClassInfo())
 327     {
 328         wxList::compatibility_iterator
 329             node = docTemplate->GetDocumentManager()->GetTemplates().GetFirst();
 330         while (node)
 331         {
 332             wxDocTemplate *t = (wxDocTemplate*) node->GetData();
 333
 334             if (t->IsVisible() && t != docTemplate &&
 335                 t->GetViewClassInfo() == docTemplate->GetViewClassInfo() &&
 336                 t->GetDocClassInfo() == docTemplate->GetDocClassInfo())
 337             {
 338                 // add a '|' to separate this filter from the previous one
 339                 if ( !filter.empty() )
 340                     filter << wxT('|');
 341
 342                 filter << t->GetDescription()
 343                        << wxT(" (") << t->GetFileFilter() << wxT(") |")
 344                        << t->GetFileFilter();
 345             }
 346
 347             node = node->GetNext();
 348         }
 349     }
 350 #else
 351     wxString filter = docTemplate->GetFileFilter() ;
 352 #endif
 353
 354     wxString defaultDir = docTemplate->GetDirectory();
 355     if ( defaultDir.empty() )
 356     {
 357         defaultDir = wxPathOnly(GetFilename());
 358         if ( defaultDir.empty() )
 359             defaultDir = GetDocumentManager()->GetLastDirectory();
 360     }
 361
 362     wxString fileName = wxFileSelector(_("Save As"),
 363             defaultDir,
 364             wxFileNameFromPath(GetFilename()),
 365             docTemplate->GetDefaultExtension(),
 366             filter,
 367             wxFD_SAVE | wxFD_OVERWRITE_PROMPT,
 368             GetDocumentWindow());
 369
 370     if (fileName.empty())
 371         return false; // cancelled by user
 372
 373     // Files that were not saved correctly are not added to the FileHistory.
 374     if (!OnSaveDocument(fileName))
 375         return false;
 376
 377     SetTitle(wxFileNameFromPath(fileName));
 378     SetFilename(fileName, true);    // will call OnChangeFileName automatically
 379
 380     // A file that doesn't use the default extension of its document template
 381     // cannot be opened via the FileHistory, so we do not add it.
 382     if (docTemplate->FileMatchesTemplate(fileName))
 383     {
 384         GetDocumentManager()->AddFileToHistory(fileName);
 385     }
 386     //else: the user will probably not be able to open the file again, so we
 387     //      could warn about the wrong file-extension here
 388
 389     return true;
 390 }
 391
 392 bool wxDocument::OnSaveDocument(const wxString& file)
 393 {
 394     if ( !file )
 395         return false;
 396
 397     if ( !DoSaveDocument(file) )
 398         return false;
 399
 400     Modify(false);
 401     SetFilename(file);
 402     SetDocumentSaved(true);
 403 #if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
 404     wxFileName fn(file) ;
 405     fn.MacSetDefaultTypeAndCreator() ;
 406 #endif
 407     return true;
 408 }
 409
 410 bool wxDocument::OnOpenDocument(const wxString& file)
 411 {
 412     // notice that there is no need to check the modified flag here for the
 413     // reasons explained in OnNewDocument()
 414
 415     if ( !DoOpenDocument(file) )
 416         return false;
 417
 418     SetFilename(file, true);
 419
 420     // stretching the logic a little this does make sense because the document
 421     // had been saved into the file we just loaded it from, it just could have
 422     // happened during a previous program execution, it's just that the name of
 423     // this method is a bit unfortunate, it should probably have been called
 424     // HasAssociatedFileName()
 425     SetDocumentSaved(true);
 426
 427     UpdateAllViews();
 428
 429     return true;
 430 }
 431
 432 #if wxUSE_STD_IOSTREAM
 433 wxSTD istream& wxDocument::LoadObject(wxSTD istream& stream)
 434 #else
 435 wxInputStream& wxDocument::LoadObject(wxInputStream& stream)
 436 #endif
 437 {
 438     return stream;
 439 }
 440
 441 #if wxUSE_STD_IOSTREAM
 442 wxSTD ostream& wxDocument::SaveObject(wxSTD ostream& stream)
 443 #else
 444 wxOutputStream& wxDocument::SaveObject(wxOutputStream& stream)
 445 #endif
 446 {
 447     return stream;
 448 }
 449
 450 bool wxDocument::Revert()
 451 {
 452     if ( wxMessageBox
 453          (
 454             _("Discard changes and reload the last saved version?"),
 455             wxTheApp->GetAppDisplayName(),
 456             wxYES_NO | wxCANCEL | wxICON_QUESTION,
 457             GetDocumentWindow()
 458           ) != wxYES )
 459         return false;
 460
 461     if ( !DoOpenDocument(GetFilename()) )
 462         return false;
 463
 464     Modify(false);
 465     UpdateAllViews();
 466
 467     return true;
 468 }
 469
 470
 471 // Get title, or filename if no title, else unnamed
 472 #if WXWIN_COMPATIBILITY_2_8
 473 bool wxDocument::GetPrintableName(wxString& buf) const
 474 {
 475     // this function cannot only be overridden by the user code but also
 476     // called by it so we need to ensure that we return the same thing as
 477     // GetUserReadableName() but we can't call it because this would result in
 478     // an infinite recursion, hence we use the helper DoGetUserReadableName()
 479     buf = DoGetUserReadableName();
 480
 481     return true;
 482 }
 483 #endif // WXWIN_COMPATIBILITY_2_8
 484
 485 wxString wxDocument::GetUserReadableName() const
 486 {
 487 #if WXWIN_COMPATIBILITY_2_8
 488     // we need to call the old virtual function to ensure that the overridden
 489     // version of it is still called
 490     wxString name;
 491     if ( GetPrintableName(name) )
 492         return name;
 493 #endif // WXWIN_COMPATIBILITY_2_8
 494
 495     return DoGetUserReadableName();
 496 }
 497
 498 wxString wxDocument::DoGetUserReadableName() const
 499 {
 500     if ( !m_documentTitle.empty() )
 501         return m_documentTitle;
 502
 503     if ( !m_documentFile.empty() )
 504         return wxFileNameFromPath(m_documentFile);
 505
 506     return _("unnamed");
 507 }
 508
 509 wxWindow *wxDocument::GetDocumentWindow() const
 510 {
 511     wxView * const view = GetFirstView();
 512
 513     return view ? view->GetFrame() : wxTheApp->GetTopWindow();
 514 }
 515
 516 wxCommandProcessor *wxDocument::OnCreateCommandProcessor()
 517 {
 518     return new wxCommandProcessor;
 519 }
 520
 521 // true if safe to close
 522 bool wxDocument::OnSaveModified()
 523 {
 524     if ( IsModified() )
 525     {
 526         switch ( wxMessageBox
 527                  (
 528                     wxString::Format
 529                     (
 530                      _("Do you want to save changes to %s?"),
 531                      GetUserReadableName()
 532                     ),
 533                     wxTheApp->GetAppDisplayName(),
 534                     wxYES_NO | wxCANCEL | wxICON_QUESTION | wxCENTRE
 535                  ) )
 536         {
 537             case wxNO:
 538                 Modify(false);
 539                 break;
 540
 541             case wxYES:
 542                 return Save();
 543
 544             case wxCANCEL:
 545                 return false;
 546         }
 547     }
 548
 549     return true;
 550 }
 551
 552 bool wxDocument::Draw(wxDC& WXUNUSED(context))
 553 {
 554     return true;
 555 }
 556
 557 bool wxDocument::AddView(wxView *view)
 558 {
 559     if ( !m_documentViews.Member(view) )
 560     {
 561         m_documentViews.Append(view);
 562         OnChangedViewList();
 563     }
 564     return true;
 565 }
 566
 567 bool wxDocument::RemoveView(wxView *view)
 568 {
 569     (void)m_documentViews.DeleteObject(view);
 570     OnChangedViewList();
 571     return true;
 572 }
 573
 574 bool wxDocument::OnCreate(const wxString& WXUNUSED(path), long flags)
 575 {
 576     return GetDocumentTemplate()->CreateView(this, flags) != NULL;
 577 }
 578
 579 // Called after a view is added or removed.
 580 // The default implementation deletes the document if
 581 // there are no more views.
 582 void wxDocument::OnChangedViewList()
 583 {
 584     if ( m_documentViews.empty() && OnSaveModified() )
 585         delete this;
 586 }
 587
 588 void wxDocument::UpdateAllViews(wxView *sender, wxObject *hint)
 589 {
 590     wxList::compatibility_iterator node = m_documentViews.GetFirst();
 591     while (node)
 592     {
 593         wxView *view = (wxView *)node->GetData();
 594         if (view != sender)
 595             view->OnUpdate(sender, hint);
 596         node = node->GetNext();
 597     }
 598 }
 599
 600 void wxDocument::NotifyClosing()
 601 {
 602     wxList::compatibility_iterator node = m_documentViews.GetFirst();
 603     while (node)
 604     {
 605         wxView *view = (wxView *)node->GetData();
 606         view->OnClosingDocument();
 607         node = node->GetNext();
 608     }
 609 }
 610
 611 void wxDocument::SetFilename(const wxString& filename, bool notifyViews)
 612 {
 613     m_documentFile = filename;
 614     OnChangeFilename(notifyViews);
 615 }
 616
 617 void wxDocument::OnChangeFilename(bool notifyViews)
 618 {
 619     if ( notifyViews )
 620     {
 621         // Notify the views that the filename has changed
 622         wxList::compatibility_iterator node = m_documentViews.GetFirst();
 623         while (node)
 624         {
 625             wxView *view = (wxView *)node->GetData();
 626             view->OnChangeFilename();
 627             node = node->GetNext();
 628         }
 629     }
 630 }
 631
 632 bool wxDocument::DoSaveDocument(const wxString& file)
 633 {
 634 #if wxUSE_STD_IOSTREAM
 635     wxSTD ofstream store(file.mb_str(), wxSTD ios::binary);
 636     if ( !store )
 637 #else
 638     wxFileOutputStream store(file);
 639     if ( store.GetLastError() != wxSTREAM_NO_ERROR )
 640 #endif
 641     {
 642         wxLogError(_("File \"%s\" could not be opened for writing."), file);
 643         return false;
 644     }
 645
 646     if (!SaveObject(store))
 647     {
 648         wxLogError(_("Failed to save document to the file \"%s\"."), file);
 649         return false;
 650     }
 651
 652     return true;
 653 }
 654
 655 bool wxDocument::DoOpenDocument(const wxString& file)
 656 {
 657 #if wxUSE_STD_IOSTREAM
 658     wxSTD ifstream store(file.mb_str(), wxSTD ios::binary);
 659     if ( !store )
 660 #else
 661     wxFileInputStream store(file);
 662     if (store.GetLastError() != wxSTREAM_NO_ERROR || !store.IsOk())
 663 #endif
 664     {
 665         wxLogError(_("File \"%s\" could not be opened for reading."), file);
 666         return false;
 667     }
 668
 669 #if wxUSE_STD_IOSTREAM
 670     LoadObject(store);
 671     if ( !store )
 672 #else
 673     int res = LoadObject(store).GetLastError();
 674     if ( res != wxSTREAM_NO_ERROR && res != wxSTREAM_EOF )
 675 #endif
 676     {
 677         wxLogError(_("Failed to read document from the file \"%s\"."), file);
 678         return false;
 679     }
 680
 681     return true;
 682 }
 683
 684
 685 // ----------------------------------------------------------------------------
 686 // Document view
 687 // ----------------------------------------------------------------------------
 688
 689 wxView::wxView()
 690 {
 691     m_viewDocument = NULL;
 692
 693     m_viewFrame = NULL;
 694
 695     m_docChildFrame = NULL;
 696 }
 697
 698 wxView::~wxView()
 699 {
 700     if (m_viewDocument && GetDocumentManager())
 701         GetDocumentManager()->ActivateView(this, false);
 702
 703     // reset our frame view first, before removing it from the document as
 704     // SetView(NULL) is a simple call while RemoveView() may result in user
 705     // code being executed and this user code can, for example, show a message
 706     // box which would result in an activation event for m_docChildFrame and so
 707     // could reactivate the view being destroyed -- unless we reset it first
 708     if ( m_docChildFrame && m_docChildFrame->GetView() == this )
 709     {
 710         // prevent it from doing anything with us
 711         m_docChildFrame->SetView(NULL);
 712
 713         // it doesn't make sense to leave the frame alive if its associated
 714         // view doesn't exist any more so unconditionally close it as well
 715         //
 716         // notice that we only get here if m_docChildFrame is non-NULL in the
 717         // first place and it will be always NULL if we're deleted because our
 718         // frame was closed, so this only catches the case of directly deleting
 719         // the view, as it happens if its creation fails in wxDocTemplate::
 720         // CreateView() for example
 721         m_docChildFrame->GetWindow()->Destroy();
 722     }
 723
 724     if ( m_viewDocument )
 725         m_viewDocument->RemoveView(this);
 726 }
 727
 728 void wxView::SetDocChildFrame(wxDocChildFrameAnyBase *docChildFrame)
 729 {
 730     SetFrame(docChildFrame ? docChildFrame->GetWindow() : NULL);
 731     m_docChildFrame = docChildFrame;
 732 }
 733
 734 bool wxView::TryBefore(wxEvent& event)
 735 {
 736     wxDocument * const doc = GetDocument();
 737     return doc && doc->ProcessEventLocally(event);
 738 }
 739
 740 void wxView::OnActivateView(bool WXUNUSED(activate),
 741                             wxView *WXUNUSED(activeView),
 742                             wxView *WXUNUSED(deactiveView))
 743 {
 744 }
 745
 746 void wxView::OnPrint(wxDC *dc, wxObject *WXUNUSED(info))
 747 {
 748     OnDraw(dc);
 749 }
 750
 751 void wxView::OnUpdate(wxView *WXUNUSED(sender), wxObject *WXUNUSED(hint))
 752 {
 753 }
 754
 755 void wxView::OnChangeFilename()
 756 {
 757     // GetFrame can return wxWindow rather than wxTopLevelWindow due to
 758     // generic MDI implementation so use SetLabel rather than SetTitle.
 759     // It should cause SetTitle() for top level windows.
 760     wxWindow *win = GetFrame();
 761     if (!win) return;
 762
 763     wxDocument *doc = GetDocument();
 764     if (!doc) return;
 765
 766     wxString label = doc->GetUserReadableName();
 767     if (doc->IsModified())
 768     {
 769        label += "*";
 770     }
 771     win->SetLabel(label);
 772 }
 773
 774 void wxView::SetDocument(wxDocument *doc)
 775 {
 776     m_viewDocument = doc;
 777     if (doc)
 778         doc->AddView(this);
 779 }
 780
 781 bool wxView::Close(bool deleteWindow)
 782 {
 783     return OnClose(deleteWindow);
 784 }
 785
 786 void wxView::Activate(bool activate)
 787 {
 788     if (GetDocument() && GetDocumentManager())
 789     {
 790         OnActivateView(activate, this, GetDocumentManager()->GetCurrentView());
 791         GetDocumentManager()->ActivateView(this, activate);
 792     }
 793 }
 794
 795 bool wxView::OnClose(bool WXUNUSED(deleteWindow))
 796 {
 797     return GetDocument() ? GetDocument()->Close() : true;
 798 }
 799
 800 #if wxUSE_PRINTING_ARCHITECTURE
 801 wxPrintout *wxView::OnCreatePrintout()
 802 {
 803     return new wxDocPrintout(this);
 804 }
 805 #endif // wxUSE_PRINTING_ARCHITECTURE
 806
 807 // ----------------------------------------------------------------------------
 808 // wxDocTemplate
 809 // ----------------------------------------------------------------------------
 810
 811 wxDocTemplate::wxDocTemplate(wxDocManager *manager,
 812                              const wxString& descr,
 813                              const wxString& filter,
 814                              const wxString& dir,
 815                              const wxString& ext,
 816                              const wxString& docTypeName,
 817                              const wxString& viewTypeName,
 818                              wxClassInfo *docClassInfo,
 819                              wxClassInfo *viewClassInfo,
 820                              long flags)
 821 {
 822     m_documentManager = manager;
 823     m_description = descr;
 824     m_directory = dir;
 825     m_defaultExt = ext;
 826     m_fileFilter = filter;
 827     m_flags = flags;
 828     m_docTypeName = docTypeName;
 829     m_viewTypeName = viewTypeName;
 830     m_documentManager->AssociateTemplate(this);
 831
 832     m_docClassInfo = docClassInfo;
 833     m_viewClassInfo = viewClassInfo;
 834 }
 835
 836 wxDocTemplate::~wxDocTemplate()
 837 {
 838     m_documentManager->DisassociateTemplate(this);
 839 }
 840
 841 // Tries to dynamically construct an object of the right class.
 842 wxDocument *wxDocTemplate::CreateDocument(const wxString& path, long flags)
 843 {
 844     // InitDocument() is supposed to delete the document object if its
 845     // initialization fails so don't use wxScopedPtr<> here: this is fragile
 846     // but unavoidable because the default implementation uses CreateView()
 847     // which may -- or not -- create a wxView and if it does create it and its
 848     // initialization fails then the view destructor will delete the document
 849     // (via RemoveView()) and as we can't distinguish between the two cases we
 850     // just have to assume that it always deletes it in case of failure
 851     wxDocument * const doc = DoCreateDocument();
 852
 853     return doc && InitDocument(doc, path, flags) ? doc : NULL;
 854 }
 855
 856 bool
 857 wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
 858 {
 859     doc->SetFilename(path);
 860     doc->SetDocumentTemplate(this);
 861     GetDocumentManager()->AddDocument(doc);
 862     doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
 863
 864     if (doc->OnCreate(path, flags))
 865         return true;
 866
 867     if (GetDocumentManager()->GetDocuments().Member(doc))
 868         doc->DeleteAllViews();
 869     return false;
 870 }
 871
 872 wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
 873 {
 874     wxScopedPtr<wxView> view(DoCreateView());
 875     if ( !view )
 876         return NULL;
 877
 878     view->SetDocument(doc);
 879     if ( !view->OnCreate(doc, flags) )
 880         return NULL;
 881
 882     return view.release();
 883 }
 884
 885 // The default (very primitive) format detection: check is the extension is
 886 // that of the template
 887 bool wxDocTemplate::FileMatchesTemplate(const wxString& path)
 888 {
 889     wxStringTokenizer parser (GetFileFilter(), wxT(";"));
 890     wxString anything = wxT ("*");
 891     while (parser.HasMoreTokens())
 892     {
 893         wxString filter = parser.GetNextToken();
 894         wxString filterExt = FindExtension (filter);
 895         if ( filter.IsSameAs (anything)    ||
 896              filterExt.IsSameAs (anything) ||
 897              filterExt.IsSameAs (FindExtension (path)) )
 898             return true;
 899     }
 900     return GetDefaultExtension().IsSameAs(FindExtension(path));
 901 }
 902
 903 wxDocument *wxDocTemplate::DoCreateDocument()
 904 {
 905     if (!m_docClassInfo)
 906         return NULL;
 907
 908     return static_cast<wxDocument *>(m_docClassInfo->CreateObject());
 909 }
 910
 911 wxView *wxDocTemplate::DoCreateView()
 912 {
 913     if (!m_viewClassInfo)
 914         return NULL;
 915
 916     return static_cast<wxView *>(m_viewClassInfo->CreateObject());
 917 }
 918
 919 // ----------------------------------------------------------------------------
 920 // wxDocManager
 921 // ----------------------------------------------------------------------------
 922
 923 BEGIN_EVENT_TABLE(wxDocManager, wxEvtHandler)
 924     EVT_MENU(wxID_OPEN, wxDocManager::OnFileOpen)
 925     EVT_MENU(wxID_CLOSE, wxDocManager::OnFileClose)
 926     EVT_MENU(wxID_CLOSE_ALL, wxDocManager::OnFileCloseAll)
 927     EVT_MENU(wxID_REVERT, wxDocManager::OnFileRevert)
 928     EVT_MENU(wxID_NEW, wxDocManager::OnFileNew)
 929     EVT_MENU(wxID_SAVE, wxDocManager::OnFileSave)
 930     EVT_MENU(wxID_SAVEAS, wxDocManager::OnFileSaveAs)
 931     EVT_MENU(wxID_UNDO, wxDocManager::OnUndo)
 932     EVT_MENU(wxID_REDO, wxDocManager::OnRedo)
 933
 934     // We don't know in advance how many items can there be in the MRU files
 935     // list so set up OnMRUFile() as a handler for all menu events and do the
 936     // check for the id of the menu item clicked inside it.
 937     EVT_MENU(wxID_ANY, wxDocManager::OnMRUFile)
 938
 939     EVT_UPDATE_UI(wxID_OPEN, wxDocManager::OnUpdateFileOpen)
 940     EVT_UPDATE_UI(wxID_CLOSE, wxDocManager::OnUpdateDisableIfNoDoc)
 941     EVT_UPDATE_UI(wxID_CLOSE_ALL, wxDocManager::OnUpdateDisableIfNoDoc)
 942     EVT_UPDATE_UI(wxID_REVERT, wxDocManager::OnUpdateFileRevert)
 943     EVT_UPDATE_UI(wxID_NEW, wxDocManager::OnUpdateFileNew)
 944     EVT_UPDATE_UI(wxID_SAVE, wxDocManager::OnUpdateFileSave)
 945     EVT_UPDATE_UI(wxID_SAVEAS, wxDocManager::OnUpdateFileSaveAs)
 946     EVT_UPDATE_UI(wxID_UNDO, wxDocManager::OnUpdateUndo)
 947     EVT_UPDATE_UI(wxID_REDO, wxDocManager::OnUpdateRedo)
 948
 949 #if wxUSE_PRINTING_ARCHITECTURE
 950     EVT_MENU(wxID_PRINT, wxDocManager::OnPrint)
 951     EVT_MENU(wxID_PREVIEW, wxDocManager::OnPreview)
 952     EVT_MENU(wxID_PRINT_SETUP, wxDocManager::OnPageSetup)
 953
 954     EVT_UPDATE_UI(wxID_PRINT, wxDocManager::OnUpdateDisableIfNoDoc)
 955     EVT_UPDATE_UI(wxID_PREVIEW, wxDocManager::OnUpdateDisableIfNoDoc)
 956     // NB: we keep "Print setup" menu item always enabled as it can be used
 957     //     even without an active document
 958 #endif // wxUSE_PRINTING_ARCHITECTURE
 959 END_EVENT_TABLE()
 960
 961 wxDocManager* wxDocManager::sm_docManager = NULL;
 962
 963 wxDocManager::wxDocManager(long WXUNUSED(flags), bool initialize)
 964 {
 965     sm_docManager = this;
 966
 967     m_defaultDocumentNameCounter = 1;
 968     m_currentView = NULL;
 969     m_maxDocsOpen = INT_MAX;
 970     m_fileHistory = NULL;
 971     if ( initialize )
 972         Initialize();
 973 }
 974
 975 wxDocManager::~wxDocManager()
 976 {
 977     Clear();
 978     delete m_fileHistory;
 979     sm_docManager = NULL;
 980 }
 981
 982 // closes the specified document
 983 bool wxDocManager::CloseDocument(wxDocument* doc, bool force)
 984 {
 985     if ( !doc->Close() && !force )
 986         return false;
 987
 988     // Implicitly deletes the document when
 989     // the last view is deleted
 990     doc->DeleteAllViews();
 991
 992     // Check we're really deleted
 993     if (m_docs.Member(doc))
 994         delete doc;
 995
 996     return true;
 997 }
 998
 999 bool wxDocManager::CloseDocuments(bool force)
1000 {
1001     wxList::compatibility_iterator node = m_docs.GetFirst();
1002     while (node)
1003     {
1004         wxDocument *doc = (wxDocument *)node->GetData();
1005         wxList::compatibility_iterator next = node->GetNext();
1006
1007         if (!CloseDocument(doc, force))
1008             return false;
1009
1010         // This assumes that documents are not connected in
1011         // any way, i.e. deleting one document does NOT
1012         // delete another.
1013         node = next;
1014     }
1015     return true;
1016 }
1017
1018 bool wxDocManager::Clear(bool force)
1019 {
1020     if (!CloseDocuments(force))
1021         return false;
1022
1023     m_currentView = NULL;
1024
1025     wxList::compatibility_iterator node = m_templates.GetFirst();
1026     while (node)
1027     {
1028         wxDocTemplate *templ = (wxDocTemplate*) node->GetData();
1029         wxList::compatibility_iterator next = node->GetNext();
1030         delete templ;
1031         node = next;
1032     }
1033     return true;
1034 }
1035
1036 bool wxDocManager::Initialize()
1037 {
1038     m_fileHistory = OnCreateFileHistory();
1039     return true;
1040 }
1041
1042 wxString wxDocManager::GetLastDirectory() const
1043 {
1044     // if we haven't determined the last used directory yet, do it now
1045     if ( m_lastDirectory.empty() )
1046     {
1047         // we're going to modify m_lastDirectory in this const method, so do it
1048         // via non-const self pointer instead of const this one
1049         wxDocManager * const self = const_cast<wxDocManager *>(this);
1050
1051         // first try to reuse the directory of the most recently opened file:
1052         // this ensures that if the user opens a file, closes the program and
1053         // runs it again the "Open file" dialog will open in the directory of
1054         // the last file he used
1055         if ( m_fileHistory && m_fileHistory->GetCount() )
1056         {
1057             const wxString lastOpened = m_fileHistory->GetHistoryFile(0);
1058             const wxFileName fn(lastOpened);
1059             if ( fn.DirExists() )
1060             {
1061                 self->m_lastDirectory = fn.GetPath();
1062             }
1063             //else: should we try the next one?
1064         }
1065         //else: no history yet
1066
1067         // if we don't have any files in the history (yet?), use the
1068         // system-dependent default location for the document files
1069         if ( m_lastDirectory.empty() )
1070         {
1071             self->m_lastDirectory = wxStandardPaths::Get().GetAppDocumentsDir();
1072         }
1073     }
1074
1075     return m_lastDirectory;
1076 }
1077
1078 wxFileHistory *wxDocManager::OnCreateFileHistory()
1079 {
1080     return new wxFileHistory;
1081 }
1082
1083 void wxDocManager::OnFileClose(wxCommandEvent& WXUNUSED(event))
1084 {
1085     wxDocument *doc = GetCurrentDocument();
1086     if (doc)
1087         CloseDocument(doc);
1088 }
1089
1090 void wxDocManager::OnFileCloseAll(wxCommandEvent& WXUNUSED(event))
1091 {
1092     CloseDocuments(false);
1093 }
1094
1095 void wxDocManager::OnFileNew(wxCommandEvent& WXUNUSED(event))
1096 {
1097     CreateNewDocument();
1098 }
1099
1100 void wxDocManager::OnFileOpen(wxCommandEvent& WXUNUSED(event))
1101 {
1102     if ( !CreateDocument("") )
1103     {
1104         OnOpenFileFailure();
1105     }
1106 }
1107
1108 void wxDocManager::OnFileRevert(wxCommandEvent& WXUNUSED(event))
1109 {
1110     wxDocument *doc = GetCurrentDocument();
1111     if (!doc)
1112         return;
1113     doc->Revert();
1114 }
1115
1116 void wxDocManager::OnFileSave(wxCommandEvent& WXUNUSED(event))
1117 {
1118     wxDocument *doc = GetCurrentDocument();
1119     if (!doc)
1120         return;
1121     doc->Save();
1122 }
1123
1124 void wxDocManager::OnFileSaveAs(wxCommandEvent& WXUNUSED(event))
1125 {
1126     wxDocument *doc = GetCurrentDocument();
1127     if (!doc)
1128         return;
1129     doc->SaveAs();
1130 }
1131
1132 void wxDocManager::OnMRUFile(wxCommandEvent& event)
1133 {
1134     // Check if the id is in the range assigned to MRU list entries.
1135     const int id = event.GetId();
1136     if ( id >= wxID_FILE1 &&
1137             id < wxID_FILE1 + static_cast<int>(m_fileHistory->GetCount()) )
1138     {
1139         DoOpenMRUFile(id - wxID_FILE1);
1140     }
1141     else
1142     {
1143         event.Skip();
1144     }
1145 }
1146
1147 void wxDocManager::DoOpenMRUFile(unsigned n)
1148 {
1149     wxString filename(GetHistoryFile(n));
1150     if ( filename.empty() )
1151         return;
1152
1153     wxString errMsg; // must contain exactly one "%s" if non-empty
1154     if ( wxFile::Exists(filename) )
1155     {
1156         // Try to open it but don't give an error if it failed: this could be
1157         // normal, e.g. because the user cancelled opening it, and we don't
1158         // have any useful information to put in the error message anyhow, so
1159         // we assume that in case of an error the appropriate message had been
1160         // already logged.
1161         (void)CreateDocument(filename, wxDOC_SILENT);
1162     }
1163     else // file doesn't exist
1164     {
1165         OnMRUFileNotExist(n, filename);
1166     }
1167 }
1168
1169 void wxDocManager::OnMRUFileNotExist(unsigned n, const wxString& filename)
1170 {
1171     // remove the file which we can't open from the MRU list
1172     RemoveFileFromHistory(n);
1173
1174     // and tell the user about it
1175     wxLogError(_("The file '%s' doesn't exist and couldn't be opened.\n"
1176                  "It has been removed from the most recently used files list."),
1177                filename);
1178 }
1179
1180 #if wxUSE_PRINTING_ARCHITECTURE
1181
1182 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
1183 {
1184     wxView *view = GetActiveView();
1185     if (!view)
1186         return;
1187
1188     wxPrintout *printout = view->OnCreatePrintout();
1189     if (printout)
1190     {
1191         wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1192         wxPrinter printer(&printDialogData);
1193         printer.Print(view->GetFrame(), printout, true);
1194
1195         delete printout;
1196     }
1197 }
1198
1199 void wxDocManager::OnPageSetup(wxCommandEvent& WXUNUSED(event))
1200 {
1201     wxPageSetupDialog dlg(wxTheApp->GetTopWindow(), &m_pageSetupDialogData);
1202     if ( dlg.ShowModal() == wxID_OK )
1203     {
1204         m_pageSetupDialogData = dlg.GetPageSetupData();
1205     }
1206 }
1207
1208 wxPreviewFrame* wxDocManager::CreatePreviewFrame(wxPrintPreviewBase* preview,
1209                                                  wxWindow *parent,
1210                                                  const wxString& title)
1211 {
1212     return new wxPreviewFrame(preview, parent, title);
1213 }
1214
1215 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
1216 {
1217     wxBusyCursor busy;
1218     wxView *view = GetActiveView();
1219     if (!view)
1220         return;
1221
1222     wxPrintout *printout = view->OnCreatePrintout();
1223     if (printout)
1224     {
1225         wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1226
1227         // Pass two printout objects: for preview, and possible printing.
1228         wxPrintPreviewBase *
1229             preview = new wxPrintPreview(printout,
1230                                          view->OnCreatePrintout(),
1231                                          &printDialogData);
1232         if ( !preview->IsOk() )
1233         {
1234             delete preview;
1235             wxLogError(_("Print preview creation failed."));
1236             return;
1237         }
1238
1239         wxPreviewFrame* frame = CreatePreviewFrame(preview,
1240                                                    wxTheApp->GetTopWindow(),
1241                                                    _("Print Preview"));
1242         wxCHECK_RET( frame, "should create a print preview frame" );
1243
1244         frame->Centre(wxBOTH);
1245         frame->Initialize();
1246         frame->Show(true);
1247     }
1248 }
1249 #endif // wxUSE_PRINTING_ARCHITECTURE
1250
1251 void wxDocManager::OnUndo(wxCommandEvent& event)
1252 {
1253     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1254     if ( !cmdproc )
1255     {
1256         event.Skip();
1257         return;
1258     }
1259
1260     cmdproc->Undo();
1261 }
1262
1263 void wxDocManager::OnRedo(wxCommandEvent& event)
1264 {
1265     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1266     if ( !cmdproc )
1267     {
1268         event.Skip();
1269         return;
1270     }
1271
1272     cmdproc->Redo();
1273 }
1274
1275 // Handlers for UI update commands
1276
1277 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent& event)
1278 {
1279     // CreateDocument() (which is called from OnFileOpen) may succeed
1280     // only when there is at least a template:
1281     event.Enable( GetTemplates().GetCount()>0 );
1282 }
1283
1284 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event)
1285 {
1286     event.Enable( GetCurrentDocument() != NULL );
1287 }
1288
1289 void wxDocManager::OnUpdateFileRevert(wxUpdateUIEvent& event)
1290 {
1291     wxDocument* doc = GetCurrentDocument();
1292     event.Enable(doc && doc->IsModified() && doc->GetDocumentSaved());
1293 }
1294
1295 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent& event)
1296 {
1297     // CreateDocument() (which is called from OnFileNew) may succeed
1298     // only when there is at least a template:
1299     event.Enable( GetTemplates().GetCount()>0 );
1300 }
1301
1302 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
1303 {
1304     wxDocument * const doc = GetCurrentDocument();
1305     event.Enable( doc && !doc->IsChildDocument() && !doc->AlreadySaved() );
1306 }
1307
1308 void wxDocManager::OnUpdateFileSaveAs(wxUpdateUIEvent& event)
1309 {
1310     wxDocument * const doc = GetCurrentDocument();
1311     event.Enable( doc && !doc->IsChildDocument() );
1312 }
1313
1314 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
1315 {
1316     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1317     if ( !cmdproc )
1318     {
1319         event.Enable(false);
1320         return;
1321     }
1322
1323     event.Enable(cmdproc->CanUndo());
1324     cmdproc->SetMenuStrings();
1325 }
1326
1327 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent& event)
1328 {
1329     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1330     if ( !cmdproc )
1331     {
1332         event.Enable(false);
1333         return;
1334     }
1335
1336     event.Enable(cmdproc->CanRedo());
1337     cmdproc->SetMenuStrings();
1338 }
1339
1340 wxView *wxDocManager::GetActiveView() const
1341 {
1342     wxView *view = GetCurrentView();
1343
1344     if ( !view && !m_docs.empty() )
1345     {
1346         // if we have exactly one document, consider its view to be the current
1347         // one
1348         //
1349         // VZ: I'm not exactly sure why is this needed but this is how this
1350         //     code used to behave before the bug #9518 was fixed and it seems
1351         //     safer to preserve the old logic
1352         wxList::compatibility_iterator node = m_docs.GetFirst();
1353         if ( !node->GetNext() )
1354         {
1355             wxDocument *doc = static_cast<wxDocument *>(node->GetData());
1356             view = doc->GetFirstView();
1357         }
1358         //else: we have more than one document
1359     }
1360
1361     return view;
1362 }
1363
1364 bool wxDocManager::TryBefore(wxEvent& event)
1365 {
1366     wxView * const view = GetActiveView();
1367     return view && view->ProcessEventLocally(event);
1368 }
1369
1370 namespace
1371 {
1372
1373 // helper function: return only the visible templates
1374 wxDocTemplates GetVisibleTemplates(const wxList& allTemplates)
1375 {
1376     // select only the visible templates
1377     const size_t totalNumTemplates = allTemplates.GetCount();
1378     wxDocTemplates templates;
1379     if ( totalNumTemplates )
1380     {
1381         templates.reserve(totalNumTemplates);
1382
1383         for ( wxList::const_iterator i = allTemplates.begin(),
1384                                    end = allTemplates.end();
1385               i != end;
1386               ++i )
1387         {
1388             wxDocTemplate * const temp = (wxDocTemplate *)*i;
1389             if ( temp->IsVisible() )
1390                 templates.push_back(temp);
1391         }
1392     }
1393
1394     return templates;
1395 }
1396
1397 } // anonymous namespace
1398
1399 void wxDocManager::ActivateDocument(wxDocument *doc)
1400 {
1401     wxView * const view = doc->GetFirstView();
1402     if ( !view )
1403         return;
1404
1405     view->Activate(true);
1406     if ( wxWindow *win = view->GetFrame() )
1407         win->SetFocus();
1408 }
1409
1410 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
1411 {
1412     // this ought to be const but SelectDocumentType/Path() are not
1413     // const-correct and can't be changed as, being virtual, this risks
1414     // breaking user code overriding them
1415     wxDocTemplates templates(GetVisibleTemplates(m_templates));
1416     const size_t numTemplates = templates.size();
1417     if ( !numTemplates )
1418     {
1419         // no templates can be used, can't create document
1420         return NULL;
1421     }
1422
1423
1424     // normally user should select the template to use but wxDOC_SILENT flag we
1425     // choose one ourselves
1426     wxString path = pathOrig;   // may be modified below
1427     wxDocTemplate *temp;
1428     if ( flags & wxDOC_SILENT )
1429     {
1430         wxASSERT_MSG( !path.empty(),
1431                       "using empty path with wxDOC_SILENT doesn't make sense" );
1432
1433         temp = FindTemplateForPath(path);
1434         if ( !temp )
1435         {
1436             wxLogWarning(_("The format of file '%s' couldn't be determined."),
1437                          path);
1438         }
1439     }
1440     else // not silent, ask the user
1441     {
1442         // for the new file we need just the template, for an existing one we
1443         // need the template and the path, unless it's already specified
1444         if ( (flags & wxDOC_NEW) || !path.empty() )
1445             temp = SelectDocumentType(&templates[0], numTemplates);
1446         else
1447             temp = SelectDocumentPath(&templates[0], numTemplates, path, flags);
1448     }
1449
1450     if ( !temp )
1451         return NULL;
1452
1453     // check whether the document with this path is already opened
1454     if ( !path.empty() )
1455     {
1456         const wxFileName fn(path);
1457         for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
1458         {
1459             wxDocument * const doc = (wxDocument*)*i;
1460
1461             if ( fn == doc->GetFilename() )
1462             {
1463                 // file already open, just activate it and return
1464                 ActivateDocument(doc);
1465                 return doc;
1466             }
1467         }
1468     }
1469
1470
1471     // no, we need to create a new document
1472
1473
1474     // if we've reached the max number of docs, close the first one.
1475     if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen )
1476     {
1477         if ( !CloseDocument((wxDocument *)GetDocuments().GetFirst()->GetData()) )
1478         {
1479             // can't open the new document if closing the old one failed
1480             return NULL;
1481         }
1482     }
1483
1484
1485     // do create and initialize the new document finally
1486     wxDocument * const docNew = temp->CreateDocument(path, flags);
1487     if ( !docNew )
1488         return NULL;
1489
1490     docNew->SetDocumentName(temp->GetDocumentName());
1491     docNew->SetDocumentTemplate(temp);
1492
1493     wxTRY
1494     {
1495         // call the appropriate function depending on whether we're creating a
1496         // new file or opening an existing one
1497         if ( !(flags & wxDOC_NEW ? docNew->OnNewDocument()
1498                                  : docNew->OnOpenDocument(path)) )
1499         {
1500             docNew->DeleteAllViews();
1501             return NULL;
1502         }
1503     }
1504     wxCATCH_ALL( docNew->DeleteAllViews(); throw; )
1505
1506     // add the successfully opened file to MRU, but only if we're going to be
1507     // able to reopen it successfully later which requires the template for
1508     // this document to be retrievable from the file extension
1509     if ( !(flags & wxDOC_NEW) && temp->FileMatchesTemplate(path) )
1510         AddFileToHistory(path);
1511
1512     // at least under Mac (where views are top level windows) it seems to be
1513     // necessary to manually activate the new document to bring it to the
1514     // forefront -- and it shouldn't hurt doing this under the other platforms
1515     ActivateDocument(docNew);
1516
1517     return docNew;
1518 }
1519
1520 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
1521 {
1522     wxDocTemplates templates(GetVisibleTemplates(m_templates));
1523     const size_t numTemplates = templates.size();
1524
1525     if ( numTemplates == 0 )
1526         return NULL;
1527
1528     wxDocTemplate * const
1529     temp = numTemplates == 1 ? templates[0]
1530                              : SelectViewType(&templates[0], numTemplates);
1531
1532     if ( !temp )
1533         return NULL;
1534
1535     wxView *view = temp->CreateView(doc, flags);
1536     if ( view )
1537         view->SetViewName(temp->GetViewName());
1538     return view;
1539 }
1540
1541 // Not yet implemented
1542 void
1543 wxDocManager::DeleteTemplate(wxDocTemplate *WXUNUSED(temp), long WXUNUSED(flags))
1544 {
1545 }
1546
1547 // Not yet implemented
1548 bool wxDocManager::FlushDoc(wxDocument *WXUNUSED(doc))
1549 {
1550     return false;
1551 }
1552
1553 wxDocument *wxDocManager::GetCurrentDocument() const
1554 {
1555     wxView * const view = GetActiveView();
1556     return view ? view->GetDocument() : NULL;
1557 }
1558
1559 wxCommandProcessor *wxDocManager::GetCurrentCommandProcessor() const
1560 {
1561     wxDocument * const doc = GetCurrentDocument();
1562     return doc ? doc->GetCommandProcessor() : NULL;
1563 }
1564
1565 // Make a default name for a new document
1566 #if WXWIN_COMPATIBILITY_2_8
1567 bool wxDocManager::MakeDefaultName(wxString& WXUNUSED(name))
1568 {
1569     // we consider that this function can only be overridden by the user code,
1570     // not called by it as it only makes sense to call it internally, so we
1571     // don't bother to return anything from here
1572     return false;
1573 }
1574 #endif // WXWIN_COMPATIBILITY_2_8
1575
1576 wxString wxDocManager::MakeNewDocumentName()
1577 {
1578     wxString name;
1579
1580 #if WXWIN_COMPATIBILITY_2_8
1581     if ( !MakeDefaultName(name) )
1582 #endif // WXWIN_COMPATIBILITY_2_8
1583     {
1584         name.Printf(_("unnamed%d"), m_defaultDocumentNameCounter);
1585         m_defaultDocumentNameCounter++;
1586     }
1587
1588     return name;
1589 }
1590
1591 // Make a frame title (override this to do something different)
1592 // If docName is empty, a document is not currently active.
1593 wxString wxDocManager::MakeFrameTitle(wxDocument* doc)
1594 {
1595     wxString appName = wxTheApp->GetAppDisplayName();
1596     wxString title;
1597     if (!doc)
1598         title = appName;
1599     else
1600     {
1601         wxString docName = doc->GetUserReadableName();
1602         title = docName + wxString(_(" - ")) + appName;
1603     }
1604     return title;
1605 }
1606
1607
1608 // Not yet implemented
1609 wxDocTemplate *wxDocManager::MatchTemplate(const wxString& WXUNUSED(path))
1610 {
1611     return NULL;
1612 }
1613
1614 // File history management
1615 void wxDocManager::AddFileToHistory(const wxString& file)
1616 {
1617     if (m_fileHistory)
1618         m_fileHistory->AddFileToHistory(file);
1619 }
1620
1621 void wxDocManager::RemoveFileFromHistory(size_t i)
1622 {
1623     if (m_fileHistory)
1624         m_fileHistory->RemoveFileFromHistory(i);
1625 }
1626
1627 wxString wxDocManager::GetHistoryFile(size_t i) const
1628 {
1629     wxString histFile;
1630
1631     if (m_fileHistory)
1632         histFile = m_fileHistory->GetHistoryFile(i);
1633
1634     return histFile;
1635 }
1636
1637 void wxDocManager::FileHistoryUseMenu(wxMenu *menu)
1638 {
1639     if (m_fileHistory)
1640         m_fileHistory->UseMenu(menu);
1641 }
1642
1643 void wxDocManager::FileHistoryRemoveMenu(wxMenu *menu)
1644 {
1645     if (m_fileHistory)
1646         m_fileHistory->RemoveMenu(menu);
1647 }
1648
1649 #if wxUSE_CONFIG
1650 void wxDocManager::FileHistoryLoad(const wxConfigBase& config)
1651 {
1652     if (m_fileHistory)
1653         m_fileHistory->Load(config);
1654 }
1655
1656 void wxDocManager::FileHistorySave(wxConfigBase& config)
1657 {
1658     if (m_fileHistory)
1659         m_fileHistory->Save(config);
1660 }
1661 #endif
1662
1663 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu* menu)
1664 {
1665     if (m_fileHistory)
1666         m_fileHistory->AddFilesToMenu(menu);
1667 }
1668
1669 void wxDocManager::FileHistoryAddFilesToMenu()
1670 {
1671     if (m_fileHistory)
1672         m_fileHistory->AddFilesToMenu();
1673 }
1674
1675 size_t wxDocManager::GetHistoryFilesCount() const
1676 {
1677     return m_fileHistory ? m_fileHistory->GetCount() : 0;
1678 }
1679
1680
1681 // Find out the document template via matching in the document file format
1682 // against that of the template
1683 wxDocTemplate *wxDocManager::FindTemplateForPath(const wxString& path)
1684 {
1685     wxDocTemplate *theTemplate = NULL;
1686
1687     // Find the template which this extension corresponds to
1688     for (size_t i = 0; i < m_templates.GetCount(); i++)
1689     {
1690         wxDocTemplate *temp = (wxDocTemplate *)m_templates.Item(i)->GetData();
1691         if ( temp->FileMatchesTemplate(path) )
1692         {
1693             theTemplate = temp;
1694             break;
1695         }
1696     }
1697     return theTemplate;
1698 }
1699
1700 // Prompts user to open a file, using file specs in templates.
1701 // Must extend the file selector dialog or implement own; OR
1702 // match the extension to the template extension.
1703
1704 wxDocTemplate *wxDocManager::SelectDocumentPath(wxDocTemplate **templates,
1705                                                 int noTemplates,
1706                                                 wxString& path,
1707                                                 long WXUNUSED(flags),
1708                                                 bool WXUNUSED(save))
1709 {
1710 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
1711     wxString descrBuf;
1712
1713     for (int i = 0; i < noTemplates; i++)
1714     {
1715         if (templates[i]->IsVisible())
1716         {
1717             // add a '|' to separate this filter from the previous one
1718             if ( !descrBuf.empty() )
1719                 descrBuf << wxT('|');
1720
1721             descrBuf << templates[i]->GetDescription()
1722                 << wxT(" (") << templates[i]->GetFileFilter() << wxT(") |")
1723                 << templates[i]->GetFileFilter();
1724         }
1725     }
1726 #else
1727     wxString descrBuf = wxT("*.*");
1728     wxUnusedVar(noTemplates);
1729 #endif
1730
1731     int FilterIndex = -1;
1732
1733     wxString pathTmp = wxFileSelectorEx(_("Open File"),
1734                                         GetLastDirectory(),
1735                                         wxEmptyString,
1736                                         &FilterIndex,
1737                                         descrBuf,
1738                                         wxFD_OPEN | wxFD_FILE_MUST_EXIST);
1739
1740     wxDocTemplate *theTemplate = NULL;
1741     if (!pathTmp.empty())
1742     {
1743         if (!wxFileExists(pathTmp))
1744         {
1745             wxString msgTitle;
1746             if (!wxTheApp->GetAppDisplayName().empty())
1747                 msgTitle = wxTheApp->GetAppDisplayName();
1748             else
1749                 msgTitle = wxString(_("File error"));
1750
1751             wxMessageBox(_("Sorry, could not open this file."),
1752                          msgTitle,
1753                          wxOK | wxICON_EXCLAMATION | wxCENTRE);
1754
1755             path = wxEmptyString;
1756             return NULL;
1757         }
1758
1759         SetLastDirectory(wxPathOnly(pathTmp));
1760
1761         path = pathTmp;
1762
1763         // first choose the template using the extension, if this fails (i.e.
1764         // wxFileSelectorEx() didn't fill it), then use the path
1765         if ( FilterIndex != -1 )
1766             theTemplate = templates[FilterIndex];
1767         if ( !theTemplate )
1768             theTemplate = FindTemplateForPath(path);
1769         if ( !theTemplate )
1770         {
1771             // Since we do not add files with non-default extensions to the
1772             // file history this can only happen if the application changes the
1773             // allowed templates in runtime.
1774             wxMessageBox(_("Sorry, the format for this file is unknown."),
1775                          _("Open File"),
1776                          wxOK | wxICON_EXCLAMATION | wxCENTRE);
1777         }
1778     }
1779     else
1780     {
1781         path.clear();
1782     }
1783
1784     return theTemplate;
1785 }
1786
1787 wxDocTemplate *wxDocManager::SelectDocumentType(wxDocTemplate **templates,
1788                                                 int noTemplates, bool sort)
1789 {
1790     wxArrayString strings;
1791     wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1792     int i;
1793     int n = 0;
1794
1795     for (i = 0; i < noTemplates; i++)
1796     {
1797         if (templates[i]->IsVisible())
1798         {
1799             int j;
1800             bool want = true;
1801             for (j = 0; j < n; j++)
1802             {
1803                 //filter out NOT unique documents + view combinations
1804                 if ( templates[i]->m_docTypeName == data[j]->m_docTypeName &&
1805                      templates[i]->m_viewTypeName == data[j]->m_viewTypeName
1806                    )
1807                     want = false;
1808             }
1809
1810             if ( want )
1811             {
1812                 strings.Add(templates[i]->m_description);
1813
1814                 data[n] = templates[i];
1815                 n ++;
1816             }
1817         }
1818     }  // for
1819
1820     if (sort)
1821     {
1822         strings.Sort(); // ascending sort
1823         // Yes, this will be slow, but template lists
1824         // are typically short.
1825         int j;
1826         n = strings.Count();
1827         for (i = 0; i < n; i++)
1828         {
1829             for (j = 0; j < noTemplates; j++)
1830             {
1831                 if (strings[i] == templates[j]->m_description)
1832                     data[i] = templates[j];
1833             }
1834         }
1835     }
1836
1837     wxDocTemplate *theTemplate;
1838
1839     switch ( n )
1840     {
1841         case 0:
1842             // no visible templates, hence nothing to choose from
1843             theTemplate = NULL;
1844             break;
1845
1846         case 1:
1847             // don't propose the user to choose if he has no choice
1848             theTemplate = data[0];
1849             break;
1850
1851         default:
1852             // propose the user to choose one of several
1853             theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1854                           (
1855                             _("Select a document template"),
1856                             _("Templates"),
1857                             strings,
1858                             (void **)data.get()
1859                           );
1860     }
1861
1862     return theTemplate;
1863 }
1864
1865 wxDocTemplate *wxDocManager::SelectViewType(wxDocTemplate **templates,
1866                                             int noTemplates, bool sort)
1867 {
1868     wxArrayString strings;
1869     wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1870     int i;
1871     int n = 0;
1872
1873     for (i = 0; i < noTemplates; i++)
1874     {
1875         wxDocTemplate *templ = templates[i];
1876         if ( templ->IsVisible() && !templ->GetViewName().empty() )
1877         {
1878             int j;
1879             bool want = true;
1880             for (j = 0; j < n; j++)
1881             {
1882                 //filter out NOT unique views
1883                 if ( templates[i]->m_viewTypeName == data[j]->m_viewTypeName )
1884                     want = false;
1885             }
1886
1887             if ( want )
1888             {
1889                 strings.Add(templ->m_viewTypeName);
1890                 data[n] = templ;
1891                 n ++;
1892             }
1893         }
1894     }
1895
1896     if (sort)
1897     {
1898         strings.Sort(); // ascending sort
1899         // Yes, this will be slow, but template lists
1900         // are typically short.
1901         int j;
1902         n = strings.Count();
1903         for (i = 0; i < n; i++)
1904         {
1905             for (j = 0; j < noTemplates; j++)
1906             {
1907                 if (strings[i] == templates[j]->m_viewTypeName)
1908                     data[i] = templates[j];
1909             }
1910         }
1911     }
1912
1913     wxDocTemplate *theTemplate;
1914
1915     // the same logic as above
1916     switch ( n )
1917     {
1918         case 0:
1919             theTemplate = NULL;
1920             break;
1921
1922         case 1:
1923             theTemplate = data[0];
1924             break;
1925
1926         default:
1927             theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1928                           (
1929                             _("Select a document view"),
1930                             _("Views"),
1931                             strings,
1932                             (void **)data.get()
1933                           );
1934
1935     }
1936
1937     return theTemplate;
1938 }
1939
1940 void wxDocManager::AssociateTemplate(wxDocTemplate *temp)
1941 {
1942     if (!m_templates.Member(temp))
1943         m_templates.Append(temp);
1944 }
1945
1946 void wxDocManager::DisassociateTemplate(wxDocTemplate *temp)
1947 {
1948     m_templates.DeleteObject(temp);
1949 }
1950
1951 wxDocTemplate* wxDocManager::FindTemplate(const wxClassInfo* classinfo)
1952 {
1953    for ( wxList::compatibility_iterator node = m_templates.GetFirst();
1954          node;
1955          node = node->GetNext() )
1956    {
1957       wxDocTemplate* t = wxStaticCast(node->GetData(), wxDocTemplate);
1958       if ( t->GetDocClassInfo() == classinfo )
1959          return t;
1960    }
1961
1962    return NULL;
1963 }
1964
1965 // Add and remove a document from the manager's list
1966 void wxDocManager::AddDocument(wxDocument *doc)
1967 {
1968     if (!m_docs.Member(doc))
1969         m_docs.Append(doc);
1970 }
1971
1972 void wxDocManager::RemoveDocument(wxDocument *doc)
1973 {
1974     m_docs.DeleteObject(doc);
1975 }
1976
1977 // Views or windows should inform the document manager
1978 // when a view is going in or out of focus
1979 void wxDocManager::ActivateView(wxView *view, bool activate)
1980 {
1981     if ( activate )
1982     {
1983         m_currentView = view;
1984     }
1985     else // deactivate
1986     {
1987         if ( m_currentView == view )
1988         {
1989             // don't keep stale pointer
1990             m_currentView = NULL;
1991         }
1992     }
1993 }
1994
1995 // ----------------------------------------------------------------------------
1996 // wxDocChildFrameAnyBase
1997 // ----------------------------------------------------------------------------
1998
1999 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
2000 {
2001     if ( m_childView )
2002     {
2003         // notice that we must call wxView::Close() and OnClose() called from
2004         // it in any case, even if we know that we are going to close anyhow
2005         if ( !m_childView->Close(false) && event.CanVeto() )
2006         {
2007             event.Veto();
2008             return false;
2009         }
2010
2011         m_childView->Activate(false);
2012
2013         // it is important to reset m_childView frame pointer to NULL before
2014         // deleting it because while normally it is the frame which deletes the
2015         // view when it's closed, the view also closes the frame if it is
2016         // deleted directly not by us as indicated by its doc child frame
2017         // pointer still being set
2018         m_childView->SetDocChildFrame(NULL);
2019         wxDELETE(m_childView);
2020     }
2021
2022     m_childDocument = NULL;
2023
2024     return true;
2025 }
2026
2027 // ----------------------------------------------------------------------------
2028 // wxDocParentFrameAnyBase
2029 // ----------------------------------------------------------------------------
2030
2031 #if wxUSE_PRINTING_ARCHITECTURE
2032
2033 namespace
2034 {
2035
2036 wxString GetAppropriateTitle(const wxView *view, const wxString& titleGiven)
2037 {
2038     wxString title(titleGiven);
2039     if ( title.empty() )
2040     {
2041         if ( view && view->GetDocument() )
2042             title = view->GetDocument()->GetUserReadableName();
2043         else
2044             title = _("Printout");
2045     }
2046
2047     return title;
2048 }
2049
2050 } // anonymous namespace
2051
2052 wxDocPrintout::wxDocPrintout(wxView *view, const wxString& title)
2053              : wxPrintout(GetAppropriateTitle(view, title))
2054 {
2055     m_printoutView = view;
2056 }
2057
2058 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page))
2059 {
2060     wxDC *dc = GetDC();
2061
2062     // Get the logical pixels per inch of screen and printer
2063     int ppiScreenX, ppiScreenY;
2064     GetPPIScreen(&ppiScreenX, &ppiScreenY);
2065     wxUnusedVar(ppiScreenY);
2066     int ppiPrinterX, ppiPrinterY;
2067     GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
2068     wxUnusedVar(ppiPrinterY);
2069
2070     // This scales the DC so that the printout roughly represents the
2071     // the screen scaling. The text point size _should_ be the right size
2072     // but in fact is too small for some reason. This is a detail that will
2073     // need to be addressed at some point but can be fudged for the
2074     // moment.
2075     float scale = (float)((float)ppiPrinterX/(float)ppiScreenX);
2076
2077     // Now we have to check in case our real page size is reduced
2078     // (e.g. because we're drawing to a print preview memory DC)
2079     int pageWidth, pageHeight;
2080     int w, h;
2081     dc->GetSize(&w, &h);
2082     GetPageSizePixels(&pageWidth, &pageHeight);
2083     wxUnusedVar(pageHeight);
2084
2085     // If printer pageWidth == current DC width, then this doesn't
2086     // change. But w might be the preview bitmap width, so scale down.
2087     float overallScale = scale * (float)(w/(float)pageWidth);
2088     dc->SetUserScale(overallScale, overallScale);
2089
2090     if (m_printoutView)
2091     {
2092         m_printoutView->OnDraw(dc);
2093     }
2094     return true;
2095 }
2096
2097 bool wxDocPrintout::HasPage(int pageNum)
2098 {
2099     return (pageNum == 1);
2100 }
2101
2102 bool wxDocPrintout::OnBeginDocument(int startPage, int endPage)
2103 {
2104     if (!wxPrintout::OnBeginDocument(startPage, endPage))
2105         return false;
2106
2107     return true;
2108 }
2109
2110 void wxDocPrintout::GetPageInfo(int *minPage, int *maxPage,
2111                                 int *selPageFrom, int *selPageTo)
2112 {
2113     *minPage = 1;
2114     *maxPage = 1;
2115     *selPageFrom = 1;
2116     *selPageTo = 1;
2117 }
2118
2119 #endif // wxUSE_PRINTING_ARCHITECTURE
2120
2121 // ----------------------------------------------------------------------------
2122 // Permits compatibility with existing file formats and functions that
2123 // manipulate files directly
2124 // ----------------------------------------------------------------------------
2125
2126 #if wxUSE_STD_IOSTREAM
2127
2128 bool wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream)
2129 {
2130 #if wxUSE_FFILE
2131     wxFFile file(filename, wxT("rb"));
2132 #elif wxUSE_FILE
2133     wxFile file(filename, wxFile::read);
2134 #endif
2135     if ( !file.IsOpened() )
2136         return false;
2137
2138     char buf[4096];
2139
2140     size_t nRead;
2141     do
2142     {
2143         nRead = file.Read(buf, WXSIZEOF(buf));
2144         if ( file.Error() )
2145             return false;
2146
2147         stream.write(buf, nRead);
2148         if ( !stream )
2149             return false;
2150     }
2151     while ( !file.Eof() );
2152
2153     return true;
2154 }
2155
2156 bool wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename)
2157 {
2158 #if wxUSE_FFILE
2159     wxFFile file(filename, wxT("wb"));
2160 #elif wxUSE_FILE
2161     wxFile file(filename, wxFile::write);
2162 #endif
2163     if ( !file.IsOpened() )
2164         return false;
2165
2166     char buf[4096];
2167     do
2168     {
2169         stream.read(buf, WXSIZEOF(buf));
2170         if ( !stream.bad() ) // fail may be set on EOF, don't use operator!()
2171         {
2172             if ( !file.Write(buf, stream.gcount()) )
2173                 return false;
2174         }
2175     }
2176     while ( !stream.eof() );
2177
2178     return true;
2179 }
2180
2181 #else // !wxUSE_STD_IOSTREAM
2182
2183 bool wxTransferFileToStream(const wxString& filename, wxOutputStream& stream)
2184 {
2185 #if wxUSE_FFILE
2186     wxFFile file(filename, wxT("rb"));
2187 #elif wxUSE_FILE
2188     wxFile file(filename, wxFile::read);
2189 #endif
2190     if ( !file.IsOpened() )
2191         return false;
2192
2193     char buf[4096];
2194
2195     size_t nRead;
2196     do
2197     {
2198         nRead = file.Read(buf, WXSIZEOF(buf));
2199         if ( file.Error() )
2200             return false;
2201
2202         stream.Write(buf, nRead);
2203         if ( !stream )
2204             return false;
2205     }
2206     while ( !file.Eof() );
2207
2208     return true;
2209 }
2210
2211 bool wxTransferStreamToFile(wxInputStream& stream, const wxString& filename)
2212 {
2213 #if wxUSE_FFILE
2214     wxFFile file(filename, wxT("wb"));
2215 #elif wxUSE_FILE
2216     wxFile file(filename, wxFile::write);
2217 #endif
2218     if ( !file.IsOpened() )
2219         return false;
2220
2221     char buf[4096];
2222     for ( ;; )
2223     {
2224         stream.Read(buf, WXSIZEOF(buf));
2225
2226         const size_t nRead = stream.LastRead();
2227         if ( !nRead )
2228         {
2229             if ( stream.Eof() )
2230                 break;
2231
2232             return false;
2233         }
2234
2235         if ( !file.Write(buf, nRead) )
2236             return false;
2237     }
2238
2239     return true;
2240 }
2241
2242 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2243
2244 #endif // wxUSE_DOC_VIEW_ARCHITECTURE