add positions of hits to the range slider

In stage 1 we use a glob pattern matching the file name.
Stage 2 (which I will maybe implement some day) might use some additional magic byte sequence for file type detection.

requirements.txt

@@ -1,5 +1,5 @@
 pip==24.0
-PySide6_Essentials==6.6.2
+PySide6_Essentials==6.6.3
 setuptools==69.2.0
 watchdog==4.0.0
 pyinstaller==6.5.0

src/plugins/domain/menucontribution.py

@@ -55,9 +55,9 @@ def _new_recursive(current_action_id: str, items: [MenuContribution]) -> [MenuCo
     for item in items:
 
         mc: MenuContribution = item
-        print("%s checking %s" % (current_action_id, mc.action_id))
+        # print("%s checking %s" % (current_action_id, mc.action_id))
         if mc.after == current_action_id:
-            print("%s adding %s" % (current_action_id, mc.action_id))
+            #print("%s adding %s" % (current_action_id, mc.action_id))
             result.append(mc)
             result = result + _new_recursive(mc.action_id, items)
 
@@ -65,7 +65,7 @@ def _new_recursive(current_action_id: str, items: [MenuContribution]) -> [MenuCo
 
 
 def _recursive_half_order_adder(result: [MenuContribution], items: [MenuContribution]):
-    print("%s -- %s" % ([mc.action_id for mc in result], [mc.action_id for mc in items]))
+    #print("%s -- %s" % ([mc.action_id for mc in result], [mc.action_id for mc in items]))
     for item in items:
         mc: MenuContribution = item
         if mc.after:

src/plugins/logfile/filterwidget.py

@@ -38,7 +38,8 @@ class FilterTask(QRunnable):
             on_before: Callable[[], None],
             on_finish: Callable[[], None],
             show_only_matches: bool,
-            matches_separator: str
+            matches_separator: str,
+            zoned_plugin_registry: ZonedPluginRegistry
     ):
         super(FilterTask, self).__init__()
         self.source_model = source_model
@@ -53,6 +54,7 @@ class FilterTask(QRunnable):
         self.filter_match_found_listeners = filter_match_found_listeners
         self.show_only_matches = show_only_matches
         self.matches_separator = matches_separator
+        self.zoned_plugin_registry = zoned_plugin_registry
 
     def only_matches(self, line: str, regex: re.Pattern):
         result = ""
@@ -87,7 +89,10 @@ class FilterTask(QRunnable):
                 listener(-1, -1)  # notify listeners that a new search started
 
             hits_count = 0
+            hits_positions: set[float] = set(())
+            self.zoned_plugin_registry.execute("update_hit_positions", hits_positions)
             last_progress_report = time.time()
+            source_file_size = self.source_model.byte_count()
             try:
                 with open(self.source_model.get_file(), "rb") as source:
                     source.seek(self.source_model.range_start)
@@ -121,6 +126,12 @@ class FilterTask(QRunnable):
                                     target.write(line.encode("utf8"))
                                 hits_count = hits_count + 1
 
+                                hits_positions_before = len(hits_positions)
+                                hits_positions.add(round(source_line_offset / source_file_size, 3))
+                                hits_positions_after = len(hits_positions)
+                                if hits_positions_before != hits_positions_after:
+                                    self.zoned_plugin_registry.execute("update_hit_positions", hits_positions)
+
                             # sometime buffering can hide results for a while
                             # We force a flush periodically.
                             if line_count % 10000 == 0:
@@ -225,7 +236,7 @@ class FilterWidget(QWidget):
 
         (handle, self.tmp_filename) = tempfile.mkstemp()
         os.close(handle)
-        self.filter_model = LogFileModel(self.tmp_filename, self.source_model.settings)
+        self.filter_model = LogFileModel(self.tmp_filename, self.source_model.settings, source_model.get_file())
         self.hits_view = BigText(self.filter_model, show_range_slider=False)
 
         self.layout.addWidget(filter_bar)
@@ -350,6 +361,7 @@ class FilterWidget(QWidget):
             lambda: self.search_is_running.emit(True),
             lambda: self.search_is_running.emit(False),
             show_only_matches,
-            self.matches_separator.text()
+            self.matches_separator.text(),
+            self._zoned_plugin_registry
         )
         QThreadPool.globalInstance().start(self.filter_task)

src/plugins/logfile/fulltabwidget.py

@@ -1,6 +1,7 @@
 from PySide6.QtWidgets import *
 from PySide6.QtCore import *
 
+from src.pluginbase import PluginBase
 from src.ui.bigtext.bigtext import BigText
 from src.plugins.logfile.filterviewsyncer import FilterViewSyncer
 from src.plugins.logfile.filterwidget import FilterWidget
@@ -17,6 +18,7 @@ class FullTabWidget(Tab):
         self._model = model
         self._zoned_plugin_registry = zoned_plugin_registry
         self.file_view = BigText(model)
+        self._zoned_plugin_registry.register_plugin("TabWidgetPlugin", TabWidgetPlugin(self.file_view))
         self.filter_hit_view = FilterWidget(self._model, self._zoned_plugin_registry)
         self.filter_view_syncer = FilterViewSyncer(self.file_view)
         self.filter_hit_view.add_line_click_listener(self.filter_view_syncer.click_listener)
@@ -51,3 +53,12 @@ class FullTabWidget(Tab):
     # overriding abstract method
     def on_reveal(self):
         self.filter_hit_view.on_reveal()
+
+
+class TabWidgetPlugin(PluginBase):
+    def __init__(self, file_view: BigText):
+        super(TabWidgetPlugin, self).__init__()
+        self._file_view = file_view
+
+    def update_hit_positions(self, hit_positions: set[float]):
+        self._file_view.update_hit_positions(hit_positions)

src/ui/bigtext/bigtext.py

@@ -77,6 +77,7 @@ class BigText(QWidget):
     def __init__(self, model: LogFileModel, show_range_slider=True):
         super(BigText, self).__init__()
 
+        self.show_range_slider = show_range_slider
         self.model = model
 
         self.grid = QGridLayout()
@@ -87,10 +88,7 @@ class BigText(QWidget):
 
         self.v_scroll_bar = ScaledScrollBar()
 
-        self.range_limit = RangeSlider()
-        self.range_limit.value_changed.connect(self._range_limit_event)
-
-        self.big_text = InnerBigText(self, model, self.v_scroll_bar, self.range_limit)
+        self.big_text = InnerBigText(self, model, self.v_scroll_bar)
         self.big_text.setSizePolicy(QSizePolicy(QSizePolicy.Policy.Expanding, QSizePolicy.Policy.Expanding))
 
         self.h_scroll_bar = QScrollBar(Qt.Orientation.Horizontal)
@@ -102,9 +100,9 @@ class BigText(QWidget):
         self.v_scroll_bar.scaledValueChanged.connect(self.big_text.v_scroll_event)
         self.v_scroll_bar.scrolled_to_end.connect(self.big_text.v_scroll_update_follow_tail)
 
-
-
         if show_range_slider:
+            self.range_limit = RangeSlider()
+            self.range_limit.value_changed.connect(self._range_limit_event)
             self.grid.addWidget(self.range_limit, 0, 0)
         self.grid.addWidget(self.big_text, 0, 1)
         self.grid.addWidget(self.h_scroll_bar, 1, 1)
@@ -121,6 +119,10 @@ class BigText(QWidget):
     def get_file(self):
         return self.model.get_file()
 
+    def update_hit_positions(self, hit_positions: set[float]):
+        if self.range_limit:
+            self.range_limit.update_hit_positions(hit_positions)
+
     def add_line_click_listener(self, listener: Callable[[int], None]):
         """
         :param listener: a callable, the parameter is the byte offset of the clicked line
@@ -149,14 +151,12 @@ class InnerBigText(QWidget):
     _range_start = 0
     _range_end = -1
 
-    def __init__(self, parent: BigText, model: LogFileModel, v_scaled_scrollbar: ScaledScrollBar,
-                 range_limit: RangeSlider):
+    def __init__(self, parent: BigText, model: LogFileModel, v_scaled_scrollbar: ScaledScrollBar):
         super(InnerBigText, self).__init__()
         self.char_height = None
         self.char_width = None
         self.model = model
         self._v_scaled_scrollbar = v_scaled_scrollbar
-        self._range_limit = range_limit
         self.parent = parent
         self.setFocusPolicy(Qt.FocusPolicy.StrongFocus)
         self.setFocusPolicy(Qt.FocusPolicy.WheelFocus)
@@ -219,7 +219,6 @@ class InnerBigText(QWidget):
         elif e.modifiers() == Qt.KeyboardModifier.ControlModifier and e.key() == 65:  # ctrl + a
             self._select_all()
 
-
     def wheelEvent(self, event: QWheelEvent):
         direction = 1 if event.angleDelta().y() < 0 else -1
         if event.modifiers() == Qt.KeyboardModifier.ControlModifier:
@@ -262,6 +261,7 @@ class InnerBigText(QWidget):
         manage_highlighting.setShortcut("CTRL+H")
         menu.addAction(manage_highlighting)
 
+        if self.parent.show_range_slider:
             menu.addSeparator()
 
             set_range_start = QAction(
@@ -491,7 +491,7 @@ class InnerBigText(QWidget):
             (selected_file, _filter) = dialog.getSaveFileName(
                 parent=self,
                 caption=_("Save File"),
-                dir=os.path.dirname(self.model.get_file())
+                dir=os.path.dirname(self.model.get_original_file())
             )
             if selected_file:
                 self.model.write_range(start, end, selected_file)
@@ -559,6 +559,7 @@ class InnerBigText(QWidget):
         byte_count = self.model.byte_count()
         vmax = byte_count - 1 if self._range_end < 0 else min(self._range_end, self.model.byte_count() - 1)
         self.parent.v_scroll_bar.setMaximum(vmax)
+        if self.parent.show_range_slider:
             self.parent.range_limit.set_maximum(byte_count)
 
         for line in self.lines:

src/ui/bigtext/highlight_regex.py

@@ -1,3 +1,5 @@
+import fnmatch
+import glob
 from typing import Optional
 
 from src.ui.bigtext.highlight import Highlight
@@ -12,7 +14,7 @@ import re
 class HighlightRegex(Highlight):
 
     def __init__(self, query: str, ignore_case: bool, is_regex: bool, hit_background_color: str = "None",
-                 line_background_color: str = "None", active: bool = True):
+                 line_background_color: str = "None", active: bool = True, activated_for_file_type: str = "*"):
         self.active = active
         self.query = query
         self.ignore_case = ignore_case
@@ -20,6 +22,7 @@ class HighlightRegex(Highlight):
         self.regex = self._get_regex()
         self.hit_background_color = hit_background_color
         self.line_background_color = line_background_color
+        self.activated_for_file_type = activated_for_file_type
         self._brush_hit = self.brush(self.hit_background_color)
         self._brush_line = self.brush(self.line_background_color)
 
@@ -99,3 +102,15 @@ class HighlightRegex(Highlight):
             alpha = int(color[6:8], 16)
             return QBrush(QColor(red, green, blue, alpha))
         return QBrush()
+
+    def set_activated_for_file_type(self, activated_for_file_type: str):
+        self.activated_for_file_type = activated_for_file_type
+
+    def file_type_matches(self, file_name: str) -> bool:
+        if self.activated_for_file_type is None or len(self.activated_for_file_type) == 0:
+            return True
+        glob_patterns: [str] = self.activated_for_file_type.split(",")  # support multiple globs like: "*.txt, *.csv"
+        for glob_pattern in glob_patterns:
+            if fnmatch.fnmatch(file_name, glob_pattern.strip()):
+                return True
+        return False

src/ui/bigtext/highlighting.py

@@ -25,6 +25,7 @@ class Highlighting:
             is_regex = session.getboolean(section, "is-regex", fallback=False)
             line_background_color = session.get(section, "line.background.color", fallback="None")
             hit_background_color = session.get(section, "hit.background.color", fallback="None")
+            activated_for_file_type = session.get(section, "activated-for-file-type", fallback="*")
 
             try:
                 highlight = HighlightRegex(
@@ -33,7 +34,8 @@ class Highlighting:
                     is_regex=is_regex,
                     hit_background_color=hit_background_color,
                     line_background_color=line_background_color,
-                    active=active
+                    active=active,
+                    activated_for_file_type=activated_for_file_type
                 )
                 result.append(highlight)
             except:
@@ -57,6 +59,7 @@ class Highlighting:
             settings.session.set(section, "is-regex", str(highlighter.is_regex))
             settings.session.set(section, "line.background.color", highlighter.line_background_color)
             settings.session.set(section, "hit.background.color", highlighter.hit_background_color)
+            settings.session.set(section, "activated-for-file-type", highlighter.activated_for_file_type)
 
     @staticmethod
     def remove_highlighting_sections(settings: Settings):

src/ui/bigtext/logFileModel.py

@@ -21,21 +21,31 @@ class LogFileModel:
     range_start = 0
     range_end = -1
 
-    def __init__(self, file: str, settings: Settings):
+    def __init__(self, file: str, settings: Settings, original_file: str = False):
+        """
+        :param file:
+        :param settings:
+        :param original_file: used in the filter widget to denote the original file, the one being filtered, because 'file' points to the tmp file
+        """
         self.settings = settings
         self._file = os.path.realpath(file)
+        self._original_file = os.path.realpath(original_file) if original_file else self._file
+        self._file_name = os.path.basename(self._original_file)
 
     def highlighters(self):
         all_highlighters = Highlighting.read_config(self.settings)
         active_highlighters = []
         for h in all_highlighters:
-            if h.is_active():
+            if h.is_active() and h.file_type_matches(self._file_name):
                 active_highlighters.append(h)
         return active_highlighters
 
     def get_file(self):
         return self._file
 
+    def get_original_file(self):
+        return self._original_file
+
     def __str__(self):
         return self._file
 

src/ui/bigtext/newhighlightingdialog.py

@@ -118,7 +118,7 @@ class NewHighlightingDialog(QDialog):
 
     def _new_highlighter(self):
         highlight_regex = HighlightRegex("", ignore_case=True, is_regex=True, hit_background_color="ccb400",
-                                         line_background_color="fff080")
+                                         line_background_color="None")
         self._add_highlight_regex_to_list(highlight_regex, select=True)
 
 
@@ -139,7 +139,7 @@ class HighlightListItemWidget(QWidget):
         self.active = QCheckBox("")
         self.active.setChecked(highlight_regex.is_active())
         self.active.stateChanged.connect(self._change_active_state)
-        self.layout.addWidget(self.active, row, 0, 3, 1, alignment=QtCore.Qt.AlignmentFlag.AlignVCenter)
+        self.layout.addWidget(self.active, row, 0, 4, 1, alignment=QtCore.Qt.AlignmentFlag.AlignVCenter)
 
         query = QLineEdit(self)
         query.setText(highlight_regex.query)
@@ -181,6 +181,18 @@ class HighlightListItemWidget(QWidget):
         is_regex.setEnabled(highlight_regex.is_active())
         self.layout.addWidget(is_regex, row, 3)
 
+        row = row + 1
+        activated_for_file_type_label = QLabel(_("File Type:"), self)
+        activated_for_file_type_label.setEnabled(highlight_regex.is_active())
+        self.layout.addWidget(activated_for_file_type_label, row, 1)
+        activated_for_file_type = QLineEdit(self)
+        activated_for_file_type.setEnabled(highlight_regex.is_active())
+        activated_for_file_type.setText(highlight_regex.activated_for_file_type)
+        activated_for_file_type.textChanged[str].connect(
+            lambda: highlight_regex.set_activated_for_file_type(activated_for_file_type.text()))
+        self.layout.addWidget(activated_for_file_type, row, 2)
+
+
     def _change_active_state(self):
         active = self.active.isChecked()
         self.highlight_regex.set_active(active)

src/ui/rangeslider.py

@@ -4,7 +4,7 @@ from enum import Enum
 import PySide6
 from PySide6 import QtGui
 from PySide6.QtCore import QRect, QPoint, Signal
-from PySide6.QtGui import QPainter, Qt
+from PySide6.QtGui import QPainter, Qt, QColor, QPen
 from PySide6.QtWidgets import QWidget
 
 from src.pluginregistry import PluginRegistry
@@ -44,8 +44,6 @@ class RangeSlider(QWidget):
         super(RangeSlider, self).__init__()
         self.setFixedWidth(self._width)
 
-        self.draw_ticks = False
-
         self.min_value = 0
         self.max_value = 100
 
@@ -54,6 +52,8 @@ class RangeSlider(QWidget):
 
         self.selected_handle = None
         self.selection_drag_range = (self.min_value, self.max_value)
+        self.drag_y_offset_in_handle = 0
+        self._hit_positions: set[float] = set(())
 
     def set_maximum(self, max: int):
         if self.max_value == max:
@@ -66,14 +66,16 @@ class RangeSlider(QWidget):
             self.upper_value.value = max
             self._emit_value_changed()
 
+    def update_hit_positions(self, hit_positions: set[float]):
+        # print(f"updated hit positions in range slider:{len(hit_positions)} -> {hit_positions}")
+        self._hit_positions = hit_positions
+
     def paintEvent(self, event: PySide6.QtGui.QPaintEvent) -> None:
         painter = QPainter(self)
         self._draw_background(painter)
-        if self.draw_ticks:
-            self._draw_ticks(painter)
+        self._draw_hits(painter)
         self._draw_handle(painter, self.lower_value)
         self._draw_handle(painter, self.upper_value, direction=-1)
-
         painter.end()
 
     def _draw_background(self, painter: QPainter) -> None:
@@ -90,19 +92,6 @@ class RangeSlider(QWidget):
                      self._value_to_pixel(self.upper_value.value - self.lower_value.value) - 2 * self._handle_width)
         painter.drawRoundedRect(rect, 3.0, 3.0)
 
-    def _draw_ticks(self, painter: QPainter) -> None:
-        painter.setPen(to_qcolor("333333"))
-
-        min_tick_distance = 25
-        full_height = self.height() - 2 * self._handle_width
-        ticks = math.floor(full_height / min_tick_distance)
-        actual_tick_distance = full_height / ticks
-        print(f"ticks {ticks}")
-        y = actual_tick_distance + self._handle_width
-        while y < full_height:
-            painter.drawLine(8, y, 12, y)
-            y = y + actual_tick_distance
-
     def _draw_handle(self, painter: QPainter, handle: RangeSliderHandle, direction=1) -> None:
         y_pixel = self._value_to_pixel(handle.value)
 
@@ -127,6 +116,25 @@ class RangeSlider(QWidget):
         pixel = (self.height() - 2 * self._handle_width) * value_percent + self._handle_width
         return pixel
 
+    def _draw_hits(self, painter: QPainter) -> None:
+        color = to_qcolor("000000")
+        color.setAlpha(192)
+        pen = QPen(color)
+        pen.setWidth(1)
+        painter.setPen(pen)
+
+        # compute where to draw a line and then deduplicate then, so that we don't draw lines multiple times
+        # this is for performance and because we use transparency and drawing a line multiple times would make it
+        # darker
+        paint_at_y_positions: set[int] = set(())
+        for hit_position in self._hit_positions:
+            y = (self.height() - 2 * self._handle_width) * hit_position + self._handle_width
+            y = round(y)
+            paint_at_y_positions.add(y)
+
+        for y in paint_at_y_positions:
+            painter.drawLine(2, y, 18, y)
+
     def _pixel_to_value(self, pixel: int) -> int:
         pixel_percent = (pixel - self._handle_width) / (self.height() - 2 * self._handle_width)
         return int(math.floor(self.max_value * pixel_percent))
@@ -144,9 +152,11 @@ class RangeSlider(QWidget):
             if self._is_on_handle(self.lower_value, pos.y(), direction=1):
                 self.selected_handle = self.lower_value
                 self.selection_drag_range = (self.min_value, self.upper_value.value)
+                self.drag_y_offset_in_handle = self.selected_handle.value - self._pixel_to_value(pos.y())
             if self._is_on_handle(self.upper_value, pos.y(), direction=-1):
                 self.selected_handle = self.upper_value
                 self.selection_drag_range = (self.lower_value.value, self.max_value)
+                self.drag_y_offset_in_handle = self.selected_handle.value - self._pixel_to_value(pos.y())
 
     def mouseReleaseEvent(self, event: PySide6.QtGui.QMouseEvent) -> None:
         self.selected_handle = None
@@ -154,7 +164,7 @@ class RangeSlider(QWidget):
     def mouseMoveEvent(self, e: PySide6.QtGui.QMouseEvent) -> None:
         if self.selected_handle != None:
             pos: QPoint = e.pos()
-            value = self._pixel_to_value(pos.y())
+            value = self._pixel_to_value(pos.y()) + self.drag_y_offset_in_handle
             if self.selection_drag_range[0] <= value <= self.selection_drag_range[1]:
                 self.selected_handle.value = value
                 # print("%s, %s" %(self.lower_value.value, self.upper_value.value))

src/util/color.py

@@ -7,12 +7,22 @@ def is_hex_color(color: str):
     return re.match("[0-9a-f]{6}", color, flags=re.IGNORECASE)
 
 
+def is_hex_color_with_alpha(color: str):
+    return re.match("[0-9a-f]{8}", color, flags=re.IGNORECASE)
+
+
 def to_qcolor(color: str):
     if is_hex_color(color):
         red = int(color[0:2], 16)
         green = int(color[2:4], 16)
         blue = int(color[4:6], 16)
         return QColor(red, green, blue)
+    if is_hex_color_with_alpha(color):
+        red = int(color[0:2], 16)
+        green = int(color[2:4], 16)
+        blue = int(color[4:6], 16)
+        alpha = int(color[6:8], 16)
+        return QColor(red, green, blue, alpha)
     elif color in QColor().colorNames():
         return QColor(color)
     return QColor(255, 255, 255)