The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

PEVANS / Text-Treesitter-0.13 / lib / Text / Treesitter / Parser.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
—
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
—
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
—
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

              
#  You may distribute under the terms of either the GNU General Public License
#  or the Artistic License (the same terms as Perl itself)
#
#  (C) Paul Evans, 2023 -- leonerd@leonerd.org.uk
package Text::Treesitter::Parser 0.13;
use v5.14;
use warnings;
require Text::Treesitter::_XS;
use File::Slurper qw( read_text );
=head1 NAME
C<Text::Treesitter::Parser> - parse some input text according to a F<tree-sitter> grammar
=head1 SYNOPSIS
Usually accessed indirectly, via C<Text::Treesitter>. Can also be used
directly.
   use Text::Treesitter::Language;
   use Text::Treesitter::Parser;
   my $language_lib = "path/to/the/tree-sitter-perl.so";
   my $lang = Text::Treesitter::Language::load( $language_lib, "perl" );
   my $parser = Text::Treesitter::Parser->new;
   $parser->set_language( $lang );
   my $tree = $parser->parse_string( $input );
   ...
=head1 DESCRIPTION
Instances of this class perform the actual parsing operation, taking a language
specification (in the form of a L<Text::Treesitter::Language> instance) and the
input text string, yielding a result (in the form of a
L<Text::Treesitter::Tree> instance).
=cut
=head1 CONSTRUCTOR
=head2 new
   $parser = Text::Treesitter::Parser->new;
Returns a new parser instance. A language must be set (by calling
L</set_language>) before parsing can be performed.
=cut
=head1 METHODS
=head2 set_language
   $parser->set_language( $lang );
Sets the language specification, as specified by an instance of
L<Text::Treesitter::Language>.
=head2 parse_string
   $tree = $parser->parse_string( $str );
Parses a given input string, returning a node tree as an instance of
L<Text::Treesitter::Tree>.
=cut
sub parse_string
{
   my $self = shift;
   my ( $str ) = @_;
   require Text::Treesitter::Tree;
   return Text::Treesitter::Tree->new(
      tree => $self->_parse_string( $str ),
      text => $str,
   );
}
=head2 parse_file
   $tree = $parser->parse_file( $path );
I<Since version 0.13.>
Reads the file content as a string, then applies L</parse_string> on it.
=cut
sub parse_file
{
   my $self = shift;
   my ( $path ) = @_;
   return $self->parse_string( read_text( $path ) );
}
=head2 reset
   $parser->reset;
Resets the internal state of the parser so it can be used again.
=cut
=head1 TODO
The following C library functions are currently unhandled:
   ts_parser_included_ranges
   ts_parser_parse
   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
=cut
=head1 AUTHOR
Paul Evans <leonerd@leonerd.org.uk>
=cut
0x55AA;