extensions/source/resource/ResourceIndexAccess.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  */
   9
  10 #include <ResourceIndexAccess.hxx>
  11
  12 #include <com/sun/star/container/XIndexAccess.hpp>
  13 #include <com/sun/star/beans/PropertyValue.hpp>
  14 #include <comphelper/stlunosequence.hxx>
  15 #include <osl/mutex.hxx>
  16 #include <tools/rcid.h>
  17 #include <tools/resary.hxx>
  18 #include <tools/resmgr.hxx>
  19 #include <vcl/svapp.hxx>
  20
  21 using namespace ::extensions::resource;
  22 using namespace ::com::sun::star::uno;
  23 using namespace ::com::sun::star::lang;
  24 using namespace ::com::sun::star::beans;
  25 using namespace ::com::sun::star::container;
  26
  27 using ::comphelper::stl_begin;
  28 using ::comphelper::stl_end;
  29
  30 namespace
  31 {
  32     static ::boost::shared_ptr<ResMgr> GetResMgr(Sequence<Any> const& rArgs)
  33     {
  34         if(rArgs.getLength()!=1)
  35             return ::boost::shared_ptr<ResMgr>();
  36         OUString sFilename;
  37         rArgs[0] >>= sFilename;
  38         SolarMutexGuard aGuard;
  39         const OString sEncName(OUStringToOString(sFilename, osl_getThreadTextEncoding()));
  40         return ::boost::shared_ptr<ResMgr>(ResMgr::CreateResMgr(sEncName.getStr()));
  41     }
  42
  43     class ResourceIndexAccessBase : public cppu::WeakImplHelper1< ::com::sun::star::container::XIndexAccess>
  44     {
  45         public:
  46             ResourceIndexAccessBase( ::boost::shared_ptr<ResMgr> pResMgr)
  47                 : m_pResMgr(pResMgr)
  48             {
  49                 OSL_ENSURE(m_pResMgr, "no resource manager given");
  50             }
  51
  52             // XIndexAccess
  53             virtual ::sal_Int32 SAL_CALL getCount(  ) throw (::com::sun::star::uno::RuntimeException)
  54                 { return m_pResMgr.get() ? SAL_MAX_UINT16 : 0; };
  55             // XElementAccess
  56             virtual ::sal_Bool SAL_CALL hasElements(  ) throw (::com::sun::star::uno::RuntimeException)
  57                 { return static_cast<bool>(m_pResMgr.get()); };
  58
  59         protected:
  60             // m_pResMgr should never be NULL
  61             const ::boost::shared_ptr<ResMgr> m_pResMgr;
  62     };
  63
  64     class ResourceStringIndexAccess : public ResourceIndexAccessBase
  65     {
  66         public:
  67             ResourceStringIndexAccess( ::boost::shared_ptr<ResMgr> pResMgr)
  68                 : ResourceIndexAccessBase(pResMgr) {}
  69             // XIndexAccess
  70             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);
  71             // XElementAccessBase
  72             virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException)
  73                 { return ::getCppuType(static_cast< OUString*>(0)); };
  74     };
  75
  76     class ResourceStringListIndexAccess : public ResourceIndexAccessBase
  77     {
  78         public:
  79             ResourceStringListIndexAccess( ::boost::shared_ptr<ResMgr> pResMgr)
  80                 : ResourceIndexAccessBase(pResMgr) {}
  81             // XIndexAccess
  82             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);
  83             // XElementAccessBase
  84             virtual ::com::sun::star::uno::Type SAL_CALL getElementType(  ) throw (::com::sun::star::uno::RuntimeException)
  85                 { return ::getCppuType(static_cast<Sequence<PropertyValue> * >(0)); };
  86     };
  87 }
  88
  89 ResourceIndexAccess::ResourceIndexAccess(Sequence<Any> const& rArgs, Reference<XComponentContext> const&)
  90     : m_pResMgr(GetResMgr(rArgs))
  91 {};
  92
  93 Reference<XInterface> initResourceIndexAccess(ResourceIndexAccess* pResourceIndexAccess)
  94 {
  95     Reference<XInterface> xResult(static_cast<cppu::OWeakObject*>(pResourceIndexAccess));
  96     if(!pResourceIndexAccess->hasElements())
  97         // xResult does not help the client to analyse the problem
  98         // and will crash on getByIndex calls, better just give back an empty Reference
  99         // so that such ResourceStringIndexAccess instances are never release into the wild
 100         throw RuntimeException(
 101             OUString("resource manager could not get initialized"),
 102             /* xResult */ Reference<XInterface>());
 103     return xResult;
 104 }
 105
 106 Any SAL_CALL ResourceIndexAccess::getByName(const OUString& aName)
 107     throw (NoSuchElementException, WrappedTargetException, RuntimeException)
 108 {
 109     const Sequence<OUString> aNames(getElementNames());
 110     Reference<XIndexAccess> xResult;
 111     switch(::std::find(stl_begin(aNames), stl_end(aNames), aName)-stl_begin(aNames))
 112     {
 113         case 0:
 114             xResult = Reference<XIndexAccess>(new ResourceStringIndexAccess(m_pResMgr));
 115             break;
 116         case 1:
 117             xResult = Reference<XIndexAccess>(new ResourceStringListIndexAccess(m_pResMgr));
 118             break;
 119         default:
 120             throw NoSuchElementException();
 121     }
 122     return makeAny(xResult);
 123 }
 124
 125 Sequence<OUString> SAL_CALL ResourceIndexAccess::getElementNames(  )
 126     throw (RuntimeException)
 127 {
 128     static Sequence<OUString> aResult;
 129     if( aResult.getLength() == 0)
 130     {
 131         aResult.realloc(2);
 132         aResult[0] = OUString("String");
 133         aResult[1] = OUString("StringList");
 134     }
 135     return aResult;
 136 }
 137
 138 ::sal_Bool SAL_CALL ResourceIndexAccess::hasByName(const OUString& aName)
 139     throw (RuntimeException)
 140 {
 141     const Sequence<OUString> aNames(getElementNames());
 142     return (::std::find(stl_begin(aNames), stl_end(aNames), aName) != stl_end(aNames));
 143 }
 144
 145 Any SAL_CALL ResourceStringIndexAccess::getByIndex(sal_Int32 nIdx)
 146     throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
 147 {
 148     if(nIdx > SAL_MAX_UINT16 || nIdx < 0)
 149         throw IndexOutOfBoundsException();
 150     SolarMutexGuard aGuard;
 151     if(!m_pResMgr.get())
 152         throw RuntimeException(
 153             OUString("resource manager not available"),
 154             Reference<XInterface>());
 155
 156     const ResId aId(static_cast<sal_uInt16>(nIdx), *m_pResMgr);
 157     aId.SetRT(RSC_STRING);
 158
 159     if(!m_pResMgr->IsAvailable(aId))
 160         throw RuntimeException(
 161             OUString("string resource for id not available"),
 162             Reference<XInterface>());
 163
 164     return makeAny(OUString(String(aId)));
 165 }
 166
 167 Any SAL_CALL ResourceStringListIndexAccess::getByIndex(sal_Int32 nIdx)
 168     throw (IndexOutOfBoundsException, WrappedTargetException, RuntimeException)
 169 {
 170     if(nIdx > SAL_MAX_UINT16 || nIdx < 0)
 171         throw IndexOutOfBoundsException();
 172     SolarMutexGuard aGuard;
 173
 174     if(!m_pResMgr.get())
 175         throw RuntimeException(
 176             OUString("resource manager not available"),
 177             Reference<XInterface>());
 178
 179     const ResId aId(static_cast<sal_uInt16>(nIdx), *m_pResMgr);
 180     aId.SetRT(RSC_STRINGARRAY);
 181     if(!m_pResMgr->IsAvailable(aId))
 182         throw RuntimeException(
 183             OUString("string list resource for id not available"),
 184             Reference<XInterface>());
 185     const ResStringArray aStringList(aId);
 186     Sequence<PropertyValue> aPropList(aStringList.Count());
 187     for(sal_Int32 nCount = 0; nCount != aPropList.getLength(); ++nCount)
 188     {
 189         aPropList[nCount].Name = aStringList.GetString(nCount);
 190         aPropList[nCount].Handle = -1;
 191         aPropList[nCount].Value <<= aStringList.GetValue(nCount);
 192         aPropList[nCount].State = PropertyState_DIRECT_VALUE;
 193     }
 194     return makeAny(aPropList);
 195 }
 196
 197 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */