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