diff --git a/ConfigurationOptions.txt b/ConfigurationOptions.txt new file mode 100644 index 000000000..5d25767cd --- /dev/null +++ b/ConfigurationOptions.txt @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2007-2020 Dirk Beyer +# +# SPDX-License-Identifier: Apache-2.0 + +# Possible log levels in descending order +# (lower levels include higher ones): +# OFF: no logs published +# SEVERE: error messages +# WARNING: warnings +# INFO: messages +# FINE: logs on main application level +# FINER: logs on central CPA algorithm level +# FINEST: logs published by specific CPAs +# ALL: debugging information +# Care must be taken with levels of FINER or lower, as output files may +# become quite large and memory usage might become an issue. + +# single levels to be excluded from being logged +log.consoleExclude = [] + +# log level of console output +log.consoleLevel = Level.INFO + +# name of the log file +log.file = "CPALog.txt" + +# single levels to be excluded from being logged +log.fileExclude = [] + +# log level of file output +log.level = Level.OFF + +# Maximum size of log output strings before they will be truncated. Note that +# truncation is not precise and truncation to small values has no effect. Use +# 0 for disabling truncation completely. +log.truncateSize = 10000 + +# use colors for log messages on console +log.useColors = true + +# disable all default output files +# (any explicitly given file will still be written) +output.disable = false + +# directory to put all output files in +output.path = "output/" + +# base directory for all paths in default values +rootDirectory = "." diff --git a/api/allclasses-index.html b/api/allclasses-index.html new file mode 100644 index 000000000..cbc8506a5 --- /dev/null +++ b/api/allclasses-index.html @@ -0,0 +1,765 @@ + + + + + +All Classes (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes

+
+
+ +
+
+ + + diff --git a/api/allclasses.html b/api/allclasses.html new file mode 100644 index 000000000..c2e899b61 --- /dev/null +++ b/api/allclasses.html @@ -0,0 +1,130 @@ + + + + + +All Classes (Sosy-Lab Common Library) + + + + + + + + + + + + + +
+

All Classes

+
+ +
+
+ + diff --git a/api/allpackages-index.html b/api/allpackages-index.html new file mode 100644 index 000000000..f10e2dd60 --- /dev/null +++ b/api/allpackages-index.html @@ -0,0 +1,217 @@ + + + + + +All Packages (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

All Packages

+
+
+ +
+
+ + + diff --git a/api/constant-values.html b/api/constant-values.html new file mode 100644 index 000000000..c60a3e9a3 --- /dev/null +++ b/api/constant-values.html @@ -0,0 +1,149 @@ + + + + + +Constant Field Values (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Constant Field Values

+
+

Contents

+
+
+
+ + + diff --git a/api/deprecated-list.html b/api/deprecated-list.html new file mode 100644 index 000000000..115ece33f --- /dev/null +++ b/api/deprecated-list.html @@ -0,0 +1,581 @@ + + + + + +Deprecated List (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Deprecated API

+

Contents

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+
+ + + diff --git a/api/element-list b/api/element-list new file mode 100644 index 000000000..d4a0150c0 --- /dev/null +++ b/api/element-list @@ -0,0 +1,9 @@ +org.sosy_lab.common +org.sosy_lab.common.annotations +org.sosy_lab.common.collect +org.sosy_lab.common.configuration +org.sosy_lab.common.configuration.converters +org.sosy_lab.common.io +org.sosy_lab.common.log +org.sosy_lab.common.rationals +org.sosy_lab.common.time diff --git a/api/help-doc.html b/api/help-doc.html new file mode 100644 index 000000000..75c41d8d4 --- /dev/null +++ b/api/help-doc.html @@ -0,0 +1,273 @@ + + + + + +API Help (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+
    +
  • +
    +

    Overview

    +

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +
    +
    • +
  • +
    +

    Package

    +

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

    +
      +
    • Interfaces
      • +
    • Classes
      • +
    • Enums
      • +
    • Exceptions
      • +
    • Errors
      • +
    • Annotation Types
      • +
    +
    +
    • +
  • +
    +

    Class or Interface

    +

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    +
      +
    • Class Inheritance Diagram
      • +
    • Direct Subclasses
      • +
    • All Known Subinterfaces
      • +
    • All Known Implementing Classes
      • +
    • Class or Interface Declaration
      • +
    • Class or Interface Description
      • +
    +
    +
      +
    • Nested Class Summary
      • +
    • Field Summary
      • +
    • Property Summary
      • +
    • Constructor Summary
      • +
    • Method Summary
      • +
    +
    +
      +
    • Field Detail
      • +
    • Property Detail
      • +
    • Constructor Detail
      • +
    • Method Detail
      • +
    +

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    +
    +
    • +
  • +
    +

    Annotation Type

    +

    Each annotation type has its own separate page with the following sections:

    +
      +
    • Annotation Type Declaration
      • +
    • Annotation Type Description
      • +
    • Required Element Summary
      • +
    • Optional Element Summary
      • +
    • Element Detail
      • +
    +
    +
    • +
  • +
    +

    Enum

    +

    Each enum has its own separate page with the following sections:

    +
      +
    • Enum Declaration
      • +
    • Enum Description
      • +
    • Enum Constant Summary
      • +
    • Enum Constant Detail
      • +
    +
    +
    • +
  • +
    +

    Tree (Class Hierarchy)

    +

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

    +
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
      • +
    • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
      • +
    +
    +
    • +
  • +
    +

    Deprecated API

    +

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    +
    +
    • +
  • +
    +

    Index

    +

    The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

    +
    +
    • +
  • +
    +

    All Classes

    +

    The All Classes link shows all classes and interfaces except non-static nested types.

    +
    +
    • +
  • +
    +

    Serialized Form

    +

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    +
    +
    • +
  • +
    +

    Constant Field Values

    +

    The Constant Field Values page lists the static final fields and their values.

    +
    +
    • +
  • +
    +

    Search

    +

    You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

    +
    +
    • +
+
+This help file applies to API documentation generated by the standard doclet.
+
+ + + diff --git a/api/index-all.html b/api/index-all.html new file mode 100644 index 000000000..bc7be71df --- /dev/null +++ b/api/index-all.html @@ -0,0 +1,3558 @@ + + + + + +Index (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
A B C D E F G H I J K L M N O P R S T U V W X Z 
All Classes All Packages + + +

A

+
+
abs() - Method in class org.sosy_lab.common.rationals.Rational
+
+
Returns absolute value of this.
+
+
AbstractAppender() - Constructor for class org.sosy_lab.common.Appenders.AbstractAppender
+
 
+
AbstractMBean - Class in org.sosy_lab.common
+
+
Abstract class that encapsulates the registration of an MBean with the MBeanServer.
+
+
AbstractMBean(String, LogManager) - Constructor for class org.sosy_lab.common.AbstractMBean
+
 
+
add(int, T) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
add(LinearExpression<T>) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Add other linear expression.
+
+
add(T) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
addAll(int, Collection<? extends T>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
addAll(Collection<? extends T>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
addConverter(Class<?>, TypeConverter) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Add a type converter for options with a certain type.
+
+
addTo(Temporal) - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
allElementsEqual(Iterable<?>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Check whether all elements contained in the given iterable are equal to each other.
+
+
allElementsEqual(Object[]) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Check whether all elements contained in the given array are equal to each other.
+
+
allElementsEqual(Stream<?>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Check whether all elements contained in the given stream are equal to each other.
+
+
AnnotatedValue<T> - Class in org.sosy_lab.common.configuration
+
+
Immutable container that stores a value and an optional string.
+
+
annotation() - Method in class org.sosy_lab.common.configuration.AnnotatedValue
+
 
+
Appender - Interface in org.sosy_lab.common
+
+
An interface for classes that know how to dump themselves into an Appendable.
+
+
Appenders - Class in org.sosy_lab.common
+
+
Utility class providing Appenders for various cases.
+
+
Appenders.AbstractAppender - Class in org.sosy_lab.common
+
+
Base implementation of Appender that ensures that the Appenders.AbstractAppender.toString() method + returns the same result that Appender.appendTo(Appendable) produces in order to ensure that the + contract of Appender is fulfilled.
+
+
appendTo(Appendable) - Method in interface org.sosy_lab.common.Appender
+
+
Writes a string representation of this object into the given Appendable.
+
+
appendTo(Appendable, Object) - Static method in class org.sosy_lab.common.Appenders
+
+
Write the given object into the given output.
+
+
appendTo(StringBuilder, Appender) - Static method in class org.sosy_lab.common.Appenders
+
+
Let an Appender dump itself into a StringBuilder.
+
+
appendToFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.IO
+
+
Appends content to a file (without overwriting the file, but creating it if necessary).
+
+
appendToFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
moved to IO
+
+
+
applicableTo() - Method in annotation type org.sosy_lab.common.configuration.OptionDetailAnnotation
+
+
The annotation is applicable to configuration of these types.
+
+
ARM64 - org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+ 
+
asByteSink(Path, FileWriteMode...) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated.
+
+
asByteSource(Path) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated.
+
+
asCharSink(Path, Charset, FileWriteMode...) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated.
+
+
asCharSource(Path, Charset) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated.
+
+
asDuration() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Return a Duration instance that represents the same amount of time (but it won't be + possible to retrieve our unit as from getUnit()).
+
+
asMillis() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Get the value of this TimeSpan as milliseconds.
+
+
asNanos() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Get the value of this TimeSpan as nanoseconds.
+
+
asPropertiesString() - Method in class org.sosy_lab.common.configuration.Configuration
+
 
+
asSeconds() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Get the value of this TimeSpan as seconds.
+
+
asSet(Optional<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Return a set that is either empty or contains the present instance of the Optional.
+
+
asStream(Optional<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
use Optional.stream()
+
+
+
+ + + +

B

+
+
BaseTypeConverter - Enum in org.sosy_lab.common.configuration.converters
+
+
A TypeConverter which handles all the trivial cases like ints, Strings, log levels, + regexps, etc.
+
+
BasicLogManager - Class in org.sosy_lab.common.log
+
+
Default implementation of LogManager.
+
+
BasicLogManager(Logger) - Constructor for class org.sosy_lab.common.log.BasicLogManager
+
+
Constructor which allows to customize where this logger delegates to.
+
+
BasicLogManager(Logger, int) - Constructor for class org.sosy_lab.common.log.BasicLogManager
+
+
Constructor which allows to customize where this logger delegates to.
+
+
BasicLogManager.LogManagerMXBean - Interface in org.sosy_lab.common.log
+
 
+
build() - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
 
+
build() - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Create a Configuration instance with the settings specified by method calls on this builder + instance.
+
+
builder() - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Create a new Builder instance.
+
+
builder() - Static method in class org.sosy_lab.common.io.TempFile
+
+
Create a builder for temporary files.
+
+
+ + + +

C

+
+
ceilingEntry(K) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
checkReadableFile(Path) - Static method in class org.sosy_lab.common.io.IO
+
+
Verifies if a file exists, is a normal file and is readable.
+
+
checkReadableFile(Path) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
moved to IO
+
+
+
ChildFirstPatternClassLoader - Class in org.sosy_lab.common
+
+
Deprecated. +
replaced with Classes.makeExtendedURLClassLoader() and Classes.ClassLoaderBuilder.setDirectLoadClasses(Predicate).
+
+
+
ChildFirstPatternClassLoader(Predicate<String>, URL[], ClassLoader) - Constructor for class org.sosy_lab.common.ChildFirstPatternClassLoader
+
+
Deprecated.
+
Create a new class loader.
+
+
ChildFirstPatternClassLoader(Pattern, URL[], ClassLoader) - Constructor for class org.sosy_lab.common.ChildFirstPatternClassLoader
+
+
Deprecated.
+
Create a new class loader.
+
+
Classes - Class in org.sosy_lab.common
+
+
Helper class for various methods related to handling Java classes and types.
+
+
Classes.ClassInstantiationException - Exception in org.sosy_lab.common
+
+
Deprecated.
+
+
Classes.ClassLoaderBuilder<B extends Classes.ClassLoaderBuilder<B>> - Class in org.sosy_lab.common
+
+
A builder for class loaders with more features than URLClassLoader.
+
+
Classes.UnexpectedCheckedException - Exception in org.sosy_lab.common
+
+
An exception that should be used if a checked exception is encountered in a situation where it + is not excepted (e.g., when getting the result from a Callable of which you know it + shouldn't throw such exceptions).
+
+
Classes.UnsuitedClassException - Exception in org.sosy_lab.common
+
+
Exception thrown when Classes.createFactory(TypeToken, Class) is called with a class + that does not satisfy the requirements of the factory interface.
+
+
ClassInstantiationException(String, String, Throwable) - Constructor for exception org.sosy_lab.common.Classes.ClassInstantiationException
+
+
Deprecated.
+ 
+
ClassInstantiationException(String, Throwable) - Constructor for exception org.sosy_lab.common.Classes.ClassInstantiationException
+
+
Deprecated.
+ 
+
ClassOption - Annotation Type in org.sosy_lab.common.configuration
+
+
This is an optional annotation for all configuration options (i.e., elements that are annotated + with Option) whose type is Class.
+
+
ClassTypeConverter - Class in org.sosy_lab.common.configuration.converters
+
 
+
ClassTypeConverter() - Constructor for class org.sosy_lab.common.configuration.converters.ClassTypeConverter
+
 
+
clear() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
See Map.clear().
+
+
clear() - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
clear() - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
clear() - Method in class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
clearOption(String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Reset a single option to its default value.
+
+
close() - Method in class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
close() - Method in class org.sosy_lab.common.io.MoreFiles.DeleteOnCloseFile
+
+
Deprecated.
+ 
+
close() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseDir
+
+
Recursively delete all files and directories in the directory represented by this instance.
+
+
close() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
close() - Method in class org.sosy_lab.common.log.BasicLogManager
+
 
+
close() - Method in class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
codeUnit() - Method in annotation type org.sosy_lab.common.configuration.TimeSpanOption
+
+
The unit which will be used to write the value from the user into the annotated field if the + field is of type int or long.
+
+
Collections3 - Class in org.sosy_lab.common.collect
+
+
Utility class similar to Collections and Collections2.
+
+
collectMapsDifferenceTo(Collection<MapsDifference.Entry<K, V>>) - Static method in class org.sosy_lab.common.collect.MapsDifference
+
+
Returns a MapsDifference.Visitor that collects all map differences as MapsDifference.Entry objects into a + given collection.
+
+
collectOptions(boolean, boolean, PrintStream) - Static method in class org.sosy_lab.common.configuration.OptionCollector
+
+
This function collects options from all classes and outputs them.
+
+
collector() - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Deprecated. +
renamed to PersistentLinkedList.toPersistentLinkedList() to conform with Guava's naming
+
+
+
comparator() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
compareTo(ExtendedRational) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
compareTo(Rational) - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
compareTo(TimeSpan) - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
comparingDoubleEmptyFirst() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalDouble that compares empty optionals as smaller + than all non-empty instances, and compares present doubles using their natural order.
+
+
comparingDoubleEmptyLast() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalDouble that compares empty optionals as larger + than all non-empty instances, and compares present doubles using their natural order.
+
+
comparingEmptyFirst() - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
Use Comparators.emptiesFirst(Comparator)
+
+
+
comparingEmptyFirst(Comparator<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
Use Comparators.emptiesFirst(Comparator)
+
+
+
comparingEmptyLast() - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
Use Comparators.emptiesLast(Comparator)
+
+
+
comparingEmptyLast(Comparator<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
Use Comparators.emptiesLast(Comparator)
+
+
+
comparingIntEmptyFirst() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalInt that compares empty optionals as smaller than + all non-empty instances, and compares present integers using their natural order.
+
+
comparingIntEmptyLast() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalInt that compares empty optionals as larger than + all non-empty instances, and compares present integers using their natural order.
+
+
comparingLongEmptyFirst() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalLong that compares empty optionals as smaller + than all non-empty instances, and compares present longs using their natural order.
+
+
comparingLongEmptyLast() - Static method in class org.sosy_lab.common.Optionals
+
+
Return a Ordering for OptionalLong that compares empty optionals as larger than + all non-empty instances, and compares present longs using their natural order.
+
+
compute(K, BiFunction<? super K, ? super V, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
computeIfAbsent(K, Function<? super K, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
computeIfPresent(K, BiFunction<? super K, ? super V, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
concat(Iterable<Appender>) - Static method in class org.sosy_lab.common.Appenders
+
+
Create a new Appender that consists of the sequential concatenation of multiple + appenders.
+
+
concat(Appender...) - Static method in class org.sosy_lab.common.Appenders
+
+
Create a new Appender that consists of the sequential concatenation of multiple + appenders.
+
+
Concurrency - Class in org.sosy_lab.common
+
+
Helper methods for concurrency related things.
+
+
Configuration - Class in org.sosy_lab.common.configuration
+
+
Immutable wrapper around a map with properties, providing useful access helper methods.
+
+
ConfigurationBuilder - Class in org.sosy_lab.common.configuration
+
+
Interface for constructing Configuration instances.
+
+
ConsoleLogFormatter - Class in org.sosy_lab.common.log
+
+
Class to handle formatting for console output.
+
+
ConsoleLogFormatter(LoggingOptions) - Constructor for class org.sosy_lab.common.log.ConsoleLogFormatter
+
 
+
containsKey(Object) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in interface org.sosy_lab.common.configuration.converters.TypeConverter
+
+
Convert a String given by the user to an instance of a given type.
+
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in enum org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
 
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in class org.sosy_lab.common.configuration.converters.ClassTypeConverter
+
 
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in class org.sosy_lab.common.configuration.converters.IntegerTypeConverter
+
 
+
convert(String, String, TypeToken<?>, Annotation, Path, LogManager) - Method in class org.sosy_lab.common.configuration.converters.TimeSpanTypeConverter
+
 
+
convertDefaultValue(String, T, TypeToken<T>, Annotation) - Method in interface org.sosy_lab.common.configuration.converters.TypeConverter
+
+
Optionally convert the default value for an option that was given in the source code.
+
+
convertDefaultValue(String, T, TypeToken<T>, Annotation) - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
convertDefaultValueFromOtherInstance(String, T, TypeToken<T>, Annotation) - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
convertDefaultValueFromOtherInstance(String, T, TypeToken<T>, Annotation) - Method in interface org.sosy_lab.common.configuration.converters.TypeConverter
+
+
Like TypeConverter.convertDefaultValue(String, Object, TypeToken, Annotation), but called if the + default value was not taken from the fresh instance, but from a different instance (cf.
+
+
copyFrom(Configuration) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Copy everything from an existing Configuration instance.
+
+
copyOf(List<T>) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns A new list with the values from the Iterable.
+
+
copyOf(Map<K, V>) - Static method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
copyOf(CopyOnWriteSortedMap<K, V>) - Static method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
Create a new map instance containing all entries of the given map.
+
+
copyOf(PersistentSortedMap<K, V>) - Static method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
Create a new map instance with an initial content of the given map.
+
+
copyOf(T...) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a list containing the specified values.
+
+
CopyOnWriteSortedMap<K,​V extends @Nullable Object> - Class in org.sosy_lab.common.collect
+
+
This is a map implementation that uses copy-on-write behavior.
+
+
copyOptionFrom(Configuration, String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Copy one single option from another Configuration instance, overwriting the value in this + builder, if it is already set.
+
+
copyOptionFromIfPresent(Configuration, String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Copy one single option from another Configuration instance, overwriting the value in this + builder, if it is already set.
+
+
copyWithNewPrefix(Configuration, String) - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Creates a copy of a configuration with just the prefix set to a new value.
+
+
create() - Static method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Creates a new empty OrderStatisticMap using natural ordering.
+
+
create() - Static method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Creates a new empty OrderStatisticSet using natural ordering.
+
+
create() - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Create a fresh temporary file according to the specifications set on this builder.
+
+
create() - Static method in class org.sosy_lab.common.ShutdownManager
+
+
Create a fresh new instance of this class.
+
+
create(String[]) - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite.OrderStatisticSetFactory
+
 
+
create(Comparator<? super E>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Creates a new empty OrderStatisticSet using the given comparator.
+
+
create(Comparator<? super K>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Creates a new empty OrderStatisticMap using the given comparator over its keys.
+
+
create(List<Map.Entry<String, String>>) - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite.OrderStatisticMapFactory
+
 
+
create(Map.Entry<String, String>[]) - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite.OrderStatisticMapFactory
+
 
+
create(Configuration) - Static method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
create(Configuration) - Static method in class org.sosy_lab.common.log.BasicLogManager
+
+
Create a BasicLogManager which logs to a file and the console according to user + configuration.
+
+
create(LoggingOptions) - Static method in class org.sosy_lab.common.log.BasicLogManager
+
+
Create a BasicLogManager which logs to a file and the console according to specified + options.
+
+
create(T) - Static method in class org.sosy_lab.common.configuration.AnnotatedValue
+
 
+
create(T, String) - Static method in class org.sosy_lab.common.configuration.AnnotatedValue
+
 
+
create(T, Optional<String>) - Static method in class org.sosy_lab.common.configuration.AnnotatedValue
+
 
+
createAppender(Object) - Static method in class org.sosy_lab.common.Appenders
+
+
Return an Appender for the given object.
+
+
createDeleteOnClose() - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Create a fresh temporary file according to the specifications set on this builder.
+
+
createDeleteOnCloseDir(String, FileAttribute<?>...) - Static method in class org.sosy_lab.common.io.TempFile
+
+
Create a fresh temporary directory in JVM's temp directory.
+
+
createDummy() - Static method in class org.sosy_lab.common.ShutdownNotifier
+
+
Create an instance that will never return true for ShutdownNotifier.shouldShutdown() and will never + notify its listeners.
+
+
createFactory(TypeToken<I>, Class<?>) - Static method in class org.sosy_lab.common.Classes
+
+
Create a factory at runtime that implements the interface factoryType and delegates to + either a constructor or a static factory method of cls.
+
+
createFactory(Class<I>, Class<?>) - Static method in class org.sosy_lab.common.Classes
+
+
Create a factory at runtime that implements the interface factoryType and delegates to + either a constructor or a static factory method of cls.
+
+
createInstance(Class<? extends T>, Class<?>[], Object[], Class<T>) - Static method in class org.sosy_lab.common.Classes
+
+
Deprecated.
+
+
createInstance(Class<T>, Class<? extends T>, Class<?>[], Object[]) - Static method in class org.sosy_lab.common.Classes
+
+
Deprecated.
+
+
createInstance(Class<T>, Class<? extends T>, Class<?>[], Object[], Class<X>) - Static method in class org.sosy_lab.common.Classes
+
+
Deprecated.
+
+
createNullLogManager() - Static method in interface org.sosy_lab.common.log.LogManager
+
+
Return a LogManager that does not log anything.
+
+
createParentDirs(Path) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated.
+
+
createTempFile(String, String) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
Use TempFile.builder() and TempFile.TempFileBuilder.createDeleteOnClose().
+
+
+
createTempFile(String, String, String) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
Use TempFile.builder().
+
+
+
createTestLogManager() - Static method in interface org.sosy_lab.common.log.LogManager
+
+
Return a LogManager implementation intended for testing when nothing should actually be logged.
+
+
createThreadPool() - Static method in class org.sosy_lab.common.Concurrency
+
+
Creates a thread pool of fixed size.
+
+
createThreadPool(ThreadFactory) - Static method in class org.sosy_lab.common.Concurrency
+
+
Creates a thread pool of fixed size.
+
+
createWithHandler(Handler) - Static method in class org.sosy_lab.common.log.BasicLogManager
+
+
Create a BasicLogManager which delegates to a new logger with only the given Handler.
+
+
createWithNaturalOrder(Iterable<E>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Creates a new OrderStatisticSet containing the same elements as the given Iterable, using + natural ordering.
+
+
createWithNaturalOrder(Map<? extends K, ? extends V>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Creates a new OrderStatisticSet containing the same entries as the given map, using natural + ordering over its keys.
+
+
createWithParent(ShutdownNotifier) - Static method in class org.sosy_lab.common.ShutdownManager
+
+
Create a fresh new instance of this class in a hierarchy.
+
+
createWithSafePathsOnly(Configuration) - Static method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
+
Create an instanceof of this class that allows only injected files that are below the current + directory.
+
+
createWithSameOrder(SortedMap<K, ? extends V>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Creates a new OrderStatisticMap containing the same entries and using the same order over keys + as the given SortedMap.
+
+
createWithSameOrder(SortedSet<E>) - Static method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Creates a new OrderStatisticSet containing the same elements and using the same order as the + given SortedSet.
+
+
+ + + +

D

+
+
defaultConfiguration() - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Creates a configuration with all values set to default.
+
+
defaultUserUnit() - Method in annotation type org.sosy_lab.common.configuration.TimeSpanOption
+
+
The unit which should be assumed when the user does not explicitly specify a unit.
+
+
DefaultVisitor() - Constructor for class org.sosy_lab.common.collect.MapsDifference.DefaultVisitor
+
 
+
delegate() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
delegate() - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
delegate() - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
 
+
deprecatedName() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
When the option needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config.
+
+
deprecatedPrefix() - Method in annotation type org.sosy_lab.common.configuration.Options
+
+
When the prefix needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config.
+
+
descendingEntryIterator() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
descendingKeySet() - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
descendingMap() - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
descendingMap() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
descendingMap() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
descendingSet() - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
description() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
A text that describes the current option (this will be part of the user documentation).
+
+
description() - Method in annotation type org.sosy_lab.common.configuration.Options
+
+
An optional text, that describes the current options.
+
+
difference(TimeSpan, TimeSpan) - Static method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the difference of two time spans.
+
+
differingValues(K, V, V) - Method in class org.sosy_lab.common.collect.MapsDifference.DefaultVisitor
+
 
+
differingValues(K, V, V) - Method in interface org.sosy_lab.common.collect.MapsDifference.Visitor
+
+
Accept a map difference.
+
+
dir(Path) - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
The directory where the file will be created, default is JVM's temp directory.
+
+
divide(int) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the current one divided by a non-negative integral value.
+
+
divide(LinearExpression<T>) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Returns a iff other.multByConst(a) == this, Optional.absent() if no + such constant exists.
+
+
divides(ExtendedRational) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
divides(Rational) - Method in class org.sosy_lab.common.rationals.Rational
+
+
Return this / b.
+
+
doubleValue() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
dumpUsedOptionsTo(PrintStream) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Let this instance write human-readable information about every option that is used to the given + stream.
+
+
DuplicateOutputStream - Class in org.sosy_lab.common.io
+
+
This class is an OutputStream implementation that sends everything to two other OutputStreams.
+
+
DuplicateOutputStream(OutputStream, OutputStream) - Constructor for class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
+ + + +

E

+
+
elementAndList(T, Collection<? extends T>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Return a list that contains the given element and the given collection.
+
+
elementsAndList(T, T, Collection<? extends T>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Return a list that contains the given elements and the given collection.
+
+
empty() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
empty() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
 
+
empty() - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Replacement for {PersistentList.clear() that returns an empty instance.
+
+
empty() - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Replacement for {PersistentMap.clear() that returns an empty instance.
+
+
empty() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
empty() - Static method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Creates an empty linear expression.
+
+
empty() - Static method in class org.sosy_lab.common.time.TimeSpan
+
 
+
enableLogging(LogManager) - Method in class org.sosy_lab.common.configuration.Configuration
+
 
+
enableSecureModeGlobally() - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Enable a secure mode, i.e., allow only injection of configuration options marked as secure.
+
+
entryIterator() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
entrySet() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
entrySet() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
entrySet() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
equals(Object) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
equals(Object) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
equals(Object) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
 
+
equals(Object) - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
equals(Object) - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
ExtendedLogRecord - Class in org.sosy_lab.common.log
+
+
An extension of LogRecord that stores additional information.
+
+
ExtendedLogRecord(Level, String) - Constructor for class org.sosy_lab.common.log.ExtendedLogRecord
+
 
+
ExtendedRational - Class in org.sosy_lab.common.rationals
+
+
This class represents "extended rational": rationals which allow for infinities, negative + infinities and undefined numbers.
+
+
ExtendedRational(Rational) - Constructor for class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
ExtendedRational.NumberType - Enum in org.sosy_lab.common.rationals
+
 
+
extractUpperBoundFromType(Type) - Static method in class org.sosy_lab.common.Classes
+
+
Simplify a Type instance: if it is a wildcard generic type, replace it with its upper + bound.
+
+
+ + + +

F

+
+
FieldsAreNonnullByDefault - Annotation Type in org.sosy_lab.common.annotations
+
+
An annotation similar to ParametersAreNonnullByDefault that defines that + all fields inside the annotated element are never null, unless this is overridden with another + method.
+
+
fileAttributes(FileAttribute<?>...) - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Use the specified FileAttributes for creating the file.
+
+
FileLogFormatter - Class in org.sosy_lab.common.log
+
+
Deprecated. +
use TimestampedLogFormatter instead.
+
+
+
FileLogFormatter() - Constructor for class org.sosy_lab.common.log.FileLogFormatter
+
+
Deprecated. +
use TimestampedLogFormatter.withoutColors()
+
+
+
FileOption - Annotation Type in org.sosy_lab.common.configuration
+
+
This is an annotation providing more features for options of types File and Path.
+
+
FileOption.Type - Enum in org.sosy_lab.common.configuration
+
 
+
FileTypeConverter - Class in org.sosy_lab.common.configuration.converters
+
+
A TypeConverter for options of type File or Path which offers some + additional features like a common base directory for all output files.
+
+
filterByClass(Iterable<? super T>, Class<T>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Provide a stream that results from filtering the given iterable's element by their class.
+
+
filterByClass(Collection<? super T>, Class<T>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Provide a stream that results from filtering the given collection's element by their class.
+
+
filterByClass(Stream<? super T>, Class<T>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Provide a stream that results from filtering the given stream's element by their class.
+
+
findPathForLibrary(String) - Static method in class org.sosy_lab.common.NativeLibraries
+
+
Deprecated.
+
+
firstEntry() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
floatValue() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
floorEntry(K) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
flush() - Method in class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
flush() - Method in class org.sosy_lab.common.log.BasicLogManager
+
 
+
flush() - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
flush() - Method in interface org.sosy_lab.common.log.LogManager
+
+
Flush all handlers of this logger.
+
+
flush() - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
flush() - Method in class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
flush() - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
forDifferingValues(K, V, V) - Static method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
 
+
forIterable(Joiner, Iterable<?>) - Static method in class org.sosy_lab.common.Appenders
+
+
Return an Appender that writes an Iterable into the output using a given Joiner.
+
+
forLeftValueOnly(K, V) - Static method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
 
+
forMap(Joiner.MapJoiner, Map<?, ?>) - Static method in class org.sosy_lab.common.Appenders
+
+
Return an Appender that writes a Map into the output using a given Joiner.
+
+
format(LogRecord, StringBuilder) - Method in class org.sosy_lab.common.log.ConsoleLogFormatter
+
 
+
format(LogRecord, StringBuilder) - Method in class org.sosy_lab.common.log.TimestampedLogFormatter
+
 
+
formatAs(TimeUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Return a strings that represents (approximately) this time span, in the given unit if possible.
+
+
forName(String, String) - Static method in class org.sosy_lab.common.Classes
+
+
Similar to Class.forName(String), but if the class is not found this method re-tries + with a package name prefixed.
+
+
forRightValueOnly(K, V) - Static method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
 
+
ForwardingLogManager - Class in org.sosy_lab.common.log
+
 
+
ForwardingLogManager() - Constructor for class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
fromCmdLineArguments(String[]) - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Construct a configuration object from the array of command line arguments.
+
+
fromGuavaOptional(Optional<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
use Optional.toJavaUtil()
+
+
+
fromToStringMethod(Object) - Static method in class org.sosy_lab.common.Appenders
+
+
Return an Appender that writes the result of the Object.toString() method of an + object into the output.
+
+
+ + + +

G

+
+
get() - Method in class org.sosy_lab.common.LazyFutureTask
+
 
+
get(long, TimeUnit) - Method in class org.sosy_lab.common.LazyFutureTask
+
+
Deprecated. +
Unsupported operation.
+
+
+
get(Object) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
get(TemporalUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Deprecated.
+
+
getAvgTime() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the average of all intervals.
+
+
getByRank(int) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Returns the element of this set with the given rank.
+
+
getChecked(TimeUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Get the value of this TimeSpan represented in the given unit.
+
+
getCodeLocation(Class<?>) - Static method in class org.sosy_lab.common.Classes
+
+
Return the Path to the location of the code of the given class, e.g., the JAR file.
+
+
getCoeff(T) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
 
+
getCompletions(Element, AnnotationMirror, ExecutableElement, String) - Method in class org.sosy_lab.common.configuration.OptionAnnotationProcessor
+
 
+
getConsoleExclude() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getConsoleLevel() - Method in interface org.sosy_lab.common.log.BasicLogManager.LogManagerMXBean
+
 
+
getConsoleLevel() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getCurentInnerTimer() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Get a reference to the current inner timer.
+
+
getCurrentThreadCputime() - Static method in class org.sosy_lab.common.time.Tickers
+
+
Return a Tickers.TickerWithUnit that delegates to ThreadMXBean.getCurrentThreadCpuTime().
+
+
getDefaultConverters() - Static method in class org.sosy_lab.common.configuration.Configuration
+
+
Get the map of registered default TypeConverters.
+
+
getDen() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
getDeprecatedProperties() - Method in class org.sosy_lab.common.configuration.Configuration
+
 
+
getEntry(Object) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
getEntryByRank(int) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Returns the entry of this map with the given rank.
+
+
getErrorOutput() - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Returns the complete output to stderr of the process.
+
+
getExceptionMergeConflictHandler() - Static method in class org.sosy_lab.common.collect.PersistentSortedMaps
+
+
Returns a PersistentSortedMaps.MergeConflictHandler that will always throw an IllegalArgumentException.
+
+
getFileExclude() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getFileLevel() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getFreshId() - Method in class org.sosy_lab.common.UniqueIdGenerator
+
 
+
getFreshPath() - Method in class org.sosy_lab.common.io.PathCounterTemplate
+
+
Construct a concrete Path that was not handed out by this instance before.
+
+
getInnerAvgSumTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the average of all inner times.
+
+
getInnerMaxTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the maximal time of all inner intervals.
+
+
getInnerSumTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the sum of all inner intervals.
+
+
getInstance() - Static method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
getInstance() - Static method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
getInstanceForNewConfiguration(Configuration) - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
getInstanceForNewConfiguration(Configuration) - Method in interface org.sosy_lab.common.configuration.converters.TypeConverter
+
+
Return a (possibly) new instance of this converter that has new configuration values applied.
+
+
getKey() - Method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
+
Returns the map key.
+
+
getKeyByRank(int) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Returns the key of this map with the given rank.
+
+
getLeftValue() - Method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
+
Returns the left value, if present.
+
+
getLengthOfLastInterval() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the length of the last measured interval.
+
+
getLengthOfLastOuterInterval() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the length of the last measured outer interval.
+
+
getLengthOfLastTotalInterval() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the length of the last measured total interval.
+
+
getLog() - Method in class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
getMap() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Returns the underlying stored map.
+
+
getMaximumMergeConflictHandler() - Static method in class org.sosy_lab.common.collect.PersistentSortedMaps
+
+
Returns a PersistentSortedMaps.MergeConflictHandler that will always return the maximum (according to the + natural order).
+
+
getMaxTime() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the maximal time of all intervals.
+
+
getMinimumMergeConflictHandler() - Static method in class org.sosy_lab.common.collect.PersistentSortedMaps
+
+
Returns a PersistentSortedMaps.MergeConflictHandler that will always return the minimum (according to the + natural order).
+
+
getMinTime() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the minimal time of all intervals.
+
+
getNativeCharset() - Static method in class org.sosy_lab.common.io.IO
+
+
Return the Charset that is used by the underlying platform, i.e., configured as the OS + default.
+
+
getNativeLibraryPath() - Static method in class org.sosy_lab.common.NativeLibraries
+
+
Return the "native library path" as defined in the documentation of NativeLibraries, + i.e., a directory where members of this class expect native binaries.
+
+
getNotifier() - Method in class org.sosy_lab.common.ShutdownManager
+
 
+
getNullTicker() - Static method in class org.sosy_lab.common.time.Tickers
+
+
Return a dummy Tickers.TickerWithUnit that always returns 0.
+
+
getNum() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
getNumberOfIntervals() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the number of total intervals.
+
+
getNumberOfIntervals() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the number of intervals.
+
+
getOrDefault(Object, V) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
getOuterAvgTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the average of all outer intervals.
+
+
getOuterMaxTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the maximal time of all outer intervals.
+
+
getOuterSumTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the sum of all outer intervals.
+
+
getOutput() - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Returns the complete output of the process.
+
+
getOutputDirectory() - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
getOutputFile() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getOutputPath() - Method in class org.sosy_lab.common.configuration.converters.FileTypeConverter
+
 
+
getPath(Object...) - Method in class org.sosy_lab.common.io.PathTemplate
+
+
Construct a concrete Path from this template and the given values.
+
+
getProcessCputime() - Static method in class org.sosy_lab.common.time.Tickers
+
+
Return a Tickers.TickerWithUnit that delegates to + com.sun.management.OperatingSystemMXBean.getProcessCpuTime().
+
+
getProperty(String) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Deprecated.
+
+
getRational() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
+
If the represented number is rational, return the wrapped object.
+
+
getReason() - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Return the reason for the shutdown request on this instance.
+
+
getRightValue() - Method in class org.sosy_lab.common.collect.MapsDifference.Entry
+
+
Returns the right value, if present.
+
+
getSaturated(TimeUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Get the value of this TimeSpan represented in the given unit.
+
+
getSingleTypeArgument(TypeToken<?>) - Static method in class org.sosy_lab.common.Classes
+
+
See Classes.getSingleTypeArgument(Type).
+
+
getSingleTypeArgument(Type) - Static method in class org.sosy_lab.common.Classes
+
+
From a type X<Foo>, extract the Foo.
+
+
getSnapshot() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
Return a immutable snapshot of the current state of the map.
+
+
getSourceComponentName() - Method in class org.sosy_lab.common.log.ExtendedLogRecord
+
 
+
getSumTime() - Method in class org.sosy_lab.common.time.Timer
+
+
Return the sum of all intervals.
+
+
getSupportedSourceVersion() - Method in class org.sosy_lab.common.configuration.OptionAnnotationProcessor
+
 
+
getTemplate() - Method in class org.sosy_lab.common.io.PathCounterTemplate
+
+
Returns the raw template of this instance.
+
+
getTemplate() - Method in class org.sosy_lab.common.io.PathTemplate
+
+
Returns the raw template of this instance.
+
+
getTotalAvgTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the average of all total intervals.
+
+
getTotalMaxTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the maximal time of all total intervals.
+
+
getTotalSumTime() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return the sum of all total intervals.
+
+
getTruncateSize() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
getUnit() - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
getUnits() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Deprecated.
+
+
getUnusedProperties() - Method in class org.sosy_lab.common.configuration.Configuration
+
 
+
getWalltimeMillis() - Static method in class org.sosy_lab.common.time.Tickers
+
+
Return a Tickers.TickerWithUnit that delegates to System.currentTimeMillis().
+
+
getWalltimeNanos() - Static method in class org.sosy_lab.common.time.Tickers
+
+
Return a Tickers.TickerWithUnit that delegates to System.nanoTime().
+
+
guessOperatingSystem() - Static method in enum org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+ 
+
guessVmArchitecture() - Static method in enum org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+
Get the architecture of the current JVM, e.g., as required to load binary libraries.
+
+
+ + + +

H

+
+
handleErrorOutput(String) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Handle one line of stderr output from the process.
+
+
handleExitCode(int) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Handle the exit code of the process.
+
+
handleOutput(String) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Handle one line of output from the process.
+
+
handleRuntimeErrorException(RuntimeErrorException) - Method in class org.sosy_lab.common.AbstractMBean
+
 
+
hashCode() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
hashCode() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
hashCode() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
 
+
hashCode() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
hashCode() - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
hasProperty(String) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Deprecated.
+
+
head() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns the value at the start of the list.
+
+
headMap(K) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
headMap(K) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
headMap(K) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
headMap(K, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
headMap(K, boolean) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
headMap(K, boolean) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
headSet(E) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
headSet(E, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
higherEntry(K) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
+ + + +

I

+
+
ignoreMapsDifference() - Static method in class org.sosy_lab.common.collect.MapsDifference
+
+
Returns a default MapsDifference.Visitor that does nothing.
+
+
INFTY - org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
 
+
INFTY - Static variable in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
initialContent(Object, Charset) - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Content to write to temp file immediately after creation.
+
+
inject(Object) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Inject the values of configuration options into an object.
+
+
inject(Object, Class<?>) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Use this method if the calling class is likely to be sub-classed, so that the options of the + calling class get injected, not the options of the dynamic class type of the object.
+
+
injectWithDefaults(T, Class<T>, T) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Same as Configuration.inject(Object, Class), but if this Configuration instance does not contain a + value for a requested configuration option, use the value that is set in the given + defaultsInstance instead of the value that is set as default in the to-be-injected object.
+
+
INSTANCE - org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
 
+
INSTANCE - org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
INSTANCE - org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
IntegerOption - Annotation Type in org.sosy_lab.common.configuration
+
+
This is an optional annotation for all configuration options (i.e., elements that are annotated + with Option) whose type is an integer number (i.e., int, long, Integer and Long):
+
+
IntegerTypeConverter - Class in org.sosy_lab.common.configuration.converters
+
+
Type converter for options of types Integer/Long annotated with IntegerOption (not for + integer options without this annotation).
+
+
IntegerTypeConverter() - Constructor for class org.sosy_lab.common.configuration.converters.IntegerTypeConverter
+
 
+
interruptCurrentThreadOnShutdown() - Static method in class org.sosy_lab.common.ShutdownNotifier
+
+
Utility method for creating a ShutdownNotifier.ShutdownRequestListener that interrupts the current + thread (that calls this method) on a shutdown.
+
+
intValue() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
InvalidConfigurationException - Exception in org.sosy_lab.common.configuration
+
+
Exception class to signal that something is wrong in the user-specified configuration.
+
+
InvalidConfigurationException(String) - Constructor for exception org.sosy_lab.common.configuration.InvalidConfigurationException
+
 
+
InvalidConfigurationException(String, Throwable) - Constructor for exception org.sosy_lab.common.configuration.InvalidConfigurationException
+
 
+
invokeStaticMethod(Class<?>, String, Class<T>, T, String) - Static method in enum org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
 
+
IO - Class in org.sosy_lab.common.io
+
+
Provides helper functions for file access, in addition to Files and MoreFiles.
+
+
IS_GENERATED - Static variable in class org.sosy_lab.common.Classes
+
 
+
isEmpty() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
isEmpty() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
 
+
isEmpty() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
 
+
isEmpty() - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Check whether this time span is empty, i.e., represents 0ns (or 0ms or 0s or ...).
+
+
isFinished() - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Checks whether the process has finished already.
+
+
isIntegral() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Returns whether all coefficients are integral.
+
+
isIntegral() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
isOnlyOuterRunning() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Check if the outer timer is running, i.e., the timer is running but the inner timer is not + running.
+
+
isRational() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
isRunning() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Check if the timer is running.
+
+
isRunning() - Method in class org.sosy_lab.common.time.Timer
+
+
Check if the timer is running.
+
+
iterator() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
 
+
iterator() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
 
+
+ + + +

J

+
+
join() - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Wait for the process to terminate and read all of it's output.
+
+
join(long) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Wait for the process to terminate.
+
+
JSON - Class in org.sosy_lab.common
+
+
This class is based on code from the library JSON.simple in version 1.1 + (https://code.google.com/p/json-simple/).
+
+
+ + + +

K

+
+
keySet() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
keySet() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
+ + + +

L

+
+
lastEntry() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
LazyFutureTask<V extends @Nullable Object> - Class in org.sosy_lab.common
+
+
Future implementation that can be used when a task should be executed only lazily at the first + time LazyFutureTask.get() is called.
+
+
LazyFutureTask(Runnable, V) - Constructor for class org.sosy_lab.common.LazyFutureTask
+
 
+
LazyFutureTask(Callable<V>) - Constructor for class org.sosy_lab.common.LazyFutureTask
+
 
+
lazyString(Supplier<String>) - Static method in class org.sosy_lab.common.MoreStrings
+
+
Return an Object instance whose Object.toString() method lazily delegates to + the given supplier.
+
+
leftValueOnly(K, V) - Method in class org.sosy_lab.common.collect.MapsDifference.DefaultVisitor
+
 
+
leftValueOnly(K, V) - Method in interface org.sosy_lab.common.collect.MapsDifference.Visitor
+
 
+
LinearExpression<T> - Class in org.sosy_lab.common.rationals
+
+
Simple sparse implementation for homogeneous linear expression of the form $\Sigma + a_i x_i$, where $x_i$ is a set of variables and $a_i$ is a set of constants.
+
+
LINUX - org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+ 
+
listAndElement(Collection<? extends T>, T) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Return a list that contains the given collection and the given element.
+
+
listAndElements(Collection<? extends T>, T, T) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Return a list that contains the given collection and the given elements.
+
+
listAndSurroundingElements(T, Collection<? extends T>, T) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Return a list that contains the given collection and the given elements, one before the + collection and one after.
+
+
listIterator(int) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
 
+
loadClass(String, boolean) - Method in class org.sosy_lab.common.ChildFirstPatternClassLoader
+
+
Deprecated.
+ 
+
loadFromFile(String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Load options from a file with a "key = value" format.
+
+
loadFromFile(Path) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Load options from a file with a "key = value" format.
+
+
loadFromResource(Class<?>, String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Load options from a class-loader resource with a "key = value" format.
+
+
loadFromSource(CharSource, String, String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Load options from a CharSource with a "key = value" format.
+
+
loadLibrary(String) - Static method in class org.sosy_lab.common.NativeLibraries
+
+
Load a native library.
+
+
log(Level, Object...) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Logs any message occurring during program execution.
+
+
log(Level, Object...) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
log(Level, Object...) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Logs any message occurring during program execution.
+
+
log(Level, Object...) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
log(Level, Object...) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
log(Level, Supplier<String>) - Method in class org.sosy_lab.common.log.BasicLogManager
+
 
+
log(Level, Supplier<String>) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
log(Level, Supplier<String>) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Logs any message occurring during program execution.
+
+
log(Level, Supplier<String>) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
log(Level, Supplier<String>) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logDebugException(Throwable) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logDebugException(Throwable) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logDebugException(Throwable) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logDebugException(Throwable) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logDebugException(Throwable) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logDebugException(Throwable, String) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logDebugException(Throwable, String) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logDebugException(Throwable, String) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logDebugException(Throwable, String) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logDebugException(Throwable, String) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logException(Level, Throwable, String) - Method in class org.sosy_lab.common.log.BasicLogManager
+
 
+
logException(Level, Throwable, String) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logException(Level, Throwable, String) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log an exception by printing the full details to the user.
+
+
logException(Level, Throwable, String) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logException(Level, Throwable, String) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logf(Level, String, Object...) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Logs any message occurring during program execution.
+
+
logf(Level, String, Object...) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logf(Level, String, Object...) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Logs any message occurring during program execution.
+
+
logf(Level, String, Object...) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logf(Level, String, Object...) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logfDebugException(Throwable, String, Object...) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logfDebugException(Throwable, String, Object...) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logfDebugException(Throwable, String, Object...) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log an exception solely for the purpose of debugging.
+
+
logfDebugException(Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logfDebugException(Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logfException(Level, Throwable, String, Object...) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log an exception by printing the full details to the user.
+
+
logfException(Level, Throwable, String, Object...) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logfException(Level, Throwable, String, Object...) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log an exception by printing the full details to the user.
+
+
logfException(Level, Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logfException(Level, Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logfOnce(Level, String, Object...) - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
+
Logging method similar to ForwardingLogManager.logf(Level, String, Object...), however, subsequent calls to + this method with the same arguments will be silently ignored.
+
+
logfUserException(Level, Throwable, String, Object...) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log a message by printing its message to the user.
+
+
logfUserException(Level, Throwable, String, Object...) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logfUserException(Level, Throwable, String, Object...) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log a message by printing its message to the user.
+
+
logfUserException(Level, Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
logfUserException(Level, Throwable, String, Object...) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logger - Variable in class org.sosy_lab.common.ProcessExecutor
+
 
+
LoggingOptions - Class in org.sosy_lab.common.log
+
 
+
LoggingOptions() - Constructor for class org.sosy_lab.common.log.LoggingOptions
+
+
This constructor is for inheritance, thus allowing users to use this class without sosy-lab's + Configuration.
+
+
LoggingOptions(Configuration) - Constructor for class org.sosy_lab.common.log.LoggingOptions
+
 
+
LogManager - Interface in org.sosy_lab.common.log
+
+
Main interface for basic logging framework.
+
+
LogManagerWithoutDuplicates - Class in org.sosy_lab.common.log
+
+
LogManager implementation which helps to get log messages printed only once, and avoid duplicate + messages.
+
+
LogManagerWithoutDuplicates(LogManager) - Constructor for class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
 
+
logOnce(Level, Object...) - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
+
Logging method similar to ForwardingLogManager.log(Level, Object...), however, subsequent calls to this + method with the same arguments will be silently ignored.
+
+
logOnce(Level, Supplier<String>) - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
+
Logging method similar to ForwardingLogManager.log(Level, Supplier), however, subsequent calls to this + method with the same arguments will be silently ignored.
+
+
logUserException(Level, Throwable, String) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Log a message by printing its message to the user.
+
+
logUserException(Level, Throwable, String) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
logUserException(Level, Throwable, String) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Log a message by printing its message to the user.
+
+
logUserException(Level, Throwable, String) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
logUserException(Level, Throwable, String) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
longStringOf(MoreStrings.WithLongString) - Static method in class org.sosy_lab.common.MoreStrings
+
+
Return an Object instance whose Object.toString() method delegates to MoreStrings.WithLongString.toLongString().
+
+
longValue() - Method in class org.sosy_lab.common.rationals.Rational
+
 
+
lowerEntry(K) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
+ + + +

M

+
+
MACOSX - org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+ 
+
main(String[]) - Static method in class org.sosy_lab.common.configuration.OptionCollector
+
+
The main-method collects all classes of a program and then it searches for all Options.
+
+
makeExtendedURLClassLoader() - Static method in class org.sosy_lab.common.Classes
+
+
Create a class loader that is based on an URLClassLoader but implements some additional + features.
+
+
MapsDifference - Class in org.sosy_lab.common.collect
+
+
Utilities for handling differences between maps.
+
+
MapsDifference.DefaultVisitor<K,​V> - Class in org.sosy_lab.common.collect
+
+
Default implementation of MapsDifference.Visitor with empty methods.
+
+
MapsDifference.Entry<K,​V> - Class in org.sosy_lab.common.collect
+
+
Class representing the difference between two maps for a given key.
+
+
MapsDifference.Visitor<K,​V> - Interface in org.sosy_lab.common.collect
+
+
Interface for visiting map entries differing between two maps.
+
+
max() - Method in annotation type org.sosy_lab.common.configuration.IntegerOption
+
+
An optional maximum value for this option.
+
+
max() - Method in annotation type org.sosy_lab.common.configuration.TimeSpanOption
+
+
An optional maximum value for this option.
+
+
max(Rational, Rational) - Static method in class org.sosy_lab.common.rationals.Rational
+
 
+
mayUseColorForOutput() - Static method in class org.sosy_lab.common.io.IO
+
+
Determine whether it is advisable to use color (via escape sequences) for output on + stdout/stderr.
+
+
merge(K, V, BiFunction<? super V, ? super V, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
merge(PersistentSortedMap<K, V>, PersistentSortedMap<K, V>, Equivalence<? super V>, PersistentSortedMaps.MergeConflictHandler<? super K, V>, MapsDifference.Visitor<? super K, ? super V>) - Static method in class org.sosy_lab.common.collect.PersistentSortedMaps
+
+
Merge two PersistentSortedMaps.
+
+
merge(PersistentSortedMap<K, V>, PersistentSortedMap<K, V>, PersistentSortedMaps.MergeConflictHandler<K, V>) - Static method in class org.sosy_lab.common.collect.PersistentSortedMaps
+
+
Merge two PersistentSortedMaps.
+
+
mergeStreams(OutputStream, OutputStream) - Static method in class org.sosy_lab.common.io.DuplicateOutputStream
+
+
Create an output stream that forwards to all given output streams, ignoring null parameters.
+
+
min() - Method in annotation type org.sosy_lab.common.configuration.IntegerOption
+
+
An optional minimum value for this option.
+
+
min() - Method in annotation type org.sosy_lab.common.configuration.TimeSpanOption
+
+
An optional minimum value for this option.
+
+
minus(ExtendedRational) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
minus(Rational) - Method in class org.sosy_lab.common.rationals.Rational
+
+
Return a new instance equal to this - b.
+
+
monomial(T, Rational) - Static method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Return a monomial with a variable var and a coefficient coeff.
+
+
MoreCollectors - Class in org.sosy_lab.common.collect
+
+
Additional Collector implementation, similar to Collectors.
+
+
MoreFiles - Class in org.sosy_lab.common.io
+
+
Deprecated.
+
+
MoreFiles.DeleteOnCloseFile - Class in org.sosy_lab.common.io
+
+
Deprecated. +
Use TempFile.DeleteOnCloseFile.
+
+
+
MoreStrings - Class in org.sosy_lab.common
+
+
Utility class for String-related helpers, similar to Strings.
+
+
MoreStrings.WithLongString - Interface in org.sosy_lab.common
+
+
Interface for classes that have a second, longer, string representation (with more information) + in addition to Object.toString().
+
+
multByConst(Rational) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Multiply the linear expression by constant.
+
+
multiply(int) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the current one multiplied by a non-negative integral factor.
+
+
+ + + +

N

+
+
name() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
An optional name for the option as it appears in the configuration file.
+
+
NaN - org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
 
+
NaN - Static variable in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
NativeLibraries - Class in org.sosy_lab.common
+
+
Helper class for loading native libraries.
+
+
NativeLibraries.Architecture - Enum in org.sosy_lab.common
+
+
Deprecated.
+
+
NativeLibraries.OS - Enum in org.sosy_lab.common
+
+
Deprecated.
+
+
navigableKeySet() - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
NEG_INFTY - org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
 
+
NEG_INFTY - Static variable in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
NEG_ONE - Static variable in class org.sosy_lab.common.rationals.Rational
+
 
+
negate() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
negate() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Negate the linear expression.
+
+
negate() - Method in class org.sosy_lab.common.rationals.Rational
+
+
Return negation of this.
+
+
NestedTimer - Class in org.sosy_lab.common.time
+
+
This class represents a timer similar to Timer, however it nests two timers.
+
+
NestedTimer() - Constructor for class org.sosy_lab.common.time.NestedTimer
+
 
+
newDaemonThread(String, Runnable) - Static method in class org.sosy_lab.common.Concurrency
+
+
Create a new daemon thread with a name.
+
+
newThread(String, Runnable) - Static method in class org.sosy_lab.common.Concurrency
+
+
Create a new non-daemon thread with a name.
+
+
noDeleteOnJvmExit() - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Do not automatically delete the file on JVM exit with File.deleteOnExit().
+
+
NullLogManager - Enum in org.sosy_lab.common.log
+
+
Deprecated. +
Use LogManager.createNullLogManager() instead. This class will be made + package-private.
+
+
+
+ + + +

O

+
+
of() - Static method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
of() - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns the empty list.
+
+
of(long) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Syntax sugar.
+
+
of(long, TimeUnit) - Static method in class org.sosy_lab.common.time.TimeSpan
+
 
+
of(String) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Syntax sugar helper for creating Rationals.
+
+
of(BigInteger, BigInteger) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Create a new rational from a numerator and a denominator.
+
+
of(T) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a list containing the specified value.
+
+
of(T, T) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a list containing the specified values.
+
+
of(T, T...) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a list containing the specified values.
+
+
of(T, T, T) - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a list containing the specified values.
+
+
ofBigDecimal(BigDecimal) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Convert a given BigDecimal to Rational.
+
+
ofBigInteger(BigInteger) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Create a new rational equal to the given BigInteger.
+
+
ofFormatString(String) - Static method in class org.sosy_lab.common.io.PathCounterTemplate
+
+
Create a new instance.
+
+
ofFormatString(String) - Static method in class org.sosy_lab.common.io.PathTemplate
+
+
Create a new instance.
+
+
ofLong(long) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Create a new rational equal to the given long.
+
+
ofLongs(long, long) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Create a new rational from two longs.
+
+
ofMillis(long) - Static method in class org.sosy_lab.common.time.TimeSpan
+
 
+
ofNanos(long) - Static method in class org.sosy_lab.common.time.TimeSpan
+
 
+
ofSeconds(long) - Static method in class org.sosy_lab.common.time.TimeSpan
+
 
+
ofString(String) - Static method in class org.sosy_lab.common.rationals.ExtendedRational
+
+
Reverses the effect of ExtendedRational.toString().
+
+
ofString(String) - Static method in class org.sosy_lab.common.rationals.Rational
+
+
Reverses the effect of Rational.toString().
+
+
ofVariable(T) - Static method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Create a monomial consisting of variable var with a coefficient of one.
+
+
ONE - Static variable in class org.sosy_lab.common.rationals.Rational
+
 
+
openOutputFile(Path, Charset, FileWriteMode...) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
moved to IO
+
+
+
openOutputFile(Path, Charset, OpenOption...) - Static method in class org.sosy_lab.common.io.IO
+
+
Open a buffered Writer to a file.
+
+
Option - Annotation Type in org.sosy_lab.common.configuration
+
+
An annotation to mark fields or methods which should get configuration values injected.
+
+
OPTIONAL_INPUT_FILE - org.sosy_lab.common.configuration.FileOption.Type
+
+
The file specified with this option is a file (i.e., no directory), but it needs not exist.
+
+
Optionals - Class in org.sosy_lab.common
+
+
Utilities for Optional.
+
+
OptionAnnotationProcessor - Class in org.sosy_lab.common.configuration
+
+
Annotation processor for checking constraints on Option and Options annotations.
+
+
OptionAnnotationProcessor() - Constructor for class org.sosy_lab.common.configuration.OptionAnnotationProcessor
+
 
+
OptionCollector - Class in org.sosy_lab.common.configuration
+
+
This class collects all Options of a program.
+
+
OptionDetailAnnotation - Annotation Type in org.sosy_lab.common.configuration
+
+
This is a meta annotation that marks other annotation which may be used in conjunction with + Option to provide more information for a specific option type.
+
+
Options - Annotation Type in org.sosy_lab.common.configuration
+
+
Annotation for a class which has fields or methods with an Option annotation.
+
+
OrderStatisticMap<K,​V extends @Nullable Object> - Interface in org.sosy_lab.common.collect
+
+
A NavigableMap that allows two additional operations: receiving (and deleting) an entry + by its rank, and getting the rank of an entry.
+
+
OrderStatisticMapFactory() - Constructor for class org.sosy_lab.common.collect.OrderStatisticMapTestSuite.OrderStatisticMapFactory
+
 
+
OrderStatisticMapTestSuite - Class in org.sosy_lab.common.collect
+
 
+
OrderStatisticMapTestSuite.OrderStatisticMapFactory - Class in org.sosy_lab.common.collect
+
 
+
OrderStatisticSet<E> - Interface in org.sosy_lab.common.collect
+
+
A NavigableSet that allows two additional operations: receiving (and deleting) an element + by its rank, and getting the rank of an element.
+
+
OrderStatisticSetFactory() - Constructor for class org.sosy_lab.common.collect.OrderStatisticSetTestSuite.OrderStatisticSetFactory
+
 
+
OrderStatisticSetTestSuite - Class in org.sosy_lab.common.collect
+
 
+
OrderStatisticSetTestSuite.OrderStatisticSetFactory - Class in org.sosy_lab.common.collect
+
 
+
org.sosy_lab.common - package org.sosy_lab.common
+
+
This package contains general utilities that do not fit anywhere else.
+
+
org.sosy_lab.common.annotations - package org.sosy_lab.common.annotations
+
+
This package contains several general-purpose annotations.
+
+
org.sosy_lab.common.collect - package org.sosy_lab.common.collect
+
+
This package contains additional interfaces and implementations for collections, as well as + further collection utilities.
+
+
org.sosy_lab.common.configuration - package org.sosy_lab.common.configuration
+
+
Java-Config is a library for injecting configuration options in a decentralized way.
+
+
org.sosy_lab.common.configuration.converters - package org.sosy_lab.common.configuration.converters
+
+
This package provides the possibility to convert String values into appropriate objects of + certain types.
+
+
org.sosy_lab.common.io - package org.sosy_lab.common.io
+
+
This package contains utilities for I/O.
+
+
org.sosy_lab.common.log - package org.sosy_lab.common.log
+
+
This package provides a logging framework.
+
+
org.sosy_lab.common.rationals - package org.sosy_lab.common.rationals
+
+
Java-Rationals is a library for working with rationals and extended rationals in Java.
+
+
org.sosy_lab.common.time - package org.sosy_lab.common.time
+
+
This package provides possibilities for measuring elapsed time, and a data class TimeSpan for storing time spans together with the respective time unit.
+
+
OUTPUT_DIRECTORY - org.sosy_lab.common.configuration.FileOption.Type
+
+
The directory specified with this option will be created by the tool.
+
+
OUTPUT_FILE - org.sosy_lab.common.configuration.FileOption.Type
+
+
The file specified with this option will be created by the tool.
+
+
+ + + +

P

+
+
packagePrefix() - Method in annotation type org.sosy_lab.common.configuration.ClassOption
+
+
This field provides optional package prefixes that can be added to the specified class name.
+
+
pair(T, Rational) - Static method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Deprecated. +
Use LinearExpression.monomial(T, org.sosy_lab.common.rationals.Rational) instead.
+
+
+
PathCopyingPersistentTreeMap<K extends Comparable<? super K>,​V extends @Nullable Object> - Class in org.sosy_lab.common.collect
+
+
This is an implementation of PersistentSortedMap that is based on left-leaning red-black + trees (LLRB) and path copying.
+
+
PathCounterTemplate - Class in org.sosy_lab.common.io
+
+
A template for Path objects that uses a counter to produce paths with a fresh new name + for every request.
+
+
PathTemplate - Class in org.sosy_lab.common.io
+
+
A template for paths, from which a real path can be constructed by passing some values to fill in + the blanks.
+
+
PersistentLinkedList<T> - Class in org.sosy_lab.common.collect
+
+
A single-linked-list implementation of PersistentList.
+
+
PersistentList<T> - Interface in org.sosy_lab.common.collect
+
+
Interface for persistent lists.
+
+
PersistentMap<K,​V extends @Nullable Object> - Interface in org.sosy_lab.common.collect
+
+
Interface for persistent map.
+
+
PersistentSortedMap<K,​V extends @Nullable Object> - Interface in org.sosy_lab.common.collect
+
+
Sub-interface of PersistentMap analog to NavigableMap.
+
+
PersistentSortedMaps - Class in org.sosy_lab.common.collect
+
+
Utility class for PersistentSortedMaps.
+
+
PersistentSortedMaps.MergeConflictHandler<K,​V> - Interface in org.sosy_lab.common.collect
+
+
A callback that is used when a key with two different values is encountered during the merge of + two maps.
+
+
plus(ExtendedRational) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
plus(Rational) - Method in class org.sosy_lab.common.rationals.Rational
+
+
Return a new instance equal to the sum of this and b.
+
+
pollFirstEntry() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
This method is not starvation free, and thus not strictly guaranteed to terminate in presence + of concurrent modifying operations.
+
+
pollFirstEntry() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
pollLastEntry() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
This method is not starvation free, and thus not strictly guaranteed to terminate in presence + of concurrent modifying operations.
+
+
pollLastEntry() - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
prefix() - Method in annotation type org.sosy_lab.common.configuration.Options
+
+
An optional prefix for all configuration options of the class annotated with this type.
+
+
prefix(String) - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Prefix of randomly-generated file name.
+
+
presentDoubles(Stream<OptionalDouble>) - Static method in class org.sosy_lab.common.Optionals
+
+
Get a DoubleStream of the present doubles of a stream of OptionalDoubles.
+
+
presentInstances(Iterable<Optional<T>>) - Static method in class org.sosy_lab.common.Optionals
+
+
Get an Iterable of the present instances of an iterable of Optionals.
+
+
presentInstances(Stream<Optional<T>>) - Static method in class org.sosy_lab.common.Optionals
+
+
Get a Stream of the present instances of a stream of Optionals.
+
+
presentInts(Stream<OptionalInt>) - Static method in class org.sosy_lab.common.Optionals
+
+
Get a IntStream of the present integers of a stream of OptionalInts.
+
+
presentLongs(Stream<OptionalLong>) - Static method in class org.sosy_lab.common.Optionals
+
+
Get a LongStream of the present longs of a stream of OptionalLongs.
+
+
prettyFormat() - Method in class org.sosy_lab.common.time.Timer
+
+
Syntax sugar method: pretty-format the timer output into a string in seconds.
+
+
print(String) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Write a String to the process.
+
+
println(String) - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Write a String to the process.
+
+
process(Set<? extends TypeElement>, RoundEnvironment) - Method in class org.sosy_lab.common.configuration.OptionAnnotationProcessor
+
 
+
ProcessExecutor<E extends Exception> - Class in org.sosy_lab.common
+
+
This class can be used to execute a separate process and read its output in a convenient way.
+
+
ProcessExecutor(LogManager, Class<E>, File, String...) - Constructor for class org.sosy_lab.common.ProcessExecutor
+
+
See ProcessExecutor(LogManager, Class, File, String...).
+
+
ProcessExecutor(LogManager, Class<E>, String...) - Constructor for class org.sosy_lab.common.ProcessExecutor
+
+
See ProcessExecutor(LogManager, Class, String...).
+
+
ProcessExecutor(LogManager, Class<E>, Map<String, String>, File, String...) - Constructor for class org.sosy_lab.common.ProcessExecutor
+
+
Create an instance and immediately execute the supplied command with the supplied environment + variables.
+
+
ProcessExecutor(LogManager, Class<E>, Map<String, String>, String...) - Constructor for class org.sosy_lab.common.ProcessExecutor
+
+
See ProcessExecutor(LogManager, Class, Map, String...).
+
+
produceClassLoadingWarning(LogManager, Class<?>, Class<?>) - Static method in class org.sosy_lab.common.Classes
+
 
+
publish(LogRecord) - Method in class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
put(K, V) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
This method is not starvation free, and thus not strictly guaranteed to terminate in presence + of concurrent modifying operations.
+
+
put(K, V) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
putAll(Map<? extends K, ? extends V>) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
This method is not atomic! It inserts all keys one after the other, and in between each + operation arbitrary operations from other threads might get executed.
+
+
putAll(Map<? extends K, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
putAndCopy(K, V) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
putAndCopy(K, V) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Replacement for {PersistentMap.put(Object, Object) that returns a fresh instance.
+
+
putAndCopy(K, V) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
putIfAbsent(K, V) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
+ + + +

R

+
+
rankOf(E) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Return the rank of the given element in this set.
+
+
rankOf(K) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Return the rank of the entry with the given key in this map.
+
+
Rational - Class in org.sosy_lab.common.rationals
+
+
Rational class, throws IllegalArgumentException on unsupported operations (e.g.
+
+
RATIONAL - org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
 
+
reciprocal() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
reciprocal() - Method in class org.sosy_lab.common.rationals.Rational
+
+
Return reciprocal of this.
+
+
recursiveInject(Object) - Method in class org.sosy_lab.common.configuration.Configuration
+
+
Call Configuration.inject(Object, Class) for this object with its actual class and all super class + that have an Options annotation.
+
+
regexp() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
If regexp is specified, the value of this option (prior to conversion to the correct type) will + be checked against this regular expression.
+
+
register() - Method in class org.sosy_lab.common.AbstractMBean
+
+
Register this instance at the platform MBeanServer.
+
+
register(ShutdownNotifier.ShutdownRequestListener) - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Register a listener that will be notified once a shutdown is requested for the first time on + the associated ShutdownManager instance with ShutdownManager.requestShutdown(String).
+
+
registerAndCheckImmediately(ShutdownNotifier.ShutdownRequestListener) - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Register a listener that will be notified once a shutdown is requested for the first time on + the associated ShutdownManager instance with ShutdownManager.requestShutdown(String), or immediately if this was already the case.
+
+
remove(int) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
remove(Object) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
+
This method is not starvation free, and thus not strictly guaranteed to terminate in presence + of concurrent modifying operations.
+
+
remove(Object) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
remove(Object) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
remove(Object, Object) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
removeAll(Collection<?>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
removeAndCopy(Object) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
removeAndCopy(Object) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Replacement for {PersistentMap.remove(Object) that returns a fresh instance.
+
+
removeAndCopy(Object) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
removeByRank(int) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
+
Remove the entry of this map with the given rank and return its key.
+
+
removeByRank(int) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
+
Remove the element of this set with the given rank and return it.
+
+
replace(K, V) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
replace(K, V, V) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
replaceAll(BiFunction<? super K, ? super V, ? extends V>) - Method in interface org.sosy_lab.common.collect.PersistentMap
+
+
Deprecated. +
Unsupported operation.
+
+
+
replaceAll(UnaryOperator<T>) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Deprecated.
+
+
replaceAll(UnaryOperator<T>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
requestShutdown(String) - Method in class org.sosy_lab.common.ShutdownManager
+
+
Request a shutdown of all components that check the associated ShutdownNotifier, by + letting ShutdownNotifier.shouldShutdown() return true in the future, and by notifying + all registered listeners.
+
+
required() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
An optional flag if this option needs to be specified in the configuration file.
+
+
REQUIRED_INPUT_FILE - org.sosy_lab.common.configuration.FileOption.Type
+
+
The file specified with this option is a required input file (a non-existing file will be + considered an invalid configuration).
+
+
resetSeenMessages() - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
+
Reset all seen log messages, such that LogManagerWithoutDuplicates.logfOnce(Level, String, Object...) and LogManagerWithoutDuplicates.logfOnce(Level, String, Object...) will be guaranteed to behave exactly like in a fresh + instance of this class.
+
+
resolveConflict(K, V, V) - Method in interface org.sosy_lab.common.collect.PersistentSortedMaps.MergeConflictHandler
+
+
Resolve a conflict for one given key.
+
+
retainAll(Collection<?>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
ReturnValuesAreNonnullByDefault - Annotation Type in org.sosy_lab.common.annotations
+
+
An annotation similar to ParametersAreNonnullByDefault that defines that + all methods inside the annotated element do not return null, unless this is overridden with + another annotation.
+
+
reversed() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a new list with the elements in the reverse order.
+
+
reversed() - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Returns a new list with the elements in the reverse order.
+
+
rightValueOnly(K, V) - Method in class org.sosy_lab.common.collect.MapsDifference.DefaultVisitor
+
 
+
rightValueOnly(K, V) - Method in interface org.sosy_lab.common.collect.MapsDifference.Visitor
+
 
+
run() - Method in class org.sosy_lab.common.LazyFutureTask
+
 
+
+ + + +

S

+
+
secure() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
An optional flag that this configuration option is secure, i.e., setting it to an arbitrary + attacker-controlled value may not allow any harm (like abitrary code execution).
+
+
sendEOF() - Method in class org.sosy_lab.common.ProcessExecutor
+
+
Sends the EOF (end of file) signal to stdin of the process.
+
+
set(int, T) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
setConsoleLevel(String) - Method in interface org.sosy_lab.common.log.BasicLogManager.LogManagerMXBean
+
 
+
setCustomLookupNativeLibraries(String...) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
See Classes.ClassLoaderBuilder.setCustomLookupNativeLibraries(Predicate).
+
+
setCustomLookupNativeLibraries(Predicate<String>) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set a predicate that specifies for which native libraries we should use a custom lookup for + the binary as documented in NativeLibraries.
+
+
setCustomLookupNativeLibraries(Pattern) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
See Classes.ClassLoaderBuilder.setCustomLookupNativeLibraries(Predicate).
+
+
setDirectLoadClasses(Predicate<String>) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set a predicate that specifies which classes are forced to be loaded by the new class loader + and not its parent, even if the latter could load them.
+
+
setDirectLoadClasses(Pattern) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
See Classes.ClassLoaderBuilder.setDirectLoadClasses(Predicate).
+
+
setOption(String, String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Set a single option.
+
+
setOptions(Map<String, String>) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Add all options from a map.
+
+
setParent(ClassLoader) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set parent of new class loader.
+
+
setParentAndUrls(URLClassLoader) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set an URLClassLoader as parent and its URLs from URLClassLoader.getURLs() as + sources for new class loader.
+
+
setPrefix(String) - Method in class org.sosy_lab.common.configuration.ConfigurationBuilder
+
+
Set the optional prefix for new configuration.
+
+
setSourceComponentName(String) - Method in class org.sosy_lab.common.log.ExtendedLogRecord
+
 
+
setUrls(Iterable<URL>) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set sources for classes of new class loader just like for URLClassLoader (this or + Classes.ClassLoaderBuilder.setUrls(URL...) are required).
+
+
setUrls(URL...) - Method in class org.sosy_lab.common.Classes.ClassLoaderBuilder
+
+
Set sources for classes of new class loader just like for URLClassLoader (this or + Classes.ClassLoaderBuilder.setUrls(Iterable) are required).
+
+
shouldShutdown() - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Check whether a shutdown was previously requested.
+
+
shutdownIfNecessary() - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Check whether a shutdown was previously requested, and throw an InterruptedException in + this case.
+
+
ShutdownManager - Class in org.sosy_lab.common
+
+
Together with ShutdownNotifier, this class implements a service for distributing shutdown + requests throughout an application's component, potentially in a hierarchy.
+
+
ShutdownNotifier - Class in org.sosy_lab.common
+
+
This class allows code to check whether it should terminate for some reason, and to be notified + of such requests.
+
+
ShutdownNotifier.ShutdownRequestListener - Interface in org.sosy_lab.common
+
 
+
shutdownRequested(String) - Method in interface org.sosy_lab.common.ShutdownNotifier.ShutdownRequestListener
+
+
This method is called on registered listeners the first time ShutdownManager.requestShutdown(String) on the associated ShutdownManager instance + is called.
+
+
signum() - Method in class org.sosy_lab.common.rationals.Rational
+
+
Returns -1, 0 or 1, representing the sign of the rational number.
+
+
size() - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
size() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns the number of elements in the list.
+
+
size() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Returns number of variables with non-zero coefficients.
+
+
sort(Comparator<? super T>) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Deprecated.
+
+
sort(Comparator<? super T>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Deprecated. +
Unsupported operation.
+
+
+
start() - Method in class org.sosy_lab.common.time.Timer
+
+
Start the timer.
+
+
startBoth() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Start both timers.
+
+
startOuter() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Start the outer timer.
+
+
startsWithIgnoreCase(String, String) - Static method in class org.sosy_lab.common.MoreStrings
+
+
Check whether a string starts with a given prefix similar to String.startsWith(String), + but ignoring the case like String.equalsIgnoreCase(String).
+
+
stop() - Method in class org.sosy_lab.common.time.Timer
+
+
Stop the timer.
+
+
stopBoth() - Method in class org.sosy_lab.common.time.NestedTimer
+
 
+
stopIfRunning() - Method in class org.sosy_lab.common.time.Timer
+
 
+
stopOuter() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Stop the outer timer.
+
+
StringBuildingLogHandler - Class in org.sosy_lab.common.log
+
+
This class may be used to read the log into a String.
+
+
StringBuildingLogHandler() - Constructor for class org.sosy_lab.common.log.StringBuildingLogHandler
+
 
+
sub(LinearExpression<T>) - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Subtract other linear expression.
+
+
subMap(K, boolean, K, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
subMap(K, boolean, K, boolean) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
subMap(K, boolean, K, boolean) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
subMap(K, K) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
subMap(K, K) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
subMap(K, K) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
subMapWithPrefix(NavigableMap<String, V>, String) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Given a NavigableMap with Strings as key, return a partial map (similar to + NavigableMap.subMap(Object, Object)) of all keys that have a given prefix.
+
+
subMapWithPrefix(SortedMap<String, V>, String) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Given a SortedMap with Strings as key, return a partial map (similar to SortedMap.subMap(Object, Object)) of all keys that have a given prefix.
+
+
subSet(E, boolean, E, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
subSet(E, E) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
subSetWithPrefix(NavigableSet<String>, String) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Given a NavigableSet of String, return a set (similar to NavigableSet.subSet(Object, Object)) of all entries that have a given prefix.
+
+
subSetWithPrefix(SortedSet<String>, String) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Given a SortedSet of String, return a set (similar to SortedSet.subSet(Object, Object)) of all entries that have a given prefix.
+
+
subtractFrom(Temporal) - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
suffix(String) - Method in class org.sosy_lab.common.io.TempFile.TempFileBuilder
+
+
Suffix of randomly generated file name, default is .tmp.
+
+
sum(Iterable<TimeSpan>) - Static method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the sum of several time spans.
+
+
sum(TimeSpan...) - Static method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the sum of several time spans.
+
+
sum(TimeSpan, TimeSpan) - Static method in class org.sosy_lab.common.time.TimeSpan
+
+
Create a new time span that is the sum of two time spans.
+
+
SuppressForbidden - Annotation Type in org.sosy_lab.common.annotations
+
+
Annotation similar to SuppressWarnings, but intended to be used with + https://github.com/policeman-tools/forbidden-apis.
+
+
+ + + +

T

+
+
tail() - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns the remainder of the list without the first element.
+
+
tailMap(K) - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
tailMap(K) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
tailMap(K) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
tailMap(K, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticMap
+
 
+
tailMap(K, boolean) - Method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
 
+
tailMap(K, boolean) - Method in interface org.sosy_lab.common.collect.PersistentSortedMap
+
 
+
tailSet(E) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
tailSet(E, boolean) - Method in interface org.sosy_lab.common.collect.OrderStatisticSet
+
 
+
TempFile - Class in org.sosy_lab.common.io
+
+
Utilities for temporary files.
+
+
TempFile.DeleteOnCloseDir - Class in org.sosy_lab.common.io
+
+
A simple wrapper around Path that calls MoreFiles.deleteRecursively(Path, + com.google.common.io.RecursiveDeleteOption...) recursively from AutoCloseable.close() + to delete the directory including its contents.
+
+
TempFile.DeleteOnCloseFile - Class in org.sosy_lab.common.io
+
+
A simple wrapper around Path that calls Files.deleteIfExists(Path) from AutoCloseable.close().
+
+
TempFile.TempFileBuilder - Class in org.sosy_lab.common.io
+
 
+
testEquals() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testEquals() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_descendingSetFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_descendingSetLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_descendingSetSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_outOfBounds() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_subsetFirst() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_subsetLast() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetByRank_valid() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testGetEntryByRank_descendingMapFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_descendingMapLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_descendingMapSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_outOfBounds() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_submapFirst() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_submapLast() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetEntryByRank_valid() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_descendingMapFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_descendingMapLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_descendingMapSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_outOfBounds() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_submapFirst() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_submapLast() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testGetKeyByRank_valid() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testKeyset_mutation() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
TestLogManager - Enum in org.sosy_lab.common.log
+
+
Deprecated. +
Use LogManager.createTestLogManager() instead. This class will be made + package-private.
+
+
+
testRankOf_descendingMapFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_descendingMapLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_descendingMapSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_descendingSetFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_descendingSetLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_descendingSetSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_firstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_firstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_lastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_lastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_secondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_secondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_subMapFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_subMapLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_subMapSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRankOf_subSetFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_subSetLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRankOf_subSetSecondElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_descendingMapFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_descendingMapLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_descendingSetFirstElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_descendingSetLastElement() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_invalid() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_invalid() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_submapFirst() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_submapLast() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_subsetFirst() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_subsetLast() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testRemoveByRank_valid() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testRemoveByRank_valid() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSerialize() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSerialize() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubmapView_descending() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubmapView_mutation() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubmapView_outOfBounds_add() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubmapView_outOfBounds_contains() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubmapView_outOfBounds_remove() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubmapView_submapOfSubmap() - Method in class org.sosy_lab.common.collect.OrderStatisticMapTestSuite
+
 
+
testSubsetView_descending() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubsetView_mutation() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubsetView_outOfBounds_add() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubsetView_outOfBounds_contains() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubsetView_outOfBounds_remove() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
testSubsetView_subsetOfSubset() - Method in class org.sosy_lab.common.collect.OrderStatisticSetTestSuite
+
 
+
Tickers - Class in org.sosy_lab.common.time
+
+
Class providing several convenient Ticker implementations.
+
+
Tickers.TickerWithUnit - Class in org.sosy_lab.common.time
+
 
+
TickerWithUnit() - Constructor for class org.sosy_lab.common.time.Tickers.TickerWithUnit
+
 
+
Timer - Class in org.sosy_lab.common.time
+
+
This class represents a timer like a stop watch.
+
+
Timer() - Constructor for class org.sosy_lab.common.time.Timer
+
+
Create a fresh timer in the not-running state.
+
+
times(ExtendedRational) - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
times(Rational) - Method in class org.sosy_lab.common.rationals.Rational
+
+
Multiply by b, return a new instance.
+
+
TimeSpan - Class in org.sosy_lab.common.time
+
+
This is an immutable representation of some time span, using a TimeUnit and a value.
+
+
TimeSpanOption - Annotation Type in org.sosy_lab.common.configuration
+
+
This is an annotation for all integer options that specify some sort of time duration (e.g., a + timeout).
+
+
TimeSpanTypeConverter - Class in org.sosy_lab.common.configuration.converters
+
+
Type converter for options annotated with TimeSpanOption.
+
+
TimeSpanTypeConverter() - Constructor for class org.sosy_lab.common.configuration.converters.TimeSpanTypeConverter
+
 
+
TimestampedLogFormatter - Class in org.sosy_lab.common.log
+
+
Log formatter that produces output containing a timestamp.
+
+
TimestampedLogFormatter(boolean) - Constructor for class org.sosy_lab.common.log.TimestampedLogFormatter
+
 
+
toByteSink() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
toByteSource() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
toCharArray(CharSource) - Static method in class org.sosy_lab.common.io.IO
+
+
Read the full content of a CharSource to a char array.
+
+
toCharSink(Charset) - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
toCharSource(Charset) - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
toChecked(TimeUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Return a TimeSpan that represents (approximately) the same time span, but whose unit is the + given unit.
+
+
toDouble() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
+
Returns rational converted to double.
+
+
toGuavaOptional(Optional<T>) - Static method in class org.sosy_lab.common.Optionals
+
+
Deprecated. +
use Optional.fromJavaUtil(Optional)
+
+
+
toImmutableList() - Static method in class org.sosy_lab.common.collect.MoreCollectors
+
+
Deprecated. +
use ImmutableList.toImmutableList()
+
+
+
toImmutableSet() - Static method in class org.sosy_lab.common.collect.MoreCollectors
+
+
Deprecated. +
use ImmutableList.toImmutableList()
+
+
+
toLongString() - Method in interface org.sosy_lab.common.MoreStrings.WithLongString
+
+
Return a string representation of this instance that has some more details than Object.toString().
+
+
toPath() - Method in class org.sosy_lab.common.io.MoreFiles.DeleteOnCloseFile
+
+
Deprecated.
+ 
+
toPath() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseDir
+
 
+
toPath() - Method in class org.sosy_lab.common.io.TempFile.DeleteOnCloseFile
+
 
+
toPathCopyingPersistentTreeMap(Function<? super T, ? extends K>, Function<? super T, ? extends V>) - Static method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
+
Return a Collector that accumulates elements into a PathCopyingPersistentTreeMap.
+
+
toPathCopyingPersistentTreeMap(Function<? super T, ? extends K>, Function<? super T, ? extends V>, BinaryOperator<V>) - Static method in class org.sosy_lab.common.collect.PathCopyingPersistentTreeMap
+
+
Return a Collector that accumulates elements into a PathCopyingPersistentTreeMap.
+
+
toPersistentLinkedList() - Static method in class org.sosy_lab.common.collect.MoreCollectors
+
+
Deprecated. +
use PersistentLinkedList.toPersistentLinkedList()
+
+
+
toPersistentLinkedList() - Static method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Return a Collector that creates PersistentLinkedLists and can be used in Stream.collect(Collector).
+
+
toSaturated(TimeUnit) - Method in class org.sosy_lab.common.time.TimeSpan
+
+
Return a TimeSpan that represents (approximately) the same time span, but whose unit is the + given unit.
+
+
toString() - Method in class org.sosy_lab.common.Appenders.AbstractAppender
+
 
+
toString() - Method in class org.sosy_lab.common.configuration.Configuration
+
 
+
toString() - Method in class org.sosy_lab.common.io.PathCounterTemplate
+
 
+
toString() - Method in class org.sosy_lab.common.io.PathTemplate
+
 
+
toString() - Method in class org.sosy_lab.common.log.ExtendedLogRecord
+
 
+
toString() - Method in class org.sosy_lab.common.rationals.ExtendedRational
+
+
Returns one of TWO things.
+
+
toString() - Method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Returns a pretty-printed form of the linear expression.
+
+
toString() - Method in class org.sosy_lab.common.rationals.Rational
+
+
Returns string of the form num/den.
+
+
toString() - Method in class org.sosy_lab.common.time.NestedTimer
+
+
Return a String with a default representation of the the sum of the times of total intervals.
+
+
toString() - Method in class org.sosy_lab.common.time.Timer
+
+
Return a String with a default representation of the the sum of the times of all intervals.
+
+
toString() - Method in class org.sosy_lab.common.time.TimeSpan
+
 
+
toString(Path, Charset) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
use asCharSource(file, charset).read()
+
+
+
toString(Appender) - Static method in class org.sosy_lab.common.Appenders
+
+
Convert an Appender into a string by calling it's Appender.appendTo(Appendable) + method.
+
+
toStringBuilder(CharSource) - Static method in class org.sosy_lab.common.io.IO
+
+
Read the full content of a CharSource to a new StringBuilder.
+
+
toStringWithTruncation(Appender, int) - Static method in class org.sosy_lab.common.Appenders
+
+
Convert an Appender into a string by calling it's Appender.appendTo(Appendable) + method.
+
+
toUppercase() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
An optional flag that specifies if a configuration value should be converted to upper case + after it was read.
+
+
transformedImmutableListCopy(Collection<T1>, Function<? super T1, T2>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Apply a function to all elements in a collection and return an ImmutableList with the + results.
+
+
transformedImmutableListCopy(T1[], Function<? super T1, T2>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Apply a function to all elements in an array and return an ImmutableList with the + results.
+
+
transformedImmutableSetCopy(Collection<T1>, Function<? super T1, T2>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Apply a function to all elements in a collection and return an ImmutableSet with the + results.
+
+
TypeConverter - Interface in org.sosy_lab.common.configuration.converters
+
+
TypeConverters are used to parse Strings into instances of specific types during configuration + option injection as performed by Configuration.inject(Object).
+
+
+ + + +

U

+
+
UnexpectedCheckedException(String, Throwable) - Constructor for exception org.sosy_lab.common.Classes.UnexpectedCheckedException
+
 
+
UniqueIdGenerator - Class in org.sosy_lab.common
+
+
Utility class for generating unique.
+
+
UniqueIdGenerator() - Constructor for class org.sosy_lab.common.UniqueIdGenerator
+
 
+
unit() - Method in class org.sosy_lab.common.time.Tickers.TickerWithUnit
+
 
+
Unmaintained - Annotation Type in org.sosy_lab.common.annotations
+
+
Annotation for component that are considered unmaintained, and might have inferior quality.
+
+
unregister() - Method in class org.sosy_lab.common.AbstractMBean
+
+
Unregister this instance.
+
+
unregister(ShutdownNotifier.ShutdownRequestListener) - Method in class org.sosy_lab.common.ShutdownNotifier
+
+
Unregister a listener.
+
+
useColors() - Method in class org.sosy_lab.common.log.LoggingOptions
+
 
+
+ + + +

V

+
+
value() - Method in annotation type org.sosy_lab.common.annotations.SuppressForbidden
+
+
Description and explanation of what and why is suppressed.
+
+
value() - Method in class org.sosy_lab.common.configuration.AnnotatedValue
+
 
+
value() - Method in annotation type org.sosy_lab.common.configuration.FileOption
+
+
More details for file options.
+
+
valueOf(Class<?>, String, String) - Static method in enum org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
+
Invoke the static "valueOf(String)" method on a class.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.configuration.FileOption.Type
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in enum org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
+
Returns the enum constant of this type with the specified name.
+
+
valueOf(String) - Static method in class org.sosy_lab.common.time.TimeSpan
+
+
Converts the given String into a TimeSpan object.
+
+
values() - Method in class org.sosy_lab.common.collect.CopyOnWriteSortedMap
+
 
+
values() - Static method in enum org.sosy_lab.common.configuration.converters.BaseTypeConverter
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum org.sosy_lab.common.configuration.FileOption.Type
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Method in annotation type org.sosy_lab.common.configuration.Option
+
+
If values is non-empty, the value of this option (prior to conversion to the correct type) will + be checked if it is listed in this array.
+
+
values() - Static method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
values() - Static method in enum org.sosy_lab.common.rationals.ExtendedRational.NumberType
+
+
Returns an array containing the constants of this enum type, in +the order they are declared.
+
+
verifyDeclaredExceptions(Invokable<?, ?>, Class<?>...) - Static method in class org.sosy_lab.common.Classes
+
+
Verify that a constructor or method declares no other checked exceptions except a given type.
+
+
verifyDeclaredExceptions(Executable, Class<?>...) - Static method in class org.sosy_lab.common.Classes
+
+
Verify that a constructor or method declares no other checked exceptions except a given type.
+
+
+ + + +

W

+
+
waitForTermination(ExecutorService) - Static method in class org.sosy_lab.common.Concurrency
+
+
Wait uninterruptibly until an ExecutorService has shutdown.
+
+
WINDOWS - org.sosy_lab.common.NativeLibraries.OS
+
+
Deprecated.
+ 
+
with(T) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a new list with value as the head and the old list as the tail.
+
+
with(T) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Replacement for PersistentList.add(Object) that returns a fresh new instance.
+
+
withAll(List<T>) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a new list with values as the head and the old list as the tail.
+
+
withAll(List<T>) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Replacement for PersistentList.addAll(Collection) that returns a fresh new instance.
+
+
withColorsIfPossible() - Static method in class org.sosy_lab.common.log.ConsoleLogFormatter
+
 
+
withColorsIfPossible() - Static method in class org.sosy_lab.common.log.TimestampedLogFormatter
+
 
+
withComponentName(String) - Method in class org.sosy_lab.common.log.BasicLogManager
+
 
+
withComponentName(String) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Returns a new LogManager instance which may use the given name as an indicator from which + component a log message comes from.
+
+
withComponentName(String) - Method in class org.sosy_lab.common.log.LogManagerWithoutDuplicates
+
+
This method returns a new LogManagerWithoutDuplicates, which does not share state with the + current instance (i.e., it is possible to log the same message both through the old and the new + instance once).
+
+
withComponentName(String) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
withComponentName(String) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
without(T) - Method in class org.sosy_lab.common.collect.PersistentLinkedList
+
+
Returns a new list omitting the specified value.
+
+
without(T) - Method in interface org.sosy_lab.common.collect.PersistentList
+
+
Replacement for PersistentList.remove(Object) that returns a fresh new instance.
+
+
withoutColors() - Static method in class org.sosy_lab.common.log.ConsoleLogFormatter
+
 
+
withoutColors() - Static method in class org.sosy_lab.common.log.TimestampedLogFormatter
+
 
+
wouldBeLogged(Level) - Method in class org.sosy_lab.common.log.BasicLogManager
+
+
Returns true if a message with the given log level would be logged.
+
+
wouldBeLogged(Level) - Method in class org.sosy_lab.common.log.ForwardingLogManager
+
 
+
wouldBeLogged(Level) - Method in interface org.sosy_lab.common.log.LogManager
+
+
Returns true if a message with the given log level would be logged.
+
+
wouldBeLogged(Level) - Method in enum org.sosy_lab.common.log.NullLogManager
+
+
Deprecated.
+ 
+
wouldBeLogged(Level) - Method in enum org.sosy_lab.common.log.TestLogManager
+
+
Deprecated.
+ 
+
write(byte[]) - Method in class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
write(byte[], int, int) - Method in class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
write(int) - Method in class org.sosy_lab.common.io.DuplicateOutputStream
+
 
+
writeFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.IO
+
+
Writes content to a file.
+
+
writeFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
moved to IO
+
+
+
writeGZIPFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.IO
+
+
Writes content to a file compressed in GZIP format.
+
+
writeGZIPFile(Path, Charset, Object) - Static method in class org.sosy_lab.common.io.MoreFiles
+
+
Deprecated. +
moved to IO
+
+
+
writeJSONString(Object, Appendable) - Static method in class org.sosy_lab.common.JSON
+
+
Encode an object into JSON text and write it to out.
+
+
writeJSONString(Object, Path) - Static method in class org.sosy_lab.common.JSON
+
+
Encode an object into JSON text and write it to a file.
+
+
writeMonomial(String, Rational, StringBuilder) - Static method in class org.sosy_lab.common.rationals.LinearExpression
+
+
Pretty-print monomial to the given StringBuilder.
+
+
+ + + +

X

+
+
X86 - org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+ 
+
X86_64 - org.sosy_lab.common.NativeLibraries.Architecture
+
+
Deprecated.
+ 
+
+ + + +

Z

+
+
ZERO - Static variable in class org.sosy_lab.common.rationals.ExtendedRational
+
 
+
ZERO - Static variable in class org.sosy_lab.common.rationals.Rational
+
 
+
zipMapEntries(Iterable<Map.Entry<K, V>>, BiFunction<K, V, R>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Provide a stream that consists of the result of applying the given function to each of the map + entries, similarly to Streams.zip(Stream, Stream, + BiFunction).
+
+
zipMapEntries(Map<K, V>, BiFunction<K, V, R>) - Static method in class org.sosy_lab.common.collect.Collections3
+
+
Provide a stream that consists of the result of applying the given function to each of a map's + entries, similarly to Streams.zip(Stream, Stream, + BiFunction).
+
+
+A B C D E F G H I J K L M N O P R S T U V W X Z 
All Classes All Packages
+
+ + + diff --git a/api/index.html b/api/index.html new file mode 100644 index 000000000..a5d56761f --- /dev/null +++ b/api/index.html @@ -0,0 +1,216 @@ + + + + + +Overview (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Sosy-Lab Common Library

+
+
+

SoSy-Lab Common is a library of useful utilities.

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
org.sosy_lab.common +
This package contains general utilities that do not fit anywhere else.
+
org.sosy_lab.common.annotations +
This package contains several general-purpose annotations.
+
org.sosy_lab.common.collect +
This package contains additional interfaces and implementations for collections, as well as + further collection utilities.
+
org.sosy_lab.common.configuration +
Java-Config is a library for injecting configuration options in a decentralized way.
+
org.sosy_lab.common.configuration.converters +
This package provides the possibility to convert String values into appropriate objects of + certain types.
+
org.sosy_lab.common.io +
This package contains utilities for I/O.
+
org.sosy_lab.common.log +
This package provides a logging framework.
+
org.sosy_lab.common.rationals +
Java-Rationals is a library for working with rationals and extended rationals in Java.
+
org.sosy_lab.common.time +
This package provides possibilities for measuring elapsed time, and a data class TimeSpan for storing time spans together with the respective time unit.
+
+
+
+ + + diff --git a/api/jquery-ui.overrides.css b/api/jquery-ui.overrides.css new file mode 100644 index 000000000..facf852c2 --- /dev/null +++ b/api/jquery-ui.overrides.css @@ -0,0 +1,35 @@ +/* + * Copyright (c) 2020, 2022, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +.ui-state-active, +.ui-widget-content .ui-state-active, +.ui-widget-header .ui-state-active, +a.ui-button:active, +.ui-button:active, +.ui-button.ui-state-active:hover { + /* Overrides the color of selection used in jQuery UI */ + background: #F8981D; + border: 1px solid #F8981D; +} diff --git a/api/jquery/external/jquery/jquery.js b/api/jquery/external/jquery/jquery.js new file mode 100644 index 000000000..50937333b --- /dev/null +++ b/api/jquery/external/jquery/jquery.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( "\r\n"; + +// inject VBScript +document.write(IEBinaryToArray_ByteStr_Script); + +global.JSZipUtils._getBinaryFromXHR = function (xhr) { + var binary = xhr.responseBody; + var byteMapping = {}; + for ( var i = 0; i < 256; i++ ) { + for ( var j = 0; j < 256; j++ ) { + byteMapping[ String.fromCharCode( i + (j << 8) ) ] = + String.fromCharCode(i) + String.fromCharCode(j); + } + } + var rawBytes = IEBinaryToArray_ByteStr(binary); + var lastChr = IEBinaryToArray_ByteStr_Last(binary); + return rawBytes.replace(/[\s\S]/g, function( match ) { + return byteMapping[match]; + }) + lastChr; +}; + +// enforcing Stuk's coding style +// vim: set shiftwidth=4 softtabstop=4: + +},{}]},{},[1]) +; diff --git a/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js b/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js new file mode 100644 index 000000000..93d8bc8ef --- /dev/null +++ b/api/jquery/jszip-utils/dist/jszip-utils-ie.min.js @@ -0,0 +1,10 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g\r\n";document.write(b),a.JSZipUtils._getBinaryFromXHR=function(a){for(var b=a.responseBody,c={},d=0;256>d;d++)for(var e=0;256>e;e++)c[String.fromCharCode(d+(e<<8))]=String.fromCharCode(d)+String.fromCharCode(e);var f=IEBinaryToArray_ByteStr(b),g=IEBinaryToArray_ByteStr_Last(b);return f.replace(/[\s\S]/g,function(a){return c[a]})+g}},{}]},{},[1]); diff --git a/api/jquery/jszip-utils/dist/jszip-utils.js b/api/jquery/jszip-utils/dist/jszip-utils.js new file mode 100644 index 000000000..775895ec9 --- /dev/null +++ b/api/jquery/jszip-utils/dist/jszip-utils.js @@ -0,0 +1,118 @@ +/*! + +JSZipUtils - A collection of cross-browser utilities to go along with JSZip. + + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(e){"object"==typeof exports?module.exports=e():"function"==typeof define&&define.amd?define(e):"undefined"!=typeof window?window.JSZipUtils=e():"undefined"!=typeof global?global.JSZipUtils=e():"undefined"!=typeof self&&(self.JSZipUtils=e())}(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);throw new Error("Cannot find module '"+o+"'")}var f=n[o]={exports:{}};t[o][0].call(f.exports,function(e){var n=t[o][1][e];return s(n?n:e)},f,f.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o + +(c) 2014 Stuart Knightley, David Duponchel +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip-utils/master/LICENSE.markdown. + +*/ +!function(a){"object"==typeof exports?module.exports=a():"function"==typeof define&&define.amd?define(a):"undefined"!=typeof window?window.JSZipUtils=a():"undefined"!=typeof global?global.JSZipUtils=a():"undefined"!=typeof self&&(self.JSZipUtils=a())}(function(){return function a(b,c,d){function e(g,h){if(!c[g]){if(!b[g]){var i="function"==typeof require&&require;if(!h&&i)return i(g,!0);if(f)return f(g,!0);throw new Error("Cannot find module '"+g+"'")}var j=c[g]={exports:{}};b[g][0].call(j.exports,function(a){var c=b[g][1][a];return e(c?c:a)},j,j.exports,a,b,c,d)}return c[g].exports}for(var f="function"==typeof require&&require,g=0;g + +(c) 2009-2016 Stuart Knightley +Dual licenced under the MIT license or GPLv3. See https://raw.github.com/Stuk/jszip/master/LICENSE.markdown. + +JSZip uses the library pako released under the MIT license : +https://github.com/nodeca/pako/blob/master/LICENSE +*/ + +(function(f){if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=f()}else if(typeof define==="function"&&define.amd){define([],f)}else{var g;if(typeof window!=="undefined"){g=window}else if(typeof global!=="undefined"){g=global}else if(typeof self!=="undefined"){g=self}else{g=this}g.JSZip = f()}})(function(){var define,module,exports;return (function e(t,n,r){function s(o,u){if(!n[o]){if(!t[o]){var a=typeof require=="function"&&require;if(!u&&a)return a(o,!0);if(i)return i(o,!0);var f=new Error("Cannot find module '"+o+"'");throw f.code="MODULE_NOT_FOUND",f}var l=n[o]={exports:{}};t[o][0].call(l.exports,function(e){var n=t[o][1][e];return s(n?n:e)},l,l.exports,e,t,n,r)}return n[o].exports}var i=typeof require=="function"&&require;for(var o=0;o> 2; + enc2 = ((chr1 & 3) << 4) | (chr2 >> 4); + enc3 = remainingBytes > 1 ? (((chr2 & 15) << 2) | (chr3 >> 6)) : 64; + enc4 = remainingBytes > 2 ? (chr3 & 63) : 64; + + output.push(_keyStr.charAt(enc1) + _keyStr.charAt(enc2) + _keyStr.charAt(enc3) + _keyStr.charAt(enc4)); + + } + + return output.join(""); +}; + +// public method for decoding +exports.decode = function(input) { + var chr1, chr2, chr3; + var enc1, enc2, enc3, enc4; + var i = 0, resultIndex = 0; + + var dataUrlPrefix = "data:"; + + if (input.substr(0, dataUrlPrefix.length) === dataUrlPrefix) { + // This is a common error: people give a data url + // (data:image/png;base64,iVBOR...) with a {base64: true} and + // wonders why things don't work. + // We can detect that the string input looks like a data url but we + // *can't* be sure it is one: removing everything up to the comma would + // be too dangerous. + throw new Error("Invalid base64 input, it looks like a data url."); + } + + input = input.replace(/[^A-Za-z0-9\+\/\=]/g, ""); + + var totalLength = input.length * 3 / 4; + if(input.charAt(input.length - 1) === _keyStr.charAt(64)) { + totalLength--; + } + if(input.charAt(input.length - 2) === _keyStr.charAt(64)) { + totalLength--; + } + if (totalLength % 1 !== 0) { + // totalLength is not an integer, the length does not match a valid + // base64 content. That can happen if: + // - the input is not a base64 content + // - the input is *almost* a base64 content, with a extra chars at the + // beginning or at the end + // - the input uses a base64 variant (base64url for example) + throw new Error("Invalid base64 input, bad content length."); + } + var output; + if (support.uint8array) { + output = new Uint8Array(totalLength|0); + } else { + output = new Array(totalLength|0); + } + + while (i < input.length) { + + enc1 = _keyStr.indexOf(input.charAt(i++)); + enc2 = _keyStr.indexOf(input.charAt(i++)); + enc3 = _keyStr.indexOf(input.charAt(i++)); + enc4 = _keyStr.indexOf(input.charAt(i++)); + + chr1 = (enc1 << 2) | (enc2 >> 4); + chr2 = ((enc2 & 15) << 4) | (enc3 >> 2); + chr3 = ((enc3 & 3) << 6) | enc4; + + output[resultIndex++] = chr1; + + if (enc3 !== 64) { + output[resultIndex++] = chr2; + } + if (enc4 !== 64) { + output[resultIndex++] = chr3; + } + + } + + return output; +}; + +},{"./support":30,"./utils":32}],2:[function(require,module,exports){ +'use strict'; + +var external = require("./external"); +var DataWorker = require('./stream/DataWorker'); +var Crc32Probe = require('./stream/Crc32Probe'); +var DataLengthProbe = require('./stream/DataLengthProbe'); + +/** + * Represent a compressed object, with everything needed to decompress it. + * @constructor + * @param {number} compressedSize the size of the data compressed. + * @param {number} uncompressedSize the size of the data after decompression. + * @param {number} crc32 the crc32 of the decompressed file. + * @param {object} compression the type of compression, see lib/compressions.js. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the compressed data. + */ +function CompressedObject(compressedSize, uncompressedSize, crc32, compression, data) { + this.compressedSize = compressedSize; + this.uncompressedSize = uncompressedSize; + this.crc32 = crc32; + this.compression = compression; + this.compressedContent = data; +} + +CompressedObject.prototype = { + /** + * Create a worker to get the uncompressed content. + * @return {GenericWorker} the worker. + */ + getContentWorker: function () { + var worker = new DataWorker(external.Promise.resolve(this.compressedContent)) + .pipe(this.compression.uncompressWorker()) + .pipe(new DataLengthProbe("data_length")); + + var that = this; + worker.on("end", function () { + if (this.streamInfo['data_length'] !== that.uncompressedSize) { + throw new Error("Bug : uncompressed data size mismatch"); + } + }); + return worker; + }, + /** + * Create a worker to get the compressed content. + * @return {GenericWorker} the worker. + */ + getCompressedWorker: function () { + return new DataWorker(external.Promise.resolve(this.compressedContent)) + .withStreamInfo("compressedSize", this.compressedSize) + .withStreamInfo("uncompressedSize", this.uncompressedSize) + .withStreamInfo("crc32", this.crc32) + .withStreamInfo("compression", this.compression) + ; + } +}; + +/** + * Chain the given worker with other workers to compress the content with the + * given compression. + * @param {GenericWorker} uncompressedWorker the worker to pipe. + * @param {Object} compression the compression object. + * @param {Object} compressionOptions the options to use when compressing. + * @return {GenericWorker} the new worker compressing the content. + */ +CompressedObject.createWorkerFrom = function (uncompressedWorker, compression, compressionOptions) { + return uncompressedWorker + .pipe(new Crc32Probe()) + .pipe(new DataLengthProbe("uncompressedSize")) + .pipe(compression.compressWorker(compressionOptions)) + .pipe(new DataLengthProbe("compressedSize")) + .withStreamInfo("compression", compression); +}; + +module.exports = CompressedObject; + +},{"./external":6,"./stream/Crc32Probe":25,"./stream/DataLengthProbe":26,"./stream/DataWorker":27}],3:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require("./stream/GenericWorker"); + +exports.STORE = { + magic: "\x00\x00", + compressWorker : function (compressionOptions) { + return new GenericWorker("STORE compression"); + }, + uncompressWorker : function () { + return new GenericWorker("STORE decompression"); + } +}; +exports.DEFLATE = require('./flate'); + +},{"./flate":7,"./stream/GenericWorker":28}],4:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); + +/** + * The following functions come from pako, from pako/lib/zlib/crc32.js + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Use ordinary array, since untyped makes no boost here +function makeTable() { + var c, table = []; + + for(var n =0; n < 256; n++){ + c = n; + for(var k =0; k < 8; k++){ + c = ((c&1) ? (0xEDB88320 ^ (c >>> 1)) : (c >>> 1)); + } + table[n] = c; + } + + return table; +} + +// Create table on load. Just 255 signed longs. Not a problem. +var crcTable = makeTable(); + + +function crc32(crc, buf, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ buf[i]) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +// That's all for the pako functions. + +/** + * Compute the crc32 of a string. + * This is almost the same as the function crc32, but for strings. Using the + * same function for the two use cases leads to horrible performances. + * @param {Number} crc the starting value of the crc. + * @param {String} str the string to use. + * @param {Number} len the length of the string. + * @param {Number} pos the starting position for the crc32 computation. + * @return {Number} the computed crc32. + */ +function crc32str(crc, str, len, pos) { + var t = crcTable, end = pos + len; + + crc = crc ^ (-1); + + for (var i = pos; i < end; i++ ) { + crc = (crc >>> 8) ^ t[(crc ^ str.charCodeAt(i)) & 0xFF]; + } + + return (crc ^ (-1)); // >>> 0; +} + +module.exports = function crc32wrapper(input, crc) { + if (typeof input === "undefined" || !input.length) { + return 0; + } + + var isArray = utils.getTypeOf(input) !== "string"; + + if(isArray) { + return crc32(crc|0, input, input.length, 0); + } else { + return crc32str(crc|0, input, input.length, 0); + } +}; + +},{"./utils":32}],5:[function(require,module,exports){ +'use strict'; +exports.base64 = false; +exports.binary = false; +exports.dir = false; +exports.createFolders = true; +exports.date = null; +exports.compression = null; +exports.compressionOptions = null; +exports.comment = null; +exports.unixPermissions = null; +exports.dosPermissions = null; + +},{}],6:[function(require,module,exports){ +/* global Promise */ +'use strict'; + +// load the global object first: +// - it should be better integrated in the system (unhandledRejection in node) +// - the environment may have a custom Promise implementation (see zone.js) +var ES6Promise = null; +if (typeof Promise !== "undefined") { + ES6Promise = Promise; +} else { + ES6Promise = require("lie"); +} + +/** + * Let the user use/change some implementations. + */ +module.exports = { + Promise: ES6Promise +}; + +},{"lie":37}],7:[function(require,module,exports){ +'use strict'; +var USE_TYPEDARRAY = (typeof Uint8Array !== 'undefined') && (typeof Uint16Array !== 'undefined') && (typeof Uint32Array !== 'undefined'); + +var pako = require("pako"); +var utils = require("./utils"); +var GenericWorker = require("./stream/GenericWorker"); + +var ARRAY_TYPE = USE_TYPEDARRAY ? "uint8array" : "array"; + +exports.magic = "\x08\x00"; + +/** + * Create a worker that uses pako to inflate/deflate. + * @constructor + * @param {String} action the name of the pako function to call : either "Deflate" or "Inflate". + * @param {Object} options the options to use when (de)compressing. + */ +function FlateWorker(action, options) { + GenericWorker.call(this, "FlateWorker/" + action); + + this._pako = null; + this._pakoAction = action; + this._pakoOptions = options; + // the `meta` object from the last chunk received + // this allow this worker to pass around metadata + this.meta = {}; +} + +utils.inherits(FlateWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +FlateWorker.prototype.processChunk = function (chunk) { + this.meta = chunk.meta; + if (this._pako === null) { + this._createPako(); + } + this._pako.push(utils.transformTo(ARRAY_TYPE, chunk.data), false); +}; + +/** + * @see GenericWorker.flush + */ +FlateWorker.prototype.flush = function () { + GenericWorker.prototype.flush.call(this); + if (this._pako === null) { + this._createPako(); + } + this._pako.push([], true); +}; +/** + * @see GenericWorker.cleanUp + */ +FlateWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this._pako = null; +}; + +/** + * Create the _pako object. + * TODO: lazy-loading this object isn't the best solution but it's the + * quickest. The best solution is to lazy-load the worker list. See also the + * issue #446. + */ +FlateWorker.prototype._createPako = function () { + this._pako = new pako[this._pakoAction]({ + raw: true, + level: this._pakoOptions.level || -1 // default compression + }); + var self = this; + this._pako.onData = function(data) { + self.push({ + data : data, + meta : self.meta + }); + }; +}; + +exports.compressWorker = function (compressionOptions) { + return new FlateWorker("Deflate", compressionOptions); +}; +exports.uncompressWorker = function () { + return new FlateWorker("Inflate", {}); +}; + +},{"./stream/GenericWorker":28,"./utils":32,"pako":38}],8:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); +var utf8 = require('../utf8'); +var crc32 = require('../crc32'); +var signature = require('../signature'); + +/** + * Transform an integer into a string in hexadecimal. + * @private + * @param {number} dec the number to convert. + * @param {number} bytes the number of bytes to generate. + * @returns {string} the result. + */ +var decToHex = function(dec, bytes) { + var hex = "", i; + for (i = 0; i < bytes; i++) { + hex += String.fromCharCode(dec & 0xff); + dec = dec >>> 8; + } + return hex; +}; + +/** + * Generate the UNIX part of the external file attributes. + * @param {Object} unixPermissions the unix permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * adapted from http://unix.stackexchange.com/questions/14705/the-zip-formats-external-file-attribute : + * + * TTTTsstrwxrwxrwx0000000000ADVSHR + * ^^^^____________________________ file type, see zipinfo.c (UNX_*) + * ^^^_________________________ setuid, setgid, sticky + * ^^^^^^^^^________________ permissions + * ^^^^^^^^^^______ not used ? + * ^^^^^^ DOS attribute bits : Archive, Directory, Volume label, System file, Hidden, Read only + */ +var generateUnixExternalFileAttr = function (unixPermissions, isDir) { + + var result = unixPermissions; + if (!unixPermissions) { + // I can't use octal values in strict mode, hence the hexa. + // 040775 => 0x41fd + // 0100664 => 0x81b4 + result = isDir ? 0x41fd : 0x81b4; + } + return (result & 0xFFFF) << 16; +}; + +/** + * Generate the DOS part of the external file attributes. + * @param {Object} dosPermissions the dos permissions or null. + * @param {Boolean} isDir true if the entry is a directory, false otherwise. + * @return {Number} a 32 bit integer. + * + * Bit 0 Read-Only + * Bit 1 Hidden + * Bit 2 System + * Bit 3 Volume Label + * Bit 4 Directory + * Bit 5 Archive + */ +var generateDosExternalFileAttr = function (dosPermissions, isDir) { + + // the dir flag is already set for compatibility + return (dosPermissions || 0) & 0x3F; +}; + +/** + * Generate the various parts used in the construction of the final zip file. + * @param {Object} streamInfo the hash with information about the compressed file. + * @param {Boolean} streamedContent is the content streamed ? + * @param {Boolean} streamingEnded is the stream finished ? + * @param {number} offset the current offset from the start of the zip file. + * @param {String} platform let's pretend we are this platform (change platform dependents fields) + * @param {Function} encodeFileName the function to encode the file name / comment. + * @return {Object} the zip parts. + */ +var generateZipParts = function(streamInfo, streamedContent, streamingEnded, offset, platform, encodeFileName) { + var file = streamInfo['file'], + compression = streamInfo['compression'], + useCustomEncoding = encodeFileName !== utf8.utf8encode, + encodedFileName = utils.transformTo("string", encodeFileName(file.name)), + utfEncodedFileName = utils.transformTo("string", utf8.utf8encode(file.name)), + comment = file.comment, + encodedComment = utils.transformTo("string", encodeFileName(comment)), + utfEncodedComment = utils.transformTo("string", utf8.utf8encode(comment)), + useUTF8ForFileName = utfEncodedFileName.length !== file.name.length, + useUTF8ForComment = utfEncodedComment.length !== comment.length, + dosTime, + dosDate, + extraFields = "", + unicodePathExtraField = "", + unicodeCommentExtraField = "", + dir = file.dir, + date = file.date; + + + var dataInfo = { + crc32 : 0, + compressedSize : 0, + uncompressedSize : 0 + }; + + // if the content is streamed, the sizes/crc32 are only available AFTER + // the end of the stream. + if (!streamedContent || streamingEnded) { + dataInfo.crc32 = streamInfo['crc32']; + dataInfo.compressedSize = streamInfo['compressedSize']; + dataInfo.uncompressedSize = streamInfo['uncompressedSize']; + } + + var bitflag = 0; + if (streamedContent) { + // Bit 3: the sizes/crc32 are set to zero in the local header. + // The correct values are put in the data descriptor immediately + // following the compressed data. + bitflag |= 0x0008; + } + if (!useCustomEncoding && (useUTF8ForFileName || useUTF8ForComment)) { + // Bit 11: Language encoding flag (EFS). + bitflag |= 0x0800; + } + + + var extFileAttr = 0; + var versionMadeBy = 0; + if (dir) { + // dos or unix, we set the dos dir flag + extFileAttr |= 0x00010; + } + if(platform === "UNIX") { + versionMadeBy = 0x031E; // UNIX, version 3.0 + extFileAttr |= generateUnixExternalFileAttr(file.unixPermissions, dir); + } else { // DOS or other, fallback to DOS + versionMadeBy = 0x0014; // DOS, version 2.0 + extFileAttr |= generateDosExternalFileAttr(file.dosPermissions, dir); + } + + // date + // @see http://www.delorie.com/djgpp/doc/rbinter/it/52/13.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/65/16.html + // @see http://www.delorie.com/djgpp/doc/rbinter/it/66/16.html + + dosTime = date.getUTCHours(); + dosTime = dosTime << 6; + dosTime = dosTime | date.getUTCMinutes(); + dosTime = dosTime << 5; + dosTime = dosTime | date.getUTCSeconds() / 2; + + dosDate = date.getUTCFullYear() - 1980; + dosDate = dosDate << 4; + dosDate = dosDate | (date.getUTCMonth() + 1); + dosDate = dosDate << 5; + dosDate = dosDate | date.getUTCDate(); + + if (useUTF8ForFileName) { + // set the unicode path extra field. unzip needs at least one extra + // field to correctly handle unicode path, so using the path is as good + // as any other information. This could improve the situation with + // other archive managers too. + // This field is usually used without the utf8 flag, with a non + // unicode path in the header (winrar, winzip). This helps (a bit) + // with the messy Windows' default compressed folders feature but + // breaks on p7zip which doesn't seek the unicode path extra field. + // So for now, UTF-8 everywhere ! + unicodePathExtraField = + // Version + decToHex(1, 1) + + // NameCRC32 + decToHex(crc32(encodedFileName), 4) + + // UnicodeName + utfEncodedFileName; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x70" + + // size + decToHex(unicodePathExtraField.length, 2) + + // content + unicodePathExtraField; + } + + if(useUTF8ForComment) { + + unicodeCommentExtraField = + // Version + decToHex(1, 1) + + // CommentCRC32 + decToHex(crc32(encodedComment), 4) + + // UnicodeName + utfEncodedComment; + + extraFields += + // Info-ZIP Unicode Path Extra Field + "\x75\x63" + + // size + decToHex(unicodeCommentExtraField.length, 2) + + // content + unicodeCommentExtraField; + } + + var header = ""; + + // version needed to extract + header += "\x0A\x00"; + // general purpose bit flag + header += decToHex(bitflag, 2); + // compression method + header += compression.magic; + // last mod file time + header += decToHex(dosTime, 2); + // last mod file date + header += decToHex(dosDate, 2); + // crc-32 + header += decToHex(dataInfo.crc32, 4); + // compressed size + header += decToHex(dataInfo.compressedSize, 4); + // uncompressed size + header += decToHex(dataInfo.uncompressedSize, 4); + // file name length + header += decToHex(encodedFileName.length, 2); + // extra field length + header += decToHex(extraFields.length, 2); + + + var fileRecord = signature.LOCAL_FILE_HEADER + header + encodedFileName + extraFields; + + var dirRecord = signature.CENTRAL_FILE_HEADER + + // version made by (00: DOS) + decToHex(versionMadeBy, 2) + + // file header (common to file and central directory) + header + + // file comment length + decToHex(encodedComment.length, 2) + + // disk number start + "\x00\x00" + + // internal file attributes TODO + "\x00\x00" + + // external file attributes + decToHex(extFileAttr, 4) + + // relative offset of local header + decToHex(offset, 4) + + // file name + encodedFileName + + // extra field + extraFields + + // file comment + encodedComment; + + return { + fileRecord: fileRecord, + dirRecord: dirRecord + }; +}; + +/** + * Generate the EOCD record. + * @param {Number} entriesCount the number of entries in the zip file. + * @param {Number} centralDirLength the length (in bytes) of the central dir. + * @param {Number} localDirLength the length (in bytes) of the local dir. + * @param {String} comment the zip file comment as a binary string. + * @param {Function} encodeFileName the function to encode the comment. + * @return {String} the EOCD record. + */ +var generateCentralDirectoryEnd = function (entriesCount, centralDirLength, localDirLength, comment, encodeFileName) { + var dirEnd = ""; + var encodedComment = utils.transformTo("string", encodeFileName(comment)); + + // end of central dir signature + dirEnd = signature.CENTRAL_DIRECTORY_END + + // number of this disk + "\x00\x00" + + // number of the disk with the start of the central directory + "\x00\x00" + + // total number of entries in the central directory on this disk + decToHex(entriesCount, 2) + + // total number of entries in the central directory + decToHex(entriesCount, 2) + + // size of the central directory 4 bytes + decToHex(centralDirLength, 4) + + // offset of start of central directory with respect to the starting disk number + decToHex(localDirLength, 4) + + // .ZIP file comment length + decToHex(encodedComment.length, 2) + + // .ZIP file comment + encodedComment; + + return dirEnd; +}; + +/** + * Generate data descriptors for a file entry. + * @param {Object} streamInfo the hash generated by a worker, containing information + * on the file entry. + * @return {String} the data descriptors. + */ +var generateDataDescriptors = function (streamInfo) { + var descriptor = ""; + descriptor = signature.DATA_DESCRIPTOR + + // crc-32 4 bytes + decToHex(streamInfo['crc32'], 4) + + // compressed size 4 bytes + decToHex(streamInfo['compressedSize'], 4) + + // uncompressed size 4 bytes + decToHex(streamInfo['uncompressedSize'], 4); + + return descriptor; +}; + + +/** + * A worker to concatenate other workers to create a zip file. + * @param {Boolean} streamFiles `true` to stream the content of the files, + * `false` to accumulate it. + * @param {String} comment the comment to use. + * @param {String} platform the platform to use, "UNIX" or "DOS". + * @param {Function} encodeFileName the function to encode file names and comments. + */ +function ZipFileWorker(streamFiles, comment, platform, encodeFileName) { + GenericWorker.call(this, "ZipFileWorker"); + // The number of bytes written so far. This doesn't count accumulated chunks. + this.bytesWritten = 0; + // The comment of the zip file + this.zipComment = comment; + // The platform "generating" the zip file. + this.zipPlatform = platform; + // the function to encode file names and comments. + this.encodeFileName = encodeFileName; + // Should we stream the content of the files ? + this.streamFiles = streamFiles; + // If `streamFiles` is false, we will need to accumulate the content of the + // files to calculate sizes / crc32 (and write them *before* the content). + // This boolean indicates if we are accumulating chunks (it will change a lot + // during the lifetime of this worker). + this.accumulate = false; + // The buffer receiving chunks when accumulating content. + this.contentBuffer = []; + // The list of generated directory records. + this.dirRecords = []; + // The offset (in bytes) from the beginning of the zip file for the current source. + this.currentSourceOffset = 0; + // The total number of entries in this zip file. + this.entriesCount = 0; + // the name of the file currently being added, null when handling the end of the zip file. + // Used for the emitted metadata. + this.currentFile = null; + + + + this._sources = []; +} +utils.inherits(ZipFileWorker, GenericWorker); + +/** + * @see GenericWorker.push + */ +ZipFileWorker.prototype.push = function (chunk) { + + var currentFilePercent = chunk.meta.percent || 0; + var entriesCount = this.entriesCount; + var remainingFiles = this._sources.length; + + if(this.accumulate) { + this.contentBuffer.push(chunk); + } else { + this.bytesWritten += chunk.data.length; + + GenericWorker.prototype.push.call(this, { + data : chunk.data, + meta : { + currentFile : this.currentFile, + percent : entriesCount ? (currentFilePercent + 100 * (entriesCount - remainingFiles - 1)) / entriesCount : 100 + } + }); + } +}; + +/** + * The worker started a new source (an other worker). + * @param {Object} streamInfo the streamInfo object from the new source. + */ +ZipFileWorker.prototype.openedSource = function (streamInfo) { + this.currentSourceOffset = this.bytesWritten; + this.currentFile = streamInfo['file'].name; + + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + + // don't stream folders (because they don't have any content) + if(streamedContent) { + var record = generateZipParts(streamInfo, streamedContent, false, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + } else { + // we need to wait for the whole file before pushing anything + this.accumulate = true; + } +}; + +/** + * The worker finished a source (an other worker). + * @param {Object} streamInfo the streamInfo object from the finished source. + */ +ZipFileWorker.prototype.closedSource = function (streamInfo) { + this.accumulate = false; + var streamedContent = this.streamFiles && !streamInfo['file'].dir; + var record = generateZipParts(streamInfo, streamedContent, true, this.currentSourceOffset, this.zipPlatform, this.encodeFileName); + + this.dirRecords.push(record.dirRecord); + if(streamedContent) { + // after the streamed file, we put data descriptors + this.push({ + data : generateDataDescriptors(streamInfo), + meta : {percent:100} + }); + } else { + // the content wasn't streamed, we need to push everything now + // first the file record, then the content + this.push({ + data : record.fileRecord, + meta : {percent:0} + }); + while(this.contentBuffer.length) { + this.push(this.contentBuffer.shift()); + } + } + this.currentFile = null; +}; + +/** + * @see GenericWorker.flush + */ +ZipFileWorker.prototype.flush = function () { + + var localDirLength = this.bytesWritten; + for(var i = 0; i < this.dirRecords.length; i++) { + this.push({ + data : this.dirRecords[i], + meta : {percent:100} + }); + } + var centralDirLength = this.bytesWritten - localDirLength; + + var dirEnd = generateCentralDirectoryEnd(this.dirRecords.length, centralDirLength, localDirLength, this.zipComment, this.encodeFileName); + + this.push({ + data : dirEnd, + meta : {percent:100} + }); +}; + +/** + * Prepare the next source to be read. + */ +ZipFileWorker.prototype.prepareNextSource = function () { + this.previous = this._sources.shift(); + this.openedSource(this.previous.streamInfo); + if (this.isPaused) { + this.previous.pause(); + } else { + this.previous.resume(); + } +}; + +/** + * @see GenericWorker.registerPrevious + */ +ZipFileWorker.prototype.registerPrevious = function (previous) { + this._sources.push(previous); + var self = this; + + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.closedSource(self.previous.streamInfo); + if(self._sources.length) { + self.prepareNextSource(); + } else { + self.end(); + } + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; +}; + +/** + * @see GenericWorker.resume + */ +ZipFileWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this.previous && this._sources.length) { + this.prepareNextSource(); + return true; + } + if (!this.previous && !this._sources.length && !this.generatedError) { + this.end(); + return true; + } +}; + +/** + * @see GenericWorker.error + */ +ZipFileWorker.prototype.error = function (e) { + var sources = this._sources; + if(!GenericWorker.prototype.error.call(this, e)) { + return false; + } + for(var i = 0; i < sources.length; i++) { + try { + sources[i].error(e); + } catch(e) { + // the `error` exploded, nothing to do + } + } + return true; +}; + +/** + * @see GenericWorker.lock + */ +ZipFileWorker.prototype.lock = function () { + GenericWorker.prototype.lock.call(this); + var sources = this._sources; + for(var i = 0; i < sources.length; i++) { + sources[i].lock(); + } +}; + +module.exports = ZipFileWorker; + +},{"../crc32":4,"../signature":23,"../stream/GenericWorker":28,"../utf8":31,"../utils":32}],9:[function(require,module,exports){ +'use strict'; + +var compressions = require('../compressions'); +var ZipFileWorker = require('./ZipFileWorker'); + +/** + * Find the compression to use. + * @param {String} fileCompression the compression defined at the file level, if any. + * @param {String} zipCompression the compression defined at the load() level. + * @return {Object} the compression object to use. + */ +var getCompression = function (fileCompression, zipCompression) { + + var compressionName = fileCompression || zipCompression; + var compression = compressions[compressionName]; + if (!compression) { + throw new Error(compressionName + " is not a valid compression method !"); + } + return compression; +}; + +/** + * Create a worker to generate a zip file. + * @param {JSZip} zip the JSZip instance at the right root level. + * @param {Object} options to generate the zip file. + * @param {String} comment the comment to use. + */ +exports.generateWorker = function (zip, options, comment) { + + var zipFileWorker = new ZipFileWorker(options.streamFiles, comment, options.platform, options.encodeFileName); + var entriesCount = 0; + try { + + zip.forEach(function (relativePath, file) { + entriesCount++; + var compression = getCompression(file.options.compression, options.compression); + var compressionOptions = file.options.compressionOptions || options.compressionOptions || {}; + var dir = file.dir, date = file.date; + + file._compressWorker(compression, compressionOptions) + .withStreamInfo("file", { + name : relativePath, + dir : dir, + date : date, + comment : file.comment || "", + unixPermissions : file.unixPermissions, + dosPermissions : file.dosPermissions + }) + .pipe(zipFileWorker); + }); + zipFileWorker.entriesCount = entriesCount; + } catch (e) { + zipFileWorker.error(e); + } + + return zipFileWorker; +}; + +},{"../compressions":3,"./ZipFileWorker":8}],10:[function(require,module,exports){ +'use strict'; + +/** + * Representation a of zip file in js + * @constructor + */ +function JSZip() { + // if this constructor is used without `new`, it adds `new` before itself: + if(!(this instanceof JSZip)) { + return new JSZip(); + } + + if(arguments.length) { + throw new Error("The constructor with parameters has been removed in JSZip 3.0, please check the upgrade guide."); + } + + // object containing the files : + // { + // "folder/" : {...}, + // "folder/data.txt" : {...} + // } + // NOTE: we use a null prototype because we do not + // want filenames like "toString" coming from a zip file + // to overwrite methods and attributes in a normal Object. + this.files = Object.create(null); + + this.comment = null; + + // Where we are in the hierarchy + this.root = ""; + this.clone = function() { + var newObj = new JSZip(); + for (var i in this) { + if (typeof this[i] !== "function") { + newObj[i] = this[i]; + } + } + return newObj; + }; +} +JSZip.prototype = require('./object'); +JSZip.prototype.loadAsync = require('./load'); +JSZip.support = require('./support'); +JSZip.defaults = require('./defaults'); + +// TODO find a better way to handle this version, +// a require('package.json').version doesn't work with webpack, see #327 +JSZip.version = "3.7.1"; + +JSZip.loadAsync = function (content, options) { + return new JSZip().loadAsync(content, options); +}; + +JSZip.external = require("./external"); +module.exports = JSZip; + +},{"./defaults":5,"./external":6,"./load":11,"./object":15,"./support":30}],11:[function(require,module,exports){ +'use strict'; +var utils = require('./utils'); +var external = require("./external"); +var utf8 = require('./utf8'); +var ZipEntries = require('./zipEntries'); +var Crc32Probe = require('./stream/Crc32Probe'); +var nodejsUtils = require("./nodejsUtils"); + +/** + * Check the CRC32 of an entry. + * @param {ZipEntry} zipEntry the zip entry to check. + * @return {Promise} the result. + */ +function checkEntryCRC32(zipEntry) { + return new external.Promise(function (resolve, reject) { + var worker = zipEntry.decompressed.getContentWorker().pipe(new Crc32Probe()); + worker.on("error", function (e) { + reject(e); + }) + .on("end", function () { + if (worker.streamInfo.crc32 !== zipEntry.decompressed.crc32) { + reject(new Error("Corrupted zip : CRC32 mismatch")); + } else { + resolve(); + } + }) + .resume(); + }); +} + +module.exports = function (data, options) { + var zip = this; + options = utils.extend(options || {}, { + base64: false, + checkCRC32: false, + optimizedBinaryString: false, + createFolders: false, + decodeFileName: utf8.utf8decode + }); + + if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + return external.Promise.reject(new Error("JSZip can't accept a stream when loading a zip file.")); + } + + return utils.prepareContent("the loaded zip file", data, true, options.optimizedBinaryString, options.base64) + .then(function (data) { + var zipEntries = new ZipEntries(options); + zipEntries.load(data); + return zipEntries; + }).then(function checkCRC32(zipEntries) { + var promises = [external.Promise.resolve(zipEntries)]; + var files = zipEntries.files; + if (options.checkCRC32) { + for (var i = 0; i < files.length; i++) { + promises.push(checkEntryCRC32(files[i])); + } + } + return external.Promise.all(promises); + }).then(function addFiles(results) { + var zipEntries = results.shift(); + var files = zipEntries.files; + for (var i = 0; i < files.length; i++) { + var input = files[i]; + zip.file(input.fileNameStr, input.decompressed, { + binary: true, + optimizedBinaryString: true, + date: input.date, + dir: input.dir, + comment: input.fileCommentStr.length ? input.fileCommentStr : null, + unixPermissions: input.unixPermissions, + dosPermissions: input.dosPermissions, + createFolders: options.createFolders + }); + } + if (zipEntries.zipComment.length) { + zip.comment = zipEntries.zipComment; + } + + return zip; + }); +}; + +},{"./external":6,"./nodejsUtils":14,"./stream/Crc32Probe":25,"./utf8":31,"./utils":32,"./zipEntries":33}],12:[function(require,module,exports){ +"use strict"; + +var utils = require('../utils'); +var GenericWorker = require('../stream/GenericWorker'); + +/** + * A worker that use a nodejs stream as source. + * @constructor + * @param {String} filename the name of the file entry for this stream. + * @param {Readable} stream the nodejs stream. + */ +function NodejsStreamInputAdapter(filename, stream) { + GenericWorker.call(this, "Nodejs stream input adapter for " + filename); + this._upstreamEnded = false; + this._bindStream(stream); +} + +utils.inherits(NodejsStreamInputAdapter, GenericWorker); + +/** + * Prepare the stream and bind the callbacks on it. + * Do this ASAP on node 0.10 ! A lazy binding doesn't always work. + * @param {Stream} stream the nodejs stream to use. + */ +NodejsStreamInputAdapter.prototype._bindStream = function (stream) { + var self = this; + this._stream = stream; + stream.pause(); + stream + .on("data", function (chunk) { + self.push({ + data: chunk, + meta : { + percent : 0 + } + }); + }) + .on("error", function (e) { + if(self.isPaused) { + this.generatedError = e; + } else { + self.error(e); + } + }) + .on("end", function () { + if(self.isPaused) { + self._upstreamEnded = true; + } else { + self.end(); + } + }); +}; +NodejsStreamInputAdapter.prototype.pause = function () { + if(!GenericWorker.prototype.pause.call(this)) { + return false; + } + this._stream.pause(); + return true; +}; +NodejsStreamInputAdapter.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if(this._upstreamEnded) { + this.end(); + } else { + this._stream.resume(); + } + + return true; +}; + +module.exports = NodejsStreamInputAdapter; + +},{"../stream/GenericWorker":28,"../utils":32}],13:[function(require,module,exports){ +'use strict'; + +var Readable = require('readable-stream').Readable; + +var utils = require('../utils'); +utils.inherits(NodejsStreamOutputAdapter, Readable); + +/** +* A nodejs stream using a worker as source. +* @see the SourceWrapper in http://nodejs.org/api/stream.html +* @constructor +* @param {StreamHelper} helper the helper wrapping the worker +* @param {Object} options the nodejs stream options +* @param {Function} updateCb the update callback. +*/ +function NodejsStreamOutputAdapter(helper, options, updateCb) { + Readable.call(this, options); + this._helper = helper; + + var self = this; + helper.on("data", function (data, meta) { + if (!self.push(data)) { + self._helper.pause(); + } + if(updateCb) { + updateCb(meta); + } + }) + .on("error", function(e) { + self.emit('error', e); + }) + .on("end", function () { + self.push(null); + }); +} + + +NodejsStreamOutputAdapter.prototype._read = function() { + this._helper.resume(); +}; + +module.exports = NodejsStreamOutputAdapter; + +},{"../utils":32,"readable-stream":16}],14:[function(require,module,exports){ +'use strict'; + +module.exports = { + /** + * True if this is running in Nodejs, will be undefined in a browser. + * In a browser, browserify won't include this file and the whole module + * will be resolved an empty object. + */ + isNode : typeof Buffer !== "undefined", + /** + * Create a new nodejs Buffer from an existing content. + * @param {Object} data the data to pass to the constructor. + * @param {String} encoding the encoding to use. + * @return {Buffer} a new Buffer. + */ + newBufferFrom: function(data, encoding) { + if (Buffer.from && Buffer.from !== Uint8Array.from) { + return Buffer.from(data, encoding); + } else { + if (typeof data === "number") { + // Safeguard for old Node.js versions. On newer versions, + // Buffer.from(number) / Buffer(number, encoding) already throw. + throw new Error("The \"data\" argument must not be a number"); + } + return new Buffer(data, encoding); + } + }, + /** + * Create a new nodejs Buffer with the specified size. + * @param {Integer} size the size of the buffer. + * @return {Buffer} a new Buffer. + */ + allocBuffer: function (size) { + if (Buffer.alloc) { + return Buffer.alloc(size); + } else { + var buf = new Buffer(size); + buf.fill(0); + return buf; + } + }, + /** + * Find out if an object is a Buffer. + * @param {Object} b the object to test. + * @return {Boolean} true if the object is a Buffer, false otherwise. + */ + isBuffer : function(b){ + return Buffer.isBuffer(b); + }, + + isStream : function (obj) { + return obj && + typeof obj.on === "function" && + typeof obj.pause === "function" && + typeof obj.resume === "function"; + } +}; + +},{}],15:[function(require,module,exports){ +'use strict'; +var utf8 = require('./utf8'); +var utils = require('./utils'); +var GenericWorker = require('./stream/GenericWorker'); +var StreamHelper = require('./stream/StreamHelper'); +var defaults = require('./defaults'); +var CompressedObject = require('./compressedObject'); +var ZipObject = require('./zipObject'); +var generate = require("./generate"); +var nodejsUtils = require("./nodejsUtils"); +var NodejsStreamInputAdapter = require("./nodejs/NodejsStreamInputAdapter"); + + +/** + * Add a file in the current folder. + * @private + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data of the file + * @param {Object} originalOptions the options of the file + * @return {Object} the new file. + */ +var fileAdd = function(name, data, originalOptions) { + // be sure sub folders exist + var dataType = utils.getTypeOf(data), + parent; + + + /* + * Correct options. + */ + + var o = utils.extend(originalOptions || {}, defaults); + o.date = o.date || new Date(); + if (o.compression !== null) { + o.compression = o.compression.toUpperCase(); + } + + if (typeof o.unixPermissions === "string") { + o.unixPermissions = parseInt(o.unixPermissions, 8); + } + + // UNX_IFDIR 0040000 see zipinfo.c + if (o.unixPermissions && (o.unixPermissions & 0x4000)) { + o.dir = true; + } + // Bit 4 Directory + if (o.dosPermissions && (o.dosPermissions & 0x0010)) { + o.dir = true; + } + + if (o.dir) { + name = forceTrailingSlash(name); + } + if (o.createFolders && (parent = parentFolder(name))) { + folderAdd.call(this, parent, true); + } + + var isUnicodeString = dataType === "string" && o.binary === false && o.base64 === false; + if (!originalOptions || typeof originalOptions.binary === "undefined") { + o.binary = !isUnicodeString; + } + + + var isCompressedEmpty = (data instanceof CompressedObject) && data.uncompressedSize === 0; + + if (isCompressedEmpty || o.dir || !data || data.length === 0) { + o.base64 = false; + o.binary = true; + data = ""; + o.compression = "STORE"; + dataType = "string"; + } + + /* + * Convert content to fit. + */ + + var zipObjectContent = null; + if (data instanceof CompressedObject || data instanceof GenericWorker) { + zipObjectContent = data; + } else if (nodejsUtils.isNode && nodejsUtils.isStream(data)) { + zipObjectContent = new NodejsStreamInputAdapter(name, data); + } else { + zipObjectContent = utils.prepareContent(name, data, o.binary, o.optimizedBinaryString, o.base64); + } + + var object = new ZipObject(name, zipObjectContent, o); + this.files[name] = object; + /* + TODO: we can't throw an exception because we have async promises + (we can have a promise of a Date() for example) but returning a + promise is useless because file(name, data) returns the JSZip + object for chaining. Should we break that to allow the user + to catch the error ? + + return external.Promise.resolve(zipObjectContent) + .then(function () { + return object; + }); + */ +}; + +/** + * Find the parent folder of the path. + * @private + * @param {string} path the path to use + * @return {string} the parent folder, or "" + */ +var parentFolder = function (path) { + if (path.slice(-1) === '/') { + path = path.substring(0, path.length - 1); + } + var lastSlash = path.lastIndexOf('/'); + return (lastSlash > 0) ? path.substring(0, lastSlash) : ""; +}; + +/** + * Returns the path with a slash at the end. + * @private + * @param {String} path the path to check. + * @return {String} the path with a trailing slash. + */ +var forceTrailingSlash = function(path) { + // Check the name ends with a / + if (path.slice(-1) !== "/") { + path += "/"; // IE doesn't like substr(-1) + } + return path; +}; + +/** + * Add a (sub) folder in the current folder. + * @private + * @param {string} name the folder's name + * @param {boolean=} [createFolders] If true, automatically create sub + * folders. Defaults to false. + * @return {Object} the new folder. + */ +var folderAdd = function(name, createFolders) { + createFolders = (typeof createFolders !== 'undefined') ? createFolders : defaults.createFolders; + + name = forceTrailingSlash(name); + + // Does this folder already exist? + if (!this.files[name]) { + fileAdd.call(this, name, null, { + dir: true, + createFolders: createFolders + }); + } + return this.files[name]; +}; + +/** +* Cross-window, cross-Node-context regular expression detection +* @param {Object} object Anything +* @return {Boolean} true if the object is a regular expression, +* false otherwise +*/ +function isRegExp(object) { + return Object.prototype.toString.call(object) === "[object RegExp]"; +} + +// return the actual prototype of JSZip +var out = { + /** + * @see loadAsync + */ + load: function() { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + + /** + * Call a callback function for each entry at this folder level. + * @param {Function} cb the callback function: + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + */ + forEach: function(cb) { + var filename, relativePath, file; + /* jshint ignore:start */ + // ignore warning about unwanted properties because this.files is a null prototype object + for (filename in this.files) { + file = this.files[filename]; + relativePath = filename.slice(this.root.length, filename.length); + if (relativePath && filename.slice(0, this.root.length) === this.root) { // the file is in the current root + cb(relativePath, file); // TODO reverse the parameters ? need to be clean AND consistent with the filter search fn... + } + } + /* jshint ignore:end */ + }, + + /** + * Filter nested files/folders with the specified function. + * @param {Function} search the predicate to use : + * function (relativePath, file) {...} + * It takes 2 arguments : the relative path and the file. + * @return {Array} An array of matching elements. + */ + filter: function(search) { + var result = []; + this.forEach(function (relativePath, entry) { + if (search(relativePath, entry)) { // the file matches the function + result.push(entry); + } + + }); + return result; + }, + + /** + * Add a file to the zip file, or search a file. + * @param {string|RegExp} name The name of the file to add (if data is defined), + * the name of the file to find (if no data) or a regex to match files. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data The file data, either raw or base64 encoded + * @param {Object} o File options + * @return {JSZip|Object|Array} this JSZip object (when adding a file), + * a file (when searching by string) or an array of files (when searching by regex). + */ + file: function(name, data, o) { + if (arguments.length === 1) { + if (isRegExp(name)) { + var regexp = name; + return this.filter(function(relativePath, file) { + return !file.dir && regexp.test(relativePath); + }); + } + else { // text + var obj = this.files[this.root + name]; + if (obj && !obj.dir) { + return obj; + } else { + return null; + } + } + } + else { // more than one argument : we have data ! + name = this.root + name; + fileAdd.call(this, name, data, o); + } + return this; + }, + + /** + * Add a directory to the zip file, or search. + * @param {String|RegExp} arg The name of the directory to add, or a regex to search folders. + * @return {JSZip} an object with the new directory as the root, or an array containing matching folders. + */ + folder: function(arg) { + if (!arg) { + return this; + } + + if (isRegExp(arg)) { + return this.filter(function(relativePath, file) { + return file.dir && arg.test(relativePath); + }); + } + + // else, name is a new folder + var name = this.root + arg; + var newFolder = folderAdd.call(this, name); + + // Allow chaining by returning a new object with this folder as the root + var ret = this.clone(); + ret.root = newFolder.name; + return ret; + }, + + /** + * Delete a file, or a directory and all sub-files, from the zip + * @param {string} name the name of the file to delete + * @return {JSZip} this JSZip object + */ + remove: function(name) { + name = this.root + name; + var file = this.files[name]; + if (!file) { + // Look for any folders + if (name.slice(-1) !== "/") { + name += "/"; + } + file = this.files[name]; + } + + if (file && !file.dir) { + // file + delete this.files[name]; + } else { + // maybe a folder, delete recursively + var kids = this.filter(function(relativePath, file) { + return file.name.slice(0, name.length) === name; + }); + for (var i = 0; i < kids.length; i++) { + delete this.files[kids[i].name]; + } + } + + return this; + }, + + /** + * Generate the complete zip file + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the zip file + */ + generate: function(options) { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); + }, + + /** + * Generate the complete zip file as an internal stream. + * @param {Object} options the options to generate the zip file : + * - compression, "STORE" by default. + * - type, "base64" by default. Values are : string, base64, uint8array, arraybuffer, blob. + * @return {StreamHelper} the streamed zip file. + */ + generateInternalStream: function(options) { + var worker, opts = {}; + try { + opts = utils.extend(options || {}, { + streamFiles: false, + compression: "STORE", + compressionOptions : null, + type: "", + platform: "DOS", + comment: null, + mimeType: 'application/zip', + encodeFileName: utf8.utf8encode + }); + + opts.type = opts.type.toLowerCase(); + opts.compression = opts.compression.toUpperCase(); + + // "binarystring" is preferred but the internals use "string". + if(opts.type === "binarystring") { + opts.type = "string"; + } + + if (!opts.type) { + throw new Error("No output type specified."); + } + + utils.checkSupport(opts.type); + + // accept nodejs `process.platform` + if( + opts.platform === 'darwin' || + opts.platform === 'freebsd' || + opts.platform === 'linux' || + opts.platform === 'sunos' + ) { + opts.platform = "UNIX"; + } + if (opts.platform === 'win32') { + opts.platform = "DOS"; + } + + var comment = opts.comment || this.comment || ""; + worker = generate.generateWorker(this, opts, comment); + } catch (e) { + worker = new GenericWorker("error"); + worker.error(e); + } + return new StreamHelper(worker, opts.type || "string", opts.mimeType); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateAsync: function(options, onUpdate) { + return this.generateInternalStream(options).accumulate(onUpdate); + }, + /** + * Generate the complete zip file asynchronously. + * @see generateInternalStream + */ + generateNodeStream: function(options, onUpdate) { + options = options || {}; + if (!options.type) { + options.type = "nodebuffer"; + } + return this.generateInternalStream(options).toNodejsStream(onUpdate); + } +}; +module.exports = out; + +},{"./compressedObject":2,"./defaults":5,"./generate":9,"./nodejs/NodejsStreamInputAdapter":12,"./nodejsUtils":14,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31,"./utils":32,"./zipObject":35}],16:[function(require,module,exports){ +/* + * This file is used by module bundlers (browserify/webpack/etc) when + * including a stream implementation. We use "readable-stream" to get a + * consistent behavior between nodejs versions but bundlers often have a shim + * for "stream". Using this shim greatly improve the compatibility and greatly + * reduce the final size of the bundle (only one stream implementation, not + * two). + */ +module.exports = require("stream"); + +},{"stream":undefined}],17:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function ArrayReader(data) { + DataReader.call(this, data); + for(var i = 0; i < this.data.length; i++) { + data[i] = data[i] & 0xFF; + } +} +utils.inherits(ArrayReader, DataReader); +/** + * @see DataReader.byteAt + */ +ArrayReader.prototype.byteAt = function(i) { + return this.data[this.zero + i]; +}; +/** + * @see DataReader.lastIndexOfSignature + */ +ArrayReader.prototype.lastIndexOfSignature = function(sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3); + for (var i = this.length - 4; i >= 0; --i) { + if (this.data[i] === sig0 && this.data[i + 1] === sig1 && this.data[i + 2] === sig2 && this.data[i + 3] === sig3) { + return i - this.zero; + } + } + + return -1; +}; +/** + * @see DataReader.readAndCheckSignature + */ +ArrayReader.prototype.readAndCheckSignature = function (sig) { + var sig0 = sig.charCodeAt(0), + sig1 = sig.charCodeAt(1), + sig2 = sig.charCodeAt(2), + sig3 = sig.charCodeAt(3), + data = this.readData(4); + return sig0 === data[0] && sig1 === data[1] && sig2 === data[2] && sig3 === data[3]; +}; +/** + * @see DataReader.readData + */ +ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + return []; + } + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = ArrayReader; + +},{"../utils":32,"./DataReader":18}],18:[function(require,module,exports){ +'use strict'; +var utils = require('../utils'); + +function DataReader(data) { + this.data = data; // type : see implementation + this.length = data.length; + this.index = 0; + this.zero = 0; +} +DataReader.prototype = { + /** + * Check that the offset will not go too far. + * @param {string} offset the additional offset to check. + * @throws {Error} an Error if the offset is out of bounds. + */ + checkOffset: function(offset) { + this.checkIndex(this.index + offset); + }, + /** + * Check that the specified index will not be too far. + * @param {string} newIndex the index to check. + * @throws {Error} an Error if the index is out of bounds. + */ + checkIndex: function(newIndex) { + if (this.length < this.zero + newIndex || newIndex < 0) { + throw new Error("End of data reached (data length = " + this.length + ", asked index = " + (newIndex) + "). Corrupted zip ?"); + } + }, + /** + * Change the index. + * @param {number} newIndex The new index. + * @throws {Error} if the new index is out of the data. + */ + setIndex: function(newIndex) { + this.checkIndex(newIndex); + this.index = newIndex; + }, + /** + * Skip the next n bytes. + * @param {number} n the number of bytes to skip. + * @throws {Error} if the new index is out of the data. + */ + skip: function(n) { + this.setIndex(this.index + n); + }, + /** + * Get the byte at the specified index. + * @param {number} i the index to use. + * @return {number} a byte. + */ + byteAt: function(i) { + // see implementations + }, + /** + * Get the next number with a given byte size. + * @param {number} size the number of bytes to read. + * @return {number} the corresponding number. + */ + readInt: function(size) { + var result = 0, + i; + this.checkOffset(size); + for (i = this.index + size - 1; i >= this.index; i--) { + result = (result << 8) + this.byteAt(i); + } + this.index += size; + return result; + }, + /** + * Get the next string with a given byte size. + * @param {number} size the number of bytes to read. + * @return {string} the corresponding string. + */ + readString: function(size) { + return utils.transformTo("string", this.readData(size)); + }, + /** + * Get raw data without conversion, bytes. + * @param {number} size the number of bytes to read. + * @return {Object} the raw data, implementation specific. + */ + readData: function(size) { + // see implementations + }, + /** + * Find the last occurrence of a zip signature (4 bytes). + * @param {string} sig the signature to find. + * @return {number} the index of the last occurrence, -1 if not found. + */ + lastIndexOfSignature: function(sig) { + // see implementations + }, + /** + * Read the signature (4 bytes) at the current position and compare it with sig. + * @param {string} sig the expected signature + * @return {boolean} true if the signature matches, false otherwise. + */ + readAndCheckSignature: function(sig) { + // see implementations + }, + /** + * Get the next date. + * @return {Date} the date. + */ + readDate: function() { + var dostime = this.readInt(4); + return new Date(Date.UTC( + ((dostime >> 25) & 0x7f) + 1980, // year + ((dostime >> 21) & 0x0f) - 1, // month + (dostime >> 16) & 0x1f, // day + (dostime >> 11) & 0x1f, // hour + (dostime >> 5) & 0x3f, // minute + (dostime & 0x1f) << 1)); // second + } +}; +module.exports = DataReader; + +},{"../utils":32}],19:[function(require,module,exports){ +'use strict'; +var Uint8ArrayReader = require('./Uint8ArrayReader'); +var utils = require('../utils'); + +function NodeBufferReader(data) { + Uint8ArrayReader.call(this, data); +} +utils.inherits(NodeBufferReader, Uint8ArrayReader); + +/** + * @see DataReader.readData + */ +NodeBufferReader.prototype.readData = function(size) { + this.checkOffset(size); + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = NodeBufferReader; + +},{"../utils":32,"./Uint8ArrayReader":21}],20:[function(require,module,exports){ +'use strict'; +var DataReader = require('./DataReader'); +var utils = require('../utils'); + +function StringReader(data) { + DataReader.call(this, data); +} +utils.inherits(StringReader, DataReader); +/** + * @see DataReader.byteAt + */ +StringReader.prototype.byteAt = function(i) { + return this.data.charCodeAt(this.zero + i); +}; +/** + * @see DataReader.lastIndexOfSignature + */ +StringReader.prototype.lastIndexOfSignature = function(sig) { + return this.data.lastIndexOf(sig) - this.zero; +}; +/** + * @see DataReader.readAndCheckSignature + */ +StringReader.prototype.readAndCheckSignature = function (sig) { + var data = this.readData(4); + return sig === data; +}; +/** + * @see DataReader.readData + */ +StringReader.prototype.readData = function(size) { + this.checkOffset(size); + // this will work because the constructor applied the "& 0xff" mask. + var result = this.data.slice(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = StringReader; + +},{"../utils":32,"./DataReader":18}],21:[function(require,module,exports){ +'use strict'; +var ArrayReader = require('./ArrayReader'); +var utils = require('../utils'); + +function Uint8ArrayReader(data) { + ArrayReader.call(this, data); +} +utils.inherits(Uint8ArrayReader, ArrayReader); +/** + * @see DataReader.readData + */ +Uint8ArrayReader.prototype.readData = function(size) { + this.checkOffset(size); + if(size === 0) { + // in IE10, when using subarray(idx, idx), we get the array [0x00] instead of []. + return new Uint8Array(0); + } + var result = this.data.subarray(this.zero + this.index, this.zero + this.index + size); + this.index += size; + return result; +}; +module.exports = Uint8ArrayReader; + +},{"../utils":32,"./ArrayReader":17}],22:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var support = require('../support'); +var ArrayReader = require('./ArrayReader'); +var StringReader = require('./StringReader'); +var NodeBufferReader = require('./NodeBufferReader'); +var Uint8ArrayReader = require('./Uint8ArrayReader'); + +/** + * Create a reader adapted to the data. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data to read. + * @return {DataReader} the data reader. + */ +module.exports = function (data) { + var type = utils.getTypeOf(data); + utils.checkSupport(type); + if (type === "string" && !support.uint8array) { + return new StringReader(data); + } + if (type === "nodebuffer") { + return new NodeBufferReader(data); + } + if (support.uint8array) { + return new Uint8ArrayReader(utils.transformTo("uint8array", data)); + } + return new ArrayReader(utils.transformTo("array", data)); +}; + +},{"../support":30,"../utils":32,"./ArrayReader":17,"./NodeBufferReader":19,"./StringReader":20,"./Uint8ArrayReader":21}],23:[function(require,module,exports){ +'use strict'; +exports.LOCAL_FILE_HEADER = "PK\x03\x04"; +exports.CENTRAL_FILE_HEADER = "PK\x01\x02"; +exports.CENTRAL_DIRECTORY_END = "PK\x05\x06"; +exports.ZIP64_CENTRAL_DIRECTORY_LOCATOR = "PK\x06\x07"; +exports.ZIP64_CENTRAL_DIRECTORY_END = "PK\x06\x06"; +exports.DATA_DESCRIPTOR = "PK\x07\x08"; + +},{}],24:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var utils = require('../utils'); + +/** + * A worker which convert chunks to a specified type. + * @constructor + * @param {String} destType the destination type. + */ +function ConvertWorker(destType) { + GenericWorker.call(this, "ConvertWorker to " + destType); + this.destType = destType; +} +utils.inherits(ConvertWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +ConvertWorker.prototype.processChunk = function (chunk) { + this.push({ + data : utils.transformTo(this.destType, chunk.data), + meta : chunk.meta + }); +}; +module.exports = ConvertWorker; + +},{"../utils":32,"./GenericWorker":28}],25:[function(require,module,exports){ +'use strict'; + +var GenericWorker = require('./GenericWorker'); +var crc32 = require('../crc32'); +var utils = require('../utils'); + +/** + * A worker which calculate the crc32 of the data flowing through. + * @constructor + */ +function Crc32Probe() { + GenericWorker.call(this, "Crc32Probe"); + this.withStreamInfo("crc32", 0); +} +utils.inherits(Crc32Probe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Crc32Probe.prototype.processChunk = function (chunk) { + this.streamInfo.crc32 = crc32(chunk.data, this.streamInfo.crc32 || 0); + this.push(chunk); +}; +module.exports = Crc32Probe; + +},{"../crc32":4,"../utils":32,"./GenericWorker":28}],26:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +/** + * A worker which calculate the total length of the data flowing through. + * @constructor + * @param {String} propName the name used to expose the length + */ +function DataLengthProbe(propName) { + GenericWorker.call(this, "DataLengthProbe for " + propName); + this.propName = propName; + this.withStreamInfo(propName, 0); +} +utils.inherits(DataLengthProbe, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +DataLengthProbe.prototype.processChunk = function (chunk) { + if(chunk) { + var length = this.streamInfo[this.propName] || 0; + this.streamInfo[this.propName] = length + chunk.data.length; + } + GenericWorker.prototype.processChunk.call(this, chunk); +}; +module.exports = DataLengthProbe; + + +},{"../utils":32,"./GenericWorker":28}],27:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var GenericWorker = require('./GenericWorker'); + +// the size of the generated chunks +// TODO expose this as a public variable +var DEFAULT_BLOCK_SIZE = 16 * 1024; + +/** + * A worker that reads a content and emits chunks. + * @constructor + * @param {Promise} dataP the promise of the data to split + */ +function DataWorker(dataP) { + GenericWorker.call(this, "DataWorker"); + var self = this; + this.dataIsReady = false; + this.index = 0; + this.max = 0; + this.data = null; + this.type = ""; + + this._tickScheduled = false; + + dataP.then(function (data) { + self.dataIsReady = true; + self.data = data; + self.max = data && data.length || 0; + self.type = utils.getTypeOf(data); + if(!self.isPaused) { + self._tickAndRepeat(); + } + }, function (e) { + self.error(e); + }); +} + +utils.inherits(DataWorker, GenericWorker); + +/** + * @see GenericWorker.cleanUp + */ +DataWorker.prototype.cleanUp = function () { + GenericWorker.prototype.cleanUp.call(this); + this.data = null; +}; + +/** + * @see GenericWorker.resume + */ +DataWorker.prototype.resume = function () { + if(!GenericWorker.prototype.resume.call(this)) { + return false; + } + + if (!this._tickScheduled && this.dataIsReady) { + this._tickScheduled = true; + utils.delay(this._tickAndRepeat, [], this); + } + return true; +}; + +/** + * Trigger a tick a schedule an other call to this function. + */ +DataWorker.prototype._tickAndRepeat = function() { + this._tickScheduled = false; + if(this.isPaused || this.isFinished) { + return; + } + this._tick(); + if(!this.isFinished) { + utils.delay(this._tickAndRepeat, [], this); + this._tickScheduled = true; + } +}; + +/** + * Read and push a chunk. + */ +DataWorker.prototype._tick = function() { + + if(this.isPaused || this.isFinished) { + return false; + } + + var size = DEFAULT_BLOCK_SIZE; + var data = null, nextIndex = Math.min(this.max, this.index + size); + if (this.index >= this.max) { + // EOF + return this.end(); + } else { + switch(this.type) { + case "string": + data = this.data.substring(this.index, nextIndex); + break; + case "uint8array": + data = this.data.subarray(this.index, nextIndex); + break; + case "array": + case "nodebuffer": + data = this.data.slice(this.index, nextIndex); + break; + } + this.index = nextIndex; + return this.push({ + data : data, + meta : { + percent : this.max ? this.index / this.max * 100 : 0 + } + }); + } +}; + +module.exports = DataWorker; + +},{"../utils":32,"./GenericWorker":28}],28:[function(require,module,exports){ +'use strict'; + +/** + * A worker that does nothing but passing chunks to the next one. This is like + * a nodejs stream but with some differences. On the good side : + * - it works on IE 6-9 without any issue / polyfill + * - it weights less than the full dependencies bundled with browserify + * - it forwards errors (no need to declare an error handler EVERYWHERE) + * + * A chunk is an object with 2 attributes : `meta` and `data`. The former is an + * object containing anything (`percent` for example), see each worker for more + * details. The latter is the real data (String, Uint8Array, etc). + * + * @constructor + * @param {String} name the name of the stream (mainly used for debugging purposes) + */ +function GenericWorker(name) { + // the name of the worker + this.name = name || "default"; + // an object containing metadata about the workers chain + this.streamInfo = {}; + // an error which happened when the worker was paused + this.generatedError = null; + // an object containing metadata to be merged by this worker into the general metadata + this.extraStreamInfo = {}; + // true if the stream is paused (and should not do anything), false otherwise + this.isPaused = true; + // true if the stream is finished (and should not do anything), false otherwise + this.isFinished = false; + // true if the stream is locked to prevent further structure updates (pipe), false otherwise + this.isLocked = false; + // the event listeners + this._listeners = { + 'data':[], + 'end':[], + 'error':[] + }; + // the previous worker, if any + this.previous = null; +} + +GenericWorker.prototype = { + /** + * Push a chunk to the next workers. + * @param {Object} chunk the chunk to push + */ + push : function (chunk) { + this.emit("data", chunk); + }, + /** + * End the stream. + * @return {Boolean} true if this call ended the worker, false otherwise. + */ + end : function () { + if (this.isFinished) { + return false; + } + + this.flush(); + try { + this.emit("end"); + this.cleanUp(); + this.isFinished = true; + } catch (e) { + this.emit("error", e); + } + return true; + }, + /** + * End the stream with an error. + * @param {Error} e the error which caused the premature end. + * @return {Boolean} true if this call ended the worker with an error, false otherwise. + */ + error : function (e) { + if (this.isFinished) { + return false; + } + + if(this.isPaused) { + this.generatedError = e; + } else { + this.isFinished = true; + + this.emit("error", e); + + // in the workers chain exploded in the middle of the chain, + // the error event will go downward but we also need to notify + // workers upward that there has been an error. + if(this.previous) { + this.previous.error(e); + } + + this.cleanUp(); + } + return true; + }, + /** + * Add a callback on an event. + * @param {String} name the name of the event (data, end, error) + * @param {Function} listener the function to call when the event is triggered + * @return {GenericWorker} the current object for chainability + */ + on : function (name, listener) { + this._listeners[name].push(listener); + return this; + }, + /** + * Clean any references when a worker is ending. + */ + cleanUp : function () { + this.streamInfo = this.generatedError = this.extraStreamInfo = null; + this._listeners = []; + }, + /** + * Trigger an event. This will call registered callback with the provided arg. + * @param {String} name the name of the event (data, end, error) + * @param {Object} arg the argument to call the callback with. + */ + emit : function (name, arg) { + if (this._listeners[name]) { + for(var i = 0; i < this._listeners[name].length; i++) { + this._listeners[name][i].call(this, arg); + } + } + }, + /** + * Chain a worker with an other. + * @param {Worker} next the worker receiving events from the current one. + * @return {worker} the next worker for chainability + */ + pipe : function (next) { + return next.registerPrevious(this); + }, + /** + * Same as `pipe` in the other direction. + * Using an API with `pipe(next)` is very easy. + * Implementing the API with the point of view of the next one registering + * a source is easier, see the ZipFileWorker. + * @param {Worker} previous the previous worker, sending events to this one + * @return {Worker} the current worker for chainability + */ + registerPrevious : function (previous) { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + + // sharing the streamInfo... + this.streamInfo = previous.streamInfo; + // ... and adding our own bits + this.mergeStreamInfo(); + this.previous = previous; + var self = this; + previous.on('data', function (chunk) { + self.processChunk(chunk); + }); + previous.on('end', function () { + self.end(); + }); + previous.on('error', function (e) { + self.error(e); + }); + return this; + }, + /** + * Pause the stream so it doesn't send events anymore. + * @return {Boolean} true if this call paused the worker, false otherwise. + */ + pause : function () { + if(this.isPaused || this.isFinished) { + return false; + } + this.isPaused = true; + + if(this.previous) { + this.previous.pause(); + } + return true; + }, + /** + * Resume a paused stream. + * @return {Boolean} true if this call resumed the worker, false otherwise. + */ + resume : function () { + if(!this.isPaused || this.isFinished) { + return false; + } + this.isPaused = false; + + // if true, the worker tried to resume but failed + var withError = false; + if(this.generatedError) { + this.error(this.generatedError); + withError = true; + } + if(this.previous) { + this.previous.resume(); + } + + return !withError; + }, + /** + * Flush any remaining bytes as the stream is ending. + */ + flush : function () {}, + /** + * Process a chunk. This is usually the method overridden. + * @param {Object} chunk the chunk to process. + */ + processChunk : function(chunk) { + this.push(chunk); + }, + /** + * Add a key/value to be added in the workers chain streamInfo once activated. + * @param {String} key the key to use + * @param {Object} value the associated value + * @return {Worker} the current worker for chainability + */ + withStreamInfo : function (key, value) { + this.extraStreamInfo[key] = value; + this.mergeStreamInfo(); + return this; + }, + /** + * Merge this worker's streamInfo into the chain's streamInfo. + */ + mergeStreamInfo : function () { + for(var key in this.extraStreamInfo) { + if (!this.extraStreamInfo.hasOwnProperty(key)) { + continue; + } + this.streamInfo[key] = this.extraStreamInfo[key]; + } + }, + + /** + * Lock the stream to prevent further updates on the workers chain. + * After calling this method, all calls to pipe will fail. + */ + lock: function () { + if (this.isLocked) { + throw new Error("The stream '" + this + "' has already been used."); + } + this.isLocked = true; + if (this.previous) { + this.previous.lock(); + } + }, + + /** + * + * Pretty print the workers chain. + */ + toString : function () { + var me = "Worker " + this.name; + if (this.previous) { + return this.previous + " -> " + me; + } else { + return me; + } + } +}; + +module.exports = GenericWorker; + +},{}],29:[function(require,module,exports){ +'use strict'; + +var utils = require('../utils'); +var ConvertWorker = require('./ConvertWorker'); +var GenericWorker = require('./GenericWorker'); +var base64 = require('../base64'); +var support = require("../support"); +var external = require("../external"); + +var NodejsStreamOutputAdapter = null; +if (support.nodestream) { + try { + NodejsStreamOutputAdapter = require('../nodejs/NodejsStreamOutputAdapter'); + } catch(e) {} +} + +/** + * Apply the final transformation of the data. If the user wants a Blob for + * example, it's easier to work with an U8intArray and finally do the + * ArrayBuffer/Blob conversion. + * @param {String} type the name of the final type + * @param {String|Uint8Array|Buffer} content the content to transform + * @param {String} mimeType the mime type of the content, if applicable. + * @return {String|Uint8Array|ArrayBuffer|Buffer|Blob} the content in the right format. + */ +function transformZipOutput(type, content, mimeType) { + switch(type) { + case "blob" : + return utils.newBlob(utils.transformTo("arraybuffer", content), mimeType); + case "base64" : + return base64.encode(content); + default : + return utils.transformTo(type, content); + } +} + +/** + * Concatenate an array of data of the given type. + * @param {String} type the type of the data in the given array. + * @param {Array} dataArray the array containing the data chunks to concatenate + * @return {String|Uint8Array|Buffer} the concatenated data + * @throws Error if the asked type is unsupported + */ +function concat (type, dataArray) { + var i, index = 0, res = null, totalLength = 0; + for(i = 0; i < dataArray.length; i++) { + totalLength += dataArray[i].length; + } + switch(type) { + case "string": + return dataArray.join(""); + case "array": + return Array.prototype.concat.apply([], dataArray); + case "uint8array": + res = new Uint8Array(totalLength); + for(i = 0; i < dataArray.length; i++) { + res.set(dataArray[i], index); + index += dataArray[i].length; + } + return res; + case "nodebuffer": + return Buffer.concat(dataArray); + default: + throw new Error("concat : unsupported type '" + type + "'"); + } +} + +/** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {StreamHelper} helper the helper to use. + * @param {Function} updateCallback a callback called on each update. Called + * with one arg : + * - the metadata linked to the update received. + * @return Promise the promise for the accumulation. + */ +function accumulate(helper, updateCallback) { + return new external.Promise(function (resolve, reject){ + var dataArray = []; + var chunkType = helper._internalType, + resultType = helper._outputType, + mimeType = helper._mimeType; + helper + .on('data', function (data, meta) { + dataArray.push(data); + if(updateCallback) { + updateCallback(meta); + } + }) + .on('error', function(err) { + dataArray = []; + reject(err); + }) + .on('end', function (){ + try { + var result = transformZipOutput(resultType, concat(chunkType, dataArray), mimeType); + resolve(result); + } catch (e) { + reject(e); + } + dataArray = []; + }) + .resume(); + }); +} + +/** + * An helper to easily use workers outside of JSZip. + * @constructor + * @param {Worker} worker the worker to wrap + * @param {String} outputType the type of data expected by the use + * @param {String} mimeType the mime type of the content, if applicable. + */ +function StreamHelper(worker, outputType, mimeType) { + var internalType = outputType; + switch(outputType) { + case "blob": + case "arraybuffer": + internalType = "uint8array"; + break; + case "base64": + internalType = "string"; + break; + } + + try { + // the type used internally + this._internalType = internalType; + // the type used to output results + this._outputType = outputType; + // the mime type + this._mimeType = mimeType; + utils.checkSupport(internalType); + this._worker = worker.pipe(new ConvertWorker(internalType)); + // the last workers can be rewired without issues but we need to + // prevent any updates on previous workers. + worker.lock(); + } catch(e) { + this._worker = new GenericWorker("error"); + this._worker.error(e); + } +} + +StreamHelper.prototype = { + /** + * Listen a StreamHelper, accumulate its content and concatenate it into a + * complete block. + * @param {Function} updateCb the update callback. + * @return Promise the promise for the accumulation. + */ + accumulate : function (updateCb) { + return accumulate(this, updateCb); + }, + /** + * Add a listener on an event triggered on a stream. + * @param {String} evt the name of the event + * @param {Function} fn the listener + * @return {StreamHelper} the current helper. + */ + on : function (evt, fn) { + var self = this; + + if(evt === "data") { + this._worker.on(evt, function (chunk) { + fn.call(self, chunk.data, chunk.meta); + }); + } else { + this._worker.on(evt, function () { + utils.delay(fn, arguments, self); + }); + } + return this; + }, + /** + * Resume the flow of chunks. + * @return {StreamHelper} the current helper. + */ + resume : function () { + utils.delay(this._worker.resume, [], this._worker); + return this; + }, + /** + * Pause the flow of chunks. + * @return {StreamHelper} the current helper. + */ + pause : function () { + this._worker.pause(); + return this; + }, + /** + * Return a nodejs stream for this helper. + * @param {Function} updateCb the update callback. + * @return {NodejsStreamOutputAdapter} the nodejs stream. + */ + toNodejsStream : function (updateCb) { + utils.checkSupport("nodestream"); + if (this._outputType !== "nodebuffer") { + // an object stream containing blob/arraybuffer/uint8array/string + // is strange and I don't know if it would be useful. + // I you find this comment and have a good usecase, please open a + // bug report ! + throw new Error(this._outputType + " is not supported by this method"); + } + + return new NodejsStreamOutputAdapter(this, { + objectMode : this._outputType !== "nodebuffer" + }, updateCb); + } +}; + + +module.exports = StreamHelper; + +},{"../base64":1,"../external":6,"../nodejs/NodejsStreamOutputAdapter":13,"../support":30,"../utils":32,"./ConvertWorker":24,"./GenericWorker":28}],30:[function(require,module,exports){ +'use strict'; + +exports.base64 = true; +exports.array = true; +exports.string = true; +exports.arraybuffer = typeof ArrayBuffer !== "undefined" && typeof Uint8Array !== "undefined"; +exports.nodebuffer = typeof Buffer !== "undefined"; +// contains true if JSZip can read/generate Uint8Array, false otherwise. +exports.uint8array = typeof Uint8Array !== "undefined"; + +if (typeof ArrayBuffer === "undefined") { + exports.blob = false; +} +else { + var buffer = new ArrayBuffer(0); + try { + exports.blob = new Blob([buffer], { + type: "application/zip" + }).size === 0; + } + catch (e) { + try { + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(buffer); + exports.blob = builder.getBlob('application/zip').size === 0; + } + catch (e) { + exports.blob = false; + } + } +} + +try { + exports.nodestream = !!require('readable-stream').Readable; +} catch(e) { + exports.nodestream = false; +} + +},{"readable-stream":16}],31:[function(require,module,exports){ +'use strict'; + +var utils = require('./utils'); +var support = require('./support'); +var nodejsUtils = require('./nodejsUtils'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * The following functions come from pako, from pako/lib/utils/strings + * released under the MIT license, see pako https://github.com/nodeca/pako/ + */ + +// Table with utf8 lengths (calculated by first byte of sequence) +// Note, that 5 & 6-byte values and some 4-byte values can not be represented in JS, +// because max possible codepoint is 0x10ffff +var _utf8len = new Array(256); +for (var i=0; i<256; i++) { + _utf8len[i] = (i >= 252 ? 6 : i >= 248 ? 5 : i >= 240 ? 4 : i >= 224 ? 3 : i >= 192 ? 2 : 1); +} +_utf8len[254]=_utf8len[254]=1; // Invalid sequence start + +// convert string to array (typed, when possible) +var string2buf = function (str) { + var buf, c, c2, m_pos, i, str_len = str.length, buf_len = 0; + + // count binary size + for (m_pos = 0; m_pos < str_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + buf_len += c < 0x80 ? 1 : c < 0x800 ? 2 : c < 0x10000 ? 3 : 4; + } + + // allocate buffer + if (support.uint8array) { + buf = new Uint8Array(buf_len); + } else { + buf = new Array(buf_len); + } + + // convert + for (i=0, m_pos = 0; i < buf_len; m_pos++) { + c = str.charCodeAt(m_pos); + if ((c & 0xfc00) === 0xd800 && (m_pos+1 < str_len)) { + c2 = str.charCodeAt(m_pos+1); + if ((c2 & 0xfc00) === 0xdc00) { + c = 0x10000 + ((c - 0xd800) << 10) + (c2 - 0xdc00); + m_pos++; + } + } + if (c < 0x80) { + /* one byte */ + buf[i++] = c; + } else if (c < 0x800) { + /* two bytes */ + buf[i++] = 0xC0 | (c >>> 6); + buf[i++] = 0x80 | (c & 0x3f); + } else if (c < 0x10000) { + /* three bytes */ + buf[i++] = 0xE0 | (c >>> 12); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } else { + /* four bytes */ + buf[i++] = 0xf0 | (c >>> 18); + buf[i++] = 0x80 | (c >>> 12 & 0x3f); + buf[i++] = 0x80 | (c >>> 6 & 0x3f); + buf[i++] = 0x80 | (c & 0x3f); + } + } + + return buf; +}; + +// Calculate max possible position in utf8 buffer, +// that will not break sequence. If that's not possible +// - (very small limits) return max size as is. +// +// buf[] - utf8 bytes array +// max - length limit (mandatory); +var utf8border = function(buf, max) { + var pos; + + max = max || buf.length; + if (max > buf.length) { max = buf.length; } + + // go back from last position, until start of sequence found + pos = max-1; + while (pos >= 0 && (buf[pos] & 0xC0) === 0x80) { pos--; } + + // Fuckup - very small and broken sequence, + // return max, because we should return something anyway. + if (pos < 0) { return max; } + + // If we came to start of buffer - that means vuffer is too small, + // return max too. + if (pos === 0) { return max; } + + return (pos + _utf8len[buf[pos]] > max) ? pos : max; +}; + +// convert array to string +var buf2string = function (buf) { + var str, i, out, c, c_len; + var len = buf.length; + + // Reserve max possible length (2 words per char) + // NB: by unknown reasons, Array is significantly faster for + // String.fromCharCode.apply than Uint16Array. + var utf16buf = new Array(len*2); + + for (out=0, i=0; i 4) { utf16buf[out++] = 0xfffd; i += c_len-1; continue; } + + // apply mask on first byte + c &= c_len === 2 ? 0x1f : c_len === 3 ? 0x0f : 0x07; + // join the rest + while (c_len > 1 && i < len) { + c = (c << 6) | (buf[i++] & 0x3f); + c_len--; + } + + // terminated by end of string? + if (c_len > 1) { utf16buf[out++] = 0xfffd; continue; } + + if (c < 0x10000) { + utf16buf[out++] = c; + } else { + c -= 0x10000; + utf16buf[out++] = 0xd800 | ((c >> 10) & 0x3ff); + utf16buf[out++] = 0xdc00 | (c & 0x3ff); + } + } + + // shrinkBuf(utf16buf, out) + if (utf16buf.length !== out) { + if(utf16buf.subarray) { + utf16buf = utf16buf.subarray(0, out); + } else { + utf16buf.length = out; + } + } + + // return String.fromCharCode.apply(null, utf16buf); + return utils.applyFromCharCode(utf16buf); +}; + + +// That's all for the pako functions. + + +/** + * Transform a javascript string into an array (typed if possible) of bytes, + * UTF-8 encoded. + * @param {String} str the string to encode + * @return {Array|Uint8Array|Buffer} the UTF-8 encoded string. + */ +exports.utf8encode = function utf8encode(str) { + if (support.nodebuffer) { + return nodejsUtils.newBufferFrom(str, "utf-8"); + } + + return string2buf(str); +}; + + +/** + * Transform a bytes array (or a representation) representing an UTF-8 encoded + * string into a javascript string. + * @param {Array|Uint8Array|Buffer} buf the data de decode + * @return {String} the decoded string. + */ +exports.utf8decode = function utf8decode(buf) { + if (support.nodebuffer) { + return utils.transformTo("nodebuffer", buf).toString("utf-8"); + } + + buf = utils.transformTo(support.uint8array ? "uint8array" : "array", buf); + + return buf2string(buf); +}; + +/** + * A worker to decode utf8 encoded binary chunks into string chunks. + * @constructor + */ +function Utf8DecodeWorker() { + GenericWorker.call(this, "utf-8 decode"); + // the last bytes if a chunk didn't end with a complete codepoint. + this.leftOver = null; +} +utils.inherits(Utf8DecodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8DecodeWorker.prototype.processChunk = function (chunk) { + + var data = utils.transformTo(support.uint8array ? "uint8array" : "array", chunk.data); + + // 1st step, re-use what's left of the previous chunk + if (this.leftOver && this.leftOver.length) { + if(support.uint8array) { + var previousData = data; + data = new Uint8Array(previousData.length + this.leftOver.length); + data.set(this.leftOver, 0); + data.set(previousData, this.leftOver.length); + } else { + data = this.leftOver.concat(data); + } + this.leftOver = null; + } + + var nextBoundary = utf8border(data); + var usableData = data; + if (nextBoundary !== data.length) { + if (support.uint8array) { + usableData = data.subarray(0, nextBoundary); + this.leftOver = data.subarray(nextBoundary, data.length); + } else { + usableData = data.slice(0, nextBoundary); + this.leftOver = data.slice(nextBoundary, data.length); + } + } + + this.push({ + data : exports.utf8decode(usableData), + meta : chunk.meta + }); +}; + +/** + * @see GenericWorker.flush + */ +Utf8DecodeWorker.prototype.flush = function () { + if(this.leftOver && this.leftOver.length) { + this.push({ + data : exports.utf8decode(this.leftOver), + meta : {} + }); + this.leftOver = null; + } +}; +exports.Utf8DecodeWorker = Utf8DecodeWorker; + +/** + * A worker to endcode string chunks into utf8 encoded binary chunks. + * @constructor + */ +function Utf8EncodeWorker() { + GenericWorker.call(this, "utf-8 encode"); +} +utils.inherits(Utf8EncodeWorker, GenericWorker); + +/** + * @see GenericWorker.processChunk + */ +Utf8EncodeWorker.prototype.processChunk = function (chunk) { + this.push({ + data : exports.utf8encode(chunk.data), + meta : chunk.meta + }); +}; +exports.Utf8EncodeWorker = Utf8EncodeWorker; + +},{"./nodejsUtils":14,"./stream/GenericWorker":28,"./support":30,"./utils":32}],32:[function(require,module,exports){ +'use strict'; + +var support = require('./support'); +var base64 = require('./base64'); +var nodejsUtils = require('./nodejsUtils'); +var setImmediate = require('set-immediate-shim'); +var external = require("./external"); + + +/** + * Convert a string that pass as a "binary string": it should represent a byte + * array but may have > 255 char codes. Be sure to take only the first byte + * and returns the byte array. + * @param {String} str the string to transform. + * @return {Array|Uint8Array} the string in a binary format. + */ +function string2binary(str) { + var result = null; + if (support.uint8array) { + result = new Uint8Array(str.length); + } else { + result = new Array(str.length); + } + return stringToArrayLike(str, result); +} + +/** + * Create a new blob with the given content and the given type. + * @param {String|ArrayBuffer} part the content to put in the blob. DO NOT use + * an Uint8Array because the stock browser of android 4 won't accept it (it + * will be silently converted to a string, "[object Uint8Array]"). + * + * Use only ONE part to build the blob to avoid a memory leak in IE11 / Edge: + * when a large amount of Array is used to create the Blob, the amount of + * memory consumed is nearly 100 times the original data amount. + * + * @param {String} type the mime type of the blob. + * @return {Blob} the created blob. + */ +exports.newBlob = function(part, type) { + exports.checkSupport("blob"); + + try { + // Blob constructor + return new Blob([part], { + type: type + }); + } + catch (e) { + + try { + // deprecated, browser only, old way + var Builder = self.BlobBuilder || self.WebKitBlobBuilder || self.MozBlobBuilder || self.MSBlobBuilder; + var builder = new Builder(); + builder.append(part); + return builder.getBlob(type); + } + catch (e) { + + // well, fuck ?! + throw new Error("Bug : can't construct the Blob."); + } + } + + +}; +/** + * The identity function. + * @param {Object} input the input. + * @return {Object} the same input. + */ +function identity(input) { + return input; +} + +/** + * Fill in an array with a string. + * @param {String} str the string to use. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to fill in (will be mutated). + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated array. + */ +function stringToArrayLike(str, array) { + for (var i = 0; i < str.length; ++i) { + array[i] = str.charCodeAt(i) & 0xFF; + } + return array; +} + +/** + * An helper for the function arrayLikeToString. + * This contains static information and functions that + * can be optimized by the browser JIT compiler. + */ +var arrayToStringHelper = { + /** + * Transform an array of int into a string, chunk by chunk. + * See the performances notes on arrayLikeToString. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @param {String} type the type of the array. + * @param {Integer} chunk the chunk size. + * @return {String} the resulting string. + * @throws Error if the chunk is too big for the stack. + */ + stringifyByChunk: function(array, type, chunk) { + var result = [], k = 0, len = array.length; + // shortcut + if (len <= chunk) { + return String.fromCharCode.apply(null, array); + } + while (k < len) { + if (type === "array" || type === "nodebuffer") { + result.push(String.fromCharCode.apply(null, array.slice(k, Math.min(k + chunk, len)))); + } + else { + result.push(String.fromCharCode.apply(null, array.subarray(k, Math.min(k + chunk, len)))); + } + k += chunk; + } + return result.join(""); + }, + /** + * Call String.fromCharCode on every item in the array. + * This is the naive implementation, which generate A LOT of intermediate string. + * This should be used when everything else fail. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ + stringifyByChar: function(array){ + var resultStr = ""; + for(var i = 0; i < array.length; i++) { + resultStr += String.fromCharCode(array[i]); + } + return resultStr; + }, + applyCanBeUsed : { + /** + * true if the browser accepts to use String.fromCharCode on Uint8Array + */ + uint8array : (function () { + try { + return support.uint8array && String.fromCharCode.apply(null, new Uint8Array(1)).length === 1; + } catch (e) { + return false; + } + })(), + /** + * true if the browser accepts to use String.fromCharCode on nodejs Buffer. + */ + nodebuffer : (function () { + try { + return support.nodebuffer && String.fromCharCode.apply(null, nodejsUtils.allocBuffer(1)).length === 1; + } catch (e) { + return false; + } + })() + } +}; + +/** + * Transform an array-like object to a string. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} array the array to transform. + * @return {String} the result. + */ +function arrayLikeToString(array) { + // Performances notes : + // -------------------- + // String.fromCharCode.apply(null, array) is the fastest, see + // see http://jsperf.com/converting-a-uint8array-to-a-string/2 + // but the stack is limited (and we can get huge arrays !). + // + // result += String.fromCharCode(array[i]); generate too many strings ! + // + // This code is inspired by http://jsperf.com/arraybuffer-to-string-apply-performance/2 + // TODO : we now have workers that split the work. Do we still need that ? + var chunk = 65536, + type = exports.getTypeOf(array), + canUseApply = true; + if (type === "uint8array") { + canUseApply = arrayToStringHelper.applyCanBeUsed.uint8array; + } else if (type === "nodebuffer") { + canUseApply = arrayToStringHelper.applyCanBeUsed.nodebuffer; + } + + if (canUseApply) { + while (chunk > 1) { + try { + return arrayToStringHelper.stringifyByChunk(array, type, chunk); + } catch (e) { + chunk = Math.floor(chunk / 2); + } + } + } + + // no apply or chunk error : slow and painful algorithm + // default browser on android 4.* + return arrayToStringHelper.stringifyByChar(array); +} + +exports.applyFromCharCode = arrayLikeToString; + + +/** + * Copy the data from an array-like to an other array-like. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayFrom the origin array. + * @param {Array|ArrayBuffer|Uint8Array|Buffer} arrayTo the destination array which will be mutated. + * @return {Array|ArrayBuffer|Uint8Array|Buffer} the updated destination array. + */ +function arrayLikeToArrayLike(arrayFrom, arrayTo) { + for (var i = 0; i < arrayFrom.length; i++) { + arrayTo[i] = arrayFrom[i]; + } + return arrayTo; +} + +// a matrix containing functions to transform everything into everything. +var transform = {}; + +// string to ? +transform["string"] = { + "string": identity, + "array": function(input) { + return stringToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["string"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return stringToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": function(input) { + return stringToArrayLike(input, nodejsUtils.allocBuffer(input.length)); + } +}; + +// array to ? +transform["array"] = { + "string": arrayLikeToString, + "array": identity, + "arraybuffer": function(input) { + return (new Uint8Array(input)).buffer; + }, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// arraybuffer to ? +transform["arraybuffer"] = { + "string": function(input) { + return arrayLikeToString(new Uint8Array(input)); + }, + "array": function(input) { + return arrayLikeToArrayLike(new Uint8Array(input), new Array(input.byteLength)); + }, + "arraybuffer": identity, + "uint8array": function(input) { + return new Uint8Array(input); + }, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(new Uint8Array(input)); + } +}; + +// uint8array to ? +transform["uint8array"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return input.buffer; + }, + "uint8array": identity, + "nodebuffer": function(input) { + return nodejsUtils.newBufferFrom(input); + } +}; + +// nodebuffer to ? +transform["nodebuffer"] = { + "string": arrayLikeToString, + "array": function(input) { + return arrayLikeToArrayLike(input, new Array(input.length)); + }, + "arraybuffer": function(input) { + return transform["nodebuffer"]["uint8array"](input).buffer; + }, + "uint8array": function(input) { + return arrayLikeToArrayLike(input, new Uint8Array(input.length)); + }, + "nodebuffer": identity +}; + +/** + * Transform an input into any type. + * The supported output type are : string, array, uint8array, arraybuffer, nodebuffer. + * If no output type is specified, the unmodified input will be returned. + * @param {String} outputType the output type. + * @param {String|Array|ArrayBuffer|Uint8Array|Buffer} input the input to convert. + * @throws {Error} an Error if the browser doesn't support the requested output type. + */ +exports.transformTo = function(outputType, input) { + if (!input) { + // undefined, null, etc + // an empty string won't harm. + input = ""; + } + if (!outputType) { + return input; + } + exports.checkSupport(outputType); + var inputType = exports.getTypeOf(input); + var result = transform[inputType][outputType](input); + return result; +}; + +/** + * Return the type of the input. + * The type will be in a format valid for JSZip.utils.transformTo : string, array, uint8array, arraybuffer. + * @param {Object} input the input to identify. + * @return {String} the (lowercase) type of the input. + */ +exports.getTypeOf = function(input) { + if (typeof input === "string") { + return "string"; + } + if (Object.prototype.toString.call(input) === "[object Array]") { + return "array"; + } + if (support.nodebuffer && nodejsUtils.isBuffer(input)) { + return "nodebuffer"; + } + if (support.uint8array && input instanceof Uint8Array) { + return "uint8array"; + } + if (support.arraybuffer && input instanceof ArrayBuffer) { + return "arraybuffer"; + } +}; + +/** + * Throw an exception if the type is not supported. + * @param {String} type the type to check. + * @throws {Error} an Error if the browser doesn't support the requested type. + */ +exports.checkSupport = function(type) { + var supported = support[type.toLowerCase()]; + if (!supported) { + throw new Error(type + " is not supported by this platform"); + } +}; + +exports.MAX_VALUE_16BITS = 65535; +exports.MAX_VALUE_32BITS = -1; // well, "\xFF\xFF\xFF\xFF\xFF\xFF\xFF\xFF" is parsed as -1 + +/** + * Prettify a string read as binary. + * @param {string} str the string to prettify. + * @return {string} a pretty string. + */ +exports.pretty = function(str) { + var res = '', + code, i; + for (i = 0; i < (str || "").length; i++) { + code = str.charCodeAt(i); + res += '\\x' + (code < 16 ? "0" : "") + code.toString(16).toUpperCase(); + } + return res; +}; + +/** + * Defer the call of a function. + * @param {Function} callback the function to call asynchronously. + * @param {Array} args the arguments to give to the callback. + */ +exports.delay = function(callback, args, self) { + setImmediate(function () { + callback.apply(self || null, args || []); + }); +}; + +/** + * Extends a prototype with an other, without calling a constructor with + * side effects. Inspired by nodejs' `utils.inherits` + * @param {Function} ctor the constructor to augment + * @param {Function} superCtor the parent constructor to use + */ +exports.inherits = function (ctor, superCtor) { + var Obj = function() {}; + Obj.prototype = superCtor.prototype; + ctor.prototype = new Obj(); +}; + +/** + * Merge the objects passed as parameters into a new one. + * @private + * @param {...Object} var_args All objects to merge. + * @return {Object} a new object with the data of the others. + */ +exports.extend = function() { + var result = {}, i, attr; + for (i = 0; i < arguments.length; i++) { // arguments is not enumerable in some browsers + for (attr in arguments[i]) { + if (arguments[i].hasOwnProperty(attr) && typeof result[attr] === "undefined") { + result[attr] = arguments[i][attr]; + } + } + } + return result; +}; + +/** + * Transform arbitrary content into a Promise. + * @param {String} name a name for the content being processed. + * @param {Object} inputData the content to process. + * @param {Boolean} isBinary true if the content is not an unicode string + * @param {Boolean} isOptimizedBinaryString true if the string content only has one byte per character. + * @param {Boolean} isBase64 true if the string content is encoded with base64. + * @return {Promise} a promise in a format usable by JSZip. + */ +exports.prepareContent = function(name, inputData, isBinary, isOptimizedBinaryString, isBase64) { + + // if inputData is already a promise, this flatten it. + var promise = external.Promise.resolve(inputData).then(function(data) { + + + var isBlob = support.blob && (data instanceof Blob || ['[object File]', '[object Blob]'].indexOf(Object.prototype.toString.call(data)) !== -1); + + if (isBlob && typeof FileReader !== "undefined") { + return new external.Promise(function (resolve, reject) { + var reader = new FileReader(); + + reader.onload = function(e) { + resolve(e.target.result); + }; + reader.onerror = function(e) { + reject(e.target.error); + }; + reader.readAsArrayBuffer(data); + }); + } else { + return data; + } + }); + + return promise.then(function(data) { + var dataType = exports.getTypeOf(data); + + if (!dataType) { + return external.Promise.reject( + new Error("Can't read the data of '" + name + "'. Is it " + + "in a supported JavaScript type (String, Blob, ArrayBuffer, etc) ?") + ); + } + // special case : it's way easier to work with Uint8Array than with ArrayBuffer + if (dataType === "arraybuffer") { + data = exports.transformTo("uint8array", data); + } else if (dataType === "string") { + if (isBase64) { + data = base64.decode(data); + } + else if (isBinary) { + // optimizedBinaryString === true means that the file has already been filtered with a 0xFF mask + if (isOptimizedBinaryString !== true) { + // this is a string, not in a base64 format. + // Be sure that this is a correct "binary string" + data = string2binary(data); + } + } + } + return data; + }); +}; + +},{"./base64":1,"./external":6,"./nodejsUtils":14,"./support":30,"set-immediate-shim":54}],33:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var sig = require('./signature'); +var ZipEntry = require('./zipEntry'); +var utf8 = require('./utf8'); +var support = require('./support'); +// class ZipEntries {{{ +/** + * All the entries in the zip file. + * @constructor + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntries(loadOptions) { + this.files = []; + this.loadOptions = loadOptions; +} +ZipEntries.prototype = { + /** + * Check that the reader is on the specified signature. + * @param {string} expectedSignature the expected signature. + * @throws {Error} if it is an other signature. + */ + checkSignature: function(expectedSignature) { + if (!this.reader.readAndCheckSignature(expectedSignature)) { + this.reader.index -= 4; + var signature = this.reader.readString(4); + throw new Error("Corrupted zip or bug: unexpected signature " + "(" + utils.pretty(signature) + ", expected " + utils.pretty(expectedSignature) + ")"); + } + }, + /** + * Check if the given signature is at the given index. + * @param {number} askedIndex the index to check. + * @param {string} expectedSignature the signature to expect. + * @return {boolean} true if the signature is here, false otherwise. + */ + isSignature: function(askedIndex, expectedSignature) { + var currentIndex = this.reader.index; + this.reader.setIndex(askedIndex); + var signature = this.reader.readString(4); + var result = signature === expectedSignature; + this.reader.setIndex(currentIndex); + return result; + }, + /** + * Read the end of the central directory. + */ + readBlockEndOfCentral: function() { + this.diskNumber = this.reader.readInt(2); + this.diskWithCentralDirStart = this.reader.readInt(2); + this.centralDirRecordsOnThisDisk = this.reader.readInt(2); + this.centralDirRecords = this.reader.readInt(2); + this.centralDirSize = this.reader.readInt(4); + this.centralDirOffset = this.reader.readInt(4); + + this.zipCommentLength = this.reader.readInt(2); + // warning : the encoding depends of the system locale + // On a linux machine with LANG=en_US.utf8, this field is utf8 encoded. + // On a windows machine, this field is encoded with the localized windows code page. + var zipComment = this.reader.readData(this.zipCommentLength); + var decodeParamType = support.uint8array ? "uint8array" : "array"; + // To get consistent behavior with the generation part, we will assume that + // this is utf8 encoded unless specified otherwise. + var decodeContent = utils.transformTo(decodeParamType, zipComment); + this.zipComment = this.loadOptions.decodeFileName(decodeContent); + }, + /** + * Read the end of the Zip 64 central directory. + * Not merged with the method readEndOfCentral : + * The end of central can coexist with its Zip64 brother, + * I don't want to read the wrong number of bytes ! + */ + readBlockZip64EndOfCentral: function() { + this.zip64EndOfCentralSize = this.reader.readInt(8); + this.reader.skip(4); + // this.versionMadeBy = this.reader.readString(2); + // this.versionNeeded = this.reader.readInt(2); + this.diskNumber = this.reader.readInt(4); + this.diskWithCentralDirStart = this.reader.readInt(4); + this.centralDirRecordsOnThisDisk = this.reader.readInt(8); + this.centralDirRecords = this.reader.readInt(8); + this.centralDirSize = this.reader.readInt(8); + this.centralDirOffset = this.reader.readInt(8); + + this.zip64ExtensibleData = {}; + var extraDataSize = this.zip64EndOfCentralSize - 44, + index = 0, + extraFieldId, + extraFieldLength, + extraFieldValue; + while (index < extraDataSize) { + extraFieldId = this.reader.readInt(2); + extraFieldLength = this.reader.readInt(4); + extraFieldValue = this.reader.readData(extraFieldLength); + this.zip64ExtensibleData[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + }, + /** + * Read the end of the Zip 64 central directory locator. + */ + readBlockZip64EndOfCentralLocator: function() { + this.diskWithZip64CentralDirStart = this.reader.readInt(4); + this.relativeOffsetEndOfZip64CentralDir = this.reader.readInt(8); + this.disksCount = this.reader.readInt(4); + if (this.disksCount > 1) { + throw new Error("Multi-volumes zip are not supported"); + } + }, + /** + * Read the local files, based on the offset read in the central part. + */ + readLocalFiles: function() { + var i, file; + for (i = 0; i < this.files.length; i++) { + file = this.files[i]; + this.reader.setIndex(file.localHeaderOffset); + this.checkSignature(sig.LOCAL_FILE_HEADER); + file.readLocalPart(this.reader); + file.handleUTF8(); + file.processAttributes(); + } + }, + /** + * Read the central directory. + */ + readCentralDir: function() { + var file; + + this.reader.setIndex(this.centralDirOffset); + while (this.reader.readAndCheckSignature(sig.CENTRAL_FILE_HEADER)) { + file = new ZipEntry({ + zip64: this.zip64 + }, this.loadOptions); + file.readCentralPart(this.reader); + this.files.push(file); + } + + if (this.centralDirRecords !== this.files.length) { + if (this.centralDirRecords !== 0 && this.files.length === 0) { + // We expected some records but couldn't find ANY. + // This is really suspicious, as if something went wrong. + throw new Error("Corrupted zip or bug: expected " + this.centralDirRecords + " records in central dir, got " + this.files.length); + } else { + // We found some records but not all. + // Something is wrong but we got something for the user: no error here. + // console.warn("expected", this.centralDirRecords, "records in central dir, got", this.files.length); + } + } + }, + /** + * Read the end of central directory. + */ + readEndOfCentral: function() { + var offset = this.reader.lastIndexOfSignature(sig.CENTRAL_DIRECTORY_END); + if (offset < 0) { + // Check if the content is a truncated zip or complete garbage. + // A "LOCAL_FILE_HEADER" is not required at the beginning (auto + // extractible zip for example) but it can give a good hint. + // If an ajax request was used without responseType, we will also + // get unreadable data. + var isGarbage = !this.isSignature(0, sig.LOCAL_FILE_HEADER); + + if (isGarbage) { + throw new Error("Can't find end of central directory : is this a zip file ? " + + "If it is, see https://stuk.github.io/jszip/documentation/howto/read_zip.html"); + } else { + throw new Error("Corrupted zip: can't find end of central directory"); + } + + } + this.reader.setIndex(offset); + var endOfCentralDirOffset = offset; + this.checkSignature(sig.CENTRAL_DIRECTORY_END); + this.readBlockEndOfCentral(); + + + /* extract from the zip spec : + 4) If one of the fields in the end of central directory + record is too small to hold required data, the field + should be set to -1 (0xFFFF or 0xFFFFFFFF) and the + ZIP64 format record should be created. + 5) The end of central directory record and the + Zip64 end of central directory locator record must + reside on the same disk when splitting or spanning + an archive. + */ + if (this.diskNumber === utils.MAX_VALUE_16BITS || this.diskWithCentralDirStart === utils.MAX_VALUE_16BITS || this.centralDirRecordsOnThisDisk === utils.MAX_VALUE_16BITS || this.centralDirRecords === utils.MAX_VALUE_16BITS || this.centralDirSize === utils.MAX_VALUE_32BITS || this.centralDirOffset === utils.MAX_VALUE_32BITS) { + this.zip64 = true; + + /* + Warning : the zip64 extension is supported, but ONLY if the 64bits integer read from + the zip file can fit into a 32bits integer. This cannot be solved : JavaScript represents + all numbers as 64-bit double precision IEEE 754 floating point numbers. + So, we have 53bits for integers and bitwise operations treat everything as 32bits. + see https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Operators/Bitwise_Operators + and http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-262.pdf section 8.5 + */ + + // should look for a zip64 EOCD locator + offset = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + if (offset < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory locator"); + } + this.reader.setIndex(offset); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_LOCATOR); + this.readBlockZip64EndOfCentralLocator(); + + // now the zip64 EOCD record + if (!this.isSignature(this.relativeOffsetEndOfZip64CentralDir, sig.ZIP64_CENTRAL_DIRECTORY_END)) { + // console.warn("ZIP64 end of central directory not where expected."); + this.relativeOffsetEndOfZip64CentralDir = this.reader.lastIndexOfSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + if (this.relativeOffsetEndOfZip64CentralDir < 0) { + throw new Error("Corrupted zip: can't find the ZIP64 end of central directory"); + } + } + this.reader.setIndex(this.relativeOffsetEndOfZip64CentralDir); + this.checkSignature(sig.ZIP64_CENTRAL_DIRECTORY_END); + this.readBlockZip64EndOfCentral(); + } + + var expectedEndOfCentralDirOffset = this.centralDirOffset + this.centralDirSize; + if (this.zip64) { + expectedEndOfCentralDirOffset += 20; // end of central dir 64 locator + expectedEndOfCentralDirOffset += 12 /* should not include the leading 12 bytes */ + this.zip64EndOfCentralSize; + } + + var extraBytes = endOfCentralDirOffset - expectedEndOfCentralDirOffset; + + if (extraBytes > 0) { + // console.warn(extraBytes, "extra bytes at beginning or within zipfile"); + if (this.isSignature(endOfCentralDirOffset, sig.CENTRAL_FILE_HEADER)) { + // The offsets seem wrong, but we have something at the specified offset. + // So… we keep it. + } else { + // the offset is wrong, update the "zero" of the reader + // this happens if data has been prepended (crx files for example) + this.reader.zero = extraBytes; + } + } else if (extraBytes < 0) { + throw new Error("Corrupted zip: missing " + Math.abs(extraBytes) + " bytes."); + } + }, + prepareReader: function(data) { + this.reader = readerFor(data); + }, + /** + * Read a zip file and create ZipEntries. + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the binary string representing a zip file. + */ + load: function(data) { + this.prepareReader(data); + this.readEndOfCentral(); + this.readCentralDir(); + this.readLocalFiles(); + } +}; +// }}} end of ZipEntries +module.exports = ZipEntries; + +},{"./reader/readerFor":22,"./signature":23,"./support":30,"./utf8":31,"./utils":32,"./zipEntry":34}],34:[function(require,module,exports){ +'use strict'; +var readerFor = require('./reader/readerFor'); +var utils = require('./utils'); +var CompressedObject = require('./compressedObject'); +var crc32fn = require('./crc32'); +var utf8 = require('./utf8'); +var compressions = require('./compressions'); +var support = require('./support'); + +var MADE_BY_DOS = 0x00; +var MADE_BY_UNIX = 0x03; + +/** + * Find a compression registered in JSZip. + * @param {string} compressionMethod the method magic to find. + * @return {Object|null} the JSZip compression object, null if none found. + */ +var findCompression = function(compressionMethod) { + for (var method in compressions) { + if (!compressions.hasOwnProperty(method)) { + continue; + } + if (compressions[method].magic === compressionMethod) { + return compressions[method]; + } + } + return null; +}; + +// class ZipEntry {{{ +/** + * An entry in the zip file. + * @constructor + * @param {Object} options Options of the current file. + * @param {Object} loadOptions Options for loading the stream. + */ +function ZipEntry(options, loadOptions) { + this.options = options; + this.loadOptions = loadOptions; +} +ZipEntry.prototype = { + /** + * say if the file is encrypted. + * @return {boolean} true if the file is encrypted, false otherwise. + */ + isEncrypted: function() { + // bit 1 is set + return (this.bitFlag & 0x0001) === 0x0001; + }, + /** + * say if the file has utf-8 filename/comment. + * @return {boolean} true if the filename/comment is in utf-8, false otherwise. + */ + useUTF8: function() { + // bit 11 is set + return (this.bitFlag & 0x0800) === 0x0800; + }, + /** + * Read the local part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readLocalPart: function(reader) { + var compression, localExtraFieldsLength; + + // we already know everything from the central dir ! + // If the central dir data are false, we are doomed. + // On the bright side, the local part is scary : zip64, data descriptors, both, etc. + // The less data we get here, the more reliable this should be. + // Let's skip the whole header and dash to the data ! + reader.skip(22); + // in some zip created on windows, the filename stored in the central dir contains \ instead of /. + // Strangely, the filename here is OK. + // I would love to treat these zip files as corrupted (see http://www.info-zip.org/FAQ.html#backslashes + // or APPNOTE#4.4.17.1, "All slashes MUST be forward slashes '/'") but there are a lot of bad zip generators... + // Search "unzip mismatching "local" filename continuing with "central" filename version" on + // the internet. + // + // I think I see the logic here : the central directory is used to display + // content and the local directory is used to extract the files. Mixing / and \ + // may be used to display \ to windows users and use / when extracting the files. + // Unfortunately, this lead also to some issues : http://seclists.org/fulldisclosure/2009/Sep/394 + this.fileNameLength = reader.readInt(2); + localExtraFieldsLength = reader.readInt(2); // can't be sure this will be the same as the central dir + // the fileName is stored as binary data, the handleUTF8 method will take care of the encoding. + this.fileName = reader.readData(this.fileNameLength); + reader.skip(localExtraFieldsLength); + + if (this.compressedSize === -1 || this.uncompressedSize === -1) { + throw new Error("Bug or corrupted zip : didn't get enough information from the central directory " + "(compressedSize === -1 || uncompressedSize === -1)"); + } + + compression = findCompression(this.compressionMethod); + if (compression === null) { // no compression found + throw new Error("Corrupted zip : compression " + utils.pretty(this.compressionMethod) + " unknown (inner file : " + utils.transformTo("string", this.fileName) + ")"); + } + this.decompressed = new CompressedObject(this.compressedSize, this.uncompressedSize, this.crc32, compression, reader.readData(this.compressedSize)); + }, + + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readCentralPart: function(reader) { + this.versionMadeBy = reader.readInt(2); + reader.skip(2); + // this.versionNeeded = reader.readInt(2); + this.bitFlag = reader.readInt(2); + this.compressionMethod = reader.readString(2); + this.date = reader.readDate(); + this.crc32 = reader.readInt(4); + this.compressedSize = reader.readInt(4); + this.uncompressedSize = reader.readInt(4); + var fileNameLength = reader.readInt(2); + this.extraFieldsLength = reader.readInt(2); + this.fileCommentLength = reader.readInt(2); + this.diskNumberStart = reader.readInt(2); + this.internalFileAttributes = reader.readInt(2); + this.externalFileAttributes = reader.readInt(4); + this.localHeaderOffset = reader.readInt(4); + + if (this.isEncrypted()) { + throw new Error("Encrypted zip are not supported"); + } + + // will be read in the local part, see the comments there + reader.skip(fileNameLength); + this.readExtraFields(reader); + this.parseZIP64ExtraField(reader); + this.fileComment = reader.readData(this.fileCommentLength); + }, + + /** + * Parse the external file attributes and get the unix/dos permissions. + */ + processAttributes: function () { + this.unixPermissions = null; + this.dosPermissions = null; + var madeBy = this.versionMadeBy >> 8; + + // Check if we have the DOS directory flag set. + // We look for it in the DOS and UNIX permissions + // but some unknown platform could set it as a compatibility flag. + this.dir = this.externalFileAttributes & 0x0010 ? true : false; + + if(madeBy === MADE_BY_DOS) { + // first 6 bits (0 to 5) + this.dosPermissions = this.externalFileAttributes & 0x3F; + } + + if(madeBy === MADE_BY_UNIX) { + this.unixPermissions = (this.externalFileAttributes >> 16) & 0xFFFF; + // the octal permissions are in (this.unixPermissions & 0x01FF).toString(8); + } + + // fail safe : if the name ends with a / it probably means a folder + if (!this.dir && this.fileNameStr.slice(-1) === '/') { + this.dir = true; + } + }, + + /** + * Parse the ZIP64 extra field and merge the info in the current ZipEntry. + * @param {DataReader} reader the reader to use. + */ + parseZIP64ExtraField: function(reader) { + + if (!this.extraFields[0x0001]) { + return; + } + + // should be something, preparing the extra reader + var extraReader = readerFor(this.extraFields[0x0001].value); + + // I really hope that these 64bits integer can fit in 32 bits integer, because js + // won't let us have more. + if (this.uncompressedSize === utils.MAX_VALUE_32BITS) { + this.uncompressedSize = extraReader.readInt(8); + } + if (this.compressedSize === utils.MAX_VALUE_32BITS) { + this.compressedSize = extraReader.readInt(8); + } + if (this.localHeaderOffset === utils.MAX_VALUE_32BITS) { + this.localHeaderOffset = extraReader.readInt(8); + } + if (this.diskNumberStart === utils.MAX_VALUE_32BITS) { + this.diskNumberStart = extraReader.readInt(4); + } + }, + /** + * Read the central part of a zip file and add the info in this object. + * @param {DataReader} reader the reader to use. + */ + readExtraFields: function(reader) { + var end = reader.index + this.extraFieldsLength, + extraFieldId, + extraFieldLength, + extraFieldValue; + + if (!this.extraFields) { + this.extraFields = {}; + } + + while (reader.index + 4 < end) { + extraFieldId = reader.readInt(2); + extraFieldLength = reader.readInt(2); + extraFieldValue = reader.readData(extraFieldLength); + + this.extraFields[extraFieldId] = { + id: extraFieldId, + length: extraFieldLength, + value: extraFieldValue + }; + } + + reader.setIndex(end); + }, + /** + * Apply an UTF8 transformation if needed. + */ + handleUTF8: function() { + var decodeParamType = support.uint8array ? "uint8array" : "array"; + if (this.useUTF8()) { + this.fileNameStr = utf8.utf8decode(this.fileName); + this.fileCommentStr = utf8.utf8decode(this.fileComment); + } else { + var upath = this.findExtraFieldUnicodePath(); + if (upath !== null) { + this.fileNameStr = upath; + } else { + // ASCII text or unsupported code page + var fileNameByteArray = utils.transformTo(decodeParamType, this.fileName); + this.fileNameStr = this.loadOptions.decodeFileName(fileNameByteArray); + } + + var ucomment = this.findExtraFieldUnicodeComment(); + if (ucomment !== null) { + this.fileCommentStr = ucomment; + } else { + // ASCII text or unsupported code page + var commentByteArray = utils.transformTo(decodeParamType, this.fileComment); + this.fileCommentStr = this.loadOptions.decodeFileName(commentByteArray); + } + } + }, + + /** + * Find the unicode path declared in the extra field, if any. + * @return {String} the unicode path, null otherwise. + */ + findExtraFieldUnicodePath: function() { + var upathField = this.extraFields[0x7075]; + if (upathField) { + var extraReader = readerFor(upathField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the filename changed, this field is out of date. + if (crc32fn(this.fileName) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(upathField.length - 5)); + } + return null; + }, + + /** + * Find the unicode comment declared in the extra field, if any. + * @return {String} the unicode comment, null otherwise. + */ + findExtraFieldUnicodeComment: function() { + var ucommentField = this.extraFields[0x6375]; + if (ucommentField) { + var extraReader = readerFor(ucommentField.value); + + // wrong version + if (extraReader.readInt(1) !== 1) { + return null; + } + + // the crc of the comment changed, this field is out of date. + if (crc32fn(this.fileComment) !== extraReader.readInt(4)) { + return null; + } + + return utf8.utf8decode(extraReader.readData(ucommentField.length - 5)); + } + return null; + } +}; +module.exports = ZipEntry; + +},{"./compressedObject":2,"./compressions":3,"./crc32":4,"./reader/readerFor":22,"./support":30,"./utf8":31,"./utils":32}],35:[function(require,module,exports){ +'use strict'; + +var StreamHelper = require('./stream/StreamHelper'); +var DataWorker = require('./stream/DataWorker'); +var utf8 = require('./utf8'); +var CompressedObject = require('./compressedObject'); +var GenericWorker = require('./stream/GenericWorker'); + +/** + * A simple object representing a file in the zip file. + * @constructor + * @param {string} name the name of the file + * @param {String|ArrayBuffer|Uint8Array|Buffer} data the data + * @param {Object} options the options of the file + */ +var ZipObject = function(name, data, options) { + this.name = name; + this.dir = options.dir; + this.date = options.date; + this.comment = options.comment; + this.unixPermissions = options.unixPermissions; + this.dosPermissions = options.dosPermissions; + + this._data = data; + this._dataBinary = options.binary; + // keep only the compression + this.options = { + compression : options.compression, + compressionOptions : options.compressionOptions + }; +}; + +ZipObject.prototype = { + /** + * Create an internal stream for the content of this object. + * @param {String} type the type of each chunk. + * @return StreamHelper the stream. + */ + internalStream: function (type) { + var result = null, outputType = "string"; + try { + if (!type) { + throw new Error("No output type specified."); + } + outputType = type.toLowerCase(); + var askUnicodeString = outputType === "string" || outputType === "text"; + if (outputType === "binarystring" || outputType === "text") { + outputType = "string"; + } + result = this._decompressWorker(); + + var isUnicodeString = !this._dataBinary; + + if (isUnicodeString && !askUnicodeString) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + if (!isUnicodeString && askUnicodeString) { + result = result.pipe(new utf8.Utf8DecodeWorker()); + } + } catch (e) { + result = new GenericWorker("error"); + result.error(e); + } + + return new StreamHelper(result, outputType, ""); + }, + + /** + * Prepare the content in the asked type. + * @param {String} type the type of the result. + * @param {Function} onUpdate a function to call on each internal update. + * @return Promise the promise of the result. + */ + async: function (type, onUpdate) { + return this.internalStream(type).accumulate(onUpdate); + }, + + /** + * Prepare the content as a nodejs stream. + * @param {String} type the type of each chunk. + * @param {Function} onUpdate a function to call on each internal update. + * @return Stream the stream. + */ + nodeStream: function (type, onUpdate) { + return this.internalStream(type || "nodebuffer").toNodejsStream(onUpdate); + }, + + /** + * Return a worker for the compressed content. + * @private + * @param {Object} compression the compression object to use. + * @param {Object} compressionOptions the options to use when compressing. + * @return Worker the worker. + */ + _compressWorker: function (compression, compressionOptions) { + if ( + this._data instanceof CompressedObject && + this._data.compression.magic === compression.magic + ) { + return this._data.getCompressedWorker(); + } else { + var result = this._decompressWorker(); + if(!this._dataBinary) { + result = result.pipe(new utf8.Utf8EncodeWorker()); + } + return CompressedObject.createWorkerFrom(result, compression, compressionOptions); + } + }, + /** + * Return a worker for the decompressed content. + * @private + * @return Worker the worker. + */ + _decompressWorker : function () { + if (this._data instanceof CompressedObject) { + return this._data.getContentWorker(); + } else if (this._data instanceof GenericWorker) { + return this._data; + } else { + return new DataWorker(this._data); + } + } +}; + +var removedMethods = ["asText", "asBinary", "asNodeBuffer", "asUint8Array", "asArrayBuffer"]; +var removedFn = function () { + throw new Error("This method has been removed in JSZip 3.0, please check the upgrade guide."); +}; + +for(var i = 0; i < removedMethods.length; i++) { + ZipObject.prototype[removedMethods[i]] = removedFn; +} +module.exports = ZipObject; + +},{"./compressedObject":2,"./stream/DataWorker":27,"./stream/GenericWorker":28,"./stream/StreamHelper":29,"./utf8":31}],36:[function(require,module,exports){ +(function (global){ +'use strict'; +var Mutation = global.MutationObserver || global.WebKitMutationObserver; + +var scheduleDrain; + +{ + if (Mutation) { + var called = 0; + var observer = new Mutation(nextTick); + var element = global.document.createTextNode(''); + observer.observe(element, { + characterData: true + }); + scheduleDrain = function () { + element.data = (called = ++called % 2); + }; + } else if (!global.setImmediate && typeof global.MessageChannel !== 'undefined') { + var channel = new global.MessageChannel(); + channel.port1.onmessage = nextTick; + scheduleDrain = function () { + channel.port2.postMessage(0); + }; + } else if ('document' in global && 'onreadystatechange' in global.document.createElement('script')) { + scheduleDrain = function () { + + // Create a + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class AbstractMBean

+
+
+ +
+
    +
  • +
    +
    public abstract class AbstractMBean
+extends Object
    +
    Abstract class that encapsulates the registration of an MBean with the MBeanServer. + Exceptions that occur are swallowed and logged. + +

    This class is not thread-safe.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractMBean

        +
        protected AbstractMBean​(String name,
+                        LogManager logger)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        register

        +
        public void register()
        +
        Register this instance at the platform MBeanServer. Swallows all checked exceptions that might + occur and logs them.
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public void unregister()
        +
        Unregister this instance. May be called even if registration was not successful (does nothing + in this case).
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/Appender.html b/api/org/sosy_lab/common/Appender.html new file mode 100644 index 000000000..53b0f683d --- /dev/null +++ b/api/org/sosy_lab/common/Appender.html @@ -0,0 +1,270 @@ + + + + + +Appender (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Interface Appender

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    Appenders.AbstractAppender
    +
    +
    +
    public interface Appender
    +
    An interface for classes that know how to dump themselves into an Appendable. This can be + used for large string outputs, where writing into an Appendable is faster than creating a string + and then writing it in one piece.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        appendTo

        +
        void appendTo​(Appendable appendable)
+       throws IOException
        +
        Writes a string representation of this object into the given Appendable. + +

        It is strongly encouraged that this method behaves identically to + appendable.append(this.toString()), except for possibly calling append multiple times + with bits of the output.

        +
        +
        Parameters:
        +
        appendable - The appendable, may not be null.
        +
        Throws:
        +
        IOException - If the appendable throws an IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Appenders.AbstractAppender.html b/api/org/sosy_lab/common/Appenders.AbstractAppender.html new file mode 100644 index 000000000..3de490908 --- /dev/null +++ b/api/org/sosy_lab/common/Appenders.AbstractAppender.html @@ -0,0 +1,328 @@ + + + + + +Appenders.AbstractAppender (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Appenders.AbstractAppender

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        AbstractAppender

        +
        public AbstractAppender()
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/Appenders.html b/api/org/sosy_lab/common/Appenders.html new file mode 100644 index 000000000..30c1427f6 --- /dev/null +++ b/api/org/sosy_lab/common/Appenders.html @@ -0,0 +1,550 @@ + + + + + +Appenders (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Appenders

+
+
+ +
+
    +
  • +
    +
    public final class Appenders
+extends Object
    +
    Utility class providing Appenders for various cases.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        appendTo

        +
        public static void appendTo​(Appendable output,
+                            @Nullable Object o)
+                     throws IOException
        +
        Write the given object into the given output. If the object is an Appender, its Appender.appendTo(Appendable) method is called, otherwise the Object.toString() method + is called. The object may be null, in this case "null" is written.
        +
        +
        Parameters:
        +
        output - The appendable to write into.
        +
        o - The object which will be dumped, may be null.
        +
        Throws:
        +
        IOException - If the appendable throws an IOException
        +
        +
        • +
      + + + +
        +
      • +

        appendTo

        +
        @CanIgnoreReturnValue
+public static StringBuilder appendTo​(StringBuilder sb,
+                                     Appender a)
        +
        Let an Appender dump itself into a StringBuilder. This method is similar to + passing the StringBuilder to the Appender.appendTo(Appendable) method, just + without the checked exception.
        +
        +
        Parameters:
        +
        sb - The StringBuilder that will receive the content.
        +
        a - The Appender to dump into the StringBuilder.
        +
        Returns:
        +
        The passed StringBuilder to allow for method chaining.
        +
        +
        • +
      + + + +
        +
      • +

        forIterable

        +
        public static Appender forIterable​(Joiner joiner,
+                                   Iterable<?> it)
        +
        Return an Appender that writes an Iterable into the output using a given Joiner.
        +
        +
        Parameters:
        +
        joiner - The joiner that will be used to create a string representation of the iterable.
        +
        it - The iterable which will be dumped.
        +
        Returns:
        +
        an Appender instance
        +
        +
        • +
      + + + +
        +
      • +

        forMap

        +
        public static Appender forMap​(Joiner.MapJoiner joiner,
+                              Map<?,​?> map)
        +
        Return an Appender that writes a Map into the output using a given Joiner.
        +
        +
        Parameters:
        +
        joiner - The joiner that will be used to create a string representation of the map.
        +
        map - The map which will be dumped.
        +
        Returns:
        +
        an Appender instance
        +
        +
        • +
      + + + +
        +
      • +

        fromToStringMethod

        +
        public static Appender fromToStringMethod​(@Nullable Object o)
        +
        Return an Appender that writes the result of the Object.toString() method of an + object into the output. + +

        This will not give the performance benefit that is expected from the use of appenders, and + should only be used to adapt classes not implementing this interface themselves. + +

        If null is passed, the resulting appender will write "null". If an object is + passed, the appender will call the Object.toString() method once each time it is used + (no caching is done).

        +
        +
        Parameters:
        +
        o - The object which will be dumped, may be null.
        +
        Returns:
        +
        an Appender instance
        +
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public static Appender concat​(Iterable<Appender> pAppenders)
        +
        Create a new Appender that consists of the sequential concatenation of multiple + appenders. The given iterable is traversed once each time the resulting appender's Appender.appendTo(Appendable) method is called. The iterable may not contain nulls or be null + itself..
        +
        • +
      + + + +
        +
      • +

        concat

        +
        public static Appender concat​(Appender... pAppenders)
        +
        Create a new Appender that consists of the sequential concatenation of multiple + appenders.
        +
        +
        Throws:
        +
        NullPointerException - if any of the provided appendables is null
        +
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public static String toString​(Appender a)
        +
        Convert an Appender into a string by calling it's Appender.appendTo(Appendable) + method. + +

        Note that the contract of Appender specifies that you should be able to call Object.toString() on the object and get the same result, thus it should not be necessary to + call this method from client code. + +

        However, it may be practical to implement the Object.toString() method of an Appender by delegating to this method.

        +
        +
        Parameters:
        +
        a - The Appender to convert into a string.
        +
        Returns:
        +
        a string representation of the passed object.
        +
        +
        • +
      + + + +
        +
      • +

        toStringWithTruncation

        +
        public static String toStringWithTruncation​(Appender a,
+                                            int truncateAt)
        +
        Convert an Appender into a string by calling it's Appender.appendTo(Appendable) + method. + +

        This method truncates the returned string at a given length, and tries to be more efficient + than generating the full string and truncating it at the end (though no guarantees are made).

        +
        +
        Parameters:
        +
        a - The Appender to convert into a string.
        +
        truncateAt - The maximum size of the returned string (>= 0)
        +
        Returns:
        +
        a string representation of the passed object, with a maximum size of truncateAt +
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/ChildFirstPatternClassLoader.html b/api/org/sosy_lab/common/ChildFirstPatternClassLoader.html new file mode 100644 index 000000000..fcb6f833c --- /dev/null +++ b/api/org/sosy_lab/common/ChildFirstPatternClassLoader.html @@ -0,0 +1,415 @@ + + + + + +ChildFirstPatternClassLoader (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class ChildFirstPatternClassLoader

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Closeable, AutoCloseable
    +
    +
    +
    @Deprecated
+public class ChildFirstPatternClassLoader
+extends URLClassLoader
    +
    Deprecated. +
    replaced with Classes.makeExtendedURLClassLoader() and Classes.ClassLoaderBuilder.setDirectLoadClasses(Predicate).
    +
    +
    This is a URLClassLoader that behaves like a normal class loader except that it loads + some classes always by itself, even if the parent class loader would also have been available to + load them. + +

    Normal class loaders follow the parent-first strategy, so they never load classes which their + parent could also load. This class loader follows the child-first strategy for a specific set of + classes (given by a pattern) and the parent-first strategy for the rest. + +

    This class loader can be used if you want to load a component with its own class loader (so + that it can be garbage collected independently, for example), but the parent class loader also + sees the classes.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ChildFirstPatternClassLoader

        +
        public ChildFirstPatternClassLoader​(Predicate<String> pLoadInChild,
+                                    URL[] pUrls,
+                                    ClassLoader pParent)
        +
        Deprecated.
        +
        Create a new class loader.
        +
        +
        Parameters:
        +
        pLoadInChild - The predicate telling which classes should never be loaded by the parent.
        +
        pUrls - The sources where this class loader should load classes from.
        +
        pParent - The parent class loader.
        +
        +
        • +
      + + + +
        +
      • +

        ChildFirstPatternClassLoader

        +
        public ChildFirstPatternClassLoader​(Pattern pClassPattern,
+                                    URL[] pUrls,
+                                    ClassLoader pParent)
        +
        Deprecated.
        +
        Create a new class loader.
        +
        +
        Parameters:
        +
        pClassPattern - The pattern telling which classes should never be loaded by the parent.
        +
        pUrls - The sources where this class loader should load classes from.
        +
        pParent - The parent class loader.
        +
        +
        • +
      +
      • +
    +
    + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/Classes.ClassInstantiationException.html b/api/org/sosy_lab/common/Classes.ClassInstantiationException.html new file mode 100644 index 000000000..6620d14aa --- /dev/null +++ b/api/org/sosy_lab/common/Classes.ClassInstantiationException.html @@ -0,0 +1,324 @@ + + + + + +Classes.ClassInstantiationException (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Classes.ClassInstantiationException

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClassInstantiationException

        +
        public ClassInstantiationException​(String className,
+                                   String msg,
+                                   Throwable cause)
        +
        Deprecated.
        +
        • +
      + + + +
        +
      • +

        ClassInstantiationException

        +
        public ClassInstantiationException​(String className,
+                                   Throwable cause)
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Classes.ClassLoaderBuilder.html b/api/org/sosy_lab/common/Classes.ClassLoaderBuilder.html new file mode 100644 index 000000000..ce0a465d2 --- /dev/null +++ b/api/org/sosy_lab/common/Classes.ClassLoaderBuilder.html @@ -0,0 +1,464 @@ + + + + + +Classes.ClassLoaderBuilder (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Classes.ClassLoaderBuilder<B extends Classes.ClassLoaderBuilder<B>>

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Classes
    +
    +
    +
    public abstract static class Classes.ClassLoaderBuilder<B extends Classes.ClassLoaderBuilder<B>>
+extends Object
    +
    A builder for class loaders with more features than URLClassLoader.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setParent

        +
        @CanIgnoreReturnValue
+public abstract B setParent​(ClassLoader parent)
        +
        Set parent of new class loader. If not set the default delegation parent class loader will be + used (like URLClassLoader(URL[]).
        +
        • +
      + + + +
        +
      • +

        setUrls

        +
        @CanIgnoreReturnValue
+public abstract B setUrls​(Iterable<URL> urls)
        +
        Set sources for classes of new class loader just like for URLClassLoader (this or + setUrls(URL...) are required).
        +
        • +
      + + + +
        +
      • +

        setUrls

        +
        @CanIgnoreReturnValue
+public abstract B setUrls​(URL... urls)
        +
        Set sources for classes of new class loader just like for URLClassLoader (this or + setUrls(Iterable) are required).
        +
        • +
      + + + + + + + +
        +
      • +

        setDirectLoadClasses

        +
        @CanIgnoreReturnValue
+public abstract B setDirectLoadClasses​(Predicate<String> classes)
        +
        Set a predicate that specifies which classes are forced to be loaded by the new class loader + and not its parent, even if the latter could load them. + +

        The predicate should match the fully-qualified class name. The default is to not match any + classes. + +

        Normally class loaders follow the parent-first strategy, so they never load classes which + their parent could also load. The new class loader follows the child-first strategy for a + specific set of classes (as specified by this predicate) and the parent-first strategy for + the rest. + +

        This feature can be used if you want to load a component with its own class loader (so + that it can be garbage collected independently, for example), but the parent class loader + also sees the classes.

        +
        • +
      + + + + + + + +
        +
      • +

        setCustomLookupNativeLibraries

        +
        @CanIgnoreReturnValue
+public abstract B setCustomLookupNativeLibraries​(Predicate<String> libraries)
        +
        Set a predicate that specifies for which native libraries we should use a custom lookup for + the binary as documented in NativeLibraries. + +

        The predicate should match the library name as given to System.loadLibrary(String). The default is to not match any libraries. + +

        Note that this is only effective if the new class loader is actually the one that is asked + to load the new library. Because Java's class loaders follow the parent-first strategy, it is + easy to end up with a parent class loader loading the library, if the parent can see the + class(es) that do the loading. In this case, use setDirectLoadClasses(Predicate) to + ensure the new class loader loads all relevant classes itself.

        +
        • +
      + + + + + + + + + + + +
        +
      • +

        build

        +
        @CheckReturnValue
+public abstract URLClassLoader build()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Classes.UnexpectedCheckedException.html b/api/org/sosy_lab/common/Classes.UnexpectedCheckedException.html new file mode 100644 index 000000000..c98a6b6d7 --- /dev/null +++ b/api/org/sosy_lab/common/Classes.UnexpectedCheckedException.html @@ -0,0 +1,306 @@ + + + + + +Classes.UnexpectedCheckedException (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Classes.UnexpectedCheckedException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    Enclosing class:
    +
    Classes
    +
    +
    +
    public static final class Classes.UnexpectedCheckedException
+extends RuntimeException
    +
    An exception that should be used if a checked exception is encountered in a situation where it + is not excepted (e.g., when getting the result from a Callable of which you know it + shouldn't throw such exceptions).
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UnexpectedCheckedException

        +
        public UnexpectedCheckedException​(String message,
+                                  Throwable source)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Classes.UnsuitedClassException.html b/api/org/sosy_lab/common/Classes.UnsuitedClassException.html new file mode 100644 index 000000000..bb4c1bd1d --- /dev/null +++ b/api/org/sosy_lab/common/Classes.UnsuitedClassException.html @@ -0,0 +1,252 @@ + + + + + +Classes.UnsuitedClassException (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Classes.UnsuitedClassException

+
+
+ +
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Classes.html b/api/org/sosy_lab/common/Classes.html new file mode 100644 index 000000000..63e7d4531 --- /dev/null +++ b/api/org/sosy_lab/common/Classes.html @@ -0,0 +1,765 @@ + + + + + +Classes (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Classes

+
+
+ +
+
    +
  • +
    +
    public final class Classes
+extends Object
    +
    Helper class for various methods related to handling Java classes and types.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getCodeLocation

        +
        public static Path getCodeLocation​(Class<?> cls)
        +
        Return the Path to the location of the code of the given class, e.g., the JAR file. If + the class is in a *.class file, the base directory of the package structure is + returned.
        +
        • +
      + + + +
        +
      • +

        createInstance

        +
        @Deprecated
+public static <T> T createInstance​(Class<? extends T> cls,
+                                   Class<?> @Nullable [] argumentTypes,
+                                   Object @Nullable [] argumentValues,
+                                   Class<T> type)
+                            throws Classes.ClassInstantiationException,
+                                   InvocationTargetException
        +
        Deprecated.
        +
        Creates an instance of class cls, passing the objects from argumentList to the constructor and + casting the object to class type.
        +
        +
        Parameters:
        +
        cls - The class to instantiate.
        +
        argumentTypes - Array with the types of the parameters of the desired constructor.
        +
        argumentValues - Array with the values that will be passed to the constructor.
        +
        type - The return type (has to be a super type of the class, of course).
        +
        Throws:
        +
        Classes.ClassInstantiationException - If something goes wrong (like class cannot be found or has + no constructor).
        +
        InvocationTargetException - If the constructor throws an exception.
        +
        +
        • +
      + + + +
        +
      • +

        createInstance

        +
        @Deprecated
+public static <T> T createInstance​(Class<T> type,
+                                   Class<? extends T> cls,
+                                   Class<?> @Nullable [] argumentTypes,
+                                   Object[] argumentValues)
+                            throws InvalidConfigurationException
        +
        Deprecated.
        +
        Creates an instance of class cls, passing the objects from argumentList to the constructor and + casting the object to class type. + +

        If there is no matching constructor or the the class cannot be instantiated, an + InvalidConfigurationException is thrown.

        +
        +
        Parameters:
        +
        type - The return type (has to be a super type of the class, of course).
        +
        cls - The class to instantiate.
        +
        argumentTypes - Array with the types of the parameters of the desired constructor + (optional).
        +
        argumentValues - Array with the values that will be passed to the constructor.
        +
        Throws:
        +
        InvalidConfigurationException
        +
        +
        • +
      + + + +
        +
      • +

        createInstance

        +
        @Deprecated
+public static <T,​X extends Exception> T createInstance​(Class<T> type,
+                                                             Class<? extends T> cls,
+                                                             Class<?> @Nullable [] argumentTypes,
+                                                             Object[] argumentValues,
+                                                             Class<X> exceptionType)
+                                                      throws X extends Exception,
+                                                             InvalidConfigurationException
        +
        Deprecated.
        +
        Creates an instance of class cls, passing the objects from argumentList to the constructor and + casting the object to class type. + +

        If there is no matching constructor or the the class cannot be instantiated, an + InvalidConfigurationException is thrown.

        +
        +
        Parameters:
        +
        type - The return type (has to be a super type of the class, of course).
        +
        cls - The class to instantiate.
        +
        argumentTypes - Array with the types of the parameters of the desired constructor + (optional).
        +
        argumentValues - Array with the values that will be passed to the constructor.
        +
        exceptionType - An exception type the constructor is allowed to throw.
        +
        Throws:
        +
        X extends Exception
        +
        InvalidConfigurationException
        +
        +
        • +
      + + + +
        +
      • +

        forName

        +
        public static Class<?> forName​(String name,
+                               @Nullable String prefix)
+                        throws ClassNotFoundException
        +
        Similar to Class.forName(String), but if the class is not found this method re-tries + with a package name prefixed.
        +
        +
        Parameters:
        +
        name - The class name.
        +
        prefix - An optional package name as prefix.
        +
        Returns:
        +
        The class object for name or prefix + "." + name
        +
        Throws:
        +
        ClassNotFoundException - If none of the two classes can be found.
        +
        SecurityException - If a security manager denies access to the class loader
        +
        +
        • +
      + + + +
        +
      • +

        verifyDeclaredExceptions

        +
        public static @Nullable String verifyDeclaredExceptions​(Executable executable,
+                                                        Class<?>... allowedExceptionTypes)
        +
        Verify that a constructor or method declares no other checked exceptions except a given type. + +

        Returns the name of any violating exception, or null if there is none.

        +
        +
        Parameters:
        +
        executable - The executable to check.
        +
        allowedExceptionTypes - The type of exception that is allowed.
        +
        Returns:
        +
        Null or the name of a declared exception.
        +
        +
        • +
      + + + +
        +
      • +

        verifyDeclaredExceptions

        +
        public static @Nullable String verifyDeclaredExceptions​(Invokable<?,​?> invokable,
+                                                        Class<?>... allowedExceptionTypes)
        +
        Verify that a constructor or method declares no other checked exceptions except a given type. + +

        Returns the name of any violating exception, or null if there is none.

        +
        +
        Parameters:
        +
        invokable - The invokable to check.
        +
        allowedExceptionTypes - The type of exception that is allowed.
        +
        Returns:
        +
        Null or the name of a declared exception.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        getSingleTypeArgument

        +
        public static Type getSingleTypeArgument​(Type type)
        +
        From a type X<Foo>, extract the Foo. This is the value of ParameterizedType.getActualTypeArguments(). This method also supports X<? extends + Foo>, X<Foo<?>> etc. + +

        Example results: + + 

        
+ X<Foo>          : Foo
+ X<? extends Foo>: Foo
+ X<Foo<Bar>>     : Foo<Bar>
+
        +
        +
        Parameters:
        +
        type - The type (needs to be parameterized with exactly one parameter)
        +
        Returns:
        +
        A Type object.
        +
        +
        • +
      + + + +
        +
      • +

        extractUpperBoundFromType

        +
        public static Type extractUpperBoundFromType​(Type type)
        +
        Simplify a Type instance: if it is a wildcard generic type, replace it with its upper + bound. + +

        It does not support wildcards with several upper bounds.

        +
        +
        Parameters:
        +
        type - A possibly generic type.
        +
        Returns:
        +
        The type or its simplification.
        +
        +
        • +
      + + + +
        +
      • +

        produceClassLoadingWarning

        +
        public static void produceClassLoadingWarning​(LogManager logger,
+                                              Class<?> cls,
+                                              @Nullable Class<?> type)
        +
        • +
      + + + +
        +
      • +

        makeExtendedURLClassLoader

        +
        public static Classes.ClassLoaderBuilder<?> makeExtendedURLClassLoader()
        +
        Create a class loader that is based on an URLClassLoader but implements some additional + features. This method returns a builder that can be used to configure the new class loader.
        +
        • +
      + + + +
        +
      • +

        createFactory

        +
        public static <I> I createFactory​(Class<I> factoryType,
+                                  Class<?> cls)
+                           throws Classes.UnsuitedClassException
        +
        Create a factory at runtime that implements the interface factoryType and delegates to + either a constructor or a static factory method of cls. + +

        The factory interface needs to have exactly one method. The target class needs to have + either a single public static method name create, or a single public constructor. The + declared exceptions of the static method/constructor need to be a subset of those of the method + of the factory interface, and the same holds for the parameters. Parameters that are annotated + with an annotation named Nullable or NullableDecl may be missing in the factory + interface.

        +
        +
        Parameters:
        +
        factoryType - The factory interface
        +
        cls - The class which should be instantiated by the returned factory
        +
        Returns:
        +
        An implementation of factoryType that instantiates cls
        +
        Throws:
        +
        Classes.UnsuitedClassException - If the static method/constructor of cls does not fulfill + the restrictions of the factory interface
        +
        +
        • +
      + + + +
        +
      • +

        createFactory

        +
        public static <I> I createFactory​(TypeToken<I> factoryType,
+                                  Class<?> cls)
+                           throws Classes.UnsuitedClassException
        +
        Create a factory at runtime that implements the interface factoryType and delegates to + either a constructor or a static factory method of cls. + +

        The factory interface needs to have exactly one method. The target class needs to have + either a single public static method name create, or a single public constructor. The + declared exceptions of the static method/constructor need to be a subset of those of the method + of the factory interface, and the same holds for the parameters. Parameters that are annotated + with an annotation named Nullable or NullableDecl may be missing in the factory + interface.

        +
        +
        Parameters:
        +
        factoryType - A type token that represents the factory interface
        +
        cls - The class which should be instantiated by the returned factory
        +
        Returns:
        +
        An implementation of factoryType that instantiates cls
        +
        Throws:
        +
        Classes.UnsuitedClassException - If the static method/constructor of cls does not fulfill + the restrictions of the factory interface
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/Concurrency.html b/api/org/sosy_lab/common/Concurrency.html new file mode 100644 index 000000000..93f1d5111 --- /dev/null +++ b/api/org/sosy_lab/common/Concurrency.html @@ -0,0 +1,373 @@ + + + + + +Concurrency (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Concurrency

+
+
+ +
+
    +
  • +
    +
    public final class Concurrency
+extends Object
    +
    Helper methods for concurrency related things.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        waitForTermination

        +
        public static void waitForTermination​(ExecutorService executor)
        +
        Wait uninterruptibly until an ExecutorService has shutdown. It also ensures full memory + visibility of everything that was done in the callables. + +

        Interrupting the thread will have no effect, but this method will set the thread's + interrupted flag in this case.

        +
        • +
      + + + +
        +
      • +

        createThreadPool

        +
        public static ExecutorService createThreadPool()
        +
        Creates a thread pool of fixed size. Size is determined by processors available to the JVM.
        +
        +
        Returns:
        +
        thread pool
        +
        +
        • +
      + + + +
        +
      • +

        createThreadPool

        +
        public static ExecutorService createThreadPool​(ThreadFactory threadFactory)
        +
        Creates a thread pool of fixed size. Size is determined by processors available to the JVM.
        +
        +
        Parameters:
        +
        threadFactory - The thread factory to be used.
        +
        Returns:
        +
        thread pool
        +
        +
        • +
      + + + +
        +
      • +

        newThread

        +
        public static Thread newThread​(String name,
+                               Runnable r)
        +
        Create a new non-daemon thread with a name. Compared to creating threads manually, this has the + advantage that the thread will be created with the default settings. By default, Java lets + threads inherit some settings from the creating thread.
        +
        +
        Parameters:
        +
        name - The name of the new thread.
        +
        r - The Runnable to execute in the new thread.
        +
        Returns:
        +
        A new thread, not yet started.
        +
        +
        • +
      + + + +
        +
      • +

        newDaemonThread

        +
        public static Thread newDaemonThread​(String name,
+                                     Runnable r)
        +
        Create a new daemon thread with a name. Compared to creating threads manually, this has the + advantage that the thread will be created with the default settings. By default, Java lets + threads inherit some settings from the creating thread.
        +
        +
        Parameters:
        +
        name - The name of the new thread.
        +
        r - The Runnable to execute in the new thread.
        +
        Returns:
        +
        A new daemon thread, not yet started.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/JSON.html b/api/org/sosy_lab/common/JSON.html new file mode 100644 index 000000000..34bf8c4aa --- /dev/null +++ b/api/org/sosy_lab/common/JSON.html @@ -0,0 +1,303 @@ + + + + + +JSON (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class JSON

+
+
+ +
+
    +
  • +
    +
    public final class JSON
+extends Object
    +
    This class is based on code from the library JSON.simple in version 1.1 + (https://code.google.com/p/json-simple/). + +

    Significant performance improvements were made compared to the library.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        writeJSONString

        +
        public static void writeJSONString​(@Nullable Object value,
+                                   Path file)
+                            throws IOException
        +
        Encode an object into JSON text and write it to a file.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        writeJSONString

        +
        public static void writeJSONString​(@Nullable Object value,
+                                   Appendable out)
+                            throws IOException
        +
        Encode an object into JSON text and write it to out.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/LazyFutureTask.html b/api/org/sosy_lab/common/LazyFutureTask.html new file mode 100644 index 000000000..a49b09b4a --- /dev/null +++ b/api/org/sosy_lab/common/LazyFutureTask.html @@ -0,0 +1,414 @@ + + + + + +LazyFutureTask (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class LazyFutureTask<V extends @Nullable Object>

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/MoreStrings.WithLongString.html b/api/org/sosy_lab/common/MoreStrings.WithLongString.html new file mode 100644 index 000000000..00a1439e9 --- /dev/null +++ b/api/org/sosy_lab/common/MoreStrings.WithLongString.html @@ -0,0 +1,263 @@ + + + + + +MoreStrings.WithLongString (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Interface MoreStrings.WithLongString

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    MoreStrings
    +
    +
    +
    public static interface MoreStrings.WithLongString
    +
    Interface for classes that have a second, longer, string representation (with more information) + in addition to Object.toString().
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/MoreStrings.html b/api/org/sosy_lab/common/MoreStrings.html new file mode 100644 index 000000000..f2ebeb6b2 --- /dev/null +++ b/api/org/sosy_lab/common/MoreStrings.html @@ -0,0 +1,361 @@ + + + + + +MoreStrings (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class MoreStrings

+
+
+ +
+
    +
  • +
    +
    public final class MoreStrings
+extends Object
    +
    Utility class for String-related helpers, similar to Strings.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/NativeLibraries.Architecture.html b/api/org/sosy_lab/common/NativeLibraries.Architecture.html new file mode 100644 index 000000000..46dec9c40 --- /dev/null +++ b/api/org/sosy_lab/common/NativeLibraries.Architecture.html @@ -0,0 +1,432 @@ + + + + + +NativeLibraries.Architecture (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Enum NativeLibraries.Architecture

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NativeLibraries.Architecture[] values()
        +
        Deprecated.
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NativeLibraries.Architecture c : NativeLibraries.Architecture.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NativeLibraries.Architecture valueOf​(String name)
        +
        Deprecated.
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        guessVmArchitecture

        +
        public static NativeLibraries.Architecture guessVmArchitecture()
        +
        Deprecated.
        +
        Get the architecture of the current JVM, e.g., as required to load binary libraries. + +

        In most cases, the JVM architecture matches system architecture. In some cases, the system + architecture is not sufficient. For example, we could execute a 32bit JVM on a 64bit system. + We cannot check each possible combination, but check only the important ones like X86_64.

        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/NativeLibraries.OS.html b/api/org/sosy_lab/common/NativeLibraries.OS.html new file mode 100644 index 000000000..fb65e7db2 --- /dev/null +++ b/api/org/sosy_lab/common/NativeLibraries.OS.html @@ -0,0 +1,426 @@ + + + + + +NativeLibraries.OS (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Enum NativeLibraries.OS

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NativeLibraries.OS[] values()
        +
        Deprecated.
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NativeLibraries.OS c : NativeLibraries.OS.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NativeLibraries.OS valueOf​(String name)
        +
        Deprecated.
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        guessOperatingSystem

        +
        public static NativeLibraries.OS guessOperatingSystem()
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/NativeLibraries.html b/api/org/sosy_lab/common/NativeLibraries.html new file mode 100644 index 000000000..6db7146dd --- /dev/null +++ b/api/org/sosy_lab/common/NativeLibraries.html @@ -0,0 +1,381 @@ + + + + + +NativeLibraries (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class NativeLibraries

+
+
+ +
+
    +
  • +
    +
    public final class NativeLibraries
+extends Object
    +
    Helper class for loading native libraries. The methods in this class search for the library + binary in some more directories than those specified in the java.library.path system + property. + +

    The searched directories are: + +

      +
    • the same directory as the JAR file of this library +
    • the "native library path" as returned by getNativeLibraryPath(), which is the + directory ../native/<arch>-<os>/ relative to the JAR file of this library, with + <arch>-<os> being one of the following values depending on your system: +
        +
      • x86_64-linux +
      • x86-linux +
      • x86-windows +
      • x86_64-windows +
      • x86-macosx +
      • x86_64-macosx +
      +
    + +

    Standard usage is by calling the method loadLibrary(java.lang.String) with the library + name, or use Classes.makeExtendedURLClassLoader() and Classes.ClassLoaderBuilder.setCustomLookupNativeLibraries(java.util.function.Predicate) if + third-party code loads the library.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/Optionals.html b/api/org/sosy_lab/common/Optionals.html new file mode 100644 index 000000000..30e172518 --- /dev/null +++ b/api/org/sosy_lab/common/Optionals.html @@ -0,0 +1,664 @@ + + + + + +Optionals (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class Optionals

+
+
+ +
+
    +
  • +
    +
    public final class Optionals
+extends Object
    +
    Utilities for Optional.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/ProcessExecutor.html b/api/org/sosy_lab/common/ProcessExecutor.html new file mode 100644 index 000000000..1e7dbc5f5 --- /dev/null +++ b/api/org/sosy_lab/common/ProcessExecutor.html @@ -0,0 +1,730 @@ + + + + + +ProcessExecutor (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class ProcessExecutor<E extends Exception>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    E - The type of the exceptions the handle* methods may throw.
    +
    +
    +
    public class ProcessExecutor<E extends Exception>
+extends Object
    +
    This class can be used to execute a separate process and read its output in a convenient way. It + is only useful for processes which handle only one task and exit afterwards. + +

    This class is not thread-safe, it assumes that never two of its methods are executed + simultaneously. + +

    When an instance of this class is created, the corresponding process is started immediately. + Then some text may be written to stdin of the process with the println(String) method. + Afterwards join() has to be called, which reads the output from the process and calls + the handle* methods. This method blocks, i.e. when it returns the process has terminated. Now the + get* methods may be used to get the output of the process.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        println

        +
        public void println​(String s)
+             throws IOException
        +
        Write a String to the process. May only be called before join() was called, as + afterwards the process is not running anymore.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        print

        +
        public void print​(String s)
+           throws IOException
        +
        Write a String to the process. May only be called before join() was called, as + afterwards the process is not running anymore.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        sendEOF

        +
        public void sendEOF()
+             throws IOException
        +
        Sends the EOF (end of file) signal to stdin of the process.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        handleOutput

        +
        protected void handleOutput​(String line)
+                     throws E extends Exception
        +
        Handle one line of output from the process. This method may be overwritten by clients. The + default implementation logs the line on level ALL and adds it to a list which may later be + retrieved with getOutput(). It never throws an exception (but client implementations + may do so). + +

        This method will be called in a new thread.

        +
        +
        Throws:
        +
        E - Overwriting methods may throw this exception which will be propagated.
        +
        E extends Exception
        +
        +
        • +
      + + + +
        +
      • +

        handleErrorOutput

        +
        protected void handleErrorOutput​(String line)
+                          throws E extends Exception
        +
        Handle one line of stderr output from the process. This method may be overwritten by clients. + The default implementation logs the line on level WARNING and adds it to a list which may later + be retrieved with getErrorOutput(). It never throws an exception (but client + implementations may do so). + +

        This method will be called in a new thread.

        +
        +
        Throws:
        +
        E - Overwriting methods may throw this exception which will be propagated.
        +
        E extends Exception
        +
        +
        • +
      + + + +
        +
      • +

        handleExitCode

        +
        protected void handleExitCode​(int code)
+                       throws E extends Exception
        +
        Handle the exit code of the process. This method may be overwritten by clients. The default + implementation logs the code on level WARNING, if it is non-zero. + +

        This method will be called in a new thread.

        +
        +
        Throws:
        +
        E - Overwriting methods may throw this exception which will be propagated.
        +
        E extends Exception
        +
        +
        • +
      + + + +
        +
      • +

        isFinished

        +
        public boolean isFinished()
        +
        Checks whether the process has finished already. This is true exactly if join() has + been called.
        +
        • +
      + + + +
        +
      • +

        getOutput

        +
        public List<String> getOutput()
        +
        Returns the complete output of the process. May only be called after join() has been + called.
        +
        • +
      + + + +
        +
      • +

        getErrorOutput

        +
        public List<String> getErrorOutput()
        +
        Returns the complete output to stderr of the process. May only be called after join() + has been called.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/ShutdownManager.html b/api/org/sosy_lab/common/ShutdownManager.html new file mode 100644 index 000000000..d32125dda --- /dev/null +++ b/api/org/sosy_lab/common/ShutdownManager.html @@ -0,0 +1,359 @@ + + + + + +ShutdownManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class ShutdownManager

+
+
+ +
+
    +
  • +
    +
    public final class ShutdownManager
+extends Object
    +
    Together with ShutdownNotifier, this class implements a service for distributing shutdown + requests throughout an application's component, potentially in a hierarchy. + +

    Possible use cases are for example to implement timeouts or respond to Ctrl+C by terminating + the application in a graceful manner, i.e., letting the running code terminate itself and do + cleanup. It works passively, i.e., the running code is not forcibly interrupted, but needs to + check the ShutdownNotifier instance that is associated with this instance regularly. This + ensures that the running code is not left in an unclean state. + +

    This class is the entry point and allows issuing shutdown requests with requestShutdown(String). All components that need to get these requests or check whether the + should terminate should get the ShutdownNotifier instance that is returned by getNotifier(). By handing out only ShutdownNotifier instances instead of ShutdownManager instances, it can be controlled which components have the possibility to issue + shutdown requests, and which components may only respond to them. + +

    This class supports a hierarchy of instances. Setting the shutdown request on a higher-level + instance will do the same in all children instances (recursively), but not vice-versa. This can + be used for example to implement global and component-specific timeouts at the same time, with + the former overriding the latter if necessary. + +

    This class does not implement any timeout by itself. A separate component needs to be used + that implements the timeout and calls {requestShutdown(String)} in case it is reached. + +

    This class and ShutdownNotifier are completely thread safe.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        public static ShutdownManager create()
        +
        Create a fresh new instance of this class. The associated ShutdownNotifier has no + listeners and shutdown has not been requested yet.
        +
        • +
      + + + +
        +
      • +

        createWithParent

        +
        public static ShutdownManager createWithParent​(ShutdownNotifier parent)
        +
        Create a fresh new instance of this class in a hierarchy. + +

        The new instance is considered to be a child of the given ShutdownNotifier, this + means as soon as the parent has a shutdown requested, the same is true for the child instance + (but not vice-versa). Note that if the parent instance already has shutdown requested, the new + instance is also immediately in the same state.

        +
        +
        Parameters:
        +
        parent - A non-null ShutdownNotifier instance.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        requestShutdown

        +
        public void requestShutdown​(String pReason)
        +
        Request a shutdown of all components that check the associated ShutdownNotifier, by + letting ShutdownNotifier.shouldShutdown() return true in the future, and by notifying + all registered listeners. Only the first call to this method has an effect. When this method + returns, it is guaranteed that all currently registered listeners where notified and have been + unregistered.
        +
        +
        Parameters:
        +
        pReason - A non-null human-readable string that tells the user why a shutdown was + requested.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/ShutdownNotifier.ShutdownRequestListener.html b/api/org/sosy_lab/common/ShutdownNotifier.ShutdownRequestListener.html new file mode 100644 index 000000000..c9dad5193 --- /dev/null +++ b/api/org/sosy_lab/common/ShutdownNotifier.ShutdownRequestListener.html @@ -0,0 +1,274 @@ + + + + + +ShutdownNotifier.ShutdownRequestListener (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Interface ShutdownNotifier.ShutdownRequestListener

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    ShutdownNotifier
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @FunctionalInterface
+public static interface ShutdownNotifier.ShutdownRequestListener
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        shutdownRequested

        +
        void shutdownRequested​(String reason)
        +
        This method is called on registered listeners the first time ShutdownManager.requestShutdown(String) on the associated ShutdownManager instance + is called. + +

        Implementations of this method should be reasonably quick and never throw an exception. + +

        Note that it is usually not necessary to use a listener when all you want to do in this + method is to set some boolean flag. Instead, just call ShutdownNotifier.shouldShutdown() whenever you would check the flag (this is similarly cheap + and thread-safe).

        +
        +
        Parameters:
        +
        reason - A non-null human-readable string that tells the user why a shutdown was + requested.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/ShutdownNotifier.html b/api/org/sosy_lab/common/ShutdownNotifier.html new file mode 100644 index 000000000..069b267b8 --- /dev/null +++ b/api/org/sosy_lab/common/ShutdownNotifier.html @@ -0,0 +1,482 @@ + + + + + +ShutdownNotifier (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class ShutdownNotifier

+
+
+ +
+
    +
  • +
    +
    public final class ShutdownNotifier
+extends Object
    +
    This class allows code to check whether it should terminate for some reason, and to be notified + of such requests. + +

    It works passively, the running analysis will not be interrupted directly, but instead it has + to check every then and now whether it should shutdown. This ensures that the running code is not + left in an unclean state. + +

    The check whether a shutdown was requested is cheap and should be done quite often in order to + ensure a timely response to a shutdown request. As a rule of thumb, all operations that may take + longer than 1s should take care of calling shouldShutdown() or shutdownIfNecessary() from time to time. + +

    Shutdown requests cannot be issued via this class, but only via ShutdownManager to + allow restricting which code is allowed to request shutdowns. + +

    Instances of this class cannot be created directly, instead create a ShutdownManager + and call ShutdownManager.getNotifier(). + +

    This class is completely thread safe.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createDummy

        +
        public static ShutdownNotifier createDummy()
        +
        Create an instance that will never return true for shouldShutdown() and will never + notify its listeners. This may be handy for tests. + +

        To create a real usable ShutdownNotifier, use ShutdownManager.create().

        +
        • +
      + + + +
        +
      • +

        shouldShutdown

        +
        public boolean shouldShutdown()
        +
        Check whether a shutdown was previously requested. This method returns false immediately after + this instance was constructed, and may return true later on. After it returned true once it + will always keep returning true, and never return false again. Calling this method is very + cheap.
        +
        • +
      + + + +
        +
      • +

        shutdownIfNecessary

        +
        public void shutdownIfNecessary()
+                         throws InterruptedException
        +
        Check whether a shutdown was previously requested, and throw an InterruptedException in + this case. Once a shutdown was requested, every call to this method will throw an exception. In + the common case that no shutdown was yet requested, calling this method is very cheap.
        +
        +
        Throws:
        +
        InterruptedException - If a shutdown was requested.
        +
        +
        • +
      + + + +
        +
      • +

        getReason

        +
        public String getReason()
        +
        Return the reason for the shutdown request on this instance.
        +
        +
        Returns:
        +
        A non-null human-readable string.
        +
        Throws:
        +
        IllegalStateException - If there was no shutdown request on this instance.
        +
        +
        • +
      + + + +
        +
      • +

        register

        +
        public void register​(ShutdownNotifier.ShutdownRequestListener listener)
        +
        Register a listener that will be notified once a shutdown is requested for the first time on + the associated ShutdownManager instance with ShutdownManager.requestShutdown(String). + +

        Listeners registered when shouldShutdown() already returns true will never be + notified (so calling this method at that time has no effect). + +

        This class keeps only weak reference to the listener to allow the GC to collect them, so + make sure to keep a strong reference to your instance as long as you won't to be notified.

        +
        +
        Parameters:
        +
        listener - A non-null and not already registered listener.
        +
        +
        • +
      + + + +
        +
      • +

        registerAndCheckImmediately

        +
        public void registerAndCheckImmediately​(ShutdownNotifier.ShutdownRequestListener listener)
        +
        Register a listener that will be notified once a shutdown is requested for the first time on + the associated ShutdownManager instance with ShutdownManager.requestShutdown(String), or immediately if this was already the case. + +

        Use this method to avoid a race condition when registering the listener and checking for a + requested shutdown at the same time (you could loose a notification). + +

        This class keeps only weak reference to the listener to allow the GC to collect them, so + make sure to keep a strong reference to your instance as long as you won't to be notified.

        +
        +
        Parameters:
        +
        listener - A non-null and not already registered listener.
        +
        +
        • +
      + + + +
        +
      • +

        unregister

        +
        public void unregister​(ShutdownNotifier.ShutdownRequestListener listener)
        +
        Unregister a listener. This listener will not be notified in the future. It is safe to call + this method twice with the same listener. It is not necessary to call this method for a + listener that was already notified.
        +
        +
        Parameters:
        +
        listener - A previously registered listener.
        +
        +
        • +
      + + + +
        +
      • +

        interruptCurrentThreadOnShutdown

        +
        public static ShutdownNotifier.ShutdownRequestListener interruptCurrentThreadOnShutdown()
        +
        Utility method for creating a ShutdownNotifier.ShutdownRequestListener that interrupts the current + thread (that calls this method) on a shutdown. Note that this method does not actually do + anything, you need to register the returned listener with an instance of this class.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/UniqueIdGenerator.html b/api/org/sosy_lab/common/UniqueIdGenerator.html new file mode 100644 index 000000000..48f7a2d48 --- /dev/null +++ b/api/org/sosy_lab/common/UniqueIdGenerator.html @@ -0,0 +1,308 @@ + + + + + +UniqueIdGenerator (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common
+

Class UniqueIdGenerator

+
+
+ +
+
    +
  • +
    +
    public final class UniqueIdGenerator
+extends Object
    +
    Utility class for generating unique. This class is fully thread-safe. + +

    It gives out at most MAX_INT ids, afterwards it throws an exception.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UniqueIdGenerator

        +
        public UniqueIdGenerator()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFreshId

        +
        public int getFreshId()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/annotations/FieldsAreNonnullByDefault.html b/api/org/sosy_lab/common/annotations/FieldsAreNonnullByDefault.html new file mode 100644 index 000000000..cb9958f64 --- /dev/null +++ b/api/org/sosy_lab/common/annotations/FieldsAreNonnullByDefault.html @@ -0,0 +1,193 @@ + + + + + +FieldsAreNonnullByDefault (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.annotations
+

Annotation Type FieldsAreNonnullByDefault

+
+
+
+
    +
  • +
    +
    @Documented
+@Nonnull
+@NonNull
+@TypeQualifierDefault(FIELD)
+@Retention(RUNTIME)
+public @interface FieldsAreNonnullByDefault
    +
    An annotation similar to ParametersAreNonnullByDefault that defines that + all fields inside the annotated element are never null, unless this is overridden with another + method.
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/annotations/ReturnValuesAreNonnullByDefault.html b/api/org/sosy_lab/common/annotations/ReturnValuesAreNonnullByDefault.html new file mode 100644 index 000000000..0e2a1c3e4 --- /dev/null +++ b/api/org/sosy_lab/common/annotations/ReturnValuesAreNonnullByDefault.html @@ -0,0 +1,195 @@ + + + + + +ReturnValuesAreNonnullByDefault (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.annotations
+

Annotation Type ReturnValuesAreNonnullByDefault

+
+
+
+
    +
  • +
    +
    @Documented
+@Nonnull
+@NonNull
+@TypeQualifierDefault(METHOD)
+@Retention(RUNTIME)
+public @interface ReturnValuesAreNonnullByDefault
    +
    An annotation similar to ParametersAreNonnullByDefault that defines that + all methods inside the annotated element do not return null, unless this is overridden with + another annotation. + +

    It is defined here because the annotation supplied by FindBugs is deprecated: ReturnValuesAreNonnullByDefault.

    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/annotations/SuppressForbidden.html b/api/org/sosy_lab/common/annotations/SuppressForbidden.html new file mode 100644 index 000000000..6c36bfc03 --- /dev/null +++ b/api/org/sosy_lab/common/annotations/SuppressForbidden.html @@ -0,0 +1,246 @@ + + + + + +SuppressForbidden (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.annotations
+

Annotation Type SuppressForbidden

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      Stringvalue +
      Description and explanation of what and why is suppressed.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        value

        +
        String value
        +
        Description and explanation of what and why is suppressed.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/annotations/Unmaintained.html b/api/org/sosy_lab/common/annotations/Unmaintained.html new file mode 100644 index 000000000..3071352fe --- /dev/null +++ b/api/org/sosy_lab/common/annotations/Unmaintained.html @@ -0,0 +1,192 @@ + + + + + +Unmaintained (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.annotations
+

Annotation Type Unmaintained

+
+
+
+
    +
  • +
    +
    @Documented
+@Retention(RUNTIME)
+@Target({PACKAGE,TYPE})
+public @interface Unmaintained
    +
    Annotation for component that are considered unmaintained, and might have inferior quality. + +

    Effects of this annotation may include hiding warnings produced by static-analysis tools, and + a warning given to the user when this component is used.

    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/annotations/package-summary.html b/api/org/sosy_lab/common/annotations/package-summary.html new file mode 100644 index 000000000..96818f7a0 --- /dev/null +++ b/api/org/sosy_lab/common/annotations/package-summary.html @@ -0,0 +1,200 @@ + + + + + +org.sosy_lab.common.annotations (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.annotations

+
+
+
+ + +
This package contains several general-purpose annotations.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + +
    Annotation Types Summary 
    Annotation TypeDescription
    FieldsAreNonnullByDefault +
    An annotation similar to ParametersAreNonnullByDefault that defines that + all fields inside the annotated element are never null, unless this is overridden with another + method.
    +
    ReturnValuesAreNonnullByDefault +
    An annotation similar to ParametersAreNonnullByDefault that defines that + all methods inside the annotated element do not return null, unless this is overridden with + another annotation.
    +
    SuppressForbidden +
    Annotation similar to SuppressWarnings, but intended to be used with + https://github.com/policeman-tools/forbidden-apis.
    +
    Unmaintained +
    Annotation for component that are considered unmaintained, and might have inferior quality.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/annotations/package-tree.html b/api/org/sosy_lab/common/annotations/package-tree.html new file mode 100644 index 000000000..8a28473d9 --- /dev/null +++ b/api/org/sosy_lab/common/annotations/package-tree.html @@ -0,0 +1,161 @@ + + + + + +org.sosy_lab.common.annotations Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.annotations

+Package Hierarchies: + +
+
+
+

Annotation Type Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/collect/Collections3.html b/api/org/sosy_lab/common/collect/Collections3.html new file mode 100644 index 000000000..ac87ceb74 --- /dev/null +++ b/api/org/sosy_lab/common/collect/Collections3.html @@ -0,0 +1,715 @@ + + + + + +Collections3 (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class Collections3

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        allElementsEqual

        +
        public static boolean allElementsEqual​(Iterable<?> iterable)
        +
        Check whether all elements contained in the given iterable are equal to each other. For a + non-empty iterable, this is the same as ImmutableSet.copyOf(iterable).size() == 1, but + more efficient.
        +
        +
        Throws:
        +
        IllegalArgumentException - if the iterable is empty
        +
        +
        • +
      + + + +
        +
      • +

        allElementsEqual

        +
        public static boolean allElementsEqual​(Object[] array)
        +
        Check whether all elements contained in the given array are equal to each other. For a + non-empty array, this is the same as ImmutableSet.copyOf(array).size() == 1, but more + efficient.
        +
        +
        Throws:
        +
        IllegalArgumentException - if the array is empty
        +
        +
        • +
      + + + +
        +
      • +

        allElementsEqual

        +
        public static boolean allElementsEqual​(Stream<?> stream)
        +
        Check whether all elements contained in the given stream are equal to each other. For a + non-empty stream, this is the same as stream.distinct().count() == 1, but more + efficient.
        +
        +
        Throws:
        +
        IllegalArgumentException - if the stream is empty
        +
        +
        • +
      + + + + + + + + + +
        +
      • +

        transformedImmutableListCopy

        +
        public static <T1,​T2> ImmutableList<T2> transformedImmutableListCopy​(T1[] input,
+                                                                           Function<? super T1,​T2> transformer)
        +
        Apply a function to all elements in an array and return an ImmutableList with the + results. + +

        This function is more efficient than code doing the same using Stream or FluentIterable.

        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        elementAndList

        +
        public static <T> ImmutableList<T> elementAndList​(T elem,
+                                                  Collection<? extends T> coll)
        +
        Return a list that contains the given element and the given collection.
        +
        • +
      + + + + + +
        +
      • +

        listAndElement

        +
        public static <T> ImmutableList<T> listAndElement​(Collection<? extends T> coll,
+                                                  T elem)
        +
        Return a list that contains the given collection and the given element.
        +
        • +
      + + + + + +
        +
      • +

        elementsAndList

        +
        public static <T> ImmutableList<T> elementsAndList​(T elem1,
+                                                   T elem2,
+                                                   Collection<? extends T> coll)
        +
        Return a list that contains the given elements and the given collection.
        +
        • +
      + + + + + +
        +
      • +

        listAndSurroundingElements

        +
        public static <T> ImmutableList<T> listAndSurroundingElements​(T elem1,
+                                                              Collection<? extends T> coll,
+                                                              T elem2)
        +
        Return a list that contains the given collection and the given elements, one before the + collection and one after.
        +
        • +
      + + + + + +
        +
      • +

        listAndElements

        +
        public static <T> ImmutableList<T> listAndElements​(Collection<? extends T> coll,
+                                                   T elem1,
+                                                   T elem2)
        +
        Return a list that contains the given collection and the given elements.
        +
        • +
      + + + + + + + +
        +
      • +

        subMapWithPrefix

        +
        public static <V> SortedMap<String,​V> subMapWithPrefix​(SortedMap<String,​V> map,
+                                                             String prefix)
        +
        Given a SortedMap with Strings as key, return a partial map (similar to SortedMap.subMap(Object, Object)) of all keys that have a given prefix.
        +
        +
        Parameters:
        +
        map - The map to filter.
        +
        prefix - The prefix that all keys in the result need to have.
        +
        Returns:
        +
        A partial map of the input.
        +
        +
        • +
      + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/CopyOnWriteSortedMap.html b/api/org/sosy_lab/common/collect/CopyOnWriteSortedMap.html new file mode 100644 index 000000000..4ef73ead9 --- /dev/null +++ b/api/org/sosy_lab/common/collect/CopyOnWriteSortedMap.html @@ -0,0 +1,759 @@ + + + + + +CopyOnWriteSortedMap (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class CopyOnWriteSortedMap<K,​V extends @Nullable Object>

+
+
+ +
+
    +
  • +
    +
    Type Parameters:
    +
    K - The type of keys.
    +
    V - The type of values.
    +
    +
    +
    All Implemented Interfaces:
    +
    Map<K,​V>, NavigableMap<K,​V>, SortedMap<K,​V>
    +
    +
    +
    public final class CopyOnWriteSortedMap<K,​V extends @Nullable Object>
+extends ForwardingNavigableMap<K,​V>
    +
    This is a map implementation that uses copy-on-write behavior. This may be a good fit when you + want to keep old snapshots of the map while modifying it. Through the use of a PersistentMap backend, snapshots and modifying operations are both cheap (O(1) for the former, + usually O(log n) for the latter). + +

    There are two usage patterns for this map. First, you can keep one instance of of the map + which you modify, and eventually call getSnapshot() to take immutable snapshots. Second, + you can use an instance of the map and create copies of it with the copyOf(CopyOnWriteSortedMap) method (these copies are O(1)). Then you can modify both the old + and the new instance, but modifications to one of it won't be reflected by the other. + +

    All collection views returned my methods of this map are live views and change if this map is + modified. However, they currently do not support any modifying operations. All iterators produced + by the collection views iterate over an immutable snapshot of the map taken at iterator creation + time and thus do not reflect intermediate changes to the map. The iterators also don't support + the Iterator.remove() method. Thus it is safe to iterate over the map while changing it. + +

    This implementation is thread-safe and lock free, but does not guarantee freedom of + starvation. Bulk operations are not atomic.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/MapsDifference.DefaultVisitor.html b/api/org/sosy_lab/common/collect/MapsDifference.DefaultVisitor.html new file mode 100644 index 000000000..185d772fa --- /dev/null +++ b/api/org/sosy_lab/common/collect/MapsDifference.DefaultVisitor.html @@ -0,0 +1,377 @@ + + + + + +MapsDifference.DefaultVisitor (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class MapsDifference.DefaultVisitor<K,​V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.collect.MapsDifference.DefaultVisitor<K,​V>
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/collect/MapsDifference.Entry.html b/api/org/sosy_lab/common/collect/MapsDifference.Entry.html new file mode 100644 index 000000000..536c0ccab --- /dev/null +++ b/api/org/sosy_lab/common/collect/MapsDifference.Entry.html @@ -0,0 +1,370 @@ + + + + + +MapsDifference.Entry (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class MapsDifference.Entry<K,​V>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.collect.MapsDifference.Entry<K,​V>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - The type of the key.
    +
    V - The type of the values.
    +
    +
    +
    Enclosing class:
    +
    MapsDifference
    +
    +
    +
    @Immutable(containerOf={"K","V"})
+public abstract static class MapsDifference.Entry<K,​V>
+extends Object
    +
    Class representing the difference between two maps for a given key. This class only allows + non-null keys and values.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        forLeftValueOnly

        +
        public static <K,​V> MapsDifference.Entry<K,​V> forLeftValueOnly​(K pKey,
+                                                                           V pLeftValue)
        +
        • +
      + + + + + +
        +
      • +

        forRightValueOnly

        +
        public static <K,​V> MapsDifference.Entry<K,​V> forRightValueOnly​(K pKey,
+                                                                            V pRightValue)
        +
        • +
      + + + + + +
        +
      • +

        forDifferingValues

        +
        public static <K,​V> MapsDifference.Entry<K,​V> forDifferingValues​(K pKey,
+                                                                             V pLeftValue,
+                                                                             V pRightValue)
        +
        • +
      + + + +
        +
      • +

        getKey

        +
        public abstract K getKey()
        +
        Returns the map key.
        +
        • +
      + + + +
        +
      • +

        getLeftValue

        +
        public abstract Optional<V> getLeftValue()
        +
        Returns the left value, if present.
        +
        • +
      + + + +
        +
      • +

        getRightValue

        +
        public abstract Optional<V> getRightValue()
        +
        Returns the right value, if present.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/MapsDifference.Visitor.html b/api/org/sosy_lab/common/collect/MapsDifference.Visitor.html new file mode 100644 index 000000000..d77a53580 --- /dev/null +++ b/api/org/sosy_lab/common/collect/MapsDifference.Visitor.html @@ -0,0 +1,318 @@ + + + + + +MapsDifference.Visitor (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface MapsDifference.Visitor<K,​V>

+
+
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        leftValueOnly

        +
        void leftValueOnly​(K key,
+                   V leftValue)
        +
        • +
      + + + + + +
        +
      • +

        rightValueOnly

        +
        void rightValueOnly​(K key,
+                    V rightValue)
        +
        • +
      + + + + + +
        +
      • +

        differingValues

        +
        void differingValues​(K key,
+                     V leftValue,
+                     V rightValue)
        +
        Accept a map difference.
        +
        +
        Parameters:
        +
        key - The key.
        +
        leftValue - The left value.
        +
        rightValue - The right value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/MapsDifference.html b/api/org/sosy_lab/common/collect/MapsDifference.html new file mode 100644 index 000000000..fba40c607 --- /dev/null +++ b/api/org/sosy_lab/common/collect/MapsDifference.html @@ -0,0 +1,328 @@ + + + + + +MapsDifference (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class MapsDifference

+
+
+ +
+
    +
  • +
    +
    public final class MapsDifference
+extends Object
    +
    Utilities for handling differences between maps.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/MoreCollectors.html b/api/org/sosy_lab/common/collect/MoreCollectors.html new file mode 100644 index 000000000..dcbcfa7c4 --- /dev/null +++ b/api/org/sosy_lab/common/collect/MoreCollectors.html @@ -0,0 +1,336 @@ + + + + + +MoreCollectors (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class MoreCollectors

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticMap.html b/api/org/sosy_lab/common/collect/OrderStatisticMap.html new file mode 100644 index 000000000..a7e12bec7 --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticMap.html @@ -0,0 +1,727 @@ + + + + + +OrderStatisticMap (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface OrderStatisticMap<K,​V extends @Nullable Object>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - the type of the keys of this map
    +
    V - the type of the values of this map
    +
    +
    +
    All Superinterfaces:
    +
    Map<K,​V>, NavigableMap<K,​V>, SortedMap<K,​V>
    +
    +
    +
    public interface OrderStatisticMap<K,​V extends @Nullable Object>
+extends NavigableMap<K,​V>
    +
    A NavigableMap that allows two additional operations: receiving (and deleting) an entry + by its rank, and getting the rank of an entry. + +

    Implementations should adhere to all contracts of the NavigableMap interface. + +

    Implementing classes should provide two means for comparing elements: + +

      +
    1. Using the natural ordering over the keys. In this case, all keys of the map have to + implement the Comparable interface. +
    2. Using a Comparator to create an order over the keys of the + map. +
    + +

    In both cases, the used compare-method should be consistent with equals, i.e., + compare(k, l) == 0 => k.equals(l), so that the Map + interface is correctly implemented. If the used compare-method is not consistent with + equals, the Map contract is not fulfilled (See the SortedMap + interface for a more detailed description).

    +
    +
    See Also:
    +
    Map, +SortedMap
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getKeyByRank

        +
        default K getKeyByRank​(int pIndex)
        +
        Returns the key of this map with the given rank. The lowest key in the map has rank == 0, the + largest key in the set has rank == size - 1. + +

        If this OrderStatisticMap is a view on some backing OrderStatisticMap (as created, e.g., by + descendingMap() or headMap(Object)), the returned rank is in relation to the + keys in the view, not in relation to the keys in the backing set. Thus, one can always expect + that key of rank 0 is the first key in this map, and key of rank Map.size() - 1 + is the last.

        +
        +
        Parameters:
        +
        pIndex - the rank of the key to return
        +
        Returns:
        +
        the key of this map with the given rank
        +
        Throws:
        +
        IndexOutOfBoundsException - if the given rank is out of the range of this map (i.e., + pRank < 0 || pRank >= size)
        +
        +
        • +
      + + + +
        +
      • +

        getEntryByRank

        +
        Map.Entry<K,​V> getEntryByRank​(int pIndex)
        +
        Returns the entry of this map with the given rank. The lowest entry in the set has rank == 0, + the largest entry in the set has rank == size - 1. + +

        If this OrderStatisticMap is a view on some backing OrderStatisticMap (as created, e.g., by + descendingMap() or headMap(Object)), the returned rank is in relation to the + entries in the view, not in relation to the entries in the backing set. Thus, one can always + expect that entry of rank 0 is the first entry in this map, and entry of rank + Map.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pIndex - the rank of the entry to return
        +
        Returns:
        +
        the entry of this map with the given rank
        +
        Throws:
        +
        IndexOutOfBoundsException - if the given rank is out of the range of this map (i.e., + pRank < 0 || pRank >= size)
        +
        +
        • +
      + + + +
        +
      • +

        removeByRank

        +
        @CanIgnoreReturnValue
+K removeByRank​(int pIndex)
        +
        Remove the entry of this map with the given rank and return its key. + +

        The lowest entry in the map has rank == 0, the largest entry in the map has rank == size - + 1. + +

        If this OrderStatisticMap is a view on some backing OrderStatisticMap (as created, e.g., by + descendingMap() or headMap(Object)), the returned rank is in relation to the + entries in the view, not in relation to the entries in the backing set. Thus, one can always + expect that entry of rank 0 is the first entry in this map, and entry of rank + Map.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pIndex - the rank of the element to remove
        +
        Returns:
        +
        the removed element
        +
        Throws:
        +
        IndexOutOfBoundsException - if the given rank is out of the range of this set (i.e., + pRank < 0 || pRank >= size)
        +
        See Also:
        +
        getKeyByRank(int)
        +
        +
        • +
      + + + + + +
        +
      • +

        rankOf

        +
        int rankOf​(K pObj)
        +
        Return the rank of the entry with the given key in this map. Returns -1 if the key does not + exist in the map. + +

        The lowest entry in the set has rank == 0, the largest entry in the set has rank == size - + 1. + +

        If this OrderStatisticMap is a view on some backing OrderStatisticMap (as created, e.g., by + descendingMap() or headMap(Object)), the returned rank is in relation to the + entries in the view, not in relation to the entries in the backing set. Thus, one can always + expect that key of rank 0 is the first key in this map, and key of rank + Map.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pObj - the key of the entry to return the rank for
        +
        Returns:
        +
        the rank of the entry with the given key in the map, or -1 if the key is not in the set
        +
        Throws:
        +
        NullPointerException - if the given key is null
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        create

        +
        static <K,​V> OrderStatisticMap<K,​V> create()
        +
        Creates a new empty OrderStatisticMap using natural ordering. The returned map guarantees + performance only in O(n) for the operations specific to the OrderStatisticMap interface.
        +
        • +
      + + + +
        +
      • +

        create

        +
        static <K,​V> OrderStatisticMap<K,​V> create​(Comparator<? super K> pComparator)
        +
        Creates a new empty OrderStatisticMap using the given comparator over its keys. The returned + map guarantees performance only in O(n) for the operations specific to the OrderStatisticMap + interface.
        +
        • +
      + + + +
        +
      • +

        createWithNaturalOrder

        +
        static <K,​V> OrderStatisticMap<K,​V> createWithNaturalOrder​(Map<? extends K,​? extends V> pMap)
        +
        Creates a new OrderStatisticSet containing the same entries as the given map, using natural + ordering over its keys. The returned map guarantees performance only in O(n) for the operations + specific to the OrderStatisticMap interface.
        +
        • +
      + + + +
        +
      • +

        createWithSameOrder

        +
        static <K,​V> OrderStatisticMap<K,​V> createWithSameOrder​(SortedMap<K,​? extends V> pSortedMap)
        +
        Creates a new OrderStatisticMap containing the same entries and using the same order over keys + as the given SortedMap. The returned map guarantees performance only in O(n) for the + operations specific to the OrderStatisticMap interface.
        +
        +
        Type Parameters:
        +
        K - type of the keys of the given and new map
        +
        V - type of the values of the given and new map
        +
        Parameters:
        +
        pSortedMap - map to use entries and ordering of
        +
        Returns:
        +
        a new OrderStatisticMap containing the same entries and using the same order over keys + as the given map
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.OrderStatisticMapFactory.html b/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.OrderStatisticMapFactory.html new file mode 100644 index 000000000..12c060eed --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.OrderStatisticMapFactory.html @@ -0,0 +1,371 @@ + + + + + +OrderStatisticMapTestSuite.OrderStatisticMapFactory (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class OrderStatisticMapTestSuite.OrderStatisticMapFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.google.common.collect.testing.TestStringMapGenerator
      • +
    • +
        +
      • com.google.common.collect.testing.TestStringSortedMapGenerator
        • +
      • +
          +
        • org.sosy_lab.common.collect.OrderStatisticMapTestSuite.OrderStatisticMapFactory
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.collect.testing.TestContainerGenerator<Map<String,​String>,​Map.Entry<String,​String>>, com.google.common.collect.testing.TestMapGenerator<String,​String>, com.google.common.collect.testing.TestSortedMapGenerator<String,​String>
    +
    +
    +
    Enclosing class:
    +
    OrderStatisticMapTestSuite
    +
    +
    +
    protected abstract static class OrderStatisticMapTestSuite.OrderStatisticMapFactory
+extends com.google.common.collect.testing.TestStringSortedMapGenerator
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.html b/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.html new file mode 100644 index 000000000..743e65e40 --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticMapTestSuite.html @@ -0,0 +1,806 @@ + + + + + +OrderStatisticMapTestSuite (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class OrderStatisticMapTestSuite

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.collect.OrderStatisticMapTestSuite
      • +
    +
    • +
+
+
    +
  • +
    +
    public abstract class OrderStatisticMapTestSuite
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testEquals

        +
        public void testEquals()
        +
        • +
      + + + +
        +
      • +

        testSerialize

        +
        public void testSerialize()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_mutation

        +
        public void testSubmapView_mutation()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_outOfBounds_add

        +
        public void testSubmapView_outOfBounds_add()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_outOfBounds_remove

        +
        public void testSubmapView_outOfBounds_remove()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_outOfBounds_contains

        +
        public void testSubmapView_outOfBounds_contains()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_descending

        +
        public void testSubmapView_descending()
        +
        • +
      + + + +
        +
      • +

        testKeyset_mutation

        +
        public void testKeyset_mutation()
        +
        • +
      + + + +
        +
      • +

        testSubmapView_submapOfSubmap

        +
        public void testSubmapView_submapOfSubmap()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_valid

        +
        public void testGetEntryByRank_valid()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_outOfBounds

        +
        public void testGetEntryByRank_outOfBounds()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_submapFirst

        +
        public void testGetEntryByRank_submapFirst()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_submapLast

        +
        public void testGetEntryByRank_submapLast()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_descendingMapFirstElement

        +
        public void testGetEntryByRank_descendingMapFirstElement()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_descendingMapSecondElement

        +
        public void testGetEntryByRank_descendingMapSecondElement()
        +
        • +
      + + + +
        +
      • +

        testGetEntryByRank_descendingMapLastElement

        +
        public void testGetEntryByRank_descendingMapLastElement()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_valid

        +
        public void testGetKeyByRank_valid()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_outOfBounds

        +
        public void testGetKeyByRank_outOfBounds()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_submapFirst

        +
        public void testGetKeyByRank_submapFirst()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_submapLast

        +
        public void testGetKeyByRank_submapLast()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_descendingMapFirstElement

        +
        public void testGetKeyByRank_descendingMapFirstElement()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_descendingMapSecondElement

        +
        public void testGetKeyByRank_descendingMapSecondElement()
        +
        • +
      + + + +
        +
      • +

        testGetKeyByRank_descendingMapLastElement

        +
        public void testGetKeyByRank_descendingMapLastElement()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_valid

        +
        public void testRemoveByRank_valid()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_invalid

        +
        public void testRemoveByRank_invalid()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_submapFirst

        +
        public void testRemoveByRank_submapFirst()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_submapLast

        +
        public void testRemoveByRank_submapLast()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_descendingMapFirstElement

        +
        public void testRemoveByRank_descendingMapFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_descendingMapLastElement

        +
        public void testRemoveByRank_descendingMapLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_firstElement

        +
        public void testRankOf_firstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_secondElement

        +
        public void testRankOf_secondElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_lastElement

        +
        public void testRankOf_lastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingMapFirstElement

        +
        public void testRankOf_descendingMapFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingMapSecondElement

        +
        public void testRankOf_descendingMapSecondElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingMapLastElement

        +
        public void testRankOf_descendingMapLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subMapFirstElement

        +
        public void testRankOf_subMapFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subMapLastElement

        +
        public void testRankOf_subMapLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subMapSecondElement

        +
        public void testRankOf_subMapSecondElement()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticSet.html b/api/org/sosy_lab/common/collect/OrderStatisticSet.html new file mode 100644 index 000000000..3adfbfeb3 --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticSet.html @@ -0,0 +1,645 @@ + + + + + +OrderStatisticSet (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface OrderStatisticSet<E>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    E - the type of elements maintained by this set
    +
    +
    +
    All Superinterfaces:
    +
    Collection<E>, Iterable<E>, NavigableSet<E>, Set<E>, SortedSet<E>
    +
    +
    +
    public interface OrderStatisticSet<E>
+extends NavigableSet<E>
    +
    A NavigableSet that allows two additional operations: receiving (and deleting) an element + by its rank, and getting the rank of an element. + +

    Implementations should adhere to all contracts of the NavigableSet interface. + +

    Implementing classes should provide two means for comparing elements: + +

      +
    1. Using the natural ordering of the elements. In this case, all elements of the set have to + implement the Comparable interface. +
    2. Using a Comparator to create an order over the elements of the + set. +
    + +

    In both cases, the used compare-method should be consistent with equals, i.e., + compare(a, b) == 0 => a.equals(b), so that the contract provided by Set is fulfilled. If the used compare-method is not consistent with equals + , the Set contract is not fulfilled.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getByRank

        +
        E getByRank​(int pIndex)
        +
        Returns the element of this set with the given rank. The lowest element in the set has rank == + 0, the largest element in the set has rank == size - 1. + +

        If this OrderStatisticSet is a view on some backing OrderStatisticSet (as created, e.g., by + descendingSet() or headSet(Object)), the returned rank is in relation to the + elements in the view, not in relation to the elements in the backing set. Thus, one can always + expect that element of rank 0 is the first element in this set, and element of rank + Set.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pIndex - the rank of the element to return
        +
        Returns:
        +
        the element of this set with the given rank
        +
        Throws:
        +
        IndexOutOfBoundsException - if the given rank is out of the range of this set (i.e., + pRank < 0 || pRank >= size)
        +
        +
        • +
      + + + +
        +
      • +

        removeByRank

        +
        @CanIgnoreReturnValue
+E removeByRank​(int pIndex)
        +
        Remove the element of this set with the given rank and return it. + +

        The lowest element in the set has rank == 0, the largest element in the set has rank == size + - 1. + +

        If this OrderStatisticSet is a view on some backing OrderStatisticSet (as created, e.g., by + descendingSet() or headSet(Object)), the returned rank is in relation to the + elements in the view, not in relation to the elements in the backing set. Thus, one can always + expect that element of rank 0 is the first element in this set, and element of rank + Set.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pIndex - the rank of the element to remove
        +
        Returns:
        +
        the removed element
        +
        Throws:
        +
        IndexOutOfBoundsException - if the given rank is out of the range of this set (i.e., + pRank < 0 || pRank >= size)
        +
        See Also:
        +
        getByRank(int)
        +
        +
        • +
      + + + + + +
        +
      • +

        rankOf

        +
        int rankOf​(E pObj)
        +
        Return the rank of the given element in this set. Returns -1 if the element does not exist in + the set. + +

        The lowest element in the set has rank == 0, the largest element in the set has rank == size + - 1. + +

        If this OrderStatisticSet is a view on some backing OrderStatisticSet (as created, e.g., by + descendingSet() or headSet(Object)), the returned rank is in relation to the + elements in the view, not in relation to the elements in the backing set. Thus, one can always + expect that element of rank 0 is the first element in this set, and element of rank + Set.size() - 1 is the last.

        +
        +
        Parameters:
        +
        pObj - the element to return the rank for
        +
        Returns:
        +
        the rank of the given element in the set, or -1 if the element is not in the set
        +
        Throws:
        +
        NullPointerException - if the given element is null
        +
        +
        • +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
        +
      • +

        create

        +
        static <E> OrderStatisticSet<E> create()
        +
        Creates a new empty OrderStatisticSet using natural ordering. The returned map guarantees + performance only in O(n) for the operations specific to the OrderStatisticSet interface.
        +
        • +
      + + + +
        +
      • +

        create

        +
        static <E> OrderStatisticSet<E> create​(Comparator<? super E> pComparator)
        +
        Creates a new empty OrderStatisticSet using the given comparator. The returned map guarantees + performance only in O(n) for the operations specific to the OrderStatisticSet interface.
        +
        • +
      + + + +
        +
      • +

        createWithNaturalOrder

        +
        static <E> OrderStatisticSet<E> createWithNaturalOrder​(Iterable<E> pCollection)
        +
        Creates a new OrderStatisticSet containing the same elements as the given Iterable, using + natural ordering. The returned map guarantees performance only in O(n) for the operations + specific to the OrderStatisticSet interface.
        +
        • +
      + + + +
        +
      • +

        createWithSameOrder

        +
        static <E> OrderStatisticSet<E> createWithSameOrder​(SortedSet<E> pSortedSet)
        +
        Creates a new OrderStatisticSet containing the same elements and using the same order as the + given SortedSet. The returned map guarantees performance only in O(n) for the + operations specific to the OrderStatisticSet interface.
        +
        +
        Type Parameters:
        +
        E - type of the elements of the given and new set
        +
        Parameters:
        +
        pSortedSet - set to use elements and ordering of
        +
        Returns:
        +
        a new OrderStatisticSet containing the same elements and using the same order as the + given set
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.OrderStatisticSetFactory.html b/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.OrderStatisticSetFactory.html new file mode 100644 index 000000000..2c99bcc64 --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.OrderStatisticSetFactory.html @@ -0,0 +1,350 @@ + + + + + +OrderStatisticSetTestSuite.OrderStatisticSetFactory (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class OrderStatisticSetTestSuite.OrderStatisticSetFactory

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • com.google.common.collect.testing.TestStringSetGenerator
      • +
    • +
        +
      • com.google.common.collect.testing.TestStringSortedSetGenerator
        • +
      • +
          +
        • org.sosy_lab.common.collect.OrderStatisticSetTestSuite.OrderStatisticSetFactory
          • +
        +
        • +
      +
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    com.google.common.collect.testing.TestCollectionGenerator<String>, com.google.common.collect.testing.TestContainerGenerator<Collection<String>,​String>, com.google.common.collect.testing.TestSetGenerator<String>, com.google.common.collect.testing.TestSortedSetGenerator<String>
    +
    +
    +
    Enclosing class:
    +
    OrderStatisticSetTestSuite
    +
    +
    +
    protected abstract static class OrderStatisticSetTestSuite.OrderStatisticSetFactory
+extends com.google.common.collect.testing.TestStringSortedSetGenerator
    +
    • +
+
+
+
    +
  • + +
    + +
    + +
    + +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        OrderStatisticSetFactory

        +
        protected OrderStatisticSetFactory()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        create

        +
        protected abstract OrderStatisticSet<String> create​(String[] pStrings)
        +
        +
        Specified by:
        +
        create in class com.google.common.collect.testing.TestStringSortedSetGenerator
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.html b/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.html new file mode 100644 index 000000000..cc9659286 --- /dev/null +++ b/api/org/sosy_lab/common/collect/OrderStatisticSetTestSuite.html @@ -0,0 +1,694 @@ + + + + + +OrderStatisticSetTestSuite (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class OrderStatisticSetTestSuite

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.collect.OrderStatisticSetTestSuite
      • +
    +
    • +
+
+
    +
  • +
    +
    public abstract class OrderStatisticSetTestSuite
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        testEquals

        +
        public void testEquals()
        +
        • +
      + + + +
        +
      • +

        testSerialize

        +
        public void testSerialize()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_mutation

        +
        public void testSubsetView_mutation()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_outOfBounds_add

        +
        public void testSubsetView_outOfBounds_add()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_outOfBounds_remove

        +
        public void testSubsetView_outOfBounds_remove()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_outOfBounds_contains

        +
        public void testSubsetView_outOfBounds_contains()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_descending

        +
        public void testSubsetView_descending()
        +
        • +
      + + + +
        +
      • +

        testSubsetView_subsetOfSubset

        +
        public void testSubsetView_subsetOfSubset()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_valid

        +
        public void testGetByRank_valid()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_outOfBounds

        +
        public void testGetByRank_outOfBounds()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_subsetFirst

        +
        public void testGetByRank_subsetFirst()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_subsetLast

        +
        public void testGetByRank_subsetLast()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_descendingSetFirstElement

        +
        public void testGetByRank_descendingSetFirstElement()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_descendingSetSecondElement

        +
        public void testGetByRank_descendingSetSecondElement()
        +
        • +
      + + + +
        +
      • +

        testGetByRank_descendingSetLastElement

        +
        public void testGetByRank_descendingSetLastElement()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_valid

        +
        public void testRemoveByRank_valid()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_invalid

        +
        public void testRemoveByRank_invalid()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_subsetFirst

        +
        public void testRemoveByRank_subsetFirst()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_subsetLast

        +
        public void testRemoveByRank_subsetLast()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_descendingSetFirstElement

        +
        public void testRemoveByRank_descendingSetFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRemoveByRank_descendingSetLastElement

        +
        public void testRemoveByRank_descendingSetLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_firstElement

        +
        public void testRankOf_firstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_secondElement

        +
        public void testRankOf_secondElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_lastElement

        +
        public void testRankOf_lastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingSetFirstElement

        +
        public void testRankOf_descendingSetFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingSetSecondElement

        +
        public void testRankOf_descendingSetSecondElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_descendingSetLastElement

        +
        public void testRankOf_descendingSetLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subSetFirstElement

        +
        public void testRankOf_subSetFirstElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subSetLastElement

        +
        public void testRankOf_subSetLastElement()
        +
        • +
      + + + +
        +
      • +

        testRankOf_subSetSecondElement

        +
        public void testRankOf_subSetSecondElement()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PathCopyingPersistentTreeMap.html b/api/org/sosy_lab/common/collect/PathCopyingPersistentTreeMap.html new file mode 100644 index 000000000..7cb948b62 --- /dev/null +++ b/api/org/sosy_lab/common/collect/PathCopyingPersistentTreeMap.html @@ -0,0 +1,1573 @@ + + + + + +PathCopyingPersistentTreeMap (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class PathCopyingPersistentTreeMap<K extends Comparable<? super K>,​V extends @Nullable Object>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.collect.PathCopyingPersistentTreeMap<K,​V>
      • +
    +
    • +
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - The type of keys.
    +
    V - The type of values.
    +
    +
    +
    All Implemented Interfaces:
    +
    Serializable, Map<K,​V>, NavigableMap<K,​V>, SortedMap<K,​V>, PersistentMap<K,​V>, PersistentSortedMap<K,​V>
    +
    +
    +
    @Immutable(containerOf={"K","V"})
+public final class PathCopyingPersistentTreeMap<K extends Comparable<? super K>,​V extends @Nullable Object>
+extends Object
+implements PersistentSortedMap<K,​V>, Serializable
    +
    This is an implementation of PersistentSortedMap that is based on left-leaning red-black + trees (LLRB) and path copying. Left-leaning red-black trees are similar to red-black trees and + 2-3 trees, but are considerably easier to implement than red-black trees. They are described by + Robert Sedgewick here: http://www.cs.princeton.edu/~rs/talks/LLRB/RedBlack.pdf + +

    The operations insert, lookup, and remove are guaranteed to run in O(log n) time. Insert and + remove allocate at most O(log n) memory. Traversal through all entries also allocates up to O(log + n) memory. Per entry, this map needs memory for one object with 4 reference fields and 1 boolean. + (This is a little bit less than TreeMap needs.) + +

    This implementation does not support null keys (but null values) and + always compares according to the natural ordering. All methods may throw ClassCastException is key objects are passed that do not implement Comparable. + +

    The natural ordering of the keys needs to be consistent with equals. + +

    As for all PersistentMaps, all collection views and all iterators are immutable. They + do not reflect changes made to the map and all their modifying operations throw UnsupportedOperationException. + +

    All instances of this class are fully-thread safe. However, note that each modifying operation + allocates a new instance whose reference needs to be published safely in order to be usable by + other threads. Two concurrent accesses to a modifying operation on the same instance will create + two new maps, each reflecting exactly the operation executed by the current thread, and not + reflecting the operation executed by the other thread.

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentLinkedList.html b/api/org/sosy_lab/common/collect/PersistentLinkedList.html new file mode 100644 index 000000000..fd46cd73a --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentLinkedList.html @@ -0,0 +1,861 @@ + + + + + +PersistentLinkedList (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class PersistentLinkedList<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Iterable<T>, Collection<T>, List<T>, PersistentList<T>
    +
    +
    +
    @Immutable(containerOf="T")
+public final class PersistentLinkedList<T>
+extends AbstractSequentialList<T>
+implements PersistentList<T>
    +
    A single-linked-list implementation of PersistentList. Null values are not supported + (similarly to ImmutableList). + +

    Adding to the front of the list needs only O(1) time and memory. + +

    This implementation supports almost all operations, except for the ListIterator.hasPrevious() and ListIterator.previous() methods of its list iterator. + This means you cannot traverse this list in reverse order. + +

    All instances of this class are fully-thread safe. However, note that each modifying operation + allocates a new instance whose reference needs to be published safely in order to be usable by + other threads. Two concurrent accesses to a modifying operation on the same instance will create + two new maps, each reflecting exactly the operation executed by the current thread, and not + reflecting the operation executed by the other thread.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentList.html b/api/org/sosy_lab/common/collect/PersistentList.html new file mode 100644 index 000000000..bed9c9ef0 --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentList.html @@ -0,0 +1,734 @@ + + + + + +PersistentList (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface PersistentList<T>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    T - The type of values.
    +
    +
    +
    All Superinterfaces:
    +
    Collection<T>, Iterable<T>, List<T>
    +
    +
    +
    All Known Implementing Classes:
    +
    PersistentLinkedList
    +
    +
    +
    @Immutable(containerOf="T")
+public interface PersistentList<T>
+extends List<T>
    +
    Interface for persistent lists. A persistent data structure is immutable, but provides cheap + copy-and-write operations. Thus all write operations ({with(Object), {without(Object)}) will not modify the current instance, but return a new instance instead. + +

    All modifying operations inherited from List are not supported and will always throw + UnsupportedOperationException. + +

    Instances of this interface are thread-safe as long as published safely.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentMap.html b/api/org/sosy_lab/common/collect/PersistentMap.html new file mode 100644 index 000000000..f34628304 --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentMap.html @@ -0,0 +1,751 @@ + + + + + +PersistentMap (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface PersistentMap<K,​V extends @Nullable Object>

+
+
+
+
    +
  • +
    +
    Type Parameters:
    +
    K - The type of keys.
    +
    V - The type of values.
    +
    +
    +
    All Superinterfaces:
    +
    Map<K,​V>
    +
    +
    +
    All Known Subinterfaces:
    +
    PersistentSortedMap<K,​V>, org.sosy_lab.common.collect.PersistentSortedMapBridge<K,​V>
    +
    +
    +
    All Known Implementing Classes:
    +
    PathCopyingPersistentTreeMap
    +
    +
    +
    @Immutable(containerOf={"K","V"})
+public interface PersistentMap<K,​V extends @Nullable Object>
+extends Map<K,​V>
    +
    Interface for persistent map. A persistent data structure is immutable, but provides cheap + copy-and-write operations. Thus all write operations ({putAndCopy(Object, Object), + {removeAndCopy(Object)}) will not modify the current instance, but return a new instance + instead. + +

    All modifying operations inherited from Map are not supported and will always throw + UnsupportedOperationException. All collections returned by methods of this interface are + also immutable. + +

    Instances of this interface are thread-safe as long as published safely.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentSortedMap.html b/api/org/sosy_lab/common/collect/PersistentSortedMap.html new file mode 100644 index 000000000..cfea2257b --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentSortedMap.html @@ -0,0 +1,621 @@ + + + + + +PersistentSortedMap (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface PersistentSortedMap<K,​V extends @Nullable Object>

+
+
+
+ +
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentSortedMaps.MergeConflictHandler.html b/api/org/sosy_lab/common/collect/PersistentSortedMaps.MergeConflictHandler.html new file mode 100644 index 000000000..b6b9039f6 --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentSortedMaps.MergeConflictHandler.html @@ -0,0 +1,281 @@ + + + + + +PersistentSortedMaps.MergeConflictHandler (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Interface PersistentSortedMaps.MergeConflictHandler<K,​V>

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    PersistentSortedMaps
    +
    +
    +
    Functional Interface:
    +
    This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
    +
    +
    +
    @FunctionalInterface
+public static interface PersistentSortedMaps.MergeConflictHandler<K,​V>
    +
    A callback that is used when a key with two different values is encountered during the merge of + two maps.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + +
        +
      • +

        resolveConflict

        +
        V resolveConflict​(K key,
+                  V value1,
+                  V value2)
        +
        Resolve a conflict for one given key. This handler is called only with two values that are + not considered equal according to the used Equivalence. One of the values may be + null, which means that the corresponding map contains null as value for this + key. The handler may return null, and in this case the resulting map will contain a + mapping key -> null.
        +
        +
        Parameters:
        +
        key - The key.
        +
        value1 - The value from the first map.
        +
        value2 - The value from the second map.
        +
        Returns:
        +
        The value that should be put into the resulting map.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/PersistentSortedMaps.html b/api/org/sosy_lab/common/collect/PersistentSortedMaps.html new file mode 100644 index 000000000..08eb264ea --- /dev/null +++ b/api/org/sosy_lab/common/collect/PersistentSortedMaps.html @@ -0,0 +1,416 @@ + + + + + +PersistentSortedMaps (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.collect
+

Class PersistentSortedMaps

+
+
+ +
+
    +
  • +
    +
    public final class PersistentSortedMaps
+extends Object
    +
    Utility class for PersistentSortedMaps. + +

    Currently this class provides a merge operation. The result of merging two maps is defined as + a map whose keyset is the union of the keyset of both input maps. The values of the resulting map + are the corresponding values of the input maps as long as they are not differing. Differing + values for one key are resolved by passing them to a callback function.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + + + + + +
        +
      • +

        merge

        +
        public static <K extends Comparable<? super K>,​V> PersistentSortedMap<K,​V> merge​(PersistentSortedMap<K,​V> map1,
+                                                                                             PersistentSortedMap<K,​V> map2,
+                                                                                             PersistentSortedMaps.MergeConflictHandler<K,​V> conflictHandler)
        +
        Merge two PersistentSortedMaps. The result has all key-value pairs where the key is only in one + of the map, those which are identical in both map, and for those keys that have a different + value in both maps a handler is called, and the result is put in the resulting map.
        +
        +
        Parameters:
        +
        map1 - The first map.
        +
        map2 - The second map.
        +
        conflictHandler - The handler that is called for a key with two different values.
        +
        Returns:
        +
        The merged map.
        +
        +
        • +
      + + + +
        +
      • +

        merge

        +
        public static <K extends Comparable<? super K>,​V> PersistentSortedMap<K,​V> merge​(PersistentSortedMap<K,​V> map1,
+                                                                                             PersistentSortedMap<K,​V> map2,
+                                                                                             Equivalence<? super V> valueEquals,
+                                                                                             PersistentSortedMaps.MergeConflictHandler<? super K,​V> conflictHandler,
+                                                                                             MapsDifference.Visitor<? super K,​? super V> collectDifferences)
        +
        Merge two PersistentSortedMaps. The result has all key-value pairs where the key is only in one + of the map, those which are identical in both map, and for those keys that have a different + value in both maps a handler is called, and the result is put in the resulting map. + +

        Optionally you can pass a list that will receive all encountered differences, i.e., keys + which are present in only one map, or have different values. The list will contain triples with + key and both values, where missing values are replaced by null. + +

        Implementation note: It may be faster to call this method with the bigger of the input maps + as the first parameter.

        +
        +
        Parameters:
        +
        map1 - The first map.
        +
        map2 - The second map.
        +
        valueEquals - The Equivalence that will determine whether two values are + considered equal.
        +
        conflictHandler - The handler that is called for a key with two different values.
        +
        collectDifferences - A visitor which receives keys with two different values or keys that + are present only in one of the maps.
        +
        Returns:
        +
        The merged map.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/package-summary.html b/api/org/sosy_lab/common/collect/package-summary.html new file mode 100644 index 000000000..47aa61143 --- /dev/null +++ b/api/org/sosy_lab/common/collect/package-summary.html @@ -0,0 +1,299 @@ + + + + + +org.sosy_lab.common.collect (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.collect

+
+
+
+ + +
This package contains additional interfaces and implementations for collections, as well as + further collection utilities.
+
+ +
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/collect/package-tree.html b/api/org/sosy_lab/common/collect/package-tree.html new file mode 100644 index 000000000..7eaa1b5a1 --- /dev/null +++ b/api/org/sosy_lab/common/collect/package-tree.html @@ -0,0 +1,279 @@ + + + + + +org.sosy_lab.common.collect Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.collect

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/configuration/AnnotatedValue.html b/api/org/sosy_lab/common/configuration/AnnotatedValue.html new file mode 100644 index 000000000..3e5d4d62e --- /dev/null +++ b/api/org/sosy_lab/common/configuration/AnnotatedValue.html @@ -0,0 +1,333 @@ + + + + + +AnnotatedValue (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class AnnotatedValue<T>

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.AnnotatedValue<T>
      • +
    +
    • +
+
+
    +
  • +
    +
    @Immutable(containerOf="T")
+public abstract class AnnotatedValue<T>
+extends Object
    +
    Immutable container that stores a value and an optional string.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/ClassOption.html b/api/org/sosy_lab/common/configuration/ClassOption.html new file mode 100644 index 000000000..9d2e52d4a --- /dev/null +++ b/api/org/sosy_lab/common/configuration/ClassOption.html @@ -0,0 +1,256 @@ + + + + + +ClassOption (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type ClassOption

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      String[]packagePrefix +
      This field provides optional package prefixes that can be added to the specified class name.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        packagePrefix

        +
        String[] packagePrefix
        +
        This field provides optional package prefixes that can be added to the specified class name. + First the specified class name is tried without any prefix, and then with each prefix in the + given order. The result is the first class that is found.
        +
        +
        Default:
        +
        {""}
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/Configuration.html b/api/org/sosy_lab/common/configuration/Configuration.html new file mode 100644 index 000000000..5ae8cb41f --- /dev/null +++ b/api/org/sosy_lab/common/configuration/Configuration.html @@ -0,0 +1,673 @@ + + + + + +Configuration (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class Configuration

+
+
+ +
+
    +
  • +
    +
    public final class Configuration
+extends Object
    +
    Immutable wrapper around a map with properties, providing useful access helper methods.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        enableSecureModeGlobally

        +
        public static void enableSecureModeGlobally()
        +
        Enable a secure mode, i.e., allow only injection of configuration options marked as secure. + Once enabled, this can not be disabled.
        +
        • +
      + + + +
        +
      • +

        defaultConfiguration

        +
        public static Configuration defaultConfiguration()
        +
        Creates a configuration with all values set to default.
        +
        • +
      + + + +
        +
      • +

        copyWithNewPrefix

        +
        public static Configuration copyWithNewPrefix​(Configuration oldConfig,
+                                              String newPrefix)
        +
        Creates a copy of a configuration with just the prefix set to a new value.
        +
        • +
      + + + +
        +
      • +

        getDefaultConverters

        +
        public static Map<Class<?>,​TypeConverter> getDefaultConverters()
        +
        Get the map of registered default TypeConverters. These type converters are used + whenever a new Configuration instance is created, except when the ConfigurationBuilder.copyFrom(Configuration) method is used. + +

        For all instances in this map the method TypeConverter.getInstanceForNewConfiguration(Configuration) will be called before the type + converter is actually added to a Configuration instance. + +

        The returned map is mutable and changes have immediate effect on this class! Callers are + free to add and remove mappings as they wish. However, as this is static state, this will + affect all other callers as well! Thus, it should be used only with caution, for example to add + default type converters in a large project at startup. It is discouraged to change this map, if + the same effect can easily be achieved using ConfigurationBuilder.addConverter(Class, + TypeConverter).

        +
        +
        Returns:
        +
        A reference to the map of type converters used by this class.
        +
        +
        • +
      + + + +
        +
      • +

        enableLogging

        +
        public void enableLogging​(LogManager pLogger)
        +
        • +
      + + + +
        +
      • +

        dumpUsedOptionsTo

        +
        public void dumpUsedOptionsTo​(PrintStream out)
        +
        Let this instance write human-readable information about every option that is used to the given + stream.
        +
        • +
      + + + +
        +
      • +

        getProperty

        +
        @Deprecated
+public @Nullable String getProperty​(String key)
        +
        Deprecated.
        +
        Get the value of an option. USE OF THIS METHOD IS NOT RECOMMENDED! + +

        Use configuration injection with Option and inject(Object) instead. This + provides type safety, documentation, logging etc.

        +
        • +
      + + + +
        +
      • +

        hasProperty

        +
        @Deprecated
+public boolean hasProperty​(String key)
        +
        Deprecated.
        +
        Check whether an option has a specified value. USE OF THIS METHOD IS NOT RECOMMENDED! + +

        Use configuration injection with Option and inject(Object) instead. This + provides type safety, documentation, logging, default values, etc.

        +
        • +
      + + + +
        +
      • +

        getUnusedProperties

        +
        public Set<String> getUnusedProperties()
        +
        • +
      + + + +
        +
      • +

        getDeprecatedProperties

        +
        public Set<String> getDeprecatedProperties()
        +
        • +
      + + + +
        +
      • +

        asPropertiesString

        +
        public String asPropertiesString()
        +
        • +
      + + + +
        +
      • +

        inject

        +
        public void inject​(Object obj)
+            throws InvalidConfigurationException
        +
        Inject the values of configuration options into an object. The class of the object has to have + a Options annotation, and each field to set / method to call has to have a Option annotation. + +

        Supported types for configuration options: + +

        + +

        For the collection types an immutable instance will be created and injected. Their type + parameter has to be one of the other supported types. For collection types and arrays the + values of the configuration option are assumed to be comma separated.

        +
        +
        Parameters:
        +
        obj - The object in which the configuration options should be injected.
        +
        Throws:
        +
        InvalidConfigurationException - If the user specified configuration is wrong.
        +
        +
        • +
      + + + +
        +
      • +

        inject

        +
        public void inject​(Object obj,
+                   Class<?> cls)
+            throws InvalidConfigurationException
        +
        Use this method if the calling class is likely to be sub-classed, so that the options of the + calling class get injected, not the options of the dynamic class type of the object.
        +
        +
        Parameters:
        +
        cls - The static class type of the object to inject.
        +
        Throws:
        +
        InvalidConfigurationException
        +
        See Also:
        +
        inject(Object)
        +
        +
        • +
      + + + + + +
        +
      • +

        injectWithDefaults

        +
        public <T> void injectWithDefaults​(T obj,
+                                   Class<T> cls,
+                                   T defaultsObject)
+                            throws InvalidConfigurationException
        +
        Same as inject(Object, Class), but if this Configuration instance does not contain a + value for a requested configuration option, use the value that is set in the given + defaultsInstance instead of the value that is set as default in the to-be-injected object. + This can be used to create a copy of an object but with some options changed according to this + Configuration instance. + +

        Note that this only works for configuration options that are specified as fields, not for + those specified as setters.

        +
        +
        Parameters:
        +
        obj - The to-be-injected instance.
        +
        cls - The static class type of the object to inject.
        +
        defaultsObject - The instance from which default values should be read.
        +
        Throws:
        +
        InvalidConfigurationException
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        fromCmdLineArguments

        +
        public static Configuration fromCmdLineArguments​(String[] args)
+                                          throws InvalidConfigurationException
        +
        Construct a configuration object from the array of command line arguments. + +

        The input format is as follows: + + 

        + 
+   --option=Value
+ 
+
        +
        +
        Parameters:
        +
        args - Command line arguments
        +
        Returns:
        +
        Constructed Configuration instance
        +
        Throws:
        +
        InvalidConfigurationException - On incorrect format or when configuration options for + Configurations class are invalid
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/ConfigurationBuilder.html b/api/org/sosy_lab/common/configuration/ConfigurationBuilder.html new file mode 100644 index 000000000..d0850a1ca --- /dev/null +++ b/api/org/sosy_lab/common/configuration/ConfigurationBuilder.html @@ -0,0 +1,601 @@ + + + + + +ConfigurationBuilder (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class ConfigurationBuilder

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.ConfigurationBuilder
      • +
    +
    • +
+
+
    +
  • +
    +
    public final class ConfigurationBuilder
+extends Object
    +
    Interface for constructing Configuration instances.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        clearOption

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder clearOption​(String name)
        +
        Reset a single option to its default value.
        +
        • +
      + + + + + + + +
        +
      • +

        setPrefix

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder setPrefix​(String newPrefix)
        +
        Set the optional prefix for new configuration.
        +
        • +
      + + + +
        +
      • +

        copyFrom

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder copyFrom​(Configuration sourceConfig)
        +
        Copy everything from an existing Configuration instance. This also means that the new + configuration object created by this builder will share the set of unused properties with the + configuration instance passed to this class. + +

        If this method is called, it has to be the first method call on this builder instance. + +

        The converters registered on the given Configuration instance will have TypeConverter.getInstanceForNewConfiguration(Configuration) called on them and the result will + be used as converter in the new configuration, except if overridden with addConverter(Class, TypeConverter).

        +
        • +
      + + + +
        +
      • +

        copyOptionFrom

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder copyOptionFrom​(Configuration sourceConfig,
+                                           String option)
        +
        Copy one single option from another Configuration instance, overwriting the value in this + builder, if it is already set. The given Configuration instance needs to have a value for this + option. + +

        It is better to use this method instead of + setOption(option, oldConfig.getProperty(option)), because it retains the mapping to the + source of this value, which allows better error messages and resolving relative file paths.

        +
        +
        Parameters:
        +
        sourceConfig - A configuration instance with a value for option.
        +
        option - The name of a configuration option.
        +
        Throws:
        +
        IllegalArgumentException - If the given configuration does not specify a value for the + given option.
        +
        +
        • +
      + + + +
        +
      • +

        copyOptionFromIfPresent

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder copyOptionFromIfPresent​(Configuration sourceConfig,
+                                                    String option)
        +
        Copy one single option from another Configuration instance, overwriting the value in this + builder, if it is already set. If the given Configuration instance does not have a value for + this option, nothing is changed. + +

        It is better to use this method instead of + setOption(option, oldConfig.getProperty(option)), because it retains the mapping to the + source of this value, which allows better error messages and resolving relative file paths.

        +
        +
        Parameters:
        +
        sourceConfig - A configuration instance.
        +
        option - The name of a configuration option.
        +
        +
        • +
      + + + +
        +
      • +

        loadFromSource

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder loadFromSource​(CharSource source,
+                                           String basePath,
+                                           String sourceName)
+                                    throws IOException,
+                                           InvalidConfigurationException
        +
        Load options from a CharSource with a "key = value" format. + +

        A stream from this source is opened and closed by this method. This method may additionally + access more files from the file system if they are included.

        +
        +
        Parameters:
        +
        source - The source to read from.
        +
        basePath - The directory where relative #include directives should be based on.
        +
        sourceName - A string to use as source of the file in error messages or for other uses by + the TypeConverter. This needs to be convertible into a Path.
        +
        Throws:
        +
        IOException - If the stream cannot be read.
        +
        InvalidConfigurationException - If the stream contains an invalid format.
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        loadFromResource

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder loadFromResource​(Class<?> contextClass,
+                                             String resourceName)
        +
        Load options from a class-loader resource with a "key = value" format. + +

        There must not be any #include directives in the resource.

        +
        +
        Parameters:
        +
        contextClass - The class to use for looking up the resource.
        +
        resourceName - The name of the resource relative to contextClass.
        +
        Throws:
        +
        IllegalArgumentException - If the resource cannot be found or read, or contains invalid + syntax or #include directives.
        +
        +
        • +
      + + + +
        +
      • +

        addConverter

        +
        @CanIgnoreReturnValue
+public ConfigurationBuilder addConverter​(Class<?> cls,
+                                         TypeConverter converter)
        +
        Add a type converter for options with a certain type. This will enable the Configuration + instance to parse strings into values of the given type and inject them just as the base option + types. + +

        As an alternative, the type of an option detail annotation (OptionDetailAnnotation) + can be given. In this case, the type converter will be called for options annotated with this + type. + +

        Previous type converters for the same type will be overwritten (this also works for types + usually handled by the Configuration class, however not for collection and array types). + +

        The same converter may be used for several types.

        +
        +
        Parameters:
        +
        cls - The type the type converter handles.
        +
        converter - A converter instance.
        +
        Returns:
        +
        this
        +
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/FileOption.Type.html b/api/org/sosy_lab/common/configuration/FileOption.Type.html new file mode 100644 index 000000000..2c06e8b9a --- /dev/null +++ b/api/org/sosy_lab/common/configuration/FileOption.Type.html @@ -0,0 +1,423 @@ + + + + + +FileOption.Type (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Enum FileOption.Type

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        REQUIRED_INPUT_FILE

        +
        public static final FileOption.Type REQUIRED_INPUT_FILE
        +
        The file specified with this option is a required input file (a non-existing file will be + considered an invalid configuration).
        +
        • +
      + + + +
        +
      • +

        OPTIONAL_INPUT_FILE

        +
        public static final FileOption.Type OPTIONAL_INPUT_FILE
        +
        The file specified with this option is a file (i.e., no directory), but it needs not exist.
        +
        • +
      + + + +
        +
      • +

        OUTPUT_FILE

        +
        public static final FileOption.Type OUTPUT_FILE
        +
        The file specified with this option will be created by the tool. I doesn't matter whether + this file already exists, but it may not be a directory.
        +
        • +
      + + + +
        +
      • +

        OUTPUT_DIRECTORY

        +
        public static final FileOption.Type OUTPUT_DIRECTORY
        +
        The directory specified with this option will be created by the tool. I doesn't matter + whether this directory already exists, but it may not be a file.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static FileOption.Type[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (FileOption.Type c : FileOption.Type.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static FileOption.Type valueOf​(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/FileOption.html b/api/org/sosy_lab/common/configuration/FileOption.html new file mode 100644 index 000000000..e0a0c03d4 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/FileOption.html @@ -0,0 +1,249 @@ + + + + + +FileOption (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type FileOption

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      FileOption.Typevalue +
      More details for file options.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    + +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/IntegerOption.html b/api/org/sosy_lab/common/configuration/IntegerOption.html new file mode 100644 index 000000000..480f56bed --- /dev/null +++ b/api/org/sosy_lab/common/configuration/IntegerOption.html @@ -0,0 +1,280 @@ + + + + + +IntegerOption (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type IntegerOption

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      longmax +
      An optional maximum value for this option.
      +
      longmin +
      An optional minimum value for this option.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        min

        +
        long min
        +
        An optional minimum value for this option.
        +
        +
        Default:
        +
        -9223372036854775808L
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        max

        +
        long max
        +
        An optional maximum value for this option.
        +
        +
        Default:
        +
        9223372036854775807L
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/InvalidConfigurationException.html b/api/org/sosy_lab/common/configuration/InvalidConfigurationException.html new file mode 100644 index 000000000..acce2dd41 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/InvalidConfigurationException.html @@ -0,0 +1,308 @@ + + + + + +InvalidConfigurationException (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class InvalidConfigurationException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable
    +
    +
    +
    public class InvalidConfigurationException
+extends Exception
    +
    Exception class to signal that something is wrong in the user-specified configuration.
    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        InvalidConfigurationException

        +
        public InvalidConfigurationException​(String msg)
        +
        • +
      + + + +
        +
      • +

        InvalidConfigurationException

        +
        public InvalidConfigurationException​(String msg,
+                                     Throwable source)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/Option.html b/api/org/sosy_lab/common/configuration/Option.html new file mode 100644 index 000000000..0d4256223 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/Option.html @@ -0,0 +1,500 @@ + + + + + +Option (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type Option

+
+
+
+
    +
  • +
    +
    @Documented
+@Retention(RUNTIME)
+@Target({FIELD,METHOD})
+public @interface Option
    +
    An annotation to mark fields or methods which should get configuration values injected. Such a + field or method must be contained in a class annotated with Options. + +

    While it is possible to mark final fields with this annotation, the java documentation says + that the behavior of setting final fields will be undetermined. It might happen that some parts + of the code do not see the new value. + +

    It is possible to mark private fields with this annotation, all access modifiers will be + ignored when setting the value. + +

    If a method is marked with this annotation, it has to have exactly one parameter. An result + value would be ignored, so the method should by of type void. If the method throws an IllegalArgumentException, the configuration will be rejected as invalid. If the method throws + any other exception, the behavior is undefined (so it should not throw any other exception!). + +

    If an option is not present in the configuration file, the corresponding field is not touched. + Similarly, a corresponding method is not called. + +

    It is possible to specify one option more than once, both for fields and methods. All of the + fields will be set and all of the methods will be called.

    +
    +
    See Also:
    +
    Configuration
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      Stringdescription +
      A text that describes the current option (this will be part of the user documentation).
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      StringdeprecatedName +
      When the option needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config.
      +
      Stringname +
      An optional name for the option as it appears in the configuration file.
      +
      Stringregexp +
      If regexp is specified, the value of this option (prior to conversion to the correct type) will + be checked against this regular expression.
      +
      booleanrequired +
      An optional flag if this option needs to be specified in the configuration file.
      +
      booleansecure +
      An optional flag that this configuration option is secure, i.e., setting it to an arbitrary + attacker-controlled value may not allow any harm (like abitrary code execution).
      +
      booleantoUppercase +
      An optional flag that specifies if a configuration value should be converted to upper case + after it was read.
      +
      String[]values +
      If values is non-empty, the value of this option (prior to conversion to the correct type) will + be checked if it is listed in this array.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        description

        +
        String description
        +
        A text that describes the current option (this will be part of the user documentation).
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +
        +
      • +

        name

        +
        String name
        +
        An optional name for the option as it appears in the configuration file. If not specified, the + name of the field will be used. In both cases it will be prefixed with the prefix specified in + the Options annotation (if given).
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        deprecatedName

        +
        String deprecatedName
        +
        When the option needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config. In that case, the previous name can be moved to the + field deprecatedName. Both normal and deprecated name would work, with latter printing + the deprecation warning. + +

        Note that this field only works if the Options annotations on the class defines a + Options.deprecatedPrefix() and only with that deprecated prefix. The combination of the + current prefix and the deprecated option name will not work. + +

        Furthermore, if a deprecated option name is defined, only the combinations "current prefix + + current option name" and "deprecated prefix + deprecated option name" will work. + +

        Summary what works if Options.deprecatedPrefix() is set: + +

          +
        • If deprecated option name is set, then "current prefix + current option name" and + "deprecated prefix + deprecated option name" work. +
        • If deprecated option name is not set, then "current prefix + current option name" and + "deprecated prefix + current option name" work. +
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        secure

        +
        boolean secure
        +
        An optional flag that this configuration option is secure, i.e., setting it to an arbitrary + attacker-controlled value may not allow any harm (like abitrary code execution).
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        required

        +
        boolean required
        +
        An optional flag if this option needs to be specified in the configuration file. The default is + false. If set to true, an exception will be thrown if the option is not in the file.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        toUppercase

        +
        boolean toUppercase
        +
        An optional flag that specifies if a configuration value should be converted to upper case + after it was read. For options with enum types, this flag is always assumed to be true.
        +
        +
        Default:
        +
        false
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        regexp

        +
        String regexp
        +
        If regexp is specified, the value of this option (prior to conversion to the correct type) will + be checked against this regular expression. If it does not match, an exception will be thrown.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        values

        +
        String[] values
        +
        If values is non-empty, the value of this option (prior to conversion to the correct type) will + be checked if it is listed in this array. If it is not contained, an exception will be thrown.
        +
        +
        Default:
        +
        {}
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/OptionAnnotationProcessor.html b/api/org/sosy_lab/common/configuration/OptionAnnotationProcessor.html new file mode 100644 index 000000000..2d5de88be --- /dev/null +++ b/api/org/sosy_lab/common/configuration/OptionAnnotationProcessor.html @@ -0,0 +1,402 @@ + + + + + +OptionAnnotationProcessor (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class OptionAnnotationProcessor

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Processor
    +
    +
    +
    @SupportedAnnotationTypes("org.sosy_lab.common.configuration.*")
+@AutoService(javax.annotation.processing.Processor.class)
+public class OptionAnnotationProcessor
+extends AbstractProcessor
    +
    Annotation processor for checking constraints on Option and Options annotations. + The compiler uses this class during compilation, and we can report compiler errors and warnings. + +

    When reporting warnings, it honors the SuppressWarnings annotation either with a value + of "all" or "options". + +

    This class needs to be public and have a public no-arg constructor. However, it is not + intended for clients usage.

    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/OptionCollector.html b/api/org/sosy_lab/common/configuration/OptionCollector.html new file mode 100644 index 000000000..a17ce4eca --- /dev/null +++ b/api/org/sosy_lab/common/configuration/OptionCollector.html @@ -0,0 +1,302 @@ + + + + + +OptionCollector (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Class OptionCollector

+
+
+ +
+
    +
  • +
    +
    public final class OptionCollector
+extends Object
    +
    This class collects all Options of a program.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        main

        +
        public static void main​(String[] args)
        +
        The main-method collects all classes of a program and then it searches for all Options.
        +
        +
        Parameters:
        +
        args - use '-v' for verbose output
        +
        +
        • +
      + + + +
        +
      • +

        collectOptions

        +
        public static void collectOptions​(boolean verbose,
+                                  boolean includeLibraryOptions,
+                                  PrintStream out)
        +
        This function collects options from all classes and outputs them. Error message are written to + System.err.
        +
        +
        Parameters:
        +
        verbose - short or long output?
        +
        includeLibraryOptions - whether options defined by libraries on the classpath should be + included
        +
        out - the output target
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/OptionDetailAnnotation.html b/api/org/sosy_lab/common/configuration/OptionDetailAnnotation.html new file mode 100644 index 000000000..66bc1363b --- /dev/null +++ b/api/org/sosy_lab/common/configuration/OptionDetailAnnotation.html @@ -0,0 +1,249 @@ + + + + + +OptionDetailAnnotation (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type OptionDetailAnnotation

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      Class<?>[]applicableTo +
      The annotation is applicable to configuration of these types.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        applicableTo

        +
        Class<?>[] applicableTo
        +
        The annotation is applicable to configuration of these types. If a wrapper class of a primitive + type is added here, the annotation automatically is also applicable to the corresponding + primitive type. Otherwise types have to match exactly, i.e., no sub-types and super types.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/Options.html b/api/org/sosy_lab/common/configuration/Options.html new file mode 100644 index 000000000..5d131b442 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/Options.html @@ -0,0 +1,318 @@ + + + + + +Options (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type Options

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      StringdeprecatedPrefix +
      When the prefix needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config.
      +
      Stringdescription +
      An optional text, that describes the current options.
      +
      Stringprefix +
      An optional prefix for all configuration options of the class annotated with this type.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        prefix

        +
        String prefix
        +
        An optional prefix for all configuration options of the class annotated with this type. Prefix + and name of the option will be separated by a dot.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        deprecatedPrefix

        +
        String deprecatedPrefix
        +
        When the prefix needs to be renamed, often it is desirable to maintain the backwards + compatibility with the previous config. In that case, the previous prefix can be moved to the + field deprecatedPrefix. Both normal and deprecated prefixes would work, with latter + printing the deprecation warning. + +

        However, note that if a Option.deprecatedName() is defined for an option, then the + deprecated prefix works only in combination with that deprecated name. + +

        Summary what works if a deprecated prefix is set: + +

          +
        • If Option.deprecatedName() is set, then "current prefix + current option name" + and "deprecated prefix + deprecated option name" work. +
        • If dOption.deprecatedName() is not set, then "current prefix + current option + name" and "deprecated prefix + current option name" work. +
        +
        +
        Default:
        +
        "<NO_DEPRECATION>"
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        description

        +
        String description
        +
        An optional text, that describes the current options.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/TimeSpanOption.html b/api/org/sosy_lab/common/configuration/TimeSpanOption.html new file mode 100644 index 000000000..bd4d896e3 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/TimeSpanOption.html @@ -0,0 +1,349 @@ + + + + + +TimeSpanOption (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration
+

Annotation Type TimeSpanOption

+
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Required Element Summary

      + + + + + + + + + + + + +
      Required Elements 
      Modifier and TypeRequired ElementDescription
      TimeUnitcodeUnit +
      The unit which will be used to write the value from the user into the annotated field if the + field is of type int or long.
      +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional ElementDescription
      TimeUnitdefaultUserUnit +
      The unit which should be assumed when the user does not explicitly specify a unit.
      +
      longmax +
      An optional maximum value for this option.
      +
      longmin +
      An optional minimum value for this option.
      +
      +
      • +
    +
    +
    • +
+
+
+
    +
  • + +
    +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        codeUnit

        +
        TimeUnit codeUnit
        +
        The unit which will be used to write the value from the user into the annotated field if the + field is of type int or long. This is also the unit of the default value of this option (if one + is given), and of the minimum and maximum value!
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +
        +
      • +

        defaultUserUnit

        +
        TimeUnit defaultUserUnit
        +
        The unit which should be assumed when the user does not explicitly specify a unit.
        +
        +
        Default:
        +
        java.util.concurrent.TimeUnit.SECONDS
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        min

        +
        long min
        +
        An optional minimum value for this option. The unit of the minimum is codeUnit().
        +
        +
        Default:
        +
        -9223372036854775808L
        +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + + +
        +
      • +

        max

        +
        long max
        +
        An optional maximum value for this option. The unit of the maximum is codeUnit().
        +
        +
        Default:
        +
        9223372036854775807L
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/converters/BaseTypeConverter.html b/api/org/sosy_lab/common/configuration/converters/BaseTypeConverter.html new file mode 100644 index 000000000..12400c66a --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/BaseTypeConverter.html @@ -0,0 +1,483 @@ + + + + + +BaseTypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Enum BaseTypeConverter

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static BaseTypeConverter[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (BaseTypeConverter c : BaseTypeConverter.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static BaseTypeConverter valueOf​(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        convert

        +
        public Object convert​(String optionName,
+                      String valueStr,
+                      TypeToken<?> pType,
+                      Annotation pSecondaryOption,
+                      Path pSource,
+                      LogManager logger)
+               throws InvalidConfigurationException
        +
        Description copied from interface: TypeConverter
        +
        Convert a String given by the user to an instance of a given type. + +

        Although the signature of this method does not enforce it, the class of the returned value + needs to be assignable to "type" as defined by TypeToken.isSupertypeOf(java.lang.reflect.Type). + +

        Before this method is called, the caller ensures that all requirements for the option + defined with the Option annotation are met.

        +
        +
        Specified by:
        +
        convert in interface TypeConverter
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        valueStr - The string to parse.
        +
        pType - The target type.
        +
        pSecondaryOption - An optional second annotation for the option (this is one of the + annotations marked with OptionDetailAnnotation).
        +
        pSource - The file where the configuration option was read from. May contain a dummy value + or null if the option was given somehow else.
        +
        logger - A logger for warnings etc.
        +
        Returns:
        +
        An instance of the target type produced from the string representation-
        +
        Throws:
        +
        InvalidConfigurationException - If the user specified an invalid value.
        +
        +
        • +
      + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/converters/ClassTypeConverter.html b/api/org/sosy_lab/common/configuration/converters/ClassTypeConverter.html new file mode 100644 index 000000000..d2c66cc3e --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/ClassTypeConverter.html @@ -0,0 +1,355 @@ + + + + + +ClassTypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Class ClassTypeConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.converters.ClassTypeConverter
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ClassTypeConverter

        +
        public ClassTypeConverter()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convert

        +
        public Object convert​(String optionName,
+                      String value,
+                      TypeToken<?> type,
+                      Annotation secondaryOption,
+                      Path pSource,
+                      LogManager logger)
+               throws InvalidConfigurationException
        +
        Description copied from interface: TypeConverter
        +
        Convert a String given by the user to an instance of a given type. + +

        Although the signature of this method does not enforce it, the class of the returned value + needs to be assignable to "type" as defined by TypeToken.isSupertypeOf(java.lang.reflect.Type). + +

        Before this method is called, the caller ensures that all requirements for the option + defined with the Option annotation are met.

        +
        +
        Specified by:
        +
        convert in interface TypeConverter
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        value - The string to parse.
        +
        type - The target type.
        +
        secondaryOption - An optional second annotation for the option (this is one of the + annotations marked with OptionDetailAnnotation).
        +
        pSource - The file where the configuration option was read from. May contain a dummy value + or null if the option was given somehow else.
        +
        logger - A logger for warnings etc.
        +
        Returns:
        +
        An instance of the target type produced from the string representation-
        +
        Throws:
        +
        InvalidConfigurationException - If the user specified an invalid value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/converters/FileTypeConverter.html b/api/org/sosy_lab/common/configuration/converters/FileTypeConverter.html new file mode 100644 index 000000000..28d7c5999 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/FileTypeConverter.html @@ -0,0 +1,512 @@ + + + + + +FileTypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Class FileTypeConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.converters.FileTypeConverter
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    TypeConverter
    +
    +
    +
    public final class FileTypeConverter
+extends Object
+implements TypeConverter
    +
    A TypeConverter for options of type File or Path which offers some + additional features like a common base directory for all output files. In order to use these + features, the options need to be annotated with FileOption. + +

    This type converter should be registered for the type FileOption. + +

    The additional features are: + +

      +
    • All specified relative paths are resolved against a given root directory. +
    • All relative paths of output files are resolved against a separate output directory. +
    • All output files can be disabled by a central switch. +
    + +

    In order to configure these features, the normal configuration options are used.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/converters/IntegerTypeConverter.html b/api/org/sosy_lab/common/configuration/converters/IntegerTypeConverter.html new file mode 100644 index 000000000..c9d87ddd5 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/IntegerTypeConverter.html @@ -0,0 +1,357 @@ + + + + + +IntegerTypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Class IntegerTypeConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.converters.IntegerTypeConverter
      • +
    +
    • +
+
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    TypeConverter
    +
    +
    +
    public class IntegerTypeConverter
+extends Object
+implements TypeConverter
    +
    Type converter for options of types Integer/Long annotated with IntegerOption (not for + integer options without this annotation).
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IntegerTypeConverter

        +
        public IntegerTypeConverter()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convert

        +
        public Object convert​(String optionName,
+                      String valueStr,
+                      TypeToken<?> pType,
+                      Annotation pOption,
+                      Path pSource,
+                      LogManager logger)
+               throws InvalidConfigurationException
        +
        Description copied from interface: TypeConverter
        +
        Convert a String given by the user to an instance of a given type. + +

        Although the signature of this method does not enforce it, the class of the returned value + needs to be assignable to "type" as defined by TypeToken.isSupertypeOf(java.lang.reflect.Type). + +

        Before this method is called, the caller ensures that all requirements for the option + defined with the Option annotation are met.

        +
        +
        Specified by:
        +
        convert in interface TypeConverter
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        valueStr - The string to parse.
        +
        pType - The target type.
        +
        pOption - An optional second annotation for the option (this is one of the + annotations marked with OptionDetailAnnotation).
        +
        pSource - The file where the configuration option was read from. May contain a dummy value + or null if the option was given somehow else.
        +
        logger - A logger for warnings etc.
        +
        Returns:
        +
        An instance of the target type produced from the string representation-
        +
        Throws:
        +
        InvalidConfigurationException - If the user specified an invalid value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/converters/TimeSpanTypeConverter.html b/api/org/sosy_lab/common/configuration/converters/TimeSpanTypeConverter.html new file mode 100644 index 000000000..0a0dd08a2 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/TimeSpanTypeConverter.html @@ -0,0 +1,356 @@ + + + + + +TimeSpanTypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Class TimeSpanTypeConverter

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.configuration.converters.TimeSpanTypeConverter
      • +
    +
    • +
+
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TimeSpanTypeConverter

        +
        public TimeSpanTypeConverter()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convert

        +
        public Object convert​(String optionName,
+                      String valueStr,
+                      TypeToken<?> pType,
+                      Annotation pOption,
+                      Path pSource,
+                      LogManager logger)
+               throws InvalidConfigurationException
        +
        Description copied from interface: TypeConverter
        +
        Convert a String given by the user to an instance of a given type. + +

        Although the signature of this method does not enforce it, the class of the returned value + needs to be assignable to "type" as defined by TypeToken.isSupertypeOf(java.lang.reflect.Type). + +

        Before this method is called, the caller ensures that all requirements for the option + defined with the Option annotation are met.

        +
        +
        Specified by:
        +
        convert in interface TypeConverter
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        valueStr - The string to parse.
        +
        pType - The target type.
        +
        pOption - An optional second annotation for the option (this is one of the + annotations marked with OptionDetailAnnotation).
        +
        pSource - The file where the configuration option was read from. May contain a dummy value + or null if the option was given somehow else.
        +
        logger - A logger for warnings etc.
        +
        Returns:
        +
        An instance of the target type produced from the string representation-
        +
        Throws:
        +
        InvalidConfigurationException - If the user specified an invalid value.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/configuration/converters/TypeConverter.html b/api/org/sosy_lab/common/configuration/converters/TypeConverter.html new file mode 100644 index 000000000..26f31a75b --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/TypeConverter.html @@ -0,0 +1,410 @@ + + + + + +TypeConverter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.configuration.converters
+

Interface TypeConverter

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    BaseTypeConverter, ClassTypeConverter, FileTypeConverter, IntegerTypeConverter, TimeSpanTypeConverter
    +
    +
    +
    public interface TypeConverter
    +
    TypeConverters are used to parse Strings into instances of specific types during configuration + option injection as performed by Configuration.inject(Object). Each type converter may + handle one or more types. + +

    TypeConverters need not to be thread safe as long as no injection is performed in parallel, + however, they should have no mutable state anyway. + +

    Primitive types will be converted into their corresponding wrapper type before any type + converter is called, so they do not need to care at all about primitive types.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        convert

        +
        @Nullable Object convert​(String optionName,
+                         String value,
+                         TypeToken<?> type,
+                         @Nullable Annotation secondaryOption,
+                         @Nullable Path source,
+                         LogManager logger)
+                  throws InvalidConfigurationException
        +
        Convert a String given by the user to an instance of a given type. + +

        Although the signature of this method does not enforce it, the class of the returned value + needs to be assignable to "type" as defined by TypeToken.isSupertypeOf(java.lang.reflect.Type). + +

        Before this method is called, the caller ensures that all requirements for the option + defined with the Option annotation are met.

        +
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        value - The string to parse.
        +
        type - The target type.
        +
        secondaryOption - An optional second annotation for the option (this is one of the + annotations marked with OptionDetailAnnotation).
        +
        source - The file where the configuration option was read from. May contain a dummy value + or null if the option was given somehow else.
        +
        logger - A logger for warnings etc.
        +
        Returns:
        +
        An instance of the target type produced from the string representation-
        +
        Throws:
        +
        UnsupportedOperationException - If the option specification in the source code is invalid + (e.g., a missing annotation).
        +
        InvalidConfigurationException - If the user specified an invalid value.
        +
        +
        • +
      + + + + + +
        +
      • +

        convertDefaultValue

        +
        default <T> @Nullable T convertDefaultValue​(String optionName,
+                                            @Nullable T value,
+                                            TypeToken<T> type,
+                                            @Nullable Annotation secondaryOption)
+                                     throws InvalidConfigurationException
        +
        Optionally convert the default value for an option that was given in the source code. This + method is called if the user gave no explicit value.
        +
        +
        Parameters:
        +
        optionName - The name of the option (should only be used for nice error messages).
        +
        value - The default value (may be null).
        +
        type - The target type.
        +
        secondaryOption - An optional second annotation for the option
        +
        Returns:
        +
        An instance of the target type.
        +
        Throws:
        +
        InvalidConfigurationException - If the default value is invalid for this option.
        +
        UnsupportedOperationException - If the option specification in the source code is invalid + (e.g., a missing annotation).
        +
        +
        • +
      + + + + + + + + + +
        +
      • +

        getInstanceForNewConfiguration

        +
        default TypeConverter getInstanceForNewConfiguration​(Configuration newConfiguration)
+                                              throws InvalidConfigurationException
        +
        Return a (possibly) new instance of this converter that has new configuration values applied. + +

        If this converter has configuration options itself, it may be desired to use new values for + these options if the converter instance is used together with a new Configuration + instance. This method is called whenever an existing converter instance will be used by a new + Configuration instance, e.g., by ConfigurationBuilder.copyFrom(Configuration) or if the + converter instance is taken from Configuration.getDefaultConverters(). It can return a + new converter instance according to the options in the new Configuration instance, or + return the current converter instance. Note that this method should not change the existing + instance.

        +
        +
        Parameters:
        +
        newConfiguration - The new configuration instance which will use the returned converter
        +
        Returns:
        +
        A new instance of the same converter, or this
        +
        Throws:
        +
        InvalidConfigurationException - If applying the new configuration fails
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/converters/package-summary.html b/api/org/sosy_lab/common/configuration/converters/package-summary.html new file mode 100644 index 000000000..9b30c915c --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/package-summary.html @@ -0,0 +1,235 @@ + + + + + +org.sosy_lab.common.configuration.converters (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.configuration.converters

+
+
+
+ + +
This package provides the possibility to convert String values into appropriate objects of + certain types. This is used by the Configuration class + to convert configuration options into objects before injecting them. The primary interface is + TypeConverter, and some default + implementations for commonly-used classes are also provided.
+
+ +
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/converters/package-tree.html b/api/org/sosy_lab/common/configuration/converters/package-tree.html new file mode 100644 index 000000000..a557f4fa0 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/converters/package-tree.html @@ -0,0 +1,185 @@ + + + + + +org.sosy_lab.common.configuration.converters Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.configuration.converters

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/configuration/package-summary.html b/api/org/sosy_lab/common/configuration/package-summary.html new file mode 100644 index 000000000..214decec5 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/package-summary.html @@ -0,0 +1,345 @@ + + + + + +org.sosy_lab.common.configuration (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.configuration

+
+
+
+ + +
Java-Config is a library for injecting configuration options in a decentralized way. + +

Configuration objects can be generated either from + .properties configuration files, or from command line options. The usability is geared + towards configuration files, but command line generation is also supported. + +

The library is conceptually similar to GFlags + and allows arbitrary option injection throughout used classes. + +

Annotating classes with options + +

The example below demonstrates defining options for a class: + + 

+ 
+ @Options(prefix="grep")
+ public class Grep {
+   @Option(description="Ignore case of the query", secure=true)
+   private boolean ignoreCase = false;
+
+   @Option(description="File to search", secure=true)
+   @FileOption(Type.REQUIRED_INPUT_FILE)
+   private PathCounterTemplate haystack = null;
+
+   public Grep(Configuration c) {
+     c.inject(this);
+   }
+
+   public boolean search(String needle) {
+      // ... search for a needle in a haystack.
+   }
+ 
+
+ +

Note the following features: + +

    +
  • @Option annotations are used to define various options associated with a + class. Options are decentralized, the only requirement is that the Configuration object is injected (preferably in the + constructor). +
  • The fields defining options can be private. The injector contains reflection calls to set + them to the arbitrary file. +
  • Normally, the type of the option is defined by the type of the field. For complex + cases (e.g. files) additional decorators are used. +
  • Option name is either derived from the field name (prefixed with a base prefix), + or set explicitly in the Option annotation. +
+ +

Configuration options instance can be constructed in three different ways: + +

+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    AnnotatedValue<T> +
    Immutable container that stores a value and an optional string.
    +
    Configuration +
    Immutable wrapper around a map with properties, providing useful access helper methods.
    +
    ConfigurationBuilder +
    Interface for constructing Configuration instances.
    +
    OptionAnnotationProcessor +
    Annotation processor for checking constraints on Option and Options annotations.
    +
    OptionCollector +
    This class collects all Options of a program.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    FileOption.Type 
    +
    • +
  • + + + + + + + + + + + + +
    Exception Summary 
    ExceptionDescription
    InvalidConfigurationException +
    Exception class to signal that something is wrong in the user-specified configuration.
    +
    +
    • +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Annotation Types Summary 
    Annotation TypeDescription
    ClassOption +
    This is an optional annotation for all configuration options (i.e., elements that are annotated + with Option) whose type is Class.
    +
    FileOption +
    This is an annotation providing more features for options of types File and Path.
    +
    IntegerOption +
    This is an optional annotation for all configuration options (i.e., elements that are annotated + with Option) whose type is an integer number (i.e., int, long, Integer and Long):
    +
    Option +
    An annotation to mark fields or methods which should get configuration values injected.
    +
    OptionDetailAnnotation +
    This is a meta annotation that marks other annotation which may be used in conjunction with + Option to provide more information for a specific option type.
    +
    Options +
    Annotation for a class which has fields or methods with an Option annotation.
    +
    TimeSpanOption +
    This is an annotation for all integer options that specify some sort of time duration (e.g., a + timeout).
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/configuration/package-tree.html b/api/org/sosy_lab/common/configuration/package-tree.html new file mode 100644 index 000000000..715ee6b33 --- /dev/null +++ b/api/org/sosy_lab/common/configuration/package-tree.html @@ -0,0 +1,205 @@ + + + + + +org.sosy_lab.common.configuration Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.configuration

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Annotation Type Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/io/DuplicateOutputStream.html b/api/org/sosy_lab/common/io/DuplicateOutputStream.html new file mode 100644 index 000000000..d9dffce27 --- /dev/null +++ b/api/org/sosy_lab/common/io/DuplicateOutputStream.html @@ -0,0 +1,446 @@ + + + + + +DuplicateOutputStream (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class DuplicateOutputStream

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Closeable, Flushable, AutoCloseable
    +
    +
    +
    public class DuplicateOutputStream
+extends OutputStream
    +
    This class is an OutputStream implementation that sends everything to two other OutputStreams. + +

    Exceptions thrown by any of the streams will be relayed to the caller.

    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/io/IO.html b/api/org/sosy_lab/common/io/IO.html new file mode 100644 index 000000000..381f810d5 --- /dev/null +++ b/api/org/sosy_lab/common/io/IO.html @@ -0,0 +1,491 @@ + + + + + +IO (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class IO

+
+
+ +
+
    +
  • +
    +
    public final class IO
+extends Object
    +
    Provides helper functions for file access, in addition to Files and MoreFiles.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getNativeCharset

        +
        public static Charset getNativeCharset()
        +
        Return the Charset that is used by the underlying platform, i.e., configured as the OS + default. On modern systems this is typically Charsets.UTF_8 with the exception of + Windows. + +

        The native encoding should typically used when outputting something to the console (which is + handled by Java automatically) and is also the common agreement when processes are + communicating via pipes, i.e., for Process.getInputStream(), Process.getOutputStream(), and Process.getErrorStream(). + +

        Note that Java 17 also provides Console#charset() which should always return the + same value, this method is a convenience method for simplifying code that has to work with both + old and new Java versions. + +

        Before Java 18 the method Charset.defaultCharset() also returns the native charset, + but it was changed to return UTF-8 in Java 18. + +

        If the charset of the JVM is overwritten by setting some system properties like + file.encoding this method may return the specified charset instead of the "real" native + charset (just like Charset.defaultCharset() already did). + +

        More information can be found in JEP 400.

        +
        • +
      + + + +
        +
      • +

        mayUseColorForOutput

        +
        public static boolean mayUseColorForOutput()
        +
        Determine whether it is advisable to use color (via escape sequences) for output on + stdout/stderr. This method checks for output redirection, the OS, and the NO_COLOR environment + variable.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        writeFile

        +
        public static void writeFile​(Path file,
+                             Charset charset,
+                             Object content)
+                      throws IOException
        +
        Writes content to a file.
        +
        +
        Parameters:
        +
        file - The file.
        +
        content - The content which shall be written.
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        writeGZIPFile

        +
        public static void writeGZIPFile​(Path file,
+                                 Charset charset,
+                                 Object content)
+                          throws IOException
        +
        Writes content to a file compressed in GZIP format.
        +
        +
        Parameters:
        +
        file - The file.
        +
        content - The content which shall be written.
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        openOutputFile

        +
        public static Writer openOutputFile​(Path file,
+                                    Charset charset,
+                                    OpenOption... options)
+                             throws IOException
        +
        Open a buffered Writer to a file. This method creates necessary parent directories beforehand.
        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        appendToFile

        +
        public static void appendToFile​(Path file,
+                                Charset charset,
+                                Object content)
+                         throws IOException
        +
        Appends content to a file (without overwriting the file, but creating it if necessary).
        +
        +
        Parameters:
        +
        file - The file.
        +
        content - The content which will be written to the end of the file.
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        checkReadableFile

        +
        public static void checkReadableFile​(Path path)
+                              throws FileNotFoundException
        +
        Verifies if a file exists, is a normal file and is readable. If this is not the case, a + FileNotFoundException with a nice message is thrown.
        +
        +
        Parameters:
        +
        path - The file to check.
        +
        Throws:
        +
        FileNotFoundException - If one of the conditions is not true.
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/MoreFiles.DeleteOnCloseFile.html b/api/org/sosy_lab/common/io/MoreFiles.DeleteOnCloseFile.html new file mode 100644 index 000000000..783cc7dc7 --- /dev/null +++ b/api/org/sosy_lab/common/io/MoreFiles.DeleteOnCloseFile.html @@ -0,0 +1,311 @@ + + + + + +MoreFiles.DeleteOnCloseFile (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class MoreFiles.DeleteOnCloseFile

+
+
+
    +
  • java.lang.Object
    • +
  • +
      +
    • org.sosy_lab.common.io.MoreFiles.DeleteOnCloseFile
      • +
    +
    • +
+
+ +
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/MoreFiles.html b/api/org/sosy_lab/common/io/MoreFiles.html new file mode 100644 index 000000000..a1f9c68cd --- /dev/null +++ b/api/org/sosy_lab/common/io/MoreFiles.html @@ -0,0 +1,681 @@ + + + + + +MoreFiles (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class MoreFiles

+
+
+ +
+
    +
  • +
    +
    @Deprecated
+public final class MoreFiles
+extends Object
    +
    Deprecated.
    +
    Provides helper functions for file access.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/PathCounterTemplate.html b/api/org/sosy_lab/common/io/PathCounterTemplate.html new file mode 100644 index 000000000..29df4acdb --- /dev/null +++ b/api/org/sosy_lab/common/io/PathCounterTemplate.html @@ -0,0 +1,333 @@ + + + + + +PathCounterTemplate (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class PathCounterTemplate

+
+
+ +
+
    +
  • +
    +
    public final class PathCounterTemplate
+extends Object
    +
    A template for Path objects that uses a counter to produce paths with a fresh new name + for every request.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getFreshPath

        +
        public Path getFreshPath()
        +
        Construct a concrete Path that was not handed out by this instance before.
        +
        +
        Throws:
        +
        IllegalFormatException - If the template is invalid, or the arguments does not match the + template.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplate

        +
        public String getTemplate()
        +
        Returns the raw template of this instance.
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/PathTemplate.html b/api/org/sosy_lab/common/io/PathTemplate.html new file mode 100644 index 000000000..df64c8b7b --- /dev/null +++ b/api/org/sosy_lab/common/io/PathTemplate.html @@ -0,0 +1,332 @@ + + + + + +PathTemplate (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class PathTemplate

+
+
+ +
+
    +
  • +
    +
    @Immutable
+public final class PathTemplate
+extends Object
    +
    A template for paths, from which a real path can be constructed by passing some values to fill in + the blanks.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        getPath

        +
        public Path getPath​(Object... args)
        +
        Construct a concrete Path from this template and the given values.
        +
        +
        Throws:
        +
        IllegalFormatException - If the template is invalid, or the arguments does not match the + template.
        +
        +
        • +
      + + + +
        +
      • +

        getTemplate

        +
        public String getTemplate()
        +
        Returns the raw template of this instance.
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseDir.html b/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseDir.html new file mode 100644 index 000000000..e5852485c --- /dev/null +++ b/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseDir.html @@ -0,0 +1,302 @@ + + + + + +TempFile.DeleteOnCloseDir (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class TempFile.DeleteOnCloseDir

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        toPath

        +
        public Path toPath()
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
+           throws IOException
        +
        Recursively delete all files and directories in the directory represented by this instance.
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseFile.html b/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseFile.html new file mode 100644 index 000000000..b665c0983 --- /dev/null +++ b/api/org/sosy_lab/common/io/TempFile.DeleteOnCloseFile.html @@ -0,0 +1,364 @@ + + + + + +TempFile.DeleteOnCloseFile (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class TempFile.DeleteOnCloseFile

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/TempFile.TempFileBuilder.html b/api/org/sosy_lab/common/io/TempFile.TempFileBuilder.html new file mode 100644 index 000000000..724cc894f --- /dev/null +++ b/api/org/sosy_lab/common/io/TempFile.TempFileBuilder.html @@ -0,0 +1,426 @@ + + + + + +TempFile.TempFileBuilder (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class TempFile.TempFileBuilder

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    TempFile
    +
    +
    +
    public static final class TempFile.TempFileBuilder
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        dir

        +
        @CanIgnoreReturnValue
+public TempFile.TempFileBuilder dir​(Path pDir)
        +
        The directory where the file will be created, default is JVM's temp directory.
        +
        • +
      + + + + + + + +
        +
      • +

        suffix

        +
        @CanIgnoreReturnValue
+public TempFile.TempFileBuilder suffix​(String pSuffix)
        +
        Suffix of randomly generated file name, default is .tmp.
        +
        • +
      + + + +
        +
      • +

        initialContent

        +
        @CanIgnoreReturnValue
+public TempFile.TempFileBuilder initialContent​(Object pContent,
+                                               Charset pCharset)
        +
        Content to write to temp file immediately after creation.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        create

        +
        public Path create()
+            throws IOException
        +
        Create a fresh temporary file according to the specifications set on this builder. + +

        If the temporary file should be removed after some specific code is executed, use createDeleteOnClose(). + +

        This instance can be safely used again afterwards.

        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      + + + +
        +
      • +

        createDeleteOnClose

        +
        public TempFile.DeleteOnCloseFile createDeleteOnClose()
+                                               throws IOException
        +
        Create a fresh temporary file according to the specifications set on this builder. + +

        The resulting Path object is wrapped in a TempFile.DeleteOnCloseFile, which deletes + the file as soon as TempFile.DeleteOnCloseFile.close() is called. + +

        It is recommended to use the following pattern: + try (DeleteOnCloseFile tempFile = + TempFile.builder()[.. adjust builder ..].createDeleteOnClose()) { + // use tempFile.toPath() for writing and reading of the temporary file + } + The file can be opened and closed multiple times, potentially from different + processes. + +

        This instance can be safely used again afterwards.

        +
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/TempFile.html b/api/org/sosy_lab/common/io/TempFile.html new file mode 100644 index 000000000..feefaf671 --- /dev/null +++ b/api/org/sosy_lab/common/io/TempFile.html @@ -0,0 +1,345 @@ + + + + + +TempFile (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.io
+

Class TempFile

+
+
+ +
+
    +
  • +
    +
    public final class TempFile
+extends Object
    +
    Utilities for temporary files.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        createDeleteOnCloseDir

        +
        public static TempFile.DeleteOnCloseDir createDeleteOnCloseDir​(String pPrefix,
+                                                               FileAttribute<?>... pFileAttributes)
+                                                        throws IOException
        +
        Create a fresh temporary directory in JVM's temp directory. + +

        The resulting Path object is wrapped in a TempFile.DeleteOnCloseDir, which deletes + the directory recursively including its contents as soon as TempFile.DeleteOnCloseDir.close() is + called. + +

        It is recommended to use the following pattern: + try (DeleteOnCloseDir tempDir = TempFile.createDeleteOnCloseDir()) { + // use tempDir.toPath() to get the Path object denoting the temporary directory + } +

        +
        +
        Parameters:
        +
        pPrefix - The prefix of the randomly-generated directory name.
        +
        pFileAttributes - The FileAttributes used for creating the directory.
        +
        Throws:
        +
        IOException
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/io/package-summary.html b/api/org/sosy_lab/common/io/package-summary.html new file mode 100644 index 000000000..ce387459c --- /dev/null +++ b/api/org/sosy_lab/common/io/package-summary.html @@ -0,0 +1,231 @@ + + + + + +org.sosy_lab.common.io (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.io

+
+
+
+ + +
This package contains utilities for I/O.
+
+ +
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/io/package-tree.html b/api/org/sosy_lab/common/io/package-tree.html new file mode 100644 index 000000000..c2b6b7d30 --- /dev/null +++ b/api/org/sosy_lab/common/io/package-tree.html @@ -0,0 +1,178 @@ + + + + + +org.sosy_lab.common.io Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.io

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/log/BasicLogManager.LogManagerMXBean.html b/api/org/sosy_lab/common/log/BasicLogManager.LogManagerMXBean.html new file mode 100644 index 000000000..400ef17f4 --- /dev/null +++ b/api/org/sosy_lab/common/log/BasicLogManager.LogManagerMXBean.html @@ -0,0 +1,267 @@ + + + + + +BasicLogManager.LogManagerMXBean (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Interface BasicLogManager.LogManagerMXBean

+
+
+
+
    +
  • +
    +
    Enclosing class:
    +
    BasicLogManager
    +
    +
    +
    public static interface BasicLogManager.LogManagerMXBean
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getConsoleLevel

        +
        String getConsoleLevel()
        +
        • +
      + + + +
        +
      • +

        setConsoleLevel

        +
        void setConsoleLevel​(String newLevel)
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/log/BasicLogManager.html b/api/org/sosy_lab/common/log/BasicLogManager.html new file mode 100644 index 000000000..6eac673cd --- /dev/null +++ b/api/org/sosy_lab/common/log/BasicLogManager.html @@ -0,0 +1,846 @@ + + + + + +BasicLogManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class BasicLogManager

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        BasicLogManager

        +
        public BasicLogManager​(Logger pLogger)
        +
        Constructor which allows to customize where this logger delegates to. + +

        The feature of truncating long log messages is disabled.

        +
        +
        Parameters:
        +
        pLogger - The Java logger where this logger delegates to.
        +
        +
        • +
      + + + +
        +
      • +

        BasicLogManager

        +
        public BasicLogManager​(Logger pLogger,
+                       int pTruncateSize)
        +
        Constructor which allows to customize where this logger delegates to.
        +
        +
        Parameters:
        +
        pLogger - The Java logger where this logger delegates to.
        +
        pTruncateSize - A positive integer threshold for truncating long log messages, or 0 to + disable truncation.
        +
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createWithHandler

        +
        public static LogManager createWithHandler​(Handler handler)
        +
        Create a BasicLogManager which delegates to a new logger with only the given Handler.
        +
        +
        Parameters:
        +
        handler - The target handler.
        +
        +
        • +
      + + + + + + + +
        +
      • +

        create

        +
        public static LogManager create​(LoggingOptions options)
        +
        Create a BasicLogManager which logs to a file and the console according to specified + options. + +

        This also adds an MXBean that allows runtime control of some logging options. + +

        Most users will want to use create(Configuration) instead.

        +
        • +
      + + + +
        +
      • +

        withComponentName

        +
        public LogManager withComponentName​(String pName)
        +
        Description copied from interface: LogManager
        +
        Returns a new LogManager instance which may use the given name as an indicator from which + component a log message comes from.
        +
        +
        Specified by:
        +
        withComponentName in interface LogManager
        +
        Parameters:
        +
        pName - A non-empty string.
        +
        Returns:
        +
        A LogManager instance.
        +
        +
        • +
      + + + +
        +
      • +

        wouldBeLogged

        +
        public boolean wouldBeLogged​(Level priority)
        +
        Returns true if a message with the given log level would be logged.
        +
        +
        Specified by:
        +
        wouldBeLogged in interface LogManager
        +
        Parameters:
        +
        priority - the log level
        +
        Returns:
        +
        whether this log level is enabled
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level priority,
+                Object... args)
        +
        Logs any message occurring during program execution. The message is constructed lazily by + concatenating the parts with " ". The caller should not use string concatenation to create the + message in order to increase performance if the message is never logged.
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        args - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level priority,
+                Supplier<String> msgSupplier)
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + asking the provided supplier if necessary.
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        msgSupplier - a supplier for a non-null log message
        +
        +
        • +
      + + + +
        +
      • +

        logf

        +
        public void logf​(Level priority,
+                 String format,
+                 Object... args)
        +
        Logs any message occurring during program execution. The message is constructed lazily from + String.format(format, args).
        +
        +
        Specified by:
        +
        logf in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logUserException

        +
        public void logUserException​(Level priority,
+                             Throwable e,
+                             @Nullable String pAdditionalMessage)
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logUserException in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfUserException

        +
        public void logfUserException​(Level priority,
+                              Throwable e,
+                              String format,
+                              Object... args)
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier). + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logfUserException in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE,
+                              @Nullable String pAdditionalMessage)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable e)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        e - the occurred exception
        +
        +
        • +
      + + + +
        +
      • +

        logfDebugException

        +
        public void logfDebugException​(Throwable e,
+                               String format,
+                               Object... args)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfDebugException in interface LogManager
        +
        Parameters:
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logException

        +
        public void logException​(Level pPriority,
+                         Throwable pE,
+                         @Nullable String pAdditionalMessage)
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable.

        +
        +
        Specified by:
        +
        logException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfException

        +
        public void logfException​(Level priority,
+                          Throwable e,
+                          String format,
+                          Object... args)
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfException in interface LogManager
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        Description copied from interface: LogManager
        +
        Flush all handlers of this logger.
        +
        +
        Specified by:
        +
        flush in interface LogManager
        +
        +
        • +
      + + + +
        +
      • +

        close

        +
        public void close()
        +
        +
        Specified by:
        +
        close in interface AutoCloseable
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/ConsoleLogFormatter.html b/api/org/sosy_lab/common/log/ConsoleLogFormatter.html new file mode 100644 index 000000000..4736c77de --- /dev/null +++ b/api/org/sosy_lab/common/log/ConsoleLogFormatter.html @@ -0,0 +1,397 @@ + + + + + +ConsoleLogFormatter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class ConsoleLogFormatter

+
+
+ +
+
    +
  • +
    +
    public class ConsoleLogFormatter
+extends Formatter
    +
    Class to handle formatting for console output.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/ExtendedLogRecord.html b/api/org/sosy_lab/common/log/ExtendedLogRecord.html new file mode 100644 index 000000000..4a469626f --- /dev/null +++ b/api/org/sosy_lab/common/log/ExtendedLogRecord.html @@ -0,0 +1,360 @@ + + + + + +ExtendedLogRecord (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class ExtendedLogRecord

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ExtendedLogRecord

        +
        public ExtendedLogRecord​(Level pLevel,
+                         @Nullable String pMsg)
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setSourceComponentName

        +
        public void setSourceComponentName​(String pComponentName)
        +
        • +
      + + + +
        +
      • +

        getSourceComponentName

        +
        public String getSourceComponentName()
        +
        • +
      + + + + +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/FileLogFormatter.html b/api/org/sosy_lab/common/log/FileLogFormatter.html new file mode 100644 index 000000000..34ba0740e --- /dev/null +++ b/api/org/sosy_lab/common/log/FileLogFormatter.html @@ -0,0 +1,363 @@ + + + + + +FileLogFormatter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class FileLogFormatter

+
+
+ +
+ +
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/ForwardingLogManager.html b/api/org/sosy_lab/common/log/ForwardingLogManager.html new file mode 100644 index 000000000..fd3d02f4d --- /dev/null +++ b/api/org/sosy_lab/common/log/ForwardingLogManager.html @@ -0,0 +1,713 @@ + + + + + +ForwardingLogManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class ForwardingLogManager

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ForwardingLogManager

        +
        public ForwardingLogManager()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        delegate

        +
        @ForOverride
+protected abstract LogManager delegate()
        +
        • +
      + + + +
        +
      • +

        wouldBeLogged

        +
        public boolean wouldBeLogged​(Level pPriority)
        +
        Description copied from interface: LogManager
        +
        Returns true if a message with the given log level would be logged.
        +
        +
        Specified by:
        +
        wouldBeLogged in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level
        +
        Returns:
        +
        whether this log level is enabled
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Object... pArgs)
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + concatenating the parts with " ". The caller should not use string concatenation to create the + message in order to increase performance if the message is never logged. To make individual + arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pArgs - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Supplier<String> pMsgSupplier)
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + asking the provided supplier if necessary.
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pMsgSupplier - a supplier for a non-null log message
        +
        +
        • +
      + + + +
        +
      • +

        logf

        +
        @FormatMethod
+public void logf​(Level pPriority,
+                 String pFormat,
+                 Object... pArgs)
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily from + String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        logf in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logUserException

        +
        public void logUserException​(Level pPriority,
+                             Throwable pE,
+                             @Nullable String pAdditionalMessage)
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfUserException

        +
        @FormatMethod
+public void logfUserException​(Level pPriority,
+                              Throwable pE,
+                              String pFormat,
+                              Object... pArgs)
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier). + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logfUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE,
+                              @Nullable String pAdditionalMessage)
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfDebugException

        +
        @FormatMethod
+public void logfDebugException​(Throwable pE,
+                               String pFormat,
+                               Object... pArgs)
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE)
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        +
        • +
      + + + +
        +
      • +

        logException

        +
        public void logException​(Level pPriority,
+                         Throwable pE,
+                         @Nullable String pAdditionalMessage)
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable.

        +
        +
        Specified by:
        +
        logException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfException

        +
        @FormatMethod
+public void logfException​(Level pPriority,
+                          Throwable pE,
+                          String pFormat,
+                          Object... pArgs)
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        Description copied from interface: LogManager
        +
        Flush all handlers of this logger.
        +
        +
        Specified by:
        +
        flush in interface LogManager
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/LogManager.html b/api/org/sosy_lab/common/log/LogManager.html new file mode 100644 index 000000000..13b7ab942 --- /dev/null +++ b/api/org/sosy_lab/common/log/LogManager.html @@ -0,0 +1,665 @@ + + + + + +LogManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Interface LogManager

+
+
+
+
    +
  • +
    +
    All Known Implementing Classes:
    +
    BasicLogManager, ForwardingLogManager, LogManagerWithoutDuplicates, NullLogManager, TestLogManager
    +
    +
    +
    public interface LogManager
    +
    Main interface for basic logging framework. + +

    The log levels used are the ones from java.util.logging. SEVERE, WARNING and INFO are used + normally, the first two denoting (among other things) exceptions. FINE, FINER, FINEST, and ALL + correspond to main application, central algorithm, component level, and debug level respectively. + +

    The main advantage of this interface is that the arguments to the log methods are only + converted to strings, if the message is really logged.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        withComponentName

        +
        LogManager withComponentName​(String name)
        +
        Returns a new LogManager instance which may use the given name as an indicator from which + component a log message comes from.
        +
        +
        Parameters:
        +
        name - A non-empty string.
        +
        Returns:
        +
        A LogManager instance.
        +
        +
        • +
      + + + +
        +
      • +

        wouldBeLogged

        +
        boolean wouldBeLogged​(Level priority)
        +
        Returns true if a message with the given log level would be logged.
        +
        +
        Parameters:
        +
        priority - the log level
        +
        Returns:
        +
        whether this log level is enabled
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        void log​(Level priority,
+         Object... args)
        +
        Logs any message occurring during program execution. The message is constructed lazily by + concatenating the parts with " ". The caller should not use string concatenation to create the + message in order to increase performance if the message is never logged. To make individual + arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        args - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        void log​(Level priority,
+         Supplier<String> msgSupplier)
        +
        Logs any message occurring during program execution. The message is constructed lazily by + asking the provided supplier if necessary.
        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        msgSupplier - a supplier for a non-null log message
        +
        +
        • +
      + + + +
        +
      • +

        logf

        +
        @FormatMethod
+void logf​(Level priority,
+          String format,
+          Object... args)
        +
        Logs any message occurring during program execution. The message is constructed lazily from + String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logUserException

        +
        void logUserException​(Level priority,
+                      Throwable e,
+                      @Nullable String additionalMessage)
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        additionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfUserException

        +
        @FormatMethod
+void logfUserException​(Level priority,
+                       Throwable e,
+                       String format,
+                       Object... args)
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier). + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        void logDebugException​(Throwable e,
+                       @Nullable String additionalMessage)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Parameters:
        +
        e - the occurred exception
        +
        additionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfDebugException

        +
        @FormatMethod
+void logfDebugException​(Throwable e,
+                        String format,
+                        Object... args)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Parameters:
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        void logDebugException​(Throwable e)
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Parameters:
        +
        e - the occurred exception
        +
        +
        • +
      + + + +
        +
      • +

        logException

        +
        void logException​(Level priority,
+                  Throwable e,
+                  @Nullable String additionalMessage)
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable.

        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        additionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfException

        +
        @FormatMethod
+void logfException​(Level priority,
+                   Throwable e,
+                   String format,
+                   Object... args)
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Parameters:
        +
        priority - the log level for the message
        +
        e - the occurred exception
        +
        format - The format string.
        +
        args - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        void flush()
        +
        Flush all handlers of this logger.
        +
        • +
      + + + +
        +
      • +

        createNullLogManager

        +
        static LogManager createNullLogManager()
        +
        Return a LogManager that does not log anything. + +

        Note: Do not use this implementation for unit tests, use createTestLogManager() + instead.

        +
        • +
      + + + +
        +
      • +

        createTestLogManager

        +
        static LogManager createTestLogManager()
        +
        Return a LogManager implementation intended for testing when nothing should actually be logged. + +

        Compared to createTestLogManager(), it does check all the parameters for validity, + i.e. non-nullness and correct string format.

        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/log/LogManagerWithoutDuplicates.html b/api/org/sosy_lab/common/log/LogManagerWithoutDuplicates.html new file mode 100644 index 000000000..75b033de9 --- /dev/null +++ b/api/org/sosy_lab/common/log/LogManagerWithoutDuplicates.html @@ -0,0 +1,465 @@ + + + + + +LogManagerWithoutDuplicates (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class LogManagerWithoutDuplicates

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    LogManager
    +
    +
    +
    public class LogManagerWithoutDuplicates
+extends ForwardingLogManager
+implements LogManager
    +
    LogManager implementation which helps to get log messages printed only once, and avoid duplicate + messages.
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/LoggingOptions.html b/api/org/sosy_lab/common/log/LoggingOptions.html new file mode 100644 index 000000000..b507aef70 --- /dev/null +++ b/api/org/sosy_lab/common/log/LoggingOptions.html @@ -0,0 +1,415 @@ + + + + + +LoggingOptions (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class LoggingOptions

+
+
+ +
+
    +
  • +
    +
    public class LoggingOptions
+extends Object
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        getFileLevel

        +
        public Level getFileLevel()
        +
        • +
      + + + +
        +
      • +

        getConsoleLevel

        +
        public Level getConsoleLevel()
        +
        • +
      + + + +
        +
      • +

        getFileExclude

        +
        public List<Level> getFileExclude()
        +
        • +
      + + + +
        +
      • +

        getConsoleExclude

        +
        public List<Level> getConsoleExclude()
        +
        • +
      + + + +
        +
      • +

        getOutputFile

        +
        public Path getOutputFile()
        +
        • +
      + + + +
        +
      • +

        getTruncateSize

        +
        public int getTruncateSize()
        +
        • +
      + + + +
        +
      • +

        useColors

        +
        public boolean useColors()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/NullLogManager.html b/api/org/sosy_lab/common/log/NullLogManager.html new file mode 100644 index 000000000..088214fc4 --- /dev/null +++ b/api/org/sosy_lab/common/log/NullLogManager.html @@ -0,0 +1,838 @@ + + + + + +NullLogManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Enum NullLogManager

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        INSTANCE

        +
        public static final NullLogManager INSTANCE
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static NullLogManager[] values()
        +
        Deprecated.
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (NullLogManager c : NullLogManager.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static NullLogManager valueOf​(String name)
        +
        Deprecated.
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static LogManager getInstance()
        +
        Deprecated.
        +
        • +
      + + + +
        +
      • +

        withComponentName

        +
        public LogManager withComponentName​(String pName)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Returns a new LogManager instance which may use the given name as an indicator from which + component a log message comes from.
        +
        +
        Specified by:
        +
        withComponentName in interface LogManager
        +
        Parameters:
        +
        pName - A non-empty string.
        +
        Returns:
        +
        A LogManager instance.
        +
        +
        • +
      + + + +
        +
      • +

        wouldBeLogged

        +
        public boolean wouldBeLogged​(Level pPriority)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Returns true if a message with the given log level would be logged.
        +
        +
        Specified by:
        +
        wouldBeLogged in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level
        +
        Returns:
        +
        whether this log level is enabled
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + concatenating the parts with " ". The caller should not use string concatenation to create the + message in order to increase performance if the message is never logged. To make individual + arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pArgs - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Supplier<String> pMsgSupplier)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + asking the provided supplier if necessary.
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pMsgSupplier - a supplier for a non-null log message
        +
        +
        • +
      + + + +
        +
      • +

        logf

        +
        public void logf​(Level pPriority,
+                 String pFormat,
+                 Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily from + String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        logf in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logUserException

        +
        public void logUserException​(Level pPriority,
+                             Throwable pE,
+                             String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfUserException

        +
        public void logfUserException​(Level pPriority,
+                              Throwable pE,
+                              String pFormat,
+                              Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier). + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logfUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE,
+                              String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfDebugException

        +
        public void logfDebugException​(Throwable pE,
+                               String pFormat,
+                               Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        +
        • +
      + + + +
        +
      • +

        logException

        +
        public void logException​(Level pPriority,
+                         Throwable pE,
+                         String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable.

        +
        +
        Specified by:
        +
        logException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfException

        +
        public void logfException​(Level pPriority,
+                          Throwable pE,
+                          String pFormat,
+                          Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Flush all handlers of this logger.
        +
        +
        Specified by:
        +
        flush in interface LogManager
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/StringBuildingLogHandler.html b/api/org/sosy_lab/common/log/StringBuildingLogHandler.html new file mode 100644 index 000000000..94566329d --- /dev/null +++ b/api/org/sosy_lab/common/log/StringBuildingLogHandler.html @@ -0,0 +1,386 @@ + + + + + +StringBuildingLogHandler (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class StringBuildingLogHandler

+
+
+ +
+
    +
  • +
    +
    public class StringBuildingLogHandler
+extends Handler
    +
    This class may be used to read the log into a String.
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        StringBuildingLogHandler

        +
        public StringBuildingLogHandler()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        close

        +
        public void close()
        +
        +
        Specified by:
        +
        close in class Handler
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        +
        Specified by:
        +
        flush in class Handler
        +
        +
        • +
      + + + +
        +
      • +

        publish

        +
        public void publish​(@Nullable LogRecord record)
        +
        +
        Specified by:
        +
        publish in class Handler
        +
        +
        • +
      + + + +
        +
      • +

        getLog

        +
        public String getLog()
        +
        • +
      + + + +
        +
      • +

        clear

        +
        public void clear()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/TestLogManager.html b/api/org/sosy_lab/common/log/TestLogManager.html new file mode 100644 index 000000000..877835519 --- /dev/null +++ b/api/org/sosy_lab/common/log/TestLogManager.html @@ -0,0 +1,844 @@ + + + + + +TestLogManager (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Enum TestLogManager

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Enum Constant Detail

      + + + +
        +
      • +

        INSTANCE

        +
        public static final TestLogManager INSTANCE
        +
        Deprecated.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static TestLogManager[] values()
        +
        Deprecated.
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (TestLogManager c : TestLogManager.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static TestLogManager valueOf​(String name)
        +
        Deprecated.
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      + + + +
        +
      • +

        getInstance

        +
        public static LogManager getInstance()
        +
        Deprecated.
        +
        • +
      + + + +
        +
      • +

        withComponentName

        +
        @CanIgnoreReturnValue
+public LogManager withComponentName​(String pName)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Returns a new LogManager instance which may use the given name as an indicator from which + component a log message comes from.
        +
        +
        Specified by:
        +
        withComponentName in interface LogManager
        +
        Parameters:
        +
        pName - A non-empty string.
        +
        Returns:
        +
        A LogManager instance.
        +
        +
        • +
      + + + +
        +
      • +

        wouldBeLogged

        +
        public boolean wouldBeLogged​(Level pPriority)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Returns true if a message with the given log level would be logged.
        +
        +
        Specified by:
        +
        wouldBeLogged in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level
        +
        Returns:
        +
        whether this log level is enabled
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + concatenating the parts with " ". The caller should not use string concatenation to create the + message in order to increase performance if the message is never logged. To make individual + arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pArgs - the parts of the message (can be an arbitrary number of objects whose Object.toString() method is called)
        +
        +
        • +
      + + + +
        +
      • +

        log

        +
        public void log​(Level pPriority,
+                Supplier<String> pMsgSupplier)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily by + asking the provided supplier if necessary.
        +
        +
        Specified by:
        +
        log in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pMsgSupplier - a supplier for a non-null log message
        +
        +
        • +
      + + + +
        +
      • +

        logf

        +
        @FormatMethod
+public void logf​(Level pPriority,
+                 String pFormat,
+                 Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Logs any message occurring during program execution. The message is constructed lazily from + String.format(format, args). To make individual arguments lazy, use MoreStrings.lazyString(Supplier).
        +
        +
        Specified by:
        +
        logf in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logUserException

        +
        public void logUserException​(Level pPriority,
+                             Throwable pE,
+                             @Nullable String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfUserException

        +
        @FormatMethod
+public void logfUserException​(Level pPriority,
+                              Throwable pE,
+                              String pFormat,
+                              Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log a message by printing its message to the user. The details (e.g., stack trace) are hidden + from the user and logged with a lower log level. + +

        Use this method in cases where an expected exception with a useful error message is thrown, + e.g. an InvalidConfigurationException. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier). + +

        If you want to log an IOException because of a write error, it is recommended to write the + message like "Could not write FOO to file". The final message will then be "Could not write FOO + to file FOO.txt (REASON)".

        +
        +
        Specified by:
        +
        logfUserException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE,
+                              @Nullable String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfDebugException

        +
        @FormatMethod
+public void logfDebugException​(Throwable pE,
+                               String pFormat,
+                               Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        logDebugException

        +
        public void logDebugException​(Throwable pE)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception solely for the purpose of debugging. In default configuration, this exception + is not shown to the user! + +

        Use this method when you want to log an exception that was handled by the catching site, but + you don't want to forget the information completely.

        +
        +
        Specified by:
        +
        logDebugException in interface LogManager
        +
        Parameters:
        +
        pE - the occurred exception
        +
        +
        • +
      + + + +
        +
      • +

        logException

        +
        public void logException​(Level pPriority,
+                         Throwable pE,
+                         @Nullable String pAdditionalMessage)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable.

        +
        +
        Specified by:
        +
        logException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pAdditionalMessage - an optional message
        +
        +
        • +
      + + + +
        +
      • +

        logfException

        +
        @FormatMethod
+public void logfException​(Level pPriority,
+                          Throwable pE,
+                          String pFormat,
+                          Object... pArgs)
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Log an exception by printing the full details to the user. + +

        This method should only be used in cases where logUserException and logDebugException are + not acceptable. + +

        The message is constructed lazily from String.format(format, args). To make + individual arguments lazy, use MoreStrings.lazyString(Supplier).

        +
        +
        Specified by:
        +
        logfException in interface LogManager
        +
        Parameters:
        +
        pPriority - the log level for the message
        +
        pE - the occurred exception
        +
        pFormat - The format string.
        +
        pArgs - The arguments for the format string.
        +
        +
        • +
      + + + +
        +
      • +

        flush

        +
        public void flush()
        +
        Deprecated.
        +
        Description copied from interface: LogManager
        +
        Flush all handlers of this logger.
        +
        +
        Specified by:
        +
        flush in interface LogManager
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/TimestampedLogFormatter.html b/api/org/sosy_lab/common/log/TimestampedLogFormatter.html new file mode 100644 index 000000000..f1bab6dcc --- /dev/null +++ b/api/org/sosy_lab/common/log/TimestampedLogFormatter.html @@ -0,0 +1,407 @@ + + + + + +TimestampedLogFormatter (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.log
+

Class TimestampedLogFormatter

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    FileLogFormatter
    +
    +
    +
    public class TimestampedLogFormatter
+extends Formatter
    +
    Log formatter that produces output containing a timestamp. Each log message will look like this: + + 
    + timestamp Level (component:class.method) message
+
    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/log/package-summary.html b/api/org/sosy_lab/common/log/package-summary.html new file mode 100644 index 000000000..164386c81 --- /dev/null +++ b/api/org/sosy_lab/common/log/package-summary.html @@ -0,0 +1,268 @@ + + + + + +org.sosy_lab.common.log (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.log

+
+
+
+ + +
This package provides a logging framework. It is based on the JDK-internal logging, but provides + many additional features such as lazy log message creation, and convenience methods for + exceptions.
+
+ +
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/log/package-tree.html b/api/org/sosy_lab/common/log/package-tree.html new file mode 100644 index 000000000..416675af1 --- /dev/null +++ b/api/org/sosy_lab/common/log/package-tree.html @@ -0,0 +1,210 @@ + + + + + +org.sosy_lab.common.log Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.log

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/package-summary.html b/api/org/sosy_lab/common/package-summary.html new file mode 100644 index 000000000..6b709ba42 --- /dev/null +++ b/api/org/sosy_lab/common/package-summary.html @@ -0,0 +1,350 @@ + + + + + +org.sosy_lab.common (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common

+
+
+
+ + +
This package contains general utilities that do not fit anywhere else.
+
+ +
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/package-tree.html b/api/org/sosy_lab/common/package-tree.html new file mode 100644 index 000000000..23ef063c9 --- /dev/null +++ b/api/org/sosy_lab/common/package-tree.html @@ -0,0 +1,231 @@ + + + + + +org.sosy_lab.common Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/rationals/ExtendedRational.NumberType.html b/api/org/sosy_lab/common/rationals/ExtendedRational.NumberType.html new file mode 100644 index 000000000..3d1dcc24b --- /dev/null +++ b/api/org/sosy_lab/common/rationals/ExtendedRational.NumberType.html @@ -0,0 +1,407 @@ + + + + + +ExtendedRational.NumberType (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.rationals
+

Enum ExtendedRational.NumberType

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        values

        +
        public static ExtendedRational.NumberType[] values()
        +
        Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
        +for (ExtendedRational.NumberType c : ExtendedRational.NumberType.values())
+    System.out.println(c);
+
        +
        +
        Returns:
        +
        an array containing the constants of this enum type, in the order they are declared
        +
        +
        • +
      + + + +
        +
      • +

        valueOf

        +
        public static ExtendedRational.NumberType valueOf​(String name)
        +
        Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)
        +
        +
        Parameters:
        +
        name - the name of the enum constant to be returned.
        +
        Returns:
        +
        the enum constant with the specified name
        +
        Throws:
        +
        IllegalArgumentException - if this enum type has no constant with the specified name
        +
        NullPointerException - if the argument is null
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/rationals/ExtendedRational.html b/api/org/sosy_lab/common/rationals/ExtendedRational.html new file mode 100644 index 000000000..283ab5468 --- /dev/null +++ b/api/org/sosy_lab/common/rationals/ExtendedRational.html @@ -0,0 +1,658 @@ + + + + + +ExtendedRational (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.rationals
+

Class ExtendedRational

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Comparable<ExtendedRational>
    +
    +
    +
    @Immutable
+public final class ExtendedRational
+extends Object
+implements Comparable<ExtendedRational>
    +
    This class represents "extended rational": rationals which allow for infinities, negative + infinities and undefined numbers. + +

    Any operation on the numbers is guaranteed to never yield an exception. + +

    Represented as wrapper around Rational class.

    +
    • +
+
+
+ +
+
+ +
+
+
+ + + + diff --git a/api/org/sosy_lab/common/rationals/LinearExpression.html b/api/org/sosy_lab/common/rationals/LinearExpression.html new file mode 100644 index 000000000..c77ead8d0 --- /dev/null +++ b/api/org/sosy_lab/common/rationals/LinearExpression.html @@ -0,0 +1,618 @@ + + + + + +LinearExpression (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.rationals
+

Class LinearExpression<T>

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Iterable<Map.Entry<T,​Rational>>
    +
    +
    +
    @Immutable(containerOf="T")
+public final class LinearExpression<T>
+extends Object
+implements Iterable<Map.Entry<T,​Rational>>
    +
    Simple sparse implementation for homogeneous linear expression of the form $\Sigma + a_i x_i$, where $x_i$ is a set of variables and $a_i$ is a set of constants. + +

    Every constant stored has to have a non-zero value.

    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/rationals/Rational.html b/api/org/sosy_lab/common/rationals/Rational.html new file mode 100644 index 000000000..89e765dd6 --- /dev/null +++ b/api/org/sosy_lab/common/rationals/Rational.html @@ -0,0 +1,851 @@ + + + + + +Rational (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.rationals
+

Class Rational

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<Rational>
    +
    +
    +
    @Immutable
+public final class Rational
+extends Number
+implements Comparable<Rational>
    +
    Rational class, throws IllegalArgumentException on unsupported operations (e.g. + 1/0). + +

    The Rational object is immutable. All arithmetic operations return new instances. + +

    For performance and convenience, there is always only a single Rational instance + representing numbers 0, 1 and -1. These numbers can be compared using == operator.

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    + +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        of

        +
        public static Rational of​(BigInteger numerator,
+                          BigInteger denominator)
        +
        Create a new rational from a numerator and a denominator.
        +
        • +
      + + + +
        +
      • +

        ofLongs

        +
        public static Rational ofLongs​(long numerator,
+                               long denominator)
        +
        Create a new rational from two longs.
        +
        • +
      + + + +
        +
      • +

        ofLong

        +
        public static Rational ofLong​(long numerator)
        +
        Create a new rational equal to the given long.
        +
        • +
      + + + +
        +
      • +

        ofBigInteger

        +
        public static Rational ofBigInteger​(BigInteger numerator)
        +
        Create a new rational equal to the given BigInteger.
        +
        • +
      + + + +
        +
      • +

        ofString

        +
        public static Rational ofString​(String s)
        +
        Reverses the effect of toString(). Supports 2 different formats: with slash + (e.g. 25/17) or without slash (e.g. 5)
        +
        +
        Parameters:
        +
        s - Input string
        +
        Throws:
        +
        NumberFormatException - iff s is not a valid representation of Rational.
        +
        IllegalArgumentException - If the resulting rational is undefined (e.g. 0/0 or 1/0).
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        ofBigDecimal

        +
        public static Rational ofBigDecimal​(BigDecimal decimal)
        +
        Convert a given BigDecimal to Rational.
        +
        • +
      + + + +
        +
      • +

        times

        +
        public Rational times​(Rational b)
        +
        Multiply by b, return a new instance.
        +
        • +
      + + + +
        +
      • +

        plus

        +
        public Rational plus​(Rational b)
        +
        Return a new instance equal to the sum of this and b.
        +
        • +
      + + + +
        +
      • +

        minus

        +
        public Rational minus​(Rational b)
        +
        Return a new instance equal to this - b.
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        negate

        +
        public Rational negate()
        +
        Return negation of this.
        +
        • +
      + + + +
        +
      • +

        doubleValue

        +
        public double doubleValue()
        +
        +
        Specified by:
        +
        doubleValue in class Number
        +
        +
        • +
      + + + +
        +
      • +

        isIntegral

        +
        public boolean isIntegral()
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        signum

        +
        public int signum()
        +
        Returns -1, 0 or 1, representing the sign of the rational number.
        +
        • +
      + + + +
        +
      • +

        abs

        +
        public Rational abs()
        +
        Returns absolute value of this.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Returns string of the form num/den.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      + + + + + + + +
        +
      • +

        equals

        +
        public boolean equals​(@Nullable Object y)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        • +
      + + + + + + + +
        +
      • +

        intValue

        +
        public int intValue()
        +
        +
        Specified by:
        +
        intValue in class Number
        +
        +
        • +
      + + + +
        +
      • +

        longValue

        +
        public long longValue()
        +
        +
        Specified by:
        +
        longValue in class Number
        +
        +
        • +
      + + + +
        +
      • +

        floatValue

        +
        public float floatValue()
        +
        +
        Specified by:
        +
        floatValue in class Number
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/rationals/package-summary.html b/api/org/sosy_lab/common/rationals/package-summary.html new file mode 100644 index 000000000..8bda78297 --- /dev/null +++ b/api/org/sosy_lab/common/rationals/package-summary.html @@ -0,0 +1,206 @@ + + + + + +org.sosy_lab.common.rationals (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.rationals

+
+
+
+ + +
Java-Rationals is a library for working with rationals and extended rationals in Java.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    ExtendedRational +
    This class represents "extended rational": rationals which allow for infinities, negative + infinities and undefined numbers.
    +
    LinearExpression<T> +
    Simple sparse implementation for homogeneous linear expression of the form $\Sigma + a_i x_i$, where $x_i$ is a set of variables and $a_i$ is a set of constants.
    +
    Rational +
    Rational class, throws IllegalArgumentException on unsupported operations (e.g.
    +
    +
    • +
  • + + + + + + + + + + + + +
    Enum Summary 
    EnumDescription
    ExtendedRational.NumberType 
    +
    • +
+
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/rationals/package-tree.html b/api/org/sosy_lab/common/rationals/package-tree.html new file mode 100644 index 000000000..ae72f12e8 --- /dev/null +++ b/api/org/sosy_lab/common/rationals/package-tree.html @@ -0,0 +1,182 @@ + + + + + +org.sosy_lab.common.rationals Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.rationals

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+ + + diff --git a/api/org/sosy_lab/common/time/NestedTimer.html b/api/org/sosy_lab/common/time/NestedTimer.html new file mode 100644 index 000000000..34a592432 --- /dev/null +++ b/api/org/sosy_lab/common/time/NestedTimer.html @@ -0,0 +1,686 @@ + + + + + +NestedTimer (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.time
+

Class NestedTimer

+
+
+ +
+
    +
  • +
    +
    public final class NestedTimer
+extends Object
    +
    This class represents a timer similar to Timer, however it nests two timers. + +

    If you have a method A that calls a method B, this class can be used to measure (1) the time + spent by A and B together, (2) the time spent by B, and (3) the time spent only in A (without the + call to B). The advantage over using two separate timers is that this allows to compute average + and maximum of measurements for (3). A simple use of two timers would allow to compute these + values only for (1) and (2); for (3) one could only compute the sum time. + +

    This class uses the name "total" to refer to measurement (1), the name "inner" to refer to + measurement (2), and the name "outer" to refer to measurement (3). So in general "total" + represents the sum of "inner" and "outer". + +

    The "inner" timer can never be running as long as the "total" timer is not running. During a + single "total" interval, the "inner" timer can be started and stopped several times. This will be + counted only as one "inner" interval (e.g., when the average "inner" time is computed). + Similarly, when the "inner" timer is started and stopped several times in a single "total" + interval, this counts as only one "outer" interval. The number of all starts and stops of the + "inner" timer summed over all "outer" intervals is never used by this class and is not available + to the user. + +

    This class is not thread-safe and may be used only from within a single thread.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NestedTimer

        +
        public NestedTimer()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        startOuter

        +
        public void startOuter()
        +
        Start the outer timer. May be called only if the timer is currently not running.
        +
        • +
      + + + +
        +
      • +

        startBoth

        +
        public void startBoth()
        +
        Start both timers. May be called only if the timer is currently not running. Guarantees that + both timers are started in the exact same instant of time.
        +
        • +
      + + + +
        +
      • +

        stopOuter

        +
        public void stopOuter()
        +
        Stop the outer timer. May be called only if the outer timer is currently running and the inner + timer is stopped.
        +
        • +
      + + + +
        +
      • +

        stopBoth

        +
        public void stopBoth()
        +
        • +
      + + + +
        +
      • +

        isRunning

        +
        public boolean isRunning()
        +
        Check if the timer is running. Contrary to the other methods of this class, this method is + thread-safe. This means it can be safely run from another thread.
        +
        • +
      + + + +
        +
      • +

        isOnlyOuterRunning

        +
        public boolean isOnlyOuterRunning()
        +
        Check if the outer timer is running, i.e., the timer is running but the inner timer is not + running. Contrary to the other methods of this class, this method is thread-safe. This means it + can be safely run from another thread.
        +
        • +
      + + + +
        +
      • +

        getCurentInnerTimer

        +
        public Timer getCurentInnerTimer()
        +
        Get a reference to the current inner timer. This reference can be used to start and stop the + inner interval (even multiple times). The returned reference becomes invalid after a call to + stopOuter() or stopBoth() and may not be used anymore afterwards.
        +
        • +
      + + + +
        +
      • +

        getOuterSumTime

        +
        public TimeSpan getOuterSumTime()
        +
        Return the sum of all outer intervals. If the outer timer is running, the current interval is + also counted (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getInnerSumTime

        +
        public TimeSpan getInnerSumTime()
        +
        Return the sum of all inner intervals. If the inner timer is running, the current interval is + also counted (up to the current time). If the timer was never started, this method returns 0. + To get only the sum time of the inner timer for the interval since the last time the outer + timer was started, call getInnerTimer().getSumTime().
        +
        • +
      + + + +
        +
      • +

        getTotalSumTime

        +
        public TimeSpan getTotalSumTime()
        +
        Return the sum of all total intervals. If the outer timer is running, the current interval is + also counted (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getOuterMaxTime

        +
        public TimeSpan getOuterMaxTime()
        +
        Return the maximal time of all outer intervals. If the outer timer is running, the current + interval is also counted (up to the current time). If the timer was never started, this method + returns 0.
        +
        • +
      + + + +
        +
      • +

        getInnerMaxTime

        +
        public TimeSpan getInnerMaxTime()
        +
        Return the maximal time of all inner intervals. Note that this is not the same as the maximum + of the intervals of all inner timers. If the inner timer is running, the current interval is + also counted (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getTotalMaxTime

        +
        public TimeSpan getTotalMaxTime()
        +
        Return the maximal time of all total intervals. If the outer timer is running, the current + interval is also counted (up to the current time). If the timer was never started, this method + returns 0.
        +
        • +
      + + + +
        +
      • +

        getNumberOfIntervals

        +
        public int getNumberOfIntervals()
        +
        Return the number of total intervals. Note that this is the same as the number of outer + intervals. If timer is running, the current interval is also counted. If the timer was never + started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getLengthOfLastOuterInterval

        +
        public TimeSpan getLengthOfLastOuterInterval()
        +
        Return the length of the last measured outer interval. If the outer timer is running, this is + the time from the start of the current interval up to now. If the timer was never started, this + method returns 0.
        +
        • +
      + + + +
        +
      • +

        getLengthOfLastTotalInterval

        +
        public TimeSpan getLengthOfLastTotalInterval()
        +
        Return the length of the last measured total interval. If the timer is running, this is the + time from the start of the current interval up to now. If the timer was never started, this + method returns 0.
        +
        • +
      + + + +
        +
      • +

        getOuterAvgTime

        +
        public TimeSpan getOuterAvgTime()
        +
        Return the average of all outer intervals. If the outer timer is running, the current interval + is also counted (up to the current time). If the timer was never started, this method returns + 0.
        +
        • +
      + + + +
        +
      • +

        getInnerAvgSumTime

        +
        public TimeSpan getInnerAvgSumTime()
        +
        Return the average of all inner times. Note that this is not the average of all intervals of + the inner timers, but basically the same as getInnerSumTime() / getNumberOfIntervals() + . If the inner timer is running, the current interval is also counted (up to the current + time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getTotalAvgTime

        +
        public TimeSpan getTotalAvgTime()
        +
        Return the average of all total intervals. If the timer is running, the current interval is + also counted (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Return a String with a default representation of the the sum of the times of total intervals. + For printing other times, or with a specific unit, use the appropriate getter and call TimeSpan.formatAs(java.util.concurrent.TimeUnit). The format and the content of the String + returned by this method is not guaranteed to be the same in future versions of this code.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/time/Tickers.TickerWithUnit.html b/api/org/sosy_lab/common/time/Tickers.TickerWithUnit.html new file mode 100644 index 000000000..1ddda6723 --- /dev/null +++ b/api/org/sosy_lab/common/time/Tickers.TickerWithUnit.html @@ -0,0 +1,321 @@ + + + + + +Tickers.TickerWithUnit (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.time
+

Class Tickers.TickerWithUnit

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    Tickers
    +
    +
    +
    public abstract static class Tickers.TickerWithUnit
+extends Ticker
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TickerWithUnit

        +
        public TickerWithUnit()
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        unit

        +
        public abstract TimeUnit unit()
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/time/Tickers.html b/api/org/sosy_lab/common/time/Tickers.html new file mode 100644 index 000000000..a5042d7aa --- /dev/null +++ b/api/org/sosy_lab/common/time/Tickers.html @@ -0,0 +1,374 @@ + + + + + +Tickers (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.time
+

Class Tickers

+
+
+ +
+
    +
  • +
    +
    public final class Tickers
+extends Object
    +
    Class providing several convenient Ticker implementations.
    +
    • +
+
+
+ +
+
+ +
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/time/TimeSpan.html b/api/org/sosy_lab/common/time/TimeSpan.html new file mode 100644 index 000000000..daa13d41e --- /dev/null +++ b/api/org/sosy_lab/common/time/TimeSpan.html @@ -0,0 +1,876 @@ + + + + + +TimeSpan (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.time
+

Class TimeSpan

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Serializable, Comparable<TimeSpan>, TemporalAmount
    +
    +
    +
    @Immutable
+public final class TimeSpan
+extends Object
+implements Comparable<TimeSpan>, Serializable, TemporalAmount
    +
    This is an immutable representation of some time span, using a TimeUnit and a value. + +

    The value may be positive or negative. All operations check for overflows and underflows, the + behavior on overflow and underflow differs and is documented for each method. + +

    Two instances are considered equal if they represent the exact same time span regardless of + their unit, for example, 60s and 1min are considered equal.

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Method Detail

      + + + + + + + +
        +
      • +

        ofSeconds

        +
        public static TimeSpan ofSeconds​(long pSeconds)
        +
        • +
      + + + +
        +
      • +

        ofMillis

        +
        public static TimeSpan ofMillis​(long pMillis)
        +
        • +
      + + + +
        +
      • +

        ofNanos

        +
        public static TimeSpan ofNanos​(long pNanos)
        +
        • +
      + + + +
        +
      • +

        empty

        +
        public static TimeSpan empty()
        +
        • +
      + + + + + + + +
        +
      • +

        getChecked

        +
        public long getChecked​(TimeUnit dest)
        +
        Get the value of this TimeSpan represented in the given unit. If the given unit is larger than + the current unit, precision may be lost.
        +
        +
        Throws:
        +
        ArithmeticException - If the value cannot be represented in the given unit due to + overflow.
        +
        +
        • +
      + + + +
        +
      • +

        getSaturated

        +
        public long getSaturated​(TimeUnit dest)
        +
        Get the value of this TimeSpan represented in the given unit. If the given unit is larger than + the current unit, precision may be lost. If the value cannot be represented in the given unit + due to overflow, Long.MAX_VALUE/Long.MIN_VALUE is returned.
        +
        • +
      + + + +
        +
      • +

        toChecked

        +
        public TimeSpan toChecked​(TimeUnit dest)
        +
        Return a TimeSpan that represents (approximately) the same time span, but whose unit is the + given unit. If the given unit is larger than the current unit, precision may be lost.
        +
        +
        Throws:
        +
        ArithmeticException - If the value cannot be represented in the given unit
        +
        +
        • +
      + + + +
        +
      • +

        toSaturated

        +
        public TimeSpan toSaturated​(TimeUnit dest)
        +
        Return a TimeSpan that represents (approximately) the same time span, but whose unit is the + given unit. If the given unit is larger than the current unit, precision may be lost. If the + value cannot be represented in the given unit due to overflow, Long.MAX_VALUE/Long.MIN_VALUE is + returned.
        +
        • +
      + + + +
        +
      • +

        asSeconds

        +
        public long asSeconds()
        +
        Get the value of this TimeSpan as seconds. If the current unit is smaller than seconds, + precision may be lost.
        +
        +
        Throws:
        +
        ArithmeticException - If the value cannot be represented as seconds due to overflow.
        +
        +
        • +
      + + + +
        +
      • +

        asMillis

        +
        public long asMillis()
        +
        Get the value of this TimeSpan as milliseconds. If the current unit is smaller than + milliseconds, precision may be lost.
        +
        +
        Throws:
        +
        ArithmeticException - If the value cannot be represented as milliseconds due to overflow.
        +
        +
        • +
      + + + +
        +
      • +

        asNanos

        +
        public long asNanos()
        +
        Get the value of this TimeSpan as nanoseconds.
        +
        +
        Throws:
        +
        ArithmeticException - If the value cannot be represented as nanoseconds due to overflow.
        +
        +
        • +
      + + + +
        +
      • +

        getUnit

        +
        public TimeUnit getUnit()
        +
        • +
      + + + +
        +
      • +

        asDuration

        +
        public Duration asDuration()
        +
        Return a Duration instance that represents the same amount of time (but it won't be + possible to retrieve our unit as from getUnit()). Note that not all possible TimeSpan values can be represented by a Duration.
        +
        +
        Throws:
        +
        ArithmeticException - If an overflow occurs.
        +
        +
        • +
      + + + +
        +
      • +

        formatAs

        +
        public String formatAs​(TimeUnit dest)
        +
        Return a strings that represents (approximately) this time span, in the given unit if possible. + If the given unit is larger than the current unit, precision may be lost. If the value cannot + be represented in the given unit due to overflow, the result does not use the given unit, but + the closest unit one that still allows to hold the exact value.
        +
        • +
      + + + +
        +
      • +

        isEmpty

        +
        public boolean isEmpty()
        +
        Check whether this time span is empty, i.e., represents 0ns (or 0ms or 0s or ...).
        +
        • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals​(@Nullable Object obj)
        +
        +
        Overrides:
        +
        equals in class Object
        +
        +
        • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class Object
        +
        +
        • +
      + + + + + + + + + + + +
        +
      • +

        sum

        +
        public static TimeSpan sum​(TimeSpan a,
+                           TimeSpan b)
        +
        Create a new time span that is the sum of two time spans. The unit of the returned time span is + the more precise one if possible, otherwise the closest unit that still allows to hold both + input values and the result. Note that this can loose precision when adding a very large and a + very small value.
        +
        +
        Throws:
        +
        ArithmeticException - If no unit is large enough to represent the result value.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static TimeSpan sum​(Iterable<TimeSpan> timeSpans)
        +
        Create a new time span that is the sum of several time spans. The unit of the returned time + span is the most precise one if possible, otherwise the closest unit that still allows to hold + input values and the result. Note that this can loose precision when adding very large and very + small values.
        +
        +
        Throws:
        +
        ArithmeticException - If no unit is large enough to represent the result value.
        +
        +
        • +
      + + + +
        +
      • +

        sum

        +
        public static TimeSpan sum​(TimeSpan... t)
        +
        Create a new time span that is the sum of several time spans. The unit of the returned time + span is the most precise one.
        +
        • +
      + + + +
        +
      • +

        difference

        +
        public static TimeSpan difference​(TimeSpan a,
+                                  TimeSpan b)
        +
        Create a new time span that is the difference of two time spans. The unit of the returned time + span is the more precise one if possible, otherwise the closest unit that still allows to hold + both input values and the result. Note that this can loose precision when subtracting a very + large and a very small value.
        +
        • +
      + + + +
        +
      • +

        multiply

        +
        @CheckReturnValue
+public TimeSpan multiply​(int factor)
        +
        Create a new time span that is the current one multiplied by a non-negative integral factor. + The unit of the returned time span is the same as the current one if possible, otherwise the + closest unit that still allows to the result. Note that this can loose precision.
        +
        • +
      + + + +
        +
      • +

        divide

        +
        @CheckReturnValue
+public TimeSpan divide​(int divisor)
        +
        Create a new time span that is the current one divided by a non-negative integral value. The + result of the division is rounded down (integer division). The unit of the returned time span + is the same as the current one.
        +
        • +
      + + + + + + + + + + + + + + + + +
      • +
    +
    +
    • +
+
+
+
+ +
+ +
+ + diff --git a/api/org/sosy_lab/common/time/Timer.html b/api/org/sosy_lab/common/time/Timer.html new file mode 100644 index 000000000..97ca413a1 --- /dev/null +++ b/api/org/sosy_lab/common/time/Timer.html @@ -0,0 +1,514 @@ + + + + + +Timer (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+ +
+
+
Package org.sosy_lab.common.time
+

Class Timer

+
+
+ +
+
    +
  • +
    +
    public final class Timer
+extends Object
    +
    This class represents a timer like a stop watch. It can be started and stopped several times. It + measures the sum, the average, the minimum, the maximum and the number of those intervals. This + class is similar to Stopwatch but has more features. + +

    This class is not thread-safe and may be used only from within a single thread.

    +
    • +
+
+
+ +
+
+
    +
  • + +
    +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        Timer

        +
        public Timer()
        +
        Create a fresh timer in the not-running state.
        +
        • +
      +
      • +
    +
    + +
    +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        start

        +
        public void start()
        +
        Start the timer. May be called only if the timer is currently not running.
        +
        • +
      + + + +
        +
      • +

        stop

        +
        public void stop()
        +
        Stop the timer. May be called only if the timer is currently running.
        +
        • +
      + + + +
        +
      • +

        stopIfRunning

        +
        public void stopIfRunning()
        +
        • +
      + + + +
        +
      • +

        isRunning

        +
        public boolean isRunning()
        +
        Check if the timer is running. Contrary to all other methods of this class, this method is + thread-safe. This means it can be safely run from another thread.
        +
        • +
      + + + +
        +
      • +

        getSumTime

        +
        public TimeSpan getSumTime()
        +
        Return the sum of all intervals. If timer is running, the current interval is also counted (up + to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getMaxTime

        +
        public TimeSpan getMaxTime()
        +
        Return the maximal time of all intervals. If timer is running, the current interval is also + counted (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getMinTime

        +
        public TimeSpan getMinTime()
        +
        Return the minimal time of all intervals. If the timer is running, the current interval is not + considered. If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getNumberOfIntervals

        +
        public int getNumberOfIntervals()
        +
        Return the number of intervals. If timer is running, the current interval is also counted. If + the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        getLengthOfLastInterval

        +
        public TimeSpan getLengthOfLastInterval()
        +
        Return the length of the last measured interval. If the timer is running, this is the time from + the start of the current interval up to now. If the timer was never started, this method + returns 0.
        +
        • +
      + + + +
        +
      • +

        getAvgTime

        +
        public TimeSpan getAvgTime()
        +
        Return the average of all intervals. If timer is running, the current interval is also counted + (up to the current time). If the timer was never started, this method returns 0.
        +
        • +
      + + + +
        +
      • +

        toString

        +
        public String toString()
        +
        Return a String with a default representation of the the sum of the times of all intervals. For + printing other times, or with a specific unit, use the appropriate getter and call TimeSpan.formatAs(java.util.concurrent.TimeUnit). The format and the content of the String + returned by this method is not guaranteed to be the same in future versions of this code.
        +
        +
        Overrides:
        +
        toString in class Object
        +
        +
        • +
      + + + +
        +
      • +

        prettyFormat

        +
        public String prettyFormat()
        +
        Syntax sugar method: pretty-format the timer output into a string in seconds.
        +
        • +
      +
      • +
    +
    +
    • +
+
+
+
+ + + + diff --git a/api/org/sosy_lab/common/time/package-summary.html b/api/org/sosy_lab/common/time/package-summary.html new file mode 100644 index 000000000..9893b965e --- /dev/null +++ b/api/org/sosy_lab/common/time/package-summary.html @@ -0,0 +1,199 @@ + + + + + +org.sosy_lab.common.time (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

@CheckReturnValue +@ParametersAreNonnullByDefault +@ReturnValuesAreNonnullByDefault +@FieldsAreNonnullByDefault +

+

Package org.sosy_lab.common.time

+
+
+
+ + +
This package provides possibilities for measuring elapsed time, and a data class TimeSpan for storing time spans together with the respective time unit.
+
+
    +
  • + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Class Summary 
    ClassDescription
    NestedTimer +
    This class represents a timer similar to Timer, however it nests two timers.
    +
    Tickers +
    Class providing several convenient Ticker implementations.
    +
    Tickers.TickerWithUnit 
    Timer +
    This class represents a timer like a stop watch.
    +
    TimeSpan +
    This is an immutable representation of some time span, using a TimeUnit and a value.
    +
    +
    • +
+
+
+
+ +
+ + diff --git a/api/org/sosy_lab/common/time/package-tree.html b/api/org/sosy_lab/common/time/package-tree.html new file mode 100644 index 000000000..d02f47136 --- /dev/null +++ b/api/org/sosy_lab/common/time/package-tree.html @@ -0,0 +1,170 @@ + + + + + +org.sosy_lab.common.time Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For Package org.sosy_lab.common.time

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+
+ + + diff --git a/api/overview-summary.html b/api/overview-summary.html new file mode 100644 index 000000000..eeb6fb0d6 --- /dev/null +++ b/api/overview-summary.html @@ -0,0 +1,23 @@ + + + + + +Sosy-Lab Common Library + + + + + + + +
+ +

index.html

+
+ + diff --git a/api/overview-tree.html b/api/overview-tree.html new file mode 100644 index 000000000..783cf240f --- /dev/null +++ b/api/overview-tree.html @@ -0,0 +1,450 @@ + + + + + +Class Hierarchy (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
+ +
+
+
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+
+

Class Hierarchy

+ +
+
+

Interface Hierarchy

+ +
+
+

Annotation Type Hierarchy

+ +
+
+

Enum Hierarchy

+ +
+
+
+
+ +
+ + diff --git a/api/package-search-index.js b/api/package-search-index.js new file mode 100644 index 000000000..81382690e --- /dev/null +++ b/api/package-search-index.js @@ -0,0 +1 @@ +packageSearchIndex = [{"l":"All Packages","url":"allpackages-index.html"},{"l":"org.sosy_lab.common"},{"l":"org.sosy_lab.common.annotations"},{"l":"org.sosy_lab.common.collect"},{"l":"org.sosy_lab.common.configuration"},{"l":"org.sosy_lab.common.configuration.converters"},{"l":"org.sosy_lab.common.io"},{"l":"org.sosy_lab.common.log"},{"l":"org.sosy_lab.common.rationals"},{"l":"org.sosy_lab.common.time"}] \ No newline at end of file diff --git a/api/package-search-index.zip b/api/package-search-index.zip new file mode 100644 index 000000000..1982c582a Binary files /dev/null and b/api/package-search-index.zip differ diff --git a/api/resources/glass.png b/api/resources/glass.png new file mode 100644 index 000000000..a7f591f46 Binary files /dev/null and b/api/resources/glass.png differ diff --git a/api/resources/x.png b/api/resources/x.png new file mode 100644 index 000000000..30548a756 Binary files /dev/null and b/api/resources/x.png differ diff --git a/api/script.js b/api/script.js new file mode 100644 index 000000000..7dc93c48e --- /dev/null +++ b/api/script.js @@ -0,0 +1,149 @@ +/* + * Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var moduleSearchIndex; +var packageSearchIndex; +var typeSearchIndex; +var memberSearchIndex; +var tagSearchIndex; +function loadScripts(doc, tag) { + createElem(doc, tag, 'jquery/jszip/dist/jszip.js'); + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils.js'); + if (window.navigator.userAgent.indexOf('MSIE ') > 0 || window.navigator.userAgent.indexOf('Trident/') > 0 || + window.navigator.userAgent.indexOf('Edge/') > 0) { + createElem(doc, tag, 'jquery/jszip-utils/dist/jszip-utils-ie.js'); + } + createElem(doc, tag, 'search.js'); + + $.get(pathtoroot + "module-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "module-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("module-search-index.json").async("text").then(function(content){ + moduleSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "package-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "package-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("package-search-index.json").async("text").then(function(content){ + packageSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "type-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "type-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("type-search-index.json").async("text").then(function(content){ + typeSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "member-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "member-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("member-search-index.json").async("text").then(function(content){ + memberSearchIndex = JSON.parse(content); + }); + }); + }); + }); + $.get(pathtoroot + "tag-search-index.zip") + .done(function() { + JSZipUtils.getBinaryContent(pathtoroot + "tag-search-index.zip", function(e, data) { + JSZip.loadAsync(data).then(function(zip){ + zip.file("tag-search-index.json").async("text").then(function(content){ + tagSearchIndex = JSON.parse(content); + }); + }); + }); + }); + if (!moduleSearchIndex) { + createElem(doc, tag, 'module-search-index.js'); + } + if (!packageSearchIndex) { + createElem(doc, tag, 'package-search-index.js'); + } + if (!typeSearchIndex) { + createElem(doc, tag, 'type-search-index.js'); + } + if (!memberSearchIndex) { + createElem(doc, tag, 'member-search-index.js'); + } + if (!tagSearchIndex) { + createElem(doc, tag, 'tag-search-index.js'); + } + $(window).resize(function() { + $('.navPadding').css('padding-top', $('.fixedNav').css("height")); + }); +} + +function createElem(doc, tag, path) { + var script = doc.createElement(tag); + var scriptElement = doc.getElementsByTagName(tag)[0]; + script.src = pathtoroot + path; + scriptElement.parentNode.insertBefore(script, scriptElement); +} + +function show(type) { + count = 0; + for (var key in data) { + var row = document.getElementById(key); + if ((data[key] & type) !== 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) { + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} + +function updateModuleFrame(pFrame, cFrame) { + top.packageFrame.location = pFrame; + top.classFrame.location = cFrame; +} diff --git a/api/search.js b/api/search.js new file mode 100644 index 000000000..8492271e7 --- /dev/null +++ b/api/search.js @@ -0,0 +1,326 @@ +/* + * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved. + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * This code is free software; you can redistribute it and/or modify it + * under the terms of the GNU General Public License version 2 only, as + * published by the Free Software Foundation. Oracle designates this + * particular file as subject to the "Classpath" exception as provided + * by Oracle in the LICENSE file that accompanied this code. + * + * This code is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License + * version 2 for more details (a copy is included in the LICENSE file that + * accompanied this code). + * + * You should have received a copy of the GNU General Public License version + * 2 along with this work; if not, write to the Free Software Foundation, + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. + * + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA + * or visit www.oracle.com if you need additional information or have any + * questions. + */ + +var noResult = {l: "No results found"}; +var catModules = "Modules"; +var catPackages = "Packages"; +var catTypes = "Types"; +var catMembers = "Members"; +var catSearchTags = "SearchTags"; +var highlight = "$&"; +var camelCaseRegexp = ""; +var secondaryMatcher = ""; +function getHighlightedText(item) { + var ccMatcher = new RegExp(camelCaseRegexp); + var label = item.replace(ccMatcher, highlight); + if (label === item) { + label = item.replace(secondaryMatcher, highlight); + } + return label; +} +function getURLPrefix(ui) { + var urlPrefix=""; + if (useModuleDirectories) { + var slash = "/"; + if (ui.item.category === catModules) { + return ui.item.l + slash; + } else if (ui.item.category === catPackages && ui.item.m) { + return ui.item.m + slash; + } else if ((ui.item.category === catTypes && ui.item.p) || ui.item.category === catMembers) { + $.each(packageSearchIndex, function(index, item) { + if (item.m && ui.item.p == item.l) { + urlPrefix = item.m + slash; + } + }); + return urlPrefix; + } else { + return urlPrefix; + } + } + return urlPrefix; +} +var watermark = 'Search'; +$(function() { + $("#search").val(''); + $("#search").prop("disabled", false); + $("#reset").prop("disabled", false); + $("#search").val(watermark).addClass('watermark'); + $("#search").blur(function() { + if ($(this).val().length == 0) { + $(this).val(watermark).addClass('watermark'); + } + }); + $("#search").on('click keydown', function() { + if ($(this).val() == watermark) { + $(this).val('').removeClass('watermark'); + } + }); + $("#reset").click(function() { + $("#search").val(''); + $("#search").focus(); + }); + $("#search").focus(); + $("#search")[0].setSelectionRange(0, 0); +}); +$.widget("custom.catcomplete", $.ui.autocomplete, { + _create: function() { + this._super(); + this.widget().menu("option", "items", "> :not(.ui-autocomplete-category)"); + }, + _renderMenu: function(ul, items) { + var rMenu = this, + currentCategory = ""; + rMenu.menu.bindings = $(); + $.each(items, function(index, item) { + var li; + if (item.l !== noResult.l && item.category !== currentCategory) { + ul.append("
  • " + item.category + "
    • "); + currentCategory = item.category; + } + li = rMenu._renderItemData(ul, item); + if (item.category) { + li.attr("aria-label", item.category + " : " + item.l); + li.attr("class", "resultItem"); + } else { + li.attr("aria-label", item.l); + li.attr("class", "resultItem"); + } + }); + }, + _renderItem: function(ul, item) { + var label = ""; + if (item.category === catModules) { + label = getHighlightedText(item.l); + } else if (item.category === catPackages) { + label = (item.m) + ? getHighlightedText(item.m + "/" + item.l) + : getHighlightedText(item.l); + } else if (item.category === catTypes) { + label = (item.p) + ? getHighlightedText(item.p + "." + item.l) + : getHighlightedText(item.l); + } else if (item.category === catMembers) { + label = getHighlightedText(item.p + "." + (item.c + "." + item.l)); + } else if (item.category === catSearchTags) { + label = getHighlightedText(item.l); + } else { + label = item.l; + } + var li = $("
  • ").appendTo(ul); + var div = $("
    ").appendTo(li); + if (item.category === catSearchTags) { + if (item.d) { + div.html(label + " (" + item.h + ")
    " + + item.d + "
    "); + } else { + div.html(label + " (" + item.h + ")"); + } + } else { + div.html(label); + } + return li; + } +}); +$(function() { + $("#search").catcomplete({ + minLength: 1, + delay: 100, + source: function(request, response) { + var result = new Array(); + var presult = new Array(); + var tresult = new Array(); + var mresult = new Array(); + var tgresult = new Array(); + var secondaryresult = new Array(); + var displayCount = 0; + var exactMatcher = new RegExp("^" + $.ui.autocomplete.escapeRegex(request.term) + "$", "i"); + camelCaseRegexp = ($.ui.autocomplete.escapeRegex(request.term)).split(/(?=[A-Z])/).join("([a-z0-9_$]*?)"); + var camelCaseMatcher = new RegExp("^" + camelCaseRegexp); + secondaryMatcher = new RegExp($.ui.autocomplete.escapeRegex(request.term), "i"); + + // Return the nested innermost name from the specified object + function nestedName(e) { + return e.l.substring(e.l.lastIndexOf(".") + 1); + } + + function concatResults(a1, a2) { + a1 = a1.concat(a2); + a2.length = 0; + return a1; + } + + if (moduleSearchIndex) { + var mdleCount = 0; + $.each(moduleSearchIndex, function(index, item) { + item.category = catModules; + if (exactMatcher.test(item.l)) { + result.push(item); + mdleCount++; + } else if (camelCaseMatcher.test(item.l)) { + result.push(item); + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + displayCount = mdleCount; + result = concatResults(result, secondaryresult); + } + if (packageSearchIndex) { + var pCount = 0; + var pkg = ""; + $.each(packageSearchIndex, function(index, item) { + item.category = catPackages; + pkg = (item.m) + ? (item.m + "/" + item.l) + : item.l; + if (exactMatcher.test(item.l)) { + presult.push(item); + pCount++; + } else if (camelCaseMatcher.test(pkg)) { + presult.push(item); + } else if (secondaryMatcher.test(pkg)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(presult, secondaryresult)); + displayCount = (pCount > displayCount) ? pCount : displayCount; + } + if (typeSearchIndex) { + var tCount = 0; + $.each(typeSearchIndex, function(index, item) { + item.category = catTypes; + var s = nestedName(item); + if (exactMatcher.test(s)) { + tresult.push(item); + tCount++; + } else if (camelCaseMatcher.test(s)) { + tresult.push(item); + } else if (secondaryMatcher.test(item.p + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tresult, secondaryresult)); + displayCount = (tCount > displayCount) ? tCount : displayCount; + } + if (memberSearchIndex) { + var mCount = 0; + $.each(memberSearchIndex, function(index, item) { + item.category = catMembers; + var s = nestedName(item); + if (exactMatcher.test(s)) { + mresult.push(item); + mCount++; + } else if (camelCaseMatcher.test(s)) { + mresult.push(item); + } else if (secondaryMatcher.test(item.c + "." + item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(mresult, secondaryresult)); + displayCount = (mCount > displayCount) ? mCount : displayCount; + } + if (tagSearchIndex) { + var tgCount = 0; + $.each(tagSearchIndex, function(index, item) { + item.category = catSearchTags; + if (exactMatcher.test(item.l)) { + tgresult.push(item); + tgCount++; + } else if (secondaryMatcher.test(item.l)) { + secondaryresult.push(item); + } + }); + result = result.concat(concatResults(tgresult, secondaryresult)); + displayCount = (tgCount > displayCount) ? tgCount : displayCount; + } + displayCount = (displayCount > 500) ? displayCount : 500; + var counter = function() { + var count = {Modules: 0, Packages: 0, Types: 0, Members: 0, SearchTags: 0}; + var f = function(item) { + count[item.category] += 1; + return (count[item.category] <= displayCount); + }; + return f; + }(); + response(result.filter(counter)); + }, + response: function(event, ui) { + if (!ui.content.length) { + ui.content.push(noResult); + } else { + $("#search").empty(); + } + }, + autoFocus: true, + position: { + collision: "flip" + }, + select: function(event, ui) { + if (ui.item.l !== noResult.l) { + var url = getURLPrefix(ui); + if (ui.item.category === catModules) { + if (useModuleDirectories) { + url += "module-summary.html"; + } else { + url = ui.item.l + "-summary.html"; + } + } else if (ui.item.category === catPackages) { + if (ui.item.url) { + url = ui.item.url; + } else { + url += ui.item.l.replace(/\./g, '/') + "/package-summary.html"; + } + } else if (ui.item.category === catTypes) { + if (ui.item.url) { + url = ui.item.url; + } else if (ui.item.p === "") { + url += ui.item.l + ".html"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.l + ".html"; + } + } else if (ui.item.category === catMembers) { + if (ui.item.p === "") { + url += ui.item.c + ".html" + "#"; + } else { + url += ui.item.p.replace(/\./g, '/') + "/" + ui.item.c + ".html" + "#"; + } + if (ui.item.url) { + url += ui.item.url; + } else { + url += ui.item.l; + } + } else if (ui.item.category === catSearchTags) { + url += ui.item.u; + } + if (top !== window) { + parent.classFrame.location = pathtoroot + url; + } else { + window.location.href = pathtoroot + url; + } + $("#search").focus(); + } + } + }); +}); diff --git a/api/serialized-form.html b/api/serialized-form.html new file mode 100644 index 000000000..b9a1685e0 --- /dev/null +++ b/api/serialized-form.html @@ -0,0 +1,330 @@ + + + + + +Serialized Form (Sosy-Lab Common Library) + + + + + + + + + + + + + + + +
    + +
    +
    +
    +

    Serialized Form

    +
    +
    + +
    +
    +
    + +
    + + diff --git a/api/stylesheet.css b/api/stylesheet.css new file mode 100644 index 000000000..de945eda2 --- /dev/null +++ b/api/stylesheet.css @@ -0,0 +1,910 @@ +/* + * Javadoc style sheet + */ + +@import url('resources/fonts/dejavu.css'); + +/* + * Styles for individual HTML elements. + * + * These are styles that are specific to individual HTML elements. Changing them affects the style of a particular + * HTML element throughout the page. + */ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; + padding:0; + height:100%; + width:100%; +} +iframe { + margin:0; + padding:0; + height:100%; + width:100%; + overflow-y:scroll; + border:none; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a[href]:hover, a[href]:focus { + text-decoration:none; + color:#bb7a2a; +} +a[name] { + color:#353833; +} +a[name]:before, a[name]:target, a[id]:before, a[id]:target { + content:""; + display:inline-block; + position:relative; + padding-top:129px; + margin-top:-129px; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; + margin-top:8px; + line-height:1.4em; +} +dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + padding-top:4px; +} +table tr td dt code { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; + vertical-align:top; + padding-top:4px; +} +sup { + font-size:8px; +} + +/* + * Styles for HTML generated by javadoc. + * + * These are style classes that are used by the standard doclet to generate HTML documentation. + */ + +/* + * Styles for document title and copyright. + */ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin-left:.5em; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* + * Styles for navigation bar. + */ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.navPadding { + padding-top: 107px; +} +.fixedNav { + position:fixed; + width:100%; + z-index:999; + background-color:#ffffff; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch { + float:right; + margin:0 0 0 0; + padding:0; +} +ul.navListSearch li { + list-style:none; + float:right; + padding: 5px 6px; + text-transform:uppercase; +} +ul.navListSearch li label { + position:relative; + right:-16px; +} +ul.subNavList li { + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* + * Styles for page header and footer. + */ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexNav { + position:relative; + font-size:12px; + background-color:#dee3e9; +} +.indexNav ul { + margin-top:0; + padding:5px; +} +.indexNav ul li { + display:inline; + list-style-type:none; + padding-right:10px; + text-transform:uppercase; +} +.indexNav h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* + * Styles for headings. + */ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* + * Styles for page layout containers. + */ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer, +.allClassesContainer, .allPackagesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +.contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { + font-size:12px; + font-weight:bold; + margin:10px 0 0 0; + color:#4E4E4E; +} +.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* + * Styles for lists. + */ +li.circle { + list-style:circle; +} +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* + * Styles for tables. + */ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, +.requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + width:100%; + border-spacing:0; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary, .requiresSummary, .packagesSummary, .providesSummary, .usesSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption, +.requiresSummary caption, .packagesSummary caption, .providesSummary caption, .usesSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.constantsSummary caption a:link, .constantsSummary caption a:visited, +.useSummary caption a:link, .useSummary caption a:visited { + color:#1f389c; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, +.deprecatedSummary caption a:link, +.requiresSummary caption a:link, .packagesSummary caption a:link, .providesSummary caption a:link, +.usesSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.requiresSummary caption a:hover, .packagesSummary caption a:hover, .providesSummary caption a:hover, +.usesSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.requiresSummary caption a:active, .packagesSummary caption a:active, .providesSummary caption a:active, +.usesSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, +.deprecatedSummary caption a:visited, +.requiresSummary caption a:visited, .packagesSummary caption a:visited, .providesSummary caption a:visited, +.usesSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span, +.requiresSummary caption span, .packagesSummary caption span, .providesSummary caption span, +.usesSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span, .packagesSummary caption span.activeTableTab span, +.overviewSummary caption span.activeTableTab span, .typeSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span, .packagesSummary caption span.tableTab span, +.overviewSummary caption span.tableTab span, .typeSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab, +.packagesSummary caption span.tableTab, .packagesSummary caption span.activeTableTab, +.overviewSummary caption span.tableTab, .overviewSummary caption span.activeTableTab, +.typeSummary caption span.tableTab, .typeSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd, +.requiresSummary .tabEnd, .packagesSummary .tabEnd, .providesSummary .tabEnd, .usesSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd, .packagesSummary .activeTableTab .tabEnd, +.overviewSummary .activeTableTab .tabEnd, .typeSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd, .packagesSummary .tableTab .tabEnd, +.overviewSummary .tableTab .tabEnd, .typeSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; +} +.rowColor th, .altColor th { + font-weight:normal; +} +.overviewSummary td, .memberSummary td, .typeSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td, +.requiresSummary td, .packagesSummary td, .providesSummary td, .usesSummary td { + text-align:left; + padding:0px 0px 12px 10px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .useSummary th, +.constantsSummary th, .packagesSummary th, td.colFirst, td.colSecond, td.colLast, .useSummary td, +.constantsSummary td { + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colSecond, th.colLast, th.colConstructorName, th.colDeprecatedItemName, .constantsSummary th, +.packagesSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + font-size:13px; +} +td.colSecond, th.colSecond, td.colLast, th.colConstructorName, th.colDeprecatedItemName, th.colLast { + font-size:13px; +} +.constantsSummary th, .packagesSummary th { + font-size:13px; +} +.providesSummary th.colFirst, .providesSummary th.colLast, .providesSummary td.colFirst, +.providesSummary td.colLast { + white-space:normal; + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.requiresSummary td.colFirst, .requiresSummary th.colFirst, +.packagesSummary td.colFirst, .packagesSummary td.colSecond, .packagesSummary th.colFirst, .packagesSummary th, +.usesSummary td.colFirst, .usesSummary th.colFirst, +.providesSummary td.colFirst, .providesSummary th.colFirst, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colSecond, .memberSummary th.colSecond, .memberSummary th.colConstructorName, +.typeSummary td.colFirst, .typeSummary th.colFirst { + vertical-align:top; +} +.packagesSummary th.colLast, .packagesSummary td.colLast { + white-space:normal; +} +td.colFirst a:link, td.colFirst a:visited, +td.colSecond a:link, td.colSecond a:visited, +th.colFirst a:link, th.colFirst a:visited, +th.colSecond a:link, th.colSecond a:visited, +th.colConstructorName a:link, th.colConstructorName a:visited, +th.colDeprecatedItemName a:link, th.colDeprecatedItemName a:visited, +.constantValuesContainer td a:link, .constantValuesContainer td a:visited, +.allClassesContainer td a:link, .allClassesContainer td a:visited, +.allPackagesContainer td a:link, .allPackagesContainer td a:visited { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor, .altColor th { + background-color:#FFFFFF; +} +.rowColor, .rowColor th { + background-color:#EEEEEF; +} +/* + * Styles for contents. + */ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} +td.colLast div { + padding-top:0px; +} +td.colLast a { + padding-bottom:3px; +} +/* + * Styles for formatting effect. + */ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +.block { + display:block; + margin:3px 10px 2px 0px; + color:#474747; +} +.deprecatedLabel, .descfrmTypeLabel, .implementationLabel, .memberNameLabel, .memberNameLink, +.moduleLabelInPackage, .moduleLabelInType, .overrideSpecifyLabel, .packageLabelInType, +.packageHierarchyLabel, .paramLabel, .returnLabel, .seeLabel, .simpleTagLabel, +.throwsLabel, .typeNameLabel, .typeNameLink, .searchTagLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} +.deprecationBlock { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; + border-style:solid; + border-width:thin; + border-radius:10px; + padding:10px; + margin-bottom:10px; + margin-right:10px; + display:inline-block; +} +div.block div.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} +div.contentContainer ul.blockList li.blockList h2 { + padding-bottom:0px; +} +/* + * Styles for IFRAME. + */ +.mainContainer { + margin:0 auto; + padding:0; + height:100%; + width:100%; + position:fixed; + top:0; + left:0; +} +.leftContainer { + height:100%; + position:fixed; + width:320px; +} +.leftTop { + position:relative; + float:left; + width:315px; + top:0; + left:0; + height:30%; + border-right:6px solid #ccc; + border-bottom:6px solid #ccc; +} +.leftBottom { + position:relative; + float:left; + width:315px; + bottom:0; + left:0; + height:70%; + border-right:6px solid #ccc; + border-top:1px solid #000; +} +.rightContainer { + position:absolute; + left:320px; + top:0; + bottom:0; + height:100%; + right:0; + border-left:1px solid #000; +} +.rightIframe { + margin:0; + padding:0; + height:100%; + right:30px; + width:100%; + overflow:visible; + margin-bottom:30px; +} +/* + * Styles specific to HTML5 elements. + */ +main, nav, header, footer, section { + display:block; +} +/* + * Styles for javadoc search. + */ +.ui-autocomplete-category { + font-weight:bold; + font-size:15px; + padding:7px 0 7px 3px; + background-color:#4D7A97; + color:#FFFFFF; +} +.resultItem { + font-size:13px; +} +.ui-autocomplete { + max-height:85%; + max-width:65%; + overflow-y:scroll; + overflow-x:scroll; + white-space:nowrap; + box-shadow: 0 3px 6px rgba(0,0,0,0.16), 0 3px 6px rgba(0,0,0,0.23); +} +ul.ui-autocomplete { + position:fixed; + z-index:999999; + background-color: #FFFFFF; +} +ul.ui-autocomplete li { + float:left; + clear:both; + width:100%; +} +.resultHighlight { + font-weight:bold; +} +.ui-autocomplete .result-item { + font-size: inherit; +} +#search { + background-image:url('resources/glass.png'); + background-size:13px; + background-repeat:no-repeat; + background-position:2px 3px; + padding-left:20px; + position:relative; + right:-18px; +} +#reset { + background-color: rgb(255,255,255); + background-image:url('resources/x.png'); + background-position:center; + background-repeat:no-repeat; + background-size:12px; + border:0 none; + width:16px; + height:17px; + position:relative; + left:-4px; + top:-4px; + font-size:0px; +} +.watermark { + color:#545454; +} +.searchTagDescResult { + font-style:italic; + font-size:11px; +} +.searchTagHolderResult { + font-style:italic; + font-size:12px; +} +.searchTagResult:before, .searchTagResult:target { + color:red; +} +.moduleGraph span { + display:none; + position:absolute; +} +.moduleGraph:hover span { + display:block; + margin: -100px 0 0 100px; + z-index: 1; +} +.methodSignature { + white-space:normal; +} + +/* + * Styles for user-provided tables. + * + * borderless: + * No borders, vertical margins, styled caption. + * This style is provided for use with existing doc comments. + * In general, borderless tables should not be used for layout purposes. + * + * plain: + * Plain borders around table and cells, vertical margins, styled caption. + * Best for small tables or for complex tables for tables with cells that span + * rows and columns, when the "striped" style does not work well. + * + * striped: + * Borders around the table and vertical borders between cells, striped rows, + * vertical margins, styled caption. + * Best for tables that have a header row, and a body containing a series of simple rows. + */ + +table.borderless, +table.plain, +table.striped { + margin-top: 10px; + margin-bottom: 10px; +} +table.borderless > caption, +table.plain > caption, +table.striped > caption { + font-weight: bold; + font-size: smaller; +} +table.borderless th, table.borderless td, +table.plain th, table.plain td, +table.striped th, table.striped td { + padding: 2px 5px; +} +table.borderless, +table.borderless > thead > tr > th, table.borderless > tbody > tr > th, table.borderless > tr > th, +table.borderless > thead > tr > td, table.borderless > tbody > tr > td, table.borderless > tr > td { + border: none; +} +table.borderless > thead > tr, table.borderless > tbody > tr, table.borderless > tr { + background-color: transparent; +} +table.plain { + border-collapse: collapse; + border: 1px solid black; +} +table.plain > thead > tr, table.plain > tbody tr, table.plain > tr { + background-color: transparent; +} +table.plain > thead > tr > th, table.plain > tbody > tr > th, table.plain > tr > th, +table.plain > thead > tr > td, table.plain > tbody > tr > td, table.plain > tr > td { + border: 1px solid black; +} +table.striped { + border-collapse: collapse; + border: 1px solid black; +} +table.striped > thead { + background-color: #E3E3E3; +} +table.striped > thead > tr > th, table.striped > thead > tr > td { + border: 1px solid black; +} +table.striped > tbody > tr:nth-child(even) { + background-color: #EEE +} +table.striped > tbody > tr:nth-child(odd) { + background-color: #FFF +} +table.striped > tbody > tr > th, table.striped > tbody > tr > td { + border-left: 1px solid black; + border-right: 1px solid black; +} +table.striped > tbody > tr > th { + font-weight: normal; +} diff --git a/api/type-search-index.js b/api/type-search-index.js new file mode 100644 index 000000000..8261bce40 --- /dev/null +++ b/api/type-search-index.js @@ -0,0 +1 @@ +typeSearchIndex = [{"p":"org.sosy_lab.common","l":"Appenders.AbstractAppender"},{"p":"org.sosy_lab.common","l":"AbstractMBean"},{"l":"All Classes","url":"allclasses-index.html"},{"p":"org.sosy_lab.common.configuration","l":"AnnotatedValue"},{"p":"org.sosy_lab.common","l":"Appender"},{"p":"org.sosy_lab.common","l":"Appenders"},{"p":"org.sosy_lab.common","l":"NativeLibraries.Architecture"},{"p":"org.sosy_lab.common.configuration.converters","l":"BaseTypeConverter"},{"p":"org.sosy_lab.common.log","l":"BasicLogManager"},{"p":"org.sosy_lab.common","l":"ChildFirstPatternClassLoader"},{"p":"org.sosy_lab.common","l":"Classes"},{"p":"org.sosy_lab.common","l":"Classes.ClassInstantiationException"},{"p":"org.sosy_lab.common","l":"Classes.ClassLoaderBuilder"},{"p":"org.sosy_lab.common.configuration","l":"ClassOption"},{"p":"org.sosy_lab.common.configuration.converters","l":"ClassTypeConverter"},{"p":"org.sosy_lab.common.collect","l":"Collections3"},{"p":"org.sosy_lab.common","l":"Concurrency"},{"p":"org.sosy_lab.common.configuration","l":"Configuration"},{"p":"org.sosy_lab.common.configuration","l":"ConfigurationBuilder"},{"p":"org.sosy_lab.common.log","l":"ConsoleLogFormatter"},{"p":"org.sosy_lab.common.collect","l":"CopyOnWriteSortedMap"},{"p":"org.sosy_lab.common.collect","l":"MapsDifference.DefaultVisitor"},{"p":"org.sosy_lab.common.io","l":"TempFile.DeleteOnCloseDir"},{"p":"org.sosy_lab.common.io","l":"MoreFiles.DeleteOnCloseFile"},{"p":"org.sosy_lab.common.io","l":"TempFile.DeleteOnCloseFile"},{"p":"org.sosy_lab.common.io","l":"DuplicateOutputStream"},{"p":"org.sosy_lab.common.collect","l":"MapsDifference.Entry"},{"p":"org.sosy_lab.common.log","l":"ExtendedLogRecord"},{"p":"org.sosy_lab.common.rationals","l":"ExtendedRational"},{"p":"org.sosy_lab.common.annotations","l":"FieldsAreNonnullByDefault"},{"p":"org.sosy_lab.common.log","l":"FileLogFormatter"},{"p":"org.sosy_lab.common.configuration","l":"FileOption"},{"p":"org.sosy_lab.common.configuration.converters","l":"FileTypeConverter"},{"p":"org.sosy_lab.common.log","l":"ForwardingLogManager"},{"p":"org.sosy_lab.common.configuration","l":"IntegerOption"},{"p":"org.sosy_lab.common.configuration.converters","l":"IntegerTypeConverter"},{"p":"org.sosy_lab.common.configuration","l":"InvalidConfigurationException"},{"p":"org.sosy_lab.common.io","l":"IO"},{"p":"org.sosy_lab.common","l":"JSON"},{"p":"org.sosy_lab.common","l":"LazyFutureTask"},{"p":"org.sosy_lab.common.rationals","l":"LinearExpression"},{"p":"org.sosy_lab.common.log","l":"LoggingOptions"},{"p":"org.sosy_lab.common.log","l":"LogManager"},{"p":"org.sosy_lab.common.log","l":"BasicLogManager.LogManagerMXBean"},{"p":"org.sosy_lab.common.log","l":"LogManagerWithoutDuplicates"},{"p":"org.sosy_lab.common.collect","l":"MapsDifference"},{"p":"org.sosy_lab.common.collect","l":"PersistentSortedMaps.MergeConflictHandler"},{"p":"org.sosy_lab.common.collect","l":"MoreCollectors"},{"p":"org.sosy_lab.common.io","l":"MoreFiles"},{"p":"org.sosy_lab.common","l":"MoreStrings"},{"p":"org.sosy_lab.common","l":"NativeLibraries"},{"p":"org.sosy_lab.common.time","l":"NestedTimer"},{"p":"org.sosy_lab.common.log","l":"NullLogManager"},{"p":"org.sosy_lab.common.rationals","l":"ExtendedRational.NumberType"},{"p":"org.sosy_lab.common.configuration","l":"Option"},{"p":"org.sosy_lab.common","l":"Optionals"},{"p":"org.sosy_lab.common.configuration","l":"OptionAnnotationProcessor"},{"p":"org.sosy_lab.common.configuration","l":"OptionCollector"},{"p":"org.sosy_lab.common.configuration","l":"OptionDetailAnnotation"},{"p":"org.sosy_lab.common.configuration","l":"Options"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticMap"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticMapTestSuite.OrderStatisticMapFactory"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticMapTestSuite"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticSet"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticSetTestSuite.OrderStatisticSetFactory"},{"p":"org.sosy_lab.common.collect","l":"OrderStatisticSetTestSuite"},{"p":"org.sosy_lab.common","l":"NativeLibraries.OS"},{"p":"org.sosy_lab.common.collect","l":"PathCopyingPersistentTreeMap"},{"p":"org.sosy_lab.common.io","l":"PathCounterTemplate"},{"p":"org.sosy_lab.common.io","l":"PathTemplate"},{"p":"org.sosy_lab.common.collect","l":"PersistentLinkedList"},{"p":"org.sosy_lab.common.collect","l":"PersistentList"},{"p":"org.sosy_lab.common.collect","l":"PersistentMap"},{"p":"org.sosy_lab.common.collect","l":"PersistentSortedMap"},{"p":"org.sosy_lab.common.collect","l":"PersistentSortedMaps"},{"p":"org.sosy_lab.common","l":"ProcessExecutor"},{"p":"org.sosy_lab.common.rationals","l":"Rational"},{"p":"org.sosy_lab.common.annotations","l":"ReturnValuesAreNonnullByDefault"},{"p":"org.sosy_lab.common","l":"ShutdownManager"},{"p":"org.sosy_lab.common","l":"ShutdownNotifier"},{"p":"org.sosy_lab.common","l":"ShutdownNotifier.ShutdownRequestListener"},{"p":"org.sosy_lab.common.log","l":"StringBuildingLogHandler"},{"p":"org.sosy_lab.common.annotations","l":"SuppressForbidden"},{"p":"org.sosy_lab.common.io","l":"TempFile"},{"p":"org.sosy_lab.common.io","l":"TempFile.TempFileBuilder"},{"p":"org.sosy_lab.common.log","l":"TestLogManager"},{"p":"org.sosy_lab.common.time","l":"Tickers"},{"p":"org.sosy_lab.common.time","l":"Tickers.TickerWithUnit"},{"p":"org.sosy_lab.common.time","l":"Timer"},{"p":"org.sosy_lab.common.time","l":"TimeSpan"},{"p":"org.sosy_lab.common.configuration","l":"TimeSpanOption"},{"p":"org.sosy_lab.common.configuration.converters","l":"TimeSpanTypeConverter"},{"p":"org.sosy_lab.common.log","l":"TimestampedLogFormatter"},{"p":"org.sosy_lab.common.configuration","l":"FileOption.Type"},{"p":"org.sosy_lab.common.configuration.converters","l":"TypeConverter"},{"p":"org.sosy_lab.common","l":"Classes.UnexpectedCheckedException"},{"p":"org.sosy_lab.common","l":"UniqueIdGenerator"},{"p":"org.sosy_lab.common.annotations","l":"Unmaintained"},{"p":"org.sosy_lab.common","l":"Classes.UnsuitedClassException"},{"p":"org.sosy_lab.common.collect","l":"MapsDifference.Visitor"},{"p":"org.sosy_lab.common","l":"MoreStrings.WithLongString"}] \ No newline at end of file diff --git a/api/type-search-index.zip b/api/type-search-index.zip new file mode 100644 index 000000000..14e610937 Binary files /dev/null and b/api/type-search-index.zip differ diff --git a/index.html b/index.html new file mode 100644 index 000000000..7faef30ea --- /dev/null +++ b/index.html @@ -0,0 +1,21 @@ + + + + + + + +SoSy-Lab Common Library + + + +Javadoc API documentation +