// This file is part of YamlDotNet - A .NET library for YAML.
// Copyright (c) Antoine Aubry and contributors
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
// of the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
using System;
using System.Collections.Generic;
using System.Diagnostics;
using YamlDotNet.Core;
using YamlDotNet.Core.Events;
using YamlDotNet.Serialization;
using static YamlDotNet.Core.HashCode;
namespace YamlDotNet.RepresentationModel
{
///
/// Represents a scalar node in the YAML document.
///
[DebuggerDisplay("{Value}")]
public sealed class YamlScalarNode : YamlNode, IYamlConvertible
{
///
/// Gets or sets the value of the node.
///
/// The value.
public string? Value { get; set; }
///
/// Gets or sets the style of the node.
///
/// The style.
public ScalarStyle Style { get; set; }
///
/// Initializes a new instance of the class.
///
internal YamlScalarNode(IParser parser, DocumentLoadingState state)
{
Load(parser, state);
}
private void Load(IParser parser, DocumentLoadingState state)
{
var scalar = parser.Consume();
Load(scalar, state);
Value = scalar.Value;
Style = scalar.Style;
}
///
/// Initializes a new instance of the class.
///
public YamlScalarNode()
{
}
///
/// Initializes a new instance of the class.
///
/// The value.
public YamlScalarNode(string? value)
{
this.Value = value;
}
///
/// Resolves the aliases that could not be resolved when the node was created.
///
/// The state of the document.
internal override void ResolveAliases(DocumentLoadingState state)
{
throw new NotSupportedException("Resolving an alias on a scalar node does not make sense");
}
///
/// Saves the current node to the specified emitter.
///
/// The emitter where the node is to be saved.
/// The state.
internal override void Emit(IEmitter emitter, EmitterState state)
{
emitter.Emit(new Scalar(Anchor, Tag, Value ?? string.Empty, Style, Tag.IsEmpty, false));
}
///
/// Accepts the specified visitor by calling the appropriate Visit method on it.
///
///
/// A .
///
public override void Accept(IYamlVisitor visitor)
{
visitor.Visit(this);
}
///
public override bool Equals(object? obj)
{
return obj is YamlScalarNode other
&& Equals(Tag, other.Tag)
&& Equals(Value, other.Value);
}
///
/// Serves as a hash function for a particular type.
///
///
/// A hash code for the current .
///
public override int GetHashCode()
{
return CombineHashCodes(Tag, Value);
}
///
/// Performs an explicit conversion from to .
///
/// The value.
/// The result of the conversion.
public static explicit operator string?(YamlScalarNode value)
{
return value.Value;
}
///
/// Returns a that represents this instance.
///
///
/// A that represents this instance.
///
internal override string ToString(RecursionLevel level)
{
return Value ?? string.Empty;
}
///
/// Recursively enumerates all the nodes from the document, starting on the current node,
/// and throwing
/// if is reached.
///
internal override IEnumerable SafeAllNodes(RecursionLevel level)
{
yield return this;
}
///
/// Gets the type of node.
///
public override YamlNodeType NodeType
{
get { return YamlNodeType.Scalar; }
}
void IYamlConvertible.Read(IParser parser, Type expectedType, ObjectDeserializer nestedObjectDeserializer)
{
Load(parser, new DocumentLoadingState());
}
void IYamlConvertible.Write(IEmitter emitter, ObjectSerializer nestedObjectSerializer)
{
Emit(emitter, new EmitterState());
}
}
}