.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    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
.\" ========================================================================
.\"
.IX Title "Class::MethodMaker::OptExt 3"
.TH Class::MethodMaker::OptExt 3 2023-07-25 "perl v5.38.0" "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
Class::MethodMaker::OptExt \- Constants for C::MM's option extension mechanism
.SH SYNOPSIS
.IX Header "SYNOPSIS"
This class is internal to Class::MethodMaker and should not be used by any
clients.  It is \fBnot\fR part of the public API.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class contains the constants used by Class::MethodMaker to determine the
names of its methods dependent upon options invoked.
.SH "CLASS CONSTANTS"
.IX Header "CLASS CONSTANTS"

.SS OPTEXT
.IX Subsection "OPTEXT"
OPTEXT is a map from options that are implemented as method extensions to
the option parameters.
.PP
Parameter keys are:
.IP encode 4
.IX Item "encode"
code number (to allow the option combination to be encoded whilst keeping the
length of the subr name no more than 8 chars).  encode is required for all
opts (for determining method extension), and must be a power of two.
.IP refer 4
.IX Item "refer"
Code for referring to storage (default: '$_[0]\->{$name}').
.IP decl 4
.IX Item "decl"
Code for declaring storage.
.IP postac 4
.IX Item "postac"
Code to execute immediately after any assignment check \-\-\- for example, to
initialize storage if necessary
.IP asgnchk 4
.IX Item "asgnchk"
Code for checking assignments.
.IP defchk 4
.IX Item "defchk"
Code for default checking.
.IP reset 4
.IX Item "reset"
Code to execute when resetting an element
.IP read 4
.IX Item "read"
Code to execute each time an value is read
.IP store 4
.IX Item "store"
Code to execute each time a value is stored
.SH "CLASS COMPONENTS"
.IX Header "CLASS COMPONENTS"

.SH "CLASS HIGHER-LEVEL FUNCTIONS"
.IX Header "CLASS HIGHER-LEVEL FUNCTIONS"

.SS encode
.IX Subsection "encode"
Take a set of options, return a two-letter code being the extension to add to
the method to incorporate the extensions, and a list (arrayref) of the
extensions represented.
.IP SYNOPSIS 4
.IX Item "SYNOPSIS"
.Vb 2
\&  my ($ext, $opt) =
\&    Class::MethodMaker::OptExt\->encode([qw( static type foobar )]);
.Ve
.IP ARGUMENTS 4
.IX Item "ARGUMENTS"
.RS 4
.PD 0
.IP options 4
.IX Item "options"
.PD
The options to encode, as an arrayref of option names
.RE
.RS 4
.RE
.IP RETURNS 4
.IX Item "RETURNS"
.RS 4
.PD 0
.IP ext 4
.IX Item "ext"
.PD
A code (string) to append to a methodname to represent the options used.
.IP opts 4
.IX Item "opts"
The options represented by the ext .  This is generally a subset of the of
those provided in options, for not all general options are handled by an
encoded methodname.
.RE
.RS 4
.RE
.SH "CLASS HIGHER-LEVEL PROCEDURES"
.IX Header "CLASS HIGHER-LEVEL PROCEDURES"

.SH "INSTANCE CONSTRUCTION"
.IX Header "INSTANCE CONSTRUCTION"

.SH "INSTANCE COMPONENTS"
.IX Header "INSTANCE COMPONENTS"

.SH "INSTANCE HIGHER-LEVEL FUNCTIONS"
.IX Header "INSTANCE HIGHER-LEVEL FUNCTIONS"

.SH "INSTANCE HIGHER-LEVEL PROCEDURES"
.IX Header "INSTANCE HIGHER-LEVEL PROCEDURES"

.SH EXAMPLES
.IX Header "EXAMPLES"

.SH BUGS
.IX Header "BUGS"

.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
Email the development mailing list \f(CW\*(C`class\-mmaker\-devel@lists.sourceforge.net\*(C'\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Martyn J. Pearce
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2003 Martyn J. Pearce.  This program is free software; you can
redistribute it and/or modify it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"