/**

  * $Id: dream.h,v 1.15 2007-10-11 08:22:03 nkeynes Exp $

  *

  * Miscellaneous application-wide declarations (mainly logging atm)

  *

  * Copyright (c) 2005 Nathan Keynes.

  *

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

  */

 #ifndef dream_H

 #define dream_H 1

 #include <stdio.h>

 #include <stdlib.h>

 #include <stdint.h>

 #include <string.h>

 #include <glib/gtypes.h>

 #ifdef __cplusplus

 extern "C" {

 #endif

 #define APP_NAME "lxDream"

 #define APP_VERSION "0.8"

 /************************ Modules ********************************/

 /**

  * Basic module structure defining the common operations across all

  * modules, ie start, stop, reset, etc. 

  */

 typedef struct dreamcast_module {

     char *name;

     /**

      * Perform all initial module setup (ie register / allocate any

      * memory required, etc). Only called once during system startup

      */

     void (*init)();

     /**

      * Reset the module into it's initial system boot state. Will be called

      * once after init(), as well as whenever the user requests a reset.

      */

     void (*reset)();

     /**

      * Set the module into a running state (may be NULL)

      */

     void (*start)();

     /**

      * Execute one time-slice worth of operations, for the given number of

      * nanoseconds.

      * @return Number of nanoseconds actually executed

      */

     uint32_t (*run_time_slice)( uint32_t nanosecs );

     /**

      * Set the module into a stopped state (may be NULL)

      */

     void (*stop)();

     /**

      * Save the module state to the FILE stream. May be NULL, in which case

      * the module is considered to have no state.

      */

     void (*save)(FILE *);

     /**

      * Load the saved module state from the FILE stream. May be NULL, in which

      * case reset() will be called instead.

      * @return 0 on success, nonzero on failure.

      */

     int (*load)(FILE *);

 } *dreamcast_module_t;

 void dreamcast_register_module( dreamcast_module_t );

 extern struct dreamcast_module mem_module;

 extern struct dreamcast_module sh4_module;

 extern struct dreamcast_module asic_module;

 extern struct dreamcast_module pvr2_module;

 extern struct dreamcast_module aica_module;

 extern struct dreamcast_module ide_module;

 extern struct dreamcast_module maple_module;

 extern struct dreamcast_module pvr2_module;

 extern struct dreamcast_module gui_module;

 extern struct dreamcast_module eventq_module;

 extern struct dreamcast_module unknown_module;

 /*************************** Logging **************************/

 #define EMIT_FATAL 0

 #define EMIT_ERR 1

 #define EMIT_WARN 2

 #define EMIT_INFO 3

 #define EMIT_DEBUG 4

 #define EMIT_TRACE 5

 #ifndef MODULE

 #define MODULE unknown_module

 #endif

 void log_message( void *, int level, const char *source, const char *msg, ... );

 #define FATAL( ... ) log_message( NULL, EMIT_FATAL, MODULE.name, __VA_ARGS__ )

 #define ERROR( ... ) log_message( NULL, EMIT_ERR, MODULE.name, __VA_ARGS__ )

 #define WARN( ... ) log_message( NULL, EMIT_WARN, MODULE.name, __VA_ARGS__ )

 #define INFO( ... ) log_message( NULL, EMIT_INFO, MODULE.name, __VA_ARGS__ )

 #define DEBUG( ... ) log_message( NULL, EMIT_DEBUG, MODULE.name, __VA_ARGS__ )

 #define TRACE( ... ) log_message( NULL, EMIT_TRACE, MODULE.name, __VA_ARGS__ )

 void fwrite_string( const char *s, FILE *f );

 int fread_string( char *s, int maxlen, FILE *f );

 void fwrite_dump( unsigned char *buf, unsigned int length, FILE *f );

 void fwrite_dump32( unsigned int *buf, unsigned int length, FILE *f );

 void fwrite_dump32v( unsigned int *buf, unsigned int length, int wordsPerLine, FILE *f );

 typedef uint32_t sh4addr_t;

 #ifndef max

 #define max(a,b) ( (a) > (b) ? (a) : (b) )

 #endif

 #ifdef __cplusplus

 }

 #endif

 #endif