diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e810ebacd..c99f63cfa 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -299,7 +299,9 @@ jobs: name: test-lib ${{ matrix.target }} run: | export PATH=$PWD/bin:$PWD/dist/bin:$PATH - ./bin/test-runner --ext=.icry -F -b --exe=dist/bin/cryptol ./tests/${{ matrix.target }} + if ${{ matrix.target != 'ffi' }} || dist/bin/cryptol -v | grep -q 'FFI enabled'; then + ./bin/test-runner --ext=.icry -F -b --exe=dist/bin/cryptol ./tests/${{ matrix.target }} + fi - if: matrix.suite == 'rpc' shell: bash diff --git a/cry b/cry index 34301f165..d2436b3f2 100755 --- a/cry +++ b/cry @@ -79,11 +79,21 @@ case $COMMAND in test) echo Running tests setup_external_tools - if [ "$#" == "0" ]; then TESTS=tests; else TESTS=$*; fi + if [ "$#" == "0" ]; then + if cabal v2-exec cryptol -- -v | grep -q 'FFI enabled'; then + TESTS=(tests/*) + else + GLOBIGNORE="tests/ffi" + TESTS=(tests/*) + unset GLOBIGNORE + fi + else + TESTS=("$*") + fi $BIN/test-runner --ext=.icry \ --exe=cabal \ -F v2-run -F -v0 -F exe:cryptol -F -- -F -b \ - $TESTS + "${TESTS[@]}" ;; rpc-test) diff --git a/cryptol-remote-api/src/CryptolServer/Exceptions.hs b/cryptol-remote-api/src/CryptolServer/Exceptions.hs index ad1374ea3..43bd915ad 100644 --- a/cryptol-remote-api/src/CryptolServer/Exceptions.hs +++ b/cryptol-remote-api/src/CryptolServer/Exceptions.hs @@ -107,6 +107,10 @@ cryptolError modErr warns = NotAParameterizedModule x -> (20650, [ ("module", jsonPretty x) ]) + FFILoadErrors x errs -> + (20660, [ ("module", jsonPretty x) + , ("errors", jsonList (map jsonPretty errs)) + ]) OtherFailure x -> (29999, [ ("error", jsonString x) ]) diff --git a/cryptol.cabal b/cryptol.cabal index 7cb8d0d0a..c191941ff 100644 --- a/cryptol.cabal +++ b/cryptol.cabal @@ -37,6 +37,10 @@ flag relocatable default: True description: Don't use the Cabal-provided data directory for looking up Cryptol libraries. This is useful when the data directory can't be known ahead of time, like for a relocatable distribution. +flag ffi + default: True + description: Enable the foreign function interface + library Default-language: Haskell2010 @@ -81,6 +85,11 @@ library else build-depends: integer-gmp >= 1.0 && < 1.1 + if flag(ffi) + build-depends: libffi >= 0.2, + unix + cpp-options: -DFFI_ENABLED + Build-tool-depends: alex:alex, happy:happy hs-source-dirs: src @@ -147,6 +156,9 @@ library Cryptol.TypeCheck.TypeMap, Cryptol.TypeCheck.TypeOf, Cryptol.TypeCheck.Sanity, + Cryptol.TypeCheck.FFI, + Cryptol.TypeCheck.FFI.Error, + Cryptol.TypeCheck.FFI.FFIType, Cryptol.TypeCheck.Solver.Types, Cryptol.TypeCheck.Solver.SMT, @@ -169,6 +181,8 @@ library Cryptol.Backend, Cryptol.Backend.Arch, Cryptol.Backend.Concrete, + Cryptol.Backend.FFI, + Cryptol.Backend.FFI.Error, Cryptol.Backend.FloatHelpers, Cryptol.Backend.Monad, Cryptol.Backend.SeqMap, @@ -179,6 +193,7 @@ library Cryptol.Eval, Cryptol.Eval.Concrete, Cryptol.Eval.Env, + Cryptol.Eval.FFI, Cryptol.Eval.Generic, Cryptol.Eval.Prims, Cryptol.Eval.Reference, diff --git a/cryptol/CheckExercises.hs b/cryptol/CheckExercises.hs index de34baffb..0f9acd4fb 100644 --- a/cryptol/CheckExercises.hs +++ b/cryptol/CheckExercises.hs @@ -291,7 +291,7 @@ main = do if Seq.null (rdReplout rd) then do let cryCmd = (P.shell (exe ++ " --interactive-batch " ++ inFile ++ " -e")) - (cryEC, cryOut, _) <- P.readCreateProcessWithExitCode cryCmd "" + (cryEC, cryOut, cryErr) <- P.readCreateProcessWithExitCode cryCmd "" Line lnReplinStart _ Seq.:<| _ <- return $ rdReplin rd @@ -301,6 +301,7 @@ main = do putStrLn $ "REPL error (replin lines " ++ show lnReplinStart ++ "-" ++ show lnReplinEnd ++ ")." putStr cryOut + putStr cryErr exitFailure ExitSuccess -> do -- remove temporary input file diff --git a/docs/RefMan/FFI.rst b/docs/RefMan/FFI.rst new file mode 100644 index 000000000..6ef7ecbd9 --- /dev/null +++ b/docs/RefMan/FFI.rst @@ -0,0 +1,306 @@ +Foreign Function Interface +========================== + +The foreign function interface (FFI) allows Cryptol to call functions written in +C (or other languages that use the C calling convention). + +Platform support +---------------- + +The FFI is currently **not supported on Windows**, and only works on Unix-like +systems (macOS and Linux). + +Basic usage +----------- + +Suppose we want to call the following C function: + +.. code-block:: c + + uint32_t add(uint32_t x, uint32_t y) { + return x + y; + } + +In our Cryptol file, we write a ``foreign`` declaration with no body: + +.. code-block:: cryptol + + foreign add : [32] -> [32] -> [32] + +The C code must first be compiled into a dynamically loaded shared library. When +Cryptol loads the module containing the ``foreign`` declaration, it will look +for a shared library in the same directory as the Cryptol module, with the same +name as the Cryptol file but with a different file extension. The exact +extension it uses is platform-specific: + +* On Linux, it looks for the extension ``.so``. +* On macOS, it looks for the extension ``.dylib``. + +For example, if you are on Linux and your ``foreign`` declaration is in +``Foo.cry``, Cryptol will dynamically load ``Foo.so``. Then for each ``foreign`` +declaration it will look for a symbol with the same name in the shared library. +So in this case the function we want to call must be bound to the symbol ``add`` +in the shared library. + +Once the module is loaded, the foreign ``add`` function can be called like any +other Cryptol function. Cryptol automatically converts between Cryptol ``[32]`` +values and C ``uint32_t`` values. + +The whole process would look something like this: + +.. code-block:: + + $ cc -fPIC -shared Example.c -o Example.so + $ cryptol + Loading module Cryptol + Cryptol> :l Example.cry + Loading module Cryptol + Loading module Main + Main> add 1 2 + 0x00000003 + +Note: Since Cryptol currently only accesses the compiled binary and not the C +source, it has no way of checking that the Cryptol function type you declare in +your Cryptol code actually matches the type of the C function. **It is your +responsibility to make sure the types match up**. If they do not then there may +be undefined behavior. + +Compiling C code +---------------- + +Cryptol currently does not handle compilation of C code to shared libraries. For +simple usages, you can do this manually with the following commands: + +* Linux: ``cc -fPIC -shared Foo.c -o Foo.so`` +* macOS: ``cc -dynamiclib Foo.c -o Foo.dylib`` + +Converting between Cryptol and C types +-------------------------------------- + +This section describes how a given Cryptol function signature maps to a C +function prototype. The FFI only supports a limited set of Cryptol types which +have a clear translation into C. + +Overall structure +~~~~~~~~~~~~~~~~~ + +Cryptol ``foreign`` bindings must be functions. These functions may have +multiple (curried) arguments; they may also be polymorphic, with certain +limitations. That is, the general structure of a ``foreign`` declaration would +look something like this: + +.. code-block:: cryptol + + foreign f : {a1, ..., ak} (c1, ..., cn) => T1 -> ... -> Tm -> Tr + +Each type argument to the Cryptol function (``a1, ..., ak`` above) corresponds +to a value argument to the C function. These arguments are passed first, in the +order of the type variables declared in the Cryptol signature, before any +Cryptol value arguments. + +Each value argument to the Cryptol function (``T1, ..., Tm`` above) corresponds +to a number of value arguments to the C function. That is, a Cryptol value +argument could correspond to zero, one, or many C arguments. The C arguments for +each Cryptol value argument are passed in the order of the Cryptol value +arguments, after any C arguments corresponding to Cryptol type arguments. + +The return value of the Cryptol function (``Tr`` above) is either obtained by +directly returning from the C function or by passing *output arguments* to the C +function, depending on the return type. Output arguments are pointers to memory +which can be modified by the C function to store its output values. If output +arguments are used, they are passed last, after the C arguments corresponding to +Cryptol arguments. + +The following tables list the C type(s) that each Cryptol type (or kind) +corresponds to. + +Type parameters +~~~~~~~~~~~~~~~ + +============ ========== +Cryptol kind C type +============ ========== +``#`` ``size_t`` +============ ========== + +Only numeric type parameters are allowed in polymorphic ``foreign`` functions. +Furthermore, each type parameter ``n`` must satisfy ``fin n``. This has to be +explicitly declared in the Cryptol signature. + +Note that if a polymorphic foreign function is called with a type argument that +does not fit in a ``size_t``, there will be a runtime error. (While we could +check this statically by requiring that all type variables in foreign functions +satisfy ``< 2^^64`` instead of just ``fin``, in practice this would be too +cumbersome.) + +Bit +~~~ + +============ =========== +Cryptol type C type +============ =========== +``Bit`` ``uint8_t`` +============ =========== + +When converting to C, ``True`` is converted to ``1`` and ``False`` to ``0``. +When converting to Cryptol, any nonzero number is converted to ``True`` and +``0`` is converted to ``False``. + +Integral types +~~~~~~~~~~~~~~ + +Let ``K : #`` be a Cryptol type. Note ``K`` must be an actual fixed numeric type +and not a type variable. + +================================== ============ +Cryptol type C type +================================== ============ +``[K]Bit`` where ``0 <= K <= 8`` ``uint8_t`` +``[K]Bit`` where ``8 < K <= 16`` ``uint16_t`` +``[K]Bit`` where ``16 < K <= 32`` ``uint32_t`` +``[K]Bit`` where ``32 < K <= 64`` ``uint64_t`` +================================== ============ + +If the Cryptol type is smaller than the C type, then when converting to C the +value is padded with zero bits, and when converting to Cryptol the extra bits +are ignored. For instance, for the Cryptol type ``[4]``, the Cryptol value ``0xf +: [4]`` is converted to the C value ``uint8_t`` ``0x0f``, and the C ``uint8_t`` +``0xaf`` is converted to the Cryptol value ``0xf : [4]``. + +Note that words larger than 64 bits are not supported, since there is no +standard C integral type for that. You can split it into a sequence of smaller +words first in Cryptol, then use the FFI conversion for sequences of words to +handle it in C as an array. + +Floating point types +~~~~~~~~~~~~~~~~~~~~ + +============ ========== +Cryptol type C type +============ ========== +``Float32`` ``float`` +``Float64`` ``double`` +============ ========== + +Note: the Cryptol ``Float`` types are defined in the built-in module ``Float``. +Other sizes of floating points are not supported. + +Sequences +~~~~~~~~~ + +Let ``n : #`` be a Cryptol type, possibly containing type variables, that +satisfies ``fin n``, and ``T`` be one of the above Cryptol *integral types* or +*floating point types*. Let ``U`` be the C type that ``T`` corresponds to. + +============ =========== +Cryptol type C type +============ =========== +``[n]T`` ``U*`` +============ =========== + +The C pointer points to an array of ``n`` elements of type ``U``. Note that, +while the length of the array itself is not explicitly passed along with the +pointer, any type arguments contained in the size are passed as C ``size_t``'s +earlier, so the C code can always know the length of the array. + +Tuples and records +~~~~~~~~~~~~~~~~~~ + +Let ``T1, T2, ..., Tn`` be Cryptol types supported by the FFI (which may be any +of the types mentioned above, or tuples and records themselves). Let +``U1, U2, ..., Un`` be the C types that ``T1, T2, ..., Tn`` respectively +correspond to. Let ``f1, f2, ..., fn`` be arbitrary field names. + +================================= =================== +Cryptol type C types +================================= =================== +``(T1, T2, ..., Tn)`` ``U1, U2, ..., Un`` +``{f1: T1, f2: T2, ..., fn: Tn}`` ``U1, U2, ..., Un`` +================================= =================== + +In this case, each Cryptol tuple or record is flattened out; passing a tuple as +an argument behaves the same as if you passed its components individually. This +flattening is applied recursively for nested tuples and records. Note that this +means empty tuples don't map to any C values at all. + +Type synonyms +~~~~~~~~~~~~~ + +All type synonyms are expanded before applying the above rules, so you can use +type synonyms in ``foreign`` declarations to improve readability. + +Return values +~~~~~~~~~~~~~ + +If the Cryptol return type is ``Bit`` or one of the above *integral types* or +*floating point types*, the value is returned directly from the C function. In +that case, the return type of the C function will be the C type corresponding to +the Cryptol type, and no extra arguments are added. + +If the Cryptol return type is a sequence, tuple, or record, then the value is +returned using output arguments, and the return type of the C function will be +``void``. For tuples and records, each component is recursively returned as +output arguments. When treated as an output argument, each C type ``U`` will be +a pointer ``U*`` instead, except in the case of sequences, where the output and +input versions are the same type, because it is already a pointer. + +Quick reference +~~~~~~~~~~~~~~~ + +================================== =================== ============= ========================= +Cryptol type (or kind) C argument type(s) C return type C output argument type(s) +================================== =================== ============= ========================= +``#`` ``size_t`` N/A N/A +``Bit`` ``uint8_t`` ``uint8_t`` ``uint8_t*`` +``[K]Bit`` where ``0 <= K <= 8`` ``uint8_t`` ``uint8_t`` ``uint8_t*`` +``[K]Bit`` where ``8 < K <= 16`` ``uint16_t`` ``uint16_t`` ``uint16_t*`` +``[K]Bit`` where ``16 < K <= 32`` ``uint32_t`` ``uint32_t`` ``uint32_t*`` +``[K]Bit`` where ``32 < K <= 64`` ``uint64_t`` ``uint64_t`` ``uint64_t*`` +``Float32`` ``float`` ``float`` ``float*`` +``Float64`` ``double`` ``double`` ``double*`` +``[n]T`` ``U*`` N/A ``U*`` +``(T1, T2, ..., Tn)`` ``U1, U2, ..., Un`` N/A ``V1, V2, ..., Vn`` +``{f1: T1, f2: T2, ..., fn: Tn}`` ``U1, U2, ..., Un`` N/A ``V1, V2, ..., Vn`` +================================== =================== ============= ========================= + +where ``K`` is a constant number, ``n`` is a variable number, ``Ti`` is a type, +``Ui`` is its C argument type, and ``Vi`` is its C output argument type. + +Memory +------ + +When pointers are involved, namely in the cases of sequences and output +arguments, they point to memory. This memory is always allocated and deallocated +by Cryptol; the C code does not need to manage this memory. + +In the case of sequences, the pointer will point to an array. In the case of an +output argument for a non-sequence type, the pointer will point to a piece of +memory large enough to hold the given C type, and you should not try to access +any adjacent memory. + +For input sequence arguments, the array will already be set to the values +corresponding to the Cryptol values in the sequence. For output arguments, the +memory may be uninitialized when passed to C, and the C code should not read +from it. It must write to the memory the value it is returning. + +Evaluation +---------- + +All Cryptol arguments are fully evaluated when a foreign function is called. + +Example +------- + +The Cryptol signature + +.. code-block:: cryptol + + foreign f : {n} (fin n) => [n][10] -> {a : Bit, b : [64]} + -> (Float64, [n + 1][20]) + +corresponds to the C signature + +.. code-block:: c + + void f(size_t n, uint16_t *in0, uint8_t in1, uint64_t in2, + double *out0, uint32_t *out1); diff --git a/docs/RefMan/RefMan.rst b/docs/RefMan/RefMan.rst index c83f6da9a..02fa7eabf 100644 --- a/docs/RefMan/RefMan.rst +++ b/docs/RefMan/RefMan.rst @@ -12,4 +12,5 @@ Cryptol Reference Manual OverloadedOperations TypeDeclarations Modules + FFI diff --git a/docs/RefMan/_build/doctrees/BasicSyntax.doctree b/docs/RefMan/_build/doctrees/BasicSyntax.doctree index 3daf03c9c..921545827 100644 Binary files a/docs/RefMan/_build/doctrees/BasicSyntax.doctree and b/docs/RefMan/_build/doctrees/BasicSyntax.doctree differ diff --git a/docs/RefMan/_build/doctrees/BasicTypes.doctree b/docs/RefMan/_build/doctrees/BasicTypes.doctree index a7ba5840b..3dd801ff1 100644 Binary files a/docs/RefMan/_build/doctrees/BasicTypes.doctree and b/docs/RefMan/_build/doctrees/BasicTypes.doctree differ diff --git a/docs/RefMan/_build/doctrees/Expressions.doctree b/docs/RefMan/_build/doctrees/Expressions.doctree index 53f579161..5e3e47179 100644 Binary files a/docs/RefMan/_build/doctrees/Expressions.doctree and b/docs/RefMan/_build/doctrees/Expressions.doctree differ diff --git a/docs/RefMan/_build/doctrees/FFI.doctree b/docs/RefMan/_build/doctrees/FFI.doctree new file mode 100644 index 000000000..11ab91157 Binary files /dev/null and b/docs/RefMan/_build/doctrees/FFI.doctree differ diff --git a/docs/RefMan/_build/doctrees/Modules.doctree b/docs/RefMan/_build/doctrees/Modules.doctree index 0da8e85af..59d46a4a1 100644 Binary files a/docs/RefMan/_build/doctrees/Modules.doctree and b/docs/RefMan/_build/doctrees/Modules.doctree differ diff --git a/docs/RefMan/_build/doctrees/OverloadedOperations.doctree b/docs/RefMan/_build/doctrees/OverloadedOperations.doctree index 93fd59787..0eff73202 100644 Binary files a/docs/RefMan/_build/doctrees/OverloadedOperations.doctree and b/docs/RefMan/_build/doctrees/OverloadedOperations.doctree differ diff --git a/docs/RefMan/_build/doctrees/RefMan.doctree b/docs/RefMan/_build/doctrees/RefMan.doctree index 812de7147..8cb0ce09d 100644 Binary files a/docs/RefMan/_build/doctrees/RefMan.doctree and b/docs/RefMan/_build/doctrees/RefMan.doctree differ diff --git a/docs/RefMan/_build/doctrees/TypeDeclarations.doctree b/docs/RefMan/_build/doctrees/TypeDeclarations.doctree index c7a02e1cf..6ffeda878 100644 Binary files a/docs/RefMan/_build/doctrees/TypeDeclarations.doctree and b/docs/RefMan/_build/doctrees/TypeDeclarations.doctree differ diff --git a/docs/RefMan/_build/doctrees/environment.pickle b/docs/RefMan/_build/doctrees/environment.pickle index b3dff6690..dbda8b1dc 100644 Binary files a/docs/RefMan/_build/doctrees/environment.pickle and b/docs/RefMan/_build/doctrees/environment.pickle differ diff --git a/docs/RefMan/_build/html/.buildinfo b/docs/RefMan/_build/html/.buildinfo index 7a9e1b227..bb39e3d43 100644 --- a/docs/RefMan/_build/html/.buildinfo +++ b/docs/RefMan/_build/html/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: a4ccf7f1b3589b784c5cab7c48946aab +config: 12febdda05646d6655d93ce350355f10 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/RefMan/_build/html/BasicSyntax.html b/docs/RefMan/_build/html/BasicSyntax.html index b919ea8ef..cd9d810c6 100644 --- a/docs/RefMan/_build/html/BasicSyntax.html +++ b/docs/RefMan/_build/html/BasicSyntax.html @@ -1,7 +1,8 @@ - + + Basic Syntax — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -54,6 +56,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • @@ -80,58 +83,58 @@
    -
    -

    Basic Syntax

    -
    -

    Declarations

    -
    f x = x + y + z
    +  
    +

    Basic Syntax

    +
    +

    Declarations

    +
    f x = x + y + z
     
    -
    -
    -

    Type Signatures

    -
    f,g : {a,b} (fin a) => [a] b
    +
    +
    +

    Type Signatures

    +
    f,g : {a,b} (fin a) => [a] b
     
    -
    -
    -

    Layout

    + +
    +

    Layout

    Groups of declarations are organized based on indentation. Declarations with the same indentation belong to the same group. Lines of text that are indented more than the beginning of a declaration belong to that declaration, while lines of text that are indented less terminate a group of declarations. Consider, for example, the following Cryptol declarations:

    -
    f x = x + y + z
    -  where
    -  y = x * x
    -  z = x + y
    +
    f x = x + y + z
    +  where
    +  y = x * x
    +  z = x + y
     
    -g y = y
    +g y = y
     

    This group has two declarations, one for f and one for g. All the lines between f and g that are indented more than f belong to f. The same principle applies to the declarations in the where block of f, which defines two more local names, y and z.

    -
    -
    -

    Comments

    +
    +
    +

    Comments

    Cryptol supports block comments, which start with /* and end with */, and line comments, which start with // and terminate at the end of the line. Block comments may be nested arbitrarily.

    -
    /* This is a block comment */
    -// This is a line comment
    -/* This is a /* Nested */ block comment */
    +
    /* This is a block comment */
    +// This is a line comment
    +/* This is a /* Nested */ block comment */
     

    Todo

    Document /** */

    -
    -
    -

    Identifiers

    +
    +
    +

    Identifiers

    Cryptol identifiers consist of one or more characters. The first character must be either an English letter or underscore (_). The following characters may be an English letter, a decimal digit, @@ -140,14 +143,14 @@

    IdentifiersKeywords and Built-in Operators).

    Examples of identifiers
    -
    name    name1    name'    longer_name
    -Name    Name2    Name''   longerName
    +
    name    name1    name'    longer_name
    +Name    Name2    Name''   longerName
     
    -
    -
    -

    Keywords and Built-in Operators

    +

    +
    +

    Keywords and Built-in Operators

    The following identifiers have special meanings in Cryptol, and may not be used for programmer defined names:

    @@ -222,9 +225,9 @@

    Keywords and Built-in Operators -

    Built-in Type-level Operators

    +

    +
    +

    Built-in Type-level Operators

    Cryptol includes a variety of operators that allow computations on the numeric types used to specify the sizes of sequences.

    @@ -277,21 +280,21 @@

    Built-in Type-level Operators -

    Numeric Literals

    + +
    +

    Numeric Literals

    Numeric literals may be written in binary, octal, decimal, or hexadecimal notation. The base of a literal is determined by its prefix: 0b for binary, 0o for octal, no special prefix for decimal, and 0x for hexadecimal.

    Examples of literals
    -
    254                 // Decimal literal
    -0254                // Decimal literal
    -0b11111110          // Binary literal
    -0o376               // Octal literal
    -0xFE                // Hexadecimal literal
    -0xfe                // Hexadecimal literal
    +
    254                 // Decimal literal
    +0254                // Decimal literal
    +0b11111110          // Binary literal
    +0o376               // Octal literal
    +0xFE                // Hexadecimal literal
    +0xfe                // Hexadecimal literal
     
    @@ -302,12 +305,12 @@

    Numeric Literals -
    0b1010              // : [4],   1 * number of digits
    -0o1234              // : [12],  3 * number of digits
    -0x1234              // : [16],  4 * number of digits
    +
    0b1010              // : [4],   1 * number of digits
    +0o1234              // : [12],  3 * number of digits
    +0x1234              // : [16],  4 * number of digits
     
    -10                  // : {a}. (Literal 10 a) => a
    -                    // a = Integer or [n] where n >= width 10
    +10                  // : {a}. (Literal 10 a) => a
    +                    // a = Integer or [n] where n >= width 10
     
    @@ -317,8 +320,8 @@

    Numeric Literals -
    <| x^^6 + x^^4 + x^^2 + x^^1 + 1 |>  // : [7], equal to 0b1010111
    -<| x^^4 + x^^3 + x |>                // : [5], equal to 0b11010
    +
    <| x^^6 + x^^4 + x^^2 + x^^1 + 1 |>  // : [7], equal to 0b1010111
    +<| x^^4 + x^^3 + x |>                // : [5], equal to 0b11010
     
    @@ -331,10 +334,10 @@

    Numeric Literals -
    10.2
    -10.2e3            // 10.2 * 10^3
    -0x30.1            // 3 * 64 + 1/16
    -0x30.1p4          // (3 * 64 + 1/16) * 2^4
    +
    10.2
    +10.2e3            // 10.2 * 10^3
    +0x30.1            // 3 * 64 + 1/16
    +0x30.1p4          // (3 * 64 + 1/16) * 2^4
     
    @@ -348,13 +351,13 @@

    Numeric Literals -
    0b_0000_0010
    -0x_FFFF_FFEA
    +
    0b_0000_0010
    +0x_FFFF_FFEA
     
    -
    -

    +

    + diff --git a/docs/RefMan/_build/html/BasicTypes.html b/docs/RefMan/_build/html/BasicTypes.html index 373526e8a..1fd9d5267 100644 --- a/docs/RefMan/_build/html/BasicTypes.html +++ b/docs/RefMan/_build/html/BasicTypes.html @@ -1,7 +1,8 @@ - + + Basic Types — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -53,6 +55,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • @@ -79,79 +82,79 @@
    -
    -

    Basic Types

    -
    -

    Tuples and Records

    +
    +

    Basic Types

    +
    +

    Tuples and Records

    Tuples and records are used for packaging multiple values together. Tuples are enclosed in parentheses, while records are enclosed in curly braces. The components of both tuples and records are separated by commas. The components of tuples are expressions, while the components of records are a label and a value separated by an equal sign. Examples:

    -
    (1,2,3)           // A tuple with 3 component
    -()                // A tuple with no components
    +
    (1,2,3)           // A tuple with 3 component
    +()                // A tuple with no components
     
    -{ x = 1, y = 2 }  // A record with two fields, `x` and `y`
    -{}                // A record with no fields
    +{ x = 1, y = 2 }  // A record with two fields, `x` and `y`
    +{}                // A record with no fields
     

    The components of tuples are identified by position, while the components of records are identified by their label, and so the ordering of record components is not important for most purposes. Examples:

    -
               (1,2) == (1,2)               // True
    -           (1,2) == (2,1)               // False
    +
               (1,2) == (1,2)               // True
    +           (1,2) == (2,1)               // False
     
    -{ x = 1, y = 2 } == { x = 1, y = 2 }    // True
    -{ x = 1, y = 2 } == { y = 2, x = 1 }    // True
    +{ x = 1, y = 2 } == { x = 1, y = 2 }    // True
    +{ x = 1, y = 2 } == { y = 2, x = 1 }    // True
     

    Ordering on tuples and records is defined lexicographically. Tuple components are compared in the order they appear, whereas record fields are compared in alphabetical order of field names.

    -
    -

    Accessing Fields

    +
    +

    Accessing Fields

    The components of a record or a tuple may be accessed in two ways: via pattern matching or by using explicit component selectors. Explicit component selectors are written as follows:

    -
    (15, 20).0           == 15
    -(15, 20).1           == 20
    +
    (15, 20).0           == 15
    +(15, 20).1           == 20
     
    -{ x = 15, y = 20 }.x == 15
    +{ x = 15, y = 20 }.x == 15
     

    Explicit record selectors may be used only if the program contains sufficient type information to determine the shape of the tuple or record. For example:

    -
    type T = { sign : Bit, number : [15] }
    +
    type T = { sign : Bit, number : [15] }
     
    -// Valid definition:
    -// the type of the record is known.
    -isPositive : T -> Bit
    -isPositive x = x.sign
    +// Valid definition:
    +// the type of the record is known.
    +isPositive : T -> Bit
    +isPositive x = x.sign
     
    -// Invalid definition:
    -// insufficient type information.
    -badDef x = x.f
    +// Invalid definition:
    +// insufficient type information.
    +badDef x = x.f
     

    The components of a tuple or a record may also be accessed using pattern matching. Patterns for tuples and records mirror the syntax for constructing values: tuple patterns use parentheses, while record patterns use braces. Examples:

    -
    getFst (x,_) = x
    +
    getFst (x,_) = x
     
    -distance2 { x = xPos, y = yPos } = xPos ^^ 2 + yPos ^^ 2
    +distance2 { x = xPos, y = yPos } = xPos ^^ 2 + yPos ^^ 2
     
    -f p = x + y where
    -    (x, y) = p
    +f p = x + y where
    +    (x, y) = p
     

    Selectors are also lifted through sequence and function types, point-wise, so that the following equations should hold:

    -
    xs.l == [ x.l | x <- xs ]     // sequences
    -f.l  == \x -> (f x).l         // functions
    +
    xs.l == [ x.l | x <- xs ]     // sequences
    +f.l  == \x -> (f x).l         // functions
     

    Thus, if we have a sequence of tuples, xs, then we can quickly obtain a @@ -160,57 +163,57 @@

    Accessing Fieldsf.0 to get a function that computes only the first entry in the tuple.

    This behavior is quite handy when examining complex data at the REPL.

    -

    -
    +
    +

    Updating Fields

    The components of a record or a tuple may be updated using the following notation:

    -
    // Example values
    -r = { x = 15, y = 20 }      // a record
    -t = (True,True)             // a tuple
    -n = { pt = r, size = 100 }  // nested record
    +
    // Example values
    +r = { x = 15, y = 20 }      // a record
    +t = (True,True)             // a tuple
    +n = { pt = r, size = 100 }  // nested record
     
    -// Setting fields
    -{ r | x = 30 }          == { x = 30, y = 20 }
    -{ t | 0 = False }       == (False,True)
    +// Setting fields
    +{ r | x = 30 }          == { x = 30, y = 20 }
    +{ t | 0 = False }       == (False,True)
     
    -// Update relative to the old value
    -{ r | x -> x + 5 }      == { x = 20, y = 20 }
    +// Update relative to the old value
    +{ r | x -> x + 5 }      == { x = 20, y = 20 }
     
    -// Update a nested field
    -{ n | pt.x = 10 }       == { pt = { x = 10, y = 20 }, size = 100 }
    -{ n | pt.x -> x + 10 }  == { pt = { x = 25, y = 20 }, size = 100 }
    +// Update a nested field
    +{ n | pt.x = 10 }       == { pt = { x = 10, y = 20 }, size = 100 }
    +{ n | pt.x -> x + 10 }  == { pt = { x = 25, y = 20 }, size = 100 }
     
    -
    -
    -
    -

    Sequences

    +
    +
    +
    +

    Sequences

    A sequence is a fixed-length collection of elements of the same type. The type of a finite sequence of length n, with elements of type a is [n] a. Often, a finite sequence of bits, [n] Bit, is called a word. We may abbreviate the type [n] Bit as [n]. An infinite sequence with elements of type a has type [inf] a, and [inf] is an infinite stream of bits.

    -
    [e1,e2,e3]            // A sequence with three elements
    +
    [e1,e2,e3]            // A sequence with three elements
     
    -[t1 .. t2]            // Enumeration
    -[t1 .. <t2]           // Enumeration (exclusive bound)
    -[t1 .. t2 by n]       // Enumeration (stride)
    -[t1 .. <t2 by n]      // Enumeration (stride, ex. bound)
    -[t1 .. t2 down by n]  // Enumeration (downward stride)
    -[t1 .. >t2 down by n] // Enumeration (downward stride, ex. bound)
    -[t1, t2 .. t3]        // Enumeration (step by t2 - t1)
    +[t1 .. t2]            // Enumeration
    +[t1 .. <t2]           // Enumeration (exclusive bound)
    +[t1 .. t2 by n]       // Enumeration (stride)
    +[t1 .. <t2 by n]      // Enumeration (stride, ex. bound)
    +[t1 .. t2 down by n]  // Enumeration (downward stride)
    +[t1 .. >t2 down by n] // Enumeration (downward stride, ex. bound)
    +[t1, t2 .. t3]        // Enumeration (step by t2 - t1)
     
    -[e1 ...]              // Infinite sequence starting at e1
    -[e1, e2 ...]          // Infinite sequence stepping by e2-e1
    +[e1 ...]              // Infinite sequence starting at e1
    +[e1, e2 ...]          // Infinite sequence stepping by e2-e1
     
    -[ e | p11 <- e11, p12 <- e12    // Sequence comprehensions
    -    | p21 <- e21, p22 <- e22 ]
    +[ e | p11 <- e11, p12 <- e12    // Sequence comprehensions
    +    | p21 <- e21, p22 <- e22 ]
     
    -x = generate (\i -> e)    // Sequence from generating function
    -x @ i = e                 // Sequence with index binding
    -arr @ i @ j = e           // Two-dimensional sequence
    +x = generate (\i -> e)    // Sequence from generating function
    +x @ i = e                 // Sequence with index binding
    +arr @ i @ j = e           // Two-dimensional sequence
     

    Note: the bounds in finite sequences (those with ..) are type @@ -258,19 +261,19 @@

    Sequences
    [p1, p2, p3, p4]          // Sequence pattern
    -p1 # p2                   // Split sequence pattern
    +
    [p1, p2, p3, p4]          // Sequence pattern
    +p1 # p2                   // Split sequence pattern
     
    -
    -
    -

    Functions

    -
    \p1 p2 -> e              // Lambda expression
    -f p1 p2 = e              // Function definition
    +

    +
    +

    Functions

    +
    \p1 p2 -> e              // Lambda expression
    +f p1 p2 = e              // Function definition
     
    -
    -
    + +
    diff --git a/docs/RefMan/_build/html/Expressions.html b/docs/RefMan/_build/html/Expressions.html index d00e28191..d242cae93 100644 --- a/docs/RefMan/_build/html/Expressions.html +++ b/docs/RefMan/_build/html/Expressions.html @@ -1,7 +1,8 @@ - + + Expressions — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -55,6 +57,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • @@ -81,134 +84,134 @@
    -
    -

    Expressions

    +
    +

    Expressions

    This section provides an overview of the Cryptol’s expression syntax.

    -
    -

    Calling Functions

    -
    f 2             // call `f` with parameter `2`
    -g x y           // call `g` with two parameters: `x` and `y`
    -h (x,y)         // call `h` with one parameter,  the pair `(x,y)`
    +
    +

    Calling Functions

    +
    f 2             // call `f` with parameter `2`
    +g x y           // call `g` with two parameters: `x` and `y`
    +h (x,y)         // call `h` with one parameter,  the pair `(x,y)`
     
    -
    -
    -

    Prefix Operators

    -
    -2              // call unary `-` with parameter `2`
    -- 2             // call unary `-` with parameter `2`
    -f (-2)          // call `f` with one argument: `-2`,  parens are important
    --f 2            // call unary `-` with parameter `f 2`
    -- f 2           // call unary `-` with parameter `f 2`
    +
    +
    +

    Prefix Operators

    +
    -2              // call unary `-` with parameter `2`
    +- 2             // call unary `-` with parameter `2`
    +f (-2)          // call `f` with one argument: `-2`,  parens are important
    +-f 2            // call unary `-` with parameter `f 2`
    +- f 2           // call unary `-` with parameter `f 2`
     
    -
    -
    -

    Infix Functions

    -
    2 + 3           // call `+` with two parameters: `2` and `3`
    -2 + 3 * 5       // call `+` with two parameters: `2` and `3 * 5`
    -(+) 2 3         // call `+` with two parameters: `2` and `3`
    -f 2 + g 3       // call `+` with two parameters: `f 2` and `g 3`
    -- 2 + - 3       // call `+` with two parameters: `-2` and `-3`
    -- f 2 + - g 3
    +
    +
    +

    Infix Functions

    +
    2 + 3           // call `+` with two parameters: `2` and `3`
    +2 + 3 * 5       // call `+` with two parameters: `2` and `3 * 5`
    +(+) 2 3         // call `+` with two parameters: `2` and `3`
    +f 2 + g 3       // call `+` with two parameters: `f 2` and `g 3`
    +- 2 + - 3       // call `+` with two parameters: `-2` and `-3`
    +- f 2 + - g 3
     
    -
    -
    -

    Type Annotations

    + +
    +

    Type Annotations

    Explicit type annotations may be added on expressions, patterns, and in argument definitions.

    -
    x : Bit         // specify that `x` has type `Bit`
    -f x : Bit       // specify that `f x` has type `Bit`
    -- f x : [8]     // specify that `- f x` has type `[8]`
    -2 + 3 : [8]     // specify that `2 + 3` has type `[8]`
    -\x -> x : [8]   // type annotation is on `x`, not the function
    -if x
    -  then y
    -  else z : Bit  // the type annotation is on `z`, not the whole `if`
    -[1..9 : [8]]    // specify that elements in `[1..9]` have type `[8]`
    -
    -f (x : [8]) = x + 1   // type annotation on patterns
    +
    x : Bit         // specify that `x` has type `Bit`
    +f x : Bit       // specify that `f x` has type `Bit`
    +- f x : [8]     // specify that `- f x` has type `[8]`
    +2 + 3 : [8]     // specify that `2 + 3` has type `[8]`
    +\x -> x : [8]   // type annotation is on `x`, not the function
    +if x
    +  then y
    +  else z : Bit  // the type annotation is on `z`, not the whole `if`
    +[1..9 : [8]]    // specify that elements in `[1..9]` have type `[8]`
    +
    +f (x : [8]) = x + 1   // type annotation on patterns
     

    Todo

    Patterns with type variables

    -
    -
    -

    Explicit Type Instantiation

    +
    +
    +

    Explicit Type Instantiation

    If f is a polymorphic value with type:

    -
    f : { tyParam } tyParam
    -f = zero
    +
    f : { tyParam } tyParam
    +f = zero
     

    you can evaluate f, passing it a type parameter:

    -
    f `{ tyParam = 13 }
    +
    f `{ tyParam = 13 }
     
    -
    -
    -

    Local Declarations

    +
    +
    +

    Local Declarations

    Local declarations have the weakest precedence of all expressions.

    -
    2 + x : [T]
    -  where
    -  type T = 8
    -  x      = 2          // `T` and `x` are in scope of `2 + x : `[T]`
    +
    2 + x : [T]
    +  where
    +  type T = 8
    +  x      = 2          // `T` and `x` are in scope of `2 + x : `[T]`
     
    -if x then 1 else 2
    -  where x = 2         // `x` is in scope in the whole `if`
    +if x then 1 else 2
    +  where x = 2         // `x` is in scope in the whole `if`
     
    -\y -> x + y
    -  where x = 2         // `y` is not in scope in the defintion of `x`
    +\y -> x + y
    +  where x = 2         // `y` is not in scope in the defintion of `x`
     
    -
    -
    -

    Block Arguments

    +
    +
    +

    Block Arguments

    When used as the last argument to a function call, if and lambda expressions do not need parens:

    -
    f \x -> x       // call `f` with one argument `x -> x`
    -2 + if x
    -      then y
    -      else z    // call `+` with two arguments: `2` and `if ...`
    +
    f \x -> x       // call `f` with one argument `x -> x`
    +2 + if x
    +      then y
    +      else z    // call `+` with two arguments: `2` and `if ...`
     
    -
    -
    -

    Conditionals

    +
    +
    +

    Conditionals

    The if ... then ... else construct can be used with multiple branches. For example:

    -
    x = if y % 2 == 0 then 22 else 33
    +
    x = if y % 2 == 0 then 22 else 33
     
    -x = if y % 2 == 0 then 1
    -     | y % 3 == 0 then 2
    -     | y % 5 == 0 then 3
    -     else 7
    +x = if y % 2 == 0 then 1
    +     | y % 3 == 0 then 2
    +     | y % 5 == 0 then 3
    +     else 7
     
    -
    -
    -

    Demoting Numeric Types to Values

    +
    +
    +

    Demoting Numeric Types to Values

    The value corresponding to a numeric type may be accessed using the following notation:

    -
    `t
    +
    `t
     

    Here t should be a finite type expression with numeric kind. The resulting expression will be of a numeric base type, which is sufficiently large to accommodate the value of the type:

    -
    `t : {a} (Literal t a) => a
    +
    `t : {a} (Literal t a) => a
     

    This backtick notation is syntax sugar for an application of the number primtive, so the above may be written as:

    -
    number`{t} : {a} (Literal t a) => a
    +
    number`{t} : {a} (Literal t a) => a
     

    If a type cannot be inferred from context, a suitable type will be automatically chosen if possible, usually Integer.

    -
    -
    +
    +
    diff --git a/docs/RefMan/_build/html/FFI.html b/docs/RefMan/_build/html/FFI.html new file mode 100644 index 000000000..918a0aeec --- /dev/null +++ b/docs/RefMan/_build/html/FFI.html @@ -0,0 +1,519 @@ + + + + + + + Foreign Function Interface — Cryptol 2.11.0 documentation + + + + + + + + + + + + + + + + +
    + + +
    + +
    +
    +
    + +
    +
    +
    +
    + +
    +

    Foreign Function Interface

    +

    The foreign function interface (FFI) allows Cryptol to call functions written in +C (or other languages that use the C calling convention).

    +
    +

    Platform support

    +

    The FFI is currently not supported on Windows, and only works on Unix-like +systems (macOS and Linux).

    +
    +
    +

    Basic usage

    +

    Suppose we want to call the following C function:

    +
    uint32_t add(uint32_t x, uint32_t y) {
    +  return x + y;
    +}
    +
    +
    +

    In our Cryptol file, we write a foreign declaration with no body:

    +
    foreign add : [32] -> [32] -> [32]
    +
    +
    +

    The C code must first be compiled into a dynamically loaded shared library. When +Cryptol loads the module containing the foreign declaration, it will look +for a shared library in the same directory as the Cryptol module, with the same +name as the Cryptol file but with a different file extension. The exact +extension it uses is platform-specific:

    +
      +
    • On Linux, it looks for the extension .so.

    • +
    • On macOS, it looks for the extension .dylib.

    • +
    +

    For example, if you are on Linux and your foreign declaration is in +Foo.cry, Cryptol will dynamically load Foo.so. Then for each foreign +declaration it will look for a symbol with the same name in the shared library. +So in this case the function we want to call must be bound to the symbol add +in the shared library.

    +

    Once the module is loaded, the foreign add function can be called like any +other Cryptol function. Cryptol automatically converts between Cryptol [32] +values and C uint32_t values.

    +

    The whole process would look something like this:

    +
    $ cc -fPIC -shared Example.c -o Example.so
    +$ cryptol
    +Loading module Cryptol
    +Cryptol> :l Example.cry
    +Loading module Cryptol
    +Loading module Main
    +Main> add 1 2
    +0x00000003
    +
    +
    +

    Note: Since Cryptol currently only accesses the compiled binary and not the C +source, it has no way of checking that the Cryptol function type you declare in +your Cryptol code actually matches the type of the C function. It is your +responsibility to make sure the types match up. If they do not then there may +be undefined behavior.

    +
    +
    +

    Compiling C code

    +

    Cryptol currently does not handle compilation of C code to shared libraries. For +simple usages, you can do this manually with the following commands:

    +
      +
    • Linux: cc -fPIC -shared Foo.c -o Foo.so

    • +
    • macOS: cc -dynamiclib Foo.c -o Foo.dylib

    • +
    +
    +
    +

    Converting between Cryptol and C types

    +

    This section describes how a given Cryptol function signature maps to a C +function prototype. The FFI only supports a limited set of Cryptol types which +have a clear translation into C.

    +
    +

    Overall structure

    +

    Cryptol foreign bindings must be functions. These functions may have +multiple (curried) arguments; they may also be polymorphic, with certain +limitations. That is, the general structure of a foreign declaration would +look something like this:

    +
    foreign f : {a1, ..., ak} (c1, ..., cn) => T1 -> ... -> Tm -> Tr
    +
    +
    +

    Each type argument to the Cryptol function (a1, ..., ak above) corresponds +to a value argument to the C function. These arguments are passed first, in the +order of the type variables declared in the Cryptol signature, before any +Cryptol value arguments.

    +

    Each value argument to the Cryptol function (T1, ..., Tm above) corresponds +to a number of value arguments to the C function. That is, a Cryptol value +argument could correspond to zero, one, or many C arguments. The C arguments for +each Cryptol value argument are passed in the order of the Cryptol value +arguments, after any C arguments corresponding to Cryptol type arguments.

    +

    The return value of the Cryptol function (Tr above) is either obtained by +directly returning from the C function or by passing output arguments to the C +function, depending on the return type. Output arguments are pointers to memory +which can be modified by the C function to store its output values. If output +arguments are used, they are passed last, after the C arguments corresponding to +Cryptol arguments.

    +

    The following tables list the C type(s) that each Cryptol type (or kind) +corresponds to.

    +
    +
    +

    Type parameters

    +

    ++++ + + + + + + + + + + +

    Cryptol kind

    C type

    #

    size_t

    +

    Only numeric type parameters are allowed in polymorphic foreign functions. +Furthermore, each type parameter n must satisfy fin n. This has to be +explicitly declared in the Cryptol signature.

    +

    Note that if a polymorphic foreign function is called with a type argument that +does not fit in a size_t, there will be a runtime error. (While we could +check this statically by requiring that all type variables in foreign functions +satisfy < 2^^64 instead of just fin, in practice this would be too +cumbersome.)

    +
    +
    +

    Bit

    + ++++ + + + + + + + + + + +

    Cryptol type

    C type

    Bit

    uint8_t

    +

    When converting to C, True is converted to 1 and False to 0. +When converting to Cryptol, any nonzero number is converted to True and +0 is converted to False.

    +
    +
    +

    Integral types

    +

    Let K : # be a Cryptol type. Note K must be an actual fixed numeric type +and not a type variable.

    + ++++ + + + + + + + + + + + + + + + + + + + +

    Cryptol type

    C type

    [K]Bit where 0  <= K <= 8

    uint8_t

    [K]Bit where 8  <  K <= 16

    uint16_t

    [K]Bit where 16 <  K <= 32

    uint32_t

    [K]Bit where 32 <  K <= 64

    uint64_t

    +

    If the Cryptol type is smaller than the C type, then when converting to C the +value is padded with zero bits, and when converting to Cryptol the extra bits +are ignored. For instance, for the Cryptol type [4], the Cryptol value 0xf +: [4] is converted to the C value uint8_t 0x0f, and the C uint8_t +0xaf is converted to the Cryptol value 0xf : [4].

    +

    Note that words larger than 64 bits are not supported, since there is no +standard C integral type for that. You can split it into a sequence of smaller +words first in Cryptol, then use the FFI conversion for sequences of words to +handle it in C as an array.

    +
    +
    +

    Floating point types

    + ++++ + + + + + + + + + + + + + +

    Cryptol type

    C type

    Float32

    float

    Float64

    double

    +

    Note: the Cryptol Float types are defined in the built-in module Float. +Other sizes of floating points are not supported.

    +
    +
    +

    Sequences

    +

    Let n : # be a Cryptol type, possibly containing type variables, that +satisfies fin n, and T be one of the above Cryptol integral types or +floating point types. Let U be the C type that T corresponds to.

    + ++++ + + + + + + + + + + +

    Cryptol type

    C type

    [n]T

    U*

    +

    The C pointer points to an array of n elements of type U. Note that, +while the length of the array itself is not explicitly passed along with the +pointer, any type arguments contained in the size are passed as C size_t’s +earlier, so the C code can always know the length of the array.

    +
    +
    +

    Tuples and records

    +

    Let T1, T2, ..., Tn be Cryptol types supported by the FFI (which may be any +of the types mentioned above, or tuples and records themselves). Let +U1, U2, ..., Un be the C types that T1, T2, ..., Tn respectively +correspond to. Let f1, f2, ..., fn be arbitrary field names.

    + ++++ + + + + + + + + + + + + + +

    Cryptol type

    C types

    (T1, T2, ..., Tn)

    U1, U2, ..., Un

    {f1: T1, f2: T2, ..., fn: Tn}

    U1, U2, ..., Un

    +

    In this case, each Cryptol tuple or record is flattened out; passing a tuple as +an argument behaves the same as if you passed its components individually. This +flattening is applied recursively for nested tuples and records. Note that this +means empty tuples don’t map to any C values at all.

    +
    +
    +

    Type synonyms

    +

    All type synonyms are expanded before applying the above rules, so you can use +type synonyms in foreign declarations to improve readability.

    +
    +
    +

    Return values

    +

    If the Cryptol return type is Bit or one of the above integral types or +floating point types, the value is returned directly from the C function. In +that case, the return type of the C function will be the C type corresponding to +the Cryptol type, and no extra arguments are added.

    +

    If the Cryptol return type is a sequence, tuple, or record, then the value is +returned using output arguments, and the return type of the C function will be +void. For tuples and records, each component is recursively returned as +output arguments. When treated as an output argument, each C type U will be +a pointer U* instead, except in the case of sequences, where the output and +input versions are the same type, because it is already a pointer.

    +
    +
    +

    Quick reference

    + ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Cryptol type (or kind)

    C argument type(s)

    C return type

    C output argument type(s)

    #

    size_t

    N/A

    N/A

    Bit

    uint8_t

    uint8_t

    uint8_t*

    [K]Bit where 0  <= K <= 8

    uint8_t

    uint8_t

    uint8_t*

    [K]Bit where 8  <  K <= 16

    uint16_t

    uint16_t

    uint16_t*

    [K]Bit where 16 <  K <= 32

    uint32_t

    uint32_t

    uint32_t*

    [K]Bit where 32 <  K <= 64

    uint64_t

    uint64_t

    uint64_t*

    Float32

    float

    float

    float*

    Float64

    double

    double

    double*

    [n]T

    U*

    N/A

    U*

    (T1, T2, ..., Tn)

    U1, U2, ..., Un

    N/A

    V1, V2, ..., Vn

    {f1: T1, f2: T2, ..., fn: Tn}

    U1, U2, ..., Un

    N/A

    V1, V2, ..., Vn

    +

    where K is a constant number, n is a variable number, Ti is a type, +Ui is its C argument type, and Vi is its C output argument type.

    +
    + +
    +

    Memory

    +

    When pointers are involved, namely in the cases of sequences and output +arguments, they point to memory. This memory is always allocated and deallocated +by Cryptol; the C code does not need to manage this memory.

    +

    In the case of sequences, the pointer will point to an array. In the case of an +output argument for a non-sequence type, the pointer will point to a piece of +memory large enough to hold the given C type, and you should not try to access +any adjacent memory.

    +

    For input sequence arguments, the array will already be set to the values +corresponding to the Cryptol values in the sequence. For output arguments, the +memory may be uninitialized when passed to C, and the C code should not read +from it. It must write to the memory the value it is returning.

    +
    +
    +

    Evaluation

    +

    All Cryptol arguments are fully evaluated when a foreign function is called.

    +
    +
    +

    Example

    +

    The Cryptol signature

    +
    foreign f : {n} (fin n) => [n][10] -> {a : Bit, b : [64]}
    +                           -> (Float64, [n + 1][20])
    +
    +
    +

    corresponds to the C signature

    +
    void f(size_t n, uint16_t *in0, uint8_t in1, uint64_t in2,
    +       double *out0, uint32_t *out1);
    +
    +
    +
    + + + +
    +
    + +
    +
    + +
    + + + + \ No newline at end of file diff --git a/docs/RefMan/_build/html/Modules.html b/docs/RefMan/_build/html/Modules.html index b7b58d915..a874dd877 100644 --- a/docs/RefMan/_build/html/Modules.html +++ b/docs/RefMan/_build/html/Modules.html @@ -1,7 +1,8 @@ - + + Modules — Cryptol 2.11.0 documentation @@ -13,10 +14,12 @@ + + @@ -69,6 +72,7 @@ +
  • Foreign Function Interface
  • @@ -95,26 +99,26 @@
    -
    -

    Modules

    +
    +

    Modules

    A module is used to group some related definitions. Each file may contain at most one top-level module.

    -
    module M where
    +
    module M where
     
    -type T = [8]
    +type T = [8]
     
    -f : [8]
    -f = 10
    +f : [8]
    +f = 10
     
    -
    -

    Hierarchical Module Names

    +
    +

    Hierarchical Module Names

    Module may have either simple or hierarchical names. Hierarchical names are constructed by gluing together ordinary identifiers using the symbol ::.

    -
    module Hash::SHA256 where
    +
    module Hash::SHA256 where
     
    -sha256 = ...
    +sha256 = ...
     

    The structure in the name may be used to group together related @@ -123,104 +127,104 @@

    Hierarchical Module NamesHash::SHA256, Cryptol will look for a file named SHA256.cry in a directory called Hash, contained in one of the directories specified by CRYPTOLPATH.

    -

    -
    +
    +

    Module Imports

    To use the definitions from one module in another module, we use import declarations:

    module M
    -
    // Provide some definitions
    -module M where
    +
    // Provide some definitions
    +module M where
     
    -f : [8]
    -f = 2
    +f : [8]
    +f = 2
     
    module N
    -
    // Uses definitions from `M`
    -module N where
    +
    // Uses definitions from `M`
    +module N where
     
    -import M  // import all definitions from `M`
    +import M  // import all definitions from `M`
     
    -g = f   // `f` was imported from `M`
    +g = f   // `f` was imported from `M`
     
    -
    -

    Import Lists

    +
    +

    Import Lists

    Sometimes, we may want to import only some of the definitions from a module. To do so, we use an import declaration with an import list.

    -
    module M where
    +
    module M where
     
    -f = 0x02
    -g = 0x03
    -h = 0x04
    +f = 0x02
    +g = 0x03
    +h = 0x04
     
    -
    module N where
    +
    module N where
     
    -import M(f,g)  // Imports only `f` and `g`, but not `h`
    +import M(f,g)  // Imports only `f` and `g`, but not `h`
     
    -x = f + g
    +x = f + g
     

    Using explicit import lists helps reduce name collisions. It also tends to make code easier to understand, because it makes it easy to see the source of definitions.

    -
    -
    -

    Hiding Imports

    +
    +
    +

    Hiding Imports

    Sometimes a module may provide many definitions, and we want to use most of them but with a few exceptions (e.g., because those would result to a name clash). In such situations it is convenient to use a hiding import:

    module M
    -
    module M where
    +
    module M where
     
    -f = 0x02
    -g = 0x03
    -h = 0x04
    +f = 0x02
    +g = 0x03
    +h = 0x04
     
    module N
    -
    module N where
    +
    module N where
     
    -import M hiding (h) // Import everything but `h`
    +import M hiding (h) // Import everything but `h`
     
    -x = f + g
    +x = f + g
     
    -
    -
    -

    Qualified Module Imports

    +
    +
    +

    Qualified Module Imports

    Another way to avoid name collisions is by using a qualified import.

    module M
    -
    module M where
    +
    module M where
     
    -f : [8]
    -f = 2
    +f : [8]
    +f = 2
     
    module N
    -
    module N where
    +
    module N where
     
    -import M as P
    +import M as P
     
    -g = P::f
    -// `f` was imported from `M`
    -// but when used it needs to be prefixed by the qualifier `P`
    +g = P::f
    +// `f` was imported from `M`
    +// but when used it needs to be prefixed by the qualifier `P`
     
    @@ -229,9 +233,9 @@

    Qualified Module Imports -
    import A as B (f)         // introduces B::f
    -import X as Y hiding (f)  // introduces everything but `f` from X
    -                          // using the prefix `X`
    +
    import A as B (f)         // introduces B::f
    +import X as Y hiding (f)  // introduces everything but `f` from X
    +                          // using the prefix `X`
     
    @@ -239,34 +243,34 @@

    Qualified Module Imports -
    import A as B
    -import X as B
    +
    import A as B
    +import X as B
     

    Such declarations will introduces all definitions from A and X but to use them, you would have to qualify using the prefix B::.

    -
    -

    -
    -

    Private Blocks

    +

    +
    +
    +

    Private Blocks

    In some cases, definitions in a module might use helper functions that are not intended to be used outside the module. It is good practice to place such declarations in private blocks:

    Private blocks
    -
    module M where
    +
    module M where
     
    -f : [8]
    -f = 0x01 + helper1 + helper2
    +f : [8]
    +f = 0x01 + helper1 + helper2
     
    -private
    +private
     
    -  helper1 : [8]
    -  helper1 = 2
    +  helper1 : [8]
    +  helper1 = 2
     
    -  helper2 : [8]
    -  helper2 = 3
    +  helper2 : [8]
    +  helper2 = 3
     
    @@ -276,18 +280,18 @@

    Private Blocks -
    module M where
    +
    module M where
     
    -f : [8]
    -f = 0x01 + helper1 + helper2
    +f : [8]
    +f = 0x01 + helper1 + helper2
     
    -private
    +private
     
    -helper1 : [8]
    -helper1 = 2
    +helper1 : [8]
    +helper1 = 2
     
    -helper2 : [8]
    -helper2 = 3
    +helper2 : [8]
    +helper2 = 3
     
    @@ -297,33 +301,33 @@

    Private Blocks -
    module M where
    +
    module M where
     
    -f : [8]
    -f = 0x01 + helper1 + helper2
    +f : [8]
    +f = 0x01 + helper1 + helper2
     
    -private
    -  helper1 : [8]
    -  helper1 = 2
    +private
    +  helper1 : [8]
    +  helper1 = 2
     
    -private
    -  helper2 : [8]
    -  helper2 = 3
    +private
    +  helper2 : [8]
    +  helper2 = 3
     
    -
    -
    -

    Nested Modules

    +

    +
    +

    Nested Modules

    Module may be declared withing other modules, using the submodule keword.

    Declaring a nested module called N
    -
    module M where
    +
    module M where
     
    -  x = 0x02
    +  x = 0x02
     
    -  submodule N where
    -    y = x + 2
    +  submodule N where
    +    y = x + 2
     
    @@ -334,44 +338,44 @@

    Nested Modules -
    module M where
    +
    module M where
     
    -  x = 0x02
    +  x = 0x02
     
    -  submodule N where
    -    y = x + 2
    +  submodule N where
    +    y = x + 2
     
    -  import submodule N as P
    +  import submodule N as P
     
    -  z = 2 * P::y
    +  z = 2 * P::y
     

    Note that recursive definitions across modules are not allowed. So, in the previous example, it would be an error if y was to try to use z in its definition.

    -
    -

    Implicit Imports

    +
    +

    Implicit Imports

    For convenience, we add an implicit qualified submodule import for each locally defined submodules.

    Making use of the implicit import for a submodule.
    -
    module M where
    +
    module M where
     
    -  x = 0x02
    +  x = 0x02
     
    -  submodule N where
    -    y = x + 2
    +  submodule N where
    +    y = x + 2
     
    -  z = 2 * N::y
    +  z = 2 * N::y
     

    N::y works in the previous example because Cryptol added an implicit import import submoulde N as N.

    -
    -
    -

    Managing Module Names

    +
    +
    +

    Managing Module Names

    The names of nested modules are managed by the module system just like the name of any other declaration in Cryptol. Thus, nested modules may declared in the public or private sections of their @@ -386,43 +390,43 @@

    Managing Module Names
    -
    module A where
    +
    module A where
     
    -  x = 0x02
    +  x = 0x02
     
    -  submodule N where
    -    y = x + 2
    +  submodule N where
    +    y = x + 2
     
    -module B where
    -  import A            // Brings `N` in scope
    -  import submodule N  // Brings `y` in scope
    -  z = 2 * y
    +module B where
    +  import A            // Brings `N` in scope
    +  import submodule N  // Brings `y` in scope
    +  z = 2 * y
     
    -
    -
    -
    -

    Parameterized Modules

    +

    +

    +
    +

    Parameterized Modules

    Warning

    The documentation in this section is for the upcoming variant of the feature, which is not yet part of main line Cryptol.

    -
    -

    Interface Modules

    +
    +

    Interface Modules

    An interface module describes the content of a module without providing a concrete implementation.

    An interface module.
    -
    interface module I where
    +
    interface module I where
     
    -  type n : #      // `n` is a numeric type
    +  type n : #      // `n` is a numeric type
     
    -  type constraint (fin n, n >= 1)
    -                  // Assumptions about the declared numeric type
    +  type constraint (fin n, n >= 1)
    +                  // Assumptions about the declared numeric type
     
    -  x : [n]         // A declarations of a constant
    +  x : [n]         // A declarations of a constant
     
    @@ -430,39 +434,39 @@

    Interface Modules -
    module M where
    +
    module M where
     
    -  interface submodule I where
    +  interface submodule I where
     
    -    type n : #      // `n` is a numeric type
    +    type n : #      // `n` is a numeric type
     
    -    type constraint (fin n, n >= 1)
    -                    // Assumptions about the declared numeric type
    +    type constraint (fin n, n >= 1)
    +                    // Assumptions about the declared numeric type
     
    -    x : [n]         // A declarations of a constant
    +    x : [n]         // A declarations of a constant
     
    -
    -
    -

    Importing an Interface Module

    +

    +
    +

    Importing an Interface Module

    A module may be parameterized by importing an interface, instead of a concrete module

    A parameterized module
    -
    // The interface desribes the parmaeters
    -interface module I where
    -  type n : #
    -  type constraint (fin n, n >= 1)
    -  x : [n]
    +
    // The interface desribes the parmaeters
    +interface module I where
    +  type n : #
    +  type constraint (fin n, n >= 1)
    +  x : [n]
     
     
    -// This module is parameterized
    -module F where
    -  import interface I
    +// This module is parameterized
    +module F where
    +  import interface I
     
    -  y : [n]
    -  y = x + 1
    +  y : [n]
    +  y = x + 1
     
    @@ -474,46 +478,46 @@

    Importing an Interface ModuleInstantiating a Parameterized Module.

    Multiple interface parameters
    -
    interface module I where
    -  type n : #
    -  type constraint (fin n, n >= 1)
    -  x : [n]
    +
    interface module I where
    +  type n : #
    +  type constraint (fin n, n >= 1)
    +  x : [n]
     
     
    -module F where
    -  import interface I as I
    -  import interface I as J
    +module F where
    +  import interface I as I
    +  import interface I as J
     
    -  y : [I::n]
    -  y = I::x + 1
    +  y : [I::n]
    +  y = I::x + 1
     
    -  z : [J::n]
    -  z = J::x + 1
    +  z : [J::n]
    +  z = J::x + 1
     
    -
    -
    -

    Interface Constraints

    +

    +
    +

    Interface Constraints

    When working with multiple interfaces, it is to useful to be able to impose additional constraints on the types imported from the interface.

    Adding constraints to interface parameters
    -
    interface module I where
    -  type n : #
    -  type constraint (fin n, n >= 1)
    -  x : [n]
    +
    interface module I where
    +  type n : #
    +  type constraint (fin n, n >= 1)
    +  x : [n]
     
     
    -module F where
    -  import interface I as I
    -  import interface I as J
    +module F where
    +  import interface I as I
    +  import interface I as J
     
    -  interface constraint (I::n == J::n)
    +  interface constraint (I::n == J::n)
     
    -  y : [I::n]
    -  y = I::x + J::x
    +  y : [I::n]
    +  y = I::x + J::x
     
    @@ -521,30 +525,30 @@

    Interface Constraintsx) in both interfaces must be the same. Note that, of course, the two instantiations may provide different values for x.

    -

    -
    +
    +

    Instantiating a Parameterized Module

    To use a parameterized module we need to provide concrete implementations for the interfaces that it uses, and provide a name for the resulting module. This is done as follows:

    Instantiating a parameterized module using a single interface.
    -
    interface module I where
    -  type n : #
    -  type constraint (fin n, n >= 1)
    -  x : [n]
    +
    interface module I where
    +  type n : #
    +  type constraint (fin n, n >= 1)
    +  x : [n]
     
    -module F where
    -  import interface I
    +module F where
    +  import interface I
     
    -  y : [n]
    -  y = x + 1
    +  y : [n]
    +  y = x + 1
     
    -module Impl where
    -  type n = 8
    -  x = 26
    +module Impl where
    +  type n = 8
    +  x = 26
     
    -module MyF = F { Impl }
    +module MyF = F { Impl }
     
    @@ -556,26 +560,26 @@

    Interface Constraints
    -
    // I is defined as above
    +
    // I is defined as above
     
    -module F where
    -  import interface I as I
    -  import interface I as J
    +module F where
    +  import interface I as I
    +  import interface I as J
     
    -  interface constraint (I::n == J::n)
    +  interface constraint (I::n == J::n)
     
    -  y : [I::n]
    -  y = I::x + J::x
    +  y : [I::n]
    +  y = I::x + J::x
     
    -module Impl1 where
    -  type n = 8
    -  x = 26
    +module Impl1 where
    +  type n = 8
    +  x = 26
     
    -module Impl2 where
    -  type n = 8
    -  x = 30
    +module Impl2 where
    +  type n = 8
    +  x = 30
     
    -module MyF = F { I = Impl1, J = Impl 2 }
    +module MyF = F { I = Impl1, J = Impl 2 }
     
    @@ -590,11 +594,11 @@

    Interface Constraints
    -
    module M where
    +
    module M where
     
    -  import Somewhere // defines G
    +  import Somewhere // defines G
     
    -  submodule F = submodule G { I }
    +  submodule F = submodule G { I }
     
    @@ -608,82 +612,82 @@

    Interface Constraintssubmodule I like this:

    -
    module M where
    +
    module M where
     
    -  import Somewhere // defines G and I
    +  import Somewhere // defines G and I
     
    -  submodule F = submodule G { submodule I }
    +  submodule F = submodule G { submodule I }
     
    -
    -
    -

    Anonymous Interface Modules

    +

    +
    +

    Anonymous Interface Modules

    If we need to just parameterize a module by a couple of types/values, it is quite cumbersome to have to define a whole separate interface module. To make this more convenient we provide the following notation for defining an anonymous interface and using it straight away:

    Simple parameterized module.
    -
    module M where
    +
    module M where
     
    -  parameter
    -    type n : #
    -    type constraint (fin n, n >= 1)
    -    x : [n]
    +  parameter
    +    type n : #
    +    type constraint (fin n, n >= 1)
    +    x : [n]
     
    -  f : [n]
    -  f = 1 + x
    +  f : [n]
    +  f = 1 + x
     

    The parameter block defines an interface module and uses it. Note that the parameters may not use things defined in M as the interface is declared outside of M.

    -
    -
    -

    Anonymous Instantiation Arguments

    +
    +
    +

    Anonymous Instantiation Arguments

    Sometimes it is also a bit cumbersome to have to define a whole separate module just to pass it as an argument to some parameterized module. To make this more convenient we support the following notion for instantiation a module:

    -
    // A parameterized module
    -module M where
    +
    // A parameterized module
    +module M where
     
    -  parameter
    -    type n : #
    -    x      : [n]
    -    y      : [n]
    +  parameter
    +    type n : #
    +    x      : [n]
    +    y      : [n]
     
    -  f : [n]
    -  f = x + y
    +  f : [n]
    +  f = x + y
     
     
    -// A module instantiation
    -module N = M
    -  where
    -  type n = 32
    -  x      = 11
    -  y      = helper
    +// A module instantiation
    +module N = M
    +  where
    +  type n = 32
    +  x      = 11
    +  y      = helper
     
    -  helper = 12
    +  helper = 12
     

    The declarations in the where block are treated as the definition of an anonymous module which is passed as the argument to parameterized module M.

    -
    -
    -

    Anonymous Import Instantiations

    +
    +
    +

    Anonymous Import Instantiations

    We provide syntactic sugar for importing and instantiating a functor at the same time:

    -
    +
    +

    Passing Through Module Parameters

    Occasionally it is useful to define a functor that instantiates another functor using the same parameters as the functor being defined (i.e., a functor parameter is passed on to another functor). This can be done by using the keyword interface followed by the name of a parameter in an instantiation. Here is an example:

    -
    interface submodule S where
    -  x : [8]
    +
    interface submodule S where
    +  x : [8]
     
    -// A functor, parameterized on S
    -submodule G where
    -  import interface submodule S
    -  y = x + 1
    +// A functor, parameterized on S
    +submodule G where
    +  import interface submodule S
    +  y = x + 1
     
    -// Another functor, also parameterize on S
    -submodule F where
    -  import interface submodule S as A
    +// Another functor, also parameterize on S
    +submodule F where
    +  import interface submodule S as A
     
    -  // Instantiate `G` using parameter `A` of `F`
    -  import submodule G { interface A }    // Brings `y` in scope
    +  // Instantiate `G` using parameter `A` of `F`
    +  import submodule G { interface A }    // Brings `y` in scope
     
    -  z = A::x + y
    +  z = A::x + y
     
    -// Brings `z` into scope: z = A::x + y
    -//                          = 5    + (5 + 1)
    -//                          = 11
    -import submodule F where
    -  x = 5
    +// Brings `z` into scope: z = A::x + y
    +//                          = 5    + (5 + 1)
    +//                          = 11
    +import submodule F where
    +  x = 5
     
    -
    -
    -
    +
    +
    +

    diff --git a/docs/RefMan/_build/html/OverloadedOperations.html b/docs/RefMan/_build/html/OverloadedOperations.html index 5c1d42e44..f917ab032 100644 --- a/docs/RefMan/_build/html/OverloadedOperations.html +++ b/docs/RefMan/_build/html/OverloadedOperations.html @@ -1,7 +1,8 @@ - + + Overloaded Operations — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -55,6 +57,7 @@
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • @@ -81,102 +84,102 @@
    -
    -

    Overloaded Operations

    -
    -

    Equality

    -
    Eq
    -  (==)        : {a}    (Eq a) => a -> a -> Bit
    -  (!=)        : {a}    (Eq a) => a -> a -> Bit
    -  (===)       : {a, b} (Eq b) => (a -> b) -> (a -> b) -> (a -> Bit)
    -  (!==)       : {a, b} (Eq b) => (a -> b) -> (a -> b) -> (a -> Bit)
    +  
    +

    Overloaded Operations

    +
    +

    Equality

    +
    Eq
    +  (==)        : {a}    (Eq a) => a -> a -> Bit
    +  (!=)        : {a}    (Eq a) => a -> a -> Bit
    +  (===)       : {a, b} (Eq b) => (a -> b) -> (a -> b) -> (a -> Bit)
    +  (!==)       : {a, b} (Eq b) => (a -> b) -> (a -> b) -> (a -> Bit)
     
    -
    -
    -

    Comparisons

    -
    Cmp
    -  (<)         : {a} (Cmp a) => a -> a -> Bit
    -  (>)         : {a} (Cmp a) => a -> a -> Bit
    -  (<=)        : {a} (Cmp a) => a -> a -> Bit
    -  (>=)        : {a} (Cmp a) => a -> a -> Bit
    -  min         : {a} (Cmp a) => a -> a -> a
    -  max         : {a} (Cmp a) => a -> a -> a
    -  abs         : {a} (Cmp a, Ring a) => a -> a
    +
    +
    +

    Comparisons

    +
    Cmp
    +  (<)         : {a} (Cmp a) => a -> a -> Bit
    +  (>)         : {a} (Cmp a) => a -> a -> Bit
    +  (<=)        : {a} (Cmp a) => a -> a -> Bit
    +  (>=)        : {a} (Cmp a) => a -> a -> Bit
    +  min         : {a} (Cmp a) => a -> a -> a
    +  max         : {a} (Cmp a) => a -> a -> a
    +  abs         : {a} (Cmp a, Ring a) => a -> a
     
    -
    -
    -

    Signed Comparisons

    -
    SignedCmp
    -  (<$)        : {a} (SignedCmp a) => a -> a -> Bit
    -  (>$)        : {a} (SignedCmp a) => a -> a -> Bit
    -  (<=$)       : {a} (SignedCmp a) => a -> a -> Bit
    -  (>=$)       : {a} (SignedCmp a) => a -> a -> Bit
    +
    +
    +

    Signed Comparisons

    +
    SignedCmp
    +  (<$)        : {a} (SignedCmp a) => a -> a -> Bit
    +  (>$)        : {a} (SignedCmp a) => a -> a -> Bit
    +  (<=$)       : {a} (SignedCmp a) => a -> a -> Bit
    +  (>=$)       : {a} (SignedCmp a) => a -> a -> Bit
     
    -
    -
    -

    Zero

    -
    Zero
    -  zero        : {a} (Zero a) => a
    +
    +
    +

    Zero

    +
    Zero
    +  zero        : {a} (Zero a) => a
     
    -
    -
    -

    Logical Operations

    -
    Logic
    -  (&&)        : {a} (Logic a) => a -> a -> a
    -  (||)        : {a} (Logic a) => a -> a -> a
    -  (^)         : {a} (Logic a) => a -> a -> a
    -  complement  : {a} (Logic a) => a -> a
    +
    +
    +

    Logical Operations

    +
    Logic
    +  (&&)        : {a} (Logic a) => a -> a -> a
    +  (||)        : {a} (Logic a) => a -> a -> a
    +  (^)         : {a} (Logic a) => a -> a -> a
    +  complement  : {a} (Logic a) => a -> a
     
    -
    -
    -

    Basic Arithmetic

    -
    Ring
    -  fromInteger : {a} (Ring a) => Integer -> a
    -  (+)         : {a} (Ring a) => a -> a -> a
    -  (-)         : {a} (Ring a) => a -> a -> a
    -  (*)         : {a} (Ring a) => a -> a -> a
    -  negate      : {a} (Ring a) => a -> a
    -  (^^)        : {a, e} (Ring a, Integral e) => a -> e -> a
    +
    +
    +

    Basic Arithmetic

    +
    Ring
    +  fromInteger : {a} (Ring a) => Integer -> a
    +  (+)         : {a} (Ring a) => a -> a -> a
    +  (-)         : {a} (Ring a) => a -> a -> a
    +  (*)         : {a} (Ring a) => a -> a -> a
    +  negate      : {a} (Ring a) => a -> a
    +  (^^)        : {a, e} (Ring a, Integral e) => a -> e -> a
     
    -
    -
    -

    Integral Operations

    -
    Integral
    -  (/)         : {a} (Integral a) => a -> a -> a
    -  (%)         : {a} (Integral a) => a -> a -> a
    -  (^^)        : {a, e} (Ring a, Integral e) => a -> e -> a
    -  toInteger   : {a} (Integral a) => a -> Integer
    -  infFrom     : {a} (Integral a) => a -> [inf]a
    -  infFromThen : {a} (Integral a) => a -> a -> [inf]a
    +
    +
    +

    Integral Operations

    +
    Integral
    +  (/)         : {a} (Integral a) => a -> a -> a
    +  (%)         : {a} (Integral a) => a -> a -> a
    +  (^^)        : {a, e} (Ring a, Integral e) => a -> e -> a
    +  toInteger   : {a} (Integral a) => a -> Integer
    +  infFrom     : {a} (Integral a) => a -> [inf]a
    +  infFromThen : {a} (Integral a) => a -> a -> [inf]a
     
    -
    -
    -

    Division

    -
    Field
    -  recip       : {a} (Field a) => a -> a
    -  (/.)        : {a} (Field a) => a -> a -> a
    +
    +
    +

    Division

    +
    Field
    +  recip       : {a} (Field a) => a -> a
    +  (/.)        : {a} (Field a) => a -> a -> a
     
    -
    -
    -

    Rounding

    -
    Round
    -  ceiling     : {a} (Round a) => a -> Integer
    -  floor       : {a} (Round a) => a -> Integer
    -  trunc       : {a} (Round a) => a -> Integer
    -  roundAway   : {a} (Round a) => a -> Integer
    -  roundToEven : {a} (Round a) => a -> Integer
    +
    +
    +

    Rounding

    +
    Round
    +  ceiling     : {a} (Round a) => a -> Integer
    +  floor       : {a} (Round a) => a -> Integer
    +  trunc       : {a} (Round a) => a -> Integer
    +  roundAway   : {a} (Round a) => a -> Integer
    +  roundToEven : {a} (Round a) => a -> Integer
     
    -
    -
    + +
    diff --git a/docs/RefMan/_build/html/RefMan.html b/docs/RefMan/_build/html/RefMan.html index 1bc5da77f..c8315776b 100644 --- a/docs/RefMan/_build/html/RefMan.html +++ b/docs/RefMan/_build/html/RefMan.html @@ -1,7 +1,8 @@ - + + Cryptol Reference Manual — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -43,6 +45,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • @@ -69,8 +72,8 @@
    diff --git a/docs/RefMan/_build/html/TypeDeclarations.html b/docs/RefMan/_build/html/TypeDeclarations.html index a23564d10..1d11e58af 100644 --- a/docs/RefMan/_build/html/TypeDeclarations.html +++ b/docs/RefMan/_build/html/TypeDeclarations.html @@ -1,7 +1,8 @@ - + + Type Declarations — Cryptol 2.11.0 documentation @@ -13,6 +14,7 @@ + @@ -48,6 +50,7 @@
  • Modules
  • +
  • Foreign Function Interface
  • @@ -74,11 +77,11 @@
    -
    -

    Type Declarations

    -
    -

    Type Synonyms

    -
    type T a b = [a] b
    +  
    +

    Type Declarations

    +
    +

    Type Synonyms

    +
    type T a b = [a] b
     

    A type declaration creates a synonym for a @@ -88,10 +91,10 @@

    Type Synonyms -

    Newtypes

    -
    newtype NewT a b = { seq : [a]b }
    +

    +
    +

    Newtypes

    +
    newtype NewT a b = { seq : [a]b }
     

    A newtype declaration declares a new named type which is defined by @@ -107,8 +110,8 @@

    Newtypesnewtype declaration brings into scope a new function with the same name as the type which can be used to create values of the newtype.

    -
    x : NewT 3 Integer
    -x = NewT { seq = [1,2,3] }
    +
    x : NewT 3 Integer
    +x = NewT { seq = [1,2,3] }
     

    Just as with records, field projections can be used directly on values @@ -117,8 +120,8 @@

    Newtypes a:before{ content: "["; @@ -247,6 +246,7 @@ span.brackets > a:after { content: "]"; } + h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -334,13 +334,11 @@ aside.sidebar { p.sidebar-title { font-weight: bold; } - div.admonition, div.topic, blockquote { clear: left; } /* -- topics ---------------------------------------------------------------- */ - div.topic { border: 1px solid #ccc; padding: 7px; @@ -428,10 +426,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.footnote td, table.footnote th { - border: 0 !important; -} - th { text-align: left; padding-right: 5px; @@ -614,7 +608,6 @@ ol.simple p, ul.simple p { margin-bottom: 0; } - dl.footnote > dt, dl.citation > dt { float: left; @@ -643,11 +636,11 @@ dl.field-list > dt { padding-left: 0.5em; padding-right: 5px; } - dl.field-list > dt:after { content: ":"; } + dl.field-list > dd { padding-left: 0.5em; margin-top: 0em; @@ -731,8 +724,9 @@ dl.glossary dt { .classifier:before { font-style: normal; - margin: 0.5em; + margin: 0 0.5em; content: ":"; + display: inline-block; } abbr, acronym { @@ -756,6 +750,7 @@ span.pre { -ms-hyphens: none; -webkit-hyphens: none; hyphens: none; + white-space: nowrap; } div[class*="highlight-"] { diff --git a/docs/RefMan/_build/html/_static/doctools.js b/docs/RefMan/_build/html/_static/doctools.js index 8cbf1b161..c3db08d1c 100644 --- a/docs/RefMan/_build/html/_static/doctools.js +++ b/docs/RefMan/_build/html/_static/doctools.js @@ -2,322 +2,263 @@ * doctools.js * ~~~~~~~~~~~ * - * Sphinx JavaScript utilities for all documentation. + * Base JavaScript utilities for all Sphinx HTML documentation. * - * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ +"use strict"; -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x +const _ready = (callback) => { + if (document.readyState !== "loading") { + callback(); + } else { + document.addEventListener("DOMContentLoaded", callback); } - return decodeURIComponent(x.replace(/\+/g, ' ')); }; /** - * small helper function to urlencode strings + * highlight a given string on a node by wrapping it in + * span elements with the given class name. */ -jQuery.urlencode = encodeURIComponent; +const _highlight = (node, addItems, text, className) => { + if (node.nodeType === Node.TEXT_NODE) { + const val = node.nodeValue; + const parent = node.parentNode; + const pos = val.toLowerCase().indexOf(text); + if ( + pos >= 0 && + !parent.classList.contains(className) && + !parent.classList.contains("nohighlight") + ) { + let span; -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; + const closestNode = parent.closest("body, svg, foreignObject"); + const isInSVG = closestNode && closestNode.matches("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.classList.add(className); + } -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + parent.insertBefore( + span, + parent.insertBefore( document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } + node.nextSibling + ) + ); + node.nodeValue = val.substr(0, pos); + + if (isInSVG) { + const rect = document.createElementNS( + "http://www.w3.org/2000/svg", + "rect" + ); + const bbox = parent.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute("class", className); + addItems.push({ parent: parent, target: rect }); } } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } + } else if (node.matches && !node.matches("button, select, textarea")) { + node.childNodes.forEach((el) => _highlight(el, addItems, text, className)); } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; }; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} +const _highlightText = (thisNode, text, className) => { + let addItems = []; + _highlight(thisNode, addItems, text, className); + addItems.forEach((obj) => + obj.parent.insertAdjacentElement("beforebegin", obj.target) + ); +}; /** * Small JavaScript module for the documentation. */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } +const Documentation = { + init: () => { + Documentation.highlightSearchWords(); + Documentation.initDomainIndexTable(); + Documentation.initOnKeyListeners(); }, /** * i18n support */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', + TRANSLATIONS: {}, + PLURAL_EXPR: (n) => (n === 1 ? 0 : 1), + LOCALE: "unknown", // gettext and ngettext don't access this so that the functions // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; + gettext: (string) => { + const translated = Documentation.TRANSLATIONS[string]; + switch (typeof translated) { + case "undefined": + return string; // no translation + case "string": + return translated; // translation exists + default: + return translated[0]; // (singular, plural) translation tuple exists + } }, - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); + ngettext: (singular, plural, n) => { + const translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated !== "undefined") + return translated[Documentation.PLURAL_EXPR(n)]; + return n === 1 ? singular : plural; }, - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); + addTranslations: (catalog) => { + Object.assign(Documentation.TRANSLATIONS, catalog.messages); + Documentation.PLURAL_EXPR = new Function( + "n", + `return (${catalog.plural_expr})` + ); + Documentation.LOCALE = catalog.locale; }, /** * highlight the search words provided in the url in the text */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('') - .appendTo($('#searchbox')); - } - }, + highlightSearchWords: () => { + const highlight = + new URLSearchParams(window.location.search).get("highlight") || ""; + const terms = highlight.toLowerCase().split(/\s+/).filter(x => x); + if (terms.length === 0) return; // nothing to do - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } + // There should never be more than one element matching "div.body" + const divBody = document.querySelectorAll("div.body"); + const body = divBody.length ? divBody[0] : document.querySelector("body"); + window.setTimeout(() => { + terms.forEach((term) => _highlightText(body, term, "highlighted")); + }, 10); + + const searchBox = document.getElementById("searchbox"); + if (searchBox === null) return; + searchBox.appendChild( + document + .createRange() + .createContextualFragment( + '" + ) + ); }, /** * helper function to hide the search marks again */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); + hideSearchWords: () => { + document + .querySelectorAll("#searchbox .highlight-link") + .forEach((el) => el.remove()); + document + .querySelectorAll("span.highlighted") + .forEach((el) => el.classList.remove("highlighted")); + const url = new URL(window.location); + url.searchParams.delete("highlight"); + window.history.replaceState({}, "", url); }, /** - * make the url absolute + * helper function to focus on search bar */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + focusSearchBar: () => { + document.querySelectorAll("input[name=q]")[0]?.focus(); }, /** - * get the current relative url + * Initialise the domain index toggle buttons */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + initDomainIndexTable: () => { + const toggler = (el) => { + const idNumber = el.id.substr(7); + const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`); + if (el.src.substr(-9) === "minus.png") { + el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`; + toggledRows.forEach((el) => (el.style.display = "none")); + } else { + el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`; + toggledRows.forEach((el) => (el.style.display = "")); + } + }; + + const togglerElements = document.querySelectorAll("img.toggler"); + togglerElements.forEach((el) => + el.addEventListener("click", (event) => toggler(event.currentTarget)) + ); + togglerElements.forEach((el) => (el.style.display = "")); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler); }, - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box, textarea, dropdown or button - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey - && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; + initOnKeyListeners: () => { + // only install a listener if it is really needed + if ( + !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS + ) + return; + + const blacklistedElements = new Set([ + "TEXTAREA", + "INPUT", + "SELECT", + "BUTTON", + ]); + document.addEventListener("keydown", (event) => { + if (blacklistedElements.has(document.activeElement.tagName)) return; // bail for input elements + if (event.altKey || event.ctrlKey || event.metaKey) return; // bail with special keys + + if (!event.shiftKey) { + switch (event.key) { + case "ArrowLeft": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const prevLink = document.querySelector('link[rel="prev"]'); + if (prevLink && prevLink.href) { + window.location.href = prevLink.href; + event.preventDefault(); } break; - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; + case "ArrowRight": + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break; + + const nextLink = document.querySelector('link[rel="next"]'); + if (nextLink && nextLink.href) { + window.location.href = nextLink.href; + event.preventDefault(); } break; + case "Escape": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.hideSearchWords(); + event.preventDefault(); } } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case "/": + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break; + Documentation.focusSearchBar(); + event.preventDefault(); + } }); - } + }, }; // quick alias for translations -_ = Documentation.gettext; +const _ = Documentation.gettext; -$(document).ready(function() { - Documentation.init(); -}); +_ready(Documentation.init); diff --git a/docs/RefMan/_build/html/_static/documentation_options.js b/docs/RefMan/_build/html/_static/documentation_options.js index b6ad65f53..b1c5979a4 100644 --- a/docs/RefMan/_build/html/_static/documentation_options.js +++ b/docs/RefMan/_build/html/_static/documentation_options.js @@ -1,12 +1,14 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), VERSION: '2.11.0', - LANGUAGE: 'None', + LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', FILE_SUFFIX: '.html', LINK_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, }; \ No newline at end of file diff --git a/docs/RefMan/_build/html/_static/jquery-3.6.0.js b/docs/RefMan/_build/html/_static/jquery-3.6.0.js new file mode 100644 index 000000000..fc6c299b7 --- /dev/null +++ b/docs/RefMan/_build/html/_static/jquery-3.6.0.js @@ -0,0 +1,10881 @@ +/*! + * jQuery JavaScript Library v3.6.0 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright OpenJS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2021-03-02T17:08Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5 + // Plus for old WebKit, typeof returns "function" for HTML collections + // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756) + return typeof obj === "function" && typeof obj.nodeType !== "number" && + typeof obj.item !== "function"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.6.0", + + // Define a local copy of jQuery + jQuery = function( selector, context ) { + + // The jQuery object is actually just the init constructor 'enhanced' + // Need init if jQuery is called (just allow error to be thrown if not included) + return new jQuery.fn.init( selector, context ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return 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 all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : 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; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +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; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + 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 ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // 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" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // 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 { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), + function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); + } ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.6 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2021-02-16 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ 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 + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "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" ), + "bool": 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" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.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; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * 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 keys = []; + + function cache( 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 ); + } + return cache; +} + +/** + * 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 element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // 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; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +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 + * @param {String} type + */ +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 :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +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 ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem && elem.namespaceURI, + docElem = elem && ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); +}; + +/** + * 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 hasCompare, subWindow, + doc = node ? node.ownerDocument || node : preferredDoc; + + // Return early if doc is invalid or already selected + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + 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 !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // 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 https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // 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 + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // 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 ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + 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 ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + 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; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( 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 + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !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 ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +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 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * 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 + while ( ( node = elem[ 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 (jQuery #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[ 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[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // 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 !== "undefined" && + 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 += ""; + + /* eslint-disable max-len */ + + 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.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "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, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + 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 + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && 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 ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // 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 ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ 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( 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 ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || 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": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( 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 ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + 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; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // 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 > length ? + 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; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// 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 ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( 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, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "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 ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator 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 ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +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 multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +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( 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( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + 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( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).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 ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // 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 ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + 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, match /* 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 ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound 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; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + 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 ) && testContext( 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 if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var 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; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +} +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // 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". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // 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 <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ 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; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + 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 ( 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 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).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[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // 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( { + 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; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + 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 indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + 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 dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return 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.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], 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" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + 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.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + 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; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).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 = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + 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( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the primary Deferred + primary = jQuery.Deferred(), + + // subordinate callback factory + updateFunc = function( i ) { + return function( value ) { + resolveContexts[ i ] = this; + resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value; + if ( !( --remaining ) ) { + primary.resolveWith( resolveContexts, resolveValues ); + } + }; + }; + + // Single- and empty arguments are adopted like Promise.resolve + if ( remaining <= 1 ) { + adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject, + !remaining ); + + // Use .then() to unwrap secondary thenables (cf. gh-3000) + if ( primary.state() === "pending" || + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + + return primary.then(); + } + } + + // Multiple arguments are aggregated like Promise.all array elements + while ( i-- ) { + adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject ); + } + + return primary.promise(); + } +} ); + + +// These usually indicate a programmer mistake during development, +// warn about them ASAP rather than swallowing them by default. +var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/; + +jQuery.Deferred.exceptionHook = function( error, stack ) { + + // Support: IE 8 - 9 only + // Console exists when dev tools are open, which can happen at any time + if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) { + window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack ); + } +}; + + + + +jQuery.readyException = function( error ) { + window.setTimeout( function() { + throw error; + } ); +}; + + + + +// The deferred used on DOM ready +var readyList = jQuery.Deferred(); + +jQuery.fn.ready = function( fn ) { + + readyList + .then( fn ) + + // Wrap jQuery.readyException in a function so that the lookup + // happens at the time of error handling instead of callback + // registration. + .catch( function( error ) { + jQuery.readyException( error ); + } ); + + return this; +}; + +jQuery.extend( { + + // 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, + + // 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 ] ); + } +} ); + +jQuery.ready.then = readyList.then; + +// The ready event handler and self cleanup method +function completed() { + document.removeEventListener( "DOMContentLoaded", completed ); + window.removeEventListener( "load", completed ); + jQuery.ready(); +} + +// Catch cases where $(document).ready() is called +// after the browser event has already occurred. +// Support: IE <=9 - 10 only +// Older IE sometimes signals "interactive" too soon +if ( document.readyState === "complete" || + ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) { + + // Handle it asynchronously to allow scripts the opportunity to delay ready + window.setTimeout( jQuery.ready ); + +} else { + + // Use the handy event callback + document.addEventListener( "DOMContentLoaded", completed ); + + // A fallback to window.onload, that will always work + window.addEventListener( "load", completed ); +} + + + + +// Multifunctional method to get and set values of a collection +// The value/s can optionally be executed if it's a function +var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { + var i = 0, + len = elems.length, + bulk = key == null; + + // Sets many values + if ( toType( key ) === "object" ) { + chainable = true; + for ( i in key ) { + access( elems, fn, i, key[ i ], true, emptyGet, raw ); + } + + // Sets one value + } else if ( value !== undefined ) { + chainable = true; + + if ( !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 < len; i++ ) { + fn( + elems[ i ], key, raw ? + value : + value.call( elems[ i ], i, fn( elems[ i ], key ) ) + ); + } + } + } + + if ( chainable ) { + return elems; + } + + // Gets + if ( bulk ) { + return fn.call( elems ); + } + + return len ? fn( elems[ 0 ], key ) : emptyGet; +}; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} +var acceptData = function( owner ) { + + // Accepts only: + // - Node + // - Node.ELEMENT_NODE + // - Node.DOCUMENT_NODE + // - Object + // - Any + return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType ); +}; + + + + +function Data() { + this.expando = jQuery.expando + Data.uid++; +} + +Data.uid = 1; + +Data.prototype = { + + cache: function( owner ) { + + // Check if the owner object already has a cache + var value = owner[ this.expando ]; + + // If not, create one + if ( !value ) { + value = {}; + + // We can accept data for non-element nodes in modern browsers, + // but we should not, see #8335. + // Always return an empty object. + if ( acceptData( owner ) ) { + + // If it is a node unlikely to be stringify-ed or looped over + // use plain assignment + if ( owner.nodeType ) { + owner[ this.expando ] = value; + + // Otherwise secure it in a non-enumerable property + // configurable must be true to allow the property to be + // deleted when data is removed + } else { + Object.defineProperty( owner, this.expando, { + value: value, + configurable: true + } ); + } + } + } + + return value; + }, + set: function( owner, data, value ) { + var prop, + cache = this.cache( owner ); + + // Handle: [ owner, key, value ] args + // Always use camelCase key (gh-2257) + if ( typeof data === "string" ) { + cache[ camelCase( data ) ] = value; + + // Handle: [ owner, { properties } ] args + } else { + + // Copy the properties one-by-one to the cache object + for ( prop in data ) { + cache[ camelCase( prop ) ] = data[ prop ]; + } + } + return cache; + }, + get: function( owner, key ) { + return key === undefined ? + this.cache( owner ) : + + // Always use camelCase key (gh-2257) + owner[ this.expando ] && owner[ this.expando ][ camelCase( 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, + cache = owner[ this.expando ]; + + if ( cache === undefined ) { + return; + } + + if ( key !== undefined ) { + + // Support array or space separated string of keys + if ( Array.isArray( key ) ) { + + // If key is an array of keys... + // We always set camelCase keys, so remove that. + key = key.map( camelCase ); + } else { + key = camelCase( key ); + + // If a key with the spaces exists, use it. + // Otherwise, create an array by matching non-whitespace + key = key in cache ? + [ key ] : + ( key.match( rnothtmlwhite ) || [] ); + } + + i = key.length; + + while ( i-- ) { + delete cache[ key[ i ] ]; + } + } + + // Remove the expando if there's no more data + if ( key === undefined || jQuery.isEmptyObject( cache ) ) { + + // Support: Chrome <=35 - 45 + // Webkit & Blink performance suffers when deleting properties + // from DOM nodes, so set to undefined instead + // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted) + if ( owner.nodeType ) { + owner[ this.expando ] = undefined; + } else { + delete owner[ this.expando ]; + } + } + }, + hasData: function( owner ) { + var cache = owner[ this.expando ]; + return cache !== undefined && !jQuery.isEmptyObject( cache ); + } +}; +var dataPriv = new Data(); + +var dataUser = new Data(); + + + +// 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 rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/, + rmultiDash = /[A-Z]/g; + +function getData( data ) { + if ( data === "true" ) { + return true; + } + + if ( data === "false" ) { + return false; + } + + if ( data === "null" ) { + return null; + } + + // Only convert to a number if it doesn't change the string + if ( data === +data + "" ) { + return +data; + } + + if ( rbrace.test( data ) ) { + return JSON.parse( data ); + } + + return data; +} + +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, "-$&" ).toLowerCase(); + data = elem.getAttribute( name ); + + if ( typeof data === "string" ) { + try { + data = getData( data ); + } catch ( e ) {} + + // Make sure we set the data so it isn't changed later + dataUser.set( elem, key, data ); + } else { + data = undefined; + } + } + return data; +} + +jQuery.extend( { + hasData: function( elem ) { + return dataUser.hasData( elem ) || dataPriv.hasData( elem ); + }, + + data: function( elem, name, data ) { + return dataUser.access( elem, name, data ); + }, + + removeData: function( elem, name ) { + dataUser.remove( elem, name ); + }, + + // TODO: Now that all calls to _data and _removeData have been replaced + // with direct calls to dataPriv methods, these can be deprecated. + _data: function( elem, name, data ) { + return dataPriv.access( elem, name, data ); + }, + + _removeData: function( elem, name ) { + dataPriv.remove( elem, name ); + } +} ); + +jQuery.fn.extend( { + data: function( key, value ) { + var i, name, data, + elem = this[ 0 ], + attrs = elem && elem.attributes; + + // Gets all values + if ( key === undefined ) { + if ( this.length ) { + data = dataUser.get( elem ); + + if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) { + i = attrs.length; + while ( i-- ) { + + // Support: IE 11 only + // The attrs elements can be null (#14894) + if ( attrs[ i ] ) { + name = attrs[ i ].name; + if ( name.indexOf( "data-" ) === 0 ) { + name = camelCase( name.slice( 5 ) ); + dataAttr( elem, name, data[ name ] ); + } + } + } + dataPriv.set( elem, "hasDataAttrs", true ); + } + } + + return data; + } + + // Sets multiple values + if ( typeof key === "object" ) { + return this.each( function() { + dataUser.set( this, key ); + } ); + } + + return access( this, function( value ) { + var data; + + // 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 + // The key will always be camelCased in Data + data = dataUser.get( elem, key ); + if ( data !== undefined ) { + return data; + } + + // Attempt to "discover" the data in + // HTML5 custom data-* attrs + data = dataAttr( elem, key ); + if ( data !== undefined ) { + return data; + } + + // We tried really hard, but the data doesn't exist. + return; + } + + // Set the data... + this.each( function() { + + // We always store the camelCased key + dataUser.set( this, key, value ); + } ); + }, null, value, arguments.length > 1, null, true ); + }, + + removeData: function( key ) { + return this.each( function() { + dataUser.remove( this, key ); + } ); + } +} ); + + +jQuery.extend( { + queue: function( elem, type, data ) { + var queue; + + if ( elem ) { + type = ( type || "fx" ) + "queue"; + queue = dataPriv.get( elem, type ); + + // Speed up dequeue by getting out quickly if this is just a lookup + if ( data ) { + if ( !queue || Array.isArray( data ) ) { + queue = dataPriv.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--; + } + + 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 public - generate a queueHooks object, or return the current one + _queueHooks: function( elem, type ) { + var key = type + "queueHooks"; + return dataPriv.get( elem, key ) || dataPriv.access( elem, key, { + empty: jQuery.Callbacks( "once memory" ).add( function() { + dataPriv.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 ); + } ); + }, + 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 = dataPriv.get( elements[ i ], type + "queueHooks" ); + if ( tmp && tmp.empty ) { + count++; + tmp.empty.add( resolve ); + } + } + resolve(); + return defer.promise( obj ); + } +} ); +var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source; + +var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); + + +var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; + +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } +var isHiddenWithinTree = function( elem, el ) { + + // isHiddenWithinTree might be called from jQuery#filter function; + // in that case, element will be second argument + elem = el || elem; + + // Inline style trumps all + return elem.style.display === "none" || + elem.style.display === "" && + + // Otherwise, check computed style + // Support: Firefox <=43 - 45 + // Disconnected elements can have computed display: none, so first confirm that elem is + // in the document. + isAttached( elem ) && + + jQuery.css( elem, "display" ) === "none"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
    " ], + col: [ 2, "", "
    " ], + tr: [ 2, "", "
    " ], + td: [ 3, "", "
    " ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + 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 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var rtypenamespace = /^([^.]*)(?:\.(.+)|)/; + +function returnTrue() { + return true; +} + +function returnFalse() { + return false; +} + +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + +// Support: IE <=9 only +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 +function safeActiveElement() { + try { + return document.activeElement; + } catch ( err ) { } +} + +function on( elem, types, selector, data, fn, 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 ) { + on( elem, type, selector, data, types[ type ], one ); + } + return elem; + } + + 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 elem; + } + + 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 elem.each( function() { + jQuery.event.add( this, types, fn, data, selector ); + } ); +} + +/* + * 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 = dataPriv.get( elem ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + 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; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, 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 = Object.create( null ); + } + 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 !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + 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 ); + } + } + } + + 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; + } + + }, + + // 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 = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + 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 data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + 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() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.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, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( 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 ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + + // Support: Chrome 86+ + // In Chrome, if an element having a focusout handler is blurred by + // clicking outside of it, it invokes the handler synchronously. If + // that handler calls `.remove()` on the element, the data is cleared, + // leaving `result` undefined. We need to guard against this. + return result && result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} + +jQuery.removeEvent = function( elem, type, handle ) { + + // This "if" is needed for plain objects + if ( elem.removeEventListener ) { + elem.removeEventListener( type, handle ); + } +}; + +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.defaultPrevented === undefined && + + // Support: Android <=2.3 only + src.returnValue === false ? + returnTrue : + returnFalse; + + // Create target properties + // Support: Safari <=6 - 7 only + // Target should not be a text node (#504, #13143) + this.target = ( src.target && src.target.nodeType === 3 ) ? + src.target.parentNode : + src.target; + + this.currentTarget = src.currentTarget; + this.relatedTarget = src.relatedTarget; + + // 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 || Date.now(); + + // Mark it as fixed + this[ jQuery.expando ] = true; +}; + +// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding +// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html +jQuery.Event.prototype = { + constructor: jQuery.Event, + isDefaultPrevented: returnFalse, + isPropagationStopped: returnFalse, + isImmediatePropagationStopped: returnFalse, + isSimulated: false, + + preventDefault: function() { + var e = this.originalEvent; + + this.isDefaultPrevented = returnTrue; + + if ( e && !this.isSimulated ) { + e.preventDefault(); + } + }, + stopPropagation: function() { + var e = this.originalEvent; + + this.isPropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopPropagation(); + } + }, + stopImmediatePropagation: function() { + var e = this.originalEvent; + + this.isImmediatePropagationStopped = returnTrue; + + if ( e && !this.isSimulated ) { + e.stopImmediatePropagation(); + } + + this.stopPropagation(); + } +}; + +// Includes all common event props including KeyEvent and MouseEvent specific props +jQuery.each( { + altKey: true, + bubbles: true, + cancelable: true, + changedTouches: true, + ctrlKey: true, + detail: true, + eventPhase: true, + metaKey: true, + pageX: true, + pageY: true, + shiftKey: true, + view: true, + "char": true, + code: true, + charCode: true, + key: true, + keyCode: true, + button: true, + buttons: true, + clientX: true, + clientY: true, + offsetX: true, + offsetY: true, + pointerId: true, + pointerType: true, + screenX: true, + screenY: true, + targetTouches: true, + toElement: true, + touches: true, + which: true +}, jQuery.event.addProp ); + +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + // Suppress native focus or blur as it's already being fired + // in leverageNative. + _default: function() { + return true; + }, + + delegateType: delegateType + }; +} ); + +// Create mouseenter/leave events using mouseover/out and event-time checks +// so that event delegation works in jQuery. +// Do the same for pointerenter/pointerleave and pointerover/pointerout +// +// Support: Safari 7 only +// Safari sends mouseenter too often; see: +// https://bugs.chromium.org/p/chromium/issues/detail?id=470258 +// for the description of the bug (it existed in older Chrome versions as well). +jQuery.each( { + mouseenter: "mouseover", + mouseleave: "mouseout", + pointerenter: "pointerover", + pointerleave: "pointerout" +}, 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 mouseenter/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; + } + }; +} ); + +jQuery.fn.extend( { + + on: function( types, selector, data, fn ) { + return on( this, types, selector, data, fn ); + }, + one: function( types, selector, data, fn ) { + return on( this, 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 ); + } ); + } +} ); + + +var + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return 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 ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle 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 ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +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" && 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; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + 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: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ 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 || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://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; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + 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 ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, 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 domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + 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 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 = jQuery.htmlPrefilter( value ); + + 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 ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +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: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + 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.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + // + // Support: Firefox 70+ + // Only Firefox includes border widths + // in computed dimensions. (gh-4529) + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate"; + tr.style.cssText = "border:1px solid"; + + // Support: Chrome 86+ + // Height set through cssText does not get applied. + // Computed height then comes back as 0. + tr.style.height = "1px"; + trChild.style.height = "9px"; + + // Support: Android 8 Chrome 86+ + // In our bodyBackground.html iframe, + // display for all div elements is set to "inline", + // which causes a problem only in Android 8 Chrome 86. + // Ensuring the div is display: block + // gets around this issue. + trChild.style.display = "block"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) + + parseInt( trStyle.borderTopWidth, 10 ) + + parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.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 !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // 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]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +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; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": 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: {}, + + // 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 = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !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 ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + 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 = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + 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 ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.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 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.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 = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// 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.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", 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. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + 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; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.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 ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-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 + !option.disabled && + ( !option.parentNode.disabled || + !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 ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = 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( "." ) > -1 ) { + + // 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.rnamespace = 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 && !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() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === 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 ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !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; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + 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 ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml, parserErrorElem; + if ( !data || typeof data !== "string" ) { + return null; + } + + // Support: IE 9 - 11 only + // IE throws on parseFromString with invalid input. + try { + xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" ); + } catch ( e ) {} + + parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ]; + if ( !xml || parserErrorElem ) { + jQuery.error( "Invalid XML: " + ( + parserErrorElem ? + jQuery.map( parserErrorElem.childNodes, function( el ) { + return el.textContent; + } ).join( "\n" ) : + data + ) ); + } + return xml; +}; + + +var + rbracket = /\[\]$/, + rCRLF = /\r?\n/g, + rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i, + rsubmittable = /^(?:input|select|textarea|keygen)/i; + +function buildParams( prefix, obj, traditional, add ) { + var name; + + if ( Array.isArray( obj ) ) { + + // Serialize array item. + jQuery.each( obj, function( i, v ) { + if ( traditional || rbracket.test( prefix ) ) { + + // Treat each array item as a scalar. + add( prefix, v ); + + } else { + + // Item is non-scalar (array or object), encode its numeric index. + buildParams( + prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]", + v, + traditional, + add + ); + } + } ); + + } else if ( !traditional && toType( obj ) === "object" ) { + + // Serialize object item. + for ( name in obj ) { + buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add ); + } + + } else { + + // Serialize scalar item. + add( prefix, obj ); + } +} + +// Serialize an array of form elements or a set of +// key/values into a query string +jQuery.param = function( a, traditional ) { + var prefix, + s = [], + add = function( key, valueOrFunction ) { + + // If value is a function, invoke it and use its return value + var value = isFunction( valueOrFunction ) ? + valueOrFunction() : + valueOrFunction; + + s[ s.length ] = encodeURIComponent( key ) + "=" + + encodeURIComponent( value == null ? "" : value ); + }; + + if ( a == null ) { + return ""; + } + + // If an array was passed in, assume that it is an array of form elements. + if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { + + // Serialize the form elements + jQuery.each( a, function() { + add( this.name, this.value ); + } ); + + } else { + + // If traditional, encode the "old" way (the way 1.3.2 or older + // did it), otherwise encode params recursively. + for ( prefix in a ) { + buildParams( prefix, a[ prefix ], traditional, add ); + } + } + + // Return the resulting serialization + return s.join( "&" ); +}; + +jQuery.fn.extend( { + serialize: function() { + return jQuery.param( this.serializeArray() ); + }, + serializeArray: function() { + return this.map( function() { + + // Can add propHook for "elements" to filter or add form elements + var elements = jQuery.prop( this, "elements" ); + return elements ? jQuery.makeArray( elements ) : this; + } ).filter( function() { + var type = this.type; + + // Use .is( ":disabled" ) so that fieldset[disabled] works + return this.name && !jQuery( this ).is( ":disabled" ) && + rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && + ( this.checked || !rcheckableType.test( type ) ); + } ).map( function( _i, elem ) { + var val = jQuery( this ).val(); + + if ( val == null ) { + return null; + } + + if ( Array.isArray( val ) ) { + return jQuery.map( val, function( val ) { + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ); + } + + return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) }; + } ).get(); + } +} ); + + +var + r20 = /%20/g, + rhash = /#.*$/, + rantiCache = /([?&])_=[^&]*/, + rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg, + + // #7653, #8125, #8152: local protocol detection + rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/, + rnoContent = /^(?:GET|HEAD)$/, + rprotocol = /^\/\//, + + /* Prefilters + * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example) + * 2) These are called: + * - BEFORE asking for a transport + * - AFTER param serialization (s.data is a string if s.processData is true) + * 3) key is the dataType + * 4) the catchall symbol "*" can be used + * 5) execution will start with transport dataType and THEN continue down to "*" if needed + */ + prefilters = {}, + + /* Transports bindings + * 1) key is the dataType + * 2) the catchall symbol "*" can be used + * 3) selection will start with transport dataType and THEN go to "*" if needed + */ + transports = {}, + + // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression + allTypes = "*/".concat( "*" ), + + // Anchor tag for parsing the document origin + originAnchor = document.createElement( "a" ); + +originAnchor.href = location.href; + +// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport +function addToPrefiltersOrTransports( structure ) { + + // dataTypeExpression is optional and defaults to "*" + return function( dataTypeExpression, func ) { + + if ( typeof dataTypeExpression !== "string" ) { + func = dataTypeExpression; + dataTypeExpression = "*"; + } + + var dataType, + i = 0, + dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; + + if ( isFunction( func ) ) { + + // For each dataType in the dataTypeExpression + while ( ( dataType = dataTypes[ i++ ] ) ) { + + // Prepend if requested + if ( dataType[ 0 ] === "+" ) { + dataType = dataType.slice( 1 ) || "*"; + ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func ); + + // Otherwise append + } else { + ( structure[ dataType ] = structure[ dataType ] || [] ).push( func ); + } + } + } + }; +} + +// Base inspection function for prefilters and transports +function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) { + + var inspected = {}, + seekingTransport = ( structure === transports ); + + function inspect( dataType ) { + var selected; + inspected[ dataType ] = true; + jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) { + var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR ); + if ( typeof dataTypeOrTransport === "string" && + !seekingTransport && !inspected[ dataTypeOrTransport ] ) { + + options.dataTypes.unshift( dataTypeOrTransport ); + inspect( dataTypeOrTransport ); + return false; + } else if ( seekingTransport ) { + return !( selected = dataTypeOrTransport ); + } + } ); + return selected; + } + + return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" ); +} + +// A special extend for ajax options +// that takes "flat" options (not to be deep extended) +// Fixes #9887 +function ajaxExtend( target, src ) { + var key, deep, + flatOptions = jQuery.ajaxSettings.flatOptions || {}; + + for ( key in src ) { + if ( src[ key ] !== undefined ) { + ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ]; + } + } + if ( deep ) { + jQuery.extend( true, target, deep ); + } + + return target; +} + +/* Handles responses to an ajax request: + * - finds the right dataType (mediates between content-type and expected dataType) + * - returns the corresponding response + */ +function ajaxHandleResponses( s, jqXHR, responses ) { + + var ct, type, finalDataType, firstDataType, + contents = s.contents, + dataTypes = s.dataTypes; + + // Remove auto dataType and get content-type in the process + while ( dataTypes[ 0 ] === "*" ) { + dataTypes.shift(); + if ( ct === undefined ) { + ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" ); + } + } + + // Check if we're dealing with a known content-type + if ( ct ) { + for ( type in contents ) { + if ( contents[ type ] && contents[ type ].test( ct ) ) { + dataTypes.unshift( type ); + break; + } + } + } + + // Check to see if we have a response for the expected dataType + if ( dataTypes[ 0 ] in responses ) { + finalDataType = dataTypes[ 0 ]; + } else { + + // Try convertible dataTypes + for ( type in responses ) { + if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) { + finalDataType = type; + break; + } + if ( !firstDataType ) { + firstDataType = type; + } + } + + // Or just use first one + finalDataType = finalDataType || firstDataType; + } + + // If we found a dataType + // We add the dataType to the list if needed + // and return the corresponding response + if ( finalDataType ) { + if ( finalDataType !== dataTypes[ 0 ] ) { + dataTypes.unshift( finalDataType ); + } + return responses[ finalDataType ]; + } +} + +/* Chain conversions given the request and the original response + * Also sets the responseXXX fields on the jqXHR instance + */ +function ajaxConvert( s, response, jqXHR, isSuccess ) { + var conv2, current, conv, tmp, prev, + converters = {}, + + // Work with a copy of dataTypes in case we need to modify it for conversion + dataTypes = s.dataTypes.slice(); + + // Create converters map with lowercased keys + if ( dataTypes[ 1 ] ) { + for ( conv in s.converters ) { + converters[ conv.toLowerCase() ] = s.converters[ conv ]; + } + } + + current = dataTypes.shift(); + + // Convert to each sequential dataType + while ( current ) { + + if ( s.responseFields[ current ] ) { + jqXHR[ s.responseFields[ current ] ] = response; + } + + // Apply the dataFilter if provided + if ( !prev && isSuccess && s.dataFilter ) { + response = s.dataFilter( response, s.dataType ); + } + + prev = current; + current = dataTypes.shift(); + + if ( current ) { + + // There's only work to do if current dataType is non-auto + if ( current === "*" ) { + + current = prev; + + // Convert response if prev dataType is non-auto and differs from current + } else if ( prev !== "*" && prev !== current ) { + + // Seek a direct converter + conv = converters[ prev + " " + current ] || converters[ "* " + current ]; + + // If none found, seek a pair + if ( !conv ) { + for ( conv2 in converters ) { + + // If conv2 outputs current + tmp = conv2.split( " " ); + if ( tmp[ 1 ] === current ) { + + // If prev can be converted to accepted input + conv = converters[ prev + " " + tmp[ 0 ] ] || + converters[ "* " + tmp[ 0 ] ]; + if ( conv ) { + + // Condense equivalence converters + if ( conv === true ) { + conv = converters[ conv2 ]; + + // Otherwise, insert the intermediate dataType + } else if ( converters[ conv2 ] !== true ) { + current = tmp[ 0 ]; + dataTypes.unshift( tmp[ 1 ] ); + } + break; + } + } + } + } + + // Apply converter (if not an equivalence) + if ( conv !== true ) { + + // Unless errors are allowed to bubble, catch and return them + if ( conv && s.throws ) { + response = conv( response ); + } else { + try { + response = conv( response ); + } catch ( e ) { + return { + state: "parsererror", + error: conv ? e : "No conversion from " + prev + " to " + current + }; + } + } + } + } + } + } + + return { state: "success", data: response }; +} + +jQuery.extend( { + + // Counter for holding the number of active queries + active: 0, + + // Last-Modified header cache for next request + lastModified: {}, + etag: {}, + + ajaxSettings: { + url: location.href, + type: "GET", + isLocal: rlocalProtocol.test( location.protocol ), + global: true, + processData: true, + async: true, + contentType: "application/x-www-form-urlencoded; charset=UTF-8", + + /* + timeout: 0, + data: null, + dataType: null, + username: null, + password: null, + cache: null, + throws: false, + traditional: false, + headers: {}, + */ + + accepts: { + "*": allTypes, + text: "text/plain", + html: "text/html", + xml: "application/xml, text/xml", + json: "application/json, text/javascript" + }, + + contents: { + xml: /\bxml\b/, + html: /\bhtml/, + json: /\bjson\b/ + }, + + responseFields: { + xml: "responseXML", + text: "responseText", + json: "responseJSON" + }, + + // Data converters + // Keys separate source (or catchall "*") and destination types with a single space + converters: { + + // Convert anything to text + "* text": String, + + // Text to html (true = no transformation) + "text html": true, + + // Evaluate text as a json expression + "text json": JSON.parse, + + // Parse text as xml + "text xml": jQuery.parseXML + }, + + // For options that shouldn't be deep extended: + // you can add your own custom options here if + // and when you create one that shouldn't be + // deep extended (see ajaxExtend) + flatOptions: { + url: true, + context: true + } + }, + + // Creates a full fledged settings object into target + // with both ajaxSettings and settings fields. + // If target is omitted, writes into ajaxSettings. + ajaxSetup: function( target, settings ) { + return settings ? + + // Building a settings object + ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) : + + // Extending ajaxSettings + ajaxExtend( jQuery.ajaxSettings, target ); + }, + + ajaxPrefilter: addToPrefiltersOrTransports( prefilters ), + ajaxTransport: addToPrefiltersOrTransports( transports ), + + // Main method + ajax: function( url, options ) { + + // If url is an object, simulate pre-1.5 signature + if ( typeof url === "object" ) { + options = url; + url = undefined; + } + + // Force options to be an object + options = options || {}; + + var transport, + + // URL without anti-cache param + cacheURL, + + // Response headers + responseHeadersString, + responseHeaders, + + // timeout handle + timeoutTimer, + + // Url cleanup var + urlAnchor, + + // Request state (becomes false upon send and true upon completion) + completed, + + // To know if global events are to be dispatched + fireGlobals, + + // Loop variable + i, + + // uncached part of the url + uncached, + + // Create the final options object + s = jQuery.ajaxSetup( {}, options ), + + // Callbacks context + callbackContext = s.context || s, + + // Context for global events is callbackContext if it is a DOM node or jQuery collection + globalEventContext = s.context && + ( callbackContext.nodeType || callbackContext.jquery ) ? + jQuery( callbackContext ) : + jQuery.event, + + // Deferreds + deferred = jQuery.Deferred(), + completeDeferred = jQuery.Callbacks( "once memory" ), + + // Status-dependent callbacks + statusCode = s.statusCode || {}, + + // Headers (they are sent all at once) + requestHeaders = {}, + requestHeadersNames = {}, + + // Default abort message + strAbort = "canceled", + + // Fake xhr + jqXHR = { + readyState: 0, + + // Builds headers hashtable if needed + getResponseHeader: function( key ) { + var match; + if ( completed ) { + if ( !responseHeaders ) { + responseHeaders = {}; + while ( ( match = rheaders.exec( responseHeadersString ) ) ) { + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); + } + } + match = responseHeaders[ key.toLowerCase() + " " ]; + } + return match == null ? null : match.join( ", " ); + }, + + // Raw string + getAllResponseHeaders: function() { + return completed ? responseHeadersString : null; + }, + + // Caches the header + setRequestHeader: function( name, value ) { + if ( completed == null ) { + name = requestHeadersNames[ name.toLowerCase() ] = + requestHeadersNames[ name.toLowerCase() ] || name; + requestHeaders[ name ] = value; + } + return this; + }, + + // Overrides response content-type header + overrideMimeType: function( type ) { + if ( completed == null ) { + s.mimeType = type; + } + return this; + }, + + // Status-dependent callbacks + statusCode: function( map ) { + var code; + if ( map ) { + if ( completed ) { + + // Execute the appropriate callbacks + jqXHR.always( map[ jqXHR.status ] ); + } else { + + // Lazy-add the new callbacks in a way that preserves old ones + for ( code in map ) { + statusCode[ code ] = [ statusCode[ code ], map[ code ] ]; + } + } + } + return this; + }, + + // Cancel the request + abort: function( statusText ) { + var finalText = statusText || strAbort; + if ( transport ) { + transport.abort( finalText ); + } + done( 0, finalText ); + return this; + } + }; + + // Attach deferreds + deferred.promise( jqXHR ); + + // Add protocol if not provided (prefilters might expect it) + // Handle falsy url in the settings object (#10093: consistency with old signature) + // We also use the url parameter if available + s.url = ( ( url || s.url || location.href ) + "" ) + .replace( rprotocol, location.protocol + "//" ); + + // Alias method option to type as per ticket #12004 + s.type = options.method || options.type || s.method || s.type; + + // Extract dataTypes list + s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ]; + + // A cross-domain request is in order when the origin doesn't match the current origin. + if ( s.crossDomain == null ) { + urlAnchor = document.createElement( "a" ); + + // Support: IE <=8 - 11, Edge 12 - 15 + // IE throws exception on accessing the href property if url is malformed, + // e.g. http://example.com:80x/ + try { + urlAnchor.href = s.url; + + // Support: IE <=8 - 11 only + // Anchor's host property isn't correctly set when s.url is relative + urlAnchor.href = urlAnchor.href; + s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !== + urlAnchor.protocol + "//" + urlAnchor.host; + } catch ( e ) { + + // If there is an error parsing the URL, assume it is crossDomain, + // it can be rejected by the transport if it is invalid + s.crossDomain = true; + } + } + + // Convert data if not already a string + if ( s.data && s.processData && typeof s.data !== "string" ) { + s.data = jQuery.param( s.data, s.traditional ); + } + + // Apply prefilters + inspectPrefiltersOrTransports( prefilters, s, options, jqXHR ); + + // If request was aborted inside a prefilter, stop there + if ( completed ) { + return jqXHR; + } + + // We can fire global events as of now if asked to + // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118) + fireGlobals = jQuery.event && s.global; + + // Watch for a new set of requests + if ( fireGlobals && jQuery.active++ === 0 ) { + jQuery.event.trigger( "ajaxStart" ); + } + + // Uppercase the type + s.type = s.type.toUpperCase(); + + // Determine if request has content + s.hasContent = !rnoContent.test( s.type ); + + // Save the URL in case we're toying with the If-Modified-Since + // and/or If-None-Match header later on + // Remove hash to simplify url manipulation + cacheURL = s.url.replace( rhash, "" ); + + // More options handling for requests with no content + if ( !s.hasContent ) { + + // Remember the hash so we can put it back + uncached = s.url.slice( cacheURL.length ); + + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { + cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; + + // #9682: remove data so that it's not used in an eventual retry + delete s.data; + } + + // Add or update anti-cache param if needed + if ( s.cache === false ) { + cacheURL = cacheURL.replace( rantiCache, "$1" ); + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script but not if jsonp + if ( !isSuccess && + jQuery.inArray( "script", s.dataTypes ) > -1 && + jQuery.inArray( "json", s.dataTypes ) < 0 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( 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 ( 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 htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " + @@ -42,6 +43,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • diff --git a/docs/RefMan/_build/html/objects.inv b/docs/RefMan/_build/html/objects.inv index 722ba416f..00c5c0810 100644 Binary files a/docs/RefMan/_build/html/objects.inv and b/docs/RefMan/_build/html/objects.inv differ diff --git a/docs/RefMan/_build/html/search.html b/docs/RefMan/_build/html/search.html index 7e61ed64b..171f62c6a 100644 --- a/docs/RefMan/_build/html/search.html +++ b/docs/RefMan/_build/html/search.html @@ -14,6 +14,7 @@ + @@ -45,6 +46,7 @@
  • Overloaded Operations
  • Type Declarations
  • Modules
  • +
  • Foreign Function Interface
  • diff --git a/docs/RefMan/_build/html/searchindex.js b/docs/RefMan/_build/html/searchindex.js index 1d5f1b10c..5bf45ee7c 100644 --- a/docs/RefMan/_build/html/searchindex.js +++ b/docs/RefMan/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["BasicSyntax","BasicTypes","Expressions","Modules","OverloadedOperations","RefMan","TypeDeclarations"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,sphinx:56},filenames:["BasicSyntax.rst","BasicTypes.rst","Expressions.rst","Modules.rst","OverloadedOperations.rst","RefMan.rst","TypeDeclarations.rst"],objects:{},objnames:{},objtypes:{},terms:{"0":[1,2],"0254":0,"0b":0,"0b1010":0,"0b1010111":0,"0b11010":0,"0b11111110":0,"0b_0000_0010":0,"0o":0,"0o1234":0,"0o376":0,"0x":0,"0x01":3,"0x02":3,"0x03":3,"0x04":3,"0x1234":0,"0x30":0,"0x_ffff_ffea":0,"0xfe":0,"1":[0,1,2,3,6],"10":[0,1,3],"100":1,"11":3,"12":[0,3],"13":2,"15":1,"16":0,"1p4":0,"2":[0,1,2,3,6],"20":1,"22":2,"25":1,"254":0,"26":3,"2e3":0,"3":[0,1,2,3,6],"30":[1,3],"32":3,"33":2,"4":0,"5":[0,1,2,3],"6":[0,6],"64":0,"7":[0,2,3],"8":[2,3],"9":2,"case":3,"do":[2,3,6],"float":0,"function":[3,5,6],"import":[0,1,2,5],"new":[3,6],"public":3,"static":0,"true":1,"try":3,"while":[0,1],A:[0,1,3,6],For:[1,2,3,6],If:[2,3],In:3,It:3,Such:[0,3],The:[0,1,2,3],Then:3,There:1,To:3,_:[0,1],ab:4,abbrevi:1,abl:3,about:3,abov:[2,3],access:[2,5],accommod:2,across:3,ad:[2,3],add:3,addit:[0,3],all:[0,2,3,6],allow:[0,3,6],alphabet:1,also:[0,1,3],an:[0,1,2,5],ani:[3,6],annot:5,anonym:5,anoth:3,appear:[1,6],appli:0,applic:2,ar:[0,1,2,3,6],arbitrarili:0,argument:[5,6],arithmet:[1,5],arr:1,associ:0,assumpt:3,automat:2,avoid:3,awai:3,b:[0,3,4,6],back:1,backtick:2,baddef:1,base:[0,2],basic:5,becaus:3,befor:3,begin:0,behavior:1,being:3,belong:0,between:0,binari:0,bind:1,bit:[0,1,2,3,4],bitvector:1,block:[0,5],bodi:6,both:[1,3],bound:1,brace:1,branch:2,bring:[3,6],built:5,call:[1,3,5],can:[1,2,3,6],cannot:[0,2],ceil:[0,4],charact:0,checker:6,chosen:2,clash:3,claus:3,close:0,closest:0,cmp:4,code:3,collect:[1,6],collis:3,combin:3,comma:1,comment:5,compar:1,comparison:5,complement:4,complex:1,compon:1,comprehens:1,comput:[0,1],concaten:1,concret:3,condit:5,consid:[0,3,6],consist:0,constant:3,constraint:[0,5],construct:[1,2,3],contain:[0,1,3],content:3,context:[0,2],conveni:3,correspond:2,coupl:3,cours:3,creat:6,cry:3,cryptol:[0,2,3],cryptolpath:3,cumbersom:3,curli:1,data:1,decim:0,declar:[3,5],defin:[0,1,3,6],definit:[1,2,3],defint:2,degre:0,demot:5,deriv:3,describ:3,descript:1,desrib:3,determin:[0,1],differ:3,digit:0,dimension:1,directli:6,directori:3,distance2:1,distinct:6,divis:[0,5],document:[0,3],done:3,down:[0,1],downward:1,e11:1,e12:1,e1:1,e21:1,e22:1,e2:1,e3:1,e:[0,1,3,4],each:[3,6],easi:3,easier:3,effect:0,either:[0,3],element:[1,2],els:[0,2,3],enclos:[1,3],end:[0,3],english:0,entri:1,enumer:1,eq:4,equal:[0,1,5,6],equat:1,equival:3,error:3,evalu:2,even:[0,6],everi:6,everyth:3,ex:1,examin:1,exampl:[0,1,2,3],except:3,exclus:1,exist:[3,6],explicit:[1,3,5],expon:0,exponenti:0,express:[0,1,3,5,6],extend:3,extern:0,extract:6,f:[0,1,2,3],fals:1,famili:0,featur:3,few:3,field:[4,5,6],file:3,fill:3,fin:[0,3],finit:[1,2],first:[0,1,3],fix:[0,1],floor:4,follow:[0,1,2,3],form:6,fraction:0,from:[0,1,2,3],frominteg:4,front:1,functor:3,g:[0,2,3],gener:1,get:1,getfst:1,glu:3,good:3,group:[0,3,6],h:[2,3],ha:[0,1,2],had:6,handi:1,happen:3,hash:3,have:[0,1,2,3,6],help:3,helper1:3,helper2:3,helper:3,here:[0,2,3],hexadecim:0,hide:[0,5],hierarch:5,highest:0,hold:1,i:[0,1,3],identifi:[1,3,5],impl1:3,impl2:3,impl:3,implement:3,implicit:5,impos:3,improv:0,includ:0,indent:[0,3],index:1,inf:[1,4],infer:[0,2],inffrom:4,inffromthen:4,infinit:1,infix:[0,5],infixl:0,infixr:0,inform:1,instanti:5,instead:[3,6],insuffici:1,integ:[0,2,4,6],integr:5,intend:3,interfac:[0,5],introduc:3,invalid:1,irrelev:6,isposit:1,its:[0,3],itself:3,j:[1,3],just:[3,6],keword:3,keyword:[3,5],kind:2,known:1,l:1,label:1,lambda:[1,2],languag:0,larg:2,last:[0,2],layout:[3,5],left:[0,1],length:[0,1],less:0,let:0,letter:0,level:[3,5],lexicograph:1,lg2:0,lift:1,like:[3,6],line:[0,3,6],link:3,list:5,liter:[2,5],local:[0,3,5],locat:[1,3],logarithm:0,logic:5,longer_nam:0,longernam:0,look:3,lowest:0,m:3,mai:[0,1,2,3,6],main:3,make:3,manag:5,mani:3,mark:0,match:1,max:[0,4],maximum:0,mayb:3,mean:0,member:6,mention:6,might:3,min:[0,4],minimum:0,mirror:1,modul:[0,5],modulu:0,more:[0,3],moreov:6,most:[1,3],multipl:[0,1,2,3],must:[0,3],my:3,myf:3,n:[0,1,3],name1:0,name2:0,name:[0,1,5,6],need:[2,3],negat:4,nest:[0,1,5],newt:6,newtyp:[0,3,5],notat:[0,1,2,3],note:[1,3],noth:3,notion:3,number:[0,1,2],numer:[3,5],obtain:[1,3],occasion:3,octal:0,often:1,old:1,onc:3,one:[0,2,3],onli:[1,3,6],open:0,oper:5,option:[0,6],order:[1,3],ordinari:3,organ:0,other:[3,6],otherwis:6,outer:3,outsid:3,overload:[0,5],overview:2,ox:0,p11:1,p12:1,p1:1,p21:1,p22:1,p2:1,p3:1,p4:1,p:[0,1,3],packag:1,pad:0,pair:2,paramet:[0,2,5],parameter:5,paren:2,parenthes:1,parmaet:3,part:3,pass:[2,5],pattern:[1,2],place:3,point:1,pointwis:1,polymorph:2,polynomi:0,posit:1,possibl:[2,3],practic:3,pragma:0,pre:6,preced:[2,3],precis:0,prefix:[0,3,5],presum:3,previou:3,prime:0,primit:0,primtiv:2,principl:0,privat:[0,5],program:1,programm:0,project:6,properti:0,provid:[2,3],pt:1,purpos:[1,6],qualifi:5,quickli:1,quit:[1,3],r:1,ration:0,readabl:0,recip:4,record:[5,6],recurs:[3,6],reduc:3,refer:3,reject:0,rel:1,relat:3,remain:3,repl:1,repres:0,represent:0,requir:3,result:[0,1,2,3],right:[0,1],ring:4,rotat:1,round:[0,5],roundawai:4,roundtoeven:4,s:[0,2,3],same:[0,1,3,6],scope:[2,3,6],search:3,section:[2,3],see:[0,3],selector:1,semant:3,separ:[1,3],seq:6,sequenc:[0,5],set:1,sha256:3,shadow:3,shape:1,shift:1,should:[1,2],sign:[1,5],signatur:5,signedcmp:4,similarli:1,simpl:3,sinc:3,singl:3,site:6,situat:3,size:[0,1],slight:3,so:[0,1,2,3],some:[0,3],sometim:3,somewher:3,sourc:3,special:0,specifi:[0,2,3],split:1,start:[0,1],step:[1,3],straight:3,stream:1,stride:1,structur:3,sub:[1,3],submdul:3,submodul:[0,3],submould:3,subtract:0,suffici:[1,2],sugar:[2,3],suitabl:2,sum:6,sumbodul:3,support:[0,3],sure:3,symbol:[0,3],synonym:[3,5],syntact:3,syntax:[1,2,5],system:3,t1:1,t2:1,t3:1,t:[1,2,3,6],tabl:0,tend:3,term:0,termin:0,text:0,than:[0,3],thei:[0,1,3,6],them:3,thi:[0,1,2,3],thing:3,those:[1,3],though:6,three:1,through:[1,5],thu:[1,3],time:3,togeth:[1,3],tointeg:4,top:3,transpar:6,treat:[3,6],trunc:4,tupl:5,two:[0,1,2,3,6],typaram:2,type:[3,5],typecheck:6,typeclass:6,unari:[0,2],underscor:0,understand:3,unfold:6,unlik:6,up:0,upcom:3,updat:5,updateend:1,updatesend:1,us:[0,1,2,3,6],user:6,usual:2,valid:1,valu:[0,1,3,5,6],variabl:2,variant:3,variat:3,varieti:0,via:1,wa:3,wai:[1,3],want:3,we:[1,3],weakest:2,when:[0,1,2,3],where:[0,1,2,3],wherea:1,which:[0,2,3,6],whole:[2,3],width:[0,3],wise:1,withing:3,without:3,word:1,work:3,would:[3,6],write:[0,1],written:[0,1,2,6],x:[0,1,2,3,6],xpo:1,xs:1,y:[0,1,2,3],yet:3,you:[2,3],ypo:1,z:[0,2,3],zero:[2,5]},titles:["Basic Syntax","Basic Types","Expressions","Modules","Overloaded Operations","Cryptol Reference Manual","Type Declarations"],titleterms:{"function":[1,2],"import":3,access:1,an:3,annot:2,anonym:3,argument:[2,3],arithmet:4,basic:[0,1,4],block:[2,3],built:0,call:2,comment:0,comparison:4,condit:2,constraint:3,cryptol:5,declar:[0,2,6],demot:2,divis:4,equal:4,explicit:2,express:2,field:1,hide:3,hierarch:3,identifi:0,implicit:3,infix:2,instanti:[2,3],integr:4,interfac:3,keyword:0,layout:0,level:0,list:3,liter:0,local:2,logic:4,manag:3,manual:5,modul:3,name:3,nest:3,newtyp:6,numer:[0,2],oper:[0,1,2,4],overload:4,paramet:3,parameter:3,pass:3,preced:0,prefix:2,privat:3,qualifi:3,record:1,refer:5,round:4,sequenc:1,sign:4,signatur:0,synonym:6,syntax:0,through:3,todo:[0,2],tupl:1,type:[0,1,2,6],updat:1,valu:2,zero:4}}) \ No newline at end of file +Search.setIndex({"docnames": ["BasicSyntax", "BasicTypes", "Expressions", "FFI", "Modules", "OverloadedOperations", "RefMan", "TypeDeclarations"], "filenames": ["BasicSyntax.rst", "BasicTypes.rst", "Expressions.rst", "FFI.rst", "Modules.rst", "OverloadedOperations.rst", "RefMan.rst", "TypeDeclarations.rst"], "titles": ["Basic Syntax", "Basic Types", "Expressions", "Foreign Function Interface", "Modules", "Overloaded Operations", "Cryptol Reference Manual", "Type Declarations"], "terms": {"f": [0, 1, 2, 3, 4], "x": [0, 1, 2, 3, 4, 7], "y": [0, 1, 2, 3, 4], "z": [0, 2, 4], "g": [0, 2, 4], "b": [0, 3, 4, 5, 7], "fin": [0, 3, 4], "group": [0, 4, 7], "ar": [0, 1, 2, 3, 4, 7], "organ": 0, "base": [0, 2], "indent": [0, 4], "same": [0, 1, 3, 4, 7], "belong": 0, "line": [0, 4, 7], "text": 0, "more": [0, 4], "than": [0, 3, 4], "begin": 0, "while": [0, 1, 3], "less": 0, "termin": 0, "consid": [0, 4, 7], "exampl": [0, 1, 2, 4, 6], "follow": [0, 1, 2, 3, 4], "cryptol": [0, 2, 4], "where": [0, 1, 2, 3, 4], "thi": [0, 1, 2, 3, 4], "ha": [0, 1, 2, 3], "two": [0, 1, 2, 4, 7], "one": [0, 2, 3, 4], "all": [0, 2, 3, 4, 7], "between": [0, 6], "The": [0, 1, 2, 3, 4], "principl": 0, "appli": [0, 3], "block": [0, 6], "which": [0, 2, 3, 4, 7], "defin": [0, 1, 3, 4, 7], "local": [0, 4, 6], "name": [0, 1, 3, 6, 7], "support": [0, 4, 6], "start": [0, 1], "end": [0, 4], "mai": [0, 1, 2, 3, 4, 7], "nest": [0, 1, 3, 6], "arbitrarili": 0, "i": [0, 1, 2, 3, 4, 7], "document": [0, 4], "consist": 0, "charact": 0, "first": [0, 1, 3, 4], "must": [0, 3, 4], "either": [0, 3, 4], "an": [0, 1, 2, 3, 6], "english": 0, "letter": 0, "underscor": 0, "_": [0, 1], "decim": 0, "digit": 0, "prime": 0, "some": [0, 4], "have": [0, 1, 2, 3, 4, 7], "special": 0, "mean": [0, 3], "languag": [0, 3], "so": [0, 1, 2, 3, 4], "thei": [0, 1, 3, 4, 7], "us": [0, 1, 2, 3, 4, 7], "programm": 0, "see": [0, 4], "name1": 0, "longer_nam": 0, "name2": 0, "longernam": 0, "extern": 0, "includ": 0, "interfac": [0, 6], "paramet": [0, 2, 6], "properti": 0, "hide": [0, 6], "infix": [0, 6], "let": [0, 3], "pragma": 0, "submodul": [0, 4], "els": [0, 2, 4], "constraint": [0, 6], "infixl": 0, "modul": [0, 3, 6], "primit": 0, "down": [0, 1], "import": [0, 1, 2, 6], "infixr": 0, "newtyp": [0, 4, 6], "privat": [0, 6], "tabl": [0, 3], "contain": [0, 1, 3, 4], "": [0, 2, 3, 4], "associ": 0, "lowest": 0, "highest": 0, "last": [0, 2, 3], "right": [0, 1], "left": [0, 1], "unari": [0, 2], "varieti": 0, "allow": [0, 3, 4, 7], "comput": [0, 1], "specifi": [0, 2, 4], "size": [0, 1, 3], "sequenc": [0, 6], "addit": [0, 4], "subtract": 0, "multipl": [0, 1, 2, 3, 4], "divis": [0, 6], "ceil": [0, 5], "round": [0, 6], "up": [0, 3], "modulu": 0, "pad": [0, 3], "exponenti": 0, "lg2": 0, "logarithm": 0, "2": [0, 1, 2, 3, 4, 7], "width": [0, 4], "bit": [0, 1, 2, 4, 5, 6], "equal": [0, 1, 6, 7], "n": [0, 1, 3, 4], "1": [0, 1, 2, 3, 4, 7], "max": [0, 5], "maximum": 0, "min": [0, 5], "minimum": 0, "written": [0, 1, 2, 3, 7], "binari": [0, 3], "octal": 0, "hexadecim": 0, "notat": [0, 1, 2, 4], "determin": [0, 1], "its": [0, 3, 4], "prefix": [0, 4, 6], "0b": 0, "0o": 0, "0x": 0, "254": 0, "0254": 0, "0b11111110": 0, "0o376": 0, "0xfe": 0, "result": [0, 1, 2, 4], "fix": [0, 1, 3], "length": [0, 1, 3], "e": [0, 1, 4, 5], "number": [0, 1, 2, 3], "overload": [0, 6], "infer": [0, 2], "from": [0, 1, 2, 3, 4], "context": [0, 2], "0b1010": 0, "4": [0, 3], "0o1234": 0, "12": [0, 4], "3": [0, 1, 2, 4, 7], "0x1234": 0, "16": [0, 3], "10": [0, 1, 3, 4], "integ": [0, 2, 5, 7], "also": [0, 1, 3, 4], "polynomi": 0, "write": [0, 1, 3], "express": [0, 1, 4, 6, 7], "term": 0, "open": 0, "close": 0, "degre": 0, "6": [0, 7], "7": [0, 2, 4], "0b1010111": 0, "5": [0, 1, 2, 4], "0b11010": 0, "fraction": 0, "ox": 0, "A": [0, 1, 3, 4, 7], "option": [0, 7], "expon": 0, "mark": 0, "symbol": [0, 3, 4], "p": [0, 1, 4], "2e3": 0, "0x30": 0, "64": [0, 3], "1p4": 0, "ration": 0, "float": [0, 6], "famili": 0, "cannot": [0, 2], "repres": 0, "precis": 0, "Such": [0, 4], "reject": 0, "static": [0, 3], "when": [0, 1, 2, 3, 4], "closest": 0, "represent": 0, "even": [0, 7], "effect": 0, "valu": [0, 1, 4, 6, 7], "improv": [0, 3], "readabl": [0, 3], "here": [0, 2, 4], "0b_0000_0010": 0, "0x_ffff_ffea": 0, "packag": 1, "togeth": [1, 4], "enclos": [1, 4], "parenthes": 1, "curli": 1, "brace": 1, "compon": [1, 3], "both": [1, 4], "separ": [1, 4], "comma": 1, "label": 1, "sign": [1, 6], "identifi": [1, 4, 6], "posit": 1, "order": [1, 3, 4], "most": [1, 4], "purpos": [1, 7], "true": [1, 3], "fals": [1, 3], "lexicograph": 1, "compar": 1, "appear": [1, 7], "wherea": 1, "alphabet": 1, "wai": [1, 3, 4], "via": 1, "pattern": [1, 2], "match": [1, 3], "explicit": [1, 4, 6], "selector": 1, "15": 1, "20": [1, 3], "0": [1, 2, 3], "onli": [1, 3, 4, 7], "program": 1, "suffici": [1, 2], "inform": 1, "shape": 1, "For": [1, 2, 3, 4, 7], "t": [1, 2, 3, 4, 7], "valid": 1, "definit": [1, 2, 4], "known": 1, "isposit": 1, "invalid": 1, "insuffici": 1, "baddef": 1, "mirror": 1, "syntax": [1, 2, 6], "construct": [1, 2, 4], "getfst": 1, "distance2": 1, "xpo": 1, "ypo": 1, "lift": 1, "through": [1, 6], "point": [1, 6], "wise": 1, "equat": 1, "should": [1, 2, 3], "hold": [1, 3], "l": [1, 3], "thu": [1, 4], "we": [1, 3, 4], "can": [1, 2, 3, 4, 7], "quickli": 1, "obtain": [1, 3, 4], "similarli": 1, "get": 1, "entri": 1, "behavior": [1, 3], "quit": [1, 4], "handi": 1, "examin": 1, "complex": 1, "data": 1, "repl": 1, "r": 1, "pt": 1, "100": 1, "set": [1, 3], "30": [1, 4], "rel": 1, "old": 1, "25": 1, "collect": [1, 7], "element": [1, 2, 3], "finit": [1, 2], "often": 1, "call": [1, 3, 4, 6], "word": [1, 3], "abbrevi": 1, "infinit": 1, "inf": [1, 5], "stream": 1, "e1": 1, "e2": 1, "e3": 1, "three": 1, "t1": [1, 3], "t2": [1, 3], "enumer": 1, "exclus": 1, "bound": [1, 3], "stride": 1, "ex": 1, "downward": 1, "t3": 1, "step": [1, 4], "p11": 1, "e11": 1, "p12": 1, "e12": 1, "comprehens": 1, "p21": 1, "e21": 1, "p22": 1, "e22": 1, "gener": [1, 3], "index": 1, "bind": [1, 3], "arr": 1, "j": [1, 4], "dimension": 1, "note": [1, 3, 4], "those": [1, 4], "descript": 1, "concaten": 1, "shift": 1, "rotat": 1, "arithmet": [1, 6], "bitvector": 1, "front": 1, "back": 1, "sub": [1, 4], "updateend": 1, "locat": [1, 4], "updatesend": 1, "There": 1, "pointwis": 1, "p1": 1, "p2": 1, "p3": 1, "p4": 1, "split": [1, 3], "lambda": [1, 2], "section": [2, 3, 4], "provid": [2, 4], "overview": 2, "h": [2, 4], "pair": 2, "paren": 2, "ad": [2, 3, 4], "8": [2, 3, 4], "whole": [2, 3, 4], "9": 2, "variabl": [2, 3], "If": [2, 3, 4], "polymorph": [2, 3], "typaram": 2, "zero": [2, 3, 6], "you": [2, 3, 4], "evalu": [2, 6], "pass": [2, 3, 6], "13": 2, "weakest": 2, "preced": [2, 4], "scope": [2, 4, 7], "defint": 2, "do": [2, 3, 4, 7], "need": [2, 3, 4], "branch": 2, "22": 2, "33": 2, "correspond": [2, 3], "access": [2, 3, 6], "kind": [2, 3], "larg": [2, 3], "accommod": 2, "liter": [2, 6], "backtick": 2, "sugar": [2, 4], "applic": 2, "primtiv": 2, "abov": [2, 3, 4], "suitabl": 2, "automat": [2, 3], "chosen": 2, "possibl": [2, 4], "usual": 2, "ffi": 3, "other": [3, 4, 7], "convent": 3, "current": 3, "window": 3, "work": [3, 4], "unix": 3, "like": [3, 4, 7], "system": [3, 4], "maco": 3, "linux": 3, "suppos": 3, "want": [3, 4], "uint32_t": 3, "add": [3, 4], "In": [3, 4], "our": 3, "file": [3, 4], "declar": [3, 4, 6], "bodi": [3, 7], "32": [3, 4], "dynam": 3, "load": 3, "share": 3, "librari": 3, "look": [3, 4], "directori": [3, 4], "differ": [3, 4], "extens": 3, "exact": 3, "specif": 3, "On": 3, "dylib": 3, "your": 3, "foo": 3, "cry": [3, 4], "Then": [3, 4], "each": [3, 4, 7], "case": [3, 4], "onc": [3, 4], "ani": [3, 4, 7], "sinc": [3, 4], "sourc": [3, 4], "check": 3, "actual": 3, "It": [3, 4], "respons": 3, "make": [3, 4], "sure": [3, 4], "undefin": 3, "doe": 3, "handl": 3, "simpl": [3, 4], "manual": 3, "command": 3, "cc": 3, "fpic": 3, "o": 3, "dynamiclib": 3, "describ": [3, 4], "how": 3, "given": 3, "signatur": [3, 6], "map": 3, "prototyp": 3, "limit": 3, "clear": 3, "translat": 3, "These": 3, "curri": 3, "argument": [3, 6, 7], "certain": 3, "befor": [3, 4], "That": 3, "could": 3, "mani": [3, 4], "after": 3, "directli": [3, 7], "output": 3, "depend": 3, "pointer": 3, "modifi": 3, "store": 3, "list": [3, 6], "size_t": 3, "numer": [3, 4, 6], "furthermor": 3, "satisfi": 3, "explicitli": 3, "fit": 3, "runtim": 3, "error": [3, 4], "requir": [3, 4], "instead": [3, 4, 7], "just": [3, 4, 7], "practic": [3, 4], "would": [3, 4, 7], "too": 3, "cumbersom": [3, 4], "uint8_t": 3, "nonzero": 3, "k": 3, "uint16_t": 3, "uint64_t": 3, "smaller": 3, "extra": 3, "ignor": 3, "instanc": 3, "0xf": 3, "0x0f": 3, "0xaf": 3, "larger": 3, "standard": 3, "convers": 3, "arrai": 3, "float32": 3, "float64": 3, "doubl": 3, "built": [3, 6], "possibli": 3, "u": 3, "itself": [3, 4], "along": 3, "earlier": 3, "alwai": 3, "know": 3, "tn": 3, "mention": [3, 7], "themselv": 3, "u1": 3, "u2": 3, "un": 3, "respect": 3, "f1": 3, "f2": 3, "fn": 3, "arbitrari": 3, "field": [3, 5, 6, 7], "flatten": 3, "out": 3, "behav": 3, "individu": 3, "recurs": [3, 4, 7], "empti": 3, "don": 3, "void": 3, "treat": [3, 4, 7], "except": [3, 4], "input": 3, "version": 3, "becaus": [3, 4], "alreadi": 3, "involv": 3, "alloc": 3, "dealloc": 3, "manag": [3, 6], "non": 3, "piec": 3, "enough": 3, "try": [3, 4], "adjac": 3, "uniniti": 3, "read": 3, "relat": 4, "top": 4, "level": [4, 6], "m": 4, "type": [4, 6], "glu": 4, "ordinari": 4, "hash": 4, "sha256": 4, "structur": [4, 6], "implement": 4, "search": 4, "cryptolpath": 4, "To": 4, "anoth": 4, "wa": 4, "sometim": 4, "0x02": 4, "0x03": 4, "0x04": 4, "help": 4, "reduc": 4, "collis": 4, "tend": 4, "code": [4, 6], "easier": 4, "understand": 4, "easi": 4, "them": 4, "few": 4, "clash": 4, "situat": 4, "conveni": 4, "everyth": 4, "avoid": 4, "happen": 4, "combin": 4, "claus": 4, "introduc": 4, "might": 4, "helper": 4, "function": [4, 6, 7], "intend": 4, "outsid": 4, "good": 4, "place": 4, "0x01": 4, "helper1": 4, "helper2": 4, "public": 4, "remain": 4, "extend": 4, "keyword": [4, 6], "new": [4, 7], "layout": [4, 6], "singl": 4, "equival": 4, "previou": 4, "withing": 4, "keword": 4, "refer": 4, "shadow": 4, "outer": 4, "submdul": 4, "across": 4, "submould": 4, "bring": [4, 7], "upcom": 4, "variant": 4, "featur": 4, "yet": 4, "part": 4, "main": [3, 4], "content": 4, "without": 4, "concret": 4, "assumpt": 4, "about": 4, "constant": [3, 4], "desrib": 4, "parmaet": 4, "sumbodul": 4, "mayb": 4, "link": 4, "abl": 4, "impos": 4, "cours": 4, "done": 4, "impl": 4, "26": 4, "myf": 4, "fill": 4, "my": 4, "slight": 4, "variat": 4, "impl1": 4, "impl2": 4, "deriv": 4, "somewher": 4, "presum": 4, "coupl": 4, "straight": 4, "awai": 4, "thing": 4, "notion": 4, "11": 4, "syntact": 4, "functor": 4, "time": 4, "synonym": [4, 6], "noth": 4, "exist": [4, 7], "semant": 4, "occasion": 4, "being": 4, "eq": 5, "cmp": 5, "ab": 5, "ring": 5, "signedcmp": 5, "complement": 5, "frominteg": 5, "negat": 5, "tointeg": 5, "inffrom": 5, "inffromthen": 5, "recip": 5, "floor": 5, "trunc": 5, "roundawai": 5, "roundtoeven": 5, "basic": 6, "comment": 6, "oper": 6, "annot": 6, "instanti": 6, "condit": 6, "demot": 6, "tupl": 6, "record": [6, 7], "updat": 6, "comparison": 6, "logic": 6, "integr": 6, "hierarch": 6, "qualifi": 6, "implicit": 6, "parameter": 6, "anonym": 6, "foreign": 6, "platform": 6, "usag": 6, "compil": 6, "c": 6, "convert": 6, "overal": 6, "return": 6, "memori": 6, "creat": 7, "pre": 7, "transpar": 7, "unfold": 7, "site": 7, "though": 7, "user": 7, "had": 7, "newt": 7, "seq": 7, "unlik": 7, "distinct": 7, "checker": 7, "moreov": 7, "member": 7, "typeclass": 7, "typecheck": 7, "otherwis": 7, "irrelev": 7, "form": 7, "everi": 7, "project": 7, "extract": 7, "sum": 7, "someth": 3, "a1": 3, "ak": 3, "c1": 3, "cn": 3, "tm": 3, "tr": 3, "expand": 3, "rule": 3, "out0": 3, "out1": 3, "in0": 3, "in1": 3, "in2": 3, "fulli": 3, "process": 3, "0x00000003": 3, "v1": 3, "v2": 3, "vn": 3, "ti": 3, "ui": 3, "vi": 3, "quick": 6}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"basic": [0, 1, 3, 5], "syntax": 0, "declar": [0, 2, 7], "type": [0, 1, 2, 3, 7], "signatur": 0, "layout": 0, "comment": 0, "todo": [0, 2], "identifi": 0, "keyword": 0, "built": 0, "oper": [0, 1, 2, 5], "preced": 0, "level": 0, "numer": [0, 2], "liter": 0, "tupl": [1, 3], "record": [1, 3], "access": 1, "field": 1, "updat": 1, "sequenc": [1, 3], "function": [1, 2, 3], "express": 2, "call": 2, "prefix": 2, "infix": 2, "annot": 2, "explicit": 2, "instanti": [2, 4], "local": 2, "block": [2, 4], "argument": [2, 4], "condit": 2, "demot": 2, "valu": [2, 3], "foreign": 3, "interfac": [3, 4], "platform": 3, "support": 3, "usag": 3, "compil": 3, "c": 3, "code": 3, "convert": 3, "between": 3, "cryptol": [3, 6], "overal": 3, "structur": 3, "paramet": [3, 4], "bit": 3, "integr": [3, 5], "float": 3, "point": 3, "return": 3, "memori": 3, "modul": 4, "hierarch": 4, "name": 4, "import": 4, "list": 4, "hide": 4, "qualifi": 4, "privat": 4, "nest": 4, "implicit": 4, "manag": 4, "parameter": 4, "an": 4, "constraint": 4, "anonym": 4, "pass": 4, "through": 4, "overload": 5, "equal": 5, "comparison": 5, "sign": 5, "zero": 5, "logic": 5, "arithmet": 5, "divis": 5, "round": 5, "refer": [3, 6], "manual": 6, "synonym": [3, 7], "newtyp": 7, "exampl": 3, "evalu": 3, "quick": 3}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 6, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.todo": 2, "sphinx": 56}}) \ No newline at end of file diff --git a/src/Cryptol/Backend/FFI.hs b/src/Cryptol/Backend/FFI.hs new file mode 100644 index 000000000..7b13d16be --- /dev/null +++ b/src/Cryptol/Backend/FFI.hs @@ -0,0 +1,227 @@ +{-# LANGUAGE BlockArguments #-} +{-# LANGUAGE CPP #-} +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE ExistentialQuantification #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TypeApplications #-} + +-- | The implementation of loading and calling external functions from shared +-- libraries. Currently works on Unix only. +module Cryptol.Backend.FFI + ( ForeignSrc + , loadForeignSrc + , unloadForeignSrc +#ifdef FFI_ENABLED + , ForeignImpl + , loadForeignImpl + , FFIArg + , FFIRet + , SomeFFIArg (..) + , callForeignImpl +#endif + ) + where + +import Control.DeepSeq + +import Cryptol.Backend.FFI.Error + +#ifdef FFI_ENABLED + +import Control.Concurrent.MVar +import Control.Exception +import Control.Monad +import Data.Bifunctor +import Data.Word +import Foreign hiding (newForeignPtr) +import Foreign.C.Types +import Foreign.Concurrent +import Foreign.LibFFI +import System.FilePath ((-<.>)) +import System.IO.Error +import System.Posix.DynamicLinker + +import Cryptol.Utils.Panic + +#else + +import GHC.Generics + +#endif + +#ifdef FFI_ENABLED + +-- | A source from which we can retrieve implementations of foreign functions. +data ForeignSrc = ForeignSrc + { -- | The 'ForeignPtr' wraps the pointer returned by 'dlopen', where the + -- finalizer calls 'dlclose' when the library is no longer needed. We keep + -- references to the 'ForeignPtr' in each foreign function that is in the + -- evaluation environment, so that the shared library will stay open as long + -- as there are references to it. + foreignSrcFPtr :: ForeignPtr () + -- | We support explicit unloading of the shared library so we keep track of + -- if it has already been unloaded, and if so the finalizer does nothing. + -- This is updated atomically when the library is unloaded. + , foreignSrcLoaded :: MVar Bool } + +instance Show ForeignSrc where + show = show . foreignSrcFPtr + +instance NFData ForeignSrc where + rnf ForeignSrc {..} = foreignSrcFPtr `seq` foreignSrcLoaded `deepseq` () + +-- | Load a 'ForeignSrc' for the given __Cryptol__ file path. The file path of +-- the shared library that we try to load is the same as the Cryptol file path +-- except with a platform specific extension. +loadForeignSrc :: FilePath -> IO (Either FFILoadError ForeignSrc) +loadForeignSrc = loadForeignLib >=> traverse \ptr -> do + foreignSrcLoaded <- newMVar True + foreignSrcFPtr <- newForeignPtr ptr (unloadForeignSrc' foreignSrcLoaded ptr) + pure ForeignSrc {..} + +loadForeignLib :: FilePath -> IO (Either FFILoadError (Ptr ())) +#ifdef darwin_HOST_OS +-- On Darwin, try loading .dylib first, and if that fails try .so +loadForeignLib path = + (Right <$> open "dylib") `catchIOError` \e1 -> + (Right <$> open "so") `catchIOError` \e2 -> + pure $ Left $ CantLoadFFISrc path $ + displayException e1 ++ "\n" ++ displayException e2 +#else +-- On other platforms, use .so +loadForeignLib path = + tryLoad (CantLoadFFISrc path) $ open "so" +#endif + where -- RTLD_NOW so we can make sure that the symbols actually exist at + -- module loading time + open ext = undl <$> dlopen (path -<.> ext) [RTLD_NOW] + +-- | Explicitly unload a 'ForeignSrc' immediately instead of waiting for the +-- garbage collector to do it. This can be useful if you want to immediately +-- load the same library again to pick up new changes. +-- +-- The 'ForeignSrc' __must not__ be used in any way after this is called, +-- including calling 'ForeignImpl's loaded from it. +unloadForeignSrc :: ForeignSrc -> IO () +unloadForeignSrc ForeignSrc {..} = withForeignPtr foreignSrcFPtr $ + unloadForeignSrc' foreignSrcLoaded + +unloadForeignSrc' :: MVar Bool -> Ptr () -> IO () +unloadForeignSrc' loaded lib = modifyMVar_ loaded \l -> do + when l $ unloadForeignLib lib + pure False + +unloadForeignLib :: Ptr () -> IO () +unloadForeignLib = dlclose . DLHandle + +withForeignSrc :: ForeignSrc -> (Ptr () -> IO a) -> IO a +withForeignSrc ForeignSrc {..} f = withMVar foreignSrcLoaded + \case + True -> withForeignPtr foreignSrcFPtr f + False -> + panic "[FFI] withForeignSrc" ["Use of foreign library after unload"] + +-- | An implementation of a foreign function. +data ForeignImpl = ForeignImpl + { foreignImplFun :: FunPtr () + -- | We don't need this to call the function but we want to keep the library + -- around as long as we still have a function from it so that it isn't + -- unloaded too early. + , foreignImplSrc :: ForeignSrc + } + +-- | Load a 'ForeignImpl' with the given name from the given 'ForeignSrc'. +loadForeignImpl :: ForeignSrc -> String -> IO (Either FFILoadError ForeignImpl) +loadForeignImpl foreignImplSrc name = + withForeignSrc foreignImplSrc \lib -> + tryLoad (CantLoadFFIImpl name) do + foreignImplFun <- loadForeignFunPtr lib name + pure ForeignImpl {..} + +loadForeignFunPtr :: Ptr () -> String -> IO (FunPtr ()) +loadForeignFunPtr = dlsym . DLHandle + +tryLoad :: (String -> FFILoadError) -> IO a -> IO (Either FFILoadError a) +tryLoad err = fmap (first $ err . displayException) . tryIOError + +-- | Types which can be converted into libffi arguments. +-- +-- The Storable constraint is so that we can put them in arrays. +class Storable a => FFIArg a where + ffiArg :: a -> Arg + +instance FFIArg Word8 where + ffiArg = argWord8 + +instance FFIArg Word16 where + ffiArg = argWord16 + +instance FFIArg Word32 where + ffiArg = argWord32 + +instance FFIArg Word64 where + ffiArg = argWord64 + +instance FFIArg CFloat where + ffiArg = argCFloat + +instance FFIArg CDouble where + ffiArg = argCDouble + +instance FFIArg (Ptr a) where + ffiArg = argPtr + +instance FFIArg CSize where + ffiArg = argCSize + +-- | Types which can be returned from libffi. +-- +-- The Storable constraint is so that we can put them in arrays. +class Storable a => FFIRet a where + ffiRet :: RetType a + +instance FFIRet Word8 where + ffiRet = retWord8 + +instance FFIRet Word16 where + ffiRet = retWord16 + +instance FFIRet Word32 where + ffiRet = retWord32 + +instance FFIRet Word64 where + ffiRet = retWord64 + +instance FFIRet CFloat where + ffiRet = retCFloat + +instance FFIRet CDouble where + ffiRet = retCDouble + +instance FFIRet () where + ffiRet = retVoid + +-- | Existential wrapper around a 'FFIArg'. +data SomeFFIArg = forall a. FFIArg a => SomeFFIArg a + +-- | Call a 'ForeignImpl' with the given arguments. The type parameter decides +-- how the return value should be converted into a Haskell value. +callForeignImpl :: forall a. FFIRet a => ForeignImpl -> [SomeFFIArg] -> IO a +callForeignImpl ForeignImpl {..} xs = withForeignSrc foreignImplSrc \_ -> + callFFI foreignImplFun (ffiRet @a) $ map toArg xs + where toArg (SomeFFIArg x) = ffiArg x + +#else + +data ForeignSrc = ForeignSrc deriving (Show, Generic, NFData) + +loadForeignSrc :: FilePath -> IO (Either FFILoadError ForeignSrc) +loadForeignSrc _ = pure $ Right ForeignSrc + +unloadForeignSrc :: ForeignSrc -> IO () +unloadForeignSrc _ = pure () + +#endif diff --git a/src/Cryptol/Backend/FFI/Error.hs b/src/Cryptol/Backend/FFI/Error.hs new file mode 100644 index 000000000..d04a72385 --- /dev/null +++ b/src/Cryptol/Backend/FFI/Error.hs @@ -0,0 +1,31 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} + +-- | Errors from dynamic loading of shared libraries for FFI. +module Cryptol.Backend.FFI.Error where + +import Control.DeepSeq +import GHC.Generics + +import Cryptol.Utils.PP + +data FFILoadError + = CantLoadFFISrc + FilePath -- ^ Path to cryptol module + String -- ^ Error message + | CantLoadFFIImpl + String -- ^ Function name + String -- ^ Error message + deriving (Show, Generic, NFData) + +instance PP FFILoadError where + ppPrec _ e = + case e of + CantLoadFFISrc path msg -> + hang (text "Could not load foreign source for module located at" + <+> text path <.> colon) + 4 (text msg) + CantLoadFFIImpl name msg -> + hang (text "Could not load foreign implementation for binding" + <+> text name <.> colon) + 4 (text msg) diff --git a/src/Cryptol/Backend/Monad.hs b/src/Cryptol/Backend/Monad.hs index ef138188a..01167e21b 100644 --- a/src/Cryptol/Backend/Monad.hs +++ b/src/Cryptol/Backend/Monad.hs @@ -54,7 +54,7 @@ import qualified Control.Exception as X import Cryptol.Parser.Position import Cryptol.Utils.Panic import Cryptol.Utils.PP -import Cryptol.TypeCheck.AST(Name) +import Cryptol.TypeCheck.AST(Name, TParam) -- | A computation that returns an already-evaluated value. ready :: a -> Eval a @@ -412,15 +412,18 @@ evalPanic cxt = panic ("[Eval] " ++ cxt) -- | Data type describing errors that can occur during evaluation. data EvalError - = InvalidIndex (Maybe Integer) -- ^ Out-of-bounds index - | DivideByZero -- ^ Division or modulus by 0 - | NegativeExponent -- ^ Exponentiation by negative integer - | LogNegative -- ^ Logarithm of a negative integer - | UserError String -- ^ Call to the Cryptol @error@ primitive - | LoopError String -- ^ Detectable nontermination - | NoPrim Name -- ^ Primitive with no implementation - | BadRoundingMode Integer -- ^ Invalid rounding mode - | BadValue String -- ^ Value outside the domain of a partial function. + = InvalidIndex (Maybe Integer) -- ^ Out-of-bounds index + | DivideByZero -- ^ Division or modulus by 0 + | NegativeExponent -- ^ Exponentiation by negative integer + | LogNegative -- ^ Logarithm of a negative integer + | UserError String -- ^ Call to the Cryptol @error@ primitive + | LoopError String -- ^ Detectable nontermination + | NoPrim Name -- ^ Primitive with no implementation + | BadRoundingMode Integer -- ^ Invalid rounding mode + | BadValue String -- ^ Value outside the domain of a partial function. + | FFINotSupported Name -- ^ Foreign function cannot be called + | FFITypeNumTooBig Name TParam Integer -- ^ Number passed to foreign function + -- as a type argument is too large deriving Typeable instance PP EvalError where @@ -440,6 +443,17 @@ instance PP EvalError where BadRoundingMode r -> "invalid rounding mode" <+> integer r BadValue x -> "invalid input for" <+> backticks (text x) NoPrim x -> text "unimplemented primitive:" <+> pp x + FFINotSupported x -> vcat + [ text "cannot call foreign function" <+> pp x + , text "FFI calls are not supported in this context" + , text "If you are trying to evaluate an expression, try rebuilding" + , text " Cryptol with FFI support enabled." + ] + FFITypeNumTooBig f p n -> vcat + [ text "numeric type argument to foreign function is too large:" + <+> integer n + , text "in type parameter" <+> pp p <+> "of function" <+> pp f + , text "type arguments must fit in a C `size_t`" ] instance Show EvalError where show = show . pp diff --git a/src/Cryptol/Eval.hs b/src/Cryptol/Eval.hs index 874ecf5e1..4d7925044 100644 --- a/src/Cryptol/Eval.hs +++ b/src/Cryptol/Eval.hs @@ -382,9 +382,11 @@ declHole :: sym -> Decl -> SEval sym (Name, Schema, SEval sym (GenValue sym), SEval sym (GenValue sym) -> SEval sym ()) declHole sym d = case dDefinition d of - DPrim -> evalPanic "Unexpected primitive declaration in recursive group" - [show (ppLocName nm)] - DExpr _ -> do + DPrim -> evalPanic "Unexpected primitive declaration in recursive group" + [show (ppLocName nm)] + DForeign _ -> evalPanic "Unexpected foreign declaration in recursive group" + [show (ppLocName nm)] + DExpr _ -> do (hole, fill) <- sDeclareHole sym msg return (nm, sch, hole, fill) where @@ -416,6 +418,18 @@ evalDecl sym renv env d = Just (Left ex) -> bindVar sym (dName d) (evalExpr sym renv ex) env Nothing -> bindVar sym (dName d) (cryNoPrimError sym (dName d)) env + DForeign _ -> do + -- Foreign declarations should have been handled by the previous + -- Cryptol.Eval.FFI.evalForeignDecls pass already, so they should already + -- be in the environment. If not, then either Cryptol was not compiled + -- with FFI support enabled, or we are in a non-Concrete backend. In that + -- case, we just bind the name to an error computation which will raise an + -- error if we try to evaluate it. + case lookupVar (dName d) env of + Just _ -> pure env + Nothing -> bindVar sym (dName d) + (raiseError sym $ FFINotSupported $ dName d) env + DExpr e -> bindVar sym (dName d) (evalExpr sym renv e) env @@ -689,5 +703,6 @@ evalMatch sym (lsz, lenv) m = seq lsz $ case m of where f env = case dDefinition d of - DPrim -> evalPanic "evalMatch" ["Unexpected local primitive"] - DExpr e -> evalExpr sym env e + DPrim -> evalPanic "evalMatch" ["Unexpected local primitive"] + DForeign _ -> evalPanic "evalMatch" ["Unexpected local foreign"] + DExpr e -> evalExpr sym env e diff --git a/src/Cryptol/Eval/FFI.hs b/src/Cryptol/Eval/FFI.hs new file mode 100644 index 000000000..51b06e247 --- /dev/null +++ b/src/Cryptol/Eval/FFI.hs @@ -0,0 +1,281 @@ +{-# LANGUAGE BlockArguments #-} +{-# LANGUAGE CPP #-} +{-# LANGUAGE LambdaCase #-} +{-# LANGUAGE NamedFieldPuns #-} +{-# LANGUAGE PatternSynonyms #-} +{-# LANGUAGE RankNTypes #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ScopedTypeVariables #-} +{-# LANGUAGE TupleSections #-} +{-# LANGUAGE TypeApplications #-} +{-# LANGUAGE ViewPatterns #-} + +-- | Evaluation of foreign functions. +module Cryptol.Eval.FFI + ( evalForeignDecls + ) where + +import Cryptol.Backend.FFI +import Cryptol.Backend.FFI.Error +import Cryptol.Eval +import Cryptol.ModuleSystem.Env +import Cryptol.TypeCheck.AST + +#ifdef FFI_ENABLED + +import Data.Either +import Data.IORef +import Data.Maybe +import Data.Proxy +import Data.Traversable +import Data.Word +import Foreign +import Foreign.C.Types +import GHC.Float +import LibBF (bfFromDouble, bfToDouble, + pattern NearEven) +import System.Directory + +import Cryptol.Backend.Concrete +import Cryptol.Backend.FloatHelpers +import Cryptol.Backend.Monad +import Cryptol.Backend.SeqMap +import Cryptol.Eval.Env +import Cryptol.Eval.Prims +import Cryptol.Eval.Type +import Cryptol.Eval.Value +import Cryptol.ModuleSystem.Name +import Cryptol.TypeCheck.FFI.FFIType +import Cryptol.Utils.Ident +import Cryptol.Utils.RecordMap + +-- | Find all the foreign declarations in the module and add them to the +-- environment. This is a separate pass from the main evaluation functions in +-- "Cryptol.Eval" since it only works for the Concrete backend. +-- +-- Note: 'Right' is only returned if we successfully loaded some foreign +-- functions and the environment was modified. If there were no foreign +-- declarations at all then @Left []@ is returned, so 'Left' does not +-- necessarily indicate an error. +evalForeignDecls :: ModulePath -> Module -> EvalEnv -> + Eval (Either [FFILoadError] (ForeignSrc, EvalEnv)) +evalForeignDecls path m env = io + case mapMaybe getForeign $ mDecls m of + [] -> pure $ Left [] + foreigns -> + case path of + InFile p -> canonicalizePath p >>= loadForeignSrc >>= + \case + Right fsrc -> collect <$> for foreigns \(name, ffiType) -> + fmap ((name,) . foreignPrimPoly name ffiType) <$> + loadForeignImpl fsrc (unpackIdent $ nameIdent name) + where collect (partitionEithers -> (errs, primMap)) + | null errs = Right + (fsrc, foldr (uncurry bindVarDirect) env primMap) + | otherwise = Left errs + Left err -> pure $ Left [err] + -- We don't handle in-memory modules for now + InMem _ _ -> evalPanic "evalForeignDecls" + ["Can't find foreign source of in-memory module"] + where getForeign (NonRecursive Decl { dName, dDefinition = DForeign ffiType }) + = Just (dName, ffiType) + getForeign _ = Nothing + +-- | Generate a 'Prim' value representing the given foreign function, containing +-- all the code necessary to marshal arguments and return values and do the +-- actual FFI call. +foreignPrimPoly :: Name -> FFIFunType -> ForeignImpl -> Prim Concrete +foreignPrimPoly name fft impl = buildNumPoly (ffiTParams fft) mempty + where -- Add type lambdas for the type parameters and build a type environment + -- that we can look up later to compute e.g. array sizes. + -- + -- Given [p1, p2, ..., pk] {}, returns + -- PNumPoly \n1 -> PNumPoly \n2 -> ... PNumPoly \nk -> + -- foreignPrim name fft impl {p1 = n1, p2 = n2, ..., pk = nk} + buildNumPoly (tp:tps) tenv = PNumPoly \n -> + buildNumPoly tps $ bindTypeVar (TVBound tp) (Left n) tenv + buildNumPoly [] tenv = foreignPrim name fft impl tenv + +-- | Methods for obtaining a return value. The producer of this type must supply +-- both 1) a polymorphic IO object directly containing a return value that the +-- consumer can instantiate at any 'FFIRet' type, and 2) an effectful function +-- that takes some output arguments and modifies what they are pointing at to +-- store a return value. The consumer can choose which one to use. +data GetRet = GetRet + { getRetAsValue :: forall a. FFIRet a => IO a + , getRetAsOutArgs :: [SomeFFIArg] -> IO () } + +-- | Generate the monomorphic part of the foreign 'Prim', given a 'TypeEnv' +-- containing all the type arguments we have already received. +foreignPrim :: Name -> FFIFunType -> ForeignImpl -> TypeEnv -> Prim Concrete +foreignPrim name FFIFunType {..} impl tenv = buildFun ffiArgTypes [] + where + + -- Build up the 'Prim' function for the FFI call. + -- + -- Given [t1, t2 ... tm] we return + -- PStrict \v1 -> PStrict \v2 -> ... PStrict \vm -> PPrim $ + -- marshalArg t1 v1 \a1 -> + -- marshalArg t2 v2 \a2 -> ... marshalArg tm vm \am -> + -- marshalRet ffiRetType GetRet + -- { getRetAsValue = callForeignImpl impl [n1, ..., nk, a1, ..., am] + -- , getRetAsOutArgs = \[o1, ..., ol] -> + -- callForeignImpl impl [n1, ..., nk, a1, ..., am, o1, ..., ol] } + buildFun :: [FFIType] -> [(FFIType, GenValue Concrete)] -> Prim Concrete + buildFun (argType:argTypes) typesAndVals = PStrict \val -> + buildFun argTypes $ typesAndVals ++ [(argType, val)] + buildFun [] typesAndVals = PPrim $ + marshalArgs typesAndVals \inArgs -> do + tyArgs <- traverse marshalTyArg ffiTParams + let tyInArgs = tyArgs ++ inArgs + marshalRet ffiRetType GetRet + { getRetAsValue = callForeignImpl impl tyInArgs + , getRetAsOutArgs = callForeignImpl impl . (tyInArgs ++) } + + -- Look up the value of a type parameter in the type environment and marshal + -- it. + marshalTyArg :: TParam -> Eval SomeFFIArg + marshalTyArg tp + | n <= toInteger (maxBound :: CSize) = + pure $ SomeFFIArg @CSize $ fromInteger n + | otherwise = raiseError Concrete $ FFITypeNumTooBig name tp n + where n = evalFinType $ TVar $ TVBound tp + + -- Marshal the given value as the given FFIType and call the given function + -- with the results. A single Cryptol argument may correspond to any number of + -- C arguments, so the callback takes a list. + -- + -- NOTE: the result must be used only in the callback since it may have a + -- limited lifetime (e.g. pointer returned by alloca). + marshalArg :: FFIType -> GenValue Concrete -> + ([SomeFFIArg] -> Eval a) -> Eval a + marshalArg FFIBool val f = f [SomeFFIArg @Word8 $ fromBool $ fromVBit val] + marshalArg (FFIBasic t) val f = getMarshalBasicArg t \m -> do + arg <- m val + f [SomeFFIArg arg] + marshalArg (FFIArray (evalFinType -> n) t) val f = + getMarshalBasicArg t \m -> do + args <- traverse (>>= m) $ enumerateSeqMap n $ fromVSeq val + -- Since we need to do an Eval action in an IO callback, we need to + -- manually unwrap and wrap the Eval datatype + Eval \stk -> + withArray args \ptr -> + runEval stk $ f [SomeFFIArg ptr] + marshalArg (FFITuple types) val f = do + vals <- sequence $ fromVTuple val + marshalArgs (zip types vals) f + marshalArg (FFIRecord typeMap) val f = do + vals <- traverse (`lookupRecord` val) $ displayOrder typeMap + marshalArgs (zip (displayElements typeMap) vals) f + + -- Call marshalArg on a bunch of arguments and collect the results together + -- (in the order of the arguments). + marshalArgs :: [(FFIType, GenValue Concrete)] -> + ([SomeFFIArg] -> Eval a) -> Eval a + marshalArgs typesAndVals f = go typesAndVals [] + where go [] args = f args + go ((t, v):tvs) prevArgs = marshalArg t v \currArgs -> + go tvs (prevArgs ++ currArgs) + + -- Given a FFIType and a GetRet, obtain a return value and convert it to a + -- Cryptol value. The return value is obtained differently depending on the + -- FFIType. + marshalRet :: FFIType -> GetRet -> Eval (GenValue Concrete) + marshalRet FFIBool gr = VBit . toBool <$> io (getRetAsValue gr @Word8) + marshalRet (FFIBasic t) gr = getMarshalBasicRet t (io (getRetAsValue gr) >>=) + marshalRet (FFIArray (evalFinType -> n) t) gr = getMarshalBasicRet t \m -> + fmap (VSeq n . finiteSeqMap Concrete . map m) $ + io $ allocaArray (fromInteger n) \ptr -> do + getRetAsOutArgs gr [SomeFFIArg ptr] + peekArray (fromInteger n) ptr + marshalRet (FFITuple types) gr = VTuple <$> marshalMultiRet types gr + marshalRet (FFIRecord typeMap) gr = + VRecord . recordFromFields . zip (displayOrder typeMap) <$> + marshalMultiRet (displayElements typeMap) gr + + -- Obtain multiple return values as output arguments for a composite return + -- type. Each return value is fully evaluated but put back in an Eval since + -- VTuple and VRecord expect it. + marshalMultiRet :: [FFIType] -> GetRet -> Eval [Eval (GenValue Concrete)] + -- Since IO callbacks are involved we just do the whole thing in IO and wrap + -- it in an Eval at the end. This should be fine since we are not changing + -- the (Cryptol) call stack. + marshalMultiRet types gr = Eval \stk -> do + -- We use this IORef hack here since we are calling marshalRet recursively + -- but marshalRet doesn't let us return any extra information from the + -- callback through to the result of the function. So we remember the result + -- as a side effect. + vals <- newIORef [] + let go [] args = getRetAsOutArgs gr args + go (t:ts) prevArgs = do + val <- runEval stk $ marshalRet t $ getRetFromAsOutArgs \currArgs -> + go ts (prevArgs ++ currArgs) + modifyIORef' vals (val :) + go types [] + map pure <$> readIORef vals + + -- Evaluate a finite numeric type expression. + evalFinType :: Type -> Integer + evalFinType = finNat' . evalNumType tenv + +-- | Given a way to 'getRetAsOutArgs', create a 'GetRet', where the +-- 'getRetAsValue' simply allocates a temporary space to call 'getRetAsOutArgs' +-- on. This is useful for return types that we know how to obtain directly as a +-- value but need to obtain as an output argument when multiple return values +-- are involved. +getRetFromAsOutArgs :: ([SomeFFIArg] -> IO ()) -> GetRet +getRetFromAsOutArgs f = GetRet + { getRetAsValue = alloca \ptr -> do + f [SomeFFIArg ptr] + peek ptr + , getRetAsOutArgs = f } + +-- | Given a 'FFIBasicType', call the callback with a marshalling function that +-- marshals values to the 'FFIArg' type corresponding to the 'FFIBasicType'. +-- The callback must be able to handle marshalling functions that marshal to any +-- 'FFIArg' type. +getMarshalBasicArg :: FFIBasicType -> + (forall a. FFIArg a => (GenValue Concrete -> Eval a) -> b) -> b +getMarshalBasicArg (FFIWord _ s) f = withWordType s \(_ :: p t) -> + f @t $ fmap (fromInteger . bvVal) . fromVWord Concrete "getMarshalBasicArg" +getMarshalBasicArg (FFIFloat _ _ s) f = + case s of + -- LibBF can only convert to 'Double' directly, so we do that first then + -- convert to 'Float', which should not result in any loss of precision if + -- the original data was 32-bit anyways. + FFIFloat32 -> f $ pure . CFloat . double2Float . toDouble + FFIFloat64 -> f $ pure . CDouble . toDouble + where toDouble = fst . bfToDouble NearEven . bfValue . fromVFloat + +-- | Given a 'FFIBasicType', call the callback with an unmarshalling function +-- from the 'FFIRet' type corresponding to the 'FFIBasicType' to Cryptol values. +-- The callback must be able to handle unmarshalling functions from any 'FFIRet' +-- type. +getMarshalBasicRet :: FFIBasicType -> + (forall a. FFIRet a => (a -> Eval (GenValue Concrete)) -> b) -> b +getMarshalBasicRet (FFIWord n s) f = withWordType s \(_ :: p t) -> + f @t $ word Concrete n . toInteger +getMarshalBasicRet (FFIFloat e p s) f = + case s of + FFIFloat32 -> f $ toValue . \case CFloat x -> float2Double x + FFIFloat64 -> f $ toValue . \case CDouble x -> x + where toValue = pure . VFloat . BF e p . bfFromDouble + +-- | Call the callback with the Word type corresponding to the given +-- 'FFIWordSize'. +withWordType :: FFIWordSize -> + (forall a. (FFIArg a, FFIRet a, Integral a) => Proxy a -> b) -> b +withWordType FFIWord8 f = f $ Proxy @Word8 +withWordType FFIWord16 f = f $ Proxy @Word16 +withWordType FFIWord32 f = f $ Proxy @Word32 +withWordType FFIWord64 f = f $ Proxy @Word64 + +#else + +-- | Dummy implementation for when FFI is disabled. Does not add anything to +-- the environment. +evalForeignDecls :: ModulePath -> Module -> EvalEnv -> + Eval (Either [FFILoadError] (ForeignSrc, EvalEnv)) +evalForeignDecls _ _ _ = pure $ Left [] + +#endif diff --git a/src/Cryptol/Eval/Reference.lhs b/src/Cryptol/Eval/Reference.lhs index 19a53b068..547f6914c 100644 --- a/src/Cryptol/Eval/Reference.lhs +++ b/src/Cryptol/Eval/Reference.lhs @@ -510,8 +510,9 @@ the new bindings. > evalDecl :: Env -> Decl -> (Name, E Value) > evalDecl env d = > case dDefinition d of -> DPrim -> (dName d, pure (evalPrim (dName d))) -> DExpr e -> (dName d, evalExpr env e) +> DPrim -> (dName d, pure (evalPrim (dName d))) +> DForeign _ -> (dName d, cryError $ FFINotSupported $ dName d) +> DExpr e -> (dName d, evalExpr env e) > Newtypes diff --git a/src/Cryptol/IR/FreeVars.hs b/src/Cryptol/IR/FreeVars.hs index 9810af692..3a0c13df3 100644 --- a/src/Cryptol/IR/FreeVars.hs +++ b/src/Cryptol/IR/FreeVars.hs @@ -93,6 +93,7 @@ instance FreeVars Decl where instance FreeVars DeclDef where freeVars d = case d of DPrim -> mempty + DForeign _ -> mempty DExpr e -> freeVars e diff --git a/src/Cryptol/ModuleSystem.hs b/src/Cryptol/ModuleSystem.hs index cf8986b15..10f9062cb 100644 --- a/src/Cryptol/ModuleSystem.hs +++ b/src/Cryptol/ModuleSystem.hs @@ -64,8 +64,9 @@ findModule n env = runModuleM env (Base.findModule n) -- | Load the module contained in the given file. loadModuleByPath :: FilePath -> ModuleCmd (ModulePath,T.Module) -loadModuleByPath path minp = - runModuleM minp{ minpModuleEnv = resetModuleEnv (minpModuleEnv minp) } $ do +loadModuleByPath path minp = do + moduleEnv' <- resetModuleEnv $ minpModuleEnv minp + runModuleM minp{ minpModuleEnv = moduleEnv' } $ do unloadModule ((InFile path ==) . lmFilePath) m <- Base.loadModuleByPath path setFocusedModule (T.mName m) @@ -73,8 +74,9 @@ loadModuleByPath path minp = -- | Load the given parsed module. loadModuleByName :: P.ModName -> ModuleCmd (ModulePath,T.Module) -loadModuleByName n minp = - runModuleM minp{ minpModuleEnv = resetModuleEnv (minpModuleEnv minp) } $ do +loadModuleByName n minp = do + moduleEnv' <- resetModuleEnv $ minpModuleEnv minp + runModuleM minp{ minpModuleEnv = moduleEnv' } $ do unloadModule ((n ==) . lmName) (path,m') <- Base.loadModuleFrom False (FromModule n) setFocusedModule (T.mName m') diff --git a/src/Cryptol/ModuleSystem/Base.hs b/src/Cryptol/ModuleSystem/Base.hs index 24eb393b9..e17384e75 100644 --- a/src/Cryptol/ModuleSystem/Base.hs +++ b/src/Cryptol/ModuleSystem/Base.hs @@ -11,6 +11,7 @@ {-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE ImplicitParams #-} +{-# LANGUAGE LambdaCase #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE OverloadedStrings #-} @@ -18,6 +19,7 @@ module Cryptol.ModuleSystem.Base where import qualified Control.Exception as X import Control.Monad (unless,when) +import Data.Functor.Compose import Data.Maybe (fromMaybe) import Data.Monoid ((<>)) import Data.Text.Encoding (decodeUtf8') @@ -52,6 +54,7 @@ import Cryptol.ModuleSystem.Env (lookupModule import qualified Cryptol.Eval as E import qualified Cryptol.Eval.Concrete as Concrete import Cryptol.Eval.Concrete (Concrete(..)) +import Cryptol.Eval.FFI import qualified Cryptol.ModuleSystem.NamingEnv as R import qualified Cryptol.ModuleSystem.Renamer as R import qualified Cryptol.Parser as P @@ -237,8 +240,17 @@ doLoadModule quiet isrc path fp pm0 = let ?evalPrim = \i -> Right <$> Map.lookup i tbl callStacks <- getCallStacks let ?callStacks = callStacks - unless (T.isParametrizedModule tcm) $ modifyEvalEnv (E.moduleEnv Concrete tcm) - loadedModule path fp nameEnv tcm + foreignSrc <- + if T.isParametrizedModule tcm + then pure Nothing + else (getCompose + <$> modifyEvalEnvM (fmap Compose . evalForeignDecls path tcm) + >>= \case + Left [] -> pure Nothing + Left errs -> ffiLoadErrors (T.mName tcm) errs + Right (foreignSrc, ()) -> pure (Just foreignSrc)) + <* modifyEvalEnv (E.moduleEnv Concrete tcm) + loadedModule path fp nameEnv foreignSrc tcm return tcm where diff --git a/src/Cryptol/ModuleSystem/Env.hs b/src/Cryptol/ModuleSystem/Env.hs index 49233d73b..da596685a 100644 --- a/src/Cryptol/ModuleSystem/Env.hs +++ b/src/Cryptol/ModuleSystem/Env.hs @@ -18,6 +18,7 @@ module Cryptol.ModuleSystem.Env where import Paths_cryptol (getDataDir) #endif +import Cryptol.Backend.FFI (ForeignSrc, unloadForeignSrc) import Cryptol.Eval (EvalEnv) import Cryptol.ModuleSystem.Fingerprint import Cryptol.ModuleSystem.Interface @@ -41,6 +42,7 @@ import System.Directory (getAppUserDataDirectory, getCurrentDirectory) import System.Environment(getExecutablePath) import System.FilePath ((), normalise, joinPath, splitPath, takeDirectory) import qualified Data.List as List +import Data.Foldable import GHC.Generics (Generic) import Control.DeepSeq @@ -99,14 +101,19 @@ data CoreLint = NoCoreLint -- ^ Don't run core lint | CoreLint -- ^ Run core lint deriving (Generic, NFData) -resetModuleEnv :: ModuleEnv -> ModuleEnv -resetModuleEnv env = env - { meLoadedModules = mempty - , meNameSeeds = T.nameSeeds - , meEvalEnv = mempty - , meFocusedModule = Nothing - , meDynEnv = mempty - } +resetModuleEnv :: ModuleEnv -> IO ModuleEnv +resetModuleEnv env = do + for_ (getLoadedModules $ meLoadedModules env) $ \lm -> + case lmForeignSrc lm of + Just fsrc -> unloadForeignSrc fsrc + _ -> pure () + pure env + { meLoadedModules = mempty + , meNameSeeds = T.nameSeeds + , meEvalEnv = mempty + , meFocusedModule = Nothing + , meDynEnv = mempty + } initialModuleEnv :: IO ModuleEnv initialModuleEnv = do @@ -342,6 +349,9 @@ data LoadedModule = LoadedModule -- ^ The actual type-checked module , lmFingerprint :: Fingerprint + + , lmForeignSrc :: Maybe ForeignSrc + -- ^ The dynamically loaded source for any foreign functions in the module } deriving (Show, Generic, NFData) -- | Has this module been loaded already. @@ -362,9 +372,9 @@ lookupModule mn me = search lmLoadedModules `mplus` search lmLoadedParamModules -- | Add a freshly loaded module. If it was previously loaded, then -- the new version is ignored. addLoadedModule :: - ModulePath -> String -> Fingerprint -> R.NamingEnv -> T.Module -> - LoadedModules -> LoadedModules -addLoadedModule path ident fp nameEnv tm lm + ModulePath -> String -> Fingerprint -> R.NamingEnv -> Maybe ForeignSrc -> + T.Module -> LoadedModules -> LoadedModules +addLoadedModule path ident fp nameEnv fsrc tm lm | isLoaded (T.mName tm) lm = lm | T.isParametrizedModule tm = lm { lmLoadedParamModules = loaded : lmLoadedParamModules lm } @@ -379,6 +389,7 @@ addLoadedModule path ident fp nameEnv tm lm , lmInterface = T.genIface tm , lmModule = tm , lmFingerprint = fp + , lmForeignSrc = fsrc } -- | Remove a previously loaded module. diff --git a/src/Cryptol/ModuleSystem/InstantiateModule.hs b/src/Cryptol/ModuleSystem/InstantiateModule.hs index 9d6b46729..e82a13114 100644 --- a/src/Cryptol/ModuleSystem/InstantiateModule.hs +++ b/src/Cryptol/ModuleSystem/InstantiateModule.hs @@ -227,8 +227,9 @@ instance Inst DeclGroup where instance Inst DeclDef where inst env d = case d of - DPrim -> DPrim - DExpr e -> DExpr (inst env e) + DPrim -> DPrim + DForeign t -> DForeign t + DExpr e -> DExpr (inst env e) instance Inst Decl where inst env d = d { dSignature = inst env (dSignature d) diff --git a/src/Cryptol/ModuleSystem/Monad.hs b/src/Cryptol/ModuleSystem/Monad.hs index eaca216ff..a282a94de 100644 --- a/src/Cryptol/ModuleSystem/Monad.hs +++ b/src/Cryptol/ModuleSystem/Monad.hs @@ -14,6 +14,8 @@ module Cryptol.ModuleSystem.Monad where import Cryptol.Eval (EvalEnv,EvalOpts(..)) +import Cryptol.Backend.FFI (ForeignSrc) +import Cryptol.Backend.FFI.Error import qualified Cryptol.Backend.Monad as E import Cryptol.ModuleSystem.Env @@ -42,9 +44,11 @@ import Control.Monad.IO.Class import Control.Exception (IOException) import Data.ByteString (ByteString) import Data.Function (on) +import Data.Functor.Identity import Data.Map (Map) import Data.Maybe (isJust) import Data.Text.Encoding.Error (UnicodeException) +import Data.Traversable import MonadLib import System.Directory (canonicalizePath) @@ -113,6 +117,8 @@ data ModuleError | FailedToParameterizeModDefs P.ModName [T.Name] -- ^ Failed to add the module parameters to all definitions in a module. | NotAParameterizedModule P.ModName + | FFILoadErrors P.ModName [FFILoadError] + -- ^ Errors loading foreign function implementations | ErrorInFile ModulePath ModuleError -- ^ This is just a tag on the error, indicating the file containing it. @@ -141,6 +147,7 @@ instance NFData ModuleError where ImportedParamModule x -> x `deepseq` () FailedToParameterizeModDefs x xs -> x `deepseq` xs `deepseq` () NotAParameterizedModule x -> x `deepseq` () + FFILoadErrors x errs -> x `deepseq` errs `deepseq` () ErrorInFile x y -> x `deepseq` y `deepseq` () instance PP ModuleError where @@ -207,6 +214,11 @@ instance PP ModuleError where NotAParameterizedModule x -> text "[error] Module" <+> pp x <+> text "does not have parameters." + FFILoadErrors x errs -> + hang (text "[error] Failed to load foreign implementations for module" + <+> pp x <.> colon) + 4 (vcat $ map pp errs) + ErrorInFile _ x -> ppPrec prec x moduleNotFound :: P.ModName -> [FilePath] -> ModuleM a @@ -266,6 +278,9 @@ failedToParameterizeModDefs x xs = notAParameterizedModule :: P.ModName -> ModuleM a notAParameterizedModule x = ModuleT (raise (NotAParameterizedModule x)) +ffiLoadErrors :: P.ModName -> [FFILoadError] -> ModuleM a +ffiLoadErrors x errs = ModuleT (raise (FFILoadErrors x errs)) + -- | Run the computation, and if it caused and error, tag the error -- with the given file. errorInFile :: ModulePath -> ModuleM a -> ModuleM a @@ -511,22 +526,27 @@ unloadModule rm = ModuleT $ do set $! env { meLoadedModules = removeLoadedModule rm (meLoadedModules env) } loadedModule :: - ModulePath -> Fingerprint -> NamingEnv -> T.Module -> ModuleM () -loadedModule path fp nameEnv m = ModuleT $ do + ModulePath -> Fingerprint -> NamingEnv -> Maybe ForeignSrc -> T.Module -> + ModuleM () +loadedModule path fp nameEnv fsrc m = ModuleT $ do env <- get ident <- case path of InFile p -> unModuleT $ io (canonicalizePath p) InMem l _ -> pure l - set $! env { meLoadedModules = addLoadedModule path ident fp nameEnv m + set $! env { meLoadedModules = addLoadedModule path ident fp nameEnv fsrc m (meLoadedModules env) } -modifyEvalEnv :: (EvalEnv -> E.Eval EvalEnv) -> ModuleM () -modifyEvalEnv f = ModuleT $ do +modifyEvalEnvM :: Traversable t => + (EvalEnv -> E.Eval (t EvalEnv)) -> ModuleM (t ()) +modifyEvalEnvM f = ModuleT $ do env <- get let evalEnv = meEvalEnv env - evalEnv' <- inBase $ E.runEval mempty (f evalEnv) - set $! env { meEvalEnv = evalEnv' } + inBase (E.runEval mempty (f evalEnv)) + >>= traverse (\evalEnv' -> set $! env { meEvalEnv = evalEnv' }) + +modifyEvalEnv :: (EvalEnv -> E.Eval EvalEnv) -> ModuleM () +modifyEvalEnv = fmap runIdentity . modifyEvalEnvM . (fmap Identity .) getEvalEnv :: ModuleM EvalEnv getEvalEnv = ModuleT (meEvalEnv `fmap` get) diff --git a/src/Cryptol/ModuleSystem/Renamer.hs b/src/Cryptol/ModuleSystem/Renamer.hs index d43402557..baca1b962 100644 --- a/src/Cryptol/ModuleSystem/Renamer.hs +++ b/src/Cryptol/ModuleSystem/Renamer.hs @@ -683,6 +683,7 @@ instance Rename Bind where instance Rename BindDef where rename DPrim = return DPrim + rename DForeign = return DForeign rename (DExpr e) = DExpr <$> rename e -- NOTE: this only renames types within the pattern. diff --git a/src/Cryptol/Parser.y b/src/Cryptol/Parser.y index 7ee646f48..cf58621dd 100644 --- a/src/Cryptol/Parser.y +++ b/src/Cryptol/Parser.y @@ -90,6 +90,7 @@ import Paths_cryptol 'primitive' { Located $$ (Token (KW KW_primitive) _)} 'constraint'{ Located $$ (Token (KW KW_constraint) _)} + 'foreign' { Located $$ (Token (KW KW_foreign) _)} 'Prop' { Located $$ (Token (KW KW_Prop) _)} '[' { Located $$ (Token (Sym BracketL) _)} @@ -251,6 +252,7 @@ vtop_decl :: { [TopDecl PName] } { [exportDecl $1 Public (mkProperty $3 [] $5)] } | mbDoc newtype { [exportNewtype Public $1 $2] } | prim_bind { $1 } + | foreign_bind { $1 } | private_decls { $1 } | parameter_decls { $1 } | mbDoc 'submodule' @@ -273,6 +275,8 @@ prim_bind :: { [TopDecl PName] } | mbDoc 'primitive' '(' op ')' ':' schema { mkPrimDecl $1 $4 $7 } | mbDoc 'primitive' 'type' schema ':' kind {% mkPrimTypeDecl $1 $4 $6 } +foreign_bind :: { [TopDecl PName] } + : mbDoc 'foreign' name ':' schema { mkForeignDecl $1 $3 $5 } parameter_decls :: { [TopDecl PName] } : 'parameter' 'v{' par_decls 'v}' { reverse $3 } diff --git a/src/Cryptol/Parser/AST.hs b/src/Cryptol/Parser/AST.hs index d10747e74..90ccd0afa 100644 --- a/src/Cryptol/Parser/AST.hs +++ b/src/Cryptol/Parser/AST.hs @@ -278,6 +278,7 @@ data Bind name = Bind type LBindDef = Located (BindDef PName) data BindDef name = DPrim + | DForeign | DExpr (Expr name) deriving (Eq, Show, Generic, NFData, Functor) @@ -725,6 +726,7 @@ instance (Show name, PPName name) => PP (Bind name) where instance (Show name, PPName name) => PP (BindDef name) where ppPrec _ DPrim = text "" + ppPrec _ DForeign = text "" ppPrec p (DExpr e) = ppPrec p e diff --git a/src/Cryptol/Parser/Lexer.x b/src/Cryptol/Parser/Lexer.x index 0f76c62ae..7b82be8b8 100644 --- a/src/Cryptol/Parser/Lexer.x +++ b/src/Cryptol/Parser/Lexer.x @@ -126,6 +126,7 @@ $white+ { emit $ White Space } "primitive" { emit $ KW KW_primitive } "parameter" { emit $ KW KW_parameter } "constraint" { emit $ KW KW_constraint } +"foreign" { emit $ KW KW_foreign } "Prop" { emit $ KW KW_Prop } diff --git a/src/Cryptol/Parser/Names.hs b/src/Cryptol/Parser/Names.hs index 7f9ba8163..14b7e2bdc 100644 --- a/src/Cryptol/Parser/Names.hs +++ b/src/Cryptol/Parser/Names.hs @@ -63,6 +63,7 @@ namesB b = namesDef :: Ord name => BindDef name -> Set name namesDef DPrim = Set.empty +namesDef DForeign = Set.empty namesDef (DExpr e) = namesE e @@ -183,6 +184,7 @@ tnamesB b = Set.unions [setS, setP, setE] tnamesDef :: Ord name => BindDef name -> Set name tnamesDef DPrim = Set.empty +tnamesDef DForeign = Set.empty tnamesDef (DExpr e) = tnamesE e -- | The type names used by an expression. diff --git a/src/Cryptol/Parser/NoPat.hs b/src/Cryptol/Parser/NoPat.hs index 9b0c781f0..0bf930250 100644 --- a/src/Cryptol/Parser/NoPat.hs +++ b/src/Cryptol/Parser/NoPat.hs @@ -219,6 +219,11 @@ noMatchB b = | otherwise -> panic "NoPat" [ "noMatchB: primitive with params" , show b ] + DForeign + | null (bParams b) -> return b + | otherwise -> panic "NoPat" [ "noMatchB: foreign with params" + , show b ] + DExpr e -> do e' <- noPatFun (Just (thing (bName b))) 0 (bParams b) e return b { bParams = [], bDef = DExpr e' <$ bDef b } diff --git a/src/Cryptol/Parser/ParserUtils.hs b/src/Cryptol/Parser/ParserUtils.hs index 5c910f8b8..8ecf5cf37 100644 --- a/src/Cryptol/Parser/ParserUtils.hs +++ b/src/Cryptol/Parser/ParserUtils.hs @@ -624,19 +624,26 @@ mkIf ifThens theElse = foldr addIfThen theElse ifThens where addIfThen (cond, doexpr) elseExpr = EIf cond doexpr elseExpr --- | Generate a signature and a primitive binding. The reason for generating --- both instead of just adding the signature at this point is that it means the --- primitive declarations don't need to be treated differently in the noPat +mkPrimDecl :: Maybe (Located Text) -> LPName -> Schema PName -> [TopDecl PName] +mkPrimDecl = mkNoImplDecl DPrim + +mkForeignDecl :: Maybe (Located Text) -> LPName -> Schema PName -> [TopDecl PName] +mkForeignDecl = mkNoImplDecl DForeign + +-- | Generate a signature and a binding for value declarations with no +-- implementation (i.e. primitive or foreign declarations). The reason for +-- generating both instead of just adding the signature at this point is that it +-- means the declarations don't need to be treated differently in the noPat -- pass. This is also the reason we add the doc to the TopLevel constructor, -- instead of just place it on the binding directly. A better solution might be --- to just have a different constructor for primitives. -mkPrimDecl :: - Maybe (Located Text) -> LPName -> Schema PName -> [TopDecl PName] -mkPrimDecl mbDoc ln sig = +-- to just have a different constructor for primitives and foreigns. +mkNoImplDecl :: BindDef PName + -> Maybe (Located Text) -> LPName -> Schema PName -> [TopDecl PName] +mkNoImplDecl def mbDoc ln sig = [ exportDecl mbDoc Public $ DBind Bind { bName = ln , bParams = [] - , bDef = at sig (Located emptyRange DPrim) + , bDef = at sig (Located emptyRange def) , bSignature = Nothing , bPragmas = [] , bMono = False diff --git a/src/Cryptol/Parser/Position.hs b/src/Cryptol/Parser/Position.hs index cc3900037..d300be020 100644 --- a/src/Cryptol/Parser/Position.hs +++ b/src/Cryptol/Parser/Position.hs @@ -37,6 +37,11 @@ data Range = Range { from :: !Position , source :: FilePath } deriving (Eq, Ord, Show, Generic, NFData) +-- | Returns `True` if the first range is contained in the second one. +rangeWithin :: Range -> Range -> Bool +a `rangeWithin` b = + source a == source b && from a >= from b && to a <= to b + -- | An empty range. -- -- Caution: using this on the LHS of a use of rComb will cause the empty source diff --git a/src/Cryptol/Parser/Token.hs b/src/Cryptol/Parser/Token.hs index c1ec16903..e48d433ba 100644 --- a/src/Cryptol/Parser/Token.hs +++ b/src/Cryptol/Parser/Token.hs @@ -50,6 +50,7 @@ data TokenKW = KW_else | KW_primitive | KW_parameter | KW_constraint + | KW_foreign | KW_Prop | KW_by | KW_down diff --git a/src/Cryptol/Transform/AddModParams.hs b/src/Cryptol/Transform/AddModParams.hs index 22575c6d3..e5d55e734 100644 --- a/src/Cryptol/Transform/AddModParams.hs +++ b/src/Cryptol/Transform/AddModParams.hs @@ -146,11 +146,12 @@ instance AddParams DeclGroup where instance AddParams Decl where addParams ps d = case dDefinition d of - DPrim -> d - DExpr e -> d { dSignature = addParams ps (dSignature d) - , dDefinition = DExpr (addParams ps e) - , dName = toParamInstName (dName d) - } + DPrim -> d + DForeign _ -> d + DExpr e -> d { dSignature = addParams ps (dSignature d) + , dDefinition = DExpr (addParams ps e) + , dName = toParamInstName (dName d) + } instance AddParams TySyn where addParams ps ts = ts { tsParams = pTypes ps ++ tsParams ts @@ -278,6 +279,7 @@ instance Inst DeclDef where inst ps d = case d of DPrim -> DPrim + DForeign t -> DForeign t DExpr e -> DExpr (inst ps e) instance Inst Type where diff --git a/src/Cryptol/Transform/MonoValues.hs b/src/Cryptol/Transform/MonoValues.hs index baf4e80e1..31afd555d 100644 --- a/src/Cryptol/Transform/MonoValues.hs +++ b/src/Cryptol/Transform/MonoValues.hs @@ -216,8 +216,9 @@ rewD rews d = do e <- rewDef rews (dDefinition d) return d { dDefinition = e } rewDef :: RewMap -> DeclDef -> M DeclDef -rewDef rews (DExpr e) = DExpr <$> rewE rews e -rewDef _ DPrim = return DPrim +rewDef rews (DExpr e) = DExpr <$> rewE rews e +rewDef _ DPrim = return DPrim +rewDef _ (DForeign t) = return $ DForeign t rewDeclGroup :: RewMap -> DeclGroup -> M DeclGroup rewDeclGroup rews dg = @@ -237,11 +238,12 @@ rewDeclGroup rews dg = consider d = case dDefinition d of - DPrim -> Left d - DExpr e -> let (tps,props,e') = splitTParams e - in if not (null tps) && notFun e' - then Right (d, tps, props, e') - else Left d + DPrim -> Left d + DForeign _ -> Left d + DExpr e -> let (tps,props,e') = splitTParams e + in if not (null tps) && notFun e' + then Right (d, tps, props, e') + else Left d rewSame ds = do new <- forM (NE.toList ds) $ \(d,_,_,e) -> diff --git a/src/Cryptol/Transform/Specialize.hs b/src/Cryptol/Transform/Specialize.hs index f71fb2f60..6a074b89f 100644 --- a/src/Cryptol/Transform/Specialize.hs +++ b/src/Cryptol/Transform/Specialize.hs @@ -187,9 +187,10 @@ specializeConst e0 = do sig' <- instantiateSchema ts n (dSignature decl) modifySpecCache (Map.adjust (fmap (insertTM ts (qname', Nothing))) qname) rhs' <- case dDefinition decl of - DExpr e -> do e' <- specializeExpr =<< instantiateExpr ts n e - return (DExpr e') - DPrim -> return DPrim + DExpr e -> do e' <- specializeExpr =<< instantiateExpr ts n e + return (DExpr e') + DPrim -> return DPrim + DForeign t -> return $ DForeign t let decl' = decl { dName = qname', dSignature = sig', dDefinition = rhs' } modifySpecCache (Map.adjust (fmap (insertTM ts (qname', Just decl'))) qname) return (EVar qname') diff --git a/src/Cryptol/TypeCheck/AST.hs b/src/Cryptol/TypeCheck/AST.hs index a061630e2..72bfa5494 100644 --- a/src/Cryptol/TypeCheck/AST.hs +++ b/src/Cryptol/TypeCheck/AST.hs @@ -39,6 +39,7 @@ import Cryptol.Parser.AST ( Selector(..),Pragma(..) , Fixity(..)) import Cryptol.Utils.Ident (Ident,isInfixIdent,ModName,PrimIdent,prelPrim) import Cryptol.Utils.RecordMap +import Cryptol.TypeCheck.FFI.FFIType import Cryptol.TypeCheck.PP import Cryptol.TypeCheck.Type @@ -178,6 +179,7 @@ data Decl = Decl { dName :: !Name } deriving (Generic, NFData, Show) data DeclDef = DPrim + | DForeign FFIFunType | DExpr Expr deriving (Show, Generic, NFData) @@ -368,8 +370,9 @@ instance PP (WithNames Decl) where ++ [ nest 2 (sep [pp dName <+> text "=", ppWithNames nm dDefinition]) ] instance PP (WithNames DeclDef) where - ppPrec _ (WithNames DPrim _) = text "" - ppPrec _ (WithNames (DExpr e) nm) = ppWithNames nm e + ppPrec _ (WithNames DPrim _) = text "" + ppPrec _ (WithNames (DForeign _) _) = text "" + ppPrec _ (WithNames (DExpr e) nm) = ppWithNames nm e instance PP Decl where ppPrec = ppWithNamesPrec IntMap.empty diff --git a/src/Cryptol/TypeCheck/Error.hs b/src/Cryptol/TypeCheck/Error.hs index cdb542596..676cd0d35 100644 --- a/src/Cryptol/TypeCheck/Error.hs +++ b/src/Cryptol/TypeCheck/Error.hs @@ -13,12 +13,13 @@ import Data.List((\\),sortBy,groupBy,partition) import Data.Function(on) import qualified Cryptol.Parser.AST as P -import Cryptol.Parser.Position(Located(..), Range(..)) +import Cryptol.Parser.Position(Located(..), Range(..), rangeWithin) import Cryptol.TypeCheck.PP import Cryptol.TypeCheck.Type import Cryptol.TypeCheck.InferTypes import Cryptol.TypeCheck.Subst import Cryptol.TypeCheck.Unify(Path,isRootPath) +import Cryptol.TypeCheck.FFI.Error import Cryptol.ModuleSystem.Name(Name) import Cryptol.Utils.Ident(Ident) import Cryptol.Utils.RecordMap @@ -56,6 +57,8 @@ cleanupErrors = dropErrorsFromSameLoc -- | Should the first error suppress the next one. subsumes :: (Range,Error) -> (Range,Error) -> Bool subsumes (_,NotForAll _ _ x _) (_,NotForAll _ _ y _) = x == y +subsumes (r1,UnexpectedTypeWildCard) (r2,UnsupportedFFIType{}) = + r1 `rangeWithin` r2 subsumes (r1,KindMismatch {}) (r2,err) = case err of KindMismatch {} -> r1 == r2 @@ -143,6 +146,11 @@ data Error = KindMismatch (Maybe TypeSource) Kind Kind | MissingModTParam (Located Ident) | MissingModVParam (Located Ident) + | UnsupportedFFIKind TypeSource TParam Kind + -- ^ Kind is not supported for FFI + | UnsupportedFFIType TypeSource FFITypeError + -- ^ Type is not supported for FFI + | TemporaryError Doc -- ^ This is for errors that don't fit other cateogories. -- We should not use it much, and is generally to be used @@ -199,7 +207,9 @@ errorImportance err = AmbiguousSize {} -> 2 - + UnsupportedFFIKind {} -> 10 + UnsupportedFFIType {} -> 7 + -- less than UnexpectedTypeWildCard instance TVars Warning where @@ -249,6 +259,9 @@ instance TVars Error where MissingModTParam {} -> err MissingModVParam {} -> err + UnsupportedFFIKind {} -> err + UnsupportedFFIType src e -> UnsupportedFFIType src !$ apSubst su e + TemporaryError {} -> err @@ -284,6 +297,9 @@ instance FVS Error where MissingModTParam {} -> Set.empty MissingModVParam {} -> Set.empty + UnsupportedFFIKind {} -> Set.empty + UnsupportedFFIType _ t -> fvs t + TemporaryError {} -> Set.empty instance PP Warning where @@ -322,7 +338,7 @@ instance PP (WithNames Error) where UnexpectedTypeWildCard -> addTVarsDescsAfter names err $ nested "Wild card types are not allowed in this context" - "(e.g., they cannot be used in type synonyms)." + "(e.g., they cannot be used in type synonyms or FFI declarations)." KindMismatch mbsrc k1 k2 -> addTVarsDescsAfter names err $ @@ -457,6 +473,17 @@ instance PP (WithNames Error) where MissingModVParam x -> "Missing definition for value parameter" <+> quotes (pp (thing x)) + UnsupportedFFIKind src param k -> + nested "Kind of type variable unsupported for FFI: " $ + vcat + [ pp param <+> colon <+> pp k + , "Only type variables of kind" <+> pp KNum <+> "are supported" + , "When checking" <+> pp src ] + + UnsupportedFFIType src t -> vcat + [ ppWithNames names t + , "When checking" <+> pp src ] + TemporaryError doc -> doc where bullets xs = vcat [ "•" <+> d | d <- xs ] diff --git a/src/Cryptol/TypeCheck/FFI.hs b/src/Cryptol/TypeCheck/FFI.hs new file mode 100644 index 000000000..b4c97b198 --- /dev/null +++ b/src/Cryptol/TypeCheck/FFI.hs @@ -0,0 +1,102 @@ +{-# LANGUAGE BlockArguments #-} +{-# LANGUAGE RecordWildCards #-} +{-# LANGUAGE ViewPatterns #-} + +-- | Checking and conversion of 'Type's to 'FFIType's. +module Cryptol.TypeCheck.FFI + ( toFFIFunType + ) where + +import Data.Containers.ListUtils +import Data.Either + +import Cryptol.TypeCheck.FFI.Error +import Cryptol.TypeCheck.FFI.FFIType +import Cryptol.TypeCheck.SimpType +import Cryptol.TypeCheck.Type +import Cryptol.Utils.RecordMap + +-- | Convert a 'Schema' to a 'FFIFunType', along with any 'Prop's that must be +-- satisfied for the 'FFIFunType' to be valid. +toFFIFunType :: Schema -> Either FFITypeError ([Prop], FFIFunType) +toFFIFunType (Forall params _ t) = + -- Remove all type synonyms and simplify the type before processing it + case go $ tRebuild' False t of + Just (Right (props, fft)) -> Right + -- Remove duplicate constraints + (nubOrd $ map (fin . TVar . TVBound) params ++ props, fft) + Just (Left errs) -> Left $ FFITypeError t $ FFIBadComponentTypes errs + Nothing -> Left $ FFITypeError t FFINotFunction + where go (TCon (TC TCFun) [argType, retType]) = Just + case toFFIType argType of + Right (ps, ffiArgType) -> + case go retType of + Just (Right (ps', ffiFunType)) -> Right + ( ps ++ ps' + , ffiFunType + { ffiArgTypes = ffiArgType : ffiArgTypes ffiFunType } ) + Just (Left errs) -> Left errs + Nothing -> + case toFFIType retType of + Right (ps', ffiRetType) -> Right + ( ps ++ ps' + , FFIFunType + { ffiTParams = params + , ffiArgTypes = [ffiArgType], .. } ) + Left err -> Left [err] + Left err -> Left + case go retType of + Just (Right _) -> [err] + Just (Left errs) -> err : errs + Nothing -> + case toFFIType retType of + Right _ -> [err] + Left err' -> [err, err'] + go _ = Nothing + +-- | Convert a 'Type' to a 'FFIType', along with any 'Prop's that must be +-- satisfied for the 'FFIType' to be valid. +toFFIType :: Type -> Either FFITypeError ([Prop], FFIType) +toFFIType t = + case t of + TCon (TC TCBit) [] -> Right ([], FFIBool) + (toFFIBasicType -> Just r) -> (\fbt -> ([], FFIBasic fbt)) <$> r + TCon (TC TCSeq) [sz, bt] -> + case toFFIBasicType bt of + Just (Right fbt) -> Right ([fin sz], FFIArray sz fbt) + Just (Left err) -> Left $ FFITypeError t $ FFIBadComponentTypes [err] + Nothing -> Left $ FFITypeError t FFIBadArrayType + TCon (TC (TCTuple _)) ts -> + case partitionEithers $ map toFFIType ts of + ([], unzip -> (pss, fts)) -> Right (concat pss, FFITuple fts) + (errs, _) -> Left $ FFITypeError t $ FFIBadComponentTypes errs + TRec tMap -> + case sequence resMap of + Right resMap' -> Right $ FFIRecord <$> + recordMapAccum (\ps (ps', ft) -> (ps' ++ ps, ft)) [] resMap' + Left _ -> Left $ FFITypeError t $ + FFIBadComponentTypes $ lefts $ displayElements resMap + where resMap = fmap toFFIType tMap + _ -> Left $ FFITypeError t FFIBadType + +-- | Convert a 'Type' to a 'FFIBasicType', returning 'Nothing' if it isn't a +-- basic type and 'Left' if it is but there was some other issue with it. +toFFIBasicType :: Type -> Maybe (Either FFITypeError FFIBasicType) +toFFIBasicType t = + case t of + TCon (TC TCSeq) [TCon (TC (TCNum n)) [], TCon (TC TCBit) []] + | n <= 8 -> word FFIWord8 + | n <= 16 -> word FFIWord16 + | n <= 32 -> word FFIWord32 + | n <= 64 -> word FFIWord64 + | otherwise -> Just $ Left $ FFITypeError t FFIBadWordSize + where word = Just . Right . FFIWord n + TCon (TC TCFloat) [TCon (TC (TCNum e)) [], TCon (TC (TCNum p)) []] + | e == 8, p == 24 -> float FFIFloat32 + | e == 11, p == 53 -> float FFIFloat64 + | otherwise -> Just $ Left $ FFITypeError t FFIBadFloatSize + where float = Just . Right . FFIFloat e p + _ -> Nothing + +fin :: Type -> Prop +fin t = TCon (PC PFin) [t] diff --git a/src/Cryptol/TypeCheck/FFI/Error.hs b/src/Cryptol/TypeCheck/FFI/Error.hs new file mode 100644 index 000000000..23f942bb8 --- /dev/null +++ b/src/Cryptol/TypeCheck/FFI/Error.hs @@ -0,0 +1,81 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} +{-# LANGUAGE FlexibleInstances #-} +{-# LANGUAGE OverloadedStrings #-} + +-- | Errors from typechecking foreign functions. +module Cryptol.TypeCheck.FFI.Error where + +import Control.DeepSeq +import GHC.Generics + +import Cryptol.TypeCheck.PP +import Cryptol.TypeCheck.Subst +import Cryptol.TypeCheck.Type + +data FFITypeError = FFITypeError Type FFITypeErrorReason + deriving (Show, Generic, NFData) + +data FFITypeErrorReason + = FFIBadWordSize + | FFIBadFloatSize + | FFIBadArrayType + | FFIBadComponentTypes [FFITypeError] + | FFIBadType + | FFINotFunction + deriving (Show, Generic, NFData) + +instance TVars FFITypeError where + apSubst su (FFITypeError t r) = FFITypeError !$ apSubst su t !$ apSubst su r + +instance TVars FFITypeErrorReason where + apSubst su r = + case r of + FFIBadWordSize -> r + FFIBadFloatSize -> r + FFIBadArrayType -> r + FFIBadComponentTypes errs -> FFIBadComponentTypes !$ apSubst su errs + FFIBadType -> r + FFINotFunction -> r + +instance FVS FFITypeError where + fvs (FFITypeError t r) = fvs (t, r) + +instance FVS FFITypeErrorReason where + fvs r = + case r of + FFIBadWordSize -> mempty + FFIBadFloatSize -> mempty + FFIBadArrayType -> mempty + FFIBadComponentTypes errs -> fvs errs + FFIBadType -> mempty + FFINotFunction -> mempty + +instance PP (WithNames FFITypeError) where + ppPrec _ (WithNames (FFITypeError t r) names) = + nest 2 $ "Type unsupported for FFI:" $$ + vcat + [ ppWithNames names t + , "Due to:" + , ppWithNames names r ] + +instance PP (WithNames FFITypeErrorReason) where + ppPrec _ (WithNames r names) = + case r of + FFIBadWordSize -> vcat + [ "Unsupported word size" + , "Only words of up to 64 bits are supported" ] + FFIBadFloatSize -> vcat + [ "Unsupported Float format" + , "Only Float32 and Float64 are supported" ] + FFIBadArrayType -> vcat + [ "Unsupported sequence element type" + , "Only words or floats are supported as the element type of sequences" + ] + FFIBadComponentTypes errs -> + indent 2 $ vcat $ map (ppWithNames names) errs + FFIBadType -> vcat + [ "Only Bit, words, floats, sequences of words or floats," + , "or structs or tuples of the above are supported as FFI" + , "argument or return types"] + FFINotFunction -> "FFI binding must be a function" diff --git a/src/Cryptol/TypeCheck/FFI/FFIType.hs b/src/Cryptol/TypeCheck/FFI/FFIType.hs new file mode 100644 index 000000000..dfd8ef502 --- /dev/null +++ b/src/Cryptol/TypeCheck/FFI/FFIType.hs @@ -0,0 +1,57 @@ +{-# LANGUAGE DeriveAnyClass #-} +{-# LANGUAGE DeriveGeneric #-} + +-- | This module defines a nicer intermediate representation of Cryptol types +-- allowed for the FFI, which the typechecker generates then stores in the AST. +-- This way the FFI evaluation code does not have to examine the raw type +-- signatures again. +module Cryptol.TypeCheck.FFI.FFIType where + +import Control.DeepSeq +import GHC.Generics + +import Cryptol.TypeCheck.Type +import Cryptol.Utils.Ident +import Cryptol.Utils.RecordMap + +-- | Type of a foreign function. +data FFIFunType = FFIFunType + { -- | Note: any type variables within this function type must be bound here. + ffiTParams :: [TParam] + , ffiArgTypes :: [FFIType] + , ffiRetType :: FFIType } + deriving (Show, Generic, NFData) + +-- | Type of a value that can be passed to or returned from a foreign function. +data FFIType + = FFIBool + | FFIBasic FFIBasicType + | FFIArray + Type -- ^ Size (should be of kind @\#@) + FFIBasicType -- ^ Element type + | FFITuple [FFIType] + | FFIRecord (RecordMap Ident FFIType) + deriving (Show, Generic, NFData) + +-- | Types which can be elements of FFI sequences. +data FFIBasicType + = FFIWord + Integer -- ^ The size of the Cryptol type + FFIWordSize -- ^ The machine word size that it corresponds to + | FFIFloat + Integer -- ^ Exponent + Integer -- ^ Precision + FFIFloatSize -- ^ The machine float size that it corresponds to + deriving (Show, Generic, NFData) + +data FFIWordSize + = FFIWord8 + | FFIWord16 + | FFIWord32 + | FFIWord64 + deriving (Show, Generic, NFData) + +data FFIFloatSize + = FFIFloat32 + | FFIFloat64 + deriving (Show, Generic, NFData) diff --git a/src/Cryptol/TypeCheck/Infer.hs b/src/Cryptol/TypeCheck/Infer.hs index 62b51cc1e..e12515c80 100644 --- a/src/Cryptol/TypeCheck/Infer.hs +++ b/src/Cryptol/TypeCheck/Infer.hs @@ -47,6 +47,8 @@ import Cryptol.TypeCheck.Kind(checkType,checkSchema,checkTySyn, import Cryptol.TypeCheck.Instantiate import Cryptol.TypeCheck.Subst (listSubst,apSubst,(@@),isEmptySubst) import Cryptol.TypeCheck.Unify(rootPath) +import Cryptol.TypeCheck.FFI +import Cryptol.TypeCheck.FFI.FFIType import Cryptol.Utils.Ident import Cryptol.Utils.Panic(panic) import Cryptol.Utils.RecordMap @@ -61,7 +63,7 @@ import Data.List(partition) import Data.Ratio(numerator,denominator) import Data.Traversable(forM) import Data.Function(on) -import Control.Monad(zipWithM,unless,foldM,forM_,mplus) +import Control.Monad(zipWithM,unless,foldM,forM_,mplus,when) @@ -833,7 +835,11 @@ guessType exprMap b@(P.Bind { .. }) = case bSignature of Just s -> - do s1 <- checkSchema AllowWildCards s + do let wildOk = case thing bDef of + P.DForeign {} -> NoWildCards + P.DPrim -> NoWildCards + P.DExpr {} -> AllowWildCards + s1 <- checkSchema wildOk s return ((name, ExtVar (fst s1)), Left (checkSigB b s1)) Nothing @@ -927,8 +933,9 @@ generalize bs0 gs0 = genE e = foldr ETAbs (foldr EProofAbs (apSubst su e) qs) asPs genB d = d { dDefinition = case dDefinition d of - DExpr e -> DExpr (genE e) - DPrim -> DPrim + DExpr e -> DExpr (genE e) + DPrim -> DPrim + DForeign t -> DForeign t , dSignature = Forall asPs qs $ apSubst su $ sType $ dSignature d } @@ -950,6 +957,8 @@ checkMonoB b t = P.DPrim -> panic "checkMonoB" ["Primitive with no signature?"] + P.DForeign -> panic "checkMonoB" ["Foreign with no signature?"] + P.DExpr e -> do let nm = thing (P.bName b) let tGoal = WithSource t (DefinitionOf nm) (getLoc b) @@ -979,6 +988,37 @@ checkSigB b (Forall as asmps0 t0, validSchema) = case thing (P.bDef b) of , dDoc = P.bDoc b } + P.DForeign -> + do let loc = getLoc b + name = thing $ P.bName b + src = DefinitionOf name + inRangeMb loc do + -- Ensure all type params are of kind # + forM_ as \a -> + when (tpKind a /= KNum) $ + recordErrorLoc loc $ UnsupportedFFIKind src a $ tpKind a + withTParams as do + ffiFunType <- + case toFFIFunType (Forall as asmps0 t0) of + Right (props, ffiFunType) -> ffiFunType <$ do + ffiGoals <- traverse (newGoal (CtFFI name)) props + proveImplication True (Just name) as asmps0 $ + validSchema ++ ffiGoals + Left err -> do + recordErrorLoc loc $ UnsupportedFFIType src err + -- Just a placeholder type + pure FFIFunType + { ffiTParams = as, ffiArgTypes = [] + , ffiRetType = FFITuple [] } + pure Decl { dName = thing (P.bName b) + , dSignature = Forall as asmps0 t0 + , dDefinition = DForeign ffiFunType + , dPragmas = P.bPragmas b + , dInfix = P.bInfix b + , dFixity = P.bFixity b + , dDoc = P.bDoc b + } + P.DExpr e0 -> inRangeMb (getLoc b) $ withTParams as $ @@ -1010,7 +1050,7 @@ checkSigB b (Forall as asmps0 t0, validSchema) = case thing (P.bDef b) of addGoals leave - su <- proveImplication (Just (thing (P.bName b))) as asmps1 stay + su <- proveImplication False (Just (thing (P.bName b))) as asmps1 stay extendSubst su let asmps = concatMap pSplitAnd (apSubst su asmps1) @@ -1113,8 +1153,8 @@ checkDecl isTopLevel d mbDoc = checkParameterFun :: P.ParameterFun Name -> InferM ModVParam checkParameterFun x = do (s,gs) <- checkSchema NoWildCards (P.pfSchema x) - su <- proveImplication (Just (thing (P.pfName x))) - (sVars s) (sProps s) gs + su <- proveImplication False (Just (thing (P.pfName x))) + (sVars s) (sProps s) gs unless (isEmptySubst su) $ panic "checkParameterFun" ["Subst not empty??"] let n = thing (P.pfName x) diff --git a/src/Cryptol/TypeCheck/InferTypes.hs b/src/Cryptol/TypeCheck/InferTypes.hs index 217a9c0dc..08af6d709 100644 --- a/src/Cryptol/TypeCheck/InferTypes.hs +++ b/src/Cryptol/TypeCheck/InferTypes.hs @@ -220,6 +220,8 @@ data ConstraintSource | CtImprovement | CtPattern TypeSource -- ^ Constraints arising from type-checking patterns | CtModuleInstance ModName -- ^ Instantiating a parametrized module + | CtFFI Name -- ^ Constraints on a foreign declaration required + -- by the FFI (e.g. sequences must be finite) deriving (Show, Generic, NFData) selSrc :: Selector -> TypeSource @@ -247,6 +249,7 @@ instance TVars ConstraintSource where CtImprovement -> src CtPattern _ -> src CtModuleInstance _ -> src + CtFFI _ -> src instance FVS Goal where @@ -353,6 +356,7 @@ instance PP ConstraintSource where CtImprovement -> "examination of collected goals" CtPattern ad -> "checking a pattern:" <+> pp ad CtModuleInstance n -> "module instantiation" <+> pp n + CtFFI f -> "declaration of foreign function" <+> pp f ppUse :: Expr -> Doc ppUse expr = diff --git a/src/Cryptol/TypeCheck/Parseable.hs b/src/Cryptol/TypeCheck/Parseable.hs index 86f72f06b..a7eba7448 100644 --- a/src/Cryptol/TypeCheck/Parseable.hs +++ b/src/Cryptol/TypeCheck/Parseable.hs @@ -93,6 +93,7 @@ instance ShowParseable Decl where instance ShowParseable DeclDef where showParseable DPrim = text (show DPrim) + showParseable (DForeign t) = text (show $ DForeign t) showParseable (DExpr e) = parens (text "DExpr" $$ showParseable e) instance ShowParseable DeclGroup where diff --git a/src/Cryptol/TypeCheck/Sanity.hs b/src/Cryptol/TypeCheck/Sanity.hs index fc995288d..aa4ee91ce 100644 --- a/src/Cryptol/TypeCheck/Sanity.hs +++ b/src/Cryptol/TypeCheck/Sanity.hs @@ -398,6 +398,10 @@ checkDecl checkSig d = do when checkSig $ checkSchema $ dSignature d return (dName d, dSignature d) + DForeign _ -> + do when checkSig $ checkSchema $ dSignature d + return (dName d, dSignature d) + DExpr e -> do let s = dSignature d when checkSig $ checkSchema s diff --git a/src/Cryptol/TypeCheck/Solve.hs b/src/Cryptol/TypeCheck/Solve.hs index b0bc432dc..85741a9b5 100644 --- a/src/Cryptol/TypeCheck/Solve.hs +++ b/src/Cryptol/TypeCheck/Solve.hs @@ -37,6 +37,7 @@ import Cryptol.Utils.Patterns(matchMaybe) import Control.Applicative ((<|>)) import Control.Monad(mzero) +import Data.Containers.ListUtils (nubOrd) import Data.Map (Map) import qualified Data.Map as Map import Data.Set ( Set ) @@ -265,20 +266,21 @@ proveModuleTopLevel = cs <- getParamConstraints case cs of [] -> addGoals gs1 - _ -> do su2 <- proveImplication Nothing [] [] gs1 + _ -> do su2 <- proveImplication False Nothing [] [] gs1 extendSubst su2 -- | Prove an implication, and return any improvements that we computed. -- Records errors, if any of the goals couldn't be solved. -proveImplication :: Maybe Name -> [TParam] -> [Prop] -> [Goal] -> InferM Subst -proveImplication lnam as ps gs = +proveImplication :: Bool -> Maybe Name -> + [TParam] -> [Prop] -> [Goal] -> InferM Subst +proveImplication dedupErrs lnam as ps gs = do evars <- varsWithAsmps solver <- getSolver extraAs <- (map mtpParam . Map.elems) <$> getParamTypes extra <- map thing <$> getParamConstraints - (mbErr,su) <- io (proveImplicationIO solver lnam evars + (mbErr,su) <- io (proveImplicationIO solver dedupErrs lnam evars (extraAs ++ as) (extra ++ ps) gs) case mbErr of Right ws -> mapM_ recordWarning ws @@ -287,6 +289,7 @@ proveImplication lnam as ps gs = proveImplicationIO :: Solver + -> Bool -- ^ Whether to remove duplicate goals in errors -> Maybe Name -- ^ Checking this function -> Set TVar -- ^ These appear in the env., and we should -- not try to default them @@ -294,8 +297,8 @@ proveImplicationIO :: Solver -> [Prop] -- ^ Assumed constraint -> [Goal] -- ^ Collected constraints -> IO (Either [Error] [Warning], Subst) -proveImplicationIO _ _ _ _ [] [] = return (Right [], emptySubst) -proveImplicationIO s f varsInEnv ps asmps0 gs0 = +proveImplicationIO _ _ _ _ _ [] [] = return (Right [], emptySubst) +proveImplicationIO s dedupErrs f varsInEnv ps asmps0 gs0 = do let ctxt = buildSolverCtxt asmps res <- quickSolverIO ctxt gs case res of @@ -315,7 +318,7 @@ proveImplicationIO s f varsInEnv ps asmps0 gs0 = return (Left (err gs3:errs), su) -- XXX: Old? (_,newGs,newSu,ws,errs) -> do let su1 = newSu @@ su - (res1,su2) <- proveImplicationIO s f varsInEnv ps + (res1,su2) <- proveImplicationIO s dedupErrs f varsInEnv ps (apSubst su1 asmps0) newGs let su3 = su2 @@ su1 case res1 of @@ -329,7 +332,7 @@ proveImplicationIO s f varsInEnv ps asmps0 gs0 = $ DelayedCt { dctSource = f , dctForall = ps , dctAsmps = asmps0 - , dctGoals = us + , dctGoals = if dedupErrs then nubOrd us else us } diff --git a/src/Cryptol/TypeCheck/Subst.hs b/src/Cryptol/TypeCheck/Subst.hs index 474c537a8..0ed3c5a43 100644 --- a/src/Cryptol/TypeCheck/Subst.hs +++ b/src/Cryptol/TypeCheck/Subst.hs @@ -406,8 +406,9 @@ instance TVars Decl where in d { dSignature = sig', dDefinition = def' } instance TVars DeclDef where - apSubst su (DExpr e) = DExpr !$ (apSubst su e) - apSubst _ DPrim = DPrim + apSubst su (DExpr e) = DExpr !$ (apSubst su e) + apSubst _ DPrim = DPrim + apSubst _ (DForeign t) = DForeign t instance TVars Module where apSubst su m = diff --git a/src/Cryptol/Utils/RecordMap.hs b/src/Cryptol/Utils/RecordMap.hs index f8599702f..2d16fc246 100644 --- a/src/Cryptol/Utils/RecordMap.hs +++ b/src/Cryptol/Utils/RecordMap.hs @@ -21,6 +21,7 @@ module Cryptol.Utils.RecordMap , canonicalFields , displayFields , recordElements + , displayElements , fieldSet , recordFromFields , recordFromFieldsErr @@ -89,6 +90,11 @@ recordElements = map snd . canonicalFields canonicalFields :: RecordMap a b -> [(a,b)] canonicalFields = Map.toList . recordMap +-- | Retrieve the elements of the record in display order +-- of the field names. +displayElements :: (Show a, Ord a) => RecordMap a b -> [b] +displayElements = map snd . displayFields + -- | Return a list of field/value pairs in display order. displayFields :: (Show a, Ord a) => RecordMap a b -> [(a,b)] displayFields r = map find (displayOrder r) diff --git a/src/Cryptol/Version.hs b/src/Cryptol/Version.hs index 58135e217..ad439e899 100644 --- a/src/Cryptol/Version.hs +++ b/src/Cryptol/Version.hs @@ -6,6 +6,7 @@ -- Stability : provisional -- Portability : portable +{-# LANGUAGE CPP #-} {-# LANGUAGE Safe #-} module Cryptol.Version ( @@ -39,6 +40,9 @@ displayVersion putLn = do putLn ("Cryptol " ++ ver) putLn ("Git commit " ++ commitHash) putLn (" branch " ++ commitBranch ++ dirtyLab) +#ifdef FFI_ENABLED + putLn "FFI enabled" +#endif where dirtyLab | commitDirty = " (non-committed files present during build)" | otherwise = "" diff --git a/tests/.gitignore b/tests/.gitignore index 53752db25..0332d461a 100644 --- a/tests/.gitignore +++ b/tests/.gitignore @@ -1 +1,3 @@ output +*.so +*.dylib diff --git a/tests/ffi/Makefile b/tests/ffi/Makefile new file mode 100644 index 000000000..af40830e5 --- /dev/null +++ b/tests/ffi/Makefile @@ -0,0 +1,28 @@ +CFLAGS += -Wall -Werror + +# For each C file foo.c, we make a phony target foo, then depending on the OS +# map that to either foo.dylib or foo.so. + +CFILES = $(wildcard *.c) +TARGETS = $(CFILES:.c=) + +all: $(TARGETS) + +.PHONY: all clean $(TARGETS) + +ifeq ($(shell uname),Darwin) +EXT = .dylib +else +EXT = .so +endif + +$(TARGETS): %: %$(EXT) + +%.dylib: %.c + $(CC) $(CFLAGS) -dynamiclib $< -o $@ + +%.so: %.c + $(CC) $(CFLAGS) -fPIC -shared $< -o $@ + +clean: + rm *$(EXT) diff --git a/tests/ffi/ffi-reload.cry b/tests/ffi/ffi-reload.cry new file mode 100644 index 000000000..71a0d88ab --- /dev/null +++ b/tests/ffi/ffi-reload.cry @@ -0,0 +1 @@ +foreign test : () -> Bit diff --git a/tests/ffi/ffi-reload.icry b/tests/ffi/ffi-reload.icry new file mode 100644 index 000000000..0c3924b2f --- /dev/null +++ b/tests/ffi/ffi-reload.icry @@ -0,0 +1,10 @@ +:! echo '#include \nuint8_t test() { return 0; }' > ffi-reload.c +:! make -s ffi-reload +:l ffi-reload.cry +test () +:! sleep 1 +:! sed -i.bak 's/return 0/return 1/' ffi-reload.c +:! make -s ffi-reload +:r +test () +:! rm ffi-reload.c ffi-reload.c.bak diff --git a/tests/ffi/ffi-reload.icry.stdout b/tests/ffi/ffi-reload.icry.stdout new file mode 100644 index 000000000..441a89a75 --- /dev/null +++ b/tests/ffi/ffi-reload.icry.stdout @@ -0,0 +1,7 @@ +Loading module Cryptol +Loading module Cryptol +Loading module Main +False +Loading module Cryptol +Loading module Main +True diff --git a/tests/ffi/ffi-runtime-errors.c b/tests/ffi/ffi-runtime-errors.c new file mode 100644 index 000000000..b7c27ad1a --- /dev/null +++ b/tests/ffi/ffi-runtime-errors.c @@ -0,0 +1,10 @@ +#include +#include + +uint8_t f(size_t n, uint8_t *p) { + return n == 0; +} + +uint8_t g(uint8_t x) { + return x; +} diff --git a/tests/ffi/ffi-runtime-errors.cry b/tests/ffi/ffi-runtime-errors.cry new file mode 100644 index 000000000..4343f792a --- /dev/null +++ b/tests/ffi/ffi-runtime-errors.cry @@ -0,0 +1,2 @@ +foreign f : {n} (fin n, n >= 2^^64) => [n - 2^^64][8] -> Bit +foreign g : Bit -> Bit diff --git a/tests/ffi/ffi-runtime-errors.icry b/tests/ffi/ffi-runtime-errors.icry new file mode 100644 index 000000000..402bd5ad3 --- /dev/null +++ b/tests/ffi/ffi-runtime-errors.icry @@ -0,0 +1,9 @@ +:! make -s ffi-runtime-errors +:l ffi-runtime-errors.cry + +f [] + +:prove g +:sat g +:safe g +:eval g diff --git a/tests/ffi/ffi-runtime-errors.icry.stdout b/tests/ffi/ffi-runtime-errors.icry.stdout new file mode 100644 index 000000000..1bf3c9006 --- /dev/null +++ b/tests/ffi/ffi-runtime-errors.icry.stdout @@ -0,0 +1,28 @@ +Loading module Cryptol +Loading module Cryptol +Loading module Main + +numeric type argument to foreign function is too large: 18446744073709551616 +in type parameter n`899 of function Main::f +type arguments must fit in a C `size_t` +-- Backtrace -- +Main::f called at ffi-runtime-errors.icry:4:1--4:2 + +cannot call foreign function Main::g +FFI calls are not supported in this context +If you are trying to evaluate an expression, try rebuilding + Cryptol with FFI support enabled. + +cannot call foreign function Main::g +FFI calls are not supported in this context +If you are trying to evaluate an expression, try rebuilding + Cryptol with FFI support enabled. + +cannot call foreign function Main::g +FFI calls are not supported in this context +If you are trying to evaluate an expression, try rebuilding + Cryptol with FFI support enabled. +cannot call foreign function Main::g +FFI calls are not supported in this context +If you are trying to evaluate an expression, try rebuilding + Cryptol with FFI support enabled. diff --git a/tests/ffi/ffi-type-errors.cry b/tests/ffi/ffi-type-errors.cry new file mode 100644 index 000000000..4c13c57ee --- /dev/null +++ b/tests/ffi/ffi-type-errors.cry @@ -0,0 +1,11 @@ +import Float + +foreign badWordSizes : [65] -> [128] +foreign badFloatSizes : Float16 -> Float128 +foreign badArrayTypes : {n} (fin n) => [n]Bit -> [n]([16], [16]) -> [n][4][8] +foreign badTypes : Integer -> Z 3 +foreign notFunction : [32] +foreign badKind : {t} t -> [32] +foreign noFin : {n} [n][32] -> [n * 2][32] +foreign infSeq : [inf][32] -> Bit +foreign wildcard : { x : [8], y : Float32 } -> _ diff --git a/tests/ffi/ffi-type-errors.icry b/tests/ffi/ffi-type-errors.icry new file mode 100644 index 000000000..e49c54e26 --- /dev/null +++ b/tests/ffi/ffi-type-errors.icry @@ -0,0 +1 @@ +:l ffi-type-errors.cry diff --git a/tests/ffi/ffi-type-errors.icry.stdout b/tests/ffi/ffi-type-errors.icry.stdout new file mode 100644 index 000000000..e13efa913 --- /dev/null +++ b/tests/ffi/ffi-type-errors.icry.stdout @@ -0,0 +1,102 @@ +Loading module Cryptol +Loading module Cryptol +Loading module Float +Loading module Main + +[error] at ffi-type-errors.cry:3:9--3:37: + Type unsupported for FFI: + [65] -> [128] + Due to: + Type unsupported for FFI: + [65] + Due to: + Unsupported word size + Only words of up to 64 bits are supported + Type unsupported for FFI: + [128] + Due to: + Unsupported word size + Only words of up to 64 bits are supported + When checking the type of 'Main::badWordSizes' +[error] at ffi-type-errors.cry:4:9--4:44: + Type unsupported for FFI: + Float 5 11 -> Float 15 113 + Due to: + Type unsupported for FFI: + Float 5 11 + Due to: + Unsupported Float format + Only Float32 and Float64 are supported + Type unsupported for FFI: + Float 15 113 + Due to: + Unsupported Float format + Only Float32 and Float64 are supported + When checking the type of 'Main::badFloatSizes' +[error] at ffi-type-errors.cry:5:9--5:78: + Type unsupported for FFI: + [n`969] -> [n`969]([16], [16]) -> [n`969][4][8] + Due to: + Type unsupported for FFI: + [n`969] + Due to: + Unsupported sequence element type + Only words or floats are supported as the element type of sequences + Type unsupported for FFI: + [n`969]([16], [16]) + Due to: + Unsupported sequence element type + Only words or floats are supported as the element type of sequences + Type unsupported for FFI: + [n`969][4][8] + Due to: + Unsupported sequence element type + Only words or floats are supported as the element type of sequences + When checking the type of 'Main::badArrayTypes' +[error] at ffi-type-errors.cry:6:9--6:34: + Type unsupported for FFI: + Integer -> Z 3 + Due to: + Type unsupported for FFI: + Integer + Due to: + Only Bit, words, floats, sequences of words or floats, + or structs or tuples of the above are supported as FFI + argument or return types + Type unsupported for FFI: + Z 3 + Due to: + Only Bit, words, floats, sequences of words or floats, + or structs or tuples of the above are supported as FFI + argument or return types + When checking the type of 'Main::badTypes' +[error] at ffi-type-errors.cry:7:9--7:27: + Type unsupported for FFI: + [32] + Due to: + FFI binding must be a function + When checking the type of 'Main::notFunction' +[error] at ffi-type-errors.cry:8:9--8:32: + Kind of type variable unsupported for FFI: + t`970 : * + Only type variables of kind # are supported + When checking the type of 'Main::badKind' +[error] at ffi-type-errors.cry:9:9--9:43: + Failed to validate user-specified signature. + in the definition of 'Main::noFin', at ffi-type-errors.cry:9:9--9:14, + we need to show that + for any type n + the following constraints hold: + • fin n + arising from + declaration of foreign function Main::noFin + at ffi-type-errors.cry:9:9--9:43 +[error] at ffi-type-errors.cry:10:9--10:34: + • Unsolvable constraint: + fin inf + arising from + declaration of foreign function Main::infSeq + at ffi-type-errors.cry:10:9--10:34 +[error] at ffi-type-errors.cry:11:48--11:49: + Wild card types are not allowed in this context + (e.g., they cannot be used in type synonyms or FFI declarations). diff --git a/tests/ffi/test-ffi.c b/tests/ffi/test-ffi.c new file mode 100644 index 000000000..6a88c9a61 --- /dev/null +++ b/tests/ffi/test-ffi.c @@ -0,0 +1,118 @@ +#include +#include +#include +#include + +uint8_t add8(uint8_t x, uint8_t y) { + return x + y; +} + +uint16_t sub16(uint16_t x, uint16_t y) { + return x - y; +} + +uint32_t mul32(uint32_t x, uint32_t y) { + return x * y; +} + +uint64_t div64(uint64_t x, uint64_t y) { + return x / y; +} + +uint8_t extendInput(uint8_t x) { + return x; +} + +uint8_t maskOutput(uint8_t x) { + return x; +} + +uint8_t noBits(uint8_t zero) { + assert(zero == 0); + return 1; +} + +uint8_t not(uint8_t x) { + return !x; +} + +float addFloat32(float x, float y) { + return x + y; +} + +double subFloat64(double x, double y) { + return x - y; +} + +float specialFloats(uint8_t select) { + switch (select) { + case 0: + return INFINITY; + case 1: + return -INFINITY; + case 2: + return NAN; + case 3: + return -0.0f; + } + return 0; +} + +uint8_t usesTypeSynonym(uint32_t x, float y) { + return x == y; +} + +uint32_t sum10(uint32_t *xs) { + uint32_t sum = 0; + for (unsigned i = 0; i < 10; ++i) { + sum += xs[i]; + } + return sum; +} + +void reverse5(double *in, double *out) { + for (unsigned i = 0; i < 5; ++i) { + out[i] = in[4 - i]; + } +} + +void compoundTypes(uint32_t n, uint16_t x, uint32_t *y, uint32_t *z, + uint16_t *a_0, uint16_t *a_1, uint32_t *c, uint8_t *d, uint8_t *e) { + *a_0 = n >> 16; + *a_1 = n; + for (unsigned i = 0; i < 3; ++i) { + c[i] = y[i]; + } + for (unsigned i = 0; i < 5; ++i) { + c[i + 3] = z[i]; + } + *d = x >> 5; + *e = x; +} + +uint64_t typeToValue(size_t n) { + return n; +} + +uint32_t sumPoly(size_t n, uint32_t *xs) { + uint32_t sum = 0; + for (size_t i = 0; i < n; ++i) { + sum += xs[i]; + } + return sum; +} + +void inits(size_t n, uint8_t *in, uint8_t *out) { + for (unsigned i = 1; i <= n; ++i) { + for (unsigned j = 0; j < i; ++j) { + *out++ = in[j]; + } + } +} + +void zipMul3(size_t n, size_t m, size_t p, float *xs, float *ys, float *zs, + float *out) { + for (size_t i = 0; i < n && i < m && i < p; ++i) { + out[i] = xs[i] * ys[i] * zs[i]; + } +} diff --git a/tests/ffi/test-ffi.cry b/tests/ffi/test-ffi.cry new file mode 100644 index 000000000..2be07c795 --- /dev/null +++ b/tests/ffi/test-ffi.cry @@ -0,0 +1,40 @@ +import Float + +// Basic integral types +foreign add8 : [8] -> [8] -> [8] +foreign sub16 : [16] -> [16] -> [16] +foreign mul32 : [32] -> [32] -> [32] +foreign div64 : [64] -> [64] -> [64] + +// Non-machine integer sizes +foreign extendInput : [3] -> [8] +foreign maskOutput : [8] -> [3] +foreign noBits : [0] -> [0] + +// Bit +foreign not : Bit -> Bit + +// Float +foreign addFloat32 : Float32 -> Float32 -> Float32 +foreign subFloat64 : Float64 -> Float64 -> Float64 +foreign specialFloats : [2] -> Float32 + +// Type synonyms +type Word32 = [32] +type MyFunc = Word32 -> Float32 -> Bit +foreign usesTypeSynonym : MyFunc + +// Sequences +foreign sum10 : [10]Word32 -> Word32 +foreign reverse5 : [5]Float64 -> [5]Float64 + +// Tuples and records +foreign compoundTypes : ([32], { x : [10], y : [3][20] }) -> { z : [5][20] } + -> { a : ([16], [16]), b : { c : [8][20], d : [5], e : [5] } } + +// Polymorphic sizes +foreign typeToValue : {n} (fin n) => () -> [64] +foreign sumPoly : {n} (fin n) => [n]Word32 -> Word32 +foreign inits : {n} (fin n) => [n][8] -> [n * (n + 1) / 2][8] +foreign zipMul3 : {n, m, p} (fin n, fin m, fin p) => + [n]Float32 -> [m]Float32 -> [p]Float32 -> [min n (min m p)]Float32 diff --git a/tests/ffi/test-ffi.icry b/tests/ffi/test-ffi.icry new file mode 100644 index 000000000..93f2771e5 --- /dev/null +++ b/tests/ffi/test-ffi.icry @@ -0,0 +1,34 @@ +:! make -s test-ffi +:l test-ffi.cry + +add8 1 2 +sub16 12345 6789 +mul32 123456 7890 +div64 12345678901234567890 987654321 + +extendInput 7 +maskOutput 255 +noBits 0 + +not True + +addFloat32 12.34 56.78 +subFloat64 1234.5678 9012.3456 +specialFloats 0 +specialFloats 1 +specialFloats 2 +specialFloats 3 + +usesTypeSynonym 42 42 + +sum10 [1..10] +reverse5 [0x1.23, -0x3.45, 0x6.78, -0x9.0a, 0xb.cd] + +compoundTypes (0x12345678, {y = [10, 20, 30], x = 300}) {z = [40, 50, 60, 70, 80]} + +typeToValue`{0x12345678deadbeef} () +sumPoly [] +sumPoly [1..10] +sumPoly [1..10000] +inits [1..5] +zipMul3 [1, 2, 3] [3, 4, 5, 6] [6, 7, 8, 9, 10] diff --git a/tests/ffi/test-ffi.icry.stdout b/tests/ffi/test-ffi.icry.stdout new file mode 100644 index 000000000..72db4b2e8 --- /dev/null +++ b/tests/ffi/test-ffi.icry.stdout @@ -0,0 +1,33 @@ +Loading module Cryptol +Loading module Cryptol +Loading module Float +Loading module Main +0x03 +0x15b4 +0x3a0f1880 +0x00000002e90edc8f +0x07 +0x7 +0x0 +False +0x45.1eb8 +-0x1e61.c71de69ad5 +fpPosInf +fpNegInf +fpNaN +-0.0 +True +0x00000037 +[0xb.cd, -0x9.0a, 0x6.78, -0x3.45, 0x1.23] +{a = (0x1234, 0x5678), + b = {c = [0x0000a, 0x00014, 0x0001e, 0x00028, 0x00032, 0x0003c, + 0x00046, 0x00050], + d = 0x09, + e = 0x0c}} +0x12345678deadbeef +0x00000000 +0x00000037 +0x02fb0408 +[0x01, 0x01, 0x02, 0x01, 0x02, 0x03, 0x01, 0x02, 0x03, 0x04, 0x01, + 0x02, 0x03, 0x04, 0x05] +[0x12.0, 0x38.0, 0x78.0] diff --git a/tests/regression/tc-errors.icry.stdout b/tests/regression/tc-errors.icry.stdout index 03e4e534e..a31ed9ac6 100644 --- a/tests/regression/tc-errors.icry.stdout +++ b/tests/regression/tc-errors.icry.stdout @@ -77,7 +77,7 @@ Loading module Main [error] at tc-errors-4.cry:1:10--1:11: Wild card types are not allowed in this context - (e.g., they cannot be used in type synonyms). + (e.g., they cannot be used in type synonyms or FFI declarations). Loading module Cryptol Loading module Main