[openrtm-commit:03026] r3151 - branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/common
openrtm ＠ openrtm.org
openrtm ＠ openrtm.org
2017年 12月 15日 (金) 14:26:38 JST
Author: kawauchi
Date: 2017-12-15 14:26:38 +0900 (Fri, 15 Dec 2017)
New Revision: 3151
Modified:
branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/common/stringutil.h
Log:
[compat,encoding] Encoding has been changed.
Modified: branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/common/stringutil.h
===================================================================
--- branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/common/stringutil.h 2017-12-15 04:40:54 UTC (rev 3150)
+++ branches/RELENG_1_2/OpenRTM-aist/src/lib/coil/common/stringutil.h 2017-12-15 05:26:38 UTC (rev 3151)
@@ -1,4 +1,4 @@
-// -*- C++ -*-
+// -*- C++ -*-
/*!
* @file StringUtil.h
* @brief String operation utility
@@ -46,11 +46,13 @@
typedef std::map<std::string, std::string> mapstring;
/*!
* @if jp
- * @brief string ¤«¤Ewstring ¤Ø¤ÎÊÑ´¹
+ * @brief string から wstring への変換
*
- * Í¿¤¨¤é¤E¿ string ʸ»úÎó¤Ewstring ʸ»úÎó¤ËÊÑ´¹
+ * 与えられた string 文字列を wstring 文字列に変換
*
- * @param str std::string ·¿¤ÎÆþÎÏʸ»úÎE * @return std::wstring ·¿¤Î½ÐÎÏʸ»úÎE *
+ * @param str std::string 型の入力文字列
+ * @return std::wstring 型の出力文字列
+ *
* @else
* @brief string to wstring conversion
*
@@ -65,11 +67,13 @@
/*!
* @if jp
- * @brief wstring ¤«¤Estring ¤Ø¤ÎÊÑ´¹
+ * @brief wstring から string への変換
*
- * Í¿¤¨¤é¤E¿ wstring ʸ»úÎó¤Estring ʸ»úÎó¤ËÊÑ´¹
+ * 与えられた wstring 文字列を string 文字列に変換
*
- * @param str std::wstring ·¿¤ÎÆþÎÏʸ»úÎE * @return std::string ·¿¤Î½ÐÎÏʸ»úÎE *
+ * @param str std::wstring 型の入力文字列
+ * @return std::string 型の出力文字列
+ *
* @else
* @brief wstring to string conversion
*
@@ -84,11 +88,12 @@
/*!
* @if jp
- * @brief Âçʸ»ú¤Ø¤ÎÊÑ´¹
+ * @brief 大文字への変換
*
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤òÂçʸ»ú¤ËÊÑ´¹
+ * 与えられた文字列を大文字に変換
*
- * @param str ÆþÎÏʸ»úÎE *
+ * @param str 入力文字列
+ *
* @else
* @brief Uppercase String Transformation
*
@@ -102,11 +107,12 @@
/*!
* @if jp
- * @brief ¾®Ê¸»ú¤Ø¤ÎÊÑ´¹
+ * @brief 小文字への変換
*
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ò¾®Ê¸»ú¤ËÊÑ´¹
+ * 与えられた文字列を小文字に変換
*
- * @param str ÆþÎÏʸ»úÎE *
+ * @param str 入力文字列
+ *
* @else
* @brief Lowercase String Transformation
*
@@ -120,14 +126,17 @@
/*!
* @if jp
- * @brief ÆþÎÏ¥¹¥È¥ê¡¼¥à¤«¤E¹ÔÆɤ߹þ¤E *
- * ÆþÎÏ¥¹¥È¥ê¡¼¥à¤«¤E¹ÔÆɤ߹þ¤à¡£
- * ÆþÎÏ¥¹¥È¥ê¡¼¥à¤Ï¤Î²þ¹Ô¥³¡¼¥É¤ÏUNIX, Windows¤Î²þ¹Ô¥³¡¼¥É¤Î¤¤¤º¤E«¡¢
- * ¤â¤·¤¯¤Ïº®ºß¤·¤Æ¤¤¤Æ¤â¤è¤¤¡£
+ * @brief 入力ストリームから1行読み込む
*
- * @param istr ÆþÎÏ¥¹¥È¥ê¡¼¥E * @param line Æɤ߹þ¤ó¤Àʸ»úÎó¤ò³ÊǼ¤¹¤EÑ¿E *
- * @return ²þ¹Ôʸ»ú¤ò½E¯Æɤ߹þ¤ó¤Àʸ»úÎó¤ÎŤµ
+ * 入力ストリームから1行読み込む。
+ * 入力ストリームはの改行コードはUNIX, Windowsの改行コードのいずれか、
+ * もしくは混在していてもよい。
*
+ * @param istr 入力ストリーム
+ * @param line 読み込んだ文字列を格納する変数
+ *
+ * @return 改行文字を除く読み込んだ文字列の長さ
+ *
* @else
* @brief Read a line from input stream
*
@@ -145,13 +154,15 @@
/*!
* @if jp
- * @brief ʸ»úÎ󤬥¨¥¹¥±¡¼¥×¤µ¤EƤ¤¤E«È½ÃǤ¹¤E *
- * »ØÄꤵ¤E¿Ê¸»ú¤¬¥¨¥¹¥±¡¼¥×¤µ¤EƤ¤¤E«¤É¤¦¤«¤òȽÃǤ¹¤E£
+ * @brief 文字列がエスケープされているか判断する
*
- * @param str ¥¨¥¹¥±¡¼¥×¤µ¤EƤ¤¤E«¤É¤¦¤«È½ÃǤ¹¤E¸»ú¤ò´Þ¤àʸ»úÎE * @param pos ¥¨¥¹¥±¡¼¥×¤µ¤EƤ¤¤E«¤É¤¦¤«È½ÃǤ¹¤E¸»ú¤Î°ÌÃÖ
+ * 指定された文字がエスケープされているかどうかを判断する。
*
- * @return »ØÄꤷ¤¿Ê¸»ú¤¬¥¨¥¹¥±¡¼¥×¤µ¤EƤ¤¤EÐ true, ¤½¤Eʳ°¤Ï false
+ * @param str エスケープされているかどうか判断する文字を含む文字列
+ * @param pos エスケープされているかどうか判断する文字の位置
*
+ * @return 指定した文字がエスケープされていれば true, それ以外は false
+ *
* @else
* @brief Check whether the character is escaped or not
*
@@ -168,16 +179,19 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤ò¥¨¥¹¥±¡¼¥×¤¹¤E *
- * ¼¡¤Îʸ»ú¤ò¥¨¥¹¥±¡¼¥×¥·¡¼¥±¥ó¥¹¤ËÊÑ´¹¤¹¤E£<br>
+ * @brief 文字列をエスケープする
+ *
+ * 次の文字をエスケープシーケンスに変換する。<br>
* HT -> "\t" <br>
* LF -> "\n" <br>
* CR -> "\r" <br>
* FF -> "\f" <br>
- * ¥·¥ó¥°¥E¯¥ª¡¼¥È¡¢¥À¥Ö¥E¯¥ª¡¼¥È¤Ë¤Ä¤¤¤Æ¤Ï¤È¤¯¤Ë½èÍý¤Ï¤·¤Ê¤¤¡£
+ * シングルクオート、ダブルクオートについてはとくに処理はしない。
*
- * @param str ¥¨¥¹¥±¡¼¥×½èÍýÂоÝʸ»úÎE *
- * @return ¥¨¥¹¥±¡¼¥×½èÍý·EÌʸ»úÎE *
+ * @param str エスケープ処理対象文字列
+ *
+ * @return エスケープ処理結果文字列
+ *
* @else
*
* @brief Escape string
@@ -199,9 +213,9 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤Î¥¨¥¹¥±¡¼¥×¤òÌ᤹
+ * @brief 文字列のエスケープを戻す
*
- * ¼¡¤Î¥¨¥¹¥±¡¼¥×¥·¡¼¥±¥ó¥¹¤òʸ»ú¤ËÊÑ´¹¤¹¤E£<br>
+ * 次のエスケープシーケンスを文字に変換する。<br>
* "\t" -> HT <br>
* "\n" -> LF <br>
* "\r" -> CR <br>
@@ -208,10 +222,12 @@
* "\f" -> FF <br>
* "\"" -> " <br>
* "\'" -> ' <br>
- * ¢¨¥¨¥¹¥±¡¼¥×½èÍý¤Î´°Á´¤ÊµÕÊÑ´¹¤Ë¤Ï¤Ê¤Ã¤Æ¤¤¤Ê¤¤¤¿¤á¡¢ÃúÌÕ¤¬É¬Íס£
+ * ※エスケープ処理の完全な逆変換にはなっていないため、注意が必要。
*
- * @param str ¥¢¥ó¥¨¥¹¥±¡¼¥×½èÍýÂоÝʸ»úÎE *
- * @return ¥¢¥ó¥¨¥¹¥±¡¼¥×½èÍý·EÌʸ»úÎE *
+ * @param str アンエスケープ処理対象文字列
+ *
+ * @return アンエスケープ処理結果文字列
+ *
* @else
*
* @brief Unescape string
@@ -235,11 +251,13 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤Î¶õÇòʸ»ú¤òºEE¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤Î¶õÇòʸ»ú¤òºEE¹¤E£
- * ¶õÇòʸ»ú¤È¤·¤Æ°·¤¦¤Î¤Ï' '(¥¹¥Ú¡¼¥¹)¤È'\\t'(¥¿¥Ö)¡£
+ * @brief 文字列の空白文字を削除する
*
- * @param str ¶õÇòʸ»úºEEèÍýʸ»úÎE *
+ * 与えられた文字列の空白文字を削除する。
+ * 空白文字として扱うのは' '(スペース)と'\\t'(タブ)。
+ *
+ * @param str 空白文字削除処理文字列
+ *
* @else
* @brief Erase blank characters of string
*
@@ -254,11 +272,13 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤ÎÀèƬ¤Î¶õÇòʸ»ú¤òºEE¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ÎÀèƬ¤Ë¸ºß¤¹¤EõÇòʸ»ú¤òºEE¹¤E£
- * ¶õÇòʸ»ú¤È¤·¤Æ°·¤¦¤Î¤Ï' '(¥¹¥Ú¡¼¥¹)¤È'\\t'(¥¿¥Ö)¡£
+ * @brief 文字列の先頭の空白文字を削除する
*
- * @param str ÀèƬ¶õÇòʸ»úºEEèÍýʸ»úÎE *
+ * 与えられた文字列の先頭に存在する空白文字を削除する。
+ * 空白文字として扱うのは' '(スペース)と'\\t'(タブ)。
+ *
+ * @param str 先頭空白文字削除処理文字列
+ *
* @else
* @brief Erase the head blank characters of string
*
@@ -273,11 +293,13 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤ÎËöÈø¤Î¶õÇòʸ»ú¤òºEE¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ÎËöÈø¤Ë¸ºß¤¹¤EõÇòʸ»ú¤òºEE¹¤E£
- * ¶õÇòʸ»ú¤È¤·¤Æ°·¤¦¤Î¤Ï' '(¥¹¥Ú¡¼¥¹)¤È'\\t'(¥¿¥Ö)¡£
+ * @brief 文字列の末尾の空白文字を削除する
*
- * @param str ËöÈø¶õÇòʸ»úºEEèÍýʸ»úÎE *
+ * 与えられた文字列の末尾に存在する空白文字を削除する。
+ * 空白文字として扱うのは' '(スペース)と'\\t'(タブ)。
+ *
+ * @param str 末尾空白文字削除処理文字列
+ *
* @else
* @brief Erase the tail blank characters of string
*
@@ -293,11 +315,13 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤ÎÀèƬ¡¦ËöÈø¤Î¶õÇòʸ»ú¤òºEE¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ÎÀèƬ¤ª¤è¤ÓËöÈø¤Ë¸ºß¤¹¤EõÇòʸ»ú¤òºEE¹¤E£
- * ¶õÇòʸ»ú¤È¤·¤Æ°·¤¦¤Î¤Ï' '(¥¹¥Ú¡¼¥¹)¤È'\\t'(¥¿¥Ö)¡£
+ * @brief 文字列の先頭・末尾の空白文字を削除する
*
- * @param str ÀèƬËöÈø¶õÇòʸ»úºEEèÍýʸ»úÎE *
+ * 与えられた文字列の先頭および末尾に存在する空白文字を削除する。
+ * 空白文字として扱うのは' '(スペース)と'\\t'(タブ)。
+ *
+ * @param str 先頭末尾空白文字削除処理文字列
+ *
* @else
* @brief Erase the head blank and the tail blank characters of string
*
@@ -313,11 +337,13 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤òÀµµ¬²½¤¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ÎÀèƬ¤ª¤è¤ÓËöÈø¤Ë¸ºß¤¹¤EõÇòʸ»ú¤òºEE·¡¢
- * ±Ñ»ú¤ò¤¹¤Ù¤Æ¾®Ê¸»ú¤ËÊÑ´¹¤¹¤E£
+ * @brief 文字列を正規化する
*
- * @param str ½èÍýÂоÝʸ»úÎE *
+ * 与えられた文字列の先頭および末尾に存在する空白文字を削除し、
+ * 英字をすべて小文字に変換する。
+ *
+ * @param str 処理対象文字列
+ *
* @else
* @brief Erase the head/tail blank and replace upper case to lower case
*
@@ -334,10 +360,14 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤òÃÖ¤´¹¤¨¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤ËÂФ·¤Æ¡¢»ØÄꤷ¤¿Ê¸»ú¤ÎÃÖ¤´¹¤¨¤ò¹Ô¤¦¡£
+ * @brief 文字列を置き換える
*
- * @param str ÃÖ¤´¹¤¨½èÍýÂоÝʸ»úÎE * @param from ÃÖ´¹¸µÊ¸»E * @param to ÃÖ´¹Àèʸ»E *
+ * 与えられた文字列に対して、指定した文字の置き換えを行う。
+ *
+ * @param str 置き換え処理対象文字列
+ * @param from 置換元文字
+ * @param to 置換先文字
+ *
* @else
* @brief Replace string
*
@@ -354,12 +384,14 @@
/*!
* @if jp
- * @brief ʸ»úÎó¤òʬ³äʸ»ú¤Çʬ³ä¤¹¤E *
- * ÀßÄꤵ¤E¿Ê¸»úÎó¤òÍ¿¤¨¤é¤E¿¥Ç¥Eߥ¿¤Çʬ³ä¤¹¤E£
+ * @brief 文字列を分割文字で分割する
+ *
+ * 設定された文字列を与えられたデリミタで分割する。
*
- * @param input ʬ³äÂоÝʸ»úÎE * @param delimiter ʬ³äʸ»úÎE¥Ç¥Eߥ¿)
+ * @param input 分割対象文字列
+ * @param delimiter 分割文字列(デリミタ)
*
- * @return ʸ»úÎóʬ³ä·EÌ¥E¹¥È
+ * @return 文字列分割結果リスト
*
* @else
* @brief Split string by delimiter
@@ -379,12 +411,17 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¤òboolÃͤËÊÑ´¹¤¹¤E *
- * »ØÄꤵ¤E¿Ê¸»úÎó¤ò¡¢trueɽ¸½Ê¸»úÎó¡¢falseɽ¸½Ê¸»úÎó¤ÈÈæ³Ó¤·¡¢¤½¤Î·E̤E * boolÃͤȤ·¤ÆÊÖ¤¹¡£
- * Èæ³Ó¤Î·EÌ¡¢trueɽ¸½Ê¸»úÎó¡¢falseɽ¸½Ê¸»úÎó¤Î¤É¤Á¤é¤È¤â°Eפ·¤Ê¤¤¾Eç¤Ï¡¢
- * Í¿¤¨¤é¤E¿¥Ç¥Õ¥©¥EÈÃͤòÊÖ¤¹¡£
+ * @brief 与えられた文字列をbool値に変換する
+ *
+ * 指定された文字列を、true表現文字列、false表現文字列と比較し、その結果を
+ * bool値として返す。
+ * 比較の結果、true表現文字列、false表現文字列のどちらとも一致しない場合は、
+ * 与えられたデフォルト値を返す。
*
- * @param str ȽÃÇÂоÝʸ»úÎE * @param yes trueɽ¸½Ê¸»úÎE * @param no falseɽ¸½Ê¸»úÎE * @param default_value ¥Ç¥Õ¥©¥EÈÃÍ(¥Ç¥Õ¥©¥EÈÃÍ:true)
+ * @param str 判断対象文字列
+ * @param yes true表現文字列
+ * @param no false表現文字列
+ * @param default_value デフォルト値(デフォルト値:true)
* @else
* @brief Convert given string into bool value
*
@@ -404,12 +441,14 @@
bool default_value = true);
/*!
* @if jp
- * @brief ʸ»úÎó¥E¹¥ÈÃæ¤Ë¤¢¤E¸»úÎ󤬴ޤޤEE«¤É¤¦¤«¤òȽÃǤ¹¤E *
- * ÂE°ú¿ô¤Ë¥«¥ó¥Þ¶èÀÚ¤ê¤Î¥E¹¥È¤ò¡¢ÂE°ú¿ô¤Ëõº÷ÂоÝʸ»úÎó¤ò»ØÄꤷ¡¢
- * ¤½¤Îʸ»úÎó¤¬ÂE°ú¿ô¤ÎÃæ¤Ë´Þ¤Þ¤EE«¤òȽÃǤ¹¤E£
+ * @brief 文字列リスト中にある文字列が含まれるかどうかを判断する
+ *
+ * 第1引数にカンマ区切りのリストを、第2引数に探索対象文字列を指定し、
+ * その文字列が第1引数の中に含まれるかを判断する。
*
- * @param list ÂоݥE¹¥È
- * @param value õº÷ʸ»úÎE * @return true: ´Þ¤Þ¤EE¢false: ´Þ¤Þ¤Eʤ¤
+ * @param list 対象リスト
+ * @param value 探索文字列
+ * @return true: 含まれる、false: 含まれない
*
* @else
* @brief Include if a string is included in string list
@@ -428,11 +467,14 @@
/*!
* @if jp
- * @brief ʸ»úÎó¥E¹¥ÈÃæ¤Ë¤¢¤E¸»úÎ󤬴ޤޤEE«¤É¤¦¤«¤òȽÃǤ¹¤E *
- * ÂE°ú¿ô¤Ë¥«¥ó¥Þ¶èÀÚ¤ê¤Î¥E¹¥È¤ò¡¢ÂE°ú¿ô¤Ëõº÷ÂоÝʸ»úÎó¤ò»ØÄꤷ¡¢
- * ¤½¤Îʸ»úÎó¤¬ÂE°ú¿ô¤ÎÃæ¤Ë´Þ¤Þ¤EE«¤òȽÃǤ¹¤E£
+ * @brief 文字列リスト中にある文字列が含まれるかどうかを判断する
+ *
+ * 第1引数にカンマ区切りのリストを、第2引数に探索対象文字列を指定し、
+ * その文字列が第1引数の中に含まれるかを判断する。
*
- * @param list ÂоÝʸ»úÎE * @param value õº÷ʸ»úÎE * @return true: ´Þ¤Þ¤EE¢false: ´Þ¤Þ¤Eʤ¤
+ * @param list 対象文字列
+ * @param value 探索文字列
+ * @return true: 含まれる、false: 含まれない
*
* @else
* @brief Include if a string is included in string list
@@ -451,16 +493,18 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¤¬ÀäÂХѥ¹¤«¤É¤¦¤«¤òȽÃǤ¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤¬ÀäÂХѥ¹É½¸½¤Ç¤¢¤E«¤É¤¦¤«¤òȽÃǤ¹¤E£
- * ʸ»úÎ󤬰ʲ¼¤Î¾Eç¤Ë¤ÏÀäÂХѥ¹¤È¤·¤ÆȽÃǤ¹¤E£
- * - ÀèƬʸ»ú¤¬'/' (UNIX¤Î¾EE
- * - ÀèƬ£³Ê¸»ú¤¬¥¢¥EÕ¥¡¥Ù¥Ã¥È¡Ü'/'¡Ü'\\' (Windows¤Î¾EE
- * - ÀèƬ£²Ê¸»ú¤¬'\\\\' (Windows¥Í¥Ã¥È¥E¼¥¯¥Ñ¥¹¤Î¾EE
+ * @brief 与えられた文字列が絶対パスかどうかを判断する
*
- * @param str ȽÄEоÝʸ»úÎE *
- * @return ÀäÂХѥ¹È½ÄEEÌ
+ * 与えられた文字列が絶対パス表現であるかどうかを判断する。
+ * 文字列が以下の場合には絶対パスとして判断する。
+ * - 先頭文字が'/' (UNIXの場合)
+ * - 先頭３文字がアルファベット＋'/'＋'\\' (Windowsの場合)
+ * - 先頭２文字が'\\\\' (Windowsネットワークパスの場合)
*
+ * @param str 判定対象文字列
+ *
+ * @return 絶対パス判定結果
+ *
* @else
* @brief Investigate whether the given string is absolute path or not
*
@@ -467,7 +511,7 @@
* Investigate whether the given string is absolute path or not.
* Investigate it as an absolute path, if the string is as follows:
* - The first character '/' (UNIX)
- * - The first 3 characters are alphabet ¡Ü'/'¡Ü'\\' (Windows)
+ * - The first 3 characters are alphabet ＋'/'＋'\\' (Windows)
* - The first 2 characters are '\\\\' (Windows network path)
*
* @param str The target string for the investigation
@@ -480,14 +524,16 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¤¬URL¤«¤É¤¦¤«¤òȽÃǤ¹¤E *
- * Í¿¤¨¤é¤E¿Ê¸»úÎó¤¬URLɽ¸½¤«¤É¤¦¤«¤òȽÃǤ¹¤E£
- * Í¿¤¨¤é¤E¿Ê¸»úÎóÃæ¤Ë¡¢'://'¤È¤¤¤¦Ê¸»úÎ󤬴ޤޤEƤ¤¤EEç¤Ë¤Ï
- * URLɽ¸½¤È¤·¤ÆȽÃǤ¹¤E£
+ * @brief 与えられた文字列がURLかどうかを判断する
*
- * @param str ȽÄEоÝʸ»úÎE *
- * @return URLȽÄEEÌ
+ * 与えられた文字列がURL表現かどうかを判断する。
+ * 与えられた文字列中に、'://'という文字列が含まれている場合には
+ * URL表現として判断する。
*
+ * @param str 判定対象文字列
+ *
+ * @return URL判定結果
+ *
* @else
* @brief Investigate whether the given string is URL or not
*
@@ -506,30 +552,26 @@
bool isIPv6(const std::string& str);
/*!
* @if jp
- * @brief URL¥Ñ¥é¥á¡¼¥¿¤òmapstring¤Ëʬ²ò¤·¤ÆÊÖ¤¹
+ * @brief 与えられた文字列がURLかどうかを判断する
*
- * URL¥Ñ¥é¥á¡¼¥¿É½¸½ something?key0=value0&key1=value1.... ¤Î¤¦¤Á
- * '?' °Ê¹ß¤ÎÉôʬ¤òʬ²ò¤·¤Æ¡¢std::map<std::string, std::string> ·Á¼°
- * ¤ËÊÑ´¹¤¹¤E£Í¿¤¨¤é¤E¿Ê¸»úÎó¤òº¸¤«¤é¥µ¡¼¥Á¤·¡¢'?' ¤è¤E¦Â¦¤ÎÉôʬ¤Ë
- * ¤Ä¤¤¤Æ²òÀϤò¹Ô¤¦¡£'&'¤Çʬ³ä¤·¡¢º¸¤«¤E'=' ¤ò¸¡º÷¤·¡¢ºÇ½é¤Î '=' ¤Î
- * ±¦ÊդȺ¸ÊÕ¤ò¤½¤E¾¤E¢key ¤È value ¤È¤·¤Æ map ¤Ë³ÊǼ¤¹¤E£
+ * 与えられた文字列がURL表現かどうかを判断する。
+ * 与えられた文字列中に、'://'という文字列が含まれている場合には
+ * URL表現として判断する。
*
- * @param str ʬ²òÂоÝʸ»úÎE * @return mapstring ·¿¤Î key/value¥Ç¡¼¥¿
+ * @param str 判定対象文字列
*
+ * @return URL判定結果
+ *
* @else
* @brief Investigate whether the given string is URL or not
*
- * URL parameter description such as
- * something?key0=value0&key1=value1.... is analyzed. Right hand
- * side string of '?' character is decomposed and it is converted
- * into std::map<std::string, std::string> type.The following string
- * are devided by '&' and then '=' character is
- * searched. Right-hand-side value and left-hand-side value of '='
- * are stored as key and value in the map.
+ * Investigate whether the given string is URL or not.
+ * When the string '://' is included in the given character string,
+ * make it of URL representation.
*
- * @param str The target string for decomposed
+ * @param str The target string for investigation
*
- * @return decomposed key-values in map
+ * @return URL investigation result
*
* @endif
*/
@@ -537,13 +579,13 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿¥ª¥Ö¥¸¥§¥¯¥È¤òstd::string¤ËÊÑ´¹
+ * @brief 与えられたオブジェクトをstd::stringに変換
*
- * °ú¿ô¤Ç»ØÄꤵ¤E¿¥ª¥Ö¥¸¥§¥¯¥È¤òʸ»úÎó¤ËÊÑ´¹¤¹¤E£
+ * 引数で指定されたオブジェクトを文字列に変換する。
*
- * @param n ÊÑ´¹Âоݥª¥Ö¥¸¥§¥¯¥È
+ * @param n 変換対象オブジェクト
*
- * @return ʸ»úÎóÊÑ´¹·EÌ
+ * @return 文字列変換結果
*
* @else
* @brief Convert the given object to std::string
@@ -566,14 +608,15 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿std::string¤ò¥ª¥Ö¥¸¥§¥¯¥È¤ËÊÑ´¹
+ * @brief 与えられたstd::stringをオブジェクトに変換
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¤ò»ØÄꤵ¤E¿¥ª¥Ö¥¸¥§¥¯¥È¤ËÊÑ´¹¤¹¤E£
+ * 引数で与えられた文字列を指定されたオブジェクトに変換する。
*
- * @param val ÊÑ´¹À襪¥Ö¥¸¥§¥¯¥È
- * @param str ÊÑ´¹¸µÊ¸»úÎE *
- * @return true: À®¸E false: ¼ºÇÔ
+ * @param val 変換先オブジェクト
+ * @param str 変換元文字列
*
+ * @return true: 成功, false: 失敗
+ *
* @else
* @brief Convert the given std::string to object.
*
@@ -599,13 +642,15 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¤òstd::string¤ËÊÑ´¹
+ * @brief 与えられた文字列をstd::stringに変換
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¤òstd::string¤ËÊÑ´¹¤¹¤E£
+ * 引数で与えられた文字列をstd::stringに変換する。
*
- * @param val ÊÑ´¹Àèʸ»úÎE * @param str ÊÑ´¹¸µÊ¸»úÎE *
- * @return true: À®¸E false: ¼ºÇÔ
+ * @param val 変換先文字列
+ * @param str 変換元文字列
*
+ * @return true: 成功, false: 失敗
+ *
* @else
* @brief Convert the given string to std::string.
*
@@ -623,31 +668,24 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¤òbool¤ËÊÑ´¹
+ * @brief 与えられた文字列リストから重複を削除
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¤òbool¤ËÊÑ´¹¤¹¤E£true/false ¤ò»ØÄꤹ¤E¿¤E * ¤Ë°Ê²¼¤Îʸ»úÎ󤬻ÈÍѲÄǽ¡£Âçʸ»ú¤È¾®Ê¸»ú¤Î¶èÊ̤Ϥʤ¤¡£
+ * 引数で与えられた文字列リストから重複を削除したリストを作成する。
*
- * - true: 1, true, yes, on
- * - true: 0, false, no, off
+ * @param sv 確認元文字列リスト
*
- * @param val ÊÑ´¹Àèʸ»úÎE * @param str ÊÑ´¹¸µÊ¸»úÎE *
- * @return true: À®¸E false: ¼ºÇÔ
+ * @return 重複削除処理結果リスト
*
* @else
- * @brief Convert the given string to bool
+ * @brief Eliminate duplication from the given string list
*
- * Convert string given by the argument to bool. The following
- * string can be used to specify true/false. Given string is not
- * case-sensitive.
+ * Create a list of eliminating duplication from the string list
+ * given by the argument.
*
- * - true: 1, true, yes, on
- * - true: 0, false, no, off
+ * @param sv The string list for confirmation source
*
- * @param val String of conversion destination
- * @param val String of conversion destination
+ * @return Eliminating duplication result list
*
- * @return true: successful, false: failed
- *
* @endif
*/
template <>
@@ -655,13 +693,15 @@
/*!
* @if jp
- * @brief ¥Ý¥¤¥ó¥¿¤E6¿Ê¿ôʸ»úÎó¤ËÊÑ´¹¤¹¤E *
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¤E6¿Ê¿ôʸ»úÎó¤ËÊÑ´¹¤¹¤E£ÊÑ´¹¤µ¤E¿Ê¸»úÎó¤Î
- * ÀèƬ¤Ë¤Ï "0x" ¤¬Éղ䵤EE£
+ * @brief ポインタを16進数文字列に変換する
*
- * @param ptr ¥Ý¥¤¥ó¥¿
+ * 引数で与えられた文字列を16進数文字列に変換する。変換された文字列の
+ * 先頭には "0x" が付加される。
*
- * @return 16¿Ê¿ôʸ»úÎE *
+ * @param ptr ポインタ
+ *
+ * @return 16進数文字列
+ *
* @else
* @brief Converting a pointer to hexadecimal string
*
@@ -685,13 +725,15 @@
/*!
* @if jp
- * @brief 16¿Ê¿ôʸ»úÎó¤ò¥Ý¥¤¥ó¥¿¤ËÊÑ´¹¤¹¤E *
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿16¿Ê¿ôʸ»úÎó¤òʸ»úÎó¤ò¤ËÊÑ´¹¤¹¤E£Ê¸»úÎó¤Î
- * ÀèƬ¤Ë¤Ï "0x" ¤¬Éղ䵤EƤ¤¤EÙ¤¤Ç¤¢¤E£
+ * @brief 16進数文字列をポインタに変換する
*
- * @param ptr ¥Ý¥¤¥ó¥¿
- * @param str 16¿Ê¿ôʸ»úÎE * @return ÊÑ´¹¤¬À®¸ù¤·¤¿¤Etrue¡¢¤½¤Eʳ°¤Ï false
+ * 引数で与えられた16進数文字列を文字列をに変換する。文字列の
+ * 先頭には "0x" が付加されているべきである。
*
+ * @param ptr ポインタ
+ * @param str 16進数文字列
+ * @return 変換が成功したら true、それ以外は false
+ *
* @else
* @brief Converting hexadecimal string to a pointer
*
@@ -719,13 +761,14 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤«¤é½ÅÊ£¤òºEE *
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤«¤é½ÅÊ£¤òºEE·¤¿¥E¹¥È¤òºûÜ®¤¹¤E£
+ * @brief 与えられた文字列リストから重複を削除
*
- * @param sv ³Îǧ¸µÊ¸»úÎó¥E¹¥È
+ * 引数で与えられた文字列リストから重複を削除したリストを作成する。
*
- * @return ½ÅÊ£ºEEèÍý·EÌ¥E¹¥È
+ * @param sv 確認元文字列リスト
*
+ * @return 重複削除処理結果リスト
+ *
* @else
* @brief Eliminate duplication from the given string list
*
@@ -742,15 +785,15 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤«¤éCSV¤òÀ¸À®
+ * @brief 与えられた文字列リストからCSVを生成
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤Î³ÆÍ×ÁǤòʤ٤¿CSV¤òÀ¸À®¤¹¤E£
- * ʸ»úÎó¥E¹¥È¤¬¶õ¤Î¾Eç¤Ë¤Ï¶õÇòʸ»ú¤òÊÖ¤¹¡£
+ * 引数で与えられた文字列リストの各要素を並べたCSVを生成する。
+ * 文字列リストが空の場合には空白文字を返す。
*
- * @param sv CSVÊÑ´¹ÂоÝʸ»úÎó¥E¹¥È
- * @param delimiter Àܳ¤µ¤EE¸»úÎó¤Î´Ö¤Îʸ»E(¥Ç¥Õ¥©¥EÈ: ", ")
+ * @param sv CSV変換対象文字列リスト
*
- * @return CSVÊÑ´¹·EÌʸ»úÎE *
+ * @return CSV変換結果文字列
+ *
* @else
* @brief Create CSV file from the given string list
*
@@ -769,14 +812,15 @@
/*!
* @if jp
- * @brief Í¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤ò°ú¿ô¥E¹¥È¤ËÊÑ´¹
+ * @brief 与えられた文字列リストを引数リストに変換
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿Ê¸»úÎó¥E¹¥È¤Î³ÆÍ×ÁÇËöÈø¤Ë'\\0'¤ò²Ã¤¨¡¢°ú¿ô¥E¹¥È
- * ¤ËÊÑ´¹¤¹¤E£
+ * 引数で与えられた文字列リストの各要素末尾に'\\0'を加え、引数リスト
+ * に変換する。
*
- * @param args ÊÑ´¹ÂоÝʸ»úÎó¥E¹¥È
+ * @param args 変換対象文字列リスト
*
- * @return °ú¿ôÊÑ´¹·EÌʸ»úÎE *
+ * @return 引数変換結果文字列
+ *
* @else
* @brief Convert the given string list into the argument list
*
@@ -794,13 +838,14 @@
/*!
* @if jp
- * @brief »ØÄꤵ¤E¿½ñ¼°¤ËÊÑ´¹
+ * @brief 指定された書式に変換
*
- * °ú¿ô¤ÇÍ¿¤¨¤é¤E¿½ñ¼°¤ËÊÑ´¹¤·¤ÆÊÖ¤¹¡£
+ * 引数で与えられた書式に変換して返す。
*
- * @param fmt ½ñ¼°
+ * @param fmt 書式
*
- * @return ÊÑ´¹·EÌʸ»úÎE *
+ * @return 変換結果文字列
+ *
* @else
* @brief Convert it into a format given with an argumen
*
More information about the openrtm-commit
mailing list