Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

file 291 lines (257 sloc) 9.653 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
;;; event.scm: Event definitions
;;;
;;; Copyright (c) 2004-2012 uim Project http://code.google.com/p/uim/
;;;
;;; All rights reserved.
;;;
;;; Redistribution and use in source and binary forms, with or without
;;; modification, are permitted provided that the following conditions
;;; are met:
;;; 1. Redistributions of source code must retain the above copyright
;;; notice, this list of conditions and the following disclaimer.
;;; 2. Redistributions in binary form must reproduce the above copyright
;;; notice, this list of conditions and the following disclaimer in the
;;; documentation and/or other materials provided with the distribution.
;;; 3. Neither the name of authors nor the names of its contributors
;;; may be used to endorse or promote products derived from this software
;;; without specific prior written permission.
;;;
;;; THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS'' AND
;;; ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
;;; IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
;;; ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE
;;; FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
;;; DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
;;; OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
;;; HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
;;; LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
;;; OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
;;; SUCH DAMAGE.
;;;;

;; These events will cooperate with the composer framework which will
;; be appeared as composer.scm to enable flexible input method
;; component organization such as nested composer (input method) based
;; on loose relationships. -- YamaKen 2005-02-18

(require-extension (sscm-ext))

(require "util.scm")
;;(require "utext.scm")
(require "ng-key.scm")

(define %HYPHEN-SYM (string->symbol "-"))

;;
;; event definitions
;;

(define valid-event-types ())

