wrctypes.h 12.9 KB
Newer Older
Alexandre Julliard's avatar
Alexandre Julliard committed
1 2 3 4 5
/*
 * General type definitions
 *
 * Copyright 1998 Bertho A. Stultiens (BS)
 *
6 7 8 9 10 11 12 13 14 15 16 17
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
Alexandre Julliard's avatar
Alexandre Julliard committed
19 20 21 22 23
 */

#ifndef __WRC_WRCTYPES_H
#define __WRC_WRCTYPES_H

24
#include <stdarg.h>
25
#include "windef.h"
26
#include "winbase.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
27 28 29 30 31 32

#ifndef MAKELANGID
#include "winnls.h"
#endif

#ifndef VS_FFI_SIGNATURE
33
#include "winver.h"
Alexandre Julliard's avatar
Alexandre Julliard committed
34 35
#endif

36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
/* Memory/load flags */
#define WRC_MO_MOVEABLE		0x0010
#define WRC_MO_PURE		0x0020
#define WRC_MO_PRELOAD		0x0040
#define WRC_MO_DISCARDABLE	0x1000

/* Resource type IDs */
#define WRC_RT_CURSOR		(1)
#define WRC_RT_BITMAP		(2)
#define WRC_RT_ICON		(3)
#define WRC_RT_MENU		(4)
#define WRC_RT_DIALOG		(5)
#define WRC_RT_STRING		(6)
#define WRC_RT_FONTDIR		(7)
#define WRC_RT_FONT		(8)
#define WRC_RT_ACCELERATOR	(9)
#define WRC_RT_RCDATA		(10)
#define WRC_RT_MESSAGETABLE	(11)
#define WRC_RT_GROUP_CURSOR	(12)
#define WRC_RT_GROUP_ICON	(14)
#define WRC_RT_VERSION		(16)
#define WRC_RT_DLGINCLUDE	(17)
#define WRC_RT_PLUGPLAY		(19)
#define WRC_RT_VXD		(20)
#define WRC_RT_ANICURSOR	(21)
#define WRC_RT_ANIICON		(22)
62
#define WRC_RT_HTML		(23)
63
#define WRC_RT_DLGINIT          (240)
64
#define WRC_RT_TOOLBAR		(241)
65 66 67 68 69 70 71 72 73

/* Default class type IDs */
#define CT_BUTTON	0x80
#define CT_EDIT		0x81
#define CT_STATIC 	0x82
#define CT_LISTBOX	0x83
#define CT_SCROLLBAR	0x84
#define CT_COMBOBOX	0x85

74 75 76 77 78 79 80 81 82 83 84
/* Byteordering defines */
#define WRC_BO_NATIVE	0x00
#define WRC_BO_LITTLE	0x01
#define WRC_BO_BIG	0x02

#define WRC_LOBYTE(w)		((WORD)(w) & 0xff)
#define WRC_HIBYTE(w)		(((WORD)(w) >> 8) & 0xff)
#define WRC_LOWORD(d)		((DWORD)(d) & 0xffff)
#define WRC_HIWORD(d)		(((DWORD)(d) >> 16) & 0xffff)
#define BYTESWAP_WORD(w)	((WORD)(((WORD)WRC_LOBYTE(w) << 8) + (WORD)WRC_HIBYTE(w)))
#define BYTESWAP_DWORD(d)	((DWORD)(((DWORD)BYTESWAP_WORD(WRC_LOWORD(d)) << 16) + ((DWORD)BYTESWAP_WORD(WRC_HIWORD(d)))))
Alexandre Julliard's avatar
Alexandre Julliard committed
85

86 87 88 89 90 91 92
typedef struct
{
    const char *file;
    int         line;
    int         col;
} location_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
93 94 95 96
/* Binary resource structure */
#define RES_BLOCKSIZE	512

typedef struct res {
97 98 99 100
	unsigned int	allocsize;	/* Allocated datablock size */
	unsigned int	size;		/* Actual size of data */
	unsigned int	dataidx;	/* Tag behind the resource-header */
	char		*data;
Alexandre Julliard's avatar
Alexandre Julliard committed
101 102 103 104 105 106 107 108 109 110
} res_t;

/* Resource strings are slightly more complex because they include '\0' */
enum str_e {str_char, str_unicode};

typedef struct string {
	int 		size;
	enum str_e	type;
	union {
		char *cstr;
111
		WCHAR *wstr;
Alexandre Julliard's avatar
Alexandre Julliard committed
112
	} str;
113
	location_t loc;
Alexandre Julliard's avatar
Alexandre Julliard committed
114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
} string_t;

/* Resources are identified either by name or by number */
enum name_e {name_str, name_ord};

typedef struct name_id {
	union {
		string_t *s_name;
		int	i_name;
	} name;
	enum name_e type;
} name_id_t;

/* Language definitions */
typedef struct language {
	int	id;
	int	sub;
} language_t;

typedef DWORD characts_t;
typedef DWORD version_t;

typedef struct lvc {
	language_t	*language;
	version_t	*version;
	characts_t	*characts;
} lvc_t;

typedef struct font_id {
	string_t	*name;
	int		size;
	int		weight;
	int		italic;
} font_id_t;

149 150 151 152 153 154
/* control styles */
typedef struct style {
    	DWORD 			or_mask;
	DWORD			and_mask;
} style_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
155 156 157 158 159 160 161 162 163 164 165 166 167 168
/* resource types */
/* These are in the same order (and ordinal) as the RT_xxx
 * defines. This is _required_.
 * I rolled my own numbers for the win32 extension that are
 * documented, but generate either old RT_xxx numbers, or
 * don't have an ordinal associated (user type).
 * I don't know any specs for those noted such, for that matter,
 * I don't even know whether they can be generated other than by
 * using a user-type resource.
 */
enum res_e {
	res_0 = 0,
	res_cur,
	res_bmp,
169
	res_ico,
Alexandre Julliard's avatar
Alexandre Julliard committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
	res_men,
	res_dlg,
	res_stt,
	res_fntdir,
	res_fnt,
	res_acc,
	res_rdt,
	res_msg,
	res_curg,
	res_13,		/* Hm, wonder why its not used... */
	res_icog,
	res_15,
	res_ver,
	res_dlginc,	/* Not implemented, no layout available */
	res_18,
	res_pnp,	/* Not implemented, no layout available */
	res_vxd,	/* Not implemented, no layout available */
187 188 189
	res_anicur,
	res_aniico,
	res_html,	/* Not implemented, no layout available */
Alexandre Julliard's avatar
Alexandre Julliard committed
190

191
	res_dlginit = WRC_RT_DLGINIT,	/* 240 */
192 193
	res_toolbar = WRC_RT_TOOLBAR,	/* 241 */

194
	res_usr = 256 + 6
Alexandre Julliard's avatar
Alexandre Julliard committed
195 196 197 198
};

/* Raw bytes in a row... */
typedef struct raw_data {
199 200 201
	unsigned int	size;
	char		*data;
	lvc_t		lvc;		/* Localized data */
Alexandre Julliard's avatar
Alexandre Julliard committed
202 203 204 205 206 207 208
} raw_data_t;

/* Dialog structures */
typedef struct control {
	struct control	*next;		/* List of controls */
	struct control	*prev;
	name_id_t	*ctlclass;	/* ControlClass */
209
	name_id_t	*title;		/* Title of control */
Alexandre Julliard's avatar
Alexandre Julliard committed
210 211 212 213 214
	int		id;
	int		x;		/* Position */
	int		y;
	int		width;		/* Size */
	int		height;
215 216
	style_t		*style;		/* Style */
	style_t		*exstyle;
Alexandre Julliard's avatar
Alexandre Julliard committed
217 218 219 220 221 222 223 224 225 226 227 228 229
	DWORD		helpid;		/* EX: */
	int		gotstyle;	/* Used to determine whether the default */
	int		gotexstyle;	/* styles must be set */
	int		gothelpid;
	raw_data_t	*extra;		/* EX: number of extra bytes in resource */
} control_t;

typedef struct dialog {
	DWORD		memopt;
	int		x;		/* Position */
	int		y;
	int		width;		/* Size */
	int		height;
230 231
	style_t		*style;		/* Style */
	style_t		*exstyle;
Alexandre Julliard's avatar
Alexandre Julliard committed
232 233 234 235
	DWORD		helpid;		/* EX: */
	int		gotstyle;	/* Used to determine whether the default */
	int		gotexstyle;	/* styles must be set */
	int		gothelpid;
236
	int		is_ex;
Alexandre Julliard's avatar
Alexandre Julliard committed
237 238 239 240 241 242
	name_id_t	*menu;
	name_id_t	*dlgclass;
	string_t	*title;
	font_id_t	*font;
	lvc_t		lvc;
	control_t	*controls;
243
} dialog_t;
Alexandre Julliard's avatar
Alexandre Julliard committed
244 245 246 247 248 249 250

