vsrg 0.6.0

Data structures for vertical scrolling rhythm games
Documentation
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
/// Generates note enum and storage of all note types.
///
/// # Remarks
/// This macro generates:
/// - A note type enum, which is fieldless. Used to identify the note type.
/// - A note enum, holding one note record per variant. Represents a note's content.
/// - A snapshot enum, holding one owned [`crate::notes::NoteSnapshot`] per variant.
/// - A note reference enum, holding one [`crate::notes::NoteRef`] per variant. It holds both the
///   note's content ([`crate::notes::NoteRef::value_data`]), and the note's runtime state
///   ([`crate::notes::NoteRef::runtime_data`]).
/// - A note mut reference enum, holding one [`crate::notes::NoteMut`] per variant. It's similar to
///   the reference enum but allows mutating runtime state.
/// - The notes storage struct, holding either [`crate::notes::ShortNoteTypeStorage`] or
///   [`crate::notes::LongNoteTypeStorage`] for each note type, plus any other field that was
///   specified.
///
/// It also implements ergonomic methods for each generated type.
/// Each note storage field gets a `set_<field_name>_state(id, note_state)` method
/// that replaces the note's runtime data in both indexes, ignoring missing ids.
///
/// Edit hooks can be provided. Each entry registers a value implementing [`NotesStorageEditHook`],
/// whose methods fire for every notes storage edit operation (add, remove, update note).
///
/// Each note is assigned a u64 id. Ids are only unique within each note storage, or in other
/// words, notes of different types may share the same numerical id. The user must take care to
/// keep track of the type of each id. Note ids are used by `remove_note(s)` and `replace_note(s)`
/// to identify the target note(s).
///
/// # Examples:
/// ```
///    use vsrg::rhythm::{Time, ClockTime};
///    use vsrg::notes::{
///        ShortNoteTypeStorage, LongNoteTypeStorage, GroupId, Interval,
///        ShortNoteData, LongNoteData,
///    };
///    use soa_rs::{Soars, SoaClone};
///
///    vsrg::generate_notes_storage! {
///        enum MyNoteType,
///
///        enum MyNote,
///
///        enum MyNoteSnapshot,
///
///        enum MyNoteRef,
///
///        enum MyNoteMut,
///
///        #[derive(Debug, Clone)]
///        struct MyNotesStorage {
///            note_type Short(MyShort) => shorts: ShortNoteTypeStorage<MyShort>,
///            note_type Long(MyLong) => longs: LongNoteTypeStorage<MyLong>,
///        }
///    }
///
///    #[derive(Debug, Clone, PartialEq)]
///    struct MyShort {
///        time: Time,
///        gr_id: GroupId,
///        pos: f32,
///    }
///
///    #[derive(Debug, Clone, PartialEq)]
///    struct MyLong {
///        time: Interval<Time>,
///        gr_id: GroupId,
///        pos: f32,
///    }
///
///    #[derive(Clone, Copy, soa_rs::Soars, soa_rs::SoaClone)]
///    pub struct NoteData(f32);
///    #[derive(Clone, Copy, soa_rs::Soars, soa_rs::SoaClone, Default)]
///    pub struct NoteRuntime(f32);
///    impl ShortNoteData for MyShort {
///        type ValueData = NoteData;
///        type RuntimeData = NoteRuntime;
///        fn time(&self) -> Time {
///            self.time
///        }
///        fn group_id(&self) -> GroupId {
///            self.gr_id
///        }
///        fn value_data(&self) -> Self::ValueData {
///            NoteData(self.pos)
///        }
///        fn reconstruct<'a>(
///            time: Time,
///            data: <Self::ValueData as soa_rs::Soars>::Ref<'a>,
///            gr_id: GroupId,
///        ) -> Self {
///            Self {
///                time,
///                gr_id,
///                pos: *data.0,
///            }
///        }
///    }
///    impl LongNoteData for MyLong {
///        type ValueData = NoteData;
///        type RuntimeData = NoteRuntime;
///        fn start_time(&self) -> Time {
///            self.time.start()
///        }
///        fn duration(&self) -> Time {
///            generativity::make_guard!(guard);
///            let (start, end) = self.time.start().prove_same_unit(self.time.end(), guard)
///                .expect("test interval endpoints use the same time unit");
///            (end - start).as_time()
///        }
///        fn group_id(&self) -> GroupId {
///            self.gr_id
///        }
///        fn value_data(&self) -> Self::ValueData {
///            NoteData(self.pos)
///        }
///        fn reconstruct<'a>(
///            start_time: Time,
///            duration: Time,
///            data: <Self::ValueData as soa_rs::Soars>::Ref<'a>,
///            gr_id: GroupId,
///        ) -> Self {
///            generativity::make_guard!(guard);
///            let (start, duration) = start_time.prove_same_unit(duration, guard)
///                .expect("test note timing uses the same time unit");
///            let time = Interval::try_new(start_time, (start + duration).as_time()).unwrap();
///            Self {
///                time,
///                gr_id,
///                pos: *data.0,
///            }
///        }
///    }
/// ```
///
/// For more advanced demonstrations, please refer to the examples of this crate.
#[macro_export]
macro_rules! generate_notes_storage {
    (
        $(#[$note_ty_meta:meta])*
        $note_ty_enum_vis:vis enum $note_ty_enum_name:ident,

        $(#[$note_enum_meta:meta])*
        $note_enum_vis:vis enum $note_enum_name:ident,

        $(#[$snapshot_meta:meta])*
        $snapshot_vis:vis enum $snapshot_name:ident,

        $(#[$note_ref_meta:meta])*
        $note_ref_vis:vis enum $note_ref_name:ident,

        $(#[$note_mut_meta:meta])*
        $note_mut_vis:vis enum $note_mut_name:ident,

        $(#[$struct_meta:meta])*
        $struct_vis:vis struct $struct_name:ident {
            $(note_type $enum_variant:ident ($variant_ty:ty) => $field_vis: vis $field_name:ident: $storage_type: ty),*
            $(, field $aux_vis: vis $aux_field:ident: $aux_ty:ty)*
            $(, edit_hook $hook:expr)* $(,)?
        }
    ) => {
        /// Enum of all note types.
        #[derive(Debug, Clone, Copy, PartialEq, Eq)]
        $(#[$note_ty_meta])*
        $note_ty_enum_vis enum $note_ty_enum_name {
            $($enum_variant,)*
        }

        /// Enum of all note types, with each variant holding the note's content.
        ///
        /// # Remarks
        /// Each note variant only contains the note's canonical value (the minimal data necessary
        /// to identify the note), and contains no runtime state.
        #[derive(Debug, Clone)]
        $(#[$note_enum_meta])*
        $note_enum_vis enum $note_enum_name {
            $($enum_variant($variant_ty),)*
        }

        /// Owned snapshot of a note, including its identity, timing, and runtime state.
        #[derive(Clone)]
        $(#[$snapshot_meta])*
        $snapshot_vis enum $snapshot_name {
            $($enum_variant($crate::notes::NoteSnapshot<$variant_ty>),)*
        }

        #[allow(dead_code)]
        impl $snapshot_name {
            pub fn note_type(&self) -> $note_ty_enum_name {
                match self {
                    $(Self::$enum_variant(_) => $note_ty_enum_name::$enum_variant,)*
                }
            }

            pub fn id(&self) -> u64 {
                match self {
                    $(Self::$enum_variant(n) => n.id,)*
                }
            }

            pub fn start_time(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::Note::start_time(n),)*
                }
            }

            pub fn duration(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::Note::duration(n),)*
                }
            }

            pub fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                match self {
                    $(Self::$enum_variant(n) => n.clock_time,)*
                }
            }

            pub fn group_id(&self) -> $crate::notes::GroupId {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::Note::group_id(n),)*
                }
            }

            /// Clone the canonical note value, excluding runtime state.
            pub fn to_owned_note(&self) -> $note_enum_name {
                match self {
                    $(Self::$enum_variant(n) => $note_enum_name::$enum_variant(n.note.clone()),)*
                }
            }

            /// Consume this snapshot and take its canonical note value.
            pub fn into_owned_note(self) -> $note_enum_name {
                match self {
                    $(Self::$enum_variant(n) => $note_enum_name::$enum_variant(n.note),)*
                }
            }
        }

        impl $crate::notes::Note for $snapshot_name {
            fn start_time(&self) -> $crate::rhythm::Time {
                self.start_time()
            }
            fn duration(&self) -> $crate::rhythm::Time {
                self.duration()
            }
            fn group_id(&self) -> $crate::notes::GroupId {
                self.group_id()
            }
        }

        impl $crate::notes::NoteState for $snapshot_name {
            type Snapshot = Self;
            fn to_snapshot(&self) -> Self {
                self.clone()
            }
            fn id(&self) -> u64 {
                self.id()
            }
            fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                self.clock_time_interval()
            }
        }

        impl From<&$snapshot_name> for $note_ty_enum_name {
            fn from(note: &$snapshot_name) -> Self {
                note.note_type()
            }
        }

        impl From<&$snapshot_name> for $note_enum_name {
            fn from(note: &$snapshot_name) -> Self {
                note.to_owned_note()
            }
        }

        impl From<$snapshot_name> for $note_enum_name {
            fn from(note: $snapshot_name) -> Self {
                note.into_owned_note()
            }
        }

        impl From<&$note_enum_name> for $note_ty_enum_name {
            fn from(val: &$note_enum_name) -> Self {
                val.note_type()
            }
        }

        impl From<$note_enum_name> for $note_ty_enum_name {
            fn from(val: $note_enum_name) -> Self {
                val.note_type()
            }
        }

        #[allow(dead_code)]
        impl $note_enum_name {
            pub fn note_type(&self) -> $note_ty_enum_name {
                match self {
                    $(Self::$enum_variant(_) => $note_ty_enum_name::$enum_variant,)*
                }
            }

            pub fn start_time(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::LongNoteData::start_time(n),)*
                }
            }

            pub fn duration(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::LongNoteData::duration(n),)*
                }
            }

            pub fn group_id(&self) -> $crate::notes::GroupId {
                match self {
                    $(Self::$enum_variant(n) => $crate::notes::LongNoteData::group_id(n),)*
                }
            }
        }

        /// Reference to a note in the notes storage.
        ///
        /// # Remarks
        /// This contains both its canonical value and readonly reference to its runtime state.
        /// Returned by the notes storage's querying methods.
        $(#[$note_ref_meta])*
        #[allow(unused)]
        $note_ref_vis enum $note_ref_name<'a> {
            $($enum_variant($crate::notes::NoteRef<'a, $variant_ty>),)*
        }

        #[allow(dead_code)]
        impl $note_ref_name<'_> {
            /// The storage id, unique within this note type.
            pub fn id(&self) -> u64 {
                match self {
                    $(Self::$enum_variant(n) => n.id,)*
                }
            }

            pub fn start_time(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => n.start_time,)*
                }
            }

            pub fn duration(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => n.duration,)*
                }
            }

            pub fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                match self {
                    $(Self::$enum_variant(n) => n.clock_time,)*
                }
            }

            pub fn group_id(&self) -> $crate::notes::GroupId {
                match self {
                    $(Self::$enum_variant(n) => n.group_id,)*
                }
            }

            /// Clone the stored value, runtime state, identity, and clock timing into an owned snapshot.
            pub fn to_snapshot(&self) -> $snapshot_name {
                match self {
                    $(Self::$enum_variant(n) => $snapshot_name::$enum_variant(n.to_snapshot()),)*
                }
            }

            /// Copy the stored value into an owned value.
            pub fn to_owned_note(&self) -> $note_enum_name {
                match self {
                    $(Self::$enum_variant(n) => $note_enum_name::$enum_variant(
                        <$variant_ty as $crate::notes::LongNoteData>::reconstruct(
                            n.start_time, n.duration, n.value_data, n.group_id.clone(),
                        ),
                    ),)*
                }
            }
        }

        /// Mutable reference to a note in the notes storage.
        ///
        /// # Remarks
        /// This contains both its canonical value and mutable reference to its runtime state.
        /// Returned by the notes storage's querying methods.
        $(#[$note_mut_meta])*
        #[allow(unused)]
        $note_mut_vis enum $note_mut_name<'a> {
            $($enum_variant($crate::notes::NoteMut<'a, $variant_ty>),)*
        }

        #[allow(dead_code)]
        impl $note_mut_name<'_> {
            /// Borrow a read-only view for the duration of this shared borrow.
            pub fn as_ref(&self) -> $note_ref_name<'_> {
                match self {
                    $(Self::$enum_variant(n) => $note_ref_name::$enum_variant(n.as_ref()),)*
                }
            }

            /// The storage id, unique within this note type.
            pub fn id(&self) -> u64 {
                match self {
                    $(Self::$enum_variant(n) => n.id,)*
                }
            }

            pub fn start_time(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => n.start_time,)*
                }
            }

            pub fn duration(&self) -> $crate::rhythm::Time {
                match self {
                    $(Self::$enum_variant(n) => n.duration,)*
                }
            }

            pub fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                match self {
                    $(Self::$enum_variant(n) => n.clock_time,)*
                }
            }

            pub fn group_id(&self) -> $crate::notes::GroupId {
                match self {
                    $(Self::$enum_variant(n) => n.group_id,)*
                }
            }

            /// Clone the stored value, runtime state, identity, and clock timing into an owned snapshot.
            pub fn to_snapshot(&self) -> $snapshot_name {
                match self {
                    $(Self::$enum_variant(n) => $snapshot_name::$enum_variant(n.to_snapshot()),)*
                }
            }

            /// Copy the stored value into an owned value.
            pub fn to_owned_note(&self) -> $note_enum_name {
                match self {
                    $(Self::$enum_variant(n) => $note_enum_name::$enum_variant(
                        <$variant_ty as $crate::notes::LongNoteData>::reconstruct(
                            n.start_time, n.duration, n.value_data, n.group_id.clone(),
                        ),
                    ),)*
                }
            }
        }

        impl<'a, 'b> From<&'a $note_mut_name<'b>> for $note_ref_name<'a> {
            fn from(note: &'a $note_mut_name<'b>) -> Self {
                note.as_ref()
            }
        }

        impl From<&$note_ref_name<'_>> for $note_enum_name {
            fn from(note: &$note_ref_name<'_>) -> Self {
                note.to_owned_note()
            }
        }

        impl From<&$note_mut_name<'_>> for $note_enum_name {
            fn from(note: &$note_mut_name<'_>) -> Self {
                note.to_owned_note()
            }
        }

        impl From<$note_ref_name<'_>> for $note_enum_name {
            fn from(note: $note_ref_name<'_>) -> Self {
                note.to_owned_note()
            }
        }

        impl From<$note_mut_name<'_>> for $note_enum_name {
            fn from(note: $note_mut_name<'_>) -> Self {
                note.to_owned_note()
            }
        }

        impl $crate::notes::Note for $note_enum_name {
            fn start_time(&self) -> $crate::rhythm::Time {
                $note_enum_name::start_time(self)
            }

            fn duration(&self) -> $crate::rhythm::Time {
                $note_enum_name::duration(self)
            }

            fn group_id(&self) -> $crate::notes::GroupId {
                $note_enum_name::group_id(self)
            }
        }

        impl $crate::notes::Note for $note_ref_name<'_> {
            fn start_time(&self) -> $crate::rhythm::Time {
                $note_ref_name::start_time(self)
            }

            fn duration(&self) -> $crate::rhythm::Time {
                $note_ref_name::duration(self)
            }

            fn group_id(&self) -> $crate::notes::GroupId {
                $note_ref_name::group_id(self)
            }
        }

        impl $crate::notes::NoteState for $note_ref_name<'_> {
            type Snapshot = $snapshot_name;

            fn to_snapshot(&self) -> Self::Snapshot {
                $note_ref_name::to_snapshot(self)
            }

            fn id(&self) -> u64 {
                $note_ref_name::id(self)
            }

            fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                $note_ref_name::clock_time_interval(self)
            }
        }

        impl $crate::notes::Note for $note_mut_name<'_> {
            fn start_time(&self) -> $crate::rhythm::Time {
                $note_mut_name::start_time(self)
            }

            fn duration(&self) -> $crate::rhythm::Time {
                $note_mut_name::duration(self)
            }

            fn group_id(&self) -> $crate::notes::GroupId {
                $note_mut_name::group_id(self)
            }
        }

        impl $crate::notes::NoteState for $note_mut_name<'_> {
            type Snapshot = $snapshot_name;

            fn to_snapshot(&self) -> Self::Snapshot {
                $note_mut_name::to_snapshot(self)
            }

            fn id(&self) -> u64 {
                $note_mut_name::id(self)
            }

            fn clock_time_interval(&self) -> $crate::notes::Interval<$crate::rhythm::ClockTime> {
                $note_mut_name::clock_time_interval(self)
            }
        }

        /// Storage for all generated note types.
        ///
        /// # Data model
        /// Each note type has its own storage with fast O(log N) timing and scroll position
        /// lookup. The storage stores each note in struct-of-array style for good cache
        /// locality during note judgement and note rendering.
        ///
        /// Each note stores separately its *canonical value* (minimum information necessary to
        /// identify the note - usually its serialized value), and its *runtime state* (to support
        /// judgement and rendering).
        ///
        /// # Encapsulation
        /// Edits to runtime state are safe to do directly, while edits to canonical value must be
        /// done by the notes storage's editing methods: [`Self::add_note`], [`Self::remove_note`], etc.
        /// These methods ensure that all notes are sorted correctly for fast lookup, and note
        /// relationships are correctly calculated.
        $(#[$struct_meta])*
        $struct_vis struct $struct_name {
            $($field_vis $field_name: $storage_type,)*
            $($aux_vis $aux_field: $aux_ty,)*
        }

        #[allow(dead_code)]
        impl $struct_name {
            $(
                #[doc = concat!("Shared reference to the `", stringify!($field_name), "` note storage.")]
                #[inline]
                pub fn $field_name(&self) -> &$storage_type {
                    &self.$field_name
                }
            )*

            /// Create a new empty notes storage.
            pub fn new() -> Self {
                Self {
                    $($field_name: Default::default(),)*
                    $($aux_field: Default::default(),)*
                }
            }

            /// Create a notes storage with initial notes.
            pub fn with_notes<G: $crate::notes::NoteGroup>(
                notes: Vec<$note_enum_name>,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
            ) -> Self {
                let mut s = Self::new();
                $crate::notes::NotesStorage::add_notes(
                    &mut s, note_groups, tempo_tracks, scroll_tracks, notes
                );
                s
            }
        }

        impl $crate::notes::NotesStorage for $struct_name {
            type NoteTypeEnum = $note_ty_enum_name;
            type NoteEnum = $note_enum_name;
            type NoteSnapshotEnum = $snapshot_name;
            type NoteRefEnum<'a> = $note_ref_name<'a>;
            type NoteMutEnum<'a> = $note_mut_name<'a>;

            fn rebuild_clock_time<G: $crate::notes::NoteGroup>(
                &mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
            ) {
                $(self.$field_name.rebuild_clock_time(
                        note_groups,
                        tempo_tracks,
                        scroll_tracks);)*
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                $crate::notes::NotesStorageEditHook::post_rebuild_clock_time(&mut hooks, self);
            }

            fn rebuild_scroll_pos<G: $crate::notes::NoteGroup>(
                &mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
            ) {
                $(self.$field_name.rebuild_scroll_pos(
                        note_groups,
                        tempo_tracks,
                        scroll_tracks);)*
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                $crate::notes::NotesStorageEditHook::post_rebuild_scroll_pos(&mut hooks, self);
            }

            /// Add a single note to the notes storage.
            fn add_note<G: $crate::notes::NoteGroup>(
                &mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
                mut note: $note_enum_name,
            ) -> u64 {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                $crate::notes::NotesStorageEditHook::pre_add(&mut hooks, self, ::std::slice::from_mut(&mut note));
                match note {
                    $($note_enum_name::$enum_variant(n) => {
                        let note_id = self.$field_name.add_note(
                            note_groups,
                            tempo_tracks,
                            scroll_tracks,
                            n);
                        $crate::notes::NotesStorageEditHook::post_add(
                            &mut hooks,
                            self,
                            &[(note_id, $note_ty_enum_name::$enum_variant)],
                        );

                        note_id
                    })*
                }
            }

            /// Add multiple notes to the notes storage.
            fn add_notes<G: $crate::notes::NoteGroup>(&mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
                mut notes: ::std::vec::Vec<$note_enum_name>,
            ) -> Vec<(u64, $note_ty_enum_name)> {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                if !notes.is_empty() {
                    $crate::notes::NotesStorageEditHook::pre_add(&mut hooks, self, &mut notes);
                }
                let mut added = ::std::vec::Vec::with_capacity(notes.len());
                $(let mut $field_name: ::std::vec::Vec<$variant_ty> = ::std::vec::Vec::new();)*
                for note in notes {
                    match note {
                        $($note_enum_name::$enum_variant(n) => $field_name.push(n),)*
                    }
                }
                $(
                    if !$field_name.is_empty() {
                        let note_ids = self.$field_name.add_notes(
                            note_groups,
                            tempo_tracks,
                            scroll_tracks,
                            $field_name.into_iter());
                        added.extend(note_ids.into_iter().map(|id| (id, $note_ty_enum_name::$enum_variant)));
                    }
                )*
                if !added.is_empty() {
                    $crate::notes::NotesStorageEditHook::post_add(&mut hooks, self, &added);
                }
                added
            }

            /// Remove a single note from the notes storage.
            ///
            /// Silently does nothing if the id does not exist in the notes storage of the given note
            /// type.
            fn remove_note(&mut self, note_type: $note_ty_enum_name, id: u64) {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                match note_type {
                    $($note_ty_enum_name::$enum_variant => {
                        let queried = self.$field_name.query_notes_ref(::std::iter::once(id))
                            .map(|state| $note_ref_name::$enum_variant(state).to_snapshot()).next();
                        let Some(note) = queried else {
                            return;
                        };
                        let note_id = note.id();
                        $crate::notes::NotesStorageEditHook::pre_remove(
                            &mut hooks,
                            self,
                            ::std::slice::from_ref(&note),
                        );
                        self.$field_name.remove_note(note_id);
                        $crate::notes::NotesStorageEditHook::post_remove(&mut hooks, self, ::std::slice::from_ref(&note));
                    })*
                }
            }

            /// Remove multiple notes from the notes storage.
            ///
            /// Duplicate ids are deduplicated, and ids that do not exist are silently skipped.
            fn remove_notes(&mut self,
                mut notes: ::std::vec::Vec<(u64, $note_ty_enum_name)>,
            ) {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                // Reuse the caller's buffer for sorting and deduplication.
                notes.sort_unstable_by_key(|(id, ty)| (*ty as usize, *id));
                notes.dedup();
                let queried: ::std::vec::Vec<_> = self.query_notes(notes.iter().copied()).collect();
                if !queried.is_empty() {
                    $crate::notes::NotesStorageEditHook::pre_remove(&mut hooks, self, &queried);
                }
                $(
                    self.$field_name.remove_notes(queried.iter().filter_map(|note| {
                        (note.note_type() == $note_ty_enum_name::$enum_variant).then_some(note.id())
                    }));
                )*
                if !queried.is_empty() {
                    $crate::notes::NotesStorageEditHook::post_remove(&mut hooks, self, &queried);
                }
            }

            /// Query for owned snapshots of notes by its ids and note type.
            ///
            /// Since ids are only unique within each note type, a note must also be identified by
            /// its note type as well as its ids.
            fn query_notes(&self,
                ids: impl Iterator<Item = (u64, $note_ty_enum_name)> + Clone
            ) -> impl Iterator<Item = $snapshot_name> {
                ::std::iter::empty()
                $(.chain(self.$field_name.query_notes_ref(
                    #[allow(unreachable_patterns)]
                    ids.clone().filter_map(|(id, ty)| match ty {
                        $note_ty_enum_name::$enum_variant => Some(id),
                        _ => None,
                    })
                ).map(|state| $note_ref_name::$enum_variant(state).to_snapshot())))*
            }

            fn all_notes(&self) -> impl Iterator<Item = $snapshot_name> {
                ::std::iter::empty()
                $(.chain(self.$field_name.all_notes_ref()
                    .map(|state| $note_ref_name::$enum_variant(state).to_snapshot())))*
            }

            fn all_notes_of_type(&self,
                note_type: $note_ty_enum_name,
            ) -> impl Iterator<Item = $snapshot_name> {
                self.all_notes_ref_of_type(note_type).map(|state| state.to_snapshot())
            }

            fn all_notes_ref_of_type<'a>(&'a self,
                note_type: $note_ty_enum_name,
            ) -> impl Iterator<Item = $note_ref_name<'a>> + 'a
            where
                Self: 'a,
            {
                ::std::iter::empty()
                $(.chain(
                    ::std::iter::once(&self.$field_name)
                        .filter(move |_| matches!(note_type, $note_ty_enum_name::$enum_variant))
                        .flat_map(|storage| storage.all_notes_ref())
                        .map($note_ref_name::$enum_variant)
                ))*
            }

            fn all_notes_mut_of_type(&mut self,
                note_type: $note_ty_enum_name,
                mut f: impl FnMut($note_mut_name<'_>),
            ) {
                match note_type {
                    $($note_ty_enum_name::$enum_variant => {
                        self.$field_name.all_notes_mut(
                            |state| f($note_mut_name::$enum_variant(state)),
                        );
                    })*
                }
            }

            /// Get references to note state from the notes storage by its ids and note type.
            ///
            /// Since ids are only unique within each note type, a note must also be identified by
            /// its note type as well as its ids.
            fn query_notes_ref<'a>(&'a self,
                ids: impl Iterator<Item = (u64, $note_ty_enum_name)> + Clone + 'a
            ) -> impl Iterator<Item = $note_ref_name<'a>> + 'a
            where
                Self: 'a
            {
                ::std::iter::empty()
                $(
                    .chain(
                        self.$field_name.query_notes_ref(
                            #[allow(unreachable_patterns)]
                            ids.clone().filter_map(|(id, note_type)| match note_type {
                                $note_ty_enum_name::$enum_variant => Some(id),
                                _ => None,
                            })
                        ).map(|state| $note_ref_name::$enum_variant(state))
                    )
                )*
            }

            /// Get mutable references to note state from the notes storage by ids and note type.
            ///
            /// Mutable references cannot be returned from an iterator (rust's AXM rule), so each
            /// note state is lent to a callback instead. Duplicate ids in `ids` are allowed.
            ///
            /// Since ids are only unique within each note type, a note must also be identified by
            /// its note type as well as its ids.
            fn query_notes_mut(&mut self,
                ids: impl Iterator<Item = (u64, $note_ty_enum_name)> + Clone,
                mut f: impl FnMut($note_mut_name<'_>),
            ) {
                $(
                    self.$field_name.query_notes_mut(
                        #[allow(unreachable_patterns)]
                        ids.clone().filter_map(|(id, note_type)| match note_type {
                            $note_ty_enum_name::$enum_variant => Some(id),
                            _ => None,
                        }),
                        |state| f($note_mut_name::$enum_variant(state)),
                    );
                )*
            }

            /// Query for owned snapshots of notes that overlap a clock-time range.
            fn notes_overlapping_range(&self,
                range: $crate::notes::Interval<$crate::rhythm::ClockTime>
            ) -> impl Iterator<Item = $snapshot_name> {
                self.notes_ref_overlapping_range(range).map(|state| state.to_snapshot())
            }

            /// Get references to state of notes that overlap a clock-time range.
            fn notes_ref_overlapping_range<'a>(&'a self,
                range: $crate::notes::Interval<$crate::rhythm::ClockTime>
            ) -> impl Iterator<Item = $note_ref_name<'a>> + 'a
            where
                Self: 'a
            {
                ::std::iter::empty()
                $(
                    .chain(
                        self.$field_name.notes_ref_overlapping_range(range)
                            .map(|state| $note_ref_name::$enum_variant(state))
                    )
                )*
            }

            /// Get mutable references to notes that overlap a clock-time range.
            ///
            /// Like [`Self::query_notes_mut`], mutable references cannot be returned
            /// from an iterator (rust's AXM rule), so each note state is lent to a callback
            /// instead. Duplicate ids in `ids` are allowed.
            fn notes_mut_overlapping_range(&mut self,
                range: $crate::notes::Interval<$crate::rhythm::ClockTime>,
                mut f: impl FnMut($note_mut_name<'_>),
            ) {
                $(
                    self.$field_name.notes_mut_overlapping_range(
                        range,
                        |state| f($note_mut_name::$enum_variant(state)),
                    );
                )*
            }

            /// Remove multiple notes from the notes storage, running a closure on each note.
            ///
            /// Duplicate ids are deduplicated, and ids that do not exist are silently skipped.
            fn extract_notes(&mut self,
                mut notes: ::std::vec::Vec<(u64, $note_ty_enum_name)>,
                mut f: impl FnMut($snapshot_name),
            ) {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                // Reuse the caller's buffer for sorting and deduplication.
                notes.sort_unstable_by_key(|(id, ty)| (*ty as usize, *id));
                notes.dedup();
                let queried: ::std::vec::Vec<_> = self.query_notes(notes.iter().copied()).collect();
                if !queried.is_empty() {
                    $crate::notes::NotesStorageEditHook::pre_remove(&mut hooks, self, &queried);
                }
                $(
                    self.$field_name.remove_notes(queried.iter().filter_map(|note| {
                        (note.note_type() == $note_ty_enum_name::$enum_variant).then_some(note.id())
                    }));
                )*
                for note in &queried { f(note.clone()); }
                if !queried.is_empty() {
                    $crate::notes::NotesStorageEditHook::post_remove(&mut hooks, self, &queried);
                }
            }

            /// Replace a note with new data.
            ///
            /// Silently does nothing if the id does not exist in the notes storage of the note's type.
            fn replace_note<G: $crate::notes::NoteGroup>(&mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
                id: u64,
                note: $note_enum_name,
            ) {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                let note_type = note.note_type();
                let queried = self
                    .query_notes(::std::iter::once((id, note_type)))
                    .next();
                let Some(before) = queried else {
                    return;
                };
                let note_id = before.id();
                let mut replacement = (note_id, note);
                $crate::notes::NotesStorageEditHook::pre_update(
                    &mut hooks, self, ::std::slice::from_mut(&mut replacement),
                );
                match replacement.1 {
                    $($note_enum_name::$enum_variant(n) => {
                        self.$field_name.replace_note(
                            note_groups,
                            tempo_tracks,
                            scroll_tracks,
                            note_id,
                            n);
                    })*
                }
                let after = self
                    .query_notes(::std::iter::once((note_id, before.note_type())))
                    .next();
                if let Some(after) = after {
                    $crate::notes::NotesStorageEditHook::post_update(
                        &mut hooks,
                        self,
                        &[(before, after)],
                    );
                }
            }

            /// Replace multiple notes with new data.
            ///
            /// When multiple pairs share the same note type and id, the last pair wins. Missing notes
            /// are silently skipped.
            fn replace_notes<G: $crate::notes::NoteGroup>(&mut self,
                note_groups: &$crate::notes::NoteGroups<G>,
                tempo_tracks: &$crate::rhythm::TempoTracks,
                scroll_tracks: &$crate::rhythm::ScrollSpeedTracks,
                mut notes: ::std::vec::Vec<(u64, $note_enum_name)>,
            ) {
                let mut hooks = $crate::generate_notes_storage!(@edit_hooks_tuple $($hook),*);
                // Stable sorting after reversing keeps the last supplied value for each
                // (type, id) when deduplicating.
                notes.reverse();
                notes.sort_by_key(|(id, note)| (note.note_type() as usize, *id));
                notes.dedup_by_key(|(id, note)| (note.note_type() as usize, *id));
                let mut befores: ::std::vec::Vec<_> = self
                    .query_notes(notes.iter().map(|(id, note)| (*id, note.note_type())))
                    .collect();
                befores.sort_unstable_by_key(|note| (note.note_type() as usize, note.id()));
                notes.retain(|(id, note)| befores.binary_search_by_key(
                    &(note.note_type() as usize, *id),
                    |before| (before.note_type() as usize, before.id()),
                ).is_ok());
                if !notes.is_empty() {
                    $crate::notes::NotesStorageEditHook::pre_update(&mut hooks, self, &mut notes);
                }
                $(let mut $field_name: ::std::vec::Vec<(u64, $variant_ty)> =
                    ::std::vec::Vec::new();)*
                for (id, note) in notes {
                    match note {
                        $($note_enum_name::$enum_variant(n) => $field_name.push((id, n)),)*
                    }
                }
                $(
                    if !$field_name.is_empty() {
                        self.$field_name.replace_notes(
                            &note_groups,
                            &tempo_tracks,
                            &scroll_tracks,
                            $field_name.into_iter());
                    }
                )*
                // Capture every after snapshot before post hooks can mutate storage.
                let updates: ::std::vec::Vec<_> = befores.into_iter().filter_map(|before| {
                    self.query_notes(::std::iter::once((before.id(), before.note_type())))
                        .next().map(|after| (before, after))
                }).collect();
                if !updates.is_empty() {
                    $crate::notes::NotesStorageEditHook::post_update(&mut hooks, self, &updates);
                }
            }
        }

        impl Default for $struct_name {
            fn default() -> Self {
                Self::new()
            }
        }
    };

    (@edit_hooks_tuple) => { () };

    (@edit_hooks_tuple $hook:expr) => { $hook };

    (@edit_hooks_tuple $first:expr, $($rest:expr),+) => {
        ($first, $crate::generate_notes_storage!(@edit_hooks_tuple $($rest),+))
    };
}

/// Timing and grouping shared by generated owned and borrowed note enums.
///
/// Implemented by [`generate_notes_storage!`] so generic [`NotesStorage`]
/// consumers can inspect notes.
pub trait Note {
    /// The note's musical start time.
    fn start_time(&self) -> crate::rhythm::Time;

    /// The note's musical duration (zero for short notes).
    fn duration(&self) -> crate::rhythm::Time;

    /// The group containing the note.
    fn group_id(&self) -> crate::notes::GroupId;
}

/// Storage identity and timing available on stored-note views and owned snapshots.
///
/// Implemented by [`generate_notes_storage!`] so generic [`NotesStorage`]
/// consumers can inspect notes.
pub trait NoteState: Note {
    /// Owned snapshot produced by this stored-note view.
    type Snapshot: NoteState<Snapshot = Self::Snapshot> + Clone;

    /// Capture the note value, runtime state, storage identity, and resolved timing.
    fn to_snapshot(&self) -> Self::Snapshot;

    /// The storage id, unique within the note's type.
    fn id(&self) -> u64;

    /// The note's time interval after conversion through its tempo track.
    fn clock_time_interval(&self) -> crate::notes::Interval<crate::rhythm::ClockTime>;
}

/// Represents storage for rhythm game notes.
///
/// # Remarks
/// Implemented automatically by [`generate_notes_storage!`].
///
/// This traits link to the relevant note enum and note state types, and defines edit operations,
/// so generic API can operate on user's generated notes storage.
pub trait NotesStorage {
    type NoteTypeEnum: Clone
        + Copy
        + Eq
        + for<'a> From<&'a Self::NoteEnum>
        + for<'a> From<&'a Self::NoteSnapshotEnum>
        + 'static;
    type NoteEnum: Note
        + Clone
        + for<'a> From<&'a Self::NoteSnapshotEnum>
        + for<'a, 'b> From<&'a Self::NoteRefEnum<'b>>
        + for<'a, 'b> From<&'a Self::NoteMutEnum<'b>>;
    type NoteSnapshotEnum: NoteState<Snapshot = Self::NoteSnapshotEnum> + Clone;
    type NoteRefEnum<'a>: NoteState<Snapshot = Self::NoteSnapshotEnum>
        + for<'b> From<&'a Self::NoteMutEnum<'b>>
    where
        Self: 'a;
    type NoteMutEnum<'a>: NoteState<Snapshot = Self::NoteSnapshotEnum>
    where
        Self: 'a;

    /// Rebuild the stored clock times after changes to tempo tracks.
    ///
    /// # Remarks
    /// Each note may be placed in either beat time or clock time, but are indexed by clock time.
    /// After changes to tempo events, the storage must recompute the note's clock time, scroll
    /// position and reindex.
    fn rebuild_clock_time<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
    );

    /// Rebuild the stored scroll position after changes to scroll tracks.
    ///
    /// # Remarks
    /// After changes to scroll speed change events, the storage must recompute the note's scroll
    /// position and reindex.
    fn rebuild_scroll_pos<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
    );

    /// Add a note to the storage, returning the id of the added note.
    fn add_note<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
        note: Self::NoteEnum,
    ) -> u64;

    /// Add multiple notes to the storage, returning the ids of the added notes.
    ///
    /// Returns a vec of the tuple (note id, note type) of all notes that were added,
    /// in the order they were declared in `notes`.
    fn add_notes<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
        notes: ::std::vec::Vec<Self::NoteEnum>,
    ) -> Vec<(u64, Self::NoteTypeEnum)>;

    /// Remove a note from the storage.
    fn remove_note(&mut self, note_type: Self::NoteTypeEnum, id: u64);

    /// Remove multiple notes from the storage.
    fn remove_notes(&mut self, notes: ::std::vec::Vec<(u64, Self::NoteTypeEnum)>);

    /// Iterate over every note, yielding cloned snapshot of each note.
    fn all_notes(&self) -> impl Iterator<Item = Self::NoteSnapshotEnum>;

    /// Iterate over every note of one note type.
    fn all_notes_of_type(
        &self,
        note_type: Self::NoteTypeEnum,
    ) -> impl Iterator<Item = Self::NoteSnapshotEnum>;

    /// Iterate over every note of one note type, yielding reference to the note.
    fn all_notes_ref_of_type<'a>(
        &'a self,
        note_type: Self::NoteTypeEnum,
    ) -> impl Iterator<Item = Self::NoteRefEnum<'a>> + 'a
    where
        Self: 'a;

    /// Visit every one note of a note type once, mutating each with a callback.
    fn all_notes_mut_of_type(
        &mut self,
        note_type: Self::NoteTypeEnum,
        f: impl FnMut(Self::NoteMutEnum<'_>),
    );

    /// Query for notes by their ids and note type, yielding cloned snapshot of each note.
    fn query_notes(
        &self,
        ids: impl Iterator<Item = (u64, Self::NoteTypeEnum)> + Clone,
    ) -> impl Iterator<Item = Self::NoteSnapshotEnum>;

    /// Query for notes by their ids and note type, yielding reference to each note.
    fn query_notes_ref<'a>(
        &'a self,
        ids: impl Iterator<Item = (u64, Self::NoteTypeEnum)> + Clone + 'a,
    ) -> impl Iterator<Item = Self::NoteRefEnum<'a>> + 'a
    where
        Self: 'a;

    /// Visit notes by note id and note type, mutating each with a callback.
    fn query_notes_mut(
        &mut self,
        ids: impl Iterator<Item = (u64, Self::NoteTypeEnum)> + Clone,
        f: impl FnMut(Self::NoteMutEnum<'_>),
    );

    /// Query for notes whose time overlaps a timing range, yielding cloned snapshot of each note.
    fn notes_overlapping_range(
        &self,
        range: crate::notes::Interval<crate::rhythm::ClockTime>,
    ) -> impl Iterator<Item = Self::NoteSnapshotEnum>;

    /// Query for notes whose time overlaps a timing range, yielding reference to each note.
    fn notes_ref_overlapping_range<'a>(
        &'a self,
        range: crate::notes::Interval<crate::rhythm::ClockTime>,
    ) -> impl Iterator<Item = Self::NoteRefEnum<'a>> + 'a
    where
        Self: 'a;

    /// Visit notes whose time overlaps a timing range, mutating each with a callback.
    fn notes_mut_overlapping_range(
        &mut self,
        range: crate::notes::Interval<crate::rhythm::ClockTime>,
        f: impl FnMut(Self::NoteMutEnum<'_>),
    );

    /// Access notes from the storage with a callback while deleting them from the storage.
    fn extract_notes(
        &mut self,
        notes: ::std::vec::Vec<(u64, Self::NoteTypeEnum)>,
        f: impl FnMut(Self::NoteSnapshotEnum),
    );

    /// Replace a note identified by an id and note type with new note value.
    fn replace_note<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
        id: u64,
        note: Self::NoteEnum,
    );

    /// Replace multiple notes identified by ids and note types with new note value.
    fn replace_notes<G: crate::notes::NoteGroup>(
        &mut self,
        note_groups: &crate::notes::NoteGroups<G>,
        tempo_tracks: &crate::rhythm::TempoTracks,
        scroll_tracks: &crate::rhythm::ScrollSpeedTracks,
        notes: ::std::vec::Vec<(u64, Self::NoteEnum)>,
    );
}

/// Edit hooks for a notes storage generated by [`generate_notes_storage!`].
///
/// A hook type is registered with the `edit_hook` entry of [`generate_notes_storage!`], and may
/// implement any subset of the methods (unimplemented methods default to no-ops).
///
/// Hooks are not stored permanently, but are instantiated once per notes storage edit
/// call. The same instance receives all pre and post callbacks in that call, allowing allocations
/// to be reused across a batch edit. Instances are dropped when the call finishes.
///
/// Hooks fire around notes storage edit operations ([`NotesStorage::add_note`],
/// [`NotesStorage::remove_note`], etc.) and notes storage construction. When multiple hooks are
/// registered, they run in declaration order, each receiving the entire batch before
/// the next hook runs. Single-note edits receive one-element slices. Empty batches,
/// including edits with no existing targets, do not invoke callbacks.
///
/// For bulk edit methods, all pre hooks run before storage applies the batch, and all post
/// hooks run after the whole batch is applied. Add pre hooks follow input order; add post
/// hooks and removal hooks follow note type declaration order. Within each type, removals
/// follow id order. Update hooks follow note type declaration order, then id order.
/// Duplicate (note type, id) pairs are deduplicated, and missing notes do not trigger hooks.
///
/// Hooks receive `&mut S` and may perform further edits reentrantly, each nested edit fires
/// its own fresh hook instances (but be careful of infinite recursion).
#[allow(unused_variables)]
pub trait NotesStorageEditHook<S: NotesStorage> {
    /// Called after [`NotesStorage::rebuild_clock_time`].
    fn post_rebuild_clock_time(&mut self, storage: &mut S) {}

    /// Called after [`NotesStorage::rebuild_scroll_pos`].
    fn post_rebuild_scroll_pos(&mut self, storage: &mut S) {}

    /// Called before notes are added.
    ///
    /// `notes` may be modified; the modified values are stored.
    fn pre_add(&mut self, storage: &mut S, notes: &mut [S::NoteEnum]) {}

    /// Called after addition, with each assigned id and its note type.
    fn post_add(&mut self, storage: &mut S, notes: &[(u64, S::NoteTypeEnum)]) {}

    /// Called before removal, borrowing snapshots captured before all pre-remove hooks.
    fn pre_remove(&mut self, storage: &mut S, notes: &[S::NoteSnapshotEnum]) {}

    /// Called after removal, with the value, runtime state, and resolved timing captured before pre-remove hooks.
    fn post_remove(&mut self, storage: &mut S, notes: &[S::NoteSnapshotEnum]) {}

    /// Called before replacement.
    ///
    /// Modify the new values only; preserve ids and note types.
    fn pre_update(&mut self, storage: &mut S, notes: &mut [(u64, S::NoteEnum)]) {}

    /// Called after replacement, with snapshots captured before pre-update hooks and after storage updates.
    fn post_update(
        &mut self,
        storage: &mut S,
        notes: &[(S::NoteSnapshotEnum, S::NoteSnapshotEnum)],
    ) {
    }
}

// Recursive tuples preserve static dispatch and declaration order without allocating.
impl<S: NotesStorage> NotesStorageEditHook<S> for () {}

impl<S: NotesStorage, H: NotesStorageEditHook<S>, T: NotesStorageEditHook<S>>
    NotesStorageEditHook<S> for (H, T)
{
    fn post_rebuild_clock_time(&mut self, storage: &mut S) {
        self.0.post_rebuild_clock_time(storage);
        self.1.post_rebuild_clock_time(storage);
    }

    fn post_rebuild_scroll_pos(&mut self, storage: &mut S) {
        self.0.post_rebuild_scroll_pos(storage);
        self.1.post_rebuild_scroll_pos(storage);
    }

    fn pre_add(&mut self, storage: &mut S, notes: &mut [S::NoteEnum]) {
        self.0.pre_add(storage, notes);
        self.1.pre_add(storage, notes);
    }

    fn post_add(&mut self, storage: &mut S, notes: &[(u64, S::NoteTypeEnum)]) {
        self.0.post_add(storage, notes);
        self.1.post_add(storage, notes);
    }

    fn pre_remove(&mut self, storage: &mut S, notes: &[S::NoteSnapshotEnum]) {
        self.0.pre_remove(storage, notes);
        self.1.pre_remove(storage, notes);
    }

    fn post_remove(&mut self, storage: &mut S, notes: &[S::NoteSnapshotEnum]) {
        self.0.post_remove(storage, notes);
        self.1.post_remove(storage, notes);
    }

    fn pre_update(&mut self, storage: &mut S, notes: &mut [(u64, S::NoteEnum)]) {
        self.0.pre_update(storage, notes);
        self.1.pre_update(storage, notes);
    }

    fn post_update(
        &mut self,
        storage: &mut S,
        notes: &[(S::NoteSnapshotEnum, S::NoteSnapshotEnum)],
    ) {
        self.0.post_update(storage, notes);
        self.1.post_update(storage, notes);
    }
}