?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
comctl32/tests: Test more return values (Clang).
[wine/multimedia.git] / tools / winebuild / res32.c
blobd459a5fad881fa210787715064325ec7e37cfdf3
1 /*
2 * Builtin dlls resource support
3 *
4 * Copyright 2000 Alexandre Julliard
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
15 *
16 * You should have received a copy of the GNU Lesser General Public
17 * 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
19 */
20
21 #include "config.h"
22 #include "wine/port.h"
23
24 #include <assert.h>
25 #include <ctype.h>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <stdarg.h>
29 #include <stdio.h>
30 #ifdef HAVE_SYS_TYPES_H
31 # include <sys/types.h>
32 #endif
33 #include <fcntl.h>
34
35 #include "build.h"
36
37 typedef unsigned short WCHAR;
38
39 /* Unicode string or integer id */
40 struct string_id
41 {
42 WCHAR *str; /* ptr to Unicode string */
43 unsigned short id; /* integer id if str is NULL */
44 };
45
46 /* descriptor for a resource */
47 struct resource
48 {
49 struct string_id type;
50 struct string_id name;
51 const void *data;
52 unsigned int data_size;
53 unsigned int data_offset;
54 unsigned short mem_options;
55 unsigned short lang;
56 unsigned int version;
57 };
58
59 /* name level of the resource tree */
60 struct res_name
61 {
62 const struct string_id *name; /* name */
63 struct resource *res; /* resource */
64 int nb_languages; /* number of languages */
65 unsigned int dir_offset; /* offset of directory in resource dir */
66 unsigned int name_offset; /* offset of name in resource dir */
67 };
68
69 /* type level of the resource tree */
70 struct res_type
71 {
72 const struct string_id *type; /* type name */
73 struct res_name *names; /* names array */
74 unsigned int nb_names; /* total number of names */
75 unsigned int nb_id_names; /* number of names that have a numeric id */
76 unsigned int dir_offset; /* offset of directory in resource dir */
77 unsigned int name_offset; /* offset of type name in resource dir */
78 };
79
80 /* top level of the resource tree */
81 struct res_tree
82 {
83 struct res_type *types; /* types array */
84 unsigned int nb_types; /* total number of types */
85 };
86
87 /* size of a resource directory with n entries */
88 #define RESOURCE_DIR_SIZE (4 * sizeof(unsigned int))
89 #define RESOURCE_DIR_ENTRY_SIZE (2 * sizeof(unsigned int))
90 #define RESOURCE_DATA_ENTRY_SIZE (4 * sizeof(unsigned int))
91 #define RESDIR_SIZE(n) (RESOURCE_DIR_SIZE + (n) * RESOURCE_DIR_ENTRY_SIZE)
92
93
94 static inline struct resource *add_resource( DLLSPEC *spec )
95 {
96 spec->resources = xrealloc( spec->resources, (spec->nb_resources + 1) * sizeof(spec->resources[0]) );
97 return &spec->resources[spec->nb_resources++];
98 }
99
100 static inline unsigned int strlenW( const WCHAR *str )
101 {
102 const WCHAR *s = str;
103 while (*s) s++;
104 return s - str;
105 }
106
107 static inline int strcmpW( const WCHAR *str1, const WCHAR *str2 )
108 {
109 while (*str1 && (*str1 == *str2)) { str1++; str2++; }
110 return *str1 - *str2;
111 }
112
113 static struct res_name *add_name( struct res_type *type, struct resource *res )
114 {
115 struct res_name *name;
116 type->names = xrealloc( type->names, (type->nb_names + 1) * sizeof(*type->names) );
117 name = &type->names[type->nb_names++];
118 name->name = &res->name;
119 name->res = res;
120 name->nb_languages = 1;
121 if (!name->name->str) type->nb_id_names++;
122 return name;
123 }
124
125 static struct res_type *add_type( struct res_tree *tree, struct resource *res )
126 {
127 struct res_type *type;
128 tree->types = xrealloc( tree->types, (tree->nb_types + 1) * sizeof(*tree->types) );
129 type = &tree->types[tree->nb_types++];
130 type->type = &res->type;
131 type->names = NULL;
132 type->nb_names = 0;
133 type->nb_id_names = 0;
134 return type;
135 }
136
137 /* get a string from the current resource file */
138 static void get_string( struct string_id *str )
139 {
140 WCHAR wc = get_word();
141
142 if (wc == 0xffff)
143 {
144 str->str = NULL;
145 str->id = get_word();
146 }
147 else
148 {
149 WCHAR *p = xmalloc( (strlenW( (const WCHAR *)(input_buffer + input_buffer_pos) - 1) + 1) * sizeof(WCHAR) );
150 str->str = p;
151 str->id = 0;
152 if ((*p++ = wc)) while ((*p++ = get_word()));
153 }
154 }
155
156 /* put a string into the resource file */
157 static void put_string( const struct string_id *str )
158 {
159 if (str->str)
160 {
161 const WCHAR *p = str->str;
162 while (*p) put_word( *p++ );
163 put_word( 0 );
164 }
165 else
166 {
167 put_word( 0xffff );
168 put_word( str->id );
169 }
170 }
171
172 static void dump_res_data( const struct resource *res )
173 {
174 unsigned int i = 0;
175 unsigned int size = (res->data_size + 3) & ~3;
176
177 if (!size) return;
178
179 input_buffer = res->data;
180 input_buffer_pos = 0;
181 input_buffer_size = size;
182
183 output( "\t.long " );
184 while (size > 4)
185 {
186 if ((i++ % 16) == 15) output( "0x%08x\n\t.long ", get_dword() );
187 else output( "0x%08x,", get_dword() );
188 size -= 4;
189 }
190 output( "0x%08x\n", get_dword() );
191 assert( input_buffer_pos == input_buffer_size );
192 }
193
194 /* check the file header */
195 /* all values must be zero except header size */
196 static int check_header(void)
197 {
198 unsigned int size;
199
200 if (get_dword()) return 0; /* data size */
201 size = get_dword(); /* header size */
202 if (size == 0x20000000) byte_swapped = 1;
203 else if (size != 0x20) return 0;
204 if (get_word() != 0xffff || get_word()) return 0; /* type, must be id 0 */
205 if (get_word() != 0xffff || get_word()) return 0; /* name, must be id 0 */
206 if (get_dword()) return 0; /* data version */
207 if (get_word()) return 0; /* mem options */
208 if (get_word()) return 0; /* language */
209 if (get_dword()) return 0; /* version */
210 if (get_dword()) return 0; /* characteristics */
211 return 1;
212 }
213
214 /* load the next resource from the current file */
215 static void load_next_resource( DLLSPEC *spec )
216 {
217 unsigned int hdr_size;
218 struct resource *res = add_resource( spec );
219
220 res->data_size = get_dword();
221 hdr_size = get_dword();
222 if (hdr_size & 3) fatal_error( "%s header size not aligned\n", input_buffer_filename );
223 if (hdr_size < 32) fatal_error( "%s invalid header size %u\n", input_buffer_filename, hdr_size );
224
225 res->data = input_buffer + input_buffer_pos - 2*sizeof(unsigned int) + hdr_size;
226 if ((const unsigned char *)res->data < input_buffer ||
227 (const unsigned char *)res->data >= input_buffer + input_buffer_size)
228 fatal_error( "%s invalid header size %u\n", input_buffer_filename, hdr_size );
229 get_string( &res->type );
230 get_string( &res->name );
231 if (input_buffer_pos & 2) get_word(); /* align to dword boundary */
232 get_dword(); /* skip data version */
233 res->mem_options = get_word();
234 res->lang = get_word();
235 res->version = get_dword();
236 get_dword(); /* skip characteristics */
237
238 input_buffer_pos = ((const unsigned char *)res->data - input_buffer) + ((res->data_size + 3) & ~3);
239 input_buffer_pos = (input_buffer_pos + 3) & ~3;
240 if (input_buffer_pos > input_buffer_size)
241 fatal_error( "%s is a truncated file\n", input_buffer_filename );
242 }
243
244 /* load a Win32 .res file */
245 int load_res32_file( const char *name, DLLSPEC *spec )
246 {
247 int ret;
248
249 init_input_buffer( name );
250
251 if ((ret = check_header()))
252 {
253 while (input_buffer_pos < input_buffer_size) load_next_resource( spec );
254 }
255 return ret;
256 }
257
258 /* compare two unicode strings/ids */
259 static int cmp_string( const struct string_id *str1, const struct string_id *str2 )
260 {
261 if (!str1->str)
262 {
263 if (!str2->str) return str1->id - str2->id;
264 return 1; /* an id compares larger than a string */
265 }
266 if (!str2->str) return -1;
267 return strcmpW( str1->str, str2->str );
268 }
269
270 /* compare two resources for sorting the resource directory */
271 /* resources are stored first by type, then by name, then by language */
272 static int cmp_res( const void *ptr1, const void *ptr2 )
273 {
274 const struct resource *res1 = ptr1;
275 const struct resource *res2 = ptr2;
276 int ret;
277
278 if ((ret = cmp_string( &res1->type, &res2->type ))) return ret;
279 if ((ret = cmp_string( &res1->name, &res2->name ))) return ret;
280 if ((ret = res1->lang - res2->lang)) return ret;
281 return res1->version - res2->version;
282 }
283
284 static char *format_res_string( const struct string_id *str )
285 {
286 int i, len = str->str ? strlenW(str->str) + 1 : 5;
287 char *ret = xmalloc( len );
288
289 if (!str->str) sprintf( ret, "%04x", str->id );
290 else for (i = 0; i < len; i++) ret[i] = str->str[i]; /* dumb W->A conversion */
291 return ret;
292 }
293
294 /* get rid of duplicate resources with different versions */
295 static void remove_duplicate_resources( DLLSPEC *spec )
296 {
297 unsigned int i, n;
298
299 for (i = n = 0; i < spec->nb_resources; i++, n++)
300 {
301 if (i && !cmp_string( &spec->resources[i].type, &spec->resources[i-1].type ) &&
302 !cmp_string( &spec->resources[i].name, &spec->resources[i-1].name ) &&
303 spec->resources[i].lang == spec->resources[i-1].lang)
304 {
305 if (spec->resources[i].version == spec->resources[i-1].version)
306 {
307 char *type_str = format_res_string( &spec->resources[i].type );
308 char *name_str = format_res_string( &spec->resources[i].name );
309 error( "winebuild: duplicate resource type %s name %s language %04x version %08x\n",
310 type_str, name_str, spec->resources[i].lang, spec->resources[i].version );
311 }
312 else n--; /* replace the previous one */
313 }
314 if (n < i) spec->resources[n] = spec->resources[i];
315 }
316 spec->nb_resources = n;
317 }
318
319 /* build the 3-level (type,name,language) resource tree */
320 static struct res_tree *build_resource_tree( DLLSPEC *spec, unsigned int *dir_size )
321 {
322 unsigned int i, k, n, offset, data_offset;
323 struct res_tree *tree;
324 struct res_type *type = NULL;
325 struct res_name *name = NULL;
326 struct resource *res;
327
328 qsort( spec->resources, spec->nb_resources, sizeof(*spec->resources), cmp_res );
329 remove_duplicate_resources( spec );
330
331 tree = xmalloc( sizeof(*tree) );
332 tree->types = NULL;
333 tree->nb_types = 0;
334
335 for (i = 0; i < spec->nb_resources; i++)
336 {
337 if (!i || cmp_string( &spec->resources[i].type, &spec->resources[i-1].type )) /* new type */
338 {
339 type = add_type( tree, &spec->resources[i] );
340 name = add_name( type, &spec->resources[i] );
341 }
342 else if (cmp_string( &spec->resources[i].name, &spec->resources[i-1].name )) /* new name */
343 {
344 name = add_name( type, &spec->resources[i] );
345 }
346 else
347 {
348 name->nb_languages++;
349 }
350 }
351
352 /* compute the offsets */
353
354 offset = RESDIR_SIZE( tree->nb_types );
355 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
356 {
357 type->dir_offset = offset;
358 offset += RESDIR_SIZE( type->nb_names );
359 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
360 {
361 name->dir_offset = offset;
362 offset += RESDIR_SIZE( name->nb_languages );
363 }
364 }
365 data_offset = offset;
366 offset += spec->nb_resources * RESOURCE_DATA_ENTRY_SIZE;
367
368 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
369 {
370 if (type->type->str)
371 {
372 type->name_offset = offset | 0x80000000;
373 offset += (strlenW(type->type->str)+1) * sizeof(WCHAR);
374 }
375 else type->name_offset = type->type->id;
376
377 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
378 {
379 if (name->name->str)
380 {
381 name->name_offset = offset | 0x80000000;
382 offset += (strlenW(name->name->str)+1) * sizeof(WCHAR);
383 }
384 else name->name_offset = name->name->id;
385 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
386 {
387 unsigned int entry_offset = (res - spec->resources) * RESOURCE_DATA_ENTRY_SIZE;
388 res->data_offset = data_offset + entry_offset;
389 }
390 }
391 }
392 if (dir_size) *dir_size = (offset + 3) & ~3;
393 return tree;
394 }
395
396 /* free the resource tree */
397 static void free_resource_tree( struct res_tree *tree )
398 {
399 unsigned int i;
400
401 for (i = 0; i < tree->nb_types; i++) free( tree->types[i].names );
402 free( tree->types );
403 free( tree );
404 }
405
406 /* output a Unicode string */
407 static void output_string( const WCHAR *name )
408 {
409 int i, len = strlenW(name);
410 output( "\t.short 0x%04x", len );
411 for (i = 0; i < len; i++) output( ",0x%04x", name[i] );
412 output( " /* " );
413 for (i = 0; i < len; i++) output( "%c", isprint((char)name[i]) ? (char)name[i] : '?' );
414 output( " */\n" );
415 }
416
417 /* output a resource directory */
418 static inline void output_res_dir( unsigned int nb_names, unsigned int nb_ids )
419 {
420 output( "\t.long 0\n" ); /* Characteristics */
421 output( "\t.long 0\n" ); /* TimeDateStamp */
422 output( "\t.short 0,0\n" ); /* Major/MinorVersion */
423 output( "\t.short %u,%u\n", /* NumberOfNamed/IdEntries */
424 nb_names, nb_ids );
425 }
426
427 /* output the resource definitions */
428 void output_resources( DLLSPEC *spec )
429 {
430 int k, nb_id_types;
431 unsigned int i, n;
432 struct res_tree *tree;
433 struct res_type *type;
434 struct res_name *name;
435 const struct resource *res;
436
437 if (!spec->nb_resources) return;
438
439 tree = build_resource_tree( spec, NULL );
440
441 /* output the resource directories */
442
443 output( "\n/* resources */\n\n" );
444 output( "\t.data\n" );
445 output( "\t.align %d\n", get_alignment(get_ptr_size()) );
446 output( ".L__wine_spec_resources:\n" );
447
448 for (i = nb_id_types = 0, type = tree->types; i < tree->nb_types; i++, type++)
449 if (!type->type->str) nb_id_types++;
450
451 output_res_dir( tree->nb_types - nb_id_types, nb_id_types );
452
453 /* dump the type directory */
454
455 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
456 output( "\t.long 0x%08x,0x%08x\n",
457 type->name_offset, type->dir_offset | 0x80000000 );
458
459 /* dump the names and languages directories */
460
461 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
462 {
463 output_res_dir( type->nb_names - type->nb_id_names, type->nb_id_names );
464 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
465 output( "\t.long 0x%08x,0x%08x\n",
466 name->name_offset, name->dir_offset | 0x80000000 );
467
468 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
469 {
470 output_res_dir( 0, name->nb_languages );
471 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
472 output( "\t.long 0x%08x,0x%08x\n", res->lang, res->data_offset );
473 }
474 }
475
476 /* dump the resource data entries */
477
478 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
479 output( "\t.long .L__wine_spec_res_%d-.L__wine_spec_rva_base,%u,0,0\n",
480 i, res->data_size );
481
482 /* dump the name strings */
483
484 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
485 {
486 if (type->type->str) output_string( type->type->str );
487 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
488 if (name->name->str) output_string( name->name->str );
489 }
490
491 /* resource data */
492
493 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
494 {
495 output( "\n\t.align %d\n", get_alignment(get_ptr_size()) );
496 output( ".L__wine_spec_res_%d:\n", i );
497 dump_res_data( res );
498 }
499 output( ".L__wine_spec_resources_end:\n" );
500 output( "\t.byte 0\n" );
501
502 free_resource_tree( tree );
503 }
504
505 /* output a Unicode string in binary format */
506 static void output_bin_string( const WCHAR *name )
507 {
508 int i, len = strlenW(name);
509 put_word( len );
510 for (i = 0; i < len; i++) put_word( name[i] );
511 }
512
513 /* output a resource directory in binary format */
514 static inline void output_bin_res_dir( unsigned int nb_names, unsigned int nb_ids )
515 {
516 put_dword( 0 ); /* Characteristics */
517 put_dword( 0 ); /* TimeDateStamp */
518 put_word( 0 ); /* MajorVersion */
519 put_word( 0 ); /* MinorVersion */
520 put_word( nb_names ); /* NumberOfNamedEntries */
521 put_word( nb_ids ); /* NumberOfIdEntries */
522 }
523
524 /* output the resource definitions in binary format */
525 void output_bin_resources( DLLSPEC *spec, unsigned int start_rva )
526 {
527 int k, nb_id_types;
528 unsigned int i, n, data_offset;
529 struct res_tree *tree;
530 struct res_type *type;
531 struct res_name *name;
532 const struct resource *res;
533
534 if (!spec->nb_resources) return;
535
536 tree = build_resource_tree( spec, &data_offset );
537 init_output_buffer();
538
539 /* output the resource directories */
540
541 for (i = nb_id_types = 0, type = tree->types; i < tree->nb_types; i++, type++)
542 if (!type->type->str) nb_id_types++;
543
544 output_bin_res_dir( tree->nb_types - nb_id_types, nb_id_types );
545
546 /* dump the type directory */
547
548 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
549 {
550 put_dword( type->name_offset );
551 put_dword( type->dir_offset | 0x80000000 );
552 }
553
554 /* dump the names and languages directories */
555
556 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
557 {
558 output_bin_res_dir( type->nb_names - type->nb_id_names, type->nb_id_names );
559 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
560 {
561 put_dword( name->name_offset );
562 put_dword( name->dir_offset | 0x80000000 );
563 }
564
565 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
566 {
567 output_bin_res_dir( 0, name->nb_languages );
568 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
569 {
570 put_dword( res->lang );
571 put_dword( res->data_offset );
572 }
573 }
574 }
575
576 /* dump the resource data entries */
577
578 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
579 {
580 put_dword( data_offset + start_rva );
581 put_dword( res->data_size );
582 put_dword( 0 );
583 put_dword( 0 );
584 data_offset += (res->data_size + 3) & ~3;
585 }
586
587 /* dump the name strings */
588
589 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
590 {
591 if (type->type->str) output_bin_string( type->type->str );
592 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
593 if (name->name->str) output_bin_string( name->name->str );
594 }
595
596 /* resource data */
597
598 align_output( 4 );
599 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
600 {
601 put_data( res->data, res->data_size );
602 align_output( 4 );
603 }
604
605 free_resource_tree( tree );
606 }
607
608 static unsigned int get_resource_header_size( const struct resource *res )
609 {
610 unsigned int size = 5 * sizeof(unsigned int) + 2 * sizeof(unsigned short);
611
612 if (!res->type.str) size += 2 * sizeof(unsigned short);
613 else size += (strlenW(res->type.str) + 1) * sizeof(WCHAR);
614
615 if (!res->name.str) size += 2 * sizeof(unsigned short);
616 else size += (strlenW(res->name.str) + 1) * sizeof(WCHAR);
617
618 return size;
619 }
620
621 /* output the resources into a .o file */
622 void output_res_o_file( DLLSPEC *spec )
623 {
624 unsigned int i;
625 char *res_file = NULL;
626 int fd;
627 struct strarray *args;
628
629 if (!spec->nb_resources) fatal_error( "--resources mode needs at least one resource file as input\n" );
630 if (!output_file_name) fatal_error( "No output file name specified\n" );
631
632 qsort( spec->resources, spec->nb_resources, sizeof(*spec->resources), cmp_res );
633 remove_duplicate_resources( spec );
634
635 byte_swapped = 0;
636 init_output_buffer();
637
638 put_dword( 0 ); /* ResSize */
639 put_dword( 32 ); /* HeaderSize */
640 put_word( 0xffff ); /* ResType */
641 put_word( 0x0000 );
642 put_word( 0xffff ); /* ResName */
643 put_word( 0x0000 );
644 put_dword( 0 ); /* DataVersion */
645 put_word( 0 ); /* Memory options */
646 put_word( 0 ); /* Language */
647 put_dword( 0 ); /* Version */
648 put_dword( 0 ); /* Characteristics */
649
650 for (i = 0; i < spec->nb_resources; i++)
651 {
652 unsigned int header_size = get_resource_header_size( &spec->resources[i] );
653
654 put_dword( spec->resources[i].data_size );
655 put_dword( (header_size + 3) & ~3 );
656 put_string( &spec->resources[i].type );
657 put_string( &spec->resources[i].name );
658 align_output( 4 );
659 put_dword( 0 );
660 put_word( spec->resources[i].mem_options );
661 put_word( spec->resources[i].lang );
662 put_dword( spec->resources[i].version );
663 put_dword( 0 );
664 put_data( spec->resources[i].data, spec->resources[i].data_size );
665 align_output( 4 );
666 }
667
668 /* if the output file name is a .res too, don't run the results through windres */
669 if (strendswith( output_file_name, ".res"))
670 {
671 flush_output_buffer();
672 return;
673 }
674
675 res_file = get_temp_file_name( output_file_name, ".res" );
676 if ((fd = open( res_file, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY, 0600 )) == -1)
677 fatal_error( "Cannot create %s\n", res_file );
678 if (write( fd, output_buffer, output_buffer_pos ) != output_buffer_pos)
679 fatal_error( "Error writing to %s\n", res_file );
680 close( fd );
681 free( output_buffer );
682
683 args = find_tool( "windres", NULL );
684 strarray_add( args, "-i", res_file, "-o", output_file_name, NULL );
685 spawn( args );
686 strarray_free( args );
687
688 output_file_name = NULL; /* so we don't try to assemble it */
689 }
Maarten's multimedia branch