Skip to content

Latest commit

 

History

History
135 lines (76 loc) · 3.37 KB

README.md

File metadata and controls

135 lines (76 loc) · 3.37 KB
Raw

Soufflé Datalog Language Server README

Soufflé is a logic programming language inspired by Datalog. Soufflé was initially designed for static program analysis and since then, there have been many other applications written in the Soufflé language, including applications in reverse engineering, network analysis and data analytics.

This is a plugin adding basic smart features to the Soufflé language, using the Language Server Protocol.

For syntax highlighting refer to: https://marketplace.visualstudio.com/items?itemName=W4RH4WK.souffle-syntax

The user needs to set the JAVA_HOME variable in settings for the plugin to work properly.

Features

  • Automatic reparsing when saving the file.

  • Syntax error reporting

Syntax error message

  • Integration with souffle-lint (If available on user system)

Souffle-lint message

  • Hover (Provide declaration info on hovers)

Hover example

  • Go to definition

Go to definition example

  • Go to Type Definition

Go to type definition example

  • Autocomplete

Autocomplete example

  • Signature Help

Signature Help example

  • Rename

Rename example

  • Find all references

References example

  • Find all rules for relation

Rule references example

  • Generate .input/.output for relation

Genarate I/O example

  • Extract type

Extract example

  • Snippets for fact / rule templates

  • Snippets for decl / comp generation

  • Deprecated code warning and quickfixes

  • Reformat documentation comments

Reformat comments example

  • Document symbols

Outline example

Requirements

The user needs to have Java installed on their system.

Build from source

To build the server jar file yourself just run ./gradlew jar on the top level and the resulting jar will be under build/libs.

To run the server run java -jar with the name of the generated jar file.

For the VS Code plugin run npm run package and the resulting .js file will be under dist/extension.js

Known Issues

In libraries with heavy use of the C preprocessor macros, sometimes parsing fails giving a false syntax error.

Release Notes

0.3.1

Minor fix in type autocomplete suggestions

0.3.0

  • Added primitive type list autocomplete
  • Added relation data structure list
  • Better type documentation (include super types)
  • Added deprecated code warnings

0.2.5

  • Added support for snippets
    • fact / rule template
    • decl / comp generation

0.2.1

  • Added support for slow rules in souffle-lint
  • Added support for many one-line // style comments.

0.2.0

  • Added integration with souffle-lint.
  • Added source code action to trigger souffle-lint
  • Added code action to extract types

0.1.6

Added code actions for reformatting documentation comments.

0.1.5

Added code actions for generating .input/.output for relations.

0.1.2

Updated README

0.1.1

  • Changed the grammar to be on par with Souffle.
  • Added icon.

0.1.0

Initial release of Soufflé Datalog Language Server.