/*
 * gamelist.c -- Functions to manage a gamelist
 * XBoard $Id: $
 *
 * Copyright 1995 Free Software Foundation, Inc.
 *
 * ------------------------------------------------------------------------
 * 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 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., 675 Mass Ave, Cambridge, MA 02139, USA.
 * ------------------------------------------------------------------------
 *
 * This file could well be a part of backend.c, but I prefer it this
 * way.
 */

#include <stdio.h>
#include <errno.h>
#if STDC_HEADERS
# include <stdlib.h>
# include <string.h>
#else /* not STDC_HEADERS */
# if HAVE_STRING_H
#  include <string.h>
# else /* not HAVE_STRING_H */
#  include <strings.h>
# endif /* not HAVE_STRING_H */
#endif /* not STDC_HEADERS */

#include "common.h"
#include "frontend.h"
#include "backend.h"
#include "parser.h"


/* Variables
 */
List gameList;


/* Local function prototypes
 */
static void GameListDeleteGame P((ListGame *));
static ListGame *GameListCreate P((void));
static void GameListFree P((List *));


/* Delete a ListGame; implies removint it from a list.
 */
static void GameListDeleteGame(listGame)
    ListGame *listGame;
{
    if (listGame) {
	if (listGame->gameInfo.event) free(listGame->gameInfo.event);
	if (listGame->gameInfo.site) free(listGame->gameInfo.site);
	if (listGame->gameInfo.date) free(listGame->gameInfo.date);
	if (listGame->gameInfo.round) free(listGame->gameInfo.round);
	if (listGame->gameInfo.white) free(listGame->gameInfo.white);
	if (listGame->gameInfo.black) free(listGame->gameInfo.black);
	if (listGame->gameInfo.fen) free(listGame->gameInfo.fen);
	if (listGame->gameInfo.resultDetails) free(listGame->gameInfo.resultDetails);
	if (listGame->gameInfo.timeControl) free(listGame->gameInfo.timeControl);
	if (listGame->gameInfo.extraTags) free(listGame->gameInfo.extraTags);
	ListNodeFree((ListNode *) listGame);
    }
}


/* Free the previous list of games.
 */
static void GameListFree(gameList)
    List *gameList;
{
    while (!ListEmpty(gameList))
    {
	GameListDeleteGame((ListGame *) gameList->head);
    }
}



/* Initialize a new GameInfo structure.
 */
void GameListInitGameInfo(gameInfo)
    GameInfo *gameInfo;
{
    gameInfo->event = NULL;
    gameInfo->site = NULL;
    gameInfo->date = NULL;
    gameInfo->round = NULL;
    gameInfo->white = NULL;
    gameInfo->black = NULL;
    gameInfo->result = GameUnfinished;
    gameInfo->fen = NULL;
    gameInfo->resultDetails = NULL;
    gameInfo->timeControl = NULL;
    gameInfo->extraTags = NULL;
}


/* Create empty ListGame; returns ListGame or NULL, if out of memory.
 *
 * Note, that the ListGame is *not* added to any list
 */
static ListGame *GameListCreate()

{
    ListGame *listGame;

    if ((listGame = (ListGame *) ListNodeCreate(sizeof(*listGame)))) {
	GameListInitGameInfo(&listGame->gameInfo);
    }
    return(listGame);
}


/* Creates a new game for the gamelist.
 */
static int GameListNewGame(ListGame **listGamePtr)

{
    if (!(*listGamePtr = (ListGame *) GameListCreate())) {
	GameListFree(&gameList);
	return(ENOMEM);
    }
    ListAddTail(&gameList, (ListNode *) *listGamePtr);
    return(0);
}


/* Build the list of games in the open file f.
 * Returns 0 for success or error number.
 */
int GameListBuild(f)
    FILE *f;
{
    ChessMove cm, lastStart;
    int gameNumber;
    ListGame *currentListGame = NULL;
    int error;
    int offset;

    GameListFree(&gameList);
    yynewfile(f);
    gameNumber = 0;

    lastStart = (ChessMove) 0;
    do {
	yyboardindex = 1;
	offset = yyoffset();
	cm = (ChessMove) yylex();
	switch (cm) {
	    case GNUChessGame:
	    case XBoardGame:
		lastStart = cm;
		break;
	    case MoveNumberOne:
		switch (lastStart) {
		    case GNUChessGame:
			break;  /*  ignore  */
		    case XBoardGame:
		    case PGNTag:
			lastStart = cm;
			break;  /*  Already counted */
		    case (ChessMove) 0:
		    case MoveNumberOne:
			if ((error = GameListNewGame(&currentListGame))) {
			    return(error);
			}
			currentListGame->number = ++gameNumber;
			currentListGame->offset = offset;
			lastStart = cm;
			break;
		    default:
			break;  /*  impossible  */
		}
		break;
	    case PGNTag:
		switch (lastStart) {
		    case GNUChessGame:
		    case PGNTag:
		    case MoveNumberOne:
		    case (ChessMove) 0:
			if ((error = GameListNewGame(&currentListGame))) {
			    return(error);
			}
			currentListGame->number = ++gameNumber;
			currentListGame->offset = offset;
			lastStart = cm;
			break;
		    case XBoardGame:
			lastStart = cm;
			break;  /*  Already counted */
		    default:
			break;  /*  impossible  */
		}
		ParsePGNTag(yy_text, &currentListGame->gameInfo);
		do {
		    yyboardindex = 1;
		    offset = yyoffset();
		    cm = (ChessMove) yylex();
		    if (cm == PGNTag) {
			ParsePGNTag(yy_text, &currentListGame->gameInfo);
		    }
		} while (cm == PGNTag  ||  cm == Comment);
		break;
	    default:
		break;
	}
    }
    while (cm != (ChessMove) 0);


    /* Scan gamelist and add missing event, white and black fields,
     * so that the list can be displayed.
     */
    for (currentListGame = (ListGame *) gameList.head;
	 currentListGame->node.succ;
	 currentListGame = (ListGame *) currentListGame->node.succ) {
	if (!currentListGame->gameInfo.event  &&
	    !StrSavePtr("Unknown", &currentListGame->gameInfo.event)) {
	    return(ENOMEM);
	}
	if (!currentListGame->gameInfo.white  &&
	    !StrSavePtr("Unknown", &currentListGame->gameInfo.white)) {
	    return(ENOMEM);
	}
	if (!currentListGame->gameInfo.black  &&
	    !StrSavePtr("Unknown", &currentListGame->gameInfo.black)) {
	    return(ENOMEM);
	}
	if (appData.debugMode) {
	    fprintf(debugFP, "Parsed game number %d, offset %ld:\n",
		    currentListGame->number, currentListGame->offset);
	    PrintPGNTags(debugFP, &currentListGame->gameInfo);
	}
    }

    return(0);
}


/* Clear an existing GameInfo structure.
 */
void ClearGameInfo(gameInfo)
    GameInfo *gameInfo;
{
    if (gameInfo->event != NULL) {
	free(gameInfo->event);
    }
    if (gameInfo->site != NULL) {
	free(gameInfo->site);
    }
    if (gameInfo->date != NULL) {
	free(gameInfo->date);
    }
    if (gameInfo->round != NULL) {
	free(gameInfo->round);
    }
    if (gameInfo->white != NULL) {
	free(gameInfo->white);
    }
    if (gameInfo->black != NULL) {
	free(gameInfo->black);
    }
    if (gameInfo->resultDetails != NULL) {
	free(gameInfo->resultDetails);
    }
    if (gameInfo->fen != NULL) {
	free(gameInfo->fen);
    }
    if (gameInfo->timeControl != NULL) {
	free(gameInfo->timeControl);
    }
    if (gameInfo->extraTags != NULL) {
	free(gameInfo->extraTags);
    }

    GameListInitGameInfo(gameInfo);
}