5 Sepia - Simple Emacs-Perl Interface
11 M-x load-library RET sepia RET
14 At the prompt in the C<*sepia-repl*> buffer:
18 For more information, please see F<Sepia.html> or F<sepia.info>, which
19 come with the distribution.
23 Sepia is a set of features to make Emacs a better tool for Perl
24 development. This package contains the Perl side of the
25 implementation, including all user-serviceable parts (for the
26 cross-referencing facility see L<Sepia::Xref>). This document is
27 aimed as Sepia developers; for user documentation, see
28 L<Sepia.html> or L<sepia.info>.
30 Though not intended to be used independent of the Emacs interface, the
31 Sepia module's functionality can be used through a rough procedural
36 use 5.008; # try to defend against "Modern"
37 $VERSION = '0.992_01';
40 # eval 'no warnings "deprecated"'; # undo some of the 5.12 suck.
44 Perl $] (newer than 5.12.3) may break Sepia. Please let the author
45 (seano\@cpan.org) know what happens.
48 # Not as useful as I had hoped...
52 (my $child = $_[1]) =~ s!/!::!g;
54 push @
{$REQUIRED_BY{$child}}, $parent;
55 push @
{$REQUIRES{$parent}}, $child;
57 BEGIN { sub TRACK_REQUIRES
() { $ENV{TRACK_REQUIRES
}||0 } };
58 unshift @INC, \
&Sepia
::track_requires
if TRACK_REQUIRES
;
61 use Sepia
::Debug
; # THIS TURNS ON DEBUGGING INFORMATION!
63 use Scalar
::Util
'looks_like_number';
66 # uncomment for development:
68 # use vars qw($PS1 %REPL %RK %REPL_DOC %REPL_SHORT %PRINTER
69 # @res $REPL_LEVEL $REPL_QUIT $PACKAGE $SIGGED
70 # $WANTARRAY $PRINTER $STRICT $COLUMNATE $ISEVAL $STRINGIFY
71 # $LAST_INPUT $READLINE @PRE_EVAL @POST_EVAL @PRE_PROMPT
72 # %REQUIRED_BY %REQUIRES);
75 eval q{ use List::Util 'max' };
80 $ret = $_ if $_ > $ret;
89 Like Emacs, Sepia's behavior can be modified by placing functions on
90 various hooks (arrays). Hooks can be manipulated by the following
95 =item C<add_hook(@hook, @functions)> -- Add C<@functions> to C<@hook>.
97 =item C<remove_hook(@hook, @functions)> -- Remove named C<@functions> from C<@hook>.
99 =item C<run_hook(@hook)> -- Run the functions on the named hook.
101 Each function is called with no arguments in an eval {} block, and
102 its return value is ignored.
106 Sepia currently defines the following hooks:
110 =item C<@PRE_PROMPT> -- Called immediately before the prompt is printed.
112 =item C<@PRE_EVAL> -- Called immediately before evaluating user input.
114 =item C<@POST_EVAL> -- Called immediately after evaluating user input.
133 push @
$hook, $h unless grep $h eq $_, @
$hook;
140 @
$hook = grep { my $x = $_; !grep $_ eq $x, @
$hook } @
$hook;
145 Sepia tries hard to come up with a list of completions.
149 =item C<$re = _apropos_re($pat)>
151 Create a completion expression from user input.
157 # Do that crazy multi-word identifier completion thing:
159 my $hat = shift() ?
'' : '^';
160 return qr/.*/ if $re eq '';
163 s/(?:^|(?<=[A-Za-z\d]))(([^A-Za-z\d])\2*)/[A-Za-z\\d]*$2+/g;
165 } split /:+/, $re, -1;
167 if ($re !~ /[^\w\d_^:]/) {
168 $re =~ s/(?<=[A-Za-z\d])(([^A-Za-z\d])\2*)/[A-Za-z\\d]*$2+/g;
176 %sigil = qw(ARRAY @ SCALAR $ HASH %);
179 =item C<$val = filter_untyped>
181 Return true if C<$_> is the name of a sub, file handle, or package.
183 =item C<$val = filter_typed $type>
185 Return true if C<$_> is the name of something of C<$type>, which
186 should be either a glob slot name (e.g. SCALAR) or the special value
187 "VARIABLE", meaning an array, hash, or scalar.
195 local $_ = /^::/ ?
$_ : "::$_";
196 defined *{$_}{CODE
} || defined *{$_}{IO
} || (/::$/ && %$_);
199 ## XXX: Careful about autovivification here! Specifically:
200 ## defined *FOO{HASH} # => ''
201 ## defined %FOO # => ''
202 ## defined *FOO{HASH} # => 1
207 local $_ = /^::/ ?
$_ : "::$_";
208 if ($type eq 'SCALAR') {
210 } elsif ($type eq 'VARIABLE') {
211 defined $$_ || defined *{$_}{HASH
} || defined *{$_}{ARRAY
};
217 =item C<$re_out = maybe_icase $re_in>
219 Make C<$re_in> case-insensitive if it looks like it should be.
226 return '' if $ch eq '';
227 $ch =~ /[A-Z]/ ?
$ch : '['.uc($ch).$ch.']';
230 =item C<@res = all_abbrev_completions $pattern>
232 Find all "abbreviated completions" for $pattern.
236 sub all_abbrev_completions
238 use vars
'&_completions';
239 local *_completions
= sub {
241 my ($stash, @e) = @_;
242 my $ch = '[A-Za-z0-9]*';
243 my $re1 = "^".maybe_icase
($e[0]).$ch.join('', map {
244 '_'.maybe_icase
($_).$ch
247 my $re2 = maybe_icase
$e[0];
248 $re2 = qr/^$re2.*::$/;
249 my @ret = grep !/::$/ && /$re1/, keys %{$stash};
250 my @pkgs = grep /$re2/, keys %{$stash};
251 (map("$stash$_", @ret),
252 @e > 1 ?
map { _completions
"$stash$_", @e[1..$#e] } @pkgs :
253 map { "$stash$_" } @pkgs)
255 map { s/^:://; $_ } _completions
('::', split //, shift);
260 my ($icase, $re) = @_;
262 $icase ?
qr/^$re.*$/i : qr/^$re.*$/;
267 my $icase = $_[0] !~ /[A-Z]/;
268 my @parts = split /:+/, shift, -1;
269 my $re = apropos_re
$icase, pop @parts;
270 use vars
'&_completions';
271 local *_completions
= sub {
275 map { "$stash$_" } grep /$re/, keys %{$stash};
277 my $re2 = $icase ?
qr/^$_[0].*::$/i : qr/^$_[0].*::$/;
278 my @pkgs = grep /$re2/, keys %{$stash};
279 map { _completions
"$stash$_", @_[1..$#_] } @pkgs
282 map { s/^:://; $_ } _completions
('::', @parts);
285 =item C<@res = filter_exact_prefix @names>
287 Filter exact matches so that e.g. "A::x" completes to "A::xx" when
288 both "Ay::xx" and "A::xx" exist.
292 sub filter_exact_prefix
294 my @parts = split /:+/, shift, -1;
297 my $pre = shift @parts;
298 while (@parts && (@tmp = grep /^\Q$pre\E(?:::|$)/, @res)) {
300 $pre .= '::'.shift @parts;
305 =item C<@res = lexical_completions $type, $str, $sub>
307 Find lexicals of C<$sub> (or a parent lexical environment) of type
308 C<$type> matching C<$str>.
312 sub lexical_completions
314 eval q{ use PadWalker 'peek_sub' };
315 # "internal" function, so don't warn on failure
317 *lexical_completions
= sub {
318 my ($type, $str, $sub) = @_;
319 $sub = "$PACKAGE\::$sub" unless $sub =~ /::/;
320 # warn "Completing $str of type $type in $sub\n";
322 return unless defined *{$sub}{CODE
};
323 my $pad = peek_sub
(\
&$sub);
325 map { s/^[\$\@&\%]//;$_ } grep /^\Q$type$str\E/, keys %$pad;
327 map { s/^[\$\@&\%]//;$_ } grep /^.\Q$str\E/, keys %$pad;
330 goto &lexical_completions
;
333 =item C<@compls = completions($string [, $type [, $sub ] ])>
335 Find a list of completions for C<$string> with glob type C<$type>,
336 which may be "SCALAR", "HASH", "ARRAY", "CODE", "IO", or the special
337 value "VARIABLE", which means either scalar, hash, or array.
338 Completion operates on word subparts separated by [:_], so
339 e.g. "S:m_w" completes to "Sepia::my_walksymtable". If C<$sub> is
340 given, also consider its lexical variables.
342 =item C<@compls = method_completions($expr, $string [,$eval])>
344 Complete among methods on the object returned by C<$expr>. The
345 C<$eval> argument, if present, is a function used to do the
346 evaluation; the default is C<eval>, but for example the Sepia REPL
347 uses C<Sepia::repl_eval>. B<Warning>: Since it has to evaluate
348 C<$expr>, method completion can be extremely problematic. Use with
355 my ($type, $str, $sub) = @_;
357 my %h = qw(@ ARRAY % HASH & CODE * IO $ SCALAR);
360 $t = $type ?
$rh{$type} : '';
362 if ($sub && $type ne '') {
363 @ret = lexical_completions
$t, $str, $sub;
367 $type ? filter_typed
$type : filter_untyped
368 } all_completions
$str;
370 if (!@ret && $str !~ /:/) {
372 $type ? filter_typed
$type : filter_untyped
373 } all_abbrev_completions
$str;
375 @ret = map { s/^:://; "$t$_" } filter_exact_prefix
$str, @ret;
376 # ## XXX: Control characters, $", and $1, etc. confuse Emacs, so
379 length $_ > 0 && !/^\d+$/ && !/^[^\w\d_]$/ && !/^_</ && !/^[[:cntrl:]]/
383 sub method_completions
385 my ($x, $fn, $eval) = @_;
388 $eval ||= 'CORE::eval';
390 return unless ($x =~ /^\$/ && ($x = $eval->("ref($x)")))
391 || $eval->('%'.$x.'::');
393 my $re = _apropos_re
$fn;
394 ## Filter out overload methods "(..."
395 return sort { $a cmp $b } map { s/.*:://; $_ }
396 grep { defined *{$_}{CODE
} && /::$re/ && !/\(/ }
401 =item C<@matches = apropos($name [, $is_regex])>
403 Search for function C<$name>, either in all packages or, if C<$name>
404 is qualified, only in one package. If C<$is_regex> is true, the
405 non-package part of C<$name> is a regular expression.
409 sub my_walksymtable
(&*)
415 &$f for keys %$stash;
416 _walk
("$stash$_") for grep /(?<!main)::$/, keys %$stash;
423 my ($it, $re, @types) = @_;
426 $stashp = grep /STASH/, @types;
427 @types = grep !/STASH/, @types;
432 if ($it =~ /^(.*::)([^:]+)$/) {
433 my ($stash, $name) = ($1, $2);
438 my $name = qr/^$name/;
443 my $stashnm = "$stash$_";
447 defined($_ eq 'SCALAR' ?
$$stashnm : *{$stashnm}{$_})
451 defined &$it ?
$it : ();
455 my $findre = $re ?
qr/$it/ : qr/^\Q$it\E$/;
457 push @ret, "$stash$_" if /$findre/;
459 map { s/^:*(?:main:+)*//;$_ } @ret;
465 =head2 Module information
469 =item C<@names = mod_subs($pack)>
471 Find subs in package C<$pack>.
479 my $stash = \
%{"$p\::"};
481 grep { defined &{"$p\::$_"} } keys %$stash;
485 =item C<@decls = mod_decls($pack)>
487 Generate a list of declarations for all subroutines in package
498 my $proto = prototype(\
&{"$pack\::$sn"});
499 $proto = defined($proto) ?
"($proto)" : '';
502 return wantarray ?
@ret : join '', @ret;
505 =item C<$info = module_info($module, $type)>
507 Emacs-called function to get module information.
513 eval q{ require Module::Info; import Module::Info };
522 $info = Module
::Info
->new_from_file($m);
524 (my $file = $m) =~ s
|::|/|g
;
526 if (exists $INC{$file}) {
527 $info = Module
::Info
->new_from_loaded($m);
529 $info = Module
::Info
->new_from_module($m);
540 =item C<$file = mod_file($mod)>
542 Find the likely file owner for module C<$mod>.
550 while ($m && !exists $INC{"$m.pm"}) {
551 $m =~ s
#(?:^|/)[^/]+$##;
553 $m ?
$INC{"$m.pm"} : undef;
556 =item C<@mods = package_list>
558 Gather a list of all distributions on the system.
566 require ExtUtils
::Installed
;
567 $INST = new ExtUtils
::Installed
;
574 sort { $a cmp $b } inst
()->modules;
577 =item C<@mods = module_list>
579 Gather a list of all packages (.pm files, really) installed on the
580 system, grouped by distribution. XXX UNUSED
586 join '|', map quotemeta, sort { length $b <=> length $a } @INC;
591 @_ = package_list
unless @_;
593 $incre = qr
|(?
:$incre)/|;
597 s/$incre\///; s|/|::|g
;$_
598 } grep /\.pm$/, $inst->files($_)]
602 =item C<@paths = file_list $module>
604 List the absolute paths of all files (except man pages) installed by
611 my @ret = eval { grep /\.p(l|m|od)$/, inst
->files(shift) };
615 =item C<@mods = doc_list>
617 Gather a list of all documented packages (.?pm files, really)
618 installed on the system, grouped by distribution. XXX UNUSED
626 @_ = package_list
unless @_;
630 s/.*man.\///; s|/|::|g
;s/\..?pm//; $_
631 } grep /\..pm$/, $inst->files($_)]
635 =head2 Miscellaneous functions
639 =item C<$v = core_version($module)>
645 eval q{ require Module::CoreList };
649 *core_version
= sub { Module
::CoreList
->first_release(@_) };
654 =item C<[$file, $line, $name] = location($name)>
656 Return a [file, line, name] triple for function C<$name>.
664 if (my ($pfx, $name) = /^([\%\$\@]?)(.+)/) {
666 warn "Sorry -- can't lookup variables.";
668 # XXX: svref_2object only seems to work with a package
669 # tacked on, but that should probably be done elsewhere...
670 $name = 'main::'.$name unless $name =~ /::/;
671 my $cv = B
::svref_2object
(\
&{$name});
672 if ($cv && defined($cv = $cv->START) && !$cv->isa('B::NULL')) {
673 my ($file, $line) = ($cv->file, $cv->line);
674 if ($file !~ /^\//) {
676 if (!ref $_ && -f
"$_/$file") {
682 my ($shortname) = $name =~ /^(?:.*::)([^:]+)$/;
683 return [Cwd
::abs_path
($file), $line, $shortname || $name]
691 =item C<lexicals($subname)>
693 Return a list of C<$subname>'s lexical variables. Note that this
694 includes all nested scopes -- I don't know if or how Perl
695 distinguishes inner blocks.
701 my $cv = B
::svref_2object
(\
&{+shift});
702 return unless $cv && ($cv = $cv->PADLIST);
703 my ($names, $vals) = $cv->ARRAY;
705 my $name = $_->PV; $name =~ s/\0.*$//; $name
706 } grep B
::class($_) ne 'SPECIAL', $names->ARRAY;
709 =item C<$lisp = tolisp($perl)>
711 Convert a Perl scalar to some ELisp equivalent.
717 my $thing = @_ == 1 ?
shift : \
@_;
720 if (!defined $thing) {
722 } elsif (looks_like_number
$thing) {
725 ## XXX Elisp and perl have slightly different
726 ## escaping conventions, so we do this crap instead.
727 $thing =~ s/["\\]/\\$1/g;
730 } elsif ($t eq 'GLOB') {
731 (my $name = $$thing) =~ s/\*main:://;
733 } elsif ($t eq 'ARRAY') {
734 '(' . join(' ', map { tolisp
($_) } @
$thing).')'
735 } elsif ($t eq 'HASH') {
736 '(' . join(' ', map {
737 '(' . tolisp
($_) . " . " . tolisp
($thing->{$_}) . ')'
739 } elsif ($t eq 'Regexp') {
740 "'(regexp . \"" . quotemeta($thing) . '")';
741 # } elsif ($t eq 'IO') {
747 =item C<printer(\@res)>
749 Print C<@res> appropriately on the current filehandle. If C<$ISEVAL>
750 is true, use terse format. Otherwise, use human-readable format,
751 which can use either L<Data::Dumper>, L<YAML>, or L<Data::Dump>.
757 eval q{ require Data::Dumper };
758 local $Data::Dumper
::Deparse
= 1;
759 local $Data::Dumper
::Indent
= 0;
761 my $thing = @res > 1 ? \
@res : $res[0];
763 $_ = Data
::Dumper
::Dumper
($thing);
765 if (length $_ > ($ENV{COLUMNS
} || 80)) {
766 $Data::Dumper
::Indent
= 1;
768 $_ = Data
::Dumper
::Dumper
($thing);
779 if (eval q{require 'dumpvar.pl';1}) {
780 dumpvar
::veryCompact
(1);
781 $PRINTER{dumpvar
} = sub { dumpValue
(\
@res) };
782 goto &{$PRINTER{dumpvar
}};
786 eval q{ require YAML };
788 $PRINTER{dumper
}->();
794 eval q{ require Data::Dump };
796 $PRINTER{dumper
}->();
798 Data
::Dump
::dump(\
@res);
807 $PRINTER{dumper
}->();
809 my $ret = new IO
::Scalar
;
810 my $out = select $ret;
811 Devel
::Peek
::Dump
(@res == 1 ?
$res[0] : \
@res);
832 $_ = @res == 1 ?
$res[0] : @res == 0 ?
undef : [@res];
836 } elsif (@res == 1 && !$ISEVAL && $STRINGIFY
837 && UNIVERSAL
::can
($res[0], '()')) {
840 } elsif (!$ISEVAL && $COLUMNATE && @res > 1 && !grep ref, @res) {
841 $res = columnate
(@res);
845 $res = $PRINTER{$PRINTER}->();
848 print ';;;', length $res, "\n$res\n";
863 =item C<prompt()> -- Print the REPL prompt.
869 run_hook
@PRE_PROMPT;
870 "$PACKAGE $WANTARRAY$PS1"
876 Data
::Dumper
->Dump([$_[0]], [$_[1]]);
880 =item C<$flowed = flow($width, $text)> -- Flow C<$text> to at most C<$width> columns.
886 my $width = shift()-2;
887 my $format = "^" . ('<' x
$width) . "~~\n";
889 formline($format, @_);
899 =item C<load \@keyvals> -- Load persisted data in C<@keyvals>.
901 =item C<$ok = saveable $name> -- Return whether C<$name> is saveable.
903 Saving certain magic variables leads to badness, so we avoid them.
905 =item C<\@kvs = save $re> -- Return a list of name/value pairs to save.
916 *{$_->[0]} = $_->[1];
921 undef @BADVARS{qw(%INC @INC %SIG @ISA %ENV @ARGV)};
927 return !/^.[^c-zA-Z]$/ # single-letter stuff (match vars, $_, etc.)
928 && !/^.[\0-\060]/ # magic weirdness.
929 && !/^._</ # debugger info
930 && !exists $BADVARS{$_}; # others.
937 $re = qr/(?:^|::)$re/;
938 no strict; # no kidding...
941 || $stash =~ /^(?:::)?(?:warnings|Config|strict|B)\b/;
943 my $name = "$stash$_";
944 if (defined ${$name} and saveable '$'.$_) {
945 push @save, [$name, \$$name];
947 if (defined *{$name}{HASH} and saveable '%'.$_) {
948 push @save, [$name, \%{$name}];
950 if (defined *{$name}{ARRAY} and saveable '@'.$_) {
951 push @save, [$name, \@{$name}];
955 print STDERR "$_->[0] " for @save;
960 =head2 REPL shortcuts
962 The function implementing built-in REPL shortcut ",X" is named C<repl_X>.
966 =item C<define_shortcut $name, $sub [, $doc [, $shortdoc]]>
968 Define $name as a shortcut for function $sub.
974 my ($name, $doc, $short, $fn);
980 ($name, $fn, $doc) = @_;
983 ($name, $fn, $short, $doc) = @_;
986 $REPL_DOC{$name} = $doc;
987 $REPL_SHORT{$name} = $short;
988 abbrev \%RK, keys %REPL;
991 =item C<alias_shortcut $new, $old>
993 Alias $new to do the same as $old.
999 my ($new, $old) = @_;
1000 $REPL{$new} = $REPL{$old};
1001 $REPL_DOC{$new} = $REPL_DOC{$old};
1002 ($REPL_SHORT{$new} = $REPL_SHORT{$old}) =~ s/^\Q$old\E/$new/;
1003 abbrev %RK, keys %REPL;
1006 =item C<define_shortcuts()>
1008 Define the default REPL shortcuts.
1012 sub define_shortcuts
1014 define_shortcut 'help', \&Sepia::repl_help,
1016 'Display help on all commands or CMD.';
1017 define_shortcut 'cd', \&Sepia::repl_chdir,
1018 'cd DIR', 'Change directory to DIR';
1019 define_shortcut 'pwd', \&Sepia::repl_pwd,
1020 'Show current working directory';
1021 define_shortcut 'methods', \&Sepia::repl_methods,
1023 'List methods for reference or package X, matching optional pattern RE';
1024 define_shortcut 'package', \&Sepia::repl_package,
1025 'package PKG', 'Set evaluation package to PKG';
1026 define_shortcut 'who', \&Sepia::repl_who,
1028 'List variables and subs in PKG matching optional pattern RE.';
1029 define_shortcut 'wantarray', \&Sepia::repl_wantarray,
1030 'wantarray [0|1]', 'Set or toggle evaluation context';
1031 define_shortcut 'format', \&Sepia::repl_format,
1032 'format [TYPE]', "Set output format to TYPE ('dumper', 'dump', 'yaml', or 'plain'; default: 'dumper') or show current type.";
1033 define_shortcut 'strict', \&Sepia::repl_strict,
1034 'strict [0|1]', 'Turn \'use strict\' mode on or off';
1035 define_shortcut 'quit', \&Sepia::repl_quit,
1037 alias_shortcut 'exit', 'quit';
1038 define_shortcut 'restart', \&Sepia::repl_restart,
1039 'Reload Sepia.pm and relaunch the REPL.';
1040 define_shortcut 'shell', \&Sepia::repl_shell,
1041 'shell CMD ...', 'Run CMD in the shell';
1042 define_shortcut 'eval', \&Sepia::repl_eval,
1043 'eval EXP', '(internal)';
1044 define_shortcut 'size', \&Sepia::repl_size,
1046 'List total sizes of objects in PKG matching optional pattern RE.';
1047 define_shortcut define => \&Sepia::repl_define,
1048 'define NAME [\'DOC\'] BODY',
1049 'Define NAME as a shortcut executing BODY';
1050 define_shortcut undef => \&Sepia::repl_undef,
1051 'undef NAME', 'Undefine shortcut NAME';
1052 define_shortcut test => \&Sepia::repl_test,
1053 'test FILE...', 'Run tests interactively.';
1054 define_shortcut load => \&Sepia::repl_load,
1055 'load [FILE]', 'Load state from FILE.';
1056 define_shortcut save => \&Sepia::repl_save,
1057 'save [PATTERN [FILE]]', 'Save variables matching PATTERN to FILE.';
1058 define_shortcut reload => \&Sepia::repl_reload,
1059 'reload [MODULE | /RE/]', 'Reload MODULE or all modules matching RE.';
1060 define_shortcut freload => \&Sepia::repl_full_reload,
1061 'freload MODULE', 'Reload MODULE and all its dependencies.';
1062 define_shortcut time => \&Sepia::repl_time,
1063 'time [0|1]', 'Print timing information for each command.';
1064 define_shortcut lsmod => \&Sepia::repl_lsmod,
1065 'lsmod [PATTERN]', 'List loaded modules matching PATTERN.';
1068 =item C<repl_strict([$value])>
1070 Toggle strict mode. Requires L<PadWalker> and L<Devel::LexAlias>.
1076 eval q{ use PadWalker qw(peek_sub set_closed_over);
1077 use Devel
::LexAlias
'lexalias';
1080 print "Strict mode requires PadWalker and Devel::LexAlias.\n";
1082 *repl_strict
= sub {
1083 my $x = as_boolean
(shift, $STRICT);
1084 if ($x && !$STRICT) {
1096 eval q{ require Devel::Size };
1098 print "Size requires Devel::Size.\n";
1100 *Sepia
::repl_size
= sub {
1101 my ($pkg, $re) = split ' ', shift, 2;
1104 } elsif (!$re && $pkg =~ /^\/(.*?
)\
/?$/) {
1111 if ($STRICT && !$pkg) {
1112 @who = grep /$re/, keys %$STRICT;
1114 $res{$_} = Devel
::Size
::total_size
($Sepia::STRICT
->{$_});
1119 @who = who
($pkg, $re);
1121 next unless /^[\$\@\%\&]/; # skip subs.
1122 next if $_ eq '%SIG';
1123 $res{$_} = eval "no strict; package $pkg; Devel::Size::total_size \\$_;";
1126 my $len = max
(3, map { length } @who) + 4;
1127 my $fmt = '%-'.$len."s%10d\n";
1128 # print "$pkg\::/$re/\n";
1129 print 'Var', ' ' x
($len + 2), "Bytes\n";
1130 print '-' x
($len-4), ' ' x
9, '-' x
5, "\n";
1131 for (sort { $res{$b} <=> $res{$a} } keys %res) {
1132 printf $fmt, $_, $res{$_};
1139 =item C<repl_time([$value])>
1141 Toggle command timing.
1145 my ($time_res, $TIME);
1146 sub time_pre_prompt_bsd
1148 printf "(%.2gr, %.2gu, %.2gs) ", @
{$time_res} if defined $time_res;
1151 sub time_pre_prompt_plain
1153 printf "(%.2gs) ", $time_res if defined $time_res;
1158 $TIME = as_boolean
(shift, $TIME);
1160 print STDERR
"Removing time hook.\n";
1161 remove_hook
@PRE_PROMPT, 'Sepia::time_pre_prompt';
1162 remove_hook
@PRE_EVAL, 'Sepia::time_pre_eval';
1163 remove_hook
@POST_EVAL, 'Sepia::time_post_eval';
1166 print STDERR
"Adding time hook.\n";
1167 add_hook
@PRE_PROMPT, 'Sepia::time_pre_prompt';
1168 add_hook
@PRE_EVAL, 'Sepia::time_pre_eval';
1169 add_hook
@POST_EVAL, 'Sepia::time_post_eval';
1170 my $has_bsd = eval q{ use BSD::Resource 'getrusage';1 };
1171 my $has_hires = eval q{ use Time::HiRes qw(gettimeofday tv_interval);1 };
1173 if ($has_bsd) { # sweet! getrusage!
1174 my ($user, $sys, $real);
1175 *time_pre_eval
= sub {
1177 ($user, $sys) = getrusage
();
1178 $real = $has_hires ?
[gettimeofday
()] : $user+$sys;
1180 *time_post_eval
= sub {
1181 my ($u2, $s2) = getrusage
();
1182 $time_res = [$has_hires ? tv_interval
($real, [gettimeofday
()])
1183 : $s2 + $u2 - $real,
1184 ($u2 - $user), ($s2 - $sys)];
1186 *time_pre_prompt
= *time_pre_prompt_bsd
;
1187 } elsif ($has_hires) { # at least we have msec...
1188 *time_pre_eval
= sub {
1190 $t0 = [gettimeofday
()];
1192 *time_post_eval
= sub {
1193 $time_res = tv_interval
($t0, [gettimeofday
()]);
1195 *time_pre_prompt
= *time_pre_prompt_plain
;
1197 *time_pre_eval
= sub {
1201 *time_post_eval
= sub {
1202 $time_res = (time - $t0);
1204 *time_pre_prompt
= *time_pre_prompt_plain
;
1210 my $width = $ENV{COLUMNS
} || 80;
1212 if ($args =~ /\S/) {
1215 my $full = $RK{$args};
1217 my $short = $REPL_SHORT{$full};
1218 my $flow = flow
($width - length($short) - 4, $REPL_DOC{$full});
1220 $flow =~ s/(.)\n/"$1\n".(' 'x (4 + length $short))/eg;
1221 print "$short $flow\n";
1223 print "$args: no such command\n";
1226 my $left = 1 + max
map length, values %REPL_SHORT;
1227 print "REPL commands (prefixed with ','):\n";
1229 for (sort keys %REPL) {
1230 my $flow = flow
($width - $left, $REPL_DOC{$_});
1232 $flow =~ s/(.)\n/"$1\n".(' ' x $left)/eg;
1233 printf "%-${left}s%s\n", $REPL_SHORT{$_}, $flow;
1241 my ($name, $doc, $body);
1242 if (/^\s*(\S+)\s+'((?:[^'\\]|\\.)*)'\s+(.+)/) {
1243 ($name, $doc, $body) = ($1, $2, $3);
1244 } elsif (/^\s*(\S+)\s+(\S.*)/) {
1245 ($name, $doc, $body) = ($1, $2, $2);
1247 print "usage: define NAME ['doc'] BODY...\n";
1250 my $sub = eval "sub { do { $body } }";
1252 print "usage: define NAME ['doc'] BODY...\n\t$@\n";
1255 define_shortcut
$name, $sub, $doc;
1256 # %RK = abbrev keys %REPL;
1264 my $full = $RK{$name};
1266 delete $REPL{$full};
1267 delete $REPL_SHORT{$full};
1268 delete $REPL_DOC{$full};
1269 abbrev \
%RK, keys %REPL;
1271 print "$name: no such shortcut.\n";
1280 print "printer = $PRINTER, columnate = @{[$COLUMNATE ? 1 : 0]}\n";
1282 my %formats = abbrev
keys %PRINTER;
1283 if (exists $formats{$t}) {
1284 $PRINTER = $formats{$t};
1286 warn "No such format '$t' (dumper, dump, yaml, plain).\n";
1293 chomp(my $dir = shift);
1294 $dir =~ s/^~\//$ENV{HOME
}\
//;
1295 $dir =~ s/\$HOME/$ENV{HOME}/;
1298 my $ecmd = '(cd "'.Cwd
::getcwd
().'")';
1299 print ";;;###".length($ecmd)."\n$ecmd\n";
1301 warn "Can't chdir\n";
1307 print Cwd
::getcwd
(), "\n";
1310 =item C<who($package [, $re])>
1312 List variables and functions in C<$package> matching C<$re>, or all
1313 variables if C<$re> is absent.
1319 my ($pack, $re_str) = @_;
1321 my $re = qr/$re_str/;
1323 if ($re_str =~ /^[\$\@\%\&]/) {
1324 ## sigil given -- match it
1325 sort grep /$re/, map {
1326 my $name = $pack.'::'.$_;
1327 (defined *{$name}{HASH
} ?
'%'.$_ : (),
1328 defined *{$name}{ARRAY
} ?
'@'.$_ : (),
1329 defined *{$name}{CODE
} ?
$_ : (),
1330 defined ${$name} ?
'$'.$_ : (), # ?
1332 } grep !/::$/ && !/^(?:_<|[^\w])/ && /$re/, keys %{$pack.'::'};
1334 ## no sigil -- don't match it
1336 my $name = $pack.'::'.$_;
1337 (defined *{$name}{HASH
} ?
'%'.$_ : (),
1338 defined *{$name}{ARRAY
} ?
'@'.$_ : (),
1339 defined *{$name}{CODE
} ?
$_ : (),
1340 defined ${$name} ?
'$'.$_ : (), # ?
1342 } grep !/::$/ && !/^(?:_<|[^\w])/ && /$re/, keys %{$pack.'::'};
1346 =item C<$text = columnate(@items)>
1348 Format C<@items> in columns such that they fit within C<$ENV{COLUMNS}>
1356 my $width = $ENV{COLUMNS
} || 80;
1358 $len = length if $len < length;
1360 my $nc = int($width / ($len+1)) || 1;
1361 my $nr = int(@_ / $nc) + (@_ % $nc ?
1 : 0);
1362 my $fmt = ('%-'.($len+1).'s') x
($nc-1) . "%s\n";
1363 my @incs = map { $_ * $nr } 0..$nc-1;
1365 for my $r (0..$nr-1) {
1366 $str .= sprintf $fmt, map { defined($_) ?
$_ : '' }
1367 @_[map { $r + $_ } @incs];
1375 my ($pkg, $re) = split ' ', shift, 2;
1378 } elsif (!$re && $pkg =~ /^\/(.*?
)\
/?$/) {
1385 if ($STRICT && !$pkg) {
1386 @x = grep /$re/, keys %$STRICT;
1390 @x = who
($pkg, $re);
1392 print($pkg, "::/$re/\n", columnate
@x) if @x;
1395 =item C<@m = methods($package [, $qualified])>
1397 List method names in C<$package> and its parents. If C<$qualified>,
1398 return full "CLASS::NAME" rather than just "NAME."
1404 my ($pack, $qualified) = @_;
1406 my @own = $qualified ?
grep {
1408 } map { "$pack\::$_" } keys %{$pack.'::'}
1410 defined &{"$pack\::$_"}
1411 } keys %{$pack.'::'};
1412 if (exists ${$pack.'::'}{ISA
} && *{$pack.'::ISA'}{ARRAY
}) {
1414 undef @m{@own, map methods
($_, $qualified), @
{$pack.'::ISA'}};
1422 my ($x, $re) = split ' ', shift;
1426 $x = $REPL{eval}->("ref $x");
1431 print columnate
sort { $a cmp $b } grep /$re/, methods
$x;
1436 my ($val, $cur) = @_;
1438 length($val) ?
$val : !$cur;
1443 (my $val = $_[0]) =~ s/\s+//g;
1445 $WANTARRAY = ($WANTARRAY eq '@' ?
'$' : '@');
1447 $WANTARRAY = $val ?
'@' : '$';
1453 chomp(my $p = shift);
1465 do $INC{'Sepia.pm'};
1467 print "Restart failed:\n$@\n";
1469 $REPL_LEVEL = 0; # ok?
1480 # Stolen from Lexical::Persistence, then simplified.
1485 # steal any new "my" variables
1486 my $pad = peek_sub
($sub);
1487 for my $k (keys %$pad) {
1488 unless (exists $STRICT->{$k}) {
1490 $STRICT->{$k} = \
(my $x);
1491 } elsif ($k =~ /^\@/) {
1493 } elsif ($k =~ /^\%/) {
1494 $STRICT->{$k} = +{};
1500 lexalias
($sub, $_, $STRICT->{$_}) for keys %$STRICT;
1508 # local $PACKAGE = $pkg || $PACKAGE;
1510 my $ctx = join(',', keys %$STRICT);
1511 $ctx = $ctx ?
"my ($ctx);" : '';
1512 if ($WANTARRAY eq '$') {
1513 $buf = 'scalar($buf)';
1514 } elsif ($WANTARRAY ne '@') {
1517 $buf = eval "sub { package $PACKAGE; use strict; $ctx $buf }";
1519 print "ERROR\n$@\n";
1524 $buf = "do { package $PACKAGE; no strict; $buf }";
1525 if ($WANTARRAY eq '@') {
1527 } elsif ($WANTARRAY eq '$') {
1544 } elsif (-f
"t/$buf") {
1551 wanted
=> sub { push @files, $_ if /\.t$/ }
1552 }, Cwd
::getcwd
() =~ /t\/?
$/ ? '.' : './t
');
1555 # XXX: this is cribbed from an EU::MM-generated Makefile.
1556 system $^X, qw(-MExtUtils::Command::MM -e),
1557 "test_harness(0, 'blib/lib', 'blib/arch')", @files;
1559 print "No test files for '$buf' in ", Cwd
::getcwd
, "\n";
1565 my ($file) = split ' ', shift;
1566 $file ||= "$ENV{HOME}/.sepia-save";
1568 load
(Storable
::retrieve
($file));
1573 my ($re, $file) = split ' ', shift;
1575 $file ||= "$ENV{HOME}/.sepia-save";
1577 Storable
::store
(save
($re)), $file;
1580 sub modules_matching
1583 if ($pat =~ /^\/(.*)\
/?$/) {
1587 grep /$pat/, keys %INC;
1591 exists $INC{"$pat.pm"} ?
"$pat.pm" : ();
1597 my %save_inc = %INC;
1599 for my $name (modules_matching
$_[0]) {
1600 print STDERR
"full reload $name\n";
1603 my @ret = keys %INC;
1604 while (my ($k, $v) = each %save_inc) {
1610 sub repl_full_reload
1612 chomp (my $pat = shift);
1613 my @x = full_reload
$pat;
1614 print "Reloaded: @x\n";
1619 chomp (my $pat = shift);
1620 # for my $name (modules_matching $pat) {
1621 # delete $INC{$PAT};
1622 # eval "require $name";
1624 # (my $mod = $name) =~ s/
1625 if ($pat =~ /^\/(.*)\
/?$/) {
1643 if (exists $INC{$pat}) {
1645 eval 'require $mod';
1646 import
$mod unless $@
;
1647 print "Reloaded $mod.\n"
1649 print "$mod not loaded.\n"
1656 chomp (my $pat = shift);
1660 my $fmt = "%-20s%8s %s\n";
1661 # my $shorten = join '|', sort { length($a) <=> length($b) } @INC;
1663 # s/^(?:$shorten)\/?//; $_
1665 for (sort keys %INC) {
1669 next if /^::/ || !/$pat/;
1671 printf $fmt, qw(Module Version File);
1672 printf $fmt, qw(------ ------- ----);
1675 printf $fmt, $_, (UNIVERSAL
::VERSION
($_)||'???'), $INC{$file};
1678 print "No modules found.\n";
1682 =item C<sig_warn($warning)>
1684 Collect C<$warning> for later printing.
1686 =item C<print_warnings()>
1688 Print and clear accumulated warnings.
1704 print ';;;'.length($tmp)."\n$tmp\n";
1708 print "warning: $_\n";
1717 I need user feedback! Please send questions or comments to seano\@cpan.org.
1718 Sepia version $Sepia::VERSION.
1719 Type ",h" for help, or ",q" to quit.
1725 Execute a command interpreter on standard input and standard output.
1726 If you want to use different descriptors, localize them before
1727 calling C<repl()>. The prompt has a few bells and whistles, including:
1731 =item Obviously-incomplete lines are treated as multiline input (press
1732 'return' twice or 'C-c' to discard).
1734 =item C<die> is overridden to enter a debugging repl at the point
1739 Behavior is controlled in part through the following package-globals:
1743 =item C<$PACKAGE> -- evaluation package
1745 =item C<$PRINTER> -- result printer (default: dumper)
1747 =item C<$PS1> -- the default prompt
1749 =item C<$STRICT> -- whether 'use strict' is applied to input
1751 =item C<$WANTARRAY> -- evaluation context
1753 =item C<$COLUMNATE> -- format some output nicely (default = 1)
1755 Format some values nicely, independent of $PRINTER. Currently, this
1756 displays arrays of scalars as columns.
1758 =item C<$REPL_LEVEL> -- level of recursive repl() calls
1760 If zero, then initialization takes place.
1762 =item C<%REPL> -- maps shortcut names to handlers
1764 =item C<%REPL_DOC> -- maps shortcut names to documentation
1766 =item C<%REPL_SHORT> -- maps shortcut names to brief usage
1777 if ($REPL_LEVEL == 0) {
1779 -f
"$ENV{HOME}/.sepiarc" and eval qq#package $Sepia::PACKAGE; do "$ENV{HOME}/.sepiarc"#;
1780 warn ".sepiarc: $@\n" if $@
;
1782 Sepia
::Debug
::add_repl_commands
;
1783 repl_banner
if $REPL_LEVEL == 0;
1786 $READLINE = sub { print prompt
(); <STDIN
> };
1791 local $REPL_LEVEL = $REPL_LEVEL + 1;
1797 my $nextrepl = sub { $SIGGED++; };
1800 local *CORE
::GLOBAL
::die = \
&Sepia
::Debug
::die;
1801 local *CORE
::GLOBAL
::warn = \
&Sepia
::Debug
::warn;
1802 my @sigs = qw(INT TERM PIPE ALRM);
1804 $SIG{$_} = $nextrepl for @sigs;
1805 repl
: while (defined(my $in = $READLINE->())) {
1815 if ($buf =~ /^<<(\d+)\n(.*)/) {
1820 while ($len && defined($tmp = read STDIN
, $buf, $len, length $buf)) {
1824 ## Only install a magic handler if no one else is playing.
1825 local $SIG{__WARN__
} = $SIG{__WARN__
};
1827 unless ($SIG{__WARN__
}) {
1828 $SIG{__WARN__
} = 'Sepia::sig_warn';
1832 # repeat last interactive command
1838 if ($buf =~ /^,(\S+)\s*(.*)/s) {
1839 ## Inspector shortcuts
1841 if (exists $Sepia::RK
{$short}) {
1845 $Sepia::REPL
{$Sepia::RK
{$short}}->($arg, wantarray);
1847 if (grep /^$short/, keys %Sepia::REPL
) {
1848 print "Ambiguous shortcut '$short': ",
1849 join(', ', sort grep /^$short/, keys %Sepia::REPL
),
1852 print "Unrecognized shortcut '$short'\n";
1860 @res = $REPL{eval}->($buf);
1861 run_hook
@POST_EVAL;
1864 ## Always return results for an eval request
1865 Sepia
::printer \
@res, wantarray;
1866 Sepia
::printer
[$@
], wantarray;
1867 # print_warnings $ISEVAL;
1869 } elsif ($@
=~ /(?:at|before) EOF(?:$| at)/m) {
1870 ## Possibly-incomplete line
1872 print "Error:\n$@\n*** cancel ***\n";
1879 # $@ =~ s/(.*) at eval .*/$1/;
1880 # don't complain if we're abandoning execution
1881 # from the debugger.
1882 unless (ref $@
eq 'Sepia::Debug') {
1884 print "\n" unless $@
=~ /\n\z/;
1891 if ($buf !~ /;\s*$/ && $buf !~ /^,/) {
1892 ## Be quiet if it ends with a semicolon, or if we
1893 ## executed a shortcut.
1894 Sepia
::printer \
@res, wantarray;
1900 wantarray ?
@res : $res[0]
1905 tolisp
($REPL{eval}->(shift));
1908 =head2 Module browsing
1912 =item C<$status = html_module_list([$file [, $prefix]])>
1914 Generate an HTML list of installed modules, looking inside of
1915 packages. If C<$prefix> is missing, uses "about://perldoc/". If
1916 $file is given, write the result to $file; otherwise, return it as a
1919 =item C<$status = html_package_list([$file [, $prefix]])>
1921 Generate an HTML list of installed top-level modules, without looking
1922 inside of packages. If C<$prefix> is missing, uses
1923 "about://perldoc/". $file is the same as for C<html_module_list>.
1929 sub html_module_list
1931 my ($file, $base) = @_;
1932 $base ||= 'about://perldoc/';
1934 open OUT
, ">", $file || \
$out or return;
1935 print OUT
"<html><body>";
1938 my $incre = join '|', map quotemeta, sort { length $b <=> length $a } @INC;
1939 $incre = qr!^(?:$incre)/*(.+)!;
1943 return unless /\.p(?:m|od)$/ && -r
$_;
1944 $File::Find
::name
=~ /$incre/ and $fs{$1} = 1;
1946 for (sort keys %fs) {
1947 (my $name = $_) =~ s!/!::!g;
1948 $name =~ s/\.p(?:m|od)$//;
1949 print OUT
qq{<li
><a href
="$base$_">$name</a
>};
1951 print OUT
"</ul></body></html>\n";
1956 sub html_package_list
1958 my ($file, $base) = @_;
1959 return unless inst
();
1961 for (package_list
) {
1962 push @
{$ns{$1}}, $_ if /^([^:]+)/;
1964 $base ||= 'about://perldoc/';
1966 open OUT
, ">", $file || \
$out or return;
1967 print OUT
"<html><body><ul>";
1969 for (sort keys %ns) {
1970 if (@
{$ns{$_}} == 1) {
1972 qq{<li
><a href
="$base$ns{$_}[0]">$ns{$_}[0]</a
>};
1974 print OUT
qq{<li
><b
>$_</b
><ul
>};
1975 print OUT
qq{<li
><a href
="$base$_">$_</a
>}
1976 for sort @
{$ns{$_}};
1977 print OUT
qq{</ul
>};
1980 print OUT
"</ul></body></html>\n";
1987 my $re = _apropos_re
$_[0], 1;
1991 for ($inst->files('Perl', 'prog'), package_list
) {
1992 if (/\.\d?(?:pm)?$/ && !/man1/ && !/usr\/bin
/ && /$re/) {
1997 s/\.\d?(?:p[lm])?$//;
2007 my @q = $REQUIRES{$mod};
2012 push @q, @
{$REQUIRES{$m}};
2020 @
{$REQUIRED_BY{$mod}}
2028 See the README file included with the distribution.
2032 Sepia's public GIT repository is located at L<http://repo.or.cz/w/sepia.git>.
2034 There are several modules for Perl development in Emacs on CPAN,
2035 including L<Devel::PerlySense> and L<PDE>. For a complete list, see
2036 L<http://emacswiki.org/cgi-bin/wiki/PerlLanguage>.
2040 Sean O'Rourke, E<lt>seano@cpan.orgE<gt>
2042 Bug reports welcome, patches even more welcome.
2046 Copyright (C) 2005-2011 Sean O'Rourke. All rights reserved, some
2047 wrongs reversed. This module is distributed under the same terms as