[ci release] feature: add experimental color labels (#270)

This is work in progress. Allows to assign color labels to selected
text. For now there are 3 color labels: red, green and cyan.
Selected words can be colored with one of these labels using shortcuts:
`Ctrl+Shift+1/2/3`. All labels are cleared using shortcut `Ctrl+Shift+0`.

src/settings/include/shortcuts.h

@@ -84,6 +84,11 @@ struct ShortcutAction {
 
     static constexpr auto LogViewExitView = "logview.exit_view";
 
+    static constexpr auto LogViewAddColorLabel1 = "logview.add_color_label_1";
+    static constexpr auto LogViewAddColorLabel2 = "logview.add_color_label_2";
+    static constexpr auto LogViewAddColorLabel3 = "logview.add_color_label_3";
+    static constexpr auto LogViewClearColorLabels = "logview.clear_color_labels";
+
     static const std::map<std::string, QStringList>& defaultShortcuts();
 
     static QStringList defaultShortcuts( const std::string& action );

src/settings/include/styles.h

@@ -23,8 +23,6 @@
 #include <QStringList>
 #include <QLatin1String>
 
-#include "log.h"
-
 struct StyleManager {
 
     static constexpr QLatin1String DarkStyleKey = QLatin1String( "Dark", 4 );

src/settings/src/shortcuts.cpp

@@ -124,6 +124,11 @@ const std::map<std::string, QStringList>& ShortcutAction::defaultShortcuts()
         shortcuts.emplace( LogViewExitView, QStringList()
                                                 << QKeySequence( Qt::Key_Space ).toString() );
 
+        shortcuts.emplace( LogViewAddColorLabel1, QStringList() << "Ctrl+Shift+1" );
+        shortcuts.emplace( LogViewAddColorLabel2, QStringList() << "Ctrl+Shift+2" );
+        shortcuts.emplace( LogViewAddColorLabel3, QStringList() << "Ctrl+Shift+3" );
+        shortcuts.emplace( LogViewClearColorLabels, QStringList() << "Ctrl+Shift+0" );
+
         return shortcuts;
     }();
 
@@ -201,6 +206,11 @@ QString ShortcutAction::actionName( const std::string& action )
 
         shortcuts.emplace( LogViewExitView, "Release focus from view" );
 
+        shortcuts.emplace( LogViewAddColorLabel1, "Highlight selected text with color 1" );
+        shortcuts.emplace( LogViewAddColorLabel2, "Highlight selected text with color 2" );
+        shortcuts.emplace( LogViewAddColorLabel3, "Highlight selected text with color 3" );
+        shortcuts.emplace( LogViewClearColorLabels, "Clear all color labels" );
+
         return shortcuts;
     }();
 

src/ui/include/abstractlogview.h

@@ -40,12 +40,15 @@
 #ifndef ABSTRACTLOGVIEW_H
 #define ABSTRACTLOGVIEW_H
 
+#include <array>
 #include <functional>
+#include <qcolor.h>
 #include <string_view>
 
 #include <QAbstractScrollArea>
 #include <QBasicTimer>
 #include <QEvent>
+#include <vector>
 
 #ifdef GLOGG_PERF_MEASURE_FPS
 #include "perfcounter.h"
@@ -210,6 +213,10 @@ class AbstractLogView : public QAbstractScrollArea, public SearchableWidgetInter
     void allowFollowMode( bool allow );
 
     void setSearchPattern( const RegularExpressionPattern& pattern );
+
+    using WordsHighlighters = std::tuple<QStringList, QColor, QColor>;
+    void setWordsHighlighters( const std::vector<WordsHighlighters>& wordHighlighters );
+
     void registerShortcuts();
 
   protected:
@@ -381,8 +388,8 @@ class AbstractLogView : public QAbstractScrollArea, public SearchableWidgetInter
     OverviewWidget* overviewWidget_ = nullptr;
 
     struct FilePos {
-      LineNumber line;
-      int column;
+        LineNumber line;
+        int column;
     };
 
     bool selectionStarted_ = false;
@@ -403,6 +410,9 @@ class AbstractLogView : public QAbstractScrollArea, public SearchableWidgetInter
     Selection selection_;
     RegularExpressionPattern searchPattern_;
 
+
+    std::vector<WordsHighlighters> wordsHighlighters_;
+
     // Position of the view, those are crucial to control drawing
     // firstLine gives the position of the view,
     // lastLineAligned == true make the bottom of the last line aligned
@@ -476,7 +486,7 @@ class AbstractLogView : public QAbstractScrollArea, public SearchableWidgetInter
     int convertCoordToColumn( int xPos ) const;
 
     void displayLine( LineNumber line );
-    void moveSelection( LinesCount delta, bool isDeltaNegative  );
+    void moveSelection( LinesCount delta, bool isDeltaNegative );
     void moveSelectionUp();
     void moveSelectionDown();
     void jumpToStartOfLine();
@@ -497,7 +507,7 @@ class AbstractLogView : public QAbstractScrollArea, public SearchableWidgetInter
     void searchUsingFunction( QuickFindSearchFn searchFunction );
 
     void updateScrollBars();
-        
+
     LineNumber verticalScrollToLineNumber( int scrollPosition ) const;
     int lineNumberToVerticalScroll( LineNumber line ) const;
     double verticalScrollMultiplicator() const;

src/ui/include/crawlerwidget.h

@@ -387,6 +387,12 @@ class CrawlerWidget : public QSplitter,
 
     std::vector<LineNumber> savedMarkedLines_;
 
+    std::vector<AbstractLogView::WordsHighlighters> wordsHighlighters_ = {
+        { {}, {}, Qt::red },
+        { {}, {}, Qt::green },
+        { {}, {}, Qt::cyan },
+    };
+
     // Current encoding setting;
     std::optional<int> encodingMib_;
     QString encodingText_;

src/ui/src/abstractlogview.cpp

@@ -50,11 +50,13 @@
 #include <cstdint>
 #include <functional>
 #include <iostream>
+#include <iterator>
 #include <limits>
 #include <plog/Log.h>
 #include <qcoreevent.h>
 #include <qevent.h>
 #include <qglobal.h>
+#include <qnamespace.h>
 #include <string_view>
 #include <utility>
 
@@ -115,7 +117,7 @@ inline int countLeadingZeroes( uint64_t value )
 {
     unsigned long leading_zero = 0;
 
-    if ( _BitScanReverse( &leading_zero, static_cast<uint32_t>(value) ) ) {
+    if ( _BitScanReverse( &leading_zero, static_cast<uint32_t>( value ) ) ) {
         return 63ul - leading_zero;
     }
     else {
@@ -1010,6 +1012,13 @@ void AbstractLogView::setSearchPattern( const RegularExpressionPattern& pattern
     update();
 }
 
+void AbstractLogView::setWordsHighlighters( const std::vector<WordsHighlighters>& wordsHighlighters )
+{
+    wordsHighlighters_ = wordsHighlighters;
+    textAreaCache_.invalid_ = true;
+    update();
+}
+
 void AbstractLogView::followSet( bool checked )
 {
     followMode_ = checked;
@@ -1861,6 +1870,32 @@ void AbstractLogView::drawTextArea( QPaintDevice* paintDevice )
     const auto highlightPatternMatches = Configuration::get().mainSearchHighlight();
     const auto variateHighlightPatternMatches = Configuration::get().variateMainSearchHighlight();
 
+    std::optional<Highlighter> patternHighlight;
+    if ( highlightPatternMatches && !searchPattern_.isBoolean && !searchPattern_.isExclude
+         && !searchPattern_.pattern.isEmpty() ) {
+        patternHighlight = Highlighter{};
+        patternHighlight->setHighlightOnlyMatch( true );
+        patternHighlight->setVariateColors( variateHighlightPatternMatches );
+        patternHighlight->setPattern( searchPattern_.pattern );
+        patternHighlight->setIgnoreCase( !searchPattern_.isCaseSensitive );
+        patternHighlight->setUseRegex( !searchPattern_.isPlainText );
+
+        patternHighlight->setBackColor( mainSearchBackColor );
+        patternHighlight->setForeColor( Qt::black );
+    }
+
+    std::vector<Highlighter> additionalHighlighters;
+    for ( const auto& wordHighlighter : wordsHighlighters_ ) {
+        const auto& [ words, wordForeColor, wordBackColor ] = wordHighlighter;
+
+        std::transform( words.begin(), words.end(), std::back_inserter( additionalHighlighters ),
+                        [ wordForeColor, wordBackColor ]( const QString& word ) {
+                            Highlighter h{ word, false, true, wordForeColor, wordBackColor };
+                            h.setUseRegex( false );
+                            return h;
+                        } );
+    }
+
     // Then draw each line
     for ( auto currentLine = 0_lcount; currentLine < nbLines; ++currentLine ) {
         const auto lineNumber = firstLine_ + currentLine;
@@ -1893,25 +1928,20 @@ void AbstractLogView::drawTextArea( QPaintDevice* paintDevice )
 
                 backColor = palette.color( QPalette::Base );
             }
-        }
 
-        if ( highlightPatternMatches && !searchPattern_.isBoolean && !searchPattern_.isExclude
-             && !searchPattern_.pattern.isEmpty() ) {
-            Highlighter patternHighlight;
-            patternHighlight.setHighlightOnlyMatch( true );
-            patternHighlight.setVariateColors( variateHighlightPatternMatches );
-            patternHighlight.setPattern( searchPattern_.pattern );
-            patternHighlight.setIgnoreCase( !searchPattern_.isCaseSensitive );
-            patternHighlight.setUseRegex( !searchPattern_.isPlainText );
-
-            patternHighlight.setBackColor( mainSearchBackColor );
-            patternHighlight.setForeColor( Qt::black );
-
-            std::vector<HighlightedMatch> patternMatches;
-            patternHighlight.matchLine( logLine, patternMatches );
+            if ( patternHighlight ) {
+                std::vector<HighlightedMatch> patternMatches;
+                patternHighlight->matchLine( logLine, patternMatches );
+                highlighterMatches.insert( highlighterMatches.end(), patternMatches.begin(),
+                                           patternMatches.end() );
+            }
 
-            highlighterMatches.insert( highlighterMatches.end(), patternMatches.begin(),
-                                       patternMatches.end() );
+            for ( const auto& highlighter : additionalHighlighters ) {
+                std::vector<HighlightedMatch> patternMatches;
+                highlighter.matchLine( logLine, patternMatches );
+                highlighterMatches.insert( highlighterMatches.end(), patternMatches.begin(),
+                                           patternMatches.end() );
+            }
         }
 
         const auto untabifyHighlight = [ &logLine ]( const auto& match ) {

src/ui/src/crawlerwidget.cpp

@@ -1203,6 +1203,37 @@ void CrawlerWidget::registerShortcuts()
                                           }
                                       } );
 
+    const auto addColorLabelToSelection = [ this ]( size_t label ) {
+        std::get<0>( wordsHighlighters_[ label ] ).append( getSelectedText() );
+        logMainView_->setWordsHighlighters( wordsHighlighters_ );
+        filteredView_->setWordsHighlighters( wordsHighlighters_ );
+    };
+
+    ShortcutAction::registerShortcut(
+        configuredShortcuts, shortcuts_, this, Qt::WidgetWithChildrenShortcut,
+        ShortcutAction::LogViewAddColorLabel1,
+        [ addColorLabelToSelection ]() { addColorLabelToSelection( 0u ); } );
+
+    ShortcutAction::registerShortcut(
+        configuredShortcuts, shortcuts_, this, Qt::WidgetWithChildrenShortcut,
+        ShortcutAction::LogViewAddColorLabel2,
+        [ addColorLabelToSelection ]() { addColorLabelToSelection( 1u ); } );
+
+    ShortcutAction::registerShortcut(
+        configuredShortcuts, shortcuts_, this, Qt::WidgetWithChildrenShortcut,
+        ShortcutAction::LogViewAddColorLabel3,
+        [ addColorLabelToSelection ]() { addColorLabelToSelection( 2u ); } );
+
+    ShortcutAction::registerShortcut( configuredShortcuts, shortcuts_, this,
+                                      Qt::WidgetWithChildrenShortcut,
+                                      ShortcutAction::LogViewClearColorLabels, [ this ]() {
+                                          for ( auto& wordsHighlighters : wordsHighlighters_ ) {
+                                              std::get<0>( wordsHighlighters ).clear();
+                                          }
+                                          logMainView_->setWordsHighlighters( wordsHighlighters_ );
+                                          filteredView_->setWordsHighlighters( wordsHighlighters_ );
+                                      } );
+
     logMainView_->registerShortcuts();
     filteredView_->registerShortcuts();
 }