1 ;;; makeinfo.el --- run makeinfo conveniently
3 ;; Copyright (C) 1991, 1993 Free Software Foundation, Inc.
5 ;; Author: Robert J. Chassell
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
27 ;;; The Texinfo mode `makeinfo' related commands are:
29 ;; makeinfo-region to run makeinfo on the current region.
30 ;; makeinfo-buffer to run makeinfo on the current buffer, or
31 ;; with optional prefix arg, on current region
32 ;; kill-compilation to kill currently running makeinfo job
33 ;; makeinfo-recenter-makeinfo-buffer to redisplay *compilation* buffer
35 ;;; Keybindings (defined in `texinfo.el')
38 ; (define-key texinfo-mode-map "\C-c\C-m\C-r" 'makeinfo-region)
39 ; (define-key texinfo-mode-map "\C-c\C-m\C-b" 'makeinfo-buffer)
40 ; (define-key texinfo-mode-map "\C-c\C-m\C-k" 'kill-compilation)
41 ; (define-key texinfo-mode-map "\C-c\C-m\C-l"
42 ; 'makeinfo-recenter-compilation-buffer)
46 ;;; Variables used by `makeinfo'
50 (defvar makeinfo-run-command
"makeinfo"
51 "*Command used to run `makeinfo' subjob.
52 The name of the file is appended to this string, separated by a space.")
54 (defvar makeinfo-options
"--fill-column=70"
55 "*String containing options for running `makeinfo'.
56 Do not include `--footnote-style' or `--paragraph-indent';
57 the proper way to specify those is with the Texinfo commands
58 `@footnotestyle` and `@paragraphindent'.")
62 (defvar makeinfo-compilation-process nil
63 "Process that runs `makeinfo'. Should start out nil.")
65 (defvar makeinfo-temp-file nil
66 "Temporary file name used for text being sent as input to `makeinfo'.")
68 (defvar makeinfo-output-file-name nil
69 "Info file name used for text output by `makeinfo'.")
72 ;;; The `makeinfo' function definitions
74 (defun makeinfo-region (region-beginning region-end
)
75 "Make Info file from region of current Texinfo file, and switch to it.
77 This command does not offer the `next-error' feature since it would
78 apply to a temporary file, not the original; use the `makeinfo-buffer'
79 command to gain use of `next-error'."
82 (let (filename-or-header
83 filename-or-header-beginning
84 filename-or-header-end
)
85 ;; Cannot use `let' for makeinfo-temp-file or
86 ;; makeinfo-output-file-name since `makeinfo-compilation-sentinel'
89 (setq makeinfo-temp-file
92 (substring (buffer-file-name)
94 (or (string-match "\\.tex" (buffer-file-name))
95 (length (buffer-file-name)))))
101 (goto-char (point-min))
102 (let ((search-end (save-excursion (forward-line 100) (point))))
103 ;; Find and record the Info filename,
104 ;; or else explain that a filename is needed.
105 (if (re-search-forward
106 "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*"
108 (setq makeinfo-output-file-name
109 (buffer-substring (match-beginning 1) (match-end 1)))
111 "The texinfo file needs a line saying: @setfilename <name>"))
113 ;; Find header and specify its beginning and end.
114 (goto-char (point-min))
117 (search-forward tex-start-of-header search-end t
)
119 ;; Mark beginning of header.
120 (setq filename-or-header-beginning
(point)))
122 (search-forward tex-end-of-header nil t
)
124 ;; Mark end of header
125 (setq filename-or-header-end
(point))))
127 ;; Insert the header into the temporary file.
129 (min filename-or-header-beginning region-beginning
)
130 filename-or-header-end
131 makeinfo-temp-file nil nil
)
133 ;; Else no header; insert @filename line into temporary file.
134 (goto-char (point-min))
135 (search-forward "@setfilename" search-end t
)
137 (setq filename-or-header-beginning
(point))
139 (setq filename-or-header-end
(point))
141 (min filename-or-header-beginning region-beginning
)
142 filename-or-header-end
143 makeinfo-temp-file nil nil
))
145 ;; Insert the region into the file.
147 (max region-beginning filename-or-header-end
)
149 makeinfo-temp-file t nil
)
151 ;; Run the `makeinfo-compile' command in the *compilation* buffer
154 (concat makeinfo-run-command
159 "Use `makeinfo-buffer' to gain use of the `next-error' command"
162 ;;; Actually run makeinfo. COMMAND is the command to run.
163 ;;; ERROR-MESSAGE is what to say when next-error can't find another error.
164 ;;; If PARSE-ERRORS is non-nil, do try to parse error messages.
165 (defun makeinfo-compile (command error-message parse-errors
)
167 (compile-internal command error-message nil
168 (and (not parse-errors
)
169 ;; If we do want to parse errors, pass nil.
170 ;; Otherwise, use this function, which won't
171 ;; ever find any errors.
172 '(lambda (&rest ignore
)
173 (setq compilation-error-list nil
))))))
174 (set-process-sentinel (get-buffer-process buffer
)
175 'makeinfo-compilation-sentinel
)))
177 ;; Delete makeinfo-temp-file after processing is finished,
178 ;; and visit Info file.
179 ;; This function is called when the compilation process changes state.
180 ;; Based on `compilation-sentinel' in compile.el
181 (defun makeinfo-compilation-sentinel (proc msg
)
182 (compilation-sentinel proc msg
)
183 (if (and makeinfo-temp-file
(file-exists-p makeinfo-temp-file
))
184 (delete-file makeinfo-temp-file
))
185 ;; Always use the version on disk.
186 (if (get-file-buffer makeinfo-output-file-name
)
187 (progn (set-buffer makeinfo-output-file-name
)
189 (find-file makeinfo-output-file-name
))
190 (goto-char (point-min)))
192 (defun makeinfo-buffer ()
193 "Make Info file from current buffer.
195 Use the \\[next-error] command to move to the next error
196 \(if there are errors\)."
199 (cond ((null buffer-file-name
)
200 (error "Buffer not visiting any file"))
202 (if (y-or-n-p "Buffer modified; do you want to save it? ")
205 ;; Find and record the Info filename,
206 ;; or else explain that a filename is needed.
208 (goto-char (point-min))
209 (let ((search-end (save-excursion (forward-line 100) (point))))
210 (if (re-search-forward
211 "^@setfilename[ \t]+\\([^ \t\n]+\\)[ \t]*"
213 (setq makeinfo-output-file-name
214 (buffer-substring (match-beginning 1) (match-end 1)))
216 "The texinfo file needs a line saying: @setfilename <name>"))))
220 (concat makeinfo-run-command
" " makeinfo-options
221 " " buffer-file-name
)
225 (defun makeinfo-recenter-compilation-buffer (linenum)
226 "Redisplay `*compilation*' buffer so most recent output can be seen.
227 The last line of the buffer is displayed on
228 line LINE of the window, or centered if LINE is nil."
230 (let ((makeinfo-buffer (get-buffer "*compilation*"))
231 (old-buffer (current-buffer)))
232 (if (null makeinfo-buffer
)
233 (message "No *compilation* buffer")
234 (pop-to-buffer makeinfo-buffer
)
235 (bury-buffer makeinfo-buffer
)
236 (goto-char (point-max))
237 (recenter (if linenum
238 (prefix-numeric-value linenum
)
239 (/ (window-height) 2)))
240 (pop-to-buffer old-buffer
)
243 ;;; Place `provide' at end of file.
246 ;;; makeinfo.el ends here