2 * upkg: tool for manipulating Unreal Tournament packages.
3 * Copyright © 2009-2011 Nick Bowler
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
27 #include <glib-object.h>
29 #include <uobject/uobject.h>
30 #include <uobject/module.h>
31 #include <uobject/package.h>
35 #define U_OBJECT_GET_PRIV(o) \
36 G_TYPE_INSTANCE_GET_PRIVATE(o, U_TYPE_OBJECT, struct u_object_priv)
40 const char *prop_name, *struct_name;
41 unsigned long size, array_idx;
64 struct u_object_priv {
68 unsigned char buf[2048];
72 G_DEFINE_TYPE(UObject, u_object, G_TYPE_OBJECT);
75 * Determine the actual size (in bytes) of a property, given the 3-bit encoded
76 * size from the tag byte. Depending on the tag size, there will be 0, 1, 2
77 * or 4 additional size bytes, which are to be found in the provided buffer
78 * which is at least n bytes long. The result is stored in *size.
80 * Returns the number of bytes that were read from the buffer, which may be 0.
81 * On failure, (i.e., there was not enough material in the buffer) 0 is stored
85 decode_tag_size(unsigned long *size, unsigned tag_size,
86 const unsigned char *buf, unsigned long n)
91 case 0: *size = 1; return 0;
92 case 1: *size = 2; return 0;
93 case 2: *size = 4; return 0;
94 case 3: *size = 12; return 0;
95 case 4: *size = 16; return 0;
104 *size = unpack_16_le(buf);
109 *size = unpack_32_le(buf);
117 decode_array_index(unsigned long *index, const unsigned char *buf,
123 /* TODO: Actually implement this instead of aborting. */
124 assert("FIXME" && !(buf[0] & 0x80));
131 * Decode the (mostly) generic property header, filling out the struct pointed
132 * to by head. Returns the number of bytes read from the buffer, or 0 on
136 decode_prop_header(struct upkg *upkg, struct prop_head *head,
137 const unsigned char *buf, unsigned long n)
139 unsigned long rc, len = 0;
140 unsigned char tag_size;
143 rc = upkg_decode_index(&index, buf+len, n-len);
146 if (!(head->prop_name = upkg_get_name(upkg, index)))
150 /* A property called "None" terminates the list, and does not have
151 * the usual header. */
152 if (!strcmp(head->prop_name, "None")) {
153 head->type = PROPERTY_END;
160 head->tag_msb = (buf[len] >> 7) & 0x01;
161 tag_size = (buf[len] >> 4) & 0x07;
162 head->type = (buf[len] >> 0) & 0x0f;
166 * TODO: Confirm the correct relative ordering of the next three
169 if (head->type == PROPERTY_STRUCT) {
170 rc = upkg_decode_index(&index, buf+len, n-len);
173 if (!(head->struct_name = upkg_get_name(upkg, index)))
178 rc = decode_tag_size(&head->size, tag_size, buf+len, n-len);
179 if (rc == 0 && head->size == 0)
184 if (head->tag_msb && head->type != PROPERTY_BOOLEAN) {
185 rc = decode_array_index(&head->array_idx, buf+len, n-len);
195 * TODO: Make this use the uobject_module stuff so packages are not loaded
199 open_import_package(UObject *uo, const struct upkg_import *i)
203 assert(i->parent == NULL);
205 if (strcmp(i->class_package, "Core") != 0
206 || strcmp(i->class_name, "Package") != 0) {
207 u_err(uo, "import root must be Core.Package");
211 pkg = u_pkg_open(i->name);
212 if (!pkg || !g_type_module_use(pkg)) {
213 u_err(uo, "failed to open package: %s", i->name);
217 if (!U_PKG(pkg)->pkg) {
218 g_type_module_unuse(pkg);
219 u_err(uo, "failed to open package: %s", pkg->name);
226 /* Find the export index of a package based on the import chain from another
227 * package. Returns the (non-negative) offset on success, or a negative value
229 static long resolve_import(struct upkg *pkg, const struct upkg_import *import)
236 current = resolve_import(pkg, import->parent);
237 if (current != -1 && current >= 0)
240 index = upkg_export_find(pkg, current, import->name);
247 static GObject *get_import_object(UObject *uo, unsigned long index)
249 const struct upkg_import *import;
254 import = upkg_get_import(uo->pkg_file->pkg, index);
256 u_err(uo, "invalid package import: %ld", index);
260 /* Get the package name at the top of the hierarchy. */
261 for (const struct upkg_import *i = import; i; i = i->parent) {
262 if (i->parent == NULL) {
263 pkg = open_import_package(uo, i);
269 obj_index = resolve_import(U_PKG(pkg)->pkg, import);
271 u_err(uo, "could not find import in package: %s", pkg->name);
275 obj = u_object_new_from_package(pkg, obj_index);
277 g_type_module_unuse(pkg);
281 static int decode_object_property(UObject *uo, GValue *val, unsigned long len)
283 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
288 rc = upkg_decode_index(&index, priv->buf+len, priv->nbuf-len);
289 if (rc == 0 || index == 0)
293 obj = get_import_object(uo, -(index+1));
295 obj = u_object_new_from_package(uo->pkg, index-1);
298 g_value_init(val, U_TYPE_OBJECT);
299 g_value_take_object(val, obj);
304 * Deserialize an IEEE 754 binary32 value in "little endian" (for whatever
305 * that term is worth in this context). That is, when interpreted as a little
306 * endian 32-bit unsigned integer: bit 31 is the sign, bits 30-23 are the
307 * (biased) exponent, and bits 22-0 are the encoded part of the significand.
309 * The implementation is designed to be agnostic of the platform's actual
310 * float type, but the conversion may be lossy if "float" is not itself a
311 * binary32 format. NaN payloads are not preserved.
313 static float unpack_binary32_le(const unsigned char *buf)
320 raw = unpack_32_le(buf);
321 exponent = (raw & 0x7f800000) >> 23;
322 significand = (raw & 0x007fffff) >> 0;
326 result = significand ? NAN : INFINITY;
329 significand |= 0x00800000;
332 result = ldexpf(significand, exponent-126-24);
335 return copysignf(result, raw & 0x80000000 ? -1 : 1);
338 static unsigned long deserialize_property(UObject *uo, struct prop_head *head)
340 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
341 unsigned long rc, len = 0;
344 rc = decode_prop_header(uo->pkg_file->pkg, head, priv->buf, priv->nbuf);
349 switch (head->type) {
353 if (head->size != 1 || priv->nbuf-len < head->size)
355 g_value_init(&val, G_TYPE_UCHAR);
356 g_value_set_uchar(&val, priv->buf[len]);
357 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
359 case PROPERTY_INTEGER:
360 if (head->size != 4 || priv->nbuf-len < head->size)
362 g_value_init(&val, G_TYPE_ULONG);
363 g_value_set_ulong(&val, unpack_32_le(priv->buf+len));
364 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
366 case PROPERTY_BOOLEAN:
369 g_value_init(&val, G_TYPE_BOOLEAN);
370 g_value_set_boolean(&val, head->tag_msb);
371 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
373 case PROPERTY_OBJECT:
374 rc = decode_object_property(uo, &val, len);
377 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
380 if (head->size != 4 || priv->nbuf-len < head->size)
382 g_value_init(&val, G_TYPE_FLOAT);
383 g_value_set_float(&val, unpack_binary32_le(priv->buf+len));
384 g_object_set_property(G_OBJECT(uo), head->prop_name, &val);
387 u_warn(uo, "%s: unsupported property type %u",
388 head->prop_name, (unsigned)head->type);
392 if (len > priv->nbuf) {
393 long skip = len - priv->nbuf;
395 /* XXX: Long properties are not supported yet, so just seek
396 * past them for now. */
397 if (upkg_export_seek(uo->pkg_file, skip, SEEK_CUR) != 0)
403 memmove(priv->buf, priv->buf+len, priv->nbuf-len);
409 /* Deserialize properties from an Unreal package. */
410 static int deserialize(UObject *uo)
412 struct u_object_priv *priv = U_OBJECT_GET_PRIV(uo);
413 struct upkg_file *f = uo->pkg_file;
414 unsigned long rc, tot_len = 0;
417 struct prop_head head;
419 /* Prime the buffer; deserialize_property assumes that there's
420 * enough data for "small" properties already available. */
422 void *buf = priv->buf + priv->nbuf;
423 size_t amt = sizeof priv->buf - priv->nbuf;
424 rc = upkg_export_read(f, buf, amt);
425 if (rc == 0 && priv->nbuf == 0)
430 rc = deserialize_property(uo, &head);
436 if (head.type == PROPERTY_END)
442 upkg_export_seek(f, 0, SEEK_SET);
448 * Get the full hierarchical object name for an export, used for diagnostics.
449 * The package name is passed in pname.
451 * Returns a buffer allocated by malloc on success, or NULL on failure.
453 static char *get_obj_fullname(const char *pname, const struct upkg_export *e)
455 size_t total_len = strlen(pname) + 1, len;
460 for (const struct upkg_export *c = e; c; c = c->parent) {
461 len = strlen(c->name) + 1;
462 if (total_len > SIZE_MAX - len)
467 fullname = malloc(total_len);
471 for (const struct upkg_export *c = e; c; c = c->parent) {
472 len = strlen(c->name);
473 assert(total_len > len);
475 total_len -= len + 1;
476 memcpy(fullname + total_len, c->name, len);
477 fullname[total_len + len] = c == e ? '\0' : '.';
480 assert(total_len == strlen(pname)+1);
481 memcpy(fullname, pname, total_len-1);
482 fullname[total_len-1] = '.';
487 int u_object_deserialize(GObject *obj, GTypeModule *pkg, unsigned long idx)
489 g_return_val_if_fail(IS_U_OBJECT(obj), -1);
490 g_return_val_if_fail(IS_U_PKG(pkg), -1);
492 UObject *uo = U_OBJECT(obj);
493 struct upkg *upkg = U_PKG(pkg)->pkg;
494 const struct upkg_export *e;
498 g_return_val_if_fail(uo->pkg_file == NULL, -1);
499 f = upkg_export_open(upkg, idx);
507 e = upkg_get_export(upkg, idx);
510 uo->pkg_name = get_obj_fullname(pkg->name, e);
514 rc = U_OBJECT_GET_CLASS(obj)->deserialize(uo);
516 upkg_export_close(f);
523 GObject *u_object_new_from_package(GTypeModule *pkg, unsigned long idx)
525 g_return_val_if_fail(IS_U_PKG(pkg), NULL);
527 const char *class, *package;
531 class = upkg_export_class(U_PKG(pkg)->pkg, idx, &package);
533 type = u_object_module_get_class(package, class);
535 obj = g_object_new(type, NULL);
536 if (u_object_deserialize(obj, pkg, idx) != 0) {
545 static void u_object_init(UObject *o)
551 static void u_object_finalize(GObject *o)
553 UObject *uo = U_OBJECT(o);
556 upkg_export_close(uo->pkg_file);
561 G_OBJECT_CLASS(u_object_parent_class)->finalize(o);
564 static void u_object_class_init(UObjectClass *class)
566 g_type_class_add_private(class, sizeof (struct u_object_priv));
567 GObjectClass *go = G_OBJECT_CLASS(class);
569 class->deserialize = deserialize;
570 go->finalize = u_object_finalize;
574 * Prepend a prefix to a printf-style format string. Unfortunately, there's
575 * no way to construct va_list values on the fly in C, so we cannot simply
576 * prepend %s and pass the prefix as an argument. Any % characters in the
577 * prefix will be escaped.
579 * Returns a pointer to a newly allocated string, which should be freed by the
580 * caller, or NULL otherwise.
582 static char *prepend_fmt(const char *prefix, const char *fmt)
584 size_t prefix_len = strlen(prefix), fmt_len = strlen(fmt);
587 if (prefix_len > SIZE_MAX/2 - sizeof ": ")
589 if (2*prefix_len > SIZE_MAX - fmt_len)
592 new_fmt = malloc(2*prefix_len + fmt_len + 1);
596 for (size_t i = 0; i < prefix_len; i++) {
597 if (prefix[i] == '%')
598 new_fmt[offset++] = '%';
599 new_fmt[offset++] = prefix[i];
602 new_fmt[offset++] = ':';
603 new_fmt[offset++] = ' ';
604 strcpy(new_fmt+offset, fmt);
610 /* Logging helpers that automatically prepend the UObject class information. */
611 void u_vlog_full(GObject *o, GLogLevelFlags level, const char *fmt, va_list ap)
613 g_return_if_fail(IS_U_OBJECT(o));
614 UObject *uo = U_OBJECT(o);
615 char *new_fmt = NULL;
618 new_fmt = prepend_fmt(uo->pkg_name, fmt);
620 g_log(G_OBJECT_TYPE_NAME(o), level, "%s",
627 g_logv(G_OBJECT_TYPE_NAME(o), level, fmt, ap);
631 void u_log_full(GObject *o, GLogLevelFlags level, const char *fmt, ...)
636 u_vlog_full(o, level, fmt, ap);