office-gobmx/slideshow/source/inc/activitiesfactory.hxx
Stephan Bergmann 7e403195e5 Introduce o3tl::optional as an alias for std::optional
...with a boost::optional fallback for Xcode < 10 (as std::optional is only
available starting with Xcode 10 according to
<https://en.cppreference.com/w/cpp/compiler_support>, and our baseline for iOS
and macOS is still Xcode 9.3 according to README.md).  And mechanically rewrite
all code to use o3tl::optional instead of boost::optional.

One immediate benefit is that disabling -Wmaybe-uninitialized for GCC as per
fed7c3deb3 "Slience bogus
-Werror=maybe-uninitialized" should no longer be necessary (and whose check
happened to no longer trigger for GCC 10 trunk, even though that compiler would
still emit bogus -Wmaybe-uninitialized for uses of boost::optional under
--enable-optimized, which made me ponder whether this switch from
boost::optional to std::optional would be a useful thing to do; I keep that
configure.ac check for now, though, and will only remove it in a follow up
commit).

Another longer-term benefit is that the code is now already in good shape for an
eventual switch to std::optional (a switch we would have done anyway once we no
longer need to support Xcode < 10).

Only desktop/qa/desktop_lib/test_desktop_lib.cxx heavily uses
boost::property_tree::ptree::get_child_optional returning boost::optional, so
let it keep using boost::optional for now.

After a number of preceding commits have paved the way for this change, this
commit is completely mechanical, done with

> git ls-files -z | grep -vz -e '^bin/find-unneeded-includes$' -e '^configure.ac$' -e '^desktop/qa/desktop_lib/test_desktop_lib.cxx$' -e '^dictionaries$' -e '^external/' -e '^helpcontent2$' -e '^include/IwyuFilter_include.yaml$' -e '^sc/IwyuFilter_sc.yaml$' -e '^solenv/gdb/boost/optional.py$' -e '^solenv/vs/LibreOffice.natvis$' -e '^translations$' -e '\.svg$' | xargs -0 sed -i -E -e 's|\<boost(/optional)?/optional\.hpp\>|o3tl/optional.hxx|g' -e 's/\<boost(\s*)::(\s*)(make_)?optional\>/o3tl\1::\2\3optional/g' -e 's/\<boost(\s*)::(\s*)none\>/o3tl\1::\2nullopt/g'

(before committing include/o3tl/optional.hxx, and relying on some GNU features).
It excludes some files where mention of boost::optional et al should apparently
not be changed (and the sub-repo directory stubs).  It turned out that all uses
of boost::none across the code base were in combination with boost::optional, so
had all to be rewritten as o3tl::nullopt.

Change-Id: Ibfd9f4b3d5a8aee6e6eed310b988c4e5ffd8b11b
Reviewed-on: https://gerrit.libreoffice.org/84128
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
2019-12-01 14:57:16 +01:00

313 lines
11 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 .
*/
#ifndef INCLUDED_SLIDESHOW_SOURCE_INC_ACTIVITIESFACTORY_HXX
#define INCLUDED_SLIDESHOW_SOURCE_INC_ACTIVITIESFACTORY_HXX
#include <com/sun/star/animations/XAnimate.hpp>
#include <com/sun/star/animations/XAnimateColor.hpp>
#include "animationactivity.hxx"
#include "activitiesqueue.hxx"
#include "event.hxx"
#include "eventqueue.hxx"
#include "shape.hxx"
#include "numberanimation.hxx"
#include "enumanimation.hxx"
#include "coloranimation.hxx"
#include "hslcoloranimation.hxx"
#include "stringanimation.hxx"
#include "boolanimation.hxx"
#include "pairanimation.hxx"
#include <o3tl/optional.hxx>
/* Definition of ActivitiesFactory class */
namespace slideshow {
namespace internal {
namespace ActivitiesFactory
{
/// Collection of common factory parameters
struct CommonParameters
{
CommonParameters(
const EventSharedPtr& rEndEvent,
EventQueue& rEventQueue,
ActivitiesQueue& rActivitiesQueue,
double nMinDuration,
sal_uInt32 nMinNumberOfFrames,
bool bAutoReverse,
::o3tl::optional<double> const& aRepeats,
double nAcceleration,
double nDeceleration,
const ShapeSharedPtr& rShape,
const ::basegfx::B2DVector& rSlideBounds )
: mpEndEvent( rEndEvent ),
mrEventQueue( rEventQueue ),
mrActivitiesQueue( rActivitiesQueue ),
mnMinDuration( nMinDuration ),
mnMinNumberOfFrames( nMinNumberOfFrames ),
maRepeats( aRepeats ),
mnAcceleration( nAcceleration ),
mnDeceleration( nDeceleration ),
mpShape( rShape ),
maSlideBounds( rSlideBounds ),
mbAutoReverse( bAutoReverse ) {}
/// End event to fire when animation is over
EventSharedPtr mpEndEvent;
/// Event queue to insert the end event into.
EventQueue& mrEventQueue;
/// Event queue to insert the end event into.
ActivitiesQueue& mrActivitiesQueue;
/** Simple duration of the activity
Specifies the minimal simple duration of the
activity (minimal, because mnMinNumberOfFrames
might prolong the activity). According to SMIL,
this might also be indefinite, which for our
framework does not make much sense, though
(wouldn't have a clue, then, how to scale the
animation over time).
*/
double const mnMinDuration;
/** Minimal number of frames for this activity.
This specifies the minimal number of frames this
activity will display per simple duration. If less
than this number are displayed until mnMinDuration
is over, the activity will be prolonged until
mnMinNumberOfFrames are rendered.
*/
sal_uInt32 const mnMinNumberOfFrames;
/** Number of repeats for the simple duration
This specified the number of repeats. The
mnMinDuration times maRepeats yields the total
duration of this activity. If this value is
unspecified, the activity will repeat
indefinitely.
*/
::o3tl::optional<double> const maRepeats;
/// Fraction of simple time to accelerate animation
double const mnAcceleration;
/// Fraction of simple time to decelerate animation
double const mnDeceleration;
/// Shape, to get bounds from
ShapeSharedPtr mpShape;
/// LayerManager, to get page size from
::basegfx::B2DVector maSlideBounds;
/// When true, activity is played reversed after mnDuration.
bool const mbAutoReverse;
};
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a double value.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const NumberAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a double value.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const EnumAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a color value.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const ColorAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a color value.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const HSLColorAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimateColor >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a pair of double values.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const PairAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a string.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const StringAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create an activity from an XAnimate node.
This method creates an animated activity from the
given XAnimate node, extracting all necessary
animation parameters from that. Note that due to the
animator parameter, the animation values must be
convertible to a bool value.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param xNode
The SMIL animation node to animate
*/
AnimationActivitySharedPtr createAnimateActivity(
const CommonParameters& rParms,
const BoolAnimationSharedPtr& rAnimator,
const css::uno::Reference< css::animations::XAnimate >& xNode );
/** Create a simple activity for the given animator
This method is suited to create activities for custom
animations, which need a simple double value and lasts
a given timespan. This activity always generates values
from the [0,1] range.
@param rParms
Factory parameter structure
@param rAnimator
Animator sub-object
@param bDirectionForward
If true, the activity goes 'forward', i.e. from 0 to
1. With false, the direction is reversed.
*/
AnimationActivitySharedPtr createSimpleActivity(
const CommonParameters& rParms,
const NumberAnimationSharedPtr& rAnimator,
bool bDirectionForward );
}
} // namespace internal
} // namespace presentation
#endif // INCLUDED_SLIDESHOW_SOURCE_INC_ACTIVITIESFACTORY_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */