update document

diff --git a/doc/API b/doc/API
index f3b88756bc6a4bb93f147166c7371bc5a4a38013..af764d64e0e2e7202cc5bbd568e9b0b788396d48 100644 (file)
--- a/doc/API
+++ b/doc/API
@@ -1,13 +1,19 @@
-Oniguruma API  Version 5.9.2  2008/02/19
+Oniguruma API  Version 6.0.0  2016/04/05
 
 #include <oniguruma.h>
 
 
-# int onig_init(void)
+# int onig_initialize(OnigEncoding use_encodings[], int num_encodings)
 
   Initialize library.
 
-  You don't have to call it explicitly, because it is called in onig_new().
+  You have to call it explicitly.
+
+  * onig_init() is deprecated.
+
+  arguments
+  1 use_encodings:         array of encodings used in application.
+  2 num_encodings:         number of encodings.
 
 
 # int onig_error_code_to_str(UChar* err_buf, int err_code, ...)

diff --git a/doc/API.ja b/doc/API.ja
index f681fa546089190dd35552972c87592b65eb8ea3..88e3f8dbb49a88ff3538141e92aab246aadbdc35 100644 (file)
--- a/doc/API.ja
+++ b/doc/API.ja
@@ -1,13 +1,18 @@
-µ´¼Ö¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹ Version 5.9.2   2008/02/19
+µ´¼Ö¥¤¥ó¥¿¡¼¥Õ¥§¡¼¥¹ Version 6.0.0   2016/04/06
 
 #include <oniguruma.h>
 
 
-# int onig_init(void)
+# int onig_initialize(OnigEncoding use_encodings[], int num_encodings)
 
   ¥é¥¤¥Ö¥é¥ê¤Î½é´ü²½
+  ºÇ½é¤Ë¸Æ¤Ó½Ð¤¹É¬Íפ¬¤¢¤ë¡£
 
-  onig_new()¤ÎÃæ¤Ç¸Æ¤Ó½Ð¤µ¤ì¤ë¤Î¤Ç¡¢¤³¤Î´Ø¿ô¤òÌÀ¼¨Åª¤Ë¸Æ¤Ó½Ð¤µ¤Ê¤¯¤Æ¤â¤è¤¤¡£
+  * onig_init() ¤ÏÇÑ»ß
+
+  °ú¿ô
+  1 use_encodings:         »ÈÍѤ¹¤ëʸ»ú¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤ÎÇÛÎó
+  2 num_encodings:         ʸ»ú¥¨¥ó¥³¡¼¥Ç¥£¥ó¥°¤Î¿ô
 
 
 # int onig_error_code_to_str(UChar* err_buf, int err_code, ...)

diff --git a/doc/FAQ b/doc/FAQ
index 46a3e0e08b7d86a8fd40ceea7235d922ab6ce20d..c00f0304537eeb268cdc8362199211e901844b6b 100644 (file)
--- a/doc/FAQ
+++ b/doc/FAQ
@@ -5,32 +5,7 @@ FAQ    2006/11/14
    You can execute longest match by using ONIG_OPTION_FIND_LONGEST option
    in onig_new().
 
-
-2. Thread safe
-
-   In order to make thread safe, which of (A) or (B) must be done.
-
-   (A) Oniguruma Layer
-
-       Define the macro below in oniguruma/regint.h.
-
-       USE_MULTI_THREAD_SYSTEM
-       THREAD_ATOMIC_START
-       THREAD_ATOMIC_END
-       THREAD_PASS
-
-       THREAD_SYSTEM_INIT
-       THREAD_SYSTEM_END
-
-
-   (B) Application Layer
-
-       The plural threads should not do simultaneously that making 
-       new regexp objects or re-compiling objects or freeing objects,
-       even if these objects are differ.
-
-
-3. Mailing list
+2. Mailing list
 
    There is no mailing list about Oniguruma.
 

diff --git a/doc/FAQ.ja b/doc/FAQ.ja
index 1d65f9fb62753668353969fd76734381ad8cd543..b8f4aa92d861e91f6b19aac0af567f71604a1d73 100644 (file)
--- a/doc/FAQ.ja
+++ b/doc/FAQ.ja
@@ -1,4 +1,4 @@
-FAQ    2007/07/23
+FAQ    2016/04/06
 
 1. ºÇĹ¥Þ¥Ã¥Á
 
@@ -6,36 +6,7 @@ FAQ    2007/07/23
    ¤ò»ÈÍѤ¹¤ì¤ÐºÇĹ¥Þ¥Ã¥Á¤Ë¤Ê¤ë¡£
 
 
-2. ¥¹¥ì¥Ã¥É¥»¡¼¥Õ
-
-   ¥¹¥ì¥Ã¥É¥»¡¼¥Õ¤Ë¤¹¤ë¤Ë¤Ï¡¢°Ê²¼¤Î(A)¤È(B)¤Î¤É¤Á¤é¤«¤ò¹Ô¤Ê¤¨¤Ð
-   ¤è¤¤¡£
-
-   (A) Oniguruma Layer
-
-       oniguruma/regint.h¤ÎÃæ¤Î°Ê²¼¤Î¥Þ¥¯¥í¤òÄêµÁ¤¹¤ë¡£
-
-       USE_MULTI_THREAD_SYSTEM
-       THREAD_ATOMIC_START
-       THREAD_ATOMIC_END
-       THREAD_PASS
-
-       ²¿¤é¤«¤Î½é´ü²½/½ªÎ»½èÍý¤¬É¬ÍפǤ¢¤ì¤Ð¡¢°Ê²¼¤Î¥Þ¥¯¥í¤ËÄêµÁ¤¹¤ë¡£
-       THREAD_SYSTEM_INIT
-       THREAD_SYSTEM_END
-
-
-   (B) Application Layer
-
-       Ʊ»þ¤ËÊ£¿ô¤Î¥¹¥ì¥Ã¥É¤¬¡¢Àµµ¬É½¸½¥ª¥Ö¥¸¥§¥¯¥È¤òºîÀ®¤¹¤ë¡¢
-       ¤Þ¤¿¤Ï²òÊü¤¹¤ë¡¢¤³¤È¤ò¹Ô¤Ê¤Ã¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£
-       ¤½¤ì¤é¤Î¥ª¥Ö¥¸¥§¥¯¥È¤¬Á´¤¯Ê̤Τâ¤Î¤Ç¤¢¤Ã¤Æ¤â¡£
-
-   ¤â¤¦¾¯¤·¾Ü¤·¤¤ÀâÌÀ¤Ï¡¢¤³¤Î¥É¥­¥å¥á¥ó¥È¤ÎÃæ¤Î
-   "¥¹¥ì¥Ã¥É¥»¡¼¥Õ¤Ë´Ø¤¹¤ëÊä­"¤Ë½ñ¤¤¤Æ¤ª¤¤¤¿¡£
-
-
-3. CR + LF
+2. CR + LF
 
    DOS¤Î²þ¹Ô(CR(0x0c) + LF(0x0a)¤ÎϢ³)
 
@@ -44,87 +15,8 @@ FAQ    2007/07/23
      /* #define USE_CRNL_AS_LINE_TERMINATOR */
 
 
-4. ¥á¡¼¥ê¥ó¥°¥ê¥¹¥È
+3. ¥á¡¼¥ê¥ó¥°¥ê¥¹¥È
 
    µ´¼Ö¤Ë´Ø¤¹¤ë¥á¡¼¥ê¥ó¥°¥ê¥¹¥È¤Ï¸ºß¤·¤Ê¤¤¡£
 
 //END
-
-
-
-¥¹¥ì¥Ã¥É¥»¡¼¥Õ¤Ë´Ø¤¹¤ëÊä­
-
-¥¹¥ì¥Ã¥É¥»¡¼¥Õ¤Ë¤¹¤ë¤Ë¤Ï¡¢¸ÄÊ̤Υ¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ÎÃæ¤Ç¹Ô¤¦¤«¡¢
-Oniguruma¥é¥¤¥Ö¥é¥ê¤ÎÃæ¤Ç¹Ô¤¦¤«¡¢¤É¤Á¤é¤«¤òÁª¤Ö¤³¤È¤¬¤Ç¤­¤Þ¤¹¡£
-(Oniguruma¤ò»ÈÍѤ¹¤ë¦¤ÇÂн褹¤ë¤«¡¢Oniguruma¤ËÂн褵¤»¤ë¤«
-¤É¤Á¤é¤«ÊÒÊý¤Ç¹Ô¤¦É¬Íפ¬¤¢¤ë¤È¤¤¤¦¤³¤È¤Ç¤¹¡£)
-
-¤³¤ì¤é¤ÎÊýË¡¤Ë¤Ä¤¤¤Æ¡¢°Ê²¼(A)¤È(B)¤ÇÀâÌÀ¤·¤Þ¤¹¡£
-
-¥Þ¥ë¥Á¥¹¥ì¥Ã¥ÉAPI¤Ï¡¢¤½¤ì¤¾¤ì¤Î¥×¥é¥Ã¥È¥Õ¥©¡¼¥à¤Ë¤è¤Ã¤Æ¤â
-°Û¤Ê¤ê¤Þ¤¹¤Î¤Ç¡¢°Ê²¼¤ÎÀâÌÀ¤ÎÃæ¤Ç¶ñÂÎŪ¤Ë²¿¤ò¸Æ¤Ö¤Î¤«¤ò
-½ñ¤¯¤³¤È¤Ï̵Íý¤Ç¤¹¡£¼ÂºÝ¤Ë»ÈÍѤµ¤ì¤ë¥Þ¥ë¥Á¥¹¥ì¥Ã¥ÉAPI¤Ç¡¢
-Âбþ¤¹¤ëµ¡Ç½¤Î¤â¤Î¤ò»ØÄꤷ¤Æ¤¯¤À¤µ¤¤¡£
-
-(A) Oniguruma¤ÎÃæ¤ÇÂбþ¤¹¤ë¾ì¹ç
-
-oniguruma/regint.h¤ÎÃæ¤Ç°Ê²¼¤Î¥Þ¥¯¥í¤òÄêµÁ¤·¤ÆºÆ¥³¥ó¥Ñ¥¤¥ë¤·¤Æ¤¯¤À¤µ¤¤¡£
-
-USE_MULTI_THREAD_SYSTEM
-
-  ñ¤ËÍ­¸ú¤Ë¤¹¤ì¤Ð¤è¤¤¤Ç¤¹¡£
-
-THREAD_ATOMIC_START
-THREAD_ATOMIC_END
-
-  THREAD_ATOMIC_START¤«¤éTHREAD_ATOMIC_END¤Ç°Ï¤Þ¤ì¤¿
-  ¥×¥í¥°¥é¥à¤Î¥³¡¼¥ÉÉôʬ¤ò¤¢¤ë¥¹¥ì¥Ã¥É¤¬¼Â¹ÔÃæ¤Ë¡¢Â¾¤Î
-  ¥¹¥ì¥Ã¥É¤Ë¼Â¹Ô¸¢¤¬°ÜÆ°¤·¤Ê¤¤¤³¤È¤òÊݾ㤹¤ë¤â¤Î¤ËÄêµÁ
-  ¤·¤Æ¤¯¤À¤µ¤¤¡£
-  (̾Á°¤ÎÄ̤ꡢ°Ï¤Þ¤ì¤¿¥³¡¼¥ÉÉôʬ¤ò¥¹¥ì¥Ã¥É¥¢¥È¥ß¥Ã¥¯¤Ë
-   ¤¹¤ë¤È¤¤¤¦°ÕÌ£)
-
-THREAD_PASS
-
-  ¤³¤ì¤ò¼Â¹Ô¤·¤¿¥¹¥ì¥Ã¥É¤«¤é¡¢Â¾¤Î¥¹¥ì¥Ã¥É¤Ë¼Â¹Ô¸¢¤ò°Ñ¾ù
-  ¤¹¤ë¤â¤Î¤ËÄêµÁ¤ò¤·¤Æ¤¯¤À¤µ¤¤¡£(ºÆ¥¹¥±¥¸¥å¡¼¥ë¤ò¸Æ¤Ó½Ð¤¹
-  ¤È¤¤¤¦°ÕÌ£)
-  Âбþ¤¹¤ëµ¡Ç½¤¬Á´¤¯¤Ê¤±¤ì¤Ð¡¢¶õÄêµÁ¤Ë¤·¤Æ¤¯¤À¤µ¤¤¡£
-
-(»²¹ÍÎã)
-Ruby¤Î¾ì¹ç¤òÎã¤Ë¤¹¤ë¤È¡¢
-Ruby¤Ï¼«Ê¬¼«¿È¤ÇÆȼ«¤Î¥¹¥ì¥Ã¥Éµ¡Ç½¤ò¼ÂÁõ¤·¤Æ¤¤¤Þ¤¹¡£
-¤½¤Îµ¡Ç½¤ò»ÈÍѤ¹¤ë¤È¡¢°Ê²¼¤Î¤è¤¦¤ËÄêµÁ¤¹¤ì¤Ð¤è¤¤¤³¤È¤Ë
-¤Ê¤ê¤Þ¤¹¡£
-
-#define USE_MULTI_THREAD_SYSTEM
-#define THREAD_SYSTEM_INIT
-#define THREAD_SYSTEM_END
-#define THREAD_ATOMIC_START       DEFER_INTS
-#define THREAD_ATOMIC_END         ENABLE_INTS
-#define THREAD_PASS               rb_thread_schedule()
-
-Ruby¤Î¾ì¹ç¡¢¥¿¥¤¥Þ³ä¤ê¹þ¤ß¤ò»ÈÍѤ·¤Æ¡¢¥¹¥ì¥Ã¥É¤ÎÀÚ¤êÂؤ¨¤ò
-¹Ô¤Ã¤Æ¤¤¤Þ¤¹¡£DEFER_INTS¤Ï³ä¤ê¹þ¤ß¥Ï¥ó¥É¥é¤Î¼Â¹Ô¤ò°ì»þŪ¤Ë
-»ß¤á¤ë¤¿¤á¤Î¥Þ¥¯¥í¤Ç¤¹¡£ENABLE_INTS¥Þ¥¯¥í¤Ç³ä¤ê¹þ¤ß¥Ï¥ó¥É¥é
-¤Î¼Â¹Ô¤òµö²Ä¤·¤Þ¤¹¡£
-¤³¤ì¤Ë¤è¤Ã¤Æ¡¢THREAD_ATOMIC_START¤«¤éTHREAD_ATOMIC_END
-¤Ç°Ï¤Þ¤ì¤¿Éôʬ¤Î¼Â¹ÔÃæ¤Ë¡¢Â¾¤Î¥¹¥ì¥Ã¥É¤Ë¼Â¹Ô¸¢¤¬°ÜÆ°¤·¤Þ¤»¤ó¡£
-
-
-(B) ¥¢¥×¥ê¥±¡¼¥·¥ç¥ó¤ÎÃæ¤ÇÂбþ¤¹¤ë¾ì¹ç
-
-°Ê²¼¤òÊݾ㤹¤ë¤è¤¦¤Ë¡¢¥¹¥ì¥Ã¥É¤Î¼Â¹Ô¤òÀ©¸æ¤·¤Æ¤¯¤À¤µ¤¤¡£
-
-Ʊ»þ¤ËÊ£¿ô¤Î¥¹¥ì¥Ã¥É¤¬¡¢Àµµ¬É½¸½¥ª¥Ö¥¸¥§¥¯¥È¤òºîÀ®¤¹¤ë¡¢¤Þ¤¿¤Ï²òÊü¤¹¤ë¡¢¤³¤È¤ò
-¹Ô¤Ê¤Ã¤Æ¤Ï¤Ê¤é¤Ê¤¤¡£¤½¤ì¤é¤Î¥ª¥Ö¥¸¥§¥¯¥È¤¬Á´¤¯Ê̤Τâ¤Î¤Ç¤¢¤Ã¤Æ¤â¡£
-
-onig_new(), onig_new_deluxe(), onig_free()¤Î¤É¤ì¤«¤Î¸Æ¤Ó½Ð¤·¤ò¡¢
-Ê£¿ô¤Î¥¹¥ì¥Ã¥É¤¬Æ±»þ¤Ë¼Â¹Ô¤¹¤ë¤³¤È¤òÈò¤±¤Æ¤¯¤À¤µ¤¤¡£Æ±»þ¤Ç¤Ê¤±¤ì¤ÐÊ̤ˤ«¤Þ¤¤¤Þ¤»¤ó¡£
-
-¤³¤ì¤Ï²¿¸ÎɬÍפʤΤ«¤È¤¤¤¦¤È¡¢Àµµ¬É½¸½¥ª¥Ö¥¸¥§¥¯¥È¤òºîÀ®¤¹¤ë
-²áÄø¤Ç¡¢ÆâÉô¤Ç¶¦Ä̤˻²¾È¤¹¤ë¥Æ¡¼¥Ö¥ë¤¬¤¢¤ê¤Þ¤¹¡£
-¤³¤Î¥Æ¡¼¥Ö¥ë¤ËÂФ·¤Æ¤Î¥Ç¡¼¥¿ÅÐÏ¿½èÍý¤¬Ê£¿ô¤Î¥¹¥ì¥Ã¥É¤Ç¾×Æͤ·¤Æ
-°Û¾ï¤Ê¾õÂ֤ˤʤé¤Ê¤¤¤¿¤á¤ËɬÍפǤ¹¡£
-
-// END