mir/libreoffice
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ecece54942a8e5f20ae6dc69f25a2499d38c78bd
libreoffice/xmloff/source/draw/XMLImageMapExport.cxx
Stephan Bergmann 0d7c582312 New o3tl::try/doGet to obtain value from Any 
...in an attempt to reduce usage of type-unsafe

  void const * css::uno::Any::getValue()

These new functions are often more convenient to use than the existing ">>=" and
Any::get<T>.  Note how they are careful to provide a pointer directly into the
given Any, instead of creating temporaries.

As an example, replaced most calls of getValue across xmloff:

* Cases that first check for a specific type (via getValueType etc.) and then
  call getValue can instead call tryGet.  (But beware that tryGet supports some
  conversions, which a check for a specific type may have missed---either
  intentionally or by accident.  Also beware the somewhat common idiom of
  checking for TypeClass_ENUM and then using getValue to obtain a sal_Int32;
  this cannot be replaced with a call to tryGet.)

* Cases that seem confident that the Any is of the correct type when calling
  getValue (but apparently are confident due to some higher-layer protocol, as
  the surrounding code does not do any checking via getValueType or similar) can
  instead call doGet.  It throws an exception if it turns out the confidence
  wasn't warranted.  (Many of the existing calls that directly dereferenced the
  return value of getValue as sal_Bool look suspicious, in that the author might
  have thought the given code would also cover a VOID Any---which technically it
  even would have happened to do.  If any RuntimeExceptions thrown from these
  doGet calls start to crop up, these changes need to be revisited.  Some may
  even be rewritten as uses of ">>=".  But at least "make check" did not show
  any such problems.  Also note that casting the value obtained from getValue to
  any css::uno::Reference<X> with X being anything but the base
  css::uno::XInterface was always prone to producing a bad pointer, in case the
  interface actually stored in the Any derived from X via multiple inheritance.)

* Should there ever be cases where an Any is known to be of the requested type,
  some additional forceGet could be introduced (which would assert instead of
  throwing an exception).

Change-Id: I2d8739e86314eff73abfcafe01d806f5bc5c34db
2016-06-02 15:33:59 +02:00

348 lines
12 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include "XMLImageMapExport.hxx"
#include <o3tl/any.hxx>
#include <rtl/ustring.hxx>
#include <rtl/ustrbuf.hxx>
#include <tools/debug.hxx>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>
#include <com/sun/star/beans/XPropertySet.hpp>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/container/XIndexContainer.hpp>
#include <com/sun/star/document/XEventsSupplier.hpp>
#include <com/sun/star/awt/Rectangle.hpp>
#include <com/sun/star/awt/Point.hpp>
#include <com/sun/star/awt/Size.hpp>
#include <com/sun/star/drawing/PointSequence.hpp>
#include <xmloff/xmlexp.hxx>
#include <xmloff/xmlnmspe.hxx>
#include <xmloff/xmltoken.hxx>
#include <xmloff/XMLEventExport.hxx>
#include <xmloff/xmluconv.hxx>
#include "xexptran.hxx"
#include <basegfx/polygon/b2dpolygon.hxx>
#include <basegfx/polygon/b2dpolygontools.hxx>
using namespace ::com::sun::star;
using namespace ::xmloff::token;
using ::com::sun::star::uno::Any;
using ::com::sun::star::uno::UNO_QUERY;
using ::com::sun::star::uno::Sequence;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::beans::XPropertySet;
using ::com::sun::star::container::XIndexContainer;
using ::com::sun::star::document::XEventsSupplier;
using ::com::sun::star::lang::XServiceInfo;
using ::com::sun::star::drawing::PointSequence;
XMLImageMapExport::XMLImageMapExport(SvXMLExport& rExp) :
msBoundary("Boundary"),
msCenter("Center"),
msDescription("Description"),
msImageMap("ImageMap"),
msIsActive("IsActive"),
msName("Name"),
msPolygon("Polygon"),
msRadius("Radius"),
msTarget("Target"),
msURL("URL"),
msTitle("Title"),
mrExport(rExp),
mbWhiteSpace(true)
{
}
XMLImageMapExport::~XMLImageMapExport()
{
}
void XMLImageMapExport::Export(
const Reference<XPropertySet> & rPropertySet)
{
if (rPropertySet->getPropertySetInfo()->hasPropertyByName(msImageMap))
{
Any aAny = rPropertySet->getPropertyValue(msImageMap);
Reference<XIndexContainer> aContainer;
aAny >>= aContainer;
Export(aContainer);
}
// else: no ImageMap property -> nothing to do
}
void XMLImageMapExport::Export(
const Reference<XIndexContainer> & rContainer)
{
if (rContainer.is())
{
if (rContainer->hasElements())
{
// image map container element
SvXMLElementExport aImageMapElement(
mrExport, XML_NAMESPACE_DRAW, XML_IMAGE_MAP,
mbWhiteSpace, mbWhiteSpace);
// iterate over image map elements and call ExportMapEntry(...)
// for each
sal_Int32 nLength = rContainer->getCount();
for(sal_Int32 i = 0; i < nLength; i++)
{
Any aAny = rContainer->getByIndex(i);
Reference<XPropertySet> rElement;
aAny >>= rElement;
DBG_ASSERT(rElement.is(), "Image map element is empty!");
if (rElement.is())
{
ExportMapEntry(rElement);
}
}
}
// else: container is empty -> nothing to do
}
// else: no container -> nothing to do
}
void XMLImageMapExport::ExportMapEntry(
const Reference<XPropertySet> & rPropertySet)
{
Reference<XServiceInfo> xServiceInfo(rPropertySet, UNO_QUERY);
if (xServiceInfo.is())
{
enum XMLTokenEnum eType = XML_TOKEN_INVALID;
// distinguish map entries by their service name
Sequence<OUString> sServiceNames =
xServiceInfo->getSupportedServiceNames();
sal_Int32 nLength = sServiceNames.getLength();
for( sal_Int32 i=0; i<nLength; i++ )
{
OUString& rName = sServiceNames[i];
if ( rName == "com.sun.star.image.ImageMapRectangleObject" )
{
eType = XML_AREA_RECTANGLE;
break;
}
else if ( rName == "com.sun.star.image.ImageMapCircleObject" )
{
eType = XML_AREA_CIRCLE;
break;
}
else if ( rName == "com.sun.star.image.ImageMapPolygonObject" )
{
eType = XML_AREA_POLYGON;
break;
}
}
// return from method if no proper service is found!
DBG_ASSERT(XML_TOKEN_INVALID != eType,
"Image map element doesn't support appropriate service!");
if (XML_TOKEN_INVALID == eType)
return;
// now: handle ImageMapObject properties (those for all types)
// XLINK (URL property)
Any aAny = rPropertySet->getPropertyValue(msURL);
OUString sHref;
aAny >>= sHref;
if (!sHref.isEmpty())
{
mrExport.AddAttribute(XML_NAMESPACE_XLINK, XML_HREF, mrExport.GetRelativeReference(sHref));
}
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_TYPE, XML_SIMPLE );
// Target property (and xlink:show)
aAny = rPropertySet->getPropertyValue(msTarget);
OUString sTargt;
aAny >>= sTargt;
if (!sTargt.isEmpty())
{
mrExport.AddAttribute(
XML_NAMESPACE_OFFICE, XML_TARGET_FRAME_NAME, sTargt);
mrExport.AddAttribute(
XML_NAMESPACE_XLINK, XML_SHOW,
sTargt == "_blank" ? XML_NEW : XML_REPLACE );
}
// name
aAny = rPropertySet->getPropertyValue(msName);
OUString sItemName;
aAny >>= sItemName;
if (!sItemName.isEmpty())
{
mrExport.AddAttribute(XML_NAMESPACE_OFFICE, XML_NAME, sItemName);
}
// is-active
aAny = rPropertySet->getPropertyValue(msIsActive);
if (! *o3tl::doGet<bool>(aAny))
{
mrExport.AddAttribute(XML_NAMESPACE_DRAW, XML_NOHREF, XML_NOHREF);
}
// call specific rectangle/circle/... method
// also prepare element name
switch (eType)
{
case XML_AREA_RECTANGLE:
ExportRectangle(rPropertySet);
break;
case XML_AREA_CIRCLE:
ExportCircle(rPropertySet);
break;
case XML_AREA_POLYGON:
ExportPolygon(rPropertySet);
break;
default:
break;
}
// write element
DBG_ASSERT(XML_TOKEN_INVALID != eType,
"No name?! How did this happen?");
SvXMLElementExport aAreaElement(mrExport, XML_NAMESPACE_DRAW, eType,
mbWhiteSpace, mbWhiteSpace);
// title property (as <svg:title> element)
OUString sTitle;
rPropertySet->getPropertyValue(msTitle) >>= sTitle;
if(!sTitle.isEmpty())
{
SvXMLElementExport aEventElemt(mrExport, XML_NAMESPACE_SVG, XML_TITLE, mbWhiteSpace, false);
mrExport.Characters(sTitle);
}
// description property (as <svg:desc> element)
OUString sDescription;
rPropertySet->getPropertyValue(msDescription) >>= sDescription;
if (!sDescription.isEmpty())
{
SvXMLElementExport aDesc(mrExport, XML_NAMESPACE_SVG, XML_DESC, mbWhiteSpace, false);
mrExport.Characters(sDescription);
}
// export events attached to this
Reference<XEventsSupplier> xSupplier(rPropertySet, UNO_QUERY);
mrExport.GetEventExport().Export(xSupplier, mbWhiteSpace);
}
// else: no service info -> can't determine type -> ignore entry
}
void XMLImageMapExport::ExportRectangle(
const Reference<XPropertySet> & rPropertySet)
{
// get boundary rectangle
Any aAny = rPropertySet->getPropertyValue(msBoundary);
awt::Rectangle aRectangle;
aAny >>= aRectangle;
// parameters svg:x, svg:y, svg:width, svg:height
OUStringBuffer aBuffer;
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, aRectangle.X);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_X,
aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, aRectangle.Y);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_Y,
aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer,
aRectangle.Width);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_WIDTH,
aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer,
aRectangle.Height);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_HEIGHT,
aBuffer.makeStringAndClear() );
}
void XMLImageMapExport::ExportCircle(
const Reference<XPropertySet> & rPropertySet)
{
// get boundary rectangle
Any aAny = rPropertySet->getPropertyValue(msCenter);
awt::Point aCenter;
aAny >>= aCenter;
// parameters svg:cx, svg:cy
OUStringBuffer aBuffer;
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, aCenter.X);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_CX,
aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, aCenter.Y);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_CY,
aBuffer.makeStringAndClear() );
// radius
aAny = rPropertySet->getPropertyValue(msRadius);
sal_Int32 nRadius = 0;
aAny >>= nRadius;
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, nRadius);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_R,
aBuffer.makeStringAndClear() );
}
void XMLImageMapExport::ExportPolygon(const Reference<XPropertySet> & rPropertySet)
{
// polygons get exported as bounding box, viewbox, and coordinate
// pair sequence. The bounding box is always the entire image.
// get polygon point sequence
Any aAny = rPropertySet->getPropertyValue(msPolygon);
PointSequence aPoly;
aAny >>= aPoly;
const basegfx::B2DPolygon aPolygon(
basegfx::tools::UnoPointSequenceToB2DPolygon(
aPoly));
const basegfx::B2DRange aPolygonRange(aPolygon.getB2DRange());
// parameters svg:x, svg:y, svg:width, svg:height
OUStringBuffer aBuffer;
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, 0);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_X, aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, 0);
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_Y, aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, basegfx::fround(aPolygonRange.getWidth()));
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_WIDTH, aBuffer.makeStringAndClear() );
mrExport.GetMM100UnitConverter().convertMeasureToXML(aBuffer, basegfx::fround(aPolygonRange.getHeight()));
mrExport.AddAttribute( XML_NAMESPACE_SVG, XML_HEIGHT, aBuffer.makeStringAndClear() );
// svg:viewbox
SdXMLImExViewBox aViewBox(0.0, 0.0, aPolygonRange.getWidth(), aPolygonRange.getHeight());
mrExport.AddAttribute(XML_NAMESPACE_SVG, XML_VIEWBOX, aViewBox.GetExportString());
// export point sequence
const OUString aPointString(
basegfx::tools::exportToSvgPoints(
aPolygon));
mrExport.AddAttribute(XML_NAMESPACE_DRAW, XML_POINTS, aPointString);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in New Issue View Git Blame Copy Permalink