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
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
| | ;;; recentf.el --- setup a menu of recently opened files
;; Copyright (C) 1999-2018 Free Software Foundation, Inc.
;; Author: David Ponce <david@dponce.com>
;; Created: July 19 1999
;; Keywords: files
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This package maintains a menu for visiting files that were operated
;; on recently. When enabled a new "Open Recent" sub menu is
;; displayed in the "File" menu. The recent files list is
;; automatically saved across Emacs sessions. You can customize the
;; number of recent files displayed, the location of the menu and
;; others options (see the source code for details).
;; To enable this package, add the following to your .emacs:
;; (recentf-mode 1)
;;; History:
;;
;;; Code:
(require 'easymenu)
(require 'tree-widget)
(require 'timer)
;;; Internal data
;;
(defvar recentf-list nil
"List of recently opened files.")
(defsubst recentf-enabled-p ()
"Return non-nil if recentf mode is currently enabled."
(memq 'recentf-save-list kill-emacs-hook))
\f
;;; Customization
;;
(defgroup recentf nil
"Maintain a menu of recently opened files."
:version "21.1"
:group 'files)
(defgroup recentf-filters nil
"Group to customize recentf menu filters.
You should define the options of your own filters in this group."
:group 'recentf)
(defcustom recentf-max-saved-items 20
"Maximum number of items of the recent list that will be saved.
A nil value means to save the whole list.
See the command `recentf-save-list'."
:group 'recentf
:type 'integer)
(defcustom recentf-save-file (locate-user-emacs-file "recentf" ".recentf")
"File to save the recent list into."
:group 'recentf
:version "24.4"
:type 'file
:initialize 'custom-initialize-default
:set (lambda (symbol value)
(let ((oldvalue (eval symbol)))
(custom-set-default symbol value)
(and (not (equal value oldvalue))
recentf-mode
(recentf-load-list)))))
(defcustom recentf-save-file-modes #o600
"Mode bits of recentf save file, as an integer, or nil.
If non-nil, after writing `recentf-save-file', set its mode bits to
this value. By default give R/W access only to the user who owns that
file. See also the function `set-file-modes'."
:group 'recentf
:type '(choice (const :tag "Don't change" nil)
integer))
(defcustom recentf-exclude nil
"List of regexps and predicates for filenames excluded from the recent list.
When a filename matches any of the regexps or satisfies any of the
predicates it is excluded from the recent list.
A predicate is a function that is passed a filename to check and that
must return non-nil to exclude it."
:group 'recentf
:type '(repeat (choice regexp function)))
(defun recentf-keep-default-predicate (file)
"Return non-nil if FILE should be kept in the recent list.
It handles the case of remote files as well."
(cond
((file-remote-p file nil t) (file-readable-p file))
((file-remote-p file))
((file-readable-p file))))
(defcustom recentf-keep
'(recentf-keep-default-predicate)
"List of regexps and predicates for filenames kept in the recent list.
Regexps and predicates are tried in the specified order.
When nil all filenames are kept in the recent list.
When a filename matches any of the regexps or satisfies any of the
predicates it is kept in the recent list.
The default is to keep readable files. Remote files are checked
for readability only in case a connection is established to that
remote system, otherwise they are kept in the recent list without
checking their readability.
A predicate is a function that is passed a filename to check and that
must return non-nil to keep it."
:group 'recentf
:type '(repeat (choice regexp function)))
(defun recentf-menu-customization-changed (variable value)
"Function called when the recentf menu customization has changed.
Set VARIABLE with VALUE, and force a rebuild of the recentf menu."
(if (and (featurep 'recentf) (recentf-enabled-p))
(progn
;; Unavailable until recentf has been loaded.
(recentf-hide-menu)
(set-default variable value)
(recentf-show-menu))
(set-default variable value)))
(defcustom recentf-menu-title "Open Recent"
"Name of the recentf menu."
:group 'recentf
:type 'string
:set 'recentf-menu-customization-changed)
(defcustom recentf-menu-path '("File")
"Path where to add the recentf menu.
If nil add it at top level (see also `easy-menu-add-item')."
:group 'recentf
:type '(choice (const :tag "Top Level" nil)
(sexp :tag "Menu Path"))
:set 'recentf-menu-customization-changed)
(defcustom recentf-menu-before "Open File..."
"Name of the menu before which the recentf menu will be added.
If nil add it at end of menu (see also `easy-menu-add-item')."
:group 'recentf
:type '(choice (string :tag "Name")
(const :tag "Last" nil))
:set 'recentf-menu-customization-changed)
(defcustom recentf-menu-action 'find-file
"Function to invoke with a filename item of the recentf menu.
The default is to call `find-file' to edit the selected file."
:group 'recentf
:type 'function)
(defcustom recentf-max-menu-items 10
"Maximum number of items in the recentf menu."
:group 'recentf
:type 'integer)
(defcustom recentf-menu-filter nil
"Function used to filter files displayed in the recentf menu.
A nil value means no filter. The following functions are predefined:
- `recentf-sort-ascending'
Sort menu items in ascending order.
- `recentf-sort-descending'
Sort menu items in descending order.
- `recentf-sort-basenames-ascending'
Sort menu items by filenames sans directory in ascending order.
- `recentf-sort-basenames-descending'
Sort menu items by filenames sans directory in descending order.
- `recentf-sort-directories-ascending'
Sort menu items by directories in ascending order.
- `recentf-sort-directories-descending'
Sort menu items by directories in descending order.
- `recentf-show-basenames'
Show filenames sans directory in menu items.
- `recentf-show-basenames-ascending'
Show filenames sans directory in ascending order.
- `recentf-show-basenames-descending'
Show filenames sans directory in descending order.
- `recentf-relative-filter'
Show filenames relative to `default-directory'.
- `recentf-arrange-by-rule'
Show sub-menus following user defined rules.
- `recentf-arrange-by-mode'
Show a sub-menu for each major mode.
- `recentf-arrange-by-dir'
Show a sub-menu for each directory.
- `recentf-filter-changer'
Manage a menu of filters.
The filter function is called with one argument, the list of menu
elements used to build the menu and must return a new list of menu
elements (see `recentf-make-menu-element' for menu element form)."
:group 'recentf
:type '(radio (const nil)
(function-item recentf-sort-ascending)
(function-item recentf-sort-descending)
(function-item recentf-sort-basenames-ascending)
(function-item recentf-sort-basenames-descending)
(function-item recentf-sort-directories-ascending)
(function-item recentf-sort-directories-descending)
(function-item recentf-show-basenames)
(function-item recentf-show-basenames-ascending)
(function-item recentf-show-basenames-descending)
(function-item recentf-relative-filter)
(function-item recentf-arrange-by-rule)
(function-item recentf-arrange-by-mode)
(function-item recentf-arrange-by-dir)
(function-item recentf-filter-changer)
function))
(defcustom recentf-menu-open-all-flag nil
"Non-nil means to show an \"All...\" item in the menu.
This item will replace the \"More...\" item."
:group 'recentf
:type 'boolean)
(defcustom recentf-menu-append-commands-flag t
"Non-nil means to append command items to the menu."
:group 'recentf
:type 'boolean)
(defcustom recentf-auto-cleanup 'mode
"Define when to automatically cleanup the recent list.
The following values can be set:
- `mode'
Cleanup when turning the mode on (default).
- `never'
Never cleanup the list automatically.
- A number
Cleanup each time Emacs has been idle that number of seconds.
- A time string
Cleanup at specified time string, for example at \"11:00pm\".
Setting this variable directly does not take effect;
use \\[customize].
See also the command `recentf-cleanup', that can be used to manually
cleanup the list."
:group 'recentf
:type '(radio (const :tag "When mode enabled"
:value mode)
(const :tag "Never"
:value never)
(number :tag "When idle that seconds"
:value 300)
(string :tag "At time"
:value "11:00pm"))
:set (lambda (variable value)
(set-default variable value)
(when (featurep 'recentf)
;; Unavailable until recentf has been loaded.
(recentf-auto-cleanup))))
(defcustom recentf-initialize-file-name-history t
"Non-nil means to initialize `file-name-history' with the recent list.
If `file-name-history' is not empty, do nothing."
:group 'recentf
:type 'boolean)
(defcustom recentf-load-hook nil
"Normal hook run at end of loading the `recentf' package."
:group 'recentf
:type 'hook)
(defcustom recentf-filename-handlers nil
"Functions to post process recent file names.
They are successively passed a file name to transform it."
:group 'recentf
:type '(choice
(const :tag "None" nil)
(repeat :tag "Functions"
(choice
(const file-truename)
(const abbreviate-file-name)
(function :tag "Other function")))))
(defcustom recentf-show-file-shortcuts-flag t
"Whether to show \"[N]\" for the Nth item up to 10.
If non-nil, `recentf-open-files' will show labels for keys that can be
used as shortcuts to open the Nth file."
:group 'recentf
:type 'boolean)
\f
;;; Utilities
;;
(defconst recentf-case-fold-search
(memq system-type '(windows-nt cygwin))
"Non-nil if recentf searches and matches should ignore case.")
(defsubst recentf-string-equal (s1 s2)
"Return non-nil if strings S1 and S2 have identical contents.
Ignore case if `recentf-case-fold-search' is non-nil."
(if recentf-case-fold-search
(string-equal (downcase s1) (downcase s2))
(string-equal s1 s2)))
(defsubst recentf-string-lessp (s1 s2)
"Return non-nil if string S1 is less than S2 in lexicographic order.
Ignore case if `recentf-case-fold-search' is non-nil."
(if recentf-case-fold-search
(string-lessp (downcase s1) (downcase s2))
(string-lessp s1 s2)))
(defun recentf-string-member (elt list)
"Return non-nil if ELT is an element of LIST.
The value is actually the tail of LIST whose car is ELT.
ELT must be a string and LIST a list of strings.
Ignore case if `recentf-case-fold-search' is non-nil."
(while (and list (not (recentf-string-equal elt (car list))))
(setq list (cdr list)))
list)
(defsubst recentf-trunc-list (l n)
"Return from L the list of its first N elements."
(let (nl)
(while (and l (> n 0))
(setq nl (cons (car l) nl)
n (1- n)
l (cdr l)))
(nreverse nl)))
(defun recentf-dump-variable (variable &optional limit)
"Insert a \"(setq VARIABLE value)\" in the current buffer.
When the value of VARIABLE is a list, optional argument LIMIT
specifies a maximum number of elements to insert. By default insert
the full list."
(let ((value (symbol-value variable)))
(if (atom value)
(insert (format "\n(setq %S '%S)\n" variable value))
(when (and (integerp limit) (> limit 0))
(setq value (recentf-trunc-list value limit)))
(insert (format "\n(setq %S\n '(" variable))
(dolist (e value)
(insert (format "\n %S" e)))
(insert "\n ))\n"))))
(defvar recentf-auto-cleanup-timer nil
"Timer used to automatically cleanup the recent list.
See also the option `recentf-auto-cleanup'.")
(defun recentf-auto-cleanup ()
"Automatic cleanup of the recent list."
(when (timerp recentf-auto-cleanup-timer)
(cancel-timer recentf-auto-cleanup-timer))
(when recentf-mode
(setq recentf-auto-cleanup-timer
(cond
((eq 'mode recentf-auto-cleanup)
(recentf-cleanup)
nil)
((numberp recentf-auto-cleanup)
(run-with-idle-timer
recentf-auto-cleanup t 'recentf-cleanup))
((stringp recentf-auto-cleanup)
(run-at-time
recentf-auto-cleanup nil 'recentf-cleanup))))))
\f
;;; File functions
;;
(defsubst recentf-push (filename)
"Push FILENAME into the recent list, if it isn't there yet.
If it is there yet, move it at the beginning of the list.
If `recentf-case-fold-search' is non-nil, ignore case when comparing
filenames."
(let ((m (recentf-string-member filename recentf-list)))
(and m (setq recentf-list (delq (car m) recentf-list)))
(push filename recentf-list)))
(defun recentf-apply-filename-handlers (name)
"Apply `recentf-filename-handlers' to file NAME.
Return the transformed file name, or NAME if any handler failed, or
returned nil."
(or (condition-case nil
(let ((handlers recentf-filename-handlers)
(filename name))
(while (and filename handlers)
(setq filename (funcall (car handlers) filename)
handlers (cdr handlers)))
filename)
(error nil))
name))
(defsubst recentf-expand-file-name (name)
"Convert file NAME to absolute, and canonicalize it.
NAME is first passed to the function `expand-file-name', then to
`recentf-filename-handlers' to post process it."
(recentf-apply-filename-handlers (expand-file-name name)))
(defun recentf-include-p (filename)
"Return non-nil if FILENAME should be included in the recent list.
That is, if it doesn't match any of the `recentf-exclude' checks."
(let ((case-fold-search recentf-case-fold-search)
(checks recentf-exclude)
(keepit t))
(while (and checks keepit)
;; If there was an error in a predicate, err on the side of
;; keeping the file. (Bug#5843)
(setq keepit (not (ignore-errors
(if (stringp (car checks))
;; A regexp
(string-match (car checks) filename)
;; A predicate
(funcall (car checks) filename))))
checks (cdr checks)))
keepit))
(defun recentf-keep-p (filename)
"Return non-nil if FILENAME should be kept in the recent list.
That is, if it matches any of the `recentf-keep' checks."
(let* ((case-fold-search recentf-case-fold-search)
(checks recentf-keep)
(keepit (null checks)))
(while (and checks (not keepit))
(setq keepit (condition-case nil
(if (stringp (car checks))
;; A regexp
(string-match (car checks) filename)
;; A predicate
(funcall (car checks) filename))
(error nil))
checks (cdr checks)))
keepit))
(defsubst recentf-add-file (filename)
"Add or move FILENAME at the beginning of the recent list.
Does nothing if the name satisfies any of the `recentf-exclude'
regexps or predicates."
(setq filename (recentf-expand-file-name filename))
(when (recentf-include-p filename)
(recentf-push filename)))
(defsubst recentf-remove-if-non-kept (filename)
"Remove FILENAME from the recent list, if file is not kept.
Return non-nil if FILENAME has been removed."
(unless (recentf-keep-p filename)
(let ((m (recentf-string-member
(recentf-expand-file-name filename) recentf-list)))
(and m (setq recentf-list (delq (car m) recentf-list))))))
(defsubst recentf-directory-compare (f1 f2)
"Compare absolute filenames F1 and F2.
First compare directories, then filenames sans directory.
Return non-nil if F1 is less than F2."
(let ((d1 (file-name-directory f1))
(d2 (file-name-directory f2)))
(if (recentf-string-equal d1 d2)
(recentf-string-lessp (file-name-nondirectory f1)
(file-name-nondirectory f2))
(recentf-string-lessp d1 d2))))
\f
;;; Menu building
;;
(defsubst recentf-digit-shortcut-command-name (n)
"Return a command name to open the Nth most recent file.
See also the command `recentf-open-most-recent-file'."
(intern (format "recentf-open-most-recent-file-%d" n)))
(defvar recentf--shortcuts-keymap
(let ((km (make-sparse-keymap)))
(dolist (k '(0 9 8 7 6 5 4 3 2 1))
(let ((cmd (recentf-digit-shortcut-command-name k)))
;; Define a shortcut command.
(defalias cmd
`(lambda ()
(interactive)
(recentf-open-most-recent-file ,k)))
;; Bind it to a digit key.
(define-key km (vector (+ k ?0)) cmd)))
km)
"Digit shortcuts keymap.")
(defvar recentf-menu-items-for-commands
(list
["Cleanup list"
recentf-cleanup
:help "Remove duplicates, and obsoletes files from the recent list"
:active t]
["Edit list..."
recentf-edit-list
:help "Manually remove files from the recent list"
:active t]
["Save list now"
recentf-save-list
:help "Save the list of recently opened files now"
:active t]
["Options..."
(customize-group "recentf")
:help "Customize recently opened files menu and options"
:active t]
)
"List of menu items for recentf commands.")
(defvar recentf-menu-filter-commands nil
"This variable can be used by menu filters to setup their own command menu.
If non-nil it must contain a list of valid menu-items to be appended
to the recent file list part of the menu. Before calling a menu
filter function this variable is reset to nil.")
(defsubst recentf-elements (n)
"Return a list of the first N elements of the recent list."
(recentf-trunc-list recentf-list n))
(defsubst recentf-make-menu-element (menu-item menu-value)
"Create a new menu-element.
A menu element is a pair (MENU-ITEM . MENU-VALUE), where MENU-ITEM is
the menu item string displayed. MENU-VALUE is the file to be open
when the corresponding MENU-ITEM is selected. Or it is a
pair (SUB-MENU-TITLE . MENU-ELEMENTS) where SUB-MENU-TITLE is a
sub-menu title and MENU-ELEMENTS is the list of menu elements in the
sub-menu."
(cons menu-item menu-value))
(defsubst recentf-menu-element-item (e)
"Return the item part of the menu-element E."
(car e))
(defsubst recentf-menu-element-value (e)
"Return the value part of the menu-element E."
(cdr e))
(defsubst recentf-set-menu-element-item (e item)
"Change the item part of menu-element E to ITEM."
(setcar e item))
(defsubst recentf-set-menu-element-value (e value)
"Change the value part of menu-element E to VALUE."
(setcdr e value))
(defsubst recentf-sub-menu-element-p (e)
"Return non-nil if menu-element E defines a sub-menu."
(consp (recentf-menu-element-value e)))
(defsubst recentf-make-default-menu-element (file)
"Make a new default menu element with FILE.
This a menu element (FILE . FILE)."
(recentf-make-menu-element file file))
(defsubst recentf-menu-elements (n)
"Return a list of the first N default menu elements from the recent list.
See also `recentf-make-default-menu-element'."
(mapcar 'recentf-make-default-menu-element
(recentf-elements n)))
(defun recentf-apply-menu-filter (filter l)
"Apply function FILTER to the list of menu-elements L.
It takes care of sub-menu elements in L and recursively apply FILTER
to them. It is guaranteed that FILTER receives only a list of single
menu-elements (no sub-menu)."
(if (and l (functionp filter))
(let ((case-fold-search recentf-case-fold-search)
elts others)
;; split L into two sub-lists, one of sub-menus elements and
;; another of single menu elements.
(dolist (elt l)
(if (recentf-sub-menu-element-p elt)
(push elt elts)
(push elt others)))
;; Apply FILTER to single elements.
(when others
(setq others (funcall filter (nreverse others))))
;; Apply FILTER to sub-menu elements.
(setq l nil)
(dolist (elt elts)
(recentf-set-menu-element-value
elt (recentf-apply-menu-filter
filter (recentf-menu-element-value elt)))
(push elt l))
;; Return the new filtered menu element list.
(nconc l others))
l))
;; Count the number of assigned menu shortcuts.
(defvar recentf-menu-shortcuts)
(defun recentf-make-menu-items (&optional _menu)
"Make menu items from the recent list.
This is a menu filter function which ignores the MENU argument."
(setq recentf-menu-filter-commands nil)
(let* ((recentf-menu-shortcuts 0)
(file-items
(condition-case err
(mapcar 'recentf-make-menu-item
(recentf-apply-menu-filter
recentf-menu-filter
(recentf-menu-elements recentf-max-menu-items)))
(error
(message "recentf update menu failed: %s"
(error-message-string err))))))
(append
(or file-items
'(["No files" t
:help "No recent file to open"
:active nil]))
(if recentf-menu-open-all-flag
'(["All..." recentf-open-files
:help "Open recent files through a dialog"
:active t])
(and (< recentf-max-menu-items (length recentf-list))
'(["More..." recentf-open-more-files
:help "Open files not in the menu through a dialog"
:active t])))
(and recentf-menu-filter-commands '("---"))
recentf-menu-filter-commands
(and recentf-menu-items-for-commands '("---"))
recentf-menu-items-for-commands)))
(defun recentf-menu-value-shortcut (name)
"Return a shortcut digit for file NAME.
Return nil if file NAME is not one of the ten more recent."
(let ((i 0) k)
(while (and (not k) (< i 10))
(if (string-equal name (nth i recentf-list))
(progn
(setq recentf-menu-shortcuts (1+ recentf-menu-shortcuts))
(setq k (% (1+ i) 10)))
(setq i (1+ i))))
k))
(defun recentf-make-menu-item (elt)
"Make a menu item from menu element ELT."
(let ((item (recentf-menu-element-item elt))
(value (recentf-menu-element-value elt)))
(if (recentf-sub-menu-element-p elt)
(cons item (mapcar 'recentf-make-menu-item value))
(let ((k (and (< recentf-menu-shortcuts 10)
(recentf-menu-value-shortcut value))))
(vector item
;; If the file name is one of the ten more recent, use
;; a digit shortcut command to open it, else use an
;; anonymous command.
(if k
(recentf-digit-shortcut-command-name k)
`(lambda ()
(interactive)
(,recentf-menu-action ,value)))
:help (concat "Open " value)
:active t)))))
(defsubst recentf-menu-bar ()
"Return the keymap of the global menu bar."
(lookup-key global-map [menu-bar]))
(defun recentf-show-menu ()
"Show the menu of recently opened files."
(easy-menu-add-item
(recentf-menu-bar) recentf-menu-path
(list recentf-menu-title :filter 'recentf-make-menu-items)
recentf-menu-before))
(defun recentf-hide-menu ()
"Hide the menu of recently opened files."
(easy-menu-remove-item (recentf-menu-bar) recentf-menu-path
recentf-menu-title))
\f
;;; Predefined menu filters
;;
(defsubst recentf-sort-ascending (l)
"Sort the list of menu elements L in ascending order.
The MENU-ITEM part of each menu element is compared."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-string-lessp
(recentf-menu-element-item e1)
(recentf-menu-element-item e2)))))
(defsubst recentf-sort-descending (l)
"Sort the list of menu elements L in descending order.
The MENU-ITEM part of each menu element is compared."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-string-lessp
(recentf-menu-element-item e2)
(recentf-menu-element-item e1)))))
(defsubst recentf-sort-basenames-ascending (l)
"Sort the list of menu elements L in ascending order.
Only filenames sans directory are compared."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-string-lessp
(file-name-nondirectory (recentf-menu-element-value e1))
(file-name-nondirectory (recentf-menu-element-value e2))))))
(defsubst recentf-sort-basenames-descending (l)
"Sort the list of menu elements L in descending order.
Only filenames sans directory are compared."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-string-lessp
(file-name-nondirectory (recentf-menu-element-value e2))
(file-name-nondirectory (recentf-menu-element-value e1))))))
(defsubst recentf-sort-directories-ascending (l)
"Sort the list of menu elements L in ascending order.
Compares directories then filenames to order the list."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-directory-compare
(recentf-menu-element-value e1)
(recentf-menu-element-value e2)))))
(defsubst recentf-sort-directories-descending (l)
"Sort the list of menu elements L in descending order.
Compares directories then filenames to order the list."
(sort (copy-sequence l)
#'(lambda (e1 e2)
(recentf-directory-compare
(recentf-menu-element-value e2)
(recentf-menu-element-value e1)))))
(defun recentf-show-basenames (l &optional no-dir)
"Filter the list of menu elements L to show filenames sans directory.
When a filename is duplicated, it is appended a sequence number if
optional argument NO-DIR is non-nil, or its directory otherwise."
(let (filtered-names filtered-list full name counters sufx)
(dolist (elt l (nreverse filtered-list))
(setq full (recentf-menu-element-value elt)
name (file-name-nondirectory full))
(if (not (member name filtered-names))
(push name filtered-names)
(if no-dir
(if (setq sufx (assoc name counters))
(setcdr sufx (1+ (cdr sufx)))
(setq sufx 1)
(push (cons name sufx) counters))
(setq sufx (file-name-directory full)))
(setq name (format "%s(%s)" name sufx)))
(push (recentf-make-menu-element name full) filtered-list))))
(defsubst recentf-show-basenames-ascending (l)
"Filter the list of menu elements L to show filenames sans directory.
Filenames are sorted in ascending order.
This filter combines the `recentf-sort-basenames-ascending' and
`recentf-show-basenames' filters."
(recentf-show-basenames (recentf-sort-basenames-ascending l)))
(defsubst recentf-show-basenames-descending (l)
"Filter the list of menu elements L to show filenames sans directory.
Filenames are sorted in descending order.
This filter combines the `recentf-sort-basenames-descending' and
`recentf-show-basenames' filters."
(recentf-show-basenames (recentf-sort-basenames-descending l)))
(defun recentf-relative-filter (l)
"Filter the list of menu-elements L to show relative filenames.
Filenames are relative to the `default-directory'."
(mapcar #'(lambda (menu-element)
(let* ((ful (recentf-menu-element-value menu-element))
(rel (file-relative-name ful default-directory)))
(if (string-match "^\\.\\." rel)
menu-element
(recentf-make-menu-element rel ful))))
l))
\f
;;; Rule based menu filters
;;
(defcustom recentf-arrange-rules
'(
("Elisp files (%d)" ".\\.el\\'")
("Java files (%d)" ".\\.java\\'")
("C/C++ files (%d)" "c\\(pp\\)?\\'")
)
"List of rules used by `recentf-arrange-by-rule' to build sub-menus.
A rule is a pair (SUB-MENU-TITLE . MATCHER). SUB-MENU-TITLE is the
displayed title of the sub-menu where a `%d' `format' pattern is
replaced by the number of items in the sub-menu. MATCHER is a regexp
or a list of regexps. Items matching one of the regular expressions in
MATCHER are added to the corresponding sub-menu.
SUB-MENU-TITLE can be a function. It is passed every items that
matched the corresponding MATCHER, and it must return a
pair (SUB-MENU-TITLE . ITEM). SUB-MENU-TITLE is a computed sub-menu
title that can be another function. ITEM is the received item which
may have been modified to match another rule."
:group 'recentf-filters
:type '(repeat (cons (choice string function)
(repeat regexp))))
(defcustom recentf-arrange-by-rule-others "Other files (%d)"
"Title of the `recentf-arrange-by-rule' sub-menu.
This is for the menu where items that don't match any
`recentf-arrange-rules' are displayed. If nil these items are
displayed in the main recent files menu. A `%d' `format' pattern in
the title is replaced by the number of items in the sub-menu."
:group 'recentf-filters
:type '(choice (const :tag "Main menu" nil)
(string :tag "Title")))
(defcustom recentf-arrange-by-rules-min-items 0
"Minimum number of items in a `recentf-arrange-by-rule' sub-menu.
If the number of items in a sub-menu is less than this value the
corresponding sub-menu items are displayed in the main recent files
menu or in the `recentf-arrange-by-rule-others' sub-menu if
defined."
:group 'recentf-filters
:type 'number)
(defcustom recentf-arrange-by-rule-subfilter nil
"Function called by a rule based filter to filter sub-menu elements.
A nil value means no filter. See also `recentf-menu-filter'.
You can't use another rule based filter here."
:group 'recentf-filters
:type '(choice (const nil) function)
:set (lambda (variable value)
(when (memq value '(recentf-arrange-by-rule
recentf-arrange-by-mode
recentf-arrange-by-dir))
(error "Recursive use of a rule based filter"))
(set-default variable value)))
(defun recentf-match-rule (file)
"Return the rule that match FILE."
(let ((rules recentf-arrange-rules)
match found)
(while (and (not found) rules)
(setq match (cdar rules))
(when (stringp match)
(setq match (list match)))
(while (and match (not (string-match (car match) file)))
(setq match (cdr match)))
(if match
(setq found (cons (caar rules) file))
(setq rules (cdr rules))))
found))
(defun recentf-arrange-by-rule (l)
"Filter the list of menu-elements L.
Arrange them in sub-menus following rules in `recentf-arrange-rules'."
(when recentf-arrange-rules
(let (menus others menu file min count)
;; Put menu items into sub-menus as defined by rules.
(dolist (elt l)
(setq file (recentf-menu-element-value elt)
menu (recentf-match-rule file))
(while (functionp (car menu))
(setq menu (funcall (car menu) (cdr menu))))
(if (not (stringp (car menu)))
(push elt others)
(setq menu (or (assoc (car menu) menus)
(car (push (list (car menu)) menus))))
(recentf-set-menu-element-value
menu (cons elt (recentf-menu-element-value menu)))))
;; Finalize each sub-menu:
;; - truncate it depending on the value of
;; `recentf-arrange-by-rules-min-items',
;; - replace %d by the number of menu items,
;; - apply `recentf-arrange-by-rule-subfilter' to menu items.
(setq min (if (natnump recentf-arrange-by-rules-min-items)
recentf-arrange-by-rules-min-items 0)
l nil)
(dolist (elt menus)
(setq menu (recentf-menu-element-value elt)
count (length menu))
(if (< count min)
(setq others (nconc menu others))
(recentf-set-menu-element-item
elt (format (recentf-menu-element-item elt) count))
(recentf-set-menu-element-value
elt (recentf-apply-menu-filter
recentf-arrange-by-rule-subfilter (nreverse menu)))
(push elt l)))
;; Add the menu items remaining in the `others' bin.
(when (setq others (nreverse others))
(setq l (nconc
l
;; Put items in an sub menu.
(if (stringp recentf-arrange-by-rule-others)
(list
(recentf-make-menu-element
(format recentf-arrange-by-rule-others
(length others))
(recentf-apply-menu-filter
recentf-arrange-by-rule-subfilter others)))
;; Append items to the main menu.
(recentf-apply-menu-filter
recentf-arrange-by-rule-subfilter others)))))))
l)
\f
;;; Predefined rule based menu filters
;;
(defun recentf-indirect-mode-rule (file)
"Apply a second level `auto-mode-alist' regexp to FILE."
(recentf-match-rule (substring file 0 (match-beginning 0))))
(defun recentf-build-mode-rules ()
"Convert `auto-mode-alist' to menu filter rules.
Rules obey `recentf-arrange-rules' format."
(let ((case-fold-search recentf-case-fold-search)
regexp rule-name rule rules)
(dolist (mode auto-mode-alist)
(setq regexp (car mode)
mode (cdr mode))
(when mode
(cond
;; Build a special "strip suffix" rule from entries of the
;; form (REGEXP FUNCTION NON-NIL). Notice that FUNCTION is
;; ignored by the menu filter. So in some corner cases a
;; wrong mode could be guessed.
((and (consp mode) (cadr mode))
(setq rule-name 'recentf-indirect-mode-rule))
((and mode (symbolp mode))
(setq rule-name (symbol-name mode))
(if (string-match "\\(.*\\)-mode$" rule-name)
(setq rule-name (match-string 1 rule-name)))
(setq rule-name (concat rule-name " (%d)"))))
(setq rule (assoc rule-name rules))
(if rule
(setcdr rule (cons regexp (cdr rule)))
(push (list rule-name regexp) rules))))
;; It is important to preserve auto-mode-alist order
;; to ensure the right file <-> mode association
(nreverse rules)))
(defun recentf-arrange-by-mode (l)
"Split the list of menu-elements L into sub-menus by major mode."
(let ((recentf-arrange-rules (recentf-build-mode-rules))
(recentf-arrange-by-rule-others "others (%d)"))
(recentf-arrange-by-rule l)))
(defun recentf-file-name-nondir (l)
"Filter the list of menu-elements L to show filenames sans directory.
This simplified version of `recentf-show-basenames' does not handle
duplicates. It is used by `recentf-arrange-by-dir' as its
`recentf-arrange-by-rule-subfilter'."
(mapcar #'(lambda (e)
(recentf-make-menu-element
(file-name-nondirectory (recentf-menu-element-value e))
(recentf-menu-element-value e)))
l))
(defun recentf-dir-rule (file)
"Return as a sub-menu, the directory FILE belongs to."
(cons (file-name-directory file) file))
(defun recentf-arrange-by-dir (l)
"Split the list of menu-elements L into sub-menus by directory."
(let ((recentf-arrange-rules '((recentf-dir-rule . ".*")))
(recentf-arrange-by-rule-subfilter 'recentf-file-name-nondir)
recentf-arrange-by-rule-others)
(recentf-arrange-by-rule l)))
\f
;;; Menu of menu filters
;;
(defvar recentf-filter-changer-current nil
"Current filter used by `recentf-filter-changer'.")
(defcustom recentf-filter-changer-alist
'(
(recentf-arrange-by-mode . "Grouped by Mode")
(recentf-arrange-by-dir . "Grouped by Directory")
(recentf-arrange-by-rule . "Grouped by Custom Rules")
)
"List of filters managed by `recentf-filter-changer'.
Each filter is defined by a pair (FUNCTION . LABEL), where FUNCTION is
the filter function, and LABEL is the menu item displayed to select
that filter."
:group 'recentf-filters
:type '(repeat (cons function string))
:set (lambda (variable value)
(setq recentf-filter-changer-current nil)
(set-default variable value)))
(defun recentf-filter-changer-select (filter)
"Select FILTER as the current menu filter.
See `recentf-filter-changer'."
(setq recentf-filter-changer-current filter))
(defun recentf-filter-changer (l)
"Manage a sub-menu of menu filters.
`recentf-filter-changer-alist' defines the filters in the menu.
Filtering of L is delegated to the selected filter in the menu."
(unless recentf-filter-changer-current
(setq recentf-filter-changer-current
(caar recentf-filter-changer-alist)))
(if (not recentf-filter-changer-current)
l
(setq recentf-menu-filter-commands
(list
`("Show files"
,@(mapcar
#'(lambda (f)
`[,(cdr f)
(setq recentf-filter-changer-current ',(car f))
;;:active t
:style radio ;;radio Don't work with GTK :-(
:selected (eq recentf-filter-changer-current
',(car f))
;;:help ,(cdr f)
])
recentf-filter-changer-alist))))
(recentf-apply-menu-filter recentf-filter-changer-current l)))
\f
;;; Hooks
;;
(defun recentf-track-opened-file ()
"Insert the name of the file just opened or written into the recent list."
(and buffer-file-name
(recentf-add-file buffer-file-name))
;; Must return nil because it is run from `write-file-functions'.
nil)
(defun recentf-track-closed-file ()
"Update the recent list when a buffer is killed.
That is, remove a non kept file from the recent list."
(and buffer-file-name
(recentf-remove-if-non-kept buffer-file-name)))
(defconst recentf-used-hooks
'(
(find-file-hook recentf-track-opened-file)
(write-file-functions recentf-track-opened-file)
(kill-buffer-hook recentf-track-closed-file)
(kill-emacs-hook recentf-save-list)
)
"Hooks used by recentf.")
\f
;;; Commands
;;
;;; Common dialog stuff
;;
(defun recentf-cancel-dialog (&rest _ignore)
"Cancel the current dialog.
IGNORE arguments."
(interactive)
(kill-buffer (current-buffer))
(message "Dialog canceled"))
(defun recentf-dialog-goto-first (widget-type)
"Move the cursor to the first WIDGET-TYPE in current dialog.
Go to the beginning of buffer if not found."
(goto-char (point-min))
(condition-case nil
(let (done)
(widget-move 1)
(while (not done)
(if (eq widget-type (widget-type (widget-at (point))))
(setq done t)
(widget-move 1))))
(error
(goto-char (point-min)))))
(defvar recentf-dialog-mode-map
(let ((km (copy-keymap recentf--shortcuts-keymap)))
(set-keymap-parent km widget-keymap)
(define-key km "q" 'recentf-cancel-dialog)
(define-key km "n" 'next-line)
(define-key km "p" 'previous-line)
km)
"Keymap used in recentf dialogs.")
(define-derived-mode recentf-dialog-mode nil "recentf-dialog"
"Major mode of recentf dialogs.
\\{recentf-dialog-mode-map}"
:syntax-table nil
:abbrev-table nil
(setq truncate-lines t))
(defmacro recentf-dialog (name &rest forms)
"Show a dialog buffer with NAME, setup with FORMS."
(declare (indent 1) (debug t))
`(with-current-buffer (get-buffer-create ,name)
;; Cleanup buffer
(let ((inhibit-read-only t)
(ol (overlay-lists)))
(mapc 'delete-overlay (car ol))
(mapc 'delete-overlay (cdr ol))
(erase-buffer))
(recentf-dialog-mode)
,@forms
(widget-setup)
(switch-to-buffer (current-buffer))))
\f
;;; Edit list dialog
;;
(defvar recentf-edit-list nil)
(defun recentf-edit-list-select (widget &rest _ignore)
"Toggle a file selection based on the checkbox WIDGET state.
IGNORE other arguments."
(let ((value (widget-get widget :tag))
(check (widget-value widget)))
(if check
(add-to-list 'recentf-edit-list value)
(setq recentf-edit-list (delq value recentf-edit-list)))
(message "%s %sselected" value (if check "" "un"))))
(defun recentf-edit-list-validate (&rest _ignore)
"Process the recent list when the edit list dialog is committed.
IGNORE arguments."
(if recentf-edit-list
(let ((i 0))
(dolist (e recentf-edit-list)
(setq recentf-list (delq e recentf-list)
i (1+ i)))
(kill-buffer (current-buffer))
(message "%S file(s) removed from the list" i))
(message "No file selected")))
(defun recentf-edit-list ()
"Show a dialog to delete selected files from the recent list."
(interactive)
(unless recentf-list
(error "The list of recent files is empty"))
(recentf-dialog (format "*%s - Edit list*" recentf-menu-title)
(set (make-local-variable 'recentf-edit-list) nil)
(widget-insert
(format-message
"Click on OK to delete selected files from the recent list.
Click on Cancel or type `q' to cancel.\n"))
;; Insert the list of files as checkboxes
(dolist (item recentf-list)
(widget-create 'checkbox
:value nil ; unselected checkbox
:format "\n %[%v%] %t"
:tag item
:notify 'recentf-edit-list-select))
(widget-insert "\n\n")
(widget-create
'push-button
:notify 'recentf-edit-list-validate
:help-echo "Delete selected files from the recent list"
"Ok")
(widget-insert " ")
(widget-create
'push-button
:notify 'recentf-cancel-dialog
"Cancel")
(recentf-dialog-goto-first 'checkbox)))
\f
;;; Open file dialog
;;
(defun recentf-open-files-action (widget &rest _ignore)
"Open the file stored in WIDGET's value when notified.
IGNORE other arguments."
(kill-buffer (current-buffer))
(funcall recentf-menu-action (widget-value widget)))
;; List of files associated to a digit shortcut key.
(defvar recentf--files-with-key nil)
(defun recentf-show-digit-shortcut-filter (l)
"Filter the list of menu-elements L to show digit shortcuts."
(let ((i 0))
(dolist (e l)
(setq i (1+ i))
(recentf-set-menu-element-item
e (format "[%d] %s" (% i 10) (recentf-menu-element-item e))))
l))
(defun recentf-open-files-item (menu-element)
"Return a widget to display MENU-ELEMENT in a dialog buffer."
(if (consp (cdr menu-element))
;; Represent a sub-menu with a tree widget
`(tree-widget
:open t
:match ignore
:node (item :tag ,(car menu-element)
:sample-face bold
:format "%{%t%}:\n")
,@(mapcar 'recentf-open-files-item
(cdr menu-element)))
;; Represent a single file with a link widget
`(link :tag ,(car menu-element)
:button-prefix ""
:button-suffix ""
:button-face default
:format "%[%t\n%]"
:help-echo ,(concat "Open " (cdr menu-element))
:action recentf-open-files-action
;; Override the (problematic) follow-link property of the
;; `link' widget (bug#22434).
:follow-link nil
,(cdr menu-element))))
(defun recentf-open-files-items (files)
"Return a list of widgets to display FILES in a dialog buffer."
(set (make-local-variable 'recentf--files-with-key)
(recentf-trunc-list files 10))
(mapcar 'recentf-open-files-item
(append
;; When requested group the files with shortcuts together
;; at the top of the list.
(when recentf-show-file-shortcuts-flag
(setq files (nthcdr 10 files))
(recentf-apply-menu-filter
'recentf-show-digit-shortcut-filter
(mapcar 'recentf-make-default-menu-element
recentf--files-with-key)))
;; Then the other files.
(recentf-apply-menu-filter
recentf-menu-filter
(mapcar 'recentf-make-default-menu-element
files)))))
(defun recentf-open-files (&optional files buffer-name)
"Show a dialog to open a recent file.
If optional argument FILES is non-nil, it is a list of recently-opened
files to choose from. It defaults to the whole recent list.
If optional argument BUFFER-NAME is non-nil, it is a buffer name to
use for the dialog. It defaults to \"*`recentf-menu-title'*\"."
(interactive)
(unless (or files recentf-list)
(error "There is no recent file to open"))
(recentf-dialog (or buffer-name (format "*%s*" recentf-menu-title))
(widget-insert "Click on a file"
(if recentf-show-file-shortcuts-flag
", or type the corresponding digit key,"
"")
" to open it.\n"
(format-message "Click on Cancel or type `q' to cancel.\n"))
;; Use a L&F that looks like the recentf menu.
(tree-widget-set-theme "folder")
(apply 'widget-create
`(group
:indent 2
:format "\n%v\n"
,@(recentf-open-files-items (or files recentf-list))))
(widget-create
'push-button
:notify 'recentf-cancel-dialog
"Cancel")
(recentf-dialog-goto-first 'link)))
(defun recentf-open-more-files ()
"Show a dialog to open a recent file that is not in the menu."
(interactive)
(recentf-open-files (nthcdr recentf-max-menu-items recentf-list)
(format "*%s - More*" recentf-menu-title)))
(defun recentf-open-most-recent-file (&optional n)
"Open the Nth most recent file.
Optional argument N must be a valid digit number. It defaults to 1.
1 opens the most recent file, 2 the second most recent one, etc..
0 opens the tenth most recent file."
(interactive "p")
(cond
((zerop n) (setq n 10))
((and (> n 0) (< n 10)))
((error "Recent file number out of range [0-9], %d" n)))
(let ((file (nth (1- n) (or recentf--files-with-key recentf-list))))
(unless file (error "Not that many recent files"))
;; Close the open files dialog.
(when recentf--files-with-key
(kill-buffer (current-buffer)))
(funcall recentf-menu-action file)))
\f
;;; Save/load/cleanup the recent list
;;
(defconst recentf-save-file-header
";;; Automatically generated by `recentf' on %s.\n"
"Header to be written into the `recentf-save-file'.")
(defconst recentf-save-file-coding-system
(if (coding-system-p 'utf-8-emacs)
'utf-8-emacs
'emacs-mule)
"Coding system of the file `recentf-save-file'.")
(defun recentf-save-list ()
"Save the recent list.
Write data into the file specified by `recentf-save-file'."
(interactive)
(condition-case error
(with-temp-buffer
(erase-buffer)
(set-buffer-file-coding-system recentf-save-file-coding-system)
(insert (format-message recentf-save-file-header
(current-time-string)))
(recentf-dump-variable 'recentf-list recentf-max-saved-items)
(recentf-dump-variable 'recentf-filter-changer-current)
(insert "\n\f\n;; Local Variables:\n"
(format ";; coding: %s\n" recentf-save-file-coding-system)
";; End:\n")
(write-file (expand-file-name recentf-save-file))
(when recentf-save-file-modes
(set-file-modes recentf-save-file recentf-save-file-modes))
nil)
(error
(warn "recentf mode: %s" (error-message-string error)))))
(defun recentf-load-list ()
"Load a previously saved recent list.
Read data from the file specified by `recentf-save-file'.
When `recentf-initialize-file-name-history' is non-nil, initialize an
empty `file-name-history' with the recent list."
(interactive)
(let ((file (expand-file-name recentf-save-file))
;; We do not want Tramp asking for passwords.
(non-essential t))
(when (file-readable-p file)
(load-file file)
(and recentf-initialize-file-name-history
(not file-name-history)
(setq file-name-history (mapcar 'abbreviate-file-name
recentf-list))))))
(defun recentf-cleanup ()
"Cleanup the recent list.
That is, remove duplicates, non-kept, and excluded files."
(interactive)
(message "Cleaning up the recentf list...")
(let ((n 0)
(ht (make-hash-table
:size recentf-max-saved-items
:test 'equal))
newlist key)
(dolist (f recentf-list)
(setq f (recentf-expand-file-name f)
key (if recentf-case-fold-search (downcase f) f))
(if (and (recentf-include-p f)
(recentf-keep-p f)
(not (gethash key ht)))
(progn
(push f newlist)
(puthash key t ht))
(setq n (1+ n))
(message "File %s removed from the recentf list" f)))
(message "Cleaning up the recentf list...done (%d removed)" n)
(setq recentf-list (nreverse newlist))))
\f
;;; The minor mode
;;
(defvar recentf-mode-map (make-sparse-keymap)
"Keymap to use in recentf mode.")
;;;###autoload
(define-minor-mode recentf-mode
"Toggle \"Open Recent\" menu (Recentf mode).
With a prefix argument ARG, enable Recentf mode if ARG is
positive, and disable it otherwise. If called from Lisp, enable
Recentf mode if ARG is omitted or nil.
When Recentf mode is enabled, a \"Open Recent\" submenu is
displayed in the \"File\" menu, containing a list of files that
were operated on recently."
:global t
:group 'recentf
:keymap recentf-mode-map
(unless (and recentf-mode (recentf-enabled-p))
(if recentf-mode
(progn
(recentf-load-list)
(recentf-show-menu))
(recentf-hide-menu)
(recentf-save-list))
(recentf-auto-cleanup)
(let ((hook-setup (if recentf-mode 'add-hook 'remove-hook)))
(dolist (hook recentf-used-hooks)
(apply hook-setup hook)))))
(defun recentf-unload-function ()
"Unload the recentf library."
(recentf-mode -1)
;; continue standard unloading
nil)
(provide 'recentf)
(run-hooks 'recentf-load-hook)
\f
;;; recentf.el ends here
|