.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "HTML::Mason::ComponentSource 3pm"
.TH HTML::Mason::ComponentSource 3pm "2014-01-19" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
HTML::Mason::ComponentSource \- represents information about an component
.SH "VERSION"
.IX Header "VERSION"
version 1.54
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    my $info = $resolver\->get_info($comp_path);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Mason uses the ComponentSource class to store information about a
source component, one that has yet to be compiled.
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
This method takes the following arguments:
.RS 4
.IP "\(bu" 4
comp_path
.Sp
The component's component path.
.IP "\(bu" 4
last_modified
.Sp
This is the last modificatoin time for the component, in Unix time
(seconds since the epoch).
.IP "\(bu" 4
comp_id
.Sp
This is a unique id for the component used to distinguish two
components with the same name in different component roots.
.Sp
If your resolver does not support multiple component roots, this can
simply be the same as the \*(L"comp_path\*(R" key or it can be any other id
you wish.
.Sp
This value will be used when constructing filesystem paths so it needs
to be something that works on different filesystems.  If it contains
forward slashes, these will be converted to the appropriate
filesystem-specific path separator.
.Sp
In fact, we encourage you to make sure that your component ids have
some forward slashes in them or also \fBall\fR of your generated object
files will end up in a single directory, which could affect
performance.
.IP "\(bu" 4
comp_class
.Sp
The component class into which this particular component should be
blessed when it is created.  This must be a subclass of
\&\f(CW\*(C`HTML::Mason::Component\*(C'\fR, which is the default.
.IP "\(bu" 4
friendly_name
.Sp
This is used when displaying error messages related to the component,
like parsing errors.  This should be something that will help whoever
sees the message identify the component.  For example, for component
stored on the filesystem, this should be the absolute path to the
component.
.IP "\(bu" 4
source_callback
.Sp
This is a subroutine reference which, when called, returns the
component source.
.Sp
The reasoning behind using this parameter is that it helps avoid a
profusion of tiny little \f(CW\*(C`HTML::Mason::ComponentSource\*(C'\fR subclasses that
don't do very much.
.IP "\(bu" 4
extra
.Sp
This optional parameter should be a hash reference.  It is used to
pass information from the resolver to the component class.
.Sp
This is needed since a
\&\f(CW\*(C`HTML::Mason::Resolver\*(C'\fR subclass and a
\&\f(CW\*(C`HTML::Mason::Component\*(C'\fR subclass can be
rather tightly coupled, but they must communicate with each through
the interpreter (this may change in the future).
.RE
.RS 4
.RE
.IP "comp_path" 4
.IX Item "comp_path"
.PD 0
.IP "last_modified" 4
.IX Item "last_modified"
.IP "comp_id" 4
.IX Item "comp_id"
.IP "comp_class" 4
.IX Item "comp_class"
.IP "friendly_name" 4
.IX Item "friendly_name"
.IP "extra" 4
.IX Item "extra"
.PD
These are all simple accessors that return the value given to the
constructor.
.IP "comp_source" 4
.IX Item "comp_source"
Returns the source of the component.
.ie n .IP "object_code ( compiler => $compiler )" 4
.el .IP "object_code ( compiler => \f(CW$compiler\fR )" 4
.IX Item "object_code ( compiler => $compiler )"
Given a compiler, this method returns the object code for the
component.
.PP
HTML::Mason,
HTML::Mason::Admin,
HTML::Mason::Component
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Mason
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Jonathan Swartz <swartz@pobox.com>
.IP "\(bu" 4
Dave Rolsky <autarch@urth.org>
.IP "\(bu" 4
Ken Williams <ken@mathforum.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2012 by Jonathan Swartz.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.