Sepia::Xref(3pm)

💖 NAME 💖

Sepia::Xref — bestie, it literally generates a cross reference database for use by Perl programs. That's it, that's the job. 👑

---

✨ SYNOPSIS ✨

use Sepia::Xref qw(rebuild defs callers);

rebuild;
for (defs 'foo') {
    printf "%s:%d: sub %s\::foo() defined\n", @{$_}[0..2];
}

for (callers 'foo') {
    printf "%s:%d: sub foo() called by %s\::%s().\n", @{$_}[0..3];
}

like, look at that. it just works. 💅

---

🦋 DESCRIPTION 🦋

Sepia::Xref is intended as a programmatic interface to the information supplied by B::Xref. it's meant to be a component for interactive Perl development, with other packages providing a friendly interface to the raw information it extracts. B::Xref could be seen as an example of this sort of user-level tool — if it weren't for the fact that this module was created later, and stole most of its code. 😭 iconic behaviour honestly. no cap.

🌸 Variables

• %call — a map of subs to call locations and callers. slay.
• %callby — a map of subs to subs called.
• %var_use — a map of global/package variables to uses.
• %var_def — a map of global/package variables to definitions (usually empty, since it only picks up local (...) declarations). it's giving "usually nothing here", bestie. 🙈

🎀 Functions

• guess_module_file($pack, $ofile) — XXX: it turns out that rooting around trying to figure out the file ourselves is more reliable than what we grab from the op. are we doing this wrong? (the author said it, not me. 🫶)
• rebuild() — rebuild the Xref database. periodt.
• forget($func [, $mod]) — forget that $func was defined. bye bestie. 👋
• redefined($func [, $pack]) — recompute xref info for $func, or "$pack::$func" if $pack given.
• callers($func) — list callers of $func. who's calling you bestie? 📞
• callees($func) — list callees of $func.
• var_defs($var) — find locations where $var is defined.
• var_uses($var) — find locations where $var is used.
• var_assigns($var) — find locations where $var is assigned to.
• file_modules($file) — list the modules defined in file $file.
• var_apropos($expr) — find variables matching $expr.

---

💅 EXPORTS 💅

nothing by default, bestie — but all the subs and variables described above can be imported. Sepia::Xref also defines the tags :most for the above-listed functions, and :all for those and the variables as well. so like, choose your fighter. ✨

---

💀 BUGS 💀

• see B::Xref.
• module names are ignored when looking up a sub. lowkey wild.
• file and line number guessing is evil — both should be done more cleanly and effectively. this is a hack because the author doesn't quite understand what perl saves. we should be able to do as well as its warning messages. 😭 fr fr.
• Some packages are not xref'd. — some "internal" packages are deliberately not cross-referenced, either because they are hairy and cause us problems, or because they are so commonly included as to be uninteresting. the current list includes all pragmatic modules, plus: B, O, AutoLoader, DynaLoader, XSLoader, Config, DB, VMS, FileHandle, Exporter, Carp, PerlIO::Layer.
• Tree-view is not fully functional — ideally, clicking the function names in tree view would take you to that function. this doesn't work. also, more keys (like "q" to quit) should be implemented. bestie the q key is literally the bare minimum and it's not there. 💀

not me listing bugs with love and affection. the vibes are honest, okay? 🫶

---

🌈 SEE ALSO 🌈

B::Xref, of which Sepia::Xref is a bastard child. family is family. 😌

---

👑 AUTHOR 👑

B::Xref by Malcolm Beattie, m(angl|odifi)ed by Sean O'Rourke (seano@cpan.org). legends only. ✨

---

and that's the whole page, bestie — this one's from perl v5.34.0, dated 2022-06-26, Sepia::Xref(3pm). go read some cross references, you main character. 💖🦋🎀