summaryrefslogtreecommitdiff
path: root/lib/overload.pm
diff options
context:
space:
mode:
authorBen Morrow <ben@morrow.me.uk>2009-10-27 16:12:36 +0000
committerRafael Garcia-Suarez <rgs@consttype.org>2009-11-01 16:18:04 +0100
commit7cb0cfe6b05b22a9c89198b7133aee5507599e8c (patch)
treea6142ef54022a268cd823693b36acdcf5c8bf385 /lib/overload.pm
parentd4b87e753f3c5c8123aeebb4ae822cef9f2eed3c (diff)
downloadperl-7cb0cfe6b05b22a9c89198b7133aee5507599e8c.tar.gz
Documentation for the 'qr' overload.
Diffstat (limited to 'lib/overload.pm')
-rw-r--r--lib/overload.pm27
1 files changed, 16 insertions, 11 deletions
diff --git a/lib/overload.pm b/lib/overload.pm
index 8960171160..e506a7c2d3 100644
--- a/lib/overload.pm
+++ b/lib/overload.pm
@@ -135,7 +135,7 @@ sub mycan { # Real can would leave stubs.
unary => "neg ! ~",
mutators => '++ --',
func => "atan2 cos sin exp abs log sqrt int",
- conversion => 'bool "" 0+',
+ conversion => 'bool "" 0+ qr',
iterators => '<>',
filetest => "-X",
dereferencing => '${} @{} %{} &{} *{}',
@@ -400,15 +400,20 @@ floating-point-like types one should follow the same semantic. If
C<int> is unavailable, it can be autogenerated using the overloading of
C<0+>.
-=item * I<Boolean, string and numeric conversion>
+=item * I<Boolean, string, numeric and regexp conversion>
- 'bool', '""', '0+',
+ 'bool', '""', '0+', 'qr'
-If one or two of these operations are not overloaded, the remaining ones can
-be used instead. C<bool> is used in the flow control operators
-(like C<while>) and for the ternary C<?:> operation. These functions can
-return any arbitrary Perl value. If the corresponding operation for this value
-is overloaded too, that operation will be called again with this value.
+If one or two of these operations are not overloaded, the remaining ones
+can be used instead. C<bool> is used in the flow control operators
+(like C<while>) and for the ternary C<?:> operation; C<qr> is used for
+the RHS of C<=~> and when an object is interpolated into a regexp.
+
+C<bool>, C<"">, and C<0+> can return any arbitrary Perl value. If the
+corresponding operation for this value is overloaded too, that operation
+will be called again with this value. C<qr> must return a compiled
+regexp, or a ref to a compiled regexp (such as C<qr//> returns), and any
+further overloading on the return value will be ignored.
As a special case if the overload returns the object itself then it will
be used directly. An overloaded conversion returning the object is
@@ -518,7 +523,7 @@ A computer-readable form of the above table is available in the hash
unary => 'neg ! ~',
mutators => '++ --',
func => 'atan2 cos sin exp abs log sqrt',
- conversion => 'bool "" 0+',
+ conversion => 'bool "" 0+ qr',
iterators => '<>',
filetest => '-X',
dereferencing => '${} @{} %{} &{} *{}',
@@ -693,8 +698,8 @@ is not defined.
=item I<Conversion operations>
-String, numeric, and boolean conversion are calculated in terms of one
-another if not all of them are defined.
+String, numeric, boolean and regexp conversion are calculated in terms
+of one another if not all of them are defined.
=item I<Increment and decrement>