include/anna/core/tracing/TraceFunction.hpp

   1 // ANNA - Anna is Not Nothingness Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_tracing_TraceFunction_hpp
  38 #define anna_core_tracing_TraceFunction_hpp
  39
  40 #include <anna/core/tracing/Logger.hpp>
  41
  42 namespace anna {
  43
  44 /**
  45   Trazas de funciones.
  46
  47   Graba una traza en el historico de operaciones por cada entrada y salida de una determinada
  48   funcion.
  49 */
  50 class TraceFunction {
  51 public:
  52   /**
  53     Constructor.
  54     @param functionName Nombre de la funcion desde la que se invoca a este constructor.
  55     @param fromFile Nombre del fichero desde el que se invoca a este constructor. Normalmente
  56     sera el indicado por la macro de compilacion __FILE__.
  57     @param fromLine Numero de linea del fichero desde la que se invoca a este constructor.
  58     Normalmente sera el indicado por la macro de compilacion __LINE__.
  59   */
  60   TraceFunction(const char* functionName, const char* fromFile, const int fromLine) :
  61     a_functionName(functionName),
  62     a_fromFile(fromFile),
  63     a_ok(false) {
  64     if(Logger::isActive(Logger::Debug) == true) {
  65       a_ok = true;
  66       Logger::write(Logger::Debug, functionName, "begin", fromFile, fromLine);
  67     }
  68   }
  69
  70   /**
  71      Destructor.
  72   */
  73   ~TraceFunction() {
  74     if(a_ok == true && Logger::isActive(Logger::Debug) == true)
  75       Logger::write(Logger::Debug, a_functionName, "end", a_fromFile, 0);
  76   }
  77
  78 private:
  79   const char* a_functionName;
  80   const char* a_fromFile;
  81   bool a_ok;
  82 };
  83
  84 } //namespace anna
  85
  86 #endif
  87