1 ;;; glasses.el --- make cantReadThis readable
3 ;; Copyright (C) 1999, 2000 Free Software Foundation, Inc.
5 ;; Author: Milan Zamazal <pdm@freesoft.cz>
6 ;; Maintainer: Milan Zamazal <pdm@freesoft.cz>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
24 ;; Boston, MA 02111-1307, USA.
28 ;; This file defines a minor mode for making unreadableIdentifiersLikeThis
29 ;; readable. In some environments, for instance Java, it is common to use such
30 ;; unreadable identifiers. It is not good to use underscores in identifiers of
31 ;; your own project in such an environment to make your sources more readable,
32 ;; since it introduces undesirable confusion, which is worse than the
33 ;; unreadability. Fortunately, you use Emacs for the subproject, so the
34 ;; problem can be solved some way.
36 ;; This file defines the `glasses-mode' minor mode, which displays underscores
37 ;; between all the pairs of lower and upper English letters. (This only
38 ;; displays underscores, the text is not changed actually.) Alternatively, you
39 ;; can say you want the capitals in some given face (e.g. bold).
41 ;; The mode does something usable, though not perfect. Improvement suggestions
42 ;; from Emacs experts are welcome.
44 ;; If you like in-identifier separators different from underscores, change the
45 ;; value of the variable `glasses-separator' appropriately. See also the
46 ;; variables `glasses-face' and `glasses-convert-on-write-p'. You can also use
47 ;; the command `M-x customize-group RET glasses RET'.
49 ;; If you set any of the variables `glasses-separator' or `glasses-face' after
50 ;; glasses.el is loaded in a different way than through customize, you
51 ;; should call the function `glasses-set-overlay-properties' afterwards.
64 "Make unreadable code likeThis(one) readable."
68 (defcustom glasses-separator "_"
69 "*String to be displayed as a visual separator in unreadable identifiers."
72 :set 'glasses-custom-set
73 :initialize 'custom-initialize-default)
76 (defcustom glasses-face nil
77 "*Face to be put on capitals of an identifier looked through glasses.
78 If it is nil, no face is placed at the capitalized letter.
80 For example, you can set `glasses-separator' to an empty string and
81 `glasses-face' to `bold'. Then unreadable identifiers will have no separators,
82 but will have their capitals in bold."
85 :set 'glasses-custom-set
86 :initialize 'custom-initialize-default)
89 (defcustom glasses-separate-parentheses-p t
90 "*If non-nil, ensure space between an identifier and an opening parenthesis."
95 (defcustom glasses-uncapitalize-p nil
96 "*If non-nil, downcase embedded capital letters in identifiers.
97 Only identifiers starting with lower case letters are affected, letters inside
98 other identifiers are unchanged."
101 :set 'glasses-custom-set
102 :initialize 'custom-initialize-default)
105 (defcustom glasses-uncapitalize-regexp "[a-z]"
106 "*Regexp matching beginnings of words to be uncapitalized.
107 Only words starting with this regexp are uncapitalized.
108 The regexp is case sensitive.
109 It has any effect only when `glasses-uncapitalize-p' is non-nil."
112 :set 'glasses-custom-set
113 :initialize 'custom-initialize-default)
116 (defcustom glasses-convert-on-write-p nil
117 "*If non-nil, remove separators when writing glasses buffer to a file.
118 If you are confused by glasses so much, that you write the separators into code
119 during coding, set this variable to t. The separators will be removed on each
122 Note the removal action does not try to be much clever, so it can remove real
128 (defun glasses-custom-set (symbol value)
129 "Set value of the variable SYMBOL to VALUE and update overlay categories.
130 Used in :set parameter of some customized glasses variables."
132 (glasses-set-overlay-properties))
135 ;;; Utility functions
138 (defun glasses-set-overlay-properties ()
139 "Set properties of glasses overlays.
140 Consider current setting of user variables."
141 ;; In-identifier overlay
142 (put 'glasses 'evaporate t)
143 (put 'glasses 'before-string glasses-separator)
144 (put 'glasses 'face glasses-face)
145 ;; Beg-identifier overlay
146 (put 'glasses-init 'evaporate t)
147 (put 'glasses-init 'face glasses-face)
148 ;; Parenthesis overlay
149 (put 'glasses-parenthesis 'evaporate t)
150 (put 'glasses-parenthesis 'before-string " "))
152 (glasses-set-overlay-properties)
155 (defun glasses-overlay-p (overlay)
156 "Return whether OVERLAY is an overlay of glasses mode."
157 (memq (overlay-get overlay 'category)
158 '(glasses glasses-init glasses-parenthesis)))
161 (defun glasses-make-overlay (beg end &optional category)
162 "Create and return readability overlay over the region from BEG to END.
163 CATEGORY is the overlay category. If it is nil, use the `glasses' category."
164 (let ((overlay (make-overlay beg end)))
165 (overlay-put overlay 'category (or category 'glasses))
169 (defun glasses-make-readable (beg end)
170 "Make identifiers in the region from BEG to END readable."
171 (let ((case-fold-search nil))
176 (while (re-search-forward
177 "\\<\\([A-Z]\\)[a-zA-Z]*\\([a-z][A-Z]\\|[A-Z][a-z]\\)"
179 (glasses-make-overlay (match-beginning 1) (match-end 1)
183 (while (re-search-forward "[a-z]\\([A-Z]\\)\\|[A-Z]\\([A-Z]\\)[a-z]"
185 (let* ((n (if (match-string 1) 1 2))
186 (o (glasses-make-overlay (match-beginning n) (match-end n))))
187 (goto-char (match-beginning n))
188 (when (and glasses-uncapitalize-p
190 (looking-at "[A-Z]\\($\\|[^A-Z]\\)"))
193 (re-search-backward "\\<.")
194 (looking-at glasses-uncapitalize-regexp))))
195 (overlay-put o 'invisible t)
196 (overlay-put o 'after-string (downcase (match-string n))))))
198 (when glasses-separate-parentheses-p
200 (while (re-search-forward "[a-zA-Z]\\(\(\\)" end t)
201 (glasses-make-overlay (match-beginning 1) (match-end 1)
202 'glasses-parenthesis)))))))
205 (defun glasses-make-unreadable (beg end)
206 "Return identifiers in the region from BEG to END to their unreadable state."
207 (dolist (o (overlays-in beg end))
208 (when (glasses-overlay-p o)
209 (delete-overlay o))))
212 (defun glasses-convert-to-unreadable ()
213 "Convert current buffer to unreadable identifiers and return nil.
214 This function modifies buffer contents, it removes all the separators,
215 recognized according to the current value of the variable `glasses-separator'."
216 (when (and glasses-convert-on-write-p
217 (not (string= glasses-separator "")))
218 (let ((case-fold-search nil)
219 (separator (regexp-quote glasses-separator)))
221 (goto-char (point-min))
222 (while (re-search-forward
223 (format "[a-z]\\(%s\\)[A-Z]\\|[A-Z]\\(%s\\)[A-Z][a-z]"
226 (let ((n (if (match-string 1) 1 2)))
227 (replace-match "" t nil nil n)
228 (goto-char (match-end n))))
229 (when glasses-separate-parentheses-p
230 (goto-char (point-min))
231 (while (re-search-forward "[a-zA-Z]\\( \\)\(" nil t)
232 (replace-match "" t nil nil 1))))))
233 ;; nil must be returned to allow use in write file hooks
237 (defun glasses-change (beg end old-len)
238 "After-change function updating glass overlays."
239 (let ((beg-line (save-excursion (goto-char beg) (line-beginning-position)))
240 (end-line (save-excursion (goto-char end) (line-end-position))))
241 (glasses-make-unreadable beg-line end-line)
242 (glasses-make-readable beg-line end-line)))
245 ;;; Minor mode definition
248 (defvar glasses-mode nil
249 "Mode variable for `glasses-mode'.")
250 (make-variable-buffer-local 'glasses-mode)
252 (add-to-list 'minor-mode-alist '(glasses-mode " o^o"))
256 (defun glasses-mode (arg)
257 "Minor mode for making identifiers likeThis readable.
258 When this mode is active, it tries to add virtual separators (like underscores)
259 at places they belong to."
261 (let ((new-flag (if (null arg)
263 (> (prefix-numeric-value arg) 0))))
264 (unless (eq new-flag glasses-mode)
268 ;; We erase the all overlays anyway, to avoid dual sight in some
270 (glasses-make-unreadable (point-min) (point-max))
273 (glasses-make-readable (point-min) (point-max))
274 (make-local-hook 'after-change-functions)
275 (add-hook 'after-change-functions 'glasses-change nil t)
276 (add-hook 'local-write-file-hooks
277 'glasses-convert-to-unreadable nil t))
278 (remove-hook 'after-change-functions 'glasses-change t)
279 (remove-hook 'local-write-file-hooks
280 'glasses-convert-to-unreadable t))))
281 (setq glasses-mode new-flag))))
289 ;;; glasses.el ends here