(define event-rec-spec
  '((type unknown)))

(define upward-event-rec-spec event-rec-spec)
(define-record 'upward-event upward-event-rec-spec)

(define downward-event-rec-spec
  (append
   event-rec-spec
  '(;;(context-id -1)
    (consumed #f)
    (loopback #f) ;; instructs re-injection into local composer
    (timestamp -1) ;; placeholder
    (ext-state #f))))
;; use 'event' instead of 'downward-event' as record name for convenient use
(define-record 'event downward-event-rec-spec)

;; Define an uim event
;;
;; define-event defines event-creator (foo-event-new) and accessors
;; (foo-event-bar, foo-event-set-bar!) as same as define-record does. The
;; difference is convenient definition and better performance of creator proc.
;;
;; Base part spec of event record and extended one are passed to define-event
;; as separated. Be careful about the difference from define-record.
;;
;; .parameter name Event name as symbol (e.g. 'key)
;; .parameter base-spec upward-event-rec-spec or downward-event-rec-spec
;; .parameter ext-spec Additional field definitions as same as record-spec for
;; define-record
;; TODO: write test
(define define-event
  (lambda (name base-spec . rest)
    (let-optionals* rest ((ext-spec ()))
      (let* ((base-spec (alist-replace (list 'type name) base-spec))
(base-defaults (map record-field-spec-default-value base-spec))
(ext-defaults (map record-field-spec-default-value ext-spec))
(creator (lambda args
(append base-defaults
args
(list-tail ext-defaults (length args))))))
(define-record (symbol-append name %HYPHEN-SYM 'event)
(append base-spec ext-spec))
(eval (list 'define (symbol-append name %HYPHEN-SYM 'event-new) creator)
(interaction-environment))
(set! valid-event-types (cons name valid-event-types))))))

(define event-external-state
  (lambda (ev state-id)
    (let ((state-reader (event-ext-state ev)))
      (and (procedure? state-reader)
(state-reader state-id)))))

(define-event 'timer
  downward-event-rec-spec)

(define-event 'reset
  downward-event-rec-spec)

(define-event 'focus-in
  downward-event-rec-spec)

(define-event 'focus-out
  downward-event-rec-spec)

(define-event 'client-info
  downward-event-rec-spec
  '((locale #f)
    (bridge "") ;; "gtk", "uim-xim", "macuim", "scim-uim", ...
    (application "") ;; acquire via bridge-dependent methods such as basename `echo $0`
    (expected ""))) ;; "direct", "number", "upper-alphabet", "ja-hiragana", ...

;; inserts a text into active IM context
;; For example, this can be used to insert a kanji word via clipboard
;; to register new dictionary entry
(define-event 'insert
  downward-event-rec-spec
  '((utext ()))) ;; can include cursor position info

(define-event 'commit
  upward-event-rec-spec
  '((utext ()) ;; can include cursor position info
    (preedit-updated #t) ;; can also update preedit as atomic event
    (former-del-len 0) ;; for surrounding text operation
    (latter-del-len 0))) ;; for surrounding text operation

(define-event 'preedit-updated
  upward-event-rec-spec)

(define-event 'action
  downward-event-rec-spec
  '((action-id #f))) ;; 'action_input_mode_direct

(define-event 'choosable-updated
  upward-event-rec-spec
  '((choosable-id #f) ;; 'chbl_candidates 'chbl_input_modes
    (sender #f))) ;; originator choosable object of this event

(define-event 'choosable-deactivated
  upward-event-rec-spec
  '((choosable-id #f) ;; 'chbl_candidates 'chbl_input_modes
    (sender #f))) ;; originator choosable object of this event

(define-event 'chooser
  downward-event-rec-spec
  '((widget-id #f) ;; 'chsr_floating_window0 'chsr_toolbar0
    (chosen -1) ;; negative value means that nothing is chosen
    (finish #t) ;; finish current choice transaction
    (scope-top -1)
    (scope-size -1)))

(define-event 'chooser-update-req
  downward-event-rec-spec
  '((widget-id #f) ;; 'chsr_floating_window0 'chsr_toolbar0
    (initialize #f)
    (items-top -1)
    (nr-items -1)))

(define-event 'chooser-update
  upward-event-rec-spec
  '((widget-id #f)
    (initialize #f) ;; invalidate all cached info about the chooser
    (transition #f) ;; 'activate 'deactivate 'update
    (chooser-size -1) ;; number of items including hidden ones
    (chosen -1) ;; item index currently chosen
    (scope-top -1) ;;
    (scope-size-hint -1) ;; number of items displayable at a time
    (title #f) ;; indication
    (status #f) ;; indication
    (updated-items-top -1)
    (updated-items ()))) ;; list of indications

;; #f means "don't care" for lkey, pkey, str, press and autorepeat
;; when comparing with other key-event. But modifiers require exact
;; match.
(define-event 'key
  downward-event-rec-spec
  (list
   ;;(list text #f) ;; replace raw string with utext in future
   (list 'str #f) ;; precomposed string
   (list 'lkey #f) ;; logical keysym
   (list 'pkey #f) ;; physical keysym
   (list 'modifier mod_None) ;; set of modifiers
   (list 'press #t) ;; indicates press/release
   (list 'autorepeat #f))) ;; whether generated by autorepeat or not

(define key-release-event-new
  (lambda args
    (let ((ev (apply key-event-new args)))
      (key-event-set-press! ev #f)
      ev)))

;; TODO: make encoding sensitive
(define key-event-char
  (lambda (ev)
    (let ((str (key-event-str ev)))
      (and (string? str)
(string->char str)))))

(define key-event-extract-press-str
  (lambda (ev)
    (and (key-event-press ev)
(key-event-str ev))))

(define key-event-char-upcase!
  (lambda (ev)
    (let ((str ((compose charcode->string
char-upcase
key-event-char)
ev)))
      (key-event-set-str! ev str))))

(define key-event-char-downcase!
  (lambda (ev)
    (let ((str ((compose charcode->string
char-downcase
key-event-char)
ev)))
      (key-event-set-str! ev str))))

;; TODO: write test
(define key-event-covers?
  (lambda (self other)
    (and (every (lambda (getter)
(let ((self-val (getter self))
(other-val (getter other)))
(and self-val ;; #f means "don't care"
(equal? self-val other-val))))
(list key-event-lkey
key-event-pkey
key-event-str))
(modifier-match? (key-event-modifier self)
(key-event-modifier other))
;; exact matches
(every (lambda (getter)
(equal? (getter self)
(getter other)))
(list key-event-press
key-event-autorepeat)))))

;; TODO: write test
(define key-event-inspect
  (lambda (ev)
    (string-append
     (if (key-event-str ev)
(string-append "\"" (key-event-str ev) "\"")
"-")
     " "
     (symbol->string (or (key-event-lkey ev)
%HYPHEN-SYM))
     " "
     (symbol->string (or (key-event-pkey ev)
%HYPHEN-SYM))
     " ("
     (string-join
      " "
      (filter-map (lambda (mod-sym)
(and (not (= (bitwise-and (symbol-value mod-sym)
(key-event-modifier ev))
0))
(symbol->string mod-sym)))
valid-modifiers))
     ") "
     (if (key-event-press ev)
"press"
"release")
     " "
     (if (key-event-autorepeat ev)
"autorepeat"
"nonrepeat")
     " "
     (if (event-consumed ev)
"consumed"
"not-consumed")
     "\n")))

(define key-event-print-inspected
  (lambda (msg ev)
    (if inspect-key-event-translation?
(display (string-append msg
(key-event-inspect ev))))))
Something went wrong with that request. Please try again.