From b14d3653c5b31042e5e8a3b12885b1e19ca2eaa4 Mon Sep 17 00:00:00 2001 From: xcb-xwii Date: Wed, 11 Oct 2023 18:58:58 +0000 Subject: [PATCH] deploy: 7cbcb4ed1dce2f8a6938a66fd66f8d5608e6798b --- classes/Language.html | 6 +- classes/Node.html | 6 +- classes/Parser.html | 6 +- classes/Point.html | 6 +- classes/Query.html | 133 ++++++++++++++++++++ classes/QueryCapture.html | 220 +++++++++++++++++++++++++++++++++ classes/QueryCursor.html | 254 ++++++++++++++++++++++++++++++++++++++ classes/QueryMatch.html | 206 +++++++++++++++++++++++++++++++ classes/Range.html | 6 +- classes/RangeArray.html | 6 +- classes/Tree.html | 6 +- index.html | 22 +++- modules/tree_sitter.html | 6 +- 13 files changed, 874 insertions(+), 9 deletions(-) create mode 100644 classes/Query.html create mode 100644 classes/QueryCapture.html create mode 100644 classes/QueryCursor.html create mode 100644 classes/QueryMatch.html diff --git a/classes/Language.html b/classes/Language.html index e1c04a4..fa81ed2 100644 --- a/classes/Language.html +++ b/classes/Language.html @@ -45,6 +45,10 @@

Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -189,7 +193,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/Node.html b/classes/Node.html index f9dc978..4c6191a 100644 --- a/classes/Node.html +++ b/classes/Node.html @@ -44,6 +44,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -1020,7 +1024,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/Parser.html b/classes/Parser.html index ed5c52a..7a5e496 100644 --- a/classes/Parser.html +++ b/classes/Parser.html @@ -44,6 +44,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -261,7 +265,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/Point.html b/classes/Point.html index 68f50c2..e77112e 100644 --- a/classes/Point.html +++ b/classes/Point.html @@ -45,6 +45,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -363,7 +367,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/Query.html b/classes/Query.html new file mode 100644 index 0000000..7a8d5ae --- /dev/null +++ b/classes/Query.html @@ -0,0 +1,133 @@ + + + + + lua-tree-sitter Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Class Query

    +

    A query that can be ran on Nodes of a given Language.

    +

    Analogous to TSQuery.

    + + +

    Functions

    + + + + + +
    Query.new (lang, source)Create a new query for a given Language from a source string.
    + +
    +
    + + +

    Functions

    + +
    +
    + + Query.new (lang, source) +
    +
    + Create a new query for a given Language from a source string. + + +

    Parameters:

    + + +

    Returns:

    +
      + + Query + + + +
    + +

    Raises:

    + Invalid pattern in the source. + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.5.0 +Last updated 2023-10-11 18:58:57 +
    +
    + + diff --git a/classes/QueryCapture.html b/classes/QueryCapture.html new file mode 100644 index 0000000..4d8fdfb --- /dev/null +++ b/classes/QueryCapture.html @@ -0,0 +1,220 @@ + + + + + lua-tree-sitter Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Class QueryCapture

    +

    A capture of a Query.

    +

    Analogous to TSQueryCapture.

    + + +

    Methods

    + + + + + + + + + + + + + + + + + + + + + +
    QueryCapture:node ()Get the Node of the capture.
    QueryCapture:index ()Get the index of the capture.
    QueryCapture:match ()Get the QueryMatch the capture belongs to.
    QueryCapture:query ()Get the Query the capture belongs to.
    QueryCapture:name ()Get the name of the capture.
    + +
    +
    + + +

    Methods

    + +
    +
    + + QueryCapture:node () +
    +
    + Get the Node of the capture. + + + +

    Returns:

    +
      + + Node + + + +
    + + + + +
    +
    + + QueryCapture:index () +
    +
    + Get the index of the capture. + + + +

    Returns:

    +
      + + integer + + + +
    + + + + +
    +
    + + QueryCapture:match () +
    +
    + Get the QueryMatch the capture belongs to. + + + +

    Returns:

    +
      + + QueryMatch + + + +
    + + + + +
    +
    + + QueryCapture:query () +
    +
    + Get the Query the capture belongs to. + + + +

    Returns:

    +
      + + Query + + + +
    + + + + +
    +
    + + QueryCapture:name () +
    +
    + Get the name of the capture. + + + +

    Returns:

    +
      + + Node + + + +
    + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.5.0 +Last updated 2023-10-11 18:58:57 +
    +
    + + diff --git a/classes/QueryCursor.html b/classes/QueryCursor.html new file mode 100644 index 0000000..f04fe17 --- /dev/null +++ b/classes/QueryCursor.html @@ -0,0 +1,254 @@ + + + + + lua-tree-sitter Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Class QueryCursor

    +

    A cursor for executing a given Query.

    +

    Analogous to TSQueryCursor.

    + + +

    Functions

    + + + + + +
    QueryCursor.new (query, node)Create a new cursor for executing a given Query on a given Node.
    +

    Methods

    + + + + + + + + + + + + + + + + + +
    QueryCursor:query ()Get the Query the cursor is executing.
    QueryCursor:set_point_range (start_point, end_point)Set the range of Points in which the Query will be executed.
    QueryCursor:next_match ()Advance to and get the next match.
    QueryCursor:next_capture ()Advance to and get the next capture.
    + +
    +
    + + +

    Functions

    + +
    +
    + + QueryCursor.new (query, node) +
    +
    + Create a new cursor for executing a given Query on a given Node. + + +

    Parameters:

    +
      +
    • query + Query + + + +
      • +
    • node + Node + + + +
      • +
    + +

    Returns:

    +
      + + QueryCursor + + + +
    + + + + +
    +
    +

    Methods

    + +
    +
    + + QueryCursor:query () +
    +
    + Get the Query the cursor is executing. + + + +

    Returns:

    +
      + + Query + + + +
    + + + + +
    +
    + + QueryCursor:set_point_range (start_point, end_point) +
    +
    + Set the range of Points in which the Query will be executed. + + +

    Parameters:

    +
      +
    • start_point + Point + + + +
      • +
    • end_point + Point + + + +
      • +
    + + + + + +
    +
    + + QueryCursor:next_match () +
    +
    + Advance to and get the next match.

    + +

    This method may return nil if there are no more matches. + + + +

    Returns:

    +
      + + QueryMatch or nil + + + +
    + + + + +
    +
    + + QueryCursor:next_capture () +
    +
    + Advance to and get the next capture.

    + +

    This method may return nil if there are no more captures. + + + +

    Returns:

    +
      + + QueryCapture or nil + + + +
    + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.5.0 +Last updated 2023-10-11 18:58:57 +
    +
    + + diff --git a/classes/QueryMatch.html b/classes/QueryMatch.html new file mode 100644 index 0000000..0aa24ae --- /dev/null +++ b/classes/QueryMatch.html @@ -0,0 +1,206 @@ + + + + + lua-tree-sitter Reference + + + + +
    + +
    + +
    +
    +
    + + +
    + + + + + + +
    + +

    Class QueryMatch

    +

    A match of a Query.

    +

    Analogous to TSQueryMatch.

    + + +

    Methods

    + + + + + + + + + + + + + + + + + +
    QueryMatch:pattern_index ()Get the pattern index of the match.
    QueryCursor:capture_count ()Get the number of QueryCaptures in the match.
    QueryCursor:capture_at (index)Get the QueryCapture at a given index.
    QueryMatch:query ()Get the Query to which the match belongs.
    + +
    +
    + + +

    Methods

    + +
    +
    + + QueryMatch:pattern_index () +
    +
    + Get the pattern index of the match. + + + +

    Returns:

    +
      + + integer + + + +
    + + + + +
    +
    + + QueryCursor:capture_count () +
    +
    + Get the number of QueryCaptures in the match. + + + +

    Returns:

    +
      + + integer + + + +
    + + + + +
    +
    + + QueryCursor:capture_at (index) +
    +
    + Get the QueryCapture at a given index. + + +

    Parameters:

    +
      +
    • index + integer + + + +
      • +
    + +

    Returns:

    +
      + + QueryCapture + + + +
    + +

    Raises:

    + Indexing a negative index.
    + Indexing beyond last element. + + + +
    +
    + + QueryMatch:query () +
    +
    + Get the Query to which the match belongs. + + + +

    Returns:

    +
      + + Query + + + +
    + + + + +
    +
    + + +
    +
    +
    +generated by LDoc 1.5.0 +Last updated 2023-10-11 18:58:57 +
    +
    + + diff --git a/classes/Range.html b/classes/Range.html index 4b6ce02..0b743bb 100644 --- a/classes/Range.html +++ b/classes/Range.html @@ -45,6 +45,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -375,7 +379,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/RangeArray.html b/classes/RangeArray.html index 90e05cd..2bb1f9b 100644 --- a/classes/RangeArray.html +++ b/classes/RangeArray.html @@ -45,6 +45,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -435,7 +439,7 @@

    Returns:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/classes/Tree.html b/classes/Tree.html index bf91409..24c0ae8 100644 --- a/classes/Tree.html +++ b/classes/Tree.html @@ -44,6 +44,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -301,7 +305,7 @@

    See also:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/index.html b/index.html index 08917af..bb088ef 100644 --- a/index.html +++ b/index.html @@ -40,6 +40,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -77,6 +81,22 @@

    Classes

    Point A point on a document. + + Query + A query that can be ran on Nodes of a given Language. + + + QueryCapture + A capture of a Query. + + + QueryCursor + A cursor for executing a given Query. + + + QueryMatch + A match of a Query. + Range A range within a document. @@ -95,7 +115,7 @@

    Classes

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57
    diff --git a/modules/tree_sitter.html b/modules/tree_sitter.html index 5ae32bb..8861e7e 100644 --- a/modules/tree_sitter.html +++ b/modules/tree_sitter.html @@ -43,6 +43,10 @@

    Classes

  • Node
  • Parser
  • Point
    • +
  • Query
    • +
  • QueryCapture
    • +
  • QueryCursor
    • +
  • QueryMatch
  • Range
  • RangeArray
  • Tree
    • @@ -75,7 +79,7 @@

    Usage:

    generated by LDoc 1.5.0 -Last updated 2023-10-11 18:06:08 +Last updated 2023-10-11 18:58:57