1448138 - rename DataFlags::SHARED to REFCOUNTED

Status: RESOLVED FIXED

(Core :: XPCOM, enhancement)

Description

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

Per IRC conversation in #developers this morning, I think it would be clearer if we renamed DataFlags::SHARED to REFCOUNTED.  See starting at https://mozilla.logbot.info/developers/20180322#c14502459

Comment 1

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

Attachment: Rename string DataFlags::SHARED to REFCOUNTED to make it clearer to those reading the code

MozReview-Commit-ID: 1mJuwY5dQkj

Comment 2

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

I presumably need to separate out the changes in servo/ and make a servo PR, but let's start with all-in-one-patch for review. :-)

Comment 3

[Eric Rahm [:erahm]]

Comment on attachment 8961549 [details] [diff] [review]
Rename string DataFlags::SHARED to REFCOUNTED to make it clearer to those reading the code

Review of attachment 8961549 [details] [diff] [review]:
-----------------------------------------------------------------

Thanks, that's definitely clearer.

::: servo/support/gecko/nsstring/src/lib.rs
@@ -139,5 @@
>          #[repr(C)]
>          pub struct DataFlags: u16 {
>              const TERMINATED = 1 << 0; // IsTerminated returns true
>              const VOIDED = 1 << 1; // IsVoid returns true
> -            const SHARED = 1 << 2; // mData points to a heap-allocated, shared buffer

Maybe rephrase the comment to say "shareable ref counted buffer" or something to that effect

::: xpcom/string/nsTSubstring.cpp
@@ +120,5 @@
>  
>    //
>    // several cases:
>    //
> +  //  (1) we have a shared buffer (this->mDataFlags & DataFlags::REFCOUNTED)

Ditto on this comment.

::: xpcom/tests/gtest/TestTArray2.cpp
@@ +627,5 @@
>    do {                                                    \
>      ASSERT_FALSE(IS_USING_AUTO(arr));                     \
>    } while(0)
>  
> +#define CHECK_USES_REFCOUNTED_EMPTY_HDR(arr) \

This is unrelated to strings, it can be reverted.

Comment 4

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

https://treeherder.mozilla.org/#/jobs?repo=try&revision=1d3068d9bf00126bef0ef8b8b53101fbc48dde2a&group_state=expanded

Comment 5

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

https://github.com/servo/servo/pull/20407

Comment 6

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

https://hg.mozilla.org/integration/mozilla-inbound/rev/5b91410deb5b02599f99e67a615b613bf7b9971b
Bug 1448138 - Rename string DataFlags::SHARED to REFCOUNTED to make it clearer to those reading the code.  r=erahm

Comment 7

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

servo half landed in https://github.com/servo/servo/commit/5a42c6cf7254dd2def4f3a0503b5dfb00711a506 and thus https://hg.mozilla.org/integration/autoland/rev/2f7ddde0e2cc

Comment 8

[Cristina Coroiu [:ccoroiu]]

https://hg.mozilla.org/mozilla-central/rev/5b91410deb5b