ui.h

/*  Almost Serious Synth
 *
 *  UI (menu) definitions
 *
 *  Copyright (c) 2017, 2018 Thomas Friedrichsmeier
 *
 *  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 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/>.
 */

#ifndef UI_H
#define UI_H
/** This file contains the structures and logic for making the UI work. */

#include "synthsettings.h"

/** Base class for all "pages" / screens of the UI */
class UIPage {
public:
  virtual void handleUpDown (int8_t delta) = 0;   /// handle "up / down" input (value change)
  virtual void handleLeftRight (int8_t delta) {}; /// handle "left right" (page change)
  virtual void handleButton (int8_t but) = 0;  /// handle button (matrix) press
  virtual void updateDisplay () = 0;           /// update display (if necessary)
  enum PageID {
    MenuPage1,
    SynthSettingsPage1,
    SynthSettingsPage2,
    SelectExistingFile,
    SaveFile
  };
  static void setCurrentPage (PageID page);
  static UIPage* currentPage () { return current_page; };
protected:
  virtual void initDisplay () = 0;             /// intialize the display. To be called, when the page has just been activated.
  static UIPage* current_page;
};

/** UI specification for a synthesizer settings screen. In essence, button
 * press selects the setting to tune, encoder ticks change the setting value. */
class SynthSettingsPage : public UIPage {
public:
  SynthSettingsPage (uint8_t offset);
  void drawIconForSetting (uint8_t setting, bool active);
  void initDisplay () override;
  void handleUpDown (int8_t delta) override; 
  void handleLeftRight (int8_t delta) override;
  void updateDisplay () override;
  void handleButton (int8_t button) override;
private:
  uint8_t current_setting = NothingSetting;
  uint8_t offset;
  bool update = false;
};

/** UI specification for the main menu. Currently. there is exactly one main menu page, but more might be added in the future, or it might be made scrollable. */
class MenuPage : public UIPage {
public:
  void initDisplay () override;
  void handleUpDown (int8_t delta) override;
  void handleLeftRight (int8_t delta) override;
  void handleButton (int8_t but);
  void updateDisplay ();
private:
  void drawMIDIPlayOptions ();
};

#include "storage.h"
/** Allows to select an existing file inside a given directory. When done, a callback is called with the selected filename as parameter. */
class SelectFilePage : public UIPage {
public:
  void initDisplay () override;
  void handleUpDown (int8_t delta) override;
  void handleButton (int8_t but);
  void updateDisplay ();
  void selectFile (File directory, void (*callback)(const char*));
private:
  File dir;
  File entry;
  void (*callback) (const char*);
#ifdef USE_SDFAT
  char filenamebuf[13];
#endif
  int16_t pos;
};

/** Asks for a save file name */
class SaveFilePage : public UIPage {
public:
  void initDisplay () override;
  void handleUpDown (int8_t delta) override;
  void handleButton (int8_t but);
  void updateDisplay ();
  void saveFile (File directory, const char* initial_name, const char* extension, void (*callback)(const char*));
private:
  File dir;
  char name[9];
  char extension[4];
  void (*callback) (const char*);
  int16_t pos;
};

#endif