2021-10-23 06:41:37 +04:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js colibri" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2023-03-31 10:23:23 +04:00
< title > Adding textobject queries< / title >
2021-10-23 06:41:37 +04:00
<!-- Custom HTML head -->
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< link rel = "icon" href = "../favicon.svg" >
< link rel = "shortcut icon" href = "../favicon.png" >
< link rel = "stylesheet" href = "../css/variables.css" >
< link rel = "stylesheet" href = "../css/general.css" >
< link rel = "stylesheet" href = "../css/chrome.css" >
< link rel = "stylesheet" href = "../css/print.css" media = "print" >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
<!-- Fonts -->
< link rel = "stylesheet" href = "../FontAwesome/css/font-awesome.css" >
< link rel = "preconnect" href = "https://fonts.gstatic.com" >
< link href = "https://fonts.googleapis.com/css2?family=Inter:wght@200;400;500;700&display=swap" rel = "stylesheet" >
< link rel = "stylesheet" href = "../fonts/fonts.css" >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "../highlight.css" >
< link rel = "stylesheet" href = "../tomorrow-night.css" >
< link rel = "stylesheet" href = "../ayu-highlight.css" >
<!-- Custom theme stylesheets -->
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< / head >
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "colibri" : "colibri";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('colibri')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2023-03-31 10:23:23 +04:00
< ol class = "chapter" > < li class = "chapter-item expanded affix " > < a href = "../title-page.html" > Helix< / a > < / li > < li class = "chapter-item expanded " > < a href = "../install.html" > < strong aria-hidden = "true" > 1.< / strong > Installation< / a > < / li > < li class = "chapter-item expanded " > < a href = "../usage.html" > < strong aria-hidden = "true" > 2.< / strong > Usage< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../keymap.html" > < strong aria-hidden = "true" > 2.1.< / strong > Keymap< / a > < / li > < li class = "chapter-item expanded " > < a href = "../commands.html" > < strong aria-hidden = "true" > 2.2.< / strong > Commands< / a > < / li > < li class = "chapter-item expanded " > < a href = "../lang-support.html" > < strong aria-hidden = "true" > 2.3.< / strong > Language support< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../from-vim.html" > < strong aria-hidden = "true" > 3.< / strong > Migrating from Vim< / a > < / li > < li class = "chapter-item expanded " > < a href = "../configuration.html" > < strong aria-hidden = "true" > 4.< / strong > Configuration< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../themes.html" > < strong aria-hidden = "true" > 4.1.< / strong > Themes< / a > < / li > < li class = "chapter-item expanded " > < a href = "../remapping.html" > < strong aria-hidden = "true" > 4.2.< / strong > Key remapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "../languages.html" > < strong aria-hidden = "true" > 4.3.< / strong > Languages< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "../guides/index.html" > < strong aria-hidden = "true" > 5.< / strong > Guides< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "../guides/adding_languages.html" > < strong aria-hidden = "true" > 5.1.< / strong > Adding languages< / a > < / li > < li class = "chapter-item expanded " > < a href = "../guides/textobject.html" class = "active" > < strong aria-hidden = "true" > 5.2.< / strong > Adding textobject queries< / a > < / li > < li class = "chapter-item expanded " > < a href = "../guides/indent.html" > < strong aria-hidden = "true" > 5.3.< / strong > Adding indent queries< / a > < / li > < / ol > < / li > < / ol >
2021-10-23 06:41:37 +04:00
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2023-03-31 10:23:23 +04:00
< div id = "menu-bar-hover-placeholder" > < / div >
2021-10-23 06:41:37 +04:00
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "colibri" > Colibri (default)< / button > < / li >
< / ul >
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > < / h1 >
< div class = "right-buttons" >
< a href = "../print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2023-03-31 10:23:23 +04:00
< a href = "https://github.com/helix-editor/helix" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
2021-10-23 06:41:37 +04:00
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2023-03-31 10:23:23 +04:00
< h1 id = "adding-textobject-queries" > < a class = "header" href = "#adding-textobject-queries" > Adding textobject queries< / a > < / h1 >
< p > Helix supports textobjects that are language specific, such as functions, classes, etc.
These textobjects require an accompanying tree-sitter grammar and a < code > textobjects.scm< / code > query file
2021-10-23 06:41:37 +04:00
to work properly. Tree-sitter allows us to query the source code syntax tree
and capture specific parts of it. The queries are written in a lisp dialect.
2021-11-08 04:53:05 +04:00
More information on how to write queries can be found in the < a href = "https://tree-sitter.github.io/tree-sitter/using-parsers#query-syntax" > official tree-sitter
2021-10-23 06:41:37 +04:00
documentation< / a > .< / p >
< p > Query files should be placed in < code > runtime/queries/{language}/textobjects.scm< / code >
2023-03-31 10:23:23 +04:00
when contributing to Helix. Note that to test the query files locally you should put
2021-10-23 06:41:37 +04:00
them under your local runtime directory (< code > ~/.config/helix/runtime< / code > on Linux
for example).< / p >
< p > The following < a href = "https://tree-sitter.github.io/tree-sitter/using-parsers#capturing-nodes" > captures< / a > are recognized:< / p >
2022-08-31 21:05:59 +04:00
< div class = "table-wrapper" > < table > < thead > < tr > < th > Capture Name< / th > < / tr > < / thead > < tbody >
2021-10-23 06:41:37 +04:00
< tr > < td > < code > function.inside< / code > < / td > < / tr >
< tr > < td > < code > function.around< / code > < / td > < / tr >
< tr > < td > < code > class.inside< / code > < / td > < / tr >
< tr > < td > < code > class.around< / code > < / td > < / tr >
2022-08-31 21:05:59 +04:00
< tr > < td > < code > test.inside< / code > < / td > < / tr >
< tr > < td > < code > test.around< / code > < / td > < / tr >
2021-10-23 06:41:37 +04:00
< tr > < td > < code > parameter.inside< / code > < / td > < / tr >
2022-03-06 09:24:36 +04:00
< tr > < td > < code > comment.inside< / code > < / td > < / tr >
< tr > < td > < code > comment.around< / code > < / td > < / tr >
2021-10-23 06:41:37 +04:00
< / tbody > < / table >
2022-08-31 21:05:59 +04:00
< / div >
2021-10-23 06:41:37 +04:00
< p > < a href = "https://github.com/search?q=repo%3Ahelix-editor%2Fhelix+filename%3Atextobjects.scm&type=Code&ref=advsearch&l=&l=" > Example query files< / a > can be found in the helix GitHub repository.< / p >
2023-03-31 10:23:23 +04:00
< h2 id = "queries-for-textobject-based-navigation" > < a class = "header" href = "#queries-for-textobject-based-navigation" > Queries for textobject based navigation< / a > < / h2 >
< p > Tree-sitter based navigation in Helix is done using captures in the
2022-02-15 09:05:05 +04:00
following order:< / p >
< ul >
< li > < code > object.movement< / code > < / li >
< li > < code > object.around< / code > < / li >
< li > < code > object.inside< / code > < / li >
< / ul >
< p > For example if a < code > function.around< / code > capture has been already defined for a language
2023-03-31 10:23:23 +04:00
in its < code > textobjects.scm< / code > file, function navigation should also work automatically.
2022-02-15 09:05:05 +04:00
< code > function.movement< / code > should be defined only if the node captured by < code > function.around< / code >
doesn't make sense in a navigation context.< / p >
2021-10-23 06:41:37 +04:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-11-07 05:31:26 +04:00
< a rel = "prev" href = "../guides/adding_languages.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-10-23 06:41:37 +04:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2023-03-31 10:23:23 +04:00
2022-05-28 18:19:49 +04:00
< a rel = "next" href = "../guides/indent.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-11-07 05:31:26 +04:00
< a rel = "prev" href = "../guides/adding_languages.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-10-23 06:41:37 +04:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2023-03-31 10:23:23 +04:00
2022-05-28 18:19:49 +04:00
< a rel = "next" href = "../guides/indent.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-10-23 06:41:37 +04:00
< / nav >
< / div >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
2023-03-31 10:23:23 +04:00
2021-10-23 06:41:37 +04:00
< / body >
< / html >
