openframeworks / openframeworks/openFrameworks

XML deserialize checks for unnecessary stream operators

Open
#4,589 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
10.4k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
9

Description

In order to deserialize an ofParameter, ofParameter::isSerializable() must be true. This method checks both for serializable flag and existence of stream operators (<<, >>).

However when deserializing an ofParameter, only ofParameter::fromString() is used. I use to implement fromString() for my custom ofParameter's in OF < 0.9.0, but now a dummy implementation of the stream operators must be defined to allow deserialization, which is kind of dangerous (who knows if other parts of ofParameter end using stream operators for something).

I suspect this happens also on serialization.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with ofxXmlSettings.cpp around the deserialization check and inspect ofParameter.h, especially isSerializable() and fromString(). Trace the corresponding serialization path as well, then verify that custom ofParameter types can deserialize without unnecessary stream operators and determine whether serialization has the same issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.