abakus/src/function.h

#ifndef ABAKUS_FUNCTION_H
#define ABAKUS_FUNCTION_H
/*
 * function.h - part of abakus
 * Copyright (C) 2004, 2005 Michael Pyne <michael.pyne@kdemail.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#include "numerictypes.h"

#include <tqobject.h>
#include <tqstringlist.h>
#include <tqstring.h>
#include <tqmap.h>
#include <tqdict.h>



class BaseFunction;

struct UserFunction
{
    int sequenceNumber;
    BaseFunction *fn;
    TQString varName;
};

// Ugly pointer-to-member typedef ahead
typedef Abakus::number_t (Abakus::number_t::*function_t)() const;

struct Function {
    TQString name;
    TQString description;

    // A function is either builtin or user defined, this union is
    // used for both cases.
    union {
	function_t fn;       // Builtin.
	UserFunction *userFn; // User defined
    };

    bool returnsTrig;
    bool needsTrig;

    bool userDefined;
};

void setTrigMode(Abakus::TrigMode mode);
Abakus::TrigMode trigMode();

class FunctionManager : public TQObject
{
    Q_OBJECT
  
    public:
    typedef TQDict<Function> functionDict;

    static FunctionManager *instance();

    Function *function(const TQString &name);

    bool isFunction(const TQString &name);
    bool isFunctionUserDefined(const TQString &name);

    bool addFunction(BaseFunction *fn, const TQString &dependantVar);
    bool addFunction(const TQString &name, function_t fn, const TQString &desc);
    void removeFunction(const TQString &name);

    typedef enum { Builtin, UserDefined, All } FunctionType;

    TQStringList functionList(FunctionType type);

    signals:
    void signalFunctionAdded(const TQString &name);
    void signalFunctionRemoved(const TQString &name);

    private:
    FunctionManager(TQObject *parent = 0, const char *name = "function manager");

    static FunctionManager *m_manager;
    functionDict m_dict;
};

Abakus::number_t evaluateFunction(const Function *func, const Abakus::number_t value);

// Implemented in lexer.l due to prototype issues.
Abakus::number_t parseString(const char *str);

// Implemented in lexer.l due to prototype issues.
class Lexer
{
public:
    Lexer(const TQString &expr);
    ~Lexer();

    bool hasNext() const;
    int nextType();

    int tokenPos() const;

    // Can call this after nextType to find the associated string value of the
    // token.
    TQString tokenValue() const;

private:
    class Private;
    Private *m_private;
};

#endif