sw/source/core/edit/edws.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 <editsh.hxx>
  21
  22 #include <officecfg/Office/Common.hxx>
  23 #include <unotools/configmgr.hxx>
  24 #include <vcl/window.hxx>
  25
  26 #include <doc.hxx>
  27 #include <IDocumentUndoRedo.hxx>
  28 #include <IDocumentState.hxx>
  29 #include <pam.hxx>
  30 #include <docary.hxx>
  31 #include <acorrect.hxx>
  32 #include <swtable.hxx>
  33 #include <ndtxt.hxx>
  34 #include <txtfrm.hxx>
  35 #include <swundo.hxx>
  36 #include <SwRewriter.hxx>
  37 #include <frameformats.hxx>
  38
  39 // masqueraded copy constructor
  40 SwEditShell::SwEditShell( SwEditShell& rEdSH, vcl::Window *pWindow )
  41     : SwCursorShell( rEdSH, pWindow )
  42     , m_bNbspRunNext(false)   // TODO: would copying that make sense? only if editing continues
  43     , m_bDoParagraphSignatureValidation(true)
  44 {
  45 }
  46
  47 SwEditShell::SwEditShell( SwDoc& rDoc, vcl::Window *pWindow, const SwViewOption *pOptions )
  48     : SwCursorShell( rDoc, pWindow, pOptions )
  49     , m_bNbspRunNext(false)
  50     , m_bDoParagraphSignatureValidation(true)
  51 {
  52     if (!utl::ConfigManager::IsFuzzing() && 0 < officecfg::Office::Common::Undo::Steps::get())
  53     {
  54         GetDoc()->GetIDocumentUndoRedo().DoUndo(true);
  55     }
  56
  57     // Restore the paragraph metadata fields and validate signatures.
  58     RestoreMetadataFieldsAndValidateParagraphSignatures();
  59 }
  60
  61 SwEditShell::~SwEditShell() // USED
  62 {
  63 }
  64
  65 bool SwEditShell::IsModified() const
  66 {
  67     return GetDoc()->getIDocumentState().IsModified();
  68 }
  69
  70 void SwEditShell::SetModified()
  71 {
  72     GetDoc()->getIDocumentState().SetModified();
  73 }
  74
  75 void SwEditShell::ResetModified()
  76 {
  77     GetDoc()->getIDocumentState().ResetModified();
  78 }
  79
  80 void SwEditShell::SetUndoNoResetModified()
  81 {
  82     GetDoc()->getIDocumentState().SetModified();
  83     GetDoc()->GetIDocumentUndoRedo().SetUndoNoResetModified();
  84 }
  85
  86 void SwEditShell::StartAllAction()
  87 {
  88     for(SwViewShell& rCurrentShell : GetRingContainer())
  89     {
  90         if (SwEditShell* pEditShell = dynamic_cast<SwEditShell*>(&rCurrentShell))
  91             pEditShell->StartAction();
  92         else
  93             rCurrentShell.StartAction();
  94     }
  95 }
  96
  97 void SwEditShell::EndAllAction()
  98 {
  99     for(SwViewShell& rCurrentShell : GetRingContainer())
 100     {
 101         if( auto pEditShell = dynamic_cast<SwEditShell *>(&rCurrentShell))
 102             pEditShell->EndAction();
 103         else
 104             rCurrentShell.EndAction();
 105     }
 106 }
 107
 108 void SwEditShell::CalcLayout()
 109 {
 110     StartAllAction();
 111     SwViewShell::CalcLayout();
 112
 113     for(SwViewShell& rCurrentShell : GetRingContainer())
 114     {
 115         if ( rCurrentShell.GetWin() )
 116             rCurrentShell.GetWin()->Invalidate();
 117     }
 118
 119     EndAllAction();
 120 }
 121
 122 /** Get the content type of a shell
 123  *
 124  * @todo Is this called for every attribute?
 125  */
 126 sal_uInt16 SwEditShell::GetCntType() const
 127 {
 128     sal_uInt16 nRet = 0;
 129     if( IsTableMode() )
 130         nRet = CNT_TXT;
 131     else
 132         switch( GetCursor()->GetNode().GetNodeType() )
 133         {
 134         case SwNodeType::Text:   nRet = CNT_TXT; break;
 135         case SwNodeType::Grf:    nRet = CNT_GRF; break;
 136         case SwNodeType::Ole:    nRet = CNT_OLE; break;
 137         default: break;
 138         }
 139
 140     OSL_ASSERT( nRet );
 141     return nRet;
 142 }
 143
 144 bool SwEditShell::HasOtherCnt() const
 145
 146 {
 147     if ( !GetDoc()->GetSpzFrameFormats()->empty() )
 148         return true;
 149
 150     const SwNodes &rNds = GetDoc()->GetNodes();
 151     const SwNode *pNd;
 152
 153     pNd = &rNds.GetEndOfInserts();
 154     if ( 1 != (pNd->GetIndex() - pNd->StartOfSectionIndex()) )
 155         return true;
 156
 157     pNd = &rNds.GetEndOfAutotext();
 158     return 1 != (pNd->GetIndex() - pNd->StartOfSectionIndex());
 159 }
 160
 161 SwActContext::SwActContext(SwEditShell *pShell)
 162     : m_rShell(*pShell)
 163 {
 164     m_rShell.StartAction();
 165 }
 166
 167 SwActContext::~SwActContext() COVERITY_NOEXCEPT_FALSE
 168 {
 169     m_rShell.EndAction();
 170 }
 171
 172 SwMvContext::SwMvContext(SwEditShell *pShell)
 173     : m_rShell(*pShell)
 174 {
 175     m_rShell.SttCursorMove();
 176 }
 177
 178 SwMvContext::~SwMvContext() COVERITY_NOEXCEPT_FALSE
 179 {
 180     m_rShell.EndCursorMove();
 181 }
 182
 183 SwFrameFormat *SwEditShell::GetTableFormat() // fastest test on a table
 184 {
 185     const SwTableNode* pTableNd = IsCursorInTable();
 186     return pTableNd ? static_cast<SwFrameFormat*>(pTableNd->GetTable().GetFrameFormat()) : nullptr;
 187 }
 188
 189 // TODO: Why is this called 3x for a new document?
 190 sal_uInt16 SwEditShell::GetTOXTypeCount(TOXTypes eTyp) const
 191 {
 192     return mxDoc->GetTOXTypeCount(eTyp);
 193 }
 194
 195 void SwEditShell::InsertTOXType(const SwTOXType& rTyp)
 196 {
 197     mxDoc->InsertTOXType(rTyp);
 198 }
 199
 200 void SwEditShell::DoUndo( bool bOn )
 201 { GetDoc()->GetIDocumentUndoRedo().DoUndo( bOn ); }
 202
 203 bool SwEditShell::DoesUndo() const
 204 { return GetDoc()->GetIDocumentUndoRedo().DoesUndo(); }
 205
 206 void SwEditShell::DoGroupUndo( bool bOn )
 207 { GetDoc()->GetIDocumentUndoRedo().DoGroupUndo( bOn ); }
 208
 209 bool SwEditShell::DoesGroupUndo() const
 210 { return GetDoc()->GetIDocumentUndoRedo().DoesGroupUndo(); }
 211
 212 void SwEditShell::DelAllUndoObj()
 213 {
 214     GetDoc()->GetIDocumentUndoRedo().DelAllUndoObj();
 215 }
 216
 217 // Combine continuous calls of Insert/Delete/Overwrite on characters. Default: sdbcx::Group-Undo.
 218
 219 /** open undo container
 220  *
 221  * @return nUndoId ID of the container
 222  */
 223 SwUndoId SwEditShell::StartUndo( SwUndoId eUndoId,
 224                                    const SwRewriter *pRewriter )
 225 { return GetDoc()->GetIDocumentUndoRedo().StartUndo( eUndoId, pRewriter ); }
 226
 227 /** close undo container
 228  *
 229  * not used by UI
 230  *
 231  * @param eUndoId   ID of the undo container
 232  * @param pRewriter ?
 233 */
 234 SwUndoId SwEditShell::EndUndo(SwUndoId eUndoId, const SwRewriter *pRewriter)
 235 { return GetDoc()->GetIDocumentUndoRedo().EndUndo(eUndoId, pRewriter); }
 236
 237 bool     SwEditShell::GetLastUndoInfo(OUString *const o_pStr,
 238                                       SwUndoId *const o_pId,
 239                                       const SwView* pView) const
 240 {
 241     return GetDoc()->GetIDocumentUndoRedo().GetLastUndoInfo(o_pStr, o_pId, pView);
 242 }
 243
 244 bool SwEditShell::GetFirstRedoInfo(OUString *const o_pStr,
 245                                    SwUndoId *const o_pId,
 246                                    const SwView* pView) const
 247 {
 248     return GetDoc()->GetIDocumentUndoRedo().GetFirstRedoInfo(o_pStr, o_pId, pView);
 249 }
 250
 251 SwUndoId SwEditShell::GetRepeatInfo(OUString *const o_pStr) const
 252 { return GetDoc()->GetIDocumentUndoRedo().GetRepeatInfo(o_pStr); }
 253
 254 /** Auto correction */
 255 void SwEditShell::AutoCorrect( SvxAutoCorrect& rACorr, bool bInsert,
 256                                 sal_Unicode cChar )
 257 {
 258     CurrShell aCurr( this );
 259
 260     StartAllAction();
 261
 262     SwPaM* pCursor = getShellCursor( true );
 263     SwTextNode* pTNd = pCursor->GetNode().GetTextNode();
 264
 265     SwAutoCorrDoc aSwAutoCorrDoc( *this, *pCursor, cChar );
 266     // FIXME: this _must_ be called with reference to the actual node text!
 267     SwTextFrame const*const pFrame(static_cast<SwTextFrame const*>(pTNd->getLayoutFrame(GetLayout())));
 268     TextFrameIndex const nPos(pFrame->MapModelToViewPos(*pCursor->GetPoint()));
 269     OUString const& rMergedText(pFrame->GetText());
 270     rACorr.DoAutoCorrect( aSwAutoCorrDoc,
 271                     rMergedText, sal_Int32(nPos),
 272                     cChar, bInsert, m_bNbspRunNext, GetWin() );
 273     if( cChar )
 274         SaveTableBoxContent( pCursor->GetPoint() );
 275     EndAllAction();
 276 }
 277
 278 void SwEditShell::SetNewDoc()
 279 {
 280     GetDoc()->getIDocumentState().SetNewDoc(true);
 281 }
 282
 283 OUString SwEditShell::GetPrevAutoCorrWord(SvxAutoCorrect& rACorr)
 284 {
 285     CurrShell aCurr( this );
 286
 287     OUString sRet;
 288     SwPaM* pCursor = getShellCursor( true );
 289     SwTextNode* pTNd = pCursor->GetNode().GetTextNode();
 290     if (pTNd)
 291     {
 292         SwAutoCorrDoc aSwAutoCorrDoc( *this, *pCursor, 0 );
 293         SwTextFrame const*const pFrame(static_cast<SwTextFrame const*>(pTNd->getLayoutFrame(GetLayout())));
 294         TextFrameIndex const nPos(pFrame->MapModelToViewPos(*pCursor->GetPoint()));
 295         sRet = rACorr.GetPrevAutoCorrWord(aSwAutoCorrDoc, pFrame->GetText(), sal_Int32(nPos));
 296     }
 297     return sRet;
 298 }
 299
 300 std::vector<OUString> SwEditShell::GetChunkForAutoText()
 301 {
 302     CurrShell aCurr(this);
 303
 304     std::vector<OUString> aRet;
 305     SwPaM* pCursor = getShellCursor(true);
 306     SwTextNode* pTNd = pCursor->GetNode().GetTextNode();
 307     if (pTNd)
 308     {
 309         const auto pFrame = static_cast<SwTextFrame const*>(pTNd->getLayoutFrame(GetLayout()));
 310         TextFrameIndex const nPos(pFrame->MapModelToViewPos(*pCursor->GetPoint()));
 311         aRet = SvxAutoCorrect::GetChunkForAutoText(pFrame->GetText(), sal_Int32(nPos));
 312     }
 313     return aRet;
 314 }
 315
 316 SwAutoCompleteWord& SwEditShell::GetAutoCompleteWords()
 317 {
 318     return SwDoc::GetAutoCompleteWords();
 319 }
 320
 321 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */