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.106 by root, Wed Jan 18 19:44:22 2006 UTC vs.
Revision 1.142 by root, Thu Jul 6 18:56:10 2006 UTC

34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>. 34find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35 35
36You can activate them like this: 36You can activate them like this:
37 37
38 @@RXVT_NAME@@ -pe <extensionname> 38 @@RXVT_NAME@@ -pe <extensionname>
39
40Or by adding them to the resource for extensions loaded by default:
41
42 URxvt.perl-ext-common: default,automove-background,selection-autotransform
39 43
40=over 4 44=over 4
41 45
42=item selection (enabled by default) 46=item selection (enabled by default)
43 47
63the match. For example, the followign adds a regex that matches everything 67the match. For example, the followign adds a regex that matches everything
64between two vertical bars: 68between two vertical bars:
65 69
66 URxvt.selection.pattern-0: \\|([^|]+)\\| 70 URxvt.selection.pattern-0: \\|([^|]+)\\|
67 71
72Another example: Programs I use often output "absolute path: " at the
73beginning of a line when they process multiple files. The following
74pattern matches the filename (note, there is a single space at the very
75end):
76
77 URxvt.selection.pattern-0: ^(/[^:]+):\
78
68You can look at the source of the selection extension to see more 79You can look at the source of the selection extension to see more
69interesting uses, such as parsing a line from beginning to end. 80interesting uses, such as parsing a line from beginning to end.
70 81
71This extension also offers following bindable keyboard commands: 82This extension also offers following bindable keyboard commands:
72 83
83=item option-popup (enabled by default) 94=item option-popup (enabled by default)
84 95
85Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at 96Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
86runtime. 97runtime.
87 98
99Other extensions can extend this popup menu by pushing a code reference
100onto C<@{ $term->{option_popup_hook} }>, which gets called whenever the
101popup is being displayed.
102
103It's 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
105reference. 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
107first argument.
108
109The following will add an entry C<myoption> that changes
110C<$self->{myoption}>:
111
112 push @{ $self->{term}{option_popup_hook} }, sub {
113 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
114 };
115
88=item selection-popup (enabled by default) 116=item selection-popup (enabled by default)
89 117
90Binds a popup menu to Ctrl-Button3 that lets you convert the selection 118Binds a popup menu to Ctrl-Button3 that lets you convert the selection
91text into various other formats/action (such as uri unescaping, perl 119text into various other formats/action (such as uri unescaping, perl
92evalution, web-browser starting etc.), depending on content. 120evaluation, web-browser starting etc.), depending on content.
93 121
94Other extensions can extend this popup menu by pushing a code reference onto 122Other extensions can extend this popup menu by pushing a code reference
95C<@urxvt::ext::selection_popup::hook>, that is called whenever the popup is displayed. 123onto C<@{ $term->{selection_popup_hook} }>, which gets called whenever the
124popup is being displayed.
96 125
97It's sole argument is the popup menu, which can be modified. The selection 126It's sole argument is the popup menu, which can be modified. The selection
98is in C<$_>, which can be used to decide wether to add something or not. 127is in C<$_>, which can be used to decide wether to add something or not.
99It should either return nothing or a string and a code reference. The 128It should either return nothing or a string and a code reference. The
100string will be used as button text and the code reference will be called 129string will be used as button text and the code reference will be called
102 131
103The following will add an entry C<a to b> that transforms all C<a>s in 132The following will add an entry C<a to b> that transforms all C<a>s in
104the selection to C<b>s, but only if the selection currently contains any 133the selection to C<b>s, but only if the selection currently contains any
105C<a>s: 134C<a>s:
106 135
107 push urxvt::ext::selection_popup::hook, sub { 136 push @{ $self->{term}{selection_popup_hook} }, sub {
108 /a/ ? ("a to be" => sub { s/a/b/g } 137 /a/ ? ("a to be" => sub { s/a/b/g }
109 : () 138 : ()
110 }; 139 };
111 140
112=item searchable-scrollback<hotkey> (enabled by default) 141=item searchable-scrollback<hotkey> (enabled by default)
122bottom. C<Escape> leaves search mode and returns to the point where search 151bottom. C<Escape> leaves search mode and returns to the point where search
123was started, while C<Enter> or C<Return> stay at the current position and 152was started, while C<Enter> or C<Return> stay at the current position and
124additionally stores the first match in the current line into the primary 153additionally stores the first match in the current line into the primary
125selection. 154selection.
126 155
156The regex defaults to "(?i)", resulting in a case-insensitive search. To
157get a case-sensitive search you can delete this prefix using C<BackSpace>
158or simply use an uppercase character which removes the "(?i)" prefix.
159
160See L<perlre> for more info about perl regular expression syntax.
161
162=item readline (enabled by default)
163
164A support package that tries to make editing with readline easier. At
165the 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
167cursor-left or cursor-right keypresses as required (the this only works
168for programs that correctly support wide characters).
169
170To avoid too many false positives, this is only done when:
171
172=over 4
173
174=item - the tty is in ICANON state.
175
176=item - the text cursor is visible.
177
178=item - the primary screen is currently being displayed.
179
180=item - the mouse is on the same (multi-row-) line as the text cursor.
181
182=back
183
184The normal selection mechanism isn't disabled, so quick successive clicks
185might interfere with selection creation in harmless ways.
186
127=item selection-autotransform 187=item selection-autotransform
128 188
129This selection allows you to do automatic transforms on a selection 189This selection allows you to do automatic transforms on a selection
130whenever a selection is made. 190whenever a selection is made.
131 191
143 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/ 203 URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
144 204
145And this example matches the same,but replaces it with vi-commands you can 205And this example matches the same,but replaces it with vi-commands you can
146paste directly into your (vi :) editor: 206paste directly into your (vi :) editor:
147 207
148 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/\\x1b:e \\Q$1\\E\\x0d:$2\\x0d/ 208 URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
149 209
150Of course, this can be modified to suit your needs and your editor :) 210Of course, this can be modified to suit your needs and your editor :)
151 211
152To expand the example above to typical perl error messages ("XXX at 212To expand the example above to typical perl error messages ("XXX at
153FILENAME line YYY."), you need a slightly more elaborate solution: 213FILENAME line YYY."), you need a slightly more elaborate solution:
154 214
155 URxvt.selection.pattern-0: ( at .*? line \\d+\\.) 215 URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
156 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)\\.$/\x1b:e \\Q$1\E\\x0d:$2\\x0d/ 216 URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
157 217
158The first line tells the selection code to treat the unchanging part of 218The first line tells the selection code to treat the unchanging part of
159every error message as a selection pattern, and the second line transforms 219every error message as a selection pattern, and the second line transforms
160the message into vi commands to load the file. 220the message into vi commands to load the file.
221
222=item tabbed
223
224This transforms the terminal into a tabbar with additional terminals, that
225is, it implements what is commonly refered to as "tabbed terminal". The topmost line
226displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
227button per tab.
228
229Clicking a button will activate that tab. Pressing B<Shift-Left> and
230B<Shift-Right> will switch to the tab left or right of the current one,
231while B<Shift-Down> creates a new tab.
232
233The tabbar itself can be configured similarly to a normal terminal, but
234with a resource class of C<URxvt.tabbed>. In addition, it supports the
235following four resources (shown with defaults):
236
237 URxvt.tabbed.tabbar-fg: <colour-index, default 3>
238 URxvt.tabbed.tabbar-bg: <colour-index, default 0>
239 URxvt.tabbed.tab-fg: <colour-index, default 0>
240 URxvt.tabbed.tab-bg: <colour-index, default 1>
241
242See I<COLOR AND GRAPHICS> in the @@RXVT_NAME@@(1) manpage for valid
243indices.
161 244
162=item mark-urls 245=item mark-urls
163 246
164Uses per-line display filtering (C<on_line_update>) to underline urls and 247Uses per-line display filtering (C<on_line_update>) to underline urls and
165make them clickable. When middle-clicked, the program specified in the 248make them clickable. When middle-clicked, the program specified in the
166resource C<urlLauncher> (default C<x-www-browser>) will be started with 249resource C<urlLauncher> (default C<x-www-browser>) will be started with
167the URL as first argument. 250the URL as first argument.
168 251
252=item xim-onthespot
253
254This (experimental) perl extension implements OnTheSpot editing. It does
255not work perfectly, and some input methods don't seem to work well with
256OnTheSpot editing in general, but it seems to work at leats for SCIM and
257kinput2.
258
259You enable it by specifying this extension and a preedit style of
260C<OnTheSpot>, i.e.:
261
262 @@RXVT_NAME@@ -pt OnTheSpot -pe xim-onthespot
263
169=item automove-background 264=item automove-background
170 265
171This is basically a one-line extension that dynamically changes the background pixmap offset 266This is basically a very small extension that dynamically changes the
172to the window position, in effect creating the same effect as pseudo transparency with 267background pixmap offset to the window position, in effect creating the
173a custom pixmap. No scaling is supported in this mode. Exmaple: 268same effect as pseudo transparency with a custom pixmap. No scaling is
269supported in this mode. Exmaple:
174 270
175 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background 271 @@RXVT_NAME@@ -pixmap background.xpm -pe automove-background
176 272
177=item block-graphics-to-ascii 273=item block-graphics-to-ascii
178 274
179A not very useful example of filtering all text output to the terminal, 275A not very useful example of filtering all text output to the terminal
180by replacing all line-drawing characters (U+2500 .. U+259F) by a 276by replacing all line-drawing characters (U+2500 .. U+259F) by a
181similar-looking ascii character. 277similar-looking ascii character.
182 278
183=item digital-clock 279=item digital-clock
184 280
185Displays a digital clock using the built-in overlay. 281Displays a digital clock using the built-in overlay.
186 282
187=item example-refresh-hooks 283=item remote-clipboard
188 284
189Displays a very simple digital clock in the upper right corner of the 285Somewhat of a misnomer, this extension adds two menu entries to the
190window. Illustrates overwriting the refresh callbacks to create your own 286selection popup that allows one ti run external commands to store the
191overlays or changes. 287selection somewhere and fetch it again.
288
289We use it to implement a "distributed selection mechanism", which just
290means that one command uploads the file to a remote server, and another
291reads it.
292
293The commands can be set using the C<URxvt.remote-selection.store> and
294C<URxvt.remote-selection.fetch> resources. The first should read the
295selection to store from STDIN (always in UTF-8), the second should provide
296the selection data on STDOUT (also in UTF-8).
297
298The defaults (which are likely useless to you) use rsh and cat:
299
300 URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
301 URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
192 302
193=item selection-pastebin 303=item selection-pastebin
194 304
195This is a little rarely useful extension that Uploads the selection as 305This is a little rarely useful extension that Uploads the selection as
196textfile to a remote site (or does other things). (The implementation is 306textfile to a remote site (or does other things). (The implementation is
216After a successful upload the selection will be replaced by the text given 326After a successful upload the selection will be replaced by the text given
217in the C<selection-pastebin-url> resource (again, the % is the placeholder 327in the C<selection-pastebin-url> resource (again, the % is the placeholder
218for the filename): 328for the filename):
219 329
220 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/% 330 URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
331
332=item example-refresh-hooks
333
334Displays a very simple digital clock in the upper right corner of the
335window. Illustrates overwriting the refresh callbacks to create your own
336overlays or changes.
221 337
222=back 338=back
223 339
224=head1 API DOCUMENTATION 340=head1 API DOCUMENTATION
225 341
259 375
260=back 376=back
261 377
262=head2 Extension Objects 378=head2 Extension Objects
263 379
264Very perl extension is a perl class. A separate perl object is created 380Every perl extension is a perl class. A separate perl object is created
265for each terminal and each extension and passed as the first parameter to 381for each terminal and each extension and passed as the first parameter to
266hooks. So extensions can use their C<$self> object without having to think 382hooks. So extensions can use their C<$self> object without having to think
267about other extensions, with the exception of methods and members that 383about other extensions, with the exception of methods and members that
268begin with an underscore character C<_>: these are reserved for internal 384begin with an underscore character C<_>: these are reserved for internal
269use. 385use.
298called whenever the relevant event happens. 414called whenever the relevant event happens.
299 415
300The first argument passed to them is an extension oject as described in 416The first argument passed to them is an extension oject as described in
301the in the C<Extension Objects> section. 417the in the C<Extension Objects> section.
302 418
303B<All> of these hooks must return a boolean value. If it is true, then the 419B<All> of these hooks must return a boolean value. If any of the called
304event counts as being I<consumed>, and the invocation of other hooks is 420hooks returns true, then the event counts as being I<consumed>, and the
305skipped, and the relevant action might not be carried out by the C++ code. 421relevant action might not be carried out by the C++ code.
306 422
307I<< When in doubt, return a false value (preferably C<()>). >> 423I<< When in doubt, return a false value (preferably C<()>). >>
308 424
309=over 4 425=over 4
310 426
311=item on_init $term 427=item on_init $term
312 428
313Called after a new terminal object has been initialized, but before 429Called after a new terminal object has been initialized, but before
314windows are created or the command gets run. Most methods are unsafe to 430windows are created or the command gets run. Most methods are unsafe to
315call or deliver senseless data, as terminal size and other characteristics 431call or deliver senseless data, as terminal size and other characteristics
316have not yet been determined. You can safely query and change resources, 432have not yet been determined. You can safely query and change resources
317though. 433and options, though. For many purposes the C<on_start> hook is a better
434place.
435
436=item on_start $term
437
438Called at the very end of initialisation of a new terminal, just before
439trying to map (display) the toplevel and returning to the mainloop.
440
441=item on_destroy $term
442
443Called whenever something tries to destroy terminal, when the terminal is
444still fully functional (not for long, though).
318 445
319=item on_reset $term 446=item on_reset $term
320 447
321Called after the screen is "reset" for any reason, such as resizing or 448Called after the screen is "reset" for any reason, such as resizing or
322control sequences. Here is where you can react on changes to size-related 449control sequences. Here is where you can react on changes to size-related
323variables. 450variables.
324 451
325=item on_start $term 452=item on_child_start $term, $pid
326 453
327Called at the very end of initialisation of a new terminal, just before 454Called just after the child process has been C<fork>ed.
328returning to the mainloop. 455
456=item on_child_exit $term, $status
457
458Called just after the child process has exited. C<$status> is the status
459from C<waitpid>.
329 460
330=item on_sel_make $term, $eventtime 461=item on_sel_make $term, $eventtime
331 462
332Called whenever a selection has been made by the user, but before the 463Called whenever a selection has been made by the user, but before the
333selection text is copied, so changes to the beginning, end or type of the 464selection text is copied, so changes to the beginning, end or type of the
369 500
370It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 501It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
371$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 502$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
372number of lines that will be in the scrollback buffer. 503number of lines that will be in the scrollback buffer.
373 504
505=item on_osc_seq $term, $op, $args
506
507Called on every OSC sequence and can be used to suppress it or modify its
508behaviour. The default should be to return an empty list. A true value
509suppresses execution of the request completely. Make sure you don't get
510confused by recursive invocations when you output an osc sequence within
511this callback.
512
513C<on_osc_seq_perl> should be used for new behaviour.
514
374=item on_osc_seq $term, $string 515=item on_osc_seq_perl $term, $string
375 516
376Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 517Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
377operating system command) is processed. Cursor position and other state 518operating system command) is processed. Cursor position and other state
378information is up-to-date when this happens. For interoperability, the 519information is up-to-date when this happens. For interoperability, the
379string should start with the extension name and a colon, to distinguish 520string should start with the extension name and a colon, to distinguish
420 561
421=item on_refresh_end $term 562=item on_refresh_end $term
422 563
423Called just after the screen gets redrawn. See C<on_refresh_begin>. 564Called just after the screen gets redrawn. See C<on_refresh_begin>.
424 565
425=item on_keyboard_command $term, $string 566=item on_user_command $term, $string
426 567
427Called whenever the user presses a key combination that has a 568Called whenever the a user-configured event is being activated (e.g. via
428C<perl:string> action bound to it (see description of the B<keysym> 569a C<perl:string> action bound to a key, see description of the B<keysym>
429resource in the @@RXVT_NAME@@(1) manpage). 570resource in the @@RXVT_NAME@@(1) manpage).
571
572The event is simply the action string. This interface is assumed to change
573slightly in the future.
574
575=item on_resize_all_windows $tern, $new_width, $new_height
576
577Called just after the new window size has been calculcated, but before
578windows are actually being resized or hints are being set. If this hook
579returns TRUE, setting of the window hints is being skipped.
430 580
431=item on_x_event $term, $event 581=item on_x_event $term, $event
432 582
433Called on every X event received on the vt window (and possibly other 583Called on every X event received on the vt window (and possibly other
434windows). Should only be used as a last resort. Most event structure 584windows). Should only be used as a last resort. Most event structure
444Called wheneever the window loses keyboard focus, before rxvt-unicode does 594Called wheneever the window loses keyboard focus, before rxvt-unicode does
445focus out processing. 595focus out processing.
446 596
447=item on_configure_notify $term, $event 597=item on_configure_notify $term, $event
448 598
599=item on_property_notify $term, $event
600
449=item on_key_press $term, $event, $keysym, $octets 601=item on_key_press $term, $event, $keysym, $octets
450 602
451=item on_key_release $term, $event, $keysym 603=item on_key_release $term, $event, $keysym
452 604
453=item on_button_press $term, $event 605=item on_button_press $term, $event
462 614
463Called whenever the corresponding X event is received for the terminal If 615Called whenever the corresponding X event is received for the terminal If
464the hook returns true, then the even will be ignored by rxvt-unicode. 616the hook returns true, then the even will be ignored by rxvt-unicode.
465 617
466The event is a hash with most values as named by Xlib (see the XEvent 618The event is a hash with most values as named by Xlib (see the XEvent
467manpage), with the additional members C<row> and C<col>, which are the row 619manpage), with the additional members C<row> and C<col>, which are the
468and column under the mouse cursor. 620(real, not screen-based) row and column under the mouse cursor.
469 621
470C<on_key_press> additionally receives the string rxvt-unicode would 622C<on_key_press> additionally receives the string rxvt-unicode would
471output, if any, in locale-specific encoding. 623output, if any, in locale-specific encoding.
472 624
473subwindow. 625subwindow.
626
627=item on_client_message $term, $event
628
629=item on_wm_protocols $term, $event
630
631=item on_wm_delete_window $term, $event
632
633Called when various types of ClientMessage events are received (all with
634format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
474 635
475=back 636=back
476 637
477=cut 638=cut
478 639
484use Scalar::Util (); 645use Scalar::Util ();
485use List::Util (); 646use List::Util ();
486 647
487our $VERSION = 1; 648our $VERSION = 1;
488our $TERM; 649our $TERM;
650our @TERM_INIT;
651our @TERM_EXT;
489our @HOOKNAME; 652our @HOOKNAME;
490our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME; 653our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
491our %OPTION; 654our %OPTION;
492 655
493our $LIBDIR; 656our $LIBDIR;
494our $RESNAME; 657our $RESNAME;
495our $RESCLASS; 658our $RESCLASS;
496our $RXVTNAME; 659our $RXVTNAME;
497 660
661our $NOCHAR = chr 0xffff;
662
498=head2 Variables in the C<urxvt> Package 663=head2 Variables in the C<urxvt> Package
499 664
500=over 4 665=over 4
501 666
502=item $urxvt::LIBDIR 667=item $urxvt::LIBDIR
514 679
515=item $urxvt::TERM 680=item $urxvt::TERM
516 681
517The current terminal. This variable stores the current C<urxvt::term> 682The current terminal. This variable stores the current C<urxvt::term>
518object, whenever a callback/hook is executing. 683object, whenever a callback/hook is executing.
684
685=item @urxvt::TERM_INIT
686
687All coderefs in this array will be called as methods of the next newly
688created C<urxvt::term> object (during the C<on_init> phase). The array
689gets cleared before the codereferences that were in it are being executed,
690so coderefs can push themselves onto it again if they so desire.
691
692This complements to the perl-eval commandline option, but gets executed
693first.
694
695=item @urxvt::TERM_EXT
696
697Works similar to C<@TERM_INIT>, but contains perl package/class names, which
698get registered as normal extensions after calling the hooks in C<@TERM_INIT>
699but before other extensions. Gets cleared just like C<@TERM_INIT>.
519 700
520=back 701=back
521 702
522=head2 Functions in the C<urxvt> Package 703=head2 Functions in the C<urxvt> Package
523 704
537 718
538Using this function has the advantage that its output ends up in the 719Using this function has the advantage that its output ends up in the
539correct place, e.g. on stderr of the connecting urxvtc client. 720correct place, e.g. on stderr of the connecting urxvtc client.
540 721
541Messages have a size limit of 1023 bytes currently. 722Messages have a size limit of 1023 bytes currently.
723
724=item @terms = urxvt::termlist
725
726Returns all urxvt::term objects that exist in this process, regardless of
727wether they are started, being destroyed etc., so be careful. Only term
728objects that have perl extensions attached will be returned (because there
729is no urxvt::term objet associated with others).
542 730
543=item $time = urxvt::NOW 731=item $time = urxvt::NOW
544 732
545Returns the "current time" (as per the event loop). 733Returns the "current time" (as per the event loop).
546 734
604Return the foreground/background colour index, respectively. 792Return the foreground/background colour index, respectively.
605 793
606=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour 794=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
607 795
608=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour 796=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
797
798=item $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
609 799
610Replace the foreground/background colour in the rendition mask with the 800Replace the foreground/background colour in the rendition mask with the
611specified one. 801specified one.
612 802
613=item $value = urxvt::GET_CUSTOM $rend 803=item $value = urxvt::GET_CUSTOM $rend
630 my $msg = join "", @_; 820 my $msg = join "", @_;
631 $msg .= "\n" 821 $msg .= "\n"
632 unless $msg =~ /\n$/; 822 unless $msg =~ /\n$/;
633 urxvt::warn ($msg); 823 urxvt::warn ($msg);
634 }; 824 };
635
636 # %ENV is the original startup environment
637 delete $ENV{IFS};
638 delete $ENV{CDPATH};
639 delete $ENV{BASH_ENV};
640 $ENV{PATH} = "/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin:/usr/local/sbin:/opt/bin:/opt/sbin";
641} 825}
826
827no warnings 'utf8';
642 828
643my $verbosity = $ENV{URXVT_PERL_VERBOSITY}; 829my $verbosity = $ENV{URXVT_PERL_VERBOSITY};
644 830
645sub verbose { 831sub verbose {
646 my ($level, $msg) = @_; 832 my ($level, $msg) = @_;
650my %extension_pkg; 836my %extension_pkg;
651 837
652# load a single script into its own package, once only 838# load a single script into its own package, once only
653sub extension_package($) { 839sub extension_package($) {
654 my ($path) = @_; 840 my ($path) = @_;
655
656 no strict 'refs';
657 841
658 $extension_pkg{$path} ||= do { 842 $extension_pkg{$path} ||= do {
659 $path =~ /([^\/\\]+)$/; 843 $path =~ /([^\/\\]+)$/;
660 my $pkg = $1; 844 my $pkg = $1;
661 $pkg =~ s/[^[:word:]]/_/g; 845 $pkg =~ s/[^[:word:]]/_/g;
664 verbose 3, "loading extension '$path' into package '$pkg'"; 848 verbose 3, "loading extension '$path' into package '$pkg'";
665 849
666 open my $fh, "<:raw", $path 850 open my $fh, "<:raw", $path
667 or die "$path: $!"; 851 or die "$path: $!";
668 852
669 @{"$pkg\::ISA"} = urxvt::term::extension::;
670
671 my $source = 853 my $source =
672 "package $pkg; use strict; use utf8;\n" 854 "package $pkg; use strict; use utf8; no warnings 'utf8';\n"
673 . "#line 1 \"$path\"\n{\n" 855 . "#line 1 \"$path\"\n{\n"
674 . (do { local $/; <$fh> }) 856 . (do { local $/; <$fh> })
675 . "\n};\n1"; 857 . "\n};\n1";
676 858
677 eval $source 859 eval $source
691 if ($htype == 0) { # INIT 873 if ($htype == 0) { # INIT
692 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl"); 874 my @dirs = ((split /:/, $TERM->resource ("perl_lib")), "$LIBDIR/perl");
693 875
694 my %ext_arg; 876 my %ext_arg;
695 877
878 {
879 my @init = @TERM_INIT;
880 @TERM_INIT = ();
881 $_->($TERM) for @init;
882 my @pkg = @TERM_EXT;
883 @TERM_EXT = ();
884 $TERM->register_package ($_) for @pkg;
885 }
886
696 for (map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) { 887 for (grep $_, map { split /,/, $TERM->resource ("perl_ext_$_") } 1, 2) {
697 if ($_ eq "default") { 888 if ($_ eq "default") {
698 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback); 889 $ext_arg{$_} ||= [] for qw(selection option-popup selection-popup searchable-scrollback readline);
699 } elsif (/^-(.*)$/) { 890 } elsif (/^-(.*)$/) {
700 delete $ext_arg{$1}; 891 delete $ext_arg{$1};
701 } elsif (/^([^<]+)<(.*)>$/) { 892 } elsif (/^([^<]+)<(.*)>$/) {
702 push @{ $ext_arg{$1} }, $2; 893 push @{ $ext_arg{$1} }, $2;
703 } else { 894 } else {
704 $ext_arg{$_} ||= []; 895 $ext_arg{$_} ||= [];
705 } 896 }
706 } 897 }
707 898
708 while (my ($ext, $argv) = each %ext_arg) { 899 for my $ext (sort keys %ext_arg) {
709 my @files = grep -f $_, map "$_/$ext", @dirs; 900 my @files = grep -f $_, map "$_/$ext", @dirs;
710 901
711 if (@files) { 902 if (@files) {
712 $TERM->register_package (extension_package $files[0], $argv); 903 $TERM->register_package (extension_package $files[0], $ext_arg{$ext});
713 } else { 904 } else {
714 warn "perl extension '$ext' not found in perl library search path\n"; 905 warn "perl extension '$ext' not found in perl library search path\n";
715 } 906 }
716 } 907 }
717 908
723 914
724 if (my $cb = $TERM->{_hook}[$htype]) { 915 if (my $cb = $TERM->{_hook}[$htype]) {
725 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")" 916 verbose 10, "$HOOKNAME[$htype] (" . (join ", ", $TERM, @_) . ")"
726 if $verbosity >= 10; 917 if $verbosity >= 10;
727 918
728 keys %$cb; 919 for my $pkg (keys %$cb) {
729
730 while (my ($pkg, $cb) = each %$cb) {
731 $retval = eval { $cb->($TERM->{_pkg}{$pkg}, @_) } 920 my $retval_ = eval { $cb->{$pkg}->($TERM->{_pkg}{$pkg}, @_) };
732 and last; 921 $retval ||= $retval_;
733 922
734 if ($@) { 923 if ($@) {
735 $TERM->ungrab; # better to lose the grab than the session 924 $TERM->ungrab; # better to lose the grab than the session
736 warn $@; 925 warn $@;
737 } 926 }
750 } 939 }
751 940
752 $retval 941 $retval
753} 942}
754 943
755sub exec_async(@) { 944sub SET_COLOR($$$) {
756 my $pid = fork; 945 SET_BGCOLOR (SET_FGCOLOR ($_[0], $_[1]), $_[2])
757
758 return
759 if !defined $pid or $pid;
760
761 %ENV = %{ $TERM->env };
762
763 exec @_;
764 _exit 255;
765} 946}
766 947
767# urxvt::term::extension 948# urxvt::term::extension
768 949
769package urxvt::term::extension; 950package urxvt::term::extension;
908# find on_xxx subs in the package and register them 1089# find on_xxx subs in the package and register them
909# as hooks 1090# as hooks
910sub register_package { 1091sub register_package {
911 my ($self, $pkg, $argv) = @_; 1092 my ($self, $pkg, $argv) = @_;
912 1093
1094 no strict 'refs';
1095
1096 urxvt::verbose 6, "register package $pkg to $self";
1097
1098 @{"$pkg\::ISA"} = urxvt::term::extension::;
1099
913 my $proxy = bless { 1100 my $proxy = bless {
914 _pkg => $pkg, 1101 _pkg => $pkg,
915 argv => $argv, 1102 argv => $argv,
916 }, $pkg; 1103 }, $pkg;
917 Scalar::Util::weaken ($proxy->{term} = $self); 1104 Scalar::Util::weaken ($proxy->{term} = $self);
932hash which defines the environment of the new terminal. 1119hash which defines the environment of the new terminal.
933 1120
934Croaks (and probably outputs an error message) if the new instance 1121Croaks (and probably outputs an error message) if the new instance
935couldn't be created. Returns C<undef> if the new instance didn't 1122couldn't be created. Returns C<undef> if the new instance didn't
936initialise perl, and the terminal object otherwise. The C<init> and 1123initialise perl, and the terminal object otherwise. The C<init> and
937C<start> hooks will be called during this call. 1124C<start> hooks will be called before this call returns, and are free to
1125refer to global data (which is race free).
938 1126
939=cut 1127=cut
940 1128
941sub new { 1129sub new {
942 my ($class, $env, @args) = @_; 1130 my ($class, $env, @args) = @_;
943 1131
1132 $env or Carp::croak "environment hash missing in call to urxvt::term->new";
1133 @args or Carp::croak "name argument missing in call to urxvt::term->new";
1134
944 _new ([ map "$_=$env->{$_}", keys %$env ], @args); 1135 _new ([ map "$_=$env->{$_}", keys %$env ], \@args);
945} 1136}
946 1137
947=item $term->destroy 1138=item $term->destroy
948 1139
949Destroy the terminal object (close the window, free resources 1140Destroy the terminal object (close the window, free resources
950etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event 1141etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
951watchers (timers, io watchers) are still active. 1142watchers (timers, io watchers) are still active.
1143
1144=item $term->exec_async ($cmd[, @args])
1145
1146Works like the combination of the C<fork>/C<exec> builtins, which executes
1147("starts") programs in the background. This function takes care of setting
1148the user environment before exec'ing the command (e.g. C<PATH>) and should
1149be preferred over explicit calls to C<exec> or C<system>.
1150
1151Returns the pid of the subprocess or C<undef> on error.
1152
1153=cut
1154
1155sub exec_async {
1156 my $self = shift;
1157
1158 my $pid = fork;
1159
1160 return $pid
1161 if !defined $pid or $pid;
1162
1163 %ENV = %{ $self->env };
1164
1165 exec @_;
1166 urxvt::_exit 255;
1167}
952 1168
953=item $isset = $term->option ($optval[, $set]) 1169=item $isset = $term->option ($optval[, $set])
954 1170
955Returns true if the option specified by C<$optval> is enabled, and 1171Returns true if the option specified by C<$optval> is enabled, and
956optionally change it. All option values are stored by name in the hash 1172optionally change it. All option values are stored by name in the hash
1181 1397
1182Normally its not a good idea to use this function, as programs might be 1398Normally its not a good idea to use this function, as programs might be
1183confused by changes in cursor position or scrolling. Its useful inside a 1399confused by changes in cursor position or scrolling. Its useful inside a
1184C<on_add_lines> hook, though. 1400C<on_add_lines> hook, though.
1185 1401
1402=item $term->scr_change_screen ($screen)
1403
1404Switch to given screen - 0 primary, 1 secondary.
1405
1186=item $term->cmd_parse ($octets) 1406=item $term->cmd_parse ($octets)
1187 1407
1188Similar to C<scr_add_lines>, but the argument must be in the 1408Similar to C<scr_add_lines>, but the argument must be in the
1189locale-specific encoding of the terminal and can contain command sequences 1409locale-specific encoding of the terminal and can contain command sequences
1190(escape codes) that will be interpreted. 1410(escape codes) that will be interpreted.
1200Replaces the event mask of the pty watcher by the given event mask. Can 1420Replaces the event mask of the pty watcher by the given event mask. Can
1201be used to suppress input and output handling to the pty/tty. See the 1421be used to suppress input and output handling to the pty/tty. See the
1202description of C<< urxvt::timer->events >>. Make sure to always restore 1422description of C<< urxvt::timer->events >>. Make sure to always restore
1203the previous value. 1423the previous value.
1204 1424
1425=item $fd = $term->pty_fd
1426
1427Returns the master file descriptor for the pty in use, or C<-1> if no pty
1428is used.
1429
1205=item $windowid = $term->parent 1430=item $windowid = $term->parent
1206 1431
1207Return the window id of the toplevel window. 1432Return the window id of the toplevel window.
1208 1433
1209=item $windowid = $term->vt 1434=item $windowid = $term->vt
1215Adds the specified events to the vt event mask. Useful e.g. when you want 1440Adds the specified events to the vt event mask. Useful e.g. when you want
1216to receive pointer events all the times: 1441to receive pointer events all the times:
1217 1442
1218 $term->vt_emask_add (urxvt::PointerMotionMask); 1443 $term->vt_emask_add (urxvt::PointerMotionMask);
1219 1444
1445=item $term->focus_in
1446
1447=item $term->focus_out
1448
1449=item $term->key_press ($state, $keycode[, $time])
1450
1451=item $term->key_release ($state, $keycode[, $time])
1452
1453Deliver various fake events to to terminal.
1454
1220=item $window_width = $term->width 1455=item $window_width = $term->width
1221 1456
1222=item $window_height = $term->height 1457=item $window_height = $term->height
1223 1458
1224=item $font_width = $term->fwidth 1459=item $font_width = $term->fwidth
1254=item $env = $term->env 1489=item $env = $term->env
1255 1490
1256Returns a copy of the environment in effect for the terminal as a hashref 1491Returns a copy of the environment in effect for the terminal as a hashref
1257similar to C<\%ENV>. 1492similar to C<\%ENV>.
1258 1493
1494=item @envv = $term->envv
1495
1496Returns the environment as array of strings of the form C<VAR=VALUE>.
1497
1498=item @argv = $term->argv
1499
1500Return the argument vector as this terminal, similar to @ARGV, but
1501includes the program name as first element.
1502
1259=cut 1503=cut
1260 1504
1261sub env { 1505sub env {
1262 if (my $env = $_[0]->_env) {
1263 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env } 1506 +{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), $_[0]->envv }
1264 } else {
1265 +{ %ENV }
1266 }
1267} 1507}
1268 1508
1269=item $modifiermask = $term->ModLevel3Mask 1509=item $modifiermask = $term->ModLevel3Mask
1270 1510
1271=item $modifiermask = $term->ModMetaMask 1511=item $modifiermask = $term->ModMetaMask
1272 1512
1273=item $modifiermask = $term->ModNumLockMask 1513=item $modifiermask = $term->ModNumLockMask
1274 1514
1275Return the modifier masks corresponding to the "ISO Level 3 Shift" (often 1515Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
1276AltGr), the meta key (often Alt) and the num lock key, if applicable. 1516AltGr), the meta key (often Alt) and the num lock key, if applicable.
1517
1518=item $screen = $term->current_screen
1519
1520Returns the currently displayed screen (0 primary, 1 secondary).
1521
1522=item $cursor_is_hidden = $term->hidden_cursor
1523
1524Returns wether the cursor is currently hidden or not.
1277 1525
1278=item $view_start = $term->view_start ([$newvalue]) 1526=item $view_start = $term->view_start ([$newvalue])
1279 1527
1280Returns the row number of the topmost displayed line. Maximum value is 1528Returns the row number of the topmost displayed line. Maximum value is
1281C<0>, which displays the normal terminal contents. Lower values scroll 1529C<0>, which displays the normal terminal contents. Lower values scroll
1301line, starting at column C<$start_col> (default C<0>), which is useful 1549line, starting at column C<$start_col> (default C<0>), which is useful
1302to replace only parts of a line. The font index in the rendition will 1550to replace only parts of a line. The font index in the rendition will
1303automatically be updated. 1551automatically be updated.
1304 1552
1305C<$text> is in a special encoding: tabs and wide characters that use more 1553C<$text> is in a special encoding: tabs and wide characters that use more
1306than one cell when displayed are padded with urxvt::NOCHAR characters 1554than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1307(C<chr 65535>). Characters with combining characters and other characters 1555characters. Characters with combining characters and other characters that
1308that do not fit into the normal tetx encoding will be replaced with 1556do not fit into the normal tetx encoding will be replaced with characters
1309characters in the private use area. 1557in the private use area.
1310 1558
1311You have to obey this encoding when changing text. The advantage is 1559You have to obey this encoding when changing text. The advantage is
1312that C<substr> and similar functions work on screen cells and not on 1560that C<substr> and similar functions work on screen cells and not on
1313characters. 1561characters.
1314 1562
1461=item $string = $term->special_decode $text 1709=item $string = $term->special_decode $text
1462 1710
1463Converts rxvt-unicodes text reprsentation into a perl string. See 1711Converts rxvt-unicodes text reprsentation into a perl string. See
1464C<< $term->ROW_t >> for details. 1712C<< $term->ROW_t >> for details.
1465 1713
1466=item $success = $term->grab_button ($button, $modifiermask) 1714=item $success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])
1467 1715
1716=item $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
1717
1468Registers a synchronous button grab. See the XGrabButton manpage. 1718Register/unregister a synchronous button grab. See the XGrabButton
1719manpage.
1469 1720
1470=item $success = $term->grab ($eventtime[, $sync]) 1721=item $success = $term->grab ($eventtime[, $sync])
1471 1722
1472Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or 1723Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
1473synchronous (C<$sync> is true). Also remembers the grab timestampe. 1724synchronous (C<$sync> is true). Also remembers the grab timestampe.
1488=item $term->ungrab 1739=item $term->ungrab
1489 1740
1490Calls XUngrab for the most recent grab. Is called automatically on 1741Calls XUngrab for the most recent grab. Is called automatically on
1491evaluation errors, as it is better to lose the grab in the error case as 1742evaluation errors, as it is better to lose the grab in the error case as
1492the session. 1743the session.
1744
1745=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1746
1747=item $atom_name = $term->XGetAtomName ($atom)
1748
1749=item @atoms = $term->XListProperties ($window)
1750
1751=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1752
1753=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets)
1754
1755=item $term->XDeleteProperty ($window, $property)
1756
1757=item $window = $term->DefaultRootWindow
1758
1759=item $term->XReparentWindow ($window, $parent, [$x, $y])
1760
1761=item $term->XMapWindow ($window)
1762
1763=item $term->XUnmapWindow ($window)
1764
1765=item $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
1766
1767=item ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)
1768
1769=item $term->XChangeInput ($window, $add_events[, $del_events])
1770
1771Various X or X-related functions. The C<$term> object only serves as
1772the source of the display, otherwise those functions map more-or-less
1773directory onto the X functions of the same name.
1493 1774
1494=back 1775=back
1495 1776
1496=cut 1777=cut
1497 1778
1561 my ($self, $text, $cb) = @_; 1842 my ($self, $text, $cb) = @_;
1562 1843
1563 $self->add_item ({ type => "button", text => $text, activate => $cb}); 1844 $self->add_item ({ type => "button", text => $text, activate => $cb});
1564} 1845}
1565 1846
1566=item $popup->add_toggle ($text, $cb, $initial_value) 1847=item $popup->add_toggle ($text, $initial_value, $cb)
1567 1848
1568Adds a toggle/checkbox item to the popup. Teh callback gets called 1849Adds a toggle/checkbox item to the popup. The callback gets called
1569whenever it gets toggled, with a boolean indicating its value as its first 1850whenever it gets toggled, with a boolean indicating its new value as its
1570argument. 1851first argument.
1571 1852
1572=cut 1853=cut
1573 1854
1574sub add_toggle { 1855sub add_toggle {
1575 my ($self, $text, $cb, $value) = @_; 1856 my ($self, $text, $value, $cb) = @_;
1576 1857
1577 my $item; $item = { 1858 my $item; $item = {
1578 type => "button", 1859 type => "button",
1579 text => " $text", 1860 text => " $text",
1580 value => $value, 1861 value => $value,
1617 delete $self->{term}{_destroy}{$self}; 1898 delete $self->{term}{_destroy}{$self};
1618 $self->{term}->ungrab; 1899 $self->{term}->ungrab;
1619} 1900}
1620 1901
1621=back 1902=back
1903
1904=cut
1905
1906package urxvt::watcher;
1907
1908@urxvt::timer::ISA = __PACKAGE__;
1909@urxvt::iow::ISA = __PACKAGE__;
1910@urxvt::pw::ISA = __PACKAGE__;
1911@urxvt::iw::ISA = __PACKAGE__;
1622 1912
1623=head2 The C<urxvt::timer> Class 1913=head2 The C<urxvt::timer> Class
1624 1914
1625This class implements timer watchers/events. Time is represented as a 1915This class implements timer watchers/events. Time is represented as a
1626fractional number of seconds since the epoch. Example: 1916fractional number of seconds since the epoch. Example:
1724 2014
1725Stop watching for events on the given filehandle. 2015Stop watching for events on the given filehandle.
1726 2016
1727=back 2017=back
1728 2018
2019=head2 The C<urxvt::iw> Class
2020
2021This class implements idle watchers, that get called automatically when
2022the process is idle. They should return as fast as possible, after doing
2023some useful work.
2024
2025=over 4
2026
2027=item $iw = new urxvt::iw
2028
2029Create a new idle watcher object in stopped state.
2030
2031=item $iw = $iw->cb (sub { my ($iw) = @_; ... })
2032
2033Set the callback to be called when the watcher triggers.
2034
2035=item $timer = $timer->start
2036
2037Start the watcher.
2038
2039=item $timer = $timer->stop
2040
2041Stop the watcher.
2042
2043=back
2044
2045=head2 The C<urxvt::pw> Class
2046
2047This class implements process watchers. They create an event whenever a
2048process exits, after which they stop automatically.
2049
2050 my $pid = fork;
2051 ...
2052 $term->{pw} = urxvt::pw
2053 ->new
2054 ->start ($pid)
2055 ->cb (sub {
2056 my ($pw, $exit_status) = @_;
2057 ...
2058 });
2059
2060=over 4
2061
2062=item $pw = new urxvt::pw
2063
2064Create a new process watcher in stopped state.
2065
2066=item $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
2067
2068Set the callback to be called when the timer triggers.
2069
2070=item $pw = $timer->start ($pid)
2071
2072Tells the wqtcher to start watching for process C<$pid>.
2073
2074=item $pw = $pw->stop
2075
2076Stop the watcher.
2077
2078=back
2079
1729=head1 ENVIRONMENT 2080=head1 ENVIRONMENT
1730 2081
1731=head2 URXVT_PERL_VERBOSITY 2082=head2 URXVT_PERL_VERBOSITY
1732 2083
1733This variable controls the verbosity level of the perl extension. Higher 2084This variable controls the verbosity level of the perl extension. Higher

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines