editeng/source/accessibility/AccessibleParaManager.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  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20
  21
  22
  23 // Global header
  24
  25
  26 #include <com/sun/star/uno/Any.hxx>
  27 #include <com/sun/star/uno/Reference.hxx>
  28 #include <cppuhelper/weakref.hxx>
  29 #include <com/sun/star/accessibility/XAccessible.hpp>
  30 #include <com/sun/star/accessibility/AccessibleStateType.hpp>
  31
  32
  33
  34 // Project-local header
  35
  36
  37
  38 #include <editeng/unoedhlp.hxx>
  39 #include <editeng/unopracc.hxx>
  40 #include <editeng/unoedsrc.hxx>
  41 #include "editeng/AccessibleParaManager.hxx"
  42 #include "editeng/AccessibleEditableTextPara.hxx"
  43
  44
  45 using namespace ::com::sun::star;
  46 using namespace ::com::sun::star::accessibility;
  47
  48
  49
  50 namespace accessibility
  51 {
  52     AccessibleParaManager::AccessibleParaManager() :
  53         maChildren(1),
  54         maEEOffset( 0, 0 ),
  55         mnFocusedChild( -1 ),
  56         mbActive( false )
  57     {
  58     }
  59
  60     AccessibleParaManager::~AccessibleParaManager()
  61     {
  62         // owner is responsible for possible child defuncs
  63     }
  64
  65     void AccessibleParaManager::SetAdditionalChildStates( const VectorOfStates& rChildStates )
  66     {
  67         maChildStates = rChildStates;
  68     }
  69
  70     void AccessibleParaManager::SetNum( sal_Int32 nNumParas )
  71     {
  72         if( (size_t)nNumParas < maChildren.size() )
  73             Release( nNumParas, maChildren.size() );
  74
  75         maChildren.resize( nNumParas );
  76
  77         if( mnFocusedChild >= nNumParas )
  78             mnFocusedChild = -1;
  79     }
  80
  81     sal_Int32 AccessibleParaManager::GetNum() const
  82     {
  83         size_t nSize = maChildren.size();
  84         if (nSize > SAL_MAX_INT32)
  85         {
  86             SAL_WARN( "editeng", "AccessibleParaManager::GetNum - overflow " << nSize);
  87             return SAL_MAX_INT32;
  88         }
  89         return static_cast<sal_Int32>(nSize);
  90     }
  91
  92     AccessibleParaManager::VectorOfChildren::iterator AccessibleParaManager::begin()
  93     {
  94         return maChildren.begin();
  95     }
  96
  97     AccessibleParaManager::VectorOfChildren::iterator AccessibleParaManager::end()
  98     {
  99         return maChildren.end();
 100     }
 101
 102     AccessibleParaManager::VectorOfChildren::const_iterator AccessibleParaManager::begin() const
 103     {
 104         return maChildren.begin();
 105     }
 106
 107     AccessibleParaManager::VectorOfChildren::const_iterator AccessibleParaManager::end() const
 108     {
 109         return maChildren.end();
 110     }
 111
 112     void AccessibleParaManager::FireEvent( sal_Int32 nPara,
 113                                            const sal_Int16 nEventId,
 114                                            const uno::Any& rNewValue,
 115                                            const uno::Any& rOldValue ) const
 116     {
 117         DBG_ASSERT( 0 <= nPara && maChildren.size() > static_cast<size_t>(nPara),
 118                 "AccessibleParaManager::FireEvent: invalid index" );
 119
 120         if( 0 <= nPara && maChildren.size() > static_cast<size_t>(nPara) )
 121         {
 122             WeakPara::HardRefType maChild( GetChild( nPara ).first.get() );
 123             if( maChild.is() )
 124                 maChild->FireEvent( nEventId, rNewValue, rOldValue );
 125         }
 126     }
 127
 128     bool AccessibleParaManager::IsReferencable( WeakPara::HardRefType aChild )
 129     {
 130         return aChild.is();
 131     }
 132
 133     bool AccessibleParaManager::IsReferencable( sal_Int32 nChild ) const
 134     {
 135         DBG_ASSERT( 0 <= nChild && maChildren.size() > static_cast<size_t>(nChild),
 136                 "AccessibleParaManager::IsReferencable: invalid index" );
 137
 138         if( 0 <= nChild && maChildren.size() > static_cast<size_t>(nChild) )
 139         {
 140             // retrieve hard reference from weak one
 141             return IsReferencable( GetChild( nChild ).first.get() );
 142         }
 143         else
 144         {
 145             return false;
 146         }
 147     }
 148
 149     AccessibleParaManager::WeakChild AccessibleParaManager::GetChild( sal_Int32 nParagraphIndex ) const
 150     {
 151         DBG_ASSERT( 0 <= nParagraphIndex && maChildren.size() > static_cast<size_t>(nParagraphIndex),
 152                 "AccessibleParaManager::GetChild: invalid index" );
 153
 154         if( 0 <= nParagraphIndex && maChildren.size() > static_cast<size_t>(nParagraphIndex) )
 155         {
 156             return maChildren[ nParagraphIndex ];
 157         }
 158         else
 159         {
 160             return WeakChild();
 161         }
 162     }
 163
 164     AccessibleParaManager::Child AccessibleParaManager::CreateChild( sal_Int32                              nChild,
 165                                                                      const uno::Reference< XAccessible >&   xFrontEnd,
 166                                                                      SvxEditSourceAdapter&                  rEditSource,
 167                                                                      sal_Int32                              nParagraphIndex )
 168     {
 169         DBG_ASSERT( 0 <= nParagraphIndex && maChildren.size() > static_cast<size_t>(nParagraphIndex),
 170                 "AccessibleParaManager::CreateChild: invalid index" );
 171
 172         if( 0 <= nParagraphIndex && maChildren.size() > static_cast<size_t>(nParagraphIndex) )
 173         {
 174             // retrieve hard reference from weak one
 175             WeakPara::HardRefType aChild( GetChild( nParagraphIndex ).first.get() );
 176
 177             if( !IsReferencable( nParagraphIndex ) )
 178             {
 179                 // there is no hard reference available, create object then
 180                 // #i27138#
 181                 AccessibleEditableTextPara* pChild = new AccessibleEditableTextPara( xFrontEnd, this );
 182                 uno::Reference< XAccessible > xChild( static_cast< ::cppu::OWeakObject* > (pChild), uno::UNO_QUERY );
 183
 184                 if( !xChild.is() )
 185                     throw uno::RuntimeException("Child creation failed", xFrontEnd);
 186
 187                 aChild = WeakPara::HardRefType( xChild, pChild );
 188
 189                 InitChild( *aChild, rEditSource, nChild, nParagraphIndex );
 190
 191                 maChildren[ nParagraphIndex ] = WeakChild( aChild, pChild->getBounds() );
 192             }
 193
 194             return Child( aChild.getRef(), GetChild( nParagraphIndex ).second );
 195         }
 196         else
 197         {
 198             return Child();
 199         }
 200     }
 201
 202     void AccessibleParaManager::SetEEOffset( const Point& rOffset )
 203     {
 204         maEEOffset = rOffset;
 205
 206         MemFunAdapter< const Point& > aAdapter( &::accessibility::AccessibleEditableTextPara::SetEEOffset, rOffset );
 207         ::std::for_each( begin(), end(), aAdapter );
 208     }
 209
 210     void AccessibleParaManager::SetActive( bool bActive )
 211     {
 212         mbActive = bActive;
 213
 214         if( bActive )
 215         {
 216             SetState( AccessibleStateType::ACTIVE );
 217             SetState( AccessibleStateType::EDITABLE );
 218         }
 219         else
 220         {
 221             UnSetState( AccessibleStateType::ACTIVE );
 222             UnSetState( AccessibleStateType::EDITABLE );
 223         }
 224     }
 225
 226     void AccessibleParaManager::SetFocus( sal_Int32 nChild )
 227     {
 228         if( mnFocusedChild != -1 )
 229             UnSetState( mnFocusedChild, AccessibleStateType::FOCUSED );
 230
 231         mnFocusedChild = nChild;
 232
 233         if( mnFocusedChild != -1 )
 234             SetState( mnFocusedChild, AccessibleStateType::FOCUSED );
 235     }
 236
 237     void AccessibleParaManager::InitChild( AccessibleEditableTextPara&  rChild,
 238                                            SvxEditSourceAdapter&        rEditSource,
 239                                            sal_Int32                    nChild,
 240                                            sal_Int32                    nParagraphIndex ) const
 241     {
 242         rChild.SetEditSource( &rEditSource );
 243         rChild.SetIndexInParent( nChild );
 244         rChild.SetParagraphIndex( nParagraphIndex );
 245
 246         rChild.SetEEOffset( maEEOffset );
 247
 248         if( mbActive )
 249         {
 250             rChild.SetState( AccessibleStateType::ACTIVE );
 251             rChild.SetState( AccessibleStateType::EDITABLE );
 252         }
 253
 254         if( mnFocusedChild == nParagraphIndex )
 255             rChild.SetState( AccessibleStateType::FOCUSED );
 256
 257         // add states passed from outside
 258         for( VectorOfStates::const_iterator aIt = maChildStates.begin(), aEnd = maChildStates.end(); aIt != aEnd; ++aIt )
 259             rChild.SetState( *aIt );
 260     }
 261
 262     void AccessibleParaManager::SetState( sal_Int32 nChild, const sal_Int16 nStateId )
 263     {
 264         MemFunAdapter< const sal_Int16 > aFunc( &AccessibleEditableTextPara::SetState,
 265                                                 nStateId );
 266         aFunc( GetChild(nChild) );
 267     }
 268
 269     void AccessibleParaManager::SetState( const sal_Int16 nStateId )
 270     {
 271         ::std::for_each( begin(), end(),
 272                          MemFunAdapter< const sal_Int16 >( &AccessibleEditableTextPara::SetState,
 273                                                            nStateId ) );
 274     }
 275
 276     void AccessibleParaManager::UnSetState( sal_Int32 nChild, const sal_Int16 nStateId )
 277     {
 278         MemFunAdapter< const sal_Int16 > aFunc( &AccessibleEditableTextPara::UnSetState,
 279                                                 nStateId );
 280         aFunc( GetChild(nChild) );
 281     }
 282
 283     void AccessibleParaManager::UnSetState( const sal_Int16 nStateId )
 284     {
 285         ::std::for_each( begin(), end(),
 286                          MemFunAdapter< const sal_Int16 >( &AccessibleEditableTextPara::UnSetState,
 287                                                            nStateId ) );
 288     }
 289
 290     // not generic yet, no arguments...
 291     class AccessibleParaManager_DisposeChildren : public ::std::unary_function< ::accessibility::AccessibleEditableTextPara&, void >
 292     {
 293     public:
 294         AccessibleParaManager_DisposeChildren() {}
 295         void operator()( ::accessibility::AccessibleEditableTextPara& rPara )
 296         {
 297             rPara.Dispose();
 298         }
 299     };
 300
 301     void AccessibleParaManager::Dispose()
 302     {
 303         AccessibleParaManager_DisposeChildren aFunctor;
 304
 305         ::std::for_each( begin(), end(),
 306                          WeakChildAdapter< AccessibleParaManager_DisposeChildren > (aFunctor) );
 307     }
 308
 309     // not generic yet, too many method arguments...
 310     class StateChangeEvent : public ::std::unary_function< ::accessibility::AccessibleEditableTextPara&, void >
 311     {
 312     public:
 313         typedef void return_type;
 314         StateChangeEvent( const sal_Int16 nEventId,
 315                           const uno::Any& rNewValue,
 316                           const uno::Any& rOldValue ) :
 317             mnEventId( nEventId ),
 318             mrNewValue( rNewValue ),
 319             mrOldValue( rOldValue ) {}
 320         void operator()( ::accessibility::AccessibleEditableTextPara& rPara )
 321         {
 322             rPara.FireEvent( mnEventId, mrNewValue, mrOldValue );
 323         }
 324
 325     private:
 326         const sal_Int16 mnEventId;
 327         const uno::Any& mrNewValue;
 328         const uno::Any& mrOldValue;
 329     };
 330
 331     void AccessibleParaManager::FireEvent( sal_Int32 nStartPara,
 332                                            sal_Int32 nEndPara,
 333                                            const sal_Int16 nEventId,
 334                                            const uno::Any& rNewValue,
 335                                            const uno::Any& rOldValue ) const
 336     {
 337         DBG_ASSERT( 0 <= nStartPara && 0 <= nEndPara &&
 338                     maChildren.size() > static_cast<size_t>(nStartPara) &&
 339                     maChildren.size() >= static_cast<size_t>(nEndPara) &&
 340                     nEndPara >= nStartPara, "AccessibleParaManager::FireEvent: invalid index" );
 341
 342
 343
 344         if( 0 <= nStartPara && 0 <= nEndPara &&
 345                 maChildren.size() > static_cast<size_t>(nStartPara) &&
 346                 maChildren.size() >= static_cast<size_t>(nEndPara) &&
 347                 nEndPara >= nStartPara )
 348         {
 349             VectorOfChildren::const_iterator front = maChildren.begin();
 350             VectorOfChildren::const_iterator back = front;
 351
 352             ::std::advance( front, nStartPara );
 353             ::std::advance( back, nEndPara );
 354
 355             StateChangeEvent aFunctor( nEventId, rNewValue, rOldValue );
 356
 357             ::std::for_each( front, back, AccessibleParaManager::WeakChildAdapter< StateChangeEvent >( aFunctor ) );
 358         }
 359     }
 360
 361     class ReleaseChild : public ::std::unary_function< const AccessibleParaManager::WeakChild&, AccessibleParaManager::WeakChild >
 362     {
 363     public:
 364         AccessibleParaManager::WeakChild operator()( const AccessibleParaManager::WeakChild& rPara )
 365         {
 366             AccessibleParaManager::ShutdownPara( rPara );
 367
 368             // clear reference
 369             return AccessibleParaManager::WeakChild();
 370         }
 371     };
 372
 373     void AccessibleParaManager::Release( sal_Int32 nStartPara, sal_Int32 nEndPara )
 374     {
 375         DBG_ASSERT( 0 <= nStartPara && 0 <= nEndPara &&
 376                     maChildren.size() > static_cast<size_t>(nStartPara) &&
 377                     maChildren.size() >= static_cast<size_t>(nEndPara),
 378                     "AccessibleParaManager::Release: invalid index" );
 379
 380         if( 0 <= nStartPara && 0 <= nEndPara &&
 381                 maChildren.size() > static_cast<size_t>(nStartPara) &&
 382                 maChildren.size() >= static_cast<size_t>(nEndPara) )
 383         {
 384             VectorOfChildren::iterator front = maChildren.begin();
 385             VectorOfChildren::iterator back = front;
 386
 387             ::std::advance( front, nStartPara );
 388             ::std::advance( back, nEndPara );
 389
 390             ::std::transform( front, back, front, ReleaseChild() );
 391         }
 392     }
 393
 394     void AccessibleParaManager::ShutdownPara( const WeakChild& rChild )
 395     {
 396         WeakPara::HardRefType aChild( rChild.first.get() );
 397
 398         if( IsReferencable( aChild ) )
 399             aChild->SetEditSource( NULL );
 400     }
 401
 402 }
 403
 404
 405
 406 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */