#pragma region Copyright (c) 2014-2017 OpenRCT2 Developers
/*****************************************************************************
 * OpenRCT2, an open source clone of Roller Coaster Tycoon 2.
 *
 * OpenRCT2 is the work of many authors, a full list can be found in contributors.md
 * For more information, visit https://github.com/OpenRCT2/OpenRCT2
 *
 * OpenRCT2 is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * A full copy of the GNU General Public License can be found in licence.txt
 *****************************************************************************/
#pragma endregion

#include "../config/Config.h"
#include "../core/Guard.hpp"
#include "../core/Util.hpp"
#include "../Game.h"
#include "../interface/window.h"
#include "../localisation/date.h"
#include "../localisation/localisation.h"
#include "../localisation/string_ids.h"
#include "../ObjectList.h"
#include "../OpenRCT2.h"
#include "../scenario/scenario.h"
#include "../rct1.h"
#include "../ride/ride.h"
#include "../ride/ride_data.h"
#include "../ride/RideGroupManager.h"
#include "../ride/TrackData.h"
#include "../world/scenery.h"
#include "NewsItem.h"
#include "Finance.h"
#include "Research.h"

const sint32 _researchRate[] = {0, 160, 250, 400};

uint8  gResearchFundingLevel;
uint8  gResearchPriorities;
uint16 gResearchProgress;
uint8  gResearchProgressStage;
uint32 gResearchLastItemSubject;
uint8  gResearchExpectedMonth;
uint8  gResearchExpectedDay;
uint8  gResearchNextCategory;
uint32 gResearchNextItem;

// 0x01358844[500]
rct_research_item gResearchItems[MAX_RESEARCH_ITEMS];

// 0x00EE787C
uint8 gResearchUncompletedCategories;

uint32 gResearchedRideTypes[MAX_RESEARCHED_RIDE_TYPES];
uint32 gResearchedRideEntries[MAX_RESEARCHED_RIDE_ENTRIES];
uint32 gResearchedSceneryItems[MAX_RESEARCHED_SCENERY_ITEMS];

bool gSilentResearch = false;

static void ride_type_set_invented(sint32 rideType);

static void ride_entry_set_invented(sint32 rideEntryIndex);

/**
 *
 *  rct2: 0x006671AD, part of 0x00667132
 */
void research_reset_items()
{
    gResearchItems[0].entryIndex = RESEARCHED_ITEMS_SEPARATOR;
    gResearchItems[1].entryIndex = RESEARCHED_ITEMS_END;
    gResearchItems[2].entryIndex = RESEARCHED_ITEMS_END_2;
}

/**
 *
 *  rct2: 0x00684BAE
 */
void research_update_uncompleted_types()
{
    sint32 uncompletedResearchTypes = 0;
    rct_research_item * researchItem = gResearchItems;
    while (researchItem++->entryIndex != RESEARCHED_ITEMS_SEPARATOR);

    for (; researchItem->entryIndex != RESEARCHED_ITEMS_END; researchItem++)
    {
        uncompletedResearchTypes |= (1 << researchItem->category);
    }

    gResearchUncompletedCategories = uncompletedResearchTypes;
}

/**
 *
 *  rct2: 0x00684D2A
 */
static void research_calculate_expected_date()
{
    if (gResearchProgressStage == RESEARCH_STAGE_INITIAL_RESEARCH || gResearchFundingLevel == RESEARCH_FUNDING_NONE)
    {
        gResearchExpectedDay = 255;
    }
    else
    {
        sint32 progressRemaining = gResearchProgressStage == RESEARCH_STAGE_COMPLETING_DESIGN ? 0x10000 : 0x20000;
        progressRemaining -= gResearchProgress;
        sint32 daysRemaining = (progressRemaining / _researchRate[gResearchFundingLevel]) * 128;

        sint32 expectedDay  = gDateMonthTicks + (daysRemaining & 0xFFFF);
        sint32 dayQuotient  = expectedDay / 0x10000;
        sint32 dayRemainder = expectedDay % 0x10000;

        sint32 expectedMonth = date_get_month(gDateMonthsElapsed + dayQuotient + (daysRemaining >> 16));
        expectedDay = (dayRemainder * days_in_month[expectedMonth]) >> 16;

        gResearchExpectedDay   = expectedDay;
        gResearchExpectedMonth = expectedMonth;
    }
}

static void research_invalidate_related_windows()
{
    window_invalidate_by_class(WC_CONSTRUCT_RIDE);
    window_invalidate_by_class(WC_RESEARCH);
}

/**
 *
 *  rct2: 0x00684BE5
 */
static void research_next_design()
{
    rct_research_item * firstUnresearchedItem, * researchItem, tmp;
    sint32 ignoreActiveResearchTypes;

    // Skip already researched items
    firstUnresearchedItem = gResearchItems;
    while (firstUnresearchedItem->entryIndex != RESEARCHED_ITEMS_SEPARATOR)
    {
        firstUnresearchedItem++;
    }

    ignoreActiveResearchTypes = 0;
    researchItem              = firstUnresearchedItem;
    for (;;)
    {
        researchItem++;
        if (researchItem->entryIndex == RESEARCHED_ITEMS_END)
        {
            if (!ignoreActiveResearchTypes)
            {
                ignoreActiveResearchTypes = 1;
                researchItem              = firstUnresearchedItem;
                continue;
            }
            else
            {
                gResearchProgress      = 0;
                gResearchProgressStage = RESEARCH_STAGE_FINISHED_ALL;
                research_invalidate_related_windows();
                // Reset funding to 0 if no more rides.
                research_set_funding(0);
                return;
            }
        }
        else if (ignoreActiveResearchTypes || (gResearchPriorities & (1 << researchItem->category)))
        {
            break;
        }
    }

    gResearchNextItem      = researchItem->entryIndex;
    gResearchNextCategory  = researchItem->category;
    gResearchProgress      = 0;
    gResearchProgressStage = RESEARCH_STAGE_DESIGNING;

    // Bubble research item up until it is above the researched items separator
    do
    {
        tmp = *researchItem;
        *researchItem       = *(researchItem - 1);
        *(researchItem - 1) = tmp;
        researchItem--;
    }
    while ((researchItem + 1)->entryIndex != RESEARCHED_ITEMS_SEPARATOR);

    research_invalidate_related_windows();
}

/**
 *
 *  rct2: 0x006848D4
 */
void research_finish_item(uint32 entryIndex)
{
    gResearchLastItemSubject = entryIndex;
    research_invalidate_related_windows();

    if (entryIndex >= RESEARCH_ENTRY_RIDE_MASK)
    {
        // Ride
        uint32 base_ride_type = research_get_ride_base_type(entryIndex);
        sint32 rideEntryIndex = entryIndex & 0xFF;
        rct_ride_entry * rideEntry = get_ride_entry(rideEntryIndex);

        if (rideEntry != nullptr && base_ride_type != RIDE_TYPE_NULL)
        {
            bool ride_group_was_invented_before = false;
            bool ride_type_was_invented_before  = ride_type_is_invented(base_ride_type);
            rct_string_id availabilityString;

            // Determine if the ride group this entry belongs to was invented before.
            if (RideGroupManager::RideTypeHasRideGroups(base_ride_type))
            {
                const RideGroup * rideGroup = RideGroupManager::GetRideGroup(base_ride_type, rideEntry);

                if (RideGroupManager::RideGroupIsInvented(rideGroup))
                {
                    ride_group_was_invented_before = true;
                }
            }

            ride_type_set_invented(base_ride_type);
            openrct2_assert(base_ride_type < Util::CountOf(RideTypePossibleTrackConfigurations),
                            "Invalid base_ride_type = %d", base_ride_type);

            ride_entry_set_invented(rideEntryIndex);

            if (!(rideEntry->flags & RIDE_ENTRY_FLAG_SEPARATE_RIDE))
            {
                for (sint32 i = 0; i < MAX_RESEARCHED_TRACK_TYPES; i++)
                {
                    rct_ride_entry * rideEntry2 = get_ride_entry(i);
                    if (rideEntry2 == nullptr)
                    {
                        continue;
                    }
                    if ((rideEntry2->flags & RIDE_ENTRY_FLAG_SEPARATE_RIDE))
                    {
                        continue;
                    }

                    for (auto rideType : rideEntry2->ride_type)
                    {
                        if (rideType == base_ride_type)
                        {
                            ride_entry_set_invented(i);
                            break;
                        }
                    }
                }
            }


            // If a vehicle should be listed separately (maze, mini golf, flat rides, shops)
            if (RideGroupManager::RideTypeIsIndependent(base_ride_type))
            {
                availabilityString = STR_NEWS_ITEM_RESEARCH_NEW_RIDE_AVAILABLE;
                set_format_arg(0, rct_string_id, rideEntry->naming.name);
            }
            // If a vehicle is the first to be invented for its ride group, show the ride group name.
            else if (!ride_type_was_invented_before ||
                     (ride_type_has_ride_groups(base_ride_type) && !ride_group_was_invented_before))
            {
                rct_ride_name naming = get_ride_naming(base_ride_type, rideEntry);
                availabilityString = STR_NEWS_ITEM_RESEARCH_NEW_RIDE_AVAILABLE;
                set_format_arg(0, rct_string_id, naming.name);
            }
            // If the vehicle should not be listed separately and it isn't the first to be invented for its ride group,
            // report it as a new vehicle for the existing ride group.
            else
            {
                availabilityString = STR_NEWS_ITEM_RESEARCH_NEW_VEHICLE_AVAILABLE;
                rct_ride_name baseRideNaming = get_ride_naming(base_ride_type, rideEntry);

                set_format_arg(0, rct_string_id, baseRideNaming.name);
                set_format_arg(2, rct_string_id, rideEntry->naming.name);
            }

            if (!gSilentResearch)
            {
                if (gConfigNotifications.ride_researched)
                {
                    news_item_add_to_queue(NEWS_ITEM_RESEARCH, availabilityString, entryIndex);
                }
            }

            research_invalidate_related_windows();
        }
    }
    else
    {
        // Scenery
        rct_scenery_group_entry * sceneryGroupEntry = get_scenery_group_entry(entryIndex & 0xFFFF);
        if (sceneryGroupEntry != nullptr)
        {
            for (sint32 i = 0; i < sceneryGroupEntry->entry_count; i++)
            {
                sint32 subSceneryEntryIndex = sceneryGroupEntry->scenery_entries[i];
                gResearchedSceneryItems[subSceneryEntryIndex >> 5] |= 1UL << (subSceneryEntryIndex & 0x1F);
            }

            set_format_arg(0, rct_string_id, sceneryGroupEntry->name);

            if (!gSilentResearch)
            {
                if (gConfigNotifications.ride_researched)
                {
                    news_item_add_to_queue(NEWS_ITEM_RESEARCH, STR_NEWS_ITEM_RESEARCH_NEW_SCENERY_SET_AVAILABLE, entryIndex);
                }
            }

            research_invalidate_related_windows();
            init_scenery();
        }
    }
}

/**
 *
 *  rct2: 0x00684C7A
 */
void research_update()
{
    sint32 editorScreenFlags, researchLevel, currentResearchProgress;

    editorScreenFlags = SCREEN_FLAGS_SCENARIO_EDITOR | SCREEN_FLAGS_TRACK_DESIGNER | SCREEN_FLAGS_TRACK_MANAGER;
    if (gScreenFlags & editorScreenFlags)
    {
        return;
    }

    if (gScenarioTicks % 32 != 0)
    {
        return;
    }

    researchLevel = gResearchFundingLevel;

    currentResearchProgress = gResearchProgress;
    currentResearchProgress += _researchRate[researchLevel];
    if (currentResearchProgress <= 0xFFFF)
    {
        gResearchProgress = currentResearchProgress;
    }
    else
    {
        switch (gResearchProgressStage)
        {
        case RESEARCH_STAGE_INITIAL_RESEARCH:
            research_next_design();
            research_calculate_expected_date();
            break;
        case RESEARCH_STAGE_DESIGNING:
            gResearchProgress      = 0;
            gResearchProgressStage = RESEARCH_STAGE_COMPLETING_DESIGN;
            research_calculate_expected_date();
            research_invalidate_related_windows();
            break;
        case RESEARCH_STAGE_COMPLETING_DESIGN:
            research_finish_item(gResearchNextItem);
            gResearchProgress      = 0;
            gResearchProgressStage = 0;
            research_calculate_expected_date();
            research_update_uncompleted_types();
            research_invalidate_related_windows();
            break;
        }
    }
}

/**
 *
 *  rct2: 0x00684AC3
 */
void research_reset_current_item()
{
    rct_research_item * research = gResearchItems;
    for (; research->entryIndex != RESEARCHED_ITEMS_END; research++) { }

    research++;
    for (; research->entryIndex != RESEARCHED_ITEMS_END_2; research += 2)
    {
        if (scenario_rand() & 1)
        {
            continue;
        }

        rct_research_item * edx            = nullptr;
        rct_research_item * ebp            = nullptr;
        rct_research_item * inner_research = gResearchItems;
        do
        {
            if (research->entryIndex == inner_research->entryIndex)
            {
                edx = inner_research;
            }
            if ((research + 1)->entryIndex == inner_research->entryIndex)
            {
                ebp = inner_research;
            }
        }
        while ((inner_research++)->entryIndex != RESEARCHED_ITEMS_END);
        assert(edx != nullptr);
        edx->entryIndex = research->entryIndex;
        assert(ebp != nullptr);
        ebp->entryIndex = (research + 1)->entryIndex;

        uint8 cat = edx->category;
        edx->category = ebp->category;
        ebp->category = cat;
    }

    for (auto &researchedRideType : gResearchedRideTypes)
    {
        researchedRideType = 0;
    }

    for (auto &researchedRideEntry : gResearchedRideEntries)
    {
        researchedRideEntry = 0;
    }

    for (auto &researchedSceneryItem : gResearchedSceneryItems)
    {
        researchedSceneryItem = 0xFFFFFFFF;
    }

    for (sint32 i = 0; i < MAX_SCENERY_GROUP_OBJECTS; ++i)
    {
        rct_scenery_group_entry * scenery_set = get_scenery_group_entry(i);
        if (scenery_set == nullptr)
        {
            continue;
        }

        for (sint32 j = 0; j < scenery_set->entry_count; ++j)
        {
            uint8 value = scenery_set->scenery_entries[j] & 0x1F;
            gResearchedSceneryItems[scenery_set->scenery_entries[j] >> 5] &= ~(1UL << value);
        }
    }


    for (research = gResearchItems; research->entryIndex != RESEARCHED_ITEMS_SEPARATOR; research++)
    {
        research_finish_item(research->entryIndex);
    }

    gResearchLastItemSubject = (uint32) -1;
    gResearchProgressStage   = 0;
    gResearchProgress        = 0;
}

/**
 *
 *  rct2: 0x0068585B
 */
void research_remove_non_separate_vehicle_types()
{
    rct_research_item * researchItem, * researchItem2;

    researchItem = gResearchItems;
    while ((researchItem + 1)->entryIndex != RESEARCHED_ITEMS_END)
    {
        researchItem++;
    }

    do
    {
    loopBeginning:
        if (
            researchItem != gResearchItems &&
            researchItem->entryIndex != RESEARCHED_ITEMS_SEPARATOR &&
            researchItem->entryIndex != RESEARCHED_ITEMS_END &&
            researchItem->entryIndex >= RESEARCH_ENTRY_RIDE_MASK
            )
        {
            rct_ride_entry * rideEntry = get_ride_entry(researchItem->entryIndex & 0xFF);
            if (!(rideEntry->flags & (RIDE_ENTRY_FLAG_SEPARATE_RIDE)))
            {
                // Check if ride type already exists further up for a vehicle type that isn't displayed as a ride
                researchItem2 = researchItem - 1;
                do
                {
                    if (
                        researchItem2->entryIndex != RESEARCHED_ITEMS_SEPARATOR &&
                        researchItem2->entryIndex >= RESEARCH_ENTRY_RIDE_MASK
                        )
                    {
                        rideEntry = get_ride_entry(researchItem2->entryIndex & 0xFF);
                        if (!(rideEntry->flags & (RIDE_ENTRY_FLAG_SEPARATE_RIDE)))
                        {

                            if (research_get_ride_base_type(researchItem->entryIndex) ==
                                research_get_ride_base_type(researchItem2->entryIndex))
                            {
                                // Remove item
                                researchItem2 = researchItem;
                                do
                                {
                                    *researchItem2 = *(researchItem2 + 1);
                                }
                                while ((researchItem2++)->entryIndex != RESEARCHED_ITEMS_END_2);
                                goto loopBeginning;
                            }
                        }
                    }
                }
                while ((researchItem2--) != gResearchItems);
            }
        }
    }
    while ((researchItem--) != gResearchItems);
}

