initial checkin - helper for control models with limited formatting capabilities

2 files changed, 575 insertions, 0 deletions

diff --git a/forms/source/inc/limitedformats.hxx b/forms/source/inc/limitedformats.hxx
new file mode 100644
index 000000000000..a3a555617357
--- /dev/null
+++ b/forms/source/inc/limitedformats.hxx
@@ -0,0 +1,151 @@
+/*************************************************************************
+ *
+ *  $RCSfile: limitedformats.hxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: fs $ $Date: 2001-05-18 14:47:28 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef _FORMS_LIMITED_FORMATS_HXX_
+#define _FORMS_LIMITED_FORMATS_HXX_
+
+#ifndef _OSL_MUTEX_HXX_
+#include <osl/mutex.hxx>
+#endif
+#ifndef _COM_SUN_STAR_UTIL_XNUMBERFORMATSSUPPLIER_HPP_
+#include <com/sun/star/util/XNumberFormatsSupplier.hpp>
+#endif
+#ifndef _COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
+#include <com/sun/star/lang/XMultiServiceFactory.hpp>
+#endif
+#include <com/sun/star/beans/XFastPropertySet.hpp>
+
+//.........................................................................
+namespace frm
+{
+//.........................................................................
+
+    //=====================================================================
+    //= OLimitedFormats
+    //=====================================================================
+    /** maintains translation tables format key <-> enum value
+        <p>Used for controls which provide a limited number for (standard) formats, which
+        should be available as format keys.</p>
+    */
+    class OLimitedFormats
+    {
+    private:
+        static sal_Int32    s_nInstanceCount;
+        static ::osl::Mutex s_aMutex;
+        static ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >
+                            s_xStandardFormats;
+
+    protected:
+        sal_Int32           m_nFormatEnumPropertyHandle;
+        const sal_Int16     m_nTableId;
+        ::com::sun::star::uno::Reference< ::com::sun::star::beans::XFastPropertySet >
+                            m_xAggregate;
+
+    protected:
+        /** ctor
+            <p>The class id is used to determine the translation table to use. All instances which
+            pass the same value here share one table.</p>
+        */
+        OLimitedFormats(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB,
+            const sal_Int16 _nClassId
+            );
+        ~OLimitedFormats();
+
+    protected:
+        void setAggregateSet(
+            const ::com::sun::star::uno::Reference< ::com::sun::star::beans::XFastPropertySet >& _rxAggregate,
+            sal_Int32 _nOriginalPropertyHandle
+        );
+
+    protected:
+        void        getFormatKeyPropertyValue( ::com::sun::star::uno::Any& _rValue ) const;
+        sal_Bool    convertFormatKeyPropertyValue(
+                        ::com::sun::star::uno::Any& _rConvertedValue,
+                        ::com::sun::star::uno::Any& _rOldValue,
+                const   ::com::sun::star::uno::Any& _rNewValue
+            );
+        void        setFormatKeyPropertyValue( const ::com::sun::star::uno::Any& _rNewValue );
+        // setFormatKeyPropertyValue should only be called with a value got from convertFormatKeyPropertyValue!
+
+        ::com::sun::star::uno::Reference< ::com::sun::star::util::XNumberFormatsSupplier >
+                    getFormatsSupplier() const { return s_xStandardFormats; }
+
+    private:
+        void acquireSupplier(const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& _rxORB);
+        void releaseSupplier();
+
+        static void ensureTableInitialized(const sal_Int16 _nTableId);
+    };
+
+//.........................................................................
+}   // namespace frm
+//.........................................................................
+
+#endif // _FORMS_LIMITED_FORMATS_HXX_
+
+/*************************************************************************
+ * history:
+ *  $Log: not supported by cvs2svn $
+ *
+ *  Revision 1.0 18.05.01 10:38:19  fs
+ ************************************************************************/
+
diff --git a/forms/source/misc/limitedformats.cxx b/forms/source/misc/limitedformats.cxx
new file mode 100644
index 000000000000..0e8cd24172d6
--- /dev/null
+++ b/forms/source/misc/limitedformats.cxx
@@ -0,0 +1,424 @@
+/*************************************************************************
+ *
+ *  $RCSfile: limitedformats.cxx,v $
+ *
+ *  $Revision: 1.1 $
+ *
+ *  last change: $Author: fs $ $Date: 2001-05-18 14:48:05 $
+ *
+ *  The Contents of this file are made available subject to the terms of
+ *  either of the following licenses
+ *
+ *         - GNU Lesser General Public License Version 2.1
+ *         - Sun Industry Standards Source License Version 1.1
+ *
+ *  Sun Microsystems Inc., October, 2000
+ *
+ *  GNU Lesser General Public License Version 2.1
+ *  =============================================
+ *  Copyright 2000 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
+ *
+ *
+ *  Sun Industry Standards Source License Version 1.1
+ *  =================================================
+ *  The contents of this file are subject to the Sun Industry Standards
+ *  Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ *  Software provided under this License is provided on an "AS IS" basis,
+ *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
+ *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ *  See the License for the specific provisions governing your rights and
+ *  obligations concerning the Software.
+ *
+ *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
+ *
+ *  Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ *  All Rights Reserved.
+ *
+ *  Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+
+#ifndef _FORMS_LIMITED_FORMATS_HXX_
+#include "limitedformats.hxx"
+#endif
+#ifndef _FRM_SERVICES_HXX_
+#include "services.hxx"
+#endif
+#ifndef _OSL_DIAGNOSE_H_
+#include <osl/diagnose.h>
+#endif
+#ifndef _COMPHELPER_TYPES_HXX_
+#include <comphelper/types.hxx>
+#endif
+#ifndef _COMPHELPER_EXTRACT_HXX_
+#include <comphelper/extract.hxx>
+#endif
+#ifndef _COM_SUN_STAR_FORM_FORMCOMPONENTTYPE_HPP_
+#include <com/sun/star/form/FormComponentType.hpp>
+#endif
+
+//.........................................................................
+namespace frm
+{
+//.........................................................................
+
+    using namespace ::com::sun::star::uno;
+    using namespace ::com::sun::star::util;
+    using namespace ::com::sun::star::lang;
+    using namespace ::com::sun::star::form;
+    using namespace ::com::sun::star::beans;
+
+    sal_Int32                               OLimitedFormats::s_nInstanceCount(0);
+    ::osl::Mutex                            OLimitedFormats::s_aMutex;
+    Reference< XNumberFormatsSupplier >     OLimitedFormats::s_xStandardFormats;
+
+    //=====================================================================
+    //=
+    //=====================================================================
+    //---------------------------------------------------------------------
+    enum LocaleType
+    {
+        ltEnglishUS,
+        ltGerman,
+        ltSystem
+    };
+
+    //---------------------------------------------------------------------
+    static const Locale& getLocale(LocaleType _eType)
+    {
+        static Locale s_aEnglishUS( ::rtl::OUString::createFromAscii("en"), ::rtl::OUString::createFromAscii("us"), ::rtl::OUString() );
+        static Locale s_aGerman( ::rtl::OUString::createFromAscii("de"), ::rtl::OUString::createFromAscii("DE"), ::rtl::OUString() );
+        static Locale s_aSystem( ::rtl::OUString(), ::rtl::OUString(), ::rtl::OUString() );
+
+        switch (_eType)
+        {
+            case ltEnglishUS:
+                return s_aEnglishUS;
+
+            case ltGerman:
+                return s_aGerman;
+
+            case ltSystem:
+                return s_aSystem;
+        }
+
+        OSL_ENSURE(sal_False, "getLocale: invalid enum value!");
+        return s_aSystem;
+    }
+
+    //---------------------------------------------------------------------
+    struct FormatEntry
+    {
+        const sal_Char* pDescription;
+        sal_Int32       nKey;
+        LocaleType      eLocale;
+    };
+
+    //---------------------------------------------------------------------
+    static const FormatEntry* lcl_getFormatTable(sal_Int16 nTableId)
+    {
+        switch (nTableId)
+        {
+            case FormComponentType::TIMEFIELD:
+            {
+                static FormatEntry s_aFormats[] = {
+                    { "HH:MM", -1, ltEnglishUS },
+                    { "HH:MM:SS", -1, ltEnglishUS },
+                    { "HH:MM AM/PM", -1, ltEnglishUS },
+                    { "HH:MM:SS AM/PM", -1, ltEnglishUS },
+                    { NULL, -1 }
+                };
+                // don't switch this table here to const. The compiler could be tempted to really place this
+                // in a non-writeable segment, but we want to fill in the format keys later ....
+                return s_aFormats;
+            }
+            break;
+            case FormComponentType::DATEFIELD:
+            {
+                static FormatEntry s_aFormats[] = {
+                    { "M/D/YY", -1, ltSystem },
+                    { "MM/DD/YY", -1, ltSystem },
+                    { "MM/DD/YYYY", -1, ltSystem },
+                    { "NNNNMMMM DD, YYYY", -1, ltSystem },
+
+                    { "DD/MM/YY", -1, ltEnglishUS },
+                    { "MM/DD/YY", -1, ltEnglishUS },
+                    { "YY/MM/DD", -1, ltEnglishUS },
+                    { "DD/MM/YYYY", -1, ltEnglishUS },
+                    { "MM/DD/YYYY", -1, ltEnglishUS },
+                    { "YYYY/MM/DD", -1, ltEnglishUS },
+
+                    { "JJ-MM-TT", -1, ltGerman },
+                    { "JJJJ-MM-TT", -1, ltGerman },
+
+                    { NULL, -1 }
+                };
+                return s_aFormats;
+            }
+        }
+
+        OSL_ENSURE(sal_False, "lcl_getFormatTable: invalid id!");
+        return NULL;
+    }
+
+    //=====================================================================
+    //= OLimitedFormats
+    //=====================================================================
+    //---------------------------------------------------------------------
+    OLimitedFormats::OLimitedFormats(const Reference< XMultiServiceFactory >& _rxORB, const sal_Int16 _nClassId)
+        :m_nTableId(_nClassId)
+        ,m_nFormatEnumPropertyHandle(-1)
+    {
+        OSL_ENSURE(_rxORB.is(), "OLimitedFormats::OLimitedFormats: invalid service factory!");
+        acquireSupplier(_rxORB);
+        ensureTableInitialized(m_nTableId);
+    }
+
+    //---------------------------------------------------------------------
+    OLimitedFormats::~OLimitedFormats()
+    {
+        releaseSupplier();
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::ensureTableInitialized(const sal_Int16 _nTableId)
+    {
+        const FormatEntry* pFormatTable = lcl_getFormatTable(_nTableId);
+        if (-1 == pFormatTable->nKey)
+        {
+            ::osl::MutexGuard aGuard(s_aMutex);
+            if (-1 == pFormatTable->nKey)
+            {
+                // initialize the keys
+                Reference<XNumberFormats> xStandardFormats;
+                if (s_xStandardFormats.is())
+                    xStandardFormats = s_xStandardFormats->getNumberFormats();
+                OSL_ENSURE(xStandardFormats.is(), "OLimitedFormats::ensureTableInitialized: don't have a formats supplier!");
+
+                if (xStandardFormats.is())
+                {
+                    // loop through the table
+                    FormatEntry* pLoopFormats = const_cast<FormatEntry*>(pFormatTable);
+                    while (pLoopFormats->pDescription)
+                    {
+                        // get the key for the description
+                        pLoopFormats->nKey = xStandardFormats->queryKey(
+                            ::rtl::OUString::createFromAscii(pLoopFormats->pDescription),
+                            getLocale(pLoopFormats->eLocale),
+                            sal_False
+                        );
+
+                        if (-1 == pLoopFormats->nKey)
+                        {
+                            pLoopFormats->nKey = xStandardFormats->addNew(
+                                ::rtl::OUString::createFromAscii(pLoopFormats->pDescription),
+                                getLocale(pLoopFormats->eLocale)
+                            );
+                        }
+
+                        // next
+                        ++pLoopFormats;
+                    }
+                }
+            }
+        }
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::setAggregateSet(const Reference< XFastPropertySet >& _rxAggregate, sal_Int32 _nOriginalPropertyHandle)
+    {
+        // changes (NULL -> not NULL) and (not NULL -> NULL) are allowed
+        OSL_ENSURE(!m_xAggregate.is() || !_rxAggregate.is(), "OLimitedFormats::setAggregateSet: already have an aggregate!");
+        OSL_ENSURE(_rxAggregate.is() || m_xAggregate.is(), "OLimitedFormats::setAggregateSet: invalid new aggregate!");
+
+        m_xAggregate = _rxAggregate;
+        m_nFormatEnumPropertyHandle = _nOriginalPropertyHandle;
+#ifdef DBG_UTIL
+        if (m_xAggregate.is())
+        {
+            try
+            {
+                m_xAggregate->getFastPropertyValue(m_nFormatEnumPropertyHandle);
+            }
+            catch(const Exception&)
+            {
+                OSL_ENSURE(sal_False, "OLimitedFormats::setAggregateSet: invalid handle!");
+            }
+        }
+#endif
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::getFormatKeyPropertyValue( Any& _rValue ) const
+    {
+        _rValue.clear();
+
+        OSL_ENSURE(m_xAggregate.is() && (-1 != m_nFormatEnumPropertyHandle), "OLimitedFormats::getFormatKeyPropertyValue: not initialized!");
+        if (m_xAggregate.is())
+        {
+            // get the aggregate's enum property value
+            Any aEnumPropertyValue = m_xAggregate->getFastPropertyValue(m_nFormatEnumPropertyHandle);
+            sal_Int32 nValue = -1;
+            ::cppu::enum2int(nValue, aEnumPropertyValue);
+
+            // get the translation table
+            const FormatEntry* pFormats = lcl_getFormatTable(m_nTableId);
+
+            // seek to the nValue'th entry
+            sal_Int32 nLookup = 0;
+            for (   ;
+                    (NULL != pFormats->pDescription) && (nLookup < nValue);
+                    ++pFormats, ++nLookup
+                )
+                ;
+            OSL_ENSURE(NULL != pFormats->pDescription, "OLimitedFormats::getFormatKeyPropertyValue: did not find the value!");
+            if (pFormats->pDescription)
+                _rValue <<= pFormats->nKey;
+        }
+
+        // TODO: should use a standard format for the control type we're working for
+    }
+
+    //---------------------------------------------------------------------
+    sal_Bool OLimitedFormats::convertFormatKeyPropertyValue(Any& _rConvertedValue, Any& _rOldValue, const Any& _rNewValue)
+    {
+        OSL_ENSURE(m_xAggregate.is() && (-1 != m_nFormatEnumPropertyHandle), "OLimitedFormats::convertFormatKeyPropertyValue: not initialized!");
+
+        if (m_xAggregate.is())
+        {
+            // the new format key to set
+            sal_Int32 nNewFormat = 0;
+            if (!(_rNewValue >>= nNewFormat))
+                throw IllegalArgumentException();
+
+            // get the old (enum) value from the aggregate
+            Any aEnumPropertyValue = m_xAggregate->getFastPropertyValue(m_nFormatEnumPropertyHandle);
+            sal_Int32 nOldEnumValue = -1;
+            ::cppu::enum2int(nOldEnumValue, aEnumPropertyValue);
+
+            // get the translation table
+            const FormatEntry* pFormats = lcl_getFormatTable(m_nTableId);
+
+            _rOldValue.clear();
+            _rConvertedValue.clear();
+
+            // look for the entry with the given format key
+            sal_Int32 nTablePosition = 0;
+            for (   ;
+                    (NULL != pFormats->pDescription) && (nNewFormat != pFormats->nKey);
+                    ++pFormats, ++nTablePosition
+                )
+            {
+                if (nTablePosition == nOldEnumValue)
+                    _rOldValue <<= pFormats->nKey;
+            }
+
+            sal_Bool bFoundIt = (NULL != pFormats->pDescription);
+            sal_Bool bModified = sal_False;
+            if (bFoundIt)
+            {
+                _rConvertedValue <<= (sal_Int16)nTablePosition;
+                bModified = nTablePosition != nOldEnumValue;
+            }
+
+            if (!bFoundIt && !_rOldValue.hasValue())
+            {   // did not reach the end of the table (means we found nNewFormat)
+                // -> go to the end to ensure that _rOldValue is set
+                while (pFormats->pDescription)
+                {
+                    if (nTablePosition == nOldEnumValue)
+                        _rOldValue <<= pFormats->nKey;
+
+                    ++pFormats;
+                    ++nTablePosition;
+                }
+            }
+
+            OSL_ENSURE(_rOldValue.hasValue(), "OLimitedFormats::convertFormatKeyPropertyValue: did not find the old enum value in the table!");
+
+            if (!bFoundIt)
+            {   // somebody gave us an format which we can't translate
+                ::rtl::OUString sMessage = ::rtl::OUString::createFromAscii("This control supports only a very limited number of formats.");
+                throw IllegalArgumentException(sMessage, NULL, 2);
+            }
+
+            return bModified;
+        }
+
+        return sal_False;
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::setFormatKeyPropertyValue( const Any& _rNewValue )
+    {
+        OSL_ENSURE(m_xAggregate.is() && (-1 != m_nFormatEnumPropertyHandle), "OLimitedFormats::setFormatKeyPropertyValue: not initialized!");
+
+        if (m_xAggregate.is())
+        {   // this is to be called after convertFormatKeyPropertyValue, where
+            // we translated the format key into a enum value.
+            // So now we can simply forward this enum value to our aggreate
+            m_xAggregate->setFastPropertyValue(m_nFormatEnumPropertyHandle, _rNewValue);
+        }
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::acquireSupplier(const Reference< XMultiServiceFactory >& _rxORB)
+    {
+        ::osl::MutexGuard aGuard(s_aMutex);
+        if ((1 == ++s_nInstanceCount) && _rxORB.is())
+        {   // create the standard formatter
+
+            Sequence< Any > aInit(1);
+            aInit[0] <<= getLocale(ltEnglishUS);
+
+            Reference< XInterface > xSupplier = _rxORB->createInstanceWithArguments(FRM_NUMBER_FORMATS_SUPPLIER, aInit);
+            OSL_ENSURE(xSupplier.is(), "OLimitedFormats::OLimitedFormats: could not create a formats supplier!");
+
+            s_xStandardFormats = Reference< XNumberFormatsSupplier >(xSupplier, UNO_QUERY);
+            OSL_ENSURE(s_xStandardFormats.is() || !xSupplier.is(), "OLimitedFormats::OLimitedFormats: missing an interface!");
+        }
+    }
+
+    //---------------------------------------------------------------------
+    void OLimitedFormats::releaseSupplier()
+    {
+        ::osl::MutexGuard aGuard(s_aMutex);
+        if (0 == --s_nInstanceCount)
+        {
+            ::comphelper::disposeComponent(s_xStandardFormats);
+            s_xStandardFormats = NULL;
+        }
+    }
+
+//.........................................................................
+}   // namespace frm
+//.........................................................................
+
+/*************************************************************************
+ * history:
+ *  $Log: not supported by cvs2svn $
+ *
+ *  Revision 1.0 18.05.01 10:39:57  fs
+ ************************************************************************/
+