diff options
Diffstat (limited to 'prompt_info/uberprompt.pl')
| -rw-r--r-- | prompt_info/uberprompt.pl | 214 |
1 files changed, 144 insertions, 70 deletions
diff --git a/prompt_info/uberprompt.pl b/prompt_info/uberprompt.pl index d5f66b2..79717ae 100644 --- a/prompt_info/uberprompt.pl +++ b/prompt_info/uberprompt.pl @@ -2,7 +2,7 @@ # of displaying additional information, under either user control or via # scripts. # -# Installation: +# INSTALL: # # Place script in ~/.irssi/scripts/ and potentially symlink into autorun/ # to ensure it starts at irssi startup. @@ -11,11 +11,16 @@ # # /script load uberprompt.pl # -# Usage: +# If you have a custom prompt format, you may need to copy it to the +# uberprompt_format setting. See below for details. +# +# USAGE: # # Although the script is designed primarily for other scripts to set # status information into the prompt, the following commands are available: # +# TODO: Document positional settings. +# # /prompt set - sets the prompt to the given argument. $p in the argument will # be replaced by the original prompt content. # /prompt clear - clears the additional data provided to the prompt. @@ -26,21 +31,43 @@ # # Additionally, the format for the prompt can be set via: # +# UBERPROMPT FORMAT: +# # /set uberprompt_format <format> # # The default is [$*], which is the same as the default provided in default.theme. # Changing this setting will update the prompt immediately, unlike editing your theme. # +# An additional variable available within this format is '$uber', which expands to +# the content of prompt data provided with the UP_INNER placement argument. For all +# other placement arguments, it will expand to the empty string ''. +# # NOTE: this setting completely overrides the prompt="..." line in your .theme # file, and may cause unexpected behaviour if your theme wishes to set a # different form of prompt. It can be simply copied from the theme file into # the above setting. # -# Usage from other Scripts: +# Usage from other Scripts: signal 'change prompt' => 'string' => position +# +# eg: +# +# signal_emit 'change prompt' 'some_string', UberPrompt::UP_INNER; +# +# will set the prompt to include that content, by default '[$* some_string]' +# +# The possible position arguments are the following strings: # -# signal_emit 'change prompt' 'some_string $p other string'; +# UP_PRE - place the provided string before the prompt -- $string$prompt +# UP_INNER - place the provided string inside the prompt -- {prompt $* $string} +# UP_POST - place the provided string after the prompt -- $prompt$string +# UP_ONLY - replace the prompt with the provided string -- $string # -# will set the prompt to include that content. +# All strings may use the special variable '$prompt' to include the prompt +# verbatim at that position in the string. It is probably only useful for +# the UP_ONLY mode however. '$prompt_nt' will include the prompt, minus any +# trailing whitespace. +# +# NOTIFICATIONS: # # You can also be notified when the prompt changes in response to the previous # signal or manual commands via: @@ -75,7 +102,6 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. - use strict; use warnings; @@ -83,8 +109,6 @@ use Irssi; use Irssi::TextUI; # for sbar_items_redraw use Data::Dumper; - - our $VERSION = "0.2"; our %IRSSI = ( @@ -99,136 +123,189 @@ our %IRSSI = my $DEBUG_ENABLED = 0; - sub DEBUG { $DEBUG_ENABLED } -my $prompt_data = undef; +my $prompt_data = ''; +my $prompt_data_pos = 'UP_INNER'; -my $prompt_format = ''; +my $prompt_last = ''; +my $prompt_format = ''; init(); sub prompt_subcmd_handler { my ($data, $server, $item) = @_; - $data =~ s/\s+$//g; # strip trailing whitespace. + $data =~ s/\s+$//g; # strip trailing whitespace. Irssi::command_runsub('prompt', $data, $server, $item); } +sub UNLOAD { + # remove uberprompt and return the original ones. + print "Removing uberprompt and restoring original"; + restore_prompt_items(); +} + sub init { Irssi::statusbar_item_register('uberprompt', 0, 'uberprompt_draw'); - Irssi::settings_add_str('uberprompt', 'uberprompt_format', '[$*] '); + Irssi::settings_add_str('uberprompt', 'uberprompt_format', '[$*$uber] '); Irssi::settings_add_bool('uberprompt', 'uberprompt_debug', 0); + Irssi::settings_add_bool('uberprompt', 'uberprompt_autostart', 1); Irssi::command_bind("prompt", \&prompt_subcmd_handler); Irssi::command_bind('prompt on', \&replace_prompt_items); Irssi::command_bind('prompt off', \&restore_prompt_items); Irssi::command_bind('prompt set', - sub { Irssi::signal_emit 'change prompt', shift; }); + sub { + my $args = shift; + $args =~ s/^\s*(\w+)\s*(.*$)/$2/; + my $mode = 'UP_' . uc($1); + Irssi::signal_emit 'change prompt', $args, $mode; + }); Irssi::command_bind('prompt clear', - sub { Irssi::signal_emit 'change prompt', '$p'; }); + sub { + Irssi::signal_emit 'change prompt', '$p', 'UP_POST'; + }); Irssi::signal_add('setup changed', \&reload_settings); # intialise the prompt format. reload_settings(); - # install our statusbars. - replace_prompt_items(); + # make sure we redraw when necessary. + Irssi::signal_add('window changed', \&uberprompt_refresh); + Irssi::signal_add('window name changed', \&uberprompt_refresh); + Irssi::signal_add('window changed automatic', \&uberprompt_refresh); + Irssi::signal_add('window item changed', \&uberprompt_refresh); + + # install our statusbars if required. + if (Irssi::settings_get_bool('uberprompt_autostart')) { + replace_prompt_items(); + } + + # API signals - # the actual API signal. - Irssi::signal_register({'change prompt' => [qw/string/]}); - Irssi::signal_add('change prompt' => \&change_prompt_sig); + Irssi::signal_register({'change prompt' => [qw/string string/]}); + Irssi::signal_add('change prompt' => \&change_prompt_handler); # other scripts (specifically overlay/visual) can subscribe to # this event to be notified when the prompt changes. # arguments are new contents (string), new length (int) Irssi::signal_register({'prompt changed' => [qw/string int/]}); + if (DEBUG) { Irssi::signal_add 'prompt changed', \&debug_prompt_changed; } } +sub reload_settings { + + $DEBUG_ENABLED = Irssi::settings_get_bool('uberprompt_debug'); + + my $new = Irssi::settings_get_str('uberprompt_format'); + if ($prompt_format ne $new) { + print "Updated prompt format" if DEBUG; + $prompt_format = $new; + $prompt_format =~ s/\$uber/\$\$uber/; + Irssi::abstracts_register(['uberprompt', $prompt_format]); + } +} + sub debug_prompt_changed { my ($text, $len) = @_; - my $exp = Irssi::current_theme()->format_expand($text, 0); - my $ps = Irssi::parse_special($exp); - print "DEBUG: Got $text = $exp = $ps, length: $len"; + + $text =~ s/%/%%/g; + + print "DEBUG: Got $text, length: $len"; } -sub change_prompt_sig { - my ($text) = @_; +sub change_prompt_handler { + my ($text, $pos) = @_; - # TODO: mroe intelligence about where to insert $p? - $text = '$p' . $text; - print "Got prompt change sig with: $text" if DEBUG; + print "Got prompt change signal with: $text, $pos" if DEBUG; - my $changed; - $changed = defined $prompt_data ? $prompt_data ne $text : 1; + my ($changed_text, $changed_pos); + $changed_text = defined $prompt_data ? $prompt_data ne $text : 1; + $changed_pos = defined $prompt_data_pos ? $prompt_data_pos ne $pos : 1; - $prompt_data = $text; + $prompt_data = $text; + $prompt_data_pos = $pos; - if ($changed) { + if ($changed_text || $changed_pos) { print "Redrawing prompt" if DEBUG; uberprompt_refresh(); } } -sub UNLOAD { - # remove uberprompt and return the original ones. - print "Removing uberprompt and restoring original"; - restore_prompt_items(); -} - -sub reload_settings { - - $DEBUG_ENABLED = Irssi::settings_get_bool('uberprompt_debug'); - - my $new = Irssi::settings_get_str('uberprompt_format'); - if ($prompt_format ne $new) { - print "Updated prompt format" if DEBUG; - $prompt_format = $new; - Irssi::abstracts_register(['uberprompt', $prompt_format]); - } +sub _escape_prompt_special { + my $str = shift; + $str =~ s/\$/\$\$/g; + $str =~ s/\\/\\\\/g; + return $str; } sub uberprompt_draw { my ($sb_item, $get_size_only) = @_; - my $default_prompt = ''; - my $window = Irssi::active_win; + my $prompt_arg = ''; - #print Dumper($sb_item); - - # hack to produce the same defaults as prompt/prompt_empty sbars. + # default prompt sbar arguments (from config) if (scalar( () = $window->items )) { - $default_prompt = '{uberprompt $[.15]itemname}'; + $prompt_arg = '$[.15]{itemname}'; } else { - $default_prompt = '{uberprompt $winname}'; + $prompt_arg = '${winname}'; } - my $p_copy = $prompt_data; + my $prompt = ''; # rendered content of the prompt. + my $theme = Irssi::current_theme; + + $prompt = $theme->format_expand("{uberprompt $prompt_arg}"); - if (defined $prompt_data) { - # replace the special marker '$p' with the original prompt. - $p_copy =~ s/\$/\$\$/g; # escape all $ symbols - $p_copy =~ s/\\/\\\\/g; # escape backslashes. + if ($prompt_data_pos eq 'UP_ONLY') { + $prompt =~ s/\$\$uber//; # no need for recursive prompting, I hope. - $p_copy =~ s/\$\$p/$default_prompt/; + # TODO: only compute this if necessary? + my $prompt_nt = $prompt; + $prompt_nt =~ s/\s+$//; + + my $pdata_copy = $prompt_data; + + $pdata_copy =~ s/\$prompt_nt/$prompt_nt/; + $pdata_copy =~ s/\$prompt/$prompt/; + + $prompt = $pdata_copy; + + } elsif ($prompt_data_pos eq 'UP_INNER' && defined $prompt_data) { + my $esc = _escape_prompt_special($prompt_data); + $prompt =~ s/\$\$uber/$esc/; } else { - $p_copy = $default_prompt; + # remove the $uber marker + $prompt =~ s/\$\$uber//; + + # and add the additional text at the appropriate position. + if ($prompt_data_pos eq 'UP_PRE') { + $prompt = $prompt_data . $prompt; + } elsif ($prompt_data_pos eq 'UP_POST') { + $prompt .= $prompt_data; + } } - print "Redrawing with: $p_copy, size-only: $get_size_only" if DEBUG; + print "Redrawing with: $prompt, size-only: $get_size_only" if DEBUG; - my $ret = $sb_item->default_handler($get_size_only, $p_copy, '', 0); - # TODO: do this properly, and also make sure it's only emitted once per - # change. - Irssi::signal_emit('prompt changed', $p_copy, $sb_item->{size}); + if ($prompt ne $prompt_last) { + + # print "Emitting prompt changed signal" if DEBUG; + # my $exp = Irssi::current_theme()->format_expand($text, 0); + my $ps = Irssi::parse_special($prompt); + + Irssi::signal_emit('prompt changed', $ps, length($ps)); + $prompt_last = $prompt; + } + my $ret = $sb_item->default_handler($get_size_only, $prompt, '', 0); return $ret; } @@ -281,6 +358,3 @@ sub _sbar_command { Irssi::command($command); } -# bit of fakery so things don't complain about the lack of prompt_info (hoepfully) - -%Irssi::Script::prompt_info:: = (); |