开发者

What is the fundamental difference between source and header files in C?

I don't quite understand how things should be separated in C's source and header files. I often see many projects with two sets of files with the same name (an extension denotes a source and another donates a header file).

So far, from this lack of understanding, when I've written 开发者_JAVA百科libraries, I've chucked all the class and class method code into one file, with indecision as to choosing the file extension.

What should be in headers and what should be in the source files? How do I implement this separation?


There is no technical difference. The compiler will happily let you include a .c file, or compile a .h file directly, if you want to.

There is, however, a huge cultural difference:

  • Declarations (prototypes) go in .h files. The .h file is the interface to whatever is implemented in the corresponding .c file.

  • Definitions go in .c files. They implement the interface specified in the .h file.

The difference is that a .h file can (and usually will) be #included into multiple compilation units (.c files). If you define a function in a .h file, it will end up in multiple .o files, and the linker will complain about a multiply defined symbol. That's why definitions should not go in .h files. (Inline functions are the exception.)

If a function is defined in a .c file, and you want to use it from other .c files, a declaration of that function needs to be available in each of those other .c files. That's why you put the declaration in a .h, and #include that in each of them. You could also repeat the declaration in each .c file, but that leads to lots of code duplication and an unmantainable mess.

If a function is defined in a .c file, but you don't want to use it from other .c files, there's no need to declare it in the header. It's essentially an implementation detail of that .c file. In that case, make the function static as well, so it doesn't conflict with identically-named functions in other files.


What should be in headers and what should be in the source files?

Typically headers contain one or more of the following:

  • Function declaration (except statics)
  • Variable declaration (typically global)
  • User defined type declaration (read struct, union etc.)
  • Macro definition

Source files on the other hand have:

  • Function/variable definition
  • Static function declaration and definition (you don't want to expose these to your clients)
  • Variable definition
  • Some prefer to define inline functions (C99) in a header

How do I implement this separation?

The One Definition Rule is your friend.

Remember, if you are writing a library, this is what your client gets to see. So, be helpful and provide all the information you can for them to use your library. The source files are typically compiled and supplied in binary form.

And by the way, C does not have the concept of classes.


Usually, header files contain declarations, source files contain code.

So, if in source file A.c you need a function implemented in source file B.c, you just include B.h to have its declaration.


There is little fundamental difference between .c and .h files (though some compilers may refuse to compile a raw .h file). The difference is more by convention.

Typically the .h file provides the API and the .c provides the implementation.

Therefore the .h file would contain only things needed by other source files to access the facilities provided by your .c file. So the .h files would provide the function prototypes of global functions, declarations of global variables (if you really must have them), and the structures and other types used by them. (Don't expose a structure if the only a pointer to the structure is required by the API.)

In-line functions are also often included in .h files but some coding guidelines prefer the use of a separate extension (e.g. .inl)

All other function implementations, the definition and initialisation of variables and declarations of local (static) variables and functions would be in the .c file.

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