include/anna/app/functions.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_app_functions_hpp
  38 #define anna_app_functions_hpp
  39
  40 #include <anna/core/functions.hpp>
  41
  42 #include <anna/app/Application.hpp>
  43
  44 namespace anna {
  45
  46 namespace app {
  47
  48 class Application;
  49
  50 /**
  51    functions - Metodos y variables
  52 */
  53 struct functions : public anna::functions {
  54   /**
  55      Devuelve la referencia de la instancia de nuestra aplicacion
  56   */
  57   static Application& getApp() throw(RuntimeException);
  58
  59   /**
  60      Patron para obtener facilmente la instancia de un determinado componente.
  61      Estos dos parametros suelen ser sustituidos por la macro C <b>FILE_LOCATION</b>.
  62
  63      \param fromFile Fichero desde el que se invoca a este metodo
  64      \param fromLine Numero de linea desde el que se invoca a este metodo.
  65
  66      \return La instancia del componente de la clase recibida como parametro.
  67      \warning La clase T de implementar un metodo de la forma:
  68      \code
  69          static const char* getClassName () throw ();
  70      \endcode
  71      \see Component
  72   */
  73   template <typename T> static T* component(const char* fromFile, const int fromLine)
  74   throw(anna::RuntimeException) {
  75     return component<T> (T::getClassName(), fromFile, fromLine);
  76   }
  77
  78   /**
  79      Patron para obtener facilmente la instancia de un determinado componente.
  80      Estos dos parametros suelen ser sustituidos por la macro C <b>FILE_LOCATION</b>.
  81      \param className Nombre del componente buscado.
  82      \param fromFile Fichero desde el que se invoca a este metodo
  83      \param fromLine Numero de linea desde el que se invoca a este metodo.
  84
  85      \return La instancia del componente de la clase recibida como parametro.
  86      \see Component
  87   */
  88   template <typename T> static T* component(const char* className, const char* fromFile, const int fromLine)
  89   throw(anna::RuntimeException) {
  90     T* result = static_cast <T*>(functions::getApp().find(className));
  91
  92     if(result == NULL) {
  93       std::string msg(className);
  94       msg += " | Componente no registrado";
  95       throw RuntimeException(msg, fromFile, fromLine);
  96     }
  97
  98     return result;
  99   }
 100 };
 101
 102 }
 103 }
 104
 105 #endif
 106
 107