blob: 22039ca6c70c00fa9d1597439691af39c360b375 (
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
|
;;; hl-sentence-length.el --- Highlights sentences by word count
;; Copyright (C) 2022 Ferdinand Pieper
;; Author: Ferdinand Pieper <mail@pie.tf>
;; URL: https://github.com/fpiper/hl-sentence-length
;; 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 2, 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.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, see
;; <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; Minor mode to highlight sentences based on the number of words.
;; This is intended to help writers focus on varying their sentence
;; lengths. By default it cycles trough eight different colors. To
;; increase this set `hl-sentence-length-cycle' and define new
;; additional faces. To change the clustering of word lengths
;; customize `hl-sentence-length-roughness'.
;;
;;; Code:
(defface hl-sentence-length-face-1
'((t (:background "#7d9fb2")))
"Face for sentences of length 1.")
(defface hl-sentence-length-face-2
'((t (:background "#d5b195")))
"Face for sentences of length 2.")
(defface hl-sentence-length-face-3
'((t (:background "#6f9e91")))
"Face for sentences of length 3.")
(defface hl-sentence-length-face-4
'((t (:background "#cc8fb1")))
"Face for sentences of length 4.")
(defface hl-sentence-length-face-5
'((t (:background "#a3d0e9")))
"Face for sentences of length 5.")
(defface hl-sentence-length-face-6
'((t (:background "#e6d1a1")))
"Face for sentences of length 6.")
(defface hl-sentence-length-face-7
'((t (:background "#f0eba8")))
"Face for sentences of length 7.")
(defface hl-sentence-length-face-8
'((t (:background "#707070")))
"Face for sentences of length 8.")
(defvar hl-sentence-length-cycle 8
"Number of faces to cycle trough.")
(defvar hl-sentence-length-roughness 3
"Size of groups to cluster sentence lengths into.")
(defun hl-sentence-length-sentence-beginning ()
"Return point at beginning of the current sentence."
(save-excursion
(backward-sentence)
(point)))
(defun hl-sentence-length-sentence-end ()
"Return point at end of the current sentence."
(save-excursion
(backward-sentence)
(forward-sentence)
(point)))
(defun hl-sentence-length-sentence-length ()
"Return length of current sentence."
(save-mark-and-excursion
(backward-sentence)
(set-mark (point))
(forward-sentence)
(count-words-region (region-beginning) (region-end))))
(defun hl-sentence-length-sentence-face ()
"Return the appropriate face for the current sentence."
(let* ((length (hl-sentence-length-sentence-length))
(modulo (mod
(+ 1 (/ (- length 1) hl-sentence-length-roughness))
hl-sentence-length-cycle))
(facenumber (if (eq modulo 0)
hl-sentence-length-cycle
modulo)))
(intern (format "hl-sentence-length-face-%i" facenumber))))
(defun hl-sentence-length-highlight-sentence ()
"Highlight the current sentence based on its length."
(let ((face (hl-sentence-length-sentence-face))
(overlay (make-overlay (hl-sentence-length-sentence-beginning) (hl-sentence-length-sentence-end))))
(overlay-put overlay 'origin 'hl-sentence-length)
(overlay-put overlay 'face face)))
(define-minor-mode hl-sentence-length-mode
"Highlight the word count of sentences."
nil nil nil
(if hl-sentence-length-mode
(add-hook 'post-command-hook 'hl-sentence-length-update nil t)
(progn
(remove-hook 'post-command-hook 'hl-sentence-length-update t)
(hl-sentence-length-remove-highlights))))
(defun hl-sentence-length-create-highlights ()
(save-mark-and-excursion
(let ((pmax (point-max)))
(beginning-of-buffer)
(while (< (point) pmax)
(forward-sentence)
(hl-sentence-length-highlight-sentence)))))
(defun hl-sentence-length-remove-highlights ()
(remove-overlays nil nil 'origin 'hl-sentence-length))
(defun hl-sentence-length-update ()
"Update the highlighted sentence lengths."
;; FIXME There is probably a better way to do this.
(hl-sentence-length-remove-highlights)
(hl-sentence-length-create-highlights))
(provide 'hl-sentence-length)
;;; hl-sentence-length.el ends here
|
