/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef INCLUDED_BASIC_SBXCORE_HXX
#define INCLUDED_BASIC_SBXCORE_HXX

#include <tools/rtti.hxx>
#include <tools/ref.hxx>

#include <basic/sbxdef.hxx>
#include <basic/basicdllapi.h>

class SvStream;

// The following Macro defines four (five) necessary methods within a
// SBX object. LoadPrivateData() and StorePrivateData() must be implemented.
// They are necessary for loading/storing the data of derived classes.
// Load() and Store() must not be overridden.

// This version of the Macros does not define Load/StorePrivateData()-methods
#define SBX_DECL_PERSIST_NODATA( nCre, nSbxId, nVer )       \
    virtual sal_uInt32 GetCreator() const SAL_OVERRIDE { return nCre;   }    \
    virtual sal_uInt16 GetVersion() const SAL_OVERRIDE { return nVer;   }    \
    virtual sal_uInt16 GetSbxId() const SAL_OVERRIDE   { return nSbxId; }

// This version of the macro defines Load/StorePrivateData()-methods
#define SBX_DECL_PERSIST( nCre, nSbxId, nVer )              \
    virtual bool LoadPrivateData( SvStream&, sal_uInt16 );      \
    virtual bool StorePrivateData( SvStream& ) const;       \
    virtual sal_uInt32 GetCreator() const { return nCre;   }    \
    virtual sal_uInt16 GetVersion() const { return nVer;   }    \
    virtual sal_uInt16 GetSbxId() const   { return nSbxId; }

class SbxBase;
class SbxFactory;
class SbxObject;

class BASIC_DLLPUBLIC SbxBase : virtual public SvRefBase
{
    virtual bool LoadData( SvStream&, sal_uInt16 );
    virtual bool StoreData( SvStream& ) const;
protected:
    SbxFlagBits nFlags;          // Flag-Bits

    SbxBase();
    SbxBase( const SbxBase& );
    SbxBase& operator=( const SbxBase& );
    virtual ~SbxBase();
    SBX_DECL_PERSIST(0,0,0);
public:
    TYPEINFO();
    inline void         SetFlags( SbxFlagBits n );
    inline SbxFlagBits  GetFlags() const;
    inline void         SetFlag( SbxFlagBits n );
    inline void         ResetFlag( SbxFlagBits n );
    inline bool         IsSet( SbxFlagBits n ) const;
    inline bool         IsReset( SbxFlagBits n ) const;
    inline bool         CanRead() const;
    inline bool         CanWrite() const;
    inline bool         IsModified() const;
    inline bool         IsConst() const;
    inline bool         IsHidden() const;
    inline bool         IsVisible() const;

    virtual bool        IsFixed() const;
    virtual void        SetModified( bool );

    virtual SbxDataType GetType()  const;
    virtual SbxClassType GetClass() const;

    virtual void Clear();

    static SbxBase* Load( SvStream& );
    static void     Skip( SvStream& );
    bool            Store( SvStream& );
    virtual bool    LoadCompleted();
    virtual bool    StoreCompleted();

    static SbxError GetError();
    static void SetError( SbxError );
    static bool IsError();
    static void ResetError();

    // Set the factory for Load/Store/Create
    static void AddFactory( SbxFactory* );
    static void RemoveFactory( SbxFactory* );

    static SbxBase* Create( sal_uInt16, sal_uInt32=SBXCR_SBX );
    static SbxObject* CreateObject( const OUString& );
};

typedef tools::SvRef<SbxBase> SbxBaseRef;

inline void SbxBase::SetFlags( SbxFlagBits n )
{ nFlags = n; }

inline SbxFlagBits SbxBase::GetFlags() const
{ return nFlags; }

inline void SbxBase::SetFlag( SbxFlagBits n )
{ nFlags |= n; }

inline void SbxBase::ResetFlag( SbxFlagBits n )
{ nFlags &= ~n; }

inline bool SbxBase::IsSet( SbxFlagBits n ) const
{ return ( nFlags & n ) != SBX_NONE; }

inline bool SbxBase::IsReset( SbxFlagBits n ) const
{ return ( nFlags & n ) == SBX_NONE; }

inline bool SbxBase::CanRead() const
{ return IsSet( SBX_READ ); }

inline bool SbxBase::CanWrite() const
{ return IsSet( SBX_WRITE ); }

inline bool SbxBase::IsModified() const
{ return IsSet( SBX_MODIFIED ); }

inline bool SbxBase::IsConst() const
{ return IsSet( SBX_CONST ); }

inline bool SbxBase::IsHidden() const
{ return IsSet( SBX_HIDDEN ); }

inline bool SbxBase::IsVisible() const
{ return IsReset( SBX_INVISIBLE ); }

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
