swiftlang / indexstore-db Goto Github PK

Index database library for use with sourcekit-lsp

License: Apache License 2.0

Swift 5.10% Python 0.46% C 12.81% C++ 81.36% Objective-C++ 0.03% Objective-C 0.01% CMake 0.23%

indexstore-db's Introduction

IndexStoreDB

IndexStoreDB is a source code indexing library. It provides a composable and efficient query API for looking up source code symbols, symbol occurrences, and relations. IndexStoreDB uses the libIndexStore library, which lives in swiftlang/llvm-project, for reading raw index data. Raw index data can be produced by compilers such as Apple Clang and Swift using the -index-store-path option. IndexStoreDB enables efficiently querying this data by maintaining acceleration tables in a key-value database built with LMDB.

IndexStoreDB's data model is derived from libIndexStore. For more information about libIndexStore, and producing raw indexing data, see the Indexing While Building whitepaper.

Building IndexStoreDB

IndexStoreDB is built using the Swift Package Manager.

For a standard debug build and test:

$ swift build
$ swift test

Building on Linux

The C++ code in the index requires libdispatch, but unlike Swift code, it cannot find it automatically on Linux. You can work around this by adding a search path manually.

$ swift build -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift/Block

Some Example Users

Pecker: a tool to detect unused code based on SwiftSyntax and IndexStoreDB.

Contributing to Swift

Contributions to indexstore-db are welcomed and encouraged! Please see the Contributing to Swift guide.

Before submitting the pull request, please make sure you have tested your changes and that they follow the Swift project guidelines for contributing code.

To be a truly great community, Swift.org needs to welcome developers from all walks of life, with different backgrounds, and with a wide range of experience. A diverse and friendly community will have more great ideas, more unique perspectives, and produce more great code. We will work diligently to make the Swift community welcoming to everyone.

To give clarity of what is expected of our members, Swift has adopted the code of conduct defined by the Contributor Covenant. This document is used across many open source communities, and we think it articulates our values well. For more, see the Code of Conduct.

Development

For more information about developing IndexStoreDB, see Development.

indexstore-db's People

Contributors

Stargazers

Watchers

indexstore-db's Issues

build-script-helper.py needs to support Python3 to support Ubuntu 22.04

/home/build-user/indexstore-db/Utilities/build-script-helper.py build --package-path /home/build-user/indexstore-db --build-path /home/build-user/build/buildbot_linux/indexstoredb-linux-x86_64 --configuration release --toolchain /home/build-user/swift-nightly-install/usr --ninja-bin /home/build-user/build/buildbot_linux/ninja-build/ninja
/usr/bin/env: ‘python’: No such file or directory

https://ci.swift.org/job/oss-swift-package-ubuntu-22_04/84/console

Import errors when running `swift build`

I'm following the directions in the README, but when I get to swift build I see a number of import errors:

╰─ swift build                         
Building for debugging...
/Users/stevenhepting/workspace/indexstore-db/lib/Support/PatternMatching.cpp:13:10: fatal error: 'IndexStoreDB/Support/PatternMatching.h' file not found
#include "IndexStoreDB/Support/PatternMatching.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1 error generated.
/Users/stevenhepting/workspace/indexstore-db/lib/LLVMSupport/Support/circular_raw_ostream.cpp:13:10: fatal error: 'llvm/Support/circular_raw_ostream.h' file not found
#include "llvm/Support/circular_raw_ostream.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/LLVMSupport/Support/raw_ostream.cpp:13:10: fatal error: 'llvm/Support/raw_ostream.h' file not found
#include "llvm/Support/raw_ostream.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/Support/Concurrency-Mac.cpp:13:10: fatal error: 'IndexStoreDB/Support/Concurrency.h' file not found
#include "IndexStoreDB/Support/Concurrency.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/Support/Logging.cpp:14:10: fatal error: 'IndexStoreDB/Support/Logging.h' file not found
#include "IndexStoreDB/Support/Logging.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/Support/FilePathWatcher.cpp:13:10: fatal error: 'IndexStoreDB/Support/FilePathWatcher.h' file not found
#include "IndexStoreDB/Support/FilePathWatcher.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/Support/Path.cpp:13:10: fatal error: 'IndexStoreDB/Support/Path.h' file not found
#include "IndexStoreDB/Support/Path.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
/Users/stevenhepting/workspace/indexstore-db/lib/LLVMSupport/Support/YAMLTraits.cpp:9:10: fatal error: 'llvm/Support/YAMLTraits.h' file not found
#include "llvm/Support/YAMLTraits.h"
         ^~~~~~~~~~~~~~~~~~~~~~~~~~~
[1/87] Compiling YAMLTraits.cpp

Is there perhaps another way to build this project using cmake?

throw an error if `storePath` is incorrect

on linux, at swift-5.10-RELEASE at least, it seems IndexStoreDB.init(storePath:databasePath:library:delegate:useExplicitOutputUnits:waitUntilDoneInitializing:readonly:enableOutOfDateFileWatching:listenToUnitEvents:prefixMappings:) will fail silently if the storePath is incorrect.

could the initializer check if an index store actually exists at that path?

Couldn't load project <.../ISDBTestSupport/INPUTS> error

It does not affect build, but an error will be reported.

swiftlang / indexstore-db Goto Github PK

indexstore-db's Introduction

IndexStoreDB

Building IndexStoreDB

Building on Linux

Some Example Users

Contributing to Swift

Development

indexstore-db's People

Contributors

Stargazers

Watchers

Forkers

indexstore-db's Issues

build-script-helper.py needs to support Python3 to support Ubuntu 22.04

Import errors when running `swift build`

throw an error if `storePath` is incorrect

Couldn't load project <.../ISDBTestSupport/INPUTS> error

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent