LibreOffice Module xmloff (master)  1
XMLShapeStyleContext.cxx
Go to the documentation of this file.
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 <tools/debug.hxx>
21 #include <sal/log.hxx>
24 #include <xmloff/contextid.hxx>
25 #include <com/sun/star/drawing/XControlShape.hpp>
26 #include <com/sun/star/beans/XPropertySet.hpp>
27 #include <com/sun/star/beans/XPropertySetInfo.hpp>
28 #include <com/sun/star/lang/IllegalArgumentException.hpp>
29 #include <com/sun/star/container/XIndexReplace.hpp>
30 #include <xmloff/xmlimp.hxx>
31 #include <xmloff/xmlnumi.hxx>
32 #include <xmloff/xmlnamespace.hxx>
33 #include <xmloff/xmlprmap.hxx>
34 #include <xmloff/xmltoken.hxx>
35 #include <xmloff/xmlerror.hxx>
36 #include <xmloff/maptype.hxx>
37 #include <xmloff/xmlimppr.hxx>
38 
39 #include <xmlsdtypes.hxx>
40 
41 using namespace ::com::sun::star;
42 using namespace ::com::sun::star::uno;
43 using namespace ::com::sun::star::beans;
44 using namespace ::com::sun::star::drawing;
49 
50 
52  SvXMLImport& rImport,
53  SvXMLStylesContext& rStyles,
54  XmlStyleFamily nFamily)
55 : XMLPropStyleContext(rImport, rStyles, nFamily ),
56  m_bIsNumRuleAlreadyConverted( false )
57 {
58 }
59 
61 {
62 }
63 
64 void XMLShapeStyleContext::SetAttribute( sal_uInt16 nPrefixKey, const OUString& rLocalName, const OUString& rValue )
65 {
67  {
69  }
70  else if( (XML_NAMESPACE_STYLE == nPrefixKey) && IsXMLToken( rLocalName, ::xmloff::token::XML_LIST_STYLE_NAME ) )
71  {
73  }
74  else
75  {
76  XMLPropStyleContext::SetAttribute( nPrefixKey, rLocalName, rValue );
77 
78  if( (XML_NAMESPACE_STYLE == nPrefixKey) &&
79  ( IsXMLToken( rLocalName, ::xmloff::token::XML_NAME ) || IsXMLToken( rLocalName, ::xmloff::token::XML_DISPLAY_NAME ) ) )
80  {
81  if( !GetName().isEmpty() && !GetDisplayName().isEmpty() && GetName() != GetDisplayName() )
82  {
83  GetImport().
84  AddStyleDisplayName( GetFamily(), GetName(), GetDisplayName() );
85  }
86  }
87  }
88 }
89 
90 css::uno::Reference< css::xml::sax::XFastContextHandler > XMLShapeStyleContext::createFastChildContext(
91  sal_Int32 nElement,
92  const css::uno::Reference< css::xml::sax::XFastAttributeList >& xAttrList )
93 {
94  SvXMLImportContextRef xContext;
95 
96  if( IsTokenInNamespace(nElement, XML_NAMESPACE_STYLE) ||
98  {
99  sal_Int32 nLocalName = nElement & TOKEN_MASK;
100  sal_uInt32 nFamily = 0;
101  if( nLocalName == XML_TEXT_PROPERTIES )
102  nFamily = XML_TYPE_PROP_TEXT;
103  else if( nLocalName == XML_PARAGRAPH_PROPERTIES )
104  nFamily = XML_TYPE_PROP_PARAGRAPH;
105  else if( nLocalName == XML_GRAPHIC_PROPERTIES )
106  nFamily = XML_TYPE_PROP_GRAPHIC;
107  if( nFamily )
108  {
111  if( xImpPrMap.is() )
112  return new XMLShapePropertySetContext( GetImport(), nElement, xAttrList,
113  nFamily,
114  GetProperties(),
115  xImpPrMap );
116  }
117  }
118 
119  return XMLPropStyleContext::createFastChildContext( nElement, xAttrList );
120 }
121 
123 {
125  {
127 
128  // for compatibility to beta files, search for CTF_SD_NUMBERINGRULES_NAME to
129  // import numbering rules from the style:properties element
130  const rtl::Reference< XMLPropertySetMapper >&rMapper = GetStyles()->GetImportPropertyMapper( GetFamily() )->getPropertySetMapper();
131 
132  ::std::vector< XMLPropertyState > &rProperties = GetProperties();
133  ::std::vector< XMLPropertyState >::iterator end( rProperties.end() );
134 
135  // first, look for the old format, where we had a text:list-style-name
136  // attribute in the style:properties element
137  auto property = std::find_if(rProperties.begin(), end, [&rMapper](XMLPropertyState& rProp) {
138  // find properties with context
139  return (rProp.mnIndex != -1) && (rMapper->GetEntryContextId( rProp.mnIndex ) == CTF_SD_NUMBERINGRULES_NAME); });
140 
141  // if we did not find an old list-style-name in the properties, and we need one
142  // because we got a style:list-style attribute in the style-style element
143  // we generate one
144  if( (property == end) && ( !m_sListStyleName.isEmpty() ) )
145  {
146  sal_Int32 nIndex = rMapper->FindEntryIndex( CTF_SD_NUMBERINGRULES_NAME );
147  SAL_WARN_IF( -1 == nIndex, "xmloff", "can't find numbering rules property entry, can't set numbering rule!" );
148 
149  XMLPropertyState aNewState( nIndex );
150  rProperties.push_back( aNewState );
151  end = rProperties.end();
152  property = end - 1;
153  }
154 
155  // so, if we have an old or a new list style name, we set its value to
156  // a numbering rule
157  if( property != end )
158  {
159  if( m_sListStyleName.isEmpty() )
160  {
161  property->maValue >>= m_sListStyleName;
162  }
163 
164  const SvxXMLListStyleContext *pListStyle = GetImport().GetTextImport()->FindAutoListStyle( m_sListStyleName );
165 
166  SAL_WARN_IF( !pListStyle, "xmloff", "list-style not found for shape style" );
167  if( pListStyle )
168  {
169  uno::Reference< container::XIndexReplace > xNumRule( SvxXMLListStyleContext::CreateNumRule( GetImport().GetModel() ) );
170  pListStyle->FillUnoNumRule(xNumRule);
171  property->maValue <<= xNumRule;
172  }
173  else
174  {
175  property->mnIndex = -1;
176  }
177  }
178  }
179 
180  struct ContextID_Index_Pair aContextIDs[] =
181  {
182  { CTF_DASHNAME , -1 },
183  { CTF_LINESTARTNAME , -1 },
184  { CTF_LINEENDNAME , -1 },
185  { CTF_FILLGRADIENTNAME, -1 },
186  { CTF_FILLTRANSNAME , -1 },
187  { CTF_FILLHATCHNAME , -1 },
188  { CTF_FILLBITMAPNAME , -1 },
193  { -1, -1 }
194  };
195  static const XmlStyleFamily aFamilies[] =
196  {
204  };
205 
208  SAL_WARN_IF( !xImpPrMap.is(), "xmloff", "There is the import prop mapper" );
209  if( xImpPrMap.is() )
210  xImpPrMap->FillPropertySet( GetProperties(), rPropSet, aContextIDs );
211 
212  Reference< XPropertySetInfo > xInfo;
213  // get property set mapper
214  rtl::Reference<XMLPropertySetMapper> xPropMapper( xImpPrMap->getPropertySetMapper() );
215 
216  for( sal_uInt16 i=0; aContextIDs[i].nContextID != -1; i++ )
217  {
218  sal_Int32 nIndex = aContextIDs[i].nIndex;
219  if( nIndex != -1 ) switch( aContextIDs[i].nContextID )
220  {
221  case CTF_DASHNAME:
222  case CTF_LINESTARTNAME:
223  case CTF_LINEENDNAME:
225  case CTF_FILLTRANSNAME:
226  case CTF_FILLHATCHNAME:
227  case CTF_FILLBITMAPNAME:
228  {
229  struct XMLPropertyState& rState = GetProperties()[nIndex];
230  OUString sStyleName;
231  rState.maValue >>= sStyleName;
232  sStyleName = GetImport().GetStyleDisplayName( aFamilies[i], sStyleName );
233  // All of these attributes refer to something with draw:name
234  // of type styleName = NCName which is non-empty.
235  // tdf#89802: for Writer frames there would be no exception here but
236  // it will fail later on attach() and take out the entire frame
237  if (sStyleName.isEmpty() &&
238  ( CTF_FILLGRADIENTNAME == aContextIDs[i].nContextID
239  || CTF_FILLTRANSNAME == aContextIDs[i].nContextID
240  || CTF_FILLHATCHNAME == aContextIDs[i].nContextID
241  || CTF_FILLBITMAPNAME == aContextIDs[i].nContextID))
242  {
243  Sequence<OUString> const seq{ sStyleName };
246  seq, "empty style name reference", nullptr );
247  break;
248  }
249 
250  try
251  {
252 
253  // set property
254  const OUString& rPropertyName = xPropMapper->GetEntryAPIName(rState.mnIndex);
255  if( !xInfo.is() )
256  xInfo = rPropSet->getPropertySetInfo();
257  if ( xInfo->hasPropertyByName( rPropertyName ) )
258  {
259  rPropSet->setPropertyValue( rPropertyName, Any( sStyleName ) );
260  }
261  }
262  catch ( const css::lang::IllegalArgumentException& e )
263  {
264  Sequence<OUString> aSeq { sStyleName };
267  aSeq, e.Message, nullptr );
268  }
269  break;
270  }
275  {
276  struct XMLPropertyState& rState = GetProperties()[nIndex];
277  const OUString& rPropertyName = xPropMapper->GetEntryAPIName(rState.mnIndex);
278  try
279  {
280  if( !xInfo.is() )
281  xInfo = rPropSet->getPropertySetInfo();
282  if ( xInfo->hasPropertyByName( rPropertyName ) )
283  {
284  rPropSet->setPropertyValue( rPropertyName, rState.maValue );
285  }
286  }
287  catch ( const css::lang::IllegalArgumentException& e )
288  {
292  aSeq, e.Message, nullptr );
293  }
294  break;
295  }
296  }
297  }
298 
299  if (m_sControlDataStyleName.isEmpty())
300  return;
301 
302  // we had a data-style-name attribute
303 
304  // set the formatting on the control model of the control shape
305  uno::Reference< drawing::XControlShape > xControlShape(rPropSet, uno::UNO_QUERY);
306  DBG_ASSERT(xControlShape.is(), "XMLShapeStyleContext::FillPropertySet: data style for a non-control shape!");
307  if (xControlShape.is())
308  {
309  uno::Reference< beans::XPropertySet > xControlModel(xControlShape->getControl(), uno::UNO_QUERY);
310  DBG_ASSERT(xControlModel.is(), "XMLShapeStyleContext::FillPropertySet: no control model for the shape!");
311  if (xControlModel.is())
312  {
313  GetImport().GetFormImport()->applyControlNumberStyle(xControlModel, m_sControlDataStyleName);
314  }
315  }
316 }
317 
318 void XMLShapeStyleContext::Finish( bool /*bOverwrite*/ )
319 {
320 }
321 
322 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
sal_Int16 nContextID
Definition: xmlimppr.hxx:58
XmlStyleFamily GetFamily() const
Definition: xmlstyle.hxx:104
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext(sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
Definition: prstylei.cxx:176
bool IsXMLToken(const OUString &rString, enum XMLTokenEnum eToken)
compare eToken to the string
Definition: xmltoken.cxx:3434
sal_Int32 nIndex
rtl::Reference< ::xmloff::OFormLayerXMLImport > const & GetFormImport()
Definition: xmlimp.hxx:616
virtual ~XMLShapeStyleContext() override
#define CTF_LINEENDNAME
Definition: xmlsdtypes.hxx:137
void FillUnoNumRule(const css::uno::Reference< css::container::XIndexReplace > &rNumRule) const
Definition: xmlnumi.cxx:957
SvXMLImport & GetImport()
Definition: xmlictxt.hxx:62
virtual void SetAttribute(sal_uInt16 nPrefixKey, const OUString &rLocalName, const OUString &rValue) override
Definition: prstylei.cxx:57
sal_Int32 mnIndex
Definition: maptype.hxx:124
constexpr sal_uInt16 XML_NAMESPACE_LO_EXT
virtual css::uno::Reference< css::xml::sax::XFastContextHandler > SAL_CALL createFastChildContext(sal_Int32 nElement, const css::uno::Reference< css::xml::sax::XFastAttributeList > &AttrList) override
#define CTF_FILLGRADIENTNAME
Definition: xmlsdtypes.hxx:138
#define CTF_FILLTRANSNAME
Definition: xmlsdtypes.hxx:141
rtl::Reference< XMLTextImportHelper > const & GetTextImport()
Definition: xmlimp.hxx:592
css::uno::Any const & rValue
Definition: ImageStyle.hxx:38
XmlStyleFamily
Definition: families.hxx:47
#define CTF_FILLBITMAPNAME
Definition: xmlsdtypes.hxx:140
#define XML_TYPE_PROP_PARAGRAPH
Definition: xmltypes.hxx:99
#define XMLERROR_FLAG_WARNING
Definition: xmlerror.hxx:35
static css::uno::Reference< css::container::XIndexReplace > CreateNumRule(const css::uno::Reference< css::frame::XModel > &rModel)
Definition: xmlnumi.cxx:1101
#define CTF_SD_OLE_VIS_AREA_IMPORT_TOP
Definition: xmlsdtypes.hxx:169
#define CTF_SD_OLE_VIS_AREA_IMPORT_HEIGHT
Definition: xmlsdtypes.hxx:171
virtual rtl::Reference< SvXMLImportPropertyMapper > GetImportPropertyMapper(XmlStyleFamily nFamily) const
Definition: xmlstyle.cxx:530
#define XMLERROR_STYLE_PROP_VALUE
Definition: xmlerror.hxx:68
#define DBG_ASSERT(sCon, aError)
const OUString & GetDisplayName() const
Definition: xmlstyle.hxx:99
int i
#define CTF_SD_OLE_VIS_AREA_IMPORT_WIDTH
Definition: xmlsdtypes.hxx:170
::std::vector< XMLPropertyState > & GetProperties()
Definition: prstylei.hxx:81
#define XML_TYPE_PROP_TEXT
Definition: xmltypes.hxx:98
#define CTF_FILLHATCHNAME
Definition: xmlsdtypes.hxx:139
enumrange< T >::Iterator end(enumrange< T >)
#define CTF_LINESTARTNAME
Definition: xmlsdtypes.hxx:136
virtual void SetAttribute(sal_uInt16 nPrefixKey, const OUString &rLocalName, const OUString &rValue) override
virtual void Finish(bool bOverwrite) override
css::uno::Any maValue
Definition: maptype.hxx:125
constexpr bool IsTokenInNamespace(sal_Int32 nToken, sal_uInt16 nNamespacePrefix)
Definition: xmlimp.hxx:101
OUString GetStyleDisplayName(XmlStyleFamily nFamily, const OUString &rName) const
Definition: xmlimp.cxx:1469
#define SAL_WARN_IF(condition, area, stream)
const OUString & GetName() const
Definition: xmlstyle.hxx:98
const OUString & GetXMLToken(enum XMLTokenEnum eToken)
return the OUString representation for eToken
Definition: xmltoken.cxx:3378
#define XML_TYPE_PROP_GRAPHIC
Definition: xmltypes.hxx:94
#define CTF_DASHNAME
Definition: xmlsdtypes.hxx:135
XMLShapeStyleContext(SvXMLImport &rImport, SvXMLStylesContext &rStyles, XmlStyleFamily nFamily)
#define CTF_SD_OLE_VIS_AREA_IMPORT_LEFT
Definition: xmlsdtypes.hxx:168
Smart struct to transport an Any with an index to the appropriate property-name.
Definition: maptype.hxx:122
void SetError(sal_Int32 nId, const css::uno::Sequence< OUString > &rMsgParams, const OUString &rExceptionMessage, const css::uno::Reference< css::xml::sax::XLocator > &rLocator)
Record an error condition that occurred during import.
Sequence< sal_Int8 > aSeq
SvXMLStylesContext * GetStyles()
Definition: prstylei.hxx:80
This struct is used as an optional parameter to the static _FillPropertySet() methods.
Definition: xmlimppr.hxx:56
constexpr sal_Int32 TOKEN_MASK
Definition: xmlimp.hxx:91
virtual void FillPropertySet(const css::uno::Reference< css::beans::XPropertySet > &rPropSet) override
constexpr sal_uInt16 XML_NAMESPACE_STYLE
#define CTF_SD_NUMBERINGRULES_NAME
Definition: contextid.hxx:36