User interface header. More...

#include "board.h"
#include "book.h"
#include "event.h"
#include "search.h"
#include "move.h"
#include "play.h"

Classes
struct	UI

Macros
#define	DLL_API

Typedefs
typedef struct UI	UI

Functions
bool	ui_switch (UI , const char )
	Switch between different User Interface. More...

void	ui_event_init (UI *)
	Create a new Othello User Interface. More...

bool	ui_event_peek (UI , char , char *)
	Wait input. More...

void	ui_event_wait (UI , char , char *)
	Wait input. More...

bool	ui_event_exist (UI *)
	ui_event_exist More...

void	ui_event_free (UI *)
	Free events. More...

void	ui_init_edax (UI *)
	initialize edax protocol. More...

void	ui_loop_edax (UI *)
	Loop event. More...

void	ui_free_edax (UI *)
	free resources used by edax protocol. More...

void	ui_init_gtp (UI *)
	initialize edax protocol More...

void	ui_loop_gtp (UI *)
	Loop event. More...

void	ui_free_gtp (UI *)
	free resources used by edax protocol More...

void	ui_init_nboard (UI *)
	initialize edax protocol More...

void	ui_loop_nboard (UI *)
	Loop event. More...

void	ui_free_nboard (UI *)
	free resources used by edax protocol More...

void	ui_init_xboard (UI *)
	initialize xboard protocol. More...

void	ui_loop_xboard (UI *)
	Loop event. More...

void	ui_free_xboard (UI *)
	free resources used by xboard protocol. More...

void	ui_init_ggs (UI *)
	ui_init_ggs More...

void	ui_loop_ggs (UI *)
	ui_loop_ggs More...

void	ui_free_ggs (UI *)
	ui_free_ggs More...

void	ui_init_cassio (UI *)

void	ui_loop_cassio (UI *)

void	ui_free_cassio (UI *)

void	ui_book_init (UI *)

DLL_API void	libedax_initialize (int, char **)
	edax init function for library use. More...

DLL_API void	libedax_terminate ()
	edax terminate function for library use. More...

DLL_API void	edax_init ()
	init command. More...

DLL_API void	edax_new ()
	new command. More...

DLL_API void	edax_load (const char *)
	load command. More...

DLL_API void	edax_save (const char *)
	save command. More...

DLL_API void	edax_undo ()
	undo command. More...

DLL_API void	edax_redo ()
	redo command. More...

DLL_API void	edax_mode (const int)
	mode command. More...

DLL_API void	edax_setboard (const char *)
	setboard command. More...

DLL_API void	edax_setboard_from_obj (const Board *, const int)
	setboard command with board object. More...

DLL_API void	edax_vmirror ()
	vmirror command. More...

DLL_API void	edax_hmirror ()
	hmirror command. More...

DLL_API void	edax_rotate (const int)
	rotate command. More...

DLL_API void	edax_symetry (const int)
	symetry command. More...

DLL_API void	edax_play (char *)
	play command. More...

DLL_API void	edax_force (char *)
	force command. More...

DLL_API void	edax_go ()
	go command. More...

DLL_API void	edax_hint (const int, HintList *)
	hint command. More...

DLL_API void	edax_hint_prepare ()
	hint command. Call edax_hint_next after calling this function. More...

DLL_API void	edax_hint_next (Hint *)
	hint command. Gets hint one by one. If there are no more hints, hint will be NOMOVE. Call edax_hint_prepare before calling this function. More...

DLL_API void	edax_stop ()
	stop command. More...

DLL_API int	edax_move (const char *)
	user move command. More...

DLL_API const char *	edax_opening ()
	opening command. More...

DLL_API const char *	edax_ouverture ()
	ouverture command. More...

DLL_API void	edax_book_store ()
	book store command. More...

DLL_API void	edax_book_on ()
	book on command. More...

DLL_API void	edax_book_off ()
	book off command. More...

DLL_API void	edax_book_randomness (const int)
	book randomness command. More...

DLL_API void	edax_book_depth (const int)
	book depth command. More...

DLL_API void	edax_book_new (const int, const int)
	book new command. More...

DLL_API void	edax_book_load (const char *)
	book load command. More...

DLL_API void	edax_book_save (const char *)
	book save command. More...

DLL_API void	edax_book_import (const char *)
	book import command. More...

DLL_API void	edax_book_export (const char *)
	book export command. More...

DLL_API void	edax_book_merge (const char *)
	book merge command. More...

DLL_API void	edax_book_fix ()
	book fix command. More...

DLL_API void	edax_book_negamax ()
	book negamax command. More...

DLL_API void	edax_book_correct ()
	book correct command. More...

DLL_API void	edax_book_prune ()
	book prune command. More...

DLL_API void	edax_book_subtree ()
	book subtree command. More...

DLL_API void	edax_book_show (Position *)
	book show command. More...

DLL_API void	edax_book_info (Book *)
	book info command. More...

DLL_API void	edax_book_verbose (const int)
	book verbose command. More...

DLL_API void	edax_book_add (const char *)
	book add command. More...

DLL_API void	edax_book_check (const char *)
	book check command. More...

DLL_API void	edax_book_extract (const char *)
	book extract command. More...

DLL_API void	edax_book_deviate (int, int)
	book deviate command. More...

DLL_API void	edax_book_enhance (int, int)
	book enhance command. More...

DLL_API void	edax_book_fill (int)
	book fill command. More...

DLL_API void	edax_book_play ()
	book play command. More...

DLL_API void	edax_book_deepen ()
	book deepen command. caution: Currently, this function does not work correctly. More...

DLL_API void	edax_book_feed_hash ()
	book feed-hash command. More...

DLL_API void	edax_base_problem (const char , const int, const char )
	base problem command. More...

DLL_API void	edax_base_tofen (const char , const int, const char )
	base tofen command. More...

DLL_API void	edax_base_correct (const char *, const int)
	base correct command. More...

DLL_API void	edax_base_complete (const char *)
	base complete command. More...

DLL_API void	edax_base_convert (const char , const char )
	base convert command. More...

DLL_API void	edax_base_unique (const char , const char )
	base unique command. More...

DLL_API void	edax_set_option (const char , const char )
	set (option) command. More...

DLL_API char *	edax_get_moves (char *)
	get moves of the current game. More...

DLL_API int	edax_is_game_over ()
	check if the current game is over. More...

DLL_API int	edax_can_move ()
	check if the current player can move. More...

DLL_API void	edax_get_last_move (Move *)
	get last move. More...

DLL_API void	edax_get_board (Board *)
	get current board. More...

DLL_API int	edax_get_current_player ()
	get current player. More...

DLL_API int	edax_get_disc (const int)
	get current number of discs. More...

DLL_API int	edax_get_mobility_count (const int)
	get current number of legal moves. More...

static void	libedax_observer (Result *)

void	ui_init_libedax (UI *)
	initialize libedax api. More...

void	ui_free_libedax (UI *)
	free resources used by libedax api. More...

void	auto_go ()
	auto go with regard to mode. More...

void	book_cmd_pre_process (UI *)
	pre-process of book command. More...

void	book_cmd_post_process (UI *)
	post-process of book command. More...

Detailed Description

User interface header.

Date: 1998 - 2017

Author: Richard Delorme

Version: 4.4

Macro Definition Documentation

◆ DLL_API

#define DLL_API

Typedef Documentation

◆ UI

typedef struct UI UI

UI structure

Function Documentation

◆ auto_go()

void auto_go ( )

auto go with regard to mode.

◆ book_cmd_post_process()

void book_cmd_post_process ( UI * ui )

post-process of book command.

Parameters

ui	user interface.

◆ book_cmd_pre_process()

void book_cmd_pre_process ( UI * ui )

pre-process of book command.

Parameters

ui	user interface.

◆ edax_base_complete()

DLL_API void edax_base_complete ( const char * base_file )

base complete command.

Parameters

base_file game database file.

◆ edax_base_convert()

DLL_API void edax_base_convert	(	const char *	base_file_from,
		const char *	base_file_to
	)

base convert command.

Parameters

base_file_from	input game database file.
base_file_to	output game database file.

◆ edax_base_correct()

DLL_API void edax_base_correct	(	const char *	base_file,
		const int	n_empties
	)

base correct command.

Parameters

base_file	game database file.
n_empties	number of empties.

◆ edax_base_problem()

DLL_API void edax_base_problem	(	const char *	base_file,
		const int	n_empties,
		const char *	problem_file
	)

base problem command.

Parameters

base_file	game database file.
n_empties	number of empties.
problem_file	problem_file to save.

◆ edax_base_tofen()

DLL_API void edax_base_tofen	(	const char *	base_file,
		const int	n_empties,
		const char *	problem_file
	)

base tofen command.

Parameters

base_file	game database file.
n_empties	number of empties.
problem_file	problem_file to save.

◆ edax_base_unique()

DLL_API void edax_base_unique	(	const char *	base_file_from,
		const char *	base_file_to
	)

base unique command.

Parameters

base_file_from	input game database file.
base_file_to	output game database file.

◆ edax_book_add()

DLL_API void edax_book_add ( const char * base_file )

book add command.

Parameters

base_file base file to add.

◆ edax_book_check()

DLL_API void edax_book_check ( const char * base_file )

book check command.

Parameters

base_file base file to check.

◆ edax_book_correct()

DLL_API void edax_book_correct ( )

book correct command.

◆ edax_book_deepen()

DLL_API void edax_book_deepen ( )

book deepen command. caution: Currently, this function does not work correctly.

◆ edax_book_depth()

DLL_API void edax_book_depth ( const int depth )

book depth command.

Parameters

depth depth.

◆ edax_book_deviate()

DLL_API void edax_book_deviate	(	int	relative_error,
		int	absolute_error
	)

book deviate command.

Parameters

relative_error	relative error.
absolute_error	absolute error.

◆ edax_book_enhance()

DLL_API void edax_book_enhance	(	int	midgame_error,
		int	endcut_error
	)

book enhance command.

Parameters

midgame_error	midgame error.
endcut_error	endcut error.

◆ edax_book_export()

DLL_API void edax_book_export ( const char * export_file )

book export command.

Parameters

export_file file name to export.

◆ edax_book_extract()

DLL_API void edax_book_extract ( const char * base_file )

book extract command.

Parameters

base_file base file to extract.

◆ edax_book_feed_hash()

DLL_API void edax_book_feed_hash ( )

book feed-hash command.

◆ edax_book_fill()

DLL_API void edax_book_fill ( int fill_depth )

book fill command.

Parameters

fill_depth fill depth.

◆ edax_book_fix()

DLL_API void edax_book_fix ( )

book fix command.

◆ edax_book_import()

DLL_API void edax_book_import ( const char * import_file )

book import command.

Parameters

import_file file name to import.

◆ edax_book_info()

DLL_API void edax_book_info ( Book * book )

book info command.

Parameters

book	book information(out parameter).

◆ edax_book_load()

DLL_API void edax_book_load ( const char * book_file )

book load command.

Parameters

book_file book file name to load.

◆ edax_book_merge()

DLL_API void edax_book_merge ( const char * book_file )

book merge command.

Parameters

book_file file name to merge.

◆ edax_book_negamax()

DLL_API void edax_book_negamax ( )

book negamax command.

◆ edax_book_new()

DLL_API void edax_book_new	(	const int	level,
		const int	depth
	)

book new command.

Parameters

level	level.
depth	depth.

◆ edax_book_off()

DLL_API void edax_book_off ( )

book off command.

◆ edax_book_on()

DLL_API void edax_book_on ( )

book on command.

◆ edax_book_play()

DLL_API void edax_book_play ( )

book play command.

◆ edax_book_prune()

DLL_API void edax_book_prune ( )

book prune command.

◆ edax_book_randomness()

DLL_API void edax_book_randomness ( const int randomness )

book randomness command.

Parameters

randomness randomness.

◆ edax_book_save()

DLL_API void edax_book_save ( const char * book_file )

book save command.

Parameters

book_file book file name to save.

◆ edax_book_show()

DLL_API void edax_book_show ( Position * position )

book show command.

Parameters

position position information(out parameter).

◆ edax_book_store()

DLL_API void edax_book_store ( )

book store command.

◆ edax_book_subtree()

DLL_API void edax_book_subtree ( )

book subtree command.

◆ edax_book_verbose()

DLL_API void edax_book_verbose ( const int book_verbosity )

book verbose command.

Parameters

book_verbosity book verbosity.

◆ edax_can_move()

DLL_API int edax_can_move ( )

check if the current player can move.

Returns: 1 if the current player can move, otherwise 0.

◆ edax_force()

DLL_API void edax_force ( char * moves )

force command.

Parameters

moves moves.

◆ edax_get_board()

DLL_API void edax_get_board ( Board * board )

get current board.

Parameters

board current board(out parameter).

◆ edax_get_current_player()

DLL_API int edax_get_current_player ( )

get current player.

Returns: current player(0:BLACK, 1:WHITE).

◆ edax_get_disc()

DLL_API int edax_get_disc ( const int color )

get current number of discs.

Parameters

color player's color(0:BLACK, 1:WHITE).

Returns: number of discs.

◆ edax_get_last_move()

DLL_API void edax_get_last_move ( Move * move )

get last move.

Parameters

move	last move(out parameter).

◆ edax_get_mobility_count()

DLL_API int edax_get_mobility_count ( const int color )

get current number of legal moves.

Parameters

color player's color(0:BLACK, 1:WHITE).

Returns: number of legal moves.

◆ edax_get_moves()

DLL_API char* edax_get_moves ( char * str )

get moves of the current game.

Parameters

str	buffer of length 160 + 1 or more (out parameter).

Returns: moves(equals to str. This is for Java, as Java String is immutable).

◆ edax_go()

DLL_API void edax_go ( )

go command.

◆ edax_hint()

DLL_API void edax_hint	(	const int	n,
		HintList *	hintlist
	)

hint command.

Parameters

n	number of hints.
hintlist	result (out parameter).

◆ edax_hint_next()

DLL_API void edax_hint_next ( Hint * hint )

hint command. Gets hint one by one. If there are no more hints, hint will be NOMOVE. Call edax_hint_prepare before calling this function.

Parameters

n	number of hints.
hintlist	result (out parameter).

◆ edax_hint_prepare()

DLL_API void edax_hint_prepare ( )

hint command. Call edax_hint_next after calling this function.

◆ edax_hmirror()

DLL_API void edax_hmirror ( )

hmirror command.

◆ edax_init()

DLL_API void edax_init ( )

init command.

◆ edax_is_game_over()

DLL_API int edax_is_game_over ( )

check if the current game is over.

Returns: 1 if game is over, otherwise 0.

◆ edax_load()

DLL_API void edax_load ( const char * file )

load command.

Parameters

file	file name to open

◆ edax_mode()

DLL_API void edax_mode ( const int mode )

mode command.

Parameters

mode	mode to set

◆ edax_move()

DLL_API int edax_move ( const char * move )

user move command.

Parameters

move	user move.

Returns: 1 if the move has been legally played, otherwise 0.

◆ edax_new()

DLL_API void edax_new ( )

new command.

◆ edax_opening()

DLL_API const char* edax_opening ( )

opening command.

Returns: opening name.

◆ edax_ouverture()

DLL_API const char* edax_ouverture ( )

ouverture command.

Returns: opening name in french.

◆ edax_play()

DLL_API void edax_play ( char * moves )

play command.

Parameters

moves moves.

◆ edax_redo()

DLL_API void edax_redo ( )

redo command.

◆ edax_rotate()

DLL_API void edax_rotate ( const int angle )

rotate command.

Parameters

angle angle for rotation

◆ edax_save()

DLL_API void edax_save ( const char * file )

save command.

Parameters

file	file name to save

◆ edax_set_option()

DLL_API void edax_set_option	(	const char *	option_name,
		const char *	val
	)

set (option) command.

Parameters

option_name	name of option.
val	value to set.

◆ edax_setboard()

DLL_API void edax_setboard ( const char * board )

setboard command.

Parameters

board board to set

◆ edax_setboard_from_obj()

DLL_API void edax_setboard_from_obj	(	const Board *	board,
		const int	turn
	)

setboard command with board object.

Parameters

board	board to set
turn	player to play

◆ edax_stop()

DLL_API void edax_stop ( )

stop command.

◆ edax_symetry()

DLL_API void edax_symetry ( const int sym )

symetry command.

Parameters

sym symetry.

◆ edax_undo()

DLL_API void edax_undo ( )

undo command.

◆ edax_vmirror()

DLL_API void edax_vmirror ( )

vmirror command.

◆ libedax_initialize()

DLL_API void libedax_initialize	(	int	argc,
		char **	argv
	)

edax init function for library use.

Parameters

argc	Number of arguments.
argv	Command line arguments.

◆ libedax_observer()

static void libedax_observer ( Result * )

static

◆ libedax_terminate()

DLL_API void libedax_terminate ( )

edax terminate function for library use.

◆ ui_book_init()

void ui_book_init ( UI * )

◆ ui_event_exist()

bool ui_event_exist ( UI * ui )

ui_event_exist

Locked version of event_exist.

Parameters

ui	User interface.

Returns: true if an event is waiting.

◆ ui_event_free()

void ui_event_free ( UI * ui )

Free events.

Allocate event resources & launch user-input event thread.

◆ ui_event_init()

void ui_event_init ( UI * ui )

Create a new Othello User Interface.

Allocate event resources & launch user-input event thread.

◆ ui_event_peek()

bool ui_event_peek	(	UI *	ui,
		char **	cmd,
		char **	param
	)

Wait input.

Parameters

ui	User interface.
cmd	Command.
param	Command's parameters.

◆ ui_event_wait()

void ui_event_wait	(	UI *	ui,
		char **	cmd,
		char **	param
	)

Wait input.

Parameters

ui	User interface.
cmd	Command.
param	Command's parameters.

◆ ui_free_cassio()

void ui_free_cassio ( UI * )

◆ ui_free_edax()

void ui_free_edax ( UI * ui )

free resources used by edax protocol.

Parameters

ui	user interface.

◆ ui_free_ggs()

void ui_free_ggs ( UI * ui )

ui_free_ggs

Free GGS.

Parameters

ui	User Interface.

◆ ui_free_gtp()

void ui_free_gtp ( UI * ui )

free resources used by edax protocol

Parameters

ui	user interface

◆ ui_free_libedax()

void ui_free_libedax ( UI * ui )

free resources used by libedax api.

Parameters

ui	user interface.

◆ ui_free_nboard()

void ui_free_nboard ( UI * ui )

free resources used by edax protocol

Parameters

ui	user interface

◆ ui_free_xboard()

void ui_free_xboard ( UI * ui )

free resources used by xboard protocol.

Parameters

ui	user interface.

◆ ui_init_cassio()

void ui_init_cassio ( UI * )

◆ ui_init_edax()

void ui_init_edax ( UI * ui )

initialize edax protocol.

Parameters

ui	user interface.

◆ ui_init_ggs()

void ui_init_ggs ( UI * ui )

ui_init_ggs

Init GGS interface.

Parameters

ui	User Interface.

◆ ui_init_gtp()

void ui_init_gtp ( UI * ui )

initialize edax protocol

Parameters

ui	user interface

◆ ui_init_libedax()

void ui_init_libedax ( UI * ui )

initialize libedax api.

Parameters

ui	user interface.

◆ ui_init_nboard()

void ui_init_nboard ( UI * ui )

initialize edax protocol

Parameters

ui	user interface

◆ ui_init_xboard()

void ui_init_xboard ( UI * ui )

initialize xboard protocol.

Parameters

ui	user interface.

◆ ui_loop_cassio()

void ui_loop_cassio ( UI * )

◆ ui_loop_edax()

void ui_loop_edax ( UI * ui )

Loop event.

Parameters

ui	user interface.

◆ ui_loop_ggs()

void ui_loop_ggs ( UI * ui )

ui_loop_ggs

GGS main loop. Here the input from both the user and GGS server is interpreted.

Parameters

ui	User Interface.

◆ ui_loop_gtp()

void ui_loop_gtp ( UI * ui )

Loop event.

Parameters

ui	user interface

◆ ui_loop_nboard()

void ui_loop_nboard ( UI * ui )

Loop event.

Parameters

ui	user interface

◆ ui_loop_xboard()

void ui_loop_xboard ( UI * ui )

Loop event.

Parameters

ui	user interface.

◆ ui_switch()

bool ui_switch	(	UI *	ui,
		const char *	ui_type
	)

Switch between different User Interface.

Parameters

ui	User Interface.
ui_type	A string describing the chosen user interface.

Returns: true if successful.

Classes

Macros

Typedefs

Functions

Detailed Description

Macro Definition Documentation

◆ DLL_API

Typedef Documentation

◆ UI

Function Documentation

◆ auto_go()

◆ book_cmd_post_process()

◆ book_cmd_pre_process()

◆ edax_base_complete()

◆ edax_base_convert()

◆ edax_base_correct()

◆ edax_base_problem()

◆ edax_base_tofen()

◆ edax_base_unique()

◆ edax_book_add()

◆ edax_book_check()

◆ edax_book_correct()

◆ edax_book_deepen()

◆ edax_book_depth()

◆ edax_book_deviate()

◆ edax_book_enhance()

◆ edax_book_export()

◆ edax_book_extract()

◆ edax_book_feed_hash()

◆ edax_book_fill()

◆ edax_book_fix()

◆ edax_book_import()

◆ edax_book_info()

◆ edax_book_load()

◆ edax_book_merge()

◆ edax_book_negamax()

◆ edax_book_new()

◆ edax_book_off()

◆ edax_book_on()

◆ edax_book_play()

◆ edax_book_prune()

◆ edax_book_randomness()

◆ edax_book_save()

◆ edax_book_show()

◆ edax_book_store()

◆ edax_book_subtree()

◆ edax_book_verbose()

◆ edax_can_move()

◆ edax_force()

◆ edax_get_board()

◆ edax_get_current_player()

◆ edax_get_disc()

◆ edax_get_last_move()

◆ edax_get_mobility_count()

◆ edax_get_moves()

◆ edax_go()

◆ edax_hint()

◆ edax_hint_next()

◆ edax_hint_prepare()

◆ edax_hmirror()

◆ edax_init()

◆ edax_is_game_over()

◆ edax_load()

◆ edax_mode()

◆ edax_move()

◆ edax_new()

◆ edax_opening()

◆ edax_ouverture()

◆ edax_play()

◆ edax_redo()

◆ edax_rotate()

◆ edax_save()

◆ edax_set_option()

◆ edax_setboard()

◆ edax_setboard_from_obj()

◆ edax_stop()

◆ edax_symetry()

◆ edax_undo()

◆ edax_vmirror()

◆ libedax_initialize()