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