Debian Codegraph @

upstream/debian-unstable/man3/base.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (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 .\"
57 .IX Title "base 3perl"
58 .TH base 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 base \- Establish an ISA relationship with base classes at compile time
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& package Baz;
69 \& use base qw(Foo Bar);
70 .Ve
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 Unless you are using the \f(CW\*(C`fields\*(C'\fR pragma, consider this module discouraged
74 in favor of the lighter-weight \f(CW\*(C`parent\*(C'\fR.
75 .PP
76 Allows you to both load one or more modules, while setting up inheritance from
77 those modules at the same time. Roughly similar in effect to
78 .PP
79 .Vb 6
80 \& package Baz;
81 \& BEGIN {
82 \& require Foo;
83 \& require Bar;
84 \& push @ISA, qw(Foo Bar);
85 \& }
86 .Ve
87 .PP
88 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
89 the module's file, but will die on any other error. After all this, should
90 your base class be empty, containing no symbols, \f(CW\*(C`base\*(C'\fR will die. This is
91 useful for inheriting from classes in the same file as yourself but where
92 the filename does not match the base module name, like so:
93 .PP
94 .Vb 3
95 \& # in Bar.pm
96 \& package Foo;
97 \& sub exclaim { "I can have such a thing?!" }
98 \&
99 \& package Bar;
100 \& use base "Foo";
101 .Ve
102 .PP
103 There is no \fIFoo.pm\fR, but because \f(CW\*(C`Foo\*(C'\fR defines a symbol (the \f(CW\*(C`exclaim\*(C'\fR
104 subroutine), \f(CW\*(C`base\*(C'\fR will not die when the \f(CW\*(C`require\*(C'\fR fails to load \fIFoo.pm\fR.
105 .PP
106 \&\f(CW\*(C`base\*(C'\fR will also initialize the fields if one of the base classes has it.
107 Multiple inheritance of fields is \fBNOT\fR supported, if two or more base classes
108 each have inheritable fields the 'base' pragma will croak. See fields
109 for a description of this feature.
110 .PP
111 The base class' \f(CW\*(C`import\*(C'\fR method is \fBnot\fR called.
112 .SH DIAGNOSTICS
113 .IX Header "DIAGNOSTICS"
114 .IP "Base class package ""%s"" is empty." 4
115 .IX Item "Base class package ""%s"" is empty."
116 base.pm was unable to require the base package, because it was not
117 found in your path.
118 .IP "Class 'Foo' tried to inherit from itself" 4
119 .IX Item "Class 'Foo' tried to inherit from itself"
120 Attempting to inherit from yourself generates a warning.
121 .Sp
122 .Vb 2
123 \& package Foo;
124 \& use base \*(AqFoo\*(Aq;
125 .Ve
126 .SH HISTORY
127 .IX Header "HISTORY"
128 This module was introduced with Perl 5.004_04.
129 .SH CAVEATS
130 .IX Header "CAVEATS"
131 Due to the limitations of the implementation, you must use
132 base \fIbefore\fR you declare any of your own fields.
133 .SH "SEE ALSO"
134 .IX Header "SEE ALSO"
135 fields