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 };
57
58 /* name level of the resource tree */
59 struct res_name
60 {
61 const struct string_id *name; /* name */
62 struct resource *res; /* resource */
63 int nb_languages; /* number of languages */
64 unsigned int dir_offset; /* offset of directory in resource dir */
65 unsigned int name_offset; /* offset of name in resource dir */
66 };
67
68 /* type level of the resource tree */
69 struct res_type
70 {
71 const struct string_id *type; /* type name */
72 struct res_name *names; /* names array */
73 unsigned int nb_names; /* total number of names */
74 unsigned int nb_id_names; /* number of names that have a numeric id */
75 unsigned int dir_offset; /* offset of directory in resource dir */
76 unsigned int name_offset; /* offset of type name in resource dir */
77 };
78
79 /* top level of the resource tree */
80 struct res_tree
81 {
82 struct res_type *types; /* types array */
83 unsigned int nb_types; /* total number of types */
84 };
85
86 /* size of a resource directory with n entries */
87 #define RESOURCE_DIR_SIZE (4 * sizeof(unsigned int))
88 #define RESOURCE_DIR_ENTRY_SIZE (2 * sizeof(unsigned int))
89 #define RESOURCE_DATA_ENTRY_SIZE (4 * sizeof(unsigned int))
90 #define RESDIR_SIZE(n) (RESOURCE_DIR_SIZE + (n) * RESOURCE_DIR_ENTRY_SIZE)
91
92
93 static inline struct resource *add_resource( DLLSPEC *spec )
94 {
95 spec->resources = xrealloc( spec->resources, (spec->nb_resources + 1) * sizeof(spec->resources[0]) );
96 return &spec->resources[spec->nb_resources++];
97 }
98
99 static inline unsigned int strlenW( const WCHAR *str )
100 {
101 const WCHAR *s = str;
102 while (*s) s++;
103 return s - str;
104 }
105
106 static inline int strcmpW( const WCHAR *str1, const WCHAR *str2 )
107 {
108 while (*str1 && (*str1 == *str2)) { str1++; str2++; }
109 return *str1 - *str2;
110 }
111
112 static struct res_name *add_name( struct res_type *type, struct resource *res )
113 {
114 struct res_name *name;
115 type->names = xrealloc( type->names, (type->nb_names + 1) * sizeof(*type->names) );
116 name = &type->names[type->nb_names++];
117 name->name = &res->name;
118 name->res = res;
119 name->nb_languages = 1;
120 if (!name->name->str) type->nb_id_names++;
121 return name;
122 }
123
124 static struct res_type *add_type( struct res_tree *tree, struct resource *res )
125 {
126 struct res_type *type;
127 tree->types = xrealloc( tree->types, (tree->nb_types + 1) * sizeof(*tree->types) );
128 type = &tree->types[tree->nb_types++];
129 type->type = &res->type;
130 type->names = NULL;
131 type->nb_names = 0;
132 type->nb_id_names = 0;
133 return type;
134 }
135
136 /* get a string from the current resource file */
137 static void get_string( struct string_id *str )
138 {
139 WCHAR wc = get_word();
140
141 if (wc == 0xffff)
142 {
143 str->str = NULL;
144 str->id = get_word();
145 }
146 else
147 {
148 WCHAR *p = xmalloc( (strlenW( (const WCHAR *)(input_buffer + input_buffer_pos) - 1) + 1) * sizeof(WCHAR) );
149 str->str = p;
150 str->id = 0;
151 if ((*p++ = wc)) while ((*p++ = get_word()));
152 }
153 }
154
155 /* put a string into the resource file */
156 static void put_string( const struct string_id *str )
157 {
158 if (str->str)
159 {
160 const WCHAR *p = str->str;
161 while (*p) put_word( *p++ );
162 put_word( 0 );
163 }
164 else
165 {
166 put_word( 0xffff );
167 put_word( str->id );
168 }
169 }
170
171 static void dump_res_data( const struct resource *res )
172 {
173 unsigned int i = 0;
174 unsigned int size = (res->data_size + 3) & ~3;
175
176 if (!size) return;
177
178 input_buffer = res->data;
179 input_buffer_pos = 0;
180 input_buffer_size = size;
181
182 output( "\t.long " );
183 while (size > 4)
184 {
185 if ((i++ % 16) == 15) output( "0x%08x\n\t.long ", get_dword() );
186 else output( "0x%08x,", get_dword() );
187 size -= 4;
188 }
189 output( "0x%08x\n", get_dword() );
190 size -= 4;
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
224 res->data = input_buffer + input_buffer_pos - 2*sizeof(unsigned int) + hdr_size;
225 get_string( &res->type );
226 get_string( &res->name );
227 if (input_buffer_pos & 2) get_word(); /* align to dword boundary */
228 get_dword(); /* skip data version */
229 res->mem_options = get_word();
230 res->lang = get_word();
231 get_dword(); /* skip version */
232 get_dword(); /* skip characteristics */
233
234 input_buffer_pos = ((const unsigned char *)res->data - input_buffer) + ((res->data_size + 3) & ~3);
235 input_buffer_pos = (input_buffer_pos + 3) & ~3;
236 if (input_buffer_pos > input_buffer_size)
237 fatal_error( "%s is a truncated file\n", input_buffer_filename );
238 }
239
240 /* load a Win32 .res file */
241 int load_res32_file( const char *name, DLLSPEC *spec )
242 {
243 int ret;
244
245 init_input_buffer( name );
246
247 if ((ret = check_header()))
248 {
249 while (input_buffer_pos < input_buffer_size) load_next_resource( spec );
250 }
251 return ret;
252 }
253
254 /* compare two unicode strings/ids */
255 static int cmp_string( const struct string_id *str1, const struct string_id *str2 )
256 {
257 if (!str1->str)
258 {
259 if (!str2->str) return str1->id - str2->id;
260 return 1; /* an id compares larger than a string */
261 }
262 if (!str2->str) return -1;
263 return strcmpW( str1->str, str2->str );
264 }
265
266 /* compare two resources for sorting the resource directory */
267 /* resources are stored first by type, then by name, then by language */
268 static int cmp_res( const void *ptr1, const void *ptr2 )
269 {
270 const struct resource *res1 = ptr1;
271 const struct resource *res2 = ptr2;
272 int ret;
273
274 if ((ret = cmp_string( &res1->type, &res2->type ))) return ret;
275 if ((ret = cmp_string( &res1->name, &res2->name ))) return ret;
276 return res1->lang - res2->lang;
277 }
278
279 static char *format_res_string( const struct string_id *str )
280 {
281 int i, len = str->str ? strlenW(str->str) + 1 : 5;
282 char *ret = xmalloc( len );
283
284 if (!str->str) sprintf( ret, "%04x", str->id );
285 else for (i = 0; i < len; i++) ret[i] = str->str[i]; /* dumb W->A conversion */
286 return ret;
287 }
288
289 /* build the 3-level (type,name,language) resource tree */
290 static struct res_tree *build_resource_tree( DLLSPEC *spec, unsigned int *dir_size )
291 {
292 unsigned int i, k, n, offset, data_offset;
293 struct res_tree *tree;
294 struct res_type *type = NULL;
295 struct res_name *name = NULL;
296 struct resource *res;
297
298 qsort( spec->resources, spec->nb_resources, sizeof(*spec->resources), cmp_res );
299
300 tree = xmalloc( sizeof(*tree) );
301 tree->types = NULL;
302 tree->nb_types = 0;
303
304 for (i = 0; i < spec->nb_resources; i++)
305 {
306 if (!i || cmp_string( &spec->resources[i].type, &spec->resources[i-1].type )) /* new type */
307 {
308 type = add_type( tree, &spec->resources[i] );
309 name = add_name( type, &spec->resources[i] );
310 }
311 else if (cmp_string( &spec->resources[i].name, &spec->resources[i-1].name )) /* new name */
312 {
313 name = add_name( type, &spec->resources[i] );
314 }
315 else if (spec->resources[i].lang == spec->resources[i-1].lang)
316 {
317 char *type_str = format_res_string( &spec->resources[i].type );
318 char *name_str = format_res_string( &spec->resources[i].name );
319 error( "winebuild: duplicate resource type %s name %s language %04x\n",
320 type_str, name_str, spec->resources[i].lang );
321 }
322 else name->nb_languages++;
323 }
324
325 /* compute the offsets */
326
327 offset = RESDIR_SIZE( tree->nb_types );
328 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
329 {
330 type->dir_offset = offset;
331 offset += RESDIR_SIZE( type->nb_names );
332 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
333 {
334 name->dir_offset = offset;
335 offset += RESDIR_SIZE( name->nb_languages );
336 }
337 }
338 data_offset = offset;
339 offset += spec->nb_resources * RESOURCE_DATA_ENTRY_SIZE;
340
341 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
342 {
343 if (type->type->str)
344 {
345 type->name_offset = offset | 0x80000000;
346 offset += (strlenW(type->type->str)+1) * sizeof(WCHAR);
347 }
348 else type->name_offset = type->type->id;
349
350 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
351 {
352 if (name->name->str)
353 {
354 name->name_offset = offset | 0x80000000;
355 offset += (strlenW(name->name->str)+1) * sizeof(WCHAR);
356 }
357 else name->name_offset = name->name->id;
358 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
359 {
360 unsigned int entry_offset = (res - spec->resources) * RESOURCE_DATA_ENTRY_SIZE;
361 res->data_offset = data_offset + entry_offset;
362 }
363 }
364 }
365 if (dir_size) *dir_size = (offset + 3) & ~3;
366 return tree;
367 }
368
369 /* free the resource tree */
370 static void free_resource_tree( struct res_tree *tree )
371 {
372 unsigned int i;
373
374 for (i = 0; i < tree->nb_types; i++) free( tree->types[i].names );
375 free( tree->types );
376 free( tree );
377 }
378
379 /* output a Unicode string */
380 static void output_string( const WCHAR *name )
381 {
382 int i, len = strlenW(name);
383 output( "\t%s 0x%04x", get_asm_short_keyword(), len );
384 for (i = 0; i < len; i++) output( ",0x%04x", name[i] );
385 output( " /* " );
386 for (i = 0; i < len; i++) output( "%c", isprint((char)name[i]) ? (char)name[i] : '?' );
387 output( " */\n" );
388 }
389
390 /* output a resource directory */
391 static inline void output_res_dir( unsigned int nb_names, unsigned int nb_ids )
392 {
393 output( "\t.long 0\n" ); /* Characteristics */
394 output( "\t.long 0\n" ); /* TimeDateStamp */
395 output( "\t%s 0,0\n", /* Major/MinorVersion */
396 get_asm_short_keyword() );
397 output( "\t%s %u,%u\n", /* NumberOfNamed/IdEntries */
398 get_asm_short_keyword(), nb_names, nb_ids );
399 }
400
401 /* output the resource definitions */
402 void output_resources( DLLSPEC *spec )
403 {
404 int k, nb_id_types;
405 unsigned int i, n;
406 struct res_tree *tree;
407 struct res_type *type;
408 struct res_name *name;
409 const struct resource *res;
410
411 if (!spec->nb_resources) return;
412
413 tree = build_resource_tree( spec, NULL );
414
415 /* output the resource directories */
416
417 output( "\n/* resources */\n\n" );
418 output( "\t.data\n" );
419 output( "\t.align %d\n", get_alignment(get_ptr_size()) );
420 output( ".L__wine_spec_resources:\n" );
421
422 for (i = nb_id_types = 0, type = tree->types; i < tree->nb_types; i++, type++)
423 if (!type->type->str) nb_id_types++;
424
425 output_res_dir( tree->nb_types - nb_id_types, nb_id_types );
426
427 /* dump the type directory */
428
429 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
430 output( "\t.long 0x%08x,0x%08x\n",
431 type->name_offset, type->dir_offset | 0x80000000 );
432
433 /* dump the names and languages directories */
434
435 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
436 {
437 output_res_dir( type->nb_names - type->nb_id_names, type->nb_id_names );
438 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
439 output( "\t.long 0x%08x,0x%08x\n",
440 name->name_offset, name->dir_offset | 0x80000000 );
441
442 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
443 {
444 output_res_dir( 0, name->nb_languages );
445 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
446 output( "\t.long 0x%08x,0x%08x\n", res->lang, res->data_offset );
447 }
448 }
449
450 /* dump the resource data entries */
451
452 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
453 output( "\t.long .L__wine_spec_res_%d-.L__wine_spec_rva_base,%u,0,0\n",
454 i, (res->data_size + 3) & ~3 );
455
456 /* dump the name strings */
457
458 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
459 {
460 if (type->type->str) output_string( type->type->str );
461 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
462 if (name->name->str) output_string( name->name->str );
463 }
464
465 /* resource data */
466
467 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
468 {
469 output( "\n\t.align %d\n", get_alignment(get_ptr_size()) );
470 output( ".L__wine_spec_res_%d:\n", i );
471 dump_res_data( res );
472 }
473 output( ".L__wine_spec_resources_end:\n" );
474 output( "\t.byte 0\n" );
475
476 free_resource_tree( tree );
477 }
478
479 /* output a Unicode string in binary format */
480 static void output_bin_string( const WCHAR *name )
481 {
482 int i, len = strlenW(name);
483 put_word( len );
484 for (i = 0; i < len; i++) put_word( name[i] );
485 }
486
487 /* output a resource directory in binary format */
488 static inline void output_bin_res_dir( unsigned int nb_names, unsigned int nb_ids )
489 {
490 put_dword( 0 ); /* Characteristics */
491 put_dword( 0 ); /* TimeDateStamp */
492 put_word( 0 ); /* MajorVersion */
493 put_word( 0 ); /* MinorVersion */
494 put_word( nb_names ); /* NumberOfNamedEntries */
495 put_word( nb_ids ); /* NumberOfIdEntries */
496 }
497
498 /* output the resource definitions in binary format */
499 void output_bin_resources( DLLSPEC *spec, unsigned int start_rva )
500 {
501 int k, nb_id_types;
502 unsigned int i, n, data_offset;
503 struct res_tree *tree;
504 struct res_type *type;
505 struct res_name *name;
506 const struct resource *res;
507
508 if (!spec->nb_resources) return;
509
510 tree = build_resource_tree( spec, &data_offset );
511 init_output_buffer();
512
513 /* output the resource directories */
514
515 for (i = nb_id_types = 0, type = tree->types; i < tree->nb_types; i++, type++)
516 if (!type->type->str) nb_id_types++;
517
518 output_bin_res_dir( tree->nb_types - nb_id_types, nb_id_types );
519
520 /* dump the type directory */
521
522 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
523 {
524 put_dword( type->name_offset );
525 put_dword( type->dir_offset | 0x80000000 );
526 }
527
528 /* dump the names and languages directories */
529
530 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
531 {
532 output_bin_res_dir( type->nb_names - type->nb_id_names, type->nb_id_names );
533 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
534 {
535 put_dword( name->name_offset );
536 put_dword( name->dir_offset | 0x80000000 );
537 }
538
539 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
540 {
541 output_bin_res_dir( 0, name->nb_languages );
542 for (k = 0, res = name->res; k < name->nb_languages; k++, res++)
543 {
544 put_dword( res->lang );
545 put_dword( res->data_offset );
546 }
547 }
548 }
549
550 /* dump the resource data entries */
551
552 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
553 {
554 put_dword( data_offset + start_rva );
555 put_dword( (res->data_size + 3) & ~3 );
556 put_dword( 0 );
557 put_dword( 0 );
558 data_offset += (res->data_size + 3) & ~3;
559 }
560
561 /* dump the name strings */
562
563 for (i = 0, type = tree->types; i < tree->nb_types; i++, type++)
564 {
565 if (type->type->str) output_bin_string( type->type->str );
566 for (n = 0, name = type->names; n < type->nb_names; n++, name++)
567 if (name->name->str) output_bin_string( name->name->str );
568 }
569
570 /* resource data */
571
572 align_output( 4 );
573 for (i = 0, res = spec->resources; i < spec->nb_resources; i++, res++)
574 {
575 put_data( res->data, res->data_size );
576 align_output( 4 );
577 }
578
579 free_resource_tree( tree );
580 }
581
582 static unsigned int get_resource_header_size( const struct resource *res )
583 {
584 unsigned int size = 5 * sizeof(unsigned int) + 2 * sizeof(unsigned short);
585
586 if (!res->type.str) size += 2 * sizeof(unsigned short);
587 else size += (strlenW(res->type.str) + 1) * sizeof(WCHAR);
588
589 if (!res->name.str) size += 2 * sizeof(unsigned short);
590 else size += (strlenW(res->name.str) + 1) * sizeof(WCHAR);
591
592 return size;
593 }
594
595 /* output the resources into a .o file */
596 void output_res_o_file( DLLSPEC *spec )
597 {
598 unsigned int i;
599 char *res_file = NULL;
600 int fd, err;
601
602 if (!spec->nb_resources) fatal_error( "--resources mode needs at least one resource file as input\n" );
603 if (!output_file_name) fatal_error( "No output file name specified\n" );
604
605 byte_swapped = 0;
606 init_output_buffer();
607
608 put_dword( 0 ); /* ResSize */
609 put_dword( 32 ); /* HeaderSize */
610 put_word( 0xffff ); /* ResType */
611 put_word( 0x0000 );
612 put_word( 0xffff ); /* ResName */
613 put_word( 0x0000 );
614 put_dword( 0 ); /* DataVersion */
615 put_word( 0 ); /* Memory options */
616 put_word( 0 ); /* Language */
617 put_dword( 0 ); /* Version */
618 put_dword( 0 ); /* Characteristics */
619
620 for (i = 0; i < spec->nb_resources; i++)
621 {
622 unsigned int header_size = get_resource_header_size( &spec->resources[i] );
623
624 put_dword( spec->resources[i].data_size );
625 put_dword( (header_size + 3) & ~3 );
626 put_string( &spec->resources[i].type );
627 put_string( &spec->resources[i].name );
628 align_output( 4 );
629 put_dword( 0 );
630 put_word( spec->resources[i].mem_options );
631 put_word( spec->resources[i].lang );
632 put_dword( 0 );
633 put_dword( 0 );
634 put_data( spec->resources[i].data, spec->resources[i].data_size );
635 align_output( 4 );
636 }
637
638 /* if the output file name is a .res too, don't run the results through windres */
639 if (strendswith( output_file_name, ".res"))
640 {
641 flush_output_buffer();
642 return;
643 }
644
645 res_file = get_temp_file_name( output_file_name, ".res" );
646 if ((fd = open( res_file, O_WRONLY|O_CREAT|O_TRUNC|O_BINARY, 0600 )) == -1)
647 fatal_error( "Cannot create %s\n", res_file );
648 if (write( fd, output_buffer, output_buffer_pos ) != output_buffer_pos)
649 fatal_error( "Error writing to %s\n", res_file );
650 close( fd );
651 free( output_buffer );
652
653 if (res_file)
654 {
655 const char *prog = get_windres_command();
656 char *cmd = xmalloc( strlen(prog) + strlen(res_file) + strlen(output_file_name) + 9 );
657 sprintf( cmd, "%s -i %s -o %s", prog, res_file, output_file_name );
658 if (verbose) fprintf( stderr, "%s\n", cmd );
659 err = system( cmd );
660 if (err) fatal_error( "%s failed with status %d\n", prog, err );
661 free( cmd );
662 }
663 output_file_name = NULL; /* so we don't try to assemble it */
664 }
665
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.