-
Notifications
You must be signed in to change notification settings - Fork 0
/
eev-anchors.el
181 lines (133 loc) · 5.83 KB
/
eev-anchors.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
;;; eev-anchors.el -- hyperlinks to anchors. -*- lexical-binding: nil; -*-
;; Copyright (C) 2012-2019,2023 Free Software Foundation, Inc.
;;
;; This file is part of GNU eev.
;;
;; GNU eev 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 of the License, or
;; (at your option) any later version.
;;
;; GNU eev 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. If not, see <http://www.gnu.org/licenses/>.
;;
;; Author: Eduardo Ochs <[email protected]>
;; Maintainer: Eduardo Ochs <[email protected]>
;; Version: 20230127
;; Keywords: e-scripts
;;
;; Latest version: <http://anggtwu.net/eev-current/eev-anchors.el>
;; htmlized: <http://anggtwu.net/eev-current/eev-anchors.el.html>
;; See also: <http://anggtwu.net/eev-current/eev-beginner.el.html>
;; <http://anggtwu.net/eev-intros/find-eev-intro.html>
;; <http://anggtwu.net/eev-intros/find-anchors-intro.html>
;; (find-eev-intro)
;; (find-anchors-intro)
;;; Commentary:
;; See the tutorial on anchors here:
;; (find-eev-quick-intro "8. Anchors")
;; «.glyphs» (to "glyphs")
;; «.ee-goto-anchor» (to "ee-goto-anchor")
;; «.find-anchor» (to "find-anchor")
;; «.to» (to "to")
(require 'eepitch) ; (find-eev "eepitch.el")
(require 'eev-codings) ; (find-eev "eev-codings.el")
;;; _ _
;;; __ _| |_ _ _ __ | |__ ___
;;; / _` | | | | | '_ \| '_ \/ __|
;;; | (_| | | |_| | |_) | | | \__ \
;;; \__, |_|\__, | .__/|_| |_|___/
;;; |___/ |___/|_|
;;
;; «glyphs» (to ".glyphs")
;; See: (find-eev "eepitch.el" "glyphs")
(defface eev-glyph-face-green
'((((class color) (background dark))
(:foreground "green"))
(((class color) (background light))
(:foreground "forest green"))
(t (:bold t)))
"Face used for the green glyphs (`<<' and `>>', chars 171 and 187).")
;; (eepitch-set-glyph ?« ?« 'eev-glyph-face-green)
;; (eepitch-set-glyph ?» ?» 'eev-glyph-face-green)
(eepitch-set-glyph 171 171 'eev-glyph-face-green)
(eepitch-set-glyph 187 187 'eev-glyph-face-green)
;;; _ __ _
;;; __ _ _ __ ___| |__ ___ _ __ / _| ___ _ __ _ __ ___ __ _| |_
;;; / _` | '_ \ / __| '_ \ / _ \| '__|____| |_ / _ \| '__| '_ ` _ \ / _` | __|
;;; | (_| | | | | (__| | | | (_) | | |_____| _| (_) | | | | | | | | (_| | |_
;;; \__,_|_| |_|\___|_| |_|\___/|_| |_| \___/|_| |_| |_| |_|\__,_|\__|
;;;
(defvar ee-anchor-format "«%s»" "See `ee-goto-anchor'.")
;;;###autoload
(put 'ee-anchor-format 'safe-local-variable #'stringp)
;; A paranoid setting would be:
;; (defvar ee-anchor-format nil "See `ee-goto-anchor'.")
(defun ee-format-as-anchor (tag)
"Convert TAG into an anchor using `ee-anchor-format'."
(if ee-anchor-format
(format (ee-tolatin1 ee-anchor-format) tag)
(error "`ee-anchor-format' is nil - can't convert string to anchor")))
;;; __ _ _ _
;;; / _(_)_ __ __| | __ _ _ __ ___| |__ ___ _ __
;;; | |_| | '_ \ / _` |_____ / _` | '_ \ / __| '_ \ / _ \| '__|
;;; | _| | | | | (_| |_____| (_| | | | | (__| | | | (_) | |
;;; |_| |_|_| |_|\__,_| \__,_|_| |_|\___|_| |_|\___/|_|
;;;
;; «ee-goto-anchor» (to ".ee-goto-anchor")
;; «find-anchor» (to ".find-anchor")
;; See: (find-eev-quick-intro "8. Anchors")
;; (find-eval-intro "Anchors and pages")
(defun ee-goto-anchor (&optional tag &rest rest)
"Like `ee-goto-position', but TAG is converted to an anchor.
If the anchor obtained from TAG is not found then issue an error
but do not move point.
For example, if `ee-anchor-format' is \"<<%s>>\" then
(ee-goto-anchor \"foo\" \"bar\")
searches for the first occurrence of \"<<foo>>\" in the current
buffer, then for the first occurrence of \"bar\" after that. If
\"<<foo>>\" is not found then do not move point.
It is good style to set `ee-anchor-format' globally to nil and
only use anchors in files where `ee-anchor-format' is declared in
the local variables section of the file; see:
(find-node \"(emacs)File Variables\")
(find-node \"(emacs)Specifying File Variables\")
a hint: one way of forcing reloading the local variables by hand
is by running `\\[normal-mode]'.
The glyphs defined in (find-eev \"eev-anchors.el\" \"glyphs\")
can be used to make anchors using characters that stand out."
(if tag (goto-char
(save-excursion
(goto-char (point-min))
(search-forward (ee-format-as-anchor tag))
(point))))
(ee-goto-rest rest))
(defun find-anchor (fname &optional tag &rest pos-spec-list)
"Like `find-fline', but TAG is converted to an anchor if not nil.
See `ee-goto-anchor'."
(find-fline fname)
(apply 'ee-goto-anchor tag pos-spec-list))
;;; _
;;; | |_ ___
;;; | __/ _ \
;;; | || (_) |
;;; \__\___/
;;;
;; «to» (to ".to")
;; See: (find-eev-quick-intro "8.1. Introduction: `to'")
;; (find-eev-intro "1. `eev-mode'" "prefixes" "to")
;;
(defun to (tag &rest pos-spec-list)
"Like `find-anchor', but does not switch to another buffer or file."
(interactive "sAnchor: ")
(apply 'ee-goto-anchor tag pos-spec-list))
(provide 'eev-anchors)
;; Local Variables:
;; coding: utf-8-unix
;; no-byte-compile: t
;; End: