1677549 - Add guidelines on how/where to include headers resp. forward declare things to the coding style

Status: RESOLVED FIXED

(Developer Infrastructure :: Source Code Analysis, task)

Description

[Simon Giesecke [:sg] [he/him]]

Currently, the coding style states on this topic:

Forward-declare classes in your header files, instead of including them, whenever possible. For example, if you have an interface with a void DoSomething(nsIContent* aContent) function, forward-declare with class nsIContent; instead of #include "nsIContent.h"

Given the current situation that Bug 1676346 tries to mitigate to some degree, these brief guidelines don't seem to be sufficient to keep include dependencies limited. More situations and possible mitigations should be described. Aspects that should be covered are e.g.

• interaction with the unified and non-unified builds
• IPDL files

When done, a heads-up should be given to dev-platform about this.

Comment 1

[Simon Giesecke [:sg] [he/him]]

Attachment: Bug 1677549 - Add some guidelines on include directives and header files to the coding style. r=andi,sylvestre

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/eb6cdd43ce2e
Add some guidelines on include directives and header files to the coding style. r=andi,sylvestre,asuth

Comment 3

[Natalia Csoregi [:nataliaCs]]

https://hg.mozilla.org/mozilla-central/rev/eb6cdd43ce2e

Comment 4

[Atila Butkovits]

Backed out as requested: https://hg.mozilla.org/integration/autoland/rev/2caa43dff4ee6784048667ddb26d7f098684733d

Comment 5

[Julien Cristau [:jcristau]]

beta backout: https://hg.mozilla.org/releases/mozilla-beta/rev/02897873b3a716a46950181f14d5741ef5ab568d

Comment 6

[Sebastian Hengst [:aryx] (needinfo me if it's about an intermittent or backout)]

Backout merged: https://hg.mozilla.org/mozilla-central/rev/2caa43dff4ee

Comment 7

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/6f43446c07b7
Add some guidelines on include directives and header files to the coding style. r=asuth

Comment 8

[Sandor Molnar[:smolnar]]

https://hg.mozilla.org/mozilla-central/rev/6f43446c07b7