include/animations/animationnodehelper.hxx

   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 #pragma once
  21
  22 #include <o3tl/any.hxx>
  23 #include <rtl/strbuf.hxx>
  24 #include <sal/log.hxx>
  25 #include <tools/helpers.hxx>
  26
  27 #include <com/sun/star/uno/Any.hxx>
  28 #include <com/sun/star/uno/Reference.hxx>
  29 #include <com/sun/star/animations/XAnimate.hpp>
  30 #include <com/sun/star/animations/XAnimationNode.hpp>
  31 #include <com/sun/star/container/XEnumerationAccess.hpp>
  32 #include <com/sun/star/container/XEnumeration.hpp>
  33 #include <com/sun/star/presentation/ParagraphTarget.hpp>
  34
  35 #include <vector>
  36
  37 /* Declaration and definition of AnimationNode helper */
  38
  39 namespace anim
  40 {
  41     // TODO(Q1): this could possibly be implemented with a somewhat
  42     // more lightweight template, by having the actual worker receive
  43     // only a function pointer, and a thin templated wrapper around
  44     // that which converts member functions into that.
  45
  46     /** pushes the given node to the given vector and recursively calls itself for each child node.
  47     */
  48     inline void create_deep_vector( const css::uno::Reference< css::animations::XAnimationNode >& xNode,
  49                                 std::vector< css::uno::Reference< css::animations::XAnimationNode > >& rVector )
  50     {
  51         rVector.push_back( xNode );
  52
  53         try
  54         {
  55             // get an XEnumerationAccess to the children
  56             css::uno::Reference< css::container::XEnumerationAccess >
  57                   xEnumerationAccess( xNode, css::uno::UNO_QUERY );
  58
  59             if( xEnumerationAccess.is() )
  60             {
  61                 css::uno::Reference< css::container::XEnumeration >
  62                       xEnumeration = xEnumerationAccess->createEnumeration();
  63
  64                 if( xEnumeration.is() )
  65                 {
  66                     while( xEnumeration->hasMoreElements() )
  67                     {
  68                         css::uno::Reference< css::animations::XAnimationNode >
  69                             xChildNode( xEnumeration->nextElement(),
  70                                         css::uno::UNO_QUERY_THROW );
  71
  72                         create_deep_vector( xChildNode, rVector );
  73                     }
  74                 }
  75             }
  76         }
  77         catch( css::uno::Exception& )
  78         {
  79         }
  80     }
  81
  82     inline bool getVisibilityProperty(
  83         const css::uno::Reference< css::animations::XAnimate >& xAnimateNode, bool& bReturn)
  84     {
  85         if( xAnimateNode->getAttributeName().equalsIgnoreAsciiCase("visibility") )
  86         {
  87             bool bVisible( false );
  88             css::uno::Any aAny( xAnimateNode->getTo() );
  89
  90             // try to extract bool value
  91             if( !(aAny >>= bVisible) )
  92             {
  93                 // try to extract string
  94                 OUString aString;
  95                 if( aAny >>= aString )
  96                 {
  97                     // we also take the strings "true" and "false",
  98                     // as well as "on" and "off" here
  99                     if( aString.equalsIgnoreAsciiCase("true") ||
 100                         aString.equalsIgnoreAsciiCase("on") )
 101                     {
 102                         bVisible = true;
 103                     }
 104                     if( aString.equalsIgnoreAsciiCase("false") ||
 105                         aString.equalsIgnoreAsciiCase("off") )
 106                     {
 107                         bVisible = false;
 108                     }
 109                 }
 110             }
 111             bReturn = bVisible;
 112             return true;
 113         }
 114
 115         return false;
 116     }
 117
 118     inline css::uno::Reference<css::uno::XInterface> getParagraphTarget(
 119         const css::presentation::ParagraphTarget& pTarget)
 120     {
 121         try
 122         {
 123             css::uno::Reference<css::container::XEnumerationAccess> xParaEnumAccess(
 124                 pTarget.Shape, css::uno::UNO_QUERY_THROW);
 125
 126             css::uno::Reference<css::container::XEnumeration> xEnumeration(
 127                                                 xParaEnumAccess->createEnumeration(),
 128                                                 css::uno::UNO_SET_THROW);
 129             sal_Int32 nParagraph = pTarget.Paragraph;
 130
 131             while (xEnumeration->hasMoreElements())
 132             {
 133                 css::uno::Reference<css::uno::XInterface> xRef(
 134                     xEnumeration->nextElement(), css::uno::UNO_QUERY);
 135                 if (nParagraph-- == 0)
 136                     return xRef;
 137             }
 138         }
 139         catch (const css::uno::RuntimeException&)
 140         {
 141             SAL_WARN("animations", "getParagraphTarget");
 142         }
 143
 144         css::uno::Reference<css::uno::XInterface> xRef;
 145         return xRef;
 146     }
 147
 148     inline void convertTarget(OStringBuffer& sTmp, const css::uno::Any& rTarget)
 149     {
 150         if (!rTarget.hasValue())
 151             return;
 152
 153         css::uno::Reference<css::uno::XInterface> xRef;
 154         if (!(rTarget >>= xRef))
 155         {
 156             if (auto pt = o3tl::tryAccess<css::presentation::ParagraphTarget>(rTarget))
 157             {
 158                 xRef = getParagraphTarget(*pt);
 159             }
 160         }
 161
 162         SAL_WARN_IF(!xRef.is(), "animations", "convertTarget(), invalid target type!");
 163         if (xRef.is())
 164         {
 165             const std::string aIdentifier(GetInterfaceHash(xRef));
 166             if (!aIdentifier.empty())
 167                 sTmp.append(aIdentifier);
 168         }
 169     }
 170 }
 171
 172 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */