reportdesign/inc/conditionalexpression.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 #ifndef INCLUDED_REPORTDESIGN_INC_CONDITIONALEXPRESSION_HXX
  21 #define INCLUDED_REPORTDESIGN_INC_CONDITIONALEXPRESSION_HXX
  22
  23 #include "dllapi.h"
  24
  25 #include <rtl/ustring.hxx>
  26 #include <map>
  27 #include <memory>
  28
  29 namespace rptui
  30 {
  31
  32
  33     // = ConditionalExpression
  34
  35     class REPORTDESIGN_DLLPUBLIC ConditionalExpression
  36     {
  37     private:
  38         const OUString       m_sPattern;
  39
  40     public:
  41         ConditionalExpression( const sal_Char* _pAsciiPattern );
  42
  43         /** assembles an expression string from a field data source, and one or two operands
  44         */
  45         OUString     assembleExpression( const OUString& _rFieldDataSource, const OUString& _rLHS, const OUString& _rRHS ) const;
  46
  47         /** matches the given expression string to the expression pattern represented by the object
  48             @param  _rExpression
  49                 the expression to match
  50             @param  _rFieldDataSource
  51                 the field data source
  52             @param  _out_rLHS
  53                 output parameter taking the left hand side operand, if successful
  54             @param  _out_rRHS
  55                 output parameter taking the right hand side operand, if successful
  56             @return
  57                 <TRUE/> if and only if the expression string could be successfully matched to
  58                 the pattern.
  59         */
  60         bool                matchExpression( const OUString& _rExpression, const OUString& _rFieldDataSource, OUString& _out_rLHS, OUString& _out_rRHS ) const;
  61     };
  62
  63
  64     //= ConditionType
  65
  66     enum ConditionType
  67     {
  68         eFieldValueComparison   = 0,
  69         eExpression             = 1
  70     };
  71
  72
  73     //= ComparisonOperation
  74
  75     enum ComparisonOperation
  76     {
  77         eBetween        = 0,
  78         eNotBetween     = 1,
  79         eEqualTo        = 2,
  80         eNotEqualTo     = 3,
  81         eGreaterThan    = 4,
  82         eLessThan       = 5,
  83         eGreaterOrEqual = 6,
  84         eLessOrEqual    = 7
  85     };
  86
  87     typedef std::shared_ptr< ConditionalExpression >                PConditionalExpression;
  88     typedef ::std::map< ComparisonOperation, PConditionalExpression >   ConditionalExpressions;
  89
  90
  91     // = ConditionalExpressionFactory
  92
  93     class REPORTDESIGN_DLLPUBLIC ConditionalExpressionFactory
  94     {
  95     public:
  96         /// fills the given map with all ConditionalExpressions which we know
  97         static size_t  getKnownConditionalExpressions( ConditionalExpressions& _out_rCondExp );
  98
  99     private:
 100         ConditionalExpressionFactory( const ConditionalExpressionFactory& ) = delete;
 101         ConditionalExpressionFactory& operator=( const ConditionalExpressionFactory& ) = delete;
 102     };
 103
 104 } // namespace rptui
 105
 106
 107 #endif // INCLUDED_REPORTDESIGN_INC_CONDITIONALEXPRESSION_HXX
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */