framework/inc/stdtypes.h

   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: stdtypes.h,v $
  10  * $Revision: 1.10 $
  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 #ifndef __FRAMEWORK_STDTYPES_H_
  32 #define __FRAMEWORK_STDTYPES_H_
  33
  34 #include <vector>
  35 #include <queue>
  36 #include <hash_map>
  37
  38 //_________________________________________________________________________________________________________________
  39 // own includes
  40 //_________________________________________________________________________________________________________________
  41 #include <general.h>
  42
  43 //_________________________________________________________________________________________________________________
  44 // interface includes
  45 //_________________________________________________________________________________________________________________
  46
  47 #ifndef __COM_SUN_STAR_AWT_KEYEVENT_HPP_
  48 #include <com/sun/star/awt/KeyEvent.hpp>
  49 #endif
  50
  51 //_________________________________________________________________________________________________________________
  52 // other includes
  53 //_________________________________________________________________________________________________________________
  54 #include <comphelper/sequenceasvector.hxx>
  55 #include <cppuhelper/interfacecontainer.hxx>
  56 #include <rtl/ustring.hxx>
  57
  58 //_________________________________________________________________________________________________________________
  59 //      namespace
  60 //_________________________________________________________________________________________________________________
  61
  62 namespace framework{
  63
  64 //_________________________________________________________________________________________________________________
  65 //  definitions
  66 //_________________________________________________________________________________________________________________
  67
  68 /**
  69     Own hash functions used for stl-structures ... e.g. hash tables/maps ...
  70 */
  71 struct OUStringHashCode
  72 {
  73     size_t operator()( const ::rtl::OUString& sString ) const
  74     {
  75         return sString.hashCode();
  76     }
  77 };
  78
  79 struct ShortHashCode
  80 {
  81     size_t operator()( const ::sal_Int16& nShort ) const
  82     {
  83         return (size_t)nShort;
  84     }
  85 };
  86
  87 struct Int32HashCode
  88 {
  89     size_t operator()( const ::sal_Int32& nValue ) const
  90     {
  91         return (size_t)nValue;
  92     }
  93 };
  94
  95 struct KeyEventHashCode
  96 {
  97     size_t operator()( const css::awt::KeyEvent& aEvent ) const
  98     {
  99         return (size_t)(aEvent.KeyCode  +
 100                         //aEvent.KeyChar  +
 101                         //aEvent.KeyFunc  +
 102                         aEvent.Modifiers);
 103     }
 104 };
 105
 106 struct KeyEventEqualsFunc
 107 {
 108     bool operator()(const css::awt::KeyEvent aKey1,
 109                     const css::awt::KeyEvent aKey2) const
 110     {
 111         return (
 112                 (aKey1.KeyCode   == aKey2.KeyCode  ) &&
 113                 //(aKey1.KeyChar   == aKey2.KeyChar  ) &&
 114                 //(aKey1.KeyFunc   == aKey2.KeyFunc  ) &&
 115                 (aKey1.Modifiers == aKey2.Modifiers)
 116                );
 117     }
 118 };
 119
 120 //_________________________________________________________________________________________________________________
 121
 122 /**
 123     Basic string list based on a std::vector()
 124     It implements some additional funtionality which can be usefull but
 125     is missing at the normal vector implementation.
 126 */
 127 class OUStringList : public ::comphelper::SequenceAsVector< ::rtl::OUString >
 128 {
 129     public:
 130
 131         // insert given element as the first one into the vector
 132         void push_front( const ::rtl::OUString& sElement )
 133         {
 134             insert( begin(), sElement );
 135         }
 136
 137         // search for given element
 138         iterator find( const ::rtl::OUString& sElement )
 139         {
 140             return ::std::find(begin(), end(), sElement);
 141         }
 142
 143         const_iterator findConst( const ::rtl::OUString& sElement ) const
 144         {
 145             return ::std::find(begin(), end(), sElement);
 146         }
 147
 148         // the only way to free used memory realy!
 149         void free()
 150         {
 151             OUStringList().swap( *this );
 152         }
 153 };
 154
 155 //_________________________________________________________________________________________________________________
 156
 157 /**
 158     Basic string queue based on a std::queue()
 159     It implements some additional funtionality which can be usefull but
 160     is missing at the normal std implementation.
 161 */
 162 typedef ::std::queue< ::rtl::OUString > OUStringQueue;
 163
 164 //_________________________________________________________________________________________________________________
 165
 166 /**
 167     Basic hash based on a std::hash_map() which provides key=[OUString] and value=[template type] pairs
 168     It implements some additional funtionality which can be usefull but
 169     is missing at the normal hash implementation.
 170 */
 171 template< class TType >
 172 class BaseHash : public ::std::hash_map< ::rtl::OUString                    ,
 173                                          TType                              ,
 174                                          OUStringHashCode                   ,
 175                                          ::std::equal_to< ::rtl::OUString > >
 176 {
 177     public:
 178
 179         // the only way to free used memory realy!
 180         void free()
 181         {
 182             BaseHash().swap( *this );
 183         }
 184 };
 185
 186 //_________________________________________________________________________________________________________________
 187
 188 /**
 189     Basic OUString hash.
 190     Key and values are OUStrings.
 191 */
 192 typedef BaseHash< ::rtl::OUString > OUStringHash;
 193
 194 //_________________________________________________________________________________________________________________
 195
 196 /**
 197     It can be used to map names (e.g. of properties) to her corresponding handles.
 198     Our helper class OPropertySetHelper works optimized with handles but sometimes we have only a property name.
 199     Mapping between these two parts of a property should be done in the fastest way :-)
 200 */
 201 typedef BaseHash< sal_Int32 > NameToHandleHash;
 202
 203 //_________________________________________________________________________________________________________________
 204
 205 /**
 206     Sometimes we need this template to implement listener container ...
 207     and we need it at different positions ...
 208     So it's better to declare it one times only!
 209 */
 210 typedef ::cppu::OMultiTypeInterfaceContainerHelperVar<  ::rtl::OUString                    ,
 211                                                         OUStringHashCode                   ,
 212                                                         ::std::equal_to< ::rtl::OUString > >    ListenerHash;
 213
 214 }       // namespace framework
 215
 216 #endif  // #ifndef __FRAMEWORK_STDTYPES_H_