Scroll to navigation

PPIx::EditorTools::Outline(3pm) User Contributed Perl Documentation PPIx::EditorTools::Outline(3pm)

NAME

PPIx::EditorTools::Outline - Collect use pragmata, modules, subroutiones, methods, attributes

VERSION

version 0.21

SYNOPSIS

  my $outline = PPIx::EditorTools::Outline->new->find(
        code => "package TestPackage;\nsub x { 1;\n"
      );
 print Dumper $outline;

DESCRIPTION

Return a list of pragmatas, modules, methods, attributes of a "PPI::Document".

METHODS

  • new()

    Constructor. Generally shouldn't be called with any arguments.

  • find()

            find( ppi => PPI::Document $ppi )
    or
            find( code => Str $code )
        

    Accepts either a "PPI::Document" to process or a string containing the code (which will be converted into a "PPI::Document") to process. Return a reference to a hash.

Internal Methods

  • _Moo_Attributes
  • _Moo_PkgName

SEE ALSO

This class inherits from "PPIx::EditorTools". Also see App::EditorTools, Padre, and PPI.

AUTHORS

  • Steffen Mueller "smueller@cpan.org"
  • Mark Grimes "mgrimes@cpan.org"
  • Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
  • Gabor Szabo <gabor@szabgab.com>
  • Yanick Champoux <yanick@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

2022-06-17 perl v5.34.0