PdfPig/src/UglyToad.PdfPig/Graphics/Operations/MarkedContent/BeginMarkedContentWithProperties.cs

namespace UglyToad.PdfPig.Graphics.Operations.MarkedContent
{
    using System.IO;
    using Tokens;
    using Util.JetBrains.Annotations;
    using Writer;

    /// <inheritdoc />
    /// <summary>
    /// Begin a marked-content sequence with an associated property list terminated by a balancing <see cref="EndMarkedContent"/> operator.
    /// </summary>
    public class BeginMarkedContentWithProperties : IGraphicsStateOperation
    {
        /// <summary>
        /// The symbol for this operation in a stream.
        /// </summary>
        public const string Symbol = "BDC";

        /// <inheritdoc />
        public string Operator => Symbol;

        /// <summary>
        /// A name indicating the role or significance of the point.
        /// </summary>
        public NameToken Name { get; }

        /// <summary>
        /// The name of the property dictionary in the Properties subdictionary of the current resource dictionary.
        /// Can be <see langword="null"/> if the property dictionary is provided inline.
        /// </summary>
        [CanBeNull]
        public NameToken PropertyDictionaryName { get; }

        /// <summary>
        /// The marked-content sequence properties.
        /// Can be <see langword="null"/> if a name of the property dictionary is provided instead.
        /// </summary>
        [CanBeNull]
        public DictionaryToken Properties { get; }

        /// <summary>
        /// Create a new <see cref="BeginMarkedContentWithProperties"/>.
        /// </summary>
        /// <param name="name">The name of the marked-content point.</param>
        /// <param name="propertyDictionaryName">The name of the property dictionary.</param>
        public BeginMarkedContentWithProperties(NameToken name, NameToken propertyDictionaryName)
        {
            Name = name;
            PropertyDictionaryName = propertyDictionaryName;
        }

        /// <summary>
        /// Create a new <see cref="BeginMarkedContentWithProperties"/>.
        /// </summary>
        /// <param name="name">The name of the marked-content point.</param>
        /// <param name="properties">The properties of the marked-content point.</param>
        public BeginMarkedContentWithProperties(NameToken name, DictionaryToken properties)
        {
            Name = name;
            Properties = properties;
        }

        /// <inheritdoc />
        public void Run(IOperationContext operationContext)
        {
            operationContext.BeginMarkedContent(Name, PropertyDictionaryName, Properties);
        }

        /// <inheritdoc />
        public void Write(Stream stream)
        {
            TokenWriter.WriteToken(Name, stream);
            stream.WriteWhiteSpace();

            if (PropertyDictionaryName != null)
            {
                TokenWriter.WriteToken(PropertyDictionaryName, stream);
            }
            else
            {
                TokenWriter.WriteToken(Properties, stream);
            }

            stream.WriteWhiteSpace();
            stream.WriteText(Symbol);
            stream.WriteNewLine();
        }
    }
}