lotuswordpro/source/filter/lwpsilverbullet.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 <memory>
  62 #include <lwpglobalmgr.hxx>
  63 #include "lwpsilverbullet.hxx"
  64 #include "lwpdoc.hxx"
  65 #include "lwpdivinfo.hxx"
  66 #include "lwpfribheader.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 const & objHdr, LwpSvStream* pStrm)
  74     : LwpDLNFVList(objHdr, pStrm)
  75     , m_nFlags(0)
  76     , m_nUseCount(0)
  77 {
  78     memset(m_pHideLevels, 0, sizeof(m_pHideLevels));
  79 }
  80
  81 LwpSilverBullet::~LwpSilverBullet()
  82 {
  83 }
  84
  85 void LwpSilverBullet::Read()
  86 {
  87     LwpDLNFVList::Read();
  88
  89     m_nFlags = m_pObjStrm->QuickReaduInt16();
  90     m_aStory.ReadIndexed(m_pObjStrm.get());
  91
  92     sal_uInt16 nNumPos = m_pObjStrm->QuickReaduInt16();
  93
  94     if (nNumPos > SAL_N_ELEMENTS(m_pResetPositionFlags))
  95         throw std::range_error("corrupt SilverBullet");
  96
  97     for (sal_uInt16 nC = 0; nC < nNumPos; nC++)
  98         m_pResetPositionFlags[nC] = m_pObjStrm->QuickReaduInt8();
  99
 100     if (nNumPos < SAL_N_ELEMENTS(m_pResetPositionFlags))
 101         std::fill(m_pResetPositionFlags + nNumPos, m_pResetPositionFlags + SAL_N_ELEMENTS(m_pResetPositionFlags), 0);
 102
 103     m_nUseCount = m_pObjStrm->QuickReaduInt32();
 104
 105     m_aAtomHolder.Read(m_pObjStrm.get());
 106 }
 107
 108 /**
 109  * @short:   Register bullet or numbering style-list and store the returned
 110  *          name from XFStyleManager.
 111  * @descr:
 112  */
 113 void LwpSilverBullet::RegisterStyle()
 114 {
 115     std::unique_ptr<XFListStyle> xListStyle(new XFListStyle());
 116     XFStyleManager* pXFStyleManager = LwpGlobalMgr::GetInstance()->GetXFStyleManager();
 117
 118     GetBulletPara();
 119
 120     if (IsBulletOrdered() && HasName())
 121     {
 122         //todo: find the flag in the file
 123         bool bCumulative = false;
 124
 125         for (sal_uInt8 nPos = 1; nPos < 10; nPos++)
 126         {
 127             ParaNumbering aParaNumbering;
 128             //get numbering format according to the position.
 129             m_xBulletPara->GetParaNumber(nPos, &aParaNumbering);
 130             LwpFribParaNumber* pParaNumber = aParaNumbering.pParaNumber;
 131             if (pParaNumber)
 132             {
 133                 if (pParaNumber->GetStyleID() != NUMCHAR_other)
 134                 {
 135                     m_pHideLevels[nPos] = aParaNumbering.nNumLevel;
 136                     sal_uInt16 nDisplayLevel = GetDisplayLevel(nPos);
 137                     bCumulative = (nDisplayLevel > 1);
 138                     OUString aPrefix = GetAdditionalName(nPos);
 139
 140                     XFNumFmt aFmt;
 141                     if (!bCumulative && aParaNumbering.pPrefix)
 142                     {
 143                         aFmt.SetPrefix(aPrefix + aParaNumbering.pPrefix->GetText());
 144                     }
 145
 146                     aFmt.SetFormat(GetNumCharByStyleID(pParaNumber));
 147
 148                     if (aParaNumbering.pSuffix)
 149                     {
 150                         aFmt.SetSuffix(aParaNumbering.pSuffix->GetText());
 151                     }
 152
 153                     //set numbering format into the style-list.
 154                     xListStyle->SetListNumber(nPos, aFmt, pParaNumber->GetStart()+1);
 155
 156                     if (bCumulative && nPos > 1)
 157                     {
 158                         xListStyle->SetDisplayLevel(nPos, nDisplayLevel);
 159                     }
 160
 161                 }
 162                 else
 163                 {
 164                     OUString aPrefix, aSuffix;
 165                     if (aParaNumbering.pPrefix)
 166                     {
 167                         aPrefix = aParaNumbering.pPrefix->GetText();
 168                     }
 169                     if (aParaNumbering.pSuffix)
 170                     {
 171                         aSuffix = aParaNumbering.pSuffix->GetText();
 172                     }
 173
 174                     xListStyle->SetListBullet(nPos, GetNumCharByStyleID(pParaNumber),
 175                         "Times New Roman", aPrefix, aSuffix);
 176                 }
 177
 178                 xListStyle->SetListPosition(nPos, 0.0, 0.635, 0.0);
 179                 aParaNumbering.clear();
 180             }
 181         }
 182     }
 183
 184     //add style-list to style manager.
 185     m_strStyleName = pXFStyleManager->AddStyle(std::move(xListStyle)).m_pStyle->GetStyleName();
 186 }
 187
 188 /**
 189  * @short:   Get the font name of the bullet.
 190  * @descr:
 191  * @return:  Font name of the bullet.
 192  */
 193 OUString LwpSilverBullet::GetBulletFontName()
 194 {
 195     //foundry has been set?
 196     if (!m_pFoundry)
 197     {
 198         return OUString();
 199     }
 200
 201     LwpFontManager& rFontMgr = m_pFoundry->GetFontManager();
 202
 203     sal_uInt32 nBulletFontID = m_xBulletPara->GetBulletFontID();
 204     sal_uInt16 nFinalFont = static_cast<sal_uInt16>((nBulletFontID >> 16) & 0xFFFF);
 205
 206     //final fontid is valid?
 207     if (nFinalFont > 255 || nFinalFont == 0)
 208     {
 209         return OUString();
 210     }
 211
 212     //get font name from font manager.
 213     OUString aFontName = rFontMgr.GetNameByID(nBulletFontID);
 214
 215     return aFontName;
 216 }
 217 /**
 218  * @short:   Get bullet character of the bullet vo_para.
 219  * @descr:
 220  * @return:  An UChar32 bullet character.
 221  */
 222 OUString const & LwpSilverBullet::GetBulletChar() const
 223 {
 224     return m_xBulletPara->GetBulletChar();
 225 }
 226
 227 /**
 228  * @short:   Get the LwpPara object through story id.
 229  */
 230 LwpPara* LwpSilverBullet::GetBulletPara()
 231 {
 232     if (!m_xBulletPara.is())
 233     {
 234         LwpStory* pStory = dynamic_cast<LwpStory*>(m_aStory.obj(VO_STORY).get());
 235         if (!pStory)
 236         {
 237             return nullptr;
 238         }
 239
 240         m_xBulletPara.set(dynamic_cast<LwpPara*>(pStory->GetFirstPara().obj(VO_PARA).get()));
 241     }
 242
 243     return m_xBulletPara.get();
 244 }
 245
 246 /**
 247  * @short:   Get numbering character of the bullet vo_para.
 248  * @descr:
 249  * @param:   pParaNumber a pointer to the structure LwpFribParaNumber which
 250  *          includes numbering prefix, format and suffix.
 251  * @return:  An OUString object which store the numbering character.
 252  */
 253 OUString LwpSilverBullet::GetNumCharByStyleID(LwpFribParaNumber const * pParaNumber)
 254 {
 255     if (!pParaNumber)
 256     {
 257         assert(false);
 258         return OUString();
 259     }
 260
 261     OUString strNumChar("1");
 262     sal_uInt16 nStyleID = pParaNumber->GetStyleID();
 263
 264     switch (nStyleID)
 265     {
 266     case NUMCHAR_1:
 267     case NUMCHAR_01:
 268     case NUMCHAR_Chinese4:
 269         strNumChar = "1";
 270         break;
 271     case NUMCHAR_A :
 272         strNumChar = "A";
 273         break;
 274     case NUMCHAR_a:
 275         strNumChar = "a";
 276         break;
 277     case NUMCHAR_I:
 278         strNumChar = "I";
 279         break;
 280     case NUMCHAR_i:
 281         strNumChar = "i";
 282         break;
 283     case NUMCHAR_other:
 284         strNumChar = OUString(sal_Unicode(pParaNumber->GetNumberChar()));
 285         break;
 286     case NUMCHAR_Chinese1:
 287         {
 288         static constexpr OUStringLiteral sBuf = u"\u58f9\u002c\u0020\u8d30, \u53c1, ...";
 289         strNumChar = OUString(sBuf);
 290         }
 291         break;
 292     case NUMCHAR_Chinese2:
 293         {
 294         static constexpr OUStringLiteral sBuf = u"\u4e00, \u4e8c, \u4e09, ...";
 295         strNumChar = OUString(sBuf);
 296         }
 297         break;
 298     case NUMCHAR_Chinese3:
 299         {
 300         static constexpr OUStringLiteral sBuf = u"\u7532, \u4e59, \u4e19, ...";
 301         strNumChar = OUString(sBuf);
 302         }
 303         break;
 304     case NUMCHAR_none:
 305         strNumChar.clear();
 306         break;
 307     default:
 308         break;
 309     }//mod end
 310     return strNumChar;
 311 }
 312
 313 /**
 314  * @short:   To judge the silverbullet list is ordered or not.
 315  * @descr:
 316  * @return:  sal_True if list is ordered, sal_False if list is unordered.
 317  */
 318 bool LwpSilverBullet::IsBulletOrdered()
 319 {
 320     if (!m_xBulletPara.is())
 321         return false;
 322
 323     LwpFribPtr& rFribs = m_xBulletPara->GetFribs();
 324
 325     return (rFribs.HasFrib(FRIB_TAG_PARANUMBER) != nullptr);
 326 }
 327
 328 /**
 329  * @short:   Calculate the displaylevel according to the position and hidelevels.
 330  * @descr:
 331  * @param:   nPos position of the numbering.
 332  * @return:  displaylevel of the position passed in.
 333  */
 334 sal_uInt16 LwpSilverBullet::GetDisplayLevel(sal_uInt8 nPos)
 335 {
 336     if (nPos > 1)
 337     {
 338         sal_uInt16 nHideBit = (1 << nPos);
 339         for (sal_uInt8 nC = nPos-1; nC > 0; nC--)
 340         {
 341             sal_uInt16 nAttrMask = ~m_pHideLevels[nC];
 342             if (!(nAttrMask & nHideBit))
 343             {
 344                 return static_cast<sal_uInt16>(nPos - nC);
 345             }
 346         }
 347     }
 348
 349     return static_cast<sal_uInt16>(nPos);
 350 }
 351
 352 /**
 353  * @descr:   Get the additional information, "Division name" or "Section Name" from document
 354  *      variable frib according to numbering position. Whether we should add a
 355  *      Division/Section name or not is determined by the hidelevels of the frib.
 356  * @param:   nPos position of the numbering.
 357  * @return:  Division or Section name.
 358  */
 359 OUString LwpSilverBullet::GetAdditionalName(sal_uInt8 nPos)
 360 {
 361     OUString aRet;
 362     sal_uInt16 nHideBit = (1 << nPos);
 363     bool bDivisionName = false;
 364     bool bSectionName = false;
 365
 366     LwpFrib* pParaFrib = m_xBulletPara->GetFribs().GetFribs();
 367     if (!pParaFrib)
 368     {
 369         return OUString();
 370     }
 371
 372     while (pParaFrib)
 373     {
 374         if (pParaFrib->GetType() == FRIB_TAG_DOCVAR)
 375         {
 376             ModifierInfo* pMoInfo = pParaFrib->GetModifiers();
 377             if (!pMoInfo)
 378             {
 379                 return OUString();
 380             }
 381             sal_uInt16 nHideLevels = pMoInfo->aTxtAttrOverride.GetHideLevels();
 382             sal_uInt16 nType = static_cast<LwpFribDocVar*>(pParaFrib)->GetType();
 383
 384             if (~nHideLevels & nHideBit)
 385             {
 386                 if (nType == 0x000D)
 387                 {
 388                     bDivisionName = true;
 389                 }
 390                 else if (nType == 0x000E)
 391                 {
 392                     bSectionName= true;
 393                 }
 394             }
 395         }
 396         pParaFrib = pParaFrib->GetNext();
 397     }
 398
 399     if (bDivisionName)
 400     {
 401         aRet += GetDivisionName();
 402     }
 403     if (bSectionName)
 404     {
 405         aRet += GetSectionName();
 406     }
 407
 408     return aRet;
 409 }
 410
 411 OUString LwpSilverBullet::GetDivisionName()
 412 {
 413     OUString aRet;
 414
 415     if (!m_pFoundry)
 416     {
 417         return aRet;
 418     }
 419
 420     LwpDocument* pDoc = m_pFoundry->GetDocument();
 421     if (pDoc)
 422     {
 423         LwpObjectID& rID = pDoc->GetDivInfoID();
 424         if (!rID.IsNull())
 425         {
 426             LwpDivInfo *pInfo = dynamic_cast<LwpDivInfo*>(rID.obj(VO_DIVISIONINFO).get());
 427             if (pInfo)
 428                 aRet = pInfo->GetDivName();
 429         }
 430     }
 431
 432     return aRet;
 433 }
 434
 435 OUString LwpSilverBullet::GetSectionName() const
 436 {
 437     LwpStory* pStory = dynamic_cast<LwpStory*>(m_aStory.obj(VO_STORY).get());
 438     if (!pStory)
 439     {
 440         return OUString();
 441     }
 442
 443     return pStory->GetSectionName();
 444 }
 445
 446 bool LwpSilverBullet::HasName()
 447 {
 448     LwpAtomHolder& rName = GetName();
 449     return (!rName.str().isEmpty());
 450 }
 451 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */