xmloff/source/text/XMLIndexTOCContext.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMLIndexTOCContext.cxx,v $
  10  * $Revision: 1.19 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_xmloff.hxx"
  33
  34
  35 #include "XMLIndexTOCContext.hxx"
  36 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  37 #include <com/sun/star/lang/IllegalArgumentException.hpp>
  38 #include <com/sun/star/uno/XInterface.hpp>
  39 #include <com/sun/star/text/XTextContent.hpp>
  40 #include <com/sun/star/text/XTextSection.hpp>
  41 #include <com/sun/star/text/XRelativeTextContentInsert.hpp>
  42 #include <com/sun/star/beans/XPropertySet.hpp>
  43 #include "XMLIndexTOCSourceContext.hxx"
  44 #include "XMLIndexObjectSourceContext.hxx"
  45 #include "XMLIndexAlphabeticalSourceContext.hxx"
  46 #include "XMLIndexUserSourceContext.hxx"
  47 #include "XMLIndexBibliographySourceContext.hxx"
  48 #include "XMLIndexTableSourceContext.hxx"
  49 #include "XMLIndexIllustrationSourceContext.hxx"
  50 #include "XMLIndexBodyContext.hxx"
  51 #include <xmloff/xmlictxt.hxx>
  52 #include <xmloff/xmlimp.hxx>
  53 #include <xmloff/txtimp.hxx>
  54 #include <xmloff/nmspmap.hxx>
  55 #include "xmlnmspe.hxx"
  56 #include "xmlkywd.hxx"
  57 #include <xmloff/xmltoken.hxx>
  58 #include <xmloff/prstylei.hxx>
  59 #include "xmlerror.hxx"
  60 #include <xmloff/xmluconv.hxx>
  61 #include <tools/debug.hxx>
  62 #include <rtl/ustring.hxx>
  63 #include <tools/debug.hxx>
  64
  65
  66 using namespace ::com::sun::star::uno;
  67 using namespace ::com::sun::star::text;
  68 using namespace ::xmloff::token;
  69
  70 using ::rtl::OUString;
  71 using ::com::sun::star::beans::XPropertySet;
  72 using ::com::sun::star::uno::Reference;
  73 using ::com::sun::star::xml::sax::XAttributeList;
  74 using ::com::sun::star::lang::XMultiServiceFactory;
  75 using ::com::sun::star::lang::IllegalArgumentException;
  76
  77
  78 TYPEINIT1(XMLIndexTOCContext, SvXMLImportContext);
  79
  80 static const sal_Char* aIndexServiceMap[] =
  81 {
  82     "com.sun.star.text.ContentIndex",
  83     "com.sun.star.text.DocumentIndex",
  84     "com.sun.star.text.TableIndex",
  85     "com.sun.star.text.ObjectIndex",
  86     "com.sun.star.text.Bibliography",
  87     "com.sun.star.text.UserIndex",
  88     "com.sun.star.text.IllustrationsIndex"
  89 };
  90
  91 static const sal_Char* aIndexSourceElementMap[] =
  92 {
  93     sXML_table_of_content_source,
  94     sXML_alphabetical_index_source,
  95     sXML_table_index_source,
  96     sXML_object_index_source,
  97     sXML_bibliography_source,
  98     sXML_user_index_source,
  99     sXML_illustration_index_source
 100 };
 101
 102 SvXMLEnumMapEntry __READONLY_DATA aIndexTypeMap[] =
 103 {
 104     { XML_TABLE_OF_CONTENT,         TEXT_INDEX_TOC },
 105     { XML_ALPHABETICAL_INDEX,   TEXT_INDEX_ALPHABETICAL },
 106     { XML_TABLE_INDEX,              TEXT_INDEX_TABLE },
 107     { XML_OBJECT_INDEX,             TEXT_INDEX_OBJECT },
 108     { XML_BIBLIOGRAPHY,             TEXT_INDEX_BIBLIOGRAPHY },
 109     { XML_USER_INDEX,                   TEXT_INDEX_USER },
 110     { XML_ILLUSTRATION_INDEX,   TEXT_INDEX_ILLUSTRATION },
 111     { XML_TOKEN_INVALID,        0 }
 112 };
 113
 114
 115 XMLIndexTOCContext::XMLIndexTOCContext(
 116     SvXMLImport& rImport,
 117     sal_uInt16 nPrfx,
 118     const OUString& rLocalName )
 119 :       SvXMLImportContext(rImport, nPrfx, rLocalName)
 120 ,       sTitle(RTL_CONSTASCII_USTRINGPARAM("Title"))
 121 ,       sIsProtected(RTL_CONSTASCII_USTRINGPARAM("IsProtected"))
 122 ,       sName(RTL_CONSTASCII_USTRINGPARAM("Name"))
 123 ,       pSourceElementName(NULL)
 124 ,       bValid(sal_False)
 125 {
 126     if (XML_NAMESPACE_TEXT == nPrfx)
 127     {
 128         sal_uInt16 nTmp;
 129         if (SvXMLUnitConverter::convertEnum(nTmp, rLocalName, aIndexTypeMap))
 130         {
 131             // check for array index:
 132             DBG_ASSERT(nTmp < (sizeof(aIndexServiceMap)/sizeof(sal_Char*)), "index out of range");
 133             DBG_ASSERT(sizeof(aIndexServiceMap) ==
 134                        sizeof(aIndexSourceElementMap),
 135                        "service and source element maps must be same size");
 136
 137             eIndexType = (enum IndexTypeEnum)nTmp;
 138             pSourceElementName = aIndexSourceElementMap[eIndexType];
 139             bValid = sal_True;
 140         }
 141     }
 142 }
 143
 144 XMLIndexTOCContext::~XMLIndexTOCContext()
 145 {
 146 }
 147
 148 void XMLIndexTOCContext::StartElement(
 149     const Reference<XAttributeList> & xAttrList)
 150 {
 151     if (bValid)
 152     {
 153         // find text:style-name attribute and set section style
 154         // find text:protected and set value
 155         // find text:name and set value (if not empty)
 156         sal_Int16 nCount = xAttrList->getLength();
 157         sal_Bool bProtected = sal_False;
 158         OUString sIndexName;
 159         OUString sXmlId;
 160         XMLPropStyleContext* pStyle(NULL);
 161         for(sal_Int16 nAttr = 0; nAttr < nCount; nAttr++)
 162         {
 163             OUString sLocalName;
 164             sal_uInt16 nPrefix = GetImport().GetNamespaceMap().
 165                 GetKeyByAttrName( xAttrList->getNameByIndex(nAttr),
 166                                   &sLocalName );
 167             if ( XML_NAMESPACE_TEXT == nPrefix)
 168             {
 169                 if ( IsXMLToken( sLocalName, XML_STYLE_NAME ) )
 170                 {
 171                     pStyle = GetImport().GetTextImport()->FindSectionStyle(
 172                                 xAttrList->getValueByIndex(nAttr));
 173                 }
 174                 else if ( IsXMLToken( sLocalName, XML_PROTECTED ) )
 175                 {
 176                     sal_Bool bTmp;
 177                     if ( SvXMLUnitConverter::convertBool(
 178                          bTmp, xAttrList->getValueByIndex(nAttr) ) )
 179                     {
 180                         bProtected = bTmp;
 181                     }
 182                 }
 183                 else if ( IsXMLToken( sLocalName, XML_NAME ) )
 184                 {
 185                     sIndexName = xAttrList->getValueByIndex(nAttr);
 186                 }
 187             }
 188             else if ( XML_NAMESPACE_XML == nPrefix)
 189             {
 190                 if ( IsXMLToken( sLocalName, XML_ID ) )
 191                 {
 192                     sXmlId = xAttrList->getValueByIndex(nAttr);
 193                 }
 194             }
 195         }
 196
 197         // create table of content (via MultiServiceFactory)
 198         Reference<XMultiServiceFactory> xFactory(GetImport().GetModel(),
 199                                                  UNO_QUERY);
 200         if( xFactory.is() )
 201         {
 202             Reference<XInterface> xIfc =
 203                 xFactory->createInstance(
 204                     OUString::createFromAscii(aIndexServiceMap[eIndexType]));
 205             if( xIfc.is() )
 206             {
 207
 208                 // xml:id for RDF metadata
 209                 GetImport().SetXmlId(xIfc, sXmlId);
 210
 211                 // get Property set
 212                 Reference<XPropertySet> xPropSet(xIfc, UNO_QUERY);
 213                 xTOCPropertySet = xPropSet;
 214
 215                 // insert section
 216                 // a) insert section
 217                 //    The inserted index consists of an empty paragraph
 218                 //    only, as well as an empty paragraph *after* the index
 219                 // b) insert marker after index, and put Cursor inside of the
 220                 //    index
 221
 222                 // preliminaries
 223 #ifdef PRODUCT
 224                 OUString sMarker(RTL_CONSTASCII_USTRINGPARAM(" "));
 225 #else
 226                 OUString sMarker(RTL_CONSTASCII_USTRINGPARAM("Y"));
 227 #endif
 228                 UniReference<XMLTextImportHelper> rImport =
 229                     GetImport().GetTextImport();
 230
 231                 // a) insert index
 232                 Reference<XTextContent> xTextContent(xIfc, UNO_QUERY);
 233                 try
 234                 {
 235                     GetImport().GetTextImport()->InsertTextContent(
 236                         xTextContent);
 237                 }
 238                 catch( IllegalArgumentException e )
 239                 {
 240                     // illegal argument? Then we can't accept indices here!
 241                     Sequence<OUString> aSeq(1);
 242                     aSeq[0] = GetLocalName();
 243                     GetImport().SetError(
 244                         XMLERROR_FLAG_ERROR | XMLERROR_NO_INDEX_ALLOWED_HERE,
 245                         aSeq, e.Message, NULL );
 246
 247                     // set bValid to false, and return prematurely
 248                     bValid = false;
 249                     return;
 250                 }
 251
 252                 // b) insert marker and move cursor
 253                 rImport->InsertString(sMarker);
 254                 rImport->GetCursor()->goLeft(2, sal_False);
 255             }
 256         }
 257
 258         // finally, check for redlines that should start at
 259         // the section start node
 260         if( bValid )
 261             GetImport().GetTextImport()->
 262                 RedlineAdjustStartNodeCursor(sal_True);
 263
 264         if (pStyle != NULL)
 265         {
 266             pStyle->FillPropertySet( xTOCPropertySet );
 267         }
 268
 269         Any aAny;
 270         aAny.setValue( &bProtected, ::getBooleanCppuType() );
 271         xTOCPropertySet->setPropertyValue( sIsProtected, aAny );
 272
 273         if (sIndexName.getLength() > 0)
 274         {
 275             aAny <<= sIndexName;
 276             xTOCPropertySet->setPropertyValue( sName, aAny );
 277         }
 278     }
 279 }
 280
 281 void XMLIndexTOCContext::EndElement()
 282 {
 283     // complete import of index by removing the markers (if the index
 284     // was actually inserted, that is)
 285     if( bValid )
 286     {
 287         // preliminaries
 288         OUString sEmpty;
 289         UniReference<XMLTextImportHelper> rHelper= GetImport().GetTextImport();
 290
 291         // get rid of last paragraph (unless it's the only paragraph)
 292         rHelper->GetCursor()->goRight(1, sal_False);
 293         if( xBodyContextRef.Is() &&
 294             ((XMLIndexBodyContext*)&xBodyContextRef)->HasContent() )
 295         {
 296             rHelper->GetCursor()->goLeft(1, sal_True);
 297             rHelper->GetText()->insertString(rHelper->GetCursorAsRange(),
 298                                              sEmpty, sal_True);
 299         }
 300
 301         // and delete second marker
 302         rHelper->GetCursor()->goRight(1, sal_True);
 303         rHelper->GetText()->insertString(rHelper->GetCursorAsRange(),
 304                                          sEmpty, sal_True);
 305
 306         // check for Redlines on our end node
 307         GetImport().GetTextImport()->RedlineAdjustStartNodeCursor(sal_False);
 308     }
 309 }
 310
 311 SvXMLImportContext* XMLIndexTOCContext::CreateChildContext(
 312     sal_uInt16 nPrefix,
 313     const OUString& rLocalName,
 314     const Reference<XAttributeList> & xAttrList )
 315 {
 316     SvXMLImportContext* pContext = NULL;
 317
 318     if (bValid)
 319     {
 320         if (XML_NAMESPACE_TEXT == nPrefix)
 321         {
 322             if ( IsXMLToken( rLocalName, XML_INDEX_BODY ) )
 323             {
 324                 pContext = new XMLIndexBodyContext(GetImport(), nPrefix,
 325                                                    rLocalName);
 326                 if ( !xBodyContextRef.Is() ||
 327                      !((XMLIndexBodyContext*)&xBodyContextRef)->HasContent() )
 328                 {
 329                     xBodyContextRef = pContext;
 330                 }
 331             }
 332             else if (0 == rLocalName.compareToAscii(pSourceElementName))
 333             {
 334                 // instantiate source context for the appropriate index type
 335                 switch (eIndexType)
 336                 {
 337                     case TEXT_INDEX_TOC:
 338                         pContext = new XMLIndexTOCSourceContext(
 339                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 340                         break;
 341
 342                     case TEXT_INDEX_OBJECT:
 343                         pContext = new XMLIndexObjectSourceContext(
 344                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 345                         break;
 346
 347                     case TEXT_INDEX_ALPHABETICAL:
 348                         pContext = new XMLIndexAlphabeticalSourceContext(
 349                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 350                         break;
 351
 352                     case TEXT_INDEX_USER:
 353                         pContext = new XMLIndexUserSourceContext(
 354                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 355                         break;
 356
 357                     case TEXT_INDEX_BIBLIOGRAPHY:
 358                         pContext = new XMLIndexBibliographySourceContext(
 359                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 360                         break;
 361
 362                     case TEXT_INDEX_TABLE:
 363                         pContext = new XMLIndexTableSourceContext(
 364                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 365                         break;
 366
 367                     case TEXT_INDEX_ILLUSTRATION:
 368                         pContext = new XMLIndexIllustrationSourceContext(
 369                             GetImport(), nPrefix, rLocalName, xTOCPropertySet);
 370                         break;
 371
 372                     default:
 373                         DBG_ERROR("index type not implemented");
 374                         break;
 375                 }
 376             }
 377             // else: ignore
 378         }
 379         // else: no text: namespace -> ignore
 380     }
 381     // else: not valid -> ignore
 382
 383     // default: ignore
 384     if (pContext == NULL)
 385     {
 386         pContext = SvXMLImportContext::CreateChildContext(nPrefix, rLocalName,
 387                                                           xAttrList);
 388     }
 389
 390     return pContext;
 391 }