trader/src/trader.c

/************************************************************************
*                                                                       *
*             Star Traders: A Game of Interstellar Trading              *
*                Copyright (C) 1990-2011, John Zaitseff                 *
*                                                                       *
************************************************************************/

/*
  Author: John Zaitseff <J.Zaitseff@zap.org.au>
  $Id$

  Star Traders is a simple game of interstellar trading, where the object
  of the game is to create companies, buy and sell shares, borrow and
  repay money, in order to become the wealthiest player (the winner).

  This file, trader.c, contains the main program for Star Traders.


  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/.
*/


#include "trader.h"


/************************************************************************
*                    Internal function declarations                     *
************************************************************************/

int main (int argc, char *argv[]);

void process_cmdline (int argc, char *argv[]);
void show_version (void) __attribute__((noreturn));
void show_usage (int status) __attribute__((noreturn));

void init_program (void);
void end_program (void);


/************************************************************************
*                             Main program                              *
************************************************************************/

int main (int argc, char *argv[])
{
    init_program_name(argv);

    // Initialise the locale
    if (setlocale(LC_ALL, "") == NULL) {
	err_exit("could not set locale (check LANG, LC_ALL and LANGUAGE in environment)");
    }

    // Process command line arguments
    process_cmdline(argc, argv);

    // Set up the display, internal low-level routines, etc.
    init_program();

    // Play the actual game
    init_game();
    while (! quit_selected && ! abort_game && turn_number <= max_turn) {
	select_moves();
	get_move();
	process_move();
	exchange_stock();
	next_player();
    }
    end_game();

    // Finish up...
    end_program();
    return EXIT_SUCCESS;
}


/************************************************************************
*                        Command line processing                        *
************************************************************************/

/* Constants for command line options */

enum options_char {
    OPTION_NO_COLOR = 1,
};

static const char options_short[] = "hV";
    /* -h   --help
       -V   --version
    */

static struct option const options_long[] = {
    { "help",      no_argument, NULL, 'h' },
    { "version",   no_argument, NULL, 'V' },
    { "no-color",  no_argument, NULL, OPTION_NO_COLOR },
    { "no-colour", no_argument, NULL, OPTION_NO_COLOR },
    { NULL,        0,           NULL, 0 }
};


/*-----------------------------------------------------------------------
  Function:   process_cmdline  - Process command line arguments
  Arguments:  argc             - Same as passed to main()
              argv             - Same as passed to main()
  Returns:    (nothing)

  This function processes the command line arguments passed through argc
  and argv, setting global variables as appropriate.
*/

void process_cmdline (int argc, char *argv[])
{
    int c;

    // Process arguments starting with "-" or "--"
    opterr = true;
    while (true) {
	c = getopt_long(argc, argv, options_short, options_long, NULL);
	if (c == EOF)
	    break;

	switch (c) {
	case 'h':
	    // -h, --help: show help
	    show_usage(EXIT_SUCCESS);
	    break;

	case 'V':
	    // -V, --version: show version information
	    show_version();
	    break;

	case OPTION_NO_COLOR:
	    // --no-color, --no-colour: don't use colour
	    option_no_color = true;
	    break;

	default:
	    show_usage(EXIT_FAILURE);
	}
    }

    // Process remaining arguments

    if ((optind < argc) && (argv[optind] != NULL)) {
	if (argv[optind][0] == '-') {
	    fprintf(stderr, "%s: invalid operand `%s'\n", program_name(),
		    argv[optind]);
	    show_usage(EXIT_FAILURE);
	}

	if ((strlen(argv[optind]) == 1) &&
	    (*argv[optind] >= '1') && (*argv[optind] <= '9')) {
	    game_num = *argv[optind] - '0';
	} else {
	    fprintf(stderr, "%s: invalid game number `%s'\n",
		    program_name(), argv[optind]);
	    show_usage(EXIT_FAILURE);
	}

	optind++;
    }

    if ((optind < argc) && (argv[optind] != NULL)) {
	fprintf(stderr, "%s: extra operand `%s'\n", program_name(),
		argv[optind]);
	show_usage(EXIT_FAILURE);
    }
}


/*-----------------------------------------------------------------------
  Function:   show_version  - Show program version information
  Arguments:  (none)
  Returns:    (nothing)

  This function displays version information about this program, then
  terminates.
*/

void show_version (void)
{
    printf("\
" PACKAGE_NAME " (%s) %s\n\
Copyright (C) %s, John Zaitseff.\n\
\n\
Star Traders is a simple game of interstellar trading, where the object\n\
of the game is to create companies, buy and sell shares, borrow and repay\n\
money, in order to become the wealthiest player (the winner).\n\
\n\
This program is free software that is distributed under the terms of the\n\
GNU General Public License, version 3 or later.  You are welcome to\n\
modify and/or distribute it under certain conditions.  This program has\n\
NO WARRANTY, to the extent permitted by law; see the License for details.\n\
", program_name(), PACKAGE_VERSION, "1990-2011");

    exit(EXIT_SUCCESS);
}


/*-----------------------------------------------------------------------
  Function:   show_usage  - Show command line usage information
  Arguments:  status      - Exit status
  Returns:    (nothing)

  This function displays usage information to standard output or standard
  error, then terminates.
*/

void show_usage (int status)
{
    const char *pn = program_name();

    if (status != EXIT_SUCCESS) {
	fprintf(stderr, "%s: Try `%s --help' for more information.\n",
		pn, pn);
    } else {
	printf("Usage: %s [OPTION ...] [GAME]\n", pn);
	printf("\
Play Star Traders, a simple game of interstellar trading.\n\n\
");
	printf("\
Options:\n\
  -V, --version    output version information and exit\n\
  -h, --help       display this help and exit\n\
      --no-color   don't use colour for displaying text\n\n\
");
	printf("\
If GAME is specified as a number between 1 and 9, load and continue\n\
playing that game.  If GAME is not specified, start a new game.\n\n\
");

#ifdef PACKAGE_AUTHOR
	printf("Report bugs to %s <%s>.\n", PACKAGE_AUTHOR, PACKAGE_BUGREPORT);
#else
	printf("Report bugs to <%s>.\n", PACKAGE_BUGREPORT);
#endif
#ifdef PACKAGE_PACKAGER_BUG_REPORTS
	printf("Report %s bugs to <%s>.\n", PACKAGE_PACKAGER, PACKAGE_PACKAGER_BUG_REPORTS);
#endif
#ifdef PACKAGE_URL
	printf(PACKAGE_NAME " home page: <%s>.\n", PACKAGE_URL);
#endif
    }

    exit(status);
}


/************************************************************************
*       Initialisation and deinitialisation function definitions        *
************************************************************************/


/*-----------------------------------------------------------------------
  Function:   init_program  - Initialise program-wide functions
  Arguments:  (none)
  Returns:    (nothing)

  This function initialises the terminal display, internal low-level
  routines, etc.
*/

void init_program (void)
{
    // Initialise the random number generator
    init_rand();

    // Initialise the terminal display
    init_screen();

    // Initialise signal-handling functions
    // @@@ To be completed
}


/*-----------------------------------------------------------------------
  Function:   end_program  - Deinitialise program-wide functions
  Arguments:  (none)
  Returns:    (nothing)

  This function finalises the terminal display, internal low-level
  routines, etc.
*/

void end_program (void)
{
    end_screen();
}