plotfunctionregister.h

//
// author Kazys Stepanas
//
// Copyright (c) CSIRO 2013
//
#ifndef __PLOTFUNCTIONREGISTER_H_
#define __PLOTFUNCTIONREGISTER_H_

#include "plotsconfig.h"

#include "plotfunction.h"

#include "functionsimple.h"

#include <QStringList>

class PlotFunctionRegister
{
public:
  PlotFunctionRegister(bool registerDefaults = true);

  ~PlotFunctionRegister();

  FunctionSimple *add(FunctionSimple::ValueFunctionPtr function, const QString &category, const QString &name, const QString &description);

  FunctionSimple *add(FunctionSimple::ExpandedFunctionPtr function, const QString &category, const QString &name, const QString &description, unsigned argc = 0, bool variadic = false);

  FunctionDefinition *add(FunctionDefinition *functionDef, bool takeOwnership = true);

  const FunctionDefinition *find(const QString &name) const;

  void registerDefaultFunctions();

  inline const QVector<FunctionDefinition *> &definitions() const { return _definitions; }

  inline const QStringList categories() const { return _categories; }

  unsigned getDefinitionsInCategory(const QString &categoryName, QVector<const FunctionDefinition *> &definitions) const;

protected:
  void ensureCategoryIsPresent(const QString &categoryName);

private:
  QVector<FunctionDefinition *> _definitions;
  QStringList _categories;  
  QVector<bool> _ownership;
};

#endif // __PLOTFUNCTIONREGISTER_H_