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