/* This file is part of MAUS: http://micewww.pp.rl.ac.uk:8080/projects/maus
 *
 * MAUS 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 3 of the License, or
 * (at your option) any later version.
 *
 * MAUS 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 MAUS.  If not, see <http://www.gnu.org/licenses/>.
 *
 */


/*!
 * \file oneArgManip.h
 *
 * \author Alexander Richards, Imperial College London
 * \date 06/01/2012
 *
 * This file contains a class template representing a one argument manipulator function
 * which will act on the rstream. It also contains a function "branchName" which returns
 * a oneArgManip rstream manipulator which will allow for setting up of branches within
 * a root tree.
 */
#ifndef ONEARG_MANIP_H
#define ONEARG_MANIP_H
#include "gtest/gtest_prod.h"


class rstream;

// Single argument manipulator object
// \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
/*!
 * \class oneArgManip
 *
 * \brief Wrapper class for the single argument manipulators
 *
 * This class wraps a single argument manipulator by storing the intended argument and passing it
 * along with the stream when called. The template type T represents the argument type of the function
 * pointed to by the stored function pointer.
 * \author Alexander Richards, Imperial College London
 * \date 06/01/2012
 */
template<typename T>
class oneArgManip {
 private:
  // ! Type def manipulator function pointer
  typedef rstream& (*manip_pointer)(rstream&, T);
  /*!
   * \var manip_pointer m_manip
   * \brief pointer to the single arg manipulator function.
   */  
  manip_pointer m_manip;
  /*!
   * \var T m_value
   * \brief The argument that the single arg manipulator should take.
   */
  T m_value;

  FRIEND_TEST(OneArgManipTest, TestConstructor);

 public:
  /*!
   * \brief Constructor
   * \param manip_pointer a function pointer to the single arg manipulator
   * \param T the single argument to be wrapped.
   */
  oneArgManip(manip_pointer manip, T value): m_manip(manip), m_value(value) {}
  /*!
   * \brief call the wrapped function
   * \param rstream& The rstream object that the function will operate on.
   */
  rstream& operator()(rstream& rs) {
    return m_manip(rs, m_value);
  }
};

// Related single arg function.
// \/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/
/*!
 * \brief single arg manipulator to set the branch name within the stream.
 * \param char* the name to use as the next branch name.
 */
oneArgManip<const char*>* branchName(const char* name);

#endif