2001-03-17 Michael Kifer <kifer@cs.sunysb.edu>
[emacs.git] / lisp / emulation / mlsupport.el
blobab32291dbfe8572565f7f1b522112b86fdaa1b78
1 ;;; mlsupport.el --- run-time support for mocklisp code.
3 ;; Copyright (C) 1985 Free Software Foundation, Inc.
5 ;; Maintainer: FSF
6 ;; Keywords: extensions
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)
13 ;; any later version.
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.
25 ;;; Commentary:
27 ;; This package provides equivalents of certain primitives from Gosling
28 ;; Emacs (including the commercial UniPress versions). These have an
29 ;; ml- prefix to distinguish them from native GNU Emacs functions with
30 ;; similar names. The package mlconvert.el translates Mocklisp code
31 ;; to use these names.
33 ;;; Code:
35 (defmacro ml-defun (&rest defs)
36 (list 'ml-defun-1 (list 'quote defs)))
38 (defun ml-defun-1 (args)
39 (while args
40 (fset (car (car args)) (cons 'mocklisp (cdr (car args))))
41 (setq args (cdr args))))
43 (defmacro declare-buffer-specific (&rest vars)
44 (cons 'progn (mapcar (function (lambda (var) (list 'make-variable-buffer-local (list 'quote var)))) vars)))
46 (defun ml-set-default (varname value)
47 (set-default (intern varname) value))
49 ; Lossage: must make various things default missing args to the prefix arg
50 ; Alternatively, must make provide-prefix-argument do something hairy.
52 (defun >> (val count) (lsh val (- count)))
53 (defun novalue () nil)
55 (defun ml-not (arg) (if (zerop arg) 1 0))
57 (defun provide-prefix-arg (arg form)
58 (funcall (car form) arg))
60 (defun define-keymap (name)
61 (fset (intern name) (make-keymap)))
63 ;; Make it work to use ml-use-...-map on "esc" and such.
64 (fset 'esc-map esc-map)
65 (fset 'ctl-x-map ctl-x-map)
67 (defun ml-use-local-map (name)
68 (use-local-map (intern (concat name "-map"))))
70 (defun ml-use-global-map (name)
71 (use-global-map (intern (concat name "-map"))))
73 (defun local-bind-to-key (name key)
74 (or (current-local-map)
75 (use-local-map (make-keymap)))
76 (define-key (current-local-map)
77 (if (integerp key)
78 (if (>= key 128)
79 (concat (char-to-string meta-prefix-char)
80 (char-to-string (- key 128)))
81 (char-to-string key))
82 key)
83 (intern name)))
85 (defun bind-to-key (name key)
86 (define-key global-map (if (integerp key) (char-to-string key) key)
87 (intern name)))
89 (defun ml-autoload (name file)
90 (autoload (intern name) file))
92 (defun ml-define-string-macro (name defn)
93 (fset (intern name) defn))
95 (defun push-back-character (char)
96 (setq unread-command-events (list char)))
98 (defun to-col (column)
99 (indent-to column 0))
101 (defmacro is-bound (&rest syms)
102 (cons 'and (mapcar (function (lambda (sym) (list 'boundp (list 'quote sym)))) syms)))
104 (defmacro declare-global (&rest syms)
105 (cons 'progn (mapcar (function (lambda (sym) (list 'defvar sym nil))) syms)))
107 (defmacro error-occurred (&rest body)
108 (list 'condition-case nil (cons 'progn (append body '(nil))) '(error t)))
110 (defun return-prefix-argument (value)
111 (setq prefix-arg value))
113 (defun ml-prefix-argument ()
114 (if (null current-prefix-arg) 1
115 (if (listp current-prefix-arg) (car current-prefix-arg)
116 (if (eq current-prefix-arg '-) -1
117 current-prefix-arg))))
119 (defun ml-print (varname)
120 (interactive "vPrint variable: ")
121 (if (boundp varname)
122 (message "%s => %s" (symbol-name varname) (symbol-value varname))
123 (message "%s has no value" (symbol-name varname))))
125 (defun ml-set (str val) (set (intern str) val))
127 (defun ml-message (&rest args) (message "%s" (apply 'concat args)))
129 (defun kill-to-end-of-line ()
130 (ml-prefix-argument-loop
131 (if (eolp)
132 (kill-region (point) (1+ (point)))
133 (kill-region (point) (if (search-forward ?\n nil t)
134 (1- (point)) (point-max))))))
136 (defun set-auto-fill-hook (arg)
137 (setq auto-fill-function (intern arg)))
139 (defun auto-execute (function pattern)
140 (if (/= (aref pattern 0) ?*)
141 (error "Only patterns starting with * supported in auto-execute"))
142 (setq auto-mode-alist (cons (cons (concat "\\." (substring pattern 1)
143 "\\'")
144 function)
145 auto-mode-alist)))
147 (defun move-to-comment-column ()
148 (indent-to comment-column))
150 (defun erase-region ()
151 (delete-region (point) (mark)))
153 (defun delete-region-to-buffer (bufname)
154 (copy-to-buffer bufname (point) (mark))
155 (delete-region (point) (mark)))
157 (defun copy-region-to-buffer (bufname)
158 (copy-to-buffer bufname (point) (mark)))
160 (defun append-region-to-buffer (bufname)
161 (append-to-buffer bufname (point) (mark)))
163 (defun prepend-region-to-buffer (bufname)
164 (prepend-to-buffer bufname (point) (mark)))
166 (defun delete-next-character ()
167 (delete-char (ml-prefix-argument)))
169 (defun delete-next-word ()
170 (delete-region (point) (progn (forward-word (ml-prefix-argument)) (point))))
172 (defun delete-previous-word ()
173 (delete-region (point) (progn (backward-word (ml-prefix-argument)) (point))))
175 (defun delete-previous-character ()
176 (delete-backward-char (ml-prefix-argument)))
178 (defun forward-character ()
179 (forward-char (ml-prefix-argument)))
181 (defun backward-character ()
182 (backward-char (ml-prefix-argument)))
184 (defun ml-newline ()
185 (newline (ml-prefix-argument)))
187 (defun ml-next-line ()
188 (next-line (ml-prefix-argument)))
190 (defun ml-previous-line ()
191 (previous-line (ml-prefix-argument)))
193 (defun delete-to-kill-buffer ()
194 (kill-region (point) (mark)))
196 (defun narrow-region ()
197 (narrow-to-region (point) (mark)))
199 (defun ml-newline-and-indent ()
200 (let ((column (current-indentation)))
201 (newline (ml-prefix-argument))
202 (indent-to column)))
204 (defun newline-and-backup ()
205 (open-line (ml-prefix-argument)))
207 (defun quote-char ()
208 (quoted-insert (ml-prefix-argument)))
210 (defun ml-current-column ()
211 (1+ (current-column)))
213 (defun ml-current-indent ()
214 (1+ (current-indentation)))
216 (defun region-around-match (&optional n)
217 (set-mark (match-beginning n))
218 (goto-char (match-end n)))
220 (defun region-to-string ()
221 (buffer-substring (min (point) (mark)) (max (point) (mark))))
223 (defun use-abbrev-table (name)
224 (let ((symbol (intern (concat name "-abbrev-table"))))
225 (or (boundp symbol)
226 (define-abbrev-table symbol nil))
227 (symbol-value symbol)))
229 (defun define-hooked-local-abbrev (name exp hook)
230 (define-abbrev local-abbrev-table name exp (intern hook)))
232 (defun define-hooked-global-abbrev (name exp hook)
233 (define-abbrev global-abbrev-table name exp (intern hook)))
235 (defun case-word-lower ()
236 (ml-casify-word 'downcase-region))
238 (defun case-word-upper ()
239 (ml-casify-word 'upcase-region))
241 (defun case-word-capitalize ()
242 (ml-casify-word 'capitalize-region))
244 (defun ml-casify-word (fun)
245 (save-excursion
246 (forward-char 1)
247 (forward-word -1)
248 (funcall fun (point)
249 (progn (forward-word (ml-prefix-argument))
250 (point)))))
252 (defun case-region-lower ()
253 (downcase-region (point) (mark)))
255 (defun case-region-upper ()
256 (upcase-region (point) (mark)))
258 (defun case-region-capitalize ()
259 (capitalize-region (point) (mark)))
261 (defvar saved-command-line-args nil)
263 (defun argc ()
264 (or saved-command-line-args
265 (setq saved-command-line-args command-line-args
266 command-line-args ()))
267 (length command-line-args))
269 (defun argv (i)
270 (or saved-command-line-args
271 (setq saved-command-line-args command-line-args
272 command-line-args ()))
273 (nth i saved-command-line-args))
275 (defun invisible-argc ()
276 (length (or saved-command-line-args
277 command-line-args)))
279 (defun invisible-argv (i)
280 (nth i (or saved-command-line-args
281 command-line-args)))
283 (defun exit-emacs ()
284 (interactive)
285 (condition-case ()
286 (exit-recursive-edit)
287 (error (kill-emacs))))
289 ;; Lisp function buffer-size returns total including invisible;
290 ;; mocklisp wants just visible.
291 (defun ml-buffer-size ()
292 (- (point-max) (point-min)))
294 (defun previous-command ()
295 last-command)
297 (defun beginning-of-window ()
298 (goto-char (window-start)))
300 (defun end-of-window ()
301 (goto-char (window-start))
302 (vertical-motion (- (window-height) 2)))
304 (defun ml-search-forward (string)
305 (search-forward string nil nil (ml-prefix-argument)))
307 (defun ml-re-search-forward (string)
308 (re-search-forward string nil nil (ml-prefix-argument)))
310 (defun ml-search-backward (string)
311 (search-backward string nil nil (ml-prefix-argument)))
313 (defun ml-re-search-backward (string)
314 (re-search-backward string nil nil (ml-prefix-argument)))
316 (defvar use-users-shell 1
317 "Mocklisp compatibility variable; 1 means use shell from SHELL env var.
318 0 means use /bin/sh.")
320 (defvar use-csh-option-f 1
321 "Mocklisp compatibility variable; 1 means pass -f when calling csh.")
323 (defun filter-region (command)
324 (let ((shell (if (/= use-users-shell 0) shell-file-name "/bin/sh"))
325 (csh (equal (file-name-nondirectory shell) "csh")))
326 (call-process-region (point) (mark) shell t t nil
327 (if (and csh use-csh-option-f) "-cf" "-c")
328 (concat "exec " command))))
330 (defun execute-monitor-command (command)
331 (let ((shell (if (/= use-users-shell 0) shell-file-name "/bin/sh"))
332 (csh (equal (file-name-nondirectory shell) "csh")))
333 (call-process shell nil t t
334 (if (and csh use-csh-option-f) "-cf" "-c")
335 (concat "exec " command))))
337 (defun use-syntax-table (name)
338 (set-syntax-table (symbol-value (intern (concat name "-syntax-table")))))
340 (defun line-to-top-of-window ()
341 (recenter (1- (ml-prefix-argument))))
343 (defun ml-previous-page (&optional arg)
344 (let ((count (or arg (ml-prefix-argument))))
345 (while (> count 0)
346 (scroll-down nil)
347 (setq count (1- count)))
348 (while (< count 0)
349 (scroll-up nil)
350 (setq count (1+ count)))))
352 (defun ml-next-page ()
353 (previous-page (- (ml-prefix-argument))))
355 (defun page-next-window (&optional arg)
356 (let ((count (or arg (ml-prefix-argument))))
357 (while (> count 0)
358 (scroll-other-window nil)
359 (setq count (1- count)))
360 (while (< count 0)
361 (scroll-other-window '-)
362 (setq count (1+ count)))))
364 (defun ml-next-window ()
365 (select-window (next-window)))
367 (defun ml-previous-window ()
368 (select-window (previous-window)))
370 (defun scroll-one-line-up ()
371 (scroll-up (ml-prefix-argument)))
373 (defun scroll-one-line-down ()
374 (scroll-down (ml-prefix-argument)))
376 (defun split-current-window ()
377 (split-window (selected-window)))
379 (defun last-key-struck () last-command-char)
381 (defun execute-mlisp-line (string)
382 (eval (read string)))
384 (defun move-dot-to-x-y (x y)
385 (goto-char (window-start (selected-window)))
386 (vertical-motion (1- y))
387 (move-to-column (1- x)))
389 (defun ml-modify-syntax-entry (string)
390 (let ((i 5)
391 (len (length string))
392 (datastring (substring string 0 2)))
393 (if (= (aref string 0) ?\-)
394 (aset datastring 0 ?\ ))
395 (if (= (aref string 2) ?\{)
396 (if (= (aref string 4) ?\ )
397 (aset datastring 0 ?\<)
398 (error "Two-char comment delimiter: use modify-syntax-entry directly")))
399 (if (= (aref string 3) ?\})
400 (if (= (aref string 4) ?\ )
401 (aset datastring 0 ?\>)
402 (error "Two-char comment delimiter: use modify-syntax-entry directly")))
403 (while (< i len)
404 (modify-syntax-entry (aref string i) datastring)
405 (setq i (1+ i))
406 (if (and (< i len)
407 (= (aref string i) ?\-))
408 (let ((c (aref string (1- i)))
409 (lim (aref string (1+ i))))
410 (while (<= c lim)
411 (modify-syntax-entry c datastring)
412 (setq c (1+ c)))
413 (setq i (+ 2 i)))))))
417 (defun ml-substr (string from to)
418 (let ((length (length string)))
419 (if (< from 0) (setq from (+ from length)))
420 (if (< to 0) (setq to (+ to length)))
421 (substring string from (+ from to))))
423 (defun ml-concat (&rest args)
424 (let ((newargs nil) this)
425 (while args
426 (setq this (car args))
427 (if (numberp this)
428 (setq this (number-to-string this)))
429 (setq newargs (cons this newargs)
430 args (cdr args)))
431 (apply 'concat (nreverse newargs))))
433 (provide 'mlsupport)
435 ;;; mlsupport.el ends here