.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 >0, 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 "Object::Pad::MOP::Class 3pm"
.TH Object::Pad::MOP::Class 3pm "2021-02-20" "perl v5.32.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"
"Object::Pad::MOP::Class" \- meta\-object representation of a "Object::Pad" class
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Instances of this class represent a class or role implemented by
Object::Pad. Accessors provide information about the class or role, and
methods that can alter the class, typically by adding new elements to it, 
allow a program to extend existing classes.
.PP
Where possible, this \s-1API\s0 is designed to be compatible with MOP::Class.
.PP
This \s-1API\s0 should be considered experimental even within the overall context in
which \f(CW\*(C`Object::Pad\*(C'\fR is expermental.
.SH "METHODS"
.IX Header "METHODS"
.SS "is_class"
.IX Subsection "is_class"
.SS "is_role"
.IX Subsection "is_role"
.Vb 2
\&   $bool = $metaclass\->is_class
\&   $bool = $metaclass\->is_role
.Ve
.PP
Exactly one of these methods will return true, depending on whether this
metaclass instance represents a true \f(CW\*(C`class\*(C'\fR, or a \f(CW\*(C`role\*(C'\fR.
.SS "name"
.IX Subsection "name"
.Vb 1
\&   $name = $metaclass\->name
.Ve
.PP
Returns the name of the class, as a plain string.
.SS "superclasses"
.IX Subsection "superclasses"
.Vb 1
\&   @classes = $metaclass\->superclasses
.Ve
.PP
Returns a list of superclasses, as Object::Pad::MOP::Class instances.
.PP
Because \f(CW\*(C`Object::Pad\*(C'\fR does not support multiple superclasses, this list will
contain at most one item.
.SS "roles"
.IX Subsection "roles"
.Vb 1
\&   @roles = $metaclass\->roles
.Ve
.PP
Returns a list of roles implemented by this class, as
Object::Pad::MOP::Class instances.
.SS "compose_role"
.IX Subsection "compose_role"
.Vb 2
\&   $metaclass\->compose_role( $rolename )
\&   $metaclass\->compose_role( $rolemeta )
.Ve
.PP
Adds a new role to the list of those implemented by the class.
.PP
The new role can be specified either as a plain string giving its name, or as
an \f(CW\*(C`Object::Pad::MOP::Class\*(C'\fR meta instance directly.
.SS "add_BUILD"
.IX Subsection "add_BUILD"
.Vb 1
\&   $metaclass\->add_BUILD( $code )
.Ve
.PP
Adds a new \f(CW\*(C`BUILD\*(C'\fR block to the class, as a \s-1CODE\s0 reference.
.SS "add_method"
.IX Subsection "add_method"
.Vb 1
\&   $metamethod = $metaclass\->add_method( $name, $code )
.Ve
.PP
Adds a new named method to the class under the given name, as \s-1CODE\s0 reference.
.PP
Returns an instance of Object::Pad::MOP::Method to represent it.
.SS "get_own_method"
.IX Subsection "get_own_method"
.Vb 1
\&   $metamethod = $metaclass\->get_own_method( $name )
.Ve
.PP
Returns an instance of Object::Pad::MOP::Slot to represent the method of
the given name, if one exists. If not an exception is thrown.
.PP
This can only see directly-applied methods; that is, methods created by the
\&\f(CW\*(C`method\*(C'\fR keyword on the class itself, or added via \*(L"add_method\*(R". This will
not see other names in the package stash, even if they contain a \f(CW\*(C`CODE\*(C'\fR slot,
nor will it see methods inherited from a superclass.
.SS "add_slot"
.IX Subsection "add_slot"
.Vb 1
\&   $metaslot = $metaclass\->add_slot( $name )
.Ve
.PP
Adds a new slot to the class, using the given name (which must begin with the
sigil character \f(CW\*(C`$\*(C'\fR, \f(CW\*(C`@\*(C'\fR or \f(CW\*(C`%\*(C'\fR).
.PP
Returns an instance of Object::Pad::MOP::Slot to represent it.
.SS "get_slot"
.IX Subsection "get_slot"
.Vb 1
\&   $metaslot = $metaclass\->get_slot( $name )
.Ve
.PP
Returns an instance of Object::Pad::MOP::Slot to represent the slot of the
given name, if one exists. If not an exception is thrown.
.SH "AUTHOR"
.IX Header "AUTHOR"
Paul Evans <leonerd@leonerd.org.uk>