Added wxStrnicmp and to wchar.h, not yet for Unicode mode.

[wxWidgets.git] / src / mac / menu.cpp

/////////////////////////////////////////////////////////////////////////////
// Name:        menu.cpp
// Purpose:     wxMenu, wxMenuBar, wxMenuItem
// Author:      AUTHOR
// Modified by:
// Created:     ??/??/98
// RCS-ID:      $Id$
// Copyright:   (c) AUTHOR
// Licence:   	wxWindows licence
/////////////////////////////////////////////////////////////////////////////


// ============================================================================
// headers & declarations
// ============================================================================

// wxWindows headers
// -----------------

#ifdef __GNUG__
#pragma implementation "menu.h"
#pragma implementation "menuitem.h"
#endif

#include "wx/menu.h"
#include "wx/menuitem.h"
#include "wx/log.h"
#include "wx/utils.h"

#include "wx/mac/uma.h"

// other standard headers
// ----------------------
#include <string.h>

#if !USE_SHARED_LIBRARY
IMPLEMENT_DYNAMIC_CLASS(wxMenu, wxEvtHandler)
IMPLEMENT_DYNAMIC_CLASS(wxMenuBar, wxEvtHandler)
#endif

// the (popup) menu title has this special id
static const int idMenuTitle = -2;
static int formerHelpMenuItems = 0 ;

const short kwxMacMenuBarResource = 1 ;
const short kwxMacAppleMenuId = 1 ;

// ============================================================================
// implementation
// ============================================================================

//
// Helper Functions to get Mac Menus the way they should be ;-)
//

void wxMacCtoPString(const char* theCString, Str255 thePString);

// remove inappropriate characters, if useShortcuts is false, the ampersand will not auto-generate a mac menu-shortcut

static void wxMacBuildMenuString(StringPtr outMacItemText, char *outMacShortcutChar , short *outMacModifiers , const char *inItemName , bool useShortcuts )
{
	char *p = (char *) &outMacItemText[1] ;
	short macModifiers = 0 ;
	char macShortCut = 0 ;
	
	if ( useShortcuts && !wxApp::s_macSupportPCMenuShortcuts )
		useShortcuts = false ;
	
	// we have problems with a leading hypen - it will be taken as a separator
	
	while ( *inItemName == '-' )
		inItemName++ ;
		
	while( *inItemName )
	{
		switch ( *inItemName )
		{
			// special characters for macintosh menus -> use some replacement
			case ';' :
				*p++ = ',' ;
				break ;
			case '^' :
				*p++ = ' ' ;
				break ;
			case '!' :
				*p++ = ' ' ;
				break ;
			case '<' :
				*p++ = ' ' ;
				break ;
			case '/' :
				*p++ = '|' ;
				break ;
			case '(' :
				*p++ = '[' ;
				break ;
			case ')' :	
				*p++ = ']' ;
				break ;
			// shortcuts
			case '&' :
				{
					++inItemName ;
					if ( *inItemName )
					{
						*p++ = *inItemName ;
						if ( useShortcuts )
							macShortCut = *inItemName ;
					}
					else
						--inItemName ;
				}
				break ;
			// win-like accelerators
			case '\t' :
				{
					++inItemName ;
					while( *inItemName )
					{
						if (strncmp("Ctrl+", inItemName, 5) == 0) 
						{
							inItemName = inItemName + 5;
							macShortCut = *inItemName;
						}
						else if (strncmp("Alt+", inItemName, 4) == 0) 
						{
							inItemName = inItemName + 4;
							macModifiers |= kMenuOptionModifier ;
							macShortCut = *inItemName ;
						}
						else if (strncmp("Shift+", inItemName, 6) == 0) 
						{
							inItemName = inItemName + 6;
							macModifiers |= kMenuShiftModifier ;
							macShortCut = *inItemName ;
						}
						else if (strncmp("F", inItemName, 1) == 0) 
						{
							inItemName += strlen( inItemName ) ;
							// no function keys at the moment
							// macModifiers |= kMenuShiftModifier ;
							// macShortCut = *inItemName ;
						}
						else
						{
							break ;
						}
					}

					if ( *inItemName == 0 )
						--inItemName ;
						
				}
				break ;
			default :
				*p++ = *inItemName ;
		}
		++inItemName ;
	}

	outMacItemText[0] = (p - (char *)outMacItemText) - 1;
	if ( outMacShortcutChar )
		*outMacShortcutChar = macShortCut ;
	if ( outMacModifiers )
		*outMacModifiers = macModifiers ;
	if ( macShortCut )
	{
			int pos = outMacItemText[0] ;
			outMacItemText[++pos] = '/';
			outMacItemText[++pos] = toupper( macShortCut );
			outMacItemText[0] = pos ;
	}
}

// Menus

// Construct a menu with optional title (then use append)

short wxMenu::s_macNextMenuId = 2 ;

wxMenu::wxMenu(const wxString& title, const wxFunction func)
{
    m_title = title;
    m_parent = NULL;
    m_eventHandler = this;
    m_noItems = 0;
    m_menuBar = NULL;
    m_pInvokingWindow = NULL ;
    m_clientData = (void*) NULL;
    if (m_title != "")
    {
        Append(idMenuTitle, m_title) ;
        AppendSeparator() ;
    }

    Callback(func);

	Str255 	label;
	wxMacBuildMenuString( label, NULL , NULL , title , false );
	m_macMenuId = s_macNextMenuId++; 
    wxCHECK_RET( s_macNextMenuId < 236 , "menu ids > 235 cannot be used for submenus on mac" );
	m_macMenuHandle = ::NewMenu(m_macMenuId, label);
	m_macMenuEnabled = true ;
}

// The wxWindow destructor will take care of deleting the submenus.
wxMenu::~wxMenu()
{
    wxNode *node = m_menuItems.First();
    while (node)
    {
        wxMenuItem *item = (wxMenuItem *)node->Data();

        // Delete child menus.
        // Beware: they must not be appended to children list!!!
        // (because order of delete is significant)
        if (item->GetSubMenu())
            item->DeleteSubMenu();

        wxNode *next = node->Next();
        delete item;
        delete node;
        node = next;
    }
	if (m_macMenuHandle)
		::DisposeMenu(m_macMenuHandle);
}

void wxMenu::Break()
{
	// not available on the mac platform
}

// function appends a new item or submenu to the menu
void wxMenu::Append(wxMenuItem *pItem)
{
    wxCHECK_RET( pItem != NULL, "can't append NULL item to the menu" );

    m_menuItems.Append(pItem);

	if ( pItem->IsSeparator() )
	{
		MacAppendMenu(m_macMenuHandle, "\p-");
	}
	else 
	{
		wxMenu *pSubMenu = pItem->GetSubMenu() ;
		if ( pSubMenu != NULL )
		{
 			Str255 label;
   			wxCHECK_RET( pSubMenu->m_macMenuHandle != NULL , "invalid submenu added");
		    pSubMenu->m_parent = this ;
			wxMacBuildMenuString( label , NULL , NULL , pItem->GetName() ,false);
		
			// hardcoded adding of the submenu combination for mac
		
			int theEnd = label[0] + 1; 
			if (theEnd > 251) 
				theEnd = 251; // mac allows only 255 characters
			label[theEnd++] = '/';
			label[theEnd++] = hMenuCmd; 
			label[theEnd++] = '!';
			label[theEnd++] = pSubMenu->m_macMenuId; 
			label[theEnd] = 0x00;
			label[0] = theEnd;

			if (wxMenuBar::s_macInstalledMenuBar == m_menuBar) 
			{
				::InsertMenu( pSubMenu->m_macMenuHandle , -1 ) ;
			}
			
			::AppendMenu(m_macMenuHandle, label);
		}
		else
		{
			Str255 label ;
			wxMacBuildMenuString( label , NULL , NULL , pItem->GetName(), pItem->GetId() == wxApp::s_macAboutMenuItemId);
			if ( label[0] == 0 )
			{
				// we cannot add empty menus on mac
				label[0] = 1 ;
				label[1] = ' ' ;
			}
			::AppendMenu(m_macMenuHandle, label );
  			if ( pItem->GetId() == idMenuTitle ) 
  			{
					UMADisableMenuItem( m_macMenuHandle , CountMItems( m_macMenuHandle ) ) ;
  			}
		}
	}

    m_noItems++;
}

void wxMenu::AppendSeparator()
{
    Append(new wxMenuItem(this, ID_SEPARATOR));
}

// Pullright item
void wxMenu::Append(int Id, const wxString& label, wxMenu *SubMenu, 
                    const wxString& helpString)
{
    Append(new wxMenuItem(this, Id, label, helpString, FALSE, SubMenu));
}

// Ordinary menu item
void wxMenu::Append(int Id, const wxString& label, 
                    const wxString& helpString, bool checkable)
{
  // 'checkable' parameter is useless for Windows.
    Append(new wxMenuItem(this, Id, label, helpString, checkable));
}

void wxMenu::Delete(int id)
{
    wxNode *node;
    wxMenuItem *item;
    int pos;

    for (pos = 0, node = m_menuItems.First(); node; node = node->Next(), pos++) {
	 item = (wxMenuItem *)node->Data();
	 if (item->GetId() == id)
		break;
    }

    if (!node)
		return;

    int index = pos + 1 ;

    if (index < 1)
		return;

	wxMenu *pSubMenu = item->GetSubMenu();
	if ( pSubMenu != NULL ) 
	{
		::DeleteMenuItem( m_macMenuHandle , index);
		pSubMenu->m_parent = NULL;
		// TODO: Why isn't subMenu deleted here???
		// Will put this in for now. Assuming this is supposed
		// to delete the menu, not just remove it.
		item->DeleteSubMenu();
	}
	else 
	{
		::DeleteMenuItem( m_macMenuHandle , index);
	}

    m_menuItems.DeleteNode(node);