lotuswordpro/source/filter/lwpsilverbullet.cxx

   1 /*************************************************************************
   2  *
   3  *  The Contents of this file are made available subject to the terms of
   4  *  either of the following licenses
   5  *
   6  *         - GNU Lesser General Public License Version 2.1
   7  *         - Sun Industry Standards Source License Version 1.1
   8  *
   9  *  Sun Microsystems Inc., October, 2000
  10  *
  11  *  GNU Lesser General Public License Version 2.1
  12  *  =============================================
  13  *  Copyright 2000 by Sun Microsystems, Inc.
  14  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  15  *
  16  *  This library is free software; you can redistribute it and/or
  17  *  modify it under the terms of the GNU Lesser General Public
  18  *  License version 2.1, as published by the Free Software Foundation.
  19  *
  20  *  This library is distributed in the hope that it will be useful,
  21  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  23  *  Lesser General Public License for more details.
  24  *
  25  *  You should have received a copy of the GNU Lesser General Public
  26  *  License along with this library; if not, write to the Free Software
  27  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  28  *  MA  02111-1307  USA
  29  *
  30  *
  31  *  Sun Industry Standards Source License Version 1.1
  32  *  =================================================
  33  *  The contents of this file are subject to the Sun Industry Standards
  34  *  Source License Version 1.1 (the "License"); You may not use this file
  35  *  except in compliance with the License. You may obtain a copy of the
  36  *  License at http://www.openoffice.org/license.html.
  37  *
  38  *  Software provided under this License is provided on an "AS IS" basis,
  39  *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
  40  *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  41  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  42  *  See the License for the specific provisions governing your rights and
  43  *  obligations concerning the Software.
  44  *
  45  *  The Initial Developer of the Original Code is: IBM Corporation
  46  *
  47  *  Copyright: 2008 by IBM Corporation
  48  *
  49  *  All Rights Reserved.
  50  *
  51  *  Contributor(s): _______________________________________
  52  *
  53  *
  54  ************************************************************************/
  55 /*************************************************************************
  56  * @file
  57  *  For LWP filter architecture prototype
  58  ************************************************************************/
  59 /*************************************************************************
  60  * Change History
  61  Jan 2005                       Created
  62  ************************************************************************/
  63 #include "lwpglobalmgr.hxx"
  64 #include "lwpsilverbullet.hxx"
  65 #include "lwpdoc.hxx"
  66 #include "lwpdivinfo.hxx"
  67 #include "lwpfoundry.hxx"
  68 #include "lwpstory.hxx"
  69 #include "lwppara.hxx"
  70 #include "xfilter/xfliststyle.hxx"
  71 #include "xfilter/xfstylemanager.hxx"
  72
  73 LwpSilverBullet::LwpSilverBullet(LwpObjectHeader& objHdr, LwpSvStream* pStrm)
  74         : LwpDLNFVList(objHdr, pStrm), m_pAtomHolder(new LwpAtomHolder), m_pBulletPara(NULL)
  75 {
  76 }
  77
  78 LwpSilverBullet::~LwpSilverBullet()
  79 {
  80         if (m_pAtomHolder)
  81         {
  82                 delete m_pAtomHolder;
  83         }
  84 }
  85
  86 void LwpSilverBullet::Read()
  87 {
  88         LwpDLNFVList::Read();
  89
  90         m_pObjStrm->QuickRead(&m_nFlags, 2);
  91         m_aStory.ReadIndexed(m_pObjStrm);
  92
  93         sal_uInt16 nNumPos;
  94         m_pObjStrm->QuickRead(&nNumPos, 2);
  95
  96         for (sal_uInt8 nC = 0; nC < nNumPos; nC++)
  97         {
  98                 m_pObjStrm->QuickRead(&m_pResetPositionFlags[nC], 1);
  99         }
 100
 101         m_pObjStrm->QuickRead(&m_nUseCount, 4);
 102
 103         m_pAtomHolder->Read(m_pObjStrm);
 104 }
 105
 106 /**
 107  * @short:   Register bullet or numbering style-list and store the returned
 108  *                      name from XFStyleManager.
 109  * @descr:
 110  */
 111 void LwpSilverBullet::RegisterStyle()
 112 {
 113         XFListStyle* pListStyle = new XFListStyle();
 114         XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 115
 116         this->GetBulletPara();
 117
 118         if (this->IsBulletOrdered() && this->HasName())
 119         {
 120                 ParaNumbering aParaNumbering;
 121                 XFNumFmt aFmt;
 122
 123                 //todo: find the flag in the file
 124                 sal_Bool bCumulative = sal_False;
 125
 126                 //get the numbeing format of level-1
 127                 m_pBulletPara->GetParaNumber(1, &aParaNumbering);
 128                 if (aParaNumbering.pPrefix)
 129                 {
 130                         aFmt.SetPrefix(aParaNumbering.pPrefix->GetText());
 131                 }
 132
 133
 134                 for (sal_uInt8 nPos = 1; nPos < 10; nPos++)
 135                 {
 136                         //get numbering format according to the position.
 137                         m_pBulletPara->GetParaNumber(nPos, &aParaNumbering);
 138                         LwpFribParaNumber* pParaNumber = aParaNumbering.pParaNumber;
 139                         if (pParaNumber)
 140                         {
 141                                 if (pParaNumber->GetStyleID() != NUMCHAR_other)
 142                                 {
 143                                         m_pHideLevels[nPos] = aParaNumbering.nNumLevel;
 144                                         sal_uInt16 nDisplayLevel = this->GetDisplayLevel(nPos);
 145                                         bCumulative = (sal_Bool)(nDisplayLevel > 1);
 146                                         rtl::OUString aPrefix = this->GetAdditionalName(nPos);
 147
 148                                         XFNumFmt aFmt;
 149                                         if (!bCumulative && aParaNumbering.pPrefix)
 150                                         {
 151                                                 aFmt.SetPrefix(aPrefix + aParaNumbering.pPrefix->GetText());
 152                                         }
 153
 154                                         aFmt.SetFormat(this->GetNumCharByStyleID(pParaNumber));
 155
 156                                         if (aParaNumbering.pSuffix)
 157                                         {
 158                                                 aFmt.SetSuffix(aParaNumbering.pSuffix->GetText());
 159                                         }
 160
 161                                         //set numbering format into the style-list.
 162                                         pListStyle->SetListNumber(nPos, aFmt, pParaNumber->GetStart()+1);
 163
 164                                         if (bCumulative && nPos > 1)
 165                                         {
 166                                                 pListStyle->SetDisplayLevel(nPos, nDisplayLevel);
 167                                         }
 168
 169                                 }
 170                                 else
 171                                 {
 172                                         rtl::OUString aPrefix, aSuffix;
 173                                         if (aParaNumbering.pPrefix)
 174                                         {
 175                                                 aPrefix = aParaNumbering.pPrefix->GetText();
 176                                         }
 177                                         if (aParaNumbering.pSuffix)
 178                                         {
 179                                                 aSuffix = aParaNumbering.pSuffix->GetText();
 180                                         }
 181
 182                                         pListStyle->SetListBullet(nPos, this->GetNumCharByStyleID(pParaNumber).toChar(),
 183                                                 rtl::OUString::createFromAscii("Times New Roman"), aPrefix, aSuffix);
 184                                 }
 185
 186                                 pListStyle->SetListPosition(nPos, 0.0, 0.635, 0.0);
 187                                 aParaNumbering.clear();
 188                         }
 189                 }
 190         }
 191         else
 192         {
 193                 //register bullet style-list
 194 /*              for (sal_uInt8 nC = 1; nC < 11; nC++)
 195                 {
 196                         pListStyle->SetListBullet(nC, this->GetBulletChar(), this->GetBulletFontName(),
 197                                 this->GetPrefix(), this->GetSuffix());
 198                         pListStyle->SetListPosition(nC, 0.0, 0.635, 0.0);
 199                 }*/
 200
 201         }
 202
 203         //add style-list to style manager.
 204         m_strStyleName = pXFStyleManager->AddStyle(pListStyle)->GetStyleName();
 205 }
 206
 207 /**
 208  * @short:   Get the font name of the bullet.
 209  * @descr:
 210  * @return:  Font name of the bullet.
 211  */
 212 rtl::OUString LwpSilverBullet::GetBulletFontName()
 213 {
 214         //foundry has been set?
 215         if (!m_pFoundry)
 216         {
 217                 return rtl::OUString::createFromAscii("");
 218         }
 219
 220         LwpFontManager* pFontMgr = m_pFoundry->GetFontManger();
 221         if (!pFontMgr)
 222         {
 223                 return rtl::OUString::createFromAscii("");
 224         }
 225
 226         sal_uInt32 nBulletFontID = m_pBulletPara->GetBulletFontID();
 227         sal_uInt16 nFinalFont = static_cast<sal_uInt16>((nBulletFontID >> 16) & 0xFFFF);
 228
 229         //final fontid is valid?
 230         if (nFinalFont > 255 || nFinalFont == 0)
 231         {
 232                 return rtl::OUString::createFromAscii("");
 233         }
 234
 235         //get font name from font manager.
 236         rtl::OUString aFontName = pFontMgr->GetNameByID(nBulletFontID);
 237
 238         return aFontName;
 239 }
 240 /**
 241  * @short:   Get bullet character of the bullet vo_para.
 242  * @descr:
 243  * @return:  An UChar32 bulle character.
 244  */
 245 UChar32 LwpSilverBullet::GetBulletChar()
 246 {
 247         rtl::OUString aBulletChar = m_pBulletPara->GetBulletChar();
 248
 249         return aBulletChar.toChar();
 250 }
 251
 252 rtl::OUString LwpSilverBullet::GetPrefix()
 253 {
 254         return rtl::OUString::createFromAscii("");
 255 }
 256
 257 rtl::OUString LwpSilverBullet::GetSuffix()
 258 {
 259         return rtl::OUString::createFromAscii("");
 260 }
 261 /**
 262  * @short:   Get the LwpPara object through story id.
 263  */
 264 LwpPara* LwpSilverBullet::GetBulletPara()
 265 {
 266         if (!m_pBulletPara)
 267         {
 268                 LwpStory* pStory = static_cast<LwpStory*>(m_aStory.obj(VO_STORY));
 269                 if (!pStory)
 270                 {
 271                         return NULL;
 272                 }
 273
 274                 m_pBulletPara = static_cast<LwpPara*>(pStory->GetFirstPara()->obj(VO_PARA));
 275         }
 276
 277         return m_pBulletPara;
 278 }
 279
 280 /**
 281  * @short:   Get numbering character of the bullet vo_para.
 282  * @descr:
 283  * @param:   pParaNumber a pionter to the structure LwpFribParaNumber which
 284  *                      includes numbering prefix, format and suffix.
 285  * @return:  An OUString object which store the numbering character.
 286  */
 287 rtl::OUString LwpSilverBullet::GetNumCharByStyleID(LwpFribParaNumber* pParaNumber)
 288 {
 289         if (!pParaNumber)
 290         {
 291                 assert(false);
 292                 return rtl::OUString::createFromAscii("");
 293         }
 294
 295         rtl::OUString strNumChar = rtl::OUString::createFromAscii("1");
 296         sal_uInt16 nStyleID = pParaNumber->GetStyleID();
 297         UChar32 uC = 0x0000;
 298
 299         switch (nStyleID)
 300         {
 301         case NUMCHAR_1:
 302         case NUMCHAR_01:
 303         case NUMCHAR_Chinese4:
 304                 strNumChar =  rtl::OUString::createFromAscii("1");
 305                 break;
 306         case NUMCHAR_A :
 307                 strNumChar =  rtl::OUString::createFromAscii("A");
 308                 break;
 309         case NUMCHAR_a:
 310                 strNumChar = rtl::OUString::createFromAscii("a");
 311                 break;
 312         case NUMCHAR_I:
 313                 strNumChar = rtl::OUString::createFromAscii("I");
 314                 break;
 315         case NUMCHAR_i:
 316                 strNumChar = rtl::OUString::createFromAscii("i");
 317                 break;
 318         case NUMCHAR_other:
 319                 uC = static_cast<UChar32>(pParaNumber->GetNumberChar());
 320                 strNumChar = rtl::OUString(uC);
 321                 break;
 322         case NUMCHAR_Chinese1:
 323                 {
 324                 sal_Unicode sBuf[13] = {0x58f9,0x002c,0x0020,0x8d30,0x002c,0x0020,0x53c1,0x002c,0x0020,0x002e,0x002e,0x002e,0x0};
 325                 strNumChar = rtl::OUString(sBuf);
 326                 }
 327                 break;
 328         case NUMCHAR_Chinese2:
 329                 {
 330                 sal_Unicode sBuf[13] = {0x4e00,0x002c,0x0020,0x4e8c,0x002c,0x0020,0x4e09,0x002c,0x0020,0x002e,0x002e,0x002e,0x0};
 331                 strNumChar = rtl::OUString(sBuf);
 332                 }
 333                 break;
 334         case NUMCHAR_Chinese3:
 335                 {
 336                 sal_Unicode sBuf[13] = {0x7532,0x002c,0x0020,0x4e59,0x002c,0x0020,0x4e19,0x002c,0x0020,0x002e,0x002e,0x002e,0x0};
 337                 strNumChar = rtl::OUString(sBuf);
 338                 }
 339                 break;
 340         case NUMCHAR_none:
 341                 strNumChar = rtl::OUString::createFromAscii("");
 342                 break;
 343         default:
 344                 break;
 345         }//mod end
 346         return strNumChar;
 347 }
 348
 349 /**
 350  * @short:   To judge the silverbullet list is ordered or not.
 351  * @descr:
 352  * @return:  sal_True if list is ordered, sal_False if list is unordered.
 353  */
 354 sal_Bool LwpSilverBullet::IsBulletOrdered()
 355 {
 356         return (sal_Bool)(m_pBulletPara->GetFribs()->HasFrib(FRIB_TAG_PARANUMBER) != NULL);
 357 }
 358
 359 /**
 360  * @short:   Calculate the displaylevel according to the position and hidelevels.
 361  * @descr:
 362  * @param:   nPos position of the numbering.
 363  * @return:  displaylevel of the position passed in.
 364  */
 365 sal_uInt16 LwpSilverBullet::GetDisplayLevel(sal_uInt8 nPos)
 366 {
 367         if (nPos > 1)
 368         {
 369                 sal_uInt16 nHideBit = (1 << nPos);
 370                 for (sal_uInt8 nC = nPos-1; nC > 0; nC--)
 371                 {
 372                         sal_uInt16 nAttrMask = ~m_pHideLevels[nC];
 373                         if (!(nAttrMask & nHideBit))
 374                         {
 375                                 return static_cast<sal_uInt16>(nPos - nC);
 376                         }
 377                 }
 378         }
 379
 380         return static_cast<sal_uInt16>(nPos);
 381 }
 382
 383 /**
 384  * @descr:   Get the additional information, "Division name" or "Section Name" from document
 385  *              variable frib according to numbering position. Whether we should add a
 386  *              Division/Section name or not is determined by the hidelevels of the frib.
 387  * @param:   nPos position of the numbering.
 388  * @return:  Division or Section name.
 389  */
 390 rtl::OUString LwpSilverBullet::GetAdditionalName(sal_uInt8 nPos)
 391 {
 392         rtl::OUString aRet = rtl::OUString::createFromAscii("");
 393         sal_uInt16 nHideBit = (1 << nPos);
 394         sal_Bool bDivisionName = sal_False;
 395         sal_Bool bSectionName = sal_False;
 396
 397         LwpFrib* pParaFrib = m_pBulletPara->GetFribs()->GetFribs();
 398         if (!pParaFrib)
 399         {
 400                 return rtl::OUString::createFromAscii("");
 401         }
 402
 403         while (pParaFrib)
 404         {
 405                 if (pParaFrib->GetType() == FRIB_TAG_DOCVAR)
 406                 {
 407                         ModifierInfo* pMoInfo = pParaFrib->GetModifiers();
 408                         if (!pMoInfo)
 409                         {
 410                                 return rtl::OUString::createFromAscii("");
 411                         }
 412                         sal_uInt16 nHideLevels = pMoInfo->aTxtAttrOverride.GetHideLevels();
 413                         sal_uInt16 nType = static_cast<LwpFribDocVar*>(pParaFrib)->GetType();
 414
 415                         if (~nHideLevels & nHideBit)
 416                         {
 417                                 if (nType == 0x000D)
 418                                 {
 419                                         bDivisionName = sal_True;
 420                                 }
 421                                 else if (nType == 0x000E)
 422                                 {
 423                                         bSectionName= sal_True;
 424                                 }
 425                         }
 426                 }
 427                 pParaFrib = pParaFrib->GetNext();
 428         }
 429
 430         if (bDivisionName)
 431         {
 432                 aRet += this->GetDivisionName();
 433         }
 434         if (bSectionName)
 435         {
 436                 aRet += this->GetSectionName();
 437         }
 438
 439         return aRet;
 440 }
 441
 442 rtl::OUString LwpSilverBullet::GetDivisionName()
 443 {
 444         if (!m_pFoundry)
 445         {
 446                 return rtl::OUString::createFromAscii("");
 447         }
 448
 449         rtl::OUString aRet = rtl::OUString::createFromAscii("");
 450
 451         LwpDocument* pDoc = m_pFoundry->GetDocument();
 452         if (pDoc)
 453         {
 454                 LwpObjectID* pID = pDoc->GetDivInfoID();
 455                 if (!pID->IsNull())
 456                 {
 457                         aRet = static_cast<LwpDivInfo*>(pID->obj(VO_DIVISIONINFO))->GetDivName();
 458                 }
 459         }
 460
 461         return aRet;
 462 }
 463
 464 rtl::OUString LwpSilverBullet::GetSectionName()
 465 {
 466         LwpStory* pStory = static_cast<LwpStory*>(m_aStory.obj(VO_STORY));
 467         if (!pStory)
 468         {
 469                 return rtl::OUString::createFromAscii("");
 470         }
 471
 472         return pStory->GetSectionName();
 473 }
 474
 475 sal_Bool LwpSilverBullet::HasName()
 476 {
 477         LwpAtomHolder* pName = this->GetName();
 478         if (pName)
 479         {
 480                 return (sal_Bool)(pName->str().getLength() != 0);
 481         }
 482         else
 483         {
 484                 return sal_False;
 485         }
 486 }