fdo#37290: allow also access to StringList resources

extensions/source/resource/ResourceIndexAccess.cxx

@@ -0,0 +1,208 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License or as specified alternatively below. You may obtain a copy of
+ * the License at http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Initial Developer of the Original Code is
+ *      Bjoern Michaelsen <bjoern.michaelsen@canonical.com>
+ * Portions created by the Initial Developer are Copyright (C) 2010 the
+ * Initial Developer. All Rights Reserved.
+ *
+ * Major Contributor(s):
+ *
+ * For minor contributions see the git repository.
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+#include <ResourceIndexAccess.hxx>
+
+#include <com/sun/star/container/XIndexAccess.hpp>
+#include <com/sun/star/beans/PropertyValue.hpp>
+#include <comphelper/stlunosequence.hxx>
+#include <osl/mutex.hxx>
+#include <tools/rcid.h>
+#include <tools/resary.hxx>
+#include <tools/resmgr.hxx>
+#include <vcl/svapp.hxx>
+
+using namespace ::extensions::resource;
+using namespace ::com::sun::star::uno;
+using namespace ::com::sun::star::lang;
+using namespace ::com::sun::star::beans;
+using namespace ::com::sun::star::container;
+
+using ::comphelper::stl_begin;
+using ::comphelper::stl_end;
+using ::rtl::OString;
+using ::rtl::OUString;
+using ::rtl::OUStringToOString;
+
+namespace
+{
+    static ::boost::shared_ptr<ResMgr> GetResMgr(Sequence<Any> const& rArgs)
+    {
+        if(rArgs.getLength()!=1)
+            return ::boost::shared_ptr<ResMgr>();
+        OUString sFilename;
+        rArgs[0] >>= sFilename;
+        SolarMutexGuard aGuard;
+        const OString sEncName(OUStringToOString(sFilename, osl_getThreadTextEncoding()));
+        return ::boost::shared_ptr<ResMgr>(ResMgr::CreateResMgr(sEncName));
+    }
+
+    class ResourceIndexAccessBase : public cppu::WeakImplHelper1< ::com::sun::star::container::XIndexAccess>
+    {
+        public:
+            ResourceIndexAccessBase( ::boost::shared_ptr<ResMgr> pResMgr)
+                : m_pResMgr(pResMgr)
+            {
+                OSL_ENSURE(m_pResMgr, "no ressource manager given");
+            }
+
+            // XIndexAccess
+            virtual ::sal_Int32 SAL_CALL getCount(  ) throw (::com::sun::star::uno::RuntimeException)
+                { return m_pResMgr.get() ? SAL_MAX_UINT16 : 0; };
+            // XElementAccess
+            virtual ::sal_Bool SAL_CALL hasElements(  ) throw (::com::sun::star::uno::RuntimeException)
+                { return static_cast<bool>(m_pResMgr.get()); };
+
+        protected:
+            // m_pResMgr should never be NULL
+            const ::boost::shared_ptr<ResMgr> m_pResMgr;
+    };
+
+    class ResourceStringIndexAccess : public ResourceIndexAccessBase
+    {
+        public:
+            ResourceStringIndexAccess( ::boost::shared_ptr<ResMgr> pResMgr)
+                : ResourceIndexAccessBase(pResMgr) {}
+            // XIndexAccess
+            virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+            // XElementAccessBase
+            virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException)
+                { return ::getCppuType(reinterpret_cast< ::rtl::OUString*>(NULL)); };
+    };
+
+    class ResourceStringListIndexAccess : public ResourceIndexAccessBase
+    {
+        public:
+            ResourceStringListIndexAccess( ::boost::shared_ptr<ResMgr> pResMgr)
+                : ResourceIndexAccessBase(pResMgr) {}
+            // XIndexAccess
+            virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+            // XElementAccessBase
+            virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException)
+                { return ::getCppuType(reinterpret_cast<Sequence<PropertyValue> * >(NULL)); };
+    };
+}
+
+ResourceIndexAccess::ResourceIndexAccess(Sequence<Any> const& rArgs, Reference<XComponentContext> const&)
+    : m_pResMgr(GetResMgr(rArgs))
+{};
+
+Reference<XInterface> initResourceIndexAccess(ResourceIndexAccess* pResourceIndexAccess)
+{
+    Reference<XInterface> xResult(static_cast<cppu::OWeakObject*>(pResourceIndexAccess));
+    if(!pResourceIndexAccess->hasElements())
+        // xResult does not help the client to analyse the problem
+        // and will crash on getByIndex calls, better just give back an empty Reference
+        // so that such ResourceStringIndexAccess instances are never release into the wild
+        throw RuntimeException(
+            OUString(RTL_CONSTASCII_USTRINGPARAM("ressource manager could not get initialized")),
+            /* xResult */ Reference<XInterface>());
+    return xResult;
+}
+
+Any SAL_CALL ResourceIndexAccess::getByName(const OUString& aName)
+    throw (NoSuchElementException, WrappedTargetException, RuntimeException)
+{
+    const Sequence<OUString> aNames(getElementNames());
+    Reference<XIndexAccess> xResult;
+    switch(::std::find(stl_begin(aNames), stl_end(aNames), aName)-stl_begin(aNames))
+    {
+        case 0:
+            xResult = Reference<XIndexAccess>(new ResourceStringIndexAccess(m_pResMgr));
+            break;
+        case 1:
+            xResult = Reference<XIndexAccess>(new ResourceStringListIndexAccess(m_pResMgr));
+            break;
+        default:
+            throw NoSuchElementException();
+    }
+    return makeAny(xResult);
+}
+
+Sequence<OUString> SAL_CALL ResourceIndexAccess::getElementNames(  )
+    throw (RuntimeException)
+{
+    static Sequence<OUString> aResult;
+    if( aResult.getLength() == 0)
+    {
+        aResult.realloc(2);
+        aResult[0] = OUString(RTL_CONSTASCII_USTRINGPARAM("String"));
+        aResult[1] = OUString(RTL_CONSTASCII_USTRINGPARAM("StringList"));
+    }
+    return aResult;
+}
+
+::sal_Bool SAL_CALL ResourceIndexAccess::hasByName(const OUString& aName)
+    throw (RuntimeException)
+{
+    const Sequence<OUString> aNames(getElementNames());
+    return (::std::find(stl_begin(aNames), stl_end(aNames), aName) != stl_end(aNames));
+}
+
+Any SAL_CALL ResourceStringIndexAccess::getByIndex(sal_Int32 nIdx)
+    throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
+{
+    if(nIdx > SAL_MAX_UINT16 || nIdx < 0)
+        throw IndexOutOfBoundsException();
+    SolarMutexGuard aGuard;
+    const ResId aId(static_cast<sal_uInt16>(nIdx), *m_pResMgr);
+    aId.SetRT(RSC_STRING);
+    if(!m_pResMgr->IsAvailable(aId))
+        throw RuntimeException(
+            OUString(RTL_CONSTASCII_USTRINGPARAM("string ressource for id not available")),
+            Reference<XInterface>());
+    return makeAny(OUString(String(aId)));
+}
+
+Any SAL_CALL ResourceStringListIndexAccess::getByIndex(sal_Int32 nIdx)
+    throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
+{
+    if(nIdx > SAL_MAX_UINT16 || nIdx < 0)
+        throw IndexOutOfBoundsException();
+    SolarMutexGuard aGuard;
+    const ResId aId(static_cast<sal_uInt16>(nIdx), *m_pResMgr);
+    aId.SetRT(RSC_STRINGARRAY);
+    if(!m_pResMgr->IsAvailable(aId))
+        throw RuntimeException(
+            OUString(RTL_CONSTASCII_USTRINGPARAM("string list ressource for id not available")),
+            Reference<XInterface>());
+    const ResStringArray aStringList(aId);
+    Sequence<PropertyValue> aPropList(aStringList.Count());
+    for(sal_Int32 nCount = 0; nCount != aPropList.getLength(); ++nCount)
+    {
+        aPropList[nCount].Name = aStringList.GetString(nCount);
+        aPropList[nCount].Handle = -1;
+        aPropList[nCount].Value <<= aStringList.GetValue(nCount);
+        aPropList[nCount].State = PropertyState_DIRECT_VALUE;
+    }
+    return makeAny(aPropList);
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

extensions/source/resource/ResourceIndexAccess.hxx

@@ -33,39 +33,43 @@
 
 #include "precompiled_extensions.hxx"
 
-#include <com/sun/star/container/XIndexAccess.hpp>
+#include <boost/shared_ptr.hpp>
+#include <com/sun/star/container/XNameAccess.hpp>
 #include <com/sun/star/uno/Reference.hxx>
 #include <com/sun/star/uno/Sequence.hxx>
 #include <com/sun/star/uno/XInterface.hpp>
 #include <cppuhelper/implbase1.hxx>
-#include <memory>
 
 class ResMgr;
 
 namespace extensions { namespace resource
 {
-    class ResourceStringIndexAccess : public cppu::WeakImplHelper1< ::com::sun::star::container::XIndexAccess>
+    /** This class provides access to tools library text resources */
+    class ResourceIndexAccess : public cppu::WeakImplHelper1< ::com::sun::star::container::XNameAccess>
     {
         public:
-            ResourceStringIndexAccess(::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any> const& rArgs, ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext> const&);
+            /** The ctor takes a sequence with one element: the name of the resource, e.g. svt */
-            // XIndexAccess
+            ResourceIndexAccess(::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any> const& rArgs, ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext> const&);
-            virtual ::sal_Int32 SAL_CALL getCount(  ) throw (::com::sun::star::uno::RuntimeException)
+            // XNameAccess
-                { return m_pResMgr.get() ? SAL_MAX_UINT16 : 0; };
+            // The XNameAccess provides access to two named elements:
-            virtual ::com::sun::star::uno::Any SAL_CALL getByIndex( ::sal_Int32 Index ) throw (::com::sun::star::lang::IndexOutOfBoundsException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+            //    "String" returns a XIndexAccess to String resources
+            //    "StringList" returns a XIndexAccess to StringList/StringArray resources
+            virtual ::com::sun::star::uno::Any SAL_CALL getByName( const ::rtl::OUString& aName ) throw (::com::sun::star::container::NoSuchElementException, ::com::sun::star::lang::WrappedTargetException, ::com::sun::star::uno::RuntimeException);
+            virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL getElementNames(  ) throw (::com::sun::star::uno::RuntimeException);
+            virtual ::sal_Bool SAL_CALL hasByName( const ::rtl::OUString& aName ) throw (::com::sun::star::uno::RuntimeException);
             // XElementAccess
             virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException)
-                { return ::getCppuType(reinterpret_cast< ::rtl::OUString*>(NULL)); };
+                { return ::getCppuType(reinterpret_cast< ::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface>*>(NULL)); };
             virtual ::sal_Bool SAL_CALL hasElements(  ) throw (::com::sun::star::uno::RuntimeException)
                 { return static_cast<bool>(m_pResMgr.get()); };
 
         private:
-            // m_pResMgr should never be NULL, see initResourceStringIndexAccess
+            // m_pResMgr should never be NULL
-            const ::std::auto_ptr<ResMgr> m_pResMgr;
+            const ::boost::shared_ptr<ResMgr> m_pResMgr;
     };
-
 }}
 
-::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> initResourceStringIndexAccess(::extensions::resource::ResourceStringIndexAccess*);
+::com::sun::star::uno::Reference< ::com::sun::star::uno::XInterface> initResourceIndexAccess(::extensions::resource::ResourceIndexAccess*);
 
 #endif
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

extensions/source/resource/ResourceStringIndexAccess.cxx

@@ -1,94 +0,0 @@
-/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
-/*
- * Version: MPL 1.1 / GPLv3+ / LGPLv3+
- *
- * The contents of this file are subject to the Mozilla Public License Version
- * 1.1 (the "License"); you may not use this file except in compliance with
- * the License or as specified alternatively below. You may obtain a copy of
- * the License at http://www.mozilla.org/MPL/
- *
- * Software distributed under the License is distributed on an "AS IS" basis,
- * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
- * for the specific language governing rights and limitations under the
- * License.
- *
- * The Initial Developer of the Original Code is
- *      Bjoern Michaelsen <bjoern.michaelsen@canonical.com>
- * Portions created by the Initial Developer are Copyright (C) 2010 the
- * Initial Developer. All Rights Reserved.
- *
- * Major Contributor(s):
- *
- * For minor contributions see the git repository.
- *
- * Alternatively, the contents of this file may be used under the terms of
- * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
- * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
- * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
- * instead of those above.
- */
-
-#include <ResourceStringIndexAccess.hxx>
-
-#include <osl/mutex.hxx>
-#include <tools/rcid.h>
-#include <tools/resary.hxx>
-#include <tools/resmgr.hxx>
-#include <vcl/svapp.hxx>
-
-using namespace ::extensions::resource;
-using namespace ::com::sun::star::uno;
-using namespace ::com::sun::star::lang;
-
-using ::rtl::OUString;
-using ::rtl::OString;
-using ::rtl::OUStringToOString;
-
-namespace
-{
-    static ::std::auto_ptr<ResMgr> GetResMgr(Sequence<Any> const& rArgs)
-    {
-        if(rArgs.getLength()!=1)
-            return ::std::auto_ptr<ResMgr>();
-        OUString sFilename;
-        rArgs[0] >>= sFilename;
-        SolarMutexGuard aGuard;
-        const OString sEncName(OUStringToOString(sFilename, osl_getThreadTextEncoding()));
-        return ::std::auto_ptr<ResMgr>(ResMgr::CreateResMgr(sEncName));
-    }
-}
-
-
-ResourceStringIndexAccess::ResourceStringIndexAccess(Sequence<Any> const& rArgs, Reference<XComponentContext> const&)
-    : m_pResMgr(GetResMgr(rArgs))
-{};
-
-Reference<XInterface> initResourceStringIndexAccess(ResourceStringIndexAccess* pResourceStringIndexAccess)
-{
-    Reference<XInterface> xResult(static_cast<cppu::OWeakObject*>(pResourceStringIndexAccess));
-    if(!pResourceStringIndexAccess->hasElements())
-        // xResult does not help the client to analyse the problem
-        // and will crash on getByIndex calls, better just give back an empty Reference
-        // so that such ResourceStringIndexAccess instances are never release into the wild
-        throw RuntimeException(
-            OUString(RTL_CONSTASCII_USTRINGPARAM("ressource manager could not get initialized")),
-            /* xResult */ Reference<XInterface>());
-    return xResult;
-}
-
-Any SAL_CALL ResourceStringIndexAccess::getByIndex(sal_Int32 nIdx)
-    throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
-{
-    if(nIdx > SAL_MAX_UINT16 || nIdx < 0)
-        throw IndexOutOfBoundsException();
-    SolarMutexGuard aGuard;
-    const ResId aId(static_cast<sal_uInt16>(nIdx), *m_pResMgr);
-    aId.SetRT(RSC_STRING);
-    if(!m_pResMgr->IsAvailable(aId))
-        throw RuntimeException(
-            OUString(RTL_CONSTASCII_USTRINGPARAM("string ressource for id not available")),
-            Reference<XInterface>());
-    return makeAny(OUString(String(aId)));
-}
-
-/* vim:set shiftwidth=4 softtabstop=4 expandtab: */

extensions/source/resource/makefile.mk

@@ -40,7 +40,7 @@ ENABLE_EXCEPTIONS=TRUE
 # --- Files --------------------------------------------------------
 
 SLOFILES= \
-    $(SLO)$/ResourceStringIndexAccess.obj \
+    $(SLO)$/ResourceIndexAccess.obj \
     $(SLO)$/oooresourceloader.obj \
     $(SLO)$/resourceservices.obj
 

extensions/source/resource/res.component

@@ -32,7 +32,7 @@
     <service name="com.sun.star.resource.OfficeResourceLoader"/>
     <singleton name="com.sun.star.resource.OfficeResourceLoader"/>
   </implementation>
-  <implementation name="org.libreoffice.extensions.resource.ResourceStringIndexAccess">
+  <implementation name="org.libreoffice.extensions.resource.ResourceIndexAccess">
-    <service name="org.libreoffice.resource.ResourceStringIndexAccess"/>
+    <service name="org.libreoffice.resource.ResourceIndexAccess"/>
   </implementation>
 </component>

extensions/source/resource/resourceservices.cxx

@@ -30,20 +30,20 @@
 
 #include "precompiled_extensions.hxx"
 
-#include <ResourceStringIndexAccess.hxx>
+#include <ResourceIndexAccess.hxx>
 #include <oooresourceloader.hxx>
 #include <comphelper/servicedecl.hxx>
 #include <uno/environment.h>
 
 namespace sdecl = ::comphelper::service_decl;
 
-sdecl::class_< ::extensions::resource::ResourceStringIndexAccess, sdecl::with_args<true> > ResourceStringIndexAccessServiceImpl;
+sdecl::class_< ::extensions::resource::ResourceIndexAccess, sdecl::with_args<true> > ResourceIndexAccessServiceImpl;
 sdecl::class_< ::extensions::resource::OpenOfficeResourceLoader> OpenOfficeResourceLoaderServiceImpl;
 
-const sdecl::ServiceDecl ResourceStringIndexAccessDecl(
+const sdecl::ServiceDecl ResourceIndexAccessDecl(
-    ResourceStringIndexAccessServiceImpl,
+    ResourceIndexAccessServiceImpl,
-    "org.libreoffice.extensions.resource.ResourceStringIndexAccess",
+    "org.libreoffice.extensions.resource.ResourceIndexAccess",
-    "org.libreoffice.resource.ResourceStringIndexAccess");
+    "org.libreoffice.resource.ResourceIndexAccess");
 
 const sdecl::ServiceDecl OpenOfficeResourceLoaderDecl(
     OpenOfficeResourceLoaderServiceImpl,
@@ -51,7 +51,7 @@ const sdecl::ServiceDecl OpenOfficeResourceLoaderDecl(
     "com.sun.star.resource.OfficeResourceLoader");
 
 COMPHELPER_SERVICEDECL_EXPORTS2(
-    ResourceStringIndexAccessDecl,
+    ResourceIndexAccessDecl,
     OpenOfficeResourceLoaderDecl
 );