Templates -- Meow
1.1.2
不能,也不應該先編譯成obj-file的templates
|
管理參數設置, 自訂usage document, 分析argc, argv More...
#include "Usage.h"
Public Member Functions | |
Usage () | |
constructor More... | |
Usage (String const &name) | |
constructor More... | |
Usage (Usage const &usage) | |
constructor More... | |
bool | import (Usage const &usage) |
將另一個usage的設置匯入 More... | |
bool | update (Usage const &usage) |
將另一個usage的選項設置加進來 More... | |
bool | optionAdd (String opt, String const &des) |
新增一個沒有額外選項的選項 More... | |
bool | optionAdd (String opt, String const &des, String const &val_type, String const &val_default, bool must) |
新增一個有額外選項的選項 More... | |
bool | optionValueAcceptAdd (String opt, String const &val, String const &des) |
針對-(opt)新增一個可接受的額外選項 More... | |
bool | hasOptionSetup (String opt) const |
回傳是否有設定此選項 More... | |
size_t | optionValuesSize (String opt) const |
回傳參數 -(opt) 被設置幾次 More... | |
String | optionValue (String opt, size_t index) const |
回傳參數 -(opt) 的第 index 個額外選項 More... | |
size_t | procArgsSize () const |
取得有幾個process arguments More... | |
String | procArg (size_t index) const |
取得第i個process argument More... | |
Strings const & | procArgs () const |
取得process arguments array More... | |
void | usageBeginAdd (String const &des) |
新增一段usage document於每個選項逐條說明之前 More... | |
void | usageEndAdd (String const &des) |
新增一段usage document於每個選項逐條說明之後 More... | |
String | usage () const |
回傳usage string More... | |
bool | arguments (int argc, char **argv, String *errmsg) |
給定argc, argv, 將各參數設置 More... | |
管理參數設置, 自訂usage document, 分析argc, argv
Usage 是用來分析argc, argv和輸出usage document的class.
argc, argv的部份, 有以下規則
|
inline |
constructor
所有說明文字中 <name> 都會被代換成空字串
|
inline |
constructor
所有說明文字中 "<name>" 都會被代換成空字串 name
|
inline |
constructor
將另一個usage原封不動的複製過來
|
inline |
給定argc, argv, 將各參數設置
[in] | argc,argv | |
[out] | errmsg | 將錯誤訊息寫到這裡 (若給定NULL pointer, 則會把錯誤訊息忽略) |
true/false
成功與否 (否的話代表有錯誤的設定值在其中)
|
inline |
回傳是否有設定此選項
[in] | opt | 指定字符 |
true/false
表 是否有設定此選項
|
inline |
將另一個usage的設置匯入
[in] | usage | 另一個usage |
true/false
表示 是否成功
|
inline |
新增一個沒有額外選項的選項
[in] | opt | 指定字符 |
[in] | des | 即description, 用來解釋這個選項的意義用的 |
true/false
表 是否成功
|
inline |
新增一個有額外選項的選項
[in] | opt | 指定字符 |
[in] | des | 即description, 用來解釋這個選項的意義用的 |
[in] | val_type | 表示額外選項的型態, 寫在USAGE裡面給人看用的 |
[in] | val_default | 預設值, 若為空字串則當作沒有預設值 |
[in] | must | 表示是否一定要設定 |
true/false
表 是否成功
|
inline |
回傳參數 -(opt) 的第 index 個額外選項
[in] | opt | 指定字符 |
[in] | index | 第幾個 |
|
inline |
針對-(opt)新增一個可接受的額外選項
[in] | opt | 指定字符 |
[in] | val | 額外選項 |
[in] | des | 關於此額外選項的說明 |
true/false
表 是否成功
|
inline |
回傳參數 -(opt) 被設置幾次
[in] | opt | 指定字符 |
|
inline |
取得第i個process argument
[in] | index | 第幾個 |
|
inline |
取得process arguments array
std::vector
, 包含所有 Process arguments
|
inline |
取得有幾個process arguments
|
inline |
將另一個usage的選項設置加進來
[in] | usage | 另一個usage |
true/false
表 是否成功
|
inline |
回傳usage string
|
inline |
新增一段usage document於每個選項逐條說明之前
[in] | des | 要新增的usage document |
|
inline |
新增一段usage document於每個選項逐條說明之後
[in] | des | 要新增的usage document |