2 * Builtin dlls resource support
4 * Copyright 2000 Alexandre Julliard
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.
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.
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
22 #include "wine/port.h"
30 #ifdef HAVE_SYS_TYPES_H
31 # include <sys/types.h>
37 typedef unsigned short WCHAR
;
39 /* Unicode string or integer id */
42 WCHAR
*str
; /* ptr to Unicode string */
43 unsigned short id
; /* integer id if str is NULL */
46 /* descriptor for a resource */
49 struct string_id type
;
50 struct string_id name
;
52 unsigned int data_size
;
53 unsigned int data_offset
;
54 unsigned short mem_options
;
59 /* name level of the resource tree */
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 */
69 /* type level of the resource tree */
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 */
80 /* top level of the resource tree */
83 struct res_type
*types
; /* types array */
84 unsigned int nb_types
; /* total number of types */
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)
94 static inline struct resource
*add_resource( DLLSPEC
*spec
)
96 spec
->resources
= xrealloc( spec
->resources
, (spec
->nb_resources
+ 1) * sizeof(spec
->resources
[0]) );
97 return &spec
->resources
[spec
->nb_resources
++];
100 static inline unsigned int strlenW( const WCHAR
*str
)
102 const WCHAR
*s
= str
;
107 static inline int strcmpW( const WCHAR
*str1
, const WCHAR
*str2
)
109 while (*str1
&& (*str1
== *str2
)) { str1
++; str2
++; }
110 return *str1
- *str2
;
113 static struct res_name
*add_name( struct res_type
*type
, struct resource
*res
)
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
;
120 name
->nb_languages
= 1;
121 if (!name
->name
->str
) type
->nb_id_names
++;
125 static struct res_type
*add_type( struct res_tree
*tree
, struct resource
*res
)
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
;
133 type
->nb_id_names
= 0;
137 /* get a string from the current resource file */
138 static void get_string( struct string_id
*str
)
140 WCHAR wc
= get_word();
145 str
->id
= get_word();
149 WCHAR
*p
= xmalloc( (strlenW( (const WCHAR
*)(input_buffer
+ input_buffer_pos
) - 1) + 1) * sizeof(WCHAR
) );
152 if ((*p
++ = wc
)) while ((*p
++ = get_word()));
156 /* put a string into the resource file */
157 static void put_string( const struct string_id
*str
)
161 const WCHAR
*p
= str
->str
;
162 while (*p
) put_word( *p
++ );
172 static void dump_res_data( const struct resource
*res
)
175 unsigned int size
= (res
->data_size
+ 3) & ~3;
179 input_buffer
= res
->data
;
180 input_buffer_pos
= 0;
181 input_buffer_size
= size
;
183 output( "\t.long " );
186 if ((i
++ % 16) == 15) output( "0x%08x\n\t.long ", get_dword() );
187 else output( "0x%08x,", get_dword() );
190 output( "0x%08x\n", get_dword() );
191 assert( input_buffer_pos
== input_buffer_size
);
194 /* check the file header */
195 /* all values must be zero except header size */
196 static int check_header(void)
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 */
214 /* load the next resource from the current file */
215 static void load_next_resource( DLLSPEC
*spec
)
217 unsigned int hdr_size
;
218 struct resource
*res
= add_resource( spec
);
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
);
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 */
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
);
244 /* load a Win32 .res file */
245 int load_res32_file( const char *name
, DLLSPEC
*spec
)
249 init_input_buffer( name
);
251 if ((ret
= check_header()))
253 while (input_buffer_pos
< input_buffer_size
) load_next_resource( spec
);
258 /* compare two unicode strings/ids */
259 static int cmp_string( const struct string_id
*str1
, const struct string_id
*str2
)
263 if (!str2
->str
) return str1
->id
- str2
->id
;
264 return 1; /* an id compares larger than a string */
266 if (!str2
->str
) return -1;
267 return strcmpW( str1
->str
, str2
->str
);
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
)
274 const struct resource
*res1
= ptr1
;
275 const struct resource
*res2
= ptr2
;
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
;
284 static char *format_res_string( const struct string_id
*str
)
286 int i
, len
= str
->str
? strlenW(str
->str
) + 1 : 5;
287 char *ret
= xmalloc( len
);
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 */
294 /* get rid of duplicate resources with different versions */
295 static void remove_duplicate_resources( DLLSPEC
*spec
)
299 for (i
= n
= 0; i
< spec
->nb_resources
; i
++, n
++)
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
)
305 if (spec
->resources
[i
].version
== spec
->resources
[i
-1].version
)
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
);
312 else n
--; /* replace the previous one */
314 if (n
< i
) spec
->resources
[n
] = spec
->resources
[i
];
316 spec
->nb_resources
= n
;
319 /* build the 3-level (type,name,language) resource tree */
320 static struct res_tree
*build_resource_tree( DLLSPEC
*spec
, unsigned int *dir_size
)
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
;
328 qsort( spec
->resources
, spec
->nb_resources
, sizeof(*spec
->resources
), cmp_res
);
329 remove_duplicate_resources( spec
);
331 tree
= xmalloc( sizeof(*tree
) );
335 for (i
= 0; i
< spec
->nb_resources
; i
++)
337 if (!i
|| cmp_string( &spec
->resources
[i
].type
, &spec
->resources
[i
-1].type
)) /* new type */
339 type
= add_type( tree
, &spec
->resources
[i
] );
340 name
= add_name( type
, &spec
->resources
[i
] );
342 else if (cmp_string( &spec
->resources
[i
].name
, &spec
->resources
[i
-1].name
)) /* new name */
344 name
= add_name( type
, &spec
->resources
[i
] );
348 name
->nb_languages
++;
352 /* compute the offsets */
354 offset
= RESDIR_SIZE( tree
->nb_types
);
355 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
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
++)
361 name
->dir_offset
= offset
;
362 offset
+= RESDIR_SIZE( name
->nb_languages
);
365 data_offset
= offset
;
366 offset
+= spec
->nb_resources
* RESOURCE_DATA_ENTRY_SIZE
;
368 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
372 type
->name_offset
= offset
| 0x80000000;
373 offset
+= (strlenW(type
->type
->str
)+1) * sizeof(WCHAR
);
375 else type
->name_offset
= type
->type
->id
;
377 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
381 name
->name_offset
= offset
| 0x80000000;
382 offset
+= (strlenW(name
->name
->str
)+1) * sizeof(WCHAR
);
384 else name
->name_offset
= name
->name
->id
;
385 for (k
= 0, res
= name
->res
; k
< name
->nb_languages
; k
++, res
++)
387 unsigned int entry_offset
= (res
- spec
->resources
) * RESOURCE_DATA_ENTRY_SIZE
;
388 res
->data_offset
= data_offset
+ entry_offset
;
392 if (dir_size
) *dir_size
= (offset
+ 3) & ~3;
396 /* free the resource tree */
397 static void free_resource_tree( struct res_tree
*tree
)
401 for (i
= 0; i
< tree
->nb_types
; i
++) free( tree
->types
[i
].names
);
406 /* output a Unicode string */
407 static void output_string( const WCHAR
*name
)
409 int i
, len
= strlenW(name
);
410 output( "\t%s 0x%04x", get_asm_short_keyword(), len
);
411 for (i
= 0; i
< len
; i
++) output( ",0x%04x", name
[i
] );
413 for (i
= 0; i
< len
; i
++) output( "%c", isprint((char)name
[i
]) ? (char)name
[i
] : '?' );
417 /* output a resource directory */
418 static inline void output_res_dir( unsigned int nb_names
, unsigned int nb_ids
)
420 output( "\t.long 0\n" ); /* Characteristics */
421 output( "\t.long 0\n" ); /* TimeDateStamp */
422 output( "\t%s 0,0\n", /* Major/MinorVersion */
423 get_asm_short_keyword() );
424 output( "\t%s %u,%u\n", /* NumberOfNamed/IdEntries */
425 get_asm_short_keyword(), nb_names
, nb_ids
);
428 /* output the resource definitions */
429 void output_resources( DLLSPEC
*spec
)
433 struct res_tree
*tree
;
434 struct res_type
*type
;
435 struct res_name
*name
;
436 const struct resource
*res
;
438 if (!spec
->nb_resources
) return;
440 tree
= build_resource_tree( spec
, NULL
);
442 /* output the resource directories */
444 output( "\n/* resources */\n\n" );
445 output( "\t.data\n" );
446 output( "\t.align %d\n", get_alignment(get_ptr_size()) );
447 output( ".L__wine_spec_resources:\n" );
449 for (i
= nb_id_types
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
450 if (!type
->type
->str
) nb_id_types
++;
452 output_res_dir( tree
->nb_types
- nb_id_types
, nb_id_types
);
454 /* dump the type directory */
456 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
457 output( "\t.long 0x%08x,0x%08x\n",
458 type
->name_offset
, type
->dir_offset
| 0x80000000 );
460 /* dump the names and languages directories */
462 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
464 output_res_dir( type
->nb_names
- type
->nb_id_names
, type
->nb_id_names
);
465 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
466 output( "\t.long 0x%08x,0x%08x\n",
467 name
->name_offset
, name
->dir_offset
| 0x80000000 );
469 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
471 output_res_dir( 0, name
->nb_languages
);
472 for (k
= 0, res
= name
->res
; k
< name
->nb_languages
; k
++, res
++)
473 output( "\t.long 0x%08x,0x%08x\n", res
->lang
, res
->data_offset
);
477 /* dump the resource data entries */
479 for (i
= 0, res
= spec
->resources
; i
< spec
->nb_resources
; i
++, res
++)
480 output( "\t.long .L__wine_spec_res_%d-.L__wine_spec_rva_base,%u,0,0\n",
481 i
, (res
->data_size
+ 3) & ~3 );
483 /* dump the name strings */
485 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
487 if (type
->type
->str
) output_string( type
->type
->str
);
488 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
489 if (name
->name
->str
) output_string( name
->name
->str
);
494 for (i
= 0, res
= spec
->resources
; i
< spec
->nb_resources
; i
++, res
++)
496 output( "\n\t.align %d\n", get_alignment(get_ptr_size()) );
497 output( ".L__wine_spec_res_%d:\n", i
);
498 dump_res_data( res
);
500 output( ".L__wine_spec_resources_end:\n" );
501 output( "\t.byte 0\n" );
503 free_resource_tree( tree
);
506 /* output a Unicode string in binary format */
507 static void output_bin_string( const WCHAR
*name
)
509 int i
, len
= strlenW(name
);
511 for (i
= 0; i
< len
; i
++) put_word( name
[i
] );
514 /* output a resource directory in binary format */
515 static inline void output_bin_res_dir( unsigned int nb_names
, unsigned int nb_ids
)
517 put_dword( 0 ); /* Characteristics */
518 put_dword( 0 ); /* TimeDateStamp */
519 put_word( 0 ); /* MajorVersion */
520 put_word( 0 ); /* MinorVersion */
521 put_word( nb_names
); /* NumberOfNamedEntries */
522 put_word( nb_ids
); /* NumberOfIdEntries */
525 /* output the resource definitions in binary format */
526 void output_bin_resources( DLLSPEC
*spec
, unsigned int start_rva
)
529 unsigned int i
, n
, data_offset
;
530 struct res_tree
*tree
;
531 struct res_type
*type
;
532 struct res_name
*name
;
533 const struct resource
*res
;
535 if (!spec
->nb_resources
) return;
537 tree
= build_resource_tree( spec
, &data_offset
);
538 init_output_buffer();
540 /* output the resource directories */
542 for (i
= nb_id_types
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
543 if (!type
->type
->str
) nb_id_types
++;
545 output_bin_res_dir( tree
->nb_types
- nb_id_types
, nb_id_types
);
547 /* dump the type directory */
549 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
551 put_dword( type
->name_offset
);
552 put_dword( type
->dir_offset
| 0x80000000 );
555 /* dump the names and languages directories */
557 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
559 output_bin_res_dir( type
->nb_names
- type
->nb_id_names
, type
->nb_id_names
);
560 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
562 put_dword( name
->name_offset
);
563 put_dword( name
->dir_offset
| 0x80000000 );
566 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
568 output_bin_res_dir( 0, name
->nb_languages
);
569 for (k
= 0, res
= name
->res
; k
< name
->nb_languages
; k
++, res
++)
571 put_dword( res
->lang
);
572 put_dword( res
->data_offset
);
577 /* dump the resource data entries */
579 for (i
= 0, res
= spec
->resources
; i
< spec
->nb_resources
; i
++, res
++)
581 put_dword( data_offset
+ start_rva
);
582 put_dword( (res
->data_size
+ 3) & ~3 );
585 data_offset
+= (res
->data_size
+ 3) & ~3;
588 /* dump the name strings */
590 for (i
= 0, type
= tree
->types
; i
< tree
->nb_types
; i
++, type
++)
592 if (type
->type
->str
) output_bin_string( type
->type
->str
);
593 for (n
= 0, name
= type
->names
; n
< type
->nb_names
; n
++, name
++)
594 if (name
->name
->str
) output_bin_string( name
->name
->str
);
600 for (i
= 0, res
= spec
->resources
; i
< spec
->nb_resources
; i
++, res
++)
602 put_data( res
->data
, res
->data_size
);
606 free_resource_tree( tree
);
609 static unsigned int get_resource_header_size( const struct resource
*res
)
611 unsigned int size
= 5 * sizeof(unsigned int) + 2 * sizeof(unsigned short);
613 if (!res
->type
.str
) size
+= 2 * sizeof(unsigned short);
614 else size
+= (strlenW(res
->type
.str
) + 1) * sizeof(WCHAR
);
616 if (!res
->name
.str
) size
+= 2 * sizeof(unsigned short);
617 else size
+= (strlenW(res
->name
.str
) + 1) * sizeof(WCHAR
);
622 /* output the resources into a .o file */
623 void output_res_o_file( DLLSPEC
*spec
)
626 char *res_file
= NULL
;
628 struct strarray
*args
;
630 if (!spec
->nb_resources
) fatal_error( "--resources mode needs at least one resource file as input\n" );
631 if (!output_file_name
) fatal_error( "No output file name specified\n" );
633 qsort( spec
->resources
, spec
->nb_resources
, sizeof(*spec
->resources
), cmp_res
);
634 remove_duplicate_resources( spec
);
637 init_output_buffer();
639 put_dword( 0 ); /* ResSize */
640 put_dword( 32 ); /* HeaderSize */
641 put_word( 0xffff ); /* ResType */
643 put_word( 0xffff ); /* ResName */
645 put_dword( 0 ); /* DataVersion */
646 put_word( 0 ); /* Memory options */
647 put_word( 0 ); /* Language */
648 put_dword( 0 ); /* Version */
649 put_dword( 0 ); /* Characteristics */
651 for (i
= 0; i
< spec
->nb_resources
; i
++)
653 unsigned int header_size
= get_resource_header_size( &spec
->resources
[i
] );
655 put_dword( spec
->resources
[i
].data_size
);
656 put_dword( (header_size
+ 3) & ~3 );
657 put_string( &spec
->resources
[i
].type
);
658 put_string( &spec
->resources
[i
].name
);
661 put_word( spec
->resources
[i
].mem_options
);
662 put_word( spec
->resources
[i
].lang
);
663 put_dword( spec
->resources
[i
].version
);
665 put_data( spec
->resources
[i
].data
, spec
->resources
[i
].data_size
);
669 /* if the output file name is a .res too, don't run the results through windres */
670 if (strendswith( output_file_name
, ".res"))
672 flush_output_buffer();
676 res_file
= get_temp_file_name( output_file_name
, ".res" );
677 if ((fd
= open( res_file
, O_WRONLY
|O_CREAT
|O_TRUNC
|O_BINARY
, 0600 )) == -1)
678 fatal_error( "Cannot create %s\n", res_file
);
679 if (write( fd
, output_buffer
, output_buffer_pos
) != output_buffer_pos
)
680 fatal_error( "Error writing to %s\n", res_file
);
682 free( output_buffer
);
684 args
= strarray_init();
685 strarray_add( args
, find_tool( "windres", NULL
), "-i", res_file
, "-o", output_file_name
, NULL
);
687 strarray_free( args
);
689 output_file_name
= NULL
; /* so we don't try to assemble it */