-
Notifications
You must be signed in to change notification settings - Fork 5
/
howm-vars.el
1285 lines (1109 loc) · 43.2 KB
/
howm-vars.el
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
;;; howm-vars.el --- Wiki-like note-taking tool
;;; Copyright (C) 2005-2024
;;; HIRAOKA Kazuyuki <kakkokakko@gmail.com>
;;;
;;; This program 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 1, or (at your option)
;;; any later version.
;;;
;;; This program 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.
;;;
;;; The GNU General Public License is available by anonymouse ftp from
;;; prep.ai.mit.edu in pub/gnu/COPYING. Alternately, you can write to
;;; the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139,
;;; USA.
;;--------------------------------------------------------------------
(require 'cl-lib)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Util
(defmacro howm-define-risky-command (risky orig)
"Define a macro RISKY which is risky-version of ORIG."
(let* ((gsymbol (cl-gensym))
(gargs (cl-gensym))
(docstring (format "Do `%s' and set risky-local-variable property."
orig)))
`(defmacro ,risky
(,gsymbol &rest ,gargs)
,docstring
(declare (indent 'defun))
(howm-define-risky-command-body ',orig ,gsymbol ,gargs))))
;; [2011-01-13]
;; I split this function from howm-define-risky-command for avoiding
;; nested backquotes. Nested backquotes are byte-compiled to
;; old-style-backquotes, that cause warnings when *.elc is loaded.
(cl-eval-when (compile load eval)
(defun howm-define-risky-command-body (command symbol args)
`(progn
(,command ,symbol ,@args)
(put ',symbol 'risky-local-variable t))))
;; ;; This code is byte-compiled to old-style-backquotes. Sigh...
;; (defmacro howm-define-risky-command (risky orig)
;; "Define a macro RISKY which is risky-version of ORIG."
;; (let* ((gsymbol (cl-gensym))
;; (gargs (cl-gensym))
;; (docstring (format "Do `%s' and set risky-local-variable property."
;; orig)))
;; `(progn
;; (put ',risky 'lisp-indent-hook 'defun)
;; (defmacro ,risky
;; (,gsymbol &rest ,gargs)
;; ,docstring
;; (let ((command ',orig)
;; (symbol ,gsymbol)
;; (args ,gargs))
;; `(progn
;; ;; (,',orig ...) doesn't work.
;; ;; So I need to bind temporal variables outside nested backquote.
;; (,command ,symbol ,@args)
;; (put ',symbol 'risky-local-variable t)))))))
(howm-define-risky-command howm-defvar-risky defvar)
(howm-define-risky-command howm-defcustom-risky defcustom)
(howm-define-risky-command howm-defconst-risky defconst)
;; ;; Should I use this?
;; (defmacro howm-boundp-q (var)
;; `(prog1
;; (boundp ,var)
;; (howm-dont-warn-free-variable ,var)))
(defmacro howm-dont-warn-free-variable (var)
"No effect except for inhibition of warning in byte-compilation.
Without this trick, compiler says 'reference to free variable' even when
we have checked availability like (if (boundp xxx) ...)."
`(when (boundp (quote ,var))
(defvar ,var nil)))
(defmacro howm-funcall-if-defined (call &rest not-defined)
"Execute CALL if its car is defined as a function.
Otherwise, execute expressions in NOT-DEFINED.
This is cheat to avoid warning while byte-compilation.
Byte-compiler says \"not known to be defined\" even for codes like
(if (fboundp 'foo) (foo bar)).
\(macroexpand '(howm-funcall-if-defined (migemo-get-pattern roma) nil))
==> (if (fboundp 'migemo-get-pattern)
(let ((howm-funcall-if-defined-f 'migemo-get-pattern))
(funcall howm-funcall-if-defined-f roma))
nil)
"
(declare (indent 1))
(let ((func (car call))
(args (cdr call)))
`(if (fboundp (quote ,func))
(let ((howm-funcall-if-defined-f (quote ,func)))
(funcall howm-funcall-if-defined-f ,@args))
,@not-defined)))
;; copied and modified from mule-cmds.el
;; snap:///usr/share/emacs/21.2/lisp/international/mule-cmds.el#1870:(defun set-locale-environment (locale-name)
(defun howm-get-locale ()
(let ((vars '("LC_ALL" "LC_CTYPE" "LANG"))
(locale nil))
(while (and vars (not (setq locale (getenv (car vars)))))
(setq vars (cdr vars)))
(or locale "")))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Top
(defgroup howm nil
"Wiki-like note-taking tool."
:group 'applications)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Compatibility
(defvar howm-compatible-to-ver1dot3 nil
"If non-nil, compatible values to howm-1.3.* are used
as default of some variables; put (setq howm-compatible-to-ver1dot3 t)
*before* (require 'howm) if you like.")
(defgroup howm-compatibility nil
"Compatibility to howm-1.3.*."
:group 'howm)
(defmacro howm-if-ver1dot3 (oldval def)
(declare (indent 1))
(cl-destructuring-bind (command var val &rest args) def
`(,command ,var (if howm-compatible-to-ver1dot3 ,oldval ,val)
,@args
:group 'howm-compatibility)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Files
(defgroup howm-files nil
"Names of files and directories."
:group 'howm)
(howm-defcustom-risky howm-directory "~/howm/"
"*All files under this directory are scanned recursively."
:type 'directory
:group 'howm-files)
(let ((default-format "%Y/%m/%Y-%m-%d-%H%M%S.txt"))
(howm-if-ver1dot3 "%Y/%m/%Y-%m-%d-%H%M%S.howm"
(defcustom howm-file-name-format default-format
"Name of new file. See `format-time-string'.
For example, set as \"%Y/%m/%Y-%m-%d-%H%M%S.txt\" to separate each entry
to its own file. You must guarantee (string< oldfile newfile)."
:type `(radio (const :tag "One file for one entry" ,default-format)
(const :tag "One file for one day" "%Y/%m/%Y-%m-%d.txt")
(const :tag "One file for one month" "%Y/%Y-%m.txt")
(const :tag "One file for one year" "%Y.txt")
string)
:group 'howm-efficiency
:group 'howm-files)))
(howm-defcustom-risky howm-keyword-file "~/.howm-keys"
"*Keywords (WikiNames) are stored in this file."
:type 'file
:group 'howm-files)
;; inhibit warning in compilation.
(howm-dont-warn-free-variable image-file-name-regexps)
(defvar howm-image-file-name-regexps
(let ((exts-regexp "\\.\\(GIF\\|JP\\(?:E?G\\)\\|P\\(?:BM\\|GM\\|NG\\|PM\\)\\|TIFF?\\|X\\(?:[BP]M\\)\\|gif\\|jp\\(?:e?g\\)\\|p\\(?:bm\\|gm\\|ng\\|pm\\)\\|tiff?\\|x\\(?:[bp]m\\)\\)\\'")
(image-file-name-regexps (and (boundp 'image-file-name-regexps)
image-file-name-regexps)))
;; copied from image-file-name-regexp.
(if image-file-name-regexps
(mapconcat 'identity
(if exts-regexp
(cons exts-regexp image-file-name-regexps)
image-file-name-regexps)
"\\|")
exts-regexp))
"Regular expression that matches image-file filenames.
Default value is equal to the result of `image-file-name-regexp'
on GNU Emacs 21.2.1.
In order to use `image-file-name-regexp' on Meadow 2.10 (ASAGAO),
max-specpdl-size must be increased from the default value 600.
Otherwise, an error occurs both in byte-compilation and in run time.
To avoid such troubles, this variable is prepared as a fixed string.")
(defvar howm-excluded-dirs '("RCS" "CVS" ".svn" ".git" "_darcs"))
(defvar howm-excluded-file-regexp-common-list
(list "[~#]$"
"\\.\\(bak\\|elc\\|gz\\|aux\\|toc\\|idx\\|dvi\\)$"
howm-image-file-name-regexps))
(defvar howm-excluded-file-regexp-dir-sep
(if (let ((case-fold-search t))
(string-match "windows" (symbol-name system-type)))
"[/\\\\]" ;; / or \ for win
"/")) ;; / otherwise
(let ((dir-head (concat "\\(^\\|" howm-excluded-file-regexp-dir-sep "\\)"))
(excluded-dirs (concat (regexp-opt howm-excluded-dirs t)
howm-excluded-file-regexp-dir-sep)))
(let ((howm-excluded-file-regexp-dots-ok
(mapconcat #'identity
`(,(concat dir-head excluded-dirs)
"^[.][.]"
,@howm-excluded-file-regexp-common-list)
"\\|"))
(howm-excluded-file-regexp-dots-ng
(mapconcat #'identity
`(,(concat dir-head "\\([.]\\|" excluded-dirs "\\)")
,@howm-excluded-file-regexp-common-list)
"\\|")))
(howm-defcustom-risky howm-excluded-file-regexp
howm-excluded-file-regexp-dots-ng
"Regexp for excluded files.
It is checked for relative paths from howm-directory and howm-search-path.
A file is excluded iff this regexp matches with all the relative paths."
:type `(radio (const :tag "Don't search dot files"
,howm-excluded-file-regexp-dots-ng)
(const :tag "Search dot files"
,howm-excluded-file-regexp-dots-ok)
regexp)
:group 'howm-files
)))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Menu
(defgroup howm-menu nil
"Menu."
:group 'howm)
(defcustom howm-menu-lang
(let ((lang-table '((fr "French" "^fr")
(ja "Japanese" "^ja"))))
(let ((lang (or (and (boundp 'current-language-environment)
current-language-environment)
""))
(locale (howm-get-locale))
(ret 'en))
(mapc (lambda (rule)
(if (or (string= lang (cadr rule))
(string-match (cl-caddr rule) locale))
(setq ret (car rule))))
lang-table)
ret))
"*Language of menu."
:type '(radio (const en) (const fr) (const ja))
:group 'howm-menu)
(howm-defcustom-risky howm-menu-file nil
"*Specify menu file explicitly, or set as nil to search every time."
:type '(radio (const :tag "Search every time" nil)
(const "0000-00-00-000000.txt")
file)
:group 'howm-files
:group 'howm-efficiency
:group 'howm-menu)
(defcustom howm-menu-expiry-hours 0
"*Cache menu contents for this number of hours."
:type 'number
:group 'howm-efficiency
:group 'howm-menu)
(defcustom howm-menu-refresh-after-save t
"*If non-nil, refresh menu contents after you save howm note."
:type 'boolean
:group 'howm-efficiency
:group 'howm-menu)
(defcustom howm-menu-name-format "*howmM:%s*"
"*Name format of menu buffer."
:type '(radio (const :tag "Never show in normal buffer list" " *howmM:%s*")
string)
:group 'howm-menu)
(defcustom howm-menu-footer nil
"Footer string for each menu. Nil means no footer."
:type '(radio (const :tag "Off" nil)
string)
:group 'howm-menu)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Reminder
(defgroup howm-reminder nil
"Schedule and todo list."
:group 'howm)
(defvar howm-reminder-old-format nil)
(defvar howm-reminder-marks
;; Be careful to order of characters.
;; "-" must be first so that regexp "[-+~!@.]" makes sense.
(if howm-reminder-old-format "-+~!@. " "-+~!@."))
(defvar howm-reminder-types
(format "[%s]" howm-reminder-marks))
(defun howm-custom-reminder-get-types (symbol)
(let ((reg (default-value symbol))
(default-types (split-string howm-reminder-marks "")))
;; return list of types for standard cases
;; and string itself for nonstandard cases
(if (not (string-match "^\\[\\(.*\\)\\]" reg))
reg
(let ((types (split-string (match-string-no-properties 1 reg) "")))
(if (cl-find-if-not (lambda (x) (member x default-types))
types)
reg
(cl-remove-if-not (lambda (x) (member x types))
default-types))))))
(defun howm-custom-reminder-set-types (symbol types)
(when (listp types)
(setq types (apply #'concat `("[" ,@types "]"))))
(set-default symbol types))
(defun howm-custom-reminder-list-types ()
`(radio (set ,@(mapcar (lambda (ty) (list 'const ty))
(split-string howm-reminder-marks "")))
string))
(defcustom howm-schedule-types "[!@.]"
"*Regular expression of reminder types which are listed as schedule."
:get #'howm-custom-reminder-get-types
:set #'howm-custom-reminder-set-types
:type (howm-custom-reminder-list-types)
:group 'howm-efficiency
:group 'howm-reminder)
(defcustom howm-todo-types
(if howm-reminder-old-format "[-+~! .]" "[-+~!.]")
"*Regular expression of reminder types which are listed as todo."
:get #'howm-custom-reminder-get-types
:set #'howm-custom-reminder-set-types
:type (howm-custom-reminder-list-types)
:group 'howm-efficiency
:group 'howm-reminder)
(defcustom howm-congrats-format '("Finished %s tasks!")
"List of format strings to generate message when a reminder is finished.
One of elements is chosen randomly every time."
:type '(repeat string)
:group 'howm-reminder)
(howm-defcustom-risky howm-congrats-command nil
"*If non-nil, this command is executed when a reminder is finished.
Example: (\"play\" \"~/sound/fanfare.wav\") for calling the command
\"play ~/sound/fanfare.wav\"."
:type '(repeat string)
:group 'howm-reminder)
(defcustom howm-reminder-cancel-string "cancel"
"*This string is inserted automatically when a reminder is canceled."
:type 'string
:group 'howm-reminder)
(defcustom howm-action-lock-forward-save-buffer nil
"*Non nil if direct manipulation on reminder list should cause auto-save."
:type 'boolean
:group 'howm-reminder)
(defcustom howm-action-lock-forward-kill-buffer nil
"*Non nil if direct manipulation on reminder list should cause kill-buffer.
Be careful that you cannot undo the result of action-lock after kill-buffer."
:type 'boolean
:group 'howm-reminder)
(howm-if-ver1dot3 0
(defcustom howm-action-lock-forward-fuzziness 5
"*Maximum lines of permitted inconsistency for `howm-action-lock-forward'."
:type 'integer
:group 'howm-reminder))
(let* ((sep "- - - - - - - - - - - - - - - - - - -")
(reminder-default `((-1 . ,sep) (0 . ,sep) (nil . ,sep)))
(todo-default `((0 . ,sep) (nil . ,sep))))
(howm-if-ver1dot3 nil
(defcustom howm-menu-reminder-separators reminder-default
"Assoc list to specify positions and strings of separators in reminder
in menu. For each element, car is days from now, and cdr is separator string.
If car is nil, it means the border between schedule and todo.
This option is prepared for `howm-menu-reminder'."
:type `(radio (const :tag "No separators" nil)
(const :tag "Default separators" ,reminder-default)
(alist :key-type
(radio number
(const :tag "Between schedule and todo" nil))
:value-type string))
:group 'howm-reminder))
(defcustom howm-todo-separators nil
"Assoc list to specify positions and strings of separators in todo buffer.
For each element, car is priority and cdr is separator string.
If car is nil, it means the border between active and sleeping reminders."
:type `(radio (const :tag "No separators" nil)
(const :tag "Default separators" ,todo-default)
(alist :key-type number
:value-type string))
:group 'howm-reminder))
(howm-if-ver1dot3 nil
(defcustom howm-schedule-sort-by-time t
"Non nil if `howm-schedule-sort-converter' should consider time part."
:type 'boolean
:group 'howm-reminder))
(defcustom howm-reminder-menu-types
(if howm-reminder-old-format "[-+~!@ ]" "[-+~!@]")
"*Regular expression of reminder types which are shown in menu."
:get #'howm-custom-reminder-get-types
:set #'howm-custom-reminder-set-types
:type (howm-custom-reminder-list-types)
:group 'howm-reminder)
;;;
;;; Menu reminder
;;;
(defgroup howm-menu-reminder nil
"Reminders shown in menu."
:group 'howm-menu
:group 'howm-reminder)
(defcustom howm-schedule-menu-types "[!@]"
"*Regular expression of reminder types which are shown in menu as schedule."
:get #'howm-custom-reminder-get-types
:set #'howm-custom-reminder-set-types
:type (howm-custom-reminder-list-types)
:group 'howm-efficiency
:group 'howm-menu-reminder)
(defcustom howm-todo-menu-types
(if howm-reminder-old-format "[-+~! .]" "[-+~!.]")
"*Regular expression of reminder types which are shown in menu as todo."
:get #'howm-custom-reminder-get-types
:set #'howm-custom-reminder-set-types
:type (howm-custom-reminder-list-types)
:group 'howm-efficiency
:group 'howm-menu-reminder)
(defcustom howm-menu-schedule-days 7
"*Show schedule in menu until this number of days from now."
:type 'number
:group 'howm-menu-reminder)
(defcustom howm-menu-schedule-days-before 0
"*Show schedule in menu from this number of days ago."
:type 'number
:group 'howm-menu-reminder)
(defcustom howm-menu-todo-num 50
"*Maximum number of todo items shown in menu."
:type 'number
:group 'howm-menu-reminder)
(defvar howm-huge- 66666)
(defvar howm-huge 77777)
(defvar howm-huge+ 88888)
(defvar howm-huge++ 99999)
(defcustom howm-menu-todo-priority (- howm-huge+)
"*Limit priority for elimination of reminders in menu."
:type `(radio (const :tag "Show sleeping reminders",(- howm-huge+))
(const :tag "Hide sleeping reminders" ,(- howm-huge-))
number)
:group 'howm-menu-reminder)
(defcustom howm-todo-priority-done-bottom (- howm-huge+)
"*Base priority of done reminder.
<priority of done reminder> = <this value> + <days from specified date>"
:type `(radio (const :tag "Deeper than sleeping reminders" ,(- howm-huge+))
(const :tag "Shallower than sleeping reminders"
,(- howm-huge-))
number)
:group 'howm-menu-reminder)
(defcustom howm-menu-recent-num 20
"*Maximum number of recent items shown in menu."
:type 'number
:group 'howm-menu-reminder)
(defcustom howm-menu-recent-regexp nil
"Regexp which is regarded as title line in recent list in menu.
When it is nil, `howm-view-title-regexp' is used."
:type '(radio (const :tag "Default" nil)
regexp)
:group 'howm-title
:group 'howm-menu-reminder)
(defcustom howm-menu-todo-priority-format nil
"*Format for priority display in todo list in menu, or nil for no display."
:type '(radio (const :tag "Off" nil)
(const "(%8.1f)")
string)
:group 'howm-devel
:group 'howm-menu-reminder)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; List
(defgroup howm-list nil
"Style of list view."
:group 'howm)
(defcustom howm-view-contents-limit nil
"*Max length for howm-view-contents. Nil means no limit."
:type '(radio (const :tag "No limit" nil)
integer)
:group 'howm-list)
(defcustom howm-view-summary-keep-cursor t
"*If non-nil, keep cursor position when you open a note from summary list."
:type 'boolean
:group 'howm-list)
(defcustom howm-view-summary-omit-same-name t
"*If non-nil, same name is not written repeatedly in summary list."
:type 'boolean
:group 'howm-list)
(defcustom howm-list-recent-days 7
"*This number of days are listed by `howm-list-recent'."
:type 'integer
:group 'howm-list)
(defcustom howm-list-buffers-exclude
'("*Messages*" ".howm-keys" ".howm-history")
"*List of excluded buffer names for `howm-list-buffers'."
:type '(repeat string)
:group 'howm-list)
;;
;; Sort
;;
(defgroup howm-sort nil
"Sorting and filtering of matched entries."
:group 'howm-list)
(howm-defcustom-risky howm-list-normalizer nil
"*Obsolete. Use `howm-normalizer' insteadly."
:type '(radio (const :tag "Off (strongly recommended)" nil)
(function-item :tag "Sort by edit-time"
howm-view-sort-by-mtime)
(function-item :tag "Sort by create-time"
howm-view-sort-by-reverse-date)
function)
:group 'howm-sort)
(howm-defcustom-risky howm-normalizer 'howm-sort-items-by-mtime
"*Default method to list matched notes.
For backward compatibility, this value is overridden
if `howm-list-normalizer' is non-nil."
:type '(radio (function-item :tag "Sort by edit-time"
howm-sort-items-by-mtime)
(function-item :tag "Sort by create-time"
howm-sort-items-by-reverse-date)
function)
:group 'howm-sort)
(defcustom howm-list-prefer-word nil
"*Matches to whole word are listed first in summary buffer."
:type 'boolean
:group 'howm-sort)
(defcustom howm-list-prefer-wiki t
"*Matches to wiki tags are listed first in summary buffer."
:type 'boolean
:group 'howm-sort)
;;
;; Title
;;
(defgroup howm-title nil
"Title of each entry."
:group 'howm-list)
;; I don't know the way to generate this list automatically. Sigh...
(defvar howm-custom-command-list
`(set ,@(mapcar (lambda (com) (list 'const com))
'(howm-list-all
howm-list-recent
howm-list-around
howm-keyword-search
howm-list-grep
howm-list-grep-fixed
howm-list-migemo
howm-list-related
howm-action-lock-date-search
))))
(howm-defcustom-risky howm-list-title
'(
howm-list-all
howm-list-recent
howm-list-around
; howm-keyword-search
; howm-list-grep howm-list-grep-fixed howm-list-migemo
; howm-list-related
howm-action-lock-date-search
)
"List of commands in which titles are listed instead of matched lines.
T means 'always'.
If it is a function, the evaluated value is used instead of itself."
:type `(radio (const :tag "Always" t)
(const :tag "Never" nil)
,howm-custom-command-list
;; (set (const howm-list-all)
;; (const howm-list-recent)
;; (const howm-list-around)
;; (const howm-keyword-search)
;; (const howm-list-grep)
;; (const howm-list-grep-fixed)
;; (const howm-list-migemo)
;; (const howm-list-related))
function)
:group 'howm-efficiency
:group 'howm-title)
(defcustom howm-list-title-regexp nil
"Regexp which is regarded as title line in summary buffer.
When it is nil, `howm-view-title-regexp' is used."
:type '(radio (const :tag "Default" nil)
regexp)
:group 'howm-title)
(defcustom howm-list-title-undo t
"*Non-nil if `howm-list-toggle-title' should toggle whether title is shown
or not."
:type 'boolean
:group 'howm-efficiency
:group 'howm-title)
;;
;; BufWin
;;
(defgroup howm-list-bufwin nil
"Buffers and windows for listing search result."
:group 'howm-list)
(defcustom howm-view-summary-name "*howmS*"
"Format string of buffer name for summary.
%s is replaced with searched string. See `format'."
:type '(radio (const :tag "Use one common buffer" "*howmS*")
(const :tag "Make new buffer for each search" "*howmS:%s*")
string)
:group 'howm-list-bufwin)
(defcustom howm-view-contents-name "*howmC*"
"Format string of buffer name for contents.
%s is replaced with searched string. See `format'."
:type '(radio (const :tag "Use one common buffer" "*howmC*")
(const :tag "Make new buffer for each search" "*howmC:%s*")
string)
:group 'howm-list-bufwin)
(howm-defcustom-risky howm-view-summary-persistent t
"*If non-nil, keep summary buffer on howm-view-summary-open by default.
If it is a function, the evaluated value is used instead of itself."
:type 'boolean
:group 'howm-list-bufwin)
(howm-defcustom-risky howm-view-contents-persistent t
"*If non-nil, keep contents buffer on howm-view-contents-open by default.
If it is a function, the evaluated value is used instead of itself."
:type 'boolean
:group 'howm-list-bufwin)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Search
(defgroup howm-search nil
"Search methods."
:group 'howm)
(defcustom howm-keyword-case-fold-search nil
"*Non-nil if searches of come-from keywords should ignore case."
:type 'boolean
:group 'howm-search)
(defcustom howm-check-word-break nil
"*Non-nil if come-from keywords within a word should not linked.
When the value is a string (regexp), word breaks are checked
only for matched keywords. "
:type '(radio (const :tag "Always" t)
(const :tag "Never" nil)
(const :tag "ASCII only" "^[[:ascii:]]+$")
string)
:group 'howm-search)
(defcustom howm-view-update-search-ring nil
"*Non-nil if search-ring should be updated in howm search."
:type 'boolean
:group 'howm-search)
(defcustom howm-message-time nil
"*Non nil if search etc. should show took time."
:type 'boolean
:group 'howm-devel
:group 'howm-search)
(howm-defcustom-risky howm-history-file "~/.howm-history"
"*Search history is recorded to that file."
:type 'file
:group 'howm-files
:group 'howm-search)
(defcustom howm-history-limit 50
"*Limit number of recorded search history, or nil for no limit.
Set 0 to inhibit recording."
:type '(radio (const :tag "No limit" nil)
integer)
:group 'howm-search)
(defcustom howm-history-unique t
"*If non-nil, duplicated entries are removed from search history."
:type 'boolean
:group 'howm-search)
(defcustom howm-keyword-list-alias-sep "\t"
"*Separator string for alias keywords in the keyword file `howm-keyword-file'.
If it is nil, alias of come-from keyword is disabled."
:type '(radio (const :tag "Disable aliases" nil)
(const :tag "Tab" "\t")
string)
:group 'howm-search)
(defcustom howm-keyword-aliases-recursive t
"*Non nil if aliases of come-from keywords should be expanded recursively."
:type 'boolean
:group 'howm-search)
;;;
;;; grep
;;;
(defgroup howm-grep nil
"Use external grep command for fast search."
:group 'howm-efficiency
:group 'howm-search)
(howm-defcustom-risky howm-view-use-grep nil
"*If non-nil, use external grep command for search.
Performance must be improved greatly if you set this.
When the value is elisp function, it is used instead of `howm-fake-grep'."
:type '(radio (const :tag "On" t)
(const :tag "Off" nil)
function)
:group 'howm-grep)
;; These variables should be renamed: howm-view-xxx ==> howm-xxx.
(howm-defcustom-risky howm-view-grep-command "grep"
"*Command name for grep."
:type 'string
:group 'howm-grep)
(howm-defvar-risky howm-view-fgrep-command nil
"*Command name for fgrep.
This variable is obsolete and may be removed in future.")
(defvar howm-view-grep-default-option
;; "labels" causes a trouble in git-head emacs (d5e3922) [2015-01-31]
(let* ((ed (lambda (d) (concat "--exclude-dir=" d)))
(has-ed (condition-case nil
(eq 0 (call-process howm-view-grep-command nil nil nil
(apply ed "/") "--version"))
(error nil)))
(opts (cons "-Hnr" (and has-ed (mapcar ed howm-excluded-dirs)))))
(mapconcat #'identity opts " ")))
(howm-defcustom-risky howm-view-grep-option howm-view-grep-default-option
"*Common grep option for howm."
:type `(radio (const :tag "scan all files"
,howm-view-grep-default-option)
(const :tag "scan *.howm only"
,(concat howm-view-grep-default-option
" --include=*.howm"))
string)
:group 'howm-grep)
(howm-defcustom-risky howm-view-grep-extended-option "-E"
"*Grep option for extended regular expression."
:type 'string
:group 'howm-grep)
(howm-defcustom-risky howm-view-grep-fixed-option "-F"
"*Grep option to search fixed strings."
:type 'string
:group 'howm-grep)
(howm-defcustom-risky howm-view-grep-ignore-case-option "-i"
"*Grep option for ignoring case distinctions."
:type 'string
:group 'howm-grep)
(howm-defcustom-risky howm-view-grep-expr-option "-e"
"*Grep option for pattern."
:type 'string
:group 'howm-grep)
(howm-defcustom-risky howm-view-grep-file-stdin-option "-f -"
"*Grep option for receiving patterns from standard input.
If this is nil, pattern is received as command line argument."
:type '(radio (const :tag "Off" nil)
string)
:group 'howm-grep)
(howm-defcustom-risky howm-command-length-limit 10000
"*Maximum length of command line for call-process."
:type 'integer
:group 'howm-grep)
(defcustom howm-process-coding-system nil
"*Default coding system for grep command in howm.
If the value is a symbol, it is used for both read and write.
If the value is a cons pair, its car and cdr are used for read and write,
respectively.
Example:
(setq howm-process-coding-system 'euc-japan-unix)
(setq howm-process-coding-system '(utf-8-unix . sjis-unix))"
:type '(radio (const :tag "Off" nil)
coding-system
(cons coding-system coding-system))
:group 'howm-grep)
(howm-if-ver1dot3 nil
(defcustom howm-occur-force-fake-grep t
"*If non-nil, force `howm-occur' to use `howm-fake-grep'
so that highlighting works correctly."
:type 'boolean
:group 'howm-grep))
(defgroup howm-iigrep nil
"Show search results on the fly before hitting RET."
:group 'howm-grep)
(defcustom howm-iigrep-preview-items 20
"Show howm search results on the fly before hitting RET when the hit counts are within this number."
:type 'integer
:group 'howm-efficiency
:group 'howm-iigrep)
(defcustom howm-iigrep-show-what 'counts
"Show search results on the fly before hitting RET."
:type '(radio (const :tag "Off" nil)
(const :tag "Counts" counts)
(const :tag "Contents" contents)
(const :tag "Full" full))
:group 'howm-efficiency
:group 'howm-iigrep)
(defcustom howm-iigrep-migemo-show-what 'inherit
"Show migemo search results on the fly before hitting RET."
:type '(radio (const :tag "Inherit howm-iigrep-show-what" inherit)
(const :tag "Counts" counts)
(const :tag "Contents" contents)
(const :tag "Full" full))
:group 'howm-efficiency
:group 'howm-iigrep)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Misc
(defgroup howm-misc nil
"Miscellaneous customization."
:group 'howm)
(defvar howm-prefix "\C-c,"
"Howm commands are invoked by this prefix + some keys.")
(defcustom howm-random-walk-wait 2
"*Seconds of wait in `howm-random-walk'."
:type 'number
:group 'howm-misc)
(defcustom howm-remember-insertion-format "%s\n"
"*Format for insertion of the input text in `howm-remember'."
:type '(radio (const :tag "Blank line after the text." "%s\n")
(const :tag "No Blank line after the text." "%s")
string)
:group 'howm-misc)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Create
(defgroup howm-create nil
"Create new note."
:group 'howm-misc)
(defcustom howm-prepend nil
"*Non nil if new entries should be prepended to previous entries.
Otherwise, they are appended."
:type '(radio (const :tag "Append" nil)
(const :tag "Prepend" t))
:group 'howm-create)
(defcustom howm-content-from-region nil
"*When the value non-nil, selected string is inserted as default content.
Unless the value is t, single-line selection is inserted as title instead.
This variable is ignored when `transient-mark-mode' is nil."
:type '(radio (const :tag "Off" nil)
(const :tag "Single line selection is copied as title" 1)
(const :tag "Any selection is copied as content" t))
:group 'howm-create)
(defcustom howm-title-from-search nil
"*Non nil if searched keyword is inserted as default title
when `howm-create' is called on summary buffer."
:type 'boolean
:group 'howm-create)
(defcustom howm-create-here-just nil
"*Non nil if `howm-create-here' should insert new entry into cursor position
rather than append or prepend."
:type '(radio (const :tag "Append or prepend" nil)
(const :tag "Just here" t))
:group 'howm-create)
(defcustom howm-remember-first-line-to-title nil
"If non-nil, the first line in `howm-remember' is set to %title
and the rest lines are inserted to the position at %cursor in `howm-template.
If nil, all the lines are simply inserted at %cursor."
:type 'boolean
:group 'howm-create)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Viewer
(defgroup howm-viewer nil
"External viewers for images, movies, sounds, etc."
:group 'howm-misc)
(defun howm-try-require (feature)
(and (locate-library (symbol-name feature))
(require feature)))
;; These variables should be renamed.
(howm-defcustom-risky howm-view-external-viewer-assoc nil
"List of viewer specifications.
Each specification must be a cons pair of type and format.
Type is a regular expression of file names.
Format is a command string in which %s is replaced with file name.
This setting is prior to mailcap.
This variable is marked as a risky local variable
because `howm-viewer-dispatchers' `howm-viewer-indicator'
and `howm-viewer-type' accept functions instead of format strings.
Example:
(setq howm-view-external-viewer-assoc
'(
(\"[.]\\(jpg\\|gif\\|png\\)$\" . \"display %s\")
(\"[.]dvi$\" . \"xdvi %s\")
))
"
:type '(alist :key-type regexp :value-type string)
:group 'howm-viewer)
(defcustom howm-view-use-mailcap
(and (howm-try-require 'mailcap)
(fboundp 'mailcap-parse-mailcaps)
(fboundp 'mailcap-parse-mimetypes))
"*Non nil if external viewers should be selected according to mailcap.
Mailcap processing depends on gnus/mailcap, and old FLIM library may
cause conflicts."
:type 'boolean
:group 'howm-viewer)
(defcustom howm-view-open-by-myself '("text/.*" "application/emacs-lisp")
"List of regular expressions for mime types which should be opened normally."
:type '(repeat regexp)
:group 'howm-viewer)
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Narrow
(defgroup howm-narrow nil
"Narrowing to each entry."
:group 'howm-misc)
(defcustom howm-auto-narrow t
"List of commands after which the function `howm-auto-narrow' can work.
If the value is t, it means 'always'."
:type `(radio (const :tag "Never" nil)
(const :tag "Always" t)
,howm-custom-command-list)
:group 'howm-narrow)
(mapc (lambda (hook) (custom-add-option hook 'howm-auto-narrow))
'(howm-view-open-hook howm-create-hook))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;; Efficiency
(defgroup howm-efficiency nil
"To improve performance, use grep and turn off expensive options."
:group 'howm)