1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
// -*- mode: c++ -*-
//
// This file is part of libyacurs.
// Copyright (C) 2013 Rafael Ostertag
//
// This program is free software: you can redistribute it and/or
// modify it under the terms of the GNU General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see
// <http://www.gnu.org/licenses/>.
//
//
// $Id$
#ifndef COORDINATES_H
#define COORDINATES_H 1
// Can't use #ifdef HAVE_STDINT_H since that would require pulling in
// config.h or libyacurscfg.h which might cause undesired side
// effects.
#include <stdint.h>
#include <string>
namespace YACURS {
/**
* Coordinates as used throughout Curses.
*/
class Coordinates {
private:
/**
* Object representing zero.
*/
static Coordinates _zero;
/**
* y component.
*/
int16_t _y;
/**
* x component
*/
int16_t _x;
public:
/**
* Constructor.
*
* When no arguments are provided, it initializes the object
* to zero, i.e. x=0, y=0.
*
* @param x x-component
* @param y y-component
*/
Coordinates(int16_t x = 0, int16_t y = 0);
/**
* Get x component.
*
* @return x component
*/
int16_t x() const;
/**
* Get y component
*
* @return y component
*/
int16_t y() const;
/**
* Set x component.
*
* @param x value of x
*/
void x(int16_t x);
/**
* Set y component.
*
* @param y value of y
*/
void y(int16_t y);
/**
* Add and assign another Coordinates object.
*
* Component wise add and assign another Coordinates object.
*
* @param rhs right hand side to add
*
* @return reference to @c this.
*/
Coordinates& operator+=(const Coordinates& rhs);
/**
* Subtract and assign another Coordinates object.
*
* Component wise subtract and assign another Coordinates
* object.
*
* @param rhs right hand side to subtract.
*
* @return reference to @c this.
*/
Coordinates& operator-=(const Coordinates& rhs);
/**
* Test two Coordinates objects for equality.
*
* Test two Coordinates object component wise for equality.
*
* @param rhs right hand side to test for equality.
*
* @return @c true if both Coordinates objects are component
* wise equal, @c false otherwise.
*/
bool operator==(const Coordinates& rhs) const;
/**
* Return the object representing zero.
*
* @return Coordinates object representing zero.
*/
static const Coordinates& zero();
};
/**
* Component wise addition.
*
* Adds two Coordinates objects component wise.
*
* @param rhs right hand side of addition.
*
* @return sum of two Coordinate objects.
*/
Coordinates operator+(const Coordinates& lhs, const Coordinates& rhs);
/**
* Component wise subtraction.
*
* Subtracts two Coordinates objects comonent wise.
*
* @param rhs right hand side of subtraction.
*
* @return difference of two Coordinate objects.
*/
Coordinates operator-(const Coordinates& lhs, const Coordinates& rhs);
/**
* Test two Coordinates object for inequality.
*
* Simply
*
* <code>!Coordinates::operator==()</code>
*
* @param rhs right hand side of comparison.
*
* @return @c true if Coordinates object are not equal, @c
* false otherwise.
*/
bool operator!=(const Coordinates& lhs, const Coordinates& rhs);
inline Coordinates::Coordinates(int16_t x, int16_t y) : _y(y), _x(x) {}
inline int16_t Coordinates::x() const { return _x; }
inline int16_t Coordinates::y() const { return _y; }
inline void Coordinates::x(int16_t x) { _x = x; }
inline void Coordinates::y(int16_t y) { _y = y; }
inline Coordinates& Coordinates::operator+=(const Coordinates& rhs) {
_x += rhs._x;
_y += rhs._y;
return *this;
}
inline Coordinates& Coordinates::operator-=(const Coordinates& rhs) {
_x -= rhs._x;
_y -= rhs._y;
return *this;
}
inline bool Coordinates::operator==(const Coordinates& rhs) const {
return _x == rhs._x && _y == rhs._y;
}
inline const Coordinates& Coordinates::zero() { return _zero; }
inline Coordinates operator+(const Coordinates& lhs, const Coordinates& rhs) {
Coordinates tmp = lhs;
return tmp += rhs;
}
inline Coordinates operator-(const Coordinates& lhs, const Coordinates& rhs) {
Coordinates tmp = lhs;
return tmp -= rhs;
}
inline bool operator!=(const Coordinates& lhs, const Coordinates& rhs) {
return !(lhs == rhs);
}
} // namespace YACURS
#endif // COORDINATES_H
|
