1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
use std::{
any::TypeId,
sync::{
atomic::{AtomicUsize, Ordering},
Arc,
},
};
use parking_lot::{RwLock, RwLockReadGuard};
use super::{private::InnerData, Data, RwData};
use crate::{
ui::Ui,
widgets::{ActiveWidget, PassiveWidget},
};
/// A read-only reference to information.
///
/// A data type that can read, but not write, the inner data. If you
/// wish to get a read write struct, see [`RwData`]. This struct is
/// usually what you will get as a readable handle from structs
/// containing [`RwData`]. For example, when opening a new file, we
/// use a hook, called the `constructor_hook`, to do certain actions
/// to that file, like opening surroundig [`Widget`]s. This hook can
/// provide an [`RoData<FileWidget<U>>`], which is then queryed by the
/// widget for information about the file. This also prevents the
/// modification of data by third parties which shouldn`t be able to
/// do so.
///
/// Can only be created by cloning the [`Arc<RwLock<T>>`] from a
/// [`RwData<T>`], or through cloning.
///
/// [`Widget`]: crate::widgets::Widget
/// [`RoData<FileWidget<U>>`]: RoData
pub struct RoData<T>
where
T: ?Sized + 'static,
{
data: Arc<RwLock<T>>,
cur_state: Arc<AtomicUsize>,
read_state: AtomicUsize,
type_id: TypeId,
}
impl<T> RoData<T> {
/// Returns a new instance of a [`RoData<T>`], assuming that it is
/// sized.
///
/// This has to be sized because of some Rust limitations, as you
/// can`t really pass an unsized argument to a function (for now).
/// If you're looking to store unsized types (`dyn Trait`,
/// `[Type]`, etc) on a [`RwData`], see [`RwData::new_unsized`].
pub fn new(data: T) -> Self {
Self {
data: Arc::new(RwLock::new(data)),
cur_state: Arc::new(AtomicUsize::new(1)),
read_state: AtomicUsize::new(1),
type_id: TypeId::of::<T>(),
}
}
}
impl<T> RoData<T>
where
T: ?Sized,
{
/// Returns a new instance of [`RoData<T>`], assuming that it is
/// unsized.
///
/// This method is only required if you're dealing with types that
/// may not be [`Sized`] (`dyn Trait`, `[Type]`, etc). If the type
/// in question is sized, use [`RwData::new`] instead.
pub fn new_unsized<SizedT: 'static>(data: Arc<RwLock<T>>) -> Self {
// It's 1 here so that any `RoState`s created from this will have
// `has_changed()` return `true` at least once, by copying the
// second value - 1.
Self {
data,
cur_state: Arc::new(AtomicUsize::new(1)),
read_state: AtomicUsize::new(1),
type_id: TypeId::of::<SizedT>(),
}
}
/// Blocking reference to the information.
///
/// Also makes it so that [`has_changed`] returns `false`.
///
/// # Examples
///
/// Since this is a blocking read, the thread will hault while the
/// data is being written to:
/// ```rust
/// # use std::{
/// # thread,
/// # time::{Duration, Instant}
/// # };
/// # use duat_core::data::{ReadableData, RoData, RwData};
/// let read_write_data = RwData::new("☹️");
/// let read_only_data = RoData::from(&read_write_data);
/// let instant = Instant::now();
/// thread::scope(|scope| {
/// scope.spawn(|| {
/// let mut read_write = read_write_data.write();
/// // Supposedly long computations.
/// thread::sleep(Duration::from_millis(100));
/// *read_write = "☺️";
/// });
///
/// // Just making sure that the read happens slighly after the write.
/// thread::sleep(Duration::from_millis(1));
///
/// let read_only = read_only_data.read();
/// let time_elapsed = Instant::now().duration_since(instant);
/// assert!(time_elapsed >= Duration::from_millis(100));
/// assert!(*read_only == "☺️");
/// });
/// ```
/// Note that other reads will **NOT** block reading in this way,
/// only writes:
/// ```rust
/// # use std::{
/// # thread,
/// # time::{Duration, Instant}
/// # };
/// # use duat_core::data::{ReadableData, RoData, RwData};
/// let read_write_data = RwData::new("☹️");
/// let read_only_data = RoData::from(&read_write_data);
/// let instant = Instant::now();
/// thread::scope(|scope| {
/// scope.spawn(|| {
/// let read_only = read_write_data.read();
/// // The thread hangs, but reading is still possible.
/// thread::sleep(Duration::from_millis(100));
/// });
///
/// // Just making sure that this read happens slighly after the last one.
/// thread::sleep(Duration::from_millis(1));
///
/// let read_only = read_only_data.read();
/// let time_elapsed = Instant::now().duration_since(instant);
/// assert!(time_elapsed < Duration::from_millis(100));
/// });
/// ```
/// [`has_changed`]: Self::has_changed
pub fn read(&self) -> RwLockReadGuard<'_, T> {
let cur_state = self.cur_state().load(Ordering::Acquire);
self.read_state().store(cur_state, Ordering::Release);
self.data()
}
/// Blocking inspection of the inner data.
///
/// Also makes it so that [`has_changed`] returns `false`.
///
/// # Examples
///
/// This method is useful if you want to scope the reading, or
/// need to drop the reference quickly, so it can be written to.
///
/// You can do this:
/// ```rust
/// # use duat_core::data::{ReadableData, RoData, RwData};
/// # fn add_to_count(count: &mut usize) {}
/// # fn new_count() -> usize {
/// # 0
/// # }
/// let count = RwData::new(31);
/// let count_reader = RoData::from(&count);
///
/// // The read write counterpart to `inspect`.
/// count.mutate(|count| {
/// *count += 5;
/// add_to_count(count)
/// });
///
/// count_reader.inspect(|count| { /* reading operations */ });
///
/// *count.write() = new_count();
/// ```
/// Instead of this:
/// ```rust
/// # use duat_core::data::{ReadableData, RoData, RwData};
/// # fn add_to_count(count: &mut usize) {}
/// # fn new_count() -> usize {
/// # 0
/// # }
/// let count = RwData::new(31);
/// let count_reader = RoData::from(&count);
///
/// // The read write counterpart to `inspect`.
/// let mut count_write = count.write();
/// *count_write += 5;
/// add_to_count(&mut *count_write);
/// drop(count_write);
///
/// let count_read = count_reader.read();
/// // reading operations
/// drop(count_read);
///
/// *count.write() = new_count();
/// ```
/// Or this:
/// ```rust
/// # use duat_core::data::{ReadableData, RoData, RwData};
/// # fn add_to_count(count: &mut usize) {}
/// # fn new_count() -> usize {
/// # 0
/// # }
/// let count = RwData::new(31);
/// let count_reader = RoData::from(&count);
///
/// // The read write counterpart to `inspect`.
/// {
/// let mut count = count.write();
/// *count += 5;
/// add_to_count(&mut count)
/// }
///
/// {
/// let count = count.read();
/// // reading operations
/// }
///
/// *count.write() = new_count();
/// ```
/// [`has_changed`]: Self::has_changed
pub fn inspect<U>(&self, f: impl FnOnce(&T) -> U) -> U {
let cur_state = self.cur_state().load(Ordering::Acquire);
self.read_state().store(cur_state, Ordering::Release);
f(&self.data())
}
/// Non blocking reference to the information.
///
/// If successful, also makes it so that [`has_changed`] returns
/// `false`.
///
/// # Examples
///
/// Unlike [`read`], can fail to return a reference to the
/// underlying data:
/// ```rust
/// # use std::{sync::TryLockError};
/// # use duat_core::data::{ReadableData, RwData};
/// let new_data = RwData::new("hello 👋");
///
/// let mut blocking_write = new_data.write();
/// *blocking_write = "bye 👋";
///
/// let try_read = new_data.try_read();
/// assert!(matches!(try_read, Err(TryLockError::WouldBlock)));
/// ```
///
/// [`has_changed`]: Self::has_changed
/// [`read`]: Self::read
pub fn try_read(&self) -> Option<RwLockReadGuard<'_, T>> {
self.try_data().inspect(|_| {
let cur_state = self.cur_state().load(Ordering::Acquire);
self.read_state().store(cur_state, Ordering::Release);
})
}
/// Non blocking inspection of the inner data.
///
/// If successful, also makes it so that [`has_changed`] returns
/// `false`.
///
/// # Examples
///
/// Unlike [`inspect`], can fail to return a reference to the
/// underlying data:
/// ```rust
/// # use std::sync::TryLockError;
/// # use duat_core::data::{ReadableData, RwData};
/// let new_data = RwData::new("hello 👋");
///
/// let try_inspect = new_data.mutate(|blocking_mutate| {
/// *blocking_mutate = "bye 👋";
///
/// new_data.try_inspect(|try_inspect| *try_inspect == "bye 👋")
/// });
///
/// assert!(matches!(try_inspect, Err(TryLockError::WouldBlock)));
/// ```
///
/// [`has_changed`]: Self::has_changed
/// [`inspect`]: Self::inspect
pub fn try_inspect<U>(&self, f: impl FnOnce(&T) -> U) -> Option<U> {
self.try_data().map(|data| {
let cur_state = self.cur_state().load(Ordering::Acquire);
self.read_state().store(cur_state, Ordering::Release);
f(&data)
})
}
/// Wether or not it has changed since it was last read.
///
/// A "change" is defined as any time the methods [`write`],
/// [`mutate`], [`try_write`], or [`try_mutate`], are called on an
/// [`RwData`]. Once `has_changed` is called, the data will be
/// considered unchanged since the last `has_changed` call, for
/// that specific instance of a [`ReadableData`].
///
/// When first creating a [`ReadableData`] type, `has_changed`
/// will return `false`;
///
/// # Examples
/// ```rust
/// use duat_core::data::{ReadableData, RoData, RwData};
/// let new_data = RwData::new("Initial text");
/// assert!(!new_data.has_changed());
///
/// let first_reader = RoData::from(&new_data);
///
/// *new_data.write() = "Final text";
///
/// let second_reader = RoData::from(&new_data);
///
/// assert!(first_reader.has_changed());
/// assert!(!second_reader.has_changed());
/// ```
///
/// [`write`]: RwData::write
/// [`mutate`]: RwData::mutate
/// [`try_write`]: RwData::try_write
/// [`try_mutate`]: RwData::try_mutate
pub fn has_changed(&self) -> bool {
let cur_state = self.cur_state().load(Ordering::Relaxed);
let read_state = self.read_state().swap(cur_state, Ordering::Relaxed);
cur_state > read_state
}
/// Returns `true` if both [`ReadableData<T>`]s point to the same
/// data.
///
/// # Examples
/// ```rust
/// # use duat_core::data::{ReadableData, RwData};
/// let data_1 = RwData::new(false);
/// let data_1_clone = data_1.clone();
///
/// let data_2 = RwData::new(true);
///
/// assert!(data_1.ptr_eq(&data_1_clone));
/// assert!(!data_1.ptr_eq(&data_2));
/// ```
pub fn ptr_eq<U>(&self, other: &impl Data<U>) -> bool
where
U: ?Sized,
{
Arc::as_ptr(self.cur_state()) as usize == Arc::as_ptr(other.cur_state()) as usize
}
/// Blocking inspection of the inner data.
///
/// # Examples
///
/// You may want this method if you're storing a list of
/// [`RwData<dyn Trait>`], and want to know, at runtime, what type
/// each element is:
/// ```rust
/// # use std::{
/// # any::Any,
/// # fmt::Display,
/// # sync::{Arc, RwLock}
/// # };
/// # use duat_core::data::{RwData};
/// # struct DownCastableChar(char);
/// # struct DownCastableString(String);
/// # impl AsAny for DownCastableChar {
/// # fn as_any(&self) -> &dyn Any {
/// # self
/// # }
/// # }
/// let list: [RwData<dyn Any>; 3] = [
/// RwData::new_unsized(Arc::new(RwLock::new(DownCastableString(
/// String::from("I can show you the world"),
/// )))),
/// RwData::new_unsized(Arc::new(RwLock::new(DownCastableString(
/// String::from("Shining, shimmering, splendid"),
/// )))),
/// RwData::new_unsized(Arc::new(RwLock::new(DownCastableChar('🧞')))),
/// ];
///
/// assert!(matches!(
/// list[2].inspect_as::<DownCastableChar, char>(|char| char.0),
/// Some('🧞')
/// ));
/// assert!(matches!(
/// list[1].inspect_as::<DownCastableChar, char>(|char| char.0),
/// None
/// ));
/// ```
///
/// [`RwData<dyn Trait>`]: RwData
pub fn inspect_as<U: 'static, R>(&self, f: impl FnOnce(&U) -> R) -> Option<R> {
self.data_is::<U>().then(|| {
let ptr = Arc::as_ptr(&self.data);
let cast = unsafe { ptr.cast::<RwLock<U>>().as_ref().unwrap() };
self.read_state
.store(self.cur_state.load(Ordering::Acquire), Ordering::Release);
f(&cast.read())
})
}
pub fn data_is<U>(&self) -> bool
where
U: 'static,
{
self.type_id == TypeId::of::<U>()
}
/// Tries to downcast to a concrete type.
pub fn try_downcast<U>(&self) -> Option<RoData<U>>
where
U: 'static,
{
if self.data_is::<U>() {
let Self {
data,
cur_state,
read_state,
..
} = self.clone();
let raw_data_pointer = Arc::into_raw(data);
let data = unsafe { Arc::from_raw(raw_data_pointer.cast::<RwLock<U>>()) };
Some(RoData {
data,
cur_state,
read_state,
type_id: TypeId::of::<U>(),
})
} else {
None
}
}
}
impl<T> Default for RoData<T>
where
T: Default,
{
fn default() -> Self {
Self {
data: Arc::new(RwLock::new(T::default())),
cur_state: Arc::new(AtomicUsize::new(0)),
read_state: AtomicUsize::new(0),
type_id: TypeId::of::<T>(),
}
}
}
impl<T> std::fmt::Debug for RoData<T>
where
T: ?Sized + std::fmt::Debug,
{
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
std::fmt::Debug::fmt(&*self.data.read(), f)
}
}
impl<T> From<&RwData<T>> for RoData<T>
where
T: ?Sized,
{
fn from(value: &RwData<T>) -> Self {
RoData {
data: value.data.clone(),
cur_state: value.cur_state.clone(),
read_state: AtomicUsize::new(value.cur_state.load(Ordering::Relaxed)),
type_id: value.type_id,
}
}
}
impl<T> InnerData<T> for RoData<T>
where
T: ?Sized,
{
fn data(&self) -> RwLockReadGuard<'_, T> {
self.data.read()
}
fn try_data(&self) -> Option<RwLockReadGuard<'_, T>> {
self.data.try_read()
}
fn cur_state(&self) -> &Arc<AtomicUsize> {
&self.cur_state
}
fn read_state(&self) -> &AtomicUsize {
&self.read_state
}
}
// NOTE: Each `RoState` of a given state will have its own internal
// update counter.
impl<T> Clone for RoData<T>
where
T: ?Sized,
{
fn clone(&self) -> Self {
RoData {
data: self.data.clone(),
cur_state: self.cur_state.clone(),
read_state: AtomicUsize::new(self.cur_state.load(Ordering::Relaxed)),
type_id: self.type_id,
}
}
}
impl<U> RoData<dyn ActiveWidget<U>>
where
U: Ui,
{
pub fn to_passive(self) -> RoData<dyn PassiveWidget<U>> {
RoData {
data: self.data as Arc<RwLock<dyn PassiveWidget<U>>>,
cur_state: self.cur_state.clone(),
read_state: AtomicUsize::new(self.cur_state.load(Ordering::Relaxed) - 1),
type_id: self.type_id,
}
}
}
impl<T: ?Sized> Data<T> for RoData<T> {
fn to_ro(&self) -> RoData<T> {
self.clone()
}
fn has_changed(&self) -> bool {
self.has_changed()
}
}
unsafe impl<T: ?Sized + Send> Send for RoData<T> {}
unsafe impl<T: ?Sized + Sync> Sync for RoData<T> {}