2005-11-11 Carl Worth <cworth@pippin.local>
[ttt] / src / ttt-board.c
1 /* ttt.c - client-server tic-tac-toe game
2  *
3  * Copyright © 2005 Carl Worth
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2, or (at your option)
8  * any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18  *
19  * Author: Carl Worth <cworth@cworth.org>
20  */
21
22 #include "ttt-board.h"
23
24 /* Initialize an empty board. */
25 void
26 ttt_board_init (ttt_board_t *board)
27 {
28   int i;
29   for (i = 0; i < TTT_BOARD_MAX_CELLS; i++)
30     {
31       board->cells[i] = 0;
32     }
33 }
34
35 /* Initialize a board from its string representation.
36  *
37  * Returns: TTT_BOARD_SUCCESS or TTT_BOARD_INVALID_BOARD if the board
38  * string could not be properly parsed.
39  */
40 void
41 ttt_board_init_from_string (ttt_board_t *board,
42                             const char  *s)
43 {
44     /* XXX: NYI */
45 }
46
47 /* Return the string representation of a board.
48  *
49  * The return value is a malloc()ed string that should be free()ed
50  * when no longer needed.
51  *
52  * Errors: If out-of-memory occurs, this function will not return.
53  */
54 char *
55 ttt_board_to_string (ttt_board_t *board)
56 {
57     /* XXX: NYI */
58     return NULL;
59 }
60
61 /* Write a string representation of a board to the provided file.
62  *
63  * Errors: If out-of-memory or a file IO error occurs, this function
64  * will not return.
65  */
66 void
67 ttt_board_write (ttt_board_t *board, FILE *file)
68 {
69     char *s;
70
71     s = ttt_board_to_string (board);
72
73     xfwrite (s, 1, strlen (s) + 1, file);
74
75     free (s);
76 }
77