/************************************************************************* * * $RCSfile: tencinfo.h,v $ * * $Revision: 1.5 $ * * last change: $Author: sb $ $Date: 2001-10-29 13:27:54 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses * * - GNU Lesser General Public License Version 2.1 * - Sun Industry Standards Source License Version 1.1 * * Sun Microsystems Inc., October, 2000 * * GNU Lesser General Public License Version 2.1 * ============================================= * Copyright 2000 by Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, CA 94303, USA * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License version 2.1, as published by the Free Software Foundation. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 59 Temple Place, Suite 330, Boston, * MA 02111-1307 USA * * * Sun Industry Standards Source License Version 1.1 * ================================================= * The contents of this file are subject to the Sun Industry Standards * Source License Version 1.1 (the "License"); You may not use this file * except in compliance with the License. You may obtain a copy of the * License at http://www.openoffice.org/license.html. * * Software provided under this License is provided on an "AS IS" basis, * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. * See the License for the specific provisions governing your rights and * obligations concerning the Software. * * The Initial Developer of the Original Code is: Sun Microsystems, Inc. * * Copyright: 2000 by Sun Microsystems, Inc. * * All Rights Reserved. * * Contributor(s): _______________________________________ * * ************************************************************************/ #ifndef _RTL_TENCINFO_H #define _RTL_TENCINFO_H #ifndef _SAL_TYPES_H #include #endif #ifndef _RTL_TEXTENC_H #include #endif #ifdef __cplusplus extern "C" { #endif #define RTL_TEXTENCODING_INFO_CONTEXT ((sal_uInt32)0x00000001) #define RTL_TEXTENCODING_INFO_ASCII ((sal_uInt32)0x00000002) #define RTL_TEXTENCODING_INFO_UNICODE ((sal_uInt32)0x00000004) #define RTL_TEXTENCODING_INFO_MULTIBYTE ((sal_uInt32)0x00000008) #define RTL_TEXTENCODING_INFO_R2L ((sal_uInt32)0x00000010) #define RTL_TEXTENCODING_INFO_7BIT ((sal_uInt32)0x00000020) #define RTL_TEXTENCODING_INFO_SYMBOL ((sal_uInt32)0x00000040) #define RTL_TEXTENCODING_INFO_MIME ((sal_uInt32)0x00000080) /** Information about a text encoding. */ typedef struct _rtl_TextEncodingInfo { /** The size (in bytes) of this structure. Should be 12. */ sal_uInt32 StructSize; /** The minimum number of bytes needed to encode any character in the given encoding. Can be rather meaningless for encodings that encode global state along with the characters (e.g., ISO-2022 encodings). */ sal_uInt8 MinimumCharSize; /** The maximum number of bytes needed to encode any character in the given encoding. Can be rather meaningless for encodings that encode global state along with the characters (e.g., ISO-2022 encodings). */ sal_uInt8 MaximumCharSize; /** The average number of bytes needed to encode a character in the given encoding. */ sal_uInt8 AverageCharSize; /** An unused byte, for padding. */ sal_uInt8 Reserved; /** Any combination of the flags RTL_TEXTENCODING_INFO_CONTEXT (with unknown semantics), RTL_TEXTENCODING_INFO_ASCII (the encoding is a superset of ASCII), RTL_TEXTENCODING_INFO_UNICODE (the encoding's character set is Unicode), RTL_TEXTENCODING_INFO_MULTIBYTE (a multi-byte encoding), RTL_TEXTENCODING_INFO_R2L (an encoding used mainly or exclusively for languages written from right to left), RTL_TEXTENCODING_INFO_7BIT (a 7-bit instead of an 8-bit encoding), RTL_TEXTENCODING_INFO_SYMBOL (an encoding for symbol character sets), and RTL_TEXTENCODING_INFO_MIME (the encoding is registered as a MIME charset). */ sal_uInt32 Flags; } rtl_TextEncodingInfo; /** Return information about a text encoding. @param eTextEncoding Any rtl_TextEncoding value. @param pEncInfo Returns information about the given encoding. Must not be null, and the StructSize member must be set correctly. @return True if information about the given encoding is available, false otherwise. */ sal_Bool SAL_CALL rtl_getTextEncodingInfo( rtl_TextEncoding eTextEncoding, rtl_TextEncodingInfo* pEncInfo ); /** Map from a numeric Windows charset to a text encoding. @param nWinCharset Any numeric Windows charset. @return The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable. */ rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromWindowsCharset( sal_uInt8 nWinCharset ); /** Map from a MIME charset to a text encoding. @param pMimeCharset Any MIME charset string. Must not be null. @return The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable. */ rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromMimeCharset( const sal_Char* pMimeCharset ); /** Map from a Unix charset to a text encoding. @param pMimeCharset Any Unix charset string. Must not be null. @return The corresponding rtl_TextEncoding value, or RTL_TEXTENCODING_DONTKNOW if no mapping is applicable. */ rtl_TextEncoding SAL_CALL rtl_getTextEncodingFromUnixCharset( const sal_Char* pUnixCharset ); /** Map from a text encoding to the best matching numeric Windows charset. @param eTextEncoding Any rtl_TextEncoding value. @return The best matching numeric Windows charset, or 1 if none matches. */ sal_uInt8 SAL_CALL rtl_getBestWindowsCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding ); /** Map from a text encoding to the best matching MIME charset. @param eTextEncoding Any rtl_TextEncoding value. @return The best matching MIME charset string, or null if none matches. */ const sal_Char* SAL_CALL rtl_getBestMimeCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding ); /** Map from a text encoding to the best matching Unix charset. @param eTextEncoding Any rtl_TextEncoding value. @return The best matching Unix charset string, or null if none matches. */ const sal_Char* SAL_CALL rtl_getBestUnixCharsetFromTextEncoding( rtl_TextEncoding eTextEncoding ); #ifdef __cplusplus } #endif #endif /* _RTL_TENCINFO_H */