CPSC 421-010 Object-Oriented Programming Spring 2025

Archive

• Week 3 Class 6 Thu Jan 30 Posted: Jan 30

  After Class

  • I made changes in Brightspace for viewing grades. It now should show the points, e.g., 10 / 10 for a crossword, instead of the overall weighted grade. It should display it this way on the Project also.

  Announcements

  • Project 1 v1a

    Scores (out of 20 possible) are in Brightspace for Project 1. The feedback is in GitHub in the Issues tab of your repository. Issues include:

    • Missing tag v1a
    • Inconsistent spacing
    • Missing changes for tag v1a
    • Inconsistent spacing around keywords
    • Declaration does not match existing code
    • Inconsistent variable name returncount
    • Inconsistent spacing around operators
    • Inconsistent return statement count label
    • Code at tag v1a does not build

    Do not expect that every part (e.g., v1b, etc.) will be graded before the next part is due. This is a straightforward part. The rest of the parts involve a lot more coding. Also, for some parts, I want to grade the parts together.

    The first step of Project 2 will be to fix these issues. You can fix these issues now or later. For small changes, I suggest now. Use a commit message that starts with "Fix". After the issue is fixed, close the issue.

  • Project 1 v1c

    Added the due date for v1c.

    The Coding Practices Task List is an issue in your GitHub repository.

  • Exercise 5: Rainfall II and Exercise 13: Rainfall III Feedback in Report23.md in the feedback main branch, scores in Brightspace.
  • Exercise 13: Header File Quiz Posted your filled-out quiz as an Assignment

  Agenda

  • Notes: XML

    You will not be asked to explain or define any XML terminology as part of any exam. However, to discuss the problem domain of the project, we require this terminology.

    You will need to understand that the parts of XML are a concern, and also that the implementation of a parser for XML is another concern. We will cover the idea of a concern later on.

  • Exercise 16: XML Crossword
  • Notes: Coding Style
  • Exercise 17: Coding Style Crossword
  • Notes: Rainfall Coding Practices

  • Exercise 18: Rainfall V

    Continuing on using the workflow from Rainfall I

    As before, you can follow along and see the commits that I make in class:

    OOPS25-Rainfall-010

  Unless otherwise noted, exercises are due by 4:30 pm on Monday, Feb 3.

• Week 3 Class 5 Tue Jan 28 Posted: Jan 28

  After Class

  • Corrected exercise numbering

  Announcements

  • Engineering, Engineering Technology, and Computing Spring 2025 Career Fair

    

    Career Fair Registration
    Registration will close on January 31, 2025, at 11:55 pm
    Date: Tuesday, February 11, 2025
    Time: 10:00 am - 2:00 pm – NOTE THE NEW END TIME (come and go between classes)
    Location: Jean Hower Taber Student Union Ballroom & 3rd Floor
    

    We are sold out for our Career Fair once again!
    The fair is for students interested in co-op, internship, and full-time placements.

    Career Fair & Interviewing Workshop
    Date: Tuesday, January 28, 2025, from 1 – 2:30 pm

    Resume Review Open House Three Sessions Offered:
    Date: Thursday, January 30. 2025
    

    • 10 am – 12 pm
    • 12 pm – 2 pm
    • 2 pm - 4 pm
  • Guide: gh default

  • CMake Presets - srcFacts on macOS

    On macOS, the libarchive library, libarchive.dylib, is already installed. You just need the proper include files.

    I added an (optional) pull request to the repos. If you accept this pull request in GitHub, and do a git pull in your cloned repositories, it will add a preset for macOS that will correctly set up the include files for libarchive. This does not use the libarchive from brew, but the version already installed on your machine.

    To use this, in your build directory, use cmake with the macos preset:

    • This does not change your CMakeLists.txt
    • It adds the file toolchain_macos.cmake to download the appropriate include files
    • It adds the file CMakePresets.json to add the preset macos that runs the toolchain
    • If you are on another platform it will not find the preset, and accepting this pull request will not cause any problems.

    We will have more presets as the semester goes on, for all platforms. So, be sure to start using this on macOS. To see what presets are available:

    Also, if you do not see a pull request, then you may have created your repository (using the GitHub Classroom Invitation Link) after I added the pull request. In that case, you already have the preset. Try it and see (if on macOS).

  • Exercise 5: Rainfall II and Exercise 13: Rainfall III Still grading
  • Project 1: srcFacts Check due dates

  Agenda

  • Notes: Git Basics

    With a few exceptions, the use of proper Git Commit messages is not a part of the grade for Project 1. However, you should try to follow the rules:

    • Essential for group projects
    • Good practice for real-world projects
    • A skill that takes practice
    • Allows me to monitor what students are working on and what they have completed
    • Allows me to assist you individually
  • Guide: Git Commands
  • Exercise 13: Header File Quiz
  • Notes: Separate Compilation
  • Exercise 14: Separate Compilation Crossword
  • Notes: Rainfall Coding Practices

  • Exercise 15: Rainfall IV

    Continuing on using the workflow from Rainfall I

    As before, you can follow along and see the commits that I make in class:

    OOPS25-Rainfall-010

  Unless otherwise noted, exercises are due by 4:30 pm on Wed Jan 29

• Week 2 Class 4 Thu Jan 23 Posted: Jan 23

  After Class

  • gh default The GitHub command-line client, gh, is very useful. However, the default repo for your GitHub Classroom clones is not your own repo, but the original that your repo was cloned from, the one I setup to generate yours. So if you do a:

    it doesn't take you to your repo at GitHub, but to the repo UACPSC/cpsc-421-oop-spring-2025-srcfacts-OOPS25-srcFacts.

    The easy fix is to reset your default. The command is:

    It will ask you to pick what you want as your default. Pick your repo. Here is an example run:

    If you want to truly automate the command and not have to pick, you can use the following:

    Note that every time you clone your repository you will have to do this.

  • srcFacts on macOS

    On macOS, the libarchive library, libarchive.dylib, is already installed. You just need the proper include files.

    I added an (optional) pull request to the repos. If you accept this pull request in GitHub, and do a git pull in your cloned repositories, it will add a preset for macOS that will correctly set up the include files for libarchive. This does not use the libarchive from brew, but the version already installed on your machine.

    To use this, in your build directory, use cmake with the macos preset:

    • This does not change your CMakeLists.txt
    • It adds the file toolchain_macos.cmake to download the appropriate include files
    • It adds the file CMakePresets.json to add the preset macos that runs the toolchain
    • If you are on another platform it will not find the preset, and accepting this pull request will not cause any problems.

    We will have more presets as the semester goes on, for all platforms. So, be sure to start using this on macOS. To see what presets are available:

    Also, if you do not see a pull request, then you may have created your repository (using the GitHub Classroom Invitation Link) after I added the pull request. In that case, you already have the preset. Try it and see (if on macOS).

  Announcements

  • Teaching Assistants
  • Exercise 9: Rainfall II Feedback and grades are not ready yet.

  • Project 1: srcFacts

    All project due dates are 11:59:59 pm.

  Agenda

  • Exercise 10: Build srcFacts

    Build and run the Project 1 srcfacts program performing the following:

    • Clone the repository and move to the repo directory (Not required if you are using GitHub Codespaces or have already cloned the repository)
    • Create the build directory - If you already have a build directory, delete it first
    • Move to the build directory
    • Create the build using cmake
    • Build the project using make
    • Run the program with the demo make run
    • Run the program with the demo directly, not using make

    • Enter the following command:

    To demonstrate this, you will record a terminal session using asciinema. It records the commands you enter and the output the command produces. asciinema is already installed in the GitHub Codespaces image. You can also install asciinema on Linux/WSL/macOS.

    asciinema is relatively straightforward to use.

    You can play, pause, skip, etc. You can also copy the commands as text. Note that the replay even includes your pauses and any delay as the command is run.

    At the end of the terminal session, asciinema will show a URL. Anybody can use this URL to view the session. This is what you will submit for the exercise to the link in the exercise title.

    IMPORTANT The URL should not contain "connect" or be a local file. Test your URL in a browser verifying that it shows the session you recorded. An incorrect URL will receive a 0.

  • Notes: Algorithmic Decomposition
  • Exercise 11: Algorithmic Decomposition Crossword
  • Notes: Rainfall Coding Practices

  • Exercise 12: Rainfall III

    Continuing on using the workflow from Rainfall I

    As before, you can follow along and see the commits that I make in class:

    OOPS25-Rainfall-010

    If you have any questions or issues, make sure to contact me.

  Unless otherwise noted, exercises are due by 4:30 pm on Fri Jan 24

• Project 1: srcFacts Posted: Jan 23

  One approach to understanding a system's source code is to count things, such as the number of statements, functions, classes, expressions, and LOC (Lines Of Code). The program srcfacts produces a report of these counts.

  Writing code in a program to directly parse C++, i.e., identify the syntactic parts of the code, is very difficult. So, the srcfacts program does not parse the C++ source code. It uses another tool, srcML, to convert the C++ source code into an XML format. The srcfacts program inputs this XML format, parses the XML while collecting counts of parts of the input code, and produces the report. The input has to be in the srcML format, e.g., demo.xml, however it can be compressed or part of an archive, e.g., demo.xml.zip, linux.xml.gz.

  The srcfacts.cpp program is one large, main() function using almost no design features. It is extremely fast; for example, it can produce a report on the entire Linux kernel (verison 6.13, 60,392 source-code files, an 4.7 GB file in the srcML format) in under 8 seconds. However, in its current form, it is not easy to debug the XML parsing, add additional program element counts, or even understand what is going on. It includes code for parsing all parts of XML, but it would not be easy to adapt the XML parsing code for another purpose, e.g., another report. The only way to reuse this code is by copy/paste reuse. Overall, it has the following:

  Design Characteristic	Level
  Scalability	Very High
  Performance	Very High
  Portability	Medium
  Usability	Medium
  Modularity	Very Low
  Extensibility	None
  Reusability	None
  Maintainability	None

  Your task is to take the srcfacts code, improve the overall design, and extract the XML parsing part of the code. When completed, a set of functions in the files xml_parser.hpp and xml_parser.cpp will handle as much XML parsing as possible, while the main program, srcfacts.cpp, generates the report using the XML parser functions for parsing.

  • You do not have to understand how to parse XML. You are only repackaging XML parsing code, not writing from scratch.
  • The existing code is brittle, so you need to work carefully not to break the code
  • The repository includes example input
  • Keep in mind all aspects of design as we discuss them in class

  The steps (in order) with the associated (git) tag are:

  Tag v1a: Without changing the design, add the code necessary for the report to include the number of return statements. First see how the other counts are collected, then use it as a guide. Do not make any other changes to the project. The heading in the table must be "Returns". Due Jan 28

  Tag v1b: Move the refillContent() function into the separate refillContent.hpp and refillContent.cpp files. The build is already configured for these files. Due Jan 31

  Tag v1c: Apply the specific design changes from the Coding Practices Task List (an issue in your repository). As you verify that the code follows the practices given, check them off. Once you have completed all of them, close the issue. Due Feb 4

  Tag v1d: Extract a set of (free) functions to handle the low-level details of the XML parsing. Extract one function at a time, i.e., each commit can only include a single extracted function. Due TBA

  Tag v1e: Add the necessary code to count the number of line comments and literal strings. The headings in the table must be "Line Comments" and "Strings". Due TBA

  Your repository for this project is through GitHub Classroom, with a link on the Brightspace course page.

  • Projects in this course build on each other. Failure to complete Project 1 will impede progress on Project 2.
  • Steps must be completed in order, e.g., Step v1a must be completed before Step v1b.
  • Your code must compile with both g++ and clang. An easy way to verify is with GitHub Codespaces.
  • Be sure to follow the good practices we discuss in class
  • There are no classes or structs created for this project. You are extracting a set of free functions. Any class you create to solve this problem now would not solve the primary problem of how the srcFacts code uses an XML parser.
  • The main() handles XML errors (invalid XML format) with a direct return 1; so the program exits with the status of 1. To exit the program from within any function, use exit(1); which requires the include file stdlib.h.
  • While you can create and use other branches, only the work on the main branch counts. The main branch is the default when you git clone and git checkout.
  • The code uses the library libarchive to input compressed and archive files, e.g., linux-6.6.xml.gz and demo.xml.zip. To install it on Linux, use sudo apt-get install libarchive-dev. To install it on macOS, use brew install libarchive. The GitHub Codespaces image already has libarchive-dev installed.

  General Guidelines

  • Code must compile and build
  • Do not change the existing format of the output
  • Do not add or commmit your build directory
  • Follow the programming style of the existing code. Do not change the indentation style.
  • Follow all guidelines given in class

• Week 2 Class 3 Tue Jan 21 Posted: Jan 21

  Special Announcement

  Class Meeting 3 on Tuesday, Jan. 21, is remote. We will meet via Teams during class meeting time.

  The class meeting should appear on your Teams calendar. If not, there is a direct link in Brightspace.

  Announcements

  • Office Hours Online via Teams. Contact me via chat on Teams.

  • Exercise 5: Rainfall I

    • I posted a feedback report, Report1.md, in your repository under the branch feedback. I strongly suggest looking at it on GitHub:

    • I posted the scores and any additional comments in Brightspace

    Report1.md Example report.

    Points were taken off for:

    • Differences between your code for a commit and my code in the example
    • Not following the exact format of the header comment
    • Typos in words
    • More than 2 commits
    • Wrong form of the action in the commit message. It is "Add", not "Added", "Adding", or "add".

    Also, do not use term "assignment" or "exercise" in your code. We simulate working on real code.

    If you have spacing or wording to fix, you can fix them. However, these commits must start with the word "Fix". Not "Fixing", "Fixed", or "fix", but "Fix".

  • Guides

  • Exercise 6: Development Environment Setup Results

    If you do not have cmake 3.31 or later, you will have problems with further exercises and the projects. Follow my Development Environment Setup instructions. If you have issues or problems setting it up, do not ignore it.

  Agenda

  • Notes: Software Design Characteristics
  • Exercise 7: Software Design Characteristics Crossword
  • Exercise 8: For Statement Quiz Performed during class.
  • Notes: Rainfall Coding Practices

  • Exercise 9: Rainfall II

    Continuing on using the workflow from Rainfall I

    As before, you can follow along and see the commits that I make in class:

    OOPS25-Rainfall-010

    If you have any questions or issues, make sure to contact me.

  Unless otherwise noted, exercises are due by 4:30 pm on Wed Jan 22

• Week 1 Class 2 Thu Jan 16 Posted: Jan 16

  After Class

  • Remote Teaching In anticipation of the forecasted cold and possible extreme wind chills, class on Tuesday, Jan. 21, will be remote. We will meet via Teams.

    The class meeting should appear on your Teams calendar. If not, there is a direct link in Brightspace.

  Announcements

  • Grades for Exercises 1 & 2 are in Brightspace
  • OOP Survey Results
  • Development Environment: Tools Follow the directions in the guide to set up your development environment. Department servers have older versions of g++ and cmake, so do not rely on them.

  Agenda

  • Guide: GitHub Authentication
  • Setup for Exercise 5: Rainfall I
  • Notes: Software Design
  • Exercise 3: Software Design Crossword Due by 4:30 pm on Friday, Jan 17

  • Exercise 4: Statement Design Quiz

    • Completed during class
    • Each solution in a question produces the same result
    • Must choose the "best" choice, and state why it is better
    • If you complete the Design Quiz, you will get full credit for Exercise 4
  • Notes: Rainfall Coding Practices

  • Exercise 5: Rainfall I

    You can follow along and see the commits that I make in class:

    OOPS25-Rainfall-010

    If you have any questions or issues, make sure to contact me.

  • Exercise 6: Development Environment Setup

  Unless otherwise noted, exercises are due by Noon on Mon Jan 20

• Exercise 5: Rainfall I Posted: Jan 16

  Take the starting rainfall.cpp code and make the same changes that I make in class.

  Your code is in a repository from GitHub Classroom:

  1. Log in to your GitHub account.
  2. Click on the invitation link (GitHub Classroom Rainfall) on the main course page in Brightspace.
  3. Follow the directions to link your GitHub account to your UA ID.

  Environment

  1. Local

     This would be on your own machine with local files.

     First, you need to authenticate your local environment with GitHub: Guide: GitHub Authentication. This only has to be done once per environment, e.g. WSL on Windowws.

     Then you clone the repository. Cloning creates a local repository that is a copy of your repository at GitHub.

     You can get the repo link from the button <> Code button on GitHub, then under Local and HTTPS.

     Cloning a repository creates a directory with the name of your repository, e.g., _rainfall-_. To work on the files, you need to move into that directory:

  2. GitHub Codespaces

     GitHub Codespaces provides a development environment in the browser. When you create one from your GitHub Repository, you are already authenticated with GitHub and have a clone repository. So you can start working right away

     You can start a Codespace from the <> Code button on GitHub, then under Codespaces.

  Build Setup

  Git Workflow on Rainfall

  1. Edit files locally, e.g., add a header comment to the file rainfall.cpp
  2. Build, run, and check your work
  3. View your changes
  4. Commit current changes to the local repository:
  5. Push your local commits to the GitHub repository:
  6. View and verify your changes at GitHub in your browser Do not skip this verification
  7. View your commits locally

  Note Your code must build and compile. If you have a build warning or error, fix these before making any more changes to the code.

  Note You must commit each change that I make separately and use the exact commit message that I use in class

• Week 1 Class 1 Tue Jan 14 Posted: Jan 14

  Announcements

  • Syllabus

  • GitHub We use GitHub and GitHub Classroom in the class to manage source code for projects, exercises, and examples. You are required to have a GitHub account.

    Optionally, you can apply for the Student Github Developer Pack and get a free GitHub Pro account. To apply, your account email can be a school account, or a personal account if you upload documents to prove your current enrollment status.

  • GitHub Codespaces All exercises and projects include GitHub Codespaces as an option. It runs in and browser and offers a development environment with Visual Studio Code, along with a shell to enter commands for building (compiling and linking) and running your program. It automatically clones your GitHub repository. However, it does not automatically save your code changes back to GitHub; you must use git commands to do so.
  • Development Environment: Tools While GitHub Codespaces is great for short-term exercises, you'll want to work on long-term projects directly on your computer. Follow the instructions in the guide to set up your development environment. Department servers have older versions of g++ and cmake, so avoid relying on them.

  • O'Reilly Online Learning The course textbook is available in O'Reilly Online Learning.

    You do not have to be on the campus network (e.g., via VPN) to access O'Reilly Online Learning.

    To access content, click the "Institution not listed?" link below the dropdown and enter your UA email. You will then create an account and use that account from now on.

    For more information: Library LibGuide

  Agenda

  • Exercise 1: OOP Survey

  • Exercise 2: Course Content Crossword

    1. Fill out the crossword in your browser. Do not print and fill out on paper.
    2. Print to a PDF using the Print Button or the Print feature in your browser. Try to include the headers and footers in the PDF.
    3. Upload the PDF of the completed crossword to Brightspace in Assessments/Assignments.
  • Notes: Software Design

  Unless otherwise noted, exercises are due by 4:30 pm on Wed Jan 15

• Welcome Posted: Dec 19

  Greetings and welcome to CPSC 421 Object-Oriented Programming (OOP) for Spring 2025.

  • Syllabus The syllabus for the course is on the main course page. It is a draft that I will finalize before our first class meeting.
  • Survey The first exercise is to fill out the class survey. The survey is due after our first class meeting, but you can complete it before.
  • Development Environment Development Environment: Tools is a guide for setting up your programming development environment for the class. It is good to start early as you will need this early in the course.

  • GitHub In the class, we use GitHub and GitHub Classroom to manage source code for projects, exercises, and examples. You are required to have a GitHub account.

    Optionally, you can apply for the Student Github Developer Pack and get a free GitHub Pro account. To apply, your account email can be a school account or a personal account if you upload documents to prove your current enrollment status.

  See you on Tuesday, Jan 14 at  9:15 - 10:30 am in (CAS) room 136