ElevatorSimWindow.cpp

/*
 * Copyright (c) 2012, Joseph Max DeLiso
 * 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 COPYRIGHT HOLDERS AND CONTRIBUTORS "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 COPYRIGHT OWNER OR CONTRIBUTORS 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.
 *
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the FreeBSD Project.
 */

#include "ElevatorSim.hpp"
#include "ElevatorSimWindow.hpp"
#include "ElevatorSimRenderWindow.hpp"
#include "ElevatorSimWelcomeWindow.hpp"
#include "ElevatorSimStartWindow.hpp"
#include "ElevatorSimResultsWindow.hpp"
#include "SimulationState.hpp"
#include "Logger.hpp"

#include <sstream>
#include <string>

#include <FL/Fl.H>
#include <FL/gl.h>
#include <FL/Fl_Window.H>
#include <FL/Fl_Button.H>
#include <FL/Fl_Menu_Bar.H>
#include <FL/Fl_File_Chooser.H>
#include <FL/Fl_Text_Display.H>
#include <FL/Fl_Text_Buffer.H>
#include <FL/Enumerations.H>
#include <FL/names.h>

namespace elevatorSim {

/* private methods */
int ElevatorSimWindow::handle(int event) {
   int lastKey = Fl::event_key();

   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "MainWin: event: " << fl_eventnames[event] << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   if(event == FL_KEYDOWN) {
      if(lastKey == FL_Escape) {
         confirmDialog->show();

         return Fl_Window::handle(event);
      } else {
         SimulationState::acquire().getKeyManager().down(lastKey);
         return true;
      }
   } else if (event == FL_KEYUP) {
      SimulationState::acquire().getKeyManager().up(lastKey);
      return true;
   } else if (event == FL_FOCUS) {
      Fl_Window::handle(event);

      if(isDebugBuild()) {
         LOG_INFO(Logger::SUB_FLTK, "after focus event");
      }

      if(welcomeWin->shouldShowTips()) {
         welcomeWin->show();
      }

      /* check simState for which buttons to activate and deactivate */
      updateButtonAvailability();

      return true;
   } else {
      return Fl_Window::handle(event);
   }
}

/* private static methods */
void ElevatorSimWindow::windowCloseCB(Fl_Window* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "windowCloseCB fired with widget ptr " << w << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWin = (ElevatorSimWindow*) userData;
   thisWin->confirmDialog->show();
}

void ElevatorSimWindow::menuNewCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "menuNewCB fired with widget ptr " << w
               << "and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   /* TODO */
}

void ElevatorSimWindow::menuOpenCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "menuNewCB fired with widget ptr " << w
               << "and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }
}

void ElevatorSimWindow::menuHelpCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "menuHelpCB fired with widget ptr " << w << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWindow = (ElevatorSimWindow*) userData;
   thisWindow->helpWin->show();
}

void ElevatorSimWindow::dismissHelpCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "dismissHelpCB fired with widget " << w << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWindow = (ElevatorSimWindow*) userData;
   thisWindow->helpWin->hide();
}

void ElevatorSimWindow::dismissAboutCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "dismissAboutCB fired with widget " << w << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWindow = (ElevatorSimWindow*) userData;
   thisWindow->aboutWin->hide();
}

void ElevatorSimWindow::startSimCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "in startSimCB with widget ptr " << w
               << " and userData " << userData << std::endl;
   }

   Fl_Button* startButton = (Fl_Button*) w;

   if(startButton->value()) {
      if(isDebugBuild() ) {
         std::stringstream dbgSS;
         dbgSS << "startSim CB fired" << std::endl;
      }

      ElevatorSimWindow* thisWindow = (ElevatorSimWindow*) userData;
      thisWindow->startWin->show();
   }
}

void ElevatorSimWindow::pauseSimCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "in pauseSimCB with widget ptr " << w
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   Fl_Button* pauseButton = (Fl_Button*) w;

   if(pauseButton->value()) {
      if(isDebugBuild()) {
         std::stringstream dbgSS;
         dbgSS << "pauseSimCB fired " << std::endl;
         LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
      }

      SimulationState::acquire().togglePause();
   }
}

void ElevatorSimWindow::stopSimCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "in stopSimCB with widget ptr " << w
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   Fl_Button* stopButton = (Fl_Button*) w;
   ElevatorSimWindow* thisWin = (ElevatorSimWindow*) userData;

   if(stopButton->value()) {

      if(isDebugBuild()) {
         std::stringstream dbgSS;
         dbgSS << "stopSimCB fired " << std::endl;
         LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
      }

      SimulationState::acquire().stop();
      thisWin -> resultsWin -> updateChartData();
      thisWin -> resultsWin -> show();
   }
}

void ElevatorSimWindow::menuSaveCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "menuSaveCB fired with widget ptr " << w
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   /* TODO: display save dialog */
}

void ElevatorSimWindow::menuQuitCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "menuQuitCB fired with widget ptr " << w
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWin = (ElevatorSimWindow*) userData;
   thisWin->confirmDialog->show();
}

void ElevatorSimWindow::menuAboutCB(Fl_Widget* w, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "menuAboutCB fired with widget ptr " << w
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWindow = (ElevatorSimWindow*) userData;
   thisWindow->aboutWin->show();
}

void ElevatorSimWindow::quitConfirmedCB(Fl_Button* yesButton, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "quitConfirmedCB fired with widget ptr " << yesButton
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWin = (ElevatorSimWindow*) userData;

   thisWin->confirmDialog->hide();
   thisWin->welcomeWin->hide();
   thisWin->hide();
}

void ElevatorSimWindow::quitCancelledCB(Fl_Button* noButton, void* userData) {
   if(isDebugBuild()) {

      std::stringstream dbgSS;
      dbgSS << "quitCancelledCB fired with widget ptr " << noButton
               << " and userData " << userData << std::endl;
      LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
   }

   ElevatorSimWindow* thisWin = (ElevatorSimWindow*) userData;
   thisWin->confirmDialog->hide();
}

void ElevatorSimWindow::buildMenu() {
   static const Fl_Menu_Item menuitems[] = {
            { "&File", 0, 0, 0, FL_SUBMENU },
            { "&Open", FL_COMMAND + 'o',
                     (Fl_Callback *)menuOpenCB, this, FL_MENU_INACTIVE },
            { "E&xit", FL_COMMAND + 'x', (Fl_Callback *)menuQuitCB, this },
            { 0 },
            { "&Help", 0, 0, 0, FL_SUBMENU },
            { "How to use", 0, (Fl_Callback *)menuHelpCB, this },
            { "About", 0, (Fl_Callback *)menuAboutCB, this },
            { 0 },
            { 0 }};

   Fl_Menu_Bar* menubar = new Fl_Menu_Bar(0, 0, w(), MENUBAR_HEIGHT);
   menubar->copy(menuitems);

   add(menubar);
}

void ElevatorSimWindow::buildButtons() {
   startButton = new Fl_Button(10, 35, 42, 42, "@+5>");
   pauseButton = new Fl_Button(10, 87, 42, 42, "@+5||");
   stopButton = new Fl_Button(10, 139, 42, 42, "@+5square");

   startButton ->when(FL_LEFT_MOUSE);
   pauseButton->when(FL_LEFT_MOUSE);
   stopButton->when(FL_LEFT_MOUSE);

   startButton->clear_visible_focus();
   pauseButton->clear_visible_focus();
   stopButton->clear_visible_focus();

   startButton->callback((Fl_Callback *)startSimCB, this);
   pauseButton->callback((Fl_Callback *)pauseSimCB, this);
   stopButton->callback((Fl_Callback *)stopSimCB, this);

   startButton->activate();
   stopButton->deactivate();
   pauseButton->deactivate();
}

void ElevatorSimWindow::buildDialogs() {
   /* Help Dialog */
   helpWin = new Fl_Window(443, 273, "Help");
   helpTextBuffer = new Fl_Text_Buffer();
   helpTextDisplay = new Fl_Text_Display(10, 30, 423, 213, "How to use:");

   helpTextDisplay->wrap_mode(Fl_Text_Display::WRAP_AT_BOUNDS,  0);
   helpTextDisplay->buffer(helpTextBuffer);
   helpTextDisplay->insert(
      "Camera controls: \n"
      "     WASD -\n"
      "          re-orient the view vector\n"
      "     Up and Down Arrow Keys -\n"
      "          move camera position along the z axis\n"
      "     Left and Right Arrow Keys -\n"
      "          move camera position along the x axis\n"
      "     RF -\n"
      "          rotate the up vector\n"
      "     Page Up/Page Down -\n"
      "          move camera along the y axis\n"
      "     Space -\n"
      "          resets camera\n\n"
      " NOTE: you must Begin a simulation before you can use these\n\n"
      " see https://github.com/maxdeliso/elevatorSim/wiki for more"
   );

   helpTextBuffer->add_predelete_callback( nullaryTextPredeleteCB, this);
   helpTextBuffer->add_modify_callback( nullaryTextModifyCB, this);

   helpWin->add(helpTextDisplay);
   helpWin->end();

   /* Confirmation dialog */
   confirmDialog = new Fl_Window(220, 110, "Exit elevatorSim?");
   yesButton = new Fl_Button(10, 10, 200, 40, "yes");
   noButton = new Fl_Button(10, 60, 200, 40, "no");

   yesButton->callback((Fl_Callback*) quitConfirmedCB, this);
   noButton->callback((Fl_Callback*) quitCancelledCB, this);

   confirmDialog->add(yesButton);
   confirmDialog->add(noButton);
   confirmDialog->end();

   /* About Dialog */
   aboutWin = new Fl_Window(400, 300, "About");
   aboutTextBuffer = new Fl_Text_Buffer();
   aboutTextDisplay = new Fl_Text_Display(10,30,380,200);
   aboutDoneButton = new Fl_Button(150, 250, 100, 40, "OK");

   aboutTextDisplay->wrap_mode(Fl_Text_Display::WRAP_AT_BOUNDS,  0);
   aboutTextDisplay->buffer(aboutTextBuffer);
   aboutDoneButton->callback((Fl_Callback*) dismissAboutCB, this);

   std::stringstream aboutSS;

   /* output version info of libraries */
   aboutSS
   << "elevatorSim" << std::endl
   << "  built with: " << std::endl
   << "    boost v" << BOOST_LIB_VERSION
   << " http://www.boost.org" << std::endl
   << "    fltk v" << FL_MAJOR_VERSION << "_"
   << FL_MINOR_VERSION << FL_PATCH_VERSION
   << " http://www.fltk.org" << std::endl
   << "    python v" << PY_MAJOR_VERSION << "_" << PY_MINOR_VERSION
   << " http://www.python.org\n\n"
   << "hosted at: https://github.com/maxdeliso/elevatorSim\n";

   do {
      const int lineBufferLen = 256;
      char lineBuffer[lineBufferLen];

      aboutSS.getline(lineBuffer, lineBufferLen);
      aboutTextBuffer->append(lineBuffer);
      aboutTextBuffer->append("\n");
   } while( !aboutSS.eof() );

   aboutTextBuffer->add_predelete_callback(nullaryTextPredeleteCB, this);
   aboutTextBuffer->add_modify_callback(nullaryTextModifyCB, this);

   aboutWin->add(aboutTextDisplay);
   aboutWin->add(aboutDoneButton);
   aboutWin->end();
}

void ElevatorSimWindow::updateButtonAvailability() {

   SimulationState& simState = SimulationState::acquire();

   if(isDebugBuild()) {
      LOG_INFO( Logger::SUB_FLTK, "updating button availability...");
   }

   switch(simState.getState()) {
   case SimulationState::SIMULATION_RUNNING:
      startButton->deactivate();
      stopButton->activate();
      pauseButton->activate();
      break;

   case SimulationState::SIMULATION_READY:
      startButton->activate();
      stopButton->deactivate();
      pauseButton->deactivate();
      break;

   case SimulationState::SIMULATION_PAUSED:
      startButton->deactivate();
      stopButton->activate();
      pauseButton->activate();
      break;

   default:

      break;
   }
}

