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.152 by tpope, Tue Jan 9 16:18:56 2007 UTC vs.
Revision 1.179 by root, Sat Dec 26 09:23:53 2009 UTC

… …
26thus must be encoded as UTF-8. 26thus must be encoded as UTF-8.
27 27
28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where 28Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29scripts will be shared (but not enabled) for all terminals. 29scripts will be shared (but not enabled) for all terminals.
30 30
31You can disable the embedded perl interpreter by setting both "perl-ext"
32and "perl-ext-common" resources to the empty string.
33
31=head1 PREPACKAGED EXTENSIONS 34=head1 PREPACKAGED EXTENSIONS
32 35
33This section describes the extensions delivered with this release. You can 36This section describes the extensions delivered with this release. You can
34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 37find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 38
… …
37 40
38 @@RXVT_NAME@@ -pe <extensionname> 41 @@RXVT_NAME@@ -pe <extensionname>
39 42
40Or by adding them to the resource for extensions loaded by default: 43Or by adding them to the resource for extensions loaded by default:
41 44
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform 45 URxvt.perl-ext-common: default,selection-autotransform
43 46
44=over 4 47=over 4
45 48
46=item selection (enabled by default) 49=item selection (enabled by default)
47 50
… …
98 101
99Other extensions can extend this popup menu by pushing a code reference 102Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the 103onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed. 104popup is being displayed.
102 105
103It's sole argument is the popup menu, which can be modified. It should 106Its sole argument is the popup menu, which can be modified. It should
104either return nothing or a string, the initial boolean value and a code 107either return nothing or a string, the initial boolean value and a code
105reference. 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
106will 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
107first argument. 110first argument.
108 111
109The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
110C<$self->{myoption}>: 113C<< $self->{myoption} >>:
111 114
112 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 }; 117 };
115 118
… …
121 124
122Other extensions can extend this popup menu by pushing a code reference 125Other extensions can extend this popup menu by pushing a code reference
123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the 126onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed. 127popup is being displayed.
125 128
126It's sole argument is the popup menu, which can be modified. The selection 129Its sole argument is the popup menu, which can be modified. The selection
127is in C<$_>, which can be used to decide whether to add something or not. 130is in C<$_>, which can be used to decide whether to add something or not.
128It should either return nothing or a string and a code reference. The 131It should either return nothing or a string and a code reference. The
129string will be used as button text and the code reference will be called 132string will be used as button text and the code reference will be called
130when the button gets activated and should transform C<$_>. 133when the button gets activated and should transform C<$_>.
131 134
132The following will add an entry C<a to b> that transforms all C<a>s in 135The following will add an entry C<a to b> that transforms all C<a>s in
133the selection to C<b>s, but only if the selection currently contains any 136the selection to C<b>s, but only if the selection currently contains any
134C<a>s: 137C<a>s:
135 138
136 push @{ $self->{term}{selection_popup_hook} }, sub { 139 push @{ $self->{term}{selection_popup_hook} }, sub {
137 /a/ ? ("a to be" => sub { s/a/b/g } 140 /a/ ? ("a to b" => sub { s/a/b/g }
138 : () 141 : ()
139 }; 142 };
140 143
141=item searchable-scrollback<hotkey> (enabled by default) 144=item searchable-scrollback<hotkey> (enabled by default)
142 145
… …
149search. C<BackSpace> removes a character from the regex, C<Up> and C<Down> 152search. C<BackSpace> removes a character from the regex, C<Up> and C<Down>
150search upwards/downwards in the scrollback buffer, C<End> jumps to the 153search upwards/downwards in the scrollback buffer, C<End> jumps to the
151bottom. C<Escape> leaves search mode and returns to the point where search 154bottom. C<Escape> leaves search mode and returns to the point where search
152was started, while C<Enter> or C<Return> stay at the current position and 155was started, while C<Enter> or C<Return> stay at the current position and
153additionally stores the first match in the current line into the primary 156additionally stores the first match in the current line into the primary
154selection. 157selection if the C<Shift> modifier is active.
155 158
156The regex defaults to "(?i)", resulting in a case-insensitive search. To 159The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace> 160get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix. 161or simply use an uppercase character which removes the "(?i)" prefix.
159 162
… …
162=item readline (enabled by default) 165=item readline (enabled by default)
163 166
164A support package that tries to make editing with readline easier. At 167A support package that tries to make editing with readline easier. At
165the 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
166move 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
167cursor-left or cursor-right keypresses as required (the this only works 170cursor-left or cursor-right keypresses as required (this only works
168for programs that correctly support wide characters). 171for programs that correctly support wide characters).
169 172
170To avoid too many false positives, this is only done when: 173To avoid too many false positives, this is only done when:
171 174
172=over 4 175=over 4
… …
256The default pattern to match URLs can be overridden with the 259The default pattern to match URLs can be overridden with the
257C<matcher.pattern.0> resource, and additional patterns can be specified 260C<matcher.pattern.0> resource, and additional patterns can be specified
258with numbered patterns, in a manner similar to the "selection" extension. 261with numbered patterns, in a manner similar to the "selection" extension.
259The launcher can also be overridden on a per-pattern basis. 262The launcher can also be overridden on a per-pattern basis.
260 263
264It is possible to activate the most recently seen match from the keyboard.
265Simply bind a keysym to "perl:matcher" as seen in the example below.
266
261Example configuration: 267Example configuration:
262 268
263 URxvt.perl-ext: default,matcher 269 URxvt.perl-ext: default,matcher
264 URxvt.urlLauncher: sensible-browser 270 URxvt.urlLauncher: sensible-browser
265 URxvt.keysym.C-Delete: perl:matcher 271 URxvt.keysym.C-Delete: perl:matcher
… …
270 276
271=item xim-onthespot 277=item xim-onthespot
272 278
273This (experimental) perl extension implements OnTheSpot editing. It does 279This (experimental) perl extension implements OnTheSpot editing. It does
274not work perfectly, and some input methods don't seem to work well with 280not work perfectly, and some input methods don't seem to work well with
275OnTheSpot editing in general, but it seems to work at leats for SCIM and 281OnTheSpot editing in general, but it seems to work at least for SCIM and
276kinput2. 282kinput2.
277 283
278You enable it by specifying this extension and a preedit style of 284You enable it by specifying this extension and a preedit style of
279C<OnTheSpot>, i.e.: 285C<OnTheSpot>, i.e.:
280 286
… …
288will show or hide itself. Another press of the accelerator key will hide 294will show or hide itself. Another press of the accelerator key will hide
289or show it again. 295or show it again.
290 296
291Initially, the window will not be shown when using this extension. 297Initially, the window will not be shown when using this extension.
292 298
293This is useful if you need a single terminal thats not using any desktop 299This is useful if you need a single terminal that is not using any desktop
294space most of the time but is quickly available at the press of a key. 300space most of the time but is quickly available at the press of a key.
295 301
296The accelerator key is grabbed regardless of any modifiers, so this 302The accelerator key is grabbed regardless of any modifiers, so this
297extension will actually grab a physical key just for this function. 303extension will actually grab a physical key just for this function.
298 304
299If you want a quake-like animation, tell your window manager to do so 305If you want a quake-like animation, tell your window manager to do so
300(fvwm can do it). 306(fvwm can do it).
301 307
302=item automove-background 308=item overlay-osc
303 309
304This is basically a very small extension that dynamically changes the 310This extension implements some OSC commands to display timed popups on the
305background pixmap offset to the window position, in effect creating the 311screen - useful for status displays from within scripts. You have to read
306same effect as pseudo transparency with a custom pixmap. No scaling is 312the sources for more info.
307supported in this mode. Example:
308
309 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
310 313
311=item block-graphics-to-ascii 314=item block-graphics-to-ascii
312 315
313A not very useful example of filtering all text output to the terminal 316A not very useful example of filtering all text output to the terminal
314by replacing all line-drawing characters (U+2500 .. U+259F) by a 317by replacing all line-drawing characters (U+2500 .. U+259F) by a
… …
319Displays a digital clock using the built-in overlay. 322Displays a digital clock using the built-in overlay.
320 323
321=item remote-clipboard 324=item remote-clipboard
322 325
323Somewhat of a misnomer, this extension adds two menu entries to the 326Somewhat of a misnomer, this extension adds two menu entries to the
324selection popup that allows one ti run external commands to store the 327selection popup that allows one to run external commands to store the
325selection somewhere and fetch it again. 328selection somewhere and fetch it again.
326 329
327We use it to implement a "distributed selection mechanism", which just 330We use it to implement a "distributed selection mechanism", which just
328means that one command uploads the file to a remote server, and another 331means that one command uploads the file to a remote server, and another
329reads it. 332reads it.
… …
369 372
370I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret 373I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
371the double C</> characters as comment start. Use C<\057\057> instead, 374the double C</> characters as comment start. Use C<\057\057> instead,
372which works regardless of wether xrdb is used to parse the resource file 375which works regardless of wether xrdb is used to parse the resource file
373or not. 376or not.
377
378=item macosx-pastebin and macosx-pastebin-native
379
380These two modules implement an extended clipboard for Mac OS X. They are
381used like this:
382
383 URxvt.perl-ext-common: default,macosx-clipboard
384 URxvt.keysym.M-c: perl:macosx-clipboard:copy
385 URxvt.keysym.M-v: perl:macosx-clipboard:paste
386
387The difference between them is that the native variant requires a
388perl from apple's devkit or so, and C<maxosx-pastebin> requires the
389C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
390simpler etc. etc.
374 391
375=item example-refresh-hooks 392=item example-refresh-hooks
376 393
377Displays a very simple digital clock in the upper right corner of the 394Displays a very simple digital clock in the upper right corner of the
378window. Illustrates overwriting the refresh callbacks to create your own 395window. Illustrates overwriting the refresh callbacks to create your own
… …
544 561
545It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 562It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
546$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 563$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
547number of lines that will be in the scrollback buffer. 564number of lines that will be in the scrollback buffer.
548 565
549=item on_osc_seq $term, $op, $args 566=item on_osc_seq $term, $op, $args, $resp
550 567
551Called on every OSC sequence and can be used to suppress it or modify its 568Called on every OSC sequence and can be used to suppress it or modify its
552behaviour. The default should be to return an empty list. A true value 569behaviour. The default should be to return an empty list. A true value
553suppresses execution of the request completely. Make sure you don't get 570suppresses execution of the request completely. Make sure you don't get
554confused by recursive invocations when you output an osc sequence within 571confused by recursive invocations when you output an OSC sequence within
555this callback. 572this callback.
556 573
557C<on_osc_seq_perl> should be used for new behaviour. 574C<on_osc_seq_perl> should be used for new behaviour.
558 575
559=item on_osc_seq_perl $term, $string 576=item on_osc_seq_perl $term, $args, $resp
560 577
561Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 578Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
562operating system command) is processed. Cursor position and other state 579operating system command) is processed. Cursor position and other state
563information is up-to-date when this happens. For interoperability, the 580information is up-to-date when this happens. For interoperability, the
564string should start with the extension name and a colon, to distinguish 581string should start with the extension name (sans -osc) and a semicolon,
565it from commands for other extensions, and this might be enforced in the 582to distinguish it from commands for other extensions, and this might be
566future. 583enforced in the future.
584
585For example, C<overlay-osc> uses this:
586
587 sub on_osc_seq_perl {
588 my ($self, $osc, $resp) = @_;
589
590 return unless $osc =~ s/^overlay;//;
591
592 ... process remaining $osc string
593 }
567 594
568Be careful not ever to trust (in a security sense) the data you receive, 595Be careful not ever to trust (in a security sense) the data you receive,
569as its source can not easily be controlled (e-mail content, messages from 596as its source can not easily be controlled (e-mail content, messages from
570other users on the same system etc.). 597other users on the same system etc.).
598
599For responses, C<$resp> contains the end-of-args separator used by the
600sender.
571 601
572=item on_add_lines $term, $string 602=item on_add_lines $term, $string
573 603
574Called whenever text is about to be output, with the text as argument. You 604Called whenever text is about to be output, with the text as argument. You
575can filter/change and output the text yourself by returning a true value 605can filter/change and output the text yourself by returning a true value
… …
596later with the already-modified line (e.g. if unrelated parts change), so 626later with the already-modified line (e.g. if unrelated parts change), so
597you cannot just toggle rendition bits, but only set them. 627you cannot just toggle rendition bits, but only set them.
598 628
599=item on_refresh_begin $term 629=item on_refresh_begin $term
600 630
601Called just before the screen gets redrawn. Can be used for overlay 631Called just before the screen gets redrawn. Can be used for overlay or
602or similar effects by modify terminal contents in refresh_begin, and 632similar effects by modifying the terminal contents in refresh_begin, and
603restoring them in refresh_end. The built-in overlay and selection display 633restoring them in refresh_end. The built-in overlay and selection display
604code is run after this hook, and takes precedence. 634code is run after this hook, and takes precedence.
605 635
606=item on_refresh_end $term 636=item on_refresh_end $term
607 637
… …
918 local $TERM = shift; 948 local $TERM = shift;
919 my $htype = shift; 949 my $htype = shift;
920 950
921 if ($htype == 0) { # INIT 951 if ($htype == 0) { # INIT
922 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 952 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
923 953
924 my %ext_arg; 954 my %ext_arg;
925 955
926 { 956 {
927 my @init = @TERM_INIT; 957 my @init = @TERM_INIT;
928 @TERM_INIT = (); 958 @TERM_INIT = ();
… …
1094is that you cannot use blocking APIs, but the non-blocking variant should 1124is that you cannot use blocking APIs, but the non-blocking variant should
1095work. 1125work.
1096 1126
1097=cut 1127=cut
1098 1128
1099our $VERSION = 1; 1129our $VERSION = '5.23';
1100 1130
1101$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1131$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1102push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1132push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1103 1133
1104sub timer { 1134sub timer {
… …
1106 1136
1107 my $cb = $arg{cb}; 1137 my $cb = $arg{cb};
1108 1138
1109 urxvt::timer 1139 urxvt::timer
1110 ->new 1140 ->new
1111 ->start (urxvt::NOW + $arg{after}) 1141 ->after ($arg{after}, $arg{interval})
1112 ->cb (sub { 1142 ->cb ($arg{interval} ? $cb : sub {
1113 $_[0]->stop; # need to cancel manually 1143 $_[0]->stop; # need to cancel manually
1114 $cb->(); 1144 $cb->();
1115 }) 1145 })
1116} 1146}
1117 1147
1118sub io { 1148sub io {
1119 my ($class, %arg) = @_; 1149 my ($class, %arg) = @_;
1120 1150
1121 my $cb = $arg{cb}; 1151 my $cb = $arg{cb};
1152 my $fd = fileno $arg{fh};
1153 defined $fd or $fd = $arg{fh};
1122 1154
1123 bless [$arg{fh}, urxvt::iow 1155 bless [$arg{fh}, urxvt::iow
1124 ->new 1156 ->new
1125 ->fd (fileno $arg{fh}) 1157 ->fd ($fd)
1126 ->events (($arg{poll} =~ /r/ ? 1 : 0) 1158 ->events (($arg{poll} =~ /r/ ? 1 : 0)
1127 | ($arg{poll} =~ /w/ ? 2 : 0)) 1159 | ($arg{poll} =~ /w/ ? 2 : 0))
1128 ->start 1160 ->start
1129 ->cb (sub { 1161 ->cb ($cb)
1130 $cb->(($_[1] & 1 ? 'r' : '')
1131 . ($_[1] & 2 ? 'w' : ''));
1132 })],
1133 urxvt::anyevent:: 1162 ], urxvt::anyevent::
1163}
1164
1165sub idle {
1166 my ($class, %arg) = @_;
1167
1168 my $cb = $arg{cb};
1169
1170 urxvt::iw
1171 ->new
1172 ->start
1173 ->cb ($cb)
1174}
1175
1176sub child {
1177 my ($class, %arg) = @_;
1178
1179 my $cb = $arg{cb};
1180
1181 urxvt::pw
1182 ->new
1183 ->start ($arg{pid})
1184 ->cb (sub {
1185 $_[0]->stop; # need to cancel manually
1186 $cb->($_[0]->rpid, $_[0]->rstatus);
1187 })
1134} 1188}
1135 1189
1136sub DESTROY { 1190sub DESTROY {
1137 $_[0][1]->stop; 1191 $_[0][1]->stop;
1138}
1139
1140sub condvar {
1141 bless \my $flag, urxvt::anyevent::
1142}
1143
1144sub broadcast {
1145 ${$_[0]}++;
1146}
1147
1148sub wait {
1149 unless (${$_[0]}) {
1150 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1151 }
1152} 1192}
1153 1193
1154sub one_event { 1194sub one_event {
1155 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1195 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1156} 1196}
… …
1279Here is a likely non-exhaustive list of resource names, not all of which 1319Here is a likely non-exhaustive list of resource names, not all of which
1280are supported in every build, please see the source file F</src/rsinc.h> 1320are supported in every build, please see the source file F</src/rsinc.h>
1281to see the actual list: 1321to see the actual list:
1282 1322
1283 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1323 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1284 borderLess color cursorBlink cursorUnderline cutchars delete_key 1324 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1285 display_name embed ext_bwidth fade font geometry hold iconName 1325 display_name embed ext_bwidth fade font geometry hold iconName
1286 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1326 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1287 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1327 italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1288 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1328 modifier mouseWheelScrollPage name override_redirect pastableTabs path
1289 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1329 perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1290 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1330 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1291 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1331 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1292 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1332 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1293 secondaryScreen secondaryScroll selectstyle shade term_name title 1333 secondaryScreen secondaryScroll shade term_name title
1294 transient_for transparent transparent_all tripleclickwords utmpInhibit 1334 transient_for transparent transparent_all tripleclickwords utmpInhibit
1295 visualBell 1335 visualBell
1296 1336
1297=cut 1337=cut
1298 1338
1299sub resource($$;$) { 1339sub resource($$;$) {
1300 my ($self, $name) = (shift, shift); 1340 my ($self, $name) = (shift, shift);
1301 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1341 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1302 &urxvt::term::_resource 1342 goto &urxvt::term::_resource
1303} 1343}
1304 1344
1305=item $value = $term->x_resource ($pattern) 1345=item $value = $term->x_resource ($pattern)
1306 1346
1307Returns the X-Resource for the given pattern, excluding the program or 1347Returns the X-Resource for the given pattern, excluding the program or
… …
1390 1430
1391The methods currently supported on C<urxvt::overlay> objects are: 1431The methods currently supported on C<urxvt::overlay> objects are:
1392 1432
1393=over 4 1433=over 4
1394 1434
1395=item $overlay->set ($x, $y, $text, $rend) 1435=item $overlay->set ($x, $y, $text[, $rend])
1396 1436
1397Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts 1437Similar to C<< $term->ROW_t >> and C<< $term->ROW_r >> in that it puts
1398text in rxvt-unicode's special encoding and an array of rendition values 1438text in rxvt-unicode's special encoding and an array of rendition values
1399at a specific position inside the overlay. 1439at a specific position inside the overlay.
1440
1441If C<$rend> is missing, then the rendition will not be changed.
1400 1442
1401=item $overlay->hide 1443=item $overlay->hide
1402 1444
1403If visible, hide the overlay, but do not destroy it. 1445If visible, hide the overlay, but do not destroy it.
1404 1446
… …
1614 1656
1615Used after changing terminal contents to display them. 1657Used after changing terminal contents to display them.
1616 1658
1617=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1659=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1618 1660
1619Returns the text of the entire row with number C<$row_number>. Row C<0> 1661Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1620is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1662is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1621terminal line. The scrollback buffer starts at line C<-1> and extends to
1622line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1663terminal line. Nothing will be returned if a nonexistent line
1623is requested. 1664is requested.
1624 1665
1625If C<$new_text> is specified, it will replace characters in the current 1666If C<$new_text> is specified, it will replace characters in the current
1626line, starting at column C<$start_col> (default C<0>), which is useful 1667line, starting at column C<$start_col> (default C<0>), which is useful
1627to replace only parts of a line. The font index in the rendition will 1668to replace only parts of a line. The font index in the rendition will
1628automatically be updated. 1669automatically be updated.
1629 1670
1630C<$text> is in a special encoding: tabs and wide characters that use more 1671C<$text> is in a special encoding: tabs and wide characters that use more
1631than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1672than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1632characters. Characters with combining characters and other characters that 1673characters. Characters with combining characters and other characters that
1633do not fit into the normal tetx encoding will be replaced with characters 1674do not fit into the normal text encoding will be replaced with characters
1634in the private use area. 1675in the private use area.
1635 1676
1636You have to obey this encoding when changing text. The advantage is 1677You have to obey this encoding when changing text. The advantage is
1637that C<substr> and similar functions work on screen cells and not on 1678that C<substr> and similar functions work on screen cells and not on
1638characters. 1679characters.
… …
1825 1866
1826=item @atoms = $term->XListProperties ($window) 1867=item @atoms = $term->XListProperties ($window)
1827 1868
1828=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1869=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1829 1870
1830=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1871=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1831 1872
1832=item $term->XDeleteProperty ($window, $property) 1873=item $term->XDeleteProperty ($window, $property)
1833 1874
1834=item $window = $term->DefaultRootWindow 1875=item $window = $term->DefaultRootWindow
1835 1876
… …
1957 my $env = $self->{term}->env; 1998 my $env = $self->{term}->env;
1958 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1999 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1959 delete $env->{LC_ALL}; 2000 delete $env->{LC_ALL};
1960 $env->{LC_CTYPE} = $self->{term}->locale; 2001 $env->{LC_CTYPE} = $self->{term}->locale;
1961 2002
1962 urxvt::term->new ($env, "popup", 2003 my $term = urxvt::term->new (
2004 $env, "popup",
1963 "--perl-lib" => "", "--perl-ext-common" => "", 2005 "--perl-lib" => "", "--perl-ext-common" => "",
1964 "-pty-fd" => -1, "-sl" => 0, 2006 "-pty-fd" => -1, "-sl" => 0,
1965 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 2007 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1966 "--transient-for" => $self->{term}->parent, 2008 "--transient-for" => $self->{term}->parent,
1967 "-display" => $self->{term}->display_id, 2009 "-display" => $self->{term}->display_id,
1968 "-pe" => "urxvt-popup") 2010 "-pe" => "urxvt-popup",
1969 or die "unable to create popup window\n"; 2011 ) or die "unable to create popup window\n";
2012
2013 unless (delete $term->{urxvt_popup_init_done}) {
2014 $term->ungrab;
2015 $term->destroy;
2016 die "unable to initialise popup window\n";
2017 }
1970} 2018}
1971 2019
1972sub DESTROY { 2020sub DESTROY {
1973 my ($self) = @_; 2021 my ($self) = @_;
1974 2022
… …
1992 ->new 2040 ->new
1993 ->interval (1) 2041 ->interval (1)
1994 ->cb (sub { 2042 ->cb (sub {
1995 $term->{overlay}->set (0, 0, 2043 $term->{overlay}->set (0, 0,
1996 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]); 2044 sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
1997 }); 2045 });
1998 2046
1999=over 4 2047=over 4
2000 2048
2001=item $timer = new urxvt::timer 2049=item $timer = new urxvt::timer
2002 2050
… …
2005 2053
2006=item $timer = $timer->cb (sub { my ($timer) = @_; ... }) 2054=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2007 2055
2008Set the callback to be called when the timer triggers. 2056Set the callback to be called when the timer triggers.
2009 2057
2010=item $tstamp = $timer->at
2011
2012Return the time this watcher will fire next.
2013
2014=item $timer = $timer->set ($tstamp) 2058=item $timer = $timer->set ($tstamp[, $interval])
2015 2059
2016Set the time the event is generated to $tstamp. 2060Set the time the event is generated to $tstamp (and optionally specifies a
2061new $interval).
2017 2062
2018=item $timer = $timer->interval ($interval) 2063=item $timer = $timer->interval ($interval)
2019 2064
2020Normally (and when C<$interval> is C<0>), the timer will automatically 2065By default (and when C<$interval> is C<0>), the timer will automatically
2021stop after it has fired once. If C<$interval> is non-zero, then the timer 2066stop after it has fired once. If C<$interval> is non-zero, then the timer
2022is automatically rescheduled at the given intervals. 2067is automatically rescheduled at the given intervals.
2023 2068
2024=item $timer = $timer->start 2069=item $timer = $timer->start
2025 2070
2026Start the timer. 2071Start the timer.
2027 2072
2028=item $timer = $timer->start ($tstamp) 2073=item $timer = $timer->start ($tstamp[, $interval])
2029 2074
2030Set the event trigger time to C<$tstamp> and start the timer. 2075Set the event trigger time to C<$tstamp> and start the timer. Optionally
2076also replaces the interval.
2031 2077
2032=item $timer = $timer->after ($delay) 2078=item $timer = $timer->after ($delay[, $interval])
2033 2079
2034Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>. 2080Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2035 2081
2036=item $timer = $timer->stop 2082=item $timer = $timer->stop
2037 2083
… …
2045 2091
2046 $term->{socket} = ... 2092 $term->{socket} = ...
2047 $term->{iow} = urxvt::iow 2093 $term->{iow} = urxvt::iow
2048 ->new 2094 ->new
2049 ->fd (fileno $term->{socket}) 2095 ->fd (fileno $term->{socket})
2050 ->events (urxvt::EVENT_READ) 2096 ->events (urxvt::EV_READ)
2051 ->start 2097 ->start
2052 ->cb (sub { 2098 ->cb (sub {
2053 my ($iow, $revents) = @_; 2099 my ($iow, $revents) = @_;
2054 # $revents must be 1 here, no need to check 2100 # $revents must be 1 here, no need to check
2055 sysread $term->{socket}, my $buf, 8192 2101 sysread $term->{socket}, my $buf, 8192
… …
2073Set the file descriptor (not handle) to watch. 2119Set the file descriptor (not handle) to watch.
2074 2120
2075=item $iow = $iow->events ($eventmask) 2121=item $iow = $iow->events ($eventmask)
2076 2122
2077Set the event mask to watch. The only allowed values are 2123Set the event mask to watch. The only allowed values are
2078C<urxvt::EVENT_READ> and C<urxvt::EVENT_WRITE>, which might be ORed 2124C<urxvt::EV_READ> and C<urxvt::EV_WRITE>, which might be ORed
2079together, or C<urxvt::EVENT_NONE>. 2125together, or C<urxvt::EV_NONE>.
2080 2126
2081=item $iow = $iow->start 2127=item $iow = $iow->start
2082 2128
2083Start watching for requested events on the given handle. 2129Start watching for requested events on the given handle.
2084 2130
… …
2125 ->new 2171 ->new
2126 ->start ($pid) 2172 ->start ($pid)
2127 ->cb (sub { 2173 ->cb (sub {
2128 my ($pw, $exit_status) = @_; 2174 my ($pw, $exit_status) = @_;
2129 ... 2175 ...
2130 }); 2176 });
2131 2177
2132=over 4 2178=over 4
2133 2179
2134=item $pw = new urxvt::pw 2180=item $pw = new urxvt::pw
2135 2181

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines