Use an enumeration type rather than unnamed integers to specify the different types...
[synfig.git] / synfig-core / trunk / src / synfig / value.h
1 /* === S Y N F I G ========================================================= */
2 /*!     \file value.h
3 **      \brief Template Header
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2007 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === S T A R T =========================================================== */
25
26 #ifndef __SYNFIG_VALUE_H
27 #define __SYNFIG_VALUE_H
28
29 /* === H E A D E R S ======================================================= */
30
31 //#include "vector.h"
32 //#include "time.h"
33 #include "segment.h"
34 //#include "color.h"
35 #include "string.h"
36 #include <list>
37 #include <vector>
38 #include <ETL/trivial>
39 #include <ETL/handle>
40 #include "general.h"
41 //#include "gradient.h"
42 #include "blinepoint.h"
43 #include "exception.h"
44
45 #ifdef USE_HALF_TYPE
46 #include <OpenEXR/half.h>
47 #endif
48
49 #ifndef SYNFIG_NO_ANGLE
50 #include "angle.h"
51 #endif
52
53 #include <ETL/ref_count>
54
55 /* === M A C R O S ========================================================= */
56
57 /* === T Y P E D E F S ===================================================== */
58
59 /* === C L A S S E S & S T R U C T S ======================================= */
60
61 namespace synfig {
62
63 class Canvas;
64 class Vector;
65 class Time;
66 class Segment;
67 class Gradient;
68 class BLinePoint;
69 class Color;
70
71 /*!     \class ValueBase
72 **      \todo writeme
73 */
74 class ValueBase
75 {
76         /*
77  --     ** -- T Y P E S -----------------------------------------------------------
78         */
79
80 public:
81
82         //! \writeme
83         enum Type
84         {
85                 TYPE_NIL=0,                     //!< Represents an empty value
86
87                 TYPE_BOOL,
88                 TYPE_INTEGER,
89                 TYPE_ANGLE,                     //!< Angle
90
91                 // All types after this point are larger than 32 bits
92
93                 TYPE_TIME,                      //!< Time
94                 TYPE_REAL,                      //!< Real
95
96                 // All types after this point are larger than 64 bits
97
98                 TYPE_VECTOR,            //!< Vector
99                 TYPE_COLOR,                     //!< Color
100                 TYPE_SEGMENT,           //!< Segment
101                 TYPE_BLINEPOINT,        //!< BLinePoint
102
103                 // All types after this point require construction/destruction
104
105                 TYPE_LIST,                      //!< List
106                 TYPE_CANVAS,            //!< Canvas
107                 TYPE_STRING,            //!< String
108                 TYPE_GRADIENT,          //!< Color Gradient
109
110                 TYPE_END                        //!< Not a valid type, used for sanity checks
111         };
112
113 private:
114
115         typedef std::vector<ValueBase> list_type;
116
117         /*
118  --     ** -- D A T A -------------------------------------------------------------
119         */
120
121 protected:
122
123         Type type;
124         void *data;
125         etl::reference_counter ref_count;
126         bool loop_;
127
128         /*
129  --     ** -- C O N S T R U C T O R S -----------------------------------
130         */
131
132 public:
133
134         //! \writeme
135         ValueBase();
136
137         //! \writeme
138         template <typename T>
139         ValueBase(const T &x, bool loop_=false):
140                 type(TYPE_NIL),data(0),ref_count(0),loop_(loop_)
141                 { set(x); }
142
143         //! \writeme
144         ValueBase(Type x);
145
146         //! \writeme
147         ~ValueBase();
148
149         /*
150  --     ** -- O P E R A T O R S ---------------------------------------------------
151         */
152
153 public:
154
155         //! \writeme
156         template <class T> ValueBase& operator=(const T& x)
157                 { set(x); return *this; }
158
159         //! \writeme
160         ValueBase& operator=(const ValueBase& x);
161
162         //! \writeme
163         bool operator==(const ValueBase& rhs)const;
164
165         //! \writeme
166         bool operator!=(const ValueBase& rhs)const { return !operator==(rhs); }
167
168         //!     Constant index operator for when value is of type TYPE_LIST
169         const ValueBase &operator[](int index)const
170                 { assert(type==TYPE_LIST); assert(index>0); return get_list()[index]; }
171
172         /*
173  --     ** -- M E M B E R   F U N C T I O N S -------------------------------------
174         */
175
176 public:
177
178         //! \writeme
179         void clear();
180
181         //! \writeme
182         bool get_loop()const { return loop_; }
183
184         //! \writeme
185         void set_loop(bool x) { loop_=x; }
186
187         //! \writeme
188         bool empty()const;
189
190         //! \writeme
191         Type get_contained_type()const;
192
193         //! Returns true if the contained value is defined and valid.
194         bool is_valid()const;
195
196         //!     Returns a string containing the name of the type
197         String type_name()const { return type_name(type); }
198
199         //! Returns the type of the contained value
200         const Type & get_type()const { return type; }
201
202         //! Checks the type of the parameter against itself. Returns true if they are of the same type.
203         template <class T> bool
204         same_type_as(const T &x)const
205         {
206                 const Type testtype(get_type(x));
207
208                 return same_type_as(testtype);
209         }
210
211         bool same_type_as(const Type testtype)const
212         {
213                 if(testtype==type)return true;
214                 if(     (type==TYPE_REAL || type==TYPE_TIME) &&
215                         (testtype==TYPE_REAL || testtype==TYPE_TIME) )
216                         return true;
217                 return false;
218         }
219
220
221         // === GET MEMBERS ========================================================
222         template <typename T>
223         const T &get(const T& x)const
224         {
225                 assert(is_valid() && same_type_as(x));
226                 return *static_cast<const T*>(data);
227         }
228         float get(const float &)const { return get(Real()); }
229         etl::loose_handle<Canvas> get(const etl::handle<Canvas>&)const
230                 { return get(etl::loose_handle<Canvas>()); }
231         etl::loose_handle<Canvas> get(Canvas*)const
232                 { return get(etl::loose_handle<Canvas>()); }
233         const char* get(const char*)const;
234         const list_type& get_list()const { return get(list_type()); }
235         // ========================================================================
236
237
238
239         // === PUT MEMBERS ========================================================
240         template <typename T>
241         void put(T* x)const
242         {
243                 assert(same_type_as(*x));
244                 *x=*static_cast<const T*>(data);
245         }
246         void put(float* x)const { *x=get(Real()); }
247         void put(char** x)const;
248         // ========================================================================
249
250
251
252         // === SET MEMBERS ========================================================
253         template <typename T> void set(const T& x) { _set(x); }
254         void set(const float &x) { _set(Real(x)); }
255         void set(const list_type &x);
256         void set(const char* x);
257         void set(Canvas*x);
258         void set(etl::loose_handle<Canvas> x);
259         void set(etl::handle<Canvas> x);
260         template <class T> void set(const std::vector<T> &x)
261                 { _set(list_type(x.begin(),x.end())); }
262         template <class T> void set(const std::list<T> &x)
263                 { _set(list_type(x.begin(),x.end())); }
264         // ========================================================================
265
266
267         /*
268  --     ** -- S T A T I C   F U N C T I O N S -------------------------------------
269         */
270
271 public:
272
273         //!     Returns a string containing the name of the given Type
274         static String type_name(Type id);
275
276         //!     Returns a the corresponding Type of the described type
277         static Type ident_type(const String &str);
278
279
280         // === GET TYPE MEMBERS ===================================================
281         static const Type get_type(bool) { return TYPE_BOOL; }
282         static const Type get_type(int) { return TYPE_INTEGER; }
283         static const Type get_type(const Time&) { return TYPE_TIME; }
284         static const Type get_type(const Real&) { return TYPE_REAL; }
285         static const Type get_type(const float&) { return TYPE_REAL; }
286         static const Type get_type(const Vector&) { return TYPE_VECTOR; }
287         static const Type get_type(const Color&) { return TYPE_COLOR; }
288         static const Type get_type(const Segment&) { return TYPE_SEGMENT; }
289         static const Type get_type(const BLinePoint&) { return TYPE_BLINEPOINT; }
290         static const Type get_type(const String&) { return TYPE_STRING; }
291         static const Type get_type(const Gradient&) { return TYPE_GRADIENT; }
292         static const Type get_type(Canvas*) { return TYPE_CANVAS; }
293         static const Type get_type(const etl::handle<Canvas>&)
294                 { return TYPE_CANVAS; }
295         static const Type get_type(const etl::loose_handle<Canvas>&)
296                 { return TYPE_CANVAS; }
297         static const Type get_type(const list_type&) { return TYPE_LIST; }
298         template <class T> static const Type get_type(const std::vector<T> &/*x*/)
299                 { return TYPE_LIST; }
300         template <class T> static const Type get_type(const std::list<T> &/*x*/)
301                 { return TYPE_LIST; }
302         // ========================================================================
303
304
305         /*
306  --     ** -- C A S T   O P E R A T O R S -----------------------------------------
307         */
308
309 public:
310
311         operator const list_type&()const { return get_list(); }
312         //operator const Color&()const { return get(Color()); }
313         //operator const Real&()const { return get(Real()); }
314         //operator const Time&()const { return get(Time()); }
315
316         operator const Vector&()const {  return get(Vector()); }
317         operator const BLinePoint&()const {  return get(BLinePoint()); }
318         //operator const int&()const {  return get(int()); }
319         //operator const String&()const {  return get(String()); }
320         //operator const char *()const {  return get(String()).c_str(); }
321         operator const Segment&()const { return get(Segment()); }
322
323
324         /*
325  --     ** -- O T H E R -----------------------------------------------------------
326         */
327
328 public:
329
330 #ifdef USE_HALF_TYPE
331         half get(const half &)const { return get(Real()); }
332         void put(half*x)const { *x=get(Real()); }
333         void set(const half &x) { _set(Real(x)); }
334         static const Type get_type(const half&) { return TYPE_REAL; }
335         operator half()const { return get(Real()); }
336 #endif
337
338 #ifndef SYNFIG_NO_ANGLE
339         operator const Angle&()const { return get(Angle()); }
340         static const Type get_type(const Angle&) { return TYPE_ANGLE; }
341 #endif
342
343         template <class T>
344         operator std::list<T>()const
345         {
346                 assert(type==TYPE_LIST);
347                 std::list<T> ret(get_list().begin(),get_list().end());
348                 return ret;
349         }
350         template <class T>
351         operator std::vector<T>()const
352         {
353                 assert(type==TYPE_LIST);
354                 std::vector<T> ret(get_list().begin(),get_list().end());
355                 return ret;
356         }
357
358
359 private:
360
361         template <typename T> void
362         _set(const T& x)
363         {
364                 const Type newtype(get_type(x));
365
366                 assert(newtype!=TYPE_NIL);
367
368                 if(newtype==type)
369                 {
370                         if(ref_count.unique())
371                         {
372                                 *reinterpret_cast<T*>(data)=x;
373                                 return;
374                         }
375                 }
376
377                 clear();
378
379                 type=newtype;
380                 ref_count.reset();
381                 data=new T(x);
382         }
383 }; // END of class ValueBase
384
385
386 /*!     \class Value
387 **      \todo writeme
388 */
389 template <class T>
390 class Value : public ValueBase
391 {
392 public:
393         Value(const T &x):ValueBase(x)
394         {
395         }
396
397         Value(const ValueBase &x):ValueBase(x)
398         {
399                 if(!x.same_type_as(T()))
400                         throw Exception::BadType("Value<T>(ValueBase): Type Mismatch");
401         }
402
403         Value()
404         {
405         }
406
407         T get()const { return ValueBase::get(T()); }
408
409         void put(T* x)const     { ValueBase::put(x); }
410
411         void set(const T& x) { ValueBase::operator=(x); }
412
413         Value<T>& operator=(const T& x) { set(x); return *this; }
414
415         Value<T>& operator=(const Value<T>& x) { return ValueBase::operator=(x); }
416
417         Value<T>& operator=(const ValueBase& x)
418         {
419                 if(!x.same_type_as(T()))
420                         throw Exception::BadType("Value<T>(ValueBase): Type Mismatch");
421                 return ValueBase::operator=(x);
422         }
423
424 }; // END of class Value
425
426 /*
427 template <>
428 class Value< std::list<CT> > : public ValueBase
429 {
430 public:
431         Value(const T &x):ValueBase(x)
432         {
433         }
434         Value(const ValueBase &x):ValueBase(x)
435         {
436                 if(!x.same_type_as(T()))
437                         throw Exception::BadType("Value<T>(ValueBase): Type Mismatch");
438         }
439         Value()
440         {
441         }
442
443         T get()const { return ValueBase::get(T()); }
444
445         void put(T* x)const     { ValueBase::put(x); }
446
447         void set(const T& x) { ValueBase::operator=(x); }
448
449         Value<T>& operator=(const T& x) { set(x); return *this; }
450
451         Value<T>& operator=(const Value<T>& x) { return ValueBase::operator=(x); }
452
453         Value<T>& operator=(const ValueBase& x)
454         {
455                 if(!x.same_type_as(T()))
456                         throw Exception::BadType("Value<T>(ValueBase): Type Mismatch");
457                 return ValueBase::operator=(x);
458         }
459
460 }; // END of class Value
461 */
462
463 }; // END of namespace synfig
464
465 /* === E N D =============================================================== */
466
467 #endif