scm/framework-gnome.scm

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