Files
libreoffice/xmloff/source/text/XMLTextMasterPageContext.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

298 lines
9.8 KiB
C++

/* -*- 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 <com/sun/star/style/XStyle.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/style/PageStyleLayout.hpp>
#include <com/sun/star/beans/XMultiPropertyStates.hpp>
#include <o3tl/any.hxx>
#include <osl/diagnose.h>
#include <xmloff/nmspmap.hxx>
#include <xmloff/xmlnmspe.hxx>
#include <xmloff/xmltoken.hxx>
#include <xmloff/XMLTextMasterPageContext.hxx>
#include "XMLTextHeaderFooterContext.hxx"
#include <xmloff/xmlimp.hxx>
#include "PageMasterImportContext.hxx"
using namespace ::com::sun::star;
using namespace ::com::sun::star::uno;
using namespace ::com::sun::star::xml::sax;
using namespace ::com::sun::star::style;
using namespace ::com::sun::star::text;
using namespace ::com::sun::star::beans;
using namespace ::com::sun::star::container;
using namespace ::com::sun::star::lang;
using namespace ::xmloff::token;
Reference < XStyle > XMLTextMasterPageContext::Create()
{
Reference < XStyle > xNewStyle;
Reference< XMultiServiceFactory > xFactory( GetImport().GetModel(),
UNO_QUERY );
if( xFactory.is() )
{
Reference < XInterface > xIfc =
xFactory->createInstance("com.sun.star.style.PageStyle");
if( xIfc.is() )
xNewStyle.set( xIfc, UNO_QUERY );
}
return xNewStyle;
}
XMLTextMasterPageContext::XMLTextMasterPageContext( SvXMLImport& rImport,
sal_uInt16 nPrfx, const OUString& rLName,
const Reference< XAttributeList > & xAttrList,
bool bOverwrite )
: SvXMLStyleContext( rImport, nPrfx, rLName, xAttrList, XML_STYLE_FAMILY_MASTER_PAGE )
, sIsPhysical( "IsPhysical" )
, sFollowStyle( "FollowStyle" )
, bInsertHeader( false )
, bInsertFooter( false )
, bInsertHeaderLeft( false )
, bInsertFooterLeft( false )
, bInsertHeaderFirst( false )
, bInsertFooterFirst( false )
, bHeaderInserted( false )
, bFooterInserted( false )
, bHeaderLeftInserted( false )
, bFooterLeftInserted( false )
, bHeaderFirstInserted( false )
, bFooterFirstInserted( false )
{
OUString sName, sDisplayName;
sal_Int16 nAttrCount = xAttrList.is() ? xAttrList->getLength() : 0;
for( sal_Int16 i=0; i < nAttrCount; i++ )
{
const OUString& rAttrName = xAttrList->getNameByIndex( i );
OUString aLocalName;
sal_uInt16 nPrefix = GetImport().GetNamespaceMap().GetKeyByAttrName( rAttrName, &aLocalName );
if( XML_NAMESPACE_STYLE == nPrefix )
{
if( IsXMLToken( aLocalName, XML_NAME ) )
{
sName = xAttrList->getValueByIndex( i );
}
else if( IsXMLToken( aLocalName, XML_DISPLAY_NAME ) )
{
sDisplayName = xAttrList->getValueByIndex( i );
}
else if( IsXMLToken( aLocalName, XML_NEXT_STYLE_NAME ) )
{
sFollow = xAttrList->getValueByIndex( i );
}
else if( IsXMLToken( aLocalName, XML_PAGE_LAYOUT_NAME ) )
{
sPageMasterName = xAttrList->getValueByIndex( i );
}
}
}
if( !sDisplayName.isEmpty() )
{
rImport.AddStyleDisplayName( XML_STYLE_FAMILY_MASTER_PAGE, sName,
sDisplayName );
}
else
{
sDisplayName = sName;
}
if( sDisplayName.isEmpty() )
return;
Reference < XNameContainer > xPageStyles =
GetImport().GetTextImport()->GetPageStyles();
if( !xPageStyles.is() )
return;
Any aAny;
bool bNew = false;
if( xPageStyles->hasByName( sDisplayName ) )
{
aAny = xPageStyles->getByName( sDisplayName );
aAny >>= xStyle;
}
else
{
xStyle = Create();
if( !xStyle.is() )
return;
xPageStyles->insertByName( sDisplayName, Any(xStyle) );
bNew = true;
}
Reference < XPropertySet > xPropSet( xStyle, UNO_QUERY );
Reference< XPropertySetInfo > xPropSetInfo =
xPropSet->getPropertySetInfo();
if( !bNew && xPropSetInfo->hasPropertyByName( sIsPhysical ) )
{
aAny = xPropSet->getPropertyValue( sIsPhysical );
bNew = !*o3tl::doGet<bool>(aAny);
}
SetNew( bNew );
if( bOverwrite || bNew )
{
Reference < XMultiPropertyStates > xMultiStates( xPropSet,
UNO_QUERY );
OSL_ENSURE( xMultiStates.is(),
"text page style does not support multi property set" );
if( xMultiStates.is() )
xMultiStates->setAllPropertiesToDefault();
bInsertHeader = bInsertFooter = true;
bInsertHeaderLeft = bInsertFooterLeft = true;
bInsertHeaderFirst = bInsertFooterFirst = true;
}
}
XMLTextMasterPageContext::~XMLTextMasterPageContext()
{
}
SvXMLImportContext *XMLTextMasterPageContext::CreateChildContext(
sal_uInt16 nPrefix,
const OUString& rLocalName,
const Reference< XAttributeList > & xAttrList )
{
SvXMLImportContext *pContext = nullptr;
const SvXMLTokenMap& rTokenMap =
GetImport().GetTextImport()->GetTextMasterPageElemTokenMap();
bool bInsert = false, bFooter = false, bLeft = false, bFirst = false;
switch( rTokenMap.Get( nPrefix, rLocalName ) )
{
case XML_TOK_TEXT_MP_HEADER:
if( bInsertHeader && !bHeaderInserted )
{
bInsert = true;
bHeaderInserted = true;
}
break;
case XML_TOK_TEXT_MP_FOOTER:
if( bInsertFooter && !bFooterInserted )
{
bInsert = bFooter = true;
bFooterInserted = true;
}
break;
case XML_TOK_TEXT_MP_HEADER_LEFT:
if( bInsertHeaderLeft && bHeaderInserted && !bHeaderLeftInserted )
bInsert = bLeft = true;
break;
case XML_TOK_TEXT_MP_FOOTER_LEFT:
if( bInsertFooterLeft && bFooterInserted && !bFooterLeftInserted )
bInsert = bFooter = bLeft = true;
break;
case XML_TOK_TEXT_MP_HEADER_FIRST:
if( bInsertHeaderFirst && bHeaderInserted && !bHeaderFirstInserted )
bInsert = bFirst = true;
break;
case XML_TOK_TEXT_MP_FOOTER_FIRST:
if( bInsertFooterFirst && bFooterInserted && !bFooterFirstInserted )
bInsert = bFooter = bFirst = true;
break;
}
if( bInsert && xStyle.is() )
{
pContext = CreateHeaderFooterContext( nPrefix, rLocalName,
xAttrList,
bFooter, bLeft, bFirst );
}
else
{
pContext = SvXMLStyleContext::CreateChildContext( nPrefix, rLocalName,
xAttrList );
}
return pContext;
}
SvXMLImportContext *XMLTextMasterPageContext::CreateHeaderFooterContext(
sal_uInt16 nPrefix,
const OUString& rLocalName,
const css::uno::Reference< css::xml::sax::XAttributeList > & xAttrList,
const bool bFooter,
const bool bLeft,
const bool bFirst )
{
Reference < XPropertySet > xPropSet( xStyle, UNO_QUERY );
return new XMLTextHeaderFooterContext( GetImport(),
nPrefix, rLocalName,
xAttrList,
xPropSet,
bFooter, bLeft, bFirst );
}
void XMLTextMasterPageContext::Finish( bool bOverwrite )
{
if( xStyle.is() && (IsNew() || bOverwrite) )
{
Reference < XPropertySet > xPropSet( xStyle, UNO_QUERY );
if( !sPageMasterName.isEmpty() )
{
XMLPropStyleContext* pStyle =
GetImport().GetTextImport()->FindPageMaster( sPageMasterName );
if (pStyle)
{
pStyle->FillPropertySet(xPropSet);
}
}
Reference < XNameContainer > xPageStyles =
GetImport().GetTextImport()->GetPageStyles();
if( !xPageStyles.is() )
return;
Reference< XPropertySetInfo > xPropSetInfo =
xPropSet->getPropertySetInfo();
if( xPropSetInfo->hasPropertyByName( sFollowStyle ) )
{
OUString sDisplayFollow(
GetImport().GetStyleDisplayName(
XML_STYLE_FAMILY_MASTER_PAGE, sFollow ) );
if( sDisplayFollow.isEmpty() ||
!xPageStyles->hasByName( sDisplayFollow ) )
sDisplayFollow = xStyle->getName();
Any aAny = xPropSet->getPropertyValue( sFollowStyle );
OUString sCurrFollow;
aAny >>= sCurrFollow;
if( sCurrFollow != sDisplayFollow )
{
xPropSet->setPropertyValue( sFollowStyle, Any(sDisplayFollow) );
}
}
if ( xPropSetInfo->hasPropertyByName( "Hidden" ) )
{
xPropSet->setPropertyValue( "Hidden", uno::makeAny( IsHidden( ) ) );
}
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */