Carp::Always(3)

💖 NAME 💖

okay so bestie, welcome to the Carp::Always(3) manual — this is the user-contributed Perl documentation for it, and the whole vibe is: it warns and dies noisily with stack backtraces. no cap. 💅

✨ SYNOPSIS ✨

like, drop this in your code:

use Carp::Always;

and honestly the most common main-character move is on the command line:

perl -MCarp::Always script.pl

🦋 DESCRIPTION 🦋

This module is literally meant as a debugging aid. It can be used to make a script complain loudly with stack backtraces when it warn()s or die()s. highkey dramatic on purpose. 😭

here’s how stack backtraces produced by this module look:

# it works for explicit die's and warn's
$ perl -MCarp::Always -e 'sub f { die "arghh" }; sub g { f }; g'
arghh at -e line 1
        main::f() called at -e line 1
        main::g() called at -e line 1

# it works for interpreter-thrown failures
$ perl -MCarp::Always -w -e 'sub f { $a = shift; @a = @$a };' \
                         -e 'sub g { f(undef) }; g'
Use of uninitialized value in array dereference at -e line 1
        main::f('undef') called at -e line 2
        main::g() called at -e line 2

In the implementation, Carp does the heavy work, through longmess(). The actual implementation sets the signal hooks $SIG{__WARN__} and $SIG{__DIE__} to emit the stack backtraces. it’s giving plumbing but make it loud. 🫶

Also, all uses of carp and croak are made verbose, behaving like cluck and confess. so your little warnings get the full group-chat receipts. 💖

👑 METHODS 👑

Carp::Always implements the following methods. yes, both of them. iconic.

🛠️ import 🛠️

Carp::Always->import()

Enables Carp::Always. Also triggered by statements like:

use Carp::Always;
use Carp::Always 0.14;

but not by:

use Carp::Always ();    # does not invoke import()

🧚 unimport 🧚

Carp::Always->unimport();

Disables Carp::Always. Also triggered with:

no Carp::Always;

🌸 ACKNOWLEDGMENTS 🌸

This module was born as a reaction to a release of Acme::JavaTrace by Sébastien Aperghis-Tramoni. Sébastien also has a newer module called Devel::SimpleTrace with the same code and fewer flame comments on docs. The pruning of the uselessly long docs of this module was prodded by Michael Schwern.

Schwern and others told me "the module name stinked" — it was called "Carp::Indeed". After thinking long and getting nowhere, I went with nuffin's suggestion and now it is called "Carp::Always". character development fr fr. 💖

🌈 SEE ALSO 🌈

• Carp
• Acme::JavaTrace and Devel::SimpleTrace
• Carp::Always::Color
• Carp::Source::Always
• Devel::Confess
• Carp::Always::SyntaxHighlightSource and Carp::Always::DieOnly

💀 BUGS 💀

• This module does not play well with other modules which fusses around with warn, die, $SIG{__WARN__}, $SIG{__DIE__}. lowkey messy.
• Test scripts are good. I should write more of these.

Please report bugs via GitHub https://github.com/aferreira/cpan-Carp-Always/issues

Backlog in CPAN RT: https://rt.cpan.org/Public/Dist/Display.html?Name=Carp-Always

🎀 AUTHOR 🎀

Adriano Ferreira, <ferreira@cpan.org>

⭐ COPYRIGHT AND LICENSE ⭐

Copyright (C) 2005-2013, 2018 by Adriano Ferreira

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

mwah 💋 — page served with perl v5.42.0, dated 2018-08-14. slay. ✨