CPSC 421-020 Object-Oriented Programming (OOP) Spring 2023

Archive

• Finals Week

  • Project 4 Scores and feedback posted:

    • Scores and Feedback in Brightspace
    • TemplateReport.md in repo
    • HandlerReport.md in repo

    Please review the feedback as it may relate to your UML.pdf part of the XMLFramework Project, and the material on implementing extension points for the Final Exam.

  • XMLFramework Project

    • Your XMLParser reads from standard input, or file descriptor 0. If you want to read from a file, then you can redirect from the file to file descriptor 0. An example program, filein.cpp shows how to do this.

    • The number of @TODOs which are optional/extra credit is 6. It doesn't matter which ones these are.

• Week 15 Class 28 Thu Apr 27 Posted: Apr 27

  Announcements

  • Exercise 78: Library You may have needed to use sudo for some commands, including copying the library to /usr/local/lib and using ldconfig.

  • XMLFramework

    Your XMLParser reads from standard input, or file descriptor 0. If you want to read from a file, then you can redirect from the file to file descriptor 0. An example program, filein.cpp shows how to do this.

    Instead of posting which @TODOs are optional, I will decide on the number that become optional. For now, that number is 6, as in 6 of the @TODOs count as Extra Credit. It doesn't matter which ones they are.

  • CheatSH A utility for shell command "cheat sheets". For the cheat sheet of ldd:

    Discovered this morning through the console weekly digest of developer tools.

  • Notes: Libraries Added the soname commands and packaging
  • Project 4 I will update the course page as I grade
  • Finals Week Will post links and any updates to the course page
  • Office Hours By appointment only during Finals Week
  • Final Exam
  • Course Evaluations Open through Apr 30

  Class

  • Notes: Proxy
  • Exercise 80 Proxy Design Pattern Crossword
  • Notes: Message Queue
  • Exercise 81 Message Queue Design Pattern Crossword
  • Notes: Conclusion

  All exercises are due by 4:30 pm on Fri Apr 28

• Week 15 Class 27 Tue Apr 25 Posted: Apr 25

  After Class

  • For Exercise 78: Library, you may need to use sudo for some commands, including copying the library to /usr/local/lib and using ldconfig.

  • XMLFramework

    Your XMLParser reads from standard input, or file descriptor 0. If you want to read from a file, then you can redirect from the file to file descriptor 0. A example program, filein.cpp shows how to do this.

  Announcements

  • Final Exam
  • XMLFramework Project

  Class

  • Exercise 76: XMLFramework @TODO

    Make sure your XMLFramework has at least one @TODO completed.

  • Notes: C++ Templates
  • Exercise 77: C++ Templates Crossword

  • Notes: Libraries

    OOPS23-Libraries

  • Exercise 78: Library

    This exercise is optional as I will drop the lowest Exercise score.

    In an asciinema terminal session, perform the following on the Increment example in Linux using gcc.

    All commands must be typed in (not copy and pasted). Be sure to remember to use tab completion for filenames.

    1. Compile each source file separately
    2. Link the object files into an executable incr
    3. Run the executable incr
    4. Create a static library for increment()
    5. Show what is in the static library
    6. Link the static library to the executable incr
    7. Run the executable incr
    8. Create a shared library for increment()
    9. Link the shared library to the executable incr
    10. Run the executable incr showing that it cannot find the library
    11. Show the shared libraries that incr uses
    12. Use LD_LIBRARY_PATH so that incr can find the shared library
    13. Install the shared library into /usr/local/lib
    14. Show that incr still cannot find the library
    15. Run ldconfig
    16. Run the executable incr showing that it can find the library
    17. Show what libraries incr uses

    When completed, submit your asciinema URL

  • Exercise 79 Libraries Crossword

  All exercises are due by 4:30 pm on Wed Apr 26

• Week 14 Class 26 Thu Apr 20 Posted: Apr 20

  Special Announcement

  Class is in-person on Thursday, Apr 20. See you in our regular classroom.

  Announcements

  • Project 3 Scores posted in Brightspace, along with the diagram feedback
  • Final Exam
  • XMLFramework Project

  Class

  • Exercise 73: Build XMLFramework

    Create your XMLFramework repository using the GitHub Classroom link on Brightspace.

    Then do the following in an asciinema session:

    1. Clone the repository
    2. Create a build subdirectory
    3. Generate a build using cmake
    4. Build the program
    5. Execute the xmlpipeline program using the target run
    6. Directly execute the xmlpipeline program (without using make)

    Submit your resulting asciinema URL using the link in the title of the exercise.

  • Exercise 74: XMLFramework Quiz

    Take the XMLFramework Quiz. You only have one chance to get the answers right.

  • Notes: Design Pattern Visitor

  • Exercise 75: Visitor Design Pattern Crossword

  • Docker Guide

  All exercises are due by 4:30 pm on Fri Apr 21

• XMLFramework Project Posted: Apr 19

  The project is a critical part of your overall grade in the course, and parts of the project count toward 25% of the questions on the Final Exam. Consider this as a take-home part of the Final Exam. No matter how you performed on the previous projects, you need to work on this project.

  The project is due by 11:59:59 pm on Friday, May 5. The project consists of the following:

  • Parsing XML with a variety of push and pull parsers
  • XPath evaluation - XPath is an addressing language for XML
  • XSLT transformation - XSLT is a transformation language for XML
  • Combining these operations as needed by the applications

  The open-layered architecture framework, XMLFramework, supports all of this and includes:

  • Applications
    • Applications using XMLFramework
    • xmlpipeline.cpp - CLI for using the framework
  • XMLFramework
    • As described above
  • XMLToolkit
    • Set of C++ classes for processing XML
    • Used to implement XMLFramework, but can be used directly
    • Where your XMLParser lives
  • XMLLibrary
    • Set of C functions for processing XML
    • Used to implement the XMLToolkit, but can be used directly

  There is a lot of code in the project already. The primary task is to finish the remaining @TODOs. Some examples are:

  // @TODO Add to the factory method so that it generates the correct parser
  // @TODO Apply encapsulation and information hiding
  // @TODO Apply the const specifier to methods where applicable
  // @TODO Create a Filter that outputs XML statistics
  // @TODO Declare a XMLParserHandler for XMLParser to use
  // @TODO Declare the class XMLParserDocumentHandler which inherits from XMLParserHandler
  // @TODO Enforce that no one can inherit from XPathFilter
  // @TODO Implement the XMLDocumentHandlerParser 
  // @TODO Integrate use of XMLDocumentHandlerParser into this method
  // @TODO Make it so that there is only one parser object in the entire
  // @TODO Remove any unused include files
  // @TODO Remove need for destructor definition
  // @TODO Remove unused include files
  // @TODO Replace this code with a call to the action of the class MacroFilter
  // @TODO Replace with an instance of a MacroFilter
  // @TODO Use override where appropriate
  

  The @TODOs that involve integrating your XMLParser into the framework are not required and, if completed, will count as extra credit for the projects.

  The work involved is:

  • (50%) Complete any @TODOs
  • (20%) Fill in all classes @pattern and @role comments. A class can participate in multiple roles in multiple patterns.
  • (10%) Document the use of design patterns in the markdown file DESIGN.md. Each instance of a design pattern in XMLFramework must be listed, including the collaborators.
  • (10%) Document the architectures used in the XMLFramework in the markdown file ARCHITECTURE.md
  • (10%) Draw a UML diagram of the entire project in the file UML.pdf

  Notes:

  • The GitHub Classroom invitation link is on Brightspace.
  • The answers to some questions on the Final Exam are from your work on this project. E.g., instead of creating a UML diagram during the Final Exam, your UML diagram from this project is your Final Exam answer. You must do these parts as they also count toward the Final Exam.
  • The project has a complete CMake build. You can add files to the subdirectories, and the CMake build will handle them automatically. Each file in the apps directory is assumed to be a single executable. Make sure you also commit and push the files to GitHub if you add files. Always verify at GitHub that the correct files are there.
  • In XMLFramework, the app, xmlpipeline, uses CLI11 for parsing command-line options. When you run cmake, the file is downloaded. Depending on many settings in Windows, the download may be unsuccessful and quietly result in an empty file. If this happens, let me know.
  • To quickly find code, git grep works well. For all the lines of code that contain @TODO, enter the command git grep "@TODO" in the project's top directory. To see only the filenames, git grep -l "@TODO". The command depends on the directory where you issue the command, e.g., if in the directory framework; the results are for that directory and its subdirectories. A command for a comprehensive report of which @TODOs are left: More on this command
