OpenSOAP: String.h Source File

00001 /* -*- mode: c++; -*-
00002  *-----------------------------------------------------------------------------
00003  * $RCSfile: String.h,v $
00004  *
00005  * See Copyright for the status of this software.
00006  *
00007  * The OpenSOAP Project
00008  * http://opensoap.jp/
00009  *-----------------------------------------------------------------------------
00010  */ void *opt, wchar_t c, int *judge)
00359       * @brief Find String Function Pointer Type Definition
00360       * @param
00361       *    opt void * [in] Find Function Option 
00362       * @param
00363       *    c wchar_t [in] 
00364       * @param
00365       *    judge int * [out] Result
00366       * @return
00367       *    エラーコード
00368       */
00531 #ifndef OpenSOAP_String_H
00532 #define OpenSOAP_String_H
00533 
00534 #include <OpenSOAP/ByteArray.h>
00535 #include <stdarg.h>
00536 
00537 #ifdef __cplusplus
00538 extern "C" {
00539 #endif /* __cplusplus */
00540 
00541     typedef struct tagOpenSOAPString OpenSOAPString;
00542 
00543     typedef OpenSOAPString    *OpenSOAPStringPtr;
00544 
00545 
00546     int
00547     OPENSOAP_API
00548     OpenSOAPStringCreate(/* [out] */ OpenSOAPStringPtr *str);
00549     
00550     int
00551     OPENSOAP_API
00552     OpenSOAPStringCreateWithMB(/* [in]  */ const char *mb_str,
00553                                /* [out] */ OpenSOAPStringPtr *str);
00554 
00555     int
00556     OPENSOAP_API
00557     OpenSOAPStringCreateWithWC(/* [in]  */ const wchar_t *wc_str,
00558                                /* [out] */ OpenSOAPStringPtr *str);
00559 
00560     int
00561     OPENSOAP_API
00562     OpenSOAPStringCreateWithCharEncodingString(/* [in]  */ const char * char_enc,
00563                                                /* [in]  */ OpenSOAPByteArrayPtr char_enc_str,
00564                                                /* [out] */ OpenSOAPStringPtr *str);
00565 
00566     int
00567     OPENSOAP_API
00568     OpenSOAPStringCreateWithUTF8(/* [in]  */ const char *utf8Str,
00569                                  /* [out] */ OpenSOAPStringPtr *str);
00570 
00571     int
00572     OPENSOAP_API
00573     OpenSOAPStringRetain(/* [in] */ OpenSOAPStringPtr str);
00574 
00575     int
00576     OPENSOAP_API
00577     OpenSOAPStringRelease(/* [in] */ OpenSOAPStringPtr str);
00578 
00579     int
00580     OPENSOAP_API
00581     OpenSOAPStringGetLengthMB(/* [in]  */ OpenSOAPStringPtr str,
00582                               /* [out] */ size_t *len);
00583         
00584     int
00585     OPENSOAP_API
00586     OpenSOAPStringGetLengthWC(/* [in]  */ OpenSOAPStringPtr str,
00587                               /* [out] */ size_t *len);
00588 
00589     int
00590     OPENSOAP_API
00591     OpenSOAPStringGetStringMBWithAllocator(/* [in]  */ OpenSOAPStringPtr str,
00592                                            /* [in]  */ char * (*memAllocator)(size_t),
00593                                            /* [out] */ size_t *len,
00594                                            /* [out] */ char **mbStr);
00595 
00596     int
00597     OPENSOAP_API
00598     OpenSOAPStringGetStringWCWithAllocator(/* [in]  */ OpenSOAPStringPtr str,
00599                                            /* [in]  */ wchar_t * (*memAllocator)(size_t),
00600                                            /* [out] */ size_t *len,
00601                                            /* [out] */ wchar_t **wcStr);
00602 
00603     int
00604     OPENSOAP_API
00605     OpenSOAPStringGetStringUTF8WithAllocator(/* [in]  */ OpenSOAPStringPtr str,
00606                                              /* [in]  */ char * (*memAllocator)(size_t),
00607                                              /* [out] */ size_t *len,
00608                                              /* [out] */ char **utf8Str);
00609 
00610     int
00611     OPENSOAP_API
00612     OpenSOAPStringGetStringMB(/* [in]      */ OpenSOAPStringPtr str,
00613                               /* [in, out] */ size_t *len,
00614                               /* [out]     */ char * mb_Str);
00615         
00616     int
00617     OPENSOAP_API
00618     OpenSOAPStringGetStringWC(/* [in]      */ OpenSOAPStringPtr str,
00619                               /* [in, out] */ size_t *len,
00620                               /* [out]     */ wchar_t *wc_str);
00621 
00622     int
00623     OPENSOAP_API
00624     OpenSOAPStringGetCharEncodingString(/* [in]  */ OpenSOAPStringPtr str,
00625                                         /* [in]  */ const char *char_enc,
00626                                         /* [out] */ OpenSOAPByteArrayPtr char_enc_str);
00627     
00628     int
00629     OPENSOAP_API
00630     OpenSOAPStringSetStringMB(/* [in] */ OpenSOAPStringPtr str,
00631                               /* [in] */ const char *mb_str);
00632         
00633     int
00634     OPENSOAP_API
00635     OpenSOAPStringSetStringWC(/* [in] */ OpenSOAPStringPtr str,
00636                               /* [in] */ const wchar_t *wc_str);
00637 
00638     int
00639     OPENSOAP_API
00640     OpenSOAPStringSetCharEncodingString(/* [out] */ OpenSOAPStringPtr str,
00641                                         /* [in]  */ const char *char_enc,
00642                                         /* [in]  */ OpenSOAPByteArrayPtr charEncStr);
00643 
00644     int
00645     OPENSOAP_API
00646     OpenSOAPStringSetStringUTF8(/* [out] */ OpenSOAPStringPtr str,
00647                                 /* [in]  */ const char *utf8Str);
00648 
00649     int
00650     OPENSOAP_API
00651     OpenSOAPStringFormatMB(/* [out] */ OpenSOAPStringPtr str,
00652                            /* [in]  */ const char *format, ...);
00653 
00654     int
00655     OPENSOAP_API
00656     OpenSOAPStringFormatWC(/* [out] */ OpenSOAPStringPtr str,
00657                            /* [in]  */ const wchar_t *format, ...);
00658 
00659     int
00660     OPENSOAP_API
00661     OpenSOAPStringVFormatMB(/* [out] */ OpenSOAPStringPtr str,
00662                                                         /* [in]  */ const char *format,
00663                                                         /* [in]  */ va_list ap);
00664 
00665     int
00666     OPENSOAP_API
00667     OpenSOAPStringVFormatWC(/* [out] */ OpenSOAPStringPtr str,
00668                                                         /* [in]  */ const wchar_t *format,
00669                                                         /* [in]  */ va_list ap);
00670 
00671     int
00672     OPENSOAP_API
00673     OpenSOAPStringCompareMB(/* [in]  */ OpenSOAPStringPtr str,
00674                             /* [in]  */ const char *cmp_str,
00675                             /* [out] */ int *cmp_rslt);
00676 
00677     int
00678     OPENSOAP_API
00679     OpenSOAPStringCompareWC(/* [in]  */ OpenSOAPStringPtr str,
00680                             /* [in]  */ const wchar_t *cmp_str,
00681                             /* [out] */ int *cmp_rslt);
00682 
00683     int
00684     OPENSOAP_API
00685     OpenSOAPStringCompare(/* [in]  */ OpenSOAPStringPtr str,
00686                           /* [in]  */ OpenSOAPStringPtr cmp_str,
00687                           /* [out] */ int *cmp_rslt);
00688 
00689     int
00690     OPENSOAP_API
00691     OpenSOAPStringFindStringMB(/* [in]      */ OpenSOAPStringPtr str,
00692                                /* [in]      */ const char *find_str,
00693                                /* [in, out] */ size_t *idx);
00694 
00695     int
00696     OPENSOAP_API
00697     OpenSOAPStringFindStringWC(/* [in]      */ OpenSOAPStringPtr str,
00698                                /* [in]      */ const wchar_t *find_str,
00699                                /* [in, out] */ size_t *idx);
00700 
00701     int
00702     OPENSOAP_API
00703     OpenSOAPStringFindString(/* [in]      */ OpenSOAPStringPtr str,
00704                              /* [in]      */ OpenSOAPStringPtr find_str,
00705                              /* [in, out] */ size_t *idx);
00706 
00707     typedef int
00708     (*OpenSOAPStringFindIfFunc)(/* [in, out] */ void *opt,
00709                                 /* [in]      */ wchar_t c,
00710                                 /* [out]     */ int *judge);
00711         
00712     extern
00713     int
00714     OPENSOAP_API
00715     OpenSOAPStringFindIfStringIndex(/* [in]  */ OpenSOAPStringPtr str,
00716                                     /* [in]  */ OpenSOAPStringFindIfFunc find_func,
00717                                     /* [in]  */ void *find_func_opt,
00718                                     /* [in, out] */ size_t *idx);
00719     int
00720     OPENSOAP_API
00721     OpenSOAPStringReplaceStringMB(/* [in, out] */ OpenSOAPStringPtr str,
00722                                   /* [in]      */ const char *find_str,
00723                                   /* [in]      */ const char *rplc_str,
00724                                   /* [in, out] */ size_t *idx);
00725     
00726     int
00727     OPENSOAP_API
00728     OpenSOAPStringReplaceStringWC(/* [in, out] */ OpenSOAPStringPtr str,
00729                                   /* [in]      */ const wchar_t *find_str,
00730                                   /* [in]      */ const wchar_t *rplc_str,
00731                                   /* [in, out] */ size_t *idx);
00732     
00733     int
00734     OPENSOAP_API
00735     OpenSOAPStringReplaceString(/* [in, out] */ OpenSOAPStringPtr str,
00736                                 /* [in]      */ OpenSOAPStringPtr find_str,
00737                                 /* [in]      */ OpenSOAPStringPtr rplc_str,
00738                                 /* [in, out] */ size_t *idx);
00739     
00740     int
00741     OPENSOAP_API
00742     OpenSOAPStringClear(/* [out] */ OpenSOAPStringPtr str);
00743 
00744     int
00745     OPENSOAP_API
00746     OpenSOAPStringAppendMB(/* [out] */ OpenSOAPStringPtr str,
00747                            /* [in]  */ const char *mb_str,
00748                            /* [in]  */ size_t mb_len);
00749 
00750     int
00751     OPENSOAP_API
00752     OpenSOAPStringAppendWC(/* [out] */ OpenSOAPStringPtr str,
00753                            /* [in]  */ const wchar_t *wc_str,
00754                            /* [in]  */ size_t wc_len);
00755 
00756     int
00757     OPENSOAP_API
00758     OpenSOAPStringDuplicate(/* [in]  */ OpenSOAPStringPtr str,
00759                             /* [out] */ OpenSOAPStringPtr *dup_str);
00760 
00761     int
00762     OPENSOAP_API
00763     OpenSOAPStringGetSubstring(/* [in]  */ OpenSOAPStringPtr str,
00764                                /* [in]  */ size_t   beg,
00765                                /* [in]  */ size_t   len,
00766                                /* [out] */ OpenSOAPStringPtr *sub_str);
00767 
00768     int
00769     OPENSOAP_API
00770     OpenSOAPStringConvertCharEncoding(/* [in]  */ const char *from_enc,
00771                                       /* [in]  */ OpenSOAPByteArrayPtr from_str,
00772                                       /* [in]  */ const char *to_enc,
00773                                       /* [out] */ OpenSOAPByteArrayPtr to_str);
00774 
00775     int
00776     OPENSOAP_API
00777     OpenSOAPStringConvertXMLCharRefToUTF8(/* [in]  */ const unsigned char *utf8Beg,
00778                                           /* [out] */ OpenSOAPByteArrayPtr utf8BAry);
00779     int
00780     OPENSOAP_API
00781     OpenSOAPStringGetStringUSASCII(/* [in]  */ OpenSOAPStringPtr str,
00782                                    /* [out] */ OpenSOAPByteArrayPtr charEncStr);
00783 
00784     int
00785     OPENSOAP_API
00786     OpenSOAPStringIterateProc(/* [in]  */ OpenSOAPStringPtr str,
00787                               /* [in]  */ int (*iterateProc)(unsigned long c, size_t idx, size_t len, void *opt),
00788                               /* [in]  */ int (*beforeProc)(size_t len, void *opt),
00789                               /* [in]  */ int (*afterProc)(size_t len, void *opt),
00790                               /* [in, out] */ void *opt);
00791         
00792 #ifdef __cplusplus
00793 }
00794 #endif /* __cplusplus */
00795 
00796 #endif /* OpenSOAP_String_H */