#5278 Move syntax tokenization off UI thread; apply results on main thread

4 files changed, 354 insertions, 62 deletions

diff --git a/indra/llui/llkeywords.cpp b/indra/llui/llkeywords.cpp
index 2168ba2382..0ada54df06 100644
--- a/indra/llui/llkeywords.cpp
+++ b/indra/llui/llkeywords.cpp
@@ -498,41 +498,25 @@ bool LLKeywords::WStringMapIndex::operator<(const LLKeywords::WStringMapIndex &o
 
 LLTrace::BlockTimerStatHandle FTM_SYNTAX_COLORING("Syntax Coloring");
 
-// Walk through a string, applying the rules specified by the keyword token list and
-// create a list of color segments.
-void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLWString& wtext, LLTextEditor& editor, LLStyleConstSP style)
+void LLKeywords::collectSegmentOps(segment_ops_t& ops, const LLWString& wtext, bool disable_syntax_highlighting) const
 {
-    LL_RECORD_BLOCK_TIME(FTM_SYNTAX_COLORING);
+    ops.clear();
 
-    if( wtext.empty() )
+    if (wtext.empty())
     {
         return;
     }
 
-    // Clear the segment list
-    seg_list->clear();
-    // Reserve capacity for segments based on an estimated average of 8 characters per segment.
-    constexpr size_t AVERAGE_SEGMENT_LENGTH = 8;
-    seg_list->reserve(wtext.size() / AVERAGE_SEGMENT_LENGTH);
-
-    S32 text_len = static_cast<S32>(wtext.size()) + 1;
-
-    seg_list->push_back( new LLNormalTextSegment( style, 0, text_len, editor ) );
-
-    static LLCachedControl<bool> sDisableSyntaxHighlighting(gSavedSettings, "ScriptEditorDisableSyntaxHighlight", false);
-    const bool disable_syntax_highlighting = sDisableSyntaxHighlighting;
-
     const llwchar* base = wtext.c_str();
     const llwchar* cur = base;
+
     while( *cur )
     {
         if( *cur == '\n' || cur == base )
         {
             if( *cur == '\n' )
             {
-                LLTextSegmentPtr text_segment = new LLLineBreakTextSegment(style, (S32)(cur - base));
-                text_segment->setToken( 0 );
-                insertSegment( *seg_list, text_segment, text_len, style, editor);
+                ops.push_back({SegmentOp::OP_LINE_BREAK, (S32)(cur - base), 0, nullptr});
                 cur++;
                 if( !*cur || *cur == '\n' )
                 {
@@ -570,8 +554,7 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                             }
                             S32 seg_end = (S32)(cur - base);
 
-                            //create segments from seg_start to seg_end
-                            insertSegments(wtext, *seg_list,cur_token, text_len, seg_start, seg_end, style, editor);
+                            ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, cur_token});
                             line_done = true; // to break out of second loop.
                             break;
                         }
@@ -646,7 +629,6 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                         if (*p == '[')
                         {
                             p++;  // skip the second [
-                            const llwchar* content_start = p;
 
                             // Build the closing pattern: ] + level equals + ]
                             // Search for it in the remaining text
@@ -667,7 +649,7 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                                         // Found the matching close
                                         seg_end = (S32)(close_check + 1 - base);
                                         cur = close_check + 1;
-                                        insertSegments(wtext, *seg_list, cur_delimiter, text_len, seg_start, seg_end, style, editor);
+                                        ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, cur_delimiter});
                                         break;
                                     }
                                 }
@@ -677,9 +659,9 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                             if (!*p)
                             {
                                 // No closing found, highlight to end of file
-                                seg_end = text_len - 1;
+                                seg_end = static_cast<S32>(wtext.size());
                                 cur = base + seg_end;
-                                insertSegments(wtext, *seg_list, cur_delimiter, text_len, seg_start, seg_end, style, editor);
+                                ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, cur_delimiter});
                             }
                             continue;
                         }
@@ -761,7 +743,7 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                         seg_end = seg_start + between_delimiters + cur_delimiter->getLengthHead();
                     }
 
-                    insertSegments(wtext, *seg_list, cur_delimiter, text_len, seg_start, seg_end, style, editor);
+                    ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, cur_delimiter});
                     // Note: we don't increment cur, since the end of one delimited seg may be immediately
                     // followed by the start of another one.
                     continue;
@@ -794,13 +776,12 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                     S32 seg_end = seg_start + seg_len;
 
                     // First try to match the whole token (including dots for Lua namespaces)
-                    word_token_map_t::iterator map_iter = mWordTokenMap.find(WStringMapIndex(word_start, seg_len));
+                    word_token_map_t::const_iterator map_iter = mWordTokenMap.find(WStringMapIndex(word_start, seg_len));
 
                     if (map_iter != mWordTokenMap.end())
                     {
                         // Found a match for the complete token (including any namespace)
-                        LLKeywordToken* cur_token = map_iter->second;
-                        insertSegments(wtext, *seg_list, cur_token, text_len, seg_start, seg_end, style, editor);
+                        ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, map_iter->second});
                     }
                     else if (namespace_dots > 0 && mLuauLanguage)
                     {
@@ -815,8 +796,7 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                             if (map_iter != mWordTokenMap.end())
                             {
                                 // Found a match for the namespace prefix, highlight just that part
-                                LLKeywordToken* cur_token = map_iter->second;
-                                insertSegments(wtext, *seg_list, cur_token, text_len, seg_start, seg_start + prefix_len, style, editor);
+                                ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_start + prefix_len, map_iter->second});
 
                                 // Now try to match the function part (after the dot)
                                 const llwchar* func_part = last_dot + 1;
@@ -830,13 +810,7 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
                                     if (map_iter != mWordTokenMap.end())
                                     {
                                         // Found a match for the function part
-                                        LLKeywordToken* cur_token = map_iter->second;
-                                        insertSegments(wtext, *seg_list, cur_token, text_len, seg_start, seg_end, style, editor);
-                                    }
-                                    else
-                                    {
-                                        // No token found, continue without incrementing cur
-                                        // since we already advanced it while collecting the word
+                                        ops.push_back({SegmentOp::OP_TOKEN, seg_start, seg_end, map_iter->second});
                                     }
                                 }
                             }
@@ -854,6 +828,61 @@ void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLW
     }
 }
 
+void LLKeywords::applySegmentOps(std::vector<LLTextSegmentPtr> *seg_list,
+                                 const LLWString& wtext,
+                                 const segment_ops_t& ops,
+                                 LLTextEditor& editor,
+                                 LLStyleConstSP style)
+{
+    if (wtext.empty())
+    {
+        return;
+    }
+
+    // Clear the segment list
+    seg_list->clear();
+    // Reserve capacity for segments based on an estimated average of 8 characters per segment.
+    constexpr size_t AVERAGE_SEGMENT_LENGTH = 8;
+    seg_list->reserve(wtext.size() / AVERAGE_SEGMENT_LENGTH);
+
+    S32 text_len = static_cast<S32>(wtext.size()) + 1;
+
+    seg_list->push_back( new LLNormalTextSegment( style, 0, text_len, editor ) );
+
+    for (const auto& op : ops)
+    {
+        if (op.type == SegmentOp::OP_LINE_BREAK)
+        {
+            LLTextSegmentPtr text_segment = new LLLineBreakTextSegment(style, op.start);
+            text_segment->setToken( 0 );
+            insertSegment( *seg_list, text_segment, text_len, style, editor);
+        }
+        else
+        {
+            insertSegments(wtext, *seg_list, op.token, text_len, op.start, op.end, style, editor);
+        }
+    }
+}
+
+// Walk through a string, applying the rules specified by the keyword token list and
+// create a list of color segments.
+void LLKeywords::findSegments(std::vector<LLTextSegmentPtr>* seg_list, const LLWString& wtext, LLTextEditor& editor, LLStyleConstSP style)
+{
+    LL_RECORD_BLOCK_TIME(FTM_SYNTAX_COLORING);
+
+    if( wtext.empty() )
+    {
+        return;
+    }
+
+    static LLCachedControl<bool> sDisableSyntaxHighlighting(gSavedSettings, "ScriptEditorDisableSyntaxHighlight", false);
+    const bool disable_syntax_highlighting = sDisableSyntaxHighlighting;
+
+    segment_ops_t ops;
+    collectSegmentOps(ops, wtext, disable_syntax_highlighting);
+    applySegmentOps(seg_list, wtext, ops, editor, style);
+}
+
 void LLKeywords::insertSegments(const LLWString& wtext, std::vector<LLTextSegmentPtr>& seg_list, LLKeywordToken* cur_token, S32 text_len, S32 seg_start, S32 seg_end, LLStyleConstSP style, LLTextEditor& editor )
 {
     std::string::size_type pos = wtext.find('\n',seg_start);
diff --git a/indra/llui/llkeywords.h b/indra/llui/llkeywords.h
index 3a02f0e68e..b8689a0e88 100644
--- a/indra/llui/llkeywords.h
+++ b/indra/llui/llkeywords.h
@@ -36,6 +36,7 @@
 #include <map>
 #include <list>
 #include <deque>
+#include <vector>
 #include "llpointer.h"
 
 class LLTextSegment;
@@ -124,6 +125,25 @@ public:
                              const LLWString& text,
                              class LLTextEditor& editor,
                              LLStyleConstSP style);
+    struct SegmentOp
+    {
+        enum EOpType
+        {
+            OP_LINE_BREAK,
+            OP_TOKEN
+        };
+        EOpType         type;
+        S32             start;
+        S32             end;
+        LLKeywordToken* token;
+    };
+    typedef std::vector<SegmentOp> segment_ops_t;
+    void        collectSegmentOps(segment_ops_t& ops, const LLWString& text, bool disable_syntax_highlighting) const;
+    void        applySegmentOps(std::vector<LLTextSegmentPtr> *seg_list,
+                                const LLWString& text,
+                                const segment_ops_t& ops,
+                                class LLTextEditor& editor,
+                                LLStyleConstSP style);
     void        initialize(LLSD SyntaxXML, bool luau_language = false);
     void        processTokens();
 
diff --git a/indra/newview/llscripteditor.cpp b/indra/newview/llscripteditor.cpp
index d171d785a7..871210ea6d 100644
--- a/indra/newview/llscripteditor.cpp
+++ b/indra/newview/llscripteditor.cpp
@@ -31,6 +31,173 @@
 #include "llsyntaxid.h"
 #include "lllocalcliprect.h"
 #include "llviewercontrol.h"
+#include "llworkerthread.h"
+#include <utility>
+
+static LLWorkerThread& getSyntaxWorkerThread()
+{
+    static LLWorkerThread* sThread = new LLWorkerThread("SyntaxParse", true);
+    return *sThread;
+}
+
+class LLScriptEditorSyntaxWorker final : public LLWorkerClass
+{
+public:
+    struct Request
+    {
+        LLWString       text;
+        S32             text_generation = 0;
+        U32             keywords_generation = 0;
+        bool            disable_highlight = false;
+        LLKeywords*     keywords = nullptr;
+    };
+
+    struct Result
+    {
+        LLWString                   text;
+        LLKeywords::segment_ops_t   ops;
+        S32                         text_generation = 0;
+        U32                         keywords_generation = 0;
+        bool                        disable_highlight = false;
+        LLKeywords*                 keywords = nullptr;
+    };
+
+    LLScriptEditorSyntaxWorker(LLWorkerThread* thread, LLScriptEditor* editor)
+    :   LLWorkerClass(thread, "ScriptEditorSyntax"),
+        mEditor(editor),
+        mHasPending(false),
+        mDropResults(false)
+    {
+    }
+
+    void queueRequest(const Request& request)
+    {
+        bool should_add = false;
+        {
+            LLMutexLock lock(&mRequestMutex);
+            mPendingRequest = request;
+            mHasPending = true;
+            should_add = (!haveWork() && !isWorking());
+        }
+        if (should_add)
+        {
+            addWork(0);
+        }
+    }
+
+    void pump()
+    {
+        checkWork();
+        bool should_add = false;
+        {
+            LLMutexLock lock(&mRequestMutex);
+            should_add = (!haveWork() && !isWorking() && mHasPending);
+        }
+        if (should_add)
+        {
+            addWork(0);
+        }
+    }
+
+    void waitForIdle(bool drop_results)
+    {
+        mDropResults = drop_results;
+        {
+            LLMutexLock lock(&mRequestMutex);
+            mHasPending = false;
+        }
+        if (mRequestHandle != LLWorkerThread::nullHandle())
+        {
+            mWorkerThread->waitForResult(mRequestHandle, false);
+            checkWork();
+        }
+        mDropResults = false;
+    }
+
+    void shutdown()
+    {
+        mEditor = nullptr;
+        waitForIdle(true);
+        scheduleDelete();
+    }
+
+private:
+    void startWork(S32 param) override
+    {
+        LLMutexLock lock(&mRequestMutex);
+        if (!mHasPending)
+        {
+            return;
+        }
+        mActiveRequest = mPendingRequest;
+        mHasPending = false;
+    }
+
+    bool doWork(S32 param) override
+    {
+        Request request;
+        {
+            LLMutexLock lock(&mRequestMutex);
+            request = mActiveRequest;
+        }
+
+        Result result;
+        result.text = request.text;
+        result.text_generation = request.text_generation;
+        result.keywords_generation = request.keywords_generation;
+        result.disable_highlight = request.disable_highlight;
+        result.keywords = request.keywords;
+
+        if (request.keywords)
+        {
+            request.keywords->collectSegmentOps(result.ops, request.text, request.disable_highlight);
+        }
+
+        {
+            LLMutexLock lock(&mResultMutex);
+            mResult = std::move(result);
+        }
+        return true;
+    }
+
+    void endWork(S32 param, bool aborted) override
+    {
+        if (aborted || mDropResults || !mEditor)
+        {
+            return;
+        }
+
+        Result result;
+        {
+            LLMutexLock lock(&mResultMutex);
+            result = std::move(mResult);
+        }
+
+        if (mEditor->getTextGeneration() != result.text_generation)
+        {
+            return;
+        }
+        if (mEditor->getKeywordsGeneration() != result.keywords_generation)
+        {
+            return;
+        }
+        if (&mEditor->getKeywords() != result.keywords)
+        {
+            return;
+        }
+
+        mEditor->applySyntaxSegments(result.text, result.ops);
+    }
+
+    LLScriptEditor* mEditor;
+    LLMutex mRequestMutex;
+    LLMutex mResultMutex;
+    Request mPendingRequest;
+    Request mActiveRequest;
+    Result mResult;
+    bool mHasPending;
+    bool mDropResults;
+};
 
 const S32   UI_TEXTEDITOR_LINE_NUMBER_MARGIN = 32;
 
@@ -46,7 +213,13 @@ LLScriptEditor::LLScriptEditor(const Params& p)
 :   LLTextEditor(p)
 ,   mShowLineNumbers(p.show_line_numbers),
     mUseDefaultFontSize(p.default_font_size),
-    mLuauLanguage(false)
+    mLuauLanguage(false),
+    mKeywordsGeneration(0),
+    mLastQueuedTextGeneration(-1),
+    mLastQueuedKeywordsGeneration(0),
+    mLastQueuedDisableHighlight(false),
+    mLastQueuedKeywords(nullptr),
+    mSyntaxWorker(nullptr)
 {
     if (mShowLineNumbers)
     {
@@ -55,6 +228,16 @@ LLScriptEditor::LLScriptEditor(const Params& p)
     }
 }
 
+LLScriptEditor::~LLScriptEditor()
+{
+    if (mSyntaxWorker)
+    {
+        mSyntaxWorker->shutdown();
+        getSyntaxWorkerThread().update(0.f);
+        mSyntaxWorker = nullptr;
+    }
+}
+
 bool LLScriptEditor::postBuild()
 {
     gSavedSettings.getControl("LSLFontSizeName")->getCommitSignal()->connect(boost::bind(&LLScriptEditor::onFontSizeChange, this));
@@ -154,43 +337,93 @@ void LLScriptEditor::initKeywords(bool luau_language)
 void LLScriptEditor::loadKeywords()
 {
     LL_PROFILE_ZONE_SCOPED;
+    ensureSyntaxWorker();
+    mSyntaxWorker->waitForIdle(true);
     getKeywords().processTokens();
+    ++mKeywordsGeneration;
 
-    LLStyleConstSP style = new LLStyle(LLStyle::Params().font(getScriptFont()).color(mDefaultColor.get()));
-
-    segment_vec_t segment_list;
-    getKeywords().findSegments(&segment_list, getWText(), *this, style);
-
-    mSegments.clear();
-    segment_set_t::iterator insert_it = mSegments.begin();
-    for (segment_vec_t::iterator list_it = segment_list.begin(); list_it != segment_list.end(); ++list_it)
+    LLKeywords::segment_ops_t ops;
+    const LLWString& text = getWText();
+    const llwchar* base = text.c_str();
+    for (const llwchar* cur = base; *cur; ++cur)
     {
-        insert_it = mSegments.insert(insert_it, *list_it);
+        if (*cur == '\n')
+        {
+            ops.push_back({LLKeywords::SegmentOp::OP_LINE_BREAK, (S32)(cur - base), 0, nullptr});
+        }
     }
+    applySyntaxSegments(text, ops);
+    queueSyntaxParse();
 }
 
 void LLScriptEditor::updateSegments()
 {
-    if (mReflowIndex < S32_MAX && getKeywords().isLoaded() && mParseOnTheFly)
+    if (getKeywords().isLoaded() && mParseOnTheFly)
     {
         LL_PROFILE_ZONE_SCOPED;
-
-        LLStyleConstSP style = new LLStyle(LLStyle::Params().font(getScriptFont()).color(mDefaultColor.get()));
-
-        // HACK:  No non-ascii keywords for now
-        segment_vec_t segment_list;
-        getKeywords().findSegments(&segment_list, getWText(), *this, style);
-
-        clearSegments();
-        for (segment_vec_t::iterator list_it = segment_list.begin(); list_it != segment_list.end(); ++list_it)
+        ensureSyntaxWorker();
+        mSyntaxWorker->pump();
+        if (mReflowIndex < S32_MAX)
         {
-            insertSegment(*list_it);
+            queueSyntaxParse();
         }
     }
 
     LLTextBase::updateSegments();
 }
 
+void LLScriptEditor::ensureSyntaxWorker()
+{
+    if (!mSyntaxWorker)
+    {
+        mSyntaxWorker = new LLScriptEditorSyntaxWorker(&getSyntaxWorkerThread(), this);
+    }
+}
+
+void LLScriptEditor::queueSyntaxParse()
+{
+    static LLCachedControl<bool> sDisableSyntaxHighlighting(gSavedSettings, "ScriptEditorDisableSyntaxHighlight", false);
+    const bool disable_syntax_highlighting = sDisableSyntaxHighlighting;
+
+    LLKeywords* keywords = &getKeywords();
+    const S32 text_generation = getTextGeneration();
+
+    if (mLastQueuedTextGeneration == text_generation
+        && mLastQueuedKeywordsGeneration == mKeywordsGeneration
+        && mLastQueuedDisableHighlight == disable_syntax_highlighting
+        && mLastQueuedKeywords == keywords)
+    {
+        return;
+    }
+
+    mLastQueuedTextGeneration = text_generation;
+    mLastQueuedKeywordsGeneration = mKeywordsGeneration;
+    mLastQueuedDisableHighlight = disable_syntax_highlighting;
+    mLastQueuedKeywords = keywords;
+
+    LLScriptEditorSyntaxWorker::Request request;
+    request.text = getWText();
+    request.text_generation = text_generation;
+    request.keywords_generation = mKeywordsGeneration;
+    request.disable_highlight = disable_syntax_highlighting;
+    request.keywords = keywords;
+    mSyntaxWorker->queueRequest(request);
+}
+
+void LLScriptEditor::applySyntaxSegments(const LLWString& text, const LLKeywords::segment_ops_t& ops)
+{
+    LLStyleConstSP style = new LLStyle(LLStyle::Params().font(getScriptFont()).color(mDefaultColor.get()));
+
+    segment_vec_t segment_list;
+    getKeywords().applySegmentOps(&segment_list, text, ops, *this, style);
+
+    clearSegments();
+    for (segment_vec_t::iterator list_it = segment_list.begin(); list_it != segment_list.end(); ++list_it)
+    {
+        insertSegment(*list_it);
+    }
+}
+
 void LLScriptEditor::clearSegments()
 {
     if (!mSegments.empty())
diff --git a/indra/newview/llscripteditor.h b/indra/newview/llscripteditor.h
index 2d98110f75..1ca26fbcc9 100644
--- a/indra/newview/llscripteditor.h
+++ b/indra/newview/llscripteditor.h
@@ -41,7 +41,7 @@ public:
         Params();
     };
 
-    ~LLScriptEditor() override {};
+    ~LLScriptEditor() override;
 
     // LLView override
     void    draw() override;
@@ -55,6 +55,8 @@ public:
     LLKeywords& getKeywords();
     bool    getIsLuauLanguage() { return mLuauLanguage; }
     void    setLuauLanguage(bool luau_language) { mLuauLanguage = luau_language; }
+    U32     getKeywordsGeneration() const { return mKeywordsGeneration; }
+    void    applySyntaxSegments(const LLWString& text, const LLKeywords::segment_ops_t& ops);
 
     static std::string getScriptFontSize();
     LLFontGL* getScriptFont();
@@ -68,6 +70,8 @@ private:
     void    drawLineNumbers();
     void  updateSegments() override;
     void  drawSelectionBackground() override;
+    void    ensureSyntaxWorker();
+    void    queueSyntaxParse();
 
     LLKeywords  mKeywordsLua;
     LLKeywords  mKeywordsLSL;
@@ -75,6 +79,12 @@ private:
 
     bool        mShowLineNumbers;
     bool mUseDefaultFontSize;
+    U32         mKeywordsGeneration;
+    S32         mLastQueuedTextGeneration;
+    U32         mLastQueuedKeywordsGeneration;
+    bool        mLastQueuedDisableHighlight;
+    LLKeywords* mLastQueuedKeywords;
+    class LLScriptEditorSyntaxWorker* mSyntaxWorker;
 };
 
 #endif // LL_SCRIPTEDITOR_H