src/Core/CommandBinding.h

   1 /***************************************************************************
   2  *   Copyright (C) 2008 by Vegard Nossum                                   *
   3  *   vegard.nossum@gmail.com                                               *
   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
  21 #pragma once
  22
  23 /**
  24  * @file CommandBinding.h
  25  * @brief This file contains the CommandBinding template.
  26  *
  27  * @see CommandBinding
  28  */
  29
  30 #include "CommandObject.h"
  31
  32 /**
  33  * This template defines a binding from the specified alias to the specified CommandObject.
  34  */
  35 template<typename T>
  36 class CommandBinding {
  37         public:
  38                 /** Constructs a new CommandBinding with the specified alias to the specified CommandObject. */
  39                 CommandBinding(const char* alias, const CommandObject<T>& command);
  40
  41                 /** Destructor, a noop. */
  42                 ~CommandBinding();
  43
  44                 /** Returns the command associated with this binding. */
  45                 const CommandObject<T>& getCommand() const;
  46
  47                 /** Whether the binding should only allow full matches. */
  48                 bool fullName() const;
  49
  50
  51         public:
  52                 const char* m_alias; /**< The alias associated with this binding. Public to optimize the binary search for speed. */
  53
  54         private:
  55                 const CommandObject<T>& m_command; /**< The CommandObject associated with this binding. */
  56 };
  57
  58 template<typename T>
  59 CommandBinding<T>::CommandBinding(const char* alias,
  60         const CommandObject<T>& command):
  61         m_alias(alias),
  62         m_command(command)
  63 {
  64 }
  65
  66 template<typename T>
  67 CommandBinding<T>::~CommandBinding()
  68 {
  69 }
  70
  71 template<typename T>
  72 const CommandObject<T>&
  73 CommandBinding<T>::getCommand() const
  74 {
  75         return m_command;
  76 }
  77
  78 template<typename T>
  79 bool
  80 CommandBinding<T>::fullName() const
  81 {
  82         return m_command.fullName();
  83 }