lotuswordpro/source/filter/lwpfoundry.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  *  The Contents of this file are made available subject to the terms of
   5  *  either of the following licenses
   6  *
   7  *         - GNU Lesser General Public License Version 2.1
   8  *         - Sun Industry Standards Source License Version 1.1
   9  *
  10  *  Sun Microsystems Inc., October, 2000
  11  *
  12  *  GNU Lesser General Public License Version 2.1
  13  *  =============================================
  14  *  Copyright 2000 by Sun Microsystems, Inc.
  15  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16  *
  17  *  This library is free software; you can redistribute it and/or
  18  *  modify it under the terms of the GNU Lesser General Public
  19  *  License version 2.1, as published by the Free Software Foundation.
  20  *
  21  *  This library is distributed in the hope that it will be useful,
  22  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24  *  Lesser General Public License for more details.
  25  *
  26  *  You should have received a copy of the GNU Lesser General Public
  27  *  License along with this library; if not, write to the Free Software
  28  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29  *  MA  02111-1307  USA
  30  *
  31  *
  32  *  Sun Industry Standards Source License Version 1.1
  33  *  =================================================
  34  *  The contents of this file are subject to the Sun Industry Standards
  35  *  Source License Version 1.1 (the "License"); You may not use this file
  36  *  except in compliance with the License. You may obtain a copy of the
  37  *  License at http://www.openoffice.org/license.html.
  38  *
  39  *  Software provided under this License is provided on an "AS IS" basis,
  40  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  41  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43  *  See the License for the specific provisions governing your rights and
  44  *  obligations concerning the Software.
  45  *
  46  *  The Initial Developer of the Original Code is: IBM Corporation
  47  *
  48  *  Copyright: 2008 by IBM Corporation
  49  *
  50  *  All Rights Reserved.
  51  *
  52  *  Contributor(s): _______________________________________
  53  *
  54  *
  55  ************************************************************************/
  56 /*************************************************************************
  57  * @file
  58  *  For LWP filter architecture prototype
  59  ************************************************************************/
  60
  61 #include <lwpfoundry.hxx>
  62 #include <lwpfilehdr.hxx>
  63 #include "lwpdoc.hxx"
  64 #include "lwpmarker.hxx"
  65 #include "lwpholder.hxx"
  66 #include "lwpbulletstylemgr.hxx"
  67 #include "lwpcontent.hxx"
  68 #include "lwpvpointer.hxx"
  69 #include "lwpsection.hxx"
  70 #include "lwpcharacterstyle.hxx"
  71 #include <lwpglobalmgr.hxx>
  72 #include <lwpobjtags.hxx>
  73 #include <xfilter/xfstylemanager.hxx>
  74
  75 #include <osl/diagnose.h>
  76
  77 LwpFoundry::LwpFoundry(LwpObjectStream *pStrm, LwpDocument* pDoc)
  78     : m_pDoc(pDoc)
  79     , m_bRegisteredAll(false)
  80 {
  81     Read(pStrm);
  82     m_xBulletStyleMgr.reset(new LwpBulletStyleMgr);
  83     m_xBulletStyleMgr->SetFoundry(this);
  84 }
  85
  86 LwpFoundry::~LwpFoundry()
  87 {
  88 }
  89
  90 void LwpFoundry::Read(LwpObjectStream *pStrm)
  91 {
  92     if (!m_pDoc->IsChildDoc())
  93     {
  94         LwpVersionManager::Read(pStrm);
  95     }
  96     m_ObjMgr.Read(pStrm);
  97
  98     m_MarkerHead.ReadIndexed(pStrm);
  99     m_FootnoteMgr.ReadIndexed(pStrm);
 100
 101     m_NumMgr.Read(pStrm);
 102     m_BulMgr.Read(pStrm);
 103
 104     m_SectionList.Read(pStrm);
 105     m_Layout.ReadIndexed(pStrm);
 106
 107     ReadStyles(pStrm);
 108
 109     m_BookMarkHead.ReadIndexed(pStrm);
 110     m_DdeLinkHead.ReadIndexed(pStrm);
 111     m_DirtBagHead.ReadIndexed(pStrm);
 112     m_NamedOutlineSeqHead.ReadIndexed(pStrm);
 113
 114     m_EnumLayoutHead.ReadIndexed(pStrm);
 115     m_EnumLayoutTail.ReadIndexed(pStrm);
 116     m_NamedObjects.ReadIndexed(pStrm);
 117
 118     m_nLastClickHere = pStrm->QuickReaduInt32();
 119     m_SmartTextMgr.ReadIndexed(pStrm);
 120
 121     m_ContentMgr.Read(pStrm);
 122     m_FontMgr.Read(pStrm);
 123
 124     if (!m_pDoc->IsChildDoc() && LwpFileHeader::m_nFileRevision >= 0x000B)
 125     {
 126         m_xPieceMgr.reset(new LwpPieceManager);
 127         m_xPieceMgr->Read(pStrm);
 128     }
 129
 130     if( LwpFileHeader::m_nFileRevision >= 0x000B)
 131     {
 132         m_DftDropCapStyle.ReadIndexed(pStrm);
 133     }
 134     if( LwpFileHeader::m_nFileRevision >= 0x000F)
 135     {
 136         m_DftHeaderStyle.ReadIndexed(pStrm);
 137         m_DftFooterStyle.ReadIndexed(pStrm);
 138     }
 139     pStrm->SkipExtra();
 140
 141     m_xStyleMgr.reset(new LwpStyleManager);
 142     m_xStyleMgr->SetFoundry(this);
 143 }
 144
 145 void LwpFoundry::ReadStyles(LwpObjectStream *pStrm)
 146 {
 147     m_TextStyle.ReadIndexed(pStrm);
 148     m_DefaultTextStyle.ReadIndexed(pStrm);
 149     m_DefaultClickStyle.ReadIndexed(pStrm);
 150     m_PageStyle.ReadIndexed(pStrm);
 151     m_FrameStyle.ReadIndexed(pStrm);
 152
 153     m_TableStyle.ReadIndexed(pStrm);
 154     m_CellStyle.ReadIndexed(pStrm);
 155     m_DftFrameStyle.ReadIndexed(pStrm);
 156     m_DftPageStyle.ReadIndexed(pStrm);
 157     m_DftTableStyle.ReadIndexed(pStrm);
 158
 159     m_DftCellStyle.ReadIndexed(pStrm);
 160     m_DftColumnStyle.ReadIndexed(pStrm);
 161     m_DftLeftColumnStyle.ReadIndexed(pStrm);
 162     m_DftRighColumnStyle.ReadIndexed(pStrm);
 163
 164 }
 165
 166 void LwpFoundry::RegisterAllLayouts()
 167 {
 168     if (m_bRegisteredAll)
 169     {
 170         OSL_FAIL("recursive LwpFoundry::RegisterAllLayouts!");
 171         return;
 172     }
 173
 174     m_bRegisteredAll = true;
 175
 176     //Register CellStyle
 177     rtl::Reference<LwpObject> pStyle = m_CellStyle.obj();
 178     if( pStyle.is() )
 179     {
 180         pStyle->SetFoundry(this);
 181         pStyle->DoRegisterStyle();
 182     }
 183
 184     //register content page layout list: Layout
 185     pStyle = m_Layout.obj();
 186     if( pStyle.is() )
 187     {
 188         pStyle->SetFoundry(this);
 189         pStyle->DoRegisterStyle();
 190     }
 191
 192     //Register page style layout list: PageStyle, such as "Default Page"
 193     pStyle = m_PageStyle.obj();
 194     if( pStyle.is() )
 195     {
 196         pStyle->SetFoundry(this);
 197         pStyle->DoRegisterStyle();
 198     }
 199
 200     //Register FrameStyle
 201     pStyle = m_FrameStyle.obj();
 202     if( pStyle.is() )
 203     {
 204         pStyle->SetFoundry(this);
 205         pStyle->DoRegisterStyle();
 206     }
 207
 208 }
 209
 210 LwpBookMark* LwpFoundry::GetBookMark(LwpObjectID objMarker)
 211 {
 212     LwpDLVListHeadHolder* pHeadHolder= dynamic_cast
 213                     <LwpDLVListHeadHolder*>(m_BookMarkHead.obj().get());
 214
 215     if (!pHeadHolder)
 216         return nullptr;
 217
 218     LwpObjectID* pObjID = &pHeadHolder->GetHeadID();
 219     LwpBookMark* pBookMark = dynamic_cast<LwpBookMark*>(pObjID->obj().get());
 220
 221     while (pBookMark)
 222     {
 223         if (pBookMark->IsRightMarker(objMarker))
 224             return pBookMark;
 225         pObjID = &pBookMark->GetNext();
 226         pBookMark = dynamic_cast<LwpBookMark*>(pObjID->obj().get());
 227     }
 228     return nullptr;
 229 }
 230
 231 /**
 232 * @descr:   Get next content
 233 *
 234 */
 235 LwpContent* LwpFoundry::EnumContents(LwpContent * pContent)
 236 {
 237     return GetContentManager().EnumContents(pContent);
 238 }
 239
 240 /**
 241 * @descr:   Get next section
 242 *
 243 */
 244 LwpSection* LwpFoundry::EnumSections(LwpSection * pSection)
 245 {
 246     return static_cast<LwpSection*>(m_SectionList.Enumerate(pSection));
 247 }
 248
 249 /**
 250 * @descr:   Get default text style id
 251 *
 252 */
 253 LwpObjectID * LwpFoundry::GetDefaultTextStyle()
 254 {
 255     LwpVersionedPointer * pPointer = dynamic_cast<LwpVersionedPointer *>(m_DefaultTextStyle.obj().get());
 256     if (!pPointer)
 257         return nullptr;
 258
 259     return &pPointer->GetPointer();
 260 }
 261
 262 /**
 263 * @descr:   Get paragraph style object id according to its style name
 264 *
 265 */
 266 LwpObjectID * LwpFoundry::FindParaStyleByName(std::u16string_view name)
 267 {
 268     LwpDLVListHeadHolder* pParaStyleHolder = dynamic_cast<LwpDLVListHeadHolder*>(GetTextStyleHead().obj().get());
 269     if(pParaStyleHolder)
 270     {
 271         LwpTextStyle* pParaStyle = dynamic_cast<LwpTextStyle*> (pParaStyleHolder->GetHeadID().obj().get());
 272         while(pParaStyle)
 273         {
 274             OUString strName = pParaStyle->GetName().str();
 275             if(strName == name)
 276                 return &pParaStyle->GetObjectID();
 277             pParaStyle = dynamic_cast<LwpTextStyle*>(pParaStyle->GetNext().obj().get());
 278         }
 279     }
 280
 281     return nullptr;
 282 }
 283
 284 /**
 285 * @descr:   Get style name registered according the original style name
 286 *
 287 */
 288 OUString LwpFoundry::FindActualStyleName(const OUString& name)
 289 {
 290     LwpObjectID* pID = FindParaStyleByName(name);
 291     if(pID)
 292     {
 293         IXFStyle* pStyle = GetStyleManager()->GetStyle(*pID);
 294         if(pStyle)
 295         {
 296             return pStyle->GetStyleName();
 297         }
 298     }
 299
 300     return name;
 301 }
 302
 303 void LwpVersionManager::Read(LwpObjectStream *pStrm)
 304 {
 305     // TODO: skip the data for prototype
 306     Skip(pStrm);
 307 }
 308
 309 void LwpVersionManager::Skip(LwpObjectStream *pStrm)
 310 {
 311     pStrm->QuickReaduInt32();
 312     sal_uInt16 Count = pStrm->QuickReaduInt16();
 313
 314     while(Count--)
 315     {
 316         sal_uInt32 tag = pStrm->QuickReaduInt32();
 317         switch(tag)
 318         {
 319             case TAG_USER_VERSION:
 320                 // TODO: skip the CUserVersionControl
 321                 pStrm->SeekRel(pStrm->QuickReaduInt16());
 322                 break;
 323
 324             default:
 325                 pStrm->SeekRel(pStrm->QuickReaduInt16());
 326                 pStrm->SkipExtra();
 327                 break;
 328         }
 329     }
 330     pStrm->SkipExtra();
 331 }
 332
 333 void LwpObjectManager::Read(LwpObjectStream *pStrm)
 334 {
 335
 336     LwpObjectID dummy;
 337     dummy.Read(pStrm);
 338     // TODO: judge if we need to set the cDelta by the dummy id
 339
 340     m_Division.ReadIndexed(pStrm);
 341     pStrm->SkipExtra();
 342 }
 343
 344 void LwpNumberManager::Read(LwpObjectStream *pStrm)
 345 {
 346     m_TableRange.ReadIndexed(pStrm);
 347     pStrm->SkipExtra();
 348 }
 349
 350 void LwpBulletManager::Read(LwpObjectStream *pStrm)
 351 {
 352     m_Head.ReadIndexed(pStrm);
 353     pStrm->SkipExtra();
 354 }
 355
 356 void LwpContentManager::Read(LwpObjectStream *pStrm)
 357 {
 358     m_ContentList.ReadIndexed(pStrm);
 359
 360     // TODO:  to judge the file revision
 361
 362     m_EnumHead.ReadIndexed(pStrm);
 363     m_EnumTail.ReadIndexed(pStrm);
 364
 365     m_OleObjCount.ReadIndexed(pStrm);
 366
 367     if( LwpFileHeader::m_nFileRevision >= 0x000B)
 368     {
 369         m_GrapHead.ReadIndexed(pStrm);
 370         m_GrapTail.ReadIndexed(pStrm);
 371         m_OleHead.ReadIndexed(pStrm);
 372         m_OleTail.ReadIndexed(pStrm);
 373     }
 374
 375     pStrm->SkipExtra();
 376 }
 377
 378 /**
 379 * @descr:   Get next content
 380 *
 381 */
 382 LwpContent* LwpContentManager::EnumContents(LwpContent* pContent)
 383 {
 384     if(pContent)
 385         return pContent->GetNextEnumerated();
 386     LwpVersionedPointer* pPointer = dynamic_cast<LwpVersionedPointer*>(m_EnumHead.obj().get());
 387     return pPointer ? dynamic_cast<LwpContent*>(pPointer->GetPointer().obj().get()) : nullptr;
 388 }
 389
 390 void LwpPieceManager::Read(LwpObjectStream *pStrm)
 391 {
 392     m_GeometryPieceList.ReadIndexed(pStrm);
 393     m_ScalePieceList.ReadIndexed(pStrm);
 394     m_MarginsPieceList.ReadIndexed(pStrm);
 395     m_ColumnsPieceList.ReadIndexed(pStrm);
 396     m_BorderStuffPieceList.ReadIndexed(pStrm);
 397
 398     m_GutterStuffPieceList.ReadIndexed(pStrm);
 399     m_BackgroundStuffPieceList.ReadIndexed(pStrm);
 400     m_JoinStuffPieceList.ReadIndexed(pStrm);
 401     m_ShadowPieceList.ReadIndexed(pStrm);
 402     m_NumericsPieceList.ReadIndexed(pStrm);
 403
 404     m_RelativityPieceList.ReadIndexed(pStrm);
 405     m_AlignmentPieceList.ReadIndexed(pStrm);
 406     m_IndentPieceList.ReadIndexed(pStrm);
 407     m_ParaBorderPieceList.ReadIndexed(pStrm);
 408     m_SpacingPieceList.ReadIndexed(pStrm);
 409
 410     m_BreaksPieceList.ReadIndexed(pStrm);
 411     m_NumberingPieceList.ReadIndexed(pStrm);
 412     m_TabPieceList.ReadIndexed(pStrm);
 413     m_CharacterBorderPieceList.ReadIndexed(pStrm);
 414     m_AmikakePieceList.ReadIndexed(pStrm);
 415
 416     if(pStrm->CheckExtra())
 417     {
 418         m_ParaBackgroundPieceList.ReadIndexed(pStrm);
 419         m_ExternalBorderStuffPieceList.ReadIndexed(pStrm);
 420         m_ExternalJoinStuffPieceList.ReadIndexed(pStrm);
 421         pStrm->SkipExtra();
 422     }
 423 }
 424
 425 void LwpOrderedObjectManager::Read(LwpObjectStream *pStrm)
 426 {
 427     m_Head.ReadIndexed(pStrm);
 428 }
 429
 430 /**
 431 * @descr:   Get next orderedobject, copy from lwp source code
 432 *
 433 */
 434 LwpOrderedObject* LwpOrderedObjectManager::Enumerate(LwpOrderedObject * pLast)
 435 {
 436     // If Last has a next, return it.
 437     if(pLast && !pLast->GetNext().IsNull())
 438         return dynamic_cast<LwpOrderedObject*>(pLast->GetNext().obj().get());
 439
 440     LwpListList* pList = nullptr;
 441     if(pLast)
 442     {
 443         // We're at the end of Last's list (not list's list).
 444         // Start with the next active list
 445         pList = dynamic_cast<LwpListList*>(pLast->GetListList().obj().get());
 446         pList= GetNextActiveListList(pList);
 447     }
 448     else
 449     {
 450         // Start with the first active ListList
 451         pList = GetNextActiveListList(nullptr);
 452     }
 453
 454     if(pList)
 455     {
 456         return dynamic_cast<LwpOrderedObject*>(pList->GetHead().obj().get());
 457     }
 458
 459     return nullptr;
 460 }
 461
 462 /**
 463 * @descr:   Get next listlist object, copy from lwp source code
 464 *
 465 */
 466 LwpListList* LwpOrderedObjectManager::GetNextActiveListList(LwpListList * pLast)
 467 {
 468     LwpListList* pList = nullptr;
 469     if(pLast)
 470         pList = dynamic_cast<LwpListList*>(pLast->GetNext().obj().get());
 471     else
 472     {
 473         LwpDLVListHeadHolder* pHeadHolder= dynamic_cast<LwpDLVListHeadHolder*>(m_Head.obj().get());
 474         if(pHeadHolder)
 475         {
 476             pList = dynamic_cast<LwpListList*>(pHeadHolder->GetHeadID().obj().get());
 477         }
 478     }
 479
 480     while(pList)
 481     {
 482         LwpContent* pContent = dynamic_cast<LwpContent*>(pList->GetObject().obj().get());
 483         if (pContent && pContent->HasNonEmbeddedLayouts() && !pContent->IsStyleContent())
 484             return pList;
 485         pList = dynamic_cast<LwpListList*>(pList->GetNext().obj().get());
 486     }
 487     return nullptr;
 488 }
 489
 490 LwpStyleManager::LwpStyleManager()
 491     : m_pFoundry(nullptr)
 492 {
 493 }
 494
 495 LwpStyleManager::~LwpStyleManager()
 496 {
 497     m_StyleList.clear();
 498 }
 499
 500 /*
 501 VO_PARASTYLE/VO_CHARACTERSTYLE call this method to add its created style to XFStyleManager
 502 1. Add the style to XFStyleManager, and return the <office:styles> style name
 503 2. Add it to LwpParaStyleMap.
 504 Prerequisite: pStyle has been created and all properties has been set to it.
 505 Return the XFStyle* added by XFStyleManager
 506 */
 507 void LwpStyleManager::AddStyle(LwpObjectID styleObjID, std::unique_ptr<IXFStyle> pNewStyle)
 508 {
 509     assert(pNewStyle);
 510     //pStyle may change if same style is found in XFStyleManager
 511     XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 512     auto pStyle = pXFStyleManager->AddStyle(std::move(pNewStyle)).m_pStyle;
 513     m_StyleList.emplace(styleObjID, pStyle);
 514 }
 515
 516 /*
 517 Called by VO_PARA  or other objects to get style name based on the Style object ID
 518 1) Get style from LwpParaStyleMap based on the LwpObjectID of VO_PARASTYLE.
 519 Prerequisite: VO_PARASTYLE/VO_CHARACTERSTYLE should call AddStyle first.
 520 Return empty string if no style found.
 521 */
 522 IXFStyle* LwpStyleManager::GetStyle(const LwpObjectID &styleObjID)
 523 {
 524     LwpStyleMap::const_iterator it =  m_StyleList.find(styleObjID);
 525     if (it != m_StyleList.end()) {
 526         return((*it).second);
 527     }
 528     return nullptr;
 529 }
 530
 531 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */