« back to all changes in this revision
Viewing changes to src/urxvt.pm
- browse files at revision 34
- compare with another revision
- download diff
- download tarball
- view history from revision 34
- Committer: Package Import Robot
- Author(s): Ryan Kavanagh
- Date: 2013-05-26 18:12:22 UTC
- mfrom: (33.1.2 experimental)
- Revision ID: package-import@ubuntu.com-20130526181222-67glcv7nppi4ih7r
Tags: 9.18-2
* Upload to unstable now that wheezy has been released
* Merge in patch from gregor herrman fixing a FTBFS due to POD errors
(Closes: #708026)
* Merge in patch from gregor herrman fixing a FTBFS due to POD errors
(Closes: #708026)
- files added:
- .pc/11_fix_lexgrog.diff/src
- .pc/11_fix_lexgrog.diff/src/perl
- .pc/13_section_mismatch.diff
- .pc/13_section_mismatch.diff/src
- .pc/14_pod_errors.diff
- .pc/14_pod_errors.diff/doc
- files removed:
- doc/rxvtperl.3.man.in
- libecb
- files modified:
- .pc/01_app-defaults.diff/src/rxvttoolkit.C
added
removed
src/urxvt.pm
2
2
3
3
=head1 NAME
4
4
5
@@RXVT_NAME@@perl - rxvt-unicode's embedded perl interpreter
5
urxvtperl - rxvt-unicode's embedded perl interpreter
6
6
7
7
=head1 SYNOPSIS
8
8
13
13
()
14
14
}
15
15
16
# start a @@RXVT_NAME@@ using it:
16
# start a urxvt using it:
17
17
18
@@RXVT_NAME@@ --perl-lib $HOME -pe grab_test
18
urxvt --perl-lib $HOME -pe grab_test
19
19
20
20
=head1 DESCRIPTION
21
21
22
22
Every time a terminal object gets created, extension scripts specified via
23
23
the C<perl> resource are loaded and associated with it.
24
24
25
Scripts are compiled in a 'use strict' and 'use utf8' environment, and
25
Scripts are compiled in a 'use strict "vars"' and 'use utf8' environment, and
26
26
thus must be encoded as UTF-8.
27
27
28
Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
28
Each script will only ever be loaded once, even in urxvtd, where
29
29
scripts will be shared (but not enabled) for all terminals.
30
30
31
31
You can disable the embedded perl interpreter by setting both "perl-ext"
33
33
34
34
=head1 PREPACKAGED EXTENSIONS
35
35
36
This section describes the extensions delivered with this release. You can
37
find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
36
A number of extensions are delivered with this release. You can find them
37
in F<< <libdir>/urxvt/perl/ >>, and the documentation can be viewed using
38
F<< man urxvt-<EXTENSIONNAME> >>.
38
39
39
40
You can activate them like this:
40
41
41
@@RXVT_NAME@@ -pe <extensionname>
42
urxvt -pe <extensionname>
42
43
43
44
Or by adding them to the resource for extensions loaded by default:
44
45
45
46
URxvt.perl-ext-common: default,selection-autotransform
46
47
47
=over 4
48
49
=item selection (enabled by default)
50
51
(More) intelligent selection. This extension tries to be more intelligent
52
when the user extends selections (double-click and further clicks). Right
53
now, it tries to select words, urls and complete shell-quoted
54
arguments, which is very convenient, too, if your F<ls> supports
55
C<--quoting-style=shell>.
56
57
A double-click usually selects the word under the cursor, further clicks
58
will enlarge the selection.
59
60
The selection works by trying to match a number of regexes and displaying
61
them in increasing order of length. You can add your own regexes by
62
specifying resources of the form:
63
64
URxvt.selection.pattern-0: perl-regex
65
URxvt.selection.pattern-1: perl-regex
66
...
67
68
The index number (0, 1...) must not have any holes, and each regex must
69
contain at least one pair of capturing parentheses, which will be used for
70
the match. For example, the following adds a regex that matches everything
71
between two vertical bars:
72
73
URxvt.selection.pattern-0: \\|([^|]+)\\|
74
75
Another example: Programs I use often output "absolute path: " at the
76
beginning of a line when they process multiple files. The following
77
pattern matches the filename (note, there is a single space at the very
78
end):
79
80
URxvt.selection.pattern-0: ^(/[^:]+):\
81
82
You can look at the source of the selection extension to see more
83
interesting uses, such as parsing a line from beginning to end.
84
85
This extension also offers following bindable keyboard commands:
86
87
=over 4
88
89
=item rot13
90
91
Rot-13 the selection when activated. Used via keyboard trigger:
92
93
URxvt.keysym.C-M-r: perl:selection:rot13
94
95
=back
96
97
=item option-popup (enabled by default)
98
99
Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
100
runtime.
101
102
Other extensions can extend this popup menu by pushing a code reference
103
onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
104
popup is being displayed.
105
106
Its sole argument is the popup menu, which can be modified. It should
107
either return nothing or a string, the initial boolean value and a code
108
reference. The string will be used as button text and the code reference
109
will be called when the toggle changes, with the new boolean value as
110
first argument.
111
112
The following will add an entry C<myoption> that changes
113
C<< $self->{myoption} >>:
114
115
push @{ $self->{term}{option_popup_hook} }, sub {
116
("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117
};
118
119
=item selection-popup (enabled by default)
120
121
Binds a popup menu to Ctrl-Button3 that lets you convert the selection
122
text into various other formats/action (such as uri unescaping, perl
123
evaluation, web-browser starting etc.), depending on content.
124
125
Other extensions can extend this popup menu by pushing a code reference
126
onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
127
popup is being displayed.
128
129
Its sole argument is the popup menu, which can be modified. The selection
130
is in C<$_>, which can be used to decide whether to add something or not.
131
It should either return nothing or a string and a code reference. The
132
string will be used as button text and the code reference will be called
133
when the button gets activated and should transform C<$_>.
134
135
The following will add an entry C<a to b> that transforms all C<a>s in
136
the selection to C<b>s, but only if the selection currently contains any
137
C<a>s:
138
139
push @{ $self->{term}{selection_popup_hook} }, sub {
140
/a/ ? ("a to b" => sub { s/a/b/g }
141
: ()
142
};
143
144
=item searchable-scrollback<hotkey> (enabled by default)
145
146
Adds regex search functionality to the scrollback buffer, triggered
147
by a hotkey (default: C<M-s>). While in search mode, normal terminal
148
input/output is suspended and a regex is displayed at the bottom of the
149
screen.
150
151
Inputting characters appends them to the regex and continues incremental
152
search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
153
search upwards/downwards in the scrollback buffer, C<End> jumps to the
154
bottom. C<Escape> leaves search mode and returns to the point where search
155
was started, while C<Enter> or C<Return> stay at the current position and
156
additionally stores the first match in the current line into the primary
157
selection if the C<Shift> modifier is active.
158
159
The regex defaults to "(?i)", resulting in a case-insensitive search. To
160
get a case-sensitive search you can delete this prefix using C<BackSpace>
161
or simply use an uppercase character which removes the "(?i)" prefix.
162
163
See L<perlre> for more info about perl regular expression syntax.
164
165
=item readline (enabled by default)
166
167
A support package that tries to make editing with readline easier. At
168
the moment, it reacts to clicking shift-left mouse button by trying to
169
move the text cursor to this position. It does so by generating as many
170
cursor-left or cursor-right keypresses as required (this only works
171
for programs that correctly support wide characters).
172
173
To avoid too many false positives, this is only done when:
174
175
=over 4
176
177
=item - the tty is in ICANON state.
178
179
=item - the text cursor is visible.
180
181
=item - the primary screen is currently being displayed.
182
183
=item - the mouse is on the same (multi-row-) line as the text cursor.
184
185
=back
186
187
The normal selection mechanism isn't disabled, so quick successive clicks
188
might interfere with selection creation in harmless ways.
189
190
=item selection-autotransform
191
192
This selection allows you to do automatic transforms on a selection
193
whenever a selection is made.
194
195
It works by specifying perl snippets (most useful is a single C<s///>
196
operator) that modify C<$_> as resources:
197
198
URxvt.selection-autotransform.0: transform
199
URxvt.selection-autotransform.1: transform
200
...
201
202
For example, the following will transform selections of the form
203
C<filename:number>, often seen in compiler messages, into C<vi +$filename
204
$word>:
205
206
URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
207
208
And this example matches the same,but replaces it with vi-commands you can
209
paste directly into your (vi :) editor:
210
211
URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
212
213
Of course, this can be modified to suit your needs and your editor :)
214
215
To expand the example above to typical perl error messages ("XXX at
216
FILENAME line YYY."), you need a slightly more elaborate solution:
217
218
URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
219
URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
220
221
The first line tells the selection code to treat the unchanging part of
222
every error message as a selection pattern, and the second line transforms
223
the message into vi commands to load the file.
224
225
=item tabbed
226
227
This transforms the terminal into a tabbar with additional terminals, that
228
is, it implements what is commonly referred to as "tabbed terminal". The topmost line
229
displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
230
button per tab.
231
232
Clicking a button will activate that tab. Pressing B<Shift-Left> and
233
B<Shift-Right> will switch to the tab left or right of the current one,
234
while B<Shift-Down> creates a new tab.
235
236
The tabbar itself can be configured similarly to a normal terminal, but
237
with a resource class of C<URxvt.tabbed>. In addition, it supports the
238
following four resources (shown with defaults):
239
240
URxvt.tabbed.tabbar-fg: <colour-index, default 3>
241
URxvt.tabbed.tabbar-bg: <colour-index, default 0>
242
URxvt.tabbed.tab-fg: <colour-index, default 0>
243
URxvt.tabbed.tab-bg: <colour-index, default 1>
244
245
See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
246
indices.
247
248
=item matcher
249
250
Uses per-line display filtering (C<on_line_update>) to underline text
251
matching a certain pattern and make it clickable. When clicked with the
252
mouse button specified in the C<matcher.button> resource (default 2, or
253
middle), the program specified in the C<matcher.launcher> resource
254
(default, the C<urlLauncher> resource, C<sensible-browser>) will be started
255
with the matched text as first argument. The default configuration is
256
suitable for matching URLs and launching a web browser, like the
257
former "mark-urls" extension.
258
259
The default pattern to match URLs can be overridden with the
260
C<matcher.pattern.0> resource, and additional patterns can be specified
261
with numbered patterns, in a manner similar to the "selection" extension.
262
The launcher can also be overridden on a per-pattern basis.
263
264
It is possible to activate the most recently seen match or a list of matches
265
from the keyboard. Simply bind a keysym to "perl:matcher:last" or
266
"perl:matcher:list" as seen in the example below.
267
268
Example configuration:
269
270
URxvt.perl-ext: default,matcher
271
URxvt.urlLauncher: sensible-browser
272
URxvt.keysym.C-Delete: perl:matcher:last
273
URxvt.keysym.M-Delete: perl:matcher:list
274
URxvt.matcher.button: 1
275
URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
276
URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
277
URxvt.matcher.launcher.2: gvim +$2 $1
278
279
=item xim-onthespot
280
281
This (experimental) perl extension implements OnTheSpot editing. It does
282
not work perfectly, and some input methods don't seem to work well with
283
OnTheSpot editing in general, but it seems to work at least for SCIM and
284
kinput2.
285
286
You enable it by specifying this extension and a preedit style of
287
C<OnTheSpot>, i.e.:
288
289
@@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
290
291
=item kuake<hotkey>
292
293
A very primitive quake-console-like extension. It was inspired by a
294
description of how the programs C<kuake> and C<yakuake> work: Whenever the
295
user presses a global accelerator key (by default C<F10>), the terminal
296
will show or hide itself. Another press of the accelerator key will hide
297
or show it again.
298
299
Initially, the window will not be shown when using this extension.
300
301
This is useful if you need a single terminal that is not using any desktop
302
space most of the time but is quickly available at the press of a key.
303
304
The accelerator key is grabbed regardless of any modifiers, so this
305
extension will actually grab a physical key just for this function.
306
307
If you want a quake-like animation, tell your window manager to do so
308
(fvwm can do it).
309
310
=item overlay-osc
311
312
This extension implements some OSC commands to display timed popups on the
313
screen - useful for status displays from within scripts. You have to read
314
the sources for more info.
315
316
=item block-graphics-to-ascii
317
318
A not very useful example of filtering all text output to the terminal
319
by replacing all line-drawing characters (U+2500 .. U+259F) by a
320
similar-looking ascii character.
321
322
=item digital-clock
323
324
Displays a digital clock using the built-in overlay.
325
326
=item remote-clipboard
327
328
Somewhat of a misnomer, this extension adds two menu entries to the
329
selection popup that allows one to run external commands to store the
330
selection somewhere and fetch it again.
331
332
We use it to implement a "distributed selection mechanism", which just
333
means that one command uploads the file to a remote server, and another
334
reads it.
335
336
The commands can be set using the C<URxvt.remote-selection.store> and
337
C<URxvt.remote-selection.fetch> resources. The first should read the
338
selection to store from STDIN (always in UTF-8), the second should provide
339
the selection data on STDOUT (also in UTF-8).
340
341
The defaults (which are likely useless to you) use rsh and cat:
342
343
URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
344
URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
345
346
=item selection-pastebin
347
348
This is a little rarely useful extension that uploads the selection as
349
textfile to a remote site (or does other things). (The implementation is
350
not currently secure for use in a multiuser environment as it writes to
351
F</tmp> directly.).
352
353
It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
354
i.e.
355
356
URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
357
358
Pressing this combination runs a command with C<%> replaced by the name of
359
the textfile. This command can be set via a resource:
360
361
URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
362
363
And the default is likely not useful to anybody but the few people around
364
here :)
365
366
The name of the textfile is the hex encoded md5 sum of the selection, so
367
the same content should lead to the same filename.
368
369
After a successful upload the selection will be replaced by the text given
370
in the C<selection-pastebin-url> resource (again, the % is the placeholder
371
for the filename):
372
373
URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
374
375
I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
376
the double C</> characters as comment start. Use C<\057\057> instead,
377
which works regardless of whether xrdb is used to parse the resource file
378
or not.
379
380
=item macosx-clipboard and macosx-clipboard-native
381
382
These two modules implement an extended clipboard for Mac OS X. They are
383
used like this:
384
385
URxvt.perl-ext-common: default,macosx-clipboard
386
URxvt.keysym.M-c: perl:macosx-clipboard:copy
387
URxvt.keysym.M-v: perl:macosx-clipboard:paste
388
389
The difference between them is that the native variant requires a
390
perl from apple's devkit or so, and C<macosx-clipboard> requires the
391
C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392
simpler etc. etc.
393
394
=item example-refresh-hooks
395
396
Displays a very simple digital clock in the upper right corner of the
397
window. Illustrates overwriting the refresh callbacks to create your own
398
overlays or changes.
399
400
=item confirm-paste
401
402
Displays a confirmation dialog when a paste containing at least a full
403
line is detected.
404
405
=item bell-command
406
407
Runs the command specified by the C<URxvt.bell-command> resource when
408
a bell event occurs. For example, the following pops up a notification
409
bubble with the text "Beep, Beep" using notify-send:
410
411
URxvt.bell-command: notify-send "Beep, Beep"
412
413
=back
48
Extensions that add command line parameters or resources on their own are
49
loaded automatically when used.
414
50
415
51
=head1 API DOCUMENTATION
416
52
469
105
Although it isn't a C<urxvt::term> object, you can call all methods of the
470
106
C<urxvt::term> class on this object.
471
107
472
It has the following methods and data members:
473
474
=over 4
475
476
=item $urxvt_term = $self->{term}
477
478
Returns the C<urxvt::term> object associated with this instance of the
479
extension. This member I<must not> be changed in any way.
480
481
=item $self->enable ($hook_name => $cb, [$hook_name => $cb..])
482
483
Dynamically enable the given hooks (named without the C<on_> prefix) for
484
this extension, replacing any previous hook. This is useful when you want
485
to overwrite time-critical hooks only temporarily.
486
487
=item $self->disable ($hook_name[, $hook_name..])
488
489
Dynamically disable the given hooks.
490
491
=back
108
Additional methods only supported for extension objects are described in
109
the C<urxvt::extension> section below.
492
110
493
111
=head2 Hooks
494
112
669
287
670
288
Called whenever a user-configured event is being activated (e.g. via
671
289
a C<perl:string> action bound to a key, see description of the B<keysym>
672
resource in the @@RXVT_NAME@@(1) manpage).
290
resource in the urxvt(1) manpage).
673
291
674
292
The event is simply the action string. This interface is assumed to change
675
293
slightly in the future.
757
375
package urxvt;
758
376
759
377
use utf8;
760
use strict;
378
use strict 'vars';
761
379
use Carp ();
762
380
use Scalar::Util ();
763
381
use List::Util ();
764
382
765
383
our $VERSION = 1;
766
384
our $TERM;
767
our @TERM_INIT;
768
our @TERM_EXT;
385
our @TERM_INIT; # should go, prevents async I/O etc.
386
our @TERM_EXT; # should go, prevents async I/O etc.
769
387
our @HOOKNAME;
770
388
our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
771
389
our %OPTION;
945
563
946
564
no warnings 'utf8';
947
565
566
sub parse_resource {
567
my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
568
569
$name =~ y/-/./ if $isarg;
570
571
$term->scan_meta;
572
573
my $r = $term->{meta}{resource};
574
keys %$r; # reste iterator
575
while (my ($pattern, $v) = each %$r) {
576
if (
577
$pattern =~ /\.$/
578
? $pattern eq substr $name, 0, length $pattern
579
: $pattern eq $name
580
) {
581
$name = "$urxvt::RESCLASS.$name";
582
583
push @{ $term->{perl_ext_3} }, $v->[0];
584
585
if ($v->[1] eq "boolean") {
586
$term->put_option_db ($name, $flag ? "true" : "false");
587
return 1;
588
} else {
589
$term->put_option_db ($name, $value);
590
return 1 + 2;
591
}
592
}
593
}
594
595
0
596
}
597
598
sub usage {
599
my ($term, $usage_type) = @_;
600
601
$term->scan_meta;
602
603
my $r = $term->{meta}{resource};
604
605
for my $pattern (sort keys %$r) {
606
my ($ext, $type, $desc) = @{ $r->{$pattern} };
607
608
$desc .= " (-pe $ext)";
609
610
if ($usage_type == 1) {
611
$pattern =~ y/./-/;
612
$pattern =~ s/-$/-.../g;
613
614
if ($type eq "boolean") {
615
urxvt::log sprintf " -%-30s %s\n", "/+$pattern", $desc;
616
} else {
617
urxvt::log sprintf " -%-30s %s\n", "$pattern $type", $desc;
618
}
619
} else {
620
$pattern =~ s/\.$/.*/g;
621
urxvt::log sprintf " %-31s %s\n", "$pattern:", $type;
622
}
623
}
624
}
625
948
626
my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
949
627
950
628
sub verbose {
966
644
967
645
verbose 3, "loading extension '$path' into package '$pkg'";
968
646
647
(${"$pkg\::_NAME"} = $path) =~ s/^.*[\\\/]//; # hackish
648
969
649
open my $fh, "<:raw", $path
970
650
or die "$path: $!";
971
651
972
652
my $source =
973
"package $pkg; use strict; use utf8; no warnings 'utf8';\n"
653
"package $pkg; use strict 'vars'; use utf8; no warnings 'utf8';\n"
974
654
. "#line 1 \"$path\"\n{\n"
975
655
. (do { local $/; <$fh> })
976
656
. "\n};\n1";
990
670
my $htype = shift;
991
671
992
672
if ($htype == 0) { # INIT
993
my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$ENV{HOME}/.urxvt/ext", "$LIBDIR/perl");
673
my @dirs = $TERM->perl_libdirs;
994
674
995
675
my %ext_arg;
996
676
1003
683
$TERM->register_package ($_) for @pkg;
1004
684
}
1005
685
1006
for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
686
for (
687
@{ delete $TERM->{perl_ext_3} },
688
grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2
689
) {
1007
690
if ($_ eq "default") {
1008
691
$ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
1009
692
} elsif (/^-(.*)$/) {
1036
719
if $verbosity >= 10;
1037
720
1038
721
for my $pkg (keys %$cb) {
1039
my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
722
my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg} || $TERM, @_) };
1040
723
$retval ||= $retval_;
1041
724
1042
725
if ($@) {
1089
772
($mask, @color{qw(fg bg)}, \@failed)
1090
773
}
1091
774
1092
# urxvt::term::extension
1093
1094
775
package urxvt::term::extension;
1095
776
1096
sub enable {
1097
my ($self, %hook) = @_;
1098
my $pkg = $self->{_pkg};
1099
1100
while (my ($name, $cb) = each %hook) {
1101
my $htype = $HOOKTYPE{uc $name};
1102
defined $htype
1103
or Carp::croak "unsupported hook type '$name'";
1104
1105
$self->set_should_invoke ($htype, +1)
1106
unless exists $self->{term}{_hook}[$htype]{$pkg};
1107
1108
$self->{term}{_hook}[$htype]{$pkg} = $cb;
1109
}
1110
}
1111
1112
sub disable {
1113
my ($self, @hook) = @_;
1114
my $pkg = $self->{_pkg};
1115
1116
for my $name (@hook) {
1117
my $htype = $HOOKTYPE{uc $name};
1118
defined $htype
1119
or Carp::croak "unsupported hook type '$name'";
1120
1121
$self->set_should_invoke ($htype, -1)
1122
if delete $self->{term}{_hook}[$htype]{$pkg};
1123
}
1124
}
777
=head2 The C<urxvt::term::extension> class
778
779
Each extension attached to a terminal object is represented by
780
a C<urxvt::term::extension> object.
781
782
You can use these objects, which are passed to all callbacks to store any
783
state related to the terminal and extension instance.
784
785
The methods (And data members) documented below can be called on extension
786
objects, in addition to call methods documented for the <urxvt::term>
787
class.
788
789
=over 4
790
791
=item $urxvt_term = $self->{term}
792
793
Returns the C<urxvt::term> object associated with this instance of the
794
extension. This member I<must not> be changed in any way.
795
796
=cut
1125
797
1126
798
our $AUTOLOAD;
1127
799
1144
816
# nop
1145
817
}
1146
818
1147
# urxvt::destroy_hook
819
# urxvt::destroy_hook (basically a cheap Guard:: implementation)
1148
820
1149
821
sub urxvt::destroy_hook::DESTROY {
1150
822
${$_[0]}->();
1154
826
bless \shift, urxvt::destroy_hook::
1155
827
}
1156
828
829
=item $self->enable ($hook_name => $cb[, $hook_name => $cb..])
830
831
Dynamically enable the given hooks (named without the C<on_> prefix) for
832
this extension, replacing any previous hook. This is useful when you want
833
to overwrite time-critical hooks only temporarily.
834
835
To install additional callbacks for the same hook, you can use the C<on>
836
method of the C<urxvt::term> class.
837
838
=item $self->disable ($hook_name[, $hook_name..])
839
840
Dynamically disable the given hooks.
841
842
=cut
843
844
sub enable {
845
my ($self, %hook) = @_;
846
my $pkg = $self->{_pkg};
847
848
while (my ($name, $cb) = each %hook) {
849
my $htype = $HOOKTYPE{uc $name};
850
defined $htype
851
or Carp::croak "unsupported hook type '$name'";
852
853
$self->set_should_invoke ($htype, +1)
854
unless exists $self->{term}{_hook}[$htype]{$pkg};
855
856
$self->{term}{_hook}[$htype]{$pkg} = $cb;
857
}
858
}
859
860
sub disable {
861
my ($self, @hook) = @_;
862
my $pkg = $self->{_pkg};
863
864
for my $name (@hook) {
865
my $htype = $HOOKTYPE{uc $name};
866
defined $htype
867
or Carp::croak "unsupported hook type '$name'";
868
869
$self->set_should_invoke ($htype, -1)
870
if delete $self->{term}{_hook}[$htype]{$pkg};
871
}
872
}
873
874
=item $guard = $self->on ($hook_name => $cb[, $hook_name => $cb..])
875
876
Similar to the C<enable> enable, but installs additional callbacks for
877
the given hook(s) (that is, it doesn't replace existing callbacks), and
878
returns a guard object. When the guard object is destroyed the callbacks
879
are disabled again.
880
881
=cut
882
883
sub urxvt::extension::on_disable::DESTROY {
884
my $disable = shift;
885
886
my $term = delete $disable->{""};
887
888
while (my ($htype, $id) = each %$disable) {
889
delete $term->{_hook}[$htype]{$id};
890
$term->set_should_invoke ($htype, -1);
891
}
892
}
893
894
sub on {
895
my ($self, %hook) = @_;
896
897
my $term = $self->{term};
898
899
my %disable = ( "" => $term );
900
901
while (my ($name, $cb) = each %hook) {
902
my $htype = $HOOKTYPE{uc $name};
903
defined $htype
904
or Carp::croak "unsupported hook type '$name'";
905
906
$term->set_should_invoke ($htype, +1);
907
$term->{_hook}[$htype]{ $disable{$htype} = $cb+0 }
908
= sub { shift; $cb->($self, @_) }; # very ugly indeed
909
}
910
911
bless \%disable, "urxvt::extension::on_disable"
912
}
913
914
=item $self->x_resource ($pattern)
915
916
=item $self->x_resource_boolean ($pattern)
917
918
These methods support an additional C<%> prefix when called on an
919
extension object - see the description of these methods in the
920
C<urxvt::term> class for details.
921
922
=cut
923
924
sub x_resource {
925
my ($self, $name) = @_;
926
$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
927
$self->{term}->x_resource ($name)
928
}
929
930
sub x_resource_boolean {
931
my ($self, $name) = @_;
932
$name =~ s/^%(\.|$)/$_[0]{_name}$1/;
933
$self->{term}->x_resource_boolean ($name)
934
}
935
936
=back
937
938
=cut
939
1157
940
package urxvt::anyevent;
1158
941
1159
942
=head2 The C<urxvt::anyevent> Class
1161
944
The sole purpose of this class is to deliver an interface to the
1162
945
C<AnyEvent> module - any module using it will work inside urxvt without
1163
946
further programming. The only exception is that you cannot wait on
1164
condition variables, but non-blocking condvar use is ok. What this means
1165
is that you cannot use blocking APIs, but the non-blocking variant should
1166
work.
947
condition variables, but non-blocking condvar use is ok.
948
949
In practical terms this means is that you cannot use blocking APIs, but
950
the non-blocking variant should work.
1167
951
1168
952
=cut
1169
953
1257
1041
@{"$pkg\::ISA"} = urxvt::term::extension::;
1258
1042
1259
1043
my $proxy = bless {
1260
_pkg => $pkg,
1261
argv => $argv,
1044
_pkg => $pkg,
1045
_name => ${"$pkg\::_NAME"}, # hackish
1046
argv => $argv,
1262
1047
}, $pkg;
1263
1048
Scalar::Util::weaken ($proxy->{term} = $self);
1264
1049
1271
1056
}
1272
1057
}
1273
1058
1059
sub perl_libdirs {
1060
map { split /:/ }
1061
$_[0]->resource ("perl_lib"),
1062
$ENV{URXVT_PERL_LIB},
1063
"$ENV{HOME}/.urxvt/ext",
1064
"$LIBDIR/perl"
1065
}
1066
1067
sub scan_meta {
1068
my ($self) = @_;
1069
my @libdirs = perl_libdirs $self;
1070
1071
return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1072
1073
my %meta;
1074
1075
$self->{meta_libdirs} = join "\x00", @libdirs;
1076
$self->{meta} = \%meta;
1077
1078
for my $dir (reverse @libdirs) {
1079
opendir my $fh, $dir
1080
or next;
1081
for my $ext (readdir $fh) {
1082
$ext !~ /^\./
1083
and open my $fh, "<", "$dir/$ext"
1084
or next;
1085
1086
while (<$fh>) {
1087
if (/^#:META:X_RESOURCE:(.*)/) {
1088
my ($pattern, $type, $desc) = split /:/, $1;
1089
$pattern =~ s/^%(\.|$)/$ext$1/g; # % in pattern == extension name
1090
if ($pattern =~ /[^a-zA-Z0-9\-\.]/) {
1091
warn "$dir/$ext: meta resource '$pattern' contains illegal characters (not alphanumeric nor . nor *)\n";
1092
} else {
1093
$meta{resource}{$pattern} = [$ext, $type, $desc];
1094
}
1095
} elsif (/^\s*(?:#|$)/) {
1096
# skip other comments and empty lines
1097
} else {
1098
last; # stop parsing on first non-empty non-comment line
1099
}
1100
}
1101
}
1102
}
1103
}
1104
1274
1105
=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1275
1106
1276
1107
Creates a new terminal, very similar as if you had started it with system
1297
1128
=item $term->destroy
1298
1129
1299
1130
Destroy the terminal object (close the window, free resources
1300
etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
1131
etc.). Please note that urxvt will not exit as long as any event
1301
1132
watchers (timers, io watchers) are still active.
1302
1133
1303
1134
=item $term->exec_async ($cmd[, @args])
1363
1194
are supported in every build, please see the source file F</src/rsinc.h>
1364
1195
to see the actual list:
1365
1196
1366
answerbackstring backgroundPixmap backspace_key blendtype blurradius
1197
answerbackstring backgroundPixmap backspace_key blurradius
1367
1198
boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1368
1199
cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1369
1200
fade font geometry hold iconName iconfile imFont imLocale inputMethod
1393
1224
same value as used by this instance of rxvt-unicode. Returns C<undef> if no
1394
1225
resource with that pattern exists.
1395
1226
1227
Extensions that define extra resource or command line arguments also need
1228
to call this method to access their values.
1229
1230
If the method is called on an extension object (basically, from an
1231
extension), then the special prefix C<%.> will be replaced by the name of
1232
the extension and a dot, and the lone string C<%> will be replaced by the
1233
extension name itself. This makes it possible to code extensions so you
1234
can rename them and get a new set of commandline switches and resources
1235
without having to change the actual code.
1236
1396
1237
This method should only be called during the C<on_start> hook, as there is
1397
1238
only one resource database per display, and later invocations might return
1398
1239
the wrong resources.
1399
1240
1241
=item $value = $term->x_resource_boolean ($pattern)
1242
1243
Like C<x_resource>, above, but interprets the string value as a boolean
1244
and returns C<1> for true values, C<0> for false values and C<undef> if
1245
the resource or option isn't specified.
1246
1247
You should always use this method to parse boolean resources.
1248
1249
=cut
1250
1251
sub x_resource_boolean {
1252
my $res = &x_resource;
1253
1254
$res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
1255
}
1256
1400
1257
=item $success = $term->parse_keysym ($key, $octets)
1401
1258
1402
1259
Adds a key binding exactly as specified via a resource. See the
1403
C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1260
C<keysym> resource in the urxvt(1) manpage.
1404
1261
1405
1262
=item $term->register_command ($keysym, $modifiermask, $string)
1406
1263
Loggerhead is a web-based interface for Breezy
Version: 2.0.1