summaryrefslogtreecommitdiff
path: root/indra/newview/llkeyconflict.cpp
blob: be0b8fd4ca9f91050519e9386fda09bc91748102 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
83
84
85
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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
/** 
 * @file llkeyconflict.cpp
 * @brief 
 *
 * $LicenseInfo:firstyear=2019&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2019, Linden Research, Inc.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 * 
 * This library 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
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 * 
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

/*
 * App-wide preferences.  Note that these are not per-user,
 * because we need to load many preferences before we have
 * a login name.
 */

#include "llviewerprecompiledheaders.h"

#include "llkeyconflict.h"

#include "llinitparam.h"
#include "llkeyboard.h"
#include "llviewercontrol.h"
#include "llviewerkeyboard.h"
#include "llxuiparser.h"
//#include "llstring.h"

static const std::string typetostring[LLKeyConflictHandler::CONTROL_NUM_INDICES] = {
    "control_view_actions",
    "control_about",
    "control_orbit",
    "control_pan",
    "control_world_map",
    "control_zoom",
    "control_interactions",
    "control_build",
    //"control_drag",
    "control_edit",
    //"control_menu",
    "control_open",
    "control_touch",
    "control_wear",
    "control_movements",
    "control_moveto",
    "control_teleportto",
    "push_forward",
    "push_backward",
    "turn_left",
    "turn_right",
    "slide_left",
    "slide_right",
    "jump",
    "push_down",
    //"control_run",
    "toggle_run",
    "toggle_fly",
    "toggle_sit",
    "stop_moving",
    "control_camera",
    "look_up",
    "look_down",
    "move_forward",
    "move_backward",
    "move_forward_fast",
    "move_backward_fast",
    "move_forward_sitting",
    "move_backward_sitting",
    "spin_over",
    "spin_under",
    "spin_over_sitting",
    "spin_under_sitting",
    "pan_up",
    "pan_down",
    "pan_left",
    "pan_right",
    "pan_in",
    "pan_out",
    "spin_around_ccw",
    "spin_around_cw",
    "spin_around_ccw_sitting",
    "spin_around_cw_sitting",
    "control_edit_title",
    "edit_avatar_spin_ccw",
    "edit_avatar_spin_cw",
    "edit_avatar_spin_over",
    "edit_avatar_spin_under",
    "edit_avatar_move_forward",
    "edit_avatar_move_backward",
    "control_mediacontent",
    "toggle_pause_media",
    "toggle_enable_media",
    "control_voice",
    "control_toggle_voice",
    "start_chat",
    "start_gesture",
    "control_reserved",
    "control_delete",
    "control_menu",
    "control_reserved_select",
    "control_shift_select",
    "control_cntrl_select"
};

// note, a solution is needed that will keep this up to date with llviewerkeyboard
typedef std::map<std::string, LLKeyConflictHandler::EControlTypes> control_enum_t;
static const control_enum_t command_to_key =
{
    { "jump", LLKeyConflictHandler::CONTROL_JUMP },
    { "push_down", LLKeyConflictHandler::CONTROL_DOWN },
    { "push_forward", LLKeyConflictHandler::CONTROL_FORWARD },
    { "push_backward", LLKeyConflictHandler::CONTROL_BACKWARD },
    { "look_up", LLKeyConflictHandler::CONTROL_LOOK_UP },
    { "look_down", LLKeyConflictHandler::CONTROL_LOOK_DOWN },
    { "toggle_fly", LLKeyConflictHandler::CONTROL_TOGGLE_FLY },
    { "turn_left", LLKeyConflictHandler::CONTROL_LEFT },
    { "turn_right", LLKeyConflictHandler::CONTROL_RIGHT },
    { "slide_left", LLKeyConflictHandler::CONTROL_LSTRAFE },
    { "slide_right", LLKeyConflictHandler::CONTROL_RSTRAFE },
    { "spin_around_ccw", LLKeyConflictHandler::CONTROL_CAMERA_SPIN_CCW }, // todo, no idea what these spins are
    { "spin_around_cw", LLKeyConflictHandler::CONTROL_CAMERA_SPIN_CW },
    { "spin_around_ccw_sitting", LLKeyConflictHandler::CONTROL_CAMERA_SPIN_CCW_SITTING },
    { "spin_around_cw_sitting", LLKeyConflictHandler::CONTROL_CAMERA_SPIN_CCW_SITTING },
    { "spin_over", LLKeyConflictHandler::CONTROL_CAMERA_SOVER },
    { "spin_under", LLKeyConflictHandler::CONTROL_CAMERA_SUNDER },
    { "spin_over_sitting", LLKeyConflictHandler::CONTROL_CAMERA_SOVER_SITTING },
    { "spin_under_sitting", LLKeyConflictHandler::CONTROL_CAMERA_SUNDER_SITTING },
    { "move_forward", LLKeyConflictHandler::CONTROL_CAMERA_FORWARD },
    { "move_backward", LLKeyConflictHandler::CONTROL_CAMERA_BACKWARD },
    { "move_forward_sitting", LLKeyConflictHandler::CONTROL_CAMERA_FSITTING },
    { "move_backward_sitting", LLKeyConflictHandler::CONTROL_CAMERA_BSITTING },
    { "pan_up", LLKeyConflictHandler::CONTROL_CAMERA_PANUP },
    { "pan_down", LLKeyConflictHandler::CONTROL_CAMERA_PANDOWN },
    { "pan_left", LLKeyConflictHandler::CONTROL_CAMERA_PANLEFT },
    { "pan_right", LLKeyConflictHandler::CONTROL_CAMERA_PANRIGHT },
    { "pan_in", LLKeyConflictHandler::CONTROL_CAMERA_PANIN },
    { "pan_out", LLKeyConflictHandler::CONTROL_CAMERA_PANOUT },
    { "move_forward_fast", LLKeyConflictHandler::CONTROL_CAMERA_FFORWARD },
    { "move_backward_fast", LLKeyConflictHandler::CONTROL_CAMERA_FBACKWARD },
    { "edit_avatar_spin_ccw", LLKeyConflictHandler::CONTROL_EDIT_AV_SPIN_CCW },
    { "edit_avatar_spin_cw", LLKeyConflictHandler::CONTROL_EDIT_AV_SPIN_CW },
    { "edit_avatar_spin_over", LLKeyConflictHandler::CONTROL_EDIT_AV_SPIN_OVER },
    { "edit_avatar_spin_under", LLKeyConflictHandler::CONTROL_EDIT_AV_SPIN_UNDER },
    { "edit_avatar_move_forward", LLKeyConflictHandler::CONTROL_EDIT_AV_MV_FORWARD },
    { "edit_avatar_move_backward", LLKeyConflictHandler::CONTROL_EDIT_AV_MV_BACKWARD },
    { "stop_moving", LLKeyConflictHandler::CONTROL_STOP },
    { "start_chat", LLKeyConflictHandler::CONTROL_START_CHAT },
    { "start_gesture", LLKeyConflictHandler::CONTROL_START_GESTURE },
    { "toggle_run", LLKeyConflictHandler::CONTROL_TOGGLE_RUN },
    { "toggle_sit", LLKeyConflictHandler::CONTROL_SIT },
    { "toggle_parcel_media", LLKeyConflictHandler::CONTROL_PAUSE_MEDIA },
    { "toggle_enable_media", LLKeyConflictHandler::CONTROL_ENABLE_MEDIA }, 
};


// LLKeyboard::stringFromMask is meant for UI and is OS dependent,
// so this class uses it's own version
std::string string_from_mask(MASK mask)
{
    std::string res;
    if ((mask & MASK_CONTROL) != 0)
    {
        res = "CTL";
    }
    if ((mask & MASK_ALT) != 0)
    {
        if (!res.empty()) res += "_";
        res += "ALT";
    }
    if ((mask & MASK_SHIFT) != 0)
    {
        if (!res.empty()) res += "_";
        res += "SHIFT";
    }

    if (mask == MASK_NONE)
    {
        res = "NONE";
    }
    return res;
}

std::string string_from_mouse(EMouseClickType click)
{
    std::string res;
    switch (click)
    {
    case CLICK_LEFT:
        res = "LMB";
        break;
    case CLICK_MIDDLE:
        res = "MMB";
        break;
    case CLICK_RIGHT:
        res = "RMB";
        break;
    case CLICK_BUTTON4:
        res = "MB4";
        break;
    case CLICK_BUTTON5:
        res = "MB5";
        break;
    case CLICK_DOUBLELEFT:
        res = "Double LMB";
        break;
    default:
        break;
    }
    return res;
}

EMouseClickType mouse_from_string(const std::string& input)
{
    if (input == "LMB")
    {
        return CLICK_LEFT;
    }
    if (input == "MMB")
    {
        return CLICK_MIDDLE;
    }
    if (input == "RMB")
    {
        return CLICK_RIGHT;
    }
    if (input == "MB4")
    {
        return CLICK_BUTTON4;
    }
    if (input == "MB5")
    {
        return CLICK_BUTTON5;
    }
    return CLICK_NONE;
}

// LLKeyConflictHandler

LLKeyConflictHandler::LLKeyConflictHandler()
    : mHasUnsavedChanges(false)
{
    // todo: assign conflic priorities
    // todo: load from keys.xml?

    // Thise controls are meant to cause conflicts when user tries to assign same control somewhere else
    /*registerTemporaryControl(CONTROL_RESERVED_MENU, CLICK_RIGHT, KEY_NONE, MASK_NONE, 0);
    registerTemporaryControl(CONTROL_SHIFT_SELECT, CLICK_LEFT, KEY_NONE, MASK_SHIFT, 0);
    registerTemporaryControl(CONTROL_CNTRL_SELECT, CLICK_LEFT, KEY_NONE, MASK_CONTROL, 0);
    registerTemporaryControl(CONTROL_DELETE, CLICK_NONE, KEY_DELETE, MASK_NONE, 0);

    loadFromSettings();*/
}

LLKeyConflictHandler::LLKeyConflictHandler(EModes mode)
    : mHasUnsavedChanges(false),
    mLoadedMode(mode)
{
    loadFromSettings(mode);
}

bool LLKeyConflictHandler::canHandleControl(LLKeyConflictHandler::EControlTypes control_type, EMouseClickType mouse_ind, KEY key, MASK mask)
{
    return mControlsMap[control_type].canHandle(mouse_ind, key, mask);
}

bool LLKeyConflictHandler::canHandleKey(EControlTypes control_type, KEY key, MASK mask)
{
    return canHandleControl(control_type, CLICK_NONE, key, mask);
}

bool LLKeyConflictHandler::canHandleMouse(LLKeyConflictHandler::EControlTypes control_type, EMouseClickType mouse_ind, MASK mask)
{
    return canHandleControl(control_type, mouse_ind, KEY_NONE, mask);
}

bool LLKeyConflictHandler::canHandleMouse(EControlTypes control_type, S32 mouse_ind, MASK mask)
{
    return canHandleControl(control_type, (EMouseClickType)mouse_ind, KEY_NONE, mask);
}

bool LLKeyConflictHandler::canAssignControl(EControlTypes control_type)
{
    std::map<EControlTypes, LLKeyConflict>::iterator iter = mControlsMap.find(control_type);
    if (iter != mControlsMap.end())
    {
        return iter->second.mAssignable;
    }
    return false;
}

void LLKeyConflictHandler::registerControl(EControlTypes control_type, U32 index, EMouseClickType mouse, KEY key, MASK mask, bool ignore_mask)
{
    LLKeyConflict &type_data = mControlsMap[control_type];
    if (!type_data.mAssignable)
    {
        LL_ERRS() << "Error in code, user or system should not be able to change certain controls" << LL_ENDL;
    }
    type_data.mKeyBind.replaceKeyData(mouse, key, mask, ignore_mask, index);

    mHasUnsavedChanges = true;
}

LLKeyData LLKeyConflictHandler::getControl(EControlTypes control_type, U32 index)
{
    return mControlsMap[control_type].getKeyData(index);
}

// static
std::string LLKeyConflictHandler::getStringFromKeyData(const LLKeyData& keydata)
{
    std::string result;

    if (keydata.mMask != MASK_NONE && keydata.mKey != KEY_NONE)
    {
        result = LLKeyboard::stringFromAccelerator(keydata.mMask, keydata.mKey);
    }
    else if (keydata.mKey != KEY_NONE)
    {
        result = LLKeyboard::stringFromKey(keydata.mKey);
    }
    else if (keydata.mMask != MASK_NONE)
    {
        result = LLKeyboard::stringFromAccelerator(keydata.mMask);
    }

    result += string_from_mouse(keydata.mMouse);

    return result;
}

// static
std::string LLKeyConflictHandler::getControlName(EControlTypes control_type)
{
    return typetostring[control_type];
}

std::string LLKeyConflictHandler::getControlString(EControlTypes control_type, U32 index)
{
    return getStringFromKeyData(mControlsMap[control_type].getKeyData(index));
}

void  LLKeyConflictHandler::loadFromSettings(const LLViewerKeyboard::KeyMode& keymode, control_map_t *destination)
{
    for (LLInitParam::ParamIterator<LLViewerKeyboard::KeyBinding>::const_iterator it = keymode.bindings.begin(),
        end_it = keymode.bindings.end();
        it != end_it;
    ++it)
    {
        KEY key;
        MASK mask;
        EMouseClickType mouse = it->mouse.isProvided() ? mouse_from_string(it->mouse) : CLICK_NONE;
        bool ignore = it->ignore.isProvided() ? it->ignore.getValue() : false;
        if (it->key.getValue().empty())
        {
            key = KEY_NONE;
        }
        else
        {
            LLKeyboard::keyFromString(it->key, &key);
        }
        LLKeyboard::maskFromString(it->mask, &mask);
        std::string command_name = it->command;
        // it->command
        // It might be better to have <string,bind> map, but at the moment enum is easier to iterate through.
        // Besides keys.xml might not contain all commands
        control_enum_t::const_iterator iter = command_to_key.find(command_name);
        if (iter != command_to_key.end())
        {
            LLKeyConflict &type_data = (*destination)[iter->second];
            type_data.mAssignable = true;
            // Don't care about conflict level, all movement and view commands already account for it
            type_data.mKeyBind.addKeyData(mouse, key, mask, ignore);
        }
    }
}

void LLKeyConflictHandler::loadFromSettings(const EModes &load_mode, const std::string &filename, control_map_t *destination)
{
    if (filename.empty())
    {
        return;
    }

    LLViewerKeyboard::Keys keys;
    LLSimpleXUIParser parser;

    if (parser.readXUI(filename, keys)
        && keys.validateBlock())
    {
        switch (load_mode)
        {
        case MODE_FIRST_PERSON:
            if (keys.first_person.isProvided())
            {
                loadFromSettings(keys.first_person, destination);
            }
            break;
        case MODE_THIRD_PERSON:
            if (keys.third_person.isProvided())
            {
                loadFromSettings(keys.third_person, destination);
            }
            break;
        case MODE_EDIT:
            if (keys.edit.isProvided())
            {
                loadFromSettings(keys.edit, destination);
            }
            break;
        case MODE_EDIT_AVATAR:
            if (keys.edit_avatar.isProvided())
            {
                loadFromSettings(keys.edit_avatar, destination);
            }
            break;
        case MODE_SITTING:
            if (keys.sitting.isProvided())
            {
                loadFromSettings(keys.sitting, destination);
            }
            break;
        default:
            break;
        }
    }
}

void  LLKeyConflictHandler::loadFromSettings(EModes load_mode)
{
    mControlsMap.clear();
    mDefaultsMap.clear();

    // E.X. In case we need placeholder keys for conflict resolution.
    generatePlaceholders(load_mode);

    if (load_mode == MODE_GENERAL)
    {
        for (U32 i = 0; i < CONTROL_NUM_INDICES; i++)
        {
            EControlTypes type = (EControlTypes)i;
            switch (type)
            {
            case LLKeyConflictHandler::CONTROL_VIEW_ACTIONS:
            case LLKeyConflictHandler::CONTROL_INTERACTIONS:
            case LLKeyConflictHandler::CONTROL_MOVEMENTS:
            case LLKeyConflictHandler::CONTROL_MEDIACONTENT:
            case LLKeyConflictHandler::CONTROL_CAMERA:
            case LLKeyConflictHandler::CONTROL_EDIT_TITLE:
            case LLKeyConflictHandler::CONTROL_RESERVED:
                // ignore 'headers', they are for representation and organization purposes
                break;
            default:
                {
                    std::string name = getControlName(type);
                    LLControlVariablePtr var = gSavedSettings.getControl(name);
                    if (var)
                    {
                        LLKeyBind bind(var->getValue());
                        LLKeyConflict key(bind, true, 0);
                        mControlsMap[type] = key;
                    }
                    break;
                }
            }
        }
    }
    else
    {
        // load defaults
        std::string filename = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, "keys.xml");
        loadFromSettings(load_mode, filename, &mDefaultsMap);

        // load user's
        filename = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, "keys.xml");
        if (gDirUtilp->fileExists(filename))
        {
            loadFromSettings(load_mode, filename, &mControlsMap);
        }
        else
        {
            // mind placeholders
            mControlsMap.insert(mDefaultsMap.begin(), mDefaultsMap.end());
        }
    }
    mLoadedMode = load_mode;
}

void  LLKeyConflictHandler::saveToSettings()
{
    if (mControlsMap.empty())
    {
        return;
    }

    if (mLoadedMode == MODE_GENERAL)
    {
        for (U32 i = 0; i < CONTROL_NUM_INDICES; i++)
        {
            EControlTypes type = (EControlTypes)i;
            switch (type)
            {
            case LLKeyConflictHandler::CONTROL_VIEW_ACTIONS:
            case LLKeyConflictHandler::CONTROL_INTERACTIONS:
            case LLKeyConflictHandler::CONTROL_MOVEMENTS:
            case LLKeyConflictHandler::CONTROL_MEDIACONTENT:
            case LLKeyConflictHandler::CONTROL_CAMERA:
            case LLKeyConflictHandler::CONTROL_EDIT_TITLE:
            case LLKeyConflictHandler::CONTROL_RESERVED:
                // ignore 'headers', they are for representation and organization purposes
                break;
            default:
            {
                if (mControlsMap[type].mAssignable)
                {
                    std::string name = getControlName(type);
                    if (gSavedSettings.controlExists(name))
                    {
                        gSavedSettings.setLLSD(name, mControlsMap[type].mKeyBind.asLLSD());
                    }
                    else if (!mControlsMap[type].mKeyBind.empty())
                    {
                        // shouldn't happen user side since all settings are supposed to be declared already, but handy when creating new ones
                        // (just don't forget to change comment and to copy them from user's folder)
                        LL_INFOS() << "Creating new keybinding " << name << LL_ENDL;
                        gSavedSettings.declareLLSD(name, mControlsMap[type].mKeyBind.asLLSD(), "comment", LLControlVariable::PERSIST_ALWAYS);
                    }
                }
                break;
            }
            }
        }
    }
    else
    {
        // loaded full copy of original file
        std::string filename = gDirUtilp->findFile("keys.xml",
            gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, ""),
            gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, ""));

        LLViewerKeyboard::Keys keys;
        LLSimpleXUIParser parser;

        if (parser.readXUI(filename, keys)
            && keys.validateBlock())
        {
            // replace category we edited

            // todo: fix this
            // workaround to avoid doing own param container 
            LLViewerKeyboard::KeyMode mode;
            LLViewerKeyboard::KeyBinding binding;

            control_map_t::iterator iter = mControlsMap.begin();
            control_map_t::iterator end = mControlsMap.end();
            for (; iter != end; ++iter)
            {
                U32 size = iter->second.mKeyBind.getDataCount();
                for (U32 i = 0; i < size; ++i)
                {
                    // Still write empty keys to make sure we will maintain UI position
                    LLKeyData data = iter->second.mKeyBind.getKeyData(i);
                    if (data.mKey == KEY_NONE)
                    {
                        binding.key = "";
                    }
                    else
                    {
                        // Note: this is UI string, we might want to hardcode our own for 'fixed' use in keys.xml
                        binding.key = LLKeyboard::stringFromKey(data.mKey);
                    }
                    binding.mask = string_from_mask(data.mMask);
                    binding.mouse.set(string_from_mouse(data.mMouse), true); //set() because 'optional', for compatibility purposes
                    binding.ignore.set(data.mIgnoreMasks, true);
                    binding.command = getControlName(iter->first);
                    mode.bindings.add(binding);
                }
            }

            switch (mLoadedMode)
            {
            case MODE_FIRST_PERSON:
                if (keys.first_person.isProvided())
                {
                    keys.first_person.bindings.set(mode.bindings, true);
                }
                break;
            case MODE_THIRD_PERSON:
                if (keys.third_person.isProvided())
                {
                    keys.third_person.bindings.set(mode.bindings, true);
                }
                break;
            case MODE_EDIT:
                if (keys.edit.isProvided())
                {
                    keys.edit.bindings.set(mode.bindings, true);
                }
                break;
            case MODE_EDIT_AVATAR:
                if (keys.edit_avatar.isProvided())
                {
                    keys.edit_avatar.bindings.set(mode.bindings, true);
                }
                break;
            case MODE_SITTING:
                if (keys.sitting.isProvided())
                {
                    keys.sitting.bindings.set(mode.bindings, true);
                }
                break;
            default:
                break;
            }

            // write back to user's xml;
            std::string filename = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, "keys.xml");

            LLXMLNodePtr output_node = new LLXMLNode("keys", false);
            LLXUIParser parser;
            parser.writeXUI(output_node, keys);

            // Write the resulting XML to file
            if (!output_node->isNull())
            {
                LLFILE *fp = LLFile::fopen(filename, "w");
                if (fp != NULL)
                {
                    LLXMLNode::writeHeaderToFile(fp);
                    output_node->writeToFile(fp);
                    fclose(fp);
                }
            }
            // Now force a rebind for keyboard
            if (gDirUtilp->fileExists(filename))
            {
                gViewerKeyboard.loadBindingsXML(filename);
            }
        }
    }
    mHasUnsavedChanges = false;
}

LLKeyData LLKeyConflictHandler::getDefaultControl(EControlTypes control_type, U32 index)
{
    if (mLoadedMode == MODE_GENERAL)
    {
        std::string name = getControlName(control_type);
        LLControlVariablePtr var = gSavedSettings.getControl(name);
        if (var)
        {
            return LLKeyBind(var->getDefault()).getKeyData(index);
        }
        return LLKeyData();
    }
    else
    {
        control_map_t::iterator iter = mDefaultsMap.find(control_type);
        if (iter != mDefaultsMap.end())
        {
            return iter->second.mKeyBind.getKeyData(index);
        }
        return LLKeyData();
    }
}

void LLKeyConflictHandler::resetToDefault(EControlTypes control_type, U32 index)
{
    LLKeyData data = getDefaultControl(control_type, index);
    mControlsMap[control_type].setKeyData(data, index);
}

