/
Lua.pm
197 lines (136 loc) · 4.04 KB
/
Lua.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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
package Doxygen::Lua;
use warnings;
use strict;
=head1 NAME
Doxygen::Lua - Make Doxygen support Lua
=head1 VERSION
Version 0.04
=cut
our $VERSION = '0.04';
=head1 SYNOPSIS
use Doxygen::Lua;
my $p = Doxygen::Lua->new;
print $p->parse($input);
=head1 DESCRIPTION
A script named "lua2dox" will be installed. Then modify your Doxyfile as below:
FILTER_PATTERNS = *.lua=../bin/lua2dox
That's all!
=head1 SUBROUTINES/METHODS
=head2 new
This function will create a Doxygen::Lua object.
=cut
sub new {
my ($class, %args) = @_;
my $self = bless \%args, $class;
$self->_init;
return $self;
}
sub _init {
my $self = shift;
$self->{mark} = '--!';
}
=head2 parse
This function will parse the given input file and return the result.
=cut
sub parse {
my $self = shift;
my $input = shift;
my $in_block = 0;
my $in_function = 0;
my $block_name = q{};
my $result = q{};
my $mark = $self->mark;
open FH, "<$input"
or die "Can't open $input for reading: $!";
foreach my $line (<FH>) {
chomp $line;
# include empty lines
if ($line =~ m{^\s*$}) {
$result .= "\n"
}
# skip normal comments
next if $line =~ /^\s*--[^!]/;
# remove end of line comments
$line =~ s/--[^!].*//;
# skip comparison
next if $line =~ /==/;
# translate to doxygen mark
$line =~ s{$mark}{///};
if ($line =~ m{^\s*///}) {
$result .= "$line\n";
}
# function start
elsif ($line =~ /^function/) {
$in_function = 1;
$line .= q{;};
$line =~ s/:/-/;
$result .= "$line\n";
}
#local function start
elsif ($line =~ /^local.+function/) {
$in_function = 1;
$line .= q{;};
$line =~ s/function\s+/function-/;
$result .= "$line\n";
}
# function end
elsif ($in_function == 1 && $line =~ /^end/) {
$in_function = 0;
}
# block start
elsif ($in_function == 0 && $line =~ /^(\S+)\s*=\s*{/ && $line !~ /}/) {
$block_name = $1;
$in_block = 1;
}
# block end
elsif ($in_function == 0 && $line =~ /^\s*}/ && $in_block == 1) {
$block_name = q{};
$in_block = 0;
}
# variables
elsif ($in_function == 0 && $line =~ /=/) {
$line =~ s/(?=\S)/$block_name./ if $block_name;
$line =~ s{,?(\s*)(?=///|$)}{;$1};
$result .= "$line\n";
}
}
close FH;
return $result;
}
=head2 mark
This function will set the mark style. The default value is "--!".
=cut
sub mark {
my ($self, $value) = @_;
$self->{mark} = $value if $value;
return $self->{mark};
}
=head1 AUTHOR
Alec Chen, C<< <alec at cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-doxygen-lua at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Doxygen-Lua>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Doxygen::Lua
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Doxygen-Lua>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Doxygen-Lua>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Doxygen-Lua>
=item * Search CPAN
L<http://search.cpan.org/dist/Doxygen-Lua/>
=back
=head1 ACKNOWLEDGEMENTS
=head1 REPOSITORY
See http://github.com/alecchen/doxygen-lua
=head1 LICENSE AND COPYRIGHT
Copyright 2010 Alec Chen.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut
1; # End of Doxygen::Lua