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.161 by ayin, Fri Nov 30 01:22:26 2007 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC

108reference. The string will be used as button text and the code reference 108reference. The string will be used as button text and the code reference
109will be called when the toggle changes, with the new boolean value as 109will be called when the toggle changes, with the new boolean value as
110first argument. 110first argument.
111 111
112The following will add an entry C<myoption> that changes 112The following will add an entry C<myoption> that changes
113C<$self->{myoption}>: 113C<< $self->{myoption} >>:
114 114
115 push @{ $self->{term}{option_popup_hook} }, sub { 115 push @{ $self->{term}{option_popup_hook} }, sub {
116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] }) 116 ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
117 }; 117 };
118 118
541 541
542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1, 542It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total 543$nrow - 1) represent the lines to be scrolled out). C<$saved> is the total
544number of lines that will be in the scrollback buffer. 544number of lines that will be in the scrollback buffer.
545 545
546=item on_osc_seq $term, $op, $args 546=item on_osc_seq $term, $op, $args, $resp
547 547
548Called on every OSC sequence and can be used to suppress it or modify its 548Called on every OSC sequence and can be used to suppress it or modify its
549behaviour. The default should be to return an empty list. A true value 549behaviour. The default should be to return an empty list. A true value
550suppresses execution of the request completely. Make sure you don't get 550suppresses execution of the request completely. Make sure you don't get
551confused by recursive invocations when you output an osc sequence within 551confused by recursive invocations when you output an OSC sequence within
552this callback. 552this callback.
553 553
554C<on_osc_seq_perl> should be used for new behaviour. 554C<on_osc_seq_perl> should be used for new behaviour.
555 555
556=item on_osc_seq_perl $term, $string 556=item on_osc_seq_perl $term, $args, $resp
557 557
558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC = 558Called whenever the B<ESC ] 777 ; string ST> command sequence (OSC =
559operating system command) is processed. Cursor position and other state 559operating system command) is processed. Cursor position and other state
560information is up-to-date when this happens. For interoperability, the 560information is up-to-date when this happens. For interoperability, the
561string should start with the extension name and a colon, to distinguish 561string should start with the extension name (sans -osc) and a semicolon,
562it from commands for other extensions, and this might be enforced in the 562to distinguish it from commands for other extensions, and this might be
563future. 563enforced in the future.
564
565For example, C<overlay-osc> uses this:
566
567 sub on_osc_seq_perl {
568 my ($self, $osc, $resp) = @_;
569
570 return unless $osc =~ s/^overlay;//;
571
572 ... process remaining $osc string
573 }
564 574
565Be careful not ever to trust (in a security sense) the data you receive, 575Be careful not ever to trust (in a security sense) the data you receive,
566as its source can not easily be controlled (e-mail content, messages from 576as its source can not easily be controlled (e-mail content, messages from
567other users on the same system etc.). 577other users on the same system etc.).
578
579For responses, C<$resp> contains the end-of-args separator used by the
580sender.
568 581
569=item on_add_lines $term, $string 582=item on_add_lines $term, $string
570 583
571Called whenever text is about to be output, with the text as argument. You 584Called whenever text is about to be output, with the text as argument. You
572can filter/change and output the text yourself by returning a true value 585can filter/change and output the text yourself by returning a true value
593later with the already-modified line (e.g. if unrelated parts change), so 606later with the already-modified line (e.g. if unrelated parts change), so
594you cannot just toggle rendition bits, but only set them. 607you cannot just toggle rendition bits, but only set them.
595 608
596=item on_refresh_begin $term 609=item on_refresh_begin $term
597 610
598Called just before the screen gets redrawn. Can be used for overlay 611Called just before the screen gets redrawn. Can be used for overlay or
599or similar effects by modify terminal contents in refresh_begin, and 612similar effects by modifying the terminal contents in refresh_begin, and
600restoring them in refresh_end. The built-in overlay and selection display 613restoring them in refresh_end. The built-in overlay and selection display
601code is run after this hook, and takes precedence. 614code is run after this hook, and takes precedence.
602 615
603=item on_refresh_end $term 616=item on_refresh_end $term
604 617
1091is that you cannot use blocking APIs, but the non-blocking variant should 1104is that you cannot use blocking APIs, but the non-blocking variant should
1092work. 1105work.
1093 1106
1094=cut 1107=cut
1095 1108
1096our $VERSION = 1; 1109our $VERSION = '3.4';
1097 1110
1098$INC{"urxvt/anyevent.pm"} = 1; # mark us as there 1111$INC{"urxvt/anyevent.pm"} = 1; # mark us as there
1099push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::]; 1112push @AnyEvent::REGISTRY, [urxvt => urxvt::anyevent::];
1100 1113
1101sub timer { 1114sub timer {
1132 1145
1133sub DESTROY { 1146sub DESTROY {
1134 $_[0][1]->stop; 1147 $_[0][1]->stop;
1135} 1148}
1136 1149
1137sub condvar {
1138 bless \my $flag, urxvt::anyevent::
1139}
1140
1141sub broadcast {
1142 ${$_[0]}++;
1143}
1144
1145sub wait {
1146 unless (${$_[0]}) {
1147 Carp::croak "AnyEvent->condvar blocking wait unsupported in urxvt, use a non-blocking API";
1148 }
1149}
1150
1151sub one_event { 1150sub one_event {
1152 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API"; 1151 Carp::croak "AnyEvent->one_event blocking wait unsupported in urxvt, use a non-blocking API";
1153} 1152}
1154 1153
1155package urxvt::term; 1154package urxvt::term;
1276Here is a likely non-exhaustive list of resource names, not all of which 1275Here is a likely non-exhaustive list of resource names, not all of which
1277are supported in every build, please see the source file F</src/rsinc.h> 1276are supported in every build, please see the source file F</src/rsinc.h>
1278to see the actual list: 1277to see the actual list:
1279 1278
1280 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont 1279 answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
1281 borderLess color cursorBlink cursorUnderline cutchars delete_key 1280 borderLess chdir color cursorBlink cursorUnderline cutchars delete_key
1282 display_name embed ext_bwidth fade font geometry hold iconName 1281 display_name embed ext_bwidth fade font geometry hold iconName
1283 imFont imLocale inputMethod insecure int_bwidth intensityStyles 1282 imFont imLocale inputMethod insecure int_bwidth intensityStyles
1284 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier 1283 italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
1285 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval 1284 mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
1286 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay 1285 perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
1287 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar 1286 preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
1288 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness 1287 scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
1289 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle 1288 scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
1290 secondaryScreen secondaryScroll selectstyle shade term_name title 1289 secondaryScreen secondaryScroll shade term_name title
1291 transient_for transparent transparent_all tripleclickwords utmpInhibit 1290 transient_for transparent transparent_all tripleclickwords utmpInhibit
1292 visualBell 1291 visualBell
1293 1292
1294=cut 1293=cut
1295 1294
1296sub resource($$;$) { 1295sub resource($$;$) {
1297 my ($self, $name) = (shift, shift); 1296 my ($self, $name) = (shift, shift);
1298 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0); 1297 unshift @_, $self, $name, ($name =~ s/\s*\+\s*(\d+)$// ? $1 : 0);
1299 &urxvt::term::_resource 1298 goto &urxvt::term::_resource
1300} 1299}
1301 1300
1302=item $value = $term->x_resource ($pattern) 1301=item $value = $term->x_resource ($pattern)
1303 1302
1304Returns the X-Resource for the given pattern, excluding the program or 1303Returns the X-Resource for the given pattern, excluding the program or
1611 1610
1612Used after changing terminal contents to display them. 1611Used after changing terminal contents to display them.
1613 1612
1614=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]]) 1613=item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
1615 1614
1616Returns the text of the entire row with number C<$row_number>. Row C<0> 1615Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
1617is the topmost terminal line, row C<< $term->$ncol-1 >> is the bottommost 1616is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost
1618terminal line. The scrollback buffer starts at line C<-1> and extends to
1619line C<< -$term->nsaved >>. Nothing will be returned if a nonexistent line 1617terminal line. Nothing will be returned if a nonexistent line
1620is requested. 1618is requested.
1621 1619
1622If C<$new_text> is specified, it will replace characters in the current 1620If C<$new_text> is specified, it will replace characters in the current
1623line, starting at column C<$start_col> (default C<0>), which is useful 1621line, starting at column C<$start_col> (default C<0>), which is useful
1624to replace only parts of a line. The font index in the rendition will 1622to replace only parts of a line. The font index in the rendition will
1625automatically be updated. 1623automatically be updated.
1626 1624
1627C<$text> is in a special encoding: tabs and wide characters that use more 1625C<$text> is in a special encoding: tabs and wide characters that use more
1628than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535) 1626than one cell when displayed are padded with C<$urxvt::NOCHAR> (chr 65535)
1629characters. Characters with combining characters and other characters that 1627characters. Characters with combining characters and other characters that
1630do not fit into the normal tetx encoding will be replaced with characters 1628do not fit into the normal text encoding will be replaced with characters
1631in the private use area. 1629in the private use area.
1632 1630
1633You have to obey this encoding when changing text. The advantage is 1631You have to obey this encoding when changing text. The advantage is
1634that C<substr> and similar functions work on screen cells and not on 1632that C<substr> and similar functions work on screen cells and not on
1635characters. 1633characters.
1822 1820
1823=item @atoms = $term->XListProperties ($window) 1821=item @atoms = $term->XListProperties ($window)
1824 1822
1825=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property) 1823=item ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
1826 1824
1827=item $term->XChangeWindowProperty ($window, $property, $type, $format, $octets) 1825=item $term->XChangeProperty ($window, $property, $type, $format, $octets)
1828 1826
1829=item $term->XDeleteProperty ($window, $property) 1827=item $term->XDeleteProperty ($window, $property)
1830 1828
1831=item $window = $term->DefaultRootWindow 1829=item $window = $term->DefaultRootWindow
1832 1830
1954 my $env = $self->{term}->env; 1952 my $env = $self->{term}->env;
1955 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE. 1953 # we can't hope to reproduce the locale algorithm, so nuke LC_ALL and set LC_CTYPE.
1956 delete $env->{LC_ALL}; 1954 delete $env->{LC_ALL};
1957 $env->{LC_CTYPE} = $self->{term}->locale; 1955 $env->{LC_CTYPE} = $self->{term}->locale;
1958 1956
1959 urxvt::term->new ($env, "popup", 1957 my $term = urxvt::term->new (
1958 $env, "popup",
1960 "--perl-lib" => "", "--perl-ext-common" => "", 1959 "--perl-lib" => "", "--perl-ext-common" => "",
1961 "-pty-fd" => -1, "-sl" => 0, 1960 "-pty-fd" => -1, "-sl" => 0,
1962 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect", 1961 "-b" => 1, "-bd" => "grey80", "-bl", "-override-redirect",
1963 "--transient-for" => $self->{term}->parent, 1962 "--transient-for" => $self->{term}->parent,
1964 "-display" => $self->{term}->display_id, 1963 "-display" => $self->{term}->display_id,
1965 "-pe" => "urxvt-popup") 1964 "-pe" => "urxvt-popup",
1966 or die "unable to create popup window\n"; 1965 ) or die "unable to create popup window\n";
1966
1967 unless (delete $term->{urxvt_popup_init_done}) {
1968 $term->ungrab;
1969 $term->destroy;
1970 die "unable to initialise popup window\n";
1971 }
1967} 1972}
1968 1973
1969sub DESTROY { 1974sub DESTROY {
1970 my ($self) = @_; 1975 my ($self) = @_;
1971 1976

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines