[plomrogue] / src / server / field_of_view.c

/* src/server/field_of_view.c */

#include "field_of_view.h"
#include <stdint.h> /* uint8_t, uint16_t, uint32_t, int32_t */
#include <stdlib.h> /* free() */
#include <string.h> /* memset() */
#include "../common/rexit.h" /* exit_trouble() */
#include "../common/try_malloc.h" /* try_malloc() */
#include "map.h" /* yx_to_map_pos() */
#include "things.h" /* Thing */
#include "yx_uint8.h" /* yx_uint8 */
#include "world.h" /* world  */



/* Number of degrees a circle is divided into. The greater it is, the greater
 * the angle precision. But make it one whole zero larger and bizarre FOV bugs
 * appear on large maps, probably due to value overflows (TODO: more research!).
 */
#define CIRCLE 3600000



/* Angle of a shadow. */
struct shadow_angle
{
    struct shadow_angle * next;
    uint32_t left_angle;
    uint32_t right_angle;
};



/* Move "yx" into hex direction "d". */
static void mv_yx_in_hex_dir(char d, struct yx_uint8 * yx);

/* Move "yx" into hex direction "d". If this moves "yx" beyond the minimal (0)
 * or maximal (UINT8_MAX) column or row, it wraps to the opposite side. Such
 * wrapping is returned as a wraps enum value and stored, so that further calls
 * to move "yx" back into the opposite direction may unwrap it again. Pass an
 * "unwrap" of !0 to re-set the internal wrap memory to 0.
 */
static uint8_t mv_yx_in_dir_wrap(char d, struct yx_uint8 * yx, uint8_t unwrap);

/* Wrapper to "mv_yx_in_dir_wrap()", returns 1 if the wrapped function moved
 * "yx" within the wrap borders and the map size, else 0.
 */
static uint8_t mv_yx_in_dir_legal(char dir, struct yx_uint8 * yx);

/* Recalculate angle < 0 or > CIRCLE to a value between these two limits. */
static uint32_t correct_angle(int32_t angle);

/* Try merging the angle between "left_angle" and "right_angle" to "shadow" if
 * it meets the shadow from the right or the left. Returns 1 on success, else 0.
 */
static uint8_t try_merge(struct shadow_angle * shadow,
                         uint32_t left_angle, uint32_t right_angle);

/* Try merging the shadow angle between "left_angle" and "right_angle" into an
 * existing shadow angle in "shadows". On success, see if this leads to any
 * additional shadow angle overlaps and merge these accordingly. Return 1 on
 * success, else 0.
 */
static uint8_t try_merging_angles(uint32_t left_angle, uint32_t right_angle,
                                  struct shadow_angle ** shadows);

/* If "pos_in_map" in angle between"left_angle" to "right_angle" to the viewing
 * actor is in a shadow from the shadow list "shadows", mark it as HIDDEN on the
 * "fov_map"; else, if the world map features a viewing obstacle on the world
 * map, calculate its shadow angle to the viewer and add it to "shadows".
 */
static void set_shadow(uint32_t left_angle, uint32_t right_angle,
                       struct shadow_angle ** shadows, uint16_t pos_in_map,
                       uint8_t * fov_map);

/* Free shadow angles list "angles". */
static void free_angles(struct shadow_angle * angles);

/* Evaluate map position "test_pos" in distance "dist" to the view origin, and
 * on the circle of that distance to the origin on hex "hex_i" (as counted from
 * the circle's rightmost point), for setting shaded cells in "fov_map" and
 * potentially adding a new shadow to linked shadow angle list "shadows".
 */
static void eval_position(uint16_t dist, uint16_t hex_i, uint8_t * fov_map,
                          struct yx_uint8 * test_pos,
                          struct shadow_angle ** shadows);



static void mv_yx_in_hex_dir(char d, struct yx_uint8 * yx)
{
    if     (d == 'e')
    {
        yx->x = yx->x + (yx->y % 2);
        yx->y--;
    }
    else if (d == 'd')
    {
        yx->x++;
    }
    else if (d == 'c')
    {
        yx->x = yx->x + (yx->y % 2);
        yx->y++;
    }
    else if (d == 'x')
    {
        yx->x = yx->x - !(yx->y % 2);
        yx->y++;
    }
    else if (d == 's')
    {
        yx->x--;
    }
    else if (d == 'w')
    {
        yx->x = yx->x - !(yx->y % 2);
        yx->y--;
    }
}



static uint8_t mv_yx_in_dir_wrap(char d, struct yx_uint8 * yx, uint8_t unwrap)
{
    static int8_t wrap_west_east   = 0;
    static int8_t wrap_north_south = 0;
    if (unwrap)
    {
        wrap_west_east = wrap_north_south = 0;
        return 0;
    }
    struct yx_uint8 original;
    original.y = yx->y;
    original.x = yx->x;
    mv_yx_in_hex_dir(d, yx);
    if      (strchr("edc", d) && yx->x < original.x)
    {
        wrap_west_east++;
    }
    else if (strchr("xsw", d) && yx->x > original.x)
    {
        wrap_west_east--;
    }
    if      (strchr("we", d) && yx->y > original.y)
    {
        wrap_north_south--;
    }
    else if (strchr("xc", d) && yx->y < original.y)
    {
        wrap_north_south++;
    }
    return (wrap_west_east != 0) + (wrap_north_south != 0);
}



static uint8_t mv_yx_in_dir_legal(char dir, struct yx_uint8 * yx)
{
    uint8_t wraptest = mv_yx_in_dir_wrap(dir, yx, 0);
    if (!wraptest && yx->x < world.map.length && yx->y < world.map.length)
    {
        return 1;
    }
    return 0;
}



static uint32_t correct_angle(int32_t angle)
{
    while (angle < 0)
    {
        angle = angle + CIRCLE;
    }
    while (angle > CIRCLE)
    {
        angle = angle - CIRCLE;
    }
    return angle;
}



static uint8_t try_merge(struct shadow_angle * shadow,
                         uint32_t left_angle, uint32_t right_angle)
{
    if      (   shadow->right_angle <= left_angle + 1
             && shadow->right_angle >= right_angle)
    {
        shadow->right_angle = right_angle;
    }
    else if (   shadow->left_angle + 1 >= right_angle
             && shadow->left_angle     <= left_angle)
    {
        shadow->left_angle = left_angle;
    }
    else
    {
        return 0;
    }
    return 1;
}



static uint8_t try_merging_angles(uint32_t left_angle, uint32_t right_angle,
                                  struct shadow_angle ** shadows)
{
    uint8_t angle_merge = 0;
    struct shadow_angle * shadow;
    for (shadow = *shadows; shadow; shadow = shadow->next)
    {
        if (try_merge(shadow, left_angle, right_angle))
        {
            angle_merge = 1;
        }
    }
    if (angle_merge)
    {
        struct shadow_angle * shadow1;
        for (shadow1 = *shadows; shadow1; shadow1 = shadow1->next)
        {
            struct shadow_angle * last_shadow = NULL;
            struct shadow_angle * shadow2;
            for (shadow2 = *shadows; shadow2; shadow2 = shadow2->next)
            {
                if (   shadow1 != shadow2
                    && try_merge(shadow1, shadow2->left_angle,
                                          shadow2->right_angle))
                {
                    struct shadow_angle * to_free = shadow2;
                    if (last_shadow)
                    {
                        last_shadow->next = shadow2->next;
                        shadow2 = last_shadow;
                    }
                    else
                    {
                        *shadows = shadow2->next;
                        shadow2 = *shadows;
                    }
                    free(to_free);
                }
                last_shadow = shadow2;
            }
        }
    }
    return angle_merge;
}



static void set_shadow(uint32_t left_angle, uint32_t right_angle,
                       struct shadow_angle ** shadows, uint16_t pos_in_map,
                       uint8_t * fov_map)
{
    char * f_name = "set_shadow()";
    struct shadow_angle * shadow_i;
    if (fov_map[pos_in_map] & VISIBLE)
    {
        for (shadow_i = *shadows; shadow_i; shadow_i = shadow_i->next)
        {
            if (   left_angle <=  shadow_i->left_angle
                && right_angle >= shadow_i->right_angle)
            {
                fov_map[pos_in_map] = HIDDEN;
                return;
            }
        }
    }
    if ('X' == world.map.cells[pos_in_map])
    {
        if (!try_merging_angles(left_angle, right_angle, shadows))
        {
            struct shadow_angle * shadow;
            shadow = try_malloc(sizeof(struct shadow_angle), f_name);
            shadow->left_angle  = left_angle;
            shadow->right_angle = right_angle;
            shadow->next = NULL;
            if (*shadows)
            {
                for (shadow_i = *shadows; shadow_i; shadow_i = shadow_i->next)
                {
                    if (!shadow_i->next)
                    {
                        shadow_i->next = shadow;
                        return;
                    }
                }
            }
            *shadows = shadow;
        }
    }
}



static void free_angles(struct shadow_angle * angles)
{
    if (angles->next)
    {
        free_angles(angles->next);
    }
    free(angles);
}



static void eval_position(uint16_t dist, uint16_t hex_i, uint8_t * fov_map,
                          struct yx_uint8 * test_pos,
                          struct shadow_angle ** shadows)
{
    int32_t left_angle_uncorrected =   ((CIRCLE / 12) / dist)
                                     - ((hex_i * (CIRCLE / 6)) / dist);
    int32_t right_angle_uncorrected =   left_angle_uncorrected
                                      - (CIRCLE / (6 * dist));
    uint32_t left_angle  = correct_angle(left_angle_uncorrected);
    uint32_t right_angle = correct_angle(right_angle_uncorrected);
    uint32_t right_angle_1st = right_angle > left_angle ? 0 : right_angle;
    uint16_t pos_in_map = yx_to_map_pos(test_pos);
    set_shadow(left_angle, right_angle_1st, shadows, pos_in_map, fov_map);
    if (right_angle_1st != right_angle)
    {
        left_angle = CIRCLE;
        set_shadow(left_angle, right_angle, shadows, pos_in_map, fov_map);
    }
}



extern uint8_t * build_fov_map(struct Thing * eye)
{
    char * f_name = "build_fov_map()";
    uint32_t map_size = world.map.length * world.map.length;
    uint8_t * fov_map = try_malloc(map_size, f_name);
    memset(fov_map, VISIBLE, map_size);
    struct yx_uint8 test_pos = eye->pos;
    struct shadow_angle * shadows = NULL;
    char * circle_dirs = "xswedc";
    uint16_t dist;
    uint8_t first_round, circle_on_map;
    for (first_round = 1, dist = 1, circle_on_map = 1; circle_on_map; dist++)
    {
        if (!first_round)
        {
            mv_yx_in_dir_legal('c', &test_pos);
        }
        char dir = 'd';
        uint8_t i_dir = first_round = circle_on_map = 0;
        uint16_t i_dist, hex_i;
        for (hex_i = 0, i_dist = 1; hex_i < 6 * dist; i_dist++, hex_i++)
        {
            if (mv_yx_in_dir_legal(dir, &test_pos))
            {
                eval_position(dist, hex_i, fov_map, &test_pos, &shadows);
                circle_on_map = 1;
            }
            dir = circle_dirs[i_dir];
            if (dist == i_dist)
            {
                i_dist = 0;
                i_dir++;
            }
        }
    }
    mv_yx_in_dir_wrap(0, NULL, 1);
    free_angles(shadows);
    return fov_map;
}