Makefiles and Multi-file Projects

# CHAPTER 29

Makefiles and Multi-file Projects #

1. Introduction #

2. Learning Objectives #

• Separate a Class into a Header (.h) and Implementation (.cpp) file.

• Prevent duplicate inclusions using Header Guards (#ifndef).

• Compile multiple files manually in the terminal.

• Automate compilation using a Makefile.

3. Splitting a Class into Two Files #

1. 1. Header Files (.h): Contain declarations (the "Blueprint").

1. 2. Implementation Files (.cpp): Contain definitions (the "Actual Code").

#### Step 1: Create Player.h This file just tells the compiler that the Player class exists and lists its functions.

#pragma once // Prevents the file from being included twice
#include <string>

class Player {
  private:
    std::string name;
    int health;

  public:
    Player(std::string pName); // Constructor declaration
    void takeDamage(int dmg);  // Method declaration
    void displayStatus();      // Method declaration
};

#### Step 2: Create Player.cpp This file contains the actual logic. We use the scope resolution operator (::) to link the code back to the Player class.

#include "Player.h" // MUST include its own header
#include <iostream>

// Constructor Definition
Player::Player(std::string pName) {
    name = pName;
    health = 100;
}

// Method Definition
void Player::takeDamage(int dmg) {
    health -= dmg;
}

// Method Definition
void Player::displayStatus() {
    std::cout << name << " - HP: " << health << std::endl;
}

#### Step 3: Create main.cpp This is where the program actually runs.

#include <iostream>
#include "Player.h" // Include the blueprint, not the .cpp!

int main() {
    Player p1("Arthur");
    p1.takeDamage(20);
    p1.displayStatus();
    
    return 0;
}

4. Compiling a Multi-file Project #

You must compile ALL .cpp files together:

g++ main.cpp Player.cpp -o game.exe
.\game.exe

5. Header Guards (The Include Problem) #

We fix this using Header Guards (or the modern #pragma once as seen above).

Old School Header Guard (Still widely used):

#ifndef PLAYER_H
#define PLAYER_H

class Player {
    // ...
};

#endif

6. The Magic of Makefiles #

Create a file named Makefile (no extension) in your project folder:

# Makefile
# The format is: 
# target: dependencies
# [TAB] command (MUST be a real Tab, not spaces!)

# This builds the final executable
game: main.o Player.o
	g++ main.o Player.o -o game.exe

# This compiles main.cpp into an object file
main.o: main.cpp
	g++ -c main.cpp

# This compiles Player.cpp into an object file
Player.o: Player.cpp Player.h
	g++ -c Player.cpp

# A clean command to remove old compiled files
clean:
	rm *.o game.exe

Now, open your terminal and simply type:

make

The compiler will automatically figure out what files changed and only recompile the necessary parts!

7. Memory-Level Explanation (The Linker) #

1. 1. Preprocessing: #include statements are copy-pasted into the file.

1. 2. Compiling: The .cpp code is translated into Assembly.

1. 3. Assembling: Assembly is converted into binary Object Files (.o).

1. 4. Linking: The Linker takes all the separate .o files and stitches them together into the final .exe. If a function definition is missing, the Linker throws an "Undefined Reference" error.

8. Common Mistakes #

• Including .cpp files: #include "Player.cpp" is a disastrous mistake that will cause massive "Multiple Definition" Linker errors. ONLY include .h files.

• Using spaces instead of TAB in a Makefile: Makefiles are notorious for crashing if you use 4 spaces instead of a literal [TAB] key for the command lines.

9. Exercises #

1. 1. Split the BankAccount class you made in previous chapters into BankAccount.h and BankAccount.cpp, and test it in main.cpp.

1. 2. Write a basic Makefile to compile those three files together.

10. MCQ Quiz with Answers #

11. Interview Questions #

• Q: Explain the entire C++ compilation pipeline (Preprocessor, Compiler, Assembler, Linker).

• Q: What is an Object file (.o), and why are they useful in large projects?

• Q: What is the difference between #include <iostream> and #include "Player.h"? (Answer: Angle brackets search system directories first; quotes search the local project directory first).

12. Summary #

13. Next Chapter Recommendation #