sal/inc/systools/win32/StrConvert.h

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: StrConvert.h,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef _STRCONVERT_H_
  31 #define _STRCONVERT_H_
  32
  33 #include <windows.h>
  34
  35 #ifdef NDEBUG
  36 #define STRCONVERT_H_HAD_NDEBUG
  37 #undef NDEBUG
  38 #endif
  39 #if OSL_DEBUG_LEVEL == 0
  40 #define NDEBUG
  41 #endif
  42 #include <assert.h>
  43
  44 #ifdef __cplusplus
  45 extern "C"{
  46 #endif
  47
  48 int  AllocNecessarySpaceAndCopyWStr2Str( LPCWSTR lpcwstrString, LPSTR* lppStr );
  49 int  AllocSpaceAndCopyWStr2Str( LPCWSTR lpcwstrString, DWORD nWCharsToCopy, LPSTR* lppStr );
  50 int  CalcLenDblNullTerminatedWStr( LPCWSTR lpcwstrString );
  51 int  CalcLenDblNullTerminatedStr( LPCSTR lpcstrString );
  52 void FreeSpaceStr( LPSTR lpszString );
  53
  54 /* WC2MB allocates a sufficient amount of memory on stack and converts
  55    the wide char parameter to multi byte string using the actual code
  56    page.
  57
  58    @Param: wcStr - a wide char string
  59            mbStr - the corresponding multi byte string
  60
  61    NOTE: due to the use of _alloca, this must be a macro and no function
  62 */
  63
  64 #define WC2MB( wcStr, mbStr ) \
  65 if( wcStr ) \
  66 { \
  67     int needed = WideCharToMultiByte( CP_ACP, 0, wcStr, -1, NULL, 0, NULL, NULL ); \
  68     if( needed > 0 ) \
  69     { \
  70         int copied; \
  71         mbStr = _alloca( needed * sizeof( CHAR ) ); \
  72         copied = WideCharToMultiByte( CP_ACP, 0, wcStr, -1, mbStr, needed, NULL, NULL ); \
  73         assert( copied == needed ); \
  74     } \
  75 }
  76
  77
  78 /* WideCharListGetMultiByteLength
  79    calculates the needed length of a corresponding the multi byte string
  80    list for a wide char string list.
  81
  82    @Param: cp - the code page to use for convertion.
  83            wcList - a double '\0' terminated wide char string list.
  84 */
  85
  86 int WideCharListGetMultiByteLength( UINT codepage, LPCWSTR wcList );
  87
  88 /* WideCharListToMultiByteList
  89    converts a double '\0' terminated list of wide char strings to a
  90    multi byte string list.
  91
  92    @Param: cp - the code page to use for convertion.
  93            wcList - a double '\0' terminated wide char string list.
  94            mbList - a double '\0' terminated multi byte string list.
  95            dwSize - size of buffer for multi byte string list.
  96 */
  97
  98 int WideCharListToMultiByteList( UINT codepage, LPCWSTR wcList, LPSTR mbList, DWORD dwSize );
  99
 100
 101 /* WCL2MBL allocates a sufficient amount of memory on stack and converts
 102    the wide char list parameter to multi byte string list using the actual
 103    code page.
 104
 105    @Param: wcList - a wide char string list
 106            mbList - the corresponding multi byte string list
 107
 108    NOTE: due to the use of _alloca, this must be a macro and no function
 109 */
 110
 111 #define WCL2MBL( wcList, mbList ) \
 112 if( wcList ) \
 113 { \
 114     int needed = WideCharListGetMultiByteLength( CP_ACP, wcList ); \
 115     if( needed > 0 ) \
 116     { \
 117         int copied; \
 118         mbList = _alloca( needed * sizeof( CHAR ) ); \
 119         copied = WideCharListToMultiByteList( CP_ACP, wcList, mbList, needed ); \
 120         assert( copied == needed ); \
 121     } \
 122 }
 123
 124 #ifdef __cplusplus
 125 }
 126 #endif
 127
 128 // Restore NDEBUG state
 129 #ifdef STRCONVERT_H_HAD_NDEBUG
 130 #define NDEBUG
 131 #else
 132 #undef NDEBUG
 133 #endif
 134
 135 #endif