source: lab.git/Dev/utvpn/utvpn-unix-v101-7101-public/src/Cedar/Console.h @ 86521dd

trunk
Last change on this file since 86521dd was a1bae3e, checked in by mitty <mitty@…>, 12 years ago
  • copy vendor drop to trunk

git-svn-id: https://lab.mitty.jp/svn/lab/trunk@147 7d2118f6-f56c-43e7-95a2-4bb3031d96e7

  • Property mode set to 100644
File size: 9.8 KB
Line 
1// SoftEther UT-VPN SourceCode
2//
3// Copyright (C) 2004-2010 SoftEther Corporation.
4// Copyright (C) 2004-2010 University of Tsukuba, Japan.
5// Copyright (C) 2003-2010 Daiyuu Nobori.
6// All Rights Reserved.
7//
8// http://utvpn.tsukuba.ac.jp/
9//
10// This program is free software; you can redistribute it and/or
11// modify it under the terms of the GNU General Public License
12// version 2 as published by the Free Software Foundation.
13//
14// This program is distributed in the hope that it will be useful,
15// but WITHOUT ANY WARRANTY; without even the implied warranty of
16// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17// GNU General Public License for more details.
18//
19// You should have received a copy of the GNU General Public License version 2
20// along with this program; if not, write to the Free Software
21// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22//
23// このファイルは GPL バージョン 2 ライセンスで公開されています。
24// 誰でもこのファイルの内容を複製、改変したり、改変したバージョンを再配布
25// することができます。ただし、原著作物を改変した場合は、原著作物の著作権表示
26// を除去することはできません。改変した著作物を配布する場合は、改変実施者の
27// 著作権表示を原著作物の著作権表示に付随して記載するようにしてください。
28//
29// この SoftEther UT-VPN オープンソース・プロジェクトは、日本国の
30// ソフトイーサ株式会社 (SoftEther Corporation, http://www.softether.co.jp/ )
31// および筑波大学 (University of Tsukuba, http://www.tsukuba.ac.jp/ ) によって
32// ホストされています。
33// 本プログラムの配布者は、本プログラムを、業としての利用以外のため、
34// および、試験または研究のために利用が行われることを想定して配布
35// しています。
36// SoftEther UT-VPN プロジェクトの Web サイトは http://utvpn.tsukuba.ac.jp/ に
37// あります。
38// 本ソフトウェアの不具合の修正、機能改良、セキュリティホールの修復などのコード
39// の改変を行った場合で、その成果物を SoftEther UT-VPN プロジェクトに提出して
40// いただける場合は、 http://utvpn.tsukuba.ac.jp/ までソースコードを送付して
41// ください。SoftEther UT-VPN プロジェクトの本体リリースまたはブランチリリース
42// に組み込みさせていただきます。
43//
44// GPL に基づいて原著作物が提供される本ソフトウェアの改良版を配布、販売する
45// 場合は、そのソースコードを GPL に基づいて誰にでも開示する義務が生じます。
46//
47// 本ソフトウェアに関連する著作権、特許権、商標権はソフトイーサ株式会社
48// (SoftEther Corporation) およびその他の著作権保持者が保有しています。
49// ソフトイーサ株式会社等はこれらの権利を放棄していません。本ソフトウェアの
50// 二次著作物を配布、販売する場合は、これらの権利を侵害しないようにご注意
51// ください。
52//
53// お願い: どのような通信ソフトウェアにも通常は必ず未発見の
54// セキュリティホールが潜んでいます。本ソースコードをご覧いただいた結果、
55// UT-VPN にセキュリティホールを発見された場合は、当該セキュリティホールの
56// 情報を不特定多数に開示される前に、必ず、ソフトイーサ株式会社
57// および脆弱性情報の届出を受け付ける公的機関まで通報いただき、
58// 公益保護にご協力いただきますようお願い申し上げます。
59//
60// ソフトイーサ株式会社は、当該セキュリティホールについて迅速に対処を
61// 行い、UT-VPN および UT-VPN に関連するソフトウェアのユーザー・顧客
62// を保護するための努力を行います。
63//
64// ソフトイーサへの届出先: http://www.softether.co.jp/jp/contact/
65// 日本国内の脆弱性情報届出受付公的機関:
66//         独立行政法人 情報処理推進機構
67//         http://www.ipa.go.jp/security/vuln/report/
68//
69// 上記各事項について不明な点は、ソフトイーサ株式会社までご連絡ください。
70// 連絡先: http://www.softether.co.jp/jp/contact/
71
72// -----------------------------------------------
73// [ChangeLog]
74// 2010.05.20
75//  新規リリース by SoftEther
76// -----------------------------------------------
77
78// Console.h
79// Console.c のヘッダ
80
81#ifndef CONSOLE_H
82#define CONSOLE_H
83
84// 定数
85#define MAX_PROMPT_STRSIZE          65536
86#define WIN32_DEFAULT_CONSOLE_WIDTH 100
87
88// コンソールの種類
89#define CONSOLE_LOCAL               0   // ローカルコンソール
90#define CONSOLE_CSV                 1   // CSV 出力モード
91
92// パラメータ補完プロンプト関数
93typedef wchar_t *(PROMPT_PROC)(CONSOLE *c, void *param);
94
95// パラメータ検証プロンプト関数
96typedef bool (EVAL_PROC)(CONSOLE *c, wchar_t *str, void *param);
97
98// パラメータ項目の定義
99struct PARAM
100{
101    char *Name;                 // パラメータ名
102    PROMPT_PROC *PromptProc;    // パラメータが指定されていない場合に自動的に呼び出す
103                                // プロンプト関数 (NULL の場合は呼ばない)
104    void *PromptProcParam;      // プロンプト関数に渡す任意のポインタ
105    EVAL_PROC *EvalProc;        // パラメータ文字列検証関数
106    void *EvalProcParam;        // 検証関数に渡す任意のポインタ
107    char *Tmp;                  // 一時変数
108};
109
110// パラメータ値内部データ
111struct PARAM_VALUE
112{
113    char *Name;                 // 名前
114    char *StrValue;             // 文字列値
115    wchar_t *UniStrValue;       // Unicode 文字列値
116    UINT IntValue;              // 整数値
117};
118
119// コンソールサービス構造体
120struct CONSOLE
121{
122    UINT ConsoleType;                                       // コンソールの種類
123    UINT RetCode;                                           // 最後の終了コード
124    void *Param;                                            // 任意のデータ
125    void (*Free)(CONSOLE *c);                               // 解放関数
126    wchar_t *(*ReadLine)(CONSOLE *c, wchar_t *prompt, bool nofile);     // 1 行読み込む関数
127    char *(*ReadPassword)(CONSOLE *c, wchar_t *prompt);     // パスワードを読み込む関数
128    bool (*Write)(CONSOLE *c, wchar_t *str);                // 文字列を書き出す関数
129    UINT (*GetWidth)(CONSOLE *c);                           // 画面の横幅の取得
130};
131
132// ローカルコンソールパラメータ
133struct LOCAL_CONSOLE_PARAM
134{
135    IO *InFile;     // 入力ファイル
136    BUF *InBuf;     // 入力バッファ
137    IO *OutFile;    // 出力ファイル
138    UINT Win32_OldConsoleWidth; // 以前のコンソールサイズ
139};
140
141// コマンドプロシージャ
142typedef UINT (COMMAND_PROC)(CONSOLE *c, char *cmd_name, wchar_t *str, void *param);
143
144// コマンドの定義
145struct CMD
146{
147    char *Name;             // コマンド名
148    COMMAND_PROC *Proc;     // プロシージャ関数
149};
150
151// パラメータの最小 / 最大値評価
152struct CMD_EVAL_MIN_MAX
153{
154    char *StrName;
155    UINT MinValue, MaxValue;
156};
157
158
159// 関数プロトタイプ
160wchar_t *Prompt(wchar_t *prompt_str);
161char *PromptA(wchar_t *prompt_str);
162bool PasswordPrompt(char *password, UINT size);
163void *SetConsoleRaw();
164void RestoreConsole(void *p);
165wchar_t *ParseCommandEx(wchar_t *str, wchar_t *name, TOKEN_LIST **param_list);
166wchar_t *ParseCommand(wchar_t *str, wchar_t *name);
167TOKEN_LIST *GetCommandNameList(wchar_t *str);
168char *ParseCommandA(wchar_t *str, char *name);
169LIST *NewParamValueList();
170int CmpParamValue(void *p1, void *p2);
171void FreeParamValueList(LIST *o);
172PARAM_VALUE *FindParamValue(LIST *o, char *name);
173char *GetParamStr(LIST *o, char *name);
174wchar_t *GetParamUniStr(LIST *o, char *name);
175UINT GetParamInt(LIST *o, char *name);
176bool GetParamYes(LIST *o, char *name);
177LIST *ParseCommandList(CONSOLE *c, char *cmd_name, wchar_t *command, PARAM param[], UINT num_param);
178bool IsNameInRealName(char *input_name, char *real_name);
179void GetOmissionName(char *dst, UINT size, char *src);
180bool IsOmissionName(char *input_name, char *real_name);
181TOKEN_LIST *GetRealnameCandidate(char *input_name, TOKEN_LIST *real_name_list);
182bool SeparateCommandAndParam(wchar_t *src, char **cmd, wchar_t **param);
183UINT GetConsoleWidth(CONSOLE *c);
184bool DispatchNextCmd(CONSOLE *c, char *prompt, CMD cmd[], UINT num_cmd, void *param);
185bool DispatchNextCmdEx(CONSOLE *c, wchar_t *exec_command, char *prompt, CMD cmd[], UINT num_cmd, void *param);
186void PrintCandidateHelp(CONSOLE *c, char *cmd_name, TOKEN_LIST *candidate_list, UINT left_space);
187UNI_TOKEN_LIST *SeparateStringByWidth(wchar_t *str, UINT width);
188void GetCommandHelpStr(char *command_name, wchar_t **description, wchar_t **args, wchar_t **help);
189void GetCommandParamHelpStr(char *command_name, char *param_name, wchar_t **description);
190bool CmdEvalMinMax(CONSOLE *c, wchar_t *str, void *param);
191wchar_t *CmdPrompt(CONSOLE *c, void *param);
192bool CmdEvalNotEmpty(CONSOLE *c, wchar_t *str, void *param);
193bool CmdEvalInt1(CONSOLE *c, wchar_t *str, void *param);
194bool CmdEvalIsFile(CONSOLE *c, wchar_t *str, void *param);
195bool CmdEvalSafe(CONSOLE *c, wchar_t *str, void *param);
196void PrintCmdHelp(CONSOLE *c, char *cmd_name, TOKEN_LIST *param_list);
197int CompareCandidateStr(void *p1, void *p2);
198bool IsHelpStr(char *str);
199
200CONSOLE *NewLocalConsole(wchar_t *infile, wchar_t *outfile);
201void ConsoleLocalFree(CONSOLE *c);
202wchar_t *ConsoleLocalReadLine(CONSOLE *c, wchar_t *prompt, bool nofile);
203char *ConsoleLocalReadPassword(CONSOLE *c, wchar_t *prompt);
204bool ConsoleLocalWrite(CONSOLE *c, wchar_t *str);
205void ConsoleWriteOutFile(CONSOLE *c, wchar_t *str, bool add_last_crlf);
206wchar_t *ConsoleReadNextFromInFile(CONSOLE *c);
207UINT ConsoleLocalGetWidth(CONSOLE *c);
208
209
210#endif  // CONSOLE_H
211
212
213
Note: See TracBrowser for help on using the repository browser.