• Final Exam Posted: Apr 19

  The Final Exam is in our regular classroom Final Exam: May 4, 2:30 - 4:30 pm.

  You are responsible for the following:

  • UML multiplicity, generalization (inheritance), composition, and aggregation. Understand the difference between composition and aggregation and when we would use one over the other.
  • Extension points: Three implementations: A) Direct inheritance from a Base class, B) Inheritance from Handler used by a Base class, C) C++ Templates. Be able to compare and implement at least two of these approaches on a small code example.
  • RAII - What it means, why it is important, how to implement
  • Coupling - Definition, why decoupling is important
  • Dependency Injection - general concepts
  • Encapsulation & Information Hiding - Given code, show how to improve the code to support both.
  • Dispatch: Static vs. Dynamic, Given code and output, change code to generate the proper output
  • Extra: vtable and how it works

  The exam has various problem types, including short answers, definitions, comparisons, drawing diagrams, and coding.

  Questions are from what I covered in class, the book, the exercises, and the projects. If I did not cover it in class, it is not on the exam.

  The following exam answers are taken from your work on the XMLFramework Project. You will not answer them on the Final Exam

  • UML multiplicity, generalization (inheritance), composition, and aggregation. Know the syntax of the diagrams for each. Given code, state the relationship, and draw a UML diagram.
  • Design Patterns - general concepts, specific patterns: Template Method, Factory Method, Composite, Command, Adapter, Facade, Singleton.
  • exception handling Given exception handling code, show the result. Add exception handling to a code example.
  • Software Architecture: Layered, Pipe & Filter - Given a problem, compare and contrast solutions using these two architectures.
  • C++ Inheritance specifiers: override and final
  • C++ Constructor Specifiers: explicit, mutable, default, delete

• Week 14 Class 25 Tue Apr 18 Posted: Apr 18

  Special After Class

  Return to in-person classes on Thursday, Apr 20. See you in our regular classroom.

  Special Announcement

  2023 CEPS Design Day on Tuesday, Apr 18 is cancelled, and UA switched to remote learning late Monday night.

  In order to reserve time for a rescheduling of the 2023 CEPS Design Day, we will have class on Tuesday, Apr 18.

  Class will be remote via Teams.

  My Office Hours will remain the same as normal (1 - 2pm and 4:45 - 5:15pm) but will be via Teams.

  Announcements

  • Project 4 Due date is extended to Wed, Apr 19.

  Class

  • Notes: Software Architecture

  • Exercise 70: Software Architecture Crossword

  • Notes: Design Pattern Facade

  • Exercise 71: Facade Design Pattern Crossword

  • Notes: Design Pattern Singleton

  • Exercise 72: Singleton Design Pattern Crossword

  • Docker Guide

  All exercises are due by 4:30 pm on Wed Apr 19

• Week 13 Class 24 Thu Apr 13 Posted: Apr 13

  Announcements

  • 2023 CEPS Design Day on Tuesday, Apr 18

    The Computer Science presentations are from 2 - 4 pm, and I encourage you to attend.

    This time period conflicts with the afternoon CPSC 421-020 OOP and CPSC 480 SE sections, so we will not have a class meeting on Tuesday, Apr 18. However, I will post a short screencast for viewing.

    During the morning CPSC 421-010 OOP class time, 10:45 - Noon, I will be in my office for Office Hours. So my Office Hours on Tuesday, Apr 18, are:

    • 10:45 am - Noon
    • 1 - 1:45 pm
    • 4:15 - 5:15 pm

  • Project 3

    Added issues for v3identity.

    Note that Project 4, part v4a, is to fix XMLParser issues. So you do not have to fix any identity or xmlstats issues, and only fix the ones in XMLParser (which I already posted).

  • Inline member functions for abstract classes

    At the design level in UML Class Diagrams, we often have abstract classes:

    

    When we implement, we have a couple of choices in C++. We can use a pure virtual method

    or an empty method:

    In this case, it is preferred to have the definition in the include file, i.e., an inline member function, instead of a separate declaration and definition. The reason is that we want the class user to see that it is empty and that they should override it if they want it to do anything. We are not using an inline member function just because the method definition is short. So this is an exception to the rule.

  Class

  • Notes: Design Pattern Adapter - Object Adapter Consequences
  • Notes: Design Pattern Strategy
  • Exercise 67: Strategy Design Pattern Crossword
  • Notes: PIMPL
  • Exercise 68: PIMPL Crossword
  • Notes: Dependency Injection
  • Exercise 69: Dependency Injection Crossword
  • Docker Guide

  All exercises are due by 4:30 pm on Fri Apr 14

• Week 13 Class 23 Tue Apr 11 Posted: Apr 11

  Announcements

  • Project 3
    • I posted all of the issues for v3a and v3xmlstats
    • Scores are not posted

  Class

  • Notes: C++ Inheritance Specifiers
  • Exercise 63: C++ Inheritance Specifiers Crossword
  • Notes: Design Pattern Composite
  • Exercise 64: Composite Design Pattern Crossword
  • Notes: C++ Constructor Specifiers
  • Exercise 65: C++ Constructor Specifiers Crossword
  • Notes: Design Pattern Adapter
  • Exercise 66: Adapter Design Pattern Crossword

  All exercises are due by 4:30 pm on Wed Apr 12

• Week 12 Class 22 Thu Apr 06 Posted: Apr 06

  After Class

  • Project 3
    • I posted all of the issues for v3a
    • I posted all of the issues for v3xmlstats
    • Scores are not posted
  • I did not complete the notes for C++ Inheritance Specifiers in section 020, so the crossword is not due until after the next class

  Announcements

  • CPSC 480 Software Engineering

    The department is offering two sections of CPSC 480 SE in Fall, 2023.

    There will be no sections of CPSC 480 SE in Spring, 2024. So if you need CPSC 480 SE to graduate in Spring 2024, you will have to take it in the Fall.

  Class

  • Project 4
  • Notes: SOLID
  • Exercise 61: SOLID Crossword
  • Notes: Design Pattern Command
  • Exercise 62: Design Pattern Command Crossword
  • Notes: C++ Inheritance Specifiers
  • Exercise 63: C++ Inheritance Specifiers Crossword Due by 4:30 pm on Wed Apr 12

  All exercises are due by 4:30 pm on Fri Apr 07

• Project 4 Posted: Apr 05

  Project 4 continues the work on srcFacts. It is due at 11:59:59 pm Tuesday, Apr 18 Wednesday, Apr 19, and involves the following stages:

  1. Tag "v4a": Correct the issues in XMLParser that affect srcFacts, xmlstats, and identity

  2. Tag "template": Redesign XMLParser to use the Template Design Pattern. In this pattern, extension points are virtual methods. Create a new class srcFactsParser (in the new files srcFactsParser.hpp and srcFactsParser.cpp) that inherits from class XMLParser. Do the same thing for the new class IdentityParser (in the new files IdentityParser.hpp and IdentityParser.cpp) and the new class XMLStatsParser (in the new files XMLStatsParser.hpp and XMLStatsParser.cpp). Add these classes to the repository, e.g., git add srcFactsParser.hpp, and update the CMakeLists.txt file so that they are part of the build (search for the term "sources"). Update your class and sequence diagrams to show this new design.

     As before, your XML parser needs to provide access to all parts of XML via the following extension points (i.e., virtual methods) from XML notes slide 34

     • Start Document
     • XML Declaration: version, encoding, standalone
     • Element Start Tag: qName, prefix, localName
     • Element End Tag: qName, prefix, localName
     • Characters: characters
     • Attribute: qName, prefix, localName, value
     • XML Namespace: prefix, uri
     • XML Comment: value
     • CDATA: characters
     • Processing Instruction: target, data
     • End Document
  3. Tag "handler": Extract a handler from XMLParser called XMLParserHandler, a new class that only handles the user-defined processing (what we previously had as callbacks). Put the entire XMLParserHandler class in the file XMLParserHandler.hpp. Change srcFactsParser, IdentityParser, and XMLStatsParser to inherit from XMLParserHandler instead of XMLParser, and rename them replacing "Parser" in the name with "Handler". You can rename a file using git, e.g., git mv srcFactsParser.hpp srcFactsParserHandler.hpp. Update your class and sequence diagrams to show this new design.

  One prevalent issue in these conversions is that changing XMLParser and srcFacts will cause identity and xmlstats to break until they are converted. To avoid this, first, understand that make is a synonym for make all and builds all executable targets. So instead of building all executable targets, build them separately as needed, e.g., make srcfacts, make xmlstats, or make identity.

  Keep in mind:

  • You are required to implement these steps in the order given, i.e., tag v4a, tag template, and then tag handler
  • At every commit, make sure the project compiles, builds, and produces the correct answer. Note that it may be only one of the executable targets builds during conversion.

• Week 12 Class 21 Tue Apr 04 Posted: Apr 04

  Announcements

  Class

  • Notes: Handlers
  • Exercise 58: Handlers Crossword
  • Notes: Design Pattern: Factory Method
  • Exercise 59: Design Pattern: Factory Method Crossword
  • Notes: API
  • Exercise 60: API Crossword

  All exercises are due by 4:30 pm on Wed Apr 05

• Week 11 Class 20 Thu Mar 30 Posted: Mar 30

  Announcements

  Class

  • Notes: rValue References
  • Exercise 53: rValue References Crossword
  • Notes: Errors and Exception Handling
  • Exercise 54: Errors and Exception Handling Crossword

  • Exercise 55: std::exception Hierarchy Crossword

  • Exercise 56: Exceptions

    Take the code for ExceptionsDemo.cpp and perform the following changes:

    • Change the maximum length in function g() to 200 in both the code and the output message
    • Change the "not allowed" value from 50 to 75 in function h() in both the code and the output message
    • Change the domain of function f() to allow the negative value -1 (-2 and smaller is still not allowed)

    Run the program once for each exception, and show that the exception is thrown.

    To demonstrate these changes, you will record a terminal session using asciinema. It records the commands that you enter and the output the command produces.

    After you install asciinema on Linux/WSL/macOS, it is quite straightforward to use.

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

    At the end of the terminal session, asciinema will show a URL. This URL can be used by anybody to view the session. This is what you will submit for the exercise to the link in the exercise title. The URL should not contain "connect" or be a local file. Incorrect URLs will receive a 0.

    You can use GitHub Codespaces for this exercise. Since asciinema is not installed, take a look at asciinema Running from source.

    To build the ExceptionsDemo:

    Use the GitHub Classroom Exceptions invitation link in Brightspace.

  • Exercise 57: Constructor Exceptions

    Upload an asciinema URL of the following session. As previous, the URL should not contain "connect" or be a local file. Incorrect URLs will receive a 0.

    Perform the following: and run the RAIIDataMembers program (part of the GitHub Classroom Exceptions):

    1. Build the program RAIIDataMembers
    2. Run the program with a value where an exception is not thrown. Note the message output shows the destructor is called.
    3. Run the program with a value where an exception is thrown. Note the message output shows the destructor is not called.
    4. Run valgrind on the program to show there is a memory leak. Since valgrind produces a large amount of output, filter the call using the following command:
    5. Change the program to use a std::vector<int> for the field data instead of a c-array.
    6. Run valgrind (with the filter) to show that there is now no memory leak, even when an exception is thrown.

    You can do all of this in one terminal session, or break it into two. The submission form (in the link of this exercise) has both.

  All exercises are due by 4:30 pm on Monday, Apr 3

• Week 11 Class 19 Tue Mar 28 Posted: Mar 28

  Announcements

  • Project 3 For a lambda function, if you have many variables to capture you can capture all variables in scope using the capture default [&]. Only do this if you are going to pass a high percentage of the variables in scope (see Stamp Coupling).

  • Project 3 Pass std::string_view as an IN parameter by value, not const reference:

    std::string_view consists of a pointer (to the actual memory) and a size and is equivalent to the following:

    Since this is so small, passing by value is efficient. While it takes the same number of assembly operations, it requires an extra pointer dereference, and timings show they are equivalent. The general guide is to pass by value when the object is 16 bytes or less.

  Class

  • Notes: Virtual Destructors

  • Exercise 50: FileIO

    The program ReadFile supports multiple ways to read from standard input. You run the program with the option on the command line. The options include get, read, and fileread:

    

    All is well and good, but the program has memory leaks with some options. Use valgrind to determine what the problem is, fix it, and commit your fix. Do not make any other changes.

    Valgrind performs dynamic analysis, which means it collects data during the execution of a program. For valgrind, running with one option (e.g., using the option get) may find an issue, but running with another option (e.g., using the option read) may not. To be sure, we have to run the program with all options.

    The build command is:

    To run with valgrind for option get:

    That command is a single line displayed using the line continuation character ("\"). You can copy and paste the entire command.

    You must run the command with each option, get, read, and fileread.

    The fix consists of only one change to the code. Your code must pass with a clean valgrind report for all three options.

    The GitHub Classroom link is in Brightspace.

  • Notes: Design Patterns
  • Exercise 51: Design Patterns Crossword
  • Notes: Design Pattern Template Method
  • Exercise 52: Design Pattern Template Method Crossword
  • Notes: rValue References

  All exercises are due by 4:30 pm on Wed Mar 29

• Week 10 Class 18 Thu Mar 16 Posted: Mar 16

  After Class

  • GitHub GitHub is experiencing "degraded performance" with Git Operations. You can check the status of GitHub via the GitHub Current Status.

    In general, this should only effect git pull or git push. A git commit is performed in the local repository (that you cloned). The timestamp on a commit is based on when you made the commit, not when it was pushed.

    Other parts of the status that may be applicable are Pull Requests, Issues, and Codespaces. If you see problems with Pages that means that you can still access the course pages (course pages are hosted in GitHub Pages), but I may not be able to update the pages.

  • Project 3 If you have a large number of variables to pass via capture, you can pass all of them (and all variables in scope) using the capture default, [&].

  • Project 3 Pass std::string_view as an IN parameter by value, not const reference:

    std::string_view consists of a pointer (to the actual memory) and a size and is equivalent to the following:

    Since this is so small, passing by value is efficient. While it takes the same number of assembly operations, it requires an extra pointer dereference, and timings show they are equivalent. The general guide is to pass by value when the object is 16 bytes or less.

  Announcements

  • Midterm

    Midterm scores and feedback are posted in Brightspace:

    • Overall score in Grades under Midterm
    • Copy of your test as a pdf in Assignments under Midterm Feedback
    • Scores and feedback for each question as a pdf in Assignments under Midterm Feedback

  • Project 3

    • You are allowed one @stereotype get method for total bytes.

  Class

  • Notes: UML Association
  • Exercise 46: UML Association Crossword
  • Notes: UML Generalization
  • Exercise 47: UML Generalization Crossword
  • Notes: Dispatch
  • Exercise 48: Dispatch Crossword

  • Exercise 49: Base

    virtual methods in C++ support dynamic polymorphism. Dynamic polymorphism only occurs with pointers and references to objects, passing by value is not polymorphic.

    

    The classes in this exercise are Base, Derived which inherits from Base, and DerivedDerived which inherits from Derived. So Derived is a Base, and DerivedDerived is a Derived and therefore also is a Base.

    The method m1() is not virtual, so it does not provide for polymorphism.

    The method m2() is virtual, so it does provide for polymorphism.

     

    Complete the assertions in the code that indicate (via a string) which method is called, e.g., for m1() is it "Base::m1()", "Derived::m1()", or "DerivedDerived::m1()"?

    Complete each assertion one at a time in order, compiling and running the program (i.e., make run) after each assertion is completed. The assertion you edited should pass, and you should be onto the next assertion.

    You are required to commit for each block of statements in the main program.

    The GitHub Classroom link is in Brightspace.

  All exercises are due by 4:30 pm on Monday, Mar 27

• Week 10 Class 17 Tue Mar 14 Posted: Mar 14

  After Class

  • Project 3

    • To convert from an int to std::string, use std::to_string().
    • You are allowed one @stereotype get method for total bytes.

  Announcements

  • Project 2 Entered v2a scores, so total score is now out of 100
  • Project 3

  • IoC Fixed diagram comparison:

    • IoC Slide 4 DockerReport to YAMLParser
    • IoC Slide 9 YAMLParser to YAMLParser IoC

  Class

  • Notes: UML Class Relationships

  • Exercise 36: UML Class Relationships Crossword

    Exercise number is out-of-sequence because I moved some of the notes around

  • Notes: Dependencies
  • Exercise 44: Dependencies Crossword
  • Notes: Coupling
  • Exercise 45: Coupling Crossword
  • Notes: UML Association

  All exercises are due by 4:30 pm on Wed Mar 15

• Week 9 Class 16 Thu Mar 09 Posted: Mar 09

  Announcements

  • Project 2 If you had tag issues, then I am working on getting the issues/scores updated.
  • Class Meeting Numbers may be incorrect. Working on a fix.

  Class

  • Notes: RAII

  • Exercise 40: Memory I

    The file Memory.cpp in the repository Memory contains many memory resource problems described in the notes.

    Compile and run the program on your platform (i.e., your compiler and operating system). You may or may not see a memory-related issue during the build and run.

    Go to a system where you can run valgrind. Following the instructions in the Guide: Valgrind, compile and run valgrind on the program.

    Fix the memory resource problems in Memory.cpp without using std::unique_ptr. Do this for each section one by one committing each section separately. Get the code to the point where it compiles and runs successfully, and you have a clean Valgrind run. Once done, tag this in Git as fixmemory

    The Memory repository is available via GitHub Classroom with a link on the Brightspace course page.

  • Exercise 41: Memory II

    Replace the raw pointers (e.g., int* p) with std::unique_ptr<int>. Ensure it runs successfully on all compilers and you have a clean Valgrind run. The include file for std::unique_ptr is <memory>. Once done, tag this in Git as smartpointer

  • Notes: IoC
  • Exercise 42: IoC Crossword
  • Project 3: IoC

  • Exercise 43: Lambda

    Following my example in class, create a lambda function for each section.

    The GitHub Classroom link is in Brightspace.

    OOPS23-lambda-020

  All exercises are due by 4:30 pm on Monday, Mar 13.

• Project 3 Posted: Mar 09

  The main problem with the design for the srcFacts project is the complicated section of code (large while loop with nested-if) surrounding the srcFacts concerns. We have moved much of the low-level parsing details out of srcFacts.cpp (and into XMLParser), but that overall code structure remains.

  Change the design of XMLParser to use full IoC (Inversion of Control). IoC lets you move the large while loop with nested-if entirely into an XMLParser method parse(). The only things that srcFacts will have to do (and the only public methods of the new XMLParser) are the parse() method and (depending on your implementation) methods to register handlers.

  Your XML parser needs to provide access to all parts of XML, even if srcFacts does not use it, via the following extension points from XML notes slide 34

  • Start Document
  • XML Declaration: version, encoding, standalone
  • Element Start Tag: qName, prefix, localName
  • Element End Tag: qName, prefix, localName
  • Characters: characters
  • Attribute: qName, prefix, localName, value
  • XML Namespace: prefix, uri
  • XML Comment: value
  • CDATA: characters
  • Processing Instruction: target, data
  • End Document

  There is no explicit stage to fix the code from the Project 2 feedback. Fix any style issues in XMLParser, or any issues that will cause a problem with Project 3.

  Tag v3a: Redesign XMLParser to use IoC with lambda handlers for the extension points. For srcFacts, this means that the lambda functions in srcFacts.cpp contains all the processing of the XML data results, e.g., tag names with none of the XML parsing. Update your Class Diagram and Sequence Diagram to reflect this new design. Rules apply:

  • Each extension point has a single handler
  • All data passed to the handlers must be via parameters
  • Handlers cannot call XMLParser methods

  Tag v3xmlstats: Create the application xmlstats that produces a markdown report (similar to what srcFacts does) that indicates the number of each part of XML. E.g., the number of start tags, end tags, attributes, character sections, etc.

  Tag v3identity: Create the application identity which is an identity transformation. A transformation is a program that converts data in one format to data in a related format, typically the same format. In this case, it converts from XML to XML. It is an identity transformation because the output XML should be the same (as much as possible) as the input XML. The XMLParser will parse the input, and your callbacks will output the XML format. You can assume that there are no CDATA parts, but you must escape all >, <, and & in Character and CDATA content.

  Note: Any changes to XMLParser must work with srcFacts, xmlstats, and identity:

  • You cannot have a special XMLParser for each application
  • Any srcFacts, xmlstats, or identity-specific concerns cannot remain in XMLParser

  All tags for Project 3 are due Friday, Mar 31.

  Keep in mind:

  • Complete tag v3a first. After that, you can complete tags v3xmlstats and v3identity in any order.
  • I will provide pull requests for the programs xmlstats and identity that add the needed files to the build.
  • At every commit, ensure the project compiles, builds, and produces the correct answer.

• Midterm Exam Tue Mar 07 Posted: Mar 03

  Midterm In our regular classroom

• Week 8 Class 15 Thu Mar 02 Posted: Mar 02

  After Class

  • Project 2 Feedback for v2b - v2e are in GitHub Issues. I am still working on the feedback for v2a. In the meantime, I will post the scores for v2b - v2e as soon as I can.

  • xml_parser.hpp Not clear if there were issues not created or not completed, but in grading Project 2 (post v2a) I am finding a lot of things in xml_parser.hpp that are not for the user of the functions, but for the implementor.

    Let me make this very clear. The only things allowed in the file xml_parser.hpp are:

    • Header comment
    • Include guard
    • #include <string_view>
    • #include <string> (if used as a parameter or return type, leave out if std::string is not used)
    • #include <optional> (if used as a parameter or return type, leave out if std::optional is not used)
    • Another include file, only if used as a parameter or return type
    • Namespace definition for the xml_parser functions
    • Function declarations for xml_parser functions
    • Function comments for xml_parser functions

    Anything else does not belong in the .hpp file. The purpose of the .hpp file is not so you can compile the corresponding .cpp file. It is for the user of your functions, e.g., srcFacts.cpp. So cluttering it up with declarations and includes that are only needed in the .cpp file is extremely bad design. In the case of xml_parser, this includes any of the following:

    Having any of these in your xml_parser.hpp file adds unnecessary dependencies and hurts comprehension.

  Announcements

  • Midterm Midterm Exam next class period
  • Project 2 I am not done grading v2a. In the meantime, I opened up Project 2 so I can give feedback to those with missing tags or broken builds.

  • Exercise 24: DesignFun II Is graded with any feedback in Brightspace

    Note that using both min() and minimum() together lack naming clarity. For example, which is which? Pick one and stick to it.

  • Exercise Due Date Note special due date
  • Office Hours from 4:45 - 5:15 pm today are cancelled.
  • Guide: Names Feedback

  Class

  • Exercise 36: Declaration Cohesion

    Follow along in class. The GitHub Classroom link is in Brightspace.

    Notes: Cohesion

    OOPS23-DeclarationCohesion-020

  • Exercise 37a: Convert II

    Follow along with the design changes in class. This is part (a), with part (b) later in the class meeting.

    OOPS23-convert-020

  • Notes: Lambda Functions
  • Exercise 38: Lamba Functions Crossword

  • Exercise 37b: Convert II

    Follow along with the design changes in class as we apply lambda functions.

    OOPS23-convert-020

  • Notes: RAII
  • Exercise 39: RAII Crossword

  All exercises are due by 4:30 pm on Wednesday, Mar 8 (day after the Midterm)

• Week 8 Class 14 Tue Feb 28 Posted: Feb 28

  After Class

  • Project 2

    I am not done grading v2a. In the meantime, I opened up Project 2 so I can give feedback to those with missing tags or broken builds.

  • Exercise 24: DesignFun II Is graded with any feedback in Brightspace

    Note that using both min() and minimum() together lack naming clarity. For example, which is which? Pick one and stick to it.

  Announcements

  • Midterm
  • Project 2 Pull Request Pull request to add XMLParser files to the build

  • Exercise 31: Member Initialization List

    • Report.md in GitHub (main branch)
    • No errors or warning allowed
    • Must use member initialization list as much as possible
    • For multipleFields.cpp, you must use the initialization list for both fields
    • When changing the design, do not leave the old code commented out

  • Include File Guard Name

    The convention we follow for include guard names, technically, a preprocessor macro, is to:

    • turn all characters to uppercase
    • replace the extension . with _
    • (optionally) use the prefix INCLUDED_`.

    E.g., xml_parser.hpp has the include guard name INCLUDED_XML_PARSER_HPP.

    Some have added extra _s to separate words in the filename. Basically, this is replacing camelCase with under_score. If these extra underscores are added, then the file XMLParser.hpp would have the include guard name INCLUDED_XML_PARSER_HPP, and xml_parser.hpp would have the identical include guard name. So the rule is to not add extra underscores, so the include guard name for XMLParser.hpp is INCLUDED_XMLPARSER_HPP.

    Do not use filenames with the same characters where the only difference is the case of a letter, e.g., XMLParser.hpp and xmlparser.hpp. Some UNIX filesystems are not case sensitive for filenames, e.g., macOS APFS.

  Class

  • Exercise 33: Convert

    Follow along in class. Be sure to mark and update concerns as we go along.

    Make the first commit where you add the concerns.

    The GitHub Classroom link is in Brightspace.

    OOPS23-convert-020

  • Notes: Multiplicity
  • Exercise 34: Multiplicity Crossword

  • Exercise 35: Names

    

    The UML Class Diagram shows Name with attributes that are single-value optionals.

    Convert the source code class to use std::optional instead of the pair of std::string and a flag.

    The link for GitHub Classroom is in Brightspace

    Note: The type String in a UML Class Diagram does not necesarily map to a std::string in a C++ program. It could map to a std::string_view, or even a c-string. Which source-code type a UML type maps to is part of the code implementation, and not part of the model

  All exercises are due by 4:30 pm on Wed Mar 01

• Midterm Posted: Feb 28

  The Midterm Exam is during class time in our regular classroom on Tuesday, Mar 7.

  You are responsible for the following:

  Software Design - Definition, the two types of design (so far), where they come from, what they are concerned with Software Design Characteristics - Know the list of characteristics Algorithmic Decomposition - Explain what it is and how it works Structure Diagram Given code or description, draw. Coding Style Given function declaration or definition, improve the code using the principles we discussed in class Generalizing Functions - Given an example, explain what we could do to generalize it Physical Organization - Include guards, header comments, function comments, separate function declaration, and definition, the contents of each type of file Naming & Method Naming Standards - Given a list of names, correct the poor names Iterator - Four basic operations in GoF terms and C/C++ operators Free-Function Stereotypes - Know the terms and be able to write a free function for each stereotype UML Sequence Diagram Given a scenario, be able to draw a sequence diagram XML Know what is and what is not an XML concern Concerns - Definition, separation of concerns, be able to identify concerns Cohesion - Definition UML Class Diagram - C++ code ⇨ diagram, diagram ⇨ C++ code, single class only (no relationships) Encapsulation and Information Hiding - Definition of each, the encapsulation rule and the information hiding rules. Member Initialization List - Order of field creation, proper use of member initialization list Note that method stereotypes and callbacks are not on the exam.

  The exam has various problem types, including short answers, definitions, comparisons, drawing diagrams, and coding.

  Questions are from what I covered in class, the book, the exercises, and the projects. If I did not cover it in class, it is not on the exam.

• Week 7 Class 13 Thu Feb 23 Posted: Feb 23

  After Class

  • Project 2 Pull Request Pull request to add XMLParser files to the build
  • Sign In There was no Sign In sheet for this class meeting.
  • Exercise 31: Member Initialization List Make sure to move all fields to the member initialization list.

  Announcements

  • Project 1 Feedback as issues, scores in Brightspace. The comments include the number of points per part, e.g., v1a.
  • Project 2 I created a pull request to add diagram files. You may not have a pull request if you already have the files.
  • Exercise DesignFun II Not graded yet

  Class

  • Notes: Encapsulation
  • Exercise 30: Encapsulation Crossword
  • Notes: Constructors and Initialization

  • Exercise 31: Member Initialization List

    Following my example in class, convert all the constructors in all files to use member initialization lists.

    CMake builds an executable for each .cpp file.

    The GitHub Classroom link is in Brightspace.

    OOPS23-member-initialization-lists-020

  • Notes: Callbacks
  • Exercise 32: Callbacks Crossword

  All exercises are due by 4:30 pm on Monday, Feb 27

• Week 6 Class 12 Thu Feb 16 Posted: Feb 16

  After Class

  • Office Hours No Office Hours on Tuesday, Feb 21

  • Project 1

    • The overall scores are posted in GitHub. Per-part scores will be entered soon.
    • The v1c issues are out. I still have manual ones to add.
    • The detection of v1c issues depends on you following directions, and completing (and tagging) v1c before working on v1d.
    • The numbers for the use of auto and const are for the main() of srcFacts.cpp. That code should have moved to xml_parser.cpp as part of v1d, so you will have to make the auto and const changes in those files.
    • You can fix and close issues for v2a in any order, e.g., you can fix and close v1d and v1e issues before v1c issues
    • Reviewed and updated all "Rename …" issues
    • If you have closed all current issues for v2a and want to start on v2b, you can go ahead and finish any v1c issues later (after I post them)

  • Exercises

    • Note the special due date of Tuesday, Feb 21 at 4:30 pm for current exercises
    • Exercises 24 & 25 are graded

  Announcements

  • Project 1

    I started posting issues in GitHub as feedback for Project 1. Issues for tag v1a were posted previously. Will most likely get v1b, v1d, and v1e posted by class time. I have to fix the scripts for v1c. There may be additional issues as it goes along.

    Scores in Brightspace will be added later.

    Monitor the course page for After Class notes as I will post when I have things finished.

    Make sure to review the process for fixing and closing these issues as described in Project 2, i.e., wait until after class.

  • Viewing Indentation

    To view indentation, as in some GitHub issues and the generated reports, use the following command:

    To view different files, change the filename in the cat command

  • Exercises 24 & 25 I did not finish grading these exercises yet. Most likely will not get to them until Monday.

  Class

  • Notes: Namespaces
  • Notes: UML Class Diagrams

  • Exercise 27: Create a UML Class Diagram

    Create a UML Class Diagram at yuml.me for the class diagram on the right.

    Compose your class diagram at yuml.me. The resulting contents of the box on yuml.me will go into the file ClassDiagram.txt in the GitHub Classroom Repository (link in Brightspace. You should be able to copy the contents of the file ClassDiagram.txt and paste it into the editing box at yuml.me and see the diagram on the right.

    Your final result should look exactly like the image shown here. The style used for the image is Boring, instead of the default Scruffy or Plain.

    Make sure to commit after each of the following parts:

    • Name of the class
    • Attributes
    • Operations

    Note that yuml.me can be temperamental. Add iteratively and carefully.

    

  • Exercise 28: UML Class Diagram Crossword
  • Notes: Method Stereotypes
  • Exercise 29: Method Stereotypes Crossword

  All exercises are due by 4:30 pm on Tuesday, Feb 21

• Project 2 Posted: Feb 16

  Continue to improve the design of srcFacts using more language features. There are no changes to the functionality of this project, only to the design.

  In addition to the following code changes, you will maintain two modeling diagrams:

  • A UML Class Diagram, ClassDiagram.txt, to model the class you create. This means showing the UML form of all fields/data members and member functions. The format for the diagram class diagram is the text yuml.me format.
  • A UML Sequence Diagram, SequenceDiagram.svg, to model the relationship and control between srcFacts.cpp, the xml_parser functions, and the class XMLParser. In particular, you need to show the same function/method calls used for each part. The sequence diagram for the sequence diagram is at sequencediagram.org. Make sure to export and save it as SVG.

  The diagrams must be updated to reflect the code for each tag. So do not tag until the part is done and the diagrams are updated.

  Tag v2a Implement and close all issues I created as feedback from Project 1. When you finish fixing an issue, there must be at least one commit that describes what you are changing. Create a tag for that commit in the form issueN tag where N is the issue number, e.g., when you complete issue1, create the tag issue1. Do not refer to the issue number in the commit message, only in the tag. For the sequence diagram, add your calls' exact function names and (UML form of) parameters to the xml_parser. Due Feb 23

  Tag v2b Create a namespace, xml_parser, for the functions in xml_parser. This will involve making changes to the files srcFacts.cpp, xml_parser.hpp, and xml_parser.cpp. Due Feb 24

  From this point on, do not make any changes to the files xml_parser.hpp or xml_parser.cpp.

  Tag v2c Create the class XMLParser in the files XMLParser.hpp and XMLParser.cpp where the methods call the free functions from xml_parser.hpp. Do not use any fields/data members. The method parameters must be identical to the parameters of the free functions in xml_parser.hpp. For the sequence diagram, add the XMLParser as a participant and show how it is involved between srcFacts and xml_parser. Due Feb 28

  Tag v2d Eliminate any parameters in the XMLParser methods that you can, replacing them with field/data members in the class. In other words, move as many XML parsing variables from srcFacts.cpp as possible. Do this one field/data member at a time. For the class diagram, show the added fields and the removal of parameters. For the sequence diagram, update the parameter lists of the calls to the XMLParser. Due Mar 3

  Tag v2e Inline the calls to the xml_parser free functions into your XMLParser methods. Inlining the calls does not mean adding the inline specifier, and it does not mean changing anything in XMLParser.hpp. Do this one free function call at a time. Ultimately, your XMLParser.cpp should have no calls to xml_parser functions and will not need to include xml_parser.hpp. Do not make any changes to the files xml_parser.{hpp,cpp}. For the sequence diagram, remove the xml_parser participant and any calls. Due Mar 3

  Ensure the project compiles, builds, and produces the correct answer at every commit with gcc and clang.

  There is a zero-tolerance policy for the following. A zero-tolerance policy means that you will receive a zero for that part if any of the following are violated:

  • At every tag, v2a, v2b, v2c, v2d, and v2e, the program must compile and build in gcc and clang without errors or warnings.
  • All data members/fields must be private
  • No mention of srcML or use of specific srcML element names (or attribute names/types) in the files XMLParser.hpp, XMLParser.cpp, xml_parser.hpp, nor xml_parser.cpp.

• Week 6 Class 11 Tue Feb 14 Posted: Feb 14

  Class

  • DesignFun Feedback

    • (2 points) Comments
      • No @return if return type is void
    • (2 points) Parameter passing
      • IN parameters Direction and C++ Parameter Types

      • Ex1 Ex2

      • Guide: Benchmarks
    • (6 points) Naming
      • Notes: DesignFun Feedback
      • Notes: Free-Function Stereotypes
      • Notes: Naming
      • Notes: Method Naming Standards

  • Exercise 24: DesignFun II

    Go over your answers and fix them according to the guidelines given.

  • Notes: Event States
  • Notes: Sequence Diagrams

  • Exercise 25: Create a Sequence Diagram

    Create a sequence diagram at SequenceDiagram.org for the diagram on the right, which is for parsing a start tag with an attribute.

    Start with the SVG file with the GitHub Classroom Repository link at Brightspace, and commit your changes to that repository.

    Your final result should look exactly like the image shown here.

    Make sure to save as a SVG Image File (vector image with embedded source text)

    

  • Notes: Cohesion
  • Exercise 26: Cohesion Crossword

  All exercises are due by 4:30 pm on Wed Feb 15 unless otherwise noted

• Week 5 Class 10 Thu Feb 09 Posted: Feb 09

  Announcements

  • Project Due Dates A few things to check as you get to a project deadline:

    • Clone the repo into another directory
    • Verify this second clone builds
    • Verify it produces the correct answer
    • Verify it compiles with both gcc and clang Compilers
    • Verify that the tags are present and refer to the proper commit
    • Follow any hints in class, e.g., it must compile with TRACE() enabled
    • Read over the assignment and make sure you did not miss anything

  • Exercise Due Dates All on Monday

  Class

  • Notes: Scope
  • Exercise 21: Scope Crossword
  • Notes: Iterator
  • Exercise 22: Iterator Crossword

  • Exercise 23: DesignFun

    Finish the code in the repo DesignFun in GitHub Classroom. Be sure to follow carefully all directions in the header comment.

    If you have not already, this would be an excellent exercise to try out GitHub Codespaces.

  • Notes: Event States

  All exercises are due by 4:30 pm on Monday, Feb 13

• Week 5 Class 9 Tue Feb 07 Posted: Feb 07

  Announcements

  • Spring 2023 Career Fair Class attendance is still expected

  • Crossword Labs had an update in the past few days. Printing is much more standard. So now you can use either 1) the Print menu item in your browser or 2) the Print button

    New Crossword Labs Print Feature

  • Project 1 v1d General principles that I carefully go over and emphasize but are being overlooked:

    • Don't break the build A design change must not break the build. If you extract a function and the program does not build, you must fix it before going on. I.e., make and observe if it successfully builds
    • Don't change the output of the program A design change must not change the program's output. If you extract a function and the program's output is not the same, you must fix it before going on. E.g., make run, and verify the result
    • Push your changes We do not use git in this class as a submission system, and we use it as we would professionally. Push your changes as you make them. I monitor for potential problems and cannot do so if I do not see the changes.
    • Use the proper direction and type of parameters Direction of parameters
    • Use the XML Interface Concepts as a guide for what to pass, I.e., XML Interface Concepts are the only things that our XML functions can pass OUT. Other parameters can be IN or IN/OUT.
    • Review all free-function stereotypes to see if they apply Accessor::Predicate Stereotype When to Use an Accessor::Predicate Stereotype
    • Each category of concerns belongs in specific files Exercise 16: srcFacts Concerns Answer Key srcFacts & srcML concerns belong only in srcFacts.cpp. As much as possible Parsing concerns belong in xml_parser.cpp, XML concerns may be in all files.

  Class

  • Notes: Concerns
  • Exercise 16: srcFacts Concerns Answer Key
  • Notes: Naming
  • Exercise 18: Naming Crossword
  • Notes: Method Naming Standards
  • Exercise 19: Method Naming Standards Crossword

  • Exercise 20: Comment Events

    On a sheet of paper, write down all the events for a single-line comment. Then write down the change that occurs with a block comment.

    Guide: srcML

    Command	Description
    1) cmake . -DTRACE=ON	Use the CMake variable TRACE to define the TRACE() macro
    2) make	Rerun make to include the changes to the TRACE() macro
    3) make run	Run the demo data with the srcfacts program
    3) ./srcfacts < line.cpp	Directly run the srcfacts program in Linux or macOS
    4) cmake . -DTRACE=OFF	Use the CMake variable TRACE to undefine the TRACE() macro
    4) cmake . -UTRACE	Alternatively, remove the CMake variable TRACE
    5) make	Rerun make to include the changes to the TRACE() macro

    I strongly recommend that at least once, you turn on the TRACE() macro with your code and try to run it. You may be surprised.

  • Notes: Scope

  All exercises are due by 4:30 pm on Wed Feb 08 unless otherwise noted

• Week 4 Class 8 Thu Feb 02 Posted: Feb 02

  After Class

  • Crosswords

    Crossword Labs had an update in the past couple of days. Printing is much more standard. So now you can

    1. Print using the Print feature in your browser
    2. Use the print button

  • Project 1 v1d General principles that I carefully went over and emphasized, but are being overlooked.

    • A design change must not break the build. If you extract a function and the program does not build, you must fix it before going on. E.g., make
    • A design change must not change the output of the program. If you extract a function and the output of the program is not the same, you must fix it before going on. E.g., make run, and verify the result.
    • Proper Direction of parameters
    • XML Interface Concepts are the only things that our XML functions can pass OUT.
    • Accessor::Predicate Stereotype
    • When to Use an Accessor::Predicate Stereotype

  Announcements

  • A question was raised that either Aggregate.hpp or Aggregate.cpp did not have a newline at the EOF for one of the commits. For a demonstration that they did, Rainfall-020
  • Spring 2023 Career Fair Class attendance is still expected. If you want to attend the other section of OOP, email me for class to check
  • Project 1 Do not wait until the last minute. This part is much more involved and have you extracting multiple functions.

  • Project 1 Pull Request

    I created a pull request for Project 1 to create the (empty) files, xml_parser.hpp and xml_parser.cpp for part v1d. The easiest way to merge this into your code is the Merge pull request at GitHub. Once you merge, then remember to do a git pull in all of your cloned repositories.

    Note that xml_parser.{hpp,cpp} expands to xml_parser.hpp and xml_parser.cpp in a shell.

  • Guide: srcML

  Class

  • Notes: Concerns

  • Exercise 16: srcFacts Concerns- Handout in class, due by the end of the class meeting

    • srcFacts.cpp#L433-L473
    • srcFacts.cpp#L283-L292
    • srcFacts.cpp#L548-L556
    • srcFacts.cpp#L317-L324
  • Exercise 17: Concerns Crossword
  • Notes: Vertical Development
  • Interlude: Guide: Benchmarks
  • Notes: Function Generalization
  • Notes: Naming

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

• Week 4 Class 7 Tue Jan 31 Posted: Jan 31

  After Class

  • A question was raised that either Aggregate.hpp or Aggregate.cpp did not have a newline at the EOF for one of the commits. For a demonstration that they did, Rainfall-020

  • Project 1 Pull Request

    I created a pull request for Project 1 to create the (empty) files, xml_parser.hpp and xml_parser.cpp for part v1d. The easiest way to merge this into your code is the Merge pull request at GitHub. Once you merge, then remember to do a git pull in all of your cloned repositories.

    Note that xml_parser.{hpp,cpp} expands to xml_parser.hpp and xml_parser.cpp in a shell.

  Announcements

  • Policy Enforcement Change Starting with the class on Tuesday, Jan 31, attendance is required to get credit for any exercises. For example, to get credit for Exercise 14: Coding Style Crossword, you must be in class today as I present those notes. Any exceptions must be from a valid, excused absence. This applies to all exercises, including crosswords and coding exercises. If you attend, you still have until the due date (typically 4:30 pm the next day) to complete the assignment. I encourage those of you not attending regularly to start doing so.
  • Rainfall IV Feedback I posted Report4 in branch feedback4, and scores in Brightspace along with some notes
  • Project 1 I adjusted the due date for v1c

  • GitHub Desktop & Atom Users Keep your software updated. It is easy to forget about any virtual environments and not update them.

    On Windows, Windows Update does not update the Ubuntu in WSL. So for WSL (and Ubuntu):

    On macOS, macOS updates do not update the software in brew. So for brew:

    Also, before you install a package, do the above first.

  • Cleaning Up Package managers download packages and installs them. Once they are installed, the downloads are not needed, unless you want to reinstall at some point. And, they can be downloaded again if needed.

    For WSL (and Ubuntu):

    For brew:

  Class

  • Notes: XML

  • Exercise 13: XML Crossword

  • Notes: Coding Style

  • Exercise 14: Coding Style Crossword

  • Notes: Free-Function Stereotypes

  • Exercise 15: Free-Function Stereotypes Crossword

  • Notes: Concerns

  Unless noted otherwise, all exercises are due by 4:30 pm on Wed Feb 01

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

  After Class

  • Policy Enforcement Change Starting with the class on Tuesday, Jan 31, attendance is required to get credit for any exercises. For example, to get credit for the Separate Compilation Crossword, you must be in class when I present those notes. Any exceptions must be from a valid, excused absence. This applies to all exercises, including crosswords and coding exercises. If you attend, you still have until the due date (typically 4:30 pm the next day) to complete the assignment. I encourage those of you not attending regularly to start doing so.
  • Exercise 13: XML Crossword Due after next class

  Announcements

  • Good Practices Always perform a git pull before you start making any changes to your code. That prevents the need for a git merge after. That would have prevented some of the git warnings that students were getting.
  • Rainfall IV Feedback I did not get to this yet
  • Project 1
    • I posted feedback for Project 1 v1a as GitHub Issues. The scores are in Brightspace. Note that I will not always grade each part as we go along.
    • There is a GitHub issue, Coding Practices Task List, for Project 1 part v1c
    • I adjusted some of the due dates
  • Guide: Compilers

  Class

  • Notes: Separate Compilation
  • OOPS23-Rainfall-020
  • Exercise 11: Separate Compilation Crossword
  • Notes: Rainfall Coding Practices
  • Notes: XML
  • Exercise 13: XML Crossword Due after next class (did not complete XML slides in 2 - 3:15 pm 020 section)

  Unless noted otherwise, all exercises are due by 4:30 pm on Monday, Jan 30

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

  After Class

  • I posted feedback for Project 1 v1a as GitHub Issues. The scores are in Brightspace.
  • Always perform a git pull before you start making any changes to your code. That prevents the need for a git merge after. For the 010 section, that would have prevented some of the git warnings that students were getting.
  • For Rainfall IV, I am not concerned with the order or number of commits. Get your program up to the point that I showed in class (and you can view on GitHub)

  Announcements

  • Rainfall III Feedback Posted as Report3.md on branch, feedback3
  • Due Dates Unless I give you a specific time, all deadlines are by 11:59:59 pm of the day listed
  • Project 1
    • Not all parts of the project have the same level of difficulty or take the same amount of time. I definitely suggest you work ahead of the due dates
    • The function already in srcFacts is refillContent(). I accidentally showed code in class that was from another version that used the name refillBuffer()
    • I changed the due date for v1b
  • Guide: Git Tags

  Class

  • Notes: Algorithmic Decomposition

  • Exercise 10: Algorithmic Decomposition Crossword

  • Notes: Separate Compilation - Will finish on Thursday

  • Exercise 11: Separate Compilation Crossword - Delayed until after next class

  • Exercise 12: Rainfall IV

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-020

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

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

  After Class

  • All deadlines for projects are by 11:59:59 pm of the day listed
  • I definitely suggest working ahead of the due dates

  Announcements

  • Repo Issues Only affected a few of you, and currently fixed

  • Navigation In WSL, if you enter the following command in the WSL shell:

    the Windows File Explorer will open with the directory you are at in the WSL shell.

    Carefully note that there is a single dot, ., in the command. A single dot in a shell is the current directory. Two dots, .., refer to the parent directory (as in cmake ..)

  • Rainfall II Feedback Posted as Report2.md on branch, feedback2
  • Project 1 GitHub Classroom link on Brightspace

  Class

  • Exercise 8: Build & Run srcFacts

    Create your srcFacts repository from GitHub Classroom and clone the repository on your machine. Build and run the program to verify it works in your development environment. At the end of the commands, enter the following:

    Upload a screenshot (or multiple) to Brightspace of these commands executing.

  • Exercise 9: Rainfall III

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-020

  • Notes: Algorithmic Decomposition - Delayed until next class
  • Exercise 10: Algorithmic Decomposition Crossword - Delayed until next class

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

• Project 1: srcFacts Posted: Jan 18

  One approach to understanding the source code of a system is to count things, e.g., the number of statements, functions, classes, expressions, LOC (Lines Of Code), etc. The program srcFacts produces a report of these counts.

  It is very difficult for a program to directly parse C++ source code, i.e., identify the syntactic parts of the code. 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 collecting counts, and produces the report.

  The srcFacts program is one large, main() function using almost no design features. It does have high scalability and performance as it is extremely fast and, for example, can produce a report on the entire Linux kernel in under 6 seconds. However, it is not easy in its current form 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. It has no modularity, extensibility, reusability, and specifically no maintainability.

  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. The heading in the table must be "Returns". Due Jan 24

  Tag v1b Move the refillContent() function into the separate refillContent.hpp and refillContent.cpp files. Due Jan 26 27

  Tag v1c Apply the specific design changes from the Coding Practices Task List (to appear). As you verify that the code follows the practices given, check them off. Once you have completed all of them, close the issue. Due Jan 29 31 Feb 1

  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. These function declarations and definitions belong in the files xml_parser.hpp and xml_parser.cpp, as described above. Due Feb 2 6 9

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

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

  • 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 absolutely 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 are free to 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.

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

  After Class

  • Missing Repositories

    I did some cleanup of membership on UAComputerScience, the organization used for GitHub Classroom.

    Unfortunately, if you were a member of UAComputerScience, it may have removed your access to your repository.

    For most of you, this should not be a problem.

    I am restoring access. If you don't have access, send me an email, or a message via Teams.

    Update Going through all the repositories, it is only those who took another class of mine (e.g,. Software Engineering) and were members (instead of "outside collaborators"). For those few, I sent out invitations to restore access to your repository.

  • Navigation In WSL, if you enter the following command in the WSL shell:

    the Windows File Explorer will open with the directory you are at in the WSL shell.

    Carefully note that there is a single dot, ., in the command. A single dot in a shell is the current directory. Two dots, .., refer to the parent directory (as in cmake ..)

  Announcements

  • After Class

  • Ubuntu 20.04

    If you are having issues installing gh in WSL, then you probably have Ubuntu 20.04 installed instead of Ubuntu 22.04. To check your version of Ubuntu:

    At some point you will need to update. In the meantime, you can use the following commands to directly install gh:

    Note that to install an updated CMake, you will have to follow the directions at apt.kitware.com for Ubuntu Focal Fossa (20.04)

  • Scores I posted the scores for the Exercises 3 & 4. From now on, I will not announce posted scores. I will only announce when they are delayed.
  • Rainfall I Feedback
  • Workflow

  Class

  • Notes: Software Design Characteristics
  • Exercise 6: Software Design Characteristics Crossword

  • Exercise 7: Rainfall II

    We continue on with the notes on Rainfall Coding Practices. Refer to Exercise 5: Rainfall I.

    OOPS23-Rainfall-020

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

• Exercise 5: Rainfall I Feedback Posted: Jan 17

  The scores and feedback for Exercise 6: rainfall.cpp is in two parts:

  • The file Report.md in the feedback1 branch of your repository. Best to view this on GitHub.
  • Scores and comments in Brightspace

  The report check/shows the following:

  • The most recent rainfall.cpp with indentation and line endings marked
  • Changed files - Should only be rainfall.cpp (and README.md from a github bot)
  • Results of cmake ..; make; make run; make check
  • Word difference with the oracle commit messages
  • For each commit:
    • git show
    • Results of cmake ..; make; make run; make check for the code in this commit
    • diff of rainfall.cpp with what I entered

  I use the report to give feedback. In some cases, the report can be off, e.g., if you had extra commits.

  Overall observations:

  • All commits, including changes to code and commit messages, were in GitHub as soon as I did a git push.
  • The first word in a commit message is always capitalized
  • Commit messages use an imperative form, e.g., Add, Change, Comment, Move, Remove, Rename, Replace, and Separate. Not Added, Adding, Changed, Commented, Moved, Removed, Renamed, Replaced, or Separated
  • Spelling is important. Letter case is important.

  • Valid commit messages:

  • Invalid commit messages:

  • The code in every commit must build. Do not commit if you have a compile error. Build and run your code and fix any errors before committing.

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

  After Class

  If you are having issues installing gh in WSL, then you probably have Ubuntu 20.04 installed instead of Ubuntu 22.04. To check your version of Ubuntu:

  At some point you will need to update. In the meantime, you can use the following commands to directly install gh:

  Note that to install an updated CMake, you will have to follow the directions at apt.kitware.com for Ubuntu Focal Fossa (20.04)

  If this doesn't work, then use GitHub Codespaces to work on Rainfall.

  Announcements

  • TA Mr. Andrew Murphy
  • Scores I posted the scores for the Exercises 1 & 2
  • Syllabus In the syllabus, "3460" is replaced by "CPSC"
  • Notes The class notes have a bunch of default and custom hot keys. Type a "?" to see a list.
  • Archive The post for the first class session are now in the Archive. I only keep relevant posts on the course page.
  • Class Survey Results

  Class

  • Exercise 3: Development Environment Survey
  • Notes: Software Design
  • Exercise 4: Software Design Crossword
  • Steps to work on Coding Exercises:
    • Development Environment: Tools Setup your local machine with the proper tools
    • GitHub Authentication Authenticate your local machine with GitHub
    • Git Setup Setup your local machine to properly use Git
  • Alternative work on Exercises in GitHub Codespace. But you will need to update CMake. See the Guide.

  • Exercise 5: Rainfall I

    Note Due to the required setup, Exercise 5 is due by 8 am on Monday, Jan 16. Even with this extra time, there is a lot of setup, so start early.

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

• Exercise Rainfall I Posted: Jan 12

  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.

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

  Now to setup the build:

  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
  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

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

  OOPS23-Rainfall-020

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

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

  After Class

  • Course Content Crossword:

  

  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. The account email (not necessarily the account name) should be your @uakron.edu email address. If it is, you can apply for the Student Github Developer Pack and get a free GitHub Pro account. You will need your GitHub account for Thursday's class.
  • 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.
  • GitHub Codespaces I am considering using these for exercises at least. Will know more soon.

  • O'Reilly Online Learning The course textbooks are 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

  • During Office Hours, I monitor Teams

  Exercises

  • Exercise 1: OOP Survey

  • Exercise 2: Course Content Crossword

    Upload a PDF of the completed crossword to Brightspace in Assessments/Assignments, Exercise 2: Course Content Crossword

    Make sure to follow the print directions given in class to create a PDF of the crossword.

    Also, try to include the headers and footers in the pdf.

  • Notes: Software Design

  All exercises are due by 4:30 pm on Wed Jan 11

• Welcome Posted: Jan 08

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

  • Syllabus The syllabus for the course is on the main course page. It is a draft, but I will finalize it 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 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. The account email (not necessarily the account name) should be your @uakron.edu email address. If it is, you can apply for the Student Github Developer Pack and get a free GitHub Pro account.

  See you on Tuesday, Jan 10 at 2:00 pm - 3:15 pm in Arts & Sciences (CAS) room 134