/* ES40 emulator.
 * Copyright (C) 2007-2008 by the ES40 Emulator Project
 *
 * WWW    : http://sourceforge.net/projects/es40
 * E-mail : camiel@camicom.com
 *
 * 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 2
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Although this is not required, the author would appreciate being notified of,
 * and receiving any modifications you may make to the source code that might serve
 * the general public.
 */

 /**
  * \file
  * FreeTextQuestion class for Configuration file creator.
  *
  * $Id$
  *
  * X-1.1        Camiel Vanderhoeven                             28-MAR-2008
  *      File created.
  **/

  /**
   * Question class that allows free-format text input.
   **/
class FreeTextQuestion : public Question
{
public:
  /**
   * Define a list of options to show following the question,
   * to show the user what values are acceptable.
   **/
  void setOptions(string options)
  {
    mOptions = options;
  }

  /**
   * Ask the question, and return the answer.
   **/
  virtual string ask()
  {
    for (;;)
    {
      cout << mQuestion;

      /* If there is an options list, display it after the
       * question enclosed in ().
       */
      if (mOptions != "")
        cout << " (" << mOptions << ")";

      /* If there is a default value, display it after the
       * question enclosed in [].
       */
      if (mDefault != "")
        cout << " [" << mDefault << "]";

      cout << ": ";

      /* Get the answer.
       */
      getline(cin, mAnswer);

      /* If the question is answered with '?', display the
       * explanation, then ask again.
       */
      if (mAnswer == "?")
      {
        explain();
        continue;
      }

      /* If the question is answered with <return>, set the
       * answer to the default answer.
       */
      if (mAnswer == "")
        mAnswer = mDefault;

      /* Return the answer.
       */
      return mAnswer;
    }
  }

protected:
  /** List of options to show after the question. */
  string mOptions;
};
