#
# Copyright (c) 2008-2010 by FlashCode <flashcode@flashtux.org>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
# Set WeeChat and plugins options interactively.
#
# History:
# 2010-02-02, rettub <rettub@gmx.net>:
# version 0.9: turn all the help stuff off if option 'show_help_bar' is 'off',
# new key binding <alt>-<v> to toggle help_bar and help stuff on/off
# 2010-01-30, nils_2 <weechatter@arcor.de>:
# version 0.8: fix error when option does not exist
# 2010-01-24, FlashCode <flashcode@flashtux.org>:
# version 0.7: display iset bar only on iset buffer
# 2010-01-22, nils_2 <weechatter@arcor.de> and drubin:
# version 0.6: add description in a bar, fix singular/plural bug in title bar,
# fix selected line when switching buffer
# 2009-06-21, FlashCode <flashcode@flashtux.org>:
# version 0.5: fix bug with iset buffer after /upgrade
# 2009-05-02, FlashCode <flashcode@flashtux.org>:
# version 0.4: sync with last API changes
# 2009-01-04, FlashCode <flashcode@flashtux.org>:
# version 0.3: open iset buffer when /iset command is executed
# 2009-01-04, FlashCode <flashcode@flashtux.org>:
# version 0.2: use null values for options, add colors, fix refresh bugs,
# use new keys to reset/unset options, sort options by name,
# display number of options in buffer's title
# 2008-11-05, FlashCode <flashcode@flashtux.org>:
# version 0.1: first official version
# 2008-04-19, FlashCode <flashcode@flashtux.org>:
# script creation
use strict;
my $version = "0.9";
my $iset_buffer = "";
my @options_names = ();
my @options_types = ();
my @options_values = ();
my @options_is_null = ();
my $option_max_length = 0;
my $current_line = 0;
my $filter = "*";
my $description = "";
my $options_name_copy = "";
my %default_options = ("show_help_bar" => "on",
"show_help_extra_info" => "on",
"color_option" => "default",
"color_option_selected" => "white",
"color_type" => "brown",
"color_type_selected" => "yellow",
"color_value" => "cyan",
"color_value_selected" => "lightcyan",
"color_value_undef" => "green",
"color_value_undef_selected" => "lightgreen",
"color_bg_selected" => "red",
"color_help_option_name" => "white",
"color_help_text" => "default",
"color_help_default_value" => "green",
);
sub iset_init_config
{
foreach my $option (keys %default_options)
{
if (!weechat::config_is_set_plugin($option))
{
weechat::config_set_plugin($option, $default_options{$option});
}
}
}
sub iset_title
{
if ($iset_buffer ne "")
{
my $postfix = "s";
my $option_txt = " option";
my $opt_txt = $option_txt;
$opt_txt = $option_txt.$postfix if (@options_names > 1);
weechat::buffer_set($iset_buffer, "title",
"Interactive set (iset.pl v$version) | "
."Filter: ".weechat::color("yellow").$filter.weechat::color("default")." | "
.@options_names.$opt_txt);
}
}
sub iset_filter
{
$filter = $_[0];
$filter = "$1.*" if ($filter =~ /f (.*)/);
$filter = "*.$1.*" if ($filter =~ /s (.*)/);
if ((substr($filter, 0, 1) ne "*") && (substr($filter, -1, 1) ne "*"))
{
$filter = "*".$filter."*";
}
}
sub iset_buffer_input
{
my ($data, $buffer, $string) = ($_[0], $_[1], $_[2]);
iset_filter($string);
iset_get_options();
weechat::buffer_clear($buffer);
iset_title();
$current_line = 0;
iset_refresh();
return weechat::WEECHAT_RC_OK;
}
sub iset_buffer_close
{
$iset_buffer = "";
return weechat::WEECHAT_RC_OK;
}
sub iset_init
{
$current_line = 0;
$iset_buffer = weechat::buffer_search("perl", "iset");
if ($iset_buffer eq "")
{
$iset_buffer = weechat::buffer_new("iset", "iset_buffer_input", "", "iset_buffer_close", "");
}
if ($iset_buffer ne "")
{
weechat::buffer_set($iset_buffer, "type", "free");
iset_title();
weechat::buffer_set($iset_buffer, "key_bind_ctrl-L", "/iset **refresh");
weechat::buffer_set($iset_buffer, "key_bind_meta2-A", "/iset **up");
weechat::buffer_set($iset_buffer, "key_bind_meta2-B", "/iset **down");
weechat::buffer_set($iset_buffer, "key_bind_meta- ", "/iset **toggle");
weechat::buffer_set($iset_buffer, "key_bind_meta-+", "/iset **incr");
weechat::buffer_set($iset_buffer, "key_bind_meta--", "/iset **decr");
weechat::buffer_set($iset_buffer, "key_bind_meta-imeta-r", "/iset **reset");
weechat::buffer_set($iset_buffer, "key_bind_meta-imeta-u", "/iset **unset");
weechat::buffer_set($iset_buffer, "key_bind_meta-ctrl-J", "/iset **set");
weechat::buffer_set($iset_buffer, "key_bind_meta-ctrl-M", "/iset **set");
weechat::buffer_set($iset_buffer, "key_bind_meta-meta2-1~", "/iset **scroll_top");
weechat::buffer_set($iset_buffer, "key_bind_meta-meta2-4~", "/iset **scroll_bottom");
weechat::buffer_set($iset_buffer, "key_bind_meta-v", "/iset **toggle_help");
}
}
sub iset_get_options
{
@options_names = ();
@options_types = ();
@options_values = ();
@options_is_null = ();
$option_max_length = 0;
my %options = ();
my $i = 0;
my $infolist = weechat::infolist_get("option", "", $filter);
while (weechat::infolist_next($infolist))
{
my $name = weechat::infolist_string($infolist, "full_name");
my $type = weechat::infolist_string($infolist, "type");
my $value = weechat::infolist_string($infolist, "value");
my $is_null = weechat::infolist_integer($infolist, "value_is_null");
$options{$name}{"type"} = $type;
$options{$name}{"value"} = $value;
$options{$name}{"is_null"} = $is_null;
$option_max_length = length($name) if (length($name) > $option_max_length);
$i++;
}
weechat::infolist_free($infolist);
foreach my $name (sort keys %options)
{
push(@options_names, $name);
push(@options_types, $options{$name}{"type"});
push(@options_values, $options{$name}{"value"});
push(@options_is_null, $options{$name}{"is_null"});
}
}
sub iset_refresh_line
{
if ($iset_buffer ne "")
{
my $y = $_[0];
if ($y <= $#options_names)
{
return if (! defined($options_types[$y]));
my $format = sprintf("%%s%%-%ds %%s %%-7s %%s %%s%%s%%s", $option_max_length);
my $around = "";
$around = "\"" if ((!$options_is_null[$y]) && ($options_types[$y] eq "string"));
my $color1 = weechat::color(weechat::config_get_plugin("color_option"));
my $color2 = weechat::color(weechat::config_get_plugin("color_type"));
my $color3 = "";
if ($options_is_null[$y])
{
$color3 = weechat::color(weechat::config_get_plugin("color_value_undef"));
}
else
{
$color3 = weechat::color(weechat::config_get_plugin("color_value"));
}
if ($y == $current_line)
{
$color1 = weechat::color(weechat::config_get_plugin("color_option_selected").",".weechat::config_get_plugin("color_bg_selected"));
$color2 = weechat::color(weechat::config_get_plugin("color_type_selected").",".weechat::config_get_plugin("color_bg_selected"));
if ($options_is_null[$y])
{
$color3 = weechat::color(weechat::config_get_plugin("color_value_undef_selected").",".weechat::config_get_plugin("color_bg_selected"));
}
else
{
$color3 = weechat::color(weechat::config_get_plugin("color_value_selected").",".weechat::config_get_plugin("color_bg_selected"));
}
}
my $value = $options_values[$y];
$value = "(undef)" if ($options_is_null[$y]);
my $strline = sprintf($format,
$color1, $options_names[$y],
$color2, $options_types[$y],
$color3, $around, $value, $around);
weechat::print_y($iset_buffer, $y, $strline);
}
}
}
sub iset_refresh
{
iset_title();
if (($iset_buffer ne "") && ($#options_names >= 0))
{
foreach my $y (0 .. $#options_names)
{
iset_refresh_line($y);
}
}
weechat::bar_item_update("isetbar_help") if weechat::config_get_plugin('show_help_bar') eq 'on';
}
sub iset_full_refresh
{
if ($iset_buffer ne "")
{
weechat::buffer_clear($iset_buffer);
iset_get_options();
iset_set_current_line($current_line);
iset_refresh();
weechat::command($iset_buffer, "/window refresh");
}
}
sub iset_set_current_line
{
my $new_current_line = $_[0];
my $old_current_line = $current_line;
$current_line = $new_current_line;
$current_line = $#options_names if ($current_line > $#options_names);
if ($old_current_line != $current_line)
{
iset_refresh_line($old_current_line);
iset_refresh_line($current_line);
weechat::bar_item_update("isetbar_help") if weechat::config_get_plugin('show_help_bar') eq 'on';
}
}
sub iset_signal_window_scrolled_cb
{
my ($data, $signal, $signal_data) = ($_[0], $_[1], $_[2]);
if ($iset_buffer ne "")
{
my $infolist = weechat::infolist_get("window", $signal_data, "");
if (weechat::infolist_next($infolist))
{
if (weechat::infolist_pointer($infolist, "buffer") eq $iset_buffer)
{
my $old_current_line = $current_line;
my $new_current_line = $current_line;
my $start_line_y = weechat::infolist_integer($infolist, "start_line_y");
my $chat_height = weechat::infolist_integer($infolist, "chat_height");
$new_current_line += $chat_height if ($new_current_line < $start_line_y);
$new_current_line -= $chat_height if ($new_current_line >= $start_line_y + $chat_height);
$new_current_line = $start_line_y if ($new_current_line < $start_line_y);
$new_current_line = $start_line_y + $chat_height - 1 if ($new_current_line >= $start_line_y + $chat_height);
iset_set_current_line($new_current_line);
}
}
weechat::infolist_free($infolist);
}
return weechat::WEECHAT_RC_OK;
}
sub iset_check_line_outside_window
{
if ($iset_buffer ne "")
{
my $infolist = weechat::infolist_get("window", "", "current");
if (weechat::infolist_next($infolist))
{
my $start_line_y = weechat::infolist_integer($infolist, "start_line_y");
my $chat_height = weechat::infolist_integer($infolist, "chat_height");
if ($start_line_y > $current_line)
{
weechat::command($iset_buffer, "/window scroll -".($start_line_y - $current_line));
}
else
{
if ($start_line_y <= $current_line - $chat_height)
{
weechat::command($iset_buffer, "/window scroll +".($current_line - $start_line_y - $chat_height + 1));
}
}
}
weechat::infolist_free($infolist);
}
}
sub iset_get_option_name_index
{
my $option_name = $_[0];
my $index = 0;
while ($index <= $#options_names)
{
return -1 if ($options_names[$index] gt $option_name);
return $index if ($options_names[$index] eq $option_name);
$index++;
}
return -1;
}
sub iset_config_cb
{
my ($data, $option_name, $value) = ($_[0], $_[1], $_[2]);
if ($iset_buffer ne "")
{
my $index = iset_get_option_name_index($option_name);
if ($index >= 0)
{
# refresh info about changed option
my $infolist = weechat::infolist_get("option", "", $option_name);
if ($infolist)
{
weechat::infolist_next($infolist);
if (weechat::infolist_fields($infolist))
{
$options_types[$index] = weechat::infolist_string($infolist, "type");
$options_values[$index] = weechat::infolist_string($infolist, "value");
$options_is_null[$index] = weechat::infolist_integer($infolist, "value_is_null");
weechat::infolist_free($infolist);
iset_refresh_line($index);
}
else
{
iset_full_refresh();
}
}
}
else
{
iset_full_refresh() if ($option_name ne "weechat.bar.isetbar.hidden");
}
if ($option_name eq "plugins.var.perl.iset.show_help_bar")
{
my $show = 1;
$show = 0 if ($value eq "off");
iset_show_bar($show);
}
}
return weechat::WEECHAT_RC_OK;
}
sub iset_set_option
{
my $option = weechat::config_get($_[0]);
weechat::config_option_set($option, $_[1], 1) if ($option ne "");
}
sub iset_reset_option
{
my $option = weechat::config_get($_[0]);
weechat::config_option_reset($option, 1) if ($option ne "");
}
sub iset_unset_option
{
my $option = weechat::config_get($_[0]);
weechat::config_option_unset($option) if ($option ne "");
weechat::buffer_clear($iset_buffer);
iset_refresh();
}
sub iset_cmd_cb
{
my ($data, $buffer, $args) = ($_[0], $_[1], $_[2]);
if (($args ne "") && (substr($args, 0, 2) ne "**"))
{
iset_filter($args);
}
if ($iset_buffer eq "")
{
iset_init();
iset_get_options();
iset_refresh();
}
weechat::buffer_set($iset_buffer, "display", "1");
if ($args ne "")
{
if ($args eq "**refresh")
{
iset_full_refresh();
}
if ($args eq "**up")
{
if ($current_line > 0)
{
$current_line--;
iset_refresh_line($current_line + 1);
iset_refresh_line($current_line);
iset_check_line_outside_window();
}
}
if ($args eq "**down")
{
if ($current_line < $#options_names)
{
$current_line++;
iset_refresh_line($current_line - 1);
iset_refresh_line($current_line);
iset_check_line_outside_window();
}
}
if ($args eq "**scroll_top")
{
my $old_current_line = $current_line;
$current_line = 0;
iset_refresh_line ($old_current_line);
iset_refresh_line ($current_line);
weechat::command($iset_buffer, "/window scroll_top");
}
if ($args eq "**scroll_bottom")
{
my $old_current_line = $current_line;
$current_line = $#options_names;
iset_refresh_line ($old_current_line);
iset_refresh_line ($current_line);
weechat::command($iset_buffer, "/window scroll_bottom");
}
if ($args eq "**toggle")
{
if ($options_types[$current_line] eq "boolean")
{
iset_set_option($options_names[$current_line], "toggle");
}
}
if ($args eq "**incr")
{
if (($options_types[$current_line] eq "integer")
|| ($options_types[$current_line] eq "color"))
{
iset_set_option($options_names[$current_line], "++1");
}
}
if ($args eq "**decr")
{
if (($options_types[$current_line] eq "integer")
|| ($options_types[$current_line] eq "color"))
{
iset_set_option($options_names[$current_line], "--1");
}
}
if ($args eq "**reset")
{
iset_reset_option($options_names[$current_line]);
}
if ($args eq "**unset")
{
iset_unset_option($options_names[$current_line]);
}
if ($args eq "**toggle_help")
{
if (weechat::config_get_plugin("show_help_bar") eq "on")
{
weechat::config_set_plugin("show_help_bar", "off");
}
else
{
weechat::config_set_plugin("show_help_bar", "on");
}
}
if ($args eq "**set")
{
my $quote = "";
my $value = $options_values[$current_line];
if ($options_is_null[$current_line])
{
$value = "null";
}
else
{
$quote = "\"" if ($options_types[$current_line] eq "string");
}
weechat::buffer_set($iset_buffer, "input", "/set ".$options_names[$current_line]." ".$quote.$value.$quote);
}
}
weechat::bar_item_update("isetbar_help") if weechat::config_get_plugin('show_help_bar') eq 'on';
return weechat::WEECHAT_RC_OK;
}
sub iset_get_help
{
return '' unless weechat::config_get_plugin('show_help_bar') eq 'on';
if (not defined $options_names[$current_line])
{
return "No option selected. Set a new filter using command line (use '*' to see all options)";
}
if ($options_name_copy eq $options_names[$current_line])
{
return $description;
}
$options_name_copy = $options_names[$current_line];
my $optionlist ="";
$optionlist = weechat::infolist_get("option", "", $options_names[$current_line]);
weechat::infolist_next($optionlist);
my $full_name = weechat::infolist_string($optionlist,"full_name");
my $option_desc = "";
my $option_default_value = "";
my $option_range = "";
my $re = qq(\Q$full_name);
if (grep (/^$re$/,$options_names[$current_line]))
{
$option_desc = weechat::infolist_string($optionlist, "description_nls");
$option_desc = weechat::infolist_string($optionlist, "description") if ($option_desc eq "");
$option_desc = "No help found" if ($option_desc eq "");
$option_default_value = weechat::infolist_string($optionlist, "default_value");
if (weechat::infolist_string($optionlist, "type") eq "integer"
&& weechat::infolist_string($optionlist, "string_values") eq "")
{
$option_range = weechat::infolist_integer($optionlist, "min")
." .. ".weechat::infolist_integer($optionlist, "max");
}
}
weechat::infolist_free($optionlist);
iset_title();
$description = weechat::color(weechat::config_get_plugin("color_help_option_name")).$options_names[$current_line]
.weechat::color("bar_fg").": "
.weechat::color(weechat::config_get_plugin("color_help_text")).$option_desc;
if (weechat::config_get_plugin("show_help_extra_info") eq "on")
{
$description .=
weechat::color("bar_delim")." ["
.weechat::color("bar_fg")."default: "
.weechat::color("bar_delim")."\""
.weechat::color(weechat::config_get_plugin("color_help_default_value")).$option_default_value
.weechat::color("bar_delim")."\"";
if ($option_range ne "")
{
$description .= weechat::color("bar_fg").", values: ".$option_range;
}
$description .= weechat::color("bar_delim")."]";
}
return $description;
}
sub iset_check_condition_isetbar_cb
{
my ($data, $modifier, $modifier_data, $string) = ($_[0], $_[1], $_[2], $_[3]);
my $buffer = weechat::window_get_pointer($modifier_data, "buffer");
if ($buffer ne "")
{
if ((weechat::buffer_get_string($buffer, "plugin") eq "perl")
&& (weechat::buffer_get_string($buffer, "name") eq "iset"))
{
return "1";
}
}
return "0";
}
sub iset_show_bar
{
my $show = $_[0];
my $barhidden = weechat::config_get("weechat.bar.isetbar.hidden");
if ($barhidden)
{
if ($show)
{
if (weechat::config_get_plugin("show_help_bar") eq "on")
{
if (weechat::config_boolean($barhidden))
{
weechat::config_option_set($barhidden, 0, 1);
}
}
}
else
{
if (!weechat::config_boolean($barhidden))
{
weechat::config_option_set($barhidden, 1, 1);
}
}
}
}
sub iset_signal_buffer_switch_cb
{
my $buffer_pointer = $_[2];
my $show_bar = 0;
$show_bar = 1 if (weechat::buffer_get_integer($iset_buffer, "num_displayed") > 0);
iset_show_bar($show_bar);
iset_check_line_outside_window() if ($buffer_pointer eq $iset_buffer);
return weechat::WEECHAT_RC_OK;
}
sub iset_item_cb()
{
return iset_get_help();
}
sub iset_end()
{
# when script is unloaded, we hide bar
iset_show_bar(0);
}
weechat::register("iset", "FlashCode <flashcode\@flashtux.org>", $version, "GPL3", "Interactive Set for configuration options", "iset_end", "");
weechat::hook_command("iset", "Interactive set", "[f file] [s section] [text]",
"f file : show options for a file (for example: 'f weechat' or 'f irc')\n".
"s section : show options for a section (for example: 's look')\n".
"text : show options with 'text' in name (for example: 'nicklist')\n\n".
"Keys for iset buffer:\n".
"up,down : move one option up/down\n".
"pgup,pdwn : move one page up/down\n".
"ctrl+'L' : refresh options and screen\n".
"alt+space : toggle boolean on/off\n".
"alt+'+' : increase value (for integer or color)\n".
"alt+'-' : decrease value (for integer or color)\n".
"alt+'I',alt+'R': reset value of option\n".
"alt+'I',alt+'U': unset option\n".
"alt+enter : set new value for option (edit it with command line)\n".
"text,enter : set a new filter using command line (use '*' to see all options)\n".
"alt+'V' : toggle help bar\n",
"", "iset_cmd_cb", "");
weechat::hook_signal("window_scrolled", "iset_signal_window_scrolled_cb", "");
weechat::hook_signal("buffer_switch", "iset_signal_buffer_switch_cb","");
weechat::hook_config("*", "iset_config_cb", "");
weechat::bar_item_new("isetbar_help", "iset_item_cb", "");
weechat::bar_new("isetbar", "on", "0", "window", "", "top", "horizontal",
"vertical", "3", "3", "default", "cyan", "default", "1",
"isetbar_help");
weechat::hook_modifier("bar_condition_isetbar", "iset_check_condition_isetbar_cb", "");
iset_init_config();
$iset_buffer = weechat::buffer_search("perl", "iset");
iset_init() if ($iset_buffer ne "");
Back to scripts |
Download