diff libmlk-rpg/rpg/map-file.c @ 243:71b3b7036de7

misc: lot of cleanups, - prefix libraries with libmlk, - move assets from source directories closes #2520, - prefix header guards closes #2519
author David Demelier <markand@malikania.fr>
date Sat, 28 Nov 2020 22:37:30 +0100
parents librpg/rpg/map-file.c@76afe639fd72
children 8ef7fb7f14ad
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/libmlk-rpg/rpg/map-file.c	Sat Nov 28 22:37:30 2020 +0100
@@ -0,0 +1,285 @@
+/*
+ * map-file.c -- map file loader
+ *
+ * Copyright (c) 2020 David Demelier <markand@malikania.fr>
+ *
+ * Permission to use, copy, modify, and/or distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
+#define _XOPEN_SOURCE 700
+#include <assert.h>
+#include <errno.h>
+#include <libgen.h>
+#include <limits.h>
+#include <stddef.h>
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <core/alloc.h>
+#include <core/error.h>
+#include <core/image.h>
+#include <core/trace.h>
+
+#include "map-file.h"
+#include "rpg_p.h"
+
+/* Create %<v>c string literal for scanf */
+#define MAX_F(v) MAX_F_(v)
+#define MAX_F_(v) "%" #v "c"
+
+struct context {
+	struct map_file *mf;            /* Map loader. */
+	struct map *map;                /* Map object to fill. */
+	FILE *fp;                       /* Map file pointer. */
+	char basedir[PATH_MAX];         /* Parent map directory */
+};
+
+static bool
+parse_layer_tiles(struct context *ctx, const char *layer_name)
+{
+	enum map_layer_type layer_type;
+	size_t amount, current;
+
+	if (strcmp(layer_name, "background") == 0)
+		layer_type = MAP_LAYER_TYPE_BACKGROUND;
+	else if (strcmp(layer_name, "foreground") == 0)
+		layer_type = MAP_LAYER_TYPE_FOREGROUND;
+	else if (strcmp(layer_name, "above") == 0)
+		layer_type = MAP_LAYER_TYPE_ABOVE;
+	else
+		return errorf(_("invalid layer type: %s"), layer_name);
+
+	amount = ctx->map->columns * ctx->map->rows;
+	current = 0;
+
+	/*
+	 * The next line after a layer declaration is a list of plain integer
+	 * that fill the layer tiles.
+	 */
+	if (!(ctx->mf->layers[layer_type].tiles = alloc_array0(amount, sizeof (unsigned short))))
+		return false;
+
+	for (int tile; fscanf(ctx->fp, "%d\n", &tile) && current < amount; ++current)
+		ctx->mf->layers[layer_type].tiles[current] = tile;
+
+	ctx->map->layers[layer_type].tiles = ctx->mf->layers[layer_type].tiles;
+
+	return true;
+}
+
+static bool
+parse_actions(struct context *ctx)
+{
+	char exec[128 + 1];
+	int x = 0, y = 0;
+	unsigned int w = 0, h = 0;
+
+	while (fscanf(ctx->fp, "%d|%d|%u|%u|%128[^\n]\n", &x, &y, &w, &h, exec) == 5) {
+		struct action *act;
+
+		if (!ctx->mf->load_action) {
+			tracef(_("ignoring action %d,%d,%u,%u,%s"), x, y, w, h, exec);
+			continue;
+		}
+
+		if ((act = ctx->mf->load_action(ctx->map, x, y, w, h, exec)))
+			action_stack_add(&ctx->map->actions, act);
+	}
+
+	return true;
+}
+
+static bool
+parse_layer(struct context *ctx, const char *line)
+{
+	char layer_name[32 + 1] = {0};
+
+	/* Check if weight/height has been specified. */
+	if (ctx->map->columns == 0 || ctx->map->rows == 0)
+		return errorf(_("missing map dimensions before layer"));
+
+	/* Determine layer type. */
+	if (sscanf(line, "layer|%32s", layer_name) <= 0)
+		return errorf(_("missing layer type definition"));
+
+	if (strcmp(layer_name, "actions") == 0)
+		return parse_actions(ctx);
+
+	return parse_layer_tiles(ctx, layer_name);
+}
+
+static bool
+parse_tileset(struct context *ctx, const char *line)
+{
+	char path[PATH_MAX] = {0}, *p;
+	struct map_file *mf = ctx->mf;
+	struct tileset_file *tf = &mf->tileset_file;
+
+	if (!(p = strchr(line, '|')))
+		return errorf(_("could not parse tileset"));
+
+	snprintf(path, sizeof (path), "%s/%s", ctx->basedir, p + 1);
+
+	if (!tileset_file_open(tf, &mf->tileset, path))
+		return false;
+
+	ctx->map->tileset = &mf->tileset;
+
+	return true;
+}
+
+static bool
+parse_title(struct context *ctx, const char *line)
+{
+	if (sscanf(line, "title|" MAX_F(MAP_FILE_TITLE_MAX), ctx->mf->title) != 1 || strlen(ctx->mf->title) == 0)
+		return errorf(_("null map title"));
+
+	ctx->map->title = ctx->mf->title;
+
+	return true;
+}
+
+static bool
+parse_columns(struct context *ctx, const char *line)
+{
+	if (sscanf(line, "columns|%u", &ctx->map->columns) != 1 || ctx->map->columns == 0)
+		return errorf(_("null map columns"));
+
+	return true;
+}
+
+static bool
+parse_rows(struct context *ctx, const char *line)
+{
+	if (sscanf(line, "rows|%u", &ctx->map->rows) != 1 || ctx->map->rows == 0)
+		return errorf(_("null map rows"));
+
+	return true;
+}
+
+static bool
+parse_origin(struct context *ctx, const char *line)
+{
+	if (sscanf(line, "origin|%d|%d", &ctx->map->player_x, &ctx->map->player_y) != 2)
+		return errorf(_("invalid origin"));
+
+	return true;
+}
+
+static bool
+parse_line(struct context *ctx, const char *line)
+{
+	static const struct {
+		const char *property;
+		bool (*read)(struct context *, const char *);
+	} props[] = {
+		{ "title",      parse_title             },
+		{ "columns",    parse_columns           },
+		{ "rows",       parse_rows              },
+		{ "tileset",    parse_tileset           },
+		{ "origin",     parse_origin            },
+		{ "layer",      parse_layer             },
+	};
+
+	for (size_t i = 0; i < NELEM(props); ++i)
+		if (strncmp(line, props[i].property, strlen(props[i].property)) == 0)
+			return props[i].read(ctx, line);
+
+	return true;
+}
+
+static bool
+parse(struct context *ctx, const char *path)
+{
+	char line[1024];
+	char basedir[PATH_MAX];
+
+	snprintf(basedir, sizeof (basedir), "%s", path);
+	snprintf(ctx->basedir, sizeof (ctx->basedir), "%s", dirname(basedir));
+
+	while (fgets(line, sizeof (line), ctx->fp)) {
+		/* Remove \n if any */
+		line[strcspn(line, "\n")] = '\0';
+
+		if (!parse_line(ctx, line))
+			return false;
+	}
+
+	return true;
+}
+
+static bool
+check(struct map *map)
+{
+	/*
+	 * Check that we have parsed every required components.
+	 */
+	if (!map->title)
+		return errorf(_("missing title"));
+
+	/*
+	 * We don't need to check width/height because parsing layers and
+	 * tilesets already check for their presence, so only check layers.
+	 */
+	if (!map->layers[0].tiles)
+		return errorf(_("missing background layer"));
+	if (!map->layers[1].tiles)
+		return errorf(_("missing foreground layer"));
+	if (!tileset_ok(map->tileset))
+		return errorf(_("missing tileset"));
+
+	return true;
+}
+
+bool
+map_file_open(struct map_file *file, struct map *map, const char *path)
+{
+	assert(file);
+	assert(path);
+	assert(map);
+
+	struct context ctx = {
+		.mf = file,
+		.map = map,
+	};
+	bool ret = true;
+
+	memset(map, 0, sizeof (*map));
+
+	if (!(ctx.fp = fopen(path, "r")))
+		return errorf("%s", strerror(errno));
+
+	if (!(ret = parse(&ctx, path)) || !(ret = check(map))) {
+		map_finish(map);
+		map_file_finish(file);
+	}
+
+	fclose(ctx.fp);
+
+	return ret;
+}
+
+void
+map_file_finish(struct map_file *file)
+{
+	assert(file);
+
+	free(file->layers[0].tiles);
+	free(file->layers[1].tiles);
+	free(file->layers[2].tiles);
+
+	tileset_file_finish(&file->tileset_file);
+
+	memset(file, 0, sizeof (*file));
+}