From 9a1dbf5d9469cf175c48cb4da558f3c9b8e0fdc5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Gia=20Phong?= Date: Mon, 24 Aug 2020 16:41:13 +0700 Subject: [PATCH] Move documentation to docs/ --- .nojekyll | 0 Makefile => docs/Makefile | 13 +- make.bat => docs/make.bat | 4 +- {src => docs/source}/_static/.empty | 0 {src => docs/source}/_templates/quicknav.html | 0 docs/source/conf.py | 39 + {src => docs/source}/contributing.rst | 0 {src => docs/source}/copying.rst | 0 {src => docs/source}/design.rst | 0 {src => docs/source}/index.rst | 0 {src => docs/source}/installation.rst | 0 {src => docs/source}/reference/buffer.rst | 0 {src => docs/source}/reference/context.rst | 0 {src => docs/source}/reference/decoder.rst | 0 {src => docs/source}/reference/device.rst | 0 {src => docs/source}/reference/effect.rst | 0 {src => docs/source}/reference/file-io.rst | 0 {src => docs/source}/reference/index.rst | 0 {src => docs/source}/reference/source.rst | 0 {src => docs/source}/tutorial/context.rst | 0 {src => docs/source}/tutorial/index.rst | 0 {src => docs/source}/tutorial/play-audio.rst | 0 {src => docs/source}/tutorial/source.rst | 0 html/.buildinfo | 4 - html/_sources/contributing.rst.txt | 203 - html/_sources/copying.rst.txt | 75 - html/_sources/design.rst.txt | 185 - html/_sources/index.rst.txt | 38 - html/_sources/installation.rst.txt | 37 - html/_sources/reference/buffer.rst.txt | 17 - html/_sources/reference/context.rst.txt | 83 - html/_sources/reference/decoder.rst.txt | 44 - html/_sources/reference/device.rst.txt | 21 - html/_sources/reference/effect.rst.txt | 34 - html/_sources/reference/file-io.rst.txt | 11 - html/_sources/reference/index.rst.txt | 14 - html/_sources/reference/source.rst.txt | 16 - html/_sources/tutorial/context.rst.txt | 41 - html/_sources/tutorial/index.rst.txt | 15 - html/_sources/tutorial/play-audio.rst.txt | 101 - html/_sources/tutorial/source.rst.txt | 82 - html/_static/alabaster.css | 707 - html/_static/basic.css | 855 -- html/_static/custom.css | 1 - html/_static/doctools.js | 315 - html/_static/documentation_options.js | 12 - html/_static/file.png | Bin 286 -> 0 bytes html/_static/jquery-3.4.1.js | 10598 --------------- html/_static/jquery-3.5.1.js | 10872 ---------------- html/_static/jquery.js | 2 - html/_static/language_data.js | 297 - html/_static/minus.png | Bin 90 -> 0 bytes html/_static/plus.png | Bin 90 -> 0 bytes html/_static/pygments.css | 77 - html/_static/searchtools.js | 514 - html/_static/underscore-1.3.1.js | 999 -- html/_static/underscore.js | 31 - html/contributing.html | 332 - html/copying.html | 224 - html/design.html | 299 - html/genindex.html | 722 - html/index.html | 204 - html/installation.html | 177 - html/objects.inv | Bin 1982 -> 0 bytes html/reference/buffer.html | 351 - html/reference/context.html | 581 - html/reference/decoder.html | 431 - html/reference/device.html | 330 - html/reference/effect.html | 451 - html/reference/file-io.html | 211 - html/reference/index.html | 194 - html/reference/source.html | 673 - html/search.html | 137 - html/searchindex.js | 1 - html/tutorial/context.html | 181 - html/tutorial/index.html | 172 - html/tutorial/play-audio.html | 230 - html/tutorial/source.html | 216 - index.html | 2 - requirements.txt | 2 - src/conf.py | 67 - 81 files changed, 47 insertions(+), 32498 deletions(-) delete mode 100644 .nojekyll rename Makefile => docs/Makefile (69%) rename make.bat => docs/make.bat (90%) rename {src => docs/source}/_static/.empty (100%) rename {src => docs/source}/_templates/quicknav.html (100%) create mode 100644 docs/source/conf.py rename {src => docs/source}/contributing.rst (100%) rename {src => docs/source}/copying.rst (100%) rename {src => docs/source}/design.rst (100%) rename {src => docs/source}/index.rst (100%) rename {src => docs/source}/installation.rst (100%) rename {src => docs/source}/reference/buffer.rst (100%) rename {src => docs/source}/reference/context.rst (100%) rename {src => docs/source}/reference/decoder.rst (100%) rename {src => docs/source}/reference/device.rst (100%) rename {src => docs/source}/reference/effect.rst (100%) rename {src => docs/source}/reference/file-io.rst (100%) rename {src => docs/source}/reference/index.rst (100%) rename {src => docs/source}/reference/source.rst (100%) rename {src => docs/source}/tutorial/context.rst (100%) rename {src => docs/source}/tutorial/index.rst (100%) rename {src => docs/source}/tutorial/play-audio.rst (100%) rename {src => docs/source}/tutorial/source.rst (100%) delete mode 100644 html/.buildinfo delete mode 100644 html/_sources/contributing.rst.txt delete mode 100644 html/_sources/copying.rst.txt delete mode 100644 html/_sources/design.rst.txt delete mode 100644 html/_sources/index.rst.txt delete mode 100644 html/_sources/installation.rst.txt delete mode 100644 html/_sources/reference/buffer.rst.txt delete mode 100644 html/_sources/reference/context.rst.txt delete mode 100644 html/_sources/reference/decoder.rst.txt delete mode 100644 html/_sources/reference/device.rst.txt delete mode 100644 html/_sources/reference/effect.rst.txt delete mode 100644 html/_sources/reference/file-io.rst.txt delete mode 100644 html/_sources/reference/index.rst.txt delete mode 100644 html/_sources/reference/source.rst.txt delete mode 100644 html/_sources/tutorial/context.rst.txt delete mode 100644 html/_sources/tutorial/index.rst.txt delete mode 100644 html/_sources/tutorial/play-audio.rst.txt delete mode 100644 html/_sources/tutorial/source.rst.txt delete mode 100644 html/_static/alabaster.css delete mode 100644 html/_static/basic.css delete mode 100644 html/_static/custom.css delete mode 100644 html/_static/doctools.js delete mode 100644 html/_static/documentation_options.js delete mode 100644 html/_static/file.png delete mode 100644 html/_static/jquery-3.4.1.js delete mode 100644 html/_static/jquery-3.5.1.js delete mode 100644 html/_static/jquery.js delete mode 100644 html/_static/language_data.js delete mode 100644 html/_static/minus.png delete mode 100644 html/_static/plus.png delete mode 100644 html/_static/pygments.css delete mode 100644 html/_static/searchtools.js delete mode 100644 html/_static/underscore-1.3.1.js delete mode 100644 html/_static/underscore.js delete mode 100644 html/contributing.html delete mode 100644 html/copying.html delete mode 100644 html/design.html delete mode 100644 html/genindex.html delete mode 100644 html/index.html delete mode 100644 html/installation.html delete mode 100644 html/objects.inv delete mode 100644 html/reference/buffer.html delete mode 100644 html/reference/context.html delete mode 100644 html/reference/decoder.html delete mode 100644 html/reference/device.html delete mode 100644 html/reference/effect.html delete mode 100644 html/reference/file-io.html delete mode 100644 html/reference/index.html delete mode 100644 html/reference/source.html delete mode 100644 html/search.html delete mode 100644 html/searchindex.js delete mode 100644 html/tutorial/context.html delete mode 100644 html/tutorial/index.html delete mode 100644 html/tutorial/play-audio.html delete mode 100644 html/tutorial/source.html delete mode 100644 index.html delete mode 100644 requirements.txt delete mode 100644 src/conf.py diff --git a/.nojekyll b/.nojekyll deleted file mode 100644 index e69de29..0000000 diff --git a/Makefile b/docs/Makefile similarity index 69% rename from Makefile rename to docs/Makefile index 724a572..501f2d1 100644 --- a/Makefile +++ b/docs/Makefile @@ -1,12 +1,11 @@ # Minimal makefile for Sphinx documentation -# -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = src -BUILDDIR = . +# You can set these variables from the command line, +# and also from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build # Put it first so that "make" without argument is like "make help". help: diff --git a/make.bat b/docs/make.bat similarity index 90% rename from make.bat rename to docs/make.bat index cdb58dd..6247f7e 100644 --- a/make.bat +++ b/docs/make.bat @@ -7,8 +7,8 @@ REM Command file for Sphinx documentation if "%SPHINXBUILD%" == "" ( set SPHINXBUILD=sphinx-build ) -set SOURCEDIR=src -set BUILDDIR=. +set SOURCEDIR=source +set BUILDDIR=build if "%1" == "" goto help diff --git a/src/_static/.empty b/docs/source/_static/.empty similarity index 100% rename from src/_static/.empty rename to docs/source/_static/.empty diff --git a/src/_templates/quicknav.html b/docs/source/_templates/quicknav.html similarity index 100% rename from src/_templates/quicknav.html rename to docs/source/_templates/quicknav.html diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..7f0c4cc --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,39 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. +# For a full list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# Project information +project = 'palace' +copyright = '2019, 2020 Nguyễn Gia Phong et al' +author = 'Nguyễn Gia Phong et al.' +release = '0.2.1' + +# Add any Sphinx extension module names here, as strings. +# They can be extensions coming with Sphinx (named 'sphinx.ext.*') +# or your custom ones. +extensions = [ + 'sphinx.ext.autodoc', 'sphinx.ext.githubpages', 'sphinx.ext.napoleon'] +napoleon_google_docstring = False + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match +# files and directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# Options for HTML output +html_theme = 'alabaster' +html_theme_options = {'fixed_sidebar': True, 'show_relbars': True} + +html_sidebars = { + '**': ['globaltoc.html', 'quicknav.html', 'searchbox.html']} + +# Add any paths that contain custom static files (such as style sheets) +# here, relative to this directory. They are copied after the builtin +# static files, so a file named "default.css" will overwrite the builtin +# "default.css". +html_static_path = ['_static'] diff --git a/src/contributing.rst b/docs/source/contributing.rst similarity index 100% rename from src/contributing.rst rename to docs/source/contributing.rst diff --git a/src/copying.rst b/docs/source/copying.rst similarity index 100% rename from src/copying.rst rename to docs/source/copying.rst diff --git a/src/design.rst b/docs/source/design.rst similarity index 100% rename from src/design.rst rename to docs/source/design.rst diff --git a/src/index.rst b/docs/source/index.rst similarity index 100% rename from src/index.rst rename to docs/source/index.rst diff --git a/src/installation.rst b/docs/source/installation.rst similarity index 100% rename from src/installation.rst rename to docs/source/installation.rst diff --git a/src/reference/buffer.rst b/docs/source/reference/buffer.rst similarity index 100% rename from src/reference/buffer.rst rename to docs/source/reference/buffer.rst diff --git a/src/reference/context.rst b/docs/source/reference/context.rst similarity index 100% rename from src/reference/context.rst rename to docs/source/reference/context.rst diff --git a/src/reference/decoder.rst b/docs/source/reference/decoder.rst similarity index 100% rename from src/reference/decoder.rst rename to docs/source/reference/decoder.rst diff --git a/src/reference/device.rst b/docs/source/reference/device.rst similarity index 100% rename from src/reference/device.rst rename to docs/source/reference/device.rst diff --git a/src/reference/effect.rst b/docs/source/reference/effect.rst similarity index 100% rename from src/reference/effect.rst rename to docs/source/reference/effect.rst diff --git a/src/reference/file-io.rst b/docs/source/reference/file-io.rst similarity index 100% rename from src/reference/file-io.rst rename to docs/source/reference/file-io.rst diff --git a/src/reference/index.rst b/docs/source/reference/index.rst similarity index 100% rename from src/reference/index.rst rename to docs/source/reference/index.rst diff --git a/src/reference/source.rst b/docs/source/reference/source.rst similarity index 100% rename from src/reference/source.rst rename to docs/source/reference/source.rst diff --git a/src/tutorial/context.rst b/docs/source/tutorial/context.rst similarity index 100% rename from src/tutorial/context.rst rename to docs/source/tutorial/context.rst diff --git a/src/tutorial/index.rst b/docs/source/tutorial/index.rst similarity index 100% rename from src/tutorial/index.rst rename to docs/source/tutorial/index.rst diff --git a/src/tutorial/play-audio.rst b/docs/source/tutorial/play-audio.rst similarity index 100% rename from src/tutorial/play-audio.rst rename to docs/source/tutorial/play-audio.rst diff --git a/src/tutorial/source.rst b/docs/source/tutorial/source.rst similarity index 100% rename from src/tutorial/source.rst rename to docs/source/tutorial/source.rst diff --git a/html/.buildinfo b/html/.buildinfo deleted file mode 100644 index 44fb98c..0000000 --- a/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# 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: 15f696dd8f7d3d70ce592a5e4a09ce3d -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/html/_sources/contributing.rst.txt b/html/_sources/contributing.rst.txt deleted file mode 100644 index ecc13f1..0000000 --- a/html/_sources/contributing.rst.txt +++ /dev/null @@ -1,203 +0,0 @@ -Getting Involved -================ - -.. note:: The development of palace is carried out on GitHub_. - Since GitHub is not free software, we fully understand - if one does not want to register an account just to participate - in our development. Therefore, we also welcome patches - and bug reports sent via email. - -First of all, thank you for using and contributing to palace! We welcome -all forms of contribution, and `the mo the merier`_. By saying this, we also -mean that we much prefer receiving many small and self-contained bug reports, -feature requests and patches than a giant one. There is no limit for -the number of contributions one may or should make. While it may seem -appealing to be able to dump all thoughts and feelings into one ticket, -it would be more difficult for us to keep track of the progress. - -Reporting a Bug ---------------- - -Before filing a bug report, please make sure that the bug has not been -already reported by searching our GitHub Issues_ tracker. - -To facilitate the debugging process, a bug report should at least contain -the following information: - -#. The platform, the CPython version and the compiler used to build it. - These can be obtained from :py:func:`platform.platform`, - :py:func:`platform.python_version` and :py:func:`platform.python_compiler`, - respectively. -#. The version of palace and how you installed it. - The earlier is usually provided by ``pip show palace``. -#. Detailed instructions on how to reproduce the bug, - for example a short Python script would be appreciated. - -Requesting a Feature --------------------- - -Prior to filing a feature request, please make sure that the feature -has not been already reported by searching our GitHub Issues_ tracker. - -Please only ask for features that you (or an incapacitated friend -you can personally talk to) require. Do not request features because -they seem like a good idea. If they are really useful, they will be -requested by someone who requires them. - -Submitting a Patch ------------------- - -We accept all kinds of patches, from documentation and CI/CD setup -to bug fixes, feature implementations and tests. Except for documentation -located in the ``gh-pages`` branch, others should be filed against -the development branch ``master``. These are hosted on GitHub and -one may create a local repository by running:: - - git clone https://github.com/McSinyx/palace - -While the patch can be submitted via email, it is preferable to file -a pull request on GitHub to allow more people to review it, since we do not -have any mail list. Either way, contributors must have legal permission -to distribute the code and it must be available under `LGPLv3+`_. Furthermore, -each contributor retains the copyrights of their patch, to ensure that -the licence can never be revoked even if others wants to. It is advisable -that the author list per legal name under the copyright header -of each source file they modify, like so:: - - Copyright (C) 2038 Foo Bar - -Using GitHub -^^^^^^^^^^^^ - -#. Create a fork_ of our repository on GitHub. -#. Checkout the source code and (optionally) add the ``upstream`` remote:: - - git clone https://github.com/YOUR_GITHUB_USERNAME/palace - cd palace - git remote add upstream https://github.com/McSinyx/palace - -#. Start working on your patch and make sure your code complies with - the `Style Guidelines`_ and passes the test suit run by tox_. -#. Add relevant tests to the patch and work on it until they all pass. - In case one is only modifying tests, perse may install palace using - ``CYTHON_TRACE=1 pip install .`` then run pytest_ directly to avoid - having to build the extension module multiple times. -#. Update the copyright notices of the files you modified. - Palace is collectively licensed under `LGPLv3+`_, - and to protect the freedom of the users, - copyright holders need to be properly documented. -#. Add_, commit_ with `a great message`_ then push_ the result. -#. Finally, `create a pull request`_. We will then review and merge it. - -It is recommended to create a new branch in your fork -(``git checkout -c what-you-are-working-on``) instead of working directly -on ``master``. This way one can still sync per fork with our ``master`` branch -and ``git pull --rebase upstream master`` to avoid integration issues. - -Via Email -^^^^^^^^^ - -#. Checkout the source code:: - - git clone https://github.com/McSinyx/palace - cd palace - -#. Work on your patch with tests and copyright notice included - as described above. -#. `git-format-patch`_ and send it to one of the maintainers - (our emails addresses are available under ``git log``). - We will then review and merge it. - -In any case, thank you very much for your contributions! - -Making a Release ----------------- - -While this is meant for developers doing a palace release, contributors wishing -to improve the CI/CD may find it helpful. - -#. Under the local repository, checkout the ``master`` branch - and sync with the one on GitHub using ``git pull``. -#. Bump the version in ``setup.cfg`` and push to GitHub. -#. Create a source distribution by running ``setup.py sdist``. - The distribution generated by this command is now referred to as ``sdist``. -#. Using twine_, upload the ``sdist`` to PyPI via ``twine upload $sdist``. -#. On GitHub, tag a new release with the ``sdist`` attached. - In the release note, make sure to include all user-facing changes - since the previous release. This will trigger the CD services - to build the wheels and publish them to PyPI. -#. Wait for the wheel for your platform to arrive to PyPI and install it. - Play around with it for a little to make sure that everything is OK. -#. Under the local repository, checkout the ``gh-pages`` branch. - Often, is it necessary to update the credits under the :doc:`copying` - section and review if the :doc:`reference/index` section needs any change - before running ``make html`` to rebuild to documentation. -#. View the documentation locally then push it to GitHub. - -Style Guidelines ----------------- - -Python and Cython -^^^^^^^^^^^^^^^^^ - -Generally, palace follows :pep:`8` and :pep:`257`, -with the following preferences and exceptions: - -* Hanging indentation is *always* preferred, - where continuation lines are indented by 4 spaces. -* Comments and one-line docstrings are limited to column 79 - instead of 72 like for multi-line docstrings. -* Cython extern declarations need not follow the 79-character limit. -* Break long lines before a binary operator. -* Use form feeds sparingly to break long modules - into pages of relating functions and classes. -* Prefer single-quoted strings over double-quoted strings, - unless the string contains single quote characters. -* Avoid trailing commas at all costs. -* Line breaks within comments and docstrings should not cut a phrase in half. -* Everything deserves a docstring. Palace follows numpydoc_ which support - documenting attributes as well as constants and module-level variables. - In additional to docstrings, type annotations should be employed - for all public names. -* Use numpydoc_ markups moderately to keep docstrings readable as plain text. - -C++ -^^^ - -C++ codes should follow GNU style, which is best documented at Octave_. - -reStructuredText -^^^^^^^^^^^^^^^^ - -In order for reStructuredText to be rendered correctly, the body of -constructs beginning with a marker (lists, hyperlink targets, comments, etc.) -must be aligned relative to the marker. For this reason, it is convenient -to set your editor indentation level to 3 spaces, since most constructs -starts with two dots and a space. However, be aware of that bullet items -require 2-space alignment and other exceptions. - -Limit all lines to a maximum of 79 characters. Similar to comments -and docstrings, phrases should not be broken in the middle. -The source code of this guide itself is a good example on how line breaks -should be handled. Additionally, two spaces should also be used -after a sentence-ending period in multi-sentence paragraph, -except after the final sentence. - -.. _GitHub: https://github.com/McSinyx/palace -.. _the mo the merier: - https://www.phrases.org.uk/meanings/the-more-the-merrier.html -.. _Issues: https://github.com/McSinyx/palace/issues -.. _LGPLv3+: https://www.gnu.org/licenses/lgpl-3.0.en.html -.. _fork: https://github.com/McSinyx/palace/fork -.. _tox: https://tox.readthedocs.io/en/latest/ -.. _pytest: https://docs.pytest.org/en/latest/ -.. _Add: https://git-scm.com/docs/git-add -.. _commit: https://git-scm.com/docs/git-commit -.. _a great message: https://chris.beams.io/posts/git-commit/#seven-rules -.. _push: https://git-scm.com/docs/git-push -.. _create a pull request: - https://help.github.com/articles/creating-a-pull-request -.. _git-format-patch: https://git-scm.com/docs/git-format-patch -.. _twine: https://twine.readthedocs.io/en/latest/ -.. _numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html -.. _Octave: https://wiki.octave.org/C%2B%2B_style_guide diff --git a/html/_sources/copying.rst.txt b/html/_sources/copying.rst.txt deleted file mode 100644 index 5e2b2cb..0000000 --- a/html/_sources/copying.rst.txt +++ /dev/null @@ -1,75 +0,0 @@ -Copying -======= - -This listing is our best-faith, hard-work effort at accurate attribution, -sources, and licenses for everything in palace. If you discover -an asset/contribution that is incorrectly attributed or licensed, -please contact us immediately. We are happy to do everything we can -to fix or remove the issue. - -License -------- - -Palace is free software: you can redistribute it and/or modify it -under the terms of the `GNU Lesser General Public License`_ -as published by the Free Software Foundation, either version 3 -of the License, or (at your option) any later version. - -To ensure that palace can run without any dependencies outside of the pip_ -toolchain, the wheels are bundled with dynamically linked libraries from -the build machine, which is similar to static linking: - -============== ============ -Library License -============== ============ -Alure_ ZLib -`OpenAL Soft`_ GNU LGPLv2+ -Vorbis_ 3-clause BSD -Opus_ 3-clause BSD -libsndfile_ GNU LGPL2.1+ -============== ============ - -In addition, the following sounds are used for testing: - -=============================================== ========= -Sound (located in ``tests/data``) License -=============================================== ========= -`164957__zonkmachine__white-noise.ogg`_ CC0 1.0 -`24741__tim-kahn__b23-c1-raw.aiff`_ CC BY 3.0 -`261590__kwahmah-02__little-glitch.flac`_ CC BY 3.0 -`353684__tec-studio__drip2.mp3`_ CC0 1.0 -`99642__jobro__deconvoluted-20hz-to-20khz.wav`_ CC BY 3.0 -=============================================== ========= - -Credits -------- - -Palace would never have seen the light of day without the help from -the developers of Alure_ and Cython_ who promptly gave detail answers -and made quick fixes to all of our problems. - -The wheels are build using cibuildwheel_, which made building extension modules -much less of a painful experience. `Travis CI`_ and AppVeyor_ kindly provides -their services free of charge for automated CI/CD. - -This documentation is generated using Sphinx_, whose maintainer responses -extreamly quickly to obsolete Cython-related issues. - -.. _GNU Lesser General Public License: - https://www.gnu.org/licenses/lgpl-3.0.en.html -.. _pip: https://pip.pypa.io/en/latest/ -.. _Alure: https://github.com/kcat/alure -.. _OpenAL Soft: https://kcat.strangesoft.net/openal.html -.. _Vorbis: https://xiph.org/vorbis/ -.. _Opus: https://opus-codec.org/ -.. _libsndfile: http://www.mega-nerd.com/libsndfile/ -.. _164957__zonkmachine__white-noise.ogg: https://freesound.org/s/164957/ -.. _24741__tim-kahn__b23-c1-raw.aiff: https://freesound.org/s/24741/ -.. _261590__kwahmah-02__little-glitch.flac: https://freesound.org/s/261590/ -.. _353684__tec-studio__drip2.mp3: https://freesound.org/s/353684/ -.. _99642__jobro__deconvoluted-20hz-to-20khz.wav: https://freesound.org/s/99642/ -.. _Cython: https://cython.org/ -.. _cibuildwheel: https://cibuildwheel.readthedocs.io/en/stable/ -.. _Sphinx: https://www.sphinx-doc.org/en/master/ -.. _Travis CI: https://travis-ci.com/ -.. _AppVeyor: https://www.appveyor.com/ diff --git a/html/_sources/design.rst.txt b/html/_sources/design.rst.txt deleted file mode 100644 index edfe07c..0000000 --- a/html/_sources/design.rst.txt +++ /dev/null @@ -1,185 +0,0 @@ -Design Principles -================= - -.. currentmodule:: palace - -In this section, we will discuss a few design principles in order to write -a safe, efficient, easy-to-use and extendable 3D audio library for Python, -by wrapping existing functionalities from the C++ API alure_. - -This part of the documentation assumes its reader are at least familiar with -Cython, Python and C++11. - -.. _impl-idiom: - -The Impl Idiom --------------- - -*Not to be confused with* `the pimpl idiom`_. - -For memory-safety, whenever possible, we rely on Cython for allocation and -deallocation of C++ objects. To do this, the nullary constructor needs to be -(re-)declared in Cython, e.g. - -.. code-block:: cython - - cdef extern from 'foobar.h' namespace 'foobar': - cdef cppclass Foo: - Foo() - float meth(size_t crack) except + - ... - -The Cython extension type can then be declared as follows - -.. code-block:: cython - - cdef class Bar: - cdef Foo impl - - def __init__(self, *args, **kwargs): - self.impl = ... - - @staticmethod - def from_baz(baz: Baz) -> Bar: - bar = Bar.__new__(Bar) - bar.impl = ... - return bar - - def meth(self, crack: int) -> float: - return self.impl.meth(crack) - -The Modern Python ------------------ - -One of the goal of palace is to create a Pythonic, i.e. intuitive and concise, -interface. To achieve this, we try to make use of some modern Python features, -which not only allow users to adopt palace with ease, but also make their -programs more readable and less error-prone. - -.. _getter-setter: - -Property Attributes -^^^^^^^^^^^^^^^^^^^ - -A large proportion of alure API are getters/setter methods. In Python, -it is a good practice to use property_ to abstract these calls, and thus make -the interface more natural with attribute-like referencing and assignments. - -Due to implementation details, Cython has to hijack the ``@property`` decorator -to make it work for read-write properties. Unfortunately, the Cython-generated -descriptors do not play very well with other builtin decorators, thus in some -cases, it is recommended to alias the call to ``property`` as follows - -.. code-block:: python - - getter = property - setter = lambda fset: property(fset=fset, doc=fset.__doc__) - -Then ``@getter`` and ``@setter`` can be used to decorate read-only and -write-only properties, respectively, without any trouble even if other -decorators are used for the same extension type method. - -Context Managers -^^^^^^^^^^^^^^^^ - -The alure API defines many objects that need manual tear-down in -a particular order. Instead of trying to be clever and perform automatic -clean-ups at garbage collection, we should put the user in control. -To quote *The Zen of Python*, - - | If the implementation is hard to explain, it's a bad idea. - | If the implementation is easy to explain, it may be a good idea. - -With that being said, it does not mean we do not provide any level of -abstraction. A simplified case in point would be - -.. code-block:: cython - - cdef class Device: - cdef alure.Device impl - - def __init__(self, name: str = '') -> None: - self.impl = devmgr.open_playback(name) - - def __enter__(self) -> Device: - return self - - def __exit__(self, *exc) -> Optional[bool]: - self.close() - - def close(self) -> None: - self.impl.close() - -Now if the ``with`` statement is used, it will make sure the device -will be closed, regardless of whatever may happen within the inner block - -.. code-block:: python - - with Device() as dev: - ... - -as it is equivalent to - -.. code-block:: python - - dev = Device() - try: - ... - finally: - dev.close() - -Other than closure/destruction of objects, typical uses of `context managers`__ -also include saving and restoring various kinds of global state (as seen in -:py:class:`Context`), locking and unlocking resources, etc. - -__ https://docs.python.org/3/reference/datamodel.html#context-managers - -The Double Reference --------------------- - -While wrapping C++ interfaces, :ref:`the impl idiom ` might not -be adequate, since the derived Python methods need to be callable from C++. -Luckily, Cython can handle Python objects within C++ classes just fine, -although we'll need to handle the reference count ourselves, e.g. - -.. code-block:: cython - - cdef cppclass CppDecoder(alure.BaseDecoder): - Decoder pyo - - __init__(Decoder decoder): - this.pyo = decoder - Py_INCREF(pyo) - - __dealloc__(): - Py_DECREF(pyo) - - bool seek(uint64_t pos): - return pyo.seek(pos) - -With this being done, we can now write the wrapper as simply as - -.. code-block:: cython - - cdef class BaseDecoder: - cdef shared_ptr[alure.Decoder] pimpl - - def __cinit__(self, *args, **kwargs) -> None: - self.pimpl = shared_ptr[alure.Decoder](new CppDecoder(self)) - - def seek(pos: int) -> bool: - ... - -Because ``__cinit__`` is called by ``__new__``, any Python class derived -from ``BaseDecoder`` will be exposed to C++ as an attribute of ``CppDecoder``. -Effectively, this means the users can have the alure API calling their -inherited Python object as naturally as if palace is implemented in pure Python. - -In practice, :py:class:`BaseDecoder` will also need to take into account -other guarding mechanisms like :py:class:`abc.ABC`. Due to Cython limitations, -implementation as a pure Python class and :ref:`aliasing ` of -``@getter``/``@setter`` should be considered. - -.. _alure: https://github.com/kcat/alure -.. _`the pimpl idiom`: https://wiki.c2.com/?PimplIdiom -.. _property: https://docs.python.org/3/library/functions.html#property diff --git a/html/_sources/index.rst.txt b/html/_sources/index.rst.txt deleted file mode 100644 index 1fce2ba..0000000 --- a/html/_sources/index.rst.txt +++ /dev/null @@ -1,38 +0,0 @@ -Overview -======== - -Pythonic Audio Library and Codecs Environment provides common higher-level API -for audio rendering using OpenAL: - -* 3D positional rendering, with HRTF_ support for stereo systems -* Environmental effects: reverb, atmospheric air absorption, - sound occlusion and obstruction -* Out-of-the-box codec support: FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc. - -Palace wraps around the C++ interface alure_ using Cython_ for a safe and -convenient interface with type hinting, data descriptors and context managers, -following :pep:`8#naming-conventions` (``PascalCase.snake_case``). - -Table of Contents ------------------ - -.. toctree:: - :maxdepth: 2 - - installation - tutorial/index - reference/index - design - contributing - copying - -Indices and Tables ------------------- - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. _HRTF: https://en.wikipedia.org/wiki/Head-related_transfer_function -.. _alure: https://github.com/kcat/alure -.. _Cython: https://cython.org diff --git a/html/_sources/installation.rst.txt b/html/_sources/installation.rst.txt deleted file mode 100644 index 95819b7..0000000 --- a/html/_sources/installation.rst.txt +++ /dev/null @@ -1,37 +0,0 @@ -Installation -============ - -Prerequisites -------------- - -Palace requires CPython_ version 3.6 or above for runtime -and pip_ for installation. - -Via PyPI --------- - -Palace can be installed from PyPI:: - - pip install palace - -Wheel distributions are built exclusively for amd64. Currently, only GNU/Linux -and macOS are properly supported. If you want to help packaging for Windows, -please see `GH-1`_ on our issues tracker on GitHub. - -From source ------------ - -Aside from the build dependencies listed in ``pyproject.toml``, -one will additionally need compatible Python headers, alure_, -a C++14 compiler, CMake_ 2.6+ (and probably git_ for fetching the source). -Palace can then be compiled and installed by running:: - - git clone https://github.com/McSinyx/palace.git - pip install palace/ - -.. _CPython: https://www.python.org/ -.. _pip: https://pip.pypa.io/en/latest/ -.. _GH-1: https://github.com/McSinyx/palace/issues/1 -.. _alure: https://github.com/kcat/alure -.. _CMake: https://cmake.org/ -.. _git: https://git-scm.com/ diff --git a/html/_sources/reference/buffer.rst.txt b/html/_sources/reference/buffer.rst.txt deleted file mode 100644 index 52af757..0000000 --- a/html/_sources/reference/buffer.rst.txt +++ /dev/null @@ -1,17 +0,0 @@ -Resource Caching -================ - -.. currentmodule:: palace - -Audio Buffers -------------- - -.. autoclass:: Buffer - :members: - -Loading & Freeing in Batch --------------------------- - -.. autofunction:: cache - -.. autofunction:: free diff --git a/html/_sources/reference/context.rst.txt b/html/_sources/reference/context.rst.txt deleted file mode 100644 index 257de29..0000000 --- a/html/_sources/reference/context.rst.txt +++ /dev/null @@ -1,83 +0,0 @@ -Audio Library Contexts -====================== - -.. currentmodule:: palace - -Context and Auxiliary Classes ------------------------------ - -.. autoclass:: Context - :members: - -.. autoclass:: Listener - :members: - -.. autoclass:: MessageHandler - :members: - -Using Contexts --------------- - -.. autofunction:: use_context - -.. autofunction:: current_context - -.. autofunction:: thread_local - -Context Creation Attributes ---------------------------- - -.. data:: CHANNEL_CONFIG - :type: int - - Context creation key to specify the channel configuration - (either ``MONO``, ``STEREO``, ``QUAD``, ``X51``, ``X61`` or ``X71``). - -.. data:: SAMPLE_TYPE - :type: int - - Context creation key to specify the sample type - (either ``[UNSIGNED_]{BYTE,SHORT,INT}`` or ``FLOAT``). - -.. data:: FREQUENCY - :type: int - - Context creation key to specify the frequency in hertz. - -.. data:: MONO_SOURCES - :type: int - - Context creation key to specify the number of mono (3D) sources. - -.. data:: STEREO_SOURCES - :type: int - - Context creation key to specify the number of stereo sources. - -.. data:: MAX_AUXILIARY_SENDS - :type: int - - Context creation key to specify the maximum number of - auxiliary source sends. - -.. data:: HRTF - :type: int - - Context creation key to specify whether to enable HRTF - (either ``FALSE``, ``TRUE`` or ``DONT_CARE``). - -.. data:: HRTF_ID - :type: int - - Context creation key to specify the HRTF to be used. - -.. data:: OUTPUT_LIMITER - :type: int - - Context creation key to specify whether to use a gain limiter - (either ``FALSE``, ``TRUE`` or ``DONT_CARE``). - -.. data:: distance_models - :type: Tuple[str, ...] - - Names of available distance models. diff --git a/html/_sources/reference/decoder.rst.txt b/html/_sources/reference/decoder.rst.txt deleted file mode 100644 index 9671631..0000000 --- a/html/_sources/reference/decoder.rst.txt +++ /dev/null @@ -1,44 +0,0 @@ -Audio Streams -============= - -.. currentmodule:: palace - -Builtin Decoders ----------------- - -.. autoclass:: Decoder - :members: - -Decoder Interface ------------------ - -.. data:: decoder_factories - :type: DecoderNamespace - - Simple object for storing decoder factories. - - User-registered factories are tried one after another - if :py:exc:`RuntimeError` is raised, in lexicographical order. - Internal decoder factories are always used after registered ones. - -.. autofunction:: decode - -.. autoclass:: BaseDecoder - :members: - -Miscellaneous -------------- - -.. data:: sample_types - :type: Tuple[str, ...] - - Names of available sample types. - -.. data:: channel_configs - :type: Tuple[str, ...] - - Names of available channel configurations. - -.. autofunction:: sample_size - -.. autofunction:: sample_length diff --git a/html/_sources/reference/device.rst.txt b/html/_sources/reference/device.rst.txt deleted file mode 100644 index 742c87b..0000000 --- a/html/_sources/reference/device.rst.txt +++ /dev/null @@ -1,21 +0,0 @@ -Audio Devices -============= - -.. currentmodule:: palace - -Device-Dependent Utilities --------------------------- - -.. autoclass:: Device - :members: - -Device-Independent Utilities ----------------------------- - -.. data:: device_names - :type: DeviceNames - - Read-only namespace of device names by category (``basic``, ``full`` and - ``capture``), as tuples of strings whose first item being the default. - -.. autofunction:: query_extension diff --git a/html/_sources/reference/effect.rst.txt b/html/_sources/reference/effect.rst.txt deleted file mode 100644 index e625097..0000000 --- a/html/_sources/reference/effect.rst.txt +++ /dev/null @@ -1,34 +0,0 @@ -Environmental Effects -===================== - -.. currentmodule:: palace - -For the sake of brevity, we only document the constraints of each effect's -properties. Further details can be found at OpenAL's `Effect Extension Guide`_ -which specifies the purpose and usage of each value. - -Base Effect ------------ - -.. autoclass:: BaseEffect - :members: - -Chorus Effect -------------- - -.. autoclass:: ChorusEffect - :members: - -Reverb Effect -------------- - -.. data:: reverb_preset_names - :type: Tuple[str, ...] - - Names of predefined reverb effect presets in lexicographical order. - -.. autoclass:: ReverbEffect - :members: - -.. _Effect Extension Guide: - https://kcat.strangesoft.net/misc-downloads/Effects%20Extension%20Guide.pdf diff --git a/html/_sources/reference/file-io.rst.txt b/html/_sources/reference/file-io.rst.txt deleted file mode 100644 index 3070465..0000000 --- a/html/_sources/reference/file-io.rst.txt +++ /dev/null @@ -1,11 +0,0 @@ -File I/O Interface -================== - -.. currentmodule:: palace - -.. autofunction:: current_fileio - -.. autofunction:: use_fileio - -.. autoclass:: FileIO - :members: diff --git a/html/_sources/reference/index.rst.txt b/html/_sources/reference/index.rst.txt deleted file mode 100644 index 849c40a..0000000 --- a/html/_sources/reference/index.rst.txt +++ /dev/null @@ -1,14 +0,0 @@ -Reference -========= - -API reference is divided into the following sections: - -.. toctree:: - - device - context - buffer - source - effect - decoder - file-io diff --git a/html/_sources/reference/source.rst.txt b/html/_sources/reference/source.rst.txt deleted file mode 100644 index 398920c..0000000 --- a/html/_sources/reference/source.rst.txt +++ /dev/null @@ -1,16 +0,0 @@ -Sources & Source Groups -======================= - -.. currentmodule:: palace - -Sources -------- - -.. autoclass:: Source - :members: - -Source Groups -------------- - -.. autoclass:: SourceGroup - :members: diff --git a/html/_sources/tutorial/context.rst.txt b/html/_sources/tutorial/context.rst.txt deleted file mode 100644 index 678fef3..0000000 --- a/html/_sources/tutorial/context.rst.txt +++ /dev/null @@ -1,41 +0,0 @@ -Context Creation -================ - -.. currentmodule:: palace - -A context is an object that allows palace to access OpenAL, -which is essential when you work with palace. Context maintains -the audio environment and contains environment settings and components -such as sources, buffers, and effects. - -Creating a Device Object ------------------------- - -To create a context, we must first create a device, -since it's a parameter of the context object. - -To create an object, well, you just have to instantiate -the :py:class:`Device` class. - -.. code-block:: python - - from palace import Device - - with Device() as dev: - # Your code goes here - -This is how you declare a :py:class:`Device` object with the default device. -There can be several devices available, which can be found -in :py:data:`device_names`. - -Creating a Context ------------------- - -Now that we've created a device, we can create the context: - -.. code-block:: python - - from palace import Device, Context - - with Device() as dev, Context(dev) as ctx: - # Your code goes here diff --git a/html/_sources/tutorial/index.rst.txt b/html/_sources/tutorial/index.rst.txt deleted file mode 100644 index 05a4da6..0000000 --- a/html/_sources/tutorial/index.rst.txt +++ /dev/null @@ -1,15 +0,0 @@ -Tutorial -======== - -This tutorial will guide you on: - -.. toctree:: - :maxdepth: 2 - - context - play-audio - source -.. comment these to add later - Adding effects - Customize decoder - Generate sounds diff --git a/html/_sources/tutorial/play-audio.rst.txt b/html/_sources/tutorial/play-audio.rst.txt deleted file mode 100644 index 337cc09..0000000 --- a/html/_sources/tutorial/play-audio.rst.txt +++ /dev/null @@ -1,101 +0,0 @@ -Play an Audio -============= - -.. currentmodule:: palace - -Now that you know how to create a context, -let's get into the most essential use case: playing audio. - -Creating a Source ------------------ - -To play an audio, you have to create a source. This source -is an imaginary sound broadcaster, whose positions and properties -can be changed to create desired effects. - -.. code-block:: python - - from palace import Device, Context, Source - - with Device() as dev, Context(dev) as ctx: - with Source() as src: - # to be written - -Just like for the case of :py:class:`Context`, :py:class:`Source` creation -requires a context, but here the context is passed implicitly. - -Decode the Audio File ---------------------- - -Palace has a module level function :py:func:`decode`, which decodes audio file -automatically, and this decoded file is a :py:class:`Decoder` object. This object -can be played by a simple :py:meth:`Decoder.play` method. - -.. code-block:: python - - from palace import Device, Context, Source, decode - - filename = 'some_audio.ogg' - with Device() as dev, Context(dev) as ctx: - with Source() as src: - dec = decode(filename) - -We are almost there. Now, let's look at the document for :py:meth:`Decoder.play`. -The method takes 3 parameters: ``chunk_len``, ``queue_size``, and ``source``. - -The source object is optional, because if you don't have it, a new source -will be generated by default. - -The audio is divided into chunks, each of which is of length ``chunk_len``. -Then ``queue_size`` is the number of these chunks that it will play. - -.. TODO: I think it's better to include a diagram here. Add later - -.. code-block:: python - - from palace import Device, Context, Source, decode - - filename = 'some_audio.ogg' - with Device() as dev, Context(dev) as ctx: - with Source() as src: - dec = decode(filename) - dec.play(12000, 4, src) - -But we don't want it to play only a small part of the audio. We want it to -play all of it. How do we do that? The answer is a loop. - -There is a method, :py:meth:`Context.update`, which update the context and the source. -When the source is updated, it will be filled with new chunks of data from -the decoder. - -.. code-block:: python - - from palace import Device, Context, Source, decode - - filename = 'some_audio.ogg' - with Device() as dev, Context(dev) as ctx: - with Source() as src: - dec = decode(filename) - dec.play(12000, 4, src) - while src.playing: - ctx.update() - -If you tried this code for a song, you will find that it's a bit rush. -That is because the source is renewed too fast. So, a simple solution -is to ``sleep`` for a while. - -.. code-block:: python - - from time import sleep - from palace import Device, Context, Source, decode - - filename = 'some_audio.ogg' - with Device() as dev, Context(dev) as ctx: - with Source() as src: - dec = decode(filename) - dec.play(12000, 4, src) - while src.playing: - sleep(0.025) - ctx.update() - -Congratulation! Enjoy your music before we get to the next part of this tutorial. diff --git a/html/_sources/tutorial/source.rst.txt b/html/_sources/tutorial/source.rst.txt deleted file mode 100644 index f4e8c1c..0000000 --- a/html/_sources/tutorial/source.rst.txt +++ /dev/null @@ -1,82 +0,0 @@ -Source Manipulation -=================== - -.. currentmodule:: palace - -We have created a source in the last section. -As said previously, its properties can be manipulated to create wanted effects. - -Moving the Source ------------------ - -Changing :py:attr:`Source.position` is one of the most noticeable, -but first, we have to enable spatialization via :py:attr:`Source.spatialize`. - -.. code-block:: python - - from time import sleep - from palace import Device, Context, Source, decode - - with Device() as device, Context(device) as context, Source() as source: - source.spatialize = True - decoder = decode('some_audio.ogg') - decoder.play(12000, 4, source) - while source.playing: - sleep(0.025) - context.update() - -Now, we can set the position of the source in this virtual 3D space. -The position is a 3-tuple indicating the coordinate of the source. -The axes are aligned according to the normal coordinate system: - -- The x-axis goes from left to right -- The y-axis goes from below to above -- The z-axis goes from front to back - -For example, this will set the source above the listener:: - - src.position = 0, 1, 0 - -.. note:: - - For this too work for stereo, you have to have HRTF enabled. - You can check that via :py:attr:`Device.current_hrtf`. - -You can as well use a function to move the source automatically by writing -a function that generate positions. A simple example is circular motion. - -.. code-block:: python - - from itertools import takewhile, count - ... - for i in takewhile(src.playing, count(step=0.025)): - source.position = sin(i), 0, cos(-i) - ... - -A more well-written example of this can be found `in our repository`_. - -Speed and Pitch ---------------- - -Modifying :py:attr:`pitch` changes the playing speed, effectively changing -pitch. Pitch can be any positive number. - -.. code-block:: python - - src.pitch = 2 # high pitch - src.pitch = 0.4 # low pitch - -Air Absorption Factor ---------------------- - -:py:attr:`Source.air_absorption_factor` simulates atmospheric high-frequency -air absorption. Higher values simulate foggy air and lower values simulate -drier air. - -.. code-block:: python - - src.air_absorption_factor = 9 # very high humidity - src.air_absorption_factor = 0 # dry air (default) - -.. _in our repository: - https://github.com/McSinyx/palace/blob/master/examples/palace-hrtf.py diff --git a/html/_static/alabaster.css b/html/_static/alabaster.css deleted file mode 100644 index 4c500fb..0000000 --- a/html/_static/alabaster.css +++ /dev/null @@ -1,707 +0,0 @@ -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Georgia, serif; - font-size: 17px; - background-color: #fff; - color: #000; - margin: 0; - padding: 0; -} - - -div.document { - width: 940px; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 220px; -} - -div.sphinxsidebar { - width: 220px; - font-size: 14px; - line-height: 1.5; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #fff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -div.body > .section { - text-align: left; -} - -div.footer { - width: 940px; - margin: 20px auto 30px auto; - font-size: 14px; - color: #888; - text-align: right; -} - -div.footer a { - color: #888; -} - -p.caption { - font-family: inherit; - font-size: inherit; -} - - -div.relations { - display: none; -} - - -div.sphinxsidebar a { - color: #444; - text-decoration: none; - border-bottom: 1px dotted #999; -} - -div.sphinxsidebar a:hover { - border-bottom: 1px solid #999; -} - -div.sphinxsidebarwrapper { - padding: 18px 10px; -} - -div.sphinxsidebarwrapper p.logo { - padding: 0; - margin: -10px 0 0 0px; - text-align: center; -} - -div.sphinxsidebarwrapper h1.logo { - margin-top: -10px; - text-align: center; - margin-bottom: 5px; - text-align: left; -} - -div.sphinxsidebarwrapper h1.logo-name { - margin-top: 0px; -} - -div.sphinxsidebarwrapper p.blurb { - margin-top: 0; - font-style: normal; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Georgia, serif; - color: #444; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 20px; -} - -div.sphinxsidebar h3 a { - color: #444; -} - -div.sphinxsidebar p.logo a, -div.sphinxsidebar h3 a, -div.sphinxsidebar p.logo a:hover, -div.sphinxsidebar h3 a:hover { - border: none; -} - -div.sphinxsidebar p { - color: #555; - margin: 10px 0; -} - -div.sphinxsidebar ul { - margin: 10px 0; - padding: 0; - color: #000; -} - -div.sphinxsidebar ul li.toctree-l1 > a { - font-size: 120%; -} - -div.sphinxsidebar ul li.toctree-l2 > a { - font-size: 110%; -} - -div.sphinxsidebar input { - border: 1px solid #CCC; - font-family: Georgia, serif; - font-size: 1em; -} - -div.sphinxsidebar hr { - border: none; - height: 1px; - color: #AAA; - background: #AAA; - - text-align: left; - margin-left: 0; - width: 50%; -} - -div.sphinxsidebar .badge { - border-bottom: none; -} - -div.sphinxsidebar .badge:hover { - border-bottom: none; -} - -/* To address an issue with donation coming after search */ -div.sphinxsidebar h3.donation { - margin-top: 10px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #004B6B; - text-decoration: underline; -} - -a:hover { - color: #6D4100; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Georgia, serif; - font-weight: normal; - margin: 30px 0px 10px 0px; - padding: 0; -} - -div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 150%; } -div.body h4 { font-size: 130%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #DDD; - padding: 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - color: #444; - background: #EAEAEA; -} - -div.body p, div.body dd, div.body li { - line-height: 1.4em; -} - -div.admonition { - margin: 20px 0px; - padding: 10px 30px; - background-color: #EEE; - border: 1px solid #CCC; -} - -div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fafafa; -} - -div.admonition p.admonition-title { - font-family: Georgia, serif; - font-weight: normal; - font-size: 24px; - margin: 0 0 10px 0; - padding: 0; - line-height: 1; -} - -div.admonition p.last { - margin-bottom: 0; -} - -div.highlight { - background-color: #fff; -} - -dt:target, .highlight { - background: #FAF3E8; -} - -div.warning { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.danger { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.error { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.caution { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.attention { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.important { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.note { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.tip { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.hint { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.seealso { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.topic { - background-color: #EEE; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre, tt, code { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.9em; -} - -.hll { - background-color: #FFC; - margin: 0 -12px; - padding: 0 12px; - display: block; -} - -img.screenshot { -} - -tt.descname, tt.descclassname, code.descname, code.descclassname { - font-size: 0.95em; -} - -tt.descname, code.descname { - padding-right: 0.08em; -} - -img.screenshot { - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils { - border: 1px solid #888; - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils td, table.docutils th { - border: 1px solid #888; - padding: 0.25em 0.7em; -} - -table.field-list, table.footnote { - border: none; - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - -table.footnote { - margin: 15px 0; - width: 100%; - border: 1px solid #EEE; - background: #FDFDFD; - font-size: 0.9em; -} - -table.footnote + table.footnote { - margin-top: -15px; - border-top: none; -} - -table.field-list th { - padding: 0 0.8em 0 0; -} - -table.field-list td { - padding: 0; -} - -table.field-list p { - margin-bottom: 0.8em; -} - -/* Cloned from - * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 - */ -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -table.footnote td.label { - width: .1px; - padding: 0.3em 0 0.3em 0.5em; -} - -table.footnote td { - padding: 0.3em 0.5em; -} - -dl { - margin: 0; - padding: 0; -} - -dl dd { - margin-left: 30px; -} - -blockquote { - margin: 0 0 0 30px; - padding: 0; -} - -ul, ol { - /* Matches the 30px from the narrow-screen "li > ul" selector below */ - margin: 10px 0 10px 30px; - padding: 0; -} - -pre { - background: #EEE; - padding: 7px 30px; - margin: 15px 0px; - line-height: 1.3em; -} - -div.viewcode-block:target { - background: #ffd; -} - -dl pre, blockquote pre, li pre { - margin-left: 0; - padding-left: 30px; -} - -tt, code { - background-color: #ecf0f3; - color: #222; - /* padding: 1px 2px; */ -} - -tt.xref, code.xref, a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fff; -} - -a.reference { - text-decoration: none; - border-bottom: 1px dotted #004B6B; -} - -/* Don't put an underline on images */ -a.image-reference, a.image-reference:hover { - border-bottom: none; -} - -a.reference:hover { - border-bottom: 1px solid #6D4100; -} - -a.footnote-reference { - text-decoration: none; - font-size: 0.7em; - vertical-align: top; - border-bottom: 1px dotted #004B6B; -} - -a.footnote-reference:hover { - border-bottom: 1px solid #6D4100; -} - -a:hover tt, a:hover code { - background: #EEE; -} - - -@media screen and (max-width: 870px) { - - div.sphinxsidebar { - display: none; - } - - div.document { - width: 100%; - - } - - div.documentwrapper { - margin-left: 0; - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - } - - div.bodywrapper { - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - margin-left: 0; - } - - ul { - margin-left: 0; - } - - li > ul { - /* Matches the 30px from the "ul, ol" selector above */ - margin-left: 30px; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .bodywrapper { - margin: 0; - } - - .footer { - width: auto; - } - - .github { - display: none; - } - - - -} - - - -@media screen and (max-width: 875px) { - - body { - margin: 0; - padding: 20px 30px; - } - - div.documentwrapper { - float: none; - background: #fff; - } - - div.sphinxsidebar { - display: block; - float: none; - width: 102.5%; - margin: -20px -30px 20px -30px; - padding: 10px 20px; - background: #333; - color: #FFF; - } - - div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, - div.sphinxsidebar h3 a { - color: #fff; - } - - div.sphinxsidebar a { - color: #AAA; - } - - div.sphinxsidebar p.logo { - display: none; - } - - div.document { - width: 100%; - margin: 0; - } - - div.footer { - display: none; - } - - div.bodywrapper { - margin: 0; - } - - div.body { - min-height: 0; - padding: 0; - } - - .rtd_doc_footer { - display: none; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .footer { - width: auto; - } - - .github { - display: none; - } -} -@media screen and (min-width: 876px) { - div.sphinxsidebar { - position: fixed; - margin-left: 0; - } -} - - -/* misc. */ - -.revsys-inline { - display: none!important; -} - -/* Make nested-list/multi-paragraph items look better in Releases changelog - * pages. Without this, docutils' magical list fuckery causes inconsistent - * formatting between different release sub-lists. - */ -div#changelog > div.section > ul > li > p:only-child { - margin-bottom: 0; -} - -/* Hide fugly table cell borders in ..bibliography:: directive output */ -table.docutils.citation, table.docutils.citation td, table.docutils.citation th { - border: none; - /* Below needed in some edge cases; if not applied, bottom shadows appear */ - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - - -/* relbar */ - -.related { - line-height: 30px; - width: 100%; - font-size: 0.9rem; -} - -.related.top { - border-bottom: 1px solid #EEE; - margin-bottom: 20px; -} - -.related.bottom { - border-top: 1px solid #EEE; -} - -.related ul { - padding: 0; - margin: 0; - list-style: none; -} - -.related li { - display: inline; -} - -nav#rellinks { - float: right; -} - -nav#rellinks li+li:before { - content: "|"; -} - -nav#breadcrumbs li+li:before { - content: "\00BB"; -} - -/* Hide certain items when printing */ -@media print { - div.related { - display: none; - } -} \ No newline at end of file diff --git a/html/_static/basic.css b/html/_static/basic.css deleted file mode 100644 index 24bc73e..0000000 --- a/html/_static/basic.css +++ /dev/null @@ -1,855 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li div.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 450px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -dl.footnote > dt, -dl.citation > dt { - float: left; - margin-right: 0.5em; -} - -dl.footnote > dd, -dl.citation > dd { - margin-bottom: 0em; -} - -dl.footnote > dd:after, -dl.citation > dd:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dt:after { - content: ":"; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0.5em; - content: ":"; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.descname { - background-color: transparent; - font-weight: bold; - font-size: 1.2em; -} - -code.descclassname { - background-color: transparent; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/html/_static/custom.css b/html/_static/custom.css deleted file mode 100644 index 2a924f1..0000000 --- a/html/_static/custom.css +++ /dev/null @@ -1 +0,0 @@ -/* This file intentionally left blank. */ diff --git a/html/_static/doctools.js b/html/_static/doctools.js deleted file mode 100644 index daccd20..0000000 --- a/html/_static/doctools.js +++ /dev/null @@ -1,315 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * 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 - */ -jQuery.urldecode = function(x) { - return decodeURIComponent(x).replace(/\+/g, ' '); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * 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; -}; - -/** - * 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( - 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}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - 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; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return 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; - }, - - /** - * 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); - }); - }, - - /** - * 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); - }, - - /** - * 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); - $('

' + _('Hide Search Matches') + '

') - .appendTo($('#searchbox')); - } - }, - - /** - * 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(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - 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); - }, - - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && !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; - } - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/html/_static/documentation_options.js b/html/_static/documentation_options.js deleted file mode 100644 index 569b91a..0000000 --- a/html/_static/documentation_options.js +++ /dev/null @@ -1,12 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.2.1', - LANGUAGE: 'None', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file diff --git a/html/_static/file.png b/html/_static/file.png deleted file mode 100644 index a858a410e4faa62ce324d814e4b816fff83a6fb3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( diff --git a/html/_static/jquery-3.4.1.js b/html/_static/jquery-3.4.1.js deleted file mode 100644 index 773ad95..0000000 --- a/html/_static/jquery-3.4.1.js +++ /dev/null @@ -1,10598 +0,0 @@ -/*! - * jQuery JavaScript Library v3.4.1 - * https://jquery.com/ - * - * Includes Sizzle.js - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://jquery.org/license - * - * Date: 2019-05-01T21:04Z - */ -( 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 document = window.document; - -var getProto = Object.getPrototypeOf; - -var slice = arr.slice; - -var concat = arr.concat; - -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. - return typeof obj === "function" && typeof obj.nodeType !== "number"; - }; - - -var isWindow = function isWindow( obj ) { - return obj != null && obj === obj.window; - }; - - - - - 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.4.1", - - // 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 ); - }, - - // Support: Android <=4.0 only - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g; - -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 ); - }, - - 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 global context - globalEval: function( code, options ) { - DOMEval( code, { nonce: options && options.nonce } ); - }, - - 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; - }, - - // Support: Android <=4.0 only - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - - // 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 concat.apply( [], 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.4 - * https://sizzlejs.com/ - * - * Copyright JS Foundation and other contributors - * Released under the MIT license - * https://js.foundation/ - * - * Date: 2019-04-08 - */ -(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, - push_native = 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]", - - // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", - - // 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-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : - high < 0 ? - // BMP codepoint - String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) - 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 - arr[ preferredDoc.childNodes.length ].nodeType; -} catch ( e ) { - push = { apply: arr.length ? - - // Leverage slice if possible - function( target, els ) { - push_native.apply( target, slice.call(els) ); - } : - - // Support: IE<9 - // Otherwise append directly - function( target, els ) { - var j = target.length, - i = 0; - // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} - target.length = j - 1; - } - }; -} - -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 ) { - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - 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. - // Thanks to Andrew Dupont for this technique. - if ( nodeType === 1 && rdescend.test( selector ) ) { - - // 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 + " " + toSelector( groups[i] ); - } - newSelector = groups.join( "," ); - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; - } - - 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.namespaceURI, - docElem = (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 - 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 - // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - 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 ); - } - } - - /* 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 ) { - // 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("~="); - } - - // 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(".#.+[+~]"); - } - }); - - 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" ); - } - - // 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 - 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 - if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { - return -1; - } - 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 ) { - return a === document ? -1 : - b === document ? 1 : - 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 - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : - 0; - }; - - return document; -}; - -Sizzle.matches = function( expr, elements ) { - return Sizzle( expr, null, null, elements ); -}; - -Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - 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 - if ( ( context.ownerDocument || context ) !== document ) { - setDocument( context ); - } - return contains( context, elem ); -}; - -Sizzle.attr = function( elem, name ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - var fn = Expr.attrHandle[ name.toLowerCase() ], - // 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 += ""; - - 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; - }; - }, - - "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 ) { - 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 ) { - 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; - 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 ( typeof elem.contentDocument !== "undefined" ) { - 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 master Deferred - master = 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 ) ) { - master.resolveWith( resolveContexts, resolveValues ); - } - }; - }; - - // Single- and empty arguments are adopted like Promise.resolve - if ( remaining <= 1 ) { - adoptValue( singleValue, master.done( updateFunc( i ) ).resolve, master.reject, - !remaining ); - - // Use .then() to unwrap secondary thenables (cf. gh-3000) - if ( master.state() === "pending" || - isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { - - return master.then(); - } - } - - // Multiple arguments are aggregated like Promise.all array elements - while ( i-- ) { - adoptValue( resolveValues[ i ], updateFunc( i ), master.reject ); - } - - return master.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"; - }; - -var swap = function( elem, options, callback, args ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.apply( elem, args || [] ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - - - -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 ); - - - -// We have to close these tags to support XHTML (#13200) -var wrapMap = { - - // Support: IE <=9 only - option: [ 1, "" ], - - // 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, "", "" ] -}; - -// Support: IE <=9 only -wrapMap.optgroup = wrapMap.option; - -wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; -wrapMap.th = wrapMap.td; - - -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; -} - - -( 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; -} )(); - - -var - rkeyEvent = /^key/, - rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, - 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 ); - - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { - return; - } - - // Caller can pass in an object of custom data in lieu of the handler - if ( handler.handler ) { - handleObjIn = handler; - handler = handleObjIn.handler; - selector = handleObjIn.selector; - } - - // 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 = {}; - } - 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 ) { - - // Make a writable jQuery.Event from the native event object - var event = jQuery.event.fix( nativeEvent ); - - var i, j, ret, matched, handleObj, handlerQueue, - args = new Array( arguments.length ), - handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], - special = jQuery.event.special[ event.type ] || {}; - - // Use the fix-ed jQuery.Event rather than the (read-only) native event - args[ 0 ] = event; - - 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(); - return 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: function( event ) { - var button = event.button; - - // Add which for key events - if ( event.which == null && rkeyEvent.test( event.type ) ) { - return event.charCode != null ? event.charCode : event.keyCode; - } - - // Add which for click: 1 === left; 2 === middle; 3 === right - if ( !event.which && button !== undefined && rmouseEvent.test( event.type ) ) { - if ( button & 1 ) { - return 1; - } - - if ( button & 2 ) { - return 3; - } - - if ( button & 4 ) { - return 2; - } - - return 0; - } - - return event.which; - } -}, 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; - }, - - 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 - - /* eslint-disable max-len */ - - // See https://github.com/eslint/eslint/issues/3229 - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, - - /* eslint-enable */ - - // 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, pdataCur, udataOld, udataCur, events; - - if ( dest.nodeType !== 1 ) { - return; - } - - // 1. Copy private data: events, handlers, etc. - if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.access( src ); - pdataCur = dataPriv.set( dest, pdataOld ); - events = pdataOld.events; - - if ( events ) { - delete pdataCur.handle; - pdataCur.events = {}; - - for ( type in events ) { - for ( i = 0, l = events[ type ].length; i < l; i++ ) { - jQuery.event.add( dest, type, events[ type ][ i ] ); - } - } - } - } - - // 2. Copy user data - if ( 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 = concat.apply( [], 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" ) - } ); - } - } 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.replace( rxhtmlTag, "<$1>" ); - }, - - 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 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, - 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; - } - } ); -} )(); - - -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"; - } - - - // Fall back to offsetWidth/offsetHeight when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - // Support: Android <=4.1 - 4.3 only - // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) - // Support: IE 9-11 only - // Also use offsetWidth/offsetHeight for when box sizing is unreliable - // We use getClientRects() to check for hidden/disconnected. - // In those cases, the computed value can be trusted to be border-box - if ( ( !support.boxSizingReliable() && isBorderBox || - val === "auto" || - !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && - 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 && type !== false ) { - 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" ) || {} )[ 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() { - var doc = this.ownerDocument || 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, - 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 = Date.now(); - -var rquery = ( /\?/ ); - - - -// Cross-browser xml parsing -jQuery.parseXML = function( data ) { - var xml; - 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 ) { - xml = undefined; - } - - if ( !xml || xml.getElementsByTagName( "parsererror" ).length ) { - jQuery.error( "Invalid XML: " + 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++ ) + 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 ); - } - - // 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._evalUrl = function( url, options ) { - 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 ); - } - } ); -}; - - -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( " - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Getting Involved

