├── crossfiledialog ├── __init__.py ├── exceptions.py ├── strings.py ├── wrapper.py ├── osascript.py ├── kdialog.py ├── zenity.py └── win32.py ├── setup.cfg ├── test.py ├── setup.py ├── README.md ├── .gitignore └── LICENSE /crossfiledialog/__init__.py: -------------------------------------------------------------------------------- 1 | from crossfiledialog.wrapper import * 2 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | # Inside of setup.cfg 2 | [metadata] 3 | description_file = README.md 4 | -------------------------------------------------------------------------------- /crossfiledialog/exceptions.py: -------------------------------------------------------------------------------- 1 | class FileDialogException(Exception): 2 | pass 3 | 4 | 5 | class NoImplementationFoundException(FileDialogException): 6 | pass 7 | -------------------------------------------------------------------------------- /crossfiledialog/strings.py: -------------------------------------------------------------------------------- 1 | open_file = 'Choose a file' 2 | open_multiple = 'Choose one or more files' 3 | save_file = 'Enter the name of the file to save to' 4 | choose_folder = 'Choose a folder' 5 | -------------------------------------------------------------------------------- /test.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import crossfiledialog 4 | 5 | 6 | def test(): 7 | print(crossfiledialog.open_file( 8 | start_dir="~", 9 | filter={"PDF-Files": "*.pdf", "Python Project": ["*.py", "*.md"]} 10 | # filter=[["*.py", "*.txt"], ["*.png", "*.jpg"]] 11 | # filter=["*.py", "*.md"] 12 | # filter="*.py" 13 | )) 14 | # print(crossfiledialog.open_multiple()) 15 | # print(crossfiledialog.save_file()) 16 | # print(crossfiledialog.choose_folder()) 17 | 18 | 19 | if __name__ == "__main__": 20 | test() 21 | -------------------------------------------------------------------------------- /crossfiledialog/wrapper.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | from crossfiledialog.exceptions import NoImplementationFoundException 5 | 6 | 7 | def which(command): 8 | for d in os.environ['PATH'].split(':'): 9 | if os.path.exists(d): 10 | for binary in os.listdir(d): 11 | if binary == command: 12 | return os.path.join(d, command) 13 | 14 | 15 | if sys.platform == 'linux': 16 | probably_kde = os.environ.get('DESKTOP_SESSION', '').lower() == 'kde' or \ 17 | os.environ.get('XDG_CURRENT_DESKTOP', '').lower() == 'kde' 18 | 19 | kdialog_binary = which('kdialog') 20 | zenity_binary = which('zenity') 21 | 22 | if kdialog_binary and (probably_kde or not zenity_binary): 23 | from crossfiledialog.kdialog import * 24 | elif zenity_binary: 25 | from crossfiledialog.zenity import * 26 | else: 27 | raise NoImplementationFoundException() 28 | 29 | elif sys.platform == 'win32': 30 | from crossfiledialog.win32 import * 31 | 32 | elif sys.platform == "darwin": 33 | from crossfiledialog.osascript import * 34 | 35 | else: 36 | raise NoImplementationFoundException() 37 | 38 | 39 | __all__ = ['open_file', 'open_multiple', 'save_file', 'choose_folder'] 40 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | 3 | import sys 4 | 5 | from distutils.core import setup 6 | 7 | 8 | requirements = [] 9 | 10 | if sys.platform == 'win32': 11 | requirements.append('pywin32') 12 | 13 | 14 | description = 'A Python wrapper for opening files and folders with the native file dialog.' 15 | 16 | try: 17 | long_description = open('README.md').read() 18 | except: 19 | long_description = description 20 | 21 | 22 | 23 | setup( 24 | name='crossfiledialog', 25 | version='1.1.0', 26 | description=description, 27 | long_description=long_description, 28 | long_description_content_type='text/markdown', 29 | author='Maikel Wever', 30 | author_email='maikelwever@gmail.com', 31 | url='https://github.com/maikelwever/crossfiledialog/', 32 | packages=['crossfiledialog'], 33 | install_requires=requirements, 34 | python_requires='>=3.4', 35 | classifiers=[ 36 | 'Development Status :: 5 - Production/Stable', 37 | 'Intended Audience :: Developers', 38 | 'License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)', 39 | 'Programming Language :: Python :: 3', 40 | 'Environment :: X11 Applications :: GTK', 41 | 'Environment :: X11 Applications :: KDE', 42 | 'Environment :: Win32 (MS Windows)', 43 | 'Operating System :: OS Independent', 44 | 'Operating System :: Microsoft', 45 | 'Operating System :: POSIX :: Linux', 46 | 'Topic :: Desktop Environment :: File Managers', 47 | ], 48 | ) 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | CrossFileDialog 2 | =============== 3 | 4 | A Python wrapper for opening files and folders with the native file dialog. 5 | 6 | Makes it easy to prompt the user with a native filepicker on all supported platforms. 7 | 8 | 9 | Currently supports: 10 | 11 | - Zenity (GTK) 12 | - KDialog (KDE) 13 | - Windows 2000 and newer (via PyWin32) 14 | - osascript (macOS) 15 | 16 | Basic API usage: 17 | 18 | ```python 19 | import crossfiledialog 20 | 21 | filename = crossfiledialog.open_file() 22 | multiple_filenames = crossfiledialog.open_multiple() 23 | save_filename = crossfiledialog.save_file() 24 | foldername = crossfiledialog.choose_folder() 25 | ``` 26 | 27 | ## Documentation 28 | ```python 29 | crossfiledialog.open_file(title, start_dir, filter) -> str 30 | ``` 31 | Open a file selection dialog for selecting a file. 32 | 33 | Parameters: 34 | - title (str, optional) — The title of the file selection dialog. Default is 'Choose a file' 35 | - start_dir (str, optional) — The starting directory for the dialog. 36 | - filter (str, list, dict, optional) — The filter for file types to display. It can be either: 37 | - a single wildcard (e.g.: `"*.py"`, all files are displayed ending .py) 38 | - a list of wildcards (e.g.: `["*.py" "*.md"]`, all files are displayed ending either .py or .md) 39 | - a list of list optional one or more wildcards (e.g.: `[["*.py", "*.md"], ["*.txt"]]`, 40 | user can switch between (.py, .md) and (.txt)) 41 | - a dictionary mapping descriptions to wildcards (e.g.: `{"PDF-Files": "*.pdf", "Python Project": ["\*.py", "*.md"]}`) 42 | 43 | Returns: 44 | - str: The selected file's path. 45 | 46 | --- 47 | 48 | ```python 49 | crossfiledialog.open_multiple(title, start_dir, filter) -> list[str] 50 | ``` 51 | Open a file selection dialog for selecting multiple files. 52 | 53 | Parameters: 54 | - title (str, optional) — The title of the file selection dialog. Default is 'Choose one or more files' 55 | - start_dir (str, optional) — The starting directory for the dialog. 56 | - filter (str, list, dict, optional) — The filter for file types to display. It can be either: 57 | - a single wildcard (e.g.: `"*.py"`, all files are displayed ending .py) 58 | - a list of wildcards (e.g.: `["*.py" "*.md"]`, all files are displayed ending either .py or .md) 59 | - a list of list optional one or more wildcards (e.g.: `[["*.py", "*.md"], ["*.txt"]]`, 60 | user can switch between (.py, .md) and (.txt)) 61 | - a dictionary mapping descriptions to wildcards (e.g.: `{"PDF-Files": "*.pdf", "Python Project": ["\*.py", "*.md"]}`) 62 | 63 | Returns: 64 | - list[str]: A list of selected file paths. 65 | 66 | --- 67 | 68 | ```python 69 | crossfiledialog.save_file(title, start_dir) -> str 70 | ``` 71 | Open a save file dialog. 72 | 73 | Parameters: 74 | - title (str, optional) — The title of the file selection dialog. Default is 'Enter the name of the file to save to' 75 | - start_dir (str, optional) — The starting directory for the dialog. 76 | 77 | Returns: 78 | - str: The selected file's path for saving. 79 | 80 | --- 81 | 82 | ```python 83 | crossfiledialog.save_file(title, start_dir) -> str 84 | ``` 85 | Open a folder selection dialog. 86 | 87 | Parameters: 88 | - title (str, optional) — The title of the file selection dialog. Default is 'Choose a folder' 89 | - start_dir (str, optional) — The starting directory for the dialog. 90 | 91 | Returns: 92 | - str: The selected folder's path. 93 | 94 | ## Licence 95 | 96 | This software is licensed under the GNU LGPL 3.0 Only. See the LICENSE file for details. 97 | 98 | SPDX-License-Identifier: LGPL-3.0-only 99 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/python,vim,linux 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=python,vim,linux 4 | 5 | ### Linux ### 6 | *~ 7 | 8 | # temporary files which can be created if a process still has a handle open of a deleted file 9 | .fuse_hidden* 10 | 11 | # KDE directory preferences 12 | .directory 13 | 14 | # Linux trash folder which might appear on any partition or disk 15 | .Trash-* 16 | 17 | # .nfs files are created when an open file is removed but is still being accessed 18 | .nfs* 19 | 20 | ### Python ### 21 | # Byte-compiled / optimized / DLL files 22 | __pycache__/ 23 | *.py[cod] 24 | *$py.class 25 | 26 | # C extensions 27 | *.so 28 | 29 | # Distribution / packaging 30 | .Python 31 | build/ 32 | develop-eggs/ 33 | dist/ 34 | downloads/ 35 | eggs/ 36 | .eggs/ 37 | lib/ 38 | lib64/ 39 | parts/ 40 | sdist/ 41 | var/ 42 | wheels/ 43 | pip-wheel-metadata/ 44 | share/python-wheels/ 45 | *.egg-info/ 46 | .installed.cfg 47 | *.egg 48 | MANIFEST 49 | 50 | # PyInstaller 51 | # Usually these files are written by a python script from a template 52 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 53 | *.manifest 54 | *.spec 55 | 56 | # Installer logs 57 | pip-log.txt 58 | pip-delete-this-directory.txt 59 | 60 | # Unit test / coverage reports 61 | htmlcov/ 62 | .tox/ 63 | .nox/ 64 | .coverage 65 | .coverage.* 66 | .cache 67 | nosetests.xml 68 | coverage.xml 69 | *.cover 70 | *.py,cover 71 | .hypothesis/ 72 | .pytest_cache/ 73 | 74 | # Translations 75 | *.mo 76 | *.pot 77 | 78 | # Django stuff: 79 | *.log 80 | local_settings.py 81 | db.sqlite3 82 | db.sqlite3-journal 83 | 84 | # Flask stuff: 85 | instance/ 86 | .webassets-cache 87 | 88 | # Scrapy stuff: 89 | .scrapy 90 | 91 | # Sphinx documentation 92 | docs/_build/ 93 | 94 | # PyBuilder 95 | target/ 96 | 97 | # Jupyter Notebook 98 | .ipynb_checkpoints 99 | 100 | # IPython 101 | profile_default/ 102 | ipython_config.py 103 | 104 | # pyenv 105 | .python-version 106 | 107 | # pipenv 108 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 109 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 110 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 111 | # install all needed dependencies. 112 | #Pipfile.lock 113 | 114 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 115 | __pypackages__/ 116 | 117 | # Celery stuff 118 | celerybeat-schedule 119 | celerybeat.pid 120 | 121 | # SageMath parsed files 122 | *.sage.py 123 | 124 | # Environments 125 | .env 126 | .venv 127 | env/ 128 | venv/ 129 | ENV/ 130 | env.bak/ 131 | venv.bak/ 132 | 133 | # Spyder project settings 134 | .spyderproject 135 | .spyproject 136 | 137 | # Rope project settings 138 | .ropeproject 139 | 140 | # mkdocs documentation 141 | /site 142 | 143 | # mypy 144 | .mypy_cache/ 145 | .dmypy.json 146 | dmypy.json 147 | 148 | # Pyre type checker 149 | .pyre/ 150 | 151 | # pytype static type analyzer 152 | .pytype/ 153 | 154 | ### Vim ### 155 | # Swap 156 | [._]*.s[a-v][a-z] 157 | !*.svg # comment out if you don't need vector files 158 | [._]*.sw[a-p] 159 | [._]s[a-rt-v][a-z] 160 | [._]ss[a-gi-z] 161 | [._]sw[a-p] 162 | 163 | # Session 164 | Session.vim 165 | Sessionx.vim 166 | 167 | # Temporary 168 | .netrwhist 169 | # Auto-generated tag files 170 | tags 171 | # Persistent undo 172 | [._]*.un~ 173 | 174 | # End of https://www.toptal.com/developers/gitignore/api/python,vim,linux 175 | 176 | 177 | .idea 178 | .vscode 179 | .venv 180 | -------------------------------------------------------------------------------- /crossfiledialog/osascript.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | from subprocess import PIPE, Popen 5 | 6 | from crossfiledialog import strings 7 | from crossfiledialog.exceptions import FileDialogException 8 | 9 | 10 | class OsascriptException(FileDialogException): 11 | pass 12 | 13 | 14 | last_cwd = None 15 | 16 | 17 | def get_preferred_cwd(): 18 | possible_cwd = os.environ.get('FILEDIALOG_CWD', '') 19 | if possible_cwd: 20 | return possible_cwd 21 | 22 | global last_cwd 23 | if last_cwd: 24 | return last_cwd 25 | 26 | 27 | def set_last_cwd(cwd): 28 | global last_cwd 29 | last_cwd = os.path.dirname(cwd) 30 | 31 | 32 | def run_osascript(script): 33 | process = Popen(['osascript', '-e', script], stdout=PIPE, stderr=PIPE) 34 | stdout, stderr = process.communicate() 35 | 36 | if process.returncode != 0: 37 | raise OsascriptException(f"Unexpected error during osascript call: {stderr.decode().strip()}") 38 | 39 | stdout, stderr = stdout.decode(), stderr.decode() 40 | 41 | if stderr.strip(): 42 | sys.stderr.write(stderr) 43 | 44 | return stdout.strip() 45 | 46 | 47 | def _escape_applescript_string(s): 48 | # Escape backslashes and double quotes for AppleScript 49 | return s.replace("\\", "\\\\").replace('"', '\\"') 50 | 51 | 52 | def open_file(title=strings.open_file, start_dir=None, filter=None): 53 | """ 54 | Open a file selection dialog for selecting a file using AppleScript (osascript). 55 | 56 | Args: 57 | title (str, optional): The title of the file selection dialog. 58 | Default is 'Choose a file' 59 | start_dir (str, optional): The starting directory for the dialog. 60 | filter (str, list, dict, optional): The filter for file types to display. 61 | 62 | Returns: 63 | str: The selected file's path. 64 | 65 | Example: 66 | result = open_file(title="Select a file", start_dir="/path/to/starting/directory", filter="*.txt") 67 | """ 68 | script = 'set chosenFile to choose file' 69 | if title: 70 | script += f' with prompt "{_escape_applescript_string(title)}"' 71 | if start_dir: 72 | script += f' default location POSIX file "{_escape_applescript_string(start_dir)}"' 73 | # AppleScript does not support file type filtering by wildcard, only by file type/extension 74 | # so we attempt to support basic extension filtering if possible 75 | if filter: 76 | file_types = [] 77 | if isinstance(filter, str): 78 | if filter.startswith("*."): 79 | ext = filter[2:] 80 | file_types.append(ext) 81 | elif isinstance(filter, list): 82 | for f in filter: 83 | if isinstance(f, str) and f.startswith("*."): 84 | file_types.append(f[2:]) 85 | elif isinstance(filter, dict): 86 | for value in filter.values(): 87 | if isinstance(value, str) and value.startswith("*."): 88 | file_types.append(value[2:]) 89 | elif isinstance(value, list): 90 | for v in value: 91 | if isinstance(v, str) and v.startswith("*."): 92 | file_types.append(v[2:]) 93 | if file_types: 94 | # AppleScript expects a list of file types as {"txt", "md"} 95 | script += ' of type {' + ", ".join([f'"{_escape_applescript_string(ext)}"' for ext in file_types]) + '}' 96 | script += '\nPOSIX path of chosenFile' 97 | 98 | result = run_osascript(script) 99 | if result: 100 | set_last_cwd(result) 101 | return result 102 | 103 | 104 | def open_multiple(title=strings.open_multiple, start_dir=None, filter=None): 105 | """ 106 | Open a file selection dialog for selecting multiple files using AppleScript (osascript). 107 | 108 | Args: 109 | title (str, optional): The title of the file selection dialog. 110 | Default is 'Choose one or more files' 111 | start_dir (str, optional): The starting directory for the dialog. 112 | filter (str, list, dict, optional): The filter for file types to display. 113 | 114 | Returns: 115 | list[str]: A list of selected file paths. 116 | 117 | Example: 118 | result = open_multiple(title="Select multiple files", 119 | start_dir="/path/to/starting/directory", filter="*.txt") 120 | """ 121 | script = 'set chosenFiles to choose file with multiple selections allowed' 122 | if title: 123 | script += f' with prompt "{_escape_applescript_string(title)}"' 124 | if start_dir: 125 | script += f' default location POSIX file "{_escape_applescript_string(start_dir)}"' 126 | # File type filtering as above 127 | if filter: 128 | file_types = [] 129 | if isinstance(filter, str): 130 | if filter.startswith("*."): 131 | ext = filter[2:] 132 | file_types.append(ext) 133 | elif isinstance(filter, list): 134 | for f in filter: 135 | if isinstance(f, str) and f.startswith("*."): 136 | file_types.append(f[2:]) 137 | elif isinstance(filter, dict): 138 | for value in filter.values(): 139 | if isinstance(value, str) and value.startswith("*."): 140 | file_types.append(value[2:]) 141 | elif isinstance(value, list): 142 | for v in value: 143 | if isinstance(v, str) and v.startswith("*."): 144 | file_types.append(v[2:]) 145 | if file_types: 146 | script += ' of type {' + ", ".join([f'"{_escape_applescript_string(ext)}"' for ext in file_types]) + '}' 147 | script += '\nset posixList to {}\nrepeat with f in chosenFiles\nset end of posixList to POSIX path of f\nend repeat\nreturn posixList as string' 148 | 149 | result = run_osascript(script) 150 | if result: 151 | # AppleScript returns a comma-separated list 152 | split_result = [s.strip() for s in result.split(",")] 153 | if split_result: 154 | set_last_cwd(split_result[0]) 155 | return split_result 156 | return [] 157 | 158 | 159 | def save_file(title=strings.save_file, start_dir=None): 160 | """ 161 | Open a save file dialog using AppleScript (osascript). 162 | 163 | Args: 164 | title (str, optional): The title of the save file dialog. 165 | Default is 'Enter the name of the file to save to' 166 | start_dir (str, optional): The starting directory for the dialog. 167 | 168 | Returns: 169 | str: The selected file's path for saving. 170 | 171 | Example: 172 | result = save_file(title="Save file", start_dir="/path/to/starting/directory") 173 | """ 174 | script = 'set saveFile to choose file name' 175 | if title: 176 | script += f' with prompt "{_escape_applescript_string(title)}"' 177 | if start_dir: 178 | script += f' default location POSIX file "{_escape_applescript_string(start_dir)}"' 179 | script += '\nPOSIX path of saveFile' 180 | 181 | result = run_osascript(script) 182 | if result: 183 | set_last_cwd(result) 184 | return result 185 | 186 | 187 | def choose_folder(title=strings.choose_folder, start_dir=None): 188 | """ 189 | Open a folder selection dialog using AppleScript (osascript). 190 | 191 | Args: 192 | title (str, optional): The title of the folder selection dialog. 193 | Default is 'Choose a folder' 194 | start_dir (str, optional): The starting directory for the dialog. 195 | 196 | Returns: 197 | str: The selected folder's path. 198 | 199 | Example: 200 | result = choose_folder(title="Select folder", start_dir="/path/to/starting/directory") 201 | """ 202 | script = 'set chosenFolder to choose folder' 203 | if title: 204 | script += f' with prompt "{_escape_applescript_string(title)}"' 205 | if start_dir: 206 | script += f' default location POSIX file "{_escape_applescript_string(start_dir)}"' 207 | script += '\nPOSIX path of chosenFolder' 208 | 209 | result = run_osascript(script) 210 | if result: 211 | set_last_cwd(result) 212 | return result 213 | 214 | 215 | __all__ = ['open_file', 'open_multiple', 'save_file', 'choose_folder'] 216 | -------------------------------------------------------------------------------- /crossfiledialog/kdialog.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | from subprocess import PIPE, Popen 5 | 6 | from crossfiledialog import strings 7 | from crossfiledialog.exceptions import FileDialogException 8 | 9 | 10 | class KDialogException(FileDialogException): 11 | pass 12 | 13 | 14 | last_cwd = None 15 | 16 | 17 | def get_preferred_cwd(): 18 | possible_cwd = os.environ.get('FILEDIALOG_CWD', '') 19 | if possible_cwd: 20 | return possible_cwd 21 | 22 | global last_cwd 23 | if last_cwd: 24 | return last_cwd 25 | 26 | 27 | def set_last_cwd(cwd): 28 | global last_cwd 29 | last_cwd = os.path.dirname(cwd) 30 | 31 | 32 | def run_kdialog(*args, **kwargs): 33 | cmdlist = ['kdialog'] 34 | cmdlist.extend('--{0}'.format(arg) for arg in args) 35 | 36 | if "start_dir" in kwargs: 37 | cmdlist.append(kwargs.pop("start_dir")) 38 | 39 | if "filter" in kwargs: 40 | cmdlist.append(kwargs.pop("filter")) 41 | 42 | for k, v in kwargs.items(): 43 | cmdlist.append('--{0}'.format(k)) 44 | cmdlist.append(v) 45 | 46 | extra_kwargs = dict() 47 | preferred_cwd = get_preferred_cwd() 48 | if preferred_cwd: 49 | extra_kwargs['cwd'] = preferred_cwd 50 | 51 | process = Popen(cmdlist, stdout=PIPE, stderr=PIPE, **extra_kwargs) 52 | stdout, stderr = process.communicate() 53 | 54 | if process.returncode == -1: 55 | raise KDialogException("Unexpected error during kdialog call") 56 | 57 | stdout, stderr = stdout.decode(), stderr.decode() 58 | if stderr.strip(): 59 | sys.stderr.write(stderr) 60 | 61 | return stdout.strip() 62 | 63 | 64 | def open_file(title=strings.open_file, start_dir=None, filter=None): 65 | """ 66 | Open a file selection dialog for selecting a file using KDialog. 67 | 68 | Args: 69 | title (str, optional): The title of the file selection dialog. 70 | Default is 'Choose a file' 71 | start_dir (str, optional): The starting directory for the dialog. 72 | filter (str, list, dict, optional): The filter for file types to display. 73 | 74 | Returns: 75 | str: The selected file's path. 76 | 77 | Example: 78 | result = open_file(title="Select a file", start_dir="/path/to/starting/directory", filter="*.txt") 79 | """ 80 | kdialog_kwargs = dict(title=title) 81 | 82 | if start_dir: 83 | kdialog_kwargs["start_dir"] = start_dir 84 | 85 | if filter: 86 | if isinstance(filter, str): 87 | # Filter is a single wildcard. 88 | kdialog_kwargs["filter"] = filter 89 | elif isinstance(filter, list): 90 | if isinstance(filter[0], str): 91 | # Filter is a list of wildcards. 92 | kdialog_kwargs["filter"] = " ".join(filter) 93 | elif isinstance(filter[0], list): 94 | # Filter is a list of lists with wildcards. 95 | kdialog_kwargs["filter"] = " | ".join( 96 | " ".join(f) for f in filter 97 | ) 98 | else: 99 | raise ValueError("Invalid filter") 100 | elif isinstance(filter, dict): 101 | # Filter is a dictionary mapping descriptions to wildcards or lists of wildcards. 102 | filters = [] 103 | for key, value in filter.items(): 104 | if isinstance(value, str): 105 | filters.append("{0} ({1})".format(key, value)) 106 | elif isinstance(value, list): 107 | filters.append("{0} ({1})".format(key, ' '.join(value))) 108 | else: 109 | raise ValueError("Invalid filter") 110 | 111 | kdialog_kwargs["filter"] = " | ".join( 112 | filters 113 | ) 114 | else: 115 | raise ValueError("Invalid filter") 116 | 117 | result = run_kdialog('getopenfilename', **kdialog_kwargs) 118 | if result: 119 | set_last_cwd(result) 120 | return result 121 | 122 | 123 | def open_multiple(title=strings.open_multiple, start_dir=None, filter=None): 124 | """ 125 | Open a file selection dialog for selecting multiple files using KDialog. 126 | 127 | Args: 128 | title (str, optional): The title of the file selection dialog. 129 | Default is 'Choose one or more files' 130 | start_dir (str, optional): The starting directory for the dialog. 131 | filter (optional): The filter for file types to display. 132 | 133 | Returns: 134 | list[str]: A list of selected file paths. 135 | 136 | Example: 137 | result = open_multiple(title="Select multiple files", 138 | start_dir="/path/to/starting/directory", filter="*.txt") 139 | """ 140 | kdialog_kwargs = dict(title=title) 141 | 142 | if start_dir: 143 | kdialog_kwargs["start_dir"] = start_dir 144 | 145 | if filter: 146 | if isinstance(filter, str): 147 | # Filter is a single wildcard. 148 | kdialog_kwargs["filter"] = filter 149 | elif isinstance(filter, list): 150 | if isinstance(filter[0], str): 151 | # Filter is a list of wildcards. 152 | kdialog_kwargs["filter"] = " ".join(filter) 153 | elif isinstance(filter[0], list): 154 | # Filter is a list of lists with wildcards. 155 | kdialog_kwargs["filter"] = " | ".join( 156 | " ".join(f) for f in filter 157 | ) 158 | else: 159 | raise ValueError("Invalid filter") 160 | elif isinstance(filter, dict): 161 | # Filter is a dictionary mapping descriptions to wildcards or lists of wildcards. 162 | filters = [] 163 | for key, value in filter.items(): 164 | if isinstance(value, str): 165 | filters.append("{0} ({1})".format(key, value)) 166 | elif isinstance(value, list): 167 | filters.append("{0} ({1})".format(key, ' '.join(value))) 168 | else: 169 | raise ValueError("Invalid filter") 170 | 171 | kdialog_kwargs["filter"] = " | ".join( 172 | filters 173 | ) 174 | else: 175 | raise ValueError("Invalid filter") 176 | 177 | result = run_kdialog('getopenfilename', 'multiple', **kdialog_kwargs) 178 | result_list = list(map(str.strip, result.split(' '))) 179 | if result_list: 180 | set_last_cwd(result_list[0]) 181 | return result_list 182 | return [] 183 | 184 | 185 | def save_file(title=strings.save_file, start_dir=None): 186 | """ 187 | Open a save file dialog using KDialog. 188 | 189 | Args: 190 | title (str, optional): The title of the save file dialog. 191 | Default is 'Enter the name of the file to save to' 192 | start_dir (str, optional): The starting directory for the dialog. 193 | 194 | Returns: 195 | str: The selected file's path for saving. 196 | 197 | Example: 198 | result = save_file(title="Save file", start_dir="/path/to/starting/directory") 199 | """ 200 | kdialog_args = ['getsavefilename'] 201 | kdialog_kwargs = dict(title=title) 202 | 203 | if start_dir: 204 | kdialog_kwargs["start_dir"] = start_dir 205 | 206 | result = run_kdialog(*kdialog_args, **kdialog_kwargs) 207 | if result: 208 | set_last_cwd(result) 209 | return result 210 | 211 | 212 | def choose_folder(title=strings.choose_folder, start_dir=None): 213 | """ 214 | Open a folder selection dialog using KDialog. 215 | 216 | Args: 217 | title (str, optional): The title of the folder selection dialog. 218 | Default is 'Choose a folder' 219 | start_dir (str, optional): The starting directory for the dialog. 220 | 221 | Returns: 222 | str: The selected folder's path. 223 | 224 | Example: 225 | result = choose_folder(title="Select folder", start_dir="/path/to/starting/directory") 226 | """ 227 | kdialog_kwargs = dict(title=title) 228 | 229 | if start_dir: 230 | kdialog_kwargs["start_dir"] = start_dir 231 | 232 | result = run_kdialog('getexistingdirectory', **kdialog_kwargs) 233 | if result: 234 | set_last_cwd(result) 235 | return result 236 | 237 | 238 | __all__ = ['open_file', 'open_multiple', 'save_file', 'choose_folder'] 239 | -------------------------------------------------------------------------------- /crossfiledialog/zenity.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | from subprocess import PIPE, Popen 5 | 6 | from crossfiledialog import strings 7 | from crossfiledialog.exceptions import FileDialogException 8 | 9 | 10 | class ZenityException(FileDialogException): 11 | pass 12 | 13 | 14 | last_cwd = None 15 | 16 | 17 | def get_preferred_cwd(): 18 | possible_cwd = os.environ.get('FILEDIALOG_CWD', '') 19 | if possible_cwd: 20 | return possible_cwd 21 | 22 | global last_cwd 23 | if last_cwd: 24 | return last_cwd 25 | 26 | 27 | def set_last_cwd(cwd): 28 | global last_cwd 29 | last_cwd = os.path.dirname(cwd) 30 | 31 | 32 | def run_zenity(*args, **kwargs): 33 | cmdlist = ['zenity'] 34 | cmdlist.extend('--{0}'.format(arg) for arg in args) 35 | cmdlist.extend('--{0}={1}'.format(k, v) for k, v in kwargs.items()) 36 | 37 | extra_kwargs = dict() 38 | preferred_cwd = get_preferred_cwd() 39 | if preferred_cwd: 40 | extra_kwargs['cwd'] = preferred_cwd 41 | 42 | process = Popen(cmdlist, stdout=PIPE, stderr=PIPE, **extra_kwargs) 43 | stdout, stderr = process.communicate() 44 | 45 | if process.returncode == -1: 46 | raise ZenityException("Unexpected error during zenity call") 47 | 48 | stdout, stderr = stdout.decode(), stderr.decode() 49 | 50 | if stderr.strip(): 51 | sys.stderr.write(stderr) 52 | 53 | return stdout.strip() 54 | 55 | 56 | def open_file(title=strings.open_file, start_dir=None, filter=None): 57 | """ 58 | Open a file selection dialog for selecting a file using Zenity. 59 | 60 | Args: 61 | title (str, optional): The title of the file selection dialog. 62 | Default is 'Choose a file' 63 | start_dir (str, optional): The starting directory for the dialog. 64 | filter (str, list, dict, optional): The filter for file types to display. 65 | 66 | Returns: 67 | str: The selected file's path. 68 | 69 | Example: 70 | result = open_file(title="Select a file", start_dir="/path/to/starting/directory", filter="*.txt") 71 | """ 72 | zenity_args = [] 73 | zenity_kwargs = dict(title=title) 74 | 75 | if start_dir: 76 | # If the path doesn't end with a backslash, Zenity only 77 | # starts in the parent directory and selects the directory. 78 | if start_dir[-1] != "/": 79 | start_dir += "/" 80 | zenity_kwargs["filename"] = start_dir 81 | 82 | if filter: 83 | if isinstance(filter, str): 84 | # Filter is a single wildcard. 85 | zenity_kwargs["file-filter"] = filter 86 | elif isinstance(filter, list): 87 | # Filter is a list of wildcards. 88 | if isinstance(filter[0], str): 89 | zenity_kwargs["file-filter"] = " ".join(filter) 90 | elif isinstance(filter[0], list): 91 | zenity_args.extend("file-filter={0}".format(' '.join(f)) for f in filter) 92 | elif isinstance(filter, dict): 93 | # Filter is a dictionary mapping descriptions to wildcards. 94 | for key, value in filter.items(): 95 | if isinstance(value, str): 96 | zenity_args.append("file-filter={0} | {1}".format(key, value)) 97 | elif isinstance(value, list): 98 | zenity_args.append("file-filter={0} | {1}".format(key, ' | '.join(value))) 99 | else: 100 | raise ValueError("Invalid filter") 101 | else: 102 | raise ValueError("Invalid filter") 103 | 104 | result = run_zenity('file-selection', *zenity_args, **zenity_kwargs) 105 | if result: 106 | set_last_cwd(result) 107 | return result 108 | 109 | 110 | def open_multiple(title=strings.open_multiple, start_dir=None, filter=None): 111 | """ 112 | Open a file selection dialog for selecting multiple files using Zenity. 113 | 114 | Args: 115 | title (str, optional): The title of the file selection dialog. 116 | Default is 'Choose one or more files' 117 | start_dir (str, optional): The starting directory for the dialog. 118 | filter (str, list, dict, optional): The filter for file types to display. 119 | 120 | Returns: 121 | list[str]: A list of selected file paths. 122 | 123 | Example: 124 | result = open_multiple(title="Select multiple files", 125 | start_dir="/path/to/starting/directory", filter="*.txt") 126 | """ 127 | zenity_args = [] 128 | zenity_kwargs = dict(title=title) 129 | 130 | if start_dir: 131 | # If the path doesn't end with a backslash, Zenity only starts in the parent directory 132 | # and selects the directory in the dialog. 133 | if start_dir[-1] != "/": 134 | start_dir += "/" 135 | zenity_kwargs["filename"] = start_dir 136 | 137 | if filter: 138 | if isinstance(filter, str): 139 | # Filter is a single wildcard. 140 | zenity_kwargs["file-filter"] = filter 141 | elif isinstance(filter, list): 142 | # Filter is a list of wildcards. 143 | if isinstance(filter[0], str): 144 | zenity_kwargs["file-filter"] = " ".join(filter) 145 | elif isinstance(filter[0], list): 146 | zenity_args.extend("file-filter={0}".format(' '.join(f)) for f in filter) 147 | elif isinstance(filter, dict): 148 | # Filter is a dictionary mapping descriptions to wildcards. 149 | for key, value in filter.items(): 150 | if isinstance(value, str): 151 | zenity_args.append("file-filter={0} | {1}".format(key, value)) 152 | elif isinstance(value, list): 153 | zenity_args.append("file-filter={0} | {1}".format(key, ' | '.join(value))) 154 | else: 155 | raise ValueError("Invalid filter") 156 | else: 157 | raise ValueError("Invalid filter") 158 | 159 | result = run_zenity('file-selection', 'multiple', *zenity_args, **zenity_kwargs) 160 | split_result = result.split('|') 161 | if split_result: 162 | set_last_cwd(split_result[0]) 163 | return split_result 164 | return [] 165 | 166 | 167 | def save_file(title=strings.save_file, start_dir=None): 168 | """ 169 | Open a save file dialog using Zenity. 170 | 171 | Args: 172 | title (str, optional): The title of the save file dialog. 173 | Default is 'Enter the name of the file to save to' 174 | start_dir (str, optional): The starting directory for the dialog. 175 | 176 | Returns: 177 | str: The selected file's path for saving. 178 | 179 | Example: 180 | result = save_file(title="Save file", start_dir="/path/to/starting/directory") 181 | """ 182 | zenity_args = ['file-selection', 'save', 'confirm-overwrite'] 183 | zenity_kwargs = dict(title=title) 184 | 185 | if start_dir: 186 | # If the path doesn't end with a backslash, Zenity only starts in the parent directory 187 | # and selects the directory in the dialog. 188 | if start_dir[-1] != "/": 189 | start_dir += "/" 190 | zenity_kwargs["filename"] = start_dir 191 | 192 | result = run_zenity(*zenity_args, **zenity_kwargs) 193 | if result: 194 | set_last_cwd(result) 195 | return result 196 | 197 | 198 | def choose_folder(title=strings.choose_folder, start_dir=None): 199 | """ 200 | Open a folder selection dialog using Zenity. 201 | 202 | Args: 203 | title (str, optional): The title of the folder selection dialog. 204 | Default is 'Choose a folder' 205 | start_dir (str, optional): The starting directory for the dialog. 206 | 207 | Returns: 208 | str: The selected folder's path. 209 | 210 | Example: 211 | result = choose_folder(title="Select folder", start_dir="/path/to/starting/directory") 212 | """ 213 | zenity_kwargs = dict(title=title) 214 | 215 | if start_dir: 216 | # If the path doesn't end with a backslash, Zenity only starts in the parent directory 217 | # and selects the directory in the dialog. 218 | if start_dir[-1] != "/": 219 | start_dir += "/" 220 | zenity_kwargs["filename"] = start_dir 221 | 222 | result = run_zenity('file-selection', 'directory', **zenity_kwargs) 223 | if result: 224 | set_last_cwd(result) 225 | return result 226 | 227 | 228 | __all__ = ['open_file', 'open_multiple', 'save_file', 'choose_folder'] 229 | -------------------------------------------------------------------------------- /crossfiledialog/win32.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | from crossfiledialog import strings 4 | from crossfiledialog.exceptions import NoImplementationFoundException, FileDialogException 5 | 6 | try: 7 | import pywintypes 8 | import win32gui 9 | import win32con 10 | from win32com.shell import shell, shellcon 11 | 12 | except ImportError: 13 | raise NoImplementationFoundException( 14 | "Running 'filedialog' on Windows requires the 'pywin32' package.") 15 | 16 | 17 | class Win32Exception(FileDialogException): 18 | pass 19 | 20 | 21 | last_cwd = None 22 | 23 | 24 | def get_preferred_cwd(): 25 | possible_cwd = os.environ.get('FILEDIALOG_CWD', '') 26 | if possible_cwd: 27 | return possible_cwd 28 | 29 | global last_cwd 30 | if last_cwd: 31 | return last_cwd 32 | 33 | 34 | def set_last_cwd(cwd): 35 | global last_cwd 36 | last_cwd = os.path.dirname(cwd) 37 | 38 | 39 | def error_handling_wrapper(struct, **kwargs): 40 | if 'InitialDir' not in kwargs: 41 | kwargs['InitialDir'] = get_preferred_cwd() 42 | 43 | if 'Flags' in kwargs: 44 | kwargs['Flags'] = kwargs['Flags'] | win32con.OFN_EXPLORER 45 | else: 46 | kwargs['Flags'] = win32con.OFN_EXPLORER 47 | 48 | try: 49 | file_name, custom_filter, flags = struct(**kwargs) 50 | return file_name 51 | 52 | except pywintypes.error: 53 | return None 54 | 55 | 56 | def open_file(title=strings.open_file, start_dir=None, filter=None): 57 | """ 58 | Open a file selection dialog for selecting a file using the Windows API. 59 | 60 | Args: 61 | title (str, optional): The title of the file selection dialog. 62 | Default is 'Choose a file' 63 | start_dir (str, optional): The starting directory for the dialog. 64 | filter (str, list, dict, optional): The filter for file types to display. 65 | 66 | Returns: 67 | str: The selected file's path. 68 | 69 | Example: 70 | result = open_file(title="Select a file", start_dir="C:/Documents", filter="*.txt") 71 | """ 72 | win_kwargs = dict(Title=title) 73 | 74 | if start_dir: 75 | win_kwargs["InitialDir"] = start_dir 76 | 77 | if filter: 78 | if isinstance(filter, str): 79 | # Filter is a single wildcard. 80 | win_kwargs["Filter"] = filter + '\0' + filter + '\0' 81 | elif isinstance(filter, list): 82 | if isinstance(filter[0], str): 83 | # Filter is a list of wildcards. 84 | win_kwargs["Filter"] = " ".join(filter) + '\0' + ";".join(filter) + '\0' 85 | elif isinstance(filter[0], list): 86 | # Filter is a list of list with wildcards. 87 | win_kwargs["Filter"] = "".join( 88 | " ".join(f) + '\0' + ";".join(f) + '\0' for f in filter 89 | ) 90 | else: 91 | raise ValueError("Invalid filter") 92 | elif isinstance(filter, dict): 93 | # Filter is a dictionary mapping descriptions to wildcards or lists of wildcards. 94 | filters = "" 95 | for key, value in filter.items(): 96 | if isinstance(value, str): 97 | filters += "{0}\0{1}\0".format(key, value) 98 | elif isinstance(value, list): 99 | filters += "{0}\0{1}\0".format(key, ';'.join(value)) 100 | else: 101 | raise ValueError("Invalid filter") 102 | 103 | win_kwargs["Filter"] = filters 104 | else: 105 | raise ValueError("Invalid filter") 106 | 107 | file_name = error_handling_wrapper( 108 | win32gui.GetOpenFileNameW, 109 | **win_kwargs 110 | ) 111 | 112 | if file_name: 113 | set_last_cwd(file_name) 114 | return file_name 115 | 116 | 117 | def open_multiple(title=strings.open_multiple, start_dir=None, filter=None): 118 | """ 119 | Open a file selection dialog for selecting multiple files using the Windows API. 120 | 121 | Args: 122 | title (str, optional): The title of the file selection dialog. 123 | Default is 'Choose one or more files' 124 | start_dir (str, optional): The starting directory for the dialog. 125 | filter (str, list, dict, optional): The filter for file types to display. 126 | 127 | Returns: 128 | list[str]: A list of selected file paths. 129 | 130 | Example: 131 | result = open_multiple(title="Select multiple files", start_dir="C:/Documents", filter="*.txt") 132 | """ 133 | win_kwargs = dict(Title=title) 134 | 135 | if start_dir: 136 | win_kwargs["InitialDir"] = start_dir 137 | 138 | if filter: 139 | if isinstance(filter, str): 140 | # Filter is a single wildcard. 141 | win_kwargs["Filter"] = filter + '\0' + filter + '\0' 142 | elif isinstance(filter, list): 143 | if isinstance(filter[0], str): 144 | # Filter is a list of wildcards. 145 | win_kwargs["Filter"] = " ".join(filter) + '\0' + ";".join(filter) + '\0' 146 | elif isinstance(filter[0], list): 147 | # Filter is a list of list with wildcards. 148 | win_kwargs["Filter"] = "".join( 149 | " ".join(f) + '\0' + ";".join(f) + '\0' for f in filter 150 | ) 151 | else: 152 | raise ValueError("Invalid filter") 153 | elif isinstance(filter, dict): 154 | # Filter is a dictionary mapping descriptions to wildcards or lists of wildcards. 155 | filters = "" 156 | for key, value in filter.items(): 157 | if isinstance(value, str): 158 | filters += "{0}\0{1}\0".format(key, value) 159 | elif isinstance(value, list): 160 | filters += "{0}\0{1}\0".format(key, ';'.join(value)) 161 | else: 162 | raise ValueError("Invalid filter") 163 | 164 | win_kwargs["Filter"] = filters 165 | else: 166 | raise ValueError("Invalid filter") 167 | 168 | file_names = error_handling_wrapper( 169 | win32gui.GetOpenFileNameW, 170 | **win_kwargs, 171 | Flags=win32con.OFN_ALLOWMULTISELECT, 172 | ) 173 | 174 | if file_names: 175 | file_names_list = file_names.split('\x00') 176 | if len(file_names_list) > 1: 177 | dirname = file_names_list[0] 178 | file_names_list_nodir = file_names_list[1:] 179 | file_names_list = [os.path.join(dirname, file_name) for file_name in file_names_list_nodir] 180 | 181 | set_last_cwd(file_names_list[0]) 182 | return file_names_list 183 | 184 | return [] 185 | 186 | 187 | def save_file(title=strings.save_file, start_dir=None): 188 | """ 189 | Open a save file dialog using the Windows API. 190 | 191 | Args: 192 | title (str, optional): The title of the save file dialog. 193 | Default is 'Enter the name of the file to save to' 194 | start_dir (str, optional): The starting directory for the dialog. 195 | 196 | Returns: 197 | str: The selected file's path for saving. 198 | 199 | Example: 200 | result = save_file(title="Save file", start_dir="C:/Documents") 201 | """ 202 | win_kwargs = dict(Title=title) 203 | 204 | if start_dir: 205 | win_kwargs["InitialDir"] = start_dir 206 | 207 | file_name = error_handling_wrapper( 208 | win32gui.GetSaveFileNameW, 209 | **win_kwargs, 210 | Flags=win32con.OFN_OVERWRITEPROMPT, 211 | ) 212 | 213 | if file_name: 214 | set_last_cwd(file_name) 215 | return file_name 216 | 217 | 218 | def choose_folder(title=strings.choose_folder, start_dir=None): 219 | """ 220 | Open a folder selection dialog using the Windows API. 221 | 222 | Args: 223 | title (str, optional): The title of the folder selection dialog. 224 | Default is 'Choose a folder' 225 | start_dir (str, optional): The starting directory for the dialog. 226 | 227 | Returns: 228 | str: The selected folder's path. 229 | 230 | Example: 231 | result = choose_folder(title="Choose folder", start_dir="C:/Documents") 232 | """ 233 | if start_dir: 234 | start_pidl, _ = shell.SHParseDisplayName(start_dir, 0, None) 235 | elif last_cwd: 236 | start_pidl, _ = shell.SHParseDisplayName(last_cwd, 0, None) 237 | else: 238 | # default directory is the desktop 239 | start_pidl = shell.SHGetFolderLocation(0, shellcon.CSIDL_DESKTOP, 0, 0) 240 | pidl, display_name, image_list = shell.SHBrowseForFolder( 241 | win32gui.GetDesktopWindow(), start_pidl, 242 | title, 0, None, None 243 | ) 244 | 245 | if pidl: 246 | path = shell.SHGetPathFromIDListW(pidl) 247 | set_last_cwd(path) 248 | return path 249 | 250 | 251 | __all__ = ['open_file', 'open_multiple', 'save_file', 'choose_folder'] 252 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | GNU GENERAL PUBLIC LICENSE 168 | Version 3, 29 June 2007 169 | 170 | Copyright (C) 2007 Free Software Foundation, Inc. 171 | Everyone is permitted to copy and distribute verbatim copies 172 | of this license document, but changing it is not allowed. 173 | 174 | Preamble 175 | 176 | The GNU General Public License is a free, copyleft license for 177 | software and other kinds of works. 178 | 179 | The licenses for most software and other practical works are designed 180 | to take away your freedom to share and change the works. By contrast, 181 | the GNU General Public License is intended to guarantee your freedom to 182 | share and change all versions of a program--to make sure it remains free 183 | software for all its users. We, the Free Software Foundation, use the 184 | GNU General Public License for most of our software; it applies also to 185 | any other work released this way by its authors. You can apply it to 186 | your programs, too. 187 | 188 | When we speak of free software, we are referring to freedom, not 189 | price. Our General Public Licenses are designed to make sure that you 190 | have the freedom to distribute copies of free software (and charge for 191 | them if you wish), that you receive source code or can get it if you 192 | want it, that you can change the software or use pieces of it in new 193 | free programs, and that you know you can do these things. 194 | 195 | To protect your rights, we need to prevent others from denying you 196 | these rights or asking you to surrender the rights. Therefore, you have 197 | certain responsibilities if you distribute copies of the software, or if 198 | you modify it: responsibilities to respect the freedom of others. 199 | 200 | For example, if you distribute copies of such a program, whether 201 | gratis or for a fee, you must pass on to the recipients the same 202 | freedoms that you received. You must make sure that they, too, receive 203 | or can get the source code. And you must show them these terms so they 204 | know their rights. 205 | 206 | Developers that use the GNU GPL protect your rights with two steps: 207 | (1) assert copyright on the software, and (2) offer you this License 208 | giving you legal permission to copy, distribute and/or modify it. 209 | 210 | For the developers' and authors' protection, the GPL clearly explains 211 | that there is no warranty for this free software. For both users' and 212 | authors' sake, the GPL requires that modified versions be marked as 213 | changed, so that their problems will not be attributed erroneously to 214 | authors of previous versions. 215 | 216 | Some devices are designed to deny users access to install or run 217 | modified versions of the software inside them, although the manufacturer 218 | can do so. This is fundamentally incompatible with the aim of 219 | protecting users' freedom to change the software. The systematic 220 | pattern of such abuse occurs in the area of products for individuals to 221 | use, which is precisely where it is most unacceptable. Therefore, we 222 | have designed this version of the GPL to prohibit the practice for those 223 | products. If such problems arise substantially in other domains, we 224 | stand ready to extend this provision to those domains in future versions 225 | of the GPL, as needed to protect the freedom of users. 226 | 227 | Finally, every program is threatened constantly by software patents. 228 | States should not allow patents to restrict development and use of 229 | software on general-purpose computers, but in those that do, we wish to 230 | avoid the special danger that patents applied to a free program could 231 | make it effectively proprietary. To prevent this, the GPL assures that 232 | patents cannot be used to render the program non-free. 233 | 234 | The precise terms and conditions for copying, distribution and 235 | modification follow. 236 | 237 | TERMS AND CONDITIONS 238 | 239 | 0. Definitions. 240 | 241 | "This License" refers to version 3 of the GNU General Public License. 242 | 243 | "Copyright" also means copyright-like laws that apply to other kinds of 244 | works, such as semiconductor masks. 245 | 246 | "The Program" refers to any copyrightable work licensed under this 247 | License. Each licensee is addressed as "you". "Licensees" and 248 | "recipients" may be individuals or organizations. 249 | 250 | To "modify" a work means to copy from or adapt all or part of the work 251 | in a fashion requiring copyright permission, other than the making of an 252 | exact copy. The resulting work is called a "modified version" of the 253 | earlier work or a work "based on" the earlier work. 254 | 255 | A "covered work" means either the unmodified Program or a work based 256 | on the Program. 257 | 258 | To "propagate" a work means to do anything with it that, without 259 | permission, would make you directly or secondarily liable for 260 | infringement under applicable copyright law, except executing it on a 261 | computer or modifying a private copy. Propagation includes copying, 262 | distribution (with or without modification), making available to the 263 | public, and in some countries other activities as well. 264 | 265 | To "convey" a work means any kind of propagation that enables other 266 | parties to make or receive copies. Mere interaction with a user through 267 | a computer network, with no transfer of a copy, is not conveying. 268 | 269 | An interactive user interface displays "Appropriate Legal Notices" 270 | to the extent that it includes a convenient and prominently visible 271 | feature that (1) displays an appropriate copyright notice, and (2) 272 | tells the user that there is no warranty for the work (except to the 273 | extent that warranties are provided), that licensees may convey the 274 | work under this License, and how to view a copy of this License. If 275 | the interface presents a list of user commands or options, such as a 276 | menu, a prominent item in the list meets this criterion. 277 | 278 | 1. Source Code. 279 | 280 | The "source code" for a work means the preferred form of the work 281 | for making modifications to it. "Object code" means any non-source 282 | form of a work. 283 | 284 | A "Standard Interface" means an interface that either is an official 285 | standard defined by a recognized standards body, or, in the case of 286 | interfaces specified for a particular programming language, one that 287 | is widely used among developers working in that language. 288 | 289 | The "System Libraries" of an executable work include anything, other 290 | than the work as a whole, that (a) is included in the normal form of 291 | packaging a Major Component, but which is not part of that Major 292 | Component, and (b) serves only to enable use of the work with that 293 | Major Component, or to implement a Standard Interface for which an 294 | implementation is available to the public in source code form. A 295 | "Major Component", in this context, means a major essential component 296 | (kernel, window system, and so on) of the specific operating system 297 | (if any) on which the executable work runs, or a compiler used to 298 | produce the work, or an object code interpreter used to run it. 299 | 300 | The "Corresponding Source" for a work in object code form means all 301 | the source code needed to generate, install, and (for an executable 302 | work) run the object code and to modify the work, including scripts to 303 | control those activities. However, it does not include the work's 304 | System Libraries, or general-purpose tools or generally available free 305 | programs which are used unmodified in performing those activities but 306 | which are not part of the work. For example, Corresponding Source 307 | includes interface definition files associated with source files for 308 | the work, and the source code for shared libraries and dynamically 309 | linked subprograms that the work is specifically designed to require, 310 | such as by intimate data communication or control flow between those 311 | subprograms and other parts of the work. 312 | 313 | The Corresponding Source need not include anything that users 314 | can regenerate automatically from other parts of the Corresponding 315 | Source. 316 | 317 | The Corresponding Source for a work in source code form is that 318 | same work. 319 | 320 | 2. Basic Permissions. 321 | 322 | All rights granted under this License are granted for the term of 323 | copyright on the Program, and are irrevocable provided the stated 324 | conditions are met. This License explicitly affirms your unlimited 325 | permission to run the unmodified Program. The output from running a 326 | covered work is covered by this License only if the output, given its 327 | content, constitutes a covered work. This License acknowledges your 328 | rights of fair use or other equivalent, as provided by copyright law. 329 | 330 | You may make, run and propagate covered works that you do not 331 | convey, without conditions so long as your license otherwise remains 332 | in force. You may convey covered works to others for the sole purpose 333 | of having them make modifications exclusively for you, or provide you 334 | with facilities for running those works, provided that you comply with 335 | the terms of this License in conveying all material for which you do 336 | not control copyright. Those thus making or running the covered works 337 | for you must do so exclusively on your behalf, under your direction 338 | and control, on terms that prohibit them from making any copies of 339 | your copyrighted material outside their relationship with you. 340 | 341 | Conveying under any other circumstances is permitted solely under 342 | the conditions stated below. Sublicensing is not allowed; section 10 343 | makes it unnecessary. 344 | 345 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 346 | 347 | No covered work shall be deemed part of an effective technological 348 | measure under any applicable law fulfilling obligations under article 349 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 350 | similar laws prohibiting or restricting circumvention of such 351 | measures. 352 | 353 | When you convey a covered work, you waive any legal power to forbid 354 | circumvention of technological measures to the extent such circumvention 355 | is effected by exercising rights under this License with respect to 356 | the covered work, and you disclaim any intention to limit operation or 357 | modification of the work as a means of enforcing, against the work's 358 | users, your or third parties' legal rights to forbid circumvention of 359 | technological measures. 360 | 361 | 4. Conveying Verbatim Copies. 362 | 363 | You may convey verbatim copies of the Program's source code as you 364 | receive it, in any medium, provided that you conspicuously and 365 | appropriately publish on each copy an appropriate copyright notice; 366 | keep intact all notices stating that this License and any 367 | non-permissive terms added in accord with section 7 apply to the code; 368 | keep intact all notices of the absence of any warranty; and give all 369 | recipients a copy of this License along with the Program. 370 | 371 | You may charge any price or no price for each copy that you convey, 372 | and you may offer support or warranty protection for a fee. 373 | 374 | 5. Conveying Modified Source Versions. 375 | 376 | You may convey a work based on the Program, or the modifications to 377 | produce it from the Program, in the form of source code under the 378 | terms of section 4, provided that you also meet all of these conditions: 379 | 380 | a) The work must carry prominent notices stating that you modified 381 | it, and giving a relevant date. 382 | 383 | b) The work must carry prominent notices stating that it is 384 | released under this License and any conditions added under section 385 | 7. This requirement modifies the requirement in section 4 to 386 | "keep intact all notices". 387 | 388 | c) You must license the entire work, as a whole, under this 389 | License to anyone who comes into possession of a copy. This 390 | License will therefore apply, along with any applicable section 7 391 | additional terms, to the whole of the work, and all its parts, 392 | regardless of how they are packaged. This License gives no 393 | permission to license the work in any other way, but it does not 394 | invalidate such permission if you have separately received it. 395 | 396 | d) If the work has interactive user interfaces, each must display 397 | Appropriate Legal Notices; however, if the Program has interactive 398 | interfaces that do not display Appropriate Legal Notices, your 399 | work need not make them do so. 400 | 401 | A compilation of a covered work with other separate and independent 402 | works, which are not by their nature extensions of the covered work, 403 | and which are not combined with it such as to form a larger program, 404 | in or on a volume of a storage or distribution medium, is called an 405 | "aggregate" if the compilation and its resulting copyright are not 406 | used to limit the access or legal rights of the compilation's users 407 | beyond what the individual works permit. Inclusion of a covered work 408 | in an aggregate does not cause this License to apply to the other 409 | parts of the aggregate. 410 | 411 | 6. Conveying Non-Source Forms. 412 | 413 | You may convey a covered work in object code form under the terms 414 | of sections 4 and 5, provided that you also convey the 415 | machine-readable Corresponding Source under the terms of this License, 416 | in one of these ways: 417 | 418 | a) Convey the object code in, or embodied in, a physical product 419 | (including a physical distribution medium), accompanied by the 420 | Corresponding Source fixed on a durable physical medium 421 | customarily used for software interchange. 422 | 423 | b) Convey the object code in, or embodied in, a physical product 424 | (including a physical distribution medium), accompanied by a 425 | written offer, valid for at least three years and valid for as 426 | long as you offer spare parts or customer support for that product 427 | model, to give anyone who possesses the object code either (1) a 428 | copy of the Corresponding Source for all the software in the 429 | product that is covered by this License, on a durable physical 430 | medium customarily used for software interchange, for a price no 431 | more than your reasonable cost of physically performing this 432 | conveying of source, or (2) access to copy the 433 | Corresponding Source from a network server at no charge. 434 | 435 | c) Convey individual copies of the object code with a copy of the 436 | written offer to provide the Corresponding Source. This 437 | alternative is allowed only occasionally and noncommercially, and 438 | only if you received the object code with such an offer, in accord 439 | with subsection 6b. 440 | 441 | d) Convey the object code by offering access from a designated 442 | place (gratis or for a charge), and offer equivalent access to the 443 | Corresponding Source in the same way through the same place at no 444 | further charge. You need not require recipients to copy the 445 | Corresponding Source along with the object code. If the place to 446 | copy the object code is a network server, the Corresponding Source 447 | may be on a different server (operated by you or a third party) 448 | that supports equivalent copying facilities, provided you maintain 449 | clear directions next to the object code saying where to find the 450 | Corresponding Source. Regardless of what server hosts the 451 | Corresponding Source, you remain obligated to ensure that it is 452 | available for as long as needed to satisfy these requirements. 453 | 454 | e) Convey the object code using peer-to-peer transmission, provided 455 | you inform other peers where the object code and Corresponding 456 | Source of the work are being offered to the general public at no 457 | charge under subsection 6d. 458 | 459 | A separable portion of the object code, whose source code is excluded 460 | from the Corresponding Source as a System Library, need not be 461 | included in conveying the object code work. 462 | 463 | A "User Product" is either (1) a "consumer product", which means any 464 | tangible personal property which is normally used for personal, family, 465 | or household purposes, or (2) anything designed or sold for incorporation 466 | into a dwelling. In determining whether a product is a consumer product, 467 | doubtful cases shall be resolved in favor of coverage. For a particular 468 | product received by a particular user, "normally used" refers to a 469 | typical or common use of that class of product, regardless of the status 470 | of the particular user or of the way in which the particular user 471 | actually uses, or expects or is expected to use, the product. A product 472 | is a consumer product regardless of whether the product has substantial 473 | commercial, industrial or non-consumer uses, unless such uses represent 474 | the only significant mode of use of the product. 475 | 476 | "Installation Information" for a User Product means any methods, 477 | procedures, authorization keys, or other information required to install 478 | and execute modified versions of a covered work in that User Product from 479 | a modified version of its Corresponding Source. The information must 480 | suffice to ensure that the continued functioning of the modified object 481 | code is in no case prevented or interfered with solely because 482 | modification has been made. 483 | 484 | If you convey an object code work under this section in, or with, or 485 | specifically for use in, a User Product, and the conveying occurs as 486 | part of a transaction in which the right of possession and use of the 487 | User Product is transferred to the recipient in perpetuity or for a 488 | fixed term (regardless of how the transaction is characterized), the 489 | Corresponding Source conveyed under this section must be accompanied 490 | by the Installation Information. But this requirement does not apply 491 | if neither you nor any third party retains the ability to install 492 | modified object code on the User Product (for example, the work has 493 | been installed in ROM). 494 | 495 | The requirement to provide Installation Information does not include a 496 | requirement to continue to provide support service, warranty, or updates 497 | for a work that has been modified or installed by the recipient, or for 498 | the User Product in which it has been modified or installed. Access to a 499 | network may be denied when the modification itself materially and 500 | adversely affects the operation of the network or violates the rules and 501 | protocols for communication across the network. 502 | 503 | Corresponding Source conveyed, and Installation Information provided, 504 | in accord with this section must be in a format that is publicly 505 | documented (and with an implementation available to the public in 506 | source code form), and must require no special password or key for 507 | unpacking, reading or copying. 508 | 509 | 7. Additional Terms. 510 | 511 | "Additional permissions" are terms that supplement the terms of this 512 | License by making exceptions from one or more of its conditions. 513 | Additional permissions that are applicable to the entire Program shall 514 | be treated as though they were included in this License, to the extent 515 | that they are valid under applicable law. If additional permissions 516 | apply only to part of the Program, that part may be used separately 517 | under those permissions, but the entire Program remains governed by 518 | this License without regard to the additional permissions. 519 | 520 | When you convey a copy of a covered work, you may at your option 521 | remove any additional permissions from that copy, or from any part of 522 | it. (Additional permissions may be written to require their own 523 | removal in certain cases when you modify the work.) You may place 524 | additional permissions on material, added by you to a covered work, 525 | for which you have or can give appropriate copyright permission. 526 | 527 | Notwithstanding any other provision of this License, for material you 528 | add to a covered work, you may (if authorized by the copyright holders of 529 | that material) supplement the terms of this License with terms: 530 | 531 | a) Disclaiming warranty or limiting liability differently from the 532 | terms of sections 15 and 16 of this License; or 533 | 534 | b) Requiring preservation of specified reasonable legal notices or 535 | author attributions in that material or in the Appropriate Legal 536 | Notices displayed by works containing it; or 537 | 538 | c) Prohibiting misrepresentation of the origin of that material, or 539 | requiring that modified versions of such material be marked in 540 | reasonable ways as different from the original version; or 541 | 542 | d) Limiting the use for publicity purposes of names of licensors or 543 | authors of the material; or 544 | 545 | e) Declining to grant rights under trademark law for use of some 546 | trade names, trademarks, or service marks; or 547 | 548 | f) Requiring indemnification of licensors and authors of that 549 | material by anyone who conveys the material (or modified versions of 550 | it) with contractual assumptions of liability to the recipient, for 551 | any liability that these contractual assumptions directly impose on 552 | those licensors and authors. 553 | 554 | All other non-permissive additional terms are considered "further 555 | restrictions" within the meaning of section 10. If the Program as you 556 | received it, or any part of it, contains a notice stating that it is 557 | governed by this License along with a term that is a further 558 | restriction, you may remove that term. If a license document contains 559 | a further restriction but permits relicensing or conveying under this 560 | License, you may add to a covered work material governed by the terms 561 | of that license document, provided that the further restriction does 562 | not survive such relicensing or conveying. 563 | 564 | If you add terms to a covered work in accord with this section, you 565 | must place, in the relevant source files, a statement of the 566 | additional terms that apply to those files, or a notice indicating 567 | where to find the applicable terms. 568 | 569 | Additional terms, permissive or non-permissive, may be stated in the 570 | form of a separately written license, or stated as exceptions; 571 | the above requirements apply either way. 572 | 573 | 8. Termination. 574 | 575 | You may not propagate or modify a covered work except as expressly 576 | provided under this License. Any attempt otherwise to propagate or 577 | modify it is void, and will automatically terminate your rights under 578 | this License (including any patent licenses granted under the third 579 | paragraph of section 11). 580 | 581 | However, if you cease all violation of this License, then your 582 | license from a particular copyright holder is reinstated (a) 583 | provisionally, unless and until the copyright holder explicitly and 584 | finally terminates your license, and (b) permanently, if the copyright 585 | holder fails to notify you of the violation by some reasonable means 586 | prior to 60 days after the cessation. 587 | 588 | Moreover, your license from a particular copyright holder is 589 | reinstated permanently if the copyright holder notifies you of the 590 | violation by some reasonable means, this is the first time you have 591 | received notice of violation of this License (for any work) from that 592 | copyright holder, and you cure the violation prior to 30 days after 593 | your receipt of the notice. 594 | 595 | Termination of your rights under this section does not terminate the 596 | licenses of parties who have received copies or rights from you under 597 | this License. If your rights have been terminated and not permanently 598 | reinstated, you do not qualify to receive new licenses for the same 599 | material under section 10. 600 | 601 | 9. Acceptance Not Required for Having Copies. 602 | 603 | You are not required to accept this License in order to receive or 604 | run a copy of the Program. Ancillary propagation of a covered work 605 | occurring solely as a consequence of using peer-to-peer transmission 606 | to receive a copy likewise does not require acceptance. However, 607 | nothing other than this License grants you permission to propagate or 608 | modify any covered work. These actions infringe copyright if you do 609 | not accept this License. Therefore, by modifying or propagating a 610 | covered work, you indicate your acceptance of this License to do so. 611 | 612 | 10. Automatic Licensing of Downstream Recipients. 613 | 614 | Each time you convey a covered work, the recipient automatically 615 | receives a license from the original licensors, to run, modify and 616 | propagate that work, subject to this License. You are not responsible 617 | for enforcing compliance by third parties with this License. 618 | 619 | An "entity transaction" is a transaction transferring control of an 620 | organization, or substantially all assets of one, or subdividing an 621 | organization, or merging organizations. If propagation of a covered 622 | work results from an entity transaction, each party to that 623 | transaction who receives a copy of the work also receives whatever 624 | licenses to the work the party's predecessor in interest had or could 625 | give under the previous paragraph, plus a right to possession of the 626 | Corresponding Source of the work from the predecessor in interest, if 627 | the predecessor has it or can get it with reasonable efforts. 628 | 629 | You may not impose any further restrictions on the exercise of the 630 | rights granted or affirmed under this License. For example, you may 631 | not impose a license fee, royalty, or other charge for exercise of 632 | rights granted under this License, and you may not initiate litigation 633 | (including a cross-claim or counterclaim in a lawsuit) alleging that 634 | any patent claim is infringed by making, using, selling, offering for 635 | sale, or importing the Program or any portion of it. 636 | 637 | 11. Patents. 638 | 639 | A "contributor" is a copyright holder who authorizes use under this 640 | License of the Program or a work on which the Program is based. The 641 | work thus licensed is called the contributor's "contributor version". 642 | 643 | A contributor's "essential patent claims" are all patent claims 644 | owned or controlled by the contributor, whether already acquired or 645 | hereafter acquired, that would be infringed by some manner, permitted 646 | by this License, of making, using, or selling its contributor version, 647 | but do not include claims that would be infringed only as a 648 | consequence of further modification of the contributor version. For 649 | purposes of this definition, "control" includes the right to grant 650 | patent sublicenses in a manner consistent with the requirements of 651 | this License. 652 | 653 | Each contributor grants you a non-exclusive, worldwide, royalty-free 654 | patent license under the contributor's essential patent claims, to 655 | make, use, sell, offer for sale, import and otherwise run, modify and 656 | propagate the contents of its contributor version. 657 | 658 | In the following three paragraphs, a "patent license" is any express 659 | agreement or commitment, however denominated, not to enforce a patent 660 | (such as an express permission to practice a patent or covenant not to 661 | sue for patent infringement). To "grant" such a patent license to a 662 | party means to make such an agreement or commitment not to enforce a 663 | patent against the party. 664 | 665 | If you convey a covered work, knowingly relying on a patent license, 666 | and the Corresponding Source of the work is not available for anyone 667 | to copy, free of charge and under the terms of this License, through a 668 | publicly available network server or other readily accessible means, 669 | then you must either (1) cause the Corresponding Source to be so 670 | available, or (2) arrange to deprive yourself of the benefit of the 671 | patent license for this particular work, or (3) arrange, in a manner 672 | consistent with the requirements of this License, to extend the patent 673 | license to downstream recipients. "Knowingly relying" means you have 674 | actual knowledge that, but for the patent license, your conveying the 675 | covered work in a country, or your recipient's use of the covered work 676 | in a country, would infringe one or more identifiable patents in that 677 | country that you have reason to believe are valid. 678 | 679 | If, pursuant to or in connection with a single transaction or 680 | arrangement, you convey, or propagate by procuring conveyance of, a 681 | covered work, and grant a patent license to some of the parties 682 | receiving the covered work authorizing them to use, propagate, modify 683 | or convey a specific copy of the covered work, then the patent license 684 | you grant is automatically extended to all recipients of the covered 685 | work and works based on it. 686 | 687 | A patent license is "discriminatory" if it does not include within 688 | the scope of its coverage, prohibits the exercise of, or is 689 | conditioned on the non-exercise of one or more of the rights that are 690 | specifically granted under this License. You may not convey a covered 691 | work if you are a party to an arrangement with a third party that is 692 | in the business of distributing software, under which you make payment 693 | to the third party based on the extent of your activity of conveying 694 | the work, and under which the third party grants, to any of the 695 | parties who would receive the covered work from you, a discriminatory 696 | patent license (a) in connection with copies of the covered work 697 | conveyed by you (or copies made from those copies), or (b) primarily 698 | for and in connection with specific products or compilations that 699 | contain the covered work, unless you entered into that arrangement, 700 | or that patent license was granted, prior to 28 March 2007. 701 | 702 | Nothing in this License shall be construed as excluding or limiting 703 | any implied license or other defenses to infringement that may 704 | otherwise be available to you under applicable patent law. 705 | 706 | 12. No Surrender of Others' Freedom. 707 | 708 | If conditions are imposed on you (whether by court order, agreement or 709 | otherwise) that contradict the conditions of this License, they do not 710 | excuse you from the conditions of this License. If you cannot convey a 711 | covered work so as to satisfy simultaneously your obligations under this 712 | License and any other pertinent obligations, then as a consequence you may 713 | not convey it at all. For example, if you agree to terms that obligate you 714 | to collect a royalty for further conveying from those to whom you convey 715 | the Program, the only way you could satisfy both those terms and this 716 | License would be to refrain entirely from conveying the Program. 717 | 718 | 13. Use with the GNU Affero General Public License. 719 | 720 | Notwithstanding any other provision of this License, you have 721 | permission to link or combine any covered work with a work licensed 722 | under version 3 of the GNU Affero General Public License into a single 723 | combined work, and to convey the resulting work. The terms of this 724 | License will continue to apply to the part which is the covered work, 725 | but the special requirements of the GNU Affero General Public License, 726 | section 13, concerning interaction through a network will apply to the 727 | combination as such. 728 | 729 | 14. Revised Versions of this License. 730 | 731 | The Free Software Foundation may publish revised and/or new versions of 732 | the GNU General Public License from time to time. Such new versions will 733 | be similar in spirit to the present version, but may differ in detail to 734 | address new problems or concerns. 735 | 736 | Each version is given a distinguishing version number. If the 737 | Program specifies that a certain numbered version of the GNU General 738 | Public License "or any later version" applies to it, you have the 739 | option of following the terms and conditions either of that numbered 740 | version or of any later version published by the Free Software 741 | Foundation. If the Program does not specify a version number of the 742 | GNU General Public License, you may choose any version ever published 743 | by the Free Software Foundation. 744 | 745 | If the Program specifies that a proxy can decide which future 746 | versions of the GNU General Public License can be used, that proxy's 747 | public statement of acceptance of a version permanently authorizes you 748 | to choose that version for the Program. 749 | 750 | Later license versions may give you additional or different 751 | permissions. However, no additional obligations are imposed on any 752 | author or copyright holder as a result of your choosing to follow a 753 | later version. 754 | 755 | 15. Disclaimer of Warranty. 756 | 757 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 758 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 759 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 760 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 761 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 762 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 763 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 764 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 765 | 766 | 16. Limitation of Liability. 767 | 768 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 769 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 770 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 771 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 772 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 773 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 774 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 775 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 776 | SUCH DAMAGES. 777 | 778 | 17. Interpretation of Sections 15 and 16. 779 | 780 | If the disclaimer of warranty and limitation of liability provided 781 | above cannot be given local legal effect according to their terms, 782 | reviewing courts shall apply local law that most closely approximates 783 | an absolute waiver of all civil liability in connection with the 784 | Program, unless a warranty or assumption of liability accompanies a 785 | copy of the Program in return for a fee. 786 | 787 | END OF TERMS AND CONDITIONS 788 | --------------------------------------------------------------------------------