xref: /trunk/main/framework/inc/macros/generic.hxx (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
1 /*************************************************************************
2  *
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * Copyright 2000, 2010 Oracle and/or its affiliates.
6  *
7  * OpenOffice.org - a multi-platform office productivity suite
8  *
9  * This file is part of OpenOffice.org.
10  *
11  * OpenOffice.org is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU Lesser General Public License version 3
13  * only, as published by the Free Software Foundation.
14  *
15  * OpenOffice.org is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU Lesser General Public License version 3 for more details
19  * (a copy is included in the LICENSE file that accompanied this code).
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * version 3 along with OpenOffice.org.  If not, see
23  * <http://www.openoffice.org/license.html>
24  * for a copy of the LGPLv3 License.
25  *
26  ************************************************************************/
27 
28 #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
29 #define __FRAMEWORK_MACROS_GENERIC_HXX_
30 
31 //_________________________________________________________________________________________________________________
32 //  includes
33 //_________________________________________________________________________________________________________________
34 
35 #include <rtl/ustring.hxx>
36 #include <rtl/textenc.h>
37 
38 //*****************************************************************************************************************
39 //  generic macros
40 //*****************************************************************************************************************
41 
42 /*_________________________________________________________________________________________________________________
43     DECLARE_ASCII( SASCIIVALUE )
44 
45     Use it to declare a constant ascii value at compile time in code.
46     zB. OUSting sTest = DECLARE_ASCII( "Test" )
47 _________________________________________________________________________________________________________________*/
48 
49 #define DECLARE_ASCII( SASCIIVALUE )                                                                            \
50     ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM( SASCIIVALUE ) )
51 
52 /*_________________________________________________________________________________________________________________
53     U2B( SUNICODEVALUE )
54     B2U( SASCIIVALUE )
55     U2B_ENC( SUNICODEVALUE, AENCODING )
56     B2U_ENC( SASCIIVALUE, AENCODING )
57 
58     Use it to convert unicode strings to ascii values and reverse ...
59     We use UTF8 as default textencoding. If you will change this use U2B_ENC and B2U_ENC!
60 _________________________________________________________________________________________________________________*/
61 
62 #define U2B( SUNICODEVALUE )                                                                                    \
63     ::rtl::OUStringToOString( SUNICODEVALUE, RTL_TEXTENCODING_UTF8 )
64 
65 #define B2U( SASCIIVALUE )                                                                                      \
66     ::rtl::OStringToOUString( SASCIIVALUE, RTL_TEXTENCODING_UTF8 )
67 
68 #define U2B_ENC( SUNICODEVALUE, AENCODING )                                                                     \
69     ::rtl::OUStringToOString( SUNICODEVALUE, AENCODING )
70 
71 #define B2U_ENC( SASCIIVALUE, AENCODING )                                                                       \
72     ::rtl::OStringToOUString( SASCIIVALUE, AENCODING )
73 
74 //*****************************************************************************************************************
75 //  end of file
76 //*****************************************************************************************************************
77 
78 #endif  //  #ifndef __FRAMEWORK_MACROS_GENERIC_HXX_
79