Exception-Class-TryCatch-1.13/000755 000765 000024 00000000000 12303502524 016404 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/Changes000644 000765 000024 00000004570 12303502524 017705 0ustar00davidstaff000000 000000 Revision history for Perl module Exception::Class::TryCatch 1.13 2014-02-26 19:22:39-05:00 America/New_York [CHANGED] - Updated distribution metadata, repo and bugtracker - Distribution now managed with Dist::Zilla 1.12 Mon Nov 3 17:12:19 EST 2008 - Changed: if no exception was thrown, catch() returns an empty array in list context 1.11 Tue Sep 30 12:21:56 EDT 2008 - Fixed: Exception::Class objects that stringified to an empty string weren't being caught (Alessandro Ranellucci) - Changed: now licensed under the Apache License, version 2.0; (it's clearer, relicensable, and is explicit about contributions) 1.10 Tue Feb 7 21:26:27 EST 2006 - Removed Test::Exception dependency entirely - Downgraded Test::More dependency to 0.45 1.09 Tue Aug 16 10:32:15 EDT 2005 - [RT #14025] updated documentation for try to reflect new calling syntax - deprecated "caught()" as Exception::Class 1.21 added "caught()" with different semantics - updated Test::Exception dependency to 0.21 as 0.20 had build_requires problems of its own 1.08 Mon Aug 1 09:29:00 EDT 2005 - moved build_requires to requires for CPANPLUS bug workaround 1.07 Fri Jun 10 11:30:02 EDT 2005 - reduced Test::More required version to 0.47 1.06 Wed Jun 8 12:02:24 EDT 2005 - removed pod/coverage tests to minimize dependencies for Activestate 1.05 Tue Jun 7 17:34:32 EDT 2005 - updated Build.PL to include build dependencies 1.04 Mon May 16 23:20:23 EDT 2005 - changed Module::Build makefile support to 'traditional' (Perrin) 1.03 Sat Apr 23 09:03:00 EDT 2005 - catch rethrows if optional list of class types isn't matched - added support for both one- and two-arguments forms of catch 1.02 Wed Mar 9 06:47:58 EST 2005 - added pod and pod coverage tests 1.01 Mon Jan 24 22:51:43 EST 2005 - changed "try" to return whatever eval returns - try in list context dereferences an array_ref allowing eval to be called in list context by wrapping in an anonymous array - updated build configuration 1.00 Wed Dec 8 16:28:37 EST 2004 - renamed to Exception::Class::TryCatch (on advice of Dave Rolsky) - minor pod edits 0.10 Thu Sep 9 10:20:51 EDT 2004 - initial public release as Exception::Class::Sugar 0.01 Fri Sep 3 00:09:17 2004 - original version; created by ExtUtils::ModuleMaker::TT Exception-Class-TryCatch-1.13/CONTRIBUTING000644 000765 000024 00000006512 12303502524 020242 0ustar00davidstaff000000 000000 ## HOW TO CONTRIBUTE Thank you for considering contributing to this distribution. This file contains instructions that will help you work with the source code. The distribution is managed with Dist::Zilla. This means than many of the usual files you might expect are not in the repository, but are generated at release time (e.g. Makefile.PL). Generally, **you do not need Dist::Zilla to contribute patches**. You do need Dist::Zilla to create a tarball and/or install from the repository. See below for guidance. ### Getting dependencies See the included `cpanfile` file for a list of dependencies. If you have App::cpanminus 1.6 or later installed, you can use `cpanm` to satisfy dependencies like this: $ cpanm --installdeps . Otherwise, you can install Module::CPANfile 1.0002 or later and then satisfy dependencies with the regular `cpan` client and `cpanfile-dump`: $ cpan `cpanfile-dump` ### Running tests You can run tests directly using the `prove` tool: $ prove -l $ prove -lv t/some_test_file.t For most of my distributions, `prove` is entirely sufficient for you to test any patches you have. I use `prove` for 99% of my testing during development. ### Code style and tidying Please try to match any existing coding style. If there is a `.perltidyrc` file, please install Perl::Tidy and use perltidy before submitting patches. If there is a `tidyall.ini` file, you can also install Code::TidyAll and run `tidyall` on a file or `tidyall -a` to tidy all files. ### Patching documentation Much of the documentation Pod is generated at release time. Depending on the distribution, some of my documentation may be written in a Pod dialect called WikiDoc. (See Pod::WikiDoc on CPAN.) If you would like to submit a documentation edit, please limit yourself to the documentation you see. If you see typos or documentation issues in the generated docs, please email or open a bug ticket instead of patching. ### Installing from the repository If you want to install directly from the repository, you need to have Dist::Zilla installed (see below). If this is a burden to you, I welcome patches against a CPAN tarball instead of the repository. ### Installing and using Dist::Zilla Dist::Zilla is a very powerful authoring tool, optimized for maintaining a large number of distributions with a high degree of automation, but it has a large dependency chain, a bit of a learning curve and requires a number of author-specific plugins. To install it from CPAN, I recommend one of the following approaches for the quickest installation: # using CPAN.pm, but bypassing non-functional pod tests $ cpan TAP::Harness::Restricted $ PERL_MM_USE_DEFAULT=1 HARNESS_CLASS=TAP::Harness::Restricted cpan Dist::Zilla # using cpanm, bypassing *all* tests $ cpanm -n Dist::Zilla In either case, it's probably going to take about 10 minutes. Go for a walk, go get a cup of your favorite beverage, take a bathroom break, or whatever. When you get back, Dist::Zilla should be ready for you. Then you need to install any plugins specific to this distribution: $ cpan `dzil authordeps` $ dzil authordeps | cpanm Once installed, here are some dzil commands you might try: $ dzil build $ dzil test $ dzil xtest To install from the repository, use: $ dzil install You can learn more about Dist::Zilla at http://dzil.org/ Exception-Class-TryCatch-1.13/cpanfile000644 000765 000024 00000001755 12303502524 020120 0ustar00davidstaff000000 000000 requires "Exception::Class" => "0"; requires "Exporter" => "0"; requires "perl" => "5.006"; requires "strict" => "0"; requires "warnings" => "0"; on 'test' => sub { requires "ExtUtils::MakeMaker" => "0"; requires "File::Spec::Functions" => "0"; requires "List::Util" => "0"; requires "Test::More" => "0"; requires "overload" => "0"; requires "version" => "0"; }; on 'test' => sub { recommends "CPAN::Meta" => "0"; recommends "CPAN::Meta::Requirements" => "2.120900"; }; on 'configure' => sub { requires "ExtUtils::MakeMaker" => "6.17"; }; on 'develop' => sub { requires "Dist::Zilla" => "5.013"; requires "Dist::Zilla::PluginBundle::DAGOLDEN" => "0.060"; requires "File::Spec" => "0"; requires "File::Temp" => "0"; requires "IO::Handle" => "0"; requires "IPC::Open3" => "0"; requires "Pod::Coverage::TrustPod" => "0"; requires "Test::CPAN::Meta" => "0"; requires "Test::More" => "0"; requires "Test::Pod" => "1.41"; requires "Test::Pod::Coverage" => "1.08"; }; Exception-Class-TryCatch-1.13/dist.ini000644 000765 000024 00000000327 12303502524 020052 0ustar00davidstaff000000 000000 name = Exception-Class-TryCatch author = David Golden copyright_holder = David Golden [@DAGOLDEN] :version = 0.060 stopwords = Perrin stopwords = Rolsky stopwords = perlmonks stopwords = perrin Exception-Class-TryCatch-1.13/lib/000755 000765 000024 00000000000 12303502524 017152 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/LICENSE000644 000765 000024 00000026354 12303502524 017423 0ustar00davidstaff000000 000000 This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Exception-Class-TryCatch-1.13/Makefile.PL000644 000765 000024 00000002723 12303502524 020362 0ustar00davidstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::MakeMaker v5.013. use strict; use warnings; use 5.006; use ExtUtils::MakeMaker 6.17; my %WriteMakefileArgs = ( "ABSTRACT" => "Syntactic try/catch sugar for use with Exception::Class", "AUTHOR" => "David Golden ", "BUILD_REQUIRES" => {}, "CONFIGURE_REQUIRES" => { "ExtUtils::MakeMaker" => "6.17" }, "DISTNAME" => "Exception-Class-TryCatch", "EXE_FILES" => [], "LICENSE" => "apache", "NAME" => "Exception::Class::TryCatch", "PREREQ_PM" => { "Exception::Class" => 0, "Exporter" => 0, "strict" => 0, "warnings" => 0 }, "TEST_REQUIRES" => { "ExtUtils::MakeMaker" => 0, "File::Spec::Functions" => 0, "List::Util" => 0, "Test::More" => 0, "overload" => 0, "version" => 0 }, "VERSION" => "1.13", "test" => { "TESTS" => "t/*.t" } ); my %FallbackPrereqs = ( "Exception::Class" => 0, "Exporter" => 0, "ExtUtils::MakeMaker" => 0, "File::Spec::Functions" => 0, "List::Util" => 0, "Test::More" => 0, "overload" => 0, "strict" => 0, "version" => 0, "warnings" => 0 ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.63_03) } ) { delete $WriteMakefileArgs{TEST_REQUIRES}; delete $WriteMakefileArgs{BUILD_REQUIRES}; $WriteMakefileArgs{PREREQ_PM} = \%FallbackPrereqs; } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); Exception-Class-TryCatch-1.13/MANIFEST000644 000765 000024 00000000767 12303502524 017547 0ustar00davidstaff000000 000000 # This file was automatically generated by Dist::Zilla::Plugin::Manifest v5.013. CONTRIBUTING Changes LICENSE MANIFEST META.json META.yml Makefile.PL README cpanfile dist.ini lib/Exception/Class/TryCatch.pm perlcritic.rc t/00-report-prereqs.t t/01_Exception_Class_TryCatch.t tidyall.ini xt/author/00-compile.t xt/author/critic.t xt/author/pod-spell.t xt/release/distmeta.t xt/release/minimum-version.t xt/release/pod-coverage.t xt/release/pod-syntax.t xt/release/portability.t xt/release/test-version.t Exception-Class-TryCatch-1.13/META.json000644 000765 000024 00000004677 12303502524 020043 0ustar00davidstaff000000 000000 { "abstract" : "Syntactic try/catch sugar for use with Exception::Class", "author" : [ "David Golden " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 5.013, CPAN::Meta::Converter version 2.133380", "license" : [ "apache_2_0" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Exception-Class-TryCatch", "no_index" : { "directory" : [ "t", "xt", "examples", "corpus" ], "package" : [ "DB" ] }, "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.17" } }, "develop" : { "requires" : { "Dist::Zilla" : "5.013", "Dist::Zilla::PluginBundle::DAGOLDEN" : "0.060", "File::Spec" : "0", "File::Temp" : "0", "IO::Handle" : "0", "IPC::Open3" : "0", "Pod::Coverage::TrustPod" : "0", "Test::CPAN::Meta" : "0", "Test::More" : "0", "Test::Pod" : "1.41", "Test::Pod::Coverage" : "1.08" } }, "runtime" : { "requires" : { "Exception::Class" : "0", "Exporter" : "0", "perl" : "5.006", "strict" : "0", "warnings" : "0" } }, "test" : { "recommends" : { "CPAN::Meta" : "0", "CPAN::Meta::Requirements" : "2.120900" }, "requires" : { "ExtUtils::MakeMaker" : "0", "File::Spec::Functions" : "0", "List::Util" : "0", "Test::More" : "0", "overload" : "0", "version" : "0" } } }, "provides" : { "Exception::Class::TryCatch" : { "file" : "lib/Exception/Class/TryCatch.pm", "version" : "1.13" } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://github.com/dagolden/Exception-Class-TryCatch/issues" }, "homepage" : "https://github.com/dagolden/Exception-Class-TryCatch", "repository" : { "type" : "git", "url" : "https://github.com/dagolden/Exception-Class-TryCatch.git", "web" : "https://github.com/dagolden/Exception-Class-TryCatch" } }, "version" : "1.13", "x_authority" : "cpan:DAGOLDEN" } Exception-Class-TryCatch-1.13/META.yml000644 000765 000024 00000002110 12303502524 017647 0ustar00davidstaff000000 000000 --- abstract: 'Syntactic try/catch sugar for use with Exception::Class' author: - 'David Golden ' build_requires: ExtUtils::MakeMaker: '0' File::Spec::Functions: '0' List::Util: '0' Test::More: '0' overload: '0' version: '0' configure_requires: ExtUtils::MakeMaker: '6.17' dynamic_config: 0 generated_by: 'Dist::Zilla version 5.013, CPAN::Meta::Converter version 2.133380' license: apache meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: '1.4' name: Exception-Class-TryCatch no_index: directory: - t - xt - examples - corpus package: - DB provides: Exception::Class::TryCatch: file: lib/Exception/Class/TryCatch.pm version: '1.13' requires: Exception::Class: '0' Exporter: '0' perl: '5.006' strict: '0' warnings: '0' resources: bugtracker: https://github.com/dagolden/Exception-Class-TryCatch/issues homepage: https://github.com/dagolden/Exception-Class-TryCatch repository: https://github.com/dagolden/Exception-Class-TryCatch.git version: '1.13' x_authority: cpan:DAGOLDEN Exception-Class-TryCatch-1.13/perlcritic.rc000644 000765 000024 00000001166 12303502524 021076 0ustar00davidstaff000000 000000 severity = 5 verbose = 8 [Variables::ProhibitPunctuationVars] allow = $@ $! [TestingAndDebugging::ProhibitNoStrict] allow = refs [Variables::ProhibitEvilVariables] variables = $DB::single # Turn these off [-BuiltinFunctions::ProhibitStringyEval] [-ControlStructures::ProhibitPostfixControls] [-ControlStructures::ProhibitUnlessBlocks] [-Documentation::RequirePodSections] [-InputOutput::ProhibitInteractiveTest] [-References::ProhibitDoubleSigils] [-RegularExpressions::RequireExtendedFormatting] [-InputOutput::ProhibitTwoArgOpen] [-Modules::ProhibitEvilModules] # Turn this on [Lax::ProhibitStringyEval::ExceptForRequire] Exception-Class-TryCatch-1.13/README000644 000765 000024 00000022520 12303502524 017265 0ustar00davidstaff000000 000000 NAME Exception::Class::TryCatch - Syntactic try/catch sugar for use with Exception::Class VERSION version 1.13 SYNOPSIS use Exception::Class::TryCatch; # simple usage of catch() eval { Exception::Class::Base->throw('error') }; catch my $err and warn $err->error; # catching only certain types or else rethrowing eval { Exception::Class::Base::SubClass->throw('error') }; catch( my $err, ['Exception::Class::Base', 'Other::Exception'] ) and warn $err->error; # catching and handling different types of errors eval { Exception::Class::Base->throw('error') }; if ( catch my $err ) { $err->isa('this') and do { handle_this($err) }; $err->isa('that') and do { handle_that($err) }; } # use "try eval" to push exceptions onto a stack to catch later try eval { Exception::Class::Base->throw('error') }; do { # cleanup that might use "try/catch" again }; catch my $err; # catches a matching "try" DESCRIPTION Exception::Class::TryCatch provides syntactic sugar for use with Exception::Class using the familiar keywords "try" and "catch". Its primary objective is to allow users to avoid dealing directly with $@ by ensuring that any exceptions caught in an "eval" are captured as Exception::Class objects, whether they were thrown objects to begin with or whether the error resulted from "die". This means that users may immediately use "isa" and various Exception::Class methods to process the exception. In addition, this module provides for a method to push errors onto a hidden error stack immediately after an "eval" so that cleanup code or other error handling may also call "eval" without the original error in $@ being lost. Inspiration for this module is due in part to Dave Rolsky's article "Exception Handling in Perl With Exception::Class" in *The Perl Journal* (Rolsky 2004). The "try/catch" syntax used in this module does not use code reference prototypes the way the Error.pm module does, but simply provides some helpful functionality when used in combination with "eval". As a result, it avoids the complexity and dangers involving nested closures and memory leaks inherent in Error.pm (Perrin 2003). Rolsky (2004) notes that these memory leaks may not occur in recent versions of Perl, but the approach used in Exception::Class::TryCatch should be safe for all versions of Perl as it leaves all code execution to the "eval" in the current scope, avoiding closures altogether. USAGE "catch" # zero argument form my $err = catch; # one argument forms catch my $err; my $err = catch( [ 'Exception::Type', 'Exception::Other::Type' ] ); # two argument form catch my $err, [ 'Exception::Type', 'Exception::Other::Type' ]; Returns an "Exception::Class::Base" object (or an object which is a subclass of it) if an exception has been caught by "eval". If no exception was thrown, it returns "undef" in scalar context and an empty list in list context. The exception is either popped from a hidden error stack (see "try") or, if the stack is empty, taken from the current value of $@. If the exception is not an "Exception::Class::Base" object (or subclass object), an "Exception::Class::Base" object will be created using the string contents of the exception. This means that calls to "die" will be wrapped and may be treated as exception objects. Other objects caught will be stringified and wrapped likewise. Such wrapping will likely result in confusing stack traces and the like, so any methods other than "error" used on "Exception::Class::Base" objects caught should be used with caution. "catch" is prototyped to take up to two optional scalar arguments. The single argument form has two variations. * If the argument is a reference to an array, any exception caught that is not of the same type (or a subtype) of one of the classes listed in the array will be rethrown. * If the argument is not a reference to an array, "catch" will set the argument to the same value that is returned. This allows for the "catch my $err" idiom without parentheses. In the two-argument form, the first argument is set to the same value as is returned. The second argument must be an array reference and is handled the same as as for the single argument version with an array reference, as given above. "caught" (DEPRECATED) "caught" is a synonym for "catch" for syntactic convenience. NOTE: Exception::Class version 1.21 added a "caught" method of its own. It provides somewhat similar functionality to this subroutine, but with very different semantics. As this class is intended to work closely with Exception::Class, the existence of a subroutine and a method with the same name is liable to cause confusion and this method is deprecated and may be removed in future releases of Exception::Class::TryCatch. This method is no longer exported by default. "try" # void context try eval { # dangerous code }; do { # cleanup code can use try/catch }; catch my $err; # scalar context $rv = try eval { return $scalar }; # list context @rv = try [ eval { return @array } ]; Pushes the current error ($@) onto a hidden error stack for later use by "catch". "try" uses a prototype that expects a single scalar so that it can be used with eval without parentheses. As "eval { BLOCK }" is an argument to try, it will be evaluated just prior to "try", ensuring that "try" captures the correct error status. "try" does not itself handle any errors -- it merely records the results of "eval". "try { BLOCK }" will be interpreted as passing a hash reference and will (probably) not compile. (And if it does, it will result in very unexpected behavior.) Since "try" requires a single argument, "eval" will normally be called in scalar context. To use "eval" in list context with "try", put the call to "eval" in an anonymous array: @rv = try [ eval {return @array} ]; When "try" is called in list context, if the argument to "try" is an array reference, "try" will dereference the array and return the resulting list. In scalar context, "try" passes through the scalar value returned by "eval" without modifications -- even if that is an array reference. $rv = try eval { return $scalar }; $rv = try eval { return [ qw( anonymous array ) ] }; Of course, if the eval throws an exception, "eval" and thus "try" will return undef. "try" must always be properly bracketed with a matching "catch" or unexpected behavior may result when "catch" pops the error off of the stack. "try" executes right after its "eval", so inconsistent usage of "try" like the following will work as expected: try eval { eval { die "inner" }; catch my $inner_err die "outer" if $inner_err; }; catch my $outer_err; # handle $outer_err; However, the following code is a problem: # BAD EXAMPLE try eval { try eval { die "inner" }; die $@ if $@; }; catch my $outer_err; # handle $outer_err; This code will appear to run correctly, but "catch" gets the exception from the inner "try", not the outer one, and there will still be an exception on the error stack which will be caught by the next "catch" in the program, causing unexpected (and likely hard to track) behavior. In short, if you use "try", you must have a matching "catch". The problem code above should be rewritten as: try eval { try eval { die "inner" }; catch my $inner_err; $inner_err->rethrow if $inner_err; }; catch my $outer_err; # handle $outer_err; REFERENCES 1. perrin. (2003), "Re: Re2: Learning how to use the Error module by example", (perlmonks.org), Available: http://www.perlmonks.org/index.pl?node_id=278900 (Accessed September 8, 2004). 2. Rolsky, D. (2004), "Exception Handling in Perl with Exception::Class", *The Perl Journal*, vol. 8, no. 7, pp. 9-13 SEE ALSO * Exception::Class * Error -- but see (Perrin 2003) before using SUPPORT Bugs / Feature Requests Please report any bugs or feature requests through the issue tracker at . You will be notified automatically of any progress on your issue. Source Code This is open source software. The code repository is available for public review and contribution under the terms of the license. git clone https://github.com/dagolden/Exception-Class-TryCatch.git AUTHOR David Golden COPYRIGHT AND LICENSE This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 Exception-Class-TryCatch-1.13/t/000755 000765 000024 00000000000 12303502524 016647 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/tidyall.ini000644 000765 000024 00000000240 12303502524 020543 0ustar00davidstaff000000 000000 ; Install Code::TidyAll ; run "tidyall -a" to tidy all files ; run "tidyall -g" to tidy only files modified from git [PerlTidy] select = {lib,t}/**/*.{pl,pm,t} Exception-Class-TryCatch-1.13/xt/000755 000765 000024 00000000000 12303502524 017037 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/xt/author/000755 000765 000024 00000000000 12303502524 020341 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/xt/release/000755 000765 000024 00000000000 12303502524 020457 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/xt/release/distmeta.t000644 000765 000024 00000000172 12303502524 022456 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::MetaTests. use Test::CPAN::Meta; meta_yaml_ok(); Exception-Class-TryCatch-1.13/xt/release/minimum-version.t000644 000765 000024 00000000266 12303502524 024006 0ustar00davidstaff000000 000000 #!perl use Test::More; eval "use Test::MinimumVersion"; plan skip_all => "Test::MinimumVersion required for testing minimum versions" if $@; all_minimum_version_ok( qq{5.010} ); Exception-Class-TryCatch-1.13/xt/release/pod-coverage.t000644 000765 000024 00000000334 12303502524 023217 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::PodCoverageTests. use Test::Pod::Coverage 1.08; use Pod::Coverage::TrustPod; all_pod_coverage_ok({ coverage_class => 'Pod::Coverage::TrustPod' }); Exception-Class-TryCatch-1.13/xt/release/pod-syntax.t000644 000765 000024 00000000220 12303502524 022744 0ustar00davidstaff000000 000000 #!perl # This file was automatically generated by Dist::Zilla::Plugin::PodSyntaxTests. use Test::More; use Test::Pod 1.41; all_pod_files_ok(); Exception-Class-TryCatch-1.13/xt/release/portability.t000644 000765 000024 00000000332 12303502524 023204 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; use Test::More; eval 'use Test::Portability::Files'; plan skip_all => 'Test::Portability::Files required for testing portability' if $@; options(test_one_dot => 0); run_tests(); Exception-Class-TryCatch-1.13/xt/release/test-version.t000644 000765 000024 00000000643 12303502524 023311 0ustar00davidstaff000000 000000 use strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::Version 0.002004 BEGIN { eval "use Test::Version; 1;" or die $@; } my @imports = ( 'version_all_ok' ); my $params = { is_strict => 0, has_version => 1, }; push @imports, $params if version->parse( $Test::Version::VERSION ) >= version->parse('1.002'); Test::Version->import(@imports); version_all_ok; done_testing; Exception-Class-TryCatch-1.13/xt/author/00-compile.t000644 000765 000024 00000002052 12303502524 022372 0ustar00davidstaff000000 000000 use 5.006; use strict; use warnings; # this test was generated with Dist::Zilla::Plugin::Test::Compile 2.039 use Test::More tests => 1 + ($ENV{AUTHOR_TESTING} ? 1 : 0); my @module_files = ( 'Exception/Class/TryCatch.pm' ); # fake home for cpan-testers use File::Temp; local $ENV{HOME} = File::Temp::tempdir( CLEANUP => 1 ); my $inc_switch = -d 'blib' ? '-Mblib' : '-Ilib'; use File::Spec; use IPC::Open3; use IO::Handle; open my $stdin, '<', File::Spec->devnull or die "can't open devnull: $!"; my @warnings; for my $lib (@module_files) { # see L my $stderr = IO::Handle->new; my $pid = open3($stdin, '>&STDERR', $stderr, $^X, $inc_switch, '-e', "require q[$lib]"); binmode $stderr, ':crlf' if $^O eq 'MSWin32'; my @_warnings = <$stderr>; waitpid($pid, 0); is($?, 0, "$lib loaded ok"); if (@_warnings) { warn @_warnings; push @warnings, @_warnings; } } is(scalar(@warnings), 0, 'no warnings found') if $ENV{AUTHOR_TESTING}; Exception-Class-TryCatch-1.13/xt/author/critic.t000644 000765 000024 00000000435 12303502524 022005 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; use Test::More; use English qw(-no_match_vars); eval "use Test::Perl::Critic"; plan skip_all => 'Test::Perl::Critic required to criticise code' if $@; Test::Perl::Critic->import( -profile => "perlcritic.rc" ) if -e "perlcritic.rc"; all_critic_ok(); Exception-Class-TryCatch-1.13/xt/author/pod-spell.t000644 000765 000024 00000000467 12303502524 022434 0ustar00davidstaff000000 000000 use strict; use warnings; use Test::More; # generated by Dist::Zilla::Plugin::Test::PodSpelling 2.006005 use Test::Spelling 0.12; use Pod::Wordlist; add_stopwords(); all_pod_files_spelling_ok( qw( bin lib ) ); __DATA__ Perrin Rolsky perlmonks perrin David Golden dagolden lib Exception Class TryCatch Exception-Class-TryCatch-1.13/t/00-report-prereqs.t000644 000765 000024 00000013665 12303502524 022256 0ustar00davidstaff000000 000000 #!perl use strict; use warnings; # This test was generated by Dist::Zilla::Plugin::Test::ReportPrereqs 0.013 use Test::More tests => 1; use ExtUtils::MakeMaker; use File::Spec::Functions; use List::Util qw/max/; use version; # hide optional CPAN::Meta modules from prereq scanner # and check if they are available my $cpan_meta = "CPAN::Meta"; my $cpan_meta_req = "CPAN::Meta::Requirements"; my $HAS_CPAN_META = eval "require $cpan_meta"; ## no critic my $HAS_CPAN_META_REQ = eval "require $cpan_meta_req; $cpan_meta_req->VERSION('2.120900')"; # Verify requirements? my $DO_VERIFY_PREREQS = 1; sub _merge_requires { my ($collector, $prereqs) = @_; for my $phase ( qw/configure build test runtime develop/ ) { next unless exists $prereqs->{$phase}; if ( my $req = $prereqs->{$phase}{'requires'} ) { my $cmr = CPAN::Meta::Requirements->from_string_hash( $req ); $collector->add_requirements( $cmr ); } } } my %include = map {; $_ => 1 } qw( ); my %exclude = map {; $_ => 1 } qw( ); # Add static prereqs to the included modules list my $static_prereqs = do { my $x = { 'configure' => { 'requires' => { 'ExtUtils::MakeMaker' => '6.17' } }, 'develop' => { 'requires' => { 'Dist::Zilla' => '5.013', 'Dist::Zilla::PluginBundle::DAGOLDEN' => '0.060', 'File::Spec' => '0', 'File::Temp' => '0', 'IO::Handle' => '0', 'IPC::Open3' => '0', 'Pod::Coverage::TrustPod' => '0', 'Test::CPAN::Meta' => '0', 'Test::More' => '0', 'Test::Pod' => '1.41', 'Test::Pod::Coverage' => '1.08' } }, 'runtime' => { 'requires' => { 'Exception::Class' => '0', 'Exporter' => '0', 'perl' => '5.006', 'strict' => '0', 'warnings' => '0' } }, 'test' => { 'recommends' => { 'CPAN::Meta' => '0', 'CPAN::Meta::Requirements' => '2.120900' }, 'requires' => { 'ExtUtils::MakeMaker' => '0', 'File::Spec::Functions' => '0', 'List::Util' => '0', 'Test::More' => '0', 'overload' => '0', 'version' => '0' } } }; $x; }; delete $static_prereqs->{develop} if not $ENV{AUTHOR_TESTING}; $include{$_} = 1 for map { keys %$_ } map { values %$_ } values %$static_prereqs; # Merge requirements for major phases (if we can) my $all_requires; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META_REQ ) { $all_requires = $cpan_meta_req->new; _merge_requires($all_requires, $static_prereqs); } # Add dynamic prereqs to the included modules list (if we can) my ($source) = grep { -f } 'MYMETA.json', 'MYMETA.yml'; if ( $source && $HAS_CPAN_META ) { if ( my $meta = eval { CPAN::Meta->load_file($source) } ) { my $dynamic_prereqs = $meta->prereqs; delete $dynamic_prereqs->{develop} if not $ENV{AUTHOR_TESTING}; $include{$_} = 1 for map { keys %$_ } map { values %$_ } values %$dynamic_prereqs; if ( $DO_VERIFY_PREREQS && $HAS_CPAN_META_REQ ) { _merge_requires($all_requires, $dynamic_prereqs); } } } else { $source = 'static metadata'; } my @modules = sort grep { ! $exclude{$_} } keys %include; my @reports = [qw/Version Module/]; my @dep_errors; my $req_hash = defined($all_requires) ? $all_requires->as_string_hash : {}; for my $mod ( @modules ) { next if $mod eq 'perl'; my $file = $mod; $file =~ s{::}{/}g; $file .= ".pm"; my ($prefix) = grep { -e catfile($_, $file) } @INC; if ( $prefix ) { my $ver = MM->parse_version( catfile($prefix, $file) ); $ver = "undef" unless defined $ver; # Newer MM should do this anyway push @reports, [$ver, $mod]; if ( $DO_VERIFY_PREREQS && $all_requires ) { my $req = $req_hash->{$mod}; if ( defined $req && length $req ) { if ( ! defined eval { version->parse($ver) } ) { push @dep_errors, "$mod version '$ver' cannot be parsed (version '$req' required)"; } elsif ( ! $all_requires->accepts_module( $mod => $ver ) ) { push @dep_errors, "$mod version '$ver' is not in required range '$req'"; } } } } else { push @reports, ["missing", $mod]; if ( $DO_VERIFY_PREREQS && $all_requires ) { my $req = $req_hash->{$mod}; if ( defined $req && length $req ) { push @dep_errors, "$mod is not installed (version '$req' required)"; } } } } if ( @reports ) { my $vl = max map { length $_->[0] } @reports; my $ml = max map { length $_->[1] } @reports; splice @reports, 1, 0, ["-" x $vl, "-" x $ml]; diag "\nVersions for all modules listed in $source (including optional ones):\n", map {sprintf(" %*s %*s\n",$vl,$_->[0],-$ml,$_->[1])} @reports; } if ( @dep_errors ) { diag join("\n", "\n*** WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING ***\n", "The following REQUIRED prerequisites were not satisfied:\n", @dep_errors, "\n" ); } pass; # vim: ts=4 sts=4 sw=4 et: Exception-Class-TryCatch-1.13/t/01_Exception_Class_TryCatch.t000644 000765 000024 00000017042 12303502524 024224 0ustar00davidstaff000000 000000 # Exception::Class::TryCatch use strict; use Test::More tests => 45; use Exception::Class::TryCatch qw( try catch caught ); use Exception::Class 'My::Exception::Class', 'My::Other::Exception'; package My::Exception::Class; # check for bug when some Exception class stringifies to empty string use overload q{""} => sub { return '' }, fallback => 1; package main; my $e; #--------------------------------------------------------------------------# # Test basic catching of Exception::Class thrown errors #--------------------------------------------------------------------------# eval { My::Exception::Class->throw('error1') }; $e = catch; ok( $e, "Caught My::Exception::Class error1" ); isa_ok( $e, 'Exception::Class::Base' ); isa_ok( $e, 'My::Exception::Class' ); is( $e->error, 'error1', "Exception is 'error1'" ); eval { My::Exception::Class->throw('error2'); }; $e = catch; ok( $e, "Caught My::Exception::Class error2" ); isa_ok( $e, 'My::Exception::Class' ); is( $e->error, 'error2', "Exception is 'error2'" ); #--------------------------------------------------------------------------# # Test handling of normal die (not Exception::Class throw() ) #--------------------------------------------------------------------------# eval { die "error3" }; $e = catch; ok( $e, "Caught 'die error3'" ); isa_ok( $e, 'Exception::Class::Base' ); like( $e->error, qr/^error3 at/, "Exception is 'error3 at...'" ); eval { die 0 }; $e = catch; ok( $e, "Caught 'die 0'" ); isa_ok( $e, 'Exception::Class::Base' ); like( $e->error, qr/^0 at/, "Exception is '0 at...'" ); eval { die }; $e = catch; ok( $e, "Caught 'die'" ); isa_ok( $e, 'Exception::Class::Base' ); like( $e->error, qr/^Died at/, "Exception is 'Died at...'" ); #--------------------------------------------------------------------------# # Test handling of non-dying evals #--------------------------------------------------------------------------# eval { 1 }; $e = catch; is( $e, undef, "Didn't catch eval of 1" ); eval { 0 }; $e = catch; is( $e, undef, "Didn't catch eval of 0" ); #--------------------------------------------------------------------------# # Test catch (my e) syntax-- pass by reference #--------------------------------------------------------------------------# eval { My::Exception::Class->throw('error'); }; catch my $err; is( $err->error, 'error', "catch X syntax worked" ); #--------------------------------------------------------------------------# # Test caught synonym #--------------------------------------------------------------------------# undef $err; eval { My::Exception::Class->throw("error") }; caught $err; is( $err->error, 'error', "caught synonym worked" ); #--------------------------------------------------------------------------# # Test catch setting error variable to undef if no error #--------------------------------------------------------------------------# eval { My::Exception::Class->throw("error") }; catch $err; eval { 1 }; catch $err; is( $err, undef, "catch undefs a passed error variable if no error" ); #--------------------------------------------------------------------------# # Test try passing through results of eval #--------------------------------------------------------------------------# my $test_val = 23; my @test_vals = ( 1, 2, 3 ); my $rv = try eval { return $test_val }; is( $rv, $test_val, "try in scalar context passes through result of eval" ); $rv = try eval { return \@test_vals }; is( $rv, \@test_vals, "try in scalar context passes an array ref as is" ); my @rv = try [ eval { return @test_vals } ]; is_deeply( \@rv, \@test_vals, "try in list context dereferences an array ref passed to it" ); @rv = try eval { return $test_val }; is_deeply( \@rv, [$test_val], "try in list context passes through a scalar return" ); #--------------------------------------------------------------------------# # Test simple try/catch #--------------------------------------------------------------------------# $rv = try eval { My::Exception::Class->throw("error") }; catch $err; is( $rv, undef, "try gets undef on exception" ); is( $err->error, 'error', "simple try/catch works" ); #--------------------------------------------------------------------------# # Test try/catch to array #--------------------------------------------------------------------------# $rv = try eval { My::Exception::Class->throw("error") }; my @err = catch; is( scalar @err, 1, '@array = catch' ); is( $err[0]->error, 'error', 'array catch works' ); #--------------------------------------------------------------------------# # Test try/catch to array -- no error #--------------------------------------------------------------------------# $rv = try eval { 42 }; @err = catch; is( scalar @err, 0, 'array catch with no error returns empty array' ); #--------------------------------------------------------------------------# # Test multiple try/catch with double error #--------------------------------------------------------------------------# my $inner_err; my $outer_err; for my $out ( 0, 1 ) { for my $in ( 0, 1 ) { try eval { $out ? My::Exception::Class->throw("outer") : 1 }; try eval { $in ? My::Exception::Class->throw("inner") : 1 }; catch $inner_err; catch $outer_err; if ($in) { is( $inner_err->error, "inner", "Inner try caught correctly in case ($out,$in)" ); } else { is( $inner_err, undef, "Inner try caught correctly in case ($out,$in)" ); } if ($out) { is( $outer_err->error, "outer", "Outer try caught correctly in case ($out,$in)" ); } else { is( $outer_err, undef, "Outer try caught correctly in case ($out,$in)" ); } } } #--------------------------------------------------------------------------# # Test catch rethrowing unless a list is matched -- one argument version #--------------------------------------------------------------------------# { try eval { try eval { My::Exception::Class->throw("error") }; $err = catch( ['My::Other::Exception'] ); diag( "Shouldn't be here because \$err is a " . ref($err) . " not a My::Other::Exception." ); }; catch $outer_err; } ok( UNIVERSAL::isa( $outer_err, 'My::Exception::Class' ), "catch not matching list should rethrow -- single arg version" ); eval { eval { My::Exception::Class->throw("error") }; $err = catch( ['My::Exception::Class'] ); }; is( $@, q{}, "catch matching list lives -- single arg version" ); eval { 1 }; $e = catch ['My::Exception::Class']; is( $e, undef, "catch returns undef if no error -- single arg version" ); #--------------------------------------------------------------------------# # Test catch rethrowing unless a list is matched -- two argument version #--------------------------------------------------------------------------# { try eval { try eval { My::Exception::Class->throw("error") }; catch( $err, ['My::Other::Exception'] ); diag( "Shouldn't be here unless " . ref($err) . " is a My::Other::Exception." ); }; catch $outer_err; } ok( UNIVERSAL::isa( $outer_err, 'My::Exception::Class' ), "catch not matching list should rethrow -- two arg version" ); eval { eval { My::Exception::Class->throw("error") }; catch( $err, ['My::Exception::Class'] ); }; is( $@, q{}, "catch matching list lives -- two arg version" ); eval { 1 }; $e = catch $err, ['My::Exception::Class']; is( $e, undef, "catch returns undef if no error -- two arg version" ); is( $err, undef, "catch undefs a passed error variable if no error -- two arg version" ); Exception-Class-TryCatch-1.13/lib/Exception/000755 000765 000024 00000000000 12303502524 021110 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/lib/Exception/Class/000755 000765 000024 00000000000 12303502524 022155 5ustar00davidstaff000000 000000 Exception-Class-TryCatch-1.13/lib/Exception/Class/TryCatch.pm000644 000765 000024 00000025644 12303502524 024247 0ustar00davidstaff000000 000000 use strict; use warnings; package Exception::Class::TryCatch; # ABSTRACT: Syntactic try/catch sugar for use with Exception::Class our $VERSION = '1.13'; # VERSION our @ISA = qw (Exporter); our @EXPORT = qw ( catch try ); our @EXPORT_OK = qw ( caught ); use Exception::Class; use Exporter (); my @error_stack; #--------------------------------------------------------------------------# # catch() #--------------------------------------------------------------------------# sub catch(;$$) { ## no critic my $e; my $err = @error_stack ? pop @error_stack : $@; if ( UNIVERSAL::isa( $err, 'Exception::Class::Base' ) ) { $e = $err; } elsif ( $err eq '' ) { $e = undef; } else { # use error message or hope something stringifies $e = Exception::Class::Base->new("$err"); } unless ( ref( $_[0] ) eq 'ARRAY' ) { $_[0] = $e; shift; } if ($e) { if ( defined( $_[0] ) and ref( $_[0] ) eq 'ARRAY' ) { $e->rethrow() unless grep { $e->isa($_) } @{ $_[0] }; } } return wantarray ? ( $e ? ($e) : () ) : $e; } *caught = \&catch; #--------------------------------------------------------------------------# # try() #--------------------------------------------------------------------------# sub try($) { ## no critic my $v = shift; push @error_stack, $@; return ref($v) eq 'ARRAY' ? @$v : $v if wantarray; return $v; } 1; __END__ =pod =encoding UTF-8 =head1 NAME Exception::Class::TryCatch - Syntactic try/catch sugar for use with Exception::Class =head1 VERSION version 1.13 =head1 SYNOPSIS use Exception::Class::TryCatch; # simple usage of catch() eval { Exception::Class::Base->throw('error') }; catch my $err and warn $err->error; # catching only certain types or else rethrowing eval { Exception::Class::Base::SubClass->throw('error') }; catch( my $err, ['Exception::Class::Base', 'Other::Exception'] ) and warn $err->error; # catching and handling different types of errors eval { Exception::Class::Base->throw('error') }; if ( catch my $err ) { $err->isa('this') and do { handle_this($err) }; $err->isa('that') and do { handle_that($err) }; } # use "try eval" to push exceptions onto a stack to catch later try eval { Exception::Class::Base->throw('error') }; do { # cleanup that might use "try/catch" again }; catch my $err; # catches a matching "try" =head1 DESCRIPTION Exception::Class::TryCatch provides syntactic sugar for use with L using the familiar keywords C<<< try >>> and C<<< catch >>>. Its primary objective is to allow users to avoid dealing directly with C<<< $@ >>> by ensuring that any exceptions caught in an C<<< eval >>> are captured as L objects, whether they were thrown objects to begin with or whether the error resulted from C<<< die >>>. This means that users may immediately use C<<< isa >>> and various L methods to process the exception. In addition, this module provides for a method to push errors onto a hidden error stack immediately after an C<<< eval >>> so that cleanup code or other error handling may also call C<<< eval >>> without the original error in C<<< $@ >>> being lost. Inspiration for this module is due in part to Dave Rolsky's article "Exception Handling in Perl With Exception::Class" in I (Rolsky 2004). The C<<< try/catch >>> syntax used in this module does not use code reference prototypes the way the L module does, but simply provides some helpful functionality when used in combination with C<<< eval >>>. As a result, it avoids the complexity and dangers involving nested closures and memory leaks inherent in L (Perrin 2003). Rolsky (2004) notes that these memory leaks may not occur in recent versions of Perl, but the approach used in Exception::Class::TryCatch should be safe for all versions of Perl as it leaves all code execution to the C<<< eval >>> in the current scope, avoiding closures altogether. =head1 USAGE =head2 C<<< catch >>> # zero argument form my $err = catch; # one argument forms catch my $err; my $err = catch( [ 'Exception::Type', 'Exception::Other::Type' ] ); # two argument form catch my $err, [ 'Exception::Type', 'Exception::Other::Type' ]; Returns an C<<< Exception::Class::Base >>> object (or an object which is a subclass of it) if an exception has been caught by C<<< eval >>>. If no exception was thrown, it returns C<<< undef >>> in scalar context and an empty list in list context. The exception is either popped from a hidden error stack (see C<<< try >>>) or, if the stack is empty, taken from the current value of C<<< $@ >>>. If the exception is not an C<<< Exception::Class::Base >>> object (or subclass object), an C<<< Exception::Class::Base >>> object will be created using the string contents of the exception. This means that calls to C<<< die >>> will be wrapped and may be treated as exception objects. Other objects caught will be stringified and wrapped likewise. Such wrapping will likely result in confusing stack traces and the like, so any methods other than C<<< error >>> used on C<<< Exception::Class::Base >>> objects caught should be used with caution. C<<< catch >>> is prototyped to take up to two optional scalar arguments. The single argument form has two variations. =over =item * If the argument is a reference to an array, any exception caught that is not of the same type (or a subtype) of one of the classes listed in the array will be rethrown. =item * If the argument is not a reference to an array, C<<< catch >>> will set the argument to the same value that is returned. This allows for the C<<< catch my $err >>> idiom without parentheses. =back In the two-argument form, the first argument is set to the same value as is returned. The second argument must be an array reference and is handled the same as as for the single argument version with an array reference, as given above. =head2 C<<< caught >>> (DEPRECATED) C<<< caught >>> is a synonym for C<<< catch >>> for syntactic convenience. NOTE: Exception::Class version 1.21 added a "caught" method of its own. It provides somewhat similar functionality to this subroutine, but with very different semantics. As this class is intended to work closely with Exception::Class, the existence of a subroutine and a method with the same name is liable to cause confusion and this method is deprecated and may be removed in future releases of Exception::Class::TryCatch. This method is no longer exported by default. =head2 C<<< try >>> # void context try eval { # dangerous code }; do { # cleanup code can use try/catch }; catch my $err; # scalar context $rv = try eval { return $scalar }; # list context @rv = try [ eval { return @array } ]; Pushes the current error (C<<< $@ >>>) onto a hidden error stack for later use by C<<< catch >>>. C<<< try >>> uses a prototype that expects a single scalar so that it can be used with eval without parentheses. As C<<< eval { BLOCK } >>> is an argument to try, it will be evaluated just prior to C<<< try >>>, ensuring that C<<< try >>> captures the correct error status. C<<< try >>> does not itself handle any errors -- it merely records the results of C<<< eval >>>. C<<< try { BLOCK } >>> will be interpreted as passing a hash reference and will (probably) not compile. (And if it does, it will result in very unexpected behavior.) Since C<<< try >>> requires a single argument, C<<< eval >>> will normally be called in scalar context. To use C<<< eval >>> in list context with C<<< try >>>, put the call to C<<< eval >>> in an anonymous array: @rv = try [ eval {return @array} ]; When C<<< try >>> is called in list context, if the argument to C<<< try >>> is an array reference, C<<< try >>> will dereference the array and return the resulting list. In scalar context, C<<< try >>> passes through the scalar value returned by C<<< eval >>> without modifications -- even if that is an array reference. $rv = try eval { return $scalar }; $rv = try eval { return [ qw( anonymous array ) ] }; Of course, if the eval throws an exception, C<<< eval >>> and thus C<<< try >>> will return undef. C<<< try >>> must always be properly bracketed with a matching C<<< catch >>> or unexpected behavior may result when C<<< catch >>> pops the error off of the stack. C<<< try >>> executes right after its C<<< eval >>>, so inconsistent usage of C<<< try >>> like the following will work as expected: try eval { eval { die "inner" }; catch my $inner_err die "outer" if $inner_err; }; catch my $outer_err; # handle $outer_err; However, the following code is a problem: # BAD EXAMPLE try eval { try eval { die "inner" }; die $@ if $@; }; catch my $outer_err; # handle $outer_err; This code will appear to run correctly, but C<<< catch >>> gets the exception from the inner C<<< try >>>, not the outer one, and there will still be an exception on the error stack which will be caught by the next C<<< catch >>> in the program, causing unexpected (and likely hard to track) behavior. In short, if you use C<<< try >>>, you must have a matching C<<< catch >>>. The problem code above should be rewritten as: try eval { try eval { die "inner" }; catch my $inner_err; $inner_err->rethrow if $inner_err; }; catch my $outer_err; # handle $outer_err; =head1 REFERENCES =over =item 1. perrin. (2003), "Re: Re2: Learning how to use the Error module by example", (perlmonks.org), Available: http:EEwww.perlmonks.orgEindex.pl?node_id=278900 (Accessed September 8, 2004). =item 2. Rolsky, D. (2004), "Exception Handling in Perl with Exception::Class", I, vol. 8, no. 7, pp. 9-13 =back =head1 SEE ALSO =over =item * L =item * L -- but see (Perrin 2003) before using =back =for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan =head1 SUPPORT =head2 Bugs / Feature Requests Please report any bugs or feature requests through the issue tracker at L. You will be notified automatically of any progress on your issue. =head2 Source Code This is open source software. The code repository is available for public review and contribution under the terms of the license. L git clone https://github.com/dagolden/Exception-Class-TryCatch.git =head1 AUTHOR David Golden =head1 COPYRIGHT AND LICENSE This software is Copyright (c) 2014 by David Golden. This is free software, licensed under: The Apache License, Version 2.0, January 2004 =cut