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
1157         if ( CreateDocument(filename, wxDOC_SILENT) )
1158             return;
1159
1160         errMsg = _("The file '%s' couldn't be opened.");
1161     }
1162     else // file doesn't exist
1163     {
1164         errMsg = _("The file '%s' doesn't exist and couldn't be opened.");
1165     }
1166
1167
1168     wxASSERT_MSG( !errMsg.empty(), "should have an error message" );
1169
1170     // remove the file which we can't open from the MRU list
1171     RemoveFileFromHistory(n);
1172
1173     // and tell the user about it
1174     wxLogError(errMsg + '\n' +
1175                _("It has been removed from the most recently used files list."),
1176                filename);
1177 }
1178
1179 #if wxUSE_PRINTING_ARCHITECTURE
1180
1181 void wxDocManager::OnPrint(wxCommandEvent& WXUNUSED(event))
1182 {
1183     wxView *view = GetActiveView();
1184     if (!view)
1185         return;
1186
1187     wxPrintout *printout = view->OnCreatePrintout();
1188     if (printout)
1189     {
1190         wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1191         wxPrinter printer(&printDialogData);
1192         printer.Print(view->GetFrame(), printout, true);
1193
1194         delete printout;
1195     }
1196 }
1197
1198 void wxDocManager::OnPageSetup(wxCommandEvent& WXUNUSED(event))
1199 {
1200     wxPageSetupDialog dlg(wxTheApp->GetTopWindow(), &m_pageSetupDialogData);
1201     if ( dlg.ShowModal() == wxID_OK )
1202     {
1203         m_pageSetupDialogData = dlg.GetPageSetupData();
1204     }
1205 }
1206
1207 wxPreviewFrame* wxDocManager::CreatePreviewFrame(wxPrintPreviewBase* preview,
1208                                                  wxWindow *parent,
1209                                                  const wxString& title)
1210 {
1211     return new wxPreviewFrame(preview, parent, title);
1212 }
1213
1214 void wxDocManager::OnPreview(wxCommandEvent& WXUNUSED(event))
1215 {
1216     wxBusyCursor busy;
1217     wxView *view = GetActiveView();
1218     if (!view)
1219         return;
1220
1221     wxPrintout *printout = view->OnCreatePrintout();
1222     if (printout)
1223     {
1224         wxPrintDialogData printDialogData(m_pageSetupDialogData.GetPrintData());
1225
1226         // Pass two printout objects: for preview, and possible printing.
1227         wxPrintPreviewBase *
1228             preview = new wxPrintPreview(printout,
1229                                          view->OnCreatePrintout(),
1230                                          &printDialogData);
1231         if ( !preview->IsOk() )
1232         {
1233             delete preview;
1234             wxLogError(_("Print preview creation failed."));
1235             return;
1236         }
1237
1238         wxPreviewFrame* frame = CreatePreviewFrame(preview,
1239                                                    wxTheApp->GetTopWindow(),
1240                                                    _("Print Preview"));
1241         wxCHECK_RET( frame, "should create a print preview frame" );
1242
1243         frame->Centre(wxBOTH);
1244         frame->Initialize();
1245         frame->Show(true);
1246     }
1247 }
1248 #endif // wxUSE_PRINTING_ARCHITECTURE
1249
1250 void wxDocManager::OnUndo(wxCommandEvent& event)
1251 {
1252     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1253     if ( !cmdproc )
1254     {
1255         event.Skip();
1256         return;
1257     }
1258
1259     cmdproc->Undo();
1260 }
1261
1262 void wxDocManager::OnRedo(wxCommandEvent& event)
1263 {
1264     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1265     if ( !cmdproc )
1266     {
1267         event.Skip();
1268         return;
1269     }
1270
1271     cmdproc->Redo();
1272 }
1273
1274 // Handlers for UI update commands
1275
1276 void wxDocManager::OnUpdateFileOpen(wxUpdateUIEvent& event)
1277 {
1278     // CreateDocument() (which is called from OnFileOpen) may succeed
1279     // only when there is at least a template:
1280     event.Enable( GetTemplates().GetCount()>0 );
1281 }
1282
1283 void wxDocManager::OnUpdateDisableIfNoDoc(wxUpdateUIEvent& event)
1284 {
1285     event.Enable( GetCurrentDocument() != NULL );
1286 }
1287
1288 void wxDocManager::OnUpdateFileRevert(wxUpdateUIEvent& event)
1289 {
1290     wxDocument* doc = GetCurrentDocument();
1291     event.Enable(doc && doc->IsModified() && doc->GetDocumentSaved());
1292 }
1293
1294 void wxDocManager::OnUpdateFileNew(wxUpdateUIEvent& event)
1295 {
1296     // CreateDocument() (which is called from OnFileNew) may succeed
1297     // only when there is at least a template:
1298     event.Enable( GetTemplates().GetCount()>0 );
1299 }
1300
1301 void wxDocManager::OnUpdateFileSave(wxUpdateUIEvent& event)
1302 {
1303     wxDocument * const doc = GetCurrentDocument();
1304     event.Enable( doc && !doc->IsChildDocument() && !doc->AlreadySaved() );
1305 }
1306
1307 void wxDocManager::OnUpdateFileSaveAs(wxUpdateUIEvent& event)
1308 {
1309     wxDocument * const doc = GetCurrentDocument();
1310     event.Enable( doc && !doc->IsChildDocument() );
1311 }
1312
1313 void wxDocManager::OnUpdateUndo(wxUpdateUIEvent& event)
1314 {
1315     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1316     if ( !cmdproc )
1317     {
1318         event.Enable(false);
1319         return;
1320     }
1321
1322     event.Enable(cmdproc->CanUndo());
1323     cmdproc->SetMenuStrings();
1324 }
1325
1326 void wxDocManager::OnUpdateRedo(wxUpdateUIEvent& event)
1327 {
1328     wxCommandProcessor * const cmdproc = GetCurrentCommandProcessor();
1329     if ( !cmdproc )
1330     {
1331         event.Enable(false);
1332         return;
1333     }
1334
1335     event.Enable(cmdproc->CanRedo());
1336     cmdproc->SetMenuStrings();
1337 }
1338
1339 wxView *wxDocManager::GetActiveView() const
1340 {
1341     wxView *view = GetCurrentView();
1342
1343     if ( !view && !m_docs.empty() )
1344     {
1345         // if we have exactly one document, consider its view to be the current
1346         // one
1347         //
1348         // VZ: I'm not exactly sure why is this needed but this is how this
1349         //     code used to behave before the bug #9518 was fixed and it seems
1350         //     safer to preserve the old logic
1351         wxList::compatibility_iterator node = m_docs.GetFirst();
1352         if ( !node->GetNext() )
1353         {
1354             wxDocument *doc = static_cast<wxDocument *>(node->GetData());
1355             view = doc->GetFirstView();
1356         }
1357         //else: we have more than one document
1358     }
1359
1360     return view;
1361 }
1362
1363 bool wxDocManager::TryBefore(wxEvent& event)
1364 {
1365     wxView * const view = GetActiveView();
1366     return view && view->ProcessEventLocally(event);
1367 }
1368
1369 namespace
1370 {
1371
1372 // helper function: return only the visible templates
1373 wxDocTemplates GetVisibleTemplates(const wxList& allTemplates)
1374 {
1375     // select only the visible templates
1376     const size_t totalNumTemplates = allTemplates.GetCount();
1377     wxDocTemplates templates;
1378     if ( totalNumTemplates )
1379     {
1380         templates.reserve(totalNumTemplates);
1381
1382         for ( wxList::const_iterator i = allTemplates.begin(),
1383                                    end = allTemplates.end();
1384               i != end;
1385               ++i )
1386         {
1387             wxDocTemplate * const temp = (wxDocTemplate *)*i;
1388             if ( temp->IsVisible() )
1389                 templates.push_back(temp);
1390         }
1391     }
1392
1393     return templates;
1394 }
1395
1396 } // anonymous namespace
1397
1398 void wxDocManager::ActivateDocument(wxDocument *doc)
1399 {
1400     wxView * const view = doc->GetFirstView();
1401     if ( !view )
1402         return;
1403
1404     view->Activate(true);
1405     if ( wxWindow *win = view->GetFrame() )
1406         win->SetFocus();
1407 }
1408
1409 wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags)
1410 {
1411     // this ought to be const but SelectDocumentType/Path() are not
1412     // const-correct and can't be changed as, being virtual, this risks
1413     // breaking user code overriding them
1414     wxDocTemplates templates(GetVisibleTemplates(m_templates));
1415     const size_t numTemplates = templates.size();
1416     if ( !numTemplates )
1417     {
1418         // no templates can be used, can't create document
1419         return NULL;
1420     }
1421
1422
1423     // normally user should select the template to use but wxDOC_SILENT flag we
1424     // choose one ourselves
1425     wxString path = pathOrig;   // may be modified below
1426     wxDocTemplate *temp;
1427     if ( flags & wxDOC_SILENT )
1428     {
1429         wxASSERT_MSG( !path.empty(),
1430                       "using empty path with wxDOC_SILENT doesn't make sense" );
1431
1432         temp = FindTemplateForPath(path);
1433         if ( !temp )
1434         {
1435             wxLogWarning(_("The format of file '%s' couldn't be determined."),
1436                          path);
1437         }
1438     }
1439     else // not silent, ask the user
1440     {
1441         // for the new file we need just the template, for an existing one we
1442         // need the template and the path, unless it's already specified
1443         if ( (flags & wxDOC_NEW) || !path.empty() )
1444             temp = SelectDocumentType(&templates[0], numTemplates);
1445         else
1446             temp = SelectDocumentPath(&templates[0], numTemplates, path, flags);
1447     }
1448
1449     if ( !temp )
1450         return NULL;
1451
1452     // check whether the document with this path is already opened
1453     if ( !path.empty() )
1454     {
1455         const wxFileName fn(path);
1456         for ( wxList::const_iterator i = m_docs.begin(); i != m_docs.end(); ++i )
1457         {
1458             wxDocument * const doc = (wxDocument*)*i;
1459
1460             if ( fn == doc->GetFilename() )
1461             {
1462                 // file already open, just activate it and return
1463                 ActivateDocument(doc);
1464                 return doc;
1465             }
1466         }
1467     }
1468
1469
1470     // no, we need to create a new document
1471
1472
1473     // if we've reached the max number of docs, close the first one.
1474     if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen )
1475     {
1476         if ( !CloseDocument((wxDocument *)GetDocuments().GetFirst()->GetData()) )
1477         {
1478             // can't open the new document if closing the old one failed
1479             return NULL;
1480         }
1481     }
1482
1483
1484     // do create and initialize the new document finally
1485     wxDocument * const docNew = temp->CreateDocument(path, flags);
1486     if ( !docNew )
1487         return NULL;
1488
1489     docNew->SetDocumentName(temp->GetDocumentName());
1490     docNew->SetDocumentTemplate(temp);
1491
1492     wxTRY
1493     {
1494         // call the appropriate function depending on whether we're creating a
1495         // new file or opening an existing one
1496         if ( !(flags & wxDOC_NEW ? docNew->OnNewDocument()
1497                                  : docNew->OnOpenDocument(path)) )
1498         {
1499             docNew->DeleteAllViews();
1500             return NULL;
1501         }
1502     }
1503     wxCATCH_ALL( docNew->DeleteAllViews(); throw; )
1504
1505     // add the successfully opened file to MRU, but only if we're going to be
1506     // able to reopen it successfully later which requires the template for
1507     // this document to be retrievable from the file extension
1508     if ( !(flags & wxDOC_NEW) && temp->FileMatchesTemplate(path) )
1509         AddFileToHistory(path);
1510
1511     // at least under Mac (where views are top level windows) it seems to be
1512     // necessary to manually activate the new document to bring it to the
1513     // forefront -- and it shouldn't hurt doing this under the other platforms
1514     ActivateDocument(docNew);
1515
1516     return docNew;
1517 }
1518
1519 wxView *wxDocManager::CreateView(wxDocument *doc, long flags)
1520 {
1521     wxDocTemplates templates(GetVisibleTemplates(m_templates));
1522     const size_t numTemplates = templates.size();
1523
1524     if ( numTemplates == 0 )
1525         return NULL;
1526
1527     wxDocTemplate * const
1528     temp = numTemplates == 1 ? templates[0]
1529                              : SelectViewType(&templates[0], numTemplates);
1530
1531     if ( !temp )
1532         return NULL;
1533
1534     wxView *view = temp->CreateView(doc, flags);
1535     if ( view )
1536         view->SetViewName(temp->GetViewName());
1537     return view;
1538 }
1539
1540 // Not yet implemented
1541 void
1542 wxDocManager::DeleteTemplate(wxDocTemplate *WXUNUSED(temp), long WXUNUSED(flags))
1543 {
1544 }
1545
1546 // Not yet implemented
1547 bool wxDocManager::FlushDoc(wxDocument *WXUNUSED(doc))
1548 {
1549     return false;
1550 }
1551
1552 wxDocument *wxDocManager::GetCurrentDocument() const
1553 {
1554     wxView * const view = GetActiveView();
1555     return view ? view->GetDocument() : NULL;
1556 }
1557
1558 wxCommandProcessor *wxDocManager::GetCurrentCommandProcessor() const
1559 {
1560     wxDocument * const doc = GetCurrentDocument();
1561     return doc ? doc->GetCommandProcessor() : NULL;
1562 }
1563
1564 // Make a default name for a new document
1565 #if WXWIN_COMPATIBILITY_2_8
1566 bool wxDocManager::MakeDefaultName(wxString& WXUNUSED(name))
1567 {
1568     // we consider that this function can only be overridden by the user code,
1569     // not called by it as it only makes sense to call it internally, so we
1570     // don't bother to return anything from here
1571     return false;
1572 }
1573 #endif // WXWIN_COMPATIBILITY_2_8
1574
1575 wxString wxDocManager::MakeNewDocumentName()
1576 {
1577     wxString name;
1578
1579 #if WXWIN_COMPATIBILITY_2_8
1580     if ( !MakeDefaultName(name) )
1581 #endif // WXWIN_COMPATIBILITY_2_8
1582     {
1583         name.Printf(_("unnamed%d"), m_defaultDocumentNameCounter);
1584         m_defaultDocumentNameCounter++;
1585     }
1586
1587     return name;
1588 }
1589
1590 // Make a frame title (override this to do something different)
1591 // If docName is empty, a document is not currently active.
1592 wxString wxDocManager::MakeFrameTitle(wxDocument* doc)
1593 {
1594     wxString appName = wxTheApp->GetAppDisplayName();
1595     wxString title;
1596     if (!doc)
1597         title = appName;
1598     else
1599     {
1600         wxString docName = doc->GetUserReadableName();
1601         title = docName + wxString(_(" - ")) + appName;
1602     }
1603     return title;
1604 }
1605
1606
1607 // Not yet implemented
1608 wxDocTemplate *wxDocManager::MatchTemplate(const wxString& WXUNUSED(path))
1609 {
1610     return NULL;
1611 }
1612
1613 // File history management
1614 void wxDocManager::AddFileToHistory(const wxString& file)
1615 {
1616     if (m_fileHistory)
1617         m_fileHistory->AddFileToHistory(file);
1618 }
1619
1620 void wxDocManager::RemoveFileFromHistory(size_t i)
1621 {
1622     if (m_fileHistory)
1623         m_fileHistory->RemoveFileFromHistory(i);
1624 }
1625
1626 wxString wxDocManager::GetHistoryFile(size_t i) const
1627 {
1628     wxString histFile;
1629
1630     if (m_fileHistory)
1631         histFile = m_fileHistory->GetHistoryFile(i);
1632
1633     return histFile;
1634 }
1635
1636 void wxDocManager::FileHistoryUseMenu(wxMenu *menu)
1637 {
1638     if (m_fileHistory)
1639         m_fileHistory->UseMenu(menu);
1640 }
1641
1642 void wxDocManager::FileHistoryRemoveMenu(wxMenu *menu)
1643 {
1644     if (m_fileHistory)
1645         m_fileHistory->RemoveMenu(menu);
1646 }
1647
1648 #if wxUSE_CONFIG
1649 void wxDocManager::FileHistoryLoad(const wxConfigBase& config)
1650 {
1651     if (m_fileHistory)
1652         m_fileHistory->Load(config);
1653 }
1654
1655 void wxDocManager::FileHistorySave(wxConfigBase& config)
1656 {
1657     if (m_fileHistory)
1658         m_fileHistory->Save(config);
1659 }
1660 #endif
1661
1662 void wxDocManager::FileHistoryAddFilesToMenu(wxMenu* menu)
1663 {
1664     if (m_fileHistory)
1665         m_fileHistory->AddFilesToMenu(menu);
1666 }
1667
1668 void wxDocManager::FileHistoryAddFilesToMenu()
1669 {
1670     if (m_fileHistory)
1671         m_fileHistory->AddFilesToMenu();
1672 }
1673
1674 size_t wxDocManager::GetHistoryFilesCount() const
1675 {
1676     return m_fileHistory ? m_fileHistory->GetCount() : 0;
1677 }
1678
1679
1680 // Find out the document template via matching in the document file format
1681 // against that of the template
1682 wxDocTemplate *wxDocManager::FindTemplateForPath(const wxString& path)
1683 {
1684     wxDocTemplate *theTemplate = NULL;
1685
1686     // Find the template which this extension corresponds to
1687     for (size_t i = 0; i < m_templates.GetCount(); i++)
1688     {
1689         wxDocTemplate *temp = (wxDocTemplate *)m_templates.Item(i)->GetData();
1690         if ( temp->FileMatchesTemplate(path) )
1691         {
1692             theTemplate = temp;
1693             break;
1694         }
1695     }
1696     return theTemplate;
1697 }
1698
1699 // Prompts user to open a file, using file specs in templates.
1700 // Must extend the file selector dialog or implement own; OR
1701 // match the extension to the template extension.
1702
1703 wxDocTemplate *wxDocManager::SelectDocumentPath(wxDocTemplate **templates,
1704                                                 int noTemplates,
1705                                                 wxString& path,
1706                                                 long WXUNUSED(flags),
1707                                                 bool WXUNUSED(save))
1708 {
1709 #ifdef wxHAS_MULTIPLE_FILEDLG_FILTERS
1710     wxString descrBuf;
1711
1712     for (int i = 0; i < noTemplates; i++)
1713     {
1714         if (templates[i]->IsVisible())
1715         {
1716             // add a '|' to separate this filter from the previous one
1717             if ( !descrBuf.empty() )
1718                 descrBuf << wxT('|');
1719
1720             descrBuf << templates[i]->GetDescription()
1721                 << wxT(" (") << templates[i]->GetFileFilter() << wxT(") |")
1722                 << templates[i]->GetFileFilter();
1723         }
1724     }
1725 #else
1726     wxString descrBuf = wxT("*.*");
1727     wxUnusedVar(noTemplates);
1728 #endif
1729
1730     int FilterIndex = -1;
1731
1732     wxString pathTmp = wxFileSelectorEx(_("Open File"),
1733                                         GetLastDirectory(),
1734                                         wxEmptyString,
1735                                         &FilterIndex,
1736                                         descrBuf,
1737                                         wxFD_OPEN | wxFD_FILE_MUST_EXIST);
1738
1739     wxDocTemplate *theTemplate = NULL;
1740     if (!pathTmp.empty())
1741     {
1742         if (!wxFileExists(pathTmp))
1743         {
1744             wxString msgTitle;
1745             if (!wxTheApp->GetAppDisplayName().empty())
1746                 msgTitle = wxTheApp->GetAppDisplayName();
1747             else
1748                 msgTitle = wxString(_("File error"));
1749
1750             wxMessageBox(_("Sorry, could not open this file."),
1751                          msgTitle,
1752                          wxOK | wxICON_EXCLAMATION | wxCENTRE);
1753
1754             path = wxEmptyString;
1755             return NULL;
1756         }
1757
1758         SetLastDirectory(wxPathOnly(pathTmp));
1759
1760         path = pathTmp;
1761
1762         // first choose the template using the extension, if this fails (i.e.
1763         // wxFileSelectorEx() didn't fill it), then use the path
1764         if ( FilterIndex != -1 )
1765             theTemplate = templates[FilterIndex];
1766         if ( !theTemplate )
1767             theTemplate = FindTemplateForPath(path);
1768         if ( !theTemplate )
1769         {
1770             // Since we do not add files with non-default extensions to the
1771             // file history this can only happen if the application changes the
1772             // allowed templates in runtime.
1773             wxMessageBox(_("Sorry, the format for this file is unknown."),
1774                          _("Open File"),
1775                          wxOK | wxICON_EXCLAMATION | wxCENTRE);
1776         }
1777     }
1778     else
1779     {
1780         path.clear();
1781     }
1782
1783     return theTemplate;
1784 }
1785
1786 wxDocTemplate *wxDocManager::SelectDocumentType(wxDocTemplate **templates,
1787                                                 int noTemplates, bool sort)
1788 {
1789     wxArrayString strings;
1790     wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1791     int i;
1792     int n = 0;
1793
1794     for (i = 0; i < noTemplates; i++)
1795     {
1796         if (templates[i]->IsVisible())
1797         {
1798             int j;
1799             bool want = true;
1800             for (j = 0; j < n; j++)
1801             {
1802                 //filter out NOT unique documents + view combinations
1803                 if ( templates[i]->m_docTypeName == data[j]->m_docTypeName &&
1804                      templates[i]->m_viewTypeName == data[j]->m_viewTypeName
1805                    )
1806                     want = false;
1807             }
1808
1809             if ( want )
1810             {
1811                 strings.Add(templates[i]->m_description);
1812
1813                 data[n] = templates[i];
1814                 n ++;
1815             }
1816         }
1817     }  // for
1818
1819     if (sort)
1820     {
1821         strings.Sort(); // ascending sort
1822         // Yes, this will be slow, but template lists
1823         // are typically short.
1824         int j;
1825         n = strings.Count();
1826         for (i = 0; i < n; i++)
1827         {
1828             for (j = 0; j < noTemplates; j++)
1829             {
1830                 if (strings[i] == templates[j]->m_description)
1831                     data[i] = templates[j];
1832             }
1833         }
1834     }
1835
1836     wxDocTemplate *theTemplate;
1837
1838     switch ( n )
1839     {
1840         case 0:
1841             // no visible templates, hence nothing to choose from
1842             theTemplate = NULL;
1843             break;
1844
1845         case 1:
1846             // don't propose the user to choose if he has no choice
1847             theTemplate = data[0];
1848             break;
1849
1850         default:
1851             // propose the user to choose one of several
1852             theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1853                           (
1854                             _("Select a document template"),
1855                             _("Templates"),
1856                             strings,
1857                             (void **)data.get()
1858                           );
1859     }
1860
1861     return theTemplate;
1862 }
1863
1864 wxDocTemplate *wxDocManager::SelectViewType(wxDocTemplate **templates,
1865                                             int noTemplates, bool sort)
1866 {
1867     wxArrayString strings;
1868     wxScopedArray<wxDocTemplate *> data(new wxDocTemplate *[noTemplates]);
1869     int i;
1870     int n = 0;
1871
1872     for (i = 0; i < noTemplates; i++)
1873     {
1874         wxDocTemplate *templ = templates[i];
1875         if ( templ->IsVisible() && !templ->GetViewName().empty() )
1876         {
1877             int j;
1878             bool want = true;
1879             for (j = 0; j < n; j++)
1880             {
1881                 //filter out NOT unique views
1882                 if ( templates[i]->m_viewTypeName == data[j]->m_viewTypeName )
1883                     want = false;
1884             }
1885
1886             if ( want )
1887             {
1888                 strings.Add(templ->m_viewTypeName);
1889                 data[n] = templ;
1890                 n ++;
1891             }
1892         }
1893     }
1894
1895     if (sort)
1896     {
1897         strings.Sort(); // ascending sort
1898         // Yes, this will be slow, but template lists
1899         // are typically short.
1900         int j;
1901         n = strings.Count();
1902         for (i = 0; i < n; i++)
1903         {
1904             for (j = 0; j < noTemplates; j++)
1905             {
1906                 if (strings[i] == templates[j]->m_viewTypeName)
1907                     data[i] = templates[j];
1908             }
1909         }
1910     }
1911
1912     wxDocTemplate *theTemplate;
1913
1914     // the same logic as above
1915     switch ( n )
1916     {
1917         case 0:
1918             theTemplate = NULL;
1919             break;
1920
1921         case 1:
1922             theTemplate = data[0];
1923             break;
1924
1925         default:
1926             theTemplate = (wxDocTemplate *)wxGetSingleChoiceData
1927                           (
1928                             _("Select a document view"),
1929                             _("Views"),
1930                             strings,
1931                             (void **)data.get()
1932                           );
1933
1934     }
1935
1936     return theTemplate;
1937 }
1938
1939 void wxDocManager::AssociateTemplate(wxDocTemplate *temp)
1940 {
1941     if (!m_templates.Member(temp))
1942         m_templates.Append(temp);
1943 }
1944
1945 void wxDocManager::DisassociateTemplate(wxDocTemplate *temp)
1946 {
1947     m_templates.DeleteObject(temp);
1948 }
1949
1950 wxDocTemplate* wxDocManager::FindTemplate(const wxClassInfo* classinfo)
1951 {
1952    for ( wxList::compatibility_iterator node = m_templates.GetFirst();
1953          node;
1954          node = node->GetNext() )
1955    {
1956       wxDocTemplate* t = wxStaticCast(node->GetData(), wxDocTemplate);
1957       if ( t->GetDocClassInfo() == classinfo )
1958          return t;
1959    }
1960
1961    return NULL;
1962 }
1963
1964 // Add and remove a document from the manager's list
1965 void wxDocManager::AddDocument(wxDocument *doc)
1966 {
1967     if (!m_docs.Member(doc))
1968         m_docs.Append(doc);
1969 }
1970
1971 void wxDocManager::RemoveDocument(wxDocument *doc)
1972 {
1973     m_docs.DeleteObject(doc);
1974 }
1975
1976 // Views or windows should inform the document manager
1977 // when a view is going in or out of focus
1978 void wxDocManager::ActivateView(wxView *view, bool activate)
1979 {
1980     if ( activate )
1981     {
1982         m_currentView = view;
1983     }
1984     else // deactivate
1985     {
1986         if ( m_currentView == view )
1987         {
1988             // don't keep stale pointer
1989             m_currentView = NULL;
1990         }
1991     }
1992 }
1993
1994 // ----------------------------------------------------------------------------
1995 // wxDocChildFrameAnyBase
1996 // ----------------------------------------------------------------------------
1997
1998 bool wxDocChildFrameAnyBase::CloseView(wxCloseEvent& event)
1999 {
2000     if ( m_childView )
2001     {
2002         // notice that we must call wxView::Close() and OnClose() called from
2003         // it in any case, even if we know that we are going to close anyhow
2004         if ( !m_childView->Close(false) && event.CanVeto() )
2005         {
2006             event.Veto();
2007             return false;
2008         }
2009
2010         m_childView->Activate(false);
2011
2012         // it is important to reset m_childView frame pointer to NULL before
2013         // deleting it because while normally it is the frame which deletes the
2014         // view when it's closed, the view also closes the frame if it is
2015         // deleted directly not by us as indicated by its doc child frame
2016         // pointer still being set
2017         m_childView->SetDocChildFrame(NULL);
2018         wxDELETE(m_childView);
2019     }
2020
2021     m_childDocument = NULL;
2022
2023     return true;
2024 }
2025
2026 // ----------------------------------------------------------------------------
2027 // wxDocParentFrameAnyBase
2028 // ----------------------------------------------------------------------------
2029
2030 #if wxUSE_PRINTING_ARCHITECTURE
2031
2032 namespace
2033 {
2034
2035 wxString GetAppropriateTitle(const wxView *view, const wxString& titleGiven)
2036 {
2037     wxString title(titleGiven);
2038     if ( title.empty() )
2039     {
2040         if ( view && view->GetDocument() )
2041             title = view->GetDocument()->GetUserReadableName();
2042         else
2043             title = _("Printout");
2044     }
2045
2046     return title;
2047 }
2048
2049 } // anonymous namespace
2050
2051 wxDocPrintout::wxDocPrintout(wxView *view, const wxString& title)
2052              : wxPrintout(GetAppropriateTitle(view, title))
2053 {
2054     m_printoutView = view;
2055 }
2056
2057 bool wxDocPrintout::OnPrintPage(int WXUNUSED(page))
2058 {
2059     wxDC *dc = GetDC();
2060
2061     // Get the logical pixels per inch of screen and printer
2062     int ppiScreenX, ppiScreenY;
2063     GetPPIScreen(&ppiScreenX, &ppiScreenY);
2064     wxUnusedVar(ppiScreenY);
2065     int ppiPrinterX, ppiPrinterY;
2066     GetPPIPrinter(&ppiPrinterX, &ppiPrinterY);
2067     wxUnusedVar(ppiPrinterY);
2068
2069     // This scales the DC so that the printout roughly represents the
2070     // the screen scaling. The text point size _should_ be the right size
2071     // but in fact is too small for some reason. This is a detail that will
2072     // need to be addressed at some point but can be fudged for the
2073     // moment.
2074     float scale = (float)((float)ppiPrinterX/(float)ppiScreenX);
2075
2076     // Now we have to check in case our real page size is reduced
2077     // (e.g. because we're drawing to a print preview memory DC)
2078     int pageWidth, pageHeight;
2079     int w, h;
2080     dc->GetSize(&w, &h);
2081     GetPageSizePixels(&pageWidth, &pageHeight);
2082     wxUnusedVar(pageHeight);
2083
2084     // If printer pageWidth == current DC width, then this doesn't
2085     // change. But w might be the preview bitmap width, so scale down.
2086     float overallScale = scale * (float)(w/(float)pageWidth);
2087     dc->SetUserScale(overallScale, overallScale);
2088
2089     if (m_printoutView)
2090     {
2091         m_printoutView->OnDraw(dc);
2092     }
2093     return true;
2094 }
2095
2096 bool wxDocPrintout::HasPage(int pageNum)
2097 {
2098     return (pageNum == 1);
2099 }
2100
2101 bool wxDocPrintout::OnBeginDocument(int startPage, int endPage)
2102 {
2103     if (!wxPrintout::OnBeginDocument(startPage, endPage))
2104         return false;
2105
2106     return true;
2107 }
2108
2109 void wxDocPrintout::GetPageInfo(int *minPage, int *maxPage,
2110                                 int *selPageFrom, int *selPageTo)
2111 {
2112     *minPage = 1;
2113     *maxPage = 1;
2114     *selPageFrom = 1;
2115     *selPageTo = 1;
2116 }
2117
2118 #endif // wxUSE_PRINTING_ARCHITECTURE
2119
2120 // ----------------------------------------------------------------------------
2121 // Permits compatibility with existing file formats and functions that
2122 // manipulate files directly
2123 // ----------------------------------------------------------------------------
2124
2125 #if wxUSE_STD_IOSTREAM
2126
2127 bool wxTransferFileToStream(const wxString& filename, wxSTD ostream& stream)
2128 {
2129 #if wxUSE_FFILE
2130     wxFFile file(filename, wxT("rb"));
2131 #elif wxUSE_FILE
2132     wxFile file(filename, wxFile::read);
2133 #endif
2134     if ( !file.IsOpened() )
2135         return false;
2136
2137     char buf[4096];
2138
2139     size_t nRead;
2140     do
2141     {
2142         nRead = file.Read(buf, WXSIZEOF(buf));
2143         if ( file.Error() )
2144             return false;
2145
2146         stream.write(buf, nRead);
2147         if ( !stream )
2148             return false;
2149     }
2150     while ( !file.Eof() );
2151
2152     return true;
2153 }
2154
2155 bool wxTransferStreamToFile(wxSTD istream& stream, const wxString& filename)
2156 {
2157 #if wxUSE_FFILE
2158     wxFFile file(filename, wxT("wb"));
2159 #elif wxUSE_FILE
2160     wxFile file(filename, wxFile::write);
2161 #endif
2162     if ( !file.IsOpened() )
2163         return false;
2164
2165     char buf[4096];
2166     do
2167     {
2168         stream.read(buf, WXSIZEOF(buf));
2169         if ( !stream.bad() ) // fail may be set on EOF, don't use operator!()
2170         {
2171             if ( !file.Write(buf, stream.gcount()) )
2172                 return false;
2173         }
2174     }
2175     while ( !stream.eof() );
2176
2177     return true;
2178 }
2179
2180 #else // !wxUSE_STD_IOSTREAM
2181
2182 bool wxTransferFileToStream(const wxString& filename, wxOutputStream& stream)
2183 {
2184 #if wxUSE_FFILE
2185     wxFFile file(filename, wxT("rb"));
2186 #elif wxUSE_FILE
2187     wxFile file(filename, wxFile::read);
2188 #endif
2189     if ( !file.IsOpened() )
2190         return false;
2191
2192     char buf[4096];
2193
2194     size_t nRead;
2195     do
2196     {
2197         nRead = file.Read(buf, WXSIZEOF(buf));
2198         if ( file.Error() )
2199             return false;
2200
2201         stream.Write(buf, nRead);
2202         if ( !stream )
2203             return false;
2204     }
2205     while ( !file.Eof() );
2206
2207     return true;
2208 }
2209
2210 bool wxTransferStreamToFile(wxInputStream& stream, const wxString& filename)
2211 {
2212 #if wxUSE_FFILE
2213     wxFFile file(filename, wxT("wb"));
2214 #elif wxUSE_FILE
2215     wxFile file(filename, wxFile::write);
2216 #endif
2217     if ( !file.IsOpened() )
2218         return false;
2219
2220     char buf[4096];
2221     for ( ;; )
2222     {
2223         stream.Read(buf, WXSIZEOF(buf));
2224
2225         const size_t nRead = stream.LastRead();
2226         if ( !nRead )
2227         {
2228             if ( stream.Eof() )
2229                 break;
2230
2231             return false;
2232         }
2233
2234         if ( !file.Write(buf, nRead) )
2235             return false;
2236     }
2237
2238     return true;
2239 }
2240
2241 #endif // wxUSE_STD_IOSTREAM/!wxUSE_STD_IOSTREAM
2242
2243 #endif // wxUSE_DOC_VIEW_ARCHITECTURE