LibreOffice Module sw (master)  1
ww8glsy.cxx
Go to the documentation of this file.
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 <memory>
21 #include <tools/urlobj.hxx>
22 #include <svl/urihelper.hxx>
23 #include <rtl/tencinfo.h>
24 #include <swerror.h>
25 #include <ndtxt.hxx>
26 #include <pam.hxx>
27 #include <shellio.hxx>
28 #include <docsh.hxx>
29 #include <fmtanchr.hxx>
30 #include <frmfmt.hxx>
31 #include <doc.hxx>
33 #include <docary.hxx>
34 #include "ww8glsy.hxx"
35 #include "ww8par.hxx"
36 #include "ww8par2.hxx"
37 
39  : rStrm(refStrm)
40  , xStg(pStg)
41  , nStrings(0)
42 {
43  refStrm->SetEndian(SvStreamEndian::LITTLE);
44  WW8Fib aWwFib(*refStrm, nVersion);
45 
46  if (aWwFib.m_nFibBack >= 0x6A) //Word97
47  {
49  aWwFib.m_fWhichTableStm ? SL::a1Table : SL::a0Table, StreamMode::STD_READ);
50 
51  if (xTableStream.is() && ERRCODE_NONE == xTableStream->GetError())
52  {
53  xTableStream->SetEndian(SvStreamEndian::LITTLE);
54  xGlossary.reset(new WW8GlossaryFib(*refStrm, nVersion, aWwFib));
55  }
56  }
57 }
58 
60 {
61  bool bRet=false;
62  for( sal_uInt16 nCnt = pDoc->GetSpzFrameFormats()->size(); nCnt; )
63  {
64  const SwFrameFormat* pFrameFormat = (*pDoc->GetSpzFrameFormats())[ --nCnt ];
65  if ( RES_FLYFRMFMT != pFrameFormat->Which() &&
66  RES_DRAWFRMFMT != pFrameFormat->Which() )
67  continue;
68  const SwFormatAnchor& rAnchor = pFrameFormat->GetAnchor();
69  SwPosition const*const pAPos = rAnchor.GetContentAnchor();
70  if (pAPos &&
71  ((RndStdIds::FLY_AT_PARA == rAnchor.GetAnchorId()) ||
72  (RndStdIds::FLY_AT_CHAR == rAnchor.GetAnchorId())) &&
73  rIdx == pAPos->nNode.GetIndex() )
74  {
75  bRet=true;
76  break;
77  }
78  }
79  return bRet;
80 }
81 
83  bool bSaveRelFile, const std::vector<OUString>& rStrings,
84  const std::vector<ww::bytes>& rExtra)
85 {
86  // this code will be called after reading all text into the
87  // empty sections
88  const OUString aOldURL( rBlocks.GetBaseURL() );
89  bool bRet=false;
90  if( bSaveRelFile )
91  {
92  rBlocks.SetBaseURL(
94  INetURLObject(), rBlocks.GetFileName(),
96  }
97  else
98  rBlocks.SetBaseURL( OUString() );
99 
100  SwNodeIndex aDocEnd( pD->GetNodes().GetEndOfContent() );
101  SwNodeIndex aStart( *aDocEnd.GetNode().StartOfSectionNode(), 1 );
102 
103  // search the first NormalStartNode
104  while( !( aStart.GetNode().IsStartNode() && SwNormalStartNode ==
105  aStart.GetNode().GetStartNode()->GetStartNodeType()) &&
106  aStart < aDocEnd )
107  ++aStart;
108 
109  if( aStart < aDocEnd )
110  {
112  (RES_POOLCOLL_STANDARD, false);
113  sal_uInt16 nGlosEntry = 0;
114  SwContentNode* pCNd = nullptr;
115  do {
116  SwPaM aPam( aStart );
117  {
118  SwNodeIndex& rIdx = aPam.GetPoint()->nNode;
119  ++rIdx;
120  if( nullptr == ( pCNd = rIdx.GetNode().GetTextNode() ) )
121  {
122  pCNd = pD->GetNodes().MakeTextNode( rIdx, pColl );
123  rIdx = *pCNd;
124  }
125  }
126  aPam.GetPoint()->nContent.Assign( pCNd, 0 );
127  aPam.SetMark();
128  {
129  SwNodeIndex& rIdx = aPam.GetPoint()->nNode;
130  rIdx = aStart.GetNode().EndOfSectionIndex() - 1;
131  if(( nullptr == ( pCNd = rIdx.GetNode().GetContentNode() ) )
132  || HasBareGraphicEnd(pD,rIdx))
133  {
134  ++rIdx;
135  pCNd = pD->GetNodes().MakeTextNode( rIdx, pColl );
136  rIdx = *pCNd;
137  }
138  }
139  aPam.GetPoint()->nContent.Assign( pCNd, pCNd->Len() );
140 
141  // now we have the right selection for one entry. Copy this to
142  // the defined TextBlock, but only if it is not an autocorrection
143  // entry (== -1) otherwise the group indicates the group in the
144  // sttbfglsystyle list that this entry belongs to. Unused at the
145  // moment
146  const ww::bytes &rData = rExtra[nGlosEntry];
147  sal_uInt16 n = SVBT16ToUInt16( &(rData[2]) );
148  if(n != 0xFFFF)
149  {
150  rBlocks.ClearDoc();
151  const OUString &rLNm = rStrings[nGlosEntry];
152 
153  OUString sShortcut = rLNm;
154 
155  // Need to check make sure the shortcut is not already being used
156  sal_Int32 nStart = 0;
157  sal_uInt16 nCurPos = rBlocks.GetIndex( sShortcut );
158  while( sal_uInt16(-1) != nCurPos )
159  {
160  sShortcut = rLNm + OUString::number(++nStart); // add an Number to it
161  nCurPos = rBlocks.GetIndex( sShortcut );
162  }
163 
164  if( rBlocks.BeginPutDoc( sShortcut, sShortcut )) // Make the shortcut and the name the same
165 
166  {
167  SwDoc* pGlDoc = rBlocks.GetDoc();
168  SwNodeIndex aIdx( pGlDoc->GetNodes().GetEndOfContent(),
169  -1 );
170  pCNd = aIdx.GetNode().GetContentNode();
171  SwPosition aPos(aIdx, SwIndex(pCNd, pCNd ? pCNd->Len() : 0));
172  pD->getIDocumentContentOperations().CopyRange( aPam, aPos, /*bCopyAll=*/false, /*bCheckPos=*/true );
173  rBlocks.PutDoc();
174  }
175  }
176  aStart = aStart.GetNode().EndOfSectionIndex() + 1;
177  ++nGlosEntry;
178  } while( aStart.GetNode().IsStartNode() &&
179  SwNormalStartNode == aStart.GetNode().
180  GetStartNode()->GetStartNodeType());
181  bRet=true;
182  }
183 
184 // this code will be called after reading all text into the empty sections
185 
186  rBlocks.SetBaseURL( aOldURL );
187  return bRet;
188 }
189 
190 bool WW8Glossary::Load( SwTextBlocks &rBlocks, bool bSaveRelFile )
191 {
192  bool bRet=false;
193  if (xGlossary && xGlossary->IsGlossaryFib() && rBlocks.StartPutMuchBlockEntries())
194  {
195  //read the names of the autotext entries
196  std::vector<OUString> aStrings;
197  std::vector<ww::bytes> aData;
198 
199  rtl_TextEncoding eStructCharSet =
200  WW8Fib::GetFIBCharset(xGlossary->m_chseTables, xGlossary->m_lid);
201 
202  WW8ReadSTTBF(true, *xTableStream, xGlossary->m_fcSttbfglsy,
203  xGlossary->m_lcbSttbfglsy, 0, eStructCharSet, aStrings, &aData );
204 
205  rStrm->Seek(0);
206 
207  if ( 0 != (nStrings = static_cast< sal_uInt16 >(aStrings.size())))
208  {
209  SfxObjectShellLock xDocSh(new SwDocShell(SfxObjectCreateMode::INTERNAL));
210  if (xDocSh->DoInitNew())
211  {
212  SwDoc *pD = static_cast<SwDocShell*>((&xDocSh))->GetDoc();
213 
214  SwNodeIndex aIdx(
216  if( !aIdx.GetNode().IsTextNode() )
217  {
218  OSL_ENSURE( false, "Where is the TextNode?" );
219  pD->GetNodes().GoNext( &aIdx );
220  }
221  SwPaM aPamo( aIdx );
222  aPamo.GetPoint()->nContent.Assign(aIdx.GetNode().GetContentNode(),
223  0);
224  std::unique_ptr<SwWW8ImplReader> xRdr(new SwWW8ImplReader(
225  xGlossary->m_nVersion, xStg.get(), rStrm.get(), *pD, rBlocks.GetBaseURL(),
226  true, false, *aPamo.GetPoint()));
227  xRdr->LoadDoc(this);
228  bRet = MakeEntries(pD, rBlocks, bSaveRelFile, aStrings, aData);
229  }
230  xDocSh->DoClose();
231  rBlocks.EndPutMuchBlockEntries();
232  }
233  }
234  return bRet;
235 }
236 
238 {
239  sal_uInt32 nGlossaryFibOffset = 0;
240  if ( rFib.m_fDot ) // it's a template
241  {
242  if ( rFib.m_pnNext )
243  nGlossaryFibOffset = ( rFib.m_pnNext * 512 );
244  }
245  return nGlossaryFibOffset;
246 }
247 
248 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
bool is() const
virtual sal_Int32 Len() const
Definition: node.cxx:1183
Represents the style of a paragraph.
Definition: fmtcol.hxx:55
Marks a position in the document model.
Definition: pam.hxx:35
std::shared_ptr< WW8GlossaryFib > xGlossary
Definition: ww8glsy.hxx:73
sal_uInt16 PutDoc()
Definition: swblocks.cxx:436
static bool HasBareGraphicEnd(SwDoc *pD, SwNodeIndex const &rIdx)
Definition: ww8glsy.cxx:59
SwNodeIndex nNode
Definition: pam.hxx:37
std::vector< sal_uInt8 > bytes
Definition: types.hxx:27
bool m_fDot
Definition: ww8scan.hxx:1149
Definition: doc.hxx:185
SwNode & GetNode() const
Definition: ndindex.hxx:118
WW8Glossary(tools::SvRef< SotStorageStream > &refStrm, sal_uInt8 nVersion, SotStorage *pStg)
Definition: ww8glsy.cxx:38
bool Load(SwTextBlocks &rBlocks, bool bSaveRelFile)
Definition: ww8glsy.cxx:190
tools::SvRef< SotStorageStream > xTableStream
Definition: ww8glsy.hxx:74
IDocumentContentOperations const & getIDocumentContentOperations() const
Definition: doc.cxx:347
const SwFrameFormats * GetSpzFrameFormats() const
Definition: doc.hxx:738
const char a1Table[]
Definition: ww8scan.hxx:52
SwIndex nContent
Definition: pam.hxx:38
static bool MakeEntries(SwDoc *pD, SwTextBlocks &rBlocks, bool bSaveRelFile, const std::vector< OUString > &rStrings, const std::vector< ww::bytes > &rExtra)
Definition: ww8glsy.cxx:82
IDocumentStylePoolAccess const & getIDocumentStylePoolAccess() const
Definition: doc.cxx:458
sal_uLong GetIndex() const
Definition: ndindex.hxx:151
const char a0Table[]
Definition: ww8scan.hxx:53
SwNode & GetEndOfContent() const
Regular ContentSection (i.e. the BodyText).
Definition: ndarr.hxx:164
#define RES_FLYFRMFMT
Definition: hintids.hxx:274
SwDoc * GetDoc()
returns Doc. But be careful!
Definition: docsh.hxx:202
PaM is Point and Mark: a selection of the document model.
Definition: pam.hxx:136
T * get() const
static SwNodePtr GetStartNode(SwOutlineNodes const *pOutlNds, int nOutlineLevel, SwOutlineNodes::size_type *nOutl)
Definition: docglbl.cxx:90
Style of a layout element.
Definition: frmfmt.hxx:57
void SetBaseURL(const OUString &rURL)
Definition: swblocks.cxx:603
const SwFormatAnchor & GetAnchor(bool=true) const
Definition: fmtanchr.hxx:81
SotStorageStream * OpenSotStream(const OUString &rEleName, StreamMode=StreamMode::STD_READWRITE)
const SwStartNode * StartOfSectionNode() const
Definition: node.hxx:131
const SwPosition * GetPoint() const
Definition: pam.hxx:207
SwIndex & Assign(SwIndexReg *, sal_Int32)
Definition: index.cxx:198
RndStdIds GetAnchorId() const
Definition: fmtanchr.hxx:65
SVL_DLLPUBLIC Link< OUString *, bool > const & GetMaybeFileHdl()
const SwPosition * GetContentAnchor() const
Definition: fmtanchr.hxx:67
SwContentNode * GetContentNode()
Definition: node.hxx:615
FlyAnchors.
Definition: fmtanchr.hxx:34
Marks a character position inside a document model node.
Definition: index.hxx:37
void WW8ReadSTTBF(bool bVer8, SvStream &rStrm, sal_uInt32 nStart, sal_Int32 nLen, sal_uInt16 nExtraLen, rtl_TextEncoding eCS, std::vector< OUString > &rArray, std::vector< ww::bytes > *pExtraArray, std::vector< OUString > *pValueArray)
reads array of strings (see MS documentation: STring TaBle stored in File) returns NOT the original p...
Definition: ww8scan.cxx:4118
void EndPutMuchBlockEntries()
Definition: swblocks.cxx:590
Marks a node in the document model.
Definition: ndindex.hxx:31
GUIDCNamePair const aData
SwDoc * GetDoc()
Definition: swblocks.cxx:508
sal_uInt16 nStrings
Definition: ww8glsy.hxx:77
bool BeginPutDoc(const OUString &, const OUString &)
Definition: swblocks.cxx:412
sal_uInt16 Which() const
for Querying of Writer-functions.
Definition: format.hxx:78
sal_uLong EndOfSectionIndex() const
Definition: node.hxx:677
OUString GetBaseURL() const
Definition: swblocks.cxx:596
#define RES_DRAWFRMFMT
Definition: hintids.hxx:277
#define ERRCODE_NONE
unsigned char sal_uInt8
sal_uInt16 GetIndex(const OUString &) const
Definition: swblocks.cxx:279
bool DoInitNew(SfxMedium *pMedium=nullptr)
SwNodes & GetNodes()
Definition: doc.hxx:403
virtual SwTextFormatColl * GetTextCollFromPool(sal_uInt16 nId, bool bRegardLanguage=true)=0
Return "Auto-Collection with ID.
static sal_uInt32 FindGlossaryFibOffset(const WW8Fib &rFib)
Definition: ww8glsy.cxx:237
sal_uInt16 m_nFibBack
Definition: ww8scan.hxx:1170
bool m_fWhichTableStm
Definition: ww8scan.hxx:1155
FIB - the File Information Block.
Definition: ww8scan.hxx:1106
WW8_PN m_pnNext
Definition: ww8scan.hxx:1147
void ClearDoc()
Definition: swblocks.cxx:515
size_t size() const
Definition: docary.hxx:224
static rtl_TextEncoding GetFIBCharset(sal_uInt16 chs, LanguageType nLidLocale)
Definition: ww8scan.cxx:6581
virtual void SetMark()
Unless this is called, the getter method of Mark will return Point.
Definition: pam.cxx:457
tools::SvRef< SotStorageStream > & rStrm
Definition: ww8glsy.hxx:75
tools::SvRef< SotStorage > const xStg
Definition: ww8glsy.hxx:76
SwContentNode * GoNext(SwNodeIndex *) const
Definition: nodes.cxx:1273
bool StartPutMuchBlockEntries()
Definition: swblocks.cxx:582
OUString const & GetFileName() const
Definition: swblocks.cxx:524
SwTextNode * GetTextNode()
Inline methods from Node.hxx.
Definition: ndtxt.hxx:842
SwTextNode * MakeTextNode(const SwNodeIndex &rWhere, SwTextFormatColl *pColl, bool bNewFrames=true)
Implementations of "Make...Node" are in the given .cxx-files.
Definition: ndtxt.cxx:114
SVL_DLLPUBLIC OUString SmartRel2Abs(INetURLObject const &rTheBaseURIRef, OUString const &rTheRelURIRef, Link< OUString *, bool > const &rMaybeFileHdl=Link< OUString *, bool >(), bool bCheckFileExists=true, bool bIgnoreFragment=false, INetURLObject::EncodeMechanism eEncodeMechanism=INetURLObject::EncodeMechanism::WasEncoded, INetURLObject::DecodeMechanism eDecodeMechanism=INetURLObject::DecodeMechanism::ToIUri, rtl_TextEncoding eCharset=RTL_TEXTENCODING_UTF8, FSysStyle eStyle=FSysStyle::Detect)
virtual bool CopyRange(SwPaM &rPam, SwPosition &rPos, const bool bCopyAll, bool bCheckPos) const =0
Copy a selected content range to a position.