From 38b1b37da0a3be8e486a826206a6f0cbf49ef00c Mon Sep 17 00:00:00 2001 From: Jacob Alexander Date: Sun, 14 Jun 2020 16:55:26 -0700 Subject: [PATCH] Updating docs for v1.0.0b2 --- _modules/importlib/_bootstrap.html | 1261 ++++ _modules/index.html | 82 +- _sources/capnp.rst.txt | 198 + _sources/index.rst.txt | 19 + _sources/install.rst.txt | 97 + _sources/quickstart.rst.txt | 720 ++ _static/basic.css | 372 +- _static/doctools.js | 109 +- _static/documentation_options.js | 12 + _static/file.png | Bin 392 -> 286 bytes _static/jquery-3.5.1.js | 10872 +++++++++++++++++++++++++++ _static/jquery.js | 4 +- _static/language_data.js | 297 + _static/minus.png | Bin 199 -> 90 bytes _static/nature.css | 23 +- _static/plus.png | Bin 199 -> 90 bytes _static/pygments.css | 6 + _static/searchtools.js | 385 +- _static/underscore-1.3.1.js | 999 +++ capnp.html | 2542 ++++--- genindex.html | 944 ++- index.html | 151 +- install.html | 214 +- objects.inv | Bin 1025 -> 1384 bytes py-modindex.html | 87 +- quickstart.html | 821 +- search.html | 81 +- searchindex.js | 2 +- 28 files changed, 17887 insertions(+), 2411 deletions(-) create mode 100644 _modules/importlib/_bootstrap.html create mode 100644 _sources/capnp.rst.txt create mode 100644 _sources/index.rst.txt create mode 100644 _sources/install.rst.txt create mode 100644 _sources/quickstart.rst.txt create mode 100644 _static/documentation_options.js create mode 100644 _static/jquery-3.5.1.js create mode 100644 _static/language_data.js create mode 100644 _static/underscore-1.3.1.js diff --git a/_modules/importlib/_bootstrap.html b/_modules/importlib/_bootstrap.html new file mode 100644 index 0000000..17bb312 --- /dev/null +++ b/_modules/importlib/_bootstrap.html @@ -0,0 +1,1261 @@ + + + + + + + + importlib._bootstrap — capnp 1.0.0b2 documentation + + + + + + + + + + + + +
+
+
+
+ +

Source code for importlib._bootstrap

+"""Core implementation of import.
+
+This module is NOT meant to be directly imported! It has been designed such
+that it can be bootstrapped into Python as the implementation of import. As
+such it requires the injection of specific modules and attributes in order to
+work. One should use importlib as the public-facing version of this module.
+
+"""
+#
+# IMPORTANT: Whenever making changes to this module, be sure to run a top-level
+# `make regen-importlib` followed by `make` in order to get the frozen version
+# of the module updated. Not doing so will result in the Makefile to fail for
+# all others who don't have a ./python around to freeze the module
+# in the early stages of compilation.
+#
+
+# See importlib._setup() for what is injected into the global namespace.
+
+# When editing this code be aware that code executed at import time CANNOT
+# reference any injected objects! This includes not only global code but also
+# anything specified at the class level.
+
+# Bootstrap-related code ######################################################
+
+_bootstrap_external = None
+
+def _wrap(new, old):
+    """Simple substitute for functools.update_wrapper."""
+    for replace in ['__module__', '__name__', '__qualname__', '__doc__']:
+        if hasattr(old, replace):
+            setattr(new, replace, getattr(old, replace))
+    new.__dict__.update(old.__dict__)
+
+
+def _new_module(name):
+    return type(sys)(name)
+
+
+# Module-level locking ########################################################
+
+# A dict mapping module names to weakrefs of _ModuleLock instances
+# Dictionary protected by the global import lock
+_module_locks = {}
+# A dict mapping thread ids to _ModuleLock instances
+_blocking_on = {}
+
+
+class _DeadlockError(RuntimeError):
+    pass
+
+
+class _ModuleLock:
+    """A recursive lock implementation which is able to detect deadlocks
+    (e.g. thread 1 trying to take locks A then B, and thread 2 trying to
+    take locks B then A).
+    """
+
+    def __init__(self, name):
+        self.lock = _thread.allocate_lock()
+        self.wakeup = _thread.allocate_lock()
+        self.name = name
+        self.owner = None
+        self.count = 0
+        self.waiters = 0
+
+    def has_deadlock(self):
+        # Deadlock avoidance for concurrent circular imports.
+        me = _thread.get_ident()
+        tid = self.owner
+        while True:
+            lock = _blocking_on.get(tid)
+            if lock is None:
+                return False
+            tid = lock.owner
+            if tid == me:
+                return True
+
+    def acquire(self):
+        """
+        Acquire the module lock.  If a potential deadlock is detected,
+        a _DeadlockError is raised.
+        Otherwise, the lock is always acquired and True is returned.
+        """
+        tid = _thread.get_ident()
+        _blocking_on[tid] = self
+        try:
+            while True:
+                with self.lock:
+                    if self.count == 0 or self.owner == tid:
+                        self.owner = tid
+                        self.count += 1
+                        return True
+                    if self.has_deadlock():
+                        raise _DeadlockError('deadlock detected by %r' % self)
+                    if self.wakeup.acquire(False):
+                        self.waiters += 1
+                # Wait for a release() call
+                self.wakeup.acquire()
+                self.wakeup.release()
+        finally:
+            del _blocking_on[tid]
+
+    def release(self):
+        tid = _thread.get_ident()
+        with self.lock:
+            if self.owner != tid:
+                raise RuntimeError('cannot release un-acquired lock')
+            assert self.count > 0
+            self.count -= 1
+            if self.count == 0:
+                self.owner = None
+                if self.waiters:
+                    self.waiters -= 1
+                    self.wakeup.release()
+
+    def __repr__(self):
+        return '_ModuleLock({!r}) at {}'.format(self.name, id(self))
+
+
+class _DummyModuleLock:
+    """A simple _ModuleLock equivalent for Python builds without
+    multi-threading support."""
+
+    def __init__(self, name):
+        self.name = name
+        self.count = 0
+
+    def acquire(self):
+        self.count += 1
+        return True
+
+    def release(self):
+        if self.count == 0:
+            raise RuntimeError('cannot release un-acquired lock')
+        self.count -= 1
+
+    def __repr__(self):
+        return '_DummyModuleLock({!r}) at {}'.format(self.name, id(self))
+
+
+class _ModuleLockManager:
+
+    def __init__(self, name):
+        self._name = name
+        self._lock = None
+
+    def __enter__(self):
+        self._lock = _get_module_lock(self._name)
+        self._lock.acquire()
+
+    def __exit__(self, *args, **kwargs):
+        self._lock.release()
+
+
+# The following two functions are for consumption by Python/import.c.
+
+def _get_module_lock(name):
+    """Get or create the module lock for a given module name.
+
+    Acquire/release internally the global import lock to protect
+    _module_locks."""
+
+    _imp.acquire_lock()
+    try:
+        try:
+            lock = _module_locks[name]()
+        except KeyError:
+            lock = None
+
+        if lock is None:
+            if _thread is None:
+                lock = _DummyModuleLock(name)
+            else:
+                lock = _ModuleLock(name)
+
+            def cb(ref, name=name):
+                _imp.acquire_lock()
+                try:
+                    # bpo-31070: Check if another thread created a new lock
+                    # after the previous lock was destroyed
+                    # but before the weakref callback was called.
+                    if _module_locks.get(name) is ref:
+                        del _module_locks[name]
+                finally:
+                    _imp.release_lock()
+
+            _module_locks[name] = _weakref.ref(lock, cb)
+    finally:
+        _imp.release_lock()
+
+    return lock
+
+
+def _lock_unlock_module(name):
+    """Acquires then releases the module lock for a given module name.
+
+    This is used to ensure a module is completely initialized, in the
+    event it is being imported by another thread.
+    """
+    lock = _get_module_lock(name)
+    try:
+        lock.acquire()
+    except _DeadlockError:
+        # Concurrent circular import, we'll accept a partially initialized
+        # module object.
+        pass
+    else:
+        lock.release()
+
+# Frame stripping magic ###############################################
+def _call_with_frames_removed(f, *args, **kwds):
+    """remove_importlib_frames in import.c will always remove sequences
+    of importlib frames that end with a call to this function
+
+    Use it instead of a normal call in places where including the importlib
+    frames introduces unwanted noise into the traceback (e.g. when executing
+    module code)
+    """
+    return f(*args, **kwds)
+
+
+def _verbose_message(message, *args, verbosity=1):
+    """Print the message to stderr if -v/PYTHONVERBOSE is turned on."""
+    if sys.flags.verbose >= verbosity:
+        if not message.startswith(('#', 'import ')):
+            message = '# ' + message
+        print(message.format(*args), file=sys.stderr)
+
+
+def _requires_builtin(fxn):
+    """Decorator to verify the named module is built-in."""
+    def _requires_builtin_wrapper(self, fullname):
+        if fullname not in sys.builtin_module_names:
+            raise ImportError('{!r} is not a built-in module'.format(fullname),
+                              name=fullname)
+        return fxn(self, fullname)
+    _wrap(_requires_builtin_wrapper, fxn)
+    return _requires_builtin_wrapper
+
+
+def _requires_frozen(fxn):
+    """Decorator to verify the named module is frozen."""
+    def _requires_frozen_wrapper(self, fullname):
+        if not _imp.is_frozen(fullname):
+            raise ImportError('{!r} is not a frozen module'.format(fullname),
+                              name=fullname)
+        return fxn(self, fullname)
+    _wrap(_requires_frozen_wrapper, fxn)
+    return _requires_frozen_wrapper
+
+
+# Typically used by loader classes as a method replacement.
+def _load_module_shim(self, fullname):
+    """Load the specified module into sys.modules and return it.
+
+    This method is deprecated.  Use loader.exec_module instead.
+
+    """
+    spec = spec_from_loader(fullname, self)
+    if fullname in sys.modules:
+        module = sys.modules[fullname]
+        _exec(spec, module)
+        return sys.modules[fullname]
+    else:
+        return _load(spec)
+
+# Module specifications #######################################################
+
+def _module_repr(module):
+    # The implementation of ModuleType.__repr__().
+    loader = getattr(module, '__loader__', None)
+    if hasattr(loader, 'module_repr'):
+        # As soon as BuiltinImporter, FrozenImporter, and NamespaceLoader
+        # drop their implementations for module_repr. we can add a
+        # deprecation warning here.
+        try:
+            return loader.module_repr(module)
+        except Exception:
+            pass
+    try:
+        spec = module.__spec__
+    except AttributeError:
+        pass
+    else:
+        if spec is not None:
+            return _module_repr_from_spec(spec)
+
+    # We could use module.__class__.__name__ instead of 'module' in the
+    # various repr permutations.
+    try:
+        name = module.__name__
+    except AttributeError:
+        name = '?'
+    try:
+        filename = module.__file__
+    except AttributeError:
+        if loader is None:
+            return '<module {!r}>'.format(name)
+        else:
+            return '<module {!r} ({!r})>'.format(name, loader)
+    else:
+        return '<module {!r} from {!r}>'.format(name, filename)
+
+
+class ModuleSpec:
+    """The specification for a module, used for loading.
+
+    A module's spec is the source for information about the module.  For
+    data associated with the module, including source, use the spec's
+    loader.
+
+    `name` is the absolute name of the module.  `loader` is the loader
+    to use when loading the module.  `parent` is the name of the
+    package the module is in.  The parent is derived from the name.
+
+    `is_package` determines if the module is considered a package or
+    not.  On modules this is reflected by the `__path__` attribute.
+
+    `origin` is the specific location used by the loader from which to
+    load the module, if that information is available.  When filename is
+    set, origin will match.
+
+    `has_location` indicates that a spec's "origin" reflects a location.
+    When this is True, `__file__` attribute of the module is set.
+
+    `cached` is the location of the cached bytecode file, if any.  It
+    corresponds to the `__cached__` attribute.
+
+    `submodule_search_locations` is the sequence of path entries to
+    search when importing submodules.  If set, is_package should be
+    True--and False otherwise.
+
+    Packages are simply modules that (may) have submodules.  If a spec
+    has a non-None value in `submodule_search_locations`, the import
+    system will consider modules loaded from the spec as packages.
+
+    Only finders (see importlib.abc.MetaPathFinder and
+    importlib.abc.PathEntryFinder) should modify ModuleSpec instances.
+
+    """
+
+    def __init__(self, name, loader, *, origin=None, loader_state=None,
+                 is_package=None):
+        self.name = name
+        self.loader = loader
+        self.origin = origin
+        self.loader_state = loader_state
+        self.submodule_search_locations = [] if is_package else None
+
+        # file-location attributes
+        self._set_fileattr = False
+        self._cached = None
+
+    def __repr__(self):
+        args = ['name={!r}'.format(self.name),
+                'loader={!r}'.format(self.loader)]
+        if self.origin is not None:
+            args.append('origin={!r}'.format(self.origin))
+        if self.submodule_search_locations is not None:
+            args.append('submodule_search_locations={}'
+                        .format(self.submodule_search_locations))
+        return '{}({})'.format(self.__class__.__name__, ', '.join(args))
+
+    def __eq__(self, other):
+        smsl = self.submodule_search_locations
+        try:
+            return (self.name == other.name and
+                    self.loader == other.loader and
+                    self.origin == other.origin and
+                    smsl == other.submodule_search_locations and
+                    self.cached == other.cached and
+                    self.has_location == other.has_location)
+        except AttributeError:
+            return False
+
+    @property
+    def cached(self):
+        if self._cached is None:
+            if self.origin is not None and self._set_fileattr:
+                if _bootstrap_external is None:
+                    raise NotImplementedError
+                self._cached = _bootstrap_external._get_cached(self.origin)
+        return self._cached
+
+    @cached.setter
+    def cached(self, cached):
+        self._cached = cached
+
+    @property
+    def parent(self):
+        """The name of the module's parent."""
+        if self.submodule_search_locations is None:
+            return self.name.rpartition('.')[0]
+        else:
+            return self.name
+
+    @property
+    def has_location(self):
+        return self._set_fileattr
+
+    @has_location.setter
+    def has_location(self, value):
+        self._set_fileattr = bool(value)
+
+
+def spec_from_loader(name, loader, *, origin=None, is_package=None):
+    """Return a module spec based on various loader methods."""
+    if hasattr(loader, 'get_filename'):
+        if _bootstrap_external is None:
+            raise NotImplementedError
+        spec_from_file_location = _bootstrap_external.spec_from_file_location
+
+        if is_package is None:
+            return spec_from_file_location(name, loader=loader)
+        search = [] if is_package else None
+        return spec_from_file_location(name, loader=loader,
+                                       submodule_search_locations=search)
+
+    if is_package is None:
+        if hasattr(loader, 'is_package'):
+            try:
+                is_package = loader.is_package(name)
+            except ImportError:
+                is_package = None  # aka, undefined
+        else:
+            # the default
+            is_package = False
+
+    return ModuleSpec(name, loader, origin=origin, is_package=is_package)
+
+
+def _spec_from_module(module, loader=None, origin=None):
+    # This function is meant for use in _setup().
+    try:
+        spec = module.__spec__
+    except AttributeError:
+        pass
+    else:
+        if spec is not None:
+            return spec
+
+    name = module.__name__
+    if loader is None:
+        try:
+            loader = module.__loader__
+        except AttributeError:
+            # loader will stay None.
+            pass
+    try:
+        location = module.__file__
+    except AttributeError:
+        location = None
+    if origin is None:
+        if location is None:
+            try:
+                origin = loader._ORIGIN
+            except AttributeError:
+                origin = None
+        else:
+            origin = location
+    try:
+        cached = module.__cached__
+    except AttributeError:
+        cached = None
+    try:
+        submodule_search_locations = list(module.__path__)
+    except AttributeError:
+        submodule_search_locations = None
+
+    spec = ModuleSpec(name, loader, origin=origin)
+    spec._set_fileattr = False if location is None else True
+    spec.cached = cached
+    spec.submodule_search_locations = submodule_search_locations
+    return spec
+
+
+def _init_module_attrs(spec, module, *, override=False):
+    # The passed-in module may be not support attribute assignment,
+    # in which case we simply don't set the attributes.
+    # __name__
+    if (override or getattr(module, '__name__', None) is None):
+        try:
+            module.__name__ = spec.name
+        except AttributeError:
+            pass
+    # __loader__
+    if override or getattr(module, '__loader__', None) is None:
+        loader = spec.loader
+        if loader is None:
+            # A backward compatibility hack.
+            if spec.submodule_search_locations is not None:
+                if _bootstrap_external is None:
+                    raise NotImplementedError
+                _NamespaceLoader = _bootstrap_external._NamespaceLoader
+
+                loader = _NamespaceLoader.__new__(_NamespaceLoader)
+                loader._path = spec.submodule_search_locations
+                spec.loader = loader
+                # While the docs say that module.__file__ is not set for
+                # built-in modules, and the code below will avoid setting it if
+                # spec.has_location is false, this is incorrect for namespace
+                # packages.  Namespace packages have no location, but their
+                # __spec__.origin is None, and thus their module.__file__
+                # should also be None for consistency.  While a bit of a hack,
+                # this is the best place to ensure this consistency.
+                #
+                # See # https://docs.python.org/3/library/importlib.html#importlib.abc.Loader.load_module
+                # and bpo-32305
+                module.__file__ = None
+        try:
+            module.__loader__ = loader
+        except AttributeError:
+            pass
+    # __package__
+    if override or getattr(module, '__package__', None) is None:
+        try:
+            module.__package__ = spec.parent
+        except AttributeError:
+            pass
+    # __spec__
+    try:
+        module.__spec__ = spec
+    except AttributeError:
+        pass
+    # __path__
+    if override or getattr(module, '__path__', None) is None:
+        if spec.submodule_search_locations is not None:
+            try:
+                module.__path__ = spec.submodule_search_locations
+            except AttributeError:
+                pass
+    # __file__/__cached__
+    if spec.has_location:
+        if override or getattr(module, '__file__', None) is None:
+            try:
+                module.__file__ = spec.origin
+            except AttributeError:
+                pass
+
+        if override or getattr(module, '__cached__', None) is None:
+            if spec.cached is not None:
+                try:
+                    module.__cached__ = spec.cached
+                except AttributeError:
+                    pass
+    return module
+
+
+def module_from_spec(spec):
+    """Create a module based on the provided spec."""
+    # Typically loaders will not implement create_module().
+    module = None
+    if hasattr(spec.loader, 'create_module'):
+        # If create_module() returns `None` then it means default
+        # module creation should be used.
+        module = spec.loader.create_module(spec)
+    elif hasattr(spec.loader, 'exec_module'):
+        raise ImportError('loaders that define exec_module() '
+                          'must also define create_module()')
+    if module is None:
+        module = _new_module(spec.name)
+    _init_module_attrs(spec, module)
+    return module
+
+
+def _module_repr_from_spec(spec):
+    """Return the repr to use for the module."""
+    # We mostly replicate _module_repr() using the spec attributes.
+    name = '?' if spec.name is None else spec.name
+    if spec.origin is None:
+        if spec.loader is None:
+            return '<module {!r}>'.format(name)
+        else:
+            return '<module {!r} ({!r})>'.format(name, spec.loader)
+    else:
+        if spec.has_location:
+            return '<module {!r} from {!r}>'.format(name, spec.origin)
+        else:
+            return '<module {!r} ({})>'.format(spec.name, spec.origin)
+
+
+# Used by importlib.reload() and _load_module_shim().
+def _exec(spec, module):
+    """Execute the spec's specified module in an existing module's namespace."""
+    name = spec.name
+    with _ModuleLockManager(name):
+        if sys.modules.get(name) is not module:
+            msg = 'module {!r} not in sys.modules'.format(name)
+            raise ImportError(msg, name=name)
+        try:
+            if spec.loader is None:
+                if spec.submodule_search_locations is None:
+                    raise ImportError('missing loader', name=spec.name)
+                # Namespace package.
+                _init_module_attrs(spec, module, override=True)
+            else:
+                _init_module_attrs(spec, module, override=True)
+                if not hasattr(spec.loader, 'exec_module'):
+                    # (issue19713) Once BuiltinImporter and ExtensionFileLoader
+                    # have exec_module() implemented, we can add a deprecation
+                    # warning here.
+                    spec.loader.load_module(name)
+                else:
+                    spec.loader.exec_module(module)
+        finally:
+            # Update the order of insertion into sys.modules for module
+            # clean-up at shutdown.
+            module = sys.modules.pop(spec.name)
+            sys.modules[spec.name] = module
+    return module
+
+
+def _load_backward_compatible(spec):
+    # (issue19713) Once BuiltinImporter and ExtensionFileLoader
+    # have exec_module() implemented, we can add a deprecation
+    # warning here.
+    try:
+        spec.loader.load_module(spec.name)
+    except:
+        if spec.name in sys.modules:
+            module = sys.modules.pop(spec.name)
+            sys.modules[spec.name] = module
+        raise
+    # The module must be in sys.modules at this point!
+    # Move it to the end of sys.modules.
+    module = sys.modules.pop(spec.name)
+    sys.modules[spec.name] = module
+    if getattr(module, '__loader__', None) is None:
+        try:
+            module.__loader__ = spec.loader
+        except AttributeError:
+            pass
+    if getattr(module, '__package__', None) is None:
+        try:
+            # Since module.__path__ may not line up with
+            # spec.submodule_search_paths, we can't necessarily rely
+            # on spec.parent here.
+            module.__package__ = module.__name__
+            if not hasattr(module, '__path__'):
+                module.__package__ = spec.name.rpartition('.')[0]
+        except AttributeError:
+            pass
+    if getattr(module, '__spec__', None) is None:
+        try:
+            module.__spec__ = spec
+        except AttributeError:
+            pass
+    return module
+
+def _load_unlocked(spec):
+    # A helper for direct use by the import system.
+    if spec.loader is not None:
+        # Not a namespace package.
+        if not hasattr(spec.loader, 'exec_module'):
+            return _load_backward_compatible(spec)
+
+    module = module_from_spec(spec)
+
+    # This must be done before putting the module in sys.modules
+    # (otherwise an optimization shortcut in import.c becomes
+    # wrong).
+    spec._initializing = True
+    try:
+        sys.modules[spec.name] = module
+        try:
+            if spec.loader is None:
+                if spec.submodule_search_locations is None:
+                    raise ImportError('missing loader', name=spec.name)
+                # A namespace package so do nothing.
+            else:
+                spec.loader.exec_module(module)
+        except:
+            try:
+                del sys.modules[spec.name]
+            except KeyError:
+                pass
+            raise
+        # Move the module to the end of sys.modules.
+        # We don't ensure that the import-related module attributes get
+        # set in the sys.modules replacement case.  Such modules are on
+        # their own.
+        module = sys.modules.pop(spec.name)
+        sys.modules[spec.name] = module
+        _verbose_message('import {!r} # {!r}', spec.name, spec.loader)
+    finally:
+        spec._initializing = False
+
+    return module
+
+# A method used during testing of _load_unlocked() and by
+# _load_module_shim().
+def _load(spec):
+    """Return a new module object, loaded by the spec's loader.
+
+    The module is not added to its parent.
+
+    If a module is already in sys.modules, that existing module gets
+    clobbered.
+
+    """
+    with _ModuleLockManager(spec.name):
+        return _load_unlocked(spec)
+
+
+# Loaders #####################################################################
+
+class BuiltinImporter:
+
+    """Meta path import for built-in modules.
+
+    All methods are either class or static methods to avoid the need to
+    instantiate the class.
+
+    """
+
+    @staticmethod
+    def module_repr(module):
+        """Return repr for the module.
+
+        The method is deprecated.  The import machinery does the job itself.
+
+        """
+        return '<module {!r} (built-in)>'.format(module.__name__)
+
+    @classmethod
+    def find_spec(cls, fullname, path=None, target=None):
+        if path is not None:
+            return None
+        if _imp.is_builtin(fullname):
+            return spec_from_loader(fullname, cls, origin='built-in')
+        else:
+            return None
+
+    @classmethod
+    def find_module(cls, fullname, path=None):
+        """Find the built-in module.
+
+        If 'path' is ever specified then the search is considered a failure.
+
+        This method is deprecated.  Use find_spec() instead.
+
+        """
+        spec = cls.find_spec(fullname, path)
+        return spec.loader if spec is not None else None
+
+    @classmethod
+    def create_module(self, spec):
+        """Create a built-in module"""
+        if spec.name not in sys.builtin_module_names:
+            raise ImportError('{!r} is not a built-in module'.format(spec.name),
+                              name=spec.name)
+        return _call_with_frames_removed(_imp.create_builtin, spec)
+
+    @classmethod
+    def exec_module(self, module):
+        """Exec a built-in module"""
+        _call_with_frames_removed(_imp.exec_builtin, module)
+
+    @classmethod
+    @_requires_builtin
+    def get_code(cls, fullname):
+        """Return None as built-in modules do not have code objects."""
+        return None
+
+    @classmethod
+    @_requires_builtin
+    def get_source(cls, fullname):
+        """Return None as built-in modules do not have source code."""
+        return None
+
+    @classmethod
+    @_requires_builtin
+    def is_package(cls, fullname):
+        """Return False as built-in modules are never packages."""
+        return False
+
+    load_module = classmethod(_load_module_shim)
+
+
+class FrozenImporter:
+
+    """Meta path import for frozen modules.
+
+    All methods are either class or static methods to avoid the need to
+    instantiate the class.
+
+    """
+
+    _ORIGIN = "frozen"
+
+    @staticmethod
+    def module_repr(m):
+        """Return repr for the module.
+
+        The method is deprecated.  The import machinery does the job itself.
+
+        """
+        return '<module {!r} ({})>'.format(m.__name__, FrozenImporter._ORIGIN)
+
+    @classmethod
+    def find_spec(cls, fullname, path=None, target=None):
+        if _imp.is_frozen(fullname):
+            return spec_from_loader(fullname, cls, origin=cls._ORIGIN)
+        else:
+            return None
+
+    @classmethod
+    def find_module(cls, fullname, path=None):
+        """Find a frozen module.
+
+        This method is deprecated.  Use find_spec() instead.
+
+        """
+        return cls if _imp.is_frozen(fullname) else None
+
+    @classmethod
+    def create_module(cls, spec):
+        """Use default semantics for module creation."""
+
+    @staticmethod
+    def exec_module(module):
+        name = module.__spec__.name
+        if not _imp.is_frozen(name):
+            raise ImportError('{!r} is not a frozen module'.format(name),
+                              name=name)
+        code = _call_with_frames_removed(_imp.get_frozen_object, name)
+        exec(code, module.__dict__)
+
+    @classmethod
+    def load_module(cls, fullname):
+        """Load a frozen module.
+
+        This method is deprecated.  Use exec_module() instead.
+
+        """
+        return _load_module_shim(cls, fullname)
+
+    @classmethod
+    @_requires_frozen
+    def get_code(cls, fullname):
+        """Return the code object for the frozen module."""
+        return _imp.get_frozen_object(fullname)
+
+    @classmethod
+    @_requires_frozen
+    def get_source(cls, fullname):
+        """Return None as frozen modules do not have source code."""
+        return None
+
+    @classmethod
+    @_requires_frozen
+    def is_package(cls, fullname):
+        """Return True if the frozen module is a package."""
+        return _imp.is_frozen_package(fullname)
+
+
+# Import itself ###############################################################
+
+class _ImportLockContext:
+
+    """Context manager for the import lock."""
+
+    def __enter__(self):
+        """Acquire the import lock."""
+        _imp.acquire_lock()
+
+    def __exit__(self, exc_type, exc_value, exc_traceback):
+        """Release the import lock regardless of any raised exceptions."""
+        _imp.release_lock()
+
+
+def _resolve_name(name, package, level):
+    """Resolve a relative module name to an absolute one."""
+    bits = package.rsplit('.', level - 1)
+    if len(bits) < level:
+        raise ValueError('attempted relative import beyond top-level package')
+    base = bits[0]
+    return '{}.{}'.format(base, name) if name else base
+
+
+def _find_spec_legacy(finder, name, path):
+    # This would be a good place for a DeprecationWarning if
+    # we ended up going that route.
+    loader = finder.find_module(name, path)
+    if loader is None:
+        return None
+    return spec_from_loader(name, loader)
+
+
+def _find_spec(name, path, target=None):
+    """Find a module's spec."""
+    meta_path = sys.meta_path
+    if meta_path is None:
+        # PyImport_Cleanup() is running or has been called.
+        raise ImportError("sys.meta_path is None, Python is likely "
+                          "shutting down")
+
+    if not meta_path:
+        _warnings.warn('sys.meta_path is empty', ImportWarning)
+
+    # We check sys.modules here for the reload case.  While a passed-in
+    # target will usually indicate a reload there is no guarantee, whereas
+    # sys.modules provides one.
+    is_reload = name in sys.modules
+    for finder in meta_path:
+        with _ImportLockContext():
+            try:
+                find_spec = finder.find_spec
+            except AttributeError:
+                spec = _find_spec_legacy(finder, name, path)
+                if spec is None:
+                    continue
+            else:
+                spec = find_spec(name, path, target)
+        if spec is not None:
+            # The parent import may have already imported this module.
+            if not is_reload and name in sys.modules:
+                module = sys.modules[name]
+                try:
+                    __spec__ = module.__spec__
+                except AttributeError:
+                    # We use the found spec since that is the one that
+                    # we would have used if the parent module hadn't
+                    # beaten us to the punch.
+                    return spec
+                else:
+                    if __spec__ is None:
+                        return spec
+                    else:
+                        return __spec__
+            else:
+                return spec
+    else:
+        return None
+
+
+def _sanity_check(name, package, level):
+    """Verify arguments are "sane"."""
+    if not isinstance(name, str):
+        raise TypeError('module name must be str, not {}'.format(type(name)))
+    if level < 0:
+        raise ValueError('level must be >= 0')
+    if level > 0:
+        if not isinstance(package, str):
+            raise TypeError('__package__ not set to a string')
+        elif not package:
+            raise ImportError('attempted relative import with no known parent '
+                              'package')
+    if not name and level == 0:
+        raise ValueError('Empty module name')
+
+
+_ERR_MSG_PREFIX = 'No module named '
+_ERR_MSG = _ERR_MSG_PREFIX + '{!r}'
+
+def _find_and_load_unlocked(name, import_):
+    path = None
+    parent = name.rpartition('.')[0]
+    if parent:
+        if parent not in sys.modules:
+            _call_with_frames_removed(import_, parent)
+        # Crazy side-effects!
+        if name in sys.modules:
+            return sys.modules[name]
+        parent_module = sys.modules[parent]
+        try:
+            path = parent_module.__path__
+        except AttributeError:
+            msg = (_ERR_MSG + '; {!r} is not a package').format(name, parent)
+            raise ModuleNotFoundError(msg, name=name) from None
+    spec = _find_spec(name, path)
+    if spec is None:
+        raise ModuleNotFoundError(_ERR_MSG.format(name), name=name)
+    else:
+        module = _load_unlocked(spec)
+    if parent:
+        # Set the module as an attribute on its parent.
+        parent_module = sys.modules[parent]
+        setattr(parent_module, name.rpartition('.')[2], module)
+    return module
+
+
+_NEEDS_LOADING = object()
+
+
+def _find_and_load(name, import_):
+    """Find and load the module."""
+    with _ModuleLockManager(name):
+        module = sys.modules.get(name, _NEEDS_LOADING)
+        if module is _NEEDS_LOADING:
+            return _find_and_load_unlocked(name, import_)
+
+    if module is None:
+        message = ('import of {} halted; '
+                   'None in sys.modules'.format(name))
+        raise ModuleNotFoundError(message, name=name)
+
+    _lock_unlock_module(name)
+    return module
+
+
+def _gcd_import(name, package=None, level=0):
+    """Import and return the module based on its name, the package the call is
+    being made from, and the level adjustment.
+
+    This function represents the greatest common denominator of functionality
+    between import_module and __import__. This includes setting __package__ if
+    the loader did not.
+
+    """
+    _sanity_check(name, package, level)
+    if level > 0:
+        name = _resolve_name(name, package, level)
+    return _find_and_load(name, _gcd_import)
+
+
+def _handle_fromlist(module, fromlist, import_, *, recursive=False):
+    """Figure out what __import__ should return.
+
+    The import_ parameter is a callable which takes the name of module to
+    import. It is required to decouple the function from assuming importlib's
+    import implementation is desired.
+
+    """
+    # The hell that is fromlist ...
+    # If a package was imported, try to import stuff from fromlist.
+    for x in fromlist:
+        if not isinstance(x, str):
+            if recursive:
+                where = module.__name__ + '.__all__'
+            else:
+                where = "``from list''"
+            raise TypeError(f"Item in {where} must be str, "
+                            f"not {type(x).__name__}")
+        elif x == '*':
+            if not recursive and hasattr(module, '__all__'):
+                _handle_fromlist(module, module.__all__, import_,
+                                 recursive=True)
+        elif not hasattr(module, x):
+            from_name = '{}.{}'.format(module.__name__, x)
+            try:
+                _call_with_frames_removed(import_, from_name)
+            except ModuleNotFoundError as exc:
+                # Backwards-compatibility dictates we ignore failed
+                # imports triggered by fromlist for modules that don't
+                # exist.
+                if (exc.name == from_name and
+                    sys.modules.get(from_name, _NEEDS_LOADING) is not None):
+                    continue
+                raise
+    return module
+
+
+def _calc___package__(globals):
+    """Calculate what __package__ should be.
+
+    __package__ is not guaranteed to be defined or could be set to None
+    to represent that its proper value is unknown.
+
+    """
+    package = globals.get('__package__')
+    spec = globals.get('__spec__')
+    if package is not None:
+        if spec is not None and package != spec.parent:
+            _warnings.warn("__package__ != __spec__.parent "
+                           f"({package!r} != {spec.parent!r})",
+                           ImportWarning, stacklevel=3)
+        return package
+    elif spec is not None:
+        return spec.parent
+    else:
+        _warnings.warn("can't resolve package from __spec__ or __package__, "
+                       "falling back on __name__ and __path__",
+                       ImportWarning, stacklevel=3)
+        package = globals['__name__']
+        if '__path__' not in globals:
+            package = package.rpartition('.')[0]
+    return package
+
+
+def __import__(name, globals=None, locals=None, fromlist=(), level=0):
+    """Import a module.
+
+    The 'globals' argument is used to infer where the import is occurring from
+    to handle relative imports. The 'locals' argument is ignored. The
+    'fromlist' argument specifies what should exist as attributes on the module
+    being imported (e.g. ``from module import <fromlist>``).  The 'level'
+    argument represents the package location to import from in a relative
+    import (e.g. ``from ..pkg import mod`` would have a 'level' of 2).
+
+    """
+    if level == 0:
+        module = _gcd_import(name)
+    else:
+        globals_ = globals if globals is not None else {}
+        package = _calc___package__(globals_)
+        module = _gcd_import(name, package, level)
+    if not fromlist:
+        # Return up to the first dot in 'name'. This is complicated by the fact
+        # that 'name' may be relative.
+        if level == 0:
+            return _gcd_import(name.partition('.')[0])
+        elif not name:
+            return module
+        else:
+            # Figure out where to slice the module's name up to the first dot
+            # in 'name'.
+            cut_off = len(name) - len(name.partition('.')[0])
+            # Slice end needs to be positive to alleviate need to special-case
+            # when ``'.' not in name``.
+            return sys.modules[module.__name__[:len(module.__name__)-cut_off]]
+    elif hasattr(module, '__path__'):
+        return _handle_fromlist(module, fromlist, _gcd_import)
+    else:
+        return module
+
+
+def _builtin_from_name(name):
+    spec = BuiltinImporter.find_spec(name)
+    if spec is None:
+        raise ImportError('no built-in module named ' + name)
+    return _load_unlocked(spec)
+
+
+def _setup(sys_module, _imp_module):
+    """Setup importlib by importing needed built-in modules and injecting them
+    into the global namespace.
+
+    As sys is needed for sys.modules access and _imp is needed to load built-in
+    modules, those two modules must be explicitly passed in.
+
+    """
+    global _imp, sys
+    _imp = _imp_module
+    sys = sys_module
+
+    # Set up the spec for existing builtin/frozen modules.
+    module_type = type(sys)
+    for name, module in sys.modules.items():
+        if isinstance(module, module_type):
+            if name in sys.builtin_module_names:
+                loader = BuiltinImporter
+            elif _imp.is_frozen(name):
+                loader = FrozenImporter
+            else:
+                continue
+            spec = _spec_from_module(module, loader)
+            _init_module_attrs(spec, module)
+
+    # Directly load built-in modules needed during bootstrap.
+    self_module = sys.modules[__name__]
+    for builtin_name in ('_thread', '_warnings', '_weakref'):
+        if builtin_name not in sys.modules:
+            builtin_module = _builtin_from_name(builtin_name)
+        else:
+            builtin_module = sys.modules[builtin_name]
+        setattr(self_module, builtin_name, builtin_module)
+
+
+def _install(sys_module, _imp_module):
+    """Install importers for builtin and frozen modules"""
+    _setup(sys_module, _imp_module)
+
+    sys.meta_path.append(BuiltinImporter)
+    sys.meta_path.append(FrozenImporter)
+
+
+def _install_external_importers():
+    """Install importers that require external filesystem access"""
+    global _bootstrap_external
+    import _frozen_importlib_external
+    _bootstrap_external = _frozen_importlib_external
+    _frozen_importlib_external._install(sys.modules[__name__])
+
+ +
+
+
+
+ +
+
+ + + + \ No newline at end of file diff --git a/_modules/index.html b/_modules/index.html index 5983f48..8626117 100644 --- a/_modules/index.html +++ b/_modules/index.html @@ -1,32 +1,22 @@ - + - + - - - Overview: module code — capnp 0.5.4 documentation - + + + Overview: module code — capnp 1.0.0b2 documentation - - - - - - - - -
+ + + + + + + + +
-
+

All modules for which code is available

-
-
+ -
+ -
- © Copyright 2013, Author. - Created using Sphinx 1.2.3. + \ No newline at end of file diff --git a/_sources/capnp.rst.txt b/_sources/capnp.rst.txt new file mode 100644 index 0000000..d895ef8 --- /dev/null +++ b/_sources/capnp.rst.txt @@ -0,0 +1,198 @@ +.. _api: + +API Reference +============= + +.. automodule:: capnp + +.. currentmodule:: capnp + + +Classes +------- + +RPC +~~~ + +Promise +####### + +.. autoclass:: Promise + :members: + :undoc-members: + :inherited-members: + +Promise may be one of: + +* :meth:`capnp.lib.capnp._Promise` +* :meth:`capnp.lib.capnp._RemotePromise` +* :meth:`capnp.lib.capnp._VoidPromise` +* :meth:`PromiseFulfillerPair` + +.. autoclass:: capnp.lib.capnp._Promise + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: capnp.lib.capnp._RemotePromise + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: capnp.lib.capnp._VoidPromise + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: PromiseFulfillerPair + :members: + :undoc-members: + :inherited-members: + + +Communication +############# + +.. autoclass:: TwoPartyClient + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: TwoPartyServer + :members: + :undoc-members: + :inherited-members: + + +Capability +########## + +.. autoclass:: capnp.lib.capnp._DynamicCapabilityClient + :members: + :undoc-members: + :inherited-members: + + +Response +######## + +.. autoclass:: capnp.lib.capnp._Response + :members: + :undoc-members: + :inherited-members: + + +Miscellaneous +~~~~~~~~~~~~~ +.. autoclass:: KjException + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: SchemaParser + :members: + :undoc-members: + :inherited-members: + + +Functions +--------- +.. autofunction:: add_import_hook +.. autofunction:: cleanup_global_schema_parser +.. autofunction:: create_event_loop +.. autofunction:: getTimer +.. autofunction:: join_promises +.. autofunction:: load +.. autofunction:: poll_once +.. autofunction:: remove_event_loop +.. autofunction:: remove_import_hook +.. autofunction:: reset_event_loop +.. autofunction:: wait_forever + + +Internal Classes +---------------- +These classes are internal to the library. You will never need to allocate +one yourself, but you may end up using some of their member methods. + +Modules +~~~~~~~ +These are classes that are made for you when you import a Cap'n Proto file:: + + import capnp + import addressbook_capnp + + print type(addressbook_capnp.Person) # capnp.capnp._StructModule + +.. autoclass:: _InterfaceModule + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _StructModule + :members: + :undoc-members: + :inherited-members: + +Readers +~~~~~~~ +.. autoclass:: _DynamicListReader + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _DynamicStructReader + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _PackedFdMessageReader + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _StreamFdMessageReader + :members: + :undoc-members: + :inherited-members: + +Builders +~~~~~~~~ +.. autoclass:: _DynamicResizableListBuilder + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _DynamicListBuilder + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _DynamicStructBuilder + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _MallocMessageBuilder + :members: + :undoc-members: + :inherited-members: + +RPC +~~~ +.. autoclass:: _CapabilityClient + :members: + :undoc-members: + :inherited-members: + +.. autoclass:: _DynamicCapabilityClient + :members: + :undoc-members: + :inherited-members: + +Miscellaneous +~~~~~~~~~~~~~ +.. autoclass:: _DynamicOrphan + :members: + :undoc-members: + :inherited-members: diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt new file mode 100644 index 0000000..eebd1e5 --- /dev/null +++ b/_sources/index.rst.txt @@ -0,0 +1,19 @@ +.. capnp documentation master file + +pycapnp +======= + +This is a python wrapping of the C++ implementation of the `Cap'n Proto `_ library. Here is a short description, quoted from its docs: + + Cap’n Proto is an insanely fast data interchange format and capability-based RPC system. Think JSON, except binary. Or think Protocol Buffers, except faster. In fact, in benchmarks, Cap’n Proto is INFINITY TIMES faster than Protocol Buffers. + +Since the python library is just a thin wrapping of the C++ library, we inherit a lot of what makes Cap'n Proto fast. In some simplistic benchmarks (available in the `benchmark directory of the repo `_), pycapnp has proven to be decently faster than Protocol Buffers (both pure python and C++ implementations). Also, the python capnp library can load Cap'n Proto schema files directly, without the need for a seperate compile step like with Protocol Buffers or Thrift. pycapnp is available on `github `_ and `pypi `_. + +Contents: + +.. toctree:: + :maxdepth: 4 + + install + quickstart + capnp diff --git a/_sources/install.rst.txt b/_sources/install.rst.txt new file mode 100644 index 0000000..656a8dd --- /dev/null +++ b/_sources/install.rst.txt @@ -0,0 +1,97 @@ +.. _install: + +Installation +============ + +Pip +--- +The pip installation will using the binary versions of the package (if possible). These contain a bundled version of capnproto (on Linux compiled with `manylinux `_). Starting from v1.0.0b1 binary releases are available for Windows, macOS and Linux from `pypi `_:: + + [sudo] pip install pycapnp + +To force rebuilding the pip package from source (you'll need requirments.txt or pipenv):: + + pip install --no-binary :all: pycapnp + +To force bundling libcapnp (or force system libcapnp), just in case setup.py isn't doing the right thing:: + + pip install --no-binary :all: --install-option "--force-bundled-libcapnp" + pip install --no-binary :all: --install-option "--force-system-libcapnp" + +If you're using an older Linux distro (e.g. CentOS 6) you many need to set `LDFLAGS="-Wl,--no-as-needed -lrt"`:: + + LDFLAGS="-Wl,--no-as-needed -lrt" pip install --no-binary :all: pycapnp + +It's also possible to specify the libcapnp url when bundling (this may not work, there be dragons):: + + pip install --no-binary :all: --install-option "--force-bundled-libcapnp" --install-option "--libcapnp-url" --install-option "https://github.com/capnproto/capnproto/archive/master.tar.gz" + +From Source +----------- +Source installation is generally not needed unless you're looking into an issue with capnproto or pycapnp itself. + +C++ Cap'n Proto Library +~~~~~~~~~~~~~~~~~~~~~~~ +You need to install the C++ Cap'n Proto library first. It requires a C++ compiler with C++14 support, such as GCC 5+ or Clang 5+. Follow installation docs at `https://capnproto.org/install.html `_. + +pycapnp from git +~~~~~~~~~~~~~~~~ +If you want the latest development version, you can clone the github repo:: + + git clone https://github.com/capnproto/pycapnp.git + +For development packages use one of the following to install the python dependencies:: + + pipenv install + pip install -r requirements.txt + +And install pycapnp with:: + + cd pycapnp + pip install . + +or:: + + cd pycapnp + python setup.py install + + +Development +----------- +Clone the repo from https://github.com/capnproto/pycapnp.git:: + + git clone https://github.com/capnproto/pycapnp.git + +For development packages use one of the following to install the python dependencies:: + + pipenv install + pip install -r requirements.txt + +Building:: + + cd pycapnp + pip install . + +or:: + + cd pycapnp + python setup.py install + +Useful targets for setup.py:: + + python setup.py build + python setup.py clean + +Useful command-line arguments are available for setup.py:: + + --force-bundled-libcapnp + --force-system-libcapnp + --libcapnp-url + +Testing is done through pytest:: + + cd pycapnp + pytest + pytest test/test_rpc_calculator.py + +Once you're done installing, take a look at the :ref:`quickstart` diff --git a/_sources/quickstart.rst.txt b/_sources/quickstart.rst.txt new file mode 100644 index 0000000..810b9b2 --- /dev/null +++ b/_sources/quickstart.rst.txt @@ -0,0 +1,720 @@ +.. _quickstart: + +Quickstart +========== + +This assumes you already have the capnp library installed. If you don't, please follow the instructions at :ref:`Installation ` first. + +In general, this library is a very light wrapping of the `Cap'n Proto C++ library `_. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured. + + +Load a Cap'n Proto Schema +------------------------- +First you need to import the library:: + + import capnp + +Then you can load the Cap'n Proto schema with:: + + import addressbook_capnp + +This will look all through all the directories in your sys.path/PYTHONPATH, and try to find a file of the form 'addressbook.capnp'. If you want to disable the import hook magic that `import capnp` adds, and load manually, here's how:: + + capnp.remove_import_hook() + addressbook_capnp = capnp.load('addressbook.capnp') + +For future reference, here is the Cap'n Proto schema. Also available in the github repository under `examples/addressbook.capnp `_:: + + # addressbook.capnp + @0x934efea7f017fff0; + + const qux :UInt32 = 123; + + struct Person { + id @0 :UInt32; + name @1 :Text; + email @2 :Text; + phones @3 :List(PhoneNumber); + + struct PhoneNumber { + number @0 :Text; + type @1 :Type; + + enum Type { + mobile @0; + home @1; + work @2; + } + } + + employment :union { + unemployed @4 :Void; + employer @5 :Text; + school @6 :Text; + selfEmployed @7 :Void; + # We assume that a person is only one of these. + } + } + + struct AddressBook { + people @0 :List(Person); + } + + +Const values +~~~~~~~~~~~~ +Const values show up just as you'd expect under the loaded schema. For example:: + + print addressbook_capnp.qux + # 123 + + +Build a message +--------------- + +Initialize a New Cap'n Proto Object +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Now that you've imported your schema, you need to allocate an actual struct from that schema. In this case, we will allocate an `AddressBook`:: + + addresses = addressbook_capnp.AddressBook.new_message() + +Notice that we used `addressbook_capnp` from the previous section: `Load a Cap'n Proto Schema`_. + +Also as a shortcut, you can pass keyword arguments to the `new_message` function, and those fields will be set in the new message:: + + person = addressbook_capnp.Person.new_message(name='alice') + # is equivalent to: + person = addressbook_capnp.Person.new_message() + person.name = 'alice' + + +List +~~~~ +Allocating a list inside of an object requires use of the `init` function:: + + people = addresses.init('people', 2) + +For now, let's grab the first element out of this list and assign it to a variable named `alice`:: + + alice = people[0] + +.. note:: It is a very bad idea to call `init` more than once on a single field. Every call to `init` allocates new memory inside your Cap'n Proto message, and if you call it more than once, the previous memory is left as dead space in the message. See `Tips and Best Practices `_ for more details. + + +Primitive Types +~~~~~~~~~~~~~~~ +For all primitive types, from the Cap'n Proto docs: + +- Boolean: Bool +- Integers: Int8, Int16, Int32, Int64 +- Unsigned integers: UInt8, UInt16, UInt32, UInt64 +- Floating-point: Float32, Float64 +- Blobs: Text, Data + +You can assign straight to the variable with the corresponding Python type. For Blobs, you use strings. Assignment happens just by using the `.` syntax on the object you contstructed above:: + + alice.id = 123 + alice.name = 'Alice' + alice.email = 'alice@example.com' + +.. note:: Text fields will behave differently depending on your version of Python. In Python 2.x, Text fields will expect and return a `bytes` string, while in Python 3.x, they will expect and return a `unicode` string. Data fields will always a return `bytes` string. + + +Enums +~~~~~ +First we'll allocate a length one list of phonenumbers for `alice`:: + + alicePhone = alice.init('phones', 1)[0] + +Note that even though it was a length 1 list, it was still a list that was returned, and we extracted the first (and only) element with `[0]`. + +Enums are treated like strings, and you assign to them like they were a Text field:: + + alicePhone.type = 'mobile' + +If you assign an invalid value to one, you will get a ValueError:: + + alicePhone.type = 'foo' + --------------------------------------------------------------------------- + ValueError Traceback (most recent call last) + ... + ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enumerant; name = foo + + +Unions +~~~~~~ +For the most part, you just treat them like structs:: + + alice.employment.school = "MIT" + +Now the `school` field is the active part of the union, and we've assigned `'MIT'` to it. You can query which field is set in a union with `which()`, shown in `Reading Unions`_ + +Also, one weird case is for Void types in Unions (and in general, but Void is really only used in Unions). For these, you will have to assign `None` to them:: + + bob.employment.unemployed = None + +.. note:: One caveat for unions is having structs as union members. Let us assume `employment.school` was actually a struct with a field of type `Text` called `name`:: + + alice.employment.school.name = "MIT" + # Raises a ValueError + + The problem is that a struct within a union isn't initialized automatically. You have to do the following:: + + school = alice.employment.init('school') + school.name = "MIT" + + Note that this is similar to `init` for lists, but you don't pass a size. Requiring the `init` makes it more clear that a memory allocation is occurring, and will hopefully make you mindful that you shouldn't set more than 1 field inside of a union, else you risk a memory leak + + +Writing to a File +~~~~~~~~~~~~~~~~~ +Once you're done assigning to all the fields in a message, you can write it to a file like so:: + + f = open('example.bin', 'w+b') + addresses.write(f) + +There is also a `write_packed` function, that writes out the message more space-efficientally. If you use write_packed, make sure to use read_packed when reading the message. + + +Read a message +-------------- + +Reading from a file +~~~~~~~~~~~~~~~~~~~ +Much like before, you will have to de-serialize the message from a file descriptor:: + + f = open('example.bin', 'rb') + addresses = addressbook_capnp.AddressBook.read(f) + +Note that this very much needs to match the type you wrote out. In general, you will always be sending the same message types out over a given channel or you should wrap all your types in an unnamed union. Unnamed unions are defined in the .capnp file like so:: + + struct Message { + union { + person @0 :Person; + addressbook @1 :AddressBook; + } + } + + +Reading Fields +~~~~~~~~~~~~~~ +Fields are very easy to read. You just use the `.` syntax as before. Lists behave just like normal Python lists:: + + for person in addresses.people: + print(person.name, ':', person.email) + for phone in person.phones: + print(phone.type, ':', phone.number) + + +Reading Unions +~~~~~~~~~~~~~~ +The only tricky one is unions, where you need to call `.which()` to determine the union type. The `.which()` call returns an enum, ie. a string, corresponding to the field name:: + + which = person.employment.which() + print(which) + + if which == 'unemployed': + print('unemployed') + elif which == 'employer': + print('employer:', person.employment.employer) + elif which == 'school': + print('student at:', person.employment.school) + elif which == 'selfEmployed': + print('self employed') + print() + + +Serializing/Deserializing +------------------------- + +Files +~~~~~ +As shown in the examples above, there is file serialization with `write()`:: + + addresses = addressbook_capnp.AddressBook.new_message() + ... + f = open('example.bin', 'w+b') + addresses.write(f) + +And similarly for reading:: + + f = open('example.bin', 'rb') + addresses = addressbook_capnp.AddressBook.read(f) + +There are packed versions as well:: + + addresses.write_packed(f) + f.seek(0) + addresses = addressbook_capnp.AddressBook.read_packed(f) + + +Multi-message files +~~~~~~~~~~~~~~~~~~~ +The above methods only guaranteed to work if your file contains a single message. If you have more than 1 message serialized sequentially in your file, then you need to use these convenience functions:: + + addresses = addressbook_capnp.AddressBook.new_message() + ... + f = open('example.bin', 'w+b') + addresses.write(f) + addresses.write(f) + addresses.write(f) # write 3 messages + f.seek(0) + + for addresses in addressbook_capnp.AddressBook.read_multiple(f): + print addresses + +There is also a packed version:: + + for addresses in addressbook_capnp.AddressBook.read_multiple_packed(f): + print addresses + +Dictionaries +~~~~~~~~~~~~ +There is a convenience method for converting Cap'n Proto messages to a dictionary. This works for both Builder and Reader type messages:: + + alice.to_dict() + +For the reverse, all you have to do is pass keyword arguments to the new_message constructor:: + + my_dict = {'name' : 'alice'} + alice = addressbook_capnp.Person.new_message(**my_dict) + # equivalent to: alice = addressbook_capnp.Person.new_message(name='alice') + +It's also worth noting, you can use python lists/dictionaries interchangably with their Cap'n Proto equivalent types:: + + book = addressbook_capnp.AddressBook.new_message(people=[{'name': 'Alice'}]) + ... + book = addressbook_capnp.AddressBook.new_message() + book.init('people', 1) + book.people[0] = {'name': 'Bob'} + + +Byte Strings/Buffers +~~~~~~~~~~~~~~~~~~~~ +There is serialization to a byte string available:: + + encoded_message = alice.to_bytes() + +And a corresponding from_bytes function:: + + alice = addressbook_capnp.Person.from_bytes(encoded_message) + +There are also packed versions:: + + alice2 = addressbook_capnp.Person.from_bytes_packed(alice.to_bytes_packed()) + + +Byte Segments +~~~~~~~~~~~~~ +.. note:: This feature is not supported in PyPy at the moment, pending investigation. + +Cap'n Proto supports a serialization mode which minimizes object copies. In the C++ interface, ``capnp::MessageBuilder::getSegmentsForOutput()`` returns an array of pointers to segments of the message's content without copying. ``capnp::SegmentArrayMessageReader`` performs the reverse operation, i.e., takes an array of pointers to segments and uses the underlying data, again without copying. This produces a different wire serialization format from ``to_bytes()`` serialization, which uses ``capnp::messageToFlatArray()`` and ``capnp::FlatArrayMessageReader`` (both of which use segments internally, but write them in an incompatible way). + +For compatibility on the Python side, use the ``to_segments()`` and ``from_segments()`` functions:: + + segments = alice.to_segments() + +This returns a list of segments, each a byte buffer. Each segment can be, e.g., turned into a ZeroMQ message frame. The list of segments can also be turned back into an object:: + + alice = addressbook_capnp.Person.from_segments(segments) + +For more information, please refer to the following links: + +- `Advice on minimizing copies from Cap'n Proto `_ (from the author of Cap'n Proto) +- `Advice on using Cap'n Proto over ZeroMQ `_ (from the author of Cap'n Proto) +- `Discussion about sending and reassembling Cap'n Proto message segments in C++ `_ (from the Cap'n Proto mailing list; includes sample code) + + +RPC +--- + +Cap'n Proto has a rich RPC protocol. You should read the `RPC specification `_ as well as the `C++ RPC documentation `_ before using pycapnp's RPC features. As with the serialization part of this library, the RPC component tries to be a very thin wrapper on top of the C++ API. + +The examples below will be using `calculator.capnp `_. Please refer to it to understand the interfaces that will be used. + +Asyncio support was added to pycapnp in v1.0.0 utilizing the TwoWayPipe interface to libcapnp (instead of having libcapnp control the socket communication). The main advantage here is that standard Python socket libraries can be used with pycapnp (more importantly, TLS/SSL). Asyncio requires a bit more boiler plate to get started but it does allow for a lot more control than using the pycapnp socket wrapper. + + +Client +~~~~~~ + +There are two ways to start a client: libcapnp socket wrapper and asyncio. +The wrapper is easier to implement but is very limited (doesn't support SSL/TLS with Python). +asyncio requires more setup and can be harder to debug; however, it does support SSL/TLS and has more control over the socket error conditions. asyncio also helps get around the threading limitations around the current pycapnp implementation has with libcapnp (pycapnp objects and functions must all be in the same thread). + + +Starting a Client +################# +Starting a client is very easy:: + + import capnp + import calculator_capnp + + client = capnp.TwoPartyClient('localhost:60000') + +.. note:: You can also pass a raw socket with a `fileno()` method to TwoPartyClient +.. note:: This will not work with SSL/TLS, please see :ref:`rpc-asyncio-client` + + +.. _rpc-asyncio-client: + +Starting a Client (asyncio) +########################### +Asyncio takes a bit more boilerplate than using the socket wrapper, but it gives you a lot more control. The example here is very simplistic. Here's an example of full error handling (with reconnection on server failure): `hidio client `_. + +At a basic level, asyncio splits the input and output streams of the tcp socket and sends it to the libcapnp TwoWayPipe interface. An async reader Python function/method is used to consume the incoming byte stream and an async writer Python function/method is used to write outgoing bytes to the socket. + +.. note:: You'll need to be using the async keyword on some of the Python function/methods. If you're unsure, look at the full `example code `_. Also, read up on recent Python asyncio tutorials if you're new to the concept. Make sure the tutorial is 3.7+, asyncio changed a lot from when it was first introduced in 3.4. + +First you'll need two basic async functions:: + + async def myreader(client, reader): + while True: + data = await reader.read(4096) + client.write(data) + + + async def mywriter(client, writer): + while True: + data = await client.read(4096) + writer.write(data.tobytes()) + await writer.drain() + +.. note:: There's no socket error handling here, so this won't be sufficient for anything beyond a simple example. + +Next you'll need to define an async function that sets up the socket connection. This is equivalent to `client = capnp.TwoPartyClient('localhost:60000')` in the earlier example:: + + async def main(host): + addr = 'localhost' + port = '6000' + + # Handle both IPv4 and IPv6 cases + try: + print("Try IPv4") + reader, writer = await asyncio.open_connection( + addr, port, + family=socket.AF_INET + ) + except Exception: + print("Try IPv6") + reader, writer = await asyncio.open_connection( + addr, port, + family=socket.AF_INET6 + ) + + # Start TwoPartyClient using TwoWayPipe (takes no arguments in this mode) + client = capnp.TwoPartyClient() + + # Assemble reader and writer tasks, run in the background + coroutines = [myreader(client, reader), mywriter(client, writer)] + asyncio.gather(*coroutines, return_exceptions=True) + + ## Bootstrap Here ## + +.. note:: On systems that have both IPv4 and IPv6 addresses, IPv6 is often resolved first and needs to be handled separately. If you're certain IPv6 won't be used, you can remove it (you should also avoid localhost, and stick to something like 127.0.0.1). + +Finally, you'll need to start the asyncio function:: + + if __name__ == '__main__': + asyncio.run(main(parse_args().host)) + +.. note:: This is the simplest way to start asyncio and usually not sufficient for most applications. + + +SSL/TLS Client +^^^^^^^^^^^^^^ +SSL/TLS setup effectively wraps the socket transport. You'll need an SSL certificate, for this example we'll be using a self-signed certificate. Most of the asyncio setup is the same as above:: + + async def main(host): + addr = 'localhost' + port = '6000' + + # Setup SSL context + ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, cafile=os.path.join(this_dir, 'selfsigned.cert')) + + # Handle both IPv4 and IPv6 cases + try: + print("Try IPv4") + reader, writer = await asyncio.open_connection( + addr, port, + ssl=ctx, + family=socket.AF_INET + ) + except Exception: + print("Try IPv6") + reader, writer = await asyncio.open_connection( + addr, port, + ssl=ctx, + family=socket.AF_INET6 + ) + + # Start TwoPartyClient using TwoWayPipe (takes no arguments in this mode) + client = capnp.TwoPartyClient() + + # Assemble reader and writer tasks, run in the background + coroutines = [myreader(client, reader), mywriter(client, writer)] + asyncio.gather(*coroutines, return_exceptions=True) + + ## Bootstrap Here ## + +Due to a `bug `_ in Python 3.7 and 3.8 asyncio client needs to be initialized in a slightly different way:: + + if __name__ == '__main__': + loop = asyncio.get_event_loop() + loop.run_until_complete(main(parse_args().host)) + + +Bootstrap +######### +Before calling any methods you'll need to bootstrap the Calculator interface:: + + calculator = client.bootstrap().cast_as(calculator_capnp.Calculator) + +There's two things worth noting here. First, we are asking for the server capability. Secondly, you see that we are casting the capability that we receive. This is because capabilities are intrinsically dynamic, and they hold no run time type information, so we need to pick what interface to interpret them as. + + +Calling methods +############### +There are 2 ways to call RPC methods. First the more verbose `request` syntax:: + + request = calculator.evaluate_request() + request.expression.literal = 123 + eval_promise = request.send() + +This creates a request for the method named 'evaluate', sets `expression.literal` in that call's parameters to 123, and then sends the request and returns a promise (all non-blocking). + +The shorter syntax for calling methods is:: + + eval_promise = calculator.evaluate({"literal": 123}) + +The major shortcoming with this method is that expressing complex fields with many nested sub-structs can become very tedious. + +Once you have a promise, there are 2 ways of getting to the result. The first is to wait for it:: + + result = eval_promise.wait() + +The second is to build a promise chain by calling `then`:: + + def do_stuff(val): + ... + + eval_promise.then(do_stuff).wait() + + +Pipelining +########## +If a method returns values that are themselves capabilites, then you can access these fields before having to call `wait`. Doing this is called pipelining, and it allows Cap'n Proto to chain the calls without a round-trip occurring to the server:: + + # evaluate returns `value` which is itself an interface. + # You can call a new method on `value` without having to call wait first + read_promise = eval_promise.value.read() + read_result = read_promise.wait() # only 1 wait call + +You can also chain promises with `then` and the same pipelining will occur:: + + read_result = eval_promise.then(lambda ret: ret.value.read()).wait() + + +Server +~~~~~~ +There are two ways to start a server: libcapnp socket wrapper and asyncio. +The wrapper is easier to implement but is very limited (doesn't support SSL/TLS with Python). +asyncio requires more setup and can be harder to debug; however, it does support SSL/TLS and has more control over the socket error conditions. asyncio also helps get around the threading limitations around the current pycapnp implementation has with libcapnp (pycapnp objects and functions must all be in the same thread). The asyncio Server is a bit more work to implement than an asyncio client as more error handling is required to deal with client connection/disconnection/timeout events. + + +Starting a Server +################# + +To start a server:: + + server = capnp.TwoPartyServer('*:60000', bootstrap=CalculatorImpl()) + server.run_forever() + +.. note:: You can also pass a raw socket with a `fileno()` method to TwoPartyServer. In that case, `run_forever` will not work, and you will have to use `on_disconnect.wait()`. +.. note:: This will not work with SSL/TLS, please see :ref:`rpc-asyncio-server` + + +.. _rpc-asyncio-server: + +Starting a Server (asyncio) +########################### +Like the asyncio client, an asyncio server takes a bunch of boilerplate as opposed to using the socket wrapper. Servers generally have to handle a lot more error conditions than clients so they are generally more complicated to implement with asyncio. + +Just like the asyncio client, both the input and output socket streams are handled by reader/writer callback functions/methods. + +.. note:: You'll need to be using the async keyword on some of the Python function/methods. If you're unsure, look at the full `example code `_. Also, read up on recent Python asyncio tutorials if you're new to the concept. Make sure the tutorial is 3.7+, asyncio changed a lot from when it was first introduced in 3.4. + +To simplify the callbacks use a server class to define the reader/writer callbacks.:: + + class Server: + async def myreader(self): + while self.retry: + try: + # Must be a wait_for so we don't block on read() + data = await asyncio.wait_for( + self.reader.read(4096), + timeout=0.1 + ) + except asyncio.TimeoutError: + print("myreader timeout.") + continue + except Exception as err: + print("Unknown myreader err: %s", err) + return False + await self.server.write(data) + print("myreader done.") + return True + + async def mywriter(self): + while self.retry: + try: + # Must be a wait_for so we don't block on read() + data = await asyncio.wait_for( + self.server.read(4096), + timeout=0.1 + ) + self.writer.write(data.tobytes()) + except asyncio.TimeoutError: + print("mywriter timeout.") + continue + except Exception as err: + print("Unknown mywriter err: %s", err) + return False + print("mywriter done.") + return True + +We need an additional `myserver()` method in the `Server` class to handle each of the incoming socket connections:: + + async def myserver(self, reader, writer): + # Start TwoPartyServer using TwoWayPipe (only requires bootstrap) + self.server = capnp.TwoPartyServer(bootstrap=CalculatorImpl()) + self.reader = reader + self.writer = writer + self.retry = True + + # Assemble reader and writer tasks, run in the background + coroutines = [self.myreader(), self.mywriter()] + tasks = asyncio.gather(*coroutines, return_exceptions=True) + + while True: + self.server.poll_once() + # Check to see if reader has been sent an eof (disconnect) + if self.reader.at_eof(): + self.retry = False + break + await asyncio.sleep(0.01) + + # Make wait for reader/writer to finish (prevent possible resource leaks) + await tasks + +Finally, we'll need to start an asyncio server to spawn a new async `myserver()` with it's own `Server()` object for each new connection:: + + async def new_connection(reader, writer): + server = Server() + await server.myserver(reader, writer) + + async def main(): + addr = 'localhost' + port = '60000' + + # Handle both IPv4 and IPv6 cases + try: + print("Try IPv4") + server = await asyncio.start_server( + new_connection, + addr, port, + family=socket.AF_INET + ) + except Exception: + print("Try IPv6") + server = await asyncio.start_server( + new_connection, + addr, port, + family=socket.AF_INET6 + ) + + async with server: + await server.serve_forever() + + if __name__ == '__main__': + asyncio.run(main()) + +.. note:: On systems that have both IPv4 and IPv6 addresses, IPv6 is often resolved first and needs to be handled separately. If you're certain IPv6 won't be used, you can remove it (you should also avoid localhost, and stick to something like 127.0.0.1). If you're broadcasting in general, you'll probably want to use `0.0.0.0` (IPv4) or `::/0` (IPv6). + + +SSL/TLS Server +^^^^^^^^^^^^^^ +Adding SSL/TLS support for a pycapnp asyncio server is fairly straight-forward. Just create an SSL context before starting the asyncio server:: + + async def main(): + addr = 'localhost' + port = '60000' + + # Setup SSL context + ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH) + ctx.load_cert_chain(os.path.join(this_dir, 'selfsigned.cert'), os.path.join(this_dir, 'selfsigned.key')) + + # Handle both IPv4 and IPv6 cases + try: + print("Try IPv4") + server = await asyncio.start_server( + new_connection, + addr, port, + ssl=ctx, + family=socket.AF_INET + ) + except Exception: + print("Try IPv6") + server = await asyncio.start_server( + new_connection, + addr, port, + ssl=ctx, + family=socket.AF_INET6 + ) + + async with server: + await server.serve_forever() + + +Implementing a Server +##################### +Here's a part of how you would implement a Calculator server:: + + class CalculatorImpl(calculator_capnp.Calculator.Server): + + "Implementation of the Calculator Cap'n Proto interface." + + def evaluate(self, expression, _context, **kwargs): + return evaluate_impl(expression).then(lambda value: setattr(_context.results, 'value', ValueImpl(value))) + + def defFunction_context(self, context): + params = context.params + context.results.func = FunctionImpl(params.paramCount, params.body) + + def getOperator(self, op, **kwargs): + return OperatorImpl(op) + +Some major things worth noting. + +- You must inherit from `your_module_capnp.YourInterface.Server`, but don't worry about calling __super__ in your __init__ +- Method names of your class must either match the interface exactly, or have '_context' appended to it +- If your method name is exactly the same as the interface, then you will be passed all the arguments from the interface as keyword arguments, so your argument names must match the interface spec exactly. You will also receive a `_context` parameter which is equivalent to the C++ API's Context. I highly recommend having `**kwargs` as well, so that even if your interface spec is upgraded and arguments were added, your server will still operate fine. +- Returns work with a bit of magic as well. If you return a promise, then it will be handled the same as if you returned a promise from a server method in the C++ API. Otherwise, your return statement will be filled into the results struct following the ordering in your spec, for example:: + + # capability.capnp file + interface TestInterface { + foo @0 (i :UInt32, j :Bool) -> (x: Text, i:UInt32); + } + + # python code + class TestInterface(capability_capnp.TestInterface.Server): + def foo(self, i, j, **kwargs): + return str(j), i + +- If your method ends in _context, then you will only be passed a context parameter. You will have to access params and set results yourself manually. Returning promises still works as above, but you can't return anything else from a method. + + +Full Examples +------------- +`Full examples `_ are available on github. There is also an example of a very simplistic RPC available in `test_rpc.py `_. diff --git a/_static/basic.css b/_static/basic.css index 967e36c..56f5efc 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -52,6 +52,8 @@ div.sphinxsidebar { width: 230px; margin-left: -100%; font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; } div.sphinxsidebar ul { @@ -79,14 +81,26 @@ div.sphinxsidebar input { font-size: 1em; } +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + div.sphinxsidebar #searchbox input[type="text"] { - width: 170px; + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; } div.sphinxsidebar #searchbox input[type="submit"] { - width: 30px; + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; } + img { border: 0; max-width: 100%; @@ -124,6 +138,8 @@ ul.keywordmatches li.goodmatch a { table.contentstable { width: 90%; + margin-left: auto; + margin-right: auto; } table.contentstable p.biglink { @@ -151,9 +167,14 @@ table.indextable td { vertical-align: top; } -table.indextable dl, table.indextable dd { +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 { @@ -185,19 +206,51 @@ div.genindex-jumpbox { 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 { +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { visibility: visible; } @@ -209,10 +262,6 @@ div.body td { text-align: left; } -.field-list ul { - padding-left: 1em; -} - .first { margin-top: 0 !important; } @@ -240,6 +289,12 @@ img.align-center, .figure.align-center, object.align-center { margin-right: auto; } +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + .align-left { text-align: left; } @@ -248,6 +303,10 @@ img.align-center, .figure.align-center, object.align-center { text-align: center; } +.align-default { + text-align: center; +} + .align-right { text-align: right; } @@ -257,22 +316,29 @@ img.align-center, .figure.align-center, object.align-center { div.sidebar { margin: 0 0 0.5em 1em; border: 1px solid #ddb; - padding: 7px 7px 0 7px; + padding: 7px; background-color: #ffe; width: 40%; float: right; + clear: right; + overflow-x: auto; } p.sidebar-title { font-weight: bold; } +div.admonition, div.topic, pre, div[class|="highlight"] { + clear: both; +} + /* -- topics ---------------------------------------------------------------- */ div.topic { border: 1px solid #ccc; - padding: 7px 7px 0 7px; + padding: 7px; margin: 10px 0 10px 0; + overflow-x: auto; } p.topic-title { @@ -287,16 +353,13 @@ div.admonition { margin-top: 10px; margin-bottom: 10px; padding: 7px; + overflow-x: auto; } div.admonition dt { font-weight: bold; } -div.admonition dl { - margin-bottom: 0; -} - p.admonition-title { margin: 0px 10px 5px 0px; font-weight: bold; @@ -307,13 +370,40 @@ div.body p.centered { margin-top: 25px; } +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + /* -- 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; @@ -322,10 +412,6 @@ table.docutils td, table.docutils th { border-bottom: 1px solid #aaa; } -table.field-list td, table.field-list th { - border: 0 !important; -} - table.footnote td, table.footnote th { border: 0 !important; } @@ -344,6 +430,67 @@ 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 { @@ -366,11 +513,75 @@ ol.upperroman { list-style: upper-roman; } +ol > li:first-child > :first-child, +ul > li:first-child > :first-child { + margin-top: 0px; +} + +ol ol > li:first-child > :first-child, +ol ul > li:first-child > :first-child, +ul ol > li:first-child > :first-child, +ul ul > li:first-child > :first-child { + margin-top: revert; +} + +ol > li:last-child > :last-child, +ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol ol > li:last-child > :last-child, +ol ul > li:last-child > :last-child, +ul ol > li:last-child > :last-child, +ul ul > li:last-child > :last-child { + margin-bottom: revert; +} + +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 p { +dd > :first-child { margin-top: 0px; } @@ -384,28 +595,32 @@ dd { margin-left: 30px; } -dt:target, .highlighted { +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; } -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - .optional { font-size: 1.3em; } +.sig-paren { + font-size: larger; +} + .versionmodified { font-style: italic; } @@ -444,6 +659,12 @@ dl.glossary dt { font-style: oblique; } +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + abbr, acronym { border-bottom: dotted 1px; cursor: help; @@ -456,37 +677,105 @@ pre { overflow-y: hidden; /* fixes display issues on Chrome browsers */ } +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; +} + +div[class^="highlight-"] { + margin: 1em 0; +} + td.linenos pre { - padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { - margin-left: 0.5em; + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; } table.highlighttable td { - padding: 0 0.5em 0 0.5em; + margin: 0; + padding: 0; } -tt.descname { +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; } -tt.descclassname { +code.descclassname { background-color: transparent; } -tt.xref, a tt { +code.xref, a code { background-color: transparent; font-weight: bold; } -h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { background-color: transparent; } @@ -518,6 +807,15 @@ span.eqno { float: right; } +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + /* -- printout stylesheet --------------------------------------------------- */ @media print { diff --git a/_static/doctools.js b/_static/doctools.js index c5455c9..daccd20 100644 --- a/_static/doctools.js +++ b/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -45,7 +45,7 @@ jQuery.urlencode = encodeURIComponent; * it will always return arrays of strings for the value parts. */ jQuery.getQueryParameters = function(s) { - if (typeof s == 'undefined') + if (typeof s === 'undefined') s = document.location.search; var parts = s.substr(s.indexOf('?') + 1).split('&'); var result = {}; @@ -66,31 +66,80 @@ jQuery.getQueryParameters = function(s) { * span elements with the given class name. */ jQuery.fn.highlightText = function(text, className) { - function highlight(node) { - if (node.nodeType == 3) { + 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)) { - var span = document.createElement("span"); - span.className = className; + 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); + highlight(this, addItems); }); } } - return this.each(function() { - highlight(this); + 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. */ @@ -100,27 +149,30 @@ var Documentation = { 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; }, + 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') + if (typeof translated === 'undefined') return string; - return (typeof translated == 'string') ? translated : translated[0]; + return (typeof translated === 'string') ? translated : translated[0]; }, ngettext : function(singular, plural, n) { var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated == 'undefined') + if (typeof translated === 'undefined') return (n == 1) ? singular : plural; return translated[Documentation.PLURALEXPR(n)]; }, @@ -152,6 +204,7 @@ var Documentation = { /** * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 */ fixFirefoxAnchorBug : function() { if (document.location.hash && $.browser.mozilla) @@ -190,7 +243,7 @@ var Documentation = { var src = $(this).attr('src'); var idnum = $(this).attr('id').substr(7); $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) == 'minus.png') + 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'); @@ -222,11 +275,35 @@ var Documentation = { var path = document.location.pathname; var parts = path.split(/\//); $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this == '..') + 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; + } + } + } + }); } }; diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 0000000..0ff4ae9 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,12 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '1.0.0b2', + 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/_static/file.png b/_static/file.png index d18082e397e7e54f20721af768c4c2983258f1b4..a858a410e4faa62ce324d814e4b816fff83a6fb3 100644 GIT binary patch delta 258 zcmV+d0sa1n1D*nqB!A^eL_t(|0j-mRQU(DOh4(3Yg>2U#+qMST9A?`+K(6HroI1a` zzBAwYe&?=){{H^C^73+6Bth^O4_GbsLfARhO4f6Bz6M)BwD2h-NCBA@-2L}f@ zJUj$BIywsD`1sgR5S8jrCXyuS3)mQ)Y<_}R_w3`1`{pLd8GF6fMOVNSUNp6L0a1Oz z&cgu)wqE?07u5I7qrQIu4Fij)Y3c&0@0u_#NH6I?Mk(n;dT}d~^JfiX^GbOlHe=Ae4>0m)d(f|Me07*qo IM6N<$g13lzp8x;= delta 365 zcmV-z0h0cn0*C{UB!32COGiWi{{a60|De66lK=n!32;bRa{vGf6951U69E94oEQKA z00(qQO+^RQ3l0qj0V%dr8~^|T6-h)vR5;76k+Dj|KoEw%NpdJB7zkSnA|@Po*x6ZH z34&PoFoGdze1-#GK(W;K5CoNUrxDXc#O4IgT?@G*xx{!8|9@(BnEB_M9T^M;7g?4a z&`yV87@h+VMUiQ%D2mL)$(aOso};w}Kt!gaCb5WM+cvK2mQbb!T5FOdDK!)&BJ_H_ z$}Udv5d=XaL7kjpVUb`~a}oHyUo-I?V-~P1tC;}cw0$7nfnFKc7MR@WeNaVDy;r#|UFy>2CCEKe)0& zXMMX=(3!bJBf-($3L;XuL^1cHf#-SrMUGPHDvsmbHcd*YGyY3oRjYJ=I7WWQ00000 LNkvXXu0mjfYdD&R diff --git a/_static/jquery-3.5.1.js b/_static/jquery-3.5.1.js new file mode 100644 index 0000000..5093733 --- /dev/null +++ b/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.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: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; + + + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { + doc = doc || document; + + var i, val, + script = doc.createElement( "script" ); + + script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } + doc.head.appendChild( script ).parentNode.removeChild( script ); + } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} +/* global Symbol */ +// Defining this global in .eslintrc.json would create a danger of using the global +// unguarded in another place, it seems safer to define global only for this module + + + +var + version = "3.5.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 ); + }; + +jQuery.fn = jQuery.prototype = { + + // The current version of jQuery being used + jquery: version, + + constructor: jQuery, + + // The default length of a jQuery object is 0 + length: 0, + + toArray: function() { + return slice.call( this ); + }, + + // Get the Nth element in the matched element set OR + // Get the whole matched element set as a clean array + get: function( num ) { + + // Return all the elements in a clean array + if ( num == null ) { + return slice.call( this ); + } + + // Return just the one element from the set + return num < 0 ? this[ num + this.length ] : this[ num ]; + }, + + // Take an array of elements and push it onto the stack + // (returning the new matched element set) + pushStack: function( elems ) { + + // Build a new jQuery matched element set + var ret = jQuery.merge( this.constructor(), elems ); + + // Add the old object onto the stack (as a reference) + ret.prevObject = this; + + // Return the newly-formed element set + return ret; + }, + + // Execute a callback for every element in the matched set. + each: function( callback ) { + return jQuery.each( this, callback ); + }, + + map: function( callback ) { + return this.pushStack( jQuery.map( this, function( elem, i ) { + return callback.call( elem, i, elem ); + } ) ); + }, + + slice: function() { + return this.pushStack( slice.apply( this, arguments ) ); + }, + + first: function() { + return this.eq( 0 ); + }, + + last: function() { + return this.eq( -1 ); + }, + + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + + eq: function( i ) { + var len = this.length, + j = +i + ( i < 0 ? len : 0 ); + return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] ); + }, + + end: function() { + return this.prevObject || this.constructor(); + }, + + // For internal use only. + // Behaves like an Array's method, not like a jQuery method. + push: push, + sort: arr.sort, + splice: arr.splice +}; + +jQuery.extend = jQuery.fn.extend = function() { + var options, name, src, copy, copyIsArray, clone, + target = arguments[ 0 ] || {}, + i = 1, + length = arguments.length, + deep = false; + + // Handle a deep copy situation + if ( typeof target === "boolean" ) { + deep = target; + + // Skip the boolean and the target + target = arguments[ i ] || {}; + i++; + } + + // Handle case when target is a string or something (possible in deep copy) + if ( typeof target !== "object" && !isFunction( target ) ) { + target = {}; + } + + // Extend jQuery itself if only one argument is passed + if ( i === length ) { + target = this; + i--; + } + + for ( ; i < length; i++ ) { + + // Only deal with non-null/undefined values + if ( ( options = arguments[ i ] ) != null ) { + + // Extend the base object + for ( name in options ) { + copy = options[ name ]; + + // Prevent Object.prototype pollution + // Prevent never-ending loop + if ( name === "__proto__" || target === copy ) { + continue; + } + + // Recurse if we're merging plain objects or arrays + if ( deep && copy && ( jQuery.isPlainObject( copy ) || + ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; + + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; + } else { + clone = src; + } + copyIsArray = false; + + // Never move original objects, clone them + target[ name ] = jQuery.extend( deep, clone, copy ); + + // Don't bring in undefined values + } else if ( copy !== undefined ) { + target[ name ] = copy; + } + } + } + } + + // Return the modified object + return target; +}; + +jQuery.extend( { + + // Unique for each copy of jQuery on the page + expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ), + + // Assume jQuery is ready without the ready module + isReady: true, + + error: function( msg ) { + throw new Error( msg ); + }, + + noop: function() {}, + + isPlainObject: function( obj ) { + var proto, Ctor; + + // Detect obvious negatives + // Use toString instead of jQuery.type to catch host objects + if ( !obj || toString.call( obj ) !== "[object Object]" ) { + return false; + } + + proto = getProto( obj ); + + // Objects with no prototype (e.g., `Object.create( null )`) are plain + if ( !proto ) { + return true; + } + + // Objects with prototype are plain iff they were constructed by a global Object function + Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor; + return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString; + }, + + isEmptyObject: function( obj ) { + var name; + + for ( name in obj ) { + return false; + } + return true; + }, + + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); + }, + + each: function( obj, callback ) { + var length, i = 0; + + if ( isArrayLike( obj ) ) { + length = obj.length; + for ( ; i < length; i++ ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } else { + for ( i in obj ) { + if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) { + break; + } + } + } + + return obj; + }, + + // results is for internal usage only + makeArray: function( arr, results ) { + var ret = results || []; + + if ( arr != null ) { + if ( isArrayLike( Object( arr ) ) ) { + jQuery.merge( ret, + typeof arr === "string" ? + [ arr ] : arr + ); + } else { + push.call( ret, arr ); + } + } + + return ret; + }, + + inArray: function( elem, arr, i ) { + return arr == null ? -1 : indexOf.call( arr, elem, i ); + }, + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + merge: function( first, second ) { + var len = +second.length, + j = 0, + i = first.length; + + for ( ; j < len; j++ ) { + first[ i++ ] = second[ j ]; + } + + first.length = i; + + return first; + }, + + grep: function( elems, callback, invert ) { + var callbackInverse, + matches = [], + i = 0, + length = elems.length, + callbackExpect = !invert; + + // Go through the array, only saving the items + // that pass the validator function + for ( ; i < length; i++ ) { + callbackInverse = !callback( elems[ i ], i ); + if ( callbackInverse !== callbackExpect ) { + matches.push( elems[ i ] ); + } + } + + return matches; + }, + + // arg is for internal usage only + map: function( elems, callback, arg ) { + var length, value, + i = 0, + ret = []; + + // Go through the array, translating each of the items to their new values + if ( isArrayLike( elems ) ) { + length = elems.length; + for ( ; i < length; i++ ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + + // Go through every key on the object, + } else { + for ( i in elems ) { + value = callback( elems[ i ], i, arg ); + + if ( value != null ) { + ret.push( value ); + } + } + } + + // Flatten any nested arrays + return flat( ret ); + }, + + // A global GUID counter for objects + guid: 1, + + // jQuery.support is not used in Core but other projects attach their + // properties to it so it needs to exist. + support: support +} ); + +if ( typeof Symbol === "function" ) { + jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ]; +} + +// Populate the class2type map +jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), +function( _i, name ) { + class2type[ "[object " + name + "]" ] = name.toLowerCase(); +} ); + +function isArrayLike( obj ) { + + // Support: real iOS 8.2 only (not reproducible in simulator) + // `in` check used to prevent JIT error (gh-2145) + // hasOwn isn't used here due to false negatives + // regarding Nodelist length in IE + var length = !!obj && "length" in obj && obj.length, + type = toType( obj ); + + if ( isFunction( obj ) || isWindow( obj ) ) { + return false; + } + + return type === "array" || length === 0 || + typeof length === "number" && length > 0 && ( length - 1 ) in obj; +} +var Sizzle = +/*! + * Sizzle CSS Selector Engine v2.3.5 + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://js.foundation/ + * + * Date: 2020-03-14 + */ +( function( window ) { +var i, + support, + Expr, + getText, + isXML, + tokenize, + compile, + select, + outermostContext, + sortInput, + hasDuplicate, + + // Local document vars + setDocument, + document, + docElem, + documentIsHTML, + rbuggyQSA, + rbuggyMatches, + matches, + contains, + + // Instance-specific data + expando = "sizzle" + 1 * new Date(), + preferredDoc = window.document, + dirruns = 0, + done = 0, + classCache = createCache(), + tokenCache = createCache(), + compilerCache = createCache(), + nonnativeSelectorCache = createCache(), + sortOrder = function( a, b ) { + if ( a === b ) { + hasDuplicate = true; + } + return 0; + }, + + // Instance methods + hasOwn = ( {} ).hasOwnProperty, + arr = [], + pop = arr.pop, + pushNative = arr.push, + push = arr.push, + slice = arr.slice, + + // Use a stripped-down indexOf as it's faster than native + // https://jsperf.com/thor-indexof-vs-for/5 + indexOf = function( list, elem ) { + var i = 0, + len = list.length; + for ( ; i < len; i++ ) { + if ( list[ i ] === elem ) { + return i; + } + } + return -1; + }, + + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", + + // Regular expressions + + // http://www.w3.org/TR/css3-selectors/#whitespace + whitespace = "[\\x20\\t\\r\\n\\f]", + + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", + + // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors + attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + + // Operator (capture 2) + "*([*^$|!~]?=)" + whitespace + + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", + + pseudos = ":(" + identifier + ")(?:\\((" + + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: + // 1. quoted (capture 3; capture 4 or capture 5) + "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + + // 2. simple (capture 6) + "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + + // 3. anything else (capture 2) + ".*" + + ")\\)|)", + + // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter + rwhitespace = new RegExp( whitespace + "+", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), + + rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), + + rpseudo = new RegExp( pseudos ), + ridentifier = new RegExp( "^" + identifier + "$" ), + + matchExpr = { + "ID": new RegExp( "^#(" + identifier + ")" ), + "CLASS": new RegExp( "^\\.(" + identifier + ")" ), + "TAG": new RegExp( "^(" + identifier + "|[*])" ), + "ATTR": new RegExp( "^" + attributes ), + "PSEUDO": new RegExp( "^" + pseudos ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + + // For use in libraries implementing .is() + // We use this for POS matching in `select` + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + }, + + rhtml = /HTML$/i, + rinputs = /^(?:input|select|textarea|button)$/i, + rheader = /^h\d$/i, + + rnative = /^[^{]+\{\s*\[native \w/, + + // Easily-parseable/retrievable ID or TAG or CLASS selectors + rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/, + + rsibling = /[+~]/, + + // CSS escapes + // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair + high < 0 ? + String.fromCharCode( high + 0x10000 ) : + String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); + }, + + // CSS string/identifier serialization + // https://drafts.csswg.org/cssom/#common-serializing-idioms + rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g, + fcssescape = function( ch, asCodePoint ) { + if ( asCodePoint ) { + + // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER + if ( ch === "\0" ) { + return "\uFFFD"; + } + + // Control characters and (dependent upon position) numbers get escaped as code points + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + } + + // Other potentially-special ASCII characters get backslash-escaped + return "\\" + ch; + }, + + // Used for iframes + // See setDocument() + // Removing the function wrapper causes a "Permission Denied" + // error in IE + unloadHandler = function() { + setDocument(); + }, + + inDisabledFieldset = addCombinator( + function( elem ) { + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; + }, + { dir: "parentNode", next: "legend" } + ); + +// Optimize for push.apply( _, NodeList ) +try { + push.apply( + ( arr = slice.call( preferredDoc.childNodes ) ), + preferredDoc.childNodes + ); + + // Support: Android<4.0 + // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions + arr[ preferredDoc.childNodes.length ].nodeType; +} catch ( e ) { + push = { apply: arr.length ? + + // Leverage slice if possible + function( target, els ) { + pushNative.apply( target, slice.call( els ) ); + } : + + // Support: IE<9 + // Otherwise append directly + function( target, els ) { + var j = target.length, + i = 0; + + // Can't trust NodeList.length + while ( ( target[ j++ ] = els[ i++ ] ) ) {} + target.length = j - 1; + } + }; +} + +function Sizzle( selector, context, results, seed ) { + var m, i, elem, nid, match, groups, newSelector, + newContext = context && context.ownerDocument, + + // nodeType defaults to 9, since context defaults to document + nodeType = context ? context.nodeType : 9; + + results = results || []; + + // Return early from calls with invalid selector or context + if ( typeof selector !== "string" || !selector || + nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) { + + return results; + } + + // Try to shortcut find operations (as opposed to filters) in HTML documents + if ( !seed ) { + setDocument( context ); + context = context || document; + + if ( documentIsHTML ) { + + // If the selector is sufficiently simple, try using a "get*By*" DOM method + // (excepting DocumentFragment context, where the methods don't exist) + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { + + // ID selector + if ( ( m = match[ 1 ] ) ) { + + // Document context + if ( nodeType === 9 ) { + if ( ( elem = context.getElementById( m ) ) ) { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( elem.id === m ) { + results.push( elem ); + return results; + } + } else { + return results; + } + + // Element context + } else { + + // Support: IE, Opera, Webkit + // TODO: identify versions + // getElementById can match elements by name instead of ID + if ( newContext && ( elem = newContext.getElementById( m ) ) && + contains( context, elem ) && + elem.id === m ) { + + results.push( elem ); + return results; + } + } + + // Type selector + } else if ( match[ 2 ] ) { + push.apply( results, context.getElementsByTagName( selector ) ); + return results; + + // Class selector + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && + context.getElementsByClassName ) { + + push.apply( results, context.getElementsByClassName( m ) ); + return results; + } + } + + // Take advantage of querySelectorAll + if ( support.qsa && + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && + + // Support: IE 8 only + // Exclude object elements + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { + + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } + } + + // Prefix every selector in the list + groups = tokenize( selector ); + i = groups.length; + while ( i-- ) { + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); + } + newSelector = groups.join( "," ); + } + + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); + } + } + } + } + } + + // All others + return select( selector.replace( rtrim, "$1" ), context, results, seed ); +} + +/** + * Create key-value caches of limited size + * @returns {function(string, object)} Returns the Object data after storing it on itself with + * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength) + * deleting the oldest entry + */ +function createCache() { + var keys = []; + + function cache( key, value ) { + + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) + if ( keys.push( key + " " ) > Expr.cacheLength ) { + + // Only keep the most recent entries + delete cache[ keys.shift() ]; + } + return ( cache[ key + " " ] = value ); + } + return cache; +} + +/** + * Mark a function for special use by Sizzle + * @param {Function} fn The function to mark + */ +function markFunction( fn ) { + fn[ expando ] = true; + return fn; +} + +/** + * Support testing using an element + * @param {Function} fn Passed the created element and returns a boolean result + */ +function assert( fn ) { + var el = document.createElement( "fieldset" ); + + try { + return !!fn( el ); + } catch ( e ) { + return false; + } finally { + + // Remove from its parent by default + if ( el.parentNode ) { + el.parentNode.removeChild( el ); + } + + // release memory in IE + el = null; + } +} + +/** + * Adds the same handler for all of the specified attrs + * @param {String} attrs Pipe-separated list of attributes + * @param {Function} handler The method that will be applied + */ +function addHandle( attrs, handler ) { + var arr = attrs.split( "|" ), + i = arr.length; + + while ( i-- ) { + Expr.attrHandle[ arr[ i ] ] = handler; + } +} + +/** + * Checks document order of two siblings + * @param {Element} a + * @param {Element} b + * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b + */ +function siblingCheck( a, b ) { + var cur = b && a, + diff = cur && a.nodeType === 1 && b.nodeType === 1 && + a.sourceIndex - b.sourceIndex; + + // Use IE sourceIndex if available on both nodes + if ( diff ) { + return diff; + } + + // Check if b follows a + if ( cur ) { + while ( ( cur = cur.nextSibling ) ) { + if ( cur === b ) { + return -1; + } + } + } + + return a ? 1 : -1; +} + +/** + * Returns a function to use in pseudos for input types + * @param {String} type + */ +function createInputPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for buttons + * @param {String} type + */ +function createButtonPseudo( type ) { + return function( elem ) { + var name = elem.nodeName.toLowerCase(); + return ( name === "input" || name === "button" ) && elem.type === type; + }; +} + +/** + * Returns a function to use in pseudos for :enabled/:disabled + * @param {Boolean} disabled true for :disabled; false for :enabled + */ +function createDisabledPseudo( disabled ) { + + // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable + return function( elem ) { + + // Only certain elements can match :enabled or :disabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled + // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled + if ( "form" in elem ) { + + // Check for inherited disabledness on relevant non-disabled elements: + // * listed form-associated elements in a disabled fieldset + // https://html.spec.whatwg.org/multipage/forms.html#category-listed + // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled + // * option elements in a disabled optgroup + // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled + // All such elements have a "form" property. + if ( elem.parentNode && elem.disabled === false ) { + + // Option elements defer to a parent optgroup if present + if ( "label" in elem ) { + if ( "label" in elem.parentNode ) { + return elem.parentNode.disabled === disabled; + } else { + return elem.disabled === disabled; + } + } + + // Support: IE 6 - 11 + // Use the isDisabled shortcut property to check for disabled fieldset ancestors + return elem.isDisabled === disabled || + + // Where there is no isDisabled, check manually + /* jshint -W018 */ + elem.isDisabled !== !disabled && + inDisabledFieldset( elem ) === disabled; + } + + return elem.disabled === disabled; + + // Try to winnow out elements that can't be disabled before trusting the disabled property. + // Some victims get caught in our net (label, legend, menu, track), but it shouldn't + // even exist on them, let alone have a boolean value. + } else if ( "label" in elem ) { + return elem.disabled === disabled; + } + + // Remaining elements are neither :enabled nor :disabled + return false; + }; +} + +/** + * Returns a function to use in pseudos for positionals + * @param {Function} fn + */ +function createPositionalPseudo( fn ) { + return markFunction( function( argument ) { + argument = +argument; + return markFunction( function( seed, matches ) { + var j, + matchIndexes = fn( [], seed.length, argument ), + i = matchIndexes.length; + + // Match elements found at the specified indexes + while ( i-- ) { + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); + } + } + } ); + } ); +} + +/** + * Checks a node for validity as a Sizzle context + * @param {Element|Object=} context + * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value + */ +function testContext( context ) { + return context && typeof context.getElementsByTagName !== "undefined" && context; +} + +// Expose support vars for convenience +support = Sizzle.support = {}; + +/** + * Detects XML nodes + * @param {Element|Object} elem An element or a document + * @returns {Boolean} True iff elem is a non-HTML XML node + */ +isXML = Sizzle.isXML = function( elem ) { + var namespace = elem.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 + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { + return document; + } + + // Update global variables + document = doc; + docElem = document.documentElement; + documentIsHTML = !isXML( document ); + + // Support: IE 9 - 11+, Edge 12 - 18+ + // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { + + // Support: IE 11, Edge + if ( subWindow.addEventListener ) { + subWindow.addEventListener( "unload", unloadHandler, false ); + + // Support: IE 9 - 10 only + } else if ( subWindow.attachEvent ) { + subWindow.attachEvent( "onunload", unloadHandler ); + } + } + + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + + /* Attributes + ---------------------------------------------------------------------- */ + + // Support: IE<8 + // Verify that getAttribute really returns attributes and not properties + // (excepting IE8 booleans) + support.attributes = assert( function( el ) { + el.className = "i"; + return !el.getAttribute( "className" ); + } ); + + /* getElement(s)By* + ---------------------------------------------------------------------- */ + + // Check if getElementsByTagName("*") returns only elements + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); + + // Support: IE<9 + support.getElementsByClassName = rnative.test( document.getElementsByClassName ); + + // Support: IE<10 + // Check if getElementById returns elements by name + // The broken getElementById methods don't pick up programmatically-set names, + // so use a roundabout getElementsByName test + support.getById = assert( function( el ) { + docElem.appendChild( el ).id = expando; + return !document.getElementsByName || !document.getElementsByName( expando ).length; + } ); + + // ID filter and find + if ( support.getById ) { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + return elem.getAttribute( "id" ) === attrId; + }; + }; + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var elem = context.getElementById( id ); + return elem ? [ elem ] : []; + } + }; + } else { + Expr.filter[ "ID" ] = function( id ) { + var attrId = id.replace( runescape, funescape ); + return function( elem ) { + var node = typeof elem.getAttributeNode !== "undefined" && + elem.getAttributeNode( "id" ); + return node && node.value === attrId; + }; + }; + + // Support: IE 6 - 7 only + // getElementById is not reliable as a find shortcut + Expr.find[ "ID" ] = function( id, context ) { + if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { + var node, i, elems, + elem = context.getElementById( id ); + + if ( elem ) { + + // Verify the id attribute + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + + // Fall back on getElementsByName + elems = context.getElementsByName( id ); + i = 0; + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); + if ( node && node.value === id ) { + return [ elem ]; + } + } + } + + return []; + } + }; + } + + // Tag + Expr.find[ "TAG" ] = support.getElementsByTagName ? + function( tag, context ) { + if ( typeof context.getElementsByTagName !== "undefined" ) { + return context.getElementsByTagName( tag ); + + // DocumentFragment nodes don't have gEBTN + } else if ( support.qsa ) { + return context.querySelectorAll( tag ); + } + } : + + function( tag, context ) { + var elem, + tmp = [], + i = 0, + + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too + results = context.getElementsByTagName( tag ); + + // Filter out possible comments + if ( tag === "*" ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem.nodeType === 1 ) { + tmp.push( elem ); + } + } + + return tmp; + } + return results; + }; + + // Class + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { + if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { + return context.getElementsByClassName( className ); + } + }; + + /* QSA/matchesSelector + ---------------------------------------------------------------------- */ + + // QSA and matchesSelector support + + // matchesSelector(:active) reports false when true (IE9/Opera 11.5) + rbuggyMatches = []; + + // qSa(:focus) reports false when true (Chrome 21) + // We allow this because of a bug in IE8/9 that throws an error + // whenever `document.activeElement` is accessed on an iframe + // So, we allow :focus to pass through QSA all the time to avoid the IE error + // See https://bugs.jquery.com/ticket/13378 + rbuggyQSA = []; + + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + + // Build QSA regex + // Regex strategy adopted from Diego Perini + assert( function( el ) { + + var input; + + // Select is set to empty string on purpose + // This is to test IE's treatment of not explicitly + // setting a boolean content attribute, + // since its presence should be enough + // https://bugs.jquery.com/ticket/12359 + docElem.appendChild( el ).innerHTML = "" + + ""; + + // Support: IE8, Opera 11-12.16 + // Nothing should be selected when empty strings follow ^= or $= or *= + // The test attribute must be unknown in Opera but "safe" for WinRT + // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { + rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); + } + + // Support: IE8 + // Boolean attributes and "value" are not treated correctly + if ( !el.querySelectorAll( "[selected]" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); + } + + // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ + if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); + } + + // Webkit/Opera - :checked should return selected option elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + // IE8 throws error here and will not see later tests + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); + } + + // Support: Safari 8+, iOS 8+ + // https://bugs.webkit.org/show_bug.cgi?id=136851 + // In-page `selector#id sibling-combinator selector` fails + if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { + rbuggyQSA.push( ".#.+[+~]" ); + } + + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { + el.innerHTML = "" + + ""; + + // Support: Windows 8 Native Apps + // The type and name attributes are restricted during .innerHTML assignment + var input = document.createElement( "input" ); + input.setAttribute( "type", "hidden" ); + el.appendChild( input ).setAttribute( "name", "D" ); + + // Support: IE8 + // Enforce case-sensitivity of name attribute + if ( el.querySelectorAll( "[name=d]" ).length ) { + rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); + } + + // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) + // IE8 throws error here and will not see later tests + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: IE9-11+ + // IE's :disabled selector does not pick up the children of disabled fieldsets + docElem.appendChild( el ).disabled = true; + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { + rbuggyQSA.push( ":enabled", ":disabled" ); + } + + // Support: Opera 10 - 11 only + // Opera 10-11 does not throw on post-comma invalid pseudos + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); + } + + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || + docElem.webkitMatchesSelector || + docElem.mozMatchesSelector || + docElem.oMatchesSelector || + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { + + // Check to see if it's possible to do matchesSelector + // on a disconnected node (IE 9) + support.disconnectedMatch = matches.call( el, "*" ); + + // This should fail with an exception + // Gecko does not error, returns false instead + matches.call( el, "[s!='']:x" ); + rbuggyMatches.push( "!=", pseudos ); + } ); + } + + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); + + /* Contains + ---------------------------------------------------------------------- */ + hasCompare = rnative.test( docElem.compareDocumentPosition ); + + // Element contains another + // Purposefully self-exclusive + // As in, an element does not contain itself + contains = hasCompare || rnative.test( docElem.contains ) ? + function( a, b ) { + var adown = a.nodeType === 9 ? a.documentElement : a, + bup = b && b.parentNode; + return a === bup || !!( bup && bup.nodeType === 1 && ( + adown.contains ? + adown.contains( bup ) : + a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 + ) ); + } : + function( a, b ) { + if ( b ) { + while ( ( b = b.parentNode ) ) { + if ( b === a ) { + return true; + } + } + } + return false; + }; + + /* Sorting + ---------------------------------------------------------------------- */ + + // Document order sorting + sortOrder = hasCompare ? + function( a, b ) { + + // Flag for duplicate removal + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + // Sort on method existence if only one input has compareDocumentPosition + var compare = !a.compareDocumentPosition - !b.compareDocumentPosition; + if ( compare ) { + return compare; + } + + // Calculate position if both inputs belong to the same document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? + a.compareDocumentPosition( b ) : + + // Otherwise we know they are disconnected + 1; + + // Disconnected nodes + if ( compare & 1 || + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { + + // Choose the first element that is related to our preferred document + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { + return -1; + } + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { + return 1; + } + + // Maintain original order + return sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + } + + return compare & 4 ? -1 : 1; + } : + function( a, b ) { + + // Exit early if the nodes are identical + if ( a === b ) { + hasDuplicate = true; + return 0; + } + + var cur, + i = 0, + aup = a.parentNode, + bup = b.parentNode, + ap = [ a ], + bp = [ b ]; + + // Parentless nodes are either documents or disconnected + if ( !aup || !bup ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ + aup ? -1 : + bup ? 1 : + sortInput ? + ( indexOf( sortInput, a ) - indexOf( sortInput, b ) ) : + 0; + + // If the nodes are siblings, we can do a quick check + } else if ( aup === bup ) { + return siblingCheck( a, b ); + } + + // Otherwise we need full lists of their ancestors for comparison + cur = a; + while ( ( cur = cur.parentNode ) ) { + ap.unshift( cur ); + } + cur = b; + while ( ( cur = cur.parentNode ) ) { + bp.unshift( cur ); + } + + // Walk down the tree looking for a discrepancy + while ( ap[ i ] === bp[ i ] ) { + i++; + } + + return i ? + + // Do a sibling check if the nodes have a common ancestor + siblingCheck( ap[ i ], bp[ i ] ) : + + // Otherwise nodes in our document sort first + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ + 0; + }; + + return document; +}; + +Sizzle.matches = function( expr, elements ) { + return Sizzle( expr, null, null, elements ); +}; + +Sizzle.matchesSelector = function( elem, expr ) { + setDocument( elem ); + + if ( support.matchesSelector && documentIsHTML && + !nonnativeSelectorCache[ expr + " " ] && + ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && + ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { + + try { + var ret = matches.call( elem, expr ); + + // IE 9's matchesSelector returns false on disconnected nodes + if ( ret || support.disconnectedMatch || + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { + return ret; + } + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } + } + + return Sizzle( expr, document, null, [ elem ] ).length > 0; +}; + +Sizzle.contains = function( context, elem ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { + setDocument( context ); + } + return contains( context, elem ); +}; + +Sizzle.attr = function( elem, name ) { + + // Set document vars if needed + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { + setDocument( elem ); + } + + var fn = Expr.attrHandle[ name.toLowerCase() ], + + // Don't get fooled by Object.prototype properties (jQuery #13807) + val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? + fn( elem, name, !documentIsHTML ) : + undefined; + + return val !== undefined ? + val : + support.attributes || !documentIsHTML ? + elem.getAttribute( name ) : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; +}; + +Sizzle.escape = function( sel ) { + return ( sel + "" ).replace( rcssescape, fcssescape ); +}; + +Sizzle.error = function( msg ) { + throw new Error( "Syntax error, unrecognized expression: " + msg ); +}; + +/** + * Document sorting and removing duplicates + * @param {ArrayLike} results + */ +Sizzle.uniqueSort = function( results ) { + var elem, + duplicates = [], + j = 0, + i = 0; + + // Unless we *know* we can detect duplicates, assume their presence + hasDuplicate = !support.detectDuplicates; + sortInput = !support.sortStable && results.slice( 0 ); + results.sort( sortOrder ); + + if ( hasDuplicate ) { + while ( ( elem = results[ i++ ] ) ) { + if ( elem === results[ i ] ) { + j = duplicates.push( i ); + } + } + while ( j-- ) { + results.splice( duplicates[ j ], 1 ); + } + } + + // Clear input after sorting to release objects + // See https://github.com/jquery/sizzle/pull/225 + sortInput = null; + + return results; +}; + +/** + * Utility function for retrieving the text value of an array of DOM nodes + * @param {Array|Element} elem + */ +getText = Sizzle.getText = function( elem ) { + var node, + ret = "", + i = 0, + nodeType = elem.nodeType; + + if ( !nodeType ) { + + // If no nodeType, this is expected to be an array + while ( ( node = elem[ i++ ] ) ) { + + // Do not traverse comment nodes + ret += getText( node ); + } + } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + + // Use textContent for elements + // innerText usage removed for consistency of new lines (jQuery #11153) + if ( typeof elem.textContent === "string" ) { + return elem.textContent; + } else { + + // Traverse its children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + ret += getText( elem ); + } + } + } else if ( nodeType === 3 || nodeType === 4 ) { + return elem.nodeValue; + } + + // Do not include comment or processing instruction nodes + + return ret; +}; + +Expr = Sizzle.selectors = { + + // Can be adjusted by the user + cacheLength: 50, + + createPseudo: markFunction, + + match: matchExpr, + + attrHandle: {}, + + find: {}, + + relative: { + ">": { dir: "parentNode", first: true }, + " ": { dir: "parentNode" }, + "+": { dir: "previousSibling", first: true }, + "~": { dir: "previousSibling" } + }, + + preFilter: { + "ATTR": function( match ) { + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); + + // Move the given value to match[3] whether quoted or unquoted + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); + + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; + } + + return match.slice( 0, 4 ); + }, + + "CHILD": function( match ) { + + /* matches from matchExpr["CHILD"] + 1 type (only|nth|...) + 2 what (child|of-type) + 3 argument (even|odd|\d*|\d*n([+-]\d+)?|...) + 4 xn-component of xn+y argument ([+-]?\d*n|) + 5 sign of xn-component + 6 x of xn-component + 7 sign of y-component + 8 y of y-component + */ + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { + + // nth-* requires argument + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + // numeric x and y parameters for Expr.filter.CHILD + // remember that false/true cast respectively to 0/1 + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); + + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); + } + + return match; + }, + + "PSEUDO": function( match ) { + var excess, + unquoted = !match[ 6 ] && match[ 2 ]; + + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { + return null; + } + + // Accept quoted arguments as-is + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; + + // Strip excess characters from unquoted arguments + } else if ( unquoted && rpseudo.test( unquoted ) && + + // Get excess from tokenize (recursively) + ( excess = tokenize( unquoted, true ) ) && + + // advance to the next closing parenthesis + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { + + // excess is a negative index + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); + } + + // Return only captures needed by the pseudo filter method (type and argument) + return match.slice( 0, 3 ); + } + }, + + filter: { + + "TAG": function( nodeNameSelector ) { + var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); + return nodeNameSelector === "*" ? + function() { + return true; + } : + function( elem ) { + return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; + }; + }, + + "CLASS": function( className ) { + var pattern = classCache[ className + " " ]; + + return pattern || + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); + }, + + "ATTR": function( name, operator, check ) { + return function( elem ) { + var result = Sizzle.attr( elem, name ); + + if ( result == null ) { + return operator === "!="; + } + if ( !operator ) { + return true; + } + + result += ""; + + /* eslint-disable max-len */ + + return operator === "=" ? result === check : + operator === "!=" ? result !== check : + operator === "^=" ? check && result.indexOf( check ) === 0 : + operator === "*=" ? check && result.indexOf( check ) > -1 : + operator === "$=" ? check && result.slice( -check.length ) === check : + operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : + operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : + false; + /* eslint-enable max-len */ + + }; + }, + + "CHILD": function( type, what, _argument, first, last ) { + var simple = type.slice( 0, 3 ) !== "nth", + forward = type.slice( -4 ) !== "last", + ofType = what === "of-type"; + + return first === 1 && last === 0 ? + + // Shortcut for :nth-*(n) + function( elem ) { + return !!elem.parentNode; + } : + + function( elem, _context, xml ) { + var cache, uniqueCache, outerCache, node, nodeIndex, start, + dir = simple !== forward ? "nextSibling" : "previousSibling", + parent = elem.parentNode, + name = ofType && elem.nodeName.toLowerCase(), + useCache = !xml && !ofType, + diff = false; + + if ( parent ) { + + // :(first|last|only)-(child|of-type) + if ( simple ) { + while ( dir ) { + node = elem; + while ( ( node = node[ dir ] ) ) { + if ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) { + + return false; + } + } + + // Reverse direction for :only-* (if we haven't yet done so) + start = dir = type === "only" && !start && "nextSibling"; + } + return true; + } + + start = [ forward ? parent.firstChild : parent.lastChild ]; + + // non-xml :nth-child(...) stores cache data on `parent` + if ( forward && useCache ) { + + // Seek `elem` from a previously-cached index + + // ...in a gzip-friendly way + node = parent; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex && cache[ 2 ]; + node = nodeIndex && parent.childNodes[ nodeIndex ]; + + while ( ( node = ++nodeIndex && node && node[ dir ] || + + // Fallback to seeking `elem` from the start + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + // When found, cache indexes on `parent` and break + if ( node.nodeType === 1 && ++diff && node === elem ) { + uniqueCache[ type ] = [ dirruns, nodeIndex, diff ]; + break; + } + } + + } else { + + // Use previously-cached element index if available + if ( useCache ) { + + // ...in a gzip-friendly way + node = elem; + outerCache = node[ expando ] || ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + cache = uniqueCache[ type ] || []; + nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; + diff = nodeIndex; + } + + // xml :nth-child(...) + // or :nth-last-child(...) or :nth(-last)?-of-type(...) + if ( diff === false ) { + + // Use the same loop as above to seek `elem` from the start + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { + + if ( ( ofType ? + node.nodeName.toLowerCase() === name : + node.nodeType === 1 ) && + ++diff ) { + + // Cache the index of each encountered element + if ( useCache ) { + outerCache = node[ expando ] || + ( node[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ node.uniqueID ] || + ( outerCache[ node.uniqueID ] = {} ); + + uniqueCache[ type ] = [ dirruns, diff ]; + } + + if ( node === elem ) { + break; + } + } + } + } + } + + // Incorporate the offset, then check against cycle size + diff -= last; + return diff === first || ( diff % first === 0 && diff / first >= 0 ); + } + }; + }, + + "PSEUDO": function( pseudo, argument ) { + + // pseudo-class names are case-insensitive + // http://www.w3.org/TR/selectors/#pseudo-classes + // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters + // Remember that setFilters inherits from pseudos + var args, + fn = Expr.pseudos[ pseudo ] || Expr.setFilters[ pseudo.toLowerCase() ] || + Sizzle.error( "unsupported pseudo: " + pseudo ); + + // The user may use createPseudo to indicate that + // arguments are needed to create the filter function + // just as Sizzle does + if ( fn[ expando ] ) { + return fn( argument ); + } + + // But maintain support for old signatures + if ( fn.length > 1 ) { + args = [ pseudo, pseudo, "", argument ]; + return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? + markFunction( function( seed, matches ) { + var idx, + matched = fn( seed, argument ), + i = matched.length; + while ( i-- ) { + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); + } + } ) : + function( elem ) { + return fn( elem, 0, args ); + }; + } + + return fn; + } + }, + + pseudos: { + + // Potentially complex pseudos + "not": markFunction( function( selector ) { + + // Trim the selector passed to compile + // to avoid treating leading and trailing + // spaces as combinators + var input = [], + results = [], + matcher = compile( selector.replace( rtrim, "$1" ) ); + + return matcher[ expando ] ? + markFunction( function( seed, matches, _context, xml ) { + var elem, + unmatched = matcher( seed, null, xml, [] ), + i = seed.length; + + // Match elements unmatched by `matcher` + while ( i-- ) { + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); + } + } + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; + matcher( input, null, xml, results ); + + // Don't keep the element (issue #299) + input[ 0 ] = null; + return !results.pop(); + }; + } ), + + "has": markFunction( function( selector ) { + return function( elem ) { + return Sizzle( selector, elem ).length > 0; + }; + } ), + + "contains": markFunction( function( text ) { + text = text.replace( runescape, funescape ); + return function( elem ) { + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; + }; + } ), + + // "Whether an element is represented by a :lang() selector + // is based solely on the element's language value + // being equal to the identifier C, + // or beginning with the identifier C immediately followed by "-". + // The matching of C against the element's language value is performed case-insensitively. + // The identifier C does not have to be a valid language name." + // http://www.w3.org/TR/selectors/#lang-pseudo + "lang": markFunction( function( lang ) { + + // lang value must be a valid identifier + if ( !ridentifier.test( lang || "" ) ) { + Sizzle.error( "unsupported lang: " + lang ); + } + lang = lang.replace( runescape, funescape ).toLowerCase(); + return function( elem ) { + var elemLang; + do { + if ( ( elemLang = documentIsHTML ? + elem.lang : + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { + + elemLang = elemLang.toLowerCase(); + return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; + } + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); + return false; + }; + } ), + + // Miscellaneous + "target": function( elem ) { + var hash = window.location && window.location.hash; + return hash && hash.slice( 1 ) === elem.id; + }, + + "root": function( elem ) { + return elem === docElem; + }, + + "focus": function( elem ) { + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); + }, + + // Boolean properties + "enabled": createDisabledPseudo( false ), + "disabled": createDisabledPseudo( true ), + + "checked": function( elem ) { + + // In CSS3, :checked should return both checked and selected elements + // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked + var nodeName = elem.nodeName.toLowerCase(); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); + }, + + "selected": function( elem ) { + + // Accessing this property makes selected-by-default + // options in Safari work properly + if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions + elem.parentNode.selectedIndex; + } + + return elem.selected === true; + }, + + // Contents + "empty": function( elem ) { + + // http://www.w3.org/TR/selectors/#empty-pseudo + // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), + // but not by others (comment: 8; processing instruction: 7; etc.) + // nodeType < 6 works because attributes (2) do not appear as children + for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { + if ( elem.nodeType < 6 ) { + return false; + } + } + return true; + }, + + "parent": function( elem ) { + return !Expr.pseudos[ "empty" ]( elem ); + }, + + // Element/input types + "header": function( elem ) { + return rheader.test( elem.nodeName ); + }, + + "input": function( elem ) { + return rinputs.test( elem.nodeName ); + }, + + "button": function( elem ) { + var name = elem.nodeName.toLowerCase(); + return name === "input" && elem.type === "button" || name === "button"; + }, + + "text": function( elem ) { + var attr; + return elem.nodeName.toLowerCase() === "input" && + elem.type === "text" && + + // Support: IE<8 + // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); + }, + + // Position-in-collection + "first": createPositionalPseudo( function() { + return [ 0 ]; + } ), + + "last": createPositionalPseudo( function( _matchIndexes, length ) { + return [ length - 1 ]; + } ), + + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { + return [ argument < 0 ? argument + length : argument ]; + } ), + + "even": createPositionalPseudo( function( matchIndexes, length ) { + var i = 0; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "odd": createPositionalPseudo( function( matchIndexes, length ) { + var i = 1; + for ( ; i < length; i += 2 ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; + for ( ; --i >= 0; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ), + + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? argument + length : argument; + for ( ; ++i < length; ) { + matchIndexes.push( i ); + } + return matchIndexes; + } ) + } +}; + +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; + +// Add button/input type pseudos +for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { + Expr.pseudos[ i ] = createInputPseudo( i ); +} +for ( i in { submit: true, reset: true } ) { + Expr.pseudos[ i ] = createButtonPseudo( i ); +} + +// Easy API for creating new setFilters +function setFilters() {} +setFilters.prototype = Expr.filters = Expr.pseudos; +Expr.setFilters = new setFilters(); + +tokenize = Sizzle.tokenize = function( selector, parseOnly ) { + var matched, match, tokens, type, + soFar, groups, preFilters, + cached = tokenCache[ selector + " " ]; + + if ( cached ) { + return parseOnly ? 0 : cached.slice( 0 ); + } + + soFar = selector; + groups = []; + preFilters = Expr.preFilter; + + while ( soFar ) { + + // Comma and first run + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { + if ( match ) { + + // Don't consume trailing commas as valid + soFar = soFar.slice( match[ 0 ].length ) || soFar; + } + groups.push( ( tokens = [] ) ); + } + + matched = false; + + // Combinators + if ( ( match = rcombinators.exec( soFar ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + + // Cast descendant combinators to space + type: match[ 0 ].replace( rtrim, " " ) + } ); + soFar = soFar.slice( matched.length ); + } + + // Filters + for ( type in Expr.filter ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { + matched = match.shift(); + tokens.push( { + value: matched, + type: type, + matches: match + } ); + soFar = soFar.slice( matched.length ); + } + } + + if ( !matched ) { + break; + } + } + + // Return the length of the invalid excess + // if we're just parsing + // Otherwise, throw an error or return tokens + return parseOnly ? + soFar.length : + soFar ? + Sizzle.error( selector ) : + + // Cache the tokens + tokenCache( selector, groups ).slice( 0 ); +}; + +function toSelector( tokens ) { + var i = 0, + len = tokens.length, + selector = ""; + for ( ; i < len; i++ ) { + selector += tokens[ i ].value; + } + return selector; +} + +function addCombinator( matcher, combinator, base ) { + var dir = combinator.dir, + skip = combinator.next, + key = skip || dir, + checkNonElements = base && key === "parentNode", + doneName = done++; + + return combinator.first ? + + // Check against closest ancestor/preceding element + function( elem, context, xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + return matcher( elem, context, xml ); + } + } + return false; + } : + + // Check against all ancestor/preceding elements + function( elem, context, xml ) { + var oldCache, uniqueCache, outerCache, + newCache = [ dirruns, doneName ]; + + // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching + if ( xml ) { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + if ( matcher( elem, context, xml ) ) { + return true; + } + } + } + } else { + while ( ( elem = elem[ dir ] ) ) { + if ( elem.nodeType === 1 || checkNonElements ) { + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); + + // Support: IE <9 only + // Defend against cloned attroperties (jQuery gh-1709) + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); + + if ( skip && skip === elem.nodeName.toLowerCase() ) { + elem = elem[ dir ] || elem; + } else if ( ( oldCache = uniqueCache[ key ] ) && + oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { + + // Assign to newCache so results back-propagate to previous elements + return ( newCache[ 2 ] = oldCache[ 2 ] ); + } else { + + // Reuse newcache so results back-propagate to previous elements + uniqueCache[ key ] = newCache; + + // A match means we're done; a fail means we have to keep checking + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { + return true; + } + } + } + } + } + return false; + }; +} + +function elementMatcher( matchers ) { + return matchers.length > 1 ? + function( elem, context, xml ) { + var i = matchers.length; + while ( i-- ) { + if ( !matchers[ i ]( elem, context, xml ) ) { + return false; + } + } + return true; + } : + matchers[ 0 ]; +} + +function multipleContexts( selector, contexts, results ) { + var i = 0, + len = contexts.length; + for ( ; i < len; i++ ) { + Sizzle( selector, contexts[ i ], results ); + } + return results; +} + +function condense( unmatched, map, filter, context, xml ) { + var elem, + newUnmatched = [], + i = 0, + len = unmatched.length, + mapped = map != null; + + for ( ; i < len; i++ ) { + if ( ( elem = unmatched[ i ] ) ) { + if ( !filter || filter( elem, context, xml ) ) { + newUnmatched.push( elem ); + if ( mapped ) { + map.push( i ); + } + } + } + } + + return newUnmatched; +} + +function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postSelector ) { + if ( postFilter && !postFilter[ expando ] ) { + postFilter = setMatcher( postFilter ); + } + if ( postFinder && !postFinder[ expando ] ) { + postFinder = setMatcher( postFinder, postSelector ); + } + return markFunction( function( seed, results, context, xml ) { + var temp, i, elem, + preMap = [], + postMap = [], + preexisting = results.length, + + // Get initial elements from seed or context + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), + + // Prefilter to get matcher input, preserving a map for seed-results synchronization + matcherIn = preFilter && ( seed || !selector ) ? + condense( elems, preMap, preFilter, context, xml ) : + elems, + + matcherOut = matcher ? + + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, + postFinder || ( seed ? preFilter : preexisting || postFilter ) ? + + // ...intermediate processing is necessary + [] : + + // ...otherwise use results directly + results : + matcherIn; + + // Find primary matches + if ( matcher ) { + matcher( matcherIn, matcherOut, context, xml ); + } + + // Apply postFilter + if ( postFilter ) { + temp = condense( matcherOut, postMap ); + postFilter( temp, [], context, xml ); + + // Un-match failing elements by moving them back to matcherIn + i = temp.length; + while ( i-- ) { + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); + } + } + } + + if ( seed ) { + if ( postFinder || preFilter ) { + if ( postFinder ) { + + // Get the final matcherOut by condensing this intermediate into postFinder contexts + temp = []; + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) ) { + + // Restore matcherIn since elem is not yet a final match + temp.push( ( matcherIn[ i ] = elem ) ); + } + } + postFinder( null, ( matcherOut = [] ), temp, xml ); + } + + // Move matched elements from seed to results to keep them synchronized + i = matcherOut.length; + while ( i-- ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { + + seed[ temp ] = !( results[ temp ] = elem ); + } + } + } + + // Add elements to results, through postFinder if defined + } else { + matcherOut = condense( + matcherOut === results ? + matcherOut.splice( preexisting, matcherOut.length ) : + matcherOut + ); + if ( postFinder ) { + postFinder( null, results, matcherOut, xml ); + } else { + push.apply( results, matcherOut ); + } + } + } ); +} + +function matcherFromTokens( tokens ) { + var checkContext, matcher, j, + len = tokens.length, + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], + i = leadingRelative ? 1 : 0, + + // The foundational matcher ensures that elements are reachable from top-level context(s) + matchContext = addCombinator( function( elem ) { + return elem === checkContext; + }, implicitRelative, true ), + matchAnyContext = addCombinator( function( elem ) { + return indexOf( checkContext, elem ) > -1; + }, implicitRelative, true ), + matchers = [ function( elem, context, xml ) { + var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( + ( checkContext = context ).nodeType ? + matchContext( elem, context, xml ) : + matchAnyContext( elem, context, xml ) ); + + // Avoid hanging onto element (issue #299) + checkContext = null; + return ret; + } ]; + + for ( ; i < len; i++ ) { + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; + } else { + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); + + // Return special upon seeing a positional matcher + if ( matcher[ expando ] ) { + + // Find the next relative operator (if any) for proper handling + j = ++i; + for ( ; j < len; j++ ) { + if ( Expr.relative[ tokens[ j ].type ] ) { + break; + } + } + return setMatcher( + i > 1 && elementMatcher( matchers ), + i > 1 && toSelector( + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) + ).replace( rtrim, "$1" ), + matcher, + i < j && matcherFromTokens( tokens.slice( i, j ) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), + j < len && toSelector( tokens ) + ); + } + matchers.push( matcher ); + } + } + + return elementMatcher( matchers ); +} + +function matcherFromGroupMatchers( elementMatchers, setMatchers ) { + var bySet = setMatchers.length > 0, + byElement = elementMatchers.length > 0, + superMatcher = function( seed, context, xml, results, outermost ) { + var elem, j, matcher, + matchedCount = 0, + i = "0", + unmatched = seed && [], + setMatched = [], + contextBackup = outermostContext, + + // We must always have either seed elements or outermost context + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + + // Use integer dirruns iff this is the outermost matcher + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), + len = elems.length; + + if ( outermost ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; + } + + // Add elements passing elementMatchers directly to results + // Support: IE<9, Safari + // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { + if ( byElement && elem ) { + j = 0; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { + setDocument( elem ); + xml = !documentIsHTML; + } + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { + results.push( elem ); + break; + } + } + if ( outermost ) { + dirruns = dirrunsUnique; + } + } + + // Track unmatched elements for set filters + if ( bySet ) { + + // They will have gone through all possible matchers + if ( ( elem = !matcher && elem ) ) { + matchedCount--; + } + + // Lengthen the array for every element, matched or not + if ( seed ) { + unmatched.push( elem ); + } + } + } + + // `i` is now the count of elements visited above, and adding it to `matchedCount` + // makes the latter nonnegative. + matchedCount += i; + + // Apply set filters to unmatched elements + // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount` + // equals `i`), unless we didn't visit _any_ elements in the above loop because we have + // no element matchers and no seed. + // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that + // case, which will result in a "00" `matchedCount` that differs from `i` but is also + // numerically zero. + if ( bySet && i !== matchedCount ) { + j = 0; + while ( ( matcher = setMatchers[ j++ ] ) ) { + matcher( unmatched, setMatched, context, xml ); + } + + if ( seed ) { + + // Reintegrate element matches to eliminate the need for sorting + if ( matchedCount > 0 ) { + while ( i-- ) { + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); + } + } + } + + // Discard index placeholder values to get only actual matches + setMatched = condense( setMatched ); + } + + // Add matches to results + push.apply( results, setMatched ); + + // Seedless set matches succeeding multiple successful matchers stipulate sorting + if ( outermost && !seed && setMatched.length > 0 && + ( matchedCount + setMatchers.length ) > 1 ) { + + Sizzle.uniqueSort( results ); + } + } + + // Override manipulation of globals by nested matchers + if ( outermost ) { + dirruns = dirrunsUnique; + outermostContext = contextBackup; + } + + return unmatched; + }; + + return bySet ? + markFunction( superMatcher ) : + superMatcher; +} + +compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { + var i, + setMatchers = [], + elementMatchers = [], + cached = compilerCache[ selector + " " ]; + + if ( !cached ) { + + // Generate a function of recursive functions that can be used to check each element + if ( !match ) { + match = tokenize( selector ); + } + i = match.length; + while ( i-- ) { + cached = matcherFromTokens( match[ i ] ); + if ( cached[ expando ] ) { + setMatchers.push( cached ); + } else { + elementMatchers.push( cached ); + } + } + + // Cache the compiled function + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); + + // Save selector and tokenization + cached.selector = selector; + } + return cached; +}; + +/** + * A low-level selection function that works with Sizzle's compiled + * selector functions + * @param {String|Function} selector A selector or a pre-compiled + * selector function built with Sizzle.compile + * @param {Element} context + * @param {Array} [results] + * @param {Array} [seed] A set of elements to match against + */ +select = Sizzle.select = function( selector, context, results, seed ) { + var i, tokens, token, type, find, + compiled = typeof selector === "function" && selector, + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); + + results = results || []; + + // Try to minimize operations if there is only one selector in the list and no seed + // (the latter of which guarantees us context) + if ( match.length === 1 ) { + + // Reduce context if the leading compound selector is an ID + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { + + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; + if ( !context ) { + return results; + + // Precompiled matchers will still verify ancestry, so step up a level + } else if ( compiled ) { + context = context.parentNode; + } + + selector = selector.slice( tokens.shift().value.length ); + } + + // Fetch a seed set for right-to-left matching + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; + while ( i-- ) { + token = tokens[ i ]; + + // Abort if we hit a combinator + if ( Expr.relative[ ( type = token.type ) ] ) { + break; + } + if ( ( find = Expr.find[ type ] ) ) { + + // Search, expanding context for leading sibling combinators + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { + + // If seed is empty or no tokens remain, we can return early + tokens.splice( i, 1 ); + selector = seed.length && toSelector( tokens ); + if ( !selector ) { + push.apply( results, seed ); + return results; + } + + break; + } + } + } + } + + // Compile and execute a filtering function if one is not provided + // Provide `match` to avoid retokenization if we modified the selector above + ( compiled || compile( selector, match ) )( + seed, + context, + !documentIsHTML, + results, + !context || rsibling.test( selector ) && testContext( context.parentNode ) || context + ); + return results; +}; + +// One-time assignments + +// Sort stability +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; + +// Support: Chrome 14-35+ +// Always assume duplicates if they aren't passed to the comparison function +support.detectDuplicates = !!hasDuplicate; + +// Initialize against the default document +setDocument(); + +// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) +// Detached nodes confoundingly follow *each other* +support.sortDetached = assert( function( el ) { + + // Should return 1, but returns 4 (following) + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); + +// Support: IE<8 +// Prevent attribute/property "interpolation" +// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx +if ( !assert( function( el ) { + el.innerHTML = ""; + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { + addHandle( "type|href|height|width", function( elem, name, isXML ) { + if ( !isXML ) { + return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); + } + } ); +} + +// Support: IE<9 +// Use defaultValue in place of getAttribute("value") +if ( !support.attributes || !assert( function( el ) { + el.innerHTML = ""; + el.firstChild.setAttribute( "value", "" ); + return el.firstChild.getAttribute( "value" ) === ""; +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { + if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { + return elem.defaultValue; + } + } ); +} + +// Support: IE<9 +// Use getAttributeNode to fetch booleans when getAttribute lies +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { + addHandle( booleans, function( elem, name, isXML ) { + var val; + if ( !isXML ) { + return elem[ name ] === true ? name.toLowerCase() : + ( val = elem.getAttributeNode( name ) ) && val.specified ? + val.value : + null; + } + } ); +} + +return Sizzle; + +} )( window ); + + + +jQuery.find = Sizzle; +jQuery.expr = Sizzle.selectors; + +// Deprecated +jQuery.expr[ ":" ] = jQuery.expr.pseudos; +jQuery.uniqueSort = jQuery.unique = Sizzle.uniqueSort; +jQuery.text = Sizzle.getText; +jQuery.isXMLDoc = Sizzle.isXML; +jQuery.contains = Sizzle.contains; +jQuery.escapeSelector = Sizzle.escape; + + + + +var dir = function( elem, dir, until ) { + var matched = [], + truncate = until !== undefined; + + while ( ( elem = elem[ dir ] ) && elem.nodeType !== 9 ) { + if ( elem.nodeType === 1 ) { + if ( truncate && jQuery( elem ).is( until ) ) { + break; + } + matched.push( elem ); + } + } + return matched; +}; + + +var siblings = function( n, elem ) { + var matched = []; + + for ( ; n; n = n.nextSibling ) { + if ( n.nodeType === 1 && n !== elem ) { + matched.push( n ); + } + } + + return matched; +}; + + +var rneedsContext = jQuery.expr.match.needsContext; + + + +function nodeName( elem, name ) { + + return elem.nodeName && elem.nodeName.toLowerCase() === name.toLowerCase(); + +}; +var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>|)$/i ); + + + +// Implement the identical functionality for filter and not +function winnow( elements, qualifier, not ) { + if ( isFunction( qualifier ) ) { + return jQuery.grep( elements, function( elem, i ) { + return !!qualifier.call( elem, i, elem ) !== not; + } ); + } + + // Single element + if ( qualifier.nodeType ) { + return jQuery.grep( elements, function( elem ) { + return ( elem === qualifier ) !== not; + } ); + } + + // Arraylike of elements (jQuery, arguments, Array) + if ( typeof qualifier !== "string" ) { + return jQuery.grep( elements, function( elem ) { + return ( indexOf.call( qualifier, elem ) > -1 ) !== not; + } ); + } + + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); +} + +jQuery.filter = function( expr, elems, not ) { + var elem = elems[ 0 ]; + + if ( not ) { + expr = ":not(" + expr + ")"; + } + + if ( elems.length === 1 && elem.nodeType === 1 ) { + return jQuery.find.matchesSelector( elem, expr ) ? [ elem ] : []; + } + + return jQuery.find.matches( expr, jQuery.grep( elems, function( elem ) { + return elem.nodeType === 1; + } ) ); +}; + +jQuery.fn.extend( { + find: function( selector ) { + var i, ret, + len = this.length, + self = this; + + if ( typeof selector !== "string" ) { + return this.pushStack( jQuery( selector ).filter( function() { + for ( i = 0; i < len; i++ ) { + if ( jQuery.contains( self[ i ], this ) ) { + return true; + } + } + } ) ); + } + + ret = this.pushStack( [] ); + + for ( i = 0; i < len; i++ ) { + jQuery.find( selector, self[ i ], ret ); + } + + return len > 1 ? jQuery.uniqueSort( ret ) : ret; + }, + filter: function( selector ) { + return this.pushStack( winnow( this, selector || [], false ) ); + }, + not: function( selector ) { + return this.pushStack( winnow( this, selector || [], true ) ); + }, + is: function( selector ) { + return !!winnow( + this, + + // If this is a positional/relative selector, check membership in the returned set + // so $("p:first").is("p:last") won't return true for a doc with two "p". + typeof selector === "string" && rneedsContext.test( selector ) ? + jQuery( selector ) : + selector || [], + false + ).length; + } +} ); + + +// Initialize a jQuery object + + +// A central reference to the root jQuery(document) +var rootjQuery, + + // A simple way to check for HTML strings + // Prioritize #id over to avoid XSS via location.hash (#9521) + // Strict HTML recognition (#11290: must start with <) + // Shortcut simple #id case for speed + rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/, + + init = jQuery.fn.init = function( selector, context, root ) { + var match, elem; + + // HANDLE: $(""), $(null), $(undefined), $(false) + if ( !selector ) { + return this; + } + + // Method init() accepts an alternate rootjQuery + // so migrate can support jQuery.sub (gh-2101) + root = root || rootjQuery; + + // Handle HTML strings + if ( typeof selector === "string" ) { + if ( selector[ 0 ] === "<" && + selector[ selector.length - 1 ] === ">" && + selector.length >= 3 ) { + + // Assume that strings that start and end with <> are HTML and skip the regex check + match = [ null, selector, null ]; + + } else { + match = rquickExpr.exec( selector ); + } + + // Match html or make sure no context is specified for #id + if ( match && ( match[ 1 ] || !context ) ) { + + // HANDLE: $(html) -> $(array) + if ( match[ 1 ] ) { + context = context instanceof jQuery ? context[ 0 ] : context; + + // Option to run scripts is true for back-compat + // Intentionally let the error be thrown if parseHTML is not present + jQuery.merge( this, jQuery.parseHTML( + match[ 1 ], + context && context.nodeType ? context.ownerDocument || context : document, + true + ) ); + + // HANDLE: $(html, props) + if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) { + for ( match in context ) { + + // Properties of context are called as methods if possible + if ( isFunction( this[ match ] ) ) { + this[ match ]( context[ match ] ); + + // ...and otherwise set as attributes + } else { + this.attr( match, context[ match ] ); + } + } + } + + return this; + + // HANDLE: $(#id) + } else { + elem = document.getElementById( match[ 2 ] ); + + if ( elem ) { + + // Inject the element directly into the jQuery object + this[ 0 ] = elem; + this.length = 1; + } + return this; + } + + // HANDLE: $(expr, $(...)) + } else if ( !context || context.jquery ) { + return ( context || root ).find( selector ); + + // HANDLE: $(expr, context) + // (which is just equivalent to: $(context).find(expr) + } else { + return this.constructor( context ).find( selector ); + } + + // HANDLE: $(DOMElement) + } else if ( selector.nodeType ) { + this[ 0 ] = selector; + this.length = 1; + return this; + + // HANDLE: $(function) + // Shortcut for document ready + } else if ( isFunction( selector ) ) { + return root.ready !== undefined ? + root.ready( selector ) : + + // Execute immediately if ready is not present + selector( jQuery ); + } + + return jQuery.makeArray( selector, this ); + }; + +// Give the init function the jQuery prototype for later instantiation +init.prototype = jQuery.fn; + +// Initialize central reference +rootjQuery = jQuery( document ); + + +var rparentsprev = /^(?:parents|prev(?:Until|All))/, + + // Methods guaranteed to produce a unique set when starting from a unique set + guaranteedUnique = { + children: true, + contents: true, + next: true, + prev: true + }; + +jQuery.fn.extend( { + has: function( target ) { + var targets = jQuery( target, this ), + l = targets.length; + + return this.filter( function() { + var i = 0; + for ( ; i < l; i++ ) { + if ( jQuery.contains( this, targets[ i ] ) ) { + return true; + } + } + } ); + }, + + closest: function( selectors, context ) { + var cur, + i = 0, + l = this.length, + matched = [], + targets = typeof selectors !== "string" && jQuery( selectors ); + + // Positional selectors never match, since there's no _selection_ context + if ( !rneedsContext.test( selectors ) ) { + for ( ; i < l; i++ ) { + for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) { + + // Always skip document fragments + if ( cur.nodeType < 11 && ( targets ? + targets.index( cur ) > -1 : + + // Don't pass non-elements to Sizzle + cur.nodeType === 1 && + jQuery.find.matchesSelector( cur, selectors ) ) ) { + + matched.push( cur ); + break; + } + } + } + } + + return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched ); + }, + + // Determine the position of an element within the set + index: function( elem ) { + + // No argument, return index in parent + if ( !elem ) { + return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1; + } + + // Index in selector + if ( typeof elem === "string" ) { + return indexOf.call( jQuery( elem ), this[ 0 ] ); + } + + // Locate the position of the desired element + return indexOf.call( this, + + // If it receives a jQuery object, the first element is used + elem.jquery ? elem[ 0 ] : elem + ); + }, + + add: function( selector, context ) { + return this.pushStack( + jQuery.uniqueSort( + jQuery.merge( this.get(), jQuery( selector, context ) ) + ) + ); + }, + + addBack: function( selector ) { + return this.add( selector == null ? + this.prevObject : this.prevObject.filter( selector ) + ); + } +} ); + +function sibling( cur, dir ) { + while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {} + return cur; +} + +jQuery.each( { + parent: function( elem ) { + var parent = elem.parentNode; + return parent && parent.nodeType !== 11 ? parent : null; + }, + parents: function( elem ) { + return dir( elem, "parentNode" ); + }, + parentsUntil: function( elem, _i, until ) { + return dir( elem, "parentNode", until ); + }, + next: function( elem ) { + return sibling( elem, "nextSibling" ); + }, + prev: function( elem ) { + return sibling( elem, "previousSibling" ); + }, + nextAll: function( elem ) { + return dir( elem, "nextSibling" ); + }, + prevAll: function( elem ) { + return dir( elem, "previousSibling" ); + }, + nextUntil: function( elem, _i, until ) { + return dir( elem, "nextSibling", until ); + }, + prevUntil: function( elem, _i, until ) { + return dir( elem, "previousSibling", until ); + }, + siblings: function( elem ) { + return siblings( ( elem.parentNode || {} ).firstChild, elem ); + }, + children: function( elem ) { + return siblings( elem.firstChild ); + }, + contents: function( elem ) { + if ( elem.contentDocument != null && + + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { + + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); + } +}, function( name, fn ) { + jQuery.fn[ name ] = function( until, selector ) { + var matched = jQuery.map( this, fn, until ); + + if ( name.slice( -5 ) !== "Until" ) { + selector = until; + } + + if ( selector && typeof selector === "string" ) { + matched = jQuery.filter( selector, matched ); + } + + if ( this.length > 1 ) { + + // Remove duplicates + if ( !guaranteedUnique[ name ] ) { + jQuery.uniqueSort( matched ); + } + + // Reverse order for parents* and prev-derivatives + if ( rparentsprev.test( name ) ) { + matched.reverse(); + } + } + + return this.pushStack( matched ); + }; +} ); +var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g ); + + + +// Convert String-formatted options into Object-formatted ones +function createOptions( options ) { + var object = {}; + jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) { + object[ flag ] = true; + } ); + return object; +} + +/* + * Create a callback list using the following parameters: + * + * options: an optional list of space-separated options that will change how + * the callback list behaves or a more traditional option object + * + * By default a callback list will act like an event callback list and can be + * "fired" multiple times. + * + * Possible options: + * + * once: will ensure the callback list can only be fired once (like a Deferred) + * + * memory: will keep track of previous values and will call any callback added + * after the list has been fired right away with the latest "memorized" + * values (like a Deferred) + * + * unique: will ensure a callback can only be added once (no duplicate in the list) + * + * stopOnFalse: interrupt callings when a callback returns false + * + */ +jQuery.Callbacks = function( options ) { + + // Convert options from String-formatted to Object-formatted if needed + // (we check in cache first) + options = typeof options === "string" ? + createOptions( options ) : + jQuery.extend( {}, options ); + + var // Flag to know if list is currently firing + firing, + + // Last fire value for non-forgettable lists + memory, + + // Flag to know if list was already fired + fired, + + // Flag to prevent firing + locked, + + // Actual callback list + list = [], + + // Queue of execution data for repeatable lists + queue = [], + + // Index of currently firing callback (modified by add/remove as needed) + firingIndex = -1, + + // Fire callbacks + fire = function() { + + // Enforce single-firing + locked = locked || options.once; + + // Execute callbacks for all pending executions, + // respecting firingIndex overrides and runtime changes + fired = firing = true; + for ( ; queue.length; firingIndex = -1 ) { + memory = queue.shift(); + while ( ++firingIndex < list.length ) { + + // Run callback and check for early termination + if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false && + options.stopOnFalse ) { + + // Jump to end and forget the data so .add doesn't re-fire + firingIndex = list.length; + memory = false; + } + } + } + + // Forget the data if we're done with it + if ( !options.memory ) { + memory = false; + } + + firing = false; + + // Clean up if we're done firing for good + if ( locked ) { + + // Keep an empty list if we have data for future add calls + if ( memory ) { + list = []; + + // Otherwise, this object is spent + } else { + list = ""; + } + } + }, + + // Actual Callbacks object + self = { + + // Add a callback or a collection of callbacks to the list + add: function() { + if ( list ) { + + // If we have memory from a past run, we should fire after adding + if ( memory && !firing ) { + firingIndex = list.length - 1; + queue.push( memory ); + } + + ( function add( args ) { + jQuery.each( args, function( _, arg ) { + if ( isFunction( arg ) ) { + if ( !options.unique || !self.has( arg ) ) { + list.push( arg ); + } + } else if ( arg && arg.length && toType( arg ) !== "string" ) { + + // Inspect recursively + add( arg ); + } + } ); + } )( arguments ); + + if ( memory && !firing ) { + fire(); + } + } + return this; + }, + + // Remove a callback from the list + remove: function() { + jQuery.each( arguments, function( _, arg ) { + var index; + while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) { + list.splice( index, 1 ); + + // Handle firing indexes + if ( index <= firingIndex ) { + firingIndex--; + } + } + } ); + return this; + }, + + // Check if a given callback is in the list. + // If no argument is given, return whether or not list has callbacks attached. + has: function( fn ) { + return fn ? + jQuery.inArray( fn, list ) > -1 : + list.length > 0; + }, + + // Remove all callbacks from the list + empty: function() { + if ( list ) { + list = []; + } + return this; + }, + + // Disable .fire and .add + // Abort any current/pending executions + // Clear all callbacks and values + disable: function() { + locked = queue = []; + list = memory = ""; + return this; + }, + disabled: function() { + return !list; + }, + + // Disable .fire + // Also disable .add unless we have memory (since it would have no effect) + // Abort any pending executions + lock: function() { + locked = queue = []; + if ( !memory && !firing ) { + list = memory = ""; + } + return this; + }, + locked: function() { + return !!locked; + }, + + // Call all callbacks with the given context and arguments + fireWith: function( context, args ) { + if ( !locked ) { + args = args || []; + args = [ context, args.slice ? args.slice() : args ]; + queue.push( args ); + if ( !firing ) { + fire(); + } + } + return this; + }, + + // Call all the callbacks with the given arguments + fire: function() { + self.fireWith( this, arguments ); + return this; + }, + + // To know if the callbacks have already been called at least once + fired: function() { + return !!fired; + } + }; + + return self; +}; + + +function Identity( v ) { + return v; +} +function Thrower( ex ) { + throw ex; +} + +function adoptValue( value, resolve, reject, noValue ) { + var method; + + try { + + // Check for promise aspect first to privilege synchronous behavior + if ( value && isFunction( ( method = value.promise ) ) ) { + method.call( value ).done( resolve ).fail( reject ); + + // Other thenables + } else if ( value && isFunction( ( method = value.then ) ) ) { + method.call( value, resolve, reject ); + + // Other non-thenables + } else { + + // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer: + // * false: [ value ].slice( 0 ) => resolve( value ) + // * true: [ value ].slice( 1 ) => resolve() + resolve.apply( undefined, [ value ].slice( noValue ) ); + } + + // For Promises/A+, convert exceptions into rejections + // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in + // Deferred#then to conditionally suppress rejection. + } catch ( value ) { + + // Support: Android 4.0 only + // Strict mode functions invoked without .call/.apply get global-object context + reject.apply( undefined, [ value ] ); + } +} + +jQuery.extend( { + + Deferred: function( func ) { + var tuples = [ + + // action, add listener, callbacks, + // ... .then handlers, argument index, [final state] + [ "notify", "progress", jQuery.Callbacks( "memory" ), + jQuery.Callbacks( "memory" ), 2 ], + [ "resolve", "done", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 0, "resolved" ], + [ "reject", "fail", jQuery.Callbacks( "once memory" ), + jQuery.Callbacks( "once memory" ), 1, "rejected" ] + ], + state = "pending", + promise = { + state: function() { + return state; + }, + always: function() { + deferred.done( arguments ).fail( arguments ); + return this; + }, + "catch": function( fn ) { + return promise.then( null, fn ); + }, + + // Keep pipe for back-compat + pipe: function( /* fnDone, fnFail, fnProgress */ ) { + var fns = arguments; + + return jQuery.Deferred( function( newDefer ) { + jQuery.each( tuples, function( _i, tuple ) { + + // Map tuples (progress, done, fail) to arguments (done, fail, progress) + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + + // deferred.progress(function() { bind to newDefer or newDefer.notify }) + // deferred.done(function() { bind to newDefer or newDefer.resolve }) + // deferred.fail(function() { bind to newDefer or newDefer.reject }) + deferred[ tuple[ 1 ] ]( function() { + var returned = fn && fn.apply( this, arguments ); + if ( returned && isFunction( returned.promise ) ) { + returned.promise() + .progress( newDefer.notify ) + .done( newDefer.resolve ) + .fail( newDefer.reject ); + } else { + newDefer[ tuple[ 0 ] + "With" ]( + this, + fn ? [ returned ] : arguments + ); + } + } ); + } ); + fns = null; + } ).promise(); + }, + then: function( onFulfilled, onRejected, onProgress ) { + var maxDepth = 0; + function resolve( depth, deferred, handler, special ) { + return function() { + var that = this, + args = arguments, + mightThrow = function() { + var returned, then; + + // Support: Promises/A+ section 2.3.3.3.3 + // https://promisesaplus.com/#point-59 + // Ignore double-resolution attempts + if ( depth < maxDepth ) { + return; + } + + returned = handler.apply( that, args ); + + // Support: Promises/A+ section 2.3.1 + // https://promisesaplus.com/#point-48 + if ( returned === deferred.promise() ) { + throw new TypeError( "Thenable self-resolution" ); + } + + // Support: Promises/A+ sections 2.3.3.1, 3.5 + // https://promisesaplus.com/#point-54 + // https://promisesaplus.com/#point-75 + // Retrieve `then` only once + then = returned && + + // Support: Promises/A+ section 2.3.4 + // https://promisesaplus.com/#point-64 + // Only check objects and functions for thenability + ( typeof returned === "object" || + typeof returned === "function" ) && + returned.then; + + // Handle a returned thenable + if ( isFunction( then ) ) { + + // Special processors (notify) just wait for resolution + if ( special ) { + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ) + ); + + // Normal processors (resolve) also hook into progress + } else { + + // ...and disregard older resolution values + maxDepth++; + + then.call( + returned, + resolve( maxDepth, deferred, Identity, special ), + resolve( maxDepth, deferred, Thrower, special ), + resolve( maxDepth, deferred, Identity, + deferred.notifyWith ) + ); + } + + // Handle all other returned values + } else { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Identity ) { + that = undefined; + args = [ returned ]; + } + + // Process the value(s) + // Default process is resolve + ( special || deferred.resolveWith )( that, args ); + } + }, + + // Only normal processors (resolve) catch and reject exceptions + process = special ? + mightThrow : + function() { + try { + mightThrow(); + } catch ( e ) { + + if ( jQuery.Deferred.exceptionHook ) { + jQuery.Deferred.exceptionHook( e, + process.stackTrace ); + } + + // Support: Promises/A+ section 2.3.3.3.4.1 + // https://promisesaplus.com/#point-61 + // Ignore post-resolution exceptions + if ( depth + 1 >= maxDepth ) { + + // Only substitute handlers pass on context + // and multiple values (non-spec behavior) + if ( handler !== Thrower ) { + that = undefined; + args = [ e ]; + } + + deferred.rejectWith( that, args ); + } + } + }; + + // Support: Promises/A+ section 2.3.3.3.1 + // https://promisesaplus.com/#point-57 + // Re-resolve promises immediately to dodge false rejection from + // subsequent errors + if ( depth ) { + process(); + } else { + + // Call an optional hook to record the stack, in case of exception + // since it's otherwise lost when execution goes async + if ( jQuery.Deferred.getStackHook ) { + process.stackTrace = jQuery.Deferred.getStackHook(); + } + window.setTimeout( process ); + } + }; + } + + return jQuery.Deferred( function( newDefer ) { + + // progress_handlers.add( ... ) + tuples[ 0 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onProgress ) ? + onProgress : + Identity, + newDefer.notifyWith + ) + ); + + // fulfilled_handlers.add( ... ) + tuples[ 1 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onFulfilled ) ? + onFulfilled : + Identity + ) + ); + + // rejected_handlers.add( ... ) + tuples[ 2 ][ 3 ].add( + resolve( + 0, + newDefer, + isFunction( onRejected ) ? + onRejected : + Thrower + ) + ); + } ).promise(); + }, + + // Get a promise for this deferred + // If obj is provided, the promise aspect is added to the object + promise: function( obj ) { + return obj != null ? jQuery.extend( obj, promise ) : promise; + } + }, + deferred = {}; + + // Add list-specific methods + jQuery.each( tuples, function( i, tuple ) { + var list = tuple[ 2 ], + stateString = tuple[ 5 ]; + + // promise.progress = list.add + // promise.done = list.add + // promise.fail = list.add + promise[ tuple[ 1 ] ] = list.add; + + // Handle state + if ( stateString ) { + list.add( + function() { + + // state = "resolved" (i.e., fulfilled) + // state = "rejected" + state = stateString; + }, + + // rejected_callbacks.disable + // fulfilled_callbacks.disable + tuples[ 3 - i ][ 2 ].disable, + + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + + // progress_callbacks.lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock + ); + } + + // progress_handlers.fire + // fulfilled_handlers.fire + // rejected_handlers.fire + list.add( tuple[ 3 ].fire ); + + // deferred.notify = function() { deferred.notifyWith(...) } + // deferred.resolve = function() { deferred.resolveWith(...) } + // deferred.reject = function() { deferred.rejectWith(...) } + deferred[ tuple[ 0 ] ] = function() { + deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments ); + return this; + }; + + // deferred.notifyWith = list.fireWith + // deferred.resolveWith = list.fireWith + // deferred.rejectWith = list.fireWith + deferred[ tuple[ 0 ] + "With" ] = list.fireWith; + } ); + + // Make the deferred a promise + promise.promise( deferred ); + + // Call given func if any + if ( func ) { + func.call( deferred, deferred ); + } + + // All done! + return deferred; + }, + + // Deferred helper + when: function( singleValue ) { + var + + // count of uncompleted subordinates + remaining = arguments.length, + + // count of unprocessed arguments + i = remaining, + + // subordinate fulfillment data + resolveContexts = Array( i ), + resolveValues = slice.call( arguments ), + + // the 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"; + }; + + + +function adjustCSS( elem, prop, valueParts, tween ) { + var adjusted, scale, + maxIterations = 20, + currentValue = tween ? + function() { + return tween.cur(); + } : + function() { + return jQuery.css( elem, prop, "" ); + }, + initial = currentValue(), + unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), + + // Starting value computation is required for potential unit mismatches + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + rcssNum.exec( jQuery.css( elem, prop ) ); + + if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + + // Trust units reported by jQuery.css + unit = unit || initialInUnit[ 3 ]; + + // Iteratively approximate from a nonzero starting point + initialInUnit = +initial || 1; + + while ( maxIterations-- ) { + + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). + jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; + + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; + } + + if ( valueParts ) { + initialInUnit = +initialInUnit || +initial || 0; + + // Apply relative offset (+=/-=) if specified + adjusted = valueParts[ 1 ] ? + initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] : + +valueParts[ 2 ]; + if ( tween ) { + tween.unit = unit; + tween.start = initialInUnit; + tween.end = adjusted; + } + } + return adjusted; +} + + +var defaultDisplayMap = {}; + +function getDefaultDisplay( elem ) { + var temp, + doc = elem.ownerDocument, + nodeName = elem.nodeName, + display = defaultDisplayMap[ nodeName ]; + + if ( display ) { + return display; + } + + temp = doc.body.appendChild( doc.createElement( nodeName ) ); + display = jQuery.css( temp, "display" ); + + temp.parentNode.removeChild( temp ); + + if ( display === "none" ) { + display = "block"; + } + defaultDisplayMap[ nodeName ] = display; + + return display; +} + +function showHide( elements, show ) { + var display, elem, + values = [], + index = 0, + length = elements.length; + + // Determine new display value for elements that need to change + for ( ; index < length; index++ ) { + elem = elements[ index ]; + if ( !elem.style ) { + continue; + } + + display = elem.style.display; + if ( show ) { + + // Since we force visibility upon cascade-hidden elements, an immediate (and slow) + // check is required in this first loop unless we have a nonempty display value (either + // inline or about-to-be-restored) + if ( display === "none" ) { + values[ index ] = dataPriv.get( elem, "display" ) || null; + if ( !values[ index ] ) { + elem.style.display = ""; + } + } + if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) { + values[ index ] = getDefaultDisplay( elem ); + } + } else { + if ( display !== "none" ) { + values[ index ] = "none"; + + // Remember what we're overwriting + dataPriv.set( elem, "display", display ); + } + } + } + + // Set the display of the elements in a second loop to avoid constant reflow + for ( index = 0; index < length; index++ ) { + if ( values[ index ] != null ) { + elements[ index ].style.display = values[ index ]; + } + } + + return elements; +} + +jQuery.fn.extend( { + show: function() { + return showHide( this, true ); + }, + hide: function() { + return showHide( this ); + }, + toggle: function( state ) { + if ( typeof state === "boolean" ) { + return state ? this.show() : this.hide(); + } + + return this.each( function() { + if ( isHiddenWithinTree( this ) ) { + jQuery( this ).show(); + } else { + jQuery( this ).hide(); + } + } ); + } +} ); +var rcheckableType = ( /^(?:checkbox|radio)$/i ); + +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); + +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); + + + +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; + + // Support: IE <=9 only + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { + + // XHTML parsers do not magically insert elements in the + // same way that tag soup parsers do. So we cannot shorten + // this by omitting or other required elements. + thead: [ 1, "", "
" ], + col: [ 2, "", "
" ], + tr: [ 2, "", "
" ], + td: [ 3, "", "
" ], + + _default: [ 0, "", "" ] +}; + +wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; +wrapMap.th = wrapMap.td; + +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + + +function getAll( context, tag ) { + + // Support: IE <=9 - 11 only + // Use typeof to avoid zero-argument method invocation on host objects (#15151) + var ret; + + if ( typeof context.getElementsByTagName !== "undefined" ) { + ret = context.getElementsByTagName( tag || "*" ); + + } else if ( typeof context.querySelectorAll !== "undefined" ) { + ret = context.querySelectorAll( tag || "*" ); + + } else { + ret = []; + } + + if ( tag === undefined || tag && nodeName( context, tag ) ) { + return jQuery.merge( [ context ], ret ); + } + + return ret; +} + + +// Mark scripts as having already been evaluated +function setGlobalEval( elems, refElements ) { + var i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + dataPriv.set( + elems[ i ], + "globalEval", + !refElements || dataPriv.get( refElements[ i ], "globalEval" ) + ); + } +} + + +var rhtml = /<|&#?\w+;/; + +function buildFragment( elems, context, scripts, selection, ignored ) { + var elem, tmp, tag, wrap, attached, j, + fragment = context.createDocumentFragment(), + nodes = [], + i = 0, + l = elems.length; + + for ( ; i < l; i++ ) { + elem = elems[ i ]; + + if ( elem || elem === 0 ) { + + // Add nodes directly + if ( toType( elem ) === "object" ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem ); + + // Convert non-html into a text node + } else if ( !rhtml.test( elem ) ) { + nodes.push( context.createTextNode( elem ) ); + + // Convert html into DOM nodes + } else { + tmp = tmp || fragment.appendChild( context.createElement( "div" ) ); + + // Deserialize a standard representation + tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase(); + wrap = wrapMap[ tag ] || wrapMap._default; + tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ]; + + // Descend through wrappers to the right content + j = wrap[ 0 ]; + while ( j-- ) { + tmp = tmp.lastChild; + } + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( nodes, tmp.childNodes ); + + // Remember the top-level container + tmp = fragment.firstChild; + + // Ensure the created nodes are orphaned (#12392) + tmp.textContent = ""; + } + } + } + + // Remove wrapper from fragment + fragment.textContent = ""; + + i = 0; + while ( ( elem = nodes[ i++ ] ) ) { + + // Skip elements already in the context collection (trac-4087) + if ( selection && jQuery.inArray( elem, selection ) > -1 ) { + if ( ignored ) { + ignored.push( elem ); + } + continue; + } + + attached = isAttached( elem ); + + // Append to fragment + tmp = getAll( fragment.appendChild( elem ), "script" ); + + // Preserve script evaluation history + if ( attached ) { + setGlobalEval( tmp ); + } + + // Capture executables + if ( scripts ) { + j = 0; + while ( ( elem = tmp[ j++ ] ) ) { + if ( rscriptType.test( elem.type || "" ) ) { + scripts.push( elem ); + } + } + } + } + + return fragment; +} + + +var + 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 ); + + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { + return; + } + + // Caller can pass in an object of custom data in lieu of the handler + if ( handler.handler ) { + handleObjIn = handler; + handler = handleObjIn.handler; + selector = handleObjIn.selector; + } + + // Ensure that invalid selectors throw exceptions at attach time + // Evaluate against documentElement in case elem is a non-element node (e.g., document) + if ( selector ) { + jQuery.find.matchesSelector( documentElement, selector ); + } + + // Make sure that the handler has a unique ID, used to find/remove it later + if ( !handler.guid ) { + handler.guid = jQuery.guid++; + } + + // Init the element's event structure and main handler, if this is the first + if ( !( events = elemData.events ) ) { + events = elemData.events = Object.create( null ); + } + if ( !( eventHandle = elemData.handle ) ) { + eventHandle = elemData.handle = function( e ) { + + // Discard the second event of a jQuery.event.trigger() and + // when an event is called after a page has unloaded + return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ? + jQuery.event.dispatch.apply( elem, arguments ) : undefined; + }; + } + + // Handle multiple events separated by a space + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // There *must* be a type, no attaching namespace-only handlers + if ( !type ) { + continue; + } + + // If event changes its type, use the special event handlers for the changed type + special = jQuery.event.special[ type ] || {}; + + // If selector defined, determine special event api type, otherwise given type + type = ( selector ? special.delegateType : special.bindType ) || type; + + // Update special based on newly reset type + special = jQuery.event.special[ type ] || {}; + + // handleObj is passed to all event handlers + handleObj = jQuery.extend( { + type: type, + origType: origType, + data: data, + handler: handler, + guid: handler.guid, + selector: selector, + needsContext: selector && jQuery.expr.match.needsContext.test( selector ), + namespace: namespaces.join( "." ) + }, handleObjIn ); + + // Init the event handler queue if we're the first + if ( !( handlers = events[ type ] ) ) { + handlers = events[ type ] = []; + handlers.delegateCount = 0; + + // Only use addEventListener if the special events handler returns false + if ( !special.setup || + special.setup.call( elem, data, namespaces, eventHandle ) === false ) { + + if ( elem.addEventListener ) { + elem.addEventListener( type, eventHandle ); + } + } + } + + if ( special.add ) { + special.add.call( elem, handleObj ); + + if ( !handleObj.handler.guid ) { + handleObj.handler.guid = handler.guid; + } + } + + // Add to the element's handler list, delegates in front + if ( selector ) { + handlers.splice( handlers.delegateCount++, 0, handleObj ); + } else { + handlers.push( handleObj ); + } + + // Keep track of which events have ever been used, for event optimization + jQuery.event.global[ type ] = true; + } + + }, + + // Detach an event or set of events from an element + remove: function( elem, types, handler, selector, mappedTypes ) { + + var j, origCount, tmp, + events, t, handleObj, + special, handlers, type, namespaces, origType, + elemData = dataPriv.hasData( elem ) && dataPriv.get( elem ); + + if ( !elemData || !( events = elemData.events ) ) { + return; + } + + // Once for each type.namespace in types; type may be omitted + types = ( types || "" ).match( rnothtmlwhite ) || [ "" ]; + t = types.length; + while ( t-- ) { + tmp = rtypenamespace.exec( types[ t ] ) || []; + type = origType = tmp[ 1 ]; + namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort(); + + // Unbind all events (on this namespace, if provided) for the element + if ( !type ) { + for ( type in events ) { + jQuery.event.remove( elem, type + types[ t ], handler, selector, true ); + } + continue; + } + + special = jQuery.event.special[ type ] || {}; + type = ( selector ? special.delegateType : special.bindType ) || type; + handlers = events[ type ] || []; + tmp = tmp[ 2 ] && + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ); + + // Remove matching events + origCount = j = handlers.length; + while ( j-- ) { + handleObj = handlers[ j ]; + + if ( ( mappedTypes || origType === handleObj.origType ) && + ( !handler || handler.guid === handleObj.guid ) && + ( !tmp || tmp.test( handleObj.namespace ) ) && + ( !selector || selector === handleObj.selector || + selector === "**" && handleObj.selector ) ) { + handlers.splice( j, 1 ); + + if ( handleObj.selector ) { + handlers.delegateCount--; + } + if ( special.remove ) { + special.remove.call( elem, handleObj ); + } + } + } + + // Remove generic event handler if we removed something and no more handlers exist + // (avoids potential for endless recursion during removal of special event handlers) + if ( origCount && !handlers.length ) { + if ( !special.teardown || + special.teardown.call( elem, namespaces, elemData.handle ) === false ) { + + jQuery.removeEvent( elem, type, elemData.handle ); + } + + delete events[ type ]; + } + } + + // Remove data and the expando if it's no longer used + if ( jQuery.isEmptyObject( events ) ) { + dataPriv.remove( elem, "handle events" ); + } + }, + + dispatch: function( nativeEvent ) { + + var i, j, ret, matched, handleObj, handlerQueue, + args = new Array( arguments.length ), + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], + special = jQuery.event.special[ event.type ] || {}; + + // Use the fix-ed jQuery.Event rather than the (read-only) native event + args[ 0 ] = event; + + for ( i = 1; i < arguments.length; i++ ) { + args[ i ] = arguments[ i ]; + } + + event.delegateTarget = this; + + // Call the preDispatch hook for the mapped type, and let it bail if desired + if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) { + return; + } + + // Determine handlers + handlerQueue = jQuery.event.handlers.call( this, event, handlers ); + + // Run delegates first; they may want to stop propagation beneath us + i = 0; + while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) { + event.currentTarget = matched.elem; + + j = 0; + while ( ( handleObj = matched.handlers[ j++ ] ) && + !event.isImmediatePropagationStopped() ) { + + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { + + event.handleObj = handleObj; + event.data = handleObj.data; + + ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle || + handleObj.handler ).apply( matched.elem, args ); + + if ( ret !== undefined ) { + if ( ( event.result = ret ) === false ) { + event.preventDefault(); + event.stopPropagation(); + } + } + } + } + } + + // Call the postDispatch hook for the mapped type + if ( special.postDispatch ) { + special.postDispatch.call( this, event ); + } + + return event.result; + }, + + handlers: function( event, handlers ) { + var i, handleObj, sel, matchedHandlers, matchedSelectors, + handlerQueue = [], + delegateCount = handlers.delegateCount, + cur = event.target; + + // Find delegate handlers + if ( delegateCount && + + // Support: IE <=9 + // Black-hole SVG instance trees (trac-13180) + cur.nodeType && + + // Support: Firefox <=42 + // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861) + // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click + // Support: IE 11 only + // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343) + !( event.type === "click" && event.button >= 1 ) ) { + + for ( ; cur !== this; cur = cur.parentNode || this ) { + + // Don't check non-elements (#13208) + // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764) + if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) { + matchedHandlers = []; + matchedSelectors = {}; + for ( i = 0; i < delegateCount; i++ ) { + handleObj = handlers[ i ]; + + // Don't conflict with Object.prototype properties (#13203) + sel = handleObj.selector + " "; + + if ( matchedSelectors[ sel ] === undefined ) { + matchedSelectors[ sel ] = handleObj.needsContext ? + jQuery( sel, this ).index( cur ) > -1 : + jQuery.find( sel, this, null, [ cur ] ).length; + } + if ( matchedSelectors[ sel ] ) { + matchedHandlers.push( handleObj ); + } + } + if ( matchedHandlers.length ) { + handlerQueue.push( { elem: cur, handlers: matchedHandlers } ); + } + } + } + } + + // Add the remaining (directly-bound) handlers + cur = this; + if ( delegateCount < handlers.length ) { + handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } ); + } + + return handlerQueue; + }, + + addProp: function( name, hook ) { + Object.defineProperty( jQuery.Event.prototype, name, { + enumerable: true, + configurable: true, + + get: isFunction( hook ) ? + function() { + if ( this.originalEvent ) { + return hook( this.originalEvent ); + } + } : + function() { + if ( this.originalEvent ) { + return this.originalEvent[ name ]; + } + }, + + set: function( value ) { + Object.defineProperty( this, name, { + enumerable: true, + configurable: true, + writable: true, + value: value + } ); + } + } ); + }, + + fix: function( originalEvent ) { + return originalEvent[ jQuery.expando ] ? + originalEvent : + new jQuery.Event( originalEvent ); + }, + + special: { + load: { + + // Prevent triggered image.load events from bubbling to window.load + noBubble: true + }, + click: { + + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); + } + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); + } + + // Return non-false to allow normal event-path propagation + return true; + }, + + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack + _default: function( event ) { + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); + } + }, + + beforeunload: { + postDispatch: function( event ) { + + // Support: Firefox 20+ + // Firefox doesn't alert if the returnValue field is not set. + if ( event.result !== undefined && event.originalEvent ) { + event.originalEvent.returnValue = event.result; + } + } + } + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + 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 + + // Support: IE <=10 - 11, Edge 12 - 13 only + // In IE/Edge using regex groups here causes severe slowdowns. + // See https://connect.microsoft.com/IE/feedback/details/1736512/ + rnoInnerhtml = /\s*$/g; + +// Prefer a tbody over its parent table for containing new rows +function manipulationTarget( elem, content ) { + if ( nodeName( elem, "table" ) && + nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { + + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; + } + + return elem; +} + +// Replace/restore the type attribute of script elements for safe DOM manipulation +function disableScript( elem ) { + elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type; + return elem; +} +function restoreScript( elem ) { + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); + } else { + elem.removeAttribute( "type" ); + } + + return elem; +} + +function cloneCopyEvent( src, dest ) { + var i, l, type, pdataOld, udataOld, udataCur, events; + + if ( dest.nodeType !== 1 ) { + return; + } + + // 1. Copy private data: events, handlers, etc. + if ( dataPriv.hasData( src ) ) { + pdataOld = dataPriv.get( src ); + events = pdataOld.events; + + if ( events ) { + dataPriv.remove( dest, "handle events" ); + + for ( type in events ) { + for ( i = 0, l = events[ type ].length; i < l; i++ ) { + jQuery.event.add( dest, type, events[ type ][ i ] ); + } + } + } + } + + // 2. Copy user data + if ( dataUser.hasData( src ) ) { + udataOld = dataUser.access( src ); + udataCur = jQuery.extend( {}, udataOld ); + + dataUser.set( dest, udataCur ); + } +} + +// Fix IE bugs, see support tests +function fixInput( src, dest ) { + var nodeName = dest.nodeName.toLowerCase(); + + // Fails to persist the checked state of a cloned checkbox or radio button. + if ( nodeName === "input" && rcheckableType.test( src.type ) ) { + dest.checked = src.checked; + + // Fails to return the selected option to the default selected state when cloning options + } else if ( nodeName === "input" || nodeName === "textarea" ) { + dest.defaultValue = src.defaultValue; + } +} + +function domManip( collection, args, callback, ignored ) { + + // Flatten any nested arrays + args = flat( args ); + + var fragment, first, scripts, hasScripts, node, doc, + i = 0, + l = collection.length, + iNoClone = l - 1, + value = args[ 0 ], + valueIsFunction = isFunction( value ); + + // We can't cloneNode fragments that contain checked, in WebKit + if ( valueIsFunction || + ( l > 1 && typeof value === "string" && + !support.checkClone && rchecked.test( value ) ) ) { + return collection.each( function( index ) { + var self = collection.eq( index ); + if ( valueIsFunction ) { + args[ 0 ] = value.call( this, index, self.html() ); + } + domManip( self, args, callback, ignored ); + } ); + } + + if ( l ) { + fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored ); + first = fragment.firstChild; + + if ( fragment.childNodes.length === 1 ) { + fragment = first; + } + + // Require either new content or an interest in ignored elements to invoke the callback + if ( first || ignored ) { + scripts = jQuery.map( getAll( fragment, "script" ), disableScript ); + hasScripts = scripts.length; + + // Use the original fragment for the last item + // instead of the first because it can end up + // being emptied incorrectly in certain situations (#8070). + for ( ; i < l; i++ ) { + node = fragment; + + if ( i !== iNoClone ) { + node = jQuery.clone( node, true, true ); + + // Keep references to cloned scripts for later restoration + if ( hasScripts ) { + + // Support: Android <=4.0 only, PhantomJS 1 only + // push.apply(_, arraylike) throws on ancient WebKit + jQuery.merge( scripts, getAll( node, "script" ) ); + } + } + + callback.call( collection[ i ], node, i ); + } + + if ( hasScripts ) { + doc = scripts[ scripts.length - 1 ].ownerDocument; + + // Reenable scripts + jQuery.map( scripts, restoreScript ); + + // Evaluate executable scripts on first document insertion + for ( i = 0; i < hasScripts; i++ ) { + node = scripts[ i ]; + if ( rscriptType.test( node.type || "" ) && + !dataPriv.access( node, "globalEval" ) && + jQuery.contains( doc, node ) ) { + + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { + + // Optional AJAX dependency, but won't run scripts if not present + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); + } + } else { + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); + } + } + } + } + } + } + + return collection; +} + +function remove( elem, selector, keepData ) { + var node, + nodes = selector ? jQuery.filter( selector, elem ) : elem, + i = 0; + + for ( ; ( node = nodes[ i ] ) != null; i++ ) { + if ( !keepData && node.nodeType === 1 ) { + jQuery.cleanData( getAll( node ) ); + } + + if ( node.parentNode ) { + if ( keepData && isAttached( node ) ) { + setGlobalEval( getAll( node, "script" ) ); + } + node.parentNode.removeChild( node ); + } + } + + return elem; +} + +jQuery.extend( { + htmlPrefilter: function( html ) { + return html; + }, + + clone: function( elem, dataAndEvents, deepDataAndEvents ) { + var i, l, srcElements, destElements, + clone = elem.cloneNode( true ), + inPage = isAttached( elem ); + + // Fix IE cloning issues + if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && + !jQuery.isXMLDoc( elem ) ) { + + // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2 + destElements = getAll( clone ); + srcElements = getAll( elem ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + fixInput( srcElements[ i ], destElements[ i ] ); + } + } + + // Copy the events from the original to the clone + if ( dataAndEvents ) { + if ( deepDataAndEvents ) { + srcElements = srcElements || getAll( elem ); + destElements = destElements || getAll( clone ); + + for ( i = 0, l = srcElements.length; i < l; i++ ) { + cloneCopyEvent( srcElements[ i ], destElements[ i ] ); + } + } else { + cloneCopyEvent( elem, clone ); + } + } + + // Preserve script evaluation history + destElements = getAll( clone, "script" ); + if ( destElements.length > 0 ) { + setGlobalEval( destElements, !inPage && getAll( elem, "script" ) ); + } + + // Return the cloned set + return clone; + }, + + cleanData: function( elems ) { + var data, elem, type, + special = jQuery.event.special, + i = 0; + + for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) { + if ( acceptData( elem ) ) { + if ( ( data = elem[ dataPriv.expando ] ) ) { + if ( data.events ) { + for ( type in data.events ) { + if ( special[ type ] ) { + jQuery.event.remove( elem, type ); + + // This is a shortcut to avoid jQuery.event.remove's overhead + } else { + jQuery.removeEvent( elem, type, data.handle ); + } + } + } + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataPriv.expando ] = undefined; + } + if ( elem[ dataUser.expando ] ) { + + // Support: Chrome <=35 - 45+ + // Assign undefined instead of using delete, see Data#remove + elem[ dataUser.expando ] = undefined; + } + } + } + } +} ); + +jQuery.fn.extend( { + detach: function( selector ) { + return remove( this, selector, true ); + }, + + remove: function( selector ) { + return remove( this, selector ); + }, + + text: function( value ) { + return access( this, function( value ) { + return value === undefined ? + jQuery.text( this ) : + this.empty().each( function() { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + this.textContent = value; + } + } ); + }, null, value, arguments.length ); + }, + + append: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.appendChild( elem ); + } + } ); + }, + + prepend: function() { + return domManip( this, arguments, function( elem ) { + if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) { + var target = manipulationTarget( this, elem ); + target.insertBefore( elem, target.firstChild ); + } + } ); + }, + + before: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this ); + } + } ); + }, + + after: function() { + return domManip( this, arguments, function( elem ) { + if ( this.parentNode ) { + this.parentNode.insertBefore( elem, this.nextSibling ); + } + } ); + }, + + empty: function() { + var elem, + i = 0; + + for ( ; ( elem = this[ i ] ) != null; i++ ) { + if ( elem.nodeType === 1 ) { + + // Prevent memory leaks + jQuery.cleanData( getAll( elem, false ) ); + + // Remove any remaining nodes + elem.textContent = ""; + } + } + + return this; + }, + + clone: function( dataAndEvents, deepDataAndEvents ) { + dataAndEvents = dataAndEvents == null ? false : dataAndEvents; + deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents; + + return this.map( function() { + return jQuery.clone( this, dataAndEvents, deepDataAndEvents ); + } ); + }, + + html: function( value ) { + return access( this, function( value ) { + var elem = this[ 0 ] || {}, + i = 0, + l = this.length; + + if ( value === undefined && elem.nodeType === 1 ) { + return elem.innerHTML; + } + + // See if we can take a shortcut and just use innerHTML + if ( typeof value === "string" && !rnoInnerhtml.test( value ) && + !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) { + + value = jQuery.htmlPrefilter( value ); + + try { + for ( ; i < l; i++ ) { + elem = this[ i ] || {}; + + // Remove element nodes and prevent memory leaks + if ( elem.nodeType === 1 ) { + jQuery.cleanData( getAll( elem, false ) ); + elem.innerHTML = value; + } + } + + elem = 0; + + // If using innerHTML throws an exception, use the fallback method + } catch ( e ) {} + } + + if ( elem ) { + this.empty().append( value ); + } + }, null, value, arguments.length ); + }, + + replaceWith: function() { + var ignored = []; + + // Make the changes, replacing each non-ignored context element with the new content + return domManip( this, arguments, function( elem ) { + var parent = this.parentNode; + + if ( jQuery.inArray( this, ignored ) < 0 ) { + jQuery.cleanData( getAll( this ) ); + if ( parent ) { + parent.replaceChild( elem, this ); + } + } + + // Force callback invocation + }, ignored ); + } +} ); + +jQuery.each( { + appendTo: "append", + prependTo: "prepend", + insertBefore: "before", + insertAfter: "after", + replaceAll: "replaceWith" +}, function( name, original ) { + jQuery.fn[ name ] = function( selector ) { + var elems, + ret = [], + insert = jQuery( selector ), + last = insert.length - 1, + i = 0; + + for ( ; i <= last; i++ ) { + elems = i === last ? this : this.clone( true ); + jQuery( insert[ i ] )[ original ]( elems ); + + // Support: Android <=4.0 only, PhantomJS 1 only + // .get() because push.apply(_, arraylike) throws on ancient WebKit + push.apply( ret, elems.get() ); + } + + return this.pushStack( ret ); + }; +} ); +var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); + +var getStyles = function( elem ) { + + // Support: IE <=11 only, Firefox <=30 (#15098, #14150) + // IE throws on elements created in popups + // FF meanwhile throws on frame elements through "defaultView.getComputedStyle" + var view = elem.ownerDocument.defaultView; + + if ( !view || !view.opener ) { + view = window; + } + + return view.getComputedStyle( elem ); + }; + +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + + + +( function() { + + // Executing both pixelPosition & boxSizingReliable tests require only one layout + // so they're executed at the same time to save the second computation. + function computeStyleTests() { + + // This is a singleton, we need to execute it only once + if ( !div ) { + return; + } + + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; + div.style.cssText = + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + + "margin:auto;border:1px;padding:1px;" + + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); + + var divStyle = window.getComputedStyle( div ); + pixelPositionVal = divStyle.top !== "1%"; + + // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; + + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 + // Some styles come back with percentage values, even though they shouldn't + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; + + documentElement.removeChild( container ); + + // Nullify the div so it wouldn't be stored in the memory and + // it will also be a sign that checks already performed + div = null; + } + + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, + container = document.createElement( "div" ), + div = document.createElement( "div" ); + + // Finish early in limited (non-browser) environments + if ( !div.style ) { + return; + } + + // Support: IE <=9 - 11 only + // Style of cloned element affects source element cloned (#8908) + div.style.backgroundClip = "content-box"; + div.cloneNode( true ).style.backgroundClip = ""; + support.clearCloneStyle = div.style.backgroundClip === "content-box"; + + jQuery.extend( support, { + boxSizingReliable: function() { + computeStyleTests(); + return boxSizingReliableVal; + }, + pixelBoxStyles: function() { + computeStyleTests(); + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; + }, + reliableMarginLeft: function() { + computeStyleTests(); + return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; + } + } ); +} )(); + + +function curCSS( elem, name, computed ) { + var width, minWidth, maxWidth, ret, + + // Support: Firefox 51+ + // Retrieving style before computed somehow + // fixes an issue with getting wrong values + // on detached elements + style = elem.style; + + computed = computed || getStyles( elem ); + + // getPropertyValue is needed for: + // .css('filter') (IE 9 only, #12537) + // .css('--customProperty) (#3144) + if ( computed ) { + ret = computed.getPropertyValue( name ) || computed[ name ]; + + if ( ret === "" && !isAttached( elem ) ) { + ret = jQuery.style( elem, name ); + } + + // A tribute to the "awesome hack by Dean Edwards" + // Android Browser returns percentage for some values, + // but width seems to be reliably pixels. + // This is against the CSSOM draft spec: + // https://drafts.csswg.org/cssom/#resolved-values + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { + + // Remember the original values + width = style.width; + minWidth = style.minWidth; + maxWidth = style.maxWidth; + + // Put in the new values to get a computed value out + style.minWidth = style.maxWidth = style.width = ret; + ret = computed.width; + + // Revert the changed values + style.width = width; + style.minWidth = minWidth; + style.maxWidth = maxWidth; + } + } + + return ret !== undefined ? + + // Support: IE <=9 - 11 only + // IE returns zIndex value as an integer. + ret + "" : + ret; +} + + +function addGetHookIf( conditionFn, hookFn ) { + + // Define the hook, we'll check on the first run if it's really needed. + return { + get: function() { + if ( conditionFn() ) { + + // Hook not needed (or it's not possible to use it due + // to missing dependency), remove it. + delete this.get; + return; + } + + // Hook needed; redefine it so that the support test is not executed again. + return ( this.get = hookFn ).apply( this, arguments ); + } + }; +} + + +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; + +// Return a vendor-prefixed property or undefined +function vendorPropName( name ) { + + // Check for vendor prefixed names + var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), + i = cssPrefixes.length; + + while ( i-- ) { + name = cssPrefixes[ i ] + capName; + if ( name in emptyStyle ) { + return name; + } + } +} + +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property +function finalPropName( name ) { + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; + } + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; +} + + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { + + // Any relative (+/-) values have already been + // normalized at this point + var matches = rcssNum.exec( value ); + return matches ? + + // Guard against undefined "subtract", e.g., when used as in cssHooks + Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) : + value; +} + +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; + + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; + } + + for ( ; i < 4; i += 2 ) { + + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); + } + + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { + + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" + } else { + + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } + + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + } + } + } + + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; +} + +function getWidthOrHeight( elem, dimension, extra ) { + + // Start with computed style + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, + + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. + if ( rnumnonpx.test( val ) ) { + if ( !extra ) { + return val; + } + val = "auto"; + } + + + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } + } + + // Normalize "" and auto + val = parseFloat( val ) || 0; + + // Adjust for the element's box model + return ( val + + boxModelAdjustment( + elem, + dimension, + extra || ( isBorderBox ? "border" : "content" ), + valueIsBorderBox, + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val + ) + ) + "px"; +} + +jQuery.extend( { + + // Add in style property hooks for overriding the default + // behavior of getting and setting a style property + cssHooks: { + opacity: { + get: function( elem, computed ) { + if ( computed ) { + + // We should always get a number back from opacity + var ret = curCSS( elem, "opacity" ); + return ret === "" ? "1" : ret; + } + } + } + }, + + // Don't automatically add "px" to these possibly-unitless properties + cssNumber: { + "animationIterationCount": true, + "columnCount": true, + "fillOpacity": true, + "flexGrow": true, + "flexShrink": true, + "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, + "lineHeight": true, + "opacity": true, + "order": true, + "orphans": true, + "widows": true, + "zIndex": true, + "zoom": true + }, + + // Add in properties whose names you wish to fix before + // setting or getting the value + cssProps: {}, + + // Get and set the style property on a DOM Node + style: function( elem, name, value, extra ) { + + // Don't set styles on text and comment nodes + if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) { + return; + } + + // Make sure that we're working with the right name + var ret, type, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ), + style = elem.style; + + // Make sure that we're working with the right name. We don't + // want to query the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Gets hook for the prefixed version, then unprefixed version + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // Check if we're setting a value + if ( value !== undefined ) { + type = typeof value; + + // Convert "+=" or "-=" to relative numbers (#7345) + if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) { + value = adjustCSS( elem, name, ret ); + + // Fixes bug #9237 + type = "number"; + } + + // Make sure that null and NaN values aren't set (#7116) + if ( value == null || value !== value ) { + return; + } + + // If a number was passed in, add the unit (except for certain CSS properties) + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { + value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); + } + + // background-* props affect original clone's values + if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) { + style[ name ] = "inherit"; + } + + // If a hook was provided, use that value, otherwise just set the specified value + if ( !hooks || !( "set" in hooks ) || + ( value = hooks.set( elem, value, extra ) ) !== undefined ) { + + if ( isCustomProp ) { + style.setProperty( name, value ); + } else { + style[ name ] = value; + } + } + + } else { + + // If a hook was provided get the non-computed value from there + if ( hooks && "get" in hooks && + ( ret = hooks.get( elem, false, extra ) ) !== undefined ) { + + return ret; + } + + // Otherwise just get the value from the style object + return style[ name ]; + } + }, + + css: function( elem, name, extra, styles ) { + var val, num, hooks, + origName = camelCase( name ), + isCustomProp = rcustomProp.test( name ); + + // Make sure that we're working with the right name. We don't + // want to modify the value if it is a CSS custom property + // since they are user-defined. + if ( !isCustomProp ) { + name = finalPropName( origName ); + } + + // Try prefixed name followed by the unprefixed name + hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ]; + + // If a hook was provided get the computed value from there + if ( hooks && "get" in hooks ) { + val = hooks.get( elem, true, extra ); + } + + // Otherwise, if a way to get the computed value exists, use that + if ( val === undefined ) { + val = curCSS( elem, name, styles ); + } + + // Convert "normal" to computed value + if ( val === "normal" && name in cssNormalTransform ) { + val = cssNormalTransform[ name ]; + } + + // Make numeric if forced or a qualifier was provided and val looks numeric + if ( extra === "" || extra ) { + num = parseFloat( val ); + return extra === true || isFinite( num ) ? num || 0 : val; + } + + return val; + } +} ); + +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { + get: function( elem, computed, extra ) { + if ( computed ) { + + // Certain elements can have dimension info if we invisibly show them + // but it must have a current display style that would benefit + return rdisplayswap.test( jQuery.css( elem, "display" ) ) && + + // Support: Safari 8+ + // Table columns in Safari have non-zero offsetWidth & zero + // getBoundingClientRect().width unless display is changed. + // Support: IE <=11 only + // Running getBoundingClientRect on a disconnected node + // in IE throws an error. + ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? + swap( elem, cssShow, function() { + return getWidthOrHeight( elem, dimension, extra ); + } ) : + getWidthOrHeight( elem, dimension, extra ); + } + }, + + set: function( elem, value, extra ) { + var matches, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 + ); + } + + // Convert to pixels if value adjustment is needed + if ( subtract && ( matches = rcssNum.exec( value ) ) && + ( matches[ 3 ] || "px" ) !== "px" ) { + + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); + } + + return setPositiveNumber( elem, value, subtract ); + } + }; +} ); + +jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft, + function( elem, computed ) { + if ( computed ) { + return ( parseFloat( curCSS( elem, "marginLeft" ) ) || + elem.getBoundingClientRect().left - + swap( elem, { marginLeft: 0 }, function() { + return elem.getBoundingClientRect().left; + } ) + ) + "px"; + } + } +); + +// These hooks are used by animate to expand properties +jQuery.each( { + margin: "", + padding: "", + border: "Width" +}, function( prefix, suffix ) { + jQuery.cssHooks[ prefix + suffix ] = { + expand: function( value ) { + var i = 0, + expanded = {}, + + // Assumes a single number if not a string + parts = typeof value === "string" ? value.split( " " ) : [ value ]; + + for ( ; i < 4; i++ ) { + expanded[ prefix + cssExpand[ i ] + suffix ] = + parts[ i ] || parts[ i - 2 ] || parts[ 0 ]; + } + + return expanded; + } + }; + + if ( prefix !== "margin" ) { + jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; + } +} ); + +jQuery.fn.extend( { + css: function( name, value ) { + return access( this, function( elem, name, value ) { + var styles, len, + map = {}, + i = 0; + + if ( Array.isArray( name ) ) { + styles = getStyles( elem ); + len = name.length; + + for ( ; i < len; i++ ) { + map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles ); + } + + return map; + } + + return value !== undefined ? + jQuery.style( elem, name, value ) : + jQuery.css( elem, name ); + }, name, value, arguments.length > 1 ); + } +} ); + + +function Tween( elem, options, prop, end, easing ) { + return new Tween.prototype.init( elem, options, prop, end, easing ); +} +jQuery.Tween = Tween; + +Tween.prototype = { + constructor: Tween, + init: function( elem, options, prop, end, easing, unit ) { + this.elem = elem; + this.prop = prop; + this.easing = easing || jQuery.easing._default; + this.options = options; + this.start = this.now = this.cur(); + this.end = end; + this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" ); + }, + cur: function() { + var hooks = Tween.propHooks[ this.prop ]; + + return hooks && hooks.get ? + hooks.get( this ) : + Tween.propHooks._default.get( this ); + }, + run: function( percent ) { + var eased, + hooks = Tween.propHooks[ this.prop ]; + + if ( this.options.duration ) { + this.pos = eased = jQuery.easing[ this.easing ]( + percent, this.options.duration * percent, 0, 1, this.options.duration + ); + } else { + this.pos = eased = percent; + } + this.now = ( this.end - this.start ) * eased + this.start; + + if ( this.options.step ) { + this.options.step.call( this.elem, this.now, this ); + } + + if ( hooks && hooks.set ) { + hooks.set( this ); + } else { + Tween.propHooks._default.set( this ); + } + return this; + } +}; + +Tween.prototype.init.prototype = Tween.prototype; + +Tween.propHooks = { + _default: { + get: function( tween ) { + var result; + + // Use a property on the element directly when it is not a DOM element, + // or when there is no matching style property that exists. + if ( tween.elem.nodeType !== 1 || + tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) { + return tween.elem[ tween.prop ]; + } + + // Passing an empty string as a 3rd parameter to .css will automatically + // attempt a parseFloat and fallback to a string if the parse fails. + // Simple values such as "10px" are parsed to Float; + // complex values such as "rotate(1rad)" are returned as-is. + result = jQuery.css( tween.elem, tween.prop, "" ); + + // Empty strings, null, undefined and "auto" are converted to 0. + return !result || result === "auto" ? 0 : result; + }, + set: function( tween ) { + + // Use step hook for back compat. + // Use cssHook if its there. + // Use .style if available and use plain properties where available. + if ( jQuery.fx.step[ tween.prop ] ) { + jQuery.fx.step[ tween.prop ]( tween ); + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { + jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); + } else { + tween.elem[ tween.prop ] = tween.now; + } + } + } +}; + +// Support: IE <=9 only +// Panic based approach to setting things on disconnected nodes +Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = { + set: function( tween ) { + if ( tween.elem.nodeType && tween.elem.parentNode ) { + tween.elem[ tween.prop ] = tween.now; + } + } +}; + +jQuery.easing = { + linear: function( p ) { + return p; + }, + swing: function( p ) { + return 0.5 - Math.cos( p * Math.PI ) / 2; + }, + _default: "swing" +}; + +jQuery.fx = Tween.prototype.init; + +// Back compat <1.8 extension point +jQuery.fx.step = {}; + + + + +var + fxNow, inProgress, + rfxtypes = /^(?:toggle|show|hide)$/, + rrun = /queueHooks$/; + +function schedule() { + if ( inProgress ) { + if ( document.hidden === false && window.requestAnimationFrame ) { + window.requestAnimationFrame( schedule ); + } else { + window.setTimeout( schedule, jQuery.fx.interval ); + } + + jQuery.fx.tick(); + } +} + +// Animations created synchronously will run synchronously +function createFxNow() { + window.setTimeout( function() { + fxNow = undefined; + } ); + return ( fxNow = Date.now() ); +} + +// Generate parameters to create a standard animation +function genFx( type, includeWidth ) { + var which, + i = 0, + attrs = { height: type }; + + // If we include width, step value is 1 to do all cssExpand values, + // otherwise step value is 2 to skip over Left and Right + includeWidth = includeWidth ? 1 : 0; + for ( ; i < 4; i += 2 - includeWidth ) { + which = cssExpand[ i ]; + attrs[ "margin" + which ] = attrs[ "padding" + which ] = type; + } + + if ( includeWidth ) { + attrs.opacity = attrs.width = type; + } + + return attrs; +} + +function createTween( value, prop, animation ) { + var tween, + collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ), + index = 0, + length = collection.length; + for ( ; index < length; index++ ) { + if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) { + + // We're done with this property + return tween; + } + } +} + +function defaultPrefilter( elem, props, opts ) { + var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display, + isBox = "width" in props || "height" in props, + anim = this, + orig = {}, + style = elem.style, + hidden = elem.nodeType && isHiddenWithinTree( elem ), + dataShow = dataPriv.get( elem, "fxshow" ); + + // Queue-skipping animations hijack the fx hooks + if ( !opts.queue ) { + hooks = jQuery._queueHooks( elem, "fx" ); + if ( hooks.unqueued == null ) { + hooks.unqueued = 0; + oldfire = hooks.empty.fire; + hooks.empty.fire = function() { + if ( !hooks.unqueued ) { + oldfire(); + } + }; + } + hooks.unqueued++; + + anim.always( function() { + + // Ensure the complete handler is called before this completes + anim.always( function() { + hooks.unqueued--; + if ( !jQuery.queue( elem, "fx" ).length ) { + hooks.empty.fire(); + } + } ); + } ); + } + + // Detect show/hide animations + for ( prop in props ) { + value = props[ prop ]; + if ( rfxtypes.test( value ) ) { + delete props[ prop ]; + toggle = toggle || value === "toggle"; + if ( value === ( hidden ? "hide" : "show" ) ) { + + // Pretend to be hidden if this is a "show" and + // there is still data from a stopped show/hide + if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) { + hidden = true; + + // Ignore all other no-op show/hide data + } else { + continue; + } + } + orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop ); + } + } + + // Bail out if this is a no-op like .hide().hide() + propTween = !jQuery.isEmptyObject( props ); + if ( !propTween && jQuery.isEmptyObject( orig ) ) { + return; + } + + // Restrict "overflow" and "display" styles during box animations + if ( isBox && elem.nodeType === 1 ) { + + // Support: IE <=9 - 11, Edge 12 - 15 + // Record all 3 overflow attributes because IE does not infer the shorthand + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. + opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; + + // Identify a display type, preferring old show/hide data over the CSS cascade + restoreDisplay = dataShow && dataShow.display; + if ( restoreDisplay == null ) { + restoreDisplay = dataPriv.get( elem, "display" ); + } + display = jQuery.css( elem, "display" ); + if ( display === "none" ) { + if ( restoreDisplay ) { + display = restoreDisplay; + } else { + + // Get nonempty value(s) by temporarily forcing visibility + showHide( [ elem ], true ); + restoreDisplay = elem.style.display || restoreDisplay; + display = jQuery.css( elem, "display" ); + showHide( [ elem ] ); + } + } + + // Animate inline elements as inline-block + if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) { + if ( jQuery.css( elem, "float" ) === "none" ) { + + // Restore the original display value at the end of pure show/hide animations + if ( !propTween ) { + anim.done( function() { + style.display = restoreDisplay; + } ); + if ( restoreDisplay == null ) { + display = style.display; + restoreDisplay = display === "none" ? "" : display; + } + } + style.display = "inline-block"; + } + } + } + + if ( opts.overflow ) { + style.overflow = "hidden"; + anim.always( function() { + style.overflow = opts.overflow[ 0 ]; + style.overflowX = opts.overflow[ 1 ]; + style.overflowY = opts.overflow[ 2 ]; + } ); + } + + // Implement show/hide animations + propTween = false; + for ( prop in orig ) { + + // General show/hide setup for this element animation + if ( !propTween ) { + if ( dataShow ) { + if ( "hidden" in dataShow ) { + hidden = dataShow.hidden; + } + } else { + dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } ); + } + + // Store hidden/visible for toggle so `.stop().toggle()` "reverses" + if ( toggle ) { + dataShow.hidden = !hidden; + } + + // Show elements before animating them + if ( hidden ) { + showHide( [ elem ], true ); + } + + /* eslint-disable no-loop-func */ + + anim.done( function() { + + /* eslint-enable no-loop-func */ + + // The final step of a "hide" animation is actually hiding the element + if ( !hidden ) { + showHide( [ elem ] ); + } + dataPriv.remove( elem, "fxshow" ); + for ( prop in orig ) { + jQuery.style( elem, prop, orig[ prop ] ); + } + } ); + } + + // Per-property setup + propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim ); + if ( !( prop in dataShow ) ) { + dataShow[ prop ] = propTween.start; + if ( hidden ) { + propTween.end = propTween.start; + propTween.start = 0; + } + } + } +} + +function propFilter( props, specialEasing ) { + var index, name, easing, value, hooks; + + // camelCase, specialEasing and expand cssHook pass + for ( index in props ) { + name = camelCase( index ); + easing = specialEasing[ name ]; + value = props[ index ]; + if ( Array.isArray( value ) ) { + easing = value[ 1 ]; + value = props[ index ] = value[ 0 ]; + } + + if ( index !== name ) { + props[ name ] = value; + delete props[ index ]; + } + + hooks = jQuery.cssHooks[ name ]; + if ( hooks && "expand" in hooks ) { + value = hooks.expand( value ); + delete props[ name ]; + + // Not quite $.extend, this won't overwrite existing keys. + // Reusing 'index' because we have the correct "name" + for ( index in value ) { + if ( !( index in props ) ) { + props[ index ] = value[ index ]; + specialEasing[ index ] = easing; + } + } + } else { + specialEasing[ name ] = easing; + } + } +} + +function Animation( elem, properties, options ) { + var result, + stopped, + index = 0, + length = Animation.prefilters.length, + deferred = jQuery.Deferred().always( function() { + + // Don't match elem in the :animated selector + delete tick.elem; + } ), + tick = function() { + if ( stopped ) { + return false; + } + var currentTime = fxNow || createFxNow(), + remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ), + + // Support: Android 2.3 only + // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497) + temp = remaining / animation.duration || 0, + percent = 1 - temp, + index = 0, + length = animation.tweens.length; + + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( percent ); + } + + deferred.notifyWith( elem, [ animation, percent, remaining ] ); + + // If there's more to do, yield + if ( percent < 1 && length ) { + return remaining; + } + + // If this was an empty animation, synthesize a final progress notification + if ( !length ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + } + + // Resolve the animation and report its conclusion + deferred.resolveWith( elem, [ animation ] ); + return false; + }, + animation = deferred.promise( { + elem: elem, + props: jQuery.extend( {}, properties ), + opts: jQuery.extend( true, { + specialEasing: {}, + easing: jQuery.easing._default + }, options ), + originalProperties: properties, + originalOptions: options, + startTime: fxNow || createFxNow(), + duration: options.duration, + tweens: [], + createTween: function( prop, end ) { + var tween = jQuery.Tween( elem, animation.opts, prop, end, + animation.opts.specialEasing[ prop ] || animation.opts.easing ); + animation.tweens.push( tween ); + return tween; + }, + stop: function( gotoEnd ) { + var index = 0, + + // If we are going to the end, we want to run all the tweens + // otherwise we skip this part + length = gotoEnd ? animation.tweens.length : 0; + if ( stopped ) { + return this; + } + stopped = true; + for ( ; index < length; index++ ) { + animation.tweens[ index ].run( 1 ); + } + + // Resolve when we played the last frame; otherwise, reject + if ( gotoEnd ) { + deferred.notifyWith( elem, [ animation, 1, 0 ] ); + deferred.resolveWith( elem, [ animation, gotoEnd ] ); + } else { + deferred.rejectWith( elem, [ animation, gotoEnd ] ); + } + return this; + } + } ), + props = animation.props; + + propFilter( props, animation.opts.specialEasing ); + + for ( ; index < length; index++ ) { + result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); + if ( result ) { + if ( isFunction( result.stop ) ) { + jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = + result.stop.bind( result ); + } + return result; + } + } + + jQuery.map( props, createTween, animation ); + + if ( isFunction( animation.opts.start ) ) { + animation.opts.start.call( elem, animation ); + } + + // Attach callbacks from options + animation + .progress( animation.opts.progress ) + .done( animation.opts.done, animation.opts.complete ) + .fail( animation.opts.fail ) + .always( animation.opts.always ); + + jQuery.fx.timer( + jQuery.extend( tick, { + elem: elem, + anim: animation, + queue: animation.opts.queue + } ) + ); + + return animation; +} + +jQuery.Animation = jQuery.extend( Animation, { + + tweeners: { + "*": [ function( prop, value ) { + var tween = this.createTween( prop, value ); + adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween ); + return tween; + } ] + }, + + tweener: function( props, callback ) { + if ( isFunction( props ) ) { + callback = props; + props = [ "*" ]; + } else { + props = props.match( rnothtmlwhite ); + } + + var prop, + index = 0, + length = props.length; + + for ( ; index < length; index++ ) { + prop = props[ index ]; + Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || []; + Animation.tweeners[ prop ].unshift( callback ); + } + }, + + prefilters: [ defaultPrefilter ], + + prefilter: function( callback, prepend ) { + if ( prepend ) { + Animation.prefilters.unshift( callback ); + } else { + Animation.prefilters.push( callback ); + } + } +} ); + +jQuery.speed = function( speed, easing, fn ) { + var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { + complete: fn || !fn && easing || + isFunction( speed ) && speed, + duration: speed, + easing: fn && easing || easing && !isFunction( easing ) && easing + }; + + // Go to the end state if fx are off + if ( jQuery.fx.off ) { + opt.duration = 0; + + } else { + if ( typeof opt.duration !== "number" ) { + if ( opt.duration in jQuery.fx.speeds ) { + opt.duration = jQuery.fx.speeds[ opt.duration ]; + + } else { + opt.duration = jQuery.fx.speeds._default; + } + } + } + + // Normalize opt.queue - true/undefined/null -> "fx" + if ( opt.queue == null || opt.queue === true ) { + opt.queue = "fx"; + } + + // Queueing + opt.old = opt.complete; + + opt.complete = function() { + if ( isFunction( opt.old ) ) { + opt.old.call( this ); + } + + if ( opt.queue ) { + jQuery.dequeue( this, opt.queue ); + } + }; + + return opt; +}; + +jQuery.fn.extend( { + fadeTo: function( speed, to, easing, callback ) { + + // Show any hidden elements after setting opacity to 0 + return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show() + + // Animate to the value specified + .end().animate( { opacity: to }, speed, easing, callback ); + }, + animate: function( prop, speed, easing, callback ) { + var empty = jQuery.isEmptyObject( prop ), + optall = jQuery.speed( speed, easing, callback ), + doAnimation = function() { + + // Operate on a copy of prop so per-property easing won't be lost + var anim = Animation( this, jQuery.extend( {}, prop ), optall ); + + // Empty animations, or finishing resolves immediately + if ( empty || dataPriv.get( this, "finish" ) ) { + anim.stop( true ); + } + }; + doAnimation.finish = doAnimation; + + return empty || optall.queue === false ? + this.each( doAnimation ) : + this.queue( optall.queue, doAnimation ); + }, + stop: function( type, clearQueue, gotoEnd ) { + var stopQueue = function( hooks ) { + var stop = hooks.stop; + delete hooks.stop; + stop( gotoEnd ); + }; + + if ( typeof type !== "string" ) { + gotoEnd = clearQueue; + clearQueue = type; + type = undefined; + } + if ( clearQueue ) { + this.queue( type || "fx", [] ); + } + + return this.each( function() { + var dequeue = true, + index = type != null && type + "queueHooks", + timers = jQuery.timers, + data = dataPriv.get( this ); + + if ( index ) { + if ( data[ index ] && data[ index ].stop ) { + stopQueue( data[ index ] ); + } + } else { + for ( index in data ) { + if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) { + stopQueue( data[ index ] ); + } + } + } + + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && + ( type == null || timers[ index ].queue === type ) ) { + + timers[ index ].anim.stop( gotoEnd ); + dequeue = false; + timers.splice( index, 1 ); + } + } + + // Start the next in the queue if the last step wasn't forced. + // Timers currently will call their complete callbacks, which + // will dequeue but only if they were gotoEnd. + if ( dequeue || !gotoEnd ) { + jQuery.dequeue( this, type ); + } + } ); + }, + finish: function( type ) { + if ( type !== false ) { + type = type || "fx"; + } + return this.each( function() { + var index, + data = dataPriv.get( this ), + queue = data[ type + "queue" ], + hooks = data[ type + "queueHooks" ], + timers = jQuery.timers, + length = queue ? queue.length : 0; + + // Enable finishing flag on private data + data.finish = true; + + // Empty the queue first + jQuery.queue( this, type, [] ); + + if ( hooks && hooks.stop ) { + hooks.stop.call( this, true ); + } + + // Look for any active animations, and finish them + for ( index = timers.length; index--; ) { + if ( timers[ index ].elem === this && timers[ index ].queue === type ) { + timers[ index ].anim.stop( true ); + timers.splice( index, 1 ); + } + } + + // Look for any animations in the old queue and finish them + for ( index = 0; index < length; index++ ) { + if ( queue[ index ] && queue[ index ].finish ) { + queue[ index ].finish.call( this ); + } + } + + // Turn off finishing flag + delete data.finish; + } ); + } +} ); + +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { + var cssFn = jQuery.fn[ name ]; + jQuery.fn[ name ] = function( speed, easing, callback ) { + return speed == null || typeof speed === "boolean" ? + cssFn.apply( this, arguments ) : + this.animate( genFx( name, true ), speed, easing, callback ); + }; +} ); + +// Generate shortcuts for custom animations +jQuery.each( { + slideDown: genFx( "show" ), + slideUp: genFx( "hide" ), + slideToggle: genFx( "toggle" ), + fadeIn: { opacity: "show" }, + fadeOut: { opacity: "hide" }, + fadeToggle: { opacity: "toggle" } +}, function( name, props ) { + jQuery.fn[ name ] = function( speed, easing, callback ) { + return this.animate( props, speed, easing, callback ); + }; +} ); + +jQuery.timers = []; +jQuery.fx.tick = function() { + var timer, + i = 0, + timers = jQuery.timers; + + fxNow = Date.now(); + + for ( ; i < timers.length; i++ ) { + timer = timers[ i ]; + + // Run the timer and safely remove it when done (allowing for external removal) + if ( !timer() && timers[ i ] === timer ) { + timers.splice( i--, 1 ); + } + } + + if ( !timers.length ) { + jQuery.fx.stop(); + } + fxNow = undefined; +}; + +jQuery.fx.timer = function( timer ) { + jQuery.timers.push( timer ); + jQuery.fx.start(); +}; + +jQuery.fx.interval = 13; +jQuery.fx.start = function() { + if ( inProgress ) { + return; + } + + inProgress = true; + schedule(); +}; + +jQuery.fx.stop = function() { + inProgress = null; +}; + +jQuery.fx.speeds = { + slow: 600, + fast: 200, + + // Default speed + _default: 400 +}; + + +// Based off of the plugin by Clint Helfers, with permission. +// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/ +jQuery.fn.delay = function( time, type ) { + time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time; + type = type || "fx"; + + return this.queue( type, function( next, hooks ) { + var timeout = window.setTimeout( next, time ); + hooks.stop = function() { + window.clearTimeout( timeout ); + }; + } ); +}; + + +( function() { + var input = document.createElement( "input" ), + select = document.createElement( "select" ), + opt = select.appendChild( document.createElement( "option" ) ); + + input.type = "checkbox"; + + // Support: Android <=4.3 only + // Default value for a checkbox should be "on" + support.checkOn = input.value !== ""; + + // Support: IE <=11 only + // Must access selectedIndex to make default options select + support.optSelected = opt.selected; + + // Support: IE <=11 only + // An input loses its value after becoming a radio + input = document.createElement( "input" ); + input.value = "t"; + input.type = "radio"; + support.radioValue = input.value === "t"; +} )(); + + +var boolHook, + attrHandle = jQuery.expr.attrHandle; + +jQuery.fn.extend( { + attr: function( name, value ) { + return access( this, jQuery.attr, name, value, arguments.length > 1 ); + }, + + removeAttr: function( name ) { + return this.each( function() { + jQuery.removeAttr( this, name ); + } ); + } +} ); + +jQuery.extend( { + attr: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set attributes on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + // Fallback to prop when attributes are not supported + if ( typeof elem.getAttribute === "undefined" ) { + return jQuery.prop( elem, name, value ); + } + + // Attribute hooks are determined by the lowercase version + // Grab necessary hook if one is defined + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + hooks = jQuery.attrHooks[ name.toLowerCase() ] || + ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined ); + } + + if ( value !== undefined ) { + if ( value === null ) { + jQuery.removeAttr( elem, name ); + return; + } + + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + elem.setAttribute( name, value + "" ); + return value; + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + ret = jQuery.find.attr( elem, name ); + + // Non-existent attributes return null, we normalize to undefined + return ret == null ? undefined : ret; + }, + + attrHooks: { + type: { + set: function( elem, value ) { + if ( !support.radioValue && value === "radio" && + nodeName( elem, "input" ) ) { + var val = elem.value; + elem.setAttribute( "type", value ); + if ( val ) { + elem.value = val; + } + return value; + } + } + } + }, + + removeAttr: function( elem, value ) { + var name, + i = 0, + + // Attribute names can contain non-HTML whitespace characters + // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2 + attrNames = value && value.match( rnothtmlwhite ); + + if ( attrNames && elem.nodeType === 1 ) { + while ( ( name = attrNames[ i++ ] ) ) { + elem.removeAttribute( name ); + } + } + } +} ); + +// Hooks for boolean attributes +boolHook = { + set: function( elem, value, name ) { + if ( value === false ) { + + // Remove boolean attributes when set to false + jQuery.removeAttr( elem, name ); + } else { + elem.setAttribute( name, name ); + } + return name; + } +}; + +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { + var getter = attrHandle[ name ] || jQuery.find.attr; + + attrHandle[ name ] = function( elem, name, isXML ) { + var ret, handle, + lowercaseName = name.toLowerCase(); + + if ( !isXML ) { + + // Avoid an infinite loop by temporarily removing this function from the getter + handle = attrHandle[ lowercaseName ]; + attrHandle[ lowercaseName ] = ret; + ret = getter( elem, name, isXML ) != null ? + lowercaseName : + null; + attrHandle[ lowercaseName ] = handle; + } + return ret; + }; +} ); + + + + +var rfocusable = /^(?:input|select|textarea|button)$/i, + rclickable = /^(?:a|area)$/i; + +jQuery.fn.extend( { + prop: function( name, value ) { + return access( this, jQuery.prop, name, value, arguments.length > 1 ); + }, + + removeProp: function( name ) { + return this.each( function() { + delete this[ jQuery.propFix[ name ] || name ]; + } ); + } +} ); + +jQuery.extend( { + prop: function( elem, name, value ) { + var ret, hooks, + nType = elem.nodeType; + + // Don't get/set properties on text, comment and attribute nodes + if ( nType === 3 || nType === 8 || nType === 2 ) { + return; + } + + if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) { + + // Fix name and attach hooks + name = jQuery.propFix[ name ] || name; + hooks = jQuery.propHooks[ name ]; + } + + if ( value !== undefined ) { + if ( hooks && "set" in hooks && + ( ret = hooks.set( elem, value, name ) ) !== undefined ) { + return ret; + } + + return ( elem[ name ] = value ); + } + + if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) { + return ret; + } + + return elem[ name ]; + }, + + propHooks: { + tabIndex: { + get: function( elem ) { + + // Support: IE <=9 - 11 only + // elem.tabIndex doesn't always return the + // correct value when it hasn't been explicitly set + // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/ + // Use proper attribute retrieval(#12072) + var tabindex = jQuery.find.attr( elem, "tabindex" ); + + if ( tabindex ) { + return parseInt( tabindex, 10 ); + } + + if ( + rfocusable.test( elem.nodeName ) || + rclickable.test( elem.nodeName ) && + elem.href + ) { + return 0; + } + + return -1; + } + } + }, + + propFix: { + "for": "htmlFor", + "class": "className" + } +} ); + +// Support: IE <=11 only +// Accessing the selectedIndex property +// forces the browser to respect setting selected +// on the option +// The getter ensures a default option is selected +// when in an optgroup +// eslint rule "no-unused-expressions" is disabled for this code +// since it considers such accessions noop +if ( !support.optSelected ) { + jQuery.propHooks.selected = { + get: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent && parent.parentNode ) { + parent.parentNode.selectedIndex; + } + return null; + }, + set: function( elem ) { + + /* eslint no-unused-expressions: "off" */ + + var parent = elem.parentNode; + if ( parent ) { + parent.selectedIndex; + + if ( parent.parentNode ) { + parent.parentNode.selectedIndex; + } + } + } + }; +} + +jQuery.each( [ + "tabIndex", + "readOnly", + "maxLength", + "cellSpacing", + "cellPadding", + "rowSpan", + "colSpan", + "useMap", + "frameBorder", + "contentEditable" +], function() { + jQuery.propFix[ this.toLowerCase() ] = this; +} ); + + + + + // Strip and collapse whitespace according to HTML spec + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace + function stripAndCollapse( value ) { + var tokens = value.match( rnothtmlwhite ) || []; + return tokens.join( " " ); + } + + +function getClass( elem ) { + return elem.getAttribute && elem.getAttribute( "class" ) || ""; +} + +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + +jQuery.fn.extend( { + addClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + if ( cur.indexOf( " " + clazz + " " ) < 0 ) { + cur += clazz + " "; + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + removeClass: function( value ) { + var classes, elem, cur, curValue, clazz, j, finalValue, + i = 0; + + if ( isFunction( value ) ) { + return this.each( function( j ) { + jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); + } ); + } + + if ( !arguments.length ) { + return this.attr( "class", "" ); + } + + classes = classesToArray( value ); + + if ( classes.length ) { + while ( ( elem = this[ i++ ] ) ) { + curValue = getClass( elem ); + + // This expression is here for better compressibility (see addClass) + cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); + + if ( cur ) { + j = 0; + while ( ( clazz = classes[ j++ ] ) ) { + + // Remove *all* instances + while ( cur.indexOf( " " + clazz + " " ) > -1 ) { + cur = cur.replace( " " + clazz + " ", " " ); + } + } + + // Only assign if different to avoid unneeded rendering. + finalValue = stripAndCollapse( cur ); + if ( curValue !== finalValue ) { + elem.setAttribute( "class", finalValue ); + } + } + } + } + + return this; + }, + + toggleClass: function( value, stateVal ) { + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); + + if ( typeof stateVal === "boolean" && isValidValue ) { + return stateVal ? this.addClass( value ) : this.removeClass( value ); + } + + if ( isFunction( value ) ) { + return this.each( function( i ) { + jQuery( this ).toggleClass( + value.call( this, i, getClass( this ), stateVal ), + stateVal + ); + } ); + } + + return this.each( function() { + var className, i, self, classNames; + + if ( isValidValue ) { + + // Toggle individual class names + i = 0; + self = jQuery( this ); + classNames = classesToArray( value ); + + while ( ( className = classNames[ i++ ] ) ) { + + // Check each className given, space separated list + if ( self.hasClass( className ) ) { + self.removeClass( className ); + } else { + self.addClass( className ); + } + } + + // Toggle whole class name + } else if ( value === undefined || type === "boolean" ) { + className = getClass( this ); + if ( className ) { + + // Store className if set + dataPriv.set( this, "__className__", className ); + } + + // If the element has a class name or if we're passed `false`, + // then remove the whole classname (if there was one, the above saved it). + // Otherwise bring back whatever was previously saved (if anything), + // falling back to the empty string if nothing was stored. + if ( this.setAttribute ) { + this.setAttribute( "class", + className || value === false ? + "" : + dataPriv.get( this, "__className__" ) || "" + ); + } + } + } ); + }, + + hasClass: function( selector ) { + var className, elem, + i = 0; + + className = " " + selector + " "; + while ( ( elem = this[ i++ ] ) ) { + if ( elem.nodeType === 1 && + ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) { + return true; + } + } + + return false; + } +} ); + + + + +var rreturn = /\r/g; + +jQuery.fn.extend( { + val: function( value ) { + var hooks, ret, valueIsFunction, + elem = this[ 0 ]; + + if ( !arguments.length ) { + if ( elem ) { + hooks = jQuery.valHooks[ elem.type ] || + jQuery.valHooks[ elem.nodeName.toLowerCase() ]; + + if ( hooks && + "get" in hooks && + ( ret = hooks.get( elem, "value" ) ) !== undefined + ) { + return ret; + } + + ret = elem.value; + + // Handle most common string cases + if ( typeof ret === "string" ) { + return ret.replace( rreturn, "" ); + } + + // Handle cases where value is null/undef or number + return ret == null ? "" : ret; + } + + return; + } + + valueIsFunction = isFunction( value ); + + return this.each( function( i ) { + var val; + + if ( this.nodeType !== 1 ) { + return; + } + + if ( valueIsFunction ) { + val = value.call( this, i, jQuery( this ).val() ); + } else { + val = value; + } + + // Treat null/undefined as ""; convert numbers to string + if ( val == null ) { + val = ""; + + } else if ( typeof val === "number" ) { + val += ""; + + } else if ( Array.isArray( val ) ) { + val = jQuery.map( val, function( value ) { + return value == null ? "" : value + ""; + } ); + } + + hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ]; + + // If set returns undefined, fall back to normal setting + if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) { + this.value = val; + } + } ); + } +} ); + +jQuery.extend( { + valHooks: { + option: { + get: function( elem ) { + + var val = jQuery.find.attr( elem, "value" ); + return val != null ? + val : + + // Support: IE <=10 - 11 only + // option.text throws exceptions (#14686, #14858) + // Strip and collapse whitespace + // https://html.spec.whatwg.org/#strip-and-collapse-whitespace + stripAndCollapse( jQuery.text( elem ) ); + } + }, + select: { + get: function( elem ) { + var value, option, i, + options = elem.options, + index = elem.selectedIndex, + one = elem.type === "select-one", + values = one ? null : [], + max = one ? index + 1 : options.length; + + if ( index < 0 ) { + i = max; + + } else { + i = one ? index : 0; + } + + // Loop through all the selected options + for ( ; i < max; i++ ) { + option = options[ i ]; + + // Support: IE <=9 only + // IE8-9 doesn't update selected after form reset (#2551) + if ( ( option.selected || i === index ) && + + // Don't return options that are disabled or in a disabled optgroup + !option.disabled && + ( !option.parentNode.disabled || + !nodeName( option.parentNode, "optgroup" ) ) ) { + + // Get the specific value for the option + value = jQuery( option ).val(); + + // We don't need an array for one selects + if ( one ) { + return value; + } + + // Multi-Selects return an array + values.push( value ); + } + } + + return values; + }, + + set: function( elem, value ) { + var optionSet, option, + options = elem.options, + values = jQuery.makeArray( value ), + i = options.length; + + while ( i-- ) { + option = options[ i ]; + + /* eslint-disable no-cond-assign */ + + if ( option.selected = + jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1 + ) { + optionSet = true; + } + + /* eslint-enable no-cond-assign */ + } + + // Force browsers to behave consistently when non-matching value is set + if ( !optionSet ) { + elem.selectedIndex = -1; + } + return values; + } + } + } +} ); + +// Radios and checkboxes getter/setter +jQuery.each( [ "radio", "checkbox" ], function() { + jQuery.valHooks[ this ] = { + set: function( elem, value ) { + if ( Array.isArray( value ) ) { + return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 ); + } + } + }; + if ( !support.checkOn ) { + jQuery.valHooks[ this ].get = function( elem ) { + return elem.getAttribute( "value" ) === null ? "on" : elem.value; + }; + } +} ); + + + + +// Return jQuery for attributes-only inclusion + + +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; + +jQuery.extend( jQuery.event, { + + trigger: function( event, data, elem, onlyHandlers ) { + + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, + eventPath = [ elem || document ], + type = hasOwn.call( event, "type" ) ? event.type : event, + namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; + + cur = lastElement = tmp = elem = elem || document; + + // Don't do events on text and comment nodes + if ( elem.nodeType === 3 || elem.nodeType === 8 ) { + return; + } + + // focus/blur morphs to focusin/out; ensure we're not firing them right now + if ( rfocusMorph.test( type + jQuery.event.triggered ) ) { + return; + } + + if ( type.indexOf( "." ) > -1 ) { + + // Namespaced trigger; create a regexp to match event type in handle() + namespaces = type.split( "." ); + type = namespaces.shift(); + namespaces.sort(); + } + ontype = type.indexOf( ":" ) < 0 && "on" + type; + + // Caller can pass in a jQuery.Event object, Object, or just an event type string + event = event[ jQuery.expando ] ? + event : + new jQuery.Event( type, typeof event === "object" && event ); + + // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true) + event.isTrigger = onlyHandlers ? 2 : 3; + event.namespace = namespaces.join( "." ); + event.rnamespace = event.namespace ? + new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) : + null; + + // Clean up the event in case it is being reused + event.result = undefined; + if ( !event.target ) { + event.target = elem; + } + + // Clone any incoming data and prepend the event, creating the handler arg list + data = data == null ? + [ event ] : + jQuery.makeArray( data, [ event ] ); + + // Allow special events to draw outside the lines + special = jQuery.event.special[ type ] || {}; + if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) { + return; + } + + // Determine event propagation path in advance, per W3C events spec (#9951) + // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { + + bubbleType = special.delegateType || type; + if ( !rfocusMorph.test( bubbleType + type ) ) { + cur = cur.parentNode; + } + for ( ; cur; cur = cur.parentNode ) { + eventPath.push( cur ); + tmp = cur; + } + + // Only add window if we got to document (e.g., not plain obj or detached DOM) + if ( tmp === ( elem.ownerDocument || document ) ) { + eventPath.push( tmp.defaultView || tmp.parentWindow || window ); + } + } + + // Fire handlers on the event path + i = 0; + while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { + lastElement = cur; + event.type = i > 1 ? + bubbleType : + special.bindType || type; + + // jQuery handler + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && + dataPriv.get( cur, "handle" ); + if ( handle ) { + handle.apply( cur, data ); + } + + // Native handler + handle = ontype && cur[ ontype ]; + if ( handle && handle.apply && acceptData( cur ) ) { + event.result = handle.apply( cur, data ); + if ( event.result === false ) { + event.preventDefault(); + } + } + } + event.type = type; + + // If nobody prevented the default action, do it now + if ( !onlyHandlers && !event.isDefaultPrevented() ) { + + if ( ( !special._default || + special._default.apply( eventPath.pop(), data ) === false ) && + acceptData( elem ) ) { + + // Call a native DOM method on the target with the same name as the event. + // Don't do default actions on window, that's where global variables be (#6170) + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { + + // Don't re-trigger an onFOO event when we call its FOO() method + tmp = elem[ ontype ]; + + if ( tmp ) { + elem[ ontype ] = null; + } + + // Prevent re-triggering of the same event, since we already bubbled it above + jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + + jQuery.event.triggered = undefined; + + if ( tmp ) { + elem[ ontype ] = tmp; + } + } + } + } + + return event.result; + }, + + // Piggyback on a donor event to simulate a different one + // Used only for `focus(in | out)` events + simulate: function( type, elem, event ) { + var e = jQuery.extend( + new jQuery.Event(), + event, + { + type: type, + isSimulated: true + } + ); + + jQuery.event.trigger( e, null, elem ); + } + +} ); + +jQuery.fn.extend( { + + trigger: function( type, data ) { + return this.each( function() { + jQuery.event.trigger( type, data, this ); + } ); + }, + triggerHandler: function( type, data ) { + var elem = this[ 0 ]; + if ( elem ) { + return jQuery.event.trigger( type, data, elem, true ); + } + } +} ); + + +// Support: Firefox <=44 +// Firefox doesn't have focus(in | out) events +// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 +// +// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1 +// focus(in | out) events fire after focus & blur events, +// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order +// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857 +if ( !support.focusin ) { + jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) { + + // Attach a single capturing handler on the document while someone wants focusin/focusout + var handler = function( event ) { + jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) ); + }; + + jQuery.event.special[ fix ] = { + setup: function() { + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ); + + if ( !attaches ) { + doc.addEventListener( orig, handler, true ); + } + dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); + }, + teardown: function() { + var doc = this.ownerDocument || this.document || this, + attaches = dataPriv.access( doc, fix ) - 1; + + if ( !attaches ) { + doc.removeEventListener( orig, handler, true ); + dataPriv.remove( doc, fix ); + + } else { + dataPriv.access( doc, fix, attaches ); + } + } + }; + } ); +} +var location = window.location; + +var nonce = { guid: Date.now() }; + +var rquery = ( /\?/ ); + + + +// Cross-browser xml parsing +jQuery.parseXML = function( data ) { + var xml; + 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.guid++ ) + + uncached; + } + + // Put hash and anti-cache on the URL that will be requested (gh-1732) + s.url = cacheURL + uncached; + + // Change '%20' to '+' if this is encoded form body content (gh-2658) + } else if ( s.data && s.processData && + ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) { + s.data = s.data.replace( r20, "+" ); + } + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + if ( jQuery.lastModified[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] ); + } + if ( jQuery.etag[ cacheURL ] ) { + jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] ); + } + } + + // Set the correct header, if data is being sent + if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) { + jqXHR.setRequestHeader( "Content-Type", s.contentType ); + } + + // Set the Accepts header for the server, depending on the dataType + jqXHR.setRequestHeader( + "Accept", + s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ? + s.accepts[ s.dataTypes[ 0 ] ] + + ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) : + s.accepts[ "*" ] + ); + + // Check for headers option + for ( i in s.headers ) { + jqXHR.setRequestHeader( i, s.headers[ i ] ); + } + + // Allow custom headers/mimetypes and early abort + if ( s.beforeSend && + ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) { + + // Abort if not done already and return + return jqXHR.abort(); + } + + // Aborting is no longer a cancellation + strAbort = "abort"; + + // Install callbacks on deferreds + completeDeferred.add( s.complete ); + jqXHR.done( s.success ); + jqXHR.fail( s.error ); + + // Get transport + transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR ); + + // If no transport, we auto-abort + if ( !transport ) { + done( -1, "No Transport" ); + } else { + jqXHR.readyState = 1; + + // Send global event + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] ); + } + + // If request was aborted inside ajaxSend, stop there + if ( completed ) { + return jqXHR; + } + + // Timeout + if ( s.async && s.timeout > 0 ) { + timeoutTimer = window.setTimeout( function() { + jqXHR.abort( "timeout" ); + }, s.timeout ); + } + + try { + completed = false; + transport.send( requestHeaders, done ); + } catch ( e ) { + + // Rethrow post-completion exceptions + if ( completed ) { + throw e; + } + + // Propagate others as results + done( -1, e ); + } + } + + // Callback for when everything is done + function done( status, nativeStatusText, responses, headers ) { + var isSuccess, success, error, response, modified, + statusText = nativeStatusText; + + // Ignore repeat invocations + if ( completed ) { + return; + } + + completed = true; + + // Clear timeout if it exists + if ( timeoutTimer ) { + window.clearTimeout( timeoutTimer ); + } + + // Dereference transport for early garbage collection + // (no matter how long the jqXHR object will be used) + transport = undefined; + + // Cache response headers + responseHeadersString = headers || ""; + + // Set readyState + jqXHR.readyState = status > 0 ? 4 : 0; + + // Determine if successful + isSuccess = status >= 200 && status < 300 || status === 304; + + // Get response data + if ( responses ) { + response = ajaxHandleResponses( s, jqXHR, responses ); + } + + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + + // Convert no matter what (that way responseXXX fields are always set) + response = ajaxConvert( s, response, jqXHR, isSuccess ); + + // If successful, handle type chaining + if ( isSuccess ) { + + // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode. + if ( s.ifModified ) { + modified = jqXHR.getResponseHeader( "Last-Modified" ); + if ( modified ) { + jQuery.lastModified[ cacheURL ] = modified; + } + modified = jqXHR.getResponseHeader( "etag" ); + if ( modified ) { + jQuery.etag[ cacheURL ] = modified; + } + } + + // if no content + if ( status === 204 || s.type === "HEAD" ) { + statusText = "nocontent"; + + // if not modified + } else if ( status === 304 ) { + statusText = "notmodified"; + + // If we have data, let's convert it + } else { + statusText = response.state; + success = response.data; + error = response.error; + isSuccess = !error; + } + } else { + + // Extract error from statusText and normalize for non-aborts + error = statusText; + if ( status || !statusText ) { + statusText = "error"; + if ( status < 0 ) { + status = 0; + } + } + } + + // Set data for the fake xhr object + jqXHR.status = status; + jqXHR.statusText = ( nativeStatusText || statusText ) + ""; + + // Success/Error + if ( isSuccess ) { + deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] ); + } else { + deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] ); + } + + // Status-dependent callbacks + jqXHR.statusCode( statusCode ); + statusCode = undefined; + + if ( fireGlobals ) { + globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError", + [ jqXHR, s, isSuccess ? success : error ] ); + } + + // Complete + completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] ); + + if ( fireGlobals ) { + globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] ); + + // Handle the global AJAX counter + if ( !( --jQuery.active ) ) { + jQuery.event.trigger( "ajaxStop" ); + } + } + } + + return jqXHR; + }, + + getJSON: function( url, data, callback ) { + return jQuery.get( url, data, callback, "json" ); + }, + + getScript: function( url, callback ) { + return jQuery.get( url, undefined, callback, "script" ); + } +} ); + +jQuery.each( [ "get", "post" ], function( _i, method ) { + jQuery[ method ] = function( url, data, callback, type ) { + + // Shift arguments if data argument was omitted + if ( isFunction( data ) ) { + type = type || callback; + callback = data; + data = undefined; + } + + // The url can be an options object (which then must have .url) + return jQuery.ajax( jQuery.extend( { + url: url, + type: method, + dataType: type, + data: data, + success: callback + }, jQuery.isPlainObject( url ) && url ) ); + }; +} ); + +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + + +jQuery._evalUrl = function( url, options, doc ) { + return jQuery.ajax( { + url: url, + + // Make this explicit, since user can override this through ajaxSetup (#11264) + type: "GET", + dataType: "script", + cache: true, + async: false, + global: false, + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } + } ); +}; + + +jQuery.fn.extend( { + wrapAll: function( html ) { + var wrap; + + if ( this[ 0 ] ) { + if ( isFunction( html ) ) { + html = html.call( this[ 0 ] ); + } + + // The elements to wrap the target around + wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true ); + + if ( this[ 0 ].parentNode ) { + wrap.insertBefore( this[ 0 ] ); + } + + wrap.map( function() { + var elem = this; + + while ( elem.firstElementChild ) { + elem = elem.firstElementChild; + } + + return elem; + } ).append( this ); + } + + return this; + }, + + wrapInner: function( html ) { + if ( isFunction( html ) ) { + return this.each( function( i ) { + jQuery( this ).wrapInner( html.call( this, i ) ); + } ); + } + + return this.each( function() { + var self = jQuery( this ), + contents = self.contents(); + + if ( contents.length ) { + contents.wrapAll( html ); + + } else { + self.append( html ); + } + } ); + }, + + wrap: function( html ) { + var htmlIsFunction = isFunction( html ); + + return this.each( function( i ) { + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); + } ); + }, + + unwrap: function( selector ) { + this.parent( selector ).not( "body" ).each( function() { + jQuery( this ).replaceWith( this.childNodes ); + } ); + return this; + } +} ); + + +jQuery.expr.pseudos.hidden = function( elem ) { + return !jQuery.expr.pseudos.visible( elem ); +}; +jQuery.expr.pseudos.visible = function( elem ) { + return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length ); +}; + + + + +jQuery.ajaxSettings.xhr = function() { + try { + return new window.XMLHttpRequest(); + } catch ( e ) {} +}; + +var xhrSuccessStatus = { + + // File protocol always yields status code 0, assume 200 + 0: 200, + + // Support: IE <=9 only + // #1450: sometimes IE returns 1223 when it should be 204 + 1223: 204 + }, + xhrSupported = jQuery.ajaxSettings.xhr(); + +support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported ); +support.ajax = xhrSupported = !!xhrSupported; + +jQuery.ajaxTransport( function( options ) { + var callback, errorCallback; + + // Cross domain only allowed if supported through XMLHttpRequest + if ( support.cors || xhrSupported && !options.crossDomain ) { + return { + send: function( headers, complete ) { + var i, + xhr = options.xhr(); + + xhr.open( + options.type, + options.url, + options.async, + options.username, + options.password + ); + + // Apply custom fields if provided + if ( options.xhrFields ) { + for ( i in options.xhrFields ) { + xhr[ i ] = options.xhrFields[ i ]; + } + } + + // Override mime type if needed + if ( options.mimeType && xhr.overrideMimeType ) { + xhr.overrideMimeType( options.mimeType ); + } + + // X-Requested-With header + // For cross-domain requests, seeing as conditions for a preflight are + // akin to a jigsaw puzzle, we simply never set it to be sure. + // (it can always be set on a per-request basis or even using ajaxSetup) + // For same-domain requests, won't change header if already provided. + if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) { + headers[ "X-Requested-With" ] = "XMLHttpRequest"; + } + + // Set headers + for ( i in headers ) { + xhr.setRequestHeader( i, headers[ i ] ); + } + + // Callback + callback = function( type ) { + return function() { + if ( callback ) { + callback = errorCallback = xhr.onload = + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; + + if ( type === "abort" ) { + xhr.abort(); + } else if ( type === "error" ) { + + // Support: IE <=9 only + // On a manual native abort, IE9 throws + // errors on any property access that is not readyState + if ( typeof xhr.status !== "number" ) { + complete( 0, "error" ); + } else { + complete( + + // File: protocol always yields status 0; see #8605, #14207 + xhr.status, + xhr.statusText + ); + } + } else { + complete( + xhrSuccessStatus[ xhr.status ] || xhr.status, + xhr.statusText, + + // Support: IE <=9 only + // IE9 has no XHR2 but throws on binary (trac-11426) + // For XHR2 non-text, let the caller handle it (gh-2498) + ( xhr.responseType || "text" ) !== "text" || + typeof xhr.responseText !== "string" ? + { binary: xhr.response } : + { text: xhr.responseText }, + xhr.getAllResponseHeaders() + ); + } + } + }; + }; + + // Listen to events + xhr.onload = callback(); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); + + // Support: IE 9 only + // Use onreadystatechange to replace onabort + // to handle uncaught aborts + if ( xhr.onabort !== undefined ) { + xhr.onabort = errorCallback; + } else { + xhr.onreadystatechange = function() { + + // Check readyState before timeout as it changes + if ( xhr.readyState === 4 ) { + + // Allow onerror to be called first, + // but that will not handle a native abort + // Also, save errorCallback to a variable + // as xhr.onerror cannot be accessed + window.setTimeout( function() { + if ( callback ) { + errorCallback(); + } + } ); + } + }; + } + + // Create the abort callback + callback = callback( "abort" ); + + try { + + // Do send the request (this may raise an exception) + xhr.send( options.hasContent && options.data || null ); + } catch ( e ) { + + // #14683: Only rethrow if this hasn't been notified as an error yet + if ( callback ) { + throw e; + } + } + }, + + abort: function() { + if ( callback ) { + callback(); + } + } + }; + } +} ); + + + + +// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432) +jQuery.ajaxPrefilter( function( s ) { + if ( s.crossDomain ) { + s.contents.script = false; + } +} ); + +// Install script dataType +jQuery.ajaxSetup( { + accepts: { + script: "text/javascript, application/javascript, " + + "application/ecmascript, application/x-ecmascript" + }, + contents: { + script: /\b(?:java|ecma)script\b/ + }, + converters: { + "text script": function( text ) { + jQuery.globalEval( text ); + return text; + } + } +} ); + +// Handle cache's special case and crossDomain +jQuery.ajaxPrefilter( "script", function( s ) { + if ( s.cache === undefined ) { + s.cache = false; + } + if ( s.crossDomain ) { + s.type = "GET"; + } +} ); + +// Bind script tag hack transport +jQuery.ajaxTransport( "script", function( s ) { + + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { + var script, callback; + return { + send: function( _, complete ) { + script = jQuery( " - - - - + + + + + + + - - -
+ +
-
+

API Reference

-

A python library wrapping the Cap’n Proto C++ library

+

A python library wrapping the Cap’n Proto C++ library

Example Usage:

-
import capnp
+
import capnp
 
-addressbook = capnp.load('addressbook.capnp')
+addressbook = capnp.load('addressbook.capnp')
 
-# Building
+# Building
 addresses = addressbook.AddressBook.newMessage()
-people = addresses.init('people', 1)
+people = addresses.init('people', 1)
 
 alice = people[0]
 alice.id = 123
-alice.name = 'Alice'
-alice.email = 'alice@example.com'
-alicePhone = alice.init('phones', 1)[0]
-alicePhone.type = 'mobile'
+alice.name = 'Alice'
+alice.email = 'alice@example.com'
+alicePhone = alice.init('phones', 1)[0]
+alicePhone.type = 'mobile'
 
-f = open('example.bin', 'w')
+f = open('example.bin', 'w')
 addresses.write(f)
 f.close()
 
-# Reading
-f = open('example.bin')
+# Reading
+f = open('example.bin')
 
 addresses = addressbook.AddressBook.read(f)
 
 for person in addresses.people:
-    print(person.name, ':', person.email)
+    print(person.name, ':', person.email)
     for phone in person.phones:
-        print(phone.type, ':', phone.number)
+        print(phone.type, ':', phone.number)
 

 

-

-
Internal Classes

-
These classes are internal to the library. You will never need to allocate
-one yourself, but you may end up using some of their member methods.

-

-
Modules

-
These are classes that are made for you when you import a Cap’n Proto file:

-
import capnp
-import addressbook_capnp
+

+
Classes

+

+
RPC

+

+
Promise

+

+

+capnp.Promise

+
alias of capnp.lib.capnp._Promise

+

 
-print type(addressbook_capnp.Person) # capnp.capnp._StructModule
-

-

-

-

-class capnp._StructModule(self, schema, name)

-

-

-from_bytes(self, buf, traversal_limit_in_words=None, nesting_limit=None, builder=False)

-
Returns a Reader for the unpacked object in buf.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • buf (buffer) – Any Python object that supports the buffer interface.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-
  • builder (bool) – If true, return a builder object. This will allow you to change the contents of buf, so do this with care.
    • 
+
    Promise may be one of:
    
+
-
Return type:
_DynamicStructReader or _DynamicStructBuilder

-

-

-
-

-

-from_bytes_packed(self, buf, traversal_limit_in_words=None, nesting_limit=None)

-
Returns a Reader for the packed object in buf.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • buf (buffer) – Any Python object that supports the readable buffer interface.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
_DynamicStructReader

-

-

-
-

-

-from_dict(self, kwargs)

-

-
Warning

-
This method is deprecated and will be removed in the 0.5 release. Use the new_message() function instead with **kwargs

-

-

-
-

-

-from_object(self, obj)

-

-
Warning

-
This method is deprecated and will be removed in the 0.5 release. Use the _DynamicStructReader.as_builder() or _DynamicStructBuilder.copy() functions instead

-

-

-
-

-

-new_message(self, num_first_segment_words=None, **kwargs)

-
Returns a newly allocated builder message.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)
    • 
-
  • kwargs (dict) – A list of fields and their values to initialize in the struct. Note, this is not an actual argument, but refers to Python’s ability to pass keyword arguments. ie. new_message(my_field=100)
    • 
-

-
Return type:
_DynamicStructBuilder

-

-

-
-

-

-read(self, file, traversal_limit_in_words=None, nesting_limit=None)

-
Returns a Reader for the unpacked object read from file.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
_DynamicStructReader

-

-

-
-

-

-read_multiple(self, file, traversal_limit_in_words=None, nesting_limit=None)

-
Returns an iterable, that when traversed will return Readers for messages.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
Iterable with elements of _DynamicStructReader

-

-

-
-

-

-read_multiple_bytes(self, buf, traversal_limit_in_words=None, nesting_limit=None)

-
Returns an iterable, that when traversed will return Readers for messages.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • buf (buffer) – Any Python object that supports the buffer interface.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
Iterable with elements of _DynamicStructReader

-

-

-
-

-

-read_multiple_bytes_packed(self, buf, traversal_limit_in_words=None, nesting_limit=None)

-
Returns an iterable, that when traversed will return Readers for messages.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • buf (buffer) – Any Python object that supports the buffer interface.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
Iterable with elements of _DynamicStructReader

-

-

-
-

-

-read_multiple_packed(self, file, traversal_limit_in_words=None, nesting_limit=None)

-
Returns an iterable, that when traversed will return Readers for messages.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
Iterable with elements of _DynamicStructReader

-

-

-
-

-

-read_packed(self, file, traversal_limit_in_words=None, nesting_limit=None)

-
Returns a Reader for the packed object read from file.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
-
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
-
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
-

-
Return type:
_DynamicStructReader

-

-

-
-

-
-

-

-class capnp._InterfaceModule(self, schema, name)

+

+

+class capnp.lib.capnp._Promise(obj=None)

+

+

+attach(self, *args)

 

 
-

-

-
Readers

-

-

-class capnp._DynamicStructReader

-
Reads Cap’n Proto structs

-
This class is almost a 1 for 1 wrapping of the Cap’n Proto C++ DynamicStruct::Reader. The only difference is that instead of a get method, __getattr__ is overloaded and the field name is passed onto the C++ equivalent get. This means you just use . syntax to access any field. For field names that don’t follow valid python naming convention for fields, use the global function getattr():

-
person = addressbook.Person.read(file) # This returns a _DynamicStructReader
-print person.name # using . syntax
-print getattr(person, 'field-with-hyphens') # for names that are invalid for python, use getattr
-

-

-

-

-as_builder(self, num_first_segment_words=None)

-
A method for casting this Reader to a Builder

-
This is a copying operation with respect to the message’s buffer. Changes in the new builder will not reflect in the original reader.

-
---
-
-
-
-
-
-



Parameters:num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)
Return type:_DynamicStructBuilder

+

+

+cancel(self, numParents=1)

+

+
+

+

+is_consumed

+
is_consumed: ‘bool’

 

 
-

-

-is_root

-
is_root: ‘bool’

+

+

+then(self, func, error_func=None)

+

+
+

+

+wait(self)

+

+
 

 
-

-

-schema

+

+

+class capnp.lib.capnp._RemotePromise

+

+

+a_wait(self)

+
Asyncio version of wait().
+Required when using asyncio for socket communication.

+
Will still work with non-asyncio socket communication, but requires async handling of the function call.

+

+
+

+

+as_pypromise(self)

+

+
+

+

+cancel(self, numParents=1)

+

+
+

+

+is_consumed

+
is_consumed: ‘bool’

+

+
+

+

+schema

 
A property that returns the _StructSchema object matching this reader

 

 
-

-

-to_dict(self, verbose=False, ordered=False)

+

+

+then(self, func, error_func=None)

+
Promise pipelining, use to queue up operations on a promise before executing the promise.

+

+
+

+

+to_dict(self, verbose=False, ordered=False)

 

 
-

-

-total_size

+

+

+wait(self)

+
Wait on the promise. This will block until the promise has completed.

+

+
+

+
+

+

+class capnp.lib.capnp._VoidPromise

+

+

+as_pypromise(self)

 

 
-

-

-which

-
Returns the enum corresponding to the union in this struct

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



Return type:_DynamicEnumField
Returns:A string/enum corresponding to what field is set in the union
Raises:KjException if this struct doesn’t contain a union

+

+

+attach(self, *args)

+

+
+

+

+cancel(self, numParents=1)

+

+
+

+

+is_consumed

+
is_consumed: ‘bool’

+

+
+

+

+then(self, func, error_func=None)

+

+
+

+

+wait(self)

+

+
+

+
+

+

+class capnp.PromiseFulfillerPair

+

+

+fulfill(self)

+

+
+

+

+is_consumed

+
is_consumed: ‘bool’

+

+
+

+

+promise

+
promise: capnp.lib.capnp._VoidPromise

 

 
 

 
-

-

-class capnp._DynamicListReader

-
Class for reading Cap’n Proto Lists

-
This class thinly wraps the C++ Cap’n Proto DynamicList::Reader class. __getitem__ and __len__ have been defined properly, so you can treat this class mostly like any other iterable class:

-
...
-person = addressbook.Person.read(file)
-
-phones = person.phones # This returns a _DynamicListReader
-
-phone = phones[0]
-print phone.number
-
-for phone in phones:
-    print phone.number
-

 

-

-
-

-

-
Builders

-

-

-class capnp._DynamicStructBuilder

-
Builds Cap’n Proto structs

-
This class is almost a 1 for 1 wrapping of the Cap’n Proto C++ DynamicStruct::Builder. The only difference is that instead of a get/set method, __getattr__/__setattr__ is overloaded and the field name is passed onto the C++ equivalent function. This means you just use . syntax to access or set any field. For field names that don’t follow valid python naming convention for fields, use the global functions getattr()/setattr():

-
person = addressbook.Person.new_message() # This returns a _DynamicStructBuilder
-
-person.name = 'foo' # using . syntax
-print person.name # using . syntax
-
-setattr(person, 'field-with-hyphens', 'foo') # for names that are invalid for python, use setattr
-print getattr(person, 'field-with-hyphens') # for names that are invalid for python, use getattr
-

-

-

-

-adopt(self, field, _DynamicOrphan orphan)

-
A method for adopting Cap’n Proto orphans

-
Don’t use this method unless you know what you’re doing. Orphans are useful for dynamically allocating objects for an unknown sized list.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • field (str) – The field name in the struct
    • 
-
  • orphan (_DynamicOrphan) – A Cap’n proto orphan to adopt. It will be unusable after this operation.
    • 
+
    
+
    Communication
    
+
    
+
    
+class capnp.TwoPartyClient(socket=None, traversal_limit_in_words=None, nesting_limit=None)
    
+
    TwoPartyClient for RPC Communication
    
+
    Can be initialized using a socket wrapper (libcapnp) or using asyncio controlled sockets.
    
+
    
+
    Parameters
    
+
      
+
    • socket – Can be a string defining a socket (e.g. localhost:12345) or a file descriptor for a socket.
+Passes socket directly to libcapnp. Do not use with asyncio.
      • 
+
    • traversal_limit_in_words – Pointer derefence limit (see https://capnproto.org/cxx.html).
      • 
+
    • nesting_limit – Recursive limit when reading types (see https://capnproto.org/cxx.html).
      • 
 
    
-
Return type:
void

-

-

-
-

-

-as_reader(self)

-
A method for casting this Builder to a Reader

-
This is a non-copying operation with respect to the message’s buffer. This means changes to the fields in the original struct will carry over to the new reader.

-
---
-
-
-
-



Return type:_DynamicStructReader

-

-
-

-

-copy(self, num_first_segment_words=None)

-
A method for copying this Builder

-
This is a copying operation with respect to the message’s buffer. Changes in the new builder will not reflect in the original reader.

-
---
-
-
-
-
-
-



Parameters:num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)
Return type:_DynamicStructBuilder

-

-
-

-

-disown(self, field)

-
A method for disowning Cap’n Proto orphans

-
Don’t use this method unless you know what you’re doing.

-
---
-
-
-
-
-
-



Parameters:field (str) – The field name in the struct
Return type:_DynamicOrphan

-

-
-

-

-from_dict(self, dict d)

+

+

+

+

+bootstrap(self)

 

 
-

-

-init(self, field, size=None)

-
Method for initializing fields that are of type union/struct/list

-
Typically, you don’t have to worry about initializing structs/unions, so this method is mainly for lists.

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



Parameters:
    
-
  • field (str) – The field name to initialize
    • 
-
  • size (int) – The size of the list to initiialize. This should be None for struct/union initialization.
    • 
+
    
+
    
+on_disconnect(self)
    
+
    
+
+
    
+
    
+read(self, bufsize)
    
+
    libcapnp reader (asyncio sockets only)
    
+
    
+
    Parameters
    
+
    bufsize – Buffer size to read from the libcapnp library
    
+
    
+
    
+
    
+
+
    
+
    
+write(self, data)
    
+
    libcapnp writer (asyncio sockets only)
    
+
    
+
    Parameters
    
+
    data – Buffer to write to the libcapnp library
    
+
    
+
    
+
    
+
+
+
+
    
+
    
+class capnp.TwoPartyServer(socket=None, bootstrap=None, traversal_limit_in_words=None, nesting_limit=None)
    
+
    TwoPartyServer for RPC Communication
    
+
    Can be initialized using a socket wrapper (libcapnp) or using asyncio controlled sockets.
    
+
    
+
    Parameters
    
+
      
+
    • socket – Can be a string defining a socket (e.g. localhost:12345, also supports *:12345)
+or a file descriptor for a socket.
+Passes socket directly to libcapnp. Do not use with asyncio.
      • 
+
    • bootstrap – Class object defining the implementation of the Cap’n’proto interface.
      • 
+
    • traversal_limit_in_words – Pointer derefence limit (see https://capnproto.org/cxx.html).
      • 
+
    • nesting_limit – Recursive limit when reading types (see https://capnproto.org/cxx.html).
      • 
 
    
-
Return type:
_DynamicStructBuilder or _DynamicListBuilder

-
Raises:
KjException if the field isn’t in this struct

-

-

-
-

-

-init_resizable_list(self, field)

-
Method for initializing fields that are of type list (of structs)

-
This version of init returns a _DynamicResizableListBuilder that allows you to add members one at a time (ie. if you don’t know the size for sure). This is only meant for lists of Cap’n Proto objects, since for primitive types you can just define a normal python list and fill it yourself.

-

-
Warning

-
You need to call _DynamicResizableListBuilder.finish() on the list object before serializing the Cap’n Proto message. Failure to do so will cause your objects not to be written out as well as leaking orphan structs into your message.

-

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



Parameters:field (str) – The field name to initialize
Return type:_DynamicResizableListBuilder
Raises:KjException if the field isn’t in this struct

-

-
-

-

-is_root

-
is_root: ‘bool’

-

-
-

-

-schema

-
A property that returns the _StructSchema object matching this writer

-

-
-

-

-to_bytes(self)

-
Returns the struct’s containing message as a Python bytes object in the unpacked binary format.

-
This is inefficient; it makes several copies.

-
---
-
-
-
-
-
-



Return type:bytes
Raises:KjException if this isn’t the message’s root struct.

-

-
-

-

-to_bytes_packed(self)

+
+

+

+

+bootstrap(self)

 

 
-

-

-to_dict(self, verbose=False, ordered=False)

+

+

+on_disconnect(self)

 

 
-

-

-total_size

+

+

+poll_forever(self)

+
Poll libcapnp library forever (asyncio)

+

+
+

+

+poll_once(self)

+
Poll libcapnp library one cycle.

+

+
+

+

+port

 

 
-

-

-which

-
Returns the enum corresponding to the union in this struct

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



Return type:_DynamicEnumField
Returns:A string/enum corresponding to what field is set in the union
Raises:KjException if this struct doesn’t contain a union

+

+

+port_promise

+
port_promise: object

 

 
-

-

-write(self, file)

-
Writes the struct’s containing message to the given file object in unpacked binary format.

-
This is a shortcut for calling capnp._write_message_to_fd().  This can only be called on the
-message’s root struct.

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



Parameters:file (file) – A file or socket object (or anything with a fileno() method), open for write.
Return type:void
Raises:KjException if this isn’t the message’s root struct.

+

+

+read(self, bufsize)

+
libcapnp reader (asyncio sockets only)

+

+
Parameters

+
bufsize – Buffer size to read from the libcapnp library

+

+

 

 
-

-

-write_packed(self, file)

-
Writes the struct’s containing message to the given file object in packed binary format.

-
This is a shortcut for calling capnp._write_packed_message_to_fd().  This can only be called on
-the message’s root struct.

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



Parameters:file (file) – A file or socket object (or anything with a fileno() method), open for write.
Return type:void
Raises:KjException if this isn’t the message’s root struct.

-

-
-

-
-

-

-class capnp._DynamicListBuilder

-
Class for building Cap’n Proto Lists

-
This class thinly wraps the C++ Cap’n Proto DynamicList::Bulder class. __getitem__, __setitem__, and __len__ have been defined properly, so you can treat this class mostly like any other iterable class:

-
...
-person = addressbook.Person.new_message()
-
-phones = person.init('phones', 2) # This returns a _DynamicListBuilder
-
-phone = phones[0]
-phone.number = 'foo'
-phone = phones[1]
-phone.number = 'bar'
-
-for phone in phones:
-    print phone.number
-

-

-

-

-adopt(self, index, _DynamicOrphan orphan)

-
A method for adopting Cap’n Proto orphans

-
Don’t use this method unless you know what you’re doing. Orphans are useful for dynamically allocating objects for an unknown sized list.

-
---
-
-
-
-
-
-



Parameters:
    
-
  • index (int) – The index of the element in the list to replace with the newly adopted object
    • 
-
  • orphan (_DynamicOrphan) – A Cap’n proto orphan to adopt. It will be unusable after this operation.
    • 
-

-
Return type:
void

-

-

-
-

-

-disown(self, index)

-
A method for disowning Cap’n Proto orphans

-
Don’t use this method unless you know what you’re doing.

-
---
-
-
-
-
-
-



Parameters:index (int) – The index of the element in the list to disown
Return type:_DynamicOrphan

-

-
-

-
-

-

-class capnp._DynamicResizableListBuilder

-
_DynamicResizableListBuilder(parent, field, schema)
-Class for building growable Cap’n Proto Lists

-

-

-
Warning

-
You need to call finish() on this object before serializing the Cap’n Proto message. Failure to do so will cause your objects not to be written out as well as leaking orphan structs into your message.

-

-
This class works much like _DynamicListBuilder, but it allows growing the list dynamically. It is meant for lists of structs, since for primitive types like int or float, you’re much better off using a normal python list and then serializing straight to a Cap’n Proto list. It has __getitem__ and __len__ defined, but not __setitem__:

-
...
-person = addressbook.Person.new_message()
-
-phones = person.init_resizable_list('phones') # This returns a _DynamicResizableListBuilder
-
-phone = phones.add()
-phone.number = 'foo'
-phone = phones.add()
-phone.number = 'bar'
-
-people.finish()
-
-f = open('example', 'w')
-person.write(f)
-

-

-

-

-

-add(self)

-
A method for adding a new struct to the list

-
This will return a struct, in which you can set fields that will be reflected in the serialized Cap’n Proto message.

-
---
-
-
-
-



Return type:_DynamicStructBuilder

-

-
-

-

-finish(self)

-
A method for closing this list and serializing all its members to the message

-
If you don’t call this method, the items you previously added from this object will leak into the message, ie. inaccessible but still taking up space.

-

-
-

-
-

-

-
RPC

-

-

-class capnp._DynamicCapabilityClient

-

-

-cast_as(self, schema)

+

+

+run_forever(self)

 

 
-

-

-schema

+

+

+write(self, data)

+
libcapnp writer (asyncio sockets only)

+

+
Parameters

+
data – Buffer to write to the libcapnp library

+

+

+

+
+

+
+

+

+
Capability

+

+

+class capnp.lib.capnp._DynamicCapabilityClient

+

+

+cast_as(self, schema)

+

+
+

+

+schema

 
A property that returns the _InterfaceSchema object matching this client

 

 
-

-

-upcast(self, schema)

-

-
-

-
-

-

-class capnp._CapabilityClient

-

-

-cast_as(self, schema)

+

+

+upcast(self, schema)

 

 
 

 
+

+

+
Response

+

+

+class capnp.lib.capnp._Response

+

+

+as_builder(self, num_first_segment_words=None)

+
A method for casting this Reader to a Builder

+
This is a copying operation with respect to the message’s buffer. Changes in the new builder will not reflect in the original reader.

+

+
Parameters

+
num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)

+

+
Return type

+
_DynamicStructBuilder

+

+

+

+
+

+

+is_root

+
is_root: ‘bool’

+

+
+

+

+schema

+
A property that returns the _StructSchema object matching this reader

+

+
+

+

+to_dict(self, verbose=False, ordered=False)

+

+
+

+

+total_size

+

+
+

+

+which

+
Returns the enum corresponding to the union in this struct

+

+
Return type

+
_DynamicEnumField

+

+
Returns

+
A string/enum corresponding to what field is set in the union

+

+
Raises

+
KjException if this struct doesn’t contain a union

+

+

+

+
+

+
+

 

 

 
Miscellaneous

-

-

-class capnp._DynamicOrphan

-

-

-get(self)

-
Returns a python object corresponding to the DynamicValue owned by this orphan

-
Use this DynamicValue to set fields inside the orphan

-

-
-

-
-

+

 

-class capnp.KjException(self, message=None, nature=None, durability=None, wrapper=None)

+class capnp.KjException(message=None, nature=None, durability=None, wrapper=None, type=None)
 
KjException is a wrapper of the internal C++ exception type. There is an enum named Type listed below, and a bunch of fields

-

+

 

-class Type

-

+class Type
+

 

-DISCONNECTED = 'DISCONNECTED'

+DISCONNECTED = 'DISCONNECTED'
 

 
-

+

 

-FAILED = 'FAILED'

+FAILED = 'FAILED'
 

 
-

+

 

-OTHER = 'OTHER'

+OTHER = 'OTHER'
 

 
-

+

 

-OVERLOADED = 'OVERLOADED'

+OVERLOADED = 'OVERLOADED'
 

 
-

+

 

-UNIMPLEMENTED = 'UNIMPLEMENTED'

+UNIMPLEMENTED = 'UNIMPLEMENTED'
 

 
-

+

 

-reverse_mapping = {'FAILED': 'FAILED', 'UNIMPLEMENTED': 'UNIMPLEMENTED', 'OVERLOADED': 'OVERLOADED', 'DISCONNECTED': 'DISCONNECTED', 'OTHER': 'OTHER'}

+reverse_mapping = {'DISCONNECTED': 'DISCONNECTED', 'FAILED': 'FAILED', 'OTHER': 'OTHER', 'OVERLOADED': 'OVERLOADED', 'UNIMPLEMENTED': 'UNIMPLEMENTED'}
 

 
 

 
-

+

 

-KjException.args

+args
 

 
-

+

 

-KjException.description

-
KjException.description(self)

-

-
-

-

-KjException.file

-
KjException.file(self)

-

-
-

-

-KjException.line

-
KjException.line(self)

-

-
-

-

-KjException.message

+property description
 

 
-

+

+

+property file

+

+
+

+

+property line

+

+
+

 

-KjException.type

-
KjException.type(self)

+property type
+

+
+

+

+with_traceback()

+
Exception.with_traceback(tb) –
+set self.__traceback__ to tb and return self.

+

+
+

+
+

+

+class capnp.SchemaParser

+
A class for loading Cap’n Proto schema files.

+
Do not use this class unless you’re sure you know what you’re doing. Use the convenience method load() instead.

+

+

+load(self, file_name, display_name=None, imports=[])

+
Load a Cap’n Proto schema from a file

+
You will have to load a schema before you can begin doing anything
+meaningful with this library. Loading a schema is much like loading
+a Python module (and load even returns a ModuleType). Once it’s been
+loaded, you use it much like any other Module:

+
parser = capnp.SchemaParser()
+addressbook = parser.load('addressbook.capnp')
+print addressbook.qux # qux is a top level constant
+# 123
+person = addressbook.Person.new_message()
+

+

+

+
Parameters

+
    
+
  • file_name (str) – A relative or absolute path to a Cap’n Proto schema
    • 
+
  • display_name (str) – The name internally used by the Cap’n Proto library
+for the loaded schema. By default, it’s just os.path.basename(file_name)
    • 
+
  • imports (list) – A list of str directories to add to the import path.
    • 
+

+

+
Return type

+
ModuleType

+

+
Returns

+
A module corresponding to the loaded schema. You can access
+parsed schemas and constants with . syntax

+

+
Raises

+
    
+
  • exceptions.IOError if file_name doesn’t exist
    • 
+
  • KjException if the Cap’n Proto C++ library has any problems loading the schema
    • 
+

+

+

+

+
+

+

+modules_by_id

+
modules_by_id: dict

 

 
 

@@ -897,248 +584,1052 @@ Class for building growable Cap’n Proto Lists

 

 

 
Functions

-

-

-capnp.load(file_name, display_name=None, imports=[])

-
Load a Cap’n Proto schema from a file

-
You will have to load a schema before you can begin doing anything
-meaningful with this library. Loading a schema is much like loading
-a Python module (and load even returns a ModuleType). Once it’s been
-loaded, you use it much like any other Module:

-
addressbook = capnp.load('addressbook.capnp')
-print addressbook.qux # qux is a top level constant in the addressbook.capnp schema
-# 123
-person = addressbook.Person.new_message()
-

-

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



Parameters:
    
-
  • file_name (str) – A relative or absolute path to a Cap’n Proto schema
    • 
-
  • display_name (str) – The name internally used by the Cap’n Proto library
-for the loaded schema. By default, it’s just os.path.basename(file_name)
    • 
-
  • imports (list) – A list of str directories to add to the import path.
    • 
-

-
Return type:
ModuleType

-
Returns:
A module corresponding to the loaded schema. You can access
-parsed schemas and constants with . syntax

-
Raises:
KjException if file_name doesn’t exist

-

-

-
-

+

 

-capnp.add_import_hook(additional_paths=[])

-
Add a hook to the python import system, so that Cap’n Proto modules are directly importable

+capnp.add_import_hook(additional_paths=[])
+
Add a hook to the python import system, so that Cap’n Proto modules are directly importable

 
After calling this function, you can use the python import syntax to directly import capnproto schemas. This function is automatically called upon first import of capnp, so you will typically never need to use this function.:

-
import capnp
+
import capnp
 capnp.add_import_hook()
 
 import addressbook_capnp
-# equivalent to capnp.load('addressbook.capnp', 'addressbook', sys.path), except it will search for 'addressbook.capnp' in all directories of sys.path
+# equivalent to capnp.load('addressbook.capnp', 'addressbook', sys.path), except it will search for 'addressbook.capnp' in all directories of sys.path
 

 

-
---
-
-
-
-



Parameters:additional_paths (list) – Additional paths, listed as strings, to be used to search for the .capnp files. It is prepended to the beginning of sys.path. It also affects imports inside of Cap’n Proto schemas.

+

+
Parameters

+
additional_paths (list) – Additional paths, listed as strings, to be used to search for the .capnp files. It is prepended to the beginning of sys.path. It also affects imports inside of Cap’n Proto schemas.

+

+

 

 
-

-

-capnp.remove_import_hook()

-
Remove the import hook, and return python’s import to normal

+

+

+capnp.cleanup_global_schema_parser()

+
Unloads all of the schema from the current context

 

 
-

+

+

+capnp.create_event_loop(threaded=True)

+
Create a new global event loop. This will not remove the previous
+EventLoop for you, so make sure to do that first

+

+
+

+

+capnp.getTimer()

+
Get libcapnp event loop timer

+

+
+

 

-capnp.join_promises(promises)

+capnp.join_promises(promises)
 

 
-

-

-
Classes

-

-
RPC

-

-

-class capnp.TwoPartyClient

-
TwoPartyClient(socket, restorer=None)

-

-

-bootstrap(self)

-

-
-

-

-ez_restore(self, textId)

-

-
-

-

-on_disconnect(self)

-

-
-

-

-restore(self, objectId)

-

-
-

-
-

-

-class capnp.TwoPartyServer

-
TwoPartyServer(socket, restorer=None, server_socket=None, bootstrap=None)

-

-

-on_disconnect(self)

-

-
-

-

-port

-

-
-

-

-port_promise

-
port_promise: object

-

-
-

-

-run_forever(self)

-

-
-

-
-

-

-class capnp.Promise

-
Promise(obj=None)

-

-

-attach(self, *args)

-

-
-

-

-cancel(self, numParents=1)

-

-
-

-

-is_consumed

-
is_consumed: ‘bool’

-

-
-

-

-then(self, func, error_func=None)

-

-
-

-

-wait(self)

-

-
-

-
-

-

-class capnp.PromiseFulfillerPair

-
PromiseFulfillerPair()

-

-

-fulfill(self)

-

-
-

-

-is_consumed

-
is_consumed: ‘bool’

-

-
-

-

-promise

-
promise: capnp.lib.capnp._VoidPromise

-

-
-

-
-

-

-
Miscellaneous

-

-

-class capnp.SchemaParser

-
A class for loading Cap’n Proto schema files.

-
Do not use this class unless you’re sure you know what you’re doing. Use the convenience method load() instead.

-

-

-load(self, file_name, display_name=None, imports=[])

-
Load a Cap’n Proto schema from a file

+

+

+capnp.load(file_name, display_name=None, imports=[])

+
Load a Cap’n Proto schema from a file

 
You will have to load a schema before you can begin doing anything
 meaningful with this library. Loading a schema is much like loading
-a Python module (and load even returns a ModuleType). Once it’s been
+a Python module (and load even returns a ModuleType). Once it’s been
 loaded, you use it much like any other Module:

-
parser = capnp.SchemaParser()
-addressbook = parser.load('addressbook.capnp')
-print addressbook.qux # qux is a top level constant
-# 123
+
addressbook = capnp.load('addressbook.capnp')
+print addressbook.qux # qux is a top level constant in the addressbook.capnp schema
+# 123
 person = addressbook.Person.new_message()
 

 

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



Parameters:
    
-
  • file_name (str) – A relative or absolute path to a Cap’n Proto schema
    • 
-
  • display_name (str) – The name internally used by the Cap’n Proto library
-for the loaded schema. By default, it’s just os.path.basename(file_name)
    • 
-
  • imports (list) – A list of str directories to add to the import path.
    • 
+
    
+
    Parameters
    
+
      
+
    • file_name (str) – A relative or absolute path to a Cap’n Proto schema
      • 
+
    • display_name (str) – The name internally used by the Cap’n Proto library
+for the loaded schema. By default, it’s just os.path.basename(file_name)
      • 
+
    • imports (list) – A list of str directories to add to the import path.
      • 
 
    
-
Return type:
ModuleType

-
Returns:
A module corresponding to the loaded schema. You can access
+
+
Return type

+
ModuleType

+

+
Returns

+
A module corresponding to the loaded schema. You can access
 parsed schemas and constants with . syntax

-
Raises:
    
-
  • exceptions.IOError if file_name doesn’t exist
    • 
-
  • KjException if the Cap’n Proto C++ library has any problems loading the schema
    • 
+
+
    Raises
    
+
    KjException if file_name doesn’t exist
    
+
    
+
+
+
+
    
+
    
+capnp.poll_once()
    
+
    Poll libcapnp event loop once
    
+
    
+
+
    
+
    
+capnp.remove_event_loop(ignore_errors=False)
    
+
    Remove the global event loop
    
+
    
+
+
    
+
    
+capnp.remove_import_hook()
    
+
    Remove the import hook, and return python’s import to normal
    
+
    
+
+
    
+
    
+capnp.reset_event_loop(ignore_errors=False, threaded=True)
    
+
    Removes event loop, then creates a new one. See remove_event_loop and create_event_loop for more details.
    
+
    
+
+
    
+
    
+capnp.wait_forever()
    
+
    Use libcapnp event loop to poll/wait forever
    
+
    
+
+
+
    
+
    Internal Classes
    
+
    These classes are internal to the library. You will never need to allocate
+one yourself, but you may end up using some of their member methods.
    
+
    
+
    Modules
    
+
    These are classes that are made for you when you import a Cap’n Proto file:
    
+
    import capnp
+import addressbook_capnp
+
+print type(addressbook_capnp.Person) # capnp.capnp._StructModule
+
    
+
    
+
    
+
    
+class capnp._InterfaceModule(schema, name)
    
+
    
+
+
    
+
    
+class capnp._StructModule(schema, name)
    
+
    
+
    
+from_bytes(self, buf, traversal_limit_in_words=None, nesting_limit=None, builder=False)
    
+
    Returns a Reader for the unpacked object in buf.
    
+
    
+
    Parameters
    
+
      
+
    • buf (buffer) – Any Python object that supports the buffer interface.
      • 
+
    • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
      • 
+
    • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
      • 
+
    • builder (bool) – If true, return a builder object. This will allow you to change the contents of buf, so do this with care.
      • 
 
    
-

+

+
Return type

+
_DynamicStructReader or _DynamicStructBuilder

+

+

 

 
-

-

-modules_by_id

-
modules_by_id: dict

+

+

+from_bytes_packed(self, buf, traversal_limit_in_words=None, nesting_limit=None)

+
Returns a Reader for the packed object in buf.

+

+
Parameters

+
    
+
  • buf (buffer) – Any Python object that supports the readable buffer interface.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+

+

+
Return type

+
_DynamicStructReader

+

+

+

+
+

+

+from_segments(self, segments, traversal_limit_in_words=None, nesting_limit=None)

+
Returns a Reader for a list of segment bytes.

+
This avoids making copies.

+
NB: This is not currently supported on PyPy.

+

+
Return type

+
list

+

+

+

+
+

+

+new_message(self, num_first_segment_words=None, **kwargs)

+
Returns a newly allocated builder message.

+

+
Parameters

+
    
+
  • num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)
    • 
+
  • kwargs (dict) – A list of fields and their values to initialize in the struct. Note, this is not an actual argument, but refers to Python’s ability to pass keyword arguments. ie. new_message(my_field=100)
    • 
+

+

+
Return type

+
_DynamicStructBuilder

+

+

+

+
+

+

+read(self, file, traversal_limit_in_words=None, nesting_limit=None)

+
Returns a Reader for the unpacked object read from file.

+

+
Parameters

+
    
+
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+

+

+
Return type

+
_DynamicStructReader

+

+

+

+
+

+

+read_multiple(self, file, traversal_limit_in_words=None, nesting_limit=None, skip_copy=False)

+
Returns an iterable, that when traversed will return Readers for messages.

+

+
Parameters

+
    
+
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+
  • skip_copy (bool) – By default, each message is copied because the file needs to advance, even if the message is never read completely. Skip this only if you know what you’re doing.
    • 
+

+

+
Return type

+
Iterable with elements of _DynamicStructReader

+

+

+

+
+

+

+read_multiple_bytes(self, buf, traversal_limit_in_words=None, nesting_limit=None)

+
Returns an iterable, that when traversed will return Readers for messages.

+

+
Parameters

+
    
+
  • buf (buffer) – Any Python object that supports the buffer interface.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+

+

+
Return type

+
Iterable with elements of _DynamicStructReader

+

+

+

+
+

+

+read_multiple_bytes_packed(self, buf, traversal_limit_in_words=None, nesting_limit=None)

+
Returns an iterable, that when traversed will return Readers for messages.

+

+
Parameters

+
    
+
  • buf (buffer) – Any Python object that supports the buffer interface.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+

+

+
Return type

+
Iterable with elements of _DynamicStructReader

+

+

+

+
+

+

+read_multiple_packed(self, file, traversal_limit_in_words=None, nesting_limit=None, skip_copy=False)

+
Returns an iterable, that when traversed will return Readers for messages.

+

+
Parameters

+
    
+
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+
  • skip_copy (bool) – By default, each message is copied because the file needs to advance, even if the message is never read completely. Skip this only if you know what you’re doing.
    • 
+

+

+
Return type

+
Iterable with elements of _DynamicStructReader

+

+

+

+
+

+

+read_packed(self, file, traversal_limit_in_words=None, nesting_limit=None)

+
Returns a Reader for the packed object read from file.

+

+
Parameters

+
    
+
  • file (file) – A python file-like object. It must be a “real” file, with a fileno() method.
    • 
+
  • traversal_limit_in_words (int) – Limits how many total words of data are allowed to be traversed. Is actually a uint64_t, and values can be up to 2^64-1. Default is 8*1024*1024.
    • 
+
  • nesting_limit (int) – Limits how many total words of data are allowed to be traversed. Default is 64.
    • 
+

+

+
Return type

+
_DynamicStructReader

+

+

+

+
+

+
+

+

+
Readers

+

+

+class capnp._DynamicListReader

+
Class for reading Cap’n Proto Lists

+
This class thinly wraps the C++ Cap’n Proto DynamicList::Reader class. __getitem__ and __len__ have been defined properly, so you can treat this class mostly like any other iterable class:

+
...
+person = addressbook.Person.read(file)
+
+phones = person.phones # This returns a _DynamicListReader
+
+phone = phones[0]
+print phone.number
+
+for phone in phones:
+    print phone.number
+

+

+

+
+

+

+class capnp._DynamicStructReader

+
Reads Cap’n Proto structs

+
This class is almost a 1 for 1 wrapping of the Cap’n Proto C++ DynamicStruct::Reader. The only difference is that instead of a get method, __getattr__ is overloaded and the field name is passed onto the C++ equivalent get. This means you just use . syntax to access any field. For field names that don’t follow valid python naming convention for fields, use the global function getattr():

+
person = addressbook.Person.read(file) # This returns a _DynamicStructReader
+print person.name # using . syntax
+print getattr(person, 'field-with-hyphens') # for names that are invalid for python, use getattr
+

+

+

+

+as_builder(self, num_first_segment_words=None)

+
A method for casting this Reader to a Builder

+
This is a copying operation with respect to the message’s buffer. Changes in the new builder will not reflect in the original reader.

+

+
Parameters

+
num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)

+

+
Return type

+
_DynamicStructBuilder

+

+

+

+
+

+

+is_root

+
is_root: ‘bool’

+

+
+

+

+schema

+
A property that returns the _StructSchema object matching this reader

+

+
+

+

+to_dict(self, verbose=False, ordered=False)

+

+
+

+

+total_size

+

+
+

+

+which

+
Returns the enum corresponding to the union in this struct

+

+
Return type

+
_DynamicEnumField

+

+
Returns

+
A string/enum corresponding to what field is set in the union

+

+
Raises

+
KjException if this struct doesn’t contain a union

+

+

+

+
+

+
+

+

+class capnp._PackedFdMessageReader(file, traversal_limit_in_words=None, nesting_limit=None)

+
Read a Cap’n Proto message from a file descriptor in a packed manner

+
You use this class to for reading message(s) from a file. It’s analagous to the inverse of _write_packed_message_to_fd() and _MessageBuilder, but in one class.:

+
f = open('out.txt')
+message = _PackedFdMessageReader(f)
+person = message.get_root(addressbook.Person)
+print person.name
+

+

+

+
Parameters

+
    
+
  • fd (int) - A file descriptor
    • 
+

+

+

+

+

+get_root(self, schema)

+
A method for instantiating Cap’n Proto structs

+
You will need to pass in a schema to specify which struct to
+instantiate. Schemas are available in a loaded Cap’n Proto module:

+
addressbook = capnp.load('addressbook.capnp')
+...
+person = message.get_root(addressbook.Person)
+

+

+

+
Parameters

+
schema (Schema) – A Cap’n proto schema specifying which struct to instantiate

+

+
Return type

+
_DynamicStructReader

+

+
Returns

+
An object with all the data of the read Cap’n Proto message.
+Access members with . syntax.

+

+

+

+
+

+

+get_root_as_any(self)

+
A method for getting a Cap’n Proto AnyPointer, from an already pre-written buffer

+
Don’t use this method unless you know what you’re doing.

+

+
Return type

+
_DynamicObjectReader

+

+
Returns

+
An AnyPointer that you can read from

+

+

+

+
+

+
+

+

+class capnp._StreamFdMessageReader(file, traversal_limit_in_words=None, nesting_limit=None)

+
Read a Cap’n Proto message from a file descriptor

+
You use this class to for reading message(s) from a file. It’s analagous to the inverse of _write_message_to_fd() and _MessageBuilder, but in one class:

+
f = open('out.txt')
+message = _StreamFdMessageReader(f)
+person = message.get_root(addressbook.Person)
+print person.name
+

+

+

+
Parameters

+
    
+
  • fd (int) - A file descriptor
    • 
+

+

+

+

+

+get_root(self, schema)

+
A method for instantiating Cap’n Proto structs

+
You will need to pass in a schema to specify which struct to
+instantiate. Schemas are available in a loaded Cap’n Proto module:

+
addressbook = capnp.load('addressbook.capnp')
+...
+person = message.get_root(addressbook.Person)
+

+

+

+
Parameters

+
schema (Schema) – A Cap’n proto schema specifying which struct to instantiate

+

+
Return type

+
_DynamicStructReader

+

+
Returns

+
An object with all the data of the read Cap’n Proto message.
+Access members with . syntax.

+

+

+

+
+

+

+get_root_as_any(self)

+
A method for getting a Cap’n Proto AnyPointer, from an already pre-written buffer

+
Don’t use this method unless you know what you’re doing.

+

+
Return type

+
_DynamicObjectReader

+

+
Returns

+
An AnyPointer that you can read from

+

+

+

+
+

+
+

+

+
Builders

+

+

+class capnp._DynamicResizableListBuilder(parent, field, schema)

+
Class for building growable Cap’n Proto Lists

+

+
Warning

+
You need to call finish() on this object before serializing the Cap’n Proto message. Failure to do so will cause your objects not to be written out as well as leaking orphan structs into your message.

+

+
This class works much like _DynamicListBuilder, but it allows growing the list dynamically. It is meant for lists of structs, since for primitive types like int or float, you’re much better off using a normal python list and then serializing straight to a Cap’n Proto list. It has __getitem__ and __len__ defined, but not __setitem__:

+
...
+person = addressbook.Person.new_message()
+
+phones = person.init_resizable_list('phones') # This returns a _DynamicResizableListBuilder
+
+phone = phones.add()
+phone.number = 'foo'
+phone = phones.add()
+phone.number = 'bar'
+
+people.finish()
+
+f = open('example', 'w')
+person.write(f)
+

+

+

+

+add(self)

+
A method for adding a new struct to the list

+
This will return a struct, in which you can set fields that will be reflected in the serialized Cap’n Proto message.

+

+
Return type

+
_DynamicStructBuilder

+

+

+

+
+

+

+finish(self)

+
A method for closing this list and serializing all its members to the message

+
If you don’t call this method, the items you previously added from this object will leak into the message, ie. inaccessible but still taking up space.

+

+
+

+
+

+

+class capnp._DynamicListBuilder

+
Class for building Cap’n Proto Lists

+
This class thinly wraps the C++ Cap’n Proto DynamicList::Bulder class. __getitem__, __setitem__, and __len__ have been defined properly, so you can treat this class mostly like any other iterable class:

+
...
+person = addressbook.Person.new_message()
+
+phones = person.init('phones', 2) # This returns a _DynamicListBuilder
+
+phone = phones[0]
+phone.number = 'foo'
+phone = phones[1]
+phone.number = 'bar'
+
+for phone in phones:
+    print phone.number
+

+

+

+

+adopt(self, index, _DynamicOrphan orphan)

+
A method for adopting Cap’n Proto orphans

+
Don’t use this method unless you know what you’re doing. Orphans are useful for dynamically allocating objects for an unknown sized list.

+

+
Parameters

+
    
+
  • index (int) – The index of the element in the list to replace with the newly adopted object
    • 
+
  • orphan (_DynamicOrphan) – A Cap’n proto orphan to adopt. It will be unusable after this operation.
    • 
+

+

+
Return type

+
void

+

+

+

+
+

+

+disown(self, index)

+
A method for disowning Cap’n Proto orphans

+
Don’t use this method unless you know what you’re doing.

+

+
Parameters

+
index (int) – The index of the element in the list to disown

+

+
Return type

+
_DynamicOrphan

+

+

+

+
+

+

+init(self, index, size)

+
A method for initializing an element in a list

+

+
Parameters

+
    
+
  • index (int) – The index of the element in the list
    • 
+
  • size (int) – Size of the element to be initialized.
    • 
+

+

+

+

+
+

+
+

+

+class capnp._DynamicStructBuilder

+
Builds Cap’n Proto structs

+
This class is almost a 1 for 1 wrapping of the Cap’n Proto C++ DynamicStruct::Builder. The only difference is that instead of a get/set method, __getattr__/__setattr__ is overloaded and the field name is passed onto the C++ equivalent function. This means you just use . syntax to access or set any field. For field names that don’t follow valid python naming convention for fields, use the global functions getattr()/setattr():

+
person = addressbook.Person.new_message() # This returns a _DynamicStructBuilder
+
+person.name = 'foo' # using . syntax
+print person.name # using . syntax
+
+setattr(person, 'field-with-hyphens', 'foo') # for names that are invalid for python, use setattr
+print getattr(person, 'field-with-hyphens') # for names that are invalid for python, use getattr
+

+

+

+

+adopt(self, field, _DynamicOrphan orphan)

+
A method for adopting Cap’n Proto orphans

+
Don’t use this method unless you know what you’re doing. Orphans are useful for dynamically allocating objects for an unknown sized list.

+

+
Parameters

+
    
+
  • field (str) – The field name in the struct
    • 
+
  • orphan (_DynamicOrphan) – A Cap’n proto orphan to adopt. It will be unusable after this operation.
    • 
+

+

+
Return type

+
void

+

+

+

+
+

+

+as_reader(self)

+
A method for casting this Builder to a Reader

+
This is a non-copying operation with respect to the message’s buffer. This means changes to the fields in the original struct will carry over to the new reader.

+

+
Return type

+
_DynamicStructReader

+

+

+

+
+

+

+clear_write_flag(self)

+
A method used to clear the _is_written flag.

+
This allows you to write the struct more than once without seeing any warnings.

+

+
+

+

+copy(self, num_first_segment_words=None)

+
A method for copying this Builder

+
This is a copying operation with respect to the message’s buffer. Changes in the new builder will not reflect in the original reader.

+

+
Parameters

+
num_first_segment_words (int) – Size of the first segment to allocate in the message (in words ie. 8 byte increments)

+

+
Return type

+
_DynamicStructBuilder

+

+

+

+
+

+

+disown(self, field)

+
A method for disowning Cap’n Proto orphans

+
Don’t use this method unless you know what you’re doing.

+

+
Parameters

+
field (str) – The field name in the struct

+

+
Return type

+
_DynamicOrphan

+

+

+

+
+

+

+from_dict(self, dict d)

+

+
+

+

+init(self, field, size=None)

+
Method for initializing fields that are of type union/struct/list

+
Typically, you don’t have to worry about initializing structs/unions, so this method is mainly for lists.

+

+
Parameters

+
    
+
  • field (str) – The field name to initialize
    • 
+
  • size (int) – The size of the list to initiialize. This should be None for struct/union initialization.
    • 
+

+

+
Return type

+
_DynamicStructBuilder or _DynamicListBuilder

+

+
Raises

+
KjException if the field isn’t in this struct

+

+

+

+
+

+

+init_resizable_list(self, field)

+
Method for initializing fields that are of type list (of structs)

+
This version of init returns a _DynamicResizableListBuilder that allows you to add members one at a time (ie. if you don’t know the size for sure). This is only meant for lists of Cap’n Proto objects, since for primitive types you can just define a normal python list and fill it yourself.

+

+
Warning

+
You need to call _DynamicResizableListBuilder.finish() on the list object before serializing the Cap’n Proto message. Failure to do so will cause your objects not to be written out as well as leaking orphan structs into your message.

+

+

+
Parameters

+
field (str) – The field name to initialize

+

+
Return type

+
_DynamicResizableListBuilder

+

+
Raises

+
KjException if the field isn’t in this struct

+

+

+

+
+

+

+is_root

+
is_root: ‘bool’

+

+
+

+

+schema

+
A property that returns the _StructSchema object matching this writer

+

+
+

+

+to_bytes(self)

+
Returns the struct’s containing message as a Python bytes object in the unpacked binary format.

+
This is inefficient; it makes several copies.

+

+
Return type

+
bytes

+

+
Raises

+
KjException if this isn’t the message’s root struct.

+

+

+

+
+

+

+to_bytes_packed(self)

+

+
+

+

+to_dict(self, verbose=False, ordered=False)

+

+
+

+

+to_segments(self)

+
Returns the struct’s containing message as a Python list of Python bytes objects.

+
This avoids making copies.

+
NB: This is not currently supported on PyPy.

+

+
Return type

+
list

+

+

+

+
+

+

+total_size

+

+
+

+

+which

+
Returns the enum corresponding to the union in this struct

+

+
Return type

+
_DynamicEnumField

+

+
Returns

+
A string/enum corresponding to what field is set in the union

+

+
Raises

+
KjException if this struct doesn’t contain a union

+

+

+

+
+

+

+write(self, file)

+
Writes the struct’s containing message to the given file object in unpacked binary format.

+
This is a shortcut for calling capnp._write_message_to_fd().  This can only be called on the
+message’s root struct.

+

+
Parameters

+
file (file) – A file or socket object (or anything with a fileno() method), open for write.

+

+
Return type

+
void

+

+
Raises

+
KjException if this isn’t the message’s root struct.

+

+

+

+
+

+

+write_packed(self, file)

+
Writes the struct’s containing message to the given file object in packed binary format.

+
This is a shortcut for calling capnp._write_packed_message_to_fd().  This can only be called on
+the message’s root struct.

+

+
Parameters

+
file (file) – A file or socket object (or anything with a fileno() method), open for write.

+

+
Return type

+
void

+

+
Raises

+
KjException if this isn’t the message’s root struct.

+

+

+

+
+

+
+

+

+class capnp._MallocMessageBuilder(size=None)

+
The main class for building Cap’n Proto messages

+
You will use this class to handle arena allocation of the Cap’n Proto
+messages. You also use this object when you’re done assigning to Cap’n
+Proto objects, and wish to serialize them:

+
addressbook = capnp.load('addressbook.capnp')
+message = capnp._MallocMessageBuilder()
+person = message.init_root(addressbook.Person)
+person.name = 'alice'
+...
+f = open('out.txt', 'w')
+_write_message_to_fd(f.fileno(), message)
+

+

+

+

+get_root(self, schema)

+
A method for instantiating Cap’n Proto structs, from an already pre-written buffer

+
Don’t use this method unless you know what you’re doing. You probably
+want to use init_root instead:

+
addressbook = capnp.load('addressbook.capnp')
+...
+person = message.init_root(addressbook.Person)
+...
+person = message.get_root(addressbook.Person)
+

+

+

+
Parameters

+
schema (Schema) – A Cap’n proto schema specifying which struct to instantiate

+

+
Return type

+
_DynamicStructBuilder

+

+
Returns

+
An object where you will set all the members

+

+

+

+
+

+

+get_root_as_any(self)

+
A method for getting a Cap’n Proto AnyPointer, from an already pre-written buffer

+
Don’t use this method unless you know what you’re doing.

+

+
Return type

+
_DynamicObjectBuilder

+

+
Returns

+
An AnyPointer that you can set fields in

+

+

+

+
+

+

+get_segments_for_output(self)

+

+
+

+

+init_root(self, schema)

+
A method for instantiating Cap’n Proto structs

+
You will need to pass in a schema to specify which struct to
+instantiate. Schemas are available in a loaded Cap’n Proto module:

+
addressbook = capnp.load('addressbook.capnp')
+...
+person = message.init_root(addressbook.Person)
+

+

+

+
Parameters

+
schema (Schema) – A Cap’n proto schema specifying which struct to instantiate

+

+
Return type

+
_DynamicStructBuilder

+

+
Returns

+
An object where you will set all the members

+

+

+

+
+

+

+new_orphan(self, schema)

+
A method for instantiating Cap’n Proto orphans

+
Don’t use this method unless you know what you’re doing. Orphans are useful for dynamically allocating objects for an unknown sized list, ie:

+
addressbook = capnp.load('addressbook.capnp')
+m = capnp._MallocMessageBuilder()
+alice = m.new_orphan(addressbook.Person)
+

+

+

+
Parameters

+
schema (Schema) – A Cap’n proto schema specifying which struct to instantiate

+

+
Return type

+
_DynamicOrphan

+

+
Returns

+
An orphan representing a _DynamicStructBuilder

+

+

+

+
+

+

+set_root(self, value)

+
A method for instantiating Cap’n Proto structs by copying from an existing struct

+

+
Parameters

+
value (_DynamicStructReader) – A Cap’n Proto struct value to copy

+

+
Return type

+
void

+

+

+

+
+

+
+

+

+
RPC

+

+

+class capnp._CapabilityClient

+

+

+cast_as(self, schema)

+

+
+

+
+

+

+class capnp._DynamicCapabilityClient

+

+

+cast_as(self, schema)

+

+
+

+

+schema

+
A property that returns the _InterfaceSchema object matching this client

+

+
+

+

+upcast(self, schema)

+

+
+

+
+

+

+
Miscellaneous

+

+

+class capnp._DynamicOrphan

+

+

+get(self)

+
Returns a python object corresponding to the DynamicValue owned by this orphan

+
Use this DynamicValue to set fields inside the orphan

 

 
 

@@ -1148,26 +1639,35 @@ parsed schemas and constants with . syntax

 

 
 
+
-
+ -
+ -
- © Copyright 2013, Author. - Created using Sphinx 1.2.3. + \ No newline at end of file diff --git a/genindex.html b/genindex.html index 156baad..241dd44 100644 --- a/genindex.html +++ b/genindex.html @@ -1,33 +1,22 @@ - + - - + - - - Index — capnp 0.5.4 documentation - + + + Index — capnp 1.0.0b2 documentation - - - - - - - - -
+ + + + + + + + +
-
+

Index

@@ -54,7 +44,6 @@ | B | C | D - | E | F | G | I @@ -74,590 +63,552 @@

_

- - + +
  • _DynamicListBuilder (class in capnp) +
    • +
  • _DynamicListReader (class in capnp) +
    • +
  • _DynamicOrphan (class in capnp) +
    • +
  • _DynamicResizableListBuilder (class in capnp) +
    • +
  • _DynamicStructBuilder (class in capnp) +
    • +
  • _DynamicStructReader (class in capnp) +
    • + +
    - -
    _CapabilityClient (class in capnp) -
    +
    - -
    _DynamicResizableListBuilder (class in capnp) -
    - - -
    _DynamicStructBuilder (class in capnp) -
    - - -
    _DynamicStructReader (class in capnp) -
    - - -
    _InterfaceModule (class in capnp) -
    - - -
    _StructModule (class in capnp) -
    - -

    A

    - + - + +
    - -
    add() (capnp._DynamicResizableListBuilder method) -
    +
    - -
    as_builder() (capnp._DynamicStructReader method) -
    - - -
    as_reader() (capnp._DynamicStructBuilder method) -
    - - -
    attach() (capnp.Promise method) -
    - -

    B

    - + +
    - -
    bootstrap() (capnp.TwoPartyClient method) -
    +

    C

    - - + + +
    - -
    cancel() (capnp.Promise method) -
    +
    - -
    cast_as() (capnp._CapabilityClient method) -
    + +
  • cast_as() (capnp._CapabilityClient method) -
    - -
    (capnp._DynamicCapabilityClient method) -
    - -
    - -
    copy() (capnp._DynamicStructBuilder method) -
    - -

    • D

    - + - -
    - -
    description (capnp.KjException attribute) -
    +
    - -
    disown() (capnp._DynamicListBuilder method) -
    - -
    - -
    (capnp._DynamicStructBuilder method) -
    - -
    -
    - -

    E

    - - + +
    - -
    ez_restore() (capnp.TwoPartyClient method) -
    - -

    F

    - - + +
    - -
    FAILED (capnp.KjException.Type attribute) -
    - - -
    file (capnp.KjException attribute) -
    - - -
    finish() (capnp._DynamicResizableListBuilder method) -
    - - -
    from_bytes() (capnp._StructModule method) -
    - -
    - -
    from_bytes_packed() (capnp._StructModule method) -
    - - -
    from_dict() (capnp._DynamicStructBuilder method) -
    - -
    - -
    (capnp._StructModule method) -
    - -
    - -
    from_object() (capnp._StructModule method) -
    - - -
    fulfill() (capnp.PromiseFulfillerPair method) -
    - -

    G

    - + + +
    - -
    get() (capnp._DynamicOrphan method) -
    +

    I

    - - + + +
    - -
    init() (capnp._DynamicStructBuilder method) -
    +
    - -
    is_consumed (capnp.Promise attribute) -
    + +

    J

    - +
    - -
    join_promises() (in module capnp) -
    - -

    K

    - - + +
    - -
    KjException (class in capnp) -
    - -
    - -
    KjException.Type (class in capnp) -
    - -

    L

    - + - + +
    - -
    line (capnp.KjException attribute) -
    +
    - -
    load() (capnp.SchemaParser method) -
    - -
    - -
    (in module capnp) -
    - -
    -

    M

    - - + + +
    - -
    message (capnp.KjException attribute) -
    +
      +
    • + module -
    - -
    modules_by_id (capnp.SchemaParser attribute) -
    - -

    N

    - + +
    - -
    new_message() (capnp._StructModule method) -
    - -

    O

    - - + + +
    - -
    on_disconnect() (capnp.TwoPartyClient method) -
    +
    - -
    OVERLOADED (capnp.KjException.Type attribute) -
    - -

    P

    - - + +
  • port (capnp.TwoPartyServer attribute) +
    • + +
    - -
    port (capnp.TwoPartyServer attribute) -
    +
    - -
    Promise (class in capnp) -
    - - -
    PromiseFulfillerPair (class in capnp) -
    - -

    R

    - - + +
  • read_multiple() (capnp._StructModule method) +
    • +
  • read_multiple_bytes() (capnp._StructModule method) +
    • +
  • read_multiple_bytes_packed() (capnp._StructModule method) +
    • + +
    - -
    read() (capnp._StructModule method) -
    +
    - -
    read_packed() (capnp._StructModule method) -
    - - -
    remove_import_hook() (in module capnp) -
    - - -
    restore() (capnp.TwoPartyClient method) -
    - - -
    reverse_mapping (capnp.KjException.Type attribute) -
    - - -
    run_forever() (capnp.TwoPartyServer method) -
    - -

    S

    - - + + +
    - -
    schema (capnp._DynamicCapabilityClient attribute) -
    +
    - -
    SchemaParser (class in capnp) -
    - -

    T

    - + - + +
  • TwoPartyClient (class in capnp) +
    • +
  • TwoPartyServer (class in capnp) +
    • +
  • type() (capnp.KjException property) +
    • +
    - -
    then() (capnp.Promise method) -
    +
    - -
    total_size (capnp._DynamicStructBuilder attribute) -
    - -
    - -
    (capnp._DynamicStructReader attribute) -
    - -
    - -
    TwoPartyClient (class in capnp) -
    - - -
    TwoPartyServer (class in capnp) -
    - - -
    type (capnp.KjException attribute) -
    - -

    U

    - + - + +
    - -
    UNIMPLEMENTED (capnp.KjException.Type attribute) -
    +
    - -
    upcast() (capnp._DynamicCapabilityClient method) -
    - -

    W

    - + - + +
  • write_packed() (capnp._DynamicStructBuilder method) +
    • +
    - -
    wait() (capnp.Promise method) -
    +
    - -
    write() (capnp._DynamicStructBuilder method) -
    - - -
    write_packed() (capnp._DynamicStructBuilder method) -
    - -
    +
    -
    + -
    + -
    - © Copyright 2013, Author. - Created using Sphinx 1.2.3. + \ No newline at end of file diff --git a/index.html b/index.html index 4cc066d..a070e1c 100644 --- a/index.html +++ b/index.html @@ -1,33 +1,23 @@ - + - + - - - Welcome to pycapnp’s documentation! — capnp 0.5.4 documentation - + + + pycapnp — capnp 1.0.0b2 documentation - - - - - - + + + + + + + - - -
    + +
    -
    +
    -
    -

    Welcome to pycapnp’s documentation!

    -

    This is a python wrapping of the C++ implementation of the Cap’n Proto library. Here is a short description, quoted from its docs:

    +
    +

    pycapnp

    +

    This is a python wrapping of the C++ implementation of the Cap’n Proto library. Here is a short description, quoted from its docs:

    -
    Cap’n Proto is an insanely fast data interchange format and capability-based RPC system. Think JSON, except binary. Or think Protocol Buffers, except faster. In fact, in benchmarks, Cap’n Proto is INFINITY TIMES faster than Protocol Buffers.
    -

    Since the python library is just a thin wrapping of the C++ library, we inherit a lot of what makes Cap’n Proto fast. In some simplistic benchmarks (available in the benchmark directory of the repo), pycapnp has proven to be decently faster than Protocol Buffers (both pure python and C++ implementations). Also, the python capnp library can load Cap’n Proto schema files directly, without the need for a seperate compile step like with Protocol Buffers or Thrift. pycapnp is available on github and pypi.

    +

    Cap’n Proto is an insanely fast data interchange format and capability-based RPC system. Think JSON, except binary. Or think Protocol Buffers, except faster. In fact, in benchmarks, Cap’n Proto is INFINITY TIMES faster than Protocol Buffers.

    +
    +

    Since the python library is just a thin wrapping of the C++ library, we inherit a lot of what makes Cap’n Proto fast. In some simplistic benchmarks (available in the benchmark directory of the repo), pycapnp has proven to be decently faster than Protocol Buffers (both pure python and C++ implementations). Also, the python capnp library can load Cap’n Proto schema files directly, without the need for a seperate compile step like with Protocol Buffers or Thrift. pycapnp is available on github and pypi.

    Contents:

    -
    -
    -

    Indices and tables

    -
    +
    -
    + -
    + -
    - © Copyright 2013, Author. - Created using Sphinx 1.2.3. + \ No newline at end of file diff --git a/install.html b/install.html index 6936833..f5ca442 100644 --- a/install.html +++ b/install.html @@ -1,34 +1,24 @@ - + - + - - - Installation — capnp 0.5.4 documentation - + + + Installation — capnp 1.0.0b2 documentation - - - - - - + + + + + + + - - - -
    + + +
    -
    +

    Installation

    -
    -

    C++ Cap’n Proto Library

    -

    You need to install the C++ Cap’n Proto library first. It requires a C++ compiler with C++11 support, such as GCC 4.7+ or Clang 3.2+. Follow installation docs at http://kentonv.github.io/capnproto/install.html, or if you’re feeling lazy, you can run the commands below:

    -
    curl -O http://capnproto.org/capnproto-c++-0.5.0.tar.gz
-tar zxf capnproto-c++-0.5.0.tar.gz
-cd capnproto-c++-0.5.0
-./configure
-make -j6 check
-sudo make install
-
    -
    -

    Pip

    -

    Using pip is by far the easiest way to install the library. After you’ve installed the C++ library, all you need to run is:

    -
    [sudo] pip install -U cython
-[sudo] pip install -U setuptools
-[sudo] pip install pycapnp
+
    The pip installation will using the binary versions of the package (if possible). These contain a bundled version of capnproto (on Linux compiled with manylinux). Starting from v1.0.0b1 binary releases are available for Windows, macOS and Linux from pypi:
    
+
    [sudo] pip install pycapnp
 
    
 
    
-
    On some systems you will have to install Python’s headers before doing any of this. For Debian/Ubuntu, this is:
    
-
    sudo apt-get install python-dev
+
    To force rebuilding the pip package from source (you’ll need requirments.txt or pipenv):
    
+
    pip install --no-binary :all: pycapnp
+
    
+
    
+
    To force bundling libcapnp (or force system libcapnp), just in case setup.py isn’t doing the right thing:
    
+
    pip install --no-binary :all: --install-option "--force-bundled-libcapnp"
+pip install --no-binary :all: --install-option "--force-system-libcapnp"
+
    
+
    
+
    If you’re using an older Linux distro (e.g. CentOS 6) you many need to set LDFLAGS=”-Wl,–no-as-needed -lrt”:
    
+
    LDFLAGS="-Wl,--no-as-needed -lrt" pip install --no-binary :all: pycapnp
+
    
+
    
+
    It’s also possible to specify the libcapnp url when bundling (this may not work, there be dragons):
    
+
    pip install --no-binary :all: --install-option "--force-bundled-libcapnp" --install-option "--libcapnp-url" --install-option "https://github.com/capnproto/capnproto/archive/master.tar.gz"
 
    
 
    
-
    You can control what compiler is used with the environment variable CC, ie. CC=gcc-4.8 pip install pycapnp, and flags with CFLAGS. You only need to run the setuptools line if you have a setuptools older than v0.8.0, and the cython line if you have a version older than v0.19.1.
    
 
    
 
    
 
    From Source
    
-
    If you want the latest development version, you can clone the github repo and install like so:
    
-
    git clone https://github.com/jparyani/pycapnp.git
-pip install ./pycapnp
+
    Source installation is generally not needed unless you’re looking into an issue with capnproto or pycapnp itself.
    
+
    
+
    C++ Cap’n Proto Library
    
+
    You need to install the C++ Cap’n Proto library first. It requires a C++ compiler with C++14 support, such as GCC 5+ or Clang 5+. Follow installation docs at https://capnproto.org/install.html.
    
+
    
+
    
+
    pycapnp from git
    
+
    If you want the latest development version, you can clone the github repo:
    
+
    git clone https://github.com/capnproto/pycapnp.git
+
    
+
    
+
    For development packages use one of the following to install the python dependencies:
    
+
    pipenv install
+pip install -r requirements.txt
+
    
+
    
+
    And install pycapnp with:
    
+
    cd pycapnp
+pip install .
 
    
 
    
 
    or:
    
-
    cd pycapnp
-python setup.py install
+
    cd pycapnp
+python setup.py install
 
    
 
    
 
    
+
    
 
    
 
    Development
    
-
    Clone the repo from https://github.com/jparyani/pycapnp.git and use the develop branch. I’ll probably ask you to redo pull requests that target master and aren’t easily mergable to develop:
    
-
    git clone https://github.com/jparyani/pycapnp.git
-git checkout develop
+
    Clone the repo from https://github.com/capnproto/pycapnp.git:
    
+
    git clone https://github.com/capnproto/pycapnp.git
 
    
 
    
-
    Testing is done through pytest, like so:
    
-
    pip install pytest
-py.test
+
    For development packages use one of the following to install the python dependencies:
    
+
    pipenv install
+pip install -r requirements.txt
 
    
 
    
-
    Once you’re done installing, take a look at the Quickstart
    
+
    Building:
    
+
    cd pycapnp
+pip install .
+
    
+
    
+
    or:
    
+
    cd pycapnp
+python setup.py install
+
    
+
    
+
    Useful targets for setup.py:
    
+
    python setup.py build
+python setup.py clean
+
    
+
    
+
    Useful command-line arguments are available for setup.py:
    
+
    --force-bundled-libcapnp
+--force-system-libcapnp
+--libcapnp-url
+
    
+
    
+
    Testing is done through pytest:
    
+
    cd pycapnp
+pytest
+pytest test/test_rpc_calculator.py
+
    
+
    
+
    Once you’re done installing, take a look at the Quickstart
    
 
    
 
    
 
 
+            
    
           
    
         
    
       
    
-      
    
+      
-    
    
+    
-    
    
-        © Copyright 2013, Author.
-      Created using Sphinx 1.2.3.
+    
   
 
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
index ad893b0f5861ce2ed54c0985ad553b2d83f8a01c..0fe6c5dc20329fa16f465410fb6fb77700a01e71 100644
GIT binary patch
delta 1288
zcmV+j1^4=a2n0S(_xTi_X&3Fnns$44Y2r*h&BL|R
zyJavswz(Gp1r%TP)A#6MM>ui>Xcx)+{s+#3m%^x)dZw!{h003-v)^W{ev=(sA%1G#
z&3~TFZ`!wieOvrspdDATW|*MX&VKJBgKe|dN<%b|-7hzHFVD}5yVu2iO;hI#f8Ul4
zf)yTamyfCJ%j=(ubt3w8v3`8Hy-zj$&-3zW^|*LiJSUIbz#A9~q@Y@JxsMj1W^bdR
z94s^ZoE`gn`c|4oW+dMu_QmBG-yOR8L6T_vtX+>Vz`r1d^+u;}f&*e@suvoK7PmahB47
z+2OJKslAgLjoA|wLa`^XmhK^V;Todq)&3l+5l?-}o&Cb
z`mNi2OXzZYg$$qIe?JODtdSmE=XcS%Efx(sdVgd{Q3}VkfJtzgvj-#+z3wYb&ZfeBCxy%Fh2fAucsL;cbr8TOd6Ly9$g
zlng`?8hbN8AmI)mlWZR;kMr&t3gsZd#~zqbGR<Utnba~-r?nwI=CC%zr-rP<)7*WAqfTl=65$869{pAEJfZq~
zSbFJtBJopoe;-e%`#wIQ>iaU$_1cF6Ypwg1I=0d9zJ!f6Hdyp;vHPSBirmr}sLzve
zmTJ%Rzjs}4Pc@%emwyp-i`g*0`2BXZoULI82GB39cGEgn%x`HTd>{(XMF1kTnj5FA+#GMde)tt8`W&f1Og2)wBu
y>i?jjvuz4;#vWoD981bYtv

delta 927
zcmV;Q17Q5<3V{faIR!8-H7+!fKs$d}%W~Q<6y5U`o@ust+HH0zkSS9F6lk{^S-!?f
zWJ#6e5c2hvUkL_NOJ;|~ed#{Vx%M77+d(-!_buf*?yUmqucxZ>#6nXYc8&Zoo^OYNUiP
zZU!pNstjSGM24cH0qq|7>7{>Ts>Ol#>#nUIsv$HfI7oNID57T|W>AoY5@A^DKAj1c
zIHHW29VLXTKeNqZ^)Q`H2Nbi(=|NEgNMiB=v2Q=MZ1gMd
z4q|PG*Y&=g&1VFPDKSGMrJNe1K+|^|F+j}Lt>4r|;(ssaPwU0(X|{jd4a$9e7pzhA
z*)*OpJU+}9w>US#!V$8GfE${J2zhiLN9zPvz~dzUn6rd325OCIi8@4Zoo7{>_6B^B
zFa@umG@uMiN%`K}2&3FBRqZwp;k{@$BNPm6+8cY`s+XASJmeRto6fhB)p9wTxVHPL
zg%~tZwEXR@n}ODrjJP4FQXyUnoh0X^>=zF}^Q4ngLU2gCH(5Um
z%8{&6qJ8dEtP(ff$P?I`vJq@IS?1n>n}$T&Tj}5(LX#9S?8SdY=S2x~Nw5o{U)xFt
zu0b`UdfcFs;p%R2GO#UuS-jKMarMGrmx&{y@eOS5v)G@JoIAr^V4!=pFY4`)@e?@f
zpR3FEaO2w0uE6Btv+{SmFp8z_sCaIooT`32@FgkyMXcyIQbo-^}+<;0j
z0Y`<7)GUSO3m7g)7h&xS{u~bIWWo344fnXOXJEkQ=W*Nr
zp!~qy&h-P>6~M6k{;^pO&Y5%GnW)IU58cj&BC;!pHVO~Reh;lJsBw2q
 
+
 
-
+
   
-    
-    
-    Python Module Index — capnp 0.5.4 documentation
-    
+    
+    
+    Python Module Index — capnp 1.0.0b2 documentation
     
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
+    
+    
+    
  
 
-    
 
 
-  
-  
-    
    
+  
+      
 
     
    
       
    
         
    
-          
    
+          
    
             
 
    
    Python Module Index
    
@@ -58,41 +49,46 @@
    c
    
    
 
-   
-     
+   
     
    
+     
     
    
      
    
        c
    
      
    
        
        
-       capnp
+       capnp
        
    
    
    
 
 
+            
    
           
    
         
    
       
    
-      
    
+      
-    
    
+    
-    
    
-        © Copyright 2013, Author.
-      Created using Sphinx 1.2.3.
+    
   
 
\ No newline at end of file
diff --git a/quickstart.html b/quickstart.html
index e99e8de..a48f87e 100644
--- a/quickstart.html
+++ b/quickstart.html
@@ -1,34 +1,24 @@
-
 
+
 
-
+
   
-    
-    
-    Quickstart — capnp 0.5.4 documentation
-    
+    
+    
+    Quickstart — capnp 1.0.0b2 documentation
     
     
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
+    
+    
+    
     
      
-  
-  
-    
    
+  
+      
 
     
    
       
    
         
    
-          
    
+          
    
             
   
    
 
    Quickstart
    
-
    This assumes you already have the capnp library installed. If you don’t, please follow the instructions at Installation first.
    
-
    In general, this library is a very light wrapping of the Cap’n Proto C++ library. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured.
    
+
    This assumes you already have the capnp library installed. If you don’t, please follow the instructions at Installation first.
    
+
    In general, this library is a very light wrapping of the Cap’n Proto C++ library. You can refer to its docs for more advanced concepts, or just to get a basic idea of how the python library is structured.
    
 
    
-
    Load a Cap’n Proto Schema
    
+
    Load a Cap’n Proto Schema
    
 
    First you need to import the library:
    
-
    import capnp
+
    import capnp
 
    
 
    
-
    Then you can load the Cap’n Proto schema with:
    
-
    import addressbook_capnp
+
    Then you can load the Cap’n Proto schema with:
    
+
    import addressbook_capnp
 
    
 
    
-
    This will look all through all the directories in your sys.path/PYTHONPATH, and try to find a file of the form ‘addressbook.capnp’. If you want to disable the import hook magic that import capnp adds, and load manually, here’s how:
    
-
    capnp.remove_import_hook()
-addressbook_capnp = capnp.load('addressbook.capnp')
+
    This will look all through all the directories in your sys.path/PYTHONPATH, and try to find a file of the form ‘addressbook.capnp’. If you want to disable the import hook magic that import capnp adds, and load manually, here’s how:
    
+
    capnp.remove_import_hook()
+addressbook_capnp = capnp.load('addressbook.capnp')
 
    
 
    
-
    For future reference, here is the Cap’n Proto schema. Also available in the github repository under examples/addressbook.capnp:
    
-
    # addressbook.capnp
-@0x934efea7f017fff0;
+
    For future reference, here is the Cap’n Proto schema. Also available in the github repository under examples/addressbook.capnp:
    
+
    # addressbook.capnp
+@0x934efea7f017fff0;
 
-const qux :UInt32 = 123;
+const qux :UInt32 = 123;
 
-struct Person {
-  id @0 :UInt32;
-  name @1 :Text;
-  email @2 :Text;
-  phones @3 :List(PhoneNumber);
+struct Person {
+  id @0 :UInt32;
+  name @1 :Text;
+  email @2 :Text;
+  phones @3 :List(PhoneNumber);
 
-  struct PhoneNumber {
-    number @0 :Text;
-    type @1 :Type;
+  struct PhoneNumber {
+    number @0 :Text;
+    type @1 :Type;
 
-    enum Type {
-      mobile @0;
-      home @1;
-      work @2;
-    }
-  }
+    enum Type {
+      mobile @0;
+      home @1;
+      work @2;
+    }
+  }
 
-  employment :union {
-    unemployed @4 :Void;
-    employer @5 :Text;
-    school @6 :Text;
-    selfEmployed @7 :Void;
-    # We assume that a person is only one of these.
-  }
-}
+  employment :union {
+    unemployed @4 :Void;
+    employer @5 :Text;
+    school @6 :Text;
+    selfEmployed @7 :Void;
+    # We assume that a person is only one of these.
+  }
+}
 
-struct AddressBook {
-  people @0 :List(Person);
-}
+struct AddressBook {
+  people @0 :List(Person);
+}
 
    
 
    
 
    
 
    Const values
    
-
    Const values show up just as you’d expect under the loaded schema. For example:
    
-
    print addressbook_capnp.qux
-# 123
+
    Const values show up just as you’d expect under the loaded schema. For example:
    
+
    print addressbook_capnp.qux
+# 123
 
    
 
    
 
    
@@ -120,106 +111,106 @@ struct AddressBook {
 
    
 
    Build a message
    
 
    
-
    Initialize a New Cap’n Proto Object
    
-
    Now that you’ve imported your schema, you need to allocate an actual struct from that schema. In this case, we will allocate an AddressBook:
    
-
    addresses = addressbook_capnp.AddressBook.new_message()
+
    Initialize a New Cap’n Proto Object
    
+
    Now that you’ve imported your schema, you need to allocate an actual struct from that schema. In this case, we will allocate an AddressBook:
    
+
    addresses = addressbook_capnp.AddressBook.new_message()
 
    
 
    
-
    Notice that we used addressbook_capnp from the previous section: Load a Cap’n Proto Schema.
    
+
    Notice that we used addressbook_capnp from the previous section: Load a Cap’n Proto Schema.
    
 
    Also as a shortcut, you can pass keyword arguments to the new_message function, and those fields will be set in the new message:
    
-
    person = addressbook_capnp.Person.new_message(name='alice')
-# is equivalent to:
+
    person = addressbook_capnp.Person.new_message(name='alice')
+# is equivalent to:
 person = addressbook_capnp.Person.new_message()
-person.name = 'alice'
+person.name = 'alice'
 
    
 
    
 
    
 
    
 
    List
    
 
    Allocating a list inside of an object requires use of the init function:
    
-
    people = addresses.init('people', 2)
+
    people = addresses.init('people', 2)
 
    
 
    
-
    For now, let’s grab the first element out of this list and assign it to a variable named alice:
    
-
    alice = people[0]
+
    For now, let’s grab the first element out of this list and assign it to a variable named alice:
    
+
    alice = people[0]
 
    
 
    
 
    
-
    Note
    
-
    It is a very bad idea to call init more than once on a single field. Every call to init allocates new memory inside your Cap’n Proto message, and if you call it more than once, the previous memory is leaked.
    
+
    Note
    
+
    It is a very bad idea to call init more than once on a single field. Every call to init allocates new memory inside your Cap’n Proto message, and if you call it more than once, the previous memory is left as dead space in the message. See Tips and Best Practices for more details.
    
 
    
 
    
 
    
 
    Primitive Types
    
-
    For all primitive types, from the Cap’n Proto docs:
    
+
    For all primitive types, from the Cap’n Proto docs:
    
 
      
-
    • Boolean: Bool
      • 
-
    • Integers: Int8, Int16, Int32, Int64
      • 
-
    • Unsigned integers: UInt8, UInt16, UInt32, UInt64
      • 
-
    • Floating-point: Float32, Float64
      • 
-
    • Blobs: Text, Data
      • 
+
    • Boolean: Bool
      • 
+
    • Integers: Int8, Int16, Int32, Int64
      • 
+
    • Unsigned integers: UInt8, UInt16, UInt32, UInt64
      • 
+
    • Floating-point: Float32, Float64
      • 
+
    • Blobs: Text, Data
      • 
 
    
 
    You can assign straight to the variable with the corresponding Python type. For Blobs, you use strings. Assignment happens just by using the . syntax on the object you contstructed above:
    
-
    alice.id = 123
-alice.name = 'Alice'
-alice.email = 'alice@example.com'
+
    alice.id = 123
+alice.name = 'Alice'
+alice.email = 'alice@example.com'
 
    
 
    
 
    
-
    Note
    
-
    Text fields will behave differently depending on your version of Python. In Python 2.x, Text fields will expect and return a bytes string, while in Python 3.x, they will expect and return a unicode string. Data fields will always a return bytes string.
    
+
    Note
    
+
    Text fields will behave differently depending on your version of Python. In Python 2.x, Text fields will expect and return a bytes string, while in Python 3.x, they will expect and return a unicode string. Data fields will always a return bytes string.
    
 
    
 
    
 
    
 
    Enums
    
-
    First we’ll allocate a length one list of phonenumbers for alice:
    
-
    alicePhone = alice.init('phones', 1)[0]
+
    First we’ll allocate a length one list of phonenumbers for alice:
    
+
    alicePhone = alice.init('phones', 1)[0]
 
    
 
    
 
    Note that even though it was a length 1 list, it was still a list that was returned, and we extracted the first (and only) element with [0].
    
 
    Enums are treated like strings, and you assign to them like they were a Text field:
    
-
    alicePhone.type = 'mobile'
+
    alicePhone.type = 'mobile'
 
    
 
    
 
    If you assign an invalid value to one, you will get a ValueError:
    
-
    alicePhone.type = 'foo'
----------------------------------------------------------------------------
-ValueError                                Traceback (most recent call last)
-...
-ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enumerant; name = foo
+
    alicePhone.type = 'foo'
+---------------------------------------------------------------------------
+ValueError                                Traceback (most recent call last)
+...
+ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enumerant; name = foo
 
    
 
    
 
    
 
    
 
    Unions
    
 
    For the most part, you just treat them like structs:
    
-
    alice.employment.school = "MIT"
+
    alice.employment.school = "MIT"
 
    
 
    
-
    Now the school field is the active part of the union, and we’ve assigned ‘MIT’ to it. You can query which field is set in a union with which(), shown in Reading Unions
    
+
    Now the school field is the active part of the union, and we’ve assigned ‘MIT’ to it. You can query which field is set in a union with which(), shown in Reading Unions
    
 
    Also, one weird case is for Void types in Unions (and in general, but Void is really only used in Unions). For these, you will have to assign None to them:
    
-
    bob.employment.unemployed = None
+
    bob.employment.unemployed = None
 
    
 
    
 
    
-
    Note
    
+
    Note
    
 
    One caveat for unions is having structs as union members. Let us assume employment.school was actually a struct with a field of type Text called name:
    
-
    alice.employment.school.name = "MIT"
-# Raises a ValueError
+
    alice.employment.school.name = "MIT"
+# Raises a ValueError
 
    
 
    
-
    The problem is that a struct within a union isn’t initialized automatically. You have to do the following:
    
-
    school = alice.employment.init('school')
-school.name = "MIT"
+
    The problem is that a struct within a union isn’t initialized automatically. You have to do the following:
    
+
    school = alice.employment.init('school')
+school.name = "MIT"
 
    
 
    
-
    Note that this is similar to init for lists, but you don’t pass a size. Requiring the init makes it more clear that a memory allocation is occurring, and will hopefully make you mindful that you shouldn’t set more than 1 field inside of a union, else you risk a memory leak
    
+
    Note that this is similar to init for lists, but you don’t pass a size. Requiring the init makes it more clear that a memory allocation is occurring, and will hopefully make you mindful that you shouldn’t set more than 1 field inside of a union, else you risk a memory leak
    
 
    
 
    
 
    
 
    Writing to a File
    
-
    Once you’re done assigning to all the fields in a message, you can write it to a file like so:
    
-
    f = open('example.bin', 'w+b')
+
    Once you’re done assigning to all the fields in a message, you can write it to a file like so:
    
+
    f = open('example.bin', 'w+b')
 addresses.write(f)
 
    
 
    
@@ -231,45 +222,45 @@ ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enum
 
    
 
    Reading from a file
    
 
    Much like before, you will have to de-serialize the message from a file descriptor:
    
-
    f = open('example.bin', 'rb')
+
    f = open('example.bin', 'rb')
 addresses = addressbook_capnp.AddressBook.read(f)
 
    
 
    
 
    Note that this very much needs to match the type you wrote out. In general, you will always be sending the same message types out over a given channel or you should wrap all your types in an unnamed union. Unnamed unions are defined in the .capnp file like so:
    
-
    struct Message {
-    union {
-      person @0 :Person;
-      addressbook @1 :AddressBook;
-    }
-}
+
    struct Message {
+    union {
+      person @0 :Person;
+      addressbook @1 :AddressBook;
+    }
+}
 
    
 
    
 
    
 
    
 
    Reading Fields
    
 
    Fields are very easy to read. You just use the . syntax as before. Lists behave just like normal Python lists:
    
-
    for person in addresses.people:
-    print(person.name, ':', person.email)
+
    for person in addresses.people:
+    print(person.name, ':', person.email)
     for phone in person.phones:
-        print(phone.type, ':', phone.number)
+        print(phone.type, ':', phone.number)
 
    
 
    
 
    
 
    
 
    Reading Unions
    
 
    The only tricky one is unions, where you need to call .which() to determine the union type. The .which() call returns an enum, ie. a string, corresponding to the field name:
    
-
    which = person.employment.which()
-print(which)
+
    which = person.employment.which()
+print(which)
 
-if which == 'unemployed':
-    print('unemployed')
-elif which == 'employer':
-    print('employer:', person.employment.employer)
-elif which == 'school':
-    print('student at:', person.employment.school)
-elif which == 'selfEmployed':
-    print('self employed')
-print()
+if which == 'unemployed':
+    print('unemployed')
+elif which == 'employer':
+    print('employer:', person.employment.employer)
+elif which == 'school':
+    print('student at:', person.employment.school)
+elif which == 'selfEmployed':
+    print('self employed')
+print()
 
    
 
    
 
    
@@ -279,19 +270,19 @@ ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enum
 
    
 
    Files
    
 
    As shown in the examples above, there is file serialization with write():
    
-
    addresses = addressbook_capnp.AddressBook.new_message()
+
    addresses = addressbook_capnp.AddressBook.new_message()
 ...
-f = open('example.bin', 'w+b')
+f = open('example.bin', 'w+b')
 addresses.write(f)
 
    
 
    
 
    And similarly for reading:
    
-
    f = open('example.bin', 'rb')
+
    f = open('example.bin', 'rb')
 addresses = addressbook_capnp.AddressBook.read(f)
 
    
 
    
 
    There are packed versions as well:
    
-
    addresses.write_packed(f)
+
    addresses.write_packed(f)
 f.seek(0)
 addresses = addressbook_capnp.AddressBook.read_packed(f)
 
    
@@ -300,113 +291,251 @@ ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enum
 
    
 
    Multi-message files
    
 
    The above methods only guaranteed to work if your file contains a single message. If you have more than 1 message serialized sequentially in your file, then you need to use these convenience functions:
    
-
    addresses = addressbook_capnp.AddressBook.new_message()
+
    addresses = addressbook_capnp.AddressBook.new_message()
 ...
-f = open('example.bin', 'w+b')
+f = open('example.bin', 'w+b')
 addresses.write(f)
 addresses.write(f)
-addresses.write(f) # write 3 messages
+addresses.write(f) # write 3 messages
 f.seek(0)
 
 for addresses in addressbook_capnp.AddressBook.read_multiple(f):
-    print addresses
+    print addresses
 
    
 
    
 
    There is also a packed version:
    
-
    for addresses in addressbook_capnp.AddressBook.read_multiple_packed(f):
-    print addresses
+
    for addresses in addressbook_capnp.AddressBook.read_multiple_packed(f):
+    print addresses
 
    
 
    
 
    
 
    
 
    Dictionaries
    
-
    There is a convenience method for converting Cap’n Proto messages to a dictionary. This works for both Builder and Reader type messages:
    
-
    alice.to_dict()
+
    There is a convenience method for converting Cap’n Proto messages to a dictionary. This works for both Builder and Reader type messages:
    
+
    alice.to_dict()
 
    
 
    
 
    For the reverse, all you have to do is pass keyword arguments to the new_message constructor:
    
-
    my_dict = {'name' : 'alice'}
+
    my_dict = {'name' : 'alice'}
 alice = addressbook_capnp.Person.new_message(**my_dict)
-# equivalent to: alice = addressbook_capnp.Person.new_message(name='alice')
+# equivalent to: alice = addressbook_capnp.Person.new_message(name='alice')
 
    
 
    
-
    It’s also worth noting, you can use python lists/dictionaries interchangably with their Cap’n Proto equivalent types:
    
-
    book = addressbook_capnp.AddressBook.new_message(people=[{'name': 'Alice'}])
+
    It’s also worth noting, you can use python lists/dictionaries interchangably with their Cap’n Proto equivalent types:
    
+
    book = addressbook_capnp.AddressBook.new_message(people=[{'name': 'Alice'}])
 ...
 book = addressbook_capnp.AddressBook.new_message()
-book.init('people', 1)
-book.people[0] = {'name': 'Bob'}
+book.init('people', 1)
+book.people[0] = {'name': 'Bob'}
 
    
 
    
 
    
 
    
 
    Byte Strings/Buffers
    
 
    There is serialization to a byte string available:
    
-
    encoded_message = alice.to_bytes()
+
    encoded_message = alice.to_bytes()
 
    
 
    
 
    And a corresponding from_bytes function:
    
-
    alice = addressbook_capnp.Person.from_bytes(encoded_message)
+
    alice = addressbook_capnp.Person.from_bytes(encoded_message)
 
    
 
    
 
    There are also packed versions:
    
-
    alice2 = addressbook_capnp.Person.from_bytes_packed(alice.to_bytes_packed())
+
    alice2 = addressbook_capnp.Person.from_bytes_packed(alice.to_bytes_packed())
 
    
 
    
 
    
+
    
+
    Byte Segments
    
+
    
+
    Note
    
+
    This feature is not supported in PyPy at the moment, pending investigation.
    
+
    
+
    Cap’n Proto supports a serialization mode which minimizes object copies. In the C++ interface, capnp::MessageBuilder::getSegmentsForOutput() returns an array of pointers to segments of the message’s content without copying. capnp::SegmentArrayMessageReader performs the reverse operation, i.e., takes an array of pointers to segments and uses the underlying data, again without copying. This produces a different wire serialization format from to_bytes() serialization, which uses capnp::messageToFlatArray() and capnp::FlatArrayMessageReader (both of which use segments internally, but write them in an incompatible way).
    
+
    For compatibility on the Python side, use the to_segments() and from_segments() functions:
    
+
    segments = alice.to_segments()
+
    
+
    
+
    This returns a list of segments, each a byte buffer. Each segment can be, e.g., turned into a ZeroMQ message frame. The list of segments can also be turned back into an object:
    
+
    alice = addressbook_capnp.Person.from_segments(segments)
+
    
+
    
+
    For more information, please refer to the following links:
    
+
+
    
 
    
 
    
 
    RPC
    
-
    Cap’n Proto has a rich RPC protocol. You should read the RPC specification as well as the C++ RPC documentation before using pycapnp’s RPC features. As with the serialization part of this library, the RPC component tries to be a very thin wrapper on top of the C++ API.
    
-
    The examples below will be using calculator.capnp. Please refer to it to understand the interfaces that will be used.
    
+
    Cap’n Proto has a rich RPC protocol. You should read the RPC specification as well as the C++ RPC documentation before using pycapnp’s RPC features. As with the serialization part of this library, the RPC component tries to be a very thin wrapper on top of the C++ API.
    
+
    The examples below will be using calculator.capnp. Please refer to it to understand the interfaces that will be used.
    
+
    Asyncio support was added to pycapnp in v1.0.0 utilizing the TwoWayPipe interface to libcapnp (instead of having libcapnp control the socket communication). The main advantage here is that standard Python socket libraries can be used with pycapnp (more importantly, TLS/SSL). Asyncio requires a bit more boiler plate to get started but it does allow for a lot more control than using the pycapnp socket wrapper.
    
 
    
 
    Client
    
+
    There are two ways to start a client: libcapnp socket wrapper and asyncio.
+The wrapper is easier to implement but is very limited (doesn’t support SSL/TLS with Python).
+asyncio requires more setup and can be harder to debug; however, it does support SSL/TLS and has more control over the socket error conditions. asyncio also helps get around the threading limitations around the current pycapnp implementation has with libcapnp (pycapnp objects and functions must all be in the same thread).
    
 
    
 
    Starting a Client
    
 
    Starting a client is very easy:
    
-
    import capnp
+
    import capnp
 import calculator_capnp
 
-client = capnp.TwoPartyClient('localhost:60000')
+client = capnp.TwoPartyClient('localhost:60000')
 
    
 
    
 
    
-
    Note
    
-
    You can also pass a raw socket with a fileno() method to TwoPartyClient
    
+
    Note
    
+
    You can also pass a raw socket with a fileno() method to TwoPartyClient
    
+
    
+
    
+
    Note
    
+
    This will not work with SSL/TLS, please see Starting a Client (asyncio)
    
 
    
 
    
-
    
-
    Restoring
    
-
    Before you do anything else, you will need to restore a capability from the server. Refer to the Cap’n Proto docs if you don’t know what this means:
    
-
    calculator = client.ez_restore('calculator').cast_as(calculator_capnp.Calculator)
+
    
+
    Starting a Client (asyncio)
    
+
    Asyncio takes a bit more boilerplate than using the socket wrapper, but it gives you a lot more control. The example here is very simplistic. Here’s an example of full error handling (with reconnection on server failure): hidio client.
    
+
    At a basic level, asyncio splits the input and output streams of the tcp socket and sends it to the libcapnp TwoWayPipe interface. An async reader Python function/method is used to consume the incoming byte stream and an async writer Python function/method is used to write outgoing bytes to the socket.
    
+
    
+
    Note
    
+
    You’ll need to be using the async keyword on some of the Python function/methods. If you’re unsure, look at the full example code. Also, read up on recent Python asyncio tutorials if you’re new to the concept. Make sure the tutorial is 3.7+, asyncio changed a lot from when it was first introduced in 3.4.
    
+
    
+
    First you’ll need two basic async functions:
    
+
    async def myreader(client, reader):
+    while True:
+        data = await reader.read(4096)
+        client.write(data)
+
+
+async def mywriter(client, writer):
+    while True:
+        data = await client.read(4096)
+        writer.write(data.tobytes())
+        await writer.drain()
 
    
 
    
-
    There’s two things worth noting here. First, we used the simpler ez_restore function. For servers that use a struct type as their Restorer, you will have to do the following instead:
    
-
    calculator = client.restore(calculator_capnp.MyStructType.new_message(foo='bar')).cast_as(calculator_capnp.Calculator)
+
    
+
    Note
    
+
    There’s no socket error handling here, so this won’t be sufficient for anything beyond a simple example.
    
+
    
+
    Next you’ll need to define an async function that sets up the socket connection. This is equivalent to client = capnp.TwoPartyClient(‘localhost:60000’) in the earlier example:
    
+
    async def main(host):
+    addr = 'localhost'
+    port = '6000'
+
+    # Handle both IPv4 and IPv6 cases
+    try:
+        print("Try IPv4")
+        reader, writer = await asyncio.open_connection(
+            addr, port,
+            family=socket.AF_INET
+        )
+    except Exception:
+        print("Try IPv6")
+        reader, writer = await asyncio.open_connection(
+            addr, port,
+            family=socket.AF_INET6
+        )
+
+    # Start TwoPartyClient using TwoWayPipe (takes no arguments in this mode)
+    client = capnp.TwoPartyClient()
+
+    # Assemble reader and writer tasks, run in the background
+    coroutines = [myreader(client, reader), mywriter(client, writer)]
+    asyncio.gather(*coroutines, return_exceptions=True)
+
+    ## Bootstrap Here ##
 
    
 
    
-
    Secondly, you see that we are casting the capability that we receive. This is because capabilities are intrinsically dynamic, and they hold no run time type information, so we need to pick what interface to interpret them as.
    
+
    
+
    Note
    
+
    On systems that have both IPv4 and IPv6 addresses, IPv6 is often resolved first and needs to be handled separately. If you’re certain IPv6 won’t be used, you can remove it (you should also avoid localhost, and stick to something like 127.0.0.1).
    
+
    
+
    Finally, you’ll need to start the asyncio function:
    
+
    if __name__ == '__main__':
+    asyncio.run(main(parse_args().host))
+
    
+
    
+
    
+
    Note
    
+
    This is the simplest way to start asyncio and usually not sufficient for most applications.
    
+
    
+
    
+
    SSL/TLS Client
    
+
    SSL/TLS setup effectively wraps the socket transport. You’ll need an SSL certificate, for this example we’ll be using a self-signed certificate. Most of the asyncio setup is the same as above:
    
+
    async def main(host):
+    addr = 'localhost'
+    port = '6000'
+
+    # Setup SSL context
+    ctx = ssl.create_default_context(ssl.Purpose.SERVER_AUTH, cafile=os.path.join(this_dir, 'selfsigned.cert'))
+
+    # Handle both IPv4 and IPv6 cases
+    try:
+        print("Try IPv4")
+        reader, writer = await asyncio.open_connection(
+            addr, port,
+            ssl=ctx,
+            family=socket.AF_INET
+        )
+    except Exception:
+        print("Try IPv6")
+        reader, writer = await asyncio.open_connection(
+            addr, port,
+            ssl=ctx,
+            family=socket.AF_INET6
+        )
+
+    # Start TwoPartyClient using TwoWayPipe (takes no arguments in this mode)
+    client = capnp.TwoPartyClient()
+
+    # Assemble reader and writer tasks, run in the background
+    coroutines = [myreader(client, reader), mywriter(client, writer)]
+    asyncio.gather(*coroutines, return_exceptions=True)
+
+    ## Bootstrap Here ##
+
    
+
    
+
    Due to a bug in Python 3.7 and 3.8 asyncio client needs to be initialized in a slightly different way:
    
+
    if __name__ == '__main__':
+    loop = asyncio.get_event_loop()
+    loop.run_until_complete(main(parse_args().host))
+
    
+
    
+
    
+
    
+
    
+
    Bootstrap
    
+
    Before calling any methods you’ll need to bootstrap the Calculator interface:
    
+
    calculator = client.bootstrap().cast_as(calculator_capnp.Calculator)
+
    
+
    
+
    There’s two things worth noting here. First, we are asking for the server capability. Secondly, you see that we are casting the capability that we receive. This is because capabilities are intrinsically dynamic, and they hold no run time type information, so we need to pick what interface to interpret them as.
    
 
    
 
    
 
    Calling methods
    
 
    There are 2 ways to call RPC methods. First the more verbose request syntax:
    
-
    request = calculator.evaluate_request()
+
    request = calculator.evaluate_request()
 request.expression.literal = 123
 eval_promise = request.send()
 
    
 
    
-
    This creates a request for the method named ‘evaluate’, sets expression.literal in that call’s parameters to 123, and then sends the request and returns a promise (all non-blocking).
    
+
    This creates a request for the method named ‘evaluate’, sets expression.literal in that call’s parameters to 123, and then sends the request and returns a promise (all non-blocking).
    
 
    The shorter syntax for calling methods is:
    
-
    eval_promise = calculator.evaluate({"literal": 123})
+
    eval_promise = calculator.evaluate({"literal": 123})
 
    
 
    
 
    The major shortcoming with this method is that expressing complex fields with many nested sub-structs can become very tedious.
    
 
    Once you have a promise, there are 2 ways of getting to the result. The first is to wait for it:
    
-
    result = eval_promise.wait()
+
    result = eval_promise.wait()
 
    
 
    
 
    The second is to build a promise chain by calling then:
    
-
    def do_stuff(val):
+
    def do_stuff(val):
     ...
 
 eval_promise.then(do_stuff).wait()
@@ -415,42 +544,191 @@ ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enum
 
    
 
    
 
    Pipelining
    
-
    If a method returns values that are themselves capabilites, then you can access these fields before having to call wait. Doing this is called pipelining, and it allows Cap’n Proto to chain the calls without a round-trip occurring to the server:
    
-
    # evaluate returns `value` which is itself an interface.
-# You can call a new method on `value` without having to call wait first
+
    If a method returns values that are themselves capabilites, then you can access these fields before having to call wait. Doing this is called pipelining, and it allows Cap’n Proto to chain the calls without a round-trip occurring to the server:
    
+
    # evaluate returns `value` which is itself an interface.
+# You can call a new method on `value` without having to call wait first
 read_promise = eval_promise.value.read()
-read_result = read_promise.wait() # only 1 wait call
+read_result = read_promise.wait() # only 1 wait call
 
    
 
    
 
    You can also chain promises with then and the same pipelining will occur:
    
-
    read_result = eval_promise.then(lambda ret: ret.value.read()).wait()
+
    read_result = eval_promise.then(lambda ret: ret.value.read()).wait()
 
    
 
    
 
    
 
    
 
    
 
    Server
    
+
    There are two ways to start a server: libcapnp socket wrapper and asyncio.
+The wrapper is easier to implement but is very limited (doesn’t support SSL/TLS with Python).
+asyncio requires more setup and can be harder to debug; however, it does support SSL/TLS and has more control over the socket error conditions. asyncio also helps get around the threading limitations around the current pycapnp implementation has with libcapnp (pycapnp objects and functions must all be in the same thread). The asyncio Server is a bit more work to implement than an asyncio client as more error handling is required to deal with client connection/disconnection/timeout events.
    
 
    
 
    Starting a Server
    
-
    
-
    server = capnp.TwoPartyServer(‘*:60000’, restore)
    
-
    server.run_forever()
    
-
    
-
    See the Restore section for an explanation of what the restore object needs to looks like.
    
+
    To start a server:
    
+
    server = capnp.TwoPartyServer('*:60000', bootstrap=CalculatorImpl())
+server.run_forever()
+
    
+
    
 
    
-
    Note
    
-
    You can also pass a raw socket with a fileno() method to TwoPartyServer. In that case, run_forever will not work, and you will have to use on_disconnect.wait().
    
+
    Note
    
+
    You can also pass a raw socket with a fileno() method to TwoPartyServer. In that case, run_forever will not work, and you will have to use on_disconnect.wait().
    
+
    
+
    
+
    Note
    
+
    This will not work with SSL/TLS, please see Starting a Server (asyncio)
    
+
    
+
    
+
    
+
    Starting a Server (asyncio)
    
+
    Like the asyncio client, an asyncio server takes a bunch of boilerplate as opposed to using the socket wrapper. Servers generally have to handle a lot more error conditions than clients so they are generally more complicated to implement with asyncio.
    
+
    Just like the asyncio client, both the input and output socket streams are handled by reader/writer callback functions/methods.
    
+
    
+
    Note
    
+
    You’ll need to be using the async keyword on some of the Python function/methods. If you’re unsure, look at the full example code. Also, read up on recent Python asyncio tutorials if you’re new to the concept. Make sure the tutorial is 3.7+, asyncio changed a lot from when it was first introduced in 3.4.
    
+
    
+
    To simplify the callbacks use a server class to define the reader/writer callbacks.:
    
+
    class Server:
+    async def myreader(self):
+        while self.retry:
+            try:
+                # Must be a wait_for so we don't block on read()
+                data = await asyncio.wait_for(
+                    self.reader.read(4096),
+                    timeout=0.1
+                )
+            except asyncio.TimeoutError:
+                print("myreader timeout.")
+                continue
+            except Exception as err:
+                print("Unknown myreader err: %s", err)
+                return False
+            await self.server.write(data)
+        print("myreader done.")
+        return True
+
+    async def mywriter(self):
+        while self.retry:
+            try:
+                # Must be a wait_for so we don't block on read()
+                data = await asyncio.wait_for(
+                    self.server.read(4096),
+                    timeout=0.1
+                )
+                self.writer.write(data.tobytes())
+            except asyncio.TimeoutError:
+                print("mywriter timeout.")
+                continue
+            except Exception as err:
+                print("Unknown mywriter err: %s", err)
+                return False
+        print("mywriter done.")
+        return True
+
    
+
    
+
    We need an additional myserver() method in the Server class to handle each of the incoming socket connections:
    
+
    async def myserver(self, reader, writer):
+    # Start TwoPartyServer using TwoWayPipe (only requires bootstrap)
+    self.server = capnp.TwoPartyServer(bootstrap=CalculatorImpl())
+    self.reader = reader
+    self.writer = writer
+    self.retry = True
+
+    # Assemble reader and writer tasks, run in the background
+    coroutines = [self.myreader(), self.mywriter()]
+    tasks = asyncio.gather(*coroutines, return_exceptions=True)
+
+    while True:
+        self.server.poll_once()
+        # Check to see if reader has been sent an eof (disconnect)
+        if self.reader.at_eof():
+            self.retry = False
+            break
+        await asyncio.sleep(0.01)
+
+    # Make wait for reader/writer to finish (prevent possible resource leaks)
+    await tasks
+
    
+
    
+
    Finally, we’ll need to start an asyncio server to spawn a new async myserver() with it’s own Server() object for each new connection:
    
+
    async def new_connection(reader, writer):
+    server = Server()
+    await server.myserver(reader, writer)
+
+async def main():
+    addr = 'localhost'
+    port = '60000'
+
+    # Handle both IPv4 and IPv6 cases
+    try:
+        print("Try IPv4")
+        server = await asyncio.start_server(
+            new_connection,
+            addr, port,
+            family=socket.AF_INET
+        )
+    except Exception:
+        print("Try IPv6")
+        server = await asyncio.start_server(
+            new_connection,
+            addr, port,
+            family=socket.AF_INET6
+        )
+
+    async with server:
+        await server.serve_forever()
+
+if __name__ == '__main__':
+    asyncio.run(main())
+
    
+
    
+
    
+
    Note
    
+
    On systems that have both IPv4 and IPv6 addresses, IPv6 is often resolved first and needs to be handled separately. If you’re certain IPv6 won’t be used, you can remove it (you should also avoid localhost, and stick to something like 127.0.0.1). If you’re broadcasting in general, you’ll probably want to use 0.0.0.0 (IPv4) or ::/0 (IPv6).
    
+
    
+
    
+
    SSL/TLS Server
    
+
    Adding SSL/TLS support for a pycapnp asyncio server is fairly straight-forward. Just create an SSL context before starting the asyncio server:
    
+
    async def main():
+    addr = 'localhost'
+    port = '60000'
+
+    # Setup SSL context
+    ctx = ssl.create_default_context(ssl.Purpose.CLIENT_AUTH)
+    ctx.load_cert_chain(os.path.join(this_dir, 'selfsigned.cert'), os.path.join(this_dir, 'selfsigned.key'))
+
+    # Handle both IPv4 and IPv6 cases
+    try:
+        print("Try IPv4")
+        server = await asyncio.start_server(
+            new_connection,
+            addr, port,
+            ssl=ctx,
+            family=socket.AF_INET
+        )
+    except Exception:
+        print("Try IPv6")
+        server = await asyncio.start_server(
+            new_connection,
+            addr, port,
+            ssl=ctx,
+            family=socket.AF_INET6
+        )
+
+    async with server:
+        await server.serve_forever()
+
    
+
    
 
    
 
    
 
    
 
    Implementing a Server
    
-
    Here’s a part of how you would implement a Calculator server:
    
-
    class CalculatorImpl(calculator_capnp.Calculator.Server):
+
    Here’s a part of how you would implement a Calculator server:
    
+
    class CalculatorImpl(calculator_capnp.Calculator.Server):
 
-    "Implementation of the Calculator Cap'n Proto interface."
+    "Implementation of the Calculator Cap'n Proto interface."
 
     def evaluate(self, expression, _context, **kwargs):
-        return evaluate_impl(expression).then(lambda value: setattr(_context.results, 'value', ValueImpl(value)))
+        return evaluate_impl(expression).then(lambda value: setattr(_context.results, 'value', ValueImpl(value)))
 
     def defFunction_context(self, context):
         params = context.params
@@ -462,121 +740,92 @@ ValueError: src/capnp/schema.c++:326: requirement not met: enum has no such enum
 
    
 
    Some major things worth noting.
    
 
      
-
    • You must inherit from your_module_capnp.YourInterface.Server, but don’t worry about calling __super__ in your __init__
      
-
      • 
-
    • Method names of your class must either match the interface exactly, or have ‘_context’ appended to it
      
-
      • 
-
    • If your method name is exactly the same as the interface, then you will be passed all the arguments from the interface as keyword arguments, so your argument names must match the interface spec exactly. You will also receive a _context parameter which is equivalent to the C++ API’s Context. I highly recommend having **kwargs as well, so that even if your interface spec is upgraded and arguments were added, your server will still operate fine.
      
-
      • 
-
    • Returns work with a bit of magic as well. If you return a promise, then it will be handled the same as if you returned a promise from a server method in the C++ API. Otherwise, your return statement will be filled into the results struct following the ordering in your spec, for example:
      
-
      # capability.capnp file
-interface TestInterface {
-  foo @0 (i :UInt32, j :Bool) -> (x: Text, i:UInt32);
-}
+
    • You must inherit from your_module_capnp.YourInterface.Server, but don’t worry about calling __super__ in your __init__
      • 
+
    • Method names of your class must either match the interface exactly, or have ‘_context’ appended to it
      • 
+
    • If your method name is exactly the same as the interface, then you will be passed all the arguments from the interface as keyword arguments, so your argument names must match the interface spec exactly. You will also receive a _context parameter which is equivalent to the C++ API’s Context. I highly recommend having **kwargs as well, so that even if your interface spec is upgraded and arguments were added, your server will still operate fine.
      • 
+
    • Returns work with a bit of magic as well. If you return a promise, then it will be handled the same as if you returned a promise from a server method in the C++ API. Otherwise, your return statement will be filled into the results struct following the ordering in your spec, for example:
      
+
      # capability.capnp file
+interface TestInterface {
+  foo @0 (i :UInt32, j :Bool) -> (x: Text, i:UInt32);
+}
 
-# python code
-class TestInterface(capability_capnp.TestInterface.Server):
-    def foo(self, i, j, **kwargs):
-        return str(j), i
+# python code
+class TestInterface(capability_capnp.TestInterface.Server):
+    def foo(self, i, j, **kwargs):
+        return str(j), i
 
      
 
      
 
      • 
-
    • If your method ends in _context, then you will only be passed a context parameter. You will have to access params and set results yourself manually. Returning promises still works as above, but you can’t return anything else from a method.
      
-
      • 
+
    • If your method ends in _context, then you will only be passed a context parameter. You will have to access params and set results yourself manually. Returning promises still works as above, but you can’t return anything else from a method.
      • 
 
    
 
    
-
    
-
    Restore
    
-
    Restoring can occur in either a class:
    
-
    class SimpleRestorer(test_capability_capnp.TestSturdyRefObjectId.Restorer):
-
-    def restore(self, ref_id):
-        if ref_id.tag == 'testInterface':
-            return Server(100)
-        else:
-            raise Exception('Unrecognized ref passed to restore')
-
-...
-
-server = capnp.TwoPartyServer(sock, SimpleRestorer())
-
    
-
    
-
    Where you inherit from StructType.Restorer, and the argument passed to restore will be cast to the proper type.
    
-
    Otherwise, restore can be a function:
    
-
    def restore(ref_id):
-    if ref_id.as_struct(test_capability_capnp.TestSturdyRefObjectId).tag == 'testInterface':
-        return Server(100)
-    else:
-        raise Exception('Unrecognized ref passed to restore')
-
-...
-
-server = capnp.TwoPartyServer(sock, restore)
-
    
-
    
-
    
 
    
 
    
 
    
 
    Full Examples
    
-
    Full examples are available on github. There is also an example of a very simplistic RPC available in test_rpc.py.
    
+
    Full examples are available on github. There is also an example of a very simplistic RPC available in test_rpc.py.
    
 
    
 
    
 
 
+            
    
           
    
         
    
       
    
-      
    
+      
-    
    
+    
-    
    
-        © Copyright 2013, Author.
-      Created using Sphinx 1.2.3.
+    
   
 
\ No newline at end of file
diff --git a/search.html b/search.html
index bbf8f60..a4b0817 100644
--- a/search.html
+++ b/search.html
@@ -1,40 +1,27 @@
-
 
+
 
-
+
   
-    
-    
-    Search — capnp 0.5.4 documentation
-    
+    
+    
+    Search — capnp 1.0.0b2 documentation
     
     
     
-    
-    
-    
-    
-    
-    
-  
-  
-  
+    
+    
+    
+    
+    
+    
+    
+    
+  
    
 
-  
-  
-    
    
+  
+      
 
     
    
       
    
         
    
-          
    
+          
    
             
   
    Search
    
   
    
-  
+  
   
    
     Please activate JavaScript to enable the search
     functionality.
   
    
   
    
   
    
-    From here you can search these documents. Enter your search
-    words into the box below and click "search". Note that the search
-    function will automatically search for all of the words. Pages
-    containing fewer words won't appear in the result list.
+    Searching for multiple words only shows matches that contain
+    all words.
   
    
   
    
-    
+    
     
     
   
    
@@ -76,16 +62,24 @@
   
   
    
 
+            
    
           
    
         
    
       
    
-      
    
+      
       
    
     
    
-    
    
+    
-    
    
-        © Copyright 2013, Author.
-      Created using Sphinx 1.2.3.
+    
   
 
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
index 1abcaa6..7707b76 100644
--- a/searchindex.js
+++ b/searchindex.js
@@ -1 +1 @@
-Search.setIndex({envversion:42,terms:{all:[1,2,3],concept:1,chain:1,queri:1,global:3,my_dict:1,interchang:[0,1],secondli:1,selfemploi:1,code:1,abil:3,follow:[1,2,3],cython:2,"const":0,readabl:3,send:1,init:[1,3],under:1,must:[1,3],worth:1,dynamicvalu:3,"case":1,num_first_segment_word:3,sourc:0,everi:1,string:[0,3],fals:3,"void":[1,3],nesting_limit:3,failur:3,veri:1,affect:3,tri:1,school:1,foo:[1,3],magic:1,level:3,list:[0,3],iter:3,"try":1,item:3,calculatorimpl:1,round:1,pleas:1,join_promis:3,is_consum:3,"_context":1,promisefulfillerpair:3,natur:3,seper:0,ref_id:1,second:1,pass:[1,3],to_bytes_pack:[1,3],port:3,append:1,even:[1,3],index:[0,3],what:[0,1,2,3],sub:1,defin:[1,3],section:1,advanc:1,"while":1,overload:3,access:[1,3],version:[1,2,3],yourinterfac:1,"new":[0,3],method:[0,3],thin:[0,1],full:0,themselv:1,newmessag:3,valueimpl:1,addressbook_capnp:[1,3],gener:1,never:3,here:[0,1],remove_import_hook:[1,3],met:1,shouldn:1,let:1,address:[1,3],path:[1,3],becom:1,sinc:[0,3],interpret:1,wait:[1,3],search:[0,3],upcast:3,paramcount:1,behav:1,pick:1,implement:0,writer:3,"_write_message_to_fd":3,primit:[0,3],moduletyp:3,ask:2,"boolean":1,instal:0,total:3,mobil:[1,3],schemapars:3,additional_path:3,from:[0,3],tar:2,would:1,memori:1,"_structschema":3,two:1,call:[0,3],recommend:1,type:[0,3],more:1,peopl:[1,3],benchmark:0,uint8:1,notic:1,phone:[1,3],flag:2,actual:[1,3],hold:1,unpack:3,easiest:2,"_dynamiclistbuild":3,uint64:1,none:[1,3],word:3,operatorimpl:1,restor:[0,3],"_voidpromis":3,setup:2,alic:[1,3],dev:2,spec:1,other:3,write_pack:[1,3],kwarg:[1,3],can:[0,1,2,3],caveat:1,root:3,read_multiple_byt:3,def:1,control:2,quickstart:[0,2],objectid:3,sudo:2,liter:1,want:[1,2],serial:[0,3],unsign:1,occur:1,deffunction_context:1,risk:1,alwai:1,gcc:2,end:[1,3],quot:0,write:[0,3],how:[1,3],sever:3,pure:0,instead:[1,3],int16:1,"_dynamicenumfield":3,clone:2,after:[2,3],reflect:3,befor:[1,2,3],numpar:3,mai:3,data:[0,1,3],grow:3,alloc:[1,3],"short":0,light:1,bootstrap:3,correspond:[1,3],assign:1,caus:3,inform:1,environ:2,allow:[1,3],first:[1,2,3],order:[1,3],origin:3,elif:1,ez_restor:[1,3],over:[1,3],becaus:1,through:[1,2],twopartyserv:[1,3],still:[1,3],mainli:3,dynam:[1,3],paramet:[1,3],member:[1,3],disconnect:3,contstruct:1,better:3,carri:3,complex:1,dynamiclist:3,non:[1,3],"float":[1,3],"return":[1,3],"__getitem__":3,python:[0,1,2,3],initi:[0,3],"_dynamicstructbuild":3,promis:[1,3],alicephon:[1,3],now:1,name:[1,3],anyth:[1,3],revers:1,modules_by_id:3,easili:2,new_messag:[1,3],unicod:1,simplerestor:1,from_object:3,mean:[1,3],compil:[0,2],as_struct:1,jparyani:2,replac:3,addressbook:[1,3],idea:1,"_dynamicorphan":3,realli:1,expect:1,happen:1,evaluate_impl:1,extract:1,out:[1,3],variabl:[1,2],as_build:3,shown:1,space:[1,3],newli:3,ret:1,content:[0,3],rel:3,inaccess:3,print:[1,3],unrecogn:1,ref:1,uint32:1,file_nam:3,insid:[1,3],phonenumb:1,textid:3,qux:[1,3],teststurdyrefobjectid:1,infin:0,ineffici:3,error_func:3,"__setitem__":3,base:0,eval_promis:1,dictionari:0,releas:3,org:2,"byte":[0,3],do_stuff:1,care:3,add_import_hook:3,wai:[1,2],unnam:1,traceback:1,thing:1,length:1,isn:[1,3],onto:3,think:0,lambda:1,oper:[1,3],major:1,"_structmodul":3,directli:[0,3],feel:2,onc:[1,2,3],number:[1,3],yourself:[1,3],capnproto:[2,3],instruct:1,alreadi:1,done:[1,2],wrapper:[1,3],open:[1,3],size:[1,3],avail:[0,1],differ:[1,3],convent:3,zxf:2,"0x934efea7f017fff0":1,unknown:3,top:[1,3],system:[0,2,3],messag:[0,3],attach:3,master:2,statement:1,similarli:1,conveni:[1,3],schema:[0,3],calculator_capnp:1,copi:3,setuptool:2,from_byt:[1,3],github:[0,1,2],pars:3,mostli:3,off:3,exactli:1,than:[0,1,2],simplist:[0,1],target:2,setattr:[1,3],bulder:3,remov:3,structur:1,str:[1,3],were:1,uint64_t:3,typic:3,mind:1,argument:[1,3],as_read:3,have:[1,2,3],need:[0,1,2,3],element:[1,3],seek:1,reverse_map:3,equival:[1,3],efficient:1,self:[1,3],client:[0,3],note:[1,3],also:[0,1,3],without:[0,1],take:[2,3],which:[1,3],int64:1,mit:1,singl:1,"_capabilitycli":3,begin:3,sure:[1,3],unless:3,normal:[1,3],buffer:[0,3],object:[0,3],on_disconnect:[1,3],from_bytes_pack:[1,3],functionimpl:1,cap:[0,3],segment:3,don:[1,3],doc:[0,1,2],clear:1,adopt:3,request:[1,2],part:1,determin:1,fact:0,show:1,text:1,test_capability_capnp:1,syntax:[1,3],"__super__":1,fine:1,find:1,absolut:3,onli:[1,2,3],mystructtyp:1,"true":3,configur:2,activ:1,written:3,should:[1,3],dict:3,rich:1,growabl:3,meant:3,unus:3,get:[1,2,3],init_resizable_list:3,express:1,pypi:0,clang:2,repo:[0,2],requir:[1,2],"_dynamicstructread":3,fileno:[1,3],bar:[1,3],keyword:[1,3],intrins:1,"_dynamicresizablelistbuild":3,bad:1,to_dict:[1,3],contain:[1,3],grab:1,where:1,valid:3,wrote:1,set:[1,3],shortcom:1,orphan:3,"_dynamiccapabilitycli":3,see:1,result:1,arg:3,fail:3,close:3,read_multipl:[1,3],hopefulli:1,enumer:1,getattr:3,weird:1,"import":[1,3],bunch:3,email:[1,3],parent:3,run_forev:[1,3],encoded_messag:1,lazi:2,addit:3,both:[0,1],last:1,float64:1,context:1,capnp:[0,1,3],mani:[1,3],unemploi:1,com:[1,2,3],load:[0,3],unimpl:3,point:1,hyphen:3,ubuntu:2,alice2:1,test_rpc:1,header:2,shortcut:[1,3],ioerror:3,cancel:3,respect:3,assum:1,read_promis:1,creat:1,union:[0,3],decent:0,twopartycli:[1,3],been:3,compon:1,"_interfaceschema":3,json:0,much:[1,3],kjexcept:3,valu:[0,3],basic:1,thrift:0,valueerror:1,"__len__":3,blob:1,capabilit:1,given:[1,3],convert:1,ani:[2,3],understand:1,doesn:3,func:[1,3],insan:0,those:1,emploi:1,multi:0,look:[1,2],raw:1,straight:[1,3],properti:3,"_dynamiclistread":3,employ:1,cast:[1,3],calcul:1,match:[1,3],abov:1,kentonv:2,pack:[1,3],bin:[1,3],increment:3,almost:3,read_multiple_pack:[1,3],them:1,worri:[1,3],pip:0,itself:1,tediou:1,"__init__":1,develop:0,thei:1,proto:[0,3],receiv:1,make:[0,1,2,3],same:1,check:2,shorter:1,binari:[0,3],pytest:2,fill:[1,3],finish:3,http:2,nest:1,upon:3,capabl:[0,1],rais:[1,3],student:1,disown:3,chang:3,recent:1,travers:3,testinterfac:1,lib:3,older:2,well:[1,3],inherit:[0,1],person:[1,3],exampl:[0,3],command:2,thi:[0,1,2,3],latest:2,explan:1,protocol:[0,1],just:[0,1,3],"_write_packed_message_to_fd":3,previous:3,display_nam:3,struct:[1,3],easi:1,dynamicstruct:3,except:[0,1,3],param:1,add:[1,3],uint16:1,traversal_limit_in_word:3,capability_capnp:1,els:1,float32:1,build:[0,3],real:3,int32:1,format:[0,3],read:[0,3],to_byt:[1,3],server_socket:3,apt:2,bit:1,like:[0,1,2,3],specif:1,deprec:3,manual:1,html:2,integ:1,server:0,from_dict:3,channel:1,hook:[1,3],page:0,depend:1,fulfil:3,some:[0,1,2,3],pipelin:0,proper:1,guarante:1,librari:[0,3],"__setattr__":3,redo:2,though:1,"__getattr__":3,total_s:3,port_promis:3,localhost:1,either:1,previou:1,run:[1,2],"enum":[0,3],usag:3,is_root:3,step:0,repositori:1,"_interfacemodul":3,simpler:1,src:1,about:[1,3],obj:3,socket:[1,3],most:1,mergabl:2,constructor:1,disabl:1,block:1,getoper:1,own:3,cflag:2,pythonpath:1,basenam:3,within:1,tag:1,automat:[1,3],upgrad:1,wrap:[0,1,3],your:[1,3],durabl:3,git:2,val:1,cast_a:[1,3],aren:2,support:[2,3],read_result:1,bodi:1,read_pack:[1,3],fast:0,verbos:[1,3],start:0,my_field:3,interfac:[1,3],lot:0,highli:1,treat:[1,3],properli:3,form:1,handl:1,your_module_capnp:1,line:[2,3],buf:3,int8:1,pull:2,made:3,"default":3,checkout:2,below:[1,2,3],structtyp:1,limit:3,otherwis:1,problem:[1,3],similar:1,read_multiple_bytes_pack:3,featur:1,constant:3,evalu:1,"int":3,parser:3,proven:0,descriptor:1,exist:3,file:[0,3],home:1,thinli:3,bob:1,curl:2,work:[1,3],trip:1,probabl:2,know:[1,3],sequenti:1,when:[1,3],invalid:[1,3],prepend:3,field:[0,3],book:1,bool:[1,3],futur:1,branch:2,test:2,you:[1,2,3],deseri:0,time:[0,1,3],initii:3,meaning:3,debian:2,evaluate_request:1,faster:0,sock:1,directori:[0,1,3],descript:[0,3],tricki:1,leak:[1,3],far:2},objtypes:{"0":"py:module","1":"py:method","2":"py:attribute","3":"py:class","4":"py:function"},objnames:{"0":["py","module","Python module"],"1":["py","method","Python method"],"2":["py","attribute","Python attribute"],"3":["py","class","Python class"],"4":["py","function","Python function"]},filenames:["index","quickstart","install","capnp"],titles:["Welcome to pycapnp’s documentation!","Quickstart","Installation","API Reference"],objects:{"":{capnp:[3,0,0,"-"]},"capnp.TwoPartyClient":{restore:[3,1,1,""],bootstrap:[3,1,1,""],ez_restore:[3,1,1,""],on_disconnect:[3,1,1,""]},"capnp.Promise":{cancel:[3,1,1,""],then:[3,1,1,""],wait:[3,1,1,""],is_consumed:[3,2,1,""],attach:[3,1,1,""]},"capnp._DynamicStructReader":{as_builder:[3,1,1,""],total_size:[3,2,1,""],is_root:[3,2,1,""],to_dict:[3,1,1,""],which:[3,2,1,""],schema:[3,2,1,""]},"capnp.TwoPartyServer":{on_disconnect:[3,1,1,""],port_promise:[3,2,1,""],run_forever:[3,1,1,""],port:[3,2,1,""]},"capnp._StructModule":{read_multiple_bytes_packed:[3,1,1,""],read_multiple:[3,1,1,""],new_message:[3,1,1,""],from_bytes_packed:[3,1,1,""],read:[3,1,1,""],read_multiple_packed:[3,1,1,""],from_dict:[3,1,1,""],read_packed:[3,1,1,""],read_multiple_bytes:[3,1,1,""],from_object:[3,1,1,""],from_bytes:[3,1,1,""]},"capnp._DynamicOrphan":{get:[3,1,1,""]},"capnp._DynamicListBuilder":{disown:[3,1,1,""],adopt:[3,1,1,""]},"capnp._DynamicCapabilityClient":{cast_as:[3,1,1,""],upcast:[3,1,1,""],schema:[3,2,1,""]},"capnp.PromiseFulfillerPair":{fulfill:[3,1,1,""],promise:[3,2,1,""],is_consumed:[3,2,1,""]},"capnp.SchemaParser":{load:[3,1,1,""],modules_by_id:[3,2,1,""]},"capnp._DynamicStructBuilder":{is_root:[3,2,1,""],to_bytes:[3,1,1,""],init_resizable_list:[3,1,1,""],to_bytes_packed:[3,1,1,""],adopt:[3,1,1,""],from_dict:[3,1,1,""],write:[3,1,1,""],total_size:[3,2,1,""],init:[3,1,1,""],as_reader:[3,1,1,""],write_packed:[3,1,1,""],to_dict:[3,1,1,""],which:[3,2,1,""],disown:[3,1,1,""],copy:[3,1,1,""],schema:[3,2,1,""]},capnp:{"_DynamicStructReader":[3,3,1,""],"_DynamicCapabilityClient":[3,3,1,""],"_DynamicStructBuilder":[3,3,1,""],join_promises:[3,4,1,""],PromiseFulfillerPair:[3,3,1,""],"_CapabilityClient":[3,3,1,""],load:[3,4,1,""],"_InterfaceModule":[3,3,1,""],"_DynamicListBuilder":[3,3,1,""],KjException:[3,3,1,""],"_DynamicOrphan":[3,3,1,""],"_StructModule":[3,3,1,""],add_import_hook:[3,4,1,""],SchemaParser:[3,3,1,""],Promise:[3,3,1,""],TwoPartyServer:[3,3,1,""],remove_import_hook:[3,4,1,""],TwoPartyClient:[3,3,1,""],"_DynamicListReader":[3,3,1,""],"_DynamicResizableListBuilder":[3,3,1,""]},"capnp._DynamicResizableListBuilder":{add:[3,1,1,""],finish:[3,1,1,""]},"capnp.KjException.Type":{DISCONNECTED:[3,2,1,""],reverse_mapping:[3,2,1,""],OVERLOADED:[3,2,1,""],FAILED:[3,2,1,""],OTHER:[3,2,1,""],UNIMPLEMENTED:[3,2,1,""]},"capnp._CapabilityClient":{cast_as:[3,1,1,""]},"capnp.KjException":{description:[3,2,1,""],type:[3,2,1,""],args:[3,2,1,""],file:[3,2,1,""],line:[3,2,1,""],Type:[3,3,1,""],message:[3,2,1,""]}},titleterms:{load:1,"function":3,quickstart:1,primit:1,modul:3,indic:0,rpc:[1,3],api:3,file:1,tabl:0,pip:2,instal:2,pycapnp:0,serial:1,librari:2,"const":1,miscellan:3,proto:[1,2],union:1,develop:2,method:1,messag:1,write:1,field:1,client:1,call:1,build:1,reader:3,"new":1,document:0,type:1,start:1,refer:3,deseri:1,pipelin:1,sourc:2,string:1,read:1,"enum":1,initi:1,buffer:1,dictionari:1,from:[1,2],"byte":1,"class":3,valu:1,welcom:0,multi:1,full:1,restor:1,builder:3,cap:[1,2],list:1,intern:3,object:1,server:1,exampl:1,implement:1,schema:1}})
\ No newline at end of file
+Search.setIndex({docnames:["capnp","index","install","quickstart"],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.ext.intersphinx":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["capnp.rst","index.rst","install.rst","quickstart.rst"],objects:{"":{capnp:[0,0,0,"-"]},"capnp.KjException":{Type:[0,1,1,""],args:[0,2,1,""],description:[0,3,1,""],file:[0,3,1,""],line:[0,3,1,""],type:[0,3,1,""],with_traceback:[0,3,1,""]},"capnp.KjException.Type":{DISCONNECTED:[0,2,1,""],FAILED:[0,2,1,""],OTHER:[0,2,1,""],OVERLOADED:[0,2,1,""],UNIMPLEMENTED:[0,2,1,""],reverse_mapping:[0,2,1,""]},"capnp.PromiseFulfillerPair":{fulfill:[0,3,1,""],is_consumed:[0,2,1,""],promise:[0,2,1,""]},"capnp.SchemaParser":{load:[0,3,1,""],modules_by_id:[0,2,1,""]},"capnp.TwoPartyClient":{bootstrap:[0,3,1,""],on_disconnect:[0,3,1,""],read:[0,3,1,""],write:[0,3,1,""]},"capnp.TwoPartyServer":{bootstrap:[0,3,1,""],on_disconnect:[0,3,1,""],poll_forever:[0,3,1,""],poll_once:[0,3,1,""],port:[0,2,1,""],port_promise:[0,2,1,""],read:[0,3,1,""],run_forever:[0,3,1,""],write:[0,3,1,""]},"capnp._CapabilityClient":{cast_as:[0,3,1,""]},"capnp._DynamicCapabilityClient":{cast_as:[0,3,1,""],schema:[0,2,1,""],upcast:[0,3,1,""]},"capnp._DynamicListBuilder":{adopt:[0,3,1,""],disown:[0,3,1,""],init:[0,3,1,""]},"capnp._DynamicOrphan":{get:[0,3,1,""]},"capnp._DynamicResizableListBuilder":{add:[0,3,1,""],finish:[0,3,1,""]},"capnp._DynamicStructBuilder":{adopt:[0,3,1,""],as_reader:[0,3,1,""],clear_write_flag:[0,3,1,""],copy:[0,3,1,""],disown:[0,3,1,""],from_dict:[0,3,1,""],init:[0,3,1,""],init_resizable_list:[0,3,1,""],is_root:[0,2,1,""],schema:[0,2,1,""],to_bytes:[0,3,1,""],to_bytes_packed:[0,3,1,""],to_dict:[0,3,1,""],to_segments:[0,3,1,""],total_size:[0,2,1,""],which:[0,2,1,""],write:[0,3,1,""],write_packed:[0,3,1,""]},"capnp._DynamicStructReader":{as_builder:[0,3,1,""],is_root:[0,2,1,""],schema:[0,2,1,""],to_dict:[0,3,1,""],total_size:[0,2,1,""],which:[0,2,1,""]},"capnp._MallocMessageBuilder":{get_root:[0,3,1,""],get_root_as_any:[0,3,1,""],get_segments_for_output:[0,3,1,""],init_root:[0,3,1,""],new_orphan:[0,3,1,""],set_root:[0,3,1,""]},"capnp._PackedFdMessageReader":{get_root:[0,3,1,""],get_root_as_any:[0,3,1,""]},"capnp._StreamFdMessageReader":{get_root:[0,3,1,""],get_root_as_any:[0,3,1,""]},"capnp._StructModule":{from_bytes:[0,3,1,""],from_bytes_packed:[0,3,1,""],from_segments:[0,3,1,""],new_message:[0,3,1,""],read:[0,3,1,""],read_multiple:[0,3,1,""],read_multiple_bytes:[0,3,1,""],read_multiple_bytes_packed:[0,3,1,""],read_multiple_packed:[0,3,1,""],read_packed:[0,3,1,""]},"capnp.lib.capnp":{_DynamicCapabilityClient:[0,1,1,""],_Promise:[0,1,1,""],_RemotePromise:[0,1,1,""],_Response:[0,1,1,""],_VoidPromise:[0,1,1,""]},"capnp.lib.capnp._DynamicCapabilityClient":{cast_as:[0,3,1,""],schema:[0,2,1,""],upcast:[0,3,1,""]},"capnp.lib.capnp._Promise":{attach:[0,3,1,""],cancel:[0,3,1,""],is_consumed:[0,2,1,""],then:[0,3,1,""],wait:[0,3,1,""]},"capnp.lib.capnp._RemotePromise":{a_wait:[0,3,1,""],as_pypromise:[0,3,1,""],cancel:[0,3,1,""],is_consumed:[0,2,1,""],schema:[0,2,1,""],then:[0,3,1,""],to_dict:[0,3,1,""],wait:[0,3,1,""]},"capnp.lib.capnp._Response":{as_builder:[0,3,1,""],is_root:[0,2,1,""],schema:[0,2,1,""],to_dict:[0,3,1,""],total_size:[0,2,1,""],which:[0,2,1,""]},"capnp.lib.capnp._VoidPromise":{as_pypromise:[0,3,1,""],attach:[0,3,1,""],cancel:[0,3,1,""],is_consumed:[0,2,1,""],then:[0,3,1,""],wait:[0,3,1,""]},capnp:{KjException:[0,1,1,""],Promise:[0,2,1,""],PromiseFulfillerPair:[0,1,1,""],SchemaParser:[0,1,1,""],TwoPartyClient:[0,1,1,""],TwoPartyServer:[0,1,1,""],_CapabilityClient:[0,1,1,""],_DynamicCapabilityClient:[0,1,1,""],_DynamicListBuilder:[0,1,1,""],_DynamicListReader:[0,1,1,""],_DynamicOrphan:[0,1,1,""],_DynamicResizableListBuilder:[0,1,1,""],_DynamicStructBuilder:[0,1,1,""],_DynamicStructReader:[0,1,1,""],_InterfaceModule:[0,1,1,""],_MallocMessageBuilder:[0,1,1,""],_PackedFdMessageReader:[0,1,1,""],_StreamFdMessageReader:[0,1,1,""],_StructModule:[0,1,1,""],add_import_hook:[0,4,1,""],cleanup_global_schema_parser:[0,4,1,""],create_event_loop:[0,4,1,""],getTimer:[0,4,1,""],join_promises:[0,4,1,""],load:[0,4,1,""],poll_once:[0,4,1,""],remove_event_loop:[0,4,1,""],remove_import_hook:[0,4,1,""],reset_event_loop:[0,4,1,""],wait_forever:[0,4,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","attribute","Python attribute"],"3":["py","method","Python method"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:attribute","3":"py:method","4":"py:function"},terms:{"0b1":2,"0x934efea7f017fff0":3,"boolean":3,"break":3,"byte":[0,1],"case":[2,3],"class":[1,3],"const":1,"default":0,"enum":[0,1],"final":3,"float":[0,3],"function":[1,3],"import":[0,3],"int":0,"new":[0,1],"return":[0,3],"short":1,"true":[0,3],"try":3,"void":[0,3],"while":3,Adding:3,And:[2,3],Doing:3,For:[0,2,3],One:3,The:[0,2,3],Then:3,There:[0,3],These:[0,2],Use:0,Useful:2,Will:0,__getattr__:0,__getitem__:0,__init__:3,__len__:0,__main__:3,__name__:3,__setattr__:0,__setitem__:0,__super__:3,__traceback__:0,_capabilitycli:0,_context:3,_dynamiccapabilitycli:0,_dynamicenumfield:0,_dynamiclistbuild:0,_dynamiclistread:0,_dynamicobjectbuild:0,_dynamicobjectread:0,_dynamicorphan:0,_dynamicresizablelistbuild:0,_dynamicstructbuild:0,_dynamicstructread:0,_interfacemodul:0,_interfaceschema:0,_is_written:0,_mallocmessagebuild:0,_messagebuild:0,_packedfdmessageread:0,_promis:0,_remotepromis:0,_respons:0,_streamfdmessageread:0,_structmodul:0,_structschema:0,_voidpromis:0,_write_message_to_fd:0,_write_packed_message_to_fd:0,a_wait:0,abil:0,about:[0,3],abov:3,absolut:0,access:[0,3],activ:3,actual:[0,3],add:[0,3],add_import_hook:0,added:[0,3],adding:0,addit:[0,3],additional_path:0,addr:3,address:[0,3],addressbook:[0,3],addressbook_capnp:[0,3],adopt:0,advanc:[0,3],advantag:3,advic:3,af_inet6:3,af_inet:3,affect:0,after:0,again:3,alia:0,alic:[0,3],alice2:3,alicephon:[0,3],all:[0,2,3],alloc:[0,3],allow:[0,3],almost:0,alreadi:[0,3],also:[0,1,2,3],alwai:3,analag:0,ani:[0,3],anypoint:0,anyth:[0,3],api:[1,3],append:3,applic:3,archiv:2,arena:0,arg:0,argument:[0,2,3],around:3,arrai:3,as_build:0,as_pypromis:0,as_read:0,ask:3,assembl:3,assign:[0,3],assum:3,async:[0,3],asyncio:[0,1],at_eof:3,attach:0,author:3,automat:[0,3],avail:[0,1,2,3],avoid:[0,3],await:3,back:3,background:3,bad:3,bar:0,base:1,basenam:0,basic:3,becaus:[0,3],becom:3,been:[0,3],befor:[0,3],begin:0,behav:3,below:[0,3],benchmark:1,best:3,better:0,beyond:3,bin:[0,3],binari:[0,1,2],bit:3,blob:3,block:[0,3],bob:3,bodi:3,boiler:3,boilerpl:3,book:3,bool:[0,3],bootstrap:[0,1],both:[1,3],broadcast:3,buf:0,buffer:[0,1],bufsiz:0,bug:3,build:[0,1,2],builder:[1,3],bulder:0,bunch:[0,3],bundl:2,cafil:3,calcul:3,calculator_capnp:3,calculatorimpl:3,call:[0,1],callback:3,can:[0,1,2,3],cancel:0,cap:[0,1],capabilit:3,capability_capnp:3,capabl:[1,3],capnp:[0,1,3],capnproto:[0,2],care:0,carri:0,cast:[0,3],cast_a:[0,3],caus:0,caveat:3,cento:2,cert:3,certain:3,certif:3,chain:3,chang:[0,3],channel:3,check:3,clang:2,clean:2,cleanup_global_schema_pars:0,clear:[0,3],clear_write_flag:0,client:[0,1],client_auth:3,clone:2,close:0,code:3,com:[0,2,3],command:2,commun:[1,3],compat:3,compil:[1,2],complet:0,complex:3,complic:3,compon:3,concept:3,condit:3,connect:3,constant:0,constructor:3,consum:3,contain:[0,2,3],content:[0,1,3],context:[0,3],continu:3,control:[0,3],contstruct:3,conveni:[0,3],convent:0,convert:3,copi:[0,3],coroutin:3,correspond:[0,3],creat:[0,3],create_default_context:3,create_event_loop:0,ctx:3,current:[0,3],cxx:0,cycl:0,data:[0,1,3],dead:3,deal:3,debug:3,decent:1,def:3,deffunction_context:3,defin:[0,3],depend:[2,3],deref:0,descript:[0,1],descriptor:[0,3],deseri:1,detail:[0,3],determin:3,develop:1,dict:0,dictionari:1,differ:[0,3],directli:[0,1],directori:[0,1,3],disabl:3,disconnect:[0,3],discuss:3,disown:0,display_nam:0,distro:2,do_stuff:3,doc:[1,2,3],document:3,doe:3,doesn:[0,3],doing:[0,2],don:[0,3],done:[0,2,3],dragon:2,drain:3,due:3,durabl:0,dynam:[0,3],dynamiclist:0,dynamicstruct:0,dynamicvalu:0,each:[0,3],earlier:3,easi:3,easier:3,effect:3,efficient:3,either:3,element:[0,3],elif:3,els:3,email:[0,3],emploi:3,employ:3,encoded_messag:3,end:[0,3],enumer:3,eof:3,equival:[0,3],err:3,error:3,error_func:0,eval_promis:3,evalu:3,evaluate_impl:3,evaluate_request:3,even:[0,3],event:[0,3],eventloop:0,everi:3,exactli:3,exampl:[0,1],except:[0,1,3],execut:0,exist:0,expect:3,express:3,extract:3,fact:1,fail:0,failur:[0,3],fairli:3,fals:[0,3],famili:3,fast:1,faster:1,featur:3,field:[0,1],file:[0,1],file_nam:0,fileno:[0,3],fill:[0,3],find:3,fine:3,finish:[0,3],first:[0,2,3],flag:0,flatarraymessageread:3,float32:3,float64:3,follow:[0,2,3],foo:[0,3],forc:2,forev:0,form:3,format:[0,1,3],forward:3,frame:3,from:[0,1],from_byt:[0,3],from_bytes_pack:[0,3],from_dict:0,from_seg:[0,3],fulfil:0,full:1,func:[0,3],functionimpl:3,futur:3,gather:3,gcc:2,gener:[2,3],get:[0,3],get_event_loop:3,get_root:0,get_root_as_ani:0,get_segments_for_output:0,getattr:0,getoper:3,getsegmentsforoutput:3,gettim:0,git:1,github:[1,2,3],give:3,given:[0,3],global:0,grab:3,grow:0,growabl:0,guarante:3,handl:[0,3],happen:3,harder:3,has:[0,1,3],have:[0,3],help:3,here:[1,3],hidio:3,highli:3,hold:3,home:3,hook:[0,3],hopefulli:3,host:3,how:[0,3],howev:3,html:[0,2],http:[0,2],hyphen:0,idea:3,ignore_error:0,implement:[0,1],importantli:3,inaccess:0,includ:3,incom:3,incompat:3,increment:0,index:0,ineffici:0,infin:1,inform:3,inherit:[1,3],init:[0,3],init_resizable_list:0,init_root:0,initi:[0,1],initii:0,input:3,insan:1,insid:[0,3],instal:[1,3],instanti:0,instead:[0,3],instruct:3,int16:3,int32:3,int64:3,int8:3,integ:3,interchang:[1,3],interfac:[0,3],intern:[1,3],interpret:3,intrins:3,introduc:3,invalid:[0,3],invers:0,investig:3,ioerror:0,ipv4:3,ipv6:3,is_consum:0,is_root:0,isn:[0,2,3],issu:2,item:0,iter:0,its:[0,1,3],itself:[2,3],join:3,join_promis:0,json:1,just:[0,1,2,3],kei:3,keyword:[0,3],kjexcept:0,know:0,kwarg:[0,3],lambda:3,last:3,latest:2,ldflag:2,leak:[0,3],left:3,length:3,let:3,level:[0,3],lib:0,libcapnp:[0,2,3],librari:[0,1,3],light:3,like:[0,1,3],limit:[0,3],line:[0,2],link:3,linux:2,list:[0,1],liter:3,load:[0,1],load_cert_chain:3,localhost:[0,3],look:[2,3],loop:[0,3],lot:[1,3],lrt:2,maco:2,made:0,magic:3,mai:[0,2],mail:3,main:[0,3],mainli:0,major:3,make:[0,1,3],mani:[0,2,3],manner:0,manual:3,manylinux:2,master:2,match:[0,3],mean:0,meaning:0,meant:0,member:[0,3],memori:3,messag:[0,1],messagebuild:3,messagetoflatarrai:3,met:3,method:[0,1],mind:3,minim:3,miscellan:1,mit:3,mobil:[0,3],mode:3,modul:1,modules_by_id:0,moduletyp:0,moment:3,more:[0,3],most:3,mostli:0,much:[0,3],multi:1,must:[0,3],my_dict:3,my_field:0,myread:3,myserv:3,mywrit:3,name:[0,3],natur:0,need:[0,1,2,3],nest:3,nesting_limit:0,never:0,new_connect:3,new_messag:[0,3],new_orphan:0,newli:0,newmessag:0,next:3,non:[0,3],none:[0,3],normal:[0,3],note:[0,3],notic:3,now:3,num_first_segment_word:0,number:[0,3],numpar:0,obj:0,object:[0,1],occur:3,off:0,often:3,older:2,on_disconnect:[0,3],onc:[0,2,3],one:[0,2,3],onli:[0,3],onto:0,open:[0,3],open_connect:3,oper:[0,3],operatorimpl:3,oppos:3,option:2,order:[0,3],org:[0,2],origin:0,orphan:0,other:0,otherwis:3,out:[0,3],outgo:3,output:3,over:[0,3],overload:0,own:[0,3],pack:[0,3],packag:2,param:3,paramcount:3,paramet:[0,3],parent:0,pars:0,parse_arg:3,parser:0,part:3,pass:[0,3],path:[0,3],pend:3,peopl:[0,3],perform:3,person:[0,3],phone:[0,3],phonenumb:3,pick:3,pip:1,pipelin:[0,1],pipenv:2,plate:3,pleas:3,point:3,pointer:[0,3],poll:0,poll_forev:0,poll_onc:[0,3],port:[0,3],port_promis:0,possibl:[2,3],practic:3,pre:0,prepend:0,prevent:3,previou:[0,3],previous:0,primit:[0,1],print:[0,3],probabl:[0,3],problem:[0,3],produc:3,promis:[1,3],promisefulfillerpair:0,properli:0,properti:0,proto:[0,1],protocol:[1,3],proven:1,pure:1,purpos:3,pycapnp:3,pypi:[0,1,2,3],pytest:2,python:[0,1,2,3],pythonpath:3,queri:3,queue:0,quickstart:[1,2],quot:1,qux:[0,3],rais:[0,3],raw:3,read:[0,1],read_multipl:[0,3],read_multiple_byt:0,read_multiple_bytes_pack:0,read_multiple_pack:[0,3],read_pack:[0,3],read_promis:3,read_result:3,readabl:0,reader:[1,3],real:0,realli:3,reassembl:3,rebuild:2,receiv:3,recent:3,recommend:3,reconnect:3,recurs:0,refer:[1,3],reflect:0,rel:0,releas:2,remov:[0,3],remove_event_loop:0,remove_import_hook:[0,3],replac:0,repo:[1,2],repositori:3,repres:0,request:3,requir:[0,2,3],reset_event_loop:0,resolv:3,resourc:3,respect:0,respons:1,result:3,ret:3,retri:3,return_except:3,revers:3,reverse_map:0,rich:3,right:2,risk:3,root:0,round:3,rpc:1,run:3,run_forev:[0,3],run_until_complet:3,same:3,sampl:3,schema:[0,1],schemapars:0,school:3,search:0,second:3,secondli:3,section:3,see:[0,3],seek:3,segment:[0,1],segmentarraymessageread:3,self:[0,3],selfemploi:3,selfsign:3,send:3,sent:3,separ:3,seper:1,sequenti:3,serial:[0,1],serve_forev:3,server:1,server_auth:3,set:[0,2,3],set_root:0,setattr:[0,3],setup:[2,3],sever:0,shortcom:3,shortcut:[0,3],shorter:3,should:[0,3],shouldn:3,show:3,shown:3,side:3,sign:3,similar:3,similarli:3,simpl:3,simplest:3,simplifi:3,simplist:[1,3],sinc:[0,1],singl:3,size:[0,3],skip:0,skip_copi:0,sleep:3,slightli:3,socket:[0,3],some:[0,1,3],someth:3,sourc:1,space:[0,3],spawn:3,spec:3,specif:3,specifi:[0,2],split:3,src:3,standard:3,start:[1,2],start_serv:3,statement:3,step:1,stick:3,still:[0,3],str:[0,3],straight:[0,3],stream:3,string:[0,1],struct:[0,3],structur:3,student:3,sub:3,sudo:2,suffici:3,support:[0,2,3],sure:[0,3],syntax:[0,3],sys:[0,3],system:[0,1,2,3],take:[0,2,3],tar:2,target:2,task:3,tcp:3,tediou:3,test:2,test_rpc:3,test_rpc_calcul:2,testinterfac:3,text:3,than:[0,1,3],thei:3,them:[0,3],themselv:3,thi:[0,1,2,3],thin:[1,3],thing:[2,3],think:1,thinli:0,this_dir:3,those:3,though:3,thread:[0,3],thrift:1,through:[2,3],time:[0,1,3],timeout:3,timeouterror:3,timer:0,tip:3,to_byt:[0,3],to_bytes_pack:[0,3],to_dict:[0,3],to_seg:[0,3],tobyt:3,top:[0,3],total:0,total_s:0,traceback:3,transport:3,travers:0,traversal_limit_in_word:0,treat:[0,3],tri:3,tricki:3,trip:3,turn:3,tutori:3,two:3,twopartycli:[0,3],twopartyserv:[0,3],twowaypip:3,txt:[0,2],type:[0,1],typic:0,uint16:3,uint32:3,uint64:3,uint64_t:0,uint8:3,under:3,underli:3,understand:3,unemploi:3,unicod:3,unimpl:0,union:[0,1],unknown:[0,3],unless:[0,2],unload:0,unnam:3,unpack:0,unsign:3,unsur:3,until:0,unus:0,upcast:0,upgrad:3,upon:0,url:2,usag:0,use:[0,2,3],used:[0,3],useful:0,uses:3,using:[0,2,3],usual:3,util:3,val:3,valid:0,valu:[0,1],valueerror:3,valueimpl:3,variabl:3,verbos:[0,3],veri:3,version:[0,2,3],wai:3,wait:[0,3],wait_for:3,wait_forev:0,want:[0,2,3],warn:0,weird:3,well:[0,3],were:3,what:[0,1,3],when:[0,2,3],where:[0,3],which:[0,3],window:2,wire:3,wish:0,with_traceback:0,within:3,without:[0,1,3],won:3,word:0,work:[0,2,3],worri:[0,3],worth:3,would:3,wrap:[0,1,3],wrapper:[0,3],write:[0,1],write_pack:[0,3],writer:[0,3],written:0,wrote:3,you:[0,2,3],your:[0,3],your_module_capnp:3,yourinterfac:3,yourself:[0,3],zeromq:3},titles:["API Reference","pycapnp","Installation","Quickstart"],titleterms:{"byte":3,"class":0,"const":3,"enum":3,"function":0,"new":3,TLS:3,api:0,asyncio:3,bootstrap:3,buffer:3,build:3,builder:0,call:3,cap:[2,3],capabl:0,client:3,commun:0,deseri:3,develop:2,dictionari:3,exampl:3,field:3,file:3,from:[2,3],full:3,git:2,implement:3,initi:3,instal:2,intern:0,librari:2,list:3,load:3,messag:3,method:3,miscellan:0,modul:0,multi:3,object:3,pip:2,pipelin:3,primit:3,promis:0,proto:[2,3],pycapnp:[1,2],quickstart:3,read:3,reader:0,refer:0,respons:0,rpc:[0,3],schema:3,segment:3,serial:3,server:3,sourc:2,ssl:3,start:3,string:3,type:3,union:3,valu:3,write:3}})
\ No newline at end of file