File: treesit.el.html

This file is the Lisp counterpart of treesit.c. Together they provide tree-sitter integration for Emacs. This file contains convenient functions that are more idiomatic and flexible than the exposed C API of tree-sitter. It also contains frameworks for integrating tree-sitter with font-lock, indentation, activating and deactivating tree-sitter, debugging tree-sitter, etc.

Defined variables (39)

treesit--explorer-bufferBuffer used to display the syntax tree.
treesit--explorer-highlight-overlayOverlay used to highlight in syntax tree and source buffer.
treesit--explorer-languageThe language used in the playground.
treesit--explorer-last-nodeLast top-level node used to generate syntax tree.
treesit--explorer-refresh-timerTimer for refreshing the syntax tree buffer.
treesit--explorer-source-bufferSource buffer corresponding to the playground buffer.
treesit--explorer-tree-mode-abbrev-tableAbbrev table for ‘treesit--explorer-tree-mode’.
treesit--explorer-tree-mode-hookHook run after entering TS Explorer mode.
treesit--explorer-tree-mode-mapKeymap for ‘treesit--explorer-tree-mode’.
treesit--explorer-tree-mode-syntax-tableSyntax table for ‘treesit--explorer-tree-mode’.
treesit--font-lock-fast-modeIf this variable is t, change the way we query so it’s faster.
treesit--font-lock-query-expand-rangeThe amount to expand the start and end of the region when fontifying.
treesit--font-lock-verboseIf non-nil, print debug messages when fontifying.
treesit--indent-region-batch-sizeHow many lines of indent value do we precompute.
treesit--indent-verboseIf non-nil, log progress when indenting.
treesit--inspect-nameUsed by ‘treesit-inspect-mode’ to show node name in mode-line.
treesit--pre-redisplay-tickThe last ‘buffer-chars-modified-tick’ that we’ve processed.
treesit--syntax-propertize-startIf non-nil, next ‘syntax-propertize’ should start at this position.
treesit-add-log-defun-delimiterThe delimiter used to connect several defun names.
treesit-block-type-regexpLike ‘treesit-defun-type-regexp’, but for blocks.
treesit-defun-name-functionA function that is called with a node and returns its defun name or nil.
treesit-defun-skipperA function called after tree-sitter navigation moved a step.
treesit-defun-tacticDetermines how does Emacs treat nested defuns.
treesit-defun-type-regexpA regexp that matches the node type of defun nodes.
treesit-explore-modeNon-nil if Treesit-Explore mode is enabled.
treesit-explore-mode-hookHook run after entering or leaving ‘treesit-explore-mode’.
treesit-font-lock-feature-listA list of lists of feature symbols.
treesit-font-lock-levelDecoration level to be used by tree-sitter fontifications.
treesit-font-lock-settingsA list of SETTINGs for treesit-based fontification.
treesit-indent-functionFunction used by ‘treesit-indent’ to do some of the work.
treesit-inspect-modeNon-nil if Treesit-Inspect mode is enabled.
treesit-inspect-mode-hookHook run after entering or leaving ‘treesit-inspect-mode’.
treesit-language-at-point-functionA function that returns the language at point.
treesit-language-source-alistConfiguration for downloading and installing tree-sitter language grammars.
treesit-max-buffer-sizeMaximum buffer size (in bytes) for enabling tree-sitter parsing.
treesit-range-settingsA list of range settings.
treesit-simple-imenu-settingsSettings that configure ‘treesit-simple-imenu’.
treesit-simple-indent-presetsA list of indent rule presets.
treesit-simple-indent-rulesA list of indent rule settings.

Defined functions (79)

treesit--call-process-signal(&rest ARGS)
treesit--check-manual-coverage()
treesit--check-repo-url(URL)
treesit--children-covering-range(NODE START END)
treesit--children-covering-range-recurse(NODE START END THRESHOLD &optional LIMIT)
treesit--clip-ranges(RANGES START END)
treesit--explorer--nodes-to-highlight(LANGUAGE)
treesit--explorer-draw-node(NODE)
treesit--explorer-highlight-node(NODES)
treesit--explorer-jump(BUTTON)
treesit--explorer-kill-explorer-buffer()
treesit--explorer-post-command(&rest _)
treesit--explorer-refresh()
treesit--explorer-tree-mode()
treesit--font-lock-level-setter(SYM VAL)
treesit--font-lock-notifier(RANGES PARSER)
treesit--generate-shortdoc-examples()
treesit--indent-1()
treesit--indent-rules-optimize(RULES)
treesit--install-language-grammar-1(OUT-DIR LANG URL &optional REVISION SOURCE-DIR CC C++)
treesit--install-language-grammar-build-recipe(LANG)
treesit--merge-ranges(OLD-RANGES NEW-RANGES START END)
treesit--navigate-thing(POS ARG SIDE REGEXP &optional PRED RECURSING)
treesit--node-length(NODE)
treesit--pre-redisplay(&rest _)
treesit--pre-syntax-ppss(START END)
treesit--set-nonsticky(START END SYM &optional REMOVE)
treesit--simple-imenu-1(NODE PRED NAME-FN)
treesit--simple-indent-eval(EXP)
treesit--syntax-propertize-notifier(RANGES PARSER)
treesit--thing-unpack-pattern(PATTERN)
treesit--things-around(POS REGEXP &optional PRED)
treesit--top-level-thing(NODE REGEXP &optional PRED)
treesit-add-log-current-defun()
treesit-beginning-of-defun(&optional ARG)
treesit-beginning-of-thing(PATTERN &optional ARG)
treesit-buffer-root-node(&optional LANGUAGE)
treesit-check-indent(MODE)
treesit-default-defun-skipper()
treesit-defun-at-point()
treesit-defun-name(NODE)
treesit-end-of-defun(&optional ARG _)
treesit-end-of-thing(PATTERN &optional ARG)
treesit-explore-mode(&optional ARG)
treesit-filter-child(NODE PRED &optional NAMED)
treesit-font-lock-fontify-region(START END &optional LOUDLY)
treesit-font-lock-recompute-features(&optional ADD-LIST REMOVE-LIST)
treesit-font-lock-rules(&rest QUERY-SPECS)
treesit-fontify-with-override(START END FACE OVERRIDE &optional BOUND-START BOUND-END)
treesit-indent()
treesit-indent-region(BEG END)
treesit-inspect-mode(&optional ARG)
treesit-inspect-node-at-point(&optional ARG)
treesit-install-language-grammar(LANG)
treesit-language-at(POSITION)
treesit-major-mode-setup()
treesit-node-at(POS &optional PARSER-OR-LANG NAMED)
treesit-node-buffer(NODE)
treesit-node-children(NODE &optional NAMED)
treesit-node-field-name(NODE)
treesit-node-index(NODE &optional NAMED)
treesit-node-language(NODE)
treesit-node-on(BEG END &optional PARSER-OR-LANG NAMED)
treesit-node-text(NODE &optional NO-PROPERTY)
treesit-node-top-level(NODE &optional PRED INCLUDE-NODE)
treesit-parent-until(NODE PRED &optional INCLUDE-NODE)
treesit-parent-while(NODE PRED)
treesit-parse-string(STRING LANGUAGE)
treesit-parser-range-on(PARSER BEG &optional END)
treesit-query-range(NODE QUERY &optional BEG END)
treesit-query-string(STRING QUERY LANGUAGE)
treesit-query-validate(LANGUAGE QUERY)
treesit-range-rules(&rest QUERY-SPECS)
treesit-ready-p(LANGUAGE &optional QUIET)
treesit-search-forward-goto(NODE PREDICATE &optional START BACKWARD ALL)
treesit-simple-imenu()
treesit-simple-indent(NODE PARENT BOL)
treesit-thing-at-point(PATTERN TACTIC)
treesit-update-ranges(&optional BEG END)

Defined faces (2)

treesit-explorer-anonymous-nodeFace for anonymous nodes in tree-sitter explorer.
treesit-explorer-field-nameFace for field names in tree-sitter explorer.