summaryrefslogtreecommitdiff
path: root/indra/llui/lllineeditor.h
blob: 65afa54d04632e25bf2df2ec017920a74181e367 (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
/**
 * @file lllineeditor.h
 * @brief Text editor widget to let users enter/edit a single line.
 *
 * Features:
 *      Text entry of a single line (text, delete, left and right arrow, insert, return).
 *      Callbacks either on every keystroke or just on the return key.
 *      Focus (allow multiple text entry widgets)
 *      Clipboard (cut, copy, and paste)
 *      Horizontal scrolling to allow strings longer than widget size allows
 *      Pre-validation (limit which keys can be used)
 *      Optional line history so previous entries can be recalled by CTRL UP/DOWN
 *
 * $LicenseInfo:firstyear=2001&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, 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$
 */

#ifndef LL_LLLINEEDITOR_H
#define LL_LLLINEEDITOR_H

#include "v4color.h"
#include "llframetimer.h"

#include "lleditmenuhandler.h"
#include "llspellcheckmenuhandler.h"
#include "lluictrl.h"
#include "lluiimage.h"
#include "lluistring.h"
#include "llviewborder.h"

#include "llpreeditor.h"
#include "lltextvalidate.h"

class LLFontGL;
class LLLineEditorRollback;
class LLButton;
class LLContextMenu;

class LLLineEditor
: public LLUICtrl, public LLEditMenuHandler, protected LLPreeditor, public LLSpellCheckMenuHandler
{
public:

    typedef boost::function<void (LLLineEditor* caller)> keystroke_callback_t;

    struct MaxLength : public LLInitParam::ChoiceBlock<MaxLength>
    {
        Alternative<S32> bytes, chars;

        MaxLength() : bytes("max_length_bytes", 254),
                      chars("max_length_chars", 0)
        {}
    };

    struct Params : public LLInitParam::Block<Params, LLUICtrl::Params>
    {
        Optional<std::string>           default_text;
        Optional<MaxLength>             max_length;
        Optional<keystroke_callback_t>  keystroke_callback;

        Optional<LLTextValidate::validate_func_t, LLTextValidate::ValidateTextNamedFuncs>   prevalidate_callback;
        Optional<LLTextValidate::validate_func_t, LLTextValidate::ValidateTextNamedFuncs>   prevalidate_input_callback;

        Optional<LLViewBorder::Params>  border;

        Optional<LLUIImage*>            background_image,
                                        background_image_disabled,
                                        background_image_focused;

        Optional<bool>                  select_on_focus,
                                        revert_on_esc,
                                        spellcheck,
                                        commit_on_focus_lost,
                                        ignore_tab,
                                        bg_image_always_focused,
                                        show_label_focused,
                                        is_password,
                                        use_bg_color;

        // colors
        Optional<LLUIColor>             cursor_color,
                                        bg_color,
                                        text_color,
                                        text_readonly_color,
                                        text_tentative_color,
                                        highlight_color,
                                        preedit_bg_color;

        Optional<S32>                   text_pad_left,
                                        text_pad_right;

        Ignored                         bg_visible;

        Params();
    };

    void initFromParams(const LLLineEditor::Params& params);

protected:
    LLLineEditor(const Params&);
    friend class LLUICtrlFactory;
    friend class LLFloaterEditUI;
    void showContextMenu(S32 x, S32 y);

public:
    virtual ~LLLineEditor();

    // mousehandler overrides
    /*virtual*/ BOOL    handleMouseDown(S32 x, S32 y, MASK mask) override;
    /*virtual*/ BOOL    handleMouseUp(S32 x, S32 y, MASK mask) override;
    /*virtual*/ BOOL    handleHover(S32 x, S32 y, MASK mask) override;
    /*virtual*/ BOOL    handleDoubleClick(S32 x,S32 y,MASK mask) override;
    /*virtual*/ BOOL    handleMiddleMouseDown(S32 x,S32 y,MASK mask) override;
    /*virtual*/ BOOL    handleRightMouseDown(S32 x, S32 y, MASK mask) override;
    /*virtual*/ BOOL    handleKeyHere(KEY key, MASK mask) override;
    /*virtual*/ BOOL    handleUnicodeCharHere(llwchar uni_char) override;
    /*virtual*/ void    onMouseCaptureLost() override;

    // LLEditMenuHandler overrides
    /*virtual*/ void    cut() override;
    /*virtual*/ BOOL    canCut() const override;
    /*virtual*/ void    copy() override;
    /*virtual*/ BOOL    canCopy() const override;
    /*virtual*/ void    paste() override;
    /*virtual*/ BOOL    canPaste() const override;

    virtual void    updatePrimary();
    virtual void    copyPrimary();
    virtual void    pastePrimary();
    virtual BOOL    canPastePrimary() const;

    /*virtual*/ void    doDelete() override;
    /*virtual*/ BOOL    canDoDelete() const override;

    /*virtual*/ void    selectAll() override;
    /*virtual*/ BOOL    canSelectAll() const override;

    /*virtual*/ void    deselect() override;
    /*virtual*/ BOOL    canDeselect() const override;

    // LLSpellCheckMenuHandler overrides
    /*virtual*/ bool    getSpellCheck() const override;

    /*virtual*/ const std::string& getSuggestion(U32 index) const override;
    /*virtual*/ U32     getSuggestionCount() const override;
    /*virtual*/ void    replaceWithSuggestion(U32 index) override;

    /*virtual*/ void    addToDictionary() override;
    /*virtual*/ bool    canAddToDictionary() const override;

    /*virtual*/ void    addToIgnore() override;
    /*virtual*/ bool    canAddToIgnore() const override;

    // Spell checking helper functions
    std::string         getMisspelledWord(U32 pos) const;
    bool                isMisspelledWord(U32 pos) const;
    void                onSpellCheckSettingsChange();

    // view overrides
    /*virtual*/ const std::string getToolTip() const override;
    /*virtual*/ void    draw() override;
    /*virtual*/ void    reshape(S32 width, S32 height, BOOL called_from_parent = TRUE) override;
    /*virtual*/ void    onFocusReceived() override;
    /*virtual*/ void    onFocusLost() override;
    /*virtual*/ void    setEnabled(BOOL enabled) override;

    // UI control overrides
    /*virtual*/ void    clear() override;
    /*virtual*/ void    onTabInto() override;
    /*virtual*/ void    setFocus(BOOL b) override;
    /*virtual*/ void    setRect(const LLRect& rect) override;
    /*virtual*/ BOOL    acceptsTextInput() const override;
    /*virtual*/ void    onCommit() override;
    /*virtual*/ BOOL    isDirty() const override;   // Returns TRUE if user changed value at all
    /*virtual*/ void    resetDirty() override;      // Clear dirty state

    // assumes UTF8 text
    /*virtual*/ void    setValue(const LLSD& value) override;
    /*virtual*/ LLSD    getValue() const override;
    /*virtual*/ BOOL    setTextArg(const std::string& key, const LLStringExplicit& text) override;
    /*virtual*/ BOOL    setLabelArg(const std::string& key, const LLStringExplicit& text) override;

    void            setLabel(const LLStringExplicit &new_label) { mLabel = new_label; }
    const std::string&  getLabel()  { return mLabel.getString(); }

    void            setText(const LLStringExplicit &new_text);

    const std::string& getText() const      { return mText.getString(); }
    LLWString       getWText() const    { return mText.getWString(); }
    LLWString getConvertedText() const; // trimmed text with paragraphs converted to newlines

    S32             getLength() const   { return mText.length(); }

    S32             getCursor() const   { return mCursorPos; }
    void            setCursor( S32 pos );
    void            setCursorToEnd();

    // set scroll to earliest position it can reasonable set
    void            resetScrollPosition();

    // Selects characters 'start' to 'end'.
    void            setSelection(S32 start, S32 end);
    /*virtual*/ void    getSelectionRange(S32 *position, S32 *length) const override;

    void            setCommitOnFocusLost( BOOL b )  { mCommitOnFocusLost = b; }
    void            setRevertOnEsc( BOOL b )        { mRevertOnEsc = b; }
    void            setKeystrokeOnEsc(BOOL b)       { mKeystrokeOnEsc = b; }

    void setCursorColor(const LLColor4& c)          { mCursorColor = c; }
    const LLColor4& getCursorColor() const          { return mCursorColor.get(); }

    void setFgColor( const LLColor4& c )            { mFgColor = c; }
    void setReadOnlyFgColor( const LLColor4& c )    { mReadOnlyFgColor = c; }
    void setTentativeFgColor(const LLColor4& c)     { mTentativeFgColor = c; }

    const LLColor4& getFgColor() const          { return mFgColor.get(); }
    const LLColor4& getReadOnlyFgColor() const  { return mReadOnlyFgColor.get(); }
    const LLColor4& getTentativeFgColor() const { return mTentativeFgColor.get(); }

    const LLFontGL* getFont() const { return mGLFont; }
    void setFont(const LLFontGL* font);

    void            setIgnoreArrowKeys(BOOL b)      { mIgnoreArrowKeys = b; }
    void            setIgnoreTab(BOOL b)            { mIgnoreTab = b; }
    void            setPassDelete(BOOL b)           { mPassDelete = b; }
    void            setDrawAsterixes(BOOL b);

    // get the cursor position of the beginning/end of the prev/next word in the text
    S32             prevWordPos(S32 cursorPos) const;
    S32             nextWordPos(S32 cursorPos) const;

    BOOL            hasSelection() const { return (mSelectionStart != mSelectionEnd); }
    void            startSelection();
    void            endSelection();
    void            extendSelection(S32 new_cursor_pos);
    void            deleteSelection();

    void            setSelectAllonFocusReceived(BOOL b);
    void            setSelectAllonCommit(BOOL b) { mSelectAllonCommit = b; }

    void            onKeystroke();
    typedef boost::function<void (LLLineEditor* caller, void* user_data)> callback_t;
    void            setKeystrokeCallback(callback_t callback, void* user_data);

    void            setMaxTextLength(S32 max_text_length);
    void            setMaxTextChars(S32 max_text_chars);
    // Manipulate left and right padding for text
    void getTextPadding(S32 *left, S32 *right);
    void setTextPadding(S32 left, S32 right);

    // Prevalidation controls which keystrokes can affect the editor
    void            setPrevalidate( LLTextValidate::validate_func_t func );
    // This method sets callback that prevents from:
    // - deleting, selecting, typing, cutting, pasting characters that are not valid.
    // Also callback that this method sets differs from setPrevalidate in a way that it validates just inputed
    // symbols, before existing text is modified, but setPrevalidate validates line after it was modified.
    void            setPrevalidateInput(LLTextValidate::validate_func_t func);
    static BOOL     postvalidateFloat(const std::string &str);

    bool            prevalidateInput(const LLWString& wstr);
    BOOL            evaluateFloat();

    // line history support:
    void            setEnableLineHistory( BOOL enabled ) { mHaveHistory = enabled; } // switches line history on or off
    void            updateHistory(); // stores current line in history

    void            setReplaceNewlinesWithSpaces(BOOL replace);

    void            resetContextMenu() { setContextMenu(NULL); };

    void            setBgImage(LLPointer<LLUIImage> image) { mBgImage = image; }
    void            setBgImageFocused(LLPointer<LLUIImage> image) { mBgImageFocused = image; }

    void setShowContextMenu(bool show) { mShowContextMenu = show; }
    bool getShowContextMenu() const { return mShowContextMenu; }

  private:
    // private helper methods

    void                    pasteHelper(bool is_primary);

    void            removeChar();
    void            addChar(const llwchar c);
    void            setCursorAtLocalPos(S32 local_mouse_x);
    S32             findPixelNearestPos(S32 cursor_offset = 0) const;
    S32             calcCursorPos(S32 mouse_x);
    BOOL            handleSpecialKey(KEY key, MASK mask);
    BOOL            handleSelectionKey(KEY key, MASK mask);
    BOOL            handleControlKey(KEY key, MASK mask);
    S32             handleCommitKey(KEY key, MASK mask);
    void            updateTextPadding();

    // Draw the background image depending on enabled/focused state.
    void            drawBackground();

    //
    // private data members
    //
    void            updateAllowingLanguageInput();
    BOOL            hasPreeditString() const;
    // Implementation (overrides) of LLPreeditor
    /*virtual*/ void    resetPreedit() override;
    /*virtual*/ void    updatePreedit(const LLWString &preedit_string,
                        const segment_lengths_t &preedit_segment_lengths, const standouts_t &preedit_standouts, S32 caret_position) override;
    /*virtual*/ void    markAsPreedit(S32 position, S32 length) override;
    /*virtual*/ void    getPreeditRange(S32 *position, S32 *length) const override;
    /*virtual*/ BOOL    getPreeditLocation(S32 query_position, LLCoordGL *coord, LLRect *bounds, LLRect *control) const override;
    /*virtual*/ S32     getPreeditFontSize() const override;
    /*virtual*/ LLWString getPreeditString() const override { return getWText(); }

    void            setText(const LLStringExplicit &new_text, bool use_size_limit);

    void            setContextMenu(LLContextMenu* new_context_menu);

protected:
    LLUIString      mText;                  // The string being edited.
    std::string     mPrevText;              // Saved string for 'ESC' revert
    LLUIString      mLabel;                 // text label that is visible when no user text provided

    // line history support:
    BOOL        mHaveHistory;               // flag for enabled line history
    typedef std::vector<std::string>    line_history_t;
    line_history_t  mLineHistory;           // line history storage
    line_history_t::iterator    mCurrentHistoryLine;    // currently browsed history line

    LLViewBorder* mBorder;
    const LLFontGL* mGLFont;
    S32         mMaxLengthBytes;            // Max length of the UTF8 string in bytes
    S32         mMaxLengthChars;            // Maximum number of characters in the string
    S32         mCursorPos;                 // I-beam is just after the mCursorPos-th character.
    S32         mScrollHPos;                // Horizontal offset from the start of mText.  Used for scrolling.
    LLFrameTimer mScrollTimer;
    S32         mTextPadLeft;               // Used to reserve space before the beginning of the text for children.
    S32         mTextPadRight;              // Used to reserve space after the end of the text for children.
    S32         mTextLeftEdge;              // Pixels, cached left edge of text based on left padding and width
    S32         mTextRightEdge;             // Pixels, cached right edge of text based on right padding and width

    BOOL        mCommitOnFocusLost;
    BOOL        mRevertOnEsc;
    BOOL        mKeystrokeOnEsc;

    keystroke_callback_t mKeystrokeCallback;

    BOOL        mIsSelecting;               // Selection for clipboard operations
    S32         mSelectionStart;
    S32         mSelectionEnd;
    S32         mLastSelectionX;
    S32         mLastSelectionY;
    S32         mLastSelectionStart;
    S32         mLastSelectionEnd;

    bool        mSpellCheck;
    S32         mSpellCheckStart;
    S32         mSpellCheckEnd;
    LLTimer     mSpellCheckTimer;
    std::list<std::pair<U32, U32> > mMisspellRanges;
    std::vector<std::string>        mSuggestionList;

    LLTextValidate::validate_func_t mPrevalidateFunc;
    LLTextValidate::validate_func_t mPrevalidateInputFunc;

    LLFrameTimer mKeystrokeTimer;
    LLTimer     mTripleClickTimer;

    LLUIColor   mCursorColor;
    LLUIColor   mBgColor;
    LLUIColor   mFgColor;
    LLUIColor   mReadOnlyFgColor;
    LLUIColor   mTentativeFgColor;
    LLUIColor   mHighlightColor;        // background for selected text
    LLUIColor   mPreeditBgColor;        // preedit marker background color

    S32         mBorderThickness;

    BOOL        mIgnoreArrowKeys;
    BOOL        mIgnoreTab;
    BOOL        mDrawAsterixes;

    BOOL        mSelectAllonFocusReceived;
    BOOL        mSelectAllonCommit;
    BOOL        mPassDelete;

    BOOL        mReadOnly;

    BOOL        mShowImageFocused;
    BOOL        mShowLabelFocused;

    bool        mUseBgColor;

    LLWString   mPreeditWString;
    LLWString   mPreeditOverwrittenWString;
    std::vector<S32> mPreeditPositions;
    LLPreeditor::standouts_t mPreeditStandouts;

    LLHandle<LLContextMenu> mContextMenuHandle;

    bool mShowContextMenu;

private:
    // Instances that by default point to the statics but can be overidden in XML.
    LLPointer<LLUIImage> mBgImage;
    LLPointer<LLUIImage> mBgImageDisabled;
    LLPointer<LLUIImage> mBgImageFocused;

    BOOL        mReplaceNewlinesWithSpaces; // if false, will replace pasted newlines with paragraph symbol.

    // private helper class
    class LLLineEditorRollback
    {
    public:
        LLLineEditorRollback( LLLineEditor* ed )
            :
            mCursorPos( ed->mCursorPos ),
            mScrollHPos( ed->mScrollHPos ),
            mIsSelecting( ed->mIsSelecting ),
            mSelectionStart( ed->mSelectionStart ),
            mSelectionEnd( ed->mSelectionEnd )
        {
            mText = ed->getText();
        }

        void doRollback( LLLineEditor* ed )
        {
            ed->mCursorPos = mCursorPos;
            ed->mScrollHPos = mScrollHPos;
            ed->mIsSelecting = mIsSelecting;
            ed->mSelectionStart = mSelectionStart;
            ed->mSelectionEnd = mSelectionEnd;
            ed->mText = mText;
            ed->mPrevText = mText;
        }

        std::string getText()   { return mText; }

    private:
        std::string mText;
        S32     mCursorPos;
        S32     mScrollHPos;
        BOOL    mIsSelecting;
        S32     mSelectionStart;
        S32     mSelectionEnd;
    }; // end class LLLineEditorRollback

}; // end class LLLineEditor

// Build time optimization, generate once in .cpp file
#ifndef LLLINEEDITOR_CPP
extern template class LLLineEditor* LLView::getChild<class LLLineEditor>(
    const std::string& name, BOOL recurse) const;
#endif

#endif  // LL_LINEEDITOR_