0
0
Fork 0
mirror of https://github.com/denoland/rusty_v8.git synced 2024-11-24 15:19:31 -05:00
denoland-rusty-v8/src/property_handler_flags.rs
Luca Casonato e7f96ac708
Improved ObjectTemplate::set_*_handlers (#1237)
Prior to this commit, `v8::NamedPropertyHandlerConfiguration`
and `v8::IndexedPropertyHandlerConfiguration` did not expose the
`definer` hook, or `flags`.

This commit adds these options. In the process of doing this a couple of
other changes were made:

- Bitflag enum consts are now member consts of the related struct.
  This is done because PropertyHandlerFlags has conflicts with
  PropertyAttribute.
- PropertyDescriptor gets all C++ introspection methods exposed to Rust.
- NamedPropertyHandlerConfiguration callback types get rustdoc comments.
- IndexedPropertyHandlerConfiguration callback types get rustdoc
  comments.
- GenericNamedPropertySetterCallback gets a ReturnValue parameter, to
  signal trap passthrough.

Co-authored-by: Bartek Iwańczuk <biwanczuk@gmail.com>
2023-05-26 13:14:18 +02:00

136 lines
4.6 KiB
Rust

// Copyright 2019-2021 the Deno authors. All rights reserved. MIT license.
#[repr(C)]
#[derive(Debug, Eq, PartialEq)]
pub struct PropertyHandlerFlags(u32);
impl PropertyHandlerFlags {
/// None.
pub const NONE: Self = Self(0);
/// See ALL_CAN_READ above.
pub const ALL_CAN_READ: Self = Self(1 << 0);
/// Will not call into interceptor for properties on the receiver or prototype
/// chain, i.e., only call into interceptor for properties that do not exist.
/// Currently only valid for named interceptors.
pub const NON_MASKING: Self = Self(1 << 1);
/// Will not call into interceptor for symbol lookup. Only meaningful for
/// named interceptors.
pub const ONLY_INTERCEPT_STRINGS: Self = Self(1 << 2);
/// The getter, query, enumerator callbacks do not produce side effects.
pub const HAS_NO_SIDE_EFFECT: Self = Self(1 << 3);
/// Test if no property handler flags are set.
#[inline(always)]
pub fn is_none(&self) -> bool {
*self == Self::NONE
}
/// Test if the all-can-read property handler flag is set.
#[inline(always)]
pub fn is_all_can_read(&self) -> bool {
self.has(Self::ALL_CAN_READ)
}
/// Test if the non-masking property handler flag is set.
#[inline(always)]
pub fn is_non_masking(&self) -> bool {
self.has(Self::NON_MASKING)
}
/// Test if the only-intercept-strings property handler flag is set.
#[inline(always)]
pub fn is_only_intercept_strings(&self) -> bool {
self.has(Self::ONLY_INTERCEPT_STRINGS)
}
/// Test if the has-no-side-effect property handler flag is set.
#[inline(always)]
pub fn is_has_no_side_effect(&self) -> bool {
self.has(Self::HAS_NO_SIDE_EFFECT)
}
#[inline(always)]
fn has(&self, that: Self) -> bool {
let Self(lhs) = self;
let Self(rhs) = that;
0 != lhs & rhs
}
}
// Identical to #[derive(Default)] but arguably clearer when made explicit.
impl Default for PropertyHandlerFlags {
fn default() -> Self {
Self::NONE
}
}
impl std::ops::BitOr for PropertyHandlerFlags {
type Output = Self;
fn bitor(self, Self(rhs): Self) -> Self {
let Self(lhs) = self;
Self(lhs | rhs)
}
}
#[test]
fn test_attr() {
assert!(PropertyHandlerFlags::NONE.is_none());
assert!(!PropertyHandlerFlags::NONE.is_all_can_read());
assert!(!PropertyHandlerFlags::NONE.is_non_masking());
assert!(!PropertyHandlerFlags::NONE.is_only_intercept_strings());
assert!(!PropertyHandlerFlags::NONE.is_has_no_side_effect());
assert!(!PropertyHandlerFlags::ALL_CAN_READ.is_none());
assert!(PropertyHandlerFlags::ALL_CAN_READ.is_all_can_read());
assert!(!PropertyHandlerFlags::ALL_CAN_READ.is_non_masking());
assert!(!PropertyHandlerFlags::ALL_CAN_READ.is_only_intercept_strings());
assert!(!PropertyHandlerFlags::ALL_CAN_READ.is_has_no_side_effect());
assert!(!PropertyHandlerFlags::NON_MASKING.is_none());
assert!(!PropertyHandlerFlags::NON_MASKING.is_all_can_read());
assert!(PropertyHandlerFlags::NON_MASKING.is_non_masking());
assert!(!PropertyHandlerFlags::NON_MASKING.is_only_intercept_strings());
assert!(!PropertyHandlerFlags::NON_MASKING.is_has_no_side_effect());
assert!(!PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS.is_none());
assert!(!PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS.is_all_can_read());
assert!(!PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS.is_non_masking());
assert!(
PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS.is_only_intercept_strings()
);
assert!(!PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS.is_has_no_side_effect());
assert!(!PropertyHandlerFlags::HAS_NO_SIDE_EFFECT.is_none());
assert!(!PropertyHandlerFlags::HAS_NO_SIDE_EFFECT.is_all_can_read());
assert!(!PropertyHandlerFlags::HAS_NO_SIDE_EFFECT.is_non_masking());
assert!(!PropertyHandlerFlags::HAS_NO_SIDE_EFFECT.is_only_intercept_strings());
assert!(PropertyHandlerFlags::HAS_NO_SIDE_EFFECT.is_has_no_side_effect());
assert_eq!(PropertyHandlerFlags::NONE, Default::default());
assert_eq!(
PropertyHandlerFlags::ALL_CAN_READ,
PropertyHandlerFlags::NONE | PropertyHandlerFlags::ALL_CAN_READ
);
let attr =
PropertyHandlerFlags::ALL_CAN_READ | PropertyHandlerFlags::NON_MASKING;
assert!(!attr.is_none());
assert!(attr.is_all_can_read());
assert!(attr.is_non_masking());
assert!(!attr.is_only_intercept_strings());
assert!(!attr.is_has_no_side_effect());
let attr = PropertyHandlerFlags::ONLY_INTERCEPT_STRINGS
| PropertyHandlerFlags::HAS_NO_SIDE_EFFECT
| PropertyHandlerFlags::NON_MASKING;
assert!(!attr.is_none());
assert!(!attr.is_all_can_read());
assert!(attr.is_non_masking());
assert!(attr.is_only_intercept_strings());
assert!(attr.is_has_no_side_effect());
}