Trigger4Win/libcmdline/Attributes/MultiLineTextAttribute.cs

#region License
// <copyright file="MultilineTextAttribute.cs" company="Giacomo Stelluti Scala">
//   Copyright 2015-2013 Giacomo Stelluti Scala
// </copyright>
//
// 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.
#endregion
#region Using Directives
using System;
using System.Text;

using CommandLine.Infrastructure;
using CommandLine.Text;
#endregion

namespace CommandLine
{
    /// <summary>
    /// Provides base properties for creating an attribute, used to define multiple lines of text.
    /// </summary>
    public abstract class MultilineTextAttribute : Attribute
    {
        private readonly string _line1;
        private readonly string _line2;
        private readonly string _line3;
        private readonly string _line4;
        private readonly string _line5;

        /// <summary>
        /// Initializes a new instance of the <see cref="MultilineTextAttribute"/> class. Used in derived type
        /// using one line of text.
        /// </summary>
        /// <param name="line1">The first line of text.</param>
        protected MultilineTextAttribute(string line1)
        {
            Assumes.NotNullOrEmpty(line1, "line1");

            _line1 = line1;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MultilineTextAttribute"/> class. Used in  type
        /// using two lines of text.
        /// </summary>
        /// <param name="line1">The first line of text.</param>
        /// <param name="line2">The second line of text.</param>
        protected MultilineTextAttribute(string line1, string line2)
            : this(line1)
        {
            Assumes.NotNullOrEmpty(line2, "line2");

            _line2 = line2;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MultilineTextAttribute"/> class. Used in  type
        /// using three lines of text.
        /// </summary>
        /// <param name="line1">The first line of text.</param>
        /// <param name="line2">The second line of text.</param>
        /// <param name="line3">The third line of text.</param>
        protected MultilineTextAttribute(string line1, string line2, string line3)
            : this(line1, line2)
        {
            Assumes.NotNullOrEmpty(line3, "line3");

            _line3 = line3;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MultilineTextAttribute"/> class. Used in type
        /// using four lines of text.
        /// </summary>
        /// <param name="line1">The first line of text.</param>
        /// <param name="line2">The second line of text.</param>
        /// <param name="line3">The third line of text.</param>
        /// <param name="line4">The fourth line of text.</param>
        protected MultilineTextAttribute(string line1, string line2, string line3, string line4)
            : this(line1, line2, line3)
        {
            Assumes.NotNullOrEmpty(line4, "line4");

            _line4 = line4;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="MultilineTextAttribute"/> class. Used in type
        /// using five lines of text.
        /// </summary>
        /// <param name="line1">The first line of text.</param>
        /// <param name="line2">The second line of text.</param>
        /// <param name="line3">The third line of text.</param>
        /// <param name="line4">The fourth line of text.</param>
        /// <param name="line5">The fifth line of text.</param>
        protected MultilineTextAttribute(string line1, string line2, string line3, string line4, string line5)
            : this(line1, line2, line3, line4)
        {
            Assumes.NotNullOrEmpty(line5, "line5");

            _line5 = line5;
        }

        /// <summary>
        /// Gets the all non-blank lines as string.
        /// </summary>
        /// <value>A string of all non-blank lines.</value>
        public virtual string Value
        {
            get
            {
                var value = new StringBuilder(string.Empty);
                var strArray = new[] { _line1, _line2, _line3, _line4, _line5 };

                for (int i = 0; i < GetLastLineWithText(strArray); i++)
                {
                    value.AppendLine(strArray[i]);
                }

                return value.ToString();
            }
        }

        /// <summary>
        /// Gets the first line of text.
        /// </summary>
        public string Line1
        {
            get { return _line1; }
        }

        /// <summary>
        /// Gets the second line of text.
        /// </summary>
        public string Line2
        {
            get { return _line2; }
        }

        /// <summary>
        /// Gets third line of text.
        /// </summary>
        public string Line3
        {
            get { return _line3; }
        }

        /// <summary>
        /// Gets the fourth line of text.
        /// </summary>
        public string Line4
        {
            get { return _line4; }
        }

        /// <summary>
        /// Gets the fifth line of text.
        /// </summary>
        public string Line5
        {
            get { return _line5; }
        }

        internal void AddToHelpText(Action<string> action)
        {
            var strArray = new[] { _line1, _line2, _line3, _line4, _line5 };
            Array.ForEach(
                strArray,
                line =>
                {
                    if (!string.IsNullOrEmpty(line))
                    {
                        action(line);
                    }
                });
        }

        internal void AddToHelpText(HelpText helpText, bool before)
        {
            // before flag only distinguishes which action is called, 
            // so refactor common code and call with appropriate action
            if (before)
            {
                AddToHelpText(helpText.AddPreOptionsLine);
            }
            else
            {
                AddToHelpText(helpText.AddPostOptionsLine);
            }
        }

        /// <summary>
        /// Returns the last line with text. Preserves blank lines if user intended by skipping a line.
        /// </summary>
        /// <returns>The last index of line of the non-blank line.
        /// </returns>
        /// <param name='value'>The string array to process.</param>
        protected virtual int GetLastLineWithText(string[] value)
        {
            int index = Array.FindLastIndex(value, str => !string.IsNullOrEmpty(str));

            // remember FindLastIndex returns zero-based index
            return index + 1;
        }
    }
}