filter/source/config/cache/cacheitem.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: cacheitem.cxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_filter.hxx"
  33
  34 #include "cacheitem.hxx"
  35 #include "macros.hxx"
  36 #include "constant.hxx"
  37
  38 //_______________________________________________
  39 // includes
  40 #include <com/sun/star/uno/Sequence.h>
  41
  42 #ifndef _COM_SUN_STAR_BEANS_PROPERTYVALUE_Hpp_
  43 #include <com/sun/star/beans/PropertyValue.hpp>
  44 #endif
  45
  46 //_______________________________________________
  47 // namespace
  48
  49 namespace filter{
  50     namespace config{
  51
  52 namespace css = ::com::sun::star;
  53
  54 //_______________________________________________
  55 // definitions
  56
  57 /*-----------------------------------------------
  58     04.11.2003 09:27
  59 -----------------------------------------------*/
  60 CacheItem::CacheItem()
  61     : SequenceAsHashMap()
  62 {
  63 }
  64
  65 /*-----------------------------------------------
  66     26.06.2003 11:37
  67 -----------------------------------------------*/
  68 void CacheItem::update(const CacheItem& rUpdateItem)
  69 {
  70     for(const_iterator pItUpdate  = rUpdateItem.begin();
  71                        pItUpdate != rUpdateItem.end()  ;
  72                      ++pItUpdate                       )
  73     {
  74         iterator pItThis = this->find(pItUpdate->first);
  75         if (pItThis == this->end())
  76             (*this)[pItUpdate->first] = pItUpdate->second; // add new prop
  77         else
  78             pItThis->second = pItUpdate->second; // change value of existing prop
  79     }
  80 }
  81
  82 /*-----------------------------------------------
  83     26.11.2003 13:27
  84 -----------------------------------------------*/
  85 void CacheItem::validateUINames(const ::rtl::OUString& sActLocale)
  86 {
  87     if (!sActLocale.getLength())
  88         return;
  89
  90     // 1) check UINames first
  91     const_iterator pUINames = find(PROPNAME_UINAMES);
  92     const_iterator pUIName  = find(PROPNAME_UINAME );
  93
  94     ::comphelper::SequenceAsHashMap lUINames;
  95     if (pUINames != end())
  96         lUINames << pUINames->second;
  97
  98     ::rtl::OUString sUIName;
  99     if (pUIName != end())
 100         pUIName->second >>= sUIName;
 101
 102     if (sUIName.getLength())
 103     {
 104         // 1a) set UIName inside list of UINames for current locale
 105         lUINames[sActLocale] <<= sUIName;
 106     }
 107     else if (lUINames.size()>0)
 108     {
 109         // 1b) or get it from this list, if it not exist!
 110         lUINames[sActLocale] >>= sUIName;
 111     }
 112
 113     (*this)[PROPNAME_UINAMES] <<= lUINames.getAsConstPropertyValueList();
 114     (*this)[PROPNAME_UINAME ] <<= sUIName;
 115 }
 116
 117 /*-----------------------------------------------
 118     12.01.2004 13:32
 119 -----------------------------------------------*/
 120 css::uno::Sequence< css::beans::PropertyValue > CacheItem::getAsPackedPropertyValueList()
 121 {
 122     sal_Int32 c = (sal_Int32)size();
 123     sal_Int32 i = 0;
 124
 125     css::uno::Sequence< css::beans::PropertyValue > lList(c);
 126     css::beans::PropertyValue*                      pList = lList.getArray();
 127
 128     for (const_iterator pProp  = begin();
 129                         pProp != end()  ;
 130                       ++pProp           )
 131     {
 132         const ::rtl::OUString& rName  = pProp->first;
 133         const css::uno::Any&   rValue = pProp->second;
 134
 135         if (!rValue.hasValue())
 136             continue;
 137
 138         pList[i].Name  = rName ;
 139         pList[i].Value = rValue;
 140         ++i;
 141     }
 142     lList.realloc(i);
 143
 144     return lList;
 145 }
 146
 147 /*-----------------------------------------------
 148     17.07.2003 08:27
 149 -----------------------------------------------*/
 150 sal_Bool isSubSet(const css::uno::Any& aSubSet,
 151                   const css::uno::Any& aSet   )
 152 {
 153     css::uno::Type aT1 = aSubSet.getValueType();
 154     css::uno::Type aT2 = aSet.getValueType();
 155
 156     if (!aT1.equals(aT2))
 157     {
 158         _FILTER_CONFIG_LOG_("isSubSet() ... types of any values are different => return FALSE\n")
 159         return sal_False;
 160     }
 161
 162     css::uno::TypeClass aTypeClass = aT1.getTypeClass();
 163     switch(aTypeClass)
 164     {
 165         //---------------------------------------
 166         case css::uno::TypeClass_BOOLEAN :
 167         case css::uno::TypeClass_BYTE :
 168         case css::uno::TypeClass_SHORT :
 169         case css::uno::TypeClass_UNSIGNED_SHORT :
 170         case css::uno::TypeClass_LONG :
 171         case css::uno::TypeClass_UNSIGNED_LONG :
 172         case css::uno::TypeClass_HYPER :
 173         case css::uno::TypeClass_UNSIGNED_HYPER :
 174         case css::uno::TypeClass_FLOAT :
 175         case css::uno::TypeClass_DOUBLE :
 176         {
 177             sal_Bool bIs = (aSubSet == aSet);
 178             _FILTER_CONFIG_LOG_1_("isSubSet() ... check for atomic types => return %s\n", bIs ? "TRUE" : "FALSE")
 179             return bIs;
 180         }
 181
 182         //---------------------------------------
 183         case css::uno::TypeClass_STRING :
 184         {
 185             ::rtl::OUString v1;
 186             ::rtl::OUString v2;
 187
 188             if (
 189                 (aSubSet >>= v1) &&
 190                 (aSet    >>= v2)
 191                )
 192             {
 193                 sal_Bool bIs = (v1.equals(v2));
 194                 _FILTER_CONFIG_LOG_1_("isSubSet() ... check for string types => return %s\n", bIs ? "TRUE" : "FALSE")
 195                 return bIs;
 196             }
 197         }
 198         break;
 199
 200         //---------------------------------------
 201         case css::uno::TypeClass_ANY :
 202         {
 203             css::uno::Any v1;
 204             css::uno::Any v2;
 205
 206             if (
 207                 (aSubSet >>= v1) &&
 208                 (aSet    >>= v2)
 209                )
 210             {
 211                 sal_Bool bIs = (isSubSet(v1, v2));
 212                 _FILTER_CONFIG_LOG_1_("isSubSet() ... check for packed any types => return %s\n", bIs ? "TRUE" : "FALSE")
 213                 return bIs;
 214             }
 215         }
 216         break;
 217
 218         //---------------------------------------
 219         case css::uno::TypeClass_STRUCT :
 220         {
 221             css::beans::PropertyValue p1;
 222             css::beans::PropertyValue p2;
 223
 224             if (
 225                 (aSubSet >>= p1) &&
 226                 (aSet    >>= p2)
 227                )
 228             {
 229                 sal_Bool bIs = (
 230                                 (p1.Name.equals(p2.Name)     ) &&
 231                                 (isSubSet(p1.Value, p2.Value))
 232                                );
 233                 _FILTER_CONFIG_LOG_1_("isSubSet() ... check for structured types [PropertyValue] => return %s\n", bIs ? "TRUE" : "FALSE")
 234                 return bIs;
 235             }
 236
 237             css::beans::NamedValue n1;
 238             css::beans::NamedValue n2;
 239
 240             if (
 241                 (aSubSet >>= n1) &&
 242                 (aSet    >>= n2)
 243                )
 244             {
 245                 sal_Bool bIs = (
 246                                 (n1.Name.equals(n2.Name)     ) &&
 247                                 (isSubSet(n1.Value, n2.Value))
 248                                );
 249                 _FILTER_CONFIG_LOG_1_("isSubSet() ... check for structured types [NamedValue] => return %s\n", bIs ? "TRUE" : "FALSE")
 250                 return bIs;
 251             }
 252         }
 253         break;
 254
 255         //---------------------------------------
 256         case css::uno::TypeClass_SEQUENCE :
 257         {
 258             css::uno::Sequence< ::rtl::OUString > uno_s1;
 259             css::uno::Sequence< ::rtl::OUString > uno_s2;
 260
 261             if (
 262                 (aSubSet >>= uno_s1) &&
 263                 (aSet    >>= uno_s2)
 264                )
 265             {
 266                 OUStringList stl_s1(uno_s1);
 267                 OUStringList stl_s2(uno_s2);
 268
 269                 for (OUStringList::const_iterator it1  = stl_s1.begin();
 270                                                   it1 != stl_s1.end()  ;
 271                                                 ++it1                  )
 272                 {
 273                     if (::std::find(stl_s2.begin(), stl_s2.end(), *it1) == stl_s2.end())
 274                     {
 275                         _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [OUString] ... dont found \"%s\" => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(*it1))
 276                         return sal_False;
 277                     }
 278                     _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [OUString] ... found \"%s\" => continue loop\n", _FILTER_CONFIG_TO_ASCII_(*it1))
 279                 }
 280                 _FILTER_CONFIG_LOG_("isSubSet() ... check for list types [OUString] => return TRUE\n")
 281                 return sal_True;
 282             }
 283
 284             css::uno::Sequence< css::beans::PropertyValue > uno_p1;
 285             css::uno::Sequence< css::beans::PropertyValue > uno_p2;
 286
 287             if (
 288                 (aSubSet >>= uno_p1) &&
 289                 (aSet    >>= uno_p2)
 290                )
 291             {
 292                 ::comphelper::SequenceAsHashMap stl_p1(uno_p1);
 293                 ::comphelper::SequenceAsHashMap stl_p2(uno_p2);
 294
 295                 for (::comphelper::SequenceAsHashMap::const_iterator it1  = stl_p1.begin();
 296                                                                      it1 != stl_p1.end()  ;
 297                                                                    ++it1                  )
 298                 {
 299                     ::comphelper::SequenceAsHashMap::const_iterator it2 = stl_p2.find(it1->first);
 300                     if (it2 == stl_p2.end())
 301                     {
 302                         _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [PropertyValue] ... dont found \"%s\" => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 303                         return sal_False;
 304                     }
 305                     if (!isSubSet(it1->second, it2->second))
 306                     {
 307                         _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [PropertyValue] ... found \"%s\" but has different value => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 308                         return sal_False;
 309                     }
 310                     _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [PropertyValue] ... found \"%s\" with right value => continue loop\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 311                 }
 312                 _FILTER_CONFIG_LOG_("isSubSet() ... check for list types [PropertyValue] => return TRUE\n")
 313                 return sal_True;
 314             }
 315
 316             css::uno::Sequence< css::beans::NamedValue > uno_n1;
 317             css::uno::Sequence< css::beans::NamedValue > uno_n2;
 318
 319             if (
 320                 (aSubSet >>= uno_n1) &&
 321                 (aSet    >>= uno_n2)
 322                )
 323             {
 324                 ::comphelper::SequenceAsHashMap stl_n1(uno_n1);
 325                 ::comphelper::SequenceAsHashMap stl_n2(uno_n2);
 326
 327                 for (::comphelper::SequenceAsHashMap::const_iterator it1  = stl_n1.begin();
 328                                                                      it1 != stl_n1.end()  ;
 329                                                                    ++it1                  )
 330                 {
 331                     ::comphelper::SequenceAsHashMap::const_iterator it2 = stl_n2.find(it1->first);
 332                     if (it2 == stl_n2.end())
 333                     {
 334                         _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [NamedValue] ... dont found \"%s\" => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 335                         return sal_False;
 336                     }
 337                     if (!isSubSet(it1->second, it2->second))
 338                     {
 339                         _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [NamedValue] ... found \"%s\" but has different value => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 340                         return sal_False;
 341                     }
 342                     _FILTER_CONFIG_LOG_1_("isSubSet() ... check for list types [NamedValue] ... found \"%s\" with right value => continue loop\n", _FILTER_CONFIG_TO_ASCII_(it1->first))
 343                 }
 344                 _FILTER_CONFIG_LOG_("isSubSet() ... check for list types [NamedValue] => return TRUE\n")
 345                 return sal_True;
 346             }
 347         }
 348         break;
 349 /*
 350         case css::uno::TypeClass_CHAR :
 351         case css::uno::TypeClass_VOID :
 352         case css::uno::TypeClass_TYPE :
 353         case css::uno::TypeClass_ENUM :
 354         case css::uno::TypeClass_TYPEDEF :
 355         case css::uno::TypeClass_UNION :
 356         case css::uno::TypeClass_EXCEPTION :
 357         case css::uno::TypeClass_ARRAY :
 358         case css::uno::TypeClass_INTERFACE :
 359         case css::uno::TypeClass_SERVICE :
 360         case css::uno::TypeClass_MODULE :
 361         case css::uno::TypeClass_INTERFACE_METHOD :
 362         case css::uno::TypeClass_INTERFACE_ATTRIBUTE :
 363         case css::uno::TypeClass_UNKNOWN :
 364         case css::uno::TypeClass_PROPERTY :
 365         case css::uno::TypeClass_CONSTANT :
 366         case css::uno::TypeClass_CONSTANTS :
 367         case css::uno::TypeClass_SINGLETON :
 368 */
 369         default: break;
 370     }
 371
 372     OSL_ENSURE(sal_False, "isSubSet() ... this point should not be reached!");
 373     return sal_False;
 374 }
 375
 376 /*-----------------------------------------------
 377     14.07.2003 10:24
 378 -----------------------------------------------*/
 379 sal_Bool CacheItem::haveProps(const CacheItem& lProps) const
 380 {
 381     for (const_iterator pIt  = lProps.begin();
 382                         pIt != lProps.end()  ;
 383                       ++pIt                  )
 384     {
 385         // i) one required property does not exist at this item => return false
 386         const_iterator pItThis = this->find(pIt->first);
 387         if (pItThis == this->end())
 388         {
 389             _FILTER_CONFIG_LOG_1_("CacheItem::haveProps() ... dont found \"%s\" => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(pIt->first))
 390             return sal_False;
 391         }
 392
 393         // ii) one item does not have the right value => return false
 394         if (!isSubSet(pIt->second, pItThis->second))
 395         {
 396             _FILTER_CONFIG_LOG_1_("CacheItem::haveProps() ... item \"%s\" has different value => return FALSE\n", _FILTER_CONFIG_TO_ASCII_(pIt->first))
 397             return sal_False;
 398         }
 399     }
 400
 401     // this method was not breaked before =>
 402     // the given property set seems to match with our
 403     // own properties in its minimum => return TRUE
 404     _FILTER_CONFIG_LOG_("CacheItem::haveProps() ... => return TRUE\n")
 405     return sal_True;
 406 }
 407
 408 /*-----------------------------------------------
 409     14.07.2003 10:43
 410 -----------------------------------------------*/
 411 sal_Bool CacheItem::dontHaveProps(const CacheItem& lProps) const
 412 {
 413     for (const_iterator pIt  = lProps.begin();
 414                         pIt != lProps.end()  ;
 415                       ++pIt                  )
 416     {
 417         // i) one item does not exists in general
 418         //    => continue with next one, because
 419         //    "excluding" means ... "dont have it".
 420         //    And "not exists" match to "dont have it".
 421         const_iterator pItThis = this->find(pIt->first);
 422         if (pItThis == this->end())
 423         {
 424             _FILTER_CONFIG_LOG_1_("CacheItem::dontHaveProps() ... not found \"%s\" => continue loop!\n", _FILTER_CONFIG_TO_ASCII_(pIt->first))
 425             continue;
 426         }
 427
 428         // ii) one item have the right value => return false
 429         //     because this item has the requested property ...
 430         //     But we checked for "dont have it" here.
 431         if (isSubSet(pIt->second, pItThis->second))
 432         {
 433             _FILTER_CONFIG_LOG_1_("CacheItem::dontHaveProps() ... item \"%s\" has same value => return FALSE!\n", _FILTER_CONFIG_TO_ASCII_(pIt->first))
 434             return sal_False;
 435         }
 436     }
 437
 438     // this method was not breaked before =>
 439     // That means: this item has no matching property
 440     // of the given set. It "dont have" it ... => return true.
 441     _FILTER_CONFIG_LOG_("CacheItem::dontHaveProps() ... => return TRUE\n")
 442     return sal_True;
 443 }
 444
 445     } // namespace config
 446 } // namespace filter