From 2fe75426579b3459326c830879299b152bd6453e Mon Sep 17 00:00:00 2001
From: hyung-hwan <hyunghwan.chung@gmail.com>
Date: Fri, 20 Aug 2021 04:19:06 +0000
Subject: [PATCH] some comments in lib/mod-sys.c for pack and unpack

---
 hawk/lib/mod-str.c | 12 ++++--------
 hawk/lib/mod-sys.c | 30 ++++++++++++++++++++++++++++--
 2 files changed, 32 insertions(+), 10 deletions(-)

diff --git a/hawk/lib/mod-str.c b/hawk/lib/mod-str.c
index d9c08c61..ff4d120d 100644
--- a/hawk/lib/mod-str.c
+++ b/hawk/lib/mod-str.c
@@ -275,12 +275,10 @@ static int fnc_isxdigit (hawk_rtx_t* rtx, const hawk_fnc_info_t* fi)
 
 static int fnc_frombcharcode (hawk_rtx_t* rtx, const hawk_fnc_info_t* fi)
 {
-	/* create a string from a series of character codes.
-	 * create a character from a single character code.
-	 *  - str::fromcharcode(65) for 'A'
-	 *  - str::fromcharcode(65, 66, 67) for "ABC" */
-
-/* TODO: how to support byte string? */
+	/* create a byte-string from a series of character codes.
+	 * create a byte-character from a single character code.
+	 *  - str::frombcharcode(65) for 'A'
+	 *  - str::frombcharcode(65, 66, 67) for "ABC" */
 
 	hawk_val_t* retv;
 	hawk_oow_t nargs, i;
@@ -333,8 +331,6 @@ static int fnc_fromcharcode (hawk_rtx_t* rtx, const hawk_fnc_info_t* fi)
 	 *  - str::fromcharcode(65) for 'A'
 	 *  - str::fromcharcode(65, 66, 67) for "ABC" */
 
-/* TODO: how to support byte string? */
-
 	hawk_val_t* retv;
 	hawk_oow_t nargs, i;
 	hawk_oochu_t* ptr0; /* to guarantee the unsigned code conversion */
diff --git a/hawk/lib/mod-sys.c b/hawk/lib/mod-sys.c
index 9d654ae5..fc4d3124 100644
--- a/hawk/lib/mod-sys.c
+++ b/hawk/lib/mod-sys.c
@@ -4874,6 +4874,32 @@ struct st_pointer_t { hawk_uint8_t x; void* y; };
 #define AL_POINTER (HAWK_SIZEOF(struct st_pointer_t) - HAWK_SIZEOF(void*))
 #endif
 
+/*
+Byte-Order
+=	native
+<	little-endian
+>	big-endian
+!	network (= big-endian)
+
+b	qse_int8_t
+B	qse_uint8_t
+h	qse_int16_t
+H	qse_uint16_t
+i	qse_int32_t
+I	qse_uint32_t
+l	qse_int64_t
+L	qse_uint64_t
+q	qse_intmax_t
+Q	qse_uintmax_t
+n       qse_intptr_t
+N       qse_uintptr_t
+f	qse_flt_t (32 bits)
+d	qse_flt_t (64 bits)
+s	char[]	
+p	char[]	
+x	pad bytes
+*/
+
 static hawk_oow_t pack_uint16_t (hawk_uint8_t* dst, hawk_uint16_t val, int endian)
 {
 	if (endian == ENDIAN_LITTLE)
@@ -5067,7 +5093,7 @@ static hawk_int_t pack_data (hawk_rtx_t* rtx, const hawk_oocs_t* fmt, const hawk
 				break;
 			}
 
-			case 'h':
+			case 'h': /* 2 bytes signed */
 			{
 				hawk_int_t v;
 				PACK_CHECK_ARG_AND_BUF (rep_cnt, HAWK_SIZEOF(hawk_int16_t) * rep_cnt);
@@ -5079,7 +5105,7 @@ static hawk_int_t pack_data (hawk_rtx_t* rtx, const hawk_oocs_t* fmt, const hawk
 				break;
 			}
 
-			case 'H':
+			case 'H': /* 2 bytes unsigned */
 			{
 				hawk_int_t v;
 				PACK_CHECK_ARG_AND_BUF (rep_cnt, HAWK_SIZEOF(hawk_uint16_t) * rep_cnt);