/* ScummVM - Graphic Adventure Engine * * ScummVM is the legal property of its developers, whose names * are too numerous to list here. Please refer to the COPYRIGHT * file distributed with this source distribution. * * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * $URL$ * $Id$ * */ #ifndef _GFX_STATE_INTERNAL_H_ #define _GFX_STATE_INTERNAL_H_ #include "sci/gfx/gfx_tools.h" #include "sci/gfx/gfx_options.h" #include "sci/gfx/gfx_operations.h" #include "sci/gfx/gfx_resmgr.h" #include "sci/gfx/gfx_system.h" namespace Sci { #define GFXW_FLAG_VISIBLE (1<<0) #define GFXW_FLAG_OPAQUE (1<<1) #define GFXW_FLAG_CONTAINER (1<<2) #define GFXW_FLAG_DIRTY (1<<3) #define GFXW_FLAG_TAGGED (1<<4) #define GFXW_FLAG_MULTI_ID (1<<5) /* Means that the ID used herein may be used more than once, i.e. is not unique */ #define GFXW_FLAG_IMMUNE_TO_SNAPSHOTS (1<<6) /* Snapshot restoring doesn't kill this widget, and +5 bonus to saving throws vs. Death Magic */ #define GFXW_FLAG_NO_IMPLICIT_SWITCH (1<<7) /* Ports: Don't implicitly switch to this port when disposing windows */ typedef struct { int serial; /* The first serial number to kill */ rect_t area; } gfxw_snapshot_t; typedef enum { GFXW_, /* Base widget */ GFXW_BOX, GFXW_RECT, GFXW_LINE, /* For lines, the bounding rectangle's xl, yl determine the line's expansion: ** (x2, y2) = (x+xl, y+yl) */ GFXW_INVERSE_LINE, GFXW_VIEW, GFXW_STATIC_VIEW, GFXW_DYN_VIEW, GFXW_PIC_VIEW, GFXW_TEXT, GFXW_CONTAINER, GFXW_LIST, GFXW_SORTED_LIST, GFXW_VISUAL, GFXW_PORT } gfxw_widget_type_t; #define GFXW_MAGIC_VALID 0xC001 #define GFXW_MAGIC_INVALID 0xbad #define GFXW_NO_ID -1 struct _gfxw_widget; struct _gfxw_container_widget; struct _gfxw_visual; typedef int gfxw_point_op(struct _gfxw_widget *, Common::Point); typedef int gfxw_visual_op(struct _gfxw_widget *, struct _gfxw_visual *); typedef int gfxw_op(struct _gfxw_widget *); typedef int gfxw_op_int(struct _gfxw_widget *, int); typedef int gfxw_bin_op(struct _gfxw_widget *, struct _gfxw_widget *); #define WIDGET_COMMON \ int magic; /* Extra check after typecasting */ \ int serial; /* Serial number */ \ int flags; /* Widget flags */ \ gfxw_widget_type_t type; \ rect_t bounds; /* Boundaries */ \ struct _gfxw_widget *next; /* Next widget in widget list */ \ int ID; /* Unique ID or GFXW_NO_ID */ \ int subID; /* A 'sub-ID', or GFXW_NO_ID */ \ struct _gfxw_container_widget *parent; /* The parent widget, or NULL if not owned */ \ struct _gfxw_visual *visual; /* The owner visual */ \ int widget_priority; /* Drawing priority, or -1 */ \ gfxw_point_op *draw; /* Draw widget (if dirty) and anything else required for the display to be consistant */ \ gfxw_op *widfree; /* Remove widget (and any sub-widgets it may contain) */ \ gfxw_op *tag; /* Tag the specified widget */ \ gfxw_op_int *print; /* Prints the widget's contents, using sciprintf. Second parameter is indentation. */ \ gfxw_bin_op *compare_to; /* a.compare_to(a, b) returns <0 if a0 if a>b */ \ gfxw_bin_op *equals; /* a equals b if both cause the same data to be displayed */ \ gfxw_bin_op *should_replace; /* (only if a equals b) Whether b should replace a even though they are equivalent */ \ gfxw_bin_op *superarea_of; /* a superarea_of b <=> for each pixel of b there exists an opaque pixel in a at the same location */ \ gfxw_visual_op *set_visual /* Sets the visual the widget belongs to */ typedef struct _gfxw_widget { WIDGET_COMMON; } gfxw_widget_t; #define GFXW_IS_BOX(widget) ((widget)->type == GFXW_BOX) typedef struct { WIDGET_COMMON; gfx_color_t color1, color2; gfx_box_shade_t shade_type; } gfxw_box_t; #define GFXW_IS_PRIMITIVE(widget) ((widget)->type == GFXW_RECT || (widget)->type == GFXW_LINE || (widget->type == GFXW_INVERSE_LINE)) typedef struct { WIDGET_COMMON; gfx_color_t color; gfx_line_mode_t line_mode; gfx_line_style_t line_style; } gfxw_primitive_t; #define VIEW_COMMON \ WIDGET_COMMON; \ Common::Point pos; /* Implies the value of 'bounds' in WIDGET_COMMON */ \ gfx_color_t color; \ int view, loop, cel; \ int palette #define GFXW_IS_VIEW(widget) ((widget)->type == GFXW_VIEW || (widget)->type == GFXW_STATIC_VIEW \ || (widget)->type == GFXW_DYN_VIEW || (widget)->type == GFXW_PIC_VIEW) typedef struct { VIEW_COMMON; } gfxw_view_t; #define GFXW_IS_DYN_VIEW(widget) ((widget)->type == GFXW_DYN_VIEW || (widget)->type == GFXW_PIC_VIEW) typedef struct { VIEW_COMMON; /* fixme: This code is specific to SCI */ rect_t draw_bounds; /* The correct position to draw to */ void *under_bitsp, *signalp; int under_bits, signal; int z; /* The z coordinate: Added to y, but used for sorting */ int sequence; /* Sequence number: For sorting */ int force_precedence; /* Precedence enforcement variable for sorting- defaults to 0 */ } gfxw_dyn_view_t; #define GFXW_IS_TEXT(widget) ((widget)->type == GFXW_TEXT) typedef struct { WIDGET_COMMON; int font_nr; int lines_nr, lineheight, lastline_width; char *text; gfx_alignment_t halign, valign; gfx_color_t color1, color2, bgcolor; int text_flags; int width, height; /* Real text width and height */ gfx_text_handle_t *text_handle; } gfxw_text_t; /* Container widgets */ typedef int gfxw_unary_container_op(struct _gfxw_container_widget *); typedef int gfxw_container_op(struct _gfxw_container_widget *, gfxw_widget_t *); typedef int gfxw_rect_op(struct _gfxw_container_widget *, rect_t, int); #define WIDGET_CONTAINER \ WIDGET_COMMON; \ rect_t zone; /* The writeable zone (absolute) for contained objects */ \ gfx_dirty_rect_t *dirty; /* List of dirty rectangles */ \ gfxw_widget_t *contents; \ gfxw_widget_t **nextpp; /* Pointer to the 'next' pointer in the last entry in contents */ \ gfxw_unary_container_op *free_tagged; /* Free all tagged contained widgets */ \ gfxw_unary_container_op *free_contents; /* Free all contained widgets */ \ gfxw_rect_op *add_dirty_abs; /* Add an absolute dirty rectangle */ \ gfxw_rect_op *add_dirty_rel; /* Add a relative dirty rectangle */ \ gfxw_container_op *add /* Append widget to an appropriate position (for view and control lists) */ typedef struct _gfxw_container_widget { WIDGET_CONTAINER; } gfxw_container_t; #define GFXW_IS_CONTAINER(widget) ((widget)->type == GFXW_PORT || (widget)->type == GFXW_VISUAL || \ (widget)->type == GFXW_SORTED_LIST || (widget)->type == GFXW_LIST) #define GFXW_IS_LIST(widget) ((widget)->type == GFXW_LIST || (widget)->type == GFXW_SORTED_LIST) #define GFXW_IS_SORTED_LIST(widget) ((widget)->type == GFXW_SORTED_LIST) typedef gfxw_container_t gfxw_list_t; #define GFXW_IS_VISUAL(widget) ((widget)->type == GFXW_VISUAL) typedef struct _gfxw_visual { WIDGET_CONTAINER; struct _gfxw_port **port_refs; /* References to ports */ int port_refs_nr; int font_nr; /* Default font */ gfx_state_t *gfx_state; } gfxw_visual_t; #define GFXW_IS_PORT(widget) ((widget)->type == GFXW_PORT) typedef struct _gfxw_port { WIDGET_CONTAINER; gfxw_list_t *decorations; /* optional window decorations- drawn before the contents */ gfxw_widget_t *port_bg; /* Port background widget or NULL */ gfx_color_t color, bgcolor; int chrono_port; int font_nr; Common::Point draw_pos; /* Drawing position */ gfxw_snapshot_t *restore_snap; /* Snapshot to be restored automagically, experimental feature used in the PQ3 interpreter */ int port_flags; /* interpreter-dependant flags */ const char *title_text; byte gray_text; /* Whether text is 'grayed out' (dithered) */ } gfxw_port_t; #undef WIDGET_COMMON #undef WIDGET_CONTAINER } // End of namespace Sci #endif /* !_GFX_STATE_INTERNAL_H_ */