local-lib5/man/man3/Class::Inspector::Functions.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Class::Inspector::Functions 3"
 132 .TH Class::Inspector::Functions 3 "2009-04-20" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Class::Inspector::Functions \- Get information about a class and its structure
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 3
 138 \&  use Class::Inspector::Functions;
 139 \&  # Class::Inspector provides a non\-polluting,
 140 \&  # method based interface!
 141 .Ve
 142 .PP
 143 .Vb 3
 144 \&  # Is a class installed and/or loaded
 145 \&  installed( 'Foo::Class' );
 146 \&  loaded( 'Foo::Class' );
 147 .Ve
 148 .PP
 149 .Vb 3
 150 \&  # Filename related information
 151 \&  filename( 'Foo::Class' );
 152 \&  resolved_filename( 'Foo::Class' );
 153 .Ve
 154 .PP
 155 .Vb 5
 156 \&  # Get subroutine related information
 157 \&  functions( 'Foo::Class' );
 158 \&  function_refs( 'Foo::Class' );
 159 \&  function_exists( 'Foo::Class', 'bar' );
 160 \&  methods( 'Foo::Class', 'full', 'public' );
 161 .Ve
 162 .PP
 163 .Vb 2
 164 \&  # Find all loaded subclasses or something
 165 \&  subclasses( 'Foo::Class' );
 166 .Ve
 167 .SH "DESCRIPTION"
 168 .IX Header "DESCRIPTION"
 169 Class::Inspector::Functions is a function based interface of
 170 Class::Inspector. For a thorough documentation of the available
 171 functions, please check the manual for the main module.
 172 .Sh "Exports"
 173 .IX Subsection "Exports"
 174 The following functions are exported by default.
 175 .PP
 176 .Vb 6
 177 \&  installed
 178 \&  loaded
 179 \&  filename
 180 \&  functions
 181 \&  methods
 182 \&  subclasses
 183 .Ve
 184 .PP
 185 The following functions are exported only by request.
 186 .PP
 187 .Vb 4
 188 \&  resolved_filename
 189 \&  loaded_filename
 190 \&  function_refs
 191 \&  function_exists
 192 .Ve
 193 .PP
 194 All the functions may be imported using the \f(CW\*(C`:ALL\*(C'\fR tag.
 195 .SH "SUPPORT"
 196 .IX Header "SUPPORT"
 197 Bugs should be reported via the \s-1CPAN\s0 bug tracker
 198 .PP
 199 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Class\-Inspector>
 200 .PP
 201 For other issues, or commercial enhancement or support, contact the author.
 202 .SH "AUTHOR"
 203 .IX Header "AUTHOR"
 204 Adam Kennedy <adamk@cpan.org>
 205 .PP
 206 Steffen Mueller <smueller@cpan.org>
 207 .SH "SEE ALSO"
 208 .IX Header "SEE ALSO"
 209 <http://ali.as/>, Class::Handle
 210 .SH "COPYRIGHT"
 211 .IX Header "COPYRIGHT"
 212 Copyright 2002 \- 2009 Adam Kennedy.
 213 .PP
 214 Class::Inspector::Functions copyright 2008 \- 2009 Steffen Mueller.
 215 .PP
 216 This program is free software; you can redistribute
 217 it and/or modify it under the same terms as Perl itself.
 218 .PP
 219 The full text of the license can be found in the
 220 \&\s-1LICENSE\s0 file included with this module.