buflist: add pointer "window" in bar item evaluation

6 files changed, 108 insertions, 90 deletions

diff --git a/doc/de/autogen/user/buflist_commands.adoc b/doc/de/autogen/user/buflist_commands.adoc
index 0d19c1b88..0d6bd2919 100644
--- a/doc/de/autogen/user/buflist_commands.adoc
+++ b/doc/de/autogen/user/buflist_commands.adoc
@@ -9,42 +9,45 @@
 /buflist  bar
           refresh
 
-    bar: fügt eine "buflist" Bar hinzu
-refresh: erzwingt eine Aktualisierung der Bar-Item (buflist, buflist2 und buflist3)
+    bar: add the "buflist" bar
+refresh: force the refresh of the bar items (buflist, buflist2 and buflist3)
 
-Jede Zeile die einen Buffer anzeigt wird mittels Zeichenketten-Evaluation dargestellt (siehe /help eval für das Format), dazu werden folgende Optionen genutzt:
-  - buflist.look.display_conditions: Bedingungen um einen Buffer in der Liste darzustellen
-  - buflist.format.buffer: Format für den Buffer, der nicht der aktuell dargestellte Buffer ist
-  - buflist.format.buffer_current: Format für den aktuell dargestellten Buffer
+The lines with buffers are displayed using string evaluation (see /help eval for the format), with these options:
+  - buflist.look.display_conditions: conditions to display a buffer in the list
+  - buflist.format.buffer: format for a buffer which is not current buffer
+  - buflist.format.buffer_current: format for the current buffer
 
-Die folgenden Variablen können in den obigen Optionen genutzt werden:
-  - bar item data (siehe hdata "bar_item" in API Dokumentation für eine vollständige Liste), zum Beispiel:
+The following variables can be used in these options:
+  - bar item data (see hdata "bar_item" in API doc for a complete list), for example:
     - ${bar_item.name}
-  - buffer data (siehe hdata "buffer" in API Dokumentation für eine vollständige Liste), zum Beispiel:
+  - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example:
+    - ${window.number}
+    - ${window.buffer.full_name}
+  - buffer data (see hdata "buffer" in API doc for a complete list), for example:
     - ${buffer.number}
     - ${buffer.name}
     - ${buffer.full_name}
     - ${buffer.short_name}
     - ${buffer.nicklist_nicks_count}
-  - irc_server: IRC Serverdaten, ausschließlich genutzt bei einem IRC Buffer (siehe hdata "irc_server" in API Dokumentation)
-  - irc_channel: IRC Channeldaten, ausschließlich genutzt bei einem IRC Channel Buffer (siehe hdata "irc_channel" in API Dokumentation)
-  - zusätzliche Variablen die durch buflist bereitgestellt werden:
-    - ${format_buffer}: der evaluierte Wert der Option buflist.format.buffer; dies kann in der Option buflist.format.buffer_current genutzt werden um zum Beispiel die Hintergrundfarbe zu verändern
-    - ${current_buffer}: ein Boolean ("0" oder "1"), "1" falls es sich um den aktuellen Buffer handelt; dies kann in einer Bedingung verwendet werden: ${if:${current_buffer}?...:...}
-    - ${merged}: ein Boolean ("0" oder "1"), "1" wenn der Buffer mit einem anderen zusammengefügt ist; kann innerhalb einer Bedingung genutzt werden: ${if:${merged}?...:...}
-    - ${format_number}: eingerückte Nummer mit Trennzeichen (evaluiert aus Option buflist.format.number)
-    - ${number}: eingerückte Nummer, zum Beispiel " 1", falls die Anzahl der Buffer zwischen 10 und 99 liegt; bei zusammengefügten Buffern enthält die Variable für den ersten Buffer die entsprechende Nummer, die weiteren Buffer enthalten ein Leerzeichen anstelle der Nummer
-    - ${number2}: eingerückte Nummer, zum Beispiel " 1", falls die Anzahl der Buffer zwischen 10 und 99 liegt
-    - ${number_displayed}: "1" falls Nummer angezeigt wird, ansonsten "0"
-    - ${indent}: Einrückung für Name (Channel und private Buffer werden eingerückt) (evaluiert aus Option buflist.format.indent)
-    - ${format_nick_prefix}: Nick-Präfix mit entsprechender Farbe für einen Channel (evaluiert aus Option buflist.format.nick_prefix)
-    - ${color_nick_prefix}: Farbe für den Nick-Präfix von einem Channel (wird nur genutzt wenn die Option buflist.look.nick_prefix aktiviert ist)
-    - ${nick_prefix}: der Nick-Präfix für einen Channel (wird nur genutzt falls die Option buflist.look.nick_prefix aktiviert ist)
-    - ${format_name}: der formatierte Name (evaluiert aus Option buflist.format.name)
-    - ${name}: der Kurzname (falls einer gesetzt ist), ersatzweise wird auf den Originalnamen zurückgegriffen
-    - ${color_hotlist}: die Farbe mit der höchsten Priorität für den entsprechenden Buffer (evaluiert aus Option buflist.format.hotlist_xxx wobei xxx der entsprechende Level ist)
-    - ${format_hotlist}: die formatierte Hotlist (evaluiert aus Option buflist.format.hotlist)
-    - ${hotlist}: die Hotlist in der Rohform
-    - ${hotlist_priority}: "none", "low", "message", "private" oder "highlight"
-    - ${format_lag}: die Verzögerung für einen IRC Server-Buffer, ist leer falls es keine Verzögerung gibt (evaluiert aus Option buflist.format.lag)
+  - irc_server: IRC server data, defined only on an IRC buffer (see hdata "irc_server" in API doc)
+  - irc_channel: IRC channel data, defined only on an IRC channel buffer (see hdata "irc_channel" in API doc)
+  - extra variables added by buflist for convenience:
+    - ${format_buffer}: the evaluated value of option buflist.format.buffer; this can be used in option buflist.format.buffer_current to just change the background color for example
+    - ${current_buffer}: a boolean ("0" or "1"), "1" if this is the current buffer; it can be used in a condition: ${if:${current_buffer}?...:...}
+    - ${merged}: a boolean ("0" or "1"), "1" if the buffer is merged with at least another buffer; it can be used in a condition: ${if:${merged}?...:...}
+    - ${format_number}: indented number with separator (evaluation of option buflist.format.number)
+    - ${number}: indented number, for example " 1" if there are between 10 and 99 buffers; for merged buffers, this variable is set with number for the first buffer and spaces for the next buffers with same number
+    - ${number2}: indented number, for example " 1" if there are between 10 and 99 buffers
+    - ${number_displayed}: "1" if the number is displayed, otherwise "0"
+    - ${indent}: indentation for name (channel and private buffers are indented) (evaluation of option buflist.format.indent)
+    - ${format_nick_prefix}: colored nick prefix for a channel (evaluation of option buflist.format.nick_prefix)
+    - ${color_nick_prefix}: color of nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${nick_prefix}: nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${format_name}: formatted name (evaluation of option buflist.format.name)
+    - ${name}: the short name (if set), with a fallback on the name
+    - ${color_hotlist}: the color depending on the highest hotlist level for the buffer (evaluation of option buflist.format.hotlist_xxx where xxx is the level)
+    - ${format_hotlist}: the formatted hotlist (evaluation of option buflist.format.hotlist)
+    - ${hotlist}: the raw hotlist
+    - ${hotlist_priority}: "none", "low", "message", "private" or "highlight"
+    - ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag)
 ----
diff --git a/doc/en/autogen/user/buflist_commands.adoc b/doc/en/autogen/user/buflist_commands.adoc
index effe55abe..e8a0dc86c 100644
--- a/doc/en/autogen/user/buflist_commands.adoc
+++ b/doc/en/autogen/user/buflist_commands.adoc
@@ -20,6 +20,9 @@ The lines with buffers are displayed using string evaluation (see /help eval for
 The following variables can be used in these options:
   - bar item data (see hdata "bar_item" in API doc for a complete list), for example:
     - ${bar_item.name}
+  - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example:
+    - ${window.number}
+    - ${window.buffer.full_name}
   - buffer data (see hdata "buffer" in API doc for a complete list), for example:
     - ${buffer.number}
     - ${buffer.name}
diff --git a/doc/fr/autogen/user/buflist_commands.adoc b/doc/fr/autogen/user/buflist_commands.adoc
index 3821fad45..30e6e5922 100644
--- a/doc/fr/autogen/user/buflist_commands.adoc
+++ b/doc/fr/autogen/user/buflist_commands.adoc
@@ -20,6 +20,9 @@ Les lignes avec les tampons sont affichées en utilisant l'évaluation de chaîn
 Les variables suivantes peuvent être utilisées dans ces options :
   - données de l'objet de barre (voir le hdata "bar_item" dans la doc API pour une liste complète), par exemple :
     - ${bar_item.name}
+  - données de la fenêtre ("window"), où l'objet de barre est affiché (il n'y a pas de fenêtre pour les barres de type "root", voir le hdata "window" dans la doc API pour une liste complète), par exemple :
+    - ${window.number}
+    - ${window.buffer.full_name}
   - données du tampon (voir le hdata "buffer" dans la doc API pour une liste complète), par exemple :
     - ${buffer.number}
     - ${buffer.name}
diff --git a/doc/it/autogen/user/buflist_commands.adoc b/doc/it/autogen/user/buflist_commands.adoc
index effe55abe..e8a0dc86c 100644
--- a/doc/it/autogen/user/buflist_commands.adoc
+++ b/doc/it/autogen/user/buflist_commands.adoc
@@ -20,6 +20,9 @@ The lines with buffers are displayed using string evaluation (see /help eval for
 The following variables can be used in these options:
   - bar item data (see hdata "bar_item" in API doc for a complete list), for example:
     - ${bar_item.name}
+  - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example:
+    - ${window.number}
+    - ${window.buffer.full_name}
   - buffer data (see hdata "buffer" in API doc for a complete list), for example:
     - ${buffer.number}
     - ${buffer.name}
diff --git a/doc/ja/autogen/user/buflist_commands.adoc b/doc/ja/autogen/user/buflist_commands.adoc
index 4c36b7dee..69a1d530a 100644
--- a/doc/ja/autogen/user/buflist_commands.adoc
+++ b/doc/ja/autogen/user/buflist_commands.adoc
@@ -9,42 +9,45 @@
 /buflist  bar
           refresh
 
-    bar: "buflist" バーを追加します
-refresh: 強制的にバー要素 (buflist、buflist2、buflist3) の内容を最新の状態に更新します
+    bar: add the "buflist" bar
+refresh: force the refresh of the bar items (buflist, buflist2 and buflist3)
 
-各バッファエントリは文字列評価 (書式は /help eval を参照してください) を使って表示されます、以下のオプションで指定します:
-  - buflist.look.display_conditions: バッファをリスト内に表示する条件
-  - buflist.format.buffer: 現在のバッファ以外のバッファを表示する書式
-  - buflist.format.buffer_current: 現在のバッファを表示する書式
+The lines with buffers are displayed using string evaluation (see /help eval for the format), with these options:
+  - buflist.look.display_conditions: conditions to display a buffer in the list
+  - buflist.format.buffer: format for a buffer which is not current buffer
+  - buflist.format.buffer_current: format for the current buffer
 
-以下は上記オプションで使用可能な変数です:
-  - バー要素データ (完全なリストは API リファレンスの hdata "bar_item" を参照してください)、例:
+The following variables can be used in these options:
+  - bar item data (see hdata "bar_item" in API doc for a complete list), for example:
     - ${bar_item.name}
-  - バッファデータ (完全なリストは API リファレンスの hdata "buffer" を参照してください)、例:
+  - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example:
+    - ${window.number}
+    - ${window.buffer.full_name}
+  - buffer data (see hdata "buffer" in API doc for a complete list), for example:
     - ${buffer.number}
     - ${buffer.name}
     - ${buffer.full_name}
     - ${buffer.short_name}
     - ${buffer.nicklist_nicks_count}
-  - irc_server: IRC サーバデータ、IRC バッファのみで定義 (API リファレンスの hdata "irc_server" を参照してください)
-  - irc_channel: IRC チャンネルデータ、IRC チャンネルバッファのみで定義 (API リファレンスの hdata "irc_channel" を参照してください)
-  - buflist プラグインが利便性向上の目的で追加した変数:
-    - ${format_buffer}: buflist.format.buffer オプションの評価結果; 例えば単に背景色を変えるなどの目的で、この変数を buflist.format.buffer_current オプションの中で使うことも可能です。
-    - ${current_buffer}: ブール値 ("0" または "1")、対象のバッファが現在のバッファの場合に "1"; 次のように条件中で使うことができます: ${if:${current_buffer}?...:...}
-    - ${merged}: ブール値 ("0" または "1")、対象のバッファが他のバッファとマージされていた場合に "1"; 次のように条件中で使うことができます: ${if:${merged}?...:...}
-    - ${format_number}: 区切り文字を付けたインデント済み番号 (buflist.format.number オプションの評価結果)
-    - ${number}: インデント済み番号、例えば 10 から 99 番のバッファがある場合に " 1"; マージされたバッファの場合、この値は空白で区切られたバッファ番号になります
-    - ${number2}: インデント済み番号、例えば 10 から 99 番のバッファがある場合に " 1"
-    - ${number_displayed}: 番号が表示される場合に "1"、それ以外の場合に "0"
-    - ${indent}: 名前用のインデント (チャンネルとプライベートバッファがインデントされます)
-    - ${format_nick_prefix}: チャンネルにおける色付きニックネームプレフィックス (buflist.format.nick_prefix オプションの評価結果)
-    - ${color_nick_prefix}: チャンネルにおけるニックネームプレフィックスの色 (buflist.look.nick_prefix オプションが有効化された場合のみ設定されます)
-    - ${nick_prefix}: チャンネルにおけるニックネームプレフィックス (buflist.look.nick_prefix オプションが有効化された場合のみ設定されます)
-    - ${format_name}: 書式化済みのニックネーム (buflist.format.name オプションを評価した後の値)
-    - ${name}: 短縮名 (設定済みの場合)、未設定の場合には名前
-    - ${color_hotlist}: 対象バッファのホットリストレベルの最大値に対応する色 (buflist.format.hotlist_xxx オプションの評価結果、xxx がレベル)
-    - ${format_hotlist}: 評価後のホットリスト (buflist.format.hotlist オプションの評価結果)
-    - ${hotlist}: 評価前のホットリスト
-    - ${hotlist_priority}: "none"、"low"、"message"、"private"、"highlight"
-    - ${format_lag}: IRC サーババッファの遅延時間、遅延がない場合は空 (buflist.format.lag オプションの評価結果)
+  - irc_server: IRC server data, defined only on an IRC buffer (see hdata "irc_server" in API doc)
+  - irc_channel: IRC channel data, defined only on an IRC channel buffer (see hdata "irc_channel" in API doc)
+  - extra variables added by buflist for convenience:
+    - ${format_buffer}: the evaluated value of option buflist.format.buffer; this can be used in option buflist.format.buffer_current to just change the background color for example
+    - ${current_buffer}: a boolean ("0" or "1"), "1" if this is the current buffer; it can be used in a condition: ${if:${current_buffer}?...:...}
+    - ${merged}: a boolean ("0" or "1"), "1" if the buffer is merged with at least another buffer; it can be used in a condition: ${if:${merged}?...:...}
+    - ${format_number}: indented number with separator (evaluation of option buflist.format.number)
+    - ${number}: indented number, for example " 1" if there are between 10 and 99 buffers; for merged buffers, this variable is set with number for the first buffer and spaces for the next buffers with same number
+    - ${number2}: indented number, for example " 1" if there are between 10 and 99 buffers
+    - ${number_displayed}: "1" if the number is displayed, otherwise "0"
+    - ${indent}: indentation for name (channel and private buffers are indented) (evaluation of option buflist.format.indent)
+    - ${format_nick_prefix}: colored nick prefix for a channel (evaluation of option buflist.format.nick_prefix)
+    - ${color_nick_prefix}: color of nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${nick_prefix}: nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${format_name}: formatted name (evaluation of option buflist.format.name)
+    - ${name}: the short name (if set), with a fallback on the name
+    - ${color_hotlist}: the color depending on the highest hotlist level for the buffer (evaluation of option buflist.format.hotlist_xxx where xxx is the level)
+    - ${format_hotlist}: the formatted hotlist (evaluation of option buflist.format.hotlist)
+    - ${hotlist}: the raw hotlist
+    - ${hotlist_priority}: "none", "low", "message", "private" or "highlight"
+    - ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag)
 ----
diff --git a/doc/pl/autogen/user/buflist_commands.adoc b/doc/pl/autogen/user/buflist_commands.adoc
index 84d2324d7..2b2bf81a0 100644
--- a/doc/pl/autogen/user/buflist_commands.adoc
+++ b/doc/pl/autogen/user/buflist_commands.adoc
@@ -9,42 +9,45 @@
 /buflist  bar
           refresh
 
-    bar: dodaje pasek "buflist"
-refresh: wymusza odświeżenie elementów paska (buflist, buflist2 oraz buflist3)
+    bar: add the "buflist" bar
+refresh: force the refresh of the bar items (buflist, buflist2 and buflist3)
 
-Linie z buforami są wyświetlane za pomocą przetwarzania ciągów (zobacz /help eval żeby poznać format), za pomocą tych opcji:
-  - buflist.look.display_conditions: warunki wyświetlenia buforu na liście
-  - buflist.format.buffer: format dla buforu nie będącego obecnym buforem
-  - buflist.format.buffer_current: format format dla obecnego buforu
+The lines with buffers are displayed using string evaluation (see /help eval for the format), with these options:
+  - buflist.look.display_conditions: conditions to display a buffer in the list
+  - buflist.format.buffer: format for a buffer which is not current buffer
+  - buflist.format.buffer_current: format for the current buffer
 
-Następujące zmienne mogą być użyte w powyższych opcjach:
-  - dane elementu paska (pełną listę można znaleźć w dokumentacji API dla hdata "bar_item"), na przykład:
+The following variables can be used in these options:
+  - bar item data (see hdata "bar_item" in API doc for a complete list), for example:
     - ${bar_item.name}
-  - dane buforu (zobacz hdata "buffer" w dokumentacji API dla pełnej listy zmiennych), na przykład:
+  - window data, where the bar item is displayed (there's no window in root bars, see hdata "window" in API doc for a complete list), for example:
+    - ${window.number}
+    - ${window.buffer.full_name}
+  - buffer data (see hdata "buffer" in API doc for a complete list), for example:
     - ${buffer.number}
     - ${buffer.name}
     - ${buffer.full_name}
     - ${buffer.short_name}
     - ${buffer.nicklist_nicks_count}
-  - irc_server: dane serwera IRC, zdefiniowane tylko w buforze IRC (zobacz hdata "irc_server" w dokumentacji API)
-  - irc_channel: dane kanału IRC, zdefiniowane tylko w buforze kanału IRC (zobacz hdata "irc_channel" w dokumentacji API)
-  - dodatkowe zmienne dodane dla wygody przez listę buforów:
-    - ${format_buffer}: przetworzona wartość opcji buflist.format.buffer; może to zostać użyte w opcji buflist.format.buffer_current na przykład do zmiany koloru tła
-    - ${current_buffer}: boolowskie ("0" lub "1"), "1" jeśli jest to obecny bufor; może zostać użyte w warunku: ${if: ${current_buffer}?...:...}
-    - ${merged}: boolowskie ("0" lub "1"), "1" jeśli bufor jest połączony z przynajmniej jednym innym buforem; może zostać użyte w warunku: ${if:${merged}?...:...}
-    - ${format_number}: wyrównany numer z separatorem (przetworzona opcja buflist.format.number)
-    - ${number}: wyrównany numer, na przykład " 1" jeśli buforów jest między 10 a 99
-    - ${number2}: wyrównany numer, na przykład " 1" jeśli buforów jest między 10 a 99
-    - ${number_displayed}: "1" jeśli numer jest wyświetlany, w przeciwnym wypadku "0"
-    - ${indent}: wyrównanie dla nazwy (kanały i bufory prywatne są wyrównywane) (przetworzona opcja buflist.format.indent)
-    - ${format_nick_prefix}: kolorowy prefiks nicka dla kanału (przetworzona opcja buflist.format.nick_prefix)
-    - ${color_nick_prefix}: kolor prefiksu nicka dla kanału (ustawiany, jeśli opcja buflist.look.nick_prefix jest włączona)
-    - ${nick_prefix}: prefix nicka dla kanału (ustawiany, jeśli opcja buflist.look.nick_prefix jest włączona)
-    - ${format_name}: sformatowana nazwa (przetworzona opcja buflist.format.name)
-    - ${name}: skrócona nazwa (jeśli ustawiona inaczej zwraca pełną nazwę)
-    - ${color_hotlist}: kolor zależący od najwyższego poziomu hotlisty dla bufora (przetworzona opcja buflist.format.hotlist_xxx,  gdzie xxx to poziom)
-    - ${format_hotlist}: sformatowana hotlista (przetworzenie opcji buflist.format.hotlist)
-    - ${hotlist}: niesformatowana hotlista
-    - ${hotlist_priority}: "none", "low", "message", "private" lub "highlight"
-    - ${format_lag}: opóźnienie buforu serwera IRC, puste jeśli nie ma opóźnienia (przetworzona opcja buflist.format.lag)
+  - irc_server: IRC server data, defined only on an IRC buffer (see hdata "irc_server" in API doc)
+  - irc_channel: IRC channel data, defined only on an IRC channel buffer (see hdata "irc_channel" in API doc)
+  - extra variables added by buflist for convenience:
+    - ${format_buffer}: the evaluated value of option buflist.format.buffer; this can be used in option buflist.format.buffer_current to just change the background color for example
+    - ${current_buffer}: a boolean ("0" or "1"), "1" if this is the current buffer; it can be used in a condition: ${if:${current_buffer}?...:...}
+    - ${merged}: a boolean ("0" or "1"), "1" if the buffer is merged with at least another buffer; it can be used in a condition: ${if:${merged}?...:...}
+    - ${format_number}: indented number with separator (evaluation of option buflist.format.number)
+    - ${number}: indented number, for example " 1" if there are between 10 and 99 buffers; for merged buffers, this variable is set with number for the first buffer and spaces for the next buffers with same number
+    - ${number2}: indented number, for example " 1" if there are between 10 and 99 buffers
+    - ${number_displayed}: "1" if the number is displayed, otherwise "0"
+    - ${indent}: indentation for name (channel and private buffers are indented) (evaluation of option buflist.format.indent)
+    - ${format_nick_prefix}: colored nick prefix for a channel (evaluation of option buflist.format.nick_prefix)
+    - ${color_nick_prefix}: color of nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${nick_prefix}: nick prefix for a channel (set only if the option buflist.look.nick_prefix is enabled)
+    - ${format_name}: formatted name (evaluation of option buflist.format.name)
+    - ${name}: the short name (if set), with a fallback on the name
+    - ${color_hotlist}: the color depending on the highest hotlist level for the buffer (evaluation of option buflist.format.hotlist_xxx where xxx is the level)
+    - ${format_hotlist}: the formatted hotlist (evaluation of option buflist.format.hotlist)
+    - ${hotlist}: the raw hotlist
+    - ${hotlist_priority}: "none", "low", "message", "private" or "highlight"
+    - ${format_lag}: the lag for an IRC server buffer, empty if there's no lag (evaluation of option buflist.format.lag)
 ----