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

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