mirror of
git://xwords.git.sourceforge.net/gitroot/xwords/xwords
synced 2025-01-07 05:24:46 +01:00
7994c42691
There are some screen dimensions, especially with dual-pane mode, where the board is just bit narrower than the screen. Rather than have narrow white borders, allow the cells to take up the slack. The API takes an upper bound on the ratio of width to height so things shouldn't get too odd looking.
222 lines
7.5 KiB
C
222 lines
7.5 KiB
C
/* -*-mode: C; fill-column: 78; c-basic-offset: 4; -*- */
|
|
/*
|
|
* Copyright 1997 - 2010 by Eric House (xwords@eehouse.org). All rights reserved.
|
|
*
|
|
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
*/
|
|
|
|
#ifndef __BOARD_H__
|
|
#define __BOARD_H__
|
|
|
|
#include "comtypes.h"
|
|
#include "model.h"
|
|
#include "gameinfo.h"
|
|
#include "server.h"
|
|
#include "draw.h"
|
|
#include "xwstream.h"
|
|
|
|
/* typedef struct BoardVTable { */
|
|
/* } BoardVTable; */
|
|
|
|
#ifdef CPLUS
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef enum {
|
|
/* keep these three together: for the cursor */
|
|
XP_KEY_NONE = 0,
|
|
|
|
XP_CURSOR_KEY_DOWN,
|
|
XP_CURSOR_KEY_ALTDOWN,
|
|
XP_CURSOR_KEY_RIGHT,
|
|
XP_CURSOR_KEY_ALTRIGHT,
|
|
XP_CURSOR_KEY_UP,
|
|
XP_CURSOR_KEY_ALTUP,
|
|
XP_CURSOR_KEY_LEFT,
|
|
XP_CURSOR_KEY_ALTLEFT,
|
|
|
|
XP_CURSOR_KEY_DEL,
|
|
XP_RAISEFOCUS_KEY,
|
|
XP_RETURN_KEY,
|
|
|
|
XP_KEY_LAST
|
|
} XP_Key;
|
|
|
|
#define BONUS_HINT_INTERVAL 15 /* stolen from xwords.c */
|
|
|
|
/* typedef struct BoardCtxt BoardCtxt; */
|
|
|
|
BoardCtxt* board_make( MPFORMAL ModelCtxt* model, ServerCtxt* server,
|
|
DrawCtx* draw, XW_UtilCtxt* util );
|
|
BoardCtxt* board_makeFromStream( MPFORMAL XWStreamCtxt* stream,
|
|
ModelCtxt* model, ServerCtxt* server,
|
|
DrawCtx* draw, XW_UtilCtxt* util,
|
|
XP_U16 nPlayers );
|
|
void board_setCallbacks( BoardCtxt* board );
|
|
void board_setDraw( BoardCtxt* board, DrawCtx* draw );
|
|
DrawCtx* board_getDraw( const BoardCtxt* board );
|
|
|
|
void board_destroy( BoardCtxt* board );
|
|
|
|
void board_writeToStream( const BoardCtxt* board, XWStreamCtxt* stream );
|
|
|
|
void board_reset( BoardCtxt* board );
|
|
|
|
void board_drawSnapshot( const BoardCtxt* board, DrawCtx* dctx,
|
|
XP_U16 width, XP_U16 height );
|
|
|
|
/* Layout. Either done internally or by client */
|
|
#ifdef COMMON_LAYOUT
|
|
|
|
typedef struct _BoardDims {
|
|
/* The whole board */
|
|
XP_U16 left, top;
|
|
XP_U16 width, height;
|
|
|
|
/* board */
|
|
XP_U16 boardWidth, boardHt;
|
|
|
|
/* scoreboard */
|
|
XP_U16 scoreLeft, scoreWidth, scoreHt;
|
|
|
|
/* tray */
|
|
XP_U16 trayLeft, trayTop, trayWidth, trayHt;
|
|
|
|
/* other */
|
|
XP_U16 cellSize, maxCellSize;
|
|
XP_U16 timerWidth;
|
|
} BoardDims;
|
|
|
|
void board_figureLayout( BoardCtxt* board, const CurGameInfo* gi, XP_U16 bLeft,
|
|
XP_U16 bTop, XP_U16 bWidth, XP_U16 bHeight,
|
|
XP_U16 colPctMax, XP_U16 scorePct, XP_U16 trayPct,
|
|
XP_U16 scoreWidth, XP_U16 fontWidth, XP_U16 fontHt,
|
|
XP_Bool squareTiles, /* out */ BoardDims* dimsp );
|
|
void board_applyLayout( BoardCtxt* board, const BoardDims* dims );
|
|
|
|
#endif
|
|
|
|
/* These four aren't needed if COMMON_LAYOUT defined */
|
|
void board_setPos( BoardCtxt* board, XP_U16 left, XP_U16 top,
|
|
XP_U16 width, XP_U16 height, XP_U16 maxCellSize,
|
|
XP_Bool leftHanded );
|
|
void board_setScoreboardLoc( BoardCtxt* board,
|
|
XP_U16 scoreLeft, XP_U16 scoreTop,
|
|
XP_U16 scoreWidth, XP_U16 scoreHeight,
|
|
XP_Bool divideHorizontally );
|
|
void board_setTimerLoc( BoardCtxt* board,
|
|
XP_U16 timerLeft, XP_U16 timerTop,
|
|
XP_U16 timerWidth, XP_U16 timerHeight );
|
|
void board_setTrayLoc( BoardCtxt* board, XP_U16 trayLeft, XP_U16 trayTop,
|
|
XP_U16 trayWidth, XP_U16 trayHeight );
|
|
|
|
/* Vertical scroll support; offset is in rows, not pixels */
|
|
XP_Bool board_setYOffset( BoardCtxt* board, XP_U16 newOffset );
|
|
XP_U16 board_getYOffset( const BoardCtxt* board );
|
|
|
|
XP_Bool board_curTurnSelected( const BoardCtxt* board );
|
|
XP_U16 board_visTileCount( const BoardCtxt* board );
|
|
XP_Bool board_canShuffle( const BoardCtxt* board );
|
|
XP_Bool board_canHideRack( const BoardCtxt* board );
|
|
XP_Bool board_canTrade( BoardCtxt* board );
|
|
XP_Bool board_canTogglePending( const BoardCtxt* board );
|
|
XP_Bool board_canHint( const BoardCtxt* board );
|
|
void board_sendChat( const BoardCtxt* board, const XP_UCHAR const* msg );
|
|
|
|
/* zoomBy: >0: zoom in; < 0: zoom out; 0: query only */
|
|
XP_Bool board_zoom( BoardCtxt* board, XP_S16 zoomBy, XP_Bool* canInOut );
|
|
|
|
void board_invalAll( BoardCtxt* board );
|
|
void board_invalRect( BoardCtxt* board, XP_Rect* rect );
|
|
#ifdef XWFEATURE_ACTIVERECT
|
|
XP_Bool board_getActiveRect( const BoardCtxt* board, XP_Rect* rect,
|
|
XP_U16* nCols, XP_U16* nRows );
|
|
#endif
|
|
|
|
XP_Bool board_draw( BoardCtxt* board );
|
|
|
|
XP_Bool board_get_flipped( const BoardCtxt* board );
|
|
XP_Bool board_flip( BoardCtxt* board );
|
|
XP_Bool board_inTrade( const BoardCtxt* board, XP_Bool* anySelected );
|
|
XP_Bool board_get_showValues( const BoardCtxt* board );
|
|
XP_Bool board_toggle_showValues( BoardCtxt* board );
|
|
XP_Bool board_replaceTiles( BoardCtxt* board );
|
|
XP_Bool board_redoReplacedTiles( BoardCtxt* board );
|
|
|
|
XP_U16 board_getSelPlayer(const BoardCtxt* board );
|
|
|
|
XP_Bool board_requestHint( BoardCtxt* board,
|
|
#ifdef XWFEATURE_SEARCHLIMIT
|
|
XP_Bool useTileLimits,
|
|
#endif
|
|
XP_Bool usePrev, XP_Bool* workRemainsP );
|
|
|
|
XP_Bool board_prefsChanged( BoardCtxt* board, const CommonPrefs* cp );
|
|
|
|
BoardObjectType board_getFocusOwner( BoardCtxt* board );
|
|
|
|
void board_hiliteCellAt( BoardCtxt* board, XP_U16 col, XP_U16 row );
|
|
|
|
void board_resetEngine( BoardCtxt* board );
|
|
|
|
XP_Bool board_commitTurn( BoardCtxt* board );
|
|
|
|
void board_pushTimerSave( BoardCtxt* board );
|
|
void board_popTimerSave( BoardCtxt* board );
|
|
|
|
void board_formatRemainingTiles( BoardCtxt* board, XWStreamCtxt* stream );
|
|
|
|
#ifdef POINTER_SUPPORT
|
|
XP_Bool board_handlePenDown( BoardCtxt* board, XP_U16 x, XP_U16 y,
|
|
XP_Bool* handled );
|
|
XP_Bool board_handlePenMove( BoardCtxt* board, XP_U16 x, XP_U16 y );
|
|
XP_Bool board_handlePenUp( BoardCtxt* board, XP_U16 x, XP_U16 y );
|
|
XP_Bool board_containsPt( const BoardCtxt* board, XP_U16 xx, XP_U16 yy );
|
|
#endif
|
|
|
|
#ifdef KEY_SUPPORT
|
|
XP_Bool board_handleKey( BoardCtxt* board, XP_Key key, XP_Bool* handled );
|
|
|
|
XP_Bool board_handleKeyUp( BoardCtxt* board, XP_Key key, XP_Bool* handled );
|
|
XP_Bool board_handleKeyDown( BoardCtxt* board, XP_Key key, XP_Bool* handled );
|
|
XP_Bool board_handleKeyRepeat( BoardCtxt* board, XP_Key key, XP_Bool* handled );
|
|
# ifdef KEYBOARD_NAV
|
|
XP_Bool board_focusChanged( BoardCtxt* board, BoardObjectType typ,
|
|
XP_Bool gained );
|
|
# endif
|
|
#endif
|
|
|
|
/******************** Tray methods ********************/
|
|
#define NO_TILES ((TileBit)0)
|
|
|
|
XP_Bool board_hideTray( BoardCtxt* board );
|
|
XP_Bool board_showTray( BoardCtxt* board );
|
|
XW_TrayVisState board_getTrayVisState( const BoardCtxt* board );
|
|
|
|
void board_invalTrayTiles( BoardCtxt* board, TileBit what );
|
|
XP_Bool board_juggleTray( BoardCtxt* board );
|
|
XP_Bool board_beginTrade( BoardCtxt* board );
|
|
XP_Bool board_endTrade( BoardCtxt* board );
|
|
|
|
#if defined FOR_GREMLINS
|
|
XP_Bool board_moveDivider( BoardCtxt* board, XP_Bool right );
|
|
#endif
|
|
|
|
|
|
#ifdef CPLUS
|
|
}
|
|
#endif
|
|
|
|
#endif
|