ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/urxvt.pm
(Generate patch)

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.160 by ayin, Fri Nov 16 10:06:40 2007 UTC vs.
Revision 1.208 by root, Tue Jun 5 22:23:07 2012 UTC

108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
165=item readline (enabled by default) 165=item readline (enabled by default)
166 166
167A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
168the moment, it reacts to clicking shift-left mouse button by trying to 168the moment, it reacts to clicking shift-left mouse button by trying to
169move the text cursor to this position. It does so by generating as many 169move the text cursor to this position. It does so by generating as many
170cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
171for programs that correctly support wide characters). 171for programs that correctly support wide characters).
172 172
173To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
174 174
175=over 4 175=over 4
259The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
260C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
261with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
262The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
263 263
264It is possible to activate the most recently seen match from the keyboard. 264It is possible to activate the most recently seen match or a list of matches
265from the keyboard. Simply bind a keysym to "perl:matcher:last" or
265Simply bind a keysym to "perl:matcher" as seen in the example below. 266"perl:matcher:list" as seen in the example below.
266 267
267Example configuration: 268Example configuration:
268 269
269 URxvt.perl-ext: default,matcher 270 URxvt.perl-ext: default,matcher
270 URxvt.urlLauncher: sensible-browser 271 URxvt.urlLauncher: sensible-browser
271 URxvt.keysym.C-Delete: perl:matcher 272 URxvt.keysym.C-Delete: perl:matcher:last
273 URxvt.keysym.M-Delete: perl:matcher:list
272 URxvt.matcher.button: 1 274 URxvt.matcher.button: 1
273 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-] 275 URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
274 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$) 276 URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
275 URxvt.matcher.launcher.2: gvim +$2 $1 277 URxvt.matcher.launcher.2: gvim +$2 $1
276 278
303extension will actually grab a physical key just for this function. 305extension will actually grab a physical key just for this function.
304 306
305If you want a quake-like animation, tell your window manager to do so 307If you want a quake-like animation, tell your window manager to do so
306(fvwm can do it). 308(fvwm can do it).
307 309
310=item overlay-osc
311
312This extension implements some OSC commands to display timed popups on the
313screen - useful for status displays from within scripts. You have to read
314the sources for more info.
315
308=item block-graphics-to-ascii 316=item block-graphics-to-ascii
309 317
310A not very useful example of filtering all text output to the terminal 318A not very useful example of filtering all text output to the terminal
311by replacing all line-drawing characters (U+2500 .. U+259F) by a 319by replacing all line-drawing characters (U+2500 .. U+259F) by a
312similar-looking ascii character. 320similar-looking ascii character.
335 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection' 343 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
336 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection' 344 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
337 345
338=item selection-pastebin 346=item selection-pastebin
339 347
340This is a little rarely useful extension that Uploads the selection as 348This is a little rarely useful extension that uploads the selection as
341textfile to a remote site (or does other things). (The implementation is 349textfile to a remote site (or does other things). (The implementation is
342not currently secure for use in a multiuser environment as it writes to 350not currently secure for use in a multiuser environment as it writes to
343F</tmp> directly.). 351F</tmp> directly.).
344 352
345It listens to the C<selection-pastebin:remote-pastebin> keyboard command, 353It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
364 372
365 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 373 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
366 374
367I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 375I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
368the double C</> characters as comment start. Use C<\057\057> instead, 376the double C</> characters as comment start. Use C<\057\057> instead,
369which works regardless of wether xrdb is used to parse the resource file 377which works regardless of whether xrdb is used to parse the resource file
370or not. 378or not.
379
380=item macosx-clipboard and macosx-clipboard-native
381
382These two modules implement an extended clipboard for Mac OS X. They are
383used 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
389The difference between them is that the native variant requires a
390perl from apple's devkit or so, and C<macosx-clipboard> requires the
391C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
392simpler etc. etc.
371 393
372=item example-refresh-hooks 394=item example-refresh-hooks
373 395
374Displays a very simple digital clock in the upper right corner of the 396Displays a very simple digital clock in the upper right corner of the
375window. Illustrates overwriting the refresh callbacks to create your own 397window. Illustrates overwriting the refresh callbacks to create your own
376overlays or changes. 398overlays or changes.
399
400=item confirm-paste
401
402Displays a confirmation dialog when a paste containing at least a full
403line is detected.
404
405=item bell-command
406
407Runs the command specified by the C<URxvt.bell-command> resource when
408a bell event occurs. For example, the following pops up a notification
409bubble with the text "Beep, Beep" using notify-send:
410
411 URxvt.bell-command: notify-send "Beep, Beep"
377 412
378=back 413=back
379 414
380=head1 API DOCUMENTATION 415=head1 API DOCUMENTATION
381 416
397 432
398=over 4 433=over 4
399 434
400=item $text 435=item $text
401 436
402Rxvt-unicodes special way of encoding text, where one "unicode" character 437Rxvt-unicode's special way of encoding text, where one "unicode" character
403always represents one screen cell. See L<ROW_t> for a discussion of this format. 438always represents one screen cell. See L<ROW_t> for a discussion of this format.
404 439
405=item $string 440=item $string
406 441
407A perl text string, with an emphasis on I<text>. It can store all unicode 442A perl text string, with an emphasis on I<text>. It can store all unicode
411=item $octets 446=item $octets
412 447
413Either binary data or - more common - a text string encoded in a 448Either binary data or - more common - a text string encoded in a
414locale-specific way. 449locale-specific way.
415 450
451=item $keysym
452
453an integer that is a valid X11 keysym code. You can convert a string
454into a keysym and viceversa by using C<XStringToKeysym> and
455C<XKeysymToString>.
456
416=back 457=back
417 458
418=head2 Extension Objects 459=head2 Extension Objects
419 460
420Every perl extension is a perl class. A separate perl object is created 461Every perl extension is a perl class. A separate perl object is created
421for each terminal, and each terminal has its own set of extenion objects, 462for each terminal, and each terminal has its own set of extension objects,
422which are passed as the first parameter to hooks. So extensions can use 463which are passed as the first parameter to hooks. So extensions can use
423their C<$self> object without having to think about clashes with other 464their C<$self> object without having to think about clashes with other
424extensions or other terminals, with the exception of methods and members 465extensions or other terminals, with the exception of methods and members
425that begin with an underscore character C<_>: these are reserved for 466that begin with an underscore character C<_>: these are reserved for
426internal use. 467internal use.
541 582
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 583It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 584$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544number of lines that will be in the scrollback buffer. 585number of lines that will be in the scrollback buffer.
545 586
546=item on_osc_seq $term, $op, $args 587=item on_osc_seq $term, $op, $args, $resp
547 588
548Called on every OSC sequence and can be used to suppress it or modify its 589Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 590behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 591suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 592confused by recursive invocations when you output an OSC sequence within
552this callback. 593this callback.
553 594
554C<on_osc_seq_perl> should be used for new behaviour. 595C<on_osc_seq_perl> should be used for new behaviour.
555 596
556=item on_osc_seq_perl $term, $string 597=item on_osc_seq_perl $term, $args, $resp
557 598
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 599Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 600operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 601information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 602string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 603to distinguish it from commands for other extensions, and this might be
563future. 604enforced in the future.
605
606For example, C<overlay-osc> uses this:
607
608 sub on_osc_seq_perl {
609 my ($self, $osc, $resp) = @_;
610
611 return unless $osc =~ s/^overlay;//;
612
613 ... process remaining $osc string
614 }
564 615
565Be careful not ever to trust (in a security sense) the data you receive, 616Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 617as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 618other users on the same system etc.).
619
620For responses, C<$resp> contains the end-of-args separator used by the
621sender.
568 622
569=item on_add_lines $term, $string 623=item on_add_lines $term, $string
570 624
571Called whenever text is about to be output, with the text as argument. You 625Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 626can filter/change and output the text yourself by returning a true value
577=item on_tt_write $term, $octets 631=item on_tt_write $term, $octets
578 632
579Called whenever some data is written to the tty/pty and can be used to 633Called whenever some data is written to the tty/pty and can be used to
580suppress or filter tty input. 634suppress or filter tty input.
581 635
636=item on_tt_paste $term, $octets
637
638Called whenever text is about to be pasted, with the text as argument. You
639can filter/change and paste the text yourself by returning a true value
640and calling C<< $term->tt_paste >> yourself. C<$octets> is
641locale-encoded.
642
582=item on_line_update $term, $row 643=item on_line_update $term, $row
583 644
584Called whenever a line was updated or changed. Can be used to filter 645Called whenever a line was updated or changed. Can be used to filter
585screen output (e.g. underline urls or other useless stuff). Only lines 646screen output (e.g. underline urls or other useless stuff). Only lines
586that are being shown will be filtered, and, due to performance reasons, 647that are being shown will be filtered, and, due to performance reasons,
593later with the already-modified line (e.g. if unrelated parts change), so 654later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 655you cannot just toggle rendition bits, but only set them.
595 656
596=item on_refresh_begin $term 657=item on_refresh_begin $term
597 658
598Called just before the screen gets redrawn. Can be used for overlay 659Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 660similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 661restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 662code is run after this hook, and takes precedence.
602 663
603=item on_refresh_end $term 664=item on_refresh_end $term
604 665
611resource in the @@RXVT_NAME@@(1) manpage). 672resource in the @@RXVT_NAME@@(1) manpage).
612 673
613The event is simply the action string. This interface is assumed to change 674The event is simply the action string. This interface is assumed to change
614slightly in the future. 675slightly in the future.
615 676
677=item on_register_command $term, $keysym, $modifiermask, $string
678
679Called after parsing a keysym resource but before registering the
680associated binding. If this hook returns TRUE the binding is not
681registered. It can be used to modify a binding by calling
682C<register_command>.
683
616=item on_resize_all_windows $tern, $new_width, $new_height 684=item on_resize_all_windows $term, $new_width, $new_height
617 685
618Called just after the new window size has been calculated, but before 686Called just after the new window size has been calculated, but before
619windows are actually being resized or hints are being set. If this hook 687windows are actually being resized or hints are being set. If this hook
620returns TRUE, setting of the window hints is being skipped. 688returns TRUE, setting of the window hints is being skipped.
621 689
655 723
656=item on_map_notify $term, $event 724=item on_map_notify $term, $event
657 725
658=item on_unmap_notify $term, $event 726=item on_unmap_notify $term, $event
659 727
660Called whenever the corresponding X event is received for the terminal If 728Called whenever the corresponding X event is received for the terminal. If
661the hook returns true, then the even will be ignored by rxvt-unicode. 729the hook returns true, then the event will be ignored by rxvt-unicode.
662 730
663The event is a hash with most values as named by Xlib (see the XEvent 731The event is a hash with most values as named by Xlib (see the XEvent
664manpage), with the additional members C<row> and C<col>, which are the 732manpage), with the additional members C<row> and C<col>, which are the
665(real, not screen-based) row and column under the mouse cursor. 733(real, not screen-based) row and column under the mouse cursor.
666 734
675 743
676=item on_wm_delete_window $term, $event 744=item on_wm_delete_window $term, $event
677 745
678Called when various types of ClientMessage events are received (all with 746Called when various types of ClientMessage events are received (all with
679format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW). 747format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
748
749=item on_bell $term
750
751Called on receipt of a bell character.
680 752
681=back 753=back
682 754
683=cut 755=cut
684 756
749 821
750=over 4 822=over 4
751 823
752=item urxvt::fatal $errormessage 824=item urxvt::fatal $errormessage
753 825
754Fatally aborts execution with the given error message. Avoid at all 826Fatally aborts execution with the given error message (which should
755costs! The only time this is acceptable is when the terminal process 827include a trailing newline). Avoid at all costs! The only time this
756starts up. 828is acceptable (and useful) is in the init hook, where it prevents the
829terminal from starting up.
757 830
758=item urxvt::warn $string 831=item urxvt::warn $string
759 832
760Calls C<rxvt_warn> with the given string which should not include a 833Calls C<rxvt_warn> with the given string which should include a trailing
761newline. The module also overwrites the C<warn> builtin with a function 834newline. The module also overwrites the C<warn> builtin with a function
762that calls this function. 835that calls this function.
763 836
764Using this function has the advantage that its output ends up in the 837Using this function has the advantage that its output ends up in the
765correct place, e.g. on stderr of the connecting urxvtc client. 838correct place, e.g. on stderr of the connecting urxvtc client.
769=item @terms = urxvt::termlist 842=item @terms = urxvt::termlist
770 843
771Returns all urxvt::term objects that exist in this process, regardless of 844Returns all urxvt::term objects that exist in this process, regardless of
772whether they are started, being destroyed etc., so be careful. Only term 845whether they are started, being destroyed etc., so be careful. Only term
773objects that have perl extensions attached will be returned (because there 846objects that have perl extensions attached will be returned (because there
774is no urxvt::term objet associated with others). 847is no urxvt::term object associated with others).
775 848
776=item $time = urxvt::NOW 849=item $time = urxvt::NOW
777 850
778Returns the "current time" (as per the event loop). 851Returns the "current time" (as per the event loop).
779 852
822 895
823=item $rend = urxvt::OVERLAY_RSTYLE 896=item $rend = urxvt::OVERLAY_RSTYLE
824 897
825Return the rendition mask used for overlays by default. 898Return the rendition mask used for overlays by default.
826 899
827=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline 900=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
901urxvt::RS_RVid, urxvt::RS_Uline
828 902
829Return the bit that enabled bold, italic, blink, reverse-video and 903Return the bit that enabled bold, italic, blink, reverse-video and
830underline, respectively. To enable such a style, just logically OR it into 904underline, respectively. To enable such a style, just logically OR it into
831the bitset. 905the bitset.
832 906
869 }; 943 };
870} 944}
871 945
872no warnings 'utf8'; 946no warnings 'utf8';
873 947
948sub resource {
949 my ($term, $name, $isarg, $flag, $value) = @_;
950
951 $term->scan_meta;
952
953 warn "resourece<@_>\n";#d#
954
955 0
956}
957
958sub usage {
959 my ($term, $usage_type) = @_;
960
961 $term->scan_meta;
962
963 my $r = $term->{meta}{resource};
964
965 for my $regex (sort keys %$r) {
966 my ($ext, $type, $desc) = @{ $r->{$regex} };
967
968 $desc .= " (-pe $ext)";
969
970 if ($usage_type == 1) {
971 if ($type eq "boolean") {
972 urxvt::log sprintf " -%-20.20s %s\n", "/+$regex", $desc;
973 } else {
974 urxvt::log sprintf " -%-20.20s %s\n", "$regex $type", $desc;
975 }
976 } else {
977 urxvt::log sprintf " %-19.19s %s\n", "$regex:", $type;
978 }
979 }
980}
981
874my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 982my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
875 983
876sub verbose { 984sub verbose {
877 my ($level, $msg) = @_; 985 my ($level, $msg) = @_;
878 warn "$msg\n" if $level <= $verbosity; 986 warn "$msg\n" if $level <= $verbosity;
914sub invoke { 1022sub invoke {
915 local $TERM = shift; 1023 local $TERM = shift;
916 my $htype = shift; 1024 my $htype = shift;
917 1025
918 if ($htype == 0) { # INIT 1026 if ($htype == 0) { # INIT
919 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 1027 my @dirs = $TERM->perl_libdirs;
920 1028
921 my %ext_arg; 1029 my %ext_arg;
922 1030
923 { 1031 {
924 my @init = @TERM_INIT; 1032 my @init = @TERM_INIT;
1091is that you cannot use blocking APIs, but the non-blocking variant should 1199is that you cannot use blocking APIs, but the non-blocking variant should
1092work. 1200work.
1093 1201
1094=cut 1202=cut
1095 1203
1096our $VERSION = 1; 1204our $VERSION = '5.23';
1097 1205
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1206$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1207push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1208
1101sub timer { 1209sub timer {
1103 1211
1104 my $cb = $arg{cb}; 1212 my $cb = $arg{cb};
1105 1213
1106 urxvt::timer 1214 urxvt::timer
1107 ->new 1215 ->new
1108 ->start (urxvt::NOW + $arg{after}) 1216 ->after ($arg{after}, $arg{interval})
1109 ->cb (sub { 1217 ->cb ($arg{interval} ? $cb : sub {
1110 $_[0]->stop; # need to cancel manually 1218 $_[0]->stop; # need to cancel manually
1111 $cb->(); 1219 $cb->();
1112 }) 1220 })
1113} 1221}
1114 1222
1115sub io { 1223sub io {
1116 my ($class, %arg) = @_; 1224 my ($class, %arg) = @_;
1117 1225
1118 my $cb = $arg{cb}; 1226 my $cb = $arg{cb};
1227 my $fd = fileno $arg{fh};
1228 defined $fd or $fd = $arg{fh};
1119 1229
1120 bless [$arg{fh}, urxvt::iow 1230 bless [$arg{fh}, urxvt::iow
1121 ->new 1231 ->new
1122 ->fd (fileno $arg{fh}) 1232 ->fd ($fd)
1123 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1233 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1124 | ($arg{poll} =~ /w/ ? 2 : 0)) 1234 | ($arg{poll} =~ /w/ ? 2 : 0))
1125 ->start 1235 ->start
1126 ->cb (sub { 1236 ->cb ($cb)
1127 $cb->(($_[1] & 1 ? 'r' : '')
1128 . ($_[1] & 2 ? 'w' : ''));
1129 })],
1130 urxvt::anyevent:: 1237 ], urxvt::anyevent::
1238}
1239
1240sub idle {
1241 my ($class, %arg) = @_;
1242
1243 my $cb = $arg{cb};
1244
1245 urxvt::iw
1246 ->new
1247 ->start
1248 ->cb ($cb)
1249}
1250
1251sub child {
1252 my ($class, %arg) = @_;
1253
1254 my $cb = $arg{cb};
1255
1256 urxvt::pw
1257 ->new
1258 ->start ($arg{pid})
1259 ->cb (sub {
1260 $_[0]->stop; # need to cancel manually
1261 $cb->($_[0]->rpid, $_[0]->rstatus);
1262 })
1131} 1263}
1132 1264
1133sub DESTROY { 1265sub DESTROY {
1134 $_[0][1]->stop; 1266 $_[0][1]->stop;
1135} 1267}
1136 1268
1137sub condvar { 1269# only needed for AnyEvent < 6 compatibility
1138 bless \my $flag, urxvt::anyevent::
1139}
1140
1141sub broadcast {
1142 ${$_[0]}++;
1143}
1144
1145sub wait {
1146 unless (${$_[0]}) {
1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148 }
1149}
1150
1151sub one_event { 1270sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1271 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153} 1272}
1154 1273
1155package urxvt::term; 1274package urxvt::term;
1184 $proxy->enable ($name => $ref); 1303 $proxy->enable ($name => $ref);
1185 } 1304 }
1186 } 1305 }
1187} 1306}
1188 1307
1308sub perl_libdirs {
1309 map { split /:/ }
1310 $_[0]->resource ("perl_lib"),
1311 $ENV{URXVT_PERL_LIB},
1312 "$ENV{HOME}/.urxvt/ext",
1313 "$LIBDIR/perl"
1314}
1315
1316sub scan_meta {
1317 my ($self) = @_;
1318 my @libdirs = perl_libdirs $self;
1319
1320 return if $self->{meta_libdirs} eq join "\x00", @libdirs;
1321
1322 my %meta;
1323
1324 $self->{meta_libdirs} = join "\x00", @libdirs;
1325 $self->{meta} = \%meta;
1326
1327 for my $dir (reverse @libdirs) {
1328 opendir my $fh, $dir
1329 or next;
1330 for my $ext (readdir $fh) {
1331 $ext ne "."
1332 and $ext ne ".."
1333 and open my $fh, "<", "$dir/$ext"
1334 or next;
1335
1336 while (<$fh>) {
1337 if (/^#:META:RESOURCE:(.*)/) {
1338 my ($regex, $type, $desc) = split /:/, $1;
1339 $regex =~ s/\$\$/$ext/g; # $$ in regex == extension name
1340 $meta{resource}{$regex} = [$ext, $type, $desc];
1341 } elsif (/^\s*(?:#|$)/) {
1342 # skip other comments and empty lines
1343 } else {
1344 last; # stop parsing on first non-empty non-comment line
1345 }
1346 }
1347 }
1348 }
1349}
1350
1189=item $term = new urxvt::term $envhashref, $rxvtname, [arg...] 1351=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
1190 1352
1191Creates a new terminal, very similar as if you had started it with system 1353Creates a new terminal, very similar as if you had started it with system
1192C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like 1354C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
1193hash which defines the environment of the new terminal. 1355hash which defines the environment of the new terminal.
1247C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash. 1409C<%urxvt::OPTION>. Options not enabled in this binary are not in the hash.
1248 1410
1249Here is a likely non-exhaustive list of option names, please see the 1411Here is a likely non-exhaustive list of option names, please see the
1250source file F</src/optinc.h> to see the actual list: 1412source file F</src/optinc.h> to see the actual list:
1251 1413
1252 borderLess console cursorBlink cursorUnderline hold iconic insecure 1414 borderLess buffered console cursorBlink cursorUnderline hold iconic
1253 intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage 1415 insecure intensityStyles iso14755 iso14755_52 jumpScroll loginShell
1254 override-redirect pastableTabs pointerBlank reverseVideo scrollBar 1416 mapAlert meta8 mouseWheelScrollPage override_redirect pastableTabs
1255 scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput 1417 pointerBlank reverseVideo scrollBar scrollBar_floating scrollBar_right
1256 scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs 1418 scrollTtyKeypress scrollTtyOutput scrollWithBuffer secondaryScreen
1257 transparent tripleclickwords utmpInhibit visualBell 1419 secondaryScroll skipBuiltinGlyphs skipScroll transparent tripleclickwords
1420 urgentOnBell utmpInhibit visualBell
1258 1421
1259=item $value = $term->resource ($name[, $newval]) 1422=item $value = $term->resource ($name[, $newval])
1260 1423
1261Returns the current resource value associated with a given name and 1424Returns the current resource value associated with a given name and
1262optionally sets a new value. Setting values is most useful in the C<init> 1425optionally sets a new value. Setting values is most useful in the C<init>
1275 1438
1276Here is a likely non-exhaustive list of resource names, not all of which 1439Here is a likely non-exhaustive list of resource names, not all of which
1277are supported in every build, please see the source file F</src/rsinc.h> 1440are supported in every build, please see the source file F</src/rsinc.h>
1278to see the actual list: 1441to see the actual list:
1279 1442
1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1443 answerbackstring backgroundPixmap backspace_key blendtype blurradius
1281 borderLess color cursorBlink cursorUnderline cutchars delete_key 1444 boldFont boldItalicFont borderLess buffered chdir color cursorBlink
1282 display_name embed ext_bwidth fade font geometry hold iconName 1445 cursorUnderline cutchars delete_key depth display_name embed ext_bwidth
1283 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1446 fade font geometry hold iconName iconfile imFont imLocale inputMethod
1447 insecure int_bwidth intensityStyles iso14755 iso14755_52 italicFont
1284 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1448 jumpScroll letterSpace lineSpace loginShell mapAlert meta8 modifier
1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1449 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1450 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1451 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1452 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1453 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290 secondaryScreen secondaryScroll selectstyle shade term_name title 1454 secondaryScreen secondaryScroll shade skipBuiltinGlyphs skipScroll
1291 transient_for transparent transparent_all tripleclickwords utmpInhibit 1455 term_name title transient_for transparent tripleclickwords urgentOnBell
1292 visualBell 1456 utmpInhibit visualBell
1293 1457
1294=cut 1458=cut
1295 1459
1296sub resource($$;$) { 1460sub resource($$;$) {
1297 my ($self, $name) = (shift, shift); 1461 my ($self, $name) = (shift, shift);
1298 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1462 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1299 &urxvt::term::_resource 1463 goto &urxvt::term::_resource
1300} 1464}
1301 1465
1302=item $value = $term->x_resource ($pattern) 1466=item $value = $term->x_resource ($pattern)
1303 1467
1304Returns the X-Resource for the given pattern, excluding the program or 1468Returns the X-Resource for the given pattern, excluding the program or
1308 1472
1309This method should only be called during the C<on_start> hook, as there is 1473This method should only be called during the C<on_start> hook, as there is
1310only one resource database per display, and later invocations might return 1474only one resource database per display, and later invocations might return
1311the wrong resources. 1475the wrong resources.
1312 1476
1313=item $success = $term->parse_keysym ($keysym_spec, $command_string) 1477=item $success = $term->parse_keysym ($key, $octets)
1314 1478
1315Adds a keymap translation exactly as specified via a resource. See the 1479Adds a key binding exactly as specified via a resource. See the
1316C<keysym> resource in the @@RXVT_NAME@@(1) manpage. 1480C<keysym> resource in the @@RXVT_NAME@@(1) manpage.
1481
1482=item $term->register_command ($keysym, $modifiermask, $string)
1483
1484Adds a key binding. This is a lower level api compared to
1485C<parse_keysym>, as it expects a parsed key description, and can be
1486used only inside either the C<on_init> hook, to add a binding, or the
1487C<on_register_command> hook, to modify a parsed binding.
1317 1488
1318=item $rend = $term->rstyle ([$new_rstyle]) 1489=item $rend = $term->rstyle ([$new_rstyle])
1319 1490
1320Return and optionally change the current rendition. Text that is output by 1491Return and optionally change the current rendition. Text that is output by
1321the terminal application will use this style. 1492the terminal application will use this style.
1329 1500
1330=item ($row, $col) = $term->selection_beg ([$row, $col]) 1501=item ($row, $col) = $term->selection_beg ([$row, $col])
1331 1502
1332=item ($row, $col) = $term->selection_end ([$row, $col]) 1503=item ($row, $col) = $term->selection_end ([$row, $col])
1333 1504
1334Return the current values of the selection mark, begin or end positions, 1505Return the current values of the selection mark, begin or end positions.
1335and optionally set them to new values. 1506
1507When arguments are given, then the selection coordinates are set to
1508C<$row> and C<$col>, and the selection screen is set to the current
1509screen.
1510
1511=item $screen = $term->selection_screen ([$screen])
1512
1513Returns the current selection screen, and then optionally sets it.
1336 1514
1337=item $term->selection_make ($eventtime[, $rectangular]) 1515=item $term->selection_make ($eventtime[, $rectangular])
1338 1516
1339Tries to make a selection as set by C<selection_beg> and 1517Tries to make a selection as set by C<selection_beg> and
1340C<selection_end>. If C<$rectangular> is true (default: false), a 1518C<selection_end>. If C<$rectangular> is true (default: false), a
1341rectangular selection will be made. This is the prefered function to make 1519rectangular selection will be made. This is the preferred function to make
1342a selection. 1520a selection.
1343 1521
1344=item $success = $term->selection_grab ($eventtime) 1522=item $success = $term->selection_grab ($eventtime[, $clipboard])
1345 1523
1346Try to request the primary selection text from the server (for example, as 1524Try to acquire ownership of the primary (clipboard if C<$clipboard> is
1525true) selection from the server. The corresponding text can be set
1347set by the next method). No visual feedback will be given. This function 1526with the next method. No visual feedback will be given. This function
1348is mostly useful from within C<on_sel_grab> hooks. 1527is mostly useful from within C<on_sel_grab> hooks.
1349 1528
1350=item $oldtext = $term->selection ([$newtext]) 1529=item $oldtext = $term->selection ([$newtext, $clipboard])
1351 1530
1352Return the current selection text and optionally replace it by C<$newtext>. 1531Return the current selection (clipboard if C<$clipboard> is true) text
1532and optionally replace it by C<$newtext>.
1533
1534=item $term->selection_clear ([$clipboard])
1535
1536Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1353 1537
1354=item $term->overlay_simple ($x, $y, $text) 1538=item $term->overlay_simple ($x, $y, $text)
1355 1539
1356Create a simple multi-line overlay box. See the next method for details. 1540Create a simple multi-line overlay box. See the next method for details.
1357 1541
1387 1571
1388The methods currently supported on C<urxvt::overlay> objects are: 1572The methods currently supported on C<urxvt::overlay> objects are:
1389 1573
1390=over 4 1574=over 4
1391 1575
1392=item $overlay->set ($x, $y, $text, $rend) 1576=item $overlay->set ($x, $y, $text[, $rend])
1393 1577
1394Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1578Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1395text in rxvt-unicode's special encoding and an array of rendition values 1579text in rxvt-unicode's special encoding and an array of rendition values
1396at a specific position inside the overlay. 1580at a specific position inside the overlay.
1581
1582If C<$rend> is missing, then the rendition will not be changed.
1397 1583
1398=item $overlay->hide 1584=item $overlay->hide
1399 1585
1400If visible, hide the overlay, but do not destroy it. 1586If visible, hide the overlay, but do not destroy it.
1401 1587
1483locale-specific encoding of the terminal and can contain command sequences 1669locale-specific encoding of the terminal and can contain command sequences
1484(escape codes) that will be interpreted. 1670(escape codes) that will be interpreted.
1485 1671
1486=item $term->tt_write ($octets) 1672=item $term->tt_write ($octets)
1487 1673
1488Write the octets given in C<$data> to the tty (i.e. as program input). To 1674Write the octets given in C<$octets> to the tty (i.e. as program input). To
1489pass characters instead of octets, you should convert your strings first 1675pass characters instead of octets, you should convert your strings first
1490to the locale-specific encoding using C<< $term->locale_encode >>. 1676to the locale-specific encoding using C<< $term->locale_encode >>.
1677
1678=item $term->tt_paste ($octets)
1679
1680Write the octets given in C<$octets> to the tty as a paste, converting NL to
1681CR and bracketing the data with control sequences if bracketed paste mode
1682is set.
1491 1683
1492=item $old_events = $term->pty_ev_events ([$new_events]) 1684=item $old_events = $term->pty_ev_events ([$new_events])
1493 1685
1494Replaces the event mask of the pty watcher by the given event mask. Can 1686Replaces the event mask of the pty watcher by the given event mask. Can
1495be used to suppress input and output handling to the pty/tty. See the 1687be used to suppress input and output handling to the pty/tty. See the
1514Adds the specified events to the vt event mask. Useful e.g. when you want 1706Adds the specified events to the vt event mask. Useful e.g. when you want
1515to receive pointer events all the times: 1707to receive pointer events all the times:
1516 1708
1517 $term->vt_emask_add (urxvt::PointerMotionMask); 1709 $term->vt_emask_add (urxvt::PointerMotionMask);
1518 1710
1711=item $term->set_urgency ($set)
1712
1713Enable/disable the urgency hint on the toplevel window.
1714
1519=item $term->focus_in 1715=item $term->focus_in
1520 1716
1521=item $term->focus_out 1717=item $term->focus_out
1522 1718
1523=item $term->key_press ($state, $keycode[, $time]) 1719=item $term->key_press ($state, $keycode[, $time])
1611 1807
1612Used after changing terminal contents to display them. 1808Used after changing terminal contents to display them.
1613 1809
1614=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1810=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615 1811
1616Returns the text of the entire row with number C<$row_number>. Row C<0> 1812Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1813is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618terminal line. The scrollback buffer starts at line C<-1> and extends to
1619line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1814terminal line. Nothing will be returned if a nonexistent line
1620is requested. 1815is requested.
1621 1816
1622If C<$new_text> is specified, it will replace characters in the current 1817If C<$new_text> is specified, it will replace characters in the current
1623line, starting at column C<$start_col> (default C<0>), which is useful 1818line, starting at column C<$start_col> (default C<0>), which is useful
1624to replace only parts of a line. The font index in the rendition will 1819to replace only parts of a line. The font index in the rendition will
1625automatically be updated. 1820automatically be updated.
1626 1821
1627C<$text> is in a special encoding: tabs and wide characters that use more 1822C<$text> is in a special encoding: tabs and wide characters that use more
1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1823than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1629characters. Characters with combining characters and other characters that 1824characters. Characters with combining characters and other characters that
1630do not fit into the normal tetx encoding will be replaced with characters 1825do not fit into the normal text encoding will be replaced with characters
1631in the private use area. 1826in the private use area.
1632 1827
1633You have to obey this encoding when changing text. The advantage is 1828You have to obey this encoding when changing text. The advantage is
1634that C<substr> and similar functions work on screen cells and not on 1829that C<substr> and similar functions work on screen cells and not on
1635characters. 1830characters.
1810Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most 2005Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1811recent grab. 2006recent grab.
1812 2007
1813=item $term->ungrab 2008=item $term->ungrab
1814 2009
1815Calls XUngrab for the most recent grab. Is called automatically on 2010Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1816evaluation errors, as it is better to lose the grab in the error case as 2011evaluation errors, as it is better to lose the grab in the error case as
1817the session. 2012the session.
1818 2013
1819=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists]) 2014=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1820 2015
1822 2017
1823=item @atoms = $term->XListProperties ($window) 2018=item @atoms = $term->XListProperties ($window)
1824 2019
1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 2020=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826 2021
1827=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 2022=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828 2023
1829=item $term->XDeleteProperty ($window, $property) 2024=item $term->XDeleteProperty ($window, $property)
1830 2025
1831=item $window = $term->DefaultRootWindow 2026=item $window = $term->DefaultRootWindow
1832 2027
1839=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height) 2034=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1840 2035
1841=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y) 2036=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1842 2037
1843=item $term->XChangeInput ($window, $add_events[, $del_events]) 2038=item $term->XChangeInput ($window, $add_events[, $del_events])
2039
2040=item $keysym = $term->XStringToKeysym ($string)
2041
2042=item $string = $term->XKeysymToString ($keysym)
1844 2043
1845Various X or X-related functions. The C<$term> object only serves as 2044Various X or X-related functions. The C<$term> object only serves as
1846the source of the display, otherwise those functions map more-or-less 2045the source of the display, otherwise those functions map more-or-less
1847directory onto the X functions of the same name. 2046directly onto the X functions of the same name.
1848 2047
1849=back 2048=back
1850 2049
1851=cut 2050=cut
1852 2051
1954 my $env = $self->{term}->env; 2153 my $env = $self->{term}->env;
1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 2154 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956 delete $env->{LC_ALL}; 2155 delete $env->{LC_ALL};
1957 $env->{LC_CTYPE} = $self->{term}->locale; 2156 $env->{LC_CTYPE} = $self->{term}->locale;
1958 2157
1959 urxvt::term->new ($env, "popup", 2158 my $term = urxvt::term->new (
2159 $env, "popup",
1960 "--perl-lib" => "", "--perl-ext-common" => "", 2160 "--perl-lib" => "", "--perl-ext-common" => "",
1961 "-pty-fd" => -1, "-sl" => 0, 2161 "-pty-fd" => -1, "-sl" => 0,
1962 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2162 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963 "--transient-for" => $self->{term}->parent, 2163 "--transient-for" => $self->{term}->parent,
1964 "-display" => $self->{term}->display_id, 2164 "-display" => $self->{term}->display_id,
1965 "-pe" => "urxvt-popup") 2165 "-pe" => "urxvt-popup",
1966 or die "unable to create popup window\n"; 2166 ) or die "unable to create popup window\n";
2167
2168 unless (delete $term->{urxvt_popup_init_done}) {
2169 $term->ungrab;
2170 $term->destroy;
2171 die "unable to initialise popup window\n";
2172 }
1967} 2173}
1968 2174
1969sub DESTROY { 2175sub DESTROY {
1970 my ($self) = @_; 2176 my ($self) = @_;
1971 2177
2002 2208
2003=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2209=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2004 2210
2005Set the callback to be called when the timer triggers. 2211Set the callback to be called when the timer triggers.
2006 2212
2007=item $tstamp = $timer->at
2008
2009Return the time this watcher will fire next.
2010
2011=item $timer = $timer->set ($tstamp) 2213=item $timer = $timer->set ($tstamp[, $interval])
2012 2214
2013Set the time the event is generated to $tstamp. 2215Set the time the event is generated to $tstamp (and optionally specifies a
2216new $interval).
2014 2217
2015=item $timer = $timer->interval ($interval) 2218=item $timer = $timer->interval ($interval)
2016 2219
2017Normally (and when C<$interval> is C<0>), the timer will automatically 2220By default (and when C<$interval> is C<0>), the timer will automatically
2018stop after it has fired once. If C<$interval> is non-zero, then the timer 2221stop after it has fired once. If C<$interval> is non-zero, then the timer
2019is automatically rescheduled at the given intervals. 2222is automatically rescheduled at the given intervals.
2020 2223
2021=item $timer = $timer->start 2224=item $timer = $timer->start
2022 2225
2023Start the timer. 2226Start the timer.
2024 2227
2025=item $timer = $timer->start ($tstamp) 2228=item $timer = $timer->start ($tstamp[, $interval])
2026 2229
2027Set the event trigger time to C<$tstamp> and start the timer. 2230Set the event trigger time to C<$tstamp> and start the timer. Optionally
2231also replaces the interval.
2028 2232
2029=item $timer = $timer->after ($delay) 2233=item $timer = $timer->after ($delay[, $interval])
2030 2234
2031Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2235Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2032 2236
2033=item $timer = $timer->stop 2237=item $timer = $timer->stop
2034 2238
2165 2369
2166=back 2370=back
2167 2371
2168=head1 AUTHOR 2372=head1 AUTHOR
2169 2373
2170 Marc Lehmann <pcg@goof.com> 2374 Marc Lehmann <schmorp@schmorp.de>
2171 http://software.schmorp.de/pkg/rxvt-unicode 2375 http://software.schmorp.de/pkg/rxvt-unicode
2172 2376
2173=cut 2377=cut
2174 2378
21751 23791

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines