|
428
|
1 ;;; make-docfile.el --- Cache docstrings in external file
|
|
|
2
|
|
|
3 ;; Copyright (C) 1985, 1986, 1992-1995, 1997 Free Software Foundation, Inc.
|
|
1303
|
4 ;; Copyright (C) 2002, 2003 Ben Wing.
|
|
428
|
5
|
|
|
6 ;; Author: Unknown
|
|
1330
|
7 ;; Maintainer: XEmacs Development Team
|
|
428
|
8 ;; Keywords: internal
|
|
|
9
|
|
|
10 ;; This file is part of XEmacs.
|
|
|
11
|
|
|
12 ;; XEmacs is free software; you can redistribute it and/or modify it
|
|
|
13 ;; under the terms of the GNU General Public License as published by
|
|
|
14 ;; the Free Software Foundation; either version 2, or (at your option)
|
|
|
15 ;; any later version.
|
|
|
16
|
|
|
17 ;; XEmacs is distributed in the hope that it will be useful, but
|
|
|
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
|
20 ;; General Public License for more details.
|
|
|
21
|
|
|
22 ;; You should have received a copy of the GNU General Public License
|
|
|
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
|
|
|
24 ;; Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
|
|
|
25 ;; 02111-1307, USA.
|
|
|
26
|
|
|
27 ;;; Synched up with: Not in FSF
|
|
|
28
|
|
|
29 ;;; Commentary:
|
|
|
30
|
|
|
31 ;; This is a front-end to the make-docfile program that gathers up all the
|
|
|
32 ;; lisp files that will be dumped with XEmacs. It would probably be best
|
|
|
33 ;; to just move make-docfile.c completely to lisp and be done with it.
|
|
|
34
|
|
|
35 ;;; Code:
|
|
|
36
|
|
1261
|
37 ;; Help debug problems.
|
|
|
38 (setq stack-trace-on-error t
|
|
|
39 load-always-display-messages t)
|
|
|
40
|
|
428
|
41 (defvar options nil)
|
|
|
42 (defvar processed nil)
|
|
|
43 (defvar docfile nil)
|
|
|
44 (defvar docfile-buffer nil)
|
|
|
45 (defvar site-file-list nil)
|
|
|
46 (defvar docfile-out-of-date nil)
|
|
|
47
|
|
1330
|
48 (defvar build-root (expand-file-name ".." invocation-directory))
|
|
|
49 (defvar build-lib-src (expand-file-name "lib-src" build-root))
|
|
|
50 (defvar source-lisp (file-name-directory (expand-file-name
|
|
|
51 (nth 2 command-line-args))))
|
|
|
52 (defvar source-src (expand-file-name "../src" source-lisp))
|
|
|
53
|
|
1303
|
54 (defun message (fmt &rest args)
|
|
|
55 (princ (apply #'format fmt args))
|
|
|
56 (terpri))
|
|
|
57
|
|
428
|
58 ;; Gobble up the stuff we don't wish to pass on.
|
|
|
59 (setq command-line-args (cdr (cdr (cdr (cdr command-line-args)))))
|
|
|
60
|
|
|
61 ;; First gather up the command line options.
|
|
|
62 (let (done)
|
|
|
63 (while (and (null done) command-line-args)
|
|
|
64 (let ((arg (car command-line-args)))
|
|
|
65 (cond ((or (string-equal arg "-o") ; Specify DOC file name
|
|
|
66 (string-equal arg "-a") ; Append to DOC file
|
|
|
67 (string-equal arg "-d")) ; Set working directory
|
|
|
68 (if (string-equal arg "-o")
|
|
|
69 (setq docfile (expand-file-name (car (cdr command-line-args)))))
|
|
|
70 (setq options (cons arg options))
|
|
|
71 (setq options (cons (expand-file-name (car (cdr command-line-args))) options)))
|
|
|
72 ((string-equal arg "-i") ; Set site files to scan
|
|
|
73 (setq site-file-list (car (cdr command-line-args))))
|
|
|
74 (t (setq done t)))
|
|
|
75 (if (null done)
|
|
|
76 (setq command-line-args (cdr (cdr command-line-args)))))))
|
|
|
77 (setq options (nreverse options))
|
|
|
78
|
|
1303
|
79 ;; (message (concat "Options: " (prin1-to-string options)))
|
|
|
80
|
|
|
81 ;; insert-file-contents-internal calls out to `format-decode' afterwards,
|
|
1330
|
82 ;; so it must be defined. if non-zero, it tries to do a bunch more stuff
|
|
1303
|
83 ;; so say, "NOOOOOOOOOOOOO! Basta! Ca soufit! Enough, already, OK?"
|
|
|
84 (defun format-decode (fuck me harder) 0)
|
|
428
|
85
|
|
|
86 ;; Next process the list of C files.
|
|
1303
|
87 (defun process-args (args)
|
|
|
88 (while args
|
|
|
89 (let ((arg (car args)))
|
|
|
90 ;; When called from xemacs.mak, we need to do some frobbing on the
|
|
|
91 ;; args given to us -- remove NEEDTODUMP and make-docfile.exe,
|
|
|
92 ;; convert .obj files into .c files in the source directory,
|
|
|
93 ;; handle response files (beginning with @, specifying arguments),
|
|
|
94 ;; due to line-length limitations in the shell.
|
|
|
95 (if (string-match "^@" arg)
|
|
|
96 ;; MS Windows response file
|
|
|
97 ;; no generate-new-buffer so use its implementation.
|
|
|
98 (let ((buf (get-buffer-create (generate-new-buffer-name "foo"))))
|
|
|
99 (set-buffer buf)
|
|
|
100 (insert-file-contents-internal (substring arg 1))
|
|
|
101 ;; now majorly grind up the response file.
|
|
|
102 ;; backslashes get doubled, quotes around strings,
|
|
|
103 ;; get rid of pesky CR's and NL's, and put parens around
|
|
|
104 ;; the whole thing so we have a valid list of strings.
|
|
|
105 (goto-char (point-max))
|
|
|
106 (insert "\")")
|
|
|
107 (goto-char (point-min))
|
|
|
108 (insert "(\"")
|
|
|
109 (while (search-forward "\\" nil t)
|
|
|
110 (replace-match "\\\\" nil t))
|
|
|
111 (goto-char (point-min))
|
|
|
112 (while (search-forward "\n" nil t)
|
|
|
113 (replace-match "" nil t))
|
|
|
114 (goto-char (point-min))
|
|
|
115 (while (search-forward "\r" nil t)
|
|
|
116 (replace-match "" nil t))
|
|
|
117 (goto-char (point-min))
|
|
|
118 (while (search-forward " " nil t)
|
|
|
119 (replace-match "\" \"" nil t))
|
|
|
120 (goto-char (point-min))
|
|
|
121 (process-args (read buf)))
|
|
|
122 ;; remove NEEDTODUMP and make-docfile.exe, convert .obj files into
|
|
|
123 ;; .c files in the source directory.
|
|
|
124 (when (and (not (string-match "\\(NEEDTODUMP\\|\\.exe$\\)" arg))
|
|
|
125 (not (member arg processed)))
|
|
|
126 (when (string-match "\\(.*\\)\\.obj$" arg)
|
|
1330
|
127 (setq arg (expand-file-name
|
|
|
128 (concat
|
|
|
129 (file-name-nondirectory
|
|
|
130 ;; no match-string so use its implementation.
|
|
|
131 (substring arg (match-beginning 1)
|
|
|
132 (match-end 1)))
|
|
|
133 ".c")
|
|
|
134 source-src)))
|
|
428
|
135 (if (and (null docfile-out-of-date)
|
|
|
136 (file-newer-than-file-p arg docfile))
|
|
|
137 (setq docfile-out-of-date t))
|
|
1303
|
138 (setq processed (cons arg processed))))
|
|
|
139 (setq args (cdr args)))))
|
|
|
140
|
|
1330
|
141 ;; Then process the list of Lisp files.
|
|
1303
|
142 (process-args command-line-args)
|
|
428
|
143
|
|
1330
|
144 (setq load-path (list source-lisp))
|
|
428
|
145
|
|
|
146 ;; Then process the autoloads
|
|
|
147 (setq autoload-file-name "auto-autoloads.elc")
|
|
1333
|
148 (defvar custom-declare-variable-list nil) ; unclean
|
|
428
|
149 (load "find-paths.el")
|
|
|
150 (load "packages.el")
|
|
|
151 (load "setup-paths.el")
|
|
1261
|
152 (load "raw-process.el")
|
|
428
|
153
|
|
|
154 (let (preloaded-file-list)
|
|
1330
|
155 (load (expand-file-name "dumped-lisp.el" source-lisp))
|
|
428
|
156
|
|
|
157 (let ((package-preloaded-file-list
|
|
|
158 (packages-collect-package-dumped-lisps late-package-load-path)))
|
|
|
159
|
|
|
160 (setq preloaded-file-list
|
|
|
161 (append package-preloaded-file-list
|
|
|
162 preloaded-file-list
|
|
|
163 packages-hardcoded-lisp)))
|
|
|
164
|
|
|
165 (while preloaded-file-list
|
|
|
166 (let ((arg0 (packages-add-suffix (car preloaded-file-list)))
|
|
|
167 arg)
|
|
|
168 (setq arg (locate-library arg0))
|
|
|
169 (if (null arg)
|
|
|
170 (progn
|
|
1303
|
171 (message "Error: dumped file %s does not exist" arg0)
|
|
428
|
172 ;; Uncomment in case of difficulties
|
|
2456
|
173 ;;(message "late-package-hierarchies: %S" late-package-hierarchies)
|
|
1303
|
174 ;;(message "guessed-roots: %S" (paths-find-emacs-roots invocation-directory invocation-name #'paths-emacs-root-p))
|
|
|
175 ;;(message "guessed-data-roots: %S" (paths-find-emacs-roots invocation-directory invocation-name #'paths-emacs-data-root-p))
|
|
428
|
176 )
|
|
|
177 (if (null (member arg processed))
|
|
|
178 (progn
|
|
|
179 (if (and (null docfile-out-of-date)
|
|
|
180 (file-newer-than-file-p arg docfile))
|
|
|
181 (setq docfile-out-of-date t))
|
|
|
182 (setq processed (cons arg processed)))))
|
|
|
183 (setq preloaded-file-list (cdr preloaded-file-list)))))
|
|
|
184
|
|
|
185 ;; Finally process the list of site-loaded files.
|
|
|
186 (if site-file-list
|
|
|
187 (let (site-load-packages)
|
|
|
188 (load site-file-list t t)
|
|
|
189 (while site-load-packages
|
|
|
190 (let ((arg (car site-load-packages)))
|
|
|
191 (if (null (member arg processed))
|
|
|
192 (progn
|
|
|
193 (if (and (null docfile-out-of-date)
|
|
|
194 (file-newer-than-file-p arg docfile))
|
|
|
195 (setq docfile-out-of-date t))
|
|
|
196 (setq processed (cons arg processed)))))
|
|
|
197 (setq site-load-packages (cdr site-load-packages)))))
|
|
|
198
|
|
|
199 ;(let ((autoloads (packages-list-autoloads-path)))
|
|
1303
|
200 ; ;; (message (concat "Autoloads: " (prin1-to-string autoloads)))
|
|
428
|
201 ; (while autoloads
|
|
|
202 ; (let ((arg (car autoloads)))
|
|
|
203 ; (if (null (member arg processed))
|
|
|
204 ; (progn
|
|
1303
|
205 ; ;; (message arg)
|
|
428
|
206 ; (if (and (null docfile-out-of-date)
|
|
|
207 ; (file-newer-than-file-p arg docfile))
|
|
|
208 ; (setq docfile-out-of-date t))
|
|
|
209 ; (setq processed (cons arg processed))))
|
|
|
210 ; (setq autoloads (cdr autoloads)))))
|
|
|
211
|
|
|
212 ;; Now fire up make-docfile and we're done
|
|
|
213
|
|
|
214 (setq processed (nreverse processed))
|
|
|
215
|
|
1303
|
216 (terpri)
|
|
|
217
|
|
|
218 ;(message (prin1-to-string (append options processed)))
|
|
428
|
219
|
|
1303
|
220 (when docfile-out-of-date
|
|
|
221 (condition-case nil
|
|
|
222 (delete-file docfile)
|
|
|
223 (error nil))
|
|
|
224 (message "Spawning make-docfile ...")
|
|
|
225 ;; (message (prin1-to-string (append options processed)))
|
|
|
226
|
|
1330
|
227 (setq exec-path (list build-lib-src))
|
|
428
|
228
|
|
1303
|
229 ;; (locate-file-clear-hashing nil)
|
|
|
230 (if (memq system-type '(berkeley-unix next-mach))
|
|
|
231 ;; Suboptimal, but we have a unresolved bug somewhere in the
|
|
|
232 ;; low-level process code. #### Now that we've switched to using
|
|
|
233 ;; the regular asynch process code, we should try removing this.
|
|
|
234 (call-process-internal
|
|
|
235 "/bin/csh"
|
|
|
236 nil
|
|
|
237 t
|
|
|
238 nil
|
|
|
239 "-fc"
|
|
|
240 (mapconcat
|
|
|
241 #'identity
|
|
|
242 (append
|
|
1330
|
243 (list (expand-file-name "make-docfile" build-lib-src))
|
|
1303
|
244 options processed)
|
|
|
245 " "))
|
|
|
246 ;; (message (prin1-to-string (append options processed)))
|
|
|
247 (apply 'call-process-internal
|
|
1330
|
248 ;; exec-path is set.
|
|
|
249 ;; (expand-file-name "make-docfile" build-lib-src)
|
|
1303
|
250 "make-docfile"
|
|
428
|
251 nil
|
|
|
252 t
|
|
|
253 nil
|
|
1303
|
254 (append options processed)))
|
|
428
|
255
|
|
1303
|
256 (message "Spawning make-docfile ...done")
|
|
|
257 ;; (write-region-internal (point-min) (point-max) "/tmp/DOC")
|
|
|
258 )
|
|
428
|
259
|
|
|
260 (kill-emacs)
|
|
|
261
|
|
|
262 ;;; make-docfile.el ends here
|
