diff --git a/JsonPreprocessor/CJsonPreprocessor.py b/JsonPreprocessor/CJsonPreprocessor.py index e3b2c33c..dbfd2daa 100644 --- a/JsonPreprocessor/CJsonPreprocessor.py +++ b/JsonPreprocessor/CJsonPreprocessor.py @@ -1,4 +1,4 @@ -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 Robert Bosch GmbH # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -58,16 +58,21 @@ class CSyntaxType(): (re.VERBOSE | re.MULTILINE | re.DOTALL)) class CPythonJSONDecoder(json.JSONDecoder): - """ Add below python values when scanning json data + """ +Some keywords are different in Python and Json + +.. table:: Python vs. Json keywords + :widths: auto - +---------------+-------------------+ - | True | True | - +---------------+-------------------+ - | False | False | - +---------------+-------------------+ - | None | None | - +---------------+-------------------+ + ======= ======= + Python Json + ======= ======= + True true + False false + None null + ======= ======= """ + def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.scan_once = self.custom_scan_once @@ -123,24 +128,26 @@ def custom_scan_once(self, string, idx): class CJsonPreprocessor(): ''' - CJsonPreprocessor helps to handle configuration file as json format: - - Allow comment within json file - - Allow import json file within json file +CJsonPreprocessor helps to handle configuration file as json format: + +- Allow comment within json file +- Allow import json file within json file ''' def __init__(self, syntax=CSyntaxType.json, currentCfg={}): + ''' +Method: __processImportFiles this is custom decorder of object_pairs_hook function. + +This method helps to import json file which is provided in '[import]' keyword into current json file. + +Returns: + Dictionary is parsed from json file. + ''' self.lImportedFiles = [] self.recursive_level = 0 self.syntax = syntax self.currentCfg = currentCfg self.lUpdatedParams = [] - - ''' - Method: __processImportFiles this is custom decorder of object_pairs_hook function. - This method helps to import json file which is provided in '[import]' keyword into current json file. - Returns: - Dictionary is parsed from json file. - ''' def __processImportFiles(self, input_data): out_dict = {} for key, value in input_data: @@ -161,13 +168,13 @@ def __processImportFiles(self, input_data): out_dict[key] = value return out_dict - ''' - Method: __removeComments loads json config file which allows comments inside - Args: - jsonFile: string - Returns: - lJsonData: list, list of string data from jsonFile after removing comment(s). - ''' + # ''' + # Method: __removeComments loads json config file which allows comments inside + # Args: + # jsonFile: string + # Returns: + # lJsonData: list, list of string data from jsonFile after removing comment(s). + # ''' def __removeComments(self, jsonFile): jsonPath = '' if '/' in jsonFile: @@ -205,14 +212,14 @@ def __removeComments(self, jsonFile): lJsonData.append(line) return lJsonData, jsonPath - ''' - private __nestedParamHandler: This method handles the nested variable in param names or value - in updated json config file. - Args: - sInputStr: string - param name or value which contains nested variable - Returns: - sStrHandled: string - ''' + # ''' + # private __nestedParamHandler: This method handles the nested variable in param names or value + # in updated json config file. + # Args: + # sInputStr: string - param name or value which contains nested variable + # Returns: + # sStrHandled: string + # ''' def __nestedParamHandler(self, sInputStr): #globals().update(currentCfg) @@ -271,14 +278,14 @@ def __nestedParamHandler(self, sInputStr): sStrHandled = fullVariable return sStrHandled - ''' - private __updateAndReplaceNestedParam: this method replaces all nested params in key and value of Json object - Args: - oJson: dict - currentCfg: dict - Returns: - oJsonOut: dict - ''' + # ''' + # private __updateAndReplaceNestedParam: this method replaces all nested params in key and value of Json object + # Args: + # oJson: dict + # currentCfg: dict + # Returns: + # oJsonOut: dict + # ''' def __updateAndReplaceNestedParam(self, oJson, recursive=False): if bool(self.currentCfg) and not recursive: @@ -359,6 +366,7 @@ def jsonLoad(self, jFile, masterFile=True): Args: jFile: string, json file input + Returns: oJson: dict ''' @@ -392,4 +400,4 @@ def jsonLoad(self, jFile, masterFile=True): oJson = self.__updateAndReplaceNestedParam(oJson) # oJson['JsonPath'] = jsonPath # is JsonPath required? - return oJson \ No newline at end of file + return oJson diff --git a/JsonPreprocessor/JsonPreprocessor.pdf b/JsonPreprocessor/JsonPreprocessor.pdf new file mode 100644 index 00000000..033f473a Binary files /dev/null and b/JsonPreprocessor/JsonPreprocessor.pdf differ diff --git a/JsonPreprocessor/__init__.py b/JsonPreprocessor/__init__.py index 8043fb51..6034eb8a 100644 --- a/JsonPreprocessor/__init__.py +++ b/JsonPreprocessor/__init__.py @@ -1,4 +1,4 @@ -# Copyright 2020-2022 Robert Bosch Car Multimedia GmbH +# Copyright 2020-2022 Robert Bosch GmbH # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. diff --git a/JsonPreprocessor/version.py b/JsonPreprocessor/version.py new file mode 100644 index 00000000..bf715f22 --- /dev/null +++ b/JsonPreprocessor/version.py @@ -0,0 +1,23 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# Version and date of JsonPreprocessor +# +VERSION = "0.1.2" +VERSION_DATE = "01.07.2022" + diff --git a/README.rst b/README.rst index 3527fa21..488d2017 100644 --- a/README.rst +++ b/README.rst @@ -47,7 +47,7 @@ package documentation is located in 'doc/_build/'. Package Documentation --------------------- -A detailed documentation of the Json Preprocessor's package can be found here: `Json-Preprocessor.pdf `_ +A detailed documentation of the Json Preprocessor's package can be found here: `JsonPreprocessor.pdf `_ Feedback -------- diff --git a/config/CExtendedSetup.py b/additions/CExtendedSetup.py similarity index 54% rename from config/CExtendedSetup.py rename to additions/CExtendedSetup.py index 1c1a7867..00d770da 100644 --- a/config/CExtendedSetup.py +++ b/additions/CExtendedSetup.py @@ -18,23 +18,18 @@ # # CExtendedSetup.py # -# CM-CI1/ECA3-Queckenstedt +# XC-CT/ECA3-Queckenstedt # # Contains all functions to support the extended setup process. # # -------------------------------------------------------------------------------------------------------------- # -# 21.02.2022 / XC-CT/ECA3-Queckenstedt -# Added add_htmldoc_to_wheel() to support wheel based distribution -# -# 30.09.2021 / XC-CI1/ECA3-Queckenstedt -# Added wrapper for error messages -# -# Initial version 08/2021 +# 10.05.2022 # # -------------------------------------------------------------------------------------------------------------- import os, sys, platform, shlex, subprocess, shutil +import pypandoc import colorama as col col.init(autoreset=True) @@ -70,11 +65,11 @@ def __del__(self): # -------------------------------------------------------------------------------------------------------------- - def gen_doc(self): - """Executes sphinx-makeall.py + def genpackagedoc(self): + """Executes genpackagedoc.py """ - sPython = self.__oRepositoryConfig.Get('sPython') - sDocumentationBuilder = self.__oRepositoryConfig.Get('sDocumentationBuilder') + sPython = self.__oRepositoryConfig.Get('PYTHON') + sDocumentationBuilder = self.__oRepositoryConfig.Get('DOCUMENTATIONBUILDER') listCmdLineParts = [] listCmdLineParts.append(f"\"{sPython}\"") listCmdLineParts.append(f"\"{sDocumentationBuilder}\"") @@ -96,16 +91,58 @@ def gen_doc(self): return ERROR print() return nReturn - # eof def gen_doc(): + # eof def genpackagedoc(): + + # -------------------------------------------------------------------------------------------------------------- + + def convert_repo_readme(self): + """Converts the main repository README from 'rst' to 'md' format. + """ + + sReadMe_rst = self.__oRepositoryConfig.Get("README_RST") + if sReadMe_rst is None: + print() + printerror(f"'sReadMe_rst' is None") + print() + return ERROR + + sReadMe_md = self.__oRepositoryConfig.Get("README_MD") + if sReadMe_md is None: + print() + printerror(f"'sReadMe_md' is None") + print() + return ERROR + + if os.path.isfile(sReadMe_rst) is False: + print() + printerror(f"Missing readme file '{sReadMe_rst}'") + print() + return ERROR + + sFileContent = pypandoc.convert_file(sReadMe_rst, 'md') + hFile_md = open(sReadMe_md, "w", encoding="utf-8") + listFileContent = sFileContent.splitlines() + for sLine in listFileContent: + hFile_md.write(sLine + "\n") + hFile_md.close() + + print(f"File '{sReadMe_rst}'") + print("converted to") + print(f"'{sReadMe_md}'") + print() + + return SUCCESS + + # eof def convert_repo_readme(self): # -------------------------------------------------------------------------------------------------------------- def delete_previous_build(self): """Deletes folder containing previous builds of setup.py within the repository """ - sSetupBuildFolder = self.__oRepositoryConfig.Get('sSetupBuildFolder') - sSetupDistFolder = self.__oRepositoryConfig.Get('sSetupDistFolder') - sEggInfoFolder = self.__oRepositoryConfig.Get('sEggInfoFolder') + sSetupBuildFolder = self.__oRepositoryConfig.Get('SETUPBUILDFOLDER') + sSetupDistFolder = self.__oRepositoryConfig.Get('SETUPDISTFOLDER') + sEggInfoFolder = self.__oRepositoryConfig.Get('EGGINFOFOLDER') if os.path.isdir(sSetupBuildFolder) is True: print(f"* Deleting '{sSetupBuildFolder}'") try: @@ -141,7 +178,7 @@ def delete_previous_build(self): def delete_previous_installation(self): """Deletes previous package installation folder within the Python installation """ - sInstalledPackageFolder = self.__oRepositoryConfig.Get('sInstalledPackageFolder') + sInstalledPackageFolder = self.__oRepositoryConfig.Get('INSTALLEDPACKAGEFOLDER') if os.path.isdir(sInstalledPackageFolder) is True: print(f"* Deleting '{sInstalledPackageFolder}'") try: @@ -151,102 +188,11 @@ def delete_previous_installation(self): printexception(str(ex)) print() return ERROR - sInstalledPackageDocFolder = self.__oRepositoryConfig.Get('sInstalledPackageDocFolder') - if os.path.isdir(sInstalledPackageDocFolder) is True: - print(f"* Deleting '{sInstalledPackageDocFolder}'") - try: - shutil.rmtree(sInstalledPackageDocFolder) - except Exception as ex: - print() - printexception(str(ex)) - print() - return ERROR print() return SUCCESS # eof def delete_previous_installation(): - # -------------------------------------------------------------------------------------------------------------- - - def add_htmldoc_to_installation(self): - """Adds the package documentation in HTML format to the Python onstallation - """ - sHTMLOutputFolder = self.__oRepositoryConfig.Get('sHTMLOutputFolder') - sInstalledPackageDocFolder = self.__oRepositoryConfig.Get('sInstalledPackageDocFolder') - if os.path.isdir(sHTMLOutputFolder) is False: - print() - printerror(f"Error: Missing html output folder '{sHTMLOutputFolder}'") - print() - return ERROR - shutil.copytree(sHTMLOutputFolder, sInstalledPackageDocFolder) - if os.path.isdir(sInstalledPackageDocFolder) is False: - print() - printerror(f"Error: html documentation not copied to package installation folder '{sInstalledPackageDocFolder}'") - print() - return ERROR - print(COLBY + f"Folder '{sHTMLOutputFolder}'") - print(COLBY + "copied to") - print(COLBY + f"'{sInstalledPackageDocFolder}'") - print() - return SUCCESS - # eof def add_htmldoc_to_installation(): - - # -------------------------------------------------------------------------------------------------------------- - - def add_htmldoc_to_wheel(self): - """Adds the package documentation in HTML format to the wheel folder inside build - """ - sHTMLOutputFolder = self.__oRepositoryConfig.Get('sHTMLOutputFolder') - sSetupBuildFolder = self.__oRepositoryConfig.Get('sSetupBuildFolder') - sPackageName = self.__oRepositoryConfig.Get('sPackageName') - if os.path.isdir(sHTMLOutputFolder) is False: - print() - printerror(f"Error: Missing html output folder '{sHTMLOutputFolder}'") - print() - return ERROR - - # The desired destination path for the documentation is: - # \bdist.win-amd64\wheel\\doc - # with is already available by 'sSetupBuildFolder' in CConfig. - # I am not convinced that it's a good idea to have hard coded parts like 'bdist.win-amd64' within a path here. - # Therefore we search recursively the file system for a subfolder with name 'wheel/'. And that's it! - sTargetFolder = f"wheel/{sPackageName}" - sWheelDocDestPath = None - bBreak = False - for sRootFolder, listFolders, listFiles in os.walk(sSetupBuildFolder): - for sFolder in listFolders: - sPath = os.path.join(sRootFolder, sFolder) - sPathMod = sPath.replace("\\", "/") - if sPathMod.endswith(sTargetFolder): - sWheelDocDestPath = f"{sPathMod}/doc" - bBreak = True - break # for sFolder in listFolders: - # eof if sPathMod.endswith(sTargetFolder): - # eof for sFolder in listFolders: - if bBreak is True: - break # walk - # eof for sRootFolder, listFolders, listFiles in os.walk(sSetupBuildFolder): - - if sWheelDocDestPath is None: - print() - printerror(f"Error: Not able to find '{sTargetFolder}' inside {sSetupBuildFolder}") - print() - return ERROR - - shutil.copytree(sHTMLOutputFolder, sWheelDocDestPath) - if os.path.isdir(sWheelDocDestPath) is False: - print() - printerror(f"Error: html documentation not copied to local wheel folder '{sWheelDocDestPath}'") - print() - return ERROR - - print(COLBY + f"Folder '{sHTMLOutputFolder}'") - print(COLBY + "copied to") - print(COLBY + f"'{sWheelDocDestPath}'") - print() - return SUCCESS - # eof def add_htmldoc_to_wheel(): - # eof class CExtendedSetup(): # -------------------------------------------------------------------------------------------------------------- diff --git a/additions/PythonExtensionsCollection/File/CFile.py b/additions/PythonExtensionsCollection/File/CFile.py new file mode 100644 index 00000000..320424c6 --- /dev/null +++ b/additions/PythonExtensionsCollection/File/CFile.py @@ -0,0 +1,1072 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# CFile.py +# +# XC-CT/ECA3-Queckenstedt +# +# 27.06.2022 +# +# ************************************************************************************************************** + +# -- import standard Python modules +import os, shutil, platform + +# -- import Bosch Python modules +from PythonExtensionsCollection.String.CString import CString + +# ************************************************************************************************************** + +class enFileStatiType: + """ +The class ``enFileStatiType`` defines the sollowing file states: + +* ``closed`` +* ``openedforwriting`` +* ``openedforappending`` +* ``openedforreading`` + """ + closed = "closed" + openedforwriting = "openedforwriting" + openedforappending = "openedforappending" + openedforreading = "openedforreading" + +# -------------------------------------------------------------------------------------------------------------- + +class CFile(object): + """ +The class ``CFile`` provides a small set of file functions with extended parametrization (like switches +defining if a file is allowed to be overwritten or not). + +Most of the functions at least returns ``bSuccess`` and ``sResult``. + +* ``bSuccess`` is ``True`` in case of no error occurred. +* ``bSuccess`` is ``False`` in case of an error occurred. +* ``bSuccess`` is ``None`` in case of a very fatal error occurred (exceptions). + +* ``sResult`` contains details about what happens during computation. + +Every instance of CFile handles one single file only and forces exclusive access to this file. + +It is not possible to create an instance of this class with a file that is already in use by another instance. + +It is also not possible to use ``CopyTo`` or ``MoveTo`` to overwrite files that are already in use by another instance. +This makes the file handling more save against access violations. + """ + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __init__(self, sFile=None): + self.__sFile = CString.NormalizePath(sFile) + self.__oFileHandle = None + self.__oFileStatus = enFileStatiType.closed + self.__sLastDestination = None + + try: + CFile.__listFilesInUse + except: + CFile.__listFilesInUse = [] + + # exclusive access is required (checked by self.__bIsFreeToUse; relevant for destination in CopyTo and MoveTo) + if self.__sFile in CFile.__listFilesInUse: + raise Exception(f"The file '{self.__sFile}' is already in use by another CFile instance.") + else: + CFile.__listFilesInUse.append(self.__sFile) + + # eof def __init__(self, sFile=None): + + def __del__(self): + self.Close() + if self.__sFile in CFile.__listFilesInUse: + CFile.__listFilesInUse.remove(self.__sFile) + + # eof def __del__(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __bIsFreeToUse(self, sFile=None): + """ +Checks if the file ``sFile`` is free to use, that means: not used by another instance of ``CFile``. + """ + + bIsFreeToUse = False # init + if sFile is None: + bIsFreeToUse = False # error handling + else: + if sFile in CFile.__listFilesInUse: + bIsFreeToUse = False + else: + bIsFreeToUse = True + return bIsFreeToUse + + # eof def __bIsFreeToUse(self, sFile=None): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __OpenForWriting(self): + """ +Opens a text file for writing. + +Returns ``bSuccess`` and ``sResult`` (feedback). + """ + + sMethod = "CFile.__OpenForWriting" + + if self.__sFile is None: + bSuccess = False + sResult = "self.__sFile is None; please provide path and name of a file when creating a CFile object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + try: + self.__oFileHandle = open(self.__sFile, "w", encoding="utf-8") + self.__oFileStatus = enFileStatiType.openedforwriting + bSuccess = True + sResult = f"File '{self.__sFile}' is open for writing" + except Exception as reason: + self.Close() + bSuccess = None + sResult = f"Not possible to open file '{self.__sFile}' for writing.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def __OpenForWriting(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __OpenForAppending(self): + """ +Opens a text file for appending. + +Returns ``bSuccess`` and ``sResult`` (feedback). + """ + + sMethod = "CFile.__OpenForAppending" + + if self.__sFile is None: + bSuccess = False + sResult = "self.__sFile is None; please provide path and name of a file when creating a CFile object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + try: + self.__oFileHandle = open(self.__sFile, "a", encoding="utf-8") + self.__oFileStatus = enFileStatiType.openedforappending + bSuccess = True + sResult = f"File '{self.__sFile}' is open for appending" + except Exception as reason: + self.Close() + bSuccess = None + sResult = f"Not possible to open file '{self.__sFile}' for appending.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def __OpenForAppending(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __OpenForReading(self): + """ +Opens a text file for reading. + +Returns ``bSuccess`` and ``sResult`` (feedback). + """ + + sMethod = "CFile.__OpenForReading" + + if self.__sFile is None: + bSuccess = False + sResult = "self.__sFile is None; please provide path and name of a file when creating a CFile object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + try: + self.__oFileHandle = open(self.__sFile, "r", encoding="utf-8") + self.__oFileStatus = enFileStatiType.openedforreading + bSuccess = True + sResult = f"File '{self.__sFile}' is open for reading" + except Exception as reason: + self.Close() + bSuccess = None + sResult = f"Not possible to open file '{self.__sFile}' for reading.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def __OpenForReading(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Close(self): + """ +Closes the opened file. + +**Arguments:** + +(no args) + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFile.Close" + + if self.__oFileHandle is not None: + try: + self.__oFileHandle.flush() + self.__oFileHandle.close() + bSuccess = True + sResult = f"File '{self.__sFile}' closed" + except Exception as reason: + bSuccess = None + sResult = f"Exception while closing file '{self.__sFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + self.__oFileHandle = None + else: + bSuccess = True + sResult = "Done" + + self.__oFileStatus = enFileStatiType.closed + + return bSuccess, sResult + + # eof def Close(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Delete(self, bConfirmDelete=True): + """ +Deletes the current file. + +**Arguments:** + +* ``bConfirmDelete`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + Defines if it will be handled as error if the file does not exist. + + If ``True``: If the file does not exist, the method indicates an error (``bSuccess = False``). + + If ``False``: It doesn't matter if the file exists or not. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + + sMethod = "CFile.Delete" + + if self.__sFile is None: + bSuccess = False + sResult = "self.__sFile is None; please provide path and name of a file when creating a CFile object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isfile(self.__sFile) is False: + if bConfirmDelete is True: + bSuccess = False + else: + bSuccess = True + sResult = f"Nothing to delete. The file '{self.__sFile}' does not exist." + return bSuccess, sResult + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + try: + os.remove(self.__sFile) + bSuccess = True + sResult = f"File '{self.__sFile}' deleted." + except Exception as reason: + bSuccess = None + sResult = f"Exception while deleting file '{self.__sFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def Delete(self, bConfirmDelete=True): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __PrepareOutput(self, Content=""): + """ +Helper for ``Write`` and ``Append`` (consideration of composite data types). + +Returns a list of strings (that will be written to file). + """ + + listOut = [] + + if type(Content) == list: + for element in Content: + listOut.append(str(element)) + elif type(Content) == tuple: + for element in Content: + listOut.append(str(element)) + elif type(Content) == set: + for element in Content: + listOut.append(str(element)) + elif type(Content) == dict: + listKeys = Content.keys() + nRJust = 0 + for key in listKeys: + sKey = str(key) # because also numerical values can be keys + if len(sKey) > nRJust: + nRJust = len(sKey) + for key in listKeys: + sKey = str(key) # because also numerical values can be keys + sOut = sKey.rjust(nRJust, ' ') + " : " + str(Content[key]) + listOut.append(sOut) + elif str(type(Content)).lower().find('dotdict') >=0: + try: + listKeys = Content.keys() + nRJust = 0 + for key in listKeys: + sKey = str(key) # because also numerical values can be keys + if len(sKey) > nRJust: + nRJust = len(sKey) + for key in listKeys: + sKey = str(key) # because also numerical values can be keys + sOut = sKey.rjust(nRJust, ' ') + " : " + str(Content[key]) + listOut.append(sOut) + except Exception as reason: + listOut.append(str(Content)) + else: + listOut.append(str(Content)) + + return listOut + + # eof def __PrepareOutput(self, Content=""): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Write(self, Content="", nVSpaceAfter=0, sPrefix=None, bToScreen=False): + """ +Writes the content of a variable ``Content`` to file. + +**Arguments:** + +* ``Content`` + + / *Condition*: required / *Type*: one of: str, list, tuple, set, dict, dotdict / + + If ``Content`` is not a string, the ``Write`` method resolves the data structure before writing the content to file. + +* ``nVSpaceAfter`` + + / *Condition*: optional / *Type*: int / *Default*: 0 / + + Adds vertical space ``nVSpaceAfter`` (= number of blank lines) after ``Content``. + +* ``sPrefix`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + `sPrefix`` is added to every line of output (in case of ``sPrefix`` is not ``None``). + +* ``bToScreen`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + Prints ``Content`` also to screen (in case of ``bToScreen`` is ``True``). + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + + sMethod = "CFile.Write" + + if self.__oFileStatus != enFileStatiType.openedforwriting: + bSuccess, sResult = self.__OpenForWriting() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + listOut = self.__PrepareOutput(Content) + + for nCnt in range(nVSpaceAfter): + listOut.append("") + + if bToScreen is True: + for sOut in listOut: + if ( (sPrefix is not None) and (sOut != '') ): + sOut = f"{sPrefix}{sOut}" + print(sOut) + + bSuccess = True + sResult = "Done" + try: + for sOut in listOut: + if ( (sPrefix is not None) and (sOut != '') ): + sOut = f"{sPrefix}{sOut}" + self.__oFileHandle.write(sOut + "\n") + except Exception as reason: + bSuccess = None + sResult = f"Not possible to write to file '{self.__sFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def Write(self, Content="", nVSpaceAfter=0, sPrefix=None, bToScreen=False): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Append(self, Content="", nVSpaceAfter=0, sPrefix=None, bToScreen=False): + """ +Appends the content of a variable ``Content`` to file. + +**Arguments:** + +* ``Content`` + + / *Condition*: required / *Type*: one of: str, list, tuple, set, dict, dotdict / + + If ``Content`` is not a string, the ``Write`` method resolves the data structure before writing the content to file. + +* ``nVSpaceAfter`` + + / *Condition*: optional / *Type*: int / *Default*: 0 / + + Adds vertical space ``nVSpaceAfter`` (= number of blank lines) after ``Content``. + +* ``sPrefix`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + `sPrefix`` is added to every line of output (in case of ``sPrefix`` is not ``None``). + +* ``bToScreen`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + Prints ``Content`` also to screen (in case of ``bToScreen`` is ``True``). + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFile.Append" + + if self.__oFileStatus != enFileStatiType.openedforappending: + bSuccess, sResult = self.__OpenForAppending() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + listOut = self.__PrepareOutput(Content) + + for nCnt in range(nVSpaceAfter): + listOut.append("") + + if bToScreen is True: + for sOut in listOut: + if ( (sPrefix is not None) and (sOut != '') ): + sOut = f"{sPrefix}{sOut}" + print(sOut) + + bSuccess = True + sResult = "Done" + try: + for sOut in listOut: + if ( (sPrefix is not None) and (sOut != '') ): + sOut = f"{sPrefix}{sOut}" + self.__oFileHandle.write(sOut + "\n") + except Exception as reason: + bSuccess = None + sResult = f"Not possible to append to file '{self.__sFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def Append(self, Content="", nVSpaceAfter=0, sPrefix=None, bToScreen=False): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def ReadLines(self, + bCaseSensitive = True, + bSkipBlankLines = False, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None, + bLStrip = False, + bRStrip = True, + bToScreen = False): + """ +Reads content from current file. Returns an array of lines together with ``bSuccess`` and ``sResult`` (feedback). + +The method takes care of opening and closing the file. The complete file content is read by ``ReadLines`` in one step, +but with the help of further parameters it is possible to reduce the content by including and excluding lines. + +The logical join of all filter is: ``AND``. + +**Arguments:** + +* ``bCaseSensitive`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + * If ``True``, the standard filters work case sensitive, otherwise not. + * This has no effect to the regular expression based filters ``sInclRegEx`` and ``sExclRegEx``. + +* ``bSkipBlankLines`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True``, blank lines will be skipped, otherwise not. + +* ``sComment`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + In case of a line starts with the string ``sComment``, this line is skipped. + +* ``sStartsWith`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string starts with the string ``sStartsWith`` + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +* ``sEndsWith`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string ends with the string ``sEndsWith`` + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +* ``sStartsNotWith`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string starts not with the string ``sStartsNotWith`` + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +* ``sEndsNotWith`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string ends not with the string ``sEndsNotWith`` + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +* ``sContains`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string contains the string ``sContains`` at any position + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +* ``sContainsNot`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * The criterion of this filter is fulfilled in case of the input string does **not** contain the string ``sContainsNot`` at any position + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +* ``sInclRegEx`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * *Include* filter based on regular expressions (consider the syntax of regular expressions!) + * The criterion of this filter is fulfilled in case of the regular expression ``sInclRegEx`` matches the input string + * Leading and trailing blanks within the input string are considered + * ``bCaseSensitive`` has no effect + * A semicolon separated list of several regular expressions is **not** supported + +* ``sExclRegEx`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + * *Exclude* filter based on regular expressions (consider the syntax of regular expressions!) + * The criterion of this filter is fulfilled in case of the regular expression ``sExclRegEx`` does **not** match the input string + * Leading and trailing blanks within the input string are considered + * ``bCaseSensitive`` has no effect + * A semicolon separated list of several regular expressions is **not** supported + +* ``bLStrip`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True``, leading spaces are removed from line before the filters are used, otherwise not. + +* ``bRStrip`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + If ``True``, trailing spaces are removed from line before the filters are used, otherwise not. + +* ``bToScreen`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True``, the content read from file is also printed to screen, otherwise not. + """ + + sMethod = "CFile.ReadLines" + + listLines = [] + + if os.path.isfile(self.__sFile) is False: + bSuccess = False + sResult = f"The file '{self.__sFile}' does not exist." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return listLines, bSuccess, sResult + + # !!! independend from: self.__oFileStatus != enFileStatiType.openedforreading: !!! + # Reason: Repeated call of ReadLines needs to have the read pointer at the beginning of the file. + bSuccess, sResult = self.__OpenForReading() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return listLines, bSuccess, sResult + + try: + sFileContent = self.__oFileHandle.read() + except Exception as reason: + bSuccess = None + sResult = f"Not possible to read from file '{self.__sFile}'.\nReason: " + str(reason) + return listLines, bSuccess, sResult + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return listLines, bSuccess, sResult + + listFileContent = sFileContent.splitlines() # in opposite to readlines this is OS independend! + + for sLine in listFileContent: + if CString.StringFilter(sString = sLine, + bCaseSensitive = bCaseSensitive, + bSkipBlankStrings = bSkipBlankLines, + sComment = sComment, + sStartsWith = sStartsWith, + sEndsWith = sEndsWith, + sStartsNotWith = sStartsNotWith, + sEndsNotWith = sEndsNotWith, + sContains = sContains, + sContainsNot = sContainsNot, + sInclRegEx = sInclRegEx, + sExclRegEx = sExclRegEx, + bDebug = False) is True: + if bLStrip is True: + sLine = sLine.lstrip(" \t\r\n") + + if bRStrip is True: + sLine = sLine.rstrip(" \t\r\n") + + if bToScreen is True: + print(sLine) + + listLines.append(sLine) + + # eof for sLine in listFileContent: + + del listFileContent + + nNrOfLines = len(listLines) + + bSuccess = True + sResult = f"Read {nNrOfLines} lines from '{self.__sFile}'." + return listLines, bSuccess, sResult + + # eof def ReadLines(...) + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def GetFileInfo(self): + """ +Returns the following informations about the file (encapsulated within a dictionary ``dFileInfo``): + +**Returns:** + +* Key ``sFile`` + + / *Type*: str / + + Path and name of current file + + +* Key ``bFileIsExisting`` + + / *Type*: bool / + + ``True`` if file is existing, otherwise ``False`` + +* Key ``sFileName`` + + / *Type*: str / + + The name of the current file (incl. extension) + +* Key ``sFileExtension`` + + / *Type*: str / + + The extension of the current file + +* Key ``sFileNameOnly`` + + / *Type*: str / + + The pure name of the current file (without extension) + +* Key ``sFilePath`` + + / *Type*: str / + + The the path to current file + +* Key ``bFilePathIsExisting`` + + / *Type*: bool / + + ``True`` if file path is existing, otherwise ``False`` + """ + + sMethod = "CFile.GetFileInfo" + + dFileInfo = {} + dFileInfo['sFile'] = None + dFileInfo['bFileIsExisting'] = None + dFileInfo['sFileName'] = None + dFileInfo['sFileExtension'] = None + dFileInfo['sFileNameOnly'] = None + dFileInfo['sFilePath'] = None + dFileInfo['bFilePathIsExisting'] = None + + if self.__sFile is None: + return None + + dFileInfo['sFile'] = self.__sFile + dFileInfo['bFileIsExisting'] = os.path.isfile(self.__sFile) + + sFileName = os.path.basename(self.__sFile) + dFileInfo['sFileName'] = sFileName + + sFileExtension = "" + sFileNameOnly = "" + listParts = sFileName.split('.') + if len(listParts) > 1: + sFileExtension = listParts[len(listParts)-1] + sFileNameOnly = sFileName[:-len(sFileExtension)-1] + else: + sFileExtension = "" + sFileNameOnly = sFileName + + dFileInfo['sFileExtension'] = sFileExtension + dFileInfo['sFileNameOnly'] = sFileNameOnly + dFileInfo['sFilePath'] = os.path.dirname(self.__sFile) + dFileInfo['bFilePathIsExisting'] = os.path.isdir(dFileInfo['sFilePath']) + + return dFileInfo + + # eof def GetFileInfo(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def CopyTo(self, sDestination=None, bOverwrite=False): + """ +Copies the current file to ``sDestination``, that can either be a path without file name or a path together with a file name. + +In case of the destination file already exists and ``bOverwrite`` is ``True``, than the destination file will be overwritten. + +In case of the destination file already exists and ``bOverwrite`` is ``False`` (default), than the destination file will not be overwritten +and ``CopyTo`` returns ``bSuccess = False``. + +**Arguments:** + +* ``sDestination`` + + / *Condition*: required / *Type*: string / + + The path to destination file (either incl. file name or without file name) + +* ``bOverwrite`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + * In case of the destination file already exists and ``bOverwrite`` is ``True``, than the destination file will be overwritten. + * In case of the destination file already exists and ``bOverwrite`` is ``False`` (default), than the destination file will not be overwritten + and ``CopyTo`` returns ``bSuccess = False``. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFile.CopyTo" + + if self.__sFile is None: + bSuccess = False + sResult = "self.__sFile is None; please provide path and name of a file when creating a CFile object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isfile(self.__sFile) is False: + bSuccess = False + sResult = f"The file '{self.__sFile}' does not exist, therefore nothing can be copied." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if sDestination is None: + bSuccess = False + sResult = "sDestination is None; please provide path and name of destination file. Or at least the destination path. In this case the file name will be taken over." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + sDestination = CString.NormalizePath(sDestination) + + bDeleteDestFile = False + + sDestFile = sDestination # default + + if os.path.isdir(sDestination) is True: + sFileName = os.path.basename(self.__sFile) + sDestFile = f"{sDestination}/{sFileName}" # file name in destination is required for: shutil.copyfile + + if self.__bIsFreeToUse(sDestFile) is False: + bSuccess = False + sResult = f"The destination file '{sDestFile}' is already in use by another CFile instance." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + self.__sLastDestination = sDestFile + + if os.path.isfile(sDestFile) is True: + # destination file already exists + if sDestFile == self.__sFile: + bSuccess = False + sResult = f"Source file and destination file are the same: '{self.__sFile}'. Therefore nothing to do." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if bOverwrite is True: + bDeleteDestFile = True + else: + bSuccess = False + sResult = f"Not allowed to overwrite existing destination file '{sDestFile}'. Therefore nothing to do." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + else: + # destination file not yet exists + # (we assume here that the destination shall be a file because we already have figured out that the destination is not a folder) + # => we have to check if the path to the file exists + sDestFilePath = os.path.dirname(sDestFile) + if os.path.isdir(sDestFilePath) is True: + bDeleteDestFile = False + else: + bSuccess = False + sResult = f"The destination path '{sDestFilePath}' does not exist. The file '{self.__sFile}' cannot be copied." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + # eof else - if os.path.isfile(sDestFile) is True: + + # analysis done, now the action + + bSuccess, sResult = self.Close() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if bDeleteDestFile is True: + # To delete the destination file explicitely before executing any copy-function is an addon here in this library. + # The purpose is to be independend from the way the used copy function is handling existing destination files. + # But this makes only sense under Windows and not under Linux, because Windows is much more strict with access + # violations than Linux. Therefore we avoid such kind of additional steps in case of the platform is not Windows. + if platform.system() == "Windows": + try: + os.remove(sDestFile) + bSuccess = True + sResult = f"File '{sDestFile}' deleted." + except Exception as reason: + bSuccess = None + sResult = f"Exception while deleting destination file '{sDestFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + # eof if bDeleteDestFile is True: + + try: + shutil.copyfile(self.__sFile, sDestFile) + bSuccess = True + sResult = f"File '{self.__sFile}' copied to '{sDestFile}'." + except Exception as reason: + bSuccess = None + sResult = f"Exception while copying file '{self.__sFile}' to '{sDestFile}'.\nReason: " + str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def CopyTo(self, sDestination=None, bOverwrite=False): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def MoveTo(self, sDestination=None, bOverwrite=False): + """ +Moves the current file to ``sDestination``, that can either be a path without file name or a path together with a file name. + +**Arguments:** + +* ``sDestination`` + + / *Condition*: required / *Type*: string / + + The path to destination file (either incl. file name or without file name) + +* ``bOverwrite`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + * In case of the destination file already exists and ``bOverwrite`` is ``True``, than the destination file will be overwritten. + * In case of the destination file already exists and ``bOverwrite`` is ``False`` (default), than the destination file will not be overwritten + and ``MoveTo`` returns ``bSuccess = False``. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation was successful or not + +* ``sResult`` + + / *Type*: str / + + Contains details about what happens during computation + """ + sMethod = "CFile.MoveTo" + + bSuccess, sResult = self.CopyTo(sDestination, bOverwrite) + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isfile(self.__sLastDestination) is False: + # the copied file should exist at new location + bSuccess = None + sResult = f"Someting went wrong while copying the file '{self.__sFile}' to '{self.__sLastDestination}'. Aborting." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + else: + bSuccess, sResult = self.Delete() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + bSuccess = True + sResult = f"File moved from '{self.__sFile}' to '{self.__sLastDestination}'" + return bSuccess, sResult + + # eof def MoveTo(self, sDestination=None, bOverwrite=False): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + +# eof class CFile(object): + +# ************************************************************************************************************** + + diff --git a/additions/PythonExtensionsCollection/File/__init__.py b/additions/PythonExtensionsCollection/File/__init__.py new file mode 100644 index 00000000..958420af --- /dev/null +++ b/additions/PythonExtensionsCollection/File/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/additions/PythonExtensionsCollection/Folder/CFolder.py b/additions/PythonExtensionsCollection/Folder/CFolder.py new file mode 100644 index 00000000..451c32f9 --- /dev/null +++ b/additions/PythonExtensionsCollection/Folder/CFolder.py @@ -0,0 +1,460 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# CFolder.py +# +# XC-CT/ECA3-Queckenstedt +# +# 28.06.2022 +# +# ************************************************************************************************************** + +# -- import standard Python modules +import os, shutil, time, stat + +# -- import Bosch Python modules +from PythonExtensionsCollection.String.CString import CString + +# -------------------------------------------------------------------------------------------------------------- + +# little helper to delete folders containing files that are write protected +def rm_dir_readonly(func, path, excinfo): + """ +Calls ``os.chmod`` in case of ``shutil.rmtree`` (within ``Delete()``) throws an exception (making files writable). + """ + # print(f"{excinfo}") # debug only + os.chmod(path, stat.S_IWRITE) + func(path) + +# -------------------------------------------------------------------------------------------------------------- + +class CFolder(object): + """ +The class ``CFolder`` provides a small set of folder functions with extended parametrization (like switches +defining if a folder is allowed to be overwritten or not). + +Most of the functions at least returns ``bSuccess`` and ``sResult``. + +* ``bSuccess`` is ``True`` in case of no error occurred. +* ``bSuccess`` is ``False`` in case of an error occurred. +* ``bSuccess`` is ``None`` in case of a very fatal error occurred (exceptions). + +* ``sResult`` contains details about what happens during computation. + +Every instance of CFolder handles one single folder only and forces exclusive access to this folder. + +It is not possible to create an instance of this class with a folder that is already in use by another instance. + +The constructor of ``CFolder`` requires the input parameter ``sFolder``, that is the path and the name of a folder +that is handled by the current class instance. + """ + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __init__(self, sFolder=None): + self.__sFolder = CString.NormalizePath(sFolder) + + try: + CFolder.__listFoldersInUse + except: + CFolder.__listFoldersInUse = [] + + # exclusive access is required (checked by self.__bIsFreeToUse; relevant for destination in CopyTo and MoveTo) + if self.__sFolder in CFolder.__listFoldersInUse: + raise Exception(f"The folder '{self.__sFolder}' is already in use by another CFolder instance.") + else: + CFolder.__listFoldersInUse.append(self.__sFolder) + + # eof def __init__(self, sFolder=None): + + def __del__(self): + if self.__sFolder in CFolder.__listFoldersInUse: + CFolder.__listFoldersInUse.remove(self.__sFolder) + + # eof def __del__(self): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __bIsFreeToUse(self, sFolder=None): + """ +Checks if the folder ``sFolder`` is free to use, that means: not used by another instance of ``CFolder``. + """ + + bIsFreeToUse = False # init + if sFolder is None: + bIsFreeToUse = False # error handling + else: + if sFolder in CFolder.__listFoldersInUse: + bIsFreeToUse = False + else: + bIsFreeToUse = True + return bIsFreeToUse + + # eof def __bIsFreeToUse(self, sFolder=None): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def __Delete(self, sFolder=None, bConfirmDelete=True): + """ +Deletes the folder ``sFolder``. + +**Arguments:** + +* ``sFolder`` + + / *Condition*: required / *Type*: str / + + Path and name of folder to be deleted + +* ``bConfirmDelete`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + Defines if it will be handled as error if the folder does not exist. + + If ``True``: If the folder does not exist, the method indicates an error (``bSuccess = False``). + + If ``False``: It doesn't matter if the folder exists or not. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFolder.__Delete" + + if sFolder is None: + bSuccess = False + sResult = "sFolder is None; please provide path and name of a folder when creating a CFolder object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isdir(sFolder) is False: + sResult = f"Nothing to delete. The folder '{sFolder}' does not exist." + if bConfirmDelete is True: + bSuccess = False + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + else: + bSuccess = True + return bSuccess, sResult + # eof if os.path.isdir(sFolder) is False: + + bSuccess = False + sResult = "UNKNOWN" + nCntTries = 1 + nTriesMax = 4 + nDelay = 2 # sec + listResults = [] + while nCntTries <= nTriesMax: + try: + print(f"Trying to delete '{sFolder}'") + print() + shutil.rmtree(sFolder, ignore_errors=False, onerror=rm_dir_readonly) + except Exception as reason: + listResults.append(str(reason)) + if os.path.isdir(sFolder) is True: + sResult = f"({nCntTries}/{nTriesMax}) Problem with deleting the folder '{sFolder}'. Folder still present." + listResults.append(sResult) + time.sleep(nDelay) # delay before next try + else: + bSuccess = True + sResult = f"Folder '{sFolder}' deleted." + break + nCntTries = nCntTries + 1 + # eof while nCntTries <= nTriesMax: + + if bSuccess is False: + sResult = "\n".join(listResults) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def __Delete(self, sFolder=None, bConfirmDelete=True): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Delete(self, bConfirmDelete=True): + """ +Deletes the folder the current class instance contains. + +**Arguments:** + +* ``bConfirmDelete`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + Defines if it will be handled as error if the folder does not exist. + + If ``True``: If the folder does not exist, the method indicates an error (``bSuccess = False``). + + If ``False``: It doesn't matter if the folder exists or not. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFolder.Delete" + bSuccess, sResult = self.__Delete(self.__sFolder, bConfirmDelete) + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + # eof def Delete(self, bConfirmDelete=True): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def Create(self, bOverwrite=False, bRecursive=False): + """ +Creates the current folder ``sFolder``. + +**Arguments:** + +* ``bOverwrite`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + * In case of the folder already exists and ``bOverwrite`` is ``True``, than the folder will be deleted before creation. + * In case of the folder already exists and ``bOverwrite`` is ``False`` (default), than the folder will not be touched. + + In both cases the return value ``bSuccess`` is ``True`` - because the folder exists. + +* ``bRecursive`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + * In case of ``bRecursive`` is ``True``, than the complete destination path will be created (including all intermediate subfolders). + * In case of ``bRecursive`` is ``False``, than it is expected that the parent folder of the new folder already exists. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFolder.Create" + + if self.__sFolder is None: + bSuccess = False + sResult = "self.__sFolder is None; please provide path and name of a folder when creating a CFolder object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + bCreateFolder = False + if os.path.isdir(self.__sFolder) is True: + if bOverwrite is True: + bSuccess, sResult = self.Delete() + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + bCreateFolder = True + else: + bSuccess = True + sResult = f"Folder '{self.__sFolder}' already exists." + return bSuccess, sResult + else: + bCreateFolder = True + + bSuccess = False + sResult = "UNKNOWN" + + if bCreateFolder is True: + nCntTries = 1 + nTriesMax = 3 + nDelay = 2 # sec + listResults = [] + while nCntTries <= nTriesMax: + try: + print(f"Trying to create '{self.__sFolder}'") + print() + if bRecursive is True: + os.makedirs(self.__sFolder) + else: + os.mkdir(self.__sFolder) + except Exception as reason: + listResults.append(str(reason)) + if os.path.isdir(self.__sFolder) is False: + sResult = f"({nCntTries}/{nTriesMax}) Problem with creating the folder '{self.__sFolder}'." + listResults.append(sResult) + time.sleep(nDelay) # delay before next try + else: + bSuccess = True + sResult = f"Folder '{self.__sFolder}' created." + break + nCntTries = nCntTries + 1 + # eof while nCntTries <= nTriesMax: + + if bSuccess is False: + sResult = "\n".join(listResults) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + # eof if bCreateFolder is True: + + return bSuccess, sResult + + # eof def Create(self, bOverwrite=False, bRecursive=False): + + # -------------------------------------------------------------------------------------------------------------- + # TM*** + + def CopyTo(self, sDestination=None, bOverwrite=False): + """ +Copies the current folder to ``sDestination``, that has to be a path to a folder **within** the source folder will be copied to +(with it's original name), + +In case of the destination folder already exists and ``bOverwrite`` is ``True``, than the destination folder will be overwritten. + +In case of the destination folder already exists and ``bOverwrite`` is ``False`` (default), than the destination folder will not be overwritten +and ``CopyTo`` returns ``bSuccess = False``. + +**Arguments:** + +* ``sDestination`` + + / *Condition*: required / *Type*: string / + + The path to destination folder + +* ``bOverwrite`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + * In case of the destination folder already exists and ``bOverwrite`` is ``True``, than the destination folder will be overwritten. + * In case of the destination folder already exists and ``bOverwrite`` is ``False`` (default), than the destination folder will not be overwritten + and ``CopyTo`` returns ``bSuccess = False``. + +**Returns:** + +* ``bSuccess`` + + / *Type*: bool / + + Indicates if the computation of the method was successful or not. + +* ``sResult`` + + / *Type*: str / + + The result of the computation of the method. + """ + sMethod = "CFolder.CopyTo" + + if self.__sFolder is None: + bSuccess = False + sResult = "self.__sFolder is None; please provide path and name of a folder when creating a CFolder object." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isdir(self.__sFolder) is False: + bSuccess = False + sResult = f"The folder '{self.__sFolder}' does not exist, therefore nothing can be copied." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if sDestination is None: + bSuccess = False + sResult = "sDestination is None; please provide a path to a destination folder." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + sDestination = CString.NormalizePath(sDestination) + + if os.path.isdir(sDestination) is False: + # the folder to be copied will be created within the destination folder, therefore we expect that the destination folder already exists + bSuccess = False + sResult = f"The destination folder '{sDestination}' does not exist." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + sSourceFolderName = os.path.basename(self.__sFolder) + sDestFolder = f"{sDestination}/{sSourceFolderName}" + + if sDestFolder == self.__sFolder: + bSuccess = False + sResult = f"Source folder and destination folder are the same: '{self.__sFolder}'. Therefore nothing to do." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if self.__bIsFreeToUse(sDestFolder) is False: + bSuccess = False + sResult = f"The destination folder '{sDestFolder}' is already in use by another CFolder instance." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + + if os.path.isdir(sDestFolder) is True: + # destination folder already exists + if bOverwrite is True: + bSuccess, sResult = self.__Delete(sDestFolder) + if bSuccess is not True: + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + else: + bSuccess = False + sResult = f"Not allowed to overwrite existing destination folder '{sDestFolder}'. Therefore nothing to do." + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + return bSuccess, sResult + # eof if os.path.isdir(sDestFolder) is True: + + # analysis and preconditions done, now the action + + try: + shutil.copytree(self.__sFolder, sDestFolder) + bSuccess = True + sResult = "Folder copied from\n> '" + self.__sFolder + "'\nto\n> '" + sDestFolder + "'" + except Exception as reason: + bSuccess = None + sResult = str(reason) + sResult = CString.FormatResult(sMethod, bSuccess, sResult) + + return bSuccess, sResult + + # eof def CopyTo(self, sDestination=None, bOverwrite=False): + +# -------------------------------------------------------------------------------------------------------------- + + diff --git a/additions/PythonExtensionsCollection/Folder/__init__.py b/additions/PythonExtensionsCollection/Folder/__init__.py new file mode 100644 index 00000000..958420af --- /dev/null +++ b/additions/PythonExtensionsCollection/Folder/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/additions/PythonExtensionsCollection/String/CString.py b/additions/PythonExtensionsCollection/String/CString.py new file mode 100644 index 00000000..82aeb204 --- /dev/null +++ b/additions/PythonExtensionsCollection/String/CString.py @@ -0,0 +1,1165 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# CString.py +# +# XC-CT/ECA3-Queckenstedt +# +# 02.06.2022 +# +# ************************************************************************************************************** + +# -- import standard Python modules +import os, ntpath, re + +# ************************************************************************************************************** + +class CString(object): + """ +The class ``CString`` contains some string computation methods like e.g. normalizing a path. + """ + + # -------------------------------------------------------------------------------------------------------------- + #TM*** + + def NormalizePath(sPath=None, bWin=False, sReferencePathAbs=None, bConsiderBlanks=False, bExpandEnvVars=True, bMask=True): + """ +Normalizes local paths, paths to local network resources and internet addresses + +**Arguments:** + +* ``sPath`` + + / *Condition*: required / *Type*: str / + + The path to be normalized + +* ``bWin`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True`` then returned path contains masked backslashes as separator, otherwise slashes + +* ``sReferencePathAbs`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + In case of ``sPath`` is relative and ``sReferencePathAbs`` (expected to be absolute) is given, then + the returned absolute path is a join of both input paths + +* ``bConsiderBlanks`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True`` then the returned path is encapsulated in quotes - in case of the path contains blanks + +* ``bExpandEnvVars`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + If ``True`` then in the returned path environment variables are resolved, otherwise not. + +* ``bMask`` + + / *Condition*: optional / *Type*: bool / *Default*: True (requires ``bWin=True``)/ + + * If ``bWin`` is ``True`` and ``bMask`` is ``True`` then the returned path contains masked backslashes as separator. + * If ``bWin`` is ``True`` and ``bMask`` is ``False`` then the returned path contains single backslashes only - this might be + required for applications, that are not able to handle masked backslashes. + * In case of ``bWin`` is ``False`` ``bMask`` has no effect. + +**Returns:** + +* ``sPath`` + + / *Type*: str / + + The normalized path (is ``None`` in case of ``sPath`` is ``None``) + """ + + if sPath is not None: + + # -- expand Windows environment variables + if bExpandEnvVars is True: + sPath = os.path.expandvars(sPath) + + # - remove leading and trailing horizontal space + sPath = sPath.strip(" \t\r\n") + + # - remove leading and trailing quotes + sPath = sPath.strip("\"'") + + # - remove once more leading and trailing horizontal space + # (after the removal of leading and trailing quotes further horizontal space might be there, that has to be removed; + # but further levels of nesting are not considered) + sPath = sPath.strip(" \t") + + if sPath == "": + return sPath + + # - remove trailing slash or backslash (maybe at end of path to folder) + sPath = sPath.rstrip("/\\") + + # -------------------------------------------------------------------------------------------------------------- + # consider internet addresses and local network resources + # -------------------------------------------------------------------------------------------------------------- + # -- local network resource / file server + # (prepare for Windows explorer) + # either (default) + # //server.com/abc/xyz + # or (with bWin=True); bMask must be False because \\server.com\\abc\\xyz is not allowed + # \\server.com\abc\xyz + # (=> user is allowed to select bWin but not bMask) + # + # -- local network resource / file server + # (prepare for web browser) + # after 'file://///' only single slashes allowed; bWin and bMask must be False + # file://///server.com/abc/xyz + # (=> user is NOT allowed to select bWin and bMask) + # + # -- internet address + # after server name only single slashes allowed; bWin and bMask must be False + # http://server.com/abc/xyz + # https://server.com/abc/xyz + # (=> user is NOT allowed to select bWin and bMask) + # + # - not allowed (=> this method must not return this format): + # http:\\server.com + # https:\\server.com + # -------------------------------------------------------------------------------------------------------------- + + sPathPrefix = None + + # In case there is any prefix, we remove this prefix, we compute the remaining part of the path separately, + # we also modify this prefix manually, and at the end we put the new prefix back to the path. + + if ( (sPath[:2] == "\\\\") or (sPath[:2] == "//") ): + sPath = sPath[2:] + if bWin is True: + sPathPrefix = "\\\\" + else: + sPathPrefix = "//" + bMask = False # !!! this overrules the input parameter value, because masked backslashes are not allowed in remaining path !!! + elif sPath[:10] == "file://///": # exactly this must be given; all other combinations of slashes and backslashes are not handled + sPath = sPath[10:] + sPathPrefix = "file://///" + bWin = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + bMask = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + elif ( (sPath[:7] == "http://") or (sPath[:7] == "http:\\\\") ): + sPath = sPath[7:] + sPathPrefix = "http://" + bWin = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + bMask = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + elif ( (sPath[:8] == "https://") or (sPath[:8] == "https:\\\\") ): + sPath = sPath[8:] + sPathPrefix = "https://" + bWin = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + bMask = False # !!! this overrules the input parameter value, because only single slashes allowed in remaining path !!! + else: + # Internet addresses and local network resources handled, now checking for relative paths: + # In case of sPath is a relative path AND an absolute reference path is provided + # merge them to an absolute path; without reference path use standard function to + # convert relative path to absolute path + if ( (sPath[0] != "%") and (sPath[0] != "$") ): + # If sPath starts with '%' or with '$' it is assumed that the path starts with an environment variable (Windows or Linux). + # But in this case 'os.path.isabs(sPath)' will not detect this to be an absolute path and will call + # 'sPath = os.path.abspath(sPath)' (depending on sReferencePathAbs). This will accidently merge + # the root path together with the path starting with the environment variable and cause invalid results. + if os.path.isabs(sPath) is False: + if sReferencePathAbs is not None: + sPath = os.path.join(sReferencePathAbs, sPath) + else: + sPath = os.path.abspath(sPath) + + # eof computation of sPathPrefix + + # - normalize the path (collapse redundant separators and up-level references) + # on Windows this converts slashes to backward slashes + # sPath = os.path.normpath(sPath) # under Linux this unfortunately keeps redundant separators (in opposite to Windows) + # -- alternative + sPath = ntpath.normpath(sPath) + + # - exchange single backslashes by single slashes (= partly we have to repair the outcome of normpath) + if bWin is False: + sPath = sPath.replace("\\", "/") + else: + if bMask is True: + sPath = sPath.replace("\\", "\\\\") + + # - restore the path prefix + if sPathPrefix is not None: + sPath = f"{sPathPrefix}{sPath}" + + # - consider blanks (prepare path for usage in Windows command line) + if bConsiderBlanks is True: + if sPath.find(" ") >= 0: + sPath = f"\"{sPath}\"" + + # eof if sPath is not None: + + return sPath + + # eof NormalizePath(sPath=None, bWin=False, sReferencePathAbs=None, bConsiderBlanks=False, bExpandEnvVars=True, bMask=True) + + # -------------------------------------------------------------------------------------------------------------- + #TM*** + + def DetectParentPath(sStartPath=None, sFolderName=None, sFileName=None): + """ +Computes the path to any parent folder inside a given path. Optionally DetectParentPath is able +to search for files inside the parent folder. + +**Arguments:** + +* ``sStartPath`` + + / *Condition*: required / *Type*: str / + + The path in which to search for a parent folder + +* ``sFolderName`` + + / *Condition*: required / *Type*: str / + + The name of the folder to search for within ``sStartPath``. It is possible to provide more than one folder name separated by semicolon + +* ``sFileName`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + The name of a file to search within the detected parent folder + +**Returns:** + +* ``sDestPath`` + + / *Type*: str / + + Path and name of parent folder found inside ``sStartPath``, ``None`` in case of ``sFolderName`` is not found inside ``sStartPath``. + In case of more than one parent folder is found ``sDestPath`` contains the first result and ``listDestPaths`` contains all results. + +* ``listDestPaths`` + + / *Type*: list / + + If ``sFolderName`` contains a single folder name this list contains only one element that is ``sDestPath``. + In case of ``FolderName`` contains a semicolon separated list of several folder names this list contains all found paths of the given folder names. + ``listDestPaths`` is ``None`` (and not an empty list!) in case of ``sFolderName`` is not found inside ``sStartPath``. + +* ``sDestFile`` + + / *Type*: str / + + Path and name of ``sFileName``, in case of ``sFileName`` is given and found inside ``listDestPaths``. + In case of more than one file is found ``sDestFile`` contains the first result and ``listDestFiles`` contains all results. + ``sDestFile`` is ``None`` in case of ``sFileName`` is ``None`` and also in case of ``sFileName`` is not found inside ``listDestPaths`` + (and therefore also in case of ``sFolderName`` is not found inside ``sStartPath``). + +* ``listDestFiles`` + + / *Type*: list / + + Contains all positions of ``sFileName`` found inside ``listDestPaths``. + + ``listDestFiles`` is ``None`` (and not an empty list!) in case of ``sFileName`` is ``None`` and also in case of ``sFileName`` + is not found inside ``listDestPaths`` (and therefore also in case of ``sFolderName`` is not found inside ``sStartPath``). + +* ``sDestPathParent`` + + / *Type*: str / + + The parent folder of ``sDestPath``, ``None`` in case of ``sFolderName`` is not found inside ``sStartPath`` (``sDestPath`` is ``None``). + """ + + sDestPath = None + listDestPaths = None + sDestFile = None + listDestFiles = None + sDestPathParent = None + + if sStartPath is None: + return sDestPath, listDestPaths, sDestFile, listDestFiles, sDestPathParent + + if sFolderName is None: + return sDestPath, listDestPaths, sDestFile, listDestFiles, sDestPathParent + + sStartPath = sStartPath.strip() + if sStartPath == "": + return sDestPath, listDestPaths, sDestFile, listDestFiles, sDestPathParent + + sFolderName = sFolderName.strip() + if sFolderName == "": + return sDestPath, listDestPaths, sDestFile, listDestFiles, sDestPathParent + + listSplit = sFolderName.split(';') + + listTopLevelFolders = [] + for sFolder in listSplit: + # removing duplicates + sFolder = sFolder.strip() + if sFolder != "": + if sFolder not in listTopLevelFolders: + listTopLevelFolders.append(sFolder) + # eof for sFolder in listSplit: + + nNrOfFolders = len(listTopLevelFolders) + sStartPath = CString.NormalizePath(sStartPath) + listLevels = sStartPath.split("/") + + listDestPaths = [] + + while len(listLevels) > 0: + # -- merging paths with folder names and search for existing combinations + sPathParent = "/".join(listLevels) + for sTLFolder in listTopLevelFolders: + sSubPath = sPathParent + "/" + sTLFolder + if os.path.isdir(sSubPath) is True: + listDestPaths.append(sSubPath) + if len(listTopLevelFolders) == len(listDestPaths): + # all folders found + break + else: + listLevels.pop() + # eof while len(listLevels) > 0: + + sDestPath = None + sDestPathParent = None + if len(listDestPaths) > 0: + # -- returning sDestPath and sDestPathParent related to first entry in list; just to return anything else than None + sDestPath = listDestPaths[0] + sDestPathParent = CString.NormalizePath(os.path.dirname(sDestPath)) + + # -- optionally searching also for a single file + # Input: file name + # Output: full path of file and list of full paths of files (!!! limited to 'listDestPaths' !!!) + + listDestFiles = [] + + if ( (sFileName is not None) and (len(listDestPaths) > 0) ): + for sDestPathToWalk in listDestPaths: + for sLocalRootPath, listFolderNames, listFileNames in os.walk(sDestPathToWalk): + for sFileNameTmp in listFileNames: + if sFileNameTmp == sFileName: + sFile = CString.NormalizePath(os.path.join(sLocalRootPath, sFileName)) + listDestFiles.append(sFile) + # eof for sLocalRootPath, listFolderNames, listFileNames in os.walk(sDestPathToWalk): + # eof for sDestPathToWalk in listDestPaths: + # eof if ( (sFileName is not None) and (len(listDestPaths) > 0) ): + + if len(listDestFiles) > 0: + listDestFiles.sort() + sDestFile = listDestFiles[0] # just to return anything else than None + + # -- preparing output (setting empty lists to None, to have unique criteria for results not available) + if listDestPaths is not None: + if len(listDestPaths) == 0: + listDestPaths = None + if listDestFiles is not None: + if len(listDestFiles) == 0: + listDestFiles = None + + return sDestPath, listDestPaths, sDestFile, listDestFiles, sDestPathParent + + # eof def DetectParentPath(sStartPath=None, sFolderName=None, sFileName=None): + + # -------------------------------------------------------------------------------------------------------------- + #TM*** + + def StringFilter(sString = None, + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None, + bDebug = False): + """ +During the computation of strings there might occur the need to get to know if this string fulfils certain criteria or not. +Such a criterion can e.g. be that the string contains a certain substring. Also an inverse logic might be required: +In this case the criterion is that the string does **not** contain this substring. + +It might also be required to combine several criteria to a final conclusion if in total the criterion for a string is fulfilled or not. +For example: The string must start with the string *prefix* and must also contain either the string *substring1* or the string *substring2* +but must also **not** end with the string *suffix*. + +This method provides a bunch of predefined filters that can be used singly or combined to come to a final conclusion if the string fulfils all criteria or not. + +The filters are divided into three different types: + +1. Filters that are interpreted as raw strings (called 'standard filters'; no wild cards supported) +2. Filters that are interpreted as regular expressions (called 'regular expression based filters'; the syntax of regular expressions has to be considered) +3. Boolean switches (e.g. indicating if also an empty string is accepted or not) + +The input string might contain leading and trailing blanks and tabs. This kind of horizontal space is removed from the input string +before the standard filters start their work (except the regular expression based filters). + +The regular expression based filters consider the original input string (including the leading and trailing space). + +The outcome is that in case of the leading and trailing space shall be part of the criterion, the regular expression based filters can be used only. + +It is possible to decide if the standard filters shall work case sensitive or not. This decision has no effect on the regular expression based filters. + +The regular expression based filters always work with the original input string that is not modified in any way. + +Except the regular expression based filters it is possible to provide more than one string for every standard filter (must be a semikolon separated list in this case). +A semicolon that shall be part of the search string, has to be masked in this way: ``\;``. + +This method returns a boolean value that is ``True`` in case of all criteria are fulfilled, and ``False`` in case of some or all of them are not fulfilled. + +The default value for all filters is ``None`` (except ``bSkipBlankStrings``). In case of a filter value is ``None`` this filter has no influence on the result. + +In case of all filters are ``None`` (default) the return value is ``True`` (except the string itself is ``None`` +or the string is empty and ``bSkipBlankStrings`` is ``True``). + +In case of the string is ``None``, the return value is ``False``, because nothing concrete can be done with ``None`` strings. + +Internally every filter has his own individual acknowledge that indicates if the criterion of this filter is fulfilled or not. + +The meaning of *criterion fulfilled* of a filter is that the filter supports the final return value ``bAck`` of this method with ``True``. + +The final return value ``bAck`` of this method is a logical join (``AND``) of all individual acknowledges (except ``bSkipBlankStrings`` and ``sComment``; +in case of their criteria are **not** fulfilled, immediately ``False`` is returned). + +Summarized: + +* Filters are used to define *criteria* +* The return value of this method provides the *conclusion* - indicating if all criteria are fulfilled or not + +The following filters are available: +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +**bSkipBlankStrings** + + * Like already mentioned above leading and trailing spaces are removed from the input string at the beginning + * In case of the result is an empty string and ``bSkipBlankStrings`` is ``True``, the method immediately returns ``False`` + and all other filters are ignored + +**sComment** + + * In case of the input string starts with the string ``sComment``, the method immediately returns ``False`` + and all other filters are ignored + * Leading blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * The idea behind this decision is: Ignore a string that is commented out + +**sStartsWith** + + * The criterion of this filter is fulfilled in case of the input string starts with the string ``sStartsWith`` + * Leading blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +**sEndsWith** + + * The criterion of this filter is fulfilled in case of the input string ends with the string ``sEndsWith`` + * Trailing blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +**sStartsNotWith** + + * The criterion of this filter is fulfilled in case of the input string does **not** start with the string ``sStartsNotWith`` + * Leading blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +**sEndsNotWith** + + * The criterion of this filter is fulfilled in case of the input string does **not** end with the string ``sEndsNotWith`` + * Trailing blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +**sContains** + + * The criterion of this filter is fulfilled in case of the input string contains the string ``sContains`` at any position + * Leading and trailing blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``OR``) + +**sContainsNot** + + * The criterion of this filter is fulfilled in case of the input string does **not** contain the string ``sContainsNot`` at any position + * Leading and trailing blanks within the input string have no effect + * The decision also depends on ``bCaseSensitive`` + * More than one string can be provided (semicolon separated; logical join: ``AND``) + +**sInclRegEx** + + * *Include* filter based on regular expressions (consider the syntax of regular expressions!) + * The criterion of this filter is fulfilled in case of the regular expression ``sInclRegEx`` matches the input string + * Leading and trailing blanks within the input string are considered + * ``bCaseSensitive`` has no effect + * A semicolon separated list of several regular expressions is **not** supported + +**sExclRegEx** + + * *Exclude* filter based on regular expressions (consider the syntax of regular expressions!) + * The criterion of this filter is fulfilled in case of the regular expression ``sExclRegEx`` does **not** match the input string + * Leading and trailing blanks within the input string are considered + * ``bCaseSensitive`` has no effect + * A semicolon separated list of several regular expressions is **not** supported + +**Further arguments:** + +* ``sString`` + + / *Condition*: required / *Type*: str / + + The input string that has to be investigated. + +* ``bCaseSensitive`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + If ``True``, the standard filters work case sensitive, otherwise not. + +* ``bDebug`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True``, additional output is printed to console (e.g. the decision of every single filter), otherwise not. + +**Returns:** + +* ``bAck`` + + / *Type*: bool / + + Final statement about the input string ``sString`` after filter computation + +Examples: +~~~~~~~~~ + +1. Returns ``True``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = "Sp", + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = "beats", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + +2. Returns ``False``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = "Sp", + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = "minute", + sContains = "beats", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + +3. Returns ``True``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = "Beats", + sInclRegEx = None, + sExclRegEx = None) + +4. Returns ``True``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = r"\d{2}", + sExclRegEx = None) + +5. Returns ``False``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = "Speed", + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = r"\d{3}", + sExclRegEx = None) + +6. Returns ``False``: + +.. code:: python + + StringFilter(sString = "Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = "Speed", + sEndsWith = "minute", + sStartsNotWith = "speed", + sEndsNotWith = None, + sContains = "beats", + sContainsNot = None, + sInclRegEx = r"\d{2}", + sExclRegEx = r"\d{2}") + +7. Returns ``False``: + +.. code:: python + + StringFilter(sString = " ", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + +8. Returns ``False``: + +.. code:: python + + StringFilter(sString = "# Speed is 25 beats per minute", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = "#", + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = "beats", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + + +9. Returns ``False``: + +.. code:: python + + StringFilter(sString = " Alpha is not beta; and beta is not gamma ", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = " Alpha ", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + +Because blanks around search strings (here ``" Alpha "``) are considered, whereas the blanks around the input string are removed before computation. +Therefore ``" Alpha "`` cannot be found within the (shortened) input string. + + +10. This alternative solution returns ``True``: + +.. code:: python + + StringFilter(sString = " Alpha is not beta; and beta is not gamma ", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = None, + sContainsNot = None, + sInclRegEx = r"\s{3}Alpha", + sExclRegEx = None) + + +11. Returns ``True``: + +.. code:: python + + StringFilter(sString = "Alpha is not beta; and beta is not gamma", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = "beta; and", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + +The meaning of ``"beta; and"`` is: The criterion is fulfilled in case of either ``"beta"`` or ``" and"`` can be found. That's ``True`` in this example - but this +has nothing to do with the fact, that also this string ``"beta; and"`` can be found. Here the semikolon is a separator character and therefore part of the syntax. + +A semicolon that shall be part of the search string, has to be masked with '``\;``'! + +The meaning of ``"beta\; not"`` in the following example is: The criterion is fulfilled in case of ``"beta; not"`` can be found. + +That's **not** ``True``. Therefore the method returns ``False``: + +.. code:: python + + StringFilter(sString = "Alpha is not beta; and beta is not gamma", + bCaseSensitive = True, + bSkipBlankStrings = True, + sComment = None, + sStartsWith = None, + sEndsWith = None, + sStartsNotWith = None, + sEndsNotWith = None, + sContains = r"beta\; not", + sContainsNot = None, + sInclRegEx = None, + sExclRegEx = None) + """ + + if sString is None: + return False # hard coded here; no separate filter for that decision + + # The original string 'sString' is used by regular expression filters sInclRegEx and sExclRegEx. + # The stripped string 'sStringStripped' is used by all other filters. + sStringStripped = sString.strip(" \t\r\n") + + # -- skipping blank strings or strings commented out; other filters will not be considered any more in this case + + if bSkipBlankStrings is True: + if sStringStripped == "": + return False + + if sComment is not None: + if sComment != "": + if bCaseSensitive is True: + if sStringStripped.startswith(sComment) is True: + return False + else: + if sStringStripped.upper().startswith(sComment.upper()) is True: + return False + + # -- consider further filters + # + # No filter set (= no criteria defined) => use this string (bAck is True). + # + # At least one filter set (except sExclRegEx), at least one set filter fits (except sExclRegEx) => use this string. + # Filter sExclRegEx is set and fits => skip this string (final veto). + # At least one filter does not fit (except sExclRegEx) => skip this string. + # + # All filters (except sExclRegEx) are include filter (bAck is True in case of all set filters fit, also the 'not' filters) + # The filter sExclRegEx is an exclude filter and has final veto right (can revoke the True from other filters). + # + # All filters (except sInclRegEx and sExclRegEx) are handled as 'raw strings': no wild cards, just strings, considering bCaseSensitive. + # The filters sInclRegEx and sExclRegEx are handled as regular expressions; bCaseSensitive is not considered here. + + # -- filter specific flags (containing the names of the criteria within their names) + bStartsWith = None + bEndsWith = None + bStartsNotWith = None + bEndsNotWith = None + bContains = None + bContainsNot = None + bInclRegEx = None + bExclRegEx = None + + # Meaning: + # - Flag is None : filter not set => filter has no effect + # - Flag is True : filter set => result: use the input string (from this single filter flag point of view) + # - Flag is False: filter set => result: do not use the input string (from this single filter flag point of view) + # The results of all flags will be merged at the end of this function to one final conclusion to use the input string + # (bAck is True) or not (bAck is False). + # Logical join between all set filters: AND + + # substitute for the masked filter separator '\n' (hopefully the input string does not contain this substitute) + sSeparatorSubstitute = "#|S#|E#|P#|A#|R#|A#|T#|O#|R#" + + # -- filter: starts with + # > several filter strings possible (separated by semicolon; logical join: OR) + if sStartsWith is not None: + if sStartsWith != "": + sStartsWithModified = sStartsWith.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listStartsWith = [] + if sStartsWith.find(";") >= 0: + listParts = sStartsWithModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + listStartsWith.append(sPart) + else: + sStartsWithModified = sStartsWith.replace(r"\;", ";") # convert to unmasked version + listStartsWith.append(sStartsWithModified) + + bStartsWith = False + for sStartsWith in listStartsWith: + if bCaseSensitive is True: + if sStringStripped.startswith(sStartsWith) is True: + bStartsWith = True + break + else: + if sStringStripped.upper().startswith(sStartsWith.upper()) is True: + bStartsWith = True + break + + # -- filter: ends with + # > several filter strings possible (separated by semicolon; logical join: OR) + if sEndsWith is not None: + if sEndsWith != "": + sEndsWithModified = sEndsWith.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listEndsWith = [] + if sEndsWith.find(";") >= 0: + listParts = sEndsWithModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + listEndsWith.append(sPart) + else: + sEndsWithModified = sEndsWith.replace(r"\;", ";") # convert to unmasked version + listEndsWith.append(sEndsWithModified) + + bEndsWith = False + for sEndsWith in listEndsWith: + if bCaseSensitive is True: + if sStringStripped.endswith(sEndsWith) is True: + bEndsWith = True + break + else: + if sStringStripped.upper().endswith(sEndsWith.upper()) is True: + bEndsWith = True + break + + # -- filter: starts not with + # > several filter strings possible (separated by semicolon; logical join: AND) + if sStartsNotWith is not None: + if sStartsNotWith != "": + sStartsNotWithModified = sStartsNotWith.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listStartsNotWith = [] + if sStartsNotWith.find(";") >= 0: + listParts = sStartsNotWithModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + listStartsNotWith.append(sPart) + else: + sStartsNotWithModified = sStartsNotWith.replace(r"\;", ";") # convert to unmasked version + listStartsNotWith.append(sStartsNotWithModified) + + bStartsNotWith = True + for sStartsNotWith in listStartsNotWith: + if bCaseSensitive is True: + if sStringStripped.startswith(sStartsNotWith) is True: + bStartsNotWith = False + break + else: + if sStringStripped.upper().startswith(sStartsNotWith.upper()) is True: + bStartsNotWith = False + break + + # -- filter: ends not with + # > several filter strings possible (separated by semicolon; logical join: AND) + if sEndsNotWith is not None: + if sEndsNotWith != "": + sEndsNotWithModified = sEndsNotWith.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listEndsNotWith = [] + if sEndsNotWith.find(";") >= 0: + listParts = sEndsNotWithModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + listEndsNotWith.append(sPart) + else: + sEndsNotWithModified = sEndsNotWith.replace(r"\;", ";") # convert to unmasked version + listEndsNotWith.append(sEndsNotWithModified) + + bEndsNotWith = True + for sEndsNotWith in listEndsNotWith: + if bCaseSensitive is True: + if sStringStripped.endswith(sEndsNotWith) is True: + bEndsNotWith = False + break + else: + if sStringStripped.upper().endswith(sEndsNotWith.upper()) is True: + bEndsNotWith = False + break + + # -- filter: contains + # > several filter strings possible (separated by semicolon; logical join: OR) + if sContains is not None: + if sContains != "": + sContainsModified = sContains.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listContains = [] + if sContainsModified.find(";") >= 0: + listParts = sContainsModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + print(f"- Part: '{sPart}'") + listContains.append(sPart) + else: + sContainsModified = sContains.replace(r"\;", ";") # convert to unmasked version + listContains.append(sContainsModified) + + bContains = False + for sContains in listContains: + if bCaseSensitive is True: + if sStringStripped.find(sContains) >= 0: + bContains = True + break + else: + if sStringStripped.upper().find(sContains.upper()) >= 0: + bContains = True + break + + # -- filter: contains not + # > several filter strings possible (separated by semicolon; logical join: AND) + if sContainsNot is not None: + if sContainsNot != "": + sContainsNotModified = sContainsNot.replace(r"\;", sSeparatorSubstitute) # replace the masked separator by a substitute separator + listContainsNot = [] + if sContainsNot.find(";") >= 0: + listParts = sContainsNotModified.split(";") + for sPart in listParts: + sPart = sPart.replace(sSeparatorSubstitute , ";") # recover the original version + listContainsNot.append(sPart) + else: + sContainsNotModified = sContainsNot.replace(r"\;", ";") # convert to unmasked version + listContainsNot.append(sContainsNotModified) + + bContainsNot = True + for sContainsNot in listContainsNot: + if bCaseSensitive is True: + if sStringStripped.find(sContainsNot) >= 0: + bContainsNot = False + break + else: + if sStringStripped.upper().find(sContainsNot.upper()) >= 0: + bContainsNot = False + break + + # -- filter: sInclRegEx + # > (take care to mask special characters that are part of the syntax of regular expressions!) + # > bCaseSensitive not considered here + if sInclRegEx is not None: + if sInclRegEx != "": + bInclRegEx = False + if re.search(sInclRegEx, sString) is not None: + bInclRegEx = True + + # -- last filter: sExclRegEx (final veto right) + # > (take care to mask special characters that are part of the syntax of regular expressions!) + # > bCaseSensitive not considered here + if sExclRegEx is not None: + if sExclRegEx != "": + bExclRegEx = True + if re.search(sExclRegEx, sString) is not None: + bExclRegEx = False + + # -- debug info + if bDebug is True: + print("\n* [sString] : '" + str(sString) + "'\n") + print(" -> [bStartsWith] : '" + str(bStartsWith) + "'") + print(" -> [bEndsWith] : '" + str(bEndsWith) + "'") + print(" -> [bStartsNotWith] : '" + str(bStartsNotWith) + "'") + print(" -> [bEndsNotWith] : '" + str(bEndsNotWith) + "'") + print(" -> [bContains] : '" + str(bContains) + "'") + print(" -> [bContainsNot] : '" + str(bContainsNot) + "'") + print(" -> [bInclRegEx] : '" + str(bInclRegEx) + "'") + print(" -> [bExclRegEx] : '" + str(bExclRegEx) + "'\n") + + # -- final conclusion (AND condition between filters) + + listDecisions = [] + listDecisions.append(bStartsWith) + listDecisions.append(bEndsWith) + listDecisions.append(bStartsNotWith) + listDecisions.append(bEndsNotWith) + listDecisions.append(bContains) + listDecisions.append(bContainsNot) + listDecisions.append(bInclRegEx) + listDecisions.append(bExclRegEx) + + bAck = False # initial + + # -- 1.) no filter set (all None) + nCntDecisions = 0 + for bDecision in listDecisions: + if bDecision is None: + nCntDecisions = nCntDecisions + 1 + if nCntDecisions == len(listDecisions): + bAck = True + if bDebug is True: + print(" > case [1] - bAck: " + str(bAck)) + + # -- 2.) final veto from exclude filter + if bExclRegEx is False: + bAck = False + if bDebug is True: + print(" > case [2] - bAck: " + str(bAck)) + + # -- 3.) exclude filter not set; decision only made by other filters (include) + if bExclRegEx is None: + bAck = True + for bDecision in listDecisions: + if bDecision is False: + bAck = False + break + if bDebug is True: + print(" > case [3] - bAck: " + str(bAck)) + + # -- 4.) exclude filter is True (only relevant in case of all other filters are not set; otherwise decision only made by other filters (include)) + if bExclRegEx is True: + if ( (bStartsWith is None) and + (bEndsWith is None) and + (bStartsNotWith is None) and + (bEndsNotWith is None) and + (bContains is None) and + (bContainsNot is None) and + (bInclRegEx is None) ): + bAck = True + if bDebug is True: + print(" > case [4.1] - bAck: " + str(bAck)) + else: + bAck = True + for bDecision in listDecisions: + if bDecision is False: + bAck = False + break + if bDebug is True: + print(" > case [4.2] - bAck: " + str(bAck)) + + if bDebug is True: + print() + + return bAck + + # eof def StringFilter(...) + + # -------------------------------------------------------------------------------------------------------------- + #TM*** + + def FormatResult(sMethod="", bSuccess=True, sResult=""): + """ +Formats the result string ``sResult`` depending on ``bSuccess``: + +* ``bSuccess`` is ``True`` indicates *success* +* ``bSuccess`` is ``False`` indicates an *error* +* ``bSuccess`` is ``None`` indicates an *exception* + +Additionally the name of the method that causes the result, can be provided (*optional*). +This is useful for debugging. + +**Arguments:** + +* ``sMethod`` + + / *Condition*: optional / *Type*: str / *Default*: (empty string) / + + Name of the method that causes the result. + +* ``bSuccess`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + Indicates if the computation of the method ``sMethod`` was successful or not. + +* ``sResult`` + + / *Condition*: optional / *Type*: str / *Default*: (empty string) / + + The result of the computation of the method ``sMethod``. + +**Returns:** + +* ``sResult`` + + / *Type*: str / + + The formatted result string. + """ + + if sMethod is None: + sMethod = str(sMethod) + if sResult is None: + sResult = str(sResult) + if bSuccess is True: + if sMethod != "": + sResult = f"[{sMethod}] : {sResult}" + elif bSuccess is False: + sError = "!!! ERROR !!!" + if sMethod != "": + sResult = f"{sError}\n[{sMethod}] : {sResult}" + else: + sResult = f"{sError}\n{sResult}" + else: + sException = "!!! EXCEPTION !!!" + if sMethod != "": + sResult = f"{sException}\n[{sMethod}] : {sResult}" + else: + sResult = f"{sException}\n{sResult}" + return sResult + + # eof def FormatResult(sMethod="", bSuccess=True, sResult=""): + + # -------------------------------------------------------------------------------------------------------------- + #TM*** + + # - make the methods static + + NormalizePath = staticmethod(NormalizePath) + DetectParentPath = staticmethod(DetectParentPath) + StringFilter = staticmethod(StringFilter) + FormatResult = staticmethod(FormatResult) + +# eof class CString(object): + +# ************************************************************************************************************** + + + diff --git a/additions/PythonExtensionsCollection/String/__init__.py b/additions/PythonExtensionsCollection/String/__init__.py new file mode 100644 index 00000000..958420af --- /dev/null +++ b/additions/PythonExtensionsCollection/String/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/additions/PythonExtensionsCollection/Utils/CUtils.py b/additions/PythonExtensionsCollection/Utils/CUtils.py new file mode 100644 index 00000000..20447501 --- /dev/null +++ b/additions/PythonExtensionsCollection/Utils/CUtils.py @@ -0,0 +1,374 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# CUtils.py +# +# XC-CT/ECA3-Queckenstedt +# +# 20.05.2022 +# +# ************************************************************************************************************** + +# -- import standard Python modules +from dotdict import dotdict + +# ************************************************************************************************************** +# wrapper +# ************************************************************************************************************** + +def PrettyPrint(oData=None, hOutputFile=None, bToConsole=True, nIndent=0, sPrefix=None, bHexFormat=False): + """ +Wrapper function to create and use a ``CTypePrint`` object. This wrapper function is responsible for +printing out the content to console and to a file (depending on input parameter). + +The content itself is prepared by the method ``TypePrint`` of class ``CTypePrint``. This happens ``PrettyPrint`` internally. + +The idea behind the ``PrettyPrint`` function is to resolve also the content of composite data types and provide for every parameter inside: + +* the type +* the total number of elements inside (e.g. the number of keys inside a dictionary) +* the counter number of the current element +* the value + +Example call: + +.. code:: python + + PrettyPrint(oData) + +(*with oData is a Python variable of any type*) + +The output can e.g. look like this: + +.. code:: python + + [DICT] (3/1) > {K1} [STR] : 'Val1' + [DICT] (3/2) > {K2} [LIST] (4/1) > [INT] : 1 + [DICT] (3/2) > {K2} [LIST] (4/2) > [STR] : 'A' + [DICT] (3/2) > {K2} [LIST] (4/3) > [INT] : 2 + [DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/1) > [INT] : 9 + [DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/2) > [STR] : 'Z' + [DICT] (3/3) > {K3} [INT] : 5 + +Every line of output has to be interpreted strictly from left to right. + +For example the meaning of the fifth line of output + +.. code:: python + + [DICT] (3/2) > {K2} [LIST] (4/4) > [TUPLE] (2/1) > [INT] : 9 + +is: + +* The type of input parameter (``oData``) is ``dict`` +* The dictionary contains 3 keys +* The current line gives information about the second key of the dictionary +* The name of the second key is 'K2' +* The value of the second key is of type ``list`` +* The list contains 4 elements +* The current line gives information about the fourth element of the list +* The fourth element of the list is of type ``tuple`` +* The tuple contains 2 elements +* The current line gives information about the first element of the tuple +* The first element of the tuple is of type ``int`` and has the value 9 + +Types are encapsulated in square brackets, counter in round brackets and key names are encapsulated in curly brackets. + +**Arguments:** + +* ``oData`` + + / *Condition*: required / *Type*: (*any Python data type*) / + + A variable of any Python data type. + +* ``hOutputFile`` + + / *Condition*: optional / *Type*: file handle / *Default*: None / + + If handle is not ``None`` the content is written to this file, otherwise not. + +* ``bToConsole`` + + / *Condition*: optional / *Type*: bool / *Default*: True / + + If ``True`` the content is written to console, otherwise not. + +* ``nIndent`` + + / *Condition*: optional / *Type*: int / *Default*: 0 / + + Sets the number of additional blanks at the beginning of every line of output (indentation). + +* ``sPrefix`` + + / *Condition*: optional / *Type*: str / *Default*: None / + + Sets a prefix string that is added at the beginning of every line of output. + +* ``bHexFormat`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True`` the output is printed in hexadecimal format (but valid for strings only). + +**Returns:** + +* ``listOutLines`` (*list*) + + / *Type*: list / + + List of lines containing the prepared output + """ + + oTypePrint = CTypePrint() + listOutLines = oTypePrint.TypePrint(oData, bHexFormat) + + listReturned = [] + for sLine in listOutLines: + # if requested add indentation and prefix + sLineOut = "" + if sPrefix is not None: + sLineOut = nIndent*" " + sPrefix + " " + sLine + else: + sLineOut = nIndent*" " + sLine + listReturned.append(sLineOut) + + if hOutputFile is not None: + hOutputFile.write(sLineOut + "\n") + if bToConsole is True: + print(sLineOut) + + return listReturned + +# eof def PrettyPrint(oData=None, hOutputFile=None, bToConsole=True, nIndent=0, sPrefix=None, bHexFormat=False): + +# -------------------------------------------------------------------------------------------------------------- +# TM*** + +class CTypePrint(object): + """ +The class ``CTypePrint`` provides a method (``TypePrint``) to compute the following data: + +* the type +* the total number of elements inside (e.g. the number of keys inside a dictionary) +* the counter number of the current element +* the value + +of simple and composite data types. + +The call of this method is encapsulated within the function ``PrettyPrint`` inside this module. + """ + def __init__(self): + self.listGlobalPrefixes = [] + self.listOutLines = [] + + def __del__(self): + pass + + def _ToHex(self, sString=None): + if ( (sString is None) or (sString == "") ): + return sString + listHex = [] + for sChar in sString: + listHex.append(hex(ord(sChar))) + sStringHex = " ".join(listHex) + return sStringHex + + def TypePrint(self, oData=None, bHexFormat=False): + """ +The method ``TypePrint`` computes details about the input variable ``oData``. + +**Arguments:** + +* ``oData`` + + / *Condition*: required / *Type*: any Python data type / + + Python variable of any data type. + +* ``bHexFormat`` + + / *Condition*: optional / *Type*: bool / *Default*: False / + + If ``True`` the output is provide in hexadecimal format. + +**Returns:** + +* ``listOutLines`` + + / *Type*: list / + + List of lines containing the resolved content of ``oData``. + """ + + if oData is None: + sLocalPrefix = "[NONE]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : " + str(oData) + self.listOutLines.append(sOut.strip()) + + elif type(oData) == int: + sLocalPrefix = "[INT]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : " + str(oData) + self.listOutLines.append(sOut.strip()) + + elif type(oData) == float: + sLocalPrefix = "[FLOAT]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : " + str(oData) + self.listOutLines.append(sOut.strip()) + + elif type(oData) == bool: + sLocalPrefix = "[BOOL]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : " + str(oData) + self.listOutLines.append(sOut.strip()) + + elif type(oData) == str: + sLocalPrefix = "[STR]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sData = str(oData) + if bHexFormat is True: + sData = self._ToHex(sData) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : '" + sData + "'" + self.listOutLines.append(sOut.strip()) + + elif type(oData) == list: + nNrOfElements = len(oData) + if nNrOfElements == 0: + # -- indicate empty list + sLocalPrefix = "[LIST]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : []" + self.listOutLines.append(sOut.strip()) + else: + # -- list elements of list + self.listGlobalPrefixes.append("[LIST]") + nCnt = 0 + for oElement in oData: + nCnt = nCnt + 1 + sCnt = "(" + str(nNrOfElements) + "/" + str(nCnt) + ") >" + self.listGlobalPrefixes.append(sCnt) + self.TypePrint(oElement, bHexFormat) # >>>> recursion + del self.listGlobalPrefixes[-1] # remove prefix count + del self.listGlobalPrefixes[-1] # remove prefix name + + elif type(oData) == tuple: + nNrOfElements = len(oData) + if nNrOfElements == 0: + # -- indicate empty tuple + sLocalPrefix = "[TUPLE]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : ()" + self.listOutLines.append(sOut.strip()) + else: + # -- list elements of tuple + self.listGlobalPrefixes.append("[TUPLE]") + nCnt = 0 + for oElement in oData: + nCnt = nCnt + 1 + sCnt = "(" + str(nNrOfElements) + "/" + str(nCnt) + ") >" + self.listGlobalPrefixes.append(sCnt) + self.TypePrint(oElement, bHexFormat) # >>>> recursion + del self.listGlobalPrefixes[-1] # remove prefix count + del self.listGlobalPrefixes[-1] # remove prefix name + + elif type(oData) == set: + nNrOfElements = len(oData) + if nNrOfElements == 0: + # -- indicate empty set + sLocalPrefix = "[SET]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : ()" + self.listOutLines.append(sOut.strip()) + else: + # -- list elements of set + self.listGlobalPrefixes.append("[SET]") + nCnt = 0 + for oElement in oData: + nCnt = nCnt + 1 + sCnt = "(" + str(nNrOfElements) + "/" + str(nCnt) + ") >" + self.listGlobalPrefixes.append(sCnt) + self.TypePrint(oElement, bHexFormat) # >>>> recursion + del self.listGlobalPrefixes[-1] # remove prefix count + del self.listGlobalPrefixes[-1] # remove prefix name + + elif type(oData) == dict: + nNrOfElements = len(oData) + if nNrOfElements == 0: + # -- indicate empty dictionary + sLocalPrefix = "[DICT]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : {}" + self.listOutLines.append(sOut.strip()) + else: + # -- list elements of dictionary + self.listGlobalPrefixes.append("[DICT]") + nCnt = 0 + listKeys = list(oData.keys()) + for sKey in listKeys: + nCnt = nCnt + 1 + oValue = oData[sKey] + sCntAndKey = "(" + str(nNrOfElements) + "/" + str(nCnt) + ") > {" + str(sKey) + "}" + self.listGlobalPrefixes.append(sCntAndKey) + self.TypePrint(oValue, bHexFormat) # >>>> recursion + del self.listGlobalPrefixes[-1] # remove prefix count + del self.listGlobalPrefixes[-1] # remove prefix name + + # elif type(oData) == dotdict: + elif ( (type(oData) == dotdict) or (str(type(oData)) == "") ): + nNrOfElements = len(oData) + if nNrOfElements == 0: + # -- indicate empty dot dictionary + sLocalPrefix = "[DOTDICT]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : {}" + self.listOutLines.append(sOut.strip()) + else: + # -- list elements of dot dictionary + self.listGlobalPrefixes.append("[DOTDICT]") + nCnt = 0 + listKeys = list(oData.keys()) + for sKey in listKeys: + nCnt = nCnt + 1 + oValue = oData[sKey] + sCntAndKey = "(" + str(nNrOfElements) + "/" + str(nCnt) + ") > {" + str(sKey) + "}" + self.listGlobalPrefixes.append(sCntAndKey) + self.TypePrint(oValue, bHexFormat) # >>>> recursion + del self.listGlobalPrefixes[-1] # remove prefix count + del self.listGlobalPrefixes[-1] # remove prefix name + + else: + sLocalPrefix = "[" + str(type(oData)) + "]" + sGlobalPrefix = " ".join(self.listGlobalPrefixes) + sData = str(oData) + if bHexFormat is True: + sData = self._ToHex(sData) + sOut = sGlobalPrefix + " " + sLocalPrefix + " : '" + sData + "'" + self.listOutLines.append(sOut.strip()) + + return self.listOutLines + + # eof def TypePrint(...): + +# eof class CTypePrint(): + +# ************************************************************************************************************** + diff --git a/additions/PythonExtensionsCollection/Utils/__init__.py b/additions/PythonExtensionsCollection/Utils/__init__.py new file mode 100644 index 00000000..958420af --- /dev/null +++ b/additions/PythonExtensionsCollection/Utils/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/additions/PythonExtensionsCollection/__init__.py b/additions/PythonExtensionsCollection/__init__.py new file mode 100644 index 00000000..958420af --- /dev/null +++ b/additions/PythonExtensionsCollection/__init__.py @@ -0,0 +1,13 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. diff --git a/additions/PythonExtensionsCollection/version.py b/additions/PythonExtensionsCollection/version.py new file mode 100644 index 00000000..b5b224a4 --- /dev/null +++ b/additions/PythonExtensionsCollection/version.py @@ -0,0 +1,23 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# Version and date of PythonExtensionsCollection +# +VERSION = "0.8.0" +VERSION_DATE = "28.06.2022" + diff --git a/additions/__init__.py b/additions/__init__.py new file mode 100644 index 00000000..85a18b76 --- /dev/null +++ b/additions/__init__.py @@ -0,0 +1,14 @@ +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + diff --git a/config/CConfig.py b/config/CConfig.py deleted file mode 100644 index 19b5e276..00000000 --- a/config/CConfig.py +++ /dev/null @@ -1,240 +0,0 @@ -# ************************************************************************************************************** -# -# Copyright 2020-2022 Robert Bosch GmbH -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# ************************************************************************************************************** -# -# CConfig.py -# -# XC-CT/ECA3-Queckenstedt -# -# Purpose: -# - Compute and store all repository specific information, like the repository name, -# paths to repository subfolder, paths to interpreter and so on ... -# -# - All paths to subfolder depends on the repository root path that has to be provided to constructor of CConfig -# -# Additional hints: -# - Variable names like SPHINXBUILD, SOURCEDIR and BUILDDIR are taken over from original output of Sphinx -# (when documentation project files like make.bat are generated by Sphinx; for better understanding -# no new names here). -# -# - Output in PDF format requires LaTeX compiler and depends on %ROBOTLATEXPATH%/miktex/bin/x64/pdflatex.exe -# -# - Don't be confused: We have 'doc/_build' containing the documentation builder output -# and we have 'build' containing the build of the setup tools. These are different things. -# -# -------------------------------------------------------------------------------------------------------------- -# -# 18.02.2022 / XC-CT/ECA3-Queckenstedt -# Usage of %RobotPythonPath% exchanged by sys.executable -# -# 11.10.2021 / XC-CI1/ECA3-Queckenstedt -# Fixed path within site-packages (Linux) -# -# 06.10.2021 / XC-CI1/ECA3-Queckenstedt -# Added Linux support -# -# 01.10.2021 / XC-CI1/ECA3-Queckenstedt -# Added environment check -# -# 01.10.2021 / XC-CI1/ECA3-Queckenstedt -# Added wrapper for error messages -# -# Initial version 08/2021 -# -# -------------------------------------------------------------------------------------------------------------- - -import os, sys, platform, shlex, subprocess -import colorama as col -import pypandoc - -col.init(autoreset=True) -COLBR = col.Style.BRIGHT + col.Fore.RED -COLBG = col.Style.BRIGHT + col.Fore.GREEN - -# -------------------------------------------------------------------------------------------------------------- - -def printerror(sMsg): - sys.stderr.write(COLBR + f"Error: {sMsg}!\n") - -def printexception(sMsg): - sys.stderr.write(COLBR + f"Exception: {sMsg}!\n") - -# -------------------------------------------------------------------------------------------------------------- - -class CConfig(): - - def __init__(self, sReferencePath="."): - - self.__dictConfig = {} - - self.__sReferencePath = os.path.normpath(os.path.abspath(sReferencePath)) - self.__dictConfig['sReferencePath'] = self.__sReferencePath # only to have the possibility to print out all values only with help of 'self.__dictConfig' - - # 1. basic setup stuff - self.__dictConfig['sPackageName'] = "JsonPreprocessor" - self.__dictConfig['sVersion'] = "0.1.0" - self.__dictConfig['sAuthor'] = "Mai Dinh Nam Son" - self.__dictConfig['sAuthorEMail'] = "son.maidinhnam@vn.bosch.com" - self.__dictConfig['sDescription'] = "This package provides a preprocessor for json files" - self.__dictConfig['sLongDescriptionContentType'] = "text/markdown" - self.__dictConfig['sURL'] = "https://github.com/test-fullautomation/python-jsonpreprocessor" - self.__dictConfig['sProgrammingLanguage'] = "Programming Language :: Python :: 3" - self.__dictConfig['sLicence'] = "License :: OSI Approved :: Apache Software License" - self.__dictConfig['sOperatingSystem'] = "Operating System :: OS Independent" - self.__dictConfig['sPythonRequires'] = ">=3.0" - self.__dictConfig['sDevelopmentStatus'] = "Development Status :: 4 - Beta" - self.__dictConfig['sIntendedAudience'] = "Intended Audience :: Developers" - self.__dictConfig['sTopic'] = "Topic :: Software Development" - self.__dictConfig['arInstallRequires'] = ['sphinx','pypandoc','colorama'] - - - # 2. certain folder and executables (things that requires computation) - bSuccess, sResult = self.__InitConfig() - if bSuccess != True: - raise Exception(sResult) - print(COLBG + sResult) - print() - - - def __del__(self): - del self.__dictConfig - - - def __InitConfig(self): - - sOSName = os.name - sPlatformSystem = platform.system() - sPythonPath = os.path.dirname(sys.executable) - sPython = sys.executable - sPythonVersion = sys.version - - SPHINXBUILD = None - sLaTeXInterpreter = None - sInstalledPackageFolder = None - sInstalledPackageDocFolder = None - - try: - self.__dictConfig['sPandoc'] = pypandoc.get_pandoc_path() - except Exception as ex: - bSuccess = False - sResult = str(ex) - return bSuccess, sResult - - if sPlatformSystem == "Windows": - SPHINXBUILD = f"{sPythonPath}/Scripts/sphinx-build.exe" - sInstalledPackageFolder = f"{sPythonPath}/Lib/site-packages/" + self.__dictConfig['sPackageName'] - sInstalledPackageDocFolder = f"{sPythonPath}/Lib/site-packages/" + self.__dictConfig['sPackageName'] + "_doc" - sLaTeXInterpreter = os.path.normpath(os.path.expandvars("%ROBOTLATEXPATH%/miktex/bin/x64/pdflatex.exe")) - - elif sPlatformSystem == "Linux": - SPHINXBUILD = f"{sPythonPath}/sphinx-build" - sInstalledPackageFolder = f"{sPythonPath}/../lib/python3.9/site-packages/" + self.__dictConfig['sPackageName'] - sInstalledPackageDocFolder = f"{sPythonPath}/../lib/python3.9/site-packages/" + self.__dictConfig['sPackageName'] + "_doc" - sLaTeXInterpreter = os.path.normpath(os.path.expandvars("${ROBOTLATEXPATH}/miktex/bin/x64/pdflatex")) - - else: - bSuccess = False - sResult = f"Operating system {sPlatformSystem} ({sOSName}) not supported" - return bSuccess, sResult - - if os.path.isfile(sLaTeXInterpreter) is False: - sLaTeXInterpreter = None # not an error; PDF generation is an option - - if os.path.isfile(SPHINXBUILD) is False: - bSuccess = False - sResult = f"Missing Sphinx '{SPHINXBUILD}'" - return bSuccess, sResult - - self.__dictConfig['SPHINXBUILD'] = SPHINXBUILD - self.__dictConfig['sPython'] = sPython - self.__dictConfig['sLaTeXInterpreter'] = sLaTeXInterpreter - self.__dictConfig['sInstalledPackageFolder'] = sInstalledPackageFolder - self.__dictConfig['sInstalledPackageDocFolder'] = sInstalledPackageDocFolder - - - # ---- paths relative to repository root folder (where the srcipts are located that use this module) - - # ====== 1. documentation - - # This doesn't matter in case of the documentation builder itself is using this CConfig. - # But if the documentation builder is called by other apps like setup_ext.py, they need to know where to find. - sDocumentationBuilder = os.path.normpath(self.__sReferencePath + "/sphinx-makeall.py") - self.__dictConfig['sDocumentationBuilder'] = sDocumentationBuilder - - # - documentation project source dir (relative to reference path (= position of executing script) - SOURCEDIR = os.path.normpath(self.__sReferencePath + "/doc") - self.__dictConfig['SOURCEDIR'] = SOURCEDIR - - # - documentation project build dir - BUILDDIR = os.path.normpath(SOURCEDIR + "/_build") - self.__dictConfig['BUILDDIR'] = BUILDDIR - - # - documentation project html output folder - sHTMLOutputFolder = os.path.normpath(BUILDDIR + "/html") - self.__dictConfig['sHTMLOutputFolder'] = sHTMLOutputFolder - - # - README - sReadMe_rst = os.path.normpath(self.__sReferencePath + "/README.rst") - self.__dictConfig['sReadMe_rst'] = sReadMe_rst - sReadMe_md = os.path.normpath(self.__sReferencePath + "/README.md") - self.__dictConfig['sReadMe_md'] = sReadMe_md - - - # ====== 2. setuptools - - self.__dictConfig['sSetupBuildFolder'] = os.path.normpath(self.__sReferencePath + "/build") - self.__dictConfig['sSetupBuildLibFolder'] = os.path.normpath(self.__sReferencePath + "/build/lib") - self.__dictConfig['sSetupBuildLibDocFolder'] = os.path.normpath(self.__sReferencePath + "/build/lib/" + self.__dictConfig['sPackageName'] + "_doc") - self.__dictConfig['sSetupDistFolder'] = os.path.normpath(self.__sReferencePath + "/dist") - self.__dictConfig['sEggInfoFolder'] = os.path.normpath(self.__sReferencePath + "/" + self.__dictConfig['sPackageName'] + ".egg-info") - - print() - print(f"Running under {sPlatformSystem} ({sOSName})") - self.PrintConfig() - - bSuccess = True - sResult = "Repository setup done" - return bSuccess, sResult - - # eof def __InitConfig(self): - - - def PrintConfig(self): - # -- printing configuration to console - nJust = 30 - print() - for sKey in self.__dictConfig: - print(sKey.rjust(nJust, ' ') + " : " + str(self.__dictConfig[sKey])) - print() - # eof def PrintConfig(self): - - - def Get(self, sName=None): - if ( (sName is None) or (sName not in self.__dictConfig) ): - print() - printerror(f"Error: Configuration parameter '{sName}' not existing!") - # from here it's standard output: - print("Use instead one of:") - self.PrintConfig() - return None # returning 'None' in case of key is not existing !!! - else: - return self.__dictConfig[sName] - # eof def Get(self, sName=None): - -# eof class CConfig(): - -# -------------------------------------------------------------------------------------------------------------- diff --git a/config/CRepositoryConfig.py b/config/CRepositoryConfig.py new file mode 100644 index 00000000..3da68162 --- /dev/null +++ b/config/CRepositoryConfig.py @@ -0,0 +1,198 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# CRepositoryConfig.py +# +# XC-CT/ECA3-Queckenstedt +# +# Purpose: +# - Compute and store all repository specific information, like the repository name, +# paths to repository subfolder, paths to interpreter and so on ... +# +# - All paths to subfolder depends on the repository root path that has to be provided +# to constructor of CRepositoryConfig +# +# -------------------------------------------------------------------------------------------------------------- +# +# 01.07.2022 +# +# -------------------------------------------------------------------------------------------------------------- + +import os, sys, platform, shlex, subprocess, json +import colorama as col +import pypandoc + +from PythonExtensionsCollection.String.CString import CString + +from JsonPreprocessor.version import VERSION +from JsonPreprocessor.version import VERSION_DATE + +col.init(autoreset=True) +COLBR = col.Style.BRIGHT + col.Fore.RED +COLBG = col.Style.BRIGHT + col.Fore.GREEN + +# -------------------------------------------------------------------------------------------------------------- + +def printerror(sMsg): + sys.stderr.write(COLBR + f"Error: {sMsg}!\n") + +def printexception(sMsg): + sys.stderr.write(COLBR + f"Exception: {sMsg}!\n") + +# -------------------------------------------------------------------------------------------------------------- + +class CRepositoryConfig(): + + def __init__(self, sCalledBy=None): + + # TODO: error handling sCalledBy=None + sCalledBy = CString.NormalizePath(sCalledBy) + self.__sReferencePath = os.path.dirname(sCalledBy) + + self.__dictRepositoryConfig = None # initialized below by json.load() + + # load static configuration values (name of json file is fix) + sRepositoryConfigurationFile = CString.NormalizePath(f"{self.__sReferencePath}/config/repository_config.json") + hRepositoryConfigurationFile = open(sRepositoryConfigurationFile) + self.__dictRepositoryConfig = json.load(hRepositoryConfigurationFile) + hRepositoryConfigurationFile.close() + + # add further infos + # (to have the possibility to print out all values with help of 'PrintConfig()') + self.__dictRepositoryConfig['CALLEDBY'] = sCalledBy + self.__dictRepositoryConfig['CWD'] = os.getcwd() + self.__dictRepositoryConfig['REFERENCEPATH'] = self.__sReferencePath + self.__dictRepositoryConfig['REPOSITORYCONFIGURATIONFILE'] = sRepositoryConfigurationFile + + # add version and date of the package this repository configuration belongs to + self.__dictRepositoryConfig['PACKAGEVERSION'] = VERSION + self.__dictRepositoryConfig['PACKAGEDATE'] = VERSION_DATE + + # make absolute path to package documentation + self.__dictRepositoryConfig['PACKAGEDOC'] = CString.NormalizePath(sPath=self.__dictRepositoryConfig['PACKAGEDOC'], sReferencePathAbs=self.__sReferencePath) + + # compute dynamic configuration values + bSuccess, sResult = self.__InitConfig() + if bSuccess != True: + raise Exception(sResult) + print(COLBG + sResult) + print() + + + def __del__(self): + del self.__dictRepositoryConfig + + + def __InitConfig(self): + + sOSName = os.name + sPlatformSystem = platform.system() + sPythonPath = CString.NormalizePath(os.path.dirname(sys.executable)) + sPython = CString.NormalizePath(sys.executable) + sPythonVersion = sys.version + + sInstalledPackageFolder = None + + try: + # try to access pandoc; if not installed we detect this already here as early as possible + pypandoc.get_pandoc_path() + except Exception as ex: + bSuccess = False + sResult = str(ex) + return bSuccess, sResult + + if sPlatformSystem == "Windows": + sInstalledPackageFolder = f"{sPythonPath}/Lib/site-packages/" + self.__dictRepositoryConfig['PACKAGENAME'] + elif sPlatformSystem == "Linux": + sInstalledPackageFolder = f"{sPythonPath}/../lib/python3.9/site-packages/" + self.__dictRepositoryConfig['PACKAGENAME'] + else: + bSuccess = False + sResult = f"Operating system {sPlatformSystem} ({sOSName}) not supported" + return bSuccess, sResult + + self.__dictRepositoryConfig['OSNAME'] = sOSName + self.__dictRepositoryConfig['PLATFORMSYSTEM'] = sPlatformSystem + self.__dictRepositoryConfig['PYTHON'] = sPython + self.__dictRepositoryConfig['PYTHONVERSION'] = sPythonVersion + self.__dictRepositoryConfig['INSTALLEDPACKAGEFOLDER'] = sInstalledPackageFolder + + # ---- paths relative to repository root folder (where the scripts are located that use this module) + + # ====== 1. documentation + + # - README + self.__dictRepositoryConfig['README_RST'] = CString.NormalizePath(f"{self.__sReferencePath}/README.rst") + self.__dictRepositoryConfig['README_MD'] = CString.NormalizePath(f"{self.__sReferencePath}/README.md") + + # The following key doesn't matter in case of the documentation builder itself is using this CRepositoryConfig. + # But if the documentation builder is called by other apps like setup.py, they need to know where to find. + self.__dictRepositoryConfig['DOCUMENTATIONBUILDER'] = CString.NormalizePath(f"{self.__sReferencePath}/genpackagedoc.py") + + # - folder containing the package source files (will also contain the PDF documentation) + self.__dictRepositoryConfig['PACKAGESOURCEFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/{self.__dictRepositoryConfig['PACKAGENAME']}") + + # ====== 2. setuptools + + self.__dictRepositoryConfig['SETUPBUILDFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/build") + self.__dictRepositoryConfig['SETUPBUILDLIBFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/build/lib") + self.__dictRepositoryConfig['SETUPBUILDLIBPACKAGEFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/build/lib/{self.__dictRepositoryConfig['PACKAGENAME']}") + self.__dictRepositoryConfig['SETUPDISTFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/dist") + EGGINFOFOLDER = self.__dictRepositoryConfig['PACKAGENAME'].replace('-', '_') + self.__dictRepositoryConfig['EGGINFOFOLDER'] = CString.NormalizePath(f"{self.__sReferencePath}/{EGGINFOFOLDER}.egg-info") + + print() + print(f"Running under {sPlatformSystem} ({sOSName})") + self.PrintConfig() + + bSuccess = True + sResult = "Repository setup done" + return bSuccess, sResult + + # eof def __InitConfig(self): + + + def PrintConfig(self): + # -- printing configuration to console + nJust = 30 + print() + for sKey in self.__dictRepositoryConfig: + print(sKey.rjust(nJust, ' ') + " : " + str(self.__dictRepositoryConfig[sKey])) + print() + # eof def PrintConfig(self): + + + def Get(self, sName=None): + if ( (sName is None) or (sName not in self.__dictRepositoryConfig) ): + print() + printerror(f"Error: Configuration parameter '{sName}' not existing!") + # from here it's standard output: + print("Use instead one of:") + self.PrintConfig() + return None # returning 'None' in case of key is not existing !!! + else: + return self.__dictRepositoryConfig[sName] + # eof def Get(self, sName=None): + + + def GetConfig(self): + return self.__dictRepositoryConfig + # eof def GetConfig(self): + +# eof class CRepositoryConfig(): + +# -------------------------------------------------------------------------------------------------------------- diff --git a/config/repository_config.json b/config/repository_config.json new file mode 100644 index 00000000..5c378414 --- /dev/null +++ b/config/repository_config.json @@ -0,0 +1,19 @@ +{ + "REPOSITORYNAME" : "python-jsonpreprocessor", + "PACKAGENAME" : "JsonPreprocessor", + "AUTHOR" : "Mai Dinh Nam Son", + "AUTHOREMAIL" : "son.maidinhnam@vn.bosch.com", + "DESCRIPTION" : "Preprocessor for json files", + "LONGDESCRIPTIONCONTENTTYPE" : "text/markdown", + "URL" : "https://github.com/test-fullautomation/python-jsonpreprocessor", + "PROGRAMMINGLANGUAGE" : "Programming Language :: Python :: 3", + "LICENCE" : "License :: OSI Approved :: Apache Software License", + "OPERATINGSYSTEM" : "Operating System :: OS Independent", + "PYTHONREQUIRES" : ">=3.0", + "DEVELOPMENTSTATUS" : "Development Status :: 4 - Beta", + "INTENDEDAUDIENCE" : "Intended Audience :: Developers", + "TOPIC" : "Topic :: Software Development", + "INSTALLREQUIRES" : ["pypandoc","colorama","GenPackageDoc","PythonExtensionsCollection"], + "PACKAGEDATA" : ["*.pdf"], + "PACKAGEDOC" : "./packagedoc" +} diff --git a/doc/CJsonPreprocessor.rst b/doc/CJsonPreprocessor.rst deleted file mode 100644 index 27a06032..00000000 --- a/doc/CJsonPreprocessor.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. Copyright 2020-2022 Robert Bosch GmbH - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - - -.. rst-class:: dl-parameters - -.. role:: aspect (emphasis) -.. role:: sep (strong) - - -JsonPreprocessor package -======================== - - -Module contents ---------------- - -.. automodule:: CJsonPreprocessor - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/_build/html/.buildinfo b/doc/_build/html/.buildinfo deleted file mode 100644 index 732a518c..00000000 --- a/doc/_build/html/.buildinfo +++ /dev/null @@ -1,4 +0,0 @@ -# Sphinx build info version 1 -# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: c1b9daab68a41d0ab802bb1788587c44 -tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/doc/_build/html/CJsonPreprocessor.html b/doc/_build/html/CJsonPreprocessor.html deleted file mode 100644 index 9cbd2dcd..00000000 --- a/doc/_build/html/CJsonPreprocessor.html +++ /dev/null @@ -1,183 +0,0 @@ - - - - - - - - JsonPreprocessor package — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

JsonPreprocessor package¶

-
-

Module contents¶

-
-
-class CJsonPreprocessor.CJsonPreprocessor(syntax='json', currentCfg={})[source]¶
-

Bases: object

-
-
CJsonPreprocessor helps to handle configuration file as json format:
    -

  • Allow comment within json file

    • -

  • Allow import json file within json file

    • -
-
-
-
-
-jsonLoad(jFile, masterFile=True)[source]¶
-

Method: jsonLoad loads the json file then parses to dict object

-
-
Args:

jFile: string, json file input

-
-
Returns:

oJson: dict

-
-
-
- -
- -
-
-class CJsonPreprocessor.CPythonJSONDecoder(*args, **kwargs)[source]¶
-

Bases: json.decoder.JSONDecoder

-

Add below python values when scanning json data

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

True

True

False

False

None

None

-
-
-custom_scan_once(string, idx)[source]¶
-
- -
- -
-
-class CJsonPreprocessor.CSyntaxType[source]¶
-

Bases: object

-
-
-json = 'json'¶
-
- -
-
-python = 'python'¶
-
- -
- -
-
- - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/_modules/CJsonPreprocessor.html b/doc/_build/html/_modules/CJsonPreprocessor.html deleted file mode 100644 index 2a3ba812..00000000 --- a/doc/_build/html/_modules/CJsonPreprocessor.html +++ /dev/null @@ -1,497 +0,0 @@ - - - - - - - - CJsonPreprocessor — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - -
-
-
- - -
- -

Source code for CJsonPreprocessor

-#  Copyright 2020-2022 Robert Bosch Car Multimedia GmbH
-#
-#  Licensed under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License.
-#  You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software
-#  distributed under the License is distributed on an "AS IS" BASIS,
-#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-#  See the License for the specific language governing permissions and
-#  limitations under the License.
-#################################################################################
-#
-# File: JsonPreprocessor.py
-# 
-# This module uses to handle connfiguration file in json format (import another 
-# json file to the json file).
-# Allows user adds comment into json config file
-#
-# History:
-# 
-# 2021-01:
-#    - Initially created by Mai Dinh Nam Son (RBVH/ECM11)
-#
-# 2021-02-08:
-#   - Use object_pairs_hook of json.load() to process [import] node(s).
-#     Allow to use multiple [import] node(s) at same level.
-#   - Avoid cyclic import
-#
-# 2021-02-17:
-#   - Replace method to load json data json.load() by json.loads() 
-#     to load string data after removing comment(s)
-#
-# 2021-02-18:
-#   - Add parameter syntax to support Python types if required:
-#     None  => null
-#     True  => true
-#     False => false
-#
-# 2021-03-29:
-#   - Adds update configuration using json file
-#   - Handles nested parameter in json config file
-#################################################################################
-
-
-import os
-import json
-import re
-
-
[docs]class CSyntaxType():
-    python = "python"
-    json = "json"

-
-NUMBER_RE = re.compile(
-    r'(-?(?:0|[1-9]\d*))(\.\d+)?([eE][-+]?\d+)?',
-    (re.VERBOSE | re.MULTILINE | re.DOTALL))
-
-
[docs]class CPythonJSONDecoder(json.JSONDecoder):
-    """ Add below python values when scanning json data
-
-    +---------------+-------------------+
-    | True          | True              |
-    +---------------+-------------------+
-    | False         | False             |
-    +---------------+-------------------+
-    | None          | None              |
-    +---------------+-------------------+
-    """
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.scan_once = self.custom_scan_once
-
-    def _custom_scan_once(self, string, idx):
-        try:
-            nextchar = string[idx]
-        except IndexError:
-            raise StopIteration(idx) from None
-
-        if nextchar == '"':
-            return self.parse_string(string, idx + 1, self.strict)
-        elif nextchar == '{':
-            return self.parse_object((string, idx + 1), self.strict,
-                self._custom_scan_once, self.object_hook, self.object_pairs_hook, self.memo)
-        elif nextchar == '[':
-            return self.parse_array((string, idx + 1), self._custom_scan_once)
-        elif nextchar == 'n' and string[idx:idx + 4] == 'null':
-            return None, idx + 4
-        elif nextchar == 't' and string[idx:idx + 4] == 'true':
-            return True, idx + 4
-        elif nextchar == 'f' and string[idx:idx + 5] == 'false':
-            return False, idx + 5
-        elif nextchar == 'N' and string[idx:idx + 4] == 'None':
-            return None, idx + 4
-        elif nextchar == 'T' and string[idx:idx + 4] == 'True':
-            return True, idx + 4
-        elif nextchar == 'F' and string[idx:idx + 5] == 'False':
-            return False, idx + 5
-
-        m = NUMBER_RE.match(string, idx)
-        if m is not None:
-            integer, frac, exp = m.groups()
-            if frac or exp:
-                res = self.parse_float(integer + (frac or '') + (exp or ''))
-            else:
-                res = self.parse_int(integer)
-            return res, m.end()
-        elif nextchar == 'N' and string[idx:idx + 3] == 'NaN':
-            return self.parse_constant('NaN'), idx + 3
-        elif nextchar == 'I' and string[idx:idx + 8] == 'Infinity':
-            return self.parse_constant('Infinity'), idx + 8
-        elif nextchar == '-' and string[idx:idx + 9] == '-Infinity':
-            return self.parse_constant('-Infinity'), idx + 9
-        else:
-            raise StopIteration(idx)
-
-
[docs]    def custom_scan_once(self, string, idx):
-        try:
-            return self._custom_scan_once(string, idx)
-        finally:
-            self.memo.clear()

-
-
[docs]class CJsonPreprocessor():
-    '''
-    CJsonPreprocessor helps to handle configuration file as json format:
-        - Allow comment within json file
-        - Allow import json file within json file
-    '''
-    def __init__(self, syntax=CSyntaxType.json, currentCfg={}):
-        self.lImportedFiles = []
-        self.recursive_level = 0
-        self.syntax = syntax
-        self.currentCfg = currentCfg
-        self.lUpdatedParams = []
-            
-
-    '''
-    Method: __processImportFiles this is custom decorder of object_pairs_hook function.
-    This method helps to import json file which is provided in '[import]' keyword into current json file.
-    Returns:
-        Dictionary is parsed from json file.
-    '''
-    def __processImportFiles(self, input_data):
-        out_dict = {}
-        for key, value in input_data:
-            if re.match('^\s*\[\s*import\s*\]\s*', key.lower()):
-                abs_path_file = os.path.abspath(value)
-                
-                # Use recursive_level and lImportedFiles to avoid cyclic import
-                self.recursive_level = self.recursive_level + 1     # increase recursive level
-                # length of lImportedFiles should equal to recursive_level
-                self.lImportedFiles = self.lImportedFiles[:self.recursive_level]
-                if abs_path_file in self.lImportedFiles:
-                    raise Exception('Cyclic imported json file \'%s\'' %str(abs_path_file))
-                
-                oJsonImport = self.jsonLoad(value, masterFile=False)
-                out_dict.update(oJsonImport)
-                self.recursive_level = self.recursive_level - 1     # descrease recursive level
-            else:
-                out_dict[key] = value
-        return out_dict
-
-    '''
-    Method: __removeComments loads json config file which allows comments inside
-    Args:
-        jsonFile: string
-    Returns:
-        lJsonData: list, list of string data from jsonFile after removing comment(s).
-    '''
-    def __removeComments(self, jsonFile):
-        jsonPath = ''
-        if '/' in jsonFile:
-            for item in jsonFile.split('/')[:-1]:
-                jsonPath += item + '/'
-        else:
-            for item in jsonFile.split('\\')[:-1]:
-                jsonPath += item + '\\'
-      
-        '''
-        Removes comment parts in json file then store in temporary json file
-        '''
-        lJsonData = []
-        
-        with open(jsonFile) as fr:
-            for line in fr:
-                if re.match('^\s*//', line):
-                    continue
-                elif '//' in line:
-                    reEx1 = re.search("(\s*{*\s*\'.+\')\s*:\s*(\'.+\'\s*,*)*\s*(.*)", line)
-                    if reEx1 is None:
-                        reEx1 = re.search("(\s*{*\s*\".+\")\s*:\s*(\".+\"\s*,*)*\s*(.*)", line)
-                    if reEx1 is None:
-                        line = re.sub('//.*', '', line)
-                    elif reEx1.group(1) is not None and reEx1.group(2) is not None:
-                        line = reEx1.group(1) + ": " + reEx1.group(2) if reEx1.group(3) is None else \
-                               reEx1.group(1) + ": " + reEx1.group(2) + re.sub('//.*', '', reEx1.group(3))
-                    else:
-                        reEx2 = re.search("(\s*{*\s*\'.+\')\s*:\s*(.+,*)\s*//\s*.*", line)
-                        if reEx2 is None:
-                            reEx2 = re.search("(\s*{*\s*\".+\")\s*:\s*(.+,*)\s*(//\s*.*)*", line)
-                        if reEx2 is not None:
-                            line = reEx2.group(1) + ": " + re.sub('//.*', '', reEx2.group(2))
-                            
-                lJsonData.append(line)
-        return lJsonData, jsonPath
-    
-    '''
-    private __nestedParamHandler: This method handles the nested variable in param names or value
-                                  in updated json config file.
-    Args:
-        sInputStr: string - param name or value which contains nested variable
-    Returns:
-        sStrHandled: string
-    '''
-    def __nestedParamHandler(self, sInputStr):
-        
-        #globals().update(currentCfg)
-        referVars = re.findall('(\${\s*.*?\s*})', sInputStr)
-        if len(referVars) > 1:
-            sUpdateVar =  referVars[0]
-            referVars = referVars[1:]
-            sInputStr = re.sub('\\' + sUpdateVar, '', sInputStr, count=1)
-            for var in referVars[::-1]:
-                pattern = '(\\' + var + '\s*\[\s*.*?\s*\])'
-                variable = re.findall(pattern, sInputStr)
-                if variable == []:
-                    sExec = "value = " + re.search('^\s*\${(\s*.*?)}', var).group(1)
-                    try:
-                        ldict = {}
-                        exec(sExec, globals(), ldict)
-                        tmpValue = ldict['value']
-                    except:
-                        raise Exception('The variable %s is not available' % (var))
-                    sInputStr = re.sub('\\' + var, tmpValue, sInputStr) if isinstance(tmpValue, str) else \
-                                re.sub('\\' + var, str(tmpValue), sInputStr)
-                    continue
-                while variable != []:
-                    fullVariable = variable[0]
-                    pattern = pattern[:-1] + '\[\s*.*?\s*\])'
-                    variable = re.findall(pattern, sInputStr)
-                    if variable != []:
-                        fullVariable = variable[0]
-                sExec = "value = " + re.sub('\${\s*(.*?)\s*}', '\\1', fullVariable)
-                try:
-                    ldict = {}
-                    exec(sExec, globals(), ldict)
-                    tmpValue = ldict['value']
-                except:
-                    raise Exception('The variable %s is not available!!!' % (fullVariable))
-                pattern = re.sub('\[', '\\[', fullVariable)
-                pattern = re.sub('\]', '\\]', pattern)
-                sInputStr = re.sub('\\' + pattern, '\'' + tmpValue + '\'', sInputStr) if isinstance(tmpValue, str) else \
-                            re.sub('\\' + pattern, '\'' + str(tmpValue) + '\'', sInputStr)
-            sStrHandled = sUpdateVar + sInputStr
-            return sStrHandled
-                    
-        else:
-            pattern = '(\\' + referVars[0] + '\s*\[\s*.*?\s*\])'
-            variable = re.findall(pattern, sInputStr)
-            if variable == []:
-                sStrHandled = referVars[0]
-                return sStrHandled
-            else:
-                fullVariable = variable[0]
-                while variable != []:
-                    pattern = pattern[:-1] + '\[\s*.*?\s*\])'
-                    variable = re.findall(pattern, sInputStr)
-                    if variable != []:
-                        fullVariable = variable[0]
-                sStrHandled = fullVariable
-                return sStrHandled
-            
-    '''
-    private __updateAndReplaceNestedParam: this method replaces all nested params in key and value of Json object
-    Args:
-        oJson: dict
-        currentCfg: dict
-    Returns:
-        oJsonOut: dict
-    '''
-    def __updateAndReplaceNestedParam(self, oJson, recursive=False):
-        
-        if bool(self.currentCfg) and not recursive:
-            for k, v in self.currentCfg.items():
-                globals().update({k:v})
-        
-        tmpJson = {}            
-        bNested = False
-        for k, v in oJson.items():
-            if re.match('^\s*\${\s*', k.lower()):
-                keyAfterProcessed = self.__nestedParamHandler(k)
-                k = re.sub('^\s*\${\s*(.*?)\s*}', '\\1', keyAfterProcessed)
-                bNested = True
-                
-            if isinstance(v, dict):
-                v = self.__updateAndReplaceNestedParam(v, recursive=True)
-                if bNested:
-                    if '[' in k:
-                        sExec = k + " = \'" + v + "\'" if isinstance(v, str) else k + " = " + str(v) 
-                        try:
-                            exec(sExec, globals())
-                        except:
-                            raise Exception("Could not set variable \'%s\' with value \'%s\'" %(k, v))
-                    else:
-                        tmpJson[k] = v 
-                    bNested = False
-                else:
-                    tmpJson[k] = v
-            
-            elif isinstance(v, str) and re.match('^.*\s*\${\s*', v.lower()):
-                
-                valueAfterProcessed = self.__nestedParamHandler(v)
-                tmpValueAfterProcessed = re.sub('\\${\s*(.*?)\s*}', '\\1', valueAfterProcessed)
-                sExec = "value = " + tmpValueAfterProcessed if isinstance(tmpValueAfterProcessed, str) else \
-                        "value = " + str(tmpValueAfterProcessed)
-
-                try:
-                    ldict = {}
-                    exec(sExec, globals(), ldict)
-                    v = ldict['value'] if v.strip()==valueAfterProcessed else \
-                        v.replace(valueAfterProcessed, str(ldict['value']))
-                except:
-                    raise Exception('The variable %s is not available!!!' % (tmpValueAfterProcessed))
-                
-                if bNested:
-                    if '[' in k:
-                        sExec = k + " = \'" + v + "\'" if isinstance(v, str) else k + " = " + str(v) 
-                        try:
-                            exec(sExec, globals())
-                        except:
-                            raise Exception("Could not set variable \'%s\' with value \'%s\'" %(k, v))
-                    else:
-                        tmpJson[k] = v 
-                    bNested = False
-                else:
-                    tmpJson[k] = v
-                
-            else:
-                if bNested:
-                    if '[' in k:
-                        sExec = k + " = \'" + v + "\'" if isinstance(v, str) else k + " = " + str(v) 
-                        try:
-                            exec(sExec, globals())
-                        except:
-                            raise Exception("Could not set variable \'%s\' with value \'%s\'" %(k, v))
-                    else:
-                        tmpJson[k] = v
-                    
-                    bNested = False
-                    
-        oJson.update(tmpJson)
-
-        return oJson
-
-
[docs]    def jsonLoad(self, jFile, masterFile=True):
-        '''
-        Method: jsonLoad loads the json file then parses to dict object
-        
-        Args:
-            jFile: string, json file input
-        Returns:
-            oJson: dict
-        '''
-        try:
-            lJsonData, jsonPath = self.__removeComments(jFile)
-        except Exception as reason:
-            raise Exception("Could not read json configuration file %s due to: %s \n\
-                             Please input 'utf-8' format in Json configuration file only" %(jFile, reason))
-
-        currentDir = os.getcwd()
-        self.lImportedFiles.append(os.path.abspath(jFile))
-        os.chdir(jsonPath)
-        CJSONDecoder = None
-        if self.syntax != CSyntaxType.json:
-            if self.syntax == CSyntaxType.python:
-                CJSONDecoder = CPythonJSONDecoder
-            else:
-                raise Exception('Provided syntax \'%s\' is not supported.' %self.syntax)
-
-        try:
-            oJson = json.loads("\n".join(lJsonData), 
-                               cls=CJSONDecoder , 
-                               object_pairs_hook=self.__processImportFiles)
-        except Exception as error:
-            raise Exception("JSON configuration file '%s': %s" %(jFile, error))
-        
-        os.chdir(currentDir)
-        if masterFile:
-            for k, v in oJson.items():
-                globals().update({k:v})
-            oJson = self.__updateAndReplaceNestedParam(oJson)
-        # oJson['JsonPath'] = jsonPath      # is JsonPath required?
-            
-        return oJson

-
- -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/_modules/index.html b/doc/_build/html/_modules/index.html deleted file mode 100644 index 96a7ee01..00000000 --- a/doc/_build/html/_modules/index.html +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - Overview: module code — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - -
-
-
- - -
- -

All modules for which code is available

- - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/_sources/CJsonPreprocessor.rst.txt b/doc/_build/html/_sources/CJsonPreprocessor.rst.txt deleted file mode 100644 index 63f2fb1a..00000000 --- a/doc/_build/html/_sources/CJsonPreprocessor.rst.txt +++ /dev/null @@ -1,25 +0,0 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -JsonPreprocessor package -======================== - - -Module contents ---------------- - -.. automodule:: CJsonPreprocessor - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/_build/html/_sources/additional_doc/feature_documentation.rst.txt b/doc/_build/html/_sources/additional_doc/feature_documentation.rst.txt deleted file mode 100644 index 711a3465..00000000 --- a/doc/_build/html/_sources/additional_doc/feature_documentation.rst.txt +++ /dev/null @@ -1,420 +0,0 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -Json Preprocessor's Feature Documentation -========================================= - -Introduction: -------------- - -.. image:: /images/python3-jsonpreprocessor.png - -The JsonPreprocessor is the python3 package which allows programmer to handle some -additional features in json file such as comment, import, override, etc for -configuring purpose. The json file containing comment, import,... will be handled -by JsonPreprocessor package then returned the final dictionary object for python -program. - -New features -~~~~~~~~~~~~ - -`Adding comments to Json file`_ - -`Import the contents from other json files`_ - -`Overwrite existing and add new parameters`_ - -`Nested parameters`_ - -Features in details -------------------- - -Adding comments to Json file -~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The JsonPreprocessor allows adding comments into json file, a comment could be -added follow **"//"**. - -This is required becuase some big projects require a large json configuration file -which contains a huge number of configuration parameters for the different features. -Therefore, having the need of adding comments into json file to clarify the different -configuration parameters. - -**Note:** This package is not allow commented a block of json code, each comment -must be added with **"//"**. - -**Example:** - -.. code-block:: - - //***************************************************************************** - // Author: ROBFW-AIO Team - // - // This file defines all common global parameters and will be included to all - // test config files - //***************************************************************************** - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - // Version control information. - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - // Global parameters - "global": { - "gGlobalIntParam" : 1, - "gGlobalFloatParam" : 1.332, // This parameter is used to configure for .... - "gGlobalString" : "This is a string", - "gGlobalStructure": { - "general": "general" - } - } - }, - "preprocessor": { - "definitions": { - // FEATURE switches - "gPreprolIntParam" : 1, - "gPreproFloatParam" : 1.332, - // The parameter for feature ABC - "gPreproString" : "This is a string", - "gPreproStructure": { - "general": "general" - } - } - }, - "TargetName" : "gen3flex@dlt" - } - -Import the contents from other json files -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This import feature allows user merges the content of other json files into the -json file, it also allows the nested importing means we can use import feature in -the imported files. - -The import feature helps user distinguish the configuration parameters of each -functions, purposes, variants, and so forth into the separate json files. Therefore, -we can easy to understand and manage the configuration parameters of big project. - -**Example:** - -Suppose we have the json file ``params_global.json`` with the content: - -.. code-block:: - - //***************************************************************************** - // Author: ROBFW-AIO Team - // - // This file defines all common global parameters and will be included to all - // test config files - //***************************************************************************** - // - // This is to distinguish the different types of resets - { - "gGlobalIntParam" : 1, - - "gGlobalFloatParam" : 1.332, // This parameter is used to configure for .... - - "gGlobalString" : "This is a string", - - "gGlobalStructure": { - "general": "general" - } - } - -And other json file ``preprocessor_definitions.json`` with content: - -.. code-block:: - - //***************************************************************************** - // Author: ROBFW-AIO Team - // - // This file defines all common global parameters and will be included to all - // test config files - //***************************************************************************** - { - "gPreprolIntParam" : 1, - - "gPreproFloatParam" : 1.332, - // The parameter for feature ABC - "gPreproString" : "This is a string", - - "gPreproStructure": { - "general": "general" - } - } - -Then we can import these 2 files above to the json file ``config.json`` with content: - -.. code-block:: - - //***************************************************************************** - // Author: ROBFW-AIO Team - // - // This file defines all common global parameters and will be included to all - // test config files - //***************************************************************************** - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - // Version control information. - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - // Global parameters - "global": { - "[import]": "/params_global.json" - } - }, - "preprocessor": { - "definitions": { - // FEATURE switches - "[import]": "/preprocessor_definitions.json" - } - }, - "TargetName" : "gen3flex@dlt" - } - -The ``config.json`` file is handled by JsonPreprocessor package, then return the dictionary object for a program like below: - -.. code-block:: - - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - "global": { - "gGlobalIntParam" : 1, - "gGlobalFloatParam" : 1.332, - "gGlobalString" : "This is a string", - "gGlobalStructure": { - "general": "general" - } - } - }, - "preprocessor": { - "definitions": { - "gPreprolIntParam" : 1, - "gPreproFloatParam" : 1.332, - "gPreproString" : "This is a string", - "gPreproStructure": { - "general": "general" - } - } - }, - "TargetName" : "gen3flex@dlt" - } - -Overwrite existing and add new parameters -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -This package also provides user ability to overwrite or update as well as add new -parameters. User can update parameters which are already declared and add new parameters -or new element into existing parameters. The below example will show the way to do -these features. - -In case we have many different variants, and each varaint requires a different value -assigned to the parameter. This feature could help us update new value for existen -parameters, it also supports to add new parameters to existen configuation object. - -**Example:** - -Suppose we have the json file ``params_global.json`` with the content: - -.. code-block:: - - { - "gGlobalIntParam" : 1, - - "gGlobalFloatParam" : 1.332, // This parameter is used to configure for .... - - "gGlobalString" : "This is a string", - - "gGlobalStructure": { - "general": "general" - } - } - -Then we import ``params_global.json`` to json file ``config.json`` with content: - -.. code-block:: - - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - // Version control information. - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - // Global parameters - "global": { - "[import]": "/params_global.json" - } - }, - "TargetName" : "gen3flex@dlt", - // Overwrite parameters - "${params}['global']['gGlobalFloatParam']": 9.999, - "${version}['patchversion']": "2", - "${params}['global']['gGlobalString']": "This is the new value for the already existing parameter.", - // Add new parameters - "${newParam}": { - "abc": 9, - "xyz": "new param" - }, - "${params}['global']['gGlobalStructure']['newGlobalParam']": 123 - } - -The ``config.json`` file is handled by JsonPreprocessor package, then return the dictionary object for a program like below: - -.. code-block:: - - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "2" - }, - "params": { - "global": { - "gGlobalIntParam" : 1, - "gGlobalFloatParam" : 9.999, - "gGlobalString" : "This is the new value for the already existing parameter.", - "gGlobalStructure": { - "general": "general", - "newGlobalParam": 123 - } - } - }, - "TargetName": "gen3flex@dlt", - "newParam": { - "abc": 9, - "xyz": "new param" - } - } - -Nested parameters -~~~~~~~~~~~~~~~~~ - -With JsonPreprocessor package, user can also use nested parameters as example below: - -**Example:** - -Suppose we have the json file ``config.json`` with the content: - -.. code-block:: - - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - // Version control information. - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - // Global parameters - "global": { - "gGlobalIntParam" : 1, - "gGlobalFloatParam" : 1.332, // This parameter is used to configure for .... - "gGlobalString" : "This is a string", - "gGlobalStructure": { - "general": "general" - } - } - }, - "preprocessor": { - "definitions": { - "gPreprolIntParam" : 1, - "gPreproFloatParam" : 9.664, - "ABC": "checkABC", - "gPreproString" : "This is a string", - "gPreproStructure": { - "general": "general" - } - } - }, - "TargetName" : "gen3flex@dlt", - // Nested parameter - "${params}['global'][${preprocessor}['definitions']['ABC']]": true, - "${params}['global']['gGlobalFloatParam']": "${preprocessor}['definitions']['gPreproFloatParam']" - } - -The ``config.json`` file is handled by JsonPreprocessor package, then return the dictionary object for a program like below: - -.. code-block:: - - { - "Project": "G3g", - "WelcomeString": "Hello... ROBFW is running now!", - "version": { - "majorversion": "0", - "minorversion": "1", - "patchversion": "1" - }, - "params": { - "global": { - "gGlobalIntParam" : 1, - "gGlobalFloatParam" : 9.664, - "gGlobalString" : "This is a string", - "gGlobalStructure": { - "general": "general" - }, - "checkABC": true - } - }, - "preprocessor": { - "definitions": { - "gPreprolIntParam" : 1, - "gPreproFloatParam" : 9.664, - "ABC": "checkABC", - "gPreproString" : "This is a string", - "gPreproStructure": { - "general": "general" - } - } - }, - "TargetName" : "gen3flex@dlt" - } - -Feedback --------- - -To give us a feedback, you can send an email to `Thomas Pollerspöck `_ or -`RBVH-ECM-Automation_Test_Framework-Associates `_ - -In case you want to report a bug or request any interesting feature, please don't hesitate to rasie a ticket on -`our Jira `_ - -References ----------- - -For more information please refer to our `Bosch Connect Community `_ - diff --git a/doc/_build/html/_sources/index.rst.txt b/doc/_build/html/_sources/index.rst.txt deleted file mode 100644 index e847ced9..00000000 --- a/doc/_build/html/_sources/index.rst.txt +++ /dev/null @@ -1,31 +0,0 @@ -.. Copyright 2020-2022 Robert Bosch Car Multimedia GmbH - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -.. The Json Preprocessor documentation master file, created by - sphinx-quickstart on Tue Jun 22 10:06:14 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - - -Json Preprocessor's API! -======================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - ./additional_doc/feature_documentation.rst - ./CJsonPreprocessor.rst - - diff --git a/doc/_build/html/_static/alabaster.css b/doc/_build/html/_static/alabaster.css deleted file mode 100644 index 0eddaeb0..00000000 --- a/doc/_build/html/_static/alabaster.css +++ /dev/null @@ -1,701 +0,0 @@ -@import url("basic.css"); - -/* -- page layout ----------------------------------------------------------- */ - -body { - font-family: Georgia, serif; - font-size: 17px; - background-color: #fff; - color: #000; - margin: 0; - padding: 0; -} - - -div.document { - width: 940px; - margin: 30px auto 0 auto; -} - -div.documentwrapper { - float: left; - width: 100%; -} - -div.bodywrapper { - margin: 0 0 0 220px; -} - -div.sphinxsidebar { - width: 220px; - font-size: 14px; - line-height: 1.5; -} - -hr { - border: 1px solid #B1B4B6; -} - -div.body { - background-color: #fff; - color: #3E4349; - padding: 0 30px 0 30px; -} - -div.body > .section { - text-align: left; -} - -div.footer { - width: 940px; - margin: 20px auto 30px auto; - font-size: 14px; - color: #888; - text-align: right; -} - -div.footer a { - color: #888; -} - -p.caption { - font-family: inherit; - font-size: inherit; -} - - -div.relations { - display: none; -} - - -div.sphinxsidebar a { - color: #444; - text-decoration: none; - border-bottom: 1px dotted #999; -} - -div.sphinxsidebar a:hover { - border-bottom: 1px solid #999; -} - -div.sphinxsidebarwrapper { - padding: 18px 10px; -} - -div.sphinxsidebarwrapper p.logo { - padding: 0; - margin: -10px 0 0 0px; - text-align: center; -} - -div.sphinxsidebarwrapper h1.logo { - margin-top: -10px; - text-align: center; - margin-bottom: 5px; - text-align: left; -} - -div.sphinxsidebarwrapper h1.logo-name { - margin-top: 0px; -} - -div.sphinxsidebarwrapper p.blurb { - margin-top: 0; - font-style: normal; -} - -div.sphinxsidebar h3, -div.sphinxsidebar h4 { - font-family: Georgia, serif; - color: #444; - font-size: 24px; - font-weight: normal; - margin: 0 0 5px 0; - padding: 0; -} - -div.sphinxsidebar h4 { - font-size: 20px; -} - -div.sphinxsidebar h3 a { - color: #444; -} - -div.sphinxsidebar p.logo a, -div.sphinxsidebar h3 a, -div.sphinxsidebar p.logo a:hover, -div.sphinxsidebar h3 a:hover { - border: none; -} - -div.sphinxsidebar p { - color: #555; - margin: 10px 0; -} - -div.sphinxsidebar ul { - margin: 10px 0; - padding: 0; - color: #000; -} - -div.sphinxsidebar ul li.toctree-l1 > a { - font-size: 120%; -} - -div.sphinxsidebar ul li.toctree-l2 > a { - font-size: 110%; -} - -div.sphinxsidebar input { - border: 1px solid #CCC; - font-family: Georgia, serif; - font-size: 1em; -} - -div.sphinxsidebar hr { - border: none; - height: 1px; - color: #AAA; - background: #AAA; - - text-align: left; - margin-left: 0; - width: 50%; -} - -div.sphinxsidebar .badge { - border-bottom: none; -} - -div.sphinxsidebar .badge:hover { - border-bottom: none; -} - -/* To address an issue with donation coming after search */ -div.sphinxsidebar h3.donation { - margin-top: 10px; -} - -/* -- body styles ----------------------------------------------------------- */ - -a { - color: #004B6B; - text-decoration: underline; -} - -a:hover { - color: #6D4100; - text-decoration: underline; -} - -div.body h1, -div.body h2, -div.body h3, -div.body h4, -div.body h5, -div.body h6 { - font-family: Georgia, serif; - font-weight: normal; - margin: 30px 0px 10px 0px; - padding: 0; -} - -div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } -div.body h2 { font-size: 180%; } -div.body h3 { font-size: 150%; } -div.body h4 { font-size: 130%; } -div.body h5 { font-size: 100%; } -div.body h6 { font-size: 100%; } - -a.headerlink { - color: #DDD; - padding: 0 4px; - text-decoration: none; -} - -a.headerlink:hover { - color: #444; - background: #EAEAEA; -} - -div.body p, div.body dd, div.body li { - line-height: 1.4em; -} - -div.admonition { - margin: 20px 0px; - padding: 10px 30px; - background-color: #EEE; - border: 1px solid #CCC; -} - -div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fafafa; -} - -div.admonition p.admonition-title { - font-family: Georgia, serif; - font-weight: normal; - font-size: 24px; - margin: 0 0 10px 0; - padding: 0; - line-height: 1; -} - -div.admonition p.last { - margin-bottom: 0; -} - -div.highlight { - background-color: #fff; -} - -dt:target, .highlight { - background: #FAF3E8; -} - -div.warning { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.danger { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.error { - background-color: #FCC; - border: 1px solid #FAA; - -moz-box-shadow: 2px 2px 4px #D52C2C; - -webkit-box-shadow: 2px 2px 4px #D52C2C; - box-shadow: 2px 2px 4px #D52C2C; -} - -div.caution { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.attention { - background-color: #FCC; - border: 1px solid #FAA; -} - -div.important { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.note { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.tip { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.hint { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.seealso { - background-color: #EEE; - border: 1px solid #CCC; -} - -div.topic { - background-color: #EEE; -} - -p.admonition-title { - display: inline; -} - -p.admonition-title:after { - content: ":"; -} - -pre, tt, code { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; - font-size: 0.9em; -} - -.hll { - background-color: #FFC; - margin: 0 -12px; - padding: 0 12px; - display: block; -} - -img.screenshot { -} - -tt.descname, tt.descclassname, code.descname, code.descclassname { - font-size: 0.95em; -} - -tt.descname, code.descname { - padding-right: 0.08em; -} - -img.screenshot { - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils { - border: 1px solid #888; - -moz-box-shadow: 2px 2px 4px #EEE; - -webkit-box-shadow: 2px 2px 4px #EEE; - box-shadow: 2px 2px 4px #EEE; -} - -table.docutils td, table.docutils th { - border: 1px solid #888; - padding: 0.25em 0.7em; -} - -table.field-list, table.footnote { - border: none; - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - -table.footnote { - margin: 15px 0; - width: 100%; - border: 1px solid #EEE; - background: #FDFDFD; - font-size: 0.9em; -} - -table.footnote + table.footnote { - margin-top: -15px; - border-top: none; -} - -table.field-list th { - padding: 0 0.8em 0 0; -} - -table.field-list td { - padding: 0; -} - -table.field-list p { - margin-bottom: 0.8em; -} - -/* Cloned from - * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 - */ -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -table.footnote td.label { - width: .1px; - padding: 0.3em 0 0.3em 0.5em; -} - -table.footnote td { - padding: 0.3em 0.5em; -} - -dl { - margin: 0; - padding: 0; -} - -dl dd { - margin-left: 30px; -} - -blockquote { - margin: 0 0 0 30px; - padding: 0; -} - -ul, ol { - /* Matches the 30px from the narrow-screen "li > ul" selector below */ - margin: 10px 0 10px 30px; - padding: 0; -} - -pre { - background: #EEE; - padding: 7px 30px; - margin: 15px 0px; - line-height: 1.3em; -} - -div.viewcode-block:target { - background: #ffd; -} - -dl pre, blockquote pre, li pre { - margin-left: 0; - padding-left: 30px; -} - -tt, code { - background-color: #ecf0f3; - color: #222; - /* padding: 1px 2px; */ -} - -tt.xref, code.xref, a tt { - background-color: #FBFBFB; - border-bottom: 1px solid #fff; -} - -a.reference { - text-decoration: none; - border-bottom: 1px dotted #004B6B; -} - -/* Don't put an underline on images */ -a.image-reference, a.image-reference:hover { - border-bottom: none; -} - -a.reference:hover { - border-bottom: 1px solid #6D4100; -} - -a.footnote-reference { - text-decoration: none; - font-size: 0.7em; - vertical-align: top; - border-bottom: 1px dotted #004B6B; -} - -a.footnote-reference:hover { - border-bottom: 1px solid #6D4100; -} - -a:hover tt, a:hover code { - background: #EEE; -} - - -@media screen and (max-width: 870px) { - - div.sphinxsidebar { - display: none; - } - - div.document { - width: 100%; - - } - - div.documentwrapper { - margin-left: 0; - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - } - - div.bodywrapper { - margin-top: 0; - margin-right: 0; - margin-bottom: 0; - margin-left: 0; - } - - ul { - margin-left: 0; - } - - li > ul { - /* Matches the 30px from the "ul, ol" selector above */ - margin-left: 30px; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .bodywrapper { - margin: 0; - } - - .footer { - width: auto; - } - - .github { - display: none; - } - - - -} - - - -@media screen and (max-width: 875px) { - - body { - margin: 0; - padding: 20px 30px; - } - - div.documentwrapper { - float: none; - background: #fff; - } - - div.sphinxsidebar { - display: block; - float: none; - width: 102.5%; - margin: 50px -30px -20px -30px; - padding: 10px 20px; - background: #333; - color: #FFF; - } - - div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, - div.sphinxsidebar h3 a { - color: #fff; - } - - div.sphinxsidebar a { - color: #AAA; - } - - div.sphinxsidebar p.logo { - display: none; - } - - div.document { - width: 100%; - margin: 0; - } - - div.footer { - display: none; - } - - div.bodywrapper { - margin: 0; - } - - div.body { - min-height: 0; - padding: 0; - } - - .rtd_doc_footer { - display: none; - } - - .document { - width: auto; - } - - .footer { - width: auto; - } - - .footer { - width: auto; - } - - .github { - display: none; - } -} - - -/* misc. */ - -.revsys-inline { - display: none!important; -} - -/* Make nested-list/multi-paragraph items look better in Releases changelog - * pages. Without this, docutils' magical list fuckery causes inconsistent - * formatting between different release sub-lists. - */ -div#changelog > div.section > ul > li > p:only-child { - margin-bottom: 0; -} - -/* Hide fugly table cell borders in ..bibliography:: directive output */ -table.docutils.citation, table.docutils.citation td, table.docutils.citation th { - border: none; - /* Below needed in some edge cases; if not applied, bottom shadows appear */ - -moz-box-shadow: none; - -webkit-box-shadow: none; - box-shadow: none; -} - - -/* relbar */ - -.related { - line-height: 30px; - width: 100%; - font-size: 0.9rem; -} - -.related.top { - border-bottom: 1px solid #EEE; - margin-bottom: 20px; -} - -.related.bottom { - border-top: 1px solid #EEE; -} - -.related ul { - padding: 0; - margin: 0; - list-style: none; -} - -.related li { - display: inline; -} - -nav#rellinks { - float: right; -} - -nav#rellinks li+li:before { - content: "|"; -} - -nav#breadcrumbs li+li:before { - content: "\00BB"; -} - -/* Hide certain items when printing */ -@media print { - div.related { - display: none; - } -} \ No newline at end of file diff --git a/doc/_build/html/_static/basic.css b/doc/_build/html/_static/basic.css deleted file mode 100644 index 603f6a87..00000000 --- a/doc/_build/html/_static/basic.css +++ /dev/null @@ -1,905 +0,0 @@ -/* - * basic.css - * ~~~~~~~~~ - * - * Sphinx stylesheet -- basic theme. - * - * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/* -- main layout ----------------------------------------------------------- */ - -div.clearer { - clear: both; -} - -div.section::after { - display: block; - content: ''; - clear: left; -} - -/* -- relbar ---------------------------------------------------------------- */ - -div.related { - width: 100%; - font-size: 90%; -} - -div.related h3 { - display: none; -} - -div.related ul { - margin: 0; - padding: 0 0 0 10px; - list-style: none; -} - -div.related li { - display: inline; -} - -div.related li.right { - float: right; - margin-right: 5px; -} - -/* -- sidebar --------------------------------------------------------------- */ - -div.sphinxsidebarwrapper { - padding: 10px 5px 0 10px; -} - -div.sphinxsidebar { - float: left; - width: 230px; - margin-left: -100%; - font-size: 90%; - word-wrap: break-word; - overflow-wrap : break-word; -} - -div.sphinxsidebar ul { - list-style: none; -} - -div.sphinxsidebar ul ul, -div.sphinxsidebar ul.want-points { - margin-left: 20px; - list-style: square; -} - -div.sphinxsidebar ul ul { - margin-top: 0; - margin-bottom: 0; -} - -div.sphinxsidebar form { - margin-top: 10px; -} - -div.sphinxsidebar input { - border: 1px solid #98dbcc; - font-family: sans-serif; - font-size: 1em; -} - -div.sphinxsidebar #searchbox form.search { - overflow: hidden; -} - -div.sphinxsidebar #searchbox input[type="text"] { - float: left; - width: 80%; - padding: 0.25em; - box-sizing: border-box; -} - -div.sphinxsidebar #searchbox input[type="submit"] { - float: left; - width: 20%; - border-left: none; - padding: 0.25em; - box-sizing: border-box; -} - - -img { - border: 0; - max-width: 100%; -} - -/* -- search page ----------------------------------------------------------- */ - -ul.search { - margin: 10px 0 0 20px; - padding: 0; -} - -ul.search li { - padding: 5px 0 5px 20px; - background-image: url(file.png); - background-repeat: no-repeat; - background-position: 0 7px; -} - -ul.search li a { - font-weight: bold; -} - -ul.search li p.context { - color: #888; - margin: 2px 0 0 30px; - text-align: left; -} - -ul.keywordmatches li.goodmatch a { - font-weight: bold; -} - -/* -- index page ------------------------------------------------------------ */ - -table.contentstable { - width: 90%; - margin-left: auto; - margin-right: auto; -} - -table.contentstable p.biglink { - line-height: 150%; -} - -a.biglink { - font-size: 1.3em; -} - -span.linkdescr { - font-style: italic; - padding-top: 5px; - font-size: 90%; -} - -/* -- general index --------------------------------------------------------- */ - -table.indextable { - width: 100%; -} - -table.indextable td { - text-align: left; - vertical-align: top; -} - -table.indextable ul { - margin-top: 0; - margin-bottom: 0; - list-style-type: none; -} - -table.indextable > tbody > tr > td > ul { - padding-left: 0em; -} - -table.indextable tr.pcap { - height: 10px; -} - -table.indextable tr.cap { - margin-top: 10px; - background-color: #f2f2f2; -} - -img.toggler { - margin-right: 3px; - margin-top: 3px; - cursor: pointer; -} - -div.modindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -div.genindex-jumpbox { - border-top: 1px solid #ddd; - border-bottom: 1px solid #ddd; - margin: 1em 0 1em 0; - padding: 0.4em; -} - -/* -- domain module index --------------------------------------------------- */ - -table.modindextable td { - padding: 2px; - border-collapse: collapse; -} - -/* -- general body styles --------------------------------------------------- */ - -div.body { - min-width: 450px; - max-width: 800px; -} - -div.body p, div.body dd, div.body li, div.body blockquote { - -moz-hyphens: auto; - -ms-hyphens: auto; - -webkit-hyphens: auto; - hyphens: auto; -} - -a.headerlink { - visibility: hidden; -} - -a.brackets:before, -span.brackets > a:before{ - content: "["; -} - -a.brackets:after, -span.brackets > a:after { - content: "]"; -} - -h1:hover > a.headerlink, -h2:hover > a.headerlink, -h3:hover > a.headerlink, -h4:hover > a.headerlink, -h5:hover > a.headerlink, -h6:hover > a.headerlink, -dt:hover > a.headerlink, -caption:hover > a.headerlink, -p.caption:hover > a.headerlink, -div.code-block-caption:hover > a.headerlink { - visibility: visible; -} - -div.body p.caption { - text-align: inherit; -} - -div.body td { - text-align: left; -} - -.first { - margin-top: 0 !important; -} - -p.rubric { - margin-top: 30px; - font-weight: bold; -} - -img.align-left, figure.align-left, .figure.align-left, object.align-left { - clear: left; - float: left; - margin-right: 1em; -} - -img.align-right, figure.align-right, .figure.align-right, object.align-right { - clear: right; - float: right; - margin-left: 1em; -} - -img.align-center, figure.align-center, .figure.align-center, object.align-center { - display: block; - margin-left: auto; - margin-right: auto; -} - -img.align-default, figure.align-default, .figure.align-default { - display: block; - margin-left: auto; - margin-right: auto; -} - -.align-left { - text-align: left; -} - -.align-center { - text-align: center; -} - -.align-default { - text-align: center; -} - -.align-right { - text-align: right; -} - -/* -- sidebars -------------------------------------------------------------- */ - -div.sidebar, -aside.sidebar { - margin: 0 0 0.5em 1em; - border: 1px solid #ddb; - padding: 7px; - background-color: #ffe; - width: 40%; - float: right; - clear: right; - overflow-x: auto; -} - -p.sidebar-title { - font-weight: bold; -} - -div.admonition, div.topic, blockquote { - clear: left; -} - -/* -- topics ---------------------------------------------------------------- */ - -div.topic { - border: 1px solid #ccc; - padding: 7px; - margin: 10px 0 10px 0; -} - -p.topic-title { - font-size: 1.1em; - font-weight: bold; - margin-top: 10px; -} - -/* -- admonitions ----------------------------------------------------------- */ - -div.admonition { - margin-top: 10px; - margin-bottom: 10px; - padding: 7px; -} - -div.admonition dt { - font-weight: bold; -} - -p.admonition-title { - margin: 0px 10px 5px 0px; - font-weight: bold; -} - -div.body p.centered { - text-align: center; - margin-top: 25px; -} - -/* -- content of sidebars/topics/admonitions -------------------------------- */ - -div.sidebar > :last-child, -aside.sidebar > :last-child, -div.topic > :last-child, -div.admonition > :last-child { - margin-bottom: 0; -} - -div.sidebar::after, -aside.sidebar::after, -div.topic::after, -div.admonition::after, -blockquote::after { - display: block; - content: ''; - clear: both; -} - -/* -- tables ---------------------------------------------------------------- */ - -table.docutils { - margin-top: 10px; - margin-bottom: 10px; - border: 0; - border-collapse: collapse; -} - -table.align-center { - margin-left: auto; - margin-right: auto; -} - -table.align-default { - margin-left: auto; - margin-right: auto; -} - -table caption span.caption-number { - font-style: italic; -} - -table caption span.caption-text { -} - -table.docutils td, table.docutils th { - padding: 1px 8px 1px 5px; - border-top: 0; - border-left: 0; - border-right: 0; - border-bottom: 1px solid #aaa; -} - -table.footnote td, table.footnote th { - border: 0 !important; -} - -th { - text-align: left; - padding-right: 5px; -} - -table.citation { - border-left: solid 1px gray; - margin-left: 1px; -} - -table.citation td { - border-bottom: none; -} - -th > :first-child, -td > :first-child { - margin-top: 0px; -} - -th > :last-child, -td > :last-child { - margin-bottom: 0px; -} - -/* -- figures --------------------------------------------------------------- */ - -div.figure, figure { - margin: 0.5em; - padding: 0.5em; -} - -div.figure p.caption, figcaption { - padding: 0.3em; -} - -div.figure p.caption span.caption-number, -figcaption span.caption-number { - font-style: italic; -} - -div.figure p.caption span.caption-text, -figcaption span.caption-text { -} - -/* -- field list styles ----------------------------------------------------- */ - -table.field-list td, table.field-list th { - border: 0 !important; -} - -.field-list ul { - margin: 0; - padding-left: 1em; -} - -.field-list p { - margin: 0; -} - -.field-name { - -moz-hyphens: manual; - -ms-hyphens: manual; - -webkit-hyphens: manual; - hyphens: manual; -} - -/* -- hlist styles ---------------------------------------------------------- */ - -table.hlist { - margin: 1em 0; -} - -table.hlist td { - vertical-align: top; -} - -/* -- object description styles --------------------------------------------- */ - -.sig { - font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; -} - -.sig-name, code.descname { - background-color: transparent; - font-weight: bold; -} - -.sig-name { - font-size: 1.1em; -} - -code.descname { - font-size: 1.2em; -} - -.sig-prename, code.descclassname { - background-color: transparent; -} - -.optional { - font-size: 1.3em; -} - -.sig-paren { - font-size: larger; -} - -.sig-param.n { - font-style: italic; -} - -/* C++ specific styling */ - -.sig-inline.c-texpr, -.sig-inline.cpp-texpr { - font-family: unset; -} - -.sig.c .k, .sig.c .kt, -.sig.cpp .k, .sig.cpp .kt { - color: #0033B3; -} - -.sig.c .m, -.sig.cpp .m { - color: #1750EB; -} - -.sig.c .s, .sig.c .sc, -.sig.cpp .s, .sig.cpp .sc { - color: #067D17; -} - - -/* -- other body styles ----------------------------------------------------- */ - -ol.arabic { - list-style: decimal; -} - -ol.loweralpha { - list-style: lower-alpha; -} - -ol.upperalpha { - list-style: upper-alpha; -} - -ol.lowerroman { - list-style: lower-roman; -} - -ol.upperroman { - list-style: upper-roman; -} - -:not(li) > ol > li:first-child > :first-child, -:not(li) > ul > li:first-child > :first-child { - margin-top: 0px; -} - -:not(li) > ol > li:last-child > :last-child, -:not(li) > ul > li:last-child > :last-child { - margin-bottom: 0px; -} - -ol.simple ol p, -ol.simple ul p, -ul.simple ol p, -ul.simple ul p { - margin-top: 0; -} - -ol.simple > li:not(:first-child) > p, -ul.simple > li:not(:first-child) > p { - margin-top: 0; -} - -ol.simple p, -ul.simple p { - margin-bottom: 0; -} - -dl.footnote > dt, -dl.citation > dt { - float: left; - margin-right: 0.5em; -} - -dl.footnote > dd, -dl.citation > dd { - margin-bottom: 0em; -} - -dl.footnote > dd:after, -dl.citation > dd:after { - content: ""; - clear: both; -} - -dl.field-list { - display: grid; - grid-template-columns: fit-content(30%) auto; -} - -dl.field-list > dt { - font-weight: bold; - word-break: break-word; - padding-left: 0.5em; - padding-right: 5px; -} - -dl.field-list > dt:after { - content: ":"; -} - -dl.field-list > dd { - padding-left: 0.5em; - margin-top: 0em; - margin-left: 0em; - margin-bottom: 0em; -} - -dl { - margin-bottom: 15px; -} - -dd > :first-child { - margin-top: 0px; -} - -dd ul, dd table { - margin-bottom: 10px; -} - -dd { - margin-top: 3px; - margin-bottom: 10px; - margin-left: 30px; -} - -dl > dd:last-child, -dl > dd:last-child > :last-child { - margin-bottom: 0; -} - -dt:target, span.highlighted { - background-color: #fbe54e; -} - -rect.highlighted { - fill: #fbe54e; -} - -dl.glossary dt { - font-weight: bold; - font-size: 1.1em; -} - -.versionmodified { - font-style: italic; -} - -.system-message { - background-color: #fda; - padding: 5px; - border: 3px solid red; -} - -.footnote:target { - background-color: #ffa; -} - -.line-block { - display: block; - margin-top: 1em; - margin-bottom: 1em; -} - -.line-block .line-block { - margin-top: 0; - margin-bottom: 0; - margin-left: 1.5em; -} - -.guilabel, .menuselection { - font-family: sans-serif; -} - -.accelerator { - text-decoration: underline; -} - -.classifier { - font-style: oblique; -} - -.classifier:before { - font-style: normal; - margin: 0 0.5em; - content: ":"; - display: inline-block; -} - -abbr, acronym { - border-bottom: dotted 1px; - cursor: help; -} - -/* -- code displays --------------------------------------------------------- */ - -pre { - overflow: auto; - overflow-y: hidden; /* fixes display issues on Chrome browsers */ -} - -pre, div[class*="highlight-"] { - clear: both; -} - -span.pre { - -moz-hyphens: none; - -ms-hyphens: none; - -webkit-hyphens: none; - hyphens: none; -} - -div[class*="highlight-"] { - margin: 1em 0; -} - -td.linenos pre { - border: 0; - background-color: transparent; - color: #aaa; -} - -table.highlighttable { - display: block; -} - -table.highlighttable tbody { - display: block; -} - -table.highlighttable tr { - display: flex; -} - -table.highlighttable td { - margin: 0; - padding: 0; -} - -table.highlighttable td.linenos { - padding-right: 0.5em; -} - -table.highlighttable td.code { - flex: 1; - overflow: hidden; -} - -.highlight .hll { - display: block; -} - -div.highlight pre, -table.highlighttable pre { - margin: 0; -} - -div.code-block-caption + div { - margin-top: 0; -} - -div.code-block-caption { - margin-top: 1em; - padding: 2px 5px; - font-size: small; -} - -div.code-block-caption code { - background-color: transparent; -} - -table.highlighttable td.linenos, -span.linenos, -div.highlight span.gp { /* gp: Generic.Prompt */ - user-select: none; - -webkit-user-select: text; /* Safari fallback only */ - -webkit-user-select: none; /* Chrome/Safari */ - -moz-user-select: none; /* Firefox */ - -ms-user-select: none; /* IE10+ */ -} - -div.code-block-caption span.caption-number { - padding: 0.1em 0.3em; - font-style: italic; -} - -div.code-block-caption span.caption-text { -} - -div.literal-block-wrapper { - margin: 1em 0; -} - -code.xref, a code { - background-color: transparent; - font-weight: bold; -} - -h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { - background-color: transparent; -} - -.viewcode-link { - float: right; -} - -.viewcode-back { - float: right; - font-family: sans-serif; -} - -div.viewcode-block:target { - margin: -1px -10px; - padding: 0 10px; -} - -/* -- math display ---------------------------------------------------------- */ - -img.math { - vertical-align: middle; -} - -div.body div.math p { - text-align: center; -} - -span.eqno { - float: right; -} - -span.eqno a.headerlink { - position: absolute; - z-index: 1; -} - -div.math:hover a.headerlink { - visibility: visible; -} - -/* -- printout stylesheet --------------------------------------------------- */ - -@media print { - div.document, - div.documentwrapper, - div.bodywrapper { - margin: 0 !important; - width: 100%; - } - - div.sphinxsidebar, - div.related, - div.footer, - #top-link { - display: none; - } -} \ No newline at end of file diff --git a/doc/_build/html/_static/custom.css b/doc/_build/html/_static/custom.css deleted file mode 100644 index 2a924f1d..00000000 --- a/doc/_build/html/_static/custom.css +++ /dev/null @@ -1 +0,0 @@ -/* This file intentionally left blank. */ diff --git a/doc/_build/html/_static/doctools.js b/doc/_build/html/_static/doctools.js deleted file mode 100644 index 8cbf1b16..00000000 --- a/doc/_build/html/_static/doctools.js +++ /dev/null @@ -1,323 +0,0 @@ -/* - * doctools.js - * ~~~~~~~~~~~ - * - * Sphinx JavaScript utilities for all documentation. - * - * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS. - * :license: BSD, see LICENSE for details. - * - */ - -/** - * select a different prefix for underscore - */ -$u = _.noConflict(); - -/** - * make the code below compatible with browsers without - * an installed firebug like debugger -if (!window.console || !console.firebug) { - var names = ["log", "debug", "info", "warn", "error", "assert", "dir", - "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", - "profile", "profileEnd"]; - window.console = {}; - for (var i = 0; i < names.length; ++i) - window.console[names[i]] = function() {}; -} - */ - -/** - * small helper function to urldecode strings - * - * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL - */ -jQuery.urldecode = function(x) { - if (!x) { - return x - } - return decodeURIComponent(x.replace(/\+/g, ' ')); -}; - -/** - * small helper function to urlencode strings - */ -jQuery.urlencode = encodeURIComponent; - -/** - * This function returns the parsed url parameters of the - * current request. Multiple values per key are supported, - * it will always return arrays of strings for the value parts. - */ -jQuery.getQueryParameters = function(s) { - if (typeof s === 'undefined') - s = document.location.search; - var parts = s.substr(s.indexOf('?') + 1).split('&'); - var result = {}; - for (var i = 0; i < parts.length; i++) { - var tmp = parts[i].split('=', 2); - var key = jQuery.urldecode(tmp[0]); - var value = jQuery.urldecode(tmp[1]); - if (key in result) - result[key].push(value); - else - result[key] = [value]; - } - return result; -}; - -/** - * highlight a given string on a jquery object by wrapping it in - * span elements with the given class name. - */ -jQuery.fn.highlightText = function(text, className) { - function highlight(node, addItems) { - if (node.nodeType === 3) { - var val = node.nodeValue; - var pos = val.toLowerCase().indexOf(text); - if (pos >= 0 && - !jQuery(node.parentNode).hasClass(className) && - !jQuery(node.parentNode).hasClass("nohighlight")) { - var span; - var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); - if (isInSVG) { - span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); - } else { - span = document.createElement("span"); - span.className = className; - } - span.appendChild(document.createTextNode(val.substr(pos, text.length))); - node.parentNode.insertBefore(span, node.parentNode.insertBefore( - document.createTextNode(val.substr(pos + text.length)), - node.nextSibling)); - node.nodeValue = val.substr(0, pos); - if (isInSVG) { - var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - var bbox = node.parentElement.getBBox(); - rect.x.baseVal.value = bbox.x; - rect.y.baseVal.value = bbox.y; - rect.width.baseVal.value = bbox.width; - rect.height.baseVal.value = bbox.height; - rect.setAttribute('class', className); - addItems.push({ - "parent": node.parentNode, - "target": rect}); - } - } - } - else if (!jQuery(node).is("button, select, textarea")) { - jQuery.each(node.childNodes, function() { - highlight(this, addItems); - }); - } - } - var addItems = []; - var result = this.each(function() { - highlight(this, addItems); - }); - for (var i = 0; i < addItems.length; ++i) { - jQuery(addItems[i].parent).before(addItems[i].target); - } - return result; -}; - -/* - * backward compatibility for jQuery.browser - * This will be supported until firefox bug is fixed. - */ -if (!jQuery.browser) { - jQuery.uaMatch = function(ua) { - ua = ua.toLowerCase(); - - var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || - /(webkit)[ \/]([\w.]+)/.exec(ua) || - /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || - /(msie) ([\w.]+)/.exec(ua) || - ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || - []; - - return { - browser: match[ 1 ] || "", - version: match[ 2 ] || "0" - }; - }; - jQuery.browser = {}; - jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; -} - -/** - * Small JavaScript module for the documentation. - */ -var Documentation = { - - init : function() { - this.fixFirefoxAnchorBug(); - this.highlightSearchWords(); - this.initIndexTable(); - if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { - this.initOnKeyListeners(); - } - }, - - /** - * i18n support - */ - TRANSLATIONS : {}, - PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, - LOCALE : 'unknown', - - // gettext and ngettext don't access this so that the functions - // can safely bound to a different name (_ = Documentation.gettext) - gettext : function(string) { - var translated = Documentation.TRANSLATIONS[string]; - if (typeof translated === 'undefined') - return string; - return (typeof translated === 'string') ? translated : translated[0]; - }, - - ngettext : function(singular, plural, n) { - var translated = Documentation.TRANSLATIONS[singular]; - if (typeof translated === 'undefined') - return (n == 1) ? singular : plural; - return translated[Documentation.PLURALEXPR(n)]; - }, - - addTranslations : function(catalog) { - for (var key in catalog.messages) - this.TRANSLATIONS[key] = catalog.messages[key]; - this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); - this.LOCALE = catalog.locale; - }, - - /** - * add context elements like header anchor links - */ - addContextElements : function() { - $('div[id] > :header:first').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this headline')). - appendTo(this); - }); - $('dt[id]').each(function() { - $('\u00B6'). - attr('href', '#' + this.id). - attr('title', _('Permalink to this definition')). - appendTo(this); - }); - }, - - /** - * workaround a firefox stupidity - * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 - */ - fixFirefoxAnchorBug : function() { - if (document.location.hash && $.browser.mozilla) - window.setTimeout(function() { - document.location.href += ''; - }, 10); - }, - - /** - * highlight the search words provided in the url in the text - */ - highlightSearchWords : function() { - var params = $.getQueryParameters(); - var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; - if (terms.length) { - var body = $('div.body'); - if (!body.length) { - body = $('body'); - } - window.setTimeout(function() { - $.each(terms, function() { - body.highlightText(this.toLowerCase(), 'highlighted'); - }); - }, 10); - $('

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

') - .appendTo($('#searchbox')); - } - }, - - /** - * init the domain index toggle buttons - */ - initIndexTable : function() { - var togglers = $('img.toggler').click(function() { - var src = $(this).attr('src'); - var idnum = $(this).attr('id').substr(7); - $('tr.cg-' + idnum).toggle(); - if (src.substr(-9) === 'minus.png') - $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); - else - $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); - }).css('display', ''); - if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { - togglers.click(); - } - }, - - /** - * helper function to hide the search marks again - */ - hideSearchWords : function() { - $('#searchbox .highlight-link').fadeOut(300); - $('span.highlighted').removeClass('highlighted'); - }, - - /** - * make the url absolute - */ - makeURL : function(relativeURL) { - return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; - }, - - /** - * get the current relative url - */ - getCurrentURL : function() { - var path = document.location.pathname; - var parts = path.split(/\//); - $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { - if (this === '..') - parts.pop(); - }); - var url = parts.join('/'); - return path.substring(url.lastIndexOf('/') + 1, path.length - 1); - }, - - initOnKeyListeners: function() { - $(document).keydown(function(event) { - var activeElementType = document.activeElement.tagName; - // don't navigate when in search box, textarea, dropdown or button - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' - && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey - && !event.shiftKey) { - switch (event.keyCode) { - case 37: // left - var prevHref = $('link[rel="prev"]').prop('href'); - if (prevHref) { - window.location.href = prevHref; - return false; - } - break; - case 39: // right - var nextHref = $('link[rel="next"]').prop('href'); - if (nextHref) { - window.location.href = nextHref; - return false; - } - break; - } - } - }); - } -}; - -// quick alias for translations -_ = Documentation.gettext; - -$(document).ready(function() { - Documentation.init(); -}); diff --git a/doc/_build/html/_static/documentation_options.js b/doc/_build/html/_static/documentation_options.js deleted file mode 100644 index 4daa6b50..00000000 --- a/doc/_build/html/_static/documentation_options.js +++ /dev/null @@ -1,12 +0,0 @@ -var DOCUMENTATION_OPTIONS = { - URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '', - LANGUAGE: 'en', - COLLAPSE_INDEX: false, - BUILDER: 'html', - FILE_SUFFIX: '.html', - LINK_SUFFIX: '.html', - HAS_SOURCE: true, - SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false -}; \ No newline at end of file diff --git a/doc/_build/html/_static/file.png b/doc/_build/html/_static/file.png deleted file mode 100644 index a858a410..00000000 Binary files a/doc/_build/html/_static/file.png and /dev/null differ diff --git a/doc/_build/html/_static/jquery-3.5.1.js b/doc/_build/html/_static/jquery-3.5.1.js deleted file mode 100644 index 50937333..00000000 --- a/doc/_build/html/_static/jquery-3.5.1.js +++ /dev/null @@ -1,10872 +0,0 @@ -/*! - * 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( " - - - - - - - - - - - - - - - - -
-
-
- - -
- -
-

Json Preprocessor’s Feature Documentation¶

-
-

Introduction:¶

-../_images/python3-jsonpreprocessor.png -

The JsonPreprocessor is the python3 package which allows programmer to handle some -additional features in json file such as comment, import, override, etc for -configuring purpose. The json file containing comment, import,… will be handled -by JsonPreprocessor package then returned the final dictionary object for python -program.

- -
-
-

Features in details¶

-
-

Adding comments to Json file¶

-

The JsonPreprocessor allows adding comments into json file, a comment could be -added follow “//â€.

-

This is required becuase some big projects require a large json configuration file -which contains a huge number of configuration parameters for the different features. -Therefore, having the need of adding comments into json file to clarify the different -configuration parameters.

-

Note: This package is not allow commented a block of json code, each comment -must be added with “//â€.

-

Example:

-
//*****************************************************************************
-//  Author: ROBFW-AIO Team
-//
-//  This file defines all common global parameters and will be included to all
-//  test config files
-//*****************************************************************************
-{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  // Version control information.
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    // Global parameters
-    "global": {
-      "gGlobalIntParam" : 1,
-      "gGlobalFloatParam" : 1.332,  // This parameter is used to configure for ....
-      "gGlobalString"   : "This is a string",
-      "gGlobalStructure": {
-        "general": "general"
-      }
-    }
-  },
-  "preprocessor": {
-    "definitions": {
-      // FEATURE switches
-      "gPreprolIntParam" : 1,
-      "gPreproFloatParam" : 1.332,
-       // The parameter for feature ABC
-      "gPreproString"   : "This is a string",
-      "gPreproStructure": {
-                         "general": "general"
-                        }
-      }
-  },
-  "TargetName" : "gen3flex@dlt"
-}
-
-
-
-
-

Import the contents from other json files¶

-

This import feature allows user merges the content of other json files into the -json file, it also allows the nested importing means we can use import feature in -the imported files.

-

The import feature helps user distinguish the configuration parameters of each -functions, purposes, variants, and so forth into the separate json files. Therefore, -we can easy to understand and manage the configuration parameters of big project.

-

Example:

-

Suppose we have the json file params_global.json with the content:

-
//*****************************************************************************
-//  Author: ROBFW-AIO Team
-//
-//  This file defines all common global parameters and will be included to all
-//  test config files
-//*****************************************************************************
-//
-//  This is to distinguish the different types of resets
-{
-  "gGlobalIntParam" : 1,
-
-  "gGlobalFloatParam" : 1.332, // This parameter is used to configure for ....
-
-  "gGlobalString"   : "This is a string",
-
-  "gGlobalStructure": {
-    "general": "general"
-  }
-}
-
-
-

And other json file preprocessor_definitions.json with content:

-
//*****************************************************************************
-//  Author: ROBFW-AIO Team
-//
-//  This file defines all common global parameters and will be included to all
-//  test config files
-//*****************************************************************************
-{
-  "gPreprolIntParam" : 1,
-
-  "gPreproFloatParam" : 1.332,
-  // The parameter for feature ABC
-  "gPreproString"   : "This is a string",
-
-  "gPreproStructure": {
-                         "general": "general"
-                      }
-}
-
-
-

Then we can import these 2 files above to the json file config.json with content:

-
//*****************************************************************************
-//  Author: ROBFW-AIO Team
-//
-//  This file defines all common global parameters and will be included to all
-//  test config files
-//*****************************************************************************
-{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  // Version control information.
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    // Global parameters
-    "global": {
-               "[import]": "<path_to_the_imported_file>/params_global.json"
-      }
-    },
-  "preprocessor": {
-    "definitions": {
-      // FEATURE switches
-        "[import]": "<path_to_the_imported_file>/preprocessor_definitions.json"
-      }
-  },
-  "TargetName" : "gen3flex@dlt"
-}
-
-
-

The config.json file is handled by JsonPreprocessor package, then return the dictionary object for a program like below:

-
{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    "global": {
-      "gGlobalIntParam" : 1,
-      "gGlobalFloatParam" : 1.332,
-      "gGlobalString"   : "This is a string",
-      "gGlobalStructure": {
-        "general": "general"
-        }
-    }
-  },
-  "preprocessor": {
-    "definitions": {
-      "gPreprolIntParam" : 1,
-      "gPreproFloatParam" : 1.332,
-      "gPreproString"   : "This is a string",
-      "gPreproStructure": {
-                         "general": "general"
-                        }
-    }
-  },
-  "TargetName" : "gen3flex@dlt"
-}
-
-
-
-
-

Overwrite existing and add new parameters¶

-

This package also provides user ability to overwrite or update as well as add new -parameters. User can update parameters which are already declared and add new parameters -or new element into existing parameters. The below example will show the way to do -these features.

-

In case we have many different variants, and each varaint requires a different value -assigned to the parameter. This feature could help us update new value for existen -parameters, it also supports to add new parameters to existen configuation object.

-

Example:

-

Suppose we have the json file params_global.json with the content:

-
{
-  "gGlobalIntParam" : 1,
-
-  "gGlobalFloatParam" : 1.332, // This parameter is used to configure for ....
-
-  "gGlobalString"   : "This is a string",
-
-  "gGlobalStructure": {
-    "general": "general"
-  }
-}
-
-
-

Then we import params_global.json to json file config.json with content:

-
{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  // Version control information.
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    // Global parameters
-    "global": {
-               "[import]": "<path_to_the_imported_file>/params_global.json"
-      }
-    },
-  "TargetName" : "gen3flex@dlt",
-  // Overwrite parameters
-  "${params}['global']['gGlobalFloatParam']": 9.999,
-  "${version}['patchversion']": "2",
-  "${params}['global']['gGlobalString']": "This is the new value for the already existing parameter.",
-  // Add new parameters
-  "${newParam}": {
-                               "abc": 9,
-                               "xyz": "new param"
-  },
-  "${params}['global']['gGlobalStructure']['newGlobalParam']": 123
-}
-
-
-

The config.json file is handled by JsonPreprocessor package, then return the dictionary object for a program like below:

-
{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "2"
-  },
-  "params": {
-    "global": {
-      "gGlobalIntParam" : 1,
-      "gGlobalFloatParam" : 9.999,
-      "gGlobalString"   : "This is the new value for the already existing parameter.",
-      "gGlobalStructure": {
-        "general": "general",
-               "newGlobalParam": 123
-        }
-      }
-  },
-  "TargetName": "gen3flex@dlt",
-  "newParam": {
-         "abc": 9,
-         "xyz": "new param"
-  }
-}
-
-
-
-
-

Nested parameters¶

-

With JsonPreprocessor package, user can also use nested parameters as example below:

-

Example:

-

Suppose we have the json file config.json with the content:

-
{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  // Version control information.
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    // Global parameters
-    "global": {
-      "gGlobalIntParam" : 1,
-      "gGlobalFloatParam" : 1.332, // This parameter is used to configure for ....
-      "gGlobalString"   : "This is a string",
-      "gGlobalStructure": {
-        "general": "general"
-        }
-    }
-  },
-  "preprocessor": {
-    "definitions": {
-      "gPreprolIntParam" : 1,
-      "gPreproFloatParam" : 9.664,
-         "ABC": "checkABC",
-      "gPreproString"   : "This is a string",
-      "gPreproStructure": {
-                         "general": "general"
-                        }
-    }
-  },
-  "TargetName" : "gen3flex@dlt",
-  // Nested parameter
-  "${params}['global'][${preprocessor}['definitions']['ABC']]": true,
-  "${params}['global']['gGlobalFloatParam']": "${preprocessor}['definitions']['gPreproFloatParam']"
-}
-
-
-

The config.json file is handled by JsonPreprocessor package, then return the dictionary object for a program like below:

-
{
-  "Project": "G3g",
-  "WelcomeString": "Hello... ROBFW is running now!",
-  "version": {
-    "majorversion": "0",
-    "minorversion": "1",
-    "patchversion": "1"
-  },
-  "params": {
-    "global": {
-      "gGlobalIntParam" : 1,
-      "gGlobalFloatParam" : 9.664,
-      "gGlobalString"   : "This is a string",
-      "gGlobalStructure": {
-        "general": "general"
-        },
-         "checkABC": true
-    }
-  },
-  "preprocessor": {
-    "definitions": {
-      "gPreprolIntParam" : 1,
-      "gPreproFloatParam" : 9.664,
-         "ABC": "checkABC",
-      "gPreproString"   : "This is a string",
-      "gPreproStructure": {
-                         "general": "general"
-                        }
-    }
-  },
-  "TargetName" : "gen3flex@dlt"
-}
-
-
-
-
-
-

Feedback¶

-

To give us a feedback, you can send an email to Thomas Pollerspöck or -RBVH-ECM-Automation_Test_Framework-Associates

-

In case you want to report a bug or request any interesting feature, please don’t hesitate to rasie a ticket on -our Jira

-
-
-

References¶

-

For more information please refer to our Bosch Connect Community

-
-
- - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/genindex.html b/doc/_build/html/genindex.html deleted file mode 100644 index 2d063a11..00000000 --- a/doc/_build/html/genindex.html +++ /dev/null @@ -1,165 +0,0 @@ - - - - - - - - Index — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - -
-
-
- - -
- - -

Index

- -
- C - | J - | M - | P - -
-

C

- - - -
- -

J

- - - -
- -

M

- - -
- -

P

- - -
- - - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/index.html b/doc/_build/html/index.html deleted file mode 100644 index 6fa43ffb..00000000 --- a/doc/_build/html/index.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - Json Preprocessor’s API! — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - - -
-
-
- - -
- - - - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - - | - Page source -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/objects.inv b/doc/_build/html/objects.inv deleted file mode 100644 index 765f4a34..00000000 --- a/doc/_build/html/objects.inv +++ /dev/null @@ -1,5 +0,0 @@ -# Sphinx inventory version 2 -# Project: The Json Preprocessor -# Version: -# The remainder of this file is compressed using zlib. -xÚ¥“ÍN„0…÷<Å5ºu;;ÃÄd&þàžÜi¯ZZÒ–dØù¾žO"¥N`„ÉŒ²kzîùÎ)´ñÚ(™hª´bdŒÒP5‹RñZÜ@ü[r[ŠK¯‡Wã‰xŠÈ·Ç€g’¢·vãA!ïJ’Íÿ33iZ›\§ÏOKbŠÓŒz#TÄjcU™†2S’ÑŒži#-î^šŠþ_°gt_ÎÐZ]ljKs`Uwð980–/¸bóÁø!{Ç-Èya %Qd-áú•Ð֚ܺ.©íè´!ÿœù>†™_Ÿî½–CC°%YHN».Ià†„ËÚïzÞÊ-ƒ~ì§Ð`b:ñ.Y]í#›¨šp/x£«>j ž°ù»{è6„šå‡F¿ç=©×÷¾kŒú \ No newline at end of file diff --git a/doc/_build/html/py-modindex.html b/doc/_build/html/py-modindex.html deleted file mode 100644 index 3a6e54a4..00000000 --- a/doc/_build/html/py-modindex.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - - Python Module Index — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- - -

Python Module Index

- -
- c -
- - - - - - - -
 
- c
- CJsonPreprocessor -
- - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/search.html b/doc/_build/html/search.html deleted file mode 100644 index 97710925..00000000 --- a/doc/_build/html/search.html +++ /dev/null @@ -1,124 +0,0 @@ - - - - - - - - Search — The Json Preprocessor documentation - - - - - - - - - - - - - - - - - - - - - - - -
-
-
- - -
- -

Search

- - - - -

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

- - -
- - - -
- - - -
- -
- - -
- -
-
- -
-
-
- ©2021, Pollerspoeck Thomas (XC-CI1/ECA3). - - | - Powered by Sphinx 4.3.0 - & Alabaster 0.7.12 - -
- - - - - - \ No newline at end of file diff --git a/doc/_build/html/searchindex.js b/doc/_build/html/searchindex.js deleted file mode 100644 index 077c5652..00000000 --- a/doc/_build/html/searchindex.js +++ /dev/null @@ -1 +0,0 @@ -Search.setIndex({docnames:["CJsonPreprocessor","additional_doc/feature_documentation","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["CJsonPreprocessor.rst","additional_doc\\feature_documentation.rst","index.rst"],objects:{"":[[0,0,0,"-","CJsonPreprocessor"]],"CJsonPreprocessor.CJsonPreprocessor":[[0,2,1,"","jsonLoad"]],"CJsonPreprocessor.CPythonJSONDecoder":[[0,2,1,"","custom_scan_once"]],"CJsonPreprocessor.CSyntaxType":[[0,3,1,"","json"],[0,3,1,"","python"]],CJsonPreprocessor:[[0,1,1,"","CJsonPreprocessor"],[0,1,1,"","CPythonJSONDecoder"],[0,1,1,"","CSyntaxType"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"0":1,"1":1,"123":1,"2":1,"332":1,"664":1,"9":1,"999":1,"case":1,"class":0,"do":1,"final":1,"function":1,"import":0,"pollersp\u00f6ck":1,"return":[0,1],"switch":1,"true":[0,1],And:1,For:1,In:1,The:1,Then:1,To:1,With:1,abc:1,abil:1,abov:1,add:0,addit:1,aio:1,all:1,allow:[0,1],alreadi:1,also:1,an:1,ani:1,ar:1,arg:0,assign:1,associ:1,author:1,automation_test_framework:1,base:0,becuas:1,below:[0,1],big:1,block:1,bosch:1,bug:1,can:1,checkabc:1,cjsonpreprocessor:0,clarifi:1,code:1,comment:0,common:1,commun:1,config:1,configu:1,configur:[0,1],connect:1,contain:1,control:1,could:1,cpythonjsondecod:0,csyntaxtyp:0,currentcfg:0,custom_scan_onc:0,data:0,declar:1,decod:0,defin:1,definit:1,detail:2,dict:0,dictionari:1,differ:1,distinguish:1,dlt:1,document:2,don:1,each:1,easi:1,ecm:1,element:1,email:1,etc:1,exampl:1,existen:1,fals:0,featur:2,feedback:2,file:0,follow:1,format:0,forth:1,g3g:1,gen3flex:1,gener:1,gglobalfloatparam:1,gglobalintparam:1,gglobalstr:1,gglobalstructur:1,give:1,global:1,gpreprofloatparam:1,gpreprolintparam:1,gpreprostr:1,gpreprostructur:1,handl:[0,1],have:1,hello:1,help:[0,1],hesit:1,huge:1,idx:0,includ:1,inform:1,input:0,interest:1,introduct:2,jfile:0,jira:1,json:0,jsondecod:0,jsonload:0,jsonpreprocessor:[1,2],kwarg:0,larg:1,like:1,load:0,majorvers:1,manag:1,mani:1,masterfil:0,mean:1,merg:1,method:0,minorvers:1,modul:2,more:1,must:1,need:1,newglobalparam:1,newparam:1,none:0,note:1,now:1,number:1,object:[0,1],ojson:0,our:1,overrid:1,packag:[1,2],param:1,params_glob:1,pars:0,patchvers:1,path_to_the_imported_fil:1,pleas:1,preprocessor_definit:1,program:1,programm:1,project:1,provid:1,purpos:1,python3:1,python:[0,1],rasi:1,rbvh:1,refer:2,report:1,request:1,requir:1,reset:1,robfw:1,run:1,scan:0,send:1,separ:1,show:1,so:1,some:1,sourc:0,string:[0,1],support:1,suppos:1,syntax:0,t:1,targetnam:1,team:1,test:1,therefor:1,thi:1,thoma:1,ticket:1,type:1,understand:1,updat:1,us:1,user:1,valu:[0,1],varaint:1,variant:1,version:1,wai:1,want:1,we:1,welcomestr:1,well:1,when:0,which:1,within:0,xyz:1,you:1},titles:["JsonPreprocessor package","Json Preprocessor\u2019s Feature Documentation","Json Preprocessor\u2019s API!"],titleterms:{"import":1,"new":1,ad:1,add:1,api:2,comment:1,content:[0,1,2],detail:1,document:1,exist:1,featur:1,feedback:1,file:1,from:1,introduct:1,json:[1,2],jsonpreprocessor:0,modul:0,nest:1,other:1,overwrit:1,packag:0,paramet:1,preprocessor:[1,2],refer:1,s:[1,2]}}) \ No newline at end of file diff --git a/doc/_build/latex/Json-Preprocessor.pdf b/doc/_build/latex/Json-Preprocessor.pdf deleted file mode 100644 index f8387b13..00000000 Binary files a/doc/_build/latex/Json-Preprocessor.pdf and /dev/null differ diff --git a/doc/conf.py b/doc/conf.py deleted file mode 100644 index 958d6ab7..00000000 --- a/doc/conf.py +++ /dev/null @@ -1,96 +0,0 @@ -# Copyright 2020-2022 Robert Bosch GmbH -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "./../JsonPreprocessor"))) - -# print("(debug) sys.path:\n" + '\n'.join(sys.path)) - -# -- Project information ----------------------------------------------------- - -project = 'The Json Preprocessor' -copyright = '2021, Pollerspoeck Thomas (XC-CI1/ECA3)' -author = 'Pollerspoeck Thomas (XC-CI1/ECA3)' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.viewcode', - 'sphinx.ext.todo', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# -- Options for TEX/PDF output ------------------------------------------------- - -# Redefinition of text boxes (using LaTeX package 'tcolorbox' instead of the Sphinx internal 'sphinxlightbox' and 'sphinxheavybox') -latex_additional_files = ["latex_addons/sphinxlatexadmonitions.sty"] -# The original installation version of this file can be found here: -# \Lib\site-packages\sphinx\texinputs\sphinxlatexadmonitions.sty -# The latex_addons folder contains this file with the same name! -# Reason: Because of too much dependencies and adaptions the complete file has to be exchanged! - -latex_documents = [('index', 'Json-Preprocessor.tex', project, author, 'manual', False)] - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = 'en' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] - - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ['_static'] # (currently not used) - - -# -- Extension configuration ------------------------------------------------- - -# -- Options for todo extension ---------------------------------------------- - -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True \ No newline at end of file diff --git a/doc/images/python3-jsonpreprocessor.png b/doc/images/python3-jsonpreprocessor.png deleted file mode 100644 index a691ae94..00000000 Binary files a/doc/images/python3-jsonpreprocessor.png and /dev/null differ diff --git a/doc/index.rst b/doc/index.rst deleted file mode 100644 index 0f60b070..00000000 --- a/doc/index.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. Copyright 2020-2022 Robert Bosch GmbH - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - -.. The Json Preprocessor documentation master file, created by - sphinx-quickstart on Tue Jun 22 10:06:14 2021. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - - -Json Preprocessor's API! -======================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - ./additional_doc/feature_documentation.rst - ./CJsonPreprocessor.rst - - diff --git a/doc/latex_addons/sphinxlatexadmonitions.sty b/doc/latex_addons/sphinxlatexadmonitions.sty deleted file mode 100644 index a94e1258..00000000 --- a/doc/latex_addons/sphinxlatexadmonitions.sty +++ /dev/null @@ -1,284 +0,0 @@ -%% NOTICES AND ADMONITIONS -% -% change this info string if making any custom modification -\ProvidesFile{sphinxlatexadmonitions.sty}[2021/09/22 admonitions] - -% -------------------------------------------------------------------------------------------------------------- -% -% File adapted by XC-CI1/ECA3-Queckenstedt / 22.09.2021 / v. 0.1.0 -% -% Entry point for all kind of text boxes is the environment 'sphinxadmonition' (see end of this file). -% This environment originally uses the two text boxes 'sphinxlightbox' and 'sphinxheavybox'. -% The definition of these text boxes and the reference to these text boxes within 'sphinxadmonition' -% have been replaced by alternative text boxes based on the LaTeX package 'tcolorbox' (looks much nicer). -% -% Sphinx is able to support the following markdown directives for text boxes: -% "note, hint, tip, attention, caution, important, danger, warning, error" -% Each markdown directive is mapped to an individual text box (with name box; -% the noticetype is the name of the markdown directive). -% -% Markdown example to enable the text box 'boxattention': -% .. attention:: Be aware of .. -% -% The original installation version of this file can be found here: -% \Lib\site-packages\sphinx\texinputs\sphinxlatexadmonitions.sty -% -% The exchange of this file happens in file conf.py, section 'latex_additional_files'. -% -% -------------------------------------------------------------------------------------------------------------- -% -% Dependencies (they do not need to be defined at time of loading): -% - of course the various colour and dimension options handled via sphinx.sty -% - \sphinxstrong (for text boxes) -% - dimension register \spx@image@maxheight from sphinxlatexgraphics.sty -% - \savenotes/\spewnotes from sphinxpackagefootnote (for sphinxheavybox) - -% -------------------------------------------------------------------------------------------------------------- - -\usepackage[breakable,skins]{tcolorbox} -\tcbuselibrary{skins} -\tcbuselibrary{breakable} - -\usepackage{wasysym} % to enable certain symbols in text mode - -% -------------------------------------------------------------------------------------------------------------- -% definition of text boxes for every text box markdown directive -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxnote_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=yellow!10, - colframe=yellow!80!white, - underlay={% - \path[fill=yellow!80!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \UParrow} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxnote}[1] -{\begin{boxnote_template} -{\color{yellow!95!black} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxnote_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxhint_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=green!10, - colframe=green!80!white, - underlay={% - \path[fill=green!80!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \checked} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxhint}[1] -{\begin{boxhint_template} -{\color{green!80!white} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxhint_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxtip_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=blue!10, - colframe=blue!70!white, - underlay={% - \path[fill=blue!70!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \smiley} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxtip}[1] -{\begin{boxtip_template} -{\color{blue!70!white} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxtip_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxattention_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=orange!10, - colframe=orange!80!white, - underlay={% - \path[fill=orange!80!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries !} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxattention}[1] -{\begin{boxattention_template} -{\color{orange!80!white} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxattention_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxcaution_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=orange!10, - colframe=orange!80!white, - underlay={% - \path[fill=orange!80!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries !} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxcaution}[1] -{\begin{boxcaution_template} -{\color{orange!80!white} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxcaution_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boximportant_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=orange!30, - colframe=orange!90!white, - underlay={% - \path[fill=orange!90!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries !} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boximportant}[1] -{\begin{boximportant_template} -{\color{orange!90!white} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boximportant_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxdanger_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=red!10, - colframe=red!70!white, - underlay={% - \path[fill=red!70!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \frownie} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxdanger}[1] -{\begin{boxdanger_template} -{\color{red} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxdanger_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxwarning_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=red!10, - colframe=red!70!white, - underlay={% - \path[fill=red!70!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \frownie} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxwarning}[1] -{\begin{boxwarning_template} -{\color{red} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxwarning_template}} - -% -------------------------------------------------------------------------------------------------------------- - -\newtcolorbox{boxerror_template}[1][]{ - enhanced, - before skip=2mm, - after skip=3mm, - boxrule=2pt, - left=12mm, - right=2mm, - top=1mm, - bottom=1mm, - colback=red!30, - colframe=red!90!white, - underlay={% - \path[fill=red!90!white,draw=none] (interior.south west) rectangle node[white]{\Huge\bfseries \lightning} ([xshift=10mm]interior.north west); - }, - , #1} - -\newenvironment{boxerror}[1] -{\begin{boxerror_template} -{\color{red} \sphinxstrong{#1}} -\vspace{5pt} -\\ -}{\end{boxerror_template}} - -% -------------------------------------------------------------------------------------------------------------- -% the main dispatch for all types of notices -% -------------------------------------------------------------------------------------------------------------- -\newenvironment{sphinxadmonition}[2]{% #1=type, #2=heading - % can't use #1 directly in definition of end part - \def\spx@noticetype {#1}% - % start specific environment, passing the heading as argument - \begin{box#1}{#2}} - % workaround some LaTeX "feature" of \end command - {\edef\spx@temp{\noexpand\end{box\spx@noticetype}}\spx@temp} - -% -------------------------------------------------------------------------------------------------------------- - -\endinput diff --git a/dump_repository_config.py b/dump_repository_config.py new file mode 100644 index 00000000..fcc051b8 --- /dev/null +++ b/dump_repository_config.py @@ -0,0 +1,75 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# dump_repository_config.py +# +# XC-CT/ECA3-Queckenstedt +# +# dump_repository_config.py is a little helper to get deeper knowledge about the environment under which +# the software in this repository is being executed. +# +# The script prints all repository configuration values to console: +# Reference: +# - config\repository_config.json +# - config\CRepositoryConfig.py +# +# -------------------------------------------------------------------------------------------------------------- +# +import os, sys + +import colorama as col + +from config.CRepositoryConfig import CRepositoryConfig + +col.init(autoreset=True) + +COLBR = col.Style.BRIGHT + col.Fore.RED +COLBY = col.Style.BRIGHT + col.Fore.YELLOW +COLBG = col.Style.BRIGHT + col.Fore.GREEN + +SUCCESS = 0 +ERROR = 1 + +# -------------------------------------------------------------------------------------------------------------- + +def printerror(sMsg): + sys.stderr.write(COLBR + f"Error: {sMsg}!\n") + +def printexception(sMsg): + sys.stderr.write(COLBR + f"Exception: {sMsg}!\n") + +# -------------------------------------------------------------------------------------------------------------- + +# -- setting up the repository configuration (relative to the path of this script) +oRepositoryConfig = None +try: + oRepositoryConfig = CRepositoryConfig(os.path.abspath(sys.argv[0])) +except Exception as ex: + print() + printexception(str(ex)) + print() + sys.exit(ERROR) + +# -------------------------------------------------------------------------------------------------------------- + +print(COLBG + "Repository configuration dump done") +print() +sys.exit(SUCCESS) + +# -------------------------------------------------------------------------------------------------------------- + diff --git a/genpackagedoc.py b/genpackagedoc.py new file mode 100644 index 00000000..f948d6de --- /dev/null +++ b/genpackagedoc.py @@ -0,0 +1,104 @@ +# ************************************************************************************************************** +# +# Copyright 2020-2022 Robert Bosch GmbH +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# ************************************************************************************************************** +# +# genpackagedoc.py +# +# XC-CT/ECA3-Queckenstedt +# +# -------------------------------------------------------------------------------------------------------------- +# +# 29.06.2022 +# +# -------------------------------------------------------------------------------------------------------------- + +import os, sys + +import colorama as col + +from config.CRepositoryConfig import CRepositoryConfig # providing repository and environment specific information +from GenPackageDoc.CPackageDocConfig import CPackageDocConfig +from GenPackageDoc.CDocBuilder import CDocBuilder + +col.init(autoreset=True) + +COLBR = col.Style.BRIGHT + col.Fore.RED +COLBY = col.Style.BRIGHT + col.Fore.YELLOW +COLBG = col.Style.BRIGHT + col.Fore.GREEN + +SUCCESS = 0 +ERROR = 1 + +# -------------------------------------------------------------------------------------------------------------- + +def printerror(sMsg): + sys.stderr.write(COLBR + f"Error: {sMsg}!\n") + +def printexception(sMsg): + sys.stderr.write(COLBR + f"Exception: {sMsg}!\n") + +# -------------------------------------------------------------------------------------------------------------- + +# -- setting up the repository configuration (relative to the path of this script) +oRepositoryConfig = None +try: + oRepositoryConfig = CRepositoryConfig(os.path.abspath(sys.argv[0])) +except Exception as ex: + print() + printexception(str(ex)) + print() + sys.exit(ERROR) + +# -- setting up the GenPackageDoc configuration +oGenPackageDocConfig = None +try: + oPackageDocConfig = CPackageDocConfig(oRepositoryConfig) +except Exception as ex: + print() + printexception(str(ex)) + print() + sys.exit(ERROR) + +# -- setting up and calling the doc builder +try: + oDocBuilder = CDocBuilder(oPackageDocConfig) +except Exception as ex: + print() + printexception(str(ex)) + print() + sys.exit(ERROR) + +bSuccess, sResult = oDocBuilder.Build() +if bSuccess is None: + print() + printexception(sResult) + print() + sys.exit(ERROR) +elif bSuccess is False: + print() + printerror(sResult) + print() + sys.exit(ERROR) +else: + print(COLBY + sResult) + print() + print(COLBG + "genpackagedoc done") + print() + sys.exit(SUCCESS) + +# -------------------------------------------------------------------------------------------------------------- + diff --git a/packagedoc/additional_docs/Appendix.rst b/packagedoc/additional_docs/Appendix.rst new file mode 100644 index 00000000..d70d0c0b --- /dev/null +++ b/packagedoc/additional_docs/Appendix.rst @@ -0,0 +1,37 @@ +.. Copyright 2020-2022 Robert Bosch GmbH + +.. Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +**About this package:** + +.. table:: Package setup + :widths: auto + + ================== ========================= + Setup parameter Value + ================== ========================= + Name ###PACKAGENAME### + Version ###PACKAGEVERSION### + Date ###PACKAGEDATE### + Description ###DESCRIPTION### + Package URL `###REPOSITORYNAME### <###URL###>`_ + Author ###AUTHOR### + Email ###AUTHOREMAIL### + Language ###PROGRAMMINGLANGUAGE### + License ###LICENCE### + OS ###OPERATINGSYSTEM### + Python required ###PYTHONREQUIRES### + Development status ###DEVELOPMENTSTATUS### + Intended audience ###INTENDEDAUDIENCE### + Topic ###TOPIC### + ================== ========================= diff --git a/packagedoc/additional_docs/Description.rst b/packagedoc/additional_docs/Description.rst new file mode 100644 index 00000000..66b4088c --- /dev/null +++ b/packagedoc/additional_docs/Description.rst @@ -0,0 +1,24 @@ +.. Copyright 2020-2022 Robert Bosch GmbH + +.. Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +The json preprocessor: + +.. image:: ./pictures/python3-jsonpreprocessor.png + + + +TO BE CONTINUED + + + diff --git a/doc/additional_doc/feature_documentation.rst b/packagedoc/additional_docs/Description_orig.rst similarity index 100% rename from doc/additional_doc/feature_documentation.rst rename to packagedoc/additional_docs/Description_orig.rst diff --git a/packagedoc/additional_docs/History.tex b/packagedoc/additional_docs/History.tex new file mode 100644 index 00000000..d529af95 --- /dev/null +++ b/packagedoc/additional_docs/History.tex @@ -0,0 +1,20 @@ +% Copyright 2020-2022 Robert Bosch GmbH + +% Licensed under the Apache License, Version 2.0 (the "License"); +% you may not use this file except in compliance with the License. +% You may obtain a copy of the License at + +% http://www.apache.org/licenses/LICENSE-2.0 + +% Unless required by applicable law or agreed to in writing, software +% distributed under the License is distributed on an "AS IS" BASIS, +% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +% See the License for the specific language governing permissions and +% limitations under the License. + +\begin{center} +\begin{tabular}{| m{6em} | m{26em} |}\hline + \textbf{0.1.0} & 01/2022\\ \hline + \multicolumn{2}{| m{32em} |}{\textit{Initial version}}\\ \hline +\end{tabular} +\end{center} diff --git a/packagedoc/additional_docs/Introduction.rst b/packagedoc/additional_docs/Introduction.rst new file mode 100644 index 00000000..7e72e6c3 --- /dev/null +++ b/packagedoc/additional_docs/Introduction.rst @@ -0,0 +1,17 @@ +.. Copyright 2020-2022 Robert Bosch GmbH + +.. Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +*Json Preprocessor* + +!!! add introduction - if wanted !! diff --git a/doc/_build/html/_images/python3-jsonpreprocessor.png b/packagedoc/additional_docs/pictures/python3-jsonpreprocessor.png similarity index 100% rename from doc/_build/html/_images/python3-jsonpreprocessor.png rename to packagedoc/additional_docs/pictures/python3-jsonpreprocessor.png diff --git a/packagedoc/packagedoc_config.json b/packagedoc/packagedoc_config.json new file mode 100644 index 00000000..c927d22c --- /dev/null +++ b/packagedoc/packagedoc_config.json @@ -0,0 +1,127 @@ +# ************************************************************************************************************** +# GenPackageDoc configuration file +# +# GenPackageDoc creates tex files out of the docstrings of Python modules and out of separate rst files. +# With the help of a LaTeX compiler the tex files can be converted into a PDF file. +# This json file contains the required settings. +# +# 29.06.2022 +# +# ************************************************************************************************************** +# Format: extended json format with the possibility to comment out lines (by '#' at the beginning of the line). +# All fixed terms (keys) have to be written in capital letters, all user defined keys in small letters. +# Paths to files and folders within this file must be relative (except "TEX"). The reference for relative paths +# is the position of this file. +# -------------------------------------------------------------------------------------------------------------- + +{ + +# Section "CONTROL": +# ------------------ +# Contains parameter to control the application behavior in general. + + "CONTROL" : { + # if 'INCLUDEPRIVATE' is false: private methods are skipped, otherwise they are included in documentation + "INCLUDEPRIVATE" : false, + # if 'INCLUDEUNDOCUMENTED' is true: also classes and methods without docstring are listed in the documentation; + # otherwise they are skipped + "INCLUDEUNDOCUMENTED" : true, + # if 'STRICT' is true: missing LaTeX compiler causes an error; otherwise PDF generation is handled as option + # and a missing LaTeX compiler does not cause an error + "STRICT" : false + }, + +# Section "TOC": +# -------------- +# Defines the content of the PDF document (= the order of the chapters). +# A chapter can be represented by an additional text file in rst format. Every rst file is a separate chapter +# within the resulting PDF document. +# A chapter can also be represented by an additional tex file. Every tex file is a separate chapter +# within the resulting PDF document. +# In case of Python modules are involved, every Python module is a chapter. +# Class and function definitions within a Python module are subchapters. Methods of classes are subsubchapters. +# In this section every additional rst file is represented by a short name (key) and a path incl. file name (key value). +# This is completely under the responsibility of the user and therefore the names have to be written in small letters only. +# The keys with name starting with "INTERFACE" points to folder containing Python modules that have to be documented. +# In case of a repository contains several separate folder with Python modules, it is possible to use more than one +# key starting with "INTERFACE", e.g. "INTERFACE_part1" and "INTERFACE_part2". +# The key "DOCUMENTPARTS" contains a list of all defined keys in the order of their desired appearances within the resulting PDF document. +# It is strongly recommended to place all additional rst files flat into one single folder (and not in any further sub folder). +# Reason is that currently the tex files generated out of the rst files are also placed flat into only one single output folder +# (see section "OUTPUT") and the relative paths to possibly imported pictures (see section "PICTURES") must be kept valid! + + "TOC" : { + "introduction" : "./additional_docs/Introduction.rst", + "description" : "./additional_docs/Description.rst", + "INTERFACE" : "../###PACKAGENAME###", + "appendix" : "./additional_docs/Appendix.rst", + "history" : "./additional_docs/History.tex", + "DOCUMENTPARTS" : ["introduction","description","INTERFACE","appendix","history"] + }, + +# Section "PARAMS": +# ----------------- +# In this section a user has the ability to define own runtime variables, that are accessible within the doctrings of involved Python modules +# and also within separate rst files. Key names have to be written in small letters to indicate that they are user defined. +# Values can be either hard coded or taken over from the repository configuration (see config/repository_config.json). +# In second case the key name has to be encapsulated within three hashes '#'. The same notation can be used in rst files and doctrings +# of Python modules (for example adding an additional hint within a doctring of a class: ###additional_hint###). +# This mechanism is limited to strings! +# This key is optional. In case of own parameters are not needed, this key can be removed or set to null. + + # "PARAMS" : { + # "" : "", + # }, + +# Section "DOCUMENT": +# ------------------- +# This section contains basic details about the output document. Like in the previous section, values can be defined +# either hard coded or taken over from the repository configuration (with '#' notation). +# The keys in this section also are runtime variables. + + "DOCUMENT" : { + "OUTPUTFILENAME" : "###PACKAGENAME###.tex", + "AUTHOR" : "###AUTHOR###", + "TITLE" : "###PACKAGENAME###", + "DATE" : "###PACKAGEDATE###", + "VERSION" : "###PACKAGEVERSION###" + }, + +# Section "PICTURES": +# ------------------- +# Additional rst files may import pictures. GenPackageDoc needs to know where to find them. +# To keep the relative paths to possibly imported pictures valid also within the created tex files, +# this pictures folder will be copied into the output folder defined by key "OUTPUT". +# This key is optional. In case of there are no pictures needed in this package description, +# this key can be removed or set to null. + + "PICTURES" : "./additional_docs/pictures", + +# Section "OUTPUT": +# ----------------- +# Defines the path to the output folder containing the generated tex files and the PDF file. + + "OUTPUT" : "./build", + +# Section "PDFDEST": +# ----------------- +# Defines the path to a folder in which the PDF file will be copied after creation +# (the "OUTPUT" folder in which the LaTeX compiler creates the PDF file, is not really a proper destination finally) +# This key is optional. In case of it is not required to copy the PDF file to another location, +# this key can be removed or set to null. + + "PDFDEST" : "../###PACKAGENAME###", + +# Section "TEX": +# ----------------- +# Converting the generated text source files to a PDF document requires a LaTeX distribution. +# GenPackageDoc needs to know where to find LaTeX. Because the path to the LaTeX interpreter depends +# on the operating system, this path has to be defined separately for every supported operating system +# (currently "WINDOWS" and "LINUX"). +# Example: + + "TEX" : { + "WINDOWS" : "%ROBOTLATEXPATH%/miktex/bin/x64/pdflatex.exe", + "LINUX" : "${ROBOTLATEXPATH}/miktex/bin/x64/pdflatex" + } +} diff --git a/setup.py b/setup.py index 22358c59..33ea18d8 100644 --- a/setup.py +++ b/setup.py @@ -20,12 +20,12 @@ # # XC-CT/ECA3-Queckenstedt # -# Extends the standard setuptools installation by adding the documentation in HTML format +# Extends the standard setuptools installation by adding the documentation in PDF format # (requires installation mode) and tidying up some folders. # # !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! # -# This script deletes folders (as defined in config.CConfig, depending on the position of this script): +# This script deletes folders (as defined in config.CRepositoryConfig, depending on the position of this script): # - previous builds within this repository # - previous installations within # * \Lib\site-packages (Windows) @@ -44,9 +44,9 @@ # The usual # packages = setuptools.find_packages(), # is replaced by -# packages = [str(oRepositoryConfig.Get('sPackageName')), ], -# to avoid that also config.CConfig() and config.CExtendedSetup() are part of the distribution. -# CConfig and CExtendedSetup() are only repository internal helper. +# packages = [str(oRepositoryConfig.Get('PACKAGENAME')), ], +# to avoid that also config.CRepositoryConfig() and additions.CExtendedSetup() are part of the distribution. +# CRepositoryConfig and CExtendedSetup() are only repository internal helper. # # * Known issues: # @@ -60,21 +60,7 @@ # # -------------------------------------------------------------------------------------------------------------- # -# 21.02.2022 / XC-CT/ECA3-Queckenstedt -# -# "sdist bdist_wheel" maintenance: some steps moved from inside 'ExtendedInstallCommand' to outside -# -# 09.02.2022 / XC-CT/ECA3-Queckenstedt -# Suppressed generation of documents and installations in case of command line -# parameter is not 'install' and not 'build' (this enables printing the help only). (10.02.2022: and not 'sdist') -# -# 11.10.2021 / XC-CI1/ECA3-Queckenstedt -# Fixed computation order of readme files together with long_description -# -# 30.09.2021 / XC-CI1/ECA3-Queckenstedt -# Added wrapper for error messages -# -# Initial version 08/2021 +# 30.06.2022 # # -------------------------------------------------------------------------------------------------------------- @@ -82,8 +68,11 @@ import setuptools from setuptools.command.install import install -from config.CConfig import CConfig # providing repository and environment specific information -from config.CExtendedSetup import CExtendedSetup # providing functions to support the extended setup process +# prefer the repository local version of all additional libraries (instead of the installed version under site-packages) +sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "./additions"))) + +from config.CRepositoryConfig import CRepositoryConfig # providing repository and environment specific information +from additions.CExtendedSetup import CExtendedSetup # providing functions to support the extended setup process import colorama as col @@ -113,28 +102,7 @@ def run(self): listCmdArgs = sys.argv if ( ('install' in listCmdArgs) or ('build' in listCmdArgs) or ('sdist' in listCmdArgs) or ('bdist_wheel' in listCmdArgs) ): - print() - print(COLBY + "Extended setup step 4/5: install.run(self)") # creates the build folder .\build - print() - install.run(self) # TODO: What does install.run(self) return? How to realize error handling? - print() - if 'bdist_wheel' in listCmdArgs: - print(COLBY + "Extended setup step 5/5: Add html documentation to local wheel folder inside build") - print() - nReturn = oExtendedSetup.add_htmldoc_to_wheel() - if nReturn != SUCCESS: - return nReturn - print() - else: - print(COLBY + "Extended setup step 5/5: Add html documentation to package installation folder") # (./doc/_build/html to \Lib\site-packages\_doc) - print() - nReturn = oExtendedSetup.add_htmldoc_to_installation() - if nReturn != SUCCESS: - return nReturn - print() - print(COLBG + "Extended installation done") - print() - + install.run(self) return SUCCESS # eof class ExtendedInstallCommand(install): @@ -146,9 +114,8 @@ def run(self): # -- setting up the repository configuration oRepositoryConfig = None -sReferencePath = os.path.dirname(os.path.abspath(sys.argv[0])) try: - oRepositoryConfig = CConfig(sReferencePath) + oRepositoryConfig = CRepositoryConfig(os.path.abspath(sys.argv[0])) except Exception as ex: print() printexception(str(ex)) @@ -176,59 +143,79 @@ def run(self): print() print(COLBY + "Extended setup step 1/5: Calling the documentation builder") - # (previously called inside ExtendedInstallCommand - but this is too late, because the content of the initially - # generated or updated README file is already needed for the long_description below.) print() - nReturn = oExtendedSetup.gen_doc() + + nReturn = oExtendedSetup.genpackagedoc() + if nReturn != SUCCESS: + sys.exit(nReturn) + + print(COLBY + "Extended setup step 2/5: Converting the repository README") + print() + + nReturn = oExtendedSetup.convert_repo_readme() if nReturn != SUCCESS: sys.exit(nReturn) - print(COLBY + "Extended setup step 2/5: Deleting previous setup outputs (build, dist, .egg-info within repository)") + print(COLBY + "Extended setup step 3/5: Deleting previous setup outputs (build, dist, .egg-info within repository)") print() nReturn = oExtendedSetup.delete_previous_build() if nReturn != SUCCESS: sys.exit(nReturn) - if not 'bdist_wheel' in listCmdArgs: + if ( ('bdist_wheel' in listCmdArgs) or ('build' in listCmdArgs) ): + print() + print(COLBY + "Skipping extended setup step 4/5: Deleting previous package installation folder within site-packages") + print() + else: print() - print(COLBY + "Extended setup step 3/5: Deleting previous package installation folder within site-packages") # ( and _doc under \Lib\site-packages + print(COLBY + "Extended setup step 4/5: Deleting previous package installation folder within site-packages") # ( and _doc under \Lib\site-packages print() nReturn = oExtendedSetup.delete_previous_installation() if nReturn != SUCCESS: sys.exit(nReturn) - with open("README.md", "r", encoding="utf-8") as fh: + README_MD = str(oRepositoryConfig.Get('README_MD')) + with open(README_MD, "r", encoding="utf-8") as fh: long_description = fh.read() - print() - + fh.close() # -------------------------------------------------------------------------------------------------------------- -# This also handles the printing of help to console and therefore must be called in every case. -# And therefore all variables and objects must exist (even in case of the values are not used). +# -- the 'setup' itself + +print(COLBY + "Extended setup step 5/5: install.run(self)") +print() + setuptools.setup( - name = str(oRepositoryConfig.Get('sPackageName')), - version = str(oRepositoryConfig.Get('sVersion')), - author = str(oRepositoryConfig.Get('sAuthor')), - author_email = str(oRepositoryConfig.Get('sAuthorEMail')), - description = str(oRepositoryConfig.Get('sDescription')), + name = str(oRepositoryConfig.Get('PACKAGENAME')), + version = str(oRepositoryConfig.Get('PACKAGEVERSION')), + author = str(oRepositoryConfig.Get('AUTHOR')), + author_email = str(oRepositoryConfig.Get('AUTHOREMAIL')), + description = str(oRepositoryConfig.Get('DESCRIPTION')), long_description = long_description, - long_description_content_type = str(oRepositoryConfig.Get('sLongDescriptionContentType')), - url = str(oRepositoryConfig.Get('sURL')), - packages = [str(oRepositoryConfig.Get('sPackageName')), ], + long_description_content_type = str(oRepositoryConfig.Get('LONGDESCRIPTIONCONTENTTYPE')), + url = str(oRepositoryConfig.Get('URL')), + packages = [str(oRepositoryConfig.Get('PACKAGENAME')),], classifiers = [ - str(oRepositoryConfig.Get('sProgrammingLanguage')), - str(oRepositoryConfig.Get('sLicence')), - str(oRepositoryConfig.Get('sOperatingSystem')), - str(oRepositoryConfig.Get('sDevelopmentStatus')), - str(oRepositoryConfig.Get('sIntendedAudience')), - str(oRepositoryConfig.Get('sTopic')), + str(oRepositoryConfig.Get('PROGRAMMINGLANGUAGE')), + str(oRepositoryConfig.Get('LICENCE')), + str(oRepositoryConfig.Get('OPERATINGSYSTEM')), + str(oRepositoryConfig.Get('DEVELOPMENTSTATUS')), + str(oRepositoryConfig.Get('INTENDEDAUDIENCE')), + str(oRepositoryConfig.Get('TOPIC')), ], - python_requires = str(oRepositoryConfig.Get('sPythonRequires')), + python_requires = str(oRepositoryConfig.Get('PYTHONREQUIRES')), cmdclass={ 'install': ExtendedInstallCommand, }, - install_requires = oRepositoryConfig.Get('arInstallRequires'), + install_requires = oRepositoryConfig.Get('INSTALLREQUIRES'), + package_data={f"{oRepositoryConfig.Get('PACKAGENAME')}" : oRepositoryConfig.Get('PACKAGEDATA')}, ) # -------------------------------------------------------------------------------------------------------------- +print() +print(COLBG + "Extended installation done") +print() + +# -------------------------------------------------------------------------------------------------------------- + diff --git a/sphinx-makeall.py b/sphinx-makeall.py deleted file mode 100644 index 8b5d87d8..00000000 --- a/sphinx-makeall.py +++ /dev/null @@ -1,344 +0,0 @@ -# ************************************************************************************************************** -# -# Copyright 2020-2022 Robert Bosch GmbH -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -# -# ************************************************************************************************************** -# -# sphinx-makeall.py -# -# XC-CT/ECA3-Queckenstedt -# -# Uses the Python documentation tool Sphinx to generate the documentation of Python modules -# - based on the docstrings inside the Python modules and -# - based on additionally included separate text files (containing usually more common information -# than the docstrings of the Python modules). -# -# The docstrings and the additionally included text files have to be written in reStructureText syntax. -# The output is available in HTML format and in LaTeX format (.tex), optionally also in PDF. -# -# Preconditions: -# - Sphinx available as part of the Python installation. -# - Sphinx documentation project files already created and adapted to the local repository -# (see conf.py and index.rst). -# - LaTeX compiler (in case of output in PDF format is wanted) -# - pandoc and pypandoc for conversions between markdown formats -# -# Known issues: -# - LaTeX compiler throws some warnings when computing Sphinx output. -# -# -------------------------------------------------------------------------------------------------------------- -# -# 02.11.2021 / XC-CT/ECA3-Queckenstedt -# gen_doc_pdf called twice (to get also a table of content added to PDF file) -# -# 30.09.2021 / XC-CI1/ECA3-Queckenstedt -# Added wrapper for error messages -# -# Initial version 08/2021 -# -# -------------------------------------------------------------------------------------------------------------- - -import os, sys, platform, shlex, subprocess - -import pypandoc - -from config.CConfig import CConfig # providing repository and environment specific information - -import colorama as col - -col.init(autoreset=True) - -COLBR = col.Style.BRIGHT + col.Fore.RED -COLBY = col.Style.BRIGHT + col.Fore.YELLOW -COLBG = col.Style.BRIGHT + col.Fore.GREEN - -SUCCESS = 0 -ERROR = 1 - -# -------------------------------------------------------------------------------------------------------------- - -def printerror(sMsg): - sys.stderr.write(COLBR + f"Error: {sMsg}!\n") - -def printexception(sMsg): - sys.stderr.write(COLBR + f"Exception: {sMsg}!\n") - -# -------------------------------------------------------------------------------------------------------------- - -def convert_repo_readme(oRepositoryConfig=None): - """Converts the main repository README from 'rst' to 'md' format. - """ - - if oRepositoryConfig is None: - print() - printerror("oRepositoryConfig is None") - print() - return ERROR - - sReadMe_rst = oRepositoryConfig.Get("sReadMe_rst") - if sReadMe_rst is None: - return ERROR - - sReadMe_md = oRepositoryConfig.Get("sReadMe_md") - if sReadMe_md is None: - return ERROR - - if os.path.isfile(sReadMe_rst) is False: - print() - printerror(f"Missing readme file '{sReadMe_rst}'") - print() - return ERROR - - sFileContent = pypandoc.convert_file(sReadMe_rst, 'md') - hFile_md = open(sReadMe_md, "w", encoding="utf-8") - listFileContent = sFileContent.splitlines() - for sLine in listFileContent: - hFile_md.write(sLine + "\n") - hFile_md.close() - - print() - print(COLBY + f"File '{sReadMe_rst}'") - print(COLBY + "converted to") - print(COLBY + f"'{sReadMe_md}'") - print() - - return SUCCESS - -# eof def convert_repo_readme(oRepositoryConfig=None): - -# -------------------------------------------------------------------------------------------------------------- - -def sphinx_build(sFormat=None, oRepositoryConfig=None): - """Executes Sphinx to generate the documentation in format 'sFormat'. - """ - - if sFormat is None: - print() - printerror("sFormat is None") - print() - return ERROR - - if oRepositoryConfig is None: - print() - printerror("oRepositoryConfig is None") - print() - return ERROR - - SPHINXBUILD = oRepositoryConfig.Get("SPHINXBUILD") - if SPHINXBUILD is None: - return ERROR - - SOURCEDIR = oRepositoryConfig.Get("SOURCEDIR") - if SOURCEDIR is None: - return ERROR - - BUILDDIR = oRepositoryConfig.Get("BUILDDIR") - if BUILDDIR is None: - return ERROR - - sPython = oRepositoryConfig.Get("sPython") - if sPython is None: - return ERROR - - listCmdLineParts = [] - listCmdLineParts.append(f"\"{sPython}\"") - listCmdLineParts.append(f"\"{SPHINXBUILD}\"") - listCmdLineParts.append(f"-M {sFormat}") - listCmdLineParts.append(f"\"{SOURCEDIR}\"") - listCmdLineParts.append(f"\"{BUILDDIR}\"") - - sCmdLine = " ".join(listCmdLineParts) - del listCmdLineParts - listCmdLineParts = shlex.split(sCmdLine) - - # -- debug - sCmdLine = " ".join(listCmdLineParts) - print() - print("Now executing command line:\n" + sCmdLine) - print() - - nReturn = ERROR - try: - nReturn = subprocess.call(listCmdLineParts) - except Exception as ex: - printexception(str(ex)) - print() - return ERROR - - print() - - return nReturn - -# eof def sphinx_build(sFormat=None, oRepositoryConfig=None): - -# -------------------------------------------------------------------------------------------------------------- - -def gen_doc_pdf(oRepositoryConfig=None): - """Executes LaTeX to generate the documentation in PDF format (based on previously generated LaTeX format). - """ - - if oRepositoryConfig is None: - print() - printerror("oRepositoryConfig is None") - print() - return ERROR - - print() # empty line after Sphinx console output - for better readibility - - BUILDDIR = oRepositoryConfig.Get("BUILDDIR") - if BUILDDIR is None: - return ERROR - - sLaTeXInterpreter = oRepositoryConfig.Get("sLaTeXInterpreter") - if sLaTeXInterpreter is None: - return ERROR - - # LaTeX sources are placed by Sphinx within subfolder 'latex' of folder 'BUILDDIR' - sLaTeXRoot = os.path.normpath(f"{BUILDDIR}/latex") # not part of oRepositoryConfig; only needed here! - if os.path.isdir(sLaTeXRoot) is False: - print() - printerror(f"Missing LaTeX documentation folder '{sLaTeXRoot}'") - print() - return ERROR - - # Not really sure which name of main tex file we can expect here; therefore scanning for tex files and compute all of them - # (but usually only one tex file is expected) - listTeXFiles = [] - for root, dirs, files in os.walk(sLaTeXRoot): - for name in files: - if name.lower().endswith(".tex"): - sTeXFile = os.path.join(root, name) - listTeXFiles.append(sTeXFile) - - if len(listTeXFiles) == 0: - print() - printerror(f"Missing LaTeX source files (.tex) within '{sLaTeXRoot}'") - print() - return ERROR - - for sTeXFile in listTeXFiles: - print(COLBY + f"* Rendering file '{sTeXFile}'") - print() - - listCmdLineParts = [] - listCmdLineParts.append(f"\"{sLaTeXInterpreter}\"") - listCmdLineParts.append(f"\"{sTeXFile}\"") - - sCmdLine = " ".join(listCmdLineParts) - del listCmdLineParts - listCmdLineParts = shlex.split(sCmdLine) - - # -- debug - # sCmdLine = " ".join(listCmdLineParts) - # print("Now executing command line:\n" + sCmdLine) - # print() - - nReturn = ERROR - cwd = os.getcwd() # we have to save cwd because later we have to change - try: - os.chdir(sLaTeXRoot) # otherwise LaTeX compiler is not able to find files inside - nReturn = subprocess.call(listCmdLineParts) - print() - print(f"LaTeX compiler returned {nReturn}") - print() - os.chdir(cwd) # restore original value - except Exception as ex: - printexception(str(ex)) - print() - os.chdir(cwd) # restore original value - return ERROR - - if nReturn != SUCCESS: - printerror(f"LaTeX compiler not returned expected value {SUCCESS}") - print() - return nReturn - - # finally let's see what has been generated - for root, dirs, files in os.walk(sLaTeXRoot): - for name in files: - if name.lower().endswith(".pdf"): - sPDFFile = os.path.join(root, name) - print(COLBY + f"* Created '{sPDFFile}'") - print() - - return nReturn - -# eof def gen_doc_pdf(oRepositoryConfig=None): - -# -------------------------------------------------------------------------------------------------------------- - -# -- setting up the repository configuration (relative to the path of this script) -oRepositoryConfig = None -sReferencePath = os.path.dirname(os.path.abspath(sys.argv[0])) -try: - oRepositoryConfig = CConfig(sReferencePath) -except Exception as ex: - print() - printexception(str(ex)) - print() - sys.exit(ERROR) - -# -- converting the main repository README from 'rst' to 'md' format -nReturn = convert_repo_readme(oRepositoryConfig) -if nReturn != SUCCESS: - printerror("convert_repo_readme with 'README.rst' failed") - print() - sys.exit(nReturn) - -# -- removing previous output in documentation build folder -nReturn = sphinx_build("clean", oRepositoryConfig) -if nReturn != SUCCESS: - printerror("sphinx_build 'clean' failed") - print() - sys.exit(nReturn) - -# -- generating new documentation in HTML format -nReturn = sphinx_build("html", oRepositoryConfig) -if nReturn != SUCCESS: - printerror("sphinx_build 'html' failed") - print() - sys.exit(nReturn) - -# -- generating new documentation in LaTeX format -nReturn = sphinx_build("latex", oRepositoryConfig) -if nReturn != SUCCESS: - printerror("sphinx_build 'latex' failed") - print() - sys.exit(nReturn) - -# -- generating new documentation in PDF format (requires configured LaTeX) -sLaTeXInterpreter = oRepositoryConfig.Get('sLaTeXInterpreter') -if sLaTeXInterpreter is not None: - print("Calling LaTeX PDF renderer (1/2)") - nReturn = gen_doc_pdf(oRepositoryConfig) - if nReturn != SUCCESS: - printerror("PDF generation failed") - print() - sys.exit(nReturn) - print("Calling LaTeX PDF renderer (2/2) - to get referencs and table of content updated") - nReturn = gen_doc_pdf(oRepositoryConfig) - if nReturn != SUCCESS: - printerror("PDF generation failed") - print() - sys.exit(nReturn) - -# -------------------------------------------------------------------------------------------------------------- - -print(COLBG + "sphinx-makeall done") -print() -sys.exit(SUCCESS) - -# -------------------------------------------------------------------------------------------------------------- -