api: add support of environment variables in function string_eval_expression() and command /eval (issue #388)

1 files changed, 40 insertions, 38 deletions

diff --git a/doc/ja/autogen/user/weechat_commands.asciidoc b/doc/ja/autogen/user/weechat_commands.asciidoc
index 25783327f..876c529a0 100644
--- a/doc/ja/autogen/user/weechat_commands.asciidoc
+++ b/doc/ja/autogen/user/weechat_commands.asciidoc
@@ -251,47 +251,49 @@ infolists: infolist に関する情報を表示
 /eval  [-n|-s] <expression>
        [-n] -c <expression1> <operator> <expression2>
 
-        -n: 結果をバッファに送信せずに表示 (デバッグモード)
-        -s: 評価前に式を分割する (複数のコマンドを指定する場合はセミコロンで区切ってください)
-        -c: 条件として評価: 演算子と括弧をを使い、ブール値 ("0" または "1") を返します
-expression: 評価する式、フォーマット、${variable} 型のフォーマットの変数は置換されます (以下を参照); 複数のコマンドを指定する場合はセミコロンで区切ってください
-  operator: 論理演算子や比較演算子:
-            - 論理演算子:
-                &&  ブール演算の "and"
-                ||  ブール演算の "or"
-            - 比較演算子:
-                ==  等しい
-                !=  等しくない
-                <=  以下
-                <   より少ない
-                >=  以上
-                >   より大きい
-                =~  正規表現にマッチ
-                !~  正規表現にマッチしない
-
-式が NULL でない場合、空でない場合、"0" でない場合、式は "真" と評価されます。
-両方の式が有効な整数である場合、比較は整数を使って行われます。
-文字列比較を強制するには、それぞれの式をダブルクォートで囲みます、例:
+        -n: display result without sending it to buffer (debug mode)
+        -s: split expression before evaluating it (many commands can be separated by semicolons)
+        -c: evaluate as condition: use operators and parentheses, return a boolean value ("0" or "1")
+expression: expression to evaluate, variables with format ${variable} are replaced (see below); many commands can be separated by semicolons
+  operator: a logical or comparison operator:
+            - logical operators:
+                &&  boolean "and"
+                ||  boolean "or"
+            - comparison operators:
+                ==  equal
+                !=  not equal
+                <=  less or equal
+                <   less
+                >=  greater or equal
+                >   greater
+                =~  is matching POSIX extended regex
+                !~  is NOT matching POSIX extended regex
+
+An expression is considered as "true" if it is not NULL, not empty, and different from "0".
+The comparison is made using integers if the two expressions are valid integers.
+To force a string comparison, add double quotes around each expression, for example:
   50 > 100      ==> 0
   "50" > "100"  ==> 1
 
-式中の ${variable} 型のフォーマットの変数は置換されます。変数は以下の優先順位に従います:
-  1. エスケープ文字を含む文字列 (フォーマット: "esc:xxx" または "\xxx")
-  2. 隠す文字を含む文字列 (フォーマット: "hide:char,string")
-  3. 色 (フォーマット: "color:xxx")
-  4. 情報 (フォーマット: "info:name,arguments"、arguments は任意)
-  5. オプション (フォーマット: "file.section.option")
-  6. バッファのローカル変数
-  7. hdata の名前/変数 (値は自動的に文字列に変換されます)、デフォルトでは "window" と "buffer" は現在のウィンドウ/バッファを指します。
-hdata のフォーマットは以下の 1 つです:
-  hdata.var1.var2...: hdata (ポインタは既知) で始まり、1 個ずつ変数を続ける (他の hdata を続けることも可能)
-  hdata(list).var1.var2...: リストを使って hdata を始める、例:
-    ${buffer[gui_buffers].full_name}: バッファリストにリンクされた最初のバッファのフルネーム
-    ${plugin[weechat_plugins].name}: プラグインリストにリンクされた最初のプラグインの名前
-hdata と変数の名前については、"プラグイン API リファレンス" の "weechat_hdata_get" 関数を参照してください。
-
-例 (単純な文字列):
+Some variables are replaced in expression, using the format ${variable}, variable can be, by order of priority:
+  1. a string with escaped chars (format: "esc:xxx" or "\xxx")
+  2. a string with chars to hide (format: "hide:char,string")
+  3. a color (format: "color:xxx")
+  4. an info (format: "info:name,arguments", arguments are optional)
+  5. an environment variable (format: "env:XXX")
+  6. an option (format: "file.section.option")
+  7. a local variable in buffer
+  8. a hdata name/variable (the value is automatically converted to string), by default "window" and "buffer" point to current window/buffer.
+Format for hdata can be one of following:
+  hdata.var1.var2...: start with a hdata (pointer must be known), and ask variables one after one (other hdata can be followed)
+  hdata[list].var1.var2...: start with a hdata using a list, for example:
+    ${buffer[gui_buffers].full_name}: full name of first buffer in linked list of buffers
+    ${plugin[weechat_plugins].name}: name of first plugin in linked list of plugins
+For name of hdata and variables, please look at "Plugin API reference", function "weechat_hdata_get".
+
+Examples (simple strings):
   /eval -n ${info:version}                     ==> 0.4.3
+  /eval -n ${env:HOME}                         ==> /home/user
   /eval -n ${weechat.look.scroll_amount}       ==> 3
   /eval -n ${window}                           ==> 0x2549aa0
   /eval -n ${window.buffer}                    ==> 0x2549320
@@ -300,7 +302,7 @@ hdata と変数の名前については、"プラグイン API リファレン�
   /eval -n ${\t}                               ==> <tab>
   /eval -n ${hide:-,${relay.network.password}} ==> --------
 
-例 (条件):
+Examples (conditions):
   /eval -n -c ${window.buffer.number} > 2 ==> 0
   /eval -n -c ${window.win_width} > 100   ==> 1
   /eval -n -c (8 > 12) || (5 > 2)         ==> 1