-
-

Note

-

The development of palace is carried out on GitHub. -Since GitHub is not free software, we fully understand -if one does not want to register an account just to participate -in our development. Therefore, we also welcome patches -and bug reports sent via email.

-
-

First of all, thank you for using and contributing to palace! We welcome -all forms of contribution, and the mo the merier. By saying this, we also -mean that we much prefer receiving many small and self-contained bug reports, -feature requests and patches than a giant one. There is no limit for -the number of contributions one may or should make. While it may seem -appealing to be able to dump all thoughts and feelings into one ticket, -it would be more difficult for us to keep track of the progress.

-
-

Reporting a Bug

-

Before filing a bug report, please make sure that the bug has not been -already reported by searching our GitHub Issues tracker.

-

To facilitate the debugging process, a bug report should at least contain -the following information:

-
    -

  1. The platform, the CPython version and the compiler used to build it. -These can be obtained from platform.platform(), -platform.python_version() and platform.python_compiler(), -respectively.

    2. -

  2. The version of palace and how you installed it. -The earlier is usually provided by pip show palace.

    3. -

  3. Detailed instructions on how to reproduce the bug, -for example a short Python script would be appreciated.

    4. -
-
-
-

Requesting a Feature

-

Prior to filing a feature request, please make sure that the feature -has not been already reported by searching our GitHub Issues tracker.

-

Please only ask for features that you (or an incapacitated friend -you can personally talk to) require. Do not request features because -they seem like a good idea. If they are really useful, they will be -requested by someone who requires them.

-
-
-

Submitting a Patch

-

We accept all kinds of patches, from documentation and CI/CD setup -to bug fixes, feature implementations and tests. Except for documentation -located in the gh-pages branch, others should be filed against -the development branch master. These are hosted on GitHub and -one may create a local repository by running:

-
git clone https://github.com/McSinyx/palace
-
-
-

While the patch can be submitted via email, it is preferable to file -a pull request on GitHub to allow more people to review it, since we do not -have any mail list. Either way, contributors must have legal permission -to distribute the code and it must be available under LGPLv3+. Furthermore, -each contributor retains the copyrights of their patch, to ensure that -the licence can never be revoked even if others wants to. It is advisable -that the author list per legal name under the copyright header -of each source file they modify, like so:

-
Copyright (C) 2038  Foo Bar
-
-
-
-

Using GitHub

-
    -

  1. Create a fork of our repository on GitHub.

    2. -

  2. Checkout the source code and (optionally) add the upstream remote:

    -
    git clone https://github.com/YOUR_GITHUB_USERNAME/palace
-cd palace
-git remote add upstream https://github.com/McSinyx/palace
-
    -
    -
    3. -

  3. Start working on your patch and make sure your code complies with -the Style Guidelines and passes the test suit run by tox.

    4. -

  4. Add relevant tests to the patch and work on it until they all pass. -In case one is only modifying tests, perse may install palace using -CYTHON_TRACE=1 pip install . then run pytest directly to avoid -having to build the extension module multiple times.

    5. -

  5. Update the copyright notices of the files you modified. -Palace is collectively licensed under LGPLv3+, -and to protect the freedom of the users, -copyright holders need to be properly documented.

    6. -

  6. Add, commit with a great message then push the result.

    7. -

  7. Finally, create a pull request. We will then review and merge it.

    8. -
-

It is recommended to create a new branch in your fork -(git checkout -c what-you-are-working-on) instead of working directly -on master. This way one can still sync per fork with our master branch -and git pull --rebase upstream master to avoid integration issues.

-
-
-

Via Email

-
    -

  1. Checkout the source code:

    -
    git clone https://github.com/McSinyx/palace
-cd palace
-
    -
    -
    2. -

  2. Work on your patch with tests and copyright notice included -as described above.

    3. -

  3. git-format-patch and send it to one of the maintainers -(our emails addresses are available under git log). -We will then review and merge it.

    4. -
-

In any case, thank you very much for your contributions!

-
-
-
-

Making a Release

-

While this is meant for developers doing a palace release, contributors wishing -to improve the CI/CD may find it helpful.

-
    -

  1. Under the local repository, checkout the master branch -and sync with the one on GitHub using git pull.

    2. -

  2. Bump the version in setup.cfg and push to GitHub.

    3. -

  3. Create a source distribution by running setup.py sdist. -The distribution generated by this command is now referred to as sdist.

    4. -

  4. Using twine, upload the sdist to PyPI via twine upload $sdist.

    5. -

  5. On GitHub, tag a new release with the sdist attached. -In the release note, make sure to include all user-facing changes -since the previous release. This will trigger the CD services -to build the wheels and publish them to PyPI.

    6. -

  6. Wait for the wheel for your platform to arrive to PyPI and install it. -Play around with it for a little to make sure that everything is OK.

    7. -

  7. Under the local repository, checkout the gh-pages branch. -Often, is it necessary to update the credits under the Copying -section and review if the Reference section needs any change -before running make html to rebuild to documentation.

    8. -

  8. View the documentation locally then push it to GitHub.

    9. -
-
-
-

Style Guidelines

-
-

Python and Cython

-

Generally, palace follows PEP 8 and PEP 257, -with the following preferences and exceptions:

-
    -

  • Hanging indentation is always preferred, -where continuation lines are indented by 4 spaces.

    • -

  • Comments and one-line docstrings are limited to column 79 -instead of 72 like for multi-line docstrings.

    • -

  • Cython extern declarations need not follow the 79-character limit.

    • -

  • Break long lines before a binary operator.

    • -

  • Use form feeds sparingly to break long modules -into pages of relating functions and classes.

    • -

  • Prefer single-quoted strings over double-quoted strings, -unless the string contains single quote characters.

    • -

  • Avoid trailing commas at all costs.

    • -

  • Line breaks within comments and docstrings should not cut a phrase in half.

    • -

  • Everything deserves a docstring. Palace follows numpydoc which support -documenting attributes as well as constants and module-level variables. -In additional to docstrings, type annotations should be employed -for all public names.

    • -

  • Use numpydoc markups moderately to keep docstrings readable as plain text.

    • -
-
-
-

C++

-

C++ codes should follow GNU style, which is best documented at Octave.

-
-
-

reStructuredText

-

In order for reStructuredText to be rendered correctly, the body of -constructs beginning with a marker (lists, hyperlink targets, comments, etc.) -must be aligned relative to the marker. For this reason, it is convenient -to set your editor indentation level to 3 spaces, since most constructs -starts with two dots and a space. However, be aware of that bullet items -require 2-space alignment and other exceptions.

-

Limit all lines to a maximum of 79 characters. Similar to comments -and docstrings, phrases should not be broken in the middle. -The source code of this guide itself is a good example on how line breaks -should be handled. Additionally, two spaces should also be used -after a sentence-ending period in multi-sentence paragraph, -except after the final sentence.

-
-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/copying.html b/html/copying.html deleted file mode 100644 index 8e75715..0000000 --- a/html/copying.html +++ /dev/null @@ -1,224 +0,0 @@ - - - - - - - - Copying — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Copying

-

This listing is our best-faith, hard-work effort at accurate attribution, -sources, and licenses for everything in palace. If you discover -an asset/contribution that is incorrectly attributed or licensed, -please contact us immediately. We are happy to do everything we can -to fix or remove the issue.

-
-

License

-

Palace is free software: you can redistribute it and/or modify it -under the terms of the GNU Lesser General Public License -as published by the Free Software Foundation, either version 3 -of the License, or (at your option) any later version.

-

To ensure that palace can run without any dependencies outside of the pip -toolchain, the wheels are bundled with dynamically linked libraries from -the build machine, which is similar to static linking:

- ---- - - - - - - - - - - - - - - - - - - - - - - -

Library

License

Alure

ZLib

OpenAL Soft

GNU LGPLv2+

Vorbis

3-clause BSD

Opus

3-clause BSD

libsndfile

GNU LGPL2.1+

-

In addition, the following sounds are used for testing:

- ---- - - - - - - - - - - - - - - - - - - - - - - -

Sound (located in tests/data)

License

164957__zonkmachine__white-noise.ogg

CC0 1.0

24741__tim-kahn__b23-c1-raw.aiff

CC BY 3.0

261590__kwahmah-02__little-glitch.flac

CC BY 3.0

353684__tec-studio__drip2.mp3

CC0 1.0

99642__jobro__deconvoluted-20hz-to-20khz.wav

CC BY 3.0

-
-
-

Credits

-

Palace would never have seen the light of day without the help from -the developers of Alure and Cython who promptly gave detail answers -and made quick fixes to all of our problems.

-

The wheels are build using cibuildwheel, which made building extension modules -much less of a painful experience. Travis CI and AppVeyor kindly provides -their services free of charge for automated CI/CD.

-

This documentation is generated using Sphinx, whose maintainer responses -extreamly quickly to obsolete Cython-related issues.

-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/design.html b/html/design.html deleted file mode 100644 index 754e25f..0000000 --- a/html/design.html +++ /dev/null @@ -1,299 +0,0 @@ - - - - - - - - Design Principles — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Design Principles

-

In this section, we will discuss a few design principles in order to write -a safe, efficient, easy-to-use and extendable 3D audio library for Python, -by wrapping existing functionalities from the C++ API alure.

-

This part of the documentation assumes its reader are at least familiar with -Cython, Python and C++11.

-
-

The Impl Idiom

-

Not to be confused with the pimpl idiom.

-

For memory-safety, whenever possible, we rely on Cython for allocation and -deallocation of C++ objects. To do this, the nullary constructor needs to be -(re-)declared in Cython, e.g.

-
cdef extern from 'foobar.h' namespace 'foobar':
-    cdef cppclass Foo:
-        Foo()
-        float meth(size_t crack) except +
-        ...
-
-
-

The Cython extension type can then be declared as follows

-
cdef class Bar:
-    cdef Foo impl
-
-    def __init__(self, *args, **kwargs):
-        self.impl = ...
-
-    @staticmethod
-    def from_baz(baz: Baz) -> Bar:
-        bar = Bar.__new__(Bar)
-        bar.impl = ...
-        return bar
-
-    def meth(self, crack: int) -> float:
-        return self.impl.meth(crack)
-
-
-
-
-

The Modern Python

-

One of the goal of palace is to create a Pythonic, i.e. intuitive and concise, -interface. To achieve this, we try to make use of some modern Python features, -which not only allow users to adopt palace with ease, but also make their -programs more readable and less error-prone.

-
-

Property Attributes

-

A large proportion of alure API are getters/setter methods. In Python, -it is a good practice to use property to abstract these calls, and thus make -the interface more natural with attribute-like referencing and assignments.

-

Due to implementation details, Cython has to hijack the @property decorator -to make it work for read-write properties. Unfortunately, the Cython-generated -descriptors do not play very well with other builtin decorators, thus in some -cases, it is recommended to alias the call to property as follows

-
getter = property
-setter = lambda fset: property(fset=fset, doc=fset.__doc__)
-
-
-

Then @getter and @setter can be used to decorate read-only and -write-only properties, respectively, without any trouble even if other -decorators are used for the same extension type method.

-
-
-

Context Managers

-

The alure API defines many objects that need manual tear-down in -a particular order. Instead of trying to be clever and perform automatic -clean-ups at garbage collection, we should put the user in control. -To quote The Zen of Python,

-
-
-
If the implementation is hard to explain, it’s a bad idea.
-
If the implementation is easy to explain, it may be a good idea.
-
-
-

With that being said, it does not mean we do not provide any level of -abstraction. A simplified case in point would be

-
cdef class Device:
-    cdef alure.Device impl
-
-    def __init__(self, name: str = '') -> None:
-        self.impl = devmgr.open_playback(name)
-
-    def __enter__(self) -> Device:
-        return self
-
-    def __exit__(self, *exc) -> Optional[bool]:
-        self.close()
-
-    def close(self) -> None:
-        self.impl.close()
-
-
-

Now if the with statement is used, it will make sure the device -will be closed, regardless of whatever may happen within the inner block

-
with Device() as dev:
-    ...
-
-
-

as it is equivalent to

-
dev = Device()
-try:
-    ...
-finally:
-    dev.close()
-
-
-

Other than closure/destruction of objects, typical uses of context managers -also include saving and restoring various kinds of global state (as seen in -Context), locking and unlocking resources, etc.

-
-
-
-

The Double Reference

-

While wrapping C++ interfaces, the impl idiom might not -be adequate, since the derived Python methods need to be callable from C++. -Luckily, Cython can handle Python objects within C++ classes just fine, -although we’ll need to handle the reference count ourselves, e.g.

-
cdef cppclass CppDecoder(alure.BaseDecoder):
-    Decoder pyo
-
-    __init__(Decoder decoder):
-        this.pyo = decoder
-        Py_INCREF(pyo)
-
-    __dealloc__():
-        Py_DECREF(pyo)
-
-    bool seek(uint64_t pos):
-        return pyo.seek(pos)
-
-
-

With this being done, we can now write the wrapper as simply as

-
cdef class BaseDecoder:
-    cdef shared_ptr[alure.Decoder] pimpl
-
-    def __cinit__(self, *args, **kwargs) -> None:
-        self.pimpl = shared_ptr[alure.Decoder](new CppDecoder(self))
-
-    def seek(pos: int) -> bool:
-        ...
-
-
-

Because __cinit__ is called by __new__, any Python class derived -from BaseDecoder will be exposed to C++ as an attribute of CppDecoder. -Effectively, this means the users can have the alure API calling their -inherited Python object as naturally as if palace is implemented in pure Python.

-

In practice, BaseDecoder will also need to take into account -other guarding mechanisms like abc.ABC. Due to Cython limitations, -implementation as a pure Python class and aliasing of -@getter/@setter should be considered.

-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/genindex.html b/html/genindex.html deleted file mode 100644 index 1bdb3d6..0000000 --- a/html/genindex.html +++ /dev/null @@ -1,722 +0,0 @@ - - - - - - - - Index — palace 0.2.1 documentation - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- - -

Index

- -
- A - | B - | C - | D - | E - | F - | G - | H - | I - | L - | M - | N - | O - | P - | Q - | R - | S - | T - | U - | V - | W - -
-

A

- - - -
- -

B

- - - -
- -

C

- - - -
- -

D

- - - -
- -

E

- - - -
- -

F

- - - -
- -

G

- - - -
- -

H

- - - -
- -

I

- - -
- -

L

- - - -
- -

M

- - - -
- -

N

- - - -
- -

O

- - - -
- -

P

- - - -
- -

Q

- - -
- -

R

- - - -
- -

S

- - - -
- -

T

- - -
- -

U

- - - -
- -

V

- - - -
- -

W

- - -
- - - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/html/index.html b/html/index.html deleted file mode 100644 index 41f7fef..0000000 --- a/html/index.html +++ /dev/null @@ -1,204 +0,0 @@ - - - - - - - - Overview — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Overview

-

Pythonic Audio Library and Codecs Environment provides common higher-level API -for audio rendering using OpenAL:

-
    -

  • 3D positional rendering, with HRTF support for stereo systems

    • -

  • Environmental effects: reverb, atmospheric air absorption, -sound occlusion and obstruction

    • -

  • Out-of-the-box codec support: FLAC, MP3, Ogg Vorbis, Opus, WAV, AIFF, etc.

    • -
-

Palace wraps around the C++ interface alure using Cython for a safe and -convenient interface with type hinting, data descriptors and context managers, -following PEP 8#naming-conventions (PascalCase.snake_case).

- -
-

Indices and Tables

- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/installation.html b/html/installation.html deleted file mode 100644 index 7903563..0000000 --- a/html/installation.html +++ /dev/null @@ -1,177 +0,0 @@ - - - - - - - - Installation — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Installation

-
-

Prerequisites

-

Palace requires CPython version 3.6 or above for runtime -and pip for installation.

-
-
-

Via PyPI

-

Palace can be installed from PyPI:

-
pip install palace
-
-
-

Wheel distributions are built exclusively for amd64. Currently, only GNU/Linux -and macOS are properly supported. If you want to help packaging for Windows, -please see GH-1 on our issues tracker on GitHub.

-
-
-

From source

-

Aside from the build dependencies listed in pyproject.toml, -one will additionally need compatible Python headers, alure, -a C++14 compiler, CMake 2.6+ (and probably git for fetching the source). -Palace can then be compiled and installed by running:

-
git clone https://github.com/McSinyx/palace.git
-pip install palace/
-
-
-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/objects.inv b/html/objects.inv deleted file mode 100644 index 7e2766193b9bd7921016226d7270491a4a0303b3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1982 zcmV;v2SNBFAX9K?X>NERX>N99Zgg*Qc_4OWa&u{KZXhxWBOp+6Z)#;@bUGk#VQgVz zWeOu8R%LQ?X>V>iAPOTORA^-&a%F8{X>Md?av*PJAarPHb0B7EY-J#6b0A}HZE$jB zb8}^6Aa!$TZf78RY-wUH3V7PBTFY|dC=}iMD^xX8vx~cW+q;b8bh|2vGjUSYy`r#m zWm7?*0pyP7>*pe*Shn@Bz^gdGIYQj`MLFd(hUwo_!yUvj0Tt!@Z!xD@M_(faDJT#z zd`aBobZavH$Dh&7BtHXA<1G~eIEkf5*~ao@V74+DO_VD5x4_l=01ggfW40j#QsyL= zOc))&qJSm=a80wE12Ov?LRbLaJ>c^+h1j&~1C(<;uxSF?DA^^#VZ7$jkPT(RpFtKX z2BJYE+MA@%fC^m*Gm@de@eW&BmvbGE%dDuMqW|dou|u{ugq9ge4vu6rL9f|f0!4A- z$#n{Rfa2KZsWFPJ3j-r41kJz~n{(=S?89zi0MGvO1UeJzGmuLNMoMe;{ zJfk0k79Wf=s`kD0XFrd(;^fqpt%=UP(0KB=ZFJoryakBK4;Wu$k$G(X{$>8p+x%(v zYg9dO&p0fW?Y<$!xf>=sFumqA0PXRh1IQlt*M9yQ$>KS+^F%|h@yK!?xF*ku3l_9wZ0`?+{n+`jxG ztNGL2YLx6AmrqNwTE4x^<|BbFo&9mhW-k~0F?Q-IeZnP8nAnUxfMYJ_APCkj2oP9z zj?VZ`2+<|EK8KKoq#haf317vAC9`c$8Z3|CI*fi?%eU9(w^#D8cwD^BUq)%b3t*IA zd$d!Uz$s;l(6yE-x7JfOeaSW*-Ay>+#AJ}}k%e%UIj3+1E@j=rHMsZ{x$68dga-q? z*$0xaG%f0U!Jh`=tt5WUv2&jAqp1T^7(=i&mn1xp#42zN2xH<{^&^)ZA%4BkPP*^| zZ?feyl<&__!r6aHN@GZ3m0dTEm)jN%8V$uCG1q%;8{3qy=7GdHgn!m7`7-nI5a`)zX=`>FTd1VKXB zC|TsbU>hX5+e;T=2U@rT98%_0q2sfCbYE3}#UCBC|C4IjYZtg&k(cz?7$y?cBkq|Q)GTR zbDTVQA4FeMcmSE>2~u8tvElV>v^$W2LD)NBHJe->5B^?z{gGKri3>>`96>v=C*9a>>_A z$5+_8HHq)K%B(Nu;=_kCt&i?10&2XyD{$SXR(RJ{g42ha6z${+VEKVjIz1=0@DAJ2(5Rn1~r3xSni4xGcybI9&s`n0nNq7WOBu zG#K-5bou9adE*iIp3h3=pfEV!))7HZ7>f6XB}`_0$X9fP3tSm3?8?buW7VrP_OwJr z-!b@&i_k*3YhxX+J&f0{aTuAPJ-57fzQ3s_9Olus$e=ob#_Ry>d5_*-9HUQdzq#2~ zzYx7tS4PncLxdIXnO3%QG*vdbE$}R(2ewvJ?W5|WD?K^0tahrV*;Q04gBF(^GnC)P zbP#+xstWI}=$m-wjoR@IPZiC@jwvZJTQuT-OvbT1krZGnLB0O4rS)yoAnK7h5 zgXT=_PNr(%RD+Y#2;UBEME_`2Wh;MGzoIgO&=U<*VKQ~3TW+kvx%p?hfr%+>7^J*S z6;9`B7vUDpP=2Kid@ehC - - - - - - Resource Caching — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Resource Caching

-
-

Audio Buffers

-
-
-class palace.Buffer
-

Buffer of preloaded PCM samples coming from a Decoder.

-

Cached buffers must be freed using destroy before destroying -context. Alternatively, this can be used as a context manager -that calls destroy upon completion of the block, -even if an error occurs.

-
-
Parameters
-
    -

  • name (str) – Audio file or resource name. Multiple calls with the same name -will return the same buffer.

    • -

  • context (Optional[Context], optional) – The context from which the buffer is to be created and cached. -By default current_context() is used.

    • -
-
-
-
-
-name
-

Audio file or resource name.

-
-
Type
-

str

-
-
-
- -
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-
-property channel_config
-

Buffer’s sample configuration.

-
- -
-
-destroy() → None
-

Free the buffer’s cache.

-

This invalidates all other Buffer objects with the same name.

-
- -
-
-property frequency
-

Buffer’s frequency in hertz.

-
- -
-
-static from_decoder(decoder: palace.Decoder, name: str, context: Optional[palace.Context]) → palace.Buffer
-

Return a buffer created by reading the given decoder.

-
-
Parameters
-
    -

  • decoder (Decoder) – The decoder from which the buffer is to be cached.

    • -

  • name (str) – The name to give to the buffer. It may alias an audio file, -but it must not currently exist in the buffer cache.

    • -

  • context (Optional[Context], optional) – The context from which the buffer is to be created. -By default current_context() is used.

    • -
-
-
Raises
-

RuntimeError – If there is neither any context specified nor current; - or if name is already used for another buffer.

-
-
-
- -
-
-property length
-

Length of the buffer in sample frames.

-
- -
-
-property length_seconds
-

Length of the buffer in seconds.

-
- -
-
-loop_points
-

Loop points for looping sources.

-

If AL_SOFT_loop_points extension is not supported by the -current context, start = 0 and end = length respectively. -Otherwise, start < end <= length.

-
-
Returns
-

    -

  • start (int) – Starting point, in sample frames (inclusive).

    • -

  • end (int) – Ending point, in sample frames (exclusive).

    • -
-

-
-
-

Notes

-

The buffer must not be in use when this property is set.

-
- -
-
-play(source: Optional[palace.Source]) → palace.Source
-

Play source using the buffer.

-

Return the source used for playing. If None is given, -create a new one.

-

One buffer may be played from multiple sources simultaneously.

-
- -
-
-property sample_type
-

Buffer’s sample type.

-
- -
-
-property size
-

Storage size used by the buffer, in bytes.

-

Notes

-

The size in bytes may not be what you expect from the length, -as it may take more space internally than the channel_config -and sample_type suggest.

-
- -
-
-property source_count
-

Number of sources currently using the buffer.

-

Notes

-

Context.update needs to be called to reliably ensure the count -is kept updated for when sources reach their end. This is -equivalent to calling len(self.sources).

-
- -
-
-property sources
-

Source objects currently playing the buffer.

-
- -
- -
-
-

Loading & Freeing in Batch

-
-
-palace.cache(names: Iterable[str], context: Optional[palace.Context] = None) → None
-

Cache given audio resources asynchronously.

-

Duplicate names and buffers already cached are ignored. -Cached buffers must be freed before destroying the context.

-

The resources will be scheduled for caching asynchronously, -and should be retrieved later when needed by initializing -Buffer corresponding objects. Resources that cannot be -loaded, for example due to an unsupported format, will be -ignored and a later Buffer initialization will raise -an exception.

-

If context is not given, current_context() will be used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-

See also

-
-
free()

Free cached audio resources given their names

-
-
Buffer.destroy()

Free the buffer’s cache

-
-
-
-
- -
-
-palace.free(names: Iterable[str], context: Optional[palace.Context] = None) → None
-

Free cached audio resources given their names.

-

If context is not given, current_context() will be used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/context.html b/html/reference/context.html deleted file mode 100644 index d3208ae..0000000 --- a/html/reference/context.html +++ /dev/null @@ -1,581 +0,0 @@ - - - - - - - - Audio Library Contexts — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Audio Library Contexts

-
-

Context and Auxiliary Classes

-
-
-class palace.Context
-

Container maintaining the audio environment.

-

Context contains the environment’s settings and components -such as sources, buffers and effects.

-

This can be used as a context manager, e.g.

-
with context:
-    ...
-
-
-

is equivalent to

-
previous = current_context()
-use_context(context)
-try:
-    ...
-finally:
-    use_context(previous)
-    context.destroy()
-
-
-
-
Parameters
-
    -

  • device (Device) – The device on which the context is to be created.

    • -

  • attrs (Dict[int, int]) – Attributes specified for the context to be created.

    • -
-
-
-
-
-device
-

The device this context was created from.

-
-
Type
-

Device

-
-
-
- -
-
-listener
-

The listener instance of this context.

-
-
Type
-

Listener

-
-
-
- -
-
Raises
-

RuntimeError – If context creation fails.

-
-
-
-
-async_wake_interval
-

Current interval used for waking up the background thread.

-
- -
-
-property available_resamplers
-

The list of resamplers supported by the context.

-

If AL_SOFT_source_resampler extension is unsupported, -this will be an empty list. Otherwise there would be -at least one entry.

-

This method require the context to be current.

-
- -
-
-property default_resampler_index
-

The context’s default resampler index.

-

If AL_SOFT_source_resampler extension is unsupported, -this will return 0.

-

If you try to access the resampler list with this index -without extension, undefined behavior will occur -(accessing an out of bounds array index).

-

This method require the context to be current.

-
- -
-
-destroy() → None
-

Destroy the context.

-

The context must not be current when this is called.

-
- -
-
-property distance_model
-

The model for source attenuation based on distance.

-

The default, ‘inverse clamped’, provides a realistic l/r -reduction in volume (that is, every doubling of distance -cause the gain to reduce by half).

-

The clamped distance models restrict the source distance for -the purpose of distance attenuation, so a source won’t sound -closer than its reference distance or farther than its max -distance.

-
-
Raises
-

ValueError – If set to a preset cannot be found in distance_models.

-
-
-
- -
-
-property doppler_factor
-

Factor to apply to all source’s doppler calculations.

-
- -
-
-end_batch() → None
-

Continue processing the context and end batching.

-
- -
-
-is_supported(channel_config: str, sample_type: str) → bool
-

Return if the channel config and sample type is supported.

-

This method require the context to be current.

-
-

See also

-
-
sample_types()

Set of sample types

-
-
channel_configs()

Set of channel configurations

-
-
-
-
- -
-
-message_handler
-

Handler of some certain events.

-
- -
-
-property speed_of_sound
-

The speed of sound propagation in units per second.

-

It is used to calculate the doppler effect along with other -distance-related time effects.

-

The default is 343.3 units per second (a realistic speed -assuming 1 meter per unit). If this is adjusted for a -different unit scale, Listener.meters_per_unit should -also be adjusted.

-
- -
-
-start_batch() → None
-

Suspend the context to start batching.

-
- -
-
-update() → None
-

Update the context and all sources belonging to this context.

-
- -
- -
-
-class palace.Listener
-

Listener instance of the given context.

-

It is recommended that applications access the listener via -Context.listener, which avoid the overhead caused by the -creation of the wrapper object.

-
-
Parameters
-

context (Optional[Context], optional) – The context on which the listener instance is to be created. -By default current_context() is used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-
-property gain
-

Master gain for all context output.

-
- -
-
-property meters_per_unit
-

Number of meters per unit.

-

This is used for various effects relying on the distance -in meters including air absorption and initial reverb decay. -If this is changed, so should the speed of sound -(e.g. context.speed_of_sound = 343.3 / meters_per_unit -to maintain a realistic 343.3 m/s for sound propagation).

-
- -
-
-property orientation
-

3D orientation of the listener.

-
-
Parameters
-
    -

  • at (Tuple[float, float, float]) – Relative position.

    • -

  • up (Tuple[float, float, float]) – Relative direction.

    • -
-
-
-
- -
-
-property position
-

3D position of the listener.

-
- -
-
-property velocity
-

3D velocity of the listener, in units per second.

-

As with OpenAL, this does not actually alter the listener’s -position, and instead just alters the pitch as determined by -the doppler effect.

-
- -
- -
-
-class palace.MessageHandler
-

Message handler interface.

-

Applications may derive from this and set an instance on a context -to receive messages. The base methods are no-ops, so subclasses -only need to implement methods for relevant messages.

-

Exceptions raised from MessageHandler instances are ignored.

-
-
-buffer_loading(name: str, channel_config: str, sample_type: str, sample_rate: int, data: Sequence[int]) → None
-

Handle messages from Buffer initialization.

-

This is called when a new buffer is about to be created -and loaded. which may be called asynchronously for buffers -being loaded asynchronously.

-
-
Parameters
-
    -

  • name (str) – Resource name passed to Buffer.

    • -

  • channel_config (str) – Channel configuration of the given audio data.

    • -

  • sample_type (str) – Sample type of the given audio data.

    • -

  • sample_rate (int) – Sample rate of the given audio data.

    • -

  • data (MutableSequence[int]) –

    The audio data that is about to be fed to the OpenAL buffer.

    -

    It is a mutable memory array of signed 8-bit integers, -following Python buffer protocol.

    -

    • -
-
-
-
- -
-
-device_disconnected(device: palace.Device) → None
-

Handle disconnected device messages.

-

This is called when the given device has been disconnected and -is no longer usable for output. As per ALC_EXT_disconnect -specification, disconnected devices remain valid, however all -playing sources are automatically stopped, any sources that are -attempted to play will immediately stop, and new contexts may -not be created on the device.

-

Notes

-

Connection status is checked during Context.update calls, so -method must be called regularly to be notified when a device is -disconnected. This method may not be called if the device lacks -support for ALC_EXT_disconnect extension.

-
- -
-
-resource_not_found(name: str) → str
-

Return the fallback resource for the one of the given name.

-

This is called when name is not found, allowing substitution -of a different resource until the returned string either points -to a valid resource or is empty (default).

-

For buffers being cached, the original name will still be used -for the cache entry so one does not have to keep track of -substituted resource names.

-
- -
-
-source_force_stopped(source: palace.Source) → None
-

Handle forcefully stopped sources.

-

This is called when the given source was forced to stop, -because of one of the following reasons:

-
    -

  • There were no more mixing sources and a higher-priority source -preempted it.

    • -

  • source is part of a SourceGroup (or sub-group thereof) -that had its SourceGroup.stop_all method called.

    • -

  • source was playing a buffer that’s getting removed.

    • -
-
- -
-
-source_stopped(source: palace.Source) → None
-

Handle end-of-buffer/stream messages.

-

This is called when the given source reaches the end of buffer -or stream, which is detected upon a call to Context.update.

-
- -
- -
-
-

Using Contexts

-
-
-palace.use_context(context: Optional[palace.Context], thread: Optional[bool] = None) → None
-

Make the specified context current for OpenAL operations.

-

This fails silently if the given context has been destroyed. -In case thread is not specified, fallback to preference made by -thread_local.

-

If thread is True, make the context current -for OpenAL operations on the calling thread only. -This requires the non-device-specific as well as the context’s -device ALC_EXT_thread_local_context extension to be available.

-
- -
-
-palace.current_context(thread: Optional[bool] = None) → Optional[palace.Context]
-

Return the context that is currently used.

-

If thread is set to True, return the thread-specific context -used for OpenAL operations. This requires the non-device-specific -as well as the context’s device ALC_EXT_thread_local_context -extension to be available.

-

In case thread is not specified, fallback to preference made by -thread_local.

-
- -
-
-palace.thread_local(state: bool) → Iterator[None]
-

Return a context manager controlling preference of local thread.

-

Effectively, it sets fallback value for thread argument -for current_context and use_context.

-

Initially, globally current Context is preferred.

-
- -
-
-

Context Creation Attributes

-
-
-palace.CHANNEL_CONFIG: int
-

Context creation key to specify the channel configuration -(either MONO, STEREO, QUAD, X51, X61 or X71).

-
- -
-
-palace.SAMPLE_TYPE: int
-

Context creation key to specify the sample type -(either [UNSIGNED_]{BYTE,SHORT,INT} or FLOAT).

-
- -
-
-palace.FREQUENCY: int
-

Context creation key to specify the frequency in hertz.

-
- -
-
-palace.MONO_SOURCES: int
-

Context creation key to specify the number of mono (3D) sources.

-
- -
-
-palace.STEREO_SOURCES: int
-

Context creation key to specify the number of stereo sources.

-
- -
-
-palace.MAX_AUXILIARY_SENDS: int
-

Context creation key to specify the maximum number of -auxiliary source sends.

-
- -
-
-palace.HRTF: int
-

Context creation key to specify whether to enable HRTF -(either FALSE, TRUE or DONT_CARE).

-
- -
-
-palace.HRTF_ID: int
-

Context creation key to specify the HRTF to be used.

-
- -
-
-palace.OUTPUT_LIMITER: int
-

Context creation key to specify whether to use a gain limiter -(either FALSE, TRUE or DONT_CARE).

-
- -
-
-palace.distance_models: Tuple[str, …]
-

Names of available distance models.

-
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/decoder.html b/html/reference/decoder.html deleted file mode 100644 index 405a77b..0000000 --- a/html/reference/decoder.html +++ /dev/null @@ -1,431 +0,0 @@ - - - - - - - - Audio Streams — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Audio Streams

-
-

Builtin Decoders

-
-
-class palace.Decoder
-

Generic audio decoder.

-
-
Parameters
-
    -

  • name (str) – Audio file or resource name.

    • -

  • context (Optional[Context], optional) – The context from which the decoder is to be created. -By default current_context() is used.

    • -
-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-

See also

-
-
Buffer

Preloaded PCM samples coming from a Decoder

-
-
-
-

Notes

-

Due to implementation details, while this creates decoder objects -from filenames using contexts, it is the superclass of the ABC -(abstract base class) BaseDecoder. Because of this, Decoder -may only initialize an internal one. To use registered factories, -please call the module-level decode function instead.

-
-
-property channel_config
-

Channel configuration of the audio being decoded.

-
- -
-
-property frequency
-

Sample frequency, in hertz, of the audio being decoded.

-
- -
-
-property length
-

Length of audio in sample frames, falling-back to 0.

-

Notes

-

Zero-length decoders may not be used to load a Buffer.

-
- -
-
-property length_seconds
-

Length of audio in seconds, falling-back to 0.0.

-

Notes

-

Zero-length decoders may not be used to load a Buffer.

-
- -
-
-property loop_points
-

Loop points in sample frames.

-
-
Returns
-

    -

  • start (int) – Inclusive starting loop point.

    • -

  • end (int) – Exclusive starting loop point.

    • -
-

-
-
-

Notes

-

If start >= end, all available samples are included -in the loop.

-
- -
-
-play(chunk_len: int, queue_size: int, source: Optional[palace.Source]) → palace.Source
-

Stream audio asynchronously from the decoder.

-

The decoder must NOT have its read or seek called -from elsewhere while in use.

-
-
Parameters
-
    -

  • chunk_len (int) – The number of sample frames to read for each chunk update. -Smaller values will require more frequent updates and -larger values will handle more data with each chunk.

    • -

  • queue_size (int) – The number of chunks to keep queued during playback. -Smaller values use less memory while larger values -improve protection against underruns.

    • -

  • source (Optional[Source], optional) – The source object to play audio. If None is given, -a new one will be created from the current context.

    • -
-
-
Returns
-

-
-
Return type
-

The source used for playing.

-
-
-
- -
-
-read(count: int) → bytes
-

Decode and return count sample frames.

-

If less than the requested count samples is returned, -the end of the audio has been reached.

-
-

See also

-
-
sample_length()

length of samples of given size

-
-
-
-
- -
-
-property sample_type
-

Sample type of the audio being decoded.

-
- -
-
-seek(pos: int) → bool
-

Seek to pos, specified in sample frames.

-

Return if the seek was successful.

-
- -
- -
-
-

Decoder Interface

-
-
-palace.decoder_factories: DecoderNamespace
-

Simple object for storing decoder factories.

-

User-registered factories are tried one after another -if RuntimeError is raised, in lexicographical order. -Internal decoder factories are always used after registered ones.

-
- -
-
-palace.decode(name: str, context: Optional[palace.Context] = None) → palace.Decoder
-

Return the decoder created from the given resource name.

-

This first tries user-registered decoder factories in -lexicographical order, then fallback to the internal ones.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-

See also

-
-
decoder_factories()

Simple object for storing decoder factories

-
-
-
-
- -
-
-class palace.BaseDecoder(*args, **kwargs)
-

Audio decoder interface.

-

Applications may derive from this, implement necessary methods, -and use it in places the API wants a BaseDecoder object.

-

Exceptions raised from BaseDecoder instances are ignored.

-
-
-abstract property channel_config
-

Channel configuration of the audio being decoded.

-
- -
-
-abstract property frequency
-

Sample frequency, in hertz, of the audio being decoded.

-
- -
-
-abstract property length
-

Length of audio in sample frames, falling-back to 0.

-

Notes

-

Zero-length decoders may not be used to load a Buffer.

-
- -
-
-abstract property loop_points
-

Loop points in sample frames.

-
-
Returns
-

    -

  • start (int) – Inclusive starting loop point.

    • -

  • end (int) – Exclusive starting loop point.

    • -
-

-
-
-

Notes

-

If start >= end, all available samples are included -in the loop.

-
- -
-
-abstract read(count: int) → bytes
-

Decode and return count sample frames.

-

If less than the requested count samples is returned, -the end of the audio has been reached.

-
- -
-
-abstract property sample_type
-

Sample type of the audio being decoded.

-
- -
-
-abstract seek(pos: int) → bool
-

Seek to pos, specified in sample frames.

-

Return if the seek was successful.

-
- -
- -
-
-

Miscellaneous

-
-
-palace.sample_types: Tuple[str, …]
-

Names of available sample types.

-
- -
-
-palace.channel_configs: Tuple[str, …]
-

Names of available channel configurations.

-
- -
-
-palace.sample_size(length: int, channel_config: str, sample_type: str) → int
-

Return the size of the given number of sample frames.

-
-
Raises
-
    -

  • ValueError – If either channel_config or sample_type is invalid.

    • -

  • RuntimeError – If the byte size result too large.

    • -
-
-
-
- -
-
-palace.sample_length(size: int, channel_config: str, sample_type: str) → int
-

Return the number of frames stored in the given byte size.

-
-
Raises
-

ValueError – If either channel_config or sample_type is invalid.

-
-
-
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/device.html b/html/reference/device.html deleted file mode 100644 index 3cb86e4..0000000 --- a/html/reference/device.html +++ /dev/null @@ -1,330 +0,0 @@ - - - - - - - - Audio Devices — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Audio Devices

-
-

Device-Dependent Utilities

-
-
-class palace.Device
-

Audio mix output, via either a system stream or a hardware port.

-

This can be used as a context manager that calls close upon -completion of the block, even if an error occurs.

-
-
Parameters
-
    -

  • name (str, optional) – The name of the playback device.

    • -

  • fallback (Iterable[str], optional) – Device names to fallback to, default to an empty tuple.

    • -
-
-
Raises
-

RuntimeError – If device creation fails.

-
-
Warns
-

RuntimeWarning – Before each fallback.

-
-
-
-

See also

-
-
device_names

Available device names

-
-
-
-
-
-property alc_version
-

ALC version supported by this device.

-
- -
-
-property basic_name
-

Basic name of the device.

-
- -
-
-property clock_time
-

Current clock time for the device.

-

Notes

-

This starts relative to the device being opened, and does not -increment while there are no contexts nor while processing -is paused. Currently, this may not exactly match the rate -that sources play at. In the future it may utilize an OpenAL -extension to retrieve the audio device’s real clock.

-
- -
-
-close() → None
-

Close and free the device.

-

All previously-created contexts must first be destroyed.

-
- -
-
-property current_hrtf
-

Name of the HRTF currently being used by this device.

-

If HRTF is not currently enabled, this will be None.

-
- -
-
-property efx_version
-

EFX version supported by this device.

-

If ALC_EXT_EFX extension is unsupported, this will be (0, 0).

-
- -
-
-property frequency
-

Playback frequency in hertz.

-
- -
-
-property hrtf_enabled
-

Whether HRTF is enabled on the device.

-

If ALC_SOFT_HRTF extension is unavailable, -this will return False although there could still be -HRTF applied at a lower hardware level.

-
- -
-
-property hrtf_names
-

List of available HRTF names.

-

The order is retained from OpenAL, such that the index of -a given name is the ID to use with ALC_HRTF_ID_SOFT.

-

If ALC_SOFT_HRTF extension is unavailable, -this will be an empty list.

-
- -
-
-property max_auxiliary_sends
-

Maximum number of auxiliary source sends.

-

If ALC_EXT_EFX is unsupported, this will be 0.

-
- -
-
-property name
-

Name of the device.

-
- -
-
-pause_dsp() → None
-

Pause device processing and stop contexts’ updates.

-

Multiple calls are allowed but it is not reference counted, -so the device will resume after one resume_dsp call.

-

This requires ALC_SOFT_pause_device extension.

-
- -
-
-query_extension(name: str) → bool
-

Return if an ALC extension exists on this device.

-
-

See also

-
-
query_extension()

Query non-device-specific ALC extension

-
-
-
-
- -
-
-reset(attrs: Dict[int, int]) → None
-

Reset the device, using the specified attributes.

-

If ALC_SOFT_HRTF extension is unavailable, -this will be a no-op.

-
- -
-
-resume_dsp() → None
-

Resume device processing and restart contexts’ updates.

-

Multiple calls are allowed and will no-op.

-
- -
- -
-
-

Device-Independent Utilities

-
-
-palace.device_names: DeviceNames
-

Read-only namespace of device names by category (basic, full and -capture), as tuples of strings whose first item being the default.

-
- -
-
-palace.query_extension(name: str) → bool
-

Return if a non-device-specific ALC extension exists.

-
-

See also

-
-
Device.query_extension()

Query ALC extension on a device

-
-
-
-
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/effect.html b/html/reference/effect.html deleted file mode 100644 index c37c703..0000000 --- a/html/reference/effect.html +++ /dev/null @@ -1,451 +0,0 @@ - - - - - - - - Environmental Effects — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Environmental Effects

-

For the sake of brevity, we only document the constraints of each effect’s -properties. Further details can be found at OpenAL’s Effect Extension Guide -which specifies the purpose and usage of each value.

-
-

Base Effect

-
-
-class palace.BaseEffect
-

Base effect processor.

-

Instances of this class has no effect (pun intended).

-

It takes the output mix of zero or more sources, -applies DSP for the desired effect, then adds to the output mix.

-

This can be used as a context manager that calls destroy -upon completion of the block, even if an error occurs.

-
-
Parameters
-

context (Optional[Context], optional) – The context from which the effect is to be created. -By default current_context() is used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-

See also

-
-
ReverbEffect

Environmental reverberation effect

-
-
ChorusEffect

Chorus effect

-
-
-
-
-
-destroy() → None
-

Destroy the effect slot, returning it to the system.

-

If the effect slot is currently set on a source send, -it will be removed first.

-
- -
-
-property slot_gain
-

Gain of the effect slot.

-
- -
-
-property source_sends
-

List of sources using this effect and their pairing sends.

-
- -
-
-property use_count
-

Number of source sends the effect slot is used by.

-

This is equivalent to calling len(self.source_sends).

-
- -
- -
-
-

Chorus Effect

-
-
-class palace.ChorusEffect
-

Chorus effect.

-

The chorus effect essentially replays the input audio accompanied -by another slightly delayed version of the signal, creating -a “doubling” effect. This was originally intended to emulate -the effect of several musicians playing the same notes -simultaneously, to create a thicker, more satisfying sound.

-
-
Parameters
-
    -

  • waveform (str) – Either ‘sine’ or ‘triangle’.

    • -

  • phase (int) – From -180 to 180.

    • -

  • depth (float) – From 0.0 to 1.0.

    • -

  • feedback (float) – From -1.0 to 1.0.

    • -

  • delay (float) – From 0.0 to 0.016.

    • -

  • context (Optional[Context], optional) – The context from which the effect is to be created. -By default current_context() is used.

    • -
-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-
-delay
-

Delay, from 0.0 to 0.016.

-
- -
-
-depth
-

Depth, from 0.0 to 1.0.

-
- -
-
-feedback
-

Feedback, from -1.0 to 1.0.

-
- -
-
-phase
-

Phase, from -180 to 180.

-
- -
-
-waveform
-

Waveform, either ‘sine’ or ‘triangle’.

-
- -
- -
-
-

Reverb Effect

-
-
-palace.reverb_preset_names: Tuple[str, …]
-

Names of predefined reverb effect presets in lexicographical order.

-
- -
-
-class palace.ReverbEffect
-

Environmental reverberation effect.

-
-
Parameters
-
    -

  • preset (str, optional) – The initial preset to start with, falling back to GENERIC.

    • -

  • context (Optional[Context], optional) – The context from which the effect is to be created. -By default current_context() is used.

    • -
-
-
Raises
-
    -

  • ValueError – If the specified preset cannot be found in reverb_preset_names.

    • -

  • RuntimeError – If there is neither any context specified nor current.

    • -
-
-
-
-
-air_absorption_gain_hf
-

High frequency air absorption gain, from 0.892 to 1.0.

-
- -
-
-decay_hf_limit
-

Whether to limit high frequency decay.

-
- -
-
-decay_hf_ratio
-

High frequency decay ratio, from 0.1 to 20.0.

-
- -
-
-decay_lf_ratio
-

Low frequency decay ratio, from 0.1 to 20.0.

-
- -
-
-decay_time
-

Decay time, from 0.1 to 20.0.

-
- -
-
-density
-

Density, from 0.0 to 1.0.

-
- -
-
-diffusion
-

Diffusion, from 0.0 to 1.0.

-
- -
-
-echo_depth
-

Echo depth, from 0.0 to 1.0.

-
- -
-
-echo_time
-

Echo time, from 0.075 to 0.25.

-
- -
-
-gain
-

Gain, from 0.0 to 1.0.

-
- -
-
-gain_hf
-

High frequency gain, from 0.0 to 1.0.

-
- -
-
-gain_lf
-

Low frequency gain, from 0.0 to 1.0.

-
- -
-
-hf_reference
-

High frequency reference, from 1000.0 to 20000.0.

-
- -
-
-late_reverb_delay
-

Late reverb delay, from 0.0 to 0.1.

-
- -
-
-late_reverb_gain
-

Late reverb gain, from 0.0 to 10.0.

-
- -
-
-late_reverb_pan
-

Late reverb as 3D vector of magnitude between 0 and 1.

-
- -
-
-lf_reference
-

Low frequency reference, from 20.0 to 1000.0.

-
- -
-
-modulation_depth
-

Modulation depth, from 0.0 to 1.0.

-
- -
-
-modulation_time
-

Modulation time, from 0.004 to 4.0.

-
- -
-
-reflections_delay
-

Reflections delay, from 0.0 to 0.3.

-
- -
-
-reflections_gain
-

Reflections gain, from 0.0 to 3.16.

-
- -
-
-reflections_pan
-

Reflections as 3D vector of magnitude between 0 and 1.

-
- -
-
-room_rolloff_factor
-

Room rolloff factor, from 0.0 to 10.0.

-
- -
-
-property send_auto
-

Whether to automatically adjust send slot gains.

-
- -
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/file-io.html b/html/reference/file-io.html deleted file mode 100644 index 389f78f..0000000 --- a/html/reference/file-io.html +++ /dev/null @@ -1,211 +0,0 @@ - - - - - - - - File I/O Interface — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

File I/O Interface

-
-
-palace.current_fileio() → Optional[Callable[[str], palace.FileIO]]
-

Return the file I/O factory currently in used by audio decoders.

-

If the default is being used, return None.

-
- -
-
-palace.use_fileio(factory: Optional[Callable[[str], FileIO]], buffer_size: int = 8192) → None
-

Set the file I/O factory instance to be used by audio decoders.

-

If factory=None is provided, revert to the default.

-
- -
-
-class palace.FileIO(*args, **kwds)
-

File I/O protocol.

-

This static duck type defines methods required to be used by -palace decoders. Despite its name, a FileIO is not necessarily -created from a file, but any seekable finite input stream.

-

Many classes defined in the standard library module io -are compatible with this protocol.

-

Notes

-

Since PEP 544 is only implemented in Python 3.8+, type checking -for this on earlier Python version might not work as expected.

-
-
-abstract close() → None
-

Close the file.

-
- -
-
-abstract read(size: int) → bytes
-

Read at most size bytes, returned as bytes.

-
- -
-
-abstract seek(offset: int, whence: int = 0) → int
-

Move to new file position and return the file position.

-
-
Parameters
-
    -

  • offset (int) – A byte count.

    • -

  • whence (int, optional) – Either 0 (default, move relative to start of file), -1 (move relative to current position) -or 2 (move relative to end of file).

    • -
-
-
-
- -
- -
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/index.html b/html/reference/index.html deleted file mode 100644 index 9d2f4f2..0000000 --- a/html/reference/index.html +++ /dev/null @@ -1,194 +0,0 @@ - - - - - - - - Reference — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- - - - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/reference/source.html b/html/reference/source.html deleted file mode 100644 index 3d40961..0000000 --- a/html/reference/source.html +++ /dev/null @@ -1,673 +0,0 @@ - - - - - - - - Sources & Source Groups — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Sources & Source Groups

-
-

Sources

-
-
-class palace.Source
-

Sound source for playing audio.

-

There is no practical limit to the number of sources one may create.

-

When the source is no longer needed, destroy must be called, -unless the context manager is used, which guarantees the source’s -destructioni upon completion of the block, even if an error occurs.

-
-
Parameters
-

context (Optional[Context], optional) – The context from which the source is to be created. -By default current_context() is used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-
-air_absorption_factor
-

Multiplier for atmospheric high-frequency absorption

-

Its value ranging from 0 to 10. A factor of 1 results in -a nominal -0.05 dB per meter, with higher values simulating -foggy air and lower values simulating dryer air; default to 0.

-
- -
-
-cone_angles
-

Cone inner and outer angles in degrees.

-
-
Returns
-

    -

  • inner (float) – The area within which the listener will hear the source -without extra attenuation, default to 360.

    • -

  • outer (float) – The area outside of which the listener will hear the source -attenuated according to outer_cone_gains, default to 360.

    • -
-

-
-
Raises
-

ValueError – If set to a value where inner is greater than outer - or either of them is outside of the [0, 360] interval.

-
-
-

Notes

-

The areas follow the facing direction, so for example -an inner angle of 180 means the entire front face of -the source is in the inner cone.

-
- -
-
-destroy() → None
-

Destroy the source, stop playback and release resources.

-
- -
-
-distance_range
-

Reference and maximum distance for current distance model.

-

For Clamped distance models, the source’s calculated -distance is clamped to the specified range before applying -distance-related attenuation.

-
-
Returns
-

    -

  • refdist (float) – The distance at which the source’s volume will not have -any extra attenuation (an effective gain multiplier of 1), -default to 0.

    • -

  • maxdist (float) – The maximum distance, default to FLT_MAX, which is the -maximum value of a single-precision floating-point variable -(2**128 - 2**104).

    • -
-

-
-
Raises
-

ValueError – If set to a value where refdist is greater than maxdist - or either of them is outside of the [0, FLT_MAX] interval.

-
-
-
- -
-
-doppler_factor
-

The doppler factor for the doppler effect’s pitch shift.

-

This effectively scales the source and listener velocities -for the doppler calculation.

-
-
Raises
-

ValueError – If set to a value outside of the [0, 1] interval.

-
-
-
- -
-
-fade_out_to_stop(gain: float, ms: int) → None
-

Fade the source to gain over ms milliseconds.

-

gain is in addition to the base gain and must be within -the [0, 1] interval. ms must be positive.

-

The fading is logarithmic. As a result, the initial drop-off -may happen faster than expected but the fading is more -perceptually consistant over the given duration. It will take -just as much time to go from -6 dB to -12 dB as it will to go -from -40 dB to -46 dB, for example.

-

Fading is updated during calls to Context.update, -which should be called regularly (30 to 50 times per second) -for the fading to be smooth.

-
- -
-
-property filter
-

Linear gains on the direct path signal, clamped to [0, 1].

-
-
Parameters
-
    -

  • gain (float) – Linear gain applying to all frequencies, default to 1.

    • -

  • gain_hf (float) – Linear gain applying to high frequencies, default to 1.

    • -

  • gain_lf (float) – Linear gain applying to low frequencies, default to 1.

    • -
-
-
-
- -
-
-gain
-

Base linear volume gain, default to 1.0.

-
-
Raises
-

ValueError – If set to a negative value.

-
-
-
- -
-
-gain_auto
-

Whether automatically adjust gains.

-
-
Returns
-

    -

  • direct_hf (bool) – Direct path’s high frequency gain, default to True.

    • -

  • send (bool) – Send paths’ gain, default to True.

    • -

  • send_hf (bool) – Send paths’ high-frequency, default to True.

    • -
-

-
-
-
- -
-
-gain_range
-

The range which the source’s gain is clamped to.

-

This is used after distance and cone attenuation are applied -to the gain base and before the adjustments of the filter gain.

-
-
Returns
-

    -

  • mingain (float) – Minimum gain, default to 0.

    • -

  • maxgain (float) – Maximum gain, default to 1.

    • -
-

-
-
Raises
-

ValueError – If set to a value where mingain is greater than maxgain - or either of them is outside of the [0, 1] interval.

-
-
-
- -
-
-group
-

Parent group of this source.

-

The parent group influences all sources that belong to it. -A source may only be the child of one SourceGroup at a time, -although that source group may belong to another source group.

-

This is None when the source does not belong to any group. -On the other hand, setting it to None removes the source -from its current group.

-
-

See also

-
-
SourceGroup

A group of Source references

-
-
-
-
- -
-
-property latency
-

Source latency in nanoseconds.

-

If AL_SOFT_source_latency extension is unsupported, -this will be 0.

-
- -
-
-property latency_seconds
-

Source latency in seconds.

-

If AL_SOFT_source_latency extension is unsupported, -this will be 0.

-
- -
-
-looping
-

Whether the source should loop.

-

The loop points are determined by the playing buffer or decoder.

-
- -
-
-offset
-

Source offset in sample frames.

-

For streaming sources, this will be -based on decoder’s read position.

-
- -
-
-property offset_seconds
-

Source offset in seconds.

-

For streaming sources, this will be based on -the decoder’s read position.

-
- -
-
-orientation
-

3D orientation of the source.

-
-
Returns
-

    -

  • at (Tuple[float, float, float]) – Relative position.

    • -

  • up (Tuple[float, float, float]) – Relative direction.

    • -
-

-
-
-

Notes

-

Unlike AL_EXT_BFORMAT extension this property -comes from, this also affects the facing direction.

-
- -
-
-outer_cone_gains
-

Gain when listener is out of the source’s outer cone area.

-
-
Returns
-

    -

  • gain (float) – Linear gain applying to all frequencies, default to 1.

    • -

  • gain_hf (float) – Linear gain applying extra attenuation to high frequencies -creating a low-pass effect, default to 1. It has no effect -without the ALC_EXT_EFX extension.

    • -
-

-
-
Raises
-

ValueError – If either of the gains is set to a value - outside of the [0, 1] interval.

-
-
-
- -
-
-pause() → None
-

Pause the source if it is playing.

-
- -
-
-property paused
-

Whether the source is currently paused.

-
- -
-
-pitch
-

Linear pitch shift base, default to 1.0.

-
-
Raises
-

ValueError – If set to a nonpositive value.

-
-
-
- -
-
-property playing
-

Whether the source is currently playing.

-
- -
-
-position
-

3D position of the source.

-
- -
-
-priority
-

Playback priority (natural number).

-

The lowest priority sources will be forcefully stopped -when no more mixing sources are available and higher priority -sources are played.

-
- -
-
-radius
-

Radius of the source, as if it is a sound-emitting sphere.

-

This has no effect without AL_EXT_SOURCE_RADIUS extension.

-
-
Raises
-

ValueError – If set to a negative value.

-
-
-
- -
-
-relative
-

Whether the source’s 3D parameters are relative to listener.

-

The affected parameters includes position, velocity, -and orientation.

-
- -
-
-resampler_index
-

Index of the resampler to use for this source.

-

The index must be nonnegative, from the resamplers returned -by Context.get_available_resamplers, and has no effect -without the AL_SOFT_source_resampler extension.

-
- -
-
-resume() → None
-

Resume the source if it is paused.

-
- -
-
-rolloff_factors
-

Rolloff factors for the direct and send paths.

-

This is effectively a distance scaling relative to -the reference distance.

-
-
Returns
-

    -

  • factor (float) – Rolloff factor.

    • -

  • room_factor (float) – Room rolloff factor, default to 0 which disables -distance attenuation for send paths. This is because -the reverb engine will, by default, apply a more realistic -room decay based on the reverb decay time and distance.

    • -
-

-
-
Raises
-

ValueError – If either of rolloff factors is set to a negative value.

-
-
-
- -
-
-property sends
-

Collection of send path signals.

-

Send paths can be retrieved using a nonnegative index, which has -no effect if not less than the device’s max_auxiliary_sends.

-

Each send path has two write-only descriptors, -effect and filter.

-

Examples

-
>>> source.sends[0].effect = effect
->>> source.sends[1].filter = 1, 0.6, 0.9
-
-
-
- -
-
-spatialize
-

Whether to enable 3D spatialization.

-

Either True (the source always has 3D spatialization -features), False (never has 3D spatialization features), -or None (spatialization is enabled based on playing -a mono sound or not, default).

-

This has no effect without -AL_SOFT_source_spatialize extension.

-
- -
-
-stereo_angles
-

Left and right channel angles, in radians.

-

The angles go counter-clockwise, with 0 being in front -and positive values going left.

-

This is only used for stereo playback and has no effect -without AL_EXT_STEREO_ANGLES extension.

-
- -
-
-stop() → None
-

Stop playback, releasing the buffer or decoder reference.

-
- -
-
-velocity
-

3D velocity in units per second.

-

As with OpenAL, this does not actually alter the source’s -position, and instead just alters the pitch as determined -by the doppler effect.

-
- -
- -
-
-

Source Groups

-
-
-class palace.SourceGroup
-

A group of Source references.

-

For instance, setting SourceGroup.gain to 0.5 will halve the gain -of all sources in the group.

-

This can be used as a context manager that calls destroy upon -completion of the block, even if an error occurs.

-
-
Parameters
-

context (Optional[Context], optional) – The context from which the source group is to be created. -By default current_context() is used.

-
-
Raises
-

RuntimeError – If there is neither any context specified nor current.

-
-
-
-
-destroy() → None
-

Destroy the source group, remove and free all sources.

-
- -
-
-gain
-

Source group gain.

-

This accumulates with its sources’ and sub-groups’ gain.

-
- -
-
-parent_group
-

The parent source group of this source group.

-
-
Raises
-

RuntimeException – If this group is being added to its sub-group - (i.e. it would create a circular sub-group chain).

-
-
-
- -
-
-pause_all() → None
-

Pause all currently-playing sources under this group.

-

This is done recursively, including sub-groups.

-
- -
-
-pitch
-

Source group pitch.

-

This accumulates with its sources’ and sub-groups’ pitch.

-
- -
-
-resume_all() → None
-

Resume all currently-playing sources under this group.

-

This is done recursively, including sub-groups.

-
- -
-
-property sources
-

Sources under this group.

-
- -
-
-stop_all() → None
-

Stop all currently-playing sources under this group.

-

This is done recursively, including sub-groups.

-
- -
-
-property sub_groups
-

Source groups under this group.

-
- -
- -
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/search.html b/html/search.html deleted file mode 100644 index f19ef55..0000000 --- a/html/search.html +++ /dev/null @@ -1,137 +0,0 @@ - - - - - - - - Search — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -

Search

-
- -

- Please activate JavaScript to enable the search - functionality. -

-
-

- Searching for multiple words only shows matches that contain - all words. -

-
- - - -
- -
- -
- -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/html/searchindex.js b/html/searchindex.js deleted file mode 100644 index 67329f7..0000000 --- a/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["contributing","copying","design","index","installation","reference/buffer","reference/context","reference/decoder","reference/device","reference/effect","reference/file-io","reference/index","reference/source","tutorial/context","tutorial/index","tutorial/play-audio","tutorial/source"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["contributing.rst","copying.rst","design.rst","index.rst","installation.rst","reference/buffer.rst","reference/context.rst","reference/decoder.rst","reference/device.rst","reference/effect.rst","reference/file-io.rst","reference/index.rst","reference/source.rst","tutorial/context.rst","tutorial/index.rst","tutorial/play-audio.rst","tutorial/source.rst"],objects:{"palace.BaseDecoder":{channel_config:[7,1,1,""],frequency:[7,1,1,""],length:[7,1,1,""],loop_points:[7,1,1,""],read:[7,1,1,""],sample_type:[7,1,1,""],seek:[7,1,1,""]},"palace.BaseEffect":{destroy:[9,1,1,""],slot_gain:[9,1,1,""],source_sends:[9,1,1,""],use_count:[9,1,1,""]},"palace.Buffer":{channel_config:[5,1,1,""],destroy:[5,1,1,""],frequency:[5,1,1,""],from_decoder:[5,1,1,""],length:[5,1,1,""],length_seconds:[5,1,1,""],loop_points:[5,2,1,""],name:[5,2,1,""],play:[5,1,1,""],sample_type:[5,1,1,""],size:[5,1,1,""],source_count:[5,1,1,""],sources:[5,1,1,""]},"palace.ChorusEffect":{delay:[9,2,1,""],depth:[9,2,1,""],feedback:[9,2,1,""],phase:[9,2,1,""],waveform:[9,2,1,""]},"palace.Context":{async_wake_interval:[6,2,1,""],available_resamplers:[6,1,1,""],default_resampler_index:[6,1,1,""],destroy:[6,1,1,""],device:[6,2,1,""],distance_model:[6,1,1,""],doppler_factor:[6,1,1,""],end_batch:[6,1,1,""],is_supported:[6,1,1,""],listener:[6,2,1,""],message_handler:[6,2,1,""],speed_of_sound:[6,1,1,""],start_batch:[6,1,1,""],update:[6,1,1,""]},"palace.Decoder":{channel_config:[7,1,1,""],frequency:[7,1,1,""],length:[7,1,1,""],length_seconds:[7,1,1,""],loop_points:[7,1,1,""],play:[7,1,1,""],read:[7,1,1,""],sample_type:[7,1,1,""],seek:[7,1,1,""]},"palace.Device":{alc_version:[8,1,1,""],basic_name:[8,1,1,""],clock_time:[8,1,1,""],close:[8,1,1,""],current_hrtf:[8,1,1,""],efx_version:[8,1,1,""],frequency:[8,1,1,""],hrtf_enabled:[8,1,1,""],hrtf_names:[8,1,1,""],max_auxiliary_sends:[8,1,1,""],name:[8,1,1,""],pause_dsp:[8,1,1,""],query_extension:[8,1,1,""],reset:[8,1,1,""],resume_dsp:[8,1,1,""]},"palace.FileIO":{close:[10,1,1,""],read:[10,1,1,""],seek:[10,1,1,""]},"palace.Listener":{gain:[6,1,1,""],meters_per_unit:[6,1,1,""],orientation:[6,1,1,""],position:[6,1,1,""],velocity:[6,1,1,""]},"palace.MessageHandler":{buffer_loading:[6,1,1,""],device_disconnected:[6,1,1,""],resource_not_found:[6,1,1,""],source_force_stopped:[6,1,1,""],source_stopped:[6,1,1,""]},"palace.ReverbEffect":{air_absorption_gain_hf:[9,2,1,""],decay_hf_limit:[9,2,1,""],decay_hf_ratio:[9,2,1,""],decay_lf_ratio:[9,2,1,""],decay_time:[9,2,1,""],density:[9,2,1,""],diffusion:[9,2,1,""],echo_depth:[9,2,1,""],echo_time:[9,2,1,""],gain:[9,2,1,""],gain_hf:[9,2,1,""],gain_lf:[9,2,1,""],hf_reference:[9,2,1,""],late_reverb_delay:[9,2,1,""],late_reverb_gain:[9,2,1,""],late_reverb_pan:[9,2,1,""],lf_reference:[9,2,1,""],modulation_depth:[9,2,1,""],modulation_time:[9,2,1,""],reflections_delay:[9,2,1,""],reflections_gain:[9,2,1,""],reflections_pan:[9,2,1,""],room_rolloff_factor:[9,2,1,""],send_auto:[9,1,1,""]},"palace.Source":{air_absorption_factor:[12,2,1,""],cone_angles:[12,2,1,""],destroy:[12,1,1,""],distance_range:[12,2,1,""],doppler_factor:[12,2,1,""],fade_out_to_stop:[12,1,1,""],filter:[12,1,1,""],gain:[12,2,1,""],gain_auto:[12,2,1,""],gain_range:[12,2,1,""],group:[12,2,1,""],latency:[12,1,1,""],latency_seconds:[12,1,1,""],looping:[12,2,1,""],offset:[12,2,1,""],offset_seconds:[12,1,1,""],orientation:[12,2,1,""],outer_cone_gains:[12,2,1,""],pause:[12,1,1,""],paused:[12,1,1,""],pitch:[12,2,1,""],playing:[12,1,1,""],position:[12,2,1,""],priority:[12,2,1,""],radius:[12,2,1,""],relative:[12,2,1,""],resampler_index:[12,2,1,""],resume:[12,1,1,""],rolloff_factors:[12,2,1,""],sends:[12,1,1,""],spatialize:[12,2,1,""],stereo_angles:[12,2,1,""],stop:[12,1,1,""],velocity:[12,2,1,""]},"palace.SourceGroup":{destroy:[12,1,1,""],gain:[12,2,1,""],parent_group:[12,2,1,""],pause_all:[12,1,1,""],pitch:[12,2,1,""],resume_all:[12,1,1,""],sources:[12,1,1,""],stop_all:[12,1,1,""],sub_groups:[12,1,1,""]},palace:{BaseDecoder:[7,0,1,""],BaseEffect:[9,0,1,""],Buffer:[5,0,1,""],CHANNEL_CONFIG:[6,3,1,""],ChorusEffect:[9,0,1,""],Context:[6,0,1,""],Decoder:[7,0,1,""],Device:[8,0,1,""],FREQUENCY:[6,3,1,""],FileIO:[10,0,1,""],HRTF:[6,3,1,""],HRTF_ID:[6,3,1,""],Listener:[6,0,1,""],MAX_AUXILIARY_SENDS:[6,3,1,""],MONO_SOURCES:[6,3,1,""],MessageHandler:[6,0,1,""],OUTPUT_LIMITER:[6,3,1,""],ReverbEffect:[9,0,1,""],SAMPLE_TYPE:[6,3,1,""],STEREO_SOURCES:[6,3,1,""],Source:[12,0,1,""],SourceGroup:[12,0,1,""],cache:[5,4,1,""],channel_configs:[7,3,1,""],current_context:[6,4,1,""],current_fileio:[10,4,1,""],decode:[7,4,1,""],decoder_factories:[7,3,1,""],device_names:[8,3,1,""],distance_models:[6,3,1,""],free:[5,4,1,""],query_extension:[8,4,1,""],reverb_preset_names:[9,3,1,""],sample_length:[7,4,1,""],sample_size:[7,4,1,""],sample_types:[7,3,1,""],thread_local:[6,4,1,""],use_context:[6,4,1,""],use_fileio:[10,4,1,""]}},objnames:{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","data","Python data"],"4":["py","function","Python function"]},objtypes:{"0":"py:class","1":"py:method","2":"py:attribute","3":"py:data","4":"py:function"},terms:{"004":9,"016":9,"025":[15,16],"02__littl":1,"075":9,"1000":9,"104":12,"12000":[15,16],"128":12,"164957__zonkmachine__whit":1,"180":[9,12],"20000":9,"2038":0,"20hz":1,"20khz":1,"24741__tim":1,"257":0,"261590__kwahmah":1,"343":6,"353684__tec":1,"360":12,"544":10,"8192":10,"892":9,"99642__jobro__deconvolut":1,"abstract":[2,7,10],"break":0,"byte":[5,6,7,10],"case":[0,2,6,15],"class":[0,2,5,7,8,9,10,11,12,13],"default":[5,6,7,8,9,10,12,13,15,16],"final":[0,2,6],"float":[2,6,9,12],"function":[0,2,7,15,16],"import":[13,15,16],"int":[2,5,6,7,8,9,10,12],"long":0,"new":[0,2,5,6,7,10,15],"public":[0,1],"return":[2,5,6,7,8,9,10,12],"short":[0,6],"static":[1,5,10],"true":[6,12,16],"try":[2,6],"while":[0,2,7,8,15,16],But:15,For:[0,2,6,9,12,16],Its:12,NOT:7,Not:2,One:[2,5],That:15,The:[0,1,3,5,6,7,8,9,12,15,16],Then:[2,15],There:[0,6,12,13,15],These:0,Use:0,Using:11,With:2,__cinit__:2,__dealloc__:2,__doc__:2,__enter__:2,__exit__:2,__init__:2,__new__:2,abc:[2,7],abl:0,about:6,abov:[0,4,16],absorpt:[3,6,9,12,14],accept:0,access:[6,13],accompani:9,accord:[12,16],account:[0,2],accumul:12,accur:1,achiev:2,actual:[6,12],add:[0,9],added:12,addit:[0,1,12],addition:[0,4],address:0,adequ:2,adjust:[6,9,12],adopt:2,advis:0,affect:12,after:[0,7,8,12],against:[0,7],aiff:[1,3],air:[3,6,9,12,14],air_absorption_factor:[12,16],air_absorption_gain_hf:9,al_ext_bformat:12,al_ext_source_radiu:12,al_ext_stereo_angl:12,al_soft_loop_point:5,al_soft_source_lat:12,al_soft_source_resampl:[6,12],al_soft_source_spati:12,alc:8,alc_ext_disconnect:6,alc_ext_efx:[8,12],alc_ext_thread_local_context:6,alc_hrtf_id_soft:8,alc_soft_hrtf:8,alc_soft_pause_devic:8,alc_vers:8,alia:[2,5],alias:2,align:[0,16],all:[0,1,5,6,7,8,12,15],alloc:2,allow:[0,2,6,8,13],almost:15,along:6,alreadi:[0,5],also:[0,2,6,12],alter:[6,12],altern:5,although:[2,8,12],alur:[1,2,3,4],alwai:[0,7,12],amd64:4,angl:12,ani:[0,1,2,5,6,7,9,10,12,16],annot:0,anoth:[5,7,9,12],answer:[1,15],api:[2,3,7,11],appeal:0,appli:[6,8,9,12],applic:[6,7],appreci:0,appveyor:1,area:12,arg:[2,7,10],argument:6,around:[0,3],arrai:6,arriv:0,asid:4,ask:0,asset:1,assign:2,assum:[2,6],async_wake_interv:6,asynchron:[5,6,7],atmospher:[3,12,16],attach:0,attempt:6,attenu:[6,12],attr:[6,8],attribut:[0,1,8,11],audio:[2,3,9,10,11,12,13,14],author:0,autom:1,automat:[2,6,9,12,15,16],auxiliari:[8,11],avail:[0,6,7,8,12,13],available_resampl:6,avoid:[0,6],awar:0,axes:16,axi:16,back:[7,9,16],background:6,bad:2,bar:[0,2],base:[6,7,11,12],basedecod:[2,7],baseeffect:9,basic:8,basic_nam:8,batch:[6,11],baz:2,becaus:[0,2,6,7,12,15],been:[0,6,7],befor:[0,5,8,12,15],begin:0,behavior:6,being:[2,6,7,8,10,12],belong:[6,12],below:16,best:[0,1],between:9,binari:0,bit:[6,15],block:[2,5,8,9,12],bodi:0,bool:[2,6,7,8,12],bound:6,box:3,branch:0,breviti:9,broadcast:15,broken:0,bsd:1,buffer:[6,7,11,12,13],buffer_load:6,buffer_s:10,bug:3,build:[0,1,4],built:4,builtin:[2,11],bullet:0,bump:0,bundl:1,cach:[3,6,11],calcul:[6,12],call:[2,5,6,7,8,9,12],callabl:[2,10],can:[0,1,2,4,5,6,8,9,12,13,15,16],cannot:[5,6,9],captur:8,carri:0,categori:8,caus:6,cc0:1,cdef:2,certain:6,cfg:0,chain:12,chang:[0,6,15,16],channel:[6,7,12],channel_config:[5,6,7],charact:0,charg:1,check:[6,10,16],checkout:0,child:12,choru:11,choruseffect:9,chunk:[7,15],chunk_len:[7,15],cibuildwheel:1,circular:[12,16],clamp:[6,12],claus:1,clean:2,clever:2,clock:8,clock_tim:8,clockwis:12,clone:[0,4],close:[2,8,10],closer:6,closur:2,cmake:4,code:[0,13,15],codec:3,collect:[0,2,12],column:0,com:[0,4],come:[5,7,12],comma:0,command:0,comment:0,commit:0,common:3,compat:[4,10],compil:[0,4],complet:[5,8,9,12],compli:0,compon:[6,13],concis:2,cone:12,cone_angl:12,config:6,configur:[5,6,7],confus:2,congratul:15,connect:6,consid:2,consist:12,constant:0,constraint:9,construct:0,constructor:2,contact:1,contain:[0,6,13],context:[3,5,7,8,9,11,12,14,15,16],continu:[0,6],contribut:[0,1],contributor:0,control:[2,6],conveni:[0,3],convent:3,coordin:16,copi:[0,3],copyright:0,correctli:0,correspond:5,cos:16,cost:0,could:8,count:[2,5,7,8,10,16],counter:12,cppclass:2,cppdecod:2,cpython:[0,4],crack:2,creat:[0,2,5,6,7,8,9,10,12,14,16],creation:[3,8,11,14,15],credit:[0,3],ctx:[13,15],current:[4,5,6,7,8,9,10,12],current_context:[5,6,7,9,12],current_fileio:10,current_hrtf:[8,16],cut:0,cython:[1,2,3],cython_trac:0,dai:1,data:[1,3,6,7,15],dealloc:2,debug:0,dec:15,decai:[6,9,12],decay_hf_limit:9,decay_hf_ratio:9,decay_lf_ratio:9,decay_tim:9,declar:[0,2,13],decod:[2,5,10,11,12,14,16],decoder_factori:7,decodernamespac:7,decor:2,def:2,default_resampler_index:6,defin:[2,10],degre:12,delai:9,densiti:9,depend:[1,4,11],depth:9,deriv:[2,6,7],describ:0,descriptor:[2,3,12],deserv:0,design:3,desir:[9,15],despit:10,destroi:[5,6,8,9,12],destruct:2,destructioni:12,detail:[0,1,2,7,9],detect:6,determin:[6,12],dev:[2,13,15],develop:[0,1],devic:[2,3,6,11,12,14,15,16],device_disconnect:6,device_nam:[8,13],devicenam:8,devmgr:2,dict:[6,8],differ:6,difficult:0,diffus:9,direct:[6,12],direct_hf:12,directli:0,disabl:12,disconnect:6,discov:1,discuss:2,distanc:[6,12],distance_model:6,distance_rang:12,distribut:[0,4],divid:[11,15],doc:2,docstr:0,document:[0,1,2,9,15],doe:[0,2,6,8,12],doing:0,don:15,done:[2,12],dont_car:6,doppler:[6,12],doppler_factor:[6,12],dot:0,doubl:[0,3,6,9],down:2,downgrad:[],drier:16,drop:12,dry:16,dryer:12,dsp:9,duck:10,due:[2,5,7],dump:0,duplic:5,durat:12,dure:[6,7,12],dynam:1,each:[0,7,8,9,12,15],earlier:[0,10],eas:2,easi:2,eaxreverb:[],echo:9,echo_depth:9,echo_tim:9,editor:0,effect:[2,3,6,11,12,13,15,16],effici:2,effort:1,efx:8,efx_vers:8,either:[0,1,6,7,8,9,10,12],elsewher:7,emit:12,emploi:0,empti:[6,8],emul:9,enabl:[6,8,12,16],end:[0,5,6,7,10],end_batch:6,engin:12,enjoi:15,ensur:[0,1,5],entir:12,entri:6,environ:[3,6,13],environment:[3,11],equival:[2,5,6,9],error:[2,5,8,9,12],essenti:[9,13,15],etc:[0,2,3],even:[0,2,5,8,9,12],event:6,everi:6,everyth:[0,1],exactli:8,exampl:[0,5,12,16],exc:2,except:[0,2,5,6,7],exclus:[4,5,7],exist:[2,5,8],expect:[5,10,12],experi:1,explain:2,expos:2,extend:2,extens:[0,1,2,5,6,8,9,12],extern:[0,2],extra:12,extreamli:1,face:[0,12],facilit:0,factor:[6,9,12,14],factori:[7,10],fade:12,fade_out_to_stop:12,fail:[6,8],faith:1,fall:[7,9],fallback:[6,7,8],fals:[6,8,12],familiar:2,farther:6,fast:15,faster:12,featur:[2,3,12],fed:6,feed:0,feedback:9,feel:0,fetch:4,few:2,file:[0,3,5,7,11,14],fileio:10,filenam:[7,15],fill:15,filter:12,find:[0,15],fine:2,finit:10,first:[0,7,8,9,13,16],fix:[0,1],flac:[1,3],flt_max:12,foggi:[12,16],follow:[0,1,2,3,6,11,12],foo:[0,2],foobar:2,forc:6,forcefulli:[6,12],fork:0,form:0,format:[0,5],found:[6,9,13,16],foundat:1,frame:[5,7,12],free:[0,1,8,11,12],freed:5,freedom:0,frequenc:[5,6,7,8,9,12,16],frequent:7,friend:0,from:[0,1,2,3,5,6,7,8,9,10,12,13,15,16],from_baz:2,from_decod:5,front:[12,16],fset:2,full:8,fulli:0,further:9,furthermor:0,futur:8,gain:[6,9,12],gain_auto:12,gain_hf:[9,12],gain_lf:[9,12],gain_rang:12,garbag:2,gave:1,gener:[0,1,2,7,9,15,16],get:[3,6,15],get_available_resampl:12,getter:2,giant:0,git:[0,4],github:4,give:5,given:[5,6,7,8,12],glitch:1,global:[2,6],gnu:[0,1,4],goal:2,goe:[13,16],going:12,good:[0,2],great:0,greater:12,group:[3,6,11],guarante:12,guard:2,guid:[0,9,14],guidelin:3,had:6,half:[0,6],halv:12,hand:12,handl:[0,2,6,7],handler:6,hang:0,happen:[2,12],happi:1,hard:[1,2],hardwar:8,has:[0,2,6,7,9,12,15],have:[0,1,2,6,7,12,13,15,16],header:[0,4],hear:12,help:[0,1,4],here:[13,15],hertz:[5,6,7,8],hf_refer:9,high:[9,12,16],higher:[3,6,12,16],hijack:2,hint:3,holder:0,host:0,how:[0,13,15],howev:[0,6],hrtf:[3,6,8,16],hrtf_enabl:8,hrtf_id:6,hrtf_name:8,html:0,http:[0,4],humid:16,hyperlink:0,idea:[0,2],idiom:3,ignor:[5,6,7],imaginari:15,immedi:[1,6],impl:3,implement:[0,2,6,7,10],implicitli:15,improv:[0,7],incapacit:0,includ:[0,2,6,7,12],inclus:[5,7],incorrectli:1,increment:8,indent:0,independ:11,index:[3,6,8,12],indic:16,influenc:12,inform:0,inherit:2,initi:[5,6,7,9,12],inner:[2,12],input:[9,10],instal:[0,3],instanc:[6,7,9,10,12],instanti:13,instead:[0,2,6,7,12],instruct:0,integ:6,integr:0,intend:9,interfac:[2,3,6,11],intern:[5,7],interv:[6,12],intuit:2,invalid:[5,7],invers:6,involv:3,is_support:6,issu:[0,1,4],item:[0,8],iter:[5,6,8],itertool:16,its:[2,6,7,10,12,16],itself:0,just:[0,2,6,12,13,15],kahn__b23:1,keep:[0,6,7],kei:6,kept:5,kind:[0,2],kindli:1,know:15,kwarg:[2,7],kwd:10,lack:6,lambda:2,larg:[2,7],larger:7,last:16,late:9,late_reverb_delai:9,late_reverb_gain:9,late_reverb_pan:9,latenc:12,latency_second:12,later:[1,5],least:[0,2,6],left:[12,16],legal:0,len:[5,9],length:[5,7,15],length_second:[5,7],less:[1,2,7,12],lesser:1,let:15,level:[0,2,3,7,8,15],lexicograph:[7,9],lf_refer:9,lgpl2:1,lgplv2:1,lgplv3:0,librari:[1,2,3,10,11],libsndfil:1,licenc:0,licens:[0,3],light:1,like:[0,2,15],limit:[0,2,6,9,12],line:0,linear:12,link:1,linux:4,list:[0,1,4,6,8,9],listen:[6,12,16],littl:0,load:[6,7,11],local:[0,6],locat:[0,1],lock:2,log:0,logarithm:12,longer:[6,12],look:15,loop:[5,7,12,15],loop_point:[5,7],low:[9,12,16],lower:[8,12,16],lowest:12,luckili:2,machin:1,maco:4,made:[1,6],magnitud:9,mai:[0,2,5,6,7,8,12],mail:0,maintain:[0,1,6,13],make:[2,3,6],manag:[3,5,6,8,9,12],mani:[0,2,10],manipul:[3,14],manual:2,marker:0,markup:0,master:[0,6],match:8,max:6,max_auxiliary_send:[6,8,12],maxdist:12,maxgain:12,maximum:[0,6,8,12],mcsinyx:[0,4],mean:[0,2,12],meant:0,mechan:2,memori:[2,6,7],merg:0,merier:0,messag:[0,6],message_handl:6,messagehandl:6,meter:[6,12],meters_per_unit:6,meth:2,method:[2,6,7,10,15],middl:0,might:[2,10],millisecond:12,mingain:12,minimum:12,miscellan:11,mix:[6,8,9,12],model:[6,12],moder:0,modern:3,modifi:[0,1,16],modul:[0,1,3,7,9,10,15],modulation_depth:9,modulation_tim:9,mono:[6,12],mono_sourc:6,more:[0,2,5,6,7,9,12,16],most:[0,10,15,16],motion:16,move:[10,14],mp3:[1,3],much:[0,1,12],multi:0,multipl:[0,5,8],multipli:12,music:15,musician:9,must:[0,5,6,7,8,12,13],mutabl:6,mutablesequ:6,name:[0,2,3,5,6,7,8,9,10],namespac:[2,8],nanosecond:12,natur:[2,12],necessari:[0,7],necessarili:10,need:[0,2,4,5,6,12],neg:12,neither:[5,6,7,9,12],never:[0,1,12],next:15,nois:1,nomin:12,non:[6,8],none:[2,5,6,7,8,9,10,12],nonneg:12,nonposit:12,nor:[5,6,7,8,9,12],normal:16,note:[0,5,6,7,8,9,10,12],notic:[0,16],notifi:6,now:[0,2,13,15,16],nullari:2,number:[0,5,6,7,8,9,12,15,16],numpydoc:0,object:[2,5,6,7,14,15],obsolet:1,obstruct:3,obtain:0,occlus:3,occur:[5,6,8,9,12],octav:0,off:12,offset:[10,12],offset_second:12,often:0,ogg:[1,3,15,16],one:[0,4,5,6,7,8,12,16],ones:7,onli:[0,2,4,6,7,8,9,10,12,15],open:[1,3,6,8,9,12,13],open_playback:2,oper:[0,6],ops:6,option:[0,1,2,5,6,7,8,9,10,12,15],opu:[1,3],order:[0,2,7,8,9],orient:[6,12],origin:[6,9],other:[0,2,5,6,12],otherwis:[5,6],our:[0,1,4,16],ourselv:2,out:[0,3,6,12],outer:12,outer_cone_gain:12,output:[6,8,9],output_limit:6,outsid:[1,12],over:[0,12],overhead:6,packag:4,page:[0,3],pain:1,pair:9,palac:[0,1,2,3,4,5,6,7,8,9,10,12,13,15,16],paragraph:0,paramet:[5,6,7,8,9,10,12,13,15],parent:12,parent_group:12,part:[2,6,15],particip:0,particular:2,pascalcas:3,pass:[0,6,12,15],patch:3,path:12,paus:[8,12],pause_al:12,pause_dsp:8,pcm:[5,7],peopl:0,pep:[0,3,10],per:[0,6,12],perceptu:12,perform:2,period:0,permiss:0,pers:0,person:0,phase:9,phrase:0,pimpl:2,pip:[0,1,4],pitch:[6,12,14],place:7,plai:[0,2,3,5,6,7,8,9,12,14,16],plain:0,platform:0,playback:[7,8,12],pleas:[0,1,4,7],point:[2,5,6,7,12],port:8,pos:[2,7],posit:[3,6,10,12,15,16],possibl:2,practic:[2,12],precis:12,predefin:9,preempt:6,prefer:[0,6],preload:[5,7],prerequisit:3,preset:[6,9],previou:[0,6],previous:[8,16],principl:3,prior:0,prioriti:[6,12],probabl:4,problem:1,process:[0,6,8],processor:9,program:2,progress:0,promptli:1,prone:2,propag:6,properli:[0,4],properti:[5,6,7,8,9,12,15,16],proport:2,protect:[0,7],protocol:[6,10],provid:[0,1,2,3,6,10],publish:[0,1],pull:0,pun:9,pure:2,purpos:[6,9],push:0,put:2,py_decref:2,py_incref:2,pyo:2,pypi:[0,3],pyproject:4,pytest:0,python:[3,4,6,10],python_compil:0,python_vers:0,quad:6,queri:8,query_extens:8,queu:7,queue_siz:[7,15],quick:1,quickli:1,quot:[0,2],radian:12,radiu:12,rais:[5,6,7,8,9,12],rang:12,rate:[6,8],ratio:9,raw:1,reach:[5,6,7],read:[2,5,7,8,10,12],readabl:[0,2],reader:2,real:8,realist:[6,12],realli:0,reason:[0,6],rebas:0,rebuild:0,receiv:[0,6],recommend:[0,2,6],recurs:12,redistribut:1,reduc:6,reduct:6,refdist:12,refer:[0,3,6,8,9,12],referenc:2,reflect:9,reflections_delai:9,reflections_gain:9,reflections_pan:9,regardless:2,regist:[0,7],regularli:[6,12],rel:[0,6,8,10,12],relat:[0,1,6,12],releas:[3,12],relev:[0,6],reli:[2,6],reliabl:5,remain:6,remot:0,remov:[1,6,9,12],render:[0,3],renew:15,replai:9,report:3,repositori:[0,16],reproduc:0,request:[3,7],requir:[0,4,6,7,8,10,15],resampl:[6,12],resampler_index:12,reset:8,resourc:[2,3,6,7,11,12],resource_not_found:6,respect:[0,2,5],respons:1,restart:8,restor:2,restrict:6,result:[0,7,12],resum:[8,12],resume_al:12,resume_dsp:8,retain:[0,8],retriev:[5,8,12],reverb:[3,6,11,12],reverb_preset_nam:9,reverbeffect:9,reverber:9,revert:10,review:0,revok:0,right:[12,16],rolloff:[9,12],rolloff_factor:12,room:[9,12],room_factor:12,room_rolloff_factor:9,run:[0,1,4],runtim:4,runtimeerror:[5,6,7,8,9,12],runtimeexcept:12,runtimewarn:8,rush:15,safe:[2,3],safeti:2,sai:0,said:[2,16],sake:9,same:[2,5,9],sampl:[5,6,7,12],sample_length:7,sample_r:6,sample_s:7,sample_typ:[5,6,7],satisfi:9,save:2,scale:[6,12],schedul:5,script:0,sdist:0,search:[0,3],second:[5,6,7,12],section:[0,2,11,16],see:4,seek:[2,7,10],seekabl:10,seem:0,seen:[1,2],self:[0,2,5,9],send:[0,6,8,9,12],send_auto:9,send_hf:12,sent:0,sentenc:0,sequenc:6,servic:[0,1],set:[0,5,6,9,10,12,13,16],setter:2,setup:0,sever:[9,13],shared_ptr:2,shift:12,should:[0,2,5,6,12],show:0,sign:6,signal:[9,12],silent:6,similar:[0,1],simpl:[7,15,16],simpli:2,simplifi:2,simul:[12,16],simultan:[5,9],sin:16,sinc:[0,2,10,13],sine:9,singl:[0,12],size:[5,7,10],size_t:2,sleep:[15,16],slightli:9,slot:9,slot_gain:9,small:[0,15],smaller:7,smooth:12,snake_cas:3,soft:1,softwar:[0,1],solut:15,some:[2,6],some_audio:[15,16],someon:0,song:15,sound:[1,3,6,9,12,15],sourc:[0,1,3,5,6,7,8,9,11,13,14],source_count:5,source_force_stop:6,source_send:9,source_stop:6,sourcegroup:[6,12],space:[0,5,16],sparingli:0,spatial:[12,16],specif:[6,8],specifi:[5,6,7,8,9,12],speed:[6,14],speed_of_sound:6,sphere:12,sphinx:1,src:[15,16],standard:10,start:[0,5,6,7,8,9,10],start_batch:6,state:[2,6],statement:2,staticmethod:2,statu:6,step:16,stereo:[3,6,12,16],stereo_angl:12,stereo_sourc:6,still:[0,6,8],stop:[6,8,12],stop_al:[6,12],storag:5,store:7,str:[2,5,6,7,8,9,10],stream:[3,6,8,10,11,12],string:[0,6,8],studio__drip2:1,style:3,sub:[6,12],sub_group:12,subclass:6,submit:3,substitut:6,success:7,suggest:5,suit:0,superclass:7,support:[0,3,4,5,6,8],sure:[0,2],suspend:6,sync:0,system:[3,8,9,16],tag:0,take:[2,5,9,12,15],takewhil:16,talk:0,target:0,tear:2,term:1,test:[0,1],text:0,than:[0,2,5,6,7,12],thank:0,thei:0,them:[0,12],therefor:0,thereof:6,thi:[0,1,2,5,6,7,8,9,10,12,13,14,15,16],thicker:9,thought:0,thread:6,thread_loc:6,thu:2,ticket:0,time:[0,6,8,9,12,15,16],toml:4,too:[7,15,16],toolchain:1,tox:0,track:[0,6],tracker:[0,4],trail:0,travi:1,tri:[7,15],triangl:9,trigger:0,troubl:2,tupl:[6,7,8,9,12,16],tutori:[3,15],twine:0,two:[0,12],type:[0,2,3,5,6,7,10],typic:2,uint64_t:2,unavail:8,undefin:6,under:[0,1,12],underrun:7,understand:0,unfortun:2,unit:[6,12],unless:[0,12],unlik:12,unlock:2,unsigned_:6,unsupport:[5,6,8,12],until:[0,6],updat:[0,5,6,7,8,12,15,16],upload:0,upon:[5,6,8,9,12],ups:2,upstream:0,usabl:6,usag:9,use:[2,5,6,7,8,12,15,16],use_context:6,use_count:9,use_fileio:10,used:[0,1,2,5,6,7,8,9,10,12],useful:0,user:[0,2,7],uses:2,using:[0,1,3,5,7,8,9,12],usual:0,util:11,valid:6,valu:[6,7,9,12,16],valueerror:[6,7,9,12],variabl:[0,12],variou:[2,6],vector:9,veloc:[6,12],veri:[0,2,16],version:[0,1,4,8,9,10],via:[3,6,8,16],view:0,virtual:16,volum:[6,12],vorbi:[1,3],wai:0,wait:0,wake:6,want:[0,4,7,15,16],warn:8,wav:[1,3],waveform:9,welcom:0,well:[0,2,6,13,16],were:6,what:[0,5],whatev:2,wheel:[0,1,4],when:[5,6,12,13,15],whenc:10,whenev:2,where:[0,12],whether:[6,8,9,12],which:[0,1,2,5,6,7,9,12,13,15],who:[0,1],whose:[1,8,15],window:4,wish:0,within:[0,2,12],without:[1,2,6,12],won:6,work:[0,1,2,10,13,16],would:[0,1,2,6,12],wrap:[2,3],wrapper:[2,6],write:[2,12,16],written:[15,16],x51:6,x61:6,x71:6,you:[0,1,4,5,6,13,14,15,16],your:[0,1,13,15],your_github_usernam:0,zen:2,zero:[7,9],zlib:1},titles:["Getting Involved","Copying","Design Principles","Overview","Installation","Resource Caching","Audio Library Contexts","Audio Streams","Audio Devices","Environmental Effects","File I/O Interface","Reference","Sources & Source Groups","Context Creation","Tutorial","Play an Audio","Source Manipulation"],titleterms:{"class":6,The:2,Using:[0,6],absorpt:16,air:16,attribut:[2,6],audio:[5,6,7,8,15],auxiliari:6,base:9,batch:5,buffer:5,bug:0,builtin:7,cach:5,choru:9,content:3,context:[2,6,13],copi:1,creat:[13,15],creation:[6,13],credit:1,cython:0,decod:[7,15],depend:8,design:2,devic:[8,13],doubl:2,effect:9,email:0,environment:9,factor:16,featur:0,file:[10,15],free:5,from:4,get:0,github:0,group:12,guidelin:0,idiom:2,impl:2,independ:8,indic:3,instal:4,interfac:[7,10],involv:0,librari:6,licens:1,load:5,make:0,manag:2,manipul:16,miscellan:7,modern:2,move:16,object:13,overview:3,patch:0,pitch:16,plai:15,prerequisit:4,principl:2,properti:2,pypi:4,python:[0,2],refer:[2,11],releas:0,report:0,request:0,resourc:5,restructuredtext:0,reverb:9,sourc:[4,12,15,16],speed:16,stream:7,style:0,submit:0,tabl:3,tutori:14,util:8,via:[0,4]}}) \ No newline at end of file diff --git a/html/tutorial/context.html b/html/tutorial/context.html deleted file mode 100644 index a4b1bb6..0000000 --- a/html/tutorial/context.html +++ /dev/null @@ -1,181 +0,0 @@ - - - - - - - - Context Creation — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Context Creation

-

A context is an object that allows palace to access OpenAL, -which is essential when you work with palace. Context maintains -the audio environment and contains environment settings and components -such as sources, buffers, and effects.

-
-

Creating a Device Object

-

To create a context, we must first create a device, -since it’s a parameter of the context object.

-

To create an object, well, you just have to instantiate -the Device class.

-
from palace import Device
-
-with Device() as dev:
-    # Your code goes here
-
-
-

This is how you declare a Device object with the default device. -There can be several devices available, which can be found -in device_names.

-
-
-

Creating a Context

-

Now that we’ve created a device, we can create the context:

-
from palace import Device, Context
-
-with Device() as dev, Context(dev) as ctx:
-    # Your code goes here
-
-
-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/tutorial/index.html b/html/tutorial/index.html deleted file mode 100644 index 9f7b4f0..0000000 --- a/html/tutorial/index.html +++ /dev/null @@ -1,172 +0,0 @@ - - - - - - - - Tutorial — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- - - - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/tutorial/play-audio.html b/html/tutorial/play-audio.html deleted file mode 100644 index 5ad925d..0000000 --- a/html/tutorial/play-audio.html +++ /dev/null @@ -1,230 +0,0 @@ - - - - - - - - Play an Audio — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Play an Audio

-

Now that you know how to create a context, -let’s get into the most essential use case: playing audio.

-
-

Creating a Source

-

To play an audio, you have to create a source. This source -is an imaginary sound broadcaster, whose positions and properties -can be changed to create desired effects.

-
from palace import Device, Context, Source
-
-with Device() as dev, Context(dev) as ctx:
-    with Source() as src:
-        # to be written
-
-
-

Just like for the case of Context, Source creation -requires a context, but here the context is passed implicitly.

-
-
-

Decode the Audio File

-

Palace has a module level function decode(), which decodes audio file -automatically, and this decoded file is a Decoder object. This object -can be played by a simple Decoder.play() method.

-
from palace import Device, Context, Source, decode
-
-filename = 'some_audio.ogg'
-with Device() as dev, Context(dev) as ctx:
-    with Source() as src:
-        dec = decode(filename)
-
-
-

We are almost there. Now, let’s look at the document for Decoder.play(). -The method takes 3 parameters: chunk_len, queue_size, and source.

-

The source object is optional, because if you don’t have it, a new source -will be generated by default.

-

The audio is divided into chunks, each of which is of length chunk_len. -Then queue_size is the number of these chunks that it will play.

-
from palace import Device, Context, Source, decode
-
-filename = 'some_audio.ogg'
-with Device() as dev, Context(dev) as ctx:
-    with Source() as src:
-        dec = decode(filename)
-        dec.play(12000, 4, src)
-
-
-

But we don’t want it to play only a small part of the audio. We want it to -play all of it. How do we do that? The answer is a loop.

-

There is a method, Context.update(), which update the context and the source. -When the source is updated, it will be filled with new chunks of data from -the decoder.

-
from palace import Device, Context, Source, decode
-
-filename = 'some_audio.ogg'
-with Device() as dev, Context(dev) as ctx:
-    with Source() as src:
-        dec = decode(filename)
-        dec.play(12000, 4, src)
-        while src.playing:
-            ctx.update()
-
-
-

If you tried this code for a song, you will find that it’s a bit rush. -That is because the source is renewed too fast. So, a simple solution -is to sleep for a while.

-
from time import sleep
-from palace import Device, Context, Source, decode
-
-filename = 'some_audio.ogg'
-with Device() as dev, Context(dev) as ctx:
-    with Source() as src:
-        dec = decode(filename)
-        dec.play(12000, 4, src)
-        while src.playing:
-            sleep(0.025)
-            ctx.update()
-
-
-

Congratulation! Enjoy your music before we get to the next part of this tutorial.

-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/html/tutorial/source.html b/html/tutorial/source.html deleted file mode 100644 index dc93a6a..0000000 --- a/html/tutorial/source.html +++ /dev/null @@ -1,216 +0,0 @@ - - - - - - - - Source Manipulation — palace 0.2.1 documentation - - - - - - - - - - - - - - - - - - -
- - -
-
-
-   - -
- - -
- -
-

Source Manipulation

-

We have created a source in the last section. -As said previously, its properties can be manipulated to create wanted effects.

-
-

Moving the Source

-

Changing Source.position is one of the most noticeable, -but first, we have to enable spatialization via Source.spatialize.

-
from time import sleep
-from palace import Device, Context, Source, decode
-
-with Device() as device, Context(device) as context, Source() as source:
-    source.spatialize = True
-    decoder = decode('some_audio.ogg')
-    decoder.play(12000, 4, source)
-    while source.playing:
-        sleep(0.025)
-        context.update()
-
-
-

Now, we can set the position of the source in this virtual 3D space. -The position is a 3-tuple indicating the coordinate of the source. -The axes are aligned according to the normal coordinate system:

-
    -

  • The x-axis goes from left to right

    • -

  • The y-axis goes from below to above

    • -

  • The z-axis goes from front to back

    • -
-

For example, this will set the source above the listener:

-
src.position = 0, 1, 0
-
-
-
-

Note

-

For this too work for stereo, you have to have HRTF enabled. -You can check that via Device.current_hrtf.

-
-

You can as well use a function to move the source automatically by writing -a function that generate positions. A simple example is circular motion.

-
from itertools import takewhile, count
-...
-for i in takewhile(src.playing, count(step=0.025)):
-    source.position = sin(i), 0, cos(-i)
-    ...
-
-
-

A more well-written example of this can be found in our repository.

-
-
-

Speed and Pitch

-

Modifying pitch changes the playing speed, effectively changing -pitch. Pitch can be any positive number.

-
src.pitch = 2    # high pitch
-src.pitch = 0.4  # low pitch
-
-
-
-
-

Air Absorption Factor

-

Source.air_absorption_factor simulates atmospheric high-frequency -air absorption. Higher values simulate foggy air and lower values simulate -drier air.

-
src.air_absorption_factor = 9  # very high humidity
-src.air_absorption_factor = 0  # dry air (default)
-
-
-
-
- - -
-
-   - -
- -
-
-
-
-
- ©2019, 2020 Nguyễn Gia Phong et al. - - | - Powered by Sphinx 3.2.1 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/index.html b/index.html deleted file mode 100644 index 8507650..0000000 --- a/index.html +++ /dev/null @@ -1,2 +0,0 @@ - - diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 30ca1e0..0000000 --- a/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -palace -sphinx >= 3.2 diff --git a/src/conf.py b/src/conf.py deleted file mode 100644 index 8ce991e..0000000 --- a/src/conf.py +++ /dev/null @@ -1,67 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'palace' -copyright = '2019, 2020 Nguyễn Gia Phong et al' -author = 'Nguyễn Gia Phong et al.' - -# The full version, including alpha/beta/rc tags -release = '0.2.1' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.napoleon'] - -napoleon_google_docstring = False - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -html_sidebars = { - '**': ['globaltoc.html', 'quicknav.html', 'searchbox.html']} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] -html_theme_options = {'fixed_sidebar': True, 'show_relbars': True} - - -# -- Options for LaTeX output ------------------------------------------------ - -latex_elements = dict(papersize='a4paper', - fontpkg='\\usepackage{lmodern}', - babel='\\usepackage[english,vietnamese]{babel}')