;;; cmacexp.el --- expand C macros in a region
-;; Copyright (C) 1992 Free Software Foundation, Inc.
+;; Copyright (C) 1992, 1994, 1996, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
+;; Free Software Foundation, Inc.
-;; Author: Francesco Potorti` <pot@cnuce.cnr.it>
-;; Version: $Id: cmacexp.el,v 1.10 1994/02/25 06:27:24 rms Exp rms $
+;; Author: Francesco Potorti` <pot@gnu.org>
;; Adapted-By: ESR
;; Keywords: c
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING. If not, write to
-;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
+;; along with GNU Emacs; see the file COPYING. If not, write to the
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
+
+;;; Commentary:
;; USAGE =============================================================
-;; In C mode C-M-x is bound to c-macro-expand. The result of the
-;; expansion is put in a separate buffer. The buffer is put in
-;; view-mode if the Inge Frick's view.el is installed. A user option
-;; allows the window displaying the buffer to be optimally sized.
+;; 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.
;;
;; When called with a C-u prefix, c-macro-expand replaces the selected
;; region with the expansion. Both the preprocessor name and the
-;; initial flag can be set by the user. If c-macro-prompt-p
-;; is set to a non-nil value the user is offered to change the flags
-;; to the preprocessor each time c-macro-expand is invoked.
-;; Preprocessor arguments default to the last ones entered.
-;; If c-macro-prompt is nil, one must use M-x set-variable to set a
-;; different value for c-macro-cppflags.
+;; 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.
;; A c-macro-expansion function is provided for non-interactive use.
;; INSTALLATION ======================================================
-;; Put this file on your load-path, byte compile it for increased
-;; speed and put part or all of the following in your ~/.emacs file.
+;; Put the following in your ~/.emacs file.
-;; To make a directory ~/emacs be in front of your load-path:
-;;(setq load-path (cons (expand-file-name "~/emacs") load-path))
-;;
-;; Suggested keybinding (work only in c-mode):
-;;(if (boundp 'c-mode-map)
-;; (define-key c-mode-map "\C-x\C-e" 'c-macro-expand))
-;;(if (boundp 'c++-mode-map)
-;; (define-key c++-mode-map "\C-x\C-e" 'c-macro-expand))
-;;
;; If you want the *Macroexpansion* window to be not higher than
-;; necessary:
-;;(setq c-macro-shrink-window-p t)
+;; necessary:
+;;(setq c-macro-shrink-window-flag t)
;;
;; 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
;;(setq c-macro-cppflags "-I /usr/include/local -DDEBUG"
;;
;; If you want the "Preprocessor arguments: " prompt:
-;;(setq c-macro-prompt-p t)
+;;(setq c-macro-prompt-flag t)
;; BUG REPORTS =======================================================
;; Please report bugs, suggestions, complaints and so on to
-;; pot@cnuce.cnr.it (Francesco Potorti`).
+;; pot@gnu.org (Francesco Potorti`).
;; IMPROVEMENTS OVER emacs 18.xx cmacexp.el ==========================
-;; - A lot of user visible changes. See above.
+;; - A lot of user and programmer visible changes. See above.
;; - #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.
-;; - The /lib/cpp process is run synchronously. This fixes an
-;; infinite loop bug on Motorola Delta (cpp waiting forever for
-;; end-of-file, don't know why). Fixes a similar intermittent
-;; problem on SunOS 4.1.
;; ACKNOWLEDGEMENTS ==================================================
;; A lot of thanks to Don Maszle who did a great work of testing, bug
-;; reporting and suggestion of new features and to Inge Fricks for her
-;; help with view.el. This work has been partially inspired by Don
-;; Maszle and Jonathan Segal's.
-
-;; By the way, I recommend you Inge Frick's view.el. It works like
-;; the standard view, but *it is not recursive* and has some more
-;; commands. Moreover it is a minor mode, so you preserve all your
-;; major mode keybindings (well, not always :). Mail me to obtain a
-;; copy, or get it by anonymous ftp in fly.cnuce.cnr.it:pub/view.el.
+;; reporting and suggestion of new features. This work has been
+;; partially inspired by Don Maszle and Jonathan Segal's.
;; BUGS ==============================================================
;; If the start point of the region is inside a macro definition the
;; macro expansion is often inaccurate.
+;;; Code:
-(provide 'cmacexp)
-
-(defvar c-macro-shrink-window-p nil
- "*Non-nil means shrink the *Macroexpansion* window to fit its contents.")
-
-(defvar c-macro-prompt-p nil
- "*Non-nil makes c-macro-expand prompt for preprocessor arguments.")
+(require 'cc-mode)
-(defvar c-macro-preprocessor "/lib/cpp -C" "\
-The preprocessor used by the cmacexp package.
-
-If you change this, be sure to preserve the -C (don't strip comments)
-option, or to set an equivalent one.")
+(provide 'cmacexp)
-(defvar c-macro-cppflags ""
- "*Preprocessor flags used by c-macro-expand.")
+(defvar msdos-shells)
+
+
+(defgroup c-macro nil
+ "Expand C macros in a region."
+ :group 'c)
+
+
+(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
+ (cond ;; 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")
+ ((locate-file "/usr/ccs/lib/cpp"
+ '("/") exec-suffixes 'file-executable-p)
+ "/usr/ccs/lib/cpp -C")
+ ((locate-file "/lib/cpp"
+ '("/") exec-suffixes 'file-executable-p)
+ "/lib/cpp -C")
+ ;; On some systems, we cannot rely on standard directories to
+ ;; find CPP. In fact, we cannot rely on having cpp, either,
+ ;; in some GCC versions.
+ ((locate-file "cpp" exec-path exec-suffixes 'file-executable-p)
+ "cpp -C")
+ (t "gcc -E -C -o - -"))
+ "The preprocessor used by the cmacexp package.
+
+If you change this, be sure to preserve the `-C' (don't strip comments)
+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)
(defconst c-macro-buffer-name "*Macroexpansion*")
-(defun c-macro-expand (start end subst) "\
-Expand all C macros occurring in the region using c-macro-preprocessor.
-Normally display output in temp buffer.
-Prefix arg means replace the region with it.
-Prompt for a string of arguments to the preprocessor
-\(e.g. -DDEBUG -I ./include) if the user option c-macro-prompt-p is non-nil.
+;;;###autoload
+(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.
+Tf the user option `c-macro-prompt-flag' is non-nil
+prompt for arguments to the preprocessor \(e.g. `-DDEBUG -I ./include'),
+otherwise use `c-macro-cppflags'.
Noninteractive args are START, END, SUBST.
-For use inside programs see also c-macro-expansion."
+For use inside Lisp programs, see also `c-macro-expansion'."
(interactive "r\nP")
(let ((inbuf (current-buffer))
(displaybuf (if subst
(get-buffer c-macro-buffer-name)
(get-buffer-create c-macro-buffer-name)))
- (expansion "")
- (mymsg ""))
+ (expansion ""))
;; Build the command string.
- (if c-macro-prompt-p
+ (if c-macro-prompt-flag
(setq c-macro-cppflags
(read-string "Preprocessor arguments: "
c-macro-cppflags)))
- (setq mymsg (format "Invoking %s%s%s on region..."
- c-macro-preprocessor
- (if (string= "" c-macro-cppflags) "" " ")
- c-macro-cppflags))
;; Decide where to display output.
(if (and subst
(and buffer-read-only (not inhibit-read-only))
(or displaybuf
(setq displaybuf (get-buffer-create c-macro-buffer-name)))))
;; Expand the macro and output it.
- (message mymsg)
(setq expansion (c-macro-expansion start end
(concat c-macro-preprocessor " "
- c-macro-cppflags)))
- (message (concat mymsg "done"))
+ c-macro-cppflags) t))
(if subst
(let ((exchange (= (point) start)))
(delete-region start end)
(exchange-point-and-mark)))
(set-buffer displaybuf)
(setq buffer-read-only nil)
- (buffer-flush-undo displaybuf)
+ (buffer-disable-undo displaybuf)
(erase-buffer)
(insert expansion)
(set-buffer-modified-p nil)
;; 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
-;; variable c-macro-shrink-window-p is nil the window size is *never*
+;; variable c-macro-shrink-window-flag is nil the window size is *never*
;; changed.
(defun c-macro-display-buffer ()
-
(goto-char (point-min))
(c-mode)
(let ((oldwinheight (window-height))
(alreadythere ;the window was already there
(get-buffer-window (current-buffer)))
- (popped nil)) ;the window popped changing the layout
+ (popped nil)) ;the window popped changing the layout
(or alreadythere
(progn
(display-buffer (current-buffer) t)
(setq popped (/= oldwinheight (window-height)))))
- (if (and c-macro-shrink-window-p ;user wants fancy shrinking :\)
+ (if (and c-macro-shrink-window-flag ;user wants fancy shrinking :\)
(or alreadythere popped))
;; Enlarge up to half screen, or shrink properly.
(let ((oldwin (selected-window))
(setq minheight (if alreadythere
(window-height)
window-min-height))
- (setq maxheight (/ (screen-height) 2))
+ (setq maxheight (/ (frame-height) 2))
(enlarge-window (- (min maxheight
(max minheight
(+ 2 (vertical-motion (point-max)))))
(select-window oldwin))))))
-(defun c-macro-expansion (start end cppcommand) "\
-Run a preprocessor on region and return the output as a string.
+(defun c-macro-expansion (start end cppcommand &optional display)
+ "Run a preprocessor on region and return the output as a string.
Expand the region between START and END in the current buffer using
the shell command CPPCOMMAND (e.g. \"/lib/cpp -C -DDEBUG\").
-Be sure to use a -C (don't strip comments) or equivalent option."
+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."
;; Copy the current buffer's contents to a temporary hidden buffer.
;; Delete from END to end of buffer. Insert a preprocessor #line
;; 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.
+;; buffer.
(let ((inbuf (current-buffer))
(outbuf (get-buffer-create " *C Macro Expansion*"))
(filename (if (and buffer-file-name
buffer-file-name))
(substring buffer-file-name (match-end 0))
(buffer-name)))
- (start-state)
+ (mymsg (format "Invoking %s%s%s on region..."
+ c-macro-preprocessor
+ (if (string= "" c-macro-cppflags) "" " ")
+ c-macro-cppflags))
+ (uniquestring "??? !!! ??? start of c-macro expansion ??? !!! ???")
+ (startlinenum 0)
(linenum 0)
- (linelist ()))
+ (startstat ())
+ (startmarker "")
+ (exit-status 0)
+ (tempname (make-temp-file
+ (expand-file-name "cmacexp"
+ (or small-temporary-file-directory
+ temporary-file-directory)))))
(unwind-protect
(save-excursion
(save-restriction
(widen)
- (set-buffer outbuf)
- (setq buffer-read-only nil)
- (erase-buffer)
- (set-syntax-table c-mode-syntax-table)
+ (let ((in-syntax-table (syntax-table)))
+ (set-buffer outbuf)
+ (setq buffer-read-only nil)
+ (erase-buffer)
+ (set-syntax-table in-syntax-table))
(insert-buffer-substring inbuf 1 end))
;; We have copied inbuf to outbuf. Point is at end of
- ;; outbuf. Insert a space at the end, so cpp can correctly
- ;; parse a token ending at END.
+ ;; outbuf. Inset a newline at the end, so cpp can correctly
+ ;; parse a token ending at END.
+ (insert "\n")
- (insert " ")
+ ;; 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)))
- (save-excursion
- (goto-char start)
- (setq start-state (parse-partial-sexp 1 (point))))
;; Now we insert the #line directives after all #endif or
- ;; #else following START.
+ ;; #else following START going backward, so the lines we
+ ;; insert don't change the line numbers.
;(switch-to-buffer outbuf) (debug) ;debugging instructions
+ (goto-char (point-max))
(while (re-search-backward "\n#\\(endif\\|else\\)\\>" start 'move)
- (if (equal (nthcdr 3 (parse-partial-sexp start (point) start-state))
- '(nil nil nil 0)) ;neither in string nor in
- ;comment nor after quote
+ (if (equal (nthcdr 3 (parse-partial-sexp start (point)
+ nil nil startstat))
+ '(nil nil nil 0 nil)) ;neither in string nor in
+ ;comment nor after quote
(progn
(goto-char (match-end 0))
-;;; (setq linenum (count-lines 1 (point)))
- (setq linelist
- ;; This used to be a #line command
- ;; but it's not guaranteed that the output
- ;; will have properly matching commands.
- ;; Only the *line numbers* have to agree!
- (cons (format "\n???!!!???!!!!\n")
- linelist))
- (insert (car linelist))
- (skip-chars-backward "^#")
- (insert "line")
- (goto-char (match-beginning 0)))))
-
- ;; We are at START. Insert the first #line directive. This
- ;; must work even inside a string or comment, or after a
+ (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
;; quote.
-;;; (setq linenum (+ (count-lines 1 (point))
-;;; (if (bolp) 1 0)))
- (setq linelist
- (cons
- (let* ((startstat (parse-partial-sexp 1 start))
- (startinstring (nth 3 startstat))
- (startincomment (nth 4 startstat))
- (startafterquote (nth 5 startstat)))
- (concat (if startafterquote " ")
- (cond (startinstring (char-to-string startinstring))
- (startincomment "*/"))
- (format "\n???!!!???!!!!")
- (cond (startinstring (char-to-string startinstring))
- (startincomment "/*"))
- (if startafterquote "\\")))
- linelist))
- (insert (car linelist))
- (skip-chars-backward "^#")
- (insert "line")
+ (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
+ (concat "\n" uniquestring
+ (cond (startinstring
+ (char-to-string startinstring))
+ (startincomment "/*")
+ (startinbcomment "//"))
+ (if startafterquote "\\")))
+ (format "\n#line %d \"%s\"\n" startlinenum filename)))
;; Call the preprocessor.
- (call-process-region 1 (point-max) "sh" t t nil "-c"
- (concat cppcommand " 2>/dev/null"))
+ (if display (message "%s" mymsg))
+ (setq exit-status
+ (call-process-region 1 (point-max)
+ shell-file-name
+ t (list t tempname) nil "-c"
+ cppcommand))
+ (if display (message "%s" (concat mymsg "done")))
+ (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)))
+ (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))))
+
+ ;; If CPP got errors, show them at the beginning.
+ ;; 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))))
+ (progn
+ (goto-char (point-min))
+ ;; 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")))
+ (delete-file tempname)
- (while (search-backward "\n???!!!???!!!!" nil t)
- (replace-match ""))
-
;; Compute the return value, keeping in account the space
;; inserted at the end of the buffer.
- (buffer-substring (point) (max (point) (- (point-max) 1))))
+ (buffer-substring 1 (max 1 (- (point-max) 1))))
;; Cleanup.
(kill-buffer outbuf))))
+;;; arch-tag: 4f20253c-71ef-4e6d-a774-19087060910e
;;; cmacexp.el ends here