connectivity/source/inc/RowFunctionParser.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28
  29 #ifndef CONNECTIVITY_ROWFUNCTIONPARSER_HXX_INCLUDED
  30 #define CONNECTIVITY_ROWFUNCTIONPARSER_HXX_INCLUDED
  31
  32 #include <sal/config.h>
  33 #include <boost/shared_ptr.hpp>
  34 #include "FDatabaseMetaDataResultSet.hxx"
  35 #include <vector>
  36 #include "connectivity/dbtoolsdllapi.hxx"
  37
  38 // -------------------------------------------------------------------------
  39 namespace connectivity
  40 {
  41 // -------------------------------------------------------------------------
  42 struct OOO_DLLPUBLIC_DBTOOLS RowEquation
  43 {
  44     sal_Int32   nOperation;
  45     ORowSetValueDecoratorRef    nPara[ 3 ];
  46
  47     RowEquation() :
  48         nOperation  ( 0 )
  49         {
  50         }
  51 };
  52
  53 enum ExpressionFunct
  54 {
  55     FUNC_CONST,
  56
  57     ENUM_FUNC_EQUATION,
  58
  59     UNARY_FUNC_COLUMN,
  60     ENUM_FUNC_AND,
  61     ENUM_FUNC_OR
  62 };
  63
  64 #define EXPRESSION_FLAG_SUMANGLE_MODE 1
  65
  66 class OOO_DLLPUBLIC_DBTOOLS SAL_NO_VTABLE ExpressionNode
  67 {
  68 public:
  69     virtual ~ExpressionNode(){}
  70
  71     /** Operator to calculate function value.
  72
  73         This method calculates the function value.
  74     */
  75     virtual ORowSetValueDecoratorRef evaluate(const ODatabaseMetaDataResultSet::ORow& _aRow ) const = 0;
  76
  77     virtual void fill(const ODatabaseMetaDataResultSet::ORow& _aRow ) const = 0;
  78
  79     /** Operator to retrieve the type of expression node
  80     */
  81     virtual ExpressionFunct getType() const = 0;
  82
  83     /** Operator to retrieve the ms version of expression
  84     */
  85     virtual ODatabaseMetaDataResultSet::ORow fillNode(
  86         std::vector< RowEquation >& rEquations, ExpressionNode* pOptionalArg, sal_uInt32 nFlags ) = 0;
  87 };
  88 typedef ::boost::shared_ptr< ExpressionNode > ExpressionNodeSharedPtr;
  89
  90 /** This exception is thrown, when the arithmetic expression
  91     parser failed to parse a string.
  92     */
  93 struct OOO_DLLPUBLIC_DBTOOLS ParseError
  94 {
  95     ParseError() {}
  96     ParseError( const char* ) {}
  97 };
  98
  99 class OOO_DLLPUBLIC_DBTOOLS FunctionParser
 100 {
 101 public:
 102
 103     /** Parse a string
 104
 105         The following grammar is accepted by this method:
 106         <code>
 107
 108         number_digit = '0'|'1'|'2'|'3'|'4'|'5'|'6'|'7'|'8'|'9'
 109
 110         number = number number_digit | number_digit
 111
 112         equal_function = '='
 113         ternary_function = 'if'
 114
 115         string_reference = 'a-z,A-Z,0-9' ' '
 116         modifier_reference = '$' '0-9' ' '
 117
 118         basic_expression =
 119             number |
 120             string_reference |
 121             additive_expression equal_function additive_expression |
 122             unary_function '(' number_digit ')'
 123             ternary_function '(' additive_expression ',' additive_expression ',
 124                                ' additive_expression ')' | '(' additive_expression ')'
 125
 126         </code>
 127
 128         @param rFunction
 129         The string to parse
 130
 131         @throws ParseError if an invalid expression is given.
 132
 133         @return the generated function object.
 134        */
 135
 136     static ExpressionNodeSharedPtr parseFunction( const ::rtl::OUString& _sFunction);
 137
 138 private:
 139     // disabled constructor/destructor, since this is
 140     // supposed to be a singleton
 141     FunctionParser();
 142
 143     // default: disabled copy/assignment
 144     FunctionParser(const FunctionParser&);
 145     FunctionParser& operator=( const FunctionParser& );
 146 };
 147
 148 // -------------------------------------------------------------------------
 149 } // namespace connectivity
 150 // -------------------------------------------------------------------------
 151 #endif /* CONNECTIVITY_ROWFUNCTIONPARSER_HXX_INCLUDED */
 152
 153 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */