slideshow/source/inc/smilfunctionparser.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: smilfunctionparser.hxx,v $
  10  * $Revision: 1.6 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_SLIDESHOW_SMILFUNCTIONPARSER_HXX
  32 #define INCLUDED_SLIDESHOW_SMILFUNCTIONPARSER_HXX
  33
  34 #include "expressionnode.hxx"
  35 #include "slideshowexceptions.hxx"
  36
  37 #include <basegfx/range/b2drectangle.hxx>
  38
  39 #include <boost/noncopyable.hpp>
  40
  41 namespace rtl
  42 {
  43     class OUString;
  44 }
  45
  46 /* Definition of SmilFunctionParser class */
  47
  48 namespace slideshow
  49 {
  50     namespace internal
  51     {
  52         class SmilFunctionParser : private boost::noncopyable
  53         {
  54         public:
  55             /** Parse a string containing a SMIL value.
  56
  57                 This method parses a string representing
  58                 a fixed value (i.e. a value that does not
  59                 change by time). Due to the dynamic view
  60                 capabilities of the presentation engine,
  61                 this value can sometimes only be determined
  62                 during runtime of the animation (because
  63                 e.g. mixed screen/view coordinates are
  64                 involved), and is thus still returned as an
  65                 ExpressionNode object. An example for
  66                 such a case is the "Width+1.0" string, which
  67                 contains the width of the shape in user
  68                 coordinate space, and the screen width
  69                 in device coordinate space.
  70
  71                 The following grammar is accepted by this method:
  72                 <code>
  73                identifier = 'pi'|'e'|'X'|'Y'|'Width'|'Height'
  74
  75                function = 'abs'|'sqrt'|'sin'|'cos'|'tan'|'atan'|'acos'|'asin'|'exp'|'log'
  76
  77                basic_expression =
  78                                 number |
  79                                 identifier |
  80                                 function '(' additive_expression ')' |
  81                                 '(' additive_expression ')'
  82
  83                unary_expression =
  84                                    '-' basic_expression |
  85                                 basic_expression
  86
  87                multiplicative_expression =
  88                                    unary_expression ( ( '*' unary_expression )* |
  89                                                    ( '/' unary_expression )* )
  90
  91                additive_expression =
  92                                    multiplicative_expression ( ( '+' multiplicative_expression )* |
  93                                                                ( '-' multiplicative_expression )* )
  94
  95                 </code>
  96
  97                 @param rSmilValue
  98                 The string to parse
  99
 100                 @param rRelativeShapeBounds
 101                 The bounds of the shape this SMIL value is to be
 102                 evaluated for. The bounds must be <em>relative</em> to
 103                 the page the shape is part of, i.e. within the [0,1]
 104                 range. This is necessary, since the string might
 105                 contain symbolic references to the shape bounding box.
 106
 107                 @throws ParseError if an invalid expression is given.
 108
 109                 @return the generated function object.
 110              */
 111             static ExpressionNodeSharedPtr parseSmilValue( const ::rtl::OUString&                       rSmilValue,
 112                                                            const ::basegfx::B2DRectangle&       rRelativeShapeBounds ); // throw ParseError
 113
 114             /** Parse a string containing a SMIL function.
 115
 116                 This method parses a string representing
 117                 a possibly time-varying SMIL function.
 118
 119                 The following grammar is accepted by this method:
 120                 <code>
 121                identifier = 't'|'pi'|'e'|'X'|'Y'|'Width'|'Height'
 122
 123                function = 'abs'|'sqrt'|'sin'|'cos'|'tan'|'atan'|'acos'|'asin'|'exp'|'log'
 124
 125                basic_expression =
 126                                 number |
 127                                 identifier |
 128                                 function '(' additive_expression ')' |
 129                                 '(' additive_expression ')'
 130
 131                unary_expression =
 132                                    '-' basic_expression |
 133                                 basic_expression
 134
 135                multiplicative_expression =
 136                                    unary_expression ( ( '*' unary_expression )* |
 137                                                    ( '/' unary_expression )* )
 138
 139                additive_expression =
 140                                    multiplicative_expression ( ( '+' multiplicative_expression )* |
 141                                                                ( '-' multiplicative_expression )* )
 142
 143                 </code>
 144
 145                 @param rSmilFunction
 146                 The string to parse
 147
 148                 @param rRelativeShapeBounds
 149                 The bounds of the shape this SMIL value is to be
 150                 evaluated for. The bounds must be <em>relative</em> to
 151                 the page the shape is part of, i.e. within the [0,1]
 152                 range. This is necessary, since the string might
 153                 contain symbolic references to the shape bounding box.
 154
 155                 @throws ParseError if an invalid expression is given.
 156
 157                 @return the generated function object.
 158              */
 159             static ExpressionNodeSharedPtr parseSmilFunction( const ::rtl::OUString&                    rSmilFunction,
 160                                                               const ::basegfx::B2DRectangle&    rRelativeShapeBounds ); // throw ParseError
 161
 162         private:
 163             // disabled constructor/destructor, since this is
 164             // supposed to be a singleton
 165             SmilFunctionParser();
 166         };
 167     }
 168 }
 169
 170 #endif /* INCLUDED_SLIDESHOW_SMILFUNCTIONPARSER_HXX */