1748874 - Require MOZ_CAN_RUN_SCRIPT to go to declarations

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Code Analysis, defect)

Description

[Kagami Rosylight [:saschanaz] (they/them)]

For example, https://phabricator.services.mozilla.com/D135160?id=525055 put it all to .cpp and it seems nothing warns about it.

Comment 1

[Sylvestre Ledru [:Sylvestre]]

to be clear, you would like a linter doing some kind of

if grep -q MOZ_CAN_RUN_SCRIPT *.cpp; then
   echo "please move MOZ_CAN_RUN_SCRIPT into the header files" 
   exit 1
fi

?

Comment 2

[Kagami Rosylight [:saschanaz] (they/them)]

It's a little bit complex than that, the thumb rule is that the declaration should get it, not the definition. That means there's no problem if the definition itself is a declaration.

// No problem, everything is good
MOZ_CAN_RUN_SCRIPT static void foo();

static void bar() { // MOZ_CAN_RUN_SCRIPT error as expected
  foo();
}

static void foo();

static void bar() {
  foo(); // !! bar() doesn't know foo is MOZ_CAN_RUN_SCRIPT
}

MOZ_CAN_RUN_SCRIPT foo() {};

Comment 3

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1748874 - Part 1: Mark the decl of HTMLCanvasElement::CallPrintCallback as CAN_RUN_SCRIPT r=masayuki

Comment 4

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1748874 - Part 2: Mark SessionStoreUtils method decls as CAN_RUN_SCRIPT r=masayuki

Depends on D135400

Comment 5

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1748874 - Part 3: Mark the decl of SessionStoreRestoreData::RestoreInto as CAN_RUN_SCRIPT r=masayuki

Depends on D135402

Comment 6

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1748874 - Part 4: Move MOZ_CAN_RUN_SCRIPT to declarations in dom/streams r=mgaudet

Depends on D135403

Comment 7

[Kagami Rosylight [:saschanaz] (they/them)]

Attachment: Bug 1748874 - Part 5: Require CAN_RUN_SCRIPT to be at the first declaration r=masayuki

Depends on D135404

Comment 8

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/12073baa49f0
Part 4: Move MOZ_CAN_RUN_SCRIPT to declarations in dom/streams r=mgaudet

Comment 9

[Alexandru Michis [:malexandru]]

https://hg.mozilla.org/mozilla-central/rev/12073baa49f0

Comment 10

[Kagami Rosylight [:saschanaz] (they/them)]

(There are other patches)

Comment 11

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/018d59d42d1d
Part 1: Mark the decl of HTMLCanvasElement::CallPrintCallback as CAN_RUN_SCRIPT r=masayuki
https://hg.mozilla.org/integration/autoland/rev/eb8e0e968c3b
Part 2: Mark SessionStoreUtils method decls as CAN_RUN_SCRIPT r=masayuki
https://hg.mozilla.org/integration/autoland/rev/69cf4aea9436
Part 3: Mark the decl of SessionStoreRestoreData::RestoreInto as CAN_RUN_SCRIPT r=masayuki
https://hg.mozilla.org/integration/autoland/rev/418b53fbd23d
Part 5: Require CAN_RUN_SCRIPT to be at the first declaration r=andi

Comment 12

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/018d59d42d1d
https://hg.mozilla.org/mozilla-central/rev/eb8e0e968c3b
https://hg.mozilla.org/mozilla-central/rev/69cf4aea9436
https://hg.mozilla.org/mozilla-central/rev/418b53fbd23d