void LLKeyConflictHandler::resetToDefault(EControlTypes control_type)
{
    if (mLoadedMode == MODE_GENERAL)
    {
        std::string name = getControlName(control_type);
        LLControlVariablePtr var = gSavedSettings.getControl(name);
        if (var)
        {
            mControlsMap[control_type].mKeyBind = LLKeyBind(var->getDefault());
        }
        else
        {
            mControlsMap[control_type].mKeyBind.clear();
        }
    }
    else
    {
        control_map_t::iterator iter = mDefaultsMap.find(control_type);
        if (iter != mDefaultsMap.end())
        {
            mControlsMap[control_type].mKeyBind = iter->second.mKeyBind;
        }
        else
        {
            mControlsMap[control_type].mKeyBind.clear();
        }
    }
}

void LLKeyConflictHandler::resetToDefaults(EModes mode)
{
    if (mode == MODE_GENERAL)
    {
        for (U32 i = 0; i < CONTROL_NUM_INDICES; i++)
        {
            EControlTypes type = (EControlTypes)i;
            switch (type)
            {
            case LLKeyConflictHandler::CONTROL_VIEW_ACTIONS:
            case LLKeyConflictHandler::CONTROL_INTERACTIONS:
            case LLKeyConflictHandler::CONTROL_MOVEMENTS:
            case LLKeyConflictHandler::CONTROL_MEDIACONTENT:
            case LLKeyConflictHandler::CONTROL_CAMERA:
            case LLKeyConflictHandler::CONTROL_EDIT_TITLE:
            case LLKeyConflictHandler::CONTROL_RESERVED:
                // ignore 'headers', they are for representation and organization purposes
                break;
            default:
            {
                resetToDefault(type);
                break;
            }
            }
        }
    }
    else
    {
        mControlsMap.clear();
        generatePlaceholders(mode);
        mControlsMap.insert(mDefaultsMap.begin(), mDefaultsMap.end());
    }

    mHasUnsavedChanges = true;
}

void LLKeyConflictHandler::resetToDefaults()
{
    if (!empty())
    {
        resetToDefaults(mLoadedMode);
    }
}

void LLKeyConflictHandler::resetAllToDefaults()
{
    std::string filename = gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, "keys.xml");
    if (gDirUtilp->fileExists(filename))
    {
        LLFile::remove(filename);
        std::string filename = gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, "keys.xml");
        gViewerKeyboard.loadBindingsXML(filename);
    }

    for (U32 i = 0; i < CONTROL_NUM_INDICES; i++)
    {
        EControlTypes type = (EControlTypes)i;
        switch (type)
        {
        case LLKeyConflictHandler::CONTROL_VIEW_ACTIONS:
        case LLKeyConflictHandler::CONTROL_INTERACTIONS:
        case LLKeyConflictHandler::CONTROL_MOVEMENTS:
        case LLKeyConflictHandler::CONTROL_MEDIACONTENT:
        case LLKeyConflictHandler::CONTROL_RESERVED:
            // ignore 'headers', they are for representation and organization purposes
            break;
        default:
            {
                resetToDefault(type);
                break;
            }
        }
    }
    mHasUnsavedChanges = false;
}

void LLKeyConflictHandler::clear()
{
    mHasUnsavedChanges = false;
    mControlsMap.clear();
    mDefaultsMap.clear();
}

void LLKeyConflictHandler::resetKeyboardBindings()
{
    std::string filename = gDirUtilp->findFile("keys.xml",
        gDirUtilp->getExpandedFilename(LL_PATH_USER_SETTINGS, ""),
        gDirUtilp->getExpandedFilename(LL_PATH_APP_SETTINGS, ""));
    
    gViewerKeyboard.loadBindingsXML(filename);
}

void LLKeyConflictHandler::generatePlaceholders(EModes load_mode)
{

}

void LLKeyConflictHandler::registerTemporaryControl(EControlTypes control_type, EMouseClickType mouse, KEY key, MASK mask, U32 conflict_mask)
{
    LLKeyConflict *type_data = &mControlsMap[control_type];
    type_data->mAssignable = false;
    type_data->mConflictMask = conflict_mask;
    type_data->mKeyBind.addKeyData(mouse, key, mask, false);
}