core: Rename display objects' static_data field to shared

...and the corresponding `FooStatic` structs to `FooShared`.
This better represents the semantics, and avoids conflation with the
`'static` lifetime (in fact, these structs sometimes contain GC'd data).

Author: moulins

core/src/display_object/avm1_button.rs

@@ -40,7 +40,7 @@ impl fmt::Debug for Avm1Button<'_> {
 #[collect(no_drop)]
 pub struct Avm1ButtonData<'gc> {
     cell: RefLock<Avm1ButtonDataMut<'gc>>,
-    static_data: Gc<'gc, ButtonStatic>,
+    shared: Gc<'gc, ButtonShared>,
     state: Cell<ButtonState>,
     tracking: Cell<ButtonTracking>,
     object: Lock<Option<Object<'gc>>>,
@@ -77,13 +77,13 @@ impl<'gc> Avm1Button<'gc> {
                     hit_area: BTreeMap::new(),
                     hit_bounds: Default::default(),
                 }),
-                static_data: Gc::new(
+                shared: Gc::new(
                     mc,
-                    ButtonStatic {
+                    ButtonShared {
                         swf: source_movie.movie.clone(),
                         id: button.id,
                         actions,
-                        cell: RefCell::new(ButtonStaticMut {
+                        cell: RefCell::new(ButtonSharedMut {
                             records: button.records.clone(),
                             up_to_over_sound: None,
                             over_to_down_sound: None,
@@ -105,22 +105,21 @@ impl<'gc> Avm1Button<'gc> {
     }
 
     pub fn set_sounds(self, sounds: swf::ButtonSounds) {
-        let mut static_data = self.0.static_data.cell.borrow_mut();
-        static_data.up_to_over_sound = sounds.up_to_over_sound;
-        static_data.over_to_down_sound = sounds.over_to_down_sound;
-        static_data.down_to_over_sound = sounds.down_to_over_sound;
-        static_data.over_to_up_sound = sounds.over_to_up_sound;
+        let mut shared = self.0.shared.cell.borrow_mut();
+        shared.up_to_over_sound = sounds.up_to_over_sound;
+        shared.over_to_down_sound = sounds.over_to_down_sound;
+        shared.down_to_over_sound = sounds.down_to_over_sound;
+        shared.over_to_up_sound = sounds.over_to_up_sound;
     }
 
     /// Handles the ancient DefineButtonCxform SWF tag.
     /// Set the color transform for all children of each state.
     pub fn set_colors(self, color_transforms: &[swf::ColorTransform]) {
-        let mut static_data = self.0.static_data.cell.borrow_mut();
+        let mut shared = self.0.shared.cell.borrow_mut();
 
         // This tag isn't documented well in SWF19. It is only used in very old SWF<=2 content.
         // It applies color transforms to every character in a button, in sequence(?).
-        for (record, color_transform) in static_data.records.iter_mut().zip(color_transforms.iter())
-        {
+        for (record, color_transform) in shared.records.iter_mut().zip(color_transforms.iter()) {
             record.color_transform = *color_transform;
         }
     }
@@ -142,7 +141,7 @@ impl<'gc> Avm1Button<'gc> {
         // TODO: This behavior probably differs in AVM2 (I suspect they always get recreated).
         let mut children = Vec::new();
 
-        for record in &self.0.static_data.cell.borrow().records {
+        for record in &self.0.shared.cell.borrow().records {
             if record.states.contains(state.into()) {
                 // State contains this depth, so we don't have to remove it.
                 removed_depths.remove(&record.depth.into());
@@ -260,7 +259,7 @@ impl<'gc> TDisplayObject<'gc> for Avm1Button<'gc> {
     }
 
     fn id(&self) -> CharacterId {
-        self.0.static_data.id
+        self.0.shared.id
     }
 
     fn movie(&self) -> Arc<SwfMovie> {
@@ -306,7 +305,7 @@ impl<'gc> TDisplayObject<'gc> for Avm1Button<'gc> {
             self.set_state(context, ButtonState::Up);
             self.0.initialized.set(true);
 
-            for record in &self.0.static_data.cell.borrow().records {
+            for record in &self.0.shared.cell.borrow().records {
                 if record.states.contains(swf::ButtonState::HIT_TEST) {
                     match context
                         .library
@@ -322,7 +321,7 @@ impl<'gc> TDisplayObject<'gc> for Avm1Button<'gc> {
                         Err(error) => {
                             tracing::error!(
                                 "Button ID {}: could not instantiate child ID {}: {}",
-                                self.0.static_data.id,
+                                self.0.shared.id,
                                 record.id,
                                 error
                             );
@@ -463,8 +462,8 @@ impl<'gc> TInteractiveObject<'gc> for Avm1Button<'gc> {
         let is_enabled = self.enabled(context);
 
         // Translate the clip event to a button event, based on how the button state changes.
-        let static_data = self.0.static_data;
-        let static_data = static_data.cell.borrow();
+        let shared = self.0.shared;
+        let shared = shared.cell.borrow();
         let (new_state, condition, sound) = match event {
             ClipEvent::DragOut { .. } => (
                 ButtonState::Over,
@@ -479,27 +478,27 @@ impl<'gc> TInteractiveObject<'gc> for Avm1Button<'gc> {
             ClipEvent::Press { .. } => (
                 ButtonState::Down,
                 Some(ButtonActionCondition::OVER_UP_TO_OVER_DOWN),
-                static_data.over_to_down_sound.as_ref(),
+                shared.over_to_down_sound.as_ref(),
             ),
             ClipEvent::Release { .. } => (
                 ButtonState::Over,
                 Some(ButtonActionCondition::OVER_DOWN_TO_OVER_UP),
-                static_data.down_to_over_sound.as_ref(),
+                shared.down_to_over_sound.as_ref(),
             ),
             ClipEvent::ReleaseOutside => (
                 ButtonState::Up,
                 Some(ButtonActionCondition::OUT_DOWN_TO_IDLE),
-                static_data.over_to_up_sound.as_ref(),
+                shared.over_to_up_sound.as_ref(),
             ),
             ClipEvent::RollOut { .. } => (
                 ButtonState::Up,
                 Some(ButtonActionCondition::OVER_UP_TO_IDLE),
-                static_data.over_to_up_sound.as_ref(),
+                shared.over_to_up_sound.as_ref(),
             ),
             ClipEvent::RollOver { .. } => (
                 ButtonState::Over,
                 Some(ButtonActionCondition::IDLE_TO_OVER_UP),
-                static_data.up_to_over_sound.as_ref(),
+                shared.up_to_over_sound.as_ref(),
             ),
             ClipEvent::KeyPress { key_code } => {
                 return self.0.run_actions(
@@ -623,7 +622,7 @@ impl<'gc> Avm1ButtonData<'gc> {
     ) -> ClipEventResult {
         let mut handled = ClipEventResult::NotHandled;
         if let Some(parent) = self.cell.borrow().base.base.parent {
-            for action in &self.static_data.actions {
+            for action in &self.shared.actions {
                 if action.conditions.matches(condition) {
                     // Note that AVM1 buttons run actions relative to their parent, not themselves.
                     handled = ClipEventResult::Handled;
@@ -641,7 +640,7 @@ impl<'gc> Avm1ButtonData<'gc> {
     }
 
     fn movie(&self) -> Arc<SwfMovie> {
-        self.static_data.swf.clone()
+        self.shared.swf.clone()
     }
 }
 
@@ -676,18 +675,18 @@ pub enum ButtonTracking {
     Menu,
 }
 
-/// Static data shared between all instances of a button.
+/// Data shared between all instances of a button.
 #[derive(Collect, Debug)]
 #[collect(require_static)]
-struct ButtonStatic {
+struct ButtonShared {
     swf: Arc<SwfMovie>,
     id: CharacterId,
     actions: Vec<ButtonAction>,
-    cell: RefCell<ButtonStaticMut>,
+    cell: RefCell<ButtonSharedMut>,
 }
 
 #[derive(Debug)]
-struct ButtonStaticMut {
+struct ButtonSharedMut {
     records: Vec<swf::ButtonRecord>,
 
     /// The sounds to play on state changes for this button.

core/src/display_object/avm2_button.rs

@@ -45,7 +45,7 @@ impl fmt::Debug for Avm2Button<'_> {
 pub struct Avm2ButtonData<'gc> {
     base: RefLock<InteractiveObjectBase<'gc>>,
 
-    static_data: Gc<'gc, ButtonStatic>,
+    shared: Gc<'gc, ButtonShared>,
 
     /// The current button state to render.
     state: Cell<ButtonState>,
@@ -107,12 +107,12 @@ impl<'gc> Avm2Button<'gc> {
             context.gc(),
             Avm2ButtonData {
                 base: Default::default(),
-                static_data: Gc::new(
+                shared: Gc::new(
                     context.gc(),
-                    ButtonStatic {
+                    ButtonShared {
                         swf: source_movie.movie.clone(),
                         id: button.id,
-                        cell: RefCell::new(ButtonStaticMut {
+                        cell: RefCell::new(ButtonSharedMut {
                             records: button.records.clone(),
                             up_to_over_sound: None,
                             over_to_down_sound: None,
@@ -155,22 +155,21 @@ impl<'gc> Avm2Button<'gc> {
     }
 
     pub fn set_sounds(self, sounds: swf::ButtonSounds) {
-        let mut static_data = self.0.static_data.cell.borrow_mut();
-        static_data.up_to_over_sound = sounds.up_to_over_sound;
-        static_data.over_to_down_sound = sounds.over_to_down_sound;
-        static_data.down_to_over_sound = sounds.down_to_over_sound;
-        static_data.over_to_up_sound = sounds.over_to_up_sound;
+        let mut shared = self.0.shared.cell.borrow_mut();
+        shared.up_to_over_sound = sounds.up_to_over_sound;
+        shared.over_to_down_sound = sounds.over_to_down_sound;
+        shared.down_to_over_sound = sounds.down_to_over_sound;
+        shared.over_to_up_sound = sounds.over_to_up_sound;
     }
 
     /// Handles the ancient DefineButtonCxform SWF tag.
     /// Set the color transform for all children of each state.
     pub fn set_colors(self, color_transforms: &[swf::ColorTransform]) {
-        let mut static_data = self.0.static_data.cell.borrow_mut();
+        let mut shared = self.0.shared.cell.borrow_mut();
 
         // This tag isn't documented well in SWF19. It is only used in very old SWF<=2 content.
         // It applies color transforms to every character in a button, in sequence(?).
-        for (record, color_transform) in static_data.records.iter_mut().zip(color_transforms.iter())
-        {
+        for (record, color_transform) in shared.records.iter_mut().zip(color_transforms.iter()) {
             record.color_transform = *color_transform;
         }
     }
@@ -196,9 +195,9 @@ impl<'gc> Avm2Button<'gc> {
         let sprite_class = context.avm2.classes().sprite;
 
         let mut children = Vec::new();
-        let static_data = self.0.static_data;
+        let shared = self.0.shared;
 
-        for record in static_data.cell.borrow().records.iter() {
+        for record in shared.cell.borrow().records.iter() {
             if record.states.contains(swf_state) {
                 match context
                     .library
@@ -223,7 +222,7 @@ impl<'gc> Avm2Button<'gc> {
                     Err(error) => {
                         tracing::error!(
                             "Button ID {}: could not instantiate child ID {}: {}",
-                            static_data.id,
+                            shared.id,
                             record.id,
                             error
                         );
@@ -431,11 +430,11 @@ impl<'gc> TDisplayObject<'gc> for Avm2Button<'gc> {
     }
 
     fn id(&self) -> CharacterId {
-        self.0.static_data.id
+        self.0.shared.id
     }
 
     fn movie(&self) -> Arc<SwfMovie> {
-        self.0.static_data.swf.clone()
+        self.0.shared.swf.clone()
     }
 
     fn post_instantiation(
@@ -747,20 +746,16 @@ impl<'gc> TInteractiveObject<'gc> for Avm2Button<'gc> {
         event: ClipEvent<'gc>,
     ) -> ClipEventResult {
         // Translate the clip event to a button event, based on how the button state changes.
-        let static_data = self.0.static_data.cell.borrow();
+        let shared = self.0.shared.cell.borrow();
         let (new_state, sound) = match event {
             ClipEvent::DragOut { .. } => (ButtonState::Over, None),
             ClipEvent::DragOver { .. } => (ButtonState::Down, None),
-            ClipEvent::Press { .. } => (ButtonState::Down, static_data.over_to_down_sound.as_ref()),
-            ClipEvent::Release { .. } => {
-                (ButtonState::Over, static_data.down_to_over_sound.as_ref())
-            }
-            ClipEvent::ReleaseOutside => (ButtonState::Up, static_data.over_to_up_sound.as_ref()),
-            ClipEvent::MouseUpInside => (ButtonState::Up, static_data.over_to_up_sound.as_ref()),
-            ClipEvent::RollOut { .. } => (ButtonState::Up, static_data.over_to_up_sound.as_ref()),
-            ClipEvent::RollOver { .. } => {
-                (ButtonState::Over, static_data.up_to_over_sound.as_ref())
-            }
+            ClipEvent::Press { .. } => (ButtonState::Down, shared.over_to_down_sound.as_ref()),
+            ClipEvent::Release { .. } => (ButtonState::Over, shared.down_to_over_sound.as_ref()),
+            ClipEvent::ReleaseOutside => (ButtonState::Up, shared.over_to_up_sound.as_ref()),
+            ClipEvent::MouseUpInside => (ButtonState::Up, shared.over_to_up_sound.as_ref()),
+            ClipEvent::RollOut { .. } => (ButtonState::Up, shared.over_to_up_sound.as_ref()),
+            ClipEvent::RollOver { .. } => (ButtonState::Over, shared.up_to_over_sound.as_ref()),
             _ => return ClipEventResult::NotHandled,
         };
 
@@ -837,17 +832,17 @@ impl<'gc> TInteractiveObject<'gc> for Avm2Button<'gc> {
     }
 }
 
-/// Static data shared between all instances of a button.
+/// Data shared between all instances of a button.
 #[derive(Collect, Debug)]
 #[collect(require_static)]
-struct ButtonStatic {
+struct ButtonShared {
     swf: Arc<SwfMovie>,
     id: CharacterId,
-    cell: RefCell<ButtonStaticMut>,
+    cell: RefCell<ButtonSharedMut>,
 }
 
 #[derive(Debug)]
-struct ButtonStaticMut {
+struct ButtonSharedMut {
     records: Vec<swf::ButtonRecord>,
 
     /// The sounds to play on state changes for this button.

core/src/display_object/edit_text.rs

@@ -84,8 +84,8 @@ pub struct EditTextData<'gc> {
     /// DisplayObject and InteractiveObject common properties.
     base: InteractiveObjectBase<'gc>,
 
-    /// Static data shared among all instances of this `EditText`.
-    static_data: Gc<'gc, EditTextStatic>,
+    /// Data shared among all instances of this `EditText`.
+    shared: Gc<'gc, EditTextShared>,
 
     /// The underlying text format spans of the `EditText`.
     ///
@@ -234,7 +234,7 @@ impl EditTextData<'_> {
             self.style_sheet.style_sheet(),
             self.flags.contains(EditTextFlag::MULTILINE),
             self.flags.contains(EditTextFlag::CONDENSE_WHITE),
-            self.static_data.swf.version(),
+            self.shared.swf.version(),
         );
         self.original_html_text = if self.style_sheet.is_some() {
             Some(text.to_owned())
@@ -338,9 +338,9 @@ impl<'gc> EditText<'gc> {
             EditTextData {
                 base: InteractiveObjectBase::default(),
                 text_spans,
-                static_data: Gc::new(
+                shared: Gc::new(
                     context.gc(),
-                    EditTextStatic {
+                    EditTextShared {
                         swf: swf_movie,
                         id: swf_tag.id(),
                         initial_text: swf_tag
@@ -878,7 +878,7 @@ impl<'gc> EditText<'gc> {
         let text = self
             .0
             .read()
-            .static_data
+            .shared
             .initial_text
             .clone()
             .unwrap_or_default();
@@ -898,7 +898,7 @@ impl<'gc> EditText<'gc> {
         let mut edit_text = self.0.write(context.gc());
         let autosize = edit_text.autosize;
         let is_word_wrap = edit_text.flags.contains(EditTextFlag::WORD_WRAP);
-        let movie = edit_text.static_data.swf.clone();
+        let movie = edit_text.shared.swf.clone();
         let padding = Self::GUTTER * 2;
 
         if edit_text.flags.contains(EditTextFlag::PASSWORD) {
@@ -2481,11 +2481,11 @@ impl<'gc> TDisplayObject<'gc> for EditText<'gc> {
     }
 
     fn id(&self) -> CharacterId {
-        self.0.read().static_data.id
+        self.0.read().shared.id
     }
 
     fn movie(&self) -> Arc<SwfMovie> {
-        self.0.read().static_data.swf.clone()
+        self.0.read().shared.swf.clone()
     }
 
     /// Construct objects placed on this frame.
@@ -3117,10 +3117,10 @@ bitflags::bitflags! {
     }
 }
 
-/// Static data shared between all instances of a text object.
+/// Data shared between all instances of a text object.
 #[derive(Debug, Clone, Collect)]
 #[collect(require_static)]
-struct EditTextStatic {
+struct EditTextShared {
     swf: Arc<SwfMovie>,
     id: CharacterId,
     initial_text: Option<WString>,