reportdesign/inc/reportformula.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_REPORTFORMULA_HXX
  21 #define INCLUDED_REPORTDESIGN_INC_REPORTFORMULA_HXX
  22
  23 #include <config_options.h>
  24 #include "dllapi.h"
  25
  26 #include <osl/diagnose.h>
  27 #include <rtl/ustring.hxx>
  28
  29
  30 namespace rptui
  31 {
  32
  33
  34     //= ReportFormula
  35
  36     class UNLESS_MERGELIBS_MORE(REPORTDESIGN_DLLPUBLIC) ReportFormula
  37     {
  38     public:
  39         enum BindType
  40         {
  41             Expression,
  42             Field,
  43
  44             Invalid
  45         };
  46
  47     private:
  48         BindType            m_eType;
  49         OUString     m_sCompleteFormula;
  50         OUString     m_sUndecoratedContent;
  51
  52     public:
  53         /// constructs a ReportFormula object from a string
  54         ReportFormula( const OUString& _rFormula );
  55
  56         /// constructs a ReportFormula by BindType
  57         ReportFormula( const BindType _eType, const OUString& _rFieldOrExpression );
  58         ~ReportFormula();
  59
  60         /// returns whether the object denotes a valid formula
  61         bool        isValid() const;
  62
  63         /// returns the type of the binding represented by the formula
  64         BindType    getType() const { return m_eType; }
  65
  66         /// returns the complete formula represented by the object
  67         const OUString&
  68                     getCompleteFormula() const { return m_sCompleteFormula; }
  69
  70         /** gets the <em>undecorated formula</em> content
  71
  72             If the formula denotes a field binding, the <em>undecorated content</em> is the
  73             field name.
  74
  75             If the formula denotes an expression, then the <em>undecorated content</em> is the expression
  76             itself.
  77         */
  78         const OUString& getUndecoratedContent() const { return m_sUndecoratedContent; }
  79
  80         /// convenience alias for <code>getUndecoratedContent</code>, which asserts (in a non-product build) when used on an expression
  81         inline OUString const & getFieldName() const;
  82
  83         /**
  84             @returns "=" + getFieldName()
  85         */
  86         OUString getEqualUndecoratedContent() const;
  87
  88         /// convenience alias for <code>getUndecoratedContent</code>, which asserts (in a non-product build) when used on a field
  89         inline OUString const & getExpression() const;
  90
  91         /** returns a bracketed field name of the formula denotes a field reference,
  92             or the undecorated expression if the formula denotes an expression.
  93
  94             Effectively, this means the method returns the complete formula, stripped by the prefix
  95             which indicates a field or an expression.
  96         */
  97         OUString getBracketedFieldOrExpression() const;
  98     };
  99
 100
 101     inline OUString const & ReportFormula::getFieldName() const
 102     {
 103         OSL_PRECOND( getType() == Field, "ReportFormula::getFieldName: not bound to a field!" );
 104         return getUndecoratedContent();
 105     }
 106
 107
 108     inline OUString const & ReportFormula::getExpression() const
 109     {
 110         OSL_PRECOND( getType() == Expression, "ReportFormula::getExpression: not bound to an expression!" );
 111         return getUndecoratedContent();
 112     }
 113
 114
 115 } // namespace rptui
 116
 117
 118 #endif // INCLUDED_REPORTDESIGN_INC_REPORTFORMULA_HXX
 119
 120 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */