[ { "path": ".devcontainer/devcontainer.json", "content": "{\n \"name\": \"Swift Nightly Main\",\n \"dockerComposeFile\": \"docker-compose.yaml\",\n \"service\": \"devcontainer\",\n \"workspaceFolder\": \"${localWorkspaceFolder}\",\n \"features\": {\n \"ghcr.io/devcontainers/features/common-utils:2\": {\n \"installZsh\": \"false\",\n \"username\": \"root\",\n \"upgradePackages\": \"false\"\n },\n \"ghcr.io/devcontainers/features/git:1\": {\n \"version\": \"os-provided\",\n \"ppa\": \"false\"\n }\n },\n \"initializeCommand\": \".devcontainer/init.sh\",\n \"postCreateCommand\": \"apt-get update && apt-get install -y curl sqlite3 libsqlite3-dev libncurses5-dev python3 build-essential\",\n \"postStartCommand\": \"cd ${WORKSPACE_DIR}\",\n \"customizations\": {\n \"vscode\": {\n \"settings\": {\n \"lldb.library\": \"/usr/lib/liblldb.so\"\n },\n \"extensions\": [\n \"swiftlang.swift-vscode\"\n ]\n }\n },\n // Use 'forwardPorts' to make a list of ports inside the container available locally.\n // \"forwardPorts\": [],\n \"remoteUser\": \"root\"\n}\n" }, { "path": ".devcontainer/docker-compose.yaml", "content": "services:\n devcontainer:\n # Use your desired image or Dockerfile here\n image: \"swiftlang/swift:nightly-main\"\n env_file:\n - .env\n cap_add:\n - SYS_PTRACE\n security_opt:\n - seccomp=unconfined\n volumes:\n # Mount the main git repo dir and the current worktree dir at the same absolute path as the host\n - ${GIT_REPO}:${GIT_REPO}:rw\n - ${WORKSPACE_DIR}:${WORKSPACE_DIR}:rw\n command: sleep infinity\n" }, { "path": ".devcontainer/init.sh", "content": "#!/bin/bash\n##===----------------------------------------------------------------------===##\n##\n## This source file is part of the Swift open source project\n##\n## Copyright (c) 2022 Apple Inc. and the Swift project authors\n## Licensed under Apache License v2.0 with Runtime Library Exception\n##\n## See http://swift.org/LICENSE.txt for license information\n## See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n##\n##===----------------------------------------------------------------------===##\n\n# Calculates absolute paths for the git repo root and current workspace\n\nSCRIPT_DIR=$( cd -- \"$( dirname -- \"${BASH_SOURCE[0]}\" )\" &> /dev/null && pwd )\n\nGIT_COMMON_DIR=$(git rev-parse --git-common-dir)\ncase \"$GIT_COMMON_DIR\" in\n /*) ;;\n *) GIT_COMMON_DIR=\"$PWD/$GIT_COMMON_DIR\" ;;\nesac\n\nenv_file=\"${SCRIPT_DIR}/.env\"\n# Ensure the paths are absolute for Docker mounting\necho \"GIT_REPO=$(realpath \"$GIT_COMMON_DIR\")\" > \"${env_file}\"\necho \"WORKSPACE_DIR=$(realpath \"$PWD\")\" >> \"${env_file}\"\n" }, { "path": ".dir-locals.el", "content": ";;; Directory Local Variables -*- no-byte-compile: t -*-\n;;; For more information see (info \"(emacs) Directory Variables\")\n\n((nil . ((c-basic-offset . 4)))\n (swift-mode . ((swift-mode:basic-offset . 4))))\n" }, { "path": ".editorconfig", "content": "root = true\n\n[*]\ncharset = utf-8\nend_of_line = lf\nindent_size = 4\nindent_style = space\ninsert_final_newline = true\ntrim_trailing_whitespace = true\nxcode_trim_whitespace_on_empty_lines = true\n\n[*.{yml,yaml}]\nindent_size = 2\n" }, { "path": ".github/CODEOWNERS", "content": "# This file is a list of the people responsible for ensuring that patches for a\n# particular part of Swift are reviewed, either by themselves or by someone else.\n# They are also the gatekeepers for their part of Swift, with the final word on\n# what goes in or not.\n#\n# The list is sorted by surname and formatted to allow easy grepping and\n# beautification by scripts. The fields are: name (N), email (E), web-address\n# (W), PGP key ID and fingerprint (P), description (D), and snail-mail address\n# (S).\n\n# N: Tomer Doron\n# E: tomer@apple.com\n# D: Package Manager\n\n# N: Max Desiatov\n# E: m_desiatov@apple.com\n# D: Package Manager\n\n# N: Ben Barham\n# E: ben_barham@apple.com\n# D: Package Manager\n\n###\n\n# The following lines are used by GitHub to automatically recommend reviewers.\n\n* @jakepetroules @dschaefer2 @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123 @rconnell9 @daveinglis\n\nSources/Commands/PackageCommands/Migrate.swift @AnthonyLatsis @xedin @jakepetroules @dschaefer2 @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123 @rconnell9 @daveinglis\nSources/SwiftFixIt/* @AnthonyLatsis @xedin @jakepetroules @dschaefer2 @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123 @rconnell9 @daveinglis\nTests/SwiftFixItTests/* @AnthonyLatsis @xedin @jakepetroules @dschaefer2 @bripeticca @plemarquand @owenv @bkhouri @cmcgee1024 @daveyc123 @rconnell9 @daveinglis\n" }, { "path": ".github/ISSUE_TEMPLATE/BUG_REPORT.yml", "content": "name: Bug Report\ndescription: Something isn't working as expected\nlabels: [bug]\nbody:\n - type: checkboxes\n id: cat-preferences\n attributes:\n label: >-\n Is it reproducible with SwiftPM command-line tools: `swift build`,\n `swift test`, `swift package` etc?\n description: >-\n Issues related to closed-source software are not tracked by this\n repository and will be closed. For Xcode and `xcodebuild`, please\n file a feedback at https://feedbackassistant.apple.com instead.\"\n options:\n - label: >-\n Confirmed reproduction steps with SwiftPM CLI. The description\n text _must_ include reproduction steps with either of command-line\n SwiftPM commands, `swift build`, `swift test`, `swift package` etc.\n required: true\n - type: textarea\n attributes:\n label: Description\n validations:\n required: true\n - type: textarea\n attributes:\n label: Expected behavior\n description: What you expected to happen.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Actual behavior\n description: What actually happened.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Steps to reproduce\n placeholder: |\n 1. ...\n 2. ...\n validations:\n required: false\n - type: input\n attributes:\n label: Swift Package Manager version/commit hash\n validations:\n required: false\n - type: textarea\n attributes:\n label: Swift & OS version (output of `swift --version ; uname -a`)\n validations:\n required: false\n" }, { "path": ".github/ISSUE_TEMPLATE/FEATURE_REQUEST.yml", "content": "name: Feature Request\ndescription: A suggestion for a new feature\nlabels: [enhancement]\nbody:\n - type: textarea\n attributes:\n label: Description\n validations:\n required: true\n - type: textarea\n attributes:\n label: Expected behavior\n description: What you expected to happen.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Actual behavior\n description: What actually happened.\n validations:\n required: false\n - type: textarea\n attributes:\n label: Steps to reproduce\n placeholder: |\n 1. ...\n 2. ...\n validations:\n required: false\n - type: input\n attributes:\n label: Swift Package Manager version/commit hash\n validations:\n required: false\n - type: textarea\n attributes:\n label: Swift & OS version (output of `swift --version && uname -a`)\n validations:\n required: false\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "_[One line description of your change]_\n\n### Motivation:\n\n_[Explain here the context, and why you're making that change. What is the problem you're trying to solve.]_\n\n### Modifications:\n\n_[Describe the modifications you've done.]_\n\n### Result:\n\n_[After your change, what will change.]_\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\nupdates:\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n" }, { "path": ".github/scripts/prebuild.ps1", "content": "##===----------------------------------------------------------------------===##\n##\n## This source file is part of the Swift open source project\n##\n## Copyright (c) 2025 Apple Inc. and the Swift project authors\n## Licensed under Apache License v2.0 with Runtime Library Exception\n##\n## See http://swift.org/LICENSE.txt for license information\n## See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n##\n##===----------------------------------------------------------------------===##\n\nparam (\n [switch]$SkipAndroid,\n [switch]$InstallCMake\n)\n\n# winget isn't easily made available in containers, so use chocolatey\nSet-ExecutionPolicy Bypass -Scope Process -Force; [System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://community.chocolatey.org/install.ps1'))\n\nif ($InstallCMake) {\n choco install -y cmake --installargs 'ADD_CMAKE_TO_PATH=System' --apply-install-arguments-to-dependencies\n choco install -y ninja\n\n Import-Module $env:ChocolateyInstall\\helpers\\chocolateyProfile.psm1\n refreshenv\n\n # Let swiftc find the path to link.exe in the CMake smoke test\n $env:Path += \";$(Split-Path -Path \"$(& \"${env:ProgramFiles(x86)}\\Microsoft Visual Studio\\Installer\\vswhere.exe\" \"-latest\" -products Microsoft.VisualStudio.Product.BuildTools -find VC\\Tools\\MSVC\\*\\bin\\HostX64\\x64\\link.exe)\" -Parent)\"\n}\n\nif (-not $SkipAndroid) {\n choco install -y android-ndk\n\n Import-Module $env:ChocolateyInstall\\helpers\\chocolateyProfile.psm1\n refreshenv\n\n # Work around a bug in the package causing the env var to be set incorrectly\n $env:ANDROID_NDK_ROOT = $env:ANDROID_NDK_ROOT.replace('-windows.zip','')\n}\n" }, { "path": ".github/scripts/prebuild.sh", "content": "#!/bin/bash\n##===----------------------------------------------------------------------===##\n##\n## This source file is part of the Swift open source project\n##\n## Copyright (c) 2025 Apple Inc. and the Swift project authors\n## Licensed under Apache License v2.0 with Runtime Library Exception\n##\n## See http://swift.org/LICENSE.txt for license information\n## See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n##\n##===----------------------------------------------------------------------===##\n\nset -e\n\nif [[ $(uname) == Darwin ]] ; then\n if [[ \"$INSTALL_CMAKE\" == \"1\" ]] ; then\n mkdir -p \"$RUNNER_TOOL_CACHE\"\n if ! command -v cmake >/dev/null 2>&1 ; then\n curl -fsSLO https://github.com/Kitware/CMake/releases/download/v4.1.2/cmake-4.1.2-macos-universal.tar.gz\n echo '3be85f5b999e327b1ac7d804cbc9acd767059e9f603c42ec2765f6ab68fbd367 cmake-4.1.2-macos-universal.tar.gz' > cmake-4.1.2-macos-universal.tar.gz.sha256\n sha256sum -c cmake-4.1.2-macos-universal.tar.gz.sha256\n tar -xf cmake-4.1.2-macos-universal.tar.gz\n ln -s \"$PWD/cmake-4.1.2-macos-universal/CMake.app/Contents/bin/cmake\" \"$RUNNER_TOOL_CACHE/cmake\"\n fi\n if ! command -v ninja >/dev/null 2>&1 ; then\n curl -fsSLO https://github.com/ninja-build/ninja/releases/download/v1.13.1/ninja-mac.zip\n echo 'da7797794153629aca5570ef7c813342d0be214ba84632af886856e8f0063dd9 ninja-mac.zip' > ninja-mac.zip.sha256\n sha256sum -c ninja-mac.zip.sha256\n unzip ninja-mac.zip\n rm -f ninja-mac.zip\n mv ninja \"$RUNNER_TOOL_CACHE/ninja\"\n fi\n fi\nelif command -v apt-get >/dev/null 2>&1 ; then # bookworm, noble, jammy\n export DEBIAN_FRONTEND=noninteractive\n\n apt-get update -y\n\n # Build dependencies\n apt-get install -y libsqlite3-dev libncurses-dev\n\n # Debug symbols\n apt-get install -y libc6-dbg\n\n if [[ \"$INSTALL_CMAKE\" == \"1\" ]] ; then\n apt-get install -y cmake ninja-build\n fi\n\n # Android NDK\n dpkg_architecture=\"$(dpkg --print-architecture)\"\n if [[ \"$SKIP_ANDROID\" != \"1\" ]] && [[ \"$dpkg_architecture\" == amd64 ]] ; then\n eval \"$(cat /etc/os-release)\"\n case \"$VERSION_CODENAME\" in\n bookworm|jammy)\n : # Not available\n ;;\n noble)\n apt-get install -y google-android-ndk-r26c-installer\n ;;\n *)\n echo \"Unable to fetch Android NDK for unknown Linux distribution: $VERSION_CODENAME\" >&2\n exit 1\n esac\n else\n echo \"Skipping Android NDK installation on $dpkg_architecture\" >&2\n fi\nelif command -v dnf >/dev/null 2>&1 ; then # rhel-ubi9\n dnf update -y\n\n # Build dependencies\n dnf install -y sqlite-devel ncurses-devel\n\n # Debug symbols\n dnf debuginfo-install -y glibc\nelif command -v yum >/dev/null 2>&1 ; then # amazonlinux2\n yum update -y\n\n # Build dependencies\n yum install -y sqlite-devel ncurses-devel\n\n # Debug symbols\n yum install -y yum-utils\n debuginfo-install -y glibc\nfi\n" }, { "path": ".github/workflows/automerge.yml", "content": "name: Create PR to merge main into release branch\n# In the first period after branching the release branch,\n# we typically want to include many changes from `main` in the release branch.\n# This workflow automatically creates a PR to merge the main into the release branch.\n# Later in the release cycle we should stop this practice to avoid landing risky changes by disabling this workflow.\n# To do so, disable the workflow as described in https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-workflow-runs/disabling-and-enabling-a-workflow\npermissions:\n contents: read\non:\n workflow_dispatch:\njobs:\n create_merge_pr:\n name: Create PR to merge main into release branch\n uses: swiftlang/github-workflows/.github/workflows/create_automerge_pr.yml@0.0.8\n with:\n head_branch: main\n base_branch: release/6.3\n permissions:\n contents: write\n pull-requests: write\n if: (github.event_name == 'schedule' && github.repository == 'swiftlang/swift-package-manager') || (github.event_name != 'schedule') # Ensure that we don't run this on a schedule in a fork\n" }, { "path": ".github/workflows/pull_request.yml", "content": "name: Pull request\n\npermissions:\n contents: read\n\non:\n pull_request:\n types: [opened, reopened, synchronize]\n\nconcurrency:\n group: ${{ github.workflow }}-${{ github.ref }}\n cancel-in-progress: true\n\njobs:\n build:\n needs: [soundness]\n strategy:\n fail-fast: false\n matrix:\n executableTargetBuildSystem: [\"native\"]\n buildSystem: [\"native\", \"swiftbuild\"]\n linuxSwiftVersion: ['[\"nightly-main\", \"nightly-6.2\"]', '[\"nightly-main\"]']\n exclude:\n - buildSystem: \"swiftbuild\"\n linuxSwiftVersion: '[\"nightly-main\", \"nightly-6.2\"]'\n - buildSystem: \"native\"\n linuxSwiftVersion: '[\"nightly-main\"]'\n name: Build (${{ matrix.buildSystem }}) (exectable target built using ${{ matrix.executableTargetBuildSystem }})\n uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@0.0.8\n with:\n linux_os_versions: '[\"amazonlinux2\", \"bookworm\", \"noble\", \"jammy\", \"rhel-ubi9\"]'\n linux_swift_versions: ${{ matrix.linuxSwiftVersion }}\n linux_pre_build_command: ./.github/scripts/prebuild.sh\n linux_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}}'\n # linux_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}} && swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-test --parallel --build-system ${{ matrix.buildSystem}}'\n windows_build_timeout: 180\n windows_swift_versions: '[\"nightly-main\"]'\n windows_pre_build_command: 'Invoke-Program .\\.github\\scripts\\prebuild.ps1'\n windows_build_command: 'Invoke-Program swift run -Xlinker /ignore:4217 --configuration release --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests -Xlinker /ignore:4217 --build-system ${{ matrix.buildSystem}}'\n # windows_build_command: 'Invoke-Program swift run -Xlinker /ignore:4217 --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests -Xlinker /ignore:4217 --build-system ${{ matrix.buildSystem}}; Invoke-Program swift run --build-system ${{ matrix.executableTargetBuildSystem }} -Xlinker /ignore:4217 swift-test -Xlinker /ignore:4217 --parallel --build-system ${{ matrix.buildSystem}}'\n enable_windows_checks: true\n enable_ios_checks: false\n enable_macos_checks: true\n macos_exclude_xcode_versions: \"[{\\\"xcode_version\\\": \\\"16.3\\\"}, {\\\"xcode_version\\\": \\\"16.4\\\"}]\"\n macos_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}}'\n # macos_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}} && swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-test --parallel --build-system ${{ matrix.buildSystem}}'\n ios_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}} --sdk \\\"$(xcrun --sdk iphoneos --show-sdk-path)\\\" --triple arm64-apple-ios'\n # ios_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem}} --sdk \\\"$(xcrun --sdk iphoneos --show-sdk-path)\\\" --triple arm64-apple-ios && swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-test --parallel --build-system ${{ matrix.buildSystem }} --sdk \\\"$(xcrun --sdk iphoneos --show-sdk-path)\\\" --triple arm64-apple-ios'\n\n build-using-swiftbuild:\n strategy:\n fail-fast: false\n matrix:\n executableTargetBuildSystem: [\"swiftbuild\"]\n buildSystem: [\"swiftbuild\"]\n name: Build (${{ matrix.buildSystem }}) (exectable target built using ${{ matrix.executableTargetBuildSystem }})\n needs: [soundness]\n uses: swiftlang/github-workflows/.github/workflows/swift_package_test.yml@0.0.8\n with:\n linux_os_versions: '[\"amazonlinux2\", \"bookworm\", \"noble\", \"jammy\", \"rhel-ubi9\"]'\n linux_swift_versions: '[\"nightly-main\"]'\n linux_pre_build_command: ./.github/scripts/prebuild.sh\n linux_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem }}'\n enable_windows_checks: false\n windows_build_timeout: 180\n windows_swift_versions: '[\"nightly-main\"]'\n windows_pre_build_command: 'Invoke-Program .\\.github\\scripts\\prebuild.ps1'\n windows_build_command: 'Invoke-Program swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem }}'\n enable_ios_checks: false\n enable_macos_checks: true\n macos_exclude_xcode_versions: \"[{\\\"xcode_version\\\": \\\"16.3\\\"}, {\\\"xcode_version\\\": \\\"16.4\\\"}]\"\n macos_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem }}'\n ios_build_command: 'swift run --build-system ${{ matrix.executableTargetBuildSystem }} swift-build --build-tests --build-system ${{ matrix.buildSystem }} --sdk \\\"$(xcrun --sdk iphoneos --show-sdk-path)\\\" --triple arm64-apple-ios'\n\n soundness:\n name: Soundness\n uses: swiftlang/github-workflows/.github/workflows/soundness.yml@0.0.8\n with:\n license_header_check_project_name: \"Swift\"\n license_header_check_enabled: true\n unacceptable_language_check_enabled: true\n api_breakage_check_enabled: false\n format_check_enabled: false\n shell_check_enabled: false\n docs_check_enabled: true\n broken_symlink_check_enabled: true\n python_lint_check_enabled: true\n yamllint_check_enabled: true\n" }, { "path": ".gitignore", "content": ".build\n.test\n.index-build\n.devcontainer/.env\nDerivedData\n/.previous-build\nxcuserdata\n.DS_Store\n*~\n\\#*\n.\\#*\n.*.sw[nop]\n*.xcscmblueprint\n/default.profraw\n*.xcodeproj\nUtilities/Docker/*.tar.gz\n.swiftpm\nPackage.resolved\n/build\n*.pyc\n.docc-build\n.vscode\n/stage/\nUtilities/InstalledSwiftPMConfiguration/config.json\nFixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/build\n" }, { "path": ".license_header_template", "content": "@@===----------------------------------------------------------------------===@@\n@@\n@@ This source file is part of the Swift open source project\n@@\n@@ Copyright (c) YEARS Apple Inc. and the Swift project authors\n@@ Licensed under Apache License v2.0 with Runtime Library Exception\n@@\n@@ See http://swift.org/LICENSE.txt for license information\n@@ See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n@@\n@@===----------------------------------------------------------------------===@@\n" }, { "path": ".licenseignore", "content": "**/*.mlmodel\n**/*.pbxproj\n**/*.png\n**/*.xcworkspacedata\n**/Package.swift\n.dir-locals.el\n.editorconfig\n.swift-version\n.swiftformat\n.pep8\n.mailmap\n.mailfilter\nCODEOWNERS\nPackage.swift\nFixtures/**/*.*\n**/*.pc\n**/*.cer\n**/*.zip\n**/*.tar\n**/*.tgz\n**/*.gz\n**/*.svg\n**/*.bat\n**/*.xctestplan\n**/processInputs/**\nUtilities/bootstrap\nUtilities/build-using-self\nUtilities/new-bootstrap\nUtilities/test-toolchain\n" }, { "path": ".mailfilter", "content": "# This is a list of `shasum` hashed email addresses which are filtered from CONTRIBUTORS.txt, typically for privacy.\n# Lines can be generated by running `echo -n 'My Name ' | shasum | head -c 40`.\n\n03a39e53ca4764a094b9f6e548e8d1ce0d941d7b\n38268a29b340ecfb435c5e6c5827a596acb71cc6\n43b012c0b4e67962522a02e12d07cb5d5c5ba036\n886d1da6503c6de1d630beaf6acb667e4ce3e2a0\n" }, { "path": ".mailmap", "content": "Alex Blewitt \nAlex Blewitt \nAlex Hoppen \nAlex Hoppen \nAnkit Aggarwal \nAnkit Aggarwal \nAnkit Aggarwal \nAnkit Aggarwal \nBen Chatelain \nBen Chatelain \nBen Cohen \nBen Cohen \nBen Langmuir \nBen Langmuir \nBenjamin Herzog \nBenjamin Herzog \nBenjamin Scholtysik \nBenjamin Scholtysik (Reimold) \nBenjamin Scholtysik \nBoris Buegling \nBoris Buegling \nBraden Scothern \nBraden Scothern \nBrandon Titus \nBrandon Titus \nBrian Croom \nBrian Croom \nBrian Gesiak \nBrian Gesiak \nChris Lattner \nChris Lattner \nDan Zheng \nDan Zheng \nDaniel Duan \nDaniel Duan \nDaniel Duan \nDaniel Dunbar \nDaniel Dunbar \nDario Rexin \nDario Rexin \nDave Abrahams \nDave Abrahams \nDavid Hart \nDavid Hart \nHarlan Haskins \nHarlan Haskins \nHelge Hess \nHonza Dvorsky \nHonza Dvorsky \nHonza Dvorsky \nJ. Cheyo Jimenez \nJ. Cheyo Jimenez \nJohannes Weiss \nJohannes Weiss \nJohannes Weiss \nKilian Koeltzsch \nKilian Koeltzsch \nKyle Jessup \nKyle Jessup \nLev Walkin \nLev Walkin \nMarcin Krzyzanowski \nMarcin Krzyzanowski <758033+krzyzanowskim@users.noreply.github.com>\nMarcin Krzyzanowski \nMarcin Krzyzanowski \nMatthew Seaman \nMatthew Seaman \nMattt Thompson \nMattt Thompson \nMattt Thompson \nMax Howell \nMax Howell \nMax Liberman \nMax Liberman \nMax Moiseev \nMax Moiseev \nMax Moiseev \nMichael Ilseman \nMichael Ilseman \nMishal Shah \nMishal Shah \nNikola Lajic \nNikola Lajic \nOwen Voorhees \nOwen Voorhees \nPavel Yaskevich \nPavel Yaskevich \nSaleem Abdulrasool \nSaleem Abdulrasool \nSaleem Abdulrasool \nSergio Campamá \nSergio Campamá \nSlava Pestov \nSlava Pestov \nThomas Roughton \nThomas Roughton \nTim Condon <0xTim@users.noreply.github.com> <0xTim@users.noreply.github.com>\nTim Condon <0xTim@users.noreply.github.com> \nTim Gymnich \nTim Gymnich \nTom Doron \nValeriy Van \nValeriy Van \nfinagolfin \nfinagolfin \n" }, { "path": ".pep8", "content": "[flake8]\nfilename = *.py,bootstrap\nmax-line-length = 80\n" }, { "path": ".swift-version", "content": "6.2.3" }, { "path": ".swiftformat", "content": "## File options\n\n--swiftversion 5.9\n--exclude .build\n\n## Formatting options\n\n# Configure the placement of an extension's access control keyword.\n--extensionacl on-declarations\n\n# #if indenting\n--ifdef no-indent\n\n# Wrap lines that exceed the specified maximum width.\n--maxwidth 120\n\n# Reposition `let` or `var` bindings within pattern.\n--patternlet inline\n\n# Insert explicit `self` where applicable.\n--self insert\n\n# Mark unused function arguments with `_`.\n--stripunusedargs unnamed-only\n\n# Remove trailing space at end of a line.\n--trimwhitespace always\n\n# Wrap `@attributes` onto a separate line.\n--funcattributes prev-line\n--typeattributes prev-line\n\n# Use `Void` for type declarations and `()` for values.\n--voidtype void\n\n# Align wrapped function arguments or collection elements.\n--wraparguments before-first\n\n## Rules\n\n# Prefer `&&` over `,` comma in `if`, `guard` or `while` conditions.\n# Preserve `nil` default value (Optional `var`s are `nil` by default).\n--disable andOperator,redundantNilInit \n" }, { "path": "Benchmarks/Benchmarks/PackageGraphBenchmarks/PackageGraphBenchmarks.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n@_spi(DontAdoptOutsideOfSwiftPMExposedForBenchmarksAndTestsOnly)\nimport Basics\nimport Benchmark\nimport Foundation\nimport PackageModel\n\n@_spi(DontAdoptOutsideOfSwiftPMExposedForBenchmarksAndTestsOnly)\nimport func PackageGraph.loadModulesGraph\n\nimport Workspace\n\nlet benchmarks = {\n let defaultMetrics: [BenchmarkMetric]\n if let envVar = ProcessInfo.processInfo.environment[\"SWIFTPM_BENCHMARK_ALL_METRICS\"],\n envVar.lowercased() == \"true\" || envVar == \"1\" {\n defaultMetrics = .all\n } else {\n defaultMetrics = [\n .mallocCountTotal,\n .syscalls,\n ]\n }\n\n let modulesGraphDepth: Int\n if let envVar = ProcessInfo.processInfo.environment[\"SWIFTPM_BENCHMARK_MODULES_GRAPH_DEPTH\"],\n let parsedValue = Int(envVar) {\n modulesGraphDepth = parsedValue\n } else {\n modulesGraphDepth = 150\n }\n\n let modulesGraphWidth: Int\n if let envVar = ProcessInfo.processInfo.environment[\"SWIFTPM_BENCHMARK_MODULES_GRAPH_WIDTH\"],\n let parsedValue = Int(envVar) {\n modulesGraphWidth = parsedValue\n } else {\n modulesGraphWidth = 150\n }\n\n let packagesGraphDepth: Int\n if let envVar = ProcessInfo.processInfo.environment[\"SWIFTPM_BENCHMARK_PACKAGES_GRAPH_DEPTH\"],\n let parsedValue = Int(envVar) {\n packagesGraphDepth = parsedValue\n } else {\n packagesGraphDepth = 10\n }\n\n // Benchmarks computation of a resolved graph of modules for a package using `Workspace` as an entry point. It runs PubGrub to get\n // resolved concrete versions of dependencies, assigning all modules and products to each other as corresponding dependencies\n // with their build triples, but with the build plan not yet constructed. In this benchmark specifically we're loading `Package.swift`\n // for SwiftPM itself.\n Benchmark(\n \"SwiftPMWorkspaceModulesGraph\",\n configuration: .init(\n metrics: defaultMetrics,\n maxDuration: .seconds(10),\n thresholds: [\n .mallocCountTotal: .init(absolute: [.p90: 12000]),\n .syscalls: .init(absolute: [.p90: 1600]),\n ]\n )\n ) { benchmark in\n let path = try AbsolutePath(validating: #file).parentDirectory.parentDirectory.parentDirectory\n let workspace = try Workspace(fileSystem: localFileSystem, location: .init(forRootPackage: path, fileSystem: localFileSystem))\n\n for _ in benchmark.scaledIterations {\n try workspace.loadPackageGraph(rootPath: path, observabilityScope: ObservabilitySystem.NOOP)\n }\n }\n\n // Benchmarks computation of a resolved graph of modules for a trivial synthesized package using `loadModulesGraph`\n // as an entry point, which almost immediately delegates to `ModulesGraph.load` under the hood.\n Benchmark(\n \"SyntheticModulesGraph\",\n configuration: .init(\n metrics: defaultMetrics,\n maxDuration: .seconds(10),\n thresholds: [\n .mallocCountTotal: .init(absolute: [.p90: 17000]),\n .syscalls: .init(absolute: [.p90: 5]),\n ]\n )\n ) { benchmark in\n try syntheticModulesGraph(\n benchmark,\n modulesGraphDepth: modulesGraphDepth,\n modulesGraphWidth: modulesGraphWidth\n )\n }\n\n // Benchmarks computation of a resolved graph of modules for a synthesized package that includes macros,\n // using `loadModulesGraph` as an entry point, which almost immediately delegates to `ModulesGraph.load` under\n // the hood.\n Benchmark(\n \"SyntheticModulesGraphWithMacros\",\n configuration: .init(\n metrics: defaultMetrics,\n maxDuration: .seconds(10),\n thresholds: [\n .mallocCountTotal: .init(absolute: [.p90: 8000]),\n .syscalls: .init(absolute: [.p90: 5]),\n ]\n )\n ) { benchmark in\n try syntheticModulesGraph(\n benchmark,\n modulesGraphDepth: modulesGraphDepth,\n modulesGraphWidth: modulesGraphWidth,\n includeMacros: true\n )\n }\n}\n\nfunc syntheticModulesGraph(\n _ benchmark: Benchmark,\n modulesGraphDepth: Int,\n modulesGraphWidth: Int,\n includeMacros: Bool = false\n) throws {\n // If macros are included, modules are split in three parts:\n // 1. top-level modules\n // 2. macros\n // 3. dependencies of macros\n let macrosDenominator = includeMacros ? 3 : 1\n let libraryModules: [TargetDescription] = try (0..<(modulesGraphWidth / macrosDenominator)).map { i -> TargetDescription in\n let dependencies = (0.. [TargetDescription.Dependency] in\n if includeMacros {\n [.target(name: \"Module\\(i)\"), .target(name: \"Macros\\(i)\")]\n } else {\n [.target(name: \"Module\\(i)\")]\n }\n }\n return try TargetDescription(name: \"Module\\(i)\", dependencies: dependencies)\n }\n\n let macrosModules: [TargetDescription]\n let macrosDependenciesModules: [TargetDescription]\n if includeMacros {\n macrosModules = try (0..`, or there is more than one target, the existing expectation for sources apply.\n\n* [#6540]\n\n Build tool plugins can be used with C-family targets\n\n* [#6663]\n\n Add `visionOS` as a platform alongside `iOS` and other platforms\n \n\nSwift 5.8\n-----------\n\n* [SE-0362] \n\n SwiftPM targets can now specify the upcoming language features they require. `Package.swift` manifest syntax has been expanded with an API to include setting `enableUpcomingFeature` and `enableExperimentalFeature` flags at the target level, as specified by [SE-0362].\n \n* [SE-0378]\n\n SwiftPM now supports token authentication when interacting with a package registry. The `swift package-registry` command has two new subcommands `login` and `logout` as defined in SE-0378 for adding/removing registry credentials. \n\n* [#5810]\n\n SwiftPM now allows exposing an executable product that consists solely of a binary target that is backed by an artifact bundle. This allow vending binary executables as their own separate package, independently of the plugins that are using them. \n\n* [#5819]\n\n Improved handling of offline behavior when a cached version of a dependency exists on disk. SwiftPM will check for network availability status to determine if it should attempt to update a checked version of a dependency, and when offline will use the cached version without an update.\n\n* [#5874]\n\n In packages using tools version 5.8 or later, Foundation is no longer implicitly imported into package manifests. If Foundation APIs are used, the module needs to be imported explicitly.\n \n* [#5892]\n\n Added new `--emit-extension-block-symbols` and `--omit-extension-block-symbols` via `swift package dump-symbol-graph`. `--emit-extension-block-symbols` dumps symbol graph files that are extension block symbol format. The default behavior does not change. The `--omit-extension-block-symbols` flag will be used to explicitly disable the feature once the default behavior has been changed to `--emit-extension-block-symbols` in the future.\n \n* [#5949]\n \n New `--pkg-config-path` option on `build`, `test`, and `run` commands has been introduced as an alternative to passing `PKG_CONFIG_PATH` environment variable. It allows specifying alternative path to search for `.pc` files used by `pkg-config`. Use the option multiple times to specify more than one path. \n\nSwift 5.7\n-----------\n\n* [SE-0292]\n\n SwiftPM can now resolve dependencies from a server compliant with the package registry server API defined in SE-0292. \n \n* [SE-0339]\n\n Module aliases can now be defined in the package manifest to disambiguate between modules with the same name originating from different packages. \n\n* [#4119] \n \n Add a `--disable-testable-imports` flag to `swift test` with which tests are built without the testability feature (`import @testable` disabled).\n\n* [#4131]\n\n Update to manifest API to make it impossible to create an invalid build settings condition.\n\n* [#4135]\n\n Enable linker dead stripping for all platforms. This can be disabled with `--disable-dead-strip`\n\n* [#4168]\n\n Update to manifest API to make it impossible to create an invalid target dependency condition.\n\nSwift 5.6\n-----------\n* [SE-0303]\n\n Package plugins of the type `buildTool` can now be declared in packages that specify a tools version of 5.6 or later, and can be invoked using the `swift build` command.\n \n* [SE-0332]\n\n Package plugins of the type `command` can now be declared in packages that specify a tools version of 5.6 or later, and can be invoked using the `swift package` subcommand.\n\n* [#3649]\n\n Semantic version dependencies can now be resolved against Git tag names that contain only major and minor version identifiers. A tag with the form `X.Y` will be treated as `X.Y.0`. This improves compatibility with existing repositories.\n\n* [#3486]\n\n Both parsing and comparison of semantic versions now strictly follow the [Semantic Versioning 2.0.0 specification](https://semver.org). \n \n The parsing logic now treats the first \"-\" in a version string as the delimiter between the version core and the pre-release identifiers, _only_ if there is no preceding \"+\". Otherwise, it's treated as part of a build metadata identifier.\n \n The comparison logic now ignores build metadata identifiers, and treats 2 semantic versions as equal if and only if they're equal in their major, minor, patch versions and pre-release identifiers.\n\n* [#3641]\n\n Soft deprecate `.package(name:, url:)` dependency syntax in favor of `.package(url:)`, given that an explicit `name` attribute is no longer needed for target dependencies lookup.\n\n* [#3641]\n\n Adding a dependency requirement can now be done with the convenience initializer `.package(url: String, exact: Version)`.\n\n* [#3641]\n\n Dependency requirement enum calling convention is deprecated in favour of labeled argument: \n * `.package(url: String, .branch(String))` -> `.package(url: String, branch: String)`\n * `.package(url: String, .revision(String))` -> `.package(url: String, revision: String)` \n * `.package(url: String, .exact(Version))` -> `.package(url: String, exact: Version)` \n\n* [#3717]\n\n Introduce a second version of `Package.resolved` file format which more accurately captures package identity.\n\n* [#3890]\n\n To increase the security of packages, SwiftPM performs trust on first use (TOFU) validation. The fingerprint of a package is now being recorded when the package is first downloaded from a Git repository or package registry. Subsequent downloads must have fingerpints matching previous recorded values, otherwise it would result in build warnings or failures depending on settings. \n\n* [#3670], [#3901], [#3942]\n\n Location of configuration files (including mirror file) have changed to accomodate new features that require more robust configuration directories structure, such as SE-0292: \n * `/.swiftpm/config` (mirrors file) was moved to `/.swiftpm/configuration/mirrors.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.\n * `~/.swiftpm/config/collections.json` (collections file) was moved to `~/.swiftpm/configuration/collections.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.\n\n\nSwift 5.5\n-----------\n* [#3410]\n\n In a package that specifies a minimum tools version of 5.5, `@main` can now be used in a single-source file executable as long as the name of the source file isn't `main.swift`. To work around special compiler semantics with single-file modules, SwiftPM now passes `-parse-as-library` when compiling an executable module that contains a single Swift source file whose name is not `main.swift`.\n\n* [#3310]\n\n Adding a dependency requirement can now be done with the convenience initializer `.package(url: String, revision: String)`.\n\n* [#3292]\n\n Adding a dependency requirement can now be done with the convenience initializer `.package(url: String, branch: String)`.\n\n* [#3280]\n\n A more intuitive `.product(name:, package:)` target dependency syntax is now accepted, where `package` is the package identifier as defined by the package URL.\n\n* [#3316]\n\n Test targets can now link against executable targets as if they were libraries, so that they can test any data structures or algorithms in them. All the code in the executable except for the main entry point itself is available to the unit test. Separate executables are still linked, and can be tested as a subprocess in the same way as before. This feature is available to tests defined in packages that have a tools version of `5.5` or newer. \n\n\nSwift 5.4\n-----------\n* [#2937]\n \n * Improvements\n \n `Package` manifests can now have any combination of leading whitespace characters. This allows more flexibility in formatting the manifests.\n \n [SR-13566] The Swift tools version specification in each manifest file now accepts any combination of _horizontal_ whitespace characters surrounding `swift-tools-version`, if and only if the specified version ≥ `5.4`. For example, `//swift-tools-version:\t5.4` and `//\t\t swift-tools-version: 5.4` are valid.\n \n All [Unicode line terminators](https://www.unicode.org/reports/tr14/) are now recognized in `Package` manifests. This ensures correctness in parsing manifests that are edited and/or built on many non-Unix-like platforms that use ASCII or Unicode encodings. \n \n * API Removal\n \n `ToolsVersionLoader.Error.malformedToolsVersion(specifier: String, currentToolsVersion: ToolsVersion)` is replaced by `ToolsVersionLoader.Error.malformedToolsVersionSpecification(_ malformation: ToolsVersionSpecificationMalformation)`.\n \n `ToolsVersionLoader.split(_ bytes: ByteString) -> (versionSpecifier: String?, rest: [UInt8])` and `ToolsVersionLoader.regex` are together replaced by `ToolsVersionLoader.split(_ manifest: String) -> ManifestComponents`.\n \n * Source Breakages for Swift Packages\n \n The package manager now throws an error if a manifest file contains invalid UTF-8 byte sequences.\n \n\nSwift 4.2\n---------\n\n* [SE-0209]\n\n The `swiftLanguageVersions` property no longer takes its Swift language versions via\n a freeform Integer array; instead it should be passed as a new `SwiftVersion` enum\n array.\n\n* [SE-0208]\n\n The `Package` manifest now accepts a new type of target, `systemLibrary`. This\n deprecates \"system-module packages\" which are now to be included in the packages\n that require system-installed dependencies.\n\n* [SE-0201]\n\n Packages can now specify a dependency as `package(path: String)` to point to a\n path on the local filesystem which hosts a package. This will enable interconnected\n projects to be edited in parallel.\n\n* [#1604]\n\n The `generate-xcodeproj` has a new `--watch` option to automatically regenerate the Xcode project\n if changes are detected. This uses the\n [`watchman`](https://facebook.github.io/watchman/docs/install.html) tool to detect filesystem\n changes.\n\n* Scheme generation has been improved:\n * One scheme containing all regular and test targets of the root package.\n * One scheme per executable target containing the test targets whose dependencies\n intersect with the dependencies of the exectuable target.\n\n* [SR-6978]\n Packages which mix versions of the form `vX.X.X` with `Y.Y.Y` will now be parsed and\n ordered numerically.\n\n* [#1489]\n A simpler progress bar is now generated for \"dumb\" terminals.\n\n\nSwift 4.1\n---------\n\n* [#1485]\n Support has been added to automatically generate the `LinuxMain` files for testing on\n Linux systems. On a macOS system, run `swift test --generate-linuxmain`.\n\n* [SR-5918]\n `Package` manifests that include multiple products with the same name will now throw an\n error.\n\n\nSwift 4.0\n---------\n\n* The generated Xcode project creates a dummy target which provides\n autocompletion for the manifest files. The name of the dummy target is in\n format: `PackageDescription`.\n\n* `--specifier` option for `swift test` is now deprecated.\n Use `--filter` instead which supports regex.\n\n\nSwift 3.0\n---------\n\n* [SE-0135]\n\n The package manager now supports writing Swift 3.0 specific tags and\n manifests, in order to support future evolution of the formats used in both\n cases while still allowing the Swift 3.0 package manager to continue to\n function.\n\n* [SE-0129]\n\n Test modules now *must* be named with a `Tests` suffix (e.g.,\n `Foo/Tests/BarTests/BarTests.swift`). This name also defines the name of the\n Swift module, replacing the old `BarTestSuite` module name.\n\n* It is no longer necessary to run `swift build` before running `swift test` (it\n will always regenerates the build manifest when necessary). In addition, it\n now accepts (and requires) the same `-Xcc`, etc. options as are used with\n `swift build`.\n\n* The `Package` initializer now requires the `name:` parameter.\n\n[SE-0129]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0129-package-manager-test-naming-conventions.md\n[SE-0135]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0135-package-manager-support-for-differentiating-packages-by-swift-version.md\n[SE-0201]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0201-package-manager-local-dependencies.md\n[SE-0208]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0208-package-manager-system-library-targets.md\n[SE-0209]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0209-package-manager-swift-lang-version-update.md\n[SE-0272]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0272-swiftpm-binary-dependencies.md\n[SE-0292]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0292-package-registry-service.md\n[SE-0303]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md\n[SE-0332]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0332-swiftpm-command-plugins.md\n[SE-0339]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0339-module-aliasing-for-disambiguation.md\n[SE-0362]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0362-piecemeal-future-features.md\n[SE-0378]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0378-package-registry-auth.md\n[SE-0386]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0386-package-access-modifier.md\n[SE-0387]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md\n[SE-0391]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0391-package-registry-publish.md\n[SE-0387 proposal text]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0387-cross-compilation-destinations.md#swift-sdk-installation-and-configuration\n[SE-0458]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0458-strict-memory-safety.md\n[SR-5918]: https://bugs.swift.org/browse/SR-5918\n[SR-6978]: https://bugs.swift.org/browse/SR-6978\n[SR-13566]: https://bugs.swift.org/browse/SR-13566\n\n[#1485]: https://github.com/swiftlang/swift-package-manager/pull/1485\n[#1489]: https://github.com/swiftlang/swift-package-manager/pull/1489\n[#1604]: https://github.com/swiftlang/swift-package-manager/pull/1604\n[#2937]: https://github.com/swiftlang/swift-package-manager/pull/2937\n[#3280]: https://github.com/swiftlang/swift-package-manager/pull/3280\n[#3292]: https://github.com/swiftlang/swift-package-manager/pull/3292\n[#3310]: https://github.com/swiftlang/swift-package-manager/pull/3310\n[#3316]: https://github.com/swiftlang/swift-package-manager/pull/3316\n[#3410]: https://github.com/swiftlang/swift-package-manager/pull/3410\n[#3486]: https://github.com/swiftlang/swift-package-manager/pull/3486\n[#3641]: https://github.com/swiftlang/swift-package-manager/pull/3641\n[#3649]: https://github.com/swiftlang/swift-package-manager/pull/3649\n[#3670]: https://github.com/swiftlang/swift-package-manager/pull/3670\n[#3717]: https://github.com/swiftlang/swift-package-manager/pull/3717\n[#3890]: https://github.com/swiftlang/swift-package-manager/pull/3890\n[#3901]: https://github.com/swiftlang/swift-package-manager/pull/3901\n[#3942]: https://github.com/swiftlang/swift-package-manager/pull/3942\n[#4119]: https://github.com/swiftlang/swift-package-manager/pull/4119\n[#4131]: https://github.com/swiftlang/swift-package-manager/pull/4131\n[#4135]: https://github.com/swiftlang/swift-package-manager/pull/4135\n[#4168]: https://github.com/swiftlang/swift-package-manager/pull/4168\n[#5728]: https://github.com/swiftlang/swift-package-manager/pull/5728\n[#5810]: https://github.com/swiftlang/swift-package-manager/pull/5810\n[#5819]: https://github.com/swiftlang/swift-package-manager/pull/5819\n[#5874]: https://github.com/swiftlang/swift-package-manager/pull/5874\n[#5949]: https://github.com/swiftlang/swift-package-manager/pull/5949\n[#5892]: https://github.com/swiftlang/swift-package-manager/pull/5892\n[#5966]: https://github.com/swiftlang/swift-package-manager/pull/5966\n[#6060]: https://github.com/swiftlang/swift-package-manager/pull/6060\n[#6067]: https://github.com/swiftlang/swift-package-manager/pull/6067\n[#6111]: https://github.com/swiftlang/swift-package-manager/pull/6111\n[#6114]: https://github.com/swiftlang/swift-package-manager/pull/6114\n[#6144]: https://github.com/swiftlang/swift-package-manager/pull/6144\n[#6294]: https://github.com/swiftlang/swift-package-manager/pull/6294\n[#6185]: https://github.com/swiftlang/swift-package-manager/pull/6185\n[#6200]: https://github.com/swiftlang/swift-package-manager/pull/6200\n[#6276]: https://github.com/swiftlang/swift-package-manager/pull/6276\n[#6540]: https://github.com/swiftlang/swift-package-manager/pull/6540\n[#6663]: https://github.com/swiftlang/swift-package-manager/pull/6663\n[#7010]: https://github.com/swiftlang/swift-package-manager/pull/7010\n[#7101]: https://github.com/swiftlang/swift-package-manager/pull/7101\n[#7118]: https://github.com/swiftlang/swift-package-manager/pull/7118\n[#7201]: https://github.com/swiftlang/swift-package-manager/pull/7201\n[#7202]: https://github.com/swiftlang/swift-package-manager/pull/7202\n[#7507]: https://github.com/swiftlang/swift-package-manager/pull/7507\n[#7530]: https://github.com/swiftlang/swift-package-manager/pull/7530\n[#7535]: https://github.com/swiftlang/swift-package-manager/pull/7535\n[#7722]: https://github.com/swiftlang/swift-package-manager/pull/7722\n[#7741]: https://github.com/swiftlang/swift-package-manager/pull/7741\n[#7813]: https://github.com/swiftlang/swift-package-manager/pull/7813\n[#8301]: https://github.com/swiftlang/swift-package-manager/pull/8301\n[#8314]: https://github.com/swiftlang/swift-package-manager/pull/8314\n" }, { "path": "CMakeLists.txt", "content": "# This source file is part of the Swift open source project\n#\n# Copyright (c) 2014 - 2021 Apple Inc. and the Swift project authors\n# Licensed under Apache License v2.0 with Runtime Library Exception\n#\n# See http://swift.org/LICENSE.txt for license information\n# See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n\nif(POLICY CMP0091)\n cmake_policy(SET CMP0091 NEW)\nendif()\n\ncmake_minimum_required(VERSION 3.24)\n\nlist(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_SOURCE_DIR}/cmake/modules)\n\nproject(SwiftPM LANGUAGES C Swift)\n\noption(BUILD_SHARED_LIBS \"Build shared libraries by default\" YES)\noption(FIND_PM_DEPS \"Search for all external Package Manager dependencies\" YES)\noption(SwiftPM_ENABLE_RUNTIME \"Build the runtime\" YES)\n\nset(CMAKE_Swift_LANGUAGE_VERSION 5)\nset(CMAKE_Swift_MODULE_DIRECTORY ${CMAKE_BINARY_DIR}/swift)\nset(CMAKE_Swift_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY MultiThreadedDLL)\n\nset(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)\nset(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/lib)\nset(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR}/bin)\n\nset(CMAKE_MSVC_RUNTIME_LIBRARY MultiThreadedDLL)\nset(CMAKE_POSITION_INDEPENDENT_CODE ${BUILD_SHARED_LIBS})\n\nif(FIND_PM_DEPS)\n find_package(SwiftSystem CONFIG REQUIRED)\n find_package(TSC CONFIG REQUIRED)\n\n find_package(LLBuild CONFIG)\n if(NOT LLBuild_FOUND)\n find_package(LLBuild REQUIRED)\n endif()\n\n find_package(ArgumentParser CONFIG REQUIRED)\n find_package(SwiftDriver CONFIG REQUIRED)\n find_package(SwiftCollections CONFIG REQUIRED)\n find_package(SwiftASN1 CONFIG REQUIRED)\n find_package(SwiftCertificates CONFIG REQUIRED)\n find_package(SwiftCrypto CONFIG REQUIRED)\n find_package(SwiftToolsProtocols CONFIG REQUIRED)\n find_package(SwiftBuild CONFIG REQUIRED)\nendif()\n\nfind_package(dispatch QUIET)\nfind_package(Foundation QUIET)\nfind_package(SQLite3 REQUIRED)\n\n# Enable `package` modifier for the whole package.\nadd_compile_options(\"$<$:SHELL:-package-name swift_package_manager>\")\nif(CMAKE_SYSTEM_NAME STREQUAL FreeBSD)\n link_directories(/usr/local/lib)\nendif()\n\nadd_subdirectory(BuildSupport/SwiftSyntax)\nadd_subdirectory(Sources)\nadd_subdirectory(cmake/modules)\n" }, { "path": "CONTRIBUTING.md", "content": "# Contributing to Swift Package Manager\n\nThere are several types of contributions one can make. Bug fixes, documentation and enhancements that do not materially change the user facing semantics of Swift Package Manager should be submitted directly as PR.\n\nLarger changes that do materially change the semantics of Swift Package Manager (e.g. changes to the manifest format or behavior) are required to go through [Swift Evolution Process](https://github.com/swiftlang/swift-evolution/blob/main/process.md).\n\nTo see how previous evolution decisions for SwiftPM have been made and have some direction for the development of future features please check out the [Community Proposals](https://forums.swift.org/tag/packagemanager).\n\nFor more information about making contributions to the Swift project in general see [Swift Contribution Guide](https://swift.org/contributing/).\n\n## Reporting issues\n\nIssues are tracked using [SwiftPM GitHub Issue Tracker](https://github.com/swiftlang/swift-package-manager/issues).\n\nFill the following fields:\n\n* `Title`: A one line summary of the problem you're facing.\n* `Description`: The complete description of the problem. Be specific.\n* `Expected behavior`: How you expect SwiftPM to behave.\n* `Actual behavior` : What actually happens.\n* `Steps to reproduce`: Be specific, provide steps to reproduce the bug.\n* `Swift Package Manager version/commit hash` : With which version are you testing.\n* `Actual behavior` : What actually happens.\n* `Swift & OS version` : (output of `swift --version && uname -a`).\n\nPlease include a minimal example package which can reproduce the issue. The\nsample package can be attached with the report or you can include the URL of the\npackage hosted on places like GitHub.\nAlso, include the verbose logs by adding `--verbose` or `-v` after a subcommand.\nFor example:\n\n $ swift build --verbose\n $ swift package update --verbose\n\nIf the bug is with a generated Xcode project, include how the project was\ngenerated and the Xcode build log.\n\n## Setting up the development environment\n\nFirst, clone a copy of SwiftPM code from https://github.com/swiftlang/swift-package-manager.\n\nIf you are preparing to make a contribution you should fork the repository first and clone the fork which will make opening Pull Requests easier. See \"Creating Pull Requests\" section below.\n\nSwiftPM is typically built with a pre-existing version of SwiftPM present on the system, but there are multiple ways to setup your development environment:\n\n### Using Xcode (Easiest)\n\n1. Install Xcode from [https://developer.apple.com/xcode](https://developer.apple.com/xcode) (including betas!).\n2. Verify the expected version of Xcode was installed.\n3. Open SwiftPM's `Package.swift` manifest with Xcode.\n4. Use Xcode to inspect, edit, and build the code.\n5. Select the `SwiftPM-Package` scheme to run the tests from Xcode. Note that the `SwiftPM-Package`\nshould be built prior to running any other schemes. This is so the `PackageDescription` module can be\nbuilt and cached for use.\n\n### Using the Command Line\n\nIf you are using macOS and have Xcode installed, you can use Swift from the command line immediately.\n\nIf you are not using macOS or do not have Xcode installed, you need to download and install a toolchain.\n\n#### Installing a toolchain\n\n1. Download a toolchain from https://swift.org/download/\n2. Install it and verify the expected version of the toolchain was installed:\n\n**macOS**\n\n```bash\n$> export TOOLCHAINS=swift\n$> xcrun --find swift\n/Library/Developer/Toolchains/swift-latest.xctoolchain/usr/bin/swift\n$> swift package --version\nSwift Package Manager - Swift 5.3.0\n$> swift --version\nApple Swift version 5.3\n```\n\n**Linux**\n\n```bash\n$> export PATH=/path/to/swift-toolchain/usr/bin:\"${PATH}\"\n$> which swift\n/path/to/swift-toolchain/usr/bin/swift\n$> swift package --version\nSwift Package Manager - Swift 5.3.0\n$> swift --version\nApple Swift version 5.3\n```\n\nAlternatively, there are tools like [swiftly](https://github.com/swiftlang/swiftly) that can install and manage toolchains automatically. This repository has a file called `.swift-version` that will keep swiftly at the current recommended version of the toolchain for best results. The `swiftly install` command ensures that SwiftPM's in-use toolchain is installed on your system and ready for you to do your development work with the usual swift commands.\n\n```bash\nswiftly install\nswift build\nswift test\n```\n\n## Developing in the Linux devcontainer\n\nSwiftPM includes a devcontainer configuration that allows you to develop in a containerized environment with VS Code. This approach provides a consistent development environment with all necessary dependencies pre-installed, regardless of your host operating system.\n\n### Prerequisites\n\n1. Install [Visual Studio Code](https://code.visualstudio.com/)\n2. Install the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) for VS Code\n3. Install [Docker](https://www.docker.com/products/docker-desktop/) on your system\n\n### Opening the Project in a Container\n\n1. Clone the SwiftPM repository (if you haven't already)\n2. Open the SwiftPM folder in VS Code\n3. VS Code will detect the devcontainer configuration and prompt you to \"Reopen in Container\". Click this button to start building and opening the container\n - Alternatively, you can press `F1`, type \"Dev Containers: Reopen in Container\", and press Enter\n4. Wait for the container to build and initialize (this may take a few minutes the first time)\n\n### What's Included in the Dev Container\n\nThe SwiftPM devcontainer is based on the `swiftlang/swift:nightly-main` Docker image and includes:\n\n- Swift nightly build from the main branch\n- Git\n- Common development utilities\n- VS Code Swift extension for syntax highlighting and language support\n- Debugging support with LLDB\n\n### Building and Testing in the Container\n\nOnce you've opened the project in VS Code, choose `> Dev Containers: Build and Reopen in Container` from the command pallete. Once the container finishes building it will open and you can develop as if you are on Linux using VS Code.\n\nAll the commands described in the \"Local Development\" section below will work in the container environment.\n\n## Local Development\n\nWith a Swift toolchain installed and the SwiftPM code cloned, you are ready to make changes and test them locally.\n\n### Building\n\n```bash\n$> swift build\n```\n\nA successful build will create a `.build/` directory with the following approximate structure:\n\n```\nartifacts\ncheckouts\ndebug\nrepositories\nx86_64-apple-macosx\n```\n\nBinary artifacts are located in `x86_64-apple-macosx/` when building on macOS,\nor the equivalent on other architectures and operating systems.\n\nThese binaries can be used to test the code modification. For example, to test the `swift package init` and `swift build` commands from the new SwiftPM artifacts in `.build/`:\n\n```bash\n$> cd /tmp && mkdir hello && cd hello\n$> /path/to/swiftpm/.build/x86_64-apple-macosx/debug/swift-package init\n$> /path/to/swiftpm/.build/x86_64-apple-macosx/debug/swift-build\n```\n\n### Testing\n\n```bash\n$> swift test\n```\n\nto run a single test:\n\n```bash\n$> swift test --filter PackageGraphTests.DependencyResolverTests/testBasics\n```\n\nOr another example, to run tests for the test targets BuildTests and WorkspaceTests, but skip some test cases:\n\n```bash\n$> swift test --filter BuildTests --skip BuildPlanTests --filter WorkspaceTests --skip InitTests\n```\n\nTo run the performance tests, enable them with an ENV variable:\n\n```bash\n$> export TSC_ENABLE_PERF_TESTS=1\n$> swift test -c release --filter PerformanceTests\n```\n\n### The bootstrap script\n\nThe bootstrap script is designed for building SwiftPM on systems that do not have Xcode or a toolchain installed.\nIt is used on bare systems to bootstrap the Swift toolchain (including SwiftPM), and as such not typically used outside the Swift team.\n\nThe bootstrap script requires having [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/) installed.\nPlease refer to the [_Get Started_ guide](https://github.com/apple/swift/blob/main/docs/HowToGuides/GettingStarted.md#installing-dependencies) on the Swift project repository for installation instructions.\n\nClone the following repositories beside the SwiftPM directory:\n\n1. [swift-argument-parser] and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).\n\n For example, if the latest tag is 0.4.3:\n ```sh\n $> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3\n ```\n\n2. [swift-llbuild] as llbuild\n ```sh\n $> git clone https://github.com/apple/swift-llbuild llbuild\n ```\n > Note: Make sure the directory for llbuild is called \"llbuild\" and not \"swift-llbuild\".\n\n3. [swift-tools-support-core]\n ```sh\n $> git clone https://github.com/apple/swift-tools-support-core\n ```\n\n4. [swift-driver]\n ```sh\n $> git clone https://github.com/apple/swift-driver\n ```\n\n5. [swift-system] and check out tag with the [latest version](https://github.com/apple/swift-system/tags).\n\n For example, if the latest tag is 1.0.0:\n ```sh\n $> git clone https://github.com/apple/swift-system --branch 1.0.0\n ```\n\n6. [swift-collections] and check out tag with the [latest version](https://github.com/apple/swift-collections/tags).\n\n For example, if the latest tag is 1.0.1:\n ```sh\n $> git clone https://github.com/apple/swift-collections --branch 1.0.1\n ```\n\n7. [swift-crypto] and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).\n\n For example, if the latest tag is 2.3.0:\n ```sh\n $> git clone https://github.com/apple/swift-crypto --branch 2.3.0\n ```\n\n8. [swift-asn1]\n ```sh\n $> git clone https://github.com/apple/swift-asn1\n ```\n\n9. [swift-certificates]\n ```sh\n $> git clone https://github.com/apple/swift-certificates\n ```\n\n10. [swift-syntax]\n ```sh\n $> git clone https://github.com/swiftlang/swift-syntax\n ```\n\n11. [swift-toolchain-sqlite]\n ```sh\n $> git clone https://github.com/swiftlang/swift-toolchain-sqlite\n ```\n\n[swift-argument-parser]: https://github.com/apple/swift-argument-parser\n[swift-collections]: https://github.com/apple/swift-collections\n[swift-driver]: https://github.com/apple/swift-driver\n[swift-llbuild]: https://github.com/apple/swift-llbuild\n[swift-system]: https://github.com/apple/swift-system\n[swift-tools-support-core]: https://github.com/apple/swift-tools-support-core\n[swift-crypto]: https://github.com/apple/swift-crypto\n[swift-asn1]: https://github.com/apple/swift-asn1\n[swift-certificates]: https://github.com/apple/swift-certificates\n[swift-toolchain-sqlite]: https://github.com/swiftlang/swift-toolchain-sqlite\n[swift-syntax]: https://github.com/swiftlang/swift-syntax\n\n\n#### Building\n\n```bash\n$> Utilities/bootstrap build\n```\n\nSee \"Using the Command Line / Building\" section above for more information on how to test the new artifacts.\n\n#### Testing\n\n```bash\n$> Utilities/bootstrap test\n```\n\n## Working with Docker to build and test for Linux\n\nWhen developing on macOS and need to test on Linux, install\n[Docker](https://www.docker.com/products/docker-desktop) and\n[Docker compose](https://docs.docker.com/compose/install/) and\nuse the following docker compose commands:\n\nPrepare the underlying image with the selected Ubuntu and Swift versions:\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n build\n```\n\nStart an interactive shell session:\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n run --rm shell\n```\n\nBuild SwiftPM (using the pre-installed SwiftPM version).\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n run --rm build\n```\n\nTest SwiftPM (using the pre-installed SwiftPM version).\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n run --rm test\n```\n\nBuild SwiftPM using the bootstrap script:\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n run --rm bootstrap-build\n```\n\nTest SwiftPM using the bootstrap script:\n\n```bash\ndocker-compose \\\n -f Utilities/docker/docker-compose.yaml \\\n -f Utilities/docker/docker-compose...yaml \\\n run --rm bootstrap-test\n```\n\nNote there are several Linux and Swift versions options to choose from, e.g.:\n\n`docker-compose.1804.53.yaml` => Ubuntu 18.04, Swift 5.3\n\n`docker-compose.2004.54.yaml` => Ubuntu 20.04, Swift 5.4\n\n`docker-compose.2004.main.yaml` => Ubuntu 20.04, Swift nightly\n\n## Creating Pull Requests\n\n1. Fork: https://github.com/swiftlang/swift-package-manager\n2. Clone a working copy of your fork\n3. Create a new branch\n4. Make your code changes\n5. If a particular version of the Swift toolchain is needed then update the `.swift-version` file to that version (or use `swiftly use` to update it).\n6. Try to keep your changes (when possible) below 200 lines of code.\n7. We use [SwiftFormat](https://www.github.com/nicklockwood/SwiftFormat) to enforce code style. Please install and run SwiftFormat before submitting your PR, ideally isolating formatting changes only to code changed for the original goal of the PR. This will keep the PR diff smaller.\n8. Commit (include the Radar link or GitHub issue id in the commit message if possible and a description your changes). Try to have only 1 commit in your PR (but, of course, if you add changes that can be helpful to be kept aside from the previous commit, make a new commit for them).\n9. Push the commit / branch to your fork\n10. Make a PR from your fork / branch to `apple: main`\n11. While creating your PR, make sure to follow the PR Template providing information about the motivation and highlighting the changes.\n12. Reviewers are going to be automatically added to your PR\n13. Pull requests will be merged by the maintainers after it passes CI testing and receives approval from one or more reviewers. Merge timing may be impacted by release schedule considerations.\n\nBy submitting a pull request, you represent that you have the right to license\nyour contribution to Apple and the community, and agree by submitting the patch\nthat your contributions are licensed under the [Swift\nlicense](https://swift.org/LICENSE.txt).\n\nAfter a change is known not to cause regressions in the `main` branch, it may be considered for cherry-picking to the latest release branch depending on the release schedule. Cherry-picks require [a specific template to be followed](https://github.com/swiftlang/.github/blob/main/PULL_REQUEST_TEMPLATE/release.md) in PR description that consolidates information about the change necessary for inclusion in the release branch and provides risk evaluation for nominating the change.\n\n## Continuous Integration\n\nSwiftPM uses [swift-ci](https://ci.swift.org) infrastructure for its continuous integration testing. The bots can be triggered on pull-requests if you have commit access. Otherwise, ask one of the code owners to trigger them for you.\n\n\nThis is **required** before a pull-request can be merged.\n\n\nTo run just the self-hosted test suite (faster turnaround times so it can be used to get quick feedback) use:\n\n```\n@swift-ci please test self hosted\n```\n\nTo run the windows self-hosted suite, use:\n\n```\n@swift-ci please test self hosted windows\n```\n\nTo run the swift toolchain test suite including SwiftPM use:\n\n```\n@swift-ci please test\n```\n\nTo run the swift toolchain test suite against a specific platform use one of the following:\n\n```\n@swift-ci please test macos\n@swift-ci please test linux\n@swift-ci please test windows\n```\n\nTo run package compatibility test suite (validates we do not break 3rd party packages) use:\n\n```\n@swift-ci please test package compatibility\n```\n\n\n## Generating Documentation\n\nSwiftPM uses [DocC](https://github.com/apple/swift-docc) to generate some of its documentation (currently only the `PackageDescription` module). Documentation can be built using Xcode's GUI (Product → Build Documentation or `⌃⇧⌘D`) or manually:\n\n1. Build and dump the symbol graph metadata used to generate the documentation:\n\n```\nswift package dump-symbol-graph\n```\n\n2. Generate the documentation and start a local preview server to review your changes:\n\n```\nxcrun docc preview Sources/PackageDescription/PackageDescription.docc --additional-symbol-graph-dir .build/*/symbolgraph/\n```\n\nNote that this may generate documentation for multiple modules — the preview link for PackageDescription will typically be: http://localhost:8000/documentation/packagedescription\n\n## Advanced\n\n### Using Custom Swift Compilers\n\nSwiftPM needs the Swift compiler to parse `Package.swift` manifest files and to\ncompile Swift source files. You can use the `SWIFT_EXEC` and `SWIFT_EXEC_MANIFEST`\nenvironment variables to control which compiler to use for these operations.\n\n`SWIFT_EXEC_MANIFEST`: This variable controls which compiler to use for parsing\n`Package.swift` manifest files. The lookup order for the manifest compiler is:\n`SWIFT_EXEC_MANIFEST`, `swiftc` adjacent to the `swiftpm` binaries, then `SWIFT_EXEC`\n\n`SWIFT_EXEC`: This variable controls which compiler to use for compiling Swift\nsources. The lookup order for the sources' compiler is: `SWIFT_EXEC`, then `swiftc` adjacent\nto `swiftpm` binaries. This is also useful for Swift compiler developers when they\nwant to use a debug compiler with SwiftPM.\n\n```bash\n$> SWIFT_EXEC=/path/to/my/built/swiftc swift build\n```\n\n### Overriding the Path to the Runtime Libraries\n\nSwiftPM computes the path of its runtime libraries relative to where it is\ninstalled. This path can be overridden by setting the environment variable\n`SWIFTPM_CUSTOM_LIBS_DIR` to a directory containing the libraries, or a colon-separated list of\nabsolute search paths. SwiftPM will choose the first\npath which exists on disk. If none of the paths are present on disk, it will fall\nback to built-in computation.\n\n### Making changes in TSC targets\n\nSwiftPM uses [Tools Support Core](https://github.com/apple/swift-tools-support-core) (aka TSC) for many of its general purpose utilities. Changes in SwiftPM often require changes in TSC first. To coordinate changes, open a PR against TSC first, then a second one against SwiftPM pulling the correct TSC version.\n\n## Community and Support\n\nIf you want to connect with the Swift community you can:\n* Use Swift Forums: [https://forums.swift.org/c/development/SwiftPM](https://forums.swift.org/c/development/SwiftPM)\n* Contact the CODEOWNERS: https://github.com/swiftlang/swift-package-manager/blob/main/CODEOWNERS\n\n## Additional resources\n\n* `Swift.org` Contributing page\n[https://swift.org/contributing/](https://swift.org/contributing/)\n* License\n[https://swift.org/LICENSE.txt](https://swift.org/LICENSE.txt)\n* Code of Conduct\n[https://swift.org/community/#code-of-conduct](https://swift.org/community/#code-of-conduct)\n\n## Troubleshooting\n\n* If during `swift build` you encounter this error:\n```bash\n/../apple-repos/swift-package-manager/.build/checkouts/swift-driver/Sources/SwiftDriver/Explicit Module Builds/InterModuleDependencyGraph.swift:102:3: error: unknown attribute '_spi'\n @_spi(Testing) public var isFramework: Bool\n ^\n```\nMake sure you are using SwiftPM 5.3\n```bash\n$> swift package --version\nSwift Package Manager - Swift 5.3.0\n```\n* If during `swift build` you encounter this error:\n```bash\n/../swift-package-manager/Sources/PackageLoading/Target+PkgConfig.swift:84:36: error: type 'PkgConfigError' has no member 'prohibitedFlags'\n error = PkgConfigError.prohibitedFlags(filtered.unallowed.joined(separator: \", \"))\n ~~~~~~~~~~~~~~ ^~~~~~~~~~~~~~~\n```\nMake sure to update your TSC (Tools Support Core):\n```bash\n$> swift package update\n```\nAlternatively, if you are using Xcode, you can update to the latest version of all packages:\n**Xcode App** > *File* > *Swift Packages* > *Update to Latest Package Versions*\n" }, { "path": "CONTRIBUTORS.txt", "content": "For the purpose of tracking copyright, this is the list of individuals and\norganizations who have contributed to Swift Package Manager.\n\nFor employees of an organization/company where the copyright of work done\nby employees of that company is held by the company itself, only the company\nneeds to be listed here.\n\n## COPYRIGHT HOLDERS\n\n- Apple Inc. (all contributors with '@apple.com')\n\n### Contributors\n\n- 3405691582 \n- A Koufatzis \n- AG \n- Aaron Crespo \n- Abdulhakim Ajetunmobi \n- Adam Cox \n- Adam Thayer \n- Adam Yanalunas \n- Ahmad Yasser <42544598+ahmdyasser@users.noreply.github.com>\n- Alastair Houghton \n- Alejandro Alonso \n- Aleksei Sapitskii <45671572+aleksproger@users.noreply.github.com>\n- Aleksey Mashanov \n- Aleph Retamal \n- Alex Blewitt \n- Alex Hoppen \n- Alex Lorenz \n- Alex Migicovsky \n- Alexander Sandberg \n- Alexey Ivashko \n- Alexis Laferrière \n- Anders Bertelrud \n- Andreas Koslowski \n- Andrew Carter \n- Andrew Clark \n- Angelo Villegas \n- Anh Pham \n- Ankit Aggarwal \n- Anton \n- Anton Pogonets \n- Antonio Mayorga \n- Argyrios Kyrtzidis \n- Ariel Elkin <1756909+arielelkin@users.noreply.github.com>\n- Aris Sarris <78614622+a-sarris@users.noreply.github.com>\n- Arjun Nayini \n- Arnold Schwaighofer \n- Artem Chikin \n- Artemiy Sobolev \n- Arthur Ariel Sabintsev \n- Atul Sowani \n- Aura Lily Vulcano \n- Austin \n- BJ Homer \n- Bastian Rinsche \n- Ben Barham \n- Ben Chatelain \n- Ben Cohen \n- Ben Kennedy \n- Ben Langmuir \n- Ben Rimmington \n- Ben Waldie \n- BenedictSt <52418145+BenedictSt@users.noreply.github.com>\n- Benedikt Terhechte \n- Benjamin Herzog \n- Benjamin Scholtysik \n- Bhargav \n- Bhargav Gurlanka \n- Bob Flanagan <89808793+bflanagan-apple@users.noreply.github.com>\n- Bob Wilson \n- Boris Bielik \n- Boris Buegling \n- BossJue <240778488@qq.com>\n- Bouke Haarsma \n- Braden Scothern \n- Brandon Titus \n- Brent Royal-Gordon \n- Brian Croom \n- Brian Gesiak \n- Brian Pratt \n- Calvin Hill \n- Chris Lattner \n- Chris Willmore \n- Chris Zielinski \n- Christian Rishøj \n- Christopher Goulet \n- Clay Ellis \n- Colin Cornaby \n- Connor Wakamo \n- Conrad Kramer \n- Cory Benfield \n- Dadoum <24679280+Dadoum@users.noreply.github.com>\n- Damiaan Dufaux \n- Dan Liew \n- Dan Mendoza \n- Dan Zheng \n- Daniel Duan \n- Daniel Dunbar \n- Daniel Firsht \n- Daniel Rodríguez Troitiño \n- Danny Mösch \n- Dario Rexin \n- Dave Abrahams \n- Dave Weston \n- David Bryson \n- David Farler \n- David Hart \n- David M. Bryson \n- David Nadoba \n- David Ungar \n- Denis Morozov \n- Derik Ramirez \n- Diggory Laycock \n- Dima Hutsuliak \n- Ding Ye \n- Dmitri Gribenko \n- Dmitriy Borovikov \n- Dmytro Mishchenko \n- Doug Gregor \n- Drew Crawford \n- Ed Arenberg \n- Edan Lichtenstein \n- Edward Huynh \n- Edward Valentini \n- Egor Zhdan \n- Egor Zhdan \n- Eli Geller \n- Ellie Shin \n- Eric Dudiak \n- Eric Jensen \n- Eric Miotto <1094986+edymtt@users.noreply.github.com>\n- Erik Eckstein \n- Erwin Mazariegos \n- Etan1 \n- Euan Harris \n- Eugene Tulushev \n- Evan Wilde \n- Example Example \n- Fabian Cañas \n- Federico Bucchi \n- Federico Zanetello \n- Florian Friedrich \n- Florian Reinhart \n- Franz Busch \n- Gaushik M.R \n- Gavin Eadie \n- George \n- George Barnett \n- Glenn 'devalias' Grant \n- Grzegorz Miłoś \n- Guillermo Ignacio Enriquez Gutierrez \n- Gwen Mittertreiner \n- Harlan Haskins \n- Hayden McCabe \n- Helge Hess \n- Honza Dvorsky \n- Husein Kareem \n- Ian Partridge \n- Ilya Kulakov \n- Ismael Vilas Boas \n- Itai Ferber \n- Iulian Onofrei <5748627+revolter@users.noreply.github.com>\n- IxhenHasaniQM <94111216+IxhenHasaniQM@users.noreply.github.com>\n- J. Cheyo Jimenez \n- J.D. Healy \n- JP Simard \n- JPMartha \n- Jacob Bandes-Storch \n- Jacopo Andrea Giola \n- Jader Feijo \n- Jake Heiser \n- Jake Petroules \n- Jane Manchun Wong \n- Jason Choi \n- Jason R Tibbetts <708510+jrtibbetts@users.noreply.github.com>\n- Jason Wray \n- Jeff Kelley \n- Jeff Lett <2142301+jeffctown@users.noreply.github.com>\n- Jeremiah Njoroge \n- Jeremy David Giesbrecht \n- Jhonny Bill \n- Jimmy Arts \n- Jobins John \n- Joe Groff \n- Joe Heck \n- Joe Smith \n- Joe Susnick \n- Johannes Plunien \n- Johannes Weiss \n- John Holdsworth \n- John McCall \n- Jonas Schwartz \n- Jonathan Grynspan \n- Jordan Rose \n- Jose Marcelino \n- Joseph Heck \n- Josh Parnham \n- Joshua Emmons \n- Joshua Peek \n- Julian Grosshauser \n- Justas Brazauskas \n- Justin Jia \n- Justin Oroz \n- Justus Kandzi \n- Kaan Dedeoglu \n- Karl <5254025+karwa@users.noreply.github.com>\n- Karoy Lorentey \n- Kazumasa Wakamori \n- Keith Smiley \n- Kenta Kubo <601636+kkk669@users.noreply.github.com>\n- Kilian Koeltzsch \n- Kit Langton \n- Kohki Miki \n- Kostiantyn Koval \n- Kyle <43724855+Kyle-Ye@users.noreply.github.com>\n- Kyle \n- Kyle Jessup \n- Kyle Rokita \n- Lei Zhang \n- Lev Walkin \n- Lily Vulcano \n- Ling Wang \n- Liu Liu \n- Lukas Stabe \n- Luke Lau \n- MIZUNO Hiroki \n- Marcin Iwanicki \n- Marcin Krzyzanowski \n- Marco Eidinger \n- Marin Todorov \n- Mark Brownsword \n- Mark Lacey \n- Martin Waitz \n- Matt Diephouse \n- Matt Seaman \n- Matthew Seaman \n- Matthias Bartelmeß \n- Mattt Thompson \n- Max Desiatov \n- Max Desiatov \n- Max Howell \n- Max Liberman \n- Max Moiseev \n- Max Obermeier \n- Michael Gottesman \n- Michael Henson \n- Michael Ilseman \n- Michael McGuire \n- Michael Munday \n- Michael Vendivel \n- Miguel A. Perez Ojito <54909066+miggs597@users.noreply.github.com>\n- Miguel Salinas \n- Mike Ash \n- Mike Ferris \n- Mishal Awadah \n- Mishal Shah \n- Morten Bjerg Gregersen \n- Muhammed Yavuz Nuzumlali \n- Nate Cook \n- Nathan Hawes \n- Nathan Lanza \n- Natik Gadzhi \n- Neil Jones \n- Nicholas Maccharoli \n- Nick Cooke <36927374+ncooke3@users.noreply.github.com>\n- Nikola Lajic \n- Noah Gilmore \n- NobodyNada \n- Norio Nomura \n- Noé Froidevaux \n- Oliver Chick \n- Oliver Epper <45991777+oliverepper@users.noreply.github.com>\n- Orta \n- Ostap Taran \n- Owen Voorhees \n- P W \n- Patrick Balestra \n- Patrick Metcalfe \n- Paul Nettle \n- Paulo Faria \n- Pavel Yaskevich \n- Pedro José Pereira Vieito \n- Peteous \n- Peter Adams \n- Peter Matta \n- Philippe Hausler \n- Prachi \n- Pritesh Nandgaonkar \n- Quinn McHenry \n- Rahul Malik \n- Randy Becker <81446220+randy-becker@users.noreply.github.com>\n- Rauhul Varma \n- Renzo Crisóstomo \n- Rich Ellis \n- Rick Ballard \n- Rintaro Ishizaki \n- Ritwik Gupta \n- Robert Widmann \n- Romain Pouclet \n- Roman Levenstein \n- Ron Baker \n- Ron Olson \n- Runar \n- Runar Hummelsund \n- Ryan Lovelett \n- Ryan Wilson \n- Ryosuke Hayashi \n- Saleem Abdulrasool \n- Saleem Abdulrasool \n- Samuel Giddins \n- Sebastian Grail \n- Sergio Campamá \n- Sheikh Bayazid <44797746+sheikhbayazid@users.noreply.github.com>\n- Slava Pestov \n- Stan Stadelman \n- Stephen Brown \n- Stephen Celis \n- Steve Barron \n- Steve Moser \n- Steven Sherry \n- Stuart Montgomery \n- Sven A. Schmidt \n- Swiftfuchs \n- TaborKelly \n- Ted Kremenek \n- Thi \n- Thiago Holanda \n- Thomas Grapperon <35562418+tgrapperon@users.noreply.github.com>\n- Thomas Roughton \n- Thomas Van Lenten \n- Tiago Martinho \n- Tianyu Wang \n- Tim Condon <0xTim@users.noreply.github.com>\n- Tim Gymnich \n- Tobias Landsberg \n- Tokuriku \n- Tom Doron \n- Tomasz Bąk \n- Tomoya Kose \n- Toni Suter \n- Tony Arnold \n- Tony Parker \n- TornjV \n- Trevör Anne Denise \n- Tyler Stromberg \n- Török Zsolt \n- Vadim Eisenberg \n- Vadim Smal \n- Valeriy Van \n- Vasilica Costescu \n- Vatsal Manot \n- Viktor Szilárd Simkó \n- Vincent Esche \n- Vivian Kong \n- Vladislav Alekseev \n- WFT \n- Wang Binbin \n- William Dillon \n- William Entriken \n- Wojtek Czekalski \n- Wowbagger & his liquid lunch <55120045+WowbaggersLiquidLunch@users.noreply.github.com>\n- Xavier Matos \n- Xiaodi Wu <13952+xwu@users.noreply.github.com>\n- Xiaodi Wu \n- Xing He <17washabi@gmail.com>\n- YOCKOW \n- YOUNG MO SONG <77970826+mooyoung2309@users.noreply.github.com>\n- YR Chen \n- Yan Li \n- Yannick Heinrich \n- Yim Lee \n- Yonas Kolb \n- Yoshimasa Niwa \n- Yu Ao \n- Yu Su \n- YuAo \n- Yuta Koshizawa \n- Yuta Saito \n- Zsolt Kiraly \n- adamnemecek \n- aemino \n- akashhansda <99724223+akashhansda@users.noreply.github.com>\n- aniket sharma \n- badim \n- buttaface \n- dudiak \n- eeckstein \n- elsh \n- emlai \n- freak4pc \n- futbalguy \n- futurejones \n- gibachan \n- giginet \n- givip \n- goloveychuk \n- hotchemi \n- jhonnybillm \n- jp_pancake \n- k-kohey \n- linqingmo \n- naru \n- nate-chandler <46721658+nate-chandler@users.noreply.github.com>\n- nathan spindel \n- nonsensery \n- onevcat \n- pcbeard \n- prachipai \n- samding01 \n- sarveshtamba \n- seabaylea \n- sora0077 \n- swift-ci \n- swiftix \n- t_hayashi \n- thecb4 \n- twobitunicorn \n- uhooi \n- yonihemi \n- Łukasz Mróz \n- Šimon Javora \n- ✪ vi4m Marcin Kliks \n- 冀卓疌 <55120045+WowbaggersLiquidLunch@users.noreply.github.com>\n\n\n**Updating this list**\n\nPlease do not edit this file manually. It is generated using `./Utilities/generate_contributors_list.sh`. If a name is misspelled or appearing multiple times: add an entry in `./.mailmap`\n" }, { "path": "Documentation/Design/EvolutionIdeas.md", "content": "# Swift Package Manager Ideas\n\nThis is a list of some evolution ideas for the package manager. Once the details\nof an idea are fleshed out and there is a full proposal, it can be scheduled for\nthe Swift Evolution process. It is important to note that not every idea on this\nlist is guaranteed to become an official feature, and it all depends on where\nthe design discussion leads us. Also, this is not meant to be an exhaustive\nfeature list, if you have an idea for a feature that you think will be\na valuable addition to the package manager, feel free to start a discussion\nabout it.\n\nIf you're interested in participating in a particular evolution idea, please\nfamiliarize yourself with the existing discussion on that topic and start\nparticipating in the discussion thread of that idea. If a thread doesn't exist\nfor that idea, please start one with a [draft\nproposal](https://github.com/swiftlang/swift-evolution/blob/main/proposal-templates/0000-swiftpm-template.md)\nthat can be used as a starting point.\n\n**Important Note**: This list is not in any particular order. I plan to keep\nthis post updated, but please let me know if you see something out-of-date.\n\n## Mirror and Fork Support\n\nYou may want an easy way to mirror or fork specific packages in your package\ngraph. This could be useful if you want to make a private customization to\na package that you depend on, or even if you just want to override the origin\nrepository of your packages so that you can fetch from a private mirror and not\ndepend on the original repository always being there.\n\nThread: https://forums.swift.org/t/dependency-mirroring-and-forking/13902\nBug: [SR-679](https://bugs.swift.org/browse/SR-679)\n\n## Build Settings\n\nSome packages require specific language or linker flags that SwiftPM doesn’t\ncurrently support, and some packages may desire other configurable properties as\nwell. We want to have a real, robust \"build settings\" model for adding these\nkinds of properties, potentially including conditional settings and\nfine-grained control over what parts of the package use which property values.\n\nThread: N/A\nBug: [SR-3948](https://bugs.swift.org/browse/SR-3948)\n\n## Conditional Dependencies\n\nPackages may want to use dependencies that they only use while testing the\npackage. Such dependencies shouldn't take part in dependency resolution process\nwhen a package is being used as a dependency. This is also called test-only or\ndevelopment dependencies in other package managers. It is sometimes also\nrequired to declare platform-specific dependencies which should only be fetched\nwhen a package is being built for a certain platform. This is currently possible\nusing `#if os` checks, but it leads to two problems: 1) it forces\na non-declarative syntax in the manifest file, and 2) it causes issues in\nmaintaining the `Package.resolved` file as the dependency is added or removed\ndepending on the platform.\n\nThread: N/A\nBug: [SR-883](https://bugs.swift.org/browse/SR-883)\n\n## Resource Support\n\nThe Swift Package Manager needs a story for how packages should specify their\nresources to include with products.\n\nThread: N/A\nBug: [SR-2866](https://bugs.swift.org/browse/SR-2866)\n\n## Extensible Build Tools\n\nMany users want to incorporate a variety of build-time tools into their\npackages, whether to support a custom language or preprocessor, or to add their\nown documentation generator or linter. SwiftPM could add extensibility to\nsupport tools packages which could bring these steps to the build process. We\nexpect this behavior to greatly enhance our capacity for building complex\nsoftware packages.\n\nOne important thing for us to be careful about here is to make sure that all\nparts of the build process still clearly declare their inputs and outputs to\nSwiftPM, so that it can make sure that they behave correctly and perform well\nfor incremental and parallel builds.\n\nThread: https://forums.swift.org/t/package-manager-extensible-build-tools/10900\nBug: N/A\n\n## User-defined Template Support\n\nIt would be nice if users can hook into the init command to add custom templates\nthat they frequently use.\n\nThread: N/A\nBug: [SR-7837](https://bugs.swift.org/browse/SR-7837)\n\n## Documentation Generation Support\n\nWe can leverage SourceKit to extract documentation information from Swift\npackages that can be further transformed into a developer consumable format like\na static HTML website.\n\nThread: N/A\nBug: N/A\n\n## Tagging and Publishing Support\n\nToday you publish new versions of your package by tagging manually with Git, and\nyou use Git directly to view your published tags. SwiftPM could help automate\nthis process, performing any validation, housekeeping, or auxiliary tasks that\nmight make sense as part of a streamlined and safe publication workflow.\n\nThread: N/A\nBug: N/A\n\n## Install/Deploy Command\n\nWhen you’re deploying the product of your package, whether to a server or your\nlocal system, it could be helpful for SwiftPM to provide support for automating\nthat process. You may want to configure layout and library linkage aspects of\nyour products for your specific deployment environment, record version\ninformation about what your products were built from, and otherwise leverage the\ncontext that SwiftPM has about your packages for a seamless deployment\nexperience.\n\nThread: N/A\nBug: N/A\n\n## Performance Testing Support\n\nCurrently, SwiftPM has no support for running performance tests. We need to\nprovide a way to specify performance tests for a package and to run them from\nthe SwiftPM command-line tools.\n\n[Here](https://github.com/aciidb0mb3r/swift-evolution/blob/pref-proposal/proposals/xxxx-package-manager-performance-testing.md) is a very old draft proposal that I haven't gotten around to posting for discussion yet.\n\nThread: N/A\nBug: [SR-1354](https://bugs.swift.org/browse/SR-1354)\n\n## Support for External Testing Frameworks\n\nCurrently, SwiftPM only supports writing tests with help of the XCTest testing\nframework. The community should be able to use any testing framework of their\nchoice to test with SwiftPM. This feature will most likely depend on the proposed extensible\nbuild tools feature described [here](https://forums.swift.org/t/package-manager-extensible-build-tools/10900).\n\nThread: N/A\nBug: N/A\n\n## Package Index\n\nSwiftPM plans to have a real index for Swift packages some day. In addition to\ndefining a namespace for package names and providing easier package discovery,\nit could even support metrics for quality, such as automated test coverage\nstatistics, or ways to evaluate the trustworthiness of packages that you’re\nconsidering using. This will be a large project.\n\nThread: N/A\nBug: N/A\n\n## Multi-Package Repository Support\n\nCurrently the package manager requires that each package live at the root of\na Git repository. This means that you can't store multiple packages in the same\nrepository, or develop packages which locate each other in a filesystem-relative\nmanner without relying on Git. We need a proposal for how we would like to\nsupport this.\n\nThread: N/A\nBug: [SR-3951](https://bugs.swift.org/browse/SR-3951)\n\n## Cross-platform Sandboxing\n\nSandboxing is one way to help prevent `Package.swift` manifest evaluation and\nbuilds from escaping out into your system, either accidentally or deliberately.\nSwiftPM uses macOS's sandboxing technology already, but it would be great to\nbring this safety to other platforms.\n\nThread: N/A\nBug: N/A\n\n## Automatic Semantic Versioning\n\nAutomatically detecting what semantic version it looks like you should be\npublishing your changes with could be very helpful for package authors. SwiftPM\ncould do this by analyzing the source code's API to see what has changed and\nwhether the API is backwards-compatible, at least at compile time.\n\nThread: N/A\nBug: N/A\n\n## Machine-Editable Package.swift\n\nWe need an easy way to edit the Package.swift manifest from automated tools, for\ncases where you don't want users to have to update the Swift code directly. We\nthink that it's possible to provide an API to allow this, probably using\n[`SwiftSyntax`](https://github.com/swiftlang/swift-syntax).\n\nThread: N/A\nBug: N/A\n" }, { "path": "Documentation/Design/README.md", "content": "# Swift Package Manager Design Docs\n\nSwift Package Manager design is done in open source, and governed by Swift Evolution process.\nAs such, you can find up-to-date Swift Package Manager design docs [in the Swift Evolution repository](https://github.com/swiftlang/swift-evolution/tree/main/proposals).\n\nThis directory contains documentation on the engineering design decisions and internals of the Swift Package Manager, outside the evolution process.\n" }, { "path": "Documentation/Design/SwiftBasedManifestFormat.md", "content": "# Swift-based Manifest Format\n\n> **PLEASE NOTE** This document represents the initial proposal for Swift Package Manager, and is provided for historical purposes only. It does not represent the current state or future direction of the project. For current documentation, see the main Swift Package Manager [documentation](../README.md).\n\n## Purpose\n\nWe need to have some facility for describing additional package metadata, outside of the content in the sources files. This document describes a proposal for using a Swift-based format for this manifest data.\n\n\n## Motivation\n\nThe package manager strives to support a \"convention based\" project structure which is derived from the project files and source code. This approach allows users to primarily focus on authoring their actual software and expect that the tools will assemble it into a product by following sensible defaults.\n\nHowever, packages also have information which cannot naturally be inferred from the project structure. To that end, we need to support some kind of manifest which contains the additional project information.\n\nAt a high level, the primary purpose of this manifest is to:\n\n* Complement the convention based system.\n\n The manifest complements the convention based system, by being the one definitive place to add any project metadata that would otherwise require the project to use a custom configuration. The goal is that 80%+ of projects should be able to use only a manifest and the convention based layout.\n\n By allowing the manifest to extend and override a few key, carefully picked details of the convention based system, then we allow many more projects to use the system without needing to define complex conventions.\n\n* Provide package information in a standard format.\n\n There are certain pieces of information which are important enough and common enough that we would like all projects to include, or any projects which do include them to do so in a standardized manner. For example, the license declaration of a project should follow a very standard definition.\n\n* Serve as an indicator of a package manager project.\n\n Although it is simple, having the manifest exist with a known name at the root of a package serves as an indicator to developers and tools of the type of project and how they are expected to interact with it.\n\n* Provide support for programmatic analysis and editing of project structure.\n\n The manifest should be machine readable and writeable format. We envision a variety of tools that may want to inspect the contents of packages (for example, to build information for an index) or make automatic edits to the project structure. For example, when introducing a new library dependency via adding an import statement, we would like it if a tool could, after a user prompt, automatically update the manifest to specify the new dependency.\n\n\n## Proposal\n\nWe propose to use the Swift language itself to write the manifest. An example of a proposed manifest for a small cross-platform project with several libraries might look something like this:\n\n```swift\n// This imports the API for declaring packages.\nimport PackageDescription\n\n// This declares the package.\nlet package = Package(\n // The name of the package (defaults to source root directory name).\n name: \"Foo\",\n\n // The list of targets in the package.\n targets: [\n // Declares the main application.\n Target(\n name: \"Foo\",\n // Declare the type of application.\n type: .Tool,\n // Declare that this target is a published product of the package\n // (as opposed to an internal library or tool).\n published: true),\n\n // Add information on a support library \"CoreFoo\" (as found by the\n // convention based system in CoreFoo/**/*.swift).\n Target(\n name: \"CoreFoo\",\n depends: [\n // The library always depends on the \"Utils\" target.\n \"Utils\",\n\n // This library depends on \"AccessibilityUtils\" on Linux.\n .Conditional(name: \"AccessibilityUtils\", platforms: [.Linux])\n ]),\n\n // NOTE: There is a \"Utils\" target inferred by the convention based\n // system, but we don't need to modify it at all because the defaults\n // were fine.\n\n // Declare that the \"AccessibilityUtils\" target is Linux-specific.\n Target(name: \"AccessibilityUtils\", platforms: [.Linux])\n\t])\n```\n\n*NOTE: this example is for expository purposes, the exact APIs are subject to change.*\n\nBy writing the manifest in Swift, we ensure a consistent development experience across not only authoring their source code, but also their project metadata. This means developers will have a consistent environment with all of the development conveniences they expect: syntax coloring, code completion, API documentation, and formatting tools. This also ensures that new developers to Swift can focus on learning the language and its tools, not another custom package description format.\n\nThe package description itself is a declarative definition of information which *augments* the convention based system. The actual package definition that will be used for a project consists of the convention based package definition with the package description applied to override or customize default behaviors. For example, this target description:\n\n```swift\nTarget(name: \"AccessibilityUtils\", platforms: [.Linux])\n```\n\n*does not* add a new target. Rather, it modifies the existing target `AccessibilityUtils` to specify what platforms it is available for.\n\n\n## Customization\n\nWe intend for the declaration package definition to cover 80%+ of the use cases for modifying the convention based system. Nevertheless, there are some kinds of legitimate project structures which are difficult or cumbersome to encode in a purely declarative model. For example, designing a general purpose mechanism to cover all the ways in which users may wish to divide their source code is difficult.\n\nInstead, we allow users to interact with the `Package` object using its native Swift APIs. The package declaration in a file may be followed by additional code which configures the package using a natural, imperative, Swifty API. For example, this is an example of a project which uses a custom convention for selecting which files build with unchecked optimizations:\n\n```swift\nimport PackageDescription\n\nlet package = Package(name: \"FTW\")\n\n// MARK: Custom Configuration\n\n// Build all *_unchecked.swift files using \"-Ounchecked\" for Release mode.\nfor target in package.targets {\n for source in target.sources {\n if source.path.hasSuffix(\"_unchecked.swift\") {\n source.customFlags += [.Conditional(\"-Ounchecked\", mode: .Release)\n }\n }\n}\n```\n\nIt is important to note that even when using this feature, package manifest still **must be** declarative. That is, the only output of a manifest is a complete description of the package, which is then operated on by the package manager and build tools. For example, a manifest **must not** attempt to do anything to directly interact with the build output. All such interactions must go through a documented, public API vended by the package manager libraries and surfaced via the package manager tools.\n\n\n## Editor Support\n\nThe package definition format being written in Swift is problematic for tools that wish to perform automatic updates to the file (for example, in response to a user action, or to bind to a user interface), or for situations where dealing with executable code is problematic.\n\nTo that end, the declarative package specification portion of the file is \"Swift\" in the same sense that \"JSON is Javascript\". The syntax itself is valid, executable, Swift but the tools that process it will only accept a restricted, declarative, subset of Swift which can be statically evaluated, and which can be unambiguously, automatically rewritten by editing tools. We do not intend to define a \"standard\" syntax for \"Swift Object Notation\", but we intend to accept a natural restriction of the language which only accepts literal expressions. We do intend to allow the restricted subset to take full advantage of Swift's rich type inference and literal convertible design to allow for a succinct, readable, and yet expressive syntax.\n\nThe customization section above will *not* be written in this syntax. Instead, the customization section will be clearly demarcated in the file. The leading file section up to the first '// MARK:' will be processed as part of the restricted declarative specification. All subsequent code **must be** honored by tools which only need to consume the output of the specification, and **should be** displayed by tools which present an editor view of the manifest, but **should not** be automatically modified. The semantics of the APIs will be specifically designed to accommodate the expected use case of editor support for the primary data with custom project-specific logic for special cases.\n\nAll tools which process the package manifest **must** validate that the declaration portion of the specification fits into the restricted language subset, to ensure a consistent user experience.\n\n\n## Implementation\n\nWe need to have efficient, programmatic access to the data from the manifest for use in the package manager and associated tools. Additionally, we may wish to use this data in contexts where the executable-code nature of the manifest format is problematic. On the other hand, we also want the file format to properly match the Swift language.\n\nTo satisfy these two goals, we intend to extract the package metadata from the manifest file by using the Swift parser **and** type checker to parse the leading package declaration portion of the file (not including any customizations made subsequent to the package definition). Once type checked, we will then validate the AST produced for the package description using custom logic which validates that the AST can (a) be parsed into validate model objects without needing to execute code, and (b) is written following the strict format such that it can be automatically modified by editing tools.\n\nTools that do not need to be as strict with the manifest format will be able to load it by using Swift directly to execute the file and then interact with the package definition API to extract the constructed model.\n\n\n## Discussion\n\nWe decided to use a Swift-based format for the manifest because we believe it gives developers the best experience for working with and describing their project. The primary alternative we considered was to use a declarative format encoded in a common data format like JSON. Although that would simplify implementation of the tooling around the manifest, it has the downside that users must then learn this additional language, and the development of high quality tools for that (documentation, syntax coloring, parsing diagnostics) isn't aligned with our goal of building great tools for Swift. In contrast, using the Swift language means that we can leverage all of the work on Swift to make those tools great.\n\nThe decision to use a restricted subset of Swift for the primary package definition is because we believe it is important that common tasks which require the manifest be able to be automated or surfaced via a user interface.\n\nWe decided to allow additional customization of the package via imperative code because we do not anticipate that the convention based system will be able to cover all possible uses cases. When users need to accommodate special cases, we want them to be able to do so using the most natural and expression medium, by writing Swift code. By explicitly designing in a customization system, we believe we will be able to deliver a higher quality set of core conventions -- there is an escape hatch for the special cases that allows us to focus on only delivering conventions (and core APIs) for the things that truly merit it.\n\nA common problem with systems that permit arbitrary customization (especially via a programmatic interface) is that they become difficult to maintain and evolve, since it is hard to predict how developers have taken advantage of the interface. We deal with this by requiring that the manifest only interact with the package and tools through a strict, well defined API. That is, even though we allow developers to write arbitrary code to construct their package, we do not allow arbitrary interactions with the build process. Viewed a different way, the output of *all* manifests **must be** able to be treated as a single declaration specification -- even if part of that specification was programmatically generated.\n" }, { "path": "Documentation/PackageRegistry/PackageRegistryUsage.md", "content": "# Package Registry Usage\n\n## Table of Contents\n\n * [Getting Started](#getting-started)\n + [Configuring a registry](#configuring-a-registry)\n + [Adding a registry package dependency](#adding-a-registry-package-dependency)\n + [Registry authentication](#registry-authentication)\n * [Dependency Resolution Using Registry](#dependency-resolution-using-registry)\n + [Using registry for source control dependencies](#using-registry-for-source-control-dependencies)\n * [Dependency Download From Registry](#dependency-download-from-registry)\n + [Checksum TOFU](#checksum-tofu)\n + [Validating signed packages](#validating-signed-packages)\n - [Trusted vs. untrusted certificate](#trusted-vs-untrusted-certificate)\n - [Certificate policies](#certificate-policies)\n - [Publisher TOFU](#publisher-tofu)\n * [Publishing to Registry](#publishing-to-registry)\n + [Package release metadata](#package-release-metadata)\n + [Package signing](#package-signing)\n - [Signature formats](#signature-formats)\n - [Signed contents](#signed-contents)\n * [Source archive](#source-archive)\n * [Package release metadata](#package-release-metadata-1)\n * [Package manifest(s)](#package-manifest-s-)\n * [SwiftPM Registry Configuration](#swiftpm-registry-configuration)\n + [Registry-to-scope mappings](#registry-to-scope-mappings)\n - [`swift package-registry set` subcommand](#-swift-package-registry-set--subcommand)\n + [Security configuration](#security-configuration)\n\n## Getting Started\n\nSwiftPM supports downloading dependencies from any package registry that implements \n[SE-0292](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0292-package-registry-service.md)\nand the corresponding [service specification](Registry.md). \n\nIn a registry, packages are identified by [package identifier](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0292-package-registry-service.md#package-identity)\nin the form of `scope.package-name`.\n\n### Configuring a registry\n\nA registry can be configured in SwiftPM at two levels:\n - Project: the registry will be used for packages within the project. Settings are stored in `.swiftpm/configuration/registries.json`.\n - User: the registry will be used for all projects for the user. Settings are stored in `~/.swiftpm/configuration/registries.json`.\n\nOne could use the [`swift package-registry set` subcommand](#swift-package-registry-set-subcommand) \nto assign a registry URL:\n\n```bash\n$ swift package-registry set https://packages.example.com \n```\n\nThe above sets registry to `https://packages.example.com` at project level. Pass \nthe `--global` option to set registry at user level:\n\n```bash\n$ swift package-registry set --global https://packages.example.com \n```\n\nThe resulting `registries.json` would look something like:\n\n```json\n{\n \"registries\" : {\n \"[default]\" : {\n \"url\": \"https://packages.example.com\"\n } \n },\n \"version\" : 1\n}\n```\n\nThe JSON key `[default]` means that the registry at `https://packages.example.com` is \n\"unscoped\" and will be applied when there is no registry association found for \na given scope. \n\nIn this example, `https://packages.example.com` will be applied to all scopes.\n\n### Adding a registry package dependency\n\nA registry package dependency is declared in `Package.swift` using the\npackage identifier. For example: \n\n```swift\ndependencies: [\n .package(id: \"mona.LinkedList\", .upToNextMajor(from: \"1.0.0\")),\n],\n```\n\nSwiftPM will query the registry mapped to a package's scope to \nresolve and download the appropriate release version. \n\n### Registry authentication\n\nIf a registry requires authentication, it can be set up by using the \n[`swift package-registry login` subcommand](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0378-package-registry-auth.md#new-login-subcommand)\nintroduced by SE-0378:\n\n```bash\n$ swift package-registry login\nOVERVIEW: Log in to a registry\n\nUSAGE: swift package-registry login [] [--username ] [--password ] [--token ] [--no-confirm]\n\nARGUMENTS:\n The registry URL\n\nOPTIONS:\n --username Username\n --password Password\n --token Access token\n --no-confirm Allow writing to netrc file without confirmation\n```\n\nCurrently, basic and token authentication are supported.\n\nProvide the credentials either by setting the corresponding options\n(i.e., one of username/password or access token) or when prompted:\n\n```bash\n$ swift package-registry login https://packages.example.com\n```\n\nSwiftPM will save the credentials to the operating system's credential store\n(e.g., Keychain in macOS) or netrc file (which by default is located at `~/.netrc`) \nand apply them automatically when making registry API requests.\n\n## Dependency Resolution Using Registry\n\nResolving a registry dependency involves these steps:\n1. Fetch a package's available versions by calling the [list package releases](Registry.md#41-list-package-releases) API.\n2. Compute the dependency graph by [fetching manifest(s) for a package release](Registry.md#43-fetch-manifest-for-a-package-release).\n3. Pinpoint the package version to use.\n\n### Using registry for source control dependencies \n\nHere is an example of a source control dependency:\n\n```swift\ndependencies: [\n .package(url: \"https://github.com/mona/LinkedList\", .upToNextMajor(from: \"1.0.0\")),\n],\n```\n\nRegistry can be used for source control dependencies as well. This is \nparticularly useful when there is a \"mixed\" graph (i.e., a dependency \ngraph that has both source control and registry dependencies). SwiftPM\nconsiders packages with different origins to be different, so if a\npackage is referenced as both a registry (e.g., `mona.LinkedList`) and\nsource control (e.g., `https://github.com/mona/LinkedList`) dependency,\nthey are considered different even though they are the same package,\nand would result in symbol clashes.\n\nSwiftPM can deduplicate packages by performing a \n[lookup on the source control URL](Registry.md#endpoint-5)\n(e.g., `https://github.com/mona/LinkedList`) to see if it is associated with \nany package identifier (e.g., `mona.LinkedList`).\n\nOne can control if/how SwiftPM should use registry in conjunction with \nsource control dependencies by setting one of these flags:\n- `--disable-scm-to-registry-transformation` (default): SwiftPM will not transform source control dependency to registry dependency. Source control dependency will be downloaded from its corresponding URL, while registry dependency will be resolved and downloaded using the configured registry (if any).\n- `--use-registry-identity-for-scm`: SwiftPM will look up source control dependencies in the registry and use their registry identity whenever possible to help deduplicate packages across the two origins. In other words, suppose `mona.LinkedList` is the package identifier for `https://github.com/mona/LinkedList`, then SwiftPM will treat both references in the dependency graph as the same package. \n- `--replace-scm-with-registry`: SwiftPM will look up source control dependencies in the registry and use the registry to retrieve them instead of source control when possible. In other words, SwiftPM will attempt to download a source control dependency from the registry first, and fall back to cloning the source repository iff the dependency is not found in the registry.\n\n## Dependency Download From Registry\n\nAfter a registry dependency is resolved, SwiftPM can\n[download source archive](Registry.md#endpoint-4)\nof the computed package version from the registry.\n\n### Checksum TOFU \n\nSwiftPM performs checksum TOFU \n([trust-on-first-use](https://en.wikipedia.org/wiki/Trust_on_first_use)) \non the downloaded source archive. If the archive is downloaded\nfor the first time, SwiftPM \n[fetches metadata of the package release](Registry.md#endpoint-2)\nto obtain the expected checksum. Otherwise, SwiftPM\ncompares the checksum with that in local storage (`~/.swiftpm/security/fingerprints/`)\nsaved from previous download.\n\nIf checksum of the downloaded archive doesn't match the expected\nor previous value, SwiftPM will fail the build. This can be\ntuned down from error to warning by setting the build option \n`--resolver-fingerprint-checking` to `warn` (default is `strict`).\n\nChecksum TOFU is also done for manifests downloaded from registry. \n\n### Validating signed packages\n\n[SE-0391](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0391-package-registry-publish.md#package-signing)\nadds package signing support to SwiftPM. SwiftPM determines if\na downloaded archive is signed by checking for presence of the\n`X-Swift-Package-Signature-Format` and `X-Swift-Package-Signature`\nheaders in the HTTP response.\n\nSwiftPM then performs a series of validations based on user's\n[security configuration](#security-configuration).\n- If the archive is unsigned, SwiftPM will error/prompt/warn/allow \nbased on the `signing.onUnsigned` configuration. \n- If the archive is signed, SwiftPM will validate the signature and\nthe signing certificate chain. (see the following sections for details)\n\n#### Trusted vs. untrusted certificate\n\nA certificate is trusted if it is chained to any root in SwiftPM's \ntrust store, which consists of:\n- SwiftPM's default trust store, if `signing.includeDefaultTrustedRootCertificates` is `true`.\n- Custom root(s) in the configured trusted roots directory at `signing.trustedRootCertificatesPath`. Certificates must be DER-encoded.\n\nOtherwise, a certificate is untrusted and handled according to the \n`signing.onUntrustedCertificate` configuration. If user opts to\ncontinue with the untrusted certificate, SwiftPM will proceed with\nthe archive as if it were an unsigned package.\n\n#### Certificate policies\n\nSwiftPM requires all certificates used for package signing to have \nthe \"code signing\" extended key usage extension. They must also \nsatisfy the core policies from \n[RFC 5280](https://www.rfc-editor.org/rfc/rfc5280), as implemented\nby [swift-certificates](https://github.com/apple/swift-certificates). \n\nUser can configure certificate expiry and revocation check \nthrough the `signing.validationChecks.certificateExpiration` \nand `signing.validationChecks.certificateRevocation` configuration,\nrespectively. Note that revocation check implicitly requires\nexpiry check.\n \nAn invalid signing certificate would result in SwiftPM rejecting\nthe archive.\n\n#### Publisher TOFU\n\nSome certificates allow SwiftPM to extract additional information \nabout the signing identity. For packages signed with these certificates, \nSwiftPM will perform publisher TOFU to ensure the signer remains the \nsame across all versions of the package. \n\nThe `--resolver-signing-entity-checking` option controls whether publisher \nmismatch should result in a warning (`warn`) or error (`strict`). \nData used by publisher TOFU is saved to `~/.swiftpm/security/signing-entities/`.\n\n## Publishing to Registry\n\n[`swift package-registry publish`](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0391-package-registry-publish.md#new-package-registry-publish-subcommand)\nis an all-in-one command for publishing a package release to registry:\n\n```bash\nOVERVIEW: Publish to a registry\n\nUSAGE: swift package-registry publish [--url ] [--scratch-directory ] [--metadata-path ] [--signing-identity ] [--private-key-path ] [--cert-chain-paths ...] [--dry-run]\n\nARGUMENTS:\n The package identifier.\n The package release version being created.\n\nOPTIONS:\n --url, --registry-url \n The registry URL.\n --scratch-directory \n The path of the directory where working file(s) will be written.\n --metadata-path \n The path to the package metadata JSON file if it is not 'package-metadata.json' in the package directory.\n --signing-identity \n The label of the signing identity to be retrieved from the system's identity store if supported.\n --private-key-path \n The path to the certificate's PKCS#8 private key (DER-encoded).\n --cert-chain-paths \n Path(s) to the signing certificate (DER-encoded) and optionally the rest of the certificate chain. Certificates\n should be ordered with the leaf first and the root last.\n --dry-run Dry run only; prepare the archive and sign it but do not publish to the registry.\n```\n \nThe command creates source archive for the package release,\noptionally signs the package release, and \n[publishes the package release](Registry.md#endpoint-6)\nto the registry.\n\nIf authentication is required for package publication, \npackage author should [configure registry login](#registry-authentication)\nbefore running `publish`.\n\n### Package release metadata\n\nPackage author can specify a custom location of the package \nrelease metadata file by setting the `--metadata-path` option \nof the `publish` subcommand. Otherwise, by default SwiftPM \nlooks for a file named `package-metadata.json` in the \npackage directory.\n\nContents of the metadata file must conform to the \n[JSON schema](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0391-package-registry-publish.md#package-release-metadata-standards)\ndefined in SE-0391. Also refer to registry documentation \nfor any additional requirements.\n \n### Package signing\n\nA registry may support or require signing. To sign a package\nrelease, package author will need to set either the `signing-identity`\n(for reading from operating system's identity store such as Keychain in macOS),\nor `private-key-path` and `cert-chain-paths` (for reading from files)\noptions of the `publish` subcommand such that SwiftPM can\nlocate the signing key and certificate.\n\nIf the certificate chain's root and intermediates are known by SwiftPM,\nthen package author would only need to provide the leaf signing\ncertificate in `cert-chain-paths`. \n\nOtherwise, the entire certificate chain should be provided as \n`cert-chain-paths` so that all of the certificates will be \nincluded in the signature and make it possible for SwiftPM \nto reconstruct the certificate chain for validation later. \nThis is applicable to `signing-identity` as well \n(i.e., `signing-identity` can be used in combination with \n`cert-chain-paths` to provide the entire certificate chain).\n\nIf the root of the signing certificate is not in SwiftPM's\ndefault trust store, package author is responsible for \ntelling package users to include the root certificate in their local \n[trust roots](#trusted-vs-untrusted-certificate) \ndirectory, or else [signature validation](#validating-signed-packages) \nmay fail upon download because the signing certificate is not trusted.\n\nRefer to registry documentation for its certificate policy.\n\n#### Signature formats\n\n| Signature Format | Specification |\n| ---------------- | ------------- |\n| `cms-1.0.0` | [SE-391](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0391-package-registry-publish.md#package-signature-format-cms-100) |\n\nSince there is only one supported signature format, all\nsignatures produced by SwiftPM are in `cms-1.0.0`.\n\n#### Signed contents\n\n##### Source archive\n\nThe signature is detached and sent as part of the HTTP request to the\npublish API. It is included in the source archive download response as\nHTTP headers, and is part of the package release metadata.\n\n##### Package release metadata\n\nThe signature is detached and sent as part of the HTTP request to the\npublish API. The current API specification does not include an endpoint\nfor fetching this metadata in its original form.\n\n##### Package manifest(s)\n\n`Package.swift` and version-specific manifests are individually signed.\nThe signature is embedded in the corresponding manifest file. The source\narchive is generated and signed **after** manifest signing. \n\n```swift\n// swift-tools-version: 5.7\n\nimport PackageDescription\nlet package = Package(\n name: \"library\",\n products: [ .library(name: \"library\", targets: [\"library\"]) ],\n targets: [ .target(name: \"library\") ]\n)\n\n// signature: cms-1.0.0;l1TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw==\n```\n\nWhen a manifest is fetched from the registry, SwiftPM checks if the\ncontaining source archive is signed by fetching the package release \nmetadata. It is a failure if the source archive is signed but the \nmanifest is not. SwiftPM will extract and parse signature from \nthe manifest then validate it similar to what is done for \n[source archive signature](#validating-signed-packages).\n\nSwiftPM performs publisher TOFU to ensure it remains consistent\nfor the package. This implies the signer of manifests and source\narchive must be the same.\n\nTo reduce the amount of logging and thus noise, diagnostics related \nto manifest signature validation are set to DEBUG level. Only when \nuser chooses the `prompt` option for unsigned packages or packages \nsigned with an untrusted certificate would SwiftPM behave like \nsource archive validation. \n\n## SwiftPM Registry Configuration\n\n### Registry-to-scope mappings\n\nWhen resolving or downloading registry packages, SwiftPM looks at the\nregistry-to-scope mappings in project and user-level configuration to\ndetermine which registry is assigned for a package's scope.\n\nFor example, given the following configuration files:\n\n```json\n// User-level configuration (~/.swiftpm/configuration/registries.json)\n{\n \"registries\": {\n \"[default]\": {\n \"url\": \"https://global.example.com\"\n },\n \"foo\": {\n \"url\": \"https://global.example.com\"\n },\n },\n \"version\": 1\n}\n\n// Local configuration (.swiftpm/configuration/registries.json)\n{\n \"registries\": {\n \"foo\": {\n \"url\": \"https://local.example.com\"\n }\n },\n \"version\": 1\n}\n```\n\n- For package `foo.LinkedList`, the registry at `https://local.example.com` is used. (Local configuration has higher precedence than user-level configuration.)\n- For package `bar.LinkedList`, the registry at `https://global.example.com` is used. (No mapping for scope `bar` is found, so `[default]` is used.)\n\n#### `swift package-registry set` subcommand\n\n```bash\n$ swift package-registry set \nOVERVIEW: Set a custom registry\n\nUSAGE: swift package-registry set [--global] [--scope ] \n\nARGUMENTS:\n The registry URL\n\nOPTIONS:\n --global Apply settings to all projects for this user\n --scope Associate the registry with a given scope\n```\n\nThis subcommand is used to assign registry at project or user-level:\n\n```bash\n# project-level\n$ swift package-registry set https://packages.example.com \n\n# user-level\n$ swift package-registry set --global https://global.example.com \n```\n\nFor a specific scope:\n\n```bash\n# project-level\n$ swift package-registry set --scope foo https://local.example.com\n\n# user-level\n$ swift package-registry set --scope foo --global https://global.example.com \n```\n\nTo remove a registry assignment, use the `swift package-registry unset` subcommand.\n \n### Security configuration\n\nRegistry security configuration are specified in the user-level `registries.json`\n(`~/.swiftpm/configuration/registries.json`):\n\n```json\n{\n \"security\": {\n \"default\": {\n \"signing\": {\n \"onUnsigned\": \"prompt\", // One of: \"error\", \"prompt\", \"warn\", \"silentAllow\"\n \"onUntrustedCertificate\": \"prompt\", // One of: \"error\", \"prompt\", \"warn\", \"silentAllow\"\n \"trustedRootCertificatesPath\": \"~/.swiftpm/security/trusted-root-certs/\",\n \"includeDefaultTrustedRootCertificates\": true,\n \"validationChecks\": {\n \"certificateExpiration\": \"disabled\", // One of: \"enabled\", \"disabled\"\n \"certificateRevocation\": \"disabled\" // One of: \"strict\", \"allowSoftFail\", \"disabled\"\n }\n }\n },\n \"registryOverrides\": {\n // The example shows all configuration overridable at registry level\n \"packages.example.com\": {\n \"signing\": {\n \"onUnsigned\": \"warn\",\n \"onUntrustedCertificate\": \"warn\",\n \"trustedRootCertificatesPath\": ,\n \"includeDefaultTrustedRootCertificates\": ,\n \"validationChecks\": {\n \"certificateExpiration\": \"enabled\",\n \"certificateRevocation\": \"allowSoftFail\"\n }\n }\n }\n },\n \"scopeOverrides\": {\n // The example shows all configuration overridable at scope level\n \"mona\": {\n \"signing\": {\n \"trustedRootCertificatesPath\": ,\n \"includeDefaultTrustedRootCertificates\": \n }\n }\n },\n \"packageOverrides\": {\n // The example shows all configuration overridable at package level\n \"mona.LinkedList\": {\n \"signing\": {\n \"trustedRootCertificatesPath\": ,\n \"includeDefaultTrustedRootCertificates\": \n }\n }\n }\n },\n ...\n}\n```\n\nThere are multiple levels of overrides. Configuration for a \npackage is computed using values from the following \n(in descending precedence):\n1. `packageOverrides` (if any)\n1. `scopeOverrides` (if any)\n1. `registryOverrides` (if any)\n1. `default`\n\nThe `default` JSON object in the example above contains all \nconfigurable security options and their default value when \nthere is no override.\n\n- `signing.onUnsigned`: Indicates how SwiftPM will handle an unsigned package.\n\n | Option | Description |\n | ------------- | --------------------------------------------------------- |\n | `error` | SwiftPM will reject the package and fail the build. |\n | `prompt` | SwiftPM will prompt user to see if the unsigned package should be allowed.
  • If no, SwiftPM will reject the package and fail the build.
  • If yes and the package has never been downloaded, its checksum will be stored for [checksum TOFU](#checksum-tofu). Otherwise, if the package has been downloaded before, its checksum must match the previous value or else SwiftPM will reject the package and fail the build.
SwiftPM will record user's response to prevent repetitive prompting. |\n | `warn` | SwiftPM will not prompt user but will emit a warning before proceeding. |\n | `silentAllow` | SwiftPM will allow the unsigned package without prompting user or emitting warning. |\n\n- `signing.onUntrustedCertificate`: Indicates how SwiftPM will handle a package signed with an [untrusted certificate](#trusted-vs-untrusted-certificate).\n\n | Option | Description |\n | ------------- | --------------------------------------------------------- |\n | `error` | SwiftPM will reject the package and fail the build. |\n | `prompt` | SwiftPM will prompt user to see if the package signed with an untrusted certificate should be allowed.
  • If no, SwiftPM will reject the package and fail the build.
  • If yes, SwiftPM will proceed with the package as if it were an unsigned package.
SwiftPM will record user's response to prevent repetitive prompting. |\n | `warn` | SwiftPM will not prompt user but will emit a warning before proceeding. |\n | `silentAllow` | SwiftPM will allow the package signed with an untrusted certificate without prompting user or emitting warning. |\n\n- `signing.trustedRootCertificatesPath`: Absolute path to the directory containing custom trusted roots. SwiftPM will include these roots in its [trust store](#trusted-vs-untrusted-certificate), and certificates used for package signing must chain to roots found in this store. This configuration allows override at the package, scope, and registry levels.\n- `signing.includeDefaultTrustedRootCertificates`: Indicates if SwiftPM should include default trusted roots in its [trust store](#trusted-vs-untrusted-certificate). This configuration allows override at the package, scope, and registry levels.\n- `signing.validationChecks`: Validation check settings for the package signature.\n\n | Validation | Description |\n | ------------------------ | --------------------------------------------------------------- |\n | `certificateExpiration` |
  • `enabled`: SwiftPM will check that the current timestamp when downloading falls within the signing certificate's validity period. If it doesn't, SwiftPM will reject the package and fail the build.
  • `disabled`: SwiftPM will not perform this check.
|\n | `certificateRevocation` | With the exception of `disabled`, SwiftPM will check revocation status of the signing certificate. Currently, SwiftPM only supports revocation check done through [OCSP](https://www.rfc-editor.org/rfc/rfc6960).
  • `strict`: Revocation check must complete successfully and the certificate must be in good status. SwiftPM will reject the package and fail the build if the revocation status is revoked or unknown (including revocation check not supported or failed).
  • `allowSoftFail`: SwiftPM will reject the package and fail the build iff the certificate has been revoked. SwiftPM will allow the certificate's revocation status to be unknown (including revocation check not supported or failed).
  • `disabled`: SwiftPM will not perform this check.
|\n" }, { "path": "Documentation/PackageRegistry/Registry.md", "content": "# Swift Package Registry Service Specification\n\n- [1. Notations](#1-notations)\n- [2. Definitions](#2-definitions)\n- [3. Conventions](#3-conventions)\n - [3.1. Application layer protocols](#31-application-layer-protocols)\n - [3.2. Authentication](#32-authentication)\n - [3.3. Error handling](#33-error-handling)\n - [3.4. Rate limiting](#34-rate-limiting)\n - [3.5. API versioning](#35-api-versioning)\n - [3.6. Package identification](#36-package-identification)\n - [3.6.1 Package scope](#361-package-scope)\n - [3.6.2. Package name](#362-package-name)\n- [4. Endpoints](#4-endpoints)\n - [4.1. List package releases](#41-list-package-releases)\n - [4.2. Fetch information about a package release](#42-fetch-information-about-a-package-release)\n - [4.2.1. Package release resources](#421-package-release-resources)\n - [4.2.2. Package release metadata standards](#422-package-release-metadata-standards)\n - [4.3. Fetch manifest for a package release](#43-fetch-manifest-for-a-package-release)\n - [4.3.1. swift-version query parameter](#431-swift-version-query-parameter)\n - [4.4. Download source archive](#44-download-source-archive)\n - [4.4.1. Integrity verification](#441-integrity-verification)\n - [4.4.2. Download locations](#442-download-locations)\n - [4.4.3. Signature validation](#443-signature-validation)\n - [4.5. Lookup package identifiers registered for a URL](#45-lookup-package-identifiers-registered-for-a-url)\n - [4.5.1 URL to package identifier mappings](#451-url-to-package-identifier-mappings)\n - [4.6. Create a package release](#46-create-a-package-release)\n - [4.6.1. Source archive](#461-source-archive)\n - [4.6.2. Package release metadata](#462-package-release-metadata)\n - [4.6.3. Synchronous and asynchronous publication](#463-synchronous-and-asynchronous-publication)\n - [4.6.3.1. Synchronous publication](#4631-synchronous-publication)\n - [4.6.3.2. Asynchronous publication](#4632-asynchronous-publication)\n- [5. Normative References](#5-normative-references)\n- [6. Informative References](#6-informative-references)\n- [Appendix A - OpenAPI Document](#appendix-a---openapi-document)\n- [Appendix B - Package Release Metadata JSON Schema](#appendix-b---package-release-metadata-json-schema)\n\n## 1. Notations\n\nThe following terminology and conventions are used in this document.\n\nThe key words \"MUST\", \"MUST NOT\", \"REQUIRED\", \"SHALL\", \"SHALL NOT\",\n\"SHOULD\", \"SHOULD NOT\", \"RECOMMENDED\", \"MAY\", and \"OPTIONAL\"\nin this document are to be interpreted as described in [RFC 2119].\n\nThis specification uses the Augmented Backus-Naur Form (ABNF) notation\nas described in [RFC 5234]\nand Unicode regular expression syntax\nas described in [Unicode Technical Standard #18][UAX18].\n\nAPI endpoints that accept parameters in their path\nare expressed by Uniform Resource Identifier (URI) templates,\nas described in [RFC 6570].\n\n## 2. Definitions\n\nThe following terms, as used in this document, have the meanings indicated.\n\n- _Package_:\n A named collection of Swift source code\n that is organized into one or more modules\n according to a `Package.swift` manifest file.\n- _Scope_:\n A logical grouping of related packages assigned by a package registry.\n- _Release_:\n The state of a package after applying a particular set of changes\n that is uniquely identified by an assigned version number.\n- _Version Number_:\n An identifier for a package release\n in accordance with the [Semantic Versioning Specification (SemVer)][SemVer].\n- _Precedence_:\n The ordering of version numbers relative to each other\n as defined by the [Semantic Versioning Specification (SemVer)][SemVer].\n\n## 3. Conventions\n\nThis document uses the following conventions\nin its description of client-server interactions.\n\n### 3.1. Application layer protocols\n\nA client and server MUST communicate over a secured connection\nusing Transport Layer Security (TLS) with the `https` URI scheme.\n\nThe use of HTTP 1.1 in examples is non-normative.\nA client and server MAY communicate according to this specification\nusing any version of the HTTP protocol.\n\n### 3.2. Authentication\n\nA server MAY require authentication\nfor client requests to access information about packages and package releases.\n\nA server SHOULD respond with a status code of `401` (Unauthorized)\nif a client sends a request to an endpoint that requires authentication\nwithout providing credentials.\nA server MAY respond with a status code of `404` (Not Found) or `403` (Forbidden)\nwhen a client provides valid credentials\nbut isn't authorized to access the requested resource.\n\nA server MAY use any authentication model of its choosing.\nHowever, the use of a scoped, revocable authorization framework\nlike [OAuth 2.0][RFC 6749] is RECOMMENDED.\n\n### 3.3. Error handling\n\nA server MUST communicate any errors to the client\nusing \"problem details\" objects,\nas described by [RFC 7807].\nFor example,\na client sends a request for a nonexistent release of a package\nand receives the following response:\n\n```http\nHTTP/1.1 404\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"release not found\"\n}\n```\n\n### 3.4. Rate limiting\n\nA server MAY limit the number of requests made by a client\nby responding with a status code of `429` (Too Many Requests).\n\n```http\nHTTP/1.1 429\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\nRetry-After: 60\n\n{\n \"detail\": \"try again in 60 seconds\"\n}\n```\n\nA client SHOULD follow the guidance of any\n`Retry-After` header values provided in responses\nto prevent overwhelming a server with retry requests.\nIt is RECOMMENDED for clients to introduce random jitter in their retry logic\nto avoid a [thundering herd effect].\n\n### 3.5. API versioning\n\nPackage registry APIs are versioned.\n\nAPI version numbers are designated by decimal integers.\nThe accepted version of this proposal constitutes the initial version, `1`.\nSubsequent revisions SHOULD be numbered sequentially\n(`2`, `3`, and so on).\n\nAPI version numbers SHOULD follow\nSemantic Versioning conventions for major releases.\nNon-breaking changes, such as\nadding new endpoints,\nadding new optional parameters to existing endpoints,\nor adding new information to existing endpoints in a backward-compatible way,\nSHOULD NOT require a new version.\nBreaking changes, such as\nremoving or changing an existing endpoint\nin a backward-incompatible way,\nMUST correspond to a new version.\n\nA client SHOULD set the `Accept` header field\nto specify the API version of a request.\n\n```http\nGET /mona/LinkedList/list HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+json\n```\n\nValid `Accept` header field values are described by the following rules:\n\n```abnf\n version = \"1\" ; The API version\n mediatype = \"json\" / ; JSON (default media type)\n \"zip\" / ; Zip archives, used for package releases\n \"swift\" ; Swift file, used for package manifest\n accept = \"application/vnd.swift.registry\" [\".v\" version] [\"+\" mediatype]\n```\n\nA server MUST set the `Content-Type` header field\nwith the corresponding content type of the response.\n\nA server MUST set the `Content-Version` header field\nwith the API version number of the response, unless\nexplicitly stated otherwise.\n\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\nContent-Version: 1\n```\n\nIf a client sends a request without an `Accept` header,\na server MAY either respond with a status code of `400 Bad Request` or\nprocess the request using an API version that it chooses,\nmaking sure to set the `Content-Type` and `Content-Version` headers accordingly.\n\nIf a client sends a request with an `Accept` header\nthat specifies an unknown or invalid API version,\na server SHOULD respond with a status code of `400` (Bad Request).\n\n```http\nHTTP/1.1 400 Bad Request\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"invalid API version\"\n}\n```\n\nIf a client sends a request with an `Accept` header\nthat specifies a valid but unsupported API version,\na server SHOULD respond with a status code of `415` (Unsupported Media Type).\n\n```http\nHTTP/1.1 415 Unsupported Media Type\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"unsupported API version\"\n}\n```\n\n### 3.6. Package identification\n\nA package may declare external packages as dependencies in its manifest.\nEach package dependency may specify a requirement\non which versions are allowed.\n\nAn external package dependency may itself have\none or more external package dependencies,\nknown as transitive dependencies.\nWhen multiple packages have dependencies in common,\nSwift Package Manager determines which version of that package should be used\n(if any exist that satisfy all specified requirements)\nin a process called package resolution.\n\nEach external package is uniquely identified\nby a scoped identifier in the form `scope.package-name`.\n\n#### 3.6.1 Package scope\n\nA *scope* provides a namespace for related packages within a package registry.\nA package scope consists of alphanumeric characters and hyphens.\nHyphens may not occur at the beginning or end,\nnor consecutively within a scope.\nThe maximum length of a package scope is 39 characters.\nA valid package scope matches the following regular expression pattern:\n\n```regexp\n\\A[a-zA-Z0-9](?:[a-zA-Z0-9]|-(?=[a-zA-Z0-9])){0,38}\\z\n```\n\nPackage scopes are case-insensitive\n(for example, `mona` ≍ `MONA`).\n\n#### 3.6.2. Package name\n\nA package's *name* uniquely identifies a package in a scope.\nA package name consists of alphanumeric characters, underscores, and hyphens.\nHyphens and underscores may not occur at the beginning or end,\nnor consecutively within a name.\nThe maximum length of a package name is 100 characters.\nA valid package name matches the following regular expression pattern:\n\n```regexp\n\\A[a-zA-Z0-9](?:[a-zA-Z0-9]|[-_](?=[a-zA-Z0-9])){0,99}\\z\n```\n\nPackage names are case-insensitive\n(for example, `LinkedList` ≍ `LINKEDLIST`).\n\n## 4. Endpoints\n\nA server MUST respond to the following endpoints:\n\n| Link | Method | Path | Description |\n| -------------------- | ------ | --------------------------------------------------------- | ------------------------------------------------- |\n| [\\[1\\]](#endpoint-1) | `GET` | `/{scope}/{name}` | List package releases |\n| [\\[2\\]](#endpoint-2) | `GET` | `/{scope}/{name}/{version}` | Fetch metadata for a package release |\n| [\\[3\\]](#endpoint-3) | `GET` | `/{scope}/{name}/{version}/Package.swift{?swift-version}` | Fetch manifest for a package release |\n| [\\[4\\]](#endpoint-4) | `GET` | `/{scope}/{name}/{version}.zip` | Download source archive for a package release |\n| [\\[5\\]](#endpoint-5) | `GET` | `/identifiers{?url}` | Lookup package identifiers registered for a URL |\n| [\\[6\\]](#endpoint-6) | `PUT` | `/{scope}/{name}/{version}` | Create a package release |\n\nA server SHOULD also respond to `HEAD` requests\nfor each of the specified endpoints.\n\nA client MAY send an `OPTIONS` request with an asterisk (`*`)\nto determine the permitted communication options for the server.\nA server MAY respond with a `Link` header containing\nan entry for the `service-doc` relation type\nwith a link to this document, and\nan entry for the `service-desc` relation type\nwith a link to the OpenAPI specification.\n\n* * *\n\n\n\n### 4.1. List package releases\n\nA client MAY send a `GET` request\nfor a URI matching the expression `/{scope}/{name}`\nto retrieve a list of the available releases for a particular package.\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+json`\nand MAY append the `.json` extension to the requested URI.\n\n```http\nGET /mona/LinkedList HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+json\n```\n\nIf a package is found at the requested location,\na server SHOULD respond with a status code of `200` (OK)\nand the `Content-Type` header `application/json`.\nOtherwise, a server SHOULD respond with a status code of `404` (Not Found).\n\nA server SHOULD respond with a JSON document\ncontaining the releases for the requested package.\n\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\nContent-Version: 1\nContent-Length: 508\nLink: ; rel=\"canonical\",\n ; rel=\"alternate\",\n ; rel=\"latest-version\",\n ; rel=\"payment\"\n\n{\n \"releases\": {\n \"1.1.1\": {\n \"url\": \"https://packages.example.com/mona/LinkedList/1.1.1\"\n },\n \"1.1.0\": {\n \"url\": \"https://packages.example.com/mona/LinkedList/1.1.0\",\n \"problem\": {\n \"status\": 410,\n \"title\": \"Gone\",\n \"detail\": \"this release was removed from the registry\"\n }\n },\n \"1.0.0\": {\n \"url\": \"https://packages.example.com/mona/LinkedList/1.0.0\"\n }\n }\n}\n```\n\nThe response body MUST contain a JSON object\nnested at a top-level `releases` key,\nwhose keys are version numbers for releases and\nwhose values are objects containing the following fields:\n\n| Key | Type | Description | Requirement Level |\n| --------- | ------ | ------------------------------------- | ----------------- |\n| `url` | String | The location of the release resource. | OPTIONAL |\n| `problem` | Object | A [problem details][RFC 7807] object. | OPTIONAL |\n\nA server MAY specify a URL for a release using the `url` key.\nA client SHOULD locate a release using the value of the `url` key, if one is provided.\nOtherwise, the client SHOULD locate a release\nby expanding the URI Template `/{scope}/{name}/{version}` on the originating host.\n\nA server SHOULD communicate the unavailability of a package release\nusing a [\"problem details\"][RFC 7807] object.\nA client SHOULD consider any releases with an associated `problem`\nto be unavailable for the purposes of package resolution.\n\nA server SHOULD respond with\na link to the highest precedence published release of the package if one exists,\nusing a `Link` header field with a `latest-version` relation.\n\nA server SHOULD list releases in order of precedence,\nstarting with the highest precedence version.\nHowever, a client SHOULD NOT assume\nany specific ordering of versions in a response.\n\nA server MAY include a `Link` entry\nwith the `canonical` relation type\nthat locates the source repository of the package.\n\nA server MAY include one or more `Link` entries\nwith the `alternate` relation type\nfor other source repository locations.\n\nA server MAY paginate results by responding with\na `Link` header field that includes any of the following relations:\n\n| Name | Description |\n| ------- | --------------------------------------- |\n| `next` | The immediate next page of results. |\n| `last` | The last page of results. |\n| `first` | The first page of results. |\n| `prev` | The immediate previous page of results. |\n\nFor example,\nthe `Link` header field in a response for the third page of paginated results:\n\n```http\nLink: ; rel=\"latest-version\",\n ; rel=\"first\",\n ; rel=\"previous\",\n ; rel=\"next\",\n ; rel=\"last\"\n```\n\nA server MAY respond with additional `Link` entries,\nsuch as one with a `payment` relation for sponsoring a package maintainer.\n\n\n\n### 4.2. Fetch information about a package release\n\nA client MAY send a `GET` request\nfor a URI matching the expression `/{scope}/{name}/{version}`\nto retrieve information about a release.\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+json`,\nand MAY append the `.json` extension to the requested URI.\n\n```http\nGET /mona/LinkedList/1.1.1 HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+json\n```\n\nIf a release is found at the requested location,\na server SHOULD respond with a status code of `200` (OK)\nand the `Content-Type` header `application/json`.\nOtherwise, a server SHOULD respond with a status code of `404` (Not Found).\n\n```http\nHTTP/1.1 200 OK\nContent-Version: 1\nContent-Type: application/json\nContent-Length: 720\nLink: ; rel=\"latest-version\",\n ; rel=\"predecessor-version\"\n{\n \"id\": \"mona.LinkedList\",\n \"version\": \"1.1.1\",\n \"resources\": [\n {\n \"name\": \"source-archive\",\n \"type\": \"application/zip\",\n \"checksum\": \"a2ac54cf25fbc1ad0028f03f0aa4b96833b83bb05a14e510892bb27dea4dc812\",\n \"signing\": {\n \"signatureBase64Encoded\": \"l1TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw==\",\n \"signatureFormat\": \"cms-1.0.0\"\n }\n }\n ],\n \"metadata\": { ... },\n \"publishedAt\": \"2023-02-16T04:00:00.000Z\"\n}\n```\n\nThe response body SHOULD contain a JSON object containing the following fields:\n\n| Key | Type | Description | Required |\n| ------------- | ------ | ----------------------------------------- | :------: |\n| `id` | String | The namespaced package identifier. | ✓ |\n| `version` | String | The package release version number. | ✓ |\n| `resources` | Array | The resources available for the release. | ✓ |\n| `metadata` | Object | Additional information about the release. | ✓ |\n| `publishedAt` | String | The [ISO 8601]-formatted datetime string of when the package release was published, as recorded by the registry. See related [`originalPublicationTime`](#appendix-b---package-release-metadata-json-schema) in `metadata`. | |\n\nA server SHOULD respond with a `Link` header containing the following entries:\n\n| Relation | Description |\n| --------------------- | ------------------------------------------------------------------------------------ |\n| `latest-version` | The highest precedence published release of the package |\n| `successor-version` | The next published release of the package ordered by precedence, if one exists |\n| `predecessor-version` | The previously published release of the package ordered by precedence, if one exists |\n\nA link with the `latest-version` relation\nMAY correspond to the requested release.\n\n#### 4.2.1. Package release resources\n\nEach element in the `resources` array is a JSON object with the following keys:\n\n| Key | Type | Description |\n| ---------- | ------- | -------------------------------------------------------------------------- |\n| `name` | String | The name of the resource. |\n| `type` | String | The content type of the resource. |\n| `checksum` | String | A hexadecimal representation of the SHA256 digest for the resource. |\n| `signing` | Object | Information about the signature. Required only if the resource is signed. |\n\nThe `signing` JSON object contains these keys:\n\n| Key | Type | Description |\n| ------------------------ | ------- | ------------------------------------------------- |\n| `signatureBase64Encoded` | String | The resource's signature, base64 encoded. |\n| `signatureFormat` | String | The signature format. (e.g., `cms-1.0.0`) |\n\nA resource object SHOULD have one of the following combinations of\n`name` and `type` values:\n\n| Name | Content Type | Description |\n| ------------------ | ----------------- | ---------------------------------- |\n| `source-archive` | `application/zip` | An archive of package sources. |\n\nA release MUST NOT have more than a single resource object\nwith a given combination of `name` and `type` values.\n\n#### 4.2.2. Package release metadata standards\n\n[Appendix B](#appendix-b---package-release-metadata-json-schema)\ndefines the JSON schema for package release metadata that\ngets submitted as part of the [\"create a package release\"](#endpoint-6)\nrequest. A server MAY allow and/or populate additional metadata by\nexpanding the schema. The `metadata` key in the\n[\"fetch information about a package release \"](#endpoint-2) API response\nwill hold the user-provided as well as the server populated metadata.\n\n\n\n### 4.3. Fetch manifest for a package release\n\nA client MAY send a `GET` request for a URI matching the expression\n`/{scope}/{name}/{version}/Package.swift`\nto retrieve the package manifest for a release.\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+swift`.\n\n```http\nGET /mona/LinkedList/1.1.1/Package.swift HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+swift\n```\n\nIf a release is found at the requested location,\na server SHOULD respond with a status code of `200` (OK)\nand the `Content-Type` header `text/x-swift`.\nOtherwise, a server SHOULD respond with a status code of `404` (Not Found).\n\n```http\nHTTP/1.1 200 OK\nCache-Control: public, immutable\nContent-Type: text/x-swift\nContent-Disposition: attachment; filename=\"Package.swift\"\nContent-Length: 361\nContent-Version: 1\nLink: ; rel=\"alternate\"; filename=\"Package@swift-4.swift\"; swift-tools-version=\"4.0\",\n ; rel=\"alternate\"; filename=\"Package@swift-4.2.swift\"; swift-tools-version=\"4.2\"\n\n// swift-tools-version:5.0\nimport PackageDescription\n\nlet package = Package(\n name: \"LinkedList\",\n products: [\n .library(name: \"LinkedList\", targets: [\"LinkedList\"])\n ],\n targets: [\n .target(name: \"LinkedList\"),\n .testTarget(name: \"LinkedListTests\", dependencies: [\"LinkedList\"]),\n ],\n swiftLanguageVersions: [.v4, .v5]\n)\n```\n\nA server SHOULD respond with a `Content-Length` header\nset to the size of the manifest in bytes.\n\nA server SHOULD respond with a `Content-Disposition` header\nset to `attachment` with a `filename` parameter equal to\nthe name of the manifest file\n(for example, \"Package.swift\").\n\nA server MAY omit the `Content-Version` header\nsince the response content (i.e., the manifest) SHOULD NOT\nchange across different API versions.\n\nIt is RECOMMENDED for clients and servers to support\ncaching as described by [RFC 7234].\n\nA server MUST include a `Link` header field\nwith a value for each version-specific package manifest file\nin the release's source archive,\nwhose filename matches the following regular expression pattern:\n\n```regexp\n\\APackage@swift-(\\d+)(?:\\.(\\d+))?(?:\\.(\\d+))?.swift\\z\n```\n\nEach link value SHOULD have the `alternate` relation type,\na `filename` attribute set to the version-specific package manifest filename\n(for example, `Package@swift-4.swift`), and\na `swift-tools-version` attribute set to the [Swift tools version]\nspecified by the package manifest file\n(for example, `4.0` for a manifest beginning with the comment\n`// swift-tools-version:4.0`).\n\n#### 4.3.1. swift-version query parameter\n\nA client MAY specify a `swift-version` query parameter\nto request a manifest for a particular version of Swift.\n\n```http\nGET /mona/LinkedList/1.1.1/Package.swift?swift-version=4.2 HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+swift\n```\n\nIf the package includes a file named\n`Package@swift-{swift-version}.swift`,\nthe server SHOULD respond with a status code of `200` (OK)\nand the content of that file in the response body.\n\n```http\nHTTP/1.1 200 OK\nCache-Control: public, immutable\nContent-Type: text/x-swift\nContent-Disposition: attachment; filename=\"Package@swift-4.2.swift\"\nContent-Length: 361\nContent-Version: 1\n\n// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"LinkedList\",\n products: [\n .library(name: \"LinkedList\", targets: [\"LinkedList\"])\n ],\n targets: [\n .target(name: \"LinkedList\"),\n .testTarget(name: \"LinkedListTests\", dependencies: [\"LinkedList\"]),\n ],\n swiftLanguageVersions: [.v3, .v4]\n)\n```\n\nOtherwise,\nthe server SHOULD respond with a status code of `303` (See Other)\nand redirect to the unqualified `Package.swift` resource.\n\n```http\nHTTP/1.1 303 See Other\nContent-Version: 1\nLocation: https://packages.example.com/mona/LinkedList/1.1.1/Package.swift\n```\n\n\n\n### 4.4. Download source archive\n\nA client MAY send a `GET` request\nfor a URI matching the expression `/{scope}/{name}/{version}.zip`\nto retrieve a release's source archive.\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+zip`\nand MUST append the `.zip` extension to the requested path.\n\n```http\nGET /mona/LinkedList/1.1.1.zip HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+zip\n```\n\nIf a release is found at the requested location,\na server SHOULD respond with a status code of `200` (OK)\nand the `Content-Type` header `application/zip`.\nOtherwise, a server SHOULD respond with a status code of `404` (Not Found).\n\n```http\nHTTP/1.1 200 OK\nAccept-Ranges: bytes\nCache-Control: public, immutable\nContent-Type: application/zip\nContent-Disposition: attachment; filename=\"LinkedList-1.1.1.zip\"\nContent-Length: 2048\nContent-Version: 1\nDigest: sha-256=oqxUzyX7wa0AKPA/CqS5aDO4O7BaFOUQiSuyfepNyBI=\nLink: ; rel=duplicate; geo=jp; pri=10; type=\"application/zip\"\nX-Swift-Package-Signature-Format: cms-1.0.0\nX-Swift-Package-Signature: l1TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw==\n```\n\nA server MUST respond with a `Content-Length` header\nset to the size of the archive in bytes.\nA client SHOULD terminate any requests whose response exceeds\nthe expected content length.\n\nA server MAY respond with a `Digest` header\ncontaining a cryptographic digest of the source archive.\n\nA server SHOULD respond with a `Content-Disposition` header\nset to `attachment` with a `filename` parameter equal to the name of the package\nfollowed by a hyphen (`-`), the version number, and file extension\n(for example, \"LinkedList-1.1.1.zip\").\n\nA server MAY omit the `Content-Version` header\nsince the response content (i.e., the source archive) SHOULD NOT\nchange across different API versions.\n\nIt is RECOMMENDED for clients and servers to support\nrange requests as described by [RFC 7233]\nand caching as described by [RFC 7234].\n\nIf a release is signed, a server MUST include\n`X-Swift-Package-Signature-Format` and `X-Swift-Package-Signature`\nheaders in the response.\n\n#### 4.4.1. Integrity verification\n\nA client MUST verify the integrity of a downloaded source archive using\nthe `checksum` value for the associated `source-archive` resource\nin the response to `GET /{scope}/{name}/{version}`,\nas described in [4.2.1](#421-package-release-resources).\n\nA client SHOULD also verify the integrity using any values\nprovided in the `Digest` header of the source archive response\n(for using the command\n`shasum -b -a 256 LinkedList-1.1.1.zip | cut -f1 | xxd -r -p | base64`).\n\n#### 4.4.2. Download locations\n\nA server MAY specify mirrors or multiple download locations\nusing `Link` header fields\nwith a `duplicate` relation,\nas described by [RFC 6249].\nA client MAY use this information\nto determine its preferred strategy for downloading.\n\nA server MAY respond with a status code of `303` (See Other)\nto redirect the client to download the source archive from another host.\nThe client MUST NOT follow redirects that downgrade to an insecure connection.\nThe client SHOULD limit the number of redirects to prevent a redirect loop.\n\nFor example,\na server redirects the client to download from\na content delivery network (CDN) using a signed URL:\n\n```http\nHTTP/1.1 303 See Other\nLocation: https://example.cdn.com/LinkedList-1.1.1.zip?key=XXXXXXXXXXXXXXXXX\n```\n\n```http\nGET /LinkedList-1.1.1.zip?key=XXXXXXXXXXXXXXXXX HTTP/1.1\nHost: example.cdn.com\nAccept: application/vnd.swift.registry.v1+zip\n```\n\n```http\nHTTP/1.1 200 OK\nAccept-Ranges: bytes\nCache-Control: public, immutable\nContent-Type: application/zip\nContent-Disposition: attachment; filename=\"LinkedList-1.1.1.zip\"\nContent-Length: 2048\nContent-Version: 1\nDigest: sha-256=a2ac54cf25fbc1ad0028f03f0aa4b96833b83bb05a14e510892bb27dea4dc812\n```\n\n#### 4.4.3. Signature validation\n\nA client MUST validate the signature of a signed archive\naccording to the signature format and configuration. Signing\ninformation can alternatively be found in the associated\n`source-archive` resource in the response to `GET /{scope}/{name}/{version}`,\nas described in [4.2.1](#421-package-release-resources).\n\n\n\n### 4.5. Lookup package identifiers registered for a URL\n\nA client MAY send a `GET` request\nfor a URI matching the expression `/identifiers?url={url}`\nto retrieve package identifiers associated with a particular URL.\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+json`.\n\n```http\nGET /identifiers?url=https://github.com/mona/LinkedList HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1\n```\n\nA client MUST provide a URL for the `url` query parameter.\nWhen no `url` parameter is specified,\na server SHOULD respond with a status code of `400` (Bad Request).\n\nIf one or more package identifiers are associated with the specified URL,\na server SHOULD respond with a status code of `200` (OK)\nand the `Content-Type` header `application/json`.\nOtherwise, a server SHOULD respond with a status code of `404` (Not Found).\n\nA server SHOULD respond with a JSON document\ncontaining the package identifiers for the specified URL.\n\n```http\nHTTP/1.1 200 OK\nContent-Type: application/json\nContent-Version: 1\n\n{\n \"identifiers\": [\n \"mona.LinkedList\"\n ]\n}\n```\n\nThe response body MUST contain an array of package identifier strings\nnested at a top-level `identifiers` key.\n\nIt is RECOMMENDED for clients and servers to support\ncaching as described by [RFC 7234].\n\n#### 4.5.1 URL to package identifier mappings\n\nAs part of the [package release metadata](#422-package-release-metadata-standards)\nJSON object, the `repositoryURLs` array can be used to specify\nURLs associated with a package identifier. This is one way\nthrough which a server can obtain URL to package identifier\nmappings for this API.\n\nA server MAY choose other mechanism(s) for package authors\nto specify these mappings.\n\nA server SHOULD validate the package author's ownership claim\non the corresponding repository.\n\n\n\n### 4.6. Create a package release\n\nA client MAY send a `PUT` request\nfor a URI matching the expression\n`/{scope}/{name}/{version}`\nto publish a release of a package.\nA client MUST provide a body encoded as multipart form data\nwith the following sections:\n\n| Key | Content-Type | Description | Requirement Level |\n| -------------------------- | -------------------------- | ----------------------------------------- | ----------------- |\n| `source-archive` | `application/zip` | The source archive of the package. | REQUIRED |\n| `source-archive-signature` | `application/octet-stream` | The signature of the source archive. | OPTIONAL |\n| `metadata` | `application/json` | Additional information about the release. | OPTIONAL |\n| `metadata-signature` | `application/octet-stream` | The signature of the metadata. | OPTIONAL |\n\nA client MUST set a `Content-Type` header with the value\n`multipart/form-data`. `boundary` can be any string.\n\nA client MAY use any valid value (e.g., `binary`) for the\n`Content-Transfer-Encoding` header.\n\nA client SHOULD set the `Content-Length` header with\nthe total size of the body in bytes.\n\nA client SHOULD set the `Accept` header with the value\n`application/vnd.swift.registry.v1+json`.\n\nA client MUST set a `X-Swift-Package-Signature-Format` header\nwith the signature format if the source archive is signed.\n\n```http\nPUT /mona/LinkedList/1.1.1 HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1+json\nContent-Type: multipart/form-data;boundary=\"boundary\"\nContent-Length: 336\nExpect: 100-continue\nX-Swift-Package-Signature-Format: cms-1.0.0\n\n--boundary\nContent-Disposition: form-data; name=\"source-archive\"\nContent-Type: application/zip\nContent-Length: 32\nContent-Transfer-Encoding: base64\n\ngHUFBgAAAAAAAAAAAAAAAAAAAAAAAA==\n\n--boundary\nContent-Disposition: form-data; name=\"source-archive-signature\"\nContent-Type: application/octet-stream\nContent-Length: 88\nContent-Transfer-Encoding: base64\n\nl1TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw==\n\n--boundary\nContent-Disposition: form-data; name=\"metadata\"\nContent-Type: application/json\nContent-Transfer-Encoding: quoted-printable\nContent-Length: 3\n\n{ \"repositoryURLs\": [] }\n\n--boundary\nContent-Disposition: form-data; name=\"metadata-signature\"\nContent-Type: application/octet-stream\nContent-Length: 88\nContent-Transfer-Encoding: base64\n\nM6TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw==\n\n```\n\nA server SHOULD require a client to perform authentication\nfor any requests to create a package release.\nUse of multi-factor authentication is RECOMMENDED.\n\nA client MAY publish releases in any order.\nFor example,\nif a package has existing `1.0.0` and `2.0.0` releases,\na client MAY publish a new `1.0.1` or `1.1.0` release.\n\nOnce a release has been published,\nany resources associated with that release,\nincluding its source archive,\nMUST NOT change.\n\nIf a release already exists for a package at the specified version,\nthe server SHOULD respond with a status code of `409` (Conflict).\n\n```http\nHTTP/1.1 409 Conflict\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"a release with version 1.0.0 already exists\"\n}\n```\n\nIt is RECOMMENDED that a server institute policies\nfor publishing new releases of a package\nafter a scope is transferred to a new owner.\nFor example,\nthe next release of an existing package is published with a new major version,\nor only after a period of 45 days after transfer.\n\nIf the client provides an `Expect` header,\na server SHOULD check that the request can succeed\nbefore responding with a status code of `100 (Continue)`.\nA server that doesn't support expectations\nSHOULD respond with a status code of `417 (Expectation Failed)`.\nIn response,\na client MAY remove the `Expect` header and retry the request.\n\n```http\nHTTP/1.1 417 (Expectation Failed)\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"expectations aren't supported\"\n}\n```\n\nSupport for this endpoint is OPTIONAL.\nA server SHOULD indicate that publishing isn't supported\nby responding with a status code of `405` (Method Not Allowed).\n\n```http\nHTTP/1.1 405 (Method Not Allowed)\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"publishing isn't supported\"\n}\n```\n\nA server MAY respond either synchronously or asynchronously.\nFor more information,\nsee [4.6.4](#464-synchronous-and-asynchronous-publication).\n\n#### 4.6.1. Source archive\n\nA client MUST include a multipart section named `source-archive`\ncontaining the source archive for a release.\nA client SHOULD set a `Content-Type` header with the value `application/zip`\nand a `Content-Length` header with the size of the Zip archive in bytes.\n\n```http\n--boundary\nContent-Disposition: form-data; name=\"source-archive\"\nContent-Type: application/zip\nContent-Length: 32\nContent-Transfer-Encoding: base64\n\ngHUFBgAAAAAAAAAAAAAAAAAAAAAAAA==\n```\n\nA client SHOULD use the `swift package archive-source` tool\nto create a source archive for the release.\n\nA server MAY analyze a package to\nassess its viability,\nperform security testing,\nor otherwise evaluate software quality.\nA server MAY refuse to publish a package release for any reason\nby responding with a status code of `422` (Unprocessable Entity).\n\n```http\nHTTP/1.1 422 Unprocessable Entity\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"package doesn't contain a valid manifest (Package.swift) file\"\n}\n```\n\nA server SHOULD use the `swift package compute-checksum` tool\nto compute the checksum that's provided in response to\na client's subsequent request to [download the source archive](#endpoint-4)\nfor the release.\n\n#### 4.6.2. Package release metadata\n\nA client MAY include a multipart section named `metadata`\ncontaining additional information about the release.\nA client SHOULD set a `Content-Type` header with the value `application/json`\nand a `Content-Length` header with the size of the JSON document in bytes.\nThe package release metadata MUST be based on the [JSON schema](#appendix-b---package-release-metadata-json-schema),\nas discussed in [4.2.2](#422-package-release-metadata-standards).\n\n```http\n--boundary\nContent-Disposition: form-data; name=\"metadata\"\nContent-Type: application/json\nContent-Length: 226\nContent-Transfer-Encoding: quoted-printable\n\n{\n \"description\": \"One thing links to another.\",\n \"repositoryURLs\": [\"https://github.com/mona/LinkedList\"],\n \"licenseURL\": \"https://www.apache.org/licenses/LICENSE-2.0\",\n \"author\": {\n \"name\": \"Mona Lisa Octocat\"\n }\n}\n\n```\n\nA server MAY allow and/or populate additional metadata for a release.\n\nA server MAY make any properties in the [JSON schema](#appendix-b---package-release-metadata-json-schema)\nand additional metadata it defines required.\n\nIf a client provides an invalid JSON document,\nthe server SHOULD respond with a status code of\n`422` (Unprocessable Entity) or `413` (Payload Too Large)\nand MAY communicate validation error details in the response body.\n\n```http\nHTTP/1.1 422 Unprocessable Entity\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\n\n{\n \"detail\": \"invalid JSON provided for release metadata\"\n}\n```\n\n#### 4.6.3. Synchronous and asynchronous publication\n\nA server MAY respond to a request to publish a new package release\neither synchronously or asynchronously.\n\nA client MAY indicate their preference for asynchronous processing\nwith a `Prefer` header field containing the token `respond-async`\nand an optional `wait` preference,\nas described by [RFC 7240].\n\n```http\nPUT /mona/LinkedList/1.1.1 HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1\nPrefer: respond-async, wait=300\n```\n\n##### 4.6.3.1. Synchronous publication\n\nIf processing is done synchronously,\nthe server MUST respond with a status code of `201` (Created)\nto indicate that the package release was published.\nThis response SHOULD also contain\na `Location` header with a URL to the new release.\n\n```http\nHTTP/1.1 201 Created\nContent-Version: 1\nLocation: https://packages.example.com/github.com/mona/LinkedList/1.1.1\n```\n\nA client MAY set a timeout to guarantee a timely response to each request.\n\n##### 4.6.3.2. Asynchronous publication\n\nIf processing is done asynchronously,\nthe server MUST respond with a status code of `202` (Accepted)\nto acknowledge that the request is being processed.\nThis response MUST contain a `Location` header\nwith a URL that the client can poll for progress updates\nand SHOULD contain a `Retry-After` header\nwith an estimate of when processing is expected to finish.\nA server MAY locate the status resource endpoint at a URI of its choosing.\nHowever,\nthe use of a non-sequential, randomly-generated identifier is RECOMMENDED.\n\n```http\nHTTP/1.1 202 Accepted\nContent-Version: 1\nLocation: https://packages.example.com/submissions/90D8CC77-A576-47AE-A531-D6402C4E33BC\nRetry-After: 120\n```\n\nA client MAY send a `GET` request\nto the location provided by the server in response to a publish request\nto see the current status of that process.\n\n```http\nGET /submissions/90D8CC77-A576-47AE-A531-D6402C4E33BC HTTP/1.1\nHost: packages.example.com\nAccept: application/vnd.swift.registry.v1\n```\n\nIf the asynchronous publish request is still processing,\nthe server SHOULD respond with a status code of `202` (Accepted) and\na `Retry-After` header with an estimate of when processing should finish.\nA server MAY include additional details in the response body.\n\n```http\nHTTP/1.1 202 Accepted\nContent-Version: 1\nContent-Type: application/json\nRetry-After: 120\n\n{\n \"status\": \"Processing (2/3 steps complete)\",\n \"steps\": {\n {\"name\": \"Validate metadata\", \"status\": \"complete\"},\n {\"name\": \"Verify package manifest\", \"status\": \"complete\"},\n {\"name\": \"Scan for vulnerabilities\", \"status\": \"pending\"}\n }\n}\n```\n\nIf the asynchronous publish request is finished processing successfully,\nthe server SHOULD respond with a status code of `301` (Moved Permanently)\nand a `Location` header with a URL to the package release.\n\n```http\nHTTP/1.1 301 Moved Permanently\nContent-Version: 1\nLocation: https://packages.example.com/mona/LinkedList/1.1.1\n```\n\nIf the asynchronous publish request failed,\nthe server SHOULD respond with an appropriate client error status code (`4xx`).\n\n```http\nHTTP/1.1 400 Bad Request\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\nLocation: https://packages.example.com/submissions/90D8CC77-A576-47AE-A531-D6402C4E33BC\n\n{\n \"detail\": \"invalid package\"\n}\n```\n\nA client MAY send a `DELETE` request\nto the location provided by the server in response to a publish request\nto cancel that process.\n\nIf a request to publish a new package release were to fail,\na server MUST communicate that failure in the same way\nif sending an immediate response\nas it would if responding to a client polling for status.\n\nIf a client makes a request to publish a package release\nto a server that is asynchronously processing a request to publish that release,\nthe server MUST respond with a status code of `409` (Conflict)\n\n```http\nHTTP/1.1 409 Conflict\nContent-Version: 1\nContent-Type: application/problem+json\nContent-Language: en\nLocation: https://packages.example.com/submissions/90D8CC77-A576-47AE-A531-D6402C4E33BC\n\n{\n \"detail\": \"already processing a request to publish this package version\"\n}\n```\n\nIf a client makes a request to publish a package release\nto a server that finished processing a failed request to publish that release,\nthe server SHOULD try publishing that release again.\nA server MAY refuse to fulfill a subsequent request to publish a package release\nby responding with a status code of `409` (Conflict).\n\n## 5. Normative References\n\n* [RFC 2119]: Key words for use in RFCs to Indicate Requirement Levels\n* [RFC 3230]: Instance Digests in HTTP\n* [RFC 3986]: Uniform Resource Identifier (URI): Generic Syntax\n* [RFC 3987]: Internationalized Resource Identifiers (IRIs)\n* [RFC 5234]: Augmented BNF for Syntax Specifications: ABNF\n* [RFC 5843]: Additional Hash Algorithms for HTTP Instance Digests\n* [RFC 6249]: Metalink/HTTP: Mirrors and Hashes\n* [RFC 6570]: URI Template\n* [RFC 7159]: The JavaScript Object Notation (JSON) Data Interchange Format\n* [RFC 7230]: Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing\n* [RFC 7231]: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content\n* [RFC 7233]: Hypertext Transfer Protocol (HTTP/1.1): Range Requests\n* [RFC 7234]: Hypertext Transfer Protocol (HTTP/1.1): Caching\n* [RFC 7240]: Prefer Header for HTTP\n* [RFC 7578]: Returning Values from Forms: multipart/form-data\n* [RFC 7807]: Problem Details for HTTP APIs\n* [RFC 8288]: Web Linking\n* [SemVer]: Semantic Versioning\n\n## 6. Informative References\n\n* [BCP 13] Media Type Specifications and Registration Procedures\n* [RFC 6749]: The OAuth 2.0 Authorization Framework\n* [RFC 8446]: The Transport Layer Security (TLS) Protocol Version 1.3\n* [RFC 8631]: Link Relation Types for Web Services\n* [JSON-LD]: A JSON-based Serialization for Linked Data\n* [Schema.org]: A shared vocabulary for structured data.\n* [OAS]: OpenAPI Specification\n\n## Appendix A - OpenAPI Document\n\nThe following [OpenAPI (v3) specification][OAS] is non-normative,\nand is provided for the convenience of\ndevelopers interested in building their own package registry.\n\nSee [registry.openapi.yaml](./registry.openapi.yaml).\n\n## Appendix B - Package Release Metadata JSON Schema\n\nThe `metadata` section of the [create package release request](#46-create-a-package-release)\nmust be a JSON object of type [`PackageRelease`](#packagerelease-type), as defined in the\nJSON schema below.\n\n
\n\nExpand to view JSON schema\n\n```json\n{\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"$id\": \"https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md\",\n \"title\": \"Package Release Metadata\",\n \"description\": \"Metadata of a package release.\",\n \"type\": \"object\",\n \"properties\": {\n \"author\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the author.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"email\",\n \"description\": \"Email address of the author.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"A description of the author.\"\n },\n \"organization\": {\n \"type\": \"object\",\n \"properties\": {\n \"name\": {\n \"type\": \"string\",\n \"description\": \"Name of the organization.\"\n },\n \"email\": {\n \"type\": \"string\",\n \"format\": \"email\",\n \"description\": \"Email address of the organization.\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"A description of the organization.\"\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"URL of the organization.\"\n },\n },\n \"required\": [\"name\"]\n },\n \"url\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"URL of the author.\"\n },\n },\n \"required\": [\"name\"]\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"A description of the package release.\"\n },\n \"licenseURL\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"URL of the package release's license document.\"\n },\n \"originalPublicationTime\": {\n \"type\": \"string\",\n \"format\": \"date-time\",\n \"description\": \"Original publication time of the package release in ISO 8601 format.\"\n },\n \"readmeURL\": {\n \"type\": \"string\",\n \"format\": \"uri\",\n \"description\": \"URL of the README specifically for the package release or broadly for the package.\"\n },\n \"repositoryURLs\": {\n \"type\": \"array\",\n \"description\": \"Code repository URL(s) of the package release.\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"Code repository URL.\"\n }\n }\n }\n}\n```\n\n
\n\n##### `PackageRelease` type\n\n| Property | Type | Description | Required |\n| ------------------------- | :-----------------: | ------------------------------------------------ | :------: |\n| `author` | [Author](#author-type) | Author of the package release. | |\n| `description` | String | A description of the package release. | |\n| `licenseURL` | String | URL of the package release's license document. | |\n| `originalPublicationTime` | String | Original publication time of the package release in [ISO 8601] format. This can be set if the package release was previously published elsewhere.
A registry should record the publication time independently and include it as `publishedAt` in the [package release metadata response](#42-fetch-information-about-a-package-release).
In case both `originalPublicationTime` and `publishedAt` are set, `originalPublicationTime` should be used. | |\n| `readmeURL` | String | URL of the README specifically for the package release or broadly for the package. | |\n| `repositoryURLs` | Array | Code repository URL(s) of the package. It is recommended to include all URL variations (e.g., SSH, HTTPS) for the same repository. This can be an empty array if the package does not have source control representation.
Setting this property is one way through which a registry can obtain repository URL to package identifier mappings for the [\"lookup package identifiers registered for a URL\" API](Registry.md#45-lookup-package-identifiers-registered-for-a-url). A registry may choose other mechanism(s) for package authors to specify such mappings. | |\n\n##### `Author` type\n\n| Property | Type | Description | Required |\n| ----------------- | :-----------------: | ------------------------------------------------ | :------: |\n| `name` | String | Name of the author. | ✓ |\n| `email` | String | Email address of the author. | |\n| `description` | String | A description of the author. | |\n| `organization` | [Organization](#organization-type) | Organization that the author belongs to. | |\n| `url` | String | URL of the author. | |\n\n##### `Organization` type\n\n| Property | Type | Description | Required |\n| ----------------- | :-----------------: | ------------------------------------------------ | :------: |\n| `name` | String | Name of the organization. | ✓ |\n| `email` | String | Email address of the organization. | |\n| `description` | String | A description of the organization. | |\n| `url` | String | URL of the organization. | |\n\n[UAX18]: https://unicode.org/reports/tr18/\n[BCP 13]: https://tools.ietf.org/html/rfc6838 \"Media Type Specifications and Registration Procedures\"\n[RFC 2119]: https://tools.ietf.org/html/rfc2119 \"Key words for use in RFCs to Indicate Requirement Levels\"\n[RFC 3230]: https://tools.ietf.org/html/rfc5843 \"Instance Digests in HTTP\"\n[RFC 3986]: https://tools.ietf.org/html/rfc3986 \"Uniform Resource Identifier (URI): Generic Syntax\"\n[RFC 3987]: https://tools.ietf.org/html/rfc3987 \"Internationalized Resource Identifiers (IRIs)\"\n[RFC 5234]: https://tools.ietf.org/html/rfc5234 \"Augmented BNF for Syntax Specifications: ABNF\"\n[RFC 5843]: https://tools.ietf.org/html/rfc5843 \"Additional Hash Algorithms for HTTP Instance Digests\"\n[RFC 6249]: https://tools.ietf.org/html/rfc6249 \"Metalink/HTTP: Mirrors and Hashes\"\n[RFC 6570]: https://tools.ietf.org/html/rfc6570 \"URI Template\"\n[RFC 6749]: https://tools.ietf.org/html/rfc6749 \"The OAuth 2.0 Authorization Framework\"\n[RFC 7159]: https://tools.ietf.org/html/rfc7159 \"The JavaScript Object Notation (JSON) Data Interchange Format\"\n[RFC 7230]: https://tools.ietf.org/html/rfc7230 \"Hypertext Transfer Protocol (HTTP/1.1): Message Syntax and Routing\"\n[RFC 7231]: https://tools.ietf.org/html/rfc7231 \"Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content\"\n[RFC 7233]: https://tools.ietf.org/html/rfc7233 \"Hypertext Transfer Protocol (HTTP/1.1): Range Requests\"\n[RFC 7234]: https://tools.ietf.org/html/rfc7234 \"Hypertext Transfer Protocol (HTTP/1.1): Caching\"\n[RFC 7240]: https://tools.ietf.org/html/rfc7240 \"Prefer Header for HTTP\"\n[RFC 7578]: https://tools.ietf.org/html/rfc7578 \"Returning Values from Forms: multipart/form-data\"\n[RFC 7807]: https://tools.ietf.org/html/rfc7807 \"Problem Details for HTTP APIs\"\n[RFC 8288]: https://tools.ietf.org/html/rfc8288 \"Web Linking\"\n[RFC 8446]: https://tools.ietf.org/html/rfc8446 \"The Transport Layer Security (TLS) Protocol Version 1.3\"\n[RFC 8631]: https://tools.ietf.org/html/rfc8631 \"Link Relation Types for Web Services\"\n[IANA Link Relations]: https://www.iana.org/assignments/link-relations/link-relations.xhtml\n[JSON-LD]: https://w3c.github.io/json-ld-syntax/ \"JSON-LD 1.1: A JSON-based Serialization for Linked Data\"\n[SemVer]: https://semver.org/ \"Semantic Versioning\"\n[Schema.org]: https://schema.org/\n[SoftwareSourceCode]: https://schema.org/SoftwareSourceCode\n[DUST]: https://doi.org/10.1145/1462148.1462151 \"Bar-Yossef, Ziv, et al. Do Not Crawl in the DUST: Different URLs with Similar Text. Association for Computing Machinery, 17 Jan. 2009. January 2009\"\n[OAS]: https://swagger.io/specification/ \"OpenAPI Specification\"\n[GitHub / Swift Package Management Service]: https://forums.swift.org/t/github-swift-package-management-service/30406\n[RubyGems]: https://rubygems.org \"RubyGems: The Ruby community’s gem hosting service\"\n[PyPI]: https://pypi.org \"PyPI: The Python Package Index\"\n[npm]: https://www.npmjs.com \"The npm Registry\"\n[crates.io]: https://crates.io \"crates.io: The Rust community’s crate registry\"\n[CocoaPods]: https://cocoapods.org \"A dependency manager for Swift and Objective-C Cocoa projects\"\n[thundering herd effect]: https://en.wikipedia.org/wiki/Thundering_herd_problem \"Thundering herd problem\"\n[offline cache]: https://yarnpkg.com/features/offline-cache \"Offline Cache | Yarn - Package Manager\"\n[XCFramework]: https://developer.apple.com/videos/play/wwdc2019/416/ \"WWDC 2019 Session 416: Binary Frameworks in Swift\"\n[SE-0272]: https://github.com/swiftlang/swift-evolution/blob/main/proposals/0272-swiftpm-binary-dependencies.md \"Package Manager Binary Dependencies\"\n[Swift tools version]: https://github.com/swiftlang/swift-package-manager/blob/9b9bed7eaf0f38eeccd0d8ca06ae08f6689d1c3f/Documentation/Usage.md#swift-tools-version-specification \"Swift Tools Version Specification\"\n[ISO 8601]: https://www.iso.org/iso-8601-date-and-time-format.html \"ISO 8601 Date and Time Format\"\n" }, { "path": "Documentation/PackageRegistry/registry.openapi.yaml", "content": "openapi: 3.0.3\ninfo:\n title: Swift Package Registry API\n description: API for managing Swift package releases and interacting with the package registry.\n version: 1.0.0\ntags:\n - name: Releases\n - name: Packages\n - name: Authentication\npaths:\n '/{scope}/{name}':\n parameters:\n - $ref: '#/components/parameters/Scope'\n - $ref: '#/components/parameters/PackageName'\n get:\n tags:\n - Releases\n summary: List package releases\n operationId: listPackageReleases\n responses:\n '200':\n description: Retrieve a list of all available releases for a given package\n headers:\n Link:\n $ref: '#/components/headers/PackageLinks'\n Content-Version:\n $ref: '#/components/headers/ContentVersion'\n content:\n 'application/json':\n schema:\n $ref: '#/components/schemas/Releases'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '404':\n $ref: '#/components/responses/NotFound'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '/{scope}/{name}/{version}':\n parameters:\n - $ref: '#/components/parameters/Scope'\n - $ref: '#/components/parameters/PackageName'\n - $ref: '#/components/parameters/Version'\n get:\n tags:\n - Releases\n summary: Fetch metadata for a package release\n operationId: fetchReleaseMetadata\n responses:\n '200':\n description: Retrieve detailed metadata for a specific package release\n headers:\n Link:\n $ref: '#/components/headers/PackageLinks'\n Content-Version:\n $ref: '#/components/headers/ContentVersion'\n content:\n 'application/json':\n schema:\n $ref: '#/components/schemas/ReleaseMetadata'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '404':\n $ref: '#/components/responses/NotFound'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n put:\n tags:\n - Releases\n summary: Create a package release\n operationId: createPackageRelease\n parameters:\n - in: header\n name: X-Swift-Package-Signature-Format\n description: The signature format if the source archive is signed.\n schema:\n type: string\n example: 'cms-1.0.0'\n - in: header\n name: Prefer\n description: |-\n Communicates the preference for sync vs async processing.\n\n Use \"respond-async\" to get async processing, for example \"respond-async, wait=300\" to wait up to 300 seconds.\n\n Omit this header to prefer sync processing.\n schema:\n type: string\n requestBody:\n description: A multipart payload.\n required: true\n content:\n multipart/form-data:\n schema:\n type: object\n properties:\n source-archive:\n type: string\n format: binary\n description: The binary source archive of the package to be published\n example: 'Binary data for Linked List package release'\n source-archive-signature:\n type: string\n format: binary\n description: The signature for the source archive.\n metadata:\n $ref: '#/components/schemas/PackageMetadata'\n metadata-signature:\n type: string\n format: base64\n description: The signature for the metadata.\n required:\n - source-archive\n encoding:\n source-archive:\n contentType: application/zip\n source-archive-signature:\n contentType: application/octet-stream\n metadata:\n contentType: application/json\n metadata-signature:\n contentType: application/octet-stream\n responses:\n '201':\n description: The package release has been successfully published\n headers:\n Content-Version:\n $ref: '#/components/headers/ContentVersion'\n Location:\n description: The URL to the created release.\n schema:\n type: string\n format: uri\n example: 'https://packages.example.com/github.com/mona/LinkedList/1.1.1'\n content:\n 'application/json':\n schema:\n $ref: '#/components/schemas/PublishResponse'\n '202':\n description: The request to publish the package has been accepted and is being processed\n headers:\n 'Retry-After':\n $ref: '#/components/headers/RetryAfter'\n Location:\n description: |-\n The URL to poll for status of the publication process.\n\n Poll that URL using a `GET` request, and if the response is 202, extract the Retry-After header to get a new estimate\n of when the processing will be finished.\n\n When the response is 301, the processing is finished and the Location header points to the new release.\n\n If the response is 4xx, the processing failed and you can stop polling. The response contains the failure details.\n\n Send `DELETE` to the URL to cancel the processing.\n schema:\n type: string\n format: uri\n description: URL to poll for status of the publication process\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '404':\n $ref: '#/components/responses/NotFound'\n '405':\n description: Method not allowed - publishing is not supported on this server.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n '409':\n description: Conflict - an existing release already exists, or the release is still processing.\n headers:\n Location:\n description: The location of the release that's still processing, see the 202 response for details.\n schema:\n type: string\n format: uri\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n '413':\n description: Content too large.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '422':\n description: Unprocessable entity - refused to publish the release.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '/{scope}/{name}/{version}/Package.swift':\n parameters:\n - $ref: '#/components/parameters/Scope'\n - $ref: '#/components/parameters/PackageName'\n - $ref: '#/components/parameters/Version'\n get:\n tags:\n - Packages\n summary: Fetch manifest for a package release\n operationId: fetchManifestForPackageRelease\n parameters:\n - $ref: '#/components/parameters/SwiftVersion'\n responses:\n '200':\n description: Retrieve the manifest file for the specified package release\n headers:\n Link:\n required: true\n schema:\n type: string\n description: |-\n One value for each version-specific package manifest file in the release's source archive,\n whose filename matches the following regular expression pattern:\n `\\APackage@swift-(\\d+)(?:\\.(\\d+))?(?:\\.(\\d+))?.swift\\z`\n\n Each link value should have the alternate relation type, a filename attribute set to the version-specific package manifest filename\n (for example, Package@swift-4.swift), and a swift-tools-version attribute set to the Swift tools version specified by the package\n manifest file (for example, 4.0 for a manifest beginning with the comment // swift-tools-version:4.0).\n content:\n text/x-swift:\n schema:\n type: string\n '303':\n description: Redirect to the unqualified Package.swift resource.\n headers:\n Location:\n required: true\n schema:\n type: string\n format: uri\n example: 'https://packages.example.com/mona/LinkedList/1.1.1/Package.swift'\n Content-Version:\n $ref: '#/components/headers/ContentVersion'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '404':\n $ref: '#/components/responses/NotFound'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '/{scope}/{name}/{version}.zip':\n parameters:\n - $ref: '#/components/parameters/Scope'\n - $ref: '#/components/parameters/PackageName'\n - $ref: '#/components/parameters/Version'\n get:\n tags:\n - Packages\n summary: Download source archive for a package release\n operationId: downloadSourceArchive\n responses:\n '200':\n description: Download the source archive for the specified package release\n headers:\n Digest:\n description: A digest containing a cryptographic digest of the source archive.\n schema:\n type: string\n example: 'sha-256=oqxUzyX7wa0AKPA/CqS5aDO4O7BaFOUQiSuyfepNyBI='\n Content-Disposition:\n description: |-\n A header set to attachment with a filename parameter equal to the name of the package followed by a hyphen (-),\n the version number, and file extension (for example, \"LinkedList-1.1.1.zip\")\n schema:\n type: string\n example: 'attachment; filename=\"LinkedList-1.1.1.zip\"'\n X-Swift-Package-Signature-Format:\n description: The format of the package signature, used for integrity verification\n schema:\n type: string\n example: 'cms-1.0.0'\n X-Swift-Package-Signature:\n description: Signature of the downloaded package, used for integrity verification\n schema:\n type: string\n format: base64\n example: 'l1TdTeIuGdNsO1FQ0ptD64F5nSSOsQ5WzhM6/7KsHRuLHfTsggnyIWr0DxMcBj5F40zfplwntXAgS0ynlqvlFw=='\n Link:\n description: A header containing mirrors or multiple download locations.\n schema:\n type: string\n description: A Link header with a `duplicate` relation, as described by RFC 6249.\n example: '; rel=duplicate; geo=jp; pri=10; type=\"application/zip\"'\n content:\n application/zip:\n schema:\n type: string\n format: binary\n '303':\n description: See other - download from the URL in the Location header.\n headers:\n Location:\n description: The location from which to download the resource.\n required: true\n schema:\n type: string\n example: 'https://example.cdn.com/LinkedList-1.1.1.zip?key=XXXXXXXXXXXXXXXXX'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '404':\n $ref: '#/components/responses/NotFound'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '/identifiers':\n parameters:\n - $ref: '#/components/parameters/Url'\n get:\n tags:\n - Packages\n summary: Lookup package identifiers registered for a URL\n operationId: lookupPackageIdentifiersByURL\n responses:\n '200':\n description: Retrieve a list of package identifiers registered for a specific URL\n headers:\n Content-Version:\n $ref: '#/components/headers/ContentVersion'\n content:\n 'application/json':\n schema:\n $ref: '#/components/schemas/Identifiers'\n '400':\n $ref: '#/components/responses/BadRequest'\n '401':\n $ref: '#/components/responses/Unauthorized'\n '415':\n $ref: '#/components/responses/UnsupportedMediaType'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '/login':\n post:\n tags:\n - Authentication\n summary: Log in to the package registry\n operationId: loginToRegistry\n description: |-\n Log in using either basic or token authentication. Use the `Authorization` header to provide credentials.\n\n Also use this endpoint to verify authentication credentials before saving them to the local secrets store.\n responses:\n '200':\n description: User successfully logged in to the package registry\n '401':\n $ref: '#/components/responses/Unauthorized'\n '429':\n $ref: '#/components/responses/TooManyRequests'\n '501':\n description: Registry does not support authentication.\ncomponents:\n parameters:\n SwiftVersion:\n name: swift-version\n in: query\n required: false\n description: The Swift version for which to fetch the manifest\n schema:\n type: string\n example: '4.2'\n Scope:\n name: scope\n in: path\n required: true\n description: |-\n The scope of the package (for example, the organization or user).\n Package scopes are case-insensitive.\n schema:\n type: string\n pattern: '[a-zA-Z0-9](?:[a-zA-Z0-9]|-(?=[a-zA-Z0-9])){0,38}'\n example: 'mona'\n PackageName:\n name: name\n in: path\n required: true\n description: |-\n The name of the package.\n Package names are case-insensitive.\n schema:\n type: string\n pattern: '[a-zA-Z0-9](?:[a-zA-Z0-9]|[-_](?=[a-zA-Z0-9])){0,99}'\n example: 'LinkedList'\n Version:\n name: version\n in: path\n required: true\n description: The semantic version of the package release.\n schema:\n type: string\n example: '1.2.3'\n Url:\n name: url\n in: query\n required: true\n description: The URL for which to look up registered package identifiers\n schema:\n type: string\n example: 'https://example.com/mona/LinkedList'\n responses:\n Unauthorized:\n description: Authentication failed due to invalid credentials provided\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n BadRequest:\n description: Bad Request - The request was invalid or cannot be otherwise served\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n NotFound:\n description: Not Found - The specified resource could not be found\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n UnsupportedMediaType:\n description: Unsupported Media Type - Accept header specifies a valid but unsupported API version.\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n TooManyRequests:\n description: Too Many Requests - Rate limit exceeded\n headers:\n 'Retry-After':\n $ref: '#/components/headers/RetryAfter'\n content:\n application/problem+json:\n schema:\n $ref: '#/components/schemas/ProblemDetails'\n headers:\n PackageLinks:\n schema:\n type: string\n description: |-\n A set of related links.\n\n An example:\n ; rel=\"canonical\",\n ; rel=\"alternate\",\n ; rel=\"latest-version\",\n ; rel=\"payment\",\n ; rel=\"first\",\n ; rel=\"previous\",\n ; rel=\"next\",\n ; rel=\"last\"\n\n Another example:\n ; rel=\"latest-version\",\n ; rel=\"predecessor-version\"\n\n Also see:\n - https://www.rfc-editor.org/rfc/rfc6596.html\n - https://html.spec.whatwg.org/multipage/links.html#link-type-alternate\n - https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/PackageRegistry/Registry.md#4-endpoints\n RetryAfter:\n schema:\n type: string\n description: |-\n Retry-After header, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After.\n\n Examples:\n Retry-After: Wed, 21 Oct 2015 07:28:00 GMT\n Retry-After: 120\n example: '120'\n ContentVersion:\n description: The content version.\n required: true\n schema:\n type: integer\n enum:\n - 1\n schemas:\n PackageOrganization:\n type: object\n properties:\n description:\n description: A description of the organization.\n type: string\n email:\n description: Email address of the organization.\n format: email\n type: string\n name:\n description: Name of the organization.\n type: string\n url:\n description: URL of the organization.\n format: uri\n type: string\n required:\n - name\n PackageAuthor:\n type: object\n properties:\n description:\n description: A description of the author.\n type: string\n email:\n description: Email address of the author.\n format: email\n type: string\n name:\n description: Name of the author.\n type: string\n organization:\n $ref: '#/components/schemas/PackageOrganization'\n url:\n description: URL of the author.\n format: uri\n type: string\n required:\n - name\n PackageMetadata:\n type: object\n description: Metadata of a package release.\n properties:\n author:\n $ref: '#/components/schemas/PackageAuthor'\n description:\n type: string\n description: A description of the package release.\n licenseURL:\n type: string\n format: uri\n description: URL of the package release's license document.\n originalPublicationTime:\n type: string\n format: date-time\n description: Original publication time of the package release in ISO 8601 format.\n readmeURL:\n type: string\n format: uri\n description: URL of the README specifically for the package release or broadly\n for the package.\n repositoryURLs:\n type: array\n items:\n description: Code repository URL.\n type: string\n format: uri\n description: Code repository URL(s) of the package release.\n PublishResponse:\n type: object\n properties:\n message:\n type: string\n example: 'Package release successfully published'\n url:\n type: string\n format: uri\n description: The URL of the newly published package release\n example: 'https://packages.example.com/mona/LinkedList/1.1.0'\n ProblemDetails:\n type: object\n description: A problem detail object conforming to RFC7807\n properties:\n type:\n type: string\n format: uri\n description: |-\n A URI reference that identifies the problem type.\n This specification encourages that, when dereferenced,\n it provides human-readable documentation for the problem type.\n example: 'https://example.com/problem/invalid-request-parameters'\n title:\n type: string\n description: |-\n A short, human-readable summary of the problem type.\n It should not change from occurrence to occurrence of the\n problem, except for purposes of localization.\n example: 'Invalid request parameters'\n status:\n type: integer\n description: |-\n The HTTP status code generated by the origin server for this occurrence of the problem.\n example: 400\n detail:\n type: string\n description: A human-readable explanation specific to this occurrence of the problem.\n example: 'The \"name\" field is required.'\n instance:\n type: string\n format: uri\n description: A URI reference that identifies the specific occurrence of the problem.\n example: '/requests/12345'\n additionalProperties: true\n ListedRelease:\n type: object\n properties:\n url:\n type: string\n format: uri\n example: 'https://packages.example.com/mona/LinkedList/1.1.0'\n problem:\n $ref: '#/components/schemas/ProblemDetails'\n Releases:\n type: object\n properties:\n releases:\n type: object\n additionalProperties:\n $ref: '#/components/schemas/ListedRelease'\n required:\n - releases\n ReleaseSignature:\n type: object\n properties:\n signatureBase64Encoded:\n type: string\n format: base64\n description: The resource's signature, base64 encoded.\n example: 'dGVzdFNpZ25hdHVyZQ=='\n signatureFormat:\n type: string\n description: The signature format.\n example: 'cms-1.0.0'\n required:\n - signatureBase64Encoded\n - signatureFormat\n ReleaseResource:\n type: object\n properties:\n name:\n type: string\n description: The name of the resource.\n example: 'source-archive'\n type:\n type: string\n description: The content type of the resource.\n example: 'application/zip'\n checksum:\n type: string\n description: A hexadecimal representation of the SHA256 digest for the resource.\n example: 'efaa6545cd99dd1e124b5269ea0586994b6d97a0443021d2966e1df6dec9c4a1'\n signing:\n $ref: '#/components/schemas/ReleaseSignature'\n required:\n - name\n - type\n - checksum\n ReleaseMetadata:\n type: object\n properties:\n id:\n $ref: '#/components/schemas/Identifier'\n version:\n type: string\n description: The package release version number.\n example: '1.2.3'\n resources:\n type: array\n items:\n $ref: '#/components/schemas/ReleaseResource'\n description: The resources available for the release.\n metadata:\n $ref: '#/components/schemas/PackageMetadata'\n publishedAt:\n type: string\n format: date-time\n description: |-\n The ISO 8601-formatted datetime string of when the package release was published, as recorded by the registry.\n See related `originalPublicationTime` in metadata.\n required:\n - id\n - version\n - resources\n - metadata\n Identifier:\n type: string\n example: 'mona.LinkedList'\n Identifiers:\n type: object\n properties:\n identifiers:\n type: array\n items:\n $ref: '#/components/schemas/Identifier'\n required:\n - identifiers\n" }, { "path": "Documentation/README.md", "content": "# Swift Package Manager\n\nThe documentation previously included here has primarily been migrated into DocC format, and is available for viewing online at Swift.org [Package Manager Docs](https://docs.swift.org/swiftpm/documentation/packagemanagerdocs).\nThe sources for the documentation content are in the [Sources/PackageManagerDocs](Sources/PackageManagerDocs) directory.\n\nFor documentation on developing the Swift Package Manager itself, see the [contribution guide](CONTRIBUTING.md).\n\nThis directory continues to retain legacy [design notes](Design), [release notes](ReleaseNotes), details about\nthe [Package Registry API](PackageRegistry), and [libSwiftPM](libSwiftPM).\n" }, { "path": "Documentation/ReleaseNotes/5.3.md", "content": "# SwiftPM 5.3 Release Notes\n\nSwiftPM brings several new features in version 5.3, all of which are opt-in based on the tools-version.\n\n### Conditional dependencies\n\nYou can now declare conditions for a Swift package’s target dependencies, such as limiting the dependencies by platform. This gives you more flexibility to describe complex target dependencies that support multiple platforms. (40237402)\n\n```swift\n// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"SamplePackage\",\n dependencies: [\n .package(url: \"https://github.com/pureswift/bluetooth\", .branch(\"main\")),\n .package(url: \"https://github.com/pureswift/bluetoothlinux\", .branch(\"main\")),\n ],\n targets: [\n .target(\n name: \"SampleExecutable\",\n dependencies: [\n .product(name: \"Bluetooth\", condition: .when(platforms: [.macOS])),\n .product(name: \"BluetoothLinux\", condition: .when(platforms: [.linux])),\n ]\n ),\n ]\n)\n```\n\n### Resources\n\nSwift packages can now contain resources such as images, asset catalogs, storyboards, and other files. When Xcode builds an app that depends on a package, it adds the package’s code and resources to the app bundle for use at runtime. For more information see [Bundling Resources with a Swift Package](https://developer.apple.com/documentation/swift_packages/bundling_resources_with_a_swift_package). (54361843)\n\nAny resource in the package can now contain localized content. In addition to localized content in asset catalogs, Xcode supports separate localization files in .lproj folders. For more information see [Localizing Package Resources](https://developer.apple.com/documentation/swift_packages/localizing_package_resources). (56925255)\n\n**Important**: The addition of resource support also changed the inclusion behavior for non-source files in packages. Updating a package tools-version to 5.3, means one has to explicitly declare whether to exclude or process any file whose type is unknown to SwiftPM. This can be done at the file or directory level. \n\n### Binary dependencies\n\nSwift packages can now vend prebuilt libraries distributed as XCFrameworks, allowing dependencies on libraries that can’t be distributed as source code. When Xcode builds an app that uses such a package, it embeds the libraries into the app bundle. For more information see [Distributing Binary Frameworks as Swift Packages](https://developer.apple.com/documentation/swift_packages/distributing_binary_frameworks_as_swift_packages). (56592977)\n" }, { "path": "Documentation/ReleaseNotes/5.4.md", "content": "# SwiftPM 5.4 Release Notes\n\nSwiftPM 5.4 includes several improvements, all of which are opt-in based on specifying a tools version of 5.4.\n\n\n### Executable targets\n\nSwift packages that specify a 5.4 tools version can now explicitly declare targets as executable, which allows the use of the `@main` keyword in package code.\n\nThis is done by declaring the target using `executableTarget()` in the package manifest, telling SwiftPM that the target should be considered to be executable regardless of whether it contains a file with a base name of `main`.\n\nThe compiler still applies its usual rules when compiling an executable module, so a single target cannot, for example, have a file named `main.swift` and another file that uses `@main`.\n\n### Automatic test discovery\n\nAutomatic test discovery is now the default on all platforms, removing the need in `LinuxMain.swift`, which has been deprecated. This file is still honored if it is present.\n\n### More flexible tools version formatting\n\n`Package` manifests can now have any combination of leading whitespace characters before the tools version comment. This allows more flexibility in formatting manifests.\n \nSpecifically, the Swift tools version specification in each manifest file now accepts any combination of _horizontal_ whitespace characters surrounding `swift-tools-version`, if and only if the specified version ≥ `5.4`. For example, `//swift-tools-version:\t5.4` and `//\t\t swift-tools-version: 5.4` are valid.\n \nAll [Unicode line terminators](https://www.unicode.org/reports/tr14/) are now recognised in `Package` manifests. This ensures correctness in parsing manifests that are edited and/or built on many non-Unix-like platforms that use ASCII or Unicode encodings. \n\n### Package dependency caching\n\nSwift Package Manager now caches package dependency repositories on a per-user basis, which reduces the amount of network traffic and increases performance of dependency resolution for subsequent uses of the same package.\n\nThe default location of the cache differs depending on the platform, but can be controlled using the new `--cache-path` option. SwiftPM also creates a symbolic link at `~/.swiftpm` referencing the default cache location.\n\nCompiled package manifests are also now cached on a per-user basis. This can be overridden using the new `--manifest-cache` option.\n" }, { "path": "Documentation/ReleaseNotes/5.5.md", "content": "# SwiftPM 5.5 Release Notes\n\n### Package Collections\n\nYou can now use package collections to discover, manage, and publish curated lists of packages. Package collections are authored as static JSON documents and can be published to the web or distributed to local file systems. SwiftPM and Xcode locally share the same package collections, so either interface can manage your added collections.\n\nTo try the official Apple Swift Packages collection, run:\n\n```\nswift package-collection add https://developer.apple.com/swift/packages/collections/apple.json\n```\n\nThen, to see which packages are included in that collection and can now be imported in your code, run:\n\n```\nswift package-collection describe https://developer.apple.com/swift/packages/collections/apple.json\n```\n\nFor more information about usage and how to publish your own package collections, see the [Package Collections documentation](../PackageCollections.md).\n\n### Executable target testing\n\nTest targets can now link against executable targets as if they were libraries, so that they can test any data structures or algorithms in them. All the code in the executable except for the main entry point itself is available to the unit test. Separate executables are still linked, and can be tested as a subprocess in the same way as before. This feature is available to tests defined in packages that have a tools version of `5.5` or newer. (#3316)\n\n### Manifest API improvements\n\nTwo new dependency convenience initializers are now available (#3292, #3310):\n\n```\n.package(url: String, revision: String)\n.package(url: String, branch: String)\n```\n\nTarget-based dependency resolution has also been improved. A more intuitive `.product(name:, package:)` syntax is now accepted, where `package` is the package name as defined by the package URL. (#3280)\n\n### Other improvements\n\n`@main` can now be used in a single-source file executable as long as the name of the source file isn't `main.swift`. To work around special compiler semantics with single-file modules, SwiftPM now passes `-parse-as-library` when compiling an executable module that contains a single Swift source file whose name is not `main.swift`. This feature is available in packages that have a tools version of `5.5` or newer. (#3410)\n\nAn issue where resolution of packages with binary dependencies failed to extract the binary archive was fixed. (#3507)\n" }, { "path": "Documentation/ReleaseNotes/5.6.md", "content": "# SwiftPM 5.6 Release Notes\n\n### Package Plugins\n\n[SE-0303](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md) Introduces the ability to define build tool plugins in SwiftPM, allowing custom tools to be automatically invoked during a build. Build tool plugins are focused on code generation during the build of a package, for such purposes as generating Swift source files from .proto files or from other inputs, in order to allow build tools to be incorporated into the build graph and to run automatically in a safe manner.\n\n[SE-0332](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0332-swiftpm-command-plugins.md) Extends SwiftPM plugin support first introduced with SE-0303 to allow the definition of custom command plugins — plugins that users can invoke directly from the SwiftPM CLI, or from an IDE that supports Swift Packages, in order to perform custom actions on their packages. A command plugin specifies the semantic intent of the command — this might be one of the predefined intents such “documentation generation” or “source code formatting”, or it might be a custom intent with a specialized verb that can be passed to the swift package command.\n\n### Manifest API Improvements\n\nSemantic version dependencies can now be resolved against Git tag names that contain only major and minor version identifiers. A tag with the form `X.Y` will be treated as `X.Y.0`. This improves compatibility with existing repositories.\n\nBoth parsing and comparison of semantic versions now strictly follow the Semantic Versioning 2.0.0 specification (https://semver.org/).\nThe parsing logic now treats the first \"-\" in a version string as the delimiter between the version core and the pre-release identifiers, only if there is no preceding \"+\". Otherwise, it's treated as part of a build metadata identifier.\nThe comparison logic now ignores build metadata identifiers, and treats 2 semantic versions as equal if and only if they're equal in their major, minor, patch versions and pre-release identifiers.\n\n`.package(name:, url:)` dependency syntax is deprecated in favor of `.package(url:)`, given that an explicit name attribute is no longer needed for target dependencies lookup.\n\nAdding a dependency requirement can now be done with the convenience initializer .package(url: String, exact: Version).\n\nDependency requirement enum calling convention is deprecated in favour of labeled argument:\n\n* `.package(url: String, .branch(String)) -> .package(url: String, branch: String)`\n* `.package(url: String, .revision(String)) -> .package(url: String, revision: String)`\n* `.package(url: String, .exact(Version)) -> .package(url: String, exact: Version)`\n\n### Other Improvements\n\nLocation of configuration files (including mirror file) have changed to accommodate new features that require more robust configuration directories structure, such as SE-0292:\n\n* `/.swiftpm/config` (mirrors file) was moved to `/.swiftpm/configuration/mirrors.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.\n* `~/.swiftpm/config/collections.json` (collections file) was moved to `~/.swiftpm/configuration/collections.json`. SwiftPM 5.6 will automatically copy the file from the old location to the new one and emit a warning to prompt the user to delete the file from the old location.\n\nTo increase the security of packages, SwiftPM performs trust on first use (TOFU) validation. The fingerprint of a package is now being recorded when the package is first downloaded from a Git repository or package registry. Subsequent downloads must have fingerprints matching previous recorded values, otherwise it would result in build warnings or failures depending on settings.\n\nIntroduce a second version of `Package.resolved` file format which more accurately captures package identity.\n" }, { "path": "Documentation/ReleaseNotes/5.7.md", "content": "# SwiftPM 5.7 Release Notes\n\n### Package Plugins\n\n[SE-0303: Build tool plugins](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0303-swiftpm-extensible-build-tools.md) and [SE-0332: Command Plugins](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0332-swiftpm-command-plugins.md) which were first introduced in Swift 5.6 have been further refined, with support for generating resources and improved diagnostics. To learn more, refer to the [Getting Started with Plugins](../Plugins.md) guide.\n\n### Package Registry Support\n\nSwiftPM now supports package registry related capabilities introduced by [SE-0292](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0292-package-registry-service.md) and the corresponding [service specification](../Registry.md). With the exception of package publishing, SwiftPM can resolve and download dependencies from any compliant registry using the defined APIs.\n\nTo get started, users will need to specify their package registry by running the `swift package-registry set` subcommand or editing the `registries.json` configuration file. `swift package` tool's `--use-registry-identity-for-scm` and `--replace-scm-with-registry` options might also be of interest.\n \n### Module Aliasing For Disambiguation\n\nModules with the same name from different packages can now be disambiguated by module aliasing [SE-0339](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0339-module-aliasing-for-disambiguation.md). When adding a product dependency for a target in a package manifest, use a new parameter `moduleAliases` to provide a new unique name for a conflicting module.\n\n\n* [#4119] \n \n Add a `--disable-testable-imports` flag to `swift test` with which tests are built without the testability feature (`import @testable` disabled).\n\n" }, { "path": "Documentation/ReleaseNotes/5.8.md", "content": "# SwiftPM 5.8 Release Notes\n\n## Package manifest changes\n\nSwiftPM targets can now specify the upcoming language features they require. `Package.swift` manifest syntax has been expanded with an API to include setting `enableUpcomingFeature` and `enableExperimentalFeature` flags at the target level, as specified by [SE-0362](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0362-piecemeal-future-features.md).\n \nSwiftPM now allows exposing an executable product that consists solely of a binary target that is backed by an artifact bundle. This allows vending binary executables as their own separate package, independently of plugins that are using them.\n\nIn packages using tools version 5.8 or later, `Foundation` is no longer implicitly imported into package manifests. If `Foundation` APIs are used, the module needs to be imported explicitly.\n \n## Package Registry Support\n\nSwiftPM now supports token authentication when interacting with a package registry. The `swift package-registry` command has two new subcommands `login` and `logout` as defined in [SE-0378](https://github.com/swiftlang/swift-evolution/blob/main/proposals/0378-package-registry-auth.md) for adding/removing registry credentials.\n\n## Other improvements\n\nImproved handling of offline behavior when a compatible cached version of a dependency exists on disk in either the per-package or shared cache. SwiftPM will check for network availability status to determine if it should attempt to update a checked version of a dependency, and when offline will use the cached version without an update. \n \nNew `--pkg-config-path` option on `build`, `test`, and `run` commands has been introduced as an alternative to passing `PKG_CONFIG_PATH` environment variable. It allows specifying alternative path to search for `.pc` files used by `pkg-config`. Use the option multiple times to specify more than one path.\n\nAdded new `--emit-extension-block-symbols` and `--omit-extension-block-symbols` via `swift package dump-symbol-graph`. `--emit-extension-block-symbols` dumps symbol graph files that are extension block symbol format. The default behavior does not change. The `--omit-extension-block-symbols` flag will be used to explicitly disable the feature once the default behavior has been changed to `--emit-extension-block-symbols` in the future.\n" }, { "path": "Documentation/ReleaseNotes/5.9.md", "content": "# SwiftPM 5.9 Release Notes\n\n## Cross compilation\n\nSwiftPM now supports cross compilation based on the Swift SDK bundle format. While the feature is still considered experimental, we invite users to try it out and provide feedback.\n\n## Package registry\n\nSwiftPM can now publish to a registry following the specification defined in SE-0391, as well as support signed packages, which may be required by a registry. Trust-on-first-use (TOFU) validation checks can now use signing identities in addition to fingerprints, and are enforced for source archives as well as package manifests.\n\n## Embedded resources\n\nBasic support for a new `.embedInCode` resource rule which allows embedding the contents of the resource into the executable code by generating a byte array\n\n```\nstruct PackageResources {\n static let best_txt: [UInt8] = [104,101,108,108,111,32,119,111,114,108,100,10]\n}\n```\n\n## Other improvements\n\nThe `CompilerPluginSupport` module enables defining macro targets. Macro targets allow authoring and distributing custom Swift macros as APIs in a library.\n\nPackages can use the new `package` access modifier, allowing access of symbols in another target / module within the same package without making them public. SwiftPM automatically sets the new compiler configuration to ensure this feature works out-of-the-box for packages.\n \nThe `allowNetworkConnections(scope:reason:)` setting gives a command plugin permissions to access the network. Permissions can be scoped to Unix domain sockets as well as local or remote IP connections, with an option to limit by port. For non-interactive use cases, the `--allow-network-connections` command-line flag allows network connections for a particular scope.\n\nWhen a package contains a single target, sources may be distributed anywhere within the `./Sources` directory. If sources are placed in a subdirectory under `./Sources/`, or there is more than one target, the existing expectation for sources apply\n\nBuild tool plugins can be used with C-family targets\n" }, { "path": "Documentation/ReleaseNotes/6.3.md", "content": "# SwiftPM 6.3 Release Notes\n\n## SwiftBuild: Preview of Next-Generation Build System\n\nSwiftBuild is being developed to replace the current native build system and brings several key improvements. Packages that build successfully with the existing native (default) build system should build with SwiftBuild without requiring changes to your `Package.swift` or source code.\n\nFor more information, including known limitations and platform-specific issues, see the [SwiftBuild Preview documentation](https://github.com/swiftlang/swift-package-manager/blob/main/Sources/PackageManagerDocs/Documentation.docc/SwiftBuildPreview.md).\n\n\n### Trying SwiftBuild\n\nYou can preview the build system using the `--build-system` flag:\n\n```\n# Use SwiftBuild for building\nswift build --build-system swiftbuild\n\n# Use SwiftBuild for testing\nswift test --build-system swiftbuild\n\n# Use SwiftBuild for running executables\nswift run --build-system swiftbuild MyExecutable\n```\n\nThe native build system remains the default and continues to be fully supported. We encourage developers to try SwiftBuild and [provide feedback](https://github.com/swiftlang/swift-package-manager/issues) on their experience.\n\n## Improved Build Plugin Support for C Interoperability\n\nSwiftPM now properly supports generation of C source files from plugin tools into C module targets.\nIn addition, it supports generation of module maps, header files, and API notes.\n\nThis is an experimental feature. To enable it, add a tag to the swift tools version in the\npackage manifest (Package.swift) of the target that uses the generator plugin as follows:\n\n``` swift\n// swift-tools-version: 6.3;(experimentalCGen)\n```\n\nThere are some limitations to this experimental mode.\nThere can be only one generated module map for a given target.\nHeader files to which this module map refers must be in the same directory as the module map.\nThis is also true for any API notes files generated for modules in the module map.\n\nIf a module map is generated, you can not provide one in the public headers path for the target.\n\nTo assist in finding generated public header files, the build system adds the `include` directory from the plugin output directory\nto the include path for the module and all modules that transitively depend on it.\nThe name of this directory is currently fixed.\n\nThis functionality is available in **both** the native build system and SwiftBuild.\n\n## Improved Prebuilt Swift Syntax for Macros Support\n\nBetter support has been added to use prebuilts of the swift-syntax package in libraries that are only used by macros.\nThis allows for code sharing between macro targets.\n\nSwiftPM now detects when such a library may be used by non macro targets and disables use of prebuilts when this is detected.\nIt is disabled because mixing of swift-syntax prebuilts and swift-syntax built from source at link time has caused a number of issues.\n\n## Symbol Graph Generation: Control Over Inherited Documentation\n\nCommand plugins that generate symbol graphs can now control whether inherited documentation is included, providing better flexibility for different documentation styles.\n\n## Package Traits: Improved Discoverability\n\nA new `swift package show-traits` command makes it easier to discover the traits supported by a package.\n\n" }, { "path": "Documentation/libSwiftPM.md", "content": "# libSwiftPM - SwiftPM as a Library\n\n**NOTE: The libSwiftPM API is currently _unstable_ and may change at any time.**\n\nSwiftPM has a library based architecture and the top-level library product is\ncalled `libSwiftPM`. Other packages can add SwiftPM as a package dependency and\ncreate powerful custom build tools on top of `libSwiftPM`.\n\nA subset of `libSwiftPM` that includes only the data model (without SwiftPM's\nbuild system) is available as `libSwiftPMDataModel`. Any one client should\ndepend on one or the other, but not both.\n\nThe SwiftPM repository contains an [example](https://github.com/swiftlang/swift-package-manager/tree/main/Examples/package-info) that demonstrates the use of\n`libSwiftPM` in a Swift package. Use the following commands to run the example\npackage:\n\n```sh\n$ git clone https://github.com/swiftlang/swift-package-manager\n$ cd swift-package-manager/Examples/package-info\n$ swift run\n```\n" }, { "path": "Examples/package-info/Package.swift", "content": "// swift-tools-version:5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"package-info\",\n platforms: [\n .macOS(.v13),\n .iOS(.v13)\n ],\n dependencies: [\n // This just points to the SwiftPM at the root of this repository.\n .package(name: \"swift-package-manager\", path: \"../../\"),\n // You will want to depend on a stable semantic version instead:\n // .package(url: \"https://github.com/swiftlang/swift-package-manager\", .exact(\"0.4.0\"))\n ],\n targets: [\n .executableTarget(\n name: \"package-info\",\n dependencies: [\n .product(name: \"SwiftPM\", package: \"swift-package-manager\")\n ]\n ),\n ]\n)\n" }, { "path": "Examples/package-info/README.md", "content": "# package-info\n\nSample package built on top of libSwiftPM.\n" }, { "path": "Examples/package-info/Sources/package-info/example.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 - 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\nimport Basics\nimport TSCBasic\nimport Workspace\n\n@main\n@available(macOS 12, iOS 15, tvOS 15, watchOS 8, *)\nstruct Example {\n static func main() async throws {\n // PREREQUISITES\n // ============\n\n // We need a package to work with.\n // This computes the path of this package root based on the file location\n let packagePath = try Basics.AbsolutePath(validating: #file).parentDirectory.parentDirectory.parentDirectory\n\n // LOADING\n // =======\n\n // There are several levels of information available.\n // Each takes longer to load than the level above it, but provides more detail.\n\n let observability = ObservabilitySystem({ print(\"\\($0): \\($1)\") }, outputStream: stdoutStream, logLevel: .debug)\n\n let workspace = try Workspace(forRootPackage: packagePath)\n\n let manifest = try await workspace.loadRootManifest(at: packagePath, observabilityScope: observability.topScope)\n\n let package = try await workspace.loadRootPackage(at: packagePath, observabilityScope: observability.topScope)\n\n let graph = try await workspace.loadPackageGraph(rootPath: packagePath, observabilityScope: observability.topScope)\n\n // EXAMPLES\n // ========\n\n // Manifest\n let products = manifest.products.map({ $0.name }).joined(separator: \", \")\n print(\"Products:\", products)\n\n let targets = manifest.targets.map({ $0.name }).joined(separator: \", \")\n print(\"Targets:\", targets)\n\n // Package\n let executables = package.modules.filter({ $0.type == .executable }).map({ $0.name })\n print(\"Executable targets:\", executables)\n\n // PackageGraph\n let numberOfFiles = graph.reachableModules.reduce(0, { $0 + $1.sources.paths.count })\n print(\"Total number of source files (including dependencies):\", numberOfFiles)\n }\n}\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package1\",\n targets: [\n .executableTarget(\n name: \"Example\",\n dependencies: [\n \"Simple\",\n \"Wrapper\"\n ]\n ),\n .target(\n name: \"Wrapper\",\n dependencies: [\n \"Simple\"\n ]\n ),\n .binaryTarget(\n name: \"Simple\",\n path: \"Simple.artifactbundle\"\n ),\n ]\n)\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/Makefile", "content": "SRC_FILES := $(wildcard *.c)\n\n# Define architectures and platforms\nARCHS := x86_64 arm64\nPLATFORMS := macos linux\n\n# Define output directories\nBUILD_DIR := build\nDIST_DIR := dist\n\n# Platform-specific settings\nMACOS_SDK := $(shell xcrun --sdk macosx --show-sdk-path 2>/dev/null || echo \"\")\nMACOS_MIN_VERSION := 10.15\n\n# Compiler flags\nCOMMON_FLAGS := -O2\n\n# Platform and architecture specific flags\nMACOS_X86_64_FLAGS := -target x86_64-apple-macos$(MACOS_MIN_VERSION) -isysroot $(MACOS_SDK)\nMACOS_ARM64_FLAGS := -target arm64-apple-macos$(MACOS_MIN_VERSION) -isysroot $(MACOS_SDK)\nLINUX_X86_64_FLAGS := -target x86_64-unknown-linux-gnu\nLINUX_ARM64_FLAGS := -target aarch64-unknown-linux-gnu\n\n.PHONY: all clean macos linux universal\n\nall: macos linux\n\n# Create necessary directories\n$(BUILD_DIR):\n\tmkdir -p $(BUILD_DIR)/macos/x86_64\n\tmkdir -p $(BUILD_DIR)/macos/arm64\n\tmkdir -p $(BUILD_DIR)/linux/x86_64\n\tmkdir -p $(BUILD_DIR)/linux/arm64\n\n$(DIST_DIR):\n\tmkdir -p $(DIST_DIR)/macos\n\tmkdir -p $(DIST_DIR)/linux\n\n# macOS x86_64 build\n$(BUILD_DIR)/macos/x86_64/%.o: %.c | $(BUILD_DIR)\n\tclang $(COMMON_FLAGS) $(MACOS_X86_64_FLAGS) -c -o $@ $<\n\n# macOS arm64 build\n$(BUILD_DIR)/macos/arm64/%.o: %.c | $(BUILD_DIR)\n\tclang $(COMMON_FLAGS) $(MACOS_ARM64_FLAGS) -c -o $@ $<\n\n# Linux x86_64 build\n$(BUILD_DIR)/linux/x86_64/%.o: %.c | $(BUILD_DIR)\n\tclang $(COMMON_FLAGS) $(LINUX_X86_64_FLAGS) -c -o $@ $<\n\n# Linux arm64 build\n$(BUILD_DIR)/linux/arm64/%.o: %.c | $(BUILD_DIR)\n\tclang $(COMMON_FLAGS) $(LINUX_ARM64_FLAGS) -c -o $@ $<\n\n# Define object files for each platform and architecture\nMACOS_X86_64_OBJ_FILES := $(patsubst %.c,$(BUILD_DIR)/macos/x86_64/%.o,$(SRC_FILES))\nMACOS_ARM64_OBJ_FILES := $(patsubst %.c,$(BUILD_DIR)/macos/arm64/%.o,$(SRC_FILES))\nLINUX_X86_64_OBJ_FILES := $(patsubst %.c,$(BUILD_DIR)/linux/x86_64/%.o,$(SRC_FILES))\nLINUX_ARM64_OBJ_FILES := $(patsubst %.c,$(BUILD_DIR)/linux/arm64/%.o,$(SRC_FILES))\n\n# Create individual architecture libraries\n$(DIST_DIR)/macos/libSimple_x86_64.a: $(MACOS_X86_64_OBJ_FILES) | $(DIST_DIR)\n\tllvm-ar rc $@ $^\n\n$(DIST_DIR)/macos/libSimple_arm64.a: $(MACOS_ARM64_OBJ_FILES) | $(DIST_DIR)\n\tllvm-ar rc $@ $^\n\n$(DIST_DIR)/linux/libSimple_x86_64.a: $(LINUX_X86_64_OBJ_FILES) | $(DIST_DIR)\n\tllvm-ar rc $@ $^\n\n$(DIST_DIR)/linux/libSimple_arm64.a: $(LINUX_ARM64_OBJ_FILES) | $(DIST_DIR)\n\tllvm-ar rc $@ $^\n\n# Create universal binary for macOS\n$(DIST_DIR)/macos/libSimple.a: $(DIST_DIR)/macos/libSimple_x86_64.a $(DIST_DIR)/macos/libSimple_arm64.a\n\tlipo -create -output $@ $^\n\n# For Linux, we'll provide separate libraries since lipo is macOS-specific\nlinux: $(DIST_DIR)/linux/libSimple_x86_64.a $(DIST_DIR)/linux/libSimple_arm64.a\n\t@echo \"Linux libraries built in $(DIST_DIR)/linux/\"\n\t@echo \"Note: For Linux, use the architecture-specific libraries as needed.\"\n\nmacos: $(DIST_DIR)/macos/libSimple.a\n\t@echo \"macOS universal library built at $(DIST_DIR)/macos/libSimple.a\"\n\nclean:\n\trm -rf $(BUILD_DIR) $(DIST_DIR)\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n products: [\n .library(name: \"Simple\", type: .static, targets: [\"Simple\"]),\n ],\n targets: [\n .target(\n name: \"Simple\",\n path: \".\"\n ),\n ]\n)\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/build.sh", "content": "#!/bin/bash\n\n# currently only used for Windows\n\nrm -fr .build\nswift build --arch arm64 -c release\nswift build --arch x86_64 -c release\n\ncd dist\nrm -fr windows\nmkdir windows\ncd windows\ncp ../../.build/arm64-unknown-windows-msvc/release/libSimple.a Simple_arm64.lib\ncp ../../.build/x86_64-unknown-windows-msvc/release/libSimple.a Simple_x86_64.lib\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/include/simple.h", "content": "int foo(void);\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/include/simple.modulemap", "content": "module Simple {\n header \"simple.h\"\n export *\n}" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/info.json", "content": "{\n \"schemaVersion\": \"1.0\",\n \"artifacts\": {\n \"simple\": {\n \"type\": \"staticLibrary\",\n \"version\": \"1.0.0\",\n \"variants\": [\n {\n \"path\": \"dist/macOS/libSimple.a\",\n \"supportedTriples\": [\"arm64-apple-macosx\", \"x86_64-apple-macosx\"],\n \"staticLibraryMetadata\": {\n \"headerPaths\": [\"include\"],\n \"moduleMapPath\": \"include/simple.modulemap\"\n }\n },\n {\n \"path\": \"dist/linux/libSimple_arm64.a\",\n \"supportedTriples\": [\"aarch64-unknown-linux-gnu\"],\n \"staticLibraryMetadata\": {\n \"headerPaths\": [\"include\"],\n \"moduleMapPath\": \"include/simple.modulemap\"\n }\n },\n {\n \"path\": \"dist/linux/libSimple_x86_64.a\",\n \"supportedTriples\": [\"x86_64-unknown-linux-gnu\"],\n \"staticLibraryMetadata\": {\n \"headerPaths\": [\"include\"],\n \"moduleMapPath\": \"include/simple.modulemap\"\n }\n },\n {\n \"path\": \"dist/windows/Simple_arm64.lib\",\n \"supportedTriples\": [\"aarch64-unknown-windows-msvc\"],\n \"staticLibraryMetadata\": {\n \"headerPaths\": [\"include\"],\n \"moduleMapPath\": \"include/simple.modulemap\"\n }\n },\n {\n \"path\": \"dist/windows/Simple_x86_64.lib\",\n \"supportedTriples\": [\"x86_64-unknown-windows-msvc\"],\n \"staticLibraryMetadata\": {\n \"headerPaths\": [\"include\"],\n \"moduleMapPath\": \"include/simple.modulemap\"\n }\n },\n \n ]\n }\n }\n}\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Simple.artifactbundle/simple.c", "content": "int foo(void) { return 42; }\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Sources/Example/Example.swift", "content": "import Simple\nimport Wrapper\n\n@main\nstruct Example {\n static func main() {\n print(foo())\n print(bar())\n }\n}" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Sources/Wrapper/include/wrapper.h", "content": "int bar(void);\n" }, { "path": "Fixtures/BinaryLibraries/Static/Package1/Sources/Wrapper/wrapper.c", "content": "#include \"simple.h\"\n\nint bar(void) { return foo(); }\n" }, { "path": "Fixtures/BinaryTargets/Inputs/DynamicLibrary/DynamicLibrary.m", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\n#import \"DynamicLibrary.h\"\n\n@implementation DynamicLibrary\n@end\n" }, { "path": "Fixtures/BinaryTargets/Inputs/DynamicLibrary/include/DynamicLibrary.h", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\n#import \n\n@interface DynamicLibrary : NSObject\n@end\n" }, { "path": "Fixtures/BinaryTargets/Inputs/StaticLibrary/StaticLibrary.m", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\n#import \"StaticLibrary.h\"\n\n@implementation StaticLibrary\n@end\n" }, { "path": "Fixtures/BinaryTargets/Inputs/StaticLibrary/include/StaticLibrary.h", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\n#import \n\n@interface StaticLibrary : NSObject\n@end\n" }, { "path": "Fixtures/BinaryTargets/Inputs/SwiftFramework/SwiftFramework/Info.plist", "content": "\n\n\n\n\tCFBundleDevelopmentRegion\n\t$(DEVELOPMENT_LANGUAGE)\n\tCFBundleExecutable\n\t$(EXECUTABLE_NAME)\n\tCFBundleIdentifier\n\t$(PRODUCT_BUNDLE_IDENTIFIER)\n\tCFBundleInfoDictionaryVersion\n\t6.0\n\tCFBundleName\n\t$(PRODUCT_NAME)\n\tCFBundlePackageType\n\t$(PRODUCT_BUNDLE_PACKAGE_TYPE)\n\tCFBundleShortVersionString\n\t1.0\n\tCFBundleVersion\n\t$(CURRENT_PROJECT_VERSION)\n\tNSHumanReadableCopyright\n\tCopyright © 2020 David Hart. All rights reserved.\n\n\n" }, { "path": "Fixtures/BinaryTargets/Inputs/SwiftFramework/SwiftFramework/SwiftFramework.h", "content": "//\n// SwiftFramework.h\n// SwiftFramework\n//\n// Created by David Hart on 17.02.20.\n// Copyright © 2020 David Hart. All rights reserved.\n//\n\n#import \n\n//! Project version number for SwiftFramework.\nFOUNDATION_EXPORT double SwiftFrameworkVersionNumber;\n\n//! Project version string for SwiftFramework.\nFOUNDATION_EXPORT const unsigned char SwiftFrameworkVersionString[];\n\n// In this header, you should import all the public headers of your framework using statements like #import \n\n\n" }, { "path": "Fixtures/BinaryTargets/Inputs/SwiftFramework/SwiftFramework/SwiftFramework.swift", "content": "//\n// SwiftFramework.swift\n// SwiftFramework\n//\n// Created by David Hart on 17.02.20.\n// Copyright © 2020 David Hart. All rights reserved.\n//\n\nimport Foundation\n\npublic struct SwiftFramework {\n public init() {}\n}\n" }, { "path": "Fixtures/BinaryTargets/TestBinary/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TestBinary\",\n dependencies: [\n ],\n targets: [\n .target(name: \"exe\", dependencies: [\"Library\"]),\n .target(name: \"Library\", dependencies: [\"SwiftFramework\"]),\n .target(name: \"cexe\", dependencies: [\"CLibrary\"]),\n .target(name: \"CLibrary\", dependencies: [\"StaticLibrary\", \"DynamicLibrary\"]),\n .binaryTarget(name: \"SwiftFramework\", path: \"SwiftFramework.xcframework\"),\n .binaryTarget(name: \"StaticLibrary\", path: \"StaticLibrary.xcframework\"),\n .binaryTarget(name: \"DynamicLibrary\", path: \"DynamicLibrary.xcframework\"),\n ]\n)\n" }, { "path": "Fixtures/BinaryTargets/TestBinary/Sources/CLibrary/CLibrary.m", "content": "#import \"CLibrary.h\"\n\n@implementation CLibrary\n\n- (instancetype)init {\n self = [super init];\n _staticLibrary = [StaticLibrary new];\n _dynamicLibrary = [DynamicLibrary new];\n return self;\n}\n\n@end" }, { "path": "Fixtures/BinaryTargets/TestBinary/Sources/CLibrary/include/CLibrary.h", "content": "#import \n#import \n\n@interface CLibrary: NSObject\n\n@property (nonatomic, readonly) StaticLibrary* staticLibrary;\n@property (nonatomic, readonly) DynamicLibrary* dynamicLibrary;\n\n@end" }, { "path": "Fixtures/BinaryTargets/TestBinary/Sources/Library/Library.swift", "content": "import SwiftFramework\n\npublic struct Library {\n public let framework = SwiftFramework()\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/BinaryTargets/TestBinary/Sources/cexe/main.m", "content": "#import \n\nint main(int argc, const char* argv[]) {\n\tprintf(\"%s\", [CLibrary new].description.UTF8String);\n}\n" }, { "path": "Fixtures/BinaryTargets/TestBinary/Sources/exe/main.swift", "content": "import SwiftFramework\nimport Library\n\nprint(SwiftFramework())\nprint(Library())\n" }, { "path": "Fixtures/CFamilyTargets/CDynamicLookup/Foo.c", "content": "#include \"Foo.h\"\n\nint foo() {\n bar();\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CDynamicLookup/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CDynamicLookup\",\n targets: [\n .target(name: \"CDynamicLookup\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CDynamicLookup/include/Foo.h", "content": "void bar();\nint foo();\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryNoIncludeDir/Cfactorial/Package.swift", "content": "// swift-tools-version:5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Cfactorial\",\n products: [\n // Products define the executables and libraries a package produces, and make them visible to other packages.\n .library(\n name: \"Cfactorial\",\n targets: [\"Cfactorial\"]),\n ],\n dependencies: [\n // Dependencies declare other packages that this package depends on.\n // .package(url: /* package url */, from: \"1.0.0\"),\n ],\n targets: [\n // Targets are the basic building blocks of a package. A target can define a module or a test suite.\n // Targets can depend on other targets in this package, and on products in packages this package depends on.\n .target(\n name: \"Cfactorial\",\n dependencies: [],\n\t path: \"Sources/factorial\"),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryNoIncludeDir/Cfactorial/Sources/factorial/factorial.c", "content": "//#include \"include/factorial.h\"\n#include \"factorial.h\"\nlong factorial(int n) {\n if (n == 0 || n == 1) return 1;\n return n * factorial(n-1);\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryNoIncludeDir/Cfactorial/Sources/factorial/factorial.h", "content": "#ifndef factorial_h\n#define factorial_h\n\n#include \n\nlong factorial(int n);\n\n#endif /* factorial_h */\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryNoIncludeDir/Package.swift", "content": "// swift-tools-version:5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Client\",\n dependencies: [\n // Dependencies declare other packages that this package depends on.\n // .package(url: /* package url */, from: \"1.0.0\"),\n\t.package(path: \"Cfactorial\")\n ],\n targets: [\n // Targets are the basic building blocks of a package. A target can define a module or a test suite.\n // Targets can depend on other targets in this package, and on products in packages this package depends on.\n .executableTarget(\n name: \"Client\",\n dependencies: [\"Cfactorial\"]),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryNoIncludeDir/Sources/Client/main.swift", "content": "import Cfactorial\n\nprint(factorial(5))\nprint(\"Hello, world!\")\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\nxcuserdata/\nDerivedData/\n.swiftpm/config/registries.json\n.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata\n.netrc\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/Package.swift", "content": "// swift-tools-version: 5.5\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CLibraryParentSearchPath\",\n products: [\n .library(\n name: \"HeaderInclude\",\n targets: [\"HeaderInclude\"]),\n ],\n targets: [\n .target(\n name: \"CHeaderInclude\",\n cSettings: [\n /*\n This package tests path normalization; incorrect path normalization on certain OSes (especially Windows) can lead to relative paths like these not being correctly passed to the C compiler.\n */\n .headerSearchPath(\"../Constants\")\n ]\n ),\n .target(\n name: \"HeaderInclude\",\n dependencies: [\n \"CHeaderInclude\"\n ]\n )\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/Sources/CHeaderInclude/answers.c", "content": "\n#include \"answers.h\"\n#include \"Constants.h\"\n\nint getAnswer(void) {\n return kTheAnswer;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/Sources/CHeaderInclude/include/answers.h", "content": "\n#ifndef answers_h\n#define answers_h\n\nextern int getAnswer(void);\n\n#endif /* answers_h */\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/Sources/Constants/Constants.h", "content": "\n#ifndef Constants_h\n#define Constants_h\n\nstatic const int kTheAnswer = 42;\n\n#endif /* Constants_h */\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryParentSearchPath/Sources/HeaderInclude/FinalForm.swift", "content": "\nimport CHeaderInclude\n\nenum Answer {\n var value: Int { Int(getAnswer()) }\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibrarySources/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CLibrarySources\",\n targets: [\n .target(name: \"CLibrarySources\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CLibrarySources/Sources/Foo.c", "content": "#include \"Foo.h\"\n\nint foo() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibrarySources/Sources/include/Foo.h", "content": "int foo();\n" }, { "path": "Fixtures/CFamilyTargets/CLibrarySources/Tests/CLibrarySourcesTests/foo.swift", "content": "" }, { "path": "Fixtures/CFamilyTargets/CLibrarySources/Tests/LinuxMain.swift", "content": "" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CLibraryWithSpaces\",\n targets: [\n .target(name: \"Bar\", dependencies: [\"Foo\"]),\n .target(name: \"Baz\", dependencies: [\"Foo\", \"Bar\"]),\n .target(name: \"Foo\", dependencies: []),\n .target(name: \"Bar with spaces\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Bar/Bar.c", "content": "#include \"Bar/Bar.h\"\n#include \"Foo/Foo.h\"\n\nint bar() {\n int a = foo();\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Bar/include/Bar/Bar.h", "content": "int bar();\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Bar with spaces/Bar.c", "content": "int bar() {\n return 5;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Bar with spaces/include/Bar/Bar.h", "content": "int bar();\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Baz/main.swift", "content": "import Foo\nimport Bar\n\nlet _ = foo()\nlet _ = bar()\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Foo/Foo.c", "content": "#include \"Foo/Foo.h\"\n\nint foo() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/CLibraryWithSpaces/Sources/Foo/include/Foo/Foo.h", "content": "int foo();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ModuleMapGenerationCases\",\n targets: [\n\t\t.target(\n name: \"Baz\",\n dependencies: [\"CustomModuleMap\", \"FlatInclude\", \"NonModuleDirectoryInclude\", \"UmbrellaHeader\", \"UmbrellaDirectoryInclude\", \"UmbrellaHeaderFlat\"]),\n .target(\n name: \"CustomModuleMap\",\n dependencies: []),\n\t\t.target(\n name: \"FlatInclude\",\n dependencies: []),\n\t\t.target(\n name: \"NoIncludeDir\",\n dependencies: []),\n\t\t.target(\n name: \"NonModuleDirectoryInclude\",\n dependencies: []),\n\t\t.target(\n name: \"UmbrellaDirectoryInclude\",\n dependencies: []),\n\t\t.target(\n name: \"UmbrellaHeader\",\n dependencies: []),\n\t\t.target(\n name: \"UmbrellaHeaderFlat\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/Baz/main.swift", "content": "import CustomModuleMap\nimport UmbrellaDirectoryInclude\nimport FlatInclude\nimport UmbrellaHeader\nimport UmbrellaHeaderFlat\n\nlet _ = foo()\nlet _ = bar()\nlet _ = jaz()\nlet _ = umbrellaHeaderFlat()\nlet _ = qux()\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/CustomModuleMap/CustomModuleMap.c", "content": "#include \"CustomModuleMap.h\"\n\nint qux() {\n int a = 6;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/CustomModuleMap/include/CustomModuleMap.h", "content": "int qux();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/CustomModuleMap/include/module.modulemap", "content": "module CustomModuleMap {\n header \"CustomModuleMap.h\"\n\n export *\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/FlatInclude/FlatInclude.c", "content": "#include \"FlatIncludeHeader.h\"\n\nint bar() {\n int a = 6;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/FlatInclude/include/FlatIncludeHeader.h", "content": "int bar();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/NoIncludeDir/Jaz.c", "content": "\nint noDir() {\n int a = 6;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/NonModuleDirectoryInclude/Maz.c", "content": "#include \"NonModuleDirectoryInclude/Maz.h\"\n\nint maz() {\n int a = 6;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/NonModuleDirectoryInclude/include/NonModuleDirectoryInclude/Maz.h", "content": "int jaz();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaDirectoryInclude/Jaz.c", "content": "#include \"Paz.h\"\n\nint jaz() {\n int a = 6;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaDirectoryInclude/include/Paz.h", "content": "int jaz();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaHeader/UmbrellaHeader.c", "content": "#include \"UmbrellaHeader/UmbrellaHeader.h\"\n\nint foo() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaHeader/include/UmbrellaHeader/UmbrellaHeader.h", "content": "int foo();\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaHeaderFlat/UmbrellaHeader.c", "content": "#include \"UmbrellaHeaderFlat.h\"\n\nint umbrellaHeaderFlat() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/ModuleMapGenerationCases/Sources/UmbrellaHeaderFlat/include/UmbrellaHeaderFlat.h", "content": "int umbrellaHeaderFlat();\n" }, { "path": "Fixtures/CFamilyTargets/ObjCmacOSPackage/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ObjCmacOSPackage\",\n targets: [\n .target(name: \"ObjCmacOSPackage\", path: \"Sources\"),\n .testTarget(name: \"ObjCmacOSPackageTests\", dependencies: [\"ObjCmacOSPackage\"]),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/ObjCmacOSPackage/Sources/HelloWorldExample.m", "content": "#import \n#import \"HelloWorldExample.h\"\n\n@implementation HelloWorld\n- (NSString *)hello:(NSString *)name {\n if(!name) {\n name = @\"World\";\n }\n return [NSString stringWithFormat:@\"Hello, %@!\", name];\n}\n@end\n" }, { "path": "Fixtures/CFamilyTargets/ObjCmacOSPackage/Sources/include/HelloWorldExample.h", "content": "#import \n\n@interface HelloWorld : NSObject\n\n- (NSString *)hello:(NSString *)name;\n\n@end\n" }, { "path": "Fixtures/CFamilyTargets/ObjCmacOSPackage/Tests/ObjCmacOSPackageTests/HelloWorldTest.m", "content": "#import \n\n# import \"HelloWorldExample.h\"\n\n@interface HelloWorldTest : XCTestCase\n\n@end\n\n@implementation HelloWorldTest\n\n- (HelloWorld *)helloWorld {\n return [[HelloWorld alloc] init];\n}\n\n- (void)testNoName {\n NSString *input = nil;\n NSString *expected = @\"Hello, World!\";\n NSString *result = [[self helloWorld] hello:input];\n XCTAssertEqualObjects(expected, result);\n}\n\n- (void)testSampleName {\n NSString *input = @\"Alice\";\n NSString *expected = @\"Hello, Alice!\";\n NSString *result = [[self helloWorld] hello:input];\n XCTAssertEqualObjects(expected, result);\n}\n \n- (void)testOtherSampleName {\n NSString *input = @\"Bob\";\n NSString *expected = @\"Hello, Bob!\";\n NSString *result = [[self helloWorld] hello:input];\n XCTAssertEqualObjects(expected, result);\n}\n\n@end\n" }, { "path": "Fixtures/CFamilyTargets/SwiftCMixed/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftCMixed\",\n targets: [\n .target(name: \"SeaExec\", dependencies: [\"SeaLib\"]),\n .target(name: \"CExec\", dependencies: [\"SeaLib\"]),\n .target(name: \"SeaLib\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/CFamilyTargets/SwiftCMixed/Sources/CExec/main.c", "content": "#include \"Foo.h\"\n#include\n\nint main() {\n printf(\"%d\", foo(5));\n return 0;\n}\n" }, { "path": "Fixtures/CFamilyTargets/SwiftCMixed/Sources/SeaExec/main.swift", "content": "import SeaLib\n\nlet a = foo(5)\nprint(\"a = \\(a)\")\n\n" }, { "path": "Fixtures/CFamilyTargets/SwiftCMixed/Sources/SeaLib/Foo.c", "content": "int foo(int a) {\n return a;\n}\n" }, { "path": "Fixtures/CFamilyTargets/SwiftCMixed/Sources/SeaLib/include/Foo.h", "content": "int foo(int a);\n" }, { "path": "Fixtures/Collections/GitHub/contributors.json", "content": "[\n {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false,\n \"contributions\": 32\n }\n]\n" }, { "path": "Fixtures/Collections/GitHub/languages.json", "content": "{\n \"Swift\": 3836385,\n \"Shell\": 96027,\n \"C\": 87433,\n}\n" }, { "path": "Fixtures/Collections/GitHub/license.json", "content": "{\n \"name\": \"LICENSE\",\n \"path\": \"LICENSE\",\n \"sha\": \"401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"size\": 1077,\n \"url\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=main\",\n \"html_url\": \"https://github.com/benbalter/gman/blob/main/LICENSE\",\n \"git_url\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"download_url\": \"https://raw.githubusercontent.com/benbalter/gman/main/LICENSE?lab=true\",\n \"type\": \"file\",\n \"content\": \"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\n \"encoding\": \"base64\",\n \"_links\": {\n \"self\": \"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=main\",\n \"git\": \"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\n \"html\": \"https://github.com/benbalter/gman/blob/main/LICENSE\"\n },\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n }\n}\n" }, { "path": "Fixtures/Collections/GitHub/metadata.json", "content": "{\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"forks\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"watchers\": 80,\n \"size\": 108,\n \"default_branch\": \"main\",\n \"open_issues_count\": 0,\n \"open_issues\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"pull\": true,\n \"push\": false,\n \"admin\": false\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"spdx_id\": \"MIT\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n },\n \"organization\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"Organization\",\n \"site_admin\": false\n },\n \"parent\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"main\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1\n },\n \"source\": {\n \"id\": 1296269,\n \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n \"name\": \"Hello-World\",\n \"full_name\": \"octocat/Hello-World\",\n \"owner\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"private\": false,\n \"html_url\": \"https://github.com/octocat/Hello-World\",\n \"description\": \"This your first repo!\",\n \"fork\": false,\n \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n \"homepage\": \"https://github.com\",\n \"language\": null,\n \"forks_count\": 9,\n \"stargazers_count\": 80,\n \"watchers_count\": 80,\n \"size\": 108,\n \"default_branch\": \"main\",\n \"open_issues_count\": 0,\n \"is_template\": true,\n \"topics\": [\n \"octocat\",\n \"atom\",\n \"electron\",\n \"api\"\n ],\n \"has_issues\": true,\n \"has_projects\": true,\n \"has_wiki\": true,\n \"has_pages\": false,\n \"has_downloads\": true,\n \"archived\": false,\n \"disabled\": false,\n \"visibility\": \"public\",\n \"pushed_at\": \"2011-01-26T19:06:43Z\",\n \"created_at\": \"2011-01-26T19:01:12Z\",\n \"updated_at\": \"2011-01-26T19:14:43Z\",\n \"permissions\": {\n \"admin\": false,\n \"push\": false,\n \"pull\": true\n },\n \"allow_rebase_merge\": true,\n \"template_repository\": null,\n \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n \"allow_squash_merge\": true,\n \"delete_branch_on_merge\": true,\n \"allow_merge_commit\": true,\n \"subscribers_count\": 42,\n \"network_count\": 0,\n \"license\": {\n \"key\": \"mit\",\n \"name\": \"MIT License\",\n \"url\": \"https://api.github.com/licenses/mit\",\n \"spdx_id\": \"MIT\",\n \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n \"html_url\": \"https://api.github.com/licenses/mit\"\n },\n \"forks\": 1,\n \"open_issues\": 1,\n \"watchers\": 1\n }\n}\n" }, { "path": "Fixtures/Collections/GitHub/readme.json", "content": "{\n \"type\": \"file\",\n \"encoding\": \"base64\",\n \"size\": 5362,\n \"name\": \"README.md\",\n \"path\": \"README.md\",\n \"content\": \"encoded content ...\",\n \"sha\": \"3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"url\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"git_url\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"html_url\": \"https://github.com/octokit/octokit.rb/blob/main/README.md\",\n \"download_url\": \"https://raw.githubusercontent.com/octokit/octokit.rb/main/README.md\",\n \"_links\": {\n \"git\": \"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\n \"self\": \"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\n \"html\": \"https://github.com/octokit/octokit.rb/blob/main/README.md\"\n }\n}\n" }, { "path": "Fixtures/Collections/GitHub/releases.json", "content": "[\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"v2.0.0\",\n \"target_commitish\": \"main\",\n \"name\": \"2.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n },\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1\",\n \"html_url\": \"https://github.com/octocat/Hello-World/releases/v1.0.0\",\n \"assets_url\": \"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\n \"upload_url\": \"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\n \"tarball_url\": \"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\n \"zipball_url\": \"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\n \"id\": 1,\n \"node_id\": \"MDc6UmVsZWFzZTE=\",\n \"tag_name\": \"1.0.0\",\n \"target_commitish\": \"main\",\n \"name\": \"1.0.0\",\n \"body\": \"Description of the release\",\n \"draft\": false,\n \"prerelease\": false,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"published_at\": \"2013-02-27T19:35:32Z\",\n \"author\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n },\n \"assets\": [\n {\n \"url\": \"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\n \"browser_download_url\": \"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\n \"id\": 1,\n \"node_id\": \"MDEyOlJlbGVhc2VBc3NldDE=\",\n \"name\": \"example.zip\",\n \"label\": \"short description\",\n \"state\": \"uploaded\",\n \"content_type\": \"application/zip\",\n \"size\": 1024,\n \"download_count\": 42,\n \"created_at\": \"2013-02-27T19:35:32Z\",\n \"updated_at\": \"2013-02-27T19:35:32Z\",\n \"uploader\": {\n \"login\": \"octocat\",\n \"id\": 1,\n \"node_id\": \"MDQ6VXNlcjE=\",\n \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n \"gravatar_id\": \"\",\n \"url\": \"https://api.github.com/users/octocat\",\n \"html_url\": \"https://github.com/octocat\",\n \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n \"type\": \"User\",\n \"site_admin\": false\n }\n }\n ]\n }\n]\n" }, { "path": "Fixtures/Collections/JSON/good.json", "content": "{\n \"name\": \"Sample Package Collection\",\n \"overview\": \"This is a sample package collection listing made-up packages.\",\n \"keywords\": [\"sample package collection\"],\n \"formatVersion\": \"1.0\",\n \"revision\": 3,\n \"generatedAt\": \"2020-10-22T06:03:52Z\",\n \"generatedBy\": {\n \"name\": \"Jane Doe\"\n },\n \"packages\": [\n {\n \"url\": \"https://www.example.com/repos/RepoOne.git\",\n \"identity\": \"repos.one\",\n \"summary\": \"Package One\",\n \"keywords\": [\"sample package\"],\n \"readmeURL\": \"https://www.example.com/repos/RepoOne/README\",\n \"license\": {\n \"name\": \"Apache-2.0\",\n \"url\": \"https://www.example.com/repos/RepoOne/LICENSE\"\n },\n \"versions\": [\n {\n \"version\": \"0.1.0\",\n \"summary\": \"Fixed a few bugs\",\n \"manifests\": {\n \"5.1\": {\n \"toolsVersion\": \"5.1\",\n \"packageName\": \"PackageOne\",\n \"targets\": [\n {\n \"name\": \"Foo\",\n \"moduleName\": \"Foo\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Foo\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Foo\"]\n }\n ],\n \"minimumPlatformVersions\": [\n { \"name\": \"macOS\", \"version\": \"10.15\" }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.1\",\n \"verifiedCompatibility\": [\n {\n \"platform\": { \"name\": \"macOS\" },\n \"swiftVersion\": \"5.1\"\n },\n {\n \"platform\": { \"name\": \"iOS\" },\n \"swiftVersion\": \"5.1\"\n },\n {\n \"platform\": { \"name\": \"Linux\" },\n \"swiftVersion\": \"5.1\"\n }\n ],\n \"license\": {\n \"name\": \"Apache-2.0\",\n \"url\": \"https://www.example.com/repos/RepoOne/LICENSE\"\n },\n \"author\": {\n \"name\": \"J. Appleseed\"\n },\n \"signer\": {\n \"type\": \"ADP\",\n \"commonName\": \"J. Appleseed\",\n \"organizationalUnitName\": \"A1\",\n \"organizationName\": \"Appleseed Inc.\"\n },\n \"createdAt\": \"2020-10-21T09:25:36Z\"\n }\n ]\n },\n {\n \"url\": \"https://www.example.com/repos/RepoTwo.git\",\n \"summary\": \"Package Two\",\n \"readmeURL\": \"https://www.example.com/repos/RepoTwo/README\",\n \"versions\": [\n {\n \"version\": \"2.1.0\",\n \"manifests\": {\n \"5.2\": {\n \"toolsVersion\": \"5.2\",\n \"packageName\": \"PackageTwo\",\n \"targets\": [\n {\n \"name\": \"Bar\",\n \"moduleName\": \"Bar\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Bar\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Bar\"]\n }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.2\"\n },\n {\n \"version\": \"v1.8.3\",\n \"manifests\": {\n \"5.0\": {\n \"toolsVersion\": \"5.0\",\n \"packageName\": \"PackageTwo\",\n \"targets\": [\n {\n \"name\": \"Bar\",\n \"moduleName\": \"Bar\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Bar\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Bar\"]\n }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.0\"\n }\n ]\n }\n ]\n}\n" }, { "path": "Fixtures/Collections/JSON/good_signed.json", "content": "{\n \"name\": \"Sample Package Collection\",\n \"overview\": \"This is a sample package collection listing made-up packages.\",\n \"keywords\": [\"sample package collection\"],\n \"formatVersion\": \"1.0\",\n \"revision\": 3,\n \"generatedAt\": \"2020-10-22T06:03:52Z\",\n \"generatedBy\": {\n \"name\": \"Jane Doe\"\n },\n \"packages\": [\n {\n \"url\": \"https://www.example.com/repos/RepoOne.git\",\n \"identity\": \"repos.one\",\n \"summary\": \"Package One\",\n \"keywords\": [\"sample package\"],\n \"readmeURL\": \"https://www.example.com/repos/RepoOne/README\",\n \"license\": {\n \"name\": \"Apache-2.0\",\n \"url\": \"https://www.example.com/repos/RepoOne/LICENSE\"\n },\n \"versions\": [\n {\n \"version\": \"0.1.0\",\n \"summary\": \"Fixed a few bugs\",\n \"manifests\": {\n \"5.1\": {\n \"toolsVersion\": \"5.1\",\n \"packageName\": \"PackageOne\",\n \"targets\": [\n {\n \"name\": \"Foo\",\n \"moduleName\": \"Foo\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Foo\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Foo\"]\n }\n ],\n \"minimumPlatformVersions\": [\n { \"name\": \"macOS\", \"version\": \"10.15\" }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.1\",\n \"verifiedCompatibility\": [\n {\n \"platform\": { \"name\": \"macOS\" },\n \"swiftVersion\": \"5.1\"\n },\n {\n \"platform\": { \"name\": \"iOS\" },\n \"swiftVersion\": \"5.1\"\n },\n {\n \"platform\": { \"name\": \"Linux\" },\n \"swiftVersion\": \"5.1\"\n }\n ],\n \"license\": {\n \"name\": \"Apache-2.0\",\n \"url\": \"https://www.example.com/repos/RepoOne/LICENSE\"\n },\n \"author\": {\n \"name\": \"J. Appleseed\"\n },\n \"signer\": {\n \"type\": \"ADP\",\n \"commonName\": \"J. Appleseed\",\n \"organizationalUnitName\": \"A1\",\n \"organizationName\": \"Appleseed Inc.\"\n },\n \"createdAt\": \"2020-10-21T09:25:36Z\"\n }\n ]\n },\n {\n \"url\": \"https://www.example.com/repos/RepoTwo.git\",\n \"summary\": \"Package Two\",\n \"readmeURL\": \"https://www.example.com/repos/RepoTwo/README\",\n \"versions\": [\n {\n \"version\": \"2.1.0\",\n \"manifests\": {\n \"5.2\": {\n \"toolsVersion\": \"5.2\",\n \"packageName\": \"PackageTwo\",\n \"targets\": [\n {\n \"name\": \"Bar\",\n \"moduleName\": \"Bar\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Bar\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Bar\"]\n }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.2\"\n },\n {\n \"version\": \"v1.8.3\",\n \"manifests\": {\n \"5.0\": {\n \"toolsVersion\": \"5.0\",\n \"packageName\": \"PackageTwo\",\n \"targets\": [\n {\n \"name\": \"Bar\",\n \"moduleName\": \"Bar\"\n }\n ],\n \"products\": [\n {\n \"name\": \"Bar\",\n \"type\": {\n \"library\": [\"automatic\"]\n },\n \"targets\": [\"Bar\"]\n }\n ]\n }\n },\n \"defaultToolsVersion\": \"5.0\"\n }\n ]\n }\n ],\n \"signature\": {\n \"signature\": \"\",\n \"certificate\": {\n \"subject\": {\n \"commonName\": \"Sample Subject\"\n },\n \"issuer\": {\n \"commonName\": \"Sample Issuer\"\n }\n }\n }\n}\n" }, { "path": "Fixtures/Collections/Signing/Test_ec_key.pem", "content": "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIFyZDwhGj2Q6ZchEt6DIQSptRk9yKPo60JH5x4u3p4YmoAoGCCqGSM49\nAwEHoUQDQgAEHg58TCXScU6zXSYygCNW0tBZeYFRWf3XAjaDJUkeEFUvKxiIcP8S\nsLfb8P9mukwJsj2CwfatwneFIUQGJ4P+SQ==\n-----END EC PRIVATE KEY-----\n" }, { "path": "Fixtures/Collections/Signing/Test_rsa_key.pem", "content": "-----BEGIN RSA PRIVATE KEY-----\nMIIEowIBAAKCAQEAk1a/7/deGbDnbe9K8/LzN7fkx4D0kzCHIBlCuSylKOJKiPQ5\nMHH13IXAKJYbudkufYdbACTo/4xjgvWLWI/C/ycbNfEGTPd0r6ahS9LRljgGaCVr\neK4Jqg4VHIuC5B2fTQ5Tuv4k16JhKXuD/hCZ1my96Xwt2HPniRu9cIJFxlAz/1Fj\nbotlL6EbUzzZ7msNLdXEm7QWUIuCN48z1FKk/uapAewzjq1r3X4+pWmEJSi+2tyS\n5K03bmH+SE63fBui6o4dzeCrOblGQxqyqnR0mHOKe5rHU8Y5LVmkam/wyiRGTrmT\nOywsDhRtTyI0EZEp194C7QdLxiksGnl0wt/ArQIDAQABAoIBAG/1AD4QwrFU6lZv\n+Y1rNANHuhEa3T2nJ1Ztu3TIBuwNH8P3iClWvxMFkyGEBqdu71O1caGnamEcxVTy\nziLKgsqtZZDUiAweEM2UGYZrOJUkF0I2BPcbj/5nWwVowVojZDQCSf+SNF6iZaBG\n2eJJrQvxb1Gm6ZNLZ0mZCZcfdnOcwOwubGYGjoJV7qXRhs4kCfZMmA7g8MkQ0FBu\n3fLmD2MMjWqJA2kgnYVf27BfoZrEJBfWSAQ5SKOeSnH7UqTF+L/HTrXJJnpjIY5i\nXr/+lJ7BiOHHouP8dwbggjCmkrcGwcwE7PULyhycty5DOnSpGT2ktElyeqivxPVl\nNqm3U+ECgYEAw8bsQrYrZoSGsmUBFQ29z+S402TJyTOF14PinkfEyF2Gmel0024A\n1pY7eTrmlHJMBooy4IgdkLjKnaFMd98H+jcOpfX7dXXE+cCLAs9CA3HCeP5hsOl/\nPduswEahqne58v/FcGDdc66Jf6bCb3sOcIku4vxKiInbbtv8hjvpCcUCgYEAwKlp\nKQZ072QP4cNil+ITZjlf5xhihHUudL6BLfiR3BxQhtDqk/23rbEB69yl5JkSoYA8\n4T86Gdhnfe6lKHmWbgBN54tcoaesH8yKfTFvZZfbhENfV0gxXXpxdvjM1/1peRVK\n0CJsDAEvyREKhD4nuWv50vqMBK+HjD9gYANNEckCgYBbCMKPernPn8wqY8EPEyax\n5r7yvSj/P8/6mL7lrqWYLbULGH1UWxBUt+LLylGxsTwcxmJF+cUVqHe+uGQgUTsa\nZEORdEILKkn/gEKjedBOXbV6IX83jju2fdFkTvOZmraCgeBDEyemRQB2tQowYF4k\nggWlUn8t4jyA3hYcLPt9qQKBgQCDIsyxX/O3/iPRR2yUdQ0/R04/vhlQj3JPhFvp\nLogZiixFl24TzV54m0Lzh/xi3M4Rn3fQ2XhynxnSXd2M7zW1Kf/c2r7ySW6fNloN\nXNi2Decc377Fah4vwmf40uCbI6HnCNcjVEq24Rflg/Pkj2n6i8RAFsm3ZsKcc4bl\n01liAQKBgBTPtA4M3/TpKDwuPedsmzumSe1Rmn4QSAd0ssrQ9XoPHYw2RkBSpCQg\n1HYM/lD21uBr66nAtqpByiNILTQm1LiitBSnC9jOjpoM+ECqMyYPwfU9AD7weYlX\nqjLG9mzvjAEa7bzjweN77Mox4LDf6rEiAcs9ObceElEwN8W1g+63\n-----END RSA PRIVATE KEY-----\n" }, { "path": "Fixtures/Coverage/Simple/Package.swift", "content": "// swift-tools-version: 6.2\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n products: [\n // Products define the executables and libraries a package produces, making them visible to other packages.\n .library(\n name: \"Simple\",\n targets: [\"Simple\"]\n ),\n ],\n targets: [\n // Targets are the basic building blocks of a package, defining a module or a test suite.\n // Targets can depend on other targets in this package and products from dependencies.\n .target(\n name: \"Simple\"\n ),\n .testTarget(\n name: \"SimpleTests\",\n dependencies: [\"Simple\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/Coverage/Simple/Sources/Simple/Simple.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\npublic func greet(name: String = \"world\") -> String {\n return \"Hello, \\(name)!\"\n}\n\npublic func libA() -> String {\n return \"libA\"\n}\n" }, { "path": "Fixtures/Coverage/Simple/Tests/SimpleTests/SimpleTests.swift", "content": "import Testing\nimport XCTest\n@testable import Simple\n\n@Test(\n arguments: [\n \"Bob\",\n \"Alice\",\n \"\",\n ]\n)\n func testGreet(\n name: String\n ) async throws {\n let actual = greet(name: name)\n\n #expect(actual == \"Hello, \\(name)!\")\n}\n\nfinal class SimpleTests: XCTestCase {\n func testExample() throws {\n XCTAssertEqual(libA(), \"libA\", \"Actual is not as expected\")\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Branch/Bar/Package.swift", "content": "// swift-tools-version:5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n // Products define the executables and libraries a package produces, and make them visible to other packages.\n .library(\n name: \"Bar\",\n targets: [\"Bar\"]),\n ],\n dependencies: [\n // Dependencies declare other packages that this package depends on.\n // .package(url: /* package url */, from: \"1.0.0\"),\n\t.package(url: \"../Foo\", branch: \"main\")\n ],\n targets: [\n // Targets are the basic building blocks of a package. A target can define a module or a test suite.\n // Targets can depend on other targets in this package, and on products in packages this package depends on.\n .target(\n name: \"Bar\",\n dependencies: [\"Foo\"]),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Branch/Bar/Sources/Bar/Bar.swift", "content": "import Foo\n\nstruct Bar {\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Branch/Foo/Package.swift", "content": "// swift-tools-version:5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n // Products define the executables and libraries a package produces, and make them visible to other packages.\n .library(\n name: \"Foo\",\n targets: [\"Foo\"]),\n ],\n dependencies: [\n // Dependencies declare other packages that this package depends on.\n // .package(url: /* package url */, from: \"1.0.0\"),\n ],\n targets: [\n // Targets are the basic building blocks of a package. A target can define a module or a test suite.\n // Targets can depend on other targets in this package, and on products in packages this package depends on.\n .target(\n name: \"Foo\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Branch/Foo/Sources/Foo/Foo.swift", "content": "struct Foo {\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n dependencies: [\n .package(url: \"../Foo\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"SeaLover\", dependencies: [\"Foo\"]),\n .target(name: \"SwiftExec\", dependencies: [\"Foo\"]),\n ]\n)\n\n\n" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Bar/Sources/SeaLover/Sea.c", "content": "#include \n\nvoid cool() {\n foo();\n}" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Bar/Sources/SeaLover/include/Sea.h", "content": "" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Bar/Sources/SwiftExec/main.swift", "content": "import Foo\n\nfoo()\n" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Foo/Foo.c", "content": "void foo() {\n \n}\n" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/CUsingCDep/Foo/include/Foo/Foo.h", "content": "void foo();\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/FisherYates/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"FisherYates\",\n products: [\n .library(name: \"FisherYates\", targets: [\"FisherYates\"]),\n ],\n targets: [\n .target(name: \"FisherYates\", path: \"src\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/FisherYates/src/Fisher-Yates_Shuffle.swift", "content": "\npublic extension Collection {\n func shuffle() -> [Iterator.Element] {\n var array = Array(self)\n array.shuffleInPlace()\n\n return array\n }\n}\n\npublic extension MutableCollection {\n /// Shuffles the contents of this collection.\n mutating func shuffleInPlace() {\n let c = count\n guard c > 1 else { return }\n \n for (firstUnshuffled, unshuffledCount) in zip(indices, stride(from: c, to: 1, by: -1)) {\n var g = SystemRandomNumberGenerator()\n let d = Int.random(in: 1...unshuffledCount, using: &g)\n let i = index(firstUnshuffled, offsetBy: d)\n swapAt(firstUnshuffled, i)\n }\n }\n}\n\n\npublic let shuffle = false\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/PlayingCard/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"PlayingCard\",\n products: [\n .library(name: \"PlayingCard\", targets: [\"PlayingCard\"]),\n ],\n targets: [\n .target(name: \"PlayingCard\", path: \"src\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/PlayingCard/src/PlayingCard.swift", "content": "public struct PlayingCard: Equatable {\n let rank: Rank\n let suit: Suit\n\n public init(rank: Rank, suit: Suit) {\n self.rank = rank\n self.suit = suit\n }\n}\n\n// MARK: - Comparable\n\nextension PlayingCard: Comparable {}\n\npublic func <(lhs: PlayingCard, rhs: PlayingCard) -> Bool {\n return lhs.suit < rhs.suit || (lhs.suit == rhs.suit && lhs.rank < rhs.rank)\n}\n\n// MARK: - CustomStringConvertible\n\nextension PlayingCard : CustomStringConvertible {\n public var description: String {\n return \"\\(suit)\\(rank)\"\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/PlayingCard/src/Rank.swift", "content": "public enum Rank : Int {\n case Ace = 1\n case Two, Three, Four, Five, Six, Seven, Eight, Nine, Ten\n case Jack, Queen, King\n}\n\n// MARK: - Comparable\n\nextension Rank : Comparable {}\n\npublic func <(lhs: Rank, rhs: Rank) -> Bool {\n switch (lhs, rhs) {\n case (_, _) where lhs == rhs:\n return false\n case (.Ace, _):\n return false\n default:\n return lhs.rawValue < rhs.rawValue\n }\n}\n\n// MARK: - CustomStringConvertible\n\nextension Rank : CustomStringConvertible {\n public var description: String {\n switch self {\n case .Ace: return \"A\"\n case .Jack: return \"J\"\n case .Queen: return \"Q\"\n case .King: return \"K\"\n default:\n return \"\\(rawValue)\"\n }\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/PlayingCard/src/Suit.swift", "content": "public enum Suit: String {\n case Spades, Hearts, Diamonds, Clubs\n}\n\n// MARK: - Comparable\n\nextension Suit: Comparable {}\n\npublic func <(lhs: Suit, rhs: Suit) -> Bool {\n switch (lhs, rhs) {\n case (_, _) where lhs == rhs:\n return false\n case (.Spades, _),\n (.Hearts, .Diamonds), (.Hearts, .Clubs),\n (.Diamonds, .Clubs):\n return false\n default:\n return true\n }\n}\n\n// MARK: - CustomStringConvertible\n\nextension Suit : CustomStringConvertible {\n public var description: String {\n switch self {\n case .Spades: return \"♠︎\"\n case .Hearts: return \"♡\"\n case .Diamonds: return \"♢\"\n case .Clubs: return \"♣︎\"\n }\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/app/Package.swift", "content": "// swift-tools-version:5.0\nimport PackageDescription\n\nlet package = Package(\n name: \"Dealer\",\n platforms: [\n .macOS(.v10_12),\n .iOS(.v10),\n .tvOS(.v11),\n .watchOS(.v5)\n ],\n dependencies: [\n .package(url: \"../deck-of-playing-cards\", from: \"1.0.0\"),\n ],\n targets: [\n .target(\n name: \"Dealer\",\n dependencies: [\"DeckOfPlayingCards\"],\n path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/app/main.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport FisherYates\nimport PlayingCard\nimport DeckOfPlayingCards\n\nlet numberOfCards = 10\n\nvar deck = Deck.standard52CardDeck()\n\nif FisherYates.shuffle {\n deck.shuffle()\n}\n\nfor _ in 0.. Deck {\n let suits: [Suit] = [.Spades, .Hearts, .Diamonds, .Clubs]\n let ranks: [Rank] = [.Ace, .Two, .Three, .Four, .Five, .Six, .Seven, .Eight, .Nine, .Ten, .Jack, .Queen, .King]\n\n var cards: [PlayingCard] = []\n for suit in suits {\n for rank in ranks {\n cards.append(PlayingCard(rank: rank, suit: suit))\n }\n }\n\n return Deck(cards)\n }\n\n public init(_ cards: [PlayingCard]) {\n self.cards = cards\n }\n\n public mutating func shuffle() {\n cards.shuffleInPlace()\n }\n\n public mutating func deal() -> PlayingCard? {\n guard !cards.isEmpty else { return nil }\n\n return cards.removeLast()\n }\n}\n\n// MARK: - ExpressibleByArrayLiteral\n\nextension Deck : ExpressibleByArrayLiteral {\n public init(arrayLiteral elements: PlayingCard...) {\n self.init(elements)\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/deck-of-playing-cards-local/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"DeckOfPlayingCards\",\n products: [\n .library(name: \"DeckOfPlayingCards\", targets: [\"DeckOfPlayingCards\"]),\n ],\n dependencies: [\n .package(path: \"../PlayingCard\"),\n .package(path: \"../FisherYates\")\n ],\n targets: [\n .target(\n name: \"DeckOfPlayingCards\",\n dependencies: [\"PlayingCard\", \"FisherYates\"],\n path: \"src\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Complex/deck-of-playing-cards-local/src/Deck.swift", "content": "" }, { "path": "Fixtures/DependencyResolution/External/Mirror/App/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"App\",\n dependencies: [\n .package(url: \"../Foo\", .branch(\"main\")),\n .package(url: \"../Bar\", .branch(\"main\")),\n ],\n targets: [\n .target(name: \"App\", dependencies: [\n .product(name: \"Foo\", package: \"Foo\"),\n .product(name: \"Bar\", package: \"Bar\"),\n ], path: \"./\")\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/App/main.swift", "content": "import Foo\nimport Bar\n\npublic func main() {\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/Bar/Bar.swift", "content": "public func hello() {\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/Bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"Bar\", targets: [\"Bar\"]),\n ],\n targets: [\n .target(name: \"Bar\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/BarMirror/Bar.swift", "content": "public func hello() {\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/BarMirror/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"Bar\", targets: [\"Bar\"]),\n ],\n targets: [\n .target(name: \"Bar\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/Foo/Foo.swift", "content": "public func hello() {\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Mirror/Foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/PackageLookupCaseInsensitive/dep/Package.swift", "content": "// swift-tools-version:5.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Dep\",\n products: [\n .library(name: \"Dep\", targets: [\"Dep\"]),\n ],\n targets: [\n .target(name: \"Dep\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/PackageLookupCaseInsensitive/dep/Sources/Dep/dep.swift", "content": "public struct dep {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/PackageLookupCaseInsensitive/pkg/Package.swift", "content": "// swift-tools-version:5.4\n\nimport PackageDescription\n\nlet package = Package(\n name: \"pkg\",\n products: [\n .library(name: \"pkg\", targets: [\"pkg\"]),\n ],\n dependencies: [\n .package(path: \"../dep\"),\n ],\n targets: [\n .target(\n name: \"pkg\",\n dependencies: [.product(name: \"Dep\", package: \"Dep\")]),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/PackageLookupCaseInsensitive/pkg/Sources/pkg/pkg.swift", "content": "public struct pkg {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Simple/Bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n dependencies: [\n .package(url: \"../Foo\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"Bar\", dependencies: [\"Foo\"], path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/Simple/Bar/main.swift", "content": "import Foo\n\nfoo()\n" }, { "path": "Fixtures/DependencyResolution/External/Simple/Foo/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/DependencyResolution/External/Simple/Foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/External/XCFramework/Bar.xcframework/Info.plist", "content": "\n\n\n\n AvailableLibraries\n \n \n LibraryIdentifier\n macos-x86_64\n LibraryPath\n Framework.framework\n SupportedArchitectures\n \n x86_64\n \n SupportedPlatform\n macos\n \n \n CFBundlePackageType\n XFWK\n XCFrameworkFormatVersion\n 1.0\n\n\n" }, { "path": "Fixtures/DependencyResolution/External/XCFramework/Foo/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/DependencyResolution/External/XCFramework/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\", \"Bar\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./Foo\"),\n .binaryTarget(name: \"Bar\", path: \"./Bar.xcframework\")\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n targets: [\n .target(name: \"Bar\", dependencies: [\"Baz\", \"Cat\"]),\n .target(name: \"Baz\", dependencies: []),\n .target(name: \"Cat\", dependencies: [\"Sound\"]),\n .target(name: \"Foo\", dependencies: [\"Bar\"]),\n .target(name: \"Sound\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Bar/Bar.swift", "content": "import Baz\nimport Cat\n\npublic class Bar {\n public init()\n {}\n\n public let baz = Baz()\n public let cat = Cat()\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Baz/Baz.swift", "content": "public class Baz {\n public let value = \"Baz\"\n public init()\n {}\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Cat/Cat.swift", "content": "import Sound\n\npublic class Cat {\n public let sound = Sound()\n public init()\n {}\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Foo/Foo.swift", "content": "import Bar\n\nfunc foo() -> String {\n let bar = Bar()\n return bar.cat.sound.description + \" \" + bar.baz.value\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Foo/main.swift", "content": "print(foo())\n\n// TODO copy this fixture and make one that should not compile due to the dependency not being specified\n" }, { "path": "Fixtures/DependencyResolution/Internal/Complex/Sources/Sound/Sound.swift", "content": "public class Sound: CustomStringConvertible {\n public init()\n {}\n\n public var description: String {\n return \"meiow\"\n }\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/InternalExecutableAsDependency/Bar/Bar.swift", "content": "public struct Bar {\n public init() {}\n public let value = \"Bar\"\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/InternalExecutableAsDependency/Bar/main.swift", "content": "" }, { "path": "Fixtures/DependencyResolution/Internal/InternalExecutableAsDependency/Foo/Foo.swift", "content": "class Foo {\n let value = \"Foo\"\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/InternalExecutableAsDependency/Foo/main.swift", "content": "import Bar\n\nprint(Foo().value)\nprint(Bar().value)\n" }, { "path": "Fixtures/DependencyResolution/Internal/InternalExecutableAsDependency/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Foo\", dependencies: [\"Bar\"], path: \"Foo\"),\n .target(name: \"Bar\", path: \"Bar\"),\n ]\n)\n" }, { "path": "Fixtures/DependencyResolution/Internal/Simple/Bar/Bar.swift", "content": "public struct Bar {\n public init() {}\n public let value = \"Bar\"\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Simple/Foo/Foo.swift", "content": "class Foo {\n let value = \"Foo\"\n}\n" }, { "path": "Fixtures/DependencyResolution/Internal/Simple/Foo/main.swift", "content": "import Bar\n\nprint(Foo().value)\nprint(Bar().value)\n" }, { "path": "Fixtures/DependencyResolution/Internal/Simple/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Foo\", dependencies: [\"Bar\"], path: \"Foo\"),\n .target(name: \"Bar\", path: \"Bar\"),\n ]\n)\n" }, { "path": "Fixtures/Macros/MacroPackage/Package.swift", "content": "// swift-tools-version: 999.0\nimport PackageDescription\nimport CompilerPluginSupport\n\nlet settings: [SwiftSetting] = [\n .enableExperimentalFeature(\"Macros\"),\n .unsafeFlags([\"-Xfrontend\", \"-dump-macro-expansions\"])\n]\n\nlet package = Package(\n\tname: \"MacroPackage\",\n\tplatforms: [\n\t\t.macOS(.v10_15),\n\t],\n\ttargets: [\n\t\t.macro(name: \"MacroImpl\"),\n\t\t.target(name: \"MacroDef\", dependencies: [\"MacroImpl\"], swiftSettings: settings),\n\t\t.executableTarget(name: \"MacroClient\", dependencies: [\"MacroDef\"], swiftSettings: settings),\n\t]\n)\n" }, { "path": "Fixtures/Macros/MacroPackage/Sources/MacroClient/client.swift", "content": "import MacroDef\n\nstruct Font: ExpressibleByFontLiteral {\n init(fontLiteralName: String, size: Int, weight: MacroDef.FontWeight) {\n }\n}\n\nlet _: Font = #fontLiteral(name: \"Comic Sans\", size: 14, weight: .thin)\n" }, { "path": "Fixtures/Macros/MacroPackage/Sources/MacroDef/definition.swift", "content": "\npublic enum FontWeight {\n case thin\n case normal\n case medium\n case semiBold\n case bold\n}\n\npublic protocol ExpressibleByFontLiteral {\n init(fontLiteralName: String, size: Int, weight: FontWeight)\n}\n\n/// Font literal similar to, e.g., #colorLiteral.\n@freestanding(expression) public macro fontLiteral(name: String, size: Int, weight: FontWeight) -> T = #externalMacro(module: \"MacroImpl\", type: \"FontLiteralMacro\")\n where T: ExpressibleByFontLiteral" }, { "path": "Fixtures/Macros/MacroPackage/Sources/MacroImpl/macro.swift", "content": "import SwiftSyntax\nimport SwiftSyntaxBuilder\nimport SwiftSyntaxMacros\n\n/// Implementation of the `#fontLiteral` macro, which is similar in spirit\n/// to the built-in expressions `#colorLiteral`, `#imageLiteral`, etc., but in\n/// a small macro.\npublic struct FontLiteralMacro: ExpressionMacro {\n public static func expansion(\n of macro: some FreestandingMacroExpansionSyntax,\n in context: some MacroExpansionContext\n ) -> ExprSyntax {\n let argList = replaceFirstLabel(\n of: macro.argumentList,\n with: \"fontLiteralName\"\n )\n let initSyntax: ExprSyntax = \".init(\\(argList))\"\n if let leadingTrivia = macro.leadingTrivia {\n return initSyntax.with(\\.leadingTrivia, leadingTrivia)\n }\n return initSyntax\n }\n}\n\n/// Replace the label of the first element in the tuple with the given\n/// new label.\nprivate func replaceFirstLabel(\n of tuple: TupleExprElementListSyntax,\n with newLabel: String\n) -> TupleExprElementListSyntax {\n guard let firstElement = tuple.first else {\n return tuple\n }\n\n return tuple.replacing(\n childAt: 0,\n with: firstElement.with(\\.label, .identifier(newLabel))\n )\n}\n" }, { "path": "Fixtures/Macros/MinimalMacroPackage/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\nimport CompilerPluginSupport\n\nlet package = Package(\n name: \"MinimalMacroPackage\",\n platforms: [\n .macOS(.v13),\n ],\n targets: [\n .macro(name: \"MacroImpl\"),\n .target(name: \"MacroDef\", dependencies: [\"MacroImpl\"]),\n .executableTarget(name: \"MacroClient\", dependencies: [\"MacroDef\"]),\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Macros/MinimalMacroPackage/Sources/MacroClient/main.swift", "content": "import MacroDef\n\nlet result = #stringify(42)\nprint(\"Macro result: \\(result)\")\n" }, { "path": "Fixtures/Macros/MinimalMacroPackage/Sources/MacroDef/MacroDef.swift", "content": "@freestanding(expression)\npublic macro stringify(_ value: T) -> String = #externalMacro(module: \"MacroImpl\", type: \"StringifyMacro\")\n" }, { "path": "Fixtures/Macros/MinimalMacroPackage/Sources/MacroImpl/StringifyMacro.swift", "content": "import Foundation\n\n@main\nstruct MacroPlugin {\n static func main() throws {\n while true {\n guard let headerData = try read(count: 8),\n headerData.count == 8 else {\n break\n }\n let length = headerData.withUnsafeBytes { buffer in\n buffer.load(as: UInt64.self)\n }\n let payloadLength = UInt64(littleEndian: length)\n\n if payloadLength == 0 {\n break\n }\n\n guard let payloadData = try read(count: Int(payloadLength)),\n payloadData.count == Int(payloadLength) else {\n break\n }\n\n guard let json = try? JSONSerialization.jsonObject(with: payloadData) as? [String: Any] else {\n continue\n }\n\n if json.keys.contains(\"getCapability\") {\n let response: [String: Any] = [\n \"getCapabilityResult\": [\n \"capability\": [\n \"protocolVersion\": 2\n ]\n ]\n ]\n if let responseData = try? JSONSerialization.data(withJSONObject: response) {\n try writeMessage(responseData, to: FileHandle.standardOutput)\n }\n } else if json.keys.contains(\"expandFreestandingMacro\") {\n let response: [String: Any] = [\n \"expandMacroResult\": [\n \"expandedSource\": \"\\\"expanded\\\"\",\n \"diagnostics\": []\n ]\n ]\n if let responseData = try? JSONSerialization.data(withJSONObject: response) {\n try writeMessage(responseData, to: FileHandle.standardOutput)\n }\n }\n }\n }\n}\n\nprivate func read(count: Int) throws -> Data? {\n var accumulated = Data()\n while accumulated.count < count {\n let remaining = count - accumulated.count\n guard let chunk = try FileHandle.standardInput.read(upToCount: remaining), !chunk.isEmpty else {\n return accumulated.isEmpty ? nil : accumulated\n }\n accumulated.append(chunk)\n }\n return accumulated\n}\n\nprivate func writeMessage(_ data: Data, to handle: FileHandle) throws {\n var length = UInt64(data.count).littleEndian\n let headerData = withUnsafeBytes(of: &length) { buffer in\n Data(buffer)\n }\n try handle.write(contentsOf: headerData)\n try handle.write(contentsOf: data)\n}\n" }, { "path": "Fixtures/Metal/SimpleLibrary/Package.swift", "content": "// swift-tools-version: 6.2\n// The swift-tools-version declares the minimum version of Swift required to build this package.\nimport PackageDescription\n\nlet package = Package(\n name: \"MyRenderer\",\n products: [\n .library(\n name: \"MyRenderer\",\n targets: [\"MyRenderer\"]),\n ],\n targets: [\n .target(\n name: \"MyRenderer\",\n dependencies: [\"MySharedTypes\"]),\n\n .target(name: \"MySharedTypes\")\n ]\n)\n" }, { "path": "Fixtures/Metal/SimpleLibrary/Sources/MyRenderer/Renderer.swift", "content": "import MySharedTypes\n\n\nlet vertex = AAPLVertex(position: .init(250, -250), color: .init(1, 0, 0, 1))\n" }, { "path": "Fixtures/Metal/SimpleLibrary/Sources/MyRenderer/Shaders.metal", "content": "// A relative path to SharedTypes.h.\n#import \"../MySharedTypes/include/SharedTypes.h\"\n\n#include \nusing namespace metal;\n\nvertex float4 simpleVertexShader(const device AAPLVertex *vertices [[buffer(0)]],\n uint vertexID [[vertex_id]]) {\n AAPLVertex in = vertices[vertexID];\n return float4(in.position.x, in.position.y, 0.0, 1.0);\n}\n\n" }, { "path": "Fixtures/Metal/SimpleLibrary/Sources/MySharedTypes/include/SharedTypes.h", "content": "#ifndef SharedTypes_h\n#define SharedTypes_h\n\n\n#import \n\n\ntypedef struct {\n vector_float2 position;\n vector_float4 color;\n} AAPLVertex;\n\n\n#endif /* SharedTypes_h */\n" }, { "path": "Fixtures/Metal/SimpleLibrary/Tests/MyRendererTests/MyRendererTests.swift", "content": "import Testing\n@testable import MyRenderer\n\n@Test func example() async throws {\n // Write your test here and use APIs like `#expect(...)` to check expected conditions.\n}\n" }, { "path": "Fixtures/Miscellaneous/-DSWIFT_PACKAGE/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ExtraCommandLineFlags\",\n targets: [\n .target(name: \"CLib\"),\n .target(name: \"SwiftExec\", dependencies: [\"CLib\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/-DSWIFT_PACKAGE/Sources/CLib/foo.c", "content": "#include \"CLib.h\"\n\nvoid foo(void) { }\n" }, { "path": "Fixtures/Miscellaneous/-DSWIFT_PACKAGE/Sources/CLib/include/CLib.h", "content": "// This is to check a -Xcc arg.\n#if !defined(EXTRA_C_DEFINE) || EXTRA_C_DEFINE != 2\n#error \"unexpected compiler flags\"\n#endif\n\nvoid foo(void);\n" }, { "path": "Fixtures/Miscellaneous/-DSWIFT_PACKAGE/Sources/SwiftExec/main.swift", "content": "import CLib\n\n// This is expected to be set with -Xswiftc.\n#if !EXTRA_SWIFTC_DEFINE\ndoesNotCompile()\n#endif\n\nfoo()\n\nclass Bar {\n var bar: Int = 0 \n #if SWIFT_PACKAGE\n #else\n var bar: String = \"\"\n #endif\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/Bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"Baz\", targets: [\"Baz\"]),\n .library(name: \"Qux\", targets: [\"Qux\"]),\n ],\n targets: [\n .target(name: \"Baz\"),\n .target(name: \"Qux\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/Bar/Sources/Baz/Baz.swift", "content": "public func bar() -> Int {\n 42\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/Bar/Sources/Qux/Qux.swift", "content": "public class Qux { public let x = 1 }\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/BrokenPkg/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"BrokenPkg\",\n products: [\n .library(name: \"BrokenPkg\", targets: [\"BrokenPkg\", \"Swift2\"]),\n ],\n targets: [\n .target(name: \"BrokenPkg\", publicHeadersPath: \"bestHeaders\", cSettings: [ .define(\"FLAG\"), ]),\n .target(name: \"Swift2\", dependencies: [\"BrokenPkg\"], cSettings: [ .define(\"FLAG\"), ]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/BrokenPkg/Sources/BrokenPkg/bestHeaders/header.h", "content": "#ifndef FLAG\n#error \"fail\"\n#endif\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/BrokenPkg/Sources/BrokenPkg/code.m", "content": "#import \"header.h\"\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/BrokenPkg/Sources/Swift2/file.swift", "content": "import BrokenPkg\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Package.swift", "content": "// swift-tools-version: 6.0\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Sample\",\n products: [\n .library(\n name: \"Sample\",\n targets: [\"Sample\"]\n ),\n ],\n targets: [\n .target(\n name: \"CSample\",\n sources: [\"./vendorsrc/src\"],\n cSettings: [\n .headerSearchPath(\"./vendorsrc/include\"),\n ]\n ),\n .target(\n name: \"Sample\",\n dependencies: [\"CSample\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Sources/CSample/include/CSample.h", "content": "\n#include \"config.h\"\n#include \"../vendorsrc/include/vendor.h\"" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Sources/CSample/include/config.h", "content": "#define HAVE_VENDOR_CONFIG\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Sources/CSample/vendorsrc/include/vendor.h", "content": "\n#include \"config.h\"\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Sources/CSample/vendorsrc/src/vendor.c", "content": "#include \"vendor.h\"\n\nint vendor__func(int n)\n{\n return 0;\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CIncludePath/Sources/Sample/Sample.swift", "content": "import CSample\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CTargetDep/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CLibrarySources\",\n products: [\n .library(name: \"Lib\", targets: [\"Bar\"])\n ],\n targets: [\n .target(name: \"Foo\"),\n .target(name: \"Bar\", dependencies: [\"Foo\"])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CTargetDep/Sources/Bar/Bar.swift", "content": "import Foo\n\npublic func bar() -> Int {\n foo()\n return 42\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CTargetDep/Sources/Foo/Foo.c", "content": "#include \"Foo.h\"\n\nint foo() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/CTargetDep/Sources/Foo/include/Foo.h", "content": "int foo();\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/Foo/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/Foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"NonAPILibraryTargets\",\n products: [\n .library(name: \"One\", targets: [\"Foo\"]),\n .library(name: \"Two\", targets: [\"Bar\", \"Baz\"]),\n .executable(name: \"Exec\", targets: [\"Exec\", \"Qux\"])\n ],\n targets: [\n .target(name: \"Foo\"),\n .target(name: \"Bar\", dependencies: [\"Baz\"]),\n .target(name: \"Baz\"),\n .target(name: \"Qux\"),\n .target(name: \"Exec\", dependencies: [\"Qux\"])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Sources/Bar/Bar.swift", "content": "import Baz\n\npublic func bar() -> Int {\n 42\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Sources/Baz/Baz.swift", "content": "public enum Baz {\n case a, c\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Sources/Exec/main.swift", "content": "import Qux\n\nprint(\"Hello, world!\")\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Sources/Foo/Foo.swift", "content": "public struct Foo {\n func doThing() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/NonAPILibraryTargets/Sources/Qux/Qux.swift", "content": "public class Qux { public let x = 1 }\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/WithPlugin/Package.swift", "content": "// swift-tools-version: 6.1\nimport PackageDescription\n\nlet package = Package(\n name: \"package-with-plugin\",\n products: [.library(name: \"PackageLib\", targets: [\"TargetLib\"])],\n targets: [\n .target(name: \"TargetLib\"),\n .executableTarget(name: \"BuildTool\", dependencies: [\"TargetLib\"]),\n .plugin(\n name: \"BuildPlugin\",\n capability: .command(intent: .custom(verb: \"do-it-now\", description: \"\")),\n dependencies: [\"BuildTool\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/WithPlugin/Plugins/BuildPlugin/BuildToolPlugin.swift", "content": "import Foundation\nimport PackagePlugin\n\n@main\nfinal class BuildToolPlugin: CommandPlugin {\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n _ = try context.tool(named: \"BuildTool\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/WithPlugin/Sources/BuildTool/BuildTool.swift", "content": "import TargetLib\n\n@main\npublic struct BuildTool {\n static func main() {\n TargetLibStruct.do_it()\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/APIDiff/WithPlugin/Sources/TargetLib/TargetLib.swift", "content": "public enum TargetLibStruct {\n public static func do_it() {\n print(\"Hello!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/AtMainSupport/Package.swift", "content": "// swift-tools-version:5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"AtMainSupport\",\n products: [\n .executable(name: \"ClangExecSingleFile\", targets: [\"ClangExecSingleFile\"]),\n .executable(name: \"SwiftExecSingleFile\", targets: [\"SwiftExecSingleFile\"]),\n .executable(name: \"SwiftExecMultiFile\", targets: [\"SwiftExecMultiFile\"]),\n ],\n targets: [\n .executableTarget(name: \"ClangExecSingleFile\",\n linkerSettings: [\n .linkedLibrary(\"swiftCore\", .when(platforms: [.windows])), // for swift_addNewDSOImage\n ]),\n .executableTarget(name: \"SwiftExecSingleFile\"),\n .executableTarget(name: \"SwiftExecMultiFile\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/AtMainSupport/Sources/ClangExecSingleFile/NotMain.c", "content": "#include \n\nint main() {\n printf(\"Hello, C.\");\n }\n" }, { "path": "Fixtures/Miscellaneous/AtMainSupport/Sources/SwiftExecMultiFile/NotMain.swift", "content": "@main\nstruct MyProgram {\n static func main() {\n print(\"Hello, Swift.\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/AtMainSupport/Sources/SwiftExecMultiFile/OtherFile.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/AtMainSupport/Sources/SwiftExecSingleFile/NotMain.swift", "content": "@main\nstruct MyProgram {\n static func main() {\n print(\"Hello, Swift.\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/Package.swift", "content": "// swift-tools-version:5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CXX17WithFModules\",\n targets: [\n .target(\n name: \"lodepng\",\n path: \"lodepng\",\n sources: [\"lodepng.cpp\"],\n publicHeadersPath: \"include\"),\n .target(name: \"CXX17WithFModules\", dependencies: [\"lodepng\"], path: \"./\", sources: [\"src/user_objects.cc\"], publicHeadersPath: \"include\"),\n ],\n cxxLanguageStandard: .cxx17\n)\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/include/user_objects.h", "content": "// Copyright 2021 DeepMind Technologies Limited\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef MUJOCO_SRC_USER_USER_OBJECTS_H_\n#define MUJOCO_SRC_USER_USER_OBJECTS_H_\n\n#include \n#include \n\n#include \"lodepng.h\"\n\n// forward declarations of all mjC/X classes\nclass mjCError;\nclass mjCAlternative;\nclass mjCBase;\nclass mjCBody;\nclass mjCJoint;\nclass mjCGeom;\nclass mjCSite;\nclass mjCCamera;\nclass mjCLight;\nclass mjCMesh;\nclass mjCSkin;\nclass mjCTexture;\nclass mjCMaterial;\nclass mjCPair;\nclass mjCBodyPair;\nclass mjCEquality;\nclass mjCTendon;\nclass mjCWrap;\nclass mjCActuator;\nclass mjCSensor;\nclass mjCNumeric;\nclass mjCText;\nclass mjCTuple;\nclass mjCDef;\nclass mjCMesh; // defined in user_mesh\nclass mjCModel; // defined in user_model\nclass mjXWriter; // defined in xml_native\nclass mjXURDF; // defined in xml_urdf\n\n\n//------------------------- helper classes and constants -------------------------------------------\n\n\n// builtin type for procedural textures\ntypedef enum _mjtBuiltin {\n mjBUILTIN_NONE = 0, // no builtin\n mjBUILTIN_GRADIENT, // circular gradient: rgb1->rgb2->rgb3\n mjBUILTIN_CHECKER, // checker pattern: rgb1, rgb2\n mjBUILTIN_FLAT // 2d: rgb1; cube: rgb1-up, rgb2-side, rgb3-down\n} mjtBuiltin;\n\n\n// mark type for procedural textures\ntypedef enum _mjtMark {\n mjMARK_NONE = 0, // no mark\n mjMARK_EDGE, // paint edges\n mjMARK_CROSS, // paint cross\n mjMARK_RANDOM // paint random dots\n} mjtMark;\n\n\n// error information\nclass mjCError {\n public:\n mjCError(const mjCBase* obj = 0,\n const char* msg = 0,\n const char* str = 0,\n int pos1 = 0,\n int pos2 = 0);\n\n char message[500]; // error message\n bool warning; // is this a warning instead of error\n};\n\n\n// alternative specifications of frame orientation\nclass mjCAlternative {\n public:\n mjCAlternative(); // constructor\n const char* Set(double* quat, double* inertia, // set frame quat and diag. inertia\n bool degree, // angle format: degree/radian\n const char* sequence); // euler sequence format: \"xyz\"\n\n double axisangle[4]; // rotation axis and angle\n double xyaxes[6]; // x and y axes\n double zaxis[3]; // z axis (use minimal rotation)\n double euler[3]; // euler rotations\n double fullinertia[6]; // non-axis-aligned inertia matrix\n};\n\n\n\n//------------------------- class mjCBase ----------------------------------------------------------\n// Generic functionality for all derived classes\n\nclass mjCBase {\n friend class mjCDef;\n\n public:\n std::string name; // object name\n std::string classname; // defaults class name\n int id; // object id\n int xmlpos[2]; // row and column in xml file\n mjCDef* def; // defaults class used to init this object\n\n protected:\n mjCBase(); // constructor\n mjCModel* model; // pointer to model that created object\n};\n\n\n\n//------------------------- class mjCBody -----------------------------------------------\n// Describes a rigid body\n\nclass mjCBody : public mjCBase {\n friend class mjCJoint;\n friend class mjCGeom;\n friend class mjCSite;\n friend class mjCCamera;\n friend class mjCLight;\n friend class mjCEquality;\n friend class mjCPair;\n friend class mjCModel;\n friend class mjXReader;\n friend class mjXWriter;\n friend class mjXURDF;\n\n public:\n // API for adding objects to body\n mjCBody* AddBody(mjCDef* = 0);\n mjCJoint* AddJoint(mjCDef* = 0, bool isfree = false);\n mjCGeom* AddGeom(mjCDef* = 0);\n mjCSite* AddSite(mjCDef* = 0);\n mjCCamera* AddCamera(mjCDef* = 0);\n mjCLight* AddLight(mjCDef* = 0);\n\n\n // setup child local frame, take into account change\n void MakeLocal(double* locpos, double* locquat, const double* pos, const double* quat);\n\n // set explicit_inertial to true\n void MakeInertialExplicit();\n\n // variables set by user or 'Compile'\n bool mocap; // is this a mocap body\n double pos[3]; // frame position\n double quat[4]; // frame orientation\n double ipos[3]; // inertial frame position\n double iquat[4]; // inertial frame orientation\n double mass; // mass\n double inertia[3]; // diagonal inertia (in i-frame)\n std::vector userdata; // user data\n mjCAlternative alt; // alternative orientation specification\n mjCAlternative ialt; // alternative for inertial frame\n\n // variables computed by 'Compile' and 'AddXXX'\n private:\n mjCBody(mjCModel*); // constructor\n ~mjCBody(); // destructor\n void Compile(void); // compiler\n\n void GeomFrame(void); // get inertial info from geoms\n\n double locpos[3]; // position relative to parent\n double locquat[4]; // orientation relative to parent\n double locipos[3]; // inertial position frame, rel. to local frame\n double lociquat[4]; // inertial frame orientation\n int parentid; // parent index in global array\n int weldid; // top index of body we are welded to\n int dofnum; // number of motion dofs for body\n int mocapid; // mocap id, -1: not mocap\n bool explicit_inertial; // whether to save the body with an explicit inertial clause\n\n int lastdof; // id of last dof (used by compiler)\n\n // objects allocated by Add functions\n std::vector bodies; // child bodies\n std::vector geoms; // geoms attached to this body\n std::vector joints; // joints allowing motion relative to parent\n std::vector sites; // sites attached to this body\n std::vector cameras; // cameras attached to this body\n std::vector lights; // lights attached to this body\n};\n\n#endif // MUJOCO_SRC_USER_USER_OBJECTS_H_\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/lodepng/include/lodepng.h", "content": "/*\nLodePNG version 20220109\n\nCopyright (c) 2005-2022 Lode Vandevenne\n\nThis software is provided 'as-is', without any express or implied\nwarranty. In no event will the authors be held liable for any damages\narising from the use of this software.\n\nPermission is granted to anyone to use this software for any purpose,\nincluding commercial applications, and to alter it and redistribute it\nfreely, subject to the following restrictions:\n\n 1. The origin of this software must not be misrepresented; you must not\n claim that you wrote the original software. If you use this software\n in a product, an acknowledgment in the product documentation would be\n appreciated but is not required.\n\n 2. Altered source versions must be plainly marked as such, and must not be\n misrepresented as being the original software.\n\n 3. This notice may not be removed or altered from any source\n distribution.\n*/\n\n#ifndef LODEPNG_H\n#define LODEPNG_H\n\n#include /*for size_t*/\n\nextern const char* LODEPNG_VERSION_STRING;\n\n/*\nThe following #defines are used to create code sections. They can be disabled\nto disable code sections, which can give faster compile time and smaller binary.\nThe \"NO_COMPILE\" defines are designed to be used to pass as defines to the\ncompiler command to disable them without modifying this header, e.g.\n-DLODEPNG_NO_COMPILE_ZLIB for gcc.\nIn addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to\nallow implementing a custom lodepng_crc32.\n*/\n/*deflate & zlib. If disabled, you must specify alternative zlib functions in\nthe custom_zlib field of the compress and decompress settings*/\n#ifndef LODEPNG_NO_COMPILE_ZLIB\n#define LODEPNG_COMPILE_ZLIB\n#endif\n\n/*png encoder and png decoder*/\n#ifndef LODEPNG_NO_COMPILE_PNG\n#define LODEPNG_COMPILE_PNG\n#endif\n\n/*deflate&zlib decoder and png decoder*/\n#ifndef LODEPNG_NO_COMPILE_DECODER\n#define LODEPNG_COMPILE_DECODER\n#endif\n\n/*deflate&zlib encoder and png encoder*/\n#ifndef LODEPNG_NO_COMPILE_ENCODER\n#define LODEPNG_COMPILE_ENCODER\n#endif\n\n/*the optional built in harddisk file loading and saving functions*/\n#ifndef LODEPNG_NO_COMPILE_DISK\n#define LODEPNG_COMPILE_DISK\n#endif\n\n/*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/\n#ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS\n#define LODEPNG_COMPILE_ANCILLARY_CHUNKS\n#endif\n\n/*ability to convert error numerical codes to English text string*/\n#ifndef LODEPNG_NO_COMPILE_ERROR_TEXT\n#define LODEPNG_COMPILE_ERROR_TEXT\n#endif\n\n/*Compile the default allocators (C's free, malloc and realloc). If you disable this,\nyou can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your\nsource files with custom allocators.*/\n#ifndef LODEPNG_NO_COMPILE_ALLOCATORS\n#define LODEPNG_COMPILE_ALLOCATORS\n#endif\n\n/*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/\n#ifdef __cplusplus\n#ifndef LODEPNG_NO_COMPILE_CPP\n#define LODEPNG_COMPILE_CPP\n#endif\n#endif\n\n#ifdef LODEPNG_COMPILE_CPP\n#include \n#include \n#endif /*LODEPNG_COMPILE_CPP*/\n\n#ifdef LODEPNG_COMPILE_PNG\n/*The PNG color types (also used for raw image).*/\ntypedef enum LodePNGColorType {\n LCT_GREY = 0, /*grayscale: 1,2,4,8,16 bit*/\n LCT_RGB = 2, /*RGB: 8,16 bit*/\n LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/\n LCT_GREY_ALPHA = 4, /*grayscale with alpha: 8,16 bit*/\n LCT_RGBA = 6, /*RGB with alpha: 8,16 bit*/\n /*LCT_MAX_OCTET_VALUE lets the compiler allow this enum to represent any invalid\n byte value from 0 to 255 that could be present in an invalid PNG file header. Do\n not use, compare with or set the name LCT_MAX_OCTET_VALUE, instead either use\n the valid color type names above, or numeric values like 1 or 7 when checking for\n particular disallowed color type byte values, or cast to integer to print it.*/\n LCT_MAX_OCTET_VALUE = 255\n} LodePNGColorType;\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nConverts PNG data in memory to raw pixel data.\nout: Output parameter. Pointer to buffer that will contain the raw pixel data.\n After decoding, its size is w * h * (bytes per pixel) bytes larger than\n initially. Bytes per pixel depends on colortype and bitdepth.\n Must be freed after usage with free(*out).\n Note: for 16-bit per channel colors, uses big endian format like PNG does.\nw: Output parameter. Pointer to width of pixel data.\nh: Output parameter. Pointer to height of pixel data.\nin: Memory buffer with the PNG file.\ninsize: size of the in buffer.\ncolortype: the desired color type for the raw output image. See explanation on PNG color types.\nbitdepth: the desired bit depth for the raw output image. See explanation on PNG color types.\nReturn value: LodePNG error code (0 means no error).\n*/\nunsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/\nunsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize);\n\n/*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/\nunsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize);\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad PNG from disk, from file with given name.\nSame as the other decode functions, but instead takes a filename as input.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename);\n\n/*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename);\n#endif /*LODEPNG_COMPILE_DISK*/\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nConverts raw pixel data into a PNG image in memory. The colortype and bitdepth\n of the output PNG image cannot be chosen, they are automatically determined\n by the colortype, bitdepth and content of the input pixel data.\n Note: for 16-bit per channel colors, needs big endian format like PNG does.\nout: Output parameter. Pointer to buffer that will contain the PNG image data.\n Must be freed after usage with free(*out).\noutsize: Output parameter. Pointer to the size in bytes of the out buffer.\nimage: The raw pixel data to encode. The size of this buffer should be\n w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth.\nw: width of the raw pixel data in pixels.\nh: height of the raw pixel data in pixels.\ncolortype: the color type of the raw input image. See explanation on PNG color types.\nbitdepth: the bit depth of the raw input image. See explanation on PNG color types.\nReturn value: LodePNG error code (0 means no error).\n*/\nunsigned lodepng_encode_memory(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/\nunsigned lodepng_encode32(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h);\n\n/*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/\nunsigned lodepng_encode24(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h);\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts raw pixel data into a PNG file on disk.\nSame as the other encode functions, but instead takes a filename as output.\n\nNOTE: This overwrites existing files without warning!\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode32_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h);\n\n/*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode24_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h);\n#endif /*LODEPNG_COMPILE_DISK*/\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n\n#ifdef LODEPNG_COMPILE_CPP\nnamespace lodepng {\n#ifdef LODEPNG_COMPILE_DECODER\n/*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype\nis the format to output the pixels to. Default is RGBA 8-bit per channel.*/\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const unsigned char* in, size_t insize,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const std::vector& in,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts PNG file from disk to raw pixel data in memory.\nSame as the other decode functions, but instead takes a filename as input.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const std::string& filename,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_DECODER */\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*Same as lodepng_encode_memory, but encodes to an std::vector. colortype\nis that of the raw input data. The output PNG color type will be auto chosen.*/\nunsigned encode(std::vector& out,\n const unsigned char* in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned encode(std::vector& out,\n const std::vector& in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts 32-bit RGBA raw pixel data into a PNG file on disk.\nSame as the other encode functions, but instead takes a filename as output.\n\nNOTE: This overwrites existing files without warning!\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned encode(const std::string& filename,\n const unsigned char* in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned encode(const std::string& filename,\n const std::vector& in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_ENCODER */\n} /* namespace lodepng */\n#endif /*LODEPNG_COMPILE_CPP*/\n#endif /*LODEPNG_COMPILE_PNG*/\n\n#ifdef LODEPNG_COMPILE_ERROR_TEXT\n/*Returns an English description of the numerical error code.*/\nconst char* lodepng_error_text(unsigned code);\n#endif /*LODEPNG_COMPILE_ERROR_TEXT*/\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*Settings for zlib decompression*/\ntypedef struct LodePNGDecompressSettings LodePNGDecompressSettings;\nstruct LodePNGDecompressSettings {\n /* Check LodePNGDecoderSettings for more ignorable errors such as ignore_crc */\n unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/\n unsigned ignore_nlen; /*ignore complement of len checksum in uncompressed blocks*/\n\n /*Maximum decompressed size, beyond this the decoder may (and is encouraged to) stop decoding,\n return an error, output a data size > max_output_size and all the data up to that point. This is\n not hard limit nor a guarantee, but can prevent excessive memory usage. This setting is\n ignored by the PNG decoder, but is used by the deflate/zlib decoder and can be used by custom ones.\n Set to 0 to impose no limit (the default).*/\n size_t max_output_size;\n\n /*use custom zlib decoder instead of built in one (default: null).\n Should return 0 if success, any non-0 if error (numeric value not exposed).*/\n unsigned (*custom_zlib)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGDecompressSettings*);\n /*use custom deflate decoder instead of built in one (default: null)\n if custom_zlib is not null, custom_inflate is ignored (the zlib format uses deflate).\n Should return 0 if success, any non-0 if error (numeric value not exposed).*/\n unsigned (*custom_inflate)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGDecompressSettings*);\n\n const void* custom_context; /*optional custom settings for custom functions*/\n};\n\nextern const LodePNGDecompressSettings lodepng_default_decompress_settings;\nvoid lodepng_decompress_settings_init(LodePNGDecompressSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nSettings for zlib compression. Tweaking these settings tweaks the balance\nbetween speed and compression ratio.\n*/\ntypedef struct LodePNGCompressSettings LodePNGCompressSettings;\nstruct LodePNGCompressSettings /*deflate = compress*/ {\n /*LZ77 related settings*/\n unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/\n unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/\n unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/\n unsigned minmatch; /*minimum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/\n unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/\n unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/\n\n /*use custom zlib encoder instead of built in one (default: null)*/\n unsigned (*custom_zlib)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGCompressSettings*);\n /*use custom deflate encoder instead of built in one (default: null)\n if custom_zlib is used, custom_deflate is ignored since only the built in\n zlib function will call custom_deflate*/\n unsigned (*custom_deflate)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGCompressSettings*);\n\n const void* custom_context; /*optional custom settings for custom functions*/\n};\n\nextern const LodePNGCompressSettings lodepng_default_compress_settings;\nvoid lodepng_compress_settings_init(LodePNGCompressSettings* settings);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n#ifdef LODEPNG_COMPILE_PNG\n/*\nColor mode of an image. Contains all information required to decode the pixel\nbits to RGBA colors. This information is the same as used in the PNG file\nformat, and is used both for PNG and raw image data in LodePNG.\n*/\ntypedef struct LodePNGColorMode {\n /*header (IHDR)*/\n LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/\n unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/\n\n /*\n palette (PLTE and tRNS)\n\n Dynamically allocated with the colors of the palette, including alpha.\n This field may not be allocated directly, use lodepng_color_mode_init first,\n then lodepng_palette_add per color to correctly initialize it (to ensure size\n of exactly 1024 bytes).\n\n The alpha channels must be set as well, set them to 255 for opaque images.\n\n When decoding, by default you can ignore this palette, since LodePNG already\n fills the palette colors in the pixels of the raw RGBA output.\n\n The palette is only supported for color type 3.\n */\n unsigned char* palette; /*palette in RGBARGBA... order. Must be either 0, or when allocated must have 1024 bytes*/\n size_t palettesize; /*palette size in number of colors (amount of used bytes is 4 * palettesize)*/\n\n /*\n transparent color key (tRNS)\n\n This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit.\n For grayscale PNGs, r, g and b will all 3 be set to the same.\n\n When decoding, by default you can ignore this information, since LodePNG sets\n pixels with this key to transparent already in the raw RGBA output.\n\n The color key is only supported for color types 0 and 2.\n */\n unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/\n unsigned key_r; /*red/grayscale component of color key*/\n unsigned key_g; /*green component of color key*/\n unsigned key_b; /*blue component of color key*/\n} LodePNGColorMode;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_color_mode_init(LodePNGColorMode* info);\nvoid lodepng_color_mode_cleanup(LodePNGColorMode* info);\n/*return value is error code (0 means no error)*/\nunsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source);\n/* Makes a temporary LodePNGColorMode that does not need cleanup (no palette) */\nLodePNGColorMode lodepng_color_mode_make(LodePNGColorType colortype, unsigned bitdepth);\n\nvoid lodepng_palette_clear(LodePNGColorMode* info);\n/*add 1 color to the palette*/\nunsigned lodepng_palette_add(LodePNGColorMode* info,\n unsigned char r, unsigned char g, unsigned char b, unsigned char a);\n\n/*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/\nunsigned lodepng_get_bpp(const LodePNGColorMode* info);\n/*get the amount of color channels used, based on colortype in the struct.\nIf a palette is used, it counts as 1 channel.*/\nunsigned lodepng_get_channels(const LodePNGColorMode* info);\n/*is it a grayscale type? (only colortype 0 or 4)*/\nunsigned lodepng_is_greyscale_type(const LodePNGColorMode* info);\n/*has it got an alpha channel? (only colortype 2 or 6)*/\nunsigned lodepng_is_alpha_type(const LodePNGColorMode* info);\n/*has it got a palette? (only colortype 3)*/\nunsigned lodepng_is_palette_type(const LodePNGColorMode* info);\n/*only returns true if there is a palette and there is a value in the palette with alpha < 255.\nLoops through the palette to check this.*/\nunsigned lodepng_has_palette_alpha(const LodePNGColorMode* info);\n/*\nCheck if the given color info indicates the possibility of having non-opaque pixels in the PNG image.\nReturns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels).\nReturns false if the image can only have opaque pixels.\nIn detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values,\nor if \"key_defined\" is true.\n*/\nunsigned lodepng_can_have_alpha(const LodePNGColorMode* info);\n/*Returns the byte size of a raw image buffer with given width, height and color mode*/\nsize_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color);\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n/*The information of a Time chunk in PNG.*/\ntypedef struct LodePNGTime {\n unsigned year; /*2 bytes used (0-65535)*/\n unsigned month; /*1-12*/\n unsigned day; /*1-31*/\n unsigned hour; /*0-23*/\n unsigned minute; /*0-59*/\n unsigned second; /*0-60 (to allow for leap seconds)*/\n} LodePNGTime;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n\n/*Information about the PNG image, except pixels, width and height.*/\ntypedef struct LodePNGInfo {\n /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/\n unsigned compression_method;/*compression method of the original file. Always 0.*/\n unsigned filter_method; /*filter method of the original file*/\n unsigned interlace_method; /*interlace method of the original file: 0=none, 1=Adam7*/\n LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n /*\n Suggested background color chunk (bKGD)\n\n This uses the same color mode and bit depth as the PNG (except no alpha channel),\n with values truncated to the bit depth in the unsigned integer.\n\n For grayscale and palette PNGs, the value is stored in background_r. The values\n in background_g and background_b are then unused.\n\n So when decoding, you may get these in a different color mode than the one you requested\n for the raw pixels.\n\n When encoding with auto_convert, you must use the color model defined in info_png.color for\n these values. The encoder normally ignores info_png.color when auto_convert is on, but will\n use it to interpret these values (and convert copies of them to its chosen color model).\n\n When encoding, avoid setting this to an expensive color, such as a non-gray value\n when the image is gray, or the compression will be worse since it will be forced to\n write the PNG with a more expensive color mode (when auto_convert is on).\n\n The decoder does not use this background color to edit the color of pixels. This is a\n completely optional metadata feature.\n */\n unsigned background_defined; /*is a suggested background color given?*/\n unsigned background_r; /*red/gray/palette component of suggested background color*/\n unsigned background_g; /*green component of suggested background color*/\n unsigned background_b; /*blue component of suggested background color*/\n\n /*\n Non-international text chunks (tEXt and zTXt)\n\n The char** arrays each contain num strings. The actual messages are in\n text_strings, while text_keys are keywords that give a short description what\n the actual text represents, e.g. Title, Author, Description, or anything else.\n\n All the string fields below including strings, keys, names and language tags are null terminated.\n The PNG specification uses null characters for the keys, names and tags, and forbids null\n characters to appear in the main text which is why we can use null termination everywhere here.\n\n A keyword is minimum 1 character and maximum 79 characters long (plus the\n additional null terminator). It's discouraged to use a single line length\n longer than 79 characters for texts.\n\n Don't allocate these text buffers yourself. Use the init/cleanup functions\n correctly and use lodepng_add_text and lodepng_clear_text.\n\n Standard text chunk keywords and strings are encoded using Latin-1.\n */\n size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/\n char** text_keys; /*the keyword of a text chunk (e.g. \"Comment\")*/\n char** text_strings; /*the actual text*/\n\n /*\n International text chunks (iTXt)\n Similar to the non-international text chunks, but with additional strings\n \"langtags\" and \"transkeys\", and the following text encodings are used:\n keys: Latin-1, langtags: ASCII, transkeys and strings: UTF-8.\n keys must be 1-79 characters (plus the additional null terminator), the other\n strings are any length.\n */\n size_t itext_num; /*the amount of international texts in this PNG*/\n char** itext_keys; /*the English keyword of the text chunk (e.g. \"Comment\")*/\n char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/\n char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/\n char** itext_strings; /*the actual international text - UTF-8 string*/\n\n /*time chunk (tIME)*/\n unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/\n LodePNGTime time;\n\n /*phys chunk (pHYs)*/\n unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/\n unsigned phys_x; /*pixels per unit in x direction*/\n unsigned phys_y; /*pixels per unit in y direction*/\n unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/\n\n /*\n Color profile related chunks: gAMA, cHRM, sRGB, iCPP\n\n LodePNG does not apply any color conversions on pixels in the encoder or decoder and does not interpret these color\n profile values. It merely passes on the information. If you wish to use color profiles and convert colors, please\n use these values with a color management library.\n\n See the PNG, ICC and sRGB specifications for more information about the meaning of these values.\n */\n\n /* gAMA chunk: optional, overridden by sRGB or iCCP if those are present. */\n unsigned gama_defined; /* Whether a gAMA chunk is present (0 = not present, 1 = present). */\n unsigned gama_gamma; /* Gamma exponent times 100000 */\n\n /* cHRM chunk: optional, overridden by sRGB or iCCP if those are present. */\n unsigned chrm_defined; /* Whether a cHRM chunk is present (0 = not present, 1 = present). */\n unsigned chrm_white_x; /* White Point x times 100000 */\n unsigned chrm_white_y; /* White Point y times 100000 */\n unsigned chrm_red_x; /* Red x times 100000 */\n unsigned chrm_red_y; /* Red y times 100000 */\n unsigned chrm_green_x; /* Green x times 100000 */\n unsigned chrm_green_y; /* Green y times 100000 */\n unsigned chrm_blue_x; /* Blue x times 100000 */\n unsigned chrm_blue_y; /* Blue y times 100000 */\n\n /*\n sRGB chunk: optional. May not appear at the same time as iCCP.\n If gAMA is also present gAMA must contain value 45455.\n If cHRM is also present cHRM must contain respectively 31270,32900,64000,33000,30000,60000,15000,6000.\n */\n unsigned srgb_defined; /* Whether an sRGB chunk is present (0 = not present, 1 = present). */\n unsigned srgb_intent; /* Rendering intent: 0=perceptual, 1=rel. colorimetric, 2=saturation, 3=abs. colorimetric */\n\n /*\n iCCP chunk: optional. May not appear at the same time as sRGB.\n\n LodePNG does not parse or use the ICC profile (except its color space header field for an edge case), a\n separate library to handle the ICC data (not included in LodePNG) format is needed to use it for color\n management and conversions.\n\n For encoding, if iCCP is present, gAMA and cHRM are recommended to be added as well with values that match the ICC\n profile as closely as possible, if you wish to do this you should provide the correct values for gAMA and cHRM and\n enable their '_defined' flags since LodePNG will not automatically compute them from the ICC profile.\n\n For encoding, the ICC profile is required by the PNG specification to be an \"RGB\" profile for non-gray\n PNG color types and a \"GRAY\" profile for gray PNG color types. If you disable auto_convert, you must ensure\n the ICC profile type matches your requested color type, else the encoder gives an error. If auto_convert is\n enabled (the default), and the ICC profile is not a good match for the pixel data, this will result in an encoder\n error if the pixel data has non-gray pixels for a GRAY profile, or a silent less-optimal compression of the pixel\n data if the pixels could be encoded as grayscale but the ICC profile is RGB.\n\n To avoid this do not set an ICC profile in the image unless there is a good reason for it, and when doing so\n make sure you compute it carefully to avoid the above problems.\n */\n unsigned iccp_defined; /* Whether an iCCP chunk is present (0 = not present, 1 = present). */\n char* iccp_name; /* Null terminated string with profile name, 1-79 bytes */\n /*\n The ICC profile in iccp_profile_size bytes.\n Don't allocate this buffer yourself. Use the init/cleanup functions\n correctly and use lodepng_set_icc and lodepng_clear_icc.\n */\n unsigned char* iccp_profile;\n unsigned iccp_profile_size; /* The size of iccp_profile in bytes */\n\n /* End of color profile related chunks */\n\n\n /*\n unknown chunks: chunks not known by LodePNG, passed on byte for byte.\n\n There are 3 buffers, one for each position in the PNG where unknown chunks can appear.\n Each buffer contains all unknown chunks for that position consecutively.\n The 3 positions are:\n 0: between IHDR and PLTE, 1: between PLTE and IDAT, 2: between IDAT and IEND.\n\n For encoding, do not store critical chunks or known chunks that are enabled with a \"_defined\" flag\n above in here, since the encoder will blindly follow this and could then encode an invalid PNG file\n (such as one with two IHDR chunks or the disallowed combination of sRGB with iCCP). But do use\n this if you wish to store an ancillary chunk that is not supported by LodePNG (such as sPLT or hIST),\n or any non-standard PNG chunk.\n\n Do not allocate or traverse this data yourself. Use the chunk traversing functions declared\n later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct.\n */\n unsigned char* unknown_chunks_data[3];\n size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGInfo;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_info_init(LodePNGInfo* info);\nvoid lodepng_info_cleanup(LodePNGInfo* info);\n/*return value is error code (0 means no error)*/\nunsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source);\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\nunsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/\nvoid lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/\n\nunsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag,\n const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/\nvoid lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/\n\n/*replaces if exists*/\nunsigned lodepng_set_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size);\nvoid lodepng_clear_icc(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n\n/*\nConverts raw buffer from one color type to another color type, based on\nLodePNGColorMode structs to describe the input and output color type.\nSee the reference manual at the end of this header file to see which color conversions are supported.\nreturn value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported)\nThe out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel\nof the output color type (lodepng_get_bpp).\nFor < 8 bpp images, there should not be padding bits at the end of scanlines.\nFor 16-bit per channel colors, uses big endian format like PNG does.\nReturn value is LodePNG error code\n*/\nunsigned lodepng_convert(unsigned char* out, const unsigned char* in,\n const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in,\n unsigned w, unsigned h);\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nSettings for the decoder. This contains settings for the PNG and the Zlib\ndecoder, but not the Info settings from the Info structs.\n*/\ntypedef struct LodePNGDecoderSettings {\n LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/\n\n /* Check LodePNGDecompressSettings for more ignorable errors such as ignore_adler32 */\n unsigned ignore_crc; /*ignore CRC checksums*/\n unsigned ignore_critical; /*ignore unknown critical chunks*/\n unsigned ignore_end; /*ignore issues at end of file if possible (missing IEND chunk, too large chunk, ...)*/\n /* TODO: make a system involving warnings with levels and a strict mode instead. Other potentially recoverable\n errors: srgb rendering intent value, size of content of ancillary chunks, more than 79 characters for some\n strings, placement/combination rules for ancillary chunks, crc of unknown chunks, allowed characters\n in string keys, etc... */\n\n unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/\n\n /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/\n unsigned remember_unknown_chunks;\n\n /* maximum size for decompressed text chunks. If a text chunk's text is larger than this, an error is returned,\n unless reading text chunks is disabled or this limit is set higher or disabled. Set to 0 to allow any size.\n By default it is a value that prevents unreasonably large strings from hogging memory. */\n size_t max_text_size;\n\n /* maximum size for compressed ICC chunks. If the ICC profile is larger than this, an error will be returned. Set to\n 0 to allow any size. By default this is a value that prevents ICC profiles that would be much larger than any\n legitimate profile could be to hog memory. */\n size_t max_icc_size;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGDecoderSettings;\n\nvoid lodepng_decoder_settings_init(LodePNGDecoderSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/\ntypedef enum LodePNGFilterStrategy {\n /*every filter at zero*/\n LFS_ZERO = 0,\n /*every filter at 1, 2, 3 or 4 (paeth), unlike LFS_ZERO not a good choice, but for testing*/\n LFS_ONE = 1,\n LFS_TWO = 2,\n LFS_THREE = 3,\n LFS_FOUR = 4,\n /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/\n LFS_MINSUM,\n /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending\n on the image, this is better or worse than minsum.*/\n LFS_ENTROPY,\n /*\n Brute-force-search PNG filters by compressing each filter for each scanline.\n Experimental, very slow, and only rarely gives better compression than MINSUM.\n */\n LFS_BRUTE_FORCE,\n /*use predefined_filters buffer: you specify the filter type for each scanline*/\n LFS_PREDEFINED\n} LodePNGFilterStrategy;\n\n/*Gives characteristics about the integer RGBA colors of the image (count, alpha channel usage, bit depth, ...),\nwhich helps decide which color model to use for encoding.\nUsed internally by default if \"auto_convert\" is enabled. Public because it's useful for custom algorithms.*/\ntypedef struct LodePNGColorStats {\n unsigned colored; /*not grayscale*/\n unsigned key; /*image is not opaque and color key is possible instead of full alpha*/\n unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/\n unsigned short key_g;\n unsigned short key_b;\n unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/\n unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16 or allow_palette is disabled.*/\n unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order, only valid when numcolors is valid*/\n unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for grayscale only. 16 if 16-bit per channel required.*/\n size_t numpixels;\n\n /*user settings for computing/using the stats*/\n unsigned allow_palette; /*default 1. if 0, disallow choosing palette colortype in auto_choose_color, and don't count numcolors*/\n unsigned allow_greyscale; /*default 1. if 0, choose RGB or RGBA even if the image only has gray colors*/\n} LodePNGColorStats;\n\nvoid lodepng_color_stats_init(LodePNGColorStats* stats);\n\n/*Get a LodePNGColorStats of the image. The stats must already have been inited.\nReturns error code (e.g. alloc fail) or 0 if ok.*/\nunsigned lodepng_compute_color_stats(LodePNGColorStats* stats,\n const unsigned char* image, unsigned w, unsigned h,\n const LodePNGColorMode* mode_in);\n\n/*Settings for the encoder.*/\ntypedef struct LodePNGEncoderSettings {\n LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/\n\n unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/\n\n /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than\n 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to\n completely follow the official PNG heuristic, filter_palette_zero must be true and\n filter_strategy must be LFS_MINSUM*/\n unsigned filter_palette_zero;\n /*Which filter strategy to use when not using zeroes due to filter_palette_zero.\n Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/\n LodePNGFilterStrategy filter_strategy;\n /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with\n the same length as the amount of scanlines in the image, and each value must <= 5. You\n have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero\n must be set to 0 to ensure this is also used on palette or low bitdepth images.*/\n const unsigned char* predefined_filters;\n\n /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette).\n If colortype is 3, PLTE is _always_ created.*/\n unsigned force_palette;\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n /*add LodePNG identifier and version as a text chunk, for debugging*/\n unsigned add_id;\n /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/\n unsigned text_compression;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGEncoderSettings;\n\nvoid lodepng_encoder_settings_init(LodePNGEncoderSettings* settings);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n\n#if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER)\n/*The settings, state and information for extended encoding and decoding.*/\ntypedef struct LodePNGState {\n#ifdef LODEPNG_COMPILE_DECODER\n LodePNGDecoderSettings decoder; /*the decoding settings*/\n#endif /*LODEPNG_COMPILE_DECODER*/\n#ifdef LODEPNG_COMPILE_ENCODER\n LodePNGEncoderSettings encoder; /*the encoding settings*/\n#endif /*LODEPNG_COMPILE_ENCODER*/\n LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/\n LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/\n unsigned error;\n} LodePNGState;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_state_init(LodePNGState* state);\nvoid lodepng_state_cleanup(LodePNGState* state);\nvoid lodepng_state_copy(LodePNGState* dest, const LodePNGState* source);\n#endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nSame as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and\ngetting much more information about the PNG image and color mode.\n*/\nunsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h,\n LodePNGState* state,\n const unsigned char* in, size_t insize);\n\n/*\nRead the PNG header, but not the actual data. This returns only the information\nthat is in the IHDR chunk of the PNG, such as width, height and color type. The\ninformation is placed in the info_png field of the LodePNGState.\n*/\nunsigned lodepng_inspect(unsigned* w, unsigned* h,\n LodePNGState* state,\n const unsigned char* in, size_t insize);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n/*\nReads one metadata chunk (other than IHDR) of the PNG file and outputs what it\nread in the state. Returns error code on failure.\nUse lodepng_inspect first with a new state, then e.g. lodepng_chunk_find_const\nto find the desired chunk type, and if non null use lodepng_inspect_chunk (with\nchunk_pointer - start_of_file as pos).\nSupports most metadata chunks from the PNG standard (gAMA, bKGD, tEXt, ...).\nIgnores unsupported, unknown, non-metadata or IHDR chunks (without error).\nRequirements: &in[pos] must point to start of a chunk, must use regular\nlodepng_inspect first since format of most other chunks depends on IHDR, and if\nthere is a PLTE chunk, that one must be inspected before tRNS or bKGD.\n*/\nunsigned lodepng_inspect_chunk(LodePNGState* state, size_t pos,\n const unsigned char* in, size_t insize);\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/\nunsigned lodepng_encode(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGState* state);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n/*\nThe lodepng_chunk functions are normally not needed, except to traverse the\nunknown chunks stored in the LodePNGInfo struct, or add new ones to it.\nIt also allows traversing the chunks of an encoded PNG file yourself.\n\nThe chunk pointer always points to the beginning of the chunk itself, that is\nthe first byte of the 4 length bytes.\n\nIn the PNG file format, chunks have the following format:\n-4 bytes length: length of the data of the chunk in bytes (chunk itself is 12 bytes longer)\n-4 bytes chunk type (ASCII a-z,A-Z only, see below)\n-length bytes of data (may be 0 bytes if length was 0)\n-4 bytes of CRC, computed on chunk name + data\n\nThe first chunk starts at the 8th byte of the PNG file, the entire rest of the file\nexists out of concatenated chunks with the above format.\n\nPNG standard chunk ASCII naming conventions:\n-First byte: uppercase = critical, lowercase = ancillary\n-Second byte: uppercase = public, lowercase = private\n-Third byte: must be uppercase\n-Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy\n*/\n\n/*\nGets the length of the data of the chunk. Total chunk length has 12 bytes more.\nThere must be at least 4 bytes to read from. If the result value is too large,\nit may be corrupt data.\n*/\nunsigned lodepng_chunk_length(const unsigned char* chunk);\n\n/*puts the 4-byte type in null terminated string*/\nvoid lodepng_chunk_type(char type[5], const unsigned char* chunk);\n\n/*check if the type is the given type*/\nunsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type);\n\n/*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/\nunsigned char lodepng_chunk_ancillary(const unsigned char* chunk);\n\n/*0: public, 1: private (see PNG standard)*/\nunsigned char lodepng_chunk_private(const unsigned char* chunk);\n\n/*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/\nunsigned char lodepng_chunk_safetocopy(const unsigned char* chunk);\n\n/*get pointer to the data of the chunk, where the input points to the header of the chunk*/\nunsigned char* lodepng_chunk_data(unsigned char* chunk);\nconst unsigned char* lodepng_chunk_data_const(const unsigned char* chunk);\n\n/*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/\nunsigned lodepng_chunk_check_crc(const unsigned char* chunk);\n\n/*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/\nvoid lodepng_chunk_generate_crc(unsigned char* chunk);\n\n/*\nIterate to next chunks, allows iterating through all chunks of the PNG file.\nInput must be at the beginning of a chunk (result of a previous lodepng_chunk_next call,\nor the 8th byte of a PNG file which always has the first chunk), or alternatively may\npoint to the first byte of the PNG file (which is not a chunk but the magic header, the\nfunction will then skip over it and return the first real chunk).\nWill output pointer to the start of the next chunk, or at or beyond end of the file if there\nis no more chunk after this or possibly if the chunk is corrupt.\nStart this process at the 8th byte of the PNG file.\nIn a non-corrupt PNG file, the last chunk should have name \"IEND\".\n*/\nunsigned char* lodepng_chunk_next(unsigned char* chunk, unsigned char* end);\nconst unsigned char* lodepng_chunk_next_const(const unsigned char* chunk, const unsigned char* end);\n\n/*Finds the first chunk with the given type in the range [chunk, end), or returns NULL if not found.*/\nunsigned char* lodepng_chunk_find(unsigned char* chunk, unsigned char* end, const char type[5]);\nconst unsigned char* lodepng_chunk_find_const(const unsigned char* chunk, const unsigned char* end, const char type[5]);\n\n/*\nAppends chunk to the data in out. The given chunk should already have its chunk header.\nThe out variable and outsize are updated to reflect the new reallocated buffer.\nReturns error code (0 if it went ok)\n*/\nunsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk);\n\n/*\nAppends new chunk to out. The chunk to append is given by giving its length, type\nand data separately. The type is a 4-letter string.\nThe out variable and outsize are updated to reflect the new reallocated buffer.\nReturns error code (0 if it went ok)\n*/\nunsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, unsigned length,\n const char* type, const unsigned char* data);\n\n\n/*Calculate CRC32 of buffer*/\nunsigned lodepng_crc32(const unsigned char* buf, size_t len);\n#endif /*LODEPNG_COMPILE_PNG*/\n\n\n#ifdef LODEPNG_COMPILE_ZLIB\n/*\nThis zlib part can be used independently to zlib compress and decompress a\nbuffer. It cannot be used to create gzip files however, and it only supports the\npart of zlib that is required for PNG, it does not support dictionaries.\n*/\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/\nunsigned lodepng_inflate(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings* settings);\n\n/*\nDecompresses Zlib data. Reallocates the out buffer and appends the data. The\ndata must be according to the zlib specification.\nEither, *out must be NULL and *outsize must be 0, or, *out must be a valid\nbuffer and *outsize its size in bytes. out must be freed by user after usage.\n*/\nunsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nCompresses data with Zlib. Reallocates the out buffer and appends the data.\nZlib adds a small header and trailer around the deflate data.\nThe data is output in the format of the zlib specification.\nEither, *out must be NULL and *outsize must be 0, or, *out must be a valid\nbuffer and *outsize its size in bytes. out must be freed by user after usage.\n*/\nunsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGCompressSettings* settings);\n\n/*\nFind length-limited Huffman code for given frequencies. This function is in the\npublic interface only for tests, it's used internally by lodepng_deflate.\n*/\nunsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies,\n size_t numcodes, unsigned maxbitlen);\n\n/*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/\nunsigned lodepng_deflate(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGCompressSettings* settings);\n\n#endif /*LODEPNG_COMPILE_ENCODER*/\n#endif /*LODEPNG_COMPILE_ZLIB*/\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad a file from disk into buffer. The function allocates the out buffer, and\nafter usage you should free it.\nout: output parameter, contains pointer to loaded buffer.\noutsize: output parameter, size of the allocated out buffer\nfilename: the path to the file to load\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename);\n\n/*\nSave a file from buffer to disk. Warning, if it exists, this function overwrites\nthe file without warning!\nbuffer: the buffer to write\nbuffersize: size of the buffer to write\nfilename: the path to the file to save to\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory\n*/\nunsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename);\n#endif /*LODEPNG_COMPILE_DISK*/\n\n#ifdef LODEPNG_COMPILE_CPP\n/* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */\nnamespace lodepng {\n#ifdef LODEPNG_COMPILE_PNG\nclass State : public LodePNGState {\n public:\n State();\n State(const State& other);\n ~State();\n State& operator=(const State& other);\n};\n\n#ifdef LODEPNG_COMPILE_DECODER\n/* Same as other lodepng::decode, but using a State for more settings and information. */\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n State& state,\n const unsigned char* in, size_t insize);\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n State& state,\n const std::vector& in);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/* Same as other lodepng::encode, but using a State for more settings and information. */\nunsigned encode(std::vector& out,\n const unsigned char* in, unsigned w, unsigned h,\n State& state);\nunsigned encode(std::vector& out,\n const std::vector& in, unsigned w, unsigned h,\n State& state);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad a file from disk into an std::vector.\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory\n*/\nunsigned load_file(std::vector& buffer, const std::string& filename);\n\n/*\nSave the binary data in an std::vector to a file on disk. The file is overwritten\nwithout warning.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory\n*/\nunsigned save_file(const std::vector& buffer, const std::string& filename);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_PNG */\n\n#ifdef LODEPNG_COMPILE_ZLIB\n#ifdef LODEPNG_COMPILE_DECODER\n/* Zlib-decompress an unsigned char buffer */\nunsigned decompress(std::vector& out, const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);\n\n/* Zlib-decompress an std::vector */\nunsigned decompress(std::vector& out, const std::vector& in,\n const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);\n#endif /* LODEPNG_COMPILE_DECODER */\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/* Zlib-compress an unsigned char buffer */\nunsigned compress(std::vector& out, const unsigned char* in, size_t insize,\n const LodePNGCompressSettings& settings = lodepng_default_compress_settings);\n\n/* Zlib-compress an std::vector */\nunsigned compress(std::vector& out, const std::vector& in,\n const LodePNGCompressSettings& settings = lodepng_default_compress_settings);\n#endif /* LODEPNG_COMPILE_ENCODER */\n#endif /* LODEPNG_COMPILE_ZLIB */\n} /* namespace lodepng */\n#endif /*LODEPNG_COMPILE_CPP*/\n\n/*\nTODO:\n[.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often\n[.] check compatibility with various compilers - done but needs to be redone for every newer version\n[X] converting color to 16-bit per channel types\n[X] support color profile chunk types (but never let them touch RGB values by default)\n[ ] support all public PNG chunk types (almost done except sBIT, sPLT and hIST)\n[ ] make sure encoder generates no chunks with size > (2^31)-1\n[ ] partial decoding (stream processing)\n[X] let the \"isFullyOpaque\" function check color keys and transparent palettes too\n[X] better name for the variables \"codes\", \"codesD\", \"codelengthcodes\", \"clcl\" and \"lldl\"\n[ ] allow treating some errors like warnings, when image is recoverable (e.g. 69, 57, 58)\n[ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ...\n[ ] error messages with line numbers (and version)\n[ ] errors in state instead of as return code?\n[ ] new errors/warnings like suspiciously big decompressed ztxt or iccp chunk\n[ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes\n[ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ...\n[ ] allow user to give data (void*) to custom allocator\n[X] provide alternatives for C library functions not present on some platforms (memcpy, ...)\n*/\n\n#endif /*LODEPNG_H inclusion guard*/\n\n/*\nLodePNG Documentation\n---------------------\n\n0. table of contents\n--------------------\n\n 1. about\n 1.1. supported features\n 1.2. features not supported\n 2. C and C++ version\n 3. security\n 4. decoding\n 5. encoding\n 6. color conversions\n 6.1. PNG color types\n 6.2. color conversions\n 6.3. padding bits\n 6.4. A note about 16-bits per channel and endianness\n 7. error values\n 8. chunks and PNG editing\n 9. compiler support\n 10. examples\n 10.1. decoder C++ example\n 10.2. decoder C example\n 11. state settings reference\n 12. changes\n 13. contact information\n\n\n1. about\n--------\n\nPNG is a file format to store raster images losslessly with good compression,\nsupporting different color types and alpha channel.\n\nLodePNG is a PNG codec according to the Portable Network Graphics (PNG)\nSpecification (Second Edition) - W3C Recommendation 10 November 2003.\n\nThe specifications used are:\n\n*) Portable Network Graphics (PNG) Specification (Second Edition):\n http://www.w3.org/TR/2003/REC-PNG-20031110\n*) RFC 1950 ZLIB Compressed Data Format version 3.3:\n http://www.gzip.org/zlib/rfc-zlib.html\n*) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3:\n http://www.gzip.org/zlib/rfc-deflate.html\n\nThe most recent version of LodePNG can currently be found at\nhttp://lodev.org/lodepng/\n\nLodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds\nextra functionality.\n\nLodePNG exists out of two files:\n-lodepng.h: the header file for both C and C++\n-lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage\n\nIf you want to start using LodePNG right away without reading this doc, get the\nexamples from the LodePNG website to see how to use it in code, or check the\nsmaller examples in chapter 13 here.\n\nLodePNG is simple but only supports the basic requirements. To achieve\nsimplicity, the following design choices were made: There are no dependencies\non any external library. There are functions to decode and encode a PNG with\na single function call, and extended versions of these functions taking a\nLodePNGState struct allowing to specify or get more information. By default\nthe colors of the raw image are always RGB or RGBA, no matter what color type\nthe PNG file uses. To read and write files, there are simple functions to\nconvert the files to/from buffers in memory.\n\nThis all makes LodePNG suitable for loading textures in games, demos and small\nprograms, ... It's less suitable for full fledged image editors, loading PNGs\nover network (it requires all the image data to be available before decoding can\nbegin), life-critical systems, ...\n\n1.1. supported features\n-----------------------\n\nThe following features are supported by the decoder:\n\n*) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image,\n or the same color type as the PNG\n*) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image\n*) Adam7 interlace and deinterlace for any color type\n*) loading the image from harddisk or decoding it from a buffer from other sources than harddisk\n*) support for alpha channels, including RGBA color model, translucent palettes and color keying\n*) zlib decompression (inflate)\n*) zlib compression (deflate)\n*) CRC32 and ADLER32 checksums\n*) colorimetric color profile conversions: currently experimentally available in lodepng_util.cpp only,\n plus alternatively ability to pass on chroma/gamma/ICC profile information to other color management system.\n*) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks.\n*) the following chunks are supported by both encoder and decoder:\n IHDR: header information\n PLTE: color palette\n IDAT: pixel data\n IEND: the final chunk\n tRNS: transparency for palettized images\n tEXt: textual information\n zTXt: compressed textual information\n iTXt: international textual information\n bKGD: suggested background color\n pHYs: physical dimensions\n tIME: modification time\n cHRM: RGB chromaticities\n gAMA: RGB gamma correction\n iCCP: ICC color profile\n sRGB: rendering intent\n\n1.2. features not supported\n---------------------------\n\nThe following features are _not_ supported:\n\n*) some features needed to make a conformant PNG-Editor might be still missing.\n*) partial loading/stream processing. All data must be available and is processed in one call.\n*) The following public chunks are not (yet) supported but treated as unknown chunks by LodePNG:\n sBIT\n hIST\n sPLT\n\n\n2. C and C++ version\n--------------------\n\nThe C version uses buffers allocated with alloc that you need to free()\nyourself. You need to use init and cleanup functions for each struct whenever\nusing a struct from the C version to avoid exploits and memory leaks.\n\nThe C++ version has extra functions with std::vectors in the interface and the\nlodepng::State class which is a LodePNGState with constructor and destructor.\n\nThese files work without modification for both C and C++ compilers because all\nthe additional C++ code is in \"#ifdef __cplusplus\" blocks that make C-compilers\nignore it, and the C code is made to compile both with strict ISO C90 and C++.\n\nTo use the C++ version, you need to rename the source file to lodepng.cpp\n(instead of lodepng.c), and compile it with a C++ compiler.\n\nTo use the C version, you need to rename the source file to lodepng.c (instead\nof lodepng.cpp), and compile it with a C compiler.\n\n\n3. Security\n-----------\n\nEven if carefully designed, it's always possible that LodePNG contains possible\nexploits. If you discover one, please let me know, and it will be fixed.\n\nWhen using LodePNG, care has to be taken with the C version of LodePNG, as well\nas the C-style structs when working with C++. The following conventions are used\nfor all C-style structs:\n\n-if a struct has a corresponding init function, always call the init function when making a new one\n-if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks\n-if a struct has a corresponding copy function, use the copy function instead of \"=\".\n The destination must also be inited already.\n\n\n4. Decoding\n-----------\n\nDecoding converts a PNG compressed image to a raw pixel buffer.\n\nMost documentation on using the decoder is at its declarations in the header\nabove. For C, simple decoding can be done with functions such as\nlodepng_decode32, and more advanced decoding can be done with the struct\nLodePNGState and lodepng_decode. For C++, all decoding can be done with the\nvarious lodepng::decode functions, and lodepng::State can be used for advanced\nfeatures.\n\nWhen using the LodePNGState, it uses the following fields for decoding:\n*) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here\n*) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get\n*) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use\n\nLodePNGInfo info_png\n--------------------\n\nAfter decoding, this contains extra information of the PNG image, except the actual\npixels, width and height because these are already gotten directly from the decoder\nfunctions.\n\nIt contains for example the original color type of the PNG image, text comments,\nsuggested background color, etc... More details about the LodePNGInfo struct are\nat its declaration documentation.\n\nLodePNGColorMode info_raw\n-------------------------\n\nWhen decoding, here you can specify which color type you want\nthe resulting raw image to be. If this is different from the colortype of the\nPNG, then the decoder will automatically convert the result. This conversion\nalways works, except if you want it to convert a color PNG to grayscale or to\na palette with missing colors.\n\nBy default, 32-bit color is used for the result.\n\nLodePNGDecoderSettings decoder\n------------------------------\n\nThe settings can be used to ignore the errors created by invalid CRC and Adler32\nchunks, and to disable the decoding of tEXt chunks.\n\nThere's also a setting color_convert, true by default. If false, no conversion\nis done, the resulting data will be as it was in the PNG (after decompression)\nand you'll have to puzzle the colors of the pixels together yourself using the\ncolor type information in the LodePNGInfo.\n\n\n5. Encoding\n-----------\n\nEncoding converts a raw pixel buffer to a PNG compressed image.\n\nMost documentation on using the encoder is at its declarations in the header\nabove. For C, simple encoding can be done with functions such as\nlodepng_encode32, and more advanced decoding can be done with the struct\nLodePNGState and lodepng_encode. For C++, all encoding can be done with the\nvarious lodepng::encode functions, and lodepng::State can be used for advanced\nfeatures.\n\nLike the decoder, the encoder can also give errors. However it gives less errors\nsince the encoder input is trusted, the decoder input (a PNG image that could\nbe forged by anyone) is not trusted.\n\nWhen using the LodePNGState, it uses the following fields for encoding:\n*) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be.\n*) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has\n*) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use\n\nLodePNGInfo info_png\n--------------------\n\nWhen encoding, you use this the opposite way as when decoding: for encoding,\nyou fill in the values you want the PNG to have before encoding. By default it's\nnot needed to specify a color type for the PNG since it's automatically chosen,\nbut it's possible to choose it yourself given the right settings.\n\nThe encoder will not always exactly match the LodePNGInfo struct you give,\nit tries as close as possible. Some things are ignored by the encoder. The\nencoder uses, for example, the following settings from it when applicable:\ncolortype and bitdepth, text chunks, time chunk, the color key, the palette, the\nbackground color, the interlace method, unknown chunks, ...\n\nWhen encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk.\nIf the palette contains any colors for which the alpha channel is not 255 (so\nthere are translucent colors in the palette), it'll add a tRNS chunk.\n\nLodePNGColorMode info_raw\n-------------------------\n\nYou specify the color type of the raw image that you give to the input here,\nincluding a possible transparent color key and palette you happen to be using in\nyour raw image data.\n\nBy default, 32-bit color is assumed, meaning your input has to be in RGBA\nformat with 4 bytes (unsigned chars) per pixel.\n\nLodePNGEncoderSettings encoder\n------------------------------\n\nThe following settings are supported (some are in sub-structs):\n*) auto_convert: when this option is enabled, the encoder will\nautomatically choose the smallest possible color mode (including color key) that\ncan encode the colors of all pixels without information loss.\n*) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree,\n 2 = dynamic huffman tree (best compression). Should be 2 for proper\n compression.\n*) use_lz77: whether or not to use LZ77 for compressed block types. Should be\n true for proper compression.\n*) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value\n 2048 by default, but can be set to 32768 for better, but slow, compression.\n*) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE\n chunk if force_palette is true. This can used as suggested palette to convert\n to by viewers that don't support more than 256 colors (if those still exist)\n*) add_id: add text chunk \"Encoder: LodePNG \" to the image.\n*) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks.\n zTXt chunks use zlib compression on the text. This gives a smaller result on\n large texts but a larger result on small texts (such as a single program name).\n It's all tEXt or all zTXt though, there's no separate setting per text yet.\n\n\n6. color conversions\n--------------------\n\nAn important thing to note about LodePNG, is that the color type of the PNG, and\nthe color type of the raw image, are completely independent. By default, when\nyou decode a PNG, you get the result as a raw image in the color type you want,\nno matter whether the PNG was encoded with a palette, grayscale or RGBA color.\nAnd if you encode an image, by default LodePNG will automatically choose the PNG\ncolor type that gives good compression based on the values of colors and amount\nof colors in the image. It can be configured to let you control it instead as\nwell, though.\n\nTo be able to do this, LodePNG does conversions from one color mode to another.\nIt can convert from almost any color type to any other color type, except the\nfollowing conversions: RGB to grayscale is not supported, and converting to a\npalette when the palette doesn't have a required color is not supported. This is\nnot supported on purpose: this is information loss which requires a color\nreduction algorithm that is beyond the scope of a PNG encoder (yes, RGB to gray\nis easy, but there are multiple ways if you want to give some channels more\nweight).\n\nBy default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB\ncolor, no matter what color type the PNG has. And by default when encoding,\nLodePNG automatically picks the best color model for the output PNG, and expects\nthe input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control\nthe color format of the images yourself, you can skip this chapter.\n\n6.1. PNG color types\n--------------------\n\nA PNG image can have many color types, ranging from 1-bit color to 64-bit color,\nas well as palettized color modes. After the zlib decompression and unfiltering\nin the PNG image is done, the raw pixel data will have that color type and thus\na certain amount of bits per pixel. If you want the output raw image after\ndecoding to have another color type, a conversion is done by LodePNG.\n\nThe PNG specification gives the following color types:\n\n0: grayscale, bit depths 1, 2, 4, 8, 16\n2: RGB, bit depths 8 and 16\n3: palette, bit depths 1, 2, 4 and 8\n4: grayscale with alpha, bit depths 8 and 16\n6: RGBA, bit depths 8 and 16\n\nBit depth is the amount of bits per pixel per color channel. So the total amount\nof bits per pixel is: amount of channels * bitdepth.\n\n6.2. color conversions\n----------------------\n\nAs explained in the sections about the encoder and decoder, you can specify\ncolor types and bit depths in info_png and info_raw to change the default\nbehaviour.\n\nIf, when decoding, you want the raw image to be something else than the default,\nyou need to set the color type and bit depth you want in the LodePNGColorMode,\nor the parameters colortype and bitdepth of the simple decoding function.\n\nIf, when encoding, you use another color type than the default in the raw input\nimage, you need to specify its color type and bit depth in the LodePNGColorMode\nof the raw image, or use the parameters colortype and bitdepth of the simple\nencoding function.\n\nIf, when encoding, you don't want LodePNG to choose the output PNG color type\nbut control it yourself, you need to set auto_convert in the encoder settings\nto false, and specify the color type you want in the LodePNGInfo of the\nencoder (including palette: it can generate a palette if auto_convert is true,\notherwise not).\n\nIf the input and output color type differ (whether user chosen or auto chosen),\nLodePNG will do a color conversion, which follows the rules below, and may\nsometimes result in an error.\n\nTo avoid some confusion:\n-the decoder converts from PNG to raw image\n-the encoder converts from raw image to PNG\n-the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image\n-the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG\n-when encoding, the color type in LodePNGInfo is ignored if auto_convert\n is enabled, it is automatically generated instead\n-when decoding, the color type in LodePNGInfo is set by the decoder to that of the original\n PNG image, but it can be ignored since the raw image has the color type you requested instead\n-if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion\n between the color types is done if the color types are supported. If it is not\n supported, an error is returned. If the types are the same, no conversion is done.\n-even though some conversions aren't supported, LodePNG supports loading PNGs from any\n colortype and saving PNGs to any colortype, sometimes it just requires preparing\n the raw image correctly before encoding.\n-both encoder and decoder use the same color converter.\n\nThe function lodepng_convert does the color conversion. It is available in the\ninterface but normally isn't needed since the encoder and decoder already call\nit.\n\nNon supported color conversions:\n-color to grayscale when non-gray pixels are present: no error is thrown, but\nthe result will look ugly because only the red channel is taken (it assumes all\nthree channels are the same in this case so ignores green and blue). The reason\nno error is given is to allow converting from three-channel grayscale images to\none-channel even if there are numerical imprecisions.\n-anything to palette when the palette does not have an exact match for a from-color\nin it: in this case an error is thrown\n\nSupported color conversions:\n-anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA\n-any gray or gray+alpha, to gray or gray+alpha\n-anything to a palette, as long as the palette has the requested colors in it\n-removing alpha channel\n-higher to smaller bitdepth, and vice versa\n\nIf you want no color conversion to be done (e.g. for speed or control):\n-In the encoder, you can make it save a PNG with any color type by giving the\nraw color mode and LodePNGInfo the same color mode, and setting auto_convert to\nfalse.\n-In the decoder, you can make it store the pixel data in the same color type\nas the PNG has, by setting the color_convert setting to false. Settings in\ninfo_raw are then ignored.\n\n6.3. padding bits\n-----------------\n\nIn the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines\nhave a bit amount that isn't a multiple of 8, then padding bits are used so that each\nscanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output.\nThe raw input image you give to the encoder, and the raw output image you get from the decoder\nwill NOT have these padding bits, e.g. in the case of a 1-bit image with a width\nof 7 pixels, the first pixel of the second scanline will the 8th bit of the first byte,\nnot the first bit of a new byte.\n\n6.4. A note about 16-bits per channel and endianness\n----------------------------------------------------\n\nLodePNG uses unsigned char arrays for 16-bit per channel colors too, just like\nfor any other color format. The 16-bit values are stored in big endian (most\nsignificant byte first) in these arrays. This is the opposite order of the\nlittle endian used by x86 CPU's.\n\nLodePNG always uses big endian because the PNG file format does so internally.\nConversions to other formats than PNG uses internally are not supported by\nLodePNG on purpose, there are myriads of formats, including endianness of 16-bit\ncolors, the order in which you store R, G, B and A, and so on. Supporting and\nconverting to/from all that is outside the scope of LodePNG.\n\nThis may mean that, depending on your use case, you may want to convert the big\nendian output of LodePNG to little endian with a for loop. This is certainly not\nalways needed, many applications and libraries support big endian 16-bit colors\nanyway, but it means you cannot simply cast the unsigned char* buffer to an\nunsigned short* buffer on x86 CPUs.\n\n\n7. error values\n---------------\n\nAll functions in LodePNG that return an error code, return 0 if everything went\nOK, or a non-zero code if there was an error.\n\nThe meaning of the LodePNG error values can be retrieved with the function\nlodepng_error_text: given the numerical error code, it returns a description\nof the error in English as a string.\n\nCheck the implementation of lodepng_error_text to see the meaning of each code.\n\nIt is not recommended to use the numerical values to programmatically make\ndifferent decisions based on error types as the numbers are not guaranteed to\nstay backwards compatible. They are for human consumption only. Programmatically\nonly 0 or non-0 matter.\n\n\n8. chunks and PNG editing\n-------------------------\n\nIf you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG\neditor that should follow the rules about handling of unknown chunks, or if your\nprogram is able to read other types of chunks than the ones handled by LodePNG,\nthen that's possible with the chunk functions of LodePNG.\n\nA PNG chunk has the following layout:\n\n4 bytes length\n4 bytes type name\nlength bytes data\n4 bytes CRC\n\n8.1. iterating through chunks\n-----------------------------\n\nIf you have a buffer containing the PNG image data, then the first chunk (the\nIHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the\nsignature of the PNG and are not part of a chunk. But if you start at byte 8\nthen you have a chunk, and can check the following things of it.\n\nNOTE: none of these functions check for memory buffer boundaries. To avoid\nexploits, always make sure the buffer contains all the data of the chunks.\nWhen using lodepng_chunk_next, make sure the returned value is within the\nallocated memory.\n\nunsigned lodepng_chunk_length(const unsigned char* chunk):\n\nGet the length of the chunk's data. The total chunk length is this length + 12.\n\nvoid lodepng_chunk_type(char type[5], const unsigned char* chunk):\nunsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type):\n\nGet the type of the chunk or compare if it's a certain type\n\nunsigned char lodepng_chunk_critical(const unsigned char* chunk):\nunsigned char lodepng_chunk_private(const unsigned char* chunk):\nunsigned char lodepng_chunk_safetocopy(const unsigned char* chunk):\n\nCheck if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are).\nCheck if the chunk is private (public chunks are part of the standard, private ones not).\nCheck if the chunk is safe to copy. If it's not, then, when modifying data in a critical\nchunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your\nprogram doesn't handle that type of unknown chunk.\n\nunsigned char* lodepng_chunk_data(unsigned char* chunk):\nconst unsigned char* lodepng_chunk_data_const(const unsigned char* chunk):\n\nGet a pointer to the start of the data of the chunk.\n\nunsigned lodepng_chunk_check_crc(const unsigned char* chunk):\nvoid lodepng_chunk_generate_crc(unsigned char* chunk):\n\nCheck if the crc is correct or generate a correct one.\n\nunsigned char* lodepng_chunk_next(unsigned char* chunk):\nconst unsigned char* lodepng_chunk_next_const(const unsigned char* chunk):\n\nIterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these\nfunctions do no boundary checking of the allocated data whatsoever, so make sure there is enough\ndata available in the buffer to be able to go to the next chunk.\n\nunsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk):\nunsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, unsigned length,\n const char* type, const unsigned char* data):\n\nThese functions are used to create new chunks that are appended to the data in *out that has\nlength *outsize. The append function appends an existing chunk to the new data. The create\nfunction creates a new chunk with the given parameters and appends it. Type is the 4-letter\nname of the chunk.\n\n8.2. chunks in info_png\n-----------------------\n\nThe LodePNGInfo struct contains fields with the unknown chunk in it. It has 3\nbuffers (each with size) to contain 3 types of unknown chunks:\nthe ones that come before the PLTE chunk, the ones that come between the PLTE\nand the IDAT chunks, and the ones that come after the IDAT chunks.\nIt's necessary to make the distinction between these 3 cases because the PNG\nstandard forces to keep the ordering of unknown chunks compared to the critical\nchunks, but does not force any other ordering rules.\n\ninfo_png.unknown_chunks_data[0] is the chunks before PLTE\ninfo_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT\ninfo_png.unknown_chunks_data[2] is the chunks after IDAT\n\nThe chunks in these 3 buffers can be iterated through and read by using the same\nway described in the previous subchapter.\n\nWhen using the decoder to decode a PNG, you can make it store all unknown chunks\nif you set the option settings.remember_unknown_chunks to 1. By default, this\noption is off (0).\n\nThe encoder will always encode unknown chunks that are stored in the info_png.\nIf you need it to add a particular chunk that isn't known by LodePNG, you can\nuse lodepng_chunk_append or lodepng_chunk_create to the chunk data in\ninfo_png.unknown_chunks_data[x].\n\nChunks that are known by LodePNG should not be added in that way. E.g. to make\nLodePNG add a bKGD chunk, set background_defined to true and add the correct\nparameters there instead.\n\n\n9. compiler support\n-------------------\n\nNo libraries other than the current standard C library are needed to compile\nLodePNG. For the C++ version, only the standard C++ library is needed on top.\nAdd the files lodepng.c(pp) and lodepng.h to your project, include\nlodepng.h where needed, and your program can read/write PNG files.\n\nIt is compatible with C90 and up, and C++03 and up.\n\nIf performance is important, use optimization when compiling! For both the\nencoder and decoder, this makes a large difference.\n\nMake sure that LodePNG is compiled with the same compiler of the same version\nand with the same settings as the rest of the program, or the interfaces with\nstd::vectors and std::strings in C++ can be incompatible.\n\nCHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets.\n\n*) gcc and g++\n\nLodePNG is developed in gcc so this compiler is natively supported. It gives no\nwarnings with compiler options \"-Wall -Wextra -pedantic -ansi\", with gcc and g++\nversion 4.7.1 on Linux, 32-bit and 64-bit.\n\n*) Clang\n\nFully supported and warning-free.\n\n*) Mingw\n\nThe Mingw compiler (a port of gcc for Windows) should be fully supported by\nLodePNG.\n\n*) Visual Studio and Visual C++ Express Edition\n\nLodePNG should be warning-free with warning level W4. Two warnings were disabled\nwith pragmas though: warning 4244 about implicit conversions, and warning 4996\nwhere it wants to use a non-standard function fopen_s instead of the standard C\nfopen.\n\nVisual Studio may want \"stdafx.h\" files to be included in each source file and\ngive an error \"unexpected end of file while looking for precompiled header\".\nThis is not standard C++ and will not be added to the stock LodePNG. You can\ndisable it for lodepng.cpp only by right clicking it, Properties, C/C++,\nPrecompiled Headers, and set it to Not Using Precompiled Headers there.\n\nNOTE: Modern versions of VS should be fully supported, but old versions, e.g.\nVS6, are not guaranteed to work.\n\n*) Compilers on Macintosh\n\nLodePNG has been reported to work both with gcc and LLVM for Macintosh, both for\nC and C++.\n\n*) Other Compilers\n\nIf you encounter problems on any compilers, feel free to let me know and I may\ntry to fix it if the compiler is modern and standards compliant.\n\n\n10. examples\n------------\n\nThis decoder example shows the most basic usage of LodePNG. More complex\nexamples can be found on the LodePNG website.\n\nNOTE: these examples do not support wide-character filenames, you can use an\nexternal method to handle such files and encode or decode in-memory\n\n10.1. decoder C++ example\n-------------------------\n\n#include \"lodepng.h\"\n#include \n\nint main(int argc, char *argv[]) {\n const char* filename = argc > 1 ? argv[1] : \"test.png\";\n\n //load and decode\n std::vector image;\n unsigned width, height;\n unsigned error = lodepng::decode(image, width, height, filename);\n\n //if there's an error, display it\n if(error) std::cout << \"decoder error \" << error << \": \" << lodepng_error_text(error) << std::endl;\n\n //the pixels are now in the vector \"image\", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ...\n}\n\n10.2. decoder C example\n-----------------------\n\n#include \"lodepng.h\"\n\nint main(int argc, char *argv[]) {\n unsigned error;\n unsigned char* image;\n size_t width, height;\n const char* filename = argc > 1 ? argv[1] : \"test.png\";\n\n error = lodepng_decode32_file(&image, &width, &height, filename);\n\n if(error) printf(\"decoder error %u: %s\\n\", error, lodepng_error_text(error));\n\n / * use image here * /\n\n free(image);\n return 0;\n}\n\n11. state settings reference\n----------------------------\n\nA quick reference of some settings to set on the LodePNGState\n\nFor decoding:\n\nstate.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums\nstate.decoder.zlibsettings.custom_...: use custom inflate function\nstate.decoder.ignore_crc: ignore CRC checksums\nstate.decoder.ignore_critical: ignore unknown critical chunks\nstate.decoder.ignore_end: ignore missing IEND chunk. May fail if this corruption causes other errors\nstate.decoder.color_convert: convert internal PNG color to chosen one\nstate.decoder.read_text_chunks: whether to read in text metadata chunks\nstate.decoder.remember_unknown_chunks: whether to read in unknown chunks\nstate.info_raw.colortype: desired color type for decoded image\nstate.info_raw.bitdepth: desired bit depth for decoded image\nstate.info_raw....: more color settings, see struct LodePNGColorMode\nstate.info_png....: no settings for decoder but output, see struct LodePNGInfo\n\nFor encoding:\n\nstate.encoder.zlibsettings.btype: disable compression by setting it to 0\nstate.encoder.zlibsettings.use_lz77: use LZ77 in compression\nstate.encoder.zlibsettings.windowsize: tweak LZ77 windowsize\nstate.encoder.zlibsettings.minmatch: tweak min LZ77 length to match\nstate.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching\nstate.encoder.zlibsettings.lazymatching: try one more LZ77 matching\nstate.encoder.zlibsettings.custom_...: use custom deflate function\nstate.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png\nstate.encoder.filter_palette_zero: PNG filter strategy for palette\nstate.encoder.filter_strategy: PNG filter strategy to encode with\nstate.encoder.force_palette: add palette even if not encoding to one\nstate.encoder.add_id: add LodePNG identifier and version as a text chunk\nstate.encoder.text_compression: use compressed text chunks for metadata\nstate.info_raw.colortype: color type of raw input image you provide\nstate.info_raw.bitdepth: bit depth of raw input image you provide\nstate.info_raw: more color settings, see struct LodePNGColorMode\nstate.info_png.color.colortype: desired color type if auto_convert is false\nstate.info_png.color.bitdepth: desired bit depth if auto_convert is false\nstate.info_png.color....: more color settings, see struct LodePNGColorMode\nstate.info_png....: more PNG related settings, see struct LodePNGInfo\n\n\n12. changes\n-----------\n\nThe version number of LodePNG is the date of the change given in the format\nyyyymmdd.\n\nSome changes aren't backwards compatible. Those are indicated with a (!)\nsymbol.\n\nNot all changes are listed here, the commit history in github lists more:\nhttps://github.com/lvandeve/lodepng\n\n*) 09 jan 2022: minor decoder speed improvements.\n*) 27 jun 2021: added warnings that file reading/writing functions don't support\n wide-character filenames (support for this is not planned, opening files is\n not the core part of PNG decoding/decoding and is platform dependent).\n*) 17 okt 2020: prevent decoding too large text/icc chunks by default.\n*) 06 mar 2020: simplified some of the dynamic memory allocations.\n*) 12 jan 2020: (!) added 'end' argument to lodepng_chunk_next to allow correct\n overflow checks.\n*) 14 aug 2019: around 25% faster decoding thanks to huffman lookup tables.\n*) 15 jun 2019: (!) auto_choose_color API changed (for bugfix: don't use palette\n if gray ICC profile) and non-ICC LodePNGColorProfile renamed to\n LodePNGColorStats.\n*) 30 dec 2018: code style changes only: removed newlines before opening braces.\n*) 10 sep 2018: added way to inspect metadata chunks without full decoding.\n*) 19 aug 2018: (!) fixed color mode bKGD is encoded with and made it use\n palette index in case of palette.\n*) 10 aug 2018: (!) added support for gAMA, cHRM, sRGB and iCCP chunks. This\n change is backwards compatible unless you relied on unknown_chunks for those.\n*) 11 jun 2018: less restrictive check for pixel size integer overflow\n*) 14 jan 2018: allow optionally ignoring a few more recoverable errors\n*) 17 sep 2017: fix memory leak for some encoder input error cases\n*) 27 nov 2016: grey+alpha auto color model detection bugfix\n*) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort).\n*) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within\n the limits of pure C90).\n*) 08 dec 2015: Made load_file function return error if file can't be opened.\n*) 24 okt 2015: Bugfix with decoding to palette output.\n*) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding.\n*) 24 aug 2014: Moved to github\n*) 23 aug 2014: Reduced needless memory usage of decoder.\n*) 28 jun 2014: Removed fix_png setting, always support palette OOB for\n simplicity. Made ColorProfile public.\n*) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization.\n*) 22 dec 2013: Power of two windowsize required for optimization.\n*) 15 apr 2013: Fixed bug with LAC_ALPHA and color key.\n*) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png).\n*) 11 mar 2013: (!) Bugfix with custom free. Changed from \"my\" to \"lodepng_\"\n prefix for the custom allocators and made it possible with a new #define to\n use custom ones in your project without needing to change lodepng's code.\n*) 28 jan 2013: Bugfix with color key.\n*) 27 okt 2012: Tweaks in text chunk keyword length error handling.\n*) 8 okt 2012: (!) Added new filter strategy (entropy) and new auto color mode.\n (no palette). Better deflate tree encoding. New compression tweak settings.\n Faster color conversions while decoding. Some internal cleanups.\n*) 23 sep 2012: Reduced warnings in Visual Studio a little bit.\n*) 1 sep 2012: (!) Removed #define's for giving custom (de)compression functions\n and made it work with function pointers instead.\n*) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc\n and free functions and toggle #defines from compiler flags. Small fixes.\n*) 6 may 2012: (!) Made plugging in custom zlib/deflate functions more flexible.\n*) 22 apr 2012: (!) Made interface more consistent, renaming a lot. Removed\n redundant C++ codec classes. Reduced amount of structs. Everything changed,\n but it is cleaner now imho and functionality remains the same. Also fixed\n several bugs and shrunk the implementation code. Made new samples.\n*) 6 nov 2011: (!) By default, the encoder now automatically chooses the best\n PNG color model and bit depth, based on the amount and type of colors of the\n raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color.\n*) 9 okt 2011: simpler hash chain implementation for the encoder.\n*) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching.\n*) 23 aug 2011: tweaked the zlib compression parameters after benchmarking.\n A bug with the PNG filtertype heuristic was fixed, so that it chooses much\n better ones (it's quite significant). A setting to do an experimental, slow,\n brute force search for PNG filter types is added.\n*) 17 aug 2011: (!) changed some C zlib related function names.\n*) 16 aug 2011: made the code less wide (max 120 characters per line).\n*) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors.\n*) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled.\n*) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman\n to optimize long sequences of zeros.\n*) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and\n LodePNG_InfoColor_canHaveAlpha functions for convenience.\n*) 7 nov 2010: added LodePNG_error_text function to get error code description.\n*) 30 okt 2010: made decoding slightly faster\n*) 26 okt 2010: (!) changed some C function and struct names (more consistent).\n Reorganized the documentation and the declaration order in the header.\n*) 08 aug 2010: only changed some comments and external samples.\n*) 05 jul 2010: fixed bug thanks to warnings in the new gcc version.\n*) 14 mar 2010: fixed bug where too much memory was allocated for char buffers.\n*) 02 sep 2008: fixed bug where it could create empty tree that linux apps could\n read by ignoring the problem but windows apps couldn't.\n*) 06 jun 2008: added more error checks for out of memory cases.\n*) 26 apr 2008: added a few more checks here and there to ensure more safety.\n*) 06 mar 2008: crash with encoding of strings fixed\n*) 02 feb 2008: support for international text chunks added (iTXt)\n*) 23 jan 2008: small cleanups, and #defines to divide code in sections\n*) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor.\n*) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder.\n*) 17 jan 2008: ability to encode and decode compressed zTXt chunks added\n Also various fixes, such as in the deflate and the padding bits code.\n*) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved\n filtering code of encoder.\n*) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A\n C++ wrapper around this provides an interface almost identical to before.\n Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code\n are together in these files but it works both for C and C++ compilers.\n*) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks\n*) 30 aug 2007: bug fixed which makes this Borland C++ compatible\n*) 09 aug 2007: some VS2005 warnings removed again\n*) 21 jul 2007: deflate code placed in new namespace separate from zlib code\n*) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images\n*) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing\n invalid std::vector element [0] fixed, and level 3 and 4 warnings removed\n*) 02 jun 2007: made the encoder add a tag with version by default\n*) 27 may 2007: zlib and png code separated (but still in the same file),\n simple encoder/decoder functions added for more simple usage cases\n*) 19 may 2007: minor fixes, some code cleaning, new error added (error 69),\n moved some examples from here to lodepng_examples.cpp\n*) 12 may 2007: palette decoding bug fixed\n*) 24 apr 2007: changed the license from BSD to the zlib license\n*) 11 mar 2007: very simple addition: ability to encode bKGD chunks.\n*) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding\n palettized PNG images. Plus little interface change with palette and texts.\n*) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes.\n Fixed a bug where the end code of a block had length 0 in the Huffman tree.\n*) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented\n and supported by the encoder, resulting in smaller PNGs at the output.\n*) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone.\n*) 24 jan 2007: gave encoder an error interface. Added color conversion from any\n greyscale type to 8-bit greyscale with or without alpha.\n*) 21 jan 2007: (!) Totally changed the interface. It allows more color types\n to convert to and is more uniform. See the manual for how it works now.\n*) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days:\n encode/decode custom tEXt chunks, separate classes for zlib & deflate, and\n at last made the decoder give errors for incorrect Adler32 or Crc.\n*) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel.\n*) 29 dec 2006: Added support for encoding images without alpha channel, and\n cleaned out code as well as making certain parts faster.\n*) 28 dec 2006: Added \"Settings\" to the encoder.\n*) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now.\n Removed some code duplication in the decoder. Fixed little bug in an example.\n*) 09 dec 2006: (!) Placed output parameters of public functions as first parameter.\n Fixed a bug of the decoder with 16-bit per color.\n*) 15 okt 2006: Changed documentation structure\n*) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the\n given image buffer, however for now it's not compressed.\n*) 08 sep 2006: (!) Changed to interface with a Decoder class\n*) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different\n way. Renamed decodePNG to decodePNGGeneric.\n*) 29 jul 2006: (!) Changed the interface: image info is now returned as a\n struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy.\n*) 28 jul 2006: Cleaned the code and added new error checks.\n Corrected terminology \"deflate\" into \"inflate\".\n*) 23 jun 2006: Added SDL example in the documentation in the header, this\n example allows easy debugging by displaying the PNG and its transparency.\n*) 22 jun 2006: (!) Changed way to obtain error value. Added\n loadFile function for convenience. Made decodePNG32 faster.\n*) 21 jun 2006: (!) Changed type of info vector to unsigned.\n Changed position of palette in info vector. Fixed an important bug that\n happened on PNGs with an uncompressed block.\n*) 16 jun 2006: Internally changed unsigned into unsigned where\n needed, and performed some optimizations.\n*) 07 jun 2006: (!) Renamed functions to decodePNG and placed them\n in LodePNG namespace. Changed the order of the parameters. Rewrote the\n documentation in the header. Renamed files to lodepng.cpp and lodepng.h\n*) 22 apr 2006: Optimized and improved some code\n*) 07 sep 2005: (!) Changed to std::vector interface\n*) 12 aug 2005: Initial release (C++, decoder only)\n\n\n13. contact information\n-----------------------\n\nFeel free to contact me with suggestions, problems, comments, ... concerning\nLodePNG. If you encounter a PNG image that doesn't work properly with this\ndecoder, feel free to send it and I'll use it to find and fix the problem.\n\nMy email address is (puzzle the account and domain together with an @ symbol):\nDomain: gmail dot com.\nAccount: lode dot vandevenne.\n\n\nCopyright (c) 2005-2022 Lode Vandevenne\n*/\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/lodepng/lodepng.cpp", "content": "#include \"lodepng.h\"\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_7/src/user_objects.cc", "content": "#include \"user_objects.h\"\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_8/Package.swift", "content": "// swift-tools-version:5.8.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CXX17WithFModules\",\n targets: [\n .target(\n name: \"lodepng\",\n path: \"lodepng\",\n sources: [\"lodepng.cpp\"],\n publicHeadersPath: \"include\"),\n .target(name: \"CXX17WithFModules\", dependencies: [\"lodepng\"], path: \"./\", sources: [\"src/user_objects.cc\"], publicHeadersPath: \"include\"),\n ],\n cxxLanguageStandard: .cxx17\n)\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_8/include/user_objects.h", "content": "// Copyright 2021 DeepMind Technologies Limited\n//\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\n#ifndef MUJOCO_SRC_USER_USER_OBJECTS_H_\n#define MUJOCO_SRC_USER_USER_OBJECTS_H_\n\n#include \n#include \n\n#include \"lodepng.h\"\n\n// forward declarations of all mjC/X classes\nclass mjCError;\nclass mjCAlternative;\nclass mjCBase;\nclass mjCBody;\nclass mjCJoint;\nclass mjCGeom;\nclass mjCSite;\nclass mjCCamera;\nclass mjCLight;\nclass mjCMesh;\nclass mjCSkin;\nclass mjCTexture;\nclass mjCMaterial;\nclass mjCPair;\nclass mjCBodyPair;\nclass mjCEquality;\nclass mjCTendon;\nclass mjCWrap;\nclass mjCActuator;\nclass mjCSensor;\nclass mjCNumeric;\nclass mjCText;\nclass mjCTuple;\nclass mjCDef;\nclass mjCMesh; // defined in user_mesh\nclass mjCModel; // defined in user_model\nclass mjXWriter; // defined in xml_native\nclass mjXURDF; // defined in xml_urdf\n\n\n//------------------------- helper classes and constants -------------------------------------------\n\n\n// builtin type for procedural textures\ntypedef enum _mjtBuiltin {\n mjBUILTIN_NONE = 0, // no builtin\n mjBUILTIN_GRADIENT, // circular gradient: rgb1->rgb2->rgb3\n mjBUILTIN_CHECKER, // checker pattern: rgb1, rgb2\n mjBUILTIN_FLAT // 2d: rgb1; cube: rgb1-up, rgb2-side, rgb3-down\n} mjtBuiltin;\n\n\n// mark type for procedural textures\ntypedef enum _mjtMark {\n mjMARK_NONE = 0, // no mark\n mjMARK_EDGE, // paint edges\n mjMARK_CROSS, // paint cross\n mjMARK_RANDOM // paint random dots\n} mjtMark;\n\n\n// error information\nclass mjCError {\n public:\n mjCError(const mjCBase* obj = 0,\n const char* msg = 0,\n const char* str = 0,\n int pos1 = 0,\n int pos2 = 0);\n\n char message[500]; // error message\n bool warning; // is this a warning instead of error\n};\n\n\n// alternative specifications of frame orientation\nclass mjCAlternative {\n public:\n mjCAlternative(); // constructor\n const char* Set(double* quat, double* inertia, // set frame quat and diag. inertia\n bool degree, // angle format: degree/radian\n const char* sequence); // euler sequence format: \"xyz\"\n\n double axisangle[4]; // rotation axis and angle\n double xyaxes[6]; // x and y axes\n double zaxis[3]; // z axis (use minimal rotation)\n double euler[3]; // euler rotations\n double fullinertia[6]; // non-axis-aligned inertia matrix\n};\n\n\n\n//------------------------- class mjCBase ----------------------------------------------------------\n// Generic functionality for all derived classes\n\nclass mjCBase {\n friend class mjCDef;\n\n public:\n std::string name; // object name\n std::string classname; // defaults class name\n int id; // object id\n int xmlpos[2]; // row and column in xml file\n mjCDef* def; // defaults class used to init this object\n\n protected:\n mjCBase(); // constructor\n mjCModel* model; // pointer to model that created object\n};\n\n\n\n//------------------------- class mjCBody -----------------------------------------------\n// Describes a rigid body\n\nclass mjCBody : public mjCBase {\n friend class mjCJoint;\n friend class mjCGeom;\n friend class mjCSite;\n friend class mjCCamera;\n friend class mjCLight;\n friend class mjCEquality;\n friend class mjCPair;\n friend class mjCModel;\n friend class mjXReader;\n friend class mjXWriter;\n friend class mjXURDF;\n\n public:\n // API for adding objects to body\n mjCBody* AddBody(mjCDef* = 0);\n mjCJoint* AddJoint(mjCDef* = 0, bool isfree = false);\n mjCGeom* AddGeom(mjCDef* = 0);\n mjCSite* AddSite(mjCDef* = 0);\n mjCCamera* AddCamera(mjCDef* = 0);\n mjCLight* AddLight(mjCDef* = 0);\n\n\n // setup child local frame, take into account change\n void MakeLocal(double* locpos, double* locquat, const double* pos, const double* quat);\n\n // set explicit_inertial to true\n void MakeInertialExplicit();\n\n // variables set by user or 'Compile'\n bool mocap; // is this a mocap body\n double pos[3]; // frame position\n double quat[4]; // frame orientation\n double ipos[3]; // inertial frame position\n double iquat[4]; // inertial frame orientation\n double mass; // mass\n double inertia[3]; // diagonal inertia (in i-frame)\n std::vector userdata; // user data\n mjCAlternative alt; // alternative orientation specification\n mjCAlternative ialt; // alternative for inertial frame\n\n // variables computed by 'Compile' and 'AddXXX'\n private:\n mjCBody(mjCModel*); // constructor\n ~mjCBody(); // destructor\n void Compile(void); // compiler\n\n void GeomFrame(void); // get inertial info from geoms\n\n double locpos[3]; // position relative to parent\n double locquat[4]; // orientation relative to parent\n double locipos[3]; // inertial position frame, rel. to local frame\n double lociquat[4]; // inertial frame orientation\n int parentid; // parent index in global array\n int weldid; // top index of body we are welded to\n int dofnum; // number of motion dofs for body\n int mocapid; // mocap id, -1: not mocap\n bool explicit_inertial; // whether to save the body with an explicit inertial clause\n\n int lastdof; // id of last dof (used by compiler)\n\n // objects allocated by Add functions\n std::vector bodies; // child bodies\n std::vector geoms; // geoms attached to this body\n std::vector joints; // joints allowing motion relative to parent\n std::vector sites; // sites attached to this body\n std::vector cameras; // cameras attached to this body\n std::vector lights; // lights attached to this body\n};\n\n#endif // MUJOCO_SRC_USER_USER_OBJECTS_H_\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_8/lodepng/include/lodepng.h", "content": "/*\nLodePNG version 20220109\n\nCopyright (c) 2005-2022 Lode Vandevenne\n\nThis software is provided 'as-is', without any express or implied\nwarranty. In no event will the authors be held liable for any damages\narising from the use of this software.\n\nPermission is granted to anyone to use this software for any purpose,\nincluding commercial applications, and to alter it and redistribute it\nfreely, subject to the following restrictions:\n\n 1. The origin of this software must not be misrepresented; you must not\n claim that you wrote the original software. If you use this software\n in a product, an acknowledgment in the product documentation would be\n appreciated but is not required.\n\n 2. Altered source versions must be plainly marked as such, and must not be\n misrepresented as being the original software.\n\n 3. This notice may not be removed or altered from any source\n distribution.\n*/\n\n#ifndef LODEPNG_H\n#define LODEPNG_H\n\n#include /*for size_t*/\n\nextern const char* LODEPNG_VERSION_STRING;\n\n/*\nThe following #defines are used to create code sections. They can be disabled\nto disable code sections, which can give faster compile time and smaller binary.\nThe \"NO_COMPILE\" defines are designed to be used to pass as defines to the\ncompiler command to disable them without modifying this header, e.g.\n-DLODEPNG_NO_COMPILE_ZLIB for gcc.\nIn addition to those below, you can also define LODEPNG_NO_COMPILE_CRC to\nallow implementing a custom lodepng_crc32.\n*/\n/*deflate & zlib. If disabled, you must specify alternative zlib functions in\nthe custom_zlib field of the compress and decompress settings*/\n#ifndef LODEPNG_NO_COMPILE_ZLIB\n#define LODEPNG_COMPILE_ZLIB\n#endif\n\n/*png encoder and png decoder*/\n#ifndef LODEPNG_NO_COMPILE_PNG\n#define LODEPNG_COMPILE_PNG\n#endif\n\n/*deflate&zlib decoder and png decoder*/\n#ifndef LODEPNG_NO_COMPILE_DECODER\n#define LODEPNG_COMPILE_DECODER\n#endif\n\n/*deflate&zlib encoder and png encoder*/\n#ifndef LODEPNG_NO_COMPILE_ENCODER\n#define LODEPNG_COMPILE_ENCODER\n#endif\n\n/*the optional built in harddisk file loading and saving functions*/\n#ifndef LODEPNG_NO_COMPILE_DISK\n#define LODEPNG_COMPILE_DISK\n#endif\n\n/*support for chunks other than IHDR, IDAT, PLTE, tRNS, IEND: ancillary and unknown chunks*/\n#ifndef LODEPNG_NO_COMPILE_ANCILLARY_CHUNKS\n#define LODEPNG_COMPILE_ANCILLARY_CHUNKS\n#endif\n\n/*ability to convert error numerical codes to English text string*/\n#ifndef LODEPNG_NO_COMPILE_ERROR_TEXT\n#define LODEPNG_COMPILE_ERROR_TEXT\n#endif\n\n/*Compile the default allocators (C's free, malloc and realloc). If you disable this,\nyou can define the functions lodepng_free, lodepng_malloc and lodepng_realloc in your\nsource files with custom allocators.*/\n#ifndef LODEPNG_NO_COMPILE_ALLOCATORS\n#define LODEPNG_COMPILE_ALLOCATORS\n#endif\n\n/*compile the C++ version (you can disable the C++ wrapper here even when compiling for C++)*/\n#ifdef __cplusplus\n#ifndef LODEPNG_NO_COMPILE_CPP\n#define LODEPNG_COMPILE_CPP\n#endif\n#endif\n\n#ifdef LODEPNG_COMPILE_CPP\n#include \n#include \n#endif /*LODEPNG_COMPILE_CPP*/\n\n#ifdef LODEPNG_COMPILE_PNG\n/*The PNG color types (also used for raw image).*/\ntypedef enum LodePNGColorType {\n LCT_GREY = 0, /*grayscale: 1,2,4,8,16 bit*/\n LCT_RGB = 2, /*RGB: 8,16 bit*/\n LCT_PALETTE = 3, /*palette: 1,2,4,8 bit*/\n LCT_GREY_ALPHA = 4, /*grayscale with alpha: 8,16 bit*/\n LCT_RGBA = 6, /*RGB with alpha: 8,16 bit*/\n /*LCT_MAX_OCTET_VALUE lets the compiler allow this enum to represent any invalid\n byte value from 0 to 255 that could be present in an invalid PNG file header. Do\n not use, compare with or set the name LCT_MAX_OCTET_VALUE, instead either use\n the valid color type names above, or numeric values like 1 or 7 when checking for\n particular disallowed color type byte values, or cast to integer to print it.*/\n LCT_MAX_OCTET_VALUE = 255\n} LodePNGColorType;\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nConverts PNG data in memory to raw pixel data.\nout: Output parameter. Pointer to buffer that will contain the raw pixel data.\n After decoding, its size is w * h * (bytes per pixel) bytes larger than\n initially. Bytes per pixel depends on colortype and bitdepth.\n Must be freed after usage with free(*out).\n Note: for 16-bit per channel colors, uses big endian format like PNG does.\nw: Output parameter. Pointer to width of pixel data.\nh: Output parameter. Pointer to height of pixel data.\nin: Memory buffer with the PNG file.\ninsize: size of the in buffer.\ncolortype: the desired color type for the raw output image. See explanation on PNG color types.\nbitdepth: the desired bit depth for the raw output image. See explanation on PNG color types.\nReturn value: LodePNG error code (0 means no error).\n*/\nunsigned lodepng_decode_memory(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_decode_memory, but always decodes to 32-bit RGBA raw image*/\nunsigned lodepng_decode32(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize);\n\n/*Same as lodepng_decode_memory, but always decodes to 24-bit RGB raw image*/\nunsigned lodepng_decode24(unsigned char** out, unsigned* w, unsigned* h,\n const unsigned char* in, size_t insize);\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad PNG from disk, from file with given name.\nSame as the other decode functions, but instead takes a filename as input.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_decode_file, but always decodes to 32-bit RGBA raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode32_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename);\n\n/*Same as lodepng_decode_file, but always decodes to 24-bit RGB raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.*/\nunsigned lodepng_decode24_file(unsigned char** out, unsigned* w, unsigned* h,\n const char* filename);\n#endif /*LODEPNG_COMPILE_DISK*/\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nConverts raw pixel data into a PNG image in memory. The colortype and bitdepth\n of the output PNG image cannot be chosen, they are automatically determined\n by the colortype, bitdepth and content of the input pixel data.\n Note: for 16-bit per channel colors, needs big endian format like PNG does.\nout: Output parameter. Pointer to buffer that will contain the PNG image data.\n Must be freed after usage with free(*out).\noutsize: Output parameter. Pointer to the size in bytes of the out buffer.\nimage: The raw pixel data to encode. The size of this buffer should be\n w * h * (bytes per pixel), bytes per pixel depends on colortype and bitdepth.\nw: width of the raw pixel data in pixels.\nh: height of the raw pixel data in pixels.\ncolortype: the color type of the raw input image. See explanation on PNG color types.\nbitdepth: the bit depth of the raw input image. See explanation on PNG color types.\nReturn value: LodePNG error code (0 means no error).\n*/\nunsigned lodepng_encode_memory(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_encode_memory, but always encodes from 32-bit RGBA raw image.*/\nunsigned lodepng_encode32(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h);\n\n/*Same as lodepng_encode_memory, but always encodes from 24-bit RGB raw image.*/\nunsigned lodepng_encode24(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h);\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts raw pixel data into a PNG file on disk.\nSame as the other encode functions, but instead takes a filename as output.\n\nNOTE: This overwrites existing files without warning!\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGColorType colortype, unsigned bitdepth);\n\n/*Same as lodepng_encode_file, but always encodes from 32-bit RGBA raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode32_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h);\n\n/*Same as lodepng_encode_file, but always encodes from 24-bit RGB raw image.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory.*/\nunsigned lodepng_encode24_file(const char* filename,\n const unsigned char* image, unsigned w, unsigned h);\n#endif /*LODEPNG_COMPILE_DISK*/\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n\n#ifdef LODEPNG_COMPILE_CPP\nnamespace lodepng {\n#ifdef LODEPNG_COMPILE_DECODER\n/*Same as lodepng_decode_memory, but decodes to an std::vector. The colortype\nis the format to output the pixels to. Default is RGBA 8-bit per channel.*/\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const unsigned char* in, size_t insize,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const std::vector& in,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts PNG file from disk to raw pixel data in memory.\nSame as the other decode functions, but instead takes a filename as input.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n const std::string& filename,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_DECODER */\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*Same as lodepng_encode_memory, but encodes to an std::vector. colortype\nis that of the raw input data. The output PNG color type will be auto chosen.*/\nunsigned encode(std::vector& out,\n const unsigned char* in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned encode(std::vector& out,\n const std::vector& in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#ifdef LODEPNG_COMPILE_DISK\n/*\nConverts 32-bit RGBA raw pixel data into a PNG file on disk.\nSame as the other encode functions, but instead takes a filename as output.\n\nNOTE: This overwrites existing files without warning!\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned encode(const std::string& filename,\n const unsigned char* in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\nunsigned encode(const std::string& filename,\n const std::vector& in, unsigned w, unsigned h,\n LodePNGColorType colortype = LCT_RGBA, unsigned bitdepth = 8);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_ENCODER */\n} /* namespace lodepng */\n#endif /*LODEPNG_COMPILE_CPP*/\n#endif /*LODEPNG_COMPILE_PNG*/\n\n#ifdef LODEPNG_COMPILE_ERROR_TEXT\n/*Returns an English description of the numerical error code.*/\nconst char* lodepng_error_text(unsigned code);\n#endif /*LODEPNG_COMPILE_ERROR_TEXT*/\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*Settings for zlib decompression*/\ntypedef struct LodePNGDecompressSettings LodePNGDecompressSettings;\nstruct LodePNGDecompressSettings {\n /* Check LodePNGDecoderSettings for more ignorable errors such as ignore_crc */\n unsigned ignore_adler32; /*if 1, continue and don't give an error message if the Adler32 checksum is corrupted*/\n unsigned ignore_nlen; /*ignore complement of len checksum in uncompressed blocks*/\n\n /*Maximum decompressed size, beyond this the decoder may (and is encouraged to) stop decoding,\n return an error, output a data size > max_output_size and all the data up to that point. This is\n not hard limit nor a guarantee, but can prevent excessive memory usage. This setting is\n ignored by the PNG decoder, but is used by the deflate/zlib decoder and can be used by custom ones.\n Set to 0 to impose no limit (the default).*/\n size_t max_output_size;\n\n /*use custom zlib decoder instead of built in one (default: null).\n Should return 0 if success, any non-0 if error (numeric value not exposed).*/\n unsigned (*custom_zlib)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGDecompressSettings*);\n /*use custom deflate decoder instead of built in one (default: null)\n if custom_zlib is not null, custom_inflate is ignored (the zlib format uses deflate).\n Should return 0 if success, any non-0 if error (numeric value not exposed).*/\n unsigned (*custom_inflate)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGDecompressSettings*);\n\n const void* custom_context; /*optional custom settings for custom functions*/\n};\n\nextern const LodePNGDecompressSettings lodepng_default_decompress_settings;\nvoid lodepng_decompress_settings_init(LodePNGDecompressSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nSettings for zlib compression. Tweaking these settings tweaks the balance\nbetween speed and compression ratio.\n*/\ntypedef struct LodePNGCompressSettings LodePNGCompressSettings;\nstruct LodePNGCompressSettings /*deflate = compress*/ {\n /*LZ77 related settings*/\n unsigned btype; /*the block type for LZ (0, 1, 2 or 3, see zlib standard). Should be 2 for proper compression.*/\n unsigned use_lz77; /*whether or not to use LZ77. Should be 1 for proper compression.*/\n unsigned windowsize; /*must be a power of two <= 32768. higher compresses more but is slower. Default value: 2048.*/\n unsigned minmatch; /*minimum lz77 length. 3 is normally best, 6 can be better for some PNGs. Default: 0*/\n unsigned nicematch; /*stop searching if >= this length found. Set to 258 for best compression. Default: 128*/\n unsigned lazymatching; /*use lazy matching: better compression but a bit slower. Default: true*/\n\n /*use custom zlib encoder instead of built in one (default: null)*/\n unsigned (*custom_zlib)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGCompressSettings*);\n /*use custom deflate encoder instead of built in one (default: null)\n if custom_zlib is used, custom_deflate is ignored since only the built in\n zlib function will call custom_deflate*/\n unsigned (*custom_deflate)(unsigned char**, size_t*,\n const unsigned char*, size_t,\n const LodePNGCompressSettings*);\n\n const void* custom_context; /*optional custom settings for custom functions*/\n};\n\nextern const LodePNGCompressSettings lodepng_default_compress_settings;\nvoid lodepng_compress_settings_init(LodePNGCompressSettings* settings);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n#ifdef LODEPNG_COMPILE_PNG\n/*\nColor mode of an image. Contains all information required to decode the pixel\nbits to RGBA colors. This information is the same as used in the PNG file\nformat, and is used both for PNG and raw image data in LodePNG.\n*/\ntypedef struct LodePNGColorMode {\n /*header (IHDR)*/\n LodePNGColorType colortype; /*color type, see PNG standard or documentation further in this header file*/\n unsigned bitdepth; /*bits per sample, see PNG standard or documentation further in this header file*/\n\n /*\n palette (PLTE and tRNS)\n\n Dynamically allocated with the colors of the palette, including alpha.\n This field may not be allocated directly, use lodepng_color_mode_init first,\n then lodepng_palette_add per color to correctly initialize it (to ensure size\n of exactly 1024 bytes).\n\n The alpha channels must be set as well, set them to 255 for opaque images.\n\n When decoding, by default you can ignore this palette, since LodePNG already\n fills the palette colors in the pixels of the raw RGBA output.\n\n The palette is only supported for color type 3.\n */\n unsigned char* palette; /*palette in RGBARGBA... order. Must be either 0, or when allocated must have 1024 bytes*/\n size_t palettesize; /*palette size in number of colors (amount of used bytes is 4 * palettesize)*/\n\n /*\n transparent color key (tRNS)\n\n This color uses the same bit depth as the bitdepth value in this struct, which can be 1-bit to 16-bit.\n For grayscale PNGs, r, g and b will all 3 be set to the same.\n\n When decoding, by default you can ignore this information, since LodePNG sets\n pixels with this key to transparent already in the raw RGBA output.\n\n The color key is only supported for color types 0 and 2.\n */\n unsigned key_defined; /*is a transparent color key given? 0 = false, 1 = true*/\n unsigned key_r; /*red/grayscale component of color key*/\n unsigned key_g; /*green component of color key*/\n unsigned key_b; /*blue component of color key*/\n} LodePNGColorMode;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_color_mode_init(LodePNGColorMode* info);\nvoid lodepng_color_mode_cleanup(LodePNGColorMode* info);\n/*return value is error code (0 means no error)*/\nunsigned lodepng_color_mode_copy(LodePNGColorMode* dest, const LodePNGColorMode* source);\n/* Makes a temporary LodePNGColorMode that does not need cleanup (no palette) */\nLodePNGColorMode lodepng_color_mode_make(LodePNGColorType colortype, unsigned bitdepth);\n\nvoid lodepng_palette_clear(LodePNGColorMode* info);\n/*add 1 color to the palette*/\nunsigned lodepng_palette_add(LodePNGColorMode* info,\n unsigned char r, unsigned char g, unsigned char b, unsigned char a);\n\n/*get the total amount of bits per pixel, based on colortype and bitdepth in the struct*/\nunsigned lodepng_get_bpp(const LodePNGColorMode* info);\n/*get the amount of color channels used, based on colortype in the struct.\nIf a palette is used, it counts as 1 channel.*/\nunsigned lodepng_get_channels(const LodePNGColorMode* info);\n/*is it a grayscale type? (only colortype 0 or 4)*/\nunsigned lodepng_is_greyscale_type(const LodePNGColorMode* info);\n/*has it got an alpha channel? (only colortype 2 or 6)*/\nunsigned lodepng_is_alpha_type(const LodePNGColorMode* info);\n/*has it got a palette? (only colortype 3)*/\nunsigned lodepng_is_palette_type(const LodePNGColorMode* info);\n/*only returns true if there is a palette and there is a value in the palette with alpha < 255.\nLoops through the palette to check this.*/\nunsigned lodepng_has_palette_alpha(const LodePNGColorMode* info);\n/*\nCheck if the given color info indicates the possibility of having non-opaque pixels in the PNG image.\nReturns true if the image can have translucent or invisible pixels (it still be opaque if it doesn't use such pixels).\nReturns false if the image can only have opaque pixels.\nIn detail, it returns true only if it's a color type with alpha, or has a palette with non-opaque values,\nor if \"key_defined\" is true.\n*/\nunsigned lodepng_can_have_alpha(const LodePNGColorMode* info);\n/*Returns the byte size of a raw image buffer with given width, height and color mode*/\nsize_t lodepng_get_raw_size(unsigned w, unsigned h, const LodePNGColorMode* color);\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n/*The information of a Time chunk in PNG.*/\ntypedef struct LodePNGTime {\n unsigned year; /*2 bytes used (0-65535)*/\n unsigned month; /*1-12*/\n unsigned day; /*1-31*/\n unsigned hour; /*0-23*/\n unsigned minute; /*0-59*/\n unsigned second; /*0-60 (to allow for leap seconds)*/\n} LodePNGTime;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n\n/*Information about the PNG image, except pixels, width and height.*/\ntypedef struct LodePNGInfo {\n /*header (IHDR), palette (PLTE) and transparency (tRNS) chunks*/\n unsigned compression_method;/*compression method of the original file. Always 0.*/\n unsigned filter_method; /*filter method of the original file*/\n unsigned interlace_method; /*interlace method of the original file: 0=none, 1=Adam7*/\n LodePNGColorMode color; /*color type and bits, palette and transparency of the PNG file*/\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n /*\n Suggested background color chunk (bKGD)\n\n This uses the same color mode and bit depth as the PNG (except no alpha channel),\n with values truncated to the bit depth in the unsigned integer.\n\n For grayscale and palette PNGs, the value is stored in background_r. The values\n in background_g and background_b are then unused.\n\n So when decoding, you may get these in a different color mode than the one you requested\n for the raw pixels.\n\n When encoding with auto_convert, you must use the color model defined in info_png.color for\n these values. The encoder normally ignores info_png.color when auto_convert is on, but will\n use it to interpret these values (and convert copies of them to its chosen color model).\n\n When encoding, avoid setting this to an expensive color, such as a non-gray value\n when the image is gray, or the compression will be worse since it will be forced to\n write the PNG with a more expensive color mode (when auto_convert is on).\n\n The decoder does not use this background color to edit the color of pixels. This is a\n completely optional metadata feature.\n */\n unsigned background_defined; /*is a suggested background color given?*/\n unsigned background_r; /*red/gray/palette component of suggested background color*/\n unsigned background_g; /*green component of suggested background color*/\n unsigned background_b; /*blue component of suggested background color*/\n\n /*\n Non-international text chunks (tEXt and zTXt)\n\n The char** arrays each contain num strings. The actual messages are in\n text_strings, while text_keys are keywords that give a short description what\n the actual text represents, e.g. Title, Author, Description, or anything else.\n\n All the string fields below including strings, keys, names and language tags are null terminated.\n The PNG specification uses null characters for the keys, names and tags, and forbids null\n characters to appear in the main text which is why we can use null termination everywhere here.\n\n A keyword is minimum 1 character and maximum 79 characters long (plus the\n additional null terminator). It's discouraged to use a single line length\n longer than 79 characters for texts.\n\n Don't allocate these text buffers yourself. Use the init/cleanup functions\n correctly and use lodepng_add_text and lodepng_clear_text.\n\n Standard text chunk keywords and strings are encoded using Latin-1.\n */\n size_t text_num; /*the amount of texts in these char** buffers (there may be more texts in itext)*/\n char** text_keys; /*the keyword of a text chunk (e.g. \"Comment\")*/\n char** text_strings; /*the actual text*/\n\n /*\n International text chunks (iTXt)\n Similar to the non-international text chunks, but with additional strings\n \"langtags\" and \"transkeys\", and the following text encodings are used:\n keys: Latin-1, langtags: ASCII, transkeys and strings: UTF-8.\n keys must be 1-79 characters (plus the additional null terminator), the other\n strings are any length.\n */\n size_t itext_num; /*the amount of international texts in this PNG*/\n char** itext_keys; /*the English keyword of the text chunk (e.g. \"Comment\")*/\n char** itext_langtags; /*language tag for this text's language, ISO/IEC 646 string, e.g. ISO 639 language tag*/\n char** itext_transkeys; /*keyword translated to the international language - UTF-8 string*/\n char** itext_strings; /*the actual international text - UTF-8 string*/\n\n /*time chunk (tIME)*/\n unsigned time_defined; /*set to 1 to make the encoder generate a tIME chunk*/\n LodePNGTime time;\n\n /*phys chunk (pHYs)*/\n unsigned phys_defined; /*if 0, there is no pHYs chunk and the values below are undefined, if 1 else there is one*/\n unsigned phys_x; /*pixels per unit in x direction*/\n unsigned phys_y; /*pixels per unit in y direction*/\n unsigned phys_unit; /*may be 0 (unknown unit) or 1 (metre)*/\n\n /*\n Color profile related chunks: gAMA, cHRM, sRGB, iCPP\n\n LodePNG does not apply any color conversions on pixels in the encoder or decoder and does not interpret these color\n profile values. It merely passes on the information. If you wish to use color profiles and convert colors, please\n use these values with a color management library.\n\n See the PNG, ICC and sRGB specifications for more information about the meaning of these values.\n */\n\n /* gAMA chunk: optional, overridden by sRGB or iCCP if those are present. */\n unsigned gama_defined; /* Whether a gAMA chunk is present (0 = not present, 1 = present). */\n unsigned gama_gamma; /* Gamma exponent times 100000 */\n\n /* cHRM chunk: optional, overridden by sRGB or iCCP if those are present. */\n unsigned chrm_defined; /* Whether a cHRM chunk is present (0 = not present, 1 = present). */\n unsigned chrm_white_x; /* White Point x times 100000 */\n unsigned chrm_white_y; /* White Point y times 100000 */\n unsigned chrm_red_x; /* Red x times 100000 */\n unsigned chrm_red_y; /* Red y times 100000 */\n unsigned chrm_green_x; /* Green x times 100000 */\n unsigned chrm_green_y; /* Green y times 100000 */\n unsigned chrm_blue_x; /* Blue x times 100000 */\n unsigned chrm_blue_y; /* Blue y times 100000 */\n\n /*\n sRGB chunk: optional. May not appear at the same time as iCCP.\n If gAMA is also present gAMA must contain value 45455.\n If cHRM is also present cHRM must contain respectively 31270,32900,64000,33000,30000,60000,15000,6000.\n */\n unsigned srgb_defined; /* Whether an sRGB chunk is present (0 = not present, 1 = present). */\n unsigned srgb_intent; /* Rendering intent: 0=perceptual, 1=rel. colorimetric, 2=saturation, 3=abs. colorimetric */\n\n /*\n iCCP chunk: optional. May not appear at the same time as sRGB.\n\n LodePNG does not parse or use the ICC profile (except its color space header field for an edge case), a\n separate library to handle the ICC data (not included in LodePNG) format is needed to use it for color\n management and conversions.\n\n For encoding, if iCCP is present, gAMA and cHRM are recommended to be added as well with values that match the ICC\n profile as closely as possible, if you wish to do this you should provide the correct values for gAMA and cHRM and\n enable their '_defined' flags since LodePNG will not automatically compute them from the ICC profile.\n\n For encoding, the ICC profile is required by the PNG specification to be an \"RGB\" profile for non-gray\n PNG color types and a \"GRAY\" profile for gray PNG color types. If you disable auto_convert, you must ensure\n the ICC profile type matches your requested color type, else the encoder gives an error. If auto_convert is\n enabled (the default), and the ICC profile is not a good match for the pixel data, this will result in an encoder\n error if the pixel data has non-gray pixels for a GRAY profile, or a silent less-optimal compression of the pixel\n data if the pixels could be encoded as grayscale but the ICC profile is RGB.\n\n To avoid this do not set an ICC profile in the image unless there is a good reason for it, and when doing so\n make sure you compute it carefully to avoid the above problems.\n */\n unsigned iccp_defined; /* Whether an iCCP chunk is present (0 = not present, 1 = present). */\n char* iccp_name; /* Null terminated string with profile name, 1-79 bytes */\n /*\n The ICC profile in iccp_profile_size bytes.\n Don't allocate this buffer yourself. Use the init/cleanup functions\n correctly and use lodepng_set_icc and lodepng_clear_icc.\n */\n unsigned char* iccp_profile;\n unsigned iccp_profile_size; /* The size of iccp_profile in bytes */\n\n /* End of color profile related chunks */\n\n\n /*\n unknown chunks: chunks not known by LodePNG, passed on byte for byte.\n\n There are 3 buffers, one for each position in the PNG where unknown chunks can appear.\n Each buffer contains all unknown chunks for that position consecutively.\n The 3 positions are:\n 0: between IHDR and PLTE, 1: between PLTE and IDAT, 2: between IDAT and IEND.\n\n For encoding, do not store critical chunks or known chunks that are enabled with a \"_defined\" flag\n above in here, since the encoder will blindly follow this and could then encode an invalid PNG file\n (such as one with two IHDR chunks or the disallowed combination of sRGB with iCCP). But do use\n this if you wish to store an ancillary chunk that is not supported by LodePNG (such as sPLT or hIST),\n or any non-standard PNG chunk.\n\n Do not allocate or traverse this data yourself. Use the chunk traversing functions declared\n later, such as lodepng_chunk_next and lodepng_chunk_append, to read/write this struct.\n */\n unsigned char* unknown_chunks_data[3];\n size_t unknown_chunks_size[3]; /*size in bytes of the unknown chunks, given for protection*/\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGInfo;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_info_init(LodePNGInfo* info);\nvoid lodepng_info_cleanup(LodePNGInfo* info);\n/*return value is error code (0 means no error)*/\nunsigned lodepng_info_copy(LodePNGInfo* dest, const LodePNGInfo* source);\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\nunsigned lodepng_add_text(LodePNGInfo* info, const char* key, const char* str); /*push back both texts at once*/\nvoid lodepng_clear_text(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/\n\nunsigned lodepng_add_itext(LodePNGInfo* info, const char* key, const char* langtag,\n const char* transkey, const char* str); /*push back the 4 texts of 1 chunk at once*/\nvoid lodepng_clear_itext(LodePNGInfo* info); /*use this to clear the itexts again after you filled them in*/\n\n/*replaces if exists*/\nunsigned lodepng_set_icc(LodePNGInfo* info, const char* name, const unsigned char* profile, unsigned profile_size);\nvoid lodepng_clear_icc(LodePNGInfo* info); /*use this to clear the texts again after you filled them in*/\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n\n/*\nConverts raw buffer from one color type to another color type, based on\nLodePNGColorMode structs to describe the input and output color type.\nSee the reference manual at the end of this header file to see which color conversions are supported.\nreturn value = LodePNG error code (0 if all went ok, an error if the conversion isn't supported)\nThe out buffer must have size (w * h * bpp + 7) / 8, where bpp is the bits per pixel\nof the output color type (lodepng_get_bpp).\nFor < 8 bpp images, there should not be padding bits at the end of scanlines.\nFor 16-bit per channel colors, uses big endian format like PNG does.\nReturn value is LodePNG error code\n*/\nunsigned lodepng_convert(unsigned char* out, const unsigned char* in,\n const LodePNGColorMode* mode_out, const LodePNGColorMode* mode_in,\n unsigned w, unsigned h);\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nSettings for the decoder. This contains settings for the PNG and the Zlib\ndecoder, but not the Info settings from the Info structs.\n*/\ntypedef struct LodePNGDecoderSettings {\n LodePNGDecompressSettings zlibsettings; /*in here is the setting to ignore Adler32 checksums*/\n\n /* Check LodePNGDecompressSettings for more ignorable errors such as ignore_adler32 */\n unsigned ignore_crc; /*ignore CRC checksums*/\n unsigned ignore_critical; /*ignore unknown critical chunks*/\n unsigned ignore_end; /*ignore issues at end of file if possible (missing IEND chunk, too large chunk, ...)*/\n /* TODO: make a system involving warnings with levels and a strict mode instead. Other potentially recoverable\n errors: srgb rendering intent value, size of content of ancillary chunks, more than 79 characters for some\n strings, placement/combination rules for ancillary chunks, crc of unknown chunks, allowed characters\n in string keys, etc... */\n\n unsigned color_convert; /*whether to convert the PNG to the color type you want. Default: yes*/\n\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n unsigned read_text_chunks; /*if false but remember_unknown_chunks is true, they're stored in the unknown chunks*/\n\n /*store all bytes from unknown chunks in the LodePNGInfo (off by default, useful for a png editor)*/\n unsigned remember_unknown_chunks;\n\n /* maximum size for decompressed text chunks. If a text chunk's text is larger than this, an error is returned,\n unless reading text chunks is disabled or this limit is set higher or disabled. Set to 0 to allow any size.\n By default it is a value that prevents unreasonably large strings from hogging memory. */\n size_t max_text_size;\n\n /* maximum size for compressed ICC chunks. If the ICC profile is larger than this, an error will be returned. Set to\n 0 to allow any size. By default this is a value that prevents ICC profiles that would be much larger than any\n legitimate profile could be to hog memory. */\n size_t max_icc_size;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGDecoderSettings;\n\nvoid lodepng_decoder_settings_init(LodePNGDecoderSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*automatically use color type with less bits per pixel if losslessly possible. Default: AUTO*/\ntypedef enum LodePNGFilterStrategy {\n /*every filter at zero*/\n LFS_ZERO = 0,\n /*every filter at 1, 2, 3 or 4 (paeth), unlike LFS_ZERO not a good choice, but for testing*/\n LFS_ONE = 1,\n LFS_TWO = 2,\n LFS_THREE = 3,\n LFS_FOUR = 4,\n /*Use filter that gives minimum sum, as described in the official PNG filter heuristic.*/\n LFS_MINSUM,\n /*Use the filter type that gives smallest Shannon entropy for this scanline. Depending\n on the image, this is better or worse than minsum.*/\n LFS_ENTROPY,\n /*\n Brute-force-search PNG filters by compressing each filter for each scanline.\n Experimental, very slow, and only rarely gives better compression than MINSUM.\n */\n LFS_BRUTE_FORCE,\n /*use predefined_filters buffer: you specify the filter type for each scanline*/\n LFS_PREDEFINED\n} LodePNGFilterStrategy;\n\n/*Gives characteristics about the integer RGBA colors of the image (count, alpha channel usage, bit depth, ...),\nwhich helps decide which color model to use for encoding.\nUsed internally by default if \"auto_convert\" is enabled. Public because it's useful for custom algorithms.*/\ntypedef struct LodePNGColorStats {\n unsigned colored; /*not grayscale*/\n unsigned key; /*image is not opaque and color key is possible instead of full alpha*/\n unsigned short key_r; /*key values, always as 16-bit, in 8-bit case the byte is duplicated, e.g. 65535 means 255*/\n unsigned short key_g;\n unsigned short key_b;\n unsigned alpha; /*image is not opaque and alpha channel or alpha palette required*/\n unsigned numcolors; /*amount of colors, up to 257. Not valid if bits == 16 or allow_palette is disabled.*/\n unsigned char palette[1024]; /*Remembers up to the first 256 RGBA colors, in no particular order, only valid when numcolors is valid*/\n unsigned bits; /*bits per channel (not for palette). 1,2 or 4 for grayscale only. 16 if 16-bit per channel required.*/\n size_t numpixels;\n\n /*user settings for computing/using the stats*/\n unsigned allow_palette; /*default 1. if 0, disallow choosing palette colortype in auto_choose_color, and don't count numcolors*/\n unsigned allow_greyscale; /*default 1. if 0, choose RGB or RGBA even if the image only has gray colors*/\n} LodePNGColorStats;\n\nvoid lodepng_color_stats_init(LodePNGColorStats* stats);\n\n/*Get a LodePNGColorStats of the image. The stats must already have been inited.\nReturns error code (e.g. alloc fail) or 0 if ok.*/\nunsigned lodepng_compute_color_stats(LodePNGColorStats* stats,\n const unsigned char* image, unsigned w, unsigned h,\n const LodePNGColorMode* mode_in);\n\n/*Settings for the encoder.*/\ntypedef struct LodePNGEncoderSettings {\n LodePNGCompressSettings zlibsettings; /*settings for the zlib encoder, such as window size, ...*/\n\n unsigned auto_convert; /*automatically choose output PNG color type. Default: true*/\n\n /*If true, follows the official PNG heuristic: if the PNG uses a palette or lower than\n 8 bit depth, set all filters to zero. Otherwise use the filter_strategy. Note that to\n completely follow the official PNG heuristic, filter_palette_zero must be true and\n filter_strategy must be LFS_MINSUM*/\n unsigned filter_palette_zero;\n /*Which filter strategy to use when not using zeroes due to filter_palette_zero.\n Set filter_palette_zero to 0 to ensure always using your chosen strategy. Default: LFS_MINSUM*/\n LodePNGFilterStrategy filter_strategy;\n /*used if filter_strategy is LFS_PREDEFINED. In that case, this must point to a buffer with\n the same length as the amount of scanlines in the image, and each value must <= 5. You\n have to cleanup this buffer, LodePNG will never free it. Don't forget that filter_palette_zero\n must be set to 0 to ensure this is also used on palette or low bitdepth images.*/\n const unsigned char* predefined_filters;\n\n /*force creating a PLTE chunk if colortype is 2 or 6 (= a suggested palette).\n If colortype is 3, PLTE is _always_ created.*/\n unsigned force_palette;\n#ifdef LODEPNG_COMPILE_ANCILLARY_CHUNKS\n /*add LodePNG identifier and version as a text chunk, for debugging*/\n unsigned add_id;\n /*encode text chunks as zTXt chunks instead of tEXt chunks, and use compression in iTXt chunks*/\n unsigned text_compression;\n#endif /*LODEPNG_COMPILE_ANCILLARY_CHUNKS*/\n} LodePNGEncoderSettings;\n\nvoid lodepng_encoder_settings_init(LodePNGEncoderSettings* settings);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n\n#if defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER)\n/*The settings, state and information for extended encoding and decoding.*/\ntypedef struct LodePNGState {\n#ifdef LODEPNG_COMPILE_DECODER\n LodePNGDecoderSettings decoder; /*the decoding settings*/\n#endif /*LODEPNG_COMPILE_DECODER*/\n#ifdef LODEPNG_COMPILE_ENCODER\n LodePNGEncoderSettings encoder; /*the encoding settings*/\n#endif /*LODEPNG_COMPILE_ENCODER*/\n LodePNGColorMode info_raw; /*specifies the format in which you would like to get the raw pixel buffer*/\n LodePNGInfo info_png; /*info of the PNG image obtained after decoding*/\n unsigned error;\n} LodePNGState;\n\n/*init, cleanup and copy functions to use with this struct*/\nvoid lodepng_state_init(LodePNGState* state);\nvoid lodepng_state_cleanup(LodePNGState* state);\nvoid lodepng_state_copy(LodePNGState* dest, const LodePNGState* source);\n#endif /* defined(LODEPNG_COMPILE_DECODER) || defined(LODEPNG_COMPILE_ENCODER) */\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*\nSame as lodepng_decode_memory, but uses a LodePNGState to allow custom settings and\ngetting much more information about the PNG image and color mode.\n*/\nunsigned lodepng_decode(unsigned char** out, unsigned* w, unsigned* h,\n LodePNGState* state,\n const unsigned char* in, size_t insize);\n\n/*\nRead the PNG header, but not the actual data. This returns only the information\nthat is in the IHDR chunk of the PNG, such as width, height and color type. The\ninformation is placed in the info_png field of the LodePNGState.\n*/\nunsigned lodepng_inspect(unsigned* w, unsigned* h,\n LodePNGState* state,\n const unsigned char* in, size_t insize);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n/*\nReads one metadata chunk (other than IHDR) of the PNG file and outputs what it\nread in the state. Returns error code on failure.\nUse lodepng_inspect first with a new state, then e.g. lodepng_chunk_find_const\nto find the desired chunk type, and if non null use lodepng_inspect_chunk (with\nchunk_pointer - start_of_file as pos).\nSupports most metadata chunks from the PNG standard (gAMA, bKGD, tEXt, ...).\nIgnores unsupported, unknown, non-metadata or IHDR chunks (without error).\nRequirements: &in[pos] must point to start of a chunk, must use regular\nlodepng_inspect first since format of most other chunks depends on IHDR, and if\nthere is a PLTE chunk, that one must be inspected before tRNS or bKGD.\n*/\nunsigned lodepng_inspect_chunk(LodePNGState* state, size_t pos,\n const unsigned char* in, size_t insize);\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*This function allocates the out buffer with standard malloc and stores the size in *outsize.*/\nunsigned lodepng_encode(unsigned char** out, size_t* outsize,\n const unsigned char* image, unsigned w, unsigned h,\n LodePNGState* state);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n/*\nThe lodepng_chunk functions are normally not needed, except to traverse the\nunknown chunks stored in the LodePNGInfo struct, or add new ones to it.\nIt also allows traversing the chunks of an encoded PNG file yourself.\n\nThe chunk pointer always points to the beginning of the chunk itself, that is\nthe first byte of the 4 length bytes.\n\nIn the PNG file format, chunks have the following format:\n-4 bytes length: length of the data of the chunk in bytes (chunk itself is 12 bytes longer)\n-4 bytes chunk type (ASCII a-z,A-Z only, see below)\n-length bytes of data (may be 0 bytes if length was 0)\n-4 bytes of CRC, computed on chunk name + data\n\nThe first chunk starts at the 8th byte of the PNG file, the entire rest of the file\nexists out of concatenated chunks with the above format.\n\nPNG standard chunk ASCII naming conventions:\n-First byte: uppercase = critical, lowercase = ancillary\n-Second byte: uppercase = public, lowercase = private\n-Third byte: must be uppercase\n-Fourth byte: uppercase = unsafe to copy, lowercase = safe to copy\n*/\n\n/*\nGets the length of the data of the chunk. Total chunk length has 12 bytes more.\nThere must be at least 4 bytes to read from. If the result value is too large,\nit may be corrupt data.\n*/\nunsigned lodepng_chunk_length(const unsigned char* chunk);\n\n/*puts the 4-byte type in null terminated string*/\nvoid lodepng_chunk_type(char type[5], const unsigned char* chunk);\n\n/*check if the type is the given type*/\nunsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type);\n\n/*0: it's one of the critical chunk types, 1: it's an ancillary chunk (see PNG standard)*/\nunsigned char lodepng_chunk_ancillary(const unsigned char* chunk);\n\n/*0: public, 1: private (see PNG standard)*/\nunsigned char lodepng_chunk_private(const unsigned char* chunk);\n\n/*0: the chunk is unsafe to copy, 1: the chunk is safe to copy (see PNG standard)*/\nunsigned char lodepng_chunk_safetocopy(const unsigned char* chunk);\n\n/*get pointer to the data of the chunk, where the input points to the header of the chunk*/\nunsigned char* lodepng_chunk_data(unsigned char* chunk);\nconst unsigned char* lodepng_chunk_data_const(const unsigned char* chunk);\n\n/*returns 0 if the crc is correct, 1 if it's incorrect (0 for OK as usual!)*/\nunsigned lodepng_chunk_check_crc(const unsigned char* chunk);\n\n/*generates the correct CRC from the data and puts it in the last 4 bytes of the chunk*/\nvoid lodepng_chunk_generate_crc(unsigned char* chunk);\n\n/*\nIterate to next chunks, allows iterating through all chunks of the PNG file.\nInput must be at the beginning of a chunk (result of a previous lodepng_chunk_next call,\nor the 8th byte of a PNG file which always has the first chunk), or alternatively may\npoint to the first byte of the PNG file (which is not a chunk but the magic header, the\nfunction will then skip over it and return the first real chunk).\nWill output pointer to the start of the next chunk, or at or beyond end of the file if there\nis no more chunk after this or possibly if the chunk is corrupt.\nStart this process at the 8th byte of the PNG file.\nIn a non-corrupt PNG file, the last chunk should have name \"IEND\".\n*/\nunsigned char* lodepng_chunk_next(unsigned char* chunk, unsigned char* end);\nconst unsigned char* lodepng_chunk_next_const(const unsigned char* chunk, const unsigned char* end);\n\n/*Finds the first chunk with the given type in the range [chunk, end), or returns NULL if not found.*/\nunsigned char* lodepng_chunk_find(unsigned char* chunk, unsigned char* end, const char type[5]);\nconst unsigned char* lodepng_chunk_find_const(const unsigned char* chunk, const unsigned char* end, const char type[5]);\n\n/*\nAppends chunk to the data in out. The given chunk should already have its chunk header.\nThe out variable and outsize are updated to reflect the new reallocated buffer.\nReturns error code (0 if it went ok)\n*/\nunsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk);\n\n/*\nAppends new chunk to out. The chunk to append is given by giving its length, type\nand data separately. The type is a 4-letter string.\nThe out variable and outsize are updated to reflect the new reallocated buffer.\nReturns error code (0 if it went ok)\n*/\nunsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, unsigned length,\n const char* type, const unsigned char* data);\n\n\n/*Calculate CRC32 of buffer*/\nunsigned lodepng_crc32(const unsigned char* buf, size_t len);\n#endif /*LODEPNG_COMPILE_PNG*/\n\n\n#ifdef LODEPNG_COMPILE_ZLIB\n/*\nThis zlib part can be used independently to zlib compress and decompress a\nbuffer. It cannot be used to create gzip files however, and it only supports the\npart of zlib that is required for PNG, it does not support dictionaries.\n*/\n\n#ifdef LODEPNG_COMPILE_DECODER\n/*Inflate a buffer. Inflate is the decompression step of deflate. Out buffer must be freed after use.*/\nunsigned lodepng_inflate(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings* settings);\n\n/*\nDecompresses Zlib data. Reallocates the out buffer and appends the data. The\ndata must be according to the zlib specification.\nEither, *out must be NULL and *outsize must be 0, or, *out must be a valid\nbuffer and *outsize its size in bytes. out must be freed by user after usage.\n*/\nunsigned lodepng_zlib_decompress(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings* settings);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/*\nCompresses data with Zlib. Reallocates the out buffer and appends the data.\nZlib adds a small header and trailer around the deflate data.\nThe data is output in the format of the zlib specification.\nEither, *out must be NULL and *outsize must be 0, or, *out must be a valid\nbuffer and *outsize its size in bytes. out must be freed by user after usage.\n*/\nunsigned lodepng_zlib_compress(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGCompressSettings* settings);\n\n/*\nFind length-limited Huffman code for given frequencies. This function is in the\npublic interface only for tests, it's used internally by lodepng_deflate.\n*/\nunsigned lodepng_huffman_code_lengths(unsigned* lengths, const unsigned* frequencies,\n size_t numcodes, unsigned maxbitlen);\n\n/*Compress a buffer with deflate. See RFC 1951. Out buffer must be freed after use.*/\nunsigned lodepng_deflate(unsigned char** out, size_t* outsize,\n const unsigned char* in, size_t insize,\n const LodePNGCompressSettings* settings);\n\n#endif /*LODEPNG_COMPILE_ENCODER*/\n#endif /*LODEPNG_COMPILE_ZLIB*/\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad a file from disk into buffer. The function allocates the out buffer, and\nafter usage you should free it.\nout: output parameter, contains pointer to loaded buffer.\noutsize: output parameter, size of the allocated out buffer\nfilename: the path to the file to load\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory.\n*/\nunsigned lodepng_load_file(unsigned char** out, size_t* outsize, const char* filename);\n\n/*\nSave a file from buffer to disk. Warning, if it exists, this function overwrites\nthe file without warning!\nbuffer: the buffer to write\nbuffersize: size of the buffer to write\nfilename: the path to the file to save to\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory\n*/\nunsigned lodepng_save_file(const unsigned char* buffer, size_t buffersize, const char* filename);\n#endif /*LODEPNG_COMPILE_DISK*/\n\n#ifdef LODEPNG_COMPILE_CPP\n/* The LodePNG C++ wrapper uses std::vectors instead of manually allocated memory buffers. */\nnamespace lodepng {\n#ifdef LODEPNG_COMPILE_PNG\nclass State : public LodePNGState {\n public:\n State();\n State(const State& other);\n ~State();\n State& operator=(const State& other);\n};\n\n#ifdef LODEPNG_COMPILE_DECODER\n/* Same as other lodepng::decode, but using a State for more settings and information. */\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n State& state,\n const unsigned char* in, size_t insize);\nunsigned decode(std::vector& out, unsigned& w, unsigned& h,\n State& state,\n const std::vector& in);\n#endif /*LODEPNG_COMPILE_DECODER*/\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/* Same as other lodepng::encode, but using a State for more settings and information. */\nunsigned encode(std::vector& out,\n const unsigned char* in, unsigned w, unsigned h,\n State& state);\nunsigned encode(std::vector& out,\n const std::vector& in, unsigned w, unsigned h,\n State& state);\n#endif /*LODEPNG_COMPILE_ENCODER*/\n\n#ifdef LODEPNG_COMPILE_DISK\n/*\nLoad a file from disk into an std::vector.\nreturn value: error code (0 means ok)\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and decode in-memory\n*/\nunsigned load_file(std::vector& buffer, const std::string& filename);\n\n/*\nSave the binary data in an std::vector to a file on disk. The file is overwritten\nwithout warning.\n\nNOTE: Wide-character filenames are not supported, you can use an external method\nto handle such files and encode in-memory\n*/\nunsigned save_file(const std::vector& buffer, const std::string& filename);\n#endif /* LODEPNG_COMPILE_DISK */\n#endif /* LODEPNG_COMPILE_PNG */\n\n#ifdef LODEPNG_COMPILE_ZLIB\n#ifdef LODEPNG_COMPILE_DECODER\n/* Zlib-decompress an unsigned char buffer */\nunsigned decompress(std::vector& out, const unsigned char* in, size_t insize,\n const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);\n\n/* Zlib-decompress an std::vector */\nunsigned decompress(std::vector& out, const std::vector& in,\n const LodePNGDecompressSettings& settings = lodepng_default_decompress_settings);\n#endif /* LODEPNG_COMPILE_DECODER */\n\n#ifdef LODEPNG_COMPILE_ENCODER\n/* Zlib-compress an unsigned char buffer */\nunsigned compress(std::vector& out, const unsigned char* in, size_t insize,\n const LodePNGCompressSettings& settings = lodepng_default_compress_settings);\n\n/* Zlib-compress an std::vector */\nunsigned compress(std::vector& out, const std::vector& in,\n const LodePNGCompressSettings& settings = lodepng_default_compress_settings);\n#endif /* LODEPNG_COMPILE_ENCODER */\n#endif /* LODEPNG_COMPILE_ZLIB */\n} /* namespace lodepng */\n#endif /*LODEPNG_COMPILE_CPP*/\n\n/*\nTODO:\n[.] test if there are no memory leaks or security exploits - done a lot but needs to be checked often\n[.] check compatibility with various compilers - done but needs to be redone for every newer version\n[X] converting color to 16-bit per channel types\n[X] support color profile chunk types (but never let them touch RGB values by default)\n[ ] support all public PNG chunk types (almost done except sBIT, sPLT and hIST)\n[ ] make sure encoder generates no chunks with size > (2^31)-1\n[ ] partial decoding (stream processing)\n[X] let the \"isFullyOpaque\" function check color keys and transparent palettes too\n[X] better name for the variables \"codes\", \"codesD\", \"codelengthcodes\", \"clcl\" and \"lldl\"\n[ ] allow treating some errors like warnings, when image is recoverable (e.g. 69, 57, 58)\n[ ] make warnings like: oob palette, checksum fail, data after iend, wrong/unknown crit chunk, no null terminator in text, ...\n[ ] error messages with line numbers (and version)\n[ ] errors in state instead of as return code?\n[ ] new errors/warnings like suspiciously big decompressed ztxt or iccp chunk\n[ ] let the C++ wrapper catch exceptions coming from the standard library and return LodePNG error codes\n[ ] allow user to provide custom color conversion functions, e.g. for premultiplied alpha, padding bits or not, ...\n[ ] allow user to give data (void*) to custom allocator\n[X] provide alternatives for C library functions not present on some platforms (memcpy, ...)\n*/\n\n#endif /*LODEPNG_H inclusion guard*/\n\n/*\nLodePNG Documentation\n---------------------\n\n0. table of contents\n--------------------\n\n 1. about\n 1.1. supported features\n 1.2. features not supported\n 2. C and C++ version\n 3. security\n 4. decoding\n 5. encoding\n 6. color conversions\n 6.1. PNG color types\n 6.2. color conversions\n 6.3. padding bits\n 6.4. A note about 16-bits per channel and endianness\n 7. error values\n 8. chunks and PNG editing\n 9. compiler support\n 10. examples\n 10.1. decoder C++ example\n 10.2. decoder C example\n 11. state settings reference\n 12. changes\n 13. contact information\n\n\n1. about\n--------\n\nPNG is a file format to store raster images losslessly with good compression,\nsupporting different color types and alpha channel.\n\nLodePNG is a PNG codec according to the Portable Network Graphics (PNG)\nSpecification (Second Edition) - W3C Recommendation 10 November 2003.\n\nThe specifications used are:\n\n*) Portable Network Graphics (PNG) Specification (Second Edition):\n http://www.w3.org/TR/2003/REC-PNG-20031110\n*) RFC 1950 ZLIB Compressed Data Format version 3.3:\n http://www.gzip.org/zlib/rfc-zlib.html\n*) RFC 1951 DEFLATE Compressed Data Format Specification ver 1.3:\n http://www.gzip.org/zlib/rfc-deflate.html\n\nThe most recent version of LodePNG can currently be found at\nhttp://lodev.org/lodepng/\n\nLodePNG works both in C (ISO C90) and C++, with a C++ wrapper that adds\nextra functionality.\n\nLodePNG exists out of two files:\n-lodepng.h: the header file for both C and C++\n-lodepng.c(pp): give it the name lodepng.c or lodepng.cpp (or .cc) depending on your usage\n\nIf you want to start using LodePNG right away without reading this doc, get the\nexamples from the LodePNG website to see how to use it in code, or check the\nsmaller examples in chapter 13 here.\n\nLodePNG is simple but only supports the basic requirements. To achieve\nsimplicity, the following design choices were made: There are no dependencies\non any external library. There are functions to decode and encode a PNG with\na single function call, and extended versions of these functions taking a\nLodePNGState struct allowing to specify or get more information. By default\nthe colors of the raw image are always RGB or RGBA, no matter what color type\nthe PNG file uses. To read and write files, there are simple functions to\nconvert the files to/from buffers in memory.\n\nThis all makes LodePNG suitable for loading textures in games, demos and small\nprograms, ... It's less suitable for full fledged image editors, loading PNGs\nover network (it requires all the image data to be available before decoding can\nbegin), life-critical systems, ...\n\n1.1. supported features\n-----------------------\n\nThe following features are supported by the decoder:\n\n*) decoding of PNGs with any color type, bit depth and interlace mode, to a 24- or 32-bit color raw image,\n or the same color type as the PNG\n*) encoding of PNGs, from any raw image to 24- or 32-bit color, or the same color type as the raw image\n*) Adam7 interlace and deinterlace for any color type\n*) loading the image from harddisk or decoding it from a buffer from other sources than harddisk\n*) support for alpha channels, including RGBA color model, translucent palettes and color keying\n*) zlib decompression (inflate)\n*) zlib compression (deflate)\n*) CRC32 and ADLER32 checksums\n*) colorimetric color profile conversions: currently experimentally available in lodepng_util.cpp only,\n plus alternatively ability to pass on chroma/gamma/ICC profile information to other color management system.\n*) handling of unknown chunks, allowing making a PNG editor that stores custom and unknown chunks.\n*) the following chunks are supported by both encoder and decoder:\n IHDR: header information\n PLTE: color palette\n IDAT: pixel data\n IEND: the final chunk\n tRNS: transparency for palettized images\n tEXt: textual information\n zTXt: compressed textual information\n iTXt: international textual information\n bKGD: suggested background color\n pHYs: physical dimensions\n tIME: modification time\n cHRM: RGB chromaticities\n gAMA: RGB gamma correction\n iCCP: ICC color profile\n sRGB: rendering intent\n\n1.2. features not supported\n---------------------------\n\nThe following features are _not_ supported:\n\n*) some features needed to make a conformant PNG-Editor might be still missing.\n*) partial loading/stream processing. All data must be available and is processed in one call.\n*) The following public chunks are not (yet) supported but treated as unknown chunks by LodePNG:\n sBIT\n hIST\n sPLT\n\n\n2. C and C++ version\n--------------------\n\nThe C version uses buffers allocated with alloc that you need to free()\nyourself. You need to use init and cleanup functions for each struct whenever\nusing a struct from the C version to avoid exploits and memory leaks.\n\nThe C++ version has extra functions with std::vectors in the interface and the\nlodepng::State class which is a LodePNGState with constructor and destructor.\n\nThese files work without modification for both C and C++ compilers because all\nthe additional C++ code is in \"#ifdef __cplusplus\" blocks that make C-compilers\nignore it, and the C code is made to compile both with strict ISO C90 and C++.\n\nTo use the C++ version, you need to rename the source file to lodepng.cpp\n(instead of lodepng.c), and compile it with a C++ compiler.\n\nTo use the C version, you need to rename the source file to lodepng.c (instead\nof lodepng.cpp), and compile it with a C compiler.\n\n\n3. Security\n-----------\n\nEven if carefully designed, it's always possible that LodePNG contains possible\nexploits. If you discover one, please let me know, and it will be fixed.\n\nWhen using LodePNG, care has to be taken with the C version of LodePNG, as well\nas the C-style structs when working with C++. The following conventions are used\nfor all C-style structs:\n\n-if a struct has a corresponding init function, always call the init function when making a new one\n-if a struct has a corresponding cleanup function, call it before the struct disappears to avoid memory leaks\n-if a struct has a corresponding copy function, use the copy function instead of \"=\".\n The destination must also be inited already.\n\n\n4. Decoding\n-----------\n\nDecoding converts a PNG compressed image to a raw pixel buffer.\n\nMost documentation on using the decoder is at its declarations in the header\nabove. For C, simple decoding can be done with functions such as\nlodepng_decode32, and more advanced decoding can be done with the struct\nLodePNGState and lodepng_decode. For C++, all decoding can be done with the\nvarious lodepng::decode functions, and lodepng::State can be used for advanced\nfeatures.\n\nWhen using the LodePNGState, it uses the following fields for decoding:\n*) LodePNGInfo info_png: it stores extra information about the PNG (the input) in here\n*) LodePNGColorMode info_raw: here you can say what color mode of the raw image (the output) you want to get\n*) LodePNGDecoderSettings decoder: you can specify a few extra settings for the decoder to use\n\nLodePNGInfo info_png\n--------------------\n\nAfter decoding, this contains extra information of the PNG image, except the actual\npixels, width and height because these are already gotten directly from the decoder\nfunctions.\n\nIt contains for example the original color type of the PNG image, text comments,\nsuggested background color, etc... More details about the LodePNGInfo struct are\nat its declaration documentation.\n\nLodePNGColorMode info_raw\n-------------------------\n\nWhen decoding, here you can specify which color type you want\nthe resulting raw image to be. If this is different from the colortype of the\nPNG, then the decoder will automatically convert the result. This conversion\nalways works, except if you want it to convert a color PNG to grayscale or to\na palette with missing colors.\n\nBy default, 32-bit color is used for the result.\n\nLodePNGDecoderSettings decoder\n------------------------------\n\nThe settings can be used to ignore the errors created by invalid CRC and Adler32\nchunks, and to disable the decoding of tEXt chunks.\n\nThere's also a setting color_convert, true by default. If false, no conversion\nis done, the resulting data will be as it was in the PNG (after decompression)\nand you'll have to puzzle the colors of the pixels together yourself using the\ncolor type information in the LodePNGInfo.\n\n\n5. Encoding\n-----------\n\nEncoding converts a raw pixel buffer to a PNG compressed image.\n\nMost documentation on using the encoder is at its declarations in the header\nabove. For C, simple encoding can be done with functions such as\nlodepng_encode32, and more advanced decoding can be done with the struct\nLodePNGState and lodepng_encode. For C++, all encoding can be done with the\nvarious lodepng::encode functions, and lodepng::State can be used for advanced\nfeatures.\n\nLike the decoder, the encoder can also give errors. However it gives less errors\nsince the encoder input is trusted, the decoder input (a PNG image that could\nbe forged by anyone) is not trusted.\n\nWhen using the LodePNGState, it uses the following fields for encoding:\n*) LodePNGInfo info_png: here you specify how you want the PNG (the output) to be.\n*) LodePNGColorMode info_raw: here you say what color type of the raw image (the input) has\n*) LodePNGEncoderSettings encoder: you can specify a few settings for the encoder to use\n\nLodePNGInfo info_png\n--------------------\n\nWhen encoding, you use this the opposite way as when decoding: for encoding,\nyou fill in the values you want the PNG to have before encoding. By default it's\nnot needed to specify a color type for the PNG since it's automatically chosen,\nbut it's possible to choose it yourself given the right settings.\n\nThe encoder will not always exactly match the LodePNGInfo struct you give,\nit tries as close as possible. Some things are ignored by the encoder. The\nencoder uses, for example, the following settings from it when applicable:\ncolortype and bitdepth, text chunks, time chunk, the color key, the palette, the\nbackground color, the interlace method, unknown chunks, ...\n\nWhen encoding to a PNG with colortype 3, the encoder will generate a PLTE chunk.\nIf the palette contains any colors for which the alpha channel is not 255 (so\nthere are translucent colors in the palette), it'll add a tRNS chunk.\n\nLodePNGColorMode info_raw\n-------------------------\n\nYou specify the color type of the raw image that you give to the input here,\nincluding a possible transparent color key and palette you happen to be using in\nyour raw image data.\n\nBy default, 32-bit color is assumed, meaning your input has to be in RGBA\nformat with 4 bytes (unsigned chars) per pixel.\n\nLodePNGEncoderSettings encoder\n------------------------------\n\nThe following settings are supported (some are in sub-structs):\n*) auto_convert: when this option is enabled, the encoder will\nautomatically choose the smallest possible color mode (including color key) that\ncan encode the colors of all pixels without information loss.\n*) btype: the block type for LZ77. 0 = uncompressed, 1 = fixed huffman tree,\n 2 = dynamic huffman tree (best compression). Should be 2 for proper\n compression.\n*) use_lz77: whether or not to use LZ77 for compressed block types. Should be\n true for proper compression.\n*) windowsize: the window size used by the LZ77 encoder (1 - 32768). Has value\n 2048 by default, but can be set to 32768 for better, but slow, compression.\n*) force_palette: if colortype is 2 or 6, you can make the encoder write a PLTE\n chunk if force_palette is true. This can used as suggested palette to convert\n to by viewers that don't support more than 256 colors (if those still exist)\n*) add_id: add text chunk \"Encoder: LodePNG \" to the image.\n*) text_compression: default 1. If 1, it'll store texts as zTXt instead of tEXt chunks.\n zTXt chunks use zlib compression on the text. This gives a smaller result on\n large texts but a larger result on small texts (such as a single program name).\n It's all tEXt or all zTXt though, there's no separate setting per text yet.\n\n\n6. color conversions\n--------------------\n\nAn important thing to note about LodePNG, is that the color type of the PNG, and\nthe color type of the raw image, are completely independent. By default, when\nyou decode a PNG, you get the result as a raw image in the color type you want,\nno matter whether the PNG was encoded with a palette, grayscale or RGBA color.\nAnd if you encode an image, by default LodePNG will automatically choose the PNG\ncolor type that gives good compression based on the values of colors and amount\nof colors in the image. It can be configured to let you control it instead as\nwell, though.\n\nTo be able to do this, LodePNG does conversions from one color mode to another.\nIt can convert from almost any color type to any other color type, except the\nfollowing conversions: RGB to grayscale is not supported, and converting to a\npalette when the palette doesn't have a required color is not supported. This is\nnot supported on purpose: this is information loss which requires a color\nreduction algorithm that is beyond the scope of a PNG encoder (yes, RGB to gray\nis easy, but there are multiple ways if you want to give some channels more\nweight).\n\nBy default, when decoding, you get the raw image in 32-bit RGBA or 24-bit RGB\ncolor, no matter what color type the PNG has. And by default when encoding,\nLodePNG automatically picks the best color model for the output PNG, and expects\nthe input image to be 32-bit RGBA or 24-bit RGB. So, unless you want to control\nthe color format of the images yourself, you can skip this chapter.\n\n6.1. PNG color types\n--------------------\n\nA PNG image can have many color types, ranging from 1-bit color to 64-bit color,\nas well as palettized color modes. After the zlib decompression and unfiltering\nin the PNG image is done, the raw pixel data will have that color type and thus\na certain amount of bits per pixel. If you want the output raw image after\ndecoding to have another color type, a conversion is done by LodePNG.\n\nThe PNG specification gives the following color types:\n\n0: grayscale, bit depths 1, 2, 4, 8, 16\n2: RGB, bit depths 8 and 16\n3: palette, bit depths 1, 2, 4 and 8\n4: grayscale with alpha, bit depths 8 and 16\n6: RGBA, bit depths 8 and 16\n\nBit depth is the amount of bits per pixel per color channel. So the total amount\nof bits per pixel is: amount of channels * bitdepth.\n\n6.2. color conversions\n----------------------\n\nAs explained in the sections about the encoder and decoder, you can specify\ncolor types and bit depths in info_png and info_raw to change the default\nbehaviour.\n\nIf, when decoding, you want the raw image to be something else than the default,\nyou need to set the color type and bit depth you want in the LodePNGColorMode,\nor the parameters colortype and bitdepth of the simple decoding function.\n\nIf, when encoding, you use another color type than the default in the raw input\nimage, you need to specify its color type and bit depth in the LodePNGColorMode\nof the raw image, or use the parameters colortype and bitdepth of the simple\nencoding function.\n\nIf, when encoding, you don't want LodePNG to choose the output PNG color type\nbut control it yourself, you need to set auto_convert in the encoder settings\nto false, and specify the color type you want in the LodePNGInfo of the\nencoder (including palette: it can generate a palette if auto_convert is true,\notherwise not).\n\nIf the input and output color type differ (whether user chosen or auto chosen),\nLodePNG will do a color conversion, which follows the rules below, and may\nsometimes result in an error.\n\nTo avoid some confusion:\n-the decoder converts from PNG to raw image\n-the encoder converts from raw image to PNG\n-the colortype and bitdepth in LodePNGColorMode info_raw, are those of the raw image\n-the colortype and bitdepth in the color field of LodePNGInfo info_png, are those of the PNG\n-when encoding, the color type in LodePNGInfo is ignored if auto_convert\n is enabled, it is automatically generated instead\n-when decoding, the color type in LodePNGInfo is set by the decoder to that of the original\n PNG image, but it can be ignored since the raw image has the color type you requested instead\n-if the color type of the LodePNGColorMode and PNG image aren't the same, a conversion\n between the color types is done if the color types are supported. If it is not\n supported, an error is returned. If the types are the same, no conversion is done.\n-even though some conversions aren't supported, LodePNG supports loading PNGs from any\n colortype and saving PNGs to any colortype, sometimes it just requires preparing\n the raw image correctly before encoding.\n-both encoder and decoder use the same color converter.\n\nThe function lodepng_convert does the color conversion. It is available in the\ninterface but normally isn't needed since the encoder and decoder already call\nit.\n\nNon supported color conversions:\n-color to grayscale when non-gray pixels are present: no error is thrown, but\nthe result will look ugly because only the red channel is taken (it assumes all\nthree channels are the same in this case so ignores green and blue). The reason\nno error is given is to allow converting from three-channel grayscale images to\none-channel even if there are numerical imprecisions.\n-anything to palette when the palette does not have an exact match for a from-color\nin it: in this case an error is thrown\n\nSupported color conversions:\n-anything to 8-bit RGB, 8-bit RGBA, 16-bit RGB, 16-bit RGBA\n-any gray or gray+alpha, to gray or gray+alpha\n-anything to a palette, as long as the palette has the requested colors in it\n-removing alpha channel\n-higher to smaller bitdepth, and vice versa\n\nIf you want no color conversion to be done (e.g. for speed or control):\n-In the encoder, you can make it save a PNG with any color type by giving the\nraw color mode and LodePNGInfo the same color mode, and setting auto_convert to\nfalse.\n-In the decoder, you can make it store the pixel data in the same color type\nas the PNG has, by setting the color_convert setting to false. Settings in\ninfo_raw are then ignored.\n\n6.3. padding bits\n-----------------\n\nIn the PNG file format, if a less than 8-bit per pixel color type is used and the scanlines\nhave a bit amount that isn't a multiple of 8, then padding bits are used so that each\nscanline starts at a fresh byte. But that is NOT true for the LodePNG raw input and output.\nThe raw input image you give to the encoder, and the raw output image you get from the decoder\nwill NOT have these padding bits, e.g. in the case of a 1-bit image with a width\nof 7 pixels, the first pixel of the second scanline will the 8th bit of the first byte,\nnot the first bit of a new byte.\n\n6.4. A note about 16-bits per channel and endianness\n----------------------------------------------------\n\nLodePNG uses unsigned char arrays for 16-bit per channel colors too, just like\nfor any other color format. The 16-bit values are stored in big endian (most\nsignificant byte first) in these arrays. This is the opposite order of the\nlittle endian used by x86 CPU's.\n\nLodePNG always uses big endian because the PNG file format does so internally.\nConversions to other formats than PNG uses internally are not supported by\nLodePNG on purpose, there are myriads of formats, including endianness of 16-bit\ncolors, the order in which you store R, G, B and A, and so on. Supporting and\nconverting to/from all that is outside the scope of LodePNG.\n\nThis may mean that, depending on your use case, you may want to convert the big\nendian output of LodePNG to little endian with a for loop. This is certainly not\nalways needed, many applications and libraries support big endian 16-bit colors\nanyway, but it means you cannot simply cast the unsigned char* buffer to an\nunsigned short* buffer on x86 CPUs.\n\n\n7. error values\n---------------\n\nAll functions in LodePNG that return an error code, return 0 if everything went\nOK, or a non-zero code if there was an error.\n\nThe meaning of the LodePNG error values can be retrieved with the function\nlodepng_error_text: given the numerical error code, it returns a description\nof the error in English as a string.\n\nCheck the implementation of lodepng_error_text to see the meaning of each code.\n\nIt is not recommended to use the numerical values to programmatically make\ndifferent decisions based on error types as the numbers are not guaranteed to\nstay backwards compatible. They are for human consumption only. Programmatically\nonly 0 or non-0 matter.\n\n\n8. chunks and PNG editing\n-------------------------\n\nIf you want to add extra chunks to a PNG you encode, or use LodePNG for a PNG\neditor that should follow the rules about handling of unknown chunks, or if your\nprogram is able to read other types of chunks than the ones handled by LodePNG,\nthen that's possible with the chunk functions of LodePNG.\n\nA PNG chunk has the following layout:\n\n4 bytes length\n4 bytes type name\nlength bytes data\n4 bytes CRC\n\n8.1. iterating through chunks\n-----------------------------\n\nIf you have a buffer containing the PNG image data, then the first chunk (the\nIHDR chunk) starts at byte number 8 of that buffer. The first 8 bytes are the\nsignature of the PNG and are not part of a chunk. But if you start at byte 8\nthen you have a chunk, and can check the following things of it.\n\nNOTE: none of these functions check for memory buffer boundaries. To avoid\nexploits, always make sure the buffer contains all the data of the chunks.\nWhen using lodepng_chunk_next, make sure the returned value is within the\nallocated memory.\n\nunsigned lodepng_chunk_length(const unsigned char* chunk):\n\nGet the length of the chunk's data. The total chunk length is this length + 12.\n\nvoid lodepng_chunk_type(char type[5], const unsigned char* chunk):\nunsigned char lodepng_chunk_type_equals(const unsigned char* chunk, const char* type):\n\nGet the type of the chunk or compare if it's a certain type\n\nunsigned char lodepng_chunk_critical(const unsigned char* chunk):\nunsigned char lodepng_chunk_private(const unsigned char* chunk):\nunsigned char lodepng_chunk_safetocopy(const unsigned char* chunk):\n\nCheck if the chunk is critical in the PNG standard (only IHDR, PLTE, IDAT and IEND are).\nCheck if the chunk is private (public chunks are part of the standard, private ones not).\nCheck if the chunk is safe to copy. If it's not, then, when modifying data in a critical\nchunk, unsafe to copy chunks of the old image may NOT be saved in the new one if your\nprogram doesn't handle that type of unknown chunk.\n\nunsigned char* lodepng_chunk_data(unsigned char* chunk):\nconst unsigned char* lodepng_chunk_data_const(const unsigned char* chunk):\n\nGet a pointer to the start of the data of the chunk.\n\nunsigned lodepng_chunk_check_crc(const unsigned char* chunk):\nvoid lodepng_chunk_generate_crc(unsigned char* chunk):\n\nCheck if the crc is correct or generate a correct one.\n\nunsigned char* lodepng_chunk_next(unsigned char* chunk):\nconst unsigned char* lodepng_chunk_next_const(const unsigned char* chunk):\n\nIterate to the next chunk. This works if you have a buffer with consecutive chunks. Note that these\nfunctions do no boundary checking of the allocated data whatsoever, so make sure there is enough\ndata available in the buffer to be able to go to the next chunk.\n\nunsigned lodepng_chunk_append(unsigned char** out, size_t* outsize, const unsigned char* chunk):\nunsigned lodepng_chunk_create(unsigned char** out, size_t* outsize, unsigned length,\n const char* type, const unsigned char* data):\n\nThese functions are used to create new chunks that are appended to the data in *out that has\nlength *outsize. The append function appends an existing chunk to the new data. The create\nfunction creates a new chunk with the given parameters and appends it. Type is the 4-letter\nname of the chunk.\n\n8.2. chunks in info_png\n-----------------------\n\nThe LodePNGInfo struct contains fields with the unknown chunk in it. It has 3\nbuffers (each with size) to contain 3 types of unknown chunks:\nthe ones that come before the PLTE chunk, the ones that come between the PLTE\nand the IDAT chunks, and the ones that come after the IDAT chunks.\nIt's necessary to make the distinction between these 3 cases because the PNG\nstandard forces to keep the ordering of unknown chunks compared to the critical\nchunks, but does not force any other ordering rules.\n\ninfo_png.unknown_chunks_data[0] is the chunks before PLTE\ninfo_png.unknown_chunks_data[1] is the chunks after PLTE, before IDAT\ninfo_png.unknown_chunks_data[2] is the chunks after IDAT\n\nThe chunks in these 3 buffers can be iterated through and read by using the same\nway described in the previous subchapter.\n\nWhen using the decoder to decode a PNG, you can make it store all unknown chunks\nif you set the option settings.remember_unknown_chunks to 1. By default, this\noption is off (0).\n\nThe encoder will always encode unknown chunks that are stored in the info_png.\nIf you need it to add a particular chunk that isn't known by LodePNG, you can\nuse lodepng_chunk_append or lodepng_chunk_create to the chunk data in\ninfo_png.unknown_chunks_data[x].\n\nChunks that are known by LodePNG should not be added in that way. E.g. to make\nLodePNG add a bKGD chunk, set background_defined to true and add the correct\nparameters there instead.\n\n\n9. compiler support\n-------------------\n\nNo libraries other than the current standard C library are needed to compile\nLodePNG. For the C++ version, only the standard C++ library is needed on top.\nAdd the files lodepng.c(pp) and lodepng.h to your project, include\nlodepng.h where needed, and your program can read/write PNG files.\n\nIt is compatible with C90 and up, and C++03 and up.\n\nIf performance is important, use optimization when compiling! For both the\nencoder and decoder, this makes a large difference.\n\nMake sure that LodePNG is compiled with the same compiler of the same version\nand with the same settings as the rest of the program, or the interfaces with\nstd::vectors and std::strings in C++ can be incompatible.\n\nCHAR_BITS must be 8 or higher, because LodePNG uses unsigned chars for octets.\n\n*) gcc and g++\n\nLodePNG is developed in gcc so this compiler is natively supported. It gives no\nwarnings with compiler options \"-Wall -Wextra -pedantic -ansi\", with gcc and g++\nversion 4.7.1 on Linux, 32-bit and 64-bit.\n\n*) Clang\n\nFully supported and warning-free.\n\n*) Mingw\n\nThe Mingw compiler (a port of gcc for Windows) should be fully supported by\nLodePNG.\n\n*) Visual Studio and Visual C++ Express Edition\n\nLodePNG should be warning-free with warning level W4. Two warnings were disabled\nwith pragmas though: warning 4244 about implicit conversions, and warning 4996\nwhere it wants to use a non-standard function fopen_s instead of the standard C\nfopen.\n\nVisual Studio may want \"stdafx.h\" files to be included in each source file and\ngive an error \"unexpected end of file while looking for precompiled header\".\nThis is not standard C++ and will not be added to the stock LodePNG. You can\ndisable it for lodepng.cpp only by right clicking it, Properties, C/C++,\nPrecompiled Headers, and set it to Not Using Precompiled Headers there.\n\nNOTE: Modern versions of VS should be fully supported, but old versions, e.g.\nVS6, are not guaranteed to work.\n\n*) Compilers on Macintosh\n\nLodePNG has been reported to work both with gcc and LLVM for Macintosh, both for\nC and C++.\n\n*) Other Compilers\n\nIf you encounter problems on any compilers, feel free to let me know and I may\ntry to fix it if the compiler is modern and standards compliant.\n\n\n10. examples\n------------\n\nThis decoder example shows the most basic usage of LodePNG. More complex\nexamples can be found on the LodePNG website.\n\nNOTE: these examples do not support wide-character filenames, you can use an\nexternal method to handle such files and encode or decode in-memory\n\n10.1. decoder C++ example\n-------------------------\n\n#include \"lodepng.h\"\n#include \n\nint main(int argc, char *argv[]) {\n const char* filename = argc > 1 ? argv[1] : \"test.png\";\n\n //load and decode\n std::vector image;\n unsigned width, height;\n unsigned error = lodepng::decode(image, width, height, filename);\n\n //if there's an error, display it\n if(error) std::cout << \"decoder error \" << error << \": \" << lodepng_error_text(error) << std::endl;\n\n //the pixels are now in the vector \"image\", 4 bytes per pixel, ordered RGBARGBA..., use it as texture, draw it, ...\n}\n\n10.2. decoder C example\n-----------------------\n\n#include \"lodepng.h\"\n\nint main(int argc, char *argv[]) {\n unsigned error;\n unsigned char* image;\n size_t width, height;\n const char* filename = argc > 1 ? argv[1] : \"test.png\";\n\n error = lodepng_decode32_file(&image, &width, &height, filename);\n\n if(error) printf(\"decoder error %u: %s\\n\", error, lodepng_error_text(error));\n\n / * use image here * /\n\n free(image);\n return 0;\n}\n\n11. state settings reference\n----------------------------\n\nA quick reference of some settings to set on the LodePNGState\n\nFor decoding:\n\nstate.decoder.zlibsettings.ignore_adler32: ignore ADLER32 checksums\nstate.decoder.zlibsettings.custom_...: use custom inflate function\nstate.decoder.ignore_crc: ignore CRC checksums\nstate.decoder.ignore_critical: ignore unknown critical chunks\nstate.decoder.ignore_end: ignore missing IEND chunk. May fail if this corruption causes other errors\nstate.decoder.color_convert: convert internal PNG color to chosen one\nstate.decoder.read_text_chunks: whether to read in text metadata chunks\nstate.decoder.remember_unknown_chunks: whether to read in unknown chunks\nstate.info_raw.colortype: desired color type for decoded image\nstate.info_raw.bitdepth: desired bit depth for decoded image\nstate.info_raw....: more color settings, see struct LodePNGColorMode\nstate.info_png....: no settings for decoder but output, see struct LodePNGInfo\n\nFor encoding:\n\nstate.encoder.zlibsettings.btype: disable compression by setting it to 0\nstate.encoder.zlibsettings.use_lz77: use LZ77 in compression\nstate.encoder.zlibsettings.windowsize: tweak LZ77 windowsize\nstate.encoder.zlibsettings.minmatch: tweak min LZ77 length to match\nstate.encoder.zlibsettings.nicematch: tweak LZ77 match where to stop searching\nstate.encoder.zlibsettings.lazymatching: try one more LZ77 matching\nstate.encoder.zlibsettings.custom_...: use custom deflate function\nstate.encoder.auto_convert: choose optimal PNG color type, if 0 uses info_png\nstate.encoder.filter_palette_zero: PNG filter strategy for palette\nstate.encoder.filter_strategy: PNG filter strategy to encode with\nstate.encoder.force_palette: add palette even if not encoding to one\nstate.encoder.add_id: add LodePNG identifier and version as a text chunk\nstate.encoder.text_compression: use compressed text chunks for metadata\nstate.info_raw.colortype: color type of raw input image you provide\nstate.info_raw.bitdepth: bit depth of raw input image you provide\nstate.info_raw: more color settings, see struct LodePNGColorMode\nstate.info_png.color.colortype: desired color type if auto_convert is false\nstate.info_png.color.bitdepth: desired bit depth if auto_convert is false\nstate.info_png.color....: more color settings, see struct LodePNGColorMode\nstate.info_png....: more PNG related settings, see struct LodePNGInfo\n\n\n12. changes\n-----------\n\nThe version number of LodePNG is the date of the change given in the format\nyyyymmdd.\n\nSome changes aren't backwards compatible. Those are indicated with a (!)\nsymbol.\n\nNot all changes are listed here, the commit history in github lists more:\nhttps://github.com/lvandeve/lodepng\n\n*) 09 jan 2022: minor decoder speed improvements.\n*) 27 jun 2021: added warnings that file reading/writing functions don't support\n wide-character filenames (support for this is not planned, opening files is\n not the core part of PNG decoding/decoding and is platform dependent).\n*) 17 okt 2020: prevent decoding too large text/icc chunks by default.\n*) 06 mar 2020: simplified some of the dynamic memory allocations.\n*) 12 jan 2020: (!) added 'end' argument to lodepng_chunk_next to allow correct\n overflow checks.\n*) 14 aug 2019: around 25% faster decoding thanks to huffman lookup tables.\n*) 15 jun 2019: (!) auto_choose_color API changed (for bugfix: don't use palette\n if gray ICC profile) and non-ICC LodePNGColorProfile renamed to\n LodePNGColorStats.\n*) 30 dec 2018: code style changes only: removed newlines before opening braces.\n*) 10 sep 2018: added way to inspect metadata chunks without full decoding.\n*) 19 aug 2018: (!) fixed color mode bKGD is encoded with and made it use\n palette index in case of palette.\n*) 10 aug 2018: (!) added support for gAMA, cHRM, sRGB and iCCP chunks. This\n change is backwards compatible unless you relied on unknown_chunks for those.\n*) 11 jun 2018: less restrictive check for pixel size integer overflow\n*) 14 jan 2018: allow optionally ignoring a few more recoverable errors\n*) 17 sep 2017: fix memory leak for some encoder input error cases\n*) 27 nov 2016: grey+alpha auto color model detection bugfix\n*) 18 apr 2016: Changed qsort to custom stable sort (for platforms w/o qsort).\n*) 09 apr 2016: Fixed colorkey usage detection, and better file loading (within\n the limits of pure C90).\n*) 08 dec 2015: Made load_file function return error if file can't be opened.\n*) 24 okt 2015: Bugfix with decoding to palette output.\n*) 18 apr 2015: Boundary PM instead of just package-merge for faster encoding.\n*) 24 aug 2014: Moved to github\n*) 23 aug 2014: Reduced needless memory usage of decoder.\n*) 28 jun 2014: Removed fix_png setting, always support palette OOB for\n simplicity. Made ColorProfile public.\n*) 09 jun 2014: Faster encoder by fixing hash bug and more zeros optimization.\n*) 22 dec 2013: Power of two windowsize required for optimization.\n*) 15 apr 2013: Fixed bug with LAC_ALPHA and color key.\n*) 25 mar 2013: Added an optional feature to ignore some PNG errors (fix_png).\n*) 11 mar 2013: (!) Bugfix with custom free. Changed from \"my\" to \"lodepng_\"\n prefix for the custom allocators and made it possible with a new #define to\n use custom ones in your project without needing to change lodepng's code.\n*) 28 jan 2013: Bugfix with color key.\n*) 27 okt 2012: Tweaks in text chunk keyword length error handling.\n*) 8 okt 2012: (!) Added new filter strategy (entropy) and new auto color mode.\n (no palette). Better deflate tree encoding. New compression tweak settings.\n Faster color conversions while decoding. Some internal cleanups.\n*) 23 sep 2012: Reduced warnings in Visual Studio a little bit.\n*) 1 sep 2012: (!) Removed #define's for giving custom (de)compression functions\n and made it work with function pointers instead.\n*) 23 jun 2012: Added more filter strategies. Made it easier to use custom alloc\n and free functions and toggle #defines from compiler flags. Small fixes.\n*) 6 may 2012: (!) Made plugging in custom zlib/deflate functions more flexible.\n*) 22 apr 2012: (!) Made interface more consistent, renaming a lot. Removed\n redundant C++ codec classes. Reduced amount of structs. Everything changed,\n but it is cleaner now imho and functionality remains the same. Also fixed\n several bugs and shrunk the implementation code. Made new samples.\n*) 6 nov 2011: (!) By default, the encoder now automatically chooses the best\n PNG color model and bit depth, based on the amount and type of colors of the\n raw image. For this, autoLeaveOutAlphaChannel replaced by auto_choose_color.\n*) 9 okt 2011: simpler hash chain implementation for the encoder.\n*) 8 sep 2011: lz77 encoder lazy matching instead of greedy matching.\n*) 23 aug 2011: tweaked the zlib compression parameters after benchmarking.\n A bug with the PNG filtertype heuristic was fixed, so that it chooses much\n better ones (it's quite significant). A setting to do an experimental, slow,\n brute force search for PNG filter types is added.\n*) 17 aug 2011: (!) changed some C zlib related function names.\n*) 16 aug 2011: made the code less wide (max 120 characters per line).\n*) 17 apr 2011: code cleanup. Bugfixes. Convert low to 16-bit per sample colors.\n*) 21 feb 2011: fixed compiling for C90. Fixed compiling with sections disabled.\n*) 11 dec 2010: encoding is made faster, based on suggestion by Peter Eastman\n to optimize long sequences of zeros.\n*) 13 nov 2010: added LodePNG_InfoColor_hasPaletteAlpha and\n LodePNG_InfoColor_canHaveAlpha functions for convenience.\n*) 7 nov 2010: added LodePNG_error_text function to get error code description.\n*) 30 okt 2010: made decoding slightly faster\n*) 26 okt 2010: (!) changed some C function and struct names (more consistent).\n Reorganized the documentation and the declaration order in the header.\n*) 08 aug 2010: only changed some comments and external samples.\n*) 05 jul 2010: fixed bug thanks to warnings in the new gcc version.\n*) 14 mar 2010: fixed bug where too much memory was allocated for char buffers.\n*) 02 sep 2008: fixed bug where it could create empty tree that linux apps could\n read by ignoring the problem but windows apps couldn't.\n*) 06 jun 2008: added more error checks for out of memory cases.\n*) 26 apr 2008: added a few more checks here and there to ensure more safety.\n*) 06 mar 2008: crash with encoding of strings fixed\n*) 02 feb 2008: support for international text chunks added (iTXt)\n*) 23 jan 2008: small cleanups, and #defines to divide code in sections\n*) 20 jan 2008: support for unknown chunks allowing using LodePNG for an editor.\n*) 18 jan 2008: support for tIME and pHYs chunks added to encoder and decoder.\n*) 17 jan 2008: ability to encode and decode compressed zTXt chunks added\n Also various fixes, such as in the deflate and the padding bits code.\n*) 13 jan 2008: Added ability to encode Adam7-interlaced images. Improved\n filtering code of encoder.\n*) 07 jan 2008: (!) changed LodePNG to use ISO C90 instead of C++. A\n C++ wrapper around this provides an interface almost identical to before.\n Having LodePNG be pure ISO C90 makes it more portable. The C and C++ code\n are together in these files but it works both for C and C++ compilers.\n*) 29 dec 2007: (!) changed most integer types to unsigned int + other tweaks\n*) 30 aug 2007: bug fixed which makes this Borland C++ compatible\n*) 09 aug 2007: some VS2005 warnings removed again\n*) 21 jul 2007: deflate code placed in new namespace separate from zlib code\n*) 08 jun 2007: fixed bug with 2- and 4-bit color, and small interlaced images\n*) 04 jun 2007: improved support for Visual Studio 2005: crash with accessing\n invalid std::vector element [0] fixed, and level 3 and 4 warnings removed\n*) 02 jun 2007: made the encoder add a tag with version by default\n*) 27 may 2007: zlib and png code separated (but still in the same file),\n simple encoder/decoder functions added for more simple usage cases\n*) 19 may 2007: minor fixes, some code cleaning, new error added (error 69),\n moved some examples from here to lodepng_examples.cpp\n*) 12 may 2007: palette decoding bug fixed\n*) 24 apr 2007: changed the license from BSD to the zlib license\n*) 11 mar 2007: very simple addition: ability to encode bKGD chunks.\n*) 04 mar 2007: (!) tEXt chunk related fixes, and support for encoding\n palettized PNG images. Plus little interface change with palette and texts.\n*) 03 mar 2007: Made it encode dynamic Huffman shorter with repeat codes.\n Fixed a bug where the end code of a block had length 0 in the Huffman tree.\n*) 26 feb 2007: Huffman compression with dynamic trees (BTYPE 2) now implemented\n and supported by the encoder, resulting in smaller PNGs at the output.\n*) 27 jan 2007: Made the Adler-32 test faster so that a timewaste is gone.\n*) 24 jan 2007: gave encoder an error interface. Added color conversion from any\n greyscale type to 8-bit greyscale with or without alpha.\n*) 21 jan 2007: (!) Totally changed the interface. It allows more color types\n to convert to and is more uniform. See the manual for how it works now.\n*) 07 jan 2007: Some cleanup & fixes, and a few changes over the last days:\n encode/decode custom tEXt chunks, separate classes for zlib & deflate, and\n at last made the decoder give errors for incorrect Adler32 or Crc.\n*) 01 jan 2007: Fixed bug with encoding PNGs with less than 8 bits per channel.\n*) 29 dec 2006: Added support for encoding images without alpha channel, and\n cleaned out code as well as making certain parts faster.\n*) 28 dec 2006: Added \"Settings\" to the encoder.\n*) 26 dec 2006: The encoder now does LZ77 encoding and produces much smaller files now.\n Removed some code duplication in the decoder. Fixed little bug in an example.\n*) 09 dec 2006: (!) Placed output parameters of public functions as first parameter.\n Fixed a bug of the decoder with 16-bit per color.\n*) 15 okt 2006: Changed documentation structure\n*) 09 okt 2006: Encoder class added. It encodes a valid PNG image from the\n given image buffer, however for now it's not compressed.\n*) 08 sep 2006: (!) Changed to interface with a Decoder class\n*) 30 jul 2006: (!) LodePNG_InfoPng , width and height are now retrieved in different\n way. Renamed decodePNG to decodePNGGeneric.\n*) 29 jul 2006: (!) Changed the interface: image info is now returned as a\n struct of type LodePNG::LodePNG_Info, instead of a vector, which was a bit clumsy.\n*) 28 jul 2006: Cleaned the code and added new error checks.\n Corrected terminology \"deflate\" into \"inflate\".\n*) 23 jun 2006: Added SDL example in the documentation in the header, this\n example allows easy debugging by displaying the PNG and its transparency.\n*) 22 jun 2006: (!) Changed way to obtain error value. Added\n loadFile function for convenience. Made decodePNG32 faster.\n*) 21 jun 2006: (!) Changed type of info vector to unsigned.\n Changed position of palette in info vector. Fixed an important bug that\n happened on PNGs with an uncompressed block.\n*) 16 jun 2006: Internally changed unsigned into unsigned where\n needed, and performed some optimizations.\n*) 07 jun 2006: (!) Renamed functions to decodePNG and placed them\n in LodePNG namespace. Changed the order of the parameters. Rewrote the\n documentation in the header. Renamed files to lodepng.cpp and lodepng.h\n*) 22 apr 2006: Optimized and improved some code\n*) 07 sep 2005: (!) Changed to std::vector interface\n*) 12 aug 2005: Initial release (C++, decoder only)\n\n\n13. contact information\n-----------------------\n\nFeel free to contact me with suggestions, problems, comments, ... concerning\nLodePNG. If you encounter a PNG image that doesn't work properly with this\ndecoder, feel free to send it and I'll use it to find and fix the problem.\n\nMy email address is (puzzle the account and domain together with an @ symbol):\nDomain: gmail dot com.\nAccount: lode dot vandevenne.\n\n\nCopyright (c) 2005-2022 Lode Vandevenne\n*/\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_8/lodepng/lodepng.cpp", "content": "#include \"lodepng.h\"\n" }, { "path": "Fixtures/Miscellaneous/CXX17CompilerCrash/v5_8/src/user_objects.cc", "content": "#include \"user_objects.h\"\n" }, { "path": "Fixtures/Miscellaneous/CaseCollision/Package.swift", "content": "// swift-tools-version:6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"CaseInsensitiveCollisions\",\n products: [\n .executable(name: \"foo\", targets: [\"footool\"]),\n ],\n targets: [\n .executableTarget(name: \"footool\", dependencies: [\"Foo\"]),\n .target(name: \"Foo\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/CaseCollision/Sources/Foo/Foo.swift", "content": "public func greeting() -> String {\n \"Hello, world!\"\n}\n" }, { "path": "Fixtures/Miscellaneous/CaseCollision/Sources/footool/main.swift", "content": "import Foo\n\nprint(greeting())\n" }, { "path": "Fixtures/Miscellaneous/CheckTestLibraryEnvironmentVariable/Package.swift", "content": "// swift-tools-version: 5.10\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CheckTestLibraryEnvironmentVariable\",\n targets: [\n .testTarget(name: \"CheckTestLibraryEnvironmentVariableTests\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/CheckTestLibraryEnvironmentVariable/Tests/CheckTestLibraryEnvironmentVariableTests/CheckTestLibraryEnvironmentVariableTests.swift", "content": "import XCTest\n\nfinal class CheckTestLibraryEnvironmentVariableTests: XCTestCase {\n func testEnvironmentVariables() throws {\n #if !os(macOS)\n try XCTSkipIf(true, \"Test is macOS specific\")\n #endif\n\n let testingEnabled = ProcessInfo.processInfo.environment[\"SWIFT_TESTING_ENABLED\"]\n XCTAssertEqual(testingEnabled, \"0\")\n\n if ProcessInfo.processInfo.environment[\"CONTAINS_SWIFT_TESTING\"] != nil {\n let frameworkPath = try XCTUnwrap(ProcessInfo.processInfo.environment[\"DYLD_FRAMEWORK_PATH\"])\n let libraryPath = try XCTUnwrap(ProcessInfo.processInfo.environment[\"DYLD_LIBRARY_PATH\"])\n XCTAssertTrue(\n frameworkPath.contains(\"testing\") || libraryPath.contains(\"testing\"),\n \"Expected 'testing' in '\\(frameworkPath)' or '\\(libraryPath)'\"\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/CompileFails/Foo.swift", "content": "class Foo {\n var bar: Int = 0\n \n compile_failure\n}\n" }, { "path": "Fixtures/Miscellaneous/CompileFails/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CompileFails\",\n targets: [\n .target(name: \"CompileFails\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/app/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"app\",\n products: [\n .executable(name: \"app\", targets: [\"app\"])\n ],\n dependencies: [\n .package(url: \"../dep1\", from: \"1.0.0\"),\n .package(url: \"../dep2\", from: \"1.0.0\"),\n ],\n targets: [\n .executableTarget(\n name: \"app\",\n dependencies: [\n .product(name: \"dep1\", package: \"dep1\"),\n .product(name: \"dep2\", package: \"dep2\")\n ],\n path: \"./\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/app/app.swift", "content": "import dep1\nimport dep2\n\n@main\nstruct App {\n var deprecated: DeprecatedApp\n\n public static func main() {\n print(\"hello, world!\")\n }\n}\n\n@available(*, deprecated)\nstruct DeprecatedApp {\n}\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/dep1/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"dep1\",\n products: [\n .library(name: \"dep1\", targets: [\"dep1\"])\n ],\n targets: [\n .target(name: \"dep1\", path: \"./\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/dep1/code.swift", "content": "struct Dep1 {\n var deprecated: Deprecated1\n}\n\n@available(*, deprecated)\nstruct Deprecated1 {\n}\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/dep2/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"dep2\",\n products: [\n .library(name: \"dep2\", targets: [\"dep2\"])\n ],\n targets: [\n .target(name: \"dep2\", path: \"./\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings/dep2/code.swift", "content": "struct Dep2 {\n var deprecated: Deprecated2\n}\n\n@available(*, deprecated)\nstruct Deprecated2 {\n}\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/app/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"app\",\n products: [\n .executable(name: \"app\", targets: [\"app\"])\n ],\n dependencies: [\n .package(url: \"../dep1\", from: \"1.0.0\"),\n .package(url: \"../dep2\", from: \"1.0.0\"),\n ],\n targets: [\n .executableTarget(\n name: \"app\",\n dependencies: [\n .product(name: \"dep1\", package: \"dep1\"),\n .product(name: \"dep2\", package: \"dep2\")\n ],\n path: \"./\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/app/app.swift", "content": "import dep1\nimport dep2\n\n@main\nstruct App {\n public static func main() {\n print(\"hello, world!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/dep1/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"dep1\",\n products: [\n .library(name: \"dep1\", targets: [\"dep1\"])\n ],\n targets: [\n .target(name: \"dep1\", path: \"./\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/dep1/code.swift", "content": "struct Dep1 {\n var deprecated: Deprecated1\n}\n\n@available(*, deprecated)\nstruct Deprecated1 {\n}\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/dep2/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"dep2\",\n products: [\n .library(name: \"dep2\", targets: [\"dep2\"])\n ],\n targets: [\n .target(name: \"dep2\", path: \"./\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependenciesWarnings2/dep2/code.swift", "content": "struct Dep2 {\n var deprecated: Deprecated2\n}\n\n@available(*, deprecated)\nstruct Deprecated2 {\n}\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/dep1/Foo.swift", "content": "public let foo = \"Hello\"\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/dep1/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"dep1\",\n products: [\n .library(name: \"dep1\", targets: [\"dep1\"]),\n ],\n targets: [\n .target(name: \"dep1\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/dep2/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"dep2\",\n products: [\n .executable(name: \"dep2\", targets: [\"dep2\"]),\n ],\n dependencies: [\n .package(url: \"../dep1\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"dep2\", dependencies:[ \"dep1\"], path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/dep2/main.swift", "content": "import dep1\n\nprint(foo)\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/root/Bar.swift", "content": "let bar = 1\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/External/root/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"root\",\n dependencies: [\n .package(url: \"../dep2\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"root\", dependencies: [\"dep2\"], path: \"./\"),\n ]\n)\n\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/Internal/Bar/Bar.swift", "content": "public let bar = \"Hello\"\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/Internal/Foo/main.swift", "content": "import Bar\n\nprint(bar)\n" }, { "path": "Fixtures/Miscellaneous/DependencyEdges/Internal/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ExtraCommandLineFlags\",\n targets: [\n .target(name: \"Bar\", path: \"Bar\"),\n .target(name: \"Foo\", dependencies: [\"Bar\"], path: \"Foo\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DifferentProductTargetName/Package.swift", "content": "// swift-tools-version:5.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .executable(name: \"Foo\", targets: [\"Bar\"]),\n ],\n targets: [\n .target(name: \"Bar\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DifferentProductTargetName/main.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/DistantFutureDeploymentTarget/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"DistantFutureDeploymentTarget\",\n targets: [\n .target(name: \"DistantFutureDeploymentTarget\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DistantFutureDeploymentTarget/Sources/main.swift", "content": "/// This file exists to test the ability to override deployment targets via args passed to swiftc\n/// For this test to work, this file must have an API call which was introduced in a version\n/// higher than the default macOS deployment target that is checked in.\n@available(macOS 41.0, *)\nfunc foo() {}\n\nfoo()\n" }, { "path": "Fixtures/Miscellaneous/DoNotFilterLinkerDiagnostics/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"DoNotFilterLinkerDiagnostics\",\n targets: [\n .executableTarget(\n name: \"DoNotFilterLinkerDiagnostics\",\n linkerSettings: [\n .unsafeFlags([\"-Lfoobar\"]),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DoNotFilterLinkerDiagnostics/Sources/DoNotFilterLinkerDiagnostics/main.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\nprint(\"Hello, world!\")\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/PlayingCard/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"PlayingCard\",\n products: [\n .library(name: \"PlayingCard\", targets: [\"PlayingCard\"]),\n ],\n targets: [\n .target(name: \"PlayingCard\", path: \"src\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/PlayingCard/src/PlayingCard.swift", "content": "public struct PlayingCard: Equatable {\n let rank: Rank\n let suit: Suit\n\n public init(rank: Rank, suit: Suit) {\n self.rank = rank\n self.suit = suit\n }\n}\n\n// MARK: - Comparable\n\nextension PlayingCard: Comparable {}\n\npublic func <(lhs: PlayingCard, rhs: PlayingCard) -> Bool {\n return lhs.suit < rhs.suit || (lhs.suit == rhs.suit && lhs.rank < rhs.rank)\n}\n\n// MARK: - CustomStringConvertible\n\nextension PlayingCard : CustomStringConvertible {\n public var description: String {\n return \"\\(suit)\\(rank)\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/PlayingCard/src/Rank.swift", "content": "public enum Rank : Int {\n case Ace = 1\n case Two, Three, Four, Five, Six, Seven, Eight, Nine, Ten\n case Jack, Queen, King\n}\n\n// MARK: - Comparable\n\nextension Rank : Comparable {}\n\npublic func <(lhs: Rank, rhs: Rank) -> Bool {\n switch (lhs, rhs) {\n case (_, _) where lhs == rhs:\n return false\n case (.Ace, _):\n return false\n default:\n return lhs.rawValue < rhs.rawValue\n }\n}\n\n// MARK: - CustomStringConvertible\n\nextension Rank : CustomStringConvertible {\n public var description: String {\n switch self {\n case .Ace: return \"A\"\n case .Jack: return \"J\"\n case .Queen: return \"Q\"\n case .King: return \"K\"\n default:\n return \"\\(rawValue)\"\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/PlayingCard/src/Suit.swift", "content": "public enum Suit: String {\n case Spades, Hearts, Diamonds, Clubs\n}\n\n// MARK: - Comparable\n\nextension Suit: Comparable {}\n\npublic func <(lhs: Suit, rhs: Suit) -> Bool {\n switch (lhs, rhs) {\n case (_, _) where lhs == rhs:\n return false\n case (.Spades, _),\n (.Hearts, .Diamonds), (.Hearts, .Clubs),\n (.Diamonds, .Clubs):\n return false\n default:\n return true\n }\n}\n\n// MARK: - CustomStringConvertible\n\nextension Suit : CustomStringConvertible {\n public var description: String {\n switch self {\n case .Spades: return \"♠︎\"\n case .Hearts: return \"♡\"\n case .Diamonds: return \"♢\"\n case .Clubs: return \"♣︎\"\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/app/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"Dealer\",\n defaultLocalization: \"en\",\n platforms: [\n .macOS(.v10_13),\n .iOS(.v12),\n .tvOS(.v12),\n .watchOS(.v5)\n ],\n dependencies: [\n .package(path: \"../PlayingCard\"),\n ],\n targets: [\n .target(\n name: \"Dealer\",\n dependencies: [\"PlayingCard\"],\n path: \"./\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DumpPackage/app/main.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport PlayingCard\n\nlet hand: [PlayingCard] = [\n .init(rank: .Ace, suit: .Hearts),\n .init(rank: .King, suit: .Spades),\n]\n\nfor card in hand {\n print(card)\n}\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/exec/Package.swift", "content": "// swift-tools-version:6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"exec\",\n dependencies: [\n .package(path: \"../secondDyna\")\n ],\n targets: [\n .executableTarget(\n name: \"exec\",\n dependencies: [\"secondDyna\"]),\n .testTarget(\n name: \"DynaTests\",\n dependencies: [\"exec\"])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/exec/README.md", "content": "# exec\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/exec/Sources/exec/main.swift", "content": "import secondDyna\n\nprint(secondDyna.hello())\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/exec/Tests/DynaTests/Tests.swift", "content": "error\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/firstDyna/Package.swift", "content": "// swift-tools-version:5.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"firstDyna\",\n products: [\n .library(\n name: \"firstDyna\",\n type: .dynamic,\n targets: [\"firstDyna\"])\n ],\n targets: [\n .target(\n name: \"firstDyna\",\n dependencies: [\"Core\"]),\n .target(\n name: \"Core\",\n dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/firstDyna/README.md", "content": "# firstDyna\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/Core.c", "content": "#include\n\nchar* hello() {\n return \"Hello\";\n}\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/Core/include/Core.h", "content": "\nchar* hello();\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/firstDyna/Sources/firstDyna/firstDyna.swift", "content": "import Core\n\npublic func hello() -> String {\n return String(cString: Core.hello())\n}\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/secondDyna/Package.swift", "content": "// swift-tools-version:5.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"secondDyna\",\n products: [\n .library(\n name: \"secondDyna\",\n type: .dynamic,\n targets: [\"secondDyna\"])\n ],\n dependencies: [\n .package(path: \"../firstDyna\")\n ],\n targets: [\n .target(\n name: \"secondDyna\",\n dependencies: [\"firstDyna\"])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/secondDyna/README.md", "content": "# secondDyna\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/DynamicProduct/secondDyna/Sources/secondDyna/secondDyna.swift", "content": "import firstDyna \n\npublic func hello() -> String {\n return firstDyna.hello()\n}\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"EchoExecutable\",\n products: [\n .executable(name: \"secho\", targets: [\"secho\"])\n ],\n targets: [\n .target(name: \"secho\", dependencies: []),\n .testTarget(name: \"TestSuite\")\n ])\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/Sources/secho/main.swift", "content": "#if canImport(Glibc)\n\timport Glibc\n#elseif canImport(Musl)\n\timport Musl\n#elseif canImport(Android)\n\timport Android\n#elseif canImport(Darwin.C)\n\timport Darwin.C\n#elseif canImport(ucrt)\n\timport ucrt\n\tlet PATH_MAX = 260\n\ttypealias Int = Int32\n#endif\n\nlet cwd = getcwd(nil, Int(PATH_MAX))\ndefer { free(cwd) }\nlet workingDirectory = String(validatingUTF8: cwd!)!\nlet values = [workingDirectory] + Array(CommandLine.arguments.dropFirst())\nprint(values.map({ \"\\\"\\($0)\\\"\" }).joined(separator: \" \"))" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/Tests/TestSuite/Tests.swift", "content": "import XCTest\n\nfinal class TestCase: XCTestCase {\n func testFoo() {\n XCTAssertTrue(true)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/echo.bat", "content": "echo sentinel\necho %*\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/echo.sh", "content": "#!/bin/sh\n\necho sentinel\necho \"$@\"\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/toolset.json", "content": "{\n \"debugger\": { \"path\": \"echo.sh\" },\n \"testRunner\": { \"path\": \"echo.sh\" },\n \"schemaVersion\" : \"1.0\",\n \"rootPath\" : \".\"\n}\n" }, { "path": "Fixtures/Miscellaneous/EchoExecutable/toolset.win32.json", "content": "{\n \"debugger\": { \"path\": \"echo.bat\" },\n \"testRunner\": { \"path\": \"echo.bat\" },\n \"schemaVersion\" : \"1.0\",\n \"rootPath\" : \".\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Edit/App/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"App\",\n dependencies: [\n .package(name: \"Foo\", url: \"../Foo\", .branch(\"main\")),\n .package(name: \"Bar\", url: \"../Bar\", .branch(\"main\")),\n ],\n targets: [\n .target(name: \"App\", dependencies: [\n .product(name: \"Foo\", package: \"Foo\"),\n .product(name: \"Bar\", package: \"Bar\"),\n ], path: \"./src\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Edit/App/src/main.swift", "content": "import Foo\nimport Bar\n\npublic func main() {\n}\n" }, { "path": "Fixtures/Miscellaneous/Edit/Bar/Bar.swift", "content": "public func hello() {\n}\n" }, { "path": "Fixtures/Miscellaneous/Edit/Bar/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"Bar\", targets: [\"Bar\"]),\n ],\n targets: [\n .target(name: \"Bar\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Edit/Foo/Foo.swift", "content": "public func hello() {\n}\n" }, { "path": "Fixtures/Miscellaneous/Edit/Foo/Package.swift", "content": "// swift-tools-version:5.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/EmptyTestsPkg/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/EmptyTestsPkg/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"EmptyTestsPkg\",\n targets: [\n .target(\n name: \"EmptyTestsPkg\",\n dependencies: []),\n .testTarget(\n name: \"EmptyTestsPkgTests\",\n dependencies: [\"EmptyTestsPkg\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/EmptyTestsPkg/Sources/EmptyTestsPkg/EmptyTestsPkg.swift", "content": "struct EmptyTests {\n\n var text = \"Hello, World!\"\n var bool = false\n}\n" }, { "path": "Fixtures/Miscellaneous/EmptyTestsPkg/Tests/EmptyTestsPkgTests/EmptyTestsTests.swift", "content": "import XCTest\n@testable import EmptyTestsPkg\n" }, { "path": "Fixtures/Miscellaneous/Errors/FatalErrorInSingleXCTest/TypeLibrary/.gitignore", "content": ".DS_Store\n/.build\n/Packages\nxcuserdata/\nDerivedData/\n.swiftpm/configuration/registries.json\n.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata\n.netrc\n" }, { "path": "Fixtures/Miscellaneous/Errors/FatalErrorInSingleXCTest/TypeLibrary/Package.swift", "content": "// swift-tools-version:5.9\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TypeLibrary\",\n products: [\n // Products define the executables and libraries a package produces, making them visible to other packages.\n .library(\n name: \"TypeLibrary\",\n targets: [\"TypeLibrary\"]),\n ],\n targets: [\n // Targets are the basic building blocks of a package, defining a module or a test suite.\n // Targets can depend on other targets in this package and products from dependencies.\n .target(\n name: \"TypeLibrary\"),\n .testTarget(\n name: \"TypeLibraryTests\",\n dependencies: [\"TypeLibrary\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Errors/FatalErrorInSingleXCTest/TypeLibrary/Sources/TypeLibrary/TypeLibrary.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n" }, { "path": "Fixtures/Miscellaneous/Errors/FatalErrorInSingleXCTest/TypeLibrary/Tests/TypeLibraryTests/TypeLibraryTests.swift", "content": "func testExample() throws {\n let x = 0\n let y = 1 / x\n print(y)\n}\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooExec/FooExec.swift", "content": "import FooLib1\nimport FooLib2\n\npublic class FooExec {\n public var foo: FooLib1\n public var bar: FooLib2\n \n public init() {\n foo = FooLib1()\n bar = FooLib2() \n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooExec/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"FooExec\",\n products: [\n .executable(name: \"FooExec\", targets: [\"FooExec\"]),\n ],\n dependencies: [\n .package(url: \"../FooLib1\", from: \"1.0.0\"),\n .package(url: \"../FooLib2\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"FooExec\", dependencies: [\"FooLib1\", \"FooLib2\"], path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooExec/main.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooLib1/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"FooLib1\",\n products: [\n .library(name: \"FooLib1\", targets: [\"FooLib1\"]),\n .executable(name: \"cli\", targets: [\"cli\"]),\n ],\n targets: [\n .target(name: \"FooLib1\"),\n .target(name: \"cli\", dependencies: [\"FooLib1\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooLib1/Sources/FooLib1/FooLib1.swift", "content": "public class FooLib1 {\n public var foo: Int\n \n public init() {\n foo = 0\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooLib1/Sources/cli/main.swift", "content": "import FooLib1\n\nprint(FooLib1())\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooLib2/FooLib2.swift", "content": "public class FooLib2 {\n public var foo: Int\n \n public init() {\n foo = 0\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/FooLib2/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"FooLib2\",\n products: [\n .library(name: \"FooLib2\", targets: [\"FooLib2\"]),\n ],\n targets: [\n .target(name: \"FooLib2\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/app/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"28_exact_dependencies\",\n dependencies: [\n .package(url: \"../FooExec\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"28_exact_dependencies\", dependencies: [\"FooExec\"], path: \"./\"),\n ]\n)\n\n" }, { "path": "Fixtures/Miscellaneous/ExactDependencies/app/main.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/ExeTest/Package.swift", "content": "// swift-tools-version: 5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"ExeTest\",\n targets: [\n .executableTarget(\n name: \"Exe\",\n dependencies: []\n ),\n .testTarget(\n name: \"ExeTests\",\n dependencies: [\"Exe\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ExeTest/Sources/Exe/main.swift", "content": "public func GetGreeting() -> String {\n return \"Hello\"\n}\n\nprint(\"\\(GetGreeting()), world!\")\n" }, { "path": "Fixtures/Miscellaneous/ExeTest/Tests/ExeTests/ExeTests.swift", "content": "import XCTest\nimport Exe\n\nfinal class ExeTestTests: XCTestCase {\n \n func testExample() throws {\n // This is an example of a test case that tries to imports an executable target.\n XCTAssertEqual(Exe.GetGreeting(), \"Hello\")\n }\n\n static var allTests = [\n (\"testExample\", testExample),\n ]\n}\n" }, { "path": "Fixtures/Miscellaneous/ExecutableTargetWithTwoProducts/Foo.swift", "content": "@main struct Entry {\n static func main() {\n // Ensure that Bar can be referenced as a member of the module named Foo,\n // even though the executable target Foo may have been merged into the Exe1 or Exe2 products.\n let x = Foo.Bar()\n }\n}\n\nstruct Bar {}\n" }, { "path": "Fixtures/Miscellaneous/ExecutableTargetWithTwoProducts/Package.swift", "content": "// swift-tools-version:6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .executable(name: \"Exe1\", targets: [\"Foo\"]),\n .executable(name: \"Exe2\", targets: [\"Foo\"]),\n ],\n targets: [\n .executableTarget(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/FlatPackage/MyExec.swift", "content": "@main\npublic struct MyExec {\n public private(set) var text = \"Hello, World!\"\n\n public static func main() {\n print(MyExec().text)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/FlatPackage/MyTest.swift", "content": "import XCTest\n@testable import MyExec\n\nfinal class MyTest: XCTestCase {\n func testExample() throws {\n XCTAssertEqual(MyExec().text, \"Hello, World!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/FlatPackage/Package.swift", "content": "// swift-tools-version: 5.5\nimport PackageDescription\n\nlet execSrcFiles = [\"MyExec.swift\"]\nlet testSrcFiles = [\"MyTest.swift\"]\nlet variousFiles = [\"README.md\"]\n\nlet package = Package(\n name: \"FlatPackage\",\n dependencies: [\n ],\n targets: [\n .executableTarget(\n name: \"MyExec\",\n dependencies: [],\n path: \".\",\n exclude: testSrcFiles + variousFiles,\n sources: execSrcFiles\n ),\n .testTarget(\n name: \"MyTest\",\n dependencies: [\"MyExec\"],\n path: \".\",\n exclude: execSrcFiles + variousFiles,\n sources: testSrcFiles\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/FlatPackage/README.md", "content": "# FlatPackage\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/ImportOfMissingDependency/Package.swift", "content": "// swift-tools-version:5.1\nimport PackageDescription\n\nlet package = Package(\n name: \"VerificationTestPackage\",\n products: [\n .executable(name: \"BExec\", targets: [\"B\"]),\n ],\n dependencies: [\n\n ],\n targets: [\n .target(\n name: \"A\",\n dependencies: []),\n .target(\n name: \"B\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ImportOfMissingDependency/Sources/A/A.swift", "content": "import B\npublic func bar(x: Int) -> Int {\n return 11 + foo(x: x)\n}\n" }, { "path": "Fixtures/Miscellaneous/ImportOfMissingDependency/Sources/B/B.swift", "content": "public func foo(x: Int) -> Int {\n return 11 + x\n}\n" }, { "path": "Fixtures/Miscellaneous/ImportOfMissingDependency/Sources/B/main.swift", "content": "print(baz(x: 11))\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/.gitignore", "content": ".DS_Store\n/.build\n/Packages\nxcuserdata/\nDerivedData/\n.swiftpm/configuration/registries.json\n.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata\n.netrc\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftAndCTargets\",\n targets: [\n .target(name: \"cLib\"),\n .executableTarget(name: \"exe\", dependencies: [\"cLib\", \"swiftLib\"]),\n .target(name: \"swiftLib\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/Sources/cLib/cLib.c", "content": "#include \n\n#include \"include/cLib.h\"\n\nvoid cPrint(int value) {\n printf(\"c value: %i\\n\", value);\n}\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/Sources/cLib/include/cLib.h", "content": "#pragma once\n\nextern void cPrint(int);\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/Sources/exe/main.swift", "content": "import swiftLib\nimport cLib\n\ncPrint(1)\nswiftPrint(value: 2)\n" }, { "path": "Fixtures/Miscellaneous/LTO/SwiftAndCTargets/Sources/swiftLib/swiftLib.swift", "content": "public func swiftPrint(value: Int) {\n print(\"swift value: \\(value)\")\n}\n" }, { "path": "Fixtures/Miscellaneous/LibraryEvolution/Package.swift", "content": "// swift-tools-version:5.1\nimport PackageDescription\n\nlet package = Package(\n name: \"LibraryEvolution\",\n products: [\n ],\n targets: [\n .target(name: \"A\", dependencies: [], swiftSettings: [.unsafeFlags([\"-enable-library-evolution\"])]),\n .target(name: \"B\", dependencies: [\"A\"], swiftSettings: [.unsafeFlags([\"-enable-library-evolution\"])]),\n ])\n" }, { "path": "Fixtures/Miscellaneous/LibraryEvolution/Sources/A/A.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/LibraryEvolution/Sources/B/B.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/LibraryEvolutionLinuxXCF/SwiftFramework/Package.swift", "content": "// swift-tools-version:6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftFramework\",\n products: [\n .library(name: \"SwiftFramework\", type: .dynamic, targets: [\"SwiftFramework\"]),\n ],\n targets: [\n .target(\n name: \"SwiftFramework\",\n swiftSettings: [.unsafeFlags([\"-enable-library-evolution\"])]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/LibraryEvolutionLinuxXCF/SwiftFramework/Sources/SwiftFramework/SwiftFramework.swift", "content": "public enum SwiftFrameworkWithEvolution\n{\n case v1\n case v2\n\n public\n static var latest:Self { .v2 }\n}" }, { "path": "Fixtures/Miscellaneous/LibraryEvolutionLinuxXCF/TestBinary/Package.swift", "content": "// swift-tools-version:6.0\n\nimport PackageDescription\n\nlet package = Package(name: \"TestBinary\",\n products: [\n .executable(name: \"TestBinary\", targets: [\"TestBinary\"]),\n ],\n targets: [\n .binaryTarget(name: \"SwiftFramework\", path: \"SwiftFramework.xcframework\"),\n .executableTarget(name: \"TestBinary\",\n dependencies: [\n .target(name: \"SwiftFramework\"),\n ]\n ),\n ]\n)" }, { "path": "Fixtures/Miscellaneous/LibraryEvolutionLinuxXCF/TestBinary/Sources/TestBinary/Main.swift", "content": "import SwiftFramework\n\nprint(\"Latest Framework with LibraryEvolution version: \\(SwiftFrameworkWithEvolution.latest)\")" }, { "path": "Fixtures/Miscellaneous/LocalPackageAsURL/Bar/Package.swift", "content": "// swift-tools-version:5.1\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n dependencies: [\n .package(url: \"../Foo\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"Bar\", dependencies: [\"Foo\"], path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/LocalPackageAsURL/Bar/main.swift", "content": "import Foo\n\nfoo()\nprint(\"here\")\n" }, { "path": "Fixtures/Miscellaneous/LocalPackageAsURL/Foo/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/Miscellaneous/LocalPackageAsURL/Foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/MissingDependency/Bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n dependencies: [\n .package(url: \"../NonExistentPackage\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"Bar\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/MissingDependency/Bar/main.swift", "content": "import Foo\n\nfoo()\n" }, { "path": "Fixtures/Miscellaneous/MultipleExecutables/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"EchoExecutable\",\n products: [\n .executable(name: \"exec1\", targets: [\"exec1\"]),\n .executable(name: \"exec2\", targets: [\"exec2\"]),\n .library(name: \"lib1\", targets: [\"lib1\"]),\n ],\n targets: [\n .target(name: \"exec1\"),\n .target(name: \"exec2\"),\n .target(name: \"lib1\"),\n ]\n)" }, { "path": "Fixtures/Miscellaneous/MultipleExecutables/Sources/exec1/main.swift", "content": "print(\"1\")" }, { "path": "Fixtures/Miscellaneous/MultipleExecutables/Sources/exec2/main.swift", "content": "print(\"2\")" }, { "path": "Fixtures/Miscellaneous/MultipleExecutables/Sources/lib1/lib.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageEdit/bar/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/bar/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"bar\",\n products: [\n .library(name: \"bar\", targets: [\"bar\"]),\n ],\n targets: [\n .target(name: \"bar\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/bar/Sources/bar.swift", "content": "public let theValue = 5\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/baz/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/baz/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"baz\",\n products: [\n .library(name: \"baz\", targets: [\"baz\"]),\n ],\n targets: [\n .target(name: \"baz\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/baz/Sources/baz.swift", "content": "struct baz {\n\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/foo/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/foo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"foo\",\n dependencies: [\n .package(url: \"../bar\", from: \"1.0.0\"),\n .package(url: \"../baz\", from: \"1.0.0\"),\n ],\n targets: [\n .target(\n name: \"foo\",\n dependencies: [\"bar\", \"baz\"],\n path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageEdit/foo/Sources/main.swift", "content": "import bar\nprint(bar.theValue)\n" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/appPkg/Package.swift", "content": "// swift-tools-version:5.9\nimport PackageDescription\n\nlet package = Package(\n name: \"appPkg\",\n dependencies: [\n .package(url: \"../fooPkg\", from: \"1.0.0\"),\n .package(url: \"../barPkg\", from: \"1.0.0\")\n ],\n targets: [\n .executableTarget(name: \"exe\", dependencies: [\"App\"]),\n .target(name: \"App\",\n dependencies: [\n .product(name: \"Foo\", package: \"fooPkg\"),\n .product(name: \"Bar\", package: \"barPkg\"),\n ])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/appPkg/Sources/App/file.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/appPkg/Sources/exe/main.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/barPkg/Package.swift", "content": "// swift-tools-version:5.8\nimport PackageDescription\n\nlet package = Package(\n name: \"barPkg\",\n products: [\n .library(name: \"Bar\", targets: [\"Bar\"]),\n ],\n targets: [\n .target(name: \"Bar\", dependencies: [\"Baz\"]),\n .target(name: \"Baz\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/barPkg/Sources/Bar/file.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/barPkg/Sources/Baz/file.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/fooPkg/Package.swift", "content": "// swift-tools-version:5.9\nimport PackageDescription\n\nlet package = Package(\n name: \"fooPkg\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", dependencies: [\"Zoo\"]),\n .target(name: \"Zoo\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/fooPkg/Sources/Foo/file.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageNameFlag/fooPkg/Sources/Zoo/file.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PackageWithMalformedLibraryProduct/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"PackageWithMalformedLibraryProduct\",\n products: [\n .library(\n name: \"PackageWithMalformedLibraryProduct\",\n targets: [\"PackageWithMalformedLibraryProduct\"]),\n ],\n targets: [\n .executableTarget(\n name: \"PackageWithMalformedLibraryProduct\")\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageWithMalformedLibraryProduct/Sources/PackageWithMalformedLibraryProduct/main.swift", "content": "print(\"Hello World\")" }, { "path": "Fixtures/Miscellaneous/PackageWithNonc99NameModules/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"PackageWithNonc99NameModules\",\n targets: [\n .target(name: \"A-B\", dependencies: [\"B-C\"]),\n .target(name: \"B-C\", dependencies: []),\n .target(name: \"C D\", dependencies: []),\n ]\n)\n\n" }, { "path": "Fixtures/Miscellaneous/PackageWithNonc99NameModules/Sources/A-B/ab.swift", "content": "import B_C\n\nfunc ab() {\n bc()\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageWithNonc99NameModules/Sources/B-C/bc.swift", "content": "public func bc() {\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageWithNonc99NameModules/Sources/C D/cd.swift", "content": "public func bc() {\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageWithResource/Package.swift", "content": "// swift-tools-version:5.3\nimport PackageDescription\n\nlet package = Package(\n name: \"AwesomeResources\",\n targets: [\n .target(name: \"AwesomeResources\", resources: [.copy(\"hello.txt\")]),\n .testTarget(name: \"AwesomeResourcesTest\", dependencies: [\"AwesomeResources\"], resources: [.copy(\"world.txt\")])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PackageWithResource/Sources/AwesomeResources/AwesomeResource.swift", "content": "import Foundation\n\npublic struct AwesomeResource {\n public init() {}\n public let hello = try! String(contentsOf: Bundle.module.url(forResource: \"hello\", withExtension: \"txt\")!)\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageWithResource/Sources/AwesomeResources/hello.txt", "content": "hello" }, { "path": "Fixtures/Miscellaneous/PackageWithResource/Tests/AwesomeResourcesTest/MyTests.swift", "content": "import XCTest\nimport Foundation\nimport AwesomeResources\n\nfinal class MyTests: XCTestCase {\n func testFoo() {\n XCTAssertTrue(AwesomeResource().hello == \"hello\")\n }\n func testBar() {\n let world = try! String(contentsOf: Bundle.module.url(forResource: \"world\", withExtension: \"txt\")!)\n XCTAssertTrue(world == \"world\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/PackageWithResource/Tests/AwesomeResourcesTest/world.txt", "content": "world" }, { "path": "Fixtures/Miscellaneous/ParallelTestsPkg/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/ParallelTestsPkg/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ParallelTestsPkg\",\n targets: [\n .target(\n name: \"ParallelTestsPkg\",\n dependencies: []),\n .testTarget(\n name: \"ParallelTestsPkgTests\",\n dependencies: [\"ParallelTestsPkg\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ParallelTestsPkg/Sources/ParallelTestsPkg/ParallelTestsPkg.swift", "content": "struct ParallelTests {\n\n var text = \"Hello, World!\"\n var bool = false\n}\n" }, { "path": "Fixtures/Miscellaneous/ParallelTestsPkg/Tests/ParallelTestsPkgTests/ParallelTestsFailureTests.swift", "content": "import XCTest\n@testable import ParallelTestsPkg\n\nclass ParallelTestsFailureTests: XCTestCase {\n\n func testSureFailure() {\n XCTFail(\"Giving up is the only sure way to fail.\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ParallelTestsPkg/Tests/ParallelTestsPkgTests/ParallelTestsTests.swift", "content": "import XCTest\n@testable import ParallelTestsPkg\n\nclass ParallelTestsTests: XCTestCase {\n\n func testExample1() {\n XCTAssertEqual(ParallelTests().text, \"Hello, World!\")\n }\n\n func testExample2() {\n XCTAssertEqual(ParallelTests().bool, false)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ParseAsLibrary\",\n products: [],\n targets: [\n .executableTarget(name: \"ExecutableTargetOneFileNamedMainMainAttr\"),\n .executableTarget(name: \"ExecutableTargetOneFileNamedMainNoMainAttr\"),\n .executableTarget(name: \"ExecutableTargetOneFileNotNamedMainMainAttr\"),\n .executableTarget(name: \"ExecutableTargetOneFileNotNamedMainNoMainAttr\"),\n .executableTarget(name: \"ExecutableTargetTwoFiles\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetOneFileNamedMainMainAttr/main.swift", "content": "@main struct Entry {\n static func main() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetOneFileNamedMainNoMainAttr/main.swift", "content": "print(42)\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetOneFileNotNamedMainMainAttr/othername.swift", "content": "@main struct Entry {\n static func main() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetOneFileNotNamedMainNoMainAttr/othername.swift", "content": "print(42)\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetTwoFiles/one.swift", "content": "@main struct Entry {\n static func main() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/ParseAsLibrary/Sources/ExecutableTargetTwoFiles/two.swift", "content": "func foo() {}\n" }, { "path": "Fixtures/Miscellaneous/ParseableInterfaces/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ParseableInterfaces\",\n products: [\n ],\n targets: [\n .target(name: \"A\", dependencies: []),\n .target(name: \"B\", dependencies: [\"A\"]),\n ])\n" }, { "path": "Fixtures/Miscellaneous/ParseableInterfaces/Sources/A/A.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/ParseableInterfaces/Sources/B/B.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/PkgConfig/CSystemModule/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CSystemModule\",\n pkgConfig: \"libSystemModule\",\n providers: [\n .brew([\"SystemModule\"]),\n ]\n)\n\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/CSystemModule/module.modulemap", "content": "module CSystemModule {\n header \"shim.h\"\n link \"SystemModule\"\n export *\n}\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/CSystemModule/shim.h", "content": "#include \n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModule/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"SystemModule\",\n products: [\n .library(name: \"SystemModule\", targets: [\"SystemModule\"]),\n ],\n targets: [\n .target(name: \"SystemModule\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModule/Sources/SystemModule.c", "content": "int foo() {\n int a = 5;\n int b = a;\n a = b;\n return a;\n}\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModule/Sources/include/SystemModule.h", "content": "int foo();\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModuleUser/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"SystemModuleUser\",\n dependencies: [\n .package(url: \"../CSystemModule\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"SystemModuleUser\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModuleUser/Sources/main.swift", "content": "import CSystemModule\n\nprint(\"\\(foo())\")\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModuleUserClang/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"SystemModuleUserClang\",\n dependencies: [\n .package(url: \"../CSystemModule\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"SystemModuleUserClang\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PkgConfig/SystemModuleUserClang/Sources/main.c", "content": "#include \n#include \n\nint main() {\n printf(\"%d\", foo());\n return 0;\n}\n" }, { "path": "Fixtures/Miscellaneous/PluginGeneratedResources/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PluginGeneratedResources\",\n targets: [\n .executableTarget(name: \"PluginGeneratedResources\", plugins: [\"Generator\"]),\n .plugin(name: \"Generator\", capability: .buildTool()),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/PluginGeneratedResources/Plugins/Generator/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n#if os(Android)\nlet touchExe = \"/system/bin/touch\"\nlet touchArgs: [String] = []\n#elseif os(Windows)\nlet touchExe = \"C:/Windows/System32/cmd.exe\"\nlet touchArgs = [\"/c\", \"copy\", \"NUL\"]\n#else\nlet touchExe = \"/usr/bin/touch\"\nlet touchArgs: [String] = []\n#endif\n\n@main\nstruct GeneratorPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n return [\n .prebuildCommand(\n displayName: \"Generating empty file\",\n executable: .init(fileURLWithPath: touchExe),\n arguments: touchArgs + [String(cString: (context.pluginWorkDirectoryURL.appending(path: \"best.txt\") as NSURL).fileSystemRepresentation)],\n outputFilesDirectory: context.pluginWorkDirectoryURL\n )\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/PluginGeneratedResources/Sources/PluginGeneratedResources/PluginGeneratedResources.swift", "content": "import Foundation\n\n@main\npublic struct PluginGeneratedResources {\n public private(set) var text = \"Hello, World!\"\n\n public static func main() {\n let path = Bundle.module.path(forResource: \"best\", ofType: \"txt\")\n let exists = FileManager.default.fileExists(atPath: path!)\n assert(exists, \"generated file is missing\")\n print(PluginGeneratedResources().text)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Dependencies/A/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"A\",\n products: [\n .plugin(\n name: \"A\",\n targets: [\"A\"]),\n ],\n targets: [\n .plugin(\n name: \"A\",\n capability: .command(intent: .custom(\n verb: \"A\",\n description: \"prints hello\"\n ))\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Dependencies/A/Plugins/A.swift", "content": "import PackagePlugin\n\n@main\nstruct A: CommandPlugin {\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n print(\"Hello A!\")\n }\n}\n\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Dependencies/B/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"B\",\n products: [\n .plugin(\n name: \"B\",\n targets: [\"B\"]),\n ],\n targets: [\n .plugin(\n name: \"B\",\n capability: .command(intent: .custom(\n verb: \"A\",\n description: \"prints hello\"\n ))\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Dependencies/B/Plugins/B.swift", "content": "import PackagePlugin\n\n@main\nstruct B: CommandPlugin {\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n print(\"Hello B!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"AmbiguousCommands\",\n dependencies: [\n .package(path: \"Dependencies/A\"),\n .package(path: \"Dependencies/B\"),\n ],\n targets: [\n .executableTarget(\n name: \"AmbiguousCommands\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/AmbiguousCommands/Sources/main.swift", "content": "print(\"Hello, world!\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Dependency/MyBinaryTargetExeArtifactBundle.artifactbundle/info.json", "content": "{\n \"schemaVersion\": \"1.0\",\n \"artifacts\": {\n \"mytool\": {\n \"type\": \"executable\",\n \"version\": \"1.2.3\",\n \"variants\": [\n {\n \"path\": \"mytool-macos/mytool\",\n \"supportedTriples\": [\"x86_64-apple-macosx\", \"arm64-apple-macosx\"]\n },\n {\n \"path\": \"mytool-linux/mytool\",\n \"supportedTriples\": [\"x86_64-unknown-linux-gnu\", \"aarch64-unknown-linux-gnu\"]\n }\n ]\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Dependency/MyBinaryTargetExeArtifactBundle.artifactbundle/mytool-linux/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-linux] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Dependency/MyBinaryTargetExeArtifactBundle.artifactbundle/mytool-macos/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-macosx] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyBinaryTargetExePlugin\",\n\n products: [\n .executable(\n name: \"MyPluginExe\",\n targets: [\"MyPluginExe\"]\n ),\n .plugin(\n name: \"MyPlugin\",\n targets: [\"MyPlugin\"]\n ),\n .executable(\n name: \"MyBinaryTargetExe\",\n targets: [\"MyBinaryTargetExeArtifactBundle\"]\n ),\n ],\n targets: [\n .executableTarget(\n name: \"MyPluginExe\",\n dependencies: [],\n exclude: [],\n ),\n\n .plugin(\n name: \"MyPlugin\",\n capability: .buildTool(),\n dependencies: [\"MyPluginExe\", \"MyBinaryTargetExeArtifactBundle\"]\n ),\n .binaryTarget(\n name: \"MyBinaryTargetExeArtifactBundle\",\n path: \"Dependency/MyBinaryTargetExeArtifactBundle.artifactbundle\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n \n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from MyPlugin!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryTargetExePlugin/Sources/MyPluginExe/main.swift", "content": "print(\"It's Me MyPluginExe\\n\")" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Dependency/Binaries/MyVendedSourceGenBuildTool.artifactbundle/info.json", "content": "{\n \"schemaVersion\": \"1.0\",\n \"artifacts\": {\n \"mytool\": {\n \"type\": \"executable\",\n \"version\": \"1.2.3\",\n \"variants\": [\n {\n \"path\": \"mytool-macos/mytool\",\n \"supportedTriples\": [\"x86_64-apple-macosx\", \"arm64-apple-macosx\"]\n },\n {\n \"path\": \"mytool-linux/mytool\",\n \"supportedTriples\": [\"x86_64-unknown-linux-gnu\", \"aarch64-unknown-linux-gnu\"]\n }\n ]\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Dependency/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-linux/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-linux] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Dependency/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-macos/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-macosx] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Dependency/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyBinaryProduct\",\n products: [\n .executable(\n name: \"MyVendedSourceGenBuildTool\",\n targets: [\"MyVendedSourceGenBuildTool\"]\n ), \n ],\n targets: [\n .binaryTarget(\n name: \"MyVendedSourceGenBuildTool\",\n path: \"Binaries/MyVendedSourceGenBuildTool.artifactbundle\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MyBinaryToolPlugin\",\n dependencies: [\n .package(path: \"Dependency\"),\n ],\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n .product(name: \"MyVendedSourceGenBuildTool\", package: \"Dependency\"),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n let inputFiles = target.sourceFiles.filter({ $0.url.pathExtension == \"dat\" })\n return try inputFiles.map {\n let inputPath = $0.url\n let outputName = inputPath.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(inputPath.lastPathComponent)\",\n executable:\n try context.tool(named: \"mytool\").url,\n arguments: [\n \"--verbose\",\n inputPath.path,\n outputPath.path,\n ],\n inputFiles: [\n inputPath,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BinaryToolProductPlugin/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BuildToolPluginCompilationError/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\nlet package = Package(\n name: \"MyPackage\",\n targets: [\n .target(\n name: \"MyLibrary\",\n plugins: [\n \"MyPlugin\",\n ]\n ),\n .plugin(\n name: \"MyPlugin\",\n capability: .buildTool()\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BuildToolPluginCompilationError/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n@main\nstruct MyBuildToolPlugin: BuildToolPlugin {\n func createBuildCommands(\n context: PluginContext,\n target: Target\n ) throws -> [Command] {\n print(\"This is text from the plugin\")\n throw \"This is an error from the plugin\"\n return []\n }\n\n}\nextension String : Error {}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/BuildToolPluginCompilationError/Sources/MyLibrary/library.swift", "content": "public func Foo() { }\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ClientOfPluginWithInternalExecutable/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"ClientOfPluginWithInternalExecutable\",\n dependencies: [\n .package(path: \"../PluginWithInternalExecutable\")\n ],\n targets: [\n .executableTarget(\n name: \"RootTarget\",\n plugins: [\n .plugin(name: \"PluginScriptProduct\", package: \"PluginWithInternalExecutable\")\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ClientOfPluginWithInternalExecutable/Sources/RootTarget/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginCompilationError/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\nlet package = Package(\n name: \"MyPackage\",\n products: [\n .library(\n name: \"MyLibrary\",\n targets: [\"MyLibrary\"]\n ),\n .executable(\n name: \"MyExecutable\",\n targets: [\"MyExecutable\"]\n ),\n ],\n targets: [\n .target(\n name: \"MyLibrary\"\n ),\n .executableTarget(\n name: \"MyExecutable\",\n dependencies: [\"MyLibrary\"]\n ),\n .plugin(\n name: \"MyBuildToolPlugin\",\n capability: .buildTool()\n ),\n .plugin(\n name: \"MyCommandPlugin\",\n capability: .command(\n intent: .custom(verb: \"my-build-tester\", description: \"Help description\")\n )\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginCompilationError/Plugins/MyBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\n@main struct MyBuildToolPlugin: BuildToolPlugin {\n func createBuildCommands(\n context: PluginContext,\n target: Target\n ) throws -> [Command] {\n return []\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginCompilationError/Plugins/MyCommandPlugin/plugin.swift", "content": "import PackagePlugin\n@main struct MyCommandPlugin: CommandPlugin {\n func performCommand(\n context: PluginContext,\n arguments: [String]\n ) throws {\n this is an error\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginCompilationError/Sources/MyExecutable/main.swift", "content": "import MyLibrary\nprint(\"\\\\(GetGreeting()), World!\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginCompilationError/Sources/MyLibrary/library.swift", "content": "public func GetGreeting() -> String { return \"Hello\" }\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CommandPluginDiagnostics\",\n targets: [\n .plugin(\n name: \"diagnostics-stub\",\n capability: .command(intent: .custom(\n verb: \"print-diagnostics\",\n description: \"Writes diagnostic messages for testing\"\n ))\n ),\n .plugin(\n name: \"targetbuild-stub\",\n capability: .command(intent: .custom(\n verb: \"build-target\",\n description: \"Build a target for testing\"\n ))\n ),\n .plugin(\n name: \"plugin-dependencies-stub\",\n capability: .command(intent: .custom(\n verb: \"build-plugin-dependency\",\n description: \"Build a plugin dependency for testing\"\n )),\n dependencies: [\n .target(name: \"plugintool\")\n ]\n ),\n .plugin(\n name: \"check-testability\",\n capability: .command(intent: .custom(\n verb: \"check-testability\",\n description: \"Check testability of a target\"\n ))\n ),\n .executableTarget(\n name: \"placeholder\"\n ),\n .executableTarget(\n name: \"plugintool\"\n ),\n .target(\n name: \"InternalModule\"\n ),\n .testTarget(\n name: \"InternalModuleTests\",\n dependencies: [\n .target(name: \"InternalModule\")\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Plugins/check-testability/main.swift", "content": "import Foundation\nimport PackagePlugin\n\n@main\nstruct CheckTestability: CommandPlugin {\n // This is a helper for testing target builds to ensure that they are testable.\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n // Parse the arguments: \n guard arguments.count == 3 else {\n fatalError(\"Usage: \")\n }\n let rawSubsetName = arguments[0]\n var subset: PackageManager.BuildSubset\n switch rawSubsetName {\n // Special subset names\n case \"all-with-tests\":\n subset = .all(includingTests: true)\n // By default, treat the subset as a target name\n default:\n subset = .target(rawSubsetName)\n }\n guard let config = PackageManager.BuildConfiguration(rawValue: arguments[1]) else {\n fatalError(\"Invalid configuration: \\(arguments[1])\")\n }\n let shouldTestable = arguments[2] == \"true\"\n\n var parameters = PackageManager.BuildParameters()\n parameters.configuration = config\n parameters.logging = .verbose\n\n // Perform the build\n let result = try packageManager.build(subset, parameters: parameters)\n\n // Check if the build was successful\n guard result.succeeded else {\n fatalError(\"Build failed: \\(result.logText)\")\n }\n\n // Check if the build log contains \"-enable-testing\" flag\n let isTestable = result.logText.contains(\"-enable-testing\")\n if isTestable != shouldTestable {\n fatalError(\"Testability mismatch: expected \\(shouldTestable), but got \\(isTestable):\\n\\(result.logText)\")\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Plugins/diagnostics-stub/diagnostics_stub.swift", "content": "import Foundation\nimport PackagePlugin\n\n@main\nstruct diagnostics_stub: CommandPlugin {\n // This is a helper for testing plugin diagnostics. It sends different messages to SwiftPM depending on its arguments.\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n // Build a target, possibly asking SwiftPM to echo the logs as they are produced.\n if arguments.contains(\"build\") {\n // If echoLogs is true, SwiftPM will print build logs to stderr as they are produced.\n // SwiftPM does not add a prefix to these logs.\n let result = try packageManager.build(\n .product(\"placeholder\"),\n parameters: .init(echoLogs: arguments.contains(\"echologs\"))\n )\n\n // To verify that logs are also returned correctly to the plugin,\n // print the accumulated log buffer lines with a prefix to\n // distinguish them from echoed logs. These logs are normal output\n // from the plugin and will be printed on stdout.\n if arguments.contains(\"printlogs\") {\n for line in result.logText.components(separatedBy: \"\\n\") {\n print(\"command plugin: packageManager.build logtext: \\(line)\")\n }\n }\n }\n\n // Anything a plugin writes to standard output appears on standard output.\n // Printing to stderr will also go to standard output because SwiftPM combines\n // stdout and stderr before launching the plugin.\n if arguments.contains(\"print\") {\n print(\"command plugin: print\")\n }\n\n // Diagnostics are collected by SwiftPM and printed to standard error, depending on the current log verbosity level.\n if arguments.contains(\"progress\") {\n Diagnostics.progress(\"command plugin: Diagnostics.progress\") // prefixed with [plugin_name]\n }\n\n if arguments.contains(\"remark\") {\n Diagnostics.remark(\"command plugin: Diagnostics.remark\") // prefixed with 'info:' when printed\n }\n\n if arguments.contains(\"warning\") {\n Diagnostics.warning(\"command plugin: Diagnostics.warning\") // prefixed with 'warning:' when printed\n }\n\n if arguments.contains(\"error\") {\n Diagnostics.error(\"command plugin: Diagnostics.error\") // prefixed with 'error:' when printed\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Plugins/plugin-dependencies-stub/main.swift", "content": "import PackagePlugin\n\n@main\nstruct test: CommandPlugin {\n // This plugin exists to test that the executable it requires is built correctly when cross-compiling\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n print(\"Hello from dependencies-stub\")\n let _ = try packageManager.build(\n .product(\"placeholder\"),\n parameters: .init(configuration: .debug, logging: .concise)\n )\n }\n}" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Plugins/targetbuild-stub/targetbuild_stub.swift", "content": "import Foundation\nimport PackagePlugin\n\n@main\nstruct targetbuild_stub: CommandPlugin {\n // This is a helper for testing target builds performed on behalf of plugins.\n // It sends asks SwiftPM to build a target with different options depending on its arguments.\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n // Build a target\n var parameters = PackageManager.BuildParameters()\n if arguments.contains(\"build-debug\") {\n parameters.configuration = .debug\n } else if arguments.contains(\"build-release\") {\n parameters.configuration = .release\n } else if arguments.contains(\"build-inherit\") {\n parameters.configuration = .inherit\n }\n // If no 'build-*' argument is present, the default (.debug) will be used.\n\n let _ = try packageManager.build(\n .product(\"placeholder\"),\n parameters: parameters\n )\n }\n}" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Sources/InternalModule/InternalModule.swift", "content": "internal func internalFunction() {\n print(\"Internal function\")\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Sources/placeholder/main.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\nprint(\"Hello, world from executable target!\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Sources/plugintool/main.swift", "content": "print(\"Hello from plugintool\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/CommandPluginTestStub/Tests/InternalModuleTests/InternalModuleTests.swift", "content": "@testable import InternalModule\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"ContrivedTestPlugin\",\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n \"MyAmbiguouslyNamedCommandPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // The command line tool that generates source files.\n .executableTarget(\n name: \"MySourceGenBuildTool\"\n ),\n // Plugin that emits commands with a generic name.\n .plugin(\n name: \"MyAmbiguouslyNamedCommandPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // Sample system library target for testing.\n .systemLibrary(\n name: \"libpcre\",\n path: \"Sources/libpcre\",\n pkgConfig: \"libpcre\",\n providers: [\n .apt([\"libpcre-dev\"])\n ]\n )\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Plugins/MyAmbiguouslyNamedCommandPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n guard let target = target as? SourceModuleTarget else { return [] }\n var commands: [Command] = []\n for inputFile in target.sourceFiles.filter({ $0.url.pathExtension == \"dat\" }) {\n let inputPath = inputFile.url\n let outputName = \"Ambiguous_\" + inputPath.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n commands.append(.buildCommand(\n displayName:\n \"This is a constant name\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n inputPath.path,\n outputPath.path,\n ],\n environment: [\n \"VARIABLE_NAME_PREFIX\": \"SECOND_PREFIX_\"\n ],\n inputFiles: [\n inputPath,\n ],\n outputFiles: [\n outputPath\n ]\n ))\n }\n return commands\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n guard let target = target as? SourceModuleTarget else { return [] }\n let inputFiles = target.sourceFiles.filter({ $0.url.pathExtension == \"dat\" })\n return try inputFiles.map {\n let inputPath = $0.url\n let outputName = inputPath.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(inputPath.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n inputPath.path,\n outputPath.path,\n ],\n environment: [\n \"VARIABLE_NAME_PREFIX\": \"PREFIX_\"\n ],\n inputFiles: [\n inputPath,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(PREFIX_foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Sources/MySourceGenBuildTool/main.swift", "content": "import Foundation\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file, with the value from an environment value prepended. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variablePrefix = ProcessInfo.processInfo.environment[\"VARIABLE_NAME_PREFIX\"] ?? \"\"\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public var \\(variablePrefix)\\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n\nextension String {\n \n public var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Sources/libpcre/module.modulemap", "content": "module readline [system] {\n header \"sdk_libpcre.h\"\n link \"libpcre\"\n export *\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/ContrivedTestPlugin/Sources/libpcre/sdk_libpcre.h", "content": "#include \n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"DependentPlugins\",\n platforms: [ .macOS(.v13) ],\n dependencies: [\n ],\n targets: [\n .executableTarget(name: \"MyExecutable\"),\n .executableTarget(name: \"MyExecutable2\"),\n\n .plugin(\n name: \"MyPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MyExecutable\"\n ]\n ),\n\n .plugin(\n name: \"MyPlugin2\",\n capability: .buildTool(),\n dependencies: [\n \"MyExecutable2\"\n ]\n ),\n\n .executableTarget(\n name: \"MyClient\",\n plugins: [\n \"MyPlugin\",\n \"MyPlugin2\",\n ]\n ),\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n let outputFilePath = context.pluginWorkDirectoryURL.appendingPathComponent(\"MyGeneratedFile.swift\")\n return [\n .buildCommand(\n displayName: \"Running MyExecutable\",\n executable: try context.tool(named: \"MyExecutable\").url,\n arguments: [\"--output-file-path\", outputFilePath.path],\n outputFiles: [outputFilePath]\n )\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Plugins/MyPlugin2/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n guard let sourceTarget = target as? SourceModuleTarget else {\n throw \"Target is not a source target, cannot get a file list\"\n }\n guard let inputFilePath = sourceTarget.pluginGeneratedSources.first(where: { $0.lastPathComponent == \"MyGeneratedFile.swift\" }) else {\n throw \"Cannot find MyGeneratedFile.swift, files: \\(sourceTarget.pluginGeneratedSources), target: \\(target)\"\n }\n return [\n .buildCommand(\n displayName: \"Running MyExecutable2\",\n executable: try context.tool(named: \"MyExecutable2\").url,\n arguments: [\"--input-file-path\", inputFilePath.path],\n inputFiles: [inputFilePath],\n )\n ]\n }\n}\n\nextension String: Error, LocalizedError {\n public var errorDescription: String? {\n self\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Sources/MyClient/client.swift", "content": "@main\nstruct Client {\n static func main() throws {\n print(MyGeneratedStruct.message)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Sources/MyExecutable/tool.swift", "content": "import Foundation\n\n@main\nstruct Tool {\n static func main() async throws {\n print(\"warning: Whoops! Coming from the executable\", to: &StdErr.shared)\n \n let path = CommandLine.arguments[2]\n print(\"Writing a file to \\(path)\")\n \n try #\"\"\"\n public struct MyGeneratedStruct {\n public static var message: String = \"You got struct'd\"\n }\n \"\"\"#.write(to: URL(fileURLWithPath: path), atomically: true, encoding: .utf8)\n }\n}\n\nstruct StdErr: TextOutputStream {\n static var shared: Self = .init()\n mutating func write(_ string: String) {\n string.withCString { ptr in\n _ = fputs(ptr, stderr)\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/DependentPlugins/Sources/MyExecutable2/tool.swift", "content": "import Foundation\n\n@main\nstruct Tool {\n static func main() async throws {\n let path = CommandLine.arguments[2]\n print(\"Printing file at \\(path)\")\n print(try String(contentsOfFile: path))\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Package.swift", "content": "// swift-tools-version:6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"111920845-sample\",\n platforms: [\n .macOS(.v10_15), // example uses swift concurrency which is only available in 10.15 or newer\n ],\n products: [\n .executable(name: \"MyPluginExecutable\", targets: [\"MyPluginExecutable\"]),\n .plugin(name: \"MyPlugin\", targets: [\"MyPlugin\"]),\n ],\n targets: [\n .executableTarget(name: \"MyPluginExecutable\"),\n .plugin(name: \"MyPlugin\", capability: .buildTool, dependencies: [\"MyPluginExecutable\"]),\n\n .target(name: \"MyLibrary\", plugins: [\"MyPlugin\"]),\n .executableTarget(name: \"MyExecutable\", dependencies: [\"MyLibrary\"]),\n .testTarget(name: \"MyExecutableTests\", dependencies: [\"MyExecutable\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Plugins/MyPlugin/MyPlugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n return [.buildCommand(\n displayName: \"Running MyPluginExecutable\",\n executable: try context.tool(named: \"MyPluginExecutable\").url,\n arguments: [],\n environment: [:],\n inputFiles: [],\n outputFiles: []\n )]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Sources/MyExecutable/MyExecutable.swift", "content": "import MyLibrary\n\n@main\nstruct MyExecutable {\n static func main() async throws {\n print(\"Hello from executable.\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Sources/MyLibrary/Empty.swift", "content": "\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Sources/MyPluginExecutable/MyPluginExecutable.swift", "content": "@main\nstruct MyExecutable {\n static func main() async throws {\n print(\"Hello from plugin executable.\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/IncorrectDependencies/Tests/MyExecutableTests/MyExecutableTests.swift", "content": "import XCTest\n@testable import MyExecutable\n\nfinal class MyExecutableTests: XCTestCase {\n func test() throws {\n XCTAssertTrue(true)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/InvalidUseOfInternalPluginExecutable/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"InvalidUseOfInternalPluginExecutable\",\n dependencies: [\n .package(path: \"../PluginWithInternalExecutable\")\n ],\n targets: [\n .executableTarget(\n name: \"RootTarget\",\n dependencies: [\n .product(name: \"PluginExecutable\", package: \"PluginWithInternalExecutable\")\n ],\n plugins: [\n .plugin(name: \"PluginScriptProduct\", package: \"PluginWithInternalExecutable\")\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/InvalidUseOfInternalPluginExecutable/Sources/RootTarget/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/LibraryWithLocalBuildToolPluginUsingRemoteTool/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MyLibrary\",\n dependencies: [\n .package(path: \"../MySourceGenPlugin\")\n ],\n targets: [\n .plugin(\n name: \"MyLocalSourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n .product(name: \"MySourceGenBuildTool\", package: \"MySourceGenPlugin\")\n ]\n ),\n .target(\n name: \"MyLibrary\",\n plugins: [\n \"MyLocalSourceGenBuildToolPlugin\",\n ]\n ),\n .testTarget(\n name: \"MyLibraryTests\",\n dependencies: [\"MyLibrary\"]\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/LibraryWithLocalBuildToolPluginUsingRemoteTool/Plugins/MyLocalSourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n return try target.sourceFiles.map{ $0.url }.compactMap { (url: URL) -> Command? in\n guard url.pathExtension == \"dat\" else { return nil }\n let outputName = url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(url.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n url.path,\n outputPath.path,\n ],\n inputFiles: [\n url,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/LibraryWithLocalBuildToolPluginUsingRemoteTool/Sources/MyLibrary/library.swift", "content": "public func GetGeneratedString() -> String {\n return \"Generated string: \\(generated)\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/LibraryWithLocalBuildToolPluginUsingRemoteTool/Tests/MyLibraryTests/test.swift", "content": "import XCTest\nimport MyLibrary\n\nfinal class MyLibraryTests: XCTestCase {\n \n func testLibrary() throws {\n XCTAssertEqual(GetGeneratedString(), \"Generated string: 4920616d20466f6f210a\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MissingPlugin/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"MissingPlugin\",\n targets: [\n .target(name: \"MissingPlugin\", plugins: [\"NonExistingPlugin\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MissingPlugin/Sources/MissingPlugin/MissingPlugin.swift", "content": "public struct MissingPlugin {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/info.json", "content": "{\n \"schemaVersion\": \"1.0\",\n \"artifacts\": {\n \"mytool\": {\n \"type\": \"executable\",\n \"version\": \"1.2.3\",\n \"variants\": [\n {\n \"path\": \"mytool-macos/mytool\",\n \"supportedTriples\": [\"x86_64-apple-macosx\", \"arm64-apple-macosx\"]\n },\n {\n \"path\": \"mytool-linux/mytool\",\n \"supportedTriples\": [\"x86_64-unknown-linux-gnu\", \"aarch64-unknown-linux-gnu\"]\n },\n {\n \"path\": \"mytool-windows/mytool.bat\",\n \"supportedTriples\": [\"x86_64-unknown-windows-msvc\", \"aarch64-unknown-windows-msvc\"]\n }\n ]\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-linux/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-linux] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-macos/mytool", "content": "#!/bin/bash\n\nprint_usage() {\n echo \"usage: ${0##*/} [--verbose] \"\n}\n\n# Parse arguments until we find '--' or an argument that isn't an option.\nuntil [ $# -eq 0 ]\ndo\n case \"$1\" in\n --verbose) verbose=1; shift;;\n --) shift; break;;\n -*) echo \"unknown option: ${1}\"; print_usage; exit 1; shift;;\n *) break;;\n esac\ndone\n\n# Print usage and leave if we don't have exactly two arguments.\nif [ $# -ne 2 ]; then\n print_usage\n exit 1\nfi\n\n# For our sample tool we just copy from one to the other.\nif [ $verbose != 0 ]; then\n echo \"[${0##*/}-macosx] '$1' '$2'\"\nfi\n\ncp \"$1\" \"$2\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Binaries/MyVendedSourceGenBuildTool.artifactbundle/mytool-windows/mytool.bat", "content": "@echo off\n\nset verbose=false\nIF NOT \"%1\"==\"\" (\n IF \"%1\"==\"--verbose\" (\n SET verbose=true\n SHIFT\n )\n)\n\nset input=%1\nset output=%2\nshift\nshift\n\n\nif \"%verbose%\" == \"true\" (\n echo \"[mytool-windows] '%input%' '%output%'\"\n)\n@echo on\necho f | xcopy.exe /f \"%input%\" \"%output%\"" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Package.swift", "content": "// swift-tools-version: 6.1\nimport PackageDescription\n\nlet package = Package(\n name: \"MyBinaryToolPlugin\",\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MyVendedSourceGenBuildTool\",\n ]\n ),\n // The vended executable that generates source files.\n .binaryTarget(\n name: \"MyVendedSourceGenBuildTool\",\n path: \"Binaries/MyVendedSourceGenBuildTool.artifactbundle\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n let inputFiles = target.sourceFiles.filter({ $0.url.pathExtension == \"dat\" })\n let workDir = context.pluginWorkDirectoryURL\n\n return try inputFiles.map {\n let inputFile = $0\n let inputPath = $0.url\n let outputName = inputPath.deletingPathExtension().appendingPathExtension(\"swift\")\n .lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(inputPath.lastPathComponent)\",\n executable:\n try context.tool(named: \"mytool\").url,\n arguments: [\n \"--verbose\",\n inputPath.path,\n outputPath.path,\n ],\n inputFiles: [\n inputPath\n ],\n outputFiles: [\n outputPath\n ]\n )\n } + [\n .prebuildCommand(\n displayName:\n \"Generating files in \\(workDir.path)\",\n executable:\n try context.tool(named: \"mytool\").url,\n arguments: [\n \"--verbose\",\n target.directoryURL.appendingPathComponent(\"bar.in\").path,\n workDir.appendingPathComponent(\"bar.swift\").path,\n ],\n outputFilesDirectory: workDir\n )\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Sources/MyLocalTool/bar.in", "content": "let bar = \"I am Bar!\"\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBinaryToolPlugin/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\nprint(\"Generated string Bar: '\\(bar)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MyBuildToolPluginDependencies\",\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // A command line tool that generates source files.\n .executableTarget(\n name: \"MySourceGenBuildTool\",\n dependencies: [\n \"MySourceGenBuildToolLib\",\n ]\n ),\n // A library used by MySourceGenBuildTool (not the client).\n .target(\n name: \"MySourceGenBuildToolLib\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n // Create build commands that don't invoke the MySourceGenBuildTool source generator\n // tool directly, but instead invoke a system tool that invokes it indirectly. We\n // want to test that we still end up with a dependency on not only that tool but also\n // on the library it depends on, even without including an explicit dependency on it.\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n let inputFiles = target.sourceFiles.filter({ $0.url.pathExtension == \"dat\" })\n return try inputFiles.map {\n let inputPath = $0.url\n let outputName = inputPath.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(inputPath.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n inputPath.path,\n outputPath.path,\n ],\n inputFiles: [\n inputPath,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Sources/MySourceGenBuildTool/main.swift", "content": "import Foundation\nimport MySourceGenBuildToolLib\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public let \\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MyBuildToolPluginDependencies/Sources/MySourceGenBuildToolLib/library.swift", "content": "import Foundation\n\nextension String {\n \n public var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenClient/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MySourceGenClient\",\n dependencies: [\n .package(path: \"../MySourceGenPlugin\")\n ],\n targets: [\n // A tool that uses a plugin.\n .executableTarget(\n name: \"MyTool\",\n plugins: [\n .plugin(name: \"MySourceGenBuildToolPlugin\", package: \"MySourceGenPlugin\")\n ]\n ),\n // A unit test that uses the plugin.\n .testTarget(\n name: \"MyTests\",\n plugins: [\n .plugin(name: \"MySourceGenBuildToolPlugin\", package: \"MySourceGenPlugin\")\n ]\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenClient/Sources/MyTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenClient/Tests/MyTests/MyTests.swift", "content": "import XCTest\nimport class Foundation.Bundle\n\nfinal class SwiftyProtobufTests: XCTestCase {\n func testExample() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n // Mac Catalyst won't have `Process`, but it is supported for executables.\n #if !targetEnvironment(macCatalyst)\n\n let fooBinary = productsDirectory.appendingPathComponent(\"MySourceGenTool\")\n\n let process = Process()\n process.executableURL = fooBinary\n\n let pipe = Pipe()\n process.standardOutput = pipe\n\n try process.run()\n process.waitUntilExit()\n\n let data = pipe.fileHandleForReading.readDataToEndOfFile()\n let output = String(data: data, encoding: .utf8)\n\n XCTAssertEqual(output, \"Hello, world!\\n\")\n #endif\n }\n\n /// Returns path to the built products directory.\n var productsDirectory: URL {\n #if os(macOS)\n for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(\".xctest\") {\n return bundle.bundleURL.deletingLastPathComponent()\n }\n fatalError(\"couldn't find the products directory\")\n #else\n return Bundle.main.bundleURL\n #endif\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MySourceGenPlugin\",\n products: [\n // The product that vends MySourceGenBuildToolPlugin to client packages.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n targets: [\"MySourceGenBuildToolPlugin\"]\n ),\n // The product that vends the MySourceGenBuildTool executable to client packages.\n .executable(\n name: \"MySourceGenBuildTool\",\n targets: [\"MySourceGenBuildTool\"]\n ),\n // The product that vends MySourceGenPrebuildPlugin to client packages.\n .plugin(\n name: \"MySourceGenPrebuildPlugin\",\n targets: [\"MySourceGenPrebuildPlugin\"]\n ),\n ],\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // A local tool that uses a prebuild plugin.\n .executableTarget(\n name: \"MyOtherLocalTool\",\n plugins: [\n \"MySourceGenPrebuildPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // The plugin that generates prebuild commands (currently to invoke a system tool).\n .plugin(\n name: \"MySourceGenPrebuildPlugin\",\n capability: .buildTool()\n ),\n // The command line tool that generates source files.\n .executableTarget(\n name: \"MySourceGenBuildTool\",\n dependencies: [\n \"MySourceGenBuildToolLib\",\n ]\n ),\n // A library used by MySourceGenBuildTool (not the client).\n .target(\n name: \"MySourceGenBuildToolLib\"\n ),\n // A runtime library that the client needs to link against.\n .target(\n name: \"MySourceGenRuntimeLib\"\n ),\n // Unit tests for the plugin.\n .testTarget(\n name: \"MySourceGenPluginTests\",\n dependencies: [\n \"MySourceGenRuntimeLib\",\n ],\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n \"MySourceGenPrebuildPlugin\",\n ]\n )\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n #if USE_CREATE\n let verb = \"Creating\"\n #else\n let verb = \"Generating\"\n #endif\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n return try target.sourceFiles.map { $0.url }.compactMap { (url: URL) -> Command? in\n guard url.pathExtension == \"dat\" else { return nil }\n let outputName = url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName: \"\\(verb) \\(outputName) from \\(url.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n url.path,\n outputPath.path\n ],\n inputFiles: [\n url,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Plugins/MySourceGenPrebuildPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n#if os(Android)\nlet touchExe = \"/system/bin/touch\"\nlet touchArgs: [String] = []\n#elseif os(Windows)\nlet touchExe = \"C:/Windows/System32/cmd.exe\"\nlet touchArgs = [\"/c\", \"copy\", \"NUL\"]\n#else\nlet touchExe = \"/usr/bin/touch\"\nlet touchArgs: [String] = []\n#endif\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Prebuild Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n let outputPaths: [URL] = target.sourceFiles.filter{ $0.url.pathExtension == \"dat\" }.map { file in\n context.pluginWorkDirectoryURL.appendingPathComponent(file.url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent)\n }\n var commands: [Command] = []\n let paths = outputPaths.map{ $0.path }\n#if os(Windows)\n let args = [\"/c\", \"FOR %F IN (\" + paths.joined(separator: \" \") + \") DO TYPE NUL > %F\"]\n#else\n let args = paths\n#endif\n if !outputPaths.isEmpty {\n commands.append(.prebuildCommand(\n displayName:\n \"Running prebuild command for target \\(target.name)\",\n executable:\n .init(fileURLWithPath: touchExe),\n arguments:\n args,\n outputFilesDirectory:\n context.pluginWorkDirectoryURL\n ))\n }\n return commands\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MyOtherLocalTool/main.swift", "content": "// print(\"Generated string Bar: '\\(bar)'\")\n// print(\"Generated string Baz: '\\(baz)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenBuildTool/main.swift", "content": "import Foundation\nimport MySourceGenBuildToolLib\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public let \\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenBuildToolLib/library.swift", "content": "import Foundation\n\nextension String {\n \n public var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Sources/MySourceGenRuntimeLib/library.swift", "content": "public func GetLibraryName() -> String {\n return \"MySourceGenRuntimeLib\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPlugin/Tests/MySourceGenPluginTests/MySourceGenPluginTests.swift", "content": "import XCTest\nimport class Foundation.Bundle\n\nfinal class SwiftyProtobufTests: XCTestCase {\n func testExample() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n // Mac Catalyst won't have `Process`, but it is supported for executables.\n #if !targetEnvironment(macCatalyst)\n\n let fooBinary = productsDirectory.appendingPathComponent(\"MySourceGenTool\")\n\n let process = Process()\n process.executableURL = fooBinary\n\n let pipe = Pipe()\n process.standardOutput = pipe\n\n try process.run()\n process.waitUntilExit()\n\n let data = pipe.fileHandleForReading.readDataToEndOfFile()\n let output = String(data: data, encoding: .utf8)\n\n XCTAssertEqual(output, \"Hello, world!\\n\")\n #endif\n }\n\n /// Returns path to the built products directory.\n var productsDirectory: URL {\n #if os(macOS)\n for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(\".xctest\") {\n return bundle.bundleURL.deletingLastPathComponent()\n }\n fatalError(\"couldn't find the products directory\")\n #else\n return Bundle.main.bundleURL\n #endif\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MySourceGenPluginNoPreBuildCommands\",\n products: [\n // The product that vends MySourceGenBuildToolPlugin to client packages.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n targets: [\"MySourceGenBuildToolPlugin\"]\n ),\n // The product that vends the MySourceGenBuildTool executable to client packages.\n .executable(\n name: \"MySourceGenBuildTool\",\n targets: [\"MySourceGenBuildTool\"]\n ),\n ],\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // A local tool that uses a prebuild plugin.\n .executableTarget(\n name: \"MyOtherLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // The command line tool that generates source files.\n .executableTarget(\n name: \"MySourceGenBuildTool\",\n dependencies: [\n \"MySourceGenBuildToolLib\",\n ]\n ),\n // A library used by MySourceGenBuildTool (not the client).\n .target(\n name: \"MySourceGenBuildToolLib\"\n ),\n // A runtime library that the client needs to link against.\n .target(\n name: \"MySourceGenRuntimeLib\"\n ),\n // Unit tests for the plugin.\n .testTarget(\n name: \"MySourceGenPluginTests\",\n dependencies: [\n \"MySourceGenRuntimeLib\",\n ],\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n )\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n #if USE_CREATE\n let verb = \"Creating\"\n #else\n let verb = \"Generating\"\n #endif\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n return try target.sourceFiles.map{ $0.url }.compactMap { (url: URL) -> Command? in\n guard url.pathExtension == \"dat\" else { return nil }\n let outputName = url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"\\(verb) \\(outputName) from \\(url.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n url.path,\n outputPath.path,\n ],\n inputFiles: [\n url,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Sources/MyOtherLocalTool/main.swift", "content": "// print(\"Generated string Bar: '\\(bar)'\")\n// print(\"Generated string Baz: '\\(baz)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Sources/MySourceGenBuildTool/main.swift", "content": "import Foundation\nimport MySourceGenBuildToolLib\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public var \\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Sources/MySourceGenBuildToolLib/library.swift", "content": "import Foundation\n\nextension String {\n \n public var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Sources/MySourceGenRuntimeLib/library.swift", "content": "public func GetLibraryName() -> String {\n return \"MySourceGenRuntimeLib\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Tests/MySourceGenPluginNoPreBuildCommandsTests/MySourceGenPluginNoPreBuildCommandsTests.swift", "content": "import XCTest\nimport class Foundation.Bundle\n\n// for rdar://113256834\nfinal class SwiftyProtobufTests: XCTestCase {\n func testMyLocalTool() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n // Mac Catalyst won't have `Process`, but it is supported for executables.\n #if !targetEnvironment(macCatalyst)\n\n let fooBinary = productsDirectory.appendingPathComponent(\"MyLocalTool\")\n\n let process = Process()\n process.executableURL = fooBinary\n\n let pipe = Pipe()\n process.standardOutput = pipe\n\n try process.run()\n process.waitUntilExit()\n\n let data = pipe.fileHandleForReading.readDataToEndOfFile()\n let output = String(data: data, encoding: .utf8)\n XCTAssertEqual(output, \"Generated string Foo: \\'4920616d20466f6f210a\\'\\n\")\n #endif\n }\n\n func testMyOtherLocalTool() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n // Mac Catalyst won't have `Process`, but it is supported for executables.\n #if !targetEnvironment(macCatalyst)\n\n let fooBinary = productsDirectory.appendingPathComponent(\"MyOtherLocalTool\")\n\n let process = Process()\n process.executableURL = fooBinary\n\n let pipe = Pipe()\n process.standardOutput = pipe\n\n try process.run()\n process.waitUntilExit()\n\n let data = pipe.fileHandleForReading.readDataToEndOfFile()\n let output = String(data: data, encoding: .utf8)\n XCTAssertEqual(output, \"\")\n #endif\n }\n\n /// Returns path to the built products directory.\n var productsDirectory: URL {\n #if os(macOS)\n for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(\".xctest\") {\n return bundle.bundleURL.deletingLastPathComponent()\n }\n fatalError(\"couldn't find the products directory\")\n #else\n return Bundle.main.bundleURL\n #endif\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginNoPreBuildCommands/Tests/MySourceGenPluginNoPreBuildCommandsTests/lunch.txt", "content": "coffee\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"MySourceGenPlugin\",\n products: [\n // The product that vends MySourceGenBuildToolPlugin to client packages.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n targets: [\"MySourceGenBuildToolPlugin\"]\n ),\n // The product that vends the MySourceGenBuildTool executable to client packages.\n .executable(\n name: \"MySourceGenBuildTool\",\n targets: [\"MySourceGenBuildTool\"]\n ),\n // The product that vends MySourceGenPrebuildPlugin to client packages.\n .plugin(\n name: \"MySourceGenPrebuildPlugin\",\n targets: [\"MySourceGenPrebuildPlugin\"]\n ),\n ],\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // A local tool that uses a prebuild plugin.\n .executableTarget(\n name: \"MyOtherLocalTool\",\n plugins: [\n \"MySourceGenPrebuildPlugin\",\n ]\n ),\n // The plugin that generates build tool commands to invoke MySourceGenBuildTool.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MySourceGenBuildTool\",\n ]\n ),\n // The plugin that generates prebuild commands (currently to invoke a system tool).\n .plugin(\n name: \"MySourceGenPrebuildPlugin\",\n capability: .buildTool()\n ),\n // The command line tool that generates source files.\n .executableTarget(\n name: \"MySourceGenBuildTool\",\n dependencies: [\n \"MySourceGenBuildToolLib\",\n ]\n ),\n // A library used by MySourceGenBuildTool (not the client).\n .target(\n name: \"MySourceGenBuildToolLib\"\n ),\n // A runtime library that the client needs to link against.\n .target(\n name: \"MySourceGenRuntimeLib\"\n ),\n // Unit tests for the plugin.\n .testTarget(\n name: \"MySourceGenPluginTests\",\n dependencies: [\n \"MySourceGenRuntimeLib\",\n ],\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n \"MySourceGenPrebuildPlugin\",\n ]\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n #if USE_CREATE\n let verb = \"Creating\"\n #else\n let verb = \"Generating\"\n #endif\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Build Tool Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n return try target.sourceFiles.map{ $0.url }.compactMap { (url: URL) -> Command? in\n guard url.pathExtension == \"dat\" else { return nil }\n let outputName = url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"\\(verb) \\(outputName) from \\(url.lastPathComponent)\",\n executable:\n try context.tool(named: \"MySourceGenBuildTool\").url,\n arguments: [\n url.path,\n outputPath.path\n ],\n inputFiles: [\n url,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Plugins/MySourceGenPrebuildPlugin/plugin.swift", "content": "import Foundation\nimport PackagePlugin\n\n#if os(Android)\nlet touchExe = \"/system/bin/touch\"\n#elseif os(Windows)\nlet touchExe = \"C:/Windows/System32/cmd.exe\"\n#else\nlet touchExe = \"/usr/bin/touch\"\n#endif\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the Prebuild Plugin!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n let outputPaths: [URL] = target.sourceFiles.filter{ $0.url.pathExtension == \"dat\" }.map { file in\n context.pluginWorkDirectoryURL.appendingPathComponent(file.url.lastPathComponent + \".swift\")\n }\n let paths = outputPaths.map{ $0.path }\n#if os(Windows)\n let args = [\"/c\", \"FOR %F IN (\" + paths.joined(separator: \" \") + \") DO TYPE NUL > %F\"]\n#else\n let args = paths\n#endif\n var commands: [Command] = []\n if !outputPaths.isEmpty {\n commands.append(.prebuildCommand(\n displayName:\n \"Running prebuild command for target \\(target.name)\",\n executable:\n .init(fileURLWithPath: touchExe),\n arguments:\n args,\n outputFilesDirectory:\n context.pluginWorkDirectoryURL\n ))\n }\n return commands\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MyLocalTool/main.swift", "content": "print(\"Generated string Foo: '\\(foo)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MyOtherLocalTool/main.swift", "content": "// print(\"Generated string Bar: '\\(bar)'\")\n// print(\"Generated string Baz: '\\(baz)'\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MySourceGenBuildTool/main.swift", "content": "import Foundation\nimport MySourceGenBuildToolLib\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public let \\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MySourceGenBuildToolLib/library.swift", "content": "import Foundation\n\nextension String {\n \n public var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Sources/MySourceGenRuntimeLib/library.swift", "content": "public func GetLibraryName() -> String {\n return \"MySourceGenRuntimeLib\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/MySourceGenPluginUsingURLBasedAPI/Tests/MySourceGenPluginTests/MySourceGenPluginTests.swift", "content": "import XCTest\nimport class Foundation.Bundle\n\nfinal class SwiftyProtobufTests: XCTestCase {\n func testExample() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n // Mac Catalyst won't have `Process`, but it is supported for executables.\n #if !targetEnvironment(macCatalyst)\n\n let fooBinary = productsDirectory.appendingPathComponent(\"MySourceGenTool\")\n\n let process = Process()\n process.executableURL = fooBinary\n\n let pipe = Pipe()\n process.standardOutput = pipe\n\n try process.run()\n process.waitUntilExit()\n\n let data = pipe.fileHandleForReading.readDataToEndOfFile()\n let output = String(data: data, encoding: .utf8)\n\n XCTAssertEqual(output, \"Hello, world!\\n\")\n #endif\n }\n\n /// Returns path to the built products directory.\n var productsDirectory: URL {\n #if os(macOS)\n for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(\".xctest\") {\n return bundle.bundleURL.deletingLastPathComponent()\n }\n fatalError(\"couldn't find the products directory\")\n #else\n return Bundle.main.bundleURL\n #endif\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginCanBeReferencedByProductName/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PluginCanBeReferencedByProductName\",\n products: [\n .plugin(name: \"MyPluginProduct\", targets: [\"MyPlugin\"]),\n ],\n targets: [\n .target(name: \"PluginCanBeReferencedByProductName\", plugins: [\"MyPluginProduct\"]),\n .executableTarget(name: \"Exec\"),\n .plugin(name: \"MyPlugin\", capability: .buildTool(), dependencies: [\"Exec\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginCanBeReferencedByProductName/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PackagePlugin.PluginContext, target: PackagePlugin.Target) async throws -> [PackagePlugin.Command] {\n let output = context.pluginWorkDirectoryURL.appendingPathComponent(\"gen.swift\")\n return [\n .buildCommand(displayName: \"Generating code\",\n executable: try context.tool(named: \"Exec\").url,\n arguments: [output.path],\n outputFiles: [output])\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginCanBeReferencedByProductName/Sources/Exec/main.swift", "content": "import Foundation\n\nlet output = ProcessInfo.processInfo.arguments[1]\ntry \"let stringConstant = \\\"Hello, World!\\\"\".write(to: URL(fileURLWithPath: output), atomically: true, encoding: .utf8)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginCanBeReferencedByProductName/Sources/PluginCanBeReferencedByProductName/PluginCanBeReferencedByProductName.swift", "content": "public struct PluginCanBeReferencedByProductName {\n public private(set) var text = stringConstant\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyLibrary/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyLibrary\",\n dependencies: [\n .package(path: \"../MyPlugin\")\n ],\n targets: [\n .target(\n name: \"MyLibrary\"\n ),\n .testTarget(\n name: \"MyLibraryTests\",\n dependencies: [\"MyLibrary\"]\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyLibrary/Sources/MyLibrary/library.swift", "content": "public func Foo() -> String {\n return \"Foo\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyLibrary/Tests/MyLibraryTests/test.swift", "content": "import XCTest\nimport MyLibrary\n\nfinal class MyLibraryTests: XCTestCase {\n \n func testLibrary() throws {\n XCTAssertEqual(Foo(), \"Foo\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyPlugin/Libraries/LocalToolHelperLibrary/library.swift", "content": "public func LocalToolHelperFunction() -> String {\n return \"local\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyPlugin/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyPlugin\",\n products: [\n .plugin(\n name: \"MyPlugin\",\n targets: [\"MyPlugin\"]\n ),\n ],\n dependencies: [\n .package(path: \"../RemoteTool\"),\n ],\n targets: [\n .plugin(\n name: \"MyPlugin\",\n capability: .command(\n intent: .custom(\n verb: \"my-plugin\",\n description: \"Tester plugin\"\n )\n ),\n dependencies: [\n .product(name: \"RemoteTool\", package: \"RemoteTool\"),\n \"LocalTool\",\n \"ImpliedLocalTool\",\n ]\n ),\n .executableTarget(\n name: \"LocalTool\",\n dependencies: [\"LocalToolHelperLibrary\"],\n path: \"Tools/LocalTool\"\n ),\n .executableTarget(\n name: \"ImpliedLocalTool\",\n dependencies: [\"LocalToolHelperLibrary\"],\n path: \"Tools/ImpliedLocalTool\"\n ),\n .target(\n name: \"LocalToolHelperLibrary\",\n path: \"Libraries/LocalToolHelperLibrary\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyPlugin/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: CommandPlugin {\n func performCommand(context: PluginContext, arguments: [String]) async throws {\n for name in [\"RemoteTool\", \"LocalTool\", \"ImpliedLocalTool\"] {\n let tool = try context.tool(named: name)\n print(\"tool path is \\(tool.path)\")\n \n do {\n let process = Process()\n process.executableURL = URL(fileURLWithPath: tool.path.string)\n try process.run()\n }\n catch {\n print(\"error: \\(error)\")\n }\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyPlugin/Tools/ImpliedLocalTool/main.swift", "content": "import LocalToolHelperLibrary\n\nprint(\"A message from the implied \\(LocalToolHelperFunction()) tool.\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/MyPlugin/Tools/LocalTool/main.swift", "content": "import LocalToolHelperLibrary\n\nprint(\"A message from the \\(LocalToolHelperFunction()) tool.\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/RemoteTool/Libraries/RemoteToolHelperLibrary/library.swift", "content": "public func RemoteToolHelperLibraryFunction() -> String {\n return \"remote\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/RemoteTool/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"RemoteTool\",\n products: [\n .executable(\n name: \"RemoteTool\",\n targets: [\"RemoteTool\"]\n ),\n ],\n targets: [\n .executableTarget(\n name: \"RemoteTool\",\n dependencies: [\"RemoteToolHelperLibrary\"],\n path: \"Tools/RemoteTool\"\n ),\n .target(\n name: \"RemoteToolHelperLibrary\",\n path: \"Libraries/RemoteToolHelperLibrary\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginUsingLocalAndRemoteTool/RemoteTool/Tools/RemoteTool/main.swift", "content": "import RemoteToolHelperLibrary\n\nprint(\"A message from the \\(RemoteToolHelperLibraryFunction()) tool.\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginWithInternalExecutable/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"PluginWithInternalExecutable\",\n products: [\n .plugin(\n name: \"PluginScriptProduct\",\n targets: [\"PluginScriptTarget\"]\n ),\n ],\n targets: [\n .plugin(\n name: \"PluginScriptTarget\",\n capability: .buildTool(),\n dependencies: [\n \"PluginExecutable\",\n ]\n ),\n .executableTarget(\n name: \"PluginExecutable\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginWithInternalExecutable/Plugins/PluginScriptTarget/Script.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct PluginScript: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n print(\"Hello from the plugin script!\")\n guard let target = target as? SourceModuleTarget else { return [] }\n return try target.sourceFiles.map{ $0.url }.compactMap { (url: URL) -> Command? in\n guard url.pathExtension == \"dat\" else { return nil }\n let outputName = url.deletingPathExtension().appendingPathExtension(\"swift\").lastPathComponent\n let outputPath = context.pluginWorkDirectoryURL.appendingPathComponent(outputName)\n return .buildCommand(\n displayName:\n \"Generating \\(outputName) from \\(url.lastPathComponent)\",\n executable:\n try context.tool(named: \"PluginExecutable\").url,\n arguments: [\n url.path,\n outputPath.path,\n ],\n inputFiles: [\n url,\n ],\n outputFiles: [\n outputPath\n ]\n )\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginWithInternalExecutable/Sources/PluginExecutable/Utilities.swift", "content": "import Foundation\n\nextension String {\n\n var quotedForSourceCode: String {\n return \"\\\"\" + self\n .replacingOccurrences(of: \"\\\\\", with: \"\\\\\\\\\")\n .replacingOccurrences(of: \"\\\"\", with: \"\\\\\\\"\")\n + \"\\\"\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginWithInternalExecutable/Sources/PluginExecutable/main.swift", "content": "import Foundation\n\n// Sample source generator tool that emits a Swift variable declaration of a string containing the hex representation of the contents of a file as a quoted string. The variable name is the base name of the input file. The input file is the first argument and the output file is the second.\nif ProcessInfo.processInfo.arguments.count != 3 {\n print(\"usage: MySourceGenBuildTool \")\n exit(1)\n}\nlet inputFile = ProcessInfo.processInfo.arguments[1]\nlet outputFile = ProcessInfo.processInfo.arguments[2]\n\nlet variableName = URL(fileURLWithPath: inputFile).deletingPathExtension().lastPathComponent\n\nlet inputData = FileManager.default.contents(atPath: inputFile) ?? Data()\nlet dataAsHex = inputData.map { String(format: \"%02hhx\", $0) }.joined()\nlet outputString = \"public let \\(variableName) = \\(dataAsHex.quotedForSourceCode)\\n\"\nlet outputData = outputString.data(using: .utf8)\nFileManager.default.createFile(atPath: outputFile, contents: outputData)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Package.swift", "content": "// swift-tools-version: 5.9\nimport PackageDescription\n\nlet package = Package(\n name: \"PluginsAndSnippets\",\n products: [\n .plugin(\n name: \"PluginScriptProduct\",\n targets: [\n \"PluginScriptTarget\"\n ],\n ),\n .library(\n name: \"MyLib\",\n targets: [\n \"MyLib\",\n ],\n ),\n ],\n targets: [\n .plugin(\n name: \"PluginScriptTarget\",\n capability: .command(\n intent: .custom(\n verb: \"do-something\",\n description: \"Do something\",\n ),\n ),\n ),\n .target(name: \"MyLib\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Plugins/PluginScriptTarget/Script.swift", "content": "import PackagePlugin\n\n@main\nstruct PluginScript: CommandPlugin {\n \n func performCommand(context: PluginContext, arguments: [String]) async throws {\n if !arguments.contains(\"--skip-dump\") {\n dump(context)\n }\n if let target = try context.package.targets(named: [\"MySnippet\"]).first as? SourceModuleTarget {\n print(\"type of snippet target: \\(target.kind)\")\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Snippets/ContainsMain.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\n@main\nstruct foo {\n static func main() {\n print(\"hello, snippets. File: \\(#file)\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Snippets/ImportsProductTarget.swift", "content": "import MyLib\n\nlibraryCall()" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Snippets/MySnippet.swift", "content": "print(\"hello, snippets. File: \\(#file)\")" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Snippets/SubDirectory/main.swift", "content": "print(\"hello, snippets! File: \\(#file)\")" }, { "path": "Fixtures/Miscellaneous/Plugins/PluginsAndSnippets/Sources/MyLib/MyLib.swift", "content": "public func libraryCall() {\n print(\"From library\")\n print(\"hello, snippets. File: \\(#file)\")\n}" }, { "path": "Fixtures/Miscellaneous/Plugins/PrebuildDependsExecutableTarget/Package.swift", "content": "// swift-tools-version: 6.3\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PrebuildDependsExecutableTarget\",\n platforms: [ .macOS(.v13) ],\n dependencies: [\n ],\n targets: [\n .executableTarget(name: \"MyExecutable\"),\n\n .plugin(\n name: \"MyPlugin\",\n capability: .buildTool(),\n dependencies: [\n \"MyExecutable\"\n ]\n ),\n\n .executableTarget(\n name: \"MyClient\",\n plugins: [\n \"MyPlugin\",\n ]\n ),\n ],\n swiftLanguageModes: [.v5]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PrebuildDependsExecutableTarget/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n let outputFilePath = context.pluginWorkDirectoryURL.appendingPathComponent(\"MyGeneratedFile.swift\")\n\n // We are attempting to assemble a prebuild command that relies on an executable that hasn't\n // been built yet. This should result in an error in prebuild.\n let myExecutable = try context.tool(named: \"MyExecutable\")\n\n return [\n .prebuildCommand(\n displayName: \"Prebuild that runs MyExecutable\",\n executable: myExecutable.url,\n arguments: [\"--output-file-path\", outputFilePath.path],\n outputFilesDirectory: context.pluginWorkDirectoryURL\n )\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PrebuildDependsExecutableTarget/Sources/MyClient/client.swift", "content": "@main\nstruct Client {\n static func main() throws {\n print(MyGeneratedStruct.message)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/PrebuildDependsExecutableTarget/Sources/MyExecutable/tool.swift", "content": "import Foundation\n\n@main\nstruct Tool {\n static func main() async throws {\n print(\"warning: Whoops! Coming from the executable\", to: &StdErr.shared)\n \n let path = CommandLine.arguments[2]\n print(\"Writing a file to \\(path)\")\n \n try #\"\"\"\n public struct MyGeneratedStruct {\n public static var message: String = \"You got struct'd\"\n }\n \"\"\"#.write(to: URL(fileURLWithPath: path), atomically: true, encoding: .utf8)\n }\n}\n\nstruct StdErr: TextOutputStream {\n static var shared: Self = .init()\n mutating func write(_ string: String) {\n string.withCString { ptr in\n _ = fputs(ptr, stderr)\n }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxTesterPlugin/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"SandboxTesterPlugin\",\n targets: [\n // A local tool that uses a build tool plugin.\n .executableTarget(\n name: \"MyLocalTool\",\n plugins: [\n \"MySourceGenBuildToolPlugin\",\n ]\n ),\n // The plugin that tries to write outside the sandbox.\n .plugin(\n name: \"MySourceGenBuildToolPlugin\",\n capability: .buildTool()\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxTesterPlugin/Plugins/MySourceGenBuildToolPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n \n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n guard let target = target as? SourceModuleTarget else { return [] }\n \n // Check that we can write to the output directory.\n let allowedOutputPath = context.pluginWorkDirectory.string + \"/\" + UUID().uuidString\n if mkdir(allowedOutputPath, 0o777) != 0 {\n throw StringError(\"unexpectedly could not write to '\\(allowedOutputPath)': \\(String(utf8String: strerror(errno)))\")\n }\n rmdir(allowedOutputPath)\n\n // Check that we cannot write to the user's home directory.\n let disallowedOutputPath = NSHomeDirectory() + \"/\" + UUID().uuidString\n if mkdir(disallowedOutputPath, 0o777) == 0 {\n throw StringError(\"unexpectedly could write to '\\(disallowedOutputPath)'\")\n }\n \n // Check that we can write to the temporary directory.\n let allowedTemporaryPath = NSTemporaryDirectory() + \"/\" + UUID().uuidString\n if mkdir(allowedTemporaryPath, 0o777) != 0 {\n throw StringError(\"unexpectedly could not write to '\\(allowedTemporaryPath)': \\(String(utf8String: strerror(errno)))\")\n }\n rmdir(allowedTemporaryPath)\n\n return []\n }\n\n struct StringError: Error, CustomStringConvertible {\n var error: String\n init(_ error: String) {\n self.error = error\n }\n var description: String { error }\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxTesterPlugin/Sources/MyLocalTool/main.swift", "content": "print(\"Hello plugin\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxViolatingBuildToolPluginCommands/MyLibrary/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyLibrary\",\n dependencies: [\n .package(path: \"../MyPlugin\")\n ],\n targets: [\n .target(\n name: \"MyLibrary\",\n plugins: [\n .plugin(name: \"PackageScribblerPlugin\", package: \"MyPlugin\")\n ])\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxViolatingBuildToolPluginCommands/MyLibrary/Sources/MyLibrary/library.swift", "content": "public func MyLibraryStruct() -> String {\n return \"This is \\(foo)\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxViolatingBuildToolPluginCommands/MyPlugin/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"MyPlugin\",\n products: [\n .plugin(\n name: \"PackageScribblerPlugin\",\n targets: [\"PackageScribblerPlugin\"]\n ),\n ],\n targets: [\n .plugin(\n name: \"PackageScribblerPlugin\",\n capability: .buildTool()\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SandboxViolatingBuildToolPluginCommands/MyPlugin/Plugins/PackageScribblerPlugin/plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n let outputDir = target.directory.appending(\"generated\")\n try FileManager.default.createDirectory(atPath: outputDir.string, withIntermediateDirectories: true)\n return [\n .prebuildCommand(\n displayName: \"Creating Foo.swift in the target directory…\",\n executable: Path(\"/bin/bash\"),\n arguments: [ \"-c\", \"echo 'let foo = \\\"\\(target.name)\\\"' > '\\(outputDir)/foo.swift'\" ],\n outputFilesDirectory: outputDir)\n ]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SwiftFilePlugin/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftFilePluginFixture\",\n products: [\n .library(\n name: \"SwiftFilePluginFixture\",\n targets: [\"SwiftFilePluginFixture\"]\n ),\n ],\n targets: [\n .target(\n name: \"SwiftFilePluginFixture\",\n plugins: [\n .plugin(name: \"MyCustomBuildTool\")\n ]\n ),\n .plugin(\n name: \"MyCustomBuildTool\",\n capability: .buildTool()\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SwiftFilePlugin/Plugins/MyCustomBuildTool/SwiftToolsBuildPlugin.swift", "content": "import Foundation\nimport PackagePlugin\n\n@main\nstruct SwiftToolsBuildPlugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) async throws -> [Command] {\n let formatExecutable = context.package.directoryURL.appending(components: \"SimpleSwiftScript.swift\")\n return [.buildCommand(\n displayName: \"Run a swift script\",\n executable: formatExecutable,\n arguments: [],\n inputFiles: [formatExecutable],\n outputFiles: []\n )]\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SwiftFilePlugin/SimpleSwiftScript.swift", "content": "#!/usr/bin/env swift\n\nprint(\"Hello, Build Tool Plugin!\")\n" }, { "path": "Fixtures/Miscellaneous/Plugins/SwiftFilePlugin/Sources/SwiftFilePluginFixture/SwiftFilePluginFixture.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Dependencies/Library/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Library\",\n products: [\n .library(name: \"Library\", targets: [\"Library\"]),\n ],\n dependencies: [\n .package(path: \"../PluginOnly\")\n ],\n targets: [\n .target(name: \"Library\", plugins: [.plugin(name: \"MyPlugin\", package: \"PluginOnly\")]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Dependencies/Library/Sources/Library/Library.swift", "content": "public struct Library {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Dependencies/PluginOnly/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PluginOnly\",\n products: [\n .plugin(name: \"MyPlugin\", targets: [\"MyPlugin\"]),\n ],\n targets: [\n .plugin(name: \"MyPlugin\", capability: .buildTool()),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Dependencies/PluginOnly/Plugins/MyPlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct MyPlugin: BuildToolPlugin {\n func createBuildCommands(context: PackagePlugin.PluginContext, target: PackagePlugin.Target) async throws -> [PackagePlugin.Command] {\n return []\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TransitivePluginOnlyDependency\",\n dependencies: [\n .package(path: \"Dependencies/Library\"),\n ],\n targets: [\n .target(name: \"TransitivePluginOnlyDependency\", dependencies: [\"Library\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Plugins/TransitivePluginOnlyDependency/Sources/TransitivePluginOnlyDependency/TransitivePluginOnlyDependency.swift", "content": "public struct TransitivePluginOnlyDependency {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/RequiresOlderDeploymentTarget/Foo.swift", "content": "@available(macOS, obsoleted: 13.0)\nfunc foo() {\n\n}\n\nfunc bar() {\n foo()\n}\n" }, { "path": "Fixtures/Miscellaneous/RequiresOlderDeploymentTarget/Package.swift", "content": "// swift-tools-version:6.1\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n platforms: [.macOS(.v12)],\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/RootPackageWithConditionals/Package.swift", "content": "// swift-tools-version: 5.7\n\nimport PackageDescription\n\nlet package = Package(\n name: \"client\",\n products: [\n .library(name: \"client\", targets: [\"client\"]),\n ],\n dependencies: [\n ],\n targets: [\n .target(name: \"client\", dependencies: [\n \t.target(name: \"linuxOnly\", condition: .when(platforms: [.linux]))\n ]),\n .target(name: \"linuxOnly\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/RootPackageWithConditionals/Sources/client/client.swift", "content": "public struct client {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/RootPackageWithConditionals/Sources/linuxOnly/linuxOnly.swift", "content": "public struct linuxOnly {\n public private(set) var text = \"Hello, World!\"\n\n public init() {\n#if os(Linux)\nprint(\"bestOS\")\n#else\n#error(\"not linux\")\n#endif\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/ShowExecutables/app/Package.swift", "content": "// swift-tools-version:5.10\nimport PackageDescription\n\nlet package = Package(\n name: \"Dealer\",\n products: [\n .executable(\n name: \"dealer\",\n targets: [\"Dealer\"]\n ),\n ],\n dependencies: [\n .package(path: \"../deck-of-playing-cards\"),\n ],\n targets: [\n .executableTarget(\n name: \"Dealer\",\n path: \"./\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ShowExecutables/app/main.swift", "content": "print(\"I'm the dealer\")\n" }, { "path": "Fixtures/Miscellaneous/ShowExecutables/deck-of-playing-cards/Package.swift", "content": "// swift-tools-version:5.10\nimport PackageDescription\n\nlet package = Package(\n name: \"deck-of-playing-cards\",\n products: [\n .executable(\n name: \"deck\",\n targets: [\"Deck\"]\n ),\n ],\n targets: [\n .executableTarget(\n name: \"Deck\",\n path: \"./\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ShowExecutables/deck-of-playing-cards/main.swift", "content": "print(\"I'm a deck of cards\")\n" }, { "path": "Fixtures/Miscellaneous/ShowTraits/app/Package.swift", "content": "// swift-tools-version:6.1\nimport PackageDescription\n\nlet package = Package(\n name: \"Dealer\",\n products: [\n .executable(\n name: \"dealer\",\n targets: [\"Dealer\"]\n ),\n ],\n traits: [\n .trait(name: \"trait1\", description: \"this trait is the default in app\"),\n .trait(name: \"trait2\", description: \"this trait is not the default in app\"),\n .default(enabledTraits: [\"trait1\"]),\n ],\n dependencies: [\n .package(path: \"../deck-of-playing-cards\", traits: [\"trait3\"]),\n ],\n targets: [\n .executableTarget(\n name: \"Dealer\",\n path: \"./\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ShowTraits/app/main.swift", "content": "print(\"I'm the dealer\")\n" }, { "path": "Fixtures/Miscellaneous/ShowTraits/deck-of-playing-cards/Package.swift", "content": "// swift-tools-version:6.1\nimport PackageDescription\n\nlet package = Package(\n name: \"deck-of-playing-cards\",\n products: [\n .executable(\n name: \"deck\",\n targets: [\"Deck\"]\n ),\n ],\n traits: [\n .trait(name: \"trait3\", description: \"This trait is in a different package and not default.\")\n ],\n targets: [\n .executableTarget(\n name: \"Deck\",\n path: \"./\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/ShowTraits/deck-of-playing-cards/main.swift", "content": "print(\"I'm a deck of cards\")\n" }, { "path": "Fixtures/Miscellaneous/Simple/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/Miscellaneous/Simple/Package.swift", "content": "// swift-tools-version:5.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/SkipTests/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/SkipTests/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Example\",\n targets: [\n .target(\n name: \"Example\",\n dependencies: []),\n .testTarget(\n name: \"ExampleTests\",\n dependencies: [\"Example\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/SkipTests/Sources/Example/Example.swift", "content": "struct Example {\n var text = \"Hello, World!\"\n var bool = false\n}\n" }, { "path": "Fixtures/Miscellaneous/SkipTests/Tests/ExampleTests/MoreTests.swift", "content": "import XCTest\n@testable import Example\n\nclass MoreTests: XCTestCase {\n func testExample3() {\n XCTAssertEqual(Example().text, \"Hello, World!\")\n }\n\n func testExample4() {\n XCTAssertEqual(Example().bool, false)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/SkipTests/Tests/ExampleTests/Tests.swift", "content": "import XCTest\n@testable import Example\n\nclass SomeTests: XCTestCase {\n func testExample1() {\n XCTAssertEqual(Example().text, \"Hello, World!\")\n }\n\n func testExample2() {\n XCTAssertEqual(Example().bool, false)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Spaces Fixture/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Spaces Fixture\",\n targets: [\n .target(\n name: \"Module Name 2\",\n dependencies: [\"Module Name 1\"]),\n .target(\n name: \"Module Name 1\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Spaces Fixture/Sources/Module Name 1/Foo.swift", "content": "public class Foo {\n var bar: Int = 0\n}\n" }, { "path": "Fixtures/Miscellaneous/Spaces Fixture/Sources/Module Name 2/main.swift", "content": "import Module_Name_1\n\npublic class Foo {\n var bar: Int = 0\n}\n" }, { "path": "Fixtures/Miscellaneous/SwiftBuild/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableExe\",\n targets: [\n .executableTarget(\n name: \"Test\",\n path: \".\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/SwiftBuild/main.swift", "content": "print(\"done\")" }, { "path": "Fixtures/Miscellaneous/SwiftPMXCTestHelper/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/Miscellaneous/SwiftPMXCTestHelper/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftPMXCTestHelper\",\n targets: [\n .target(name: \"SwiftPMXCTestHelper\", path: \"Sources\"),\n .testTarget(name: \"SwiftPMXCTestHelperTests\", dependencies: [\"SwiftPMXCTestHelper\"]),\n .testTarget(name: \"ObjCTests\"),\n ]\n)\n\n" }, { "path": "Fixtures/Miscellaneous/SwiftPMXCTestHelper/Sources/SwiftPMXCTestHelper.swift", "content": "struct SwiftPMXCTestHelper {\n\n}\n" }, { "path": "Fixtures/Miscellaneous/SwiftPMXCTestHelper/Tests/ObjCTests/ObjCTests.m", "content": "@import XCTest;\n\n@interface ObjCTests: XCTestCase\n@end\n\n@implementation ObjCTests\n\n- (void)testThisThing {\n}\n\n- (void)test_example {\n}\n\n- (void)nonTest {\n}\n\n@end\n" }, { "path": "Fixtures/Miscellaneous/SwiftPMXCTestHelper/Tests/SwiftPMXCTestHelperTests/SwiftPMXCTestHelperTests.swift", "content": "import XCTest\n@testable import SwiftPMXCTestHelper\n\nclass SwiftPMXCTestHelperTests1: XCTestCase {\n\n func testExample1() {\n }\n\n func test_Example2() {\n }\n\n func testExample3(arg: String) {\n }\n\n func nontest() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/SwiftRun/Package.swift", "content": "// swift-tools-version: 5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableExe\",\n targets: [\n .executableTarget(\n name: \"Test\",\n path: \".\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/SwiftRun/main.swift", "content": "print(\"done\")\n" }, { "path": "Fixtures/Miscellaneous/SystemModules/CFake/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CFake\"\n)\n" }, { "path": "Fixtures/Miscellaneous/SystemModules/CFake/module.modulemap", "content": "module CFake [system] {\n header \"/tmp/fake.h\"\n link \"fake\"\n export *\n}\n" }, { "path": "Fixtures/Miscellaneous/SystemModules/TestExec/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"TestExec\",\n dependencies: [\n .package(url: \"../CFake\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"TestExec\", path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/SystemModules/TestExec/Sources/main.swift", "content": "import CFake\n\nprint(\"Hello, \\(GetFakeString())!\")\n" }, { "path": "Fixtures/Miscellaneous/TIF/Package.swift", "content": "// swift-tools-version:5.3\nimport PackageDescription\n\nlet package = Package(\n name: \"TIF\",\n products: [\n .library(name: \"TIF\", targets: [\"TIF\"])\n ],\n targets: [\n .target(\n name: \"TIF\",\n resources: [\n .copy(\"some.txt\")\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TIF/README.md", "content": "# TIF\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/TIF/Sources/TIF/SomeAlert.swift", "content": "//\n// SomeAlert.swift\n// MyFwk\n//\n// Created by ankit on 10/31/19.\n// Copyright © 2019 Ankit. All rights reserved.\n//\n\nimport Cocoa\n\npublic class SomeAlert: NSViewController {\n \n @IBOutlet var label: NSTextField!\n \n override public func viewDidLoad() {\n super.viewDidLoad()\n let bundlePath = Bundle.main.path(forResource: \"TIF_TIF\", ofType: \"bundle\")!\n let bundle = Bundle(path: bundlePath)!\n\n let txt = bundle.path(forResource: \"some\", ofType: \"txt\")!\n let c = FileManager.default.contents(atPath: txt)!\n\n label.stringValue = String(data:c, encoding: .utf8)!\n // Do view setup here.\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TIF/Sources/TIF/SomeAlert.xib", "content": "\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n" }, { "path": "Fixtures/Miscellaneous/TIF/Sources/TIF/SomeAssets.xcassets/Contents.json", "content": "{\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TIF/Sources/TIF/SomeAssets.xcassets/this_is_fine.imageset/Contents.json", "content": "{\n \"images\" : [\n {\n \"filename\" : \"this_is_fine.jpg\",\n \"idiom\" : \"universal\",\n \"scale\" : \"1x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"2x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"3x\"\n }\n ],\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TIF/Sources/TIF/some.txt", "content": "This is being read from some.txt file in the bundle.\n" }, { "path": "Fixtures/Miscellaneous/TargetMismatch/Package.swift", "content": "// swift-tools-version:5.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Sample\",\n products: [\n .library(\n name: \"Sample\",\n targets: [\n \"Sample\"\n ]\n ),\n ],\n targets: [\n .target(\n name: \"Sample\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TargetMismatch/Sources/Sample/main.swift", "content": "" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Package.swift", "content": "// swift-tools-version:5.9\nimport PackageDescription\n\nlet package = Package(\n name: \"libPkg\",\n products: [\n .executable(name: \"ExampleApp\", targets: [\"ExampleApp\"]),\n .library(name: \"MainLib\", targets: [\"MainLib\"]),\n ],\n targets: [\n .executableTarget(name: \"ExampleApp\", dependencies: [\"MainLib\"], packageAccess: false),\n .target(name: \"MainLib\", dependencies: [\"Core\"], packageAccess: true),\n .target(name: \"Core\", dependencies: [\"DataManager\"]),\n .target(name: \"DataManager\", dependencies: [\"DataModel\"]),\n .target(name: \"DataModel\"),\n .testTarget(name: \"MainLibTests\", dependencies: [\"MainLib\"]),\n .testTarget(name: \"BlackBoxTests\", dependencies: [\"MainLib\"], packageAccess: false)\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Sources/Core/Core.swift", "content": "import DataManager\n\npublic struct PublicCore {\n public let publicVar: Int\n public init(publicVar: Int) {\n self.publicVar = publicVar\n }\n public func publicCoreFunc() {\n managePublicFunc()\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Sources/DataManager/File.swift", "content": "import DataModel\n\npublic func managePublicFunc() -> PublicData? {\n return nil\n}\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Sources/DataModel/File.swift", "content": "public class PublicData {}\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Sources/ExampleApp/main.swift", "content": "import MainLib\n\npublicFunc()\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Sources/MainLib/Lib.swift", "content": "import Core\n\npublic func publicFunc() -> Int {\n print(\"public decl\")\n return PublicCore(publicVar: 10).publicVar\n}\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Tests/BlackBoxTests/BlackBoxTests.swift", "content": "import MainLib\nimport XCTest\n\nclass BlackBoxTests: XCTestCase {\n func testBlackBox() {\n let x = publicFunc()\n XCTAssertTrue(x > 0)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TargetPackageAccess/libPkg/Tests/MainLibTests/MainLibTests.swift", "content": "import MainLib\nimport XCTest\n\nclass TestMainLib: XCTestCase {\n func testMainLib() {\n let x = publicFunc()\n XCTAssertTrue(x > 0)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Async/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Async\",\n targets: [\n .target(name: \"Async\"),\n .testTarget(name: \"AsyncTests\", dependencies: [\"Async\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Async/Sources/Async/Async.swift", "content": "struct Async {\n\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Async/Tests/AsyncTests/SwiftTests.swift", "content": "import XCTest\n@testable import Async\n\n@available(macOS 12.0, *)\nclass AsyncTests: XCTestCase {\n\n func testAsync() async {\n }\n\n func testAsyncThrows() async throws {\n }\n\n @MainActor func testMainActor() async {\n XCTAssertTrue(Thread.isMainThread)\n }\n\n func testNotAsync() {\n XCTAssertTrue(Thread.isMainThread)\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Deprecation/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Simple\"),\n .testTarget(name: \"SimpleTests\", dependencies: [\"Simple\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Deprecation/Sources/Simple/Simple.swift", "content": "struct Simple {\n func hello() {}\n\n @available(*, deprecated, message: \"use hello instead\")\n func deprecatedHello() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Deprecation/Tests/SimpleTests/SwiftTests.swift", "content": "import XCTest\n@testable import Simple\n\nclass SimpleTests: XCTestCase {\n func testHello() {\n Simple().hello()\n }\n\n @available(*, deprecated, message: \"testing deprecated API\")\n func testDeprecatedHello() {\n Simple().deprecatedHello()\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Simple\"),\n .testTarget(name: \"SimpleTests\", dependencies: [\"Simple\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Sources/Simple/Simple.swift", "content": "struct Simple {\n\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Tests/SimpleTests/SwiftTests1.swift", "content": "import XCTest\n@testable import Simple\n\nclass SimpleTests1: XCTestCase {\n func testExample1() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Tests/SimpleTests/SwiftTests2.swift", "content": "import XCTest\n@testable import Simple\n\nclass SimpleTests2: XCTestCase {\n func testExample2() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Tests/SimpleTests/SwiftTests3.swift", "content": "import XCTest\n@testable import Simple\n\nextension SimpleTests1 {\n func testExample1_a() {\n }\n}\n\nextension SimpleTests2 {\n func testExample2_a() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Extensions/Tests/SimpleTests/SwiftTests4.swift", "content": "import XCTest\n@testable import Simple\n\nclass SimpleTests4: XCTestCase {\n func testExample() {\n }\n\n func testExample1() {\n }\n\n func testExample2() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/IgnoresLinuxMain/Package.swift", "content": "// swift-tools-version:5.10\nimport PackageDescription\n\nlet package = Package(\n name: \"IgnoresLinuxMain\",\n targets: [\n .testTarget(name: \"IgnoresLinuxMainTests\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/IgnoresLinuxMain/Tests/IgnoresLinuxMainTests/SomeTest.swift", "content": "import XCTest\n\nfinal class SomeTests: XCTestCase {\n func testSomething() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/IgnoresLinuxMain/Tests/LinuxMain.swift", "content": "fatalError(\"Should not use the contents of LinuxMain.swift\")\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/NoTests/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Simple\"),\n .testTarget(name: \"SimpleTests\", dependencies: [\"Simple\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/NoTests/Sources/Simple/Simple.swift", "content": "struct Simple {\n\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/NoTests/Tests/SimpleTests/SwiftTests.swift", "content": "\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Simple/Package.swift", "content": "// swift-tools-version:5.8\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n targets: [\n .target(name: \"Simple\", plugins: [\"SimplePlugin\"]),\n .testTarget(name: \"SimpleTests\", dependencies: [\"Simple\"]),\n .plugin(name: \"SimplePlugin\", capability: .buildTool()),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Simple/Plugins/SimplePlugin/plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct Simple: BuildToolPlugin {\n func createBuildCommands(context: PackagePlugin.PluginContext, target: PackagePlugin.Target) async throws -> [PackagePlugin.Command] {\n return []\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Simple/Sources/Simple/Simple.swift", "content": "struct Simple {\n\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Simple/Tests/SimpleTests/SwiftTests.swift", "content": "import XCTest\n@testable import Simple\n\nclass SimpleTests: XCTestCase {\n\n func testExample1() {\n }\n\n func test_Example2() {\n }\n\n func testThrowing() throws {\n }\n\n func testWithArgs(arg: String) {\n }\n\n func nontest() {\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Subclass/Package.swift", "content": "// swift-tools-version:5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"Subclass\",\n targets: [\n .target(name: \"Subclass\"),\n .testTarget(name: \"Module1Tests\", dependencies: [\"Subclass\"]),\n .testTarget(name: \"Module2Tests\", dependencies: [\"Subclass\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Subclass/Sources/Subclass/Subclass.swift", "content": "struct Subclass {\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Subclass/Tests/Module1Tests/Tests1.swift", "content": "import XCTest\n\nclass Tests1: XCTestCase {\n func test11() {\n print(\"->Module1::Tests1::test11\")\n }\n\n func test12() {\n print(\"->Module1::Tests1::test12\")\n }\n\n func test13() {\n print(\"->Module1::Tests1::test13\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Subclass/Tests/Module1Tests/Tests2.swift", "content": "import XCTest\n\nclass Tests3: Tests2 {\n override func test11() {\n print(\"->Module1::Tests3::test11\")\n }\n\n override func test21() {\n print(\"->Module1::Tests3::test21\")\n }\n\n func test31() {\n print(\"->Module1::Tests3::test31\")\n }\n\n func test32() {\n print(\"->Module1::Tests3::test32\")\n }\n\n func test33() {\n print(\"->Module1::Tests3::test33\")\n }\n}\n\nclass Tests2: Tests1 {\n func test21() {\n print(\"->Module1::Tests2::test21\")\n }\n\n func test22() {\n print(\"->Module1::Tests2::test22\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/Subclass/Tests/Module2Tests/Test1.swift", "content": "import XCTest\n\nclass Tests1: XCTestCase {\n func test11() {\n print(\"->Module2::Tests1::test11\")\n }\n\n func test12() {\n print(\"->Module2::Tests1::test12\")\n }\n\n func test13() {\n print(\"->Module2::Tests1::test13\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/SwiftTesting/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"SwiftTesting\",\n targets: [\n .testTarget(name: \"SwiftTestingTests\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/SwiftTesting/Sources/SwiftTesting/SwiftTesting.swift", "content": "\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/SwiftTesting/Tests/SwiftTestingTests/SwiftTestingTests.swift", "content": "import Testing\n@Test(\"SOME TEST FUNCTION\") func someTestFunction() {}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/hello world/Package.swift", "content": "// swift-tools-version:5.3\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"hello world\",\n products: [\n // Products define the executables and libraries a package produces, and make them visible to other packages.\n .library(\n name: \"hello world\",\n targets: [\"hello world\"]),\n ],\n dependencies: [\n // Dependencies declare other packages that this package depends on.\n // .package(url: /* package url */, from: \"1.0.0\"),\n ],\n targets: [\n // Targets are the basic building blocks of a package. A target can define a module or a test suite.\n // Targets can depend on other targets in this package, and on products in packages this package depends on.\n .target(\n name: \"hello world\",\n dependencies: []),\n .testTarget(\n name: \"hello world tests\",\n dependencies: [\"hello world\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/hello world/Sources/hello world/hello world.swift", "content": "struct hello_world {\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Miscellaneous/TestDiscovery/hello world/Tests/hello world tests/hello world tests.swift", "content": "import XCTest\n@testable import hello_world\n\nfinal class hello_worldTests: XCTestCase {\n func testExample() {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n XCTAssertEqual(hello_world().text, \"Hello, World!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestMultipleFailureSwiftTesting/Package.swift", "content": "// swift-tools-version: 6.0\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TestMultipleFailureSwiftTesting\",\n targets: [\n .testTarget(\n name: \"TestMultipleFailureSwiftTestingTests\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestMultipleFailureSwiftTesting/Tests/TestMultipleFailureSwiftTestingTests/TestMultipleFailureSwiftTestingTests.swift", "content": "import Testing\n\n@Test func testFailure1() async throws {\n #expect(Bool(false), \"ST Test failure 1\")\n}\n\n@Test func testFailure2() async throws {\n #expect(Bool(false), \"ST Test failure 2\")\n}\n\n@Test func testFailure3() async throws {\n #expect(Bool(false), \"ST Test failure 3\")\n}\n\n@Test func testFailure4() async throws {\n #expect(Bool(false), \"ST Test failure 4\")\n}\n\n@Test func testFailure5() async throws {\n #expect(Bool(false), \"ST Test failure 5\")\n}\n\n@Test func testFailure6() async throws {\n #expect(Bool(false), \"ST Test failure 6\")\n}\n\n@Test func testFailure7() async throws {\n #expect(Bool(false), \"ST Test failure 7\")\n}\n\n@Test func testFailure8() async throws {\n #expect(Bool(false), \"ST Test failure 8\")\n}\n\n@Test func testFailure9() async throws {\n #expect(Bool(false), \"ST Test failure 9\")\n}\n\n@Test func testFailure10() async throws {\n #expect(Bool(false), \"ST Test failure 10\")\n}\n" }, { "path": "Fixtures/Miscellaneous/TestMultipleFailureXCTest/Package.swift", "content": "// swift-tools-version: 5.9\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TestMultipleFailureXCTest\",\n targets: [\n .testTarget(\n name: \"TestMultipleFailureXCTestTests\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestMultipleFailureXCTest/Tests/TestMultipleFailureXCTestTests/TestMultipleFailureXCTestTests.swift", "content": "import XCTest\n\nfinal class TestMultipleFailureXCTestTests: XCTestCase {\n func testFailure1() throws {\n XCTAssertFalse(true, \"Test failure 1\")\n }\n\n func testFailure2() throws {\n XCTAssertFalse(true, \"Test failure 2\")\n }\n\n func testFailure3() throws {\n XCTAssertFalse(true, \"Test failure 3\")\n }\n\n func testFailure4() throws {\n XCTAssertFalse(true, \"Test failure 4\")\n }\n\n func testFailure5() throws {\n XCTAssertFalse(true, \"Test failure 5\")\n }\n\n func testFailure6() throws {\n XCTAssertFalse(true, \"Test failure 6\")\n }\n\n func testFailure7() throws {\n XCTAssertFalse(true, \"Test failure 7\")\n }\n\n func testFailure8() throws {\n XCTAssertFalse(true, \"Test failure 8\")\n }\n\n func testFailure9() throws {\n XCTAssertFalse(true, \"Test failure 9\")\n }\n\n func testFailure10() throws {\n XCTAssertFalse(true, \"Test failure 10\")\n }\n\n}\n" }, { "path": "Fixtures/Miscellaneous/TestSingleFailureSwiftTesting/Package.swift", "content": "// swift-tools-version: 5.9\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TestFailuresSwiftTesting\",\n targets: [\n .testTarget(\n name: \"TestFailuresSwiftTestingTests\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestSingleFailureSwiftTesting/Tests/TestFailuresSwiftTestingTests/TestFailuresSwiftTestingTests.swift", "content": "import Testing\n\n@Test func example() async throws {\n #expect(Bool(false), \"Purposely failing & validating XML espace \\\"'<>\")\n}\n" }, { "path": "Fixtures/Miscellaneous/TestSingleFailureXCTest/Package.swift", "content": "// swift-tools-version: 5.9\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TestFailures\",\n targets: [\n .testTarget(\n name: \"TestFailuresTests\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestSingleFailureXCTest/Tests/TestFailuresTests/TestFailuresTests.swift", "content": "import XCTest\n\nfinal class TestFailuresTests: XCTestCase {\n func testExample() throws {\n XCTAssertFalse(true, \"Purposely failing & validating XML espace \\\"'<>\")\n }\n}\n\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Package.swift", "content": "// swift-tools-version: 5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableAsyncExe\",\n platforms: [\n .macOS(.v10_15),\n ],\n targets: [\n .executableTarget(\n name: \"TestableAsyncExe1\"\n ),\n .executableTarget(\n name: \"TestableAsyncExe2\"\n ),\n .executableTarget(\n name: \"TestableAsyncExe3\"\n ),\n .executableTarget(\n name: \"TestableAsyncExe4\"\n ),\n .testTarget(\n name: \"TestableAsyncExeTests\",\n dependencies: [\n \"TestableAsyncExe1\",\n \"TestableAsyncExe2\",\n \"TestableAsyncExe3\",\n \"TestableAsyncExe4\",\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Sources/TestableAsyncExe1/main.swift", "content": "public func GetAsyncGreeting1() async -> String {\n return \"Hello, async world\"\n}\n\nawait print(\"\\(GetAsyncGreeting1())!\")\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Sources/TestableAsyncExe2/main.swift", "content": "public func GetAsyncGreeting2() async -> String {\n return \"Hello, async planet\"\n}\n\nawait print(\"\\(GetAsyncGreeting2())!\")\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Sources/TestableAsyncExe3/NonMain.swift", "content": "@main\nstruct AsyncMain3 {\n static func main() async {\n print(await getGreeting3())\n }\n\n static func getGreeting3() async -> String {\n return \"Hello, async galaxy\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Sources/TestableAsyncExe4/NonMain.swift", "content": "@main\nstruct AsyncMain4 {\n static func main() async {\n print(await getGreeting4())\n }\n\n static func getGreeting4() async -> String {\n return \"Hello, async universe\"\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableAsyncExe/Tests/TestableAsyncExeTests/TestableAsyncExeTests.swift", "content": "import XCTest\n@testable import TestableAsyncExe1\n@testable import TestableAsyncExe2\n@testable import TestableAsyncExe3\n@testable import TestableAsyncExe4\n\nfinal class TestableAsyncExeTests: XCTestCase {\n func testExample() async throws {\n let greeting1 = await GetAsyncGreeting1()\n print(greeting1)\n XCTAssertEqual(greeting1, \"Hello, async world\")\n\n let greeting2 = await GetAsyncGreeting2()\n print(greeting2)\n XCTAssertEqual(greeting2, \"Hello, async planet\")\n\n let greeting3 = await AsyncMain3.getGreeting3()\n print(greeting3)\n XCTAssertEqual(greeting3, \"Hello, async galaxy\")\n\n let greeting4 = await AsyncMain4.getGreeting4()\n print(greeting4)\n XCTAssertEqual(greeting4, \"Hello, async universe\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableExe/Package.swift", "content": "// swift-tools-version: 5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableExe\",\n targets: [\n .executableTarget(\n name: \"TestableExe1\",\n linkerSettings: [\n .linkedLibrary(\"swiftCore\", .when(platforms: [.windows])), // for swift_addNewDSOImage\n ]\n ),\n .executableTarget(\n name: \"TestableExe2\",\n linkerSettings: [\n .linkedLibrary(\"swiftCore\", .when(platforms: [.windows])), // for swift_addNewDSOImage\n ]\n\n ),\n .executableTarget(\n name: \"TestableExe3\",\n linkerSettings: [\n .linkedLibrary(\"swiftCore\", .when(platforms: [.windows])), // for swift_addNewDSOImage\n ]\n ),\n .testTarget(\n name: \"TestableExeTests\",\n dependencies: [\n \"TestableExe1\",\n \"TestableExe2\",\n \"TestableExe3\",\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestableExe/Sources/TestableExe1/main.swift", "content": "public func GetGreeting1() -> String {\n return \"Hello, world\"\n}\n\nprint(\"\\(GetGreeting1())!\")\n" }, { "path": "Fixtures/Miscellaneous/TestableExe/Sources/TestableExe2/main.swift", "content": "public func GetGreeting2() -> String {\n return \"Hello, planet\"\n}\n\nprint(\"\\(GetGreeting2())!\")\n" }, { "path": "Fixtures/Miscellaneous/TestableExe/Sources/TestableExe3/include/TestableExe3.h", "content": "const char * GetGreeting3();" }, { "path": "Fixtures/Miscellaneous/TestableExe/Sources/TestableExe3/main.c", "content": "#include \n#include \"include/TestableExe3.h\"\n\nconst char * GetGreeting3() {\n return \"Hello, universe\";\n}\n\nint main() {\n printf(\"%s!\\n\", GetGreeting3());\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableExe/Tests/TestableExeTests/TestableExeTests.swift", "content": "import XCTest\n@testable import TestableExe1\n@testable import TestableExe2\n// import TestableExe3\nimport class Foundation.Bundle\n\nfinal class TestableExeTests: XCTestCase {\n\n #if os(Windows)\n let eol = \"\\r\\n\"\n#else\n let eol = \"\\n\"\n#endif\n\n func testExample() throws {\n // This is an example of a functional test case.\n // Use XCTAssert and related functions to verify your tests produce the correct\n // results.\n\n print(GetGreeting1())\n XCTAssertEqual(GetGreeting1(), \"Hello, world\")\n print(GetGreeting2())\n XCTAssertEqual(GetGreeting2(), \"Hello, planet\")\n // XCTAssertEqual(String(cString: GetGreeting3()), \"Hello, universe\")\n\n // Some of the APIs that we use below are available in macOS 10.13 and above.\n guard #available(macOS 10.13, *) else {\n return\n }\n\n var execPath = productsDirectory.appendingPathComponent(\"TestableExe1\")\n var process = Process()\n process.executableURL = execPath\n var pipe = Pipe()\n process.standardOutput = pipe\n try process.run()\n process.waitUntilExit()\n var data = pipe.fileHandleForReading.readDataToEndOfFile()\n var output = String(data: data, encoding: .utf8)\n XCTAssertEqual(output, \"Hello, world!\\(eol)\")\n\n execPath = productsDirectory.appendingPathComponent(\"TestableExe2\")\n process = Process()\n process.executableURL = execPath\n pipe = Pipe()\n process.standardOutput = pipe\n try process.run()\n process.waitUntilExit()\n data = pipe.fileHandleForReading.readDataToEndOfFile()\n output = String(data: data, encoding: .utf8)\n XCTAssertEqual(output, \"Hello, planet!\\(eol)\")\n\n execPath = productsDirectory.appendingPathComponent(\"TestableExe3\")\n process = Process()\n process.executableURL = execPath\n pipe = Pipe()\n process.standardOutput = pipe\n try process.run()\n process.waitUntilExit()\n data = pipe.fileHandleForReading.readDataToEndOfFile()\n output = String(data: data, encoding: .utf8)\n XCTAssertEqual(output, \"Hello, universe!\\(eol)\")\n }\n\n /// Returns path to the built products directory.\n var productsDirectory: URL {\n #if os(macOS)\n for bundle in Bundle.allBundles where bundle.bundlePath.hasSuffix(\".xctest\") {\n return bundle.bundleURL.deletingLastPathComponent()\n }\n fatalError(\"couldn't find the products directory\")\n #else\n return Bundle.main.bundleURL\n #endif\n }\n\n static var allTests = [\n (\"testExample\", testExample),\n ]\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithDifferentProductName/Package.swift", "content": "// swift-tools-version: 5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableExe\",\n products: [\n .executable(name: \"testable-exe\", targets: [\"TestableExe\"])\n ],\n targets: [\n .executableTarget(\n name: \"TestableExe\"\n ),\n .testTarget(\n name: \"TestableExeTests\",\n dependencies: [\n \"TestableExe\",\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithDifferentProductName/Sources/TestableExe/main.swift", "content": "public func functionFromTestableExecutable() {\n print(\"Hello, world\")\n}\n\nfunctionFromTestableExecutable()\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithDifferentProductName/Tests/TestableExeTests/TestableExeTests.swift", "content": "import XCTest\n@testable import TestableExe\n\nfinal class TestableExeTests: XCTestCase {\n func testExample() throws {\n functionFromTestableExecutable()\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithResources/Package.swift", "content": "// swift-tools-version: 6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"TestableExe\",\n targets: [\n .executableTarget(\n name: \"TestableExe\",\n resources: [.embedInCode(\"foo.txt\")]\n ),\n .testTarget(\n name: \"TestableExeTests\",\n dependencies: [\n \"TestableExe\",\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithResources/Sources/TestableExe/foo.txt", "content": "bar\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithResources/Sources/TestableExe/main.swift", "content": "public func GetGreeting1() -> String {\n return String(decoding: PackageResources.foo_txt, as: UTF8.self)\n}\n\nprint(\"\\(GetGreeting1())!\")\n" }, { "path": "Fixtures/Miscellaneous/TestableExeWithResources/Tests/TestableExeTests/TestableExeTests.swift", "content": "import XCTest\n@testable import TestableExe\n\nfinal class TestableExeTests: XCTestCase {\n func testExample() throws {\n XCTAssertEqual(GetGreeting1(), \"bar\\n\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Package.swift", "content": "// swift-tools-version:5.1\n\nimport PackageDescription\nimport Foundation\n\n/// This string demonstrates as many complications of Unicode as possible.\nlet complicatedString = \"πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\"\n// π U+03C0: A simple BMP scalar.\n//‎ שּׁ U+FB2C: Changes under both NFC and NFD.\n// µ U+00B5: Changes under NFKC and NFKD.\n// 𝄞 U+1D11E: Simple non‐BMP scalar.\n// 🇺🇳 U+1F1FA U+1F1F3: Multi‐scalar character.\n// 🇮🇱 U+1F1EE U+1F1F1: Second consecutive regional indicator. (Complicated grapheme breaking.)\n// x̱̱̱̱̱̄̄̄̄̄ U+0078 (U+0331 U+0304) × 5: Extremely long combining sequence. (Also reordrant under normalization.)\n\n// The following verifies that sources haven’t been normalized, which would reduce the test’s effectiveness.\nvar verify = \"\\u{03C0}\\u{0FB2C}\\u{00B5}\\u{1D11E}\\u{1F1FA}\\u{1F1F3}\\u{1F1EE}\\u{1F1F1}\\u{0078}\\u{0331}\\u{0304}\\u{0331}\\u{0304}\\u{0331}\\u{0304}\\u{0331}\\u{0304}\\u{0331}\\u{0304}\"\nassert(\n complicatedString.unicodeScalars.elementsEqual(verify.unicodeScalars),\n \"\\(complicatedString) ≠ \\(verify)\")\n\nlet package = Package(\n name: complicatedString,\n products: [\n .library(\n name: complicatedString,\n targets: [complicatedString]),\n .executable(name: complicatedString + \"‐tool\", targets: [complicatedString + \"‐tool\"])\n ],\n dependencies: [\n .package(url: \"../UnicodeDependency‐\\(complicatedString)\", from: \"1.0.0\")\n ],\n targets: [\n .target(\n name: complicatedString,\n dependencies: [.product(name: \"UnicodeDependency‐\\(complicatedString)\")]),\n .target(\n name: complicatedString + \"‐tool\",\n dependencies: [.target(name: complicatedString)]),\n .testTarget(\n name: complicatedString + \"Tests\",\n dependencies: [.target(name: complicatedString)]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/README.md", "content": "# Unicode\n\nThis fixture makes extensive use of exotic Unicode. While deliberately trying to break a as many common false assumptions as possible, *this is a valid package*, and clients are encouraged to test their functionality with it. A tool that successfully handles this package is unlikely to encounter problems with any real‐world package in any human language.\n\nThe neighbouring package `UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄` must be placed next this package and tagged with version 1.0.0. (This is necessary to use Unicode in dependency URLs in this package’s manifest.)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Sources/πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄/πשּׁµ𝄞🇺🇳x̱̱̱̱̱̄̄̄̄̄.swift", "content": "public struct πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄ {\n public init() {}\n public var πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄ = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Sources/πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄‐tool/main.swift", "content": "import π_µ_____x__________\n\nprint(πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄().πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Tests/LinuxMain.swift", "content": "import XCTest\n\nimport π_µ_____x__________Tests\n\nvar tests = [XCTestCaseEntry]()\ntests += π_µ_____x__________Tests.__allTests()\n\nXCTMain(tests)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Tests/πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests/XCTestManifests.swift", "content": "#if !canImport(ObjectiveC)\nimport XCTest\n\nextension πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests {\n // DO NOT MODIFY: This is autogenerated, use:\n // `swift test --generate-linuxmain`\n // to regenerate.\n static let __allTests__πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests = [\n (\"testπשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\", testπשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄),\n ]\n}\n\npublic func __allTests() -> [XCTestCaseEntry] {\n return [\n testCase(πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests.__allTests__πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests),\n ]\n}\n#endif\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Tests/πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests/πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests.swift", "content": "import XCTest\n\n// TODO: - Can imports be made less ugly? (SR‐10839)\n//@testable import πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\n@testable import π_µ_____x__________\n// (These characters all work for identifiers. See below.)\n\nfinal class πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄Tests: XCTestCase {\n \n func testπשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄() {\n XCTAssertEqual(πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄().πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄, \"Hello, World!\")\n }\n}\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Utilities/SomeOtherPackage/Package.swift", "content": "// swift-tools-version:5.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"SomeOtherPackage\",\n dependencies: [\n .package(path: \"../../\"),\n ],\n targets: [\n .target(\n name: \"SomeOtherPackage\",\n dependencies: [\"πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\"]),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Utilities/SomeOtherPackage/README.md", "content": "# SomeOtherPackage\n\nThis nested utility package refers back to the main repository as a local dependency.\n\nIf client tools accidentally pick this package up as part of the main repository package, dependency resolution could become circular or otherwise problematic.\n\n(Prior to direct Xcode support for packages, this repository structure was a common way of hiding executable utilities from `generate-xcodeproj`, so that the main package would still be viable for iOS.)\n" }, { "path": "Fixtures/Miscellaneous/Unicode/Utilities/SomeOtherPackage/Sources/SomeOtherPackage/main.swift", "content": "print(\"Hello, world!\")\n" }, { "path": "Fixtures/Miscellaneous/UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄/Package.swift", "content": "// swift-tools-version:5.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\",\n products: [\n .library(\n name: \"UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\",\n targets: [\"UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\"]),\n ],\n targets: [\n .target(\n name: \"UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄/README.md", "content": "# UnicodeDependency‐πשּׁµ𝄞🇺🇳x̱̱̱̱̱̄̄̄̄̄\n\nA description of this package.\n" }, { "path": "Fixtures/Miscellaneous/UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄/Sources/UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄/UnicodeDependency‐πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄.swift", "content": "struct UnicodeDependency_UnicodeDependency_πשּׁµ𝄞🇺🇳🇮🇱x̱̱̱̱̱̄̄̄̄̄ {\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/A/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"A\",\n products: [\n .executable(name: \"aexec\", targets: [\"ATarget\"])\n ],\n\tdependencies: [\n\t\t.package(url: \"../B\", from: \"1.0.0\"),\n\t\t.package(url: \"../C\", from: \"1.0.0\")\n\t],\n targets: [\n .target(name: \"ATarget\", dependencies: [\n\t\t\t.product(name: \"BLibrary\")\n\t\t])\n ])\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/A/Sources/ATarget/main.swift", "content": "import BTarget1\n\nBTarget1()\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/B/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"B\",\n products: [\n .library(name: \"BLibrary\", targets: [\"BTarget1\"]),\n\t\t.executable(name: \"bexec\", targets: [\"BTarget2\"])\n ],\n targets: [\n .target(name: \"BTarget1\", dependencies: []),\n\t\t.target(name: \"BTarget2\", dependencies: [])\n ])\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/B/Sources/BTarget1/BTarget1.swift", "content": "public struct BTarget1 {\n\tpublic init() {}\n}\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/B/Sources/BTarget2/main.swift", "content": "print(\"BTarget2\")\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/C/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"C\",\n products: [\n\t\t.executable(name: \"cexec\", targets: [\"CTarget\"])\n ],\n targets: [\n .target(name: \"CTarget\", dependencies: [])\n ])\n" }, { "path": "Fixtures/Miscellaneous/UnreachableTargets/C/Sources/CTarget/main.swift", "content": "print(\"CTarget\")\n" }, { "path": "Fixtures/Miscellaneous/VersionSpecificManifest/Foo.swift", "content": "public func foo() {\n\t{}()\n}\n" }, { "path": "Fixtures/Miscellaneous/VersionSpecificManifest/Package.swift", "content": "// swift-tools-version:6.0\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/VersionSpecificManifest/Package@swift-5.0.swift", "content": "// swift-tools-version:5.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"Foo\", targets: [\"Foo\"]),\n ],\n targets: [\n .target(name: \"Foo\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/WarningWithinFunction/Package.swift", "content": "// swift-tools-version: 5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"app\",\n products: [\n .executable(name: \"app\", targets: [\"app\"])\n ],\n targets: [\n .executableTarget(\n name: \"app\",\n path: \"./\"\n )\n ]\n)\n" }, { "path": "Fixtures/Miscellaneous/WarningWithinFunction/app.swift", "content": "@main\nstruct App {\n public static func main() {\n var myvariable = 0\n }\n}\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps1/AppPkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"AppPkg\",\n dependencies: [\n .package(path: \"../UtilsPkg\"),\n ],\n targets: [\n .executableTarget(\n name: \"App\",\n dependencies: [\n \"Utils\",\n .product(name: \"Utils\",\n package: \"UtilsPkg\",\n moduleAliases: [\"Utils\": \"GameUtils\"])\n ],\n path: \"./Sources/App\"),\n .target(\n name: \"Utils\",\n dependencies: [],\n path: \"./Sources/Utils\"\n )\n ]\n )\n \n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps1/AppPkg/Sources/App/main.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport Utils\nimport GameUtils\n\nUtils.echoModule()\n\nlet level = LevelDetector.detect(for: \"TestUser\")\nprint(level)\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps1/AppPkg/Sources/Utils/FileUtils.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\npublic func echoModule() {\n print(\"Utils\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps1/UtilsPkg/Package.swift", "content": "// swift-tools-version:5.5\nimport PackageDescription\n\nlet package = Package(\n name: \"UtilsPkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps1/UtilsPkg/Sources/Utils/FileUtils.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\npublic struct LevelDetector: Equatable {\n public static func detect(for user: String) -> Int {\n return user.count\n }\n}\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/Apkg/Package.swift", "content": "// swift-tools-version:5.7\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Apkg\",\n products: [\n .executable(name: \"AApp\", targets: [\"AApp\"]),\n .library(name: \"Utils\", type: .dynamic, targets: [\"Utils\"]),\n ],\n targets: [\n .executableTarget(name: \"AApp\", dependencies: [\"Utils\"]),\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/Apkg/Sources/AApp/main.swift", "content": "import Utils\n\nutilsInA()\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/Apkg/Sources/Utils/File.swift", "content": "public func utilsInA() {\n print(\"Utils in A\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/AppPkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"AppPkg\",\n dependencies: [\n .package(path: \"../Apkg\"),\n .package(path: \"../Bpkg\"),\n ],\n targets: [\n .executableTarget(\n name: \"App\",\n dependencies: [\n .product(name: \"Utils\",\n package: \"Apkg\",\n moduleAliases: [\"Utils\": \"AUtils\"]\n ),\n .product(name: \"Utils\",\n package: \"Bpkg\",\n moduleAliases: [\"Utils\": \"BUtils\"]\n )\n ]\n ),\n ]\n)\n\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/AppPkg/Sources/App/main.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport AUtils\nimport BUtils\n\nutilsInA()\nutilsInB()\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/Bpkg/Package.swift", "content": "// swift-tools-version:5.7\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bpkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/DirectDeps2/Bpkg/Sources/Utils/File.swift", "content": "public func utilsInB() {\n print(\"Utils in B\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/APkg/Package.swift", "content": "// swift-tools-version:5.7\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"APkg\",\n products: [\n .library(name: \"A\", targets: [\"A\"]),\n ],\n dependencies: [\n .package(path: \"../BPkg\"),\n .package(path: \"../CPkg\"),\n ],\n targets: [\n .target(name: \"A\",\n dependencies: [\n .product(name: \"Utils\",\n package: \"BPkg\",\n moduleAliases: [\"Utils\": \"FooUtils\"]\n ),\n .product(name: \"Utils\",\n package: \"CPkg\",\n moduleAliases: [\"Utils\": \"CarUtils\"]\n ),\n ]),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/APkg/Sources/A/File.swift", "content": "import FooUtils\nimport CarUtils\n\npublic func funcInA() {\n print(\"func in A\")\n utilsInB()\n utilsInC()\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/AppPkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"AppPkg\",\n dependencies: [\n .package(path: \"../APkg\"),\n .package(path: \"../XPkg\"),\n ],\n targets: [\n .executableTarget(\n name: \"App\",\n dependencies: [\n .product(name: \"A\",\n package: \"APkg\",\n moduleAliases: [\"FooUtils\": \"AFooUtils\"]\n ),\n .product(name: \"X\",\n package: \"XPkg\",\n moduleAliases: [\"Utils\": \"XUtils\", \"FooUtils\": \"XFooUtils\"]\n )\n ]),\n ]\n)\n\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/AppPkg/Sources/App/main.swift", "content": "import A\nimport X\nimport AFooUtils\nimport CarUtils\nimport XFooUtils\nimport XUtils\n\nfuncInA()\nfuncInX()\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/BPkg/Package.swift", "content": "// swift-tools-version:5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"BPkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/BPkg/Sources/Utils/File.swift", "content": "public func utilsInB() {\n print(\"utils in B\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/CPkg/Package.swift", "content": "// swift-tools-version:5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"CPkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/CPkg/Sources/Utils/File.swift", "content": "public func utilsInC() {\n print(\"utils in C\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/XPkg/Package.swift", "content": "// swift-tools-version:5.7\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"XPkg\",\n products: [\n .library(name: \"X\", targets: [\"X\"]),\n ],\n dependencies: [\n .package(path: \"../YPkg\"),\n ],\n targets: [\n .target(name: \"X\",\n dependencies: [\n \"Utils\",\n .product(name: \"Utils\",\n package: \"YPkg\",\n moduleAliases: [\"Utils\": \"FooUtils\"]\n ),\n ]),\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/XPkg/Sources/Utils/File.swift", "content": "public func utilsInX() {\n print(\"utils in X\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/XPkg/Sources/X/File.swift", "content": "import Utils\nimport FooUtils\n\npublic func funcInX() {\n print(\"func in X\")\n utilsInX()\n utilsInY()\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/YPkg/Package.swift", "content": "// swift-tools-version:5.6\nimport PackageDescription\n\nlet package = Package(\n name: \"YPkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: [])\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps1/YPkg/Sources/Utils/File.swift", "content": "public func utilsInY() {\n print(\"utils in Y\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Apkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"Apkg\",\n products: [\n .library(name: \"A\", targets: [\"A\"]),\n ],\n dependencies: [\n .package(path: \"../Bpkg\"),\n .package(path: \"../Cpkg\"),\n ],\n targets: [\n .target(name: \"A\",\n dependencies: [\n .product(name: \"Utils\",\n package: \"Bpkg\",\n moduleAliases: [\"Utils\": \"BUtils\"]),\n .product(name: \"Utils\",\n package: \"Cpkg\",\n moduleAliases: [\"Utils\": \"CUtils\"]),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Apkg/Sources/A/File.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport BUtils\nimport CUtils\n\npublic func funcA() {\n print(\"func A\")\n BUtils.funcB()\n CUtils.funcC()\n}\n\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/AppPkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"AppPkg\",\n dependencies: [\n .package(path: \"../Apkg\"),\n .package(path: \"../Xpkg\"),\n ],\n targets: [\n .executableTarget(\n name: \"App\",\n dependencies: [\n .product(name: \"A\",\n package: \"Apkg\"\n ),\n .product(name: \"Utils\",\n package: \"Xpkg\",\n moduleAliases: [\"Utils\": \"XUtils\"]\n ),\n ]),\n ]\n)\n\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/AppPkg/Sources/App/main.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nimport A\nimport XUtils\n\nprint(\"START\")\n\nfuncA()\nfuncX()\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Bpkg/Package.swift", "content": "// swift-tools-version:5.7\nimport PackageDescription\n\nlet package = Package(\n name: \"Bpkg\",\n products: [\n .library(name: \"Utils\", type: .static, targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\",\n dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Bpkg/Sources/Utils/File.swift", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\npublic func funcB() {\n print(\"func B\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Cpkg/Package.swift", "content": "// swift-tools-version: 5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Cpkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Cpkg/Sources/Utils/File.swift", "content": "public func funcC() {\n print(\"func C\")\n}\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Xpkg/Package.swift", "content": "// swift-tools-version: 5.5\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Xpkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: []),\n ]\n)\n" }, { "path": "Fixtures/ModuleAliasing/NestedDeps2/Xpkg/Sources/Utils/File.swift", "content": "public func funcX() {\n print(\"func X\")\n}\n" }, { "path": "Fixtures/ModuleMaps/Direct/App/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"App\",\n dependencies: [\n .package(url: \"../CFoo\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"App\", path: \"./\"),\n ]\n)\n" }, { "path": "Fixtures/ModuleMaps/Direct/App/main.swift", "content": "import CFoo\n\nprint(foo())\n" }, { "path": "Fixtures/ModuleMaps/Direct/CFoo/C/foo.c", "content": "int foo() {\n return 123;\n}\n" }, { "path": "Fixtures/ModuleMaps/Direct/CFoo/C/foo.h", "content": "int foo();\n" }, { "path": "Fixtures/ModuleMaps/Direct/CFoo/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"CFoo\"\n)\n" }, { "path": "Fixtures/ModuleMaps/Direct/CFoo/module.modulemap", "content": "module CFoo {\n header \"C/foo.h\"\n link \"foo\"\n export *\n}\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageA/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"packageA\",\n dependencies: [\n .package(url: \"../packageB\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"packageA\", dependencies: [\"packageB\"], path: \"Sources\"),\n ]\n)\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageA/Sources/main.swift", "content": "/**\n * Copyright IBM Corporation 2016\n * Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n **/\n\nimport y\n\nlet myY = Y()\nprint(\"calling Y.bar()\")\nmyY.bar()\n\n/*\nimport x\n\nlet myX = X()\nprint(\"calling X.foo()\")\nmyX.foo()\n*/\n\t\t\t\t \n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageB/.gitignore", "content": ".build\nPackages\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageB/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"packageB\",\n products: [\n .library(name: \"packageB\", targets: [\"y\"]),\n ],\n dependencies: [\n .package(url: \"../packageC\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"y\", dependencies: [\"packageC\"]),\n ]\n)\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageB/Sources/y/y.swift", "content": "/**\n * Copyright IBM Corporation 2016\n * Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n **/\n\nimport x\n\npublic class Y {\n public init() {}\n public func bar() {\n print(\"Y.bar() called\")\n let myX = X()\n myX.foo()\n }\n}\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageC/.gitignore", "content": ".build\nPackages\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageC/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"packageC\",\n products: [\n .library(name: \"packageC\", targets: [\"x\"]),\n ],\n dependencies: [\n .package(url: \"../packageD\", from: \"1.0.0\"),\n ],\n targets: [\n .target(name: \"x\", dependencies: [\"CFoo\"]),\n ]\n)\n" }, { "path": "Fixtures/ModuleMaps/Transitive/packageC/Sources/x/x.swift", "content": "/**\n * Copyright IBM Corporation 2016\n * Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors\n\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n * http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n **/\n\nimport CFoo\n\npublic class X {\n public init() {}\n public func foo() {\n print(\"X.foo() called\")\n let jpegData = CFoo.foo()\n print(jpegData)\n }\n}\n" }, { "path": "Fixtures/PIFBuilder/BasicExecutable/Package.swift", "content": "// swift-tools-version: 6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"BasicExecutable\",\n targets: [\n .executableTarget(\n name: \"Executable\",\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/BasicExecutable/Sources/BasicExecutable/BasicExecutable.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\n@main\nstruct BasicExecutable {\n static func main() {\n print(\"Hello, world!\")\n }\n}\n" }, { "path": "Fixtures/PIFBuilder/CCPackage/Package.swift", "content": "// swift-tools-version: 6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"CCPackage\",\n products: [\n .library(name: \"CCTarget\", type: .static, targets: [\"CCTarget\"]),\n ],\n targets: [\n .target(name: \"CCTarget\", ),\n .executableTarget(name: \"executable\", dependencies: [\"CCTarget\"]),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/CCPackage/Sources/CCTarget/include/test.h", "content": "\n#include " }, { "path": "Fixtures/PIFBuilder/CCPackage/Sources/CCTarget/test.cc", "content": "\n#include \n" }, { "path": "Fixtures/PIFBuilder/CCPackage/Sources/executable/executable.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\n@main\nstruct Executable {\n static func main() {\n print(\"Hello, world!\")\n }\n}\n" }, { "path": "Fixtures/PIFBuilder/ConditionalBuildSettings/Package.swift", "content": "// swift-tools-version: 6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ConditionalBuildSettings\",\n products: [\n .library(\n name: \"ConditionalBuildSettings\",\n type: .dynamic,\n targets: [\"ConditionalBuildSettings\"]\n ),\n ],\n targets: [\n .target(\n name: \"ConditionalBuildSettings\",\n linkerSettings: [\n .unsafeFlags([\"-Xlinker\", \"-interposable\"], .when(configuration: .debug)),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/ConditionalBuildSettings/Sources/ConditionalBuildSettings/ConditionalBuildSettings.swift", "content": "public func placeholder() {}\n" }, { "path": "Fixtures/PIFBuilder/Library/.gitignore", "content": ".DS_Store\n/.build\n/Packages\nxcuserdata/\nDerivedData/\n.swiftpm/configuration/registries.json\n.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata\n.netrc\n" }, { "path": "Fixtures/PIFBuilder/Library/Package.swift", "content": "// swift-tools-version: 6.2\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Library\",\n products: [\n // Products define the executables and libraries a package produces, making them visible to other packages.\n .library(\n name: \"LibraryAuto\",\n targets: [\"Library\"]\n ),\n .library(\n name: \"LibraryStatic\",\n type: .static,\n targets: [\"Library\"]\n ),\n .library(\n name: \"LibraryDynamic\",\n type: .dynamic,\n targets: [\"Library\"]\n ),\n ],\n targets: [\n // Targets are the basic building blocks of a package, defining a module or a test suite.\n // Targets can depend on other targets in this package and products from dependencies.\n .target(\n name: \"Library\"\n ),\n .testTarget(\n name: \"LibraryTests\",\n dependencies: [\"Library\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/Library/Sources/Library/Library.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n" }, { "path": "Fixtures/PIFBuilder/Library/Tests/LibraryTests/LibraryTests.swift", "content": "import Testing\n@testable import Library\n\n@Test func example() async throws {\n // Write your test here and use APIs like `#expect(...)` to check expected conditions.\n}\n" }, { "path": "Fixtures/PIFBuilder/PackageWithSDKSpecialization/Package.swift", "content": "// swift-tools-version: 6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PackageWithSDKSpecialization\",\n platforms: [ .macOS(\"10.15.foo\") ],\n products: [\n .library(\n name: \"PackageWithSDKSpecialization\",\n targets: [\"PackageWithSDKSpecialization\"]),\n ],\n targets: [\n .target(\n name: \"PackageWithSDKSpecialization\",\n dependencies: []\n ),\n .target(\n name: \"Executable\",\n dependencies: [\"PackageWithSDKSpecialization\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/PackageWithSDKSpecialization/Sources/Executable/main.swift", "content": "print(\"Hello, world!\")\n" }, { "path": "Fixtures/PIFBuilder/PackageWithSDKSpecialization/Sources/PackageWithSDKSpecialization/PackageWithSDKSpecialization.swift", "content": "struct PackageWithSDKSpecialization {\n var text = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/PIFBuilder/Simple/.gitignore", "content": ".DS_Store\n/.build\n/Packages\nxcuserdata/\nDerivedData/\n.swiftpm/configuration/registries.json\n.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata\n.netrc\n" }, { "path": "Fixtures/PIFBuilder/Simple/Package.swift", "content": "// swift-tools-version: 6.2\n// The swift-tools-version declares the minimum version of Swift required to build this package.\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Simple\",\n products: [\n // Products define the executables and libraries a package produces, making them visible to other packages.\n .library(\n name: \"Simple\",\n targets: [\"Simple\"]\n ),\n ],\n targets: [\n // Targets are the basic building blocks of a package, defining a module or a test suite.\n // Targets can depend on other targets in this package and products from dependencies.\n .target(\n name: \"Simple\"\n ),\n .testTarget(\n name: \"SimpleTests\",\n dependencies: [\"Simple\"]\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/Simple/Sources/Simple/Simple.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\npublic struct Person {\n public let name: String\n\n public init(name: String) {\n self.name = name\n }\n}\nextension Person: CustomStringConvertible {\n public var description: String {\n return name\n }\n}\n\npublic func greet(person: Person? = nil) -> String {\n let name = if let person {\n person.name\n } else {\n \"World\"\n }\n\n return \"Hello, \\(name)!\"\n}\n" }, { "path": "Fixtures/PIFBuilder/Simple/Tests/SimpleTests/SimpleTests.swift", "content": "import Testing\nimport XCTest\n\nimport Simple\n\n\nfinal public class XCTesting: XCTestCase {\n func testGreetWithEmptyArgument() {\n let actual = greet()\n XCTAssertEqual(actual, \"Hello, World!\")\n }\n\n func testGreetWithNonEmptyArgument() {\n let name = \"MyName\"\n let person = Person(name: name)\n let actual = greet(person: person)\n XCTAssertEqual(actual, \"Hello, \\(name)!\")\n }\n}\n\n@Suite\nstruct STTestTests {\n @Test(\"STTest tests\")\n func testGreetWithEmptyArgument() {\n let actual = greet()\n #expect(actual == \"Hello, World!\")\n }\n\n @Test(\"STTest tests\")\n func testGreetWithNonEmptyArgument() {\n let name = \"MyName\"\n let person = Person(name: name)\n let actual = greet(person: person)\n #expect(actual == \"Hello, \\(name)!\")\n }\n}\n" }, { "path": "Fixtures/PIFBuilder/UnknownPlatforms/Package.swift", "content": "// swift-tools-version: 6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"UnknownPlatforms\",\n targets: [\n .executableTarget(\n name: \"UnknownPlatforms\",\n swiftSettings: [\n .define(\"FOO\", .when(platforms: [.custom(\"DoesNotExist\")])),\n\t\t .define(\"BAR\", .when(platforms: [.linux])),\n .define(\"BAZ\", .when(platforms: [.macOS])),\n ],\n ),\n ]\n)\n" }, { "path": "Fixtures/PIFBuilder/UnknownPlatforms/Sources/UnknownPlatforms/UnknownPlatforms.swift", "content": "// The Swift Programming Language\n// https://docs.swift.org/swift-book\n\n@main\nstruct UnknownPlatforms {\n static func main() {\n print(\"Hello, world!\")\n }\n}\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Dep/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Dep\",\n products: [\n .library(\n name: \"MyDynamicLibrary\",\n type: .dynamic,\n targets: [\"MyDynamicLibrary\"]\n ),\n .executable(\n name: \"MySupportExecutable\",\n targets: [\"MySupportExecutable\"]\n )\n ],\n targets: [\n .target(\n name: \"MyDynamicLibrary\"\n ),\n .executableTarget(\n name: \"MySupportExecutable\",\n dependencies: [\"MyDynamicLibrary\"]\n )\n ]\n)\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Dep/Sources/MyDynamicLibrary/Dep.swift", "content": "public func sayHello() {\n print(\"hello!\")\n}\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Dep/Sources/MySupportExecutable/exe.swift", "content": "import MyDynamicLibrary\n\n@main struct Entry {\n static func main() {\n print(\"running support tool\")\n sayHello()\n }\n}\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Package.swift", "content": "// swift-tools-version: 6.0\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PartiallyUnusedDependency\",\n products: [\n .executable(\n name: \"MyExecutable\",\n targets: [\"MyExecutable\"]\n ),\n ],\n dependencies: [\n .package(path: \"Dep\")\n ],\n targets: [\n .executableTarget(\n name: \"MyExecutable\",\n dependencies: [.product(name: \"MyDynamicLibrary\", package: \"Dep\")]\n ),\n .plugin(\n name: \"dump-artifacts-plugin\",\n capability: .command(\n intent: .custom(verb: \"dump-artifacts-plugin\", description: \"Dump Artifacts\"),\n permissions: []\n )\n )\n ]\n)\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Plugins/dump-artifacts-plugin.swift", "content": "import PackagePlugin\n\n@main\nstruct DumpArtifactsPlugin: CommandPlugin {\n func performCommand(\n context: PluginContext,\n arguments: [String]\n ) throws {\n do {\n var parameters = PackageManager.BuildParameters()\n parameters.configuration = .debug\n parameters.logging = .concise\n let result = try packageManager.build(.all(includingTests: false), parameters: parameters)\n print(\"succeeded: \\(result.succeeded)\")\n for artifact in result.builtArtifacts {\n print(\"artifact-path: \\(artifact.path.string)\")\n print(\"artifact-kind: \\(artifact.kind)\")\n }\n }\n catch {\n print(\"error from the plugin host: \\\\(error)\")\n }\n }\n}\n" }, { "path": "Fixtures/PartiallyUnusedDependency/Sources/MyExecutable/PartiallyUnusedDependency.swift", "content": "import MyDynamicLibrary\n\n@main struct Entry {\n static func main() {\n print(\"Hello, world!\")\n sayHello()\n }\n}\n" }, { "path": "Fixtures/Resources/EmbedInCodeSimple/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"EmbedInCodeSimple\",\n targets: [\n .executableTarget(name: \"EmbedInCodeSimple\", resources: [.embedInCode(\"best.txt\")]),\n ]\n)\n" }, { "path": "Fixtures/Resources/EmbedInCodeSimple/Sources/EmbedInCodeSimple/best.txt", "content": "hello world\n" }, { "path": "Fixtures/Resources/EmbedInCodeSimple/Sources/EmbedInCodeSimple/main.swift", "content": "import Foundation\n\nprint(\"\\(String(decoding: Data(PackageResources.best_txt), as: UTF8.self))\")\n" }, { "path": "Fixtures/Resources/FoundationlessClient/AppPkg/Package.swift", "content": "// swift-tools-version:999.0\nimport PackageDescription\n\nlet package = Package(\n name: \"AppPkg\",\n dependencies: [\n .package(path: \"../UtilsPkg\"),\n ],\n targets: [\n .executableTarget(\n name: \"App\",\n dependencies: [\n .product(name: \"Utils\", package: \"UtilsPkg\")\n ],\n path: \"./Sources/App\"),\n ]\n)\n" }, { "path": "Fixtures/Resources/FoundationlessClient/AppPkg/Sources/App/main.swift", "content": "import Utils\n// Note the lack of 'import Foundation'.\n// The purpose of this fixture is to test that the following line of code\n// expectedly *doesn't* compile:\nprint(FooUtils.foo.trimmingCharacters(in: .whitespaces))\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsPkg/Package.swift", "content": "// swift-tools-version:999.0\nimport PackageDescription\n\nlet package = Package(\n name: \"UtilsPkg\",\n products: [\n .library(name: \"Utils\", targets: [\"Utils\"]),\n ],\n targets: [\n .target(name: \"Utils\", dependencies: [], resources: [\n .copy(\"foo.txt\"),\n ]),\n ]\n)\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsPkg/Sources/Utils/FooUtils.swift", "content": "@frozen\npublic enum FooUtils { }\n\nextension FooUtils {\n public static let foo: String = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsPkg/Sources/Utils/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsWithFoundationPkg/Package.swift", "content": "// swift-tools-version:5.8\nimport PackageDescription\n\n// This package acts as a regression test for the FoundationlessPackages to\n// assert that Swift targets with resources are not affected by using\n// `@_implementationOnly import Foundation` in the generated resource accessor.\nlet package = Package(\n name: \"UtilsWithFoundationPkg\",\n targets: [\n .target(\n name: \"UtilsWithFoundationPkg\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n )\n ]\n)\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsWithFoundationPkg/Sources/UtilsWithFoundationPkg/FooUtils.swift", "content": "import Foundation\n\n@frozen\npublic enum FooUtils { }\n\nextension FooUtils {\n public static let foo: String = \"Hello, World!\"\n}\n" }, { "path": "Fixtures/Resources/FoundationlessClient/UtilsWithFoundationPkg/Sources/UtilsWithFoundationPkg/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Localized/Package.swift", "content": "// swift-tools-version:5.3\nimport PackageDescription\n\nlet package = Package(\n name: \"Localized\",\n defaultLocalization: \"es\",\n targets: [\n .target(name: \"exe\"),\n ]\n)\n" }, { "path": "Fixtures/Resources/Localized/Sources/exe/Resources/de.lproj/Localizable.strings", "content": "\"hello_world\" = \"Hallo Welt!\";\n" }, { "path": "Fixtures/Resources/Localized/Sources/exe/Resources/es.lproj/Localizable.strings", "content": "\"hello_world\" = \"¡Hola Mundo!\";\n" }, { "path": "Fixtures/Resources/Localized/Sources/exe/Resources/fr.lproj/Localizable.strings", "content": "\"hello_world\" = \"Bonjour le monde !\";\n" }, { "path": "Fixtures/Resources/Localized/Sources/exe/main.swift", "content": "import Foundation\n\nfunc localizationBundle(forLanguage language: String) -> Bundle? {\n\tif let path = Bundle.module.path(forResource: language, ofType: \"lproj\") {\n\t\treturn Bundle(path: path)\n\t} else {\n\t\treturn nil\n\t}\n}\n\n// Spanish localization (based on defaultLocalization).\nprint(NSLocalizedString(\"hello_world\", bundle: .module, comment: \"\"))\n\n// German localization.\nif let germanBundle = localizationBundle(forLanguage: \"de\") {\n\tprint(NSLocalizedString(\"hello_world\", bundle: germanBundle, comment: \"\"))\n}\n\n// French localization.\nif let frenchBundle = localizationBundle(forLanguage: \"fr\") {\n\tprint(NSLocalizedString(\"hello_world\", bundle: frenchBundle, comment: \"\"))\n}\n" }, { "path": "Fixtures/Resources/Moved/Package.swift", "content": "// swift-tools-version:5.3\nimport PackageDescription\n\nlet package = Package(\n name: \"Resources\",\n targets: [\n .target(\n name: \"SwiftyResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n\n .target(\n name: \"SeaResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Resources/Moved/Sources/SeaResource/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Moved/Sources/SeaResource/main.m", "content": "#import \n\nint main(int argc, const char * argv[]) {\n @autoreleasepool {\n NSBundle *bundle = SWIFTPM_MODULE_BUNDLE;\n NSString *foo = [bundle pathForResource:@\"foo\" ofType:@\"txt\"];\n NSData *data = [NSFileManager.defaultManager contentsAtPath:foo];\n NSString *contents = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];\n printf(\"%s\", contents.UTF8String);\n }\n return 0;\n}\n" }, { "path": "Fixtures/Resources/Moved/Sources/SwiftyResource/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Moved/Sources/SwiftyResource/main.swift", "content": "import Foundation\n\nlet bundle = Bundle.module\n\nlet foo = bundle.path(forResource: \"foo\", ofType: \"txt\")!\nlet contents = FileManager.default.contents(atPath: foo)!\nprint(String(data: contents, encoding: .utf8)!, terminator: \"\")\n" }, { "path": "Fixtures/Resources/ResourceRules/Package.swift", "content": "// swift-tools-version: 5.9\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ResourceRules\",\n targets: [\n .executableTarget(name: \"ResourceRules\", resources: [\n\t\t.copy(\"CopiedAssets.xcassets\"),\n\t\t.process(\"ProcessedAssets.xcassets\")\n\t]),\n ]\n)\n" }, { "path": "Fixtures/Resources/ResourceRules/Sources/ResourceRules/CopiedAssets.xcassets/Contents.json", "content": "{\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Resources/ResourceRules/Sources/ResourceRules/CopiedAssets.xcassets/pixel.imageset/Contents.json", "content": "{\n \"images\" : [\n {\n \"filename\" : \"pixel.png\",\n \"idiom\" : \"universal\",\n \"scale\" : \"1x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"2x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"3x\"\n }\n ],\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Resources/ResourceRules/Sources/ResourceRules/ProcessedAssets.xcassets/Contents.json", "content": "{\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Resources/ResourceRules/Sources/ResourceRules/ProcessedAssets.xcassets/processedpixel.imageset/Contents.json", "content": "{\n \"images\" : [\n {\n \"filename\" : \"processedpixel.png\",\n \"idiom\" : \"universal\",\n \"scale\" : \"1x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"2x\"\n },\n {\n \"idiom\" : \"universal\",\n \"scale\" : \"3x\"\n }\n ],\n \"info\" : {\n \"author\" : \"xcode\",\n \"version\" : 1\n }\n}\n" }, { "path": "Fixtures/Resources/ResourceRules/Sources/ResourceRules/main.swift", "content": "import Foundation\nimport AppKit\n\n@main\nstruct Entry {\n public static func main() {\n guard Bundle.module.url(forResource: \"CopiedAssets\", withExtension: \"xcassets\") != nil else {\n print(\"Failed to lookup unprocessed asset catalog\")\n return\n }\n guard Bundle.module.image(forResource: \"processedpixel\") != nil else {\n print(\"Failed to lookup processed asset from catalog\")\n return\n }\n print(\"succeeded\")\n }\n}\n" }, { "path": "Fixtures/Resources/Simple/Package.swift", "content": "// swift-tools-version:5.3\nimport PackageDescription\n\nlet package = Package(\n name: \"Resources\",\n targets: [\n .target(\n name: \"SwiftyResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n\n .target(\n name: \"SeaResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n\n .target(\n name: \"ClangResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n\n .testTarget(\n name: \"ClangResourceTests\",\n dependencies: [\"ClangResource\"]\n ),\n\n .target(\n name: \"CPPResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n\n .target(\n name: \"MixedClangResource\",\n resources: [\n .copy(\"foo.txt\"),\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Resources/Simple/Sources/CPPResource/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Simple/Sources/CPPResource/main.mm", "content": "#import \n\nint main(int argc, const char * argv[]) {\n @autoreleasepool {\n NSBundle *bundle = SWIFTPM_MODULE_BUNDLE;\n NSString *foo = [bundle pathForResource:@\"foo\" ofType:@\"txt\"];\n NSData *data = [NSFileManager.defaultManager contentsAtPath:foo];\n NSString *contents = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];\n printf(\"%s\", contents.UTF8String);\n }\n return 0;\n}\n" }, { "path": "Fixtures/Resources/Simple/Sources/ClangResource/Package.m", "content": "#import \n\n#import \"Package.h\"\n\n@implementation Package\n\n+ (NSBundle *)resourceBundle {\n return SWIFTPM_MODULE_BUNDLE;\n}\n\n@end\n" }, { "path": "Fixtures/Resources/Simple/Sources/ClangResource/foo.txt", "content": "\n" }, { "path": "Fixtures/Resources/Simple/Sources/ClangResource/include/Package.h", "content": "#import \n\n@interface Package : NSObject\n\n+ (NSBundle *)resourceBundle;\n\n@end\n" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/Foo.m", "content": "#import \n\n#import \"Foo.h\"\n\n@implementation Foo\n@end\n" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/bar.c", "content": "#include \"bar.h\"\n" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/bar.h", "content": "#ifndef foo_h\n#define foo_h\n\n#include \n\n#endif /* foo_h */\n" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/baz.S", "content": "" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/foo.txt", "content": "" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/include/Foo.h", "content": "#import \n\n@interface Foo : NSObject\n@end\n" }, { "path": "Fixtures/Resources/Simple/Sources/MixedClangResource/qux.cpp", "content": "" }, { "path": "Fixtures/Resources/Simple/Sources/SeaResource/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Simple/Sources/SeaResource/main.m", "content": "#import \n\nint main(int argc, const char * argv[]) {\n @autoreleasepool {\n NSBundle *bundle = SWIFTPM_MODULE_BUNDLE;\n NSString *foo = [bundle pathForResource:@\"foo\" ofType:@\"txt\"];\n NSData *data = [NSFileManager.defaultManager contentsAtPath:foo];\n NSString *contents = [[NSString alloc] initWithData:data encoding:NSUTF8StringEncoding];\n printf(\"%s\", contents.UTF8String);\n }\n return 0;\n}\n" }, { "path": "Fixtures/Resources/Simple/Sources/SwiftyResource/foo.txt", "content": "foo\n" }, { "path": "Fixtures/Resources/Simple/Sources/SwiftyResource/main.swift", "content": "import Foundation\n\nlet bundle = Bundle.module\n\nlet foo = bundle.path(forResource: \"foo\", ofType: \"txt\")!\nlet contents = FileManager.default.contents(atPath: foo)!\nprint(String(data: contents, encoding: .utf8)!, terminator: \"\")\n" }, { "path": "Fixtures/Resources/Simple/Tests/ClangResourceTests/ClangResourceTests.m", "content": "#import \n\n@import ClangResource;\n\n@interface ClangResourceTests : XCTestCase\n@end\n\n@implementation ClangResourceTests\n\n- (void)testResourceBundleIsNonNil {\n XCTAssertNotNil([Package resourceBundle]);\n}\n\n@end\n" }, { "path": "Fixtures/Signing/Certificates/Test_ec_key.pem", "content": "-----BEGIN EC PRIVATE KEY-----\nMHcCAQEEIGfOkQcQq6oTC06KkGMVBAr2MiYFRaLo4/wKdNBpIjhnoAoGCCqGSM49\nAwEHoUQDQgAE6SjFVQRtU/+ywvxslaVsl+iZf65YgkQShuxsbAbNJBTVkEkMGyNL\n8nbaj6B4Jskjo1loNPLirNE7mKeTLYbrcw==\n-----END EC PRIVATE KEY-----\n" }, { "path": "Fixtures/Signing/Certificates/Test_rsa_key.pem", "content": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEA13XgJ9lIhR2LefNxQdo3tVrbXEZ3o4T8+MgteVJVohbPMypf\nyGgGlJJ/r7+hhL/klsPDyR4SAtgLZUGFVt3WzGMolGyV11VUTTFHMWZ10tcgrUmR\n5wg2n5E59FsJf3y3WTs5CpD2tM8igWyAUOyS/MWvhgnMtvBG8I4Mg9xyyWi/GW3g\nPLXfnyULW/v2Zg+yG9j+/Bbpx+AP8TCvWoiPyiLEZ/DKZK2kC+8mkwOtHYDMkBO5\n2nIrxopB42VUWYBfAzHm0M2XlEuc26PVojqno2ht5WU486uJXzWILvW3zFdlNDF/\nSLeqQy1mNLRt5/An6la7e3sjOcuI1W2Qe7dkrwIDAQABAoIBAES+eUx9iSPfr1az\nk5k9NLUKTh785MMpdUUzKT8iQ+w5dtaOWI0qk57ntxGuBKzERPzNbTRIAdsib1BZ\nPV/f297ObG4ezxgrQ4B1jo92b3Vb6jMf3AtolXUH8wPB4B/q/Nzdhm+WnQBHbmz4\n31/ye1tm/3+2tLhRpXCvAdM4jO8xhJlH+Pxg20fliAuiJ+ggSL56CyBR4kg80KtA\nomeGB1DOVFd23aDO/79Mii/2tf6EpmVFB/4zBkPHOH3zucwt8XUttwBeOcGdIbP+\nCiU9VdZmG0XOJfC3apAXf9YwU3WVbmbvUWSwt6iHGZD4AuKY2R0ECTZnYS8ThDhd\nZwPXzCECgYEA6xe9MpBCIVRK51Hb083mDg16UjRvPJA4T8w9xFg4UtAwe/u3CC67\n4fAOSe0P3NtsXhcQFby7PEJwoeo2Hn6hUifxVMsKWmHb+FCg+CG/oBSwRKCa5BwG\nWpJ0jEt6KHZf0u+b/N1aOjVi/9tMrsHXFV3s2Gm9LQqA8u8izshDqakCgYEA6p8t\nKVK2mA+JjvSGyR6WfpVZ1OIi6CEEUhRU3aNHRB2zPf6J3PQLjz+Ad50BCVHXQSy/\naG3LpR44eUu5Q9AmTwDr8eiC8AT6uyE19zJHbK//E40Bn6khQvtymwByjav/5ZB+\nZAhE7E31eCZO8bqufSlnMNTD0Z8oqB5YR8uDApcCgYAkPcGd5N089Bij9luUGD6p\n1ewQdiLbzEPSEWNIPG1aXtvKkTBTI5k1KGObg98ZJf5btuR05WZb0MY6P7feFZla\n5+ttLevHqSRW8F8QQWugCvBtc/DMz4EvPzqWUiBf0nfNNcDvR1RcetRrKux0WE+G\n7LbRWeOe6OqeCL1t8TN1GQKBgHPaH6m8/w689VbSpc+fu/5Lby0wcL4gt4p0IafD\nnUgkRkLBcn/ZPfABEkV+EGnysJCtMOK2/IzPDGHQo2251YDDWr576lPskYZfks86\nU4x2p0SXJwsYr6Tslp21LduI5/YKUG7Cqo3ovOIUQH0ailihXiP9m6fhqGjDeyIQ\neuOHAoGAfDpntw1HRuk812au430Stl5eaTsH+w1msLLKZOukr6qWc2xFeC3fYPWQ\nBBkyzM3p6Se9FsfHY6LMxrEkz9fSdeVOeHenyUCTMqhqrc6o9f79zIlocsMzVGsK\nXKcULjpf67Igyx12eh3rqAEKwm6PGhbv9pK5/NpuzsP1atArMRg=\n-----END RSA PRIVATE KEY-----\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyMigration/Package.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ExistentialAnyMigration\",\n targets: [\n .target(name: \"Diagnostics\", path: \"Sources\", exclude: [\"Fixed\"]),\n ]\n)\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyMigration/Sources/Fixed/Test.swift", "content": "protocol P {\n}\nprotocol Q {\n}\n\nfunc test1(_: any P) {\n}\n\nfunc test2(_: (any P).Protocol) {\n}\n\nfunc test3() {\n let _: [(any P)?] = []\n}\n\nfunc test4() {\n var x = 42\n}\n\nfunc test5(_: any P & Q) {\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyMigration/Sources/Test.swift", "content": "protocol P {\n}\nprotocol Q {\n}\n\nfunc test1(_: P) {\n}\n\nfunc test2(_: P.Protocol) {\n}\n\nfunc test3() {\n let _: [P?] = []\n}\n\nfunc test4() {\n var x = 42\n}\n\nfunc test5(_: P & Q) {\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithCommonPluginDependencyMigration/Package.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ExistentialAnyMigration\",\n platforms: [\n .macOS(.v10_15)\n ],\n targets: [\n .target(name: \"Library\", dependencies: [\"CommonLibrary\"], plugins: [.plugin(name: \"Plugin\")]),\n .plugin(name: \"Plugin\", capability: .buildTool, dependencies: [\"Tool\"]),\n .executableTarget(name: \"Tool\", dependencies: [\"CommonLibrary\"]),\n .target(name: \"CommonLibrary\"),\n ]\n)\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithCommonPluginDependencyMigration/Plugins/Plugin/Plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main struct Plugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n let tool = try context.tool(named: \"Tool\")\n let output = context.pluginWorkDirectory.appending([\"generated.swift\"])\n return [\n .buildCommand(\n displayName: \"Plugin\",\n executable: tool.path,\n arguments: [output],\n inputFiles: [],\n outputFiles: [output])\n ]\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithCommonPluginDependencyMigration/Sources/CommonLibrary/Common.swift", "content": "public func common() {}\n\n\nprotocol P {}\n\nfunc needsMigration(_ p: P) {}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithCommonPluginDependencyMigration/Sources/Library/Test.swift", "content": "import CommonLibrary\n\nfunc bar() {\n generatedFunction()\n common()\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithCommonPluginDependencyMigration/Sources/Tool/tool.swift", "content": "import Foundation\nimport CommonLibrary\n\n@main struct Entry {\n public static func main() async throws {\n common()\n let outputPath = CommandLine.arguments[1]\n let contents = \"\"\"\n func generatedFunction() {}\n \"\"\"\n FileManager.default.createFile(atPath: outputPath, contents: contents.data(using: .utf8))\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithPluginMigration/Package.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nlet package = Package(\n name: \"ExistentialAnyMigration\",\n platforms: [\n .macOS(.v10_15)\n ],\n targets: [\n .target(name: \"Library\", plugins: [.plugin(name: \"Plugin\")]),\n .plugin(name: \"Plugin\", capability: .buildTool, dependencies: [\"Tool\"]),\n .executableTarget(name: \"Tool\"),\n ]\n)\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithPluginMigration/Plugins/Plugin/Plugin.swift", "content": "import PackagePlugin\nimport Foundation\n\n@main struct Plugin: BuildToolPlugin {\n func createBuildCommands(context: PluginContext, target: Target) throws -> [Command] {\n let tool = try context.tool(named: \"Tool\")\n let output = context.pluginWorkDirectory.appending([\"generated.swift\"])\n return [\n .buildCommand(\n displayName: \"Plugin\",\n executable: tool.path,\n arguments: [output],\n inputFiles: [],\n outputFiles: [output])\n ]\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithPluginMigration/Sources/Library/Test.swift", "content": "protocol P {\n}\n\nfunc test1(_: P) {\n}\n\nfunc test2(_: P.Protocol) {\n}\n\nfunc test3() {\n let _: [P?] = []\n}\n\nfunc test4() {\n var x = 42\n}\n\nfunc bar() {\n generatedFunction()\n}\n" }, { "path": "Fixtures/SwiftMigrate/ExistentialAnyWithPluginMigration/Sources/Tool/tool.swift", "content": "import Foundation\n\n@main struct Entry {\n public static func main() async throws {\n let outputPath = CommandLine.arguments[1]\n let contents = \"\"\"\n func generatedFunction() {}\n func dontmodifyme(_: P) {}\n \"\"\"\n FileManager.default.createFile(atPath: outputPath, contents: contents.data(using: .utf8))\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/InferIsolatedConformancesMigration/Package.swift", "content": "// swift-tools-version:6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"InferIsolatedConformancesMigration\",\n targets: [\n .target(name: \"Diagnostics\", path: \"Sources\", exclude: [\"Fixed\"]),\n ]\n)\n" }, { "path": "Fixtures/SwiftMigrate/InferIsolatedConformancesMigration/Sources/Fixed/Test.swift", "content": "@MainActor\nclass C: nonisolated Equatable {\n let name = \"Hello\"\n\n nonisolated static func ==(lhs: C, rhs: C) -> Bool {\n lhs.name == rhs.name\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/InferIsolatedConformancesMigration/Sources/Fixed/Test2.swift", "content": "protocol P {}\nprotocol Q {}\n\n@MainActor\nstruct S: nonisolated P & Q {}\n" }, { "path": "Fixtures/SwiftMigrate/InferIsolatedConformancesMigration/Sources/Test.swift", "content": "@MainActor\nclass C: Equatable {\n let name = \"Hello\"\n\n nonisolated static func ==(lhs: C, rhs: C) -> Bool {\n lhs.name == rhs.name\n }\n}\n" }, { "path": "Fixtures/SwiftMigrate/InferIsolatedConformancesMigration/Sources/Test2.swift", "content": "protocol P {}\nprotocol Q {}\n\n@MainActor\nstruct S: P & Q {}\n" }, { "path": "Fixtures/SwiftMigrate/StrictMemorySafetyMigration/Package.swift", "content": "// swift-tools-version:6.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"StrictMemorySafetyMigration\",\n targets: [\n .target(name: \"Diagnostics\", path: \"Sources\", exclude: [\"Fixed\"]),\n ]\n)\n" }, { "path": "Fixtures/SwiftMigrate/StrictMemorySafetyMigration/Sources/Fixed/Test.swift", "content": "@unsafe func f() { }\n\nfunc g() {\n unsafe f()\n}\n" }, { "path": "Fixtures/SwiftMigrate/StrictMemorySafetyMigration/Sources/Test.swift", "content": "@unsafe func f() { }\n\nfunc g() {\n f()\n}\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Package.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nvar swiftSettings: [SwiftSetting] = []\n\nlet package = Package(\n name: \"WithErrors\",\n targets: [\n .target(\n name: \"CannotFindSettings\",\n swiftSettings: swiftSettings\n ),\n .target(name: \"A\"),\n .target(name: \"B\"),\n ]\n)\n\npackage.targets.append(\n .target(\n name: \"CannotFindTarget\",\n swiftSettings: swiftSettings\n ),\n)\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Package.updated.targets-A-B.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nvar swiftSettings: [SwiftSetting] = []\n\nlet package = Package(\n name: \"WithErrors\",\n targets: [\n .target(\n name: \"CannotFindSettings\",\n swiftSettings: swiftSettings\n ),\n .target(name: \"A\",swiftSettings: [\n .enableUpcomingFeature(\"ExistentialAny\"),\n .enableUpcomingFeature(\"InferIsolatedConformances\"),]),\n .target(name: \"B\",swiftSettings: [\n .enableUpcomingFeature(\"ExistentialAny\"),\n .enableUpcomingFeature(\"InferIsolatedConformances\"),]),\n ]\n)\n\npackage.targets.append(\n .target(\n name: \"CannotFindTarget\",\n swiftSettings: swiftSettings\n ),\n)\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Package.updated.targets-A.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nvar swiftSettings: [SwiftSetting] = []\n\nlet package = Package(\n name: \"WithErrors\",\n targets: [\n .target(\n name: \"CannotFindSettings\",\n swiftSettings: swiftSettings\n ),\n .target(name: \"A\",swiftSettings: [\n .enableUpcomingFeature(\"ExistentialAny\"),\n .enableUpcomingFeature(\"InferIsolatedConformances\"),]),\n .target(name: \"B\"),\n ]\n)\n\npackage.targets.append(\n .target(\n name: \"CannotFindTarget\",\n swiftSettings: swiftSettings\n ),\n)\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Package.updated.targets-all.swift", "content": "// swift-tools-version:5.8\n\nimport PackageDescription\n\nvar swiftSettings: [SwiftSetting] = []\n\nlet package = Package(\n name: \"WithErrors\",\n targets: [\n .target(\n name: \"CannotFindSettings\",\n swiftSettings: swiftSettings\n ),\n .target(name: \"A\",swiftSettings: [\n .enableUpcomingFeature(\"ExistentialAny\"),\n .enableUpcomingFeature(\"InferIsolatedConformances\"),]),\n .target(name: \"B\",swiftSettings: [\n .enableUpcomingFeature(\"ExistentialAny\"),\n .enableUpcomingFeature(\"InferIsolatedConformances\"),]),\n ]\n)\n\npackage.targets.append(\n .target(\n name: \"CannotFindTarget\",\n swiftSettings: swiftSettings\n ),\n)\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Sources/A/File.swift", "content": "public func foo() {}\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Sources/B/File.swift", "content": "public func foo() {}\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Sources/CannotFindSettings/File.swift", "content": "public func foo() {}\n" }, { "path": "Fixtures/SwiftMigrate/UpdateManifest/Sources/CannotFindTarget/File.swift", "content": "public func foo() {}\n" }, { "path": "Fixtures/SwiftSDKs/Package.swift", "content": "// This empty file tells test fixture logic to copy this directory's content to the test case temp directory.\n" }, { "path": "Fixtures/Traits/DisablingEmptyDefaultsExample/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"DisablingEmptyDefaultsExample\",\n dependencies: [\n .package(\n path: \"../Package11\",\n traits: []\n ),\n ],\n targets: [\n .executableTarget(\n name: \"DisablingEmptyDefaultsExample\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/DisablingEmptyDefaultsExample/Sources/DisablingEmptyDefaultsExample/Example.swift", "content": "@main\nstruct Example {\n static func main() {\n\n }\n}" }, { "path": "Fixtures/Traits/Example/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"TraitsExample\",\n traits: [\n .default(\n enabledTraits: [\n \"Package1\",\n \"Package2\",\n \"Package3\",\n \"Package4\",\n \"BuildCondition1\",\n ]\n ),\n \"Package1\",\n \"Package2\",\n \"Package3\",\n \"Package4\",\n \"Package5\",\n \"Package7\",\n \"Package9\",\n \"Package10\",\n \"BuildCondition1\",\n \"BuildCondition2\",\n \"BuildCondition3\",\n \"ExtraTrait\",\n ],\n dependencies: [\n .package(\n path: \"../Package1\",\n traits: [\"Package1Trait1\"]\n ),\n .package(\n path: \"../Package2\",\n traits: [\"Package2Trait1\"]\n ),\n .package(\n path: \"../Package3\"\n ),\n .package(\n path: \"../Package4\",\n traits: []\n ),\n .package(\n path: \"../Package5\",\n traits: [\"Package5Trait1\"]\n ),\n .package(\n path: \"../Package7\"\n ),\n .package(\n path: \"../Package9\"\n ),\n .package(\n path: \"../Package10\",\n traits: [\"Package10Trait2\"]\n ),\n ],\n targets: [\n .executableTarget(\n name: \"Example\",\n dependencies: [\n .product(\n name: \"Package1Library1\",\n package: \"Package1\",\n condition: .when(traits: [\"Package1\"])\n ),\n .product(\n name: \"Package2Library1\",\n package: \"Package2\",\n condition: .when(traits: [\"Package2\"])\n ),\n .product(\n name: \"Package3Library1\",\n package: \"Package3\",\n condition: .when(traits: [\"Package3\"])\n ),\n .product(\n name: \"Package4Library1\",\n package: \"Package4\",\n condition: .when(traits: [\"Package4\"])\n ),\n .product(\n name: \"Package5Library1\",\n package: \"Package5\",\n condition: .when(traits: [\"Package5\"])\n ),\n .product(\n name: \"Package7Library1\",\n package: \"Package7\",\n condition: .when(traits: [\"Package7\"])\n ),\n .product(\n name: \"Package9Library1\",\n package: \"Package9\",\n condition: .when(traits: [\"Package9\"])\n ),\n .product(\n name: \"Package10Library1\",\n package: \"Package10\",\n condition: .when(traits: [\"Package10\"])\n ),\n .product(\n name: \"Package10Library2\",\n package: \"Package10\",\n condition: .when(traits: [\"Package10\", \"ExtraTrait\"])\n )\n ],\n swiftSettings: [\n .define(\"DEFINE1\", .when(traits: [\"BuildCondition1\"])),\n .define(\"DEFINE2\", .when(traits: [\"BuildCondition2\"])),\n .define(\"DEFINE3\", .when(traits: [\"BuildCondition3\"])),\n ]\n ),\n .testTarget(\n name: \"ExampleTests\",\n dependencies: [\n .product(\n name: \"Package1Library1\",\n package: \"Package1\",\n condition: .when(traits: [\"Package1\"])\n ),\n .product(\n name: \"Package2Library1\",\n package: \"Package2\",\n condition: .when(traits: [\"Package2\"])\n ),\n .product(\n name: \"Package3Library1\",\n package: \"Package3\",\n condition: .when(traits: [\"Package3\"])\n ),\n .product(\n name: \"Package4Library1\",\n package: \"Package4\",\n condition: .when(traits: [\"Package4\"])\n ),\n .product(\n name: \"Package5Library1\",\n package: \"Package5\",\n condition: .when(traits: [\"Package5\"])\n ),\n .product(\n name: \"Package7Library1\",\n package: \"Package7\",\n condition: .when(traits: [\"Package7\"])\n ),\n .product(\n name: \"Package9Library1\",\n package: \"Package9\",\n condition: .when(traits: [\"Package9\"])\n ),\n .product(\n name: \"Package10Library1\",\n package: \"Package10\",\n condition: .when(traits: [\"Package10\"])\n ),\n ],\n swiftSettings: [\n .define(\"DEFINE1\", .when(traits: [\"BuildCondition1\"])),\n .define(\"DEFINE2\", .when(traits: [\"BuildCondition2\"])),\n .define(\"DEFINE3\", .when(traits: [\"BuildCondition3\"])),\n ]\n )\n ]\n)\n" }, { "path": "Fixtures/Traits/Example/Sources/Example/Example.swift", "content": "#if Package1\nimport Package1Library1\n#endif\n#if Package2\nimport Package2Library1\n#endif\n#if Package3\nimport Package3Library1\n#endif\n#if Package4\nimport Package4Library1\n#endif\n#if Package5\nimport Package5Library1\n#endif\n#if Package7\nimport Package7Library1\n#endif\n#if Package9\nimport Package9Library1\n#endif\n#if Package10\nimport Package10Library1\nimport Package10Library2\n#endif\n#if ExtraTrait\nimport Package10Library2\n#endif\n\n@main\nstruct Example {\n static func main() {\n #if Package1\n Package1Library1.hello()\n #endif\n #if Package2\n Package2Library1.hello()\n #endif\n #if Package3\n Package3Library1.hello()\n #endif\n #if Package4\n Package4Library1.hello()\n #endif\n #if Package5\n Package5Library1.hello()\n #endif\n #if Package7\n Package7Library1.hello()\n #endif\n #if Package9\n Package9Library1.hello()\n #endif\n #if Package10\n Package10Library1.hello()\n Package10Library2.hello()\n #endif\n #if ExtraTrait\n Package10Library2.hello()\n #endif\n #if DEFINE1\n print(\"DEFINE1 enabled\")\n #else\n print(\"DEFINE1 disabled\")\n #endif\n #if DEFINE2\n print(\"DEFINE2 enabled\")\n #else\n print(\"DEFINE2 disabled\")\n #endif\n #if DEFINE3\n print(\"DEFINE3 enabled\")\n #else\n print(\"DEFINE3 disabled\")\n #endif\n }\n}\n" }, { "path": "Fixtures/Traits/Example/Tests/ExampleTests/Tests.swift", "content": "#if Package1\nimport Package1Library1\n#endif\n#if Package2\nimport Package2Library1\n#endif\n#if Package3\nimport Package3Library1\n#endif\n#if Package4\nimport Package4Library1\n#endif\n#if Package5\nimport Package5Library1\n#endif\n#if Package7\nimport Package7Library1\n#endif\n#if Package9\nimport Package9Library1\n#endif\n#if Package10\nimport Package10Library1\n#endif\n\nimport XCTest\n\nfinal class Tests: XCTestCase {\n func testTraits() {\n #if Package1\n Package1Library1.hello()\n #endif\n #if Package2\n Package2Library1.hello()\n #endif\n #if Package3\n Package3Library1.hello()\n #endif\n #if Package4\n Package4Library1.hello()\n #endif\n #if Package5\n Package5Library1.hello()\n #endif\n #if Package7\n Package7Library1.hello()\n #endif\n #if Package9\n Package9Library1.hello()\n #endif\n #if Package10\n Package10Library1.hello()\n #endif\n #if DEFINE1\n print(\"DEFINE1 enabled\")\n #else\n print(\"DEFINE1 disabled\")\n #endif\n #if DEFINE2\n print(\"DEFINE2 enabled\")\n #else\n print(\"DEFINE2 disabled\")\n #endif\n #if DEFINE3\n print(\"DEFINE3 enabled\")\n #else\n print(\"DEFINE3 disabled\")\n #endif\n }\n}" }, { "path": "Fixtures/Traits/Package1/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package1\",\n products: [\n .library(\n name: \"Package1Library1\",\n targets: [\"Package1Library1\"]\n ),\n ],\n traits: [\n \"Package1Trait1\"\n ],\n targets: [\n .target(\n name: \"Package1Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package1/Sources/Package1Library1/Library.swift", "content": "public func hello() {\n #if Package1Trait1\n print(\"Package1Library1 trait1 enabled\")\n #else\n print(\"Package1Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package10/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package10\",\n products: [\n .library(\n name: \"Package10Library1\",\n targets: [\"Package10Library1\"]\n ),\n .library(\n name: \"Package10Library2\",\n targets: [\"Package10Library2\"]\n ),\n ],\n traits: [\n \"Package10Trait1\",\n \"Package10Trait2\"\n ],\n targets: [\n .target(\n name: \"Package10Library1\"\n ),\n .target(\n name: \"Package10Library2\"\n ),\n .plugin(\n name: \"SymbolGraphExtract\",\n capability: .command(\n intent: .custom(verb: \"extract\", description: \"\")\n )\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package10/Plugins/SymbolGraphExtract/Plugin.swift", "content": "import PackagePlugin\n\n@main struct SymbolGraphExtractPlugin: CommandPlugin {\n func performCommand(\n context: PluginContext,\n arguments: [String]\n ) throws {\n let result = try self.packageManager.getSymbolGraph(for: context.package.targets.first!, options: .init())\n print(result.directoryPath)\n }\n}" }, { "path": "Fixtures/Traits/Package10/Sources/Package10Library1/Library.swift", "content": "public func hello() {\n #if Package10Trait1\n print(\"Package10Library1 trait1 enabled\")\n #else\n print(\"Package10Library1 trait1 disabled\")\n #endif\n #if Package10Trait2\n print(\"Package10Library1 trait2 enabled\")\n #else\n print(\"Package10Library1 trait2 disabled\")\n #endif\n}\n\n#if Package10Trait1\npublic struct TypeGatedByPackage10Trait1 {}\n#endif\n\n#if Package10Trait2\npublic struct TypeGatedByPackage10Trait2 {}\n#endif" }, { "path": "Fixtures/Traits/Package10/Sources/Package10Library2/Library.swift", "content": "public func hello() {\n print(\"Package10Library2 has been included.\")\n}" }, { "path": "Fixtures/Traits/Package11/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package11\",\n products: [\n .library(\n name: \"Package11Library1\",\n targets: [\"Package11Library1\"]\n ),\n ],\n targets: [\n .target(\n name: \"Package11Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package11/Sources/Package11Library1/Library.swift", "content": "public func hello() {\n print(\"Package11Library1\")\n}" }, { "path": "Fixtures/Traits/Package2/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package2\",\n products: [\n .library(\n name: \"Package2Library1\",\n targets: [\"Package2Library1\"]\n ),\n ],\n traits: [\n Trait(name: \"Package2Trait1\", enabledTraits: [\"Package2Trait2\"]),\n \"Package2Trait2\",\n ],\n targets: [\n .target(\n name: \"Package2Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package2/Sources/Package2Library1/Library.swift", "content": "public func hello() {\n #if Package2Trait2\n print(\"Package2Library1 trait2 enabled\")\n #else\n print(\"Package2Library1 trait2 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package3/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package3\",\n products: [\n .library(\n name: \"Package3Library1\",\n targets: [\"Package3Library1\"]\n ),\n ],\n traits: [\n .default(enabledTraits: [\"Package3Trait3\"]),\n .trait(name: \"Package3Trait1\", enabledTraits: [\"Package3Trait2\"]),\n .trait(name: \"Package3Trait2\", enabledTraits: [\"Package3Trait3\"]),\n \"Package3Trait3\",\n ],\n targets: [\n .target(\n name: \"Package3Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package3/Sources/Package3Library1/Library.swift", "content": "public func hello() {\n #if Package3Trait3\n print(\"Package3Library1 trait3 enabled\")\n #else\n print(\"Package3Library1 trait3 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package4/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package4\",\n products: [\n .library(\n name: \"Package4Library1\",\n targets: [\"Package4Library1\"]\n ),\n ],\n traits: [\n .default(enabledTraits: [\"Package4Trait1\"]),\n \"Package4Trait1\",\n ],\n targets: [\n .target(\n name: \"Package4Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package4/Sources/Package4Library1/Library.swift", "content": "public func hello() {\n #if Package4Trait1\n print(\"Package4Library1 trait1 enabled\")\n #else\n print(\"Package4Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package5/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package5\",\n products: [\n .library(\n name: \"Package5Library1\",\n targets: [\"Package5Library1\"]\n ),\n ],\n traits: [\n \"Package5Trait1\"\n ],\n dependencies: [\n .package(\n path: \"../Package6\",\n traits: [\n Package.Dependency.Trait(name: \"Package6Trait1\", condition: .when(traits: [\"Package5Trait1\"]))\n ]\n )\n ],\n targets: [\n .target(\n name: \"Package5Library1\",\n dependencies: [\n .product(\n name: \"Package6Library1\",\n package: \"Package6\"\n )\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package5/Sources/Package5Library1/Library.swift", "content": "#if Package5Trait1\nimport Package6Library1\n#endif\n\npublic func hello() {\n #if Package5Trait1\n print(\"Package5Library1 trait1 enabled\")\n Package6Library1.hello()\n #else\n print(\"Package5Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package6/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package6\",\n products: [\n .library(\n name: \"Package6Library1\",\n targets: [\"Package6Library1\"]\n ),\n ],\n traits: [\n \"Package6Trait1\"\n ],\n targets: [\n .target(\n name: \"Package6Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package6/Sources/Package6Library1/Library.swift", "content": "public func hello() {\n #if Package6Trait1\n print(\"Package6Library1 trait1 enabled\")\n #else\n print(\"Package6Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package7/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package7\",\n products: [\n .library(\n name: \"Package7Library1\",\n targets: [\"Package7Library1\"]\n ),\n ],\n traits: [\n \"Package7Trait1\"\n ],\n dependencies: [\n .package(\n path: \"../Package8\"\n )\n ],\n targets: [\n .target(\n name: \"Package7Library1\",\n dependencies: [\n .product(\n name: \"Package8Library1\",\n package: \"Package8\",\n condition: .when(traits: [\"Package7Trait1\"])\n )\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package7/Sources/Package7Library1/Library.swift", "content": "#if Package7Trait1\nimport Package8Library1\n#endif\n\npublic func hello() {\n #if Package7Trait1\n print(\"Package7Library1 trait1 enabled\")\n Package8Library1.hello()\n #else\n print(\"Package7Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package8/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package8\",\n products: [\n .library(\n name: \"Package8Library1\",\n targets: [\"Package8Library1\"]\n ),\n ],\n traits: [\n \"Package8Trait1\"\n ],\n targets: [\n .target(\n name: \"Package8Library1\"\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package8/Sources/Package6Library1/Library.swift", "content": "public func hello() {\n #if Package8Trait1\n print(\"Package8Library1 trait1 enabled\")\n #else\n print(\"Package8Library1 trait1 disabled\")\n #endif\n}\n" }, { "path": "Fixtures/Traits/Package9/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Package9\",\n products: [\n .library(\n name: \"Package9Library1\",\n targets: [\"Package9Library1\"]\n ),\n ],\n dependencies: [\n .package(\n path: \"../Package10\",\n traits: [\"Package10Trait1\"]\n )\n ],\n targets: [\n .target(\n name: \"Package9Library1\",\n dependencies: [\n .product(\n name: \"Package10Library1\",\n package: \"Package10\"\n )\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/Package9/Sources/Package9Library1/Library.swift", "content": "import Package10Library1\n\npublic func hello() {\n Package10Library1.hello()\n}\n" }, { "path": "Fixtures/Traits/PackageConditionalDeps/Package.swift", "content": "// swift-tools-version: 6.1\n\nimport PackageDescription\n\nlet package = Package(\n name: \"PackageConditionalDeps\",\n products: [\n .library(\n name: \"PackageConditionalDeps\",\n targets: [\"PackageConditionalDeps\"]\n ),\n ],\n traits: [\n .default(enabledTraits: [\"EnablePackage1Dep\"]),\n \"EnablePackage1Dep\",\n \"EnablePackage2Dep\"\n ],\n dependencies: [\n .package(path: \"../Package1\"),\n .package(path: \"../Package2\"),\n ],\n targets: [\n .target(\n name: \"PackageConditionalDeps\",\n dependencies: [ \n .product(\n name: \"Package1Library1\",\n package: \"Package1\",\n condition: .when(traits: [\"EnablePackage1Dep\"])\n ),\n .product(\n name: \"Package2Library1\",\n package: \"Package2\",\n condition: .when(traits: [\"EnablePackage2Dep\"])\n )\n ]\n ),\n ]\n)\n" }, { "path": "Fixtures/Traits/PackageConditionalDeps/Sources/PackageConditionalDeps/PackageConditionalDeps.swift", "content": "public func nothingHappens() {\n // Do nothing.\n}\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ExecutableNew\",\n targets: [\n .target(name: \"ExecutableSwift\"),\n .target(name: \"ExecutableC\"),\n .target(name: \"ExecutableCxx\"),\n ]\n)\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/README.md", "content": "# ExecutableMixed\n\nA description of this package.\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/Sources/ExecutableC/c.c", "content": "int main() {\n return 0;\n}\n\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/Sources/ExecutableCxx/cxx.cpp", "content": "int main() {\n return 0;\n}\n\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableMixed/Sources/ExecutableSwift/main.swift", "content": "print(\"Hello, world!\")\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableNew/.gitignore", "content": ".DS_Store\n/.build\n/Packages\n/*.xcodeproj\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableNew/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"ExecutableNew\",\n targets: [\n .target(name: \"ExecutableNew\"),\n ]\n)\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableNew/README.md", "content": "# ExecutableNew\n\nA description of this package.\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/ExecutableNew/Sources/ExecutableNew/main.swift", "content": "print(\"Hello, world!\")\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/Library/Package.swift", "content": "// swift-tools-version:4.2\nimport PackageDescription\n\nlet package = Package(\n name: \"Library\",\n targets: [\n .target(name: \"Library\"),\n ]\n)\n" }, { "path": "Fixtures/ValidLayouts/SingleModule/Library/Sources/Library/Foo.swift", "content": "class Foo {\n var bar: Int = 0\n}\n" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Bar/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .executable(name: \"bar\", targets: [\"bar\"]),\n .executable(name: \"cbar\", targets: [\"cbar\"]),\n .library(name: \"BarLib\", targets: [\"BarLib\"]),\n ],\n targets: [\n .target(name: \"bar\", dependencies: [\"BarLib\"]),\n .target(name: \"cbar\"),\n .target(name: \"BarLib\"),\n ],\n swiftLanguageVersions: [.v4_2],\n cLanguageStandard: .c11,\n cxxLanguageStandard: .cxx14\n)\n" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Bar/Sources/BarLib/BarLib.swift", "content": "public struct BarInfo {\n public static let name: String = \"bar\"\n}" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Bar/Sources/bar/main.swift", "content": "import BarLib\n\nfunc main() {\n print(\"Hello from \\(BarInfo.name)\")\n}" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Bar/Sources/cbar/main.c", "content": "#include \n\nint main(void) {\n printf(\"Hello from cbar\");\n}\n" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Foo/Package.swift", "content": "// swift-tools-version:5.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n dependencies: [\n .package(path: \"../Bar\")\n ],\n targets: [\n .target(name: \"foo\", dependencies: [\n \"FooLib\",\n \"cfoo\",\n .product(name: \"bar\", package: \"Bar\")\n ]),\n .target(name: \"cfoo\"),\n .target(name: \"FooLib\", dependencies: [\n .product(name: \"BarLib\", package: \"Bar\"),\n ]),\n ],\n swiftLanguageVersions: [.v4_2, .v5]\n)\n" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Foo/Sources/FooLib/FooLib.swift", "content": "public struct FooInfo {\n public static let name: String = \"bar\"\n}" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Foo/Sources/cfoo/main.c", "content": "#include \n\nint main(void) {\n printf(\"Hello from cfoo\");\n}\n" }, { "path": "Fixtures/XCBuild/ExecutableProducts/Foo/Sources/foo/main.swift", "content": "import FooLib\nimport BarLib\n\nfunc main() {\n print(\"Hello from \\(FooInfo.name)\")\n print(\"Hello from \\(BarInfo.name)\")\n}" }, { "path": "Fixtures/XCBuild/Libraries/Bar/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"BarLib\", type: .dynamic, targets: [\"BarLib\"]),\n ],\n targets: [\n .target(name: \"BarLib\"),\n ],\n swiftLanguageVersions: [.v4_2],\n cLanguageStandard: .c11,\n cxxLanguageStandard: .cxx14\n)\n" }, { "path": "Fixtures/XCBuild/Libraries/Bar/Sources/BarLib/BarLib.swift", "content": "import Foundation\n\n@objcMembers public class BarInfo: NSObject {\n public static let name = \"Bar\"\n}" }, { "path": "Fixtures/XCBuild/Libraries/Foo/Package.swift", "content": "// swift-tools-version:5.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n products: [\n .library(name: \"FooLib\", type: .static, targets: [\"FooLib\"]),\n ],\n dependencies: [\n .package(path: \"../Bar\")\n ],\n targets: [\n .target(name: \"FooLib\", dependencies: [\"CFooLib\"]),\n .target(name: \"CFooLib\", dependencies: [\n .product(name: \"BarLib\", package: \"Bar\"),\n ]),\n ],\n swiftLanguageVersions: [.v4_2, .v5]\n)\n" }, { "path": "Fixtures/XCBuild/Libraries/Foo/Sources/CFooLib/CFooLib.m", "content": "@import Foundation;\n@import BarLib;\n#import \"CFooLib.h\"\n\n@implementation CFooInfo\n\n+ (NSString*)name {\n return [NSString stringWithFormat:@\"CFoo %@\", [BarInfo name]];\n}\n\n@end\n" }, { "path": "Fixtures/XCBuild/Libraries/Foo/Sources/CFooLib/include/CFooLib.h", "content": "@import Foundation;\n\n@interface CFooInfo: NSObject\n+ (nonnull NSString*)name;\n@end\n" }, { "path": "Fixtures/XCBuild/Libraries/Foo/Sources/FooLib/FooLib.swift", "content": "import CFooLib\nimport BarLib\n\npublic struct FooInfo {\n public static let name = \"Foo \\(BarInfo.name) \\(CFooInfo.name)\"\n}" }, { "path": "Fixtures/XCBuild/SystemTargets/Foo/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n targets: [\n .target(name: \"foo\", dependencies: [\"SystemLib\"]),\n .systemLibrary(name: \"SystemLib\", pkgConfig: \"libsys\"),\n ]\n)\n" }, { "path": "Fixtures/XCBuild/SystemTargets/Foo/Sources/SystemLib/module.modulemap", "content": "module SystemLib [system] {\n header \"../../../Inputs/libsys.h\"\n export *\n}\n" }, { "path": "Fixtures/XCBuild/SystemTargets/Foo/Sources/foo/main.swift", "content": "import SystemLib\n\nprint(String(cString: GetSystemLibName()!))\n" }, { "path": "Fixtures/XCBuild/SystemTargets/Inputs/libsys.c", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nconst char* GetSystemLibName() {\n\treturn \"SystemLibrary\";\n}\n" }, { "path": "Fixtures/XCBuild/SystemTargets/Inputs/libsys.h", "content": "/*\n This source file is part of the Swift.org open source project\n\n Copyright (c) 2020 Apple Inc. and the Swift project authors\n Licensed under Apache License v2.0 with Runtime Library Exception\n\n See http://swift.org/LICENSE.txt for license information\n See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n*/\n\nconst char* GetSystemLibName();\n" }, { "path": "Fixtures/XCBuild/SystemTargets/Inputs/libsys.pc", "content": "Name: SystemLibrary\nURL: http://127.0.0.1/\nDescription: The one and only SystemLibrary\nVersion: 1.0.0\nCflags: -I${pcfiledir}\nLibs: -L${pcfiledir} -lsys\n" }, { "path": "Fixtures/XCBuild/TestProducts/Bar/Package.swift", "content": "// swift-tools-version:4.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Bar\",\n products: [\n .library(name: \"BarLib\", targets: [\"BarLib\"]),\n ],\n targets: [\n .target(name: \"BarLib\"),\n ],\n swiftLanguageVersions: [.v4_2],\n cLanguageStandard: .c11,\n cxxLanguageStandard: .cxx14\n)\n" }, { "path": "Fixtures/XCBuild/TestProducts/Bar/Sources/BarLib/BarLib.m", "content": "#import \"BarLib.h\"\n\n@implementation BarInfo\n\n+ (NSString*)name {\n return @\"Bar\";\n}\n\n@end" }, { "path": "Fixtures/XCBuild/TestProducts/Bar/Sources/BarLib/include/BarLib.h", "content": "@import Foundation;\n\n@interface BarInfo: NSObject\n+ (nonnull NSString*)name;\n@end" }, { "path": "Fixtures/XCBuild/TestProducts/Foo/Package.swift", "content": "// swift-tools-version:5.2\n\nimport PackageDescription\n\nlet package = Package(\n name: \"Foo\",\n dependencies: [\n .package(path: \"../Bar\")\n ],\n targets: [\n .target(name: \"FooLib\", dependencies: [\n .product(name: \"BarLib\", package: \"Bar\"),\n ]),\n .testTarget(name: \"FooTests\", dependencies: [\"FooLib\"]),\n .testTarget(name: \"CFooTests\", dependencies: [\"FooLib\"]),\n ],\n swiftLanguageVersions: [.v4_2, .v5]\n)\n" }, { "path": "Fixtures/XCBuild/TestProducts/Foo/Sources/FooLib/FooLib.swift", "content": "import Foundation\n\n@objcMembers public class FooInfo: NSObject {\n public static let name = \"Foo\"\n}" }, { "path": "Fixtures/XCBuild/TestProducts/Foo/Tests/CFooTests/tests.m", "content": "@import XCTest;\n@import Foundation;\n@import FooLib;\n@import BarLib;\n\n@interface CFooTests: XCTestCase\n@end\n@implementation CFooTests\n\n- (void)testFoo {\n XCTAssert([[FooInfo name] isEqualTo:@\"Foo\"]);\n}\n\n- (void)testBar {\n XCTAssert([[BarInfo name] isEqualTo:@\"Bar\"]);\n}\n\n@end\n" }, { "path": "Fixtures/XCBuild/TestProducts/Foo/Tests/FooTests/FooTests.swift", "content": "import XCTest\nimport FooLib\nimport BarLib\n\nfinal class FooTests: XCTestCase {\n func testFoo() {\n XCTAssertEqual(FooInfo.name, \"Foo\")\n }\n\n func testBar() {\n XCTAssertEqual(BarInfo.name(), \"Bar\")\n }\n}" }, { "path": "LICENSE.txt", "content": " Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n\n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n\n 1. Definitions.\n\n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n\n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n\n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n\n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n\n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n\n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n\n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n\n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n\n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n\n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n\n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n\n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n\n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n\n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n\n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n\n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n\n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n\n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n\n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n\n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n\n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n\n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n\n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n\n END OF TERMS AND CONDITIONS\n\n APPENDIX: How to apply the Apache License to your work.\n\n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n\n Copyright [yyyy] [name of copyright owner]\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n\n \n \n## Runtime Library Exception to the Apache 2.0 License: ##\n\n\n As an exception, if you use this Software to compile your source code and\n portions of this Software are embedded into the binary product as a result,\n you may redistribute such product without providing attribution as would\n otherwise be required by Sections 4(a), 4(b) and 4(d) of the License.\n" }, { "path": "NOTICE.txt", "content": "\n The SwiftPM Project\n ====================\n\nPlease visit the SwiftPM web site for more information:\n\n * https://github.com/swiftlang/swift-package-manager\n\nCopyright (c) 2014 - 2021 Apple Inc. and the Swift project authors\n\nThe Swift Project licenses this file to you under the Apache License,\nversion 2.0 (the \"License\"); you may not use this file except in compliance\nwith the License. You may obtain a copy of the License at:\n\n https://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT\nWARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the\nLicense for the specific language governing permissions and limitations\nunder the License.\n\nAlso, please refer to each LICENSE.txt file, which is located in\nthe 'license' directory of the distribution file, for the license terms of the\ncomponents that this product depends on.\n\n-------------------------------------------------------------------------------\n\nThe dependency resolver is influenced by Dart project (pub tool).\n\n * LICENSE (BSD 3-Clause \"New\" or \"Revised\" License):\n * https://github.com/dart-lang/pub/blob/master/LICENSE // ignore-unacceptable-language\n * HOMEPAGE:\n * https://dart.dev\n * https://github.com/dart-lang/pub\n\n---\n\nThis product contains a derivation of Vapor's JWTKit library, specifically `JWTParser.swift`, `JWTSerializer.swift` and `Base64URL.swift`.\n\n * LICENSE (MIT License):\n * https://www.apache.org/licenses/LICENSE-2.0\n * HOMEPAGE:\n * https://vapor.codes\n * https://github.com/vapor/jwt-kit\n\n---\n\nThis product contains a derivation of OpenSSL's OCSP implementation, found under the `PackageCollectionsSigningLibc` module.\n\n * LICENSE (Apache License 2.0):\n * https://www.apache.org/licenses/LICENSE-2.0\n * HOMEPAGE:\n * https://github.com/openssl/openssl\n\n---\n\nThe observability system is influenced by SwiftLog project.\n\n * LICENSE (Apache License 2.0):\n * https://www.apache.org/licenses/LICENSE-2.0\n * HOMEPAGE:\n * https://github.com/apple/swift-log\n\n---\n\nThe observability system is influenced by SwiftMetrics project.\n\n * LICENSE (Apache License 2.0):\n * https://www.apache.org/licenses/LICENSE-2.0\n * HOMEPAGE:\n * https://github.com/apple/swift-metrics\n\n---\n\nThe observability system is influenced by SwiftDistributedTracing project.\n\n * LICENSE (Apache License 2.0):\n * https://www.apache.org/licenses/LICENSE-2.0\n * HOMEPAGE:\n * https://github.com/apple/swift-distributed-tracing-baggage\n\n---\n" }, { "path": "Package.swift", "content": "// swift-tools-version:6.1\n\n//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.ProcessInfo\nimport PackageDescription\n\n// When building the toolchain on the CI for ELF platforms, remove the CI's\n// stdlib absolute runpath and add ELF's $ORIGIN relative paths before installing.\nlet swiftpmLinkSettings: [LinkerSetting]\nlet packageLibraryLinkSettings: [LinkerSetting]\nif let resourceDirPath = ProcessInfo.processInfo.environment[\"SWIFTCI_INSTALL_RPATH_OS\"] {\n swiftpmLinkSettings = [.unsafeFlags([\n \"-no-toolchain-stdlib-rpath\",\n \"-Xlinker\", \"-rpath\",\n \"-Xlinker\", \"$ORIGIN/../lib/swift/\\(resourceDirPath)\",\n ])]\n packageLibraryLinkSettings = [.unsafeFlags([\n \"-no-toolchain-stdlib-rpath\",\n \"-Xlinker\", \"-rpath\",\n \"-Xlinker\", \"$ORIGIN/../../\\(resourceDirPath)\",\n ])]\n} else {\n swiftpmLinkSettings = []\n packageLibraryLinkSettings = []\n}\n\n// Common experimental flags to be added to all targets.\nlet commonExperimentalFeatures: [SwiftSetting] = [\n .enableExperimentalFeature(\"MemberImportVisibility\"),\n]\n\n// Certain targets fail to compile with MemberImportVisibility enabled on 6.0.3\n// but work with >=6.1. These targets opt in to using `swift6CompatibleExperimentalFeatures`.\n#if swift(>=6.1)\nlet swift6CompatibleExperimentalFeatures = commonExperimentalFeatures\n#else\nlet swift6CompatibleExperimentalFeatures: [SwiftSetting] = []\n#endif\n\n/** SwiftPMDataModel is the subset of SwiftPM product that includes just its data model.\n This allows some clients (such as IDEs) that use SwiftPM's data model but not its build system\n to not have to depend on SwiftDriver, SwiftLLBuild, etc. We should probably have better names here,\n though that could break some clients.\n */\nlet swiftPMDataModelProduct = (\n name: \"SwiftPMDataModel\",\n targets: [\n \"PackageCollections\",\n \"PackageCollectionsModel\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageMetadata\",\n \"PackageModel\",\n \"SourceControl\",\n \"Workspace\",\n ]\n)\n\n/** The `libSwiftPM` set of interfaces to programmatically work with Swift\n packages. `libSwiftPM` includes all of the SwiftPM code except the\n command line tools, while `libSwiftPMDataModel` includes only the data model.\n\n NOTE: This API is *unstable* and may change at any time.\n */\nlet swiftPMProduct = (\n name: \"SwiftPM\",\n targets: swiftPMDataModelProduct.targets + [\n \"Build\",\n \"LLBuildManifest\",\n \"SourceKitLSPAPI\",\n \"SPMLLBuild\",\n ]\n)\n\n#if os(Windows)\nlet includeDynamicLibrary: Bool = false\nlet systemSQLitePkgConfig: String? = nil\n#else\nlet includeDynamicLibrary: Bool = true\nvar systemSQLitePkgConfig: String? = \"sqlite3\"\nif ProcessInfo.processInfo.environment[\"SWIFTCI_INSTALL_RPATH_OS\"] == \"android\" {\n systemSQLitePkgConfig = nil\n}\n#endif\n\n/** An array of products which have two versions listed: one dynamically linked, the other with the\n automatic linking type with `-auto` suffix appended to product's name.\n */\nlet autoProducts = [swiftPMProduct, swiftPMDataModelProduct]\n\nlet shouldUseSwiftBuildFramework = (ProcessInfo.processInfo.environment[\"SWIFTPM_SWBUILD_FRAMEWORK\"] != nil)\n\nlet swiftDriverDeps: [Target.Dependency]\nlet swiftTSCBasicsDeps: [Target.Dependency]\nlet swiftToolsCoreSupportAutoDeps: [Target.Dependency]\nlet swiftTSCTestSupportDeps: [Target.Dependency]\nlet swiftToolsProtocolsDeps: [Target.Dependency]\n\nif shouldUseSwiftBuildFramework {\n swiftDriverDeps = []\n swiftTSCBasicsDeps = []\n swiftToolsCoreSupportAutoDeps = []\n swiftTSCTestSupportDeps = []\n swiftToolsProtocolsDeps = []\n} else {\n swiftDriverDeps = [\n .product(name: \"SwiftDriver\", package: \"swift-driver\")\n ]\n swiftTSCBasicsDeps = [\n .product(name: \"TSCBasic\", package: \"swift-tools-support-core\"),\n ]\n swiftToolsCoreSupportAutoDeps = [\n .product(name: \"SwiftToolsSupport-auto\", package: \"swift-tools-support-core\")\n ]\n swiftTSCTestSupportDeps = [\n .product(name: \"TSCTestSupport\", package: \"swift-tools-support-core\"),\n ]\n swiftToolsProtocolsDeps = [\n .product(name: \"BuildServerProtocol\", package: \"swift-tools-protocols\", condition: .when(platforms: [.macOS, .linux, .windows, .android, .openbsd, .custom(\"freebsd\")])),\n .product(name: \"LanguageServerProtocol\", package: \"swift-tools-protocols\", condition: .when(platforms: [.macOS, .linux, .windows, .android, .openbsd, .custom(\"freebsd\")])),\n .product(name: \"LanguageServerProtocolTransport\", package: \"swift-tools-protocols\", condition: .when(platforms: [.macOS, .linux, .windows, .android, .openbsd, .custom(\"freebsd\")])),\n ]\n}\nlet package = Package(\n name: \"SwiftPM\",\n platforms: [\n .macOS(.v14),\n .iOS(.v17),\n .macCatalyst(.v17),\n ],\n products:\n autoProducts.flatMap {\n (includeDynamicLibrary ? [\n .library(\n name: $0.name,\n type: .dynamic,\n targets: $0.targets\n ),\n ] : [])\n +\n [\n .library(\n name: \"\\($0.name)-auto\",\n targets: $0.targets\n ),\n ]\n } + [\n .library(\n name: \"XCBuildSupport\",\n targets: [\"XCBuildSupport\"]\n ),\n .library(\n name: \"PackageDescription\",\n type: .dynamic,\n targets: [\"PackageDescription\", \"CompilerPluginSupport\"]\n ),\n .library(\n name: \"AppleProductTypes\",\n type: .dynamic,\n targets: [\"AppleProductTypes\"]\n ),\n\n .library(\n name: \"PackagePlugin\",\n type: .dynamic,\n targets: [\"PackagePlugin\"]\n ),\n .library(\n name: \"PackageCollectionsModel\",\n targets: [\"PackageCollectionsModel\"]\n ),\n .library(\n name: \"SwiftPMPackageCollections\",\n targets: [\n \"PackageCollections\",\n \"PackageCollectionsModel\",\n \"PackageCollectionsSigning\",\n \"PackageModel\",\n ]\n ),\n ],\n targets: [\n // The `AppleProductTypes` target provides additional product types\n // to `Package.swift` manifests. Here we build a debug version of the\n // library; the bootstrap scripts build the deployable version.\n .target(\n name: \"AppleProductTypes\",\n // Note: We use `-module-link-name` so clients link against the\n // AppleProductTypes library when they import it without further\n // messing with the manifest loader.\n dependencies: [\"PackageDescription\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-package-description-version\", \"999.0\"]),\n .unsafeFlags([\"-enable-library-evolution\"], .when(platforms: [.macOS])),\n .unsafeFlags([\"-Xfrontend\", \"-module-link-name\", \"-Xfrontend\", \"AppleProductTypes\"])\n ]),\n\n .target(\n name: \"SourceKitLSPAPI\",\n dependencies: [\n \"Basics\",\n \"Build\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageModel\",\n \"SPMBuildCore\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .enableExperimentalFeature(\"AccessLevelOnImport\"),\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: SwiftPM specific support libraries\n\n .systemLibrary(name: \"SPMSQLite3\", pkgConfig: systemSQLitePkgConfig),\n\n .target(\n name: \"_AsyncFileSystem\",\n dependencies: [\n .product(name: \"SystemPackage\", package: \"swift-system\"),\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .enableExperimentalFeature(\"StrictConcurrency\"),\n .enableExperimentalFeature(\"AccessLevelOnImport\"),\n .enableExperimentalFeature(\"InternalImportsByDefault\"),\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n name: \"Basics\",\n dependencies: [\n \"_AsyncFileSystem\",\n .target(name: \"SPMSQLite3\", condition: .when(platforms: [.macOS, .iOS, .tvOS, .watchOS, .visionOS, .macCatalyst, .linux, .openbsd, .custom(\"freebsd\")])),\n .product(name: \"SwiftToolchainCSQLite\", package: \"swift-toolchain-sqlite\", condition: .when(platforms: [.windows, .android])),\n .product(name: \"DequeModule\", package: \"swift-collections\"),\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n .product(name: \"SystemPackage\", package: \"swift-system\"),\n ] + swiftToolsCoreSupportAutoDeps,\n exclude: [\"CMakeLists.txt\", \"Vendor/README.md\"],\n swiftSettings: swift6CompatibleExperimentalFeatures + [\n .enableExperimentalFeature(\"StrictConcurrency\"),\n .enableExperimentalFeature(\"AccessLevelOnImport\"),\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** The llbuild manifest model */\n name: \"LLBuildManifest\",\n dependencies: [\"Basics\"],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Package registry support */\n name: \"PackageRegistry\",\n dependencies: [\n \"Basics\",\n \"PackageFingerprint\",\n \"PackageLoading\",\n \"PackageModel\",\n \"PackageSigning\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Source control operations */\n name: \"SourceControl\",\n dependencies: [\n \"Basics\",\n \"PackageModel\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Shim for llbuild library */\n name: \"SPMLLBuild\",\n dependencies: [\"Basics\"],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** API for deserializing diagnostics and applying fix-its */\n name: \"SwiftFixIt\",\n dependencies: [\n \"Basics\",\n ] + swiftTSCBasicsDeps + swiftSyntaxDependencies(\n [\"SwiftDiagnostics\", \"SwiftIDEUtils\", \"SwiftParser\", \"SwiftSyntax\"]\n ),\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** API for inspecting symbols defined in binaries */\n name: \"BinarySymbols\",\n dependencies: [\n \"Basics\",\n ] + swiftTSCBasicsDeps,\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: Project Model\n\n .target(\n /** Primitive Package model objects */\n name: \"PackageModel\",\n dependencies: [\"Basics\"],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: swift6CompatibleExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** SBOM (Software Bill of Materials) model objects */\n name: \"SBOMModel\",\n dependencies: [\"Basics\", \"PackageCollections\", \"PackageGraph\", \"PackageModel\", \"SourceControl\", \"SwiftBuildSupport\"],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n resources: [\n .copy(\"CycloneDX/Resources/cyclonedx-1.7.schema.json\"),\n .copy(\"SPDX/Resources/spdx-3.0.1.schema.json\"),\n ],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Package model conventions and loading support */\n name: \"PackageLoading\",\n dependencies: [\n \"Basics\",\n \"PackageModel\",\n \"SourceControl\",\n ],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: Package Dependency Resolution\n\n .target(\n /** Data structures and support for complete package graphs */\n name: \"PackageGraph\",\n dependencies: [\n \"Basics\",\n \"PackageLoading\",\n \"PackageModel\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n ],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: Package Collections\n\n .target(\n /** Package collections models */\n name: \"PackageCollectionsModel\",\n dependencies: [],\n exclude: [\n \"Formats/v1.md\",\n \"CMakeLists.txt\",\n ],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Data structures and support for package collections */\n name: \"PackageCollections\",\n dependencies: [\n \"Basics\",\n \"PackageCollectionsModel\",\n \"PackageCollectionsSigning\",\n \"PackageModel\",\n \"SourceControl\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: swift6CompatibleExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n name: \"PackageCollectionsSigning\",\n dependencies: [\n .product(name: \"Crypto\", package: \"swift-crypto\"),\n .product(name: \"X509\", package: \"swift-certificates\"),\n \"Basics\",\n \"PackageCollectionsModel\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n name: \"PackageFingerprint\",\n dependencies: [\n \"Basics\",\n \"PackageModel\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n name: \"PackageSigning\",\n dependencies: [\n .product(name: \"Crypto\", package: \"swift-crypto\"),\n .product(name: \"X509\", package: \"swift-certificates\"),\n \"Basics\",\n \"PackageModel\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: Documentation\n\n .target(\n name: \"PackageManagerDocs\",\n exclude: [\"README.md\"],\n ),\n\n // MARK: Package Manager Functionality\n\n .target(\n /** Builds Modules and Products */\n name: \"SPMBuildCore\",\n dependencies: [\n \"Basics\",\n \"PackageGraph\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n /** Builds Modules and Products */\n name: \"Build\",\n dependencies: [\n \"Basics\",\n \"LLBuildManifest\",\n \"PackageGraph\",\n \"SPMBuildCore\",\n \"SPMLLBuild\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n \"DriverSupport\",\n ] + swiftDriverDeps,\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n name: \"DriverSupport\",\n dependencies: [\n \"Basics\",\n \"PackageModel\",\n ] + swiftDriverDeps,\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n /** Support for building using Xcode's build system */\n name: \"XCBuildSupport\",\n dependencies: [\n \"SPMBuildCore\",\n \"PackageGraph\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n name: \"SwiftBuildSupport\",\n dependencies: [\n \"SPMBuildCore\",\n \"PackageGraph\",\n ],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: commonExperimentalFeatures\n ),\n .target(\n /** High level functionality */\n name: \"Workspace\",\n dependencies: [\n \"Basics\",\n \"PackageFingerprint\",\n \"PackageGraph\",\n \"PackageModel\",\n \"PackageRegistry\",\n \"PackageSigning\",\n \"SourceControl\",\n \"SPMBuildCore\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n // ** High level interface for package discovery */\n name: \"PackageMetadata\",\n dependencies: [\n \"Basics\",\n \"PackageCollections\",\n \"PackageModel\",\n \"PackageRegistry\",\n \"PackageSigning\",\n ],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: BSP\n .target(\n name: \"SwiftPMBuildServer\",\n dependencies: [\n \"Basics\",\n \"Build\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageModel\",\n \"SPMBuildCore\",\n \"SourceControl\",\n \"SourceKitLSPAPI\",\n \"SwiftBuildSupport\",\n \"Workspace\"\n ] + swiftTSCBasicsDeps + swiftToolsProtocolsDeps,\n exclude: [\n \"CMakeLists.txt\",\n ],\n ),\n\n // MARK: Commands\n\n .target(\n /** Minimal set of commands required for bootstrapping a new SwiftPM */\n name: \"CoreCommands\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n \"Basics\",\n \"Build\",\n \"PackageLoading\",\n \"PackageModel\",\n \"PackageGraph\",\n \"Workspace\",\n \"XCBuildSupport\",\n \"SwiftBuildSupport\",\n \"SBOMModel\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** High-level commands */\n name: \"Commands\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n .product(name: \"SystemPackage\", package: \"swift-system\"),\n \"Basics\",\n \"BinarySymbols\",\n \"Build\",\n \"CoreCommands\",\n \"PackageGraph\",\n \"SBOMModel\",\n \"SourceControl\",\n \"Workspace\",\n \"XCBuildSupport\",\n \"SwiftBuildSupport\",\n \"SwiftFixIt\",\n \"SwiftPMBuildServer\",\n ] + swiftSyntaxDependencies([\"SwiftIDEUtils\", \"SwiftRefactor\"]),\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: swift6CompatibleExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Interacts with Swift SDKs used for cross-compilation */\n name: \"SwiftSDKCommand\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n \"Basics\",\n \"CoreCommands\",\n \"SPMBuildCore\",\n \"PackageModel\",\n ],\n exclude: [\"CMakeLists.txt\", \"README.md\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Interacts with package collections */\n name: \"PackageCollectionsCommand\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n \"Basics\",\n \"Commands\",\n \"CoreCommands\",\n \"PackageCollections\",\n \"PackageModel\",\n ],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** Interact with package registry */\n name: \"PackageRegistryCommand\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n \"Basics\",\n \"Commands\",\n \"CoreCommands\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageModel\",\n \"PackageRegistry\",\n \"PackageSigning\",\n \"SourceControl\",\n \"SPMBuildCore\",\n \"Workspace\",\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n name: \"QueryEngine\",\n dependencies: [\n \"_AsyncFileSystem\",\n \"Basics\",\n .product(name: \"Crypto\", package: \"swift-crypto\"),\n ],\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: [\n .enableExperimentalFeature(\"StrictConcurrency=complete\"),\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .executableTarget(\n /** The main executable provided by SwiftPM */\n name: \"swift-package\",\n dependencies: [\"Basics\", \"Commands\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Builds packages */\n name: \"swift-build\",\n dependencies: [\"Commands\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Builds SwiftPM itself for bootstrapping (minimal version of `swift-build`) */\n name: \"swift-bootstrap\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n \"Basics\",\n \"Build\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageModel\",\n \"XCBuildSupport\",\n \"SwiftBuildSupport\",\n ],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Interacts with Swift SDKs used for cross-compilation */\n name: \"swift-sdk\",\n dependencies: [\"Commands\", \"SwiftSDKCommand\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Deprecated command superseded by `swift-sdk` */\n name: \"swift-experimental-sdk\",\n dependencies: [\"Commands\", \"SwiftSDKCommand\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Runs package tests */\n name: \"swift-test\",\n dependencies: [\"Commands\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Runs an executable product */\n name: \"swift-run\",\n dependencies: [\"Commands\"],\n exclude: [\"CMakeLists.txt\"]\n ),\n .executableTarget(\n /** Interacts with package collections */\n name: \"swift-package-collection\",\n dependencies: [\"Commands\", \"PackageCollectionsCommand\"]\n ),\n .executableTarget(\n /** Multi-command entry point for SwiftPM. */\n name: \"swift-package-manager\",\n dependencies: [\n \"Basics\",\n \"Commands\",\n \"SwiftSDKCommand\",\n \"PackageCollectionsCommand\",\n \"PackageRegistryCommand\",\n ],\n linkerSettings: swiftpmLinkSettings\n ),\n .executableTarget(\n /** Interact with package registry */\n name: \"swift-package-registry\",\n dependencies: [\"Commands\", \"PackageRegistryCommand\"]\n ),\n .executableTarget(\n /** Utility to produce the artifacts for prebuilts */\n name: \"swift-build-prebuilts\",\n dependencies: [\n .product(name: \"ArgumentParser\", package: \"swift-argument-parser\"),\n \"Basics\",\n \"Workspace\",\n ],\n exclude: [\n \"build.sh\"\n ]\n ),\n\n // The `PackageDescription` target provides the API that is available\n // to `Package.swift` manifests. Here we build a debug version of the\n // library; the bootstrap scripts build the deployable version.\n .target(\n name: \"PackageDescription\",\n path: \"Sources/Runtimes/PackageDescription\",\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .define(\"USE_IMPL_ONLY_IMPORTS\"),\n .unsafeFlags([\"-package-description-version\", \"999.0\"]),\n .unsafeFlags([\"-enable-library-evolution\"]),\n ],\n linkerSettings: packageLibraryLinkSettings\n ),\n\n // The `PackagePlugin` target provides the API that is available to\n // plugin scripts. Here we build a debug version of the library; the\n // bootstrap scripts build the deployable version.\n .target(\n name: \"PackagePlugin\",\n path: \"Sources/Runtimes/PackagePlugin\",\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-package-description-version\", \"999.0\"]),\n .unsafeFlags([\"-enable-library-evolution\"]),\n ],\n linkerSettings: packageLibraryLinkSettings\n ),\n\n // MARK: Support for Swift macros, should eventually move to a plugin-based solution\n\n .target(\n name: \"CompilerPluginSupport\",\n dependencies: [\"PackageDescription\"],\n path: \"Sources/Runtimes/CompilerPluginSupport\",\n exclude: [\"CMakeLists.txt\"],\n swiftSettings: commonExperimentalFeatures + [\n .unsafeFlags([\"-package-description-version\", \"999.0\"]),\n .unsafeFlags([\"-enable-library-evolution\"]),\n ]\n ),\n\n // MARK: Additional Test Dependencies\n\n .target(\n /** SwiftPM internal build test suite support library */\n name: \"_InternalBuildTestSupport\",\n dependencies: [\n \"Build\",\n \"XCBuildSupport\",\n \"SwiftBuildSupport\",\n \"_InternalTestSupport\"\n ],\n swiftSettings: [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n .target(\n /** SwiftPM internal test suite support library */\n name: \"_InternalTestSupport\",\n dependencies: [\n \"Basics\",\n \"DriverSupport\",\n \"PackageFingerprint\",\n \"PackageGraph\",\n \"PackageLoading\",\n \"PackageRegistry\",\n \"PackageSigning\",\n \"SourceControl\",\n .product(name: \"OrderedCollections\", package: \"swift-collections\"),\n \"Workspace\",\n ] + swiftTSCTestSupportDeps,\n swiftSettings: [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n .target(\n /** SwiftPM internal test suite support library */\n name: \"_IntegrationTestSupport\",\n dependencies: [\n \"_InternalTestSupport\",\n ] + swiftTSCTestSupportDeps,\n ),\n\n .target(\n /** Test for thread-sanitizer. */\n name: \"tsan_utils\",\n dependencies: [],\n swiftSettings: [\n .unsafeFlags([\"-static\"]),\n ]\n ),\n\n // MARK: SwiftPM tests\n\n .testTarget(\n name: \"_AsyncFileSystemTests\",\n dependencies: [\n \"_AsyncFileSystem\",\n \"_InternalTestSupport\",\n ]\n ),\n\n .testTarget(\n name: \"SourceKitLSPAPITests\",\n dependencies: [\n \"SourceKitLSPAPI\",\n \"_InternalTestSupport\",\n ]\n ),\n\n .testTarget(\n name: \"BasicsTests\",\n dependencies: [\n \"Basics\",\n \"_InternalTestSupport\",\n \"tsan_utils\",\n ],\n exclude: [\n \"Archiver/Inputs/archive.tar.gz\",\n \"Archiver/Inputs/archive.zip\",\n \"Archiver/Inputs/invalid_archive.tar.gz\",\n \"Archiver/Inputs/invalid_archive.zip\",\n \"processInputs/long-stdout-stderr\",\n \"processInputs/long-stdout-stderr.bat\",\n \"processInputs/exit4\",\n \"processInputs/exit4.bat\",\n \"processInputs/simple-stdout-stderr\",\n \"processInputs/simple-stdout-stderr.bat\",\n \"processInputs/deadlock-if-blocking-io\",\n \"processInputs/deadlock-if-blocking-io.bat\",\n \"processInputs/echo\",\n \"processInputs/echo.bat\",\n \"processInputs/in-to-out\",\n \"processInputs/in-to-out.bat\",\n ]\n ),\n .testTarget(\n name: \"BuildTests\",\n dependencies: [\"Build\", \"PackageModel\", \"Commands\", \"_InternalTestSupport\", \"_InternalBuildTestSupport\"]\n ),\n .testTarget(\n name: \"LLBuildManifestTests\",\n dependencies: [\"Basics\", \"LLBuildManifest\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"WorkspaceTests\",\n dependencies: [\"Workspace\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageDescriptionTests\",\n dependencies: [\"PackageDescription\"]\n ),\n .testTarget(\n name: \"SPMBuildCoreTests\",\n dependencies: [\"SPMBuildCore\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageLoadingTests\",\n dependencies: [\"PackageLoading\", \"_InternalTestSupport\"],\n exclude: [\"Inputs\", \"pkgconfigInputs\"]\n ),\n .testTarget(\n name: \"PackageModelTests\",\n dependencies: [\"PackageModel\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageGraphTests\",\n dependencies: [\"PackageGraph\", \"_InternalTestSupport\"],\n swiftSettings: commonExperimentalFeatures\n ),\n .testTarget(\n name: \"PackageGraphPerformanceTests\",\n dependencies: [\"PackageGraph\", \"_InternalTestSupport\"],\n exclude: [\n \"Inputs/PerfectHTTPServer.json\",\n \"Inputs/ZewoHTTPServer.json\",\n \"Inputs/SourceKitten.json\",\n \"Inputs/kitura.json\",\n ]\n ),\n .testTarget(\n name: \"PackageCollectionsModelTests\",\n dependencies: [\"PackageCollectionsModel\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageCollectionsSigningTests\",\n dependencies: [\"PackageCollectionsSigning\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageCollectionsTests\",\n dependencies: [\"PackageCollections\", \"_InternalTestSupport\", \"tsan_utils\"]\n ),\n .testTarget(\n name: \"PackageFingerprintTests\",\n dependencies: [\"PackageFingerprint\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackagePluginAPITests\",\n dependencies: [\"PackagePlugin\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"PackageRegistryTests\",\n dependencies: [\"_InternalTestSupport\", \"PackageRegistry\"]\n ),\n .testTarget(\n name: \"PackageSigningTests\",\n dependencies: [\"_InternalTestSupport\", \"PackageSigning\"]\n ),\n .testTarget(\n name: \"SBOMModelTests\",\n dependencies: [\"SBOMModel\", \"_InternalTestSupport\"],\n resources: [\n .copy(\"testfiles\"),\n ]\n ),\n .testTarget(\n name: \"QueryEngineTests\",\n dependencies: [\"QueryEngine\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"SourceControlTests\",\n dependencies: [\"SourceControl\", \"_InternalTestSupport\"],\n exclude: [\"Inputs/TestRepo.tgz\"]\n ),\n .testTarget(\n name: \"SwiftFixItTests\",\n dependencies: [\"SwiftFixIt\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"BinarySymbolsTests\",\n dependencies: [\"BinarySymbols\", \"_InternalTestSupport\"]\n ),\n .testTarget(\n name: \"XCBuildSupportTests\",\n dependencies: [\"XCBuildSupport\", \"_InternalTestSupport\", \"_InternalBuildTestSupport\"],\n exclude: [\"Inputs/Foo.pc\"]\n ),\n .testTarget(\n name: \"FunctionalPerformanceTests\",\n dependencies: [\n \"swift-package-manager\",\n \"_InternalTestSupport\",\n ]\n ),\n .testTarget(\n name: \"SwiftBuildSupportTests\",\n dependencies: [\"SwiftBuildSupport\", \"_InternalTestSupport\", \"_InternalBuildTestSupport\"]\n ),\n .testTarget(\n name: \"BuildMetalTests\",\n dependencies: [\n \"_InternalTestSupport\",\n \"Basics\"\n ]\n ),\n // Examples (These are built to ensure they stay up to date with the API.)\n .executableTarget(\n name: \"package-info\",\n dependencies: [\"Workspace\"],\n path: \"Examples/package-info/Sources/package-info\"\n )\n ],\n swiftLanguageModes: [.v5]\n)\n\n#if canImport(Darwin)\npackage.targets.append(contentsOf: [\n .executableTarget(\n name: \"swiftpm-testing-helper\"\n )\n])\n#endif\n\n// rdar://101868275 \"error: cannot find 'XCTAssertEqual' in scope\" can affect almost any functional test, so we flat out\n// disable them all until we know what is going on\nif ProcessInfo.processInfo.environment[\"SWIFTCI_DISABLE_SDK_DEPENDENT_TESTS\"] == nil {\n package.targets.append(contentsOf: [\n .testTarget(\n name: \"FunctionalTests\",\n dependencies: [\n \"swift-package-manager\",\n \"PackageModel\",\n \"_InternalTestSupport\",\n ]\n ),\n .executableTarget(\n name: \"dummy-swiftc\",\n dependencies: [\n \"Basics\",\n ]\n ),\n .testTarget(\n name: \"_InternalTestSupportTests\",\n dependencies: [\n \"_InternalTestSupport\"\n ]\n ),\n .testTarget(\n name: \"IntegrationTests\",\n dependencies: [\n \"_IntegrationTestSupport\",\n \"_InternalTestSupport\",\n ] + swiftTSCTestSupportDeps + swiftToolsCoreSupportAutoDeps,\n ),\n .testTarget(\n name: \"CommandsTests\",\n dependencies: [\n \"swift-package-manager\",\n \"Basics\",\n \"Build\",\n \"Commands\",\n \"PackageModel\",\n \"PackageRegistryCommand\",\n \"SourceControl\",\n \"_InternalTestSupport\",\n \"Workspace\",\n \"dummy-swiftc\",\n ]\n ),\n .testTarget(\n name: \"SwiftPMBuildServerTests\",\n dependencies: [\n \"SwiftPMBuildServer\",\n \"_InternalTestSupport\",\n ] + swiftToolsProtocolsDeps\n ),\n ])\n}\n\n\nfunc swiftSyntaxDependencies(_ names: [String]) -> [Target.Dependency] {\n /// Whether swift-syntax is being built as a single dynamic library instead of as a separate library per module.\n ///\n /// This means that the swift-syntax symbols don't need to be statically linked, which allows us to stay below the\n /// maximum number of exported symbols on Windows, in turn allowing us to build sourcekit-lsp using SwiftPM on Windows\n /// and run its tests.\n let buildDynamicSwiftSyntaxLibrary = ProcessInfo.processInfo.environment[\"SWIFTSYNTAX_BUILD_DYNAMIC_LIBRARY\"] != nil\n if buildDynamicSwiftSyntaxLibrary {\n return [.product(name: \"_SwiftSyntaxDynamic\", package: \"swift-syntax\")]\n } else {\n return names.map { .product(name: $0, package: \"swift-syntax\") }\n }\n}\n\n// Add package dependency on llbuild when not bootstrapping.\n//\n// When bootstrapping SwiftPM, we can't use llbuild as a package dependency it\n// will provided by whatever build system (SwiftCI, bootstrap script) is driving\n// the build process. So, we only add these dependencies if SwiftPM is being\n// built directly using SwiftPM. It is a bit unfortunate that we've add the\n// package dependency like this but there is no other good way of expressing\n// this right now.\n\n/// When not using local dependencies, the branch to use for llbuild and TSC repositories.\nlet relatedDependenciesBranch = \"main\"\n\nif ProcessInfo.processInfo.environment[\"SWIFTPM_LLBUILD_FWK\"] == nil {\n if ProcessInfo.processInfo.environment[\"SWIFTCI_USE_LOCAL_DEPS\"] == nil {\n package.dependencies += [\n .package(url: \"https://github.com/swiftlang/swift-llbuild.git\", branch: relatedDependenciesBranch),\n ]\n } else {\n // In Swift CI, use a local path to llbuild to interoperate with tools\n // like `update-checkout`, which control the sources externally.\n package.dependencies += [\n .package(name: \"swift-llbuild\", path: \"../llbuild\"),\n ]\n }\n package.targets.first(where: { $0.name == \"SPMLLBuild\" })!.dependencies += [\n .product(name: \"llbuildSwift\", package: \"swift-llbuild\"),\n ]\n}\n\nif ProcessInfo.processInfo.environment[\"SWIFTCI_USE_LOCAL_DEPS\"] == nil {\n package.dependencies += [\n // These need to match the versions in the swiftlang/swift repo,\n // utils/update_checkout/update-checkout-config.json\n // They are used to build the official swift toolchain.\n .package(url: \"https://github.com/swiftlang/swift-syntax.git\", branch: relatedDependenciesBranch),\n .package(url: \"https://github.com/apple/swift-argument-parser.git\", revision: \"1.6.1\"),\n .package(url: \"https://github.com/apple/swift-crypto.git\", revision: \"3.12.5\"),\n .package(url: \"https://github.com/apple/swift-system.git\", revision: \"1.5.0\"),\n .package(url: \"https://github.com/apple/swift-collections.git\", revision: \"1.1.6\"),\n .package(url: \"https://github.com/apple/swift-certificates.git\", revision: \"1.10.1\"),\n .package(url: \"https://github.com/swiftlang/swift-toolchain-sqlite.git\", revision: \"1.0.7\"),\n // Not in toolchain, used for use in previewing documentation\n .package(url: \"https://github.com/swiftlang/swift-docc-plugin\", from: \"1.1.0\"),\n ]\n if !swiftDriverDeps.isEmpty {\n package.dependencies += [\n .package(url: \"https://github.com/swiftlang/swift-tools-support-core.git\", branch: relatedDependenciesBranch),\n .package(url: \"https://github.com/swiftlang/swift-driver.git\", branch: relatedDependenciesBranch),\n ]\n }\n} else {\n package.dependencies += [\n .package(path: \"../swift-argument-parser\"),\n .package(path: \"../swift-crypto\"),\n .package(path: \"../swift-syntax\"),\n .package(path: \"../swift-system\"),\n .package(path: \"../swift-collections\"),\n .package(path: \"../swift-certificates\"),\n .package(path: \"../swift-toolchain-sqlite\"),\n ]\n if !swiftDriverDeps.isEmpty {\n package.dependencies += [\n .package(path: \"../swift-tools-support-core\"),\n .package(path: \"../swift-driver\"),\n ]\n }\n\n}\n\n/// If ENABLE_APPLE_PRODUCT_TYPES is set in the environment, then also define ENABLE_APPLE_PRODUCT_TYPES in each of the regular targets and test targets.\nif ProcessInfo.processInfo.environment[\"ENABLE_APPLE_PRODUCT_TYPES\"] == \"1\" {\n for target in package.targets.filter({ $0.type == .regular || $0.type == .test }) {\n target.swiftSettings = (target.swiftSettings ?? []) + [ .define(\"ENABLE_APPLE_PRODUCT_TYPES\") ]\n }\n}\n\nif !shouldUseSwiftBuildFramework {\n\n let swiftbuildsupport: Target = package.targets.first(where: { [\"SwiftBuildSupport\", \"SwiftPMBuildServer\", \"SwiftPMBuildServerTests\"].contains($0.name) } )!\n swiftbuildsupport.dependencies += [\n .product(name: \"SwiftBuild\", package: \"swift-build\"),\n ]\n\n swiftbuildsupport.dependencies += [\n // This is here to statically link the build service in the same executable as SwiftPM\n .product(name: \"SWBBuildService\", package: \"swift-build\"),\n ]\n\n if ProcessInfo.processInfo.environment[\"SWIFTCI_USE_LOCAL_DEPS\"] == nil {\n package.dependencies += [\n .package(url: \"https://github.com/swiftlang/swift-build.git\", branch: relatedDependenciesBranch),\n .package(url: \"https://github.com/swiftlang/swift-tools-protocols.git\", branch: relatedDependenciesBranch),\n ]\n } else {\n package.dependencies += [\n .package(path: \"../swift-build\"),\n .package(path: \"../swift-tools-protocols\"),\n ]\n }\n}\n" }, { "path": "README.md", "content": "# Swift Package Manager Project\n\nThe Swift Package Manager is a tool for managing distribution of source code, aimed at making it easy to share your code and reuse others’ code. The tool directly addresses the challenges of compiling and linking Swift packages, managing dependencies, versioning, and supporting flexible distribution and collaboration models.\n\nWe’ve designed the system to make it easy to share packages on services like GitHub, but packages are also great for private personal development, sharing code within a team, or at any other granularity.\n\nSwift Package Manager includes a build system that can build for macOS and Linux. Starting with Xcode 11, Xcode integrates with SwiftPM to provide support for including packages in iOS, macOS, watchOS, and tvOS applications.\n\nThe [SourceKit-LSP](https://github.com/swiftlang/sourcekit-lsp) project leverages libSwiftPM and provides [Language Server Protocol](https://langserver.org/) implementation for editors that support LSP.\n\n---\n\n## Table of Contents\n* [Getting Started](#getting-started)\n* [Documentation](#documentation)\n* [System Requirements](#system-requirements)\n* [Installation](#installation)\n* [Contributing](#contributing)\n* [Reporting issues](#reporting-issues)\n* [License](#license)\n\n---\n\n## Getting Started\n\nPlease use [this guide](https://www.swift.org/documentation/package-manager/) for learning package manager basics.\n\n---\n\n## Documentation\n\nFor Quick Help use the `swift package --help` command.\n\nFor documentation on using Swift Package Manager, creating packages, and more, see the [Package Manager Docs](https://docs.swift.org/swiftpm/documentation/packagemanagerdocs).\n\nFor documentation on developing the Swift Package Manager itself, see the [contribution guide](CONTRIBUTING.md).\n\nFor detailed documentation on the package manifest API, see [PackageDescription API](https://docs.swift.org/swiftpm/documentation/packagedescription).\n\nFor release notes with information about changes between versions, see the [release notes](Documentation/ReleaseNotes).\n\n---\n\n## System Requirements\n\nThe package manager’s system requirements are the same as [those for Swift](https://github.com/swiftlang/swift/blob/main/docs/HowToGuides/GettingStarted.md#system-requirements) with the caveat that the package manager requires Git at runtime as well as build-time.\n\n---\n\n## Installation\n\nThe package manager is available as part the Swift toolchains available on [Swift.org](https://swift.org/download/) including snapshots for the latest versions built from `main` branch. For installation instructions for downloaded snapshots, please see the [Getting Started](https://swift.org/getting-started/#installing-swift) section of [Swift.org](https://swift.org).\n\nThe Swift Package Manager is also included in Xcode 8.0 and all subsequent releases.\n\nYou can verify your installation by typing `swift package --version` in a terminal:\n\n```sh\n$ swift package --version\nApple Swift Package Manager - ...\n```\n\n## Contributing\n\nThere are several ways to contribute to Swift Package Manager. To learn about the policies, best practices that govern contributions to the Swift project and instructions for setting up the development environment please read the [Contributor Guide](CONTRIBUTING.md). \n\nThe Swift package manager uses [llbuild](https://github.com/apple/swift-llbuild) as the underlying build system for compiling source files. It is also open source and part of the Swift project.\n\n---\n\n## Reporting issues\n\nIf you have any trouble with the package manager, help is available. We recommend:\n\n* The [Swift Forums](https://forums.swift.org/c/development/swiftpm/),\n* SwiftPM's [bug tracker](https://github.com/swiftlang/swift-package-manager/issues)\n\nWhen reporting an issue please follow the bug reporting guidelines, they can be found in [contribution guide](./CONTRIBUTING.md#reporting-issues).\n\nIf you’re not comfortable sharing your question with the list, contact details for the code owners can be found in [CODEOWNERS](CODEOWNERS); however, Swift Forums is usually the best place to go for help.\n\n---\n\n## License\n\nCopyright 2015 - 2025 Apple Inc. and the Swift project authors. Licensed under Apache License v2.0 with Runtime Library Exception.\n\nSee [https://swift.org/LICENSE.txt](https://swift.org/LICENSE.txt) for license information.\n\nSee [https://swift.org/CONTRIBUTORS.txt](https://swift.org/CONTRIBUTORS.txt) for Swift project authors.\n" }, { "path": "Sources/AppleProductTypes/Product.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2021 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n\n@_spi(PackageProductSettings) import PackageDescription\n\n#if ENABLE_APPLE_PRODUCT_TYPES\nextension Product {\n /// Creates an iOS application package product.\n ///\n /// - Parameters:\n /// - name: The name of the application product.\n /// - targets: The targets to include in the application product; one and only one of them should be an executable target.\n /// - settings: The settings that define the core properties of the application.\n public static func iOSApplication(\n name: String,\n targets: [String],\n bundleIdentifier: String? = nil,\n teamIdentifier: String? = nil,\n displayVersion: String? = nil,\n bundleVersion: String? = nil,\n iconAssetName: String? = nil,\n accentColorAssetName: String? = nil,\n supportedDeviceFamilies: [ProductSetting.IOSAppInfo.DeviceFamily],\n supportedInterfaceOrientations: [ProductSetting.IOSAppInfo.InterfaceOrientation],\n capabilities: [ProductSetting.IOSAppInfo.Capability] = [],\n additionalInfoPlistContentFilePath: String? = nil\n ) -> Product {\n return iOSApplication(\n name: name,\n targets: targets,\n bundleIdentifier: bundleIdentifier,\n teamIdentifier: teamIdentifier,\n displayVersion: displayVersion,\n bundleVersion: bundleVersion,\n appIcon: iconAssetName.map({ .asset($0) }),\n accentColor: accentColorAssetName.map({ .asset($0) }),\n supportedDeviceFamilies: supportedDeviceFamilies,\n supportedInterfaceOrientations: supportedInterfaceOrientations,\n capabilities: capabilities,\n additionalInfoPlistContentFilePath: additionalInfoPlistContentFilePath\n )\n }\n\n /// Creates an iOS application package product.\n ///\n /// - Parameters:\n /// - name: The name of the application product.\n /// - targets: The targets to include in the application product; one and only one of them should be an executable target.\n /// - settings: The settings that define the core properties of the application.\n @available(_PackageDescription, introduced: 5.6)\n public static func iOSApplication(\n name: String,\n targets: [String],\n bundleIdentifier: String? = nil,\n teamIdentifier: String? = nil,\n displayVersion: String? = nil,\n bundleVersion: String? = nil,\n appIcon: ProductSetting.IOSAppInfo.AppIcon? = nil,\n accentColor: ProductSetting.IOSAppInfo.AccentColor? = nil,\n supportedDeviceFamilies: [ProductSetting.IOSAppInfo.DeviceFamily],\n supportedInterfaceOrientations: [ProductSetting.IOSAppInfo.InterfaceOrientation],\n capabilities: [ProductSetting.IOSAppInfo.Capability] = [],\n appCategory: ProductSetting.IOSAppInfo.AppCategory? = nil,\n additionalInfoPlistContentFilePath: String? = nil\n ) -> Product {\n return .executable(name: name, targets: targets, settings: [\n bundleIdentifier.map{ .bundleIdentifier($0) },\n teamIdentifier.map{ .teamIdentifier($0) },\n displayVersion.map{ .displayVersion($0) },\n bundleVersion.map{ .bundleVersion($0) },\n .iOSAppInfo(ProductSetting.IOSAppInfo(\n appIcon: appIcon,\n accentColor: accentColor,\n supportedDeviceFamilies: supportedDeviceFamilies,\n supportedInterfaceOrientations: supportedInterfaceOrientations,\n capabilities: capabilities,\n appCategory: appCategory,\n additionalInfoPlistContentFilePath: additionalInfoPlistContentFilePath\n ))\n ].compactMap{ $0 })\n }\n}\n#endif\n" }, { "path": "Sources/Basics/Archiver/Archiver.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\nimport struct Foundation.URL\n\n/// The `Archiver` protocol abstracts away the different operations surrounding archives.\npublic protocol Archiver: Sendable {\n /// A set of extensions the current archiver supports.\n var supportedExtensions: Set { get }\n\n /// Asynchronously extracts the contents of an archive to a destination folder.\n ///\n /// - Parameters:\n /// - archivePath: The `AbsolutePath` to the archive to extract.\n /// - destinationPath: The `AbsolutePath` to the directory to extract to.\n /// - completion: The completion handler that will be called when the operation finishes to notify of its success.\n @available(*, noasync, message: \"Use the async alternative\")\n func extract(\n from archivePath: AbsolutePath,\n to destinationPath: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n )\n\n /// Asynchronously compress the contents of a directory to a destination archive.\n ///\n /// - Parameters:\n /// - directory: The `AbsolutePath` to the archive to extract.\n /// - destinationPath: The `AbsolutePath` to the directory to extract to.\n func compress(\n directory: AbsolutePath,\n to destinationPath: AbsolutePath\n ) async throws\n\n /// Asynchronously validates if a file is an archive.\n ///\n /// - Parameters:\n /// - path: The `AbsolutePath` to the archive to validate.\n /// - completion: The completion handler that will be called when the operation finishes to notify of its success.\n @available(*, noasync, message: \"Use the async alternative\")\n func validate(\n path: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n )\n}\n\nextension Archiver {\n /// Asynchronously extracts the contents of an archive to a destination folder.\n ///\n /// - Parameters:\n /// - archivePath: The `AbsolutePath` to the archive to extract.\n /// - destinationPath: The `AbsolutePath` to the directory to extract to.\n public func extract(\n from archivePath: AbsolutePath,\n to destinationPath: AbsolutePath\n ) async throws {\n try await withCheckedThrowingContinuation { continuation in\n self.extract(from: archivePath, to: destinationPath, completion: { continuation.resume(with: $0) })\n }\n }\n\n /// Asynchronously validates if a file is an archive.\n ///\n /// - Parameters:\n /// - path: The `AbsolutePath` to the archive to validate.\n public func validate(\n path: AbsolutePath\n ) async throws -> Bool {\n try await withCheckedThrowingContinuation { continuation in\n self.validate(path: path, completion: { continuation.resume(with: $0) })\n }\n }\n\n package func isFileSupported(_ lastPathComponent: String) -> Bool {\n self.supportedExtensions.contains(where: { lastPathComponent.hasSuffix($0) })\n }\n}\n" }, { "path": "Sources/Basics/Archiver/TarArchiver.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Dispatch.DispatchQueue\nimport struct Dispatch.DispatchTime\nimport struct TSCBasic.FileSystemError\n\n/// An `Archiver` that handles Tar archives using the command-line `tar` tool.\npublic struct TarArchiver: Archiver {\n public let supportedExtensions: Set = [\"tar\", \"tar.gz\"]\n\n /// The file-system implementation used for various file-system operations and checks.\n private let fileSystem: FileSystem\n\n /// Helper for cancelling in-flight requests\n private let cancellator: Cancellator\n\n /// The underlying command\n internal let tarCommand: String\n\n /// Creates a `TarArchiver`.\n ///\n /// - Parameters:\n /// - fileSystem: The file system to used by the `TarArchiver`.\n /// - cancellator: Cancellation handler\n public init(fileSystem: FileSystem, cancellator: Cancellator? = .none) {\n self.fileSystem = fileSystem\n self.cancellator = cancellator ?? Cancellator(observabilityScope: .none)\n\n #if os(Windows)\n self.tarCommand = \"tar.exe\"\n #else\n self.tarCommand = \"tar\"\n #endif\n }\n\n public func extract(\n from archivePath: AbsolutePath,\n to destinationPath: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n ) {\n do {\n guard self.fileSystem.exists(archivePath) else {\n throw FileSystemError(.noEntry, archivePath.underlying)\n }\n\n guard self.fileSystem.isDirectory(destinationPath) else {\n throw FileSystemError(.notDirectory, destinationPath.underlying)\n }\n\n let process = AsyncProcess(\n arguments: [self.tarCommand, \"zxf\", archivePath.pathString, \"-C\", destinationPath.pathString]\n )\n\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n DispatchQueue.sharedConcurrent.async {\n defer { self.cancellator.deregister(registrationKey) }\n completion(.init(catching: {\n try process.launch()\n let processResult = try process.waitUntilExit()\n guard processResult.exitStatus == .terminated(code: 0) else {\n throw try StringError(processResult.utf8stderrOutput())\n }\n }))\n }\n } catch {\n return completion(.failure(error))\n }\n }\n\n public func compress(\n directory: AbsolutePath,\n to destinationPath: AbsolutePath\n ) async throws {\n\n guard self.fileSystem.isDirectory(directory) else {\n throw FileSystemError(.notDirectory, directory.underlying)\n }\n\n let process = AsyncProcess(\n arguments: [self.tarCommand, \"acf\", destinationPath.pathString, directory.basename],\n environment: .current,\n workingDirectory: directory.parentDirectory\n )\n\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n defer { self.cancellator.deregister(registrationKey) }\n\n try process.launch()\n let processResult = try await process.waitUntilExit()\n guard processResult.exitStatus == .terminated(code: 0) else {\n throw try StringError(processResult.utf8stderrOutput())\n }\n }\n\n public func validate(path: AbsolutePath, completion: @escaping @Sendable (Result) -> Void) {\n do {\n guard self.fileSystem.exists(path) else {\n throw FileSystemError(.noEntry, path.underlying)\n }\n\n let process = AsyncProcess(arguments: [self.tarCommand, \"tf\", path.pathString])\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n DispatchQueue.sharedConcurrent.async {\n defer { self.cancellator.deregister(registrationKey) }\n completion(.init(catching: {\n try process.launch()\n let processResult = try process.waitUntilExit()\n return processResult.exitStatus == .terminated(code: 0)\n }))\n }\n } catch {\n return completion(.failure(error))\n }\n }\n\n public func cancel(deadline: DispatchTime) throws {\n try self.cancellator.cancel(deadline: deadline)\n }\n}\n" }, { "path": "Sources/Basics/Archiver/UniversalArchiver.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n/// An `Archiver` that handles multiple formats by delegating to other existing archivers each dedicated to its own\n/// format.\npublic struct UniversalArchiver: Archiver {\n public let supportedExtensions: Set\n\n /// Errors specific to the implementation of ``UniversalArchiver``.\n enum Error: Swift.Error {\n case unknownFormat([String], AbsolutePath)\n case noFileNameExtension(AbsolutePath)\n\n var description: String {\n switch self {\n case .unknownFormat(let ext, let path):\n return \"unknown format with extension \\(ext.joined(separator: \".\")) at path `\\(path)`\"\n case .noFileNameExtension(let path):\n return \"file at path `\\(path)` has no extension to detect archival format from\"\n }\n }\n }\n\n /// A dictionary that maps file extension strings to archiver instances that supports these extensions.\n private let formatMapping: [String: any Archiver]\n\n public init(_ fileSystem: any FileSystem, _ cancellator: Cancellator? = nil) {\n var formatMapping = [String: any Archiver]()\n var supportedExtensions = Set()\n\n for archiver in [\n ZipArchiver(fileSystem: fileSystem, cancellator: cancellator),\n TarArchiver(fileSystem: fileSystem, cancellator: cancellator),\n ] as [any Archiver] {\n supportedExtensions.formUnion(archiver.supportedExtensions)\n for ext in archiver.supportedExtensions {\n formatMapping[ext] = archiver\n }\n }\n\n self.formatMapping = formatMapping\n self.supportedExtensions = supportedExtensions\n }\n\n private func archiver(for archivePath: AbsolutePath) throws -> any Archiver {\n guard var extensions = archivePath.allExtensions, extensions.count > 0 else {\n throw Error.noFileNameExtension(archivePath)\n }\n\n // None of the archivers support extensions with more than 2 extension components\n if extensions.count > 2 {\n extensions = extensions.suffix(2)\n }\n\n if let archiver = self.formatMapping[extensions.joined(separator: \".\")] {\n return archiver\n } else if let lastExtension = extensions.last, let archiver = self.formatMapping[lastExtension] {\n return archiver\n } else {\n throw Error.unknownFormat(extensions, archivePath)\n }\n }\n\n public func extract(\n from archivePath: AbsolutePath,\n to destinationPath: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n ) {\n do {\n let archiver = try archiver(for: archivePath)\n archiver.extract(from: archivePath, to: destinationPath, completion: completion)\n } catch {\n completion(.failure(error))\n }\n }\n\n public func compress(\n directory: AbsolutePath,\n to destinationPath: AbsolutePath\n ) async throws {\n let archiver = try archiver(for: destinationPath)\n try await archiver.compress(directory: directory, to: destinationPath)\n }\n\n public func validate(\n path: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n ) {\n do {\n let archiver = try archiver(for: path)\n archiver.validate(path: path, completion: completion)\n } catch {\n completion(.failure(error))\n }\n }\n}\n" }, { "path": "Sources/Basics/Archiver/ZipArchiver.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Dispatch\nimport struct TSCBasic.FileSystemError\n\n#if os(Windows)\nimport WinSDK\n#endif\n\n/// An `Archiver` that handles ZIP archives using the command-line `zip` and `unzip` tools.\npublic struct ZipArchiver: Archiver, Cancellable {\n public var supportedExtensions: Set { [\"zip\"] }\n\n /// The file-system implementation used for various file-system operations and checks.\n private let fileSystem: FileSystem\n\n /// Helper for cancelling in-flight requests\n private let cancellator: Cancellator\n\n /// Absolute path to the Windows tar in the system folder\n #if os(Windows)\n internal let windowsTar: String\n #else\n internal let unzip = \"unzip\"\n internal let zip = \"zip\"\n #endif\n\n #if os(FreeBSD)\n internal let tar = \"tar\"\n #endif\n\n /// Creates a `ZipArchiver`.\n ///\n /// - Parameters:\n /// - fileSystem: The file-system to be used by the `ZipArchiver`.\n /// - cancellator: Cancellation handler\n public init(fileSystem: FileSystem, cancellator: Cancellator? = .none) {\n self.fileSystem = fileSystem\n self.cancellator = cancellator ?? Cancellator(observabilityScope: .none)\n\n #if os(Windows)\n var tarPath: PWSTR?\n defer { CoTaskMemFree(tarPath) }\n let hr = withUnsafePointer(to: FOLDERID_System) { id in\n SHGetKnownFolderPath(id, DWORD(KF_FLAG_DEFAULT.rawValue), nil, &tarPath)\n }\n if hr == S_OK, let tarPath {\n windowsTar = String(decodingCString: tarPath, as: UTF16.self) + \"\\\\tar.exe\"\n } else {\n windowsTar = \"tar.exe\"\n }\n #endif\n }\n\n public func extract(\n from archivePath: AbsolutePath,\n to destinationPath: AbsolutePath,\n completion: @escaping @Sendable (Result) -> Void\n ) {\n do {\n guard self.fileSystem.exists(archivePath) else {\n throw FileSystemError(.noEntry, archivePath.underlying)\n }\n\n guard self.fileSystem.isDirectory(destinationPath) else {\n throw FileSystemError(.notDirectory, destinationPath.underlying)\n }\n\n #if os(Windows)\n // FileManager lost the ability to detect tar.exe as executable.\n // It's part of system32 anyway so use the absolute path.\n let process = AsyncProcess(arguments: [windowsTar, \"xf\", archivePath.pathString, \"-C\", destinationPath.pathString])\n #else\n let process = AsyncProcess(arguments: [\n self.unzip, archivePath.pathString, \"-d\", destinationPath.pathString,\n ])\n #endif\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n DispatchQueue.sharedConcurrent.async {\n defer { self.cancellator.deregister(registrationKey) }\n completion(.init(catching: {\n try process.launch()\n let processResult = try process.waitUntilExit()\n guard processResult.exitStatus == .terminated(code: 0) else {\n throw try StringError(processResult.utf8stderrOutput())\n }\n }))\n }\n } catch {\n return completion(.failure(error))\n }\n }\n\n public func compress(\n directory: AbsolutePath,\n to destinationPath: AbsolutePath\n ) async throws {\n guard self.fileSystem.isDirectory(directory) else {\n throw FileSystemError(.notDirectory, directory.underlying)\n }\n\n #if os(Windows)\n let process = AsyncProcess(\n // FIXME: are these the right arguments?\n arguments: [windowsTar, \"-a\", \"-c\", \"-f\", destinationPath.pathString, directory.basename],\n workingDirectory: directory.parentDirectory\n )\n #elseif os(FreeBSD)\n // On FreeBSD, the unzip command is available in base but not the zip command.\n // Therefore; we use libarchive(bsdtar) to produce the ZIP archive instead.\n let process = AsyncProcess(\n arguments: [\n self.tar, \"-c\", \"--format\", \"zip\", \"-f\", destinationPath.pathString,\n directory.basename,\n ],\n workingDirectory: directory.parentDirectory\n )\n #else\n // This is to work around `swift package-registry publish` tool failing on\n // Amazon Linux 2 due to it having an earlier Glibc version (rdar://116370323)\n // and therefore posix_spawn_file_actions_addchdir_np is unavailable.\n // Instead of passing `workingDirectory` param to TSC.Process, which will trigger\n // SPM_posix_spawn_file_actions_addchdir_np_supported check, we shell out and\n // do `cd` explicitly before `zip`.\n let process = AsyncProcess(\n arguments: [\n \"/bin/sh\",\n \"-c\",\n \"cd \\(directory.parentDirectory.underlying.pathString) && \\(self.zip) -ry \\(destinationPath.pathString) \\(directory.basename)\"\n ]\n )\n #endif\n\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n defer { self.cancellator.deregister(registrationKey) }\n\n try process.launch()\n let processResult = try await process.waitUntilExit()\n guard processResult.exitStatus == .terminated(code: 0) else {\n throw try StringError(processResult.utf8stderrOutput())\n }\n }\n\n public func validate(path: AbsolutePath, completion: @escaping @Sendable (Result) -> Void) {\n do {\n guard self.fileSystem.exists(path) else {\n throw FileSystemError(.noEntry, path.underlying)\n }\n\n #if os(Windows)\n let process = AsyncProcess(arguments: [windowsTar, \"tf\", path.pathString])\n #else\n let process = AsyncProcess(arguments: [self.unzip, \"-t\", path.pathString])\n #endif\n guard let registrationKey = self.cancellator.register(process) else {\n throw CancellationError.failedToRegisterProcess(process)\n }\n\n DispatchQueue.sharedConcurrent.async {\n defer { self.cancellator.deregister(registrationKey) }\n completion(.init(catching: {\n try process.launch()\n let processResult = try process.waitUntilExit()\n return processResult.exitStatus == .terminated(code: 0)\n }))\n }\n } catch {\n return completion(.failure(error))\n }\n }\n\n public func cancel(deadline: DispatchTime) throws {\n try self.cancellator.cancel(deadline: deadline)\n }\n}\n" }, { "path": "Sources/Basics/ArrayHelpers.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2025 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\npublic func nextItem(in array: [T], after item: T) -> T? {\n for (index, element) in array.enumerated() {\n if element == item {\n let nextIndex = index + 1\n return nextIndex < array.count ? array[nextIndex] : nil\n }\n }\n return nil // Item not found or it's the last item\n}\n\n/// Determines if an array contains all elements of a subset array in any order.\n/// - Parameters:\n/// - array: The array to search within\n/// - subset: The subset array to check for\n/// - shouldBeContiguous: if `true`, the subset match must be contiguous sequenence\n/// - Returns: `true` if all elements in `subset` are present in `array`, `false` otherwise\npublic func contains(array: [T], subset: [T], shouldBeContiguous: Bool = true) -> Bool {\n if shouldBeContiguous {\n return containsContiguousSubset(array: array, subset: subset)\n } else {\n return containsNonContiguousSubset(array: array, subset: subset)\n }\n}\n\n/// Determines if an array contains all elements of a subset array in any order.\n/// - Parameters:\n/// - array: The array to search within\n/// - subset: The subset array to check for\n/// - Returns: `true` if all elements in `subset` are present in `array`, `false` otherwise\ninternal func containsNonContiguousSubset(array: [T], subset: [T]) -> Bool {\n for element in subset {\n if !array.contains(element) {\n return false\n }\n }\n return true\n}\n\n/// Determines if an array contains a contiguous subsequence matching the subset array.\n/// - Parameters:\n/// - array: The array to search within\n/// - subset: The contiguous subset array to check for\n/// - Returns: `true` if `subset` appears as a contiguous subsequence in `array`, `false` otherwise\ninternal func containsContiguousSubset(array: [T], subset: [T]) -> Bool {\n guard !subset.isEmpty else { return true }\n guard subset.count <= array.count else { return false }\n\n for startIndex in 0...(array.count - subset.count) {\n var matches = true\n for (offset, element) in subset.enumerated() {\n if array[startIndex + offset] != element {\n matches = false\n break\n }\n }\n if matches {\n return true\n }\n }\n return false\n}\n" }, { "path": "Sources/Basics/AuthorizationProvider.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2021-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport TSCBasic\nimport struct Foundation.Data\nimport struct Foundation.Date\nimport struct Foundation.URL\n#if canImport(Security)\nimport Security\n#endif\n\npublic protocol AuthorizationProvider: Sendable {\n func authentication(for url: URL) -> (user: String, password: String)?\n}\n\npublic protocol AuthorizationWriter {\n func addOrUpdate(\n for url: URL,\n user: String,\n password: String,\n persist: Bool\n ) async throws\n\n func remove(for url: URL) async throws\n}\n\npublic enum AuthorizationProviderError: Error {\n case invalidURLHost\n case notFound\n case other(String)\n}\n\nextension AuthorizationProvider {\n @Sendable\n public func httpAuthorizationHeader(for url: URL) -> String? {\n guard let (user, password) = self.authentication(for: url) else {\n return nil\n }\n let authString = \"\\(user):\\(password)\"\n let authData = Data(authString.utf8)\n return \"Basic \\(authData.base64EncodedString())\"\n }\n}\n\n// MARK: - netrc\n\npublic final class NetrcAuthorizationProvider: AuthorizationProvider, AuthorizationWriter {\n // marked internal for testing\n internal let path: AbsolutePath\n private let fileSystem: FileSystem\n\n private let cache = ThreadSafeKeyValueStore()\n\n public init(path: AbsolutePath, fileSystem: FileSystem) throws {\n self.path = path\n self.fileSystem = fileSystem\n // validate file is okay at the time of initializing the provider\n _ = try Self.load(fileSystem: fileSystem, path: path)\n }\n\n public func addOrUpdate(\n for url: URL,\n user: String,\n password: String,\n persist: Bool = true\n ) async throws {\n guard let machine = Self.machine(for: url) else {\n throw AuthorizationProviderError.invalidURLHost\n }\n\n if !persist {\n self.cache[machine] = (user, password)\n return\n }\n\n // Same entry already exists, no need to add or update\n let netrc = try? Self.load(fileSystem: self.fileSystem, path: self.path)\n guard netrc?.machines\n .first(where: { $0.name.lowercased() == machine && $0.login == user && $0.password == password }) == nil\n else {\n return\n }\n\n do {\n // Append to end of file\n try self.fileSystem.withLock(on: self.path, type: .exclusive) {\n let contents = try? self.fileSystem.readFileContents(self.path).contents\n try self.fileSystem.writeFileContents(self.path) { stream in\n // Write existing contents\n if let contents, !contents.isEmpty {\n stream.write(contents)\n stream.write(\"\\n\")\n }\n stream.write(\"machine \\(machine) login \\(user) password \\(password)\")\n stream.write(\"\\n\")\n }\n }\n } catch {\n throw AuthorizationProviderError\n .other(\"Failed to update netrc file at \\(self.path): \\(error.interpolationDescription)\")\n }\n }\n\n public func remove(for url: URL) async throws {\n throw AuthorizationProviderError\n .other(\"User must edit netrc file at \\(self.path) manually to remove entries\")\n }\n\n public func authentication(for url: URL) -> (user: String, password: String)? {\n if let machine = Self.machine(for: url), let cached = self.cache[machine] {\n return cached\n }\n return self.machine(for: url).map { (user: $0.login, password: $0.password) }\n }\n\n private func machine(for url: URL) -> Basics.Netrc.Machine? {\n // Since updates are appended to the end of the file, we\n // take the _last_ match to use the most recent entry.\n if let machine = Self.machine(for: url),\n let existing = self.machines.last(where: { $0.name.lowercased() == machine })\n {\n return existing\n }\n\n // No match found. Use the first default if any.\n if let existing = self.machines.first(where: { $0.isDefault }) {\n return existing\n }\n\n return .none\n }\n\n // marked internal for testing\n internal var machines: [Basics.Netrc.Machine] {\n // this ignores any errors reading the file\n // initial validation is done at the time of initializing the provider\n // and if the file becomes corrupt at runtime it will handle it gracefully\n let netrc = try? Self.load(fileSystem: self.fileSystem, path: self.path)\n return netrc?.machines ?? []\n }\n\n private static func load(fileSystem: FileSystem, path: AbsolutePath) throws -> Netrc? {\n do {\n return try NetrcParser.parse(fileSystem: fileSystem, path: path)\n } catch NetrcError.fileNotFound, NetrcError.machineNotFound {\n // These are recoverable errors.\n return .none\n }\n }\n\n private static func machine(for url: URL) -> String? {\n guard let host = url.host?.lowercased() else {\n return nil\n }\n return host.isEmpty ? nil : host\n }\n}\n\n// MARK: - Keychain\n\n#if canImport(Security)\npublic final class KeychainAuthorizationProvider: AuthorizationProvider, AuthorizationWriter {\n private let observabilityScope: ObservabilityScope\n\n private let cache = ThreadSafeKeyValueStore()\n\n public init(observabilityScope: ObservabilityScope) {\n self.observabilityScope = observabilityScope\n }\n\n public func addOrUpdate(\n for url: URL,\n user: String,\n password: String,\n persist: Bool = true\n ) async throws {\n guard let protocolHostPort = ProtocolHostPort(from: url) else {\n throw AuthorizationProviderError.invalidURLHost\n }\n\n self.observabilityScope\n .emit(debug: \"add/update credentials for '\\(protocolHostPort)' [\\(url.absoluteString)] in keychain\")\n\n if !persist {\n self.cache[protocolHostPort.description] = (user, password)\n return\n }\n\n let passwordData = Data(password.utf8)\n\n if !(try self.update(protocolHostPort: protocolHostPort, account: user, password: passwordData)) {\n try self.create(protocolHostPort: protocolHostPort, account: user, password: passwordData)\n }\n }\n\n public func remove(for url: URL) async throws {\n guard let protocolHostPort = ProtocolHostPort(from: url) else {\n throw AuthorizationProviderError.invalidURLHost\n }\n\n self.observabilityScope\n .emit(debug: \"remove credentials for '\\(protocolHostPort)' [\\(url.absoluteString)] from keychain\")\n\n try self.delete(protocolHostPort: protocolHostPort)\n }\n\n public func authentication(for url: URL) -> (user: String, password: String)? {\n guard let protocolHostPort = ProtocolHostPort(from: url) else {\n return nil\n }\n\n if let cached = self.cache[protocolHostPort.description] {\n return cached\n }\n\n self.observabilityScope\n .emit(debug: \"search credentials for '\\(protocolHostPort)' [\\(url.absoluteString)] in keychain\")\n\n do {\n guard let existingItems = try self.search(protocolHostPort: protocolHostPort) as? [[String: Any]] else {\n throw AuthorizationProviderError\n .other(\"Failed to extract credentials for '\\(protocolHostPort)' from keychain\")\n }\n\n // Log warning if there is more than one result\n if existingItems.count > 1 {\n self.observabilityScope\n .emit(\n warning: \"multiple (\\(existingItems.count)) keychain entries found for '\\(protocolHostPort)' [\\(url.absoluteString)]\"\n )\n }\n\n // Sort by modification timestamp\n let sortedItems = existingItems.sorted {\n switch (\n $0[kSecAttrModificationDate as String] as? Date,\n $1[kSecAttrModificationDate as String] as? Date\n ) {\n case (nil, nil):\n return false\n case (_, nil):\n return true\n case (nil, _):\n return false\n case (.some(let left), .some(let right)):\n return left < right\n }\n }\n\n // Return most recently modified item\n guard let mostRecent = sortedItems.last,\n let created = mostRecent[kSecAttrCreationDate as String] as? Date,\n // Get password for this specific item\n let existingItem = try self.get(\n protocolHostPort: protocolHostPort,\n created: created,\n modified: mostRecent[kSecAttrModificationDate as String] as? Date\n ) as? [String: Any],\n let passwordData = existingItem[kSecValueData as String] as? Data,\n let account = existingItem[kSecAttrAccount as String] as? String\n else {\n throw AuthorizationProviderError\n .other(\"Failed to extract credentials for '\\(protocolHostPort)' from keychain\")\n }\n \n let password = String(decoding: passwordData, as: UTF8.self)\n\n return (user: account, password: password)\n } catch {\n switch error {\n case AuthorizationProviderError.notFound:\n self.observabilityScope.emit(debug: \"no credentials found for '\\(protocolHostPort)' in keychain\")\n case AuthorizationProviderError.other(let detail):\n self.observabilityScope.emit(error: detail)\n default:\n self.observabilityScope.emit(\n error: \"failed to find credentials for '\\(protocolHostPort)' in keychain\",\n underlyingError: error\n )\n }\n return nil\n }\n }\n\n private func create(protocolHostPort: ProtocolHostPort, account: String, password: Data) throws {\n var query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,\n kSecAttrProtocol as String: protocolHostPort.protocolCFString,\n kSecAttrServer as String: protocolHostPort.server,\n kSecAttrAccount as String: account,\n kSecValueData as String: password]\n\n if let port = protocolHostPort.port {\n query[kSecAttrPort as String] = port\n }\n\n let status = SecItemAdd(query as CFDictionary, nil)\n guard status == errSecSuccess else {\n throw AuthorizationProviderError\n .other(\"Failed to save credentials for '\\(protocolHostPort)' to keychain: status \\(status)\")\n }\n }\n\n private func update(protocolHostPort: ProtocolHostPort, account: String, password: Data) throws -> Bool {\n var query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,\n kSecAttrProtocol as String: protocolHostPort.protocolCFString,\n kSecAttrServer as String: protocolHostPort.server]\n\n if let port = protocolHostPort.port {\n query[kSecAttrPort as String] = port\n }\n\n let attributes: [String: Any] = [kSecAttrAccount as String: account,\n kSecValueData as String: password]\n\n let status = SecItemUpdate(query as CFDictionary, attributes as CFDictionary)\n guard status != errSecItemNotFound else {\n return false\n }\n guard status == errSecSuccess else {\n throw AuthorizationProviderError\n .other(\"Failed to update credentials for '\\(protocolHostPort)' in keychain: status \\(status)\")\n }\n return true\n }\n\n private func delete(protocolHostPort: ProtocolHostPort) throws {\n var query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,\n kSecAttrProtocol as String: protocolHostPort.protocolCFString,\n kSecAttrServer as String: protocolHostPort.server]\n\n if let port = protocolHostPort.port {\n query[kSecAttrPort as String] = port\n }\n\n let status = SecItemDelete(query as CFDictionary)\n guard status == errSecSuccess else {\n throw AuthorizationProviderError\n .other(\"Failed to delete credentials for '\\(protocolHostPort)' from keychain: status \\(status)\")\n }\n }\n\n private func search(protocolHostPort: ProtocolHostPort) throws -> CFTypeRef? {\n var query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,\n kSecAttrProtocol as String: protocolHostPort.protocolCFString,\n kSecAttrServer as String: protocolHostPort.server,\n kSecMatchLimit as String: kSecMatchLimitAll, // returns all matches\n kSecReturnAttributes as String: true]\n // https://developer.apple.com/documentation/security/keychain_services/keychain_items/searching_for_keychain_items\n // Can't combine `kSecMatchLimitAll` and `kSecReturnData` (which contains password)\n\n if let port = protocolHostPort.port {\n query[kSecAttrPort as String] = port\n }\n\n var items: CFTypeRef?\n // Search keychain for server's username and password, if any.\n let status = SecItemCopyMatching(query as CFDictionary, &items)\n guard status != errSecItemNotFound else {\n throw AuthorizationProviderError.notFound\n }\n guard status == errSecSuccess else {\n throw AuthorizationProviderError\n .other(\"Failed to find credentials for '\\(protocolHostPort)' in keychain: status \\(status)\")\n }\n\n return items\n }\n\n private func get(protocolHostPort: ProtocolHostPort, created: Date, modified: Date?) throws -> CFTypeRef? {\n self.observabilityScope\n .emit(debug: \"read credentials for '\\(protocolHostPort)', created at \\(created), in keychain\")\n\n var query: [String: Any] = [kSecClass as String: kSecClassInternetPassword,\n kSecAttrProtocol as String: protocolHostPort.protocolCFString,\n kSecAttrServer as String: protocolHostPort.server,\n kSecAttrCreationDate as String: created,\n kSecMatchLimit as String: kSecMatchLimitOne, // limit to one match\n kSecReturnAttributes as String: true,\n kSecReturnData as String: true] // password\n\n if let port = protocolHostPort.port {\n query[kSecAttrPort as String] = port\n }\n if let modified {\n query[kSecAttrModificationDate as String] = modified\n }\n\n var item: CFTypeRef?\n // Search keychain for server's username and password, if any.\n let status = SecItemCopyMatching(query as CFDictionary, &item)\n guard status != errSecItemNotFound else {\n throw AuthorizationProviderError.notFound\n }\n guard status == errSecSuccess else {\n throw AuthorizationProviderError\n .other(\"Failed to find credentials for '\\(protocolHostPort)' in keychain: status \\(status)\")\n }\n\n return item\n }\n\n struct ProtocolHostPort: Hashable, CustomStringConvertible {\n let `protocol`: String?\n let host: String\n let port: Int?\n\n var server: String {\n self.host\n }\n\n var protocolCFString: CFString {\n // See\n // https://developer.apple.com/documentation/security/keychain_services/keychain_items/item_attribute_keys_and_values?language=swift\n // for a list of possible values for the `kSecAttrProtocol` attribute.\n switch self.protocol {\n case \"https\":\n return kSecAttrProtocolHTTPS\n case \"http\":\n return kSecAttrProtocolHTTP\n default:\n return kSecAttrProtocolHTTPS\n }\n }\n\n init?(from url: URL) {\n guard let host = url.host?.lowercased(), !host.isEmpty else {\n return nil\n }\n\n self.protocol = url.scheme?.lowercased()\n self.host = host\n self.port = url.port\n }\n\n var description: String {\n \"\\(self.protocol.map { \"\\($0)://\" } ?? \"\")\\(self.host)\\(self.port.map { \":\\($0)\" } ?? \"\")\"\n }\n }\n}\n#endif\n\n// MARK: - Composite\n\npublic struct CompositeAuthorizationProvider: AuthorizationProvider {\n // marked internal for testing\n internal let providers: [AuthorizationProvider]\n private let observabilityScope: ObservabilityScope\n\n public init(_ providers: AuthorizationProvider..., observabilityScope: ObservabilityScope) {\n self.init(providers, observabilityScope: observabilityScope)\n }\n\n public init(_ providers: [AuthorizationProvider], observabilityScope: ObservabilityScope) {\n self.providers = providers\n self.observabilityScope = observabilityScope\n }\n\n public func authentication(for url: URL) -> (user: String, password: String)? {\n for provider in self.providers {\n if let authentication = provider.authentication(for: url) {\n switch provider {\n case let provider as NetrcAuthorizationProvider:\n self.observabilityScope.emit(info: \"credentials for \\(url) found in netrc file at \\(provider.path)\")\n #if canImport(Security)\n case is KeychainAuthorizationProvider:\n self.observabilityScope.emit(info: \"credentials for \\(url) found in keychain\")\n #endif\n default:\n self.observabilityScope.emit(info: \"credentials for \\(url) found in \\(provider)\")\n }\n return authentication\n }\n }\n return nil\n }\n}\n" }, { "path": "Sources/Basics/CMakeLists.txt", "content": "# This source file is part of the Swift open source project\n#\n# Copyright (c) 2014 - 2022 Apple Inc. and the Swift project authors\n# Licensed under Apache License v2.0 with Runtime Library Exception\n#\n# See http://swift.org/LICENSE.txt for license information\n# See http://swift.org/CONTRIBUTORS.txt for Swift project authors\n\nadd_library(Basics\n Archiver/Archiver.swift\n Archiver/TarArchiver.swift\n Archiver/ZipArchiver.swift\n Archiver/UniversalArchiver.swift\n AuthorizationProvider.swift\n Cancellator.swift\n Collections/ByteString+Extensions.swift\n Collections/Dictionary+Extensions.swift\n Collections/IdentifiableSet.swift\n Collections/String+Extensions.swift\n Concurrency/AsyncProcess.swift\n Concurrency/ConcurrencyHelpers.swift\n Concurrency/NSLock+Extensions.swift\n Concurrency/SendableBox.swift\n Concurrency/ThreadSafeArrayStore.swift\n Concurrency/ThreadSafeBox.swift\n Concurrency/ThreadSafeKeyValueStore.swift\n Concurrency/ThrowingDefer.swift\n Concurrency/TokenBucket.swift\n DispatchTimeInterval+Extensions.swift\n Environment/Environment.swift\n Environment/EnvironmentKey.swift\n Environment/EnvironmentShims.swift\n Errors.swift\n FileSystem/AbsolutePath.swift\n FileSystem/CommonParentDirectory.swift\n FileSystem/FileSystem+Extensions.swift\n FileSystem/InMemoryFileSystem.swift\n FileSystem/NativePathExtensions.swift\n FileSystem/RelativePath.swift\n FileSystem/TemporaryFile.swift\n FileSystem/TSCAdapters.swift\n FileSystem/VirtualFileSystem.swift\n FileSystem/VFSOverlay.swift\n Graph/AdjacencyMatrix.swift\n Graph/DirectedGraph.swift\n Graph/GraphAlgorithms.swift\n Graph/UndirectedGraph.swift\n SourceControlURL.swift\n HTTPClient/HTTPClient.swift\n HTTPClient/HTTPClientConfiguration.swift\n HTTPClient/HTTPClientError.swift\n HTTPClient/HTTPClientHeaders.swift\n HTTPClient/HTTPClientRequest.swift\n HTTPClient/HTTPClientResponse.swift\n HTTPClient/HTTPMethod.swift\n HTTPClient/LegacyHTTPClient.swift\n HTTPClient/LegacyHTTPClientRequest.swift\n HTTPClient/URLSessionHTTPClient.swift\n ImportScanning.swift\n JSON+Extensions.swift\n JSONDecoder+Extensions.swift\n Netrc.swift\n Observability.swift\n OSSignpost.swift\n Process.swift\n ProgressAnimation/NinjaProgressAnimation.swift\n ProgressAnimation/PercentProgressAnimation.swift\n ProgressAnimation/ProgressAnimationProtocol.swift\n ProgressAnimation/SingleLinePercentProgressAnimation.swift\n ProgressAnimation/ThrottledProgressAnimation.swift\n SQLite.swift\n Sandbox.swift\n SendableTimeInterval.swift\n Serialization/SerializedJSON.swift\n SwiftVersion.swift\n SQLiteBackedCache.swift\n TestingLibrary.swift\n Triple+Basics.swift\n URL.swift\n Version+Extensions.swift\n WritableByteStream+Extensions.swift\n Vendor/Triple.swift\n Vendor/Triple+Platforms.swift)\ntarget_link_libraries(Basics PUBLIC\n _AsyncFileSystem\n SwiftCollections::OrderedCollections\n TSCBasic\n TSCUtility)\ntarget_link_libraries(Basics PRIVATE\n SwiftCollections::DequeModule\n SPMSQLite3\n TSCclibc)\n\n# NOTE(compnerd) workaround for CMake not setting up include flags yet\nset_target_properties(Basics PROPERTIES\n INTERFACE_INCLUDE_DIRECTORIES ${CMAKE_Swift_MODULE_DIRECTORY})\ntarget_link_options(Basics PRIVATE\n \"$<$:SHELL:-Xlinker -framework -Xlinker Security>\")\n\ninstall(TARGETS Basics\n ARCHIVE DESTINATION lib\n LIBRARY DESTINATION lib\n RUNTIME DESTINATION bin)\nset_property(GLOBAL APPEND PROPERTY SwiftPM_EXPORTS Basics)\n" }, { "path": "Sources/Basics/Cancellator.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Dispatch\nimport Foundation\nimport class TSCBasic.Thread\n#if canImport(WinSDK)\nimport WinSDK\n#elseif canImport(Android)\nimport Android\n#endif\n\npublic typealias CancellationHandler = @Sendable (DispatchTime) async throws -> Void\n\npublic final class Cancellator: Cancellable, Sendable {\n public typealias RegistrationKey = String\n\n private let observabilityScope: ObservabilityScope?\n private let registry = ThreadSafeKeyValueStore()\n private let cancelling = ThreadSafeBox(false)\n\n private static let signalHandlerLock = NSLock()\n private static var isSignalHandlerInstalled = false\n\n public init(observabilityScope: ObservabilityScope?) {\n self.observabilityScope = observabilityScope\n }\n\n #if os(Windows)\n // unfortunately this is needed for C callback handlers used by Windows shutdown handler\n static var shared: Cancellator?\n #endif\n\n /// Installs signal handlers to terminate sub-processes on cancellation.\n public func installSignalHandlers() {\n Self.signalHandlerLock.withLock {\n precondition(!Self.isSignalHandlerInstalled)\n\n #if os(Windows)\n // Closures passed to `SetConsoleCtrlHandler` can't capture context, working around that with a global.\n Self.shared = self\n\n // set shutdown handler to terminate sub-processes, etc\n _ = SetConsoleCtrlHandler({ _ in\n // Terminate all processes on receiving an interrupt signal.\n try? Cancellator.shared?.cancel(deadline: .now() + .seconds(30))\n\n // Reset the handler.\n _ = SetConsoleCtrlHandler(nil, false)\n\n // Exit as if by signal()\n TerminateProcess(GetCurrentProcess(), 3)\n\n return true\n }, true)\n #else\n // trap SIGINT to terminate sub-processes, etc\n signal(SIGINT, SIG_IGN)\n let interruptSignalSource = DispatchSource.makeSignalSource(signal: SIGINT)\n interruptSignalSource.setEventHandler { [weak self] in\n // cancel the trap?\n interruptSignalSource.cancel()\n\n // Terminate all processes on receiving an interrupt signal.\n try? self?.cancel(deadline: .now() + .seconds(30))\n\n // Install the default signal handler.\n var action = sigaction()\n #if canImport(Darwin) || os(OpenBSD) || os(FreeBSD)\n action.__sigaction_u.__sa_handler = SIG_DFL\n #elseif canImport(Musl)\n action.__sa_handler.sa_handler = SIG_DFL\n #elseif os(Android)\n action.sa_handler = SIG_DFL\n #else\n action.__sigaction_handler = unsafeBitCast(\n SIG_DFL,\n to: sigaction.__Unnamed_union___sigaction_handler.self\n )\n #endif\n sigaction(SIGINT, &action, nil)\n kill(getpid(), SIGINT) // ignore-unacceptable-language\n }\n interruptSignalSource.resume()\n #endif\n\n Self.isSignalHandlerInstalled = true\n }\n }\n\n @discardableResult\n public func register(name: String, handler: @escaping CancellationHandler) -> RegistrationKey? {\n if self.cancelling.get() {\n self.observabilityScope?.emit(debug: \"not registering '\\(name)' with terminator, termination in progress\")\n return .none\n }\n let key = UUID().uuidString\n self.observabilityScope?.emit(debug: \"registering '\\(name)' with terminator\")\n self.registry[key] = (name: name, handler: handler)\n return key\n }\n\n @discardableResult\n public func register(name: String, handler: Cancellable) -> RegistrationKey? {\n self.register(name: name, handler: handler.cancel(deadline:))\n }\n\n @discardableResult\n public func register(name: String, handler: AsyncCancellable) -> RegistrationKey? {\n self.register(name: name, handler: handler.cancel(deadline:))\n }\n\n @discardableResult\n public func register(name: String, handler: @escaping @Sendable () throws -> Void) -> RegistrationKey? {\n self.register(name: name, handler: { _ in try handler() })\n }\n\n package func register(_ process: AsyncProcess) -> RegistrationKey? {\n self.register(name: \"\\(process.arguments.joined(separator: \" \"))\", handler: process.terminate)\n }\n\n #if !canImport(Darwin) || os(macOS)\n public func register(_ process: Foundation.Process) -> RegistrationKey? {\n self.register(name: \"\\(process.description)\", handler: process.terminate(timeout:))\n }\n #endif\n\n public func deregister(_ key: RegistrationKey) {\n self.registry[key] = nil\n }\n\n public func cancel(deadline: DispatchTime) throws {\n self._cancel(deadline: deadline)\n }\n\n // marked internal for testing\n @discardableResult\n internal func _cancel(deadline: DispatchTime? = .none) -> Int {\n self.cancelling.put(true)\n\n self.observabilityScope?\n .emit(info: \"starting cancellation cycle with \\(self.registry.count) cancellation handlers registered\")\n\n let deadline = deadline ?? .now() + .seconds(30)\n // deadline for individual handlers set slightly before overall deadline\n let delta: DispatchTimeInterval = .nanoseconds(abs(deadline.distance(to: .now()).nanoseconds() ?? 0) / 5)\n let handlersDeadline = deadline - delta\n\n let cancellationHandlers = self.registry.get()\n let cancelled = ThreadSafeArrayStore()\n let group = DispatchGroup()\n for (_, (name, handler)) in cancellationHandlers {\n group.enter()\n Task {\n defer { group.leave() }\n do {\n self.observabilityScope?.emit(debug: \"cancelling '\\(name)'\")\n try await handler(handlersDeadline)\n cancelled.append(name)\n } catch {\n self.observabilityScope?.emit(\n warning: \"failed cancelling '\\(name)'\",\n underlyingError: error\n )\n }\n }\n }\n\n if case .timedOut = group.wait(timeout: deadline) {\n self.observabilityScope?\n .emit(\n warning: \"timeout waiting for cancellation with \\(cancellationHandlers.count - cancelled.count) cancellation handlers remaining\"\n )\n } else {\n self.observabilityScope?.emit(info: \"cancellation cycle completed successfully\")\n }\n\n self.cancelling.put(false)\n\n return cancelled.count\n }\n}\n\npublic protocol Cancellable {\n func cancel(deadline: DispatchTime) throws -> Void\n}\n\npublic protocol AsyncCancellable {\n func cancel(deadline: DispatchTime) async throws -> Void\n}\n\npublic struct CancellationError: Error, CustomStringConvertible {\n public let description: String\n\n public init() {\n self.init(description: \"Operation cancelled\")\n }\n\n private init(description: String) {\n self.description = description\n }\n\n static func failedToRegisterProcess(_ process: AsyncProcess) -> Self {\n Self(\n description: \"\"\"\n failed to register a cancellation handler for this process invocation `\\(\n process.arguments.joined(separator: \" \")\n )`\n \"\"\"\n )\n }\n}\n\nextension AsyncProcess {\n fileprivate func terminate(timeout: DispatchTime) {\n // send graceful shutdown signal\n self.signal(SIGINT)\n\n // start a thread to see if we need to terminate more forcibly\n let forceKillSemaphore = DispatchSemaphore(value: 0)\n let forceKillThread = TSCBasic.Thread {\n if case .timedOut = forceKillSemaphore.wait(timeout: timeout) {\n // send a force-kill signal // ignore-unacceptable-language\n #if os(Windows)\n self.signal(SIGTERM)\n #else\n self.signal(SIGKILL)\n #endif\n }\n }\n forceKillThread.start()\n _ = try? self.waitUntilExit()\n forceKillSemaphore.signal() // let the force-kill thread know we do not need it any more //ignore-unacceptable-language\n // join the force-kill thread thread so we don't exit before everything terminates //ignore-unacceptable-language\n forceKillThread.join()\n }\n}\n\n#if !canImport(Darwin) || os(macOS)\nextension Foundation.Process {\n fileprivate func terminate(timeout: DispatchTime) {\n guard self.isRunning else {\n return\n }\n\n // send graceful shutdown signal (SIGINT)\n self.interrupt()\n\n // start a thread to see if we need to terminate more forcibly\n let forceKillSemaphore = DispatchSemaphore(value: 0)\n let forceKillThread = TSCBasic.Thread {\n if case .timedOut = forceKillSemaphore.wait(timeout: timeout) {\n guard self.isRunning else {\n return\n }\n\n // force kill (SIGTERM) // ignore-unacceptable-language\n self.terminate()\n }\n }\n forceKillThread.start()\n self.waitUntilExit()\n forceKillSemaphore.signal() // let the force-kill thread know we do not need it any more //ignore-unacceptable-language\n // join the force-kill thread thread so we don't exit before everything terminates //ignore-unacceptable-language\n forceKillThread.join()\n }\n}\n#endif\n" }, { "path": "Sources/Basics/Collections/ByteString+Extensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct TSCBasic.ByteString\nimport struct TSCBasic.SHA256\n\nextension ByteString {\n /// A lowercase, hexadecimal representation of the SHA256 hash\n /// generated for the byte string's contents.\n ///\n /// This property uses the CryptoKit implementation of\n /// Secure Hashing Algorithm 2 (SHA-2) hashing with a 256-bit digest, when available,\n /// falling back on a native implementation in Swift provided by TSCBasic.\n public var sha256Checksum: String {\n SHA256().hash(self).hexadecimalRepresentation\n }\n\n public init(json: SerializedJSON) {\n self.init(json.underlying.utf8)\n }\n}\n" }, { "path": "Sources/Basics/Collections/Dictionary+Extensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport TSCBasic\n\nextension Dictionary {\n @inlinable\n @discardableResult\n public mutating func memoize(key: Key, body: () throws -> Value) rethrows -> Value {\n if let value = self[key] {\n return value\n }\n let value = try body()\n self[key] = value\n return value\n }\n}\n\nextension Dictionary {\n public init(throwingUniqueKeysWithValues keysAndValues: S) throws where S: Sequence, S.Element == (Key, Value) {\n self.init()\n for pair in keysAndValues {\n guard !self.keys.contains(pair.0) else {\n throw StringError(\"duplicate key found: '\\(pair.0)'\")\n }\n self[pair.0] = pair.1\n }\n }\n}\n" }, { "path": "Sources/Basics/Collections/IdentifiableSet.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct OrderedCollections.OrderedDictionary\n\n/// Replacement for `Set` elements that can't be `Hashable`, but can be `Identifiable`.\npublic struct IdentifiableSet: Collection {\n public init() {\n self.storage = [:]\n }\n\n public init(_ sequence: some Sequence) {\n self.storage = .init(pickLastWhenDuplicateFound: sequence)\n }\n\n fileprivate typealias Storage = OrderedDictionary\n\n public struct Index: Comparable {\n public static func < (lhs: IdentifiableSet.Index, rhs: IdentifiableSet.Index) -> Bool {\n lhs.storageIndex < rhs.storageIndex\n }\n\n fileprivate let storageIndex: Storage.Index\n }\n\n private var storage: Storage\n\n public var startIndex: Index {\n Index(storageIndex: self.storage.elements.startIndex)\n }\n\n public var endIndex: Index {\n Index(storageIndex: self.storage.elements.endIndex)\n }\n\n public var values: some Sequence {\n self.storage.values\n }\n\n public subscript(position: Index) -> Element {\n self.storage.elements[position.storageIndex].value\n }\n\n public subscript(id: Element.ID) -> Element? {\n get {\n self.storage[id]\n }\n set {\n self.storage[id] = newValue\n }\n }\n\n public func index(after i: Index) -> Index {\n Index(storageIndex: self.storage.elements.index(after: i.storageIndex))\n }\n\n public mutating func insert(_ element: Element) {\n self.storage[element.id] = element\n }\n\n public func union(_ otherSequence: some Sequence) -> Self {\n var result = self\n for element in otherSequence {\n result.storage[element.id] = element\n }\n return result\n }\n\n public mutating func formUnion(_ otherSequence: some Sequence) {\n for element in otherSequence {\n self.storage[element.id] = element\n }\n }\n\n public func intersection(_ otherSequence: some Sequence) -> Self {\n let keysToRemove = Set(self.storage.keys).subtracting(otherSequence.map(\\.id))\n var result = self\n for key in keysToRemove {\n result.storage.removeValue(forKey: key)\n }\n return result\n }\n\n public func subtracting(_ otherSequence: some Sequence) -> Self {\n var result = self\n for element in otherSequence {\n result.storage.removeValue(forKey: element.id)\n }\n return result\n }\n\n public func contains(id: Element.ID) -> Bool {\n self.storage.keys.contains(id)\n }\n\n public mutating func remove(id: Element.ID) -> Element? {\n self.storage.removeValue(forKey: id)\n }\n\n public mutating func remove(_ member: Element) -> Element? {\n self.storage.removeValue(forKey: member.id)\n }\n}\n\nextension OrderedDictionary where Value: Identifiable, Key == Value.ID {\n fileprivate init(pickLastWhenDuplicateFound sequence: some Sequence) {\n self.init(sequence.map { ($0.id, $0) }, uniquingKeysWith: { $1 })\n }\n}\n\nextension IdentifiableSet: Equatable {\n public static func == (_ lhs: Self, _ rhs: Self) -> Bool {\n lhs.storage.keys == rhs.storage.keys\n }\n}\n\nextension IdentifiableSet: Hashable {\n public func hash(into hasher: inout Hasher) {\n for key in self.storage.keys {\n hasher.combine(key)\n }\n }\n}\n\nextension IdentifiableSet: ExpressibleByArrayLiteral {\n public init(arrayLiteral elements: Element...) {\n self.init(elements)\n }\n}\n" }, { "path": "Sources/Basics/Collections/String+Extensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct TSCBasic.SHA256\n\nextension String {\n /// generated for the byte string's contents.\n ///\n /// This property uses the CryptoKit implementation of\n /// Secure Hashing Algorithm 2 (SHA-2) hashing with a 256-bit digest, when available,\n /// falling back on a native implementation in Swift provided by TSCBasic.\n public var sha256Checksum: String {\n SHA256().hash(self).hexadecimalRepresentation\n }\n\n /// Drops the given suffix from the string, if present.\n public func spm_dropPrefix(_ prefix: String) -> String {\n if self.hasPrefix(prefix) {\n return String(self.dropFirst(prefix.count))\n }\n return self\n }\n\n public var isValidIdentifier: Bool {\n guard !isEmpty else { return false }\n return allSatisfy { $0.isLetter || $0.isNumber || $0 == \"_\" }\n }\n}\n" }, { "path": "Sources/Basics/Concurrency/AsyncProcess.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2020 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\nimport Dispatch\nimport Foundation\n\n#if os(Windows)\nimport TSCLibc\n#elseif canImport(Android)\nimport Android\n#endif\n\n#if !os(Windows) && !canImport(Darwin)\n#if USE_IMPL_ONLY_IMPORTS\n@_implementationOnly\nimport func TSCclibc.SPM_posix_spawn_file_actions_addchdir_np_supported\n\n@_implementationOnly\nimport func TSCclibc.SPM_posix_spawn_file_actions_addchdir_np\n#else\nprivate import func TSCclibc.SPM_posix_spawn_file_actions_addchdir_np_supported\nprivate import func TSCclibc.SPM_posix_spawn_file_actions_addchdir_np\n#endif // #if USE_IMPL_ONLY_IMPORTS\n#endif\n\nimport class TSCBasic.CStringArray\nimport class TSCBasic.LocalFileOutputByteStream\nimport enum TSCBasic.SystemError\nimport class TSCBasic.Thread\nimport protocol TSCBasic.WritableByteStream\n\n/// Process result data which is available after process termination.\npackage struct AsyncProcessResult: CustomStringConvertible, Sendable {\n package enum Error: Swift.Error, Sendable {\n /// The output is not a valid UTF8 sequence.\n case illegalUTF8Sequence\n\n /// The process had a non zero exit.\n case nonZeroExit(AsyncProcessResult)\n\n /// The process failed with a `SystemError` (this is used to still provide context on the process that was\n /// launched).\n case systemError(arguments: [String], underlyingError: Swift.Error)\n }\n\n package enum ExitStatus: Equatable, Sendable {\n /// The process was terminated normally with a exit code.\n case terminated(code: Int32)\n #if os(Windows)\n /// The process was terminated abnormally.\n case abnormal(exception: UInt32)\n #else\n /// The process was terminated due to a signal.\n case signalled(signal: Int32)\n #endif\n }\n\n /// The arguments with which the process was launched.\n package let arguments: [String]\n\n /// The environment with which the process was launched.\n package let environment: Environment\n\n /// The exit status of the process.\n package let exitStatus: ExitStatus\n\n /// The output bytes of the process. Available only if the process was\n /// asked to redirect its output and no stdout output closure was set.\n package let output: Result<[UInt8], Swift.Error>\n\n /// The output bytes of the process. Available only if the process was\n /// asked to redirect its output and no stderr output closure was set.\n package let stderrOutput: Result<[UInt8], Swift.Error>\n\n /// Create an instance using a POSIX process exit status code and output result.\n ///\n /// See `waitpid(2)` for information on the exit status code.\n package init(\n arguments: [String],\n environment: Environment,\n exitStatusCode: Int32,\n normal: Bool,\n output: Result<[UInt8], Swift.Error>,\n stderrOutput: Result<[UInt8], Swift.Error>\n ) {\n let exitStatus: ExitStatus\n #if os(Windows)\n if normal {\n exitStatus = .terminated(code: exitStatusCode)\n } else {\n exitStatus = .abnormal(exception: UInt32(exitStatusCode))\n }\n #else\n if WIFSIGNALED(exitStatusCode) {\n exitStatus = .signalled(signal: WTERMSIG(exitStatusCode))\n } else {\n precondition(WIFEXITED(exitStatusCode), \"unexpected exit status \\(exitStatusCode)\")\n exitStatus = .terminated(code: WEXITSTATUS(exitStatusCode))\n }\n #endif\n self.init(\n arguments: arguments,\n environment: environment,\n exitStatus: exitStatus,\n output: output,\n stderrOutput: stderrOutput\n )\n }\n\n /// Create an instance using an exit status and output result.\n package init(\n arguments: [String],\n environment: Environment,\n exitStatus: ExitStatus,\n output: Result<[UInt8], Swift.Error>,\n stderrOutput: Result<[UInt8], Swift.Error>\n ) {\n self.arguments = arguments\n self.environment = environment\n self.output = output\n self.stderrOutput = stderrOutput\n self.exitStatus = exitStatus\n }\n\n /// Converts stdout output bytes to string, assuming they're UTF8.\n package func utf8Output() throws -> String {\n try String(decoding: output.get(), as: Unicode.UTF8.self)\n }\n\n /// Converts stderr output bytes to string, assuming they're UTF8.\n package func utf8stderrOutput() throws -> String {\n try String(decoding: stderrOutput.get(), as: Unicode.UTF8.self)\n }\n\n package var description: String {\n \"\"\"\n \n \"\"\"\n }\n}\n\nextension AsyncProcess: @unchecked Sendable {}\n\nextension DispatchQueue {\n // a shared concurrent queue for running concurrent asynchronous operations\n static let processConcurrent = DispatchQueue(\n label: \"swift.org.swift-tsc.process.concurrent\",\n attributes: .concurrent\n )\n}\n\n/// Process allows spawning new subprocesses and working with them.\n///\n/// Note: This class is thread safe.\npackage final class AsyncProcess {\n /// Errors when attempting to invoke a process\n package enum Error: Swift.Error, Sendable {\n /// The program requested to be executed cannot be found on the existing search paths, or is not executable.\n case missingExecutableProgram(program: String)\n\n /// The current OS does not support the workingDirectory API.\n case workingDirectoryNotSupported\n\n /// The stdin could not be opened.\n case stdinUnavailable\n }\n\n package typealias ReadableStream = AsyncStream<[UInt8]>\n\n package enum OutputRedirection: Sendable {\n /// Do not redirect the output\n case none\n\n /// Collect stdout and stderr output and provide it back via ``AsyncProcessResult`` object. If\n /// `redirectStderr` is `true`, `stderr` be redirected to `stdout`.\n case collect(redirectStderr: Bool)\n\n /// Stream `stdout` and `stderr` via the corresponding closures. If `redirectStderr` is `true`, `stderr` will\n /// be redirected to `stdout`.\n case stream(stdout: OutputClosure, stderr: OutputClosure, redirectStderr: Bool)\n\n /// Stream stdout and stderr as `AsyncSequence` provided as an argument to closures passed to\n /// ``AsyncProcess/launch(stdoutStream:stderrStream:)``.\n case asyncStream(\n stdoutStream: ReadableStream,\n stdoutContinuation: ReadableStream.Continuation,\n stderrStream: ReadableStream,\n stderrContinuation: ReadableStream.Continuation\n )\n\n /// Default collect OutputRedirection that defaults to not redirect stderr. Provided for API compatibility.\n package static let collect: Self = .collect(redirectStderr: false)\n\n /// Default stream OutputRedirection that defaults to not redirect stderr. Provided for API compatibility.\n package static func stream(stdout: @escaping OutputClosure, stderr: @escaping OutputClosure) -> Self {\n .stream(stdout: stdout, stderr: stderr, redirectStderr: false)\n }\n\n package var redirectsOutput: Bool {\n switch self {\n case .none:\n false\n case .collect, .stream, .asyncStream:\n true\n }\n }\n\n package var outputClosures: (stdoutClosure: OutputClosure, stderrClosure: OutputClosure)? {\n switch self {\n case let .stream(stdoutClosure, stderrClosure, _):\n (stdoutClosure: stdoutClosure, stderrClosure: stderrClosure)\n\n case let .asyncStream(_, stdoutContinuation, _, stderrContinuation):\n (stdoutClosure: { stdoutContinuation.yield($0) }, stderrClosure: { stderrContinuation.yield($0) })\n\n case .collect, .none:\n nil\n }\n }\n\n package var redirectStderr: Bool {\n switch self {\n case .collect(let redirectStderr):\n redirectStderr\n case .stream(_, _, let redirectStderr):\n redirectStderr\n default:\n false\n }\n }\n }\n\n // process execution mutable state\n private enum State {\n case idle\n case readingOutput(sync: DispatchGroup)\n case outputReady(stdout: Result<[UInt8], Swift.Error>, stderr: Result<[UInt8], Swift.Error>)\n case complete(AsyncProcessResult)\n case failed(Swift.Error)\n }\n\n /// Typealias for process id type.\n #if !os(Windows)\n package typealias ProcessID = pid_t\n #else\n package typealias ProcessID = DWORD\n #endif\n\n /// Typealias for stdout/stderr output closure.\n package typealias OutputClosure = @Sendable ([UInt8]) -> Void\n\n /// Typealias for logging handling closure.\n package typealias LoggingHandler = @Sendable (String) -> Void\n\n /// Global logging handler storage.\n private static let _loggingHandler = ThreadSafeBox()\n\n /// Global logging handler. Use with care! preferably use instance level instead of setting one globally.\n package static var loggingHandler: LoggingHandler? {\n get {\n return _loggingHandler.get() ?? nil\n }\n @available(\n *,\n deprecated,\n message: \"use instance level `loggingHandler` passed via `init` instead of setting one globally.\"\n )\n set {\n _loggingHandler.put(newValue)\n }\n }\n\n package let loggingHandler: LoggingHandler?\n\n /// The arguments to execute.\n package let arguments: [String]\n\n package let environment: Environment\n\n /// The path to the directory under which to run the process.\n package let workingDirectory: AbsolutePath?\n\n /// The process id of the spawned process, available after the process is launched.\n #if os(Windows)\n private var _process: Foundation.Process?\n package var processID: ProcessID {\n DWORD(self._process?.processIdentifier ?? 0)\n }\n #else\n package private(set) var processID = ProcessID()\n #endif\n\n // process execution mutable state\n private var state: State = .idle\n private let stateLock = NSLock()\n\n private static let sharedCompletionQueue = DispatchQueue(label: \"org.swift.tools-support-core.process-completion\")\n private var completionQueue = AsyncProcess.sharedCompletionQueue\n\n // ideally we would use the state for this, but we need to access it while the waitForExit is locking state\n private var _launched = false\n private let launchedLock = NSLock()\n\n package var launched: Bool {\n self.launchedLock.withLock {\n self._launched\n }\n }\n\n /// How process redirects its output.\n package let outputRedirection: OutputRedirection\n\n /// Indicates if a new progress group is created for the child process.\n private let startNewProcessGroup: Bool\n\n /// Cache of validated executables.\n ///\n /// Key: Executable name or path.\n /// Value: Path to the executable, if found.\n private static let validatedExecutablesMap = ThreadSafeKeyValueStore()\n\n /// Create a new process instance.\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - workingDirectory: The path to the directory under which to run the process.\n /// - outputRedirection: How process redirects its output. Default value is .collect.\n /// - startNewProcessGroup: If true, a new progress group is created for the child making it\n /// continue running even if the parent is killed or interrupted. Default value is true. //ignore-unacceptable-language\n /// - loggingHandler: Handler for logging messages\n ///\n package init(\n arguments: [String],\n environment: Environment = .current,\n workingDirectory: AbsolutePath,\n outputRedirection: OutputRedirection = .collect,\n startNewProcessGroup: Bool = true,\n loggingHandler: LoggingHandler? = .none\n ) {\n self.arguments = arguments\n self.environment = environment\n self.workingDirectory = workingDirectory\n self.outputRedirection = outputRedirection\n self.startNewProcessGroup = startNewProcessGroup\n self.loggingHandler = loggingHandler ?? AsyncProcess.loggingHandler\n }\n\n /// Create a new process instance.\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - outputRedirection: How process redirects its output. Default value is .collect.\n /// - verbose: If true, launch() will print the arguments of the subprocess before launching it.\n /// - startNewProcessGroup: If true, a new progress group is created for the child making it\n /// continue running even if the parent is killed or interrupted. Default value is true. //ignore-unacceptable-language\n /// - loggingHandler: Handler for logging messages\n package init(\n arguments: [String],\n environment: Environment = .current,\n outputRedirection: OutputRedirection = .collect,\n startNewProcessGroup: Bool = true,\n loggingHandler: LoggingHandler? = .none,\n workingDirectory: AbsolutePath? = nil\n ) {\n self.arguments = arguments\n self.environment = environment\n self.workingDirectory = workingDirectory\n self.outputRedirection = outputRedirection\n self.startNewProcessGroup = startNewProcessGroup\n self.loggingHandler = loggingHandler ?? AsyncProcess.loggingHandler\n }\n\n package convenience init(\n args: [String],\n environment: Environment = .current,\n outputRedirection: OutputRedirection = .collect,\n loggingHandler: LoggingHandler? = .none\n ) {\n self.init(\n arguments: args,\n environment: environment,\n outputRedirection: outputRedirection,\n loggingHandler: loggingHandler\n )\n }\n\n package convenience init(\n args: String...,\n environment: Environment = .current,\n outputRedirection: OutputRedirection = .collect,\n loggingHandler: LoggingHandler? = .none\n ) {\n self.init(\n arguments: args,\n environment: environment,\n outputRedirection: outputRedirection,\n loggingHandler: loggingHandler\n )\n }\n\n /// Returns the path of the the given program if found in the search paths.\n ///\n /// The program can be executable name, relative path or absolute path.\n package static func findExecutable(\n _ program: String,\n workingDirectory: AbsolutePath? = nil\n ) -> AbsolutePath? {\n if let abs = try? AbsolutePath(validating: program) {\n return abs\n }\n let cwdOpt = workingDirectory ?? localFileSystem.currentWorkingDirectory\n // The program might be a multi-component relative path.\n if let rel = try? RelativePath(validating: program), rel.components.count > 1 {\n if let cwd = cwdOpt {\n let abs = AbsolutePath(cwd, rel)\n if localFileSystem.isExecutableFile(abs) {\n return abs\n }\n }\n return nil\n }\n // From here on out, the program is an executable name, i.e. it doesn't contain a \"/\"\n let lookup: () -> AbsolutePath? = {\n let envSearchPaths = getEnvSearchPaths(\n pathString: Environment.current[.path],\n currentWorkingDirectory: cwdOpt\n )\n let value = lookupExecutablePath(\n filename: program,\n currentWorkingDirectory: cwdOpt,\n searchPaths: envSearchPaths\n )\n return value\n }\n // This should cover the most common cases, i.e. when the cache is most helpful.\n if workingDirectory == localFileSystem.currentWorkingDirectory {\n return AsyncProcess.validatedExecutablesMap.memoize(program, body: lookup)\n } else {\n return lookup()\n }\n }\n\n /// Launch the subprocess. Returns a WritableByteStream object that can be used to communicate to the process's\n /// stdin. If needed, the stream can be closed using the close() API. Otherwise, the stream will be closed\n /// automatically.\n @discardableResult\n package func launch() throws -> any WritableByteStream {\n precondition(\n self.arguments.count > 0 && !self.arguments[0].isEmpty,\n \"Need at least one argument to launch the process.\"\n )\n\n self.launchedLock.withLock {\n precondition(!self._launched, \"It is not allowed to launch the same process object again.\")\n self._launched = true\n }\n\n // Print the arguments if we are verbose.\n if let loggingHandler = self.loggingHandler {\n loggingHandler(self.arguments.map { $0.spm_shellEscaped() }.joined(separator: \" \"))\n }\n\n // Look for executable.\n let executable = self.arguments[0]\n guard let executablePath = AsyncProcess.findExecutable(executable, workingDirectory: workingDirectory) else {\n throw AsyncProcess.Error.missingExecutableProgram(program: executable)\n }\n\n #if os(Windows)\n let process = Foundation.Process()\n self._process = process\n process.arguments = Array(self.arguments.dropFirst()) // Avoid including the executable URL twice.\n if let workingDirectory {\n process.currentDirectoryURL = workingDirectory.asURL\n }\n process.executableURL = executablePath.asURL\n process.environment = .init(self.environment)\n\n let stdinPipe = Pipe()\n process.standardInput = stdinPipe\n\n let group = DispatchGroup()\n\n var stdout: [UInt8] = []\n let stdoutLock = NSLock()\n\n var stderr: [UInt8] = []\n let stderrLock = NSLock()\n\n if self.outputRedirection.redirectsOutput {\n let stdoutPipe = Pipe()\n let stderrPipe = Pipe()\n\n group.enter()\n stdoutPipe.fileHandleForReading.readabilityHandler = { (fh: FileHandle) in\n let data = (try? fh.read(upToCount: Int.max)) ?? Data()\n if data.count == 0 {\n stdoutPipe.fileHandleForReading.readabilityHandler = nil\n group.leave()\n } else {\n let contents = data.withUnsafeBytes { [UInt8]($0) }\n self.outputRedirection.outputClosures?.stdoutClosure(contents)\n stdoutLock.withLock {\n stdout += contents\n }\n }\n }\n\n group.enter()\n stderrPipe.fileHandleForReading.readabilityHandler = { (fh: FileHandle) in\n let data = (try? fh.read(upToCount: Int.max)) ?? Data()\n if data.count == 0 {\n stderrPipe.fileHandleForReading.readabilityHandler = nil\n group.leave()\n } else {\n let contents = data.withUnsafeBytes { [UInt8]($0) }\n self.outputRedirection.outputClosures?.stderrClosure(contents)\n stderrLock.withLock {\n stderr += contents\n }\n }\n }\n\n process.standardOutput = stdoutPipe\n process.standardError = stderrPipe\n }\n\n // first set state then start reading threads\n let sync = DispatchGroup()\n sync.enter()\n self.stateLock.withLock {\n self.state = .readingOutput(sync: sync)\n }\n\n group.notify(queue: self.completionQueue) {\n self.stateLock.withLock {\n self.state = .outputReady(stdout: .success(stdout), stderr: .success(stderr))\n }\n sync.leave()\n }\n\n try process.run()\n return stdinPipe.fileHandleForWriting\n #elseif(!canImport(Darwin) || os(macOS))\n // Initialize the spawn attributes.\n #if os(Android)\n var attributes: posix_spawnattr_t! = nil\n #elseif canImport(Darwin) || os(OpenBSD) || os(FreeBSD)\n var attributes: posix_spawnattr_t? = nil\n #else\n var attributes = posix_spawnattr_t()\n #endif\n posix_spawnattr_init(&attributes)\n defer { posix_spawnattr_destroy(&attributes) }\n\n // Unmask all signals.\n var noSignals = sigset_t()\n sigemptyset(&noSignals)\n posix_spawnattr_setsigmask(&attributes, &noSignals)\n\n // Reset all signals to default behavior.\n #if canImport(Darwin)\n var mostSignals = sigset_t()\n sigfillset(&mostSignals)\n sigdelset(&mostSignals, SIGKILL)\n sigdelset(&mostSignals, SIGSTOP)\n posix_spawnattr_setsigdefault(&attributes, &mostSignals)\n #else\n // On Linux, this can only be used to reset signals that are legal to\n // modify, so we have to take care about the set we use.\n var mostSignals = sigset_t()\n sigemptyset(&mostSignals)\n for i in 1 ..< SIGSYS {\n if i == SIGKILL || i == SIGSTOP {\n continue\n }\n sigaddset(&mostSignals, i)\n }\n posix_spawnattr_setsigdefault(&attributes, &mostSignals)\n #endif\n\n // Set the attribute flags.\n var flags = POSIX_SPAWN_SETSIGMASK | POSIX_SPAWN_SETSIGDEF\n if self.startNewProcessGroup {\n // Establish a separate process group.\n flags |= POSIX_SPAWN_SETPGROUP\n posix_spawnattr_setpgroup(&attributes, 0)\n }\n\n posix_spawnattr_setflags(&attributes, Int16(flags))\n\n // Setup the file actions.\n #if os(Android)\n var fileActions: posix_spawn_file_actions_t! = nil\n #elseif canImport(Darwin) || os(Android) || os(OpenBSD) || os(FreeBSD)\n var fileActions: posix_spawn_file_actions_t? = nil\n #else\n var fileActions = posix_spawn_file_actions_t()\n #endif\n posix_spawn_file_actions_init(&fileActions)\n defer { posix_spawn_file_actions_destroy(&fileActions) }\n\n if let workingDirectory = workingDirectory?.pathString {\n #if canImport(Darwin)\n posix_spawn_file_actions_addchdir_np(&fileActions, workingDirectory)\n #else\n guard SPM_posix_spawn_file_actions_addchdir_np_supported() else {\n throw AsyncProcess.Error.workingDirectoryNotSupported\n }\n\n SPM_posix_spawn_file_actions_addchdir_np(&fileActions, workingDirectory)\n #endif\n }\n\n var stdinPipe: [Int32] = [-1, -1]\n try open(pipe: &stdinPipe)\n\n guard let fp = fdopen(stdinPipe[1], \"wb\") else {\n throw AsyncProcess.Error.stdinUnavailable\n }\n let stdinStream = try LocalFileOutputByteStream(filePointer: fp, closeOnDeinit: true)\n\n // Dupe the read portion of the remote to 0.\n posix_spawn_file_actions_adddup2(&fileActions, stdinPipe[0], 0)\n\n // Close the other side's pipe since it was dupped to 0.\n posix_spawn_file_actions_addclose(&fileActions, stdinPipe[0])\n posix_spawn_file_actions_addclose(&fileActions, stdinPipe[1])\n\n var outputPipe: [Int32] = [-1, -1]\n var stderrPipe: [Int32] = [-1, -1]\n if self.outputRedirection.redirectsOutput {\n // Open the pipe.\n try open(pipe: &outputPipe)\n\n // Open the write end of the pipe.\n posix_spawn_file_actions_adddup2(&fileActions, outputPipe[1], 1)\n\n // Close the other ends of the pipe since they were dupped to 1.\n posix_spawn_file_actions_addclose(&fileActions, outputPipe[0])\n posix_spawn_file_actions_addclose(&fileActions, outputPipe[1])\n\n if self.outputRedirection.redirectStderr {\n // If merged was requested, send stderr to stdout.\n posix_spawn_file_actions_adddup2(&fileActions, 1, 2)\n } else {\n // If no redirect was requested, open the pipe for stderr.\n try open(pipe: &stderrPipe)\n posix_spawn_file_actions_adddup2(&fileActions, stderrPipe[1], 2)\n\n // Close the other ends of the pipe since they were dupped to 2.\n posix_spawn_file_actions_addclose(&fileActions, stderrPipe[0])\n posix_spawn_file_actions_addclose(&fileActions, stderrPipe[1])\n }\n } else {\n posix_spawn_file_actions_adddup2(&fileActions, 1, 1)\n posix_spawn_file_actions_adddup2(&fileActions, 2, 2)\n }\n\n var resolvedArgs = self.arguments\n if workingDirectory != nil {\n resolvedArgs[0] = executablePath.pathString\n }\n let argv = CStringArray(resolvedArgs)\n let envValues = environment.map { \"\\($0.0)=\\($0.1)\" }\n let env = CStringArray(envValues)\n let rv = posix_spawnp(&self.processID, argv.cArray[0]!, &fileActions, &attributes, argv.cArray, env.cArray)\n\n guard rv == 0 else {\n throw SystemError.posix_spawn(rv, self.arguments)\n }\n\n do {\n // Close the local read end of the input pipe.\n try close(fd: stdinPipe[0])\n\n let group = DispatchGroup()\n if !self.outputRedirection.redirectsOutput {\n // no stdout or stderr in this case\n self.stateLock.withLock {\n self.state = .outputReady(stdout: .success([]), stderr: .success([]))\n }\n } else {\n var pending: Result<[UInt8], Swift.Error>?\n let pendingLock = NSLock()\n\n let outputClosures = self.outputRedirection.outputClosures\n\n // Close the local write end of the output pipe.\n try close(fd: outputPipe[1])\n\n // Create a thread and start reading the output on it.\n group.enter()\n let stdoutThread = Thread { [weak self] in\n if let readResult = self?.readOutput(\n onFD: outputPipe[0],\n outputClosure: outputClosures?.stdoutClosure\n ) {\n pendingLock.withLock {\n if let stderrResult = pending {\n self?.stateLock.withLock {\n self?.state = .outputReady(stdout: readResult, stderr: stderrResult)\n }\n } else {\n pending = readResult\n }\n }\n group.leave()\n } else if let stderrResult = (pendingLock.withLock { pending }) {\n // TODO: this is more of an error\n self?.stateLock.withLock {\n self?.state = .outputReady(stdout: .success([]), stderr: stderrResult)\n }\n group.leave()\n }\n }\n\n // Only schedule a thread for stderr if no redirect was requested.\n var stderrThread: Thread? = nil\n if !self.outputRedirection.redirectStderr {\n // Close the local write end of the stderr pipe.\n try close(fd: stderrPipe[1])\n\n // Create a thread and start reading the stderr output on it.\n group.enter()\n stderrThread = Thread { [weak self] in\n if let readResult = self?.readOutput(\n onFD: stderrPipe[0],\n outputClosure: outputClosures?.stderrClosure\n ) {\n pendingLock.withLock {\n if let stdoutResult = pending {\n self?.stateLock.withLock {\n self?.state = .outputReady(stdout: stdoutResult, stderr: readResult)\n }\n } else {\n pending = readResult\n }\n }\n group.leave()\n } else if let stdoutResult = (pendingLock.withLock { pending }) {\n // TODO: this is more of an error\n self?.stateLock.withLock {\n self?.state = .outputReady(stdout: stdoutResult, stderr: .success([]))\n }\n group.leave()\n }\n }\n } else {\n pendingLock.withLock {\n pending = .success([]) // no stderr in this case\n }\n }\n\n // first set state then start reading threads\n self.stateLock.withLock {\n self.state = .readingOutput(sync: group)\n }\n\n stdoutThread.start()\n stderrThread?.start()\n }\n\n return stdinStream\n } catch {\n throw AsyncProcessResult.Error.systemError(arguments: self.arguments, underlyingError: error)\n }\n #else\n preconditionFailure(\"Process spawning is not available\")\n #endif // POSIX implementation\n }\n\n /// Executes the process I/O state machine, returning the result when finished.\n @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)\n @discardableResult\n package func waitUntilExit() async throws -> AsyncProcessResult {\n try await withCheckedThrowingContinuation { continuation in\n DispatchQueue.processConcurrent.async {\n self.waitUntilExit({\n continuation.resume(with: $0)\n })\n }\n }\n }\n\n /// Blocks the calling process until the subprocess finishes execution.\n @available(*, noasync)\n @discardableResult\n package func waitUntilExit() throws -> AsyncProcessResult {\n let group = DispatchGroup()\n group.enter()\n let resultBox = ThreadSafeBox?>()\n self.waitUntilExit { result in\n resultBox.put(result)\n group.leave()\n }\n group.wait()\n return try resultBox.get().unsafelyUnwrapped.get()\n }\n\n /// Executes the process I/O state machine, calling completion block when finished.\n private func waitUntilExit(_ completion: @Sendable @escaping (Result) -> Void) {\n self.stateLock.lock()\n switch self.state {\n case .idle:\n defer { self.stateLock.unlock() }\n preconditionFailure(\"The process is not yet launched.\")\n case .complete(let result):\n self.stateLock.unlock()\n completion(.success(result))\n case .failed(let error):\n self.stateLock.unlock()\n completion(.failure(error))\n case .readingOutput(let sync):\n self.stateLock.unlock()\n sync.notify(queue: self.completionQueue) {\n self.waitUntilExit(completion)\n }\n case .outputReady(let stdoutResult, let stderrResult):\n defer { self.stateLock.unlock() }\n // Wait until process finishes execution.\n #if os(Windows)\n precondition(self._process != nil, \"The process is not yet launched.\")\n let p = self._process!\n p.waitUntilExit()\n let exitStatusCode = p.terminationStatus\n let normalExit = p.terminationReason == .exit\n #else\n var exitStatusCode: Int32 = 0\n var result = waitpid(processID, &exitStatusCode, 0)\n while result == -1 && errno == EINTR {\n result = waitpid(self.processID, &exitStatusCode, 0)\n }\n if result == -1 {\n self.state = .failed(SystemError.waitpid(errno))\n }\n let normalExit = !WIFSIGNALED(result)\n #endif\n\n // Construct the result.\n let executionResult = AsyncProcessResult(\n arguments: arguments,\n environment: environment,\n exitStatusCode: exitStatusCode,\n normal: normalExit,\n output: stdoutResult,\n stderrOutput: stderrResult\n )\n self.state = .complete(executionResult)\n self.completionQueue.async {\n self.waitUntilExit(completion)\n }\n }\n }\n\n #if !os(Windows)\n /// Reads the given fd and returns its result.\n ///\n /// Closes the fd before returning.\n private func readOutput(onFD fd: Int32, outputClosure: OutputClosure?) -> Result<[UInt8], Swift.Error> {\n // Read all of the data from the output pipe.\n let N = 4096\n var buf = [UInt8](repeating: 0, count: N + 1)\n\n var out = [UInt8]()\n var error: Swift.Error? = nil\n loop: while true {\n let n = read(fd, &buf, N)\n switch n {\n case -1:\n if errno == EINTR {\n continue\n } else {\n error = SystemError.read(errno)\n break loop\n }\n case 0:\n // Close the read end of the output pipe.\n // We should avoid closing the read end of the pipe in case\n // -1 because the child process may still have content to be\n // flushed into the write end of the pipe. If the read end of the\n // pipe is closed, then a write will cause a SIGPIPE signal to\n // be generated for the calling process. If the calling process is\n // ignoring this signal, then write fails with the error EPIPE.\n close(fd)\n break loop\n default:\n let data = buf[0 ..< n]\n if let outputClosure {\n outputClosure(Array(data))\n } else {\n out += data\n }\n }\n }\n // Construct the output result.\n return error.map(Result.failure) ?? .success(out)\n }\n #endif\n\n /// Send a signal to the process.\n ///\n /// Note: This will signal all processes in the process group.\n package func signal(_ signal: Int32) {\n #if os(Windows)\n if signal == SIGINT {\n self._process?.interrupt()\n } else {\n self._process?.terminate()\n }\n #else\n assert(self.launched, \"The process is not yet launched.\")\n kill(self.startNewProcessGroup ? -self.processID : self.processID, signal) //ignore-unacceptable-language\n #endif\n }\n}\n\nextension AsyncProcess {\n /// Execute a subprocess and returns the result when it finishes execution\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n package static func popen(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) async throws -> AsyncProcessResult {\n let process = AsyncProcess(\n arguments: arguments,\n environment: environment,\n outputRedirection: .collect,\n loggingHandler: loggingHandler\n )\n try process.launch()\n return try await process.waitUntilExit()\n }\n\n /// Execute a subprocess and returns the result when it finishes execution\n ///\n /// - Parameters:\n /// - args: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n package static func popen(\n args: String...,\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) async throws -> AsyncProcessResult {\n try await self.popen(arguments: args, environment: environment, loggingHandler: loggingHandler)\n }\n\n package typealias DuplexStreamHandler =\n @Sendable (_ stdinStream: WritableByteStream, _ stdoutStream: ReadableStream) async throws -> ()\n package typealias ReadableStreamHandler =\n @Sendable (_ stderrStream: ReadableStream) async throws -> ()\n\n /// Launches a new `AsyncProcess` instances, allowing the caller to consume `stdout` and `stderr` output\n /// with handlers that support structured concurrency.\n /// - Parameters:\n /// - arguments: CLI command used to launch the process.\n /// - environment: environment variables passed to the launched process.\n /// - loggingHandler: handler used for logging,\n /// - stdoutHandler: asynchronous bidirectional handler closure that receives `stdin` and `stdout` streams as\n /// arguments.\n /// - stderrHandler: asynchronous unidirectional handler closure that receives `stderr` stream as an argument.\n /// - Returns: ``AsyncProcessResult`` value as received from the underlying ``AsyncProcess/waitUntilExit()`` call\n /// made on ``AsyncProcess`` instance.\n package static func popen(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none,\n stdoutHandler: @escaping DuplexStreamHandler,\n stderrHandler: ReadableStreamHandler? = nil\n ) async throws -> AsyncProcessResult {\n let (stdoutStream, stdoutContinuation) = ReadableStream.makeStream()\n let (stderrStream, stderrContinuation) = ReadableStream.makeStream()\n\n let process = AsyncProcess(\n arguments: arguments,\n environment: environment,\n outputRedirection: .stream {\n stdoutContinuation.yield($0)\n } stderr: {\n stderrContinuation.yield($0)\n },\n loggingHandler: loggingHandler\n )\n\n return try await withThrowingTaskGroup(of: Void.self) { group in\n let stdinStream = try process.launch()\n\n group.addTask {\n try await stdoutHandler(stdinStream, stdoutStream)\n }\n\n if let stderrHandler {\n group.addTask {\n try await stderrHandler(stderrStream)\n }\n }\n\n defer {\n stdoutContinuation.finish()\n stderrContinuation.finish()\n }\n\n return try await process.waitUntilExit()\n }\n }\n\n /// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process output (stdout + stderr).\n @discardableResult\n package static func checkNonZeroExit(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) async throws -> String {\n let result = try await popen(\n arguments: arguments,\n environment: environment,\n loggingHandler: loggingHandler\n )\n // Throw if there was a non zero termination.\n guard result.exitStatus == .terminated(code: 0) else {\n throw AsyncProcessResult.Error.nonZeroExit(result)\n }\n return try result.utf8Output()\n }\n\n /// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.\n ///\n /// - Parameters:\n /// - args: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process output (stdout + stderr).\n @discardableResult\n package static func checkNonZeroExit(\n args: String...,\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) async throws -> String {\n try await self.checkNonZeroExit(\n arguments: args,\n environment: environment,\n loggingHandler: loggingHandler\n )\n }\n}\n\nextension AsyncProcess {\n /// Execute a subprocess and calls completion block when it finishes execution\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - queue: Queue to use for callbacks\n /// - completion: A completion handler to return the process result\n @available(*, noasync)\n package static func popen(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none,\n queue: DispatchQueue? = nil,\n completion: @Sendable @escaping (Result) -> Void\n ) {\n let completionQueue = queue ?? Self.sharedCompletionQueue\n\n do {\n let process = AsyncProcess(\n arguments: arguments,\n environment: environment,\n outputRedirection: .collect,\n loggingHandler: loggingHandler\n )\n process.completionQueue = completionQueue\n try process.launch()\n process.waitUntilExit(completion)\n } catch {\n completionQueue.async {\n completion(.failure(error))\n }\n }\n }\n\n /// Execute a subprocess and block until it finishes execution\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process result.\n @available(*, noasync)\n @discardableResult\n package static func popen(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none,\n workingDirectory: AbsolutePath? = nil\n ) throws -> AsyncProcessResult {\n let process = AsyncProcess(\n arguments: arguments,\n environment: environment,\n outputRedirection: .collect,\n loggingHandler: loggingHandler,\n workingDirectory: workingDirectory\n )\n try process.launch()\n return try process.waitUntilExit()\n }\n\n /// Execute a subprocess and block until it finishes execution\n ///\n /// - Parameters:\n /// - args: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process result.\n @available(*, noasync)\n @discardableResult\n package static func popen(\n args: String...,\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) throws -> AsyncProcessResult {\n try AsyncProcess.popen(arguments: args, environment: environment, loggingHandler: loggingHandler)\n }\n\n /// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process output (stdout + stderr).\n @available(*, noasync)\n @discardableResult\n package static func checkNonZeroExit(\n arguments: [String],\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) throws -> String {\n let process = AsyncProcess(\n arguments: arguments,\n environment: environment,\n outputRedirection: .collect,\n loggingHandler: loggingHandler\n )\n try process.launch()\n let result = try process.waitUntilExit()\n // Throw if there was a non zero termination.\n guard result.exitStatus == .terminated(code: 0) else {\n throw AsyncProcessResult.Error.nonZeroExit(result)\n }\n return try result.utf8Output()\n }\n\n /// Execute a subprocess and get its (UTF-8) output if it has a non zero exit.\n ///\n /// - Parameters:\n /// - arguments: The arguments for the subprocess.\n /// - environment: The environment to pass to subprocess. By default the current process environment\n /// will be inherited.\n /// - loggingHandler: Handler for logging messages\n /// - Returns: The process output (stdout + stderr).\n @available(*, noasync)\n @discardableResult\n package static func checkNonZeroExit(\n args: String...,\n environment: Environment = .current,\n loggingHandler: LoggingHandler? = .none\n ) throws -> String {\n try self.checkNonZeroExit(arguments: args, environment: environment, loggingHandler: loggingHandler)\n }\n}\n\nextension AsyncProcess: Hashable {\n package func hash(into hasher: inout Hasher) {\n hasher.combine(ObjectIdentifier(self))\n }\n\n package static func == (lhs: AsyncProcess, rhs: AsyncProcess) -> Bool {\n ObjectIdentifier(lhs) == ObjectIdentifier(rhs)\n }\n}\n\n// MARK: - Private helpers\n\n#if !os(Windows)\n#if canImport(Darwin)\nprivate typealias swiftpm_posix_spawn_file_actions_t = posix_spawn_file_actions_t?\n#else\nprivate typealias swiftpm_posix_spawn_file_actions_t = posix_spawn_file_actions_t\n#endif\n\nprivate func WIFEXITED(_ status: Int32) -> Bool {\n _WSTATUS(status) == 0\n}\n\nprivate func _WSTATUS(_ status: Int32) -> Int32 {\n status & 0x7F\n}\n\nprivate func WIFSIGNALED(_ status: Int32) -> Bool {\n (_WSTATUS(status) != 0) && (_WSTATUS(status) != 0x7F)\n}\n\nprivate func WEXITSTATUS(_ status: Int32) -> Int32 {\n (status >> 8) & 0xFF\n}\n\nprivate func WTERMSIG(_ status: Int32) -> Int32 {\n status & 0x7F\n}\n\n/// Open the given pipe.\nprivate func open(pipe buffer: inout [Int32]) throws {\n let rv = pipe(&buffer)\n guard rv == 0 else {\n throw SystemError.pipe(rv)\n }\n}\n\n/// Close the given fd.\nprivate func close(fd: Int32) throws {\n func innerClose(_ fd: inout Int32) throws {\n let rv = close(fd)\n guard rv == 0 else {\n throw SystemError.close(rv)\n }\n }\n var innerFd = fd\n try innerClose(&innerFd)\n}\n\nextension AsyncProcess.Error: CustomStringConvertible {\n package var description: String {\n switch self {\n case .missingExecutableProgram(let program):\n \"could not find executable for '\\(program)'\"\n case .workingDirectoryNotSupported:\n \"workingDirectory is not supported in this platform\"\n case .stdinUnavailable:\n \"could not open stdin on this platform\"\n }\n }\n}\n\nextension AsyncProcess.Error: CustomNSError {\n package var errorUserInfo: [String: Any] {\n [NSLocalizedDescriptionKey: self.description]\n }\n}\n\n#endif\n\nextension AsyncProcessResult.Error: CustomStringConvertible {\n package var description: String {\n switch self {\n case .systemError(let arguments, let underlyingError):\n return \"error while executing `\\(arguments.joined(separator: \" \"))`: \\(underlyingError)\"\n case .illegalUTF8Sequence:\n return \"illegal UTF8 sequence output\"\n case .nonZeroExit(let result):\n var str = \"\"\n switch result.exitStatus {\n case .terminated(let code):\n str.append(contentsOf: \"terminated(\\(code)): \")\n #if os(Windows)\n case .abnormal(let exception):\n str.append(contentsOf: \"abnormal(\\(exception)): \")\n #else\n case .signalled(let signal):\n str.append(contentsOf: \"signalled(\\(signal)): \")\n #endif\n }\n\n // Strip sandbox information from arguments to keep things pretty.\n var args = result.arguments\n // This seems a little fragile.\n if args.first == \"sandbox-exec\", args.count > 3 {\n args = args.suffix(from: 3).map { $0 }\n }\n str.append(contentsOf: args.map { $0.spm_shellEscaped() }.joined(separator: \" \"))\n\n // Include the output, if present.\n if let output = try? result.utf8Output() + result.utf8stderrOutput() {\n // We indent the output to keep it visually separated from everything else.\n let indentation = \" \"\n str.append(contentsOf: \" output:\\n\")\n str.append(contentsOf: indentation)\n str.append(contentsOf: output.split(whereSeparator: { $0.isNewline })\n .joined(separator: \"\\n\\(indentation)\"))\n if !output.hasSuffix(\"\\n\") {\n str.append(contentsOf: \"\\n\")\n }\n }\n\n return str\n }\n }\n}\n\n#if os(Windows)\nextension FileHandle: WritableByteStream {\n package var position: Int {\n Int(offsetInFile)\n }\n\n package func write(_ byte: UInt8) {\n self.write(Data([byte]))\n }\n\n package func write(_ bytes: some Collection) {\n self.write(Data(bytes))\n }\n\n package func flush() {\n synchronizeFile()\n }\n}\n#endif\n" }, { "path": "Sources/Basics/Concurrency/ConcurrencyHelpers.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\nimport Dispatch\nimport class Foundation.NSLock\nimport class Foundation.ProcessInfo\nimport class Foundation.Thread\nimport struct Foundation.URL\nimport struct Foundation.UUID\nimport func TSCBasic.tsc_await\n\npublic enum Concurrency {\n public static var maxOperations: Int {\n Environment.current[\"SWIFTPM_MAX_CONCURRENT_OPERATIONS\"].flatMap(Int.init) ?? ProcessInfo.processInfo\n .activeProcessorCount\n }\n}\n\n@available(*, noasync, message: \"This method blocks the current thread indefinitely. Calling it from the concurrency pool can cause deadlocks\")\npublic func unsafe_await(_ body: @Sendable @escaping () async -> T) -> T {\n let semaphore = DispatchSemaphore(value: 0)\n\n let box = ThreadSafeBox()\n Task {\n let localValue: T = await body()\n box.mutate { _ in localValue }\n semaphore.signal()\n }\n semaphore.wait()\n return box.get()!\n}\n\nextension Task where Failure == Never {\n /// Runs `block` in a new thread and suspends until it finishes execution.\n ///\n /// - note: This function should be used sparingly, such as for long-running operations that may block and therefore should not be run on the Swift Concurrency thread pool. Do not use this for operations for which there may be many concurrent invocations as it could lead to thread explosion. It is meant to be a bridge to pre-existing blocking code which can't easily be converted to use Swift concurrency features.\n public static func detachNewThread(name: String? = nil, _ block: @Sendable @escaping () -> Success) async -> Success {\n return await withCheckedContinuation { continuation in\n Thread.detachNewThread {\n Thread.current.name = name\n return continuation.resume(returning: block())\n }\n }\n }\n}\n\nextension DispatchQueue {\n // a shared concurrent queue for running concurrent asynchronous operations\n public static let sharedConcurrent = DispatchQueue(\n label: \"swift.org.swiftpm.shared.concurrent\",\n attributes: .concurrent\n )\n}\n\nextension DispatchQueue {\n package func scheduleOnQueue(work: @escaping @Sendable () throws -> T) async throws -> T {\n try await withCheckedThrowingContinuation { continuation in\n self.async {\n do {\n continuation.resume(returning: try work())\n } catch {\n continuation.resume(throwing: error)\n }\n }\n }\n }\n\n package func asyncResult(_ callback: @escaping @Sendable (Result) -> Void, _ closure: @escaping @Sendable () async throws -> T) {\n let completion: @Sendable (Result) -> Void = {\n result in self.async {\n callback(result)\n }\n }\n\n Task {\n do {\n completion(.success(try await closure()))\n } catch {\n completion(.failure(error))\n }\n }\n }\n}\n\n/// A queue for running async operations with a limit on the number of concurrent tasks.\npublic final class AsyncOperationQueue: @unchecked Sendable {\n\n // This implementation is identical to the AsyncOperationQueue in swift-build.\n // Any modifications made here should also be made there.\n // https://github.com/swiftlang/swift-build/blob/main/Sources/SWBUtil/AsyncOperationQueue.swift#L13\n\n fileprivate typealias ID = UUID\n fileprivate typealias WaitingContinuation = CheckedContinuation\n\n private let concurrentTasks: Int\n private var waitingTasks: [WorkTask] = []\n private let waitingTasksLock = NSLock()\n\n fileprivate enum WorkTask {\n case creating(ID)\n case waiting(ID, WaitingContinuation)\n case running(ID)\n case cancelled(ID)\n\n var id: ID {\n switch self {\n case .creating(let id), .waiting(let id, _), .running(let id), .cancelled(let id):\n return id\n }\n }\n\n var continuation: WaitingContinuation? {\n guard case .waiting(_, let continuation) = self else {\n return nil\n }\n return continuation\n }\n }\n\n /// Creates an `AsyncOperationQueue` with a specified number of concurrent tasks.\n /// - Parameter concurrentTasks: The maximum number of concurrent tasks that can be executed concurrently.\n public init(concurrentTasks: Int) {\n self.concurrentTasks = concurrentTasks\n }\n\n deinit {\n waitingTasksLock.withLock {\n if !waitingTasks.isEmpty {\n preconditionFailure(\"Deallocated with waiting tasks\")\n }\n }\n }\n\n /// Executes an asynchronous operation, ensuring that the number of concurrent tasks\n // does not exceed the specified limit.\n /// - Parameter operation: The asynchronous operation to execute.\n /// - Returns: The result of the operation.\n /// - Throws: An error thrown by the operation, or a `CancellationError` if the operation is cancelled.\n public func withOperation(\n _ operation: () async throws -> sending ReturnValue\n ) async throws -> ReturnValue {\n let taskId = try await waitIfNeeded()\n defer { signalCompletion(taskId) }\n return try await operation()\n }\n\n private func waitIfNeeded() async throws -> ID {\n let workTask = waitingTasksLock.withLock({\n let shouldWait = waitingTasks.count >= concurrentTasks\n let workTask = shouldWait ? WorkTask.creating(ID()) : .running(ID())\n waitingTasks.append(workTask)\n return workTask\n })\n\n // If we aren't creating a task that needs to wait, we're under the concurrency limit.\n guard case .creating(let taskId) = workTask else {\n return workTask.id\n }\n\n enum TaskAction {\n case start(WaitingContinuation)\n case cancel(WaitingContinuation)\n }\n\n try await withTaskCancellationHandler {\n try await withCheckedThrowingContinuation { (continuation: WaitingContinuation) -> Void in\n let action: TaskAction? = waitingTasksLock.withLock {\n guard let index = waitingTasks.firstIndex(where: { $0.id == taskId }) else {\n // The task may have been marked as cancelled already and then removed from\n // waitingTasks in `signalCompletion`.\n return .cancel(continuation)\n }\n\n switch waitingTasks[index] {\n case .cancelled:\n // If the task was cancelled in between creating the task cancellation handler and acquiring the lock,\n // we should resume the continuation with a `CancellationError`.\n waitingTasks.remove(at: index)\n return .cancel(continuation)\n case .creating, .running, .waiting:\n // A task may have completed since we initially checked if we should wait. Check again in this locked\n // section and if we can start it, remove it from the waiting tasks and start it immediately.\n if waitingTasks.count >= concurrentTasks {\n waitingTasks[index] = .waiting(taskId, continuation)\n return nil\n } else {\n waitingTasks.remove(at: index)\n return .start(continuation)\n }\n }\n }\n\n switch action {\n case .some(.cancel(let continuation)):\n continuation.resume(throwing: _Concurrency.CancellationError())\n case .some(.start(let continuation)):\n continuation.resume()\n case .none:\n return\n }\n }\n } onCancel: {\n let continuation: WaitingContinuation? = self.waitingTasksLock.withLock {\n guard let taskIndex = self.waitingTasks.firstIndex(where: { $0.id == taskId }) else {\n return nil\n }\n\n switch self.waitingTasks[taskIndex] {\n case .waiting(_, let continuation):\n self.waitingTasks.remove(at: taskIndex)\n\n // If the parent task is cancelled then we need to manually handle resuming the\n // continuation for the waiting task with a `CancellationError`. Return the continuation\n // here so it can be resumed once the `waitingTasksLock` is released.\n return continuation\n case .creating, .running:\n // If the task was still being created, mark it as cancelled in `waitingTasks` so that\n // the handler for `withCheckedThrowingContinuation` can immediately cancel it.\n self.waitingTasks[taskIndex] = .cancelled(taskId)\n return nil\n case .cancelled:\n preconditionFailure(\"Attempting to cancel a task that was already cancelled\")\n }\n }\n\n continuation?.resume(throwing: _Concurrency.CancellationError())\n }\n return workTask.id\n }\n\n private func signalCompletion(_ taskId: ID) {\n let continuationToResume = waitingTasksLock.withLock { () -> WaitingContinuation? in\n guard !waitingTasks.isEmpty else {\n return nil\n }\n\n // Remove the completed task from the list to decrement the active task count.\n if let taskIndex = self.waitingTasks.firstIndex(where: { $0.id == taskId }) {\n waitingTasks.remove(at: taskIndex)\n }\n\n // We cannot remove elements from `waitingTasks` while iterating over it, so we make\n // a pass to collect operations and then apply them after the loop.\n func createTaskListOperations() -> (CollectionDifference?, WaitingContinuation?) {\n var changes: [CollectionDifference.Change] = []\n for (index, task) in waitingTasks.enumerated() {\n switch task {\n case .running:\n // Skip tasks that are already running, looking for the first one that is waiting or creating.\n continue\n case .creating:\n // If the next task is in the process of being created, let the\n // creation code in the `withCheckedThrowingContinuation` in `waitIfNeeded`\n // handle starting the task.\n break\n case .waiting:\n // Begin the next waiting task\n changes.append(.remove(offset: index, element: task, associatedWith: nil))\n return (CollectionDifference(changes), task.continuation)\n case .cancelled:\n // If the next task is cancelled, continue removing cancelled\n // tasks until we find one that hasn't run yet, or we exaust the list of waiting tasks.\n changes.append(.remove(offset: index, element: task, associatedWith: nil))\n continue\n }\n }\n return (CollectionDifference(changes), nil)\n }\n\n let (collectionOperations, continuation) = createTaskListOperations()\n if let operations = collectionOperations {\n guard let appliedDiff = waitingTasks.applying(operations) else {\n preconditionFailure(\"Failed to apply changes to waiting tasks\")\n }\n waitingTasks = appliedDiff\n }\n\n return continuation\n }\n\n continuationToResume?.resume()\n }\n}\n" }, { "path": "Sources/Basics/Concurrency/NSLock+Extensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.NSLock\n\nextension NSLock {\n /// Execute the given block while holding the lock.\n @discardableResult public func withLock(_ body: () throws -> T) rethrows -> T {\n lock()\n defer { unlock() }\n return try body()\n }\n}\n" }, { "path": "Sources/Basics/Concurrency/SendableBox.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct Foundation.Date\n\n/// A `Sendable` storage that allows access from concurrently running tasks in\n/// an `async` closure. This type serves as a replacement for `ThreadSafeBox`\n/// implemented with Swift Concurrency primitives.\npublic actor SendableBox {\n public init(_ value: Value) {\n self.value = value\n }\n\n public var value: Value\n\n public func set(_ value: Value) {\n self.value = value\n }\n}\n\nextension SendableBox where Value == Int {\n func increment() {\n self.value = value + 1\n }\n\n func decrement() {\n self.value = value - 1\n }\n}\n\nextension SendableBox where Value == Date {\n func resetDate() {\n value = Date()\n }\n}\n" }, { "path": "Sources/Basics/Concurrency/ThreadSafeArrayStore.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.NSLock\n\n/// Thread-safe array like structure\npublic final class ThreadSafeArrayStore {\n private var underlying: [Value]\n private let lock = NSLock()\n\n public init(_ seed: [Value] = []) {\n self.underlying = seed\n }\n\n public subscript(index: Int) -> Value? {\n self.lock.withLock {\n self.underlying[index]\n }\n }\n\n public func get() -> [Value] {\n self.lock.withLock {\n self.underlying\n }\n }\n\n @discardableResult\n public func clear() -> [Value] {\n self.lock.withLock {\n let underlying = self.underlying\n self.underlying.removeAll()\n return underlying\n }\n }\n\n @discardableResult\n public func append(_ item: Value) -> Int {\n self.lock.withLock {\n self.underlying.append(item)\n return self.underlying.count\n }\n }\n\n @discardableResult\n public func append(contentsOf items: [Value]) -> Int {\n self.lock.withLock {\n self.underlying.append(contentsOf: items)\n return self.underlying.count\n }\n }\n\n public var count: Int {\n self.lock.withLock {\n self.underlying.count\n }\n }\n\n public var isEmpty: Bool {\n self.lock.withLock {\n self.underlying.isEmpty\n }\n }\n\n public func map(_ transform: (Value) -> NewValue) -> [NewValue] {\n self.lock.withLock {\n self.underlying.map(transform)\n }\n }\n\n public func compactMap(_ transform: (Value) throws -> NewValue?) rethrows -> [NewValue] {\n try self.lock.withLock {\n try self.underlying.compactMap(transform)\n }\n }\n}\n\nextension ThreadSafeArrayStore: @unchecked Sendable where Value: Sendable {}\n" }, { "path": "Sources/Basics/Concurrency/ThreadSafeBox.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.NSLock\n\n/// Thread-safe value boxing structure that provides synchronized access to a wrapped value.\n@dynamicMemberLookup\npublic final class ThreadSafeBox {\n private var underlying: Value\n private let lock = NSLock()\n\n /// Creates a new thread-safe box with the given initial value.\n ///\n /// - Parameter seed: The initial value to store in the box.\n public init(_ seed: Value) {\n self.underlying = seed\n }\n\n /// Atomically mutates the stored value by applying a transformation function.\n ///\n /// The transformation function receives the current value and returns a new value\n /// to replace it. The entire operation is performed under a lock to ensure atomicity.\n ///\n /// - Parameter body: A closure that takes the current value and returns a new value.\n /// - Throws: Any error thrown by the transformation function.\n public func mutate(body: (Value) throws -> Value) rethrows {\n try self.lock.withLock {\n let value = try body(self.underlying)\n self.underlying = value\n }\n }\n\n /// Atomically mutates the stored value by applying an in-place transformation.\n ///\n /// The transformation function receives an inout reference to the current value,\n /// allowing direct modification. The entire operation is performed under a lock\n /// to ensure atomicity.\n ///\n /// - Parameter body: A closure that receives an inout reference to the current value.\n /// - Throws: Any error thrown by the transformation function.\n public func mutate(body: (inout Value) throws -> Void) rethrows {\n try self.lock.withLock {\n try body(&self.underlying)\n }\n }\n\n /// Atomically retrieves the current value from the box.\n ///\n /// - Returns: A copy of the current value stored in the box.\n public func get() -> Value {\n self.lock.withLock {\n self.underlying\n }\n }\n\n /// Atomically replaces the current value with a new value.\n ///\n /// - Parameter newValue: The new value to store in the box.\n public func put(_ newValue: Value) {\n self.lock.withLock {\n self.underlying = newValue\n }\n }\n\n /// Provides thread-safe read-only access to properties of the wrapped value.\n ///\n /// This subscript allows you to access properties of the wrapped value using\n /// dot notation while maintaining thread safety.\n ///\n /// - Parameter keyPath: A key path to a property of the wrapped value.\n /// - Returns: The value of the specified property.\n public subscript(dynamicMember keyPath: KeyPath) -> T {\n self.lock.withLock {\n self.underlying[keyPath: keyPath]\n }\n }\n\n /// Provides thread-safe read-write access to properties of the wrapped value.\n ///\n /// - Parameter keyPath: A writable key path to a property of the wrapped value.\n /// - Returns: The value of the specified property when getting.\n public subscript(dynamicMember keyPath: WritableKeyPath) -> T {\n get {\n self.lock.withLock {\n self.underlying[keyPath: keyPath]\n }\n }\n set {\n self.lock.withLock {\n self.underlying[keyPath: keyPath] = newValue\n }\n }\n }\n}\n\n// Extension for optional values to support empty initialization\nextension ThreadSafeBox {\n /// Creates a new thread-safe box initialized with nil for optional value types.\n ///\n /// This convenience initializer is only available when the wrapped value type is optional.\n public convenience init() where Value == Wrapped? {\n self.init(nil)\n }\n\n /// Takes the stored optional value, setting it to nil.\n /// - Returns: The previously stored value, or nil if none was present.\n public func takeValue() -> Value where Value == Wrapped? {\n self.lock.withLock {\n guard let value = self.underlying else { return nil }\n self.underlying = nil\n return value\n }\n }\n\n /// Atomically sets the stored optional value to nil.\n ///\n /// This method is only available when the wrapped value type is optional.\n public func clear() where Value == Wrapped? {\n self.lock.withLock {\n self.underlying = nil\n }\n }\n\n /// Atomically retrieves the stored value, returning a default if nil.\n ///\n /// This method is only available when the wrapped value type is optional.\n ///\n /// - Parameter defaultValue: The value to return if the stored value is nil.\n /// - Returns: The stored value if not nil, otherwise the default value.\n public func get(default defaultValue: Wrapped) -> Wrapped where Value == Wrapped? {\n self.lock.withLock {\n self.underlying ?? defaultValue\n }\n }\n\n /// Atomically computes and caches a value if not already present.\n ///\n /// If the box already contains a non-nil value, that value is returned immediately.\n /// Otherwise, the provided closure is executed to compute the value, which is then\n /// stored and returned. This method is only available when the wrapped value type is optional.\n ///\n /// - Parameter body: A closure that computes the value to store if none exists.\n /// - Returns: The cached value or the newly computed value.\n /// - Throws: Any error thrown by the computation closure.\n @discardableResult\n public func memoize(body: () throws -> Wrapped) rethrows -> Wrapped where Value == Wrapped? {\n try self.lock.withLock {\n if let value = self.underlying {\n return value\n }\n let value = try body()\n self.underlying = value\n return value\n }\n }\n\n /// Atomically computes and caches an optional value if not already present.\n ///\n /// If the box already contains a non-nil value, that value is returned immediately.\n /// Otherwise, the provided closure is executed to compute the value, which is then\n /// stored and returned. This method is only available when the wrapped value type is optional.\n ///\n /// If the returned value is `nil` subsequent calls to `memoize` or `memoizeOptional` will\n /// re-execute the closure.\n ///\n /// - Parameter body: A closure that computes the optional value to store if none exists.\n /// - Returns: The cached value or the newly computed value (which may be nil).\n /// - Throws: Any error thrown by the computation closure.\n @discardableResult\n public func memoizeOptional(body: () throws -> Wrapped?) rethrows -> Wrapped? where Value == Wrapped? {\n try self.lock.withLock {\n if let value = self.underlying {\n return value\n }\n let value = try body()\n self.underlying = value\n return value\n }\n }\n}\n\nextension ThreadSafeBox where Value == Int {\n /// Atomically increments the stored integer value by 1.\n ///\n /// This method is only available when the wrapped value type is Int.\n public func increment() {\n self.lock.withLock {\n self.underlying = self.underlying + 1\n }\n }\n\n /// Atomically decrements the stored integer value by 1.\n ///\n /// This method is only available when the wrapped value type is Int.\n public func decrement() {\n self.lock.withLock {\n self.underlying = self.underlying - 1\n }\n }\n}\n\nextension ThreadSafeBox where Value == String {\n /// Atomically appends a string to the stored string value.\n ///\n /// This method is only available when the wrapped value type is String.\n ///\n /// - Parameter value: The string to append to the current stored value.\n public func append(_ value: String) {\n self.mutate { existingValue in\n existingValue + value\n }\n }\n}\n\nextension ThreadSafeBox: @unchecked Sendable where Value: Sendable {}\n" }, { "path": "Sources/Basics/Concurrency/ThreadSafeKeyValueStore.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020-2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\n\nimport class Foundation.NSLock\n\n/// Thread-safe dictionary with async memoization\npublic actor ThrowingAsyncKeyValueMemoizer {\n var stored: [Key: Task] = [:]\n\n public init() {\n self.stored = [:]\n }\n\n public func memoize(_ key: Key, body: @Sendable @escaping () async throws -> Value) async throws -> Value {\n guard let existingTask = self.stored[key] else {\n let newTask = Task {\n try await body()\n }\n self.stored[key] = newTask\n return try await newTask.value\n }\n return try await existingTask.value\n }\n}\n\npublic actor AsyncKeyValueMemoizer {\n var stored: [Key: Task] = [:]\n\n public init() {\n self.stored = [:]\n }\n\n public func memoize(_ key: Key, body: @Sendable @escaping () async -> Value) async -> Value {\n guard let existingTask = self.stored[key] else {\n let newTask = Task {\n await body()\n }\n self.stored[key] = newTask\n return await newTask.value\n }\n return await existingTask.value\n }\n}\n\npublic actor AsyncThrowingValueMemoizer {\n var stored: ValueStorage?\n\n enum ValueStorage {\n case inProgress([CheckedContinuation])\n case complete(Result)\n }\n\n public init() {}\n\n public func memoize(body: @Sendable () async throws -> Value) async throws -> Value {\n guard let stored else {\n self.stored = .inProgress([])\n let result: Result\n do {\n result = try await .success(body())\n } catch {\n result = .failure(error)\n }\n if case .inProgress(let array) = self.stored {\n self.stored = .complete(result)\n array.forEach { $0.resume(with: result)}\n }\n return try result.get()\n }\n switch stored {\n\n case .inProgress(let existing):\n return try await withCheckedThrowingContinuation {\n self.stored = .inProgress(existing + [$0])\n }\n case .complete(let result):\n return try result.get()\n }\n }\n}\n\n/// Thread-safe dictionary like structure.\npublic final class ThreadSafeKeyValueStore where Key: Hashable {\n private var underlying: [Key: Value]\n private let lock = NSLock()\n\n public init(_ seed: [Key: Value] = [:]) {\n self.underlying = seed\n }\n\n public func get() -> [Key: Value] {\n self.lock.withLock {\n self.underlying\n }\n }\n\n public subscript(key: Key) -> Value? {\n get {\n self.lock.withLock {\n self.underlying[key]\n }\n } set {\n self.lock.withLock {\n self.underlying[key] = newValue\n }\n }\n }\n\n @discardableResult\n public func memoize(_ key: Key, body: () throws -> Value) rethrows -> Value {\n try self.lock.withLock {\n try self.underlying.memoize(key: key, body: body)\n }\n }\n\n @discardableResult\n public func removeValue(forKey key: Key) -> Value? {\n self.lock.withLock {\n self.underlying.removeValue(forKey: key)\n }\n }\n\n @discardableResult\n public func clear() -> [Key: Value] {\n self.lock.withLock {\n let underlying = self.underlying\n self.underlying.removeAll()\n return underlying\n }\n }\n\n public var count: Int {\n self.lock.withLock {\n self.underlying.count\n }\n }\n\n public var isEmpty: Bool {\n self.lock.withLock {\n self.underlying.isEmpty\n }\n }\n\n public func contains(_ key: Key) -> Bool {\n self.lock.withLock {\n self.underlying.keys.contains(key)\n }\n }\n\n public func map(_ transform: ((key: Key, value: Value)) throws -> T) rethrows -> [T] {\n try self.lock.withLock {\n try self.underlying.map(transform)\n }\n }\n\n public func mapValues(_ transform: (Value) throws -> T) rethrows -> [Key: T] {\n try self.lock.withLock {\n try self.underlying.mapValues(transform)\n }\n }\n}\n\nextension ThreadSafeKeyValueStore: @unchecked Sendable where Key: Sendable, Value: Sendable {}\n" }, { "path": "Sources/Basics/Concurrency/ThrowingDefer.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023-2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n/// Runs a cleanup closure (`deferred`) after a given `work` closure,\n/// making sure `deferred` is run also when `work` throws an error.\n/// - Parameters:\n/// - work: The work that should be performed. Will always be executed.\n/// - deferred: The cleanup that needs to be done in any case.\n/// - Throws: Any error thrown by `deferred` or `work` (in that order).\n/// - Returns: The result of `work`.\n/// - Note: If `work` **and** `deferred` throw an error,\n/// the one thrown by `deferred` is thrown from this function.\n/// - SeeAlso: ``withAsyncThrowing(do:defer:)``\npublic func withThrowing(\n do work: () throws -> T,\n defer deferred: () throws -> Void\n) throws -> T {\n do {\n let result = try work()\n try deferred()\n return result\n } catch {\n try deferred()\n throw error\n }\n}\n\n/// Runs an async cleanup closure (`deferred`) after a given async `work` closure,\n/// making sure `deferred` is run also when `work` throws an error.\n/// - Parameters:\n/// - work: The work that should be performed. Will always be executed.\n/// - deferred: The cleanup that needs to be done in any case.\n/// - Throws: Any error thrown by `deferred` or `work` (in that order).\n/// - Returns: The result of `work`.\n/// - Note: If `work` **and** `deferred` throw an error,\n/// the one thrown by `deferred` is thrown from this function.\n/// - SeeAlso: ``withThrowing(do:defer:)``\npublic func withAsyncThrowing(\n do work: @Sendable () async throws -> T,\n defer deferred: @Sendable () async throws -> Void\n) async throws -> T {\n do {\n let result = try await work()\n try await deferred()\n return result\n } catch {\n try await deferred()\n throw error\n }\n}\n" }, { "path": "Sources/Basics/Concurrency/TokenBucket.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\nprivate import DequeModule\n\n/// Type modeled after a \"token bucket\" pattern, which is similar to a semaphore, but is built with\n/// Swift Concurrency primitives.\npublic actor TokenBucket {\n private var tokens: Int\n private var waiters: Deque>\n\n public init(tokens: Int) {\n self.tokens = tokens\n self.waiters = Deque()\n }\n\n /// Executes an `async` closure immediately when a token is available.\n /// Only the same number of closures will be executed concurrently as the number\n /// of `tokens` passed to ``TokenBucket/init(tokens:)``, all subsequent\n /// invocations of `withToken` will suspend until a \"free\" token is available.\n /// - Parameter body: The closure to invoke when a token is available.\n /// - Returns: Resulting value returned by `body`.\n public func withToken(\n _ body: @Sendable () async throws -> ReturnType\n ) async rethrows -> ReturnType {\n await self.getToken()\n defer {\n self.returnToken()\n }\n\n return try await body()\n }\n\n private func getToken() async {\n if self.tokens > 0 {\n self.tokens -= 1\n return\n }\n\n await withCheckedContinuation {\n self.waiters.append($0)\n }\n }\n\n private func returnToken() {\n if let nextWaiter = self.waiters.popFirst() {\n nextWaiter.resume()\n } else {\n self.tokens += 1\n }\n }\n}\n" }, { "path": "Sources/Basics/DispatchTimeInterval+Extensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020-2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Dispatch\nimport struct Foundation.TimeInterval\n\nextension DispatchTimeInterval {\n public func timeInterval() -> TimeInterval? {\n switch self {\n case .seconds(let value):\n return Double(value)\n case .milliseconds(let value):\n return Double(value) / 1000\n case .microseconds(let value):\n return Double(value) / 1_000_000\n case .nanoseconds(let value):\n return Double(value) / 1_000_000_000\n default:\n return nil\n }\n }\n\n public func nanoseconds() -> Int? {\n switch self {\n case .seconds(let value):\n return value.multipliedReportingOverflow(by: 1_000_000_000).partialValue\n case .milliseconds(let value):\n return value.multipliedReportingOverflow(by: 1_000_000).partialValue\n case .microseconds(let value):\n return value.multipliedReportingOverflow(by: 1000).partialValue\n case .nanoseconds(let value):\n return value\n default:\n return nil\n }\n }\n\n public func milliseconds() -> Int? {\n switch self {\n case .seconds(let value):\n return value.multipliedReportingOverflow(by: 1000).partialValue\n case .milliseconds(let value):\n return value\n case .microseconds(let value):\n return Int(Double(value) / 1000)\n case .nanoseconds(let value):\n return Int(Double(value) / 1_000_000)\n default:\n return nil\n }\n }\n\n public func seconds() -> Int? {\n switch self {\n case .seconds(let value):\n return value\n case .milliseconds(let value):\n return Int(Double(value) / 1000)\n case .microseconds(let value):\n return Int(Double(value) / 1_000_000)\n case .nanoseconds(let value):\n return Int(Double(value) / 1_000_000_000)\n default:\n return nil\n }\n }\n\n public var descriptionInSeconds: String {\n switch self {\n case .seconds(let value):\n return \"\\(value)s\"\n case .milliseconds(let value):\n return String(format: \"%.2f\", Double(value) / Double(1000)) + \"s\"\n case .microseconds(let value):\n return String(format: \"%.2f\", Double(value) / Double(1_000_000)) + \"s\"\n case .nanoseconds(let value):\n return String(format: \"%.2f\", Double(value) / Double(1_000_000_000)) + \"s\"\n case .never:\n return \"n/a\"\n #if canImport(Darwin)\n @unknown default:\n return \"n/a\"\n #endif\n }\n }\n}\n\n// remove when available to all platforms\n#if os(Linux) || os(Windows) || os(Android) || os(OpenBSD) || os(FreeBSD)\nextension DispatchTime {\n public func distance(to: DispatchTime) -> DispatchTimeInterval {\n let final = to.uptimeNanoseconds\n let point = self.uptimeNanoseconds\n let duration = Int64(bitPattern: final.subtractingReportingOverflow(point).partialValue)\n return .nanoseconds(duration >= Int.max ? Int.max : Int(duration))\n }\n}\n#endif\n" }, { "path": "Sources/Basics/Environment/Environment.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Foundation\n\n#if canImport(Glibc)\nimport Glibc\n#elseif canImport(Musl)\nimport Musl\n#elseif os(Windows)\nimport CRT\nimport WinSDK\n#elseif canImport(Android)\nimport Android\n#else\nimport Darwin.C\n#endif\n\n// FIXME: Use Synchronization.Mutex when available\nprivate final class Mutex: @unchecked Sendable {\n var lock: NSLock\n var value: T\n\n init(value: T) {\n self.lock = .init()\n self.value = value\n }\n\n func withLock(_ body: (inout T) -> U) -> U {\n self.lock.lock()\n defer { self.lock.unlock() }\n return body(&self.value)\n }\n}\n\n// FIXME: This should come from Foundation\n// FIXME: package (public required by users)\npublic struct Environment {\n var storage: [EnvironmentKey: String]\n}\n\n// MARK: - Accessors\n\nextension Environment {\n package init() {\n self.storage = .init()\n }\n\n package subscript(_ key: EnvironmentKey) -> String? {\n _read { yield self.storage[key] }\n _modify { yield &self.storage[key] }\n }\n}\n\n// MARK: - Conversions between Dictionary\n\nextension Environment {\n @_spi(SwiftPMInternal)\n public init(_ dictionary: [String: String]) {\n self.storage = .init()\n let sorted = dictionary.sorted { $0.key < $1.key }\n for (key, value) in sorted {\n self.storage[.init(key)] = value\n }\n }\n}\n\nextension [String: String] {\n @_spi(SwiftPMInternal)\n public init(_ environment: Environment) {\n self.init()\n let sorted = environment.sorted { $0.key < $1.key }\n for (key, value) in sorted {\n self[key.rawValue] = value\n }\n }\n}\n\n// MARK: - Path Modification\n\nextension Environment {\n package mutating func prependPath(key: EnvironmentKey, value: String) {\n guard !value.isEmpty else { return }\n if let existing = self[key] {\n self[key] = \"\\(value)\\(Self.pathEntryDelimiter)\\(existing)\"\n } else {\n self[key] = value\n }\n }\n\n package mutating func appendPath(key: EnvironmentKey, value: String) {\n guard !value.isEmpty else { return }\n if let existing = self[key] {\n self[key] = \"\\(existing)\\(Self.pathEntryDelimiter)\\(value)\"\n } else {\n self[key] = value\n }\n }\n\n package static var pathEntryDelimiter: String {\n #if os(Windows)\n \";\"\n #else\n \":\"\n #endif\n }\n}\n\n// MARK: - Global Environment\n\nextension Environment {\n fileprivate static let _cachedCurrent = Mutex(value: nil)\n\n /// Vends a copy of the current process's environment variables.\n ///\n /// Mutations to the current process's global environment are not reflected\n /// in the returned value.\n public static var current: Self {\n Self._cachedCurrent.withLock { cachedValue in\n if let cachedValue = cachedValue {\n return cachedValue\n } else {\n let current = Self(ProcessInfo.processInfo.environment)\n cachedValue = current\n return current\n }\n }\n }\n\n /// Temporary override environment variables\n ///\n /// WARNING! This method is not thread-safe. POSIX environments are shared\n /// between threads. This means that when this method is called simultaneously\n /// from different threads, the environment will neither be setup nor restored\n /// correctly.\n package static func makeCustom(\n _ environment: Self,\n body: () async throws -> T\n ) async throws -> T {\n let current = Self.current\n let state = environment.storage.keys.map { ($0, current[$0]) }\n let restore = {\n for (key, value) in state {\n try Self.set(key: key, value: value)\n }\n }\n let returnValue: T\n do {\n for (key, value) in environment {\n try Self.set(key: key, value: value)\n }\n returnValue = try await body()\n } catch {\n try? restore()\n throw error\n }\n try restore()\n return returnValue\n }\n\n /// Temporary override environment variables\n ///\n /// WARNING! This method is not thread-safe. POSIX environments are shared\n /// between threads. This means that when this method is called simultaneously\n /// from different threads, the environment will neither be setup nor restored\n /// correctly.\n package static func makeCustom(\n _ environment: Self,\n body: () throws -> T\n ) throws -> T {\n let current = Self.current\n let state = environment.storage.keys.map { ($0, current[$0]) }\n let restore = {\n for (key, value) in state {\n try Self.set(key: key, value: value)\n }\n }\n let returnValue: T\n do {\n for (key, value) in environment {\n try Self.set(key: key, value: value)\n }\n returnValue = try body()\n } catch {\n try? restore()\n throw error\n }\n try restore()\n return returnValue\n }\n\n struct UpdateEnvironmentError: CustomStringConvertible, Error {\n var function: StaticString\n var code: Int32\n var description: String { \"\\(self.function) returned \\(self.code)\" }\n }\n\n /// Modifies the process's global environment.\n ///\n /// > Important: This operation is _not_ concurrency safe.\n package static func set(key: EnvironmentKey, value: String?) throws {\n #if os(Windows)\n func _SetEnvironmentVariableW(_ key: String, _ value: String?) -> Bool {\n key.withCString(encodedAs: UTF16.self) { key in\n if let value {\n value.withCString(encodedAs: UTF16.self) { value in\n SetEnvironmentVariableW(key, value)\n }\n } else {\n SetEnvironmentVariableW(key, nil)\n }\n }\n }\n #endif\n\n // Invalidate cached value after mutating the global environment.\n // This is potentially overly safe because we may not need to invalidate\n // the cache if the mutation fails. However this approach is easier to\n // read and reason about.\n defer { Self._cachedCurrent.withLock { $0 = nil } }\n if let value = value {\n #if os(Windows)\n guard _SetEnvironmentVariableW(key.rawValue, value) else {\n throw UpdateEnvironmentError(\n function: \"SetEnvironmentVariableW\",\n code: Int32(GetLastError())\n )\n }\n guard _putenv(\"\\(key)=\\(value)\") == 0 else {\n throw UpdateEnvironmentError(\n function: \"_putenv\",\n code: Int32(GetLastError())\n )\n }\n #else\n guard setenv(key.rawValue, value, 1) == 0 else {\n throw UpdateEnvironmentError(\n function: \"setenv\",\n code: errno\n )\n }\n #endif\n } else {\n #if os(Windows)\n guard _SetEnvironmentVariableW(key.rawValue, nil) else {\n throw UpdateEnvironmentError(\n function: \"SetEnvironmentVariableW\",\n code: Int32(GetLastError())\n )\n }\n guard _putenv(\"\\(key)=\") == 0 else {\n throw UpdateEnvironmentError(\n function: \"_putenv\",\n code: Int32(GetLastError())\n )\n }\n #else\n guard unsetenv(key.rawValue) == 0 else {\n throw UpdateEnvironmentError(\n function: \"unsetenv\",\n code: errno\n )\n }\n #endif\n }\n }\n}\n\n// MARK: - Cachable Keys\n\nextension Environment {\n /// Returns a copy of `self` with known non-cacheable keys removed.\n ///\n /// - Issue: rdar://107029374\n package var cachable: Environment {\n var cachable = Environment()\n for (key, value) in self {\n if !EnvironmentKey.nonCachable.contains(key) {\n cachable[key] = value\n }\n }\n return cachable\n }\n}\n\n// MARK: - Protocol Conformances\n\nextension Environment: Collection {\n public struct Index: Comparable {\n public static func < (lhs: Self, rhs: Self) -> Bool {\n lhs.underlying < rhs.underlying\n }\n\n var underlying: Dictionary.Index\n }\n\n public typealias Element = (key: EnvironmentKey, value: String)\n\n public var startIndex: Index {\n Index(underlying: self.storage.startIndex)\n }\n\n public var endIndex: Index {\n Index(underlying: self.storage.endIndex)\n }\n\n public subscript(index: Index) -> Element {\n self.storage[index.underlying]\n }\n\n public func index(after index: Self.Index) -> Self.Index {\n Index(underlying: self.storage.index(after: index.underlying))\n }\n}\n\nextension Environment: CustomStringConvertible {\n public var description: String {\n let body = self\n .sorted { $0.key < $1.key }\n .map { \"\\\"\\($0.rawValue)=\\($1)\\\"\" }\n .joined(separator: \", \")\n return \"[\\(body)]\"\n }\n}\n\nextension Environment: Encodable {\n public func encode(to encoder: any Encoder) throws {\n try self.storage.encode(to: encoder)\n }\n}\n\nextension Environment: Equatable {}\n\nextension Environment: ExpressibleByDictionaryLiteral {\n public typealias Key = EnvironmentKey\n public typealias Value = String\n\n public init(dictionaryLiteral elements: (Key, Value)...) {\n self.storage = .init()\n for (key, value) in elements {\n self.storage[key] = value\n }\n }\n}\n\nextension Environment: Decodable {\n public init(from decoder: any Decoder) throws {\n self.storage = try .init(from: decoder)\n }\n}\n\nextension Environment: Sendable {}\n" }, { "path": "Sources/Basics/Environment/EnvironmentKey.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n/// A key used to access values in an ``Environment``.\n///\n/// This type respects the compiled platform's case sensitivity requirements.\npublic struct EnvironmentKey {\n public var rawValue: String\n\n package init(_ rawValue: String) {\n self.rawValue = rawValue\n }\n}\n\nextension EnvironmentKey {\n package static let path: Self = \"PATH\"\n\n package static var libraryPath: Self {\n #if os(Windows)\n path\n #elseif canImport(Darwin)\n \"DYLD_LIBRARY_PATH\"\n #else\n \"LD_LIBRARY_PATH\"\n #endif\n }\n\n /// A set of known keys which should not be included in cache keys.\n package static let nonCachable: Set = [\n \"TERM\",\n \"TERM_PROGRAM\",\n \"TERM_PROGRAM_VERSION\",\n \"TERM_SESSION_ID\",\n \"ITERM_PROFILE\",\n \"ITERM_SESSION_ID\",\n \"SECURITYSESSIONID\",\n \"LaunchInstanceID\",\n \"LC_TERMINAL\",\n \"LC_TERMINAL_VERSION\",\n \"CLICOLOR\",\n \"LS_COLORS\",\n \"VSCODE_IPC_HOOK_CLI\",\n \"HYPERFINE_RANDOMIZED_ENVIRONMENT_OFFSET\",\n \"SSH_AUTH_SOCK\",\n ]\n}\n\nextension EnvironmentKey: CodingKeyRepresentable {}\n\nextension EnvironmentKey: Comparable {\n public static func < (lhs: Self, rhs: Self) -> Bool {\n // Even on windows use a stable sort order.\n lhs.rawValue < rhs.rawValue\n }\n}\n\nextension EnvironmentKey: CustomStringConvertible {\n public var description: String { self.rawValue }\n}\n\nextension EnvironmentKey: Encodable {\n public func encode(to encoder: any Encoder) throws {\n try self.rawValue.encode(to: encoder)\n }\n}\n\nextension EnvironmentKey: Equatable {\n public static func == (_ lhs: Self, _ rhs: Self) -> Bool {\n #if os(Windows)\n lhs.rawValue.lowercased() == rhs.rawValue.lowercased()\n #else\n lhs.rawValue == rhs.rawValue\n #endif\n }\n}\n\nextension EnvironmentKey: ExpressibleByStringLiteral {\n public init(stringLiteral rawValue: String) {\n self.init(rawValue)\n }\n}\n\nextension EnvironmentKey: Decodable {\n public init(from decoder: any Decoder) throws {\n self.rawValue = try String(from: decoder)\n }\n}\n\nextension EnvironmentKey: Hashable {\n public func hash(into hasher: inout Hasher) {\n #if os(Windows)\n self.rawValue.lowercased().hash(into: &hasher)\n #else\n self.rawValue.hash(into: &hasher)\n #endif\n }\n}\n\nextension EnvironmentKey: RawRepresentable {\n public init?(rawValue: String) {\n self.rawValue = rawValue\n }\n}\n\nextension EnvironmentKey: Sendable {}\n" }, { "path": "Sources/Basics/Environment/EnvironmentShims.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2021 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct TSCBasic.ProcessEnvironmentBlock\n\nimport Dispatch\n\n// FIXME: remove ProcessEnvironmentBlockShims\n// only needed outside this module for Git\nextension Environment {\n @_spi(ProcessEnvironmentBlockShim)\n public init(_ processEnvironmentBlock: ProcessEnvironmentBlock) {\n self.init()\n for (key, value) in processEnvironmentBlock {\n self[.init(key.value)] = value\n }\n }\n}\n\nextension ProcessEnvironmentBlock {\n @_spi(ProcessEnvironmentBlockShim)\n public init(_ environment: Environment) {\n self.init()\n for (key, value) in environment {\n self[.init(key.rawValue)] = value\n }\n }\n}\n" }, { "path": "Sources/Basics/Errors.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2020 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport protocol Foundation.LocalizedError\nimport class Foundation.NSError\nimport var Foundation.NSLocalizedDescriptionKey\nimport struct TSCBasic.StringError\n\npublic typealias StringError = TSCBasic.StringError\n\npublic struct InternalError: Error {\n private let description: String\n public init(_ description: String) {\n assertionFailure(description)\n self.description =\n \"Internal error. Please file a bug at https://github.com/swiftlang/swift-package-manager/issues with this info. \\(description)\"\n }\n}\n\n/// Wraps another error and provides additional context when printed.\n/// This is useful for user facing errors that need to provide a user friendly message\n/// explaning why an error might have occured, while still showing the detailed underlying error.\npublic struct ErrorWithContext: Error {\n public let error: E\n public let context: String\n public init(_ error: E, _ context: String) {\n self.error = error\n self.context = context\n }\n}\n\nextension ErrorWithContext: LocalizedError {\n public var errorDescription: String? {\n return (context.split(separator: \"\\n\") + [error.interpolationDescription])\n .map { \"\\t\\($0)\" }\n .joined(separator: \"\\n\")\n }\n}\n\nextension Error {\n public var interpolationDescription: String {\n switch self {\n // special case because `LocalizedError` conversion will hide the underlying error\n case let _error as DecodingError:\n return \"\\(_error)\"\n case let _error as LocalizedError:\n var description = _error.errorDescription ?? _error.localizedDescription\n if let recoverySuggestion = _error.recoverySuggestion {\n description += \". \\(recoverySuggestion)\"\n }\n return description\n case let _error as NSError:\n guard var description = _error.userInfo[NSLocalizedDescriptionKey] as? String else {\n return \"\\(self)\"\n }\n\n if let localizedRecoverySuggestion = _error.localizedRecoverySuggestion {\n description += \". \\(localizedRecoverySuggestion)\"\n }\n return description\n default:\n return \"\\(self)\"\n }\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/AbsolutePath.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct Foundation.URL\nimport struct TSCBasic.AbsolutePath\n\n// public for transition\npublic typealias TSCAbsolutePath = TSCBasic.AbsolutePath\n\n/// Represents an absolute file system path, independently of what (or whether\n/// anything at all) exists at that path in the file system at any given time.\n/// An absolute path always starts with a `/` character, and holds a normalized\n/// string representation. This normalization is strictly syntactic, and does\n/// not access the file system in any way.\n///\n/// The absolute path string is normalized by:\n/// - Collapsing `..` path components\n/// - Removing `.` path components\n/// - Removing any trailing path separator\n/// - Removing any redundant path separators\n///\n/// This string manipulation may change the meaning of a path if any of the\n/// path components are symbolic links on disk. However, the file system is\n/// never accessed in any way when initializing an AbsolutePath.\n///\n/// Note that `~` (home directory resolution) is *not* done as part of path\n/// normalization, because it is normally the responsibility of the shell and\n/// not the program being invoked (e.g. when invoking `cd ~`, it is the shell\n/// that evaluates the tilde; the `cd` command receives an absolute path).\npublic struct AbsolutePath: Hashable, Sendable {\n /// Root directory (whose string representation is just a path separator).\n public static let root = Self(TSCAbsolutePath.root)\n\n internal let underlying: TSCAbsolutePath\n\n // public for transition\n public init(_ underlying: TSCAbsolutePath) {\n self.underlying = underlying\n }\n\n /// Initializes the AbsolutePath from `absStr`, which must be an absolute\n /// path (i.e. it must begin with a path separator; this initializer does\n /// not interpret leading `~` characters as home directory specifiers).\n /// The input string will be normalized if needed, as described in the\n /// documentation for AbsolutePath.\n public init(validating pathString: String) throws {\n self.underlying = try .init(validating: pathString)\n }\n\n /// Initializes an AbsolutePath from a string that may be either absolute\n /// or relative; if relative, `basePath` is used as the anchor; if absolute,\n /// it is used as is, and in this case `basePath` is ignored.\n public init(validating pathString: String, relativeTo basePath: AbsolutePath) throws {\n self.underlying = try .init(validating: pathString, relativeTo: basePath.underlying)\n }\n\n /// Initializes the AbsolutePath by concatenating a relative path to an\n /// existing absolute path, and renormalizing if necessary.\n public init(_ absolutePath: AbsolutePath, _ relativeTo: RelativePath) {\n self.underlying = .init(absolutePath.underlying, relativeTo.underlying)\n }\n\n /// Convenience initializer that appends a string to a relative path.\n public init(_ absolutePath: AbsolutePath, validating relativePathString: String) throws {\n try self.init(absolutePath, RelativePath(validating: relativePathString))\n }\n\n /// Directory component. An absolute path always has a non-empty directory\n /// component (the directory component of the root path is the root itself).\n public var dirname: String {\n self.underlying.dirname\n }\n\n /// Last path component (including the suffix, if any). it is never empty.\n public var basename: String {\n self.underlying.basename\n }\n\n /// Returns the basename without the extension.\n public var basenameWithoutExt: String {\n self.underlying.basenameWithoutExt\n }\n\n /// Suffix (including leading `.` character) if any. Note that a basename\n /// that starts with a `.` character is not considered a suffix, nor is a\n /// trailing `.` character.\n public var suffix: String? {\n self.underlying.suffix\n }\n\n /// Extension of the give path's basename. This follow same rules as\n /// suffix except that it doesn't include leading `.` character.\n public var `extension`: String? {\n self.underlying.extension\n }\n\n /// Absolute path of parent directory. This always returns a path, because\n /// every directory has a parent (the parent directory of the root directory\n /// is considered to be the root directory itself).\n public var parentDirectory: AbsolutePath {\n Self(self.underlying.parentDirectory)\n }\n\n /// True if the path is the root directory.\n public var isRoot: Bool {\n self.underlying.isRoot\n }\n\n /// NOTE: We will most likely want to add other `appending()` methods, such\n /// as `appending(suffix:)`, and also perhaps `replacing()` methods,\n /// such as `replacing(suffix:)` or `replacing(basename:)` for some\n /// of the more common path operations.\n\n /// NOTE: We may want to consider adding operators such as `+` for appending\n /// a path component.\n\n /// NOTE: We will want to add a method to return the lowest common ancestor\n /// path.\n\n /// Normalized string representation (the normalization rules are described\n /// in the documentation of the initializer). This string is never empty.\n public var pathString: String {\n self.underlying.pathString\n }\n}\n\nextension AbsolutePath {\n /// Returns an array of strings that make up the path components of the\n /// absolute path. This is the same sequence of strings as the basenames\n /// of each successive path component, starting from the root. Therefore\n /// the first path component of an absolute path is always `/`.\n public var components: [String] {\n self.underlying.components\n }\n\n /// Returns the absolute path with the relative path applied.\n public func appending(_ relativePath: RelativePath) -> AbsolutePath {\n Self(self.underlying.appending(relativePath.underlying))\n }\n\n /// Returns the absolute path with an additional literal component appended.\n ///\n /// This method accepts pseudo-path like '.' or '..', but should not contain \"/\".\n public func appending(component: String) -> AbsolutePath {\n Self(self.underlying.appending(component: component))\n }\n\n /// Returns the absolute path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(components: [String]) -> AbsolutePath {\n Self(self.underlying.appending(components: components))\n }\n\n /// Returns the absolute path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(components: String...) -> AbsolutePath {\n Self(self.underlying.appending(components: components))\n }\n\n /// Returns the absolute path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(_ component: String) -> AbsolutePath {\n self.appending(component: component)\n }\n\n /// Returns the absolute path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(_ components: String...) -> AbsolutePath {\n self.appending(components: components)\n }\n\n /// Returns the absolute path with additional extension appended.\n ///\n public func appending(extension: String) -> AbsolutePath {\n guard !self.isRoot else { return self }\n let `extension` = `extension`.spm_dropPrefix(\".\")\n return self.parentDirectory.appending(\"\\(basename).\\(`extension`)\")\n }\n}\n\nextension AbsolutePath {\n /// Returns a relative path that, when concatenated to `base`, yields the\n /// callee path itself. If `base` is not an ancestor of the callee, the\n /// returned path will begin with one or more `..` path components.\n ///\n /// Because both paths are absolute, they always have a common ancestor\n /// (the root path, if nothing else). Therefore, any path can be made\n /// relative to any other path by using a sufficient number of `..` path\n /// components.\n ///\n /// This method is strictly syntactic and does not access the file system\n /// in any way. Therefore, it does not take symbolic links into account.\n public func relative(to base: AbsolutePath) -> RelativePath {\n RelativePath(self.underlying.relative(to: base.underlying))\n }\n\n /// Returns true if the path is an ancestor of the given path.\n ///\n /// This method is strictly syntactic and does not access the file system\n /// in any way.\n public func isAncestor(of descendant: AbsolutePath) -> Bool {\n self.underlying.isAncestor(of: descendant.underlying)\n }\n\n /// Returns true if the path is an ancestor of or equal to the given path.\n ///\n /// This method is strictly syntactic and does not access the file system\n /// in any way.\n public func isAncestorOfOrEqual(to descendant: AbsolutePath) -> Bool {\n self.underlying.isAncestorOfOrEqual(to: descendant.underlying)\n }\n\n /// Returns true if the path is a descendant of the given path.\n ///\n /// This method is strictly syntactic and does not access the file system\n /// in any way.\n public func isDescendant(of ancestor: AbsolutePath) -> Bool {\n self.underlying.isDescendant(of: ancestor.underlying)\n }\n\n /// Returns true if the path is a descendant of or equal to the given path.\n ///\n /// This method is strictly syntactic and does not access the file system\n /// in any way.\n public func isDescendantOfOrEqual(to ancestor: AbsolutePath) -> Bool {\n self.underlying.isDescendantOfOrEqual(to: ancestor.underlying)\n }\n}\n\nextension AbsolutePath {\n /// Unlike ``AbsolutePath//extension``, this property returns all characters after the first `.` character in a\n /// filename. If no dot character is present in the filename or first dot is the last character, `nil` is returned.\n public var allExtensions: [String]? {\n guard let firstDot = self.basename.firstIndex(of: \".\") else {\n return nil\n }\n\n var extensions = String(self.basename[firstDot ..< self.basename.endIndex])\n\n guard extensions.count > 1 else {\n return nil\n }\n\n extensions.removeFirst()\n\n return extensions.split(separator: \".\").map(String.init)\n }\n\n /// Returns the basename dropping any possible extension.\n public var basenameWithoutAnyExtension: String {\n var basename = self.basename\n if let index = basename.firstIndex(of: \".\") {\n basename.removeSubrange(index ..< basename.endIndex)\n }\n return String(basename)\n }\n}\n\nextension AbsolutePath: Codable {\n public func encode(to encoder: Encoder) throws {\n try self.underlying.encode(to: encoder)\n }\n\n public init(from decoder: Decoder) throws {\n try self = .init(TSCAbsolutePath(from: decoder))\n }\n}\n\n// Make absolute paths Comparable.\nextension AbsolutePath: Comparable {\n public static func < (lhs: AbsolutePath, rhs: AbsolutePath) -> Bool {\n lhs.underlying < rhs.underlying\n }\n}\n\n/// Make absolute paths CustomStringConvertible and CustomDebugStringConvertible.\nextension AbsolutePath: CustomStringConvertible, CustomDebugStringConvertible {\n public var description: String {\n self.underlying.description\n }\n\n public var debugDescription: String {\n self.underlying.debugDescription\n }\n}\n\nextension AbsolutePath {\n public var asURL: Foundation.URL {\n self.underlying.asURL\n }\n}\n\nextension AbsolutePath {\n /// Returns a path suitable for display to the user (if possible, it is made\n /// to be relative to the current working directory).\n public func prettyPath(cwd: AbsolutePath? = localFileSystem.currentWorkingDirectory) -> String {\n self.underlying.prettyPath(cwd: cwd?.underlying)\n }\n}\n\nextension AbsolutePath {\n public var escapedPathString: String {\n self.pathString.replacing(\"\\\\\", with: \"\\\\\\\\\")\n }\n}\n\nextension TSCAbsolutePath {\n public init(_ path: AbsolutePath) {\n self = path.underlying\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/CommonParentDirectory.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2026 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n/// Returns the common parent directory of the given absolute paths.\n///\n/// This function finds the deepest directory that is an ancestor of all the provided paths.\n/// If the paths have no common ancestor other than the root directory, it returns the root.\n/// If the array is empty, it returns the root directory.\n///\n/// - Parameter paths: An array of absolute paths to find the common parent for\n/// - Returns: The common parent directory as an AbsolutePath\n///\n/// Examples:\n/// - `[\"/a/b/c\", \"/a/b/d\"]` → `\"/a/b\"`\n/// - `[\"/usr/local/bin\", \"/usr/local/lib\"]` → `\"/usr/local\"`\n/// - `[\"/a/b\", \"/x/y\"]` → `\"/\"`\n/// - `[]` → `\"/\"`\npublic func getCommonParentDirectory(paths: [AbsolutePath]) throws-> AbsolutePath {\n // Handle empty array case\n guard !paths.isEmpty else {\n return AbsolutePath.root\n }\n\n // Handle single path case\n guard paths.count > 1 else {\n return paths[0]\n }\n\n // Get the components of all paths\n let allComponents = paths.map { $0.components }\n\n // Find the minimum length to avoid index out of bounds\n let minLength = allComponents.map { $0.count }.min() ?? 0\n\n // Find the common prefix by comparing components at each position\n var commonComponents: [String] = []\n\n for index in 0.. Bool {\n self.exists(path.underlying, followSymlink: followSymlink)\n }\n\n /// exists override with default value.\n public func exists(_ path: AbsolutePath) -> Bool {\n self.exists(path.underlying)\n }\n\n /// Check whether the given path is accessible and a directory.\n public func isDirectory(_ path: AbsolutePath) -> Bool {\n self.isDirectory(path.underlying)\n }\n\n /// Check whether the given path is accessible and a file.\n public func isFile(_ path: AbsolutePath) -> Bool {\n self.isFile(path.underlying)\n }\n\n /// Check whether the given path is an accessible and executable file.\n public func isExecutableFile(_ path: AbsolutePath) -> Bool {\n self.isExecutableFile(path.underlying)\n }\n\n /// Check whether the given path is accessible and is a symbolic link.\n public func isSymlink(_ path: AbsolutePath) -> Bool {\n self.isSymlink(path.underlying)\n }\n\n /// Check whether the given path is accessible and readable.\n public func isReadable(_ path: AbsolutePath) -> Bool {\n self.isReadable(path.underlying)\n }\n\n /// Check whether the given path is accessible and writable.\n public func isWritable(_ path: AbsolutePath) -> Bool {\n self.isWritable(path.underlying)\n }\n\n /// Returns `true` if a given path has a quarantine attribute applied if when file system supports this attribute.\n /// Returns `false` if such attribute is not applied or it isn't supported.\n public func hasAttribute(_ name: FileSystemAttribute, _ path: AbsolutePath) -> Bool {\n self.hasAttribute(name, path.underlying)\n }\n\n /// Get the contents of the given directory, in an undefined order.\n public func getDirectoryContents(_ path: AbsolutePath) throws -> [String] {\n try self.getDirectoryContents(path.underlying)\n }\n\n /// Get the current working directory (similar to `getcwd(3)`), which can be\n /// different for different (virtualized) implementations of a FileSystem.\n /// The current working directory can be empty if e.g. the directory became\n /// unavailable while the current process was still working in it.\n /// This follows the POSIX `getcwd(3)` semantics.\n public var currentWorkingDirectory: AbsolutePath? {\n self.currentWorkingDirectory.flatMap { AbsolutePath($0) }\n }\n\n /// Change the current working directory.\n /// - Parameters:\n /// - path: The path to the directory to change the current working directory to.\n public func changeCurrentWorkingDirectory(to path: AbsolutePath) throws {\n try self.changeCurrentWorkingDirectory(to: path.underlying)\n }\n\n /// Get the home directory of current user\n public var homeDirectory: AbsolutePath {\n get throws {\n try AbsolutePath(self.homeDirectory)\n }\n }\n\n /// Get the caches directory of current user\n public var cachesDirectory: AbsolutePath? {\n self.cachesDirectory.flatMap { AbsolutePath($0) }\n }\n\n /// Get the temp directory\n public var tempDirectory: AbsolutePath {\n get throws {\n try AbsolutePath(self.tempDirectory)\n }\n }\n\n /// Create the given directory.\n public func createDirectory(_ path: AbsolutePath) throws {\n try self.createDirectory(path.underlying)\n }\n\n /// Create the given directory.\n ///\n /// - recursive: If true, create missing parent directories if possible.\n public func createDirectory(_ path: AbsolutePath, recursive: Bool) throws {\n try self.createDirectory(path.underlying, recursive: recursive)\n }\n\n /// Creates a symbolic link of the source path at the target path\n /// - Parameters:\n /// - path: The path at which to create the link.\n /// - destination: The path to which the link points to.\n /// - relative: If `relative` is true, the symlink contents will be a relative path, otherwise it will be\n /// absolute.\n public func createSymbolicLink(_ path: AbsolutePath, pointingAt destination: AbsolutePath, relative: Bool) throws {\n try self.createSymbolicLink(path.underlying, pointingAt: destination.underlying, relative: relative)\n }\n\n /// Get the contents of a file.\n ///\n /// - Returns: The file contents as bytes, or nil if missing.\n public func readFileContents(_ path: AbsolutePath) throws -> ByteString {\n try self.readFileContents(path.underlying)\n }\n\n /// Write the contents of a file.\n public func writeFileContents(_ path: AbsolutePath, bytes: ByteString) throws {\n try self.writeFileContents(path.underlying, bytes: bytes)\n }\n\n /// Write the contents of a file.\n public func writeFileContents(_ path: AbsolutePath, bytes: ByteString, atomically: Bool) throws {\n try self.writeFileContents(path.underlying, bytes: bytes, atomically: atomically)\n }\n\n /// Write to a file from a stream producer.\n public func writeFileContents(_ path: AbsolutePath, body: (WritableByteStream) -> Void) throws {\n try self.writeFileContents(path.underlying, body: body)\n }\n\n /// Recursively deletes the file system entity at `path`.\n ///\n /// If there is no file system entity at `path`, this function does nothing (in particular, this is not considered\n /// to be an error).\n public func removeFileTree(_ path: AbsolutePath) throws {\n try self.removeFileTree(path.underlying)\n }\n\n /// Change file mode.\n public func chmod(_ mode: FileMode, path: AbsolutePath, options: Set) throws {\n try self.chmod(mode, path: path.underlying, options: options)\n }\n\n // Change file mode.\n public func chmod(_ mode: FileMode, path: AbsolutePath) throws {\n try self.chmod(mode, path: path.underlying)\n }\n\n /// Returns the file info of the given path.\n ///\n /// The method throws if the underlying stat call fails.\n public func getFileInfo(_ path: AbsolutePath) throws -> FileInfo {\n try self.getFileInfo(path.underlying)\n }\n\n /// Copy a file or directory.\n public func copy(from source: AbsolutePath, to destination: AbsolutePath) throws {\n try self.copy(from: source.underlying, to: destination.underlying)\n }\n\n /// Move a file or directory.\n public func move(from source: AbsolutePath, to destination: AbsolutePath) throws {\n try self.move(from: source.underlying, to: destination.underlying)\n }\n\n /// Execute the given block while holding the lock.\n public func withLock(on path: AbsolutePath, type: FileLock.LockType, blocking: Bool = true, _ body: () throws -> T) throws -> T {\n try self.withLock(on: path.underlying, type: type, blocking: blocking, body)\n }\n\n /// Execute the given block while holding the lock.\n public func withLock(on path: AbsolutePath, type: FileLock.LockType, blocking: Bool = true, _ body: () async throws -> T) async throws -> T {\n return try await FileLock.withLock(fileToLock: path.underlying, type: type, blocking: blocking, body: body)\n }\n\n /// Returns any known item replacement directories for a given path. These may be used by platform-specific\n /// libraries to handle atomic file system operations, such as deletion.\n func itemReplacementDirectories(for path: AbsolutePath) throws -> [AbsolutePath] {\n return try self.itemReplacementDirectories(for: path.underlying).compactMap { AbsolutePath($0) }\n }\n}\n\n// MARK: - user level\n\nextension FileSystem {\n /// SwiftPM directory under user's home directory (~/.swiftpm)\n /// or under $XDG_CONFIG_HOME/swiftpm if the environmental variable is defined\n public var dotSwiftPM: AbsolutePath {\n get throws {\n if let configurationDirectory = Environment.current[\"XDG_CONFIG_HOME\"] {\n return try AbsolutePath(validating: configurationDirectory).appending(\"swiftpm\")\n } else {\n return try self.homeDirectory.appending(\".swiftpm\")\n }\n }\n }\n\n private var idiomaticSwiftPMDirectory: AbsolutePath? {\n get throws {\n try FileManager.default.urls(for: .libraryDirectory, in: .userDomainMask).first\n .flatMap { try AbsolutePath(validating: $0.path) }?.appending(\"org.swift.swiftpm\")\n }\n }\n}\n\n// MARK: - cache\n\nextension FileSystem {\n private var idiomaticUserCacheDirectory: AbsolutePath? {\n // in TSC: FileManager.default.urls(for: .cachesDirectory, in: .userDomainMask)\n self.cachesDirectory\n }\n\n /// SwiftPM cache directory under user's caches directory (if exists)\n public var swiftPMCacheDirectory: AbsolutePath {\n get throws {\n if let path = self.idiomaticUserCacheDirectory {\n return path.appending(\"org.swift.swiftpm\")\n } else {\n return try self.dotSwiftPMCachesDirectory\n }\n }\n }\n\n private var dotSwiftPMCachesDirectory: AbsolutePath {\n get throws {\n try self.dotSwiftPM.appending(\"cache\")\n }\n }\n}\n\nextension FileSystem {\n public func getOrCreateSwiftPMCacheDirectory() throws -> AbsolutePath {\n let idiomaticCacheDirectory = try self.swiftPMCacheDirectory\n // Create idiomatic if necessary\n if !self.exists(idiomaticCacheDirectory) {\n try self.createDirectory(idiomaticCacheDirectory, recursive: true)\n }\n // Create ~/.swiftpm if necessary\n if !self.exists(try self.dotSwiftPM) {\n try self.createDirectory(self.dotSwiftPM, recursive: true)\n }\n // Create ~/.swiftpm/cache symlink if necessary\n // locking ~/.swiftpm to protect from concurrent access\n try self.withLock(on: self.dotSwiftPM, type: .exclusive) {\n if !self.exists(try self.dotSwiftPMCachesDirectory, followSymlink: false) {\n try self.createSymbolicLink(\n dotSwiftPMCachesDirectory,\n pointingAt: idiomaticCacheDirectory,\n relative: false\n )\n }\n }\n return idiomaticCacheDirectory\n }\n}\n\nextension FileSystem {\n private var dotSwiftPMInstalledBinsDir: AbsolutePath {\n get throws {\n try self.dotSwiftPM.appending(\"bin\")\n }\n }\n\n public func getOrCreateSwiftPMInstalledBinariesDirectory() throws -> AbsolutePath {\n let idiomaticInstalledBinariesDirectory = try self.dotSwiftPMInstalledBinsDir\n // Create idiomatic if necessary\n if !self.exists(idiomaticInstalledBinariesDirectory) {\n try self.createDirectory(idiomaticInstalledBinariesDirectory, recursive: true)\n }\n // Create ~/.swiftpm if necessary\n if !self.exists(try self.dotSwiftPM) {\n try self.createDirectory(self.dotSwiftPM, recursive: true)\n }\n // Create ~/.swiftpm/bin symlink if necessary\n // locking ~/.swiftpm to protect from concurrent access\n try self.withLock(on: self.dotSwiftPM, type: .exclusive) {\n if !self.exists(try self.dotSwiftPMInstalledBinsDir, followSymlink: false) {\n try self.createSymbolicLink(\n self.dotSwiftPMInstalledBinsDir,\n pointingAt: idiomaticInstalledBinariesDirectory,\n relative: false\n )\n }\n }\n return idiomaticInstalledBinariesDirectory\n }\n}\n\n// MARK: - configuration\n\nextension FileSystem {\n /// SwiftPM config directory under user's config directory (if exists)\n public var swiftPMConfigurationDirectory: AbsolutePath {\n get throws {\n if let path = try self.idiomaticSwiftPMDirectory {\n return path.appending(\"configuration\")\n } else {\n return try self.dotSwiftPMConfigurationDirectory\n }\n }\n }\n\n private var dotSwiftPMConfigurationDirectory: AbsolutePath {\n get throws {\n try self.dotSwiftPM.appending(\"configuration\")\n }\n }\n}\n\nextension FileSystem {\n public func getOrCreateSwiftPMConfigurationDirectory(warningHandler: @escaping (String) -> Void) throws\n -> AbsolutePath\n {\n let idiomaticConfigurationDirectory = try self.swiftPMConfigurationDirectory\n\n // temporary 5.6, remove on next version: transition from previous configuration location\n if !self.exists(idiomaticConfigurationDirectory) {\n try self.createDirectory(idiomaticConfigurationDirectory, recursive: true)\n }\n\n let handleExistingFiles = { (configurationFiles: [AbsolutePath]) in\n for file in configurationFiles {\n let destination = idiomaticConfigurationDirectory.appending(component: file.basename)\n if !self.exists(destination) {\n try self.copy(from: file, to: destination)\n } else {\n // Only emit a warning if source and destination file differ in their contents.\n let srcContents = try? self.readFileContents(file)\n let dstContents = try? self.readFileContents(destination)\n if srcContents != dstContents {\n warningHandler(\n \"Usage of \\(file) has been deprecated. Please delete it and use the new \\(destination) instead.\"\n )\n }\n }\n }\n }\n\n // in the case where ~/.swiftpm/configuration is not the idiomatic location (eg on macOS where its\n // /Users//Library/org.swift.swiftpm/configuration)\n if try idiomaticConfigurationDirectory != self.dotSwiftPMConfigurationDirectory {\n // copy the configuration files from old location (eg /Users//Library/org.swift.swiftpm) to new one\n // (eg /Users//Library/org.swift.swiftpm/configuration)\n // but leave them there for backwards compatibility (eg older xcode)\n let oldConfigDirectory = idiomaticConfigurationDirectory.parentDirectory\n if self.exists(oldConfigDirectory, followSymlink: false) && self.isDirectory(oldConfigDirectory) {\n let configurationFiles = try self.getDirectoryContents(oldConfigDirectory)\n .map { oldConfigDirectory.appending(component: $0) }\n .filter {\n self.isFile($0) && !self.isSymlink($0) && $0\n .extension != \"lock\" && ((try? self.readFileContents($0)) ?? []).count > 0\n }\n try handleExistingFiles(configurationFiles)\n }\n // in the case where ~/.swiftpm/configuration is the idiomatic location (eg on Linux)\n } else {\n // copy the configuration files from old location (~/.swiftpm/config) to new one (~/.swiftpm/configuration)\n // but leave them there for backwards compatibility (eg older toolchain)\n let oldConfigDirectory = try self.dotSwiftPM.appending(\"config\")\n if self.exists(oldConfigDirectory, followSymlink: false) && self.isDirectory(oldConfigDirectory) {\n let configurationFiles = try self.getDirectoryContents(oldConfigDirectory)\n .map { oldConfigDirectory.appending(component: $0) }\n .filter {\n self.isFile($0) && !self.isSymlink($0) && $0\n .extension != \"lock\" && ((try? self.readFileContents($0)) ?? []).count > 0\n }\n try handleExistingFiles(configurationFiles)\n }\n }\n // ~temporary 5.6 migration\n\n // Create idiomatic if necessary\n if !self.exists(idiomaticConfigurationDirectory) {\n try self.createDirectory(idiomaticConfigurationDirectory, recursive: true)\n }\n // Create ~/.swiftpm if necessary\n if !self.exists(try self.dotSwiftPM) {\n try self.createDirectory(self.dotSwiftPM, recursive: true)\n }\n // Create ~/.swiftpm/configuration symlink if necessary\n // locking ~/.swiftpm to protect from concurrent access\n try self.withLock(on: self.dotSwiftPM, type: .exclusive) {\n if !self.exists(try self.dotSwiftPMConfigurationDirectory, followSymlink: false) {\n try self.createSymbolicLink(\n dotSwiftPMConfigurationDirectory,\n pointingAt: idiomaticConfigurationDirectory,\n relative: false\n )\n }\n }\n\n return idiomaticConfigurationDirectory\n }\n}\n\n// MARK: - security\n\nextension FileSystem {\n /// SwiftPM security directory under user's security directory (if exists)\n public var swiftPMSecurityDirectory: AbsolutePath {\n get throws {\n if let path = try self.idiomaticSwiftPMDirectory {\n return path.appending(\"security\")\n } else {\n return try self.dotSwiftPMSecurityDirectory\n }\n }\n }\n\n private var dotSwiftPMSecurityDirectory: AbsolutePath {\n get throws {\n try self.dotSwiftPM.appending(\"security\")\n }\n }\n}\n\nextension FileSystem {\n public func getOrCreateSwiftPMSecurityDirectory() throws -> AbsolutePath {\n let idiomaticSecurityDirectory = try self.swiftPMSecurityDirectory\n\n // temporary 5.6, remove on next version: transition from ~/.swiftpm/security to idiomatic location + symbolic\n // link\n if try idiomaticSecurityDirectory != self.dotSwiftPMSecurityDirectory &&\n self.exists(try self.dotSwiftPMSecurityDirectory) &&\n self.isDirectory(try self.dotSwiftPMSecurityDirectory)\n {\n try self.removeFileTree(self.dotSwiftPMSecurityDirectory)\n }\n // ~temporary 5.6 migration\n\n // Create idiomatic if necessary\n if !self.exists(idiomaticSecurityDirectory) {\n try self.createDirectory(idiomaticSecurityDirectory, recursive: true)\n }\n // Create ~/.swiftpm if necessary\n if !self.exists(try self.dotSwiftPM) {\n try self.createDirectory(self.dotSwiftPM, recursive: true)\n }\n // Create ~/.swiftpm/security symlink if necessary\n // locking ~/.swiftpm to protect from concurrent access\n try self.withLock(on: self.dotSwiftPM, type: .exclusive) {\n if !self.exists(try self.dotSwiftPMSecurityDirectory, followSymlink: false) {\n try self.createSymbolicLink(\n dotSwiftPMSecurityDirectory,\n pointingAt: idiomaticSecurityDirectory,\n relative: false\n )\n }\n }\n return idiomaticSecurityDirectory\n }\n}\n\n// MARK: - Swift SDKs\n\nprivate let swiftSDKsDirectoryName = \"swift-sdks\"\n\nextension FileSystem {\n /// Path to Swift SDKs directory (if exists)\n public var swiftSDKsDirectory: AbsolutePath {\n get throws {\n if let path = try idiomaticSwiftPMDirectory {\n return path.appending(component: swiftSDKsDirectoryName)\n } else {\n return try dotSwiftPMSwiftSDKsDirectory\n }\n }\n }\n\n private var dotSwiftPMSwiftSDKsDirectory: AbsolutePath {\n get throws {\n try dotSwiftPM.appending(component: swiftSDKsDirectoryName)\n }\n }\n\n public func getSharedSwiftSDKsDirectory(explicitDirectory: AbsolutePath?) throws -> AbsolutePath {\n if let explicitDirectory {\n // Create the explicit SDKs path if necessary\n if !exists(explicitDirectory) {\n try createDirectory(explicitDirectory, recursive: true)\n }\n return explicitDirectory\n } else {\n return try swiftSDKsDirectory\n }\n }\n\n public func getOrCreateSwiftPMSwiftSDKsDirectory() throws -> AbsolutePath {\n let idiomaticSwiftSDKDirectory = try swiftSDKsDirectory\n\n // Create idiomatic if necessary\n if !exists(idiomaticSwiftSDKDirectory) {\n try createDirectory(idiomaticSwiftSDKDirectory, recursive: true)\n }\n // Create ~/.swiftpm if necessary\n if !exists(try dotSwiftPM) {\n try createDirectory(dotSwiftPM, recursive: true)\n }\n // Create ~/.swiftpm/swift-sdks symlink if necessary\n // locking ~/.swiftpm to protect from concurrent access\n try withLock(on: dotSwiftPM, type: .exclusive) {\n if !exists(try dotSwiftPMSwiftSDKsDirectory, followSymlink: false) {\n try createSymbolicLink(\n dotSwiftPMSwiftSDKsDirectory,\n pointingAt: idiomaticSwiftSDKDirectory,\n relative: false\n )\n }\n }\n return idiomaticSwiftSDKDirectory\n }\n}\n\n// MARK: - Utilities\n\nextension FileSystem {\n @_disfavoredOverload\n public func readFileContents(_ path: AbsolutePath) throws -> Data {\n try Data(self.readFileContents(path).contents)\n }\n\n @_disfavoredOverload\n public func readFileContents(_ path: AbsolutePath) throws -> String {\n try String(decoding: self.readFileContents(path), as: UTF8.self)\n }\n\n public func writeFileContents(_ path: AbsolutePath, data: Data) throws {\n try self._writeFileContents(path, bytes: .init(data))\n }\n\n public func writeFileContents(_ path: AbsolutePath, string: String) throws {\n try self._writeFileContents(path, bytes: .init(encodingAsUTF8: string))\n }\n\n private func _writeFileContents(_ path: AbsolutePath, bytes: ByteString) throws {\n // using the \"body\" variant since it creates the directory first\n // we should probably fix TSC to be consistent about this behavior\n try self.writeFileContents(path, body: { $0.send(bytes) })\n }\n}\n\nextension FileSystem {\n /// Write bytes to the path if the given contents are different.\n public func writeIfChanged(path: AbsolutePath, string: String) throws {\n try writeIfChanged(path: path, bytes: .init(encodingAsUTF8: string))\n }\n\n public func writeIfChanged(path: AbsolutePath, data: Data) throws {\n try writeIfChanged(path: path, bytes: .init(data))\n }\n\n /// Write bytes to the path if the given contents are different.\n public func writeIfChanged(path: AbsolutePath, bytes: ByteString) throws {\n try createDirectory(path.parentDirectory, recursive: true)\n\n // Return if the contents are same.\n if isFile(path), try readFileContents(path) == bytes {\n return\n }\n\n try writeFileContents(path, bytes: bytes)\n }\n}\n\nextension FileSystem {\n public func forceCreateDirectory(at path: AbsolutePath) throws {\n try self.createDirectory(path.parentDirectory, recursive: true)\n if self.exists(path) {\n try self.removeFileTree(path)\n }\n try self.createDirectory(path, recursive: true)\n }\n}\n\nextension FileSystem {\n public func stripFirstLevel(of path: AbsolutePath) throws {\n let topLevelDirectories = try self.getDirectoryContents(path)\n .map { path.appending(component: $0) }\n .filter { self.isDirectory($0) }\n\n guard topLevelDirectories.count == 1, let rootDirectory = topLevelDirectories.first else {\n throw StringError(\"stripFirstLevel requires single top level directory\")\n }\n\n let tempDirectory = path.parentDirectory.appending(component: UUID().uuidString)\n try self.move(from: rootDirectory, to: tempDirectory)\n\n let rootContents = try self.getDirectoryContents(tempDirectory)\n for entry in rootContents {\n try self.move(from: tempDirectory.appending(component: entry), to: path.appending(component: entry))\n }\n\n try self.removeFileTree(tempDirectory)\n }\n}\n\n// MARK: - Locking\n\nextension FileLock {\n public static func prepareLock(\n fileToLock: AbsolutePath,\n at lockFilesDirectory: AbsolutePath? = nil\n ) throws -> FileLock {\n return try Self.prepareLock(fileToLock: fileToLock.underlying, at: lockFilesDirectory?.underlying)\n }\n}\n\n/// Convenience initializers for testing purposes.\nextension InMemoryFileSystem {\n /// Create a new file system with the given files, provided as a map from\n /// file path to contents.\n public convenience init(files: [String: ByteString]) {\n self.init()\n\n for (path, contents) in files {\n let path = try! AbsolutePath(validating: path)\n try! createDirectory(path.parentDirectory, recursive: true)\n try! writeFileContents(path, bytes: contents)\n }\n }\n\n /// Create a new file system with an empty file at each provided path.\n public convenience init(emptyFiles files: String...) {\n self.init(emptyFiles: files)\n }\n\n /// Create a new file system with an empty file at each provided path.\n public convenience init(emptyFiles files: [String]) {\n self.init()\n self.createEmptyFiles(at: .root, files: files)\n }\n}\n\nextension FileSystem {\n public func createEmptyFiles(at root: AbsolutePath, files: String...) {\n self.createEmptyFiles(at: root, files: files)\n }\n\n public func createEmptyFiles(at root: AbsolutePath, files: [String]) {\n do {\n try createDirectory(root, recursive: true)\n for path in files {\n let path = try AbsolutePath(validating: String(path.dropFirst()), relativeTo: root)\n try createDirectory(path.parentDirectory, recursive: true)\n try writeFileContents(path, bytes: \"\")\n }\n } catch {\n fatalError(\"Failed to create empty files: \\(error)\")\n }\n }\n}\n\nextension FileSystem {\n /// Do a deep enumeration, passing each file to block\n public func enumerate(directory: AbsolutePath, block: (AbsolutePath) throws -> ()) throws {\n for file in try getDirectoryContents(directory) {\n let path = directory.appending(file)\n if isDirectory(path) {\n try enumerate(directory: path, block: block)\n } else {\n try block(path)\n }\n }\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/InMemoryFileSystem.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2014 - 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.NSLock\nimport class Dispatch.DispatchQueue\nimport struct TSCBasic.AbsolutePath\nimport struct TSCBasic.ByteString\nimport class TSCBasic.FileLock\nimport enum TSCBasic.FileMode\nimport struct TSCBasic.FileSystemError\n\n/// Concrete FileSystem implementation which simulates an empty disk.\npublic final class InMemoryFileSystem: FileSystem {\n /// Private internal representation of a file system node.\n /// Not thread-safe.\n private class Node {\n /// The actual node data.\n let contents: NodeContents\n\n /// Whether the node has executable bit enabled.\n var isExecutable: Bool\n\n init(_ contents: NodeContents, isExecutable: Bool = false) {\n self.contents = contents\n self.isExecutable = isExecutable\n }\n\n /// Creates deep copy of the object.\n func copy() -> Node {\n return Node(contents.copy())\n }\n }\n\n /// Private internal representation the contents of a file system node.\n /// Not thread-safe.\n private enum NodeContents {\n case file(ByteString)\n case directory(DirectoryContents)\n case symlink(String)\n\n /// Creates deep copy of the object.\n func copy() -> NodeContents {\n switch self {\n case .file(let bytes):\n return .file(bytes)\n case .directory(let contents):\n return .directory(contents.copy())\n case .symlink(let path):\n return .symlink(path)\n }\n }\n }\n\n /// Private internal representation the contents of a directory.\n /// Not thread-safe.\n private final class DirectoryContents {\n var entries: [String: Node]\n\n init(entries: [String: Node] = [:]) {\n self.entries = entries\n }\n\n /// Creates deep copy of the object.\n func copy() -> DirectoryContents {\n let contents = DirectoryContents()\n for (key, node) in entries {\n contents.entries[key] = node.copy()\n }\n return contents\n }\n }\n\n /// The root node of the filesystem.\n private var root: Node\n\n /// Protects `root` and everything underneath it.\n /// FIXME: Using a single lock for this is a performance problem, but in\n /// reality, the only practical use for InMemoryFileSystem is for unit\n /// tests.\n private let lock = NSLock()\n /// A map that keeps weak references to all locked files.\n private var lockFiles = Dictionary>()\n /// Used to access lockFiles in a thread safe manner.\n private let lockFilesLock = NSLock()\n\n /// Exclusive file system lock vended to clients through `withLock()`.\n /// Used to ensure that DispatchQueues are released when they are no longer in use.\n private struct WeakReference {\n weak var reference: Value?\n\n init(_ value: Value?) {\n self.reference = value\n }\n }\n\n public init() {\n root = Node(.directory(DirectoryContents()))\n }\n\n /// Creates deep copy of the object.\n public func copy() -> InMemoryFileSystem {\n return lock.withLock {\n let fs = InMemoryFileSystem()\n fs.root = root.copy()\n return fs\n }\n }\n\n /// Private function to look up the node corresponding to a path.\n /// Not thread-safe.\n private func getNode(_ path: TSCBasic.AbsolutePath, followSymlink: Bool = true) throws -> Node? {\n func getNodeInternal(_ path: TSCBasic.AbsolutePath) throws -> Node? {\n // If this is the root node, return it.\n if path.isRoot {\n return root\n }\n\n // Otherwise, get the parent node.\n guard let parent = try getNodeInternal(path.parentDirectory) else {\n return nil\n }\n\n // If we didn't find a directory, this is an error.\n guard case .directory(let contents) = parent.contents else {\n throw FileSystemError(.notDirectory, path.parentDirectory)\n }\n\n // Return the directory entry.\n let node = contents.entries[path.basename]\n\n switch node?.contents {\n case .directory, .file:\n return node\n case .symlink(let destination):\n let destination = try TSCBasic.AbsolutePath(validating: destination, relativeTo: path.parentDirectory)\n return followSymlink ? try getNodeInternal(destination) : node\n case .none:\n return nil\n }\n }\n\n // Get the node that corresponds to the path.\n return try getNodeInternal(path)\n }\n\n // MARK: FileSystem Implementation\n\n public func exists(_ path: TSCBasic.AbsolutePath, followSymlink: Bool) -> Bool {\n return lock.withLock {\n do {\n switch try getNode(path, followSymlink: followSymlink)?.contents {\n case .file, .directory, .symlink: return true\n case .none: return false\n }\n } catch {\n return false\n }\n }\n }\n\n public func isDirectory(_ path: TSCBasic.AbsolutePath) -> Bool {\n return lock.withLock {\n do {\n if case .directory? = try getNode(path)?.contents {\n return true\n }\n return false\n } catch {\n return false\n }\n }\n }\n\n public func isFile(_ path: TSCBasic.AbsolutePath) -> Bool {\n return lock.withLock {\n do {\n if case .file? = try getNode(path)?.contents {\n return true\n }\n return false\n } catch {\n return false\n }\n }\n }\n\n public func isSymlink(_ path: TSCBasic.AbsolutePath) -> Bool {\n return lock.withLock {\n do {\n if case .symlink? = try getNode(path, followSymlink: false)?.contents {\n return true\n }\n return false\n } catch {\n return false\n }\n }\n }\n\n public func isReadable(_ path: TSCBasic.AbsolutePath) -> Bool {\n self.exists(path)\n }\n\n public func isWritable(_ path: TSCBasic.AbsolutePath) -> Bool {\n self.exists(path)\n }\n\n public func isExecutableFile(_ path: TSCBasic.AbsolutePath) -> Bool {\n (try? self.getNode(path)?.isExecutable) ?? false\n }\n\n public func updatePermissions(_ path: AbsolutePath, isExecutable: Bool) throws {\n try lock.withLock {\n guard let node = try self.getNode(path.underlying, followSymlink: true) else {\n throw FileSystemError(.noEntry, path)\n }\n node.isExecutable = isExecutable\n }\n }\n\n /// Virtualized current working directory.\n private var _currentWorkingDirectory: TSCBasic.AbsolutePath = try! .init(validating: \"/\")\n\n public var currentWorkingDirectory: TSCBasic.AbsolutePath? {\n return _currentWorkingDirectory\n }\n\n public func changeCurrentWorkingDirectory(to path: TSCBasic.AbsolutePath) throws {\n return try lock.withLock {\n // Verify the path exists and is a directory\n guard let node = try getNode(path) else {\n throw FileSystemError(.noEntry, path)\n }\n\n guard case .directory = node.contents else {\n throw FileSystemError(.notDirectory, path)\n }\n _currentWorkingDirectory = path\n }\n }\n\n public var homeDirectory: TSCBasic.AbsolutePath {\n get throws {\n // FIXME: Maybe we should allow setting this when creating the fs.\n return try .init(validating: \"/home/user\")\n }\n }\n\n public var cachesDirectory: TSCBasic.AbsolutePath? {\n return try? self.homeDirectory.appending(component: \"caches\")\n }\n\n public var tempDirectory: TSCBasic.AbsolutePath {\n get throws {\n return try .init(validating: \"/tmp\")\n }\n }\n\n public func getDirectoryContents(_ path: TSCBasic.AbsolutePath) throws -> [String] {\n return try lock.withLock {\n guard let node = try getNode(path) else {\n throw FileSystemError(.noEntry, path)\n }\n guard case .directory(let contents) = node.contents else {\n throw FileSystemError(.notDirectory, path)\n }\n\n // FIXME: Perhaps we should change the protocol to allow lazy behavior.\n return [String](contents.entries.keys)\n }\n }\n\n /// Not thread-safe.\n private func _createDirectory(_ path: TSCBasic.AbsolutePath, recursive: Bool) throws {\n // Ignore if client passes root.\n guard !path.isRoot else {\n return\n }\n // Get the parent directory node.\n let parentPath = path.parentDirectory\n guard let parent = try getNode(parentPath) else {\n // If the parent doesn't exist, and we are recursive, then attempt\n // to create the parent and retry.\n if recursive && path != parentPath {\n // Attempt to create the parent.\n try _createDirectory(parentPath, recursive: true)\n\n // Re-attempt creation, non-recursively.\n return try _createDirectory(path, recursive: false)\n } else {\n // Otherwise, we failed.\n throw FileSystemError(.noEntry, parentPath)\n }\n }\n\n // Check that the parent is a directory.\n guard case .directory(let contents) = parent.contents else {\n // The parent isn't a directory, this is an error.\n throw FileSystemError(.notDirectory, parentPath)\n }\n\n // Check if the node already exists.\n if let node = contents.entries[path.basename] {\n // Verify it is a directory.\n guard case .directory = node.contents else {\n // The path itself isn't a directory, this is an error.\n throw FileSystemError(.notDirectory, path)\n }\n\n // We are done.\n return\n }\n\n // Otherwise, the node does not exist, create it.\n contents.entries[path.basename] = Node(.directory(DirectoryContents()))\n }\n\n public func createDirectory(_ path: TSCBasic.AbsolutePath, recursive: Bool) throws {\n return try lock.withLock {\n try _createDirectory(path, recursive: recursive)\n }\n }\n\n public func createSymbolicLink(\n _ path: TSCBasic.AbsolutePath,\n pointingAt destination: TSCBasic.AbsolutePath,\n relative: Bool\n ) throws {\n return try lock.withLock {\n // Create directory to destination parent.\n guard let destinationParent = try getNode(path.parentDirectory) else {\n throw FileSystemError(.noEntry, path.parentDirectory)\n }\n\n // Check that the parent is a directory.\n guard case .directory(let contents) = destinationParent.contents else {\n throw FileSystemError(.notDirectory, path.parentDirectory)\n }\n\n guard contents.entries[path.basename] == nil else {\n throw FileSystemError(.alreadyExistsAtDestination, path)\n }\n\n let destination = relative ? destination.relative(to: path.parentDirectory).pathString : destination.pathString\n\n contents.entries[path.basename] = Node(.symlink(destination))\n }\n }\n\n public func readFileContents(_ path: TSCBasic.AbsolutePath) throws -> ByteString {\n return try lock.withLock {\n // Get the node.\n guard let node = try getNode(path) else {\n throw FileSystemError(.noEntry, path)\n }\n\n // Check that the node is a file.\n guard case .file(let contents) = node.contents else {\n // The path is a directory, this is an error.\n throw FileSystemError(.isDirectory, path)\n }\n\n // Return the file contents.\n return contents\n }\n }\n\n public func writeFileContents(_ path: TSCBasic.AbsolutePath, bytes: ByteString) throws {\n return try lock.withLock {\n // It is an error if this is the root node.\n let parentPath = path.parentDirectory\n guard path != parentPath else {\n throw FileSystemError(.isDirectory, path)\n }\n\n // Get the parent node.\n guard let parent = try getNode(parentPath) else {\n throw FileSystemError(.noEntry, parentPath)\n }\n\n // Check that the parent is a directory.\n guard case .directory(let contents) = parent.contents else {\n // The parent isn't a directory, this is an error.\n throw FileSystemError(.notDirectory, parentPath)\n }\n\n // Check if the node exists.\n if let node = contents.entries[path.basename] {\n // Verify it is a file.\n guard case .file = node.contents else {\n // The path is a directory, this is an error.\n throw FileSystemError(.isDirectory, path)\n }\n }\n\n // Write the file.\n contents.entries[path.basename] = Node(.file(bytes))\n }\n }\n\n public func writeFileContents(_ path: TSCBasic.AbsolutePath, bytes: ByteString, atomically: Bool) throws {\n // In memory file system's writeFileContents is already atomic, so ignore the parameter here\n // and just call the base implementation.\n try writeFileContents(path, bytes: bytes)\n }\n\n public func removeFileTree(_ path: TSCBasic.AbsolutePath) throws {\n return lock.withLock {\n // Ignore root and get the parent node's content if its a directory.\n guard !path.isRoot,\n let parent = try? getNode(path.parentDirectory),\n case .directory(let contents) = parent.contents else {\n return\n }\n // Set it to nil to release the contents.\n contents.entries[path.basename] = nil\n }\n }\n\n public func chmod(_ mode: FileMode, path: TSCBasic.AbsolutePath, options: Set) throws {\n // FIXME: We don't have these semantics in InMemoryFileSystem.\n }\n\n /// Private implementation of core copying function.\n /// Not thread-safe.\n private func _copy(from sourcePath: TSCBasic.AbsolutePath, to destinationPath: TSCBasic.AbsolutePath) throws {\n // Get the source node.\n guard let source = try getNode(sourcePath) else {\n throw FileSystemError(.noEntry, sourcePath)\n }\n\n // Create directory to destination parent.\n guard let destinationParent = try getNode(destinationPath.parentDirectory) else {\n throw FileSystemError(.noEntry, destinationPath.parentDirectory)\n }\n\n // Check that the parent is a directory.\n guard case .directory(let contents) = destinationParent.contents else {\n throw FileSystemError(.notDirectory, destinationPath.parentDirectory)\n }\n\n guard contents.entries[destinationPath.basename] == nil else {\n throw FileSystemError(.alreadyExistsAtDestination, destinationPath)\n }\n\n contents.entries[destinationPath.basename] = source\n }\n\n public func copy(from sourcePath: TSCBasic.AbsolutePath, to destinationPath: TSCBasic.AbsolutePath) throws {\n return try lock.withLock {\n try _copy(from: sourcePath, to: destinationPath)\n }\n }\n\n public func move(from sourcePath: TSCBasic.AbsolutePath, to destinationPath: TSCBasic.AbsolutePath) throws {\n return try lock.withLock {\n // Get the source parent node.\n guard let sourceParent = try getNode(sourcePath.parentDirectory) else {\n throw FileSystemError(.noEntry, sourcePath.parentDirectory)\n }\n\n // Check that the parent is a directory.\n guard case .directory(let contents) = sourceParent.contents else {\n throw FileSystemError(.notDirectory, sourcePath.parentDirectory)\n }\n\n try _copy(from: sourcePath, to: destinationPath)\n\n contents.entries[sourcePath.basename] = nil\n }\n }\n\n public func withLock(\n on path: TSCBasic.AbsolutePath,\n type: FileLock.LockType = .exclusive,\n _ body: () throws -> T\n ) throws -> T {\n let resolvedPath: TSCBasic.AbsolutePath = try lock.withLock {\n if case let .symlink(destination) = try getNode(path)?.contents {\n return try .init(validating: destination, relativeTo: path.parentDirectory)\n } else {\n return path\n }\n }\n\n let fileQueue: DispatchQueue = lockFilesLock.withLock {\n if let queueReference = lockFiles[resolvedPath], let queue = queueReference.reference {\n return queue\n } else {\n let queue = DispatchQueue(label: \"org.swift.swiftpm.in-memory-file-system.file-queue\", attributes: .concurrent)\n lockFiles[resolvedPath] = WeakReference(queue)\n return queue\n }\n }\n\n return try fileQueue.sync(flags: type == .exclusive ? .barrier : .init() , execute: body)\n }\n\n public func withLock(on path: TSCBasic.AbsolutePath, type: FileLock.LockType, blocking: Bool, _ body: () throws -> T) throws -> T {\n try self.withLock(on: path, type: type, body)\n }\n}\n\n// Internal state of `InMemoryFileSystem` is protected with a lock in all of its `public` methods.\nextension InMemoryFileSystem: @unchecked Sendable {}\n" }, { "path": "Sources/Basics/FileSystem/NativePathExtensions.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Foundation\nimport struct TSCBasic.AbsolutePath\n\nextension AbsolutePath {\n /// Returns the File System Representation of the `AbsolutePath`'s\n /// `pathString` property converted into a `URL`.\n public func _nativePathString(escaped: Bool) -> String {\n return URL(fileURLWithPath: self.pathString).withUnsafeFileSystemRepresentation {\n let repr = String(cString: $0!)\n if escaped {\n return repr.replacing(\"\\\\\", with: \"\\\\\\\\\")\n }\n return repr\n }\n }\n}\n\nextension DefaultStringInterpolation {\n public mutating func appendInterpolation(_ value: AbsolutePath) {\n self.appendInterpolation(value._nativePathString(escaped: false))\n }\n}\n\nextension SerializedJSON.StringInterpolation {\n public mutating func appendInterpolation(_ value: AbsolutePath) {\n self.appendInterpolation(value._nativePathString(escaped: false))\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/RelativePath.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2023 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct TSCBasic.RelativePath\n\n// public for transition\npublic typealias TSCRelativePath = TSCBasic.RelativePath\n\n/// Represents a relative file system path. A relative path never starts with\n/// a `/` character, and holds a normalized string representation. As with\n/// AbsolutePath, the normalization is strictly syntactic, and does not access\n/// the file system in any way.\n///\n/// The relative path string is normalized by:\n/// - Collapsing `..` path components that aren't at the beginning\n/// - Removing extraneous `.` path components\n/// - Removing any trailing path separator\n/// - Removing any redundant path separators\n/// - Replacing a completely empty path with a `.`\n///\n/// This string manipulation may change the meaning of a path if any of the\n/// path components are symbolic links on disk. However, the file system is\n/// never accessed in any way when initializing a RelativePath.\npublic struct RelativePath: Hashable, Sendable {\n let underlying: TSCBasic.RelativePath\n\n // public for transition\n public init(_ underlying: TSCBasic.RelativePath) {\n self.underlying = underlying\n }\n\n /// Convenience initializer that verifies that the path is relative.\n public init(validating pathString: String) throws {\n self.underlying = try .init(validating: pathString)\n }\n\n /// Directory component. For a relative path without any path separators,\n /// this is the `.` string instead of the empty string.\n public var dirname: String {\n self.underlying.dirname\n }\n\n /// Last path component (including the suffix, if any). It is never empty.\n public var basename: String {\n self.underlying.basename\n }\n\n /// Returns the basename without the extension.\n public var basenameWithoutExt: String {\n self.underlying.basenameWithoutExt\n }\n\n /// Suffix (including leading `.` character) if any. Note that a basename\n /// that starts with a `.` character is not considered a suffix, nor is a\n /// trailing `.` character.\n public var suffix: String? {\n self.underlying.suffix\n }\n\n /// Extension of the give path's basename. This follow same rules as\n /// suffix except that it doesn't include leading `.` character.\n public var `extension`: String? {\n self.underlying.extension\n }\n\n /// Normalized string representation (the normalization rules are described\n /// in the documentation of the initializer). This string is never empty.\n public var pathString: String {\n self.underlying.pathString\n }\n}\n\nextension RelativePath {\n /// Returns an array of strings that make up the path components of the\n /// relative path. This is the same sequence of strings as the basenames\n /// of each successive path component. Therefore the returned array of\n /// path components is never empty; even an empty path has a single path\n /// component: the `.` string.\n public var components: [String] {\n self.underlying.components\n }\n\n /// Returns the relative path with the given relative path applied.\n public func appending(_ subpath: RelativePath) -> RelativePath {\n Self(self.underlying.appending(subpath.underlying))\n }\n\n /// Returns the relative path with an additional literal component appended.\n ///\n /// This method accepts pseudo-path like '.' or '..', but should not contain \"/\".\n public func appending(component: String) -> RelativePath {\n Self(self.underlying.appending(component: component))\n }\n\n /// Returns the relative path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(components: [String]) -> RelativePath {\n Self(self.underlying.appending(components: components))\n }\n\n /// Returns the relative path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(components: String...) -> RelativePath {\n Self(self.underlying.appending(components: components))\n }\n\n /// Returns the relative path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(_ component: String) -> RelativePath {\n self.appending(component: component)\n }\n\n /// Returns the relative path with additional literal components appended.\n ///\n /// This method should only be used in cases where the input is guaranteed\n /// to be a valid path component (i.e., it cannot be empty, contain a path\n /// separator, or be a pseudo-path like '.' or '..').\n public func appending(_ components: String...) -> RelativePath {\n self.appending(components: components)\n }\n}\n\nextension RelativePath: Codable {\n public func encode(to encoder: Encoder) throws {\n try self.underlying.encode(to: encoder)\n }\n\n public init(from decoder: Decoder) throws {\n self = try .init(TSCBasic.RelativePath(from: decoder))\n }\n}\n\n/// Make relative paths CustomStringConvertible and CustomDebugStringConvertible.\nextension RelativePath: CustomStringConvertible {\n public var description: String {\n self.underlying.description\n }\n\n public var debugDescription: String {\n self.underlying.debugDescription\n }\n}\n\nextension TSCRelativePath {\n public init(_ path: RelativePath) {\n self = path.underlying\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/TSCAdapters.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport func TSCBasic.getEnvSearchPaths\nimport func TSCBasic.lookupExecutablePath\nimport func TSCBasic.makeDirectories\nimport func TSCBasic.resolveSymlinks\nimport func TSCBasic.walk\nimport func TSCBasic.withTemporaryDirectory\n\nimport struct TSCBasic.FileSystemError\nimport class TSCBasic.LocalFileOutputByteStream\nimport enum TSCBasic.ProcessEnv\nimport class TSCBasic.RecursibleDirectoryContentsGenerator\n\npublic func resolveSymlinks(_ path: AbsolutePath) throws -> AbsolutePath {\n try AbsolutePath(TSCBasic.resolveSymlinks(path.underlying))\n}\n\npublic func withTemporaryDirectory(\n dir: AbsolutePath? = nil, prefix: String = \"TemporaryDirectory\",\n _ body: (AbsolutePath, @escaping (AbsolutePath) -> Void) throws -> Result\n) throws -> Result {\n try TSCBasic.withTemporaryDirectory(dir: dir?.underlying, prefix: prefix) { path, callback in\n let callback2 = { (path: AbsolutePath) in\n callback(path.underlying)\n }\n return try body(AbsolutePath(path), callback2)\n }\n}\n\npublic func withTemporaryDirectory(\n dir: AbsolutePath? = nil, prefix: String = \"TemporaryDirectory\",\n _ body: (AbsolutePath, @escaping (AbsolutePath) async -> Void) async throws -> Result\n) async throws -> Result {\n try await TSCBasic.withTemporaryDirectory(dir: dir?.underlying, prefix: prefix) { path, callback in\n let callback2: (AbsolutePath) async -> Void = { (path: AbsolutePath) in\n await callback(path.underlying)\n }\n return try await body(AbsolutePath(path), callback2)\n }\n}\n\npublic func withTemporaryDirectory(\n dir: AbsolutePath? = nil, prefix: String = \"TemporaryDirectory\", removeTreeOnDeinit: Bool = false,\n _ body: (AbsolutePath) throws -> Result\n) throws -> Result {\n try TSCBasic.withTemporaryDirectory(dir: dir?.underlying, prefix: prefix, removeTreeOnDeinit: removeTreeOnDeinit) {\n try body(AbsolutePath($0))\n }\n}\n\npublic func withTemporaryDirectory(\n dir: AbsolutePath? = nil, prefix: String = \"TemporaryDirectory\", removeTreeOnDeinit: Bool = false,\n _ body: (AbsolutePath) async throws -> Result\n) async throws -> Result {\n try await TSCBasic.withTemporaryDirectory(\n dir: dir?.underlying,\n prefix: prefix,\n removeTreeOnDeinit: removeTreeOnDeinit\n ) {\n try await body(AbsolutePath($0))\n }\n}\n\n/// Lookup an executable path from an environment variable value, current working\n/// directory or search paths. Only return a value that is both found and executable.\n///\n/// This method searches in the following order:\n/// * If env value is a valid absolute path, return it.\n/// * If env value is relative path, first try to locate it in current working directory.\n/// * Otherwise, in provided search paths.\n///\n/// - Parameters:\n/// - filename: The name of the file to find.\n/// - currentWorkingDirectory: The current working directory to look in.\n/// - searchPaths: The additional search paths to look in if not found in cwd.\n/// - Returns: Valid path to executable if present, otherwise nil.\npublic func lookupExecutablePath(\n filename: String?,\n currentWorkingDirectory: AbsolutePath? = localFileSystem.currentWorkingDirectory,\n searchPaths: [AbsolutePath] = []\n) -> AbsolutePath? {\n TSCBasic.lookupExecutablePath(\n filename: filename,\n currentWorkingDirectory: currentWorkingDirectory?.underlying,\n searchPaths: searchPaths.map(\\.underlying)\n ).flatMap { AbsolutePath($0) }\n}\n\n/// Create a list of AbsolutePath search paths from a string, such as the PATH environment variable.\n///\n/// - Parameters:\n/// - pathString: The path string to parse.\n/// - currentWorkingDirectory: The current working directory, the relative paths will be converted to absolute paths\n/// based on this path.\n/// - Returns: List of search paths.\npublic func getEnvSearchPaths(\n pathString: String?,\n currentWorkingDirectory: AbsolutePath?\n) -> [AbsolutePath] {\n TSCBasic.getEnvSearchPaths(\n pathString: pathString,\n currentWorkingDirectory: currentWorkingDirectory?.underlying\n ).map { AbsolutePath($0) }\n}\n\npublic func walk(\n _ path: AbsolutePath,\n fileSystem: FileSystem = localFileSystem,\n recursively: Bool = true\n) throws -> WalkResult {\n let result = try TSCBasic.walk(\n path.underlying,\n fileSystem: fileSystem,\n recursively: recursively\n )\n return WalkResult(result)\n}\n\npublic class WalkResult: IteratorProtocol, Sequence {\n private let underlying: TSCBasic.RecursibleDirectoryContentsGenerator\n\n init(_ underlying: TSCBasic.RecursibleDirectoryContentsGenerator) {\n self.underlying = underlying\n }\n\n public func next() -> AbsolutePath? {\n self.underlying.next().flatMap { AbsolutePath($0) }\n }\n}\n\npublic func makeDirectories(_ path: AbsolutePath) throws {\n try TSCBasic.makeDirectories(path.underlying)\n}\n\nextension TSCBasic.LocalFileOutputByteStream {\n public convenience init(_ path: AbsolutePath, closeOnDeinit: Bool = true, buffered: Bool = true) throws {\n try self.init(path.underlying, closeOnDeinit: closeOnDeinit, buffered: buffered)\n }\n}\n\nextension TSCBasic.ProcessEnv {\n public static func chdir(_ path: AbsolutePath) throws {\n try self.chdir(path.underlying)\n }\n}\n\nextension TSCBasic.FileSystemError {\n @_disfavoredOverload\n public init(_ kind: Kind, _ path: AbsolutePath? = nil) {\n self.init(kind, path?.underlying)\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/TemporaryFile.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport _Concurrency\nimport Foundation\nimport enum TSCBasic.TempFileError\n\n/// Creates a temporary directory and evaluates a closure with the directory path as an argument.\n/// The temporary directory will live on disk while the closure is evaluated and will be deleted when\n/// the cleanup closure is called. This allows the temporary directory to have an arbitrary lifetime.\n///\n/// - Parameters:\n/// - fileSystem: `FileSystem` which is used to construct temporary directory.\n/// - dir: If specified the temporary directory will be created in this directory otherwise environment\n/// variables TMPDIR, TEMP and TMP will be checked for a value (in that order). If none of the env\n/// variables are set, dir will be set to `/tmp/`.\n/// - prefix: The prefix to the temporary file name.\n/// - body: A closure to execute that receives the absolute path of the directory as an argument.\n/// If `body` has a return value, that value is also used as the\n/// return value for the `withTemporaryDirectory` function.\n/// The cleanup block should be called when the temporary directory is no longer needed.\n///\n/// - Throws: An error when creating directory and rethrows all errors from `body`.\npublic func withTemporaryDirectory(\n fileSystem: FileSystem = localFileSystem,\n dir: AbsolutePath? = nil,\n prefix: String = \"TemporaryDirectory\",\n _ body: @escaping @Sendable (AbsolutePath, @escaping (AbsolutePath) -> Void) async throws -> Result\n) throws -> Task {\n let temporaryDirectory = try createTemporaryDirectory(fileSystem: fileSystem, dir: dir, prefix: prefix)\n\n let task: Task = Task {\n try await withTaskCancellationHandler {\n try await body(temporaryDirectory) { path in\n try? fileSystem.removeFileTree(path)\n }\n } onCancel: {\n try? fileSystem.removeFileTree(temporaryDirectory)\n }\n }\n\n return task\n}\n\n/// Creates a temporary directory and evaluates a closure with the directory path as an argument.\n/// The temporary directory will live on disk while the closure is evaluated and will be deleted afterwards.\n///\n/// - Parameters:\n/// - fileSystem: `FileSystem` which is used to construct temporary directory.\n/// - dir: If specified the temporary directory will be created in this directory otherwise environment\n/// variables TMPDIR, TEMP and TMP will be checked for a value (in that order). If none of the env\n/// variables are set, dir will be set to `/tmp/`.\n/// - prefix: The prefix to the temporary file name.\n/// - removeTreeOnDeinit: If enabled try to delete the whole directory tree otherwise remove only if its empty.\n/// - body: A closure to execute that receives the absolute path of the directory as an argument.\n/// If `body` has a return value, that value is also used as the\n/// return value for the `withTemporaryDirectory` function.\n///\n/// - Throws: An error when creating directory and rethrows all errors from `body`.\n@discardableResult\npublic func withTemporaryDirectory(\n fileSystem: FileSystem = localFileSystem,\n dir: AbsolutePath? = nil,\n prefix: String = \"TemporaryDirectory\",\n removeTreeOnDeinit: Bool = false,\n _ body: @escaping @Sendable (AbsolutePath) async throws -> Result\n) throws -> Task {\n try withTemporaryDirectory(fileSystem: fileSystem, dir: dir, prefix: prefix) { path, cleanup in\n defer { if removeTreeOnDeinit { cleanup(path) } }\n return try await body(path)\n }\n}\n\nprivate func createTemporaryDirectory(\n fileSystem: FileSystem,\n dir: AbsolutePath?,\n prefix: String\n) throws -> AbsolutePath {\n // This random generation is needed so that\n // it is more or less equal to generation using `mkdtemp` function\n let letters = \"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789\"\n\n let randomSuffix = String((0 ..< 6).map { _ in letters.randomElement()! })\n\n let tempDirectory = try dir ?? fileSystem.tempDirectory\n guard fileSystem.isDirectory(tempDirectory) else {\n throw TempFileError.couldNotFindTmpDir(tempDirectory.pathString)\n }\n\n // Construct path to the temporary directory.\n let templatePath = try AbsolutePath(validating: prefix + \".\\(randomSuffix)\", relativeTo: tempDirectory)\n\n try fileSystem.createDirectory(templatePath, recursive: true)\n return templatePath\n}\n" }, { "path": "Sources/Basics/FileSystem/VFSOverlay.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2022 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport class Foundation.JSONEncoder\n\npublic struct VFSOverlay: Encodable {\n public struct File: Encodable {\n enum CodingKeys: String, CodingKey {\n case externalContents = \"external-contents\"\n case name\n case type\n }\n\n private let externalContents: String\n private let name: String\n private let type = \"file\"\n\n public init(name: String, externalContents: String) {\n self.name = name\n self.externalContents = externalContents\n }\n }\n\n enum CodingKeys: String, CodingKey {\n case roots\n case useExternalNames = \"use-external-names\"\n case version\n }\n\n private let roots: [File]\n private let useExternalNames = false\n private let version = 0\n\n public init(roots: [File]) {\n self.roots = roots\n }\n\n public func write(to path: AbsolutePath, fileSystem: FileSystem) throws {\n // VFS overlay files are YAML, but ours is simple enough that it works when being written using `JSONEncoder`.\n try JSONEncoder.makeWithDefaults(prettified: false).encode(path: path, fileSystem: fileSystem, self)\n }\n}\n" }, { "path": "Sources/Basics/FileSystem/VirtualFileSystem.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2021 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport Foundation\nimport struct TSCBasic.ByteString\nimport struct TSCBasic.FileInfo\nimport enum TSCBasic.FileMode\n\nprivate enum DirectoryNode: Codable {\n case directory(name: String, isSymlink: Bool, children: [DirectoryNode])\n case file(name: String, isExecutable: Bool, isSymlink: Bool, contents: Data?)\n case root(children: [DirectoryNode])\n\n var children: [DirectoryNode] {\n switch self {\n case .directory(_, _, let children): return children\n case .file: return []\n case .root(let children): return children\n }\n }\n\n var name: String {\n switch self {\n case .directory(let name, _, _): return name\n case .file(let name, _, _, _): return name\n case .root: return AbsolutePath.root.pathString\n }\n }\n\n var fileAttributeType: FileAttributeType {\n switch self {\n case .directory: return .typeDirectory\n case .file(_, _, let isSymlink, _): return isSymlink ? .typeSymbolicLink : .typeRegular\n case .root: return .typeDirectory\n }\n }\n\n var isDirectory: Bool {\n switch self {\n case .directory: return true\n case .file: return false\n case .root: return true\n }\n }\n\n var isFile: Bool {\n switch self {\n case .directory: return false\n case .file: return true\n case .root: return false\n }\n }\n\n var isRoot: Bool {\n switch self {\n case .directory: return false\n case .file: return false\n case .root: return true\n }\n }\n\n var isSymlink: Bool {\n switch self {\n case .directory(_, let isSymlink, _): return isSymlink\n case .file(_, _, let isSymlink, _): return isSymlink\n case .root: return false\n }\n }\n}\n\nprivate enum Errors: Swift.Error, LocalizedError {\n case noSuchFileOrDirectory(path: AbsolutePath)\n case notAFile(path: AbsolutePath)\n case readOnlyFileSystem\n case unhandledDirectoryNode(path: AbsolutePath)\n\n public var errorDescription: String? {\n switch self {\n case .noSuchFileOrDirectory(let path): return \"no such file or directory: \\(path.pathString)\"\n case .notAFile(let path): return \"not a file: \\(path.pathString)\"\n case .readOnlyFileSystem: return \"read-only filesystem\"\n case .unhandledDirectoryNode(let path): return \"unhandled directory node: \\(path.pathString)\"\n }\n }\n}\n\nextension FileSystem {\n fileprivate func getDirectoryNodes(\n _ path: AbsolutePath,\n includeContents: [AbsolutePath]\n ) throws -> [DirectoryNode] {\n try getDirectoryContents(path).compactMap {\n let current = path.appending(component: $0)\n let isSymlink = isSymlink(current)\n\n if isFile(current) {\n let contents: Data?\n if includeContents.contains(current) {\n contents = try readFileContents(current)\n } else {\n contents = nil\n }\n return .file(\n name: $0,\n isExecutable: isExecutableFile(current),\n isSymlink: isSymlink,\n contents: contents\n )\n } else if isDirectory(current) {\n if $0.hasPrefix(\".\") { return nil } // we ignore hidden files\n return .directory(\n name: $0,\n isSymlink: isSymlink,\n children: try getDirectoryNodes(current, includeContents: includeContents)\n )\n } else {\n throw Errors.unhandledDirectoryNode(path: current)\n }\n }\n }\n}\n\n/// A JSON-backed, read-only virtual file system.\npublic class VirtualFileSystem: FileSystem {\n private let root: DirectoryNode\n\n public init(path: TSCAbsolutePath, fs: FileSystem) throws {\n self.root = try JSONDecoder.makeWithDefaults()\n .decode(path: AbsolutePath(path), fileSystem: fs, as: DirectoryNode.self)\n assert(self.root.isRoot, \"VFS needs to have a root node\")\n }\n\n /// Write information about the directory tree at `directoryPath` into a JSON file at `vfsPath`. This can later be used to construct a `VirtualFileSystem` object.\n public static func serializeDirectoryTree(\n _ directoryPath: AbsolutePath,\n into vfsPath: AbsolutePath,\n fs: FileSystem,\n includeContents: [AbsolutePath]\n ) throws {\n let data = try JSONEncoder.makeWithDefaults().encode(\n DirectoryNode.root(\n children: fs.getDirectoryNodes(\n directoryPath,\n includeContents: includeContents\n )\n )\n )\n try data.write(to: URL(fileURLWithPath: vfsPath.pathString))\n }\n\n private func findNode(_ path: TSCAbsolutePath, followSymlink: Bool) -> DirectoryNode? {\n var current: DirectoryNode? = self.root\n for component in path.components {\n if component == AbsolutePath.root.pathString { continue }\n guard followSymlink, current?.isSymlink == false else { return nil }\n current = current?.children.first(where: { $0.name == component })\n }\n return current\n }\n\n public func exists(_ path: TSCAbsolutePath, followSymlink: Bool) -> Bool {\n findNode(path, followSymlink: followSymlink) != nil\n }\n\n public func isDirectory(_ path: TSCAbsolutePath) -> Bool {\n findNode(path, followSymlink: true)?.isDirectory == true\n }\n\n public func isFile(_ path: TSCAbsolutePath) -> Bool {\n findNode(path, followSymlink: true)?.isFile == true\n }\n\n public func isExecutableFile(_ path: TSCAbsolutePath) -> Bool {\n guard let node = findNode(path, followSymlink: true) else { return false }\n if case .file(_, let isExecutable, _, _) = node {\n return isExecutable\n } else {\n return false\n }\n }\n\n public func isSymlink(_ path: TSCAbsolutePath) -> Bool {\n findNode(path, followSymlink: true)?.isSymlink == true\n }\n\n public func isReadable(_ path: TSCAbsolutePath) -> Bool {\n self.exists(path)\n }\n\n public func isWritable(_: TSCAbsolutePath) -> Bool {\n false\n }\n\n public func getDirectoryContents(_ path: TSCAbsolutePath) throws -> [String] {\n guard let node = findNode(path, followSymlink: true)\n else { throw Errors.noSuchFileOrDirectory(path: AbsolutePath(path)) }\n return node.children.map(\\.name)\n }\n\n public let currentWorkingDirectory: TSCAbsolutePath? = nil\n\n public func changeCurrentWorkingDirectory(to path: TSCAbsolutePath) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public var homeDirectory = TSCAbsolutePath.root\n\n public var cachesDirectory: TSCAbsolutePath? = nil\n\n public var tempDirectory = TSCAbsolutePath.root\n\n public func createSymbolicLink(\n _ path: TSCAbsolutePath,\n pointingAt destination: TSCAbsolutePath,\n relative: Bool\n ) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func removeFileTree(_: TSCAbsolutePath) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func copy(from sourcePath: TSCAbsolutePath, to destinationPath: TSCAbsolutePath) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func move(from sourcePath: TSCAbsolutePath, to destinationPath: TSCAbsolutePath) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func createDirectory(_ path: TSCAbsolutePath, recursive: Bool) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func readFileContents(_ path: TSCAbsolutePath) throws -> ByteString {\n guard let node = findNode(path, followSymlink: true)\n else { throw Errors.noSuchFileOrDirectory(path: AbsolutePath(path)) }\n switch node {\n case .directory: throw Errors.notAFile(path: AbsolutePath(path))\n case .file(_, _, _, let contents):\n if let contents {\n return ByteString(contents)\n } else {\n return \"\"\n }\n case .root: throw Errors.notAFile(path: AbsolutePath(path))\n }\n }\n\n public func writeFileContents(_ path: TSCAbsolutePath, bytes: ByteString) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func chmod(_ mode: FileMode, path: TSCAbsolutePath, options: Set) throws {\n throw Errors.readOnlyFileSystem\n }\n\n public func getFileInfo(_ path: TSCAbsolutePath) throws -> FileInfo {\n guard let node = findNode(path, followSymlink: true)\n else { throw Errors.noSuchFileOrDirectory(path: AbsolutePath(path)) }\n\n let attrs: [FileAttributeKey: Any] = [\n .systemNumber: NSNumber(value: UInt64(0)),\n .systemFileNumber: UInt64(0),\n .posixPermissions: NSNumber(value: Int16(0)),\n .type: node.fileAttributeType,\n .size: UInt64(0),\n .modificationDate: Date(),\n ]\n return FileInfo(attrs)\n }\n}\n\n// `VirtualFileSystem` is read-only, so it can be marked as `Sendable`.\nextension VirtualFileSystem: @unchecked Sendable {}\n" }, { "path": "Sources/Basics/Graph/AdjacencyMatrix.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\n/// A matrix storing bits of `true`/`false` state for a given combination of row and column indices. Used as\n/// a square matrix indicating edges in graphs, where rows and columns are indices in a storage of graph's nodes.\n///\n/// For example, in a graph that contains 3 nodes `matrix[row: 1, column: 2]` evaluating to `true` means an edge\n/// between nodes with indices `1` and `2` exists. `matrix[row: 1, column: 2]` evaluating to `false` means that no\n/// edge exists.\n///\n/// See https://en.wikipedia.org/wiki/Adjacency_matrix for more details.\nstruct AdjacencyMatrix {\n let columns: Int\n let rows: Int\n private var bytes: [UInt8]\n\n /// Allocates a new bit matrix with a given size.\n /// - Parameters:\n /// - rows: Number of rows in the matrix.\n /// - columns: Number of columns in the matrix.\n init(rows: Int, columns: Int) {\n self.columns = columns\n self.rows = rows\n \n let (quotient, remainder) = (rows * columns).quotientAndRemainder(dividingBy: 8)\n self.bytes = .init(repeating: 0, count: quotient + (remainder > 0 ? 1 : 0))\n }\n\n var bitCount: Int {\n bytes.count * 8\n }\n\n private func calculateOffsets(row: Int, column: Int) -> (byteOffset: Int, bitOffsetInByte: Int) {\n let totalBitOffset = row * columns + column\n return (byteOffset: totalBitOffset / 8, bitOffsetInByte: totalBitOffset % 8)\n }\n\n subscript(row: Int, column: Int) -> Bool {\n get {\n let (byteOffset, bitOffsetInByte) = calculateOffsets(row: row, column: column)\n\n let result = (self.bytes[byteOffset] >> bitOffsetInByte) & 1\n return result == 1\n }\n\n set {\n let (byteOffset, bitOffsetInByte) = calculateOffsets(row: row, column: column)\n\n self.bytes[byteOffset] |= 1 << bitOffsetInByte\n }\n }\n}\n" }, { "path": "Sources/Basics/Graph/DirectedGraph.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nprivate import DequeModule\n\n/// Directed graph that stores edges in [adjacency lists](https://en.wikipedia.org/wiki/Adjacency_list).\n@_spi(DontAdoptOutsideOfSwiftPMExposedForBenchmarksAndTestsOnly)\npublic struct DirectedGraph {\n public init(nodes: [Node]) {\n self.nodes = nodes\n self.edges = .init(repeating: [], count: nodes.count)\n }\n\n public private(set) var nodes: [Node]\n private var edges: [[Int]]\n\n public mutating func addEdge(source: Int, destination: Int) {\n self.edges[source].append(destination)\n }\n \n /// Checks whether a path via previously created edges between two given nodes exists.\n /// - Parameters:\n /// - source: `Index` of a node to start traversing edges from.\n /// - destination: `Index` of a node to which a path could exist via edges from `source`.\n /// - Returns: `true` if a path from `source` to `destination` exists, `false` otherwise.\n @_spi(DontAdoptOutsideOfSwiftPMExposedForBenchmarksAndTestsOnly)\n public func areNodesConnected(source: Int, destination: Int) -> Bool {\n var todo = Deque([source])\n var done = Set()\n\n while !todo.isEmpty {\n let nodeIndex = todo.removeFirst()\n\n for reachableIndex in self.edges[nodeIndex] {\n if reachableIndex == destination {\n return true\n } else if !done.contains(reachableIndex) {\n todo.append(reachableIndex)\n }\n }\n\n done.insert(nodeIndex)\n }\n\n return false\n }\n}\n" }, { "path": "Sources/Basics/Graph/GraphAlgorithms.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2015-2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nimport struct OrderedCollections.OrderedSet\n\n/// Implements a pre-order depth-first search.\n///\n/// The cycles are handled by skipping cycle points but it should be possible to\n/// to extend this in the future to provide a callback for every cycle.\n///\n/// - Parameters:\n/// - nodes: The list of input nodes to sort.\n/// - successors: A closure for fetching the successors of a particular node.\n/// - onUnique: A callback to indicate the the given node is being processed for the first time.\n/// - onDuplicate: A callback to indicate that the node was already processed at least once.\n///\n/// - Complexity: O(v + e) where (v, e) are the number of vertices and edges\n/// reachable from the input nodes via the relation.\npublic func depthFirstSearch(\n _ nodes: [T],\n successors: (T) throws -> [T],\n onUnique: (T) throws -> Void,\n onDuplicate: (T, T) -> Void\n) rethrows {\n var stack = OrderedSet()\n var visited = Set()\n\n for node in nodes {\n precondition(stack.isEmpty)\n stack.append(node)\n\n while !stack.isEmpty {\n let curr = stack.removeLast()\n\n let visitResult = visited.insert(curr)\n if visitResult.inserted {\n try onUnique(curr)\n } else {\n onDuplicate(visitResult.memberAfterInsert, curr)\n continue\n }\n\n for succ in try successors(curr) {\n stack.append(succ)\n }\n }\n }\n}\n\npublic func depthFirstSearch(\n _ nodes: [T],\n successors: (T) async throws -> [T],\n onUnique: (T) async throws -> Void,\n onDuplicate: (T, T) async -> Void\n) async rethrows {\n var stack = OrderedSet()\n var visited = Set()\n\n for node in nodes {\n precondition(stack.isEmpty)\n stack.append(node)\n\n while !stack.isEmpty {\n let curr = stack.removeLast()\n\n let visitResult = visited.insert(curr)\n if visitResult.inserted {\n try await onUnique(curr)\n } else {\n await onDuplicate(visitResult.memberAfterInsert, curr)\n continue\n }\n\n for succ in try await successors(curr) {\n stack.append(succ)\n }\n }\n }\n}\n\nprivate struct TraversalNode: Hashable {\n let parent: T?\n let curr: T\n}\n\n/// Implements a pre-order depth-first search that traverses the whole graph and\n/// doesn't distinguish between unique and duplicate nodes. The method expects\n/// the graph to be acyclic but doesn't check that.\n///\n/// - Parameters:\n/// - nodes: The list of input nodes to sort.\n/// - successors: A closure for fetching the successors of a particular node.\n/// - onNext: A callback to indicate the node currently being processed\n/// including its parent (if any) and its depth.\n///\n/// - Complexity: O(v + e) where (v, e) are the number of vertices and edges\n/// reachable from the input nodes via the relation.\npublic func depthFirstSearch(\n _ nodes: [T],\n successors: (T) throws -> [T],\n onNext: (T, _ parent: T?) throws -> Void\n) rethrows {\n var stack = OrderedSet>()\n\n for node in nodes {\n precondition(stack.isEmpty)\n stack.append(TraversalNode(parent: nil, curr: node))\n\n while !stack.isEmpty {\n let node = stack.removeLast()\n\n try onNext(node.curr, node.parent)\n\n for succ in try successors(node.curr) {\n stack.append(\n TraversalNode(\n parent: node.curr,\n curr: succ\n )\n )\n }\n }\n }\n}\n" }, { "path": "Sources/Basics/Graph/UndirectedGraph.swift", "content": "//===----------------------------------------------------------------------===//\n//\n// This source file is part of the Swift open source project\n//\n// Copyright (c) 2024 Apple Inc. and the Swift project authors\n// Licensed under Apache License v2.0 with Runtime Library Exception\n//\n// See http://swift.org/LICENSE.txt for license information\n// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors\n//\n//===----------------------------------------------------------------------===//\n\nprivate import DequeModule\n\n/// Undirected graph that stores edges in an [adjacency matrix](https://en.wikipedia.org/wiki/Adjacency_matrix).\n@_spi(DontAdoptOutsideOfSwiftPMExposedForBenchmarksAndTestsOnly)\npublic struct UndirectedGraph {\n public init(nodes: [Node]) {\n self.nodes = nodes\n self.edges = .init(rows: nodes.count, columns: nodes.count)\n }\n\n private var nodes: [Node]\n private var edges: AdjacencyMatrix\n\n public mutating func addEdge(source: Int, destination: Int) {\n // Adjacency matrix is symmetrical for undirected graphs.\n self.edges[source, destination] = true\n self.edges[destination, source] = true\n }\n\n /// Checks whether a connection via previously created edges between two given nodes exists.\n /// - Parameters:\n /// - source: `Index` of a node to start traversing edges from.\n /// - destination: `Index` of a node to which a connection could exist via edges from `source`.\n /// - Returns: `true` if a path from `source` to `destination` exists, `false` otherwise.\n public func areNodesConnected(source: Int, destination: Int) -> Bool {\n var todo = Deque([source])\n var done = Set()\n\n while !todo.isEmpty {\n let nodeIndex = todo.removeFirst()\n\n for reachableIndex in self.edges.nodesAdjacentTo(nodeIndex) {\n if reachableIndex == destination {\n return true\n } else if !done.contains(reachableIndex) {\n todo.append(reachableIndex)\n }\n }\n\n done.insert(nodeIndex)\n }\n\n return false\n }\n}\n\nprivate extension AdjacencyMatrix {\n func nodesAdjacentTo(_ nodeIndex: Int) -> [Int] {\n var result = [Int]()\n\n for i in 0..