void ElevatorSimWindow::nullaryTextPredeleteCB(
         int pos, int nDeleted, void* userData) {

   (void) pos;
   (void) nDeleted;
   (void) userData;
}

void ElevatorSimWindow::nullaryTextModifyCB(
         int pos, int nInserted, int nDeleted,
         int nRestyled, const char* deletedText,
         void* userData) {

   (void) pos;
   (void) nInserted;
   (void) nDeleted;
   (void) nRestyled;
   (void) deletedText;
   (void) userData;
}

/* public static member initializers */
const char ElevatorSimWindow::WINDOW_TITLE[] = "elevatorSim";
const int ElevatorSimWindow::WINDOW_WIDTH = 640;
const int ElevatorSimWindow::WINDOW_HEIGHT = 480;
const int ElevatorSimWindow::MENUBAR_HEIGHT = 25;

/* public methods */

ElevatorSimWindow::ElevatorSimWindow() :
   Fl_Window(WINDOW_WIDTH,  WINDOW_HEIGHT, WINDOW_TITLE) {
   renderWindow = new ElevatorSimRenderWindow(
            ElevatorSimRenderWindow::LEFT_MARGIN,
            ElevatorSimRenderWindow::TOP_MARGIN,
            WINDOW_WIDTH -
            (ElevatorSimRenderWindow::LEFT_MARGIN +
                     ElevatorSimRenderWindow::RIGHT_MARGIN),
                     WINDOW_HEIGHT -
                     (ElevatorSimRenderWindow::TOP_MARGIN +
                              ElevatorSimRenderWindow::BOTTOM_MARGIN));

   resizable(*renderWindow);
   buildMenu();
   buildButtons();

   /* add more widgets to main window here */

   end();

   buildDialogs();

   welcomeWin = new ElevatorSimWelcomeWindow();
   startWin = new ElevatorSimStartWindow();
   resultsWin = new ElevatorSimResultsWindow();

   /* some hackery to set the application icon in windows */
#ifdef _ES_WINNT
   HANDLE iconImage = LoadImage(
            GetModuleHandle(NULL),
            MAKEINTRESOURCE(IDI_ELEVATOR_SIM_ICON),
            IMAGE_ICON, 0, 0, LR_DEFAULTCOLOR);

   if(iconImage == NULL) {
      std::cout << "warning: failed to load application icon!" << std::endl;
   } else {
      if(isDebugBuild()) {
         std::stringstream dbgSS;
         dbgSS << "loaded app icon OK @ " << (void*)iconImage << std::endl;
         LOG_INFO( Logger::SUB_FLTK, sstreamToBuffer(dbgSS) );
      }

      icon( (const void*) iconImage );
   }
#endif

   callback((Fl_Callback*)windowCloseCB, this);

   /* add more callbacks to main window here */

   /* initialize any other main window member variables here */
}

ElevatorSimWindow::~ElevatorSimWindow() {
   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "started to destroy sim window @ " << this << std::endl;
      LOG_INFO( Logger::SUB_MEMORY, sstreamToBuffer(dbgSS) );
   }

   /* de-register the re-draw callback for the render window */
   Fl::remove_timeout(ElevatorSimRenderWindow::timerCB);

   /* free class-local heap-allocated widgets */
   delete stopButton;
   delete pauseButton;
   delete startButton;

   delete aboutDoneButton;
   delete aboutTextDisplay;
   delete aboutTextBuffer;
   delete aboutWin;

   delete helpTextDisplay;
   delete helpTextBuffer;
   delete helpWin;

   delete noButton;
   delete yesButton;
   delete confirmDialog;

   /* free class-extra heap-allocated instances */
   delete startWin;
   delete welcomeWin;
   delete renderWindow;
   delete resultsWin;

   if(isDebugBuild()) {
      std::stringstream dbgSS;
      dbgSS << "finished destroying sim window @ " << this << std::endl;
      LOG_INFO( Logger::SUB_MEMORY, sstreamToBuffer(dbgSS) );
   }
}

} /* namespace elevatorSim */