From ee5b7ecaa4337780d3c089ab0eeb955207370d1b Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Mon, 20 Jul 2020 17:33:29 +0530
Subject: [PATCH] Show highlights in the highlights panel sorted by start
 position in book

---
 src/calibre/gui2/viewer/highlights.py | 20 +++++++++++++++-----
 1 file changed, 15 insertions(+), 5 deletions(-)

diff --git a/src/calibre/gui2/viewer/highlights.py b/src/calibre/gui2/viewer/highlights.py
index 9a7e3eec2e..28f414eff9 100644
--- a/src/calibre/gui2/viewer/highlights.py
+++ b/src/calibre/gui2/viewer/highlights.py
@@ -11,6 +11,7 @@ from PyQt5.Qt import (
 )
 
 from calibre.constants import plugins
+from calibre.ebooks.epub.cfi.parse import cfi_sort_key
 from calibre.gui2 import error_dialog, question_dialog
 from calibre.gui2.library.annotations import Details
 from calibre.gui2.viewer.search import SearchInput
@@ -39,12 +40,21 @@ class Highlights(QListWidget):
     def load(self, highlights):
         self.clear()
         self.uuid_map = {}
-        for h in highlights or ():
+        highlights = (h for h in highlights if not h.get('removed') and h.get('highlighted_text'))
+        for h in self.sorted_highlights(highlights):
             txt = h.get('highlighted_text')
-            if not h.get('removed') and txt:
-                i = QListWidgetItem(txt, self)
-                i.setData(Qt.UserRole, h)
-                self.uuid_map[h['uuid']] = self.count() - 1
+            i = QListWidgetItem(txt, self)
+            i.setData(Qt.UserRole, h)
+            self.uuid_map[h['uuid']] = self.count() - 1
+
+    def sorted_highlights(self, highlights):
+        defval = 999999999999999, cfi_sort_key('/99999999')
+
+        def cfi_key(h):
+            cfi = h.get('start_cfi')
+            return (h.get('spine_index') or defval[0], cfi_sort_key(cfi)) if cfi else defval
+
+        return sorted(highlights, key=cfi_key)
 
     def refresh(self, highlights):
         h = self.current_highlight