ferroui-base 0.3.0

// @generated by scripts/generate_composition.py — do not edit

//! `CompositionBitmapCache`.
//!
//! Schema attributes: internal.

use bitflags::bitflags;
use crate::rendering::composition::animations::AnimationInstanceFactory;
use crate::rendering::composition::animations::ICompositionAnimation;
use crate::rendering::composition::expressions::ExpressionVariant;
use crate::rendering::composition::server::CompositionProperty;
use crate::rendering::composition::server::CompositionPropertyOf;
use crate::rendering::composition::server::ServerPropertyValue;
use crate::rendering::composition::server::props_of;
use crate::rendering::composition::transport::BatchStreamReader;
use crate::rendering::composition::transport::BatchStreamWriter;
use crate::rendering::composition::transport::BatchValue;
use crate::rendering::composition::transport::BatchValueReader;
use std::any::Any;
use std::any::TypeId;
use std::cell::Cell;
use std::sync::OnceLock;
use std::time::Duration;
use super::CompositionCacheModeHooks;
use super::CompositionCacheModeProps;
use super::ServerCompositionCacheModeHooks;
use super::ServerCompositionCacheModeProps;

bitflags! {
    /// The fields of `CompositionBitmapCache` that changed since its last serialization.
    #[derive(Clone, Copy, Debug, Default, PartialEq, Eq, Hash)]
    pub struct CompositionBitmapCacheChangedFields: u8 {
        const RENDER_AT_SCALE = 1;
        const RENDER_AT_SCALE_ANIMATED = 2;
        const SNAPS_TO_DEVICE_PIXELS = 4;
        const SNAPS_TO_DEVICE_PIXELS_ANIMATED = 8;
        const ENABLE_CLEAR_TYPE = 16;
        const ENABLE_CLEAR_TYPE_ANIMATED = 32;
    }
}

impl BatchValue for CompositionBitmapCacheChangedFields {
    #[inline]
    fn write_to(&self, out: &mut Vec<u8>) {
        self.bits().write_to(out);
    }

    #[inline]
    fn read_from(input: &mut BatchValueReader<'_>) -> Self {
        CompositionBitmapCacheChangedFields::from_bits_retain(u8::read_from(input))
    }
}

/// The partial methods of `CompositionBitmapCache`: implemented by the class that embeds
/// [`CompositionBitmapCacheProps`]. Every hook defaults to doing nothing.
pub trait CompositionBitmapCacheHooks: CompositionCacheModeHooks {
    fn initialize_defaults_extra(&self) {}

    fn validate_render_at_scale_change(&self, _old_value: f64, _new_value: f64) {}
    fn on_render_at_scale_changed(&self) {}
    fn on_render_at_scale_changing(&self) {}

    fn validate_snaps_to_device_pixels_change(&self, _old_value: bool, _new_value: bool) {}
    fn on_snaps_to_device_pixels_changed(&self) {}
    fn on_snaps_to_device_pixels_changing(&self) {}

    fn validate_enable_clear_type_change(&self, _old_value: bool, _new_value: bool) {}
    fn on_enable_clear_type_changed(&self) {}
    fn on_enable_clear_type_changing(&self) {}
}

/// The UI-thread properties of `CompositionBitmapCache`.
pub struct CompositionBitmapCacheProps {
    base: CompositionCacheModeProps,
    changed_fields_of_composition_bitmap_cache: Cell<CompositionBitmapCacheChangedFields>,
    render_at_scale: Cell<f64>,
    snaps_to_device_pixels: Cell<bool>,
    enable_clear_type: Cell<bool>,
}

impl Default for CompositionBitmapCacheProps {
    fn default() -> Self {
        Self::new()
    }
}

impl CompositionBitmapCacheProps {
    /// Creates the properties with every field at the default of its type.
    /// The defaults of the schema are applied by
    /// [`initialize_defaults`](Self::initialize_defaults).
    pub fn new() -> Self {
        Self {
            base: CompositionCacheModeProps::new(),
            changed_fields_of_composition_bitmap_cache: Cell::new(CompositionBitmapCacheChangedFields::empty()),
            render_at_scale: Cell::new(Default::default()),
            snaps_to_device_pixels: Cell::new(Default::default()),
            enable_clear_type: Cell::new(Default::default()),
        }
    }

    /// The properties of the base class.
    pub fn base(&self) -> &CompositionCacheModeProps {
        &self.base
    }

    /// The `InitializeDefaults` calls of the constructor chain: the base
    /// classes first, then this class.
    pub fn initialize_defaults(&self, host: &dyn CompositionBitmapCacheHooks) {
        self.base.initialize_defaults(host);
        self.initialize_own_defaults(host);
    }

    /// `InitializeDefaults` of this class alone.
    pub fn initialize_own_defaults(&self, host: &dyn CompositionBitmapCacheHooks) {
        CompositionBitmapCacheHooks::initialize_defaults_extra(host);
        self.set_render_at_scale(host, 1.0);
        self.set_snaps_to_device_pixels(host, false);
        self.set_enable_clear_type(host, false);
    }

    /// `RenderAtScale` (animated, default `1.0`).
    pub fn render_at_scale(&self) -> f64 {
        self.render_at_scale.get()
    }

    /// Sets `RenderAtScale` (animated, default `1.0`).
    pub fn set_render_at_scale(&self, host: &dyn CompositionBitmapCacheHooks, value: f64) {
        let mut changed = false;
        let old_value = self.render_at_scale.get();
        if old_value.differs(&value) {
            CompositionBitmapCacheHooks::validate_render_at_scale_change(host, old_value, value);
            CompositionBitmapCacheHooks::on_render_at_scale_changing(host);
            changed = true;
            // Update the backing value
            self.render_at_scale.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::RENDER_AT_SCALE);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionBitmapCacheProps::id_of_render_at_scale_property().base());
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() & !CompositionBitmapCacheChangedFields::RENDER_AT_SCALE_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("RenderAtScale") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::RENDER_AT_SCALE_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionBitmapCacheProps::id_of_render_at_scale_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "RenderAtScale", ExpressionVariant::create(value));
            }
        }
        self.render_at_scale.set(value);
        if changed {
            CompositionBitmapCacheHooks::on_render_at_scale_changed(host);
        }
    }

    /// `SnapsToDevicePixels` (animated, default `false`).
    pub fn snaps_to_device_pixels(&self) -> bool {
        self.snaps_to_device_pixels.get()
    }

    /// Sets `SnapsToDevicePixels` (animated, default `false`).
    pub fn set_snaps_to_device_pixels(&self, host: &dyn CompositionBitmapCacheHooks, value: bool) {
        let mut changed = false;
        let old_value = self.snaps_to_device_pixels.get();
        if old_value.differs(&value) {
            CompositionBitmapCacheHooks::validate_snaps_to_device_pixels_change(host, old_value, value);
            CompositionBitmapCacheHooks::on_snaps_to_device_pixels_changing(host);
            changed = true;
            // Update the backing value
            self.snaps_to_device_pixels.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionBitmapCacheProps::id_of_snaps_to_device_pixels_property().base());
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() & !CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("SnapsToDevicePixels") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionBitmapCacheProps::id_of_snaps_to_device_pixels_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "SnapsToDevicePixels", ExpressionVariant::create(value));
            }
        }
        self.snaps_to_device_pixels.set(value);
        if changed {
            CompositionBitmapCacheHooks::on_snaps_to_device_pixels_changed(host);
        }
    }

    /// `EnableClearType` (animated, default `false`).
    pub fn enable_clear_type(&self) -> bool {
        self.enable_clear_type.get()
    }

    /// Sets `EnableClearType` (animated, default `false`).
    pub fn set_enable_clear_type(&self, host: &dyn CompositionBitmapCacheHooks, value: bool) {
        let mut changed = false;
        let old_value = self.enable_clear_type.get();
        if old_value.differs(&value) {
            CompositionBitmapCacheHooks::validate_enable_clear_type_change(host, old_value, value);
            CompositionBitmapCacheHooks::on_enable_clear_type_changing(host);
            changed = true;
            // Update the backing value
            self.enable_clear_type.set(value);
            // Register object for serialization in the next batch
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE);
            host.register_for_serialization();
            // Reset previous animation if any
            host.pending_animations().remove(ServerCompositionBitmapCacheProps::id_of_enable_clear_type_property().base());
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() & !CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE_ANIMATED);
            // Check for implicit animations
            if let Some(animation) = host.implicit_animation("EnableClearType") {
                // Animation affects only current property
                if let Some(a) = animation.as_composition_animation() {
                    self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE_ANIMATED);
                    host.pending_animations().set(
                        ServerCompositionBitmapCacheProps::id_of_enable_clear_type_property().base(),
                        a.create_instance(host.server(), Some(ExpressionVariant::create(value))),
                    );
                }
                // Animation is triggered by the current field, but does not necessary affects it
                host.start_animation_group(&animation, "EnableClearType", ExpressionVariant::create(value));
            }
        }
        self.enable_clear_type.set(value);
        if changed {
            CompositionBitmapCacheHooks::on_enable_clear_type_changed(host);
        }
    }

    /// Connects an animation with the named property. Returns `false` when
    /// neither this class nor its generated bases have an animated property
    /// of that name: the caller continues with its hand-written base.
    pub fn start_animation(
        &self,
        host: &dyn CompositionBitmapCacheHooks,
        property_name: &str,
        animation: &dyn ICompositionAnimation,
        final_value: Option<ExpressionVariant>,
    ) -> bool {
        if property_name == "RenderAtScale" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionBitmapCacheProps::id_of_render_at_scale_property().base(), server);
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::RENDER_AT_SCALE_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        if property_name == "SnapsToDevicePixels" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionBitmapCacheProps::id_of_snaps_to_device_pixels_property().base(), server);
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        if property_name == "EnableClearType" {
            let server = animation.create_instance(host.server(), final_value);
            host.pending_animations().set(ServerCompositionBitmapCacheProps::id_of_enable_clear_type_property().base(), server);
            self.changed_fields_of_composition_bitmap_cache.set(self.changed_fields_of_composition_bitmap_cache.get() | CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE_ANIMATED);
            host.register_for_serialization();
            return true;
        }
        false
    }

    /// Writes the changes of the object: the base class first, then the
    /// changed-fields mask and the changed members of this class.
    pub fn serialize_changes_core(&self, host: &dyn CompositionBitmapCacheHooks, writer: &mut BatchStreamWriter<'_>) {
        self.base.serialize_changes_core(host, writer);
        let changed = self.changed_fields_of_composition_bitmap_cache.get();
        writer.write(changed);
        if changed.contains(CompositionBitmapCacheChangedFields::RENDER_AT_SCALE_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionBitmapCacheProps::id_of_render_at_scale_property().base()));
        } else if changed.contains(CompositionBitmapCacheChangedFields::RENDER_AT_SCALE) {
            writer.write(self.render_at_scale.get());
        }
        if changed.contains(CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionBitmapCacheProps::id_of_snaps_to_device_pixels_property().base()));
        } else if changed.contains(CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS) {
            writer.write(self.snaps_to_device_pixels.get());
        }
        if changed.contains(CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE_ANIMATED) {
            writer.write_value(host.pending_animations().get_and_remove(ServerCompositionBitmapCacheProps::id_of_enable_clear_type_property().base()));
        } else if changed.contains(CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE) {
            writer.write(self.enable_clear_type.get());
        }
        self.changed_fields_of_composition_bitmap_cache.set(CompositionBitmapCacheChangedFields::empty());
    }
}

