CS 170 - High-Level Programming II

Reminder: These notes will be taken down permanently on Friday, April 28, 2017. If you want to save a copy for yourself, please download them before that time.

Information

If you have any questions about any assignment, please post the questions in the CS170 Forum on the CS170 Moodle website. There are many people that can answer your question. If you just send your question to me in an email, it may be a while until (or if) I get back to you. Also, if you have a question about the assignment, it's very likely that many other students have the same question and they will benefit from the posted answers.

• Syllabus
• Office hours (office location)
• Important dates for this semester
• Digipen attendance policy
• Academic Support Center Schedule

• For those wanting to get up to speed on the Clang compiler on Windows, you can visit Johannes Peter's blog where he explains how to get Clang running on Windows: Installing Clang on Windows. Johannes is a Digipen Junior (maybe Senior) and is pretty fluent in Windows, Mac, and Linux.

References

• MSDN Academic Alliance Information about downloading Microsoft software for use on your home computer.
  NOTICE: Microsoft Office (Word, Excel, etc.) is NOT available from the MSDNAA

• Code documentation This is really old, and just to show some examples.
• Code Quality Guidelines
• Delivering code The Doxygen stuff will be required later in the course.
• Operator precedence chart for C++ with a simple ASCII chart and common printf formatting characters.
• Character representations ASCII, binary, octal, decimal, and hexadecimal
• ASCII table On the web
• comp.lang.c FAQ Answers to Frequently Asked Questions (FAQ List)
• Book Reviews from the Association of C and C++ Users. The books are reviewed by experienced C/C++ programmers. Currently, they have reviewed 151 books on beginning C/C++ and 84 books on advanced C/C++.
• JTC1/SC22/WG21 - C++ The official home of the international standardization working group for the programming language C++.
• C++ FAQ Tons of Frequently Asked Questions about C++.
• cppreference.com - A nice place to get information on C++. You can even download the entire website for off-line browsing.
• Documentation:
  • make utility
  • GCC compilers
    • ansi This turns off certain features of GCC that are incompatible with ISO C90
    • pedantic Issue all the warnings demanded by strict ISO C
  • GNU Documentation Online Includes documentation for other GNU tools cvs, gdb, etc.
  • An Introduction to GCC This is a PDF document that shows how to use the command line compiler. (It doesn't teach C/C++).
  • The man page for the gcc/g++ compiler I created this PDF using the command-line tools.
• STL References
  • The C++ Standard Library - A Tutorial and Reference An excellent book for learning and using the STL. There is also an updated 2nd edition of the book for newer C++ features.
  • Scott Meyers' books Especially Effective STL
• Programming languages ranked by popularity.

Required Software (free)

• Download the Cygwin64 programs and put them on your computer. This is the same software that you installed for CS120. If you already have that installed, then you can skip this.

  The zip file contains version 5.4.0 of the GNU C/C++ compilers and command-line utilities. The zip file is about 530 MB and extracts to about 1.5 GB. Creates a folder named cygwin64 on the C: drive.

• Don't forget to add C:\cygwin64\bin directory to your PATH. Windows 7. If you're new to computers or Windows, there's a nicer GUI (Graphical User Interface) program called Windows Environment Variables Editor that makes it easier to manipulate the PATH.
• Understanding the PATH variable from wikipedia.
• Editing the PATH variable on Windows 7, 8, and 10.
• Once you've got Cygwin installed and in your PATH, you can type this to see a better view of your PATH from the command line:

  path | tr ; "\n"

  This will list all of the directories in the PATH with each on a separate line. That is:

  Token	Meaning
  path	Displays the PATH as one long line
  |	A vertical bar (pipe symbol), usually on the key with the backslash (\)
  tr	The translate command
  ;	A semi-colon (usually to the right of the letter 'L' on the keyboard). On Linux and Mac OS X it's a colon instead.
  "\n"	A double quote, backslash, lowercase letter 'N', double quote

• GNU g++ for non-Windows users:

  Version 5.4.0 is what is installed with Cygwin on the computers at Digipen. That's also the version in the download for Cygwin. For non-Windows users, if you can't get version 5.4.0, any 5.x.x version will probably be fine. We won't be using any of the advanced features of C++ that are in 5.x, but you do want to have the closest version possible so that you will get the same errors and warnings that 5.4.0 emits.
  
  For Linux people, I recommend Linux Mint 18, which comes with version 5.4.0, although any distribution that includes that compiler version will work.

• Microsoft C++ 14.0 (Not used for grading purposes)

  This is the compiler that comes with Visual Studio 2015 and is installed here. This is supposed to be the default compiler (64-bit) when you open a command window. If it isn't, you must first type setvc14 to enable the command line tools for this version. If you want the 32-bit compiler, you need to type setvc14-32. You need to do this everytime that you open a command window. As long as you don't close the window, the command line tools will be enabled. This compiler is only necessary for you to use the memory debugger (Dr. Memory) on Windows.

  If you are having problems configuring your personal computer to use Microsoft's compiler from the command line look at this page. It's for previous versions of VS, but it should get you started. You can Google for more information or visit the Academic Support Center for more help. If you installed VS to the default directory on the C: drive, you can grab the batch file named setvc14-32.bat and setvc14-64.bat from one of the computers in Edison. The file are in the C:\utils directory (along with a bunch of others). These batch files will enable their respective compiler environments when working on the command line. You need to put them in a directory that is in your PATH.

• Dr. Memory A tool to catch memory leaks and other memory-related bugs. Works on Linux, Mac, and Windows.

mem.leaks.cpp Sample program to test out the memory debuggers. Here's a simpler one: mem.bugs.cpp.

Command line switches for Dr. Memory.

Documentation, especially how to build your program with each compiler.

A technical document from the authors of the tool. It gets a little technical, but interesting for those that might want to write their own memory debugger at some point in the (distant!) future.

• Doxygen - is a free, cross-platform, automated documentation generator. You MUST use version 1.8.6, which is what is installed at Digipen. Failure to use that version may result in a failing grade in this course. You can find this version in the 1.8.6 downloads section. Windows users should download it here: Doxygen 1.8.6

• EVEditor This will make it a little easier for students to modify the PATH (and other environment variables) on their own computers.

Other useful stuff:

• (Mostly) Free Text Editors
  • Notepad++ is a free source code editor (and Notepad replacement), which supports several programming languages, running under the MS Windows environment.
  • Sublime is a really nice source code editor (not free), which supports several programming languages, and is cross-platform (Windows, Mac, Linux).
  • jEdit is a mature programmer's text editor with hundreds (counting the time developing plugins) of person-years of development behind it. Written in Java so it runs on Windows, Linux, and Mac at least.
  • EditPad Lite is a general-purpose text editor, designed to be small and compact, yet offer all the functionality you expect from a basic text editor. Windows-only.
  • Crimson Editor is a simple source code editor for Windows.
• The Jargon File Want to know where foo came from or thousands of other computer-related terms? How about bogosity, crufty, FUD, nyetwork, RTFM, Vulcan nerve pinch, or Wintendo?
• Elements of Style (It's an old book, so you can find it really cheap on the Internet somewhere.)
  • Chapter 1 - Style and Program Organization
  • Chapter 2 - File Basics, Comments, and Program Headings
  • Chapter 3 - Variable Names
  • Chapter 4 - Statement Formatting
  • Chapter 5 - Statement Details
  • Chapter 6 - Preprocessor
  • Chapter 7 - Directory Organization and Makefile Style
  • Chapter 8 - User-Friendly Programming
  • Chapter 9 - Rules

• The tablen program. Detects tabs and long lines in files. You MUST run this on EVERY programming assignment. Here's a binary version for Linux. (The Windows version also seems to work fine under Linux with Wine). Here is a binary version for Mac OS X.

• Style Guide from CS120 When in doubt, follow the guide.

Notes

• Understanding the marks on your programming assignments. Sample report files: Good Not good
• Moving from C to C++ Points out some of the more obvious differences.
• Namespaces Introduction to program organization in C++.
• Simple I/O Overview of formatted output
• Dynamic Memory Allocation in C++ Using new and delete to allocate and free memory
• Functions Part 2. References, default parameters, overloading
• Classes Structures vs. classes, encapsulation, accessibility
• More Classes Operator overloading, conversions, friend functions, member initialization
• Even More Classes More operator overloading, default methods, copy constructors, assignment
• Yet More Classes Aggregation/containment
• Inheritance Object-orientation, base classes, derived classes
• Function Templates Type deduction, overloads, specializations
• The string Class and other STL Components (std::string, STL vectors, iterators, algorithms, etc.)
• Class Templates Type and non-type parameters, default/multiple parameters
• Exceptions try, throw, catch, exception classes
• File input/output ifstream, ofstream
• More STL 1 More containers and iterators

• These topics will NOT be on the final exam::
  • More Inheritance Polymorphism, virtual functions, abstract base classes
  • Mixing C and C++ in the same project.
  • More STL 2 More Algorithms and Function Objects
  • Mead's Guide to Modern C++ This guide demonstrates several of the new features from the C++11 and C++14 standards.
  • Mead's Guide to Lambda Expressions a.k.a anonymous functions (in C++11/14). This is a little advanced, but some students may want to check it out after the semester ends.

Homework Assignments

• Make sure that you know how to compile projects from the command line with the compilers listed above. These compilers are installed on the machines at Digipen. They are also free to download, so if you want to install them on your own computers, you can.

  Please remember that all programs absolutely, positively, MUST compile cleanly with g++. If the g++ compiler gives a warning or error, you'll get an automatic 0 on the assignment. (Note, however, that since we're using a submission server that will compile and link your code, you won't be able to submit anything with warnings or errors.)

  Sample command lines for compiling/linking source file source.cpp into hw1.exe:

  GNU g++:

    g++ -o hw1 source.cpp -Wall -Werror -Wextra -ansi -pedantic -O  
  

  Microsoft:

    cl /W4 /EHa /Za /Fehw1.exe /D_CRT_SECURE_NO_DEPRECATE source.cpp
  

• Problems from the textbook and other readings:

  Assignments, Problems and Reading (Nothing to hand in)	Due Date
  Read chapters one and two in the textbook and skim over chapter 3 as it's very similar to C. You can skim over anything that is related to C++ 11 features. I'll be discussing some of those features later in the semester. Make sure you can compile with the compilers above. Read the Code Quality Guidelines. Read the Delivering code document.	Friday, January 13, 2017
  Read Chapters 1 and 2 from The make Manual. Try to create a very simple makefile and test it. Advanced students can read more, if you're inclined. Also, take any two of your CS120 assignments/labs (e.g. spellcheck/dumpit) and create a makefile for it. This will show you if you understand the presentation I gave on using make and will prepare you for future labs.	Monday, January 16, 2017
  Browse through the LLVM (Clang) coding standards. If you think that the CS 120 Style Guide is something arbitrary and antiquated that Mead invented, think again. This is Real World™ stuff that you are learning at Digipen. This will help you look good to a potential employer in an interview (or at least you won't embarrass me!) Some of the topics we haven't talked about yet, but most of it should sound familiar to you. Note: We are not following this guide. It's just meant as an example of what a real company writing real software wants everyone to follow.	Wednesday, January 18, 2017
  In the Doxygen help file, read all of these chapters: Getting Started, Documenting the Code (only the C/C++ parts) and Lists. Those that want to use the GUI instead of the command line can read about the Doxywizard usage. Browse through these two chapters to get an idea of what Doxygen can do: Configuration and Special Commands Also, take one of your CS120 assignments (e.g. spellcheck) and Doxygenize it. This will show you if you understand how to use Doxygen.	Thursday, January 19, 2017
  Chapter 9 - Questions: #2, #3, #4	Monday, January 23, 2017
  Study Quiz #1
  Chapter 8 - Questions: #2, #3, #4, #5 (#6 in 5th edition). Programming: #2	Friday, February 10, 2017
  Study Quiz #2
  Chapter 10 - Questions: #1-6, #8, #10.	Friday, February 17, 2017
  Study Quiz #3
  Chapter 11 - Questions: #1-7.	Monday, March 13, 2017
  Chapter 12 - Questions: #1-5.	Wednesday, March 15, 2017
  Study Quiz #4
  Chapter 13 - Questions: #1-12.	Wednesday, March 22, 2017
  Read Chapter 16, pages 951-968, 978-991	Friday, March 24, 2017
  Study Quiz #5
  Study Quiz #6
  Study Quiz #7

• Programming Assignments

• Assignment Submission Page - Submit all programming assignments from this page. Here is a Doxygen template to use for the labs and assignments. You must edit this file for each lab/assignment so that it contains the relevant information (e.g. filenames, assignment/lab name/numbers).
• You can reach the Returned Folders using a browser from here.
• Spreadsheet to show you how to calculate your grade.

• Programming Assignment #1 - Due Thursday, February 9, at 10:00 pm
• Programming Assignment #2 - Due Thursday, February 16, at 10:00 pm
• Programming Assignment #3 - Due Wednesday, March 8, at 10:00 pm
• Programming Assignment #4 - Due Thursday, March 23, at 10:00 pm
• Programming Assignment #5 - Due Thursday, March 30, at 10:00 pm
• Programming Assignment #6 - Due Thursday, April 13, at 10:00 pm

• Lab and Practice Assignments

  • Data for the labs
  • Data for the practice assignments

Additional Reading Assignments (required)

• Write What You Know, and Know What You Write Advice From the C++ Experts: My best advice? Don't get fancy. Treat a new C++ feature like you would treat a loaded automatic weapon in a crowded room: never use it just because it looks nifty. Wait until you understand the consequences, don't get cute, write what you know, and know what you write. The article is a little out-dated, but most of the advice is still excellent, especially for new programmers that like to use language features that they don't really understand yet.

Interesting reading (optional)

Java vs. C++ The smart money is on C++.
• The Art of Naming Files In a well-designed system, simple things should be simple, and the “obvious easy” way to do simple common tasks should be the correct way. I call this goal “no sharp edges” — to use an analogy, if you’re designing a wrench, don’t put razor blades on the handles.

• An Interview with C++ Creator Bjarne Stroustrup It's a little advanced for CS170, but some of you might find it interesting.

• Want to work at Google? Check out Google's C++ Style Guide to give you an idea of how Google does it. Remember, it's not so much the exact style that counts in the Real World^™, it's that you adopt a style and be consistent.

  Various Compiler's C++11 support:

• Clang C++14, C++11 and C++98 Support in Clang
• GCC C++0x/C++11 Support in GCC ( C++1y/C++14 support)
• Microsoft Support For C++11 Features (Modern C++)