xmloff/source/text/XMLTextColumnsContext.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #include <com/sun/star/text/XTextColumns.hpp>
  30 #include <com/sun/star/text/TextColumn.hpp>
  31 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  32 #include <com/sun/star/style/VerticalAlignment.hpp>
  33 #include <com/sun/star/beans/XPropertySet.hpp>
  34 #include <sax/tools/converter.hxx>
  35 #include <xmloff/xmltkmap.hxx>
  36 #include <xmloff/xmluconv.hxx>
  37 #include <xmloff/nmspmap.hxx>
  38 #include "xmloff/xmlnmspe.hxx"
  39 #include <xmloff/xmlimp.hxx>
  40 #include <xmloff/xmltoken.hxx>
  41 #include "XMLTextColumnsContext.hxx"
  42 #include <svl/svstdarr.hxx>
  43
  44 using ::rtl::OUString;
  45 using ::rtl::OUStringBuffer;
  46
  47 using namespace ::com::sun::star;
  48 using namespace ::com::sun::star::uno;
  49 using namespace ::com::sun::star::lang;
  50 using namespace ::com::sun::star::text;
  51 using namespace ::com::sun::star::style;
  52 using namespace ::com::sun::star::beans;
  53 using namespace ::xmloff::token;
  54
  55 enum SvXMLTokenMapAttrs
  56 {
  57     XML_TOK_COLUMN_WIDTH,
  58     XML_TOK_COLUMN_MARGIN_LEFT,
  59     XML_TOK_COLUMN_MARGIN_RIGHT,
  60     XML_TOK_COLUMN_END=XML_TOK_UNKNOWN
  61 };
  62
  63 enum SvXMLSepTokenMapAttrs
  64 {
  65     XML_TOK_COLUMN_SEP_WIDTH,
  66     XML_TOK_COLUMN_SEP_HEIGHT,
  67     XML_TOK_COLUMN_SEP_COLOR,
  68     XML_TOK_COLUMN_SEP_ALIGN,
  69     XML_TOK_COLUMN_SEP_STYLE,
  70     XML_TOK_COLUMN_SEP_END=XML_TOK_UNKNOWN
  71 };
  72
  73 static SvXMLTokenMapEntry aColAttrTokenMap[] =
  74 {
  75     { XML_NAMESPACE_STYLE,  XML_REL_WIDTH,      XML_TOK_COLUMN_WIDTH },
  76     { XML_NAMESPACE_FO,     XML_START_INDENT,   XML_TOK_COLUMN_MARGIN_LEFT },
  77     { XML_NAMESPACE_FO,     XML_END_INDENT,     XML_TOK_COLUMN_MARGIN_RIGHT },
  78     XML_TOKEN_MAP_END
  79 };
  80
  81 static SvXMLTokenMapEntry aColSepAttrTokenMap[] =
  82 {
  83     { XML_NAMESPACE_STYLE,  XML_WIDTH,          XML_TOK_COLUMN_SEP_WIDTH },
  84     { XML_NAMESPACE_STYLE,  XML_COLOR,          XML_TOK_COLUMN_SEP_COLOR },
  85     { XML_NAMESPACE_STYLE,  XML_HEIGHT,         XML_TOK_COLUMN_SEP_HEIGHT },
  86     { XML_NAMESPACE_STYLE,  XML_VERTICAL_ALIGN, XML_TOK_COLUMN_SEP_ALIGN },
  87     { XML_NAMESPACE_STYLE,  XML_STYLE,          XML_TOK_COLUMN_SEP_STYLE },
  88     XML_TOKEN_MAP_END
  89 };
  90
  91 SvXMLEnumMapEntry const pXML_Sep_Style_Enum[] =
  92 {
  93     { XML_NONE,          0 },
  94     { XML_SOLID,         1 },
  95     { XML_DOTTED,        2 },
  96     { XML_DASHED,        3 },
  97     { XML_TOKEN_INVALID, 0 }
  98 };
  99
 100 SvXMLEnumMapEntry const pXML_Sep_Align_Enum[] =
 101 {
 102     { XML_TOP,          VerticalAlignment_TOP   },
 103     { XML_MIDDLE,       VerticalAlignment_MIDDLE },
 104     { XML_BOTTOM,       VerticalAlignment_BOTTOM },
 105     { XML_TOKEN_INVALID, 0 }
 106 };
 107
 108 class XMLTextColumnContext_Impl: public SvXMLImportContext
 109 {
 110     text::TextColumn aColumn;
 111
 112 public:
 113     TYPEINFO();
 114
 115     XMLTextColumnContext_Impl( SvXMLImport& rImport, sal_uInt16 nPrfx,
 116                                const OUString& rLName,
 117                                const uno::Reference<
 118                                        xml::sax::XAttributeList > & xAttrList,
 119                                const SvXMLTokenMap& rTokenMap );
 120
 121     virtual ~XMLTextColumnContext_Impl();
 122
 123     text::TextColumn& getTextColumn() { return aColumn; }
 124 };
 125
 126 TYPEINIT1( XMLTextColumnContext_Impl, SvXMLImportContext );
 127
 128 XMLTextColumnContext_Impl::XMLTextColumnContext_Impl(
 129                                SvXMLImport& rImport, sal_uInt16 nPrfx,
 130                                const OUString& rLName,
 131                                const uno::Reference<
 132                                        xml::sax::XAttributeList > & xAttrList,
 133                                const SvXMLTokenMap& rTokenMap ) :
 134     SvXMLImportContext( rImport, nPrfx, rLName )
 135 {
 136     aColumn.Width = 0;
 137     aColumn.LeftMargin = 0;
 138     aColumn.RightMargin = 0;
 139
 140     sal_Int16 nAttrCount = xAttrList.is() ? xAttrList->getLength() : 0;
 141     for( sal_Int16 i=0; i < nAttrCount; i++ )
 142     {
 143         const OUString& rAttrName = xAttrList->getNameByIndex( i );
 144         OUString aLocalName;
 145         sal_uInt16 nPrefix =
 146             GetImport().GetNamespaceMap().GetKeyByAttrName( rAttrName,
 147                                                             &aLocalName );
 148         const OUString& rValue = xAttrList->getValueByIndex( i );
 149
 150         sal_Int32 nVal;
 151         switch( rTokenMap.Get( nPrefix, aLocalName ) )
 152         {
 153         case XML_TOK_COLUMN_WIDTH:
 154             {
 155                 sal_Int32 nPos = rValue.indexOf( (sal_Unicode)'*' );
 156                 if( nPos != -1 && nPos+1 == rValue.getLength() )
 157                 {
 158                     OUString sTmp( rValue.copy( 0, nPos ) );
 159                     if (::sax::Converter::convertNumber(
 160                                 nVal, sTmp, 0, USHRT_MAX))
 161                     aColumn.Width = nVal;
 162                 }
 163             }
 164             break;
 165         case XML_TOK_COLUMN_MARGIN_LEFT:
 166             if( GetImport().GetMM100UnitConverter().
 167                                 convertMeasureToCore( nVal, rValue ) )
 168                 aColumn.LeftMargin = nVal;
 169             break;
 170         case XML_TOK_COLUMN_MARGIN_RIGHT:
 171
 172             if( GetImport().GetMM100UnitConverter().
 173                                 convertMeasureToCore( nVal, rValue ) )
 174                 aColumn.RightMargin = nVal;
 175             break;
 176         default:
 177             break;
 178         }
 179     }
 180 }
 181
 182 XMLTextColumnContext_Impl::~XMLTextColumnContext_Impl()
 183 {
 184 }
 185
 186 // --------------------------------------------------------------------------
 187
 188 class XMLTextColumnSepContext_Impl: public SvXMLImportContext
 189 {
 190     sal_Int32 nWidth;
 191     sal_Int32 nColor;
 192     sal_Int8 nHeight;
 193     sal_Int8 nStyle;
 194     VerticalAlignment eVertAlign;
 195
 196
 197 public:
 198     TYPEINFO();
 199
 200     XMLTextColumnSepContext_Impl( SvXMLImport& rImport, sal_uInt16 nPrfx,
 201                                const OUString& rLName,
 202                                const uno::Reference<
 203                                        xml::sax::XAttributeList > & xAttrList,
 204                                const SvXMLTokenMap& rTokenMap );
 205
 206     virtual ~XMLTextColumnSepContext_Impl();
 207
 208     sal_Int32 GetWidth() const { return nWidth; }
 209     sal_Int32 GetColor() const { return  nColor; }
 210     sal_Int8 GetHeight() const { return nHeight; }
 211     sal_Int8 GetStyle() const { return nStyle; }
 212     VerticalAlignment GetVertAlign() const { return eVertAlign; }
 213 };
 214
 215
 216 TYPEINIT1( XMLTextColumnSepContext_Impl, SvXMLImportContext );
 217
 218 XMLTextColumnSepContext_Impl::XMLTextColumnSepContext_Impl(
 219                                SvXMLImport& rImport, sal_uInt16 nPrfx,
 220                                const OUString& rLName,
 221                                const uno::Reference<
 222                                        xml::sax::XAttributeList > & xAttrList,
 223                                const SvXMLTokenMap& rTokenMap ) :
 224     SvXMLImportContext( rImport, nPrfx, rLName ),
 225     nWidth( 2 ),
 226     nColor( 0 ),
 227     nHeight( 100 ),
 228     nStyle( 1 ),
 229     eVertAlign( VerticalAlignment_TOP )
 230 {
 231     sal_Int16 nAttrCount = xAttrList.is() ? xAttrList->getLength() : 0;
 232     for( sal_Int16 i=0; i < nAttrCount; i++ )
 233     {
 234         const OUString& rAttrName = xAttrList->getNameByIndex( i );
 235         OUString aLocalName;
 236         sal_uInt16 nPrefix =
 237             GetImport().GetNamespaceMap().GetKeyByAttrName( rAttrName,
 238                                                             &aLocalName );
 239         const OUString& rValue = xAttrList->getValueByIndex( i );
 240
 241         sal_Int32 nVal;
 242         switch( rTokenMap.Get( nPrefix, aLocalName ) )
 243         {
 244         case XML_TOK_COLUMN_SEP_WIDTH:
 245             if( GetImport().GetMM100UnitConverter().
 246                                 convertMeasureToCore( nVal, rValue ) )
 247                 nWidth = nVal;
 248             break;
 249         case XML_TOK_COLUMN_SEP_HEIGHT:
 250             if (::sax::Converter::convertPercent( nVal, rValue ) &&
 251                  nVal >=1 && nVal <= 100 )
 252                 nHeight = (sal_Int8)nVal;
 253             break;
 254         case XML_TOK_COLUMN_SEP_COLOR:
 255             {
 256                 ::sax::Converter::convertColor( nColor, rValue );
 257             }
 258             break;
 259         case XML_TOK_COLUMN_SEP_ALIGN:
 260             {
 261                 sal_uInt16 nAlign;
 262                 if( GetImport().GetMM100UnitConverter().
 263                                         convertEnum( nAlign, rValue,
 264                                                        pXML_Sep_Align_Enum ) )
 265                     eVertAlign = (VerticalAlignment)nAlign;
 266             }
 267             break;
 268         case XML_TOK_COLUMN_SEP_STYLE:
 269             {
 270                 sal_uInt16 nStyleVal;
 271                 if( GetImport().GetMM100UnitConverter().
 272                                         convertEnum( nStyleVal, rValue,
 273                                                        pXML_Sep_Style_Enum ) )
 274                     nStyle = (sal_Int8)nStyleVal;
 275             }
 276             break;
 277         }
 278     }
 279 }
 280
 281 XMLTextColumnSepContext_Impl::~XMLTextColumnSepContext_Impl()
 282 {
 283 }
 284
 285 // --------------------------------------------------------------------------
 286
 287 class XMLTextColumnsArray_Impl : public std::vector<XMLTextColumnContext_Impl *> {};
 288
 289 TYPEINIT1( XMLTextColumnsContext, XMLElementPropertyContext );
 290
 291 XMLTextColumnsContext::XMLTextColumnsContext(
 292                                 SvXMLImport& rImport, sal_uInt16 nPrfx,
 293                                 const OUString& rLName,
 294                                 const Reference< xml::sax::XAttributeList >&
 295                                     xAttrList,
 296                                 const XMLPropertyState& rProp,
 297                                  ::std::vector< XMLPropertyState > &rProps )
 298 :   XMLElementPropertyContext( rImport, nPrfx, rLName, rProp, rProps )
 299 ,   sSeparatorLineIsOn(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineIsOn"))
 300 ,   sSeparatorLineWidth(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineWidth"))
 301 ,   sSeparatorLineColor(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineColor"))
 302 ,   sSeparatorLineRelativeHeight(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineRelativeHeight"))
 303 ,   sSeparatorLineVerticalAlignment(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineVerticalAlignment"))
 304 ,   sIsAutomatic(RTL_CONSTASCII_USTRINGPARAM("IsAutomatic"))
 305 ,   sAutomaticDistance(RTL_CONSTASCII_USTRINGPARAM("AutomaticDistance"))
 306 ,   sSeparatorLineStyle(RTL_CONSTASCII_USTRINGPARAM("SeparatorLineStyle"))
 307 ,   pColumns( 0 )
 308 ,   pColumnSep( 0 )
 309 ,   pColumnAttrTokenMap( new SvXMLTokenMap(aColAttrTokenMap) )
 310 ,   pColumnSepAttrTokenMap( new SvXMLTokenMap(aColSepAttrTokenMap) )
 311 ,   nCount( 0 )
 312 ,   bAutomatic( sal_False )
 313 ,   nAutomaticDistance( 0 )
 314 {
 315     sal_Int16 nAttrCount = xAttrList.is() ? xAttrList->getLength() : 0;
 316     sal_Int32 nVal;
 317     for( sal_Int16 i=0; i < nAttrCount; i++ )
 318     {
 319         const OUString& rAttrName = xAttrList->getNameByIndex( i );
 320         OUString aLocalName;
 321         sal_uInt16 nPrefix =
 322             GetImport().GetNamespaceMap().GetKeyByAttrName( rAttrName,
 323                                                             &aLocalName );
 324         const OUString& rValue = xAttrList->getValueByIndex( i );
 325         if( XML_NAMESPACE_FO == nPrefix )
 326         {
 327             if( IsXMLToken( aLocalName, XML_COLUMN_COUNT ) &&
 328                 ::sax::Converter::convertNumber( nVal, rValue, 0, SHRT_MAX ))
 329             {
 330                 nCount = (sal_Int16)nVal;
 331             }
 332             else if( IsXMLToken( aLocalName, XML_COLUMN_GAP ) )
 333             {
 334                 bAutomatic = GetImport().GetMM100UnitConverter().
 335                     convertMeasureToCore( nAutomaticDistance, rValue );
 336             }
 337         }
 338     }
 339 }
 340
 341 XMLTextColumnsContext::~XMLTextColumnsContext()
 342 {
 343     if( pColumns )
 344     {
 345         for (XMLTextColumnsArray_Impl::iterator it = pColumns->begin();
 346                 it != pColumns->end(); ++it)
 347         {
 348            (*it)->ReleaseRef();
 349         }
 350     }
 351     if( pColumnSep )
 352         pColumnSep->ReleaseRef();
 353
 354     delete pColumns;
 355     delete pColumnAttrTokenMap;
 356     delete pColumnSepAttrTokenMap;
 357 }
 358
 359 SvXMLImportContext *XMLTextColumnsContext::CreateChildContext(
 360     sal_uInt16 nPrefix,
 361     const OUString& rLocalName,
 362     const uno::Reference< xml::sax::XAttributeList > & xAttrList )
 363 {
 364     SvXMLImportContext *pContext = 0;
 365
 366     if( XML_NAMESPACE_STYLE == nPrefix &&
 367         IsXMLToken( rLocalName, XML_COLUMN ) )
 368     {
 369         XMLTextColumnContext_Impl *pColumn =
 370             new XMLTextColumnContext_Impl( GetImport(), nPrefix, rLocalName,
 371                                            xAttrList, *pColumnAttrTokenMap );
 372
 373         // add new tabstop to array of tabstops
 374         if( !pColumns )
 375             pColumns = new XMLTextColumnsArray_Impl;
 376
 377         pColumns->push_back( pColumn );
 378         pColumn->AddRef();
 379
 380         pContext = pColumn;
 381     }
 382     else if( XML_NAMESPACE_STYLE == nPrefix &&
 383              IsXMLToken( rLocalName, XML_COLUMN_SEP ) )
 384     {
 385         pColumnSep =
 386             new XMLTextColumnSepContext_Impl( GetImport(), nPrefix, rLocalName,
 387                                            xAttrList, *pColumnSepAttrTokenMap );
 388         pColumnSep->AddRef();
 389
 390         pContext = pColumnSep;
 391     }
 392     else
 393     {
 394         pContext = new SvXMLImportContext( GetImport(), nPrefix, rLocalName );
 395     }
 396
 397     return pContext;
 398 }
 399
 400 void XMLTextColumnsContext::EndElement( )
 401 {
 402     Reference<XMultiServiceFactory> xFactory(GetImport().GetModel(),UNO_QUERY);
 403     if( !xFactory.is() )
 404         return;
 405
 406     Reference<XInterface> xIfc = xFactory->createInstance(
 407         OUString(RTL_CONSTASCII_USTRINGPARAM("com.sun.star.text.TextColumns")));
 408     if( !xIfc.is() )
 409         return;
 410
 411     Reference< XTextColumns > xColumns( xIfc, UNO_QUERY );
 412     if ( 0 == nCount )
 413     {
 414         // zero columns = no columns -> 1 column
 415         xColumns->setColumnCount( 1 );
 416     }
 417     else if( !bAutomatic && pColumns &&
 418              pColumns->size() == (sal_uInt16)nCount )
 419     {
 420         // if we have column descriptions, one per column, and we don't use
 421         // automatic width, then set the column widths
 422
 423         sal_Int32 nRelWidth = 0;
 424         sal_uInt16 nColumnsWithWidth = 0;
 425         sal_Int16 i;
 426
 427         for( i = 0; i < nCount; i++ )
 428         {
 429             const TextColumn& rColumn =
 430                 (*pColumns)[(sal_uInt16)i]->getTextColumn();
 431             if( rColumn.Width > 0 )
 432             {
 433                 nRelWidth += rColumn.Width;
 434                 nColumnsWithWidth++;
 435             }
 436         }
 437         if( nColumnsWithWidth < nCount )
 438         {
 439             sal_Int32 nColWidth = 0==nRelWidth
 440                                         ? USHRT_MAX / nCount
 441                                         : nRelWidth / nColumnsWithWidth;
 442
 443             for( i=0; i < nCount; i++ )
 444             {
 445                 TextColumn& rColumn =
 446                     (*pColumns)[(sal_uInt16)i]->getTextColumn();
 447                 if( rColumn.Width == 0 )
 448                 {
 449                     rColumn.Width = nColWidth;
 450                     nRelWidth += rColumn.Width;
 451                     if( 0 == --nColumnsWithWidth )
 452                         break;
 453                 }
 454             }
 455         }
 456
 457         Sequence< TextColumn > aColumns( (sal_Int32)nCount );
 458         TextColumn *pTextColumns = aColumns.getArray();
 459         for( i=0; i < nCount; i++ )
 460             *pTextColumns++ = (*pColumns)[(sal_uInt16)i]->getTextColumn();
 461
 462         xColumns->setColumns( aColumns );
 463     }
 464     else
 465     {
 466         // only set column count (and let the columns be distributed
 467         // automatically)
 468
 469         xColumns->setColumnCount( nCount );
 470     }
 471
 472     Reference < XPropertySet > xPropSet( xColumns, UNO_QUERY );
 473     if( xPropSet.is() )
 474     {
 475         Any aAny;
 476         sal_Bool bOn = pColumnSep != 0;
 477
 478         aAny.setValue( &bOn, ::getBooleanCppuType() );
 479         xPropSet->setPropertyValue( sSeparatorLineIsOn, aAny );
 480
 481         if( pColumnSep )
 482         {
 483             if( pColumnSep->GetWidth() )
 484             {
 485                 aAny <<= pColumnSep->GetWidth();
 486                 xPropSet->setPropertyValue( sSeparatorLineWidth, aAny );
 487             }
 488             if( pColumnSep->GetHeight() )
 489             {
 490                 aAny <<= pColumnSep->GetHeight();
 491                 xPropSet->setPropertyValue( sSeparatorLineRelativeHeight,
 492                                             aAny );
 493             }
 494             if ( pColumnSep->GetStyle() )
 495             {
 496                 aAny <<= pColumnSep->GetStyle();
 497                 xPropSet->setPropertyValue( sSeparatorLineStyle, aAny );
 498             }
 499
 500
 501             aAny <<= pColumnSep->GetColor();
 502             xPropSet->setPropertyValue( sSeparatorLineColor, aAny );
 503
 504
 505             aAny <<= pColumnSep->GetVertAlign();
 506             xPropSet->setPropertyValue( sSeparatorLineVerticalAlignment, aAny );
 507         }
 508
 509         // handle 'automatic columns': column distance
 510         if( bAutomatic )
 511         {
 512             aAny <<= nAutomaticDistance;
 513             xPropSet->setPropertyValue( sAutomaticDistance, aAny );
 514         }
 515     }
 516
 517     aProp.maValue <<= xColumns;
 518
 519     SetInsert( sal_True );
 520     XMLElementPropertyContext::EndElement();
 521
 522 }
 523
 524 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */