/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/


// TODO: Woher?
#define Max( a, b )		(((a)>(b)) ? (a) : (b) )
#define Min( a, b )		(((a)<(b)) ? (a) : (b) )

/*
* 
* Text2UnicodeConverter
*
**/
namespace sax_expatwrap {
	
class Text2UnicodeConverter 
{

public:
	Text2UnicodeConverter( const ::rtl::OString & sEncoding );
	~Text2UnicodeConverter();

	::com::sun::star::uno::Sequence < sal_Unicode > convert( const ::com::sun::star::uno::Sequence<sal_Int8> & );
	sal_Bool canContinue() {  return m_bCanContinue; }

private:
	void init( rtl_TextEncoding encoding );

	rtl_TextToUnicodeConverter 	m_convText2Unicode;
	rtl_TextToUnicodeContext   	m_contextText2Unicode;
	sal_Bool					m_bCanContinue;
	sal_Bool					m_bInitialized;
	rtl_TextEncoding			m_rtlEncoding;
	::com::sun::star::uno::Sequence<sal_Int8> m_seqSource;
};

/*----------------------------------------
*
* Unicode2TextConverter
*
**-----------------------------------------*/
class Unicode2TextConverter 
{
public:
	Unicode2TextConverter( rtl_TextEncoding encoding );
	~Unicode2TextConverter();

	inline ::com::sun::star::uno::Sequence<sal_Int8> convert( const ::rtl::OUString &s )
		{
			return convert( s.getStr() , s.getLength() );
		}
	::com::sun::star::uno::Sequence<sal_Int8> convert( const sal_Unicode * , sal_Int32 nLength );
	sal_Bool canContinue() {  return m_bCanContinue; }

private:
	void init( rtl_TextEncoding encoding );

	rtl_UnicodeToTextConverter 	m_convUnicode2Text;
	rtl_UnicodeToTextContext   	m_contextUnicode2Text;
	sal_Bool					m_bCanContinue;
	sal_Bool					m_bInitialized;
	rtl_TextEncoding			m_rtlEncoding;
	::com::sun::star::uno::Sequence<sal_Unicode>		m_seqSource;
};


/*----------------------------------------
*
* XMLFile2UTFConverter
*
**-----------------------------------------*/
class XMLFile2UTFConverter
{
public:
	XMLFile2UTFConverter( ):
		m_bStarted( sal_False ),
		m_pText2Unicode( 0 ),
		m_pUnicode2Text( 0 )
		{}

	~XMLFile2UTFConverter();
	
	void setInputStream( ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > &r ) { m_in = r; }
	void setEncoding( const ::rtl::OString &s ) { m_sEncoding = s; }


	// @param nMaxToRead The number of chars, that should be read. Note that this is no exact number. There
	//                   may be returned less or more bytes than ordered.
	sal_Int32 readAndConvert( ::com::sun::star::uno::Sequence<sal_Int8> &seq , sal_Int32 nMaxToRead ) 
		throw ( ::com::sun::star::io::IOException,
				::com::sun::star::io::NotConnectedException ,
				::com::sun::star::io::BufferSizeExceededException ,
				::com::sun::star::uno::RuntimeException );

private:

	// Called only on first Sequence of bytes. Tries to figure out file format and encoding information.
	// @return TRUE, when encoding information could be retrieved
	// @return FALSE, when no encoding information was found in file
	sal_Bool scanForEncoding( ::com::sun::star::uno::Sequence<sal_Int8> &seq );

	// Called only on first Sequence of bytes. Tries to figure out
	// if enough data is available to scan encoding
	// @return TRUE, when encoding is retrievable
	// @return FALSE, when more data is needed
	sal_Bool isEncodingRecognizable( const ::com::sun::star::uno::Sequence< sal_Int8 > & seq );

	// When encoding attribute is within the text (in the first line), it is removed.
	void removeEncoding( ::com::sun::star::uno::Sequence<sal_Int8> &seq );
	
	// Initializes decoding depending on m_sEncoding setting
	void initializeDecoding();
private:
	::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >  m_in;
		
	sal_Bool m_bStarted;
	::rtl::OString m_sEncoding;

	Text2UnicodeConverter *m_pText2Unicode;
	Unicode2TextConverter *m_pUnicode2Text;	
};
}