* lisp/image.el (insert-image, insert-sliced-image): Doc fix.
[emacs.git] / lisp / progmodes / ps-mode.el
bloba8fc11f71c064eb888b49ac578719968848a9123
1 ;;; ps-mode.el --- PostScript mode for GNU Emacs
3 ;; Copyright (C) 1999, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Peter Kleiweg <p.c.j.kleiweg@rug.nl>
6 ;; Maintainer: Peter Kleiweg <p.c.j.kleiweg@rug.nl>
7 ;; Created: 20 Aug 1997
8 ;; Version: 1.1h
9 ;; Keywords: PostScript, languages
11 ;; Yoni Rabkin <yoni@rabkins.net> contacted the maintainer of this
12 ;; file on 18/3/2008, and the maintainer agreed that when a bug is
13 ;; filed in the Emacs bug reporting system against this file, a copy
14 ;; of the bug report be sent to the maintainer's email address, but
15 ;; only if: "... those e-mails have a link to the bug report system,
16 ;; where I can cancel these e-mails if I want to.".
18 ;; This file is part of GNU Emacs.
20 ;; GNU Emacs is free software: you can redistribute it and/or modify
21 ;; it under the terms of the GNU General Public License as published by
22 ;; the Free Software Foundation, either version 3 of the License, or
23 ;; (at your option) any later version.
25 ;; GNU Emacs is distributed in the hope that it will be useful,
26 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
27 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
28 ;; GNU General Public License for more details.
30 ;; You should have received a copy of the GNU General Public License
31 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
33 ;;; Commentary:
36 ;;; Code:
38 (defconst ps-mode-version "1.1h, 16 Jun 2005")
39 (defconst ps-mode-maintainer-address "Peter Kleiweg <p.c.j.kleiweg@rug.nl>")
41 (require 'comint)
42 (require 'easymenu)
44 ;; Define core `PostScript' group.
45 (defgroup PostScript nil
46 "PostScript mode for Emacs."
47 :group 'languages)
49 (defgroup PostScript-edit nil
50 "PostScript editing."
51 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
52 :prefix "ps-mode-"
53 :group 'PostScript)
55 (defgroup PostScript-interaction nil
56 "PostScript interaction."
57 :prefix "ps-run-"
58 :group 'PostScript)
60 ;; User variables.
62 (defcustom ps-mode-auto-indent t
63 "Should we use autoindent?"
64 :group 'PostScript-edit
65 :type 'boolean)
67 (defcustom ps-mode-tab 4
68 "Number of spaces to use when indenting."
69 :group 'PostScript-edit
70 :type 'integer)
72 (defcustom ps-mode-paper-size '(595 842)
73 "Default paper size.
75 When inserting an EPSF template these values are used
76 to set the boundingbox to include the whole page.
77 When the figure is finished these values should be replaced."
78 :group 'PostScript-edit
79 :type '(choice
80 (const :tag "letter" (612 792))
81 (const :tag "legal" (612 1008))
82 (const :tag "a0" (2380 3368))
83 (const :tag "a1" (1684 2380))
84 (const :tag "a2" (1190 1684))
85 (const :tag "a3" (842 1190))
86 (const :tag "a4" (595 842))
87 (const :tag "a5" (421 595))
88 (const :tag "a6" (297 421))
89 (const :tag "a7" (210 297))
90 (const :tag "a8" (148 210))
91 (const :tag "a9" (105 148))
92 (const :tag "a10" (74 105))
93 (const :tag "b0" (2836 4008))
94 (const :tag "b1" (2004 2836))
95 (const :tag "b2" (1418 2004))
96 (const :tag "b3" (1002 1418))
97 (const :tag "b4" (709 1002))
98 (const :tag "b5" (501 709))
99 (const :tag "archE" (2592 3456))
100 (const :tag "archD" (1728 2592))
101 (const :tag "archC" (1296 1728))
102 (const :tag "archB" (864 1296))
103 (const :tag "archA" (648 864))
104 (const :tag "flsa" (612 936))
105 (const :tag "flse" (612 936))
106 (const :tag "halfletter" (396 612))
107 (const :tag "11x17" (792 1224))
108 (const :tag "tabloid" (792 1224))
109 (const :tag "ledger" (1224 792))
110 (const :tag "csheet" (1224 1584))
111 (const :tag "dsheet" (1584 2448))
112 (const :tag "esheet" (2448 3168))))
114 (defcustom ps-mode-print-function
115 (lambda ()
116 (let ((lpr-switches nil)
117 (lpr-command (if (memq system-type '(usg-unix-v hpux irix))
118 "lp" "lpr")))
119 (lpr-buffer)))
120 "Lisp function to print current buffer as PostScript."
121 :group 'PostScript-edit
122 :type 'function)
124 (defcustom ps-run-prompt "\\(GS\\(<[0-9]+\\)?>\\)+"
125 "Regexp to match prompt in interactive PostScript."
126 :group 'PostScript-interaction
127 :type 'regexp)
129 (defcustom ps-run-font-lock-keywords-2
130 (append (unless (string= ps-run-prompt "")
131 (list (list (if (= ?^ (string-to-char ps-run-prompt))
132 ps-run-prompt
133 (concat "^" ps-run-prompt))
134 '(0 font-lock-function-name-face nil nil))))
135 '((">>showpage, press <return> to continue<<"
136 (0 font-lock-keyword-face nil nil))
137 ("^\\(Error\\|Can't\\).*"
138 (0 font-lock-warning-face nil nil))
139 ("^\\(Current file position is\\) \\([0-9]+\\)"
140 (1 font-lock-comment-face nil nil)
141 (2 font-lock-warning-face nil nil))))
142 "Medium level highlighting of messages from the PostScript interpreter.
144 See documentation on font-lock for details."
145 :group 'PostScript-interaction
146 :type '(repeat (list :tag "Expression with one or more highlighters"
147 :value ("" (0 default nil t))
148 (regexp :tag "Expression")
149 (repeat :tag "Highlighters"
150 :inline regexp
151 (list :tag "Highlighter"
152 (integer :tag "Subexp")
153 face
154 (boolean :tag "Override")
155 (boolean :tag "Laxmatch" :value t))))))
157 (defcustom ps-run-x '("gs" "-r72" "-sPAPERSIZE=a4")
158 "Command as list to run PostScript with graphic display."
159 :group 'PostScript-interaction
160 :type '(repeat string))
162 (defcustom ps-run-dumb '("gs" "-dNODISPLAY")
163 "Command as list to run PostScript without graphic display."
164 :group 'PostScript-interaction
165 :type '(repeat string))
167 (defcustom ps-run-init nil
168 "String of commands to send to PostScript to start interactive.
170 Example: \"executive\"
172 You won't need to set this option for Ghostscript."
173 :group 'PostScript-interaction
174 :type '(choice (const nil) string))
176 (defcustom ps-run-error-line-numbers nil
177 "What values are used by the PostScript interpreter in error messages?"
178 :group 'PostScript-interaction
179 :type '(choice (const :tag "line numbers" t)
180 (const :tag "byte counts" nil)))
182 (defcustom ps-run-tmp-dir nil
183 "Name of directory to place temporary file.
184 If nil, use `temporary-file-directory'."
185 :group 'PostScript-interaction
186 :type '(choice (const nil) directory))
189 ;; Constants used for font-lock.
191 ;; Only a small set of the PostScript operators is selected for fontification.
192 ;; Fontification is meant to clarify the document structure and process flow,
193 ;; fontifying all known PostScript operators would hinder that objective.
194 (defconst ps-mode-operators
195 (let ((ops '("clear" "mark" "cleartomark" "counttomark"
196 "forall"
197 "dict" "begin" "end" "def"
198 "true" "false"
199 "exec" "if" "ifelse" "for" "repeat" "loop" "exit"
200 "stop" "stopped" "countexecstack" "execstack"
201 "quit" "start"
202 "save" "restore"
203 "bind" "null"
204 "gsave" "grestore" "grestoreall"
205 "showpage")))
206 (concat "\\<" (regexp-opt ops t) "\\>"))
207 "Regexp of PostScript operators that will be fontified.")
209 ;; Level 1 font-lock:
210 ;; - Special comments (reference face)
211 ;; - Strings and other comments
212 ;; - Partial strings (warning face)
213 ;; - 8bit characters (warning face)
214 ;; Multiline strings are not supported. Strings with nested brackets are.
215 (defconst ps-mode-font-lock-keywords-1
216 '(("\\`%!PS.*" . font-lock-constant-face)
217 ("^%%BoundingBox:[ \t]+-?[0-9]+[ \t]+-?[0-9]+[ \t]+-?[0-9]+[ \t]+-?[0-9]+[ \t]*$"
218 . font-lock-constant-face)
219 (ps-mode-match-string-or-comment
220 (1 font-lock-comment-face nil t)
221 (2 font-lock-string-face nil t))
222 ("([^()\n%]*\\|[^()\n]*)" . font-lock-warning-face)
223 ("[\200-\377]+" (0 font-lock-warning-face prepend nil)))
224 "Subdued level highlighting for PostScript mode.")
226 ;; Level 2 font-lock:
227 ;; - All from level 1
228 ;; - PostScript operators (keyword face)
229 (defconst ps-mode-font-lock-keywords-2
230 (append
231 ps-mode-font-lock-keywords-1
232 (list
233 (cons
234 ;; exclude names prepended by `/'
235 (concat "\\(^\\|[^/\n]\\)" ps-mode-operators)
236 '(2 font-lock-keyword-face))))
237 "Medium level highlighting for PostScript mode.")
239 ;; Level 3 font-lock:
240 ;; - All from level 2
241 ;; - Immediately evaluated names: those starting with `//' (type face)
242 ;; - Names that look like they are used for the definition of:
243 ;; * a function
244 ;; * an array
245 ;; * a dictionary
246 ;; * a "global" variable
247 ;; (function name face)
248 ;; - Other names (variable name face)
249 ;; The rules used to determine what names fit in the first category are:
250 ;; - Only names that are at the left margin, and one of these on the same line:
251 ;; * Nothing after the name except possibly one or more `[' or a comment
252 ;; * A `{' or `<<' or `[0-9]+ dict' following the name
253 ;; * A `def' somewhere in the same line
254 ;; Names are fontified before PostScript operators, allowing the use of
255 ;; a more simple (efficient) regexp than the one used in level 2.
256 (defconst ps-mode-font-lock-keywords-3
257 (append
258 ps-mode-font-lock-keywords-1
259 (list
260 '("//\\w+" . font-lock-type-face)
261 `(,(concat
262 "^\\(/\\w+\\)\\>"
263 "\\([[ \t]*\\(%.*\\)?\r?$" ; Nothing but `[' or comment after the name.
264 "\\|[ \t]*\\({\\|<<\\)" ; `{' or `<<' following the name.
265 "\\|[ \t]+[0-9]+[ \t]+dict\\>" ; `[0-9]+ dict' following the name.
266 "\\|.*\\<def\\>\\)") ; `def' somewhere on the same line.
267 . (1 font-lock-function-name-face))
268 '("/\\w+" . font-lock-variable-name-face)
269 (cons ps-mode-operators 'font-lock-keyword-face)))
270 "High level highlighting for PostScript mode.")
272 (defconst ps-mode-font-lock-keywords ps-mode-font-lock-keywords-1
273 "Default expressions to highlight in PostScript mode.")
275 ;; Level 1 font-lock for ps-run-mode
276 ;; - prompt (function name face)
277 (defconst ps-run-font-lock-keywords-1
278 (unless (string= "" ps-run-prompt)
279 (list (cons (if (= ?^ (string-to-char ps-run-prompt))
280 ps-run-prompt
281 (concat "^" ps-run-prompt))
282 'font-lock-function-name-face)))
283 "Subdued level highlighting for PostScript run mode.")
285 (defconst ps-run-font-lock-keywords ps-run-font-lock-keywords-1
286 "Default expressions to highlight in PostScript run mode.")
289 ;; Variables.
291 (defvar ps-mode-map nil
292 "Local keymap to use in PostScript mode.")
294 (defvar ps-mode-syntax-table nil
295 "Syntax table used while in PostScript mode.")
297 (defvar ps-run-mode-map nil
298 "Local keymap to use in PostScript run mode.")
300 (defvar ps-mode-tmp-file nil
301 "Name of temporary file, set by `ps-run'.")
303 (defvar ps-run-mark nil
304 "Mark to start of region that was sent to PostScript interpreter.")
306 (defvar ps-run-parent nil
307 "Parent window of interactive PostScript.")
310 ;; Menu
312 (defconst ps-mode-menu-main
313 '("PostScript"
314 ["EPSF Template, Sparse" ps-mode-epsf-sparse t]
315 ["EPSF Template, Rich" ps-mode-epsf-rich t]
316 "---"
317 ("Cookbook"
318 ["RE" ps-mode-RE t]
319 ["ISOLatin1Extended" ps-mode-latin-extended t]
320 ["center" ps-mode-center t]
321 ["right" ps-mode-right t]
322 ["Heapsort" ps-mode-heapsort t])
323 ("Fonts (1)"
324 ["Times-Roman" (insert "/Times-Roman ") t]
325 ["Times-Bold" (insert "/Times-Bold ") t]
326 ["Times-Italic" (insert "/Times-Italic ") t]
327 ["Times-BoldItalic" (insert "/Times-BoldItalic ") t]
328 ["Helvetica" (insert "/Helvetica ") t]
329 ["Helvetica-Bold" (insert "/Helvetica-Bold ") t]
330 ["Helvetica-Oblique" (insert "/Helvetica-Oblique ") t]
331 ["Helvetica-BoldOblique" (insert "/Helvetica-BoldOblique ") t]
332 ["Courier" (insert "/Courier ") t]
333 ["Courier-Bold" (insert "/Courier-Bold ") t]
334 ["Courier-Oblique" (insert "/Courier-Oblique ") t]
335 ["Courier-BoldOblique" (insert "/Courier-BoldOblique ") t]
336 ["Symbol" (insert "/Symbol") t ])
337 ("Fonts (2)"
338 ["AvantGarde-Book" (insert "/AvantGarde-Book ") t]
339 ["AvantGarde-Demi" (insert "/AvantGarde-Demi ") t]
340 ["AvantGarde-BookOblique" (insert "/AvantGarde-BookOblique ") t]
341 ["AvantGarde-DemiOblique" (insert "/AvantGarde-DemiOblique ") t]
342 ["Bookman-Light" (insert "/Bookman-Light ") t]
343 ["Bookman-Demi" (insert "/Bookman-Demi ") t]
344 ["Bookman-LightItalic" (insert "/Bookman-LightItalic ") t]
345 ["Bookman-DemiItalic" (insert "/Bookman-DemiItalic ") t]
346 ["Helvetica-Narrow" (insert "/Helvetica-Narrow ") t]
347 ["Helvetica-Narrow-Bold" (insert "/Helvetica-Narrow-Bold ") t]
348 ["Helvetica-Narrow-Oblique" (insert "/Helvetica-Narrow-Oblique ") t]
349 ["Helvetica-Narrow-BoldOblique" (insert "/Helvetica-Narrow-BoldOblique ") t]
350 ["NewCenturySchlbk-Roman" (insert "/NewCenturySchlbk-Roman ") t]
351 ["NewCenturySchlbk-Bold" (insert "/NewCenturySchlbk-Bold ") t]
352 ["NewCenturySchlbk-Italic" (insert "/NewCenturySchlbk-Italic ") t]
353 ["NewCenturySchlbk-BoldItalic" (insert "/NewCenturySchlbk-BoldItalic ") t]
354 ["Palatino-Roman" (insert "/Palatino-Roman ") t]
355 ["Palatino-Bold" (insert "/Palatino-Bold ") t]
356 ["Palatino-Italic" (insert "/Palatino-Italic ") t]
357 ["Palatino-BoldItalic" (insert "/Palatino-BoldItalic ") t]
358 ["ZapfChancery-MediumItalic" (insert "/ZapfChancery-MediumItalic ") t]
359 ["ZapfDingbats" (insert "/ZapfDingbats ") t])
360 "---"
361 ["Comment Out Region" ps-mode-comment-out-region (mark t)]
362 ["Uncomment Region" ps-mode-uncomment-region (mark t)]
363 "---"
364 ["8-bit to Octal Buffer" ps-mode-octal-buffer t]
365 ["8-bit to Octal Region" ps-mode-octal-region (mark t)]
366 "---"
367 ["Auto Indent" (setq ps-mode-auto-indent (not ps-mode-auto-indent))
368 :style toggle :selected ps-mode-auto-indent]
369 "---"
370 ["Start PostScript"
371 ps-run-start
373 ["Quit PostScript" ps-run-quit (process-status "ps-run")]
374 ["Kill PostScript" ps-run-kill (process-status "ps-run")]
375 ["Send Buffer to Interpreter"
376 ps-run-buffer
377 (process-status "ps-run")]
378 ["Send Region to Interpreter"
379 ps-run-region
380 (and (mark t) (process-status "ps-run"))]
381 ["Send Newline to Interpreter"
382 ps-mode-other-newline
383 (process-status "ps-run")]
384 ["View BoundingBox"
385 ps-run-boundingbox
386 (process-status "ps-run")]
387 ["Clear/Reset PostScript Graphics"
388 ps-run-clear
389 (process-status "ps-run")]
390 "---"
391 ["Print Buffer as PostScript"
392 ps-mode-print-buffer
394 ["Print Region as PostScript"
395 ps-mode-print-region
396 (mark t)]
397 "---"
398 ["Customize for PostScript"
399 (customize-group "PostScript")
401 "---"
402 ["Submit Bug Report"
403 ps-mode-submit-bug-report
404 t]))
407 ;; Mode maps for PostScript edit mode and PostScript interaction mode.
409 (unless ps-mode-map
410 (setq ps-mode-map (make-sparse-keymap))
411 (define-key ps-mode-map "\C-c\C-v" 'ps-run-boundingbox)
412 (define-key ps-mode-map "\C-c\C-u" 'ps-mode-uncomment-region)
413 (define-key ps-mode-map "\C-c\C-t" 'ps-mode-epsf-rich)
414 (define-key ps-mode-map "\C-c\C-s" 'ps-run-start)
415 (define-key ps-mode-map "\C-c\C-r" 'ps-run-region)
416 (define-key ps-mode-map "\C-c\C-q" 'ps-run-quit)
417 (define-key ps-mode-map "\C-c\C-p" 'ps-mode-print-buffer)
418 (define-key ps-mode-map "\C-c\C-o" 'ps-mode-comment-out-region)
419 (define-key ps-mode-map "\C-c\C-k" 'ps-run-kill)
420 (define-key ps-mode-map "\C-c\C-j" 'ps-mode-other-newline)
421 (define-key ps-mode-map "\C-c\C-l" 'ps-run-clear)
422 (define-key ps-mode-map "\C-c\C-b" 'ps-run-buffer)
423 (define-key ps-mode-map ">" 'ps-mode-r-gt)
424 (define-key ps-mode-map "]" 'ps-mode-r-angle)
425 (define-key ps-mode-map "}" 'ps-mode-r-brace)
426 (define-key ps-mode-map "\177" 'ps-mode-backward-delete-char)
427 (define-key ps-mode-map "\t" 'ps-mode-tabkey)
428 (define-key ps-mode-map "\r" 'ps-mode-newline)
429 (define-key ps-mode-map [return] 'ps-mode-newline)
430 (easy-menu-define ps-mode-main ps-mode-map "PostScript" ps-mode-menu-main))
432 (unless ps-run-mode-map
433 (setq ps-run-mode-map (make-sparse-keymap))
434 (set-keymap-parent ps-run-mode-map comint-mode-map)
435 (define-key ps-run-mode-map "\C-c\C-q" 'ps-run-quit)
436 (define-key ps-run-mode-map "\C-c\C-k" 'ps-run-kill)
437 (define-key ps-run-mode-map "\C-c\C-e" 'ps-run-goto-error)
438 (define-key ps-run-mode-map [mouse-2] 'ps-run-mouse-goto-error))
441 ;; Syntax table.
443 (unless ps-mode-syntax-table
444 (setq ps-mode-syntax-table (make-syntax-table))
446 (modify-syntax-entry ?\% "< " ps-mode-syntax-table)
447 (modify-syntax-entry ?\n "> " ps-mode-syntax-table)
448 (modify-syntax-entry ?\r "> " ps-mode-syntax-table)
449 (modify-syntax-entry ?\f "> " ps-mode-syntax-table)
450 (modify-syntax-entry ?\< "(>" ps-mode-syntax-table)
451 (modify-syntax-entry ?\> ")<" ps-mode-syntax-table)
453 (modify-syntax-entry ?\! "w " ps-mode-syntax-table)
454 (modify-syntax-entry ?\" "w " ps-mode-syntax-table)
455 (modify-syntax-entry ?\# "w " ps-mode-syntax-table)
456 (modify-syntax-entry ?\$ "w " ps-mode-syntax-table)
457 (modify-syntax-entry ?\& "w " ps-mode-syntax-table)
458 (modify-syntax-entry ?\' "w " ps-mode-syntax-table)
459 (modify-syntax-entry ?\* "w " ps-mode-syntax-table)
460 (modify-syntax-entry ?\+ "w " ps-mode-syntax-table)
461 (modify-syntax-entry ?\, "w " ps-mode-syntax-table)
462 (modify-syntax-entry ?\- "w " ps-mode-syntax-table)
463 (modify-syntax-entry ?\. "w " ps-mode-syntax-table)
464 (modify-syntax-entry ?\: "w " ps-mode-syntax-table)
465 (modify-syntax-entry ?\; "w " ps-mode-syntax-table)
466 (modify-syntax-entry ?\= "w " ps-mode-syntax-table)
467 (modify-syntax-entry ?\? "w " ps-mode-syntax-table)
468 (modify-syntax-entry ?\@ "w " ps-mode-syntax-table)
469 (modify-syntax-entry ?\\ "w " ps-mode-syntax-table)
470 (modify-syntax-entry ?^ "w " ps-mode-syntax-table) ; NOT: ?\^
471 (modify-syntax-entry ?\_ "w " ps-mode-syntax-table)
472 (modify-syntax-entry ?\` "w " ps-mode-syntax-table)
473 (modify-syntax-entry ?\| "w " ps-mode-syntax-table)
474 (modify-syntax-entry ?\~ "w " ps-mode-syntax-table)
476 (let ((i 128))
477 (while (< i 256)
478 (modify-syntax-entry i "w " ps-mode-syntax-table)
479 (setq i (1+ i)))))
483 (declare-function doc-view-minor-mode "doc-view")
485 ;; PostScript mode.
487 ;;;###autoload
488 (define-derived-mode ps-mode prog-mode "PostScript"
489 "Major mode for editing PostScript with GNU Emacs.
491 Entry to this mode calls `ps-mode-hook'.
493 The following variables hold user options, and can
494 be set through the `customize' command:
496 `ps-mode-auto-indent'
497 `ps-mode-tab'
498 `ps-mode-paper-size'
499 `ps-mode-print-function'
500 `ps-run-prompt'
501 `ps-run-font-lock-keywords-2'
502 `ps-run-x'
503 `ps-run-dumb'
504 `ps-run-init'
505 `ps-run-error-line-numbers'
506 `ps-run-tmp-dir'
508 Type \\[describe-variable] for documentation on these options.
511 \\{ps-mode-map}
514 When starting an interactive PostScript process with \\[ps-run-start],
515 a second window will be displayed, and `ps-run-mode-hook' will be called.
516 The keymap for this second window is:
518 \\{ps-run-mode-map}
521 When Ghostscript encounters an error it displays an error message
522 with a file position. Clicking mouse-2 on this number will bring
523 point to the corresponding spot in the PostScript window, if input
524 to the interpreter was sent from that window.
525 Typing \\<ps-run-mode-map>\\[ps-run-goto-error] when the cursor is at the number has the same effect."
526 (set (make-local-variable 'font-lock-defaults)
527 '((ps-mode-font-lock-keywords
528 ps-mode-font-lock-keywords-1
529 ps-mode-font-lock-keywords-2
530 ps-mode-font-lock-keywords-3)
532 (set (make-local-variable 'comment-start) "%")
533 ;; NOTE: `\' has a special meaning in strings only
534 (set (make-local-variable 'comment-start-skip) "%+[ \t]*")
535 ;; enable doc-view-minor-mode => C-c C-c starts viewing the current ps file
536 ;; with doc-view-mode.
537 (doc-view-minor-mode 1))
539 (defun ps-mode-show-version ()
540 "Show current version of PostScript mode."
541 (interactive)
542 (message " *** PostScript Mode (ps-mode) Version %s *** " ps-mode-version))
544 ;; From reporter.el
545 (defvar reporter-prompt-for-summary-p)
546 (defvar reporter-dont-compact-list)
548 (defun ps-mode-submit-bug-report ()
549 "Submit via mail a bug report on PostScript mode."
550 (interactive)
551 (when (y-or-n-p "Submit bug report on PostScript mode? ")
552 (let ((reporter-prompt-for-summary-p nil)
553 (reporter-dont-compact-list '(ps-mode-print-function
554 ps-run-font-lock-keywords-2)))
555 (reporter-submit-bug-report
556 ps-mode-maintainer-address
557 (format "ps-mode.el %s [%s]" ps-mode-version system-type)
558 '(ps-mode-auto-indent
559 ps-mode-tab
560 ps-mode-paper-size
561 ps-mode-print-function
562 ps-run-prompt
563 ps-run-font-lock-keywords-2
564 ps-run-x
565 ps-run-dumb
566 ps-run-init
567 ps-run-error-line-numbers
568 ps-run-tmp-dir)))))
571 ;; Helper functions for font-lock.
573 ;; When this function is called, point is at an opening bracket.
574 ;; This function should test if point is at the start of a string
575 ;; with nested brackets.
576 ;; If true: move point to end of string
577 ;; set string to match data nr 2
578 ;; return new point
579 ;; If false: return nil
580 (defun ps-mode-looking-at-nested (limit)
581 (let ((first (point))
582 (level 1)
583 pos)
584 ;; Move past opening bracket.
585 (forward-char 1)
586 (setq pos (point))
587 (while (and (> level 0) (< pos limit))
588 ;; Search next bracket, stepping over escaped brackets.
589 (if (not (looking-at "\\([^()\\\n]\\|\\\\.\\)*\\([()]\\)"))
590 (setq level -1)
591 (setq level (+ level (if (string= "(" (match-string 2)) 1 -1)))
592 (goto-char (setq pos (match-end 0)))))
593 (if (not (= level 0))
595 ;; Found string with nested brackets, now set match data nr 2.
596 (set-match-data (list first pos nil nil first pos))
597 pos)))
599 ;; This function should search for a string or comment
600 ;; If comment, return as match data nr 1
601 ;; If string, return as match data nr 2
602 (defun ps-mode-match-string-or-comment (limit)
603 ;; Find the first potential match.
604 (if (not (re-search-forward "[%(]" limit t))
605 ;; Nothing found: return failure.
607 (let ((end (match-end 0)))
608 (goto-char (match-beginning 0))
609 (cond ((looking-at "\\(%.*\\)\\|\\((\\([^()\\\n]\\|\\\\.\\)*)\\)")
610 ;; It's a comment or string without nested, unescaped brackets.
611 (goto-char (match-end 0))
612 (point))
613 ((ps-mode-looking-at-nested limit)
614 ;; It's a string with nested brackets.
615 (point))
617 ;; Try next match.
618 (goto-char end)
619 (ps-mode-match-string-or-comment limit))))))
622 ;; Key-handlers.
624 (defun ps-mode-target-column ()
625 "To what column should text on current line be indented?
627 Indentation is increased if the last token on the current line
628 defines the beginning of a group. These tokens are: { [ <<"
629 (save-excursion
630 (beginning-of-line)
631 (if (looking-at "[ \t]*\\(}\\|\\]\\|>>\\)")
632 (condition-case err
633 (progn
634 (goto-char (match-end 0))
635 (backward-sexp 1)
636 (beginning-of-line)
637 (if (looking-at "[ \t]+")
638 (goto-char (match-end 0)))
639 (current-column))
640 (error
641 (ding)
642 (message "%s" (error-message-string err))
644 (let (target)
645 (if (not (re-search-backward "[^ \t\n\r\f][ \t\n\r\f]*\\=" nil t))
647 (goto-char (match-beginning 0))
648 (beginning-of-line)
649 (if (looking-at "[ \t]+")
650 (goto-char (match-end 0)))
651 (setq target (current-column))
652 (end-of-line)
653 (if (re-search-backward "\\({\\|\\[\\|<<\\)[ \t]*\\(%[^\n]*\\)?\\=" nil t)
654 (setq target (+ target ps-mode-tab)))
655 target)))))
657 (defun ps-mode-newline ()
658 "Insert newline with proper indentation."
659 (interactive)
660 (delete-horizontal-space)
661 (insert "\n")
662 (if ps-mode-auto-indent
663 (indent-to (ps-mode-target-column))))
665 (defun ps-mode-tabkey ()
666 "Indent/reindent current line, or insert tab."
667 (interactive)
668 (let ((column (current-column))
669 target)
670 (if (or (not ps-mode-auto-indent)
671 (< ps-mode-tab 1)
672 (not (re-search-backward "^[ \t]*\\=" nil t)))
673 (insert "\t")
674 (setq target (ps-mode-target-column))
675 (while (<= target column)
676 (setq target (+ target ps-mode-tab)))
677 (indent-line-to target))))
679 (defun ps-mode-backward-delete-char ()
680 "Delete backward indentation, or delete backward character."
681 (interactive)
682 (let ((column (current-column))
683 target)
684 (if (or (not ps-mode-auto-indent)
685 (< ps-mode-tab 1)
686 (not (re-search-backward "^[ \t]+\\=" nil t)))
687 (call-interactively 'delete-backward-char)
688 (setq target (ps-mode-target-column))
689 (while (> column target)
690 (setq target (+ target ps-mode-tab)))
691 (while (>= target column)
692 (setq target (- target ps-mode-tab)))
693 (if (< target 0)
694 (setq target 0))
695 (indent-line-to target))))
697 (defun ps-mode-r-brace ()
698 "Insert `}' and perform balance."
699 (interactive)
700 (insert "}")
701 (ps-mode-r-balance "}"))
703 (defun ps-mode-r-angle ()
704 "Insert `]' and perform balance."
705 (interactive)
706 (insert "]")
707 (ps-mode-r-balance "]"))
709 (defun ps-mode-r-gt ()
710 "Insert `>' and perform balance."
711 (interactive)
712 (insert ">")
713 (ps-mode-r-balance ">>"))
715 (defun ps-mode-r-balance (right)
716 "Adjust indenting if point after RIGHT."
717 (if ps-mode-auto-indent
718 (save-excursion
719 (when (re-search-backward (concat "^[ \t]*" (regexp-quote right) "\\=") nil t)
720 (indent-line-to (ps-mode-target-column)))))
721 (blink-matching-open))
723 (defun ps-mode-other-newline ()
724 "Perform newline in `*ps-run*' buffer."
725 (interactive)
726 (ps-run-send-string ""))
729 ;; Print PostScript.
731 (defun ps-mode-print-buffer ()
732 "Print buffer as PostScript."
733 (interactive)
734 (funcall ps-mode-print-function))
736 (defun ps-mode-print-region (begin end)
737 "Print region as PostScript, adding minimal header and footer lines:
739 %!PS
740 <region>
741 showpage"
742 (interactive "r")
743 (let ((buf (current-buffer)))
744 (with-temp-buffer
745 (insert "%!PS\n")
746 (insert-buffer-substring buf begin end)
747 (insert "\nshowpage\n")
748 (funcall ps-mode-print-function))))
751 ;; Comment Out / Uncomment.
753 (defun ps-mode-comment-out-region (begin end)
754 "Comment out region."
755 (interactive "r")
756 (let ((endm (make-marker)))
757 (set-marker endm end)
758 (save-excursion
759 (goto-char begin)
760 (if (= (current-column) 0)
761 (insert "%"))
762 (while (and (= (forward-line) 0)
763 (< (point) (marker-position endm)))
764 (insert "%")))
765 (set-marker endm nil)))
767 (defun ps-mode-uncomment-region (begin end)
768 "Uncomment region.
770 Only one `%' is removed, and it has to be in the first column."
771 (interactive "r")
772 (let ((endm (make-marker)))
773 (set-marker endm end)
774 (save-excursion
775 (goto-char begin)
776 (if (looking-at "^%")
777 (delete-char 1))
778 (while (and (= (forward-line) 0)
779 (< (point) (marker-position endm)))
780 (if (looking-at "%")
781 (delete-char 1))))
782 (set-marker endm nil)))
785 ;; Convert 8-bit to octal codes.
787 (defun ps-mode-octal-buffer ()
788 "Change 8-bit characters to octal codes in buffer."
789 (interactive)
790 (ps-mode-octal-region (point-min) (point-max)))
792 (defun ps-mode-octal-region (begin end)
793 "Change 8-bit characters to octal codes in region."
794 (interactive "r")
795 (if buffer-read-only
796 (progn
797 (ding)
798 (message "Buffer is read only"))
799 (save-excursion
800 (let (endm i)
801 (setq endm (make-marker))
802 (set-marker endm end)
803 (goto-char begin)
804 (setq i 0)
805 (while (re-search-forward "[\200-\377]" (marker-position endm) t)
806 (setq i (1+ i))
807 (backward-char)
808 (insert (format "\\%03o" (string-to-char (buffer-substring (point) (1+ (point))))))
809 (delete-char 1))
810 (message "%d change%s made" i (if (= i 1) "" "s"))
811 (set-marker endm nil)))))
814 ;; Cookbook.
816 (defun ps-mode-center ()
817 "Insert function /center."
818 (interactive)
819 (insert "
820 /center {
821 dup stringwidth
822 exch 2 div neg
823 exch 2 div neg
824 rmoveto
825 } bind def
828 (defun ps-mode-right ()
829 "Insert function /right."
830 (interactive)
831 (insert "
832 /right {
833 dup stringwidth
834 exch neg
835 exch neg
836 rmoveto
837 } bind def
840 (defun ps-mode-RE ()
841 "Insert function /RE."
842 (interactive)
843 (insert "
844 % `new-font-name' `encoding-vector' `old-font-name' RE -
845 /RE {
846 findfont
847 dup maxlength dict begin {
848 1 index /FID ne { def } { pop pop } ifelse
849 } forall
850 /Encoding exch def
851 dup /FontName exch def
852 currentdict end definefont pop
853 } bind def
856 (defun ps-mode-latin-extended ()
857 "Insert array /ISOLatin1Extended.
859 This encoding vector contains all the entries from ISOLatin1Encoding
860 plus the usually uncoded characters inserted on positions 1 through 28."
861 (interactive)
862 (insert "
863 % ISOLatin1Encoding, extended with remaining uncoded glyphs
864 /ISOLatin1Extended [
865 /.notdef /Lslash /lslash /OE /oe /Scaron /scaron /Zcaron /zcaron
866 /Ydieresis /trademark /bullet /dagger /daggerdbl /ellipsis /emdash
867 /endash /fi /fl /florin /fraction /guilsinglleft /guilsinglright
868 /perthousand /quotedblbase /quotedblleft /quotedblright
869 /quotesinglbase /quotesingle /.notdef /.notdef /.notdef /space
870 /exclam /quotedbl /numbersign /dollar /percent /ampersand
871 /quoteright /parenleft /parenright /asterisk /plus /comma /minus
872 /period /slash /zero /one /two /three /four /five /six /seven /eight
873 /nine /colon /semicolon /less /equal /greater /question /at /A /B /C
874 /D /E /F /G /H /I /J /K /L /M /N /O /P /Q /R /S /T /U /V /W /X /Y /Z
875 /bracketleft /backslash /bracketright /asciicircum /underscore
876 /quoteleft /a /b /c /d /e /f /g /h /i /j /k /l /m /n /o /p /q /r /s
877 /t /u /v /w /x /y /z /braceleft /bar /braceright /asciitilde
878 /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
879 /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef /.notdef
880 /.notdef /.notdef /.notdef /dotlessi /grave /acute /circumflex
881 /tilde /macron /breve /dotaccent /dieresis /.notdef /ring /cedilla
882 /.notdef /hungarumlaut /ogonek /caron /space /exclamdown /cent
883 /sterling /currency /yen /brokenbar /section /dieresis /copyright
884 /ordfeminine /guillemotleft /logicalnot /hyphen /registered /macron
885 /degree /plusminus /twosuperior /threesuperior /acute /mu /paragraph
886 /periodcentered /cedilla /onesuperior /ordmasculine /guillemotright
887 /onequarter /onehalf /threequarters /questiondown /Agrave /Aacute
888 /Acircumflex /Atilde /Adieresis /Aring /AE /Ccedilla /Egrave /Eacute
889 /Ecircumflex /Edieresis /Igrave /Iacute /Icircumflex /Idieresis /Eth
890 /Ntilde /Ograve /Oacute /Ocircumflex /Otilde /Odieresis /multiply
891 /Oslash /Ugrave /Uacute /Ucircumflex /Udieresis /Yacute /Thorn
892 /germandbls /agrave /aacute /acircumflex /atilde /adieresis /aring
893 /ae /ccedilla /egrave /eacute /ecircumflex /edieresis /igrave
894 /iacute /icircumflex /idieresis /eth /ntilde /ograve /oacute
895 /ocircumflex /otilde /odieresis /divide /oslash /ugrave /uacute
896 /ucircumflex /udieresis /yacute /thorn /ydieresis
897 ] def
900 (defun ps-mode-heapsort ()
901 "Insert function /Heapsort."
902 (interactive)
903 (insert "
904 % `array-element' Heapsort-cvi-or-cvr-or-cvs `number-or-string'
905 /Heapsort-cvi-or-cvr-or-cvs {
906 % 0 get
907 } bind def
908 % `array' Heapsort `sorted-array'
909 /Heapsort {
910 dup length /hsR exch def
911 /hsL hsR 2 idiv 1 add def
913 hsR 2 lt { exit } if
914 hsL 1 gt {
915 /hsL hsL 1 sub def
917 /hsR hsR 1 sub def
918 dup dup dup 0 get exch dup hsR get
919 0 exch put
920 hsR exch put
921 } ifelse
922 dup hsL 1 sub get /hsT exch def
923 /hsJ hsL def
925 /hsS hsJ def
926 /hsJ hsJ dup add def
927 hsJ hsR gt { exit } if
928 hsJ hsR lt {
929 dup dup hsJ 1 sub get Heapsort-cvi-or-cvr-or-cvs
930 exch hsJ get Heapsort-cvi-or-cvr-or-cvs
931 lt { /hsJ hsJ 1 add def } if
932 } if
933 dup hsJ 1 sub get Heapsort-cvi-or-cvr-or-cvs
934 hsT Heapsort-cvi-or-cvr-or-cvs
935 le { exit } if
936 dup dup hsS 1 sub exch hsJ 1 sub get put
937 } loop
938 dup hsS 1 sub hsT put
939 } loop
940 } bind def
944 ;; EPSF document lay-out.
946 (defun ps-mode-epsf-sparse ()
947 "Insert sparse EPSF template."
948 (interactive)
949 (goto-char (point-max))
950 (unless (re-search-backward "%%EOF[ \t\n]*\\'" nil t)
951 (goto-char (point-max))
952 (insert "\n%%EOF\n"))
953 (goto-char (point-max))
954 (unless (re-search-backward "\\bshowpage[ \t\n]+%%EOF[ \t\n]*\\'" nil t)
955 (re-search-backward "%%EOF")
956 (insert "showpage\n"))
957 (goto-char (point-max))
958 (unless (re-search-backward "\\bend[ \t\n]+\\bshowpage[ \t\n]+%%EOF[ \t\n]*\\'" nil t)
959 (re-search-backward "showpage")
960 (insert "\nend\n"))
961 (goto-char (point-min))
962 (insert "%!PS-Adobe-3.0 EPSF-3.0\n%%BoundingBox: 0 0 ")
963 (insert (format "%d %d\n\n"
964 (car ps-mode-paper-size)
965 (car (cdr ps-mode-paper-size))))
966 (insert "64 dict begin\n\n"))
968 (defun ps-mode-epsf-rich ()
969 "Insert rich EPSF template."
970 (interactive)
971 (ps-mode-epsf-sparse)
972 (forward-line -3)
973 (when buffer-file-name
974 (insert "%%Title: " (file-name-nondirectory buffer-file-name) "\n"))
975 (insert "%%Creator: " (user-full-name) "\n")
976 (insert "%%CreationDate: " (current-time-string) "\n")
977 (insert "%%EndComments\n")
978 (forward-line 3))
981 ;; Interactive PostScript interpreter.
983 (define-derived-mode ps-run-mode comint-mode "Interactive PS"
984 "Major mode in interactive PostScript window.
985 This mode is invoked from `ps-mode' and should not be called directly."
986 (set (make-local-variable 'font-lock-defaults)
987 '((ps-run-font-lock-keywords
988 ps-run-font-lock-keywords-1
989 ps-run-font-lock-keywords-2)
991 (setq mode-line-process '(":%s")))
993 (defun ps-run-running ()
994 "Error if not in `ps-mode' or not running PostScript."
995 (unless (derived-mode-p 'ps-mode)
996 (error "This function can only be called from PostScript mode"))
997 (unless (equal (process-status "ps-run") 'run)
998 (error "No PostScript process running")))
1000 (defun ps-run-start ()
1001 "Start interactive PostScript."
1002 (interactive)
1003 (let ((command (or (and window-system ps-run-x) ps-run-dumb))
1004 (init-file nil)
1005 (process-connection-type nil)
1006 (oldwin (selected-window)))
1007 (unless command
1008 (error "No command specified to run interactive PostScript"))
1009 (unless (and ps-run-mark (markerp ps-run-mark))
1010 (setq ps-run-mark (make-marker)))
1011 (when ps-run-init
1012 (setq init-file (ps-run-make-tmp-filename))
1013 (write-region (concat ps-run-init "\n") 0 init-file)
1014 (setq init-file (list init-file)))
1015 (pop-to-buffer "*ps-run*")
1016 (ps-run-mode)
1017 (when (process-status "ps-run")
1018 (delete-process "ps-run"))
1019 (erase-buffer)
1020 (setq command (append command init-file))
1021 (insert (mapconcat 'identity command " ") "\n")
1022 (apply 'make-comint "ps-run" (car command) nil (cdr command))
1023 (with-current-buffer "*ps-run*"
1024 (use-local-map ps-run-mode-map)
1025 (setq comint-prompt-regexp ps-run-prompt))
1026 (select-window oldwin)))
1028 (defun ps-run-quit ()
1029 "Quit interactive PostScript."
1030 (interactive)
1031 (ps-run-send-string "quit")
1032 (ps-run-cleanup))
1034 (defun ps-run-kill ()
1035 "Kill interactive PostScript."
1036 (interactive)
1037 (delete-process "ps-run")
1038 (ps-run-cleanup))
1040 (defun ps-run-clear ()
1041 "Clear/reset PostScript graphics."
1042 (interactive)
1043 (ps-run-send-string "showpage")
1044 (sit-for 1)
1045 (ps-run-send-string ""))
1047 (defun ps-run-buffer ()
1048 "Send buffer to PostScript interpreter."
1049 (interactive)
1050 (ps-run-region (point-min) (point-max)))
1052 (defun ps-run-region (begin end)
1053 "Send region to PostScript interpreter."
1054 (interactive "r")
1055 (ps-run-running)
1056 (setq ps-run-parent (buffer-name))
1057 (let ((f (ps-run-make-tmp-filename)))
1058 (set-marker ps-run-mark begin)
1059 (write-region begin end f)
1060 (ps-run-send-string (format "(%s) run" f))))
1062 (defun ps-run-boundingbox ()
1063 "View BoundingBox."
1064 (interactive)
1065 (ps-run-running)
1066 (let (x1 y1 x2 y2 f
1067 (buf (current-buffer)))
1068 (save-excursion
1069 (goto-char 1)
1070 (re-search-forward
1071 "^%%BoundingBox:[ \t]+\\(-?[0-9]+\\)[ \t]+\\(-?[0-9]+\\)[ \t]+\\(-?[0-9]+\\)[ \t]+\\(-?[0-9]+\\)")
1072 (setq x1 (match-string 1)
1073 y1 (match-string 2)
1074 x2 (match-string 3)
1075 y2 (match-string 4)))
1076 (unless (< (string-to-number x1) (string-to-number x2))
1077 (error "x1 (%s) should be less than x2 (%s)" x1 x2))
1078 (unless (< (string-to-number y1) (string-to-number y2))
1079 (error "y1 (%s) should be less than y2 (%s)" y1 y2))
1080 (setq f (ps-run-make-tmp-filename))
1081 (write-region
1082 (format
1083 "gsave
1084 initgraphics
1085 2 setlinewidth
1086 %s %s moveto
1087 %s %s lineto
1088 %s %s lineto
1089 %s %s lineto
1090 closepath
1091 gsave
1092 [ 4 20 ] 0 setdash
1093 1 0 0 setrgbcolor
1094 stroke
1095 grestore
1096 gsave
1097 [ 4 20 ] 8 setdash
1098 0 1 0 setrgbcolor
1099 stroke
1100 grestore
1101 [ 4 20 ] 16 setdash
1102 0 0 1 setrgbcolor
1103 stroke
1104 grestore
1105 " x1 y1 x2 y1 x2 y2 x1 y2)
1108 (ps-run-send-string (format "(%s) run" f))
1109 (set-buffer buf)))
1111 (defun ps-run-send-string (string)
1112 (let ((oldwin (selected-window)))
1113 (pop-to-buffer "*ps-run*")
1114 (comint-goto-process-mark)
1115 (insert string)
1116 (comint-send-input)
1117 (select-window oldwin)))
1119 (defun ps-run-make-tmp-filename ()
1120 (unless ps-mode-tmp-file
1121 (setq ps-mode-tmp-file
1122 (let ((temporary-file-directory (or ps-run-tmp-dir
1123 temporary-file-directory)))
1124 (make-temp-file "ps-run-"))))
1125 ps-mode-tmp-file)
1127 ;; Remove temporary file
1128 ;; This shouldn't fail twice, because it is called at kill-emacs
1129 (defun ps-run-cleanup ()
1130 (when ps-mode-tmp-file
1131 (let ((i ps-mode-tmp-file))
1132 (setq ps-mode-tmp-file nil)
1133 (when (file-exists-p i)
1134 (delete-file i)))))
1136 (defun ps-run-mouse-goto-error (event)
1137 "Set point at mouse click, then call `ps-run-goto-error'."
1138 (interactive "e")
1139 (mouse-set-point event)
1140 (ps-run-goto-error))
1142 (defun ps-run-goto-error ()
1143 "Jump to buffer position read as integer at point.
1144 Use line numbers if `ps-run-error-line-numbers' is not nil"
1145 (interactive)
1146 (let ((p (point)))
1147 (unless (looking-at "[0-9]")
1148 (goto-char (max 1 (1- (point)))))
1149 (when (looking-at "[0-9]")
1150 (forward-char 1)
1151 (forward-word -1)
1152 (when (looking-at "[0-9]+")
1153 (let (i)
1154 (setq
1156 (string-to-number
1157 (buffer-substring (match-beginning 0) (match-end 0))))
1158 (goto-char p)
1159 (pop-to-buffer ps-run-parent)
1160 (if ps-run-error-line-numbers
1161 (progn
1162 (goto-char (marker-position ps-run-mark))
1163 (forward-line (1- i))
1164 (end-of-line))
1165 (goto-char (+ i (marker-position ps-run-mark)))))))))
1169 (add-hook 'kill-emacs-hook 'ps-run-cleanup)
1171 (provide 'ps-mode)
1173 ;;; ps-mode.el ends here