├── .gitignore ├── LICENSE ├── README.md ├── dev ├── phalanges │ └── dev.cljs └── user.clj ├── project.clj └── src └── phalanges ├── core.clj └── core.cljs /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor tocontrol, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of Washington and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Phalanges 2 | 3 | Phalanges is a small ClojureScript library providing utilities for 4 | working with JavaScript `KeyboardEvent`s. 5 | 6 | ## Usage 7 | 8 | Add Phalanges as to your `:dependencies` in your `project.clj` file. 9 | 10 | ```clj 11 | [spellhouse/phalanges "0.1.6"] 12 | ``` 13 | 14 | For the current `SNAPSHOT` use 15 | 16 | ```clj 17 | [spellhouse/phalanges "0.1.7-SNAPSHOT"] 18 | ``` 19 | 20 | ## License 21 | 22 | Copyright © 2014 Christopher Joel Holdbrooks 23 | 24 | Distributed under the Eclipse Public License either version 1.0 or (at 25 | your option) any later version. 26 | -------------------------------------------------------------------------------- /dev/phalanges/dev.cljs: -------------------------------------------------------------------------------- 1 | (ns phalanges.dev 2 | (:require 3 | [figwheel.client :as fw :include-macros true] 4 | [weasel.repl :as ws-repl] 5 | [phalanges.core :as keyboard])) 6 | 7 | (defonce ws-repl-connection 8 | (ws-repl/connect "ws://localhost:9001" :verbose true)) 9 | 10 | (fw/watch-and-reload 11 | ;; :websocket-url "ws:localhost:3449/figwheel-ws" default 12 | :jsload-callback 13 | (fn [] (js/console.log (str (gensym "RELOAD"))))) 14 | -------------------------------------------------------------------------------- /dev/user.clj: -------------------------------------------------------------------------------- 1 | (ns user 2 | (:require 3 | [weasel.repl.websocket] 4 | [cemerick.piggieback])) 5 | 6 | (defn ws-repl [] 7 | (cemerick.piggieback/cljs-repl 8 | :repl-env (weasel.repl.websocket/repl-env 9 | :ip "0.0.0.0" :port 9001))) 10 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject spellhouse/phalanges "0.1.7-SNAPSHOT" 2 | :description "ClojureScript library providing utilities for working with JavaScript KeyboardEvents." 3 | :url "https://github.com/spellhouse/phalanges" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | 7 | :dependencies 8 | [[org.clojure/clojure "1.5.1"]] 9 | 10 | :profiles 11 | {:dev {:source-paths ["src" "dev"] 12 | :dependencies [[weasel "0.2.0"] 13 | [com.cemerick/piggieback "0.1.3"] 14 | [figwheel "0.1.3-SNAPSHOT"] 15 | [org.clojure/clojurescript "0.0-2227" :scope "provided"]] 16 | :plugins [[com.cemerick/austin "0.1.3"] 17 | [lein-figwheel "0.1.3-SNAPSHOT"] 18 | [lein-cljsbuild "1.0.3"]] 19 | :repl-options {:nrepl-middleware [cemerick.piggieback/wrap-cljs-repl]}} 20 | :build {:source-paths ["src"]}} 21 | 22 | :cljsbuild 23 | {:builds [{:id "dev" 24 | :source-paths ["src" "dev/phalanges"] 25 | :compiler {:output-to "resources/public/js/phalanges.js" 26 | :output-dir "resources/public/js/out" 27 | :source-map "resources/public/js/phalanges.js.map" 28 | :optimizations :none}}]}) 29 | -------------------------------------------------------------------------------- /src/phalanges/core.clj: -------------------------------------------------------------------------------- 1 | (ns phalanges.core 2 | (:require 3 | [clojure.string :as string])) 4 | 5 | (def key-data 6 | '[{:default a :shift A} 7 | {:default b :shift B} 8 | {:default backslash :shift pipe} 9 | {:default backspace} 10 | {:default c :shift C} 11 | {:default caps-lock} 12 | {:default close-square-bracket :shift close-curley-bracket} 13 | {:default comma :shift open-angle-bracket} 14 | {:default d :shift D} 15 | {:default dash :shift underscore} 16 | {:default delete} 17 | {:default down} 18 | {:default e :shift E} 19 | {:default eight :shift asterix} 20 | {:default end} 21 | {:default enter} 22 | {:default equals :shift plus} 23 | {:default esc} 24 | {:default f :shift F} 25 | {:default f1} 26 | {:default f10} 27 | {:default f11} 28 | {:default f12} 29 | {:default f2} 30 | {:default f3} 31 | {:default f4} 32 | {:default f5} 33 | {:default f6} 34 | {:default f7} 35 | {:default f8} 36 | {:default f9} 37 | {:default ff-dash} 38 | {:default ff-equals} 39 | {:default ff-semicolon} 40 | {:default first-media-key} 41 | {:default five :shift percent} 42 | {:default four :shift dollar} 43 | {:default g :shift G} 44 | {:default h :shift H} 45 | {:default home} 46 | {:default i :shift I} 47 | {:default insert} 48 | {:default j :shift J} 49 | {:default k :shift K} 50 | {:default l :shift L} 51 | {:default last-media-key} 52 | {:default left} 53 | {:default m :shift M} 54 | {:default mac-enter} 55 | {:default mac-ff-meta} 56 | {:default mac-wk-cmd-left} 57 | {:default mac-wk-cmd-right} 58 | {:default n :shift N} 59 | {:default nine :shift open-round-bracket} 60 | {:default num-center} 61 | {:default num-division} 62 | {:default num-eight} 63 | {:default num-five} 64 | {:default num-four} 65 | {:default num-minus} 66 | {:default num-multiply} 67 | {:default num-nine} 68 | {:default num-one} 69 | {:default num-period} 70 | {:default num-plus} 71 | {:default num-seven} 72 | {:default num-six} 73 | {:default num-three} 74 | {:default num-two} 75 | {:default num-zero} 76 | {:default numlock} 77 | {:default o :shift O} 78 | {:default one :shift exclamation-mark} 79 | {:default open-square-bracket :shift open-curley-bracket} 80 | {:default p :shift P} 81 | {:default page-down} 82 | {:default page-up} 83 | {:default pause} 84 | {:default period :shift close-angle-bracket} 85 | {:default phantom} 86 | {:default print-screen} 87 | {:default q :shift Q} 88 | {:default question-mark :shift forward-slash} 89 | {:default r :shift R} 90 | {:default right} 91 | {:default s :shift S} 92 | {:default scroll-lock} 93 | {:default semicolon :shift colon} 94 | {:default seven :shift ampersand} 95 | {:default single-quote :shift double-quote} 96 | {:default six :shift caret} 97 | {:default slash :shift pipe} 98 | {:default space} 99 | {:default t :shift T} 100 | {:default tab} 101 | {:default three :shift sharp} 102 | {:default tilde :shift backtick} 103 | {:default two :shift at-sign} 104 | {:default u :shift U} 105 | {:default up} 106 | {:default v :shift V} 107 | {:default w :shift W} 108 | {:default win-ime} 109 | {:default win-key-ff-linux} 110 | {:default win-key-right} 111 | {:default x :shift X} 112 | {:default y :shift Y} 113 | {:default z :shift Z} 114 | {:default zero :shift close-round-bracket}]) 115 | 116 | (defn goog-key-code-lookup [s] 117 | (let [okey (-> (name s) 118 | (string/upper-case) 119 | (string/replace #"-" "_"))] 120 | `(aget goog.events.KeyCodes ~okey))) 121 | 122 | (defn do-key-code-check-defn 123 | [{:keys [default]}] 124 | (let [sym (symbol (str default "-key?"))] 125 | `(defn ~sym [e#] 126 | (= (phalanges.core/key-code e#) 127 | ~(goog-key-code-lookup default))))) 128 | 129 | (defn do-key-code-with-shift-check-defn 130 | [{:keys [default shift]}] 131 | (when shift 132 | (let [sym (symbol (str shift "-key?"))] 133 | `(defn ~sym [e#] 134 | (and (= (phalanges.core/key-code e#) 135 | ~(goog-key-code-lookup default)) 136 | (phalanges.core/shift-key? e#)))))) 137 | 138 | (defn do-defns [key-data] 139 | (let [f (juxt do-key-code-check-defn 140 | do-key-code-with-shift-check-defn)] 141 | (remove nil? (f key-data)))) 142 | 143 | (defmacro define-key-code-predicates [] 144 | `(do ~@(mapcat do-defns key-data))) 145 | -------------------------------------------------------------------------------- /src/phalanges/core.cljs: -------------------------------------------------------------------------------- 1 | (ns phalanges.core 2 | "js/KeyboardEvent utilities." 3 | (:require 4 | [clojure.string :as string] 5 | [clojure.set :as set] 6 | [goog.object] 7 | [goog.events :as events]) 8 | (:require-macros 9 | [phalanges.core :refer [define-key-code-predicates]]) 10 | (:import goog.events.KeyCodes)) 11 | 12 | ;; --------------------------------------------------------------------- 13 | ;; Utilities 14 | 15 | (defn prune 16 | "Dissociates entries in a nested associative structure when, 17 | for each value of a key in the ks path, (pred val) is true. 18 | Applies the test/dissociation from the bottom-up." 19 | [m [k & ks] pred] 20 | (if (contains? m k) 21 | (if ks 22 | (let [v (prune (get m k) ks pred)] 23 | (if (pred v) 24 | (dissoc m k) 25 | (assoc m k v))) 26 | (if (pred (get m k)) 27 | (dissoc m k) 28 | m)) 29 | m)) 30 | 31 | ;; --------------------------------------------------------------------- 32 | ;; Keyword/Keycode conversion 33 | 34 | ;; Produced with following code: 35 | ;; (reduce 36 | ;; (fn [m k] 37 | ;; (let [v (aget goog.events.KeyCodes k) 38 | ;; k (-> (string/lower-case k) 39 | ;; (string/replace #"_" "-") 40 | ;; (keyword))] 41 | ;; (if-not (fn? v) 42 | ;; (assoc m k v) 43 | ;; m))) 44 | ;; {} 45 | ;; (array-seq (goog.object/getKeys goog.events.KeyCodes))) 46 | 47 | (def 48 | ^{:doc "ClojureScript friendly version of goog.events.KeyCodes."} 49 | keyword->keycode 50 | {:a 65 51 | :alt 18 52 | :apostrophe 192 53 | :b 66 54 | :backslash 220 55 | :backspace 8 56 | :c 67 57 | :caps-lock 20 58 | :close-square-bracket 221 59 | :comma 188 60 | :context-menu 93 61 | :ctrl 17 62 | :d 68 63 | :dash 189 64 | :delete 46 65 | :down 40 66 | :e 69 67 | :eight 56 68 | :end 35 69 | :enter 13 70 | :equals 187 71 | :esc 27 72 | :f 70 73 | :f1 112 74 | :f10 121 75 | :f11 122 76 | :f12 123 77 | :f2 113 78 | :f3 114 79 | :f4 115 80 | :f5 116 81 | :f6 117 82 | :f7 118 83 | :f8 119 84 | :f9 120 85 | :ff-dash 173 86 | :ff-equals 61 87 | :ff-semicolon 59 88 | :first-media-key 166 89 | :five 53 90 | :four 52 91 | :g 71 92 | :h 72 93 | :home 36 94 | :i 73 95 | :insert 45 96 | :j 74 97 | :k 75 98 | :l 76 99 | :last-media-key 183 100 | :left 37 101 | :m 77 102 | :mac-enter 3 103 | :mac-ff-meta 224 104 | :mac-wk-cmd-left 91 105 | :mac-wk-cmd-right 93 106 | :meta 91 107 | :n 78 108 | :nine 57 109 | :num-center 12 110 | :num-division 111 111 | :num-eight 104 112 | :num-five 101 113 | :num-four 100 114 | :num-minus 109 115 | :num-multiply 106 116 | :num-nine 105 117 | :num-one 97 118 | :num-period 110 119 | :num-plus 107 120 | :num-seven 103 121 | :num-six 102 122 | :num-three 99 123 | :num-two 98 124 | :num-zero 96 125 | :numlock 144 126 | :o 79 127 | :one 49 128 | :open-square-bracket 219 129 | :p 80 130 | :page-down 34 131 | :page-up 33 132 | :pause 19 133 | :period 190 134 | :phantom 255 135 | :print-screen 44 136 | :q 81 137 | :question-mark 63 138 | :r 82 139 | :right 39 140 | :s 83 141 | :scroll-lock 145 142 | :semicolon 186 143 | :seven 55 144 | :shift 16 145 | :single-quote 222 146 | :six 54 147 | :slash 191 148 | :space 32 149 | :t 84 150 | :tab 9 151 | :three 51 152 | :tilde 192 153 | :two 50 154 | :u 85 155 | :up 38 156 | :v 86 157 | :w 87 158 | :win-ime 229 159 | :win-key 224 160 | :win-key-ff-linux 0 161 | :win-key-right 92 162 | :x 88 163 | :y 89 164 | :z 90 165 | :zero 48}) 166 | 167 | (def 168 | ^{:doc "Inversion of keyword->keycode."} 169 | keycode->keyword 170 | (set/map-invert keyword->keycode)) 171 | 172 | ;; --------------------------------------------------------------------- 173 | ;; KeyboardEvent wrappers 174 | 175 | (defn key-code 176 | "Return the keyCode property of a js/KeyboardEvent." 177 | [e] 178 | (.-keyCode e)) 179 | 180 | (defn key-up? 181 | "True if e is keyup event, false otherwise." 182 | [e] 183 | (= (.-type e) "keyup")) 184 | 185 | (defn key-down? 186 | "True if e is keydown event, false otherwise." 187 | [e] 188 | (= (.-type e) "keydown")) 189 | 190 | (defn key-press? 191 | "True if e is keypress event, false otherwise." 192 | [e] 193 | (= (.-type e) "keypress")) 194 | 195 | (defn repeating? 196 | "Return the repeat property of js/KeyboardEvent. True if the key is 197 | being held down, false otherwise." 198 | [e] 199 | (boolean (.-repeat e))) 200 | 201 | (defn control-key? 202 | "Return the ctrlKey property of a js/KeyboardEvent. True if the 203 | control key is being held, false otherwise." 204 | [e] 205 | (boolean (.-ctrlKey e))) 206 | 207 | (defn shift-key? 208 | "Return the shiftKey property of a js/KeyboardEvent. True if the 209 | shift key is being held, false otherwise." 210 | [e] 211 | (boolean (.-shiftKey e))) 212 | 213 | (defn alt-key? 214 | "Return the altKey property of a js/KeyboardEvent. True if the 215 | alt key is being held, false otherwise." 216 | [e] 217 | (boolean (.-altKey e))) 218 | 219 | (defn meta-key? 220 | "Return the metaKey property of a js/KeyboardEvent. True if the 221 | meta key is being held, false otherwise." 222 | [e] 223 | (boolean (.-metaKey e))) 224 | 225 | (define-key-code-predicates) 226 | 227 | ;; --------------------------------------------------------------------- 228 | ;; KeyCodes wrappers 229 | 230 | (def 231 | ^{:arglists '([e]) 232 | :doc "Returns true if the event contains a text modifying key."} 233 | text-modifying-key? 234 | KeyCodes.isTextModifyingKeyEvent) 235 | 236 | (def 237 | ^{:arglists '([key-code & [held-key-code shift-key? control-key? alt-key?]]) 238 | :doc "Returns true if the key fires a keypress event in the current 239 | browser."} 240 | fires-key-press? 241 | KeyCodes.firesKeyPressEvent) 242 | 243 | (def 244 | ^{:arglists '([key-code]) 245 | :doc "Returns true if the key produces a character. 246 | This does not cover characters on non-US keyboards (Russian, Hebrew, etc.)."} 247 | character-key? 248 | KeyCodes.isCharacterKey) 249 | 250 | ;; --------------------------------------------------------------------- 251 | ;; Keyset 252 | 253 | (defn modifier-set 254 | "Given a js/KeyboardEvent return a set of keywords corresponding to the 255 | modifier keys involved. 256 | 257 | 258 | Ex. 259 | (modifier-set e) 260 | ;; => #{:control :shift} 261 | " 262 | [e] 263 | (let [mods {:ctrl (control-key? e) 264 | :shift (shift-key? e) 265 | :alt (alt-key? e) 266 | :meta (meta-key? e)}] 267 | (set (keys (filter val mods))))) 268 | 269 | (defn key-set 270 | "Given a js/KeyboardEvent return a set of keywords corresponding to the 271 | keys pressed. Includes modifiers. 272 | 273 | Ex. 274 | (key-set e) 275 | ;; => #{:shift :a} 276 | " 277 | [e] 278 | (conj (modifier-set e) (keycode->keyword (key-code e)))) 279 | 280 | (defn key-char 281 | "Given a js/KeyboardEvent return the keyCode property converted to a 282 | string." 283 | [e] 284 | (char (key-code e))) 285 | 286 | 287 | ;; --------------------------------------------------------------------- 288 | ;; Key sequence listener 289 | 290 | (defn- get-register! [el] 291 | (or (aget el "__phalanges_register") 292 | (let [new-register (atom [])] 293 | (aset el "__phalanges_register" new-register) 294 | new-register))) 295 | 296 | (defn- get-fn-store! [el] 297 | (or (aget el "__phalanges_fn_store") 298 | (let [new-fn-store (atom {})] 299 | (aset el "__phalanges_fn_store" new-fn-store) 300 | new-fn-store))) 301 | 302 | (defn- get-sequence-listener! [el] 303 | (or (aget el "__phalanges_sequence_listener") 304 | (let [register (get-register! el) 305 | fn-store (get-fn-store! el) 306 | listener (fn [e] 307 | (let [ks (key-set e)] 308 | (swap! register conj ks) 309 | (let [x (get-in @fn-store @register)] 310 | (if (nil? x) 311 | (reset! register [key-set]) 312 | (when (fn? x) 313 | (x @register) 314 | (swap! register empty))))))] 315 | (aset el "__phalanges_sequence_listener" listener) 316 | listener))) 317 | 318 | (defn listen-sequence! 319 | "Listen for keydown events such that whenever a sub-sequence of 320 | mapping key-set over those events matches key-sets f is called 321 | with the matched sub-sequence. 322 | 323 | Ex. 324 | ;; Typing \"a b c\" into #test-input will show \"a b c\" in the 325 | ;; console. 326 | (let [el (js/document.getElementById \"test-input\")] 327 | (listen-sequence! el [#{:a} #{:b} #{:c}] #(js/console.log \"a b c\"))) 328 | " 329 | [el key-sets f] 330 | (swap! (get-fn-store! el) assoc-in key-sets f) 331 | (events/listen el "keydown" (get-sequence-listener! el))) 332 | 333 | (defn unlisten-sequence! 334 | "Stop listening for a sequence of keydown events." 335 | [el key-sets] 336 | (swap! (get-fn-store! el) 337 | (fn [store] 338 | (let [edit-path (butlast key-sets) 339 | key (last key-sets)] 340 | (-> (update-in store edit-path dissoc key) 341 | (prune edit-path empty?)))))) 342 | --------------------------------------------------------------------------------