/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: options3d.cxx,v $
*
* $Revision: 1.5 $
*
* last change: $Author: rt $ $Date: 2005-11-11 08:52:41 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 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
*
************************************************************************/
#ifndef GCC
#pragma hdrstop
#endif
//_________________________________________________________________________________________________________________
// includes
//_________________________________________________________________________________________________________________
#include "options3d.hxx"
#ifndef _UTL_CONFIGMGR_HXX_
#include <unotools/configmgr.hxx>
#endif
#ifndef _UTL_CONFIGITEM_HXX_
#include <unotools/configitem.hxx>
#endif
#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_ANY_HXX_
#include <com/sun/star/uno/Any.hxx>
#endif
#ifndef _COM_SUN_STAR_UNO_SEQUENCE_HXX_
#include <com/sun/star/uno/Sequence.hxx>
#endif
#include <itemholder1.hxx>
//_________________________________________________________________________________________________________________
// namespaces
//_________________________________________________________________________________________________________________
using namespace ::utl ;
using namespace ::rtl ;
using namespace ::osl ;
using namespace ::com::sun::star::uno ;
//_________________________________________________________________________________________________________________
// const
//_________________________________________________________________________________________________________________
#define ROOTNODE_START OUString(RTL_CONSTASCII_USTRINGPARAM("Office.Common/_3D_Engine" ))
#define DEFAULT_DITHERING sal_True
#define DEFAULT_OPENGL sal_True
#define DEFAULT_OPENGL_FASTER sal_True
#define DEFAULT_OPENGL_FASTER sal_True
#define DEFAULT_SHOWFULL sal_False
#define PROPERTYNAME_DITHERING OUString(RTL_CONSTASCII_USTRINGPARAM("Dithering" ))
#define PROPERTYNAME_OPENGL OUString(RTL_CONSTASCII_USTRINGPARAM("OpenGL" ))
#define PROPERTYNAME_OPENGL_FASTER OUString(RTL_CONSTASCII_USTRINGPARAM("OpenGL_Faster" ))
#define PROPERTYNAME_SHOWFULL OUString(RTL_CONSTASCII_USTRINGPARAM("ShowFull" ))
#define PROPERTYHANDLE_DITHERING 0
#define PROPERTYHANDLE_OPENGL 1
#define PROPERTYHANDLE_OPENGL_FASTER 2
#define PROPERTYHANDLE_SHOWFULL 3
#define PROPERTYCOUNT 4
class SvtOptions3D_Impl : public ConfigItem
{
public:
//---------------------------------------------------------------------------------------------------------
// constructor / destructor
//---------------------------------------------------------------------------------------------------------
SvtOptions3D_Impl();
~SvtOptions3D_Impl();
//---------------------------------------------------------------------------------------------------------
// overloaded methods of baseclass
//---------------------------------------------------------------------------------------------------------
virtual void Commit();
//---------------------------------------------------------------------------------------------------------
// public interface
//---------------------------------------------------------------------------------------------------------
sal_Bool IsDithering() const;
sal_Bool IsOpenGL() const;
sal_Bool IsOpenGL_Faster() const;
sal_Bool IsShowFull() const;
void SetDithering( sal_Bool bState );
void SetOpenGL( sal_Bool bState );
void SetOpenGL_Faster( sal_Bool bState );
void SetShowFull( sal_Bool bState );
//-------------------------------------------------------------------------------------------------------------
// private methods
//-------------------------------------------------------------------------------------------------------------
private:
static Sequence< OUString > impl_GetPropertyNames();
//-------------------------------------------------------------------------------------------------------------
// private member
//-------------------------------------------------------------------------------------------------------------
private:
sal_Bool m_bDithering;
sal_Bool m_bOpenGL;
sal_Bool m_bOpenGL_Faster;
sal_Bool m_bShowFull;
};
//_________________________________________________________________________________________________________________
// definitions
//_________________________________________________________________________________________________________________
//*****************************************************************************************************************
// constructor
//*****************************************************************************************************************
SvtOptions3D_Impl::SvtOptions3D_Impl() :
ConfigItem( ROOTNODE_START ),
m_bDithering( DEFAULT_DITHERING ),
m_bOpenGL( DEFAULT_OPENGL ),
m_bOpenGL_Faster( DEFAULT_OPENGL_FASTER ),
m_bShowFull( DEFAULT_SHOWFULL )
{
Sequence< OUString > seqNames( impl_GetPropertyNames() );
Sequence< Any > seqValues = GetProperties( seqNames ) ;
DBG_ASSERT( !(seqNames.getLength()!=seqValues.getLength()), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nI miss some values of configuration keys!\n" );
// Copy values from list in right order to ouer internal member.
sal_Int32 nPropertyCount = seqValues.getLength();
sal_Int32 nProperty = 0;
for( nProperty=0; nProperty<nPropertyCount; ++nProperty )
{
DBG_ASSERT( !(seqValues[nProperty].hasValue()==sal_False), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nInvalid property value for property detected!\n" );
switch( nProperty )
{
case PROPERTYHANDLE_DITHERING:
{
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nWho has changed the value type of \"Office.Common\\_3D_Engine\\Dithering\"?" );
seqValues[nProperty] >>= m_bDithering;
}
break;
case PROPERTYHANDLE_OPENGL:
{
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nWho has changed the value type of \"Office.Common\\_3D_Engine\\OpenGL\"?" );
seqValues[nProperty] >>= m_bOpenGL;
}
break;
case PROPERTYHANDLE_OPENGL_FASTER:
{
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nWho has changed the value type of \"Office.Common\\_3D_Engine\\OpenGL_Faster\"?" );
seqValues[nProperty] >>= m_bOpenGL_Faster;
}
break;
case PROPERTYHANDLE_SHOWFULL:
{
DBG_ASSERT(!(seqValues[nProperty].getValueTypeClass()!=TypeClass_BOOLEAN), "SvtOptions3D_Impl::SvtOptions3D_Impl()\nWho has changed the value type of \"Office.Common\\_3D_Engine\\ShowFull\"?" );
seqValues[nProperty] >>= m_bShowFull;
}
break;
}
}
}
//*****************************************************************************************************************
// destructor
//*****************************************************************************************************************
SvtOptions3D_Impl::~SvtOptions3D_Impl()
{
if( IsModified() )
Commit();
}
//*****************************************************************************************************************
// Commit
//*****************************************************************************************************************
void SvtOptions3D_Impl::Commit()
{
Sequence< OUString > aSeqNames( impl_GetPropertyNames() );
Sequence< Any > aSeqValues( aSeqNames.getLength() );
for( sal_Int32 nProperty = 0, nCount = aSeqNames.getLength(); nProperty < nCount; ++nProperty )
{
switch( nProperty )
{
case PROPERTYHANDLE_DITHERING:
aSeqValues[nProperty] <<= m_bDithering;
break;
case PROPERTYHANDLE_OPENGL:
aSeqValues[nProperty] <<= m_bOpenGL;
break;
case PROPERTYHANDLE_OPENGL_FASTER:
aSeqValues[nProperty] <<= m_bOpenGL_Faster;
break;
case PROPERTYHANDLE_SHOWFULL:
aSeqValues[nProperty] <<= m_bShowFull;
break;
}
}
PutProperties( aSeqNames, aSeqValues );
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D_Impl::IsDithering() const
{
return m_bDithering;
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D_Impl::IsOpenGL() const
{
return m_bOpenGL;
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D_Impl::IsOpenGL_Faster() const
{
return m_bOpenGL_Faster;
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D_Impl::IsShowFull() const
{
return m_bShowFull;
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D_Impl::SetDithering( sal_Bool bState )
{
m_bDithering = bState;
SetModified();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D_Impl::SetOpenGL( sal_Bool bState )
{
m_bOpenGL = bState;
SetModified();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D_Impl::SetOpenGL_Faster( sal_Bool bState )
{
m_bOpenGL_Faster = bState;
SetModified();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D_Impl::SetShowFull( sal_Bool bState )
{
m_bShowFull = bState;
SetModified();
}
//*****************************************************************************************************************
// private method
//*****************************************************************************************************************
Sequence< OUString > SvtOptions3D_Impl::impl_GetPropertyNames()
{
// Build static list of configuration key names.
static const OUString pProperties[] =
{
PROPERTYNAME_DITHERING ,
PROPERTYNAME_OPENGL ,
PROPERTYNAME_OPENGL_FASTER ,
PROPERTYNAME_SHOWFULL
};
// Initialize return sequence with these list ...
static const Sequence< OUString > seqPropertyNames( pProperties, PROPERTYCOUNT );
// ... and return it.
return seqPropertyNames;
}
//*****************************************************************************************************************
// initialize static member
// DON'T DO IT IN YOUR HEADER!
// see definition for further informations
//*****************************************************************************************************************
SvtOptions3D_Impl* SvtOptions3D::m_pDataContainer = NULL ;
sal_Int32 SvtOptions3D::m_nRefCount = 0 ;
//*****************************************************************************************************************
// constructor
//*****************************************************************************************************************
SvtOptions3D::SvtOptions3D()
{
// Global access, must be guarded (multithreading!).
MutexGuard aGuard( GetOwnStaticMutex() );
// Increase ouer refcount ...
++m_nRefCount;
// ... and initialize ouer data container only if it not already!
if( m_pDataContainer == NULL )
{
m_pDataContainer = new SvtOptions3D_Impl();
ItemHolder1::holdConfigItem(E_OPTIONS3D);
}
}
//*****************************************************************************************************************
// destructor
//*****************************************************************************************************************
SvtOptions3D::~SvtOptions3D()
{
// Global access, must be guarded (multithreading!)
MutexGuard aGuard( GetOwnStaticMutex() );
// Decrease ouer refcount.
--m_nRefCount;
// If last instance was deleted ...
// we must destroy ouer static data container!
if( m_nRefCount <= 0 )
{
delete m_pDataContainer;
m_pDataContainer = NULL;
}
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D::IsDithering() const
{
MutexGuard aGuard( GetOwnStaticMutex() );
return m_pDataContainer->IsDithering();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D::IsOpenGL() const
{
MutexGuard aGuard( GetOwnStaticMutex() );
return m_pDataContainer->IsOpenGL();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D::IsOpenGL_Faster() const
{
MutexGuard aGuard( GetOwnStaticMutex() );
return m_pDataContainer->IsOpenGL_Faster();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
sal_Bool SvtOptions3D::IsShowFull() const
{
MutexGuard aGuard( GetOwnStaticMutex() );
return m_pDataContainer->IsShowFull();
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D::SetDithering( sal_Bool bState )
{
MutexGuard aGuard( GetOwnStaticMutex() );
m_pDataContainer->SetDithering( bState );
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D::SetOpenGL( sal_Bool bState )
{
MutexGuard aGuard( GetOwnStaticMutex() );
m_pDataContainer->SetOpenGL( bState );
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D::SetOpenGL_Faster( sal_Bool bState )
{
MutexGuard aGuard( GetOwnStaticMutex() );
m_pDataContainer->SetOpenGL_Faster( bState );
}
//*****************************************************************************************************************
// public method
//*****************************************************************************************************************
void SvtOptions3D::SetShowFull( sal_Bool bState )
{
MutexGuard aGuard( GetOwnStaticMutex() );
m_pDataContainer->SetShowFull( bState );
}
//*****************************************************************************************************************
// private method
//*****************************************************************************************************************
Mutex& SvtOptions3D::GetOwnStaticMutex()
{
// Initialize static mutex only for one time!
static Mutex* pMutex = NULL;
// If these method first called (Mutex not already exist!) ...
if( pMutex == NULL )
{
// ... we must create a new one. Protect follow code with the global mutex -
// It must be - we create a static variable!
MutexGuard aGuard( Mutex::getGlobalMutex() );
// We must check our pointer again - because it can be that another instance of ouer class will be fastr then these!
if( pMutex == NULL )
{
// Create the new mutex and set it for return on static variable.
static Mutex aMutex;
pMutex = &aMutex;
}
}
// Return new created or already existing mutex object.
return *pMutex;
}