second-movement/watch-faces/complication/tarot_face.c

/*
 * MIT License
 *
 * Copyright (c) 2022 Jeremy O'Brien
 * Base code copied from Spencer Bywater's probability face
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

// Emulator only: need time() to seed the random number generator.
#if __EMSCRIPTEN__
#include <time.h>
#endif

#include <stdlib.h>

#include <string.h>
#include "tarot_face.h"

uint32_t arc4random_uniform(uint32_t upper_bound);

#define TAROT_ANIMATION_TICK_FREQUENCY 8
#define FLIPPED_BIT_POS 7
#define FLIPPED_MASK ((uint8_t)(1 << FLIPPED_BIT_POS))


// --------------
// Custom methods
// --------------

static char fallback_major_arcana[][7] = {
    " FOOL ",
    "Mgcian",
    "HPrsts",
    "En&prs", // Empress
    "En&por", // Emperor
    "Hiroph",
    "Lovers",
    "Chriot",
    "Strgth",
    "Hrn&it", // Hermit
    " Frtun",
    "Justce",
    "Hangn&", // Hangman
    " death",
    " tmprn",
    " devil",
    " Tower",
    "  Star",
    "n&OON ", // Moon
    "  Sun ",
    "Jdgmnt",
    " World",
};
#define NUM_MAJOR_ARCANA (sizeof(fallback_major_arcana) / sizeof(*fallback_major_arcana))

static char custom_major_arcana[][7] = {
    "Fool  ",
    "Mgcian",
    "HPrsts",
    "Empres",
    "Empror",
    "Hiroph",
    "Lovers",
    "Chriot",
    "Strgth",
    "Hermit",
    "Fortun",
    "Justce",
    "Hangmn",
    " death",
    "Tmprnc",
    " devil",
    " Tower",
    "Star  ",
    "  Moon",
    " Sun  ",
    "Jdgmnt",
    " World",
};

static char suits[][7] = {
    " wands",
    "  cups",
    "swords",
    " coins",
};

#define NUM_MINOR_ARCANA 56
#define NUM_CARDS_PER_SUIT 14

#define NUM_TAROT_CARDS (NUM_MAJOR_ARCANA + NUM_MINOR_ARCANA)

static void init_deck(tarot_state_t *state) {
    memset(state->drawn_cards, 0xff, sizeof(state->drawn_cards));
    state->current_card = 0;
}

static void tarot_display(tarot_state_t *state) {
    char smallbuf[4];
    char *start_end_string;
    char *fallback_start_end_string;
    uint8_t card;
    bool flipped;

    // deck is initialized; show current draw mode and return
    if (state->drawn_cards[0] == 0xff) {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
        } else {
            watch_clear_indicator(WATCH_INDICATOR_ARROWS);
        }
        watch_display_text_with_fallback(WATCH_POSITION_TOP_LEFT, "Tar", "TA");
        sprintf(smallbuf, "%2d", state->num_cards_to_draw);
        watch_display_text(WATCH_POSITION_TOP_RIGHT, smallbuf);

        if (state->major_arcana_only) {
            watch_display_text_with_fallback(WATCH_POSITION_BOTTOM, " Major", "n&ajor");
        } else {
            watch_display_text(WATCH_POSITION_BOTTOM, "   All");
        }
        return;
    }

    // show a special status if we're looking at the first or last card in the spread
    if (state->current_card == 0) {
        start_end_string = "Str";
        fallback_start_end_string = "St";
    } else if (state->current_card == state->num_cards_to_draw - 1) {
        start_end_string = "End";
        fallback_start_end_string = "En";
    } else {
        start_end_string = "   ";
        fallback_start_end_string = "  ";
    }

    // figure out the card we're showing
    card = state->drawn_cards[state->current_card];
    flipped = (card & FLIPPED_MASK) ? true : false; // check flipped bit
    card &= ~FLIPPED_MASK; // remove the flipped bit
    watch_display_text_with_fallback(WATCH_POSITION_TOP, start_end_string, fallback_start_end_string);
    if (card < NUM_MAJOR_ARCANA) {
        // major arcana

        // show no rank, card name
        watch_display_text(WATCH_POSITION_TOP_RIGHT, "  ");
        watch_display_text_with_fallback(WATCH_POSITION_BOTTOM, custom_major_arcana[card], fallback_major_arcana[card]);
    } else {
        // minor arcana
        uint8_t suit = (card - NUM_MAJOR_ARCANA) / NUM_CARDS_PER_SUIT;
        uint8_t rank = ((card - NUM_MAJOR_ARCANA) % NUM_CARDS_PER_SUIT) + 1;

        // show start/end, rank + suit
        sprintf(smallbuf, "%2d", rank);
        watch_display_text(WATCH_POSITION_TOP_RIGHT, smallbuf);
        watch_display_text(WATCH_POSITION_BOTTOM, suits[suit]);
    }

    if (flipped) {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_set_indicator(WATCH_INDICATOR_SIGNAL);
        } else {
            watch_set_indicator(WATCH_INDICATOR_ARROWS);
        }
    } else {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
        } else {
            watch_clear_indicator(WATCH_INDICATOR_ARROWS);
        }
    }
}

static uint8_t get_rand_num(uint8_t num_values) {
    // Emulator: use rand. Hardware: use arc4random.
#if __EMSCRIPTEN__
    return rand() % num_values;
#else
    return arc4random_uniform(num_values);
#endif
}

static uint8_t draw_one_card(tarot_state_t *state) {
    if (state->major_arcana_only) {
        return get_rand_num(NUM_MAJOR_ARCANA);
    } else {
        return get_rand_num(NUM_TAROT_CARDS);
    }
}

static bool already_drawn(tarot_state_t *state, uint8_t drawn_card) {
    for (int i = 0; state->drawn_cards[i] != 0xff && i < state->num_cards_to_draw; i++) {
        if ((state->drawn_cards[i] & ~FLIPPED_MASK) == drawn_card) {
            return true;
        }
    }

    return false;
}

static void pick_cards(tarot_state_t *state) {
    uint8_t card;

    for (int i = 0; i < state->num_cards_to_draw; i++) {
        card = draw_one_card(state);
        while (already_drawn(state, card)) {
            card = draw_one_card(state);
        }
        card |= get_rand_num(2) << FLIPPED_BIT_POS; // randomly flip the card
        state->drawn_cards[i] = card;
    }
}

static void display_animation(tarot_state_t *state) {
    watch_display_text(WATCH_POSITION_SECONDS, "  ");

    if (state->animation_frame == 0) {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_set_pixel(1, 4); // 9F
            watch_set_pixel(1, 6); // 9C
        } else {
            watch_set_pixel(2, 6); // 9F
            watch_set_pixel(2, 7); // 9C
        }
        state->animation_frame = 1;
    } else if (state->animation_frame == 1) {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_clear_pixel(1, 4); // 9F
            watch_clear_pixel(1, 6); // 9C
            watch_set_pixel(2, 4); // 9A
            watch_set_pixel(0, 6); // 9D
        } else {
            watch_clear_pixel(2, 6); // 9F
            watch_clear_pixel(2, 7); // 9C
            watch_set_pixel(3, 6); // 9A
            watch_set_pixel(0, 7); // 9D
        }
        state->animation_frame = 2;
    } else if (state->animation_frame == 2) {
        if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
            watch_clear_pixel(2, 4); // 9A
            watch_clear_pixel(0, 6); // 9D
            watch_set_pixel(2, 5); // 9B
            watch_set_pixel(0, 5); // 9E
        } else {
            watch_clear_pixel(3, 6); // 9A
            watch_clear_pixel(0, 6); // 9D
            watch_set_pixel(3, 7); // 9B
            watch_set_pixel(0, 6); // 9E
        }
        state->animation_frame = 3;
    } else if (state->animation_frame == 3) {
        state->animation_frame = 0;
        movement_request_tick_frequency(1);
        state->is_picking = false;
        tarot_display(state);
    }
}


// ---------------------------
// Standard watch face methods
// ---------------------------
void tarot_face_setup(uint8_t watch_face_index, void ** context_ptr) {
    (void) watch_face_index;
    if (*context_ptr == NULL) {
        *context_ptr = malloc(sizeof(tarot_state_t));
        memset(*context_ptr, 0, sizeof(tarot_state_t));
    }
    // Emulator only: Seed random number generator
#if __EMSCRIPTEN__
    srand(time(NULL));
#endif
}

void tarot_face_activate(void *context) {
    tarot_state_t *state = (tarot_state_t *)context;

    watch_display_text_with_fallback(WATCH_POSITION_TOP, "Tarot", "TA");
    init_deck(state);
    state->num_cards_to_draw = 3;
    state->major_arcana_only = true;
}

bool tarot_face_loop(movement_event_t event, void *context) {
    tarot_state_t *state = (tarot_state_t *)context;

    if (state->is_picking && event.event_type != EVENT_TICK) {
        return true;
    }

    switch (event.event_type) {
        case EVENT_ACTIVATE:
            if (watch_sleep_animation_is_running()) watch_stop_sleep_animation();
            tarot_display(state);
            break;
        case EVENT_TICK:
            if (state->is_picking) {
                display_animation(state);
            }
            break;
        case EVENT_LIGHT_BUTTON_UP:
            if (state->drawn_cards[0] == 0xff) {
                // deck is inited; cycle through # cards to draw
                state->num_cards_to_draw++;
                if (state->num_cards_to_draw > 10) {
                    state->num_cards_to_draw = 3;
                }
            } else {
                // cycle through the drawn cards
                state->current_card = (state->current_card + 1) % state->num_cards_to_draw;
            }
            tarot_display(state);
            break;
        case EVENT_LIGHT_LONG_PRESS:
            if (state->drawn_cards[0] == 0xff) {
                // at main screen; cycle major arcana mode
                state->major_arcana_only = !state->major_arcana_only;
            } else {
                // at card view screen; go back to draw screen
                init_deck(state);
            }
            tarot_display(state);
            break;
        case EVENT_ALARM_BUTTON_UP:
            // Draw cards
            watch_display_text(WATCH_POSITION_BOTTOM, "      ");
            if (watch_get_lcd_type() == WATCH_LCD_TYPE_CLASSIC) {
                watch_clear_indicator(WATCH_INDICATOR_SIGNAL);
            } else {
                watch_clear_indicator(WATCH_INDICATOR_ARROWS);
            }
            init_deck(state);
            pick_cards(state);
            // card picking animation begins on next tick and new cards will be displayed on completion
            state->is_picking = true;
            movement_request_tick_frequency(TAROT_ANIMATION_TICK_FREQUENCY);
            break;
        case EVENT_LOW_ENERGY_UPDATE:
            if (!watch_sleep_animation_is_running()) {
                watch_start_sleep_animation(1000);
            }
            break;
        case EVENT_LIGHT_BUTTON_DOWN:
            // don't light up every time light is hit
            break;
        default:
            movement_default_loop_handler(event);
            break;
    }

    return true;
}

void tarot_face_resign(void *context) {
    (void) context;
}