summaryrefslogtreecommitdiff
path: root/text-conf.el
blob: c8bc566b34568dc01be769cc005b7df9fae4c998 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
;;; text-conf.el --- My configurations about plain text files. -*- lexical-binding: t; -*-

(require 'text-mode)
(require 'rx)

;; (declare-function #'center-buffer-on "center-buffer" nil)
;; (declare-function #'center-buffer-off "center-buffer" nil)
;; (declare-function #'center-buffer-toggle "center-buffer" nil)

;; (define-key text-mode-map (vector 'f8) nil)

;;; Insert section heading

;;;###autoload
(defvar insert-section-heading-history nil
  "The history of inserted section heading strings")

;;;###autoload
(defun insert-section-heading (custom-heading)
  "Insert a heading line below.

If CUSTOM-HEADING is non-nil, then use a custom heading.

The user can input any string as a basic constituent of a
heading. The inputed string will be repeated (floor N M) times,
where N is the length of the current line and M is the lenght of
the input string. After this repeat the first (remainder N M)
characters of the input string will be inserted as well to cover
exactly the current ilne."
  (interactive "P")
  (let* ((current-length (- (point-at-eol)
                            (point-at-bol)))
         (heading (cond
                   ((null custom-heading) "-")
                   (t (read-string "Enter a custom heading: "
                                   nil insert-section-heading-history
                                   "-" t))))
         (floor-length (floor current-length (length heading)))
         (remainder (% current-length (length heading)))
         (remainder-string (substring heading 0 remainder))
         (index 0))
    (save-excursion
      (goto-char (line-end-position))
      (newline)
      (while (< index floor-length)
        (insert heading)
        (setq index (1+ index)))
      (insert remainder-string))))

;;; Center text

;;;###autoload
(defun correct-length (str)
  "Return the length of STR.
Characters that take up more than one column will be counted with
1.7 columns."
  (declare (side-effect-free t) (pure t)
           (obsolete string-width "2021-12-21 20:56:10.928712"))
  (let ((len 0))
    (mapc (lambda (char)
            (let ((name (get-char-code-property char 'name))
                  (decomposition (get-char-code-property char 'decomposition)))
              (cond
               ((or (and
                     (stringp name)
                     (string-match (rx-to-string '(seq bos "CJK"))
                                   name))
                    (eq (car decomposition) 'wide))
                (setq len (+ len 1.7)))
               ((setq len (1+ len))))))
          str)
    (floor len)))

;;;###autoload
(defun center-string-in-width (str width)
  "Add spaces to STR so that it is centered in a box which is WIDTH \
wide."
  (let ((len (string-width str)))
    (cond
     ((> len width)
      (error "String %s longer than %d" str width))
     (t (format "%s%s"
                (make-string (round (- width len) 2)
                             32)
                str)))))

;;; Make a block

;;;###autoload
(defvar make-block-history nil
  "The history of block quote descriptions.")

;;;###autoload
(defun make-block (&optional description)
  "Surround the current line or the region in a block.

If DESCRIPTION is non-nil, ask for a description and put the
DESCRIPTION above the block."
  (interactive "P")
  (let* ((beg (cond
               ((use-region-p)
                (region-beginning))
               ((line-beginning-position))))
         (end (cond
               ((use-region-p)
                (region-end))
               ((line-end-position))))
         (end-marker (set-marker (make-marker) (1+ end)))
         (fill-line (make-string fill-column ?=))
         (header (cond
                  (description
                   (list fill-line
                         "\n"
                         (center-string-in-width
                          (read-string "Description of the block: "
                                       nil make-block-history nil t)
                          fill-column)
                         "\n"
                         fill-line))
                  (t (list fill-line)))))
    (save-excursion
      (goto-char beg)
      (while (<= (point) (1- (marker-position end-marker)))
        (center-line)
        (forward-line 1))
      (goto-char beg)
      (mapc #'insert header)
      (newline)
      (goto-char (1- (marker-position end-marker)))
      (set-marker end-marker nil)
      (newline)
      (insert fill-line))))

;;; Make a center block

(defun find-max-nonblank-len-in-region (beg end)
  "Find the maximum length of non-blank lines in the region \
delimited by BEG and END."
  (let ((result 0) line-beg line-end temp)
    (save-excursion
      (goto-char beg)
      (while (<= (point) end)
        (forward-line 0)
        (setq
         line-beg
         (re-search-forward
          (rx-to-string
           '(seq bol (zero-or-more space))
           t)
          end t))
        (goto-char (line-end-position))
        (setq
         temp
         (re-search-backward
          (rx-to-string
           '(seq (not space) (zero-or-more space) eol)
           t)
          line-beg t))
        (setq line-end (cond (temp (1+ temp)) (line-beg)))
        (setq result (max result (- line-end line-beg)))
        (forward-line 1)))
    result))

;;;###autoload
(defun make-center-block (&optional description)
  "Surround the current line or the region in a centered block.

If DESCRIPTION is non-nil, ask for a description and put the
DESCRIPTION above the block."
  (interactive "P")
  (let* ((description
          (cond
           (description
            (read-string "Description of the block: "
                         nil make-block-history nil t))))
         (description-len (length description))
         (beg (cond
               ((use-region-p)
                (region-beginning))
               ((line-beginning-position))))
         (end (cond
               ((use-region-p)
                (region-end))
               ((line-end-position))))
         (end-marker (set-marker (make-marker) (1+ end)))
         (max-len (max (find-max-nonblank-len-in-region beg end)
                       description-len))
         (spaces-before
          (make-string (/ (- fill-column max-len 4) 2) 32))
         (fill-line
          (concat spaces-before (make-string (+ max-len 4) ?-)))
         (header (cond
                  (description
                   (list fill-line
                         "\n"
                         (center-string-in-width
                          description fill-column)
                         "\n"
                         fill-line))
                  ((list fill-line))))
         line-beg line-end line-str)
    (save-excursion
      (goto-char beg)
      (while (<= (point) (1- (marker-position end-marker)))
        (goto-char (line-end-position))
        (re-search-backward
         (rx-to-string
          '(seq (not space) (zero-or-more space) eol)
          t)
         (line-beginning-position) t)
        (setq line-end (min (line-end-position) (1+ (point))))
        (forward-line 0)
        (re-search-forward
         (rx-to-string
          '(seq bol (zero-or-more space))
          t)
         (line-end-position) t)
        (setq line-beg (point))
        (setq line-str (buffer-substring line-beg line-end))
        (delete-region (line-beginning-position)
                       (line-end-position))
        (insert spaces-before
                ?| 32
                line-str
                (make-string
                 (- (1+ max-len) (length line-str))
                 32)
                ?|)
        (forward-line 1))
      (goto-char beg)
      (mapc #'insert header)
      (newline)
      (goto-char (1- (marker-position end-marker)))
      (set-marker end-marker nil)
      (newline)
      (insert fill-line))))

;;; Moving between pages

;;;###autoload
(defun durand-next-page (&optional arg)
  "Move forward ARG pages and narrow to page.
The only differences with `narrow-to-page' are that a nil
argument means 1, and that after narrowing this moves the cursor
to the beginning."
  (interactive "p")
  (narrow-to-page arg)
  (goto-char (point-min)))

;;;###autoload
(defun durand-previous-page (&optional arg)
  "Move backward ARG pages and narrow to page.
Pass (- (prefix-numeric-value arg)) to `durand-next-page'."
  (interactive "p")
  (durand-next-page (- (prefix-numeric-value arg))))

(define-key text-mode-map (vector ?\s-m) #'durand-previous-page)
(define-key text-mode-map (vector ?\s-รน) #'durand-next-page)

;;; Insert time stamps

;;;###autoload
(defun durand-insert-timestamp (&optional arg)
  "Insert the time stamp for now.
If ARG is non-nil, use a more verbose format."
  (interactive "P")
  (let ((time-format (cond (arg "%F %T.%6N")
                           ("%F"))))
    (insert (format-time-string time-format))))

(define-key global-map (vector ?\H-=) #'durand-insert-timestamp)

;;; a diff-dwim

(autoload 'vc-diff "vc.el")

;;;###autoload
(defun durand-diff-dwim (&optional arg)
  "Run `diff-buffer-with-file' or `vc-diff'."
  (interactive "P")
  (cond
   ((and (or (not (buffer-modified-p))
             (equal arg (list 16)))
         (vc-registered (buffer-file-name)))
    (vc-diff arg t))
   ((buffer-modified-p)
    (diff-buffer-with-file
     (cond
      (arg (read-buffer "Choose a buffer to diff: "
                        (current-buffer) t))
      ((current-buffer)))))
   ((user-error "No reasonable way to diff"))))

(define-key global-map (vector ?\C-\M-=) #'durand-diff-dwim)

;;; Eliding a region of text

(defun durand-elide-region (beg end ignore-invisible-lines)
  "Elide a region of text delimited by BEG and END.
If IGNORE-INVISIBLE-LINES is non-nil, the line count will not
include invisible lines."
  (interactive
   (cond
    ((use-region-p) (list (region-beginning) (region-end)
                          current-prefix-arg))
    ((user-error "First select a region to elide"))))
  (cond
   ((> beg end)
    (let ((temp beg))
      (setq beg end) (setq end temp))))
  (setq beg (save-excursion
              (goto-char beg)
              (line-beginning-position)))
  (setq end (save-excursion
              (goto-char end)
              (line-end-position)))
  (let ((n (count-lines beg end ignore-invisible-lines)))
    (save-excursion
      (delete-region beg end)
      (insert (format "    >> [ %d lines elided ... ]" n)))))

(define-key text-mode-map (vector ?\M-\s-\=) #'durand-elide-region)

(provide 'text-conf)
;;; text-conf.el ends here.