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