/************************************************************************
 FAUST Architecture File
 Copyright (C) 2003-2017 GRAME, Centre National de Creation Musicale
 ---------------------------------------------------------------------
 This Architecture section 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 3 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, see <http://www.gnu.org/licenses/>.

 EXCEPTION : As a special exception, you may create a larger work
 that contains this FAUST architecture section and distribute
 that work under terms of your choice, so long as this FAUST
 architecture section is not modified.
 ************************************************************************/

#pragma once

#ifndef __faust2hpp_UI_H__
#define __faust2hpp_UI_H__

#ifndef FAUSTFLOAT
#define FAUSTFLOAT float
#endif

/*******************************************************************************
 * UI : Faust DSP User Interface
 * User Interface as expected by the buildUserInterface() method of a DSP.
 * This abstract class contains only the method that the Faust compiler can
 * generate to describe a DSP user interface.
 ******************************************************************************/

struct Soundfile;

template<typename REAL> class UIReal
{
public:
  UIReal() {}
  virtual ~UIReal() {}

  // -- widget's layouts

  virtual void openTabBox(const char* label) = 0;
  virtual void openHorizontalBox(const char* label) = 0;
  virtual void openVerticalBox(const char* label) = 0;
  virtual void closeBox() = 0;

  // -- active widgets

  virtual void addButton(const char* label, REAL* zone) = 0;
  virtual void addCheckButton(const char* label, REAL* zone) = 0;
  virtual void addVerticalSlider(
      const char* label,
      REAL* zone,
      REAL init,
      REAL min,
      REAL max,
      REAL step) = 0;
  virtual void addHorizontalSlider(
      const char* label,
      REAL* zone,
      REAL init,
      REAL min,
      REAL max,
      REAL step) = 0;
  virtual void addNumEntry(
      const char* label,
      REAL* zone,
      REAL init,
      REAL min,
      REAL max,
      REAL step) = 0;

  // -- passive widgets

  virtual void
  addHorizontalBargraph(const char* label, REAL* zone, REAL min, REAL max) = 0;
  virtual void
  addVerticalBargraph(const char* label, REAL* zone, REAL min, REAL max) = 0;

  // -- soundfiles

  virtual void addSoundfile(
      const char* label, const char* filename, Soundfile** sf_zone) = 0;

  // -- metadata declarations

  virtual void declare(REAL*, const char*, const char*) {}
};

class UI : public UIReal<FAUSTFLOAT>
{
public:
  UI() {}
  virtual ~UI() {}
};

#endif
