git.delta.rocks / jrsonnet / refs/commits / 761e42906daa

1use std::{2	any::Any,3	fmt::{self, Debug, Display},4	hash::{Hash, Hasher},5	path::{Path, PathBuf},6	rc::Rc,7};89use jrsonnet_gcmodule::{Trace, Tracer};10use jrsonnet_interner::{IBytes, IStr};1112use crate::location::{location_to_offset, offset_to_location, CodeLocation};1314macro_rules! any_ext_methods {15	($T:ident) => {16		fn as_any(&self) -> &dyn Any;17		fn dyn_hash(&self, hasher: &mut dyn Hasher);18		fn dyn_eq(&self, other: &dyn $T) -> bool;19		fn dyn_debug(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result;20	};21}22macro_rules! any_ext_impl {23	($T:ident) => {24		fn as_any(&self) -> &dyn Any {25			self26		}27		fn dyn_hash(&self, mut hasher: &mut dyn Hasher) {28			self.hash(&mut hasher)29		}30		fn dyn_eq(&self, other: &dyn $T) -> bool {31			let Some(other) = other.as_any().downcast_ref::<Self>() else {32				return false;33			};34			let this = <Self as $T>::as_any(self)35				.downcast_ref::<Self>()36				.expect("restricted by impl");37			this == other38		}39		fn dyn_debug(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {40			<Self as std::fmt::Debug>::fmt(self, fmt)41		}42	};43}44macro_rules! any_ext {45	($T:ident) => {46		impl Hash for dyn $T {47			fn hash<H: Hasher>(&self, state: &mut H) {48				self.dyn_hash(state)49			}50		}51		impl PartialEq for dyn $T {52			fn eq(&self, other: &Self) -> bool {53				self.dyn_eq(other)54			}55		}56		impl Eq for dyn $T {}57	};58}59pub trait SourcePathT: Trace + Debug + Display {60	/// This method should be checked by resolver before panicking with bad SourcePath input61	/// if `true` - then resolver may threat this path as default, and default is usally a CWD62	fn is_default(&self) -> bool;63	fn path(&self) -> Option<&Path>;64	any_ext_methods!(SourcePathT);65}66any_ext!(SourcePathT);6768/// Represents location of a file69///70/// Standard CLI only operates using71/// - [`SourceFile`] - for any file72/// - [`SourceDirectory`] - for resolution from CWD73/// - [`SourceVirtual`] - for stdlib/ext-str74/// - [`SourceFifo`] - for /dev/fd/X (This path may appear with `jrsonnet <(command_that_produces_jsonnet)`)75///76/// From all of those, only [`SourceVirtual`] may be constructed manually, any other path kind should be only obtained77/// from assigned `ImportResolver`78/// However, you should always check `is_default` method return, as it will return true for any paths, where default79/// search location is applicable80///81/// Resolver may also return custom implementations of this trait, for example it may return http url in case of remotely loaded files82#[derive(Eq, Debug, Clone)]83pub struct SourcePath(Rc<dyn SourcePathT>);84impl SourcePath {85	pub fn new(inner: impl SourcePathT) -> Self {86		Self(Rc::new(inner))87	}88	pub fn downcast_ref<T: SourcePathT>(&self) -> Option<&T> {89		self.0.as_any().downcast_ref()90	}91	pub fn is_default(&self) -> bool {92		self.0.is_default()93	}94	pub fn path(&self) -> Option<&Path> {95		self.0.path()96	}97}98impl Hash for SourcePath {99	fn hash<H: Hasher>(&self, state: &mut H) {100		self.0.hash(state);101	}102}103impl PartialEq for SourcePath {104	#[allow(clippy::op_ref)]105	fn eq(&self, other: &Self) -> bool {106		&*self.0 == &*other.0107	}108}109impl Trace for SourcePath {110	fn trace(&self, tracer: &mut Tracer) {111		(*self.0).trace(tracer)112	}113114	fn is_type_tracked() -> bool115	where116		Self: Sized,117	{118		true119	}120}121impl Display for SourcePath {122	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {123		write!(f, "{}", self.0)124	}125}126impl Default for SourcePath {127	fn default() -> Self {128		Self(Rc::new(SourceDefault))129	}130}131132#[derive(Trace, Hash, PartialEq, Eq, Debug)]133struct SourceDefault;134impl Display for SourceDefault {135	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {136		write!(f, "<default>")137	}138}139impl SourcePathT for SourceDefault {140	fn is_default(&self) -> bool {141		true142	}143	fn path(&self) -> Option<&Path> {144		None145	}146	any_ext_impl!(SourcePathT);147}148149/// Represents path to the file on the disk150/// Directories shouldn't be put here, as resolution for files differs from resolution for directories:151///152/// When `file` is being resolved from `SourceFile(a/b/c)`, it should be resolved to `SourceFile(a/b/file)`,153/// however if it is being resolved from `SourceDirectory(a/b/c)`, then it should be resolved to `SourceDirectory(a/b/c/file)`154#[derive(Trace, Hash, PartialEq, Eq, Debug)]155pub struct SourceFile(PathBuf);156impl SourceFile {157	pub fn new(path: PathBuf) -> Self {158		Self(path)159	}160	pub fn path(&self) -> &Path {161		&self.0162	}163}164impl Display for SourceFile {165	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {166		write!(f, "{}", self.0.display())167	}168}169impl SourcePathT for SourceFile {170	fn is_default(&self) -> bool {171		false172	}173	fn path(&self) -> Option<&Path> {174		Some(&self.0)175	}176	any_ext_impl!(SourcePathT);177}178179/// Represents path to the directory on the disk180///181/// See also [`SourceFile`]182#[derive(Trace, Hash, PartialEq, Eq, Debug)]183pub struct SourceDirectory(PathBuf);184impl SourceDirectory {185	pub fn new(path: PathBuf) -> Self {186		Self(path)187	}188	pub fn path(&self) -> &Path {189		&self.0190	}191}192impl Display for SourceDirectory {193	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {194		write!(f, "{}", self.0.display())195	}196}197impl SourcePathT for SourceDirectory {198	fn is_default(&self) -> bool {199		false200	}201	fn path(&self) -> Option<&Path> {202		Some(&self.0)203	}204	any_ext_impl!(SourcePathT);205}206207/// Represents virtual file, whose are located in memory, and shouldn't be cached208///209/// It is used for --ext-code=.../--tla-code=.../standard library source code by default,210/// and user can construct arbitrary values by hand, without asking import resolver211#[derive(Trace, Hash, PartialEq, Eq, Debug, Clone)]212pub struct SourceVirtual(pub IStr);213impl Display for SourceVirtual {214	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {215		write!(f, "{}", self.0)216	}217}218impl SourcePathT for SourceVirtual {219	fn is_default(&self) -> bool {220		true221	}222	fn path(&self) -> Option<&Path> {223		None224	}225	any_ext_impl!(SourcePathT);226}227228/// Represents resolved FIFO file, those files may only be read once, and this type is only used for229/// unix, where user might want to do `jrsonnet <(command_that_produces_jsonnet_source)`230/// In most cases, user most probably want to use `jrsonnet -` instead of `jrsonnet /dev/stdin`231/// for better cross-platform support.232// PartialEq is limited to ptr equality233#[allow(clippy::derived_hash_with_manual_eq)]234#[derive(Trace, Debug, Hash)]235pub struct SourceFifo(pub String, pub IBytes);236impl PartialEq for SourceFifo {237	fn eq(&self, other: &Self) -> bool {238		std::ptr::eq(self, other)239	}240}241impl fmt::Display for SourceFifo {242	fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {243		write!(f, "fifo({:?})", self.0)244	}245}246impl SourcePathT for SourceFifo {247	fn is_default(&self) -> bool {248		// In case of FD input, user won't expect relative paths to be resolved from /dev/fd/249		true250	}251252	fn path(&self) -> Option<&Path> {253		None254	}255256	any_ext_impl!(SourcePathT);257}258259/// Either real file, or virtual260/// Hash of FileName always have same value as raw Path, to make it possible to use with raw_entry_mut261#[derive(Clone, PartialEq, Eq, Debug)]262pub struct Source(pub Rc<(SourcePath, IStr)>);263264impl Trace for Source {265	fn trace(&self, _tracer: &mut Tracer) {}266267	fn is_type_tracked() -> bool {268		false269	}270}271272impl Source {273	pub fn new(path: SourcePath, code: IStr) -> Self {274		Self(Rc::new((path, code)))275	}276277	pub fn new_virtual(name: IStr, code: IStr) -> Self {278		Self::new(SourcePath::new(SourceVirtual(name)), code)279	}280281	pub fn code(&self) -> &str {282		&self.0 .1283	}284285	pub fn source_path(&self) -> &SourcePath {286		&self.0 .0287	}288289	pub fn map_source_locations<const S: usize>(&self, locs: &[u32; S]) -> [CodeLocation; S] {290		offset_to_location(&self.0 .1, locs)291	}292	pub fn map_from_source_location(&self, line: usize, column: usize) -> Option<usize> {293		location_to_offset(&self.0 .1, line, column)294	}295}