summaryrefslogtreecommitdiff
path: root/slideshow/source/engine/animationnodes/nodetools.cxx
blob: e24bcb105056258319b81cf4d5637263f27b9fee (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
/*************************************************************************
 *
 *  $RCSfile: nodetools.cxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: kz $ $Date: 2005-01-21 17:06:19 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (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.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

// must be first
#include <canvas/debug.hxx>
#include <canvas/verbosetrace.hxx>

#ifndef _COM_SUN_STAR_ANIMATIONS_TIMING_HPP_
#include <com/sun/star/animations/Timing.hpp>
#endif

#include <tools.hxx>
#include <nodetools.hxx>


using namespace ::com::sun::star;

namespace presentation
{
    namespace internal
    {
#if defined(VERBOSE) && defined(DBG_UTIL)
        int& debugGetCurrentOffset()
        {
            static int lcl_nOffset = 0; // to make each tree output distinct

            return lcl_nOffset;
        }

        void debugNodesShowTree( const BaseNode* pNode )
        {
            if( pNode )
                pNode->showState();

            ++debugGetCurrentOffset();
        }

        void debugNodesShowTreeWithin( const BaseNode* pNode )
        {
            if( pNode )
                pNode->showTreeFromWithin();

            ++debugGetCurrentOffset();
        }
#endif

        namespace
        {
            /// helper for generateSubsets
            void recursiveDocTreeTraversal( DocTreeNode::VectorOfDocTreeNodes&  o_rOutput,
                                            const DocTreeNode&                  rNode,
                                            DocTreeNode::NodeType               eWantedType )
            {
                if( rNode.getType() == eWantedType )
                {
                    // don't copy whole node (which might contain children
                    // and subchildren)
                    o_rOutput.push_back( DocTreeNode( rNode.getStartIndex(),
                                                      rNode.getEndIndex(),
                                                      rNode.getType() ) );

                    return;
                }

                const int nNumNodes( rNode.getNumberOfChildren() );
                int nCurrNode;
                for( nCurrNode=0; nCurrNode<nNumNodes; ++nCurrNode )
                {
                    recursiveDocTreeTraversal( o_rOutput,
                                               rNode.getChild( nCurrNode ),
                                               eWantedType );
                }
            }

            /** helper for generateSubsets

                This method only extracts children of the given
                paragraph node index (nPara). This is for iterations
                with a ParagraphTarget target attribute, where the
                iteration is to be applied only to the selected
                paragraph number.
            */
            void recursiveDocTreeTraversal( DocTreeNode::VectorOfDocTreeNodes&  o_rOutput,
                                            const DocTreeNode&                  rNode,
                                            DocTreeNode::NodeType               eWantedType,
                                            sal_Int32                           nPara )
            {
                if( rNode.getType() == eWantedType )
                {
                    // don't copy whole node (which might contain children
                    // and subchildren)
                    o_rOutput.push_back( DocTreeNode( rNode.getStartIndex(),
                                                      rNode.getEndIndex(),
                                                      rNode.getType() ) );

                    return;
                }

                const int nNumNodes( rNode.getNumberOfChildren() );
                int nCurrNode;
                for( nCurrNode=0; nCurrNode<nNumNodes; ++nCurrNode )
                {
                    const DocTreeNode& rCurrNode( rNode.getChild( nCurrNode ) );

                    if( rCurrNode.getType() != DocTreeNode::NODETYPE_LOGICAL_PARAGRAPH )
                    {
                        // skip all paragraph _not_ equal to given index
                        recursiveDocTreeTraversal( o_rOutput,
                                                   rCurrNode,
                                                   eWantedType,
                                                   nPara );
                    }
                    else if( nCurrNode == nPara )
                    {
                        recursiveDocTreeTraversal( o_rOutput,
                                                   rCurrNode,
                                                   eWantedType,
                                                   nPara );
                        return; // done
                    }
                }
            }
        }

        AttributableShapeSharedPtr lookupAttributableShape( const LayerManagerSharedPtr&                rLayerManager,
                                                            const uno::Reference< drawing::XShape >&    xShape          )
        {
            ShapeSharedPtr pShape( rLayerManager->lookupShape( xShape ) );

            ENSURE_AND_THROW( pShape.get(),
                              "lookupAttributableShape(): no shape found for given XShape" );

            AttributableShapeSharedPtr pRes(
                ::boost::dynamic_pointer_cast< AttributableShape >( pShape ) );

            // TODO(E3): Cannot throw here, people might set animation info
            // for non-animatable shapes from the API. AnimationNodes must catch
            // the exception and handle that differently
            ENSURE_AND_THROW( pRes.get(),
                              "lookupAttributableShape(): shape found does not implement AttributableShape interface" );

            return pRes;
        }

        void generateSubsets( DocTreeNode::VectorOfDocTreeNodes&    o_rOutput,
                              const AttributableShapeSharedPtr&     pShape,
                              DocTreeNode::NodeType                 eNodeType )
        {
            ENSURE_AND_THROW( pShape.get(),
                              "generateSubsets(): Invalid Shape");

            const int nNumNodes( pShape->getNumberOfTreeNodes() );
            for( int nCurrNode=0; nCurrNode<nNumNodes; ++nCurrNode )
            {
                recursiveDocTreeTraversal( o_rOutput,
                                           DocTreeNode::isLogicalNodeType( eNodeType ) ?
                                           pShape->getLogicalDocTreeNode( nCurrNode ) :
                                           pShape->getFormattingDocTreeNode( nCurrNode ),
                                           eNodeType );
            }
        }

        void generateSubsets( DocTreeNode::VectorOfDocTreeNodes&    o_rOutput,
                              const AttributableShapeSharedPtr&     pShape,
                              DocTreeNode::NodeType                 eNodeType,
                              sal_Int32                             nPara )
        {
            ENSURE_AND_THROW( pShape.get(),
                              "generateSubsets(): Invalid Shape");

            const int nNumNodes( pShape->getNumberOfTreeNodes() );
            for( int nCurrNode=0; nCurrNode<nNumNodes; ++nCurrNode )
            {
                recursiveDocTreeTraversal( o_rOutput,
                                           DocTreeNode::isLogicalNodeType( eNodeType ) ?
                                           pShape->getLogicalDocTreeNode( nCurrNode ) :
                                           pShape->getFormattingDocTreeNode( nCurrNode ),
                                           eNodeType,
                                           nPara );
            }
        }

        bool isIndefiniteTiming( const uno::Any& rAny )
        {
            if( !rAny.hasValue() )
                return true;

            animations::Timing eTiming;

            if( !(rAny >>= eTiming) ||
                eTiming != animations::Timing_INDEFINITE )
            {
                return false;
            }

            return true;
        }

        /// Extract the node type from the user data
        bool getNodeType( sal_Int16&                                            o_rNodeType,
                          const uno::Sequence< beans::NamedValue >&             rValues )
        {
            beans::NamedValue aNamedValue;

            if( findNamedValue( &aNamedValue,
                                rValues,
                                ::rtl::OUString( RTL_CONSTASCII_USTRINGPARAM("node-type") ) ) )
            {
                if( (aNamedValue.Value >>= o_rNodeType) )
                    return true;
            }

            return false;
        }
    }
}