… | |
… | |
123 | =over 4 |
123 | =over 4 |
124 | |
124 | |
125 | =item $text |
125 | =item $text |
126 | |
126 | |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
127 | Rxvt-unicodes special way of encoding text, where one "unicode" character |
128 | 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. |
129 | |
129 | |
130 | =item $string |
130 | =item $string |
131 | |
131 | |
132 | 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 |
133 | 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 |
… | |
… | |
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 | =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 |
493 | |
487 | |
494 | BEGIN { |
488 | BEGIN { |
495 | urxvt->bootstrap; |
489 | urxvt->bootstrap; |
496 | |
490 | |
497 | # overwrite perl's warn |
491 | # overwrite perl's warn |
… | |
… | |
781 | for my $name (@HOOKNAME) { |
775 | for my $name (@HOOKNAME) { |
782 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
776 | if (my $ref = $pkg->can ("on_" . lc $name)) { |
783 | $proxy->enable ($name => $ref); |
777 | $proxy->enable ($name => $ref); |
784 | } |
778 | } |
785 | } |
779 | } |
|
|
780 | } |
|
|
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); |
786 | } |
799 | } |
787 | |
800 | |
788 | =item $term->destroy |
801 | =item $term->destroy |
789 | |
802 | |
790 | Destroy the terminal object (close the window, free resources |
803 | Destroy the terminal object (close the window, free resources |
… | |
… | |
1055 | |
1068 | |
1056 | =item $lines_in_scrollback = $term->nsaved |
1069 | =item $lines_in_scrollback = $term->nsaved |
1057 | |
1070 | |
1058 | Return various integers describing terminal characteristics. |
1071 | Return various integers describing terminal characteristics. |
1059 | |
1072 | |
|
|
1073 | =item $x_display = $term->display_id |
|
|
1074 | |
|
|
1075 | Return the DISPLAY used by rxvt-unicode. |
|
|
1076 | |
1060 | =item $lc_ctype = $term->locale |
1077 | =item $lc_ctype = $term->locale |
1061 | |
1078 | |
1062 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1079 | Returns the LC_CTYPE category string used by this rxvt-unicode. |
1063 | |
1080 | |
1064 | =item $x_display = $term->display_id |
1081 | =item $env = $term->env |
1065 | |
1082 | |
1066 | 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 | } |
1067 | |
1095 | |
1068 | =item $modifiermask = $term->ModLevel3Mask |
1096 | =item $modifiermask = $term->ModLevel3Mask |
1069 | |
1097 | |
1070 | =item $modifiermask = $term->ModMetaMask |
1098 | =item $modifiermask = $term->ModMetaMask |
1071 | |
1099 | |
… | |
… | |
1311 | $item->{render} ||= sub { $_[0]{text} }; |
1339 | $item->{render} ||= sub { $_[0]{text} }; |
1312 | |
1340 | |
1313 | push @{ $self->{item} }, $item; |
1341 | push @{ $self->{item} }, $item; |
1314 | } |
1342 | } |
1315 | |
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 | |
1316 | sub add_separator { |
1366 | sub add_separator { |
1317 | my ($self, $sep) = @_; |
1367 | my ($self, $sep) = @_; |
1318 | |
1368 | |
1319 | $sep ||= "="; |
1369 | $sep ||= "="; |
1320 | |
1370 | |
… | |
… | |
1324 | render => sub { $sep x $self->{term}->ncol }, |
1374 | render => sub { $sep x $self->{term}->ncol }, |
1325 | activate => sub { }, |
1375 | activate => sub { }, |
1326 | }); |
1376 | }); |
1327 | } |
1377 | } |
1328 | |
1378 | |
1329 | sub add_title { |
1379 | =item $popup->add_button ($text, $cb) |
1330 | my ($self, $title) = @_; |
|
|
1331 | |
1380 | |
1332 | $self->add_item ({ |
1381 | 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" }, |
1382 | selected. |
1334 | text => $title, |
1383 | |
1335 | activate => sub { }, |
1384 | =cut |
1336 | }); |
|
|
1337 | } |
|
|
1338 | |
1385 | |
1339 | sub add_button { |
1386 | sub add_button { |
1340 | my ($self, $text, $cb) = @_; |
1387 | my ($self, $text, $cb) = @_; |
1341 | |
1388 | |
1342 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1389 | $self->add_item ({ type => "button", text => $text, activate => $cb}); |
1343 | } |
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 |
1344 | |
1399 | |
1345 | sub add_toggle { |
1400 | sub add_toggle { |
1346 | my ($self, $text, $cb, $value) = @_; |
1401 | my ($self, $text, $cb, $value) = @_; |
1347 | |
1402 | |
1348 | my $item; $item = { |
1403 | my $item; $item = { |
1349 | type => "button", |
1404 | type => "button", |
1350 | text => " $text", |
1405 | text => " $text", |
1351 | value => $value, |
1406 | value => $value, |
1352 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1407 | render => sub { ($_[0]{value} ? "* " : " ") . $text }, |
1353 | activate => sub { $cb->($_[0]{value} = !$_[0]{value}); }, |
1408 | activate => sub { $cb->($_[1]{value} = !$_[1]{value}); }, |
1354 | }; |
1409 | }; |
1355 | |
1410 | |
1356 | $self->add_item ($item); |
1411 | $self->add_item ($item); |
1357 | } |
1412 | } |
|
|
1413 | |
|
|
1414 | =item $popup->show |
|
|
1415 | |
|
|
1416 | Displays the popup (which is initially hidden). |
|
|
1417 | |
|
|
1418 | =cut |
1358 | |
1419 | |
1359 | sub show { |
1420 | sub show { |
1360 | my ($self) = @_; |
1421 | my ($self) = @_; |
1361 | |
1422 | |
1362 | local $urxvt::popup::self = $self; |
1423 | local $urxvt::popup::self = $self; |
1363 | |
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}; |
1364 | local $ENV{LC_ALL} = $self->{term}->locale; |
1428 | $env->{LC_CTYPE} = $self->{term}->locale; |
1365 | |
1429 | |
|
|
1430 | urxvt::term->new ($env, $self->{term}->resource ("name"), |
1366 | 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, |
1367 | "--transient-for" => $self->{term}->parent, |
1432 | "--transient-for" => $self->{term}->parent, |
1368 | "-display" => $self->{term}->display_id, |
1433 | "-display" => $self->{term}->display_id, |
1369 | "-pe" => "urxvt-popup") |
1434 | "-pe" => "urxvt-popup") |
1370 | or die "unable to create popup window\n"; |
1435 | or die "unable to create popup window\n"; |
1371 | } |
1436 | } |
1372 | |
1437 | |
1373 | sub DESTROY { |
1438 | sub DESTROY { |
1374 | my ($self) = @_; |
1439 | my ($self) = @_; |
1375 | |
1440 | |
1376 | delete $self->{term}{_destroy}{$self}; |
1441 | delete $self->{term}{_destroy}{$self}; |
1377 | $self->{term}->ungrab; |
1442 | $self->{term}->ungrab; |
1378 | } |
1443 | } |
|
|
1444 | |
|
|
1445 | =back |
1379 | |
1446 | |
1380 | =head2 The C<urxvt::timer> Class |
1447 | =head2 The C<urxvt::timer> Class |
1381 | |
1448 | |
1382 | This class implements timer watchers/events. Time is represented as a |
1449 | This class implements timer watchers/events. Time is represented as a |
1383 | fractional number of seconds since the epoch. Example: |
1450 | fractional number of seconds since the epoch. Example: |