/* Menu structures */
typedef struct menu_item {
	struct menu_item *next;
	struct menu_item *prev;
	struct menu_item *popup;
	int		id;
251
	DWORD		type;
Alexandre Julliard's avatar
Alexandre Julliard committed
252
	DWORD		state;
253
	int		helpid;
Alexandre Julliard's avatar
Alexandre Julliard committed
254
	string_t	*name;
255 256 257 258
	int		gotid;
	int		gottype;
	int		gotstate;
	int		gothelpid;
Alexandre Julliard's avatar
Alexandre Julliard committed
259 260 261 262 263
} menu_item_t;

typedef struct menu {
	DWORD		memopt;
	lvc_t		lvc;
264
	int		is_ex;
Alexandre Julliard's avatar
Alexandre Julliard committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	menu_item_t	*items;
} menu_t;

typedef struct itemex_opt
{
	int	id;
	DWORD	type;
	DWORD	state;
	int	helpid;
	int	gotid;
	int	gottype;
	int	gotstate;
	int	gothelpid;
} itemex_opt_t;

280 281 282
/*
 * Font resources
 */
Alexandre Julliard's avatar
Alexandre Julliard committed
283 284 285 286 287
typedef struct font {
	DWORD		memopt;
	raw_data_t	*data;
} font_t;

288 289 290 291 292
typedef struct fontdir {
	DWORD		memopt;
	raw_data_t	*data;
} fontdir_t;

293 294 295 296 297 298 299 300 301
/*
 * Icon resources
 */
typedef struct icon_header {
	WORD	reserved;	/* Don't know, should be 0 I guess */
	WORD	type;		/* Always 1 for icons */
	WORD	count;		/* Number of packed icons in resource */
} icon_header_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
302
typedef struct icon_dir_entry {
303 304 305 306 307 308 309 310
	BYTE	width;		/* From the SDK doc. */
	BYTE	height;
	BYTE	nclr;
	BYTE	reserved;
	WORD	planes;
	WORD	bits;
	DWORD	ressize;
	DWORD	offset;
Alexandre Julliard's avatar
Alexandre Julliard committed
311 312 313 314 315
} icon_dir_entry_t;

typedef struct icon {
	struct icon	*next;
	struct icon	*prev;
Alexandre Julliard's avatar
Alexandre Julliard committed
316
	lvc_t		lvc;
Alexandre Julliard's avatar
Alexandre Julliard committed
317 318 319 320 321 322 323 324 325 326 327
	int		id;	/* Unique icon id within resource file */
	int		width;	/* Field from the IconDirEntry */
	int		height;
	int		nclr;
	int		planes;
	int		bits;
	raw_data_t	*data;
} icon_t;

typedef struct icon_group {
	DWORD		memopt;
Alexandre Julliard's avatar
Alexandre Julliard committed
328
	lvc_t		lvc;
Alexandre Julliard's avatar
Alexandre Julliard committed
329 330 331 332
	icon_t		*iconlist;
	int		nicon;
} icon_group_t;

333 334 335 336 337 338 339 340 341
/*
 * Cursor resources
 */
typedef struct cursor_header {
	WORD	reserved;	/* Don't know, should be 0 I guess */
	WORD	type;		/* Always 2 for cursors */
	WORD	count;		/* Number of packed cursors in resource */
} cursor_header_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
342
typedef struct cursor_dir_entry {
343 344 345 346 347 348 349 350
	BYTE	width;		/* From the SDK doc. */
	BYTE	height;
	BYTE	nclr;
	BYTE	reserved;
	WORD	xhot;
	WORD	yhot;
	DWORD	ressize;
	DWORD	offset;
Alexandre Julliard's avatar
Alexandre Julliard committed
351 352 353 354 355
} cursor_dir_entry_t;

typedef struct cursor {
	struct cursor	*next;
	struct cursor	*prev;
Alexandre Julliard's avatar
Alexandre Julliard committed
356
	lvc_t		lvc;
Alexandre Julliard's avatar
Alexandre Julliard committed
357 358 359 360 361 362 363 364 365 366 367 368 369
	int		id;	/* Unique icon id within resource file */
	int		width;	/* Field from the CursorDirEntry */
	int		height;
	int		nclr;
	int		planes;
	int		bits;
	int		xhot;
	int		yhot;
	raw_data_t	*data;
} cursor_t;

typedef struct cursor_group {
	DWORD		memopt;
Alexandre Julliard's avatar
Alexandre Julliard committed
370
	lvc_t		lvc;
Alexandre Julliard's avatar
Alexandre Julliard committed
371 372 373 374
	cursor_t	*cursorlist;
	int		ncursor;
} cursor_group_t;

375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411
/*
 * Animated cursors and icons
 */
typedef struct aniheader {
	DWORD	structsize;	/* Header size (36 bytes) */
	DWORD	frames;		/* Number of unique icons in this cursor */
	DWORD	steps;		/* Number of blits before the animation cycles */
	DWORD	cx;		/* reserved, must be 0? */
	DWORD	cy;		/* reserved, must be 0? */
	DWORD	bitcount;	/* reserved, must be 0? */
	DWORD	planes;		/* reserved, must be 0? */
	DWORD	rate;		/* Default rate (1/60th of a second) if "rate" not present */
	DWORD	flags;		/* Animation flag (1==AF_ICON, although both icons and cursors set this) */
} aniheader_t;

typedef struct riff_tag {
	BYTE	tag[4];
	DWORD	size;
} riff_tag_t;

typedef struct ani_curico {
	DWORD		memopt;
	raw_data_t	*data;
} ani_curico_t;

typedef struct ani_any {
	enum res_e	type;
	union {
		ani_curico_t	*ani;
		cursor_group_t	*curg;
		icon_group_t	*icog;
	} u;
} ani_any_t;

/*
 * Bitmaps
 */
Alexandre Julliard's avatar
Alexandre Julliard committed
412 413 414 415 416
typedef struct bitmap {
	DWORD		memopt;
	raw_data_t	*data;
} bitmap_t;

417 418 419 420 421
typedef struct html {
	DWORD		memopt;
	raw_data_t	*data;
} html_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
422 423 424 425 426
typedef struct rcdata {
	DWORD		memopt;
	raw_data_t	*data;
} rcdata_t;

427
typedef struct {
Alexandre Julliard's avatar
Alexandre Julliard committed
428 429 430 431 432
	DWORD		memopt;
	name_id_t	*type;
	raw_data_t	*data;
} user_t;

433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
/*
 * Messagetables
 */
typedef struct msgtab_block {
	DWORD	idlo;		/* Lowest id in the set */
	DWORD	idhi;		/* Highest is in the set */
	DWORD	offset;		/* Offset from resource start to first entry */
} msgtab_block_t;

typedef struct msgtab_entry {
	WORD	length;		/* Length of the data in bytes */
	WORD	flags;		/* 0 for char, 1 for WCHAR */
/*	{char}|{WCHAR} data[...]; */
} msgtab_entry_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
448
typedef struct messagetable {
449
	DWORD		memopt;
Alexandre Julliard's avatar
Alexandre Julliard committed
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
	raw_data_t	*data;
} messagetable_t;

/* StringTable structures */
typedef struct stt_entry {
	string_t		*str;
	int			id;
	DWORD			memopt;
	characts_t		*characts;
	version_t		*version;
} stt_entry_t;

typedef struct stringtable {
	struct stringtable	*next;
	struct stringtable	*prev;
	DWORD			memopt;
	lvc_t			lvc;
	int			idbase;
	int			nentries;
	stt_entry_t		*entries;
} stringtable_t;

/* VersionInfo structures */
enum ver_val_e {val_str, val_words, val_block};

struct ver_block;	/* Forward ref */

typedef struct ver_words {
	WORD	*words;
	int	nwords;
} ver_words_t;

typedef struct ver_value {
	struct ver_value	*next;
	struct ver_value	*prev;
	string_t		*key;
	union {
		string_t		*str;
		ver_words_t		*words;
		struct ver_block	*block;
	} value;
	enum ver_val_e		type;
} ver_value_t;

typedef struct ver_block {
	struct ver_block	*next;
	struct ver_block	*prev;
	string_t		*name;
	ver_value_t		*values;
} ver_block_t;

typedef struct versioninfo {
	int	filever_maj1;
	int	filever_maj2;
	int	filever_min1;
	int	filever_min2;
	int	prodver_maj1;
	int	prodver_maj2;
	int	prodver_min1;
	int	prodver_min2;
	int	fileos;
	int	fileflags;
	int	fileflagsmask;
	int	filetype;
	int	filesubtype;
	struct {
516 517 518 519 520 521 522
		unsigned fv:1;
		unsigned pv:1;
		unsigned fo:1;
		unsigned ff:1;
		unsigned ffm:1;
		unsigned ft:1;
		unsigned fst:1;
Alexandre Julliard's avatar
Alexandre Julliard committed
523 524
	} gotit;
	ver_block_t	*blocks;
525 526
	lvc_t		lvc;
	DWORD		memopt;
Alexandre Julliard's avatar
Alexandre Julliard committed
527 528 529 530 531 532 533 534 535 536 537 538 539
} versioninfo_t;

/* Accelerator structures */
#define WRC_AF_VIRTKEY	0x0001
#define WRC_AF_NOINVERT	0x0002
#define WRC_AF_SHIFT	0x0004
#define WRC_AF_CONTROL	0x0008
#define WRC_AF_ALT	0x0010
#define WRC_AF_ASCII	0x4000

typedef struct event {
	struct event	*next;
	struct event	*prev;
540
	string_t	*str;
Alexandre Julliard's avatar
Alexandre Julliard committed
541 542 543 544 545 546 547 548 549 550 551
	int		flags;
	int		key;
	int		id;
} event_t;

typedef struct accelerator {
	DWORD		memopt;
	lvc_t		lvc;
	event_t		*events;
} accelerator_t;

552 553 554
/* Toolbar structures */
typedef struct toolbar_item {
	struct toolbar_item	*next;
555
	struct toolbar_item	*prev;
556 557 558 559 560 561 562 563 564 565 566 567
	int			id;
} toolbar_item_t;

typedef struct toolbar {
	DWORD		memopt;
	lvc_t		lvc;
	int		button_width;
	int		button_height;
	int		nitems;
	toolbar_item_t	*items;
} toolbar_t;

568 569 570 571 572 573
typedef struct dlginit {
	DWORD		memopt;
	raw_data_t	*data;
} dlginit_t;


Alexandre Julliard's avatar
Alexandre Julliard committed
574 575 576 577 578 579 580 581 582
/* A top-level resource node */
typedef struct resource {
	struct resource	*next;
	struct resource *prev;
	enum res_e	type;
	name_id_t	*name;	/* resource's name */
	language_t	*lan;	/* Only used as a sorting key and c-name creation*/
	union {
		accelerator_t	*acc;
583
		ani_curico_t	*ani;
Alexandre Julliard's avatar
Alexandre Julliard committed
584 585 586 587
		bitmap_t	*bmp;
		cursor_t	*cur;
		cursor_group_t	*curg;
		dialog_t	*dlg;
588
		dlginit_t       *dlgi;
Alexandre Julliard's avatar
Alexandre Julliard committed
589
		font_t		*fnt;
590
		fontdir_t	*fnd;
Alexandre Julliard's avatar
Alexandre Julliard committed
591 592 593 594
		icon_t		*ico;
		icon_group_t	*icog;
		menu_t		*men;
		messagetable_t	*msg;
595
		html_t		*html;
Alexandre Julliard's avatar
Alexandre Julliard committed
596 597
		rcdata_t	*rdt;
		stringtable_t	*stt;
598
		toolbar_t	*tbt;
Alexandre Julliard's avatar
Alexandre Julliard committed
599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
		user_t		*usr;
		versioninfo_t	*ver;
		void		*overlay; /* To catch all types at once... */
	} res;
	res_t		*binres;	/* To binary converted resource */
	char		*c_name;	/* BaseName in output */
	DWORD		memopt;
} resource_t;

/* Resource count */
typedef struct res32_count {
	int			count;
	resource_t		**rsc;
} res32_count_t;

typedef struct res_count {
	name_id_t		type;
	int			count;		/* win16 mode */
	resource_t		**rscarray;
	int			count32;
	res32_count_t		*rsc32array;	/* win32 mode */
	int			n_id_entries;
	int			n_name_entries;
} res_count_t;

624
typedef struct style_pair {
625 626
    	style_t			*style;
	style_t			*exstyle;
627 628
} style_pair_t;

Alexandre Julliard's avatar
Alexandre Julliard committed
629
#endif