-
Notifications
You must be signed in to change notification settings - Fork 3
/
perl-myvar.el
307 lines (250 loc) · 8.93 KB
/
perl-myvar.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
;;; perl-myvar.el --- Declare lexicaly scoped vars as my().
;;
;; ~harley/share/emacs/pkg/perlvar/perl-myvar.el ---
;;
;; $Id: perl-myvar.el,v 1.17 2003/03/17 06:21:27 harley Exp $
;;
;; Author: Harley Gorrell <harley@malhalito.net>
;; URL: http://www.mahalito.net/~harley/elisp/perl-myvar.el
;; License: GPL v2
;; Keywords: perl, emacs, my, declare
;;; Commentary:
;; Declaring all those 'my' variables can be time consuming
;; and I seem to overlook one or two now and then. 'perl-myvar'
;; helps me catch some the stragglers.
;; Bind 'jhg-pv' to a function key and go wild.
;; Inserting these two lines in your .emacs should be sufficient.
;; (require 'perl-mode)
;; (define-key perl-mode-map [f11] 'jhg-pv)
;; This package expects 'properly' indented code. That is
;; not a big problem when using perl-mode, so jhg-pv expects
;; it.
;; Global variables are variables which start in the first
;; column anywhere in the buffer. Variables declared with
;; 'my' or 'local' should have only whitespace in front of
;; them. You may use '#global' to document global
;; variables. '#ignore' may be used to work around over
;; zealous declerations on the part of this code.
;; If font-lock-mode is on, it will not pull variables out
;; of strings. If not, it will think "%s" and the like are
;; fair game.
;;; History:
;; 2003-03-16 : Updated URL and contact info.
;; Need to change the prefix to something other than 'jhg-pv'
;;; Code:
(defvar jhg-pv-are-special '( "%ENV" "@ARGV" )
"*List of variables which are special and should not be declared.")
(defvar jhg-pv-are-local '( "$a" "$b" )
"*List of variables which should be local.
These are typically the variables used in a sort() expression.")
(defvar jhg-pv-decl-global t
"*Should `jhg-pv' declare globals?")
(defvar jhg-pv-decl-local t
"*Should `jhg-pv' declare locals?")
(defvar jhg-pv-tag-string "#" ;"#pv"
"*String to tag inserted lines with.")
(defvar jhg-pv-always-update-global-vars t
"*Always scan the buffer for global vars before inserting declarations.
Set to nil if you have a big buffer. The
global variable list may be manually updated with
'jhg-pv-set-global-list'." )
(defvar jhg-pv-buffer-global-vars nil
"Global perl variables used in this buffer." )
;; Make 'em all buffer local
(make-variable-buffer-local 'jhg-pv-are-special)
(make-variable-buffer-local 'jhg-pv-are-local)
(make-variable-buffer-local 'jhg-pv-decl-global)
(make-variable-buffer-local 'jhg-pv-decl-local)
(make-variable-buffer-local 'jhg-pv-tag-string)
(make-variable-buffer-local 'jhg-pv-always-update-global-vars)
(make-variable-buffer-local 'jhg-pv-buffer-global-vars)
;;
(defun jhg-pv-find-vars (r-start r-end)
"Return a list of variables in the region with their declaration.
The list is formatted like: ((var1 . decl) (var2 . decl) ... )
Where var is a string and decl is one of
'special
'global-decl 'global-use
'local-decl 'local-use
'my-decl 'my-use
'ignore-decl
Argument R-START region start.
Argument R-END region end."
(interactive "r")
(let ((v-list nil) v-name v-loc v-pos v-type v-face)
(save-excursion
;; top
(goto-char r-start)
;; find the next
(while (search-forward-regexp "[$@%][A-Za-z][A-Za-z0-9_:]*[[{]?" r-end t)
;; get its name
(setq v-name (buffer-substring-no-properties
(match-beginning 0) (match-end 0)))
(setq v-name (jhg-pv-proper-var v-name))
;; get its face
(setq v-face (get-text-property (match-beginning 0) 'face))
;; How is this variable defined?
(setq v-pos (match-end 0))
(beginning-of-line)
(setq v-type
(cond
;; special, global
((member v-name jhg-pv-are-special) 'special)
((assoc v-name jhg-pv-buffer-global-vars) 'global-decl)
;; declarations
((looking-at "\\s-*#global(") 'global-decl)
((looking-at "\\s-*local(") 'local-decl)
((looking-at "\\s-*my(") 'my-decl)
((looking-at "\\s-*#ignore(") 'ignore-decl)
;; in a string or comment?
((and
(boundp 'font-lock-string-face)
(or (eq v-face font-lock-string-face)
(eq v-face font-lock-comment-face))) nil) ; forget
;; Used in some way... How should we declare it?
(t (funcall jhg-pv-declarer v-name))))
;; back to pos
(goto-char v-pos)
;; add to list
(if (and v-type (not (assoc v-name v-list)))
(setq v-list (cons (cons v-name v-type) v-list))))
;; the vars
v-list)))
(defun jhg-pv-find-global-vars (r-start r-end)
"Return a list of global varibles in the region.
Argument R-START region start.
Argument R-END region end."
(interactive "r")
(save-excursion
(let (v-name v-list)
;; top
(goto-char r-start)
;; find
(while (search-forward-regexp "^[$@%][A-z][A-Za-z0-9_:]*" r-end t)
(setq v-name (buffer-substring (match-beginning 0) (match-end 0)))
(set-text-properties 0 (length v-name) nil v-name)
(setq v-list (cons (cons v-name 'global) v-list)))
;;
v-list
)))
(defvar jhg-pv-declarer 'jhg-pv-declarer-default
"The function to determine the decleraton type.")
(make-variable-buffer-local 'jhg-pv-declarer)
(defun jhg-pv-declarer-my (v)
"Always declare the variable V as 'my'."
'my)
(defun jhg-pv-declarer-default (v)
"Deterimine what kind of declaration the variable V should receive.
Return value is one of special, global, local, or my."
(let ((case-fold-search nil))
(cond
((member v-name jhg-pv-are-local) 'local-use)
((string-match "^%ENV$" v) 'special)
((string-match "^[$@%][A-Z]+$" v) 'global-use)
((string-match "::" v) 'global-use)
((string-match "^[$@%]opt_" v) 'global-use)
((string-match "^\\$[ab]$" v) 'local-use) ;; for sort({$a<=>$b})
(t 'my-use))))
;(let ((l '("@ARGV" "@ARGVaaa" "$ARGVaaa" "$ENV"
; "$opt_a" "$a" "$aa" "$aa" "$foo")))
; (insert "\n")
; (while l
; (insert (format "%s:%s\n" (car l) (funcall jhg-pv-declarer (car l))))
; (setq l (cdr l))))
(defun jhg-pv-filter-vars (v-type v-list)
"Filter by the type V-TYPE the list of variables in V-LIST."
(let ((v-out ()))
(while v-list
(if (eq (cdr (car v-list)) v-type)
(setq v-out (cons (car (car v-list)) v-out)))
(setq v-list (cdr v-list)))
v-out))
(defun jhg-pv-proper-var (v-name)
"Convert the perl variable V-NAME to its 'proper' form.
The expression '$foo{...}' is a use of the hash '%foo',
while '$bar[...]' is a use of the list '@bar'."
(let (v-type v-name-len)
;;
(setq v-name-len (1- (length v-name)))
(setq v-type (aref v-name v-name-len))
;;
(cond
((= v-type 91 ) ; [
(concat "@" (substring v-name 1 v-name-len)))
((= v-type 123 ) ; {
(concat "%" (substring v-name 1 v-name-len)))
(t v-name)
)))
;; (jhg-pv-proper-var "$foo{")
;; (jhg-pv-proper-var "$foo[")
;; (jhg-pv-proper-var "$foo")
(defun jhg-pv-insert (v-decl v-list)
"Insert the declaration V-DECL of the list of variables V-LIST."
(beginning-of-line)
(insert " " v-decl "(") ; " " to move it off col 0 for tabbing
(while v-list
(insert (car v-list))
(setq v-list (cdr v-list))
(if v-list
(insert ","))
)
;; The "#" is to mark the lines this function inserts.
(insert "); " jhg-pv-tag-string)
(indent-according-to-mode)
(insert "\n")
)
;; (jhg-pv-insert "my" '( "aaa" "bbb"))
(defun jhg-pv-set-global-list ()
"Set the `jhg-pv' cache of global variables."
(interactive)
(setq jhg-pv-buffer-global-vars
(jhg-pv-find-global-vars (point-min) (point-max))
))
(defun jhg-pv-clear-global-list ()
"Clear the `jhg-pv' cache of global variables."
(interactive)
(setq jhg-pv-buffer-global-vars nil))
;;;###autoload
(defun jhg-pv ()
"Examine the current perl subroutine and insert a declaration.
Variables are considered 'declared' if they appear as:
my($myvar);
local($localvar);
or
#global($globalvar);
#ignore(%d);
Used but undeclared variables are inserted as a 'my' declaration.
If font-lock mode is active, the faces are used to do a better job."
(interactive)
(let (r-s r-e v-list g-list l-list m-list)
;; Select the block
(save-excursion
(mark-perl-function)
(setq r-s (point)
r-e (mark)))
;; Inside a sub?
(if (and r-s r-e (< r-s (point)) (> r-e (point)))
(progn
;; Refresh globals?
(if (or jhg-pv-always-update-global-vars
(not jhg-pv-buffer-global-vars))
(jhg-pv-set-global-list))
;; Make a list of vars in the region
(setq v-list (jhg-pv-find-vars r-s r-e))
;; global?
(if jhg-pv-decl-global
(progn
(setq g-list (jhg-pv-filter-vars 'global-use v-list))
(if g-list (jhg-pv-insert "#global" (sort g-list 'string<)))))
;; local?
(if jhg-pv-decl-local
(progn
(setq l-list (jhg-pv-filter-vars 'local-use v-list))
(if l-list (jhg-pv-insert "local" (sort l-list 'string<)))))
;; my
(setq m-list (jhg-pv-filter-vars 'my-use v-list))
(if m-list (jhg-pv-insert "my" (sort m-list 'string<)))
))))
;;
(provide 'perl-myvar)
;;; perl-myvar.el ends here