You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
koffice/kspread/functions.h

172 lines
4.5 KiB

/* This file is part of the KDE project
Copyright (C) 2003,2004 Ariya Hidayat <ariya@kde.org>
Copyright (C) 2005 Tomas Mecir <mecirt@gmail.com>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef KSPREAD_FUNCTIONS
#define KSPREAD_FUNCTIONS
#include <tqstringlist.h>
#include <tqvaluevector.h>
class TQDomElement;
namespace KSpread
{
class Sheet;
class Value;
class ValueCalc;
typedef TQValueVector<Value> valVector;
struct rangeInfo {
int col1, col2, row1, row2;
};
struct FuncExtra {
// here we'll add all the extras a function may need
TQValueVector<rangeInfo> ranges;
Sheet *sheet;
int myrow, mycol;
};
typedef Value (*FunctionPtr)(valVector, ValueCalc *, FuncExtra *);
class Function
{
public:
Function (const TQString& name, FunctionPtr ptr);
~Function();
/**
setParamCount sets allowed parameter count for a function.
if max=0, it means max=min. If max=-1, there is no upper limit.
*/
void setParamCount (int min, int max = 0);
/** is it okay for the function to receive this many parameters ? */
bool paramCountOkay (int count);
/** when set to true, the function can receive arrays. When set to
false, the auto-array mechamism will be used for arrays (so the
fuction will receive simple values, not arrays). */
void setAcceptArray (bool accept = true);
bool needsExtra ();
void setNeedsExtra (bool extra);
TQString name() const;
TQString localizedName() const;
TQString helpText() const;
void setHelpText( const TQString& text );
Value exec (valVector args, ValueCalc *calc, FuncExtra *extra = 0);
private:
class Private;
Private* d;
};
enum ParameterType { KSpread_Int, KSpread_Float, KSpread_String, KSpread_Boolean, KSpread_Any };
class FunctionParameter
{
public:
FunctionParameter();
FunctionParameter( const FunctionParameter& param );
FunctionParameter( const TQDomElement& element );
TQString helpText() const { return m_help; }
ParameterType type() const { return m_type; }
bool hasRange() const { return m_range; }
private:
TQString m_help;
ParameterType m_type;
bool m_range;
};
class FunctionDescription
{
public:
FunctionDescription();
FunctionDescription (const TQDomElement& element);
FunctionDescription (const FunctionDescription& desc);
const TQStringList& examples() { return m_examples; }
const TQStringList& syntax() { return m_syntax; }
const TQStringList& related() { return m_related; }
const TQStringList& helpText() const { return m_help; }
TQString name() const { return m_name; }
ParameterType type() const { return m_type; }
int params() const { return m_params.count(); }
FunctionParameter& param( int i ) { return m_params[ i ]; }
void setGroup( const TQString& g ) { m_group = g; }
TQString group() const { return m_group; }
TQString toTQML() const;
private:
TQString m_group;
TQStringList m_examples;
TQStringList m_syntax;
TQStringList m_related;
TQStringList m_help;
TQString m_name;
ParameterType m_type;
TQValueList<FunctionParameter> m_params;
};
class FunctionRepository
{
public:
FunctionRepository();
~FunctionRepository();
static FunctionRepository *self();
void add (Function *function);
Function *function (const TQString& name);
FunctionDescription *functionInfo (const TQString& name);
/** return functions within a group, or all if no group given */
TQStringList functionNames (const TQString& group = TQString());
const TQStringList &groups () const { return m_groups; }
private:
class Private;
Private* d;
static FunctionRepository* s_self;
/** loads function descriptions from a XML file */
void loadFile (const TQString& filename);
TQStringList m_groups;
// no copy or assign
FunctionRepository( const FunctionRepository& );
FunctionRepository& operator=( const FunctionRepository& );
};
} // namespace KSpread
#endif // KSPREAD_FUNCTIONS