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