lotuswordpro/source/filter/lwpfootnote.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 #include "lwpfootnote.hxx"
  58 #include "lwpstory.hxx"
  59 #include "xfilter/xffootnote.hxx"
  60 #include "xfilter/xfendnote.hxx"
  61 #include "xfilter/xffootnoteconfig.hxx"
  62 #include "xfilter/xfendnoteconfig.hxx"
  63 #include "xfilter/xfstylemanager.hxx"
  64 #include "xfilter/xftextspan.hxx"
  65 #include "lwppara.hxx"
  66 #include "lwpdoc.hxx"
  67 #include "lwpfnlayout.hxx"
  68 #include "lwpglobalmgr.hxx"
  69
  70 LwpFribFootnote::LwpFribFootnote(LwpPara* pPara ):LwpFrib(pPara)
  71 {
  72 }
  73
  74 /**
  75  * @descr  read footnote frib information
  76  */
  77 void LwpFribFootnote::Read(LwpObjectStream * pObjStrm, sal_uInt16 /*len*/)
  78 {
  79     m_Footnote.ReadIndexed(pObjStrm);
  80 }
  81
  82 /**
  83  * @descr  Register footnote style by calling LwpFootnote::RegisterStyle()
  84  */
  85 void LwpFribFootnote::RegisterNewStyle()
  86 {
  87     LwpFootnote* pFootnote = GetFootnote();
  88     if(pFootnote)
  89     {
  90         //register footnote number font style
  91         LwpFrib::RegisterStyle(m_pPara->GetFoundry());
  92         //register footnote content style
  93         pFootnote->SetFoundry(m_pPara->GetFoundry());
  94         pFootnote->RegisterStyle();
  95     }
  96 }
  97
  98 /**
  99  * @descr  Parse footnote  by calling LwpFootnote::XFConvert()
 100  */
 101 void LwpFribFootnote::XFConvert(XFContentContainer* pCont)
 102 {
 103     LwpFootnote* pFootnote = GetFootnote();
 104     if(pFootnote)
 105     {
 106         XFContentContainer* pContent = nullptr;
 107         if(pFootnote->GetType() == FN_FOOTNOTE)
 108         {
 109             pContent = new XFFootNote();
 110         }
 111         else
 112         {
 113             pContent = new XFEndNote();
 114         }
 115         pFootnote->XFConvert(pContent);
 116         if(m_ModFlag)
 117         {
 118             //set footnote number font style
 119             XFTextSpan *pSpan = new XFTextSpan();
 120             pSpan->SetStyleName(GetStyleName());
 121             //add the xffootnote into the content container
 122             pSpan->Add(pContent);
 123             pCont->Add(pSpan);
 124         }
 125         else
 126         {
 127             pCont->Add(pContent);
 128         }
 129     }
 130 }
 131
 132 /**
 133  * @descr  Get foonote object
 134  */
 135 LwpFootnote* LwpFribFootnote::GetFootnote()
 136 {
 137     return dynamic_cast<LwpFootnote*>(m_Footnote.obj().get());
 138 }
 139
 140 LwpFootnote::LwpFootnote(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 141     : LwpOrderedObject(objHdr, pStrm)
 142     , m_nType(0)
 143     , m_nRow(0)
 144 {
 145 }
 146
 147 LwpFootnote::~LwpFootnote()
 148 {
 149
 150 }
 151
 152 /**
 153  * @descr  Read foonote object
 154  */
 155 void LwpFootnote::Read()
 156 {
 157     LwpOrderedObject::Read();
 158     m_nType = m_pObjStrm->QuickReaduInt16();
 159     m_nRow = m_pObjStrm->QuickReaduInt16();
 160     m_Content.ReadIndexed(m_pObjStrm.get());
 161     m_pObjStrm->SkipExtra();
 162 }
 163
 164 /**
 165  * @descr  Register footnote style
 166  */
 167 void LwpFootnote::RegisterStyle()
 168 {
 169     //Only register footnote contents style,
 170     //Endnote contents style registers in LwpEnSuperTableLayout::RegisterStyle
 171     if(m_nType == FN_FOOTNOTE)
 172     {
 173         LwpContent* pContent = FindFootnoteContent();
 174         if(pContent)
 175         {
 176             pContent->SetFoundry(m_pFoundry);
 177             pContent->DoRegisterStyle();
 178         }
 179     }
 180 }
 181
 182 /**
 183  * @descr  Parse footnote
 184  */
 185 void LwpFootnote::XFConvert(XFContentContainer * pCont)
 186 {
 187     LwpContent* pContent = FindFootnoteContent();
 188     if(pContent)
 189     {
 190         pContent->DoXFConvert(pCont);
 191     }
 192 }
 193
 194 /**
 195  * @descr  Get endnote cell layout which contains current endnote content
 196  */
 197 LwpCellLayout* LwpFootnote::GetCellLayout()
 198 {
 199     LwpEnSuperTableLayout* pEnSuperLayout = FindFootnoteTableLayout();
 200     if(pEnSuperLayout)
 201     {
 202         LwpTableLayout* pTableLayout = dynamic_cast<LwpTableLayout*>(pEnSuperLayout->GetMainTableLayout());
 203         if(pTableLayout)
 204         {
 205             LwpRowLayout* pRowLayout = pTableLayout->GetRowLayout(m_nRow);
 206             if(pRowLayout)
 207             {
 208                 return dynamic_cast<LwpCellLayout*>(pRowLayout->GetChildHead().obj().get());
 209             }
 210         }
 211     }
 212     return nullptr;
 213 }
 214
 215 /**
 216  * @descr  Get division which footnote table contains current footnote content, copy from lwp source code
 217  */
 218 LwpDocument* LwpFootnote::GetFootnoteTableDivision()
 219 {
 220     if(!m_pFoundry)
 221         return nullptr;
 222
 223     LwpDocument* pPrev =nullptr;
 224     LwpDocument* pDivision = nullptr;
 225     LwpDocument* pFootnoteDivision =nullptr;
 226
 227     // Make sure the footnote does belong to some division
 228     // The division might not have a DivisionInfo if it's being Destruct()ed
 229     pPrev = m_pFoundry->GetDocument();
 230     pFootnoteDivision = pPrev;
 231     if (!pPrev || pPrev->GetDivInfoID().IsNull())
 232         return nullptr;
 233
 234     switch (m_nType)
 235     {
 236         case FN_FOOTNOTE:
 237         {
 238             // Footnotes always use the source division
 239             return pFootnoteDivision;
 240         }
 241         case FN_DIVISION:
 242         {
 243             // Start with the footnote's division
 244             pDivision = pPrev;
 245             break;
 246         }
 247         case FN_DIVISION_SEPARATE:
 248         {
 249             // It had better be the next division
 250             pDivision = pPrev->GetNextDivision();
 251             break;
 252         }
 253         case FN_DIVISIONGROUP:
 254         case FN_DIVISIONGROUP_SEPARATE:
 255         {
 256             pDivision = pPrev->GetLastInGroupWithContents();
 257             break;
 258         }
 259         case FN_DOCUMENT:
 260         case FN_DOCUMENT_SEPARATE:
 261         {
 262             pDivision = pFootnoteDivision->GetRootDocument();
 263             if (pDivision)
 264                 pDivision = pDivision->GetLastDivisionWithContents();
 265             break;
 266         }
 267
 268     }
 269
 270     // Make sure we're using the proper endnote division, if it's separate
 271     if (m_nType & FN_MASK_SEPARATE)
 272         pDivision = GetEndnoteDivision(pDivision);
 273     // Don't use a division that's specifically for endnotes
 274     else
 275     {
 276         while (pDivision)
 277         {
 278             if (pDivision->GetEndnoteType() == FN_DONTCARE)
 279                 break;
 280             if (m_nType == FN_DIVISIONGROUP)
 281                 pDivision = pDivision->GetPreviousInGroup();
 282             else
 283                 pDivision = pDivision->GetPreviousDivisionWithContents();
 284         }
 285     }
 286     if (pDivision)
 287         return pDivision;
 288     return nullptr;
 289 }
 290
 291 /**
 292  * @descr  Get division which endnote table contains current endnote content, copy from lwp source code
 293  */
 294 LwpDocument* LwpFootnote::GetEndnoteDivision(LwpDocument* pPossible)
 295 {
 296     LwpDocument*  pDivision = pPossible;
 297     sal_uInt16 nDivType;
 298
 299     // In case we have multiple endnote divisions, walk backwards until
 300     // we find one.
 301     while (pDivision)
 302     {
 303         // Do we already have the right division?
 304         nDivType = pDivision->GetEndnoteType();
 305         if (nDivType == m_nType)
 306             return pDivision;
 307         // When we hit the first non-endnote division, stop looking.
 308         // -- SDC 10/8/96
 309         if (nDivType == FN_DONTCARE)
 310             break;
 311         pDivision = pDivision->GetPreviousDivision();
 312     }
 313     return nullptr;
 314 }
 315
 316 /**
 317  * @descr  Get footnote table class name
 318  */
 319 OUString LwpFootnote::GetTableClass()
 320 {
 321     OUString strClassName;
 322     switch (GetType() & FN_MASK_BASE)
 323     {
 324         case FN_BASE_FOOTNOTE:
 325         {
 326             strClassName = STR_DivisionFootnote;
 327             break;
 328         }
 329         case FN_BASE_DOCUMENT:
 330         {
 331             strClassName = STR_DocumentEndnote;
 332             break;
 333         }
 334         case FN_BASE_DIVISION:
 335         {
 336             strClassName = STR_DivisionEndnote;
 337             break;
 338         }
 339         case FN_BASE_DIVISIONGROUP:
 340         {
 341             strClassName = STR_DivisionGroupEndnote;
 342             break;
 343         }
 344     }
 345     return strClassName;
 346 }
 347
 348 /**
 349  * @descr  Find footnote tablelayout, copy from lwp source code
 350  */
 351 LwpEnSuperTableLayout* LwpFootnote::FindFootnoteTableLayout()
 352 {
 353     LwpDocument* pDivision = GetFootnoteTableDivision();
 354     if(!pDivision)
 355         return nullptr;
 356
 357     LwpFoundry* pFoundry = pDivision->GetFoundry();
 358     OUString strClassName = GetTableClass();
 359     if(strClassName.isEmpty() )
 360         return nullptr;
 361
 362     LwpContent* pContent = nullptr;
 363
 364     while ((pContent = pFoundry->EnumContents(pContent)) != nullptr)
 365         if (pContent->IsTable() && (strClassName.equals(pContent->GetClassName())) &&
 366             pContent->IsActive() && pContent->GetLayout(nullptr).is())
 367         {
 368             // Found it!
 369             return static_cast<LwpEnSuperTableLayout *>(
 370                 static_cast<LwpTable*>(pContent)->GetSuperTableLayout());
 371         }
 372
 373     return nullptr;
 374 }
 375
 376 /**
 377  * @descr  Find footnote contents
 378  */
 379 LwpContent* LwpFootnote::FindFootnoteContent()
 380 {
 381     LwpContent* pContent = dynamic_cast<LwpContent*>(m_Content.obj().get());
 382     //if the content has layout, the content has footnote contents;
 383     //or looking for the celllayout and return the footnote contents.
 384     if (pContent && pContent->GetLayout(nullptr).is())
 385         return pContent;
 386
 387     LwpCellLayout* pCellLayout = GetCellLayout();
 388     if(pCellLayout)
 389     {
 390         pContent = dynamic_cast<LwpContent*>(pCellLayout->GetContent().obj().get());
 391     }
 392
 393     return pContent;
 394 }
 395
 396 LwpFootnoteTable::LwpFootnoteTable(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 397     : LwpTable(objHdr, pStrm)
 398 {
 399 }
 400
 401 void LwpFootnoteTable::Read()
 402 {
 403     LwpTable::Read();
 404     m_pObjStrm->SkipExtra();
 405 }
 406
 407 /**
 408  * @descr  Read footnote number options information
 409  */
 410 void LwpFootnoteNumberOptions::Read(LwpObjectStream *pObjStrm)
 411 {
 412     m_nFlag = pObjStrm->QuickReaduInt16();
 413     m_nStartingNumber = pObjStrm->QuickReaduInt16();
 414     m_LeadingText.Read(pObjStrm);
 415     m_TrailingText.Read(pObjStrm);
 416     pObjStrm->SkipExtra();
 417 }
 418
 419 /**
 420  * @descr  Read footnote separator options information
 421  */
 422 void LwpFootnoteSeparatorOptions::Read(LwpObjectStream *pObjStrm)
 423 {
 424     m_nFlag = pObjStrm->QuickReaduInt16();
 425     m_nLength = pObjStrm->QuickReaduInt32();
 426     m_nIndent = pObjStrm->QuickReaduInt32();
 427     m_nAbove = pObjStrm->QuickReaduInt32();
 428     m_nBelow = pObjStrm->QuickReaduInt32();
 429     m_BorderStuff.Read(pObjStrm);
 430     pObjStrm->SkipExtra();
 431 }
 432
 433 LwpFootnoteOptions::LwpFootnoteOptions(LwpObjectHeader &objHdr, LwpSvStream *pStrm)
 434     : LwpObject(objHdr, pStrm)
 435     , m_nFlag(0)
 436 {
 437 }
 438
 439 LwpFootnoteOptions::~LwpFootnoteOptions()
 440 {
 441
 442 }
 443
 444 /**
 445  * @descr  Register footnote options object
 446  */
 447 void LwpFootnoteOptions::Read()
 448 {
 449     m_nFlag = m_pObjStrm->QuickReaduInt16();
 450     m_FootnoteNumbering.Read(m_pObjStrm.get());
 451     m_EndnoteDivisionNumbering.Read(m_pObjStrm.get());
 452     m_EndnoteDivisionGroupNumbering.Read(m_pObjStrm.get());
 453     m_EndnoteDocNumbering.Read(m_pObjStrm.get());
 454     m_FootnoteSeparator.Read(m_pObjStrm.get());
 455     m_FootnoteContinuedSeparator.Read(m_pObjStrm.get());
 456     m_ContinuedOnMessage.Read(m_pObjStrm.get());
 457     m_ContinuedFromMessage.Read(m_pObjStrm.get());
 458     m_pObjStrm->SkipExtra();
 459 }
 460
 461 /**
 462  * @descr  Register footnote options style
 463  */
 464 void LwpFootnoteOptions::RegisterStyle()
 465 {
 466     RegisterFootnoteStyle();
 467     RegisterEndnoteStyle();
 468 }
 469
 470 /**
 471  * @descr  Register footnote configuration information
 472  */
 473 void LwpFootnoteOptions::RegisterFootnoteStyle()
 474 {
 475     XFFootnoteConfig* pFootnoteConfig = new XFFootnoteConfig();
 476     pFootnoteConfig->SetStartValue(m_FootnoteNumbering.GetStartingNumber() -1);
 477     pFootnoteConfig->SetNumPrefix(m_FootnoteNumbering.GetLeadingText());
 478     pFootnoteConfig->SetNumSuffix(m_FootnoteNumbering.GetTrailingText());
 479     if(m_FootnoteNumbering.GetReset() == LwpFootnoteNumberOptions::RESET_PAGE)
 480     {
 481         pFootnoteConfig->SetRestartOnPage();
 482     }
 483     if(GetContinuedFrom())
 484     {
 485         pFootnoteConfig->SetMessageFrom(GetContinuedFromMessage());
 486     }
 487     if(GetContinuedOn())
 488     {
 489         pFootnoteConfig->SetMessageOn(GetContinuedOnMessage());
 490     }
 491
 492     pFootnoteConfig->SetMasterPage( m_strMasterPage);
 493     XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 494     pXFStyleManager->SetFootnoteConfig(pFootnoteConfig);
 495
 496 }
 497
 498 /**
 499  * @descr  Register endnote configuration information
 500  */
 501 void LwpFootnoteOptions::RegisterEndnoteStyle()
 502 {
 503     XFEndnoteConfig* pEndnoteConfig = new XFEndnoteConfig();
 504     pEndnoteConfig->SetStartValue(m_EndnoteDocNumbering.GetStartingNumber() -1);
 505     OUString message = m_EndnoteDocNumbering.GetLeadingText();
 506     if(message.isEmpty())
 507     {
 508         message = "[";//default prefix
 509     }
 510     pEndnoteConfig->SetNumPrefix(message);
 511     message = m_EndnoteDocNumbering.GetTrailingText();
 512     if(message.isEmpty())
 513     {
 514         message = "]";//default suffix
 515     }
 516     pEndnoteConfig->SetNumSuffix(message);
 517     if(m_EndnoteDocNumbering.GetReset() == LwpFootnoteNumberOptions::RESET_PAGE)
 518     {
 519         pEndnoteConfig->SetRestartOnPage();
 520     }
 521
 522     pEndnoteConfig->SetMasterPage( m_strMasterPage);
 523
 524     XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 525     pXFStyleManager->SetEndnoteConfig(pEndnoteConfig);
 526 }
 527
 528 /**
 529  * @descr  Get continue on message
 530  */
 531 OUString LwpFootnoteOptions::GetContinuedOnMessage()
 532 {
 533     if(m_ContinuedOnMessage.HasValue())
 534     {
 535         return m_ContinuedOnMessage.str();
 536     }
 537     // else reture defauls message
 538     return OUString(STRID_FOOTCONTINUEDON);
 539 }
 540
 541 /**
 542  * @descr  Get continue from message
 543  */
 544 OUString LwpFootnoteOptions::GetContinuedFromMessage()
 545 {
 546     if(m_ContinuedFromMessage.HasValue())
 547     {
 548         return m_ContinuedFromMessage.str();
 549     }
 550     // else reture defauls message
 551     return OUString(STRID_FOOTCONTINUEDFROM);
 552 }
 553
 554 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */