src/common/accelcmn.cpp

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        src/common/accelcmn.cpp
   3 // Purpose:     implementation of platform-independent wxAcceleratorEntry parts
   4 // Author:      Vadim Zeitlin
   5 // Created:     2007-05-05
   6 // RCS-ID:      $Id$
   7 // Copyright:   (c) 2007 Vadim Zeitlin <vadim@wxwindows.org>
   8 // Licence:     wxWindows licence
   9 ///////////////////////////////////////////////////////////////////////////////
  10
  11 // ============================================================================
  12 // declarations
  13 // ============================================================================
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 // for compilers that support precompilation, includes "wx.h".
  20 #include "wx/wxprec.h"
  21
  22 #ifdef __BORLANDC__
  23     #pragma hdrstop
  24 #endif
  25
  26 #if wxUSE_ACCEL
  27
  28 #ifndef WX_PRECOMP
  29     #include "wx/string.h"
  30     #include "wx/intl.h"
  31     #include "wx/log.h"
  32     #include "wx/accel.h"
  33     #include "wx/crt.h"
  34 #endif //WX_PRECOMP
  35
  36 // ============================================================================
  37 // wxAcceleratorEntry implementation
  38 // ============================================================================
  39
  40 static const struct wxKeyName
  41 {
  42     wxKeyCode code;
  43     const char *name;
  44 } wxKeyNames[] =
  45 {
  46     { WXK_DELETE, wxTRANSLATE("DEL") },
  47     { WXK_DELETE, wxTRANSLATE("DELETE") },
  48     { WXK_BACK, wxTRANSLATE("BACK") },
  49     { WXK_INSERT, wxTRANSLATE("INS") },
  50     { WXK_INSERT, wxTRANSLATE("INSERT") },
  51     { WXK_RETURN, wxTRANSLATE("ENTER") },
  52     { WXK_RETURN, wxTRANSLATE("RETURN") },
  53     { WXK_PAGEUP, wxTRANSLATE("PGUP") },
  54     { WXK_PAGEDOWN, wxTRANSLATE("PGDN") },
  55     { WXK_LEFT, wxTRANSLATE("LEFT") },
  56     { WXK_RIGHT, wxTRANSLATE("RIGHT") },
  57     { WXK_UP, wxTRANSLATE("UP") },
  58     { WXK_DOWN, wxTRANSLATE("DOWN") },
  59     { WXK_HOME, wxTRANSLATE("HOME") },
  60     { WXK_END, wxTRANSLATE("END") },
  61     { WXK_SPACE, wxTRANSLATE("SPACE") },
  62     { WXK_TAB, wxTRANSLATE("TAB") },
  63     { WXK_ESCAPE, wxTRANSLATE("ESC") },
  64     { WXK_ESCAPE, wxTRANSLATE("ESCAPE") },
  65     { WXK_CANCEL, wxTRANSLATE("CANCEL") },
  66     { WXK_CLEAR, wxTRANSLATE("CLEAR") },
  67     { WXK_MENU, wxTRANSLATE("MENU") },
  68     { WXK_PAUSE, wxTRANSLATE("PAUSE") },
  69     { WXK_CAPITAL, wxTRANSLATE("CAPITAL") },
  70     { WXK_SELECT, wxTRANSLATE("SELECT") },
  71     { WXK_PRINT, wxTRANSLATE("PRINT") },
  72     { WXK_EXECUTE, wxTRANSLATE("EXECUTE") },
  73     { WXK_SNAPSHOT, wxTRANSLATE("SNAPSHOT") },
  74     { WXK_HELP, wxTRANSLATE("HELP") },
  75     { WXK_ADD, wxTRANSLATE("ADD") },
  76     { WXK_SEPARATOR, wxTRANSLATE("SEPARATOR") },
  77     { WXK_SUBTRACT, wxTRANSLATE("SUBTRACT") },
  78     { WXK_DECIMAL, wxTRANSLATE("DECIMAL") },
  79     { WXK_DIVIDE, wxTRANSLATE("DIVIDE") },
  80     { WXK_NUMLOCK, wxTRANSLATE("NUM_LOCK") },
  81     { WXK_SCROLL, wxTRANSLATE("SCROLL_LOCK") },
  82     { WXK_PAGEUP, wxTRANSLATE("PAGEUP") },
  83     { WXK_PAGEDOWN, wxTRANSLATE("PAGEDOWN") },
  84     { WXK_NUMPAD_SPACE, wxTRANSLATE("KP_SPACE") },
  85     { WXK_NUMPAD_TAB, wxTRANSLATE("KP_TAB") },
  86     { WXK_NUMPAD_ENTER, wxTRANSLATE("KP_ENTER") },
  87     { WXK_NUMPAD_HOME, wxTRANSLATE("KP_HOME") },
  88     { WXK_NUMPAD_LEFT, wxTRANSLATE("KP_LEFT") },
  89     { WXK_NUMPAD_UP, wxTRANSLATE("KP_UP") },
  90     { WXK_NUMPAD_RIGHT, wxTRANSLATE("KP_RIGHT") },
  91     { WXK_NUMPAD_DOWN, wxTRANSLATE("KP_DOWN") },
  92     { WXK_NUMPAD_PAGEUP, wxTRANSLATE("KP_PRIOR") },
  93     { WXK_NUMPAD_PAGEUP, wxTRANSLATE("KP_PAGEUP") },
  94     { WXK_NUMPAD_PAGEDOWN, wxTRANSLATE("KP_NEXT") },
  95     { WXK_NUMPAD_PAGEDOWN, wxTRANSLATE("KP_PAGEDOWN") },
  96     { WXK_NUMPAD_END, wxTRANSLATE("KP_END") },
  97     { WXK_NUMPAD_BEGIN, wxTRANSLATE("KP_BEGIN") },
  98     { WXK_NUMPAD_INSERT, wxTRANSLATE("KP_INSERT") },
  99     { WXK_NUMPAD_DELETE, wxTRANSLATE("KP_DELETE") },
 100     { WXK_NUMPAD_EQUAL, wxTRANSLATE("KP_EQUAL") },
 101     { WXK_NUMPAD_MULTIPLY, wxTRANSLATE("KP_MULTIPLY") },
 102     { WXK_NUMPAD_ADD, wxTRANSLATE("KP_ADD") },
 103     { WXK_NUMPAD_SEPARATOR, wxTRANSLATE("KP_SEPARATOR") },
 104     { WXK_NUMPAD_SUBTRACT, wxTRANSLATE("KP_SUBTRACT") },
 105     { WXK_NUMPAD_DECIMAL, wxTRANSLATE("KP_DECIMAL") },
 106     { WXK_NUMPAD_DIVIDE, wxTRANSLATE("KP_DIVIDE") },
 107     { WXK_WINDOWS_LEFT, wxTRANSLATE("WINDOWS_LEFT") },
 108     { WXK_WINDOWS_RIGHT, wxTRANSLATE("WINDOWS_RIGHT") },
 109     { WXK_WINDOWS_MENU, wxTRANSLATE("WINDOWS_MENU") },
 110     { WXK_COMMAND, wxTRANSLATE("COMMAND") },
 111 };
 112
 113 // return true if the 2 strings refer to the same accel
 114 //
 115 // as accels can be either translated or not, check for both possibilities and
 116 // also compare case-insensitively as the key names case doesn't count
 117 static inline bool CompareAccelString(const wxString& str, const char *accel)
 118 {
 119     return str.CmpNoCase(accel) == 0
 120 #if wxUSE_INTL
 121             || str.CmpNoCase(wxGetTranslation(accel)) == 0
 122 #endif
 123             ;
 124 }
 125
 126 // return prefixCode+number if the string is of the form "<prefix><number>" and
 127 // 0 if it isn't
 128 //
 129 // first and last parameter specify the valid domain for "number" part
 130 static int IsNumberedAccelKey(const wxString& str,
 131                               const char *prefix,
 132                               wxKeyCode prefixCode,
 133                               unsigned first,
 134                               unsigned last)
 135 {
 136     const size_t lenPrefix = wxStrlen(prefix);
 137     if ( !CompareAccelString(str.Left(lenPrefix), prefix) )
 138         return 0;
 139
 140     unsigned long num;
 141     if ( !str.Mid(lenPrefix).ToULong(&num) )
 142         return 0;
 143
 144     if ( num < first || num > last )
 145     {
 146         // this must be a mistake, chances that this is a valid name of another
 147         // key are vanishingly small
 148         wxLogDebug(wxT("Invalid key string \"%s\""), str.c_str());
 149         return 0;
 150     }
 151
 152     return prefixCode + num - first;
 153 }
 154
 155 /* static */
 156 bool
 157 wxAcceleratorEntry::ParseAccel(const wxString& text, int *flagsOut, int *keyOut)
 158 {
 159     // the parser won't like trailing spaces
 160     wxString label = text;
 161     label.Trim(true);
 162
 163     // For compatibility with the old wx versions which accepted (and actually
 164     // even required) a TAB character in the string passed to this function we
 165     // ignore anything up to the first TAB. Notice however that the correct
 166     // input consists of just the accelerator itself and nothing else, this is
 167     // done for compatibility and compatibility only.
 168     int posTab = label.Find(wxT('\t'));
 169     if ( posTab == wxNOT_FOUND )
 170         posTab = 0;
 171     else
 172         posTab++;
 173
 174     // parse the accelerator string
 175     int accelFlags = wxACCEL_NORMAL;
 176     wxString current;
 177     for ( size_t n = (size_t)posTab; n < label.length(); n++ )
 178     {
 179         if ( (label[n] == '+') || (label[n] == '-') )
 180         {
 181             if ( CompareAccelString(current, wxTRANSLATE("ctrl")) )
 182                 accelFlags |= wxACCEL_CTRL;
 183             else if ( CompareAccelString(current, wxTRANSLATE("alt")) )
 184                 accelFlags |= wxACCEL_ALT;
 185             else if ( CompareAccelString(current, wxTRANSLATE("shift")) )
 186                 accelFlags |= wxACCEL_SHIFT;
 187             else // not a recognized modifier name
 188             {
 189                 // we may have "Ctrl-+", for example, but we still want to
 190                 // catch typos like "Crtl-A" so only give the warning if we
 191                 // have something before the current '+' or '-', else take
 192                 // it as a literal symbol
 193                 if ( current.empty() )
 194                 {
 195                     current += label[n];
 196
 197                     // skip clearing it below
 198                     continue;
 199                 }
 200                 else
 201                 {
 202                     wxLogDebug(wxT("Unknown accel modifier: '%s'"),
 203                                current.c_str());
 204                 }
 205             }
 206
 207             current.clear();
 208         }
 209         else // not special character
 210         {
 211             current += (wxChar) wxTolower(label[n]);
 212         }
 213     }
 214
 215     int keyCode;
 216     const size_t len = current.length();
 217     switch ( len )
 218     {
 219         case 0:
 220             wxLogDebug(wxT("No accel key found, accel string ignored."));
 221             return false;
 222
 223         case 1:
 224             // it's just a letter
 225             keyCode = current[0U];
 226
 227             // if the key is used with any modifiers, make it an uppercase one
 228             // because Ctrl-A and Ctrl-a are the same; but keep it as is if it's
 229             // used alone as 'a' and 'A' are different
 230             if ( accelFlags != wxACCEL_NORMAL )
 231                 keyCode = wxToupper(keyCode);
 232             break;
 233
 234         default:
 235             keyCode = IsNumberedAccelKey(current, wxTRANSLATE("F"),
 236                                          WXK_F1, 1, 12);
 237             if ( !keyCode )
 238             {
 239                 for ( size_t n = 0; n < WXSIZEOF(wxKeyNames); n++ )
 240                 {
 241                     const wxKeyName& kn = wxKeyNames[n];
 242                     if ( CompareAccelString(current, kn.name) )
 243                     {
 244                         keyCode = kn.code;
 245                         break;
 246                     }
 247                 }
 248             }
 249
 250             if ( !keyCode )
 251                 keyCode = IsNumberedAccelKey(current, wxTRANSLATE("KP_"),
 252                                              WXK_NUMPAD0, 0, 9);
 253             if ( !keyCode )
 254                 keyCode = IsNumberedAccelKey(current, wxTRANSLATE("SPECIAL"),
 255                                              WXK_SPECIAL1, 1, 20);
 256
 257             if ( !keyCode )
 258             {
 259                 wxLogDebug(wxT("Unrecognized accel key '%s', accel string ignored."),
 260                            current.c_str());
 261                 return false;
 262             }
 263     }
 264
 265
 266     wxASSERT_MSG( keyCode, wxT("logic error: should have key code here") );
 267
 268     if ( flagsOut )
 269         *flagsOut = accelFlags;
 270     if ( keyOut )
 271         *keyOut = keyCode;
 272
 273     return true;
 274 }
 275
 276 /* static */
 277 wxAcceleratorEntry *wxAcceleratorEntry::Create(const wxString& str)
 278 {
 279     const wxString accelStr = str.AfterFirst('\t');
 280     if ( accelStr.empty() )
 281     {
 282         // It's ok to pass strings not containing any accelerators at all to
 283         // this function, wxMenuItem code does it and we should just return
 284         // NULL in this case.
 285         return NULL;
 286     }
 287
 288     int flags,
 289         keyCode;
 290     if ( !ParseAccel(accelStr, &flags, &keyCode) )
 291         return NULL;
 292
 293     return new wxAcceleratorEntry(flags, keyCode);
 294 }
 295
 296 bool wxAcceleratorEntry::FromString(const wxString& str)
 297 {
 298     return ParseAccel(str, &m_flags, &m_keyCode);
 299 }
 300
 301 wxString wxAcceleratorEntry::ToString() const
 302 {
 303     wxString text;
 304
 305     int flags = GetFlags();
 306     if ( flags & wxACCEL_ALT )
 307         text += _("Alt+");
 308     if ( flags & wxACCEL_CTRL )
 309         text += _("Ctrl+");
 310     if ( flags & wxACCEL_SHIFT )
 311         text += _("Shift+");
 312
 313     const int code = GetKeyCode();
 314
 315     if ( code >= WXK_F1 && code <= WXK_F12 )
 316         text << _("F") << code - WXK_F1 + 1;
 317     else if ( code >= WXK_NUMPAD0 && code <= WXK_NUMPAD9 )
 318         text << _("KP_") << code - WXK_NUMPAD0;
 319     else if ( code >= WXK_SPECIAL1 && code <= WXK_SPECIAL20 )
 320         text << _("SPECIAL") << code - WXK_SPECIAL1 + 1;
 321     else // check the named keys
 322     {
 323         size_t n;
 324         for ( n = 0; n < WXSIZEOF(wxKeyNames); n++ )
 325         {
 326             const wxKeyName& kn = wxKeyNames[n];
 327             if ( code == kn.code )
 328             {
 329                 text << wxGetTranslation(kn.name);
 330                 break;
 331             }
 332         }
 333
 334         if ( n == WXSIZEOF(wxKeyNames) )
 335         {
 336             // must be a simple key
 337             if (
 338 #if !wxUSE_UNICODE
 339                  // we can't call wxIsalnum() for non-ASCII characters in ASCII
 340                  // build as they're only defined for the ASCII range (or EOF)
 341                  wxIsascii(code) &&
 342 #endif // ANSI
 343                     wxIsalnum(code) )
 344             {
 345                 text << (wxChar)code;
 346             }
 347             else
 348             {
 349                 wxFAIL_MSG( wxT("unknown keyboard accelerator code") );
 350             }
 351         }
 352     }
 353
 354     return text;
 355 }
 356
 357 wxAcceleratorEntry *wxGetAccelFromString(const wxString& label)
 358 {
 359     return wxAcceleratorEntry::Create(label);
 360 }
 361
 362 #endif // wxUSE_ACCEL
 363
 364
 365