KeyboardTranslator.h 16.3 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/*
    This source file is part of Konsole, a terminal emulator.

    Copyright (C) 2007 by Robert Knight <robertknight@gmail.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; either version 2 of the License, or
    (at your option) any later version.

    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.
*/

22
23
24
#ifndef KEYBOARDTRANSLATOR_H
#define KEYBOARDTRANSLATOR_H

25
// Qt
Dirk Mueller's avatar
Dirk Mueller committed
26
27
28
29
30
#include <QtCore/QHash>
#include <QtCore/QList>
#include <QtGui/QKeySequence>
#include <QtCore/QMetaType>
#include <QtCore/QVarLengthArray>
31
32

class QIODevice;
33
class QTextStream;
34

35
36
namespace Konsole
{
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82

/** 
 * A convertor which maps between key sequences pressed by the user and the
 * character strings which should be sent to the terminal and commands
 * which should be invoked when those character sequences are pressed.
 *
 * Konsole supports multiple keyboard translators, allowing the user to
 * specify the character sequences which are sent to the terminal
 * when particular key sequences are pressed.
 *
 * A key sequence is defined as a key code, associated keyboard modifiers
 * (Shift,Ctrl,Alt,Meta etc.) and state flags which indicate the state
 * which the terminal must be in for the key sequence to apply.
 */
class KeyboardTranslator
{
public:
    /** 
     * The meaning of a particular key sequence may depend upon the state which
     * the terminal emulation is in.  Therefore findEntry() may return a different
     * Entry depending upon the state flags supplied.
     *
     * This enum describes the states which may be associated with with a particular
     * entry in the keyboard translation entry.
     */
    enum State
    {
        /** Indicates that no special state is active */
        NoState = 0,
        /**
         * TODO More documentation
         */
        NewLineState = 1,
        /** 
         * Indicates that the terminal is in 'Ansi' mode.
         * TODO: More documentation
         */
        AnsiState = 2,
        /**
         * TODO More documentation
         */
        CursorKeysState = 4,
        /**
         * Indicates that the alternate screen ( typically used by interactive programs
         * such as screen or vim ) is active 
         */
83
84
85
        AlternateScreenState = 8,
        /** Indicates that any of the modifier keys is active. */ 
        AnyModifierState = 16
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
    };

    /**
     * This enum describes commands which are associated with particular key sequences.
     */
    enum Command
    {
        /** Indicates that no command is associated with this command sequence */
        NoCommand = 0,
        /** TODO Document me */
        SendCommand = 1,
        /** Scroll the terminal display up one page */
        ScrollPageUpCommand = 2,
        /** Scroll the terminal display down one page */
        ScrollPageDownCommand = 4,
        /** Scroll the terminal display up one line */
        ScrollLineUpCommand = 8,
        /** Scroll the terminal display down one line */
        ScrollLineDownCommand = 16,
        /** Toggles scroll lock mode */
        ScrollLockCommand = 32
    };

    /**
     * Represents an association between a key sequence pressed by the user
     * and the character sequence and commands associated with it for a particular
     * KeyboardTranslator.
     */
    class Entry
    {
    public:
        /** 
         * Constructs a new entry for a keyboard translator.
         */
        Entry();

        /** Returns the commands associated with this entry */
        Command command() const;
124
125
126
        /** Sets the command associated with this entry. */
        void setCommand(Command command);

127
        /** Returns the character sequence associated with this entry */
128
        QByteArray text() const;
129
130
        /** Sets the character sequence associated with this entry */
        void setText(const QByteArray& text);
131

132
133
134
135
136
137
138
139
        /** 
         * Returns the character sequence associated with this entry,
         * with any non-printable characters replaced with escape sequences.
         *
         * eg. \E for Escape, \t for tab, \n for new line.
         */
        QByteArray escapedText() const;

140
141
        /** Returns the character code ( from the Qt::Key enum ) associated with this entry */
        int keyCode() const;
142
143
144
145
146
147
148
149
150
151
152
        /** Sets the character code associated with this entry */
        void setKeyCode(int keyCode);

        /** 
         * Returns the a bitwise-OR of the enabled keyboard modifiers associated with this entry. 
         * If a modifier is set in modifierMask() but not in modifiers(), this means that the entry
         * only matches when that modifier is NOT pressed.
         *
         * If a modifier is not set in modifierMask() then the entry matches whether the modifier
         * is pressed or not. 
         */
153
        Qt::KeyboardModifier modifiers() const;
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170

        /** Returns the keyboard modifiers which are valid in this entry.  See modifiers() */
        Qt::KeyboardModifier modifierMask() const;

        /** See modifiers() */
        void setModifiers( Qt::KeyboardModifier modifiers );
        /** See modifierMask() and modifiers() */
        void setModifierMask( Qt::KeyboardModifier modifiers );

        /** 
         * Returns a bitwise-OR of the enabled state flags associated with this entry. 
         * If flag is set in stateMask() but not in state(), this means that the entry only 
         * matches when the terminal is NOT in that state.
         *
         * If a state is not set in stateMask() then the entry matches whether the terminal
         * is in that state or not. 
         */
171
172
        State state() const;

173
174
175
176
177
178
179
180
        /** Returns the state flags which are valid in this entry.  See state() */
        State stateMask() const;

        /** See state() */
        void setState( State state );
        /** See stateMask() */
        void setStateMask( State mask );

181
182
183
184
        /** 
         * Returns the key code and modifiers associated with this entry 
         * as a QKeySequence
         */
185
186
187
188
189
190
191
        //QKeySequence keySequence() const;

        /** 
         * Returns this entry's conditions ( ie. its key code, modifier and state criteria )
         * as a string.
         */
        QString conditionToString() const;
192

193
194
195
196
197
198
        /**
         * Returns this entry's result ( ie. its command or character sequence )
         * as a string.
         */
        QString resultToString() const;

199
200
201
202
203
204
        /** 
         * Returns true if this entry matches the given key sequence, specified
         * as a combination of @p keyCode , @p modifiers and @p state.
         */
        bool matches( int keyCode , Qt::KeyboardModifier modifiers , State flags ) const;

205
        bool operator==(const Entry& rhs);
206
207
       
    private:
208
209
        void insertModifier( QString& item , int modifier ) const;
        void insertState( QString& item , int state ) const;
210
        QByteArray unescape(const QByteArray& text) const;
211

212
213
        int _keyCode;
        Qt::KeyboardModifier _modifiers;
214
        Qt::KeyboardModifier _modifierMask;
215
        State _state;
216
        State _stateMask;
217
218

        Command _command;
219
        QByteArray _text;
220
221
222
223
    };

    /** Constructs a new keyboard translator with the given @p name */
    KeyboardTranslator(const QString& name);
224
   
225
    //KeyboardTranslator(const KeyboardTranslator& other);
226

227
228
229
    /** Returns the name of this keyboard translator */
    QString name() const;

230
231
232
    /** Sets the name of this keyboard translator */
    void setName(const QString& name);

233
234
235
236
237
238
    /** Returns the descriptive name of this keyboard translator */
    QString description() const;

    /** Sets the descriptive name of this keyboard translator */
    void setDescription(const QString& description);

239
240
241
242
243
244
245
246
247
248
249
    /**
     * Looks for an entry in this keyboard translator which matches the given
     * key code, keyboard modifiers and state flags.
     * 
     * Returns the matching entry if found or 0 if there is no matching entry
     * in this keyboard translation.
     *
     * @param keyCode A key code from the Qt::Key enum
     * @param modifiers A combination of modifiers
     * @param state Optional flags which specify the current state of the terminal
     */
250
    Entry findEntry(int keyCode , Qt::KeyboardModifier modifiers , State state = NoState) const;
251
252
253
254
255
256
257

    /** 
     * Adds an entry to this keyboard translator's table.  Entries can be looked up according
     * to their key sequence using findEntry()
     */
    void addEntry(const Entry& entry);

258
259
260
261
262
263
264
265
266
267
    /**
     * Replaces an entry in the translator.
     */
    void replaceEntry(const Entry& existing , const Entry& replacement);

    /**
     * Removes an entry from the table.
     */
    void removeEntry(const Entry& entry);

268
    /** Returns a list of all entries in the translator. */
269
    QList<Entry> entries() const;
270

271
private:
272
    QMultiHash<int,Entry> _entries; // entries in this keyboard translation,
273
274
                                                 // entries are indexed according to
                                                 // their keycode
275
    QString _name;
276
    QString _description;
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
};

/** 
 * Parses the contents of a Keyboard Translator (.keytab) file and 
 * returns the entries found in it.
 *
 * Usage example:
 *
 * @code
 *  QFile source( "/path/to/keytab" );
 *  source.open( QIODevice::ReadOnly );
 *
 *  KeyboardTranslator* translator = new KeyboardTranslator( "name-of-translator" );
 *
 *  KeyboardTranslatorReader reader(source);
 *  while ( reader.hasNextEntry() )
 *      translator->addEntry(reader.nextEntry());
 *
 *  source.close();
 *
 *  if ( !reader.parseError() )
 *  {
 *      // parsing succeeded, do something with the translator
 *  } 
 *  else
 *  {
 *      // parsing failed
 *  }
 * @endcode
 */
class KeyboardTranslatorReader
{
public:
    /** Constructs a new reader which parses the given @p source */
311
312
313
314
315
316
317
    KeyboardTranslatorReader( QIODevice* source );

    /** 
     * Returns the description text. 
     * TODO: More documentation 
     */
    QString description() const;
318
319

    /** Returns true if there is another entry in the source stream */
320
    bool hasNextEntry();
321
    /** Returns the next entry found in the source stream */
322
    KeyboardTranslator::Entry nextEntry(); 
323
324
325
326
327

    /** 
     * Returns true if an error occurred whilst parsing the input or
     * false if no error occurred.
     */
328
329
    bool parseError();

330
331
332
333
334
335
336
337
    /**
     * Parses a condition and result string for a translator entry
     * and produces a keyboard translator entry.
     *
     * The condition and result strings are in the same format as in  
     */
    static KeyboardTranslator::Entry createEntry( const QString& condition ,
                                                  const QString& result );
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
private:
    struct Token
    {
        enum Type
        {
            TitleKeyword,
            TitleText,
            KeyKeyword,
            KeySequence,
            Command,
            OutputText
        };
        Type type;
        QString text;
    };
    QList<Token> tokenize(const QString&);
    void readNext();
355
356
357
358
359
360
361
    bool decodeSequence(const QString& , 
                                int& keyCode,
                                Qt::KeyboardModifier& modifiers,
                                Qt::KeyboardModifier& modifiers,
                                KeyboardTranslator::State& state,
                                KeyboardTranslator::State& stateFlags);

362
363
364
    static bool parseAsModifier(const QString& item , int& modifier);
    static bool parseAsStateFlag(const QString& item , int& modifier);
    static bool parseAsKeyCode(const QString& item , int& modifier);
365
    
366
367
368
369
    QIODevice* _source;
    QString _description;
    KeyboardTranslator::Entry _nextEntry;
    bool _hasNext;
370
371
};

372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
/** Writes a keyboard translation to disk. */
class KeyboardTranslatorWriter
{
public:
    /** 
     * Constructs a new writer which saves data into @p destination.
     * The caller is responsible for closing the device when writing is complete.
     */
    KeyboardTranslatorWriter(QIODevice* destination);
    ~KeyboardTranslatorWriter();

    /** 
     * Writes the header for the keyboard translator. 
     * @param description Description of the keyboard translator. 
     */
    void writeHeader( const QString& description );
    /** Writes a translator entry. */
    void writeEntry( const KeyboardTranslator::Entry& entry ); 

private:
    QIODevice* _destination;  
    QTextStream* _writer;
};

396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
/**
 * Manages the keyboard translations available for use by terminal sessions,
 * see KeyboardTranslator.
 */
class KeyboardTranslatorManager
{
public:
    /** 
     * Constructs a new KeyboardTranslatorManager and loads the list of
     * available keyboard translations.
     *
     * The keyboard translations themselves are not loaded until they are
     * first requested via a call to findTranslator()
     */
    KeyboardTranslatorManager();

412
413
414
415
416
417
418
419
420
421
422
423
424
425
    /**
     * Adds a new translator.  If a translator with the same name 
     * already exists, it will be replaced by the new translator.
     *
     * TODO: More documentation.
     */
    void addTranslator(KeyboardTranslator* translator);

    /**
     * Deletes a translator.
     * TODO: More documentation
     */
    void deleteTranslator(const QString& name);

426
427
428
429
430
431
432
433
434
435
    /** 
     * Returns the keyboard translator with the given name or 0 if no translator
     * with that name exists.
     *
     * The first time that a translator with a particular name is requested,
     * the on-disk .keyboard file is loaded and parsed.  
     */
    const KeyboardTranslator* findTranslator(const QString& name);
    /**
     * Returns a list of the names of available keyboard translators.
436
437
438
     *
     * The first time this is called, a search for available 
     * translators is started.
439
     */
440
    QList<QString> allTranslators();
441

442
    /** Sets the global KeyboardTranslatorManager instance. */
443
   static void setInstance(KeyboardTranslatorManager* instance);
444
    /** Returns the global KeyboardTranslatorManager instance. */
445
   static KeyboardTranslatorManager* instance();
446

447
448
449
450
451
private:
    void findTranslators(); // locate the available translators
    KeyboardTranslator* loadTranslator(const QString& name); // loads the translator 
                                                             // with the given name
    
452
    bool saveTranslator(const KeyboardTranslator* translator);
453
454
    QString findTranslatorPath(const QString& name);
    
455
456
    QHash<QString,KeyboardTranslator*> _translators; // maps translator-name -> KeyboardTranslator
                                                     // instance
457
458
459


    bool _haveLoadedAll;
460

461
    static KeyboardTranslatorManager* _instance;
462
463
};

464
465
466
467
468
469
inline int KeyboardTranslator::Entry::keyCode() const { return _keyCode; }
inline void KeyboardTranslator::Entry::setKeyCode(int keyCode) { _keyCode = keyCode; }

inline void KeyboardTranslator::Entry::setModifiers( Qt::KeyboardModifier modifier ) 
{ 
    _modifiers = modifier;
470
}
471
472
473
474
475
inline Qt::KeyboardModifier KeyboardTranslator::Entry::modifiers() const { return _modifiers; }

inline void  KeyboardTranslator::Entry::setModifierMask( Qt::KeyboardModifier mask ) 
{ 
   _modifierMask = mask; 
476
}
477
478
479
480
481
inline Qt::KeyboardModifier KeyboardTranslator::Entry::modifierMask() const { return _modifierMask; }

inline void KeyboardTranslator::Entry::setCommand( Command command )
{ 
    _command = command; 
482
}
483
484
485
486
inline KeyboardTranslator::Command KeyboardTranslator::Entry::command() const { return _command; }

inline void KeyboardTranslator::Entry::setText( const QByteArray& text )
{ 
487
    _text = unescape(text);
488
}
489
490
491
492
493
494
495
496
497
498
499
inline QByteArray KeyboardTranslator::Entry::text() const { return _text; }

inline void KeyboardTranslator::Entry::setState( State state )
{ 
    _state = state; 
}
inline KeyboardTranslator::State KeyboardTranslator::Entry::state() const { return _state; }

inline void KeyboardTranslator::Entry::setStateMask( State stateMask )
{ 
    _stateMask = stateMask; 
500
}
501
inline KeyboardTranslator::State KeyboardTranslator::Entry::stateMask() const { return _stateMask; }
502

Stephan Binner's avatar
Stephan Binner committed
503
}
504

André Wöbbeking's avatar
André Wöbbeking committed
505
Q_DECLARE_METATYPE(Konsole::KeyboardTranslator::Entry)
506
507
508
Q_DECLARE_METATYPE(const Konsole::KeyboardTranslator*)

#endif // KEYBOARDTRANSLATOR_H
509