/**********************************************************************
 *
 *   FreeDoko a Doppelkopf-Game
 *    
 *   Copyright (C) 2001-2007  by Diether Knof and Borg Enders
 *
 *   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 can find this license in the file 'gpl.txt'.
 *
 *   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., 59 Temple Place, Suite 330, Boston, 
 *   MA  02111-1307  USA
 *
 *  Contact:
 *    Diether Knof dknof@gmx.de
 *    Borg Enders  borg@borgsoft.de
 *
 **********************************************************************/

#include "constants.h"

#ifdef USE_UI_TEXT

#include "help.h"

#include "../../misc/language.h"

namespace UI_TEXT_NS {

  /**
   **
   ** constructor
   **
   ** @param	ui	pointer to the ui
   **
   ** @return	-
   **
   ** @version	0.5.4
   **
   ** @author	Diether Knof
   **
   **/
    UI_Text::Help::Help(UI_Text* const ui) :
      ui(ui)
    {
      DEBUG_CALLING(INFO_UI_HELP && INFO_UI_INIT,
		    "UI_Text::Help::Help(ui)");

      DEBUG_RETURNING(VOID,
		      INFO_UI_HELP && INFO_UI_INIT,
		      "UI_Text::Help::Help(ui)");
    } // UI_Text::Help::Help(UI_Text* const ui)

  /**
   **
   ** destructor
   **
   ** @param	-
   **
   ** @return	-
   **
   ** @version	0.5.4
   **
   ** @author	Diether Knof
   **
   **/
    UI_Text::Help::~Help()
    {
      DEBUG_CALLING(INFO_UI_HELP && INFO_UI_INIT,
		    "UI_Text::Help::~Help()");

      DEBUG_RETURNING(VOID,
		      INFO_UI_HELP && INFO_UI_INIT,
		      "UI_Text::Help::~Help()");
    } // UI_Text::Help::~Help()

  /**
   **
   ** interprets the line read by the ui
   **
   ** @param	-
   **
   ** @return	whether the line was interpreted
   **
   ** @version	0.5.4
   **
   ** @author	Diether Knof
   **
   ** @todo	mostly all
   **
   **/
    bool
      UI_Text::Help::interpret_line()
      {
	DEBUG_CALLING(INFO_UI_HELP && INFO_UI_EVENT,
		      "UI_Text::Help::interpret_line()");

	// whether the line has been interpreted
	bool interpreted = false;

	if (this->ui->iskeyword("help")) {
	  this->ui->ostr() << ::language("_UI_Text_ help")
	    << '\n';
	  interpreted = true;
	} // if (this->ui->iskeyword("help"))

	DEBUG_RETURNING(interpreted,
			INFO_UI_HELP && INFO_UI_EVENT,
			"UI_Text::Help::interpret_line()");
      } // bool UI_Text::Help::interpret_line()

} // namespace UI_TEXT_NS

#endif // #ifdef USE_UI_TEXT