[Olena-patches] olena: olena-2.0-553-gedc8943 Update the documentation of mln_trace.

* mln/debug/trace.hh: Here. Aesthetic changes. --- milena/ChangeLog | 7 +++++++ milena/mln/debug/trace.hh | 40 +++++++++++++++++++++------------------- 2 files changed, 28 insertions(+), 19 deletions(-) diff --git a/milena/ChangeLog b/milena/ChangeLog index edf3a65..28a569f 100644 --- a/milena/ChangeLog +++ b/milena/ChangeLog @@ -1,3 +1,10 @@ +2013-06-13 Roland Levillain &lt;roland(a)lrde.epita.fr&gt; + + Update the documentation of mln_trace. + + * mln/debug/trace.hh: Here. + Aesthetic changes. + 2013-04-17 Guillaume Lazzara &lt;z(a)lrde.epita.fr&gt; * doc/mln/convert.dox: Fix from_to_ module name. diff --git a/milena/mln/debug/trace.hh b/milena/mln/debug/trace.hh index bddd8a1..e3f3261 100644 --- a/milena/mln/debug/trace.hh +++ b/milena/mln/debug/trace.hh @@ -28,12 +28,14 @@ /// \file /// -/// Definition of the trace entering procedure. +/// Definition of the function entering/exiting tracing mechanism. + +# include <ctime> -# include <string> # include <iostream> +# include <string> # include <stack> -# include <ctime> + # include <mln/core/contract.hh> # define mln_trace(S) \ @@ -49,13 +51,14 @@ namespace mln namespace debug { - /*! \brief Display function calls backtrace. + /*! \brief Trace function calls. This class is meant to be instantiated at the beginning of each routine in olena. It keep trace of the function call backtrace and remember the time in each function. - This class must used at follow: + This class is intended to be used through the mln_trace macro as + follows: \code namespace mln @@ -70,9 +73,9 @@ namespace mln } \endcode - \warning mln_trace() declares a named local variable, so do not - use mln_trace twice in the same scope in order to avoid - duplicate declarations. + \warning mln_trace() declares a local variable (named + mln_trace_), so do not use mln_trace twice in the same scope to + avoid duplicate declarations. */ class trace { @@ -94,10 +97,9 @@ namespace mln private: static std::stack<std::clock_t> start_times_; - static std::stack<std::string> scopes_; + static std::stack<std::string> scopes_; static unsigned max_tab_; static bool is_quiet_; - }; @@ -167,17 +169,17 @@ namespace mln std::clock_t now = std::clock(); if (start_times_.top() > now) - { - std::cerr << "warning: bad timer in trace handling" << std::endl; - // FIXME: So what? - } + std::cerr + << "Warning: Clock skew detected (start time in the future)." + << std::endl; if (start_times_.top() < now) - { - std::cout << "- " - << ((float(now) - float(start_times_.top())) / CLOCKS_PER_SEC) - << "s "; - } + { + std::cout + << "- " + << ((float(now) - float(start_times_.top())) / CLOCKS_PER_SEC) + << "s "; + } start_times_.pop(); -- 1.7.10.4