blob: 7238e81606898c848598a2f53cab7cf095a0a838 (
plain) (
blame)
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
|
;;; org-bullets.el --- Show bullets in org-mode as UTF-8 characters
;; Version: 0.2.4
;; Package-Version: 20171127.526
;; Author: sabof
;; Maintainer: Jonas Bernoulli <jonas@bernoul.li>
;; Homepage: https://github.com/emacsorphanage/org-bullets
;; This file is NOT part of GNU Emacs.
;; This file 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, or (at your option)
;; any later version.
;; This file 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.
;; For a full copy of the GNU General Public License
;; see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; Show org-mode bullets as UTF-8 characters.
;; Because the author is inactive, this package is currenlty being
;; maintained at https://github.com/emacsorphanage/org-bullets.
;;; Code:
(defgroup org-bullets nil
"Display bullets as UTF-8 characters."
:group 'org-appearance)
;; A nice collection of unicode bullets:
;; http://nadeausoftware.com/articles/2007/11/latency_friendly_customized_bullets_using_unicode_characters
(defcustom org-bullets-bullet-list
'(;;; Large
"◉"
"○"
"✸"
"✿"
;; ♥ ● ◇ ✚ ✜ ☯ ◆ ♠ ♣ ♦ ☢ ❀ ◆ ◖ ▶
;;; Small
;; ► • ★ ▸
)
"List of bullets used in Org headings.
It can contain any number of symbols, which will be repeated."
:group 'org-bullets
:type '(repeat (string :tag "Bullet character")))
(defcustom org-bullets-face-name nil
"Face used for bullets in Org mode headings.
If set to the name of a face, that face is used.
Otherwise the face of the heading level is used."
:group 'org-bullets
:type 'symbol)
(defvar org-bullets-bullet-map
(let ((map (make-sparse-keymap)))
(define-key map [mouse-1] 'org-cycle)
(define-key map [mouse-2] 'org-bullets-set-point-and-cycle)
map)
"Mouse events for bullets.
Should this be undesirable, one can remove them with
\(setcdr org-bullets-bullet-map nil\)")
(defun org-bullets-set-point-and-cycle (event)
"Set `point' and where the user clicked and call `org-cycle'."
(interactive "e")
(mouse-set-point e)
(org-cycle))
(defun org-bullets-level-char (level)
(string-to-char
(nth (mod (1- level)
(length org-bullets-bullet-list))
org-bullets-bullet-list)))
(defvar org-bullets--keywords
`(("^\\*+ "
(0 (let* ((level (- (match-end 0) (match-beginning 0) 1))
(is-inline-task
(and (boundp 'org-inlinetask-min-level)
(>= level org-inlinetask-min-level))))
(compose-region (- (match-end 0) 2)
(- (match-end 0) 1)
(org-bullets-level-char level))
(when is-inline-task
(compose-region (- (match-end 0) 3)
(- (match-end 0) 2)
(org-bullets-level-char level)))
(when (facep org-bullets-face-name)
(put-text-property (- (match-end 0)
(if is-inline-task 3 2))
(- (match-end 0) 1)
'face
org-bullets-face-name))
(put-text-property (match-beginning 0)
(- (match-end 0) 2)
'face (list :foreground
(face-attribute
'default :background)))
(put-text-property (match-beginning 0)
(match-end 0)
'keymap
org-bullets-bullet-map)
nil)))))
;;;###autoload
(define-minor-mode org-bullets-mode
"Use UTF8 bullets in Org mode headings."
nil nil nil
(if org-bullets-mode
(progn
(font-lock-add-keywords nil org-bullets--keywords)
(org-bullets--fontify-buffer))
(save-excursion
(goto-char (point-min))
(font-lock-remove-keywords nil org-bullets--keywords)
(while (re-search-forward "^\\*+ " nil t)
(decompose-region (match-beginning 0) (match-end 0)))
(org-bullets--fontify-buffer))))
(defun org-bullets--fontify-buffer ()
(when font-lock-mode
(if (and (fboundp 'font-lock-flush)
(fboundp 'font-lock-ensure))
(save-restriction
(widen)
(font-lock-flush)
(font-lock-ensure))
(with-no-warnings
(font-lock-fontify-buffer)))))
(provide 'org-bullets)
;; Local Variables:
;; indent-tabs-mode: nil
;; End:
;;; org-bullets.el ends here
|
