[ViewVC] Diff of: cvs/rxvt-unicode/src/urxvt.pm

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

…		…
341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'	341	URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'	342	URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
343		343
344	=item selection-pastebin	344	=item selection-pastebin
345		345
346	This is a little rarely useful extension that Uploads the selection as	346	This is a little rarely useful extension that uploads the selection as
347	textfile to a remote site (or does other things). (The implementation is	347	textfile to a remote site (or does other things). (The implementation is
348	not currently secure for use in a multiuser environment as it writes to	348	not currently secure for use in a multiuser environment as it writes to
349	F</tmp> directly.).	349	F</tmp> directly.).
350		350
351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,	351	It listens to the C<selection-pastebin:remote-pastebin> keyboard command,
…		…
370		370
371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%	371	URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
372		372
373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret	373	I<Note to xrdb users:> xrdb uses the C preprocessor, which might interpret
374	the double C</> characters as comment start. Use C<\057\057> instead,	374	the double C</> characters as comment start. Use C<\057\057> instead,
375	which works regardless of wether xrdb is used to parse the resource file	375	which works regardless of whether xrdb is used to parse the resource file
376	or not.	376	or not.
		377
		378	=item macosx-clipboard and macosx-clipboard-native
		379
		380	These two modules implement an extended clipboard for Mac OS X. They are
		381	used 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
		387	The difference between them is that the native variant requires a
		388	perl from apple's devkit or so, and C<macosx-clipboard> requires the
		389	C<Mac::Pasteboard> module, works with other perls, has fewer bugs, is
		390	simpler etc. etc.
377		391
378	=item example-refresh-hooks	392	=item example-refresh-hooks
379		393
380	Displays a very simple digital clock in the upper right corner of the	394	Displays a very simple digital clock in the upper right corner of the
381	window. Illustrates overwriting the refresh callbacks to create your own	395	window. Illustrates overwriting the refresh callbacks to create your own
382	overlays or changes.	396	overlays or changes.
		397
		398	=item confirm-paste
		399
		400	Displays a confirmation dialog when a paste containing at least a full
		401	line is detected.
383		402
384	=back	403	=back
385		404
386	=head1 API DOCUMENTATION	405	=head1 API DOCUMENTATION
387		406
…		…
403		422
404	=over 4	423	=over 4
405		424
406	=item $text	425	=item $text
407		426
408	Rxvt-unicodes special way of encoding text, where one "unicode" character	427	Rxvt-unicode's special way of encoding text, where one "unicode" character
409	always represents one screen cell. See L<ROW_t> for a discussion of this format.	428	always represents one screen cell. See L<ROW_t> for a discussion of this format.
410		429
411	=item $string	430	=item $string
412		431
413	A perl text string, with an emphasis on I<text>. It can store all unicode	432	A perl text string, with an emphasis on I<text>. It can store all unicode
…		…
422	=back	441	=back
423		442
424	=head2 Extension Objects	443	=head2 Extension Objects
425		444
426	Every perl extension is a perl class. A separate perl object is created	445	Every perl extension is a perl class. A separate perl object is created
427	for each terminal, and each terminal has its own set of extenion objects,	446	for each terminal, and each terminal has its own set of extension objects,
428	which are passed as the first parameter to hooks. So extensions can use	447	which are passed as the first parameter to hooks. So extensions can use
429	their C<$self> object without having to think about clashes with other	448	their C<$self> object without having to think about clashes with other
430	extensions or other terminals, with the exception of methods and members	449	extensions or other terminals, with the exception of methods and members
431	that begin with an underscore character C<_>: these are reserved for	450	that begin with an underscore character C<_>: these are reserved for
432	internal use.	451	internal use.
…		…
596	=item on_tt_write $term, $octets	615	=item on_tt_write $term, $octets
597		616
598	Called whenever some data is written to the tty/pty and can be used to	617	Called whenever some data is written to the tty/pty and can be used to
599	suppress or filter tty input.	618	suppress or filter tty input.
600		619
		620	=item on_tt_paste $term, $octets
		621
		622	Called whenever text is about to be pasted, with the text as argument. You
		623	can filter/change and paste the text yourself by returning a true value
		624	and calling C<< $term->tt_paste >> yourself. C<$octets> is
		625	locale-encoded.
		626
601	=item on_line_update $term, $row	627	=item on_line_update $term, $row
602		628
603	Called whenever a line was updated or changed. Can be used to filter	629	Called whenever a line was updated or changed. Can be used to filter
604	screen output (e.g. underline urls or other useless stuff). Only lines	630	screen output (e.g. underline urls or other useless stuff). Only lines
605	that are being shown will be filtered, and, due to performance reasons,	631	that are being shown will be filtered, and, due to performance reasons,
…		…
630	resource in the @@RXVT_NAME@@(1) manpage).	656	resource in the @@RXVT_NAME@@(1) manpage).
631		657
632	The event is simply the action string. This interface is assumed to change	658	The event is simply the action string. This interface is assumed to change
633	slightly in the future.	659	slightly in the future.
634		660
635	=item on_resize_all_windows $tern, $new_width, $new_height	661	=item on_resize_all_windows $term, $new_width, $new_height
636		662
637	Called just after the new window size has been calculated, but before	663	Called just after the new window size has been calculated, but before
638	windows are actually being resized or hints are being set. If this hook	664	windows are actually being resized or hints are being set. If this hook
639	returns TRUE, setting of the window hints is being skipped.	665	returns TRUE, setting of the window hints is being skipped.
640		666
…		…
674		700
675	=item on_map_notify $term, $event	701	=item on_map_notify $term, $event
676		702
677	=item on_unmap_notify $term, $event	703	=item on_unmap_notify $term, $event
678		704
679	Called whenever the corresponding X event is received for the terminal If	705	Called whenever the corresponding X event is received for the terminal. If
680	the hook returns true, then the even will be ignored by rxvt-unicode.	706	the hook returns true, then the event will be ignored by rxvt-unicode.
681		707
682	The event is a hash with most values as named by Xlib (see the XEvent	708	The event is a hash with most values as named by Xlib (see the XEvent
683	manpage), with the additional members C<row> and C<col>, which are the	709	manpage), with the additional members C<row> and C<col>, which are the
684	(real, not screen-based) row and column under the mouse cursor.	710	(real, not screen-based) row and column under the mouse cursor.
685		711
…		…
694		720
695	=item on_wm_delete_window $term, $event	721	=item on_wm_delete_window $term, $event
696		722
697	Called when various types of ClientMessage events are received (all with	723	Called when various types of ClientMessage events are received (all with
698	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).	724	format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
		725
		726	=item on_bell $term
		727
		728	Called on receipt of a bell character.
699		729
700	=back	730	=back
701		731
702	=cut	732	=cut
703		733
…		…
768		798
769	=over 4	799	=over 4
770		800
771	=item urxvt::fatal $errormessage	801	=item urxvt::fatal $errormessage
772		802
773	Fatally aborts execution with the given error message. Avoid at all	803	Fatally aborts execution with the given error message (which should
774	costs! The only time this is acceptable is when the terminal process	804	include a trailing newline). Avoid at all costs! The only time this
775	starts up.	805	is acceptable (and useful) is in the init hook, where it prevents the
		806	terminal from starting up.
776		807
777	=item urxvt::warn $string	808	=item urxvt::warn $string
778		809
779	Calls C<rxvt_warn> with the given string which should not include a	810	Calls C<rxvt_warn> with the given string which should include a trailing
780	newline. The module also overwrites the C<warn> builtin with a function	811	newline. The module also overwrites the C<warn> builtin with a function
781	that calls this function.	812	that calls this function.
782		813
783	Using this function has the advantage that its output ends up in the	814	Using this function has the advantage that its output ends up in the
784	correct place, e.g. on stderr of the connecting urxvtc client.	815	correct place, e.g. on stderr of the connecting urxvtc client.
…		…
788	=item @terms = urxvt::termlist	819	=item @terms = urxvt::termlist
789		820
790	Returns all urxvt::term objects that exist in this process, regardless of	821	Returns all urxvt::term objects that exist in this process, regardless of
791	whether they are started, being destroyed etc., so be careful. Only term	822	whether they are started, being destroyed etc., so be careful. Only term
792	objects that have perl extensions attached will be returned (because there	823	objects that have perl extensions attached will be returned (because there
793	is no urxvt::term objet associated with others).	824	is no urxvt::term object associated with others).
794		825
795	=item $time = urxvt::NOW	826	=item $time = urxvt::NOW
796		827
797	Returns the "current time" (as per the event loop).	828	Returns the "current time" (as per the event loop).
798		829
…		…
841		872
842	=item $rend = urxvt::OVERLAY_RSTYLE	873	=item $rend = urxvt::OVERLAY_RSTYLE
843		874
844	Return the rendition mask used for overlays by default.	875	Return the rendition mask used for overlays by default.
845		876
846	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline	877	=item $rendbit = urxvt::RS_Bold, urxvt::RS_Italic, urxvt::RS_Blink,
		878	urxvt::RS_RVid, urxvt::RS_Uline
847		879
848	Return the bit that enabled bold, italic, blink, reverse-video and	880	Return the bit that enabled bold, italic, blink, reverse-video and
849	underline, respectively. To enable such a style, just logically OR it into	881	underline, respectively. To enable such a style, just logically OR it into
850	the bitset.	882	the bitset.
851		883
…		…
1110	is that you cannot use blocking APIs, but the non-blocking variant should	1142	is that you cannot use blocking APIs, but the non-blocking variant should
1111	work.	1143	work.
1112		1144
1113	=cut	1145	=cut
1114		1146
1115	our $VERSION = '3.4';	1147	our $VERSION = '5.23';
1116		1148
1117	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there	1149	$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1118	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];	1150	push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1119		1151
1120	sub timer {	1152	sub timer {
…		…
1122		1154
1123	my $cb = $arg{cb};	1155	my $cb = $arg{cb};
1124		1156
1125	urxvt::timer	1157	urxvt::timer
1126	->new	1158	->new
1127	->start (urxvt::NOW + $arg{after})	1159	->after ($arg{after}, $arg{interval})
1128	->cb (sub {	1160	->cb ($arg{interval} ? $cb : sub {
1129	$_[0]->stop; # need to cancel manually	1161	$_[0]->stop; # need to cancel manually
1130	$cb->();	1162	$cb->();
1131	})	1163	})
1132	}	1164	}
1133		1165
1134	sub io {	1166	sub io {
1135	my ($class, %arg) = @_;	1167	my ($class, %arg) = @_;
1136		1168
1137	my $cb = $arg{cb};	1169	my $cb = $arg{cb};
		1170	my $fd = fileno $arg{fh};
		1171	defined $fd or $fd = $arg{fh};
1138		1172
1139	bless [$arg{fh}, urxvt::iow	1173	bless [$arg{fh}, urxvt::iow
1140	->new	1174	->new
1141	->fd (fileno $arg{fh})	1175	->fd ($fd)
1142	->events (($arg{poll} =~ /r/ ? 1 : 0)	1176	->events (($arg{poll} =~ /r/ ? 1 : 0)
1143	\| ($arg{poll} =~ /w/ ? 2 : 0))	1177	\| ($arg{poll} =~ /w/ ? 2 : 0))
1144	->start	1178	->start
1145	->cb (sub {	1179	->cb ($cb)
1146	$cb->(($_[1] & 1 ? 'r' : '')
1147	. ($_[1] & 2 ? 'w' : ''));
1148	})],
1149	urxvt::anyevent::	1180	], urxvt::anyevent::
		1181	}
		1182
		1183	sub idle {
		1184	my ($class, %arg) = @_;
		1185
		1186	my $cb = $arg{cb};
		1187
		1188	urxvt::iw
		1189	->new
		1190	->start
		1191	->cb ($cb)
		1192	}
		1193
		1194	sub child {
		1195	my ($class, %arg) = @_;
		1196
		1197	my $cb = $arg{cb};
		1198
		1199	urxvt::pw
		1200	->new
		1201	->start ($arg{pid})
		1202	->cb (sub {
		1203	$_[0]->stop; # need to cancel manually
		1204	$cb->($_[0]->rpid, $_[0]->rstatus);
		1205	})
1150	}	1206	}
1151		1207
1152	sub DESTROY {	1208	sub DESTROY {
1153	$_[0][1]->stop;	1209	$_[0][1]->stop;
1154	}	1210	}
…		…
1284		1340
1285	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont	1341	answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1286	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key	1342	borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1287	display_name embed ext_bwidth fade font geometry hold iconName	1343	display_name embed ext_bwidth fade font geometry hold iconName
1288	imFont imLocale inputMethod insecure int_bwidth intensityStyles	1344	imFont imLocale inputMethod insecure int_bwidth intensityStyles
1289	italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier	1345	italicFont jumpScroll lineSpace letterSpace loginShell mapAlert meta8
1290	mouseWheelScrollPage name override_redirect pastableTabs path perl_eval	1346	modifier mouseWheelScrollPage name override_redirect pastableTabs path
1291	perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay	1347	perl_eval perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1292	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar	1348	preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1293	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness	1349	scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1294	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle	1350	scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1295	secondaryScreen secondaryScroll shade term_name title	1351	secondaryScreen secondaryScroll shade term_name title
1296	transient_for transparent transparent_all tripleclickwords utmpInhibit	1352	transient_for transparent transparent_all tripleclickwords utmpInhibit
…		…
1334		1390
1335	=item ($row, $col) = $term->selection_beg ([$row, $col])	1391	=item ($row, $col) = $term->selection_beg ([$row, $col])
1336		1392
1337	=item ($row, $col) = $term->selection_end ([$row, $col])	1393	=item ($row, $col) = $term->selection_end ([$row, $col])
1338		1394
1339	Return the current values of the selection mark, begin or end positions,	1395	Return the current values of the selection mark, begin or end positions.
1340	and optionally set them to new values.	1396
		1397	When arguments are given, then the selection coordinates are set to
		1398	C<$row> and C<$col>, and the selection screen is set to the current
		1399	screen.
		1400
		1401	=item $screen = $term->selection_screen ([$screen])
		1402
		1403	Returns the current selection screen, and then optionally sets it.
1341		1404
1342	=item $term->selection_make ($eventtime[, $rectangular])	1405	=item $term->selection_make ($eventtime[, $rectangular])
1343		1406
1344	Tries to make a selection as set by C<selection_beg> and	1407	Tries to make a selection as set by C<selection_beg> and
1345	C<selection_end>. If C<$rectangular> is true (default: false), a	1408	C<selection_end>. If C<$rectangular> is true (default: false), a
1346	rectangular selection will be made. This is the prefered function to make	1409	rectangular selection will be made. This is the preferred function to make
1347	a selection.	1410	a selection.
1348		1411
1349	=item $success = $term->selection_grab ($eventtime)	1412	=item $success = $term->selection_grab ($eventtime[, $clipboard])
1350		1413
1351	Try to request the primary selection text from the server (for example, as	1414	Try to acquire ownership of the primary (clipboard if C<$clipboard> is
		1415	true) selection from the server. The corresponding text can be set
1352	set by the next method). No visual feedback will be given. This function	1416	with the next method. No visual feedback will be given. This function
1353	is mostly useful from within C<on_sel_grab> hooks.	1417	is mostly useful from within C<on_sel_grab> hooks.
1354		1418
1355	=item $oldtext = $term->selection ([$newtext])	1419	=item $oldtext = $term->selection ([$newtext, $clipboard])
1356		1420
1357	Return the current selection text and optionally replace it by C<$newtext>.	1421	Return the current selection (clipboard if C<$clipboard> is true) text
		1422	and optionally replace it by C<$newtext>.
		1423
		1424	=item $term->selection_clear ([$clipboard])
		1425
		1426	Revoke ownership of the primary (clipboard if C<$clipboard> is true) selection.
1358		1427
1359	=item $term->overlay_simple ($x, $y, $text)	1428	=item $term->overlay_simple ($x, $y, $text)
1360		1429
1361	Create a simple multi-line overlay box. See the next method for details.	1430	Create a simple multi-line overlay box. See the next method for details.
1362		1431
…		…
1490	locale-specific encoding of the terminal and can contain command sequences	1559	locale-specific encoding of the terminal and can contain command sequences
1491	(escape codes) that will be interpreted.	1560	(escape codes) that will be interpreted.
1492		1561
1493	=item $term->tt_write ($octets)	1562	=item $term->tt_write ($octets)
1494		1563
1495	Write the octets given in C<$data> to the tty (i.e. as program input). To	1564	Write the octets given in C<$octets> to the tty (i.e. as program input). To
1496	pass characters instead of octets, you should convert your strings first	1565	pass characters instead of octets, you should convert your strings first
1497	to the locale-specific encoding using C<< $term->locale_encode >>.	1566	to the locale-specific encoding using C<< $term->locale_encode >>.
		1567
		1568	=item $term->tt_paste ($octets)
		1569
		1570	Write the octets given in C<$octets> to the tty as a paste, converting NL to
		1571	CR and bracketing the data with control sequences if bracketed paste mode
		1572	is set.
1498		1573
1499	=item $old_events = $term->pty_ev_events ([$new_events])	1574	=item $old_events = $term->pty_ev_events ([$new_events])
1500		1575
1501	Replaces the event mask of the pty watcher by the given event mask. Can	1576	Replaces the event mask of the pty watcher by the given event mask. Can
1502	be used to suppress input and output handling to the pty/tty. See the	1577	be used to suppress input and output handling to the pty/tty. See the
…		…
1816	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most	1891	Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
1817	recent grab.	1892	recent grab.
1818		1893
1819	=item $term->ungrab	1894	=item $term->ungrab
1820		1895
1821	Calls XUngrab for the most recent grab. Is called automatically on	1896	Calls XUngrabPointer and XUngrabKeyboard for the most recent grab. Is called automatically on
1822	evaluation errors, as it is better to lose the grab in the error case as	1897	evaluation errors, as it is better to lose the grab in the error case as
1823	the session.	1898	the session.
1824		1899
1825	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])	1900	=item $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
1826		1901
…		…
1848		1923
1849	=item $term->XChangeInput ($window, $add_events[, $del_events])	1924	=item $term->XChangeInput ($window, $add_events[, $del_events])
1850		1925
1851	Various X or X-related functions. The C<$term> object only serves as	1926	Various X or X-related functions. The C<$term> object only serves as
1852	the source of the display, otherwise those functions map more-or-less	1927	the source of the display, otherwise those functions map more-or-less
1853	directory onto the X functions of the same name.	1928	directly onto the X functions of the same name.
1854		1929
1855	=back	1930	=back
1856		1931
1857	=cut	1932	=cut
1858		1933
…		…
2015		2090
2016	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })	2091	=item $timer = $timer->cb (sub { my ($timer) = @_; ... })
2017		2092
2018	Set the callback to be called when the timer triggers.	2093	Set the callback to be called when the timer triggers.
2019		2094
2020	=item $tstamp = $timer->at
2021
2022	Return the time this watcher will fire next.
2023
2024	=item $timer = $timer->set ($tstamp)	2095	=item $timer = $timer->set ($tstamp[, $interval])
2025		2096
2026	Set the time the event is generated to $tstamp.	2097	Set the time the event is generated to $tstamp (and optionally specifies a
		2098	new $interval).
2027		2099
2028	=item $timer = $timer->interval ($interval)	2100	=item $timer = $timer->interval ($interval)
2029		2101
2030	Normally (and when C<$interval> is C<0>), the timer will automatically	2102	By default (and when C<$interval> is C<0>), the timer will automatically
2031	stop after it has fired once. If C<$interval> is non-zero, then the timer	2103	stop after it has fired once. If C<$interval> is non-zero, then the timer
2032	is automatically rescheduled at the given intervals.	2104	is automatically rescheduled at the given intervals.
2033		2105
2034	=item $timer = $timer->start	2106	=item $timer = $timer->start
2035		2107
2036	Start the timer.	2108	Start the timer.
2037		2109
2038	=item $timer = $timer->start ($tstamp)	2110	=item $timer = $timer->start ($tstamp[, $interval])
2039		2111
2040	Set the event trigger time to C<$tstamp> and start the timer.	2112	Set the event trigger time to C<$tstamp> and start the timer. Optionally
		2113	also replaces the interval.
2041		2114
2042	=item $timer = $timer->after ($delay)	2115	=item $timer = $timer->after ($delay[, $interval])
2043		2116
2044	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.	2117	Like C<start>, but sets the expiry timer to c<urxvt::NOW + $delay>.
2045		2118
2046	=item $timer = $timer->stop	2119	=item $timer = $timer->stop
2047		2120
…		…
2178		2251
2179	=back	2252	=back
2180		2253
2181	=head1 AUTHOR	2254	=head1 AUTHOR
2182		2255
2183	Marc Lehmann <pcg@goof.com>	2256	Marc Lehmann <schmorp@schmorp.de>
2184	http://software.schmorp.de/pkg/rxvt-unicode	2257	http://software.schmorp.de/pkg/rxvt-unicode
2185		2258
2186	=cut	2259	=cut
2187		2260
2188	1	2261	1

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs. Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.173 by root, Wed Nov 5 12:45:36 2008 UTC vs.
Revision 1.193 by sf-exg, Wed Jun 29 15:30:28 2011 UTC