First commit
[anna.git] / include / anna / core / util / TextVariable.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_util_TextVariable_hpp
38 #define anna_core_util_TextVariable_hpp
39
40 #include <anna/core/util/Variable.hpp>
41 #include <anna/core/util/String.hpp>
42
43 namespace anna {
44
45 class DataBlock;
46
47 class TextComposer;
48
49 /**
50  * Variable que contiene los valores sobre los que trabaja el util::TextComposer.
51  */
52 class TextVariable : public Variable {
53 public:
54   /**
55    * Asignación a entero.
56    * \param value Valor a asignar a esta variable.
57    */
58   TextVariable& operator= (const int value) throw(RuntimeException) { setValue(value); return *this; }
59
60   /**
61    * Asignación a cadena.
62    * \param value Valor a asignar a esta variable.
63    */
64   TextVariable& operator= (const char* value) throw(RuntimeException) { setValue(value); return *this; }
65
66   /**
67    * Asignación a cadena.
68    * \param value Valor a asignar a esta variable.
69    */
70   TextVariable& operator= (const anna::String& value) throw(RuntimeException) { setValue(value.c_str()); return *this; }
71
72   /**
73    * Asignación a entero de 64 bits.
74    * \param value Valor a asignar a esta variable.
75    */
76   TextVariable& operator= (const Integer64 value) throw(RuntimeException) { setValue(value); return *this; }
77
78   /**
79    * Asignación a flotante.
80    * \param value Valor a asignar a esta variable.
81    */
82   TextVariable& operator= (const float value) throw(RuntimeException) { setValue(value); return *this; }
83
84   /**
85    * Asignación a flotante.
86    * \param value Valor a asignar a esta variable.
87    */
88   TextVariable& operator= (const double value) throw(RuntimeException) { setValue(value); return *this; }
89
90 protected:
91   /**
92    * Constructor.
93    * \param name Nombre de la variable.
94    * \param type Tipo de dato de la variable.
95    * \param expression Expresión asociada a esta variable.
96    */
97   TextVariable(const char* name, const Type::_v type, const anna::String& expression);
98
99
100 private:
101   const anna::String a_expression;
102
103   const char* compose(DataBlock& buffer) const throw(RuntimeException);
104
105   friend class TextComposer;
106 };
107
108 }
109
110 #endif
111