p6i18n.h

Go to the documentation of this file.

#ifndef P6I18N_H__
#define P6I18N_H__ 1

#include "p6err.h"
#include "p6comdef.h"
#include "p6filetypes.h"


#ifdef  __cplusplus
namespace P6R {
extern "C" {
#endif

typedef enum
{
  NOOP       = 0x00,
  READ       = 0x01,
  WRITE      = 0x02,
  READWRITE  = 0x03,
  APPEND     = 0x04
} P6OPEN_MODE;


typedef P6UINT32 P6I18NFLAGS;
static const P6I18NFLAGS P6I18N_NOFLAGS = 0x00000000;


#undef INTERFACE
#define INTERFACE p6II18nFile
P6DECLAREIF_(p6II18nFile,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(initialize)(P6THIS_  P6I18NFLAGS flags, const P6CHAR* pLocale ) P6PURE;

   P6DECLCOMMETHOD(fopen)(P6THIS_  const P6WCHAR* pFilePath, P6FILEFLAGS operation, P6FILEMODE mode ) P6PURE;

   P6DECLCOMMETHOD(fclose)(P6THIS) P6PURE;

   P6DECLCOMMETHOD(fileFormatString)(P6THIS_  P6UINT32* pcWritten, const P6WCHAR* pszFormat, const P6ARG* pArgs, P6INT32 cArgs ) P6PURE;

   P6DECLCOMMETHOD(fgetwc)(P6THIS_  P6WCHAR* pWc ) P6PURE;

   P6DECLCOMMETHOD(fgetws)(P6THIS_  P6WCHAR* pDst, P6UINT32 dstSize ) P6PURE;

   P6DECLCOMMETHOD(fputwc)(P6THIS_  P6WCHAR wc ) P6PURE;

   P6DECLCOMMETHOD(fputws)(P6THIS_  P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(fwide)(P6THIS_  P6INT32 mode, P6INT32* result ) P6PURE;

   P6DECLCOMMETHOD(fgetUTF8)(P6THIS_  P6CHAR* pDst, P6UINT32 dstSize ) P6PURE;

   P6DECLCOMMETHOD(fputUTF8)(P6THIS_  P6CHAR* pUtf8 ) P6PURE;
};

 // {16CBE73E-8593-4fa4-BB8C-AD4B00A4654F}
#define IF_p6II18nFile  {0x16cbe73e,0x8593,0x4fa4,{0xbb,0x8c,0xad,0x4b,0x0,0xa4,0x65,0x4f}}

// {424D9BB3-33E6-41ee-BE1D-B1343DFDC651}
#define COMP_p6I18nFile {0x424d9bb3,0x33e6,0x41ee,{0xbe,0x1d,0xb1,0x34,0x3d,0xfd,0xc6,0x51}}



#undef INTERFACE
#define INTERFACE p6II18n
P6DECLAREIF_(p6II18n,p6ICom)
{
   P6DECLAREICOM
   P6DECLCOMMETHOD(initialize)(P6THIS_  P6I18NFLAGS flags, const P6CHAR* pLocale ) P6PURE;

   P6DECLCOMMETHOD(setLocale)(P6THIS_  const P6CHAR* pLocale ) P6PURE;

   P6DECLCOMMETHOD(getLocaleInUse)(P6THIS_  const P6CHAR** pLocale ) P6PURE;

   P6DECLCOMMETHOD(setCollation)(P6THIS_  const P6CHAR* pCollationName ) P6PURE;

   P6DECLCOMMETHOD(getCollationInUse)(P6THIS_  const P6CHAR** pCollationName ) P6PURE;


   // [A] Conversion Methods
   P6DECLCOMMETHOD(btowc)(P6THIS_  P6INT32 sc, P6WCHAR* pWc ) P6PURE;

   P6DECLCOMMETHOD(wctob)(P6THIS_  P6WCHAR wc, P6INT32* pSc ) P6PURE;

   P6DECLCOMMETHOD(wcstod)(P6THIS_  const P6WCHAR* pSrc, P6WCHAR** pEndPtr, P6FLOAT* pToDouble ) P6PURE;

   P6DECLCOMMETHOD(wcstol)(P6THIS_  const P6WCHAR* pSrc, P6WCHAR** pEndptr, P6INT32 base, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcstoul)(P6THIS_  const P6WCHAR* pSrc, P6WCHAR** pEndptr, P6INT32 base, P6UINT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcstoll)(P6THIS_  const P6WCHAR* pSrc, P6WCHAR** pEndptr, P6INT32 base, P6INT64* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcstoull)(P6THIS_  const P6WCHAR* pSrc, P6WCHAR** pEndptr, P6INT32 base, P6UINT64* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcsxfrm)(P6THIS_  P6WCHAR* pDst, const P6WCHAR* pSrc, P6UINT32 n, P6UINT32* pResultSize ) P6PURE;

   P6DECLCOMMETHOD(utf8ToWc)(P6THIS_  P6WCHAR* pDst, P6UINT32* pDstSize, const P6CHAR* pSrc, P6UINT32 srcSize ) P6PURE;

   P6DECLCOMMETHOD(utf8ToWcs)(P6THIS_  P6WCHAR* pDst, P6UINT32* pDstSize, const P6CHAR* pSrc ) P6PURE;

   P6DECLCOMMETHOD(utf8NToWcs)(P6THIS_  P6WCHAR* pDst, P6UINT32* pDstSize, const P6CHAR* pSrc, P6UINT32 cCount ) P6PURE;

   P6DECLCOMMETHOD(wcToUtf8)(P6THIS_  P6CHAR* pDst, P6UINT32* pDstSize, P6WCHAR wc ) P6PURE;

   P6DECLCOMMETHOD(wcsToUtf8)(P6THIS_  P6CHAR* pDst, P6UINT32* pDstSize, const P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(wcsNToUtf8)(P6THIS_  P6CHAR* pDst, P6UINT32* pDstSize, const P6WCHAR* pWs, P6UINT32 cCount ) P6PURE;



    // [B] Query Properties Methods
   P6DECLCOMMETHOD(iswalnum)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswalpha)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswcntrl)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswdigit)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswgraph)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswlower)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswprint)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswpunct)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswspace)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswupper)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswxdigit)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswctype)(P6THIS_  P6WCHAR wc, P6UINT16 charClass, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(iswLineTerminator)(P6THIS_  P6WCHAR wc, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcscspn)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32* pResultSize ) P6PURE;

   P6DECLCOMMETHOD(wcsspn)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32* pResultSize ) P6PURE;

   P6DECLCOMMETHOD(wcslen)(P6THIS_  const P6WCHAR* pWs, P6UINT32* pResultSize ) P6PURE;



   // [C] String (character) Search Methods
   P6DECLCOMMETHOD(wcsstr)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6WCHAR** pResult ) P6PURE;

   P6DECLCOMMETHOD(wcspbrk)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6WCHAR** pResult ) P6PURE;

   P6DECLCOMMETHOD(wcschr)(P6THIS_  const P6WCHAR* pWs, P6WCHAR wc, P6WCHAR** pResult ) P6PURE;

   P6DECLCOMMETHOD(wcsrchr)(P6THIS_  const P6WCHAR* pWs, P6WCHAR wc, P6WCHAR** pResult ) P6PURE;

   P6DECLCOMMETHOD(wmemchr)(P6THIS_  const P6WCHAR* pWs, P6WCHAR wc, P6UINT32 n, P6WCHAR** pResult ) P6PURE;



   // [D] String (character) Construction (Manipualation) Methods
   P6DECLCOMMETHOD(formatString)(P6THIS_  P6WCHAR* pDst, P6SIZE cDst, P6SIZE *pcWritten, const P6WCHAR* pszFormat, const P6ARG* pArgs, P6INT32 cArgs ) P6PURE;

   P6DECLCOMMETHOD(towlower)(P6THIS_  P6WCHAR wc, P6WCHAR* pLowerWc ) P6PURE;

   P6DECLCOMMETHOD(towupper)(P6THIS_  P6WCHAR wc, P6WCHAR* pUpperWc ) P6PURE;

   P6DECLCOMMETHOD(wcslwr)(P6THIS_  P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(wcsupr)(P6THIS_  P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(wcsncat)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n ) P6PURE;

   P6DECLCOMMETHOD(wcsncpy)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n ) P6PURE;

   P6DECLCOMMETHOD(wcslcpy)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 size ) P6PURE;

   P6DECLCOMMETHOD(wcslcat)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 size ) P6PURE;

   P6DECLCOMMETHOD(wmemcpy)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n ) P6PURE;

   P6DECLCOMMETHOD(wmemmove)(P6THIS_  P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n ) P6PURE;

   P6DECLCOMMETHOD(wmemset)(P6THIS_  P6WCHAR* pWs, P6WCHAR wc, P6UINT32 n ) P6PURE;

   P6DECLCOMMETHOD(wcsdup)(P6THIS_  P6WCHAR** pWs1, const P6WCHAR* pWs2 ) P6PURE;

   P6DECLCOMMETHOD(wcsdupFree)(P6THIS_  P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(wcsStrToCntrl)(P6THIS_  P6WCHAR* pWs ) P6PURE;

   P6DECLCOMMETHOD(wcsCntrlToStr)(P6THIS_  const P6WCHAR* pWs, P6WCHAR* pDst, P6UINT32* pDstSize ) P6PURE;

   // -> format time strings in a wide and local manner
   // -> P6R extension that supports "%k" which expands to display milliseconds
   P6DECLCOMMETHOD(wcsftime)(P6THIS_  P6WCHAR* pDst, P6UINT32* pDstSize, const P6WCHAR* pFormat, P6TIME tod, P6BOOL inGMT ) P6PURE;

   // [E] String Comparison Methods
   P6DECLCOMMETHOD(wcscmp)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcsncmp)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcsicmp)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcsnicmp)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wcscoll)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(wmemcmp)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6UINT32 n, P6INT32* pResult ) P6PURE;

   P6DECLCOMMETHOD(startsWith)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6BOOL* pResult ) P6PURE;

   P6DECLCOMMETHOD(endsWith)(P6THIS_  const P6WCHAR* pWs1, const P6WCHAR* pWs2, P6BOOL* pResult ) P6PURE;

   // [F] String Parsing Methods
   P6DECLCOMMETHOD(wcstok)(P6THIS_  P6WCHAR* pWs, const P6WCHAR* pDelimit, P6WCHAR** pResult ) P6PURE;


   // [G] Misc
   P6DECLCOMMETHOD(wctype)(P6THIS_  const P6CHAR* property, P6UINT16* pCharClass ) P6PURE;

   P6DECLCOMMETHOD(trimEnd)(P6THIS_  P6WCHAR* pWs ) P6PURE;
};

// {AA13B086-7425-4ec4-9C35-40DA83A6CAEC}
#define IF_p6II18n  {0xaa13b086,0x7425,0x4ec4,{0x9c,0x35,0x40,0xda,0x83,0xa6,0xca,0xec}}

// {4D41A2BA-761D-4d05-A4BC-CD376BBCA93D}
#define COMP_p6I18n {0x4d41a2ba,0x761d,0x4d05,{0xa4,0xbc,0xcd,0x37,0x6b,0xbc,0xa9,0x3d}}

#ifdef  __cplusplus
} /* extern "C" */
} // namespace
#endif



#endif