src/Core/Editors/Editor.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Sverre Rabbelier                                *
   3  *   sverre@rabbelier.nl                                                   *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 3 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program; if not, write to the                         *
  17  *   Free Software Foundation, Inc.,                                       *
  18  *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
  19  ***************************************************************************/
  20 #pragma once
  21
  22 /**
  23  * @file Editor.h
  24  * This file contains the Editor class.
  25  *
  26  * @see Editor
  27  */
  28
  29 #include "Types.h"
  30 #include "SavableTypes.h"
  31
  32 /**
  33  * This class defines an interface for UBSocket to use in handling lines from the user.
  34  *
  35  * @see UBSocket
  36  */
  37 class Editor
  38 {
  39 public:
  40         /** Constructs an Editor with the specified socket. */
  41         Editor(UBSocket* sock);
  42
  43         /** Destructor, a noop. */
  44         virtual ~Editor(void);
  45
  46
  47         /** This function is called whenever the user sends an empty line. */
  48         virtual void OnEmptyLine() {}
  49
  50         /**
  51          * This function is called whenever a user sends a line.
  52          *
  53          * The default implementation will handle the input and use <code>lookup</code> to find the matching command.
  54          * If matched it will dispatch it with the <code>dispatch</code> functions.
  55          *
  56          * @see lookup
  57          * @see dispatch
  58          */
  59         virtual void OnLine(const std::string& line);
  60
  61         /** This function is called whenever this editor becomes the editor that has the focus. */
  62         virtual void OnFocus() { }
  63
  64
  65         /** Returns the name of this editor. */
  66         virtual std::string name() = 0;
  67
  68         /** Returns the prompt for this editor. */
  69         virtual std::string prompt(); // { return Global::Get()->EmptyString; };
  70
  71         /** Returns the full name of a command of the specified action. */
  72         virtual std::string lookup(const std::string& action); // { return Global::Get()->EmptyString; };
  73
  74         /** Dispatches the specified action with the specified argument. */
  75         virtual void dispatch(const std::string& action, const std::string& argument) { return; };
  76
  77         /** Whether the current editor is capable of receiving messages from the specified channel. */
  78         virtual bool canReceiveChannel(mud::ChannelPtr channel) const;
  79
  80         /** Whether prefixes should be handled in the current editor. */
  81         virtual bool supportPrefixes() const;
  82
  83
  84         /** Send a message to the user. */
  85         void Send(const std::string& msg);
  86
  87         /** Send a formatted message to the user. */
  88         void Sendf(const char* format, ...);
  89
  90         /** Disconnect the user. */
  91         void Disconnect();
  92
  93 protected:
  94         UBSocket* m_sock; /**< The socket this Editor is associated with. */
  95
  96 private:
  97         /** Hide the copy constructor. */
  98         Editor(const Editor& rhs);
  99 };