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