wxWidgets源码分析-事件机制（上）

发布者： Tank

写在前面

wxWidgets是一款开源的跨平台图形程序开发库，其中事件机制是GUI程序开发的一个重中之重，通过阅读源代码分析wx中事件机制的实现。 具体包括到事件的定义、分发、处理以及跨平台环境中的实现。

项目中wxWidgets用的比较多，带着对wxevent如下疑问， 分析下源代码吧

• Q1：为什么wx中有的事件能像上传递有的则不能,为啥呢？
• Q2：怎么使用事件处理机制，如果一个窗口类要处理事件应该做些什么？
• Q3：wx中事件机制怎么实现，wx是怎样处理事件，怎么使用事件表？
• Q4: wx程序中消息是怎么分发的？
• Q5: MS Windows中消息是怎么样转换成wxevent？
• Q6: 各种的wxEvent从何而来， 是哪路神仙发送的呢？

1、wx中的事件类

wxEvent是wx所有事件类的基类，wx中所有的事件都直接或间接继续于它。它的构造函数如下

wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL )

它是一个抽象类， 有一个纯虚函数（虚clone函数，相当于工厂方法，有子类分别生成相应的对象） 所有的可用事件类（包括自定义事件）必须手动实现这个函数，否这wxEvent子类对象没法复制一份 传递给wxPostEvent

// this function is used to create a copy of the event polymorphically and
// all derived classes must implement it because otherwise wxPostEvent()
// for them wouldn't work (it needs to do a copy of the event)
virtual wxEvent *Clone() const = 0;

wxEvent有个保护成员

protected:
    // the propagation level: while it is positive, we propagate the event to
    // the parent window (if any)
    //
    // this one doesn't have to be public, we don't have to worry about
    // backwards compatibility as it is new
    int               m_propagationLevel;

m_propagationLevel实际上是个整形，其取值系统定义两个常量

// the predefined constants for the number of times we propagate event
// upwards window child-parent chain
enum Propagation_state
{
    // don't propagate it at all
    wxEVENT_PROPAGATE_NONE = 0,

    // propagate it until it is processed
    wxEVENT_PROPAGATE_MAX = INT_MAX
};

根据这个值，wx系统中所有事件可以分为两类：可传递的，和不可传递的。可传递的事件继承于wxCommandEvent，不可传递的事件直接继承于wxEvent，不可传递事件不会传给事件源窗口的父窗口，即只对当前窗口有效。如： wxActivate, wxCloseEvent, wxEraseEvent, wxFocusEvent, wxKeyEvent, wxIdleEvent, wxInitDialogEvent, wxJoystickEvent, wxMenuEvent, wxMouseEvent, wxMoveEvent, wxPaintEvent, wxQueryLayoutInfoEvent, wxSizeEvent, wxScrollWinEvent, wxSysColourChangedEvent 。 那wxCommandEvent到底有啥不同呢，接着看

wxEvent::wxEvent(int theId, wxEventType commandType )
{
    // ......
    m_propagationLevel = wxEVENT_PROPAGATE_NONE;
}

wxCommandEvent::wxCommandEvent(wxEventType commandType, int theId)
              : wxEvent(theId, commandType)
{
     // ......
    // the command events are propagated upwards by default
    m_propagationLevel = wxEVENT_PROPAGATE_MAX;
}

2、事件处理流程

wx事件机制采用事件表机制实现，事件表的实现稍后再分析。这里只要把事件表理解为事件到事件处理函数的的映射关系即可。事件发生时，会在事件表里查找事件处理函数， 事件表查找一般流程是：
** 当前窗口事件表—>父类事件表–>父类的父类事件表–> ，，，，–>父窗口事件表**
一旦查找成功，匹配结束，调用事件处理函数,返回一个true，不再继续向上查找事件

//common/event.cpp
bool wxEvtHandler::ProcessEvent(wxEvent& event)
{
     // ....
        // 事件哈希表查找处理（这里会搜索父类）
        if ( GetEventHashTable().HandleEvent(event, this) )
            return true;


     // ....
    // EvtHandler类组成一个栈，搜索下一个
    if ( GetNextHandler() )
    {
        if ( GetNextHandler()->ProcessEvent(event) )
            return true;
    }

    // .....
    // 继续上传递，这是个虚函数，对于wxWindow向父窗口传递 
    return TryParent(event);
}

3、程序中使用事件处理机制

对于用wx编程，要使一个类具备事件处理能力，需要
1. 定义一个类直接或间接继承wxEvtHandle（一般wxWindow的窗口或控件子类、wxApp都继承了wxEvtHandler） 2. 在类的声明中，前加入事件表声明宏 DECLARE_EVENT_TABLE() 3. 类的实现中，加入事件表实现，以BEGIN_EVENT_TABLE(MyWin, BaseWin)开始 ，以END_EVENT_TABLE()结束，中间填入要处理的事件映射宏

    BEGIN_EVENT_TABLE(MyFrame, wxFrame)
        EVT_MENU(Minimal_Quit,  MyFrame::OnQuit)
        EVT_MENU(Minimal_About, MyFrame::OnAbout)
    END_EVENT_TABLE()

一堆像模像样的宏，那么这背后wx到底做了什么呢 ？接着分析事件表的具体实现

4、事件表的实现

先说说事件表机制的相关的数据结构

事件类型(wxEventType)
wx中事件类型（wxEventType）和事件类(wxEvent）是两个不同概念,上面分析事件类是一序列继承于wxEvent的类,wxCommandEvent事件类可传递，其他不可传递。一个事件类有多个事件类型，比如同是wxCommandEvent事件，有下列事件类型 * wxEVT_COMMAND_BUTTON_CLICKED * wxEVT_COMMAND_CHECKBOX_CLICKED * wxEVT_COMMAND_CHOICE_SELECTED * wxEVT_COMMAND_LISTBOX_SELECTED * wxEVT_COMMAND_LISTBOX_DOUBLECLICKED * wxEVT_COMMAND_TEXT_UPDATED * wxEVT_COMMAND_TEXT_ENTER * wxEVT_COMMAND_MENU_SELECTED
这些实际是一些枚举常量，说白了都是一些代表事件类型整形值。 wx中事件类型就是一系列的整型值，这些值在事件系统中唯一的用于标识事件

    //event.h
    typedef int wxEventType;
    //wxEvent构造函数参数有两个成员winid(用于标识事件所关联的窗口) commmandType
    wxEvent(int winid = 0, wxEventType commandType = wxEVT_NULL )

事件表项（wxEventTableEntry）
程序要处理事件时，在类实现文件中BEGIN_EVENT_TABLE END_EVENT_TABLE宏之间添加一条一条事件映射宏。 可以际上是往事件表里一条一条添加事件表项，一个事件表有一系列事件表项组成，事件表项记录了事件到 事件处理函数的对应关系。下面是事件表项的实现

struct WXDLLIMPEXP_BASE wxEventTableEntry
{
    // For some reason, this can't be wxEventType, or VC++ complains.
    int m_eventType;            // main event type
    int m_id;                   // control/menu/toolbar id
    int m_lastId;               // used for ranges of ids
    wxObjectEventFunction m_fn; // function to call: not wxEventFunction,
                                // because of dependency problems

    wxObject* m_callbackUserData;
};

可以看出，事件表就是个一个结构体，是一个5元祖（事件类型、id, lastid,事件处理函数,用户数据指针)， 一个类要处理多少事件，就要往事件表里记录多少个事件表项，当事件发生时，查找事件表中的时间表项， 根据事件类型以及控件id匹配一条事件表项，然后调用事件处理函数，完成事件处理。

事件表(wxEventTable)
事件表，是由事件表项组成的数组。实现为一个结构体，记录了事件表条目数组的首地址， 不记录长度，事件表条目数组以一个{0, 0, 0, 0, 0}五元组结束， 此外还记录了一个指 向自身类型的指针，用于保存父窗口的事件表地址

struct WXDLLIMPEXP_BASE wxEventTable
{
    const wxEventTable *baseTable;    // base event table (next in chain)
    const wxEventTableEntry *entries; // bottom of entry array
};

看下图吧，更直观点。

事件哈希表(wxEventHashTable)
事件哈希表主要用于加速事件表的查找，那么由事件表怎么来构造事件哈希表呢？ 事件哈希表，会对事件表中的条目进行分类，同种事件类型的事件表归为一类.因 此事件哈希表实现时，在内部定义了一个事件类型表

class WXDLLIMPEXP_BASE wxEventHashTable
{
//...
struct EventTypeTable
{
        wxEventType                   eventType; //事件类型
        wxEventTableEntryPointerArray eventEntryTable;  //事件条目指针数组
};

//...
protected:
    const wxEventTable    &m_table;   //事件表的引用，这里没有必要重建一份
    bool                   m_rebuildHash;  //开始时候哈希表并不建立，建立的时机发生了第一向上搜素时间表
    size_t                 m_size;//哈希表长度
    EventTypeTablePointer *m_eventTypeTable;//事件类型表指针数组

}

看的累，上个图吧

构造函数中预先分配大小为31的指针数组m_eventTypeTable，用于保存事件类型表的地址， 事件类型表的地址根据事件类型的值哈希存到m_eventTypeTable,哈希函数

static const int EVENT_TYPE_TABLE_INIT_SIZE = 31; // Not too big not too small.

wxEventHashTable::wxEventHashTable(const wxEventTable &table)
                : m_table(table),
                  m_rebuildHash(true)
{
    AllocEventTypeTable(EVENT_TYPE_TABLE_INIT_SIZE);

    m_next = sm_first;
    if (m_next)
        m_next->m_previous = this;
    sm_first = this;
}

void wxEventHashTable::AllocEventTypeTable(size_t size)
{
    m_eventTypeTable = new EventTypeTablePointer[size];
    memset((void *)m_eventTypeTable, 0, sizeof(EventTypeTablePointer)*size);
    m_size = size;
}

画下wx事件数据结构整体的图，对事件组织的认识更清晰了

通过这些应该对wx中事件机制所涉及的数据结构有个清晰的认识了。有了这个基础可以接着分析事件机制的实现了。