Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tree-sitter grammar #28

Draft
wants to merge 10 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions .github/workflows/tree-sitter.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: tree-sitter grammar

on: [push]

env:
NODE_VERSION: "16.x"

jobs:
build-and-test:
name: Compile and test grammar
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Use Node.js ${{ env.NODE_VERSION }}
uses: actions/setup-node@v1
with:
node-version: ${{ env.NODE_VERSION }}
- name: npm install and compile
run: |
cd tree-sitter-zcbuildout
npm install
npm run test
26 changes: 26 additions & 0 deletions tree-sitter-zcbuildout/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[package]
name = "tree-sitter-zcbuildout"
description = "zcbuildout grammar for the tree-sitter parsing library"
version = "0.0.1"
keywords = ["incremental", "parsing", "zcbuildout"]
categories = ["parsing", "text-editors"]
repository = "https://github.com/tree-sitter/tree-sitter-zcbuildout"
edition = "2018"
license = "MIT"

build = "bindings/rust/build.rs"
include = [
"bindings/rust/*",
"grammar.js",
"queries/*",
"src/*",
]

[lib]
path = "bindings/rust/lib.rs"

[dependencies]
tree-sitter = "~0.20"

[build-dependencies]
cc = "1.0"
19 changes: 19 additions & 0 deletions tree-sitter-zcbuildout/binding.gyp
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"targets": [
{
"target_name": "tree_sitter_zcbuildout_binding",
"include_dirs": [
"<!(node -e \"require('nan')\")",
"src"
],
"sources": [
"bindings/node/binding.cc",
"src/parser.c",
# If your language uses an external scanner, add it here.
],
"cflags_c": [
"-std=c99",
]
}
]
}
28 changes: 28 additions & 0 deletions tree-sitter-zcbuildout/bindings/node/binding.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#include "tree_sitter/parser.h"
#include <node.h>
#include "nan.h"

using namespace v8;

extern "C" TSLanguage * tree_sitter_zcbuildout();

namespace {

NAN_METHOD(New) {}

void Init(Local<Object> exports, Local<Object> module) {
Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
tpl->SetClassName(Nan::New("Language").ToLocalChecked());
tpl->InstanceTemplate()->SetInternalFieldCount(1);

Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
Nan::SetInternalFieldPointer(instance, 0, tree_sitter_zcbuildout());

Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("zcbuildout").ToLocalChecked());
Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
}

NODE_MODULE(tree_sitter_zcbuildout_binding, Init)

} // namespace
19 changes: 19 additions & 0 deletions tree-sitter-zcbuildout/bindings/node/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
try {
module.exports = require("../../build/Release/tree_sitter_zcbuildout_binding");
} catch (error1) {
if (error1.code !== 'MODULE_NOT_FOUND') {
throw error1;
}
try {
module.exports = require("../../build/Debug/tree_sitter_zcbuildout_binding");
} catch (error2) {
if (error2.code !== 'MODULE_NOT_FOUND') {
throw error2;
}
throw error1
}
}

try {
module.exports.nodeTypeInfo = require("../../src/node-types.json");
} catch (_) {}
40 changes: 40 additions & 0 deletions tree-sitter-zcbuildout/bindings/rust/build.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
fn main() {
let src_dir = std::path::Path::new("src");

let mut c_config = cc::Build::new();
c_config.include(&src_dir);
c_config
.flag_if_supported("-Wno-unused-parameter")
.flag_if_supported("-Wno-unused-but-set-variable")
.flag_if_supported("-Wno-trigraphs");
let parser_path = src_dir.join("parser.c");
c_config.file(&parser_path);

// If your language uses an external scanner written in C,
// then include this block of code:

/*
let scanner_path = src_dir.join("scanner.c");
c_config.file(&scanner_path);
println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
*/

c_config.compile("parser");
println!("cargo:rerun-if-changed={}", parser_path.to_str().unwrap());

// If your language uses an external scanner written in C++,
// then include this block of code:

/*
let mut cpp_config = cc::Build::new();
cpp_config.cpp(true);
cpp_config.include(&src_dir);
cpp_config
.flag_if_supported("-Wno-unused-parameter")
.flag_if_supported("-Wno-unused-but-set-variable");
let scanner_path = src_dir.join("scanner.cc");
cpp_config.file(&scanner_path);
cpp_config.compile("scanner");
println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
*/
}
52 changes: 52 additions & 0 deletions tree-sitter-zcbuildout/bindings/rust/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
//! This crate provides zcbuildout language support for the [tree-sitter][] parsing library.
//!
//! Typically, you will use the [language][language func] function to add this language to a
//! tree-sitter [Parser][], and then use the parser to parse some code:
//!
//! ```
//! let code = "";
//! let mut parser = tree_sitter::Parser::new();
//! parser.set_language(tree_sitter_zcbuildout::language()).expect("Error loading zcbuildout grammar");
//! let tree = parser.parse(code, None).unwrap();
//! ```
//!
//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
//! [language func]: fn.language.html
//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
//! [tree-sitter]: https://tree-sitter.github.io/

use tree_sitter::Language;

extern "C" {
fn tree_sitter_zcbuildout() -> Language;
}

/// Get the tree-sitter [Language][] for this grammar.
///
/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
pub fn language() -> Language {
unsafe { tree_sitter_zcbuildout() }
}

/// The content of the [`node-types.json`][] file for this grammar.
///
/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");

// Uncomment these to include any queries that this grammar contains

// pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
// pub const INJECTIONS_QUERY: &'static str = include_str!("../../queries/injections.scm");
// pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
// pub const TAGS_QUERY: &'static str = include_str!("../../queries/tags.scm");

#[cfg(test)]
mod tests {
#[test]
fn test_can_load_grammar() {
let mut parser = tree_sitter::Parser::new();
parser
.set_language(super::language())
.expect("Error loading zcbuildout language");
}
}
59 changes: 59 additions & 0 deletions tree-sitter-zcbuildout/grammar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
module.exports = grammar({
name: "zcbuildout",

extras: ($) => [
/[ \t]+\n*/, // Ignore empty lines.
],

rules: {
profile: ($) =>
seq(/[\n]*/, optional(repeat($.comment)), repeat(seq($.section))),

section: ($) =>
prec.left(
seq($._section_header, /[\n]+/, repeat(choice($.option, $.comment)))
),

_section_header: ($) =>
seq(
"[",
field("section_name", $.section_name),
optional(seq(/:/, field("section_condition", $.section_condition))),
"]"
),
section_name: ($) => /[^\[\]:\n]+/,
section_condition: ($) => /[^\[\]\n]+/,

option: ($) => seq($.option_name, "=", /\s*/, $.option_value),

option_name: ($) => /[^#;=\s\[]+/,
option_value: ($) =>
choice(
seq(
$._option_value_mono_line,
prec.left(1, repeat($._option_value_multi_line))
),
seq(/\n/, prec.left(2, repeat1($._option_value_multi_line)))
),
_option_value_mono_line: ($) => prec.left(1, seq($._option_text, /\n+/)),
_option_value_multi_line: ($) =>
prec.left(2, repeat1(seq(/\s+/, $._option_text, /\n+/))),

_option_text: ($) =>
repeat1(choice($.option_text, $.option_with_reference)),
option_text: ($) => /([^\n]+\$\$[^\n]*|[^\n]*\$\$[^\n]+|[^\$\n]+)+/,

option_with_reference: ($) =>
seq(
"${",
field("referenced_section", optional($.referenced_section)),
":",
field("referenced_option", $.referenced_option),
"}"
),
referenced_section: ($) => /[^:\}\n]+/,
referenced_option: ($) => /[^\n\}]+/,

comment: ($) => token(prec(-10, /[#;]+.*\n+/)),
},
});
47 changes: 47 additions & 0 deletions tree-sitter-zcbuildout/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

17 changes: 17 additions & 0 deletions tree-sitter-zcbuildout/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "tree-sitter-zcbuildout",
"version": "0.0.0",
"description": "Tree sitter grammar for zc.buildout profiles",
"main": "bindings/node",
"scripts": {
"test": "tree-sitter test"
},
"author": "Jérome Perrin (based on tree-sitter-ini from Justin M. Keyes)",
"license": "MIT",
"dependencies": {
"nan": "^2.15.0"
},
"devDependencies": {
"tree-sitter-cli": "^0.20.6"
}
}
Loading