exiting.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_TRACE_EXITING_HH
# define MLN_TRACE_EXITING_HH


# include <string>
# include <iostream>
# include <stack>

# include <mln/core/contract.hh>
# include <mln/trace/quiet.hh>

namespace mln
{

  namespace trace
  {

    void exiting(const std::string& scope);


    extern std::stack<std::clock_t> start_times;
    extern std::stack<std::string>  scopes;      // For testing purpose
                                                 // (entering/exiting scope matching).

# ifndef MLN_INCLUDE_ONLY

    inline
    void exiting(const std::string& scope)
    {
      if (quiet)
        return;

      if (scopes.empty())
        {
          std::cerr << "error: missing 'entering' scope (exiting is '" << scope << "')" << std::endl;
          quiet = true;
        }
      else
        {
          if (scopes.top() != scope)
            {
              std::cerr << "error: bad matching scope (entering is '" << scopes.top()
                        << "' v. exiting is '" << scope << "')" << std::endl;
              quiet = true;
            }
          scopes.pop();
        }

      bool has_inner_trace = (internal::max_tab == tab);
      --tab;

      if (!has_inner_trace)
        for (unsigned i = 0; i < tab; ++i)
         std::cout << "  ";

      std::cout << "} ";

      if (!has_inner_trace)
        std::cout << scope << " ";

      mln_assertion(! start_times.empty());
      std::clock_t now = std::clock();

      if (start_times.top() > now)
        {
          std::cerr << "warning: bad timer in trace handling" << std::endl;
          // FIXME: So what?
        }

      if (start_times.top() < now)
        {
          std::cout << "- "
                    << ((float(now) - float(start_times.top())) / CLOCKS_PER_SEC)
                    << "s ";
        }

      start_times.pop();

      if (has_inner_trace || (internal::max_tab - tab > 1))
        std::cout << std::endl;
    }

# endif // ! MLN_INCLUDE_ONLY

  } // end of namespace mln::trace

} // end of namespace mln


#endif // ! MLN_TRACE_EXITING_HH