UTMenu.h

Go to the documentation of this file.

//==================================================================================================
// Copyright (C) 2010  Brian Tietz    sdbtietz at yahoo dot com
//
// This program is free software; you can redistribute it and/or modify it under the terms of the
// GNU General Public License as published by the Free Software Foundation, version 2.0 of the
// License.
//
// This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along with this program; if
// not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// 02110-1301, USA.
//
// For commercial software, the copyright holder (Brian Tietz, email sdbtietz at yahoo dot com)
// reserves the right and is willing to waive the proprietary source code disclosure aspects of that
// license as applied to the UT library in exchange for either substantial contributions to the
// development of the UT library or other forms of compensation.  Any such waiver must be
// established in writing between the copyright holder and the commercial entity obtaining such a
// waiver.
//==================================================================================================


#ifndef _UT_MENU_H_
#define _UT_MENU_H_



//==================================================================================================
//=== Project headers
//==================================================================================================
#include "UTgui.h"
#include "UTLists.h"
#include "UTMessageDestination.h"
#include "UTGUIPoolAllocator.h"


//==================================================================================================
//=== Forward name declarations
//==================================================================================================
class Resource_t;
class IOStream_t;
class Menu_t;
class MenuItem_t;
class MenuBreak_t;
class MenuMerge_t;


//==================================================================================================
//=== Predefined menu IDs
//==================================================================================================

const int eRCMENU_exit                  = 1;

const int eRCMENU_prefs                 = 2;

const int eRCMENU_file                  = 3;

const int eRCMENU_edit                  = 4;

const int eRCMENU_view                  = 5;

const int eRCMENU_project               = 6;

const int eRCMENU_tools                 = 7;

const int eRCMENU_windows               = 8;

const int eRCMENU_help                  = 9;

const int eRCMENU_about                 = 10;

const int eRCMENU_cascade               = 12;

const int eRCMENU_tile_horizontal       = 13;

const int eRCMENU_tile_vertical         = 14;

const int eRCMENU_close_all             = 15;

const int eRCMENU_window_list_break     = 16;

const int eRCMENU_window_list_break_end = 17;

const int eRCMENU_more_windows          = 18;

const int eRCMENU_min_reserved          = 19;

const int eRCMENU_max_reserved          = 99;


//==================================================================================================
class UTGUI_EXPORT MenuNode_t
//==================================================================================================
: public BTreeNode_t< MenuNode_t, uint >    // By token
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
    inline void*                        operator new(size_t size);

    inline void                         operator delete(void* block);

    inline int                          MenuID() const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
                                        MenuNode_t(int menu_id);
    virtual                             ~MenuNode_t();

    inline                              operator int() const;
    inline int                          Compare(int other_menu_id) const;

    inline                              operator uint() const;
    inline int                          Compare(uint other_token) const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    int                                 m_menu_id;
    uint                                m_token;    // Cannot be in reserved range
    #if WINDOWS
                                            #define c_reserved_menu_token_min 0xf000
                                            #define c_reserved_menu_token_max 0xf120
    #endif
    Menu_t*                             m_parent_menu;

    static BTree_t< MenuNode_t, uint >  ms_valid_menu_nodes;
    static uint                         ms_next_token;

    friend class Menu_t;
    friend class MenuItem_t;
    friend class MenuBreak_t;
    friend class MenuMerge_t;
    friend class MenuBar_t;
    friend class MergedMenuNode_t;
    friend class OwnedList_t<MenuNode_t>;
    friend class SortedList_t< MenuNode_t, int >;
    friend class BTree_t< MenuNode_t, uint >;
    friend class BTreeNode_t< MenuNode_t, uint >;
    friend class AppPlatformInfo_t;
};


//==================================================================================================
class UTGUI_EXPORT Menu_t
//==================================================================================================
: public MenuNode_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                        Menu_t();

                        Menu_t( int resource_id, Resource_t* resources = NULL );

                        Menu_t( int menu_id, takes String_t* submenu_name );

    virtual             ~Menu_t();

    inline String_t*    Label() const;

    inline int          MenuID() const;

    void                AddSubmenu( takes Menu_t* menu, int index = -1 );

    Menu_t*             FindSubmenu(int menu_id);

    gives Menu_t*       RemoveSubmenu(Menu_t* menu);

    gives Menu_t*       RemoveSubmenu(int menu_id);

    void                AddItem( takes MenuItem_t* item, int index = -1 );

    MenuItem_t*         FindItem(int menu_id);

    gives MenuItem_t*   RemoveItem(MenuItem_t* item);

    gives MenuItem_t*   RemoveItem(int menu_id);

    void                AddBreak( takes MenuBreak_t* item, int index = -1 );

    MenuBreak_t*        FindBreak(int menu_id);

    gives MenuBreak_t*  RemoveBreak(MenuBreak_t* item);

    gives MenuBreak_t*  RemoveBreak(int menu_id);

    void                AddWindowMenuMerge( takes MenuMerge_t* merge, int index = -1 );

    MenuMerge_t*        FindWindowMenuMerge(int menu_id);

    gives MenuMerge_t*  RemoveWindowMenuMerge(MenuMerge_t* merge);

    gives MenuMerge_t*  RemoveWindowMenuMerge(int menu_id);

    inline int          CountNodes() const;

    inline MenuNode_t*  NodeAt(int index) const;

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    static void         LoadResourceMenu(   Menu_t* load_to,
                                            Resource_t* resources,
                                            int resource_id );
    static void         ReadMenuContents(   IOStream_t* stream,
                                            Menu_t* reading_to,
                                            bool is_submenu,
                                            OwnedList_t<Resource_t>* named_resources );
    static void         ReadMenuItem(   String_t* line,
                                        IOStream_t* stream,
                                        Menu_t* reading_to,
                                        OwnedList_t<Resource_t>* named_resources );
    static void         ReadMenu(   String_t* line,
                                    IOStream_t* stream,
                                    Menu_t* reading_to,
                                    OwnedList_t<Resource_t>* named_resources );
    static void         ReadBreak( String_t* line, IOStream_t* stream, Menu_t* reading_to );
    static void         ReadWindowMenuMerge(    String_t* line,
                                                IOStream_t* stream,
                                                Menu_t* reading_to );
    static void         AddExitMenuItem(    Menu_t* load_to,
                                            OwnedList_t<Resource_t>* named_resources );
    static void         AddPrefsMenuItem(   Menu_t* load_to,
                                            OwnedList_t<Resource_t>* named_resources );
    static void         AddWindowsMenu( Menu_t* load_to,
                                        OwnedList_t<Resource_t>* named_resources );
    static void         AddAboutMenuItem(   Menu_t* load_to,
                                            OwnedList_t<Resource_t>* named_resources );
    static Resource_t*  ModuleResource( OwnedList_t<Resource_t>* named_resources,
                                        stringliteral* name );

    #if DEBUG
    void                AssertParentOrGrandparentOf(MenuNode_t* node);
    #endif
    void                SetRootMenu(Menu_t* root_menu);
    void                AddSubmenuToKeyLookup( Menu_t* menu, bool sort );
    void                RemoveSubmenuFromKeyLookup(Menu_t* menu);
    void                AddMenuNodeToKeyLookup(MenuNode_t* item);
    void                RemoveMenuNodeFromKeyLookup(MenuNode_t* item);

    void                AdjustPlatformPlacements();

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t*                           m_label;
    Menu_t*                             m_root_menu;
    OwnedList_t<MenuNode_t>             m_items;
    SortedList_t< MenuNode_t, int >*    m_key_lookup;

    friend class App_t;
    friend class MenuBar_t;
};


//==================================================================================================
class UTGUI_EXPORT MenuItem_t
//==================================================================================================
: public MenuNode_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                                    MenuItem_t( int menu_id,
                                                takes String_t* label,
                                                bool checkable = false,
                                                bool checked = false );

    virtual                         ~MenuItem_t();

    inline String_t*                Label() const;

    inline int                      MenuID() const;

    void                            SetAction(  takes Message_t* message_to_send,
                                                const AbstractMessageDestination_t& destination );

    void                            Disable();

    inline bool                     IsEnabled() const;

    inline const Message_t*         ActionMessage() const;

    inline bool                     IsCheckable() const;

    inline bool                     IsChecked() const;

    void                            SetChecked(bool checked);

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    void                            Activated();
                                    MenuItem_t(int menu_id);

    //----------------------------------------------------------------------------------------------
    private:
    //----------------------------------------------------------------------------------------------
    String_t*                       m_label;
    Message_t*                      m_action_message;
    AbstractMessageDestination_t    m_action_destination;
    bool                            m_checkable;
    bool                            m_checked;

    friend class Menu_t;
    friend class MenuBar_t;
    friend class AppPlatformInfo_t;
};


//==================================================================================================
class UTGUI_EXPORT MenuBreak_t
//==================================================================================================
: public MenuNode_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                MenuBreak_t(int menu_id);

    virtual     ~MenuBreak_t();

    inline int  MenuID() const;

};


//==================================================================================================
class UTGUI_EXPORT MenuMerge_t
//==================================================================================================
: public MenuNode_t
{
    //----------------------------------------------------------------------------------------------
    public:
    //----------------------------------------------------------------------------------------------
                MenuMerge_t(int menu_id);

    virtual     ~MenuMerge_t();

    inline int  MenuID() const;
};




//==================================================================================================
//==================================================================================================
//===
//=== Inline function implementations
//===
//==================================================================================================
//==================================================================================================
inline void*
MenuNode_t::operator new(size_t size)
{
    return g_gui_pool_allocator.Allocate(size);
}


inline void
MenuNode_t::operator delete(void* block)
{
    g_gui_pool_allocator.Release(block);
}


inline int
MenuNode_t::MenuID() const
{
    return m_menu_id;
}


inline
MenuNode_t::operator int() const
{
    assert(m_menu_id);
    return m_menu_id;
}


inline int
MenuNode_t::Compare(int other_menu_id) const
{
    assert(m_menu_id);
    return m_menu_id - other_menu_id;
}


inline
MenuNode_t::operator uint() const
{
    assert(m_token);
    return m_token;
}


inline int
MenuNode_t::Compare(uint other_token) const
{
    assert(m_token);
    return m_token - other_token;
}


inline String_t*
Menu_t::Label() const
{
    return m_label;
}


inline int
Menu_t::MenuID() const
{
    return m_menu_id;
}


inline int
Menu_t::CountNodes() const
{
    return m_items.CountItems();
}


inline MenuNode_t*
Menu_t::NodeAt(int index) const
{
    return m_items.ItemAt(index);
}


inline String_t*
MenuItem_t::Label() const
{
    return m_label;
}


inline int
MenuItem_t::MenuID() const
{
    return m_menu_id;
}


inline bool
MenuItem_t::IsEnabled() const
{
    return m_action_destination.IsValid();
}


inline const Message_t*
MenuItem_t::ActionMessage() const
{
    return m_action_message;
}


inline bool
MenuItem_t::IsCheckable() const
{
    return m_checkable;
}


inline bool
MenuItem_t::IsChecked() const
{
    assert(m_checkable);
    return m_checked;
}


inline int
MenuBreak_t::MenuID() const
{
    return m_menu_id;
}


inline int
MenuMerge_t::MenuID() const
{
    return m_menu_id;
}


#endif // _UT_MENU_H_