tiandiyixian / magpiebridge

MagpieBridge LSP Framework --- A simple solution for your IDE integration

What is MagpieBridge?

MapgieBridge is a framework for integrating Static Analyses into IDEs and Editors with the Language Server Protocol. It is a part of the FutureSoot project. MagpieBridge offers a default implementation of a language server---MagpieServer which runs analysis; a default TextDocumentService--MagpieTextDocumentService which handles requests like didOpen, didChange, didSave; a default WorkspaceService--MagpieWorkspaceService which handles different kinds of code actions and many other useful APIs for static analysis. For more information, please read our paper: MagpieBridge: A General Approach to Integrating Static Analyses into IDEs and Editors (ECOOP 2019). A Poster is also available. You can find the IRConverter under https://github.com/MagpieBridge/IRConverter for converting WALA IR to Soot IR, if you want to analyze Java source code with Soot.

Cite the research paper

For scientific usage, please cite the paper [BibTex].

Why is it called MagpieBridge?

In a Chinese legend, a human and a fairy fall in love, but this love angers the gods, who separate them on opposite sides of the Milky Way. However, on the seventh day of the seventh lunar month each year, thousands of magpies form a bridge, called 鹊桥 in Chinese and Queqiao in pinyin, allowing the lovers to meet. We use MagpieBridge as a metaphor for a system that connects arbitrary static analysis to arbitrary IDE.

How to use MapgieBridge?

• Check the tutorials to create your first project with MagpieBridge 🌟UPDATED🌟

Integrated Static Analyses using MagpieBridge

• MagpieBridge-based CogniCrypt
• MagpieBridge-based FlowDroid

Use MagpieBridge in your Maven project

You can either

1. MagpieBridge is published on the GitHub Package Registry. You can use the release by adding the following lines to your pom.xml (See all github package). You can follow these instructions.

<dependencies>
  <dependency>
    <groupId>magpiebridge</groupId>
    <artifactId>magpiebridge</artifactId>
    <version>0.0.6</version>
  </dependency>
</dependencies>

<repositories>
  <repository>
    <id>github</id>
    <name>GitHub MagpieBridge Apache Maven Packages</name>
    <url>https://maven.pkg.github.com/MagpieBridge/MagpieBridge</url>
  </repository>
</repositories>

2. or build MagpieBridge by yourself
   • check out the develop branch with git clone -b develop https://github.com/MagpieBridge/MagpieBridge.git
   • run mvn install in the project root directory to build the tool and run all tests. To skip tests, run mvn install -DskipTests.

Build MagpieBridge in IDE

1. Simply import the project as maven project in your IDE, Maven should take care of all required dependences. For Eclipse:

Eclipse> File> Import > Maven > Existing Maven Projects > Enter the path to your local repository > Finish

Contributors:

Get Involved

• Pull requests are welcome!
• Submit github issues for any feature enhancements, bugs or documentation problems
• Please format the code with mvn com.coveo:fmt-maven-plugin:format before git push

Contact

✉ linghui[at]outlook.de