The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
PPI-0.996
River stage four • 195 direct dependents • 1581 total dependents
58 ++
/ PPI::Token::Symbol

NAME

PPI::Token::Symbol - A token class for symbols of various types

INHERITANCE

  PPI::Token::Word
  isa PPI::Token
      isa PPI::Element

DESCRIPTION

The PPI::Token::Symbol class is used to cover all tokens that represent variables and other things that start with a sigil.

METHODS

This class has sevelal methods beyond what is provided by its PPI::Token and PPI::Element parent classes.

Most are provided to help work out what the object is actually pointing at, rather than what it might appear to be pointing at.

canonical

The canonical method returns a normalized, canonical version of the symbol.

For example, it converts $ ::foo'bar::baz to $main::foo::bar::baz.

This does not fully resolve the symbol, but merely removes syntax variations.

symbol

The symbol method returns the ACTUAL symbol this token refers to.

A token of $foo might actually be refering to @foo, if it is found in the form $foo[1].

This method attempts to resolve these issues to determine the actual symbol.

Returns the symbol as a string.

raw_type

The raw_type method returns the apparent type of the symbol in the form of it's sigil.

Returns the sigil as a string.

symbol_type

The symbol_type method returns the actual type of the symbol in the form of it's sigil.

Returns the sigil as a string.

SUPPORT

See the support section in the main module

AUTHOR

Adam Kennedy, http://ali.as/, cpan@ali.as

COPYRIGHT

Copyright (c) 2004 - 2005 Adam Kennedy. All rights reserved.

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

The full text of the license can be found in the LICENSE file included with this module.