xmloff/source/text/XMLTextListBlockContext.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <com/sun/star/container/XIndexReplace.hpp>
  21 #include <com/sun/star/style/XStyle.hpp>
  22 #include <com/sun/star/beans/XPropertySet.hpp>
  23 #include <xmloff/xmlimp.hxx>
  24 #include <xmloff/namespacemap.hxx>
  25 #include <xmloff/xmlnamespace.hxx>
  26 #include <xmloff/xmltoken.hxx>
  27 #include "XMLTextListItemContext.hxx"
  28 #include "XMLTextListBlockContext.hxx"
  29 #include <txtlists.hxx>
  30 #include <sal/log.hxx>
  31
  32
  33 using namespace ::com::sun::star;
  34 using namespace ::com::sun::star::uno;
  35 using namespace ::com::sun::star::container;
  36 using namespace ::com::sun::star::style;
  37 using namespace ::com::sun::star::beans;
  38 using namespace ::xmloff::token;
  39
  40
  41 // OD 2008-05-07 #refactorlists#
  42 // add optional parameter <bRestartNumberingAtSubList> and its handling
  43 XMLTextListBlockContext::XMLTextListBlockContext(
  44         SvXMLImport& rImport,
  45         XMLTextImportHelper& rTxtImp,
  46         const Reference< xml::sax::XFastAttributeList > & xAttrList,
  47         const bool bRestartNumberingAtSubList )
  48 :   SvXMLImportContext( rImport )
  49 ,   mrTxtImport( rTxtImp )
  50 ,   mnLevel( 0 )
  51 ,   mbRestartNumbering( false )
  52 ,   mbSetDefaults( false )
  53 {
  54     static constexpr OUStringLiteral s_PropNameDefaultListId = u"DefaultListId";
  55     {
  56         // get the parent list block context (if any); this is a bit ugly...
  57         XMLTextListBlockContext * pLB(nullptr);
  58         XMLTextListItemContext  * pLI(nullptr);
  59         XMLNumberedParaContext  * pNP(nullptr);
  60         rTxtImp.GetTextListHelper().ListContextTop(pLB, pLI, pNP);
  61         mxParentListBlock = pLB;
  62     }
  63     // Inherit style name from parent list, as well as the flags whether
  64     // numbering must be restarted and formats have to be created.
  65     OUString sParentListStyleName;
  66     if( mxParentListBlock.is() )
  67     {
  68         XMLTextListBlockContext *pParent = mxParentListBlock.get();
  69         msListStyleName = pParent->msListStyleName;
  70         sParentListStyleName = msListStyleName;
  71         mxNumRules = pParent->GetNumRules();
  72         mnLevel = pParent->GetLevel() + 1;
  73         mbRestartNumbering = pParent->IsRestartNumbering() ||
  74                              bRestartNumberingAtSubList;
  75         mbSetDefaults = pParent->mbSetDefaults;
  76         msListId = pParent->GetListId();
  77         msContinueListId = pParent->GetContinueListId();
  78     }
  79
  80     bool bIsContinueNumberingAttributePresent( false );
  81     for( auto& aIter : sax_fastparser::castToFastAttributeList(xAttrList) )
  82     {
  83         switch( aIter.getToken() )
  84         {
  85         case XML_ELEMENT(XML, XML_ID):
  86 //FIXME: there is no UNO API for lists
  87             // xml:id is also the list ID (#i92221#)
  88             if ( mnLevel == 0 ) // root <list> element
  89             {
  90                 msListId = aIter.toString();
  91             }
  92             break;
  93         case XML_ELEMENT(TEXT, XML_CONTINUE_NUMBERING):
  94             mbRestartNumbering = !IsXMLToken(aIter, XML_TRUE);
  95             bIsContinueNumberingAttributePresent = true;
  96             break;
  97         case XML_ELEMENT(TEXT, XML_STYLE_NAME):
  98             msListStyleName = aIter.toString();
  99             break;
 100         case XML_ELEMENT(TEXT, XML_CONTINUE_LIST):
 101             if ( mnLevel == 0 ) // root <list> element
 102             {
 103                 msContinueListId = aIter.toString();
 104             }
 105             break;
 106         default:
 107             XMLOFF_WARN_UNKNOWN("xmloff", aIter);
 108         }
 109     }
 110
 111     // Remember this list block.
 112     mrTxtImport.GetTextListHelper().PushListContext( this );
 113
 114     mxNumRules = XMLTextListsHelper::MakeNumRule(GetImport(), mxNumRules,
 115         sParentListStyleName, msListStyleName,
 116         mnLevel, &mbRestartNumbering, &mbSetDefaults );
 117     if( !mxNumRules.is() )
 118         return;
 119
 120     if ( mnLevel != 0 ) // root <list> element
 121         return;
 122
 123     XMLTextListsHelper& rTextListsHelper( mrTxtImport.GetTextListHelper() );
 124     // Inconsistent behavior regarding lists (#i92811#)
 125     OUString sListStyleDefaultListId;
 126     {
 127         uno::Reference< beans::XPropertySet > xNumRuleProps( mxNumRules, UNO_QUERY );
 128         if ( xNumRuleProps.is() )
 129         {
 130             uno::Reference< beans::XPropertySetInfo > xNumRulePropSetInfo(
 131                                         xNumRuleProps->getPropertySetInfo());
 132             if (xNumRulePropSetInfo.is() &&
 133                 xNumRulePropSetInfo->hasPropertyByName(
 134                      s_PropNameDefaultListId))
 135             {
 136                 xNumRuleProps->getPropertyValue(s_PropNameDefaultListId)
 137                     >>= sListStyleDefaultListId;
 138                 SAL_WARN_IF( sListStyleDefaultListId.isEmpty(), "xmloff",
 139                             "no default list id found at numbering rules instance. Serious defect." );
 140             }
 141         }
 142     }
 143     if ( msListId.isEmpty() )  // no text:id property found
 144     {
 145         sal_Int32 nUPD( 0 );
 146         sal_Int32 nBuild( 0 );
 147         const bool bBuildIdFound = GetImport().getBuildIds( nUPD, nBuild );
 148         if ( rImport.IsTextDocInOOoFileFormat() ||
 149              ( bBuildIdFound && nUPD == 680 ) )
 150         {
 151             /* handling former documents written by OpenOffice.org:
 152                use default list id of numbering rules instance, if existing
 153                (#i92811#)
 154             */
 155             if ( !sListStyleDefaultListId.isEmpty() )
 156             {
 157                 msListId = sListStyleDefaultListId;
 158                 if ( !bIsContinueNumberingAttributePresent &&
 159                      !mbRestartNumbering &&
 160                      rTextListsHelper.IsListProcessed( msListId ) )
 161                 {
 162                     mbRestartNumbering = true;
 163                 }
 164             }
 165         }
 166         if ( msListId.isEmpty() )
 167         {
 168             // generate a new list id for the list
 169             msListId = rTextListsHelper.GenerateNewListId();
 170         }
 171     }
 172
 173     if ( bIsContinueNumberingAttributePresent && !mbRestartNumbering &&
 174          msContinueListId.isEmpty() )
 175     {
 176         const OUString& Last( rTextListsHelper.GetLastProcessedListId() );
 177         if ( rTextListsHelper.GetListStyleOfLastProcessedList() == msListStyleName
 178              && Last != msListId )
 179         {
 180             msContinueListId = Last;
 181         }
 182     }
 183
 184     bool bContinueNumbering = bIsContinueNumberingAttributePresent && !mbRestartNumbering;
 185     if (msContinueListId.isEmpty() && bContinueNumbering && GetImport().IsMSO())
 186     {
 187         // No "continue list" id, but continue numbering was requested. Connect to the last list of
 188         // the same list style in the Word case, even if there was a different list in the meantime.
 189         msContinueListId = rTextListsHelper.GetLastIdOfStyleName(msListStyleName);
 190     }
 191
 192     if ( !msContinueListId.isEmpty() )
 193     {
 194         if ( !rTextListsHelper.IsListProcessed( msContinueListId ) )
 195         {
 196             msContinueListId.clear();
 197         }
 198         else
 199         {
 200             // search continue list chain for master list and
 201             // continue the master list.
 202             OUString sTmpStr =
 203                 rTextListsHelper.GetContinueListIdOfProcessedList( msContinueListId );
 204             while ( !sTmpStr.isEmpty() )
 205             {
 206                 msContinueListId = sTmpStr;
 207
 208                 sTmpStr =
 209                     rTextListsHelper.GetContinueListIdOfProcessedList( msContinueListId );
 210             }
 211         }
 212     }
 213
 214     if ( !rTextListsHelper.IsListProcessed( msListId ) )
 215     {
 216         // Inconsistent behavior regarding lists (#i92811#)
 217         rTextListsHelper.KeepListAsProcessed(
 218             msListId, msListStyleName, msContinueListId,
 219             sListStyleDefaultListId );
 220     }
 221 }
 222
 223 XMLTextListBlockContext::~XMLTextListBlockContext()
 224 {
 225 }
 226
 227 void XMLTextListBlockContext::endFastElement(sal_Int32 )
 228 {
 229     // Numbering has not to be restarted if it has been restarted within
 230     // a child list.
 231     XMLTextListBlockContext *pParent = mxParentListBlock.get();
 232     if( pParent )
 233     {
 234         pParent->mbRestartNumbering = mbRestartNumbering;
 235     }
 236
 237     // Restore current list block.
 238     mrTxtImport.GetTextListHelper().PopListContext();
 239
 240     // Any paragraph following the list within the same list item must not
 241     // be numbered.
 242     mrTxtImport.GetTextListHelper().SetListItem( nullptr );
 243 }
 244
 245 css::uno::Reference< css::xml::sax::XFastContextHandler > XMLTextListBlockContext::createFastChildContext(
 246     sal_Int32 nElement,
 247     const css::uno::Reference< css::xml::sax::XFastAttributeList >& xAttrList )
 248 {
 249     SvXMLImportContext *pContext = nullptr;
 250
 251     bool bHeader = false;
 252     switch( nElement )
 253     {
 254     case XML_ELEMENT(TEXT, XML_LIST_HEADER):
 255         bHeader = true;
 256         [[fallthrough]];
 257     case XML_ELEMENT(TEXT, XML_LIST_ITEM):
 258         pContext = new XMLTextListItemContext( GetImport(), mrTxtImport,
 259                                               xAttrList, bHeader );
 260         break;
 261     default:
 262         XMLOFF_WARN_UNKNOWN_ELEMENT("xmloff", nElement);
 263     }
 264
 265     return pContext;
 266 }
 267
 268
 269 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */