println.hh

// Copyright (C) 2007, 2008, 2009 EPITA Research and Development Laboratory (LRDE)
//
// This file is part of Olena.
//
// Olena 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, version 2 of the License.
//
// Olena 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 Olena.  If not, see <http://www.gnu.org/licenses/>.
//
// As a special exception, you may use this file as part of a free
// software project without restriction.  Specifically, if other files
// instantiate templates or use macros or inline functions from this
// file, or you compile this file and link it with other files to produce
// an executable, this file does not by itself cause the resulting
// executable to be covered by the GNU General Public License.  This
// exception does not however invalidate any other reasons why the
// executable file might be covered by the GNU General Public License.

#ifndef MLN_DEBUG_PRINTLN_HH
# define MLN_DEBUG_PRINTLN_HH


# include <mln/core/concept/image.hh>
# include <mln/core/concept/window.hh>
# include <mln/geom/bbox.hh>
# include <mln/debug/quiet.hh>
# include <mln/debug/format.hh>

// Specializations are in:
# include <mln/debug/println.spe.hh>


namespace mln
{

  namespace debug
  {

    template <typename I>
    void println(const Image<I>& input);

    template <typename I>
    void println(const std::string& msg, const Image<I>& input);


# ifndef MLN_INCLUDE_ONLY

    namespace impl
    {

      // Generic version.
      template <typename S, typename I>
      inline
      void
      println(const S&, const Image<I>& input_)
      {
        const I& input = exact(input_);
        mln_piter(I) p(input.domain());
        for_all(p)
          std::cout << format(input(p)) << ' ';
        std::cout << std::endl;
      }

    } // end of namespace mln::debug::impl


    // Facades.

    template <typename I>
    inline
    void
    println(const Image<I>& input)
    {
      trace::entering("debug::println");

      if (!quiet)
        impl::println(geom::bbox(exact(input).domain()),
                      exact(input));
      trace::exiting("debug::println");
    }

    template <typename I>
    void println(const std::string& msg, const Image<I>& input)
    {
      if (!quiet)
      {
        std::cout << msg << std::endl;
        println(input);
      }
    }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::debug

} // end of namespace mln


#endif // ! MLN_DEBUG_PRINTLN_HH