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

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC vs.
Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC

   URxvt.perl-ext-common: default,selection-autotransform
 Extensions may add additional resources and C<actions>, i.e., methods
 which can be bound to a key and invoked by the user. An extension can
-define the resources it support and also default bindings for one or
+define the resources it support using so called META comments,
-more actions it provides using so called META comments, described
-below. Similarly to builtin resources, extension resources can also be
+described below. Similarly to builtin resources, extension resources
-specified on the command line as long options (with C<.> replaced by
+can also be specified on the command line as long options (with C<.>
-C<->), in which case the corresponding extension is loaded
+replaced by C<->), in which case the corresponding extension is loaded
 automatically. For this to work the extension B<must> define META
 comments for its resources.
 =head1 API DOCUMENTATION
 the C<urxvt::extension> section below.
 =head2 META comments
 Rxvt-unicode recognizes special meta comments in extensions that define
-different types of metadata.
+different types of metadata. These comments are scanned whenever a
+terminal is created and are typically used to autoload extensions when
+their resources or command line parameters are used.
-Currently, it recxognises only one such comment:
+Currently, it recognises only one such comment:
 =over 4
 =item #:META:RESOURCE:name:type:desc
 The RESOURCE comment defines a resource used by the extension, where
 C<name> is the resource name, C<type> is the resource type, C<boolean>
 or C<string>, and C<desc> is the resource description.
+The extension will be autoloaded when this resource is specified or used
+as a command line parameter.
 =back
 =head2 Hooks
 ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
 CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
 SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
 Various constants for use in X calls and event processing.
+=item urxvt::PrivMode_132, PrivMode_132OK, PrivMode_rVideo, PrivMode_relOrigin,
+PrivMode_Screen, PrivMode_Autowrap, PrivMode_aplCUR, PrivMode_aplKP,
+PrivMode_HaveBackSpace, PrivMode_BackSpace, PrivMode_ShiftKeys,
+PrivMode_VisibleCursor, PrivMode_MouseX10, PrivMode_MouseX11,
+PrivMode_scrollBar, PrivMode_TtyOutputInh, PrivMode_Keypress,
+PrivMode_smoothScroll, PrivMode_vt52, PrivMode_LFNL, PrivMode_MouseBtnEvent,
+PrivMode_MouseAnyEvent, PrivMode_BracketPaste, PrivMode_ExtModeMouse,
+PrivMode_ExtMouseRight, PrivMode_BlinkingCursor, PrivMode_mouse_report,
+PrivMode_Default
+Constants for checking DEC private modes.
 =back
 =head2 RENDITION
 sub parse_resource {
    my ($term, $name, $isarg, $longopt, $flag, $value) = @_;
    $term->scan_extensions;
+   # iterating over all resources has quadratic time overhead
+   # overall, maybe this could be optimised?
    my $r = $term->{meta}{resource};
    keys %$r; # reset iterator
    while (my ($k, $v) = each %$r) {
       my $pattern = $k;
       $pattern =~ y/./-/ if $isarg;
       }
       if ($pattern eq $prefix) {
          $name = "$urxvt::RESCLASS.$k$suffix";
          push @{ $term->{perl_ext_3} }, $v->[0];
+         return 1 unless $isarg;
          if ($v->[1] eq "boolean") {
             $term->put_option_db ($name, $flag ? "true" : "false");
             return 1;
          } else {
    my ($self) = @_;
    return if exists $self->{meta};
    my @urxvtdirs = perl_libdirs $self;
-   my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
+#   my @cpandirs = grep -d, map "$_/URxvt/Ext", @INC;
    $self->{meta} = \my %meta;
    # first gather extensions
          $meta{ext}{$ext} = \%ext;
       }
    };
-   $gather->($_, 0) for @cpandirs;
+#   $gather->($_, 0) for @cpandirs;
    $gather->($_, 1) for @urxvtdirs;
    # and now merge resources
+   $meta{resource} = \my %resource;
    while (my ($k, $v) = each %{ $meta{ext} }) {
       #TODO: should check for extensions overriding each other
-      %{ $meta{resource} } = (%{ $meta{resource} }, %{ $v->{resource} });
+      %resource = (%resource, %{ $v->{resource} });
    }
 }
 =item $term = new urxvt::term $envhashref, $rxvtname, [arg...]
    my $res = &x_resource;
    $res =~ /^\s*(?:true|yes|on|1)\s*$/i ? 1 : defined $res && 0
 }
+=item $action = $term->lookup_keysym ($keysym, $state)
+Returns the action bound to key combination C<($keysym, $state)>,
+if a binding for it exists, and C<undef> otherwise.
 =item $success = $term->bind_action ($key, $action)
 Adds a key binding exactly as specified via a C<keysym> resource. See the
 C<keysym> resource in the urxvt(1) manpage.
-To add default bindings for an extension, the extension should call C<<
+To add default bindings for actions, an extension should call C<<
-->bind_action >> on it's C<init> hook for every such binding. Doing it
+->bind_action >> in its C<init> hook for every such binding. Doing it
-in the C<init> hook allows users the override or remove the the binding
+in the C<init> hook allows users to override or remove the binding
 again.
 Example: the C<searchable-scrollback> by default binds itself
 on C<Meta-s>, using C<< $self->bind_action >>, which calls C<<
 $term->bind_action >>.
 =item $term->key_release ($state, $keycode[, $time])
 Deliver various fake events to to terminal.
-=item $window_width = $term->width
+=item $window_width = $term->width ([$new_value])
-=item $window_height = $term->height
+=item $window_height = $term->height ([$new_value])
-=item $font_width = $term->fwidth
+=item $font_width = $term->fwidth ([$new_value])
-=item $font_height = $term->fheight
+=item $font_height = $term->fheight ([$new_value])
-=item $font_ascent = $term->fbase
+=item $font_ascent = $term->fbase ([$new_value])
-=item $terminal_rows = $term->nrow
+=item $terminal_rows = $term->nrow ([$new_value])
-=item $terminal_columns = $term->ncol
+=item $terminal_columns = $term->ncol ([$new_value])
-=item $has_focus = $term->focus
+=item $has_focus = $term->focus ([$new_value])
-=item $is_mapped = $term->mapped
+=item $is_mapped = $term->mapped ([$new_value])
-=item $max_scrollback = $term->saveLines
+=item $max_scrollback = $term->saveLines ([$new_value])
-=item $nrow_plus_saveLines = $term->total_rows
+=item $nrow_plus_saveLines = $term->total_rows ([$new_value])
-=item $topmost_scrollback_row = $term->top_row
+=item $topmost_scrollback_row = $term->top_row ([$new_value])
-Return various integers describing terminal characteristics.
+Return various integers describing terminal characteristics. If an
+argument is given, changes the value and returns the previous one.
 =item $x_display = $term->display_id
 Return the DISPLAY used by rxvt-unicode.
 Returns the currently displayed screen (0 primary, 1 secondary).
 =item $cursor_is_hidden = $term->hidden_cursor
 Returns whether the cursor is currently hidden or not.
+=item $priv_modes = $term->priv_modes
+Returns a bitset with the state of DEC private modes.
+Example:
+  if ($term->priv_modes & urxvt::PrivMode_mouse_report) {
+      # mouse reporting is turned on
+  }
 =item $view_start = $term->view_start ([$newvalue])
 Returns the row number of the topmost displayed line. Maximum value is
 C<0>, which displays the normal terminal contents. Lower values scroll
 Requests a screen refresh. At the next opportunity, rxvt-unicode will
 compare the on-screen display with its stored representation. If they
 differ, it redraws the differences.
 Used after changing terminal contents to display them.
+=item $term->refresh_check
+Checks if a refresh has been requested and, if so, schedules one.
 =item $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
 Returns the text of the entire row with number C<$row_number>. Row C<< $term->top_row >>
 is the topmost terminal line, row C<< $term->nrow-1 >> is the bottommost

Diff Legend

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

Comparing rxvt-unicode/src/urxvt.pm (file contents): Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC vs. Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC

Diff Legend

Comparing rxvt-unicode/src/urxvt.pm (file contents):
Revision 1.249 by root, Fri Dec 26 21:26:37 2014 UTC vs.
Revision 1.258 by root, Tue Sep 17 20:38:14 2019 UTC