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

Week 5 Class 10 Thu Feb 15 Posted: Feb 15

After Class

• Project 2

• All issues for v1d and v1e are in GitHub. I have not yet updated the scores in Brightspace.
• Since creating the rest of the issues for v1d and v1e took me longer than I planned, I adjusted the due dates for Project 2.
• In the branch feedback I put a file concerns.html. To get to that file:

    git pull
    git switch feedback
  

  If you had a v1d tag, you should see the file concerns.html. Load that file up in your favorite browser. If you have never done that, try now. Do not try to look at concerns.html at GitHub, because it does not display as a web page. When you are done viewing it, make sure to return back to the main branch:

    git switch main
    git branch
  

  If you open this file in a browser, you will see the XML parsing low-level concerns in srcfacts.cpp marked in red. This is based on the functions declared in xml_parser.hpp at the tag v1d, so if you make any changes since then, they won't show up. Here is an example for the original srcfacts.cpp. Yours is based on your code at tag v1d.

  It is a bit imprecise, and I may be able to generate better ones over time. It is possible that some of the code in red cannot easily be moved to functions in xml_parser. But it should give you a general idea.

  The structure of the big while statement with the nested-if is not marked in red, as it is not possible to move that out of srcfacts.cpp quite yet. If you have, then you have srcML or srcFacts concerns in your xml_parser, which creates even more of a problem. A C++ class would not help remove this structure. For that, we need mechanisms for event-driven programming.

• Code assumes unique attribute and value Issue

  I repeat the text of this v1e issue here for those who did not receive it:

  The code that counts the number of line comments assumes that the comment element is the only element that has the form: <… type="line">

  While not verified, it is also probably the case that the code for counting the number of literal strings has the same limitation.

  These elements do have these forms. But assuming this is true for all other srcML elements, current or future, is an assumption that is never stated or described. The choice is to describe in excruciating detail why this is the case, how someone could detect it, and what to do with their data when this happens. This requires forms that have to go to legal and be filled out in triplicate.

  Another choice is to fix the problem.

  I am not taking any points off for this issue. However, I expect it to be fixed. A few points to make:

  • It is easy to make assumptions about our input data for programming ease or program speed
  • Any assumptions must be clearly defined
  • A better choice is to remove the assumption
  • It is often easier (and better) to remove the assumption than it is to work around it
  • So if you can remove the assumption without much effort, it will pay to do so
  • There are exceptions as dealing with uncommon usages may delay delivery for common usages

Announcements

• Project 1

  • I updated the scores for Project 1 v1b and v1c in Brightspace
  • Feedback are issues in your GitHub repository
  • Issues are labeled with the part of the project they relate to, e.g., v1c
  • Many of the checks for v1b were based on your code at label v1c
  • For v1d, some of the issues are generated, but not all
  • No score yet for v1d as not all checks are done
  • Most problematic for v1d are srcFacts and srcML concerns in the xml_parser files
  • Another major area is low-level parsing code in srcfacts.cpp that really belongs in xml_parser files
• After Class Not always announced

• Exercise 29: TRACE

  • Building with TRACE on
  • Naming of everything is important. Even name of files.
  • Filenames such as file1.cpp.xml, file2.cpp.xml, and file3.cpp.xml have little meaning
  • Better filenames: line.cpp.xml, block.cpp.xml, and doxygen.cpp.xml
  • Even better: lineComment.cpp.xml, blockComment.cpp.xml, and doxygenComment.cpp.xml or line_comment.cpp.xml, block_comment.cpp.xml, and doxygen_comment.cpp.xml
  • Practice good naming. Overall, it will save you time and attention
• Project 2

Agenda

• Notes: Scope
• Exercise 30: Scope Crossword
• Notes: Iterator
• Exercise 31: Iterator Crossword
• Notes: Sequence Diagram

• Exercise 32: 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)