fix(yaml): properly escape double quotes

[raphaelcoeffic]

Summary of changes:

• YAML output: escape double quotes " inside string elements

[philmoz]

Does Companion also need a similar fix?

[raphaelcoeffic]

Does Companion also need a similar fix?

I must admit I didn’t try. Chances are that we don’t, as the YAML lib is probably already doing the right thing.

[philmoz]

I tried this PR on my TX16S. If I add a '"' to a model name on the radio it works.

However if I then load the radio/model settings into Companion and try and run the simulator it crashes.

Companion converts the \x22 string back to a '"' character - so the escaping is lost.

[philmoz]

Also Companion does not currently allow entering '"' characters into the model name.

If this is going to be allowed on the radio is should probably also be allowed in Companion.

[raphaelcoeffic]

If this is going to be allowed on the radio is should probably also be allowed in Companion.

Absolutely. That means we need to dig into the YAML lib and find out how we can have proper escaping.

[philmoz]

Brute force solution for Companion. Force ALL output to be double quoted (and I really mean ALL).
File - companion/src/firmwares/edgetx/edgetxinterface.cpp

static void writeYamlToByteArray(const YAML::Node& node, QByteArray& data, bool addChecksum = false)
{
    // TODO: use real streaming to avoid memory copies
    YAML::Emitter out;
    out.SetStringFormat(YAML::EMITTER_MANIP::DoubleQuoted);

    out << node;
    data = QByteArray::fromStdString(out.c_str());

    qDebug() << "Saving YAML:";

    if(addChecksum) {
      uint16_t checksum = 0xFFFF;
      checksum = calculateChecksum(data, checksum);
      std::stringstream checksum_ostream;
      checksum_ostream << "checksum:  " << checksum << std::endl;
      data.prepend(checksum_ostream.str().c_str());
    }

    qDebug() << data.toStdString().c_str();
}

[raphaelcoeffic]

// TODO: use real streaming to avoid memory copies

Would make sense, right? There might be some implications with the ZIP compression as well.

[philmoz]

Instead of trying to hack the yaml-cpp output (which is technically correct), I've pushed a change so that the firmware can correctly read back the strings saved in Companion that contain embedded double quotes.

Also changed Companion to allow the '"' character in model names.

[raphaelcoeffic]

@philmoz If I understand it correctly, your change would effect the following:

On the radio side:

• strings are always emitted with double-quotes, thus leading to "My 5\" Quad".
• when reading attribute values, double quotes would only be removed from the value when the first non-space character is a double-quote:
  • attribute: "my value" leads to a value of my value,
  • while attribute: my " value" would lead to my " value").

On the companion side:

• string attributes are basically never double-quoted (any exceptions?)

[philmoz]

On the radio strings are always enclosed in double quotes.
An embedded double quote is output as \x22, e.g. "My 5\x22 Quad". This is the first change done in this PR.
The radio and Companion YAML readers already handle characters escaped like this.

On Companion strings are not enclosed in double quotes unless they contain special characters (as per the YAML spec).
Companion would output as My 5" Quad.

The latest change modifies the radio YAML reader to handle the case where a string is not enclosed in quotes; but contains an embedded quote.

[raphaelcoeffic]

Thx @philmoz! Would you mind adding some unit test? 😅

[pfeerick]

Working good on TX16S and TX12MK2, both on radio (not longer mangling model) and when syncing with Companion.

Two aspects that could be improved on B&W - you can't select double quote as a input character - I think this may be raised in an older issue regarding order and punctuation, but come to light again now. And secondly, while the quote is visible for smaller font, it's not visble in the larger font that displays the model name (on 128x64, at least).

[dizzysizzy]

hey, i have the same issue, i want to name my model 5" quad but it just erases all the data on that model after a reboot (tx16s) and im on the newest version of edge tx, is there a way to fix this?