/**************************************************************
 * 
 * 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.
 * 
 *************************************************************/


#ifndef SC_IMPEX_HXX
#define SC_IMPEX_HXX

#include <osl/endian.h>
#include <sot/exchange.hxx>
#include "global.hxx"
#include "address.hxx"

class ScDocShell;
class ScDocument;
class SvStream;
class SfxMedium;
class ScAsciiOptions;

struct ScExportTextOptions
{
    enum NewlineConversion { ToSystem, ToSpace, None };
    ScExportTextOptions( NewlineConversion eNewlineConversion = ToSystem, sal_Unicode cSeparatorConvertTo = 0, bool bAddQuotes = false ) : 
        meNewlineConversion( eNewlineConversion ), mcSeparatorConvertTo( cSeparatorConvertTo ), mbAddQuotes( bAddQuotes ) {}

    NewlineConversion meNewlineConversion;
    sal_Unicode mcSeparatorConvertTo;   // Convert separator to this character
    bool mbAddQuotes;
};

class ScImportExport
{
	ScDocShell* pDocSh;
	ScDocument* pDoc;
	ScDocument* pUndoDoc;
	ScRange     aRange;
	String		aStreamPath;
    String      aNonConvertibleChars;
	sal_uLong		nSizeLimit;
	sal_Unicode	cSep;					// Separator
	sal_Unicode	cStr;					// String Delimiter
	sal_Bool		bFormulas;				// Formeln im Text?
	sal_Bool		bIncludeFiltered;		// include filtered rows? (default true)
	sal_Bool		bAll;					// keine Selektion
	sal_Bool		bSingle;				// Einfachselektion
	sal_Bool		bUndo;					// Mit Undo?
	sal_Bool		bOverflow;				// zuviele Zeilen/Spalten
    bool        mbApi;
    ScExportTextOptions mExportTextOptions;

	ScAsciiOptions*	pExtOptions;		// erweiterte Optionen

	sal_Bool StartPaste();					// Protect-Check, Undo einrichten
	void EndPaste();					// Undo/Redo-Aktionen, Repaint
	sal_Bool Doc2Text( SvStream& );
	sal_Bool Text2Doc( SvStream& );
	sal_Bool Doc2Sylk( SvStream& );
	sal_Bool Sylk2Doc( SvStream& );
    sal_Bool Doc2HTML( SvStream&, const String& );
	sal_Bool Doc2RTF( SvStream& );
	sal_Bool Doc2Dif( SvStream& );
	sal_Bool Dif2Doc( SvStream& );
	sal_Bool ExtText2Doc( SvStream& );		// mit pExtOptions
    sal_Bool RTF2Doc( SvStream&, const String& rBaseURL );
    sal_Bool HTML2Doc( SvStream&, const String& rBaseURL );

public:
	ScImportExport( ScDocument* );					// Gesamtdokument
	ScImportExport( ScDocument*, const String& );	// Bereichs/Zellangabe
	ScImportExport( ScDocument*, const ScAddress& );
	ScImportExport( ScDocument*, const ScRange& );
   ~ScImportExport();

	void SetExtOptions( const ScAsciiOptions& rOpt );

	sal_Bool IsDoubleRef() const { return sal_Bool( !( bAll || bSingle ) ); }
	sal_Bool IsSingleRef() const { return bSingle; }
	sal_Bool IsNoRef() const	 { return bAll;    }
	sal_Bool IsRef() const	 	 { return sal_Bool( !bAll ); }

	const ScRange& GetRange() const { return aRange; }

	sal_Bool IsUndo() const		 { return bUndo; }
	void SetUndo( sal_Bool b )	 { bUndo = b;	 }

	static sal_Bool  IsFormatSupported( sal_uLong nFormat );
	static const sal_Unicode* ScanNextFieldFromString( const sal_Unicode* p,
			String& rField, sal_Unicode cStr, const sal_Unicode* pSeps, bool bMergeSeps, bool& rbIsQuoted );
	static	void	WriteUnicodeOrByteString( SvStream& rStrm, const String& rString, sal_Bool bZero = sal_False );
	static	void	WriteUnicodeOrByteEndl( SvStream& rStrm );
	static	inline	sal_Bool	IsEndianSwap( const SvStream& rStrm );

    //! only if stream is only used in own (!) memory
    static  inline  void    SetNoEndianSwap( SvStream& rStrm );

	sal_Unicode GetSeparator() const { return cSep; }
	void SetSeparator( sal_Unicode c ) { cSep = c; }
	sal_Unicode GetDelimiter() const { return cStr; }
	void SetDelimiter( sal_Unicode c ) { cStr = c; }
	sal_Bool IsFormulas() const { return bFormulas; }
	void SetFormulas( sal_Bool b ) { bFormulas = b; }
	sal_Bool IsIncludeFiltered() const { return bIncludeFiltered; }
	void SetIncludeFiltered( sal_Bool b ) { bIncludeFiltered = b; }

	void SetSizeLimit( sal_uLong nNew ) { nSizeLimit = nNew; }	// momentan nur fuer Ascii

	void			SetStreamPath( const String& rPath ) { aStreamPath = rPath; }
	const String&	GetStreamPath() const { return aStreamPath; }

    sal_Bool ImportString( const ::rtl::OUString&, sal_uLong=FORMAT_STRING );
	sal_Bool ExportString( ::rtl::OUString&, sal_uLong=FORMAT_STRING );
	sal_Bool ExportByteString( ByteString&, rtl_TextEncoding, sal_uLong=FORMAT_STRING );

    sal_Bool ImportStream( SvStream&, const String& rBaseURL, sal_uLong=FORMAT_STRING );
    sal_Bool ExportStream( SvStream&, const String& rBaseURL, sal_uLong=FORMAT_STRING );

	sal_Bool ImportData( const String& rMimeType,
					 const ::com::sun::star::uno::Any & rValue );
    sal_Bool ExportData( const String& rMimeType,
					 ::com::sun::star::uno::Any & rValue  );

	sal_Bool IsOverflow() const	{ return bOverflow; }		// nach dem Importieren

    const String& GetNonConvertibleChars() const { return aNonConvertibleChars; }

    bool IsApi() const { return mbApi; }
    void SetApi( bool bApi ) { mbApi = bApi; }
    const ScExportTextOptions& GetExportTextOptions() { return mExportTextOptions; }
    void SetExportTextOptions( const ScExportTextOptions& options ) { mExportTextOptions = options; }
};


// static
inline sal_Bool ScImportExport::IsEndianSwap( const SvStream& rStrm )
{
#ifdef OSL_BIGENDIAN
	return rStrm.GetNumberFormatInt() != NUMBERFORMAT_INT_BIGENDIAN;
#else
	return rStrm.GetNumberFormatInt() != NUMBERFORMAT_INT_LITTLEENDIAN;
#endif
}

// static
inline void ScImportExport::SetNoEndianSwap( SvStream& rStrm )
{
#ifdef OSL_BIGENDIAN
    rStrm.SetNumberFormatInt( NUMBERFORMAT_INT_BIGENDIAN );
#else
    rStrm.SetNumberFormatInt( NUMBERFORMAT_INT_LITTLEENDIAN );
#endif
}


// Helper class for importing clipboard strings as streams.
class ScImportStringStream : public SvMemoryStream
{
public:
    ScImportStringStream( const ::rtl::OUString rStr )
        : SvMemoryStream( (void*)rStr.getStr(),
                rStr.getLength() * sizeof(sal_Unicode), STREAM_READ)
    {
        SetStreamCharSet( RTL_TEXTENCODING_UNICODE );
        SetEndianSwap( sal_False );
    }
};


#endif