Commit graph

50 commits

Author SHA1 Message Date
Amaan Qureshi
500f4326d5 feat: add the ability to specify a custom decode function 2024-10-31 22:51:40 -04:00
Davis Vaughan
937dfbfbab Swap \s for \\s 2024-04-20 07:51:45 -04:00
ObserverOfTime
b4b2d9cecc refactor: remove extern/const where possible 2024-02-29 01:50:04 -05:00
Amaan Qureshi
9e5bf6591f feat: improve language bindings
Co-authored-by: ObserverOfTime <chronobserver@disroot.org>
2024-02-25 19:06:01 -05:00
dundargoc
bf9154febe docs: small fixes
Co-authored-by: Wang <bonede@qq.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
2024-02-16 00:15:49 +01:00
Amaan Qureshi
665f5a0793 docs: explicitly mention behavior of walking outside the given "root" node for a TSTreeCursor 2024-02-14 15:54:46 -05:00
dundargoc
df1fe842eb docs: various fixes
Closes https://github.com/tree-sitter/tree-sitter/issues/1317.
Closes https://github.com/tree-sitter/tree-sitter/issues/1752.
Closes https://github.com/tree-sitter/tree-sitter/issues/2439.

Co-authored-by: Simon Hengel <sol@typeful.net>
Co-authored-by: Akash Yadav <itsaky01@gmail.com>
Co-authored-by: Sebastiaan Speck <12570668+sebastiaanspeck@users.noreply.github.com>
Co-authored-by: Laytan Laats <laytanlaats@hotmail.com>
2024-02-08 00:08:59 +01:00
Firas al-Khalil
665da5e230 doc: fix multi-language program typo 2023-11-06 13:18:09 +01:00
Amaan Qureshi
c5cb27e522
docs: improve predicate docs 2023-08-31 16:01:37 -04:00
Andrew Hlynskyi
613382c70a docs: update badges; fix markdown lint complains
Linter config `.vscode/settings.json`:
```json
{
    "[markdown]": {
        "files.trimTrailingWhitespace": false,
    },
    "markdownlint.config": {
        "default": true,
        // "ul-style": {
        //     "style": "asterisk"
        // },
        "MD001": false,
        "MD024": false,
        "MD025": false,
        "MD033": false,
        "MD041": false,
        "MD053": false,
    },
}
```
2023-04-16 23:39:08 +03:00
Andreas Deininger
0751736d17 docs: convert various links to https protocol 2023-04-04 18:05:46 +03:00
Andrew Hlynskyi
5766b8a0a7 docs: apply scheme marker for all query syntax snippets 2023-02-06 21:33:50 +02:00
petrisch
40a2afad49
Update section-2-using-parsers.md
Typo
2022-06-27 10:15:23 +02:00
Nokome Bentley
12d3e1b898
docs(Using parsers): Fix spelling, remove unusual keyword 2021-07-26 11:01:55 +12:00
Santos Gallegos
4adc2f5c88
Docs: document _ wildcard node
Closes https://github.com/tree-sitter/tree-sitter/issues/1253
2021-07-11 10:25:42 -05:00
Max Brunsfeld
a7ae7767b4 Add docs for negated field patterns 2021-03-12 15:12:24 -08:00
Patrick Thomson
1749a5d672 Shorter wording. 2020-10-23 15:11:53 -04:00
Patrick Thomson
4d8cdc2f36
Update docs/section-2-using-parsers.md
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
2020-10-23 15:11:23 -04:00
Patrick Thomson
b42b873564
Update docs/section-2-using-parsers.md
Co-authored-by: Max Brunsfeld <maxbrunsfeld@gmail.com>
2020-10-23 15:11:17 -04:00
Patrick Thomson
b5d20f07b6 Document query anchor operator (#771)
This was taken more or less directly from @maxbrunsfeld's PR comments
in https://github.com/tree-sitter/tree-sitter/pull/549. 🎩
2020-10-23 14:34:56 -04:00
Santos Gallegos
b2e4d3f54f Document alternations and wildcard nodes
These were added in https://github.com/tree-sitter/tree-sitter/pull/615
and https://github.com/tree-sitter/tree-sitter/pull/630

Closes https://github.com/tree-sitter/tree-sitter/issues/704
2020-08-15 13:08:46 -05:00
Max Brunsfeld
61814b468d Remove build-lib script, recommend make 2020-05-12 16:28:26 -07:00
Max Brunsfeld
f6f96f3503 Document the new query syntax 2020-05-11 14:24:00 -07:00
Ronan Cherrueau ⚓
b65582797a
Fix the Getting Started example in docs (#588)
Running the first example of the Getting Started failed with:

  main: Assertion `strcmp(ts_node_type(root_node), "value") == 0' failed.

The cause is the json parser that renamed the entry rule from `value` to
`document` in commit tree-sitter/tree-sitter-json@1e4abcc. This commit
update the example in docs to fix the assert.
2020-04-03 11:35:31 -07:00
Max Brunsfeld
f2e9e3b3f2 docs: Link to semantic dir instead of codegen PR 2020-03-02 09:38:25 -08:00
Max Brunsfeld
3cd05a3d0c Link to Semantic in node-types docs 2020-02-24 11:21:05 -08:00
Max Brunsfeld
f1e4104d47 Document supertypes and the node-types file
References #542
References #524
Closes #393
2020-02-24 11:12:42 -08:00
Mark Schmitz
3fbe0be6e2
Fix small typo in docs 2019-12-02 13:05:41 +00:00
Max Brunsfeld
079aa26a99 Link to docs.rs from docs site 2019-11-08 14:31:24 -08:00
Max Brunsfeld
5a3a672e30 Expand on query docs 2019-10-30 10:26:10 -07:00
Max Brunsfeld
d5dc4bbcaa Fix some errors in new query docs 2019-10-28 17:32:10 -07:00
Max Brunsfeld
6146c39b0a Add information about queries on the docs site 2019-10-28 17:19:57 -07:00
Matthew Krupcale
ee9a3c0ebb lib: remove utf8proc dependency (#436)
* Remove dependency on utf8proc

This removes the only external dependency on utf8proc for UTF-8 decoding. It does so by implementing its own UTF-8 decoder. This decoder is both faster and has a simpler API.

 * .gitmodules: remove utf8proc submodule
 * docs/section-2-using-parsers.md: remove requirement for utf8proc submodule
 * docs/section-6-contributing.md: likewise
 * lib/Cargo.toml: remove utf8proc subdirectory package include
 * lib/README.md: remove utf8proc subdirectory description
 * lib/binding_rust/build.rs: remove utf8proc compiler include directory
 * lib/src/lexer.c: remove utf8proc dependencies and types
 * lib/src/lib.c: remove utf8proc dependency
 * lib/src/unicode.h: define types for Unicode decoders
 * lib/src/utf16.{c,h}: implement more readable UTF-16 decoder
 * lib/src/utf8.{c,h}: implement fast UTF-8 decoder
 * lib/utf8proc: remove utf8proc submodule directory
 * script/build-lib: remove utf8proc compiler include directory
 * script/build-wasm: likewise

* Optimize ts_lexer__get_lookahead.

Try to favor non-failure code path and assign lookahead values directly to lexer

 * lib/src/lexer.c: optimize for non-failure code path

* Fix some compiler errors

 * lib/src/lexer.c: cast from signed to unsigned for decode_next result
 * lib/src/utf16.c: fix non-constant initializers for older compilers

* Remove some missed remnants of utf8proc

 * docs/section-2-using-parsers.md: only two include paths necessary now
 * lib/src/lib.c: no need to define UTF8PROC_STATIC

* Use ICU's utf8 and utf16 decoding routines

* Remove unnecessary casts when calling icu macros

* Check buffer length before attempting to decode a unicode character

* Use new unicode function when parsing Queries

Co-Authored-By: Matthew Krupcale <mkrupcale@matthewkrupcale.com>

* Mark libicu files as vendored for GitHub's stats
2019-10-14 11:18:39 -07:00
Rob Rix
20bb99249b Fix a typo in the docs. (#457) 2019-10-04 14:49:19 -07:00
Max Brunsfeld
f9a3998029 docs: Start adding info about field names 2019-09-05 15:43:10 -07:00
francisfuzz
ec7def2e62
s/Ucsing/Using 2019-05-31 13:06:39 -07:00
Max Brunsfeld
2f06abf984 Start work on contributing guide 2019-05-30 17:53:20 -07:00
Chris Charles
9ce9a53298 Reorder objects in documentation for consistency
The documentation lists four types of objects, the C names for them,
and a summary for each. These are now shown in the same order.
2019-05-21 07:52:23 -04:00
Andrew Craig
bcc823984e Update doc example program file locations
Update doc example program compilation instructions to be consistent
with directory structure.
2019-05-08 21:03:16 +09:00
Max Brunsfeld
3fc459a84b Reorganize language bindings
* Move rust binding: lib/binding -> lib/binding_rust
* Move wasm bindinig: lib/web -> lib/binding_web
* Add wasm readme
2019-05-07 10:41:49 -07:00
Max Brunsfeld
92e9f984ed Fix small docs errors 2019-02-22 09:44:25 -08:00
Max Brunsfeld
af44147157 docs: Fix references to runtime.h, libruntime.a 2019-02-21 16:41:22 -08:00
Max Brunsfeld
23837adac1 Fix editing documentation, add note about ts_node_edit
Fixes #242
2018-11-27 11:31:22 -08:00
Max Brunsfeld
47918070f6 Add a single-source file way of building the runtime library 2018-11-13 15:36:21 -08:00
vzvu3k6k
87448aa534 Fix assetion of an example program
test-json-parser fails:
    test-json-parser.c:42: int main():
    Assertion `ts_node_child_count(array_node) == 4' failed.

`array_node` has five nodes: ([), (number), (,), (null), (]).
2018-10-25 02:20:10 +09:00
Max Brunsfeld
9e13912db3 Tweak docs for multi-language documents 2018-09-12 20:11:35 -07:00
Max Brunsfeld
1878b425de Add documentation about included ranges 2018-09-12 17:54:52 -07:00
Max Brunsfeld
de0e8a39a2 Expand using parsers section of the docs 2018-08-14 12:13:10 -07:00
Max Brunsfeld
87ad0fb9c2 Expand using parsers document 2018-08-13 18:04:10 -07:00
Max Brunsfeld
be81989de2 Improve implementation page of docs 2018-06-20 09:49:23 -07:00
Renamed from docs/section-4-using-parsers.md (Browse further)