source: project/release/3/readline/readline.scm @ 12677

Last change on this file since 12677 was 12677, checked in by mfredrickson, 12 years ago

This checkin of readline has 2 changes:

  1. All the C code is moved into readline-egg.c as a housecleaning measure. At the moment it is just #include'd into readline.scm - but in the future, it may be compiled on its own.
  1. File globbing works for quoted completions (e.g. '(load "my-fil[tab]' -> will complete with all files starting with "my-fil*"). Non-quoted completions behave as before.

This is a pre-release checkin while I get the docs updated, bump the version number, double check the exports, etc.

File size: 13.7 KB
Line 
1;;; Add-in module to support using GNU readline from Chicken.
2;
3; (Readline is GPLed, so that makes this file GPLed too, because this
4; file will only run if it's linked against readline.)
5;
6; Copyright (c) 2002 Tony Garnock-Jones
7; Copyright (c) 2006 Heath Johns (paren bouncing and auto-completion code)
8;
9; This program is free software; you can redistribute it and/or modify
10; it under the terms of the GNU General Public License as published by
11; the Free Software Foundation; either version 2 of the License, or
12; (at your option) any later version.
13;
14; This program is distributed in the hope that it will be useful,
15; but WITHOUT ANY WARRANTY; without even the implied warranty of
16; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17; GNU General Public License for more details.
18;
19; You should have received a copy of the GNU General Public License
20; along with this program; if not, write to the Free Software
21; Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
22
23;---------------------------------------------------------------------------
24; csc -s readline.scm -L -lreadline -L -ltermcap
25;
26; To get csi to support line editing, install this library and put the
27; following lines in your ~/.csirc:
28;
29;   (require 'readline)
30;   (current-input-port (make-gnu-readline-port "csi> "))
31;
32; If you also want to make the command history span sessions, add the
33; following:
34;
35;   (gnu-history-install-file-manager (string-append (or (getenv "HOME") ".") "/.csi.history"))
36;
37; By default this will save 1000 lines of history between sessions (it
38; will prune the history file to 1000 lines at startup). For a
39; different history size, pass the desired number of lines as the
40; (optional) second argument to gnu-history-install-file-manager. If
41; #f is passed in, no history-file-pruning will take place.
42;
43;
44; Esoteric Options
45; -----------------
46;
47; To change the bouncing parenthesis time (default is 500ms):
48;
49; (gnu-readline-set-bounce-ms 1000)
50;
51; To turn it off completely:
52;
53; (gnu-readline-set-bounce-ms 0)
54;
55;
56; To pass configuration options to readline (see the readline manual page for
57; details):
58;
59; (gnu-readline-parse-and-bind "set editing-mode vi")
60;
61;
62; To change the "still waiting for input" prompt, just pass it as a second
63; argument to make-readline-port:
64;
65; (current-input-port (make-gnu-readline-port "csi> " ".... "))
66;
67;
68; The neato line numbered display that's the csi default doesn't work, but
69; here's how to write a replacement:
70;
71;(repl-prompt
72;  (let ((history-count -1))
73;       (lambda ()
74;         (set! history-count (+ 1 history-count))
75;         (sprintf "#;~A> " hist))))
76
77#|
78
79TODO:
80- C-w terminal thingy
81- tab completion with procedure info
82
83|#
84
85
86(declare
87 (usual-integrations)
88
89 (uses posix)
90
91 ;(export
92 ;
93 ; gnu-readline
94 ; make-gnu-readline-port
95 ; %gnu-readline-signal-cleanup
96 ;
97 ; gnu-readline-clear-history
98 ; gnu-readline-read-history
99 ; gnu-readline-write-history
100 ; gnu-readline-append-history
101 ; gnu-readline-truncate-history
102 ; gnu-history-new-lines
103 ; gnu-history-install-file-manager
104 ;
105 ; gnu-readline-parse-and-bind
106 ; gnu-readline-set-bounce-ms
107 ;
108 ; gnu-readline-completions
109 ; )
110  )
111
112
113#>
114 #include "readline-egg.c"
115<#
116
117
118;; Initialise (note the extra set of parens)
119((foreign-lambda void "gnu_readline_init"))
120
121
122;; Various C funcs
123
124(define gnu-readline
125  (foreign-safe-lambda c-string "gnu_readline_readline" c-string c-string))
126
127(define %gnu-readline-signal-cleanup
128    (foreign-lambda void "gnu_readline_signal_cleanup"))
129
130(define gnu-readline-clear-history
131  (foreign-lambda void "clear_history"))
132
133;;; (gnu-readline-read-history <filename-or-false>) -> 0 for success, errno for failure
134(define gnu-readline-read-history
135  (foreign-lambda int "read_history" c-string))
136
137;;; (gnu-readline-write-history <filename-or-false>) -> 0 for success, errno for failure
138(define gnu-readline-write-history
139  (foreign-lambda int "write_history" c-string))
140
141(define gnu-readline-append-history
142    (foreign-lambda int "gnu_readline_append_history" c-string))
143
144;;; (gnu-readline-truncate-history <filename-or-false> <numlines>) -> 0 succ, errno fail
145(define gnu-readline-truncate-history
146  (foreign-lambda int "history_truncate_file" c-string int))
147
148(define gnu-history-new-lines
149    (foreign-lambda int "gnu_history_new_lines"))
150
151;; Useful...
152(define gnu-readline-parse-and-bind
153  (foreign-lambda int "rl_parse_and_bind" c-string))
154
155;; Set the amount of time the cursor spends bouncing
156(define gnu-readline-set-bounce-ms
157  (foreign-lambda* void ((int time))
158        "gnu_readline_bounce_ms = time;"))
159
160;; get access to the quoting flag
161(define-foreign-variable is-quoted? int "rl_completion_quote_character")
162(define-foreign-variable filename-completion int "rl_filename_completion_desired")
163
164;; Handler for the command history file
165(define (gnu-history-install-file-manager filename . nlines)
166  (define (hook param)
167    (param (let ((next (param)))
168             (lambda args
169               ;(gnu-readline-write-history filename)
170               (gnu-readline-append-history filename)
171               (apply next args)))))
172  (if (pair? nlines)
173      (set! nlines (car nlines))
174      (set! nlines 1000))
175  (if nlines
176      (gnu-readline-truncate-history filename nlines))
177  (gnu-readline-read-history filename)
178  (hook exit-handler)
179  (hook implicit-exit-handler))
180
181
182;; Prompt2 is displayed when there are still open parens, this just makes a reasonable one
183(define (make-prompt2 prompt)
184  (let ((len (string-length prompt)))
185        (case len
186          ((0) "")
187          ((1) ">")
188          ((2) "> ")
189          (else (conc (make-string (- len 2) #\-) "> ")))))
190
191
192;; Creates a port that reads using readline
193(define (make-gnu-readline-port #!optional prompt prompt2)
194    (let ((buffer   "")
195          (pos      0)
196          (p1       prompt)
197          (p2       prompt2)
198          (handle   #f))
199        (letrec ((char-ready?
200                    (lambda ()
201                        (< pos (string-length buffer))))
202                 (get-next-char!
203                    (lambda ()
204                        (cond ((not buffer)
205                                  #!eof)
206                              ((char-ready?)
207                                  (let ((ch   (string-ref buffer pos)))
208                                      (set! pos (+ 1 pos))
209                                      ch))
210                              (else
211                                  (set! pos 0)
212                                  (set! buffer
213                                        (let* ((prompt    (or prompt
214                                                              ((repl-prompt))))
215                                               (prompt2   (make-prompt2
216                                                              prompt)))
217                                            (gnu-readline prompt prompt2)))
218                                  (if (string? buffer)
219                                      (set! buffer (string-append buffer "\n")))
220                                  (get-next-char!))))))
221            (set! handle (lambda (s)
222                             (print-call-chain)
223                             (set! pos 0)
224                             (set! buffer "")
225                             ((foreign-lambda void
226                                  "gnu_readline_signal_cleanup"))
227                             (##sys#user-interrupt-hook)))
228            (set-signal-handler! signal/int handle)
229            (let ((p   (make-input-port
230                           get-next-char!
231                           char-ready?
232                           (lambda ()
233                               (set-signal-handler! signal/int #f)
234                               'closed-gnu-readline-port))))
235                (set-port-name! p "(gnu-readline)")
236                p))))
237
238
239;;;;;;;; Tab Completion ;;;;;;;;
240
241
242;; Borrowed from the oblist egg
243(define find-symbol-table (foreign-lambda c-pointer "C_find_symbol_table" c-string))
244(define enum-symbols! (foreign-lambda scheme-object "C_enumerate_symbols" c-pointer scheme-object))
245
246;; Globally defined enumeration state (callbacks can't be closures)
247(define enum-funcs '())
248
249;; Creates a list of closures that enumerate anything the user would want to type
250(define (create-symbol-ef word)
251        (let ((global-symbol-index (cons -1 '()))
252                  (global-symbol-pointer (find-symbol-table ".")))
253          (lambda ()
254                (let loop ()
255                  (let ((symb (enum-symbols! global-symbol-pointer 
256                                                                         global-symbol-index)))
257                        (cond ((not symb)
258                                   "")
259                                  ((not (##sys#symbol-has-toplevel-binding? symb))
260                                   (loop))
261                                  (else
262                                        (let ((str (##sys#symbol->qualified-string symb)))
263                                          ;; Possibly undo the mangling of keywords
264                                          (if (not (substring=? "###" str))
265                                                str
266                                                (string-append (substring str 3) ":"))))))))))
267                                               
268;; R5RS keywords (including some special forms not included in above)
269(define (create-static-ef word)
270        (let ((index -1)
271                  (v-len (vector-length static-keywords)))
272          (lambda ()
273                (set! index (+ 1 index))
274                (if (not (>= index v-len))
275                  (vector-ref static-keywords index)
276                  ""))))
277                 
278;; Macros (thanks to Kon Lovett for suggesting ##sys#macro-environment)
279(define (create-macro-ef word)
280        (let ((index -1))
281          (lambda ()
282                (let loop ()
283                  (set! index (+ 1 index))
284                  (cond ((>= index (vector-length ##sys#macro-environment)) 
285                                 "")
286                                (else
287                                  (let ((ref (vector-ref ##sys#macro-environment index)))
288                                        (if (null? ref)
289                                          (loop)
290                                          (symbol->string (caar ref))))))))))
291
292;; handling filename completion
293(define (turn-on-filenames)
294  (set! filename-completion 1))
295 
296(define (create-file-ef word)
297  (turn-on-filenames)
298  (let ((files (glob (string-append word "*"))))
299    (lambda ()
300      (if (null? files) ""
301        (let ((current (car files)))
302          (set! files (cdr files))
303          current)))))
304         
305(define gnu-readline-completions 
306  (make-parameter 
307    (list
308      (cons 'macros create-macro-ef)
309      (cons 'statics create-static-ef) 
310      (cons 'symbols create-symbol-ef))))
311
312(define gnu-readline-quoted-completions
313  (make-parameter
314    (list
315      (cons 'files create-file-ef))))
316     
317;; This is the completion function called by readline
318;; It's called repeatedly until it returns an empty string
319;; (lambda'd to stop the compiler complaining about unused global var)
320((lambda ()
321   (define-external (gnu_readline_scm_complete (c-string word) (int len) (int state)) scheme-object
322         ;; If state is zero, init enumeration funcs.  Don't try to complete an empty string...
323         ;(print is-quoted?)
324         (when (zero? state)
325           (if (not (zero? len))
326                 (set! enum-funcs (choose-completion-procs word))
327                 ""))
328         ;; Call the enumeration funcs, discarding the ones that are done
329         (let loop ()
330           (if (null? enum-funcs)
331                 ""
332                 (let ((result ((car enum-funcs))))
333                   (cond ((equal? result "")
334                                  (set! enum-funcs (cdr enum-funcs))
335                                  (loop))
336                                 ((substring=? word result 0 0 len)
337                                  result) ;; Return only ones that are a substring of the word typed
338                                 (else (loop)))))))))
339
340;; This function simply chooses which completion type is appropriate
341;; and then gets those procedures ready.
342(define (choose-completion-procs word)
343  (map
344    (lambda (pair) ((cdr pair) word)) 
345    (if (= 34 is-quoted?)
346      (gnu-readline-quoted-completions)
347      (gnu-readline-completions))))
348
349;; Things that will always be there...
350(define static-keywords (vector
351                                                ; R5RS
352                                                "abs" "acos" "and" "angle" "append" "apply" "asin" 
353                                                "assoc" "assq" "assv" "atan" "begin" "boolean?" 
354                                                "caar" "cadr" "call-with-current-continuation" 
355                                                "call-with-input-file" "call-with-output-file" 
356                                                "call-with-values" "car" "case" "cdddar" "cddddr" 
357                                                "cdr" "ceiling" "char->integer" "char-alphabetic?" 
358                                                "char-ci<=?" "char-ci<?" "char-ci=?" "char-ci>=?" 
359                                                "char-ci>?" "char-downcase" "char-lower-case?" 
360                                                "char-numeric?" "char-ready?" "char-upcase" 
361                                                "char-upper-case?" "char-whitespace?" "char<=?" 
362                                                "char<?" "char=?" "char>=?" "char>?" "char?" 
363                                                "close-input-port" "close-output-port" "complex?" 
364                                                "cond" "cons" "cos" "current-input-port" 
365                                                "current-output-port" "define" "define-syntax" 
366                                                "delay" "denominator" "display" "do" "dynamic-wind" 
367                                                "else" "eof-object?" "eq?" "equal?" "eqv?" "eval" 
368                                                "even?" "exact->inexact" "exact?" "exp" "expt" 
369                                                "floor" "for-each" "force" "gcd" "if" "imag-part" 
370                                                "inexact->exact" "inexact?" "input-port?" 
371                                                "integer->char" "integer?" "interaction-environment" 
372                                                "lambda" "lcm" "length" "let" "let*" "let-syntax" 
373                                                "letrec" "letrec-syntax" "list" "list->string" 
374                                                "list->vector" "list-ref" "list-tail" "list?" "load" 
375                                                "log" "magnitude" "make-polar" "make-rectangular" 
376                                                "make-string" "make-vector" "map" "max" "member" 
377                                                "memq" "memv" "min" "modulo" "negative?" "newline" 
378                                                "not" "null-environment" "null?" "number->string" 
379                                                "number?" "numerator" "odd?" "open-input-file" 
380                                                "open-output-file" "or" "output-port?" "pair?" 
381                                                "peek-char" "port?" "positive?" "procedure?" 
382                                                "quasiquote" "quote" "quotient" "rational?" 
383                                                "rationalize" "read" "read-char" "real-part" 
384                                                "real?" "remainder" "reverse" "round" 
385                                                "scheme-report-environment" "set!" "set-car!" 
386                                                "set-cdr!" "setcar" "sin" "sqrt" "string" 
387                                                "string->list" "string->number" "string->symbol" 
388                                                "string-append" "string-ci<=?" "string-ci<?" 
389                                                "string-ci=?" "string-ci>=?" "string-ci>?" 
390                                                "string-copy" "string-fill!" "string-length" 
391                                                "string-ref" "string-set!" "string<=?" "string<?" 
392                                                "string=?" "string>=?" "string>?" "string?" 
393                                                "substring" "symbol->string" "symbol?" 
394                                                "syntax-rules" "tan" "transcript-off" 
395                                                "transcript-on" "truncate" "values" "vector" 
396                                                "vector->list" "vector-fill!" "vector-length" 
397                                                "vector-ref" "vector-set!" "vector?" 
398                                                "with-input-from-file" "with-output-to-file" 
399                                                "write" "write-char" "zero?"
400                                                ; csi commands
401                                                ",?" ",p" ",d" ",du" ",dur" ",q" ",l" ",ln" ",r"
402                                                ",s" ",tr" ",utr" ",t" ",x" 
403                                                ))
404
405
Note: See TracBrowser for help on using the repository browser.