scm/framework-gnome.scm

   1 ;;;; framework-gnome.scm --
   2 ;;;;
   3 ;;;;  source file of the GNU LilyPond music typesetter
   4 ;;;;
   5 ;;;; (c)  2004 Jan Nieuwenhuizen <janneke@gnu.org>
   6
   7 ;;;; See output-gnome.scm for usage information.
   8
   9
  10 (define-module (scm framework-gnome))
  11
  12 (use-modules (guile) (oop goops) (lily))
  13
  14 (use-modules
  15  (srfi srfi-2)
  16  (ice-9 regex)
  17  (gnome gtk)
  18  (gnome gtk gdk-event)
  19  (gnome gw canvas))
  20
  21 (define-public (output-framework outputter book scopes fields basename)
  22   (gnome-main book basename))
  23
  24 (define SCROLLBAR-SIZE 20)
  25 (define BUTTON-HEIGHT 25)
  26 (define PANELS-HEIGHT 80)
  27
  28 (define PIXELS-PER-UNIT 2)
  29 (define OUTPUT-SCALE (* 2.5 PIXELS-PER-UNIT))
  30 (define-public output-scale OUTPUT-SCALE)
  31
  32 (define (stderr string . rest)
  33   (apply format (cons (current-error-port) (cons string rest)))
  34   (force-output (current-error-port)))
  35
  36 (define (debugf string . rest)
  37   (if #f
  38       (stderr (cons string rest))))
  39
  40 (define-class <gnome-outputter> ()
  41   (name #:init-value "untitled" #:init-keyword #:name #:accessor name)
  42   (page-stencils ;;#:init-value '#()
  43    #:init-keyword #:page-stencils #:accessor page-stencils)
  44   (window #:init-value (make <gtk-window> #:type 'toplevel) #:accessor window)
  45   (scrolled #:init-value (make <gtk-scrolled-window>) #:accessor scrolled)
  46   (canvas #:init-value #f #:accessor canvas)
  47   (page-number #:init-value 0 #:accessor page-number)
  48   (pixels-per-unit #:init-value PIXELS-PER-UNIT #:accessor pixels-per-unit)
  49   (text-items #:init-value '() #:accessor text-items)
  50   (grob #:init-value #f #:accessor grob)
  51   (item-grobs #:init-value (make-hash-table 31) #:accessor item-grobs)
  52   (grob-tweaks #:init-value (make-hash-table 31) #:accessor grob-tweaks)
  53   (window-width #:init-keyword #:window-width #:accessor window-width)
  54   (window-height #:init-keyword #:window-height #:accessor window-height)
  55   (canvas-width #:init-keyword #:canvas-width #:accessor canvas-width)
  56   (canvas-height #:init-keyword #:canvas-height #:accessor canvas-height))
  57
  58 (define-method (initialize (go <gnome-outputter>))
  59   (let* ((button (make <gtk-button> #:label "Exit"))
  60          (next (make <gtk-button> #:label "Next"))
  61          (prev (make <gtk-button> #:label "Previous"))
  62          (vbox (make <gtk-vbox> #:homogeneous #f))
  63          (hbox (make <gtk-hbox> #:homogeneous #f)))
  64
  65     (set-size-request (window go) (window-width go) (window-height go))
  66
  67     (set-size-request (scrolled go) (window-width go) (- (window-height go)
  68                                                          BUTTON-HEIGHT
  69                                                          SCROLLBAR-SIZE))
  70
  71     (new-canvas go)
  72
  73     (add (window go) vbox)
  74     (add vbox (scrolled go))
  75
  76     (add (scrolled go) (canvas go))
  77
  78     ;; buttons
  79     (add vbox hbox)
  80     (set-size-request hbox (window-width go) BUTTON-HEIGHT)
  81
  82     ;; hmm?  These are broken when using <gnome-outputter>.
  83     ;;(set-child-packing vbox hbox #f #f 0 'end)
  84     ;;(set-child-packing hbox button #f #f 0 'end)
  85
  86     (set-size-request button (quotient (window-width go) 2) BUTTON-HEIGHT)
  87
  88
  89     (add hbox next)
  90     (add hbox prev)
  91     (add hbox button)
  92
  93     ;; signals
  94     (connect button 'clicked (lambda (b) (save-tweaks go) (gtk-main-quit)))
  95     (connect next 'clicked (lambda (b) (dump-page go (1+ (page-number go)))))
  96     (connect prev 'clicked (lambda (b) (dump-page go (1- (page-number go)))))
  97     (connect (window go) 'key-press-event
  98              (lambda (w e) (key-press-event go w e)))
  99
 100     (show-all (window go))))
 101
 102
 103 (define (gnome-main book name)
 104   (let* ((paper (ly:paper-book-paper book))
 105          (hsize (ly:output-def-lookup paper 'hsize))
 106          (vsize (ly:output-def-lookup paper 'vsize))
 107          (page-width (inexact->exact (ceiling (* OUTPUT-SCALE hsize))))
 108          (page-height (inexact->exact (ceiling (* OUTPUT-SCALE vsize))))
 109          ;;(page-width (inexact->exact (ceiling hsize)))
 110          ;;(page-height (inexact->exact (ceiling vsize)))
 111
 112          (screen-width (gdk-screen-width))
 113          (screen-height (gdk-screen-height))
 114          (desktop-height (- screen-height PANELS-HEIGHT))
 115
 116          (go (make <gnome-outputter>
 117                #:name name
 118                #:page-stencils (list->vector (ly:paper-book-pages book))
 119                #:canvas-width page-width
 120                #:canvas-height page-height
 121                #:window-width
 122                ;; huh, *2 -- pixels-per-unit?
 123                (min (+ SCROLLBAR-SIZE (* page-width 2)) screen-width)
 124                #:window-height
 125                (min (+ BUTTON-HEIGHT SCROLLBAR-SIZE (* page-height 2))
 126                     desktop-height))))
 127
 128     ;; ugh.  The GOOPS doc promises this is called automagically.
 129     ;; possibly a goops 1.6.4 problem
 130     (initialize go)
 131
 132     (map ly:pango-add-afm-decoder
 133          '("lilypond-feta"
 134            "lilypond-braces"
 135            "lilypond-dyn"
 136            "lilypond-parmesan"))
 137
 138     (dump-page go 0)
 139
 140     (gtk-main)))
 141
 142 (define (dump-page go number)
 143   (if (or (not (page-stencils go))
 144           (< number 0)
 145           (>= number (vector-length (page-stencils go))))
 146       (stderr "No such page: ~S\n" (1+ number))
 147
 148       (let ((old-canvas (canvas go)))
 149         (new-canvas go)
 150         (set! (page-number go) number)
 151
 152         ;; no destroy method for gnome-canvas-text yet.
 153         ;;(map destroy (gtk-container-get-children main-canvas))
 154         ;;(map destroy text-items)
 155
 156         (set! (text-items go) '())
 157         (debugf "page-stencil ~S: ~S\n"
 158                 (page-number go)
 159                 (vector-ref (page-stencils go) (page-number go)))
 160
 161         (ly:interpret-stencil-expression
 162          ;; ;;(vector-ref (page-stencils go) (page-number go))
 163          (ly:stencil-expr (vector-ref (page-stencils go) (page-number go)))
 164          gnome-output-expression go '(0 . 0))
 165
 166         (if old-canvas (destroy old-canvas))
 167         (add (scrolled go) (canvas go))
 168         (show (canvas go)))))
 169
 170 (define x-editor #f)
 171 (define (get-x-editor)
 172   (if (not x-editor)
 173       (set! x-editor (getenv "XEDITOR")))
 174   x-editor)
 175
 176 (define ifs #f)
 177 (define (get-ifs)
 178   (if (not ifs)
 179       (set! ifs (getenv "IFS")))
 180   (if (not ifs)
 181       (set! ifs "       "))
 182   ifs)
 183
 184 (define (spawn-editor location)
 185   (let* ((file-name (car location))
 186          (line (cadr location))
 187          (column (caddr location))
 188          (template (substring (get-x-editor) 0))
 189
 190          ;; Adhere to %l %c %f?
 191          (command
 192           (regexp-substitute/global
 193            #f "%l" (regexp-substitute/global
 194                     #f "%c"
 195                     (regexp-substitute/global
 196                      #f "%f" template 'pre file-name 'post)
 197                     'pre (number->string column)
 198                     'post)
 199            'pre (number->string line) 'post)))
 200
 201     (debugf "spawning: ~s\n" command)
 202     (if (= (primitive-fork) 0)
 203         (let ((command-list (string-split command #\ )));; (get-ifs))))
 204           (apply execlp command-list)
 205           (primitive-exit)))))
 206
 207 (define location-callback spawn-editor)
 208
 209 (define (get-location grob)
 210   (and-let* ((p? (procedure? point-and-click))
 211              (g grob)
 212              (cause (ly:grob-property grob 'cause))
 213              (music-origin (if (ly:music? cause)
 214                                (ly:music-property cause 'origin)
 215                                ;; How come #<unspecied> [and '()]
 216                                ;; are #t? :-(
 217                                #f)))
 218             (if (ly:input-location? music-origin)
 219                 (ly:input-location music-origin)
 220                 #f)))
 221
 222 (define-method (tweak (go <gnome-outputter>) item offset)
 223   (let* ((grob (hashq-ref (item-grobs go) item #f))
 224          (origin (hashq-ref (grob-tweaks go) grob '(0 . 0))))
 225     (if grob
 226         (hashq-set! (grob-tweaks go) grob (cons (+ (car origin) (car offset))
 227                                                 (+ (cdr origin) (cdr offset)))))
 228     (move item (car offset) (cdr offset))))
 229
 230 (define-method (save-tweaks (go <gnome-outputter>))
 231   (let ;;((file (current-error-port)))
 232       ((file (open-file (string-append (name go) ".twy") "w")))
 233     (format file "%% TWEAKS %%\n")
 234     (hash-fold
 235      (lambda (key value seed)
 236        (format file "~S:~S\n"
 237                (if (ly:grob? key) (ly:grob-id key) "unidentified grob") value))
 238      #f (grob-tweaks go))))
 239
 240 ;;;(define (item-event go grob item event)
 241 (define (item-event go item event)
 242   (case (gdk-event:type event)
 243     ((enter-notify) (gobject-set-property item 'fill-color "red"))
 244     ((leave-notify) (gobject-set-property item 'fill-color "black"))
 245     ((button-press)
 246      (let ((button (gdk-event-button:button event)))
 247        (cond
 248         ((= button 1)
 249          (and-let* ((grob (hashq-ref (item-grobs go) item #f))
 250                     (location (get-location grob)))
 251                    (location-callback location)))
 252         ((= button 2)
 253
 254          (and-let*
 255           ((grob (hashq-ref (item-grobs go) item #f)))
 256
 257           (let ((properties (ly:grob-properties grob))
 258                 (basic-properties (ly:grob-basic-properties grob))
 259                 (id (ly:grob-id grob))
 260                 (x (inexact->exact (gdk-event-button:x-root event)))
 261                 (y (inexact->exact (gdk-event-button:y-root event))))
 262
 263             (debugf "GROB: ~S\n" grob)
 264             (debugf "PROPERTIES: ~S\n" properties)
 265             (debugf "BASIC PROPERTIES: ~S\n" basic-properties)
 266
 267             (let ((window (make <gtk-window>))
 268                   (vbox (make <gtk-vbox>))
 269                   (button (make <gtk-button> #:label "Ok")))
 270
 271               (add window vbox)
 272               (connect button 'clicked (lambda (b) (destroy window)))
 273
 274               (for-each
 275                (lambda (x)
 276                  (let ((button (make <gtk-button>
 277                                  #:xalign 0.0
 278                                  #:label
 279                                  (string-append
 280                                   (symbol->string (car x))
 281                                   ": "
 282                                   (format #f "~S" (cdr x))))))
 283                    (set-size-request button 150 BUTTON-HEIGHT)
 284                    (add vbox button)))
 285                (cons (list id) properties))
 286               (add vbox button)
 287
 288               ;; FIXME: how to do window placement?
 289               ;; - no effect:
 290               (move window x y)
 291               (show-all window)
 292               ;; - shows actual movement:
 293               (move window x y)
 294               )))))))
 295
 296     ((2button-press) (gobject-set-property item 'fill-color "green"))
 297     ((key-press)
 298      (let ((keyval (gdk-event-key:keyval event))
 299            (mods (gdk-event-key:modifiers event))
 300            (step (quotient (pixels-per-unit go) 2)))
 301        (cond ((and (null? mods)
 302                    (eq? keyval gdk:Up))
 303               (tweak go item (cons 0 (- 0 step))))
 304              ((and (null? mods)
 305                    (eq? keyval gdk:Down))
 306               (tweak go item (cons 0 step)))
 307              ((and (null? mods)
 308                    (eq? keyval gdk:Left))
 309               (tweak go item (cons (- 0 step) 0)))
 310              ((and (null? mods)
 311                    (eq? keyval gdk:Right))
 312               (tweak go item (cons step 0)))))))
 313   #t)
 314
 315 (define (scale-canvas go factor)
 316   (set! (pixels-per-unit go) (* (pixels-per-unit go) factor))
 317   (set-pixels-per-unit (canvas go) (pixels-per-unit go))
 318   (for-each
 319    (lambda (x)
 320      (let ((scale (gobject-get-property x 'scale))
 321            (points (gobject-get-property x 'size-points)))
 322        ;;(gobject-set-property x 'scale pixels-per-unit)
 323        (gobject-set-property x 'size-points (* points factor))))
 324      (text-items go)))
 325
 326 (define (key-press-event go item event)
 327   (let ((keyval (gdk-event-key:keyval event))
 328         (mods (gdk-event-key:modifiers event)))
 329     (cond ((and (or (eq? keyval gdk:q)
 330                     (eq? keyval gdk:w))
 331                 (equal? mods '(control-mask modifier-mask)))
 332            (gtk-main-quit))
 333           ((and #t ;;(null? mods)
 334                 (eq? keyval gdk:plus))
 335            (scale-canvas go 2))
 336           ((and #t ;; (null? mods)
 337                 (eq? keyval gdk:minus))
 338            (scale-canvas go 0.5))
 339           ((or (eq? keyval gdk:Page-Up)
 340                (eq? keyval gdk:BackSpace))
 341            (dump-page go (1- (page-number go))))
 342           ((or (eq? keyval gdk:Page-Down)
 343                (eq? keyval gdk:space))
 344            (dump-page go (1+ (page-number go)))))
 345     #f))
 346
 347 (define (new-canvas go)
 348   (set! (canvas go) (make <gnome-canvas>))
 349   (set-size-request (canvas go) (window-width go) (window-height go))
 350   (set-scroll-region (canvas go) 0 0 (canvas-width go) (canvas-height go))
 351   (set-pixels-per-unit (canvas go) (pixels-per-unit go))
 352   (make <gnome-canvas-rect>
 353     #:parent (root (canvas go))
 354     #:x2 (canvas-width go) #:y2 (canvas-height go)
 355     #:fill-color "white"))
 356
 357 (define output-gnome-module #f)
 358 (define (get-output-gnome-module go)
 359   (if (not output-gnome-module)
 360       (let ((m  (resolve-module '(scm output-gnome))))
 361         (module-define! m 'canvas-root (lambda () (root (canvas go))))
 362         (module-define! m 'output-scale output-scale)
 363         (set! output-gnome-module m)))
 364   output-gnome-module)
 365
 366 (define-public (gnome-output-expression go expr)
 367   (let* ((m (get-output-gnome-module go))
 368          (result (eval expr m)))
 369     (cond
 370      ((ly:grob? result) (set! (grob go) result))
 371      ((is-a? result <gnome-canvas-item>)
 372
 373       ;; AAARGH; grobs happen after stencils
 374       ;; (connect result 'event (lambda (w e) (item-event go (grob go) w e)))
 375       (connect result 'event (lambda (w e) (item-event go w e)))
 376       (if (grob go)
 377           (hashq-set! (item-grobs go) result (grob go)))
 378       (set! (grob go) #f)
 379
 380       (if (is-a? result <gnome-canvas-text>)
 381           (set! (text-items go) (cons result (text-items go))))))))
 382