framework/inc/macros/generic.hxx

   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: generic.hxx,v $
  10  * $Revision: 1.6 $
  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
  31 #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
  32 #define __FRAMEWORK_MACROS_GENERIC_HXX_
  33
  34 //_________________________________________________________________________________________________________________
  35 //      includes
  36 //_________________________________________________________________________________________________________________
  37
  38 #include <rtl/ustring.hxx>
  39 #include <rtl/textenc.h>
  40
  41 //*****************************************************************************************************************
  42 //      generic macros
  43 //*****************************************************************************************************************
  44
  45 /*_________________________________________________________________________________________________________________
  46     DECLARE_ASCII( SASCIIVALUE )
  47
  48     Use it to declare a constant ascii value at compile time in code.
  49     zB. OUSting sTest = DECLARE_ASCII( "Test" )
  50 _________________________________________________________________________________________________________________*/
  51
  52 #define DECLARE_ASCII( SASCIIVALUE )                                                                                                                                                    \
  53     ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( SASCIIVALUE ) )
  54
  55 /*_________________________________________________________________________________________________________________
  56     U2B( SUNICODEVALUE )
  57     B2U( SASCIIVALUE )
  58     U2B_ENC( SUNICODEVALUE, AENCODING )
  59     B2U_ENC( SASCIIVALUE, AENCODING )
  60
  61     Use it to convert unicode strings to ascii values and reverse ...
  62     We use UTF8 as default textencoding. If you will change this use U2B_ENC and B2U_ENC!
  63 _________________________________________________________________________________________________________________*/
  64
  65 #define U2B( SUNICODEVALUE )                                                                                                                                                                    \
  66     ::rtl::OUStringToOString( SUNICODEVALUE, RTL_TEXTENCODING_UTF8 )
  67
  68 #define B2U( SASCIIVALUE )                                                                                                                                                                              \
  69     ::rtl::OStringToOUString( SASCIIVALUE, RTL_TEXTENCODING_UTF8 )
  70
  71 #define U2B_ENC( SUNICODEVALUE, AENCODING )                                                                                                                                             \
  72     ::rtl::OUStringToOString( SUNICODEVALUE, AENCODING )
  73
  74 #define B2U_ENC( SASCIIVALUE, AENCODING )                                                                                                                                               \
  75     ::rtl::OStringToOUString( SASCIIVALUE, AENCODING )
  76
  77 //*****************************************************************************************************************
  78 //      end of file
  79 //*****************************************************************************************************************
  80
  81 #endif  //      #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_