cmacexp.el 13.8 KB
Newer Older
1
;;; cmacexp.el --- expand C macros in a region
Eric S. Raymond's avatar
Eric S. Raymond committed
2

Richard M. Stallman's avatar
Richard M. Stallman committed
3
;; Copyright (C) 1992, 1994, 1996 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

5 6
;; Author: Francesco Potorti` <pot@cnuce.cnr.it>
;; Adapted-By: ESR
Eric S. Raymond's avatar
Eric S. Raymond committed
7 8
;; Keywords: c

Jim Blandy's avatar
Jim Blandy committed
9 10 11 12
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
Eric S. Raymond's avatar
Eric S. Raymond committed
13
;; the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
14 15 16 17 18 19 20 21
;; any later version.

;; GNU Emacs 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
Erik Naggum's avatar
Erik Naggum committed
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Jim Blandy's avatar
Jim Blandy committed
25

Richard M. Stallman's avatar
Richard M. Stallman committed
26
;; USAGE =============================================================
27

28 29 30
;; In C mode C-C C-e is bound to c-macro-expand.  The result of the
;; expansion is put in a separate buffer.  A user option allows the
;; window displaying the buffer to be optimally sized.
31
;;
32
;; When called with a C-u prefix, c-macro-expand replaces the selected
Richard M. Stallman's avatar
Richard M. Stallman committed
33
;; region with the expansion.  Both the preprocessor name and the
34 35 36 37 38 39
;; initial flag can be set by the user.  If c-macro-prompt-flag is set
;; to a non-nil value the user is offered to change the options to the
;; preprocessor each time c-macro-expand is invoked.  Preprocessor
;; arguments default to the last ones entered.  If c-macro-prompt-flag
;; is nil, one must use M-x set-variable to set a different value for
;; c-macro-cppflags.
40 41 42 43 44

;; A c-macro-expansion function is provided for non-interactive use.

;; INSTALLATION ======================================================

45
;; Put the following in your ~/.emacs file.
46 47 48

;; If you want the *Macroexpansion* window to be not higher than
;; necessary: 
49
;;(setq c-macro-shrink-window-flag t)
50
;;
51 52 53 54 55
;; If you use a preprocessor other than /lib/cpp (be careful to set a
;; -C option or equivalent in order to make the preprocessor not to
;; strip the comments):
;;(setq c-macro-preprocessor "gpp -C")
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
56 57
;; If you often use a particular set of flags:
;;(setq c-macro-cppflags "-I /usr/include/local -DDEBUG"
58
;;
Richard M. Stallman's avatar
Richard M. Stallman committed
59
;; If you want the "Preprocessor arguments: " prompt:
60
;;(setq c-macro-prompt-flag t)
61 62 63 64 65 66 67 68

;; BUG REPORTS =======================================================

;; Please report bugs, suggestions, complaints and so on to
;; pot@cnuce.cnr.it (Francesco Potorti`).

;; IMPROVEMENTS OVER emacs 18.xx cmacexp.el ==========================

69
;; - A lot of user and programmer visible changes.  See above.
70 71 72 73 74 75 76 77 78
;; - #line directives are inserted, so __LINE__ and __FILE__ are
;;   correctly expanded.  Works even with START inside a string, a
;;   comment or a region #ifdef'd away by cpp. cpp is invoked with -C,
;;   making comments visible in the expansion.
;; - All work is done in core memory, no need for temporary files.

;; ACKNOWLEDGEMENTS ==================================================

;; A lot of thanks to Don Maszle who did a great work of testing, bug
79 80
;; reporting and suggestion of new features.  This work has been
;; partially inspired by Don Maszle and Jonathan Segal's.
81

Richard M. Stallman's avatar
Richard M. Stallman committed
82
;; BUGS ==============================================================
83 84 85

;; If the start point of the region is inside a macro definition the
;; macro expansion is often inaccurate.
86

Richard M. Stallman's avatar
Richard M. Stallman committed
87

Richard M. Stallman's avatar
Richard M. Stallman committed
88 89
(require 'cc-mode)

Richard M. Stallman's avatar
Richard M. Stallman committed
90
(provide 'cmacexp)
Jim Blandy's avatar
Jim Blandy committed
91

92 93 94
(defgroup c-macro nil
  "Expand C macros in a region."
  :group 'c)
95 96


97 98 99 100 101 102 103 104 105 106 107
(defcustom c-macro-shrink-window-flag nil
  "*Non-nil means shrink the *Macroexpansion* window to fit its contents."
  :type 'boolean
  :group 'c-macro)

(defcustom c-macro-prompt-flag nil
  "*Non-nil makes `c-macro-expand' prompt for preprocessor arguments."
  :type 'boolean
  :group 'c-macro)

(defcustom c-macro-preprocessor
108
  ;; Cannot rely on standard directory on MS-DOS to find CPP.
109 110 111 112 113 114 115
  (cond ((eq system-type 'ms-dos) "cpp -C")
	;; Solaris has it in an unusual place.
	((and (string-match "^[^-]*-[^-]*-\\(solaris\\|sunos5\\)"
			    system-configuration)
	      (file-exists-p "/opt/SUNWspro/SC3.0.1/bin/acomp"))
	 "/opt/SUNWspro/SC3.0.1/bin/acomp -C -E")
	(t "/lib/cpp -C"))
Richard M. Stallman's avatar
Richard M. Stallman committed
116
  "The preprocessor used by the cmacexp package.
117

Richard M. Stallman's avatar
Richard M. Stallman committed
118
If you change this, be sure to preserve the `-C' (don't strip comments)
119 120 121 122 123 124 125 126
option, or to set an equivalent one."
  :type 'string
  :group 'c-macro)

(defcustom c-macro-cppflags ""
  "*Preprocessor flags used by `c-macro-expand'."
  :type 'string
  :group 'c-macro)
127 128 129

(defconst c-macro-buffer-name "*Macroexpansion*")

130
;;;###autoload
Richard M. Stallman's avatar
Richard M. Stallman committed
131 132 133 134 135 136 137 138
(defun c-macro-expand (start end subst)
  "Expand C macros in the region, using the C preprocessor.
Normally display output in temp buffer, but
prefix arg means replace the region with it.

`c-macro-preprocessor' specifies the preprocessor to use.
Prompt for arguments to the preprocessor \(e.g. `-DDEBUG -I ./include')
if the user option `c-macro-prompt-flag' is non-nil.
139

Richard M. Stallman's avatar
Richard M. Stallman committed
140
Noninteractive args are START, END, SUBST.
Richard M. Stallman's avatar
Richard M. Stallman committed
141
For use inside Lisp programs, see also `c-macro-expansion'."
142 143

  (interactive "r\nP")
Richard M. Stallman's avatar
Richard M. Stallman committed
144 145 146 147
  (let ((inbuf (current-buffer))
	(displaybuf (if subst
			(get-buffer c-macro-buffer-name)
		      (get-buffer-create c-macro-buffer-name)))
148
	(expansion ""))
149
    ;; Build the command string.
Richard M. Stallman's avatar
Richard M. Stallman committed
150
    (if c-macro-prompt-flag
Richard M. Stallman's avatar
Richard M. Stallman committed
151
	(setq c-macro-cppflags
152
	      (read-string "Preprocessor arguments: "
Richard M. Stallman's avatar
Richard M. Stallman committed
153
			   c-macro-cppflags)))
154 155
    ;; Decide where to display output.
    (if (and subst
156
	     (and buffer-read-only (not inhibit-read-only))
157 158 159 160 161 162 163 164 165
	     (not (eq inbuf displaybuf)))
	(progn
	  (message
	   "Buffer is read only: displaying expansion in alternate window")
	  (sit-for 2)
	  (setq subst nil)
	  (or displaybuf
	      (setq displaybuf (get-buffer-create c-macro-buffer-name)))))
    ;; Expand the macro and output it.
Richard M. Stallman's avatar
Richard M. Stallman committed
166 167
    (setq expansion (c-macro-expansion start end
				       (concat c-macro-preprocessor " "
168
					       c-macro-cppflags) t))
169 170 171 172 173 174 175 176
    (if subst
	(let ((exchange (= (point) start)))
	  (delete-region start end)
	  (insert expansion)
	  (if exchange
	      (exchange-point-and-mark)))
      (set-buffer displaybuf)
      (setq buffer-read-only nil)
177
      (buffer-disable-undo displaybuf)
178 179 180 181 182
      (erase-buffer)
      (insert expansion)
      (set-buffer-modified-p nil)
      (if (string= "" expansion)
	  (message "Null expansion")
Richard M. Stallman's avatar
Richard M. Stallman committed
183
	(c-macro-display-buffer))
184
      (setq buffer-read-only t)
Richard M. Stallman's avatar
Richard M. Stallman committed
185
      (setq buffer-auto-save-file-name nil)
186 187 188 189 190
      (bury-buffer displaybuf))))


;; Display the current buffer in a window which is either just large
;; enough to contain the entire buffer, or half the size of the
Richard M. Stallman's avatar
Richard M. Stallman committed
191 192
;; screen, whichever is smaller.  Do not select the new
;; window.
193 194 195 196 197 198 199
;;
;; Several factors influence window resizing so that the window is
;; sized optimally if it is created anew, and so that it is messed
;; with minimally if it has been created by the user.  If the window
;; chosen for display exists already but contains something else, the
;; window is not re-sized.  If the window already contains the current
;; buffer, it is never shrunk, but possibly expanded.  Finally, if the
Richard M. Stallman's avatar
Richard M. Stallman committed
200
;; variable c-macro-shrink-window-flag is nil the window size is *never*
201
;; changed.
Richard M. Stallman's avatar
Richard M. Stallman committed
202
(defun c-macro-display-buffer ()
203 204 205 206 207
  (goto-char (point-min))
  (c-mode)
  (let ((oldwinheight (window-height))
	(alreadythere			;the window was already there
	 (get-buffer-window (current-buffer)))
208
	(popped nil))			;the window popped changing the layout 
209 210 211 212
    (or alreadythere
	(progn
	  (display-buffer (current-buffer) t)
	  (setq popped (/= oldwinheight (window-height)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
213
    (if (and c-macro-shrink-window-flag	;user wants fancy shrinking :\)
214 215 216 217 218 219 220 221 222 223
	     (or alreadythere popped))
	;; Enlarge up to half screen, or shrink properly.
	(let ((oldwin (selected-window))
	      (minheight 0)
	      (maxheight 0))
	  (save-excursion
	    (select-window (get-buffer-window (current-buffer)))
	    (setq minheight (if alreadythere
				(window-height)
			      window-min-height))
224
	    (setq maxheight (/ (frame-height) 2))
225 226
	    (enlarge-window (- (min maxheight
				    (max minheight
Richard M. Stallman's avatar
Richard M. Stallman committed
227
					 (+ 2 (vertical-motion (point-max)))))
228 229 230 231 232
			       (window-height)))
	    (goto-char (point-min))
	    (select-window oldwin))))))


233
(defun c-macro-expansion (start end cppcommand &optional display)
Richard M. Stallman's avatar
Richard M. Stallman committed
234
  "Run a preprocessor on region and return the output as a string.
Richard M. Stallman's avatar
Richard M. Stallman committed
235 236
Expand the region between START and END in the current buffer using
the shell command CPPCOMMAND (e.g. \"/lib/cpp -C -DDEBUG\").
237 238
Be sure to use a -C (don't strip comments) or equivalent option.
Optional arg DISPLAY non-nil means show messages in the echo area."
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257

;; Copy the current buffer's contents to a temporary hidden buffer.
;; Delete from END to end of buffer.  Insert a preprocessor #line
;; directive at START and after each #endif following START that are
;; not inside a comment or a string.  Put all the strings thus
;; inserted (without the "line" substring) in a list named linelist.
;; If START is inside a comment, prepend "*/" and append "/*" to the
;; #line directive.  If inside a string, prepend and append "\"".
;; Preprocess the buffer contents, then look for all the lines stored
;; in linelist starting from end of buffer.  The last line so found is
;; where START was, so return the substring from point to end of
;; buffer. 
  (let ((inbuf (current-buffer))
	(outbuf (get-buffer-create " *C Macro Expansion*"))
	(filename (if (and buffer-file-name
			   (string-match (regexp-quote default-directory)
					 buffer-file-name))
		      (substring buffer-file-name (match-end 0))
		    (buffer-name)))
258 259 260 261
	(mymsg (format "Invoking %s%s%s on region..."
		       c-macro-preprocessor
		       (if (string= "" c-macro-cppflags) "" " ")
		       c-macro-cppflags))
262
	(uniquestring "??? !!! ??? start of c-macro expansion ??? !!! ???")
263
	(startlinenum 0)
264
	(linenum 0)
265
	(startstat ())
Richard M. Stallman's avatar
Richard M. Stallman committed
266
	(startmarker "")
267
	(exit-status 0)
Stefan Monnier's avatar
Stefan Monnier committed
268
	(tempname (make-temp-file
Richard M. Stallman's avatar
Richard M. Stallman committed
269
		   (expand-file-name "cmacexp"
270 271
				     (or small-temporary-file-directory
					 temporary-file-directory)))))
272 273 274 275
    (unwind-protect
	(save-excursion
	  (save-restriction
	    (widen)
276 277 278 279 280
            (let ((in-syntax-table (syntax-table)))
              (set-buffer outbuf)
              (setq buffer-read-only nil)
              (erase-buffer)
              (set-syntax-table in-syntax-table))
281 282 283
	    (insert-buffer-substring inbuf 1 end))

	  ;; We have copied inbuf to outbuf.  Point is at end of
284 285 286
	  ;; outbuf.  Inset a newline at the end, so cpp can correctly
	  ;; parse a token ending at END.
          (insert "\n")
287

288 289 290 291 292
	  ;; Save sexp status and line number at START.
	  (setq startstat (parse-partial-sexp 1 start))
	  (setq startlinenum (+ (count-lines 1 (point))
				(if (bolp) 1 0)))

293
	  ;; Now we insert the #line directives after all #endif or
294 295
	  ;; #else following START going backward, so the lines we
	  ;; insert don't change the line numbers.
296
	  ;(switch-to-buffer outbuf) (debug)	;debugging instructions
297
	  (goto-char (point-max))
298
	  (while (re-search-backward "\n#\\(endif\\|else\\)\\>" start 'move)
299 300
	    (if (equal (nthcdr 3 (parse-partial-sexp start (point)
						     nil nil startstat))
Richard M. Stallman's avatar
Richard M. Stallman committed
301
		       '(nil nil nil 0 nil)) ;neither in string nor in
302
					     ;comment nor after quote
303 304
		(progn
		  (goto-char (match-end 0))
305 306 307 308 309 310 311
		  (setq linenum (+ startlinenum
				   (count-lines start (point))))
		  (insert (format "\n#line %d \"%s\"\n" linenum filename))
		  (goto-char (match-beginning 0)))))

	  ;; Now we are at START.  Insert the first #line directive.
	  ;; This must work even inside a string or comment, or after a
312
	  ;; quote.
313 314 315 316 317 318 319 320 321 322
	  (let* ((startinstring (nth 3 startstat))
		 (startincomment (nth 4 startstat))
		 (startafterquote (nth 5 startstat))
		 (startinbcomment (nth 7 startstat)))
	    (insert (if startafterquote " " "")
		    (cond (startinstring
			   (char-to-string startinstring))
			  (startincomment "*/")
			  (""))
		    (setq startmarker
323
			  (concat "\n" uniquestring
324 325 326 327
				  (cond (startinstring
					 (char-to-string startinstring))
					(startincomment "/*")
					(startinbcomment "//"))
328 329
				  (if startafterquote "\\")))
		    (format "\n#line %d \"%s\"\n" startlinenum filename)))
330 331

	  ;; Call the preprocessor.
332
	  (if display (message mymsg))
Richard M. Stallman's avatar
Richard M. Stallman committed
333
	  (setq exit-status
334 335 336 337
		(call-process-region 1 (point-max)
				     shell-file-name
				     t (list t tempname) nil "-c"
				     cppcommand))
338
	  (if display (message (concat mymsg "done")))
339 340 341 342 343 344 345 346
	  (if (= (buffer-size) 0)
	      ;; Empty output is normal after a fatal error.
	      (insert "\nPreprocessor produced no output\n")
	    ;; Find and delete the mark of the start of the expansion.
	    ;; Look for `# nn "file.c"' lines and delete them.
	    (goto-char (point-min))
	    (search-forward startmarker)
	    (delete-region 1 (point)))
347 348 349 350 351 352 353
	  (while (re-search-forward (concat "^# [0-9]+ \""
					    (regexp-quote filename)
					    "\"") nil t)
	    (beginning-of-line)
	    (let ((beg (point)))
	      (forward-line 1)
	      (delete-region beg (point))))
354

Richard M. Stallman's avatar
Richard M. Stallman committed
355
	  ;; If CPP got errors, show them at the beginning.
356 357 358 359 360 361 362 363 364
	  ;; MS-DOS shells don't return the exit code of their children.
	  ;; Look at the size of the error message file instead, but
	  ;; don't punish those MS-DOS users who have a shell that does
	  ;; return an error code.
	  (or (and (or (not (boundp 'msdos-shells))
		       (not (member (file-name-nondirectory shell-file-name)
				    msdos-shells)))
		   (eq exit-status 0))
	      (zerop (nth 7 (file-attributes (expand-file-name tempname))))
Richard M. Stallman's avatar
Richard M. Stallman committed
365 366
	      (progn
		(goto-char (point-min))
367 368 369 370 371 372 373 374
		;; Put the messages inside a comment, so they won't get in
		;; the way of font-lock, highlighting etc.
		(insert
		 (format "/* Preprocessor terminated with status %s\n\n   Messages from `%s\':\n\n"
			 exit-status cppcommand))
		(goto-char (+ (point)
			      (nth 1 (insert-file-contents tempname))))
		(insert "\n\n*/\n")))
Richard M. Stallman's avatar
Richard M. Stallman committed
375 376
	  (delete-file tempname)

377 378
	  ;; Compute the return value, keeping in account the space
	  ;; inserted at the end of the buffer.
379
	  (buffer-substring 1 (max 1 (- (point-max) 1))))
380 381 382 383

      ;; Cleanup.
      (kill-buffer outbuf))))

Richard M. Stallman's avatar
Richard M. Stallman committed
384
;;; cmacexp.el ends here