How do I properly #include?

Can anyone point me to a detailed site to explain how to #include headers for a properly coded program? Or just explain it to me in this forum. I have four classes and a main function. The complier keeps telling me that it does not understand class names and because of that, it does not understand many different statements within my program.

main.cpp (wherever Foo Class is needed)

Code:

#include "Foo.h"

someFunction()
{
    Foo bar();
    ...
}

Foo.h (Class Definition)

Code:

class Foo {...};

Foo.cpp (Class Implementation - Headers needed for class go here too)

Code:

#include "Foo.h"

Foo::Foo() {...}

Include is used like including a header to the project. Like
[CODE]
#include <iostream>
#include <windows.h>
#include <string>
etc.
[CODE]

I like to include all of my headers in a header file called include.h like many people do.

It sounds like Yukumo is talking about your own headers, not library headers. And you should not put all includes in a file called include.h unless those includes are used almost everywhere in your program. Try to include each and every header you need, but no more.

Major Small - I've always just used a "classname.h" or used two seperate `.h`s if I wanted to separate the definition of the class and the definition of the functions in that class.
Is that ok? I think I read something about a separate .h and .cpp in a book I have...

Thank you, all of you. But I need more input. Take this code for example from my coplayer.h file.

Code:

#ifndef COPLAYER_H
#define COPLAYER_H

class CoPlayer
{
public:
	CoPlayer(Card* recieveHand, SpadGame* pGame);
	short playTurn(const Card cardsOnTable[]);
	//*************************************************************************
	// The spade variable in these search functions will be to tell the function 
	// whether it includes the spade's suit in search for aces or not.
	void findAce(bool spade);
	void selectCard1();
	//*************************************************************************
	short chosenCardPos;
private:
	SpadGame* game;
	const Card* hand;
};

#endif

The compiler will not understand what "Card" and "SpadGame" are. I need to #include their class header files, but where shall I place the #include statements? Shall I put them at the top of the header file above the "#ifndef COPLAYER_H" statement? Or should I put it just below the "#define COPLAYER_H" statement? The only other option that I can think of would be to place the #include statements in the file coplayer.cpp. But if there, should they be placed above or below the "#include coplayer.h" statement?

> Or should I put it just below the "#define COPLAYER_H" statement?

Normally, this is the correct place to put your #includes.

In this case, you only use pointers to these types in this header file, so you do not need to include the entire header file. Instead a forward declaration would work, and be better to avoid potential recursive includes and make compile times faster. A forward declaration would look like this:

Code:

#ifndef COPLAYER_H
#define COPLAYER_H

class Card;
class SpadGame;

class CoPlayer
{

You would then have to #include the headers in your coplayer.cpp file, since code in that file will probably use the Card and SpadGame classes.

Daved, your reply was wonderful. My compiler errors shrank to five. But I am hoping you or someone else can help me with my lesser problem now. Each place that I have a declaration of a Card class, the compiler tells me that the "Card" class is undefined. I'll use my deck class as an example.

Code:

#ifndef DECK_H
#define DECK_H

class Card;

class Deck
{
public:
	Deck();	// Constructor
	~Deck();	// Deconstructor
	void shuffleAndDeal();	// Function to shuffle and deal the appropiate amount of cards to each player
	Card* getPtrOfPlayerHand(short);
	void Organize();

private:
	Card playOneCards[13];	// Enough space for player #1's cards
	Card playTwoCards[13];	// Enough space for player #2's cards
	Card playThrCards[13];	// Enough space for player #3's cards
	Card playFouCards[13];	// Enough space for player #4's cards
};

#endif

Should I replace the forward declaration with [color = red]#include "card.h"[/color]? Or is there a more efficient way to correct this code? Again, your help was and is greatly appreciated.

Assuming that compiling your Deck.cpp is what is giving the undefined error and it is pointing at a line in Deck.h, then sure, go ahead and use the #include instead of the forward declaration. It is not a big deal, just a minor preference. I'm assuming that the arrays inside the class are what is causing the entire Card class declaration to need to be included.

Originally Posted by Nazca

Major Small - I've always just used a "classname.h" or used two seperate `.h`s if I wanted to separate the definition of the class and the definition of the functions in that class.
Is that ok? I think I read something about a separate .h and .cpp in a book I have...

it's perfectly fine, but generally, .h files should include definitions and .cpp files should include implementations.

putting your entire class into a .h file is fine, but it voids the rules of encapsulation, or data hiding. what encapsulation means that, basically, I should only need to tell you this:

Code:

int foo(double in); //in is truncated and returned as an int

the point is, you don't need to know how it does anything, just what it does.

encapsulation is one of the fundamental concepts of Object-Oriented Programming.

I have a general gist of encapsulation/need-to-know basis, but the idea is that the coder can look at the .h file and not worry about the .cpp file at all? Like a an unofficial standard.

Good stuff. Thank you.