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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC

…		…
343		343
344	subwindow.	344	subwindow.
345		345
346	=back	346	=back
347		347
348	=head2 Variables in the C<urxvt> Package
349
350	=over 4
351
352	=item $urxvt::LIBDIR
353
354	The rxvt-unicode library directory, where, among other things, the perl
355	modules and scripts are stored.
356
357	=item $urxvt::RESCLASS, $urxvt::RESCLASS
358
359	The resource class and name rxvt-unicode uses to look up X resources.
360
361	=item $urxvt::RXVTNAME
362
363	The basename of the installed binaries, usually C<urxvt>.
364
365	=item $urxvt::TERM
366
367	The current terminal. This variable stores the current C<urxvt::term>
368	object, whenever a callback/hook is executing.
369
370	=item
371
372	=back
373
374	=head2 Functions in the C<urxvt> Package
375
376	=over 4
377
378	=item $term = new urxvt [arg...]
379
380	Creates a new terminal, very similar as if you had started it with
381	C<system $binfile, arg...>. Croaks (and probably outputs an error message)
382	if the new instance couldn't be created. Returns C<undef> if the new
383	instance didn't initialise perl, and the terminal object otherwise. The
384	C<init> and C<start> hooks will be called during the call.
385
386	=item urxvt::fatal $errormessage
387
388	Fatally aborts execution with the given error message. Avoid at all
389	costs! The only time this is acceptable is when the terminal process
390	starts up.
391
392	=item urxvt::warn $string
393
394	Calls C<rxvt_warn> with the given string which should not include a
395	newline. The module also overwrites the C<warn> builtin with a function
396	that calls this function.
397
398	Using this function has the advantage that its output ends up in the
399	correct place, e.g. on stderr of the connecting urxvtc client.
400
401	=item $is_safe = urxvt::safe
402
403	Returns true when it is safe to do potentially unsafe things, such as
404	evaluating perl code specified by the user. This is true when urxvt was
405	started setuid or setgid.
406
407	=item $time = urxvt::NOW
408
409	Returns the "current time" (as per the event loop).
410
411	=item urxvt::CurrentTime
412
413	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
414	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
415	Button4Mask, Button5Mask, AnyModifier
416
417	Various constants for use in X calls and event processing.
418
419	=back
420
421	=head2 RENDITION
422
423	Rendition bitsets contain information about colour, font, font styles and
424	similar information for each screen cell.
425
426	The following "macros" deal with changes in rendition sets. You should
427	never just create a bitset, you should always modify an existing one,
428	as they contain important information required for correct operation of
429	rxvt-unicode.
430
431	=over 4
432
433	=item $rend = urxvt::DEFAULT_RSTYLE
434
435	Returns the default rendition, as used when the terminal is starting up or
436	being reset. Useful as a base to start when creating renditions.
437
438	=item $rend = urxvt::OVERLAY_RSTYLE
439
440	Return the rendition mask used for overlays by default.
441
442	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
443
444	Return the bit that enabled bold, italic, blink, reverse-video and
445	underline, respectively. To enable such a style, just logically OR it into
446	the bitset.
447
448	=item $foreground = urxvt::GET_BASEFG $rend
449
450	=item $background = urxvt::GET_BASEBG $rend
451
452	Return the foreground/background colour index, respectively.
453
454	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
455
456	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
457
458	Replace the foreground/background colour in the rendition mask with the
459	specified one.
460
461	=item $value = urxvt::GET_CUSTOM $rend
462
463	Return the "custom" value: Every rendition has 5 bits for use by
464	extensions. They can be set and changed as you like and are initially
465	zero.
466
467	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
468
469	Change the custom value.
470
471	=back
472
473	=cut	348	=cut
474		349
475	package urxvt;	350	package urxvt;
476		351
477	use utf8;	352	use utf8;
…		…
488		363
489	our $LIBDIR;	364	our $LIBDIR;
490	our $RESNAME;	365	our $RESNAME;
491	our $RESCLASS;	366	our $RESCLASS;
492	our $RXVTNAME;	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	=item
		392
		393	=back
		394
		395	=head2 Functions in the C<urxvt> Package
		396
		397	=over 4
		398
		399	=item urxvt::fatal $errormessage
		400
		401	Fatally aborts execution with the given error message. Avoid at all
		402	costs! The only time this is acceptable is when the terminal process
		403	starts up.
		404
		405	=item urxvt::warn $string
		406
		407	Calls C<rxvt_warn> with the given string which should not include a
		408	newline. The module also overwrites the C<warn> builtin with a function
		409	that calls this function.
		410
		411	Using this function has the advantage that its output ends up in the
		412	correct place, e.g. on stderr of the connecting urxvtc client.
		413
		414	Messages have a size limit of 1023 bytes currently.
		415
		416	=item $is_safe = urxvt::safe
		417
		418	Returns true when it is safe to do potentially unsafe things, such as
		419	evaluating perl code specified by the user. This is true when urxvt was
		420	started setuid or setgid.
		421
		422	=item $time = urxvt::NOW
		423
		424	Returns the "current time" (as per the event loop).
		425
		426	=item urxvt::CurrentTime
		427
		428	=item urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
		429	Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
		430	Button4Mask, Button5Mask, AnyModifier
		431
		432	Various constants for use in X calls and event processing.
		433
		434	=back
		435
		436	=head2 RENDITION
		437
		438	Rendition bitsets contain information about colour, font, font styles and
		439	similar information for each screen cell.
		440
		441	The following "macros" deal with changes in rendition sets. You should
		442	never just create a bitset, you should always modify an existing one,
		443	as they contain important information required for correct operation of
		444	rxvt-unicode.
		445
		446	=over 4
		447
		448	=item $rend = urxvt::DEFAULT_RSTYLE
		449
		450	Returns the default rendition, as used when the terminal is starting up or
		451	being reset. Useful as a base to start when creating renditions.
		452
		453	=item $rend = urxvt::OVERLAY_RSTYLE
		454
		455	Return the rendition mask used for overlays by default.
		456
		457	=item $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
		458
		459	Return the bit that enabled bold, italic, blink, reverse-video and
		460	underline, respectively. To enable such a style, just logically OR it into
		461	the bitset.
		462
		463	=item $foreground = urxvt::GET_BASEFG $rend
		464
		465	=item $background = urxvt::GET_BASEBG $rend
		466
		467	Return the foreground/background colour index, respectively.
		468
		469	=item $rend = urxvt::SET_FGCOLOR $rend, $new_colour
		470
		471	=item $rend = urxvt::SET_BGCOLOR $rend, $new_colour
		472
		473	Replace the foreground/background colour in the rendition mask with the
		474	specified one.
		475
		476	=item $value = urxvt::GET_CUSTOM $rend
		477
		478	Return the "custom" value: Every rendition has 5 bits for use by
		479	extensions. They can be set and changed as you like and are initially
		480	zero.
		481
		482	=item $rend = urxvt::SET_CUSTOM $rend, $new_value
		483
		484	Change the custom value.
		485
		486	=back
		487
		488	=cut
493		489
494	BEGIN {	490	BEGIN {
495	urxvt->bootstrap;	491	urxvt->bootstrap;
496		492
497	# overwrite perl's warn	493	# overwrite perl's warn
…		…
781	for my $name (@HOOKNAME) {	777	for my $name (@HOOKNAME) {
782	if (my $ref = $pkg->can ("on_" . lc $name)) {	778	if (my $ref = $pkg->can ("on_" . lc $name)) {
783	$proxy->enable ($name => $ref);	779	$proxy->enable ($name => $ref);
784	}	780	}
785	}	781	}
		782	}
		783
		784	=item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
		785
		786	Creates a new terminal, very similar as if you had started it with system
		787	C<$rxvtname, arg...>. C<$envhashref> must be a reference to a %ENV>-like
		788	C<hash which defines the environment of the new terminal.
		789
		790	Croaks (and probably outputs an error message) if the new instance
		791	couldn't be created. Returns C<undef> if the new instance didn't
		792	initialise perl, and the terminal object otherwise. The C<init> and
		793	C<start> hooks will be called during this call.
		794
		795	=cut
		796
		797	sub new {
		798	my ($class, $env, @args) = @_;
		799
		800	_new ([ map "$_=$env->{$_}", keys %$env ], @args);
786	}	801	}
787		802
788	=item $term->destroy	803	=item $term->destroy
789		804
790	Destroy the terminal object (close the window, free resources	805	Destroy the terminal object (close the window, free resources
…		…
1055		1070
1056	=item $lines_in_scrollback = $term->nsaved	1071	=item $lines_in_scrollback = $term->nsaved
1057		1072
1058	Return various integers describing terminal characteristics.	1073	Return various integers describing terminal characteristics.
1059		1074
		1075	=item $x_display = $term->display_id
		1076
		1077	Return the DISPLAY used by rxvt-unicode.
		1078
1060	=item $lc_ctype = $term->locale	1079	=item $lc_ctype = $term->locale
1061		1080
1062	Returns the LC_CTYPE category string used by this rxvt-unicode.	1081	Returns the LC_CTYPE category string used by this rxvt-unicode.
1063		1082
1064	=item $x_display = $term->display_id	1083	=item $env = $term->env
1065		1084
1066	Return the DISPLAY used by rxvt-unicode.	1085	Returns a copy of the environment in effect for the terminal as a hashref
		1086	similar to C<\%ENV>.
		1087
		1088	=cut
		1089
		1090	sub env {
		1091	if (my $env = $_[0]->_env) {
		1092	+{ map /^([^=]+)(?:=(.*))?$/s && ($1 => $2), @$env }
		1093	} else {
		1094	+{ %ENV }
		1095	}
		1096	}
1067		1097
1068	=item $modifiermask = $term->ModLevel3Mask	1098	=item $modifiermask = $term->ModLevel3Mask
1069		1099
1070	=item $modifiermask = $term->ModMetaMask	1100	=item $modifiermask = $term->ModMetaMask
1071		1101
…		…
1311	$item->{render} \|\|= sub { $_[0]{text} };	1341	$item->{render} \|\|= sub { $_[0]{text} };
1312		1342
1313	push @{ $self->{item} }, $item;	1343	push @{ $self->{item} }, $item;
1314	}	1344	}
1315		1345
		1346	=item $popup->add_title ($title)
		1347
		1348	Adds a non-clickable title to the popup.
		1349
		1350	=cut
		1351
		1352	sub add_title {
		1353	my ($self, $title) = @_;
		1354
		1355	$self->add_item ({
		1356	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },
		1357	text => $title,
		1358	activate => sub { },
		1359	});
		1360	}
		1361
		1362	=item $popup->add_separator ([$sepchr])
		1363
		1364	Creates a separator, optionally using the character given as C<$sepchr>.
		1365
		1366	=cut
		1367
1316	sub add_separator {	1368	sub add_separator {
1317	my ($self, $sep) = @_;	1369	my ($self, $sep) = @_;
1318		1370
1319	$sep \|\|= "=";	1371	$sep \|\|= "=";
1320		1372
…		…
1324	render => sub { $sep x $self->{term}->ncol },	1376	render => sub { $sep x $self->{term}->ncol },
1325	activate => sub { },	1377	activate => sub { },
1326	});	1378	});
1327	}	1379	}
1328		1380
1329	sub add_title {	1381	=item $popup->add_button ($text, $cb)
1330	my ($self, $title) = @_;
1331		1382
1332	$self->add_item ({	1383	Adds a clickable button to the popup. C<$cb> is called whenever it is
1333	rend => { normal => "\x1b[38;5;11;44m", hover => "\x1b[38;5;11;44m", active => "\x1b[38;5;11;44m" },	1384	selected.
1334	text => $title,	1385
1335	activate => sub { },	1386	=cut
1336	});
1337	}
1338		1387
1339	sub add_button {	1388	sub add_button {
1340	my ($self, $text, $cb) = @_;	1389	my ($self, $text, $cb) = @_;
1341		1390
1342	$self->add_item ({ type => "button", text => $text, activate => $cb});	1391	$self->add_item ({ type => "button", text => $text, activate => $cb});
1343	}	1392	}
		1393
		1394	=item $popup->add_toggle ($text, $cb, $initial_value)
		1395
		1396	Adds a toggle/checkbox item to the popup. Teh callback gets called
		1397	whenever it gets toggled, with a boolean indicating its value as its first
		1398	argument.
		1399
		1400	=cut
1344		1401
1345	sub add_toggle {	1402	sub add_toggle {
1346	my ($self, $text, $cb, $value) = @_;	1403	my ($self, $text, $cb, $value) = @_;
1347		1404
1348	my $item; $item = {	1405	my $item; $item = {
1349	type => "button",	1406	type => "button",
1350	text => " $text",	1407	text => " $text",
1351	value => $value,	1408	value => $value,
1352	render => sub { ($_[0]{value} ? "* " : " ") . $text },	1409	render => sub { ($_[0]{value} ? "* " : " ") . $text },
1353	activate => sub { $cb->($_[0]{value} = !$_[0]{value}); },	1410	activate => sub { $cb->($_[1]{value} = !$_[1]{value}); },
1354	};	1411	};
1355		1412
1356	$self->add_item ($item);	1413	$self->add_item ($item);
1357	}	1414	}
		1415
		1416	=item $popup->show
		1417
		1418	Displays the popup (which is initially hidden).
		1419
		1420	=cut
1358		1421
1359	sub show {	1422	sub show {
1360	my ($self) = @_;	1423	my ($self) = @_;
1361		1424
1362	local $urxvt::popup::self = $self;	1425	local $urxvt::popup::self = $self;
1363		1426
		1427	my $env = $self->{term}->env;
		1428	# we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
		1429	delete $env->{LC_ALL};
1364	local $ENV{LC_ALL} = $self->{term}->locale;	1430	$env->{LC_CTYPE} = $self->{term}->locale;
1365		1431
		1432	urxvt::term->new ($env, $self->{term}->resource ("name"),
1366	urxvt->new ("--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,	1433	"--perl-lib" => "", "--perl-ext-common" => "", "-pty-fd" => -1, "-sl" => 0, "-b" => 0,
1367	"--transient-for" => $self->{term}->parent,	1434	"--transient-for" => $self->{term}->parent,
1368	"-display" => $self->{term}->display_id,	1435	"-display" => $self->{term}->display_id,
1369	"-pe" => "urxvt-popup")	1436	"-pe" => "urxvt-popup")
1370	or die "unable to create popup window\n";	1437	or die "unable to create popup window\n";
1371	}	1438	}
1372		1439
1373	sub DESTROY {	1440	sub DESTROY {
1374	my ($self) = @_;	1441	my ($self) = @_;

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs. Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.75 by root, Tue Jan 10 05:00:13 2006 UTC vs.
Revision 1.77 by root, Wed Jan 11 00:59:58 2006 UTC