blob: c55cee441ee8d52079933adb2562f197c0bdfdd1 (
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
|
;;; local-vars.el --- local variables list utilities
;;
;; Copyright (C) 2006 Pierre Courtieu
;; Authors: Pierre Courtieu
;; Maintainer: Pierre Courtieu <Pierre.Courtieu@cnam.fr>
;;
;; $Id$
;; This software is free software; you can redistribute it and/or
;; modify it under the terms of the GNU General Public
;; License version 2, as published by the Free Software Foundation.
;;
;; This software 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 version 2 for more details
;; (enclosed in the file GPL).
;;; Commentary:
;; See documentation in variable local-var-list-doc
;;; History:
;;
;;; Help:
(defconst local-vars-list-doc nil
"From Emacs Info:
A file can contain a \"local variables list\", which specifies the values to use for
certain Emacs variables when that file is edited. See info node \"(emacs)File
Variables\".
local-vars-list provides two useful functions:
\\[local-vars-list-get] that reads a local variable value at the end of the file.
\\[local-vars-list-set] that writes a local variable value at the end of the file.")
;;TOTO: use the code in xemacs-sources/lisp/files.el
;; in particular the function hack-local-variables-last-page
(defun local-vars-list-insert-empty-zone ()
"Insert an empty local variables zone at the end of the buffer.
Indents the zone according to mode after insertion."
(save-excursion
(goto-char (point-max))
(let ((pt (point)))
(cond
((not comment-start)
(insert
"
*** Local Variables: ***
*** End: ***
"
))
((string-equal comment-end "")
(insert
(format
"
%s** Local Variables: ***
%s** End: ***
"
comment-start comment-start)))
(t
(insert
(format
"
%s
*** Local Variables: ***
*** End: ***
%s"
comment-start comment-end))
))
(indent-region pt (point) nil)
(message "%s" "Local variables zone added at the end of the buffer."))))
(defun local-vars-list-find ()
"Find the local variable definition paragraph.
Return a list containing the prefix and the suffix of its first line,
or throw 'notfound if not found. Sets the point at the beginning of
the second line of the paragraph."
(goto-char (point-max))
(catch 'notfound
(if (not (re-search-backward "Local Variables:" nil t)) (throw 'notfound nil))
(let ((bol (save-excursion (beginning-of-line) (point)))
(eol (save-excursion (end-of-line) (point)))
(lpattern)
(rpattern))
(setq lpattern (buffer-substring bol (point)))
(re-search-forward "Local Variables:" eol t)
(setq rpattern (buffer-substring (point) eol))
(forward-line 1)
(beginning-of-line)
(cons lpattern (cons rpattern nil)))))
(defun local-vars-list-goto-var (symb lpat rpat)
"Search a line defining local variable symb at current line and below.
If successful set point to the beginning of the *value* and return t.
Otherwise set point to the beginning of the last line of the local
variables list (the one containing \"End:\"), and return nil.
lpat and rpat are the suffix and prefix of the local variable list.
Note: this function must be called when at the beginning of a local
variable definition (or at the \"End:\" line)."
(let* ((symbname (symbol-name symb))
(found nil) (endreached nil)
(eol))
(while (and (not found) (not endreached))
(setq eol (save-excursion (end-of-line) (point)))
(search-forward lpat eol)
(re-search-forward "\\([^ :]+\\):" eol)
(let ((varname (match-string 1)))
(cond
((string-equal varname "End") (setq endreached t) (beginning-of-line))
((string-equal varname symbname) (setq found t))
(t (forward-line 1) (beginning-of-line)))))
(if found t nil)))
; precond: really be on a var def line
(defun local-vars-list-get-current (lpat rpat)
"Return the value written in the local variable list at current line.
lpat and rpat are the suffix and prefix of the local variable list.
Note: this function must be called when at the beginning of a local
variable definition (or at the \"End:\" line)."
(let ((bol (save-excursion (beginning-of-line) (point)))
(eol (save-excursion (end-of-line) (point)))
(varname ""))
(catch 'notfound
(if (not (search-forward lpat eol t)) (throw 'notfound nil))
(if (not (re-search-forward "\\([^ :]+\\):" eol t)) (throw 'notfound nil))
(setq varname (match-string 1))
(let ((boexp (point)))
(if (not (search-forward rpat eol t)) (throw 'notfound nil))
(search-backward rpat bol) ; should always succeed
(read (buffer-substring boexp (point))))))) ; TODO: catch errors here?
(defun local-vars-list-set-current (val lpat rpat)
"Write the value val in the local variable list at current line.
lpat and rpat are the suffix and prefix of the local variable list.
Note: this function must be called when at the beginning of a local
variable definition (or at the \"End:\" line)."
(let ((bol (save-excursion (beginning-of-line) (point)))
(eol (save-excursion (end-of-line) (point)))
(varname ""))
(search-forward lpat eol)
(re-search-forward "\\([^ :]+\\):" eol)
(setq varname (match-string 1))
(let ((boexp (point)))
(search-forward rpat eol)
(search-backward rpat bol)
(kill-region boexp (point))
(insert (format " %S " val))
)
)
)
(defun local-vars-list-get (symb)
"Return the value written in the local variable list for variable symb.
Raises an error if symb is not in the list."
(save-excursion
(let*
((lrpat (local-vars-list-find))
(dummy (if lrpat t (error "local variables zone not found. ")))
(lpat (car lrpat))
(rpat (car (cdr lrpat)))
)
(beginning-of-line)
(if (local-vars-list-goto-var symb lpat rpat)
t
(error "variable %s not found" symb))
(beginning-of-line)
(local-vars-list-get-current lpat rpat))))
(defun local-vars-list-get-safe (symb)
"Return true if variable SYMB belongs to the local variable list of the
current buffer."
(condition-case nil (local-vars-list-get symb) (error nil)))
(defun local-vars-list-set (symb val)
"Write the value val in the local variable list for variable symb.
If the variable is already specified in the list, replace the
value. If no local variable list is found, create one at the end
of the buffer first."
(save-excursion
(let ((lrpat (local-vars-list-find)))
(if (not lrpat)
(progn
(local-vars-list-insert-empty-zone)
(setq lrpat (local-vars-list-find))))
(beginning-of-line)
(let ((lpat (car lrpat))
(rpat (car (cdr lrpat))))
(if (local-vars-list-goto-var symb lpat rpat)
(progn (beginning-of-line)
(local-vars-list-set-current val lpat rpat))
(insert (format "%s%s: %S%s\n" lpat (symbol-name symb) val rpat))
(forward-line -1)
(indent-according-to-mode))))))
(provide 'local-vars-list)
;;; Local Variables: ***
;;; fill-column: 85 ***
;;; indent-tabs-mode: nil ***
;;; End: ***
|
