2005-11-05 Carl Worth <cworth@cworth.org>
[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     /* XXX: NYI */
29 }
30
31 /* Initialize a board from its string representation.
32  *
33  * Returns: TTT_BOARD_SUCCESS or TTT_BOARD_INVALID_BOARD if the board
34  * string could not be properly parsed.
35  */
36 void
37 ttt_board_init_from_string (ttt_board_t *board,
38                             const char  *s)
39 {
40     /* XXX: NYI */
41 }
42
43 /* Return the string representation of a board.
44  *
45  * The return value is a malloc()ed string that should be free()ed
46  * when no longer needed.
47  *
48  * Errors: If out-of-memory occurs, this function will not return.
49  */
50 char *
51 ttt_board_to_string (ttt_board_t *board)
52 {
53     /* XXX: NYI */
54 }
55
56 /* Write a string representation of a board to the provided file.
57  *
58  * Errors: If out-of-memory or a file IO error occurs, this function
59  * will not return.
60  */
61 void
62 ttt_board_write (ttt_board_t *board, FILE *file)
63 {
64     char *s;
65
66     s = ttt_board_to_string (board);
67
68     xfwrite (s, 1, strlen (s) + 1, file);
69
70     free (s);
71 }
72