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

 */

#pragma once

#include <basic/basicdllapi.h>

#include <basic/sbxdef.hxx>

#include <rtl/ustring.hxx>

#include <tools/ref.hxx>

class SvStream;

class ErrCode;

// 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( nSbxId, nVer )       \

    virtual sal_uInt16 GetVersion() const override { return nVer;   }    \

Unexecuted instantiation: SbxValue::GetVersion() const

Unexecuted instantiation: SbxVariable::GetVersion() const

Unexecuted instantiation: SbxObject::GetVersion() const

Unexecuted instantiation: SbxArray::GetVersion() const

Unexecuted instantiation: SbxDimArray::GetVersion() const

Unexecuted instantiation: SbxCollection::GetVersion() const

Unexecuted instantiation: SbxStdCollection::GetVersion() const

Unexecuted instantiation: SbModule::GetVersion() const

Unexecuted instantiation: StarBASIC::GetVersion() const

Unexecuted instantiation: SbxMethod::GetVersion() const

Unexecuted instantiation: SbMethod::GetVersion() const

Unexecuted instantiation: SbxProperty::GetVersion() const

Unexecuted instantiation: SbProperty::GetVersion() const

    virtual sal_uInt16 GetSbxId() const override   { return nSbxId; }

Unexecuted instantiation: SbxValue::GetSbxId() const

Unexecuted instantiation: SbxVariable::GetSbxId() const

Unexecuted instantiation: SbxObject::GetSbxId() const

Unexecuted instantiation: SbxArray::GetSbxId() const

Unexecuted instantiation: SbxDimArray::GetSbxId() const

Unexecuted instantiation: SbxCollection::GetSbxId() const

Unexecuted instantiation: SbxStdCollection::GetSbxId() const

Unexecuted instantiation: SbModule::GetSbxId() const

Unexecuted instantiation: StarBASIC::GetSbxId() const

Unexecuted instantiation: SbxMethod::GetSbxId() const

Unexecuted instantiation: SbMethod::GetSbxId() const

Unexecuted instantiation: SbxProperty::GetSbxId() const

Unexecuted instantiation: SbProperty::GetSbxId() const

class SbxFactory;

class SbxObject;

class SbxBase;

typedef tools::SvRef<SbxBase> SbxBaseRef;

typedef tools::SvRef<SbxObject> SbxObjectRef;

class BASIC_DLLPUBLIC SbxBase : virtual public SvRefBase

{

    virtual bool LoadData( SvStream&, sal_uInt16 ) = 0;

    virtual std::pair<bool, sal_uInt32> StoreData( SvStream& ) const = 0;

protected:

    SbxFlagBits nFlags;          // Flag-Bits

    SbxBase();

    SbxBase( const SbxBase& );

    SbxBase& operator=( const SbxBase& );

    virtual ~SbxBase() override;

    virtual sal_uInt16 GetVersion() const = 0;

    virtual sal_uInt16 GetSbxId() const = 0;

public:

    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         IsHidden() const;

    inline bool         IsVisible() const;

    virtual bool        IsFixed() const;

    virtual void        SetModified( bool );

    virtual SbxDataType GetType()  const;

    virtual void    Clear() = 0;

    static SbxBaseRef Load( SvStream& );

    std::pair<bool, sal_uInt32> Store( SvStream& );

    virtual bool    LoadCompleted();

    static ErrCode const & GetError();

    static OUString const& GetErrorMsg();

    static void SetError( ErrCode );

    static void SetError(ErrCode, const OUString&);

    static bool IsError();

    static void ResetError();

    // Set the factory for Load/Store/Create

    static void AddFactory( SbxFactory* );

    static void RemoveFactory( SbxFactory const * );

    static SbxBaseRef Create( sal_uInt16, sal_uInt32 );

    static SbxObjectRef CreateObject( const OUString& );

};

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 ) != SbxFlagBits::NONE; }

inline bool SbxBase::IsReset( SbxFlagBits n ) const

{ return ( nFlags & n ) == SbxFlagBits::NONE; }

inline bool SbxBase::CanRead() const

{ return IsSet( SbxFlagBits::Read ); }

inline bool SbxBase::CanWrite() const

{ return IsSet( SbxFlagBits::Write ); }

inline bool SbxBase::IsModified() const

{ return IsSet( SbxFlagBits::Modified ); }

inline bool SbxBase::IsHidden() const

{ return IsSet( SbxFlagBits::Hidden ); }

inline bool SbxBase::IsVisible() const

{ return IsReset( SbxFlagBits::Invisible ); }

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