// Copyright Two Neutron Stars Incorporated and contributors
// SPDX-License-Identifier: BlueOak-1.0.0

//! Linked-level symbol reader extension trait.
//!
//! This module provides [`LinkedSymboliqueReadExt`], for querying linked-level
//! symbols from `QueryClient`.

use {
  crate::{
    core::{Ident, SymbolPath, Value, Visibility},
    partitions::{linked::LinkedSymbols, records::SymbolEntry, symbols::Symbols},
  },
  laburnum::database::{
    HasPartition, RecordRef,
    query::QueryClient,
    storage::Partitions,
  },
};

/// Extension trait for reading linked-level symbols from partitions.
///
/// Provides typed methods for querying symbols written during the linking
/// stage. Methods query the `LinkedSymbols` index and optionally follow handles
/// to the shared `Symbols` partition.
pub trait LinkedSymboliqueReadExt<P: Partitions> {
  /// Look up a linked symbol by exact sort key.
  fn linked_symbol_at_path<V, I, Path, S>(
    &self,
    sort_key: &Path,
  ) -> Option<SymbolEntry<V, I, Path, S>>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    S: Visibility,
    P::Stores: HasPartition<LinkedSymbols<V, I, Path, S>>;

  /// Query linked symbols with a sort key prefix.
  fn linked_symbols_with_prefix<V, I, Path, S>(
    &self,
    prefix: &Path,
  ) -> Vec<(Path, SymbolEntry<V, I, Path, S>)>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    S: Visibility,
    P::Stores: HasPartition<LinkedSymbols<V, I, Path, S>>;

  /// Follow a symbol entry's handle to retrieve the full symbol shape.
  fn resolve_linked_symbol<V, I, Path, S>(
    &self,
    entry: &SymbolEntry<V, I, Path, S>,
  ) -> Option<RecordRef<'_, Symbols<V, I, Path, S>>>
  where
    V: Value<I> + 'static,
    I: Ident,
    Path: SymbolPath + 'static,
    S: Visibility,
    P::Stores: HasPartition<Symbols<V, I, Path, S>>;
}

impl<P: Partitions> LinkedSymboliqueReadExt<P> for QueryClient<P> {
  fn linked_symbol_at_path<V, I, Path, S>(
    &self,
    sort_key: &Path,
  ) -> Option<SymbolEntry<V, I, Path, S>>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    S: Visibility,
    P::Stores: HasPartition<LinkedSymbols<V, I, Path, S>>,
  {
    self.index_get::<LinkedSymbols<V, I, Path, S>>(sort_key)
  }

  fn linked_symbols_with_prefix<V, I, Path, S>(
    &self,
    prefix: &Path,
  ) -> Vec<(Path, SymbolEntry<V, I, Path, S>)>
  where
    V: Value<I>,
    I: Ident,
    Path: SymbolPath,
    S: Visibility,
    P::Stores: HasPartition<LinkedSymbols<V, I, Path, S>>,
  {
    self.index_range::<LinkedSymbols<V, I, Path, S>>(prefix)
  }

  fn resolve_linked_symbol<V, I, Path, S>(
    &self,
    entry: &SymbolEntry<V, I, Path, S>,
  ) -> Option<RecordRef<'_, Symbols<V, I, Path, S>>>
  where
    V: Value<I> + 'static,
    I: Ident,
    Path: SymbolPath + 'static,
    S: Visibility,
    P::Stores: HasPartition<Symbols<V, I, Path, S>>,
  {
    self.get::<Symbols<V, I, Path, S>>(entry.symbol.content_hash())
  }
}
