/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_REPORTDESIGN_INC_REPORTFORMULA_HXX
#define INCLUDED_REPORTDESIGN_INC_REPORTFORMULA_HXX
#include <config_options.h>
#include "dllapi.h"
#include <osl/diagnose.h>
#include <rtl/ustring.hxx>
namespace rptui
{
//= ReportFormula
class UNLESS_MERGELIBS_MORE(REPORTDESIGN_DLLPUBLIC) ReportFormula
{
public:
enum BindType
{
Expression,
Field,
Invalid
};
private:
BindType m_eType;
OUString m_sCompleteFormula;
OUString m_sUndecoratedContent;
public:
/// constructs a ReportFormula object from a string
ReportFormula(
const OUString& _rFormula );
/// constructs a ReportFormula by BindType
ReportFormula(
const BindType _eType,
const OUString& _rFieldOrExpression );
~ReportFormula();
/// returns whether the object denotes a valid formula
bool isValid()
const;
/// returns the type of the binding represented by the formula
BindType getType()
const {
return m_eType; }
/// returns the complete formula represented by the object
const OUString&
getCompleteFormula()
const {
return m_sCompleteFormula; }
/** gets the <em>undecorated formula</em> content
If the formula denotes a field binding, the <em>undecorated content</em> is the
field name.
If the formula denotes an expression, then the <em>undecorated content</em> is the expression
itself.
*/
const OUString& getUndecoratedContent()
const {
return m_sUndecoratedContent; }
/// convenience alias for <code>getUndecoratedContent</code>, which asserts (in a non-product build) when used on an expression
inline OUString
const & getFieldName()
const;
/**
@returns "=" + getFieldName()
*/
OUString getEqualUndecoratedContent()
const;
/// convenience alias for <code>getUndecoratedContent</code>, which asserts (in a non-product build) when used on a field
inline OUString
const & getExpression()
const;
/** returns a bracketed field name of the formula denotes a field reference,
or the undecorated expression if the formula denotes an expression.
Effectively, this means the method returns the complete formula, stripped by the prefix
which indicates a field or an expression.
*/
OUString getBracketedFieldOrExpression()
const;
};
inline OUString
const & ReportFormula::getFieldName()
const
{
OSL_PRECOND( getType() == Field,
"ReportFormula::getFieldName: not bound to a field!" );
return getUndecoratedContent();
}
inline OUString
const & ReportFormula::getExpression()
const
{
OSL_PRECOND( getType() == Expression,
"ReportFormula::getExpression: not bound to an expression!" );
return getUndecoratedContent();
}
}
// namespace rptui
#endif // INCLUDED_REPORTDESIGN_INC_REPORTFORMULA_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
