userfunction.h

Go to the documentation of this file.

/*-
 * Copyright (c) 2014-2018 Carsten Sonne Larsen <cs@innolan.net>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Project homepage:
 * https://amath.innolan.net
 * 
 */

#ifndef AMATH_USERFUNCTION_H
#define AMATH_USERFUNCTION_H

#include "nodes.h"
#include "values.h"
#include "functionlist.h"

struct functiondef;
class UserFunction;

/**
 * @brief A user defined function.
 *
 */
class UserFunction
{
public:
    UserFunction(const char* name, const char* variable, ExpressionNode* expression);
    explicit UserFunction(const char* name);
    ~UserFunction();

    UserFunction* Next;

    char* GetName() const;
    char* GetDefinitionName() const;
    char* GetDefinitionText() const;
    Variable* GetVariable() const;
    Variable* CreateVariable(const char* name);
    ExpressionNode* GetExpression() const;
    void SetExpression(ExpressionNode* expression);

private:
    char* name;
    Variable* variable;
    ExpressionNode* expression;
    bool chainDelete;
    friend bool FunctionList::Delete(const char* name, const char* argument);

    void InitializeTexts() const;
    CharBuffer* defname;
    CharBuffer* definition;
};

#endif