wxWidgets源碼分析(8) - MVC架構
目錄
- MVC架構
- wxDocManager文檔管理器
- 框架菜單命令的執行過程
- SDI消息傳遞總結
- 更新視圖
MVC架構
wxDocManager文檔管理器
wxWidgets使用wxDocManager
類來管理MVC中的文檔和視圖的對應關系,使用方法:
- 創建一個
wxDocManager
對象,然後向此對象中增加文檔模板wxDocTemplate
對象,文檔模板對象中說明了文檔類型和該文檔對應的文檔類、視圖類; - 將此
wxDocManager
對象傳遞給wxDocParentFrame
類(SDI),這樣框架類就和文檔類關聯起來了。
//// SDI wxDocManager *docManager = new wxDocManager; //// Create a template relating drawing documents to their views new wxDocTemplate(docManager, "#docDescription", "*.#docExtention", "", "#docExtention", "Doc", "View", CLASSINFO(CClassPrefixDoc), CLASSINFO(CClassPrefixView)); wxFrame *frame = new wxDocParentFrame(docManager, ...);
看下wxDocTemplate
構造函數,這裏實現了Manager和模板的關聯:
- 調用
wxDocManager
的AssociateTemplate
將自己和manager關聯起來,在wxDocManager
中,它將所有的文檔模板保存到m_templates
容器中; - 保存doc和view的ClassInfo。
wxDocTemplate::wxDocTemplate(wxDocManager *manager, ...) { m_documentManager = manager; m_documentManager->AssociateTemplate(this); m_docClassInfo = docClassInfo; m_viewClassInfo = viewClassInfo; } void wxDocManager::AssociateTemplate(wxDocTemplate *temp) { if (!m_templates.Member(temp)) m_templates.Append(temp); }
後續的所有文檔操作都是通過wxDocManager
進行的,我們接下來跟蹤一下創建新文檔的流程,用戶代碼如下:
docManager->CreateNewDocument();
跟蹤到wxDocManager::CreateNewDocument
,它復用CreateDocument
的實現,CreateDocument
使用flags參數,有如下數據:
- 獲取用戶註冊的文檔模板,如果沒有則不需要處理了;
- 選擇一個文檔模板,這個是必須的,因為所有的重要操作都是在文檔模板中完成的;
- 接著進行其他的有效性驗證等。
- 最後調用用戶註冊的模板類來創建文檔
wxDocument *CreateNewDocument() { return CreateDocument(wxString(), wxDOC_NEW); } wxDocument *wxDocManager::CreateDocument(const wxString& pathOrig, long flags) { wxDocTemplateVector templates(GetVisibleTemplates(m_templates)); const size_t numTemplates = templates.size(); if ( !numTemplates ) return NULL; // 選擇文檔模板,如果用戶傳遞進來的pathOrig有效,則根據這個pahOrig指定的 // 擴展名進行選擇 // wxDOC_SILENT: 如果無此標記,則當用戶要創建新文檔,並且又有多種文檔類型時, // 會彈出對話框讓用戶選擇要創建的文檔類型。 wxString path = pathOrig; // may be modified below wxDocTemplate *temp; if ( flags & wxDOC_SILENT ) { temp = FindTemplateForPath(path); } else // not silent, ask the user { if ( (flags & wxDOC_NEW) || !path.empty() ) temp = SelectDocumentType(&templates[0], numTemplates); else temp = SelectDocumentPath(&templates[0], numTemplates, path, flags); } if ( !temp ) return NULL; // 檢查文檔數量是不是已經超出範圍 if ( (int)GetDocuments().GetCount() >= m_maxDocsOpen ) { if ( !CloseDocument((wxDocument *)GetDocuments().GetFirst()->GetData()) ) { // can‘t open the new document if closing the old one failed return NULL; } } // 調用文檔模板類來生成文檔對象 wxDocument * const docNew = temp->CreateDocument(path, flags); if ( !docNew ) return NULL; docNew->SetDocumentName(temp->GetDocumentName()); // 如果是新創建文檔則要調用doc的`OnNewDocument`和`OnOpenDocument`方法; if ( !(flags & wxDOC_NEW ? docNew->OnNewDocument() : docNew->OnOpenDocument(path)) ) { docNew->DeleteAllViews(); return NULL; } // 歷史文件。。。 if ( !(flags & wxDOC_NEW) && temp->FileMatchesTemplate(path) ) AddFileToHistory(path); docNew->Activate(); return docNew; }
模板類創建文檔對象
文檔模板類wxDocTemplate
創建文檔的過程比較簡單,通過用戶註冊的docClassInfo來創建一個文檔對象,創建完成後再調用InitDocument
執行初始化:
wxDocument *wxDocTemplate::CreateDocument(const wxString& path, long flags)
{
wxDocument * const doc = DoCreateDocument();
return doc && InitDocument(doc, path, flags) ? doc : NULL;
}
wxDocument *wxDocTemplate::DoCreateDocument()
{
if (!m_docClassInfo)
return NULL;
return static_cast<wxDocument *>(m_docClassInfo->CreateObject());
}
文檔初始化過程,將文檔對象和文檔模板、文檔管理器都關聯起來,然後調用doc->OnCreate
運行用戶的代碼,這個是在創建過程中的唯一機會。
bool
wxDocTemplate::InitDocument(wxDocument* doc, const wxString& path, long flags)
{
doc->SetFilename(path);
doc->SetDocumentTemplate(this);
GetDocumentManager()->AddDocument(doc);
doc->SetCommandProcessor(doc->OnCreateCommandProcessor());
if ( doc->OnCreate(path, flags) )
return true;
if ( GetDocumentManager()->GetDocuments().Member(doc) )
doc->DeleteAllViews();
return false;
}
文檔創建過程中方法的調用順序:
1. Constructor()
2. OnCreate()
3. OnNewDocument() or OnOpenDocument()
可以看到,上面的流程,創建文檔完成後就沒事了,返回成功,那視圖是在哪創建的呢?
視圖對象的創建
在定義文檔類時,可能會實現OnCreate
方法,如果用戶想讓doc類直接創建關聯的視圖,那麽此時就必須調用父類的wxDocument::OnCreate
方法。
bool CClassPrefixDoc::OnCreate(const wxString& path, long flags)
{
if (!wxDocument::OnCreate(path, flags))
return false;
return true;
}
我們看下wxDocument::OnCreate
方法的實現,wxDocTemplate
在初始化doc對象的時候,已經將自己傳遞進去了,那麽此時doc就可以再通過模板對象來創建View類,因為View的類型是在模板對象中指定的,自然它知道怎麽創建。
- 調用
wxDocTemplate::DoCreateView
來實例化一個view對象; - 調用view的
OnCreate
方法,這個方法也是給用戶使用的。
bool wxDocument::OnCreate(const wxString& WXUNUSED(path), long flags)
{
return GetDocumentTemplate()->CreateView(this, flags) != NULL;
}
wxView *wxDocTemplate::CreateView(wxDocument *doc, long flags)
{
wxScopedPtr<wxView> view(DoCreateView());
if ( !view )
return NULL;
view->SetDocument(doc);
if ( !view->OnCreate(doc, flags) )
return NULL;
return view.release();
}
wxView *wxDocTemplate::DoCreateView()
{
if (!m_viewClassInfo)
return NULL;
return static_cast<wxView *>(m_viewClassInfo->CreateObject());
}
創建順序
從上面可以知道,創建順序如下:
wxDocTemplate -> Document -> View
框架菜單命令的執行過程
wxDocParentFrame
菜單入口
當用戶調用菜單保存文檔時,會產生菜單消息命令,由於菜單屬於Frame的子項,所以此時會調用Frame的消息處理入口,調用流程如下:
// wxDocParentFrame
wxFrame::HandleCommand()
-> wxFrame::HandleCommand()
-> wxFrameBase::ProcessCommand()
// 參考前文分析,接著會調用 menu 和 menuBar 的處理函數,隨後主動權
// 再次回到 wxDocParentFrame 中,此時的處理函數位於 wxEvtHandler 中。
wxEvtHandler::ProcessEventLocally
-> ... -> wxDocParentFrame::TryBefore
由於TryBefore
是虛方法,此時我們要看下 wxDocParentFrame
的繼承關系才能搞清楚到底調用哪個函數:
wxDocParentFrame -> wxDocParentFrameBase (wxDocParentFrameAny<wxFrame>) ->
wxFrame & wxDocParentFrameAnyBase
wxDocParentFrame
繼承關系中的wxDocParentFrameAny
模板類實現了TryBefore
方法,所以就是這個了,函數中調用了兩個函數:
- BaseFrame::TryBefore(event)這個必然是
wxFrame::TryBefore
,可忽略 - 第二個
TryProcessEvent
方法,則是繼承自wxDocParentFrameAnyBase
,所以調用的是wxDocChildFrameAnyBase::TryProcessEvent
。
template <class BaseFrame>
class WXDLLIMPEXP_CORE wxDocParentFrameAny : public BaseFrame,
public wxDocParentFrameAnyBase {
virtual bool TryBefore(wxEvent& event)
{
return BaseFrame::TryBefore(event) || TryProcessEvent(event);
}
我們繼續看wxDocChildFrameAnyBase::TryProcessEvent
,這個函數改寫了原有frame類的處理過程,它查找當前Frame關聯的wxDocManager
,然後把消息傳遞給這個對象去處理。在給wxDocManager
處理之前,我們可以看到它實際上是先調用childFrame->HasAlreadyProcessed
函數處理的,如果這個函數沒有處理則交給wxDocManager
。
由於我們這次使用的是預定義的,並且我們自身沒有實現任何消息映射,所以此時一定會走到m_docManager->ProcessEventLocally
中。
bool wxDocParentFrameAnyBase::TryProcessEvent(wxEvent& event)
{
if ( !m_docManager )
return false;
if ( wxView* const view = m_docManager->GetAnyUsableView() )
{
wxDocChildFrameAnyBase* const childFrame = view->GetDocChildFrame();
if ( childFrame && childFrame->HasAlreadyProcessed(event) )
return false;
}
return m_docManager->ProcessEventLocally(event);
}
wxDocManager
類的處理
此時我們可以先看下wxDocManager
的消息映射表,如果已經有註冊,那麽此時就會走到
wxDocManager
的消息註冊表中。
參考源碼可以看到wxDocManager
已經實現了很多個消息的預處理,對於Save來說已經有了wxDocManager::OnFileSave
:
BEGIN_EVENT_TABLE(wxDocManager, wxEvtHandler)
EVT_MENU(wxID_OPEN, wxDocManager::OnFileOpen)
EVT_MENU(wxID_CLOSE, wxDocManager::OnFileClose)
EVT_MENU(wxID_CLOSE_ALL, wxDocManager::OnFileCloseAll)
EVT_MENU(wxID_REVERT, wxDocManager::OnFileRevert)
EVT_MENU(wxID_NEW, wxDocManager::OnFileNew)
EVT_MENU(wxID_SAVE, wxDocManager::OnFileSave)
繼續跟蹤wxDocManager::OnFileSave
,發現轉向到了doc的save函數,doc中處理save時首先檢查是否是新建的文件並且有改變,如果是新建的則走SaveAs流程,否則繼續處理保存。
void wxDocManager::OnFileSave(wxCommandEvent& WXUNUSED(event))
{
wxDocument *doc = GetCurrentDocument();
if (!doc)
return;
doc->Save();
}
bool wxDocument::Save()
{
if ( AlreadySaved() )
return true;
if ( m_documentFile.empty() || !m_savedYet )
return SaveAs();
return OnSaveDocument(m_documentFile);
}
走Save
也好,走SaveAs
也好,最終都會調用wxDocument::OnSaveDocument
來實現文檔的保存,這裏最後調用的DoSaveDocument
方法來實現保存,這個是虛方法,需要用戶來實現。
bool wxDocument::OnSaveDocument(const wxString& file)
{
if ( !file )
return false;
if ( !DoSaveDocument(file) )
return false;
if ( m_commandProcessor )
m_commandProcessor->MarkAsSaved();
Modify(false);
SetFilename(file);
SetDocumentSaved(true);
#if defined( __WXOSX_MAC__ ) && wxOSX_USE_CARBON
wxFileName fn(file) ;
fn.MacSetDefaultTypeAndCreator() ;
#endif
return true;
}
對於文檔的另存、打開等也有同樣的處理。wxWidgets的文檔視圖框架已經提供了比較好的支持,我們可以省掉很多重復代碼了。
當然我們也可以通過重載OnSaveDocument (const wxString &filename)
來實現文檔的保存,這樣的話,用戶需要自己去保存文檔的狀態等等,實在是沒有必要。
wxView
類的處理
前文有描述,當收到命令菜單時,最終會調用到m_docManager->ProcessEventLocally(event)
,我們再回過頭看下ProcessEventLocally
的調用關系,先調用TryBefore
然後再調用TryHereOnly
:
bool wxEvtHandler::ProcessEventLocally(wxEvent& event)
{
return TryBeforeAndHere(event) || DoTryChain(event);
}
bool wxEvtHandler::TryBeforeAndHere(wxEvent& event)
{
return TryBefore(event) || TryHereOnly(event);
}
TryBefore
是虛方法,我們看下wxDocManager
的實現,查找當前的一個view,然後再調用view->ProcessEventLocally
,這裏需要關註GetAnyUsableView
,具體的實現就是獲取到當前最新的View,如果獲取不到在獲取到當前最近使用的doc,並獲取到這個doc中的第一個view:
bool wxDocManager::TryBefore(wxEvent& event)
{
wxView * const view = GetAnyUsableView();
return view && view->ProcessEventLocally(event);
}
wxView *wxDocManager::GetAnyUsableView() const
{
wxView *view = GetCurrentView();
if ( !view && !m_docs.empty() )
{
wxList::compatibility_iterator node = m_docs.GetFirst();
if ( !node->GetNext() )
{
wxDocument *doc = static_cast<wxDocument *>(node->GetData());
view = doc->GetFirstView();
}
}
return view;
}
接著繼續看wxView的wxView::TryBefore
方法,view中會先找Doc類來處理這個命令,如果doc不處理那麽View才會處理。
bool wxView::TryBefore(wxEvent& event)
{
wxDocument * const doc = GetDocument();
return doc && doc->ProcessEventLocally(event);
}
右鍵菜單命令的執行過程
對於MVC程序來說,View類並沒有真實的窗口,在創建wxView
對象的時候,由view創建一個新的wxWindow
窗口,此窗口繼承自Frame,然後將此窗口綁定到wxFrame
對象上。
而右鍵菜單則應用在wxWindow
窗口上,彈出菜單代碼為:
void XXXWindow::OnMouseEvent(wxMouseEvent& event)
{
if (event.RightDown()) {
wxMenu *popMenu = new wxMenu;
popMenu->Append(ID_MenuTest, "Canvas Test Menu");
PopupMenu(popMenu);
}
}
此時消息處理流程略有變更,由於菜單綁定在當前窗口上,所以最先處理此消息的是當前的wxWindow
對象,如果此對象不進行處理,則交給父類wxFrame
處理,父類則會安裝MVC的標準流程處理。
SDI消息傳遞總結
處理原則:
wxDocParentFrame
收到消息後處理:優先傳遞給wxDocManager
處理,然後自己處理;wxDocManager
收到消息後,優先傳遞給wxView
處理,然後自己處理;wxView
優先將消息傳遞給wxDocument
處理,然後自己處理;
這樣最後將導致處理優順序為:
wxDocument > wxView > wxDocParentFrame
如果是右鍵菜單命令,則優先觸發此菜單的對象處理,剩下的流程同上。
更新視圖
wxDocument提供了UpdateAllViews方法,可以在doc發生變更時,通知所有的view更新視圖,實際上是調用view的OnUpdate
方法實現更新:
void wxDocument::UpdateAllViews(wxView *sender, wxObject *hint)
{
wxList::compatibility_iterator node = m_documentViews.GetFirst();
while (node)
{
wxView *view = (wxView *)node->GetData();
if (view != sender)
view->OnUpdate(sender, hint);
node = node->GetNext();
}
}
wxView並沒有實現OnUpdate
方法,這個需要用戶自行實現,對於繪圖類的,最簡單的辦法就是直接調用更新圖板:
void CProjectView::OnUpdate(wxView *sender, wxObject *hint)
{
if (canvas)
canvas->Refresh();
}
wxWidgets源碼分析(8) - MVC架構