/*************************************************************************
 *
 *  $RCSfile: xmluconv.hxx,v $
 *
 *  $Revision: 1.16 $
 *
 *  last change: $Author: hr $ $Date: 2003/03/27 18:20:02 $
 *
 *  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 _XMLOFF_XMLUCONV_HXX
#define _XMLOFF_XMLUCONV_HXX

#include <limits.h>

#ifndef _SOLAR_H
#include <tools/solar.h>
#endif

#ifndef _TOOLS_COLOR_HXX
#include <tools/color.hxx>
#endif

#ifndef _VCL_MAPUNIT_HXX
#include <vcl/mapunit.hxx>
#endif

#ifndef _XMLOFF_XMLEMENT_HXX
#include <xmloff/xmlement.hxx>
#endif

#ifndef _XMLOFF_XMLTOKEN_HXX
#include <xmloff/xmltoken.hxx>
#endif

#ifndef _COM_SUN_STAR_UTIL_DATE_HPP_
#include <com/sun/star/util/Date.hpp>
#endif

#ifndef _COM_SUN_STAR_FRAME_XMODEL_HPP_
#include <com/sun/star/frame/XModel.hpp>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif

namespace rtl
{
class OUString;
class OUStringBuffer;
}

namespace com { namespace sun { namespace star {
	namespace util { struct DateTime; }
	namespace text { class XNumberingTypeInfo; }
}}}

class SvXMLTokenEnumerator
{
private:
	const ::rtl::OUString&	maTokenString;
	sal_Int32				mnNextTokenPos;
	sal_Unicode				mcSeperator;

public:
	SvXMLTokenEnumerator( const ::rtl::OUString& rString, sal_Unicode cSeperator = sal_Unicode(' ') );

	sal_Bool getNextToken( ::rtl::OUString& rToken );
};

/** the SvXMLTypeConverter converts values of various types from
	their internal represantation to the textual form used in xml
	and back.
	Most of the methods are static but the SvXMLTypeConverter can
	also store default units for both numerical and textual measures.
*/
class Vector3D;

class SvXMLUnitConverter
{
private:
	MapUnit	meCoreMeasureUnit;
	MapUnit	meXMLMeasureUnit;
	com::sun::star::util::Date aNullDate;
	::com::sun::star::uno::Reference<
		::com::sun::star::text::XNumberingTypeInfo > xNumTypeInfo;
	static ::rtl::OUString msXML_false;
	static ::rtl::OUString msXML_true;

	static void initXMLStrings();

	void createNumTypeInfo() const;

public:
	/** constructs a SvXMLUnitConverter. The core measure unit is the
		default unit for numerical measures, the XML measure unit is
		the default unit for textual measures */
	SvXMLUnitConverter( MapUnit eCoreMeasureUnit, MapUnit eXMLMeasureUnit );

	virtual ~SvXMLUnitConverter();

	static MapUnit GetMapUnit(sal_Int16 nFieldUnit);

	/** sets the default unit for numerical measures */
	inline void setCoreMeasureUnit( MapUnit eCoreMeasureUnit );

	/** gets the default unit for numerical measures */
	inline MapUnit getCoreMeasureUnit() const;

	/** sets the default unit for textual measures */
	void setXMLMeasureUnit( MapUnit eXMLMeasureUnit );

	/** gets the default unit for textual measures */
	MapUnit getXMLMeasureUnit() const;

	/** gets XNumberingTypeInfo */
	const ::com::sun::star::uno::Reference<
		::com::sun::star::text::XNumberingTypeInfo >& getNumTypeInfo() const
	{
		if( !xNumTypeInfo.is() )
			createNumTypeInfo();
		return xNumTypeInfo;
	}

	/** convert string to measure using optional min and max values*/
	sal_Bool convertMeasure( sal_Int32& rValue,
						 const ::rtl::OUString& rString,
						 sal_Int32 nMin = LONG_MIN,
						 sal_Int32 nMax = LONG_MAX ) const;

	/** convert measure to string */
	void convertMeasure( ::rtl::OUStringBuffer& rBuffer,
						 sal_Int32 nMeasure ) const;

	/** convert measure with given unit to string */
	void convertMeasure( ::rtl::OUStringBuffer&,
						 sal_Int32 nMeasure,
						 MapUnit eSrcUnit ) const;

	/** convert string to measure in given unit
		using optional min and max values */
	static sal_Bool convertMeasure( sal_Int32& rVal,
								const ::rtl::OUString& rString,
								MapUnit eDstUnit,
								sal_Int32 nMin = LONG_MIN,
								sal_Int32 nMax = LONG_MAX );

	/** convert measure in given unit to string with given unit */
	static void convertMeasure( ::rtl::OUStringBuffer& rBuffer,
								sal_Int32 nMeasure,
								MapUnit eSrcUnit,
								MapUnit eDstUnit );

	/** convert string to boolean */
	static sal_Bool convertBool( sal_Bool& rBool,
							 const ::rtl::OUString& rString );

	/** convert boolean to string */
	static void convertBool( ::rtl::OUStringBuffer& rBuffer,
							 sal_Bool bValue );

	/** convert string to percent */
	static sal_Bool convertPercent( sal_Int32& rValue,
								const ::rtl::OUString& rString );

	/** convert percent to string */
	static void convertPercent( ::rtl::OUStringBuffer& rBuffer,
								sal_Int32 nValue );

	/** convert string to pixel measure unite */
	static sal_Bool convertMeasurePx( sal_Int32& rValue,
								const ::rtl::OUString& rString );

	/** convert pixel measure unit to string */
	static void convertMeasurePx( ::rtl::OUStringBuffer& rBuffer,
								sal_Int32 nValue );

	/** convert string to enum using given enum map, if the enum is
	    not found in the map, this method will return false */
	static sal_Bool convertEnum( sal_uInt16& rEnum,
							 const ::rtl::OUString& rValue,
							 const SvXMLEnumMapEntry *pMap );

	/** convert string to enum using given token map, if the enum is
	    not found in the map, this method will return false */
	static sal_Bool convertEnum( sal_uInt16& rEnum,
							 const ::rtl::OUString& rValue,
							 const SvXMLEnumStringMapEntry *pMap );

	/** convert enum to string using given enum map with an optional
		default token. If the enum is not found in the map,
	    this method will either use the given default or return
		false if not default is set */
	static sal_Bool convertEnum( ::rtl::OUStringBuffer& rBuffer,
                                 USHORT nValue,
                                 const SvXMLEnumMapEntry *pMap,
                                 enum ::xmloff::token::XMLTokenEnum eDefault =
                                         ::xmloff::token::XML_TOKEN_INVALID );

	/** convert enum to string using given token map with an optional
		default token. If the enum is not found in the map,
	    this method will either use the given default or return
		false if not default is set */
	static sal_Bool convertEnum( ::rtl::OUStringBuffer& rBuffer,
                                 USHORT nValue,
                                 const SvXMLEnumStringMapEntry *pMap,
                                 sal_Char* pDefault = NULL );

	/** convert string to color */
	static sal_Bool convertColor( Color& rColor,
							  const ::rtl::OUString&rValue );

	/** convert color to string */
	static void convertColor( ::rtl::OUStringBuffer &rBuffer,
							  const Color& rCol );

	/** convert number to string */
	static void convertNumber( ::rtl::OUStringBuffer& rBuffer,
							   sal_Int32 nNumber );

	/** convert string to number with optional min and max values */
	static sal_Bool convertNumber( sal_Int32& rValue,
							   const ::rtl::OUString& rString,
							   sal_Int32 nMin = LONG_MIN,
							   sal_Int32 nMax = LONG_MAX );

	/** convert double number to string (using ::rtl::math) and DO
		convert to export MapUnit */
	void convertDouble(::rtl::OUStringBuffer& rBuffer,
		double fNumber, BOOL bWriteUnits) const;

	/** convert double number to string (using ::rtl::math) and
		DO convert from eSrcUnit to export MapUnit */
	static void convertDouble( ::rtl::OUStringBuffer& rBuffer,
		double fNumber, BOOL bWriteUnits, MapUnit eCoreUnit, MapUnit eDstUnit);

	/** convert double number to string (using ::rtl::math) without unit conversion */
	static void convertDouble( ::rtl::OUStringBuffer& rBuffer, double fNumber);

	/** convert string to double number (using ::rtl::math) and DO convert. */
	sal_Bool convertDouble(double& rValue, const ::rtl::OUString& rString, BOOL bLookForUnits) const;

	/** convert string to double number (using ::rtl::math) and DO convert from
		SrcUnit to DstUnit. */
	static sal_Bool convertDouble(double& rValue,
		const ::rtl::OUString& rString, MapUnit eSrcUnit, MapUnit eCoreUnit);

	/** convert string to double number (using ::rtl::math) without unit conversion */
	static sal_Bool convertDouble(double& rValue, const ::rtl::OUString& rString);

	/** get the Null Date of the XModel and set it to the UnitConverter */
	sal_Bool setNullDate (
		const com::sun::star::uno::Reference <com::sun::star::frame::XModel>& xModel);

	/** Set the Null Date of the UnitConverter */
	void setNullDate ( const com::sun::star::util::Date& aTempNullDate ) { aNullDate = aTempNullDate; }

	/** convert double to ISO Time String */
	static void convertTime( ::rtl::OUStringBuffer& rBuffer,
								const double& fTime);

	/** convert util::DateTime to ISO Time String */
	static void convertTime( ::rtl::OUStringBuffer& rBuffer,
								const ::com::sun::star::util::DateTime& rDateTime );

	/** convert ISO Time String to double */
	static sal_Bool convertTime( double& fTime,
								const ::rtl::OUString& rString);

	/** convert ISO Time String to util::DateTime */
	static sal_Bool convertTime( ::com::sun::star::util::DateTime& rDateTime,
								 const ::rtl::OUString& rString );

	/** convert double to ISO Date Time String */
	void convertDateTime( ::rtl::OUStringBuffer& rBuffer,
								const double& fDateTime) { convertDateTime(rBuffer, fDateTime, aNullDate); }

	/** convert ISO Date Time String to double */
	sal_Bool convertDateTime( double& fDateTime,
								const ::rtl::OUString& rString) { return convertDateTime(fDateTime, rString, aNullDate); }

	/** convert double to ISO Date Time String */
	static void convertDateTime( ::rtl::OUStringBuffer& rBuffer,
								const double& fDateTime,
								const com::sun::star::util::Date& aNullDate);
	/** convert ISO Date Time String to double */
	static sal_Bool convertDateTime( double& fDateTime,
								const ::rtl::OUString& rString,
								const com::sun::star::util::Date& aNullDate);

	/** convert string to vector3D */
	static sal_Bool convertVector3D( Vector3D& rVector,
							  const ::rtl::OUString& rValue );

	/** convert vector3D to string */
	static void convertVector3D( ::rtl::OUStringBuffer &rBuffer,
							  const Vector3D& rVector );

	/** convert util::DateTime to ISO Date String */
	static void convertDateTime( ::rtl::OUStringBuffer& rBuffer,
								const com::sun::star::util::DateTime& rDateTime );

	/** convert ISO Date String to util::DateTime */
	static sal_Bool convertDateTime( com::sun::star::util::DateTime& rDateTime,
									 const ::rtl::OUString& rString );

	/** gets the position of the first comma after npos in the string
		rStr. Commas inside '"' pairs are not matched */
	static sal_Int32 indexOfComma( const ::rtl::OUString& rStr,
								   sal_Int32 nPos );

	static void encodeBase64(rtl::OUStringBuffer& aStrBuffer, const com::sun::star::uno::Sequence<sal_Int8>& aPass);

	// Decode a base 64 encoded string into a sequence of bytes. The first
	// version can be used for attribute values only, bacause it does not
	// return any chars left from conversion.
	// For text submitted throgh the SAX characters call, the later method
	// must be used!
	static void decodeBase64(com::sun::star::uno::Sequence<sal_Int8>& aPass, const rtl::OUString& sBuffer);

	static sal_Int32 decodeBase64SomeChars(com::sun::star::uno::Sequence<sal_Int8>& aPass, const rtl::OUString& sBuffer);

	/** convert num-forat and num-letter-sync values to NumberingType */
	sal_Bool convertNumFormat( sal_Int16& rType,
						 	   const ::rtl::OUString& rNumFormat,
							   const ::rtl::OUString& rNumLetterSync,
							   sal_Bool bNumberNone = sal_False ) const;

	/** convert NumberingType to num-forat and num-letter-sync values */
	void convertNumFormat( ::rtl::OUStringBuffer& rBuffer,
						   sal_Int16 nType ) const;
	void convertNumLetterSync( ::rtl::OUStringBuffer& rBuffer,
						   	   sal_Int16 nType ) const;

	static void convertPropertySet(com::sun::star::uno::Sequence<com::sun::star::beans::PropertyValue>& rProps,
						const com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& aProperties);
	static void convertPropertySet(com::sun::star::uno::Reference<com::sun::star::beans::XPropertySet>& rProperties,
						const com::sun::star::uno::Sequence<com::sun::star::beans::PropertyValue>& aProps);

	static void clearUndefinedChars(rtl::OUString& rTarget, const rtl::OUString& rSource);

};

inline void SvXMLUnitConverter::setCoreMeasureUnit( MapUnit eCoreMeasureUnit )
{
	meCoreMeasureUnit = eCoreMeasureUnit;
}

inline MapUnit SvXMLUnitConverter::getCoreMeasureUnit() const
{
	return meCoreMeasureUnit;
}

inline void SvXMLUnitConverter::setXMLMeasureUnit( MapUnit eXMLMeasureUnit )
{
	meXMLMeasureUnit = eXMLMeasureUnit;
}

inline MapUnit SvXMLUnitConverter::getXMLMeasureUnit() const
{
	return meXMLMeasureUnit;
}

#endif	//  _XMLOFF_XMLUCONV_HXX
