/*
 * Copyright (c) 2003-2009, John Wiegley.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of New Artisans LLC nor the names of its
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/**
 * @addtogroup util
 */

/**
 * @file   hooks.h
 * @author John Wiegley
 *
 * @ingroup util
 *
 * @brief Brief
 *
 * Long.
 */
#ifndef _HOOKS_H
#define _HOOKS_H


/**
 * @brief Brief
 *
 * Long.
 */
template <typename T, typename Data>
class hooks_t : public boost::noncopyable
{
public:
  typedef boost::function<bool (Data&, bool)> function_t;

protected:
  std::list<T *> list;

public:
  hooks_t() {
    TRACE_CTOR(hooks_t, "");
  }
  ~hooks_t() throw() {
    TRACE_DTOR(hooks_t);
  }

  void add_hook(T * func, const bool prepend = false) {
    if (prepend)
      list.push_front(func);
    else
      list.push_back(func);
  }

  void remove_hook(T * func) {
    list.remove(func);
  }

  bool run_hooks(Data& item, bool post) {
    foreach (T * func, list)
      if (! (*func)(item, post))
	return false;
    return true;
  }
};

#endif // _HOOKS_H
