Ⅰ. 插件描述
Ⅱ. 基本信息
|
Ⅲ. 安装方法
使用Vundle管理器安装
在你的.vimrc下添加:Plugin 'osfameron/perl-tags':source %
:PluginInstall对于Vundle版本 < 0.10.2，请用上面的Bundle替换Plugin。
使用NeoBundle管理器安装
在你的.vimrc下添加:NeoBundle 'osfameron/perl-tags':source %
:NeoBundleInstall使用VimPlug管理器安装
在你的.vimrc下添加:Plug 'osfameron/perl-tags':source %
:PlugInstall使用Pathogen管理器安装
在终端中运行以下命令:cd ~/.vim/bundle
git clone https://github.com/osfameron/perl-tagsⅣ. 文档说明
=head1 NAME
Perl::Tags - Generate (possibly exuberant) Ctags style tags for Perl sourcecode
=head1 SYNOPSIS
=head2 Using Perl::Tags to assist your development
C<Perl::Tags> is designed to be integrated into your development
- Here are a few ways to use it:
=head3 With Vim
C<Perl::Tags> was originally designed to be used with vim. See
Lhttps://github.com/osfameron/perl-tags-vim for an easily installable Plugin.
NB: You will need to have a vim with perl compiled in it. Debuntu packages
this as C<vim-perl>. Alternatively you can compile from source (you'll need
Perl + the development headers C<libperl-dev>).
(Note that C<perl-tags-vim> includes its own copy of C<Perl::Tags> through
the magic of git submodules and L<App::FatPacker>, so you don't need to install
this module from CPAN if you are only intending to use it with Vim as above!)
=head3 From the Command Line
See the L<bin/perl-tags> script provided.
=head3 From other editors
Any editor that supports ctags should be able to use this output. Documentation
and code patches on how to do this are welcome.
=head2 Using the Perl::Tags module within your code
use Perl::Tags;
my $naive_tagger = Perl::Tags::Naive->new( max_level=>2 );
$naive_tagger->process(
files => ['Foo.pm', 'bar.pl'],
refresh=>1
);
print $naive_tagger; # stringifies to ctags file
Recursively follows C<use> and C<require> statements, up to a maximum
of C<max_level>.
=head1 DETAILS
There are several taggers distributed with this distribution, including:
=over 4
=item L<Perl::Tags::Naive>
This is a more-or-less straight ripoff, slightly updated, of the original
pltags code. This is a "naive" tagger, in that it makes pragmatic assumptions
about what Perl code usually looks like (e.g. it doesn't actually parse the
code.) This is fast, lightweight, and often Good Enough.
This has additional subclasses such as L<Perl::Tags::Naive::Moose> to parse
Moose declarations, and L<Perl::Tags::Naive::Lib> to parse C<use lib>.
=item L<Perl::Tags::PPI>
Uses the L<PPI> module to do a deeper analysis and parsing of your Perl code.
This is more accurate, but slower.
=item L<Perl::Tags::Hybrid>
Can run multiple taggers, such as ::Naive and ::PPI, combining the results.
=back
=head1 EXTENDING
Documentation patches are welcome: in the meantime, have a look at
L<Perl::Tags::Naive> and its subclasses for a simple line-by-line method of
tagging files. Alternatively L<Perl::Tags::PPI> uses L<PPI>'s built in
method of parsing Perl documents.
In general, you will want to override the C<get_tags_for_file> method,
returning a list of C<Perl::Tags::Tag> objects to be registered.
For recursively checking other modules, return a C<Perl::Tags::Tag::Recurse>
object, which does I<not> create a new tag in the resulting perltags file,
but instead processes the next file recursively.
=head1 FEATURES
* Recursive, incremental tagging.
* parses `use_ok`/`require_ok` line from Test::More
=head1 METHODS
=cut
=head2 C<new>
L<Perl::Tags> is an abstract baseclass. Use a class such as
L<Perl::Tags::Naive> and instantiate it with C<new>.
$naive_tagger = Perl::Tags::Naive->new( max_level=>2 );
Accepts the following parameters
max_level: levels of "use" statements to descend into, default 2
do_variables: tag variables? default 1 (true)
exts: use the Exuberant extensions
=cut
=head2 C<to_string>
A L<Perl::Tags> object will stringify to a textual representation of a ctags
file.
print $tagger;
=cut
=head2 C<clean_file>
Delete all tags, but without touching the "order" seen, that way, if the tags
are recreated, they will remain near the top of the "interestingness" tree
=cut
=head2 C<output>
Save the file to disk if it has changed. (The private C<{is_dirty}> attribute
is used, as the tags object may be made up incrementally and recursively within
your IDE.
=cut
=head2 C<process>
Scan one or more Perl file for tags
$tagger->process(
files => [ 'Module.pm', 'script.pl' ]
);
$tagger->process(
files => 'script.pl',
refresh => 1,
);
=cut
=head2 C<queue>, C<popqueue>
Internal methods managing the processing
=cut
=head2 C<process_item>, C<process_file>, C<get_tags_for_file>
Do the heavy lifting for C<process> above.
Taggers I<must> override the abstract method C<get_tags_for_file>.
=cut
=head2 C<register>
The parsing is done by a number of lightweight objects (parsers) which look for
subroutine references, variables, module inclusion etc. When they are
successful, they call the C<register> method in the main tags object.
Note that if your tagger wants to register not a new I<declaration> but rather
a I<usage> of another module, then your tagger should return a
C<Perl::Tags::Tag::Recurse> object. This is a pseudo-tag which causes the linked
module to be scanned in turn. See L<Perl::Tags::Naive>'s handling of C<use>
statements as an example!
=cut
=head1 SEE ALSO
L<bin/perl-tags>
=head1 CONTRIBUTIONS
Contributions are always welcome. The repo is in git:
http://github.com/osfameron/perl-tags
Please fork and make pull request. Maint bits available on request.
=over 4
=item DMITRI
many patches for features and bugfixes
=item wolverian
::PPI subclass
=item Ian Tegebo
patch to use File::Temp
=item drbean
::Naive::Moose, ::Naive::Spiffy and ::Naive::Lib subclasses
=item Alias
prodding me to make repo public
=item tsee
Command line interface, applying patches
=item nothingmuch
=item Andreas Koenig
=item ether
=back
=head1 AUTHOR and LICENSE
osfameron (2006-2014) - osfameron@cpan.org
and contributors, as above
For support, try emailing me or grabbing me on irc #london.pm on irc.perl.org
This was originally ripped off pltags.pl, as distributed with vim
and available from Lhttp://www.mscha.com/mscha.html?pltags#tools
Version 2.3, 28 February 2002
Written by Michael Schaap <pltags@mscha.com>.
This is licensed under the same terms as Perl itself. (Or as Vim if you prefer).
=cut