File: BoardLayout.h

package info (click to toggle)
kmahjongg 4:4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 1,968 kB
  • ctags: 427
  • sloc: cpp: 3,945; makefile: 9; sh: 2
file content (230 lines) | stat: -rw-r--r-- 5,618 bytes parent folder | download
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
219
220
221
222
223
224
225
226
227
228
229
230
/*
    Copyright (C) 1997 Mathias Mueller   <in5y158@public.uni-hamburg.de>

    Kmahjongg 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 2 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, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
*/

#ifndef BOARD_LAYOUT_H
#define BOARD_LAYOUT_H

#include <QString>
#include <QByteArray>
#include "KmTypes.h"

const QString layoutMagic1_0 = "kmahjongg-layout-v1.0";
const QString layoutMagic1_1 = "kmahjongg-layout-v1.1";

/**
 * @short This class implements methods for loading and manipulating board
 *
 * longer description
 *
 * @author Mauricio Piacentini  <mauricio@tabuleiro.com>
 */
class BoardLayout {

public:
    /**
     * Default Constructor
     */
    BoardLayout();

    /**
     * Copy constructor */
    BoardLayout(const BoardLayout &boardLayout);

    /**
     * Default Deconstructor
     */
    ~BoardLayout();
    /**
     * Method description
     * 
     * @param from blah blah
     * @return @c true if ...
     * @return @c false if ...
     */
    bool loadBoardLayout(const QString &from);
    /**
     * Method description
     * 
     * @param from blah blah
     * @return @c true if ...
     * @return @c false if ...
     * @see loadBoardLayout
     */
    bool loadBoardLayout_10(const QString &from);
    /**
     * Method description
     * 
     * @param where blah blah
     * @return @c true if ...
     * @return @c false if ...
     * @see loadBoardLayout
     */
    bool saveBoardLayout(const QString &where);
    /**
     * Method description
     * 
     * @param z blah blah
     * @param y blah blah
     * @param x blah blah
     * @return UCHAR ...
     */
    UCHAR getBoardData(short z, short y, short x);
    /**
     * Method description
     * 
     * @param z blah blah
     * @param y blah blah
     * @param x blah blah
     * @param value blah blah
     */
    void setBoardData(short z, short y, short x, UCHAR value);

    /**
     * is there a tile anywhere above here (top left to bot right quarter)
     * 
     * @param z blah blah
     * @param y blah blah
     * @param x blah blah
     * @return @c true if title abowe
     * @return @c false if title not abowe
     */
    bool tileAbove(short z, short y, short x);
    /**
     * is there a tile anywhere above here (top left to bot right quarter)
     * 
     * @param &p blah blah @ref pos
     * @return @c true if title abowe
     * @return @c false if title not abowe
     * @see tileAbove
     */
    bool tileAbove(POSITION &p) { return(tileAbove(p.e, p.y, p.x));	}	

    /**
     * is this tile blocked to the left or right
     * 
     * @param z blah blah
     * @param y blah blah
     * @param x blah blah
     * @return @c true if ...
     * @return @c false if ...
     */
    bool blockedLeftOrRight(short z, short y, short x);
    /**
     * Description
     * 
     * @param &p blah blah @ref pos
     */
    void deleteTile(POSITION &p);
    /**
     * Description
     * 
     * @param &p blah blah @ref pos
     * @return @c true if title abowe
     * @return @c false if title not abowe
     */
    bool anyFilled(POSITION &p);
    /**
     * Description
     * 
     * @param &p blah blah @ref pos
     * @return @c true if title abowe
     * @return @c false if title not abowe
     */
    bool allFilled(POSITION &p);
    /**
     * Description
     * 
     * @param &p blah blah
     * @see pos
     */
    void insertTile(POSITION &p);
    /**
     * Description
     * 
     * @param &p blah blah
     * @see pos
     * @return @c true if title abowe
     * @return @c false if title not abowe
     */
    bool isTileAt(POSITION &p) { return getBoardData(p.e, p.y, p.x) == '1'; }
    /**
     * Description
     * 
     * @param *to blah blah
     * @param &numTiles blah blah
     */
    void copyBoardLayout(UCHAR *to , unsigned short &numTiles); 
    /**
     * Method description
     */
    void clearBoardLayout();
    /**
     * Method description
     */
    void shiftLeft();
    /**
     * Method description
     */
    void shiftRight();
    /**
     * Method description
     */
    void shiftUp();
    /**
     * Method description
     */
    void shiftDown();

    /**
     * Get the loaded board. */
    QByteArray getLoadedBoard() const;

    /**
     * Get the board. */
    QByteArray getBoard() const;

    /**
     * Get max tile num. */
    unsigned short getMaxTileNum() const;

     int m_width;   /**< Member Description */
     int m_height;  /**< Member Description */
     int m_depth;   /**< Member Description */
     int m_maxTiles;/**< Member Description */
    /**
     * Get filename
     *
     * @return filename
     */
    QString getFilename() const;
     
protected:
    /**
     * Protected Method description
     */
    void initialiseBoard(); 

private:
    QString filename;       /**< Private Member Description */
    QByteArray loadedBoard; /**< Private Member Description */
    QByteArray board;       /**< Private Member Description */
    unsigned short maxTileNum; /**< Private Member Description */
};

#endif