blob: 0e81093166cd53d0628b424c8b9f7c03bae609c4 [file] [log] [blame]
/**************************************************************
*
* 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 OOX_DUMP_DUMPERBASE_HXX
#define OOX_DUMP_DUMPERBASE_HXX
#include <math.h>
#include <vector>
#include <stack>
#include <set>
#include <map>
#include <boost/shared_ptr.hpp>
#include <rtl/strbuf.hxx>
#include <rtl/ustrbuf.hxx>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/util/DateTime.hpp>
#include <comphelper/mediadescriptor.hxx>
#include "oox/helper/binaryinputstream.hxx"
#include "oox/helper/helper.hxx"
#include "oox/helper/storagebase.hxx"
#define OOX_INCLUDE_DUMPER (OSL_DEBUG_LEVEL > 0)
#if OOX_INCLUDE_DUMPER
namespace com { namespace sun { namespace star {
namespace io { class XInputStream; }
namespace io { class XOutputStream; }
namespace io { class XTextOutputStream; }
namespace uno { class XComponentContext; }
} } }
namespace comphelper {
class IDocPasswordVerifier;
}
namespace oox {
class BinaryOutputStream;
class TextInputStream;
}
namespace oox { namespace core {
class FilterBase;
} }
namespace oox {
namespace dump {
// ============================================================================
#define OOX_DUMP_UNUSED "unused"
#define OOX_DUMP_UNKNOWN "?unknown"
#define OOX_DUMP_ERRASCII( ascii ) "?err:" ascii
#define OOX_DUMP_ERRSTRING( ascii ) CREATE_OUSTRING( OOX_DUMP_ERRASCII( ascii ) )
#define OOX_DUMP_ERR_NOMAP OOX_DUMP_ERRSTRING( "no-map" )
#define OOX_DUMP_ERR_NONAME OOX_DUMP_ERRSTRING( "no-name" )
#define OOX_DUMP_ERR_STREAM OOX_DUMP_ERRSTRING( "stream-error" )
#define OOX_DUMP_DUMPEXT CREATE_OUSTRING( ".dump" )
const sal_Unicode OOX_DUMP_STRQUOTE = '\'';
const sal_Unicode OOX_DUMP_FMLASTRQUOTE = '"';
const sal_Unicode OOX_DUMP_ADDRABS = '$';
const sal_Unicode OOX_DUMP_R1C1ROW = 'R';
const sal_Unicode OOX_DUMP_R1C1COL = 'C';
const sal_Unicode OOX_DUMP_R1C1OPEN = '[';
const sal_Unicode OOX_DUMP_R1C1CLOSE = ']';
const sal_Unicode OOX_DUMP_RANGESEP = ':';
const sal_Unicode OOX_DUMP_BASECLASS = 'B';
const sal_Unicode OOX_DUMP_FUNCSEP = ',';
const sal_Unicode OOX_DUMP_LISTSEP = ',';
const sal_Unicode OOX_DUMP_TABSEP = '!';
const sal_Unicode OOX_DUMP_ARRAYSEP = ';';
const sal_Unicode OOX_DUMP_EMPTYVALUE = '~';
const sal_Unicode OOX_DUMP_CMDPROMPT = '?';
const sal_Unicode OOX_DUMP_PLACEHOLDER = '\x01';
typedef ::std::pair< ::rtl::OUString, ::rtl::OUString > OUStringPair;
typedef ::std::pair< sal_Int64, sal_Int64 > Int64Pair;
typedef ::std::vector< ::rtl::OUString > OUStringVector;
typedef ::std::vector< sal_Int64 > Int64Vector;
// ============================================================================
// ============================================================================
/** Static helper functions for system file and stream access. */
class InputOutputHelper
{
public:
// file names -------------------------------------------------------------
static ::rtl::OUString convertFileNameToUrl( const ::rtl::OUString& rFileName );
static sal_Int32 getFileNamePos( const ::rtl::OUString& rFileUrl );
static ::rtl::OUString getFileNameExtension( const ::rtl::OUString& rFileUrl );
// input streams ----------------------------------------------------------
static ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
openInputStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const ::rtl::OUString& rFileName );
// output streams ---------------------------------------------------------
static ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >
openOutputStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const ::rtl::OUString& rFileName );
static ::com::sun::star::uno::Reference< ::com::sun::star::io::XTextOutputStream >
openTextOutputStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >& rxOutStrm,
rtl_TextEncoding eTextEnc );
static ::com::sun::star::uno::Reference< ::com::sun::star::io::XTextOutputStream >
openTextOutputStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const ::rtl::OUString& rFileName,
rtl_TextEncoding eTextEnc );
};
// ============================================================================
class BinaryInputStreamRef : public ::oox::BinaryInputStreamRef
{
public:
inline BinaryInputStreamRef() {}
inline /*implicit*/ BinaryInputStreamRef( BinaryInputStream* pInStrm ) :
::oox::BinaryInputStreamRef( pInStrm ) {}
inline /*implicit*/ BinaryInputStreamRef( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rxInStrm ) :
::oox::BinaryInputStreamRef( new BinaryXInputStream( rxInStrm, true ) ) {}
template< typename StreamType >
inline /*implicit*/ BinaryInputStreamRef( const ::boost::shared_ptr< StreamType >& rxInStrm ) :
::oox::BinaryInputStreamRef( rxInStrm ) {}
};
// ============================================================================
// ============================================================================
/** Specifiers for atomic data types. */
enum DataType
{
DATATYPE_VOID, /// No data type.
DATATYPE_INT8, /// Signed 8-bit integer.
DATATYPE_UINT8, /// Unsigned 8-bit integer.
DATATYPE_INT16, /// Signed 16-bit integer.
DATATYPE_UINT16, /// Unsigned 16-bit integer.
DATATYPE_INT32, /// Signed 32-bit integer.
DATATYPE_UINT32, /// Unsigned 32-bit integer.
DATATYPE_INT64, /// Signed 64-bit integer.
DATATYPE_UINT64, /// Unsigned 64-bit integer.
DATATYPE_FLOAT, /// Floating-point, single precision.
DATATYPE_DOUBLE /// Floating-point, double precision.
};
// ----------------------------------------------------------------------------
/** Specifiers for the output format of values. */
enum FormatType
{
FORMATTYPE_NONE, /// No numeric format (e.g. show name only).
FORMATTYPE_DEC, /// Decimal.
FORMATTYPE_HEX, /// Hexadecimal.
FORMATTYPE_SHORTHEX, /// Hexadecimal, as short as possible (no leading zeros).
FORMATTYPE_BIN, /// Binary.
FORMATTYPE_FIX, /// Fixed-point.
FORMATTYPE_BOOL /// Boolean ('true' or 'false').
};
// ----------------------------------------------------------------------------
/** Describes the output format of a data item.
Data items are written in the following format:
<NAME>=<VALUE>=<NAME-FROM-LIST>
NAME is the name of the data item. The name is contained in the member
maItemName. If the name is empty, only the value is written (without a
leading equality sign).
VALUE is the numeric value of the data item. Its format is dependent on the
output format given in the member meFmtType. If the format type is
FORMATTYPE_NONE, no value is written.
NAME-FROM-LIST is a symbolic name for the current value of the data item.
Various types of name lists produce different names for values, which can
be used for enumerations or names for single bits in bitfields (see class
NameListBase and derived classes). The name of the list is given in the
member maListName. If it is empty, no name is written for the value.
*/
struct ItemFormat
{
DataType meDataType; /// Data type of the item.
FormatType meFmtType; /// Output format for the value.
::rtl::OUString maItemName; /// Name of the item.
::rtl::OUString maListName; /// Name of a name list to be used for this item.
explicit ItemFormat();
void set( DataType eDataType, FormatType eFmtType, const ::rtl::OUString& rItemName );
void set( DataType eDataType, FormatType eFmtType, const ::rtl::OUString& rItemName, const ::rtl::OUString& rListName );
/** Initializes the struct from a vector of strings containing the item format.
The vector must contain at least 2 strings. The struct is filled from
the strings in the vector in the following order:
1) Data type (one of: [u]int8, [u]int16, [u]int32, [u]int64, float, double).
2) Format type (one of: dec, hex, shorthex, bin, fix, bool, unused, unknown).
3) Item name (optional).
4) Name list name (optional).
@return Iterator pointing to the first unhandled string.
*/
OUStringVector::const_iterator parse( const OUStringVector& rFormatVec );
/** Initializes the struct from a string containing the item format.
The string must have the following format:
DATATYPE,FORMATTYPE[,ITEMNAME[,LISTNAME]]
DATATYPE is the data type of the item (see above for possible values).
FORMATTYPE is the format type of the item (see above for possible values).
ITEMNAME is the name of the item (optional).
LISTNAME is the name of a name list (optional).
@return List containing remaining unhandled format strings.
*/
OUStringVector parse( const ::rtl::OUString& rFormatStr );
};
// ============================================================================
// ============================================================================
struct Address
{
sal_Int32 mnCol;
sal_Int32 mnRow;
inline explicit Address() : mnCol( 0 ), mnRow( 0 ) {}
inline explicit Address( sal_Int32 nCol, sal_Int32 nRow ) : mnCol( nCol ), mnRow( nRow ) {}
};
// ----------------------------------------------------------------------------
struct Range
{
Address maFirst;
Address maLast;
inline explicit Range() {}
};
// ----------------------------------------------------------------------------
typedef ::std::vector< Range > RangeList;
// ============================================================================
struct TokenAddress : public Address
{
bool mbRelCol;
bool mbRelRow;
inline explicit TokenAddress() : mbRelCol( false ), mbRelRow( false ) {}
};
// ----------------------------------------------------------------------------
struct TokenRange
{
TokenAddress maFirst;
TokenAddress maLast;
inline explicit TokenRange() {}
};
// ============================================================================
// ============================================================================
/** Static helper functions for formatted output to strings. */
class StringHelper
{
public:
// append string to string ------------------------------------------------
static void appendChar( ::rtl::OUStringBuffer& rStr, sal_Unicode cChar, sal_Int32 nCount = 1 );
static void appendString( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
// append decimal ---------------------------------------------------------
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_uInt8 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_Int8 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_uInt16 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_Int16 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_uInt32 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_Int32 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_uInt64 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, sal_Int64 nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
static void appendDec( ::rtl::OUStringBuffer& rStr, double fData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' );
// append hexadecimal -----------------------------------------------------
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_uInt8 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_Int8 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_uInt16 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_Int16 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_uInt32 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_Int32 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_uInt64 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, sal_Int64 nData, bool bPrefix = true );
static void appendHex( ::rtl::OUStringBuffer& rStr, double fData, bool bPrefix = true );
// append shortened hexadecimal -------------------------------------------
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_uInt8 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_Int8 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_uInt16 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_Int16 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_uInt32 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_Int32 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_uInt64 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, sal_Int64 nData, bool bPrefix = true );
static void appendShortHex( ::rtl::OUStringBuffer& rStr, double fData, bool bPrefix = true );
// append binary ----------------------------------------------------------
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_uInt8 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_Int8 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_uInt16 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_Int16 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_uInt32 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_Int32 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_uInt64 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, sal_Int64 nData, bool bDots = true );
static void appendBin( ::rtl::OUStringBuffer& rStr, double fData, bool bDots = true );
// append fixed-point decimal ---------------------------------------------
template< typename Type >
static void appendFix( ::rtl::OUStringBuffer& rStr, Type nData, sal_Int32 nWidth = 0 );
// append formatted value -------------------------------------------------
static void appendBool( ::rtl::OUStringBuffer& rStr, bool bData );
template< typename Type >
static void appendValue( ::rtl::OUStringBuffer& rStr, Type nData, FormatType eFmtType );
// append columns, rows, addresses ----------------------------------------
static void appendAddrCol( ::rtl::OUStringBuffer& rStr, sal_Int32 nCol, bool bRel );
static void appendAddrRow( ::rtl::OUStringBuffer& rStr, sal_Int32 nRow, bool bRel );
static void appendAddrName( ::rtl::OUStringBuffer& rStr, sal_Unicode cPrefix, sal_Int32 nColRow, bool bRel );
static void appendAddress( ::rtl::OUStringBuffer& rStr, const Address& rPos );
static void appendRange( ::rtl::OUStringBuffer& rStr, const Range& rRange );
static void appendRangeList( ::rtl::OUStringBuffer& rStr, const RangeList& rRanges );
static void appendAddress( ::rtl::OUStringBuffer& rStr, const TokenAddress& rPos, bool bR1C1 );
static void appendRange( ::rtl::OUStringBuffer& rStr, const TokenRange& rRange, bool bR1C1 );
// encoded text output ----------------------------------------------------
static void appendCChar( ::rtl::OUStringBuffer& rStr, sal_Unicode cChar, bool bPrefix = true );
static void appendEncChar( ::rtl::OUStringBuffer& rStr, sal_Unicode cChar, sal_Int32 nCount = 1, bool bPrefix = true );
static void appendEncString( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rData, bool bPrefix = true );
// token list -------------------------------------------------------------
static void appendToken( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rToken, sal_Unicode cSep = OOX_DUMP_LISTSEP );
static void appendToken( ::rtl::OUStringBuffer& rStr, sal_Int64 nToken, sal_Unicode cSep = OOX_DUMP_LISTSEP );
static void prependToken( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rToken, sal_Unicode cSep = OOX_DUMP_LISTSEP );
static void prependToken( ::rtl::OUStringBuffer& rStr, sal_Int64 nToken, sal_Unicode cSep = OOX_DUMP_LISTSEP );
static void appendIndex( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rIdx );
static void appendIndex( ::rtl::OUStringBuffer& rStr, sal_Int64 nIdx );
static void appendIndexedText( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rData, const ::rtl::OUString& rIdx );
static void appendIndexedText( ::rtl::OUStringBuffer& rStr, const ::rtl::OUString& rData, sal_Int64 nIdx );
static ::rtl::OUString getToken( const ::rtl::OUString& rData, sal_Int32& rnPos, sal_Unicode cSep = OOX_DUMP_LISTSEP );
/** Encloses the passed string with the passed characters. Uses cOpen, if cClose is NUL. */
static void enclose( ::rtl::OUStringBuffer& rStr, sal_Unicode cOpen, sal_Unicode cClose = '\0' );
// string conversion ------------------------------------------------------
static ::rtl::OUString trimSpaces( const ::rtl::OUString& rStr );
static ::rtl::OUString trimTrailingNul( const ::rtl::OUString& rStr );
static ::rtl::OString convertToUtf8( const ::rtl::OUString& rStr );
static DataType convertToDataType( const ::rtl::OUString& rStr );
static FormatType convertToFormatType( const ::rtl::OUString& rStr );
static bool convertFromDec( sal_Int64& ornData, const ::rtl::OUString& rData );
static bool convertFromHex( sal_Int64& ornData, const ::rtl::OUString& rData );
static bool convertStringToInt( sal_Int64& ornData, const ::rtl::OUString& rData );
static bool convertStringToDouble( double& orfData, const ::rtl::OUString& rData );
static bool convertStringToBool( const ::rtl::OUString& rData );
static OUStringPair convertStringToPair( const ::rtl::OUString& rString, sal_Unicode cSep = '=' );
// string to list conversion ----------------------------------------------
static void convertStringToStringList( OUStringVector& orVec, const ::rtl::OUString& rData, bool bIgnoreEmpty );
static void convertStringToIntList( Int64Vector& orVec, const ::rtl::OUString& rData, bool bIgnoreEmpty );
};
// ----------------------------------------------------------------------------
template< typename Type >
void StringHelper::appendFix( ::rtl::OUStringBuffer& rStr, Type nData, sal_Int32 nWidth )
{
appendDec( rStr, static_cast< double >( nData ) / pow( 2.0, 4.0 * sizeof( Type ) ), nWidth );
}
template< typename Type >
void StringHelper::appendValue( ::rtl::OUStringBuffer& rStr, Type nData, FormatType eFmtType )
{
switch( eFmtType )
{
case FORMATTYPE_DEC: appendDec( rStr, nData ); break;
case FORMATTYPE_HEX: appendHex( rStr, nData ); break;
case FORMATTYPE_SHORTHEX: appendShortHex( rStr, nData ); break;
case FORMATTYPE_BIN: appendBin( rStr, nData ); break;
case FORMATTYPE_FIX: appendFix( rStr, nData ); break;
case FORMATTYPE_BOOL: appendBool( rStr, nData ); break;
default:;
}
}
// ============================================================================
class String : public ::rtl::OUString
{
public:
inline String() {}
inline /*implicit*/ String( const ::rtl::OUString& rStr ) : ::rtl::OUString( rStr ) {}
inline /*implicit*/ String( const sal_Char* pcStr ) : ::rtl::OUString( ::rtl::OUString::createFromAscii( pcStr ? pcStr : "" ) ) {}
inline /*implicit*/ String( sal_Unicode cChar ) : ::rtl::OUString( cChar ) {}
inline bool has() const { return getLength() > 0; }
inline ::rtl::OUString operator()( const sal_Char* pcDefault ) const { if( has() ) return *this; return String( pcDefault ); }
};
static const String EMPTY_STRING;
// ============================================================================
// ============================================================================
/** Stack to create a human readable formula string from a UPN token array. */
class FormulaStack
{
public:
explicit FormulaStack();
inline const ::rtl::OUString& getFormulaString() const { return getString( maFmlaStack ); }
inline const ::rtl::OUString& getClassesString() const { return getString( maClassStack ); }
void pushOperand( const String& rOp, const ::rtl::OUString& rTokClass );
void pushOperand( const String& rOp );
void pushUnaryOp( const String& rLOp, const String& rROp );
void pushBinaryOp( const String& rOp );
void pushFuncOp( const String& rFunc, const ::rtl::OUString& rTokClass, sal_uInt8 nParamCount );
inline void setError() { mbError = true; }
void replaceOnTop( const ::rtl::OUString& rOld, const ::rtl::OUString& rNew );
private:
typedef ::std::stack< ::rtl::OUString > StringStack;
inline bool check( bool bCond ) { return (mbError |= !bCond) == false; }
const ::rtl::OUString& getString( const StringStack& rStack ) const;
void pushUnaryOp( StringStack& rStack, const ::rtl::OUString& rLOp, const ::rtl::OUString& rROp );
void pushBinaryOp( StringStack& rStack, const ::rtl::OUString& rOp );
void pushFuncOp( StringStack& rStack, const ::rtl::OUString& rOp, sal_uInt8 nParamCount );
private:
StringStack maFmlaStack;
StringStack maClassStack;
bool mbError;
};
// ============================================================================
// ============================================================================
class Base;
typedef ::boost::shared_ptr< Base > BaseRef;
/** Base class for all dumper classes.
Derived classes implement the virtual function implIsValid(). It should
check all members the other functions rely on. If the function
implIsValid() returns true, all references and pointers can be used without
further checking.
Overview of all classes in this header file based on this Base class:
Base
|
+----> NameListBase
| |
| +----> ConstList ------> MultiList
| |
| +----> FlagsList ------> CombiList
| |
| +----> UnitConverter
|
+----> SharedConfigData
|
+----> Config
|
+----> Output
|
+----> StorageIterator
|
+----> ObjectBase
|
+----> StorageObjectBase
|
+----> OutputObjectBase
| |
| +----> InputObjectBase
| |
| +----> BinaryStreamObject
| |
| +----> TextStreamObjectBase
| | |
| | +----> TextStreamObject
| | |
| | +----> XmlStreamObject
| |
| +----> RecordObjectBase
| |
| +----> SequenceRecordObjectBase
|
+----> DumperBase
*/
class Base
{
public:
virtual ~Base();
inline bool isValid() const { return implIsValid(); }
inline static bool isValid( const BaseRef& rxBase ) { return rxBase.get() && rxBase->isValid(); }
protected:
inline explicit Base() {}
virtual bool implIsValid() const = 0;
};
// ============================================================================
// ============================================================================
class ConfigItemBase
{
public:
virtual ~ConfigItemBase();
void readConfigBlock( TextInputStream& rStrm );
protected:
inline explicit ConfigItemBase() {}
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
virtual void implProcessConfigItemInt(
TextInputStream& rStrm,
sal_Int64 nKey,
const ::rtl::OUString& rData );
void readConfigBlockContents(
TextInputStream& rStrm );
private:
enum LineType { LINETYPE_DATA, LINETYPE_END };
LineType readConfigLine(
TextInputStream& rStrm,
::rtl::OUString& orKey,
::rtl::OUString& orData ) const;
LineType readConfigLine(
TextInputStream& rStrm ) const;
void processConfigItem(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
};
// ============================================================================
class SharedConfigData;
class Config;
class NameListBase;
typedef ::boost::shared_ptr< NameListBase > NameListRef;
/** Base class of all classes providing names for specific values (name lists).
The idea is to provide a unique interfase for all different methods to
write specific names for any values. This can be enumerations (dedicated
names for a subset of values), or names for bits in bit fields. Classes
derived from this base class implement the specific behaviour for the
desired purpose.
*/
class NameListBase : public Base, public ConfigItemBase
{
public:
typedef ::std::map< sal_Int64, ::rtl::OUString > OUStringMap;
typedef OUStringMap::const_iterator const_iterator;
public:
virtual ~NameListBase();
/** Sets a name for the specified key. */
void setName( sal_Int64 nKey, const String& rName );
/** Include all names of the passed list. */
void includeList( const NameListRef& rxList );
/** Returns true, if the map contains an entry for the passed key. */
template< typename Type >
inline bool hasName( Type nKey ) const
{ return maMap.count( static_cast< sal_Int64 >( nKey ) ) != 0; }
/** Returns the name for the passed key. */
template< typename Type >
inline ::rtl::OUString getName( const Config& rCfg, Type nKey ) const
{ return implGetName( rCfg, static_cast< sal_Int64 >( nKey ) ); }
/** Returns a display name for the passed double value. */
inline ::rtl::OUString getName( const Config& rCfg, double fValue ) const
{ return implGetNameDbl( rCfg, fValue ); }
/** Returns a map iterator pointing to the first contained name. */
inline const_iterator begin() const { return maMap.begin(); }
/** Returns a map iterator pointing one past the last contained name. */
inline const_iterator end() const { return maMap.end(); }
protected:
inline explicit NameListBase( const SharedConfigData& rCfgData ) : mrCfgData( rCfgData ) {}
virtual bool implIsValid() const;
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
virtual void implProcessConfigItemInt(
TextInputStream& rStrm,
sal_Int64 nKey,
const ::rtl::OUString& rData );
/** Derived classes set the name for the passed key. */
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName ) = 0;
/** Derived classes generate and return the name for the passed key. */
virtual ::rtl::OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const = 0;
/** Derived classes generate and return the name for the passed double value. */
virtual ::rtl::OUString implGetNameDbl( const Config& rCfg, double fValue ) const = 0;
/** Derived classes insert all names and other settings from the passed list. */
virtual void implIncludeList( const NameListBase& rList ) = 0;
/** Inserts the passed name into the internal map. */
void insertRawName( sal_Int64 nKey, const ::rtl::OUString& rName );
/** Returns the name for the passed key, or 0, if nothing found. */
const ::rtl::OUString* findRawName( sal_Int64 nKey ) const;
private:
/** Includes name lists, given in a comma separated list of names of the lists. */
void include( const ::rtl::OUString& rListKeys );
/** Excludes names from the list, given in a comma separated list of their keys. */
void exclude( const ::rtl::OUString& rKeys );
private:
OUStringMap maMap;
const SharedConfigData& mrCfgData;
};
// ============================================================================
class ConstList : public NameListBase
{
public:
explicit ConstList( const SharedConfigData& rCfgData );
/** Sets a default name for unknown keys. */
inline void setDefaultName( const String& rDefName ) { maDefName = rDefName; }
/** Enables or disables automatic quotation of returned names. */
inline void setQuoteNames( bool bQuoteNames ) { mbQuoteNames = bQuoteNames; }
protected:
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
/** Sets the name for the passed key. */
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName );
/** Returns the name for the passed key, or the default name, if key is not contained. */
virtual ::rtl::OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const;
/** Returns the name for the passed double value. */
virtual ::rtl::OUString implGetNameDbl( const Config& rCfg, double fValue ) const;
/** Inserts all names from the passed list. */
virtual void implIncludeList( const NameListBase& rList );
private:
::rtl::OUString maDefName;
bool mbQuoteNames;
};
// ============================================================================
class MultiList : public ConstList
{
public:
explicit MultiList( const SharedConfigData& rCfgData );
void setNamesFromVec( sal_Int64 nStartKey, const OUStringVector& rNames );
protected:
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName );
private:
void insertNames( sal_Int64 nStartKey, const ::rtl::OUString& rData );
private:
bool mbIgnoreEmpty;
};
// ============================================================================
class FlagsList : public NameListBase
{
public:
explicit FlagsList( const SharedConfigData& rCfgData );
/** Returns the flags to be ignored on output. */
inline sal_Int64 getIgnoreFlags() const { return mnIgnore; }
/** Sets flags to be ignored on output. */
inline void setIgnoreFlags( sal_Int64 nIgnore ) { mnIgnore = nIgnore; }
protected:
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
/** Sets the name for the passed key. */
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName );
/** Returns the name for the passed key. */
virtual ::rtl::OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const;
/** Returns the name for the passed double value. */
virtual ::rtl::OUString implGetNameDbl( const Config& rCfg, double fValue ) const;
/** Inserts all flags from the passed list. */
virtual void implIncludeList( const NameListBase& rList );
private:
sal_Int64 mnIgnore;
};
// ============================================================================
class CombiList : public FlagsList
{
public:
explicit CombiList( const SharedConfigData& rCfgData );
protected:
/** Sets the name for the passed key. */
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName );
/** Returns the name for the passed key. */
virtual ::rtl::OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const;
/** Inserts all flags from the passed list. */
virtual void implIncludeList( const NameListBase& rList );
private:
struct ExtItemFormatKey
{
sal_Int64 mnKey;
Int64Pair maFilter;
inline explicit ExtItemFormatKey( sal_Int64 nKey ) : mnKey( nKey ), maFilter( 0, 0 ) {}
bool operator<( const ExtItemFormatKey& rRight ) const;
};
struct ExtItemFormat : public ItemFormat
{
bool mbShiftValue;
inline explicit ExtItemFormat() : mbShiftValue( true ) {}
};
typedef ::std::map< ExtItemFormatKey, ExtItemFormat > ExtItemFormatMap;
ExtItemFormatMap maFmtMap;
};
// ============================================================================
class UnitConverter : public NameListBase
{
public:
explicit UnitConverter( const SharedConfigData& rCfgData );
inline void setUnitName( const String& rUnitName ) { maUnitName = rUnitName; }
inline void setFactor( double fFactor ) { mfFactor = fFactor; }
protected:
/** Sets the name for the passed key. */
virtual void implSetName( sal_Int64 nKey, const ::rtl::OUString& rName );
/** Returns the converted value with appended unit name. */
virtual ::rtl::OUString implGetName( const Config& rCfg, sal_Int64 nKey ) const;
/** Returns the converted value with appended unit name. */
virtual ::rtl::OUString implGetNameDbl( const Config& rCfg, double fValue ) const;
/** Empty implementation. */
virtual void implIncludeList( const NameListBase& rList );
private:
::rtl::OUString maUnitName;
double mfFactor;
};
// ============================================================================
class NameListWrapper
{
public:
inline NameListWrapper() {}
inline /*implicit*/ NameListWrapper( const ::rtl::OUString& rListName ) : maName( rListName ) {}
inline /*implicit*/ NameListWrapper( const sal_Char* pcListName ) : maName( pcListName ) {}
inline /*implicit*/ NameListWrapper( const NameListRef& rxList ) : mxList( rxList ) {}
inline bool isEmpty() const { return !mxList && !maName.has(); }
NameListRef getNameList( const Config& rCfg ) const;
private:
String maName;
mutable NameListRef mxList;
};
static const NameListWrapper NO_LIST;
// ============================================================================
class ItemFormatMap : public ::std::map< sal_Int64, ItemFormat >
{
public:
inline explicit ItemFormatMap() {}
inline explicit ItemFormatMap( const NameListRef& rxNameList ) { insertFormats( rxNameList ); }
void insertFormats( const NameListRef& rxNameList );
};
// ============================================================================
// ============================================================================
class SharedConfigData : public Base, public ConfigItemBase
{
public:
explicit SharedConfigData(
const ::rtl::OUString& rFileName,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const StorageRef& rxRootStrg,
const ::rtl::OUString& rSysFileName,
::comphelper::MediaDescriptor& rMediaDesc );
virtual ~SharedConfigData();
inline const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& getContext() const { return mxContext; }
inline const StorageRef& getRootStorage() const { return mxRootStrg; }
inline const ::rtl::OUString& getSysFileName() const { return maSysFileName; }
void setOption( const ::rtl::OUString& rKey, const ::rtl::OUString& rData );
const ::rtl::OUString* getOption( const ::rtl::OUString& rKey ) const;
template< typename ListType >
::boost::shared_ptr< ListType > createNameList( const ::rtl::OUString& rListName );
void setNameList( const ::rtl::OUString& rListName, const NameListRef& rxList );
void eraseNameList( const ::rtl::OUString& rListName );
NameListRef getNameList( const ::rtl::OUString& rListName ) const;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > requestEncryptionData( ::comphelper::IDocPasswordVerifier& rVerifier );
inline bool isPasswordCancelled() const { return mbPwCancelled; }
protected:
virtual bool implIsValid() const;
virtual void implProcessConfigItemStr(
TextInputStream& rStrm,
const ::rtl::OUString& rKey,
const ::rtl::OUString& rData );
private:
bool readConfigFile( const ::rtl::OUString& rFileUrl );
template< typename ListType >
void readNameList( TextInputStream& rStrm, const ::rtl::OUString& rListName );
void createShortList( const ::rtl::OUString& rData );
void createUnitConverter( const ::rtl::OUString& rData );
private:
typedef ::std::set< ::rtl::OUString > ConfigFileSet;
typedef ::std::map< ::rtl::OUString, ::rtl::OUString > ConfigDataMap;
typedef ::std::map< ::rtl::OUString, NameListRef > NameListMap;
::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext > mxContext;
StorageRef mxRootStrg;
::rtl::OUString maSysFileName;
::comphelper::MediaDescriptor& mrMediaDesc;
ConfigFileSet maConfigFiles;
ConfigDataMap maConfigData;
NameListMap maNameLists;
::rtl::OUString maConfigPath;
bool mbLoaded;
bool mbPwCancelled;
};
// ----------------------------------------------------------------------------
template< typename ListType >
::boost::shared_ptr< ListType > SharedConfigData::createNameList( const ::rtl::OUString& rListName )
{
::boost::shared_ptr< ListType > xList;
if( rListName.getLength() > 0 )
{
xList.reset( new ListType( *this ) );
setNameList( rListName, xList );
}
return xList;
}
template< typename ListType >
void SharedConfigData::readNameList( TextInputStream& rStrm, const ::rtl::OUString& rListName )
{
NameListRef xList = createNameList< ListType >( rListName );
if( xList.get() )
xList->readConfigBlock( rStrm );
}
// ============================================================================
class Config : public Base
{
public:
explicit Config( const Config& rParent );
explicit Config(
const sal_Char* pcEnvVar,
const ::oox::core::FilterBase& rFilter );
explicit Config(
const sal_Char* pcEnvVar,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const StorageRef& rxRootStrg,
const ::rtl::OUString& rSysFileName,
::comphelper::MediaDescriptor& rMediaDesc );
virtual ~Config();
inline const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& getContext() const { return mxCfgData->getContext(); }
inline const StorageRef& getRootStorage() const { return mxCfgData->getRootStorage(); }
inline const ::rtl::OUString& getSysFileName() const { return mxCfgData->getSysFileName(); }
void setStringOption( const String& rKey, const String& rData );
const ::rtl::OUString& getStringOption( const String& rKey, const ::rtl::OUString& rDefault ) const;
bool getBoolOption( const String& rKey, bool bDefault ) const;
template< typename Type >
Type getIntOption( const String& rKey, Type nDefault ) const;
bool isDumperEnabled() const;
bool isImportEnabled() const;
template< typename ListType >
::boost::shared_ptr< ListType > createNameList( const String& rListName );
void setNameList( const String& rListName, const NameListRef& rxList );
void eraseNameList( const String& rListName );
NameListRef getNameList( const String& rListName ) const;
/** Returns the name for the passed key from the passed name list. */
template< typename Type >
::rtl::OUString getName( const NameListWrapper& rListWrp, Type nKey ) const;
/** Returns true, if the passed name list contains an entry for the passed key. */
template< typename Type >
bool hasName( const NameListWrapper& rListWrp, Type nKey ) const;
::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > requestEncryptionData( ::comphelper::IDocPasswordVerifier& rVerifier );
bool isPasswordCancelled() const;
protected:
inline explicit Config() {}
void construct( const Config& rParent );
void construct(
const sal_Char* pcEnvVar,
const ::oox::core::FilterBase& rFilter );
void construct(
const sal_Char* pcEnvVar,
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const StorageRef& rxRootStrg,
const ::rtl::OUString& rSysFileName,
::comphelper::MediaDescriptor& rMediaDesc );
virtual bool implIsValid() const;
virtual const ::rtl::OUString* implGetOption( const ::rtl::OUString& rKey ) const;
virtual NameListRef implGetNameList( const ::rtl::OUString& rListName ) const;
private:
typedef ::boost::shared_ptr< SharedConfigData > SharedConfigDataRef;
SharedConfigDataRef mxCfgData;
};
typedef ::boost::shared_ptr< Config > ConfigRef;
// ----------------------------------------------------------------------------
template< typename Type >
Type Config::getIntOption( const String& rKey, Type nDefault ) const
{
sal_Int64 nRawData;
const ::rtl::OUString* pData = implGetOption( rKey );
return (pData && StringHelper::convertStringToInt( nRawData, *pData )) ?
static_cast< Type >( nRawData ) : nDefault;
}
template< typename ListType >
::boost::shared_ptr< ListType > Config::createNameList( const String& rListName )
{
return mxCfgData->createNameList< ListType >( rListName );
}
template< typename Type >
::rtl::OUString Config::getName( const NameListWrapper& rListWrp, Type nKey ) const
{
NameListRef xList = rListWrp.getNameList( *this );
return xList.get() ? xList->getName( *this, nKey ) : OOX_DUMP_ERR_NOMAP;
}
template< typename Type >
bool Config::hasName( const NameListWrapper& rListWrp, Type nKey ) const
{
NameListRef xList = rListWrp.getNameList( *this );
return xList.get() && xList->hasName( nKey );
}
// ============================================================================
// ============================================================================
class Output : public Base
{
public:
explicit Output(
const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext,
const ::rtl::OUString& rFileName );
// ------------------------------------------------------------------------
void newLine();
void emptyLine( size_t nCount = 1 );
inline ::rtl::OUStringBuffer& getLine() { return maLine; }
void incIndent();
void decIndent();
void resetIndent();
void startTable( sal_Int32 nW1 );
void startTable( sal_Int32 nW1, sal_Int32 nW2 );
void startTable( sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3 );
void startTable( sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3, sal_Int32 nW4 );
void startTable( size_t nColCount, const sal_Int32* pnColWidths );
void tab();
void tab( size_t nCol );
void endTable();
void resetItemIndex( sal_Int64 nIdx = 0 );
void startItem( const String& rItemName );
void contItem();
void endItem();
inline const ::rtl::OUString& getLastItemValue() const { return maLastItem; }
void startMultiItems();
void endMultiItems();
// ------------------------------------------------------------------------
void writeChar( sal_Unicode cChar, sal_Int32 nCount = 1 );
void writeAscii( const sal_Char* pcStr );
void writeString( const ::rtl::OUString& rStr );
void writeArray( const sal_uInt8* pnData, sal_Size nSize, sal_Unicode cSep = OOX_DUMP_LISTSEP );
void writeBool( bool bData );
void writeColorABGR( sal_Int32 nColor );
void writeDateTime( const ::com::sun::star::util::DateTime& rDateTime );
void writeColIndex( sal_Int32 nCol );
void writeRowIndex( sal_Int32 nRow );
void writeColRowRange( sal_Int32 nColRow1, sal_Int32 nColRow2 );
void writeColRange( sal_Int32 nCol1, sal_Int32 nCol2 );
void writeRowRange( sal_Int32 nRow1, sal_Int32 nRow2 );
void writeAddress( const Address& rPos );
void writeRange( const Range& rRange );
void writeRangeList( const RangeList& rRanges );
template< typename Type >
inline void writeDec( Type nData, sal_Int32 nWidth = 0, sal_Unicode cFill = ' ' )
{ StringHelper::appendDec( maLine, nData, nWidth, cFill ); }
template< typename Type >
inline void writeHex( Type nData, bool bPrefix = true )
{ StringHelper::appendHex( maLine, nData, bPrefix ); }
template< typename Type >
inline void writeShortHex( Type nData, bool bPrefix = true )
{ StringHelper::appendShortHex( maLine, nData, bPrefix ); }
template< typename Type >
inline void writeBin( Type nData, bool bDots = true )
{ StringHelper::appendBin( maLine, nData, bDots ); }
template< typename Type >
inline void writeFix( Type nData, sal_Int32 nWidth = 0 )
{ StringHelper::appendFix( maLine, nData, nWidth ); }
template< typename Type >
inline void writeValue( Type nData, FormatType eFmtType )
{ StringHelper::appendValue( maLine, nData, eFmtType ); }
template< typename Type >
inline void writeName( const Config& rCfg, Type nData, const NameListWrapper& rListWrp )
{ writeString( rCfg.getName( rListWrp, nData ) ); }
// ------------------------------------------------------------------------
protected:
virtual bool implIsValid() const;
private:
void writeItemName( const String& rItemName );
private:
typedef ::std::vector< sal_Int32 > StringLenVec;
::com::sun::star::uno::Reference< ::com::sun::star::io::XTextOutputStream > mxStrm;
::rtl::OUString maIndent;
::rtl::OUStringBuffer maLine;
::rtl::OUString maLastItem;
StringLenVec maColPos;
size_t mnCol;
size_t mnItemLevel;
size_t mnMultiLevel;
sal_Int64 mnItemIdx;
sal_Int32 mnLastItem;
};
typedef ::boost::shared_ptr< Output > OutputRef;
// ============================================================================
class IndentGuard
{
public:
inline explicit IndentGuard( const OutputRef& rxOut ) : mrOut( *rxOut ) { mrOut.incIndent(); }
inline ~IndentGuard() { mrOut.decIndent(); }
private:
IndentGuard( const IndentGuard& );
IndentGuard& operator=( const IndentGuard& );
private:
Output& mrOut;
};
// ----------------------------------------------------------------------------
class TableGuard
{
public:
inline explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1 ) :
mrOut( *rxOut ) { mrOut.startTable( nW1 ); }
inline explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1, sal_Int32 nW2 ) :
mrOut( *rxOut ) { mrOut.startTable( nW1, nW2 ); }
inline explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3 ) :
mrOut( *rxOut ) { mrOut.startTable( nW1, nW2, nW3 ); }
inline explicit TableGuard( const OutputRef& rxOut, sal_Int32 nW1, sal_Int32 nW2, sal_Int32 nW3, sal_Int32 nW4 ) :
mrOut( *rxOut ) { mrOut.startTable( nW1, nW2, nW3, nW4 ); }
inline explicit TableGuard( const OutputRef& rxOut, size_t nColCount,
const sal_Int32* pnColWidths ) :
mrOut( *rxOut ) { mrOut.startTable( nColCount, pnColWidths ); }
inline ~TableGuard() { mrOut.endTable(); }
inline void tab() { mrOut.tab(); }
inline void tab( size_t nCol ) { mrOut.tab( nCol ); }
private:
TableGuard( const TableGuard& );
TableGuard& operator=( const TableGuard& );
private:
Output& mrOut;
};
// ----------------------------------------------------------------------------
class ItemGuard
{
public:
inline explicit ItemGuard( const OutputRef& rxOut, const String& rName = EMPTY_STRING ) :
mrOut( *rxOut ) { mrOut.startItem( rName ); }
inline ~ItemGuard() { mrOut.endItem(); }
inline void cont() { mrOut.contItem(); }
private:
ItemGuard( const ItemGuard& );
ItemGuard& operator=( const ItemGuard& );
private:
Output& mrOut;
};
// ----------------------------------------------------------------------------
class MultiItemsGuard
{
public:
inline explicit MultiItemsGuard( const OutputRef& rxOut ) : mrOut( *rxOut ) { mrOut.startMultiItems(); }
inline ~MultiItemsGuard() { mrOut.endMultiItems(); }
private:
MultiItemsGuard( const MultiItemsGuard& );
MultiItemsGuard& operator=( const MultiItemsGuard& );
private:
Output& mrOut;
};
// ============================================================================
class StorageIterator : public Base
{
public:
explicit StorageIterator( const StorageRef& rxStrg );
virtual ~StorageIterator();
size_t getElementCount() const;
StorageIterator& operator++();
::rtl::OUString getName() const;
bool isStream() const;
bool isStorage() const;
private:
virtual bool implIsValid() const;
private:
StorageRef mxStrg;
OUStringVector maNames;
OUStringVector::const_iterator maIt;
};
// ============================================================================
// ============================================================================
class ObjectBase : public Base
{
public:
virtual ~ObjectBase();
inline const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >&
getContext() const { return mxConfig->getContext(); }
void dump();
// ------------------------------------------------------------------------
protected:
inline explicit ObjectBase() {}
void construct( const ConfigRef& rxConfig );
void construct( const ObjectBase& rParent );
virtual bool implIsValid() const;
virtual void implDump();
// ------------------------------------------------------------------------
void reconstructConfig( const ConfigRef& rxConfig );
inline Config& cfg() const { return *mxConfig; }
private:
ConfigRef mxConfig;
};
typedef ::boost::shared_ptr< ObjectBase > ObjectRef;
// ============================================================================
// ============================================================================
class StorageObjectBase : public ObjectBase
{
protected:
inline explicit StorageObjectBase() {}
protected:
using ObjectBase::construct;
void construct( const ObjectBase& rParent, const StorageRef& rxStrg, const ::rtl::OUString& rSysPath );
void construct( const ObjectBase& rParent );
virtual bool implIsValid() const;
virtual void implDump();
virtual void implDumpStream(
const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rxStrm,
const ::rtl::OUString& rStrgPath,
const ::rtl::OUString& rStrmName,
const ::rtl::OUString& rSysFileName );
virtual void implDumpStorage(
const StorageRef& rxStrg,
const ::rtl::OUString& rStrgPath,
const ::rtl::OUString& rSysPath );
virtual void implDumpBaseStream(
const BinaryInputStreamRef& rxStrm,
const ::rtl::OUString& rSysFileName );
void addPreferredStream( const String& rStrmName );
void addPreferredStorage( const String& rStrgPath );
private:
::rtl::OUString getSysFileName(
const ::rtl::OUString& rStrmName,
const ::rtl::OUString& rSysOutPath );
void extractStream(
StorageBase& rStrg,
const ::rtl::OUString& rStrgPath,
const ::rtl::OUString& rStrmName,
const ::rtl::OUString& rSysFileName );
void extractStorage(
const StorageRef& rxStrg,
const ::rtl::OUString& rStrgPath,
const ::rtl::OUString& rSysPath );
void extractItem(
const StorageRef& rxStrg,
const ::rtl::OUString& rStrgPath,
const ::rtl::OUString& rItemName,
const ::rtl::OUString& rSysPath,
bool bIsStrg, bool bIsStrm );
private:
struct PreferredItem
{
::rtl::OUString maName;
bool mbStorage;
inline explicit PreferredItem( const ::rtl::OUString rName, bool bStorage ) :
maName( rName ), mbStorage( bStorage ) {}
};
typedef ::std::vector< PreferredItem > PreferredItemVector;
StorageRef mxStrg;
::rtl::OUString maSysPath;
PreferredItemVector maPreferred;
};
typedef ::boost::shared_ptr< StorageObjectBase > StorageObjectRef;
// ============================================================================
// ============================================================================
class OutputObjectBase : public ObjectBase
{
public:
virtual ~OutputObjectBase();
// ------------------------------------------------------------------------
protected:
inline explicit OutputObjectBase() {}
using ObjectBase::construct;
void construct( const ObjectBase& rParent, const ::rtl::OUString& rSysFileName );
void construct( const OutputObjectBase& rParent );
virtual bool implIsValid() const;
// ------------------------------------------------------------------------
void writeEmptyItem( const String& rName );
void writeInfoItem( const String& rName, const String& rData );
void writeCharItem( const String& rName, sal_Unicode cData );
void writeStringItem( const String& rName, const ::rtl::OUString& rData );
void writeArrayItem( const String& rName, const sal_uInt8* pnData, sal_Size nSize, sal_Unicode cSep = OOX_DUMP_LISTSEP );
void writeBoolItem( const String& rName, bool bData );
double writeRkItem( const String& rName, sal_Int32 nRk );
void writeColorABGRItem( const String& rName, sal_Int32 nColor );
void writeDateTimeItem( const String& rName, const ::com::sun::star::util::DateTime& rDateTime );
void writeGuidItem( const String& rName, const ::rtl::OUString& rGuid );
void writeColIndexItem( const String& rName, sal_Int32 nCol );
void writeRowIndexItem( const String& rName, sal_Int32 nRow );
void writeColRangeItem( const String& rName, sal_Int32 nCol1, sal_Int32 nCol2 );
void writeRowRangeItem( const String& rName, sal_Int32 nRow1, sal_Int32 nRow2 );
void writeAddressItem( const String& rName, const Address& rPos );
void writeRangeItem( const String& rName, const Range& rRange );
void writeRangeListItem( const String& rName, const RangeList& rRanges );
void writeTokenAddressItem( const String& rName, const TokenAddress& rPos, bool bNameMode );
void writeTokenAddress3dItem( const String& rName, const ::rtl::OUString& rRef, const TokenAddress& rPos, bool bNameMode );
void writeTokenRangeItem( const String& rName, const TokenRange& rRange, bool bNameMode );
void writeTokenRange3dItem( const String& rName, const ::rtl::OUString& rRef, const TokenRange& rRange, bool bNameMode );
template< typename Type >
void addNameToItem( Type nData, const NameListWrapper& rListWrp );
template< typename Type >
void writeNameItem( const String& rName, Type nData, const NameListWrapper& rListWrp );
template< typename Type >
void writeDecItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeShortHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeBinItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeFixItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeDecBoolItem( const String& rName, Type nData, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeValueItem( const String& rName, Type nData, FormatType eFmtType, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
void writeValueItem( const ItemFormat& rItemFmt, Type nData );
template< typename Type >
void writeDecPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep = ',' );
template< typename Type >
void writeHexPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep = ',' );
protected:
OutputRef mxOut;
::rtl::OUString maSysFileName;
};
typedef ::boost::shared_ptr< OutputObjectBase > OutputObjectRef;
// ----------------------------------------------------------------------------
template< typename Type >
void OutputObjectBase::addNameToItem( Type nData, const NameListWrapper& rListWrp )
{
if( !rListWrp.isEmpty() )
{
mxOut->contItem();
mxOut->writeName( cfg(), nData, rListWrp );
}
}
template< typename Type >
void OutputObjectBase::writeNameItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeName( cfg(), nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeDecItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeDec( nData );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeHex( nData );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeShortHexItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeShortHex( nData );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeBinItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeBin( nData );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeFixItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeFix( nData );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeDecBoolItem( const String& rName, Type nData, const NameListWrapper& rListWrp )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeDec( nData );
aItem.cont();
mxOut->writeBool( nData != 0 );
addNameToItem( nData, rListWrp );
}
template< typename Type >
void OutputObjectBase::writeValueItem( const String& rName, Type nData, FormatType eFmtType, const NameListWrapper& rListWrp )
{
if( eFmtType == FORMATTYPE_BOOL )
writeDecBoolItem( rName, nData, rListWrp );
else
{
ItemGuard aItem( mxOut, rName );
mxOut->writeValue( nData, eFmtType );
addNameToItem( nData, rListWrp );
}
}
template< typename Type >
void OutputObjectBase::writeValueItem( const ItemFormat& rItemFmt, Type nData )
{
::rtl::OString aNameUtf8 = StringHelper::convertToUtf8( rItemFmt.maItemName );
writeValueItem( aNameUtf8.getStr(), nData, rItemFmt.meFmtType, rItemFmt.maListName );
}
template< typename Type >
void OutputObjectBase::writeDecPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeDec( nData1 );
mxOut->writeChar( cSep );
mxOut->writeDec( nData2 );
}
template< typename Type >
void OutputObjectBase::writeHexPairItem( const String& rName, Type nData1, Type nData2, sal_Unicode cSep )
{
ItemGuard aItem( mxOut, rName );
mxOut->writeHex( nData1 );
mxOut->writeChar( cSep );
mxOut->writeHex( nData2 );
}
// ============================================================================
// ============================================================================
class InputObjectBase : public OutputObjectBase
{
public:
virtual ~InputObjectBase();
// ------------------------------------------------------------------------
protected:
inline explicit InputObjectBase() {}
using OutputObjectBase::construct;
void construct( const ObjectBase& rParent, const BinaryInputStreamRef& rxStrm, const ::rtl::OUString& rSysFileName );
void construct( const OutputObjectBase& rParent, const BinaryInputStreamRef& rxStrm );
void construct( const InputObjectBase& rParent );
virtual bool implIsValid() const;
// ------------------------------------------------------------------------
::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >
getXInputStream() const;
// ------------------------------------------------------------------------
void skipBlock( sal_Int64 nBytes, bool bShowSize = true );
void dumpRawBinary( sal_Int64 nBytes, bool bShowOffset = true, bool bStream = false );
void dumpBinary( const String& rName, sal_Int64 nBytes, bool bShowOffset = true );
void dumpRemaining( sal_Int64 nBytes );
void dumpRemainingTo( sal_Int64 nPos );
void dumpRemainingStream();
void dumpArray( const String& rName, sal_Int32 nBytes, sal_Unicode cSep = OOX_DUMP_LISTSEP );
inline void dumpUnused( sal_Int32 nBytes ) { dumpArray( OOX_DUMP_UNUSED, nBytes ); }
inline void dumpUnknown( sal_Int32 nBytes ) { dumpArray( OOX_DUMP_UNKNOWN, nBytes ); }
sal_Unicode dumpChar( const String& rName, rtl_TextEncoding eTextEnc );
sal_Unicode dumpUnicode( const String& rName );
::rtl::OUString dumpCharArray( const String& rName, sal_Int32 nLen, rtl_TextEncoding eTextEnc, bool bHideTrailingNul = false );
::rtl::OUString dumpUnicodeArray( const String& rName, sal_Int32 nLen, bool bHideTrailingNul = false );
::rtl::OUString dumpNullCharArray( const String& rName, rtl_TextEncoding eTextEnc );
::rtl::OUString dumpNullUnicodeArray( const String& rName );
double dumpRk( const String& rName = EMPTY_STRING );
sal_Int32 dumpColorABGR( const String& rName = EMPTY_STRING );
::com::sun::star::util::DateTime dumpFileTime( const String& rName = EMPTY_STRING );
::rtl::OUString dumpGuid( const String& rName = EMPTY_STRING );
void dumpItem( const ItemFormat& rItemFmt );
template< typename Type >
Type dumpName( const String& rName, const NameListWrapper& rListWrp );
template< typename Type >
Type dumpDec( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
Type dumpHex( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
Type dumpBin( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
Type dumpFix( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
Type dumpBool( const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type >
Type dumpValue( const ItemFormat& rItemFmt );
template< typename Type1, typename Type2 >
Type1 dumpName( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpDec( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpHex( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpBin( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpFix( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpBool( bool bType1, const String& rName, const NameListWrapper& rListWrp = NO_LIST );
template< typename Type1, typename Type2 >
Type1 dumpValue( bool bType1, const ItemFormat& rItemFmt );
template< typename Type >
void dumpDecPair( const String& rName, sal_Unicode cSep = ',' );
template< typename Type >
void dumpHexPair( const String& rName, sal_Unicode cSep = ',' );
protected:
BinaryInputStreamRef mxStrm;
};
typedef ::boost::shared_ptr< InputObjectBase > InputObjectRef;
// ----------------------------------------------------------------------------
template< typename Type >
Type InputObjectBase::dumpName( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeNameItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpDec( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeDecItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpHex( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeHexItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpBin( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeBinItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpFix( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeFixItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpBool( const String& rName, const NameListWrapper& rListWrp )
{
Type nData;
*mxStrm >> nData;
writeDecBoolItem( rName, nData, rListWrp );
return nData;
}
template< typename Type >
Type InputObjectBase::dumpValue( const ItemFormat& rItemFmt )
{
Type nData;
*mxStrm >> nData;
writeValueItem( rItemFmt, nData );
return nData;
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpName( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpName< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpName< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpDec( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpDec< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpDec< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpHex( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpHex< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpHex< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpBin( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpBin< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpBin< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpFix( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpFix< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpFix< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpBool( bool bType1, const String& rName, const NameListWrapper& rListWrp )
{
return bType1 ? dumpBool< Type1 >( rName, rListWrp ) : static_cast< Type1 >( dumpBool< Type2 >( rName, rListWrp ) );
}
template< typename Type1, typename Type2 >
Type1 InputObjectBase::dumpValue( bool bType1, const ItemFormat& rItemFmt )
{
return bType1 ? dumpValue< Type1 >( rItemFmt ) : static_cast< Type1 >( dumpValue< Type2 >( rItemFmt ) );
}
template< typename Type >
void InputObjectBase::dumpDecPair( const String& rName, sal_Unicode cSep )
{
Type nData1, nData2;
*mxStrm >> nData1 >> nData2;
writeDecPairItem( rName, nData1, nData2, cSep );
}
template< typename Type >
void InputObjectBase::dumpHexPair( const String& rName, sal_Unicode cSep )
{
Type nData1, nData2;
*mxStrm >> nData1 >> nData2;
writeHexPairItem( rName, nData1, nData2, cSep );
}
// ============================================================================
// ============================================================================
class BinaryStreamObject : public InputObjectBase
{
public:
explicit BinaryStreamObject(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
const ::rtl::OUString& rSysFileName );
explicit BinaryStreamObject(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxStrm );
protected:
void dumpBinaryStream( bool bShowOffset = true );
virtual void implDump();
};
// ============================================================================
// ============================================================================
class TextStreamObjectBase : public InputObjectBase
{
protected:
inline TextStreamObjectBase() {}
using InputObjectBase::construct;
void construct(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
rtl_TextEncoding eTextEnc,
const ::rtl::OUString& rSysFileName );
void construct(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
rtl_TextEncoding eTextEnc );
void construct(
const InputObjectBase& rParent,
rtl_TextEncoding eTextEnc );
virtual bool implIsValid() const;
virtual void implDump();
virtual void implDumpText( TextInputStream& rTextStrm ) = 0;
private:
void constructTextStrmObj( rtl_TextEncoding eTextEnc );
protected:
::boost::shared_ptr< TextInputStream > mxTextStrm;
};
// ============================================================================
class TextLineStreamObject : public TextStreamObjectBase
{
public:
explicit TextLineStreamObject(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
rtl_TextEncoding eTextEnc,
const ::rtl::OUString& rSysFileName );
explicit TextLineStreamObject(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
rtl_TextEncoding eTextEnc );
protected:
virtual void implDumpText( TextInputStream& rTextStrm );
virtual void implDumpLine( const ::rtl::OUString& rLine, sal_uInt32 nLine );
};
// ============================================================================
class XmlStreamObject : public TextStreamObjectBase
{
public:
explicit XmlStreamObject(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxStrm,
const ::rtl::OUString& rSysFileName );
explicit XmlStreamObject(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxStrm );
protected:
virtual void implDumpText( TextInputStream& rTextStrm );
};
// ============================================================================
// ============================================================================
class RecordObjectBase : public InputObjectBase
{
protected:
inline explicit RecordObjectBase() {}
using InputObjectBase::construct;
void construct(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxBaseStrm,
const ::rtl::OUString& rSysFileName,
const BinaryInputStreamRef& rxRecStrm,
const String& rRecNames,
const String& rSimpleRecs = EMPTY_STRING );
void construct(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxBaseStrm,
const BinaryInputStreamRef& rxRecStrm,
const String& rRecNames,
const String& rSimpleRecs = EMPTY_STRING );
inline sal_Int64 getRecPos() const { return mnRecPos; }
inline sal_Int64 getRecId() const { return mnRecId; }
inline sal_Int64 getRecSize() const { return mnRecSize; }
inline NameListRef getRecNames() const { return maRecNames.getNameList( cfg() ); }
inline void setBinaryOnlyMode( bool bBinaryOnly ) { mbBinaryOnly = bBinaryOnly; }
inline bool isBinaryOnlyMode() const { return mbBinaryOnly; }
virtual bool implIsValid() const;
virtual void implDump();
virtual bool implStartRecord( BinaryInputStream& rBaseStrm, sal_Int64& ornRecPos, sal_Int64& ornRecId, sal_Int64& ornRecSize ) = 0;
virtual void implWriteExtHeader();
virtual void implDumpRecordBody();
private:
void constructRecObjBase(
const BinaryInputStreamRef& rxBaseStrm,
const String& rRecNames,
const String& rSimpleRecs );
void writeHeader();
private:
BinaryInputStreamRef mxBaseStrm;
NameListWrapper maRecNames;
NameListWrapper maSimpleRecs;
sal_Int64 mnRecPos;
sal_Int64 mnRecId;
sal_Int64 mnRecSize;
bool mbShowRecPos;
bool mbBinaryOnly;
};
// ============================================================================
class SequenceRecordObjectBase : public RecordObjectBase
{
protected:
inline explicit SequenceRecordObjectBase() : mxRecData( new StreamDataSequence ) {}
inline StreamDataSequence& getRecordDataSequence() { return *mxRecData; }
using RecordObjectBase::construct;
void construct(
const ObjectBase& rParent,
const BinaryInputStreamRef& rxBaseStrm,
const ::rtl::OUString& rSysFileName,
const String& rRecNames,
const String& rSimpleRecs = EMPTY_STRING );
void construct(
const OutputObjectBase& rParent,
const BinaryInputStreamRef& rxBaseStrm,
const String& rRecNames,
const String& rSimpleRecs = EMPTY_STRING );
virtual bool implStartRecord( BinaryInputStream& rBaseStrm, sal_Int64& ornRecPos, sal_Int64& ornRecId, sal_Int64& ornRecSize );
virtual bool implReadRecordHeader( BinaryInputStream& rBaseStrm, sal_Int64& ornRecId, sal_Int64& ornRecSize ) = 0;
private:
typedef ::boost::shared_ptr< StreamDataSequence > StreamDataSeqRef;
StreamDataSeqRef mxRecData;
};
// ============================================================================
// ============================================================================
/** Base class for a file dumper. Derived classes implement the implDump()
function to add functionality.
*/
class DumperBase : public ObjectBase
{
public:
virtual ~DumperBase();
bool isImportEnabled() const;
bool isImportCancelled() const;
protected:
inline explicit DumperBase() {}
using ObjectBase::construct;
void construct( const ConfigRef& rxConfig );
};
// ============================================================================
// ============================================================================
} // namespace dump
} // namespace oox
#define OOX_DUMP_FILE( DumperClassName ) \
do { \
DumperClassName aDumper( *this ); \
aDumper.dump(); \
bool bCancelled = aDumper.isImportCancelled(); \
if( !aDumper.isImportEnabled() || bCancelled ) \
return aDumper.isValid() && !bCancelled; \
} while( false )
#else // OOX_INCLUDE_DUMPER
#define OOX_DUMP_FILE( DumperClassName ) (void)0
#endif // OOX_INCLUDE_DUMPER
#endif