Xcos: introduce a new XML based format (using XMI)
[scilab.git] / scilab / modules / scicos / includes / model / BaseObject.hxx
1 /*
2  *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
3  *  Copyright (C) 2014-2016 - Scilab Enterprises - Clement DAVID
4  *
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  *
7  * This file is hereby licensed under the terms of the GNU GPL v2.0,
8  * pursuant to article 5.3.4 of the CeCILL v.2.1.
9  * This file was originally licensed under the terms of the CeCILL v2.1,
10  * and continues to be available under such terms.
11  * For more information, see the COPYING file which you should have received
12  * along with this program.
13  *
14  */
15
16 #ifndef BASEOBJECT_HXX_
17 #define BASEOBJECT_HXX_
18
19 #include <vector>
20 #include <initializer_list>
21
22 #include "utilities.hxx"
23
24 namespace org_scilab_modules_scicos
25 {
26 namespace model
27 {
28
29 class BaseObject
30 {
31 public:
32     explicit BaseObject(kind_t k) :
33         m_kind(k)
34         // Not initializing m_id on purpose: the ID is given by the model constructor
35     {
36     }
37     BaseObject(const BaseObject& b) :
38         m_id(b.m_id), m_kind(b.m_kind)
39     {
40     }
41     BaseObject(BaseObject&& b) :
42         m_id(b.m_id), m_kind(b.m_kind)
43     {
44     }
45     BaseObject(ScicosID id, kind_t k) :
46         m_id(id), m_kind(k)
47     {
48     }
49
50     ~BaseObject() = default;
51
52     inline BaseObject& operator=(BaseObject&& o)
53     {
54         m_id = o.m_id;
55         m_kind = o.m_kind;
56         return *this;
57     }
58     inline bool operator<(BaseObject o) const
59     {
60         return m_id < o.m_id;
61     }
62     inline bool operator==(BaseObject o) const
63     {
64         return m_id == o.m_id;
65     }
66
67     inline ScicosID id() const
68     {
69         return m_id;
70     }
71     inline void id(ScicosID _id)
72     {
73         m_id = _id;
74     }
75
76     inline kind_t kind() const
77     {
78         return m_kind;
79     }
80
81 private:
82     /**
83      * An id is used as a reference to the current object
84      */
85     ScicosID m_id;
86
87     /**
88      * Kind of the Object
89      */
90     kind_t m_kind;
91 };
92
93 /** @defgroup utilities Shared utility classes
94  * @{
95  */
96
97 /*
98  * Represent a graphical object
99  */
100 struct Geometry
101 {
102     double m_x;
103     double m_y;
104     double m_width;
105     double m_height;
106
107     Geometry() : m_x(0), m_y(0), m_width(20), m_height(20) {};
108     Geometry(const Geometry& g) : m_x(g.m_x), m_y(g.m_y), m_width(g.m_width), m_height(g.m_height) {};
109     Geometry(const std::vector<double>& v) : m_x(v[0]), m_y(v[1]), m_width(v[2]), m_height(v[3]) {};
110     Geometry(std::initializer_list<double> l) : m_x(*l.begin()), m_y(*(l.begin() + 1)), m_width(*(l.begin() + 2)), m_height(*(l.begin() + 3)) {};
111
112     void fill(std::vector<double>& v) const
113     {
114         v.resize(4);
115         v[0] = m_x;
116         v[1] = m_y;
117         v[2] = m_width;
118         v[3] = m_height;
119     }
120     bool operator==(const Geometry& g) const
121     {
122         return m_x == g.m_x && m_y == g.m_y && m_width == g.m_width && m_height == g.m_height;
123     }
124 };
125
126 /**
127  * Per port type descriptor
128  *
129  * FIXME: should reuse Scilab datatypes descriptors
130  */
131 struct Datatype
132 {
133 public:
134     Datatype(const Datatype& d) :
135         m_refCount(0), m_datatype_id(d.m_datatype_id), m_rows(d.m_rows), m_columns(d.m_columns) {};
136     Datatype(const std::vector<int>& v) :
137         m_refCount(0), m_datatype_id(v[2]), m_rows(v[0]), m_columns(v[1]) {};
138
139     // reference counter for the flyweight pattern
140     int m_refCount;
141
142     const int m_datatype_id;
143     const int m_rows;
144     const int m_columns;
145
146     bool operator==(const Datatype& d) const
147     {
148         return m_datatype_id == d.m_datatype_id && m_rows == d.m_rows && m_columns == d.m_columns;
149     }
150
151     bool operator<(const Datatype& d) const
152     {
153         // Lexicographical order
154         return m_datatype_id < d.m_datatype_id ||
155                (m_datatype_id == d.m_datatype_id && m_rows < d.m_rows) ||
156                (m_datatype_id == d.m_datatype_id && m_rows == d.m_rows && m_columns < d.m_columns);
157     }
158 };
159
160 /** @}*/
161
162 } /* namespace model */
163 } /* namespace org_scilab_modules_scicos */
164
165 #endif /* BASEOBJECT_HXX_ */