sw/source/ui/vba/vbafind.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:
  10  * $Revision:
  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 #include "vbafind.hxx"
  31 #include <vbahelper/vbahelper.hxx>
  32 #include <tools/diagnose_ex.h>
  33 #include "vbareplacement.hxx"
  34 #include <ooo/vba/word/WdFindWrap.hpp>
  35 #include <ooo/vba/word/WdReplace.hpp>
  36 #include <com/sun/star/text/XTextRangeCompare.hpp>
  37 #include "wordvbahelper.hxx"
  38
  39 using namespace ::ooo::vba;
  40 using namespace ::com::sun::star;
  41
  42 SwVbaFind::SwVbaFind( const uno::Reference< ooo::vba::XHelperInterface >& rParent, const uno::Reference< uno::XComponentContext >& rContext, const uno::Reference< frame::XModel >& xModel, const uno::Reference< text::XTextRange >& xTextRange ) throw ( uno::RuntimeException ) :
  43     SwVbaFind_BASE( rParent, rContext ), mxModel( xModel ), mxTextRange( xTextRange ), mbReplace( sal_False ), mnReplaceType( word::WdReplace::wdReplaceOne ), mnWrap( word::WdFindWrap::wdFindStop )
  44 {
  45     mxReplaceable.set( mxModel, uno::UNO_QUERY_THROW );
  46     mxPropertyReplace.set( mxReplaceable->createReplaceDescriptor(), uno::UNO_QUERY_THROW );
  47     mxTVC = word::getXTextViewCursor( mxModel );
  48     mxSelSupp.set( mxModel->getCurrentController(), uno::UNO_QUERY_THROW );
  49 }
  50
  51 SwVbaFind::~SwVbaFind()
  52 {
  53 }
  54
  55 sal_Bool SwVbaFind::InRange( const uno::Reference< text::XTextRange >& xCurrentRange ) throw ( uno::RuntimeException )
  56 {
  57     uno::Reference< text::XTextRangeCompare > xTRC( mxTextRange->getText(), uno::UNO_QUERY_THROW );
  58     if( xTRC->compareRegionStarts( mxTextRange, xCurrentRange ) >= 0 && xTRC->compareRegionEnds( mxTextRange, xCurrentRange ) <= 0 )
  59         return sal_True;
  60     return sal_False;
  61 }
  62
  63 sal_Bool SwVbaFind::InEqualRange( const uno::Reference< text::XTextRange >& xCurrentRange ) throw ( uno::RuntimeException )
  64 {
  65     uno::Reference< text::XTextRangeCompare > xTRC( mxTextRange->getText(), uno::UNO_QUERY_THROW );
  66     if( xTRC->compareRegionStarts( mxTextRange, xCurrentRange ) == 0 && xTRC->compareRegionEnds( mxTextRange, xCurrentRange ) == 0 )
  67         return sal_True;
  68     return sal_False;
  69 }
  70
  71 void SwVbaFind::SetReplaceWith( const rtl::OUString& rText ) throw (uno::RuntimeException)
  72 {
  73     mxPropertyReplace->setReplaceString( rText );
  74     mbReplace = sal_True;
  75 }
  76
  77 rtl::OUString SwVbaFind::GetReplaceWith() throw (uno::RuntimeException)
  78 {
  79     return mxPropertyReplace->getReplaceString();
  80 }
  81 void SwVbaFind::SetReplace( sal_Int32 type )
  82 {
  83     mnReplaceType = type;
  84     mbReplace = sal_True;
  85 }
  86
  87 rtl::OUString SwVbaFind::ReplaceWildcards( const rtl::OUString& /*rText*/ ) throw ( uno::RuntimeException )
  88 {
  89     // TODO:
  90     return rtl::OUString();
  91 }
  92
  93 uno::Reference< text::XTextRange > SwVbaFind::FindOneElement() throw ( uno::RuntimeException )
  94 {
  95     uno::Reference< text::XTextRange > xFoundOne;
  96     if( mxTVC->getString().getLength() > 0 )
  97     {
  98         if( getForward() )
  99         {
 100             xFoundOne.set( mxReplaceable->findNext( mxTextRange->getStart(), uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 101         }
 102         else
 103         {
 104             xFoundOne.set( mxReplaceable->findNext( mxTextRange->getEnd(), uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 105         }
 106
 107         if( xFoundOne.is() && InEqualRange( xFoundOne ) )
 108         {
 109             xFoundOne.set( mxReplaceable->findNext( xFoundOne, uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 110         }
 111         else if( xFoundOne.is() && !InRange( xFoundOne ) )
 112         {
 113             xFoundOne = uno::Reference< text::XTextRange >();
 114         }
 115     }
 116     else
 117     {
 118         xFoundOne.set( mxReplaceable->findNext( mxTextRange, uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 119     }
 120
 121     if( !xFoundOne.is() && ( getWrap() == word::WdFindWrap::wdFindContinue || getWrap() == word::WdFindWrap::wdFindAsk ) )
 122     {
 123         if( getForward() )
 124         {
 125             mxTVC->gotoStart(sal_False);
 126             xFoundOne.set( mxReplaceable->findNext( mxTextRange->getStart(), uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 127         }
 128         else
 129         {
 130             mxTVC->gotoEnd( sal_False );
 131             xFoundOne.set( mxReplaceable->findNext( mxTextRange->getEnd(), uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) ), uno::UNO_QUERY );
 132
 133         }
 134     }
 135     return xFoundOne;
 136 }
 137
 138 sal_Bool SwVbaFind::SearchReplace() throw (uno::RuntimeException)
 139 {
 140     sal_Bool result = sal_False;
 141
 142     // TODO: map wildcards in area to OOo wildcards
 143
 144     if( mbReplace )
 145     {
 146         switch( mnReplaceType )
 147         {
 148             case word::WdReplace::wdReplaceNone:
 149             {
 150                 result = sal_True;
 151                 break;
 152             }
 153             case word::WdReplace::wdReplaceOne:
 154             {
 155                 uno::Reference< text::XTextRange > xFindOne = FindOneElement();
 156                 if( xFindOne.is() )
 157                 {
 158                     xFindOne->setString( GetReplaceWith() );
 159                     result = mxSelSupp->select( uno::makeAny( xFindOne ) );
 160                 }
 161                 break;
 162             }
 163             case word::WdReplace::wdReplaceAll:
 164             {
 165                 uno::Reference< container::XIndexAccess > xIndexAccess = mxReplaceable->findAll( uno::Reference< util::XSearchDescriptor >( mxPropertyReplace, uno::UNO_QUERY_THROW ) );
 166                 if( xIndexAccess->getCount() > 0 )
 167                 {
 168                     for( sal_Int32 i = 0; i < xIndexAccess->getCount(); i++ )
 169                     {
 170                         uno::Reference< text::XTextRange > xTextRange( xIndexAccess->getByIndex( i ), uno::UNO_QUERY_THROW );
 171                         if( mnWrap == word::WdFindWrap::wdFindContinue || mnWrap == word::WdFindWrap::wdFindAsk || InRange( xTextRange ) )
 172                         {
 173                             xTextRange->setString( GetReplaceWith() );
 174                             result = sal_True;
 175                         }
 176                     }
 177                 }
 178                 break;
 179             }
 180             default:
 181             {
 182                 result = sal_False;
 183             }
 184         }
 185     }
 186     else
 187     {
 188         uno::Reference< text::XTextRange > xFindOne = FindOneElement();
 189         if( xFindOne.is() )
 190             result = mxSelSupp->select( uno::makeAny( xFindOne ) );
 191     }
 192
 193     return result;
 194 }
 195
 196 ::rtl::OUString SAL_CALL SwVbaFind::getText() throw (uno::RuntimeException)
 197 {
 198     return mxPropertyReplace->getSearchString();
 199 }
 200
 201 void SAL_CALL SwVbaFind::setText( const ::rtl::OUString& _text ) throw (uno::RuntimeException)
 202 {
 203     mxPropertyReplace->setSearchString( _text );
 204 }
 205
 206 uno::Any SAL_CALL SwVbaFind::getReplacement() throw (uno::RuntimeException)
 207 {
 208     return uno::makeAny( uno::Reference< word::XReplacement >( new SwVbaReplacement( this, mxContext, mxPropertyReplace ) ) );
 209 }
 210
 211 void SAL_CALL SwVbaFind::setReplacement( const uno::Any& /*_replacement */ ) throw (uno::RuntimeException)
 212 {
 213     throw uno::RuntimeException( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Not implemented") ), uno::Reference< uno::XInterface >() );
 214 }
 215
 216 ::sal_Bool SAL_CALL SwVbaFind::getForward() throw (uno::RuntimeException)
 217 {
 218     sal_Bool bBackward = sal_False;
 219     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchBackwards") ) ) >>= bBackward;
 220     return !bBackward;
 221 }
 222
 223 void SAL_CALL SwVbaFind::setForward( ::sal_Bool _forward ) throw (uno::RuntimeException)
 224 {
 225     sal_Bool bBackward = !_forward;
 226     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchBackwards") ), uno::makeAny( bBackward ) );
 227 }
 228
 229 ::sal_Int32 SAL_CALL SwVbaFind::getWrap() throw (uno::RuntimeException)
 230 {
 231     // seems not supported in Writer
 232     return mnWrap;
 233 }
 234
 235 void SAL_CALL SwVbaFind::setWrap( ::sal_Int32 _wrap ) throw (uno::RuntimeException)
 236 {
 237     // seems not supported in Writer
 238     mnWrap = _wrap;
 239 }
 240
 241 ::sal_Bool SAL_CALL SwVbaFind::getFormat() throw (uno::RuntimeException)
 242 {
 243     return mxPropertyReplace->getValueSearch();
 244 }
 245
 246 void SAL_CALL SwVbaFind::setFormat( ::sal_Bool _format ) throw (uno::RuntimeException)
 247 {
 248     mxPropertyReplace->setValueSearch( _format );
 249 }
 250
 251 ::sal_Bool SAL_CALL SwVbaFind::getMatchCase() throw (uno::RuntimeException)
 252 {
 253     sal_Bool value = sal_False;
 254     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchCaseSensitive") ) ) >>= value;
 255     return value;
 256 }
 257
 258 void SAL_CALL SwVbaFind::setMatchCase( ::sal_Bool _matchcase ) throw (uno::RuntimeException)
 259 {
 260     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchCaseSensitive") ), uno::makeAny( _matchcase ) );
 261 }
 262
 263 ::sal_Bool SAL_CALL SwVbaFind::getMatchWholeWord() throw (uno::RuntimeException)
 264 {
 265     sal_Bool value = sal_False;
 266     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchWords") ) ) >>= value;
 267     return value;
 268 }
 269
 270 void SAL_CALL SwVbaFind::setMatchWholeWord( ::sal_Bool _matchwholeword ) throw (uno::RuntimeException)
 271 {
 272     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchWords") ), uno::makeAny( _matchwholeword ) );
 273 }
 274
 275 ::sal_Bool SAL_CALL SwVbaFind::getMatchWildcards() throw (uno::RuntimeException)
 276 {
 277     sal_Bool value = sal_False;
 278     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchRegularExpression") ) ) >>= value;
 279     return value;
 280 }
 281
 282 void SAL_CALL SwVbaFind::setMatchWildcards( ::sal_Bool _matchwildcards ) throw (uno::RuntimeException)
 283 {
 284     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchRegularExpression") ), uno::makeAny( _matchwildcards ) );
 285 }
 286
 287 ::sal_Bool SAL_CALL SwVbaFind::getMatchSoundsLike() throw (uno::RuntimeException)
 288 {
 289     sal_Bool value = sal_False;
 290     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarity") ) ) >>= value;
 291     return value;
 292 }
 293
 294 void SAL_CALL SwVbaFind::setMatchSoundsLike( ::sal_Bool _matchsoundslike ) throw (uno::RuntimeException)
 295 {
 296     // seems not accurate
 297     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarity") ), uno::makeAny( _matchsoundslike ) );
 298 }
 299
 300 ::sal_Bool SAL_CALL SwVbaFind::getMatchAllWordForms() throw (uno::RuntimeException)
 301 {
 302     sal_Bool value = sal_False;
 303     mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarity") ) ) >>= value;
 304     if( value )
 305         mxPropertyReplace->getPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarityRelax") ) ) >>= value;
 306     return value;
 307 }
 308
 309 void SAL_CALL SwVbaFind::setMatchAllWordForms( ::sal_Bool _matchallwordforms ) throw (uno::RuntimeException)
 310 {
 311     // seems not accurate
 312     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarity") ), uno::makeAny( _matchallwordforms ) );
 313     mxPropertyReplace->setPropertyValue( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("SearchSimilarityRelax") ), uno::makeAny( _matchallwordforms ) );
 314 }
 315
 316 uno::Any SAL_CALL SwVbaFind::getStyle() throw (uno::RuntimeException)
 317 {
 318     throw uno::RuntimeException( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Not implemented") ), uno::Reference< uno::XInterface >() );
 319 }
 320
 321 void SAL_CALL SwVbaFind::setStyle( const uno::Any& /*_style */ ) throw (uno::RuntimeException)
 322 {
 323     throw uno::RuntimeException( rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("Not implemented") ), uno::Reference< uno::XInterface >() );
 324 }
 325
 326 sal_Bool SAL_CALL
 327 SwVbaFind::Execute( const uno::Any& FindText, const uno::Any& MatchCase, const uno::Any& MatchWholeWord, const uno::Any& MatchWildcards, const uno::Any& MatchSoundsLike, const uno::Any& MatchAllWordForms, const uno::Any& Forward, const uno::Any& Wrap, const uno::Any& Format, const uno::Any& ReplaceWith, const uno::Any& Replace, const uno::Any& /*MatchKashida*/, const uno::Any& /*MatchDiacritics*/, const uno::Any& /*MatchAlefHamza*/, const uno::Any& /*MatchControl*/, const uno::Any& /*MatchPrefix*/, const uno::Any& /*MatchSuffix*/, const uno::Any& /*MatchPhrase*/, const uno::Any& /*IgnoreSpace*/, const uno::Any& /*IgnorePunct*/ ) throw (uno::RuntimeException)
 328 {
 329     sal_Bool result = sal_False;
 330     if( FindText.hasValue() )
 331     {
 332         rtl::OUString sText;
 333         FindText >>= sText;
 334         setText( sText );
 335     }
 336
 337     sal_Bool bValue = sal_False;
 338     if( MatchCase.hasValue() )
 339     {
 340         MatchCase >>= bValue;
 341         setMatchCase( bValue );
 342     }
 343
 344     if( MatchWholeWord.hasValue() )
 345     {
 346         MatchWholeWord >>= bValue;
 347         setMatchWholeWord( bValue );
 348     }
 349
 350     if( MatchWildcards.hasValue() )
 351     {
 352         MatchWildcards >>= bValue;
 353         setMatchWildcards( bValue );
 354     }
 355
 356     if( MatchSoundsLike.hasValue() )
 357     {
 358         MatchSoundsLike >>= bValue;
 359         setMatchSoundsLike( bValue );
 360     }
 361
 362     if( MatchAllWordForms.hasValue() )
 363     {
 364         MatchAllWordForms >>= bValue;
 365         setMatchAllWordForms( bValue );
 366     }
 367
 368     if( Forward.hasValue() )
 369     {
 370         Forward >>= bValue;
 371         setForward( bValue );
 372     }
 373
 374     if( Wrap.hasValue() )
 375     {
 376         sal_Int32 nWrapType = 0;
 377         Wrap >>= nWrapType;
 378         setWrap( nWrapType );
 379     }
 380
 381     if( Format.hasValue() )
 382     {
 383         Format >>= bValue;
 384         setFormat( bValue );
 385     }
 386
 387     if( ReplaceWith.hasValue() )
 388     {
 389         rtl::OUString sValue;
 390         ReplaceWith >>= sValue;
 391         SetReplaceWith( sValue );
 392     }
 393
 394     if( Replace.hasValue() )
 395     {
 396         sal_Int32 nValue(0);
 397         Replace >>= nValue;
 398         SetReplace( nValue );
 399     }
 400
 401     result = SearchReplace();
 402
 403     return result;
 404 }
 405
 406 void SAL_CALL
 407 SwVbaFind::ClearFormatting(  ) throw (uno::RuntimeException)
 408 {
 409     uno::Sequence< beans::PropertyValue >  aSearchAttribs;
 410     mxPropertyReplace->setSearchAttributes( aSearchAttribs );
 411 }
 412
 413 rtl::OUString&
 414 SwVbaFind::getServiceImplName()
 415 {
 416         static rtl::OUString sImplName( RTL_CONSTASCII_USTRINGPARAM("SwVbaFind") );
 417         return sImplName;
 418 }
 419
 420 uno::Sequence< rtl::OUString >
 421 SwVbaFind::getServiceNames()
 422 {
 423         static uno::Sequence< rtl::OUString > aServiceNames;
 424         if ( aServiceNames.getLength() == 0 )
 425         {
 426                 aServiceNames.realloc( 1 );
 427                 aServiceNames[ 0 ] = rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("ooo.vba.word.Find" ) );
 428         }
 429         return aServiceNames;
 430 }
 431