/**
 *
 *  rct2: 0x006857FA
 */
static void research_insert_unresearched(sint32 entryIndex, sint32 category)
{
    rct_research_item * researchItem, * researchItem2;

    researchItem = gResearchItems;
    do
    {
        if (researchItem->entryIndex == RESEARCHED_ITEMS_END)
        {
            // Insert slot
            researchItem2 = researchItem;
            while (researchItem2->entryIndex != RESEARCHED_ITEMS_END_2)
            {
                researchItem2++;
            }
            memmove(researchItem + 1, researchItem, (researchItem2 - researchItem + 1) * sizeof(rct_research_item));

            // Place new item
            researchItem->entryIndex = entryIndex;
            researchItem->category   = category;
            break;
        }
    }
    while (entryIndex != (researchItem++)->entryIndex);
}

/**
 *
 *  rct2: 0x00685826
 */
static void research_insert_researched(sint32 entryIndex, sint32 category)
{
    rct_research_item * researchItem, * researchItem2;

    researchItem = gResearchItems;
    // First check to make sure that entry is not already accounted for
    for (; researchItem->entryIndex != RESEARCHED_ITEMS_END; researchItem++)
    {
        if (researchItem->entryIndex == entryIndex)
        {
            return;
        }
    }
    researchItem = gResearchItems;
    do
    {
        if (researchItem->entryIndex == RESEARCHED_ITEMS_SEPARATOR)
        {
            // Insert slot
            researchItem2 = researchItem;
            while (researchItem2->entryIndex != RESEARCHED_ITEMS_END_2)
            {
                researchItem2++;
            }
            memmove(researchItem + 1, researchItem, (researchItem2 - researchItem + 1) * sizeof(rct_research_item));

            // Place new item
            researchItem->entryIndex = entryIndex;
            researchItem->category   = category;
            break;
        }
    }
    while (entryIndex != (researchItem++)->entryIndex);
}

/**
 *
 *  rct2: 0x006857CF
 */
void research_remove(sint32 entryIndex)
{
    for (rct_research_item * researchItem = gResearchItems;
         researchItem->entryIndex != RESEARCHED_ITEMS_END; researchItem++)
    {
        if (researchItem->entryIndex == entryIndex)
        {
            do
            {
                *researchItem = *(researchItem + 1);
            }
            while (researchItem++->entryIndex != RESEARCHED_ITEMS_END_2);
            return;
        }
    }
}

void research_insert(sint32 researched, sint32 entryIndex, sint32 category)
{
    if (researched)
    {
        research_insert_researched(entryIndex, category);
    }
    else
    {
        research_insert_unresearched(entryIndex, category);
    }
}

/**
 *
 *  rct2: 0x00685675
 */
void research_populate_list_random()
{
    // Rides
    for (sint32 i = 0; i < MAX_RIDE_OBJECTS; i++)
    {
        rct_ride_entry * rideEntry = get_ride_entry(i);
        if (rideEntry == nullptr)
        {
            continue;
        }

        sint32 researched = (scenario_rand() & 0xFF) > 128;
        for (auto rideType : rideEntry->ride_type)
        {
            if (rideType != RIDE_TYPE_NULL)
            {
                research_insert(researched, RESEARCH_ENTRY_RIDE_MASK | (rideType << 8) | i, rideEntry->category[0]);
            }
        }
    }

    // Scenery
    for (sint32 i = 0; i < MAX_SCENERY_GROUP_OBJECTS; i++)
    {
        rct_scenery_group_entry * sceneryGroupEntry = get_scenery_group_entry(i);
        if (sceneryGroupEntry == nullptr)
        {
            continue;
        }

        sint32 researched = (scenario_rand() & 0xFF) > 85;
        research_insert(researched, i, RESEARCH_CATEGORY_SCENERYSET);
    }
}

void research_populate_list_researched()
{
    // Rides
    for (sint32 i = 0; i < MAX_RIDE_OBJECTS; i++)
    {
        rct_ride_entry * rideEntry = get_ride_entry(i);
        if (rideEntry == nullptr)
        {
            continue;
        }

        for (auto rideType : rideEntry->ride_type)
        {
            if (rideType != RIDE_TYPE_NULL)
            {
                research_insert(true, RESEARCH_ENTRY_RIDE_MASK | (rideType << 8) | i, rideEntry->category[0]);
            }
        }
    }

    // Scenery
    for (sint32 i = 0; i < MAX_SCENERY_GROUP_OBJECTS; i++)
    {
        rct_scenery_group_entry * sceneryGroupEntry = get_scenery_group_entry(i);
        if (sceneryGroupEntry == nullptr)
        {
            continue;
        }

        research_insert(true, i, RESEARCH_CATEGORY_SCENERYSET);
    }
}

void research_set_funding(sint32 amount)
{
    game_do_command(0, GAME_COMMAND_FLAG_APPLY, 0, amount, GAME_COMMAND_SET_RESEARCH_FUNDING, 0, 0);

}

void research_set_priority(sint32 activeCategories)
{
    game_do_command(0, (1 << 8) | GAME_COMMAND_FLAG_APPLY, 0, activeCategories, GAME_COMMAND_SET_RESEARCH_FUNDING, 0, 0);
}

/**
 *
 *  rct2: 0x00684A7F
 */
void game_command_set_research_funding(sint32 * eax, sint32 * ebx, sint32 * ecx, sint32 * edx, sint32 * esi, sint32 * edi, sint32 * ebp)
{
    sint32 setPriorities    = (*ebx & (1 << 8)) != 0;
    uint32 fundingAmount    = *edx;
    sint32 activeCategories = *edx;

    gCommandExpenditureType = RCT_EXPENDITURE_TYPE_RESEARCH;
    if (*ebx & GAME_COMMAND_FLAG_APPLY)
    {
        if (!setPriorities)
        {
            if (fundingAmount >= Util::CountOf(_researchRate))
            {
                *ebx = MONEY32_UNDEFINED;
                log_warning("Invalid research rate %d", fundingAmount);
                return;
            }
            gResearchFundingLevel = fundingAmount;
        }
        else
        {
            gResearchPriorities = activeCategories;
        }

        window_invalidate_by_class(WC_FINANCES);
        window_invalidate_by_class(WC_RESEARCH);
    }

    *ebx = 0;
}

void research_insert_ride_entry(uint8 entryIndex, bool researched)
{
    rct_ride_entry * rideEntry = get_ride_entry(entryIndex);
    uint8 category = rideEntry->category[0];
    for (auto rideType : rideEntry->ride_type)
    {
        if (rideType != RIDE_TYPE_NULL)
        {
            research_insert(researched, RESEARCH_ENTRY_RIDE_MASK | (rideType << 8) | entryIndex, category);
        }
    }
}

void research_insert_scenery_group_entry(uint8 entryIndex, bool researched)
{
    research_insert(researched, entryIndex, RESEARCH_CATEGORY_SCENERYSET);
}

bool ride_type_is_invented(sint32 rideType)
{
    sint32 quadIndex = rideType >> 5;
    sint32 bitIndex  = rideType & 0x1F;
    bool   invented  = (gResearchedRideTypes[quadIndex] & ((uint32) 1 << bitIndex));
    return invented;
}

bool ride_entry_is_invented(sint32 rideEntryIndex)
{
    sint32 quadIndex = rideEntryIndex >> 5;
    sint32 bitIndex  = rideEntryIndex & 0x1F;
    bool   invented  = (gResearchedRideEntries[quadIndex] & ((uint32) 1 << bitIndex));
    return invented;
}

bool track_piece_is_available_for_ride_type(uint8 rideType, sint32 trackType)
{
    return RideTypePossibleTrackConfigurations[rideType] & (1ULL << trackType);
}

static void ride_type_set_invented(sint32 rideType)
{
    sint32 quadIndex = rideType >> 5;
    sint32 bitIndex  = rideType & 0x1F;
    gResearchedRideTypes[quadIndex] |= (uint32) 1 << bitIndex;
}

static void ride_entry_set_invented(sint32 rideEntryIndex)
{
    sint32 quadIndex = rideEntryIndex >> 5;
    sint32 bitIndex  = rideEntryIndex & 0x1F;
    gResearchedRideEntries[quadIndex] |= (uint32) 1 << bitIndex;
}

bool scenery_is_invented(uint16 sceneryItem)
{
    sint32 quadIndex = sceneryItem >> 5;
    sint32 bitIndex  = sceneryItem & 0x1F;
    bool   invented  = (gResearchedSceneryItems[quadIndex] & ((uint32) 1 << bitIndex));
    return invented;
}

bool scenery_group_is_invented(sint32 sgIndex)
{
    auto invented = false;
    const auto sgEntry = get_scenery_group_entry(sgIndex);
    if (sgEntry != nullptr && sgEntry->entry_count > 0)
    {
        if (gCheatsIgnoreResearchStatus)
        {
            invented = true;
        }
        else
        {
            for (auto i = 0; i < sgEntry->entry_count; i++)
            {
                auto sceneryEntryIndex = sgEntry->scenery_entries[i];
                if (scenery_is_invented(sceneryEntryIndex))
                {
                    invented = true;
                    break;
                }
            }
        }
    }
    return invented;
}

void reset_researched_scenery_items()
{
    for (auto &researchedSceneryItem : gResearchedSceneryItems)
    {
        researchedSceneryItem = 0xFFFFFFFF;
    }
}

void reset_researched_ride_types_and_entries()
{
    // Iteration endpoint used to be 4 for unknown reasons, likely a mistake
    for (auto &researchedRideType : gResearchedRideTypes)
    {
        researchedRideType = 0xFFFFFFFF;
    }

    for (auto &researchedRideEntry : gResearchedRideEntries)
    {
        researchedRideEntry = 0xFFFFFFFF;
    }
}

/**
 *
 *  rct2: 0x0068563D
 */
rct_string_id research_item_get_name(uint32 researchItem)
{
    if (researchItem >= RESEARCH_ENTRY_RIDE_MASK)
    {
        rct_ride_entry * rideEntry = get_ride_entry(researchItem & 0xFF);
        if (rideEntry == nullptr)
        {
            return 0;
        }
        else if (rideEntry->flags & RIDE_ENTRY_FLAG_SEPARATE_RIDE)
        {
            return rideEntry->naming.name;
        }
        else
        {
            uint8 baseRideType = research_get_ride_base_type(researchItem);
            // Makes sure the correct track name is displayed, e.g. Hyper-Twister instead of Steel Twister.
            return research_get_friendly_base_ride_type_name(baseRideType, rideEntry);
        }
    }
    else
    {
        rct_scenery_group_entry * sceneryEntry = get_scenery_group_entry(researchItem & 0xFF);
        if (sceneryEntry == nullptr)
        {
            return 0;
        }
        else
        {
            return sceneryEntry->name;
        }
    }
}

uint8 research_get_ride_base_type(sint32 researchItem)
{
    return (researchItem >> 8) & 0xFF;
}

/**
 * This will return the name of the base ride type or ride group, as seen in the research window.
 */
rct_string_id research_get_friendly_base_ride_type_name(uint8 trackType, rct_ride_entry * rideEntry)
{
    if (RideGroupManager::RideTypeHasRideGroups(trackType))
    {
        const RideGroup * rideGroup = RideGroupManager::GetRideGroup(trackType, rideEntry);
        return rideGroup->Naming.name;
    }
    else
    {
        return RideNaming[trackType].name;
    }
}

/**
 *
 *  rct2: 0x00685A79
 *  Do not use the research list outside of the inventions list window with the flags
 */
void research_remove_flags()
{
    for (rct_research_item * research = gResearchItems; research->entryIndex != RESEARCHED_ITEMS_END_2; research++)
    {
        // Clear the always researched flags.
        if (research->entryIndex > RESEARCHED_ITEMS_SEPARATOR)
        {
            research->entryIndex &= 0x00FFFFFF;
        }
    }
}