-
Notifications
You must be signed in to change notification settings - Fork 7
/
linemark.el
461 lines (423 loc) · 15.6 KB
/
linemark.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
;;; linemark.el --- Manage groups of lines with marks.
;;
;; Author: Eric M. Ludlam <[email protected]>
;; Maintainer: Eric M. Ludlam <[email protected]>
;; Created: Dec 1999
;; Keywords: lisp
;;
;; Copyright (C) 1999, 2001, 2002, 2003, 2004, 2005, 2007, 2008, 2009 Eric M. Ludlam
;;
;; 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 2, 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.
;;
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
;;
;;; Commentary:
;;
;; This is a library of routines which help Lisp programmers manage
;; groups of marked lines. Common uses for marked lines are debugger
;; breakpoints and watchpoints, or temporary line highlighting. It
;; could also be used to select elements from a list.
;;
;; The reason this tool is useful is because cross-emacs overlay
;; management can be a pain, and overlays are certainly needed for use
;; with font-lock.
(require 'eieio)
(eval-when-compile
(require 'cl))
;;; Code:
;; Compatibility
(eval-and-compile
(if (featurep 'xemacs)
(progn
(defalias 'linemark-overlay-live-p 'extent-live-p)
(defalias 'linemark-make-overlay 'make-extent)
(defalias 'linemark-overlay-put 'set-extent-property)
(defalias 'linemark-overlay-get 'extent-property)
(defalias 'linemark-delete-overlay 'delete-extent)
(defalias 'linemark-overlays-at
(lambda (pos) (extent-list nil pos pos)))
(defalias 'linemark-overlays-in
(lambda (beg end) (extent-list nil beg end)))
(defalias 'linemark-overlay-buffer 'extent-buffer)
(defalias 'linemark-overlay-start 'extent-start-position)
(defalias 'linemark-overlay-end 'extent-end-position)
(defalias 'linemark-next-overlay-change 'next-extent-change)
(defalias 'linemark-previous-overlay-change 'previous-extent-change)
(defalias 'linemark-overlay-lists
(lambda () (list (extent-list))))
(defalias 'linemark-overlay-p 'extentp)
)
(defalias 'linemark-overlay-live-p 'overlay-buffer)
(defalias 'linemark-make-overlay 'make-overlay)
(defalias 'linemark-overlay-put 'overlay-put)
(defalias 'linemark-overlay-get 'overlay-get)
(defalias 'linemark-delete-overlay 'delete-overlay)
(defalias 'linemark-overlays-at 'overlays-at)
(defalias 'linemark-overlays-in 'overlays-in)
(defalias 'linemark-overlay-buffer 'overlay-buffer)
(defalias 'linemark-overlay-start 'overlay-start)
(defalias 'linemark-overlay-end 'overlay-end)
(defalias 'linemark-next-overlay-change 'next-overlay-change)
(defalias 'linemark-previous-overlay-change 'previous-overlay-change)
(defalias 'linemark-overlay-lists 'overlay-lists)
(defalias 'linemark-overlay-p 'overlayp)
))
(defgroup linemark nil
"Line marking/highlighting."
:group 'tools
)
(eval-and-compile
;; These faces need to exist to show up as valid default
;; entries in the classes defined below.
(defface linemark-stop-face '((((class color) (background light))
(:background "#ff8888"))
(((class color) (background dark))
(:background "red3")))
"*Face used to indicate a STOP type line."
:group 'linemark)
(defface linemark-caution-face '((((class color) (background light))
(:background "yellow"))
(((class color) (background dark))
(:background "yellow4")))
"*Face used to indicate a CAUTION type line."
:group 'linemark)
(defface linemark-go-face '((((class color) (background light))
(:background "#88ff88"))
(((class color) (background dark))
(:background "green4")))
"*Face used to indicate a GO, or OK type line."
:group 'linemark)
(defface linemark-funny-face '((((class color) (background light))
(:background "cyan"))
(((class color) (background dark))
(:background "blue3")))
"*Face used for elements with no particular criticality."
:group 'linemark)
)
(defclass linemark-entry ()
((filename :initarg :filename
:type string
:documentation "File name for this mark.")
(line :initarg :line
:type number
:documentation "Line number where the mark is.")
(face :initarg :face
; Something created w/ defface is not a face in XEmacs.
; :type face
:initform linemark-caution-face
:documentation "The face to use for display.")
(parent :documentation "The parent `linemark-group' containing this."
:type linemark-group)
(overlay :documentation "Overlay created to show this mark."
:type (or linemark-overlay null)
:initform nil
:protection protected))
"Track a file/line associations with overlays used for display.")
(defclass linemark-group ()
((marks :initarg :marks
:type list
:initform nil
:documentation "List of `linemark-entries'.")
(face :initarg :face
:initform linemark-funny-face
; Something created w/ defface is not a face in XEmacs.
; :type (or null face)
:documentation "Default face used to create new `linemark-entries'.")
(active :initarg :active
:type boolean
:initform t
:documentation "Track if these marks are active or not."))
"Track a common group of `linemark-entries'.")
;;; Functions
;;
(defvar linemark-groups nil
"List of groups we need to track.")
(defun linemark-create-group (name &optional defaultface)
"*Obsolete*.
Create a group object for tracking linemark entries.
Do not permit multiple groups with the same NAME.
Optional argument DEFAULTFACE is the :face slot for the object."
(linemark-new-group 'linemark-group name :face defaultface)
)
(defun linemark-new-group (class name &rest args)
"Create a new linemark group based on the linemark CLASS.
Give this group NAME. ARGS are slot/value pairs for
the new instantiation."
(let ((newgroup nil)
(foundgroup nil)
(lmg linemark-groups))
;; Find an old group.
(while (and (not foundgroup) lmg)
(if (string= name (object-name-string (car lmg)))
(setq foundgroup (car lmg)))
(setq lmg (cdr lmg)))
;; Which group to use.
(if foundgroup
;; Recycle the old group
(setq newgroup foundgroup)
;; Create a new group
(setq newgroup (apply 'make-instance class name args))
(setq linemark-groups (cons newgroup linemark-groups)))
;; Return the group
newgroup))
(defun linemark-at-point (&optional pos group)
"Return the current variable `linemark-entry' at point.
Optional POS is the position to check which defaults to point.
If GROUP, then make sure it also belongs to GROUP."
(if (not pos) (setq pos (point)))
(let ((o (linemark-overlays-at pos))
(found nil))
(while (and o (not found))
(let ((og (linemark-overlay-get (car o) 'obj)))
(if (and og (linemark-entry-child-p og))
(progn
(setq found og)
(if group
(if (not (eq group (oref found parent)))
(setq found nil)))))
(setq o (cdr o))))
found))
(defun linemark-next-in-buffer (group &optional arg wrap)
"Return the next mark in this buffer belonging to GROUP.
If ARG, then find that manu marks forward or backward.
Optional WRAP argument indicates that we should wrap around the end of
the buffer."
(if (not arg) (setq arg 1)) ;; default is one forward
(let* ((entry (linemark-at-point (point) group))
(nc (if entry
(if (< 0 arg) (linemark-end entry)
(linemark-begin entry))
(point)))
(dir (if (< 0 arg) 1 -1))
(ofun (if (> 0 arg)
'linemark-previous-overlay-change
'linemark-next-overlay-change))
(bounds (if (< 0 arg) (point-min) (point-max)))
)
(setq entry nil)
(catch 'moose
(save-excursion
(while (and (not entry) (/= arg 0))
(setq nc (funcall ofun nc))
(setq entry (linemark-at-point nc group))
(if (not entry)
(if (or (= nc (point-min)) (= nc (point-max)))
(if (not wrap)
(throw 'moose t)
(setq wrap nil ;; only wrap once
nc bounds))))
;; Ok, now decrement arg, and keep going.
(if entry
(setq arg (- arg dir)
nc (linemark-end entry))))))
entry))
;;; Methods that make things go
;;
(defmethod linemark-add-entry ((g linemark-group) &rest args)
"Add a `linemark-entry' to G.
It will be at location specified by :filename and :line, and :face
which are property list entries in ARGS.
Call the new entrie's activate method."
(let ((file (plist-get args :filename))
(line (plist-get args :line))
(face (plist-get args :face)))
(if (not file)
(progn
(setq file (buffer-file-name))
(if file
(setq file (expand-file-name file))
(setq file (buffer-name)))))
(when (not line)
(setq line (count-lines (point-min) (point)))
(if (bolp) (setq line (1+ line))))
(setq args (plist-put args :filename file))
(setq args (plist-put args :line line))
(let ((new-entry (apply 'linemark-new-entry g args)))
(oset new-entry parent g)
(oset new-entry face (or face (oref g face)))
(oset g marks (cons new-entry (oref g marks)))
(if (oref g active)
(linemark-display new-entry t))
new-entry)
))
(defmethod linemark-new-entry ((g linemark-group) &rest args)
"Create a new entry for G using init ARGS."
(let ((f (plist-get args :filename))
(l (plist-get args :line)))
(apply 'linemark-entry (format "%s %d" f l)
args)))
(defmethod linemark-display ((g linemark-group) active-p)
"Set object G to be active or inactive."
(mapc (lambda (g) (linemark-display g active-p)) (oref g marks))
(oset g active active-p))
(defmethod linemark-display ((e linemark-entry) active-p)
"Set object E to be active or inactive."
(if active-p
(with-slots ((file filename)) e
(if (oref e overlay)
;; Already active
nil
(let ((buffer))
(if (get-file-buffer file)
(setq buffer (get-file-buffer file))
(setq buffer (get-buffer file)))
(if buffer
(with-current-buffer buffer
(save-excursion
(goto-char (point-min))
(forward-line (1- (oref e line)))
(oset e overlay
(linemark-make-overlay (point)
(save-excursion
(end-of-line) (point))
(current-buffer)))
(with-slots (overlay) e
(linemark-overlay-put overlay 'face (oref e face))
(linemark-overlay-put overlay 'obj e)
(linemark-overlay-put overlay 'tag 'linemark))))))))
;; Not active
(with-slots (overlay) e
(if overlay
(progn
(condition-case nil
;; During development of linemark programs, this is helpful
(linemark-delete-overlay overlay)
(error nil))
(oset e overlay nil))))))
(defmethod linemark-delete ((g linemark-group))
"Remove group G from linemark tracking."
(mapc 'linemark-delete (oref g marks))
(setq linemark-groups (delete g linemark-groups)))
(defmethod linemark-delete ((e linemark-entry))
"Remove entry E from it's parent group."
(with-slots (parent) e
(oset parent marks (delq e (oref parent marks)))
(linemark-display e nil)))
(defmethod linemark-begin ((e linemark-entry))
"Position at the start of the entry E."
(with-slots (overlay) e
(linemark-overlay-start overlay)))
(defmethod linemark-end ((e linemark-entry))
"Position at the end of the entry E."
(with-slots (overlay) e
(linemark-overlay-end overlay)))
;;; Trans buffer tracking
;;
;; This section sets up a find-file-hook and a kill-buffer-hook
;; so that marks that aren't displayed (because the buffer doesn't
;; exist) are displayed when said buffer appears, and that overlays
;; are removed when the buffer buffer goes away.
(defun linemark-find-file-hook ()
"Activate all marks which can benifit from this new buffer."
(mapcar (lambda (g) (linemark-display g t)) linemark-groups))
(defun linemark-kill-buffer-hook ()
"Deactivate all entries in the current buffer."
(let ((o (linemark-overlays-in (point-min) (point-max)))
(to nil))
(while o
(setq to (linemark-overlay-get (car o) 'obj))
(if (and to (linemark-entry-child-p to))
(linemark-display to nil))
(setq o (cdr o)))))
(add-hook 'find-file-hooks 'linemark-find-file-hook)
(add-hook 'kill-buffer-hook 'linemark-kill-buffer-hook)
;;; Demo mark tool: Emulate MS Visual Studio bookmarks
;;
(defvar viss-bookmark-group (linemark-new-group 'linemark-group "viss")
"The VISS bookmark group object.")
(defun viss-bookmark-toggle ()
"Toggle a bookmark on the current line."
(interactive)
(let ((ce (linemark-at-point (point) viss-bookmark-group)))
(if ce
(linemark-delete ce)
(linemark-add-entry viss-bookmark-group))))
(defun viss-bookmark-next-buffer ()
"Move to the next bookmark in this buffer."
(interactive)
(let ((n (linemark-next-in-buffer viss-bookmark-group 1 t)))
(if n
(progn
(goto-char (point-min))
(forward-line (1- (oref n line))))
(ding))))
(defun viss-bookmark-prev-buffer ()
"Move to the next bookmark in this buffer."
(interactive)
(let ((n (linemark-next-in-buffer viss-bookmark-group -1 t)))
(if n
(progn
(goto-char (point-min))
(forward-line (1- (oref n line))))
(ding))))
(defun viss-bookmark-clear-all-buffer ()
"Clear all bookmarks in this buffer."
(interactive)
(mapcar (lambda (e)
(if (or (string= (oref e filename) (buffer-file-name))
(string= (oref e filename) (buffer-name)))
(linemark-delete e)))
(oref viss-bookmark-group marks)))
;; These functions only sort of worked and were not really useful to me.
;;
;;(defun viss-bookmark-next ()
;; "Move to the next bookmark."
;; (interactive)
;; (let ((c (linemark-at-point (point) viss-bookmark-group))
;; (n nil))
;; (if c
;; (let ((n (member c (oref viss-bookmark-group marks))))
;; (if n (setq n (car (cdr n)))
;; (setq n (car (oref viss-bookmark-group marks))))
;; (if n (goto-line (oref n line)) (ding)))
;; ;; if no current mark, then just find a local one.
;; (viss-bookmark-next-buffer))))
;;
;;(defun viss-bookmark-prev ()
;; "Move to the next bookmark."
;; (interactive)
;; (let ((c (linemark-at-point (point) viss-bookmark-group))
;; (n nil))
;; (if c
;; (let* ((marks (oref viss-bookmark-group marks))
;; (n (member c marks)))
;; (if n
;; (setq n (- (- (length marks) (length n)) 1))
;; (setq n (car marks)))
;; (if n (goto-line (oref n line)) (ding)))
;; ;; if no current mark, then just find a local one.
;; (viss-bookmark-prev-buffer))))
;;
;;(defun viss-bookmark-clear-all ()
;; "Clear all viss bookmarks."
;; (interactive)
;; (mapcar (lambda (e) (linemark-delete e))
;; (oref viss-bookmark-group marks)))
;;
;;;###autoload
(defun enable-visual-studio-bookmarks ()
"Bind the viss bookmark functions to F2 related keys.
\\<global-map>
\\[viss-bookmark-toggle] - To=ggle a bookmark on this line.
\\[viss-bookmark-next-buffer] - Move to the next bookmark.
\\[viss-bookmark-prev-buffer] - Move to the previous bookmark.
\\[viss-bookmark-clear-all-buffer] - Clear all bookmarks."
(interactive)
(define-key global-map [(f2)] 'viss-bookmark-toggle)
(define-key global-map [(shift f2)] 'viss-bookmark-prev-buffer)
(define-key global-map [(control f2)] 'viss-bookmark-next-buffer)
(define-key global-map [(control shift f2)] 'viss-bookmark-clear-all-buffer)
)
(provide 'linemark)
;;; linemark.el ends here