sw/source/core/edit/edtox.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 <com/sun/star/util/SearchAlgorithms2.hpp>
  21 #include <com/sun/star/util/SearchFlags.hpp>
  22 #include <i18nlangtag/languagetag.hxx>
  23 #include <i18nutil/transliteration.hxx>
  24 #include <i18nutil/searchopt.hxx>
  25 #include <svl/fstathelper.hxx>
  26 #include <osl/diagnose.h>
  27 #include <osl/thread.h>
  28 #include <unotools/syslocale.hxx>
  29
  30 #include <sfx2/docfile.hxx>
  31
  32 #include <swtypes.hxx>
  33 #include <rootfrm.hxx>
  34 #include <editsh.hxx>
  35 #include <doc.hxx>
  36 #include <IDocumentContentOperations.hxx>
  37 #include <IDocumentUndoRedo.hxx>
  38 #include <pam.hxx>
  39 #include <swundo.hxx>
  40 #include <tox.hxx>
  41 #include <doctxm.hxx>
  42 #include <docary.hxx>
  43 #include <mdiexp.hxx>
  44 #include <strings.hrc>
  45 #include <iodetect.hxx>
  46
  47 using namespace ::com::sun::star;
  48 using namespace ::com::sun::star::lang;
  49 using namespace ::com::sun::star::util;
  50
  51 // Add/delete listing markers to a document
  52
  53 void SwEditShell::Insert(const SwTOXMark& rMark)
  54 {
  55     bool bInsAtPos = rMark.IsAlternativeText();
  56     StartAllAction();
  57     for(SwPaM& rPaM : GetCursor()->GetRingContainer())
  58     {
  59         auto [pStart, pEnd] = rPaM.StartEnd(); // SwPosition*
  60         if( bInsAtPos )
  61         {
  62             SwPaM aTmp( *pStart );
  63             GetDoc()->getIDocumentContentOperations().InsertPoolItem( aTmp, rMark );
  64         }
  65         else if( *pEnd != *pStart )
  66         {
  67             GetDoc()->getIDocumentContentOperations().InsertPoolItem(
  68                 rPaM, rMark, SetAttrMode::DONTEXPAND );
  69         }
  70
  71     }
  72     EndAllAction();
  73 }
  74
  75 void SwEditShell::DeleteTOXMark( SwTOXMark const * pMark )
  76 {
  77     CurrShell aCurr( this );
  78     StartAllAction();
  79
  80     mxDoc->DeleteTOXMark( pMark );
  81
  82     EndAllAction();
  83 }
  84
  85 /// Collect all listing markers
  86 void SwEditShell::GetCurTOXMarks(SwTOXMarks& rMarks) const
  87 {
  88     SwDoc::GetCurTOXMark( *GetCursor()->Start(), rMarks );
  89 }
  90
  91 bool SwEditShell::IsTOXBaseReadonly(const SwTOXBase& rTOXBase)
  92 {
  93     assert( dynamic_cast<const SwTOXBaseSection*>( &rTOXBase) && "no TOXBaseSection!" );
  94     const SwTOXBaseSection& rTOXSect = static_cast<const SwTOXBaseSection&>(rTOXBase);
  95     return  rTOXSect.IsProtect();
  96 }
  97
  98 void SwEditShell::SetTOXBaseReadonly(const SwTOXBase& rTOXBase, bool bReadonly)
  99 {
 100     assert( dynamic_cast<const SwTOXBaseSection*>( &rTOXBase) && "no TOXBaseSection!" );
 101     const SwTOXBaseSection& rTOXSect = static_cast<const SwTOXBaseSection&>(rTOXBase);
 102     const_cast<SwTOXBase&>(rTOXBase).SetProtected(bReadonly);
 103     OSL_ENSURE( rTOXSect.SwSection::GetType() == SectionType::ToxContent, "not a TOXContentSection" );
 104
 105     SwSectionData aSectionData(rTOXSect);
 106     aSectionData.SetProtectFlag(bReadonly);
 107     UpdateSection( GetSectionFormatPos( *rTOXSect.GetFormat()  ), aSectionData );
 108 }
 109
 110 const SwTOXBase*    SwEditShell::GetDefaultTOXBase( TOXTypes eTyp, bool bCreate )
 111 {
 112     return GetDoc()->GetDefaultTOXBase( eTyp, bCreate );
 113 }
 114
 115 void    SwEditShell::SetDefaultTOXBase(const SwTOXBase& rBase)
 116 {
 117     GetDoc()->SetDefaultTOXBase(rBase);
 118 }
 119
 120 /// Insert listing and create content
 121 void SwEditShell::InsertTableOf( const SwTOXBase& rTOX, const SfxItemSet* pSet )
 122 {
 123     CurrShell aCurr( this );
 124     StartAllAction();
 125
 126     SwDocShell* pDocSh = GetDoc()->GetDocShell();
 127     ::StartProgress( STR_STATSTR_TOX_INSERT, 0, 0, pDocSh );
 128
 129     // Insert listing
 130     const SwTOXBaseSection* pTOX = mxDoc->InsertTableOf(
 131                 *GetCursor()->GetPoint(), rTOX, pSet, true, GetLayout() );
 132     assert(pTOX && "No current TOX");
 133
 134     // start formatting
 135     CalcLayout();
 136
 137     // insert page numbering
 138     const_cast<SwTOXBaseSection*>(pTOX)->UpdatePageNum();
 139
 140     pTOX->SetPosAtStartEnd( *GetCursor()->GetPoint() );
 141
 142     // Fix for empty listing
 143     InvalidateWindows( maVisArea );
 144     ::EndProgress( pDocSh );
 145     EndAllAction();
 146 }
 147
 148 /// update tables of content
 149 void SwEditShell::UpdateTableOf(const SwTOXBase& rTOX, const SfxItemSet* pSet)
 150 {
 151     assert(dynamic_cast<const SwTOXBaseSection*>(&rTOX) && "no TOXBaseSection!");
 152     SwTOXBaseSection& rTOXSect = static_cast<SwTOXBaseSection&>(const_cast<SwTOXBase&>(rTOX));
 153     if (!rTOXSect.GetFormat()->GetSectionNode())
 154         return;
 155
 156     SwDoc* pMyDoc = GetDoc();
 157     SwDocShell* pDocSh = pMyDoc->GetDocShell();
 158
 159     bool bInIndex = &rTOX == GetCurTOX();
 160     CurrShell aCurr( this );
 161     StartAllAction();
 162
 163     ::StartProgress( STR_STATSTR_TOX_UPDATE, 0, 0, pDocSh );
 164
 165     pMyDoc->GetIDocumentUndoRedo().StartUndo(SwUndoId::TOXCHANGE, nullptr);
 166
 167     // create listing stub
 168     rTOXSect.Update(pSet, GetLayout());
 169
 170     // correct Cursor
 171     if( bInIndex )
 172         rTOXSect.SetPosAtStartEnd(*GetCursor()->GetPoint());
 173
 174     // start formatting
 175     // tdf#139426 ...but allow suppression of AssertFlyPages
 176     GetLayout()->SetTableUpdateInProgress(true);
 177     CalcLayout();
 178     GetLayout()->SetTableUpdateInProgress(false);
 179
 180     // insert page numbering
 181     rTOXSect.UpdatePageNum();
 182
 183     pMyDoc->GetIDocumentUndoRedo().EndUndo(SwUndoId::TOXCHANGE, nullptr);
 184
 185     ::EndProgress( pDocSh );
 186     EndAllAction();
 187 }
 188
 189 /// Get current listing before or at the Cursor
 190 const SwTOXBase* SwEditShell::GetCurTOX() const
 191 {
 192     return SwDoc::GetCurTOX( *GetCursor()->GetPoint() );
 193 }
 194
 195 bool SwEditShell::DeleteTOX( const SwTOXBase& rTOXBase, bool bDelNodes )
 196 {
 197     return GetDoc()->DeleteTOX( rTOXBase, bDelNodes );
 198 }
 199
 200 // manage types of listings
 201
 202 const SwTOXType* SwEditShell::GetTOXType(TOXTypes eTyp, sal_uInt16 nId) const
 203 {
 204     return mxDoc->GetTOXType(eTyp, nId);
 205 }
 206
 207 // manage keys for the alphabetical index
 208
 209 void SwEditShell::GetTOIKeys( SwTOIKeyType eTyp, std::vector<OUString>& rArr ) const
 210 {
 211     GetDoc()->GetTOIKeys( eTyp, rArr, *GetLayout() );
 212 }
 213
 214 sal_uInt16 SwEditShell::GetTOXCount() const
 215 {
 216     const SwSectionFormats& rFormats = GetDoc()->GetSections();
 217     sal_uInt16 nRet = 0;
 218     for( auto n = rFormats.size(); n; )
 219     {
 220         const SwSection* pSect = rFormats[ --n ]->GetSection();
 221         if( SectionType::ToxContent == pSect->GetType() &&
 222             pSect->GetFormat()->GetSectionNode() )
 223             ++nRet;
 224     }
 225     return nRet;
 226 }
 227
 228 const SwTOXBase* SwEditShell::GetTOX( sal_uInt16 nPos ) const
 229 {
 230     const SwSectionFormats& rFormats = GetDoc()->GetSections();
 231     sal_uInt16 nCnt {0};
 232     for( const SwSectionFormat *pFormat : rFormats )
 233     {
 234         const SwSection* pSect = pFormat->GetSection();
 235         if( SectionType::ToxContent == pSect->GetType() &&
 236             pSect->GetFormat()->GetSectionNode() &&
 237             nCnt++ == nPos )
 238         {
 239             assert( dynamic_cast<const SwTOXBaseSection*>( pSect) && "no TOXBaseSection!" );
 240             return static_cast<const SwTOXBaseSection*>(pSect);
 241         }
 242     }
 243     return nullptr;
 244 }
 245
 246 /** Update of all listings after reading-in a file */
 247 void SwEditShell::SetUpdateTOX( bool bFlag )
 248 {
 249     GetDoc()->SetUpdateTOX( bFlag );
 250 }
 251
 252 bool SwEditShell::IsUpdateTOX() const
 253 {
 254     return GetDoc()->IsUpdateTOX();
 255 }
 256
 257 OUString const & SwEditShell::GetTOIAutoMarkURL() const
 258 {
 259     return GetDoc()->GetTOIAutoMarkURL();
 260 }
 261
 262 void SwEditShell::SetTOIAutoMarkURL(const OUString& rSet)
 263 {
 264     GetDoc()->SetTOIAutoMarkURL(rSet);
 265 }
 266
 267 void SwEditShell::ApplyAutoMark()
 268 {
 269     StartAllAction();
 270     bool bDoesUndo = DoesUndo();
 271     DoUndo(false);
 272     //1. remove all automatic generated index entries if AutoMarkURL has a
 273     //   length and the file exists
 274     //2. load file
 275     //3. select all occurrences of the searched words
 276     //4. apply index entries
 277
 278     OUString sAutoMarkURL(GetDoc()->GetTOIAutoMarkURL());
 279     if( !sAutoMarkURL.isEmpty() && FStatHelper::IsDocument( sAutoMarkURL ))
 280     {
 281         //1.
 282         const SwTOXType* pTOXType = GetTOXType(TOX_INDEX, 0);
 283
 284         SwTOXMarks aMarks;
 285         pTOXType->CollectTextMarks(aMarks);
 286         for( SwTOXMark* pMark : aMarks )
 287         {
 288             if(pMark->IsAutoGenerated() && pMark->GetTextTOXMark())
 289                 // mba: test iteration; objects are deleted in iteration
 290                 DeleteTOXMark(pMark);
 291         }
 292
 293         //2.
 294         SfxMedium aMedium( sAutoMarkURL, StreamMode::STD_READ );
 295         SvStream& rStrm = *aMedium.GetInStream();
 296         Push();
 297         // tdf#106899 - import tox concordance file using the appropriate character set
 298         rtl_TextEncoding eChrSet = SwIoSystem::GetTextEncoding(rStrm);
 299         if (eChrSet == RTL_TEXTENCODING_DONTKNOW)
 300             eChrSet = ::osl_getThreadTextEncoding();
 301
 302         // SearchOptions to be used in loop below
 303         sal_Int32 const nLEV_Other    = 2;    //  -> changedChars;
 304         sal_Int32 const nLEV_Longer   = 3;    //! -> deletedChars;
 305         sal_Int32 const nLEV_Shorter  = 1;    //! -> insertedChars;
 306
 307         i18nutil::SearchOptions2 aSearchOpt(
 308                             SearchFlags::LEV_RELAXED,
 309                             u""_ustr, u""_ustr,
 310                             SvtSysLocale().GetLanguageTag().getLocale(),
 311                             nLEV_Other, nLEV_Longer, nLEV_Shorter,
 312                             TransliterationFlags::NONE,
 313                             SearchAlgorithms2::ABSOLUTE,
 314                             '\\' );
 315
 316         OStringBuffer aRdLine;
 317         while (rStrm.good())
 318         {
 319             rStrm.ReadLine( aRdLine );
 320
 321             // # -> comment
 322             // ; -> delimiter between entries ->
 323             // Format: TextToSearchFor;AlternativeString;PrimaryKey;SecondaryKey;CaseSensitive;WordOnly
 324             // Leading and trailing blanks are ignored
 325             if( !aRdLine.isEmpty() && '#' != aRdLine[0] )
 326             {
 327                 OUString sLine(OStringToOUString(aRdLine, eChrSet));
 328
 329                 sal_Int32 nTokenPos = 0;
 330                 OUString sToSelect( sLine.getToken(0, ';', nTokenPos ) );
 331                 if( !sToSelect.isEmpty() )
 332                 {
 333                     OUString sAlternative = sLine.getToken(0, ';', nTokenPos);
 334                     OUString sPrimary     = sLine.getToken(0, ';', nTokenPos);
 335                     OUString sSecondary   = sLine.getToken(0, ';', nTokenPos);
 336                     OUString sCase        = sLine.getToken(0, ';', nTokenPos);
 337                     OUString sWordOnly    = sLine.getToken(0, ';', nTokenPos);
 338
 339                     //3.
 340                     bool bCaseSensitive = !sCase.isEmpty() && sCase != "0";
 341                     bool bWordOnly = !sWordOnly.isEmpty() && sWordOnly != "0";
 342
 343                     if (!bCaseSensitive)
 344                     {
 345                         aSearchOpt.transliterateFlags |=
 346                                      TransliterationFlags::IGNORE_CASE;
 347                     }
 348                     else
 349                     {
 350                         aSearchOpt.transliterateFlags &=
 351                                     ~TransliterationFlags::IGNORE_CASE;
 352                     }
 353                     if ( bWordOnly)
 354                         aSearchOpt.searchFlag |=  SearchFlags::NORM_WORD_ONLY;
 355                     else
 356                         aSearchOpt.searchFlag &= ~SearchFlags::NORM_WORD_ONLY;
 357
 358                     aSearchOpt.searchString = sToSelect;
 359
 360                     KillPams();
 361                     bool bCancel;
 362
 363                     // todo/mba: assuming that notes shouldn't be searched
 364                     sal_Int32 nRet = Find_Text(aSearchOpt, false/*bSearchInNotes*/, SwDocPositions::Start, SwDocPositions::End, bCancel,
 365                                     FindRanges::InSelAll );
 366
 367                     if(nRet)
 368                     {
 369                         SwTOXMark* pTmpMark = new SwTOXMark(pTOXType);
 370                         if( !sPrimary.isEmpty() )
 371                         {
 372                             pTmpMark->SetPrimaryKey( sPrimary );
 373                             if( !sSecondary.isEmpty() )
 374                                 pTmpMark->SetSecondaryKey( sSecondary );
 375                         }
 376                         if( !sAlternative.isEmpty() )
 377                             pTmpMark->SetAlternativeText(sAlternative);
 378                         pTmpMark->SetMainEntry(false);
 379                         pTmpMark->SetAutoGenerated(true);
 380                         //4.
 381                         SwEditShell::Insert(*pTmpMark);
 382                     }
 383                 }
 384             }
 385         }
 386         KillPams();
 387         Pop(PopMode::DeleteCurrent);
 388     }
 389     DoUndo(bDoesUndo);
 390     EndAllAction();
 391 }
 392
 393 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */