xmloff/source/text/XMLTextColumnsContext.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 <sal/config.h>
  21
  22 #include <com/sun/star/frame/XModel.hpp>
  23 #include <com/sun/star/text/XTextColumns.hpp>
  24 #include <com/sun/star/text/TextColumn.hpp>
  25 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  26 #include <com/sun/star/style/VerticalAlignment.hpp>
  27 #include <com/sun/star/beans/XPropertySet.hpp>
  28 #include <sal/log.hxx>
  29 #include <sax/tools/converter.hxx>
  30 #include <xmloff/xmluconv.hxx>
  31 #include <xmloff/xmlnamespace.hxx>
  32 #include <xmloff/xmlimp.hxx>
  33 #include <xmloff/xmltoken.hxx>
  34 #include <xmloff/xmlement.hxx>
  35 #include <XMLTextColumnsContext.hxx>
  36
  37 using namespace ::com::sun::star;
  38 using namespace ::com::sun::star::uno;
  39 using namespace ::com::sun::star::lang;
  40 using namespace ::com::sun::star::text;
  41 using namespace ::com::sun::star::style;
  42 using namespace ::com::sun::star::beans;
  43 using namespace ::xmloff::token;
  44
  45 SvXMLEnumMapEntry<sal_Int8> const pXML_Sep_Style_Enum[] =
  46 {
  47     { XML_NONE,          0 },
  48     { XML_SOLID,         1 },
  49     { XML_DOTTED,        2 },
  50     { XML_DASHED,        3 },
  51     { XML_TOKEN_INVALID, 0 }
  52 };
  53
  54 SvXMLEnumMapEntry<VerticalAlignment> const pXML_Sep_Align_Enum[] =
  55 {
  56     { XML_TOP,           VerticalAlignment_TOP   },
  57     { XML_MIDDLE,        VerticalAlignment_MIDDLE },
  58     { XML_BOTTOM,        VerticalAlignment_BOTTOM },
  59     { XML_TOKEN_INVALID, VerticalAlignment(0) }
  60 };
  61
  62 class XMLTextColumnContext_Impl: public SvXMLImportContext
  63 {
  64     text::TextColumn aColumn;
  65
  66 public:
  67
  68     XMLTextColumnContext_Impl( SvXMLImport& rImport, sal_Int32 nElement,
  69                                const uno::Reference<
  70                                        xml::sax::XFastAttributeList > & xAttrList );
  71
  72     text::TextColumn& getTextColumn() { return aColumn; }
  73 };
  74
  75
  76 XMLTextColumnContext_Impl::XMLTextColumnContext_Impl(
  77                                SvXMLImport& rImport, sal_Int32 /*nElement*/,
  78                                const uno::Reference<
  79                                        xml::sax::XFastAttributeList > & xAttrList ) :
  80     SvXMLImportContext( rImport )
  81 {
  82     aColumn.Width = 0;
  83     aColumn.LeftMargin = 0;
  84     aColumn.RightMargin = 0;
  85
  86     for( auto& aIter : sax_fastparser::castToFastAttributeList(xAttrList) )
  87     {
  88         sal_Int32 nVal;
  89         switch( aIter.getToken() )
  90         {
  91         case XML_ELEMENT(STYLE, XML_REL_WIDTH):
  92             {
  93                 size_t nPos = aIter.toView().find( '*' );
  94                 if( nPos != std::string_view::npos && static_cast<sal_Int32>(nPos+1) == aIter.getLength() )
  95                 {
  96                     if (::sax::Converter::convertNumber(
  97                                 nVal,
  98                                 aIter.toView().substr(0, nPos),
  99                                 0, USHRT_MAX))
 100                         aColumn.Width = nVal;
 101                 }
 102             }
 103             break;
 104         case XML_ELEMENT(FO, XML_START_INDENT):
 105         case XML_ELEMENT(FO_COMPAT, XML_START_INDENT):
 106             if( GetImport().GetMM100UnitConverter().
 107                                 convertMeasureToCore( nVal, aIter.toView() ) )
 108                 aColumn.LeftMargin = nVal;
 109             break;
 110         case XML_ELEMENT(FO, XML_END_INDENT):
 111         case XML_ELEMENT(FO_COMPAT, XML_END_INDENT):
 112             if( GetImport().GetMM100UnitConverter().
 113                                 convertMeasureToCore( nVal, aIter.toView() ) )
 114                 aColumn.RightMargin = nVal;
 115             break;
 116         default:
 117             XMLOFF_WARN_UNKNOWN("xmloff", aIter);
 118             break;
 119         }
 120     }
 121 }
 122
 123 class XMLTextColumnSepContext_Impl: public SvXMLImportContext
 124 {
 125     sal_Int32 nWidth;
 126     sal_Int32 nColor;
 127     sal_Int8 nHeight;
 128     sal_Int8 nStyle;
 129     VerticalAlignment eVertAlign;
 130
 131 public:
 132
 133     XMLTextColumnSepContext_Impl( SvXMLImport& rImport, sal_Int32 nElement,
 134                                const uno::Reference<
 135                                        xml::sax::XFastAttributeList > & xAttrList );
 136
 137     sal_Int32 GetWidth() const { return nWidth; }
 138     sal_Int32 GetColor() const { return  nColor; }
 139     sal_Int8 GetHeight() const { return nHeight; }
 140     sal_Int8 GetStyle() const { return nStyle; }
 141     VerticalAlignment GetVertAlign() const { return eVertAlign; }
 142 };
 143
 144
 145 XMLTextColumnSepContext_Impl::XMLTextColumnSepContext_Impl(
 146                                SvXMLImport& rImport, sal_Int32 /*nElement*/,
 147                                const uno::Reference<
 148                                        xml::sax::XFastAttributeList > & xAttrList) :
 149     SvXMLImportContext( rImport ),
 150     nWidth( 2 ),
 151     nColor( 0 ),
 152     nHeight( 100 ),
 153     nStyle( 1 ),
 154     eVertAlign( VerticalAlignment_TOP )
 155 {
 156     for (auto &aIter : sax_fastparser::castToFastAttributeList( xAttrList ))
 157     {
 158         sal_Int32 nVal;
 159         switch( aIter.getToken() )
 160         {
 161         case XML_ELEMENT(STYLE,  XML_WIDTH):
 162             if( GetImport().GetMM100UnitConverter().
 163                                 convertMeasureToCore( nVal, aIter.toView() ) )
 164                 nWidth = nVal;
 165             break;
 166         case XML_ELEMENT(STYLE, XML_HEIGHT):
 167             if (::sax::Converter::convertPercent( nVal, aIter.toView() ) &&
 168                  nVal >=1 && nVal <= 100 )
 169                 nHeight = static_cast<sal_Int8>(nVal);
 170             break;
 171         case XML_ELEMENT(STYLE, XML_COLOR):
 172             ::sax::Converter::convertColor( nColor, aIter.toView() );
 173             break;
 174         case XML_ELEMENT(STYLE, XML_VERTICAL_ALIGN):
 175             SvXMLUnitConverter::convertEnum( eVertAlign, aIter.toView(),
 176                                              pXML_Sep_Align_Enum );
 177             break;
 178         case XML_ELEMENT(STYLE, XML_STYLE):
 179             SvXMLUnitConverter::convertEnum( nStyle, aIter.toView(),
 180                                              pXML_Sep_Style_Enum );
 181             break;
 182         default:
 183             XMLOFF_WARN_UNKNOWN("xmloff", aIter);
 184         }
 185     }
 186 }
 187
 188 constexpr OUStringLiteral gsSeparatorLineIsOn(u"SeparatorLineIsOn");
 189 constexpr OUStringLiteral gsSeparatorLineWidth(u"SeparatorLineWidth");
 190 constexpr OUStringLiteral gsSeparatorLineColor(u"SeparatorLineColor");
 191 constexpr OUStringLiteral gsSeparatorLineRelativeHeight(u"SeparatorLineRelativeHeight");
 192 constexpr OUStringLiteral gsSeparatorLineVerticalAlignment(u"SeparatorLineVerticalAlignment");
 193 constexpr OUStringLiteral gsAutomaticDistance(u"AutomaticDistance");
 194 constexpr OUStringLiteral gsSeparatorLineStyle(u"SeparatorLineStyle");
 195
 196 XMLTextColumnsContext::XMLTextColumnsContext(
 197                                 SvXMLImport& rImport, sal_Int32 nElement,
 198                                 const Reference< xml::sax::XFastAttributeList >& xAttrList,
 199                                 const XMLPropertyState& rProp,
 200                                  ::std::vector< XMLPropertyState > &rProps )
 201 :   XMLElementPropertyContext( rImport, nElement, rProp, rProps )
 202 ,   nCount( 0 )
 203 ,   bAutomatic( false )
 204 ,   nAutomaticDistance( 0 )
 205 {
 206     sal_Int32 nVal;
 207     for (auto &aIter : sax_fastparser::castToFastAttributeList(xAttrList))
 208     {
 209         switch(aIter.getToken())
 210         {
 211             case XML_ELEMENT(FO, XML_COLUMN_COUNT):
 212             case XML_ELEMENT(FO_COMPAT, XML_COLUMN_COUNT):
 213                 if(::sax::Converter::convertNumber( nVal, aIter.toView(), 0, SHRT_MAX ))
 214                     nCount = static_cast<sal_Int16>(nVal);
 215                 break;
 216             case XML_ELEMENT(FO, XML_COLUMN_GAP):
 217             case XML_ELEMENT(FO_COMPAT, XML_COLUMN_GAP):
 218             {
 219                 bAutomatic = GetImport().GetMM100UnitConverter().
 220                     convertMeasureToCore( nAutomaticDistance, aIter.toView() );
 221                 break;
 222             }
 223             default:
 224                 XMLOFF_WARN_UNKNOWN("xmloff", aIter);
 225         }
 226     }
 227 }
 228
 229 css::uno::Reference< css::xml::sax::XFastContextHandler > XMLTextColumnsContext::createFastChildContext(
 230     sal_Int32 nElement,
 231     const css::uno::Reference< css::xml::sax::XFastAttributeList >& xAttrList )
 232 {
 233     if( nElement == XML_ELEMENT(STYLE, XML_COLUMN) )
 234     {
 235         const rtl::Reference<XMLTextColumnContext_Impl> xColumn{
 236             new XMLTextColumnContext_Impl( GetImport(), nElement, xAttrList )};
 237
 238         // add new tabstop to array of tabstops
 239         maColumns.push_back( xColumn );
 240
 241         return xColumn;
 242     }
 243     else if( nElement == XML_ELEMENT(STYLE, XML_COLUMN_SEP) )
 244     {
 245         mxColumnSep.set(
 246             new XMLTextColumnSepContext_Impl( GetImport(), nElement, xAttrList ));
 247
 248         return mxColumnSep;
 249     }
 250     XMLOFF_WARN_UNKNOWN_ELEMENT("xmloff", nElement);
 251     return nullptr;
 252 }
 253
 254 void XMLTextColumnsContext::endFastElement(sal_Int32 nElement )
 255 {
 256     Reference<XMultiServiceFactory> xFactory(GetImport().GetModel(),UNO_QUERY);
 257     if( !xFactory.is() )
 258         return;
 259
 260     Reference<XInterface> xIfc = xFactory->createInstance(u"com.sun.star.text.TextColumns"_ustr);
 261     if( !xIfc.is() )
 262         return;
 263
 264     Reference< XTextColumns > xColumns( xIfc, UNO_QUERY );
 265     if ( 0 == nCount )
 266     {
 267         // zero columns = no columns -> 1 column
 268         xColumns->setColumnCount( 1 );
 269     }
 270     else if( !bAutomatic &&
 271              maColumns.size() == static_cast<sal_uInt16>(nCount) )
 272     {
 273         // if we have column descriptions, one per column, and we don't use
 274         // automatic width, then set the column widths
 275
 276         sal_Int32 nRelWidth = 0;
 277         sal_uInt16 nColumnsWithWidth = 0;
 278         sal_Int16 i;
 279
 280         for( i = 0; i < nCount; i++ )
 281         {
 282             const TextColumn& rColumn =
 283                 maColumns[static_cast<sal_uInt16>(i)]->getTextColumn();
 284             if( rColumn.Width > 0 )
 285             {
 286                 nRelWidth += rColumn.Width;
 287                 nColumnsWithWidth++;
 288             }
 289         }
 290         if( nColumnsWithWidth < nCount )
 291         {
 292             sal_Int32 nColWidth = 0==nRelWidth
 293                                         ? USHRT_MAX / nCount
 294                                         : nRelWidth / nColumnsWithWidth;
 295
 296             for( i=0; i < nCount; i++ )
 297             {
 298                 TextColumn& rColumn =
 299                     maColumns[static_cast<sal_uInt16>(i)]->getTextColumn();
 300                 if( rColumn.Width == 0 )
 301                 {
 302                     rColumn.Width = nColWidth;
 303                     nRelWidth += rColumn.Width;
 304                     if( 0 == --nColumnsWithWidth )
 305                         break;
 306                 }
 307             }
 308         }
 309
 310         Sequence< TextColumn > aColumns( static_cast<sal_Int32>(nCount) );
 311         TextColumn *pTextColumns = aColumns.getArray();
 312         for( i=0; i < nCount; i++ )
 313             *pTextColumns++ = maColumns[static_cast<sal_uInt16>(i)]->getTextColumn();
 314
 315         xColumns->setColumns( aColumns );
 316     }
 317     else
 318     {
 319         // only set column count (and let the columns be distributed
 320         // automatically)
 321
 322         xColumns->setColumnCount( nCount );
 323     }
 324
 325     Reference < XPropertySet > xPropSet( xColumns, UNO_QUERY );
 326     if( xPropSet.is() )
 327     {
 328         bool bOn = mxColumnSep != nullptr;
 329
 330         xPropSet->setPropertyValue( gsSeparatorLineIsOn, Any(bOn) );
 331
 332         if( mxColumnSep.is() )
 333         {
 334             if( mxColumnSep->GetWidth() )
 335             {
 336                 xPropSet->setPropertyValue( gsSeparatorLineWidth, Any(mxColumnSep->GetWidth()) );
 337             }
 338             if( mxColumnSep->GetHeight() )
 339             {
 340                 xPropSet->setPropertyValue( gsSeparatorLineRelativeHeight,
 341                                             Any(mxColumnSep->GetHeight()) );
 342             }
 343             if ( mxColumnSep->GetStyle() )
 344             {
 345                 xPropSet->setPropertyValue( gsSeparatorLineStyle, Any(mxColumnSep->GetStyle()) );
 346             }
 347
 348             xPropSet->setPropertyValue( gsSeparatorLineColor, Any(mxColumnSep->GetColor()) );
 349
 350             xPropSet->setPropertyValue( gsSeparatorLineVerticalAlignment, Any(mxColumnSep->GetVertAlign()) );
 351         }
 352
 353         // handle 'automatic columns': column distance
 354         if( bAutomatic )
 355         {
 356             xPropSet->setPropertyValue( gsAutomaticDistance, Any(nAutomaticDistance) );
 357         }
 358     }
 359
 360     aProp.maValue <<= xColumns;
 361
 362     SetInsert( true );
 363     XMLElementPropertyContext::endFastElement(nElement);
 364
 365 }
 366
 367 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */