hi Daniel & Ludo!
===========================
** Here are the changes:
1. Use srfi-9 record & fields comment
But I still like r6rs record, since it's less code to write. The only
good point for me is easy to comment each field. ;-P
2. Fix function define convention
I'm not aware of that, but are we going to define a function without
explicit 'lambda'?
Sorry but I didn't find any doc for this convention. I read HACKING
file, but it explains only about C code convention.
Anyway, I fixed it.
3. Rename "data" to "obj"
4. Fixed recursive REPL issue:
I think '(null? (fluid-ref *repl-stack*))' is true if there's no REPL
started, right?
============================
** But suspended issues:
1. Code style issue
I can't find a doc in Guile for that. Could anyone help me out?
2. Array efficient issue
I'd like to fix it, but it's complex & inefficient either anyway.
I've no idea at all. Even if I simply output (object->string array),
it's inefficient as read it's array-prefix-part-string, and parse it.
The best way I think is to use array-rank/array-type... such things to
handle all the prefix-part of array. But as I said, it's too
complicated, the simplest way is the way I choose.
My vote is to avoid complex design if unnecessary. But we may enhance it
later in the long term, rather than put all hackers' power to focus on a
rarely considered issue now.
What do you think?
3. Test case & manual
Should be done after all issues gone.
Anything missing?
Thanks!
;; Copyright (C) 2012 Free Software Foundation, Inc.
;;;; This library is free software; you can redistribute it and/or
;;;; modify it under the terms of the GNU Lesser General Public
;;;; License as published by the Free Software Foundation; either
;;;; version 3 of the License, or (at your option) any later version.
;;;;
;;;; This library is distributed in the hope that it will be useful,
;;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
;;;; Lesser General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU Lesser General Public
;;;; License along with this library; if not, write to the Free Software
;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
;;;; Author: Mu Lei known as NalaGinrut <nalagin...@gmail.com>
(define-module (ice-9 colorized)
#:use-module (ice-9 rdelim)
#:use-module ((srfi srfi-1) #:select (filter-map any proper-list?))
#:use-module (srfi srfi-9)
#:use-module (system repl common)
#:export (activate-colorized custom-colorized-set! color-it colorize-it colorize
colorize-string colorized-display add-color-scheme! display-in-color))
(define (colorized-repl-printer repl val)
(colorize-it val))
(define (activate-colorized)
(let ((rs (fluid-ref *repl-stack*)))
(if (null? rs)
(repl-default-option-set! 'print colorized-repl-printer) ; if no REPL started, set as default printer
(repl-option-set! (car rs) 'print colorized-repl-printer)))) ; or set as the top-REPL printer
;; color-scheme context, contains some info to be used
(define-record-type color-scheme
(make-color-scheme obj type color control method)
color-scheme?
(obj color-scheme-obj) ; the obj to be colored
(type color-scheme-type) ; the obj type (for debug/test)
(color color-scheme-color) ; the color
(control color-scheme-control) ; ansi control code
(method color-scheme-method)) ; colorized method for the obj type
(define *color-list*
`((CLEAR . "0")
(RESET . "0")
(BOLD . "1")
(DARK . "2")
(UNDERLINE . "4")
(UNDERSCORE . "4")
(BLINK . "5")
(REVERSE . "6")
(CONCEALED . "8")
(BLACK . "30")
(RED . "31")
(GREEN . "32")
(YELLOW . "33")
(BLUE . "34")
(MAGENTA . "35")
(CYAN . "36")
(WHITE . "37")
(ON-BLACK . "40")
(ON-RED . "41")
(ON-GREEN . "42")
(ON-YELLOW . "43")
(ON-BLUE . "44")
(ON-MAGENTA . "45")
(ON-CYAN . "46")
(ON-WHITE . "47")))
(define (get-color color)
(assoc-ref *color-list* color))
(define (generate-color colors)
(let ((color-list
(filter-map (lambda (c) (assoc-ref *color-list* c)) colors)))
(if (null? color-list)
""
(string-append "\x1b[" (string-join color-list ";" 'infix) "m"))))
(define (colorize-the-string color str control)
(string-append (generate-color color) str (generate-color control)))
(define (color-it-test color str control) str)
;; test-helper functions
;; when eanbled, it won't output colored result, but just normal.
;; it used to test the array/list/vector print result.
(define *color-func* (make-fluid colorize-the-string))
(define (disable-color-test)
(fluid-set! *color-func* colorize-the-string))
(define (enable-color-test)
(fluid-set! *color-func* color-it-test))
(define (color-it cs)
(let* ((obj (color-scheme-obj cs))
(str (object->string obj))
(color (color-scheme-color cs))
(control (color-scheme-control cs)))
(color-it-inner color str control)))
(define (color-it-inner color str control)
((fluid-ref *color-func*) color str control))
(define* (space #:optional (port (current-output-port)))
(display #\sp port))
(define *pre-sign*
`((LIST . "(")
(PAIR . "(")
(VECTOR . "#(")
(ARRAY . #f)))
;; array's sign is complecated, return #f so it will be handled by pre-print
(define* (pre-print cs #:optional (port (current-output-port)))
(let* ((type (color-scheme-type cs))
(control (color-scheme-control cs))
(sign (assoc-ref *pre-sign* type))
(color (color-scheme-color cs)))
(if sign
(display (color-it-inner color sign control) port) ; not array
;; array complecated coloring
(display (color-array-inner cs) port))))
(define (print-dot port)
(let ((light-cyan '(CYAN BOLD)))
(display (color-it-inner light-cyan "." '(RESET)) port)))
(define (delimiter? ch)
(char-set-contains? char-set:punctuation ch))
(define (color-array-inner cs)
(let* ((colors (color-scheme-color cs))
(control (color-scheme-control cs))
(sign-color (car colors))
(attr-color (cadr colors))
(str (object->string (color-scheme-obj cs)))
(attrs (string->list
(call-with-input-string str (lambda (p) (read-delimited "(" p))))))
(call-with-output-string
(lambda (port)
(for-each (lambda (ch)
(let ((color (if (delimiter? ch) sign-color attr-color)))
(display (color-it-inner color (string ch) control) port)))
attrs)
;; output left-paren
(display (color-it-inner sign-color "(" control) port)))))
;; Write a closing parenthesis.
(define* (post-print cs #:optional (port (current-output-port)))
(let* ((c (color-scheme-color cs))
(control (color-scheme-control cs))
(color (if (list? (car c)) (car c) c))) ; array has a color-list
(display (color-it-inner color ")" control) port)))
(define (color-integer cs)
(color-it cs))
(define (color-char cs)
(color-it cs))
(define (color-string cs)
(color-it cs))
(define (color-list cs)
(let* ((obj (color-scheme-obj cs)))
(if (proper-list? obj)
(call-with-output-string
(lambda (port)
(pre-print cs port)
(display (string-join (map ->cstr obj) " ") port)
(post-print cs port)))
(color-pair cs))))
(define (color-pair cs)
(let* ((obj (color-scheme-obj cs))
(d1 (car obj))
(d2 (cdr obj)))
(call-with-output-string
(lambda (port)
(pre-print cs port)
(colorize d1 port)
(space port) (print-dot port) (space port)
(colorize d2 port)
(post-print cs port)))))
(define (color-class cs)
(color-it cs))
(define (color-procedure cs)
(color-it cs))
(define (color-vector cs)
(let ((ll (vector->list (color-scheme-obj cs))))
(call-with-output-string
(lambda (port)
(pre-print cs port)
(display (string-join (map ->cstr ll) " ") port)
(post-print cs port)))))
(define (color-keyword cs)
(color-it cs))
;; TODO: maybe print it as char one by one?
(define (color-char-set cs)
(color-it cs))
(define (color-symbol cs)
(color-it cs))
(define (color-stack cs)
(color-it cs))
(define (color-record-type cs)
(color-it cs))
(define (color-inexact cs)
(color-it cs))
(define (color-exact cs)
(let* ((obj (color-scheme-obj cs))
(colors (color-scheme-color cs))
(num-color (car colors))
(div-color (cadr colors))
(control (color-scheme-control cs))
(n (object->string (numerator obj)))
(d (object->string (denominator obj))))
(call-with-output-string
(lambda (port)
(format port "~a~a~a"
(color-it-inner num-color n control)
(color-it-inner div-color "/" control)
(color-it-inner num-color d control))))))
(define (color-regexp cs)
(color-it cs))
(define (color-bitvector cs)
;; TODO: is it right?
(color-it cs))
(define (color-boolean cs)
(color-it cs))
(define (color-array cs)
(let ((ll (array->list (color-scheme-obj cs))))
(call-with-output-string
(lambda (port)
(pre-print cs port)
(display (string-join (map ->cstr ll) " ") port)
(post-print cs port)))))
(define (color-complex cs)
(color-it cs))
(define (color-hashtable cs)
(color-it cs))
(define (color-hook cs)
(color-it cs))
(define (color-unknown cs)
(color-it cs))
;;--- custom color scheme ---
(define *custom-colorized-list* (make-fluid '()))
(define (custom-colorized-set! ll)
(fluid-set! *custom-colorized-list* ll))
(define (current-custom-colorized)
(fluid-ref *custom-colorized-list*))
(define (add-color-scheme! cs-list)
(let ((ll (current-custom-colorized)))
(custom-colorized-set! `(,@cs-list ,@ll))))
;;--- custom color scheme end---
(define (is-inexact? obj)
(and (number? obj) (inexact? obj)))
(define (is-exact? obj)
(and (number? obj) (exact? obj)))
;; A class is a struct.
(define (class? obj)
(struct? obj))
(define *colorize-list*
`((,integer? INTEGER ,color-integer (BLUE BOLD))
(,char? CHAR ,color-char (YELLOW))
(,string? STRING ,color-string (RED))
(,list? LIST ,color-list (BLUE BOLD))
(,pair? PAIR ,color-list (BLACK BOLD)) ; NOTE: proper-list is a <pair>, and cons is <pair> too, so call color-list either.
(,class? CLASS ,color-class (CYAN BOLD))
(,procedure? PROCEDURE ,color-procedure (YELLOW BOLD))
(,vector? VECTOR ,color-vector (MAGENTA BOLD))
(,keyword? KEYWORD ,color-keyword (MAGENTA))
(,char-set? CHAR-SET ,color-char-set (WHITE))
(,symbol? SYMBOL ,color-symbol (GREEN BOLD))
(,stack? STACK ,color-stack (MAGENTA))
(,record-type? RECORD-TYPE ,color-record-type (BLACK BOLD))
;; We don't check REAL here, since it'll cover FLOAT and FRACTION, but user may customs it as they wish.
(,is-inexact? FLOAT ,color-inexact (YELLOW))
(,is-exact? FRACTION ,color-exact ((BLUE BOLD) (YELLOW)))
(,regexp? REGEXP ,color-regexp (GREEN))
(,bitvector? BITVECTOR ,color-bitvector (YELLOW BOLD))
(,array? ARRAY ,color-array ((CYAN BOLD) (YELLOW BOLD)))
(,boolean? BOOLEAN ,color-boolean (BLUE))
(,complex? COMPLEX ,color-complex (MAGENTA))
(,hash-table? HASH-TABLE ,color-hashtable (BLUE))
(,hook? HOOK ,color-hook (GREEN))))
;; TODO: if there's anything to add
(define (obj->token-color obj)
(let ((proc (lambda (x) (and ((car x) obj) (cdr x)))))
(or (any proc (current-custom-colorized)) ; checkout user defined obj type
(any proc *colorize-list*) ; checkout default obj type
`(UNKNOWN ,color-unknown (WHITE))))) ; no suitable obj type ,return the unknown solution
;; NOTE: we don't use control now, but I write the mechanism for future usage.
(define (generate-color-scheme obj)
(let* ((r (obj->token-color obj))
(type (car r))
(method (cadr r))
(color (caddr r)))
(make-color-scheme obj type color '(RESET) method)))
(define (generate-custom-string-color-scheme str color)
(make-color-scheme str #f color '(RESET) color-string))
(define (colorize-string str color)
"Example: (colorize-string \"hello\" '(BLUE BOLD))"
(and (not (list? color)) (error colorize-string "color should be a list!" color))
(colorize-the-string color str '(RESET)))
(define (colorized-display str color)
"Example: (colorized-display \"hello\" '(BLUE BOLD))"
(display (colorize-string str color)))
(define* (colorize-it obj #:optional (port (current-output-port)))
(colorize obj port)
(newline port))
(define* (colorize obj #:optional (port (current-output-port)))
(let* ((cs (generate-color-scheme obj))
(f (color-scheme-method cs)))
(display (f cs) port)))
(define (->cstr obj)
(call-with-output-string
(lambda (port)
(colorize obj port))))
