[YAMLTraits] Fix mapping <none> value that followed by comments.

[Higuoxing]

Summary

When mapping an optional value, if the value is <none> and followed
by comments, there will be a parsing error. This patch helps fix this
issue.

e.g.,

When mapping the following YAML,

Sections:
  - Name:  blah
    Type:  SHT_foo
    Flags: [[FLAGS=<none>]] ## some comments.

the raw value of ScalarNode is "<none> " rather than "<none>". We need
to remove the spaces.

[grimar]

Hmm. I do not know a simpler solution for this, so it is probably looks fine to me.
I wonder what others think though.

llvm/include/llvm/Support/YAMLTraits.h

1632–1634

This probably deserves a comment now.
Should we use rtrim(' ')? We do not need to trim the left side + trim by default trims too much it seems: " \t\n\v\f\r".

[Higuoxing]

llvm/include/llvm/Support/YAMLTraits.h

1631–1634

Another approach would be using getValue(SmallVectorImpl<char> &Storage).

/// Gets the value of this node as a StringRef.
///
/// \param Storage is used to store the content of the returned StringRef iff
///        it requires any modification from how it appeared in the source.
///        This happens with escaped characters and multi-line literals.
StringRef getValue(SmallVectorImpl<char> &Storage) const;

Flags: [[FLAGS='<none>']] can also be correctly parsed.

[jhenderson]

@grimar knows this area better, so I'll leave him to do most of this reviewing. I think the description needs updating though. Currently it talks about fields written as "Flags: <none>", but I assume you mean it to be "Flags: [[FLAGS=<none>]]"?

[grimar]

llvm/include/llvm/Support/YAMLTraits.h

1631–1634

I'd probably just stop on on rtrim( ) as it does exactly what we need here.

ScalarNode::getValue(SmallVectorImpl<char> &Storage) also handles single and double quotes,
what doesn't seem like something what we want to support.

[Higuoxing]

Address comments.

Thanks for reviewing!

[grimar]

LGTM with a nit.

llvm/include/llvm/Support/YAMLTraits.h

1631–1634

nit: still missing a comment. I'd add something like:

// We use rtrim to ignore possible white spaces that might exist when a comment is present on the same line.

[Higuoxing]

Address comments.

llvm/include/llvm/Support/YAMLTraits.h

if (Val.hasValue() &&
       this->preflightKey(Key, Required, sameAsDefault, UseDefault, SaveInfo)) {
 
     // When reading an Optional<X> key from a YAML description, we allow the
     // special "<none>" value, which can be used to specify that no value was
     // requested, i.e. the DefaultValue will be assigned. The DefaultValue is
     // usually None.
     bool IsNone = false;
     if (!outputting())
       if (auto *Node = dyn_cast<ScalarNode>(((Input *)this)->getCurrentNode()))
-        IsNone = Node->getRawValue() == "<none>";
+        // We use rtrim to ignore possible white spaces that might exist when a
+        // comment is present on the same line.
+        IsNone = Node->getRawValue().rtrim(' ') == "<none>";
 
     if (IsNone)
       Val = DefaultValue;
     else
       yamlize(*this, Val.getValue(), Required, Ctx);
     this->postflightKey(SaveInfo);
   } else {
     if (UseDefault)

llvm/test/tools/yaml2obj/ELF/none-value.yaml

 FileHeader:
   Class:   ELFCLASS64
   Data:    ELFDATA2LSB
   Type:    ET_REL
   Machine: EM_X86_64
 Sections:
   - Name:         .bar
     Type:         SHT_PROGBITS
+    Flags:        [[TEST=<none>]] ## Comment
     Offset:       [[TEST=<none>]]
     Address:      [[TEST=<none>]]
     Content:      [[TEST=<none>]]
     Size:         [[TEST=<none>]]
     ContentArray: [[TEST=<none>]]
     Info:         [[TEST=<none>]]
     EntSize:      [[TEST=<none>]]
     ShName:       [[TEST=<none>]]