From 9a57e2373001b2ce82a4d6c48dcfe18b564f4f14 Mon Sep 17 00:00:00 2001 From: Loic Sharma Date: Tue, 21 Feb 2023 15:53:58 -0800 Subject: [PATCH 1/4] [Embedder API] Add 'array of pointers' guidance --- shell/platform/embedder/embedder.h | 3 +++ 1 file changed, 3 insertions(+) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index b12d41a2a3756..ff402ef542689 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -25,6 +25,9 @@ // - Function signatures (names, argument counts, argument order, and argument // type) cannot change. // - The core behavior of existing functions cannot change. +// - Be careful with arrays of structures as indexing elements may break if +// members are added to the structure. Instead, consider using arrays of +// pointers to structures. // // These changes are allowed: // - Adding new struct members at the end of a structure. From 0c46d7679c410fefc30c2aa7f89a31dd85751c47 Mon Sep 17 00:00:00 2001 From: Loic Sharma Date: Wed, 22 Feb 2023 15:09:03 -0800 Subject: [PATCH 2/4] Tweak --- shell/platform/embedder/embedder.h | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index ff402ef542689..73984daf38042 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -25,9 +25,9 @@ // - Function signatures (names, argument counts, argument order, and argument // type) cannot change. // - The core behavior of existing functions cannot change. -// - Be careful with arrays of structures as indexing elements may break if -// members are added to the structure. Instead, consider using arrays of -// pointers to structures. +// - Prefer arrays of pointers to structures instead of arrays of structures. +// This ensures indexing elements does not break if members are added to +// the structure. // // These changes are allowed: // - Adding new struct members at the end of a structure. From 12527d531b4e06d9019f44fec39b02ea8699c940 Mon Sep 17 00:00:00 2001 From: Loic Sharma Date: Wed, 22 Feb 2023 15:14:43 -0800 Subject: [PATCH 3/4] Tweak --- shell/platform/embedder/embedder.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index 73984daf38042..ec75637d36b6d 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -26,8 +26,8 @@ // type) cannot change. // - The core behavior of existing functions cannot change. // - Prefer arrays of pointers to structures instead of arrays of structures. -// This ensures indexing elements does not break if members are added to -// the structure. +// This ensures that indexing elements does not break if members are added +// to the structure. // // These changes are allowed: // - Adding new struct members at the end of a structure. From c544414a00c688af9f216ff30862b0a5232bbac8 Mon Sep 17 00:00:00 2001 From: Loic Sharma Date: Wed, 22 Feb 2023 15:15:55 -0800 Subject: [PATCH 4/4] Tweaks --- shell/platform/embedder/embedder.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/shell/platform/embedder/embedder.h b/shell/platform/embedder/embedder.h index ec75637d36b6d..60a90f45f94d5 100644 --- a/shell/platform/embedder/embedder.h +++ b/shell/platform/embedder/embedder.h @@ -25,8 +25,8 @@ // - Function signatures (names, argument counts, argument order, and argument // type) cannot change. // - The core behavior of existing functions cannot change. -// - Prefer arrays of pointers to structures instead of arrays of structures. -// This ensures that indexing elements does not break if members are added +// - Instead of array of structures, prefer array of pointers to structures. +// This ensures that array indexing does not break if members are added // to the structure. // // These changes are allowed: