archipelago_rs 2.1.1

use std::sync::LazyLock;
use std::{collections::HashMap, fmt};

use ustr::{Ustr, UstrMap};

use super::{AsItemId, AsLocationId, Item, Location};
use crate::{Error, Iter, ProtocolError, protocol::GameData};

/// The name of the special Archipelago game that's used for well-known
/// locations.
pub(crate) static ARCHIPELAGO_NAME: LazyLock<Ustr> = LazyLock::new(|| Ustr::from("Archipelago"));

/// The well-known Archipelago game.
static ARCHIPELAGO: LazyLock<Game> = LazyLock::new(|| {
    Game::new(
        *ARCHIPELAGO_NAME,
        vec![],
        vec![Location::cheat_console(), Location::server()],
    )
});

/// Information about a single game in an Archipelago multiworld.
///
/// Note that it's possible for a game not to have a data package registered
/// with the server at all. In that case, this will consider all item and
/// location IDs to be valid and will return placeholder names for them.
pub struct Game(GameType);

/// Possible types of game data.
#[allow(clippy::large_enum_variant)]
enum GameType {
    /// A game without a data package. All we know is its name.
    NoDataPackage(Ustr),

    /// A game with a data package. We know all its locations and items as well
    /// as their names.
    DataPackage(DataPackageGame),
}

struct DataPackageGame {
    name: Ustr,

    /// All the items in this game.
    items: Vec<Item>,

    /// All the locations in this game.
    locations: Vec<Location>,

    // These map values are indices into [items].
    items_by_id: HashMap<i64, usize>,
    items_by_name: UstrMap<usize>,

    // These map values are indices into [locations].
    locations_by_id: HashMap<i64, usize>,
    locations_by_name: UstrMap<usize>,
}

impl Game {
    /// Constructs a [Game] directly from known items and locations.
    pub(crate) fn new(name: Ustr, items: Vec<Item>, locations: Vec<Location>) -> Game {
        let mut items_by_id = HashMap::with_capacity(items.len());
        let mut items_by_name = UstrMap::with_capacity_and_hasher(items.len(), Default::default());
        for (i, item) in items.iter().enumerate() {
            items_by_id.insert(item.id(), i);
            items_by_name.insert(item.name(), i);
        }

        let mut locations_by_id = HashMap::with_capacity(locations.len());
        let mut locations_by_name =
            UstrMap::with_capacity_and_hasher(locations.len(), Default::default());
        for (i, location) in locations.iter().enumerate() {
            locations_by_id.insert(location.id(), i);
            locations_by_name.insert(location.name(), i);
        }

        Game(GameType::DataPackage(DataPackageGame {
            name,
            items,
            locations,
            items_by_id,
            items_by_name,
            locations_by_id,
            locations_by_name,
        }))
    }

    /// Creates a game without a data package.
    pub(crate) fn no_data_package(name: Ustr) -> Game {
        Game(GameType::NoDataPackage(name))
    }

    /// Converts the raw network-level game struct into a [Game].
    pub(crate) fn hydrate(name: Ustr, network: GameData) -> Game {
        // TODO: Is it really worth the hassle of supporting indexing by name?
        // Consider dropping that and just storing these as `HashMap<i64, _>`s.
        let mut items = Vec::with_capacity(network.item_name_to_id.len());
        let mut items_by_id = HashMap::with_capacity(network.item_name_to_id.len());
        let mut items_by_name =
            UstrMap::with_capacity_and_hasher(network.item_name_to_id.len(), Default::default());
        for (item_name, id) in network.item_name_to_id {
            items_by_id.insert(id, items.len());
            items_by_name.insert(item_name, items.len());
            items.push(Item::new(id, item_name, name));
        }

        let mut locations = Vec::with_capacity(network.location_name_to_id.len());
        let mut locations_by_id = HashMap::with_capacity(network.location_name_to_id.len());
        let mut locations_by_name = UstrMap::with_capacity_and_hasher(
            network.location_name_to_id.len(),
            Default::default(),
        );
        for (location_name, id) in network.location_name_to_id {
            locations_by_id.insert(id, locations.len());
            // Safety: We own the item and this is immutable after creation.
            locations_by_name.insert(location_name, locations.len());
            locations.push(Location::new(id, location_name, name));
        }

        Game(GameType::DataPackage(DataPackageGame {
            name,
            items,
            locations,
            items_by_id,
            items_by_name,
            locations_by_id,
            locations_by_name,
        }))
    }

    /// The pseudo-game "Archipelago" that's used to represent the location of
    /// items such as those sent by `!getitem`.
    pub fn archipelago() -> &'static Game {
        &ARCHIPELAGO
    }

    /// Returns whether this game has a data package. Games that don't have no
    /// item or location metadata available.
    pub fn has_data_package(&self) -> bool {
        matches!(self.0, GameType::DataPackage(_))
    }

    /// Returns the game's name.
    pub fn name(&self) -> Ustr {
        match &self.0 {
            GameType::NoDataPackage(name) => *name,
            GameType::DataPackage(game) => game.name,
        }
    }

    /// All the items in this game.
    ///
    /// For games without data packages, this is always empty.
    pub fn items(&self) -> impl Iter<Item> {
        match &self.0 {
            GameType::NoDataPackage(_) => Default::default(),
            GameType::DataPackage(game) => game.items.iter().copied(),
        }
    }

    /// All the locations in this game.
    ///
    /// For games without data packages, this is always empty.
    pub fn locations(&self) -> impl Iter<Location> {
        match &self.0 {
            GameType::NoDataPackage(_) => Default::default(),
            GameType::DataPackage(game) => game.locations.iter().copied(),
        }
    }

    /// Whether this game defines an item with the given `id`.
    ///
    /// For games without data packages, this always returns true.
    pub fn has_item(&self, id: impl AsItemId) -> bool {
        match &self.0 {
            GameType::NoDataPackage(_) => true,
            GameType::DataPackage(game) => game.items_by_id.contains_key(&id.as_item_id()),
        }
    }

    /// Returns the item for the given `id` if one is defined in this game.
    pub fn item(&self, id: impl AsItemId) -> Option<Item> {
        let id = id.as_item_id();
        match &self.0 {
            GameType::NoDataPackage(name) => {
                Some(Item::new(id, format!("<item #{}>", id).into(), *name))
            }
            GameType::DataPackage(game) => game.items_by_id.get(&id).map(|i| game.items[*i]),
        }
    }

    /// Returns the item with the given `id` or an [Error] if it can't be found.
    pub(crate) fn item_or_err(&self, id: impl AsItemId) -> Result<Item, Error> {
        let id = id.as_item_id();
        self.item(id).ok_or(
            ProtocolError::MissingItem {
                id,
                game: self.name(),
            }
            .into(),
        )
    }

    /// Returns the item for the given `id`. Panics if there's no item with this
    /// ID.
    pub fn assert_item(&self, id: impl AsItemId) -> Item {
        let id = id.as_item_id();
        self.item(id)
            .unwrap_or_else(|| panic!("{} doesn't contain an item with ID {}", self.name(), id))
    }

    /// Returns the item with the given `name` if one is defined in this game.
    pub fn item_by_name(&self, name: impl Into<Ustr>) -> Option<Item> {
        match &self.0 {
            GameType::NoDataPackage(_) => None,
            GameType::DataPackage(game) => game
                .items_by_name
                // Safety: the key is only used for this call while we own name.
                .get(&name.into())
                .map(|i| game.items[*i]),
        }
    }

    /// Returns the item with the given `name`. Panics if there's no item with
    /// this name.
    pub fn assert_item_by_name(&self, name: impl Into<Ustr>) -> Item {
        let name = name.into();
        self.item_by_name(name)
            .unwrap_or_else(|| panic!("{} doesn't contain an item named \"{}\"", self.name(), name))
    }

    /// Whether this game defines an location with the given `id`.
    ///
    /// For games without data packages, this always returns true.
    pub fn has_location(&self, id: impl AsLocationId) -> bool {
        match &self.0 {
            GameType::NoDataPackage(_) => true,
            GameType::DataPackage(game) => game.locations_by_id.contains_key(&id.as_location_id()),
        }
    }

    /// Returns the location for the given `id` if one is defined in this game.
    pub fn location(&self, id: impl AsLocationId) -> Option<Location> {
        let id = id.as_location_id();
        match &self.0 {
            GameType::NoDataPackage(name) => Some(Location::new(
                id,
                format!("<location #{}>", id).into(),
                *name,
            )),
            GameType::DataPackage(game) => {
                game.locations_by_id.get(&id).map(|i| game.locations[*i])
            }
        }
    }

    /// Returns the location with the given `id` or an [Error] if it can't be found.
    pub(crate) fn location_or_err(&self, id: impl AsLocationId) -> Result<Location, Error> {
        let id = id.as_location_id();
        self.location(id).ok_or(
            ProtocolError::MissingLocation {
                id,
                game: self.name(),
            }
            .into(),
        )
    }

    /// Returns the location for the given `id`. Panics if there's no location with this
    /// ID.
    pub fn assert_location(&self, id: impl AsLocationId) -> Location {
        let id = id.as_location_id();
        self.location(id)
            .unwrap_or_else(|| panic!("{} doesn't contain an location with ID {}", self.name(), id))
    }

    /// Returns the location with the given `name` if one is defined in this game.
    pub fn location_by_name(&self, name: impl Into<Ustr>) -> Option<Location> {
        match &self.0 {
            GameType::NoDataPackage(_) => None,
            GameType::DataPackage(game) => game
                .locations_by_name
                // Safety: the key is only used for this call while we own name.
                .get(&name.into())
                .map(|i| game.locations[*i]),
        }
    }

    /// Returns the location with the given `name`. Panics if there's no location with
    /// this name.
    pub fn assert_location_by_name(&self, name: impl Into<Ustr>) -> Location {
        let name = name.into();
        self.location_by_name(name).unwrap_or_else(|| {
            panic!(
                "{} doesn't contain an location named \"{}\"",
                self.name(),
                name
            )
        })
    }

    /// Returns an [Error] if `id` isn't a location in this game.
    pub(crate) fn verify_location(&self, id: impl AsLocationId) -> Result<(), Error> {
        match &self.0 {
            GameType::NoDataPackage(_) => Ok(()),
            GameType::DataPackage(game) => {
                let id = id.as_location_id();
                game.locations_by_id.get(&id).map(|_| ()).ok_or(
                    ProtocolError::MissingLocation {
                        id,
                        game: game.name,
                    }
                    .into(),
                )
            }
        }
    }
}

impl fmt::Debug for Game {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
        match &self.0 {
            GameType::NoDataPackage(name) => name.fmt(f),
            GameType::DataPackage(game) => write!(
                f,
                "{} ({} items, {} locations)",
                game.name,
                game.items.len(),
                game.locations.len()
            ),
        }
    }
}