dcb/dcb-exe/src/func.rs

//! Executable functions
//!
//! This module stores known functions
//! within the executable, as well as
//! info on them, represented by the [`Func`]
//! type.

// Modules
pub mod table;

// Exports
pub use table::FuncTable;

// Imports
use crate::Pos;
use std::{borrow::Borrow, collections::BTreeMap};

/// A function within the executable
#[derive(Clone, Debug)]
#[derive(serde::Serialize, serde::Deserialize)]
pub struct Func {
	/// Function name
	pub name: String,

	/// Function signature
	#[serde(default)]
	pub signature: String,

	/// Description
	#[serde(default)]
	pub desc: String,

	/// Inline Comments
	#[serde(default)]
	pub inline_comments: BTreeMap<Pos, String>,

	/// Comments
	#[serde(default)]
	pub comments: BTreeMap<Pos, String>,

	/// Labels
	#[serde(default)]
	pub labels: BTreeMap<Pos, String>,

	/// Start position
	pub start_pos: Pos,

	/// End position (non-inclusive)
	pub end_pos: Pos,
}

impl Func {
	/// Checks if this function contains `pos`
	#[must_use]
	pub fn contains(&self, pos: Pos) -> bool {
		(self.start_pos..self.end_pos).contains(&pos)
	}
}

impl Borrow<Pos> for Func {
	fn borrow(&self) -> &Pos {
		&self.start_pos
	}
}

/// Two functions are equal if their start position is the same.
impl PartialEq for Func {
	fn eq(&self, other: &Self) -> bool {
		self.start_pos.eq(&other.start_pos)
	}
}

impl Eq for Func {}


/// Only the start position matters for the order
impl PartialOrd for Func {
	fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
		// Delegate to `eq` since we have a total order.
		Some(self.cmp(other))
	}
}

/// Only the start position matters for the order
impl Ord for Func {
	fn cmp(&self, other: &Self) -> std::cmp::Ordering {
		// Only compare the start position
		self.start_pos.cmp(&other.start_pos)
	}
}