// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
 
using Roslyn.LanguageServer.Protocol;
using System.Text.Json.Serialization;
 
namespace Microsoft.CodeAnalysis.LanguageServer.Handler
{
    /// <summary>
    /// Derived version of <see cref="DocumentSymbol" /> used so we can pass additional information we do not want lost for our
    /// internal consumers.  For example, the richer <see cref="Glyph"/> which is a superset of <see
    /// cref="DocumentSymbol.Kind"/>.
    /// </summary>
    internal sealed class RoslynDocumentSymbol : DocumentSymbol
    {
        [JsonPropertyName("glyph")]
        public int Glyph { get; set; }
 
        // Deliberately override the value in the base so that our serializers/deserializers know to include the custom
        // data we have on the children as well.
        [JsonPropertyName("children")]
        [JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
        public new RoslynDocumentSymbol[]? Children
        {
            get => (RoslynDocumentSymbol[]?)base.Children;
            set => base.Children = value;
        }
    }
}