Function prototype vs include header in cpp

Question

I have function that do some work.

A.h

void doSomething(int n);

A.cpp

#include "A.h"

void doSomething(int n) {
    /* something */
}

If I want to use this function in another source file, what is the best choice:

1) include A.h

B.cpp

#include "A.h"

void anotherTask() {
    // ...
    doSomething(5);
    // ...
}

2) or use forward declaration (function prototype):

B.cpp

void doSomething(int);

void anotherTask() {
    // ...
    doSomething(5);
    // ...
}

There are many tips about using forward declarations as often as possible for classes. So, what's the best practice for function forward declaration?

UPD

Ok, this is too easy example.

What if header A.h have some garbage (relative to B.cpp that doesn't know anything about drivers level):

A.h

#include "specific_driver_header.h" /* some lowlevel stuff that B.cpp couldn't know */

#define SPECIFIC_DRIVER_DEFINES 0xF0  /* useless define for B.cpp that uses global namespace */

void doSomething(int n);   /* only significant function for B.cpp */

If I include A.h in B.cpp then B.cpp will be not driver independent or something like that. Should I use variant (2) in that case?

score 6 · Answer 1 · answered Feb 08 '13 at 14:13

6

Always use a prototype in a header when at all possible. This prevents accidentally making changes to the one place, and not the other.

For example, where change the function to:

void doSomething(long n);

Now there are two other places: the defintion of the function, and b.cpp prototype to change.

If you have a header, the compiler will at least have a chance of telling you that "this looks wrong". Rather than you getting a linker error late on...

answered Feb 08 '13 at 14:13

Mats Petersson

126,704
14
140
227

But it has a side effect. If I change the fuction to:
'void doSomething(char n);'
and in B.cpp I have call 'doSomething(257);' - it's warning maybem not an error for IDE. (but it is error for user) – igor Feb 08 '13 at 14:50
And how is that made better by the program being made "invalid" by having an incorrect declaration? Surely warnings/errors are better than code that may not work at all? – Mats Petersson Feb 08 '13 at 16:41

score 5 · Answer 2 · edited May 23 '17 at 11:57

I use forward declaration only when the function is used only in that file.

If you want to make it available to other units you use a header file, and then you don't use forward declaration (unless you are solving a very specific problem such as circular dependencies). Don't use both. Never make the same declaration in more than one place.

Edit

Forward declaration of classes is a different case from what you asked about:

Should one use forward declarations instead of includes wherever possible?

Your update

Don't write your header files like that is the simple answer. Header files should as far as possible be self-contained, and not contain anything unrelated to the 'public' interface. (I put 'public' in quotes because when you declare a C++ class the protected and private methods have to go in the same 'public' header file. But you should still avoid putting things in the header file that don't really need to be there.)

That said, if you have no choice over the matter, it is still better to include the relevant header file than to duplicate the declaration. Maintainability is usually more important than compilation speed.

Thanks, that link is what I mean. And it confused me - all that questions concerned only about forward declaration of classes, not functions. — igor, Feb 08 '13 at 14:29

Function prototype vs include header in cpp

2 Answers2