Initial open source commit

Author: keith

.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+/.build/
+/*.xcodeproj/
+/DerivedData/
+/.swiftpm/

CODE_OF_CONDUCT.md

@@ -0,0 +1,2 @@
+This project is governed by [Lyft's code of conduct](https://github.com/lyft/code-of-conduct).
+All contributors and participants agree to abide by its terms.

LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022 Lyft, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

NOTICE

@@ -0,0 +1,6 @@
+IndexStore
+Copyright 2019-2022 Lyft Inc.
+
+This product includes software developed at Lyft Inc.
+
+This project contains headers copied from the Swift and LLVM projects. Licenses for those files are included in the respective headers.

Package.swift

@@ -0,0 +1,54 @@
+// swift-tools-version:5.2
+
+import PackageDescription
+
+#if os(macOS)
+import Foundation
+let linkerSettings: [LinkerSetting]? = {
+    let process = Process()
+    process.launchPath = "/usr/bin/xcode-select"
+    process.arguments = ["-p"]
+    let pipe = Pipe()
+    process.standardOutput = pipe
+    process.launch()
+    process.waitUntilExit()
+    let data = pipe.fileHandleForReading.readDataToEndOfFile()
+    let XcodePath = String(decoding: data, as: UTF8.self).trimmingCharacters(in: .newlines)
+    return [
+        .unsafeFlags(["-L\(XcodePath)/Toolchains/XcodeDefault.xctoolchain/usr/lib"]),
+        .unsafeFlags(["-Xlinker", "-rpath", "-Xlinker", "\(XcodePath)/Toolchains/XcodeDefault.xctoolchain/usr/lib"]),
+    ]
+}()
+#else
+let linkerSettings: [LinkerSetting]? = nil
+#endif
+
+let package = Package(
+    name: "IndexStore",
+    products: [
+        .library(name: "IndexStore", targets: ["IndexStore"]),
+        .library(name: "CSwiftDemangle", targets: ["CSwiftDemangle"]),
+        .library(name: "SwiftDemangle", targets: ["SwiftDemangle"]),
+        .executable(name: "indexutil-export", targets: ["indexutil-export"]),
+        .executable(name: "unnecessary-testable", targets: ["unnecessary-testable"]),
+        .executable(name: "indexutil-annotate", targets: ["indexutil-annotate"]),
+        .executable(name: "tycat", targets: ["tycat"]),
+    ],
+    targets: [
+        .target(name: "CIndexStore"),
+        .target(name: "IndexStore", dependencies: ["CIndexStore"]),
+        .testTarget(name: "IndexStoreTests", dependencies: ["IndexStore"], linkerSettings: linkerSettings),
+        .target(
+            name: "CSwiftDemangle",
+            cxxSettings: [.headerSearchPath("PrivateHeaders/include")],
+            linkerSettings: [.linkedLibrary("swiftDemangle")]
+        ),
+        .target(name: "SwiftDemangle", dependencies: ["CSwiftDemangle"]),
+        .testTarget(name: "SwiftDemangleTests", dependencies: ["SwiftDemangle"]),
+        .target(name: "indexutil-export", dependencies: ["IndexStore"], linkerSettings: linkerSettings),
+        .target(name: "unnecessary-testable", dependencies: ["IndexStore"], linkerSettings: linkerSettings),
+        .target(name: "indexutil-annotate", dependencies: ["IndexStore"], linkerSettings: linkerSettings),
+        .target(name: "tycat", dependencies: ["IndexStore"], linkerSettings: linkerSettings),
+    ],
+    cxxLanguageStandard: .cxx11
+)

README.md

@@ -0,0 +1,87 @@
+# swift-index-store
+
+`swift-index-store` is collection of libraries and tools for
+programmatically reading the source code index produced by `swiftc` and
+`clang`.
+
+## Example Usage
+
+The `IndexStore` library is the primary entrypoint. For example if you
+want to print all the `class`es defined in a specific file:
+
+```swift
+let storePath = // path/to/DerivedData/index/store
+let sourceFile = // path/to/interesting/source/file
+
+// Load the index store produced by swiftc
+let store = try IndexStore(path: storePath)
+for unit in store.units {
+    // Find the unit that corresponds to the source file we're interested in
+    guard unit.mainFile == sourceFile, let recordName = unit.recordName else {
+        continue
+    }
+
+    let recordReader = try RecordReader(indexStore: store, recordName: recordName)
+    recordReader.forEach { symbolOccurrence in
+        // Print class definitions in the source file
+        if symbolOccurrence.roles.contains(.definition) && symbolOccurrence.symbol.kind == .class {
+            print(symbolOccurrence.symbol.name)
+        }
+    }
+}
+```
+
+For more examples see:
+
+- [`unnecessary-testable`](Sources/unnecessary-testable/main.swift)
+  which discovers uses of `@testable` that aren't required based on the
+  API being called by the importing file.
+- [`tycat`](Sources/tycat) which print the subtypes or supertypes of a
+  given type.
+- [`indexutil-annotate`](Sources/indexutil-annotate) which outputs
+  the index information overlaid on the given source file for debugging
+  unexpected index data.
+
+## Setup
+
+Swift Package Manager:
+
+```swift
+let package = Package(
+    // ...
+    dependencies: [
+        .package(url: "https://github.com/lyft/swift-index-store", from: "1.0.0"),
+    ],
+    targets: [
+        .executableTarget(name: "<command-line-tool>", dependencies: [
+            .product(name: "IndexStore", package: "swift-index-store"),
+        ]),
+    ]
+)
+```
+
+## How it works
+
+During compilation, both `swiftc` and `clang` can generate a detailed
+source code index by providing the `-index-store-path` flag. The data
+model of the index is public, just not well known or well documented.
+
+`IndexStore` is a Swift wrapper over the first party `libIndexStore` C
+library which is part of LLVM. Xcode and Swift for Linux contain
+`libIndexStore`, but its header is found separately in
+[apple/llvm-project's
+`indexstore.h`](https://github.com/apple/llvm-project/blob/apple/next/clang/include/indexstore/indexstore.h).
+
+For more details on the index store's data model, see:
+
+1. Adding Index-While-Building and Refactoring to Clang: https://www.youtube.com/watch?v=jGJhnIT-D2M
+2. High level design: https://docs.google.com/document/d/1cH2sTpgSnJZCkZtJl1aY-rzy4uGPcrI-6RrUpdATO2Q/
+
+### How does this differ from [`indexstore-db`][indexstore-db]
+
+The goal of this library is to provide a thin Swift layer on top of the
+C library for one shot tools that manage the structure of the index data
+themselves. [`indexstore-db`][indexstore-db] provides more comprehensive
+support for querying index data as it changes across multiple builds.
+
+[indexstore-db]: https://github.com/apple/indexstore-db

Scripts/node-kind-list.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -euo pipefail
+
+echo "#include <stdint.h>"
+echo "#include <CoreFoundation/CFAvailability.h>"
+cat <<EOF | xcrun clang -x c++ -E -I Sources/CSwiftDemangle/PrivateHeaders/include -o - -
+typedef CF_ENUM(uint32_t, demangle_node_kind_t) {
+#define NODE(ID) demangle_node_kind_ ## ID,
+#include "swift/Demangling/DemangleNodes.def"
+};
+EOF