csci3081/class-repo-public/labs/lab02/readme.md

Lab 2 - Compiling and Linking

A reminder that in Dr. Larson's section, attendance is required for you to receive credit for the lab.

In this lab, you are going to learn how to compile the source code and link the executable. The source code is in .cpp and .h files. The object code is in the .o files. Executables are either .out or have no extension.

In addition to practicing compilation, you will define classes and subclasses. In class exercises, we have demonstrated the basics on class definitions. The syntax of a class and subclass definition is also provided within this document.

Deliverables:

• main.cpp
• DecoyDuck.cpp
• DecoyDuck.h
• MysteryDuck.cpp
• MysteryDuck.h

In this lab, you will write and edit some C++ code, build it, and run it. Please follow the instructions below. The given source code will help you get started.

Getting Started and Words of Advice

The starting code base for this lab exercise is available in the class repo: https://github.umn.edu/umn-csci-3081F17/class-repo-public. You do not want to edit within the class repo or it will cause merge conflicts. Copy the code to your individual repo and work within that. Please follow the same directory structure such that lab02 is within the labs folder.

At each push, an automatic feedback file will be pushed to your repo.

Don't forget to pull the feedback before making more edits to your repo or you will cause merge conflicts.

The automated feedback encompasses a majority, if not all, the tests that will be used to grade your lab. Please make sure you review the feedback from your final submission to ensure it passes all the tests. Minor fixable errors can result in 0 points for the lab because automated grading fails. You are responsible for ensuring your code passes all tests in the feedback.

We will not reconsider your lab grade after the due date if the feedback file gave you information that you ignored.

Text editors designed for coding are essential. There are many good options available for free and on the cselabs machines.

Step 1: Update Your Repositories

If you did not do last week's lab, refer to lab01 for directions on how to set up git for both the class repo and your individual repo.

1. Open a terminal window.

2. Navigate to the directory of your 3081 class repo.

3. pull to get lab02 base code

4. Copy the directory into your labs directory in your individual class repo.

   mv labs/lab02 <path_to_individual_repo>/labs/.

5. Navigate into the lab02 directory in your individual repo:

Step 2: Compile the Source Code

1. Compile the .cpp files into object files.

   % g++ -c -o main.o main.cpp
   % g++ -c -o Duck.o Duck.cpp
   % g++ -c -o MallardDuck.o MallardDuck.cpp
   % g++ -c -o RubberDuck.o RubberDuck.cpp
   

   What does all this mean?

   • g++ : call to the gnu c++ compiler
   • -c : a flag to indicate compilation, as opposed to linking
   • -o : output the results of compilation into the file following this flag
   • main.cpp : the last file is the one to be compiled
   • If -c is not provided, the compiler will attempt to compile AND link.
   • If -o with an output file is not provided, the compiler will use the name of the .cpp file for the .o filename.

   Notice that each file is independently compiled, even though there are interdependencies among them. If you look in the .cpp file, there will be a #include file.h statement which essentially inserts the text of <file.h> at the location of the #include statement. Compilation will create symbol tables for all classes, variables, functions declared within those header files, but with no associated address for the definition of those elements. When the files are linked, those dependencies will be resolved and the definitions of the various objects will be included in the complete program.

Step 2: Linking to Generate the Executable

1. Link the object files into an executable: 

   % g++ -o duck main.o Duck.o MallardDuck.o RubberDuck.o

   • What does all this mean? *
   • g++ : call to the gnu c++ compiler
   • -o : output the executable into the file following this flag
   • list of files : all the files that need to be linked. -If -o and output file are not provided, the compiler will create the executable a.out

Notice there was no need to tell the compiler that we are in the linking phase.

HINT: A shortcut for linking is % g++ -o duck *.o

1. Run the program: 

   % ./duck

Step 3: Add DecoyDuck to Current Project

First, let's review the syntax for class definitions in C++. This is a simple class definition that we can think of as defining an interface for the subclasses which will inherit from Duck.

#ifndef LAB02_DUCK_H_
#define LAB02_DUCK_H_
...
#endif

This serves as a guard for the header file. If there are interdependencies among files such that the compiler is instructed to include this several times, this safeguard communicates to the compiler that this code has already been incorporated. It makes compilation more efficient, and when you have circular references or definitions within the header, it is necessary.

Duck.h

class Duck {
public:
    Duck();
    virtual void performQuack();
    virtual std::string getDescription();
};

• Duck() is the constructor with no passed parameters.
• 'virtual' indicates this can be overwritten by the subclass. When we study polymorphism, the need for virtual will become clearer.
• public: gives direct access to members and methods outside the class.
• '};' : Don't forget to conclude your definition with a semi-colon

Duck.cpp

#include "Duck.h"

Don't forget to include the Duck.h file - of course the compiler will let you know if you forget it when it tries to search for the Duck class for inheritance.

class RubberDuck : public Duck {
public:
    RubberDuck();

    std::string getDescription();
    void performQuack();
};

• class RubberDuck : public Duck is the declaration of a new class RubberDuck that inherits from the class Duck. public indicates that RubberDuck will have full access to those elements in the Duck class.
• Notice that all methods of the Duck class are restated here because they will all be overwritten by RubberDuck. Definitions of these functions are in the RubberDuck.cpp file.

main.cpp

#include "MallardDuck.h"
#include "RubberDuck.h"

Notice that we are not including Duck.h. Can you guess why we don't need it, even though we are referencing it below?

using std::cout;
using std::endl;

int main() {

    // Create Ducks
    Duck jane;
    MallardDuck maloy;
    RubberDuck lemon;

These are the instantiations of the different types of ducks. The beauty of subclasses comes into play when we can treat all types of ducks identically, so that the code chooses the appropriate method for the given type. This is polymorphism, which requires knowledge of pointers and dynamic allocation - soon to be covered.

Duck ducks[3];
ducks[0] = jane;
ducks[1] = maloy;
ducks[2] = lemon;
for (int i=0;i<3;i++) {
  cout << "This is " << ducks[0].getDescription() << " who says ";
  ducks[0].performQuack();
}

Above is an attempt to use polymorphism in C++, such that we refer to objects of different duck types in one structure using the same interface. It doesn't work because we aren't using dynamic allocation.

Step 1: Create a New Class

Your task is to add another duck subclass to this simulator, namely the decoy duck. Here is the specification:

• Name the class DecoyDuck
• The description is "a plastic decoy duck"
• It is silent, thus it says '...'

1. Create both a DecoyDuck.h and DecoyDuck.cpp file in your favorite editor (e.g. atom& DecoyDuck.h).
2. Define the class as a subclass of Duck
3. Declare the needed methods in the .h file as described in the specification.
4. Define the needed methods in the .cpp file.
5. Modify main.cpp to include a DecoyDuck in the simulation.

Note that you do not need to recompile any of the other files. It is only the linking process that must be redone. This makes compilation far more efficient, which doesn't seem like much of a time savings in our little program, but imagine a project in which the compilation takes hours!

1. Compile your new duck and link it all together.

Step 4 : Add MysteryDuck class.

Create MysteryDuck class that inherits from Duck. Create a constructor in which the user passes in the description and sound. Add this to main.cpp. Compile and link as before. Currently, Duck does not have any members. You will need variables of type string in which to save the description and sound, then use in the methods. Don't forget to hide your members from objects outside the class.

Step 5 : Push to the repository

git add *
git commit -m “adding decoy and mystery duck classes”
git push