Backend/RiderPlugin/JetBrains.TextTemplating/TextTransformation.cs

using System;
using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.Globalization;
using System.Text;

namespace Microsoft.VisualStudio.TextTemplating
{
#line default
#line hidden

  #region Base class

  /// <summary>
  /// Base class for this transformation
  /// </summary>
  public abstract class TextTransformation : IDisposable
  {
    #region Fields

    private StringBuilder generationEnvironmentField;
    private CompilerErrorCollection errorsField;
    private List<int> indentLengthsField;
    private string currentIndentField = "";
    private bool endsWithNewline;
    private IDictionary<string, object> sessionField;

    #endregion

    #region Properties

    /// <summary>
    /// The string builder that generation-time code is using to assemble generated output
    /// </summary>
    protected StringBuilder GenerationEnvironment
    {
      get
      {
        if (generationEnvironmentField == null)
        {
          generationEnvironmentField = new StringBuilder();
        }

        return generationEnvironmentField;
      }
      set { generationEnvironmentField = value; }
    }

    /// <summary>
    /// The error collection for the generation process
    /// </summary>
    public CompilerErrorCollection Errors
    {
      get
      {
        if (errorsField == null)
        {
          errorsField = new CompilerErrorCollection();
        }

        return errorsField;
      }
    }

    /// <summary>
    /// A list of the lengths of each indent that was added with PushIndent
    /// </summary>
    private List<int> indentLengths =>
      indentLengthsField ??= new List<int>();

    /// <summary>
    /// Gets the current indent we use when adding lines to the output
    /// </summary>
    public string CurrentIndent => currentIndentField;

    /// <summary>
    /// Current transformation session
    /// </summary>
    public virtual IDictionary<string, object> Session
    {
      get { return sessionField; }
      set { sessionField = value; }
    }

    #endregion

    #region Transform-time helpers

    /// <summary>
    /// Write text directly into the generated output
    /// </summary>
    public void Write(string textToAppend)
    {
      if (string.IsNullOrEmpty(textToAppend))
      {
        return;
      }

      // If we're starting off, or if the previous text ended with a newline,
      // we have to append the current indent first.
      if (GenerationEnvironment.Length == 0
          || endsWithNewline)
      {
        GenerationEnvironment.Append(currentIndentField);
        endsWithNewline = false;
      }

      // Check if the current text ends with a newline
      if (textToAppend.EndsWith(Environment.NewLine, StringComparison.CurrentCulture))
      {
        endsWithNewline = true;
      }

      // This is an optimization. If the current indent is "", then we don't have to do any
      // of the more complex stuff further down.
      if (currentIndentField.Length == 0)
      {
        GenerationEnvironment.Append(textToAppend);
        return;
      }

      // Everywhere there is a newline in the text, add an indent after it
      textToAppend = textToAppend.Replace(Environment.NewLine, Environment.NewLine + currentIndentField);
      // If the text ends with a newline, then we should strip off the indent added at the very end
      // because the appropriate indent will be added when the next time Write() is called
      if (endsWithNewline)
      {
        GenerationEnvironment.Append(textToAppend, 0,
          textToAppend.Length - currentIndentField.Length);
      }
      else
      {
        GenerationEnvironment.Append(textToAppend);
      }
    }

    /// <summary>
    /// Write text directly into the generated output
    /// </summary>
    public void WriteLine(string textToAppend)
    {
      Write(textToAppend);
      GenerationEnvironment.AppendLine();
      endsWithNewline = true;
    }

    /// <summary>
    /// Write formatted text directly into the generated output
    /// </summary>
    public void Write(string format, params object[] args)
    {
      Write(string.Format(CultureInfo.CurrentCulture, format, args));
    }

    /// <summary>
    /// Write formatted text directly into the generated output
    /// </summary>
    public void WriteLine(string format, params object[] args)
    {
      WriteLine(string.Format(CultureInfo.CurrentCulture, format, args));
    }

    /// <summary>
    /// Raise an error
    /// </summary>
    public void Error(string message)
    {
      CompilerError error = new CompilerError();
      error.ErrorText = message;
      Errors.Add(error);
    }

    /// <summary>
    /// Raise a warning
    /// </summary>
    public void Warning(string message)
    {
      CompilerError error = new CompilerError();
      error.ErrorText = message;
      error.IsWarning = true;
      Errors.Add(error);
    }

    /// <summary>
    /// Increase the indent
    /// </summary>
    public void PushIndent(string indent)
    {
      if (indent == null)
      {
        throw new ArgumentNullException("indent");
      }

      currentIndentField = currentIndentField + indent;
      indentLengths.Add(indent.Length);
    }

    /// <summary>
    /// Remove the last indent that was added with PushIndent
    /// </summary>
    public string PopIndent()
    {
      string returnValue = "";
      if (indentLengths.Count > 0)
      {
        int indentLength = indentLengths[indentLengths.Count - 1];
        indentLengths.RemoveAt(indentLengths.Count - 1);
        if (indentLength > 0)
        {
          returnValue = currentIndentField.Substring(currentIndentField.Length - indentLength);
          currentIndentField =
            currentIndentField.Remove(currentIndentField.Length - indentLength);
        }
      }

      return returnValue;
    }

    /// <summary>
    /// Remove any indentation
    /// </summary>
    public void ClearIndent()
    {
      indentLengths.Clear();
      currentIndentField = "";
    }

    #endregion

    #region Microsoft compatibility

    public abstract string TransformText();

    public virtual void Initialize()
    {
    }

    ~TextTransformation() => Dispose(false);

    public void Dispose()
    {
      Dispose(true);
      GC.SuppressFinalize(this);
    }

    protected virtual void Dispose(bool disposing)
    {
      generationEnvironmentField = null;
      errorsField = null;
    }

    #endregion
  }

  #endregion
}