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