summaryrefslogtreecommitdiff
path: root/src/navigator.c
blob: 38f02b1af5505406b77f5acbecac0227344f5b5d (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
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
/*:*
 * ggaze — directory navigator
 *
 * GObject (no GtkWidget) holding the current folder listing: filter to
 * image MIME, sort (name/time/size), cursor + path-based marks, GFileMonitor
 * with debounce, nearest-fallback on current-file removal. Emits "changed".
 *
 * Copyright (c) 2026 ggaze contributors
 * SPDX-License-Identifier: GPL-3.0-or-later
 *:*/

#include "navigator.h"

#include <gio/gio.h>
#include <glib-object.h>
#include <glib.h>
#include <string.h>

/* Extensions (lowercase, no dot). */
static const char *IMAGE_EXTS[] = {"jpg",  "jpeg", "png", "gif", "webp",
                                   "tif",  "tiff", "ico", "jxl", "avif",
                                   "heif", "heic", "bmp", "svg", NULL};
static const char *RAW_EXTS[]   = {"raf", "cr2", "cr3", "nef", "arw",
                                   "dng", "orf", "rw2", "pef", "srw",
                                   "3fr", "x3f", NULL};

#define GGAZE_DEFAULT_DEBOUNCE_MS 250

typedef struct {
   GFile *file; /* owned ref */
   gchar *name; /* owned (basename) */
   gint64 mtime;
   gint64 size;
} Entry;

struct _Navigator {
   GObject     parent_instance;
   GFile      *p_dir;     /* owned */
   GPtrArray  *p_files;   /* GFile* (owned refs), sorted/filtered */
   gint        i_current; /* -1 if empty */
   GgazeSort   e_sort;
   gboolean    b_wrap;
   gboolean    b_hide_raw;
   GHashTable *p_marks;   /* GFile* (owned refs) -> presence */
   GHashTable *p_removed; /* GFile* (owned refs): trashed/deleted, dimmed */
   GFile *p_last_mark;    /* anchor for `V` range-mark (owned ref, NULL=none) */
   GFileMonitor *p_monitor;
   guint         u_debounce_ms;
   guint         u_debounce_id; /* 0 = none pending */
};

G_DEFINE_TYPE(Navigator, navigator, G_TYPE_OBJECT)

static guint u_changed_signal = 0;

/* --- helpers -------------------------------------------------------------- */

static const char *
_ext_of(const char *c_name) {
   const char *c_dot = strrchr(c_name, '.');
   if (c_dot == NULL || c_dot == c_name) {
      return (NULL);
   }
   return (c_dot + 1);
}

static gboolean
_str_in_set(const char *c_s, const char **set) {
   if (c_s == NULL) {
      return (FALSE);
   }
   for (gsize u_i = 0; set[u_i] != NULL; u_i++) {
      if (g_ascii_strcasecmp(c_s, set[u_i]) == 0) {
         return (TRUE);
      }
   }
   return (FALSE);
}

static gboolean
_is_raw_ext(const char *c_ext) {
   return (_str_in_set(c_ext, RAW_EXTS));
}

static gboolean
_is_image_file(const char *c_name, const char *c_ct) {
   if (c_ct != NULL && g_str_has_prefix(c_ct, "image/")) {
      return (TRUE);
   }
   const char *c_ext = _ext_of(c_name);
   return (_str_in_set(c_ext, IMAGE_EXTS) || _str_in_set(c_ext, RAW_EXTS));
}

static gboolean
_is_jpeg_ext(const char *c_ext) {
   return (c_ext != NULL && (g_ascii_strcasecmp(c_ext, "jpg") == 0 ||
                             g_ascii_strcasecmp(c_ext, "jpeg") == 0));
}

/* Owned stem (basename without extension, lowercased for compare). */
static char *
_stem_lower(const char *c_name) {
   const char *c_dot = strrchr(c_name, '.');
   gsize u_len  = (c_dot != NULL && c_dot != c_name) ? (gsize)(c_dot - c_name)
                                                     : strlen(c_name);
   char *c_stem = g_strndup(c_name, u_len);
   for (char *p = c_stem; *p != '\0'; p++) {
      *p = (char)g_ascii_tolower((gint)*p);
   }
   return (c_stem);
}

static void
_entry_free(gpointer p_void) {
   Entry *p_e = (Entry *)p_void;
   g_clear_object(&p_e->file);
   g_free(p_e->name);
   g_free(p_e);
}

static gint
_compare_entries(gconstpointer p_a, gconstpointer p_b, gpointer p_data) {
   const Entry *p_ea   = *(Entry *const *)p_a;
   const Entry *p_eb   = *(Entry *const *)p_b;
   GgazeSort    e_sort = (GgazeSort)GPOINTER_TO_INT(p_data);

   switch (e_sort) {
   case GGAZE_SORT_TIME:
      if (p_ea->mtime < p_eb->mtime) {
         return (-1);
      }
      if (p_ea->mtime > p_eb->mtime) {
         return (1);
      }
      break;
   case GGAZE_SORT_SIZE:
      if (p_ea->size < p_eb->size) {
         return (-1);
      }
      if (p_ea->size > p_eb->size) {
         return (1);
      }
      break;
   case GGAZE_SORT_NAME:
   default:
      break;
   }
   /* Tie-break (and the NAME case) by collated basename. */
   return (g_utf8_collate(p_ea->name, p_eb->name));
}

static gint
_find_index_by_file(Navigator *p_nav, GFile *p_file) {
   if (p_file == NULL) {
      return (-1);
   }
   for (guint u_i = 0; u_i < p_nav->p_files->len; u_i++) {
      if (g_file_equal(p_file,
                       (GFile *)g_ptr_array_index(p_nav->p_files, u_i))) {
         return ((gint)u_i);
      }
   }
   return (-1);
}

/* Re-read the directory, filter, hide-raw, sort, and commit; keep the current
 * file by path, falling back to the nearest by position if it is gone. */
static void
_relist(Navigator *p_nav) {
   GError          *p_err  = NULL;
   GFileEnumerator *p_enum = g_file_enumerate_children(
      p_nav->p_dir,
      "standard::name,standard::type,standard::content-type,"
      "time::modified,standard::size",
      G_FILE_QUERY_INFO_NONE, NULL, &p_err);
   if (p_enum == NULL) {
      if (p_err != NULL) {
         g_warning("navigator: enumerate failed: %s", p_err->message);
         g_error_free(p_err);
      }
      return;
   }

   GPtrArray  *p_entries = g_ptr_array_new_with_free_func(_entry_free);
   GHashTable *p_jpeg_stems =
      g_hash_table_new_full(g_str_hash, g_str_equal, g_free, NULL);

   GFileInfo *p_info = NULL;
   while ((p_info = g_file_enumerator_next_file(p_enum, NULL, NULL)) != NULL) {
      const char *c_name = g_file_info_get_name(p_info);
      if (c_name == NULL || c_name[0] == '.') {
         g_object_unref(p_info);
         continue;
      }
      if (g_file_info_get_file_type(p_info) != G_FILE_TYPE_REGULAR) {
         g_object_unref(p_info);
         continue;
      }
      const char *c_ct = g_file_info_get_content_type(p_info);
      if (!_is_image_file(c_name, c_ct)) {
         g_object_unref(p_info);
         continue;
      }
      Entry *p_e = g_new(Entry, 1);
      p_e->file  = g_file_get_child(p_nav->p_dir, c_name);
      p_e->name  = g_strdup(c_name);
      p_e->mtime = (gint64)g_file_info_get_attribute_uint64(
         p_info, G_FILE_ATTRIBUTE_TIME_MODIFIED);
      p_e->size = (gint64)g_file_info_get_size(p_info);
      g_object_unref(p_info);

      const char *c_ext = _ext_of(p_e->name); /* p_e->name is owned; c_name
                                               * was borrowed from p_info */
      if (_is_jpeg_ext(c_ext)) {
         char *c_stem = _stem_lower(p_e->name);
         g_hash_table_add(p_jpeg_stems, c_stem);
      }
      g_ptr_array_add(p_entries, p_e);
   }
   g_object_unref(p_enum);

   /* Drop RAW sidecars that have a JPEG twin (decision #33). */
   if (p_nav->b_hide_raw) {
      for (gsize u_i = p_entries->len; u_i > 0; u_i--) {
         Entry      *p_e   = (Entry *)g_ptr_array_index(p_entries, u_i - 1);
         const char *c_ext = _ext_of(p_e->name);
         if (_is_raw_ext(c_ext)) {
            char *c_stem = _stem_lower(p_e->name);
            if (g_hash_table_contains(p_jpeg_stems, c_stem)) {
               g_ptr_array_remove_index(p_entries, u_i - 1);
            }
            g_free(c_stem);
         }
      }
   }
   g_hash_table_unref(p_jpeg_stems);

   g_ptr_array_sort_with_data(p_entries, _compare_entries,
                              GINT_TO_POINTER((gint)p_nav->e_sort));

   /* Remember current by path, then commit. */
   GFile *p_keep = NULL;
   if (p_nav->i_current >= 0 && (guint)p_nav->i_current < p_nav->p_files->len) {
      p_keep = g_object_ref(
         g_ptr_array_index(p_nav->p_files, (guint)p_nav->i_current));
   }
   gint i_old = p_nav->i_current;

   g_ptr_array_set_size(p_nav->p_files, 0);
   for (gsize u_i = 0; u_i < p_entries->len; u_i++) {
      Entry *p_e = (Entry *)g_ptr_array_index(p_entries, u_i);
      g_ptr_array_add(p_nav->p_files, g_object_ref(p_e->file));
   }

   if (p_keep != NULL) {
      gint i_found = _find_index_by_file(p_nav, p_keep);
      if (i_found >= 0) {
         p_nav->i_current = i_found;
      } else if (p_nav->p_files->len == 0) {
         p_nav->i_current = -1;
      } else {
         p_nav->i_current = CLAMP(i_old, 0, (gint)p_nav->p_files->len - 1);
      }
      g_object_unref(p_keep);
   } else if (p_nav->p_files->len == 0) {
      p_nav->i_current = -1;
   } else if (p_nav->i_current < 0) {
      p_nav->i_current = 0;
   }

   /* Prune marks whose file is no longer in the listing (external delete via
    * the monitor, or a rescan). Keeps marks consistent with the live folder. */
   GHashTableIter iter;
   gpointer       p_key;
   g_hash_table_iter_init(&iter, p_nav->p_marks);
   while (g_hash_table_iter_next(&iter, &p_key, NULL)) {
      if (_find_index_by_file(p_nav, (GFile *)p_key) < 0) {
         g_hash_table_iter_remove(&iter);
      }
   }
   /* The range anchor must also be a live marked file: drop it if its file
    * left the listing (external delete / rescan), so `V` no-ops instead of
    * range-marking from a stale path. */
   if (p_nav->p_last_mark != NULL &&
       _find_index_by_file(p_nav, p_nav->p_last_mark) < 0) {
      g_clear_object(&p_nav->p_last_mark);
   }

   /* Preserve removed (dimmed) items: keep them in the listing even if absent
    * from disk (trashed/deleted this session); un-remove any that reappeared.
    */
   {
      GHashTableIter riter;
      gpointer       rkey;
      g_hash_table_iter_init(&riter, p_nav->p_removed);
      while (g_hash_table_iter_next(&riter, &rkey, NULL)) {
         GFile *p_rf = (GFile *)rkey;
         if (_find_index_by_file(p_nav, p_rf) < 0) {
            g_ptr_array_add(p_nav->p_files, g_object_ref(p_rf));
         } else {
            g_hash_table_iter_remove(&riter);
         }
      }
   }

   g_ptr_array_unref(p_entries);
}

static void
_emit_changed(Navigator *p_nav) {
   g_signal_emit(p_nav, u_changed_signal, 0);
}

/* --- monitor / debounce -------------------------------------------------- */

static gboolean
_debounce_fire(gpointer p_data) {
   Navigator *p_nav     = (Navigator *)p_data;
   p_nav->u_debounce_id = 0;
   _relist(p_nav);
   _emit_changed(p_nav);
   return (G_SOURCE_REMOVE);
}

static void
_schedule_debounce(Navigator *p_nav) {
   if (p_nav->u_debounce_id != 0) {
      return; /* already pending; the single rescan picks up all changes */
   }
   p_nav->u_debounce_id =
      g_timeout_add(p_nav->u_debounce_ms, _debounce_fire, p_nav);
}

static void
monitor_changed_cb(GFileMonitor *p_mon, GFile *p_other, GFile *p_src,
                   GFileMonitorEvent e_ev, gpointer p_data) {
   (void)p_mon;
   (void)p_other;
   (void)p_src;
   switch (e_ev) {
   case G_FILE_MONITOR_EVENT_CREATED:
   case G_FILE_MONITOR_EVENT_DELETED:
   case G_FILE_MONITOR_EVENT_MOVED_IN:
   case G_FILE_MONITOR_EVENT_MOVED_OUT:
   case G_FILE_MONITOR_EVENT_RENAMED:
      _schedule_debounce((Navigator *)p_data);
      break;
   default:
      break;
   }
}

/* --- GObject ------------------------------------------------------------- */

static void
navigator_dispose(GObject *p_obj) {
   Navigator *p_nav = (Navigator *)p_obj;
   if (p_nav->u_debounce_id != 0) {
      g_source_remove(p_nav->u_debounce_id);
      p_nav->u_debounce_id = 0;
   }
   if (p_nav->p_monitor != NULL) {
      g_file_monitor_cancel(p_nav->p_monitor);
      g_clear_object(&p_nav->p_monitor);
   }
   g_clear_pointer(&p_nav->p_marks, g_hash_table_unref);
   g_clear_pointer(&p_nav->p_removed, g_hash_table_unref);
   g_clear_pointer(&p_nav->p_files, g_ptr_array_unref);
   g_clear_object(&p_nav->p_dir);
   g_clear_object(&p_nav->p_last_mark);
   G_OBJECT_CLASS(navigator_parent_class)->dispose(p_obj);
}

static void
navigator_class_init(NavigatorClass *p_klass) {
   GObjectClass *p_oc = G_OBJECT_CLASS(p_klass);
   p_oc->dispose      = navigator_dispose;
   u_changed_signal =
      g_signal_new("changed", G_TYPE_FROM_CLASS(p_klass), G_SIGNAL_RUN_LAST, 0,
                   NULL, NULL, g_cclosure_marshal_generic, G_TYPE_NONE, 0);
}

static void
navigator_init(Navigator *p_nav) {
   p_nav->p_files =
      g_ptr_array_new_with_free_func((GDestroyNotify)g_object_unref);
   p_nav->p_marks =
      g_hash_table_new_full((GHashFunc)g_file_hash, (GEqualFunc)g_file_equal,
                            (GDestroyNotify)g_object_unref, NULL);
   p_nav->p_removed =
      g_hash_table_new_full((GHashFunc)g_file_hash, (GEqualFunc)g_file_equal,
                            (GDestroyNotify)g_object_unref, NULL);
   p_nav->i_current     = -1;
   p_nav->e_sort        = GGAZE_SORT_NAME;
   p_nav->b_wrap        = TRUE;
   p_nav->b_hide_raw    = TRUE;
   p_nav->u_debounce_ms = GGAZE_DEFAULT_DEBOUNCE_MS;
   p_nav->p_last_mark   = NULL;
}

/* --- public API ---------------------------------------------------------- */

Navigator *
navigator_new(GFile *p_dir, GgazeSort e_sort, gboolean b_wrap,
              gboolean b_hide_raw) {
   g_return_val_if_fail(G_IS_FILE(p_dir), NULL);
   Navigator *p_nav  = (Navigator *)g_object_new(GGAZE_TYPE_NAVIGATOR, NULL);
   p_nav->p_dir      = (GFile *)g_object_ref(p_dir);
   p_nav->e_sort     = e_sort;
   p_nav->b_wrap     = b_wrap;
   p_nav->b_hide_raw = b_hide_raw;
   _relist(p_nav);
   if (p_nav->i_current < 0 && p_nav->p_files->len > 0) {
      p_nav->i_current = 0;
   }

   GError *p_err    = NULL;
   p_nav->p_monitor = g_file_monitor_directory(
      p_nav->p_dir, G_FILE_MONITOR_WATCH_MOVES, NULL, &p_err);
   if (p_nav->p_monitor != NULL) {
      g_signal_connect(p_nav->p_monitor, "changed",
                       G_CALLBACK(monitor_changed_cb), p_nav);
   } else {
      if (p_err != NULL) {
         g_warning("navigator: monitor failed: %s", p_err->message);
         g_error_free(p_err);
      }
   }
   return (p_nav);
}

void
navigator_delete(Navigator *p_nav) {
   if (p_nav != NULL) {
      g_object_unref(p_nav);
   }
}

GFile *
navigator_get_dir(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), NULL);
   return (p_nav->p_dir);
}

guint
navigator_get_count(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), 0);
   return (p_nav->p_files->len);
}

GFile *
navigator_get_file(Navigator *p_nav, guint u_index) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), NULL);
   g_return_val_if_fail(u_index < p_nav->p_files->len, NULL);
   return ((GFile *)g_ptr_array_index(p_nav->p_files, u_index));
}

gint
navigator_get_current_index(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), -1);
   return (p_nav->i_current);
}

GFile *
navigator_get_current(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), NULL);
   if (p_nav->i_current < 0 || (guint)p_nav->i_current >= p_nav->p_files->len) {
      return (NULL);
   }
   return ((GFile *)g_ptr_array_index(p_nav->p_files, (guint)p_nav->i_current));
}

guint
navigator_get_remaining(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), 0);
   return (navigator_get_count(p_nav) - g_hash_table_size(p_nav->p_removed));
}

gboolean
navigator_is_removed(Navigator *p_nav, GFile *p_file) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (g_hash_table_contains(p_nav->p_removed, p_file));
}

void
navigator_mark_removed(Navigator *p_nav, GFile *p_file) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   g_return_if_fail(G_IS_FILE(p_file));
   /* Decision Q: marks clear on trash/delete. Drop this file's mark (and
    * the range anchor if it was the anchor) without touching unrelated
    * marks, so mark-based ops never target paths that no longer exist. */
   gboolean b_mark_changed = g_hash_table_remove(p_nav->p_marks, p_file);
   if (p_nav->p_last_mark != NULL && g_file_equal(p_nav->p_last_mark, p_file)) {
      g_clear_object(&p_nav->p_last_mark);
      b_mark_changed = TRUE;
   }
   gboolean b_removed_added = !g_hash_table_contains(p_nav->p_removed, p_file);
   if (b_removed_added) {
      g_hash_table_add(p_nav->p_removed, g_object_ref(p_file));
   }
   /* Emit when the removed set or the marks actually changed, so grid badges
    * and the header never go stale (e.g. re-marking a file already in
    * p_removed, then removing it again). */
   if (b_removed_added || b_mark_changed) {
      _emit_changed(p_nav);
   }
}

gboolean
navigator_unmark_removed(Navigator *p_nav, GFile *p_file) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (g_hash_table_remove(p_nav->p_removed, p_file));
}

guint
navigator_get_removed_count(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), 0);
   return (g_hash_table_size(p_nav->p_removed));
}

gboolean
navigator_set_current(Navigator *p_nav, guint u_index) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   if (u_index >= p_nav->p_files->len) {
      return (FALSE);
   }
   if (p_nav->i_current == (gint)u_index) {
      return (FALSE);
   }
   p_nav->i_current = (gint)u_index;
   _emit_changed(p_nav);
   return (TRUE);
}

gboolean
navigator_set_current_file(Navigator *p_nav, GFile *p_file) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   gint i = _find_index_by_file(p_nav, p_file);
   if (i < 0) {
      return (FALSE);
   }
   if (p_nav->i_current == i) {
      return (FALSE);
   }
   p_nav->i_current = i;
   _emit_changed(p_nav);
   return (TRUE);
}

static gboolean
_advance(Navigator *p_nav, gint i_delta) {
   if (p_nav->p_files->len == 0) {
      return (FALSE);
   }
   gint i_new = p_nav->i_current + i_delta;
   if (i_new < 0 || i_new >= (gint)p_nav->p_files->len) {
      if (!p_nav->b_wrap) {
         return (FALSE);
      }
      i_new = (i_new < 0) ? (gint)p_nav->p_files->len - 1 : 0;
   }
   if (i_new == p_nav->i_current) {
      return (FALSE);
   }
   p_nav->i_current = i_new;
   _emit_changed(p_nav);
   return (TRUE);
}

gboolean
navigator_prev(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (_advance(p_nav, -1));
}

gboolean
navigator_next(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (_advance(p_nav, 1));
}

gboolean
navigator_first(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (navigator_set_current(p_nav, 0));
}

gboolean
navigator_last(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   if (p_nav->p_files->len == 0) {
      return (FALSE);
   }
   return (navigator_set_current(p_nav, p_nav->p_files->len - 1));
}

GgazeSort
navigator_get_sort(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), GGAZE_SORT_NAME);
   return (p_nav->e_sort);
}

void
navigator_set_sort(Navigator *p_nav, GgazeSort e_sort) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   if (p_nav->e_sort == e_sort) {
      return;
   }
   p_nav->e_sort = e_sort;
   _relist(p_nav);
   _emit_changed(p_nav);
}

gboolean
navigator_get_wrap(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (p_nav->b_wrap);
}

void
navigator_set_wrap(Navigator *p_nav, gboolean b_wrap) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   p_nav->b_wrap = b_wrap;
}

gboolean
navigator_get_hide_raw(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (p_nav->b_hide_raw);
}

void
navigator_set_hide_raw(Navigator *p_nav, gboolean b_hide_raw) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   if (p_nav->b_hide_raw == b_hide_raw) {
      return;
   }
   p_nav->b_hide_raw = b_hide_raw;
   _relist(p_nav);
   _emit_changed(p_nav);
}

/* --- marks --------------------------------------------------------------- */

gboolean
navigator_is_marked(Navigator *p_nav, GFile *p_file) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   return (g_hash_table_contains(p_nav->p_marks, p_file));
}

void
navigator_toggle_mark(Navigator *p_nav, GFile *p_file) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   g_return_if_fail(G_IS_FILE(p_file));
   if (g_hash_table_contains(p_nav->p_marks, p_file)) {
      g_hash_table_remove(p_nav->p_marks, p_file);
      /* If the unmarked file was the range anchor, drop it: a subsequent `V`
       * has no meaningful anchor once the anchor itself is unmarked. */
      if (p_nav->p_last_mark != NULL &&
          g_file_equal(p_nav->p_last_mark, p_file)) {
         g_clear_object(&p_nav->p_last_mark);
      }
   } else {
      g_hash_table_add(p_nav->p_marks, g_object_ref(p_file));
      /* Remember this as the anchor for a later `V` range-mark. */
      g_set_object(&p_nav->p_last_mark, p_file);
   }
}

static void
_mark_index(Navigator *p_nav, guint u_index) {
   if (u_index >= p_nav->p_files->len) {
      return;
   }
   GFile *p_file = (GFile *)g_ptr_array_index(p_nav->p_files, u_index);
   if (!g_hash_table_contains(p_nav->p_marks, p_file)) {
      g_hash_table_add(p_nav->p_marks, g_object_ref(p_file));
   }
}

void
navigator_mark_range(Navigator *p_nav, GFile *p_from, GFile *p_to) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   gint i_a = _find_index_by_file(p_nav, p_from);
   gint i_b = _find_index_by_file(p_nav, p_to);
   if (i_a < 0 || i_b < 0) {
      return;
   }
   gint i_lo = MIN(i_a, i_b);
   gint i_hi = MAX(i_a, i_b);
   for (gint i = i_lo; i <= i_hi; i++) {
      _mark_index(p_nav, (guint)i);
   }
   _emit_changed(p_nav);
}

void
navigator_mark_all(Navigator *p_nav) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   for (guint u_i = 0; u_i < p_nav->p_files->len; u_i++) {
      _mark_index(p_nav, u_i);
   }
   _emit_changed(p_nav);
}

void
navigator_clear_marks(Navigator *p_nav) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   g_hash_table_remove_all(p_nav->p_marks);
   g_clear_object(&p_nav->p_last_mark);
   _emit_changed(p_nav);
}

guint
navigator_get_mark_count(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), 0);
   return (g_hash_table_size(p_nav->p_marks));
}

GList *
navigator_get_marks(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), NULL);
   GList *p_out  = NULL;
   GList *p_keys = g_hash_table_get_keys(p_nav->p_marks);
   for (GList *p_it = p_keys; p_it != NULL; p_it = p_it->next) {
      p_out = g_list_prepend(p_out, g_object_ref((GFile *)p_it->data));
   }
   g_list_free(p_keys);
   return (g_list_reverse(p_out));
}

/* The anchor set by the last `v` toggle-on, used by `V` range-mark. Borrowed
 * (owned by the navigator); NULL if no mark has been toggled on yet, or if the
 * anchor was unmarked / removed / cleared. Survives re-sort (path-based). */
GFile *
navigator_get_last_mark(Navigator *p_nav) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), NULL);
   return (p_nav->p_last_mark);
}

/* --- mutations ----------------------------------------------------------- */

void
navigator_rescan(Navigator *p_nav) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   _relist(p_nav);
   _emit_changed(p_nav);
}

gboolean
navigator_remove(Navigator *p_nav, GFile *p_file) {
   g_return_val_if_fail(GGAZE_IS_NAVIGATOR(p_nav), FALSE);
   g_return_val_if_fail(G_IS_FILE(p_file), FALSE);
   gint i = _find_index_by_file(p_nav, p_file);
   if (i < 0) {
      return (FALSE);
   }
   /* Clear its mark first (decision Q) while the file ref is still valid. */
   g_hash_table_remove(p_nav->p_marks, p_file);
   if (p_nav->p_last_mark != NULL && g_file_equal(p_nav->p_last_mark, p_file)) {
      g_clear_object(&p_nav->p_last_mark);
   }
   g_ptr_array_remove_index(p_nav->p_files, (guint)i);
   if (p_nav->p_files->len == 0) {
      p_nav->i_current = -1;
   } else if (p_nav->i_current == i) {
      /* Was current: fall back to nearest (stay at this index -> the next file,
       * or the new last if we removed the tail). */
      p_nav->i_current = MIN(i, (gint)p_nav->p_files->len - 1);
   } else if (p_nav->i_current > i) {
      p_nav->i_current--;
   }
   _emit_changed(p_nav);
   return (TRUE);
}

void
navigator_set_debounce_ms(Navigator *p_nav, guint u_ms) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   p_nav->u_debounce_ms = u_ms;
}

void
navigator_emit_changed(Navigator *p_nav) {
   g_return_if_fail(GGAZE_IS_NAVIGATOR(p_nav));
   _emit_changed(p_nav);
}