From 3aec8246eaec277d23dff87a8f396e616580ea36 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 8 Mar 2014 13:50:43 -0800 Subject: [PATCH 01/32] small layout changes (also, qwerty--ben is now the default) --- firmware/keyboard/ergodox/layout/qwerty--ben.c | 2 +- firmware/keyboard/ergodox/options.mk | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/firmware/keyboard/ergodox/layout/qwerty--ben.c b/firmware/keyboard/ergodox/layout/qwerty--ben.c index 09ddf48e..7afd35b0 100644 --- a/firmware/keyboard/ergodox/layout/qwerty--ben.c +++ b/firmware/keyboard/ergodox/layout/qwerty--ben.c @@ -108,7 +108,7 @@ shL2kcap, z, x, c, v, b, lpupo2l2, transp, transp, transp, // right hand ..... ......... ......... ......... ......... ......... ......... F12, F6, F7, F8, F9, F10, power, - lpo2l2, nop, undersc, lessThan, grtrThan, dollar, volumeU, + lpo2l2, caret, undersc, lessThan, grtrThan, dollar, volumeU, bkslash, 1, parenL, parenR, equal, volumeD, lpupo3l3, asterisk, 2, 3, 4, 5, mute, transp, transp, transp, transp, transp, diff --git a/firmware/keyboard/ergodox/options.mk b/firmware/keyboard/ergodox/options.mk index 03e87f16..8ba30a29 100644 --- a/firmware/keyboard/ergodox/options.mk +++ b/firmware/keyboard/ergodox/options.mk @@ -21,7 +21,7 @@ F_CPU := 16000000 # processor speed, in Hz; max value is 16000000 (16MHz); must match # initialization in source -KEYBOARD_LAYOUT := qwerty--kinesis-mod +KEYBOARD_LAYOUT := qwerty--ben # default layout for this keyboard KEYBOARD_LAYOUTS := \ From faf96737a0d22dc118f16929ee51cdad1ca9dfcc Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 24 Mar 2014 22:14:20 -0700 Subject: [PATCH 02/32] added todo (keyboard debugging tip) --- firmware/keyboard/ergodox/options.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/firmware/keyboard/ergodox/options.h b/firmware/keyboard/ergodox/options.h index 6b65da62..403f9e3a 100644 --- a/firmware/keyboard/ergodox/options.h +++ b/firmware/keyboard/ergodox/options.h @@ -24,6 +24,9 @@ #define OPT__DEBOUNCE_TIME 5 // in milliseconds +// TODO: it should probably be noted in a separate document that sometimes +// changing this to a higher value, say 20, is a workaround to fix keys that +// seem to unexpectedly double-tap. // ---------------------------------------------------------------------------- From 1ed4e02e5dc6796226c2b71c1f41de2c730e2849 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 24 Mar 2014 22:16:49 -0700 Subject: [PATCH 03/32] (forgot to mention my source) --- firmware/keyboard/ergodox/options.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/firmware/keyboard/ergodox/options.h b/firmware/keyboard/ergodox/options.h index 403f9e3a..f6966881 100644 --- a/firmware/keyboard/ergodox/options.h +++ b/firmware/keyboard/ergodox/options.h @@ -26,7 +26,7 @@ // in milliseconds // TODO: it should probably be noted in a separate document that sometimes // changing this to a higher value, say 20, is a workaround to fix keys that -// seem to unexpectedly double-tap. +// seem to unexpectedly double-tap (thanks Thanatermesis!). // ---------------------------------------------------------------------------- From 321973883108a43782408ffa94cdd9f94697c77e Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 12 Apr 2014 14:42:07 -0700 Subject: [PATCH 04/32] quick status update --- readme.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 023fbee3..768c0d62 100644 --- a/readme.md +++ b/readme.md @@ -28,9 +28,8 @@ Notes: (written by "hasu") to the ErgoDox! Status: -* School is starting again late August 2013. It looks to be a busy semester, - so I may not have that much time to work on it. I wasn't able to get nearly - the amount done this summer that I had hoped, other things taking precedence, - but I still plan to finish everything I've already talked about: macro - recording, (attempt) USB features, layout examples, and other documentation. +* (updated 2014-04-12) School and chores and life in general still taking most + of my time. I still plan to finish everything I've already talked about + though: macro recording, (attempt) USB features, layout examples, and other + documentation. From 881bdf6f944336f7f706f12debba7eaafe335c06 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Thu, 22 May 2014 01:34:02 -0700 Subject: [PATCH 05/32] working on eeprom_macro: wrote find_key_action() --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 201 ++++++++++-------- 1 file changed, 113 insertions(+), 88 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index d10ae1fb..59017e8a 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -14,7 +14,7 @@ * - The default state (the "erased" state) of this EEPROM is all `1`s, which * makes setting a byte to `0xFF` easier and faster in hardware than zeroing * it (and also causes less wear on the memory over time, I think). This is - * reflected in some of our choices for default values, and such. + * reflected in some of the choices for default values, and such. * * - GCC and AVR processors (and Intel processors, for that matter) are * primarily little endian: in avr-gcc, multi-byte data types are allocated @@ -34,7 +34,6 @@ */ -#include #include #include "../../../../firmware/keyboard.h" #include "../../../../firmware/lib/eeprom.h" @@ -91,14 +90,23 @@ * - byte 0: MSB of `EEMEM_START` * - byte 1: LSB of `EEMEM_START` * + * - Upon initialization, if this block does not have the expected value, + * our portion of the EEPROM should be reinitialized. + * * - END_ADDRESS: * - byte 0: MSB of `EEMEM_END` * - byte 1: LSB of `EEMEM_END` * + * - Upon initialization, if this block does not have the expected value, + * our portion of the EEPROM should be reinitialized. + * * - VERSION: * - byte 0: - * - This byte will all be set to `VERSION` as the last step of + * - This byte will be set to `VERSION` as the last step of * initializing our portion of the EEPROM. + * - This byte will be cleared (to 0xFF) before beginning a + * `compress()` of the macros, and reset to `VERSION` once the + * operation has completed. * - Upon initialization, if this value is not equal to the current * `VERSION`, our portion of the EEPROM should be reinitialized. * @@ -239,12 +247,10 @@ typedef struct { // local functions ------------------------------------------------------------ /** functions/read_key_action/description - * Read and return the key-action beginning at `*from` in the EEPROM, and - * advance `*from` to one byte past the key-action. + * Read and return the key-action beginning at `from` in the EEPROM. * * Arguments: - * - `from`: A pointer to a pointer to the location in EEPROM from which to - * begin reading + * - `from`: A pointer to the location in EEPROM from which to begin reading * * Returns: * - success: The key-action, as a `key_action_t` @@ -253,14 +259,14 @@ typedef struct { * - See the documentation for "(group) EEMEM layout" above for a description * of the layout of key-actions in EEMEM. */ -key_action_t read_key_action(void ** from) { +key_action_t read_key_action(void * from) { uint8_t byte; // handle the first byte // - since this byte (and no others) stores the value of `k.pressed` // - also, this allows us to avoid `|=` in favor of `=` for this byte - byte = eeprom__read((*from)++); + byte = eeprom__read(from++); key_action_t k = { .pressed = byte >> 6 & 0b01, @@ -274,7 +280,7 @@ key_action_t read_key_action(void ** from) { // sure that the key-action is no more than 4 bytes long. while (byte >> 7) { - byte = eeprom__read((*from)++); + byte = eeprom__read(from++); // shift up (make more significant) the bits we have so far, to make // room for the bits we just read @@ -293,17 +299,16 @@ key_action_t read_key_action(void ** from) { } /** functions/write_key_action/description - * Write the given information to a key-action beginning at `*to` in the - * EEPROM, and advance `*to` to one byte past the newly written key-action. + * Write the given information to a key-action beginning at `to` in the + * EEPROM, and return the number of bytes written. * * Arguments: - * - `to`: A pointer to a pointer to the location in EEPROM at which to begin - * writing + * - `to`: A pointer to the location in EEPROM at which to begin writing * - `k`: The key-action to write * * Returns: - * - success: `0` - * - failure: [other] + * - success: The number of bytes written + * - failure: 0 * * Notes: * - See the documentation for "(group) EEMEM layout" above for a description @@ -321,12 +326,12 @@ key_action_t read_key_action(void ** from) { * It's probably worthwhile to note that I was looking at the assembly * (though not closely) and function size with optimizations turned on. */ -uint8_t write_key_action(void ** to, key_action_t k) { +uint8_t write_key_action(void * to, key_action_t k) { // - we need to leave room after this macro (and therefore after this // key-action) for the `type == TYPE_END` byte - if ((*to) > EEMEM_END-4) - return 1; // error: might not be enough space + if (to > EEMEM_END-4) + return 0; // error: might not be enough space // ignore the bits we don't need to write // - if the leading two bits of all three variables are `0b00`, we don't @@ -347,20 +352,22 @@ uint8_t write_key_action(void ** to, key_action_t k) { k.column <<= 2; } + uint8_t written = 4-i; + // write key-action bytes for all bit pairs that weren't ignored // - the first byte contains the value of `k.pressed`; the same position is // set to `1` in all subsequent bytes // - all bytes except the last one written (containing the least // significant bits) have their first bit set to `1` - uint8_t byte = (k.pressed ? 1 : 0) << 6; + uint8_t byte = k.pressed << 6; for (; i<4; i++) { - byte = byte | ( i<3 ? 1 : 0 ) << 7 - | ( k.layer & 0xC0 ) >> 2 - | ( k.row & 0xC0 ) >> 4 - | ( k.column & 0xC0 ) >> 6 ; - eeprom__write((*to)++, byte); + byte = byte | ( i<3 ) << 7 + | ( k.layer & 0xC0 ) >> 2 + | ( k.row & 0xC0 ) >> 4 + | ( k.column & 0xC0 ) >> 6 ; + eeprom__write(to++, byte); byte = 1 << 6; k.layer <<= 2; @@ -368,7 +375,87 @@ uint8_t write_key_action(void ** to, key_action_t k) { k.column <<= 2; } - return 0; // success + return written; // success +} + +/** + * Find the macro remapping the given key-action (if it exists). + * + * Arguments: + * - `k`: The key-action to search for + * + * Returns: + * - success: The EEMEM address of the beginning of the desired macro + * - failure: `0` + * + * Notes: + * - The address `0` (or really `NULL`, which is `#define`ed to `((void *)0)`) + * is a valid address in the EEPROM; but because macros are not placed first + * in the EEPROM, we can still use it to signal nonexistence or failure. + * - See the documentation for "(group) EEMEM layout" above for a description + * of the layout of macros in EEMEM. + * + * Implementation notes: + * - It would be more efficient to convert the given key action into the same + * binary representation as used in the EEPROM, once, and then compare that + * directly with the encoded key-action bytes read; but I don't think it'll + * have enough of an impact on performance to justify rewriting the + * ...key_action() functions, and it seems like this solution is a little bit + * cleaner (since it results in slightly fewer functions and keeps the + * representation of a key-function in SRAM consistent). + */ +void * find_key_action(key_action_t k) { + void * current = EEMEM_MACROS_START; + + for ( uint8_t type = eeprom__read(current); + type != TYPE_END; + current += eeprom__read(current+1), type = eeprom__read(current) ) { + + if (type == TYPE_DELETED) + continue; + + // otherwise we have `type == TYPE_VALID_MACRO` + + key_action_t k_current = read_key_action(current+2); + + if ( k.pressed == k_current.pressed + && k.layer == k_current.layer + && k.row == k_current.row + && k.column == k_current.column ) + + return current; + } + + return 0; // key-action not found +} + +/** + * TODO + * - it might be possible to let in-progress macros keep being written, even + * when a compress() gets called, transparently. since writes to the eeprom + * (using my wrapper) are scheduled and sequential, all we would have to do + * would be to make sure to copy the in-progress bytes, and adjust the + * necessary variables so future writes to the in-progress macro would be + * scheduled to occur in the appropriate location (and also so that the final + * write validating the macro would occur in the correct location). then, we + * would only be bound by memory (for scheduling writes), and by the total + * amount of unused EEPROM space for macros. we would still be vulnerable to + * power loss though... but handling that cleanly would be too much trouble. + */ +uint8_t compress(void) { + // - find first deleted (or end) + // - find next deleted (or end) + // - copy everything in between down + // + // if not done + // - calculate beginning of new first deleted (or end) + // - find new next deleted (or end) + // - copy everything in between down + // - repeat + // + + // TODO + return 0; } // TODO: rewriting (yet again) - stopped here @@ -424,68 +511,6 @@ uint8_t current_macro_length; // ---------------------------------------------------------------------------- // local functions ------------------------------------------------------------ -/** functions/find_uid/description - * Find the macro with the given `uid` - * - * Arguments: - * - `uid`: The UID of the macro we're trying to find - * - * Returns: - * - success: The EEMEM address of the beginning of the macro - * - failure: `NULL` - * - * Notes: - * - `NULL` is `#define`ed to `((void *)0)`, which for the EEPROM is a valid - * memory address; but because `struct eeprom` does not place - * `eeprom.macros.data` first in memory, `NULL` is guaranteed to be before - * the beginning of that array, and is therefore usable as a signal that the - * macro we're looking for does not exist. - * - * Implementation notes: - * - Using `memcmp()` to compare two structs is bad practice in general (what - * if there's uninitialized padding in the struct?); but I'm doing it here - * because we're already trusting the binary layout of the struct when we - * store and retrieve it from EEMEM, and it saves writing another function - * just for that. - * - It should not be strictly necessary for us to check whether we're - * iterating over the bounds of `eeprom.macros.data`, since the list of - * macros is supposed to be terminated in a well defined way. But we may as - * well, just to be safer :) - */ -static void * find_uid(eeprom_macro__uid_t uid) { - // if `eeprom.table.data` indicates that the macro does not exist - if ( (eeprom.table.data[uid.row][uid.column] >> uid.layer) & 1 ) - return NULL; - - // otherwise the macro may exist: we must search for it - for ( uint8_t * p = &eeprom.macros.data[0]; - p < &eeprom.macros.data[MACROS_LENGTH-3]; ) { - - header_t header; - eeprom__block_read(&header, p, sizeof(header)); - - switch (header.type) { - case HEADER_TYPE_VALID: - if ( ! memcmp(&uid, &header.uid, sizeof(uid)) ) - return p; - - // (do not break) - - case HEADER_TYPE_DELETED: - p += sizeof(header_t) + header.length * sizeof(action_t); - break; - - // `HEADER_TYPE_END` or invalid value - default: - // (no more macros to search) - return NULL; - } - } - - // macro does not exist - return NULL; -} - /** functions/find_next_deleted/description * Find the first deleted macro at or after the macro at the given position * From c50b98922ce29d1656eaf6d8826b712bd32b9fad Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Fri, 23 May 2014 09:53:03 -0700 Subject: [PATCH 06/32] changing the default scan rate to 100Hz Thanatermesis (via email) told me that this worked for him, fixing his issue of having some keys unexpectedly double tap (though, I think he might have gone down to 50Hz, or something). since he mentioned it, i've been noticing my keys double tapping sometimes (on one of my brown boards, with an acrylic case... it didn't seem to happen at all with my blue caseless board...), so i decided to give this a try :) --- firmware/keyboard/ergodox/options.h | 5 +---- firmware/main.c | 3 +++ 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/firmware/keyboard/ergodox/options.h b/firmware/keyboard/ergodox/options.h index f6966881..a1c8eb0d 100644 --- a/firmware/keyboard/ergodox/options.h +++ b/firmware/keyboard/ergodox/options.h @@ -22,11 +22,8 @@ // firmware/main // ---------------------------------------------------------------------------- -#define OPT__DEBOUNCE_TIME 5 +#define OPT__DEBOUNCE_TIME 10 // in milliseconds -// TODO: it should probably be noted in a separate document that sometimes -// changing this to a higher value, say 20, is a workaround to fix keys that -// seem to unexpectedly double-tap (thanks Thanatermesis!). // ---------------------------------------------------------------------------- diff --git a/firmware/main.c b/firmware/main.c index 8ffd4583..82f699b7 100644 --- a/firmware/main.c +++ b/firmware/main.c @@ -28,6 +28,9 @@ * * Notes: * - Cherry MX bounce time <= 5ms (at 16 in/sec actuation speed) (spec) + * - From experience (after having this issue brought to my attention by + * Thanatermesis), waiting longer can sometimes fix the issue of having some + * keys unexpectedly seem to double-tap. */ #ifndef OPT__DEBOUNCE_TIME #error "OPT__DEBOUNCE_TIME not defined" From a353e8a5d1771a3b62ea7a9d8fd4ada10ecb2c89 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 24 May 2014 16:30:36 -0700 Subject: [PATCH 07/32] little bit of cleanup --- firmware/keyboard/ergodox/controller/mcp23018.c | 8 ++++---- firmware/keyboard/ergodox/controller/teensy-2-0.c | 8 ++++---- firmware/keyboard/ergodox/options.mk | 4 ---- 3 files changed, 8 insertions(+), 12 deletions(-) diff --git a/firmware/keyboard/ergodox/controller/mcp23018.c b/firmware/keyboard/ergodox/controller/mcp23018.c index 12d8676e..52ac6c06 100644 --- a/firmware/keyboard/ergodox/controller/mcp23018.c +++ b/firmware/keyboard/ergodox/controller/mcp23018.c @@ -23,10 +23,6 @@ #error "Expecting different keyboard dimensions" #endif -#if ( OPT__MCP23018__DRIVE_ROWS && OPT__MCP23018__DRIVE_COLUMNS ) \ - || !( OPT__MCP23018__DRIVE_ROWS || OPT__MCP23018__DRIVE_COLUMNS ) - #error "MCP23018 pin drive direction incorrectly set" -#endif /** macros/(group) pin drive direction/description * Select which set of pins (rows or columns) will drive (alternate between * hi-Z and drive low), and which will be inputs (hi-Z) @@ -49,6 +45,10 @@ * - If the diode cathode is towards the circular solder pad, set * `OPT__MCP23018__DRIVE_ROWS` to `1` */ +#if ( OPT__MCP23018__DRIVE_ROWS && OPT__MCP23018__DRIVE_COLUMNS ) \ + || !( OPT__MCP23018__DRIVE_ROWS || OPT__MCP23018__DRIVE_COLUMNS ) + #error "MCP23018 pin drive direction incorrectly set" +#endif // ---------------------------------------------------------------------------- diff --git a/firmware/keyboard/ergodox/controller/teensy-2-0.c b/firmware/keyboard/ergodox/controller/teensy-2-0.c index 3c4c369f..5190617e 100644 --- a/firmware/keyboard/ergodox/controller/teensy-2-0.c +++ b/firmware/keyboard/ergodox/controller/teensy-2-0.c @@ -28,10 +28,6 @@ #error "Expecting different keyboard dimensions" #endif -#if ( OPT__TEENSY__DRIVE_ROWS && OPT__TEENSY__DRIVE_COLUMNS ) \ - || !( OPT__TEENSY__DRIVE_ROWS || OPT__TEENSY__DRIVE_COLUMNS ) - #error "Teensy pin drive direction incorrectly set" -#endif /** macros/(group) pin drive direction/description * Select which set of pins (rows or columns) will drive (alternate between * hi-Z and drive low), and which will be inputs (hi-Z) @@ -54,6 +50,10 @@ * - If the diode cathode is towards the circular solder pad, set * `OPT__TEENSY__DRIVE_ROWS` to `1` */ +#if ( OPT__TEENSY__DRIVE_ROWS && OPT__TEENSY__DRIVE_COLUMNS ) \ + || !( OPT__TEENSY__DRIVE_ROWS || OPT__TEENSY__DRIVE_COLUMNS ) + #error "Teensy pin drive direction incorrectly set" +#endif // ---------------------------------------------------------------------------- diff --git a/firmware/keyboard/ergodox/options.mk b/firmware/keyboard/ergodox/options.mk index 8ba30a29..2d04e509 100644 --- a/firmware/keyboard/ergodox/options.mk +++ b/firmware/keyboard/ergodox/options.mk @@ -49,7 +49,3 @@ SRC += $(wildcard $(CURDIR)/layout/$(KEYBOARD_LAYOUT)*.c) CFLAGS += -include $(wildcard $(CURDIR)/options.h) -$(CURDIR)/layout/qwerty-kinesis-mod.o: $(wildcard $(CURDIR)/layout/common/*) -$(CURDIR)/layout/dvorak-kinesis-mod.o: $(wildcard $(CURDIR)/layout/common/*) -$(CURDIR)/layout/colemak-symbol-mod.o: $(wildcard $(CURDIR)/layout/common/*) - From 47038151ce624390c6879379bb53564124ef172d Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 24 May 2014 16:30:53 -0700 Subject: [PATCH 08/32] (working: eeprom-macro) --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 294 +++++++++--------- 1 file changed, 150 insertions(+), 144 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 59017e8a..89ebc4ce 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -31,6 +31,36 @@ * during a critical time being fairly low, and the consequence of (detected) * data corruption hopefully more of an annoyance than anything else, I * decided the effort (and extra EEMEM usage) wasn't worth it. + * + * + * TODO: + * - i was thinking before that the calling function need not ignore layer + * shift keys, or any other keys. now i think that layer keys (or at least + * layer shift keys) really should be ignored. not doing so may lead to all + * sorts of fun problems. for example, if the "begin/end recording" key is + * not on layer 0 (which it probably won't be), the last keys pressed (but + * not released) will most likely be layer shift keys -- but since these keys + * were not released before we stopped recording, there would be no record of + * their release, and the macro would therefore push that layer onto the + * layer stack, and never pop it off. + * + * - 255 bytes (so, on average, about 100 keystrokes = 200 key actions) should + * be enough for a macro, i think. `length` can be 1 byte, and count the + * total number of bytes (including `type` and `length`, and anything else) + * - also, if the following macro has the same UID, perhaps we should + * consider that macro a continuation of the first. + * + * - need to write something like: + * - `kb__layout__exec_key_layer()` + * - `kb__layout__exec_key()` could just look up the current layer + * (falling through for transparent keys), and then call + * `kb__layout__exec_key_layer()`. this would obviate the need for a + * separate `static get_layer(void)` function, since the + * functionality would essentially be separated out anyway. + * - `kb__led__delay__error()` + * - "delay" because it should probably flash a few times, or + * something, and i feel like it'd be better overall to not continue + * accepting input while that's happening. */ @@ -83,6 +113,28 @@ * - `EEMEM_MACROS_END` * - `EEMEM_END`: The address of the last byte of our block of EEMEM * + * Warnings: + * - This implementation of macros doesn't leave any room for error checking: + * we must be very careful not to corrupt the data. Also need to be very + * careful that any pointer into the EEMEM that's supposed to be pointing to + * the beginning of a macro (especially a non-initial macro) actually does + * point to one. Otherwise, behavior is undefined. + * + * Terms: + * - The "address" of a macro is the EEMEM address of the first byte of that + * macro. + * - The "header" of a macro is the part of the macro containing the macro's + * type and length. + * - The "data" of a macro is everything following the macro's header. + * + * Notes: + * - `START_ADDRESS` and `END_ADDRESS` are written as part of our effort to + * make sure that the assumptions in place when writing the data don't shift + * (undetected) by the time it gets read. Either of these values could + * change, legitimately, without `VERSION` being incremented, but it's + * important that any two builds of the firmware that deal with this section + * of the EEPROM have the same values for each. + * * * EEMEM sections: * @@ -104,9 +156,6 @@ * - byte 0: * - This byte will be set to `VERSION` as the last step of * initializing our portion of the EEPROM. - * - This byte will be cleared (to 0xFF) before beginning a - * `compress()` of the macros, and reset to `VERSION` once the - * operation has completed. * - Upon initialization, if this value is not equal to the current * `VERSION`, our portion of the EEPROM should be reinitialized. * @@ -125,10 +174,15 @@ * - byte ...: (optional) (variable length, as described below) * - `key-action` 1...: the key-actions to which `key-action` 0 * is remapped + * - byte 0: `type == TYPE_CONTINUED` + * - byte 1: `length`: the total number of bytes used by this + * macro, including the bytes for `type` and `length` + * - byte 2...: (optional) a continuation of the data section of + * the previous macro * - byte 0: `type == TYPE_END` * - byte 1...: (optional) undefined * - * - The last key-action in this series will have `type == TYPE_END`. + * - The last macro in this series will have `type == TYPE_END`. * * - A key-action is a variable length encoding of the information in a * `key_action_t`, with the following format: @@ -186,15 +240,6 @@ * | | '- layer bit pair * | '- pressed / 1 * '- continued - * - * - * Notes: - * - `START_ADDRESS` and `END_ADDRESS` are written as part of our effort to - * make sure that the assumptions in place when writing the data don't shift - * (undetected) by the time it gets read. Either of these values could - * change, legitimately, without `VERSION` being incremented, but it's - * important that any two builds of the firmware that deal with this section - * of the EEPROM have the same values for each. */ #define EEMEM_START ((void *)OPT__EEPROM__EEPROM_MACRO__START) #define EEMEM_START_ADDRESS_START (EEMEM_START + 0) @@ -213,10 +258,12 @@ * Members: * - `TYPE_DELETED` * - `TYPE_VALID_MACRO` + * - `TYPE_CONTINUED` * - `TYPE_END` */ #define TYPE_DELETED 0x00 #define TYPE_VALID_MACRO 0x01 +#define TYPE_CONTINUED 0x02 #define TYPE_END 0xFF // ---------------------------------------------------------------------------- @@ -243,6 +290,20 @@ typedef struct { uint8_t column; } key_action_t; +// ---------------------------------------------------------------------------- +// variables ------------------------------------------------------------------ + +/** variables/end_macro/description + * The EEMEM address of the macro with `type == TYPE_END` + */ +void * end_macro; + +/** variables/new_end_macro/description + * The EEMEM address of where to write the next byte of a new macro (or a macro + * in progress) + */ +void * new_end_macro; + // ---------------------------------------------------------------------------- // local functions ------------------------------------------------------------ @@ -378,14 +439,14 @@ uint8_t write_key_action(void * to, key_action_t k) { return written; // success } -/** +/** functions/find_key_action/description * Find the macro remapping the given key-action (if it exists). * * Arguments: * - `k`: The key-action to search for * * Returns: - * - success: The EEMEM address of the beginning of the desired macro + * - success: The EEMEM address of the desired macro * - failure: `0` * * Notes: @@ -411,161 +472,106 @@ void * find_key_action(key_action_t k) { type != TYPE_END; current += eeprom__read(current+1), type = eeprom__read(current) ) { - if (type == TYPE_DELETED) - continue; - - // otherwise we have `type == TYPE_VALID_MACRO` + if (type == TYPE_VALID_MACRO) { - key_action_t k_current = read_key_action(current+2); + key_action_t k_current = read_key_action(current+2); - if ( k.pressed == k_current.pressed - && k.layer == k_current.layer - && k.row == k_current.row - && k.column == k_current.column ) + if ( k.pressed == k_current.pressed + && k.layer == k_current.layer + && k.row == k_current.row + && k.column == k_current.column ) { - return current; + return current; + } + } } return 0; // key-action not found } -/** - * TODO - * - it might be possible to let in-progress macros keep being written, even - * when a compress() gets called, transparently. since writes to the eeprom - * (using my wrapper) are scheduled and sequential, all we would have to do - * would be to make sure to copy the in-progress bytes, and adjust the - * necessary variables so future writes to the in-progress macro would be - * scheduled to occur in the appropriate location (and also so that the final - * write validating the macro would occur in the correct location). then, we - * would only be bound by memory (for scheduling writes), and by the total - * amount of unused EEPROM space for macros. we would still be vulnerable to - * power loss though... but handling that cleanly would be too much trouble. - */ -uint8_t compress(void) { - // - find first deleted (or end) - // - find next deleted (or end) - // - copy everything in between down - // - // if not done - // - calculate beginning of new first deleted (or end) - // - find new next deleted (or end) - // - copy everything in between down - // - repeat - // - - // TODO - return 0; -} - -// TODO: rewriting (yet again) - stopped here -#if 0 - -// ---------------------------------------------------------------------------- -// TODO: -// -// - i was thinking before that the calling function need not ignore layer -// shift keys, or any other keys. now i think that layer keys (or at least -// layer shift keys) really should be ignored. not doing so may lead to all -// sorts of fun problems. for example, if the "begin/end recording" key is -// not on layer 0 (which it probably won't be), the last keys pressed (but -// not released) will most likely be layer shift keys -- but since these keys -// were not released before we stopped recording, there would be no record of -// their release, and the macro would therefore push that layer onto the -// layer stack, and never pop it off. -// -// - 255 bytes (so, on average, about 100 keystrokes = 200 key actions) should -// be enough for a macro, i think. `length` can be 1 byte, and count the -// total number of bytes (including `type` and `length`, and anything else) -// -// - need to write something like: -// - `kb__layout__exec_key_layer()` -// - `kb__layout__exec_key()` could just look up the current layer -// (falling through for transparent keys), and then call -// `kb__layout__exec_key_layer()`. this would obviate the need for a -// separate `static get_layer(void)` function, since the -// functionality would essentially be separated out anyway. -// - `kb__led__delay__error()` -// - "delay" because it should probably flash a few times, or -// something, and i feel like it'd be better overall to not continue -// accepting input while that's happening. -// -// - how should we handle key-functions, in both their SRAM and EEMEM forms? -// it would be very convenient if we could compare the passed key-function -// with EEMEM key-functions without having to decode the EEMEM ones (only -// read them out - and maybe not even read out them out entirely). perhaps -// there should be different functions for converting from a `uint8_t a[4]` -// to a `key_action_t`, and vice versa. or perhaps `key_action_t`s should -// really be `uint8_t a[4]`s, with a different encoding than those -// representing EEMEM key-actions (which would be written to EEMEM eliding -// zero bytes). need to think about it some more. -// -// ---------------------------------------------------------------------------- -// ---------------------------------------------------------------------------- - -// variables in SRAM ---------------------------------------------------------- - -static void * current_macro; -uint8_t current_macro_length; - -// ---------------------------------------------------------------------------- -// local functions ------------------------------------------------------------ - /** functions/find_next_deleted/description - * Find the first deleted macro at or after the macro at the given position + * Find the first deleted macro at or after the given macro. * * Arguments: - * - `start`: The address (in EEMEM) of the first byte of the header of the - * macro at which to begin searching + * - `start`: The EEMEM address of the macro at which to begin searching * * Returns: - * - success: The address (in EEMEM) of the of the beginning of the first - * deleted macro found at or after `start` - * - failure: `NULL` (no deleted macros found) + * - success: The EEMEM address of the first deleted macro at or after `start` + * - failure: `0` (no deleted macros were found at or after `start`) */ -static void * find_next_deleted(void * start) { - for ( uint8_t * p = start; - p < &eeprom.macros.data[MACROS_LENGTH-3]; ) { - - uint8_t type = eeprom__read(p); - uint8_t length = eeprom__read(p+1); +void * find_next_deleted(void * start) { + for ( uint8_t type = eeprom__read(start); + type != TYPE_END; + start += eeprom__read(start+1), type = eeprom__read(start) ) { - switch (type) { - case HEADER_TYPE_VALID: - p += sizeof(header_t) + length * sizeof(action_t); - break; + if (type == TYPE_DELETED) + return start; + } - case HEADER_TYPE_DELETED: - return p; + return 0; // no deleted macro found +} - // `HEADER_TYPE_END` or invalid value - default: - // (no more macros to search) - return NULL; - } - } +/** functions/find_next_nondeleted/description + * Find the first macro at or after the given macro that is not marked as + * deleted. + * + * Arguments: + * - `start`: The EEMEM address of the macro at which to begin searching + * + * Returns: + * - success: The EEMEM address of the first non-deleted macro at or after + * `start` + * + * Notes: + * - Since the sequence of macros must end with a `TYPE_END` macro (which is, + * of course, not a deleted macro), this function will always find a + * non-deleted macro at or after the one passed. + */ +void * find_next_nondeleted(void * start) { + for ( uint8_t type = eeprom__read(start); + type == TYPE_DELETED || type == TYPE_CONTINUED; + start += eeprom__read(start+1), type = eeprom__read(start) ); - // no deleted macros found - return NULL; + return start; } /** functions/compress/description - * Compress `macros.data` + * TODO * - * Shift all macros towards index `0`, overwriting the areas previously - * occupied by deleted macros. + * - it might be possible to let in-progress macros keep being written, even + * when a compress() gets called, transparently. since writes to the eeprom + * (using my wrapper) are scheduled and sequential, all we would have to do + * would be to make sure to copy the in-progress bytes, and adjust the + * necessary variables so future writes to the in-progress macro would be + * scheduled to occur in the appropriate location (and also so that the final + * write validating the macro would occur in the correct location). then, we + * would only be bound by memory (for scheduling writes), and by the total + * amount of unused EEPROM space for macros. we would still be vulnerable to + * power loss though... but handling that cleanly would be too much trouble. + * + * - do we clear the `VERSION` byte? maybe not... :) + * - This byte will be cleared (to 0xFF) before beginning a + * `compress()` of the macros, and reset to `VERSION` once the + * operation has completed. + * + * - another advantage of not clearing the version byte is that we can search + * for and play back macros as usual; if we're in the middle of compressing, + * and the macro hasn't been dealt with yet, it will simply appear not to + * exist for a few seconds. */ -static void compress(void) { return; - // TODO: this whole thing... just starting. - - uint8_t * current_deleted = find_next_deleted(&eeprom.macros.data[0]); +void compress(void) { +// void * to_overwrite = find_next_deleted(EEMEM_MACROS_START); +// void * to_compress = find_next_nondeleted(to_overwrite); +// void * next = to_compress + eeprom__read(to_compress+1); +// +// uint8_t type = eeprom__read(to_compress); +// eeprom__write(to_overwrite, TYPE_END); +// eeprom__copy(to_overwrite+1, to_compress+1, eeprom__read(to_compress+1)-1); +// eeprom__write(to_overwrite, type); - uint8_t * next_deleted = find_next_deleted(current_deleted); - if (! next_deleted) next_deleted = macros_free_begin; + // TODO } -#endif // 0 - // ---------------------------------------------------------------------------- // public functions ----------------------------------------------------------- From 79fec2cff07d49fcfe9320d024eb41504f2e8f37 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 24 May 2014 21:54:41 -0700 Subject: [PATCH 09/32] (working: eeprom-macro; making progress!) --- doc/references.md | 5 ++ firmware/lib/layout/eeprom-macro/atmega32u4.c | 63 ++++++++++++++++--- 2 files changed, 58 insertions(+), 10 deletions(-) diff --git a/doc/references.md b/doc/references.md index e0514b74..b9ab23e5 100644 --- a/doc/references.md +++ b/doc/references.md @@ -191,6 +191,11 @@ (http://stackoverflow.com/questions/6702161/pointer-comparisons-in-c-are-they-signed-or-unsigned) Pointer comparisons in C are interesting... Have to be careful with them. +* [Saturating Addition in C] + (http://stackoverflow.com/a/3431717) + Saturated addition is kind of difficult in C. This is my favorite of the + methods I saw. + ### C++ Stuff * [Google C++ Style Guide] diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 89ebc4ce..d18655a6 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -559,17 +559,60 @@ void * find_next_nondeleted(void * start) { * and the macro hasn't been dealt with yet, it will simply appear not to * exist for a few seconds. */ -void compress(void) { -// void * to_overwrite = find_next_deleted(EEMEM_MACROS_START); -// void * to_compress = find_next_nondeleted(to_overwrite); -// void * next = to_compress + eeprom__read(to_compress+1); -// -// uint8_t type = eeprom__read(to_compress); -// eeprom__write(to_overwrite, TYPE_END); -// eeprom__copy(to_overwrite+1, to_compress+1, eeprom__read(to_compress+1)-1); -// eeprom__write(to_overwrite, type); +void compress(void) { // TODO + + // `to_overwrite` is the first byte of the EEPROM with a value we don't + // care about + // - this will only point to the beginning of a macro initially + void * to_overwrite = find_next_deleted(EEMEM_MACROS_START); + if (! to_overwrite) + return; + + // set `next` to a value that works when we enter the loop + // - on the first iteration, `find_next_nondeleted(next)` will return + // quickly, so this doesn't waste much time + // - we should do this before writing the `TYPE_END` byte to the EEPROM + // below. since writes are delayed until the end of the keyboard scan + // cycle (which can't happen until sometime after this function returns), + // it doesn't really matter -- we could just set `next = to_overwrite` -- + // but it's nice to write things so they would work even if writes were + // not delayed. + void * next = find_next_nondeleted(to_overwrite); + + eeprom__write(to_overwrite, TYPE_END); + + while (next != new_end_macro) { + + // `to_compress` is the beginning of the data we wish to copy + void * to_compress = find_next_nondeleted(next); + + // `next` will be 1 byte beyond the data we wish to copy + next = find_next_deleted(to_compress); + if (! next) + next = new_end_macro; + + uint8_t type = eeprom__read(to_compress); + void * type_location = to_overwrite; + to_overwrite++; + to_compress++; + + for ( uint16_t length = next-to_compress; + length; + length = next-to_compress ) { + + if (length > UINT8_MAX) + length = UINT8_MAX; + + eeprom__copy(to_overwrite, to_compress, length); + to_overwrite += length; + to_compress += length; + } - // TODO + if (next != new_end_macro) + eeprom__write(to_overwrite, TYPE_END); + + eeprom__write(type_location, type); + } } // ---------------------------------------------------------------------------- From d2d0e1ffabe061704c0af05404e293b55a47208a Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 24 May 2014 22:05:41 -0700 Subject: [PATCH 10/32] (small aesthetic change) --- firmware/makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/firmware/makefile b/firmware/makefile index a9144131..ffc4a7c4 100644 --- a/firmware/makefile +++ b/firmware/makefile @@ -165,7 +165,7 @@ clean-all-files: clean-object-files clean-target-files clean-object-files: -@rm -vf $(OBJ) \ - $(OBJ:%=%.dep) + $(OBJ:%=%.dep) clean-target-files: -@rm -vf $(TARGET).eep \ From 5d35f2ed44da2b0ccaa44d86f613207024d51ebc Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sun, 25 May 2014 12:46:13 -0700 Subject: [PATCH 11/32] (working: eeprom-macro; woo! finished compress(); will test later) really, it'd be hard to test any of this stuff until i have it implemented in the layout; so it might be a while. --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 88 ++++++++++++------- 1 file changed, 57 insertions(+), 31 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index d18655a6..fa36f402 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -44,12 +44,6 @@ * their release, and the macro would therefore push that layer onto the * layer stack, and never pop it off. * - * - 255 bytes (so, on average, about 100 keystrokes = 200 key actions) should - * be enough for a macro, i think. `length` can be 1 byte, and count the - * total number of bytes (including `type` and `length`, and anything else) - * - also, if the following macro has the same UID, perhaps we should - * consider that macro a continuation of the first. - * * - need to write something like: * - `kb__layout__exec_key_layer()` * - `kb__layout__exec_key()` could just look up the current layer @@ -301,6 +295,9 @@ void * end_macro; /** variables/new_end_macro/description * The EEMEM address of where to write the next byte of a new macro (or a macro * in progress) + * + * Notes: + * - This is the first unused byte of our portion of the EEPROM */ void * new_end_macro; @@ -536,34 +533,50 @@ void * find_next_nondeleted(void * start) { } /** functions/compress/description - * TODO - * - * - it might be possible to let in-progress macros keep being written, even - * when a compress() gets called, transparently. since writes to the eeprom - * (using my wrapper) are scheduled and sequential, all we would have to do - * would be to make sure to copy the in-progress bytes, and adjust the - * necessary variables so future writes to the in-progress macro would be - * scheduled to occur in the appropriate location (and also so that the final - * write validating the macro would occur in the correct location). then, we - * would only be bound by memory (for scheduling writes), and by the total - * amount of unused EEPROM space for macros. we would still be vulnerable to - * power loss though... but handling that cleanly would be too much trouble. - * - * - do we clear the `VERSION` byte? maybe not... :) - * - This byte will be cleared (to 0xFF) before beginning a - * `compress()` of the macros, and reset to `VERSION` once the - * operation has completed. - * - * - another advantage of not clearing the version byte is that we can search - * for and play back macros as usual; if we're in the middle of compressing, - * and the macro hasn't been dealt with yet, it will simply appear not to - * exist for a few seconds. + * Remove any gaps in the EEPROM caused by deleted macros + * + * Implementation notes: + * - It's important to keep in mind that nothing will be written to the EEPROM + * until after this function returns (since writes are done 1 byte per + * keyboard scan cycle, at the end of each scan cycle). But the code should + * not depend on that. + * - It's also important to remember that this function will not be interrupted + * by the recording of any new key-actions for an in-progress macro (though, + * key-actions may be queued for writing before all `compress()` writes have + * been completed). + * - Before performing any copy operation, we invalidate the portion of the + * EEPROM we are going to modify by setting the first byte of it (which is, + * and will be, the beginning of a macro) to `TYPE_END`. This way, as long + * as writes to the EEPROM are atomic (or, as long as we don't lose power + * while writing one of these crucial `type` bytes) the EEPROM will always be + * in a consistent state. + * - If power is lost before all writes have been committed, the portion of + * the EEPROM that has not yet been compressed will remain invalidated + * (so data will be lost, but the list of macros will not be corrupted). + * - If the user tries to execute a macro before all writes have been + * committed, and the macro is in the portion of the EEPROM that has + * already been compressed, it will be found as normal. If the macro is + * in the portion of the EEPROM that is still being modified, it will + * temporarily appear not to exist. + * - In any case, this way, no extra checks need to be performed, the + * possibility of data loss is kept very low, and the possibility of data + * corruption (which would, in this scheme, be undetected) is (I think, + * for our purposes) vanishingly small. + * - As a general idea of the maximum time it might take for a compress to be + * fully committed to EEMEM: 1024 bytes * 5 ms/byte = 5120 ms ~= 5 seconds. + * For a cycle time of 10ms, our write would take ~10 seconds maximum. If + * someone were recording a macro very quickly, we might run out of memory + * for caching writes; but I can't think of a better way to do things at the + * moment, so I hope the chance of that is small. */ -void compress(void) { // TODO +void compress(void) { // `to_overwrite` is the first byte of the EEPROM with a value we don't - // care about - // - this will only point to the beginning of a macro initially + // need to keep + // - after the first iteration of the loop, this is unlikely to still point + // to the beginning of a macro + // - after we exit the loop, this will point to the first unused byte of + // our portion of the EEPROM void * to_overwrite = find_next_deleted(EEMEM_MACROS_START); if (! to_overwrite) return; @@ -579,6 +592,7 @@ void compress(void) { // TODO // not delayed. void * next = find_next_nondeleted(to_overwrite); + // invalidate the portion of the EEPROM we are going to modify eeprom__write(to_overwrite, TYPE_END); while (next != new_end_macro) { @@ -591,11 +605,17 @@ void compress(void) { // TODO if (! next) next = new_end_macro; + // we copy this byte (the `type` byte of the first macro in the block + // of macros we need to keep) last uint8_t type = eeprom__read(to_compress); void * type_location = to_overwrite; to_overwrite++; to_compress++; + // copy the data in at most `UINT8_MAX` size chunks + // - because the `length` argument of `eeprom__write()` is a `uint8_t` + // - even though macros (individually) will be at most `UINT8_MAX` + // bytes long, the block of macros we need to save may be longer for ( uint16_t length = next-to_compress; length; length = next-to_compress ) { @@ -608,11 +628,17 @@ void compress(void) { // TODO to_compress += length; } + // if this is not the last iteration, invalidate the portion of the + // EEPROM we are going to modify next if (next != new_end_macro) eeprom__write(to_overwrite, TYPE_END); + // revalidate the portion of the EEPROM we are finished with eeprom__write(type_location, type); } + + end_macro -= (new_end_macro-to_overwrite); + new_end_macro = to_overwrite; } // ---------------------------------------------------------------------------- From 5ee88643fd065d3d00e2e9889e51663f1ad33386 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sun, 25 May 2014 19:44:55 -0700 Subject: [PATCH 12/32] (working: eeprom-macro) --- firmware/keyboard.h | 7 + firmware/keyboard/ergodox/led.c | 43 +++- firmware/lib/layout/eeprom-macro/atmega32u4.c | 201 ++++++++++-------- 3 files changed, 160 insertions(+), 91 deletions(-) diff --git a/firmware/keyboard.h b/firmware/keyboard.h index 396cfcf7..dd2ab739 100644 --- a/firmware/keyboard.h +++ b/firmware/keyboard.h @@ -50,6 +50,7 @@ void kb__led__all_set (float percent); // ------- void kb__led__state__power_on (void); void kb__led__state__ready (void); +void kb__led__delay__error (void); void kb__led__delay__usb_init (void); // layout @@ -217,6 +218,12 @@ void kb__layout__exec_key (bool pressed, uint8_t row, uint8_t column); * keystrokes. */ + +// === kb__led__delay__error() === +/** functions/kb__led__delay__error/description + * Signal a generic error (delays for a total of ~1 second) + */ + // === kb__led__delay__usb_init() === /** functions/kb__led__delay__usb_init/description * Delay for a total of ~1 second, to allow the host to load drivers and such. diff --git a/firmware/keyboard/ergodox/led.c b/firmware/keyboard/ergodox/led.c index 1a68830e..42d586fb 100644 --- a/firmware/keyboard/ergodox/led.c +++ b/firmware/keyboard/ergodox/led.c @@ -18,13 +18,24 @@ // ---------------------------------------------------------------------------- -#ifndef OPT__LED_BRIGHTNESS - #error "OPT__LED_BRIGHTNESS not defined" -#endif /** macros/OPT__LED_BRIGHTNESS/description * A percentage of maximum brightness, with '1' being greatest and '0' being * not quite off */ +#ifndef OPT__LED_BRIGHTNESS + #error "OPT__LED_BRIGHTNESS not defined" +#endif + +// ---------------------------------------------------------------------------- + +/** types/struct led_state/description + * For holding the state of the LEDs (if we ever need to save/restore them) + */ +struct led_state { + bool led_1 : 1; + bool led_2 : 1; + bool led_3 : 1; +}; // ---------------------------------------------------------------------------- @@ -100,6 +111,32 @@ void kb__led__state__ready(void) { kb__led__all_set( OPT__LED_BRIGHTNESS ); } +void kb__led__delay__error(void) { + struct led_state state = { + .led_1 = kb__led__read(1), + .led_2 = kb__led__read(2), + .led_3 = kb__led__read(3), + }; + + // delay for a total of ~1 second + kb__led__all_on(); + _delay_ms(167); + kb__led__all_off(); + _delay_ms(167); + kb__led__all_on(); + _delay_ms(167); + kb__led__all_off(); + _delay_ms(167); + kb__led__all_on(); + _delay_ms(167); + kb__led__all_off(); + _delay_ms(167); + + if (state.led_1) kb__led__on(1); + if (state.led_2) kb__led__on(2); + if (state.led_3) kb__led__on(3); +} + void kb__led__delay__usb_init(void) { // need to delay for a total of ~1 second kb__led__set( 1, OPT__LED_BRIGHTNESS ); diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index fa36f402..63cbcf54 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -27,7 +27,7 @@ * * - For a long time, I was going to try to make this library robust in the * event of power loss, but in the end I decided not to. This feature is - * meant to be used for *temporary* macros - so, with the risk of power loss + * meant to be used for *temporary* macros -- so, with the risk of power loss * during a critical time being fairly low, and the consequence of (detected) * data corruption hopefully more of an annoyance than anything else, I * decided the effort (and extra EEMEM usage) wasn't worth it. @@ -51,10 +51,6 @@ * `kb__layout__exec_key_layer()`. this would obviate the need for a * separate `static get_layer(void)` function, since the * functionality would essentially be separated out anyway. - * - `kb__led__delay__error()` - * - "delay" because it should probably flash a few times, or - * something, and i feel like it'd be better overall to not continue - * accepting input while that's happening. */ @@ -293,11 +289,8 @@ typedef struct { void * end_macro; /** variables/new_end_macro/description - * The EEMEM address of where to write the next byte of a new macro (or a macro - * in progress) - * - * Notes: - * - This is the first unused byte of our portion of the EEPROM + * The EEMEM address of where to write the next byte of a macro in progress (or + * `0` if no macro is in progress) */ void * new_end_macro; @@ -305,33 +298,33 @@ void * new_end_macro; // local functions ------------------------------------------------------------ /** functions/read_key_action/description - * Read and return the key-action beginning at `from` in the EEPROM. + * Read the key-action beginning at `from` in the EEPROM * * Arguments: * - `from`: A pointer to the location in EEPROM from which to begin reading + * - `k`: A pointer to the variable in which to store the key-action * * Returns: - * - success: The key-action, as a `key_action_t` + * - success: The number of bytes read * * Notes: * - See the documentation for "(group) EEMEM layout" above for a description * of the layout of key-actions in EEMEM. */ -key_action_t read_key_action(void * from) { +uint8_t read_key_action(void * from, key_action_t * k) { uint8_t byte; // handle the first byte - // - since this byte (and no others) stores the value of `k.pressed` + // - since this byte (and no others) stores the value of `k->pressed` // - also, this allows us to avoid `|=` in favor of `=` for this byte byte = eeprom__read(from++); + uint8_t read = 1; - key_action_t k = { - .pressed = byte >> 6 & 0b01, - .layer = byte >> 4 & 0b11, - .row = byte >> 2 & 0b11, - .column = byte >> 0 & 0b11, - }; + k->pressed = byte >> 6 & 0b01; + k->layer = byte >> 4 & 0b11; + k->row = byte >> 2 & 0b11; + k->column = byte >> 0 & 0b11; // handle all subsequent bytes // - we assume the stream is valid. especially, we do not check to make @@ -339,21 +332,22 @@ key_action_t read_key_action(void * from) { while (byte >> 7) { byte = eeprom__read(from++); + read++; // shift up (make more significant) the bits we have so far, to make // room for the bits we just read - k.layer <<= 2; - k.row <<= 2; - k.column <<= 2; + k->layer <<= 2; + k->row <<= 2; + k->column <<= 2; // logical or the bits we just read into the lowest (least significant) // positions - k.layer |= byte >> 4 & 0b11; - k.row |= byte >> 2 & 0b11; - k.column |= byte >> 0 & 0b11; + k->layer |= byte >> 4 & 0b11; + k->row |= byte >> 2 & 0b11; + k->column |= byte >> 0 & 0b11; } - return k; // success + return read; // success } /** functions/write_key_action/description @@ -362,11 +356,15 @@ key_action_t read_key_action(void * from) { * * Arguments: * - `to`: A pointer to the location in EEPROM at which to begin writing - * - `k`: The key-action to write + * - `k`: A pointer to the key-action to write * * Returns: * - success: The number of bytes written - * - failure: 0 + * - failure: `0` + * + * Warnings: + * - Writes are not atomic: if there are 4 bytes to be written, and the first + * three writes succeed, the 4th may still fail. * * Notes: * - See the documentation for "(group) EEMEM layout" above for a description @@ -384,7 +382,8 @@ key_action_t read_key_action(void * from) { * It's probably worthwhile to note that I was looking at the assembly * (though not closely) and function size with optimizations turned on. */ -uint8_t write_key_action(void * to, key_action_t k) { +uint8_t write_key_action(void * to, key_action_t * k) { + uint8_t ret; // for function return codes (to test for errors) // - we need to leave room after this macro (and therefore after this // key-action) for the `type == TYPE_END` byte @@ -404,33 +403,34 @@ uint8_t write_key_action(void * to, key_action_t k) { uint8_t i = 0; - for (; i<3 && !((k.layer|k.row|k.column) & 0xC0); i++) { - k.layer <<= 2; - k.row <<= 2; - k.column <<= 2; + for (; i<3 && !((k->layer|k->row|k->column) & 0xC0); i++) { + k->layer <<= 2; + k->row <<= 2; + k->column <<= 2; } uint8_t written = 4-i; // write key-action bytes for all bit pairs that weren't ignored - // - the first byte contains the value of `k.pressed`; the same position is - // set to `1` in all subsequent bytes + // - the first byte contains the value of `k->pressed`; the same position + // is set to `1` in all subsequent bytes // - all bytes except the last one written (containing the least // significant bits) have their first bit set to `1` - uint8_t byte = k.pressed << 6; + uint8_t byte = k->pressed << 6; for (; i<4; i++) { byte = byte | ( i<3 ) << 7 - | ( k.layer & 0xC0 ) >> 2 - | ( k.row & 0xC0 ) >> 4 - | ( k.column & 0xC0 ) >> 6 ; - eeprom__write(to++, byte); + | ( k->layer & 0xC0 ) >> 2 + | ( k->row & 0xC0 ) >> 4 + | ( k->column & 0xC0 ) >> 6 ; + ret = eeprom__write(to++, byte); + if (ret) return 0; // write failed byte = 1 << 6; - k.layer <<= 2; - k.row <<= 2; - k.column <<= 2; + k->layer <<= 2; + k->row <<= 2; + k->column <<= 2; } return written; // success @@ -471,7 +471,8 @@ void * find_key_action(key_action_t k) { if (type == TYPE_VALID_MACRO) { - key_action_t k_current = read_key_action(current+2); + key_action_t k_current; + read_key_action(current+2, &k_current); if ( k.pressed == k_current.pressed && k.layer == k_current.layer @@ -535,6 +536,18 @@ void * find_next_nondeleted(void * start) { /** functions/compress/description * Remove any gaps in the EEPROM caused by deleted macros * + * Returns: + * - success: `0` + * - failure: + * - `1`: write failed; data unchanged + * - `2`: write failed; data lost + * - `end_macro` set to the new last macro + * - `new_end_macro` set to `0` + * + * Notes: + * - As a rough idea of the time it might take for a compress to be fully + * committed to EEMEM: 1024 bytes * 5 ms/byte = 5120 ms ~= 5 seconds. + * * Implementation notes: * - It's important to keep in mind that nothing will be written to the EEPROM * until after this function returns (since writes are done 1 byte per @@ -562,53 +575,51 @@ void * find_next_nondeleted(void * start) { * possibility of data loss is kept very low, and the possibility of data * corruption (which would, in this scheme, be undetected) is (I think, * for our purposes) vanishingly small. - * - As a general idea of the maximum time it might take for a compress to be - * fully committed to EEMEM: 1024 bytes * 5 ms/byte = 5120 ms ~= 5 seconds. - * For a cycle time of 10ms, our write would take ~10 seconds maximum. If - * someone were recording a macro very quickly, we might run out of memory - * for caching writes; but I can't think of a better way to do things at the - * moment, so I hope the chance of that is small. + * + * TODO: + * - I feel like this still needs to be read over a bit more; maybe after I've + * started writing the public functions and have a better idea of exactly + * what it should do. */ -void compress(void) { - - // `to_overwrite` is the first byte of the EEPROM with a value we don't - // need to keep - // - after the first iteration of the loop, this is unlikely to still point - // to the beginning of a macro - // - after we exit the loop, this will point to the first unused byte of - // our portion of the EEPROM - void * to_overwrite = find_next_deleted(EEMEM_MACROS_START); +uint8_t compress(void) { + uint8_t ret; // for function return codes (to test for errors) + + void * to_overwrite; // the first byte with a value we don't need to keep + void * to_compress; // the first byte of the data we need to keep + void * next; // the next macro after the data to keep (usually) + + uint8_t type; // the type of the first macro in `to_compress` + void * type_location; // the final location of this `type` byte in EEMEM + + to_overwrite = find_next_deleted(EEMEM_MACROS_START); if (! to_overwrite) - return; + return 0; // success: nothing to compress // set `next` to a value that works when we enter the loop // - on the first iteration, `find_next_nondeleted(next)` will return // quickly, so this doesn't waste much time - // - we should do this before writing the `TYPE_END` byte to the EEPROM - // below. since writes are delayed until the end of the keyboard scan - // cycle (which can't happen until sometime after this function returns), - // it doesn't really matter -- we could just set `next = to_overwrite` -- - // but it's nice to write things so they would work even if writes were - // not delayed. - void * next = find_next_nondeleted(to_overwrite); + // - since writes to the EEPROM are delayed, we could just set `next = + // to_overwrite`; but it's nicer to write things so they would work even + // if writes were immediate. + next = find_next_nondeleted(to_overwrite); - // invalidate the portion of the EEPROM we are going to modify - eeprom__write(to_overwrite, TYPE_END); + ret = eeprom__write(to_overwrite, TYPE_END); + if (ret) return 1; // write failed; data unchanged - while (next != new_end_macro) { + while (next < end_macro) { + to_compress = find_next_nondeleted(next); - // `to_compress` is the beginning of the data we wish to copy - void * to_compress = find_next_nondeleted(next); - - // `next` will be 1 byte beyond the data we wish to copy + // `next` will always be 1 byte beyond the data we wish to copy + // - since the EEPROM is only 2^10 bytes, and pointers are 16 bits, we + // don't have to worry about overflow next = find_next_deleted(to_compress); if (! next) next = new_end_macro; + if (! next) + next = end_macro+1 - // we copy this byte (the `type` byte of the first macro in the block - // of macros we need to keep) last - uint8_t type = eeprom__read(to_compress); - void * type_location = to_overwrite; + type = eeprom__read(to_compress); + type_location = to_overwrite; to_overwrite++; to_compress++; @@ -623,22 +634,36 @@ void compress(void) { if (length > UINT8_MAX) length = UINT8_MAX; - eeprom__copy(to_overwrite, to_compress, length); + ret = eeprom__copy(to_overwrite, to_compress, length); + if (ret) goto out; to_overwrite += length; to_compress += length; } - // if this is not the last iteration, invalidate the portion of the - // EEPROM we are going to modify next - if (next != new_end_macro) - eeprom__write(to_overwrite, TYPE_END); + if (next < end_macro) { + ret = eeprom__write(to_overwrite, TYPE_END); + if (ret) goto out; + } - // revalidate the portion of the EEPROM we are finished with - eeprom__write(type_location, type); + ret = eeprom__write(type_location, type); + if (ret) goto out; } - end_macro -= (new_end_macro-to_overwrite); - new_end_macro = to_overwrite; + if (new_end_macro) { + end_macro -= (new_end_macro-to_overwrite); + new_end_macro = to_overwrite; + } else { + end_macro = to_overwrite-1; + } + + return 0; // success: compression finished + +out: + + end_macro = type_location; + new_end_macro = 0; + + return 2; // write failed; data lost } // ---------------------------------------------------------------------------- From 5647b5812086dacdf1408f916879d594bbc86fea Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sun, 25 May 2014 19:45:48 -0700 Subject: [PATCH 13/32] (working: eeprom-macro: fixed typo) --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 63cbcf54..0ba4d1ab 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -616,7 +616,7 @@ uint8_t compress(void) { if (! next) next = new_end_macro; if (! next) - next = end_macro+1 + next = end_macro+1; type = eeprom__read(to_compress); type_location = to_overwrite; From 49e8f32a6054a7c8c92b06963d1c2ede6d7ef6bf Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 26 May 2014 14:42:50 -0700 Subject: [PATCH 14/32] (working: eeprom-macro + minor updates) --- firmware/keyboard/ergodox/controller.c | 3 +- firmware/lib/layout/eeprom-macro.h | 12 +- firmware/lib/layout/eeprom-macro/atmega32u4.c | 124 +++++++++++++----- firmware/lib/usb.h | 8 +- firmware/lib/usb/atmega32u4/general.c | 2 +- firmware/main.c | 7 +- 6 files changed, 112 insertions(+), 44 deletions(-) diff --git a/firmware/keyboard/ergodox/controller.c b/firmware/keyboard/ergodox/controller.c index 63a68607..ac511b8c 100644 --- a/firmware/keyboard/ergodox/controller.c +++ b/firmware/keyboard/ergodox/controller.c @@ -23,7 +23,8 @@ uint8_t kb__init(void) { if (mcp23018__init()) // must be second return 2; - eeprom_macro__init(); + if (eeprom_macro__init()) + return 3; return 0; // success } diff --git a/firmware/lib/layout/eeprom-macro.h b/firmware/lib/layout/eeprom-macro.h index 305f697f..82088a2e 100644 --- a/firmware/lib/layout/eeprom-macro.h +++ b/firmware/lib/layout/eeprom-macro.h @@ -101,8 +101,8 @@ uint8_t eeprom_macro__record_action ( ARGS ); uint8_t eeprom_macro__record_finalize (void); uint8_t eeprom_macro__play ( ARGS ); bool eeprom_macro__exists ( ARGS ); -void eeprom_macro__clear ( ARGS ); -void eeprom_macro__clear_all (void); +uint8_t eeprom_macro__clear ( ARGS ); +uint8_t eeprom_macro__clear_all (void); #undef ARGS @@ -252,6 +252,10 @@ void eeprom_macro__clear_all (void); * - `layer`: The layer of the key action * - `row`: The row of the key action * - `column`: The column of the key action + * + * Returns: + * - success: `0` + * - failure: [other] */ // === eeprom_macro__clear_all() === @@ -263,5 +267,9 @@ void eeprom_macro__clear_all (void); * in such a state that none of the functions declared here will be able to * find a macro for any key action. This does not necessarily imply that the * EEPROM is in a fully known state. + * + * Returns: + * - success: `0` + * - failure: [other] */ diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 0ba4d1ab..9d778238 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -103,13 +103,6 @@ * - `EEMEM_MACROS_END` * - `EEMEM_END`: The address of the last byte of our block of EEMEM * - * Warnings: - * - This implementation of macros doesn't leave any room for error checking: - * we must be very careful not to corrupt the data. Also need to be very - * careful that any pointer into the EEMEM that's supposed to be pointing to - * the beginning of a macro (especially a non-initial macro) actually does - * point to one. Otherwise, behavior is undefined. - * * Terms: * - The "address" of a macro is the EEMEM address of the first byte of that * macro. @@ -311,7 +304,7 @@ void * new_end_macro; * - See the documentation for "(group) EEMEM layout" above for a description * of the layout of key-actions in EEMEM. */ -uint8_t read_key_action(void * from, key_action_t * k) { +static uint8_t read_key_action(void * from, key_action_t * k) { uint8_t byte; // handle the first byte @@ -382,14 +375,7 @@ uint8_t read_key_action(void * from, key_action_t * k) { * It's probably worthwhile to note that I was looking at the assembly * (though not closely) and function size with optimizations turned on. */ -uint8_t write_key_action(void * to, key_action_t * k) { - uint8_t ret; // for function return codes (to test for errors) - - // - we need to leave room after this macro (and therefore after this - // key-action) for the `type == TYPE_END` byte - if (to > EEMEM_END-4) - return 0; // error: might not be enough space - +static uint8_t write_key_action(void * to, key_action_t * k) { // ignore the bits we don't need to write // - if the leading two bits of all three variables are `0b00`, we don't // need to write a key-action byte containing that pair of bits @@ -424,8 +410,10 @@ uint8_t write_key_action(void * to, key_action_t * k) { | ( k->layer & 0xC0 ) >> 2 | ( k->row & 0xC0 ) >> 4 | ( k->column & 0xC0 ) >> 6 ; - ret = eeprom__write(to++, byte); - if (ret) return 0; // write failed + + if ( to > EEMEM_START || EEMEM_END < to ) return 0; // out of bounds + if ( eeprom__write(to++, byte) ) return 0; // write failed + byte = 1 << 6; k->layer <<= 2; @@ -440,7 +428,7 @@ uint8_t write_key_action(void * to, key_action_t * k) { * Find the macro remapping the given key-action (if it exists). * * Arguments: - * - `k`: The key-action to search for + * - `k`: A pointer to the key-action to search for * * Returns: * - success: The EEMEM address of the desired macro @@ -462,7 +450,7 @@ uint8_t write_key_action(void * to, key_action_t * k) { * cleaner (since it results in slightly fewer functions and keeps the * representation of a key-function in SRAM consistent). */ -void * find_key_action(key_action_t k) { +static void * find_key_action(key_action_t * k) { void * current = EEMEM_MACROS_START; for ( uint8_t type = eeprom__read(current); @@ -474,10 +462,10 @@ void * find_key_action(key_action_t k) { key_action_t k_current; read_key_action(current+2, &k_current); - if ( k.pressed == k_current.pressed - && k.layer == k_current.layer - && k.row == k_current.row - && k.column == k_current.column ) { + if ( k->pressed == k_current.pressed + && k->layer == k_current.layer + && k->row == k_current.row + && k->column == k_current.column ) { return current; } @@ -497,7 +485,7 @@ void * find_key_action(key_action_t k) { * - success: The EEMEM address of the first deleted macro at or after `start` * - failure: `0` (no deleted macros were found at or after `start`) */ -void * find_next_deleted(void * start) { +static void * find_next_deleted(void * start) { for ( uint8_t type = eeprom__read(start); type != TYPE_END; start += eeprom__read(start+1), type = eeprom__read(start) ) { @@ -525,7 +513,7 @@ void * find_next_deleted(void * start) { * of course, not a deleted macro), this function will always find a * non-deleted macro at or after the one passed. */ -void * find_next_nondeleted(void * start) { +static void * find_next_nondeleted(void * start) { for ( uint8_t type = eeprom__read(start); type == TYPE_DELETED || type == TYPE_CONTINUED; start += eeprom__read(start+1), type = eeprom__read(start) ); @@ -581,7 +569,7 @@ void * find_next_nondeleted(void * start) { * started writing the public functions and have a better idea of exactly * what it should do. */ -uint8_t compress(void) { +static uint8_t compress(void) { uint8_t ret; // for function return codes (to test for errors) void * to_overwrite; // the first byte with a value we don't need to keep @@ -669,15 +657,54 @@ uint8_t compress(void) { // ---------------------------------------------------------------------------- // public functions ----------------------------------------------------------- +/** functions/eeprom_macro__init/description + * Implementation notes: + * - The initialization of static EEPROM values that this function is supposed + * to do when the EEPROM is not in a valid state (for this build of the + * firmware) is done in `eeprom_macro__clear_all()`. + */ uint8_t eeprom_macro__init(void) { - // TODO - return 0; + #define TEST(address, offset, expected) \ + if ( eeprom__read((address)+(offset)) != (expected) ) \ + return eeprom_macro__clear_all() + + TEST( EEMEM_START_ADDRESS_START, 0, (uint16_t)EEMEM_START >> 8 ); + TEST( EEMEM_START_ADDRESS_START, 1, (uint16_t)EEMEM_START & 0xFF ); + + TEST( EEMEM_END_ADDRESS_START, 0, (uint16_t)EEMEM_END >> 8 ); + TEST( EEMEM_END_ADDRESS_START, 1, (uint16_t)EEMEM_END & 0xFF ); + + TEST( EEMEM_VERSION_START, 0, (uint16_t)VERSION ); + + #undef TEST + + void * current = EEMEM_MACROS_START; + for ( uint8_t type = eeprom__read(current); + type != TYPE_END; + current += eeprom__read(current+1), type = eeprom__read(current) ); + + end_macro = current; + new_end_macro = 0; + + return 0; // success } uint8_t eeprom_macro__record_init( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { + + // TODO: check for out of bounds / failed write +// new_end_macro = end_macro + 2; +// +// key_action_t k = { +// .pressed = pressed, +// .layer = layer, +// .row = row, +// .column = column, +// }; +// end_macro += write_key_action( new_end_macro, &k )); + // TODO return 0; } @@ -711,14 +738,41 @@ bool eeprom_macro__exists( bool pressed, return false; } -void eeprom_macro__clear( bool pressed, - uint8_t layer, - uint8_t row, - uint8_t column ) { +uint8_t eeprom_macro__clear( bool pressed, + uint8_t layer, + uint8_t row, + uint8_t column ) { // TODO + return 0; } -void eeprom_macro__clear_all(void) { - // TODO +/** functions/eeprom_macro__clear_all/description + * Implementation notes: + * - Since the `eeprom__...` functions only modify data when necessary, we + * don't need to worry here about excessive EEPROM wear when writing; so it's + * easier to initialize all static EEPROM values every time this function + * runs than to do most of these initializations as a special case in + * `eeprom_macro__init()`. + */ +uint8_t eeprom_macro__clear_all(void) { + #define WRITE(address, offset, value) \ + if (eeprom__write( (address)+(offset), (value) )) return 1 + + WRITE( EEMEM_START_ADDRESS_START, 0, (uint16_t)EEMEM_START >> 8 ); + WRITE( EEMEM_START_ADDRESS_START, 1, (uint16_t)EEMEM_START & 0xFF ); + + WRITE( EEMEM_END_ADDRESS_START, 0, (uint16_t)EEMEM_END >> 8 ); + WRITE( EEMEM_END_ADDRESS_START, 1, (uint16_t)EEMEM_END & 0xFF ); + + WRITE( EEMEM_VERSION_START, 0, (uint16_t)VERSION ); + + WRITE( EEMEM_MACROS_START, 0, (uint16_t)TYPE_END ); + + #undef WRITE + + end_macro = EEMEM_MACROS_START; + new_end_macro = 0; + + return 0; } diff --git a/firmware/lib/usb.h b/firmware/lib/usb.h index 95c76e90..9acde00d 100644 --- a/firmware/lib/usb.h +++ b/firmware/lib/usb.h @@ -24,8 +24,8 @@ // --- general --- -void usb__init (void); -bool usb__is_configured (void); +uint8_t usb__init (void); +bool usb__is_configured (void); // --- keyboard --- @@ -53,6 +53,10 @@ uint8_t usb__kb__send_report (void); /** functions/usb__init/description * Initialize USB for this device * + * Returns: + * - success: `0` + * - failure: [other] + * * Notes: * - Should be called exactly once by `main()`, and nothing else USB related * should be done until `usb__configured` is `true` diff --git a/firmware/lib/usb/atmega32u4/general.c b/firmware/lib/usb/atmega32u4/general.c index e0c15a21..f35f3e01 100644 --- a/firmware/lib/usb/atmega32u4/general.c +++ b/firmware/lib/usb/atmega32u4/general.c @@ -16,7 +16,7 @@ // ---------------------------------------------------------------------------- -void usb__init(void) { usb_init(); } +uint8_t usb__init(void) { usb_init(); return 0; } bool usb__is_configured(void) { return usb_configured(); } diff --git a/firmware/main.c b/firmware/main.c index 82f699b7..c658aee6 100644 --- a/firmware/main.c +++ b/firmware/main.c @@ -73,15 +73,16 @@ int main(void) { static uint8_t time_scan_started; - kb__init(); // initialize hardware (besides USB and timer) + if (kb__init()) kb__led__delay__error(); // initialize hardware (besides + // USB and timer) kb__led__state__power_on(); - usb__init(); + if (usb__init()) kb__led__delay__error(); while (!usb__is_configured()); kb__led__delay__usb_init(); // give the OS time to load drivers, etc. - timer__init(); + if (timer__init()) kb__led__delay__error(); kb__led__state__ready(); From 0fd92b584061138ce7b6d0b8203137aa2ef728d8 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 26 May 2014 15:54:13 -0700 Subject: [PATCH 15/32] (working: eeprom-macro) there are a few warnings during compile, but only about functions not being used. it's okay: they'll be used soon enough. --- firmware/lib/layout/eeprom-macro.h | 104 +++++++++++------- firmware/lib/layout/eeprom-macro/atmega32u4.c | 86 ++++++++++++--- 2 files changed, 135 insertions(+), 55 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro.h b/firmware/lib/layout/eeprom-macro.h index 82088a2e..7667321b 100644 --- a/firmware/lib/layout/eeprom-macro.h +++ b/firmware/lib/layout/eeprom-macro.h @@ -25,19 +25,19 @@ * - A "key" is a pair of actions, one for when the key is pressed and another * for when it is released. We specify keys by their `layer`, `row`, and * `column`. - * - A "key action" is a single action. We specify key actions by their + * - A "key-action" is a single action. We specify key-actions by their * `pressed` value (whether the action corresponds to a press (`true`) or * release (`false`)) and the key they belong to. * - A "macro" is a collection of data that lives in persistent memory, and * specifies possibly many actions to perform in the place of a single, * usually different, action. For the purposes of this library, macros live - * in the EEPROM, and contain a key action who's original behavior we wish - * to mask, and a list of key actions that should be sequentially performed + * in the EEPROM, and contain a key-action who's original behavior we wish + * to mask, and a list of key-actions that should be sequentially performed * instead. * - A "keystroke" is a full press then release of a key. Keystrokes may * overlap each other. - * - To "remap" a key action is to assign a macro to it (masking, not - * replacing, what the key action originally did). + * - To "remap" a key-action is to assign a macro to it (masking, not + * replacing, what the key-action originally did). * - The "EEPROM" is an "Electronically Erasable Programmable Read Only * Memory". It is where this library stores persistent data. * - "EEMEM" is "EEprom MEMory" (i.e. another way of referring to the memory of @@ -67,12 +67,12 @@ * one might wish to do when, for example, quickly swapping the positions of * two letter keys. * - With sufficient trickiness, we could probably do away with having `layer` - * in the key actions that make up the body of macros (most of this + * in the key-actions that make up the body of macros (most of this * trickiness being in the logic for how users record macros and assign them - * to key actions). I could imagine there being situations where this turned + * to key-actions). I could imagine there being situations where this turned * out to be useful... but I feel like much more often it would just be a bit * confusing. It would also be inconsistent a little, having two different - * representations of a key action. And it wouldn't actually save us that + * representations of a key-action. And it wouldn't actually save us that * much EEPROM. */ @@ -99,6 +99,7 @@ uint8_t eeprom_macro__init (void); uint8_t eeprom_macro__record_init ( ARGS ); uint8_t eeprom_macro__record_action ( ARGS ); uint8_t eeprom_macro__record_finalize (void); +uint8_t eeprom_macro__record_cancel (void); uint8_t eeprom_macro__play ( ARGS ); bool eeprom_macro__exists ( ARGS ); uint8_t eeprom_macro__clear ( ARGS ); @@ -158,12 +159,12 @@ uint8_t eeprom_macro__clear_all (void); * Prepare to record a new macro * * Arguments: - * - (group) The key action to remap - * - `pressed`: Whether the key action is a press (`true`) or a release + * - (group) The key-action to remap + * - `pressed`: Whether the key-action is a press (`true`) or a release * (`false`) - * - `layer`: The layer of the key action - * - `row`: The row of the key action - * - `column`: The column of the key action + * - `layer`: The layer of the key-action + * - `row`: The row of the key-action + * - `column`: The column of the key-action * * Returns: * - success: `0` @@ -174,50 +175,75 @@ uint8_t eeprom_macro__clear_all (void); * recorded when this function is called (i.e. this function has been called * once already, and `...finalize()` has not been called yet), the old macro * should be thrown away, and this new one prepared for. + * - If a macro remapping the given key-action already exists, it should be + * deleted. */ // === eeprom_macro__record_action() === /** functions/eeprom_macro__record_action/description - * Record the next key action of the current macro + * Record the next key-action of the current macro * * Arguments: - * - (group) The key action to record - * - `pressed`: Whether the key action is a press (`true`) or a release + * - (group) The key-action to record + * - `pressed`: Whether the key-action is a press (`true`) or a release * (`false`) - * - `layer`: The layer of the key action - * - `row`: The row of the key action - * - `column`: The column of the key action + * - `layer`: The layer of the key-action + * - `row`: The row of the key-action + * - `column`: The column of the key-action * * Returns: * - success: `0` * - failure: [other] (not enough memory left to record) + * + * Notes: + * - If this function fails, the current key-action may be canceled (thrown + * away). */ // === eeprom_macro__record_finalize() === /** functions/eeprom_macro__record_finalize/description * Finalize the recording of the current macro * - * Returns + * Returns: * - success: `0` * - failure: [other] * * Notes: * - Before this function is called, the macro (even though parts of it may be * written) should not be readable, or referenced anywhere in the EEPROM. + * + * Notes: + * - If this function fails, the current key-action may be canceled (thrown + * away). + */ + +// === eeprom_macro__record_cancel() === +/** functions/eeprom_macro__record_cancel/description + * Cancel the recording of the current macro + * + * Returns: + * - success: `0` + * - failure: [other] + * + * Notes: + * - Depending on the implementation, this function may not be necessary due to + * the behavior of `eeprom_macro__record_init()` and + * `eeprom_macro__record_finalize()`. In that case this function should + * simply do nothing. */ // === eeprom_macro__play() === /** functions/eeprom_macro__play/description - * Play back recorded key actions for the macro assigned to the specified key + * Play back recorded key-actions for the macro assigned to the specified key * action * * Arguments: - * - (group) The key action to search for - * - `pressed`: Whether the key action is a press (`true`) or a release + * - (group) The key-action to search for + * - `pressed`: Whether the key-action is a press (`true`) or a release * (`false`) - * - `layer`: The layer of the key action - * - `row`: The row of the key action - * - `column`: The column of the key action + * - `layer`: The layer of the key-action + * - `row`: The row of the key-action + * - `column`: The column of the key-action * * Returns: * - success: `0` (macro successfully played) @@ -226,15 +252,15 @@ uint8_t eeprom_macro__clear_all (void); // === eeprom_macro__exists() === /** functions/eeprom_macro__exists/description - * Predicate indicating whether the specified key action has been remapped + * Predicate indicating whether the specified key-action has been remapped * * Arguments: - * - (group) The key action to search for - * - `pressed`: Whether the key action is a press (`true`) or a release + * - (group) The key-action to search for + * - `pressed`: Whether the key-action is a press (`true`) or a release * (`false`) - * - `layer`: The layer of the key action - * - `row`: The row of the key action - * - `column`: The column of the key action + * - `layer`: The layer of the key-action + * - `row`: The row of the key-action + * - `column`: The column of the key-action * * Returns: * - `true`: if a macro remapping the given key-action exists @@ -243,15 +269,15 @@ uint8_t eeprom_macro__clear_all (void); // === eeprom_macro__clear() === /** functions/eeprom_macro__clear/description - * Clear (delete) the macro assigned to the given key action + * Clear (delete) the macro assigned to the given key-action * * Arguments: - * - (group) The key action to un-remap - * - `pressed`: Whether the key action is a press (`true`) or a release + * - (group) The key-action to un-remap + * - `pressed`: Whether the key-action is a press (`true`) or a release * (`false`) - * - `layer`: The layer of the key action - * - `row`: The row of the key action - * - `column`: The column of the key action + * - `layer`: The layer of the key-action + * - `row`: The row of the key-action + * - `column`: The column of the key-action * * Returns: * - success: `0` @@ -265,7 +291,7 @@ uint8_t eeprom_macro__clear_all (void); * Notes: * - For the purposes of this function, "clearing" the EEPROM means to put it * in such a state that none of the functions declared here will be able to - * find a macro for any key action. This does not necessarily imply that the + * find a macro for any key-action. This does not necessarily imply that the * EEPROM is in a fully known state. * * Returns: diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 9d778238..09b3ac07 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -350,6 +350,7 @@ static uint8_t read_key_action(void * from, key_action_t * k) { * Arguments: * - `to`: A pointer to the location in EEPROM at which to begin writing * - `k`: A pointer to the key-action to write + * - `limit`: A pointer to the last address to which we are allowed to write * * Returns: * - success: The number of bytes written @@ -375,7 +376,7 @@ static uint8_t read_key_action(void * from, key_action_t * k) { * It's probably worthwhile to note that I was looking at the assembly * (though not closely) and function size with optimizations turned on. */ -static uint8_t write_key_action(void * to, key_action_t * k) { +static uint8_t write_key_action(void * to, key_action_t * k, void * limit) { // ignore the bits we don't need to write // - if the leading two bits of all three variables are `0b00`, we don't // need to write a key-action byte containing that pair of bits @@ -411,8 +412,8 @@ static uint8_t write_key_action(void * to, key_action_t * k) { | ( k->row & 0xC0 ) >> 4 | ( k->column & 0xC0 ) >> 6 ; - if ( to > EEMEM_START || EEMEM_END < to ) return 0; // out of bounds - if ( eeprom__write(to++, byte) ) return 0; // write failed + if ( to > limit ) return 0; // out of bounds + if ( eeprom__write(to++, byte) ) return 0; // write failed byte = 1 << 6; @@ -442,7 +443,7 @@ static uint8_t write_key_action(void * to, key_action_t * k) { * of the layout of macros in EEMEM. * * Implementation notes: - * - It would be more efficient to convert the given key action into the same + * - It would be more efficient to convert the given key-action into the same * binary representation as used in the EEPROM, once, and then compare that * directly with the encoded key-action bytes read; but I don't think it'll * have enough of an impact on performance to justify rewriting the @@ -657,6 +658,9 @@ static uint8_t compress(void) { // ---------------------------------------------------------------------------- // public functions ----------------------------------------------------------- +// TODO: go over all these, and make sure they conform to the header +// documentation + /** functions/eeprom_macro__init/description * Implementation notes: * - The initialization of static EEPROM values that this function is supposed @@ -689,23 +693,47 @@ uint8_t eeprom_macro__init(void) { return 0; // success } +/** functions/eeprom_macro__record_init/description + * Implementation notes: + * - At minimum, for a normal macro, we will need a `type` byte, `length` byte, + * key-action 0 (the action to remap), key-action 1 (a press), and key-action + * 2 (a release). Key-actions take a minimum of 1 byte, so our minimum macro + * will be 5 bytes. + */ uint8_t eeprom_macro__record_init( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { - // TODO: check for out of bounds / failed write -// new_end_macro = end_macro + 2; -// -// key_action_t k = { -// .pressed = pressed, -// .layer = layer, -// .row = row, -// .column = column, -// }; -// end_macro += write_key_action( new_end_macro, &k )); + if (new_end_macro) + eeprom_macro__record_cancel(); + + if ( end_macro + 5 > EEMEM_MACROS_END ) + return 1; // not enough room + + // TODO: + // - if a macro remapping the given key-action already exists, delete it. + + uint8_t ret; // for function return values + + key_action_t k = { + .pressed = pressed, + .layer = layer, + .row = row, + .column = column, + }; + + new_end_macro = end_macro + 2; + + // TODO: + // - call compress() if the write fails, to see if that helps + // - if compress() succeeds, but the write still fails, we should cancel + // the current macro (if compress() fails, the current macro will be + // canceled anyway) + ret = write_key_action(new_end_macro, &k, EEMEM_MACROS_END-1); + if (! ret) return 1; // write failed, or not enough room + end_macro += ret; - // TODO return 0; } @@ -713,7 +741,28 @@ uint8_t eeprom_macro__record_action( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { - // TODO + + if (! new_end_macro) + return 1; // no macro in progress + + uint8_t ret; // for function return values + + key_action_t k = { + .pressed = pressed, + .layer = layer, + .row = row, + .column = column, + }; + + // TODO: + // - call compress() if the write fails, to see if that helps + // - if compress() succeeds, but the write still fails, we should cancel + // the current macro (if compress() fails, the current macro will be + // canceled anyway) + ret = write_key_action(new_end_macro, &k, EEMEM_MACROS_END-1); + if (! ret) return 1; // write failed, or not enough room + end_macro += ret; + return 0; } @@ -722,6 +771,11 @@ uint8_t eeprom_macro__record_finalize(void) { return 0; } +uint8_t eeprom_macro__record_cancel(void) { + new_end_macro = 0; + return 0; +} + uint8_t eeprom_macro__play( bool pressed, uint8_t layer, uint8_t row, From b099061e6a440b192b0d0e9e6e9008b9cc302748 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 26 May 2014 20:29:08 -0700 Subject: [PATCH 16/32] (working: eeprom-macro) --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 145 +++++++++++++----- 1 file changed, 109 insertions(+), 36 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 09b3ac07..9fb1b79b 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -655,11 +655,72 @@ static uint8_t compress(void) { return 2; // write failed; data lost } +// ---------------------------------------------------------------------------- +// helper functions ----------------------------------------------------------- + +/** functions/write_key_action_for_new_macro/description + * Write the given key-action to the next empty space in the macros block of + * the EEPROM + * + * Arguments: + * - `k`: A pointer to the key-action to write + * + * Returns: + * - success: `0` + * - failure: [other] + * + * Assumptions: + * - A macro is currently in progress (i.e. `new_end_macro` is not `0`). + * + * Notes: + * - We make sure to leave 1 empty byte for the end macro. + * - We update the value of `new_end_macro` (either to indicate the bytes that + * were written, or to cancel the current macro if writing failed). + */ +static inline uint8_t write_key_action_for_new_macro(key_action_t * k) { + uint8_t ret; // for function return values + + ret = write_key_action(new_end_macro, k, EEMEM_MACROS_END-1); + if (! ret) { + if ( compress() ) goto out; // compress failed (macro cancelled) + + ret = write_key_action(new_end_macro, k, EEMEM_MACROS_END-1); + if (! ret) goto out; // write failed again, or not enough room + } + + new_end_macro += ret; + return 0; + +out: + new_end_macro = 0; + return 1; +} + +/** + * Deletes the macro remapping the given key-action, if it exists + * + * Arguments: + * - `k`: A pointer to the key-action to delete + * + * Returns: + * - success: `0` + * - failure: [other] + */ +static inline uint8_t delete_macro_if_exists(key_action_t * k) { + void * k_location = find_key_action(k); + + if (k_location) + if ( eeprom__write(k_location, TYPE_DELETED) ) + return 1; // write failed + + return 0; // success +} + // ---------------------------------------------------------------------------- // public functions ----------------------------------------------------------- // TODO: go over all these, and make sure they conform to the header -// documentation +// documentation (and that they work properly) /** functions/eeprom_macro__init/description * Implementation notes: @@ -695,10 +756,10 @@ uint8_t eeprom_macro__init(void) { /** functions/eeprom_macro__record_init/description * Implementation notes: - * - At minimum, for a normal macro, we will need a `type` byte, `length` byte, - * key-action 0 (the action to remap), key-action 1 (a press), and key-action - * 2 (a release). Key-actions take a minimum of 1 byte, so our minimum macro - * will be 5 bytes. + * - At minimum, for a normal macro, we will need a `type` byte, a `length` + * byte, and 3 key-actions (the key-action to remap, 1 press, and 1 release). + * Key-actions take a minimum of 1 byte, so our minimum macro will be 5 + * bytes. */ uint8_t eeprom_macro__record_init( bool pressed, uint8_t layer, @@ -711,11 +772,6 @@ uint8_t eeprom_macro__record_init( bool pressed, if ( end_macro + 5 > EEMEM_MACROS_END ) return 1; // not enough room - // TODO: - // - if a macro remapping the given key-action already exists, delete it. - - uint8_t ret; // for function return values - key_action_t k = { .pressed = pressed, .layer = layer, @@ -723,18 +779,11 @@ uint8_t eeprom_macro__record_init( bool pressed, .column = column, }; - new_end_macro = end_macro + 2; + if ( delete_macro_if_exists(&k) ) return 1; // failure - // TODO: - // - call compress() if the write fails, to see if that helps - // - if compress() succeeds, but the write still fails, we should cancel - // the current macro (if compress() fails, the current macro will be - // canceled anyway) - ret = write_key_action(new_end_macro, &k, EEMEM_MACROS_END-1); - if (! ret) return 1; // write failed, or not enough room - end_macro += ret; + new_end_macro = end_macro + 2; - return 0; + return write_key_action_for_new_macro(&k); } uint8_t eeprom_macro__record_action( bool pressed, @@ -745,8 +794,6 @@ uint8_t eeprom_macro__record_action( bool pressed, if (! new_end_macro) return 1; // no macro in progress - uint8_t ret; // for function return values - key_action_t k = { .pressed = pressed, .layer = layer, @@ -754,21 +801,33 @@ uint8_t eeprom_macro__record_action( bool pressed, .column = column, }; - // TODO: - // - call compress() if the write fails, to see if that helps - // - if compress() succeeds, but the write still fails, we should cancel - // the current macro (if compress() fails, the current macro will be - // canceled anyway) - ret = write_key_action(new_end_macro, &k, EEMEM_MACROS_END-1); - if (! ret) return 1; // write failed, or not enough room - end_macro += ret; + // TODO: if length is too long, finalize this macro, and start a + // continuation one + // + // - key-actions are at most 4 bytes long, so we make sure there are at + // least 4 bytes left in the allowable length of this macro; not worth it + // to calculate the encoded length of the key-action to be written + if ( new_end_macro - end_macro > UINT8_MAX - 4 ) { + if ( eeprom_macro__record_finalize() ) return 1; // failure + + // TODO: we can't just call ...init(). we probably need a file-local + // variable too, to keep track of whether the new macro is + // `TYPE_VALID_MACRO` or `TYPE_CONTINUED`. + } - return 0; + return write_key_action_for_new_macro(&k); } uint8_t eeprom_macro__record_finalize(void) { - // TODO + if ( eeprom__write( new_end_macro, TYPE_END ) ) goto out; + if ( eeprom__write( end_macro+1, new_end_macro - end_macro ) ) goto out; + if ( eeprom__write( end_macro, TYPE_VALID_MACRO ) ) goto out; + return 0; + +out: + new_end_macro = 0; + return 1; } uint8_t eeprom_macro__record_cancel(void) { @@ -788,16 +847,30 @@ bool eeprom_macro__exists( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { - // TODO - return false; + + key_action_t k = { + .pressed = pressed, + .layer = layer, + .row = row, + .column = column, + }; + + return find_key_action(&k); } uint8_t eeprom_macro__clear( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { - // TODO - return 0; + + key_action_t k = { + .pressed = pressed, + .layer = layer, + .row = row, + .column = column, + }; + + return delete_macro_if_exists(&k); } /** functions/eeprom_macro__clear_all/description From e8ad0d91c0d9da490ee41b46b2388a07754a561d Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Mon, 26 May 2014 23:28:08 -0700 Subject: [PATCH 17/32] (working: eeprom-macro) rough draft done! need to finish -- and check it *thoroughly* to make sure it works (and to clean it up) :) --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 80 +++++++++++++------ 1 file changed, 54 insertions(+), 26 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 9fb1b79b..1a88b757 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -157,11 +157,6 @@ * - byte ...: (optional) (variable length, as described below) * - `key-action` 1...: the key-actions to which `key-action` 0 * is remapped - * - byte 0: `type == TYPE_CONTINUED` - * - byte 1: `length`: the total number of bytes used by this - * macro, including the bytes for `type` and `length` - * - byte 2...: (optional) a continuation of the data section of - * the previous macro * - byte 0: `type == TYPE_END` * - byte 1...: (optional) undefined * @@ -241,12 +236,10 @@ * Members: * - `TYPE_DELETED` * - `TYPE_VALID_MACRO` - * - `TYPE_CONTINUED` * - `TYPE_END` */ #define TYPE_DELETED 0x00 #define TYPE_VALID_MACRO 0x01 -#define TYPE_CONTINUED 0x02 #define TYPE_END 0xFF // ---------------------------------------------------------------------------- @@ -284,6 +277,10 @@ void * end_macro; /** variables/new_end_macro/description * The EEMEM address of where to write the next byte of a macro in progress (or * `0` if no macro is in progress) + * + * Note: + * - This variable should be the primary indicator of whether a macro is in + * progress or not. */ void * new_end_macro; @@ -516,7 +513,7 @@ static void * find_next_deleted(void * start) { */ static void * find_next_nondeleted(void * start) { for ( uint8_t type = eeprom__read(start); - type == TYPE_DELETED || type == TYPE_CONTINUED; + type == TYPE_DELETED; start += eeprom__read(start+1), type = eeprom__read(start) ); return start; @@ -675,7 +672,7 @@ static uint8_t compress(void) { * Notes: * - We make sure to leave 1 empty byte for the end macro. * - We update the value of `new_end_macro` (either to indicate the bytes that - * were written, or to cancel the current macro if writing failed). + * were written, or to cancel the new macro if writing failed). */ static inline uint8_t write_key_action_for_new_macro(key_action_t * k) { uint8_t ret; // for function return values @@ -696,7 +693,7 @@ static inline uint8_t write_key_action_for_new_macro(key_action_t * k) { return 1; } -/** +/** functions/delete_macro_if_exists/description * Deletes the macro remapping the given key-action, if it exists * * Arguments: @@ -720,7 +717,8 @@ static inline uint8_t delete_macro_if_exists(key_action_t * k) { // public functions ----------------------------------------------------------- // TODO: go over all these, and make sure they conform to the header -// documentation (and that they work properly) +// documentation (and that they work properly; i'm pretty sure some don't; but +// this is hopefully a good start :) ). /** functions/eeprom_macro__init/description * Implementation notes: @@ -786,6 +784,25 @@ uint8_t eeprom_macro__record_init( bool pressed, return write_key_action_for_new_macro(&k); } +/** functions/eeprom_macro__record_action/description + * Implementation notes: + * - Macros can only be `UINT8_MAX` bytes long in total. If we don't have at + * least 4 bytes left before exceeding that limit (since 4 bytes is the + * maximum length of a key-action), we simply stop recording actions. This + * is certainly not optimal behavior... but I think it'll end up being the + * least surprising (where our other options are to either finalize the + * macro, or return an error code). + * - If long macros were desired, there are several ways one might modify + * the implementation to allow them. The simplest method would be to + * make `length` a 2 byte variable. That would reduce the number of + * small macros one could have, however. Alternately, one could steal 2 + * bits from the `type` byte, which would save space, but be more + * difficult to read. Another method would be to introduce a + * `TYPE_CONTINUED`, or something similar, where the data section of a + * macro of this type would continue the data section of the previous + * macro. That would make the logic of recording macros (and playing + * them back) a little more complicated though. + */ uint8_t eeprom_macro__record_action( bool pressed, uint8_t layer, uint8_t row, @@ -794,6 +811,9 @@ uint8_t eeprom_macro__record_action( bool pressed, if (! new_end_macro) return 1; // no macro in progress + if ( new_end_macro - end_macro > UINT8_MAX - 4 ) + return 0; // macro too long, ignoring further actions + key_action_t k = { .pressed = pressed, .layer = layer, @@ -801,20 +821,6 @@ uint8_t eeprom_macro__record_action( bool pressed, .column = column, }; - // TODO: if length is too long, finalize this macro, and start a - // continuation one - // - // - key-actions are at most 4 bytes long, so we make sure there are at - // least 4 bytes left in the allowable length of this macro; not worth it - // to calculate the encoded length of the key-action to be written - if ( new_end_macro - end_macro > UINT8_MAX - 4 ) { - if ( eeprom_macro__record_finalize() ) return 1; // failure - - // TODO: we can't just call ...init(). we probably need a file-local - // variable too, to keep track of whether the new macro is - // `TYPE_VALID_MACRO` or `TYPE_CONTINUED`. - } - return write_key_action_for_new_macro(&k); } @@ -823,6 +829,8 @@ uint8_t eeprom_macro__record_finalize(void) { if ( eeprom__write( end_macro+1, new_end_macro - end_macro ) ) goto out; if ( eeprom__write( end_macro, TYPE_VALID_MACRO ) ) goto out; + end_macro = new_end_macro; + new_end_macro = 0; return 0; out: @@ -839,7 +847,27 @@ uint8_t eeprom_macro__play( bool pressed, uint8_t layer, uint8_t row, uint8_t column ) { - // TODO + + key_action_t k = { + .pressed = pressed, + .layer = layer, + .row = row, + .column = column, + }; + + void * k_location = find_key_action(&k); + if (! k_location) return 1; // macro does not exist + + uint8_t length = eeprom__read(k_location+1); + length -= 2; + k_location += 2; + while (length) { + uint8_t read = read_key_action(k_location, &k); + // TODO: kb__layout__exec_key_layer() // function not written yet + length -= read; + k_location += read; + } + return 0; } From 24f4aca7c8cfa901fc177b8a5b1b6c05b5fc922b Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Tue, 27 May 2014 14:33:40 -0700 Subject: [PATCH 18/32] (working: eeprom-macro: went over compress()) --- firmware/lib/layout/eeprom-macro/atmega32u4.c | 65 +++++++++---------- 1 file changed, 30 insertions(+), 35 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 1a88b757..3f82d7cc 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -281,6 +281,8 @@ void * end_macro; * Note: * - This variable should be the primary indicator of whether a macro is in * progress or not. + * - When a macro is finalized, this byte will be written with the value + * `TYPE_END`, and become the new `end_macro`; hence the name. */ void * new_end_macro; @@ -526,15 +528,12 @@ static void * find_next_nondeleted(void * start) { * - success: `0` * - failure: * - `1`: write failed; data unchanged - * - `2`: write failed; data lost - * - `end_macro` set to the new last macro - * - `new_end_macro` set to `0` + * - `2`: write failed; data lost; any macro currently being written is + * cancelled * * Notes: * - As a rough idea of the time it might take for a compress to be fully * committed to EEMEM: 1024 bytes * 5 ms/byte = 5120 ms ~= 5 seconds. - * - * Implementation notes: * - It's important to keep in mind that nothing will be written to the EEPROM * until after this function returns (since writes are done 1 byte per * keyboard scan cycle, at the end of each scan cycle). But the code should @@ -543,6 +542,8 @@ static void * find_next_nondeleted(void * start) { * by the recording of any new key-actions for an in-progress macro (though, * key-actions may be queued for writing before all `compress()` writes have * been completed). + * + * Implementation notes: * - Before performing any copy operation, we invalidate the portion of the * EEPROM we are going to modify by setting the first byte of it (which is, * and will be, the beginning of a macro) to `TYPE_END`. This way, as long @@ -557,53 +558,44 @@ static void * find_next_nondeleted(void * start) { * already been compressed, it will be found as normal. If the macro is * in the portion of the EEPROM that is still being modified, it will * temporarily appear not to exist. - * - In any case, this way, no extra checks need to be performed, the - * possibility of data loss is kept very low, and the possibility of data - * corruption (which would, in this scheme, be undetected) is (I think, - * for our purposes) vanishingly small. - * - * TODO: - * - I feel like this still needs to be read over a bit more; maybe after I've - * started writing the public functions and have a better idea of exactly - * what it should do. + * - In any case, no extra checks need to be performed, the possibility of + * data loss is kept very low, and the possibility of data corruption + * (which would, in this scheme, be undetected...) is (I think, for our + * purposes) vanishingly small. */ static uint8_t compress(void) { uint8_t ret; // for function return codes (to test for errors) void * to_overwrite; // the first byte with a value we don't need to keep - void * to_compress; // the first byte of the data we need to keep + void * to_compress; // the first byte of the data we do need to keep void * next; // the next macro after the data to keep (usually) uint8_t type; // the type of the first macro in `to_compress` void * type_location; // the final location of this `type` byte in EEMEM to_overwrite = find_next_deleted(EEMEM_MACROS_START); - if (! to_overwrite) - return 0; // success: nothing to compress + if (! to_overwrite) return 0; // success: nothing to compress - // set `next` to a value that works when we enter the loop - // - on the first iteration, `find_next_nondeleted(next)` will return - // quickly, so this doesn't waste much time - // - since writes to the EEPROM are delayed, we could just set `next = - // to_overwrite`; but it's nicer to write things so they would work even - // if writes were immediate. - next = find_next_nondeleted(to_overwrite); + // - here `next` is the next macro to consider keeping + // - we could set `next = to_overwrite`, but then this would depend on + // writes being delayed + next = to_overwrite + eeprom__read(to_overwrite+1); + // invalidate the portion of the EEPROM we'll be working on ret = eeprom__write(to_overwrite, TYPE_END); if (ret) return 1; // write failed; data unchanged - while (next < end_macro) { + while (next <= end_macro) { to_compress = find_next_nondeleted(next); // `next` will always be 1 byte beyond the data we wish to copy // - since the EEPROM is only 2^10 bytes, and pointers are 16 bits, we // don't have to worry about overflow next = find_next_deleted(to_compress); - if (! next) - next = new_end_macro; - if (! next) - next = end_macro+1; + if (! next) next = new_end_macro; + if (! next) next = end_macro+1; + // save the `type` so we can write it last type = eeprom__read(to_compress); type_location = to_overwrite; to_overwrite++; @@ -621,20 +613,25 @@ static uint8_t compress(void) { length = UINT8_MAX; ret = eeprom__copy(to_overwrite, to_compress, length); - if (ret) goto out; + if (ret) goto out; // write failed; data lost to_overwrite += length; to_compress += length; } - if (next < end_macro) { + // invalidate the portion of the EEPROM we'll be working on next + // - no need to do this if there's nothing more to compress + if (next <= end_macro) { ret = eeprom__write(to_overwrite, TYPE_END); - if (ret) goto out; + if (ret) goto out; // write failed; data lost } + // lastly, write the `type` we saved earlier + // (revalidate the portion of the EEPROM we're done with) ret = eeprom__write(type_location, type); - if (ret) goto out; + if (ret) goto out; // write failed; data lost } + // update state variables if (new_end_macro) { end_macro -= (new_end_macro-to_overwrite); new_end_macro = to_overwrite; @@ -645,10 +642,8 @@ static uint8_t compress(void) { return 0; // success: compression finished out: - end_macro = type_location; new_end_macro = 0; - return 2; // write failed; data lost } From c5afdb9659a4935eb71df38f9ce58739ecb928ac Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Tue, 27 May 2014 15:44:31 -0700 Subject: [PATCH 19/32] (working: eeprom-macro: looked over public functions) almost done with this module! --- firmware/lib/layout/eeprom-macro.h | 12 ++--- firmware/lib/layout/eeprom-macro/atmega32u4.c | 53 +++++++++++++------ 2 files changed, 44 insertions(+), 21 deletions(-) diff --git a/firmware/lib/layout/eeprom-macro.h b/firmware/lib/layout/eeprom-macro.h index 7667321b..afe55133 100644 --- a/firmware/lib/layout/eeprom-macro.h +++ b/firmware/lib/layout/eeprom-macro.h @@ -168,7 +168,7 @@ uint8_t eeprom_macro__clear_all (void); * * Returns: * - success: `0` - * - failure: [other] (not enough memory left to record) + * - failure: [other] * * Notes: * - Only one macro may be recorded at a time. If another macro is being @@ -193,11 +193,11 @@ uint8_t eeprom_macro__clear_all (void); * * Returns: * - success: `0` - * - failure: [other] (not enough memory left to record) + * - failure: [other] * * Notes: - * - If this function fails, the current key-action may be canceled (thrown - * away). + * - If this function fails, the macro currently being written may be canceled + * (thrown away). */ // === eeprom_macro__record_finalize() === @@ -213,8 +213,8 @@ uint8_t eeprom_macro__clear_all (void); * written) should not be readable, or referenced anywhere in the EEPROM. * * Notes: - * - If this function fails, the current key-action may be canceled (thrown - * away). + * - If this function fails, the macro currently being written may be canceled + * (thrown away). */ // === eeprom_macro__record_cancel() === diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index 3f82d7cc..fb6a3017 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -9,6 +9,29 @@ * the ATMega32U4 * * + * Warnings: + * + * - A worst case `compress()` operation might take too much memory. Not sure + * what (if anything) to do about this right now. + * - Max EEPROM space for macros: 1024-5 = 1019 bytes + * - Min space for a macro: 5 bytes + * - Approximate space for a copy object in ".../lib/eeprom": 5 bytes + * - Worst case would be EEMEM filled with the smallest possible macros, + * alternating between valid and deleted. This would give us 1019/5/2 ~= + * 100 noncontiguous deleted macros, which would be about as many copy + * objects (plus a few write objects) in ".../lib/eeprom", so about 500 + * bytes. SRAM is 2kB. Because of the way ".../lib/eeprom" is written, + * much of this data would have to be contiguous. + * - At some point, I should probably consider changing how + * ".../lib/eeprom" (and the layer-stack code, and everything else that + * needs a variable amount of memory) manages its memory. Again, not + * quite sure how, at the moment. For common cases, the current solution + * might be sufficient. + * - If this turns out to be a problem, the easiest solution (at the + * expense of extra EEPROM wear in lower memory locations) would probably + * be to simply call `compress()` more often. + * + * * Implementation notes: * * - The default state (the "erased" state) of this EEPROM is all `1`s, which @@ -278,11 +301,13 @@ void * end_macro; * The EEMEM address of where to write the next byte of a macro in progress (or * `0` if no macro is in progress) * + * Mnemonic: + * - This macro will become the new `end_macro` when the macro currently being + * written is finalized. + * * Note: * - This variable should be the primary indicator of whether a macro is in * progress or not. - * - When a macro is finalized, this byte will be written with the value - * `TYPE_END`, and become the new `end_macro`; hence the name. */ void * new_end_macro; @@ -711,10 +736,6 @@ static inline uint8_t delete_macro_if_exists(key_action_t * k) { // ---------------------------------------------------------------------------- // public functions ----------------------------------------------------------- -// TODO: go over all these, and make sure they conform to the header -// documentation (and that they work properly; i'm pretty sure some don't; but -// this is hopefully a good start :) ). - /** functions/eeprom_macro__init/description * Implementation notes: * - The initialization of static EEPROM values that this function is supposed @@ -732,10 +753,11 @@ uint8_t eeprom_macro__init(void) { TEST( EEMEM_END_ADDRESS_START, 0, (uint16_t)EEMEM_END >> 8 ); TEST( EEMEM_END_ADDRESS_START, 1, (uint16_t)EEMEM_END & 0xFF ); - TEST( EEMEM_VERSION_START, 0, (uint16_t)VERSION ); + TEST( EEMEM_VERSION_START, 0, VERSION ); #undef TEST + // find the end macro void * current = EEMEM_MACROS_START; for ( uint8_t type = eeprom__read(current); type != TYPE_END; @@ -785,14 +807,14 @@ uint8_t eeprom_macro__record_init( bool pressed, * least 4 bytes left before exceeding that limit (since 4 bytes is the * maximum length of a key-action), we simply stop recording actions. This * is certainly not optimal behavior... but I think it'll end up being the - * least surprising (where our other options are to either finalize the - * macro, or return an error code). - * - If long macros were desired, there are several ways one might modify + * least surprising, where our other options are to either finalize the + * macro, or return an error code. + * - If longer macros are desired, there are several ways one might modify * the implementation to allow them. The simplest method would be to * make `length` a 2 byte variable. That would reduce the number of * small macros one could have, however. Alternately, one could steal 2 - * bits from the `type` byte, which would save space, but be more - * difficult to read. Another method would be to introduce a + * bits from the `type` byte, which would save space, but make things + * more difficult to read. Another method would be to introduce a * `TYPE_CONTINUED`, or something similar, where the data section of a * macro of this type would continue the data section of the previous * macro. That would make the logic of recording macros (and playing @@ -858,7 +880,8 @@ uint8_t eeprom_macro__play( bool pressed, k_location += 2; while (length) { uint8_t read = read_key_action(k_location, &k); - // TODO: kb__layout__exec_key_layer() // function not written yet +// // TODO: function not written yet +// kb__layout__exec_key_layer() length -= read; k_location += read; } @@ -914,9 +937,9 @@ uint8_t eeprom_macro__clear_all(void) { WRITE( EEMEM_END_ADDRESS_START, 0, (uint16_t)EEMEM_END >> 8 ); WRITE( EEMEM_END_ADDRESS_START, 1, (uint16_t)EEMEM_END & 0xFF ); - WRITE( EEMEM_VERSION_START, 0, (uint16_t)VERSION ); + WRITE( EEMEM_VERSION_START, 0, VERSION ); - WRITE( EEMEM_MACROS_START, 0, (uint16_t)TYPE_END ); + WRITE( EEMEM_MACROS_START, 0, TYPE_END ); #undef WRITE From 74c685a8b42c2a1d3bda6f3e373f9a5541ab50cc Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Tue, 27 May 2014 21:42:01 -0700 Subject: [PATCH 20/32] fixing up the ...exec_key...() functions just need to implement eeprom_macro's in a layout now, to test them! --- doc/references.md | 8 +- firmware/keyboard.h | 29 ++++- .../ergodox/layout/fragments/includes.part.h | 1 + .../layout/fragments/matrix-control.part.h | 115 ++++++++++++------ .../ergodox/layout/fragments/variables.part.h | 27 ++-- firmware/lib/layout/eeprom-macro.h | 2 +- firmware/lib/layout/eeprom-macro/atmega32u4.c | 5 +- firmware/lib/timer.h | 2 +- 8 files changed, 135 insertions(+), 54 deletions(-) diff --git a/doc/references.md b/doc/references.md index b9ab23e5..5b71e56b 100644 --- a/doc/references.md +++ b/doc/references.md @@ -145,7 +145,11 @@ * [Why do we need C Unions?] (http://stackoverflow.com/questions/252552/why-do-we-need-c-unions) - Some good examples of what Unions are good for. + Some examples of what unions are good for. + +* [Using and Abusing Unions] + (http://critical.eschertech.com/2010/03/12/using-and-abusing-unions/) + A good discussion on when to use unions and when not to. * [C preprocessor, recursive macros] (http://stackoverflow.com/questions/5641836/c-preprocessor-recursive-macros) @@ -728,7 +732,7 @@ ------------------------------------------------------------------------------- -Copyright © 2012, 2013 Ben Blazak +Copyright © 2012, 2013, 2014 Ben Blazak Released under The MIT License (see "doc/licenses/MIT.md") Project located at diff --git a/firmware/keyboard.h b/firmware/keyboard.h index dd2ab739..853eda09 100644 --- a/firmware/keyboard.h +++ b/firmware/keyboard.h @@ -1,5 +1,5 @@ /* ---------------------------------------------------------------------------- - * Copyright (c) 2012 Ben Blazak + * Copyright (c) 2012, 2014 Ben Blazak * Released under The MIT License (see "doc/licenses/MIT.md") * Project located at * ------------------------------------------------------------------------- */ @@ -57,7 +57,13 @@ void kb__led__delay__usb_init (void); void kb__led__logical_on (char led); void kb__led__logical_off (char led); // ------- -void kb__layout__exec_key (bool pressed, uint8_t row, uint8_t column); +void kb__layout__exec_key ( bool pressed, + uint8_t row, + uint8_t column ); +void kb__layout__exec_key_layer ( bool pressed, + uint8_t layer, + uint8_t row, + uint8_t column ); // ---------------------------------------------------------------------------- @@ -280,3 +286,22 @@ void kb__layout__exec_key (bool pressed, uint8_t row, uint8_t column); * etc. from `main()`. */ +// === kb__layout__exec_key_layer === +/** functions/kb__layout__exec_key_layer/description + * Perform the appropriate actions for a "press" or "release" of the key at the + * given position, on the given layer. + * + * Arguments: + * - `pressed`: + * - `true`: Indicates that the key to be "executed" has been pressed + * - `false`: Indicates that the key to be "executed" has been released + * - `layer`: The layer of the key to be "executed" + * - `row`: The row of the key to be "executed" + * - `column`: The column of the key to be "executed" + * + * Notes: + * - If the implementation does not support layers, the `layer` argument should + * be ignored, and this function will be equivalent to + * `kb__layout__exec_key()`. + */ + diff --git a/firmware/keyboard/ergodox/layout/fragments/includes.part.h b/firmware/keyboard/ergodox/layout/fragments/includes.part.h index f80080e4..8cf49234 100644 --- a/firmware/keyboard/ergodox/layout/fragments/includes.part.h +++ b/firmware/keyboard/ergodox/layout/fragments/includes.part.h @@ -20,6 +20,7 @@ #include "../../../../../firmware/lib/timer.h" #include "../../../../../firmware/lib/usb.h" #include "../../../../../firmware/lib/usb/usage-page/keyboard.h" +#include "../../../../../firmware/lib/layout/eeprom-macro.h" #include "../../../../../firmware/lib/layout/key-functions.h" #include "../../../../../firmware/lib/layout/layer-stack.h" #include "../../../../../firmware/keyboard.h" diff --git a/firmware/keyboard/ergodox/layout/fragments/matrix-control.part.h b/firmware/keyboard/ergodox/layout/fragments/matrix-control.part.h index 688e4223..cb548984 100644 --- a/firmware/keyboard/ergodox/layout/fragments/matrix-control.part.h +++ b/firmware/keyboard/ergodox/layout/fragments/matrix-control.part.h @@ -12,55 +12,63 @@ */ +/** functions/kb__layout__exec_key/description + * Assumptions: + * - All arguments are valid. + * + * Implementation notes: + * - The default layer is layer 0. + * - This function is only responsible for layer resolution (which includes the + * handling of transparent keys). Everything else, it passes to + * `kb__layout__exec_key_layer()`. + */ void kb__layout__exec_key(bool pressed, uint8_t row, uint8_t column) { - // if we press a key, we need to keep track of the layer it was pressed on, - // so we can release it on the same layer - // - if the release is transparent, search through the layer stack for a - // non-transparent release in the same position, as normal + // - to keep track of the layer a key was pressed on, so we can release on + // the same layer static uint8_t pressed_layer[OPT__KB__ROWS][OPT__KB__COLUMNS]; - void (*function)(void); uint8_t layer; + void (*function)(void); - // - add 1 to the stack size because we spend the first iteration checking - // to see if we need to release on a previously stored layer - // - add 1 to the stack size in order to peek out of bounds on the last - // iteration (if we get that far), so that layer 0 is our default (see - // the documentation for ".../firmware/lib/layout/layer-stack.h") - for (uint8_t i=0; i < layer_stack__size()+1+1; i++) { // i = offset+1 - if (i == 0) - if (!pressed) - layer = pressed_layer[row][column]; - else - continue; - else - layer = layer_stack__peek(i-1); + // handle the case that a key is released, and the layer it was pressed on + // has a non-transparent release function in the given location + if (! pressed) { + layer = pressed_layer[row][column]; function = (void (*)(void)) - pgm_read_word( &( layout[ layer ] - [ row ] - [ column ] - [ (pressed) ? 0 : 1 ] ) ); - - if (function == &KF(transp)) - function = NULL; + pgm_read_word( &( layout[ layer ] + [ row ] + [ column ] + [ !pressed ] ) ); - if (function) { - if (pressed) - pressed_layer[row][column] = layer; + if (function != &KF(transp)) { + kb__layout__exec_key_layer( pressed, layer, row, column ); + return; + } + } - flags.tick_keypresses = (pressed) ? true : false; // set default + // otherwise, search through the layer stack for a layer with a + // non-transparent key-function in the given location - (*function)(); + // - altogether, unless we find a non-transparent key-function earlier, we + // want to peek at offsets `0` through `layer_stack__size()`. this will + // cause us to peek out of bounds on the last iteration, so that layer 0 + // will be the default (see the documentation for + // ".../lib/layout/layer-stack") + for (uint8_t i=0; i <= layer_stack__size(); i++) { + layer = layer_stack__peek(i); + function = (void (*)(void)) + pgm_read_word( &( layout[ layer ] + [ row ] + [ column ] + [ !pressed ] ) ); - // TODO: *always* tick keypresses - // TODO: instead of this, set a flag for the type of key pressed, - // and any functions that execute can check it, and conditionally - // reschedule themselves to run later, if they so desire - if (flags.tick_keypresses) - timer___tick_keypresses(); + if (function != &KF(transp)) { + if (pressed) + pressed_layer[row][column] = layer; + kb__layout__exec_key_layer( pressed, layer, row, column ); return; } } @@ -68,3 +76,38 @@ void kb__layout__exec_key(bool pressed, uint8_t row, uint8_t column) { // if we get here, there was a transparent key in layer 0; do nothing } +/** functions/kb__layout__exec_key_layer/description + * Assumptions: + * - All arguments are valid. + * + * TODO: + * - take care of the recording and such of macros :) + */ +void kb__layout__exec_key_layer( bool pressed, + uint8_t layer, + uint8_t row, + uint8_t column ) { + + void (*function)(void) = (void (*)(void)) + pgm_read_word( &( layout[ layer ] + [ row ] + [ column ] + [ !pressed ] ) ); + if (! function) return; + + // set default values + // - the key-function will not be able to see the values set previously + // - any function scheduled to run will be able to see the values set + // previously; but that may change in the future, so it shouldn't be + // relied on. if functions need to communicate with each other, they + // should share a file-local or global variable. + flags.key_type.sticky = false; + flags.key_type.layer_shift = false; + flags.key_type.layer_lock = false; + + (*function)(); + + if (pressed) + timer___tick_keypresses(); +} + diff --git a/firmware/keyboard/ergodox/layout/fragments/variables.part.h b/firmware/keyboard/ergodox/layout/fragments/variables.part.h index 4d95ae2a..f9f35f29 100644 --- a/firmware/keyboard/ergodox/layout/fragments/variables.part.h +++ b/firmware/keyboard/ergodox/layout/fragments/variables.part.h @@ -20,17 +20,24 @@ static layout_t layout PROGMEM; /** variables/flags/description * A collection of flags pertaining to the operation of `...exec_key()` * + * Notes: + * - These should be set within key-functions, but only read inside + * `...exec_key()`. The ability to read them outside that function should + * not be counted on. + * * Struct members: - * - `tick_keypresses`: A predicate indicating whether or not to "tick" - * keypresses on this run of the function (see the documentation in - * ".../firmware/lib/timer.h" for more precisely what this means) - * - This is useful for defining things like sticky keys, if, e.g., you - * want to make it so that you can press more than one and have none of - * them release until the press of the next normal key. + * - `key_type`: To indicate the type of key most recently pressed + * - More than one type flag may be set (e.g. a key may be both a + * layer-shift key and a sticky key). + * - `key_type.sticky` + * - `key_type.layer_shift` + * - `key_type.layer_lock` */ static struct { - bool tick_keypresses : 1; -} flags = { - .tick_keypresses = true, -}; + struct { + bool sticky : 1; + bool layer_shift : 1; + bool layer_lock : 1; + } key_type; +} flags; diff --git a/firmware/lib/layout/eeprom-macro.h b/firmware/lib/layout/eeprom-macro.h index afe55133..45ef3c81 100644 --- a/firmware/lib/layout/eeprom-macro.h +++ b/firmware/lib/layout/eeprom-macro.h @@ -1,5 +1,5 @@ /* ---------------------------------------------------------------------------- - * Copyright (c) 2013 Ben Blazak + * Copyright (c) 2013, 2014 Ben Blazak * Released under The MIT License (see "doc/licenses/MIT.md") * Project located at * ------------------------------------------------------------------------- */ diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index fb6a3017..e4e791d8 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -20,8 +20,9 @@ * alternating between valid and deleted. This would give us 1019/5/2 ~= * 100 noncontiguous deleted macros, which would be about as many copy * objects (plus a few write objects) in ".../lib/eeprom", so about 500 - * bytes. SRAM is 2kB. Because of the way ".../lib/eeprom" is written, - * much of this data would have to be contiguous. + * bytes. SRAM is 2560 bytes (per the PJRC website). Because of the way + * ".../lib/eeprom" is written, much of this data would have to be + * contiguous. * - At some point, I should probably consider changing how * ".../lib/eeprom" (and the layer-stack code, and everything else that * needs a variable amount of memory) manages its memory. Again, not diff --git a/firmware/lib/timer.h b/firmware/lib/timer.h index b371ef71..ee7341eb 100644 --- a/firmware/lib/timer.h +++ b/firmware/lib/timer.h @@ -190,7 +190,7 @@ void timer___tick_keypresses (void); // === timer___tick_keypresses() === /** functions/timer___tick_keypresses/description - * Increment the counter for the number of keypresses, and perform scheduled + * Increment the counter for the number of key-presses, and perform scheduled * tasks * * Meant to be used only by `kb__layout__exec_key()` From f980028d82c1965f756c7dcc2a25eb8f53224cd9 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Tue, 27 May 2014 23:05:00 -0700 Subject: [PATCH 21/32] cleaned up a bit; minor bugfix --- firmware/keyboard.h | 2 +- firmware/keyboard/ergodox/layout/test.c | 3 --- firmware/keyboard/ergodox/led.c | 11 ++++++-- firmware/lib/layout/eeprom-macro/atmega32u4.c | 3 +-- firmware/lib/twi/atmega32u4.c | 9 +++---- firmware/main.c | 25 ++++++++++++------- 6 files changed, 30 insertions(+), 23 deletions(-) diff --git a/firmware/keyboard.h b/firmware/keyboard.h index 853eda09..c34cc2e8 100644 --- a/firmware/keyboard.h +++ b/firmware/keyboard.h @@ -227,7 +227,7 @@ void kb__layout__exec_key_layer ( bool pressed, // === kb__led__delay__error() === /** functions/kb__led__delay__error/description - * Signal a generic error (delays for a total of ~1 second) + * Signal a generic error */ // === kb__led__delay__usb_init() === diff --git a/firmware/keyboard/ergodox/layout/test.c b/firmware/keyboard/ergodox/layout/test.c index e6b5e341..cc9f9d2e 100644 --- a/firmware/keyboard/ergodox/layout/test.c +++ b/firmware/keyboard/ergodox/layout/test.c @@ -8,9 +8,6 @@ * A layout for testing newly build boards * * Implements the "layout" section of '.../firmware/keyboard.h' - * - * TODO: - * - update, if i change the semantics `kb__layout__exec_key()` */ diff --git a/firmware/keyboard/ergodox/led.c b/firmware/keyboard/ergodox/led.c index 42d586fb..33e9da5e 100644 --- a/firmware/keyboard/ergodox/led.c +++ b/firmware/keyboard/ergodox/led.c @@ -1,5 +1,5 @@ /* ---------------------------------------------------------------------------- - * Copyright (c) 2013 Ben Blazak + * Copyright (c) 2013, 2014 Ben Blazak * Released under The MIT License (see "doc/licenses/MIT.md") * Project located at * ------------------------------------------------------------------------- */ @@ -112,13 +112,20 @@ void kb__led__state__ready(void) { } void kb__led__delay__error(void) { + // make sure LED states have stabilized + // - i'm not quite sure how long this takes; i would think it'd be nearly + // instant, but a bit of testing seemed to show that even 5ms isn't quite + // long enough; 10ms seems to work; at least we can afford the time here + _delay_ms(10); + struct led_state state = { .led_1 = kb__led__read(1), .led_2 = kb__led__read(2), .led_3 = kb__led__read(3), }; - // delay for a total of ~1 second + kb__led__all_off(); + _delay_ms(167); kb__led__all_on(); _delay_ms(167); kb__led__all_off(); diff --git a/firmware/lib/layout/eeprom-macro/atmega32u4.c b/firmware/lib/layout/eeprom-macro/atmega32u4.c index e4e791d8..e9d73ca1 100644 --- a/firmware/lib/layout/eeprom-macro/atmega32u4.c +++ b/firmware/lib/layout/eeprom-macro/atmega32u4.c @@ -881,8 +881,7 @@ uint8_t eeprom_macro__play( bool pressed, k_location += 2; while (length) { uint8_t read = read_key_action(k_location, &k); -// // TODO: function not written yet -// kb__layout__exec_key_layer() + kb__layout__exec_key_layer( k.pressed, k.layer, k.row, k.column ); length -= read; k_location += read; } diff --git a/firmware/lib/twi/atmega32u4.c b/firmware/lib/twi/atmega32u4.c index 10bfaa01..3e92d68a 100644 --- a/firmware/lib/twi/atmega32u4.c +++ b/firmware/lib/twi/atmega32u4.c @@ -28,18 +28,15 @@ // ---------------------------------------------------------------------------- -#if OPT__TWI__FREQUENCY > 400000 - #error "OPT__TWI__FREQUENCY must be <= 400000" -#endif /** macros/OPT__TWI__FREQUENCY/description * Implementation notes: * - The max speed for the ATmega32U4 is 400kHz (datasheet sec. 20.1) * - The max speed for the MCP23017 is 1.7MHz (datasheet pg. 1) * - The max speed for the MCP23018 is 3.4MHz (datasheet pg. 1) - * - * TODO: do these implementation notes belong in the keyboard "options.h", - * where they're set? */ +#if OPT__TWI__FREQUENCY > 400000 + #error "OPT__TWI__FREQUENCY must be <= 400000" +#endif // ---------------------------------------------------------------------------- diff --git a/firmware/main.c b/firmware/main.c index c658aee6..e518a6fd 100644 --- a/firmware/main.c +++ b/firmware/main.c @@ -1,5 +1,5 @@ /* ---------------------------------------------------------------------------- - * Copyright (c) 2013 Ben Blazak + * Copyright (c) 2013, 2014 Ben Blazak * Released under The MIT License (see "doc/licenses/MIT.md") * Project located at * ------------------------------------------------------------------------- */ @@ -73,18 +73,25 @@ int main(void) { static uint8_t time_scan_started; - if (kb__init()) kb__led__delay__error(); // initialize hardware (besides - // USB and timer) + { + // initialize everything; signal an error (at the end) if one occurs - kb__led__state__power_on(); + bool error; - if (usb__init()) kb__led__delay__error(); - while (!usb__is_configured()); - kb__led__delay__usb_init(); // give the OS time to load drivers, etc. + error = kb__init(); // initialize hardware (besides USB and timer) - if (timer__init()) kb__led__delay__error(); + kb__led__state__power_on(); - kb__led__state__ready(); + error |= usb__init(); + while (!usb__is_configured()); + kb__led__delay__usb_init(); // give the OS time to load drivers, etc. + + error |= timer__init(); + + kb__led__state__ready(); + + if (error) kb__led__delay__error(); + } time_scan_started // on the first iteration, scan immediately = timer__get_milliseconds() - OPT__DEBOUNCE_TIME; From 5e931a7481d72268ed87130d50b638579c042d98 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Thu, 29 May 2014 23:16:44 -0700 Subject: [PATCH 22/32] starting an experiment with a layout generator this will likely be in development for a long time, if it ever amounts to anything at all --- layout-gen/main.elm | 28 ++++++++++++++++++++++++++++ layout-gen/readme.md | 6 ++++++ 2 files changed, 34 insertions(+) create mode 100644 layout-gen/main.elm create mode 100644 layout-gen/readme.md diff --git a/layout-gen/main.elm b/layout-gen/main.elm new file mode 100644 index 00000000..2e8cfde7 --- /dev/null +++ b/layout-gen/main.elm @@ -0,0 +1,28 @@ +import Window + + +lightLightBlue : Color +lightLightBlue = rgba 114 159 207 0.5 -- lightBlue with alpha=0.5 + + +main : Signal Element +main = background <~ Window.dimensions + + +background : (Int, Int) -> Element +background (w,h) = + let (xMax, yMax) = (toFloat w / 2, toFloat h / 2) + vtLine color = segment (0, -yMax) (0, yMax) |> traced (dashed color) + htLine color = segment (-xMax, 0) (xMax, 0) |> traced (dashed color) + vLineOffsets space = [floor (-xMax/space)..floor (xMax/space)] + hLineOffsets space = [floor (-yMax/space)..floor (yMax/space)] + in color lightGray <| collage w h ( + vtLine black :: htLine black :: + (map (\x -> vtLine (if mod x 2 == 1 then lightBlue else lightLightBlue) + |> move (toFloat x * 35, 0)) + (vLineOffsets 35)) ++ + (map (\y -> htLine (if mod y 2 == 1 then lightBlue else lightLightBlue) + |> move (0, toFloat y * 35)) + (hLineOffsets 35)) + ) + diff --git a/layout-gen/readme.md b/layout-gen/readme.md new file mode 100644 index 00000000..f66c800b --- /dev/null +++ b/layout-gen/readme.md @@ -0,0 +1,6 @@ +This might eventually become a layout generator :) . Until then, it's an +experiment. + +## TODO: +- update readme with useful information (once we've gotten anywhere) + From c32f396e312dfb84f68e65b9bb3fee8ff82a3699 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Fri, 30 May 2014 02:04:58 -0700 Subject: [PATCH 23/32] background's just about done! :) --- layout-gen/.gitignore | 3 +++ layout-gen/main.elm | 62 ++++++++++++++++++++++++++++++------------- 2 files changed, 46 insertions(+), 19 deletions(-) create mode 100644 layout-gen/.gitignore diff --git a/layout-gen/.gitignore b/layout-gen/.gitignore new file mode 100644 index 00000000..daf9c8fe --- /dev/null +++ b/layout-gen/.gitignore @@ -0,0 +1,3 @@ +build/ +cache/ + diff --git a/layout-gen/main.elm b/layout-gen/main.elm index 2e8cfde7..513ad9d7 100644 --- a/layout-gen/main.elm +++ b/layout-gen/main.elm @@ -1,28 +1,52 @@ import Window -lightLightBlue : Color -lightLightBlue = rgba 114 159 207 0.5 -- lightBlue with alpha=0.5 +-- our grid's aspect ratio +aspectRatio : (Int, Int) +aspectRatio = (3,2) +-- to scale our aspect ratio +aspectScale : Int +aspectScale = 7 +-- the number of columns in our grid +columns : Int +columns = aspectScale * (fst aspectRatio) +-- the number of rows in our grid +rows : Int +rows = aspectScale * (snd aspectRatio) -main : Signal Element -main = background <~ Window.dimensions +-- to generate various transparencies of lightBlue +lightBlueN : Float -> Color +lightBlueN n = rgba 114 159 207 (1/n) +-- TODO: document what i mean by (x,y) (after i figure it out) background : (Int, Int) -> Element -background (w,h) = - let (xMax, yMax) = (toFloat w / 2, toFloat h / 2) - vtLine color = segment (0, -yMax) (0, yMax) |> traced (dashed color) - htLine color = segment (-xMax, 0) (xMax, 0) |> traced (dashed color) - vLineOffsets space = [floor (-xMax/space)..floor (xMax/space)] - hLineOffsets space = [floor (-yMax/space)..floor (yMax/space)] - in color lightGray <| collage w h ( - vtLine black :: htLine black :: - (map (\x -> vtLine (if mod x 2 == 1 then lightBlue else lightLightBlue) - |> move (toFloat x * 35, 0)) - (vLineOffsets 35)) ++ - (map (\y -> htLine (if mod y 2 == 1 then lightBlue else lightLightBlue) - |> move (0, toFloat y * 35)) - (hLineOffsets 35)) - ) +background (width,height) = + let (w,h) = (toFloat width, toFloat height) + (r,c) = (toFloat rows, toFloat columns) + + step = min (w/c) (h/r) + + line (x,y) color offset = + segment (-x*w,-y*h) (x*w,y*h) |> traced (dashed color) + |> move (y*offset*step, x*offset*step) + lines (x,y) = + let dimension = if x == 0 then w else h + in map (\n -> line (x/2,y/2) + (lightBlueN <| toFloat (mod (n+1) 2 + 1) * 3) + (toFloat n)) + [floor (-dimension/step) .. floor (dimension/step)] + crossBox = [ line (0,1) charcoal 0, line (1,0) charcoal 0, + line (0,1) charcoal ( c/2), line (0,1) charcoal (-c/2), + line (1,0) charcoal ( r/2), line (1,0) charcoal (-r/2) ] + + in color lightGray <| collage width height ( + crossBox ++ + lines (0,1) ++ lines (1,0) + ) + + +main : Signal Element +main = background <~ Window.dimensions From f3635dc57912dc9426350cc75c95f6a1edbd07b0 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 31 May 2014 22:49:28 -0700 Subject: [PATCH 24/32] got it to draw the keyboard :) really slow --- {doc => firmware}/references.md | 0 layout-gen/Boards.elm | 214 ++++++++++++++++++++++++++++++++ layout-gen/main.elm | 157 +++++++++++++++++------ layout-gen/references.md | 27 ++++ 4 files changed, 363 insertions(+), 35 deletions(-) rename {doc => firmware}/references.md (100%) create mode 100644 layout-gen/Boards.elm create mode 100644 layout-gen/references.md diff --git a/doc/references.md b/firmware/references.md similarity index 100% rename from doc/references.md rename to firmware/references.md diff --git a/layout-gen/Boards.elm b/layout-gen/Boards.elm new file mode 100644 index 00000000..092fc94c --- /dev/null +++ b/layout-gen/Boards.elm @@ -0,0 +1,214 @@ +------------------------------------------------------------------------------- +-- Copyright (c) 2014 Ben Blazak +-- Released under The MIT License (see "doc/licenses/MIT.md") +-- Project located at +------------------------------------------------------------------------------- + +{-| Keyboard definitions +-} + + +module Boards where + + +------------------------------------------------------------------------------- +-- values +------------------------------------------------------------------------------- + + +{-| A list of the keyboards defined +-} +all : [Board] +all = [ ergodox ] + + +------------------------------------------------------------------------------- +-- types and default values +------------------------------------------------------------------------------- + + +{-| A type for keys in our keyboard + +Fields: +- `name`: The name of the key (so we can reference it) +- `size`: The width of the key (in multiples of the standard 1x1 key, which + takes up 1 grid block) +- `position`: The position of the center of the key on the grid, with `(0,0)` + being the top left of the board, positive x extending right, and positive y + extending down +- `rotation`: The rotation of the key (in degrees) +- `value`: A name corresponding to the assigned keycode for this key +- `configuration`: The configuration of the board to which this key belongs + - 0: This key belongs to all configurations +-} +type Key = { name: String + , size: Float + , position: (Float,Float) + , rotation: Float + , value: String + , configuration: Int + } + +defaultKey : Key +defaultKey = { name = "" + , size = 1 + , position = (0,0) + , rotation = 0 + , value = "" + , configuration = 0 + } + + +{-| A type for keyboards (`Keyboard` is already used, in Elm) + +Fields: +- `name`: The display name +- `size`: The horizontal and vertical size of the board, in grid squares +- `keys`: A list of keys, making up the keyboard +-} +type Board = { name: String + , size: (Float,Float) + , keys: [Key] + } + + +------------------------------------------------------------------------------- +-- board definitions +------------------------------------------------------------------------------- + + +{-| Definition for the ErgoDox Keyboard + +From the firmware source: + + /* left hand, spatial positions */ + k50,k51,k52,k53,k54,k55,k56, + k40,k41,k42,k43,k44,k45,k46, + k30,k31,k32,k33,k34,k35, + k20,k21,k22,k23,k24,k25,k26, + k10,k11,k12,k13,k14, + k05,k06, + k15,k16,k04, + k03,k02,k01, + + /* right hand, spatial positions * + k57,k58,k59,k5A,k5B,k5C,k5D, + k47,k48,k49,k4A,k4B,k4C,k4D, + k38,k39,k3A,k3B,k3C,k3D, + k27,k28,k29,k2A,k2B,k2C,k2D, + k19,k1A,k1B,k1C,k1D, + k07,k08, + k09,k17,k18, + k0C,k0B,k0A ) +-} + + +ergodox : Board +ergodox = { name = "ErgoDox", size = (18,8), keys = [ + + -- left hand, roughly from upper left to bottom right + + { defaultKey | name <- "k50", position <- (0.25,0), size <- 1.5 } + , { defaultKey | name <- "k51", position <- (1.5,0) } + , { defaultKey | name <- "k52", position <- (2.5,0) } + , { defaultKey | name <- "k53", position <- (3.5,0) } + , { defaultKey | name <- "k54", position <- (4.5,0) } + , { defaultKey | name <- "k55", position <- (5.5,0) } + , { defaultKey | name <- "k56", position <- (6.5,0) } + + , { defaultKey | name <- "k40", position <- (0.25,1), size <- 1.5 } + , { defaultKey | name <- "k41", position <- (1.5,1) } + , { defaultKey | name <- "k42", position <- (2.5,1) } + , { defaultKey | name <- "k43", position <- (3.5,1) } + , { defaultKey | name <- "k44", position <- (4.5,1) } + , { defaultKey | name <- "k45", position <- (5.5,1) } + , { defaultKey | name <- "k46", position <- (6.5,1.25), size <- 1.5, rotation <- 90 } + + , { defaultKey | name <- "k30", position <- (0.25,2), size <- 1.5 } + , { defaultKey | name <- "k31", position <- (1.5,2) } + , { defaultKey | name <- "k32", position <- (2.5,2) } + , { defaultKey | name <- "k33", position <- (3.5,2) } + , { defaultKey | name <- "k34", position <- (4.5,2) } + , { defaultKey | name <- "k35", position <- (5.5,2) } + + , { defaultKey | name <- "k20", position <- (0.25,3), size <- 1.5 } + , { defaultKey | name <- "k21", position <- (1.5,3) } + , { defaultKey | name <- "k22", position <- (2.5,3) } + , { defaultKey | name <- "k23", position <- (3.5,3) } + , { defaultKey | name <- "k24", position <- (4.5,3) } + , { defaultKey | name <- "k25", position <- (5.5,3) } + , { defaultKey | name <- "k26", position <- (6.5,2.75), size <- 1.5, rotation <- 90 } + + , { defaultKey | name <- "k10", position <- (0.5,4) } + , { defaultKey | name <- "k11", position <- (1.5,4) } + , { defaultKey | name <- "k12", position <- (2.5,4) } + , { defaultKey | name <- "k13", position <- (3.5,4) } + , { defaultKey | name <- "k14", position <- (4.5,4) } + + , { defaultKey | name <- "k05", position <- (6.5,5) } + , { defaultKey | name <- "k06", position <- (7.5,5) } + + , { defaultKey | name <- "k15", position <- (5.5,6), configuration <- 2 } + , { defaultKey | name <- "k16", position <- (6.5,6), configuration <- 2 } + , { defaultKey | name <- "k04", position <- (7.5,6) } + + , { defaultKey | name <- "k03", position <- (5.5,6.5), size <- 2, rotation <- 90, configuration <- 1 } + , { defaultKey | name <- "k02", position <- (6.5,6.5), size <- 2, rotation <- 90, configuration <- 1 } + , { defaultKey | name <- "k03", position <- (5.5,7), configuration <- 2 } + , { defaultKey | name <- "k02", position <- (6.5,7), configuration <- 2 } + , { defaultKey | name <- "k01", position <- (7.5,7) } + + -- right hand, roughly from upper left to bottom right + + , { defaultKey | name <- "k57", position <- (10.5,0) } + , { defaultKey | name <- "k58", position <- (11.5,0) } + , { defaultKey | name <- "k59", position <- (12.5,0) } + , { defaultKey | name <- "k5A", position <- (13.5,0) } + , { defaultKey | name <- "k5B", position <- (14.5,0) } + , { defaultKey | name <- "k5C", position <- (15.5,0) } + , { defaultKey | name <- "k5D", position <- (16.75,0), size <- 1.5 } + + , { defaultKey | name <- "k47", position <- (10.5,1.25), size <- 1.5, rotation <- -90 } + , { defaultKey | name <- "k48", position <- (11.5,1) } + , { defaultKey | name <- "k49", position <- (12.5,1) } + , { defaultKey | name <- "k4A", position <- (13.5,1) } + , { defaultKey | name <- "k4B", position <- (14.5,1) } + , { defaultKey | name <- "k4C", position <- (15.5,1) } + , { defaultKey | name <- "k4D", position <- (16.75,1), size <- 1.5 } + + , { defaultKey | name <- "k38", position <- (11.5,2) } + , { defaultKey | name <- "k39", position <- (12.5,2) } + , { defaultKey | name <- "k3A", position <- (13.5,2) } + , { defaultKey | name <- "k3B", position <- (14.5,2) } + , { defaultKey | name <- "k3C", position <- (15.5,2) } + , { defaultKey | name <- "k3D", position <- (16.75,2), size <- 1.5 } + + , { defaultKey | name <- "k27", position <- (10.5,2.75), size <- 1.5, rotation <- -90 } + , { defaultKey | name <- "k28", position <- (11.5,3) } + , { defaultKey | name <- "k29", position <- (12.5,3) } + , { defaultKey | name <- "k2A", position <- (13.5,3) } + , { defaultKey | name <- "k2B", position <- (14.5,3) } + , { defaultKey | name <- "k2C", position <- (15.5,3) } + , { defaultKey | name <- "k2D", position <- (16.75,3), size <- 1.5 } + + , { defaultKey | name <- "k19", position <- (12.5,4) } + , { defaultKey | name <- "k1A", position <- (13.5,4) } + , { defaultKey | name <- "k1B", position <- (14.5,4) } + , { defaultKey | name <- "k1C", position <- (15.5,4) } + , { defaultKey | name <- "k1D", position <- (16.5,4) } + + , { defaultKey | name <- "k07", position <- (9.5,5) } + , { defaultKey | name <- "k08", position <- (10.5,5) } + + , { defaultKey | name <- "k09", position <- (9.5,6) } + , { defaultKey | name <- "k17", position <- (10.5,6), configuration <- 2 } + , { defaultKey | name <- "k18", position <- (11.5,6), configuration <- 2 } + + , { defaultKey | name <- "k0C", position <- (9.5,7) } + , { defaultKey | name <- "k0B", position <- (10.5,6.5), size <- 2, rotation <- -90, configuration <- 1 } + , { defaultKey | name <- "k0A", position <- (11.5,6.5), size <- 2, rotation <- -90, configuration <- 1 } + , { defaultKey | name <- "k0B", position <- (10.5,7), configuration <- 2 } + , { defaultKey | name <- "k0A", position <- (11.5,7), configuration <- 2 } + + ]} + diff --git a/layout-gen/main.elm b/layout-gen/main.elm index 513ad9d7..2a931243 100644 --- a/layout-gen/main.elm +++ b/layout-gen/main.elm @@ -1,52 +1,139 @@ +------------------------------------------------------------------------------- +-- Copyright (c) 2014 Ben Blazak +-- Released under The MIT License (see "doc/licenses/MIT.md") +-- Project located at +------------------------------------------------------------------------------- + +{-| A web-based UI for generating keyboard layouts for the firmware +-} + + import Window +import Dict + +import Boards + +------------------------------------------------------------------------------- +-- values and signals +------------------------------------------------------------------------------- --- our grid's aspect ratio -aspectRatio : (Int, Int) -aspectRatio = (3,2) --- to scale our aspect ratio -aspectScale : Int -aspectScale = 7 +{-| The number of columns and rows in our grid --- the number of columns in our grid -columns : Int -columns = aspectScale * (fst aspectRatio) --- the number of rows in our grid -rows : Int -rows = aspectScale * (snd aspectRatio) +Notes: +- The list gives the aspect ratio (of width to height) +- The number gives the scale of the aspect ratio, relative to the window size +-} +[columns, rows] = map ((*) 5) [4,3] --- to generate various transparencies of lightBlue -lightBlueN : Float -> Color -lightBlueN n = rgba 114 159 207 (1/n) +{-| The edge length of a square in our grid +-} +edgeSignal : Signal Float +edgeSignal = + let function = \(width,height) -> min (toFloat width / columns) + (toFloat height / rows) + in lift function Window.dimensions --- TODO: document what i mean by (x,y) (after i figure it out) -background : (Int, Int) -> Element -background (width,height) = + +------------------------------------------------------------------------------- +-- groups of forms +------------------------------------------------------------------------------- + +background : (Int, Int) -> Float -> [Form] +background (width,height) edge = let (w,h) = (toFloat width, toFloat height) - (r,c) = (toFloat rows, toFloat columns) - step = min (w/c) (h/r) + ruleLines = True + lineStyle = dashed lightBlue + ruleLineStyle = dotted charcoal + + -- x and y represent the horizontal and vertical scaling factors + line (x,y) style offset = + segment (-x*w/2,-y*h/2) (x*w/2,y*h/2) + |> traced style + |> move (y*offset*edge, x*offset*edge) - line (x,y) color offset = - segment (-x*w,-y*h) (x*w,y*h) |> traced (dashed color) - |> move (y*offset*step, x*offset*step) lines (x,y) = let dimension = if x == 0 then w else h - in map (\n -> line (x/2,y/2) - (lightBlueN <| toFloat (mod (n+1) 2 + 1) * 3) - (toFloat n)) - [floor (-dimension/step) .. floor (dimension/step)] - crossBox = [ line (0,1) charcoal 0, line (1,0) charcoal 0, - line (0,1) charcoal ( c/2), line (0,1) charcoal (-c/2), - line (1,0) charcoal ( r/2), line (1,0) charcoal (-r/2) ] + in map (\n -> line (x,y) lineStyle (toFloat n/2) + |> alpha (1 / (toFloat (mod (n+1) 2 + 1) * 3))) + [floor (-dimension/edge)*2 .. floor (dimension/edge)*2] + + vLines = lines (0,1) + hLines = lines (1,0) + + rLines = + let boxLine (x,y) offset = line (x,y) ruleLineStyle offset + in [ boxLine (0,1) (-columns/2), boxLine (1,0) (-rows/2) +-- , boxLine (0,1) 0, boxLine (1,0) 0 + , boxLine (0,1) (columns/2), boxLine (1,0) (rows/2) + ] + + in hLines ++ vLines ++ if ruleLines then rLines else [] + + +keyboardTestDraw : Float -> [Form] +keyboardTestDraw edge = + let lineStyle = + let temp = solid lightBlue + in { temp | width <- 5, cap <- Round, join <- Smooth } + + -- grab just 1 Board, and use only 1 configuration + keyboard = head <| filter (\n -> n.name == "ErgoDox") Boards.all + configuration = 1 + + -- s = scaling factor (from 1 square of the grid) + -- p = position of the center of the rectangle on the grid + formKey k = + let (sizeX, sizeY) = (k.size*edge, edge) + (posX, posY) = ((fst k.position)*edge, (snd k.position)*edge) + in map (move (posX, posY) . rotate (degrees k.rotation)) + [ rect sizeX sizeY |> outlined lineStyle + , toForm <| plainText k.name + ] + + -- convert positions to be relative to center of the page + keys = + let convertPosition (x,y) = ( x - (fst keyboard.size) / 2, + -y + (snd keyboard.size) / 2 ) + in map (\n -> { n | position <- convertPosition n.position }) + keyboard.keys + |> filter ( \n -> n.configuration == 0 + || n.configuration == configuration ) + + in foldl1 (++) (map formKey keys) + +-- leftHand = (map (\n -> ((1.5,1),(-8.25,8-n)))[0..3]) -- left 1.5x +-- ++ (map (\n -> ((1,1),(-7+n,8)))[0..5]) -- top 1x +-- ++ (map (\n -> ((1,1),(-7+n,7)))[0..4]) -- next 1x +-- ++ (map (\n -> ((1,1),(-7+n,6)))[0..4]) -- next 1x +-- ++ (map (\n -> ((1,1),(-7+n,5)))[0..4]) -- next 1x +-- ++ (map (\n -> ((1,1),(-8+n,4)))[0..4]) -- bottom 1x +-- ++ (map (\n -> ((1,1.5),(-2,6.75-n*1.5)))[0..1]) -- right 1.5x +-- ++ (map (\n -> ((1,2),(-3+n,1.5)))[0..1]) -- thumb 2x +-- ++ (map (\n -> ((1,1),(-2+n,3)))[0..1]) -- t thumb 1x +-- ++ (map (\n -> ((1,1),(-1-n,2)))[0..0]) -- m thumb 1x +-- ++ (map (\n -> ((1,1),(-1-n,1)))[0..0]) -- b thumb 1x +-- +-- rightHand = map (\((a,b),(c,d)) -> ((a,b),(-c,d))) leftHand +-- +-- in map (\((a,b),(c,d)) -> key (a,b) (c-0.5,d-3)) (leftHand ++ rightHand) + + +------------------------------------------------------------------------------- +-- putting it all together +------------------------------------------------------------------------------- - in color lightGray <| collage width height ( - crossBox ++ - lines (0,1) ++ lines (1,0) - ) +scene : (Int, Int) -> Float -> Element +scene (width,height) edge = + let backgroundColor = lightGray + in layers [ collage width height [] |> color backgroundColor + , collage width height (background (width,height) edge) + , collage width height (keyboardTestDraw edge) + ] main : Signal Element -main = background <~ Window.dimensions +main = scene <~ Window.dimensions ~ edgeSignal diff --git a/layout-gen/references.md b/layout-gen/references.md new file mode 100644 index 00000000..f8287a04 --- /dev/null +++ b/layout-gen/references.md @@ -0,0 +1,27 @@ +## Elm Stuff + +* [Official Documentation] + (http://elm-lang.org) + + * [Standard Libaries] + (http://library.elm-lang.org/catalog/elm-lang-Elm/0.12.3/) + * [Examples] + (http://elm-lang.org/Examples.elm) + * [Syntax: a Quick Tour] + (http://elm-lang.org/learn/Syntax.elm) + * [Types] + (http://elm-lang.org/learn/Getting-started-with-Types.elm) + * [Changes in Elm 0.10] + (http://elm-lang.org/blog/announce/0.10.elm) + +* [What does the “Just” syntax mean in Haskell?] + (http://stackoverflow.com/questions/18808258/what-does-the-just-syntax-mean-in-haskell/18809252#18809252) + Haskell is very similar to Elm in some ways, so I think this applies. + + +------------------------------------------------------------------------------- + +Copyright © 2014 Ben Blazak +Released under The MIT License (see "doc/licenses/MIT.md") +Project located at + From 203cb66b2621b9a9b58d5736e6edac2c07073698 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sat, 31 May 2014 22:53:50 -0700 Subject: [PATCH 25/32] small cleanup; gonna try javascript --- layout-gen/main.elm | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/layout-gen/main.elm b/layout-gen/main.elm index 2a931243..0533e06d 100644 --- a/layout-gen/main.elm +++ b/layout-gen/main.elm @@ -104,22 +104,6 @@ keyboardTestDraw edge = in foldl1 (++) (map formKey keys) --- leftHand = (map (\n -> ((1.5,1),(-8.25,8-n)))[0..3]) -- left 1.5x --- ++ (map (\n -> ((1,1),(-7+n,8)))[0..5]) -- top 1x --- ++ (map (\n -> ((1,1),(-7+n,7)))[0..4]) -- next 1x --- ++ (map (\n -> ((1,1),(-7+n,6)))[0..4]) -- next 1x --- ++ (map (\n -> ((1,1),(-7+n,5)))[0..4]) -- next 1x --- ++ (map (\n -> ((1,1),(-8+n,4)))[0..4]) -- bottom 1x --- ++ (map (\n -> ((1,1.5),(-2,6.75-n*1.5)))[0..1]) -- right 1.5x --- ++ (map (\n -> ((1,2),(-3+n,1.5)))[0..1]) -- thumb 2x --- ++ (map (\n -> ((1,1),(-2+n,3)))[0..1]) -- t thumb 1x --- ++ (map (\n -> ((1,1),(-1-n,2)))[0..0]) -- m thumb 1x --- ++ (map (\n -> ((1,1),(-1-n,1)))[0..0]) -- b thumb 1x --- --- rightHand = map (\((a,b),(c,d)) -> ((a,b),(-c,d))) leftHand --- --- in map (\((a,b),(c,d)) -> key (a,b) (c-0.5,d-3)) (leftHand ++ rightHand) - ------------------------------------------------------------------------------- -- putting it all together From 620221bd20c3cbc0ed2ffdebf8d6e2c94781cde4 Mon Sep 17 00:00:00 2001 From: Ben Blazak Date: Sun, 1 Jun 2014 01:50:24 -0700 Subject: [PATCH 26/32] ui: going to try using elm a bit differently --- layout-gen/references.md | 22 + layout-gen/{ => test-elm-0}/Boards.elm | 0 layout-gen/{ => test-elm-0}/main.elm | 0 layout-gen/test-elm-1/main.elm | 0 layout-gen/test-js/index.html | 14 + layout-gen/test-js/lib/jquery-2.0.0.js | 8755 ++++++++++++++++++++++++ layout-gen/test-js/lib/raphael.js | 8117 ++++++++++++++++++++++ layout-gen/test-js/main.js | 13 + 8 files changed, 16921 insertions(+) rename layout-gen/{ => test-elm-0}/Boards.elm (100%) rename layout-gen/{ => test-elm-0}/main.elm (100%) create mode 100644 layout-gen/test-elm-1/main.elm create mode 100644 layout-gen/test-js/index.html create mode 100644 layout-gen/test-js/lib/jquery-2.0.0.js create mode 100644 layout-gen/test-js/lib/raphael.js create mode 100644 layout-gen/test-js/main.js diff --git a/layout-gen/references.md b/layout-gen/references.md index f8287a04..a05e45df 100644 --- a/layout-gen/references.md +++ b/layout-gen/references.md @@ -19,6 +19,28 @@ Haskell is very similar to Elm in some ways, so I think this applies. + +## JavaScript Stuff + +* [How to include a JavaScript file in another JavaScript file?] + (http://stackoverflow.com/questions/950087/how-to-include-a-javascript-file-in-another-javascript-file) + + +### Libraries + +* [Raphaël] + (http://raphaeljs.com) + Cool graphics library :) + + + +## HTML Stuff + +* [W3C Documentation] + (http://www.w3schools.com/html/html5_intro.asp) + + + ------------------------------------------------------------------------------- Copyright © 2014 Ben Blazak diff --git a/layout-gen/Boards.elm b/layout-gen/test-elm-0/Boards.elm similarity index 100% rename from layout-gen/Boards.elm rename to layout-gen/test-elm-0/Boards.elm diff --git a/layout-gen/main.elm b/layout-gen/test-elm-0/main.elm similarity index 100% rename from layout-gen/main.elm rename to layout-gen/test-elm-0/main.elm diff --git a/layout-gen/test-elm-1/main.elm b/layout-gen/test-elm-1/main.elm new file mode 100644 index 00000000..e69de29b diff --git a/layout-gen/test-js/index.html b/layout-gen/test-js/index.html new file mode 100644 index 00000000..e96c1d60 --- /dev/null +++ b/layout-gen/test-js/index.html @@ -0,0 +1,14 @@ + + + + + +layout-gen + + + + + + + + diff --git a/layout-gen/test-js/lib/jquery-2.0.0.js b/layout-gen/test-js/lib/jquery-2.0.0.js new file mode 100644 index 00000000..f389a3e3 --- /dev/null +++ b/layout-gen/test-js/lib/jquery-2.0.0.js @@ -0,0 +1,8755 @@ +/*! + * jQuery JavaScript Library v2.0.0 + * http://jquery.com/ + * + * Includes Sizzle.js + * http://sizzlejs.com/ + * + * Copyright 2005, 2013 jQuery Foundation, Inc. and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2013-04-18 + */ +(function( window, undefined ) { + +// Can't do this because several apps including ASP.NET trace +// the stack via arguments.caller.callee and Firefox dies if +// you try to trace through "use strict" call chains. (#13335) +// Support: Firefox 18+ +//"use strict"; +var + // A central reference to the root jQuery(document) + rootjQuery, + + // The deferred used on DOM ready + readyList, + + // Support: IE9 + // For `typeof xmlNode.method` instead of `xmlNode.method !== undefined` + core_strundefined = typeof undefined, + + // Use the correct document accordingly with window argument (sandbox) + location = window.location, + document = window.document, + docElem = document.documentElement, + + // Map over jQuery in case of overwrite + _jQuery = window.jQuery, + + // Map over the $ in case of overwrite + _$ = window.$, + + // [[Class]] -> type pairs + class2type = {}, + + // List of deleted data cache ids, so we can reuse them + core_deletedIds = [], + + core_version = "2.0.0", + + // Save a reference to some core methods + core_concat = core_deletedIds.concat, + core_push = core_deletedIds.push, + core_slice = core_deletedIds.slice, + core_indexOf = core_deletedIds.indexOf, + core_toString = class2type.toString, + core_hasOwn = class2type.hasOwnProperty, + core_trim = core_version.trim, + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + // The jQuery object is actually just the init constructor 'enhanced' + return new jQuery.fn.init( selector, context, rootjQuery ); + }, + + // Used for matching numbers + core_pnum = /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/.source, + + // Used for splitting on whitespace + core_rnotwhite = /\S+/g, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + rquickExpr = /^(?:(<[\w\W]+>)[^>]*|#([\w-]*))$/, + + // Match a standalone tag + rsingleTag = /^<(\w+)\s*\/?>(?:<\/\1>|)$/, + + // Matches dashed string for camelizing + rmsPrefix = /^-ms-/, + rdashAlpha = /-([\da-z])/gi, + + // Used by jQuery.camelCase as callback to replace() + fcamelCase = function( all, letter ) { + return letter.toUpperCase(); + }, + + // The ready event handler and self cleanup method + completed = function() { + document.removeEventListener( "DOMContentLoaded", completed, false ); + window.removeEventListener( "load", completed, false ); + jQuery.ready(); + }; + +jQuery.fn = jQuery.prototype = { + // The current version of jQuery being used + jquery: core_version, + + constructor: jQuery, + init: function( selector, context, rootjQuery ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector.charAt(0) === "<" && selector.charAt( selector.length - 1 ) === ">" && selector.length >= 3 ) { + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && (match[1] || !context) ) { + + // HANDLE: $(html) -> $(array) + if ( match[1] ) { + context = context instanceof jQuery ? context[0] : context; + + // scripts is true for back-compat + jQuery.merge( this, jQuery.parseHTML( + match[1], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[1] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + // Properties of context are called as methods if possible + if ( jQuery.isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[2] ); + + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Inject the element directly into the jQuery object + this.length = 1; + this[0] = elem; + } + + this.context = document; + this.selector = selector; + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || rootjQuery ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this.context = this[0] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( jQuery.isFunction( selector ) ) { + return rootjQuery.ready( selector ); + } + + if ( selector.selector !== undefined ) { + this.selector = selector.selector; + this.context = selector.context; + } + + return jQuery.makeArray( selector, this ); + }, + + // Start with an empty selector + selector: "", + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return core_slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + return num == null ? + + // Return a 'clean' array + this.toArray() : + + // Return just the object + ( num < 0 ? this[ this.length + num ] : this[ num ] ); + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + ret.context = this.context; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + // (You can seed the arguments with an array of args, but this is + // only used internally.) + each: function( callback, args ) { + return jQuery.each( this, callback, args ); + }, + + ready: function( fn ) { + // Add the callback + jQuery.ready.promise().done( fn ); + + return this; + }, + + slice: function() { + return this.pushStack( core_slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[j] ] : [] ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map(this, function( elem, i ) { + return callback.call( elem, i, elem ); + })); + }, + + end: function() { + return this.prevObject || this.constructor(null); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: core_push, + sort: [].sort, + splice: [].splice +}; + +// Give the init function the jQuery prototype for later instantiation +jQuery.fn.init.prototype = jQuery.fn; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[0] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + target = arguments[1] || {}; + // skip the boolean and the target + i = 2; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !jQuery.isFunction(target) ) { + target = {}; + } + + // extend jQuery itself if only one argument is passed + if ( length === i ) { + target = this; + --i; + } + + for ( ; i < length; i++ ) { + // Only deal with non-null/undefined values + if ( (options = arguments[ i ]) != null ) { + // Extend the base object + for ( name in options ) { + src = target[ name ]; + copy = options[ name ]; + + // Prevent never-ending loop + if ( target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject(copy) || (copyIsArray = jQuery.isArray(copy)) ) ) { + if ( copyIsArray ) { + copyIsArray = false; + clone = src && jQuery.isArray(src) ? src : []; + + } else { + clone = src && jQuery.isPlainObject(src) ? src : {}; + } + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend({ + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( core_version + Math.random() ).replace( /\D/g, "" ), + + noConflict: function( deep ) { + if ( window.$ === jQuery ) { + window.$ = _$; + } + + if ( deep && window.jQuery === jQuery ) { + window.jQuery = _jQuery; + } + + return jQuery; + }, + + // Is the DOM ready to be used? Set to true once it occurs. + isReady: false, + + // A counter to track how many items to wait for before + // the ready event fires. See #6781 + readyWait: 1, + + // Hold (or release) the ready event + holdReady: function( hold ) { + if ( hold ) { + jQuery.readyWait++; + } else { + jQuery.ready( true ); + } + }, + + // Handle when the DOM is ready + ready: function( wait ) { + + // Abort if there are pending holds or we're already ready + if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) { + return; + } + + // Remember that the DOM is ready + jQuery.isReady = true; + + // If a normal DOM Ready event fired, decrement, and wait if need be + if ( wait !== true && --jQuery.readyWait > 0 ) { + return; + } + + // If there are functions bound, to execute + readyList.resolveWith( document, [ jQuery ] ); + + // Trigger any bound ready events + if ( jQuery.fn.trigger ) { + jQuery( document ).trigger("ready").off("ready"); + } + }, + + // See test/unit/core.js for details concerning isFunction. + // Since version 1.3, DOM methods and functions like alert + // aren't supported. They return false on IE (#2968). + isFunction: function( obj ) { + return jQuery.type(obj) === "function"; + }, + + isArray: Array.isArray, + + isWindow: function( obj ) { + return obj != null && obj === obj.window; + }, + + isNumeric: function( obj ) { + return !isNaN( parseFloat(obj) ) && isFinite( obj ); + }, + + type: function( obj ) { + if ( obj == null ) { + return String( obj ); + } + // Support: Safari <= 5.1 (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ core_toString.call(obj) ] || "object" : + typeof obj; + }, + + isPlainObject: function( obj ) { + // Not plain objects: + // - Any object or value whose internal [[Class]] property is not "[object Object]" + // - DOM nodes + // - window + if ( jQuery.type( obj ) !== "object" || obj.nodeType || jQuery.isWindow( obj ) ) { + return false; + } + + // Support: Firefox <20 + // The try/catch suppresses exceptions thrown when attempting to access + // the "constructor" property of certain host objects, ie. |window.location| + // https://bugzilla.mozilla.org/show_bug.cgi?id=814622 + try { + if ( obj.constructor && + !core_hasOwn.call( obj.constructor.prototype, "isPrototypeOf" ) ) { + return false; + } + } catch ( e ) { + return false; + } + + // If the function hasn't returned already, we're confident that + // |obj| is a plain object, created by {} or constructed with new Object + return true; + }, + + isEmptyObject: function( obj ) { + var name; + for ( name in obj ) { + return false; + } + return true; + }, + + error: function( msg ) { + throw new Error( msg ); + }, + + // data: string of html + // context (optional): If specified, the fragment will be created in this context, defaults to document + // keepScripts (optional): If true, will include scripts passed in the html string + parseHTML: function( data, context, keepScripts ) { + if ( !data || typeof data !== "string" ) { + return null; + } + if ( typeof context === "boolean" ) { + keepScripts = context; + context = false; + } + context = context || document; + + var parsed = rsingleTag.exec( data ), + scripts = !keepScripts && []; + + // Single tag + if ( parsed ) { + return [ context.createElement( parsed[1] ) ]; + } + + parsed = jQuery.buildFragment( [ data ], context, scripts ); + + if ( scripts ) { + jQuery( scripts ).remove(); + } + + return jQuery.merge( [], parsed.childNodes ); + }, + + parseJSON: JSON.parse, + + // Cross-browser xml parsing + parseXML: function( data ) { + var xml, tmp; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE9 + try { + tmp = new DOMParser(); + xml = tmp.parseFromString( data , "text/xml" ); + } catch ( e ) { + xml = undefined; + } + + if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { + jQuery.error( "Invalid XML: " + data ); + } + return xml; + }, + + noop: function() {}, + + // Evaluates a script in a global context + globalEval: function( code ) { + var script, + indirect = eval; + + code = jQuery.trim( code ); + + if ( code ) { + // If the code includes a valid, prologue position + // strict mode pragma, execute code by injecting a + // script tag into the document. + if ( code.indexOf("use strict") === 1 ) { + script = document.createElement("script"); + script.text = code; + document.head.appendChild( script ).parentNode.removeChild( script ); + } else { + // Otherwise, avoid the DOM node creation, insertion + // and removal by using an indirect global eval + indirect( code ); + } + } + }, + + // Convert dashed to camelCase; used by the css and data modules + // Microsoft forgot to hump their vendor prefix (#9572) + camelCase: function( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + }, + + nodeName: function( elem, name ) { + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + }, + + // args is for internal usage only + each: function( obj, callback, args ) { + var value, + i = 0, + length = obj.length, + isArray = isArraylike( obj ); + + if ( args ) { + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback.apply( obj[ i ], args ); + + if ( value === false ) { + break; + } + } + } else { + for ( i in obj ) { + value = callback.apply( obj[ i ], args ); + + if ( value === false ) { + break; + } + } + } + + // A special, fast, case for the most common use of each + } else { + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback.call( obj[ i ], i, obj[ i ] ); + + if ( value === false ) { + break; + } + } + } else { + for ( i in obj ) { + value = callback.call( obj[ i ], i, obj[ i ] ); + + if ( value === false ) { + break; + } + } + } + } + + return obj; + }, + + trim: function( text ) { + return text == null ? "" : core_trim.call( text ); + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArraylike( Object(arr) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + core_push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : core_indexOf.call( arr, elem, i ); + }, + + merge: function( first, second ) { + var l = second.length, + i = first.length, + j = 0; + + if ( typeof l === "number" ) { + for ( ; j < l; j++ ) { + first[ i++ ] = second[ j ]; + } + } else { + while ( second[j] !== undefined ) { + first[ i++ ] = second[ j++ ]; + } + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, inv ) { + var retVal, + ret = [], + i = 0, + length = elems.length; + inv = !!inv; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + retVal = !!callback( elems[ i ], i ); + if ( inv !== retVal ) { + ret.push( elems[ i ] ); + } + } + + return ret; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var value, + i = 0, + length = elems.length, + isArray = isArraylike( elems ), + ret = []; + + // Go through the array, translating each of the items to their + if ( isArray ) { + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret[ ret.length ] = value; + } + } + } + + // Flatten any nested arrays + return core_concat.apply( [], ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // Bind a function to a context, optionally partially applying any + // arguments. + proxy: function( fn, context ) { + var tmp, args, proxy; + + if ( typeof context === "string" ) { + tmp = fn[ context ]; + context = fn; + fn = tmp; + } + + // Quick check to determine if target is callable, in the spec + // this throws a TypeError, but we will just return undefined. + if ( !jQuery.isFunction( fn ) ) { + return undefined; + } + + // Simulated bind + args = core_slice.call( arguments, 2 ); + proxy = function() { + return fn.apply( context || this, args.concat( core_slice.call( arguments ) ) ); + }; + + // Set the guid of unique handler to the same of original handler, so it can be removed + proxy.guid = fn.guid = fn.guid || jQuery.guid++; + + return proxy; + }, + + // Multifunctional method to get and set values of a collection + // The value/s can optionally be executed if it's a function + access: function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + length = elems.length, + bulk = key == null; + + // Sets many values + if ( jQuery.type( key ) === "object" ) { + chainable = true; + for ( i in key ) { + jQuery.access( elems, fn, i, key[i], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !jQuery.isFunction( value ) ) { + raw = true; + } + + if ( bulk ) { + // Bulk operations run against the entire set + if ( raw ) { + fn.call( elems, value ); + fn = null; + + // ...except when executing function values + } else { + bulk = fn; + fn = function( elem, key, value ) { + return bulk.call( jQuery( elem ), value ); + }; + } + } + + if ( fn ) { + for ( ; i < length; i++ ) { + fn( elems[i], key, raw ? value : value.call( elems[i], i, fn( elems[i], key ) ) ); + } + } + } + + return chainable ? + elems : + + // Gets + bulk ? + fn.call( elems ) : + length ? fn( elems[0], key ) : emptyGet; + }, + + now: Date.now, + + // A method for quickly swapping in/out CSS properties to get correct calculations. + // Note: this method belongs to the css module but it's needed here for the support module. + // If support gets modularized, this method should be moved back to the css module. + swap: function( elem, options, callback, args ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.apply( elem, args || [] ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; + } +}); + +jQuery.ready.promise = function( obj ) { + if ( !readyList ) { + + readyList = jQuery.Deferred(); + + // Catch cases where $(document).ready() is called after the browser event has already occurred. + // we once tried to use readyState "interactive" here, but it caused issues like the one + // discovered by ChrisS here: http://bugs.jquery.com/ticket/12282#comment:15 + if ( document.readyState === "complete" ) { + // Handle it asynchronously to allow scripts the opportunity to delay ready + setTimeout( jQuery.ready ); + + } else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed, false ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed, false ); + } + } + return readyList.promise( obj ); +}; + +// Populate the class2type map +jQuery.each("Boolean Number String Function Array Date RegExp Object Error".split(" "), function(i, name) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +}); + +function isArraylike( obj ) { + var length = obj.length, + type = jQuery.type( obj ); + + if ( jQuery.isWindow( obj ) ) { + return false; + } + + if ( obj.nodeType === 1 && length ) { + return true; + } + + return type === "array" || type !== "function" && + ( length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj ); +} + +// All jQuery objects should point back to these +rootjQuery = jQuery(document); +/*! + * Sizzle CSS Selector Engine v1.9.2-pre + * http://sizzlejs.com/ + * + * Copyright 2013 jQuery Foundation, Inc. and other contributors + * Released under the MIT license + * http://jquery.org/license + * + * Date: 2013-04-16 + */ +(function( window, undefined ) { + +var i, + cachedruns, + Expr, + getText, + isXML, + compile, + outermostContext, + sortInput, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + -(new Date()), + preferredDoc = window.document, + support = {}, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + hasDuplicate = false, + sortOrder = function() { return 0; }, + + // General-purpose constants + strundefined = typeof undefined, + MAX_NEGATIVE = 1 << 31, + + // Array methods + arr = [], + pop = arr.pop, + push_native = arr.push, + push = arr.push, + slice = arr.slice, + // Use a stripped-down indexOf if we can't use a native one + indexOf = arr.indexOf || function( elem ) { + var i = 0, + len = this.length; + for ( ; i < len; i++ ) { + if ( this[i] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // Whitespace characters http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + // http://www.w3.org/TR/css3-syntax/#characters + characterEncoding = "(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+", + + // Loosely modeled on CSS identifier characters + // An unquoted value should be a CSS identifier http://www.w3.org/TR/css3-selectors/#attribute-selectors + // Proper syntax: http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier + identifier = characterEncoding.replace( "w", "w#" ), + + // Acceptable operators http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + characterEncoding + ")" + whitespace + + "*(?:([*^$|!~]?=)" + whitespace + "*(?:(['\"])((?:\\\\.|[^\\\\])*?)\\3|(" + identifier + ")|)|)" + whitespace + "*\\]", + + // Prefer arguments quoted, + // then not containing pseudos/brackets, + // then attribute selectors/non-parenthetical expressions, + // then anything else + // These preferences are here to reduce the number of selectors + // needing tokenize in the PSEUDO preFilter + pseudos = ":(" + characterEncoding + ")(?:\\(((['\"])((?:\\\\.|[^\\\\])*?)\\3|((?:\\\\.|[^\\\\()[\\]]|" + attributes.replace( 3, 8 ) + ")*)|.*)\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), + + rsibling = new RegExp( whitespace + "*[+~]" ), + rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*)" + whitespace + "*\\]", "g" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + characterEncoding + ")" ), + "CLASS": new RegExp( "^\\.(" + characterEncoding + ")" ), + "TAG": new RegExp( "^(" + characterEncoding.replace( "w", "w*" ) + ")" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "boolean": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + + whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rescape = /'|\\/g, + + // CSS escapes http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = /\\([\da-fA-F]{1,6}[\x20\t\r\n\f]?|.)/g, + funescape = function( _, escaped ) { + var high = "0x" + escaped - 0x10000; + // NaN means non-codepoint + return high !== high ? + escaped : + // BMP codepoint + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + // Supplemental Plane codepoint (surrogate pair) + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }; + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + (arr = slice.call( preferredDoc.childNodes )), + preferredDoc.childNodes + ); + // Support: Android<4.0 + // Detect silently failing push.apply + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + push_native.apply( target, slice.call(els) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + // Can't trust NodeList.length + while ( (target[j++] = els[i++]) ) {} + target.length = j - 1; + } + }; +} + +/** + * For feature detection + * @param {Function} fn The function to test for native support + */ +function isNative( fn ) { + return rnative.test( fn + "" ); +} + +/** + * Create key-value caches of limited size + * @returns {Function(string, Object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var cache, + keys = []; + + return (cache = function( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key += " " ) > Expr.cacheLength ) { + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return (cache[ key ] = value); + }); +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created div and expects a boolean result + */ +function assert( fn ) { + var div = document.createElement("div"); + + try { + return !!fn( div ); + } catch (e) { + return false; + } finally { + if ( div.parentNode ) { + div.parentNode.removeChild( div ); + } + // release memory in IE + div = null; + } +} + +function Sizzle( selector, context, results, seed ) { + var match, elem, m, nodeType, + // QSA vars + i, groups, old, nid, newContext, newSelector; + + if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { + setDocument( context ); + } + + context = context || document; + results = results || []; + + if ( !selector || typeof selector !== "string" ) { + return results; + } + + if ( (nodeType = context.nodeType) !== 1 && nodeType !== 9 ) { + return []; + } + + if ( documentIsHTML && !seed ) { + + // Shortcuts + if ( (match = rquickExpr.exec( selector )) ) { + // Speed-up: Sizzle("#ID") + if ( (m = match[1]) ) { + if ( nodeType === 9 ) { + elem = context.getElementById( m ); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + if ( elem && elem.parentNode ) { + // Handle the case where IE, Opera, and Webkit return items + // by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + } else { + // Context is not a document + if ( context.ownerDocument && (elem = context.ownerDocument.getElementById( m )) && + contains( context, elem ) && elem.id === m ) { + results.push( elem ); + return results; + } + } + + // Speed-up: Sizzle("TAG") + } else if ( match[2] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Speed-up: Sizzle(".CLASS") + } else if ( (m = match[3]) && support.getElementsByClassName && context.getElementsByClassName ) { + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // QSA path + if ( support.qsa && (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { + nid = old = expando; + newContext = context; + newSelector = nodeType === 9 && selector; + + // qSA works strangely on Element-rooted queries + // We can work around this by specifying an extra ID on the root + // and working up from there (Thanks to Andrew Dupont for the technique) + // IE 8 doesn't work on object elements + if ( nodeType === 1 && context.nodeName.toLowerCase() !== "object" ) { + groups = tokenize( selector ); + + if ( (old = context.getAttribute("id")) ) { + nid = old.replace( rescape, "\\$&" ); + } else { + context.setAttribute( "id", nid ); + } + nid = "[id='" + nid + "'] "; + + i = groups.length; + while ( i-- ) { + groups[i] = nid + toSelector( groups[i] ); + } + newContext = rsibling.test( selector ) && context.parentNode || context; + newSelector = groups.join(","); + } + + if ( newSelector ) { + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch(qsaError) { + } finally { + if ( !old ) { + context.removeAttribute("id"); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Detect xml + * @param {Element|Object} elem An element or a document + */ +isXML = Sizzle.isXML = function( elem ) { + // documentElement is verified for cases where it doesn't yet exist + // (such as loading iframes in IE - #4833) + var documentElement = elem && (elem.ownerDocument || elem).documentElement; + return documentElement ? documentElement.nodeName !== "HTML" : false; +}; + +/** + * Sets document-related variables once based on the current document + * @param {Element|Object} [doc] An element or document object to use to set the document + * @returns {Object} Returns the current document + */ +setDocument = Sizzle.setDocument = function( node ) { + var doc = node ? node.ownerDocument || node : preferredDoc; + + // If no document and documentElement is available, return + if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Set our document + document = doc; + docElem = doc.documentElement; + + // Support tests + documentIsHTML = !isXML( doc ); + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert(function( div ) { + div.appendChild( doc.createComment("") ); + return !div.getElementsByTagName("*").length; + }); + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties (excepting IE8 booleans) + support.attributes = assert(function( div ) { + div.className = "i"; + return !div.getAttribute("className"); + }); + + // Check if getElementsByClassName can be trusted + support.getElementsByClassName = assert(function( div ) { + div.innerHTML = "
"; + + // Support: Safari<4 + // Catch class over-caching + div.firstChild.className = "i"; + // Support: Opera<10 + // Catch gEBCN failure to find non-leading classes + return div.getElementsByClassName("i").length === 2; + }); + + // Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) + // Detached nodes confoundingly follow *each other* + support.sortDetached = assert(function( div1 ) { + // Should return 1, but returns 4 (following) + return div1.compareDocumentPosition( document.createElement("div") ) & 1; + }); + + // Support: IE<10 + // Check if getElementById returns elements by name + // Support: Windows 8 Native Apps + // Assigning innerHTML with "name" attributes throws uncatchable exceptions + // (http://msdn.microsoft.com/en-us/library/ie/hh465388.aspx) + // and the broken getElementById methods don't pick up programatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert(function( div ) { + docElem.appendChild( div ).id = expando; + return !doc.getElementsByName || !doc.getElementsByName( expando ).length; + }); + + // ID find and filter + if ( support.getById ) { + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== strundefined && documentIsHTML ) { + var m = context.getElementById( id ); + // Check parentNode to catch when Blackberry 4.6 returns + // nodes that are no longer in the document #6963 + return m && m.parentNode ? [m] : []; + } + }; + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute("id") === attrId; + }; + }; + } else { + Expr.find["ID"] = function( id, context ) { + if ( typeof context.getElementById !== strundefined && documentIsHTML ) { + var m = context.getElementById( id ); + + return m ? + m.id === id || typeof m.getAttributeNode !== strundefined && m.getAttributeNode("id").value === id ? + [m] : + undefined : + []; + } + }; + Expr.filter["ID"] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== strundefined && elem.getAttributeNode("id"); + return node && node.value === attrId; + }; + }; + } + + // Tag + Expr.find["TAG"] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== strundefined ) { + return context.getElementsByTagName( tag ); + } + } : + function( tag, context ) { + var elem, + tmp = [], + i = 0, + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( (elem = results[i++]) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== strundefined && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See http://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( (support.qsa = isNative(doc.querySelectorAll)) ) { + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert(function( div ) { + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // http://bugs.jquery.com/ticket/12359 + div.innerHTML = ""; + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !div.querySelectorAll("[selected]").length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !div.querySelectorAll(":checked").length ) { + rbuggyQSA.push(":checked"); + } + }); + + assert(function( div ) { + + // Support: Opera 10-12/IE8 + // ^= $= *= and empty values + // Should not select anything + // Support: Windows 8 Native Apps + // The type attribute is restricted during .innerHTML assignment + var input = document.createElement("input"); + input.setAttribute( "type", "hidden" ); + div.appendChild( input ).setAttribute( "t", "" ); + + if ( div.querySelectorAll("[t^='']").length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( !div.querySelectorAll(":enabled").length ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Opera 10-11 does not throw on post-comma invalid pseudos + div.querySelectorAll("*,:x"); + rbuggyQSA.push(",.*:"); + }); + } + + if ( (support.matchesSelector = isNative( (matches = docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector) )) ) { + + assert(function( div ) { + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( div, "div" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( div, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + }); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + + // Element contains another + // Purposefully does not implement inclusive descendent + // As in, an element does not contain itself + contains = isNative(docElem.contains) || docElem.compareDocumentPosition ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + )); + } : + function( a, b ) { + if ( b ) { + while ( (b = b.parentNode) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + // Document order sorting + sortOrder = docElem.compareDocumentPosition ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var compare = b.compareDocumentPosition && a.compareDocumentPosition && a.compareDocumentPosition( b ); + + if ( compare ) { + // Disconnected nodes + if ( compare & 1 || + (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + + // Choose the first element that is related to our preferred document + if ( a === doc || contains(preferredDoc, a) ) { + return -1; + } + if ( b === doc || contains(preferredDoc, b) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } + + // Not directly comparable, sort on existence of method + return a.compareDocumentPosition ? -1 : 1; + } : + function( a, b ) { + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + + // Parentless nodes are either documents or disconnected + } else if ( !aup || !bup ) { + return a === doc ? -1 : + b === doc ? 1 : + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf.call( sortInput, a ) - indexOf.call( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( (cur = cur.parentNode) ) { + ap.unshift( cur ); + } + cur = b; + while ( (cur = cur.parentNode) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[i] === bp[i] ) { + i++; + } + + return i ? + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[i], bp[i] ) : + + // Otherwise nodes in our document sort first + ap[i] === preferredDoc ? -1 : + bp[i] === preferredDoc ? 1 : + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + // Make sure that attribute selectors are quoted + expr = expr.replace( rattributeQuotes, "='$1']" ); + + // rbuggyQSA always contains :focus, so no need for an existence check + if ( support.matchesSelector && documentIsHTML && + (!rbuggyMatches || !rbuggyMatches.test(expr)) && + (!rbuggyQSA || !rbuggyQSA.test(expr)) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch(e) {} + } + + return Sizzle( expr, document, null, [elem] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + // Set document vars if needed + if ( ( context.ownerDocument || context ) !== document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + // Set document vars if needed + if ( ( elem.ownerDocument || elem ) !== document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + val = fn && fn( elem, name, !documentIsHTML ); + + return val === undefined ? + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + (val = elem.getAttributeNode(name)) && val.specified ? + val.value : + null : + val; +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +// Document sorting and removing duplicates +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( (elem = results[i++]) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + return results; +}; + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns Returns -1 if a precedes b, 1 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && ( ~b.sourceIndex || MAX_NEGATIVE ) - ( ~a.sourceIndex || MAX_NEGATIVE ); + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( (cur = cur.nextSibling) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +// Fetches boolean attributes by node +function boolHandler( elem, name, isXML ) { + var val; + return isXML ? + undefined : + (val = elem.getAttributeNode( name )) && val.specified ? + val.value : + elem[ name ] === true ? name.toLowerCase() : null; +} + +// Fetches attributes without interpolation +// http://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +function interpolationHandler( elem, name, isXML ) { + var val; + return isXML ? + undefined : + (val = elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 )); +} + +// Returns a function to use in pseudos for input types +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +// Returns a function to use in pseudos for buttons +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return (name === "input" || name === "button") && elem.type === type; + }; +} + +// Returns a function to use in pseudos for positionals +function createPositionalPseudo( fn ) { + return markFunction(function( argument ) { + argument = +argument; + return markFunction(function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ (j = matchIndexes[i]) ] ) { + seed[j] = !(matches[j] = seed[j]); + } + } + }); + }); +} + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + // If no nodeType, this is expected to be an array + for ( ; (node = elem[i]); i++ ) { + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements + // innerText usage removed for consistency of new lines (see #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[1] = match[1].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[3] = ( match[4] || match[5] || "" ).replace( runescape, funescape ); + + if ( match[2] === "~=" ) { + match[3] = " " + match[3] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[1] = match[1].toLowerCase(); + + if ( match[1].slice( 0, 3 ) === "nth" ) { + // nth-* requires argument + if ( !match[3] ) { + Sizzle.error( match[0] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); + match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + + // other types prohibit arguments + } else if ( match[3] ) { + Sizzle.error( match[0] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[5] && match[2]; + + if ( matchExpr["CHILD"].test( match[0] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[4] ) { + match[2] = match[4]; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) + (excess = tokenize( unquoted, true )) && + // advance to the next closing parenthesis + (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + + // excess is a negative index + match[0] = match[0].slice( 0, excess ); + match[2] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { return true; } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && + classCache( className, function( elem ) { + return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== strundefined && elem.getAttribute("class") || "" ); + }); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + }; + }, + + "CHILD": function( type, what, argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, context, xml ) { + var cache, outerCache, node, diff, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( (node = node[ dir ]) ) { + if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { + return false; + } + } + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + // Seek `elem` from a previously-cached index + outerCache = parent[ expando ] || (parent[ expando ] = {}); + cache = outerCache[ type ] || []; + nodeIndex = cache[0] === dirruns && cache[1]; + diff = cache[0] === dirruns && cache[2]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( (node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + (diff = nodeIndex = 0) || start.pop()) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + outerCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + // Use previously-cached element index if available + } else if ( useCache && (cache = (elem[ expando ] || (elem[ expando ] = {}))[ type ]) && cache[0] === dirruns ) { + diff = cache[1]; + + // xml :nth-child(...) or :nth-last-child(...) or :nth(-last)?-of-type(...) + } else { + // Use the same loop as above to seek `elem` from the start + while ( (node = ++nodeIndex && node && node[ dir ] || + (diff = nodeIndex = 0) || start.pop()) ) { + + if ( ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) && ++diff ) { + // Cache the index of each encountered element + if ( useCache ) { + (node[ expando ] || (node[ expando ] = {}))[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction(function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf.call( seed, matched[i] ); + seed[ idx ] = !( matches[ idx ] = matched[i] ); + } + }) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + // Potentially complex pseudos + "not": markFunction(function( selector ) { + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction(function( seed, matches, context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( (elem = unmatched[i]) ) { + seed[i] = !(matches[i] = elem); + } + } + }) : + function( elem, context, xml ) { + input[0] = elem; + matcher( input, null, xml, results ); + return !results.pop(); + }; + }), + + "has": markFunction(function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + }), + + "contains": markFunction(function( text ) { + return function( elem ) { + return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + }; + }), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + // lang value must be a valid identifier + if ( !ridentifier.test(lang || "") ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( (elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + return false; + }; + }), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + }, + + // Boolean properties + "enabled": function( elem ) { + return elem.disabled === false; + }, + + "disabled": function( elem ) { + return elem.disabled === true; + }, + + "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + }, + + "selected": function( elem ) { + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is only affected by element nodes and content nodes(including text(3), cdata(4)), + // not comment, processing instructions, or others + // Thanks to Diego Perini for the nodeName shortcut + // Greater than "@" means alpha characters (specifically not starting with "#" or "?") + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeName > "@" || elem.nodeType === 3 || elem.nodeType === 4 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos["empty"]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + // IE6 and 7 will map elem.type to 'text' for new HTML5 types (search, etc) + // use getAttribute instead to test this case + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === elem.type ); + }, + + // Position-in-collection + "first": createPositionalPseudo(function() { + return [ 0 ]; + }), + + "last": createPositionalPseudo(function( matchIndexes, length ) { + return [ length - 1 ]; + }), + + "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + }), + + "even": createPositionalPseudo(function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "odd": createPositionalPseudo(function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }), + + "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + }) + } +}; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +function tokenize( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( match ) { + // Don't consume trailing commas as valid + soFar = soFar.slice( match[0].length ) || soFar; + } + groups.push( tokens = [] ); + } + + matched = false; + + // Combinators + if ( (match = rcombinators.exec( soFar )) ) { + matched = match.shift(); + tokens.push( { + value: matched, + // Cast descendant combinators to space + type: match[0].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || + (match = preFilters[ type ]( match ))) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +} + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[i].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + checkNonElements = base && dir === "parentNode", + doneName = done++; + + return combinator.first ? + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var data, cache, outerCache, + dirkey = dirruns + " " + doneName; + + // We can't set arbitrary data on XML nodes, so they don't benefit from dir caching + if ( xml ) { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( (elem = elem[ dir ]) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || (elem[ expando ] = {}); + if ( (cache = outerCache[ dir ]) && cache[0] === dirkey ) { + if ( (data = cache[1]) === true || data === cachedruns ) { + return data === true; + } + } else { + cache = outerCache[ dir ] = [ dirkey ]; + cache[1] = matcher( elem, context, xml ) || cachedruns; + if ( cache[1] === true ) { + return true; + } + } + } + } + } + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[i]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[0]; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( (elem = unmatched[i]) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction(function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( (elem = temp[i]) ) { + matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) ) { + // Restore matcherIn since elem is not yet a final match + temp.push( (matcherIn[i] = elem) ); + } + } + postFinder( null, (matcherOut = []), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( (elem = matcherOut[i]) && + (temp = postFinder ? indexOf.call( seed, elem ) : preMap[i]) > -1 ) { + + seed[temp] = !(results[temp] = elem); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + }); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[0].type ], + implicitRelative = leadingRelative || Expr.relative[" "], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf.call( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + return ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + (checkContext = context).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + } ]; + + for ( ; i < len; i++ ) { + if ( (matcher = Expr.relative[ tokens[i].type ]) ) { + matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + } else { + matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[j].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( tokens.slice( 0, i - 1 ) ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + // A counter to specify which element is currently being matched + var matcherCachedRuns = 0, + bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, expandContext ) { + var elem, j, matcher, + setMatched = [], + matchedCount = 0, + i = "0", + unmatched = seed && [], + outermost = expandContext != null, + contextBackup = outermostContext, + // We must always have either seed elements or context + elems = seed || byElement && Expr.find["TAG"]( "*", expandContext && context.parentNode || context ), + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1); + + if ( outermost ) { + outermostContext = context !== document && context; + cachedruns = matcherCachedRuns; + } + + // Add elements passing elementMatchers directly to results + // Keep `i` a string if there are no elements so `matchedCount` will be "00" below + for ( ; (elem = elems[i]) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + while ( (matcher = elementMatchers[j++]) ) { + if ( matcher( elem, context, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + cachedruns = ++matcherCachedRuns; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + // They will have gone through all possible matchers + if ( (elem = !matcher && elem) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // Apply set filters to unmatched elements + matchedCount += i; + if ( bySet && i !== matchedCount ) { + j = 0; + while ( (matcher = setMatchers[j++]) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !(unmatched[i] || setMatched[i]) ) { + setMatched[i] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, group /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element + if ( !group ) { + group = tokenize( selector ); + } + i = group.length; + while ( i-- ) { + cached = matcherFromTokens( group[i] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + } + return cached; +}; + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[i], results ); + } + return results; +} + +function select( selector, context, results, seed ) { + var i, tokens, token, type, find, + match = tokenize( selector ); + + if ( !seed ) { + // Try to minimize operations if there is only one group + if ( match.length === 1 ) { + + // Take a shortcut and set the context if the root selector is an ID + tokens = match[0] = match[0].slice( 0 ); + if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && + context.nodeType === 9 && documentIsHTML && + Expr.relative[ tokens[1].type ] ) { + + context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + if ( !context ) { + return results; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[i]; + + // Abort if we hit a combinator + if ( Expr.relative[ (type = token.type) ] ) { + break; + } + if ( (find = Expr.find[ type ]) ) { + // Search, expanding context for leading sibling combinators + if ( (seed = find( + token.matches[0].replace( runescape, funescape ), + rsibling.test( tokens[0].type ) && context.parentNode || context + )) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + } + + // Compile and execute a filtering function + // Provide `match` to avoid retokenization if we modified the selector above + compile( selector, match )( + seed, + context, + !documentIsHTML, + results, + rsibling.test( selector ) + ); + return results; +} + +// Deprecated +Expr.pseudos["nth"] = Expr.pseudos["eq"]; + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +// One-time assignments + +// Sort stability +support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; + +// Initialize against the default document +setDocument(); + +// Support: Chrome<<14 +// Always assume duplicates if they aren't passed to the comparison function +[0, 0].sort( sortOrder ); +support.detectDuplicates = hasDuplicate; + +// Support: IE<8 +// Prevent attribute/property "interpolation" +assert(function( div ) { + div.innerHTML = ""; + if ( div.firstChild.getAttribute("href") !== "#" ) { + var attrs = "type|href|height|width".split("|"), + i = attrs.length; + while ( i-- ) { + Expr.attrHandle[ attrs[i] ] = interpolationHandler; + } + } +}); + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +assert(function( div ) { + if ( div.getAttribute("disabled") != null ) { + var attrs = booleans.split("|"), + i = attrs.length; + while ( i-- ) { + Expr.attrHandle[ attrs[i] ] = boolHandler; + } + } +}); + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; +jQuery.expr[":"] = jQuery.expr.pseudos; +jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; + + +})( window ); +// String to Object options format cache +var optionsCache = {}; + +// Convert String-formatted options into Object-formatted ones and store in cache +function createOptions( options ) { + var object = optionsCache[ options ] = {}; + jQuery.each( options.match( core_rnotwhite ) || [], function( _, flag ) { + object[ flag ] = true; + }); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + ( optionsCache[ options ] || createOptions( options ) ) : + jQuery.extend( {}, options ); + + var // Last fire value (for non-forgettable lists) + memory, + // Flag to know if list was already fired + fired, + // Flag to know if list is currently firing + firing, + // First callback to fire (used internally by add and fireWith) + firingStart, + // End of the loop when firing + firingLength, + // Index of currently firing callback (modified by remove if needed) + firingIndex, + // Actual callback list + list = [], + // Stack of fire calls for repeatable lists + stack = !options.once && [], + // Fire callbacks + fire = function( data ) { + memory = options.memory && data; + fired = true; + firingIndex = firingStart || 0; + firingStart = 0; + firingLength = list.length; + firing = true; + for ( ; list && firingIndex < firingLength; firingIndex++ ) { + if ( list[ firingIndex ].apply( data[ 0 ], data[ 1 ] ) === false && options.stopOnFalse ) { + memory = false; // To prevent further calls using add + break; + } + } + firing = false; + if ( list ) { + if ( stack ) { + if ( stack.length ) { + fire( stack.shift() ); + } + } else if ( memory ) { + list = []; + } else { + self.disable(); + } + } + }, + // Actual Callbacks object + self = { + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + // First, we save the current length + var start = list.length; + (function add( args ) { + jQuery.each( args, function( _, arg ) { + var type = jQuery.type( arg ); + if ( type === "function" ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && type !== "string" ) { + // Inspect recursively + add( arg ); + } + }); + })( arguments ); + // Do we need to add the callbacks to the + // current firing batch? + if ( firing ) { + firingLength = list.length; + // With memory, if we're not firing then + // we should call right away + } else if ( memory ) { + firingStart = start; + fire( memory ); + } + } + return this; + }, + // Remove a callback from the list + remove: function() { + if ( list ) { + jQuery.each( arguments, function( _, arg ) { + var index; + while( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + // Handle firing indexes + if ( firing ) { + if ( index <= firingLength ) { + firingLength--; + } + if ( index <= firingIndex ) { + firingIndex--; + } + } + } + }); + } + return this; + }, + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? jQuery.inArray( fn, list ) > -1 : !!( list && list.length ); + }, + // Remove all callbacks from the list + empty: function() { + list = []; + firingLength = 0; + return this; + }, + // Have the list do nothing anymore + disable: function() { + list = stack = memory = undefined; + return this; + }, + // Is it disabled? + disabled: function() { + return !list; + }, + // Lock the list in its current state + lock: function() { + stack = undefined; + if ( !memory ) { + self.disable(); + } + return this; + }, + // Is it locked? + locked: function() { + return !stack; + }, + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + if ( list && ( !fired || stack ) ) { + if ( firing ) { + stack.push( args ); + } else { + fire( args ); + } + } + return this; + }, + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; +jQuery.extend({ + + Deferred: function( func ) { + var tuples = [ + // action, add listener, listener list, final state + [ "resolve", "done", jQuery.Callbacks("once memory"), "resolved" ], + [ "reject", "fail", jQuery.Callbacks("once memory"), "rejected" ], + [ "notify", "progress", jQuery.Callbacks("memory") ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + then: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + return jQuery.Deferred(function( newDefer ) { + jQuery.each( tuples, function( i, tuple ) { + var action = tuple[ 0 ], + fn = jQuery.isFunction( fns[ i ] ) && fns[ i ]; + // deferred[ done | fail | progress ] for forwarding actions to newDefer + deferred[ tuple[1] ](function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && jQuery.isFunction( returned.promise ) ) { + returned.promise() + .done( newDefer.resolve ) + .fail( newDefer.reject ) + .progress( newDefer.notify ); + } else { + newDefer[ action + "With" ]( this === promise ? newDefer.promise() : this, fn ? [ returned ] : arguments ); + } + }); + }); + fns = null; + }).promise(); + }, + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Keep pipe for back-compat + promise.pipe = promise.then; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 3 ]; + + // promise[ done | fail | progress ] = list.add + promise[ tuple[1] ] = list.add; + + // Handle state + if ( stateString ) { + list.add(function() { + // state = [ resolved | rejected ] + state = stateString; + + // [ reject_list | resolve_list ].disable; progress_list.lock + }, tuples[ i ^ 1 ][ 2 ].disable, tuples[ 2 ][ 2 ].lock ); + } + + // deferred[ resolve | reject | notify ] + deferred[ tuple[0] ] = function() { + deferred[ tuple[0] + "With" ]( this === deferred ? promise : this, arguments ); + return this; + }; + deferred[ tuple[0] + "With" ] = list.fireWith; + }); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( subordinate /* , ..., subordinateN */ ) { + var i = 0, + resolveValues = core_slice.call( arguments ), + length = resolveValues.length, + + // the count of uncompleted subordinates + remaining = length !== 1 || ( subordinate && jQuery.isFunction( subordinate.promise ) ) ? length : 0, + + // the master Deferred. If resolveValues consist of only a single Deferred, just use that. + deferred = remaining === 1 ? subordinate : jQuery.Deferred(), + + // Update function for both resolve and progress values + updateFunc = function( i, contexts, values ) { + return function( value ) { + contexts[ i ] = this; + values[ i ] = arguments.length > 1 ? core_slice.call( arguments ) : value; + if( values === progressValues ) { + deferred.notifyWith( contexts, values ); + } else if ( !( --remaining ) ) { + deferred.resolveWith( contexts, values ); + } + }; + }, + + progressValues, progressContexts, resolveContexts; + + // add listeners to Deferred subordinates; treat others as resolved + if ( length > 1 ) { + progressValues = new Array( length ); + progressContexts = new Array( length ); + resolveContexts = new Array( length ); + for ( ; i < length; i++ ) { + if ( resolveValues[ i ] && jQuery.isFunction( resolveValues[ i ].promise ) ) { + resolveValues[ i ].promise() + .done( updateFunc( i, resolveContexts, resolveValues ) ) + .fail( deferred.reject ) + .progress( updateFunc( i, progressContexts, progressValues ) ); + } else { + --remaining; + } + } + } + + // if we're not waiting on anything, resolve the master + if ( !remaining ) { + deferred.resolveWith( resolveContexts, resolveValues ); + } + + return deferred.promise(); + } +}); +jQuery.support = (function( support ) { + var input = document.createElement("input"), + fragment = document.createDocumentFragment(), + div = document.createElement("div"), + select = document.createElement("select"), + opt = select.appendChild( document.createElement("option") ); + + // Finish early in limited environments + if ( !input.type ) { + return support; + } + + input.type = "checkbox"; + + // Support: Safari 5.1, iOS 5.1, Android 4.x, Android 2.3 + // Check the default checkbox/radio value ("" on old WebKit; "on" elsewhere) + support.checkOn = input.value !== ""; + + // Must access the parent to make an option select properly + // Support: IE9, IE10 + support.optSelected = opt.selected; + + // Will be defined later + support.reliableMarginRight = true; + support.boxSizingReliable = true; + support.pixelPosition = false; + + // Make sure checked status is properly cloned + // Support: IE9, IE10 + input.checked = true; + support.noCloneChecked = input.cloneNode( true ).checked; + + // Make sure that the options inside disabled selects aren't marked as disabled + // (WebKit marks them as disabled) + select.disabled = true; + support.optDisabled = !opt.disabled; + + // Check if an input maintains its value after becoming a radio + // Support: IE9, IE10 + input = document.createElement("input"); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; + + // #11217 - WebKit loses check when the name is after the checked attribute + input.setAttribute( "checked", "t" ); + input.setAttribute( "name", "t" ); + + fragment.appendChild( input ); + + // Support: Safari 5.1, Android 4.x, Android 2.3 + // old WebKit doesn't clone checked state correctly in fragments + support.checkClone = fragment.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: Firefox, Chrome, Safari + // Beware of CSP restrictions (https://developer.mozilla.org/en/Security/CSP) + support.focusinBubbles = "onfocusin" in window; + + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + // Run tests that need a body at doc ready + jQuery(function() { + var container, marginDiv, + // Support: Firefox, Android 2.3 (Prefixed box-sizing versions). + divReset = "padding:0;margin:0;border:0;display:block;-webkit-box-sizing:content-box;-moz-box-sizing:content-box;box-sizing:content-box", + body = document.getElementsByTagName("body")[ 0 ]; + + if ( !body ) { + // Return for frameset docs that don't have a body + return; + } + + container = document.createElement("div"); + container.style.cssText = "border:0;width:0;height:0;position:absolute;top:0;left:-9999px;margin-top:1px"; + + // Check box-sizing and margin behavior. + body.appendChild( container ).appendChild( div ); + div.innerHTML = ""; + // Support: Firefox, Android 2.3 (Prefixed box-sizing versions). + div.style.cssText = "-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box;padding:1px;border:1px;display:block;width:4px;margin-top:1%;position:absolute;top:1%"; + + // Workaround failing boxSizing test due to offsetWidth returning wrong value + // with some non-1 values of body zoom, ticket #13543 + jQuery.swap( body, body.style.zoom != null ? { zoom: 1 } : {}, function() { + support.boxSizing = div.offsetWidth === 4; + }); + + // Use window.getComputedStyle because jsdom on node.js will break without it. + if ( window.getComputedStyle ) { + support.pixelPosition = ( window.getComputedStyle( div, null ) || {} ).top !== "1%"; + support.boxSizingReliable = ( window.getComputedStyle( div, null ) || { width: "4px" } ).width === "4px"; + + // Support: Android 2.3 + // Check if div with explicit width and no margin-right incorrectly + // gets computed margin-right based on width of container. (#3333) + // WebKit Bug 13343 - getComputedStyle returns wrong value for margin-right + marginDiv = div.appendChild( document.createElement("div") ); + marginDiv.style.cssText = div.style.cssText = divReset; + marginDiv.style.marginRight = marginDiv.style.width = "0"; + div.style.width = "1px"; + + support.reliableMarginRight = + !parseFloat( ( window.getComputedStyle( marginDiv, null ) || {} ).marginRight ); + } + + body.removeChild( container ); + }); + + return support; +})( {} ); + +/* + Implementation Summary + + 1. Enforce API surface and semantic compatibility with 1.9.x branch + 2. Improve the module's maintainability by reducing the storage + paths to a single mechanism. + 3. Use the same single mechanism to support "private" and "user" data. + 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData) + 5. Avoid exposing implementation details on user objects (eg. expando properties) + 6. Provide a clear path for implementation upgrade to WeakMap in 2014 +*/ +var data_user, data_priv, + rbrace = /(?:\{[\s\S]*\}|\[[\s\S]*\])$/, + rmultiDash = /([A-Z])/g; + +function Data() { + // Support: Android < 4, + // Old WebKit does not have Object.preventExtensions/freeze method, + // return new empty object instead with no [[set]] accessor + Object.defineProperty( this.cache = {}, 0, { + get: function() { + return {}; + } + }); + + this.expando = jQuery.expando + Math.random(); +} + +Data.uid = 1; + +Data.accepts = function( owner ) { + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType ? + owner.nodeType === 1 || owner.nodeType === 9 : true; +}; + +Data.prototype = { + key: function( owner ) { + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return the key for a frozen object. + if ( !Data.accepts( owner ) ) { + return 0; + } + + var descriptor = {}, + // Check if the owner object already has a cache key + unlock = owner[ this.expando ]; + + // If not, create one + if ( !unlock ) { + unlock = Data.uid++; + + // Secure it in a non-enumerable, non-writable property + try { + descriptor[ this.expando ] = { value: unlock }; + Object.defineProperties( owner, descriptor ); + + // Support: Android < 4 + // Fallback to a less secure definition + } catch ( e ) { + descriptor[ this.expando ] = unlock; + jQuery.extend( owner, descriptor ); + } + } + + // Ensure the cache object + if ( !this.cache[ unlock ] ) { + this.cache[ unlock ] = {}; + } + + return unlock; + }, + set: function( owner, data, value ) { + var prop, + // There may be an unlock assigned to this node, + // if there is no entry for this "owner", create one inline + // and set the unlock as though an owner entry had always existed + unlock = this.key( owner ), + cache = this.cache[ unlock ]; + + // Handle: [ owner, key, value ] args + if ( typeof data === "string" ) { + cache[ data ] = value; + + // Handle: [ owner, { properties } ] args + } else { + // Support an expectation from the old data system where plain + // objects used to initialize would be set to the cache by + // reference, instead of having properties and values copied. + // Note, this will kill the connection between + // "this.cache[ unlock ]" and "cache" + if ( jQuery.isEmptyObject( cache ) ) { + this.cache[ unlock ] = data; + // Otherwise, copy the properties one-by-one to the cache object + } else { + for ( prop in data ) { + cache[ prop ] = data[ prop ]; + } + } + } + }, + get: function( owner, key ) { + // Either a valid cache is found, or will be created. + // New caches will be created and the unlock returned, + // allowing direct access to the newly created + // empty data object. A valid owner object must be provided. + var cache = this.cache[ this.key( owner ) ]; + + return key === undefined ? + cache : cache[ key ]; + }, + access: function( owner, key, value ) { + // In cases where either: + // + // 1. No key was specified + // 2. A string key was specified, but no value provided + // + // Take the "read" path and allow the get method to determine + // which value to return, respectively either: + // + // 1. The entire cache object + // 2. The data stored at the key + // + if ( key === undefined || + ((key && typeof key === "string") && value === undefined) ) { + return this.get( owner, key ); + } + + // [*]When the key is not a string, or both a key and value + // are specified, set or extend (existing objects) with either: + // + // 1. An object of properties + // 2. A key and value + // + this.set( owner, key, value ); + + // Since the "set" path can have two possible entry points + // return the expected data based on which path was taken[*] + return value !== undefined ? value : key; + }, + remove: function( owner, key ) { + var i, name, + unlock = this.key( owner ), + cache = this.cache[ unlock ]; + + if ( key === undefined ) { + this.cache[ unlock ] = {}; + + } else { + // Support array or space separated string of keys + if ( jQuery.isArray( key ) ) { + // If "name" is an array of keys... + // When data is initially created, via ("key", "val") signature, + // keys will be converted to camelCase. + // Since there is no way to tell _how_ a key was added, remove + // both plain key and camelCase key. #12786 + // This will only penalize the array argument path. + name = key.concat( key.map( jQuery.camelCase ) ); + } else { + // Try the string as a key before any manipulation + if ( key in cache ) { + name = [ key ]; + } else { + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + name = jQuery.camelCase( key ); + name = name in cache ? + [ name ] : ( name.match( core_rnotwhite ) || [] ); + } + } + + i = name.length; + while ( i-- ) { + delete cache[ name[ i ] ]; + } + } + }, + hasData: function( owner ) { + return !jQuery.isEmptyObject( + this.cache[ owner[ this.expando ] ] || {} + ); + }, + discard: function( owner ) { + delete this.cache[ this.key( owner ) ]; + } +}; + +// These may be used throughout the jQuery core codebase +data_user = new Data(); +data_priv = new Data(); + + +jQuery.extend({ + acceptData: Data.accepts, + + hasData: function( elem ) { + return data_user.hasData( elem ) || data_priv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return data_user.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + data_user.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to data_priv methods, these can be deprecated. + _data: function( elem, name, data ) { + return data_priv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + data_priv.remove( elem, name ); + } +}); + +jQuery.fn.extend({ + data: function( key, value ) { + var attrs, name, + elem = this[ 0 ], + i = 0, + data = null; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = data_user.get( elem ); + + if ( elem.nodeType === 1 && !data_priv.get( elem, "hasDataAttrs" ) ) { + attrs = elem.attributes; + for ( ; i < attrs.length; i++ ) { + name = attrs[ i ].name; + + if ( name.indexOf( "data-" ) === 0 ) { + name = jQuery.camelCase( name.substring(5) ); + dataAttr( elem, name, data[ name ] ); + } + } + data_priv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each(function() { + data_user.set( this, key ); + }); + } + + return jQuery.access( this, function( value ) { + var data, + camelKey = jQuery.camelCase( key ); + + // The calling jQuery object (element matches) is not empty + // (and therefore has an element appears at this[ 0 ]) and the + // `value` parameter was not undefined. An empty jQuery object + // will result in `undefined` for elem = this[ 0 ] which will + // throw an exception if an attempt to read a data cache is made. + if ( elem && value === undefined ) { + // Attempt to get data from the cache + // with the key as-is + data = data_user.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to get data from the cache + // with the key camelized + data = data_user.get( elem, camelKey ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, camelKey, undefined ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each(function() { + // First, attempt to store a copy or reference of any + // data that might've been store with a camelCased key. + var data = data_user.get( this, camelKey ); + + // For HTML5 data-* attribute interop, we have to + // store property names with dashes in a camelCase form. + // This might not apply to all properties...* + data_user.set( this, camelKey, value ); + + // *... In the case of properties that might _actually_ + // have dashes, we need to also store a copy of that + // unchanged property. + if ( key.indexOf("-") !== -1 && data !== undefined ) { + data_user.set( this, key, value ); + } + }); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each(function() { + data_user.remove( this, key ); + }); + } +}); + +function dataAttr( elem, key, data ) { + var name; + + // If nothing was found internally, try to fetch any + // data from the HTML5 data-* attribute + if ( data === undefined && elem.nodeType === 1 ) { + name = "data-" + key.replace( rmultiDash, "-$1" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = data === "true" ? true : + data === "false" ? false : + data === "null" ? null : + // Only convert to a number if it doesn't change the string + +data + "" === data ? +data : + rbrace.test( data ) ? JSON.parse( data ) : + data; + } catch( e ) {} + + // Make sure we set the data so it isn't changed later + data_user.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} +jQuery.extend({ + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = data_priv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || jQuery.isArray( data ) ) { + queue = data_priv.access( elem, type, jQuery.makeArray(data) ); + } else { + queue.push( data ); + } + } + return queue || []; + } + }, + + dequeue: function( elem, type ) { + type = type || "fx"; + + var queue = jQuery.queue( elem, type ), + startLength = queue.length, + fn = queue.shift(), + hooks = jQuery._queueHooks( elem, type ), + next = function() { + jQuery.dequeue( elem, type ); + }; + + // If the fx queue is dequeued, always remove the progress sentinel + if ( fn === "inprogress" ) { + fn = queue.shift(); + startLength--; + } + + hooks.cur = fn; + if ( fn ) { + + // Add a progress sentinel to prevent the fx queue from being + // automatically dequeued + if ( type === "fx" ) { + queue.unshift( "inprogress" ); + } + + // clear up the last queue stop function + delete hooks.stop; + fn.call( elem, next, hooks ); + } + + if ( !startLength && hooks ) { + hooks.empty.fire(); + } + }, + + // not intended for public consumption - generates a queueHooks object, or returns the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return data_priv.get( elem, key ) || data_priv.access( elem, key, { + empty: jQuery.Callbacks("once memory").add(function() { + data_priv.remove( elem, [ type + "queue", key ] ); + }) + }); + } +}); + +jQuery.fn.extend({ + queue: function( type, data ) { + var setter = 2; + + if ( typeof type !== "string" ) { + data = type; + type = "fx"; + setter--; + } + + if ( arguments.length < setter ) { + return jQuery.queue( this[0], type ); + } + + return data === undefined ? + this : + this.each(function() { + var queue = jQuery.queue( this, type, data ); + + // ensure a hooks for this queue + jQuery._queueHooks( this, type ); + + if ( type === "fx" && queue[0] !== "inprogress" ) { + jQuery.dequeue( this, type ); + } + }); + }, + dequeue: function( type ) { + return this.each(function() { + jQuery.dequeue( this, type ); + }); + }, + // Based off of the plugin by Clint Helfers, with permission. + // http://blindsignals.com/index.php/2009/07/jquery-delay/ + delay: function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = setTimeout( next, time ); + hooks.stop = function() { + clearTimeout( timeout ); + }; + }); + }, + clearQueue: function( type ) { + return this.queue( type || "fx", [] ); + }, + // Get a promise resolved when queues of a certain type + // are emptied (fx is the type by default) + promise: function( type, obj ) { + var tmp, + count = 1, + defer = jQuery.Deferred(), + elements = this, + i = this.length, + resolve = function() { + if ( !( --count ) ) { + defer.resolveWith( elements, [ elements ] ); + } + }; + + if ( typeof type !== "string" ) { + obj = type; + type = undefined; + } + type = type || "fx"; + + while( i-- ) { + tmp = data_priv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +}); +var nodeHook, boolHook, + rclass = /[\t\r\n]/g, + rreturn = /\r/g, + rfocusable = /^(?:input|select|textarea|button)$/i; + +jQuery.fn.extend({ + attr: function( name, value ) { + return jQuery.access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each(function() { + jQuery.removeAttr( this, name ); + }); + }, + + prop: function( name, value ) { + return jQuery.access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each(function() { + delete this[ jQuery.propFix[ name ] || name ]; + }); + }, + + addClass: function( value ) { + var classes, elem, cur, clazz, j, + i = 0, + len = this.length, + proceed = typeof value === "string" && value; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).addClass( value.call( this, j, this.className ) ); + }); + } + + if ( proceed ) { + // The disjunction here is for better compressibility (see removeClass) + classes = ( value || "" ).match( core_rnotwhite ) || []; + + for ( ; i < len; i++ ) { + elem = this[ i ]; + cur = elem.nodeType === 1 && ( elem.className ? + ( " " + elem.className + " " ).replace( rclass, " " ) : + " " + ); + + if ( cur ) { + j = 0; + while ( (clazz = classes[j++]) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + elem.className = jQuery.trim( cur ); + + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, clazz, j, + i = 0, + len = this.length, + proceed = arguments.length === 0 || typeof value === "string" && value; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( j ) { + jQuery( this ).removeClass( value.call( this, j, this.className ) ); + }); + } + if ( proceed ) { + classes = ( value || "" ).match( core_rnotwhite ) || []; + + for ( ; i < len; i++ ) { + elem = this[ i ]; + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( elem.className ? + ( " " + elem.className + " " ).replace( rclass, " " ) : + "" + ); + + if ( cur ) { + j = 0; + while ( (clazz = classes[j++]) ) { + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) >= 0 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + elem.className = value ? jQuery.trim( cur ) : ""; + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isBool = typeof stateVal === "boolean"; + + if ( jQuery.isFunction( value ) ) { + return this.each(function( i ) { + jQuery( this ).toggleClass( value.call(this, i, this.className, stateVal), stateVal ); + }); + } + + return this.each(function() { + if ( type === "string" ) { + // toggle individual class names + var className, + i = 0, + self = jQuery( this ), + state = stateVal, + classNames = value.match( core_rnotwhite ) || []; + + while ( (className = classNames[ i++ ]) ) { + // check each className given, space separated list + state = isBool ? state : !self.hasClass( className ); + self[ state ? "addClass" : "removeClass" ]( className ); + } + + // Toggle whole class name + } else if ( type === core_strundefined || type === "boolean" ) { + if ( this.className ) { + // store className if set + data_priv.set( this, "__className__", this.className ); + } + + // If the element has a class name or if we're passed "false", + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + this.className = this.className || value === false ? "" : data_priv.get( this, "__className__" ) || ""; + } + }); + }, + + hasClass: function( selector ) { + var className = " " + selector + " ", + i = 0, + l = this.length; + for ( ; i < l; i++ ) { + if ( this[i].nodeType === 1 && (" " + this[i].className + " ").replace(rclass, " ").indexOf( className ) >= 0 ) { + return true; + } + } + + return false; + }, + + val: function( value ) { + var hooks, ret, isFunction, + elem = this[0]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && "get" in hooks && (ret = hooks.get( elem, "value" )) !== undefined ) { + return ret; + } + + ret = elem.value; + + return typeof ret === "string" ? + // handle most common string cases + ret.replace(rreturn, "") : + // handle cases where value is null/undef or number + ret == null ? "" : ret; + } + + return; + } + + isFunction = jQuery.isFunction( value ); + + return this.each(function( i ) { + var val, + self = jQuery(this); + + if ( this.nodeType !== 1 ) { + return; + } + + if ( isFunction ) { + val = value.call( this, i, self.val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + } else if ( typeof val === "number" ) { + val += ""; + } else if ( jQuery.isArray( val ) ) { + val = jQuery.map(val, function ( value ) { + return value == null ? "" : value + ""; + }); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !("set" in hooks) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + }); + } +}); + +jQuery.extend({ + valHooks: { + option: { + get: function( elem ) { + // attributes.value is undefined in Blackberry 4.7 but + // uses .value. See #6932 + var val = elem.attributes.value; + return !val || val.specified ? elem.value : elem.text; + } + }, + select: { + get: function( elem ) { + var value, option, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one" || index < 0, + values = one ? null : [], + max = one ? index + 1 : options.length, + i = index < 0 ? + max : + one ? index : 0; + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // IE6-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + // Don't return options that are disabled or in a disabled optgroup + ( jQuery.support.optDisabled ? !option.disabled : option.getAttribute("disabled") === null ) && + ( !option.parentNode.disabled || !jQuery.nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + if ( (option.selected = jQuery.inArray( jQuery(option).val(), values ) >= 0) ) { + optionSet = true; + } + } + + // force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + }, + + attr: function( elem, name, value ) { + var hooks, ret, + nType = elem.nodeType; + + // don't get/set attributes on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === core_strundefined ) { + return jQuery.prop( elem, name, value ); + } + + // All attributes are lowercase + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + name = name.toLowerCase(); + hooks = jQuery.attrHooks[ name ] || + ( jQuery.expr.match.boolean.test( name ) ? boolHook : nodeHook ); + } + + if ( value !== undefined ) { + + if ( value === null ) { + jQuery.removeAttr( elem, name ); + + } else if ( hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ) { + return ret; + + } else { + elem.setAttribute( name, value + "" ); + return value; + } + + } else if ( hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ) { + return ret; + + } else { + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? + undefined : + ret; + } + }, + + removeAttr: function( elem, value ) { + var name, propName, + i = 0, + attrNames = value && value.match( core_rnotwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( (name = attrNames[i++]) ) { + propName = jQuery.propFix[ name ] || name; + + // Boolean attributes get special treatment (#10870) + if ( jQuery.expr.match.boolean.test( name ) ) { + // Set corresponding property to false + elem[ propName ] = false; + } + + elem.removeAttribute( name ); + } + } + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !jQuery.support.radioValue && value === "radio" && jQuery.nodeName(elem, "input") ) { + // Setting the type on a radio button after the value resets the value in IE6-9 + // Reset value to default in case type is set after value during creation + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + }, + + prop: function( elem, name, value ) { + var ret, hooks, notxml, + nType = elem.nodeType; + + // don't get/set properties on text, comment and attribute nodes + if ( !elem || nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + notxml = nType !== 1 || !jQuery.isXMLDoc( elem ); + + if ( notxml ) { + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + return hooks && "set" in hooks && (ret = hooks.set( elem, value, name )) !== undefined ? + ret : + ( elem[ name ] = value ); + + } else { + return hooks && "get" in hooks && (ret = hooks.get( elem, name )) !== null ? + ret : + elem[ name ]; + } + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + return elem.hasAttribute( "tabindex" ) || rfocusable.test( elem.nodeName ) || elem.href ? + elem.tabIndex : + -1; + } + } + } +}); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; +jQuery.each( jQuery.expr.match.boolean.source.match( /\w+/g ), function( i, name ) { + var getter = jQuery.expr.attrHandle[ name ] || jQuery.find.attr; + + jQuery.expr.attrHandle[ name ] = function( elem, name, isXML ) { + var fn = jQuery.expr.attrHandle[ name ], + ret = isXML ? + undefined : + /* jshint eqeqeq: false */ + // Temporarily disable this handler to check existence + (jQuery.expr.attrHandle[ name ] = undefined) != + getter( elem, name, isXML ) ? + + name.toLowerCase() : + null; + + // Restore handler + jQuery.expr.attrHandle[ name ] = fn; + + return ret; + }; +}); + +// Support: IE9+ +// Selectedness for an option in an optgroup can be inaccurate +if ( !jQuery.support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + } + }; +} + +jQuery.each([ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +}); + +// Radios and checkboxes getter/setter +jQuery.each([ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( jQuery.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery(elem).val(), value ) >= 0 ); + } + } + }; + if ( !jQuery.support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + // Support: Webkit + // "" is returned instead of "on" if a value isn't specified + return elem.getAttribute("value") === null ? "on" : elem.value; + }; + } +}); +var rkeyEvent = /^key/, + rmouseEvent = /^(?:mouse|contextmenu)|click/, + rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + rtypenamespace = /^([^.]*)(?:\.(.+)|)$/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +/* + * Helper functions for managing events -- not part of the public interface. + * Props to Dean Edwards' addEvent library for many of the ideas. + */ +jQuery.event = { + + global: {}, + + add: function( elem, types, handler, data, selector ) { + + var handleObjIn, eventHandle, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = data_priv.get( elem ); + + // Don't attach events to noData or text/comment nodes (but allow plain objects) + if ( !elemData ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !(events = elemData.events) ) { + events = elemData.events = {}; + } + if ( !(eventHandle = elemData.handle) ) { + eventHandle = elemData.handle = function( e ) { + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== core_strundefined && (!e || jQuery.event.triggered !== e.type) ? + jQuery.event.dispatch.apply( eventHandle.elem, arguments ) : + undefined; + }; + // Add elem as a property of the handle fn to prevent a memory leak with IE non-native events + eventHandle.elem = elem; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( core_rnotwhite ) || [""]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[t] ) || []; + type = origType = tmp[1]; + namespaces = ( tmp[2] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend({ + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join(".") + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !(handlers = events[ type ]) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle, false ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + // Nullify elem to prevent memory leaks in IE + elem = null; + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = data_priv.hasData( elem ) && data_priv.get( elem ); + + if ( !elemData || !(events = elemData.events) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( core_rnotwhite ) || [""]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[t] ) || []; + type = origType = tmp[1]; + namespaces = ( tmp[2] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[2] && new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + delete elemData.handle; + data_priv.remove( elem, "events" ); + } + }, + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, + eventPath = [ elem || document ], + type = core_hasOwn.call( event, "type" ) ? event.type : event, + namespaces = core_hasOwn.call( event, "namespace" ) ? event.namespace.split(".") : []; + + cur = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf(".") >= 0 ) { + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split("."); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf(":") < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join("."); + event.namespace_re = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join("\\.(?:.*\\.|)") + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === (elem.ownerDocument || document) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( (cur = eventPath[i++]) && !event.isPropagationStopped() ) { + + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( data_priv.get( cur, "events" ) || {} )[ event.type ] && data_priv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && jQuery.acceptData( cur ) && handle.apply && handle.apply( cur, data ) === false ) { + event.preventDefault(); + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( (!special._default || special._default.apply( eventPath.pop(), data ) === false) && + jQuery.acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + elem[ type ](); + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + dispatch: function( event ) { + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( event ); + + var i, j, ret, matched, handleObj, + handlerQueue = [], + args = core_slice.call( arguments ), + handlers = ( data_priv.get( this, "events" ) || {} )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[0] = event; + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( (matched = handlerQueue[ i++ ]) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( (handleObj = matched.handlers[ j++ ]) && !event.isImmediatePropagationStopped() ) { + + // Triggered event must either 1) have no namespace, or + // 2) have namespace(s) a subset or equal to those in the bound event (both can have no namespace). + if ( !event.namespace_re || event.namespace_re.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( (jQuery.event.special[ handleObj.origType ] || {}).handle || handleObj.handler ) + .apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( (event.result = ret) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, matches, sel, handleObj, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + // Black-hole SVG instance trees (#13180) + // Avoid non-left-click bubbling in Firefox (#3861) + if ( delegateCount && cur.nodeType && (!event.button || event.type !== "click") ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.disabled !== true || event.type !== "click" ) { + matches = []; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matches[ sel ] === undefined ) { + matches[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) >= 0 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matches[ sel ] ) { + matches.push( handleObj ); + } + } + if ( matches.length ) { + handlerQueue.push({ elem: cur, handlers: matches }); + } + } + } + } + + // Add the remaining (directly-bound) handlers + if ( delegateCount < handlers.length ) { + handlerQueue.push({ elem: this, handlers: handlers.slice( delegateCount ) }); + } + + return handlerQueue; + }, + + // Includes some event props shared by KeyEvent and MouseEvent + props: "altKey bubbles cancelable ctrlKey currentTarget eventPhase metaKey relatedTarget shiftKey target timeStamp view which".split(" "), + + fixHooks: {}, + + keyHooks: { + props: "char charCode key keyCode".split(" "), + filter: function( event, original ) { + + // Add which for key events + if ( event.which == null ) { + event.which = original.charCode != null ? original.charCode : original.keyCode; + } + + return event; + } + }, + + mouseHooks: { + props: "button buttons clientX clientY offsetX offsetY pageX pageY screenX screenY toElement".split(" "), + filter: function( event, original ) { + var eventDoc, doc, body, + button = original.button; + + // Calculate pageX/Y if missing and clientX/Y available + if ( event.pageX == null && original.clientX != null ) { + eventDoc = event.target.ownerDocument || document; + doc = eventDoc.documentElement; + body = eventDoc.body; + + event.pageX = original.clientX + ( doc && doc.scrollLeft || body && body.scrollLeft || 0 ) - ( doc && doc.clientLeft || body && body.clientLeft || 0 ); + event.pageY = original.clientY + ( doc && doc.scrollTop || body && body.scrollTop || 0 ) - ( doc && doc.clientTop || body && body.clientTop || 0 ); + } + + // Add which for click: 1 === left; 2 === middle; 3 === right + // Note: button is not normalized, so don't use it + if ( !event.which && button !== undefined ) { + event.which = ( button & 1 ? 1 : ( button & 2 ? 3 : ( button & 4 ? 2 : 0 ) ) ); + } + + return event; + } + }, + + fix: function( event ) { + if ( event[ jQuery.expando ] ) { + return event; + } + + // Create a writable copy of the event object and normalize some properties + var i, prop, copy, + type = event.type, + originalEvent = event, + fixHook = this.fixHooks[ type ]; + + if ( !fixHook ) { + this.fixHooks[ type ] = fixHook = + rmouseEvent.test( type ) ? this.mouseHooks : + rkeyEvent.test( type ) ? this.keyHooks : + {}; + } + copy = fixHook.props ? this.props.concat( fixHook.props ) : this.props; + + event = new jQuery.Event( originalEvent ); + + i = copy.length; + while ( i-- ) { + prop = copy[ i ]; + event[ prop ] = originalEvent[ prop ]; + } + + // Support: Safari 6.0+, Chrome < 28 + // Target should not be a text node (#504, #13143) + if ( event.target.nodeType === 3 ) { + event.target = event.target.parentNode; + } + + return fixHook.filter? fixHook.filter( event, originalEvent ) : event; + }, + + special: { + load: { + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + focus: { + // Fire native event if possible so blur/focus sequence is correct + trigger: function() { + if ( this !== safeActiveElement() && this.focus ) { + this.focus(); + return false; + } + }, + delegateType: "focusin" + }, + blur: { + trigger: function() { + if ( this === safeActiveElement() && this.blur ) { + this.blur(); + return false; + } + }, + delegateType: "focusout" + }, + click: { + // For checkbox, fire native event so checked state will be right + trigger: function() { + if ( this.type === "checkbox" && this.click && jQuery.nodeName( this, "input" ) ) { + this.click(); + return false; + } + }, + + // For cross-browser consistency, don't fire native .click() on links + _default: function( event ) { + return jQuery.nodeName( event.target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined ) { + event.originalEvent.returnValue = event.result; + } + } + } + }, + + simulate: function( type, elem, event, bubble ) { + // Piggyback on a donor event to simulate a different one. + // Fake originalEvent to avoid donor's stopPropagation, but if the + // simulated event prevents default then we do the same on the donor. + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true, + originalEvent: {} + } + ); + if ( bubble ) { + jQuery.event.trigger( e, null, elem ); + } else { + jQuery.event.dispatch.call( elem, e ); + } + if ( e.isDefaultPrevented() ) { + event.preventDefault(); + } + } +}; + +jQuery.removeEvent = function( elem, type, handle ) { + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle, false ); + } +}; + +jQuery.Event = function( src, props ) { + // Allow instantiation without the 'new' keyword + if ( !(this instanceof jQuery.Event) ) { + return new jQuery.Event( src, props ); + } + + // Event object + if ( src && src.type ) { + this.originalEvent = src; + this.type = src.type; + + // Events bubbling up the document may have been marked as prevented + // by a handler lower down the tree; reflect the correct value. + this.isDefaultPrevented = ( src.defaultPrevented || + src.getPreventDefault && src.getPreventDefault() ) ? returnTrue : returnFalse; + + // Event type + } else { + this.type = src; + } + + // Put explicitly provided properties onto the event object + if ( props ) { + jQuery.extend( this, props ); + } + + // Create a timestamp if incoming event doesn't have one + this.timeStamp = src && src.timeStamp || jQuery.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// http://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && e.preventDefault ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && e.stopPropagation ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + this.isImmediatePropagationStopped = returnTrue; + this.stopPropagation(); + } +}; + +// Create mouseenter/leave events using mouseover/out and event-time checks +// Support: Chrome 15+ +jQuery.each({ + mouseenter: "mouseover", + mouseleave: "mouseout" +}, function( orig, fix ) { + jQuery.event.special[ orig ] = { + delegateType: fix, + bindType: fix, + + handle: function( event ) { + var ret, + target = this, + related = event.relatedTarget, + handleObj = event.handleObj; + + // For mousenter/leave call the handler if related is outside the target. + // NB: No relatedTarget if the mouse left/entered the browser window + if ( !related || (related !== target && !jQuery.contains( target, related )) ) { + event.type = handleObj.origType; + ret = handleObj.handler.apply( this, arguments ); + event.type = fix; + } + return ret; + } + }; +}); + +// Create "bubbling" focus and blur events +// Support: Firefox, Chrome, Safari +if ( !jQuery.support.focusinBubbles ) { + jQuery.each({ focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler while someone wants focusin/focusout + var attaches = 0, + handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ), true ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + if ( attaches++ === 0 ) { + document.addEventListener( orig, handler, true ); + } + }, + teardown: function() { + if ( --attaches === 0 ) { + document.removeEventListener( orig, handler, true ); + } + } + }; + }); +} + +jQuery.fn.extend({ + + on: function( types, selector, data, fn, /*INTERNAL*/ one ) { + var origFn, type; + + // Types can be a map of types/handlers + if ( typeof types === "object" ) { + // ( types-Object, selector, data ) + if ( typeof selector !== "string" ) { + // ( types-Object, data ) + data = data || selector; + selector = undefined; + } + for ( type in types ) { + this.on( type, selector, data, types[ type ], one ); + } + return this; + } + + if ( data == null && fn == null ) { + // ( types, fn ) + fn = selector; + data = selector = undefined; + } else if ( fn == null ) { + if ( typeof selector === "string" ) { + // ( types, selector, fn ) + fn = data; + data = undefined; + } else { + // ( types, data, fn ) + fn = data; + data = selector; + selector = undefined; + } + } + if ( fn === false ) { + fn = returnFalse; + } else if ( !fn ) { + return this; + } + + if ( one === 1 ) { + origFn = fn; + fn = function( event ) { + // Can use an empty set, since event contains the info + jQuery().off( event ); + return origFn.apply( this, arguments ); + }; + // Use same guid so caller can remove using origFn + fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ ); + } + return this.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + }); + }, + one: function( types, selector, data, fn ) { + return this.on( types, selector, data, fn, 1 ); + }, + off: function( types, selector, fn ) { + var handleObj, type; + if ( types && types.preventDefault && types.handleObj ) { + // ( event ) dispatched jQuery.Event + handleObj = types.handleObj; + jQuery( types.delegateTarget ).off( + handleObj.namespace ? handleObj.origType + "." + handleObj.namespace : handleObj.origType, + handleObj.selector, + handleObj.handler + ); + return this; + } + if ( typeof types === "object" ) { + // ( types-object [, selector] ) + for ( type in types ) { + this.off( type, selector, types[ type ] ); + } + return this; + } + if ( selector === false || typeof selector === "function" ) { + // ( types [, fn] ) + fn = selector; + selector = undefined; + } + if ( fn === false ) { + fn = returnFalse; + } + return this.each(function() { + jQuery.event.remove( this, types, fn, selector ); + }); + }, + + trigger: function( type, data ) { + return this.each(function() { + jQuery.event.trigger( type, data, this ); + }); + }, + triggerHandler: function( type, data ) { + var elem = this[0]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +}); +var isSimple = /^.[^:#\[\.,]*$/, + rneedsContext = jQuery.expr.match.needsContext, + // methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend({ + find: function( selector ) { + var self, matched, i, + l = this.length; + + if ( typeof selector !== "string" ) { + self = this; + return this.pushStack( jQuery( selector ).filter(function() { + for ( i = 0; i < l; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + }) ); + } + + matched = []; + for ( i = 0; i < l; i++ ) { + jQuery.find( selector, this[ i ], matched ); + } + + // Needed because $( selector, context ) becomes $( context ).find( selector ) + matched = this.pushStack( l > 1 ? jQuery.unique( matched ) : matched ); + matched.selector = ( this.selector ? this.selector + " " : "" ) + selector; + return matched; + }, + + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter(function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[i] ) ) { + return true; + } + } + }); + }, + + not: function( selector ) { + return this.pushStack( winnow(this, selector || [], true) ); + }, + + filter: function( selector ) { + return this.pushStack( winnow(this, selector || [], false) ); + }, + + is: function( selector ) { + return !!selector && ( + typeof selector === "string" ? + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + rneedsContext.test( selector ) ? + jQuery( selector, this.context ).index( this[ 0 ] ) >= 0 : + jQuery.filter( selector, this ).length > 0 : + this.filter( selector ).length > 0 ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + pos = ( rneedsContext.test( selectors ) || typeof selectors !== "string" ) ? + jQuery( selectors, context || this.context ) : + 0; + + for ( ; i < l; i++ ) { + for ( cur = this[i]; cur && cur !== context; cur = cur.parentNode ) { + // Always skip document fragments + if ( cur.nodeType < 11 && (pos ? + pos.index(cur) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector(cur, selectors)) ) { + + cur = matched.push( cur ); + break; + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.unique( matched ) : matched ); + }, + + // Determine the position of an element within + // the matched set of elements + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // index in selector + if ( typeof elem === "string" ) { + return core_indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return core_indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + var set = typeof selector === "string" ? + jQuery( selector, context ) : + jQuery.makeArray( selector && selector.nodeType ? [ selector ] : selector ), + all = jQuery.merge( this.get(), set ); + + return this.pushStack( jQuery.unique(all) ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter(selector) + ); + } +}); + +function sibling( cur, dir ) { + while ( (cur = cur[dir]) && cur.nodeType !== 1 ) {} + + return cur; +} + +jQuery.each({ + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return jQuery.dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, i, until ) { + return jQuery.dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return jQuery.dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return jQuery.dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, i, until ) { + return jQuery.dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, i, until ) { + return jQuery.dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return jQuery.sibling( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return jQuery.sibling( elem.firstChild ); + }, + contents: function( elem ) { + return jQuery.nodeName( elem, "iframe" ) ? + elem.contentDocument || elem.contentWindow.document : + jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.unique( matched ); + } + + // Reverse order for parents* and prev* + if ( name[ 0 ] === "p" ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +}); + +jQuery.extend({ + filter: function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + return elems.length === 1 && elem.nodeType === 1 ? + jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : [] : + jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + })); + }, + + dir: function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( (elem = elem[ dir ]) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; + }, + + sibling: function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; + } +}); + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( jQuery.isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + /* jshint -W018 */ + return !!qualifier.call( elem, i, elem ) !== not; + }); + + } + + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + }); + + } + + if ( typeof qualifier === "string" ) { + if ( isSimple.test( qualifier ) ) { + return jQuery.filter( qualifier, elements, not ); + } + + qualifier = jQuery.filter( qualifier, elements ); + } + + return jQuery.grep( elements, function( elem ) { + return ( core_indexOf.call( qualifier, elem ) >= 0 ) !== not; + }); +} +var rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi, + rtagName = /<([\w:]+)/, + rhtml = /<|&#?\w+;/, + rnoInnerhtml = /<(?:script|style|link)/i, + manipulation_rcheckableType = /^(?:checkbox|radio)$/i, + // checked="checked" or checked + rchecked = /checked\s*(?:[^=]|=\s*.checked.)/i, + rscriptType = /^$|\/(?:java|ecma)script/i, + rscriptTypeMasked = /^true\/(.*)/, + rcleanScript = /^\s*\s*$/g, + + // We have to close these tags to support XHTML (#13200) + wrapMap = { + + // Support: IE 9 + option: [ 1, "" ], + + thead: [ 1, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] + }; + +// Support: IE 9 +wrapMap.optgroup = wrapMap.option; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.col = wrapMap.thead; +wrapMap.th = wrapMap.td; + +jQuery.fn.extend({ + text: function( value ) { + return jQuery.access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().append( ( this[ 0 ] && this[ 0 ].ownerDocument || document ).createTextNode( value ) ); + }, null, value, arguments.length ); + }, + + append: function() { + return this.domManip( arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + }); + }, + + prepend: function() { + return this.domManip( arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + }); + }, + + before: function() { + return this.domManip( arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + }); + }, + + after: function() { + return this.domManip( arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + }); + }, + + // keepData is for internal use only--do not document + remove: function( selector, keepData ) { + var elem, + elems = selector ? jQuery.filter( selector, this ) : this, + i = 0; + + for ( ; (elem = elems[i]) != null; i++ ) { + if ( !keepData && elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem ) ); + } + + if ( elem.parentNode ) { + if ( keepData && jQuery.contains( elem.ownerDocument, elem ) ) { + setGlobalEval( getAll( elem, "script" ) ); + } + elem.parentNode.removeChild( elem ); + } + } + + return this; + }, + + empty: function() { + var elem, + i = 0; + + for ( ; (elem = this[i]) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function () { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + }); + }, + + html: function( value ) { + return jQuery.access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = value.replace( rxhtmlTag, "<$1>" ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var + // Snapshot the DOM in case .domManip sweeps something relevant into its fragment + args = jQuery.map( this, function( elem ) { + return [ elem.nextSibling, elem.parentNode ]; + }), + i = 0; + + // Make the changes, replacing each context element with the new content + this.domManip( arguments, function( elem ) { + var next = args[ i++ ], + parent = args[ i++ ]; + + if ( parent ) { + jQuery( this ).remove(); + parent.insertBefore( elem, next ); + } + // Allow new content to include elements from the context set + }, true ); + + // Force removal if there was no new content (e.g., from empty arguments) + return i ? this : this.remove(); + }, + + detach: function( selector ) { + return this.remove( selector, true ); + }, + + domManip: function( args, callback, allowIntersection ) { + + // Flatten any nested arrays + args = core_concat.apply( [], args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = this.length, + set = this, + iNoClone = l - 1, + value = args[ 0 ], + isFunction = jQuery.isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( isFunction || !( l <= 1 || typeof value !== "string" || jQuery.support.checkClone || !rchecked.test( value ) ) ) { + return this.each(function( index ) { + var self = set.eq( index ); + if ( isFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + self.domManip( args, callback, allowIntersection ); + }); + } + + if ( l ) { + fragment = jQuery.buildFragment( args, this[ 0 ].ownerDocument, false, !allowIntersection && this ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + if ( first ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + // Support: QtWebKit + // jQuery.merge because core_push.apply(_, arraylike) throws + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( this[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !data_priv.access( node, "globalEval" ) && jQuery.contains( doc, node ) ) { + + if ( node.src ) { + // Hope ajax is available... + jQuery._evalUrl( node.src ); + } else { + jQuery.globalEval( node.textContent.replace( rcleanScript, "" ) ); + } + } + } + } + } + } + + return this; + } +}); + +jQuery.each({ + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: QtWebKit + // .get() because core_push.apply(_, arraylike) throws + core_push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +}); + +jQuery.extend({ + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = jQuery.contains( elem.ownerDocument, elem ); + + // Support: IE >= 9 + // Fix Cloning issues + if ( !jQuery.support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: http://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + buildFragment: function( elems, context, scripts, selection ) { + var elem, tmp, tag, wrap, contains, j, + i = 0, + l = elems.length, + fragment = context.createDocumentFragment(), + nodes = []; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( jQuery.type( elem ) === "object" ) { + // Support: QtWebKit + // jQuery.merge because core_push.apply(_, arraylike) throws + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement("div") ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || ["", ""] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + elem.replace( rxhtmlTag, "<$1>" ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.firstChild; + } + + // Support: QtWebKit + // jQuery.merge because core_push.apply(_, arraylike) throws + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Fixes #12346 + // Support: Webkit, IE + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( (elem = nodes[ i++ ]) ) { + + // #4087 - If origin and destination elements are the same, and this is + // that element, do not do anything + if ( selection && jQuery.inArray( elem, selection ) !== -1 ) { + continue; + } + + contains = jQuery.contains( elem.ownerDocument, elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( contains ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( (elem = tmp[ j++ ]) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; + }, + + cleanData: function( elems ) { + var data, elem, type, + l = elems.length, + i = 0, + special = jQuery.event.special; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( jQuery.acceptData( elem ) ) { + + data = data_priv.access( elem ); + + if ( data ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + } + // Discard any remaining `private` and `user` data + // One day we'll replace the dual arrays with a WeakMap and this won't be an issue. + // (Splices the data objects out of the internal cache arrays) + data_user.discard( elem ); + data_priv.discard( elem ); + } + }, + + _evalUrl: function( url ) { + return jQuery.ajax({ + url: url, + type: "GET", + dataType: "text", + async: false, + global: false, + success: jQuery.globalEval + }); + } +}); + +// Support: 1.x compatibility +// Manipulating tables requires a tbody +function manipulationTarget( elem, content ) { + return jQuery.nodeName( elem, "table" ) && + jQuery.nodeName( content.nodeType === 1 ? content : content.firstChild, "tr" ) ? + + elem.getElementsByTagName("tbody")[0] || + elem.appendChild( elem.ownerDocument.createElement("tbody") ) : + elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = (elem.getAttribute("type") !== null) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + var match = rscriptTypeMasked.exec( elem.type ); + + if ( match ) { + elem.type = match[ 1 ]; + } else { + elem.removeAttribute("type"); + } + + return elem; +} + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var l = elems.length, + i = 0; + + for ( ; i < l; i++ ) { + data_priv.set( + elems[ i ], "globalEval", !refElements || data_priv.get( refElements[ i ], "globalEval" ) + ); + } +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( data_priv.hasData( src ) ) { + pdataOld = data_priv.access( src ); + pdataCur = jQuery.extend( {}, pdataOld ); + events = pdataOld.events; + + data_priv.set( dest, pdataCur ); + + if ( events ) { + delete pdataCur.handle; + pdataCur.events = {}; + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( data_user.hasData( src ) ) { + udataOld = data_user.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + data_user.set( dest, udataCur ); + } +} + + +function getAll( context, tag ) { + var ret = context.getElementsByTagName ? context.getElementsByTagName( tag || "*" ) : + context.querySelectorAll ? context.querySelectorAll( tag || "*" ) : + []; + + return tag === undefined || tag && jQuery.nodeName( context, tag ) ? + jQuery.merge( [ context ], ret ) : + ret; +} + +// Support: IE >= 9 +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && manipulation_rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} +jQuery.fn.extend({ + wrapAll: function( html ) { + var wrap; + + if ( jQuery.isFunction( html ) ) { + return this.each(function( i ) { + jQuery( this ).wrapAll( html.call(this, i) ); + }); + } + + if ( this[ 0 ] ) { + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map(function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + }).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( jQuery.isFunction( html ) ) { + return this.each(function( i ) { + jQuery( this ).wrapInner( html.call(this, i) ); + }); + } + + return this.each(function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + }); + }, + + wrap: function( html ) { + var isFunction = jQuery.isFunction( html ); + + return this.each(function( i ) { + jQuery( this ).wrapAll( isFunction ? html.call(this, i) : html ); + }); + }, + + unwrap: function() { + return this.parent().each(function() { + if ( !jQuery.nodeName( this, "body" ) ) { + jQuery( this ).replaceWith( this.childNodes ); + } + }).end(); + } +}); +var curCSS, iframe, + // swappable if display is none or starts with table except "table", "table-cell", or "table-caption" + // see here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rmargin = /^margin/, + rnumsplit = new RegExp( "^(" + core_pnum + ")(.*)$", "i" ), + rnumnonpx = new RegExp( "^(" + core_pnum + ")(?!px)[a-z%]+$", "i" ), + rrelNum = new RegExp( "^([+-])=(" + core_pnum + ")", "i" ), + elemdisplay = { BODY: "block" }, + + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: 0, + fontWeight: 400 + }, + + cssExpand = [ "Top", "Right", "Bottom", "Left" ], + cssPrefixes = [ "Webkit", "O", "Moz", "ms" ]; + +// return a css property mapped to a potentially vendor prefixed property +function vendorPropName( style, name ) { + + // shortcut for names that are not vendor prefixed + if ( name in style ) { + return name; + } + + // check for vendor prefixed names + var capName = name.charAt(0).toUpperCase() + name.slice(1), + origName = name, + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in style ) { + return name; + } + } + + return origName; +} + +function isHidden( elem, el ) { + // isHidden might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + return jQuery.css( elem, "display" ) === "none" || !jQuery.contains( elem.ownerDocument, elem ); +} + +// NOTE: we've included the "window" in window.getComputedStyle +// because jsdom on node.js will break without it. +function getStyles( elem ) { + return window.getComputedStyle( elem, null ); +} + +function showHide( elements, show ) { + var display, elem, hidden, + values = [], + index = 0, + length = elements.length; + + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + values[ index ] = data_priv.get( elem, "olddisplay" ); + display = elem.style.display; + if ( show ) { + // Reset the inline display of this element to learn if it is + // being hidden by cascaded rules or not + if ( !values[ index ] && display === "none" ) { + elem.style.display = ""; + } + + // Set elements which have been overridden with display: none + // in a stylesheet to whatever the default browser style is + // for such an element + if ( elem.style.display === "" && isHidden( elem ) ) { + values[ index ] = data_priv.access( elem, "olddisplay", css_defaultDisplay(elem.nodeName) ); + } + } else { + + if ( !values[ index ] ) { + hidden = isHidden( elem ); + + if ( display && display !== "none" || !hidden ) { + data_priv.set( elem, "olddisplay", hidden ? display : jQuery.css(elem, "display") ); + } + } + } + } + + // Set the display of most of the elements in a second loop + // to avoid the constant reflow + for ( index = 0; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + if ( !show || elem.style.display === "none" || elem.style.display === "" ) { + elem.style.display = show ? values[ index ] || "" : "none"; + } + } + + return elements; +} + +jQuery.fn.extend({ + css: function( name, value ) { + return jQuery.access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( jQuery.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + }, + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + var bool = typeof state === "boolean"; + + return this.each(function() { + if ( bool ? state : isHidden( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + }); + } +}); + +jQuery.extend({ + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Exclude the following css properties to add px + cssNumber: { + "columnCount": true, + "fillOpacity": true, + "fontWeight": true, + "lineHeight": true, + "opacity": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: { + // normalize float css property + "float": "cssFloat" + }, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = jQuery.camelCase( name ), + style = elem.style; + + name = jQuery.cssProps[ origName ] || ( jQuery.cssProps[ origName ] = vendorPropName( style, origName ) ); + + // gets hook for the prefixed version + // followed by the unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // convert relative number strings (+= or -=) to relative numbers. #7345 + if ( type === "string" && (ret = rrelNum.exec( value )) ) { + value = ( ret[1] + 1 ) * ret[2] + parseFloat( jQuery.css( elem, name ) ); + // Fixes bug #9237 + type = "number"; + } + + // Make sure that NaN and null values aren't set. See: #7116 + if ( value == null || type === "number" && isNaN( value ) ) { + return; + } + + // If a number was passed in, add 'px' to the (except for certain CSS properties) + if ( type === "number" && !jQuery.cssNumber[ origName ] ) { + value += "px"; + } + + // Fixes #8908, it can be done more correctly by specifying setters in cssHooks, + // but it would mean to define eight (for every problematic property) identical functions + if ( !jQuery.support.clearCloneStyle && value === "" && name.indexOf("background") === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !("set" in hooks) || (value = hooks.set( elem, value, extra )) !== undefined ) { + style[ name ] = value; + } + + } else { + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && (ret = hooks.get( elem, false, extra )) !== undefined ) { + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = jQuery.camelCase( name ); + + // Make sure that we're working with the right name + name = jQuery.cssProps[ origName ] || ( jQuery.cssProps[ origName ] = vendorPropName( elem.style, origName ) ); + + // gets hook for the prefixed version + // followed by the unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + //convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Return, converting to number if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || jQuery.isNumeric( num ) ? num || 0 : val; + } + return val; + } +}); + +curCSS = function( elem, name, _computed ) { + var width, minWidth, maxWidth, + computed = _computed || getStyles( elem ), + + // Support: IE9 + // getPropertyValue is only needed for .css('filter') in IE9, see #12537 + ret = computed ? computed.getPropertyValue( name ) || computed[ name ] : undefined, + style = elem.style; + + if ( computed ) { + + if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + ret = jQuery.style( elem, name ); + } + + // Support: Safari 5.1 + // A tribute to the "awesome hack by Dean Edwards" + // Safari 5.1.7 (at least) returns percentage for a larger set of values, but width seems to be reliably pixels + // this is against the CSSOM draft spec: http://dev.w3.org/csswg/cssom/#resolved-values + if ( rnumnonpx.test( ret ) && rmargin.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret; +}; + + +function setPositiveNumber( elem, value, subtract ) { + var matches = rnumsplit.exec( value ); + return matches ? + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 1 ] - ( subtract || 0 ) ) + ( matches[ 2 ] || "px" ) : + value; +} + +function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { + var i = extra === ( isBorderBox ? "border" : "content" ) ? + // If we already have the right measurement, avoid augmentation + 4 : + // Otherwise initialize for horizontal or vertical properties + name === "width" ? 1 : 0, + + val = 0; + + for ( ; i < 4; i += 2 ) { + // both box models exclude margin, so add it if we want it + if ( extra === "margin" ) { + val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); + } + + if ( isBorderBox ) { + // border-box includes padding, so remove it if we want content + if ( extra === "content" ) { + val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // at this point, extra isn't border nor margin, so remove border + if ( extra !== "margin" ) { + val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } else { + // at this point, extra isn't content, so add padding + val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // at this point, extra isn't content nor padding, so add border + if ( extra !== "padding" ) { + val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + return val; +} + +function getWidthOrHeight( elem, name, extra ) { + + // Start with offset property, which is equivalent to the border-box value + var valueIsBorderBox = true, + val = name === "width" ? elem.offsetWidth : elem.offsetHeight, + styles = getStyles( elem ), + isBorderBox = jQuery.support.boxSizing && jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // some non-html elements return undefined for offsetWidth, so check for null/undefined + // svg - https://bugzilla.mozilla.org/show_bug.cgi?id=649285 + // MathML - https://bugzilla.mozilla.org/show_bug.cgi?id=491668 + if ( val <= 0 || val == null ) { + // Fall back to computed then uncomputed css if necessary + val = curCSS( elem, name, styles ); + if ( val < 0 || val == null ) { + val = elem.style[ name ]; + } + + // Computed unit is not pixels. Stop here and return. + if ( rnumnonpx.test(val) ) { + return val; + } + + // we need the check for style in case a browser which returns unreliable values + // for getComputedStyle silently falls back to the reliable elem.style + valueIsBorderBox = isBorderBox && ( jQuery.support.boxSizingReliable || val === elem.style[ name ] ); + + // Normalize "", auto, and prepare for extra + val = parseFloat( val ) || 0; + } + + // use the active box-sizing model to add/subtract irrelevant styles + return ( val + + augmentWidthOrHeight( + elem, + name, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles + ) + ) + "px"; +} + +// Try to determine the default display value of an element +function css_defaultDisplay( nodeName ) { + var doc = document, + display = elemdisplay[ nodeName ]; + + if ( !display ) { + display = actualDisplay( nodeName, doc ); + + // If the simple way fails, read from inside an iframe + if ( display === "none" || !display ) { + // Use the already-created iframe if possible + iframe = ( iframe || + jQuery("