diff options
Diffstat (limited to 'admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html')
| -rw-r--r-- | admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html | 211 |
1 files changed, 0 insertions, 211 deletions
diff --git a/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html b/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html deleted file mode 100644 index 1d992b828ea..00000000000 --- a/admin/notes/tree-sitter/html-manual/Tree_002dsitter-C-API.html +++ /dev/null @@ -1,211 +0,0 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<html> -<!-- Created by GNU Texinfo 6.8, https://www.gnu.org/software/texinfo/ --> -<head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8"> -<!-- This is the GNU Emacs Lisp Reference Manual -corresponding to Emacs version 29.0.50. - -Copyright © 1990-1996, 1998-2023 Free Software Foundation, Inc. - -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with the -Invariant Sections being "GNU General Public License," with the -Front-Cover Texts being "A GNU Manual," and with the Back-Cover -Texts as in (a) below. A copy of the license is included in the -section entitled "GNU Free Documentation License." - -(a) The FSF's Back-Cover Text is: "You have the freedom to copy and -modify this GNU manual. Buying copies from the FSF supports it in -developing GNU and promoting software freedom." --> -<title>Tree-sitter C API (GNU Emacs Lisp Reference Manual)</title> - -<meta name="description" content="Tree-sitter C API (GNU Emacs Lisp Reference Manual)"> -<meta name="keywords" content="Tree-sitter C API (GNU Emacs Lisp Reference Manual)"> -<meta name="resource-type" content="document"> -<meta name="distribution" content="global"> -<meta name="Generator" content="makeinfo"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link href="index.html" rel="start" title="Top"> -<link href="Index.html" rel="index" title="Index"> -<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> -<link href="Parsing-Program-Source.html" rel="up" title="Parsing Program Source"> -<link href="Tree_002dsitter-major-modes.html" rel="prev" title="Tree-sitter major modes"> -<style type="text/css"> -<!-- -a.copiable-anchor {visibility: hidden; text-decoration: none; line-height: 0em} -a.summary-letter {text-decoration: none} -blockquote.indentedblock {margin-right: 0em} -div.display {margin-left: 3.2em} -div.example {margin-left: 3.2em} -kbd {font-style: oblique} -pre.display {font-family: inherit} -pre.format {font-family: inherit} -pre.menu-comment {font-family: serif} -pre.menu-preformatted {font-family: serif} -span.nolinebreak {white-space: nowrap} -span.roman {font-family: initial; font-weight: normal} -span.sansserif {font-family: sans-serif; font-weight: normal} -span:hover a.copiable-anchor {visibility: visible} -ul.no-bullet {list-style: none} ---> -</style> -<link rel="stylesheet" type="text/css" href="./manual.css"> - - -</head> - -<body lang="en"> -<div class="section" id="Tree_002dsitter-C-API"> -<div class="header"> -<p> -Previous: <a href="Tree_002dsitter-major-modes.html" accesskey="p" rel="prev">Developing major modes with tree-sitter</a>, Up: <a href="Parsing-Program-Source.html" accesskey="u" rel="up">Parsing Program Source</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> -</div> -<hr> -<span id="Tree_002dsitter-C-API-Correspondence"></span><h3 class="section">37.8 Tree-sitter C API Correspondence</h3> - -<p>Emacs’ tree-sitter integration doesn’t expose every feature -provided by tree-sitter’s C API. Missing features include: -</p> -<ul> -<li> Creating a tree cursor and navigating the syntax tree with it. -</li><li> Setting timeout and cancellation flag for a parser. -</li><li> Setting the logger for a parser. -</li><li> Printing a <acronym>DOT</acronym> graph of the syntax tree to a file. -</li><li> Copying and modifying a syntax tree. (Emacs doesn’t expose a tree -object.) -</li><li> Using (row, column) coordinates as position. -</li><li> Updating a node with changes. (In Emacs, retrieve a new node instead -of updating the existing one.) -</li><li> Querying statics of a language definition. -</li></ul> - -<p>In addition, Emacs makes some changes to the C API to make the API more -convenient and idiomatic: -</p> -<ul> -<li> Instead of using byte positions, the Emacs Lisp API uses character -positions. -</li><li> Null nodes are converted to nil. -</li></ul> - -<p>Below is the correspondence between all C API functions and their -ELisp counterparts. Sometimes one ELisp function corresponds to -multiple C functions, and many C functions don’t have an ELisp -counterpart. -</p> -<div class="example"> -<pre class="example">ts_parser_new treesit-parser-create -ts_parser_delete -ts_parser_set_language -ts_parser_language treesit-parser-language -ts_parser_set_included_ranges treesit-parser-set-included-ranges -ts_parser_included_ranges treesit-parser-included-ranges -ts_parser_parse -ts_parser_parse_string treesit-parse-string -ts_parser_parse_string_encoding -ts_parser_reset -ts_parser_set_timeout_micros -ts_parser_timeout_micros -ts_parser_set_cancellation_flag -ts_parser_cancellation_flag -ts_parser_set_logger -ts_parser_logger -ts_parser_print_dot_graphs -ts_tree_copy -ts_tree_delete -ts_tree_root_node -ts_tree_language -ts_tree_edit -ts_tree_get_changed_ranges -ts_tree_print_dot_graph -ts_node_type treesit-node-type -ts_node_symbol -ts_node_start_byte treesit-node-start -ts_node_start_point -ts_node_end_byte treesit-node-end -ts_node_end_point -ts_node_string treesit-node-string -ts_node_is_null -ts_node_is_named treesit-node-check -ts_node_is_missing treesit-node-check -ts_node_is_extra treesit-node-check -ts_node_has_changes -ts_node_has_error treesit-node-check -ts_node_parent treesit-node-parent -ts_node_child treesit-node-child -ts_node_field_name_for_child treesit-node-field-name-for-child -ts_node_child_count treesit-node-child-count -ts_node_named_child treesit-node-child -ts_node_named_child_count treesit-node-child-count -ts_node_child_by_field_name treesit-node-by-field-name -ts_node_child_by_field_id -ts_node_next_sibling treesit-node-next-sibling -ts_node_prev_sibling treesit-node-prev-sibling -ts_node_next_named_sibling treesit-node-next-sibling -ts_node_prev_named_sibling treesit-node-prev-sibling -ts_node_first_child_for_byte treesit-node-first-child-for-pos -ts_node_first_named_child_for_byte treesit-node-first-child-for-pos -ts_node_descendant_for_byte_range treesit-descendant-for-range -ts_node_descendant_for_point_range -ts_node_named_descendant_for_byte_range treesit-descendant-for-range -ts_node_named_descendant_for_point_range -ts_node_edit -ts_node_eq treesit-node-eq -ts_tree_cursor_new -ts_tree_cursor_delete -ts_tree_cursor_reset -ts_tree_cursor_current_node -ts_tree_cursor_current_field_name -ts_tree_cursor_current_field_id -ts_tree_cursor_goto_parent -ts_tree_cursor_goto_next_sibling -ts_tree_cursor_goto_first_child -ts_tree_cursor_goto_first_child_for_byte -ts_tree_cursor_goto_first_child_for_point -ts_tree_cursor_copy -ts_query_new -ts_query_delete -ts_query_pattern_count -ts_query_capture_count -ts_query_string_count -ts_query_start_byte_for_pattern -ts_query_predicates_for_pattern -ts_query_step_is_definite -ts_query_capture_name_for_id -ts_query_string_value_for_id -ts_query_disable_capture -ts_query_disable_pattern -ts_query_cursor_new -ts_query_cursor_delete -ts_query_cursor_exec treesit-query-capture -ts_query_cursor_did_exceed_match_limit -ts_query_cursor_match_limit -ts_query_cursor_set_match_limit -ts_query_cursor_set_byte_range -ts_query_cursor_set_point_range -ts_query_cursor_next_match -ts_query_cursor_remove_match -ts_query_cursor_next_capture -ts_language_symbol_count -ts_language_symbol_name -ts_language_symbol_for_name -ts_language_field_count -ts_language_field_name_for_id -ts_language_field_id_for_name -ts_language_symbol_type -ts_language_version -</pre></div> -</div> -<hr> -<div class="header"> -<p> -Previous: <a href="Tree_002dsitter-major-modes.html">Developing major modes with tree-sitter</a>, Up: <a href="Parsing-Program-Source.html">Parsing Program Source</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html" title="Index" rel="index">Index</a>]</p> -</div> - - - -</body> -</html> |