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.170 by root, Tue Sep 23 07:03:13 2008 UTC vs.
Revision 1.171 by root, Fri Oct 10 00:11:44 2008 UTC

… …
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

Diff Legend

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