lotuswordpro/source/filter/lwptoc.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 - TOC related object
  59  */
  60
  61 #include "lwptoc.hxx"
  62 #include "lwpfoundry.hxx"
  63 #include "lwpdoc.hxx"
  64 #include "lwpframelayout.hxx"
  65 #include "lwpglobalmgr.hxx"
  66
  67 #include "xfilter/xffont.hxx"
  68 #include "xfilter/xftextstyle.hxx"
  69 #include "xfilter/xfstylemanager.hxx"
  70 #include "xfilter/xfparagraph.hxx"
  71 #include "xfilter/xfparastyle.hxx"
  72 #include "xfilter/xfindex.hxx"
  73 #include "xfilter/xffloatframe.hxx"
  74 #include "xfilter/xfframestyle.hxx"
  75 #include "xfilter/xfframe.hxx"
  76 #include "xfilter/xftable.hxx"
  77
  78 LwpTocSuperLayout::LwpTocSuperLayout(LwpObjectHeader &objHdr, LwpSvStream* pStrm)
  79     : LwpSuperTableLayout(objHdr, pStrm)
  80     , m_nFrom(0)
  81     , m_pCont(nullptr)
  82 {
  83 }
  84
  85 LwpTocSuperLayout::~LwpTocSuperLayout()
  86 {
  87 }
  88
  89 /**
  90  * @short   Read TOCSUPERTABLELAYOUT object
  91  * @return  none
  92  */
  93 void LwpTocSuperLayout::Read()
  94 {
  95     LwpSuperTableLayout::Read();
  96     m_TextMarker.Read(m_pObjStrm);
  97     m_ParentName.Read(m_pObjStrm);
  98     m_DivisionName.Read(m_pObjStrm);
  99     m_SectionName.Read(m_pObjStrm);
 100     m_nFrom = m_pObjStrm->QuickReaduInt16();
 101
 102     m_SearchItems.Read(m_pObjStrm);
 103
 104     sal_uInt16 count = m_pObjStrm->QuickReaduInt16();
 105     if (count > MAX_LEVELS)
 106         throw std::range_error("corrupt LwpTocSuperLayout");
 107     for (sal_uInt16 i = 0; i < count; ++i)
 108         m_DestName[i].Read(m_pObjStrm);
 109
 110     count = m_pObjStrm->QuickReaduInt16();
 111     if (count > MAX_LEVELS)
 112         throw std::range_error("corrupt LwpTocSuperLayout");
 113     for (sal_uInt16 i = 0; i < count; ++i)
 114         m_DestPGName[i].Read(m_pObjStrm);
 115
 116     count = m_pObjStrm->QuickReaduInt16();
 117     if (count > MAX_LEVELS)
 118         throw std::range_error("corrupt LwpTocSuperLayout");
 119     for (sal_uInt16 i = 0; i < count; ++i)
 120         m_nFlags[i] = m_pObjStrm->QuickReaduInt32();
 121
 122     m_pObjStrm->SkipExtra();
 123 }
 124 /**
 125  * @short   Register style of TOC
 126  * @return  none
 127  */
 128 void LwpTocSuperLayout::RegisterStyle()
 129 {
 130     LwpSuperTableLayout::RegisterStyle();
 131
 132     // Get font info of default text style and set into tab style
 133     const LwpObjectID *pDefaultTextStyle = m_pFoundry ? m_pFoundry->GetDefaultTextStyle() : nullptr;
 134     XFParaStyle* pBaseStyle = pDefaultTextStyle ? dynamic_cast<XFParaStyle*>(m_pFoundry->GetStyleManager()->GetStyle(*pDefaultTextStyle)) : nullptr;
 135     XFTextStyle*pTextStyle = new XFTextStyle;
 136     if (pBaseStyle)
 137         pTextStyle->SetFont(pBaseStyle->GetFont()); // who delete this font?????
 138     XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 139     m_TabStyleName = pXFStyleManager->AddStyle(pTextStyle).m_pStyle->GetStyleName();
 140
 141 }
 142 /**
 143  * @short   Convert TOC
 144  * @param  pCont - container
 145  * @return none
 146  */
 147 void  LwpTocSuperLayout::XFConvert(XFContentContainer* pCont)
 148 {
 149     XFIndex* pToc = new XFIndex();
 150
 151     pToc->SetProtected(false);
 152     pToc->SetIndexType(enumXFIndexTOC);
 153
 154     // add TOC template
 155     for (sal_uInt16 i = 1; i<= MAX_LEVELS; i++)
 156     {
 157         LwpTocLevelData * pLevel = GetSearchLevelPtr(i);
 158         XFIndexTemplate * pTemplate = new XFIndexTemplate();
 159
 160         if(!pLevel)
 161         {
 162             // add an blank template so that SODC won't add default style to this level
 163             pToc->AddTemplate(OUString::number(i),  OUString(), pTemplate);
 164             continue;
 165         }
 166
 167         bool bInserted = false;
 168         do
 169         {
 170             // One level has 1 template
 171             if (!bInserted)
 172             {
 173                 pTemplate->SetLevel(OUString::number(i));
 174                 if(pLevel->GetUseLeadingText())
 175                 {
 176                     pTemplate->AddEntry(enumXFIndexTemplateChapter, pLevel->GetSearchStyle());
 177                 }
 178                 if(pLevel->GetUseText())
 179                 {
 180                     pTemplate->AddEntry(enumXFIndexTemplateText, pLevel->GetSearchStyle());
 181                 }
 182                 if(GetUsePageNumber(i))
 183                 {
 184                     sal_uInt16 nLeaderType = GetSeparatorType(i);
 185                     if (GetRightAlignPageNumber(i))
 186                     {
 187                         char cSep = ' ';
 188                         switch(nLeaderType)
 189                         {
 190                         default: // go through
 191                         case NONE: // no leaders
 192                             cSep = ' ';
 193                             break;
 194                         case LEADERDOTS:
 195                             cSep = '.';
 196                             break;
 197                         case LEADERDASHES:
 198                             cSep = '-';
 199                             break;
 200                         case LEADERUNDERLINE:
 201                             cSep = '_';
 202                             break;
 203                         }
 204
 205                         pTemplate->AddTabEntry(enumXFTabRight, 0, cSep, 'd', m_TabStyleName);
 206                     }
 207                     else
 208                     {
 209                         OUString sSep;
 210                         switch(nLeaderType)
 211                         {
 212                         default: // go through
 213                         case NONE: // no leaders
 214                             sSep = "  ";
 215                             break;
 216                         case SEPARATORCOMMA:
 217                             sSep = ", ";
 218                             break;
 219                         case SEPARATORDOTS:
 220                             sSep = "...";
 221                             break;
 222                         }
 223                         pTemplate->AddTextEntry(sSep, m_TabStyleName);
 224                     }
 225                     //"TOC Page Number Text Style" style always exists in Word Pro file
 226                     pTemplate->AddEntry(enumXFIndexTemplatePage, "TOC Page Number Text Style");
 227                 }
 228
 229                 pToc->AddTemplate(OUString::number((sal_Int32)i),  m_pFoundry->FindActuralStyleName(pLevel->GetSearchStyle()), pTemplate);
 230                 bInserted = true;
 231             }
 232
 233             // 1 style in WordPro may be mapped to several styles in SODC
 234             LwpDocument * pDocument = m_pFoundry->GetDocument()->GetRootDocument();
 235             AddSourceStyle(pToc, pLevel,  pDocument->GetFoundry());
 236
 237             // one level may have several corresponding Styles
 238             pLevel = GetNextSearchLevelPtr(i, pLevel);  // find next LwpTocLevelData which is same index
 239         }while (pLevel != nullptr);
 240     }
 241
 242     m_pCont = pCont;
 243     // add TOC content
 244     LwpSuperTableLayout::XFConvert(pToc);
 245
 246     rtl::Reference<LwpVirtualLayout> xContainer(GetContainerLayout());
 247     if (!xContainer.is())
 248         return;
 249
 250     // if current TOC is located in a cell, we must add a frame between upper level container and TOC
 251     if (!xContainer->IsCell())
 252     {
 253         pCont->Add(pToc);
 254     }
 255 }
 256
 257 /**
 258  * @short   convert frame which anchor to page
 259  * @param pCont -
 260  * @return
 261  */
 262 void  LwpTocSuperLayout::XFConvertFrame(XFContentContainer* pCont, sal_Int32 nStart, sal_Int32 nEnd, bool bAll)
 263 {
 264     if(m_pFrame)
 265     {
 266         XFFrame* pXFFrame = nullptr;
 267         if(nEnd < nStart)
 268         {
 269             pXFFrame = new XFFrame();
 270         }
 271         else
 272         {
 273             pXFFrame = new XFFloatFrame(nStart, nEnd, bAll);
 274         }
 275
 276         m_pFrame->Parse(pXFFrame, static_cast<sal_uInt16>(nStart));
 277
 278         //parse table, and add table to frame or TOC
 279         LwpTableLayout * pTableLayout = GetTableLayout();
 280         if (pTableLayout)
 281         {
 282             XFContentContainer * pTableContainer = pXFFrame;
 283             // if *this is a TOCSuperTableLayout and it's located in a cell
 284             // add the frame to upper level and add TOCSuperTableLayout into the frame
 285             rtl::Reference<LwpVirtualLayout> xContainer(GetContainerLayout());
 286             if (!xContainer.is())
 287                 return;
 288             if (xContainer->IsCell())
 289             {
 290                 pTableContainer = pCont; // TOC contain table directly
 291                 pXFFrame->Add(pCont);
 292                 m_pCont->Add(pXFFrame);
 293             }
 294             else
 295             {
 296                 //add frame to the container
 297                 pCont->Add(pXFFrame);
 298             }
 299             pTableLayout->XFConvert(pTableContainer);
 300         }
 301     }
 302
 303 }
 304
 305 /**
 306  * @short   Add source style into TOC
 307  * @param  pToc - TOC pointer
 308  * @param  pLevel - TOC level data
 309  * @param  pFoundry - foundry pointer
 310  * @return sal_Bool
 311  */
 312 void LwpTocSuperLayout::AddSourceStyle(XFIndex* pToc, LwpTocLevelData * pLevel, LwpFoundry * pFoundry)
 313 {
 314     if (!pLevel)
 315     {
 316         return;
 317     }
 318
 319     OUString sLwpStyleName = pLevel->GetSearchStyle();
 320
 321     if (pFoundry)
 322     {
 323         LwpDocument * pDoc = pFoundry->GetDocument();
 324         if (pDoc && pDoc->IsChildDoc())
 325         {
 326             OUString sSodcStyleName = pFoundry->FindActuralStyleName(sLwpStyleName);
 327             pToc->AddTocSource(pLevel->GetLevel(), sSodcStyleName);
 328         }
 329         else
 330         {
 331             pDoc = pDoc->GetFirstDivision();
 332             while (pDoc)
 333             {
 334                 AddSourceStyle(pToc, pLevel, pDoc->GetFoundry() );
 335                 pDoc = pDoc->GetNextDivision();
 336             }
 337         }
 338     }
 339 }
 340
 341 /**
 342  * @short   Get whether page number is right alignment
 343  * @param  index - TOC level
 344  * @return sal_Bool
 345  */
 346 bool LwpTocSuperLayout::GetRightAlignPageNumber(sal_uInt16 index)
 347 {
 348     if (index < MAX_LEVELS)
 349         return (m_nFlags[index] & TS_RIGHTALIGN) != 0;
 350     return false;
 351 }
 352 /**
 353  * @short   Get whether page number is used in TOC entries
 354  * @param  index - TOC level
 355  * @return sal_Bool
 356  */
 357 bool LwpTocSuperLayout::GetUsePageNumber(sal_uInt16 index)
 358 {
 359     if (index < MAX_LEVELS)
 360         return (m_nFlags[index] & TS_PAGENUMBER) != 0;
 361     return false;
 362 }
 363 /**
 364  * @short   Get what is used for separater
 365  * @param  index - TOC level
 366  * @return sal_uInt16 - separator type
 367  */
 368 sal_uInt16 LwpTocSuperLayout::GetSeparatorType(sal_uInt16 index)
 369 {
 370     if (index >= MAX_LEVELS)
 371         return NONE;
 372
 373     sal_uInt16 Flag = (sal_uInt16)m_nFlags[index];
 374
 375     if (Flag & TS_LEADERDOTS)
 376         return LEADERDOTS;
 377     else if (Flag & TS_LEADERDASHES)
 378         return LEADERDASHES;
 379     else if (Flag & TS_LEADERUNDERLINE)
 380         return LEADERUNDERLINE;
 381     else if (Flag & TS_SEPARATORCOMMA)
 382         return SEPARATORCOMMA;
 383     else if (Flag & TS_SEPARATORDOTS)
 384         return SEPARATORDOTS;
 385     else
 386         return NONE;
 387 }
 388
 389 /**
 390  * @short   Get TOCLEVELDATA obj
 391  * @param  index - TOC level
 392  * @return LwpTocLevelData * - pointer to TOCLEVELDATA obj
 393  */
 394 LwpTocLevelData * LwpTocSuperLayout::GetSearchLevelPtr(sal_uInt16 index)
 395 {
 396     LwpObjectID& rID = m_SearchItems.GetHead();
 397     LwpTocLevelData * pObj = dynamic_cast<LwpTocLevelData *>(rID.obj().get());
 398
 399     while(pObj)
 400     {
 401         if(pObj->GetLevel()== index)
 402         {
 403             return pObj;
 404         }
 405
 406         rID = pObj->GetNext();
 407         pObj = dynamic_cast<LwpTocLevelData *>(rID.obj().get());
 408     }
 409
 410     return nullptr;
 411 }
 412 /**
 413  * @short   Get next TOCLEVELDATA obj from current position
 414  * @param  index - TOC level
 415  * @param  pCurData - current LwpTocLevelData
 416  * @return LwpTocLevelData * - pointer to TOCLEVELDATA obj
 417  */
 418 LwpTocLevelData * LwpTocSuperLayout::GetNextSearchLevelPtr(sal_uInt16 index, LwpTocLevelData * pCurData)
 419 {
 420     LwpObjectID& rID = pCurData->GetNext();
 421     LwpTocLevelData * pObj = dynamic_cast<LwpTocLevelData *>(rID.obj().get());
 422
 423     while(pObj)
 424     {
 425         if(pObj->GetLevel()== index)
 426         {
 427             return pObj;
 428         }
 429
 430         rID = pObj->GetNext();
 431         pObj = dynamic_cast<LwpTocLevelData *>(rID.obj().get());
 432     }
 433
 434     return nullptr;
 435 }
 436
 437 LwpTocLevelData::LwpTocLevelData(LwpObjectHeader &objHdr, LwpSvStream* pStrm):LwpDLVList(objHdr, pStrm)
 438 {
 439     m_nFlags = 0;
 440     m_nLevel = 0;
 441 }
 442 LwpTocLevelData::~LwpTocLevelData()
 443 {
 444 }
 445 /**
 446  * @short   Register style
 447  * @param
 448  * @return
 449  */
 450 void LwpTocLevelData::RegisterStyle()
 451 {
 452 }
 453 /**
 454  * @short   Convert
 455  * @param  pCont - container
 456  * @return none
 457  */
 458 void LwpTocLevelData::XFConvert(XFContentContainer* /*pCont*/)
 459 {
 460 }
 461 /**
 462  * @short   Read TOCLEVELDATA obj
 463  * @param
 464  * @return
 465  */
 466 void LwpTocLevelData::Read()
 467 {
 468     LwpDLVList::Read();
 469     m_nFlags = m_pObjStrm->QuickReaduInt16();
 470     m_nLevel = m_pObjStrm->QuickReaduInt16();
 471     m_SearchName.Read(m_pObjStrm);
 472
 473     m_pObjStrm->SkipExtra();
 474 }
 475
 476 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */