Debian Codegraph @

upstream/mageia-cauldron/man3pm/base.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "base 3pm"
61 .TH base 3pm 2023-12-22 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 base \- Establish an ISA relationship with base classes at compile time
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 2
71 \& package Baz;
72 \& use base qw(Foo Bar);
73 .Ve
74 .SH DESCRIPTION
75 .IX Header "DESCRIPTION"
76 Unless you are using the \f(CW\*(C`fields\*(C'\fR pragma, consider this module discouraged
77 in favor of the lighter\-weight \f(CW\*(C`parent\*(C'\fR.
78 .PP
79 Allows you to both load one or more modules, while setting up inheritance from
80 those modules at the same time. Roughly similar in effect to
81 .PP
82 .Vb 6
83 \& package Baz;
84 \& BEGIN {
85 \& require Foo;
86 \& require Bar;
87 \& push @ISA, qw(Foo Bar);
88 \& }
89 .Ve
90 .PP
91 When \f(CW\*(C`base\*(C'\fR tries to \f(CW\*(C`require\*(C'\fR a module, it will not die if it cannot find
92 the module\*(Aqs file, but will die on any other error. After all this, should
93 your base class be empty, containing no symbols, \f(CW\*(C`base\*(C'\fR will die. This is
94 useful for inheriting from classes in the same file as yourself but where
95 the filename does not match the base module name, like so:
96 .PP
97 .Vb 3
98 \& # in Bar.pm
99 \& package Foo;
100 \& sub exclaim { "I can have such a thing?!" }
101 \&
102 \& package Bar;
103 \& use base "Foo";
104 .Ve
105 .PP
106 There is no \fIFoo.pm\fR, but because \f(CW\*(C`Foo\*(C'\fR defines a symbol (the \f(CW\*(C`exclaim\*(C'\fR
107 subroutine), \f(CW\*(C`base\*(C'\fR will not die when the \f(CW\*(C`require\*(C'\fR fails to load \fIFoo.pm\fR.
108 .PP
109 \&\f(CW\*(C`base\*(C'\fR will also initialize the fields if one of the base classes has it.
110 Multiple inheritance of fields is \fBNOT\fR supported, if two or more base classes
111 each have inheritable fields the \*(Aqbase\*(Aq pragma will croak. See fields
112 for a description of this feature.
113 .PP
114 The base class\*(Aq \f(CW\*(C`import\*(C'\fR method is \fBnot\fR called.
115 .SH DIAGNOSTICS
116 .IX Header "DIAGNOSTICS"
117 .IP "Base class package ""%s"" is empty." 4
118 .IX Item "Base class package ""%s"" is empty."
119 base.pm was unable to require the base package, because it was not
120 found in your path.
121 .IP "Class \*(AqFoo\*(Aq tried to inherit from itself" 4
122 .IX Item "Class 'Foo' tried to inherit from itself"
123 Attempting to inherit from yourself generates a warning.
124 .Sp
125 .Vb 2
126 \& package Foo;
127 \& use base \*(AqFoo\*(Aq;
128 .Ve
129 .SH HISTORY
130 .IX Header "HISTORY"
131 This module was introduced with Perl 5.004_04.
132 .SH CAVEATS
133 .IX Header "CAVEATS"
134 Due to the limitations of the implementation, you must use
135 base \fIbefore\fR you declare any of your own fields.
136 .SH "SEE ALSO"
137 .IX Header "SEE ALSO"
138 fields