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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

…		…
26	thus must be encoded as UTF-8.	26	thus must be encoded as UTF-8.
27		27
28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where	28	Each script will only ever be loaded once, even in @@RXVT_NAME@@d, where
29	scripts will be shared (but not enabled) for all terminals.	29	scripts will be shared (but not enabled) for all terminals.
30		30
31	=head2 Prepackaged Extensions	31	=head1 PREPACKAGED EXTENSIONS
32		32
33	This section describes the extensiosn delivered with this version. You can	33	This section describes the extensions delivered with this release. You can
34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.	34	find them in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
35		35
36	You can activate them like this:	36	You can activate them like this:
37		37
38	@@RXVT_NAME@@ -pe <extensionname>	38	@@RXVT_NAME@@ -pe <extensionname>
39		39
40	=over 4	40	=over 4
41		41
42	=item selection (enabled by default)	42	=item selection (enabled by default)
43		43
44	Intelligent selection. This extension tries to be more intelligent when	44	(More) intelligent selection. This extension tries to be more intelligent
45	the user extends selections (double-click). Right now, it tries to select	45	when the user extends selections (double-click). Right now, it tries to
46	urls and complete shell-quoted arguments, which is very convenient, too,	46	select urls and complete shell-quoted arguments, which is very convenient,
47	if your F<ls> supports C<--quoting-style=shell>.	47	too, if your F<ls> supports C<--quoting-style=shell>.
48		48
49	It also offers the following bindable event:	49	It also offers the following bindable keyboard command:
50		50
51	=over 4	51	=over 4
52		52
53	=item rot13	53	=item rot13
54		54
…		…
64	runtime.	64	runtime.
65		65
66	=item selection-popup (enabled by default)	66	=item selection-popup (enabled by default)
67		67
68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection	68	Binds a popup menu to Ctrl-Button3 that lets you convert the selection
69	text into various other formats/action.	69	text into various other formats/action (such as uri unescaping, perl
		70	evalution, web-browser starting etc.), depending on content.
70		71
71	=item searchable-scrollback (enabled by default)	72	=item searchable-scrollback<hotkey> (enabled by default)
72		73
73	Adds regex search functionality to the scrollback buffer, triggered by a	74	Adds regex search functionality to the scrollback buffer, triggered
74	hotkey (default: C<M-s>). When in search mode, terminal input/output is	75	by a hotkey (default: C<M-s>). When in search mode, normal terminal
		76	input/output is suspended.
		77
75	suspended, C</> starts an incremental regex search, C<n> searches further,	78	C</> starts an incremental regex search, C<n> searches further, C<p> or
76	C<p> jumps to the previous match. C<enter> leaves search mode at the	79	C<N> jump to the previous match, C<G> jumps to the bottom and clears the
77	current position and C<escape> returns to the original position.	80	history, C<enter> leaves search mode at the current position and C<escape>
		81	returns to the original position.
78		82
79	=item digital-clock	83	=item digital-clock
80		84
81	Displays a digital clock using the built-in overlay.	85	Displays a digital clock using the built-in overlay.
82		86
…		…
95	Displays a very simple digital clock in the upper right corner of the	99	Displays a very simple digital clock in the upper right corner of the
96	window. Illustrates overwriting the refresh callbacks to create your own	100	window. Illustrates overwriting the refresh callbacks to create your own
97	overlays or changes.	101	overlays or changes.
98		102
99	=back	103	=back
		104
		105	=head1 API DOCUMENTATION
100		106
101	=head2 General API Considerations	107	=head2 General API Considerations
102		108
103	All objects (such as terminals, time watchers etc.) are typical	109	All objects (such as terminals, time watchers etc.) are typical
104	reference-to-hash objects. The hash can be used to store anything you	110	reference-to-hash objects. The hash can be used to store anything you
…		…
117	=over 4	123	=over 4
118		124
119	=item $text	125	=item $text
120		126
121	Rxvt-unicodes special way of encoding text, where one "unicode" character	127	Rxvt-unicodes special way of encoding text, where one "unicode" character
122	always represents one screen cell. See L<row_t> for a discussion of this format.	128	always represents one screen cell. See L<ROW_t> for a discussion of this format.
123		129
124	=item $string	130	=item $string
125		131
126	A perl text string, with an emphasis on I<text>. It can store all unicode	132	A perl text string, with an emphasis on I<text>. It can store all unicode
127	characters and is to be distinguished with text encoded in a specific	133	characters and is to be distinguished with text encoded in a specific
…		…
263	can filter/change and output the text yourself by returning a true value	269	can filter/change and output the text yourself by returning a true value
264	and calling C<< $term->scr_add_lines >> yourself. Please note that this	270	and calling C<< $term->scr_add_lines >> yourself. Please note that this
265	might be very slow, however, as your hook is called for B<all> text being	271	might be very slow, however, as your hook is called for B<all> text being
266	output.	272	output.
267		273
		274	=item on_tt_write $term, $octets
		275
		276	Called whenever some data is written to the tty/pty and can be used to
		277	suppress or filter tty input.
		278
268	=item on_line_update $term, $row	279	=item on_line_update $term, $row
269		280
270	Called whenever a line was updated or changed. Can be used to filter	281	Called whenever a line was updated or changed. Can be used to filter
271	screen output (e.g. underline urls or other useless stuff). Only lines	282	screen output (e.g. underline urls or other useless stuff). Only lines
272	that are being shown will be filtered, and, due to performance reasons,	283	that are being shown will be filtered, and, due to performance reasons,
…		…
329		340
330	C<on_key_press> additionally receives the string rxvt-unicode would	341	C<on_key_press> additionally receives the string rxvt-unicode would
331	output, if any, in locale-specific encoding.	342	output, if any, in locale-specific encoding.
332		343
333	subwindow.	344	subwindow.
334
335	=back
336
337	=head2 Variables in the C<urxvt> Package
338
339	=over 4
340
341	=item $urxvt::TERM
342
343	The current terminal. This variable stores the current C<urxvt::term>
344	object, whenever a callback/hook is executing.
345
346	=back
347
348	=head2 Functions in the C<urxvt> Package
349
350	=over 4
351
352	=item $term = new urxvt [arg...]
353
354	Creates a new terminal, very similar as if you had started it with
355	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
356	if the new instance couldn't be created. Returns C<undef> if the new
357	instance didn't initialise perl, and the terminal object otherwise. The
358	C<init> and C<start> hooks will be called during the call.
359
360	=item urxvt::fatal $errormessage
361
362	Fatally aborts execution with the given error message. Avoid at all
363	costs! The only time this is acceptable is when the terminal process
364	starts up.
365
366	=item urxvt::warn $string
367
368	Calls C<rxvt_warn> with the given string which should not include a
369	newline. The module also overwrites the C<warn> builtin with a function
370	that calls this function.
371
372	Using this function has the advantage that its output ends up in the
373	correct place, e.g. on stderr of the connecting urxvtc client.
374
375	=item $is_safe = urxvt::safe
376
377	Returns true when it is safe to do potentially unsafe things, such as
378	evaluating perl code specified by the user. This is true when urxvt was
379	started setuid or setgid.
380
381	=item $time = urxvt::NOW
382
383	Returns the "current time" (as per the event loop).
384
385	=item urxvt::CurrentTime
386
387	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
388	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
389	Button4Mask, Button5Mask, AnyModifier
390
391	Various constants for use in X calls and event processing.
392
393	=back
394
395	=head2 RENDITION
396
397	Rendition bitsets contain information about colour, font, font styles and
398	similar information for each screen cell.
399
400	The following "macros" deal with changes in rendition sets. You should
401	never just create a bitset, you should always modify an existing one,
402	as they contain important information required for correct operation of
403	rxvt-unicode.
404
405	=over 4
406
407	=item $rend = urxvt::DEFAULT_RSTYLE
408
409	Returns the default rendition, as used when the terminal is starting up or
410	being reset. Useful as a base to start when creating renditions.
411
412	=item $rend = urxvt::OVERLAY_RSTYLE
413
414	Return the rendition mask used for overlays by default.
415
416	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
417
418	Return the bit that enabled bold, italic, blink, reverse-video and
419	underline, respectively. To enable such a style, just logically OR it into
420	the bitset.
421
422	=item $foreground = urxvt::GET_BASEFG $rend
423
424	=item $background = urxvt::GET_BASEBG $rend
425
426	Return the foreground/background colour index, respectively.
427
428	=item $rend = urxvt::SET_FGCOLOR ($rend, $new_colour)
429
430	=item $rend = urxvt::SET_BGCOLOR ($rend, $new_colour)
431
432	Replace the foreground/background colour in the rendition mask with the
433	specified one.
434
435	=item $value = urxvt::GET_CUSTOM ($rend)
436
437	Return the "custom" value: Every rendition has 5 bits for use by
438	extensions. They can be set and changed as you like and are initially
439	zero.
440
441	=item $rend = urxvt::SET_CUSTOM ($rend, $new_value)
442
443	Change the custom value.
444		345
445	=back	346	=back
446		347
447	=cut	348	=cut
448		349
…		…
457	our $VERSION = 1;	358	our $VERSION = 1;
458	our $TERM;	359	our $TERM;
459	our @HOOKNAME;	360	our @HOOKNAME;
460	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;	361	our %HOOKTYPE = map +($HOOKNAME[$_] => $_), 0..$#HOOKNAME;
461	our %OPTION;	362	our %OPTION;
		363
