include/anna/core/tracing/TraceMethod.hpp

   1 // ANNA - Anna is Not 'N' 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_TraceMethod_hpp
  38 #define anna_core_tracing_TraceMethod_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 un determinado
  48   metodo.
  49 */
  50 class TraceMethod {
  51 public:
  52   /**
  53     Constructor.
  54     @param className Nombre de la clase desde la que se invoca.
  55     @param functionName Nombre de la funcion desde la que se invoca a este constructor.
  56     @param fromFile Nombre del fichero desde el que se invoca a este constructor. Normalmente
  57     sera el indicado por la macro de compilacion __FILE__.
  58     @param fromLine Numero de linea del fichero desde la que se invoca a este constructor.
  59     Normalmente sera el indicado por la macro de compilacion __LINE__.
  60
  61     \warning Se pueden sustituir los dos ultimos valores por la macro ANNA_FILE_LOCATION.
  62   */
  63   TraceMethod(const char* className, const char* functionName, const char* fromFile, const int fromLine) :
  64     a_level(Logger::Debug),
  65     a_className(className),
  66     a_functionName(functionName),
  67     a_fromFile(fromFile),
  68     a_ok(false) {
  69     if((a_ok = Logger::isActive(a_level)) == true) {
  70       std::string text(className);
  71       text += "::";
  72       text += functionName;
  73       Logger::write(a_level, text, "begin", fromFile, fromLine);
  74     }
  75   }
  76
  77   /**
  78     Constructor.
  79     @param level Nivel usado en la traza del método
  80     @param className Nombre de la clase desde la que se invoca.
  81     @param functionName Nombre de la funcion desde la que se invoca a este constructor.
  82     @param fromFile Nombre del fichero desde el que se invoca a este constructor. Normalmente
  83     sera el indicado por la macro de compilacion __FILE__.
  84     @param fromLine Numero de linea del fichero desde la que se invoca a este constructor.
  85     Normalmente sera el indicado por la macro de compilacion __LINE__.
  86
  87     \warning Se pueden sustituir los dos ultimos valores por la macro ANNA_FILE_LOCATION.
  88   */
  89   TraceMethod(const Logger::Level level, const char* className, const char* functionName, const char* fromFile, const int fromLine) :
  90     a_level(level),
  91     a_className(className),
  92     a_functionName(functionName),
  93     a_fromFile(fromFile) {
  94     if((a_ok = Logger::isActive(level)) == true) {
  95       std::string text(className);
  96       text += "::";
  97       text += functionName;
  98       Logger::write(level, text, "begin", fromFile, fromLine);
  99     }
 100   }
 101
 102   /**
 103     Constructor.
 104     @param methodName Nombre del método desde la que se invoca, debería incluir el nombre de la clase.
 105     @param fromFile Nombre del fichero desde el que se invoca a este constructor. Normalmente
 106     sera el indicado por la macro de compilacion __FILE__.
 107     @param fromLine Numero de linea del fichero desde la que se invoca a este constructor.
 108     Normalmente sera el indicado por la macro de compilacion __LINE__.
 109
 110     \warning Se pueden sustituir los dos ultimos valores por la macro ANNA_FILE_LOCATION.
 111   */
 112   TraceMethod(const char* methodName, const char* fromFile, const int fromLine) :
 113     a_level(Logger::Debug),
 114     a_className(methodName),
 115     a_functionName(NULL),
 116     a_fromFile(fromFile),
 117     a_ok(false) {
 118     if((a_ok = Logger::isActive(a_level)) == true)
 119       Logger::write(a_level, methodName, "begin", fromFile, fromLine);
 120   }
 121
 122   /**
 123     Constructor.
 124     @param level Nivel usado en la traza del método.
 125     @param methodName Nombre del método desde la que se invoca, debería incluir el nombre de la clase.
 126     @param fromFile Nombre del fichero desde el que se invoca a este constructor. Normalmente
 127     sera el indicado por la macro de compilacion __FILE__.
 128     @param fromLine Numero de linea del fichero desde la que se invoca a este constructor.
 129     Normalmente sera el indicado por la macro de compilacion __LINE__.
 130
 131     \warning Se pueden sustituir los dos ultimos valores por la macro ANNA_FILE_LOCATION.
 132   */
 133   TraceMethod(const Logger::Level level, const char* methodName, const char* fromFile, const int fromLine) :
 134     a_level(level),
 135     a_className(methodName),
 136     a_functionName(NULL),
 137     a_fromFile(fromFile),
 138     a_ok(false) {
 139     if((a_ok = Logger::isActive(level)) == true)
 140       Logger::write(level, methodName, "begin", fromFile, fromLine);
 141   }
 142
 143   /**
 144      Destructor.
 145   */
 146   ~TraceMethod() {
 147     if(a_ok == true && Logger::isActive(a_level) == true) {
 148       std::string text(a_className);
 149
 150       if(a_functionName != NULL) {
 151         text += "::";
 152         text += a_functionName;
 153       }
 154
 155       Logger::write(a_level, text, "end", a_fromFile, 0);
 156     }
 157   }
 158
 159 private:
 160   const Logger::Level a_level;
 161   const char* a_className;
 162   const char* a_functionName;
 163   const char* a_fromFile;
 164   bool a_ok;
 165 };
 166
 167 } //namespace anna
 168
 169 #endif
 170