/// The partial methods of `ServerCompositionBitmapCache`: implemented by the class that embeds
/// [`ServerCompositionBitmapCacheProps`]. Every hook defaults to doing nothing.
pub trait ServerCompositionBitmapCacheHooks: ServerCompositionCacheModeHooks {
    fn deserialize_changes_extra(&self, _reader: &mut BatchStreamReader<'_>) {}
    fn on_fields_deserialized(&self, _changed: CompositionBitmapCacheChangedFields) {}
}

/// The server-side properties of `ServerCompositionBitmapCache`.
pub struct ServerCompositionBitmapCacheProps {
    base: ServerCompositionCacheModeProps,
    render_at_scale: Cell<f64>,
    snaps_to_device_pixels: Cell<bool>,
    enable_clear_type: Cell<bool>,
}

impl Default for ServerCompositionBitmapCacheProps {
    fn default() -> Self {
        Self::new()
    }
}

impl ServerCompositionBitmapCacheProps {
    /// Creates the properties with every field at the default of its type; the
    /// values of the UI thread arrive with the first batch.
    pub fn new() -> Self {
        Self {
            base: ServerCompositionCacheModeProps::new(),
            render_at_scale: Cell::new(Default::default()),
            snaps_to_device_pixels: Cell::new(Default::default()),
            enable_clear_type: Cell::new(Default::default()),
        }
    }

    /// The properties of the base class.
    pub fn base(&self) -> &ServerCompositionCacheModeProps {
        &self.base
    }

    /// This block or the block of a base class, by type: what
    /// `IServerObject::get_props` of the embedding class returns.
    pub fn find_props(&self, type_id: TypeId) -> Option<&dyn Any> {
        if type_id == TypeId::of::<Self>() {
            return Some(self);
        }
        self.base.find_props(type_id)
    }

    /// The composition property of `RenderAtScale`.
    pub fn id_of_render_at_scale_property() -> &'static CompositionPropertyOf<f64> {
        static PROPERTY: OnceLock<CompositionPropertyOf<f64>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBitmapCacheProps, f64>(
                "RenderAtScale",
                "ServerCompositionBitmapCache",
                |obj| props_of::<ServerCompositionBitmapCacheProps>(obj).render_at_scale.get(),
                |obj, v| props_of::<ServerCompositionBitmapCacheProps>(obj).render_at_scale.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionBitmapCacheProps>(obj).render_at_scale.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionBitmapCacheProps>(obj).render_at_scale.set(v.cast_or_default::<f64>())),
            )
        })
    }

    /// `RenderAtScale` (animated).
    pub fn render_at_scale(&self) -> f64 {
        self.render_at_scale.get()
    }

    pub fn set_render_at_scale(&self, host: &dyn ServerCompositionBitmapCacheHooks, value: f64) {
        self.render_at_scale.set(value);
        host.remove_animation_for_property(Self::id_of_render_at_scale_property().base());
    }

    /// The composition property of `SnapsToDevicePixels`.
    pub fn id_of_snaps_to_device_pixels_property() -> &'static CompositionPropertyOf<bool> {
        static PROPERTY: OnceLock<CompositionPropertyOf<bool>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBitmapCacheProps, bool>(
                "SnapsToDevicePixels",
                "ServerCompositionBitmapCache",
                |obj| props_of::<ServerCompositionBitmapCacheProps>(obj).snaps_to_device_pixels.get(),
                |obj, v| props_of::<ServerCompositionBitmapCacheProps>(obj).snaps_to_device_pixels.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionBitmapCacheProps>(obj).snaps_to_device_pixels.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionBitmapCacheProps>(obj).snaps_to_device_pixels.set(v.cast_or_default::<bool>())),
            )
        })
    }

    /// `SnapsToDevicePixels` (animated).
    pub fn snaps_to_device_pixels(&self) -> bool {
        self.snaps_to_device_pixels.get()
    }

    pub fn set_snaps_to_device_pixels(&self, host: &dyn ServerCompositionBitmapCacheHooks, value: bool) {
        self.snaps_to_device_pixels.set(value);
        host.remove_animation_for_property(Self::id_of_snaps_to_device_pixels_property().base());
    }

    /// The composition property of `EnableClearType`.
    pub fn id_of_enable_clear_type_property() -> &'static CompositionPropertyOf<bool> {
        static PROPERTY: OnceLock<CompositionPropertyOf<bool>> = OnceLock::new();
        PROPERTY.get_or_init(|| {
            CompositionProperty::register::<ServerCompositionBitmapCacheProps, bool>(
                "EnableClearType",
                "ServerCompositionBitmapCache",
                |obj| props_of::<ServerCompositionBitmapCacheProps>(obj).enable_clear_type.get(),
                |obj, v| props_of::<ServerCompositionBitmapCacheProps>(obj).enable_clear_type.set(v),
                Some(|obj| ExpressionVariant::create(props_of::<ServerCompositionBitmapCacheProps>(obj).enable_clear_type.get())),
                Some(|obj, v: ExpressionVariant| props_of::<ServerCompositionBitmapCacheProps>(obj).enable_clear_type.set(v.cast_or_default::<bool>())),
            )
        })
    }

    /// `EnableClearType` (animated).
    pub fn enable_clear_type(&self) -> bool {
        self.enable_clear_type.get()
    }

    pub fn set_enable_clear_type(&self, host: &dyn ServerCompositionBitmapCacheHooks, value: bool) {
        self.enable_clear_type.set(value);
        host.remove_animation_for_property(Self::id_of_enable_clear_type_property().base());
    }

    /// Reads the changes of the object: the base class first, then the
    /// changed-fields mask and the changed members of this class.
    pub fn deserialize_changes_core(
        &self,
        host: &dyn ServerCompositionBitmapCacheHooks,
        reader: &mut BatchStreamReader<'_>,
        committed_at: Duration,
    ) {
        self.base.deserialize_changes_core(host, reader, committed_at);
        ServerCompositionBitmapCacheHooks::deserialize_changes_extra(host, reader);
        let changed = reader.read::<CompositionBitmapCacheChangedFields>();
        if changed.contains(CompositionBitmapCacheChangedFields::RENDER_AT_SCALE_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `RenderAtScale` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_render_at_scale_property().base(),
                ExpressionVariant::create(self.render_at_scale.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionBitmapCacheChangedFields::RENDER_AT_SCALE) {
            let value = reader.read::<f64>();
            self.set_render_at_scale(host, value);
        }
        if changed.contains(CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `SnapsToDevicePixels` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_snaps_to_device_pixels_property().base(),
                ExpressionVariant::create(self.snaps_to_device_pixels.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionBitmapCacheChangedFields::SNAPS_TO_DEVICE_PIXELS) {
            let value = reader.read::<bool>();
            self.set_snaps_to_device_pixels(host, value);
        }
        if changed.contains(CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE_ANIMATED) {
            let Some(animation) = reader.read_value::<AnimationInstanceFactory>().map(AnimationInstanceFactory::create) else {
                panic!("a batch starts an animation of `EnableClearType` without an animation instance");
            };
            host.set_animated_value(
                Self::id_of_enable_clear_type_property().base(),
                ExpressionVariant::create(self.enable_clear_type.get()),
                committed_at,
                animation,
            );
        } else if changed.contains(CompositionBitmapCacheChangedFields::ENABLE_CLEAR_TYPE) {
            let value = reader.read::<bool>();
            self.set_enable_clear_type(host, value);
        }
        ServerCompositionBitmapCacheHooks::on_fields_deserialized(host, changed);
    }

    /// The composition property with the given name, among the properties
    /// of this class and of its generated bases that have a variant form.
    pub fn get_composition_property(name: &str) -> Option<&'static CompositionProperty> {
        if name == "RenderAtScale" {
            return Some(Self::id_of_render_at_scale_property().base());
        }
        if name == "SnapsToDevicePixels" {
            return Some(Self::id_of_snaps_to_device_pixels_property().base());
        }
        if name == "EnableClearType" {
            return Some(Self::id_of_enable_clear_type_property().base());
        }
        None
    }
}