KeosConsole.h

Go to the documentation of this file.

/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser 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, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */

//==========================================================
// ORIGINAL COPYRIGHT FOLLOWS
//==========================================================
// Yes::Engine - Free C++ 3D engine
//
// Copyright (C) 2004-2005 Laurent Gomila
//
// 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.,
// 59 Temple Place - Suite 330,
// Boston, MA  02111-1307, USA.
//
// E-mail : laurent.gom@gmail.com
//==========================================================

#ifndef KEOS_CONSOLE_H
#define KEOS_CONSOLE_H

//==========================================================
// En-têtes
//==========================================================
#include "KeosPrerequisites.h"
#include "KeosSingleton.h"
#include "KeosConsoleFunctor.h"
#include "KeosConsoleLook.h"

namespace Keos
{
  class KEOS_EXPORT CConsole : public CSingleton<CConsole>
  {
    friend CSingleton<CConsole>;

  public :

    //----------------------------------------------------------
    // Constructeur par défaut
    //----------------------------------------------------------
    CConsole();

    //----------------------------------------------------------
    // Change l'apparence de la console
    //----------------------------------------------------------
    void ChangeLook(Console::ILook* NewLook);

    //----------------------------------------------------------
    // Enregistre une nouvelle commande
    //----------------------------------------------------------
    void RegisterCommand(const std::string& Name, const Console::CFunctor& Function,
                         const std::string& Help = "No help for this command");

    //----------------------------------------------------------
    // Envoie un nouveau caractère à la console
    //----------------------------------------------------------
    void SendChar(char Character);

    //----------------------------------------------------------
    // Met à jour la console
    //----------------------------------------------------------
    void Update();

    //----------------------------------------------------------
    // Affiche la console
    //----------------------------------------------------------
    void Draw() const;

    //----------------------------------------------------------
    // Active ou désactive la console
    //----------------------------------------------------------
    void Enable(bool Enabled);

  private :

    //----------------------------------------------------------
    // Donne la liste des commandes enregistrées
    //----------------------------------------------------------
    std::string GetCommands() const;

    //----------------------------------------------------------
    // Commande Help: permet d'avoir la description d'une commande
    //----------------------------------------------------------
    String HelpCommand(const String& CommandName);

    //----------------------------------------------------------
    // Traite la ligne courante et appelle la fonction correspondante
    //----------------------------------------------------------
    void ProcessCurrent();

    //----------------------------------------------------------
    // Types
    //----------------------------------------------------------
    typedef std::map<std::string, Console::CFunctor> TCommandTable;
    typedef std::map<std::string, std::string> THelpTable;

    //----------------------------------------------------------
    // Données membres
    //----------------------------------------------------------
    TCommandTable             m_Commands; 
    THelpTable                m_Helps;    
    std::string               m_Current;  
    CSmartPtr<Console::ILook> m_Look;     
    bool                      m_Enabled;  
  };

} // namespace Keos


#endif // KEOS_CONSOLE_H

---