OSDN Git Service

update libMiMic
[mimic/MiMicSDK.git] / lib / src / http / NyLPC_cHttpBasicHeaderParser.h
index 42d23c3..93372df 100644 (file)
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.\r
  *\r
  * For further information please contact.\r
- *     http://nyatla.jp/\r
- *     <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
+ *  http://nyatla.jp/\r
+ *  <airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>\r
  *\r
  *********************************************************************************/\r
 \r
-#ifndef NyLPC_TcHttpBasicHeader_H\r
-#define NyLPC_TcHttpBasicHeader_H\r
+#ifndef NyLPC_TcHttpBasicHeaderParser_H\r
+#define NyLPC_TcHttpBasicHeaderParser_H\r
 #include "NyLPC_stdlib.h"\r
 #include "NyLPC_cHttpStream.h"\r
 \r
+#ifdef __cplusplus\r
+extern "C" {\r
+#endif /* __cplusplus */\r
+\r
+/**\r
+ * HeaderParserのステータス定義値。\r
+ */\r
+typedef NyLPC_TUInt8 NyLPC_TcHttpBasicHeaderParser_ST;\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_START                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x01)//HTTPステータスラインか、リクエストライン\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_RL_URL                 ((NyLPC_TcHttpBasicHeaderParser_ST)0x12)//URL\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_RL_VERSION             ((NyLPC_TcHttpBasicHeaderParser_ST)0x13)//VERSION\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_SL_STATUSCODE          ((NyLPC_TcHttpBasicHeaderParser_ST)0x21)//ステータスコード\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_SL_REASON              ((NyLPC_TcHttpBasicHeaderParser_ST)0x22)//Reason-Phrase\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSGHEAD                ((NyLPC_TcHttpBasicHeaderParser_ST)0x31)//MESSAGE\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSGPARAM               ((NyLPC_TcHttpBasicHeaderParser_ST)0x32)//MESSAGEパラメータ部\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONTENTLENGTH      ((NyLPC_TcHttpBasicHeaderParser_ST)0x33)//MESSAGEContentLength\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_CONNECTION         ((NyLPC_TcHttpBasicHeaderParser_ST)0x34)//MESSAGEConnection\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_TRANSFERENCODING   ((NyLPC_TcHttpBasicHeaderParser_ST)0x35)//TransferEncoding\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_MSG_RANGE              ((NyLPC_TcHttpBasicHeaderParser_ST)0x36)//Range\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_EOH                    ((NyLPC_TcHttpBasicHeaderParser_ST)0x7F)//終わり\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_ERROR                  ((NyLPC_TcHttpBasicHeaderParser_ST)0x80)//終わり\r
+/*\r
+    プライベート関数\r
+*/\r
+#define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)\r
+\r
+\r
+\r
 /**\r
  * このクラスは、Httpヘッダのパーサを定義します。\r
  */\r
@@ -39,18 +67,25 @@ typedef struct NyLPC_TcHttpBasicHeaderParser NyLPC_TcHttpBasicHeaderParser_t;
  * HTTPメソッドの定義値。\r
  */\r
 typedef NyLPC_TUInt8 NyLPC_THttpMethodType;\r
-#define NyLPC_THttpMethodType_GET                      ((NyLPC_THttpMethodType)0x01)\r
-#define NyLPC_THttpMethodType_POST                     ((NyLPC_THttpMethodType)0x02)\r
-#define NyLPC_THttpMethodType_HEAD                     ((NyLPC_THttpMethodType)0x03)\r
+//HTTP STANDARD\r
+#define NyLPC_THttpMethodType_NULL          ((NyLPC_THttpMethodType)0x00)\r
+#define NyLPC_THttpMethodType_GET           ((NyLPC_THttpMethodType)0x01)\r
+#define NyLPC_THttpMethodType_POST          ((NyLPC_THttpMethodType)0x02)\r
+#define NyLPC_THttpMethodType_HEAD          ((NyLPC_THttpMethodType)0x03)\r
+//SSDP\r
+#define NyLPC_THttpMethodType_M_SEARCH      ((NyLPC_THttpMethodType)0x11)\r
+#define NyLPC_THttpMethodType_NOTIFY        ((NyLPC_THttpMethodType)0x12)\r
+\r
+const char* NyLPC_THttpMethodType_toString(NyLPC_THttpMethodType i_method);\r
 \r
 /**\r
  * HTTPバージョンの定義値\r
  */\r
 typedef NyLPC_TUInt8 NyLPC_THttpVersion;\r
-#define NyLPC_THttpVersion_09          ((NyLPC_THttpVersion)0x01)\r
-#define NyLPC_THttpVersion_10          ((NyLPC_THttpVersion)0x02)\r
-#define NyLPC_THttpVersion_11          ((NyLPC_THttpVersion)0x03)\r
-#define NyLPC_THttpVersion_UNKNOWN     ((NyLPC_THttpVersion)0x04)\r
+#define NyLPC_THttpVersion_09       ((NyLPC_THttpVersion)0x01)\r
+#define NyLPC_THttpVersion_10       ((NyLPC_THttpVersion)0x02)\r
+#define NyLPC_THttpVersion_11       ((NyLPC_THttpVersion)0x03)\r
+#define NyLPC_THttpVersion_UNKNOWN  ((NyLPC_THttpVersion)0x04)\r
 \r
 \r
 typedef NyLPC_TUInt8 NyLPC_THttpHeaderType;\r
@@ -62,10 +97,11 @@ typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_Connection;
 #define NyLPC_THttpMessgeHeader_Connection_NONE  ((NyLPC_THttpMessgeHeader_Connection)0x01)\r
 #define NyLPC_THttpMessgeHeader_Connection_CLOSE ((NyLPC_THttpMessgeHeader_Connection)0x02)\r
 #define NyLPC_THttpMessgeHeader_Connection_KEEPALIVE ((NyLPC_THttpMessgeHeader_Connection)0x03)\r
+#define NyLPC_THttpMessgeHeader_Connection_UPGRADE ((NyLPC_THttpMessgeHeader_Connection)0x04)\r
 #define NyLPC_THttpMessgeHeader_Connection_UNKNOWN ((NyLPC_THttpMessgeHeader_Connection)0x10)\r
 \r
 typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;\r
-#define NyLPC_THttpMessgeHeader_TransferEncoding_NONE    ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01)      //TEはない\r
+#define NyLPC_THttpMessgeHeader_TransferEncoding_NONE    ((NyLPC_THttpMessgeHeader_TransferEncoding)0x01)   //TEはない\r
 #define NyLPC_THttpMessgeHeader_TransferEncoding_CHUNKED ((NyLPC_THttpMessgeHeader_TransferEncoding)0x02)\r
 #define NyLPC_THttpMessgeHeader_TransferEncoding_UNKNOWN ((NyLPC_THttpMessgeHeader_TransferEncoding)0x10)\r
 \r
@@ -80,20 +116,21 @@ typedef NyLPC_TUInt8 NyLPC_THttpMessgeHeader_TransferEncoding;
  */\r
 struct NyLPC_THttpBasicHeader\r
 {\r
-       NyLPC_THttpHeaderType type;\r
-       union{\r
-               struct{\r
-                       NyLPC_THttpVersion version;\r
-                       NyLPC_THttpMethodType method;\r
-               }req;\r
-               struct{\r
-                       NyLPC_THttpVersion version;\r
-                       NyLPC_TUInt32 status;\r
-               }res;\r
-       }startline;\r
-       NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;\r
-       NyLPC_TUInt32 content_length;\r
-       NyLPC_THttpMessgeHeader_Connection connection;\r
+    NyLPC_THttpMessgeHeader_TransferEncoding transfer_encoding;\r
+    NyLPC_THttpMessgeHeader_Connection connection;\r
+    NyLPC_THttpHeaderType type;\r
+    NyLPC_TUInt8 _padding;\r
+    union{\r
+        struct{\r
+            NyLPC_THttpVersion version;\r
+            NyLPC_THttpMethodType method;\r
+        }req;\r
+        struct{\r
+            NyLPC_THttpVersion version;\r
+            NyLPC_TUInt32 status;\r
+        }res;\r
+    }startline;\r
+    NyLPC_TUInt32 content_length;\r
 };\r
 \r
 /**\r
@@ -114,7 +151,6 @@ NyLPC_TBool NyLPC_THttpBasicHeader_isPersistent(const struct NyLPC_THttpBasicHea
 \r
 \r
 \r
-#define NyLPC_TcHttpBasicHeaderParser_ST_isError(i_v) ((i_v)==NyLPC_TcHttpBasicHeaderParser_ST_ERROR)\r
 \r
 /**\r
  * 独自のメッセージフィールドを受け取るイベントハンドラです。\r
@@ -136,47 +172,86 @@ typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_messageHandler) (NyLPC_TcHttp
  * <li>URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
  * </ol>\r
 */\r
-/**\r
-メッセージハンドラはNyLPC_cHttpBasicHeaderParserから3種類のメッセージを受け取ります。\r
-       1.URLメッセージ - i_cに\0以外の文字を指定して、URL値が入力されている事を指示します。\r
-       2.URLエンド - i_cに0を指定して、URLが完了した事を指示します。\r
-*/\r
 typedef NyLPC_TBool (*NyLPC_cHttpBasicHeaderParser_urlHandler) (NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TChar i_c,struct NyLPC_THttpBasicHeader* o_out);\r
 \r
 \r
 \r
+/**\r
+ * HTTPヘッダパーサハンドラの集合です。\r
+ * ハンドラにNULL指定の場合TRUEを返したと見なします。\r
+ */\r
 struct NyLPC_TcHttpBasicHeaderParser_Handler\r
 {\r
-       NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;\r
-       NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;\r
+    NyLPC_cHttpBasicHeaderParser_messageHandler messageHandler;\r
+    NyLPC_cHttpBasicHeaderParser_urlHandler urlHandler;\r
 };\r
 \r
 \r
 \r
 /**\r
-クラス構造体\r
-*/\r
+ * クラス構造体\r
+ */\r
 struct NyLPC_TcHttpBasicHeaderParser\r
 {\r
-       /**継承クラスで実装すべきインタフェイス*/\r
-       const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;\r
-       NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。\r
-       /**ワーク文字列*/\r
-       NyLPC_TcStr_t _wsb;\r
-       /**ワーク文字列のバッファ*/\r
-       char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];\r
+    /**継承クラスで実装すべきインタフェイス*/\r
+    const struct NyLPC_TcHttpBasicHeaderParser_Handler* _handler;\r
+    NyLPC_TUInt16 _rcode;//_stがERRORの時にエラーコードを格納する。\r
+    /** パースの実行状態*/\r
+    NyLPC_TcHttpBasicHeaderParser_ST _st;\r
+    /**ワーク文字列*/\r
+    NyLPC_TcStr_t _wsb;\r
+    /**ワーク文字列のバッファ*/\r
+    char _wsb_buf[NyLPC_cHttpBasicHeaderParser_SIZE_OF_WBS];\r
 };\r
 \r
 \r
-void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst);\r
+void NyLPC_cHttpBasicHeaderParser_initialize(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const struct NyLPC_TcHttpBasicHeaderParser_Handler* i_handler);\r
 #define NyLPC_cHttpBasicHeaderParser_finalize(i_inst)\r
 \r
-NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parse(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TcHttpStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);\r
+/**\r
+ * パーサの開始処理をします。\r
+ * 関数は、parseInit->parseChar[n回]->(parseStream)->parseFinishの順でコールします。\r
+ * parseChar、又はparseStreamでエラーが発生した場合は、後続の関数を呼び出すことは出来ません。\r
+ * parseCharでEOHに達した場合、parseCharまたはparseStreamを続けて呼ぶことは出来ません。\r
+ * parseFinishはparseCharまたはparseStreamでEOHに達した場合のみ呼び出すことが出来ます。\r
+ */\r
+void NyLPC_cHttpBasicHeaderParser_parseInit(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
+\r
+/**\r
+ * パーサの処理を閉じます。\r
+ * @return\r
+ * パース処理が正常に終了したかの真偽値\r
+ */\r
+NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseFinish(NyLPC_TcHttpBasicHeaderParser_t* i_inst,struct NyLPC_THttpBasicHeader* o_out);\r
+\r
+/**\r
+ * 文字列をパースします。\r
+ * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
+ * @return\r
+ * パースした文字数。エラーの場合-1です。\r
+ * 0以上の場合、getParseStatusでパーサの状態を確認してください。\r
+ */\r
+NyLPC_TInt32 NyLPC_cHttpBasicHeaderParser_parseChar(NyLPC_TcHttpBasicHeaderParser_t* i_inst,const NyLPC_TChar* i_c,NyLPC_TInt32 i_size,struct NyLPC_THttpBasicHeader* o_out);\r
+\r
+\r
+/**\r
+ * ストリームから読み出して、EOHに達するまでパースします。\r
+ * コール前にNyLPC_cHttpBasicHeaderParser_parseInitでパーサを開始してください。\r
+ * @return\r
+ * 処理が正常に終了したかを返します。\r
+ * TRUEの場合、ステータスはEOHに達しています。(parseFinishをコールできます。)\r
+ */\r
+NyLPC_TBool NyLPC_cHttpBasicHeaderParser_parseStream(NyLPC_TcHttpBasicHeaderParser_t* i_inst,NyLPC_TiHttpPtrStream_t* i_stream,struct NyLPC_THttpBasicHeader* o_out);\r
+\r
+\r
 /**\r
  * parse関数がエラーの場合に、\r
  * 候補のエラーのステータスコードを返す。\r
  */\r
 #define NyLPC_cHttpBasicHeaderParser_getStatusCode(inst) ((inst)->_rcode)\r
 \r
+#ifdef __cplusplus\r
+}\r
+#endif /* __cplusplus */\r
 \r
 #endif\r