Add support of many templates for completion of command arguments, rename default completion items

5 files changed, 256 insertions, 102 deletions

diff --git a/doc/en/Makefile.am b/doc/en/Makefile.am
index 030d8e9c5..641fcdc6f 100644
--- a/doc/en/Makefile.am
+++ b/doc/en/Makefile.am
@@ -23,6 +23,7 @@ BOOK_AUTOGEN_INCLUDE = ../include_autogen.xml       \
                        autogen/aspell_options.xml   \
                        autogen/charset_commands.xml \
                        autogen/charset_options.xml  \
+                       autogen/completions.xml      \
                        autogen/demo_commands.xml    \
                        autogen/fifo_infos.xml       \
                        autogen/irc_commands.xml     \
diff --git a/doc/en/autogen/completions.xml b/doc/en/autogen/completions.xml
new file mode 100644
index 000000000..946666323
--- /dev/null
+++ b/doc/en/autogen/completions.xml
@@ -0,0 +1,203 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+     ********* WARNING! *********
+
+     This file is autogenerated with docgen.pl script. *** DO NOT EDIT! ***
+     docgen.pl builds XML doc files to include in many languages
+-->
+
+<row>
+  <entry>alias</entry>
+  <entry>alias</entry>
+  <entry>list of alias</entry>
+</row>
+<row>
+  <entry>aspell</entry>
+  <entry>aspell_langs</entry>
+  <entry>list of supported langs for aspell</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_channel</entry>
+  <entry>current IRC channel</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_channel_nicks_hosts</entry>
+  <entry>nicks and hostnames of current IRC channel</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_channel_topic</entry>
+  <entry>topic of current IRC channel</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_channels</entry>
+  <entry>IRC channels (on all servers)</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_ignores_numbers</entry>
+  <entry>numbers for defined ignores</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_msg_part</entry>
+  <entry>default part message for IRC channel</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_server</entry>
+  <entry>current IRC server</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_server_nick</entry>
+  <entry>nick on current IRC server</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_server_nicks</entry>
+  <entry>nicks on all channels of current IRC server</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>irc_servers</entry>
+  <entry>IRC servers (internal names)</entry>
+</row>
+<row>
+  <entry>irc</entry>
+  <entry>nick</entry>
+  <entry>nicks of current IRC channel</entry>
+</row>
+<row>
+  <entry>lua</entry>
+  <entry>lua_script</entry>
+  <entry>list of scripts</entry>
+</row>
+<row>
+  <entry>perl</entry>
+  <entry>perl_script</entry>
+  <entry>list of scripts</entry>
+</row>
+<row>
+  <entry>python</entry>
+  <entry>python_script</entry>
+  <entry>list of scripts</entry>
+</row>
+<row>
+  <entry>ruby</entry>
+  <entry>ruby_script</entry>
+  <entry>list of scripts</entry>
+</row>
+<row>
+  <entry>tcl</entry>
+  <entry>tcl_script</entry>
+  <entry>list of scripts</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>bars_names</entry>
+  <entry>names of bars</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>bars_options</entry>
+  <entry>options for bars</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>buffers_names</entry>
+  <entry>names of buffers</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>buffers_numbers</entry>
+  <entry>numbers of buffers</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>buffers_plugins_names</entry>
+  <entry>names of buffers (including plugins names)</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>commands</entry>
+  <entry>commands (weechat and plugins)</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>config_files</entry>
+  <entry>configuration files</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>config_option_values</entry>
+  <entry>values for a configuration option</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>config_options</entry>
+  <entry>configuration options</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>filename</entry>
+  <entry>filename</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>filters_names</entry>
+  <entry>names of filters</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>infolists</entry>
+  <entry>names of infolists hooked</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>infos</entry>
+  <entry>names of infos hooked</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>keys_codes</entry>
+  <entry>key codes</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>nicks</entry>
+  <entry>nicks in nicklist of current buffer</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>plugins_commands</entry>
+  <entry>commands defined by plugins</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>plugins_names</entry>
+  <entry>names of plugins</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>proxies_names</entry>
+  <entry>names of proxies</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>proxies_options</entry>
+  <entry>options for proxies</entry>
+</row>
+<row>
+  <entry>weechat</entry>
+  <entry>weechat_commands</entry>
+  <entry>weechat commands</entry>
+</row>
+<row>
+  <entry>xfer</entry>
+  <entry>nick</entry>
+  <entry>nicks of DCC chat</entry>
+</row>
diff --git a/doc/en/autogen/weechat_commands.xml b/doc/en/autogen/weechat_commands.xml
index e9740ea33..fb714edf6 100644
--- a/doc/en/autogen/weechat_commands.xml
+++ b/doc/en/autogen/weechat_commands.xml
@@ -150,14 +150,14 @@ functions for command line
 Cette commande est utilisée par les associations de touches ou les extensions.
 </programlisting>
 
-<command>/key  [key [command [args]]] | [unbind key] | [reset -yes] | [missing]</command>
+<command>/key  [bind key [command [args]]] | [unbind key] | [reset -yes] | [missing]</command>
 <programlisting>
 bind/unbind keys
 
-      key: display or bind this key to a command
-   unbind: unbind a key
-    reset: restore bindings to the default values and delete ALL personal bindings (use carefully!)
-  missing: add missing keys (using default bindings)
+   bind: bind a command to a key or display command bound to key
+ unbind: remove a key binding
+  reset: restore bindings to the default values and delete ALL personal bindings (use carefully!)
+missing: add missing keys (using default bindings)
 </programlisting>
 
 <command>/layout  [[save | apply | reset] [buffers | windows]]</command>
diff --git a/doc/en/autogen/weechat_options.xml b/doc/en/autogen/weechat_options.xml
index 0015063b2..20779ea41 100644
--- a/doc/en/autogen/weechat_options.xml
+++ b/doc/en/autogen/weechat_options.xml
@@ -572,7 +572,7 @@
     <para>type: string</para>
   </listitem>
   <listitem>
-    <para>values: any string (default value: '%n|%(irc_channels)')</para>
+    <para>values: any string (default value: '%(nicks)|%(irc_channels)')</para>
   </listitem>
 </itemizedlist>
 
diff --git a/doc/en/dev/plugin_c_api.en.xml b/doc/en/dev/plugin_c_api.en.xml
index b5f01bff4..f4a50efd7 100644
--- a/doc/en/dev/plugin_c_api.en.xml
+++ b/doc/en/dev/plugin_c_api.en.xml
@@ -1835,7 +1835,7 @@ void weechat_exec_on_files (
               <option>callback</option>: function called for each file
               found, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2489,7 +2489,7 @@ struct t_config_file *weechat_config_new (
               configuration file is reloaded with /reload (optional, may be
               NULL), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2628,7 +2628,7 @@ struct t_config_section *weechat_config_new_section (
               except if options in your section need custom function),
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2680,7 +2680,7 @@ struct t_config_section *weechat_config_new_section (
               is written in file (should be NULL for most cases, except if your
               section needs to be written by a custom function), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2726,7 +2726,7 @@ struct t_config_section *weechat_config_new_section (
               <option>callback_write_default</option>: callback called when
               default values for section must be written in file, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2768,7 +2768,7 @@ struct t_config_section *weechat_config_new_section (
               new option is created in section (NULL if section does not allow
               new options to be created), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -2820,7 +2820,7 @@ struct t_config_section *weechat_config_new_section (
               option is deleted (NULL if section does not allow options to be
               deleted), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -3094,7 +3094,7 @@ struct t_config_option *weechat_config_new_option (
               <option>callback_check_value</option>: callback called to check
               new value for an option (optional), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -3135,7 +3135,7 @@ struct t_config_option *weechat_config_new_option (
               <option>callback_change</option>: callback called when value of
               option has changed (optional), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -3171,7 +3171,7 @@ struct t_config_option *weechat_config_new_option (
               <option>callback_delete</option>: callback called when option
               will be deleted (optional), arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -3726,7 +3726,7 @@ void *weechat_config_option_get_pointer (
             <para>
               <option>property</option>: property name:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Property</entry>
@@ -4655,7 +4655,7 @@ const char *weechat_prefix (const char *prefix);
             <para>
               <option>prefix</option>: name of prefix:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Prefix</entry>
@@ -5036,11 +5036,26 @@ struct t_hook *weechat_hook_command (
               completions are possible for one argument, separated by "|".
               Default completion codes are:
               <informaltable colsep="0" frame="none">
+                <tgroup cols="3">
+                  <thead>
+                    <row>
+                      <entry>Plugin</entry>
+                      <entry>Code</entry>
+                      <entry>Description</entry>
+                    </row>
+                  </thead>
+                  <tbody>
+                    &completions.xml;
+                  </tbody>
+                </tgroup>
+              </informaltable>
+              Special codes:
+              <informaltable colsep="0" frame="none">
                 <tgroup cols="2">
                   <thead>
                     <row>
                       <entry>Code</entry>
-                      <entry>Completion</entry>
+                      <entry>Description</entry>
                     </row>
                   </thead>
                   <tbody>
@@ -5052,71 +5067,6 @@ struct t_hook *weechat_hook_command (
                       <entry>%*</entry>
                       <entry>Repeat last completion</entry>
                     </row>
-                    <row>
-                      <entry>%b</entry>
-                      <entry>Buffers names</entry>
-                    </row>
-                    <row>
-                      <entry>%B</entry>
-                      <entry>Buffers names (with plugin name)</entry>
-                    </row>
-                    <row>
-                      <entry>%c</entry>
-                      <entry>Configuration files</entry>
-                    </row>
-                    <row>
-                      <entry>%f</entry>
-                      <entry>Filename</entry>
-                    </row>
-                    <row>
-                      <entry>%F</entry>
-                      <entry>Filters</entry>
-                    </row>
-                    <row>
-                      <entry>%h</entry>
-                      <entry>Commands hooked</entry>
-                    </row>
-                    <row>
-                      <entry>%i</entry>
-                      <entry>Infos hooked</entry>
-                    </row>
-                    <row>
-                      <entry>%I</entry>
-                      <entry>Infolists hooked</entry>
-                    </row>
-                    <row>
-                      <entry>%n</entry>
-                      <entry>Nick</entry>
-                    </row>
-                    <row>
-                      <entry>%o</entry>
-                      <entry>Configuration option</entry>
-                    </row>
-                    <row>
-                      <entry>%p</entry>
-                      <entry>Plugin name</entry>
-                    </row>
-                    <row>
-                      <entry>%P</entry>
-                      <entry>Plugin commands</entry>
-                    </row>
-                    <row>
-                      <entry>%r</entry>
-                      <entry>Bar names</entry>
-                    </row>
-                    <row>
-                      <entry>%v</entry>
-                      <entry>Value of configuration option</entry>
-                    </row>
-                    <row>
-                      <entry>%w</entry>
-                      <entry>WeeChat commands</entry>
-                    </row>
-                    <row>
-                      <entry>%(xxx)</entry>
-                      <entry>Custom completion by plugin (xxx is a completion
-                      code added by a plugin)</entry>
-                    </row>
                   </tbody>
                 </tgroup>
               </informaltable>
@@ -5127,7 +5077,7 @@ struct t_hook *weechat_hook_command (
               <option>callback</option>: function called when command is used,
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5243,7 +5193,7 @@ struct t_hook *weechat_hook_command_run (
               <option>callback</option>: function called when command is run,
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5350,7 +5300,7 @@ struct t_hook *weechat_hook_timer (
               <option>callback</option>: function called when time is reached,
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5451,7 +5401,7 @@ struct t_hook *weechat_hook_fd (
               <option>callback</option>: function called when a selected event
               occurs, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5545,7 +5495,7 @@ struct t_hook *weechat_hook_process (
               <option>callback</option>: function called when data from child
               is available, or when child has ended, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5683,7 +5633,7 @@ struct t_hook *weechat_hook_connect (
               <option>callback</option>: function called when connection is ok
               or failed, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5857,7 +5807,7 @@ struct t_hook *weechat_hook_print (
               <option>callback</option>: function called when message is
               printed, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -5980,7 +5930,7 @@ struct t_hook *weechat_hook_signal (
               <option>callback</option>: function called when signal is
               received, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6123,7 +6073,7 @@ struct t_hook *weechat_hook_config (
               <option>callback</option>: function called when configuration
               option is changed, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6216,7 +6166,7 @@ struct t_hook *weechat_hook_completion (
               is used (user is completing something using this item),
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6382,7 +6332,7 @@ struct t_hook *weechat_hook_modifier (
               <option>callback</option>: function called when modifier is
               received, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6546,7 +6496,7 @@ struct t_hook *weechat_hook_info (
               <option>callback</option>: function called when info is asked,
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6641,7 +6591,7 @@ struct t_hook *weechat_hook_infolist (
               <option>callback</option>: function called when infolist is asked,
               arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6804,7 +6754,7 @@ struct t_gui_buffer *weechat_buffer_new (
               <option>input_callback</option>: function called when input text
               is entered on buffer, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -6844,7 +6794,7 @@ struct t_gui_buffer *weechat_buffer_new (
               <option>close_callback</option>: function called when buffer is
               closed, arguments:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Type</entry>
@@ -7293,7 +7243,7 @@ void weechat_buffer_set (struct t_gui_buffer *buffer, const char *property,
             <para>
               <option>property</option>: property name:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Name</entry>
@@ -7521,7 +7471,7 @@ void weechat_buffer_set_pointer (struct t_gui_buffer *buffer, const char *proper
             <para>
               <option>property</option>: property name:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Name</entry>
@@ -9004,7 +8954,7 @@ const char *weechat_info_get (const char *info_name,
               core or other plugin (see plugin doc for infos returned by
               each plugin). WeeChat core infos are:
               <informaltable colsep="0" frame="none">
-                <tgroup cols="2">
+                <tgroup cols="3">
                   <thead>
                     <row>
                       <entry>Info</entry>