462	our $LIBDIR;	364	our $LIBDIR;
		365	our $RESNAME;
		366	our $RESCLASS;
		367	our $RXVTNAME;
		368
		369	=head2 Variables in the C<urxvt> Package
		370
		371	=over 4
		372
		373	=item $urxvt::LIBDIR
		374
		375	The rxvt-unicode library directory, where, among other things, the perl
		376	modules and scripts are stored.
		377
		378	=item $urxvt::RESCLASS, $urxvt::RESCLASS
		379
		380	The resource class and name rxvt-unicode uses to look up X resources.
		381
		382	=item $urxvt::RXVTNAME
		383
		384	The basename of the installed binaries, usually C<urxvt>.
		385
		386	=item $urxvt::TERM
		387
		388	The current terminal. This variable stores the current C<urxvt::term>
		389	object, whenever a callback/hook is executing.
		390
		391	=back
		392
		393	=head2 Functions in the C<urxvt> Package
		394
		395	=over 4
		396
		397	=item urxvt::fatal $errormessage
		398
		399	Fatally aborts execution with the given error message. Avoid at all
		400	costs! The only time this is acceptable is when the terminal process
		401	starts up.
		402
		403	=item urxvt::warn $string
		404
		405	Calls C<rxvt_warn> with the given string which should not include a
		406	newline. The module also overwrites the C<warn> builtin with a function
		407	that calls this function.
		408
		409	Using this function has the advantage that its output ends up in the
		410	correct place, e.g. on stderr of the connecting urxvtc client.
		411
		412	Messages have a size limit of 1023 bytes currently.
		413
		414	=item $is_safe = urxvt::safe
		415
		416	Returns true when it is safe to do potentially unsafe things, such as
		417	evaluating perl code specified by the user. This is true when urxvt was
		418	started setuid or setgid.
		419
		420	=item $time = urxvt::NOW
		421
		422	Returns the "current time" (as per the event loop).
		423
		424	=item urxvt::CurrentTime
		425
		426	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		427	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		428	Button4Mask, Button5Mask, AnyModifier
		429
		430	Various constants for use in X calls and event processing.
		431
		432	=back
		433
		434	=head2 RENDITION
		435
		436	Rendition bitsets contain information about colour, font, font styles and
		437	similar information for each screen cell.
		438
		439	The following "macros" deal with changes in rendition sets. You should
		440	never just create a bitset, you should always modify an existing one,
		441	as they contain important information required for correct operation of
		442	rxvt-unicode.
		443
		444	=over 4
		445
		446	=item $rend = urxvt::DEFAULT_RSTYLE
		447
		448	Returns the default rendition, as used when the terminal is starting up or
		449	being reset. Useful as a base to start when creating renditions.
		450
		451	=item $rend = urxvt::OVERLAY_RSTYLE
		452
		453	Return the rendition mask used for overlays by default.
		454
		455	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		456
		457	Return the bit that enabled bold, italic, blink, reverse-video and
		458	underline, respectively. To enable such a style, just logically OR it into
		459	the bitset.
		460
		461	=item $foreground = urxvt::GET_BASEFG $rend
		462
		463	=item $background = urxvt::GET_BASEBG $rend
		464
		465	Return the foreground/background colour index, respectively.
		466
		467	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		468
		469	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		470
		471	Replace the foreground/background colour in the rendition mask with the
		472	specified one.
		473
		474	=item $value = urxvt::GET_CUSTOM $rend
		475
		476	Return the "custom" value: Every rendition has 5 bits for use by
		477	extensions. They can be set and changed as you like and are initially
		478	zero.
		479
		480	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		481
		482	Change the custom value.
		483
		484	=back
		485
		486	=cut
463		487
464	BEGIN {	488	BEGIN {
465	urxvt->bootstrap;	489	urxvt->bootstrap;
466		490
467	# overwrite perl's warn	491	# overwrite perl's warn
…		…
663		687
664	=head2 The C<urxvt::anyevent> Class	688	=head2 The C<urxvt::anyevent> Class
665		689
666	The sole purpose of this class is to deliver an interface to the	690	The sole purpose of this class is to deliver an interface to the
667	C<AnyEvent> module - any module using it will work inside urxvt without	691	C<AnyEvent> module - any module using it will work inside urxvt without
668	further work. The only exception is that you cannot wait on condition	692	further programming. The only exception is that you cannot wait on
669	variables, but non-blocking condvar use is ok. What this means is that you	693	condition variables, but non-blocking condvar use is ok. What this means
670	cannot use blocking APIs, but the non-blocking variant should work.	694	is that you cannot use blocking APIs, but the non-blocking variant should
		695	work.
671		696
672	=cut	697	=cut
673		698
674	our $VERSION = 1;	699	our $VERSION = 1;
675		700
…		…
752	$proxy->enable ($name => $ref);	777	$proxy->enable ($name => $ref);
753	}	778	}
754	}	779	}
755	}	780	}
756		781
		782	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		783
		784	Creates a new terminal, very similar as if you had started it with system
		785	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a C<%ENV>-like
		786	hash which defines the environment of the new terminal.
		787
		788	Croaks (and probably outputs an error message) if the new instance
		789	couldn't be created. Returns C<undef> if the new instance didn't
		790	initialise perl, and the terminal object otherwise. The C<init> and
		791	C<start> hooks will be called during this call.
		792
		793	=cut
		794
		795	sub new {
		796	my ($class, $env, @args) = @_;
		797
		798	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
		799	}
		800
757	=item $term->destroy	801	=item $term->destroy
758		802
759	Destroy the terminal object (close the window, free resources etc.).	803	Destroy the terminal object (close the window, free resources
		804	etc.). Please note that @@RXVT_NAME@@ will not exit as long as any event
		805	watchers (timers, io watchers) are still active.
760		806
761	=item $isset = $term->option ($optval[, $set])	807	=item $isset = $term->option ($optval[, $set])
762		808
763	Returns true if the option specified by C<$optval> is enabled, and	809	Returns true if the option specified by C<$optval> is enabled, and
764	optionally change it. All option values are stored by name in the hash	810	optionally change it. All option values are stored by name in the hash
…		…
1022		1068
1023	=item $lines_in_scrollback = $term->nsaved	1069	=item $lines_in_scrollback = $term->nsaved
1024		1070
1025	Return various integers describing terminal characteristics.	1071	Return various integers describing terminal characteristics.
1026		1072
		1073	=item $x_display = $term->display_id
		1074
		1075	Return the DISPLAY used by rxvt-unicode.
		1076
1027	=item $lc_ctype = $term->locale	1077	=item $lc_ctype = $term->locale
1028		1078
1029	Returns the LC_CTYPE category string used by this rxvt-unicode.	1079	Returns the LC_CTYPE category string used by this rxvt-unicode.
1030		1080
1031	=item $x_display = $term->display_id	1081	=item $env = $term->env
1032		1082
1033	Return the DISPLAY used by rxvt-unicode.	1083	Returns a copy of the environment in effect for the terminal as a hashref
		1084	similar to C<\%ENV>.
		1085
		1086	=cut
		1087
		1088	sub env {
		1089	if (my $env = $_[0]->_env) {
		1090	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1091	} else {
		1092	+{ %ENV }
		1093	}
		1094	}
1034		1095
1035	=item $modifiermask = $term->ModLevel3Mask	1096	=item $modifiermask = $term->ModLevel3Mask
1036		1097
1037	=item $modifiermask = $term->ModMetaMask	1098	=item $modifiermask = $term->ModMetaMask
1038		1099
…		…
1278	$item->{render} \|\|= sub { $_[0]{text} };	1339	$item->{render} \|\|= sub { $_[0]{text} };
1279		1340
1280	push @{ $self->{item} }, $item;	1341	push @{ $self->{item} }, $item;
1281	}	1342	}
1282		1343
		1344	=item $popup->add_title ($title)
		1345
		1346	Adds a non-clickable title to the popup.
		1347
		1348	=cut
		1349
		1350	sub add_title {
		1351	my ($self, $title) = @_;
		1352
		1353	$self->add_item ({
		1354	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1355	text => $title,
		1356	activate => sub { },
		1357	});
		1358	}
		1359
		1360	=item $popup->add_separator ([$sepchr])
		1361
		1362	Creates a separator, optionally using the character given as C<$sepchr>.
		1363
		1364	=cut
		1365
1283	sub add_separator {	1366	sub add_separator {
1284	my ($self, $sep) = @_;	1367	my ($self, $sep) = @_;
1285		1368
1286	$sep \|\|= "=";	1369	$sep \|\|= "=";
1287		1370
…		…
1291	render => sub { $sep x $self->{term}->ncol },	1374	render => sub { $sep x $self->{term}->ncol },
1292	activate => sub { },	1375	activate => sub { },
1293	});	1376	});
1294	}	1377	}
1295		1378
1296	sub add_title {	1379	=item $popup->add_button ($text, $cb)
1297	my ($self, $title) = @_;
1298		1380
1299	$self->add_item ({	1381	Adds a clickable button to the popup. C<$cb> is called whenever it is
1300	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1382	selected.
1301	text => $title,	1383
1302	activate => sub { },	1384	=cut
1303	});
1304	}
1305		1385
1306	sub add_button {	1386	sub add_button {
1307	my ($self, $text, $cb) = @_;	1387	my ($self, $text, $cb) = @_;
1308		1388
1309	$self->add_item ({ type => "button", text => $text, activate => $cb});	1389	$self->add_item ({ type => "button", text => $text, activate => $cb});
1310	}	1390	}
		1391
		1392	=item $popup->add_toggle ($text, $cb, $initial_value)
		1393
		1394	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1395	whenever it gets toggled, with a boolean indicating its value as its first
		1396	argument.
		1397
		1398	=cut
1311		1399
1312	sub add_toggle {	1400	sub add_toggle {
1313	my ($self, $text, $cb, $value) = @_;	1401	my ($self, $text, $cb, $value) = @_;
1314		1402
1315	my $item; $item = {	1403	my $item; $item = {
1316	type => "button",	1404	type => "button",
1317	text => " $text",	1405	text => " $text",
1318	value => $value,	1406	value => $value,
1319	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1407	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1320	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1408	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1321	};	1409	};
1322		1410
1323	$self->add_item ($item);	1411	$self->add_item ($item);
1324	}	1412	}
		1413
		1414	=item $popup->show
		1415
		1416	Displays the popup (which is initially hidden).
		1417
		1418	=cut
1325		1419
1326	sub show {	1420	sub show {
1327	my ($self) = @_;	1421	my ($self) = @_;
1328		1422
1329	local $urxvt::popup::self = $self;	1423	local $urxvt::popup::self = $self;
1330		1424
		1425	my $env = $self->{term}->env;
		1426	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1427	delete $env->{LC_ALL};
1331	local $ENV{LC_ALL} = $self->{term}->locale;	1428	$env->{LC_CTYPE} = $self->{term}->locale;
1332		1429
		1430	urxvt::term->new ($env, $self->{term}->resource ("name"),
1333	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1431	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1334	"--transient-for" => $self->{term}->parent,	1432	"--transient-for" => $self->{term}->parent,
1335	"-display" => $self->{term}->display_id,	1433	"-display" => $self->{term}->display_id,
1336	"-pe" => "urxvt-popup")	1434	"-pe" => "urxvt-popup")
1337	or die "unable to create popup window\n";	1435	or die "unable to create popup window\n";
1338	}	1436	}
1339		1437
1340	sub DESTROY {	1438	sub DESTROY {
1341	my ($self) = @_;	1439	my ($self) = @_;
1342		1440
1343	delete $self->{term}{_destroy}{$self};	1441	delete $self->{term}{_destroy}{$self};
1344	$self->{term}->ungrab;	1442	$self->{term}->ungrab;
1345	}	1443	}
		1444
		1445	=back
1346		1446
1347	=head2 The C<urxvt::timer> Class	1447	=head2 The C<urxvt::timer> Class
1348		1448
1349	This class implements timer watchers/events. Time is represented as a	1449	This class implements timer watchers/events. Time is represented as a
1350	fractional number of seconds since the epoch. Example:	1450	fractional number of seconds since the epoch. Example:

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs. Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.71 by root, Mon Jan 9 23:18:49 2006 UTC vs.
Revision 1.78 by root, Wed Jan 11 01:01:52 2006 UTC