// ==++==
//
//   Copyright (c) Microsoft Corporation.  All rights reserved.
//
// ==--==
/*============================================================
**
** Class:  TextWriter
**
**
** Purpose: Abstract base class for Text-only Writers.
** Subclasses will include StreamWriter & StringWriter.
**
** Date:  February 21, 2000
**
===========================================================*/

using System;
using System.Text;
using System.Threading;
using System.Runtime.CompilerServices;
using System.Reflection;

namespace System.IO {
    // This abstract base class represents a writer that can write a sequential
    // stream of characters. A subclass must minimally implement the
    // Write(char) method.
    //
    // This class is intended for character output, not bytes.
    // There are methods on the Stream class for writing bytes.
    //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter"]/*' />
    public abstract class TextWriter : IDisposable
    {
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Null"]/*' />
        public static readonly TextWriter Null = new NullTextWriter();

        // @TODO PORTING: This should be initialized to Environment.NewLine, but
        // we don't want to load Environment unnecessarily so I've duplicated
        // the value here.
        private const String InitialNewLine = "\r\n";

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.CoreNewLine"]/*' />
        protected char[] CoreNewLine = InitialNewLine.ToCharArray();

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.TextWriter"]/*' />
        protected TextWriter()
        {
        }

        // Closes this TextWriter and releases any system resources associated with the
        // TextWriter. Following a call to Close, any operations on the TextWriter
        // may raise exceptions. This default method is empty, but descendant
        // classes can override the method to provide the appropriate
        // functionality.
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Close"]/*' />
        public virtual void Close() {
            Dispose(true);
        }

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Dispose"]/*' />
        protected virtual void Dispose(bool disposing)
        {
        }


        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.IDisposable.Dispose"]/*' />
        /// <internalonly/>
        void IDisposable.Dispose()
        {
            Dispose(true);
        }

        // Clears all buffers for this TextWriter and causes any buffered data to be
        // written to the underlying device. This default method is empty, but
        // descendant classes can override the method to provide the appropriate
        // functionality.
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Flush"]/*' />
        public virtual void Flush() {
        }

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Encoding"]/*' />
        public abstract Encoding Encoding {
            get;
        }

        // Returns the line terminator string used by this TextWriter. The default line
        // terminator string is a carriage return followed by a line feed ("\r\n").
        //
        // Sets the line terminator string for this TextWriter. The line terminator
        // string is written to the text stream whenever one of the
        // WriteLine methods are called. In order for text written by
        // the TextWriter to be readable by a TextReader, only one of the following line
        // terminator strings should be used: "\r", "\n", or "\r\n".
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.NewLine"]/*' />
        public virtual String NewLine {
            get { return new String(CoreNewLine); }
            set {
                if (value == null)
                    value = InitialNewLine;
                CoreNewLine = value.ToCharArray();
            }
        }


        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Synchronized"]/*' />
        public static TextWriter Synchronized(TextWriter writer) {
            if (writer==null)
                throw new ArgumentNullException("writer");
            if (writer is SyncTextWriter)
                return writer;

            return new SyncTextWriter(writer);
        }

        // Writes a character to the text stream. This default method is empty,
        // but descendant classes can override the method to provide the
        // appropriate functionality.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write"]/*' />
        public virtual void Write(char value) {
        }

        // Writes a character array to the text stream. This default method calls
        // Write(char) for each of the characters in the character array.
        // If the character array is null, nothing is written.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write1"]/*' />
        public virtual void Write(char[] buffer) {
            if (buffer != null) Write(buffer, 0, buffer.Length);
        }

        // Writes a range of a character array to the text stream. This method will
        // write count characters of data into this TextWriter from the
        // buffer character array starting at position index.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write2"]/*' />
        public virtual void Write(char[] buffer, int index, int count) {
            if (buffer==null)
                throw new ArgumentNullException("buffer", "ArgumentNull_Buffer");
            if (index < 0)
                throw new ArgumentOutOfRangeException("index", "ArgumentOutOfRange_NeedNonNegNum");
            if (count < 0)
                throw new ArgumentOutOfRangeException("count", "ArgumentOutOfRange_NeedNonNegNum");
            if (buffer.Length - index < count)
                throw new ArgumentException("Argument_InvalidOffLen");

            for (int i = 0; i < count; i++) Write(buffer[index + i]);
        }

        // Writes the text representation of a boolean to the text stream. This
        // method outputs either Boolean.TrueString or Boolean.FalseString.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write3"]/*' />
        public virtual void Write(bool value) {
            Write(value ? Boolean.TrueString : Boolean.FalseString);
        }

        // Writes the text representation of an integer to the text stream. The
        // text representation of the given value is produced by calling the
        // Int32.ToString() method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write4"]/*' />
        public virtual void Write(int value) {
            Write(value.ToString());
        }

        // Writes the text representation of an integer to the text stream. The
        // text representation of the given value is produced by calling the
        // UInt32.ToString() method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write5"]/*' />
        [CLSCompliant(false)]
        public virtual void Write(uint value) {
            Write(value.ToString());
        }

        // Writes the text representation of a long to the text stream. The
        // text representation of the given value is produced by calling the
        // Int64.ToString() method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write6"]/*' />
        public virtual void Write(long value) {
            Write(value.ToString());
        }

        // Writes the text representation of an unsigned long to the text
        // stream. The text representation of the given value is produced
        // by calling the UInt64.ToString() method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write7"]/*' />
        [CLSCompliant(false)]
        public virtual void Write(ulong value) {
            Write(value.ToString());
        }

        // Writes the text representation of a float to the text stream. The
        // text representation of the given value is produced by calling the
        // Float.toString(float) method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write8"]/*' />
        public virtual void Write(float value) {
            Write(value.ToString());
        }

        // Writes the text representation of a double to the text stream. The
        // text representation of the given value is produced by calling the
        // Double.toString(double) method.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write9"]/*' />
        public virtual void Write(double value) {
            Write(value.ToString());
        }

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write10"]/*' />
        public virtual void Write(Decimal value) {
            Write(value.ToString());
        }

        // Writes a string to the text stream. If the given string is null, nothing
        // is written to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write11"]/*' />
        public virtual void Write(String value) {
            if (value != null) Write(value.ToCharArray());
        }

        // Writes the text representation of an object to the text stream. If the
        // given object is null, nothing is written to the text stream.
        // Otherwise, the object's ToString method is called to produce the
        // string representation, and the resulting string is then written to the
        // output stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write12"]/*' />
        public virtual void Write(Object value) {
            if (value != null) {
                Write(value.ToString());
            }
        }

    //      // Converts the wchar * to a string and writes this to the stream.
    //      //
    //      __attribute NonCLSCompliantAttribute()
    //      public void Write(wchar *value) {
    //          Write(new String(value));
    //      }

    //      // Treats the byte* as a LPCSTR, converts it to a string, and writes it to the stream.
    //      //
    //      __attribute NonCLSCompliantAttribute()
    //      public void Write(byte *value) {
    //          Write(new String(value));
    //      }


        // Writes out a formatted string.  Uses the same semantics as
        // String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write13"]/*' />
        public virtual void Write(String format, Object arg0)
        {
            Write(String.Format(format, arg0));
        }

        // Writes out a formatted string.  Uses the same semantics as
        // String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write14"]/*' />
        public virtual void Write(String format, Object arg0, Object arg1)
        {
            Write(String.Format(format, arg0, arg1));
        }

        // Writes out a formatted string.  Uses the same semantics as
        // String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write15"]/*' />
        public virtual void Write(String format, Object arg0, Object arg1, Object arg2)
        {
            Write(String.Format(format, arg0, arg1, arg2));
        }

        // Writes out a formatted string.  Uses the same semantics as
        // String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.Write16"]/*' />
        public virtual void Write(String format, params Object[] arg)
        {
            Write(String.Format(format, arg));
        }


        // Writes a line terminator to the text stream. The default line terminator
        // is a carriage return followed by a line feed ("\r\n"), but this value
        // can be changed by setting the NewLine property.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine"]/*' />
        public virtual void WriteLine() {
            Write(CoreNewLine);
        }

        // Writes a character followed by a line terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine1"]/*' />
        public virtual void WriteLine(char value) {
            Write(value);
            WriteLine();
        }

        // Writes an array of characters followed by a line terminator to the text
        // stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine2"]/*' />
        public virtual void WriteLine(char[] buffer) {
            Write(buffer);
            WriteLine();
        }

        // Writes a range of a character array followed by a line terminator to the
        // text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine3"]/*' />
        public virtual void WriteLine(char[] buffer, int index, int count) {
            Write(buffer, index, count);
            WriteLine();
        }

        // Writes the text representation of a boolean followed by a line
        // terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine4"]/*' />
        public virtual void WriteLine(bool value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of an integer followed by a line
        // terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine5"]/*' />
        public virtual void WriteLine(int value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of an unsigned integer followed by
        // a line terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine6"]/*' />
        [CLSCompliant(false)]
        public virtual void WriteLine(uint value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of a long followed by a line terminator
        // to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine7"]/*' />
        public virtual void WriteLine(long value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of an unsigned long followed by
        // a line terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine8"]/*' />
        [CLSCompliant(false)]
        public virtual void WriteLine(ulong value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of a float followed by a line terminator
        // to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine9"]/*' />
        public virtual void WriteLine(float value) {
            Write(value);
            WriteLine();
        }

        // Writes the text representation of a double followed by a line terminator
        // to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine10"]/*' />
        public virtual void WriteLine(double value) {
            Write(value);
            WriteLine();
        }

        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine11"]/*' />
        public virtual void WriteLine(decimal value) {
            Write(value);
            WriteLine();
        }

        // Writes a string followed by a line terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine12"]/*' />
        public virtual void WriteLine(String value) {

            if (value==null) {
                WriteLine();
            }
            else {
                // We'd ideally like WriteLine to be atomic, in that one call
                // to WriteLine equals one call to the OS (ie, so writing to
                // console while simultaneously calling printf will guarantee we
                // write out a string and new line chars, without any interference).
                // Additionally, we need to call ToCharArray on Strings anyways,
                // so allocating a char[] here isn't any worse than what we were
                // doing anyways.  We do reduce the number of calls to the
                // backing store this way, potentially.
                int vLen = value.Length;
                int nlLen = CoreNewLine.Length;
                char[] chars = new char[vLen+nlLen];
                value.CopyTo(0, chars, 0, vLen);
                // CoreNewLine will almost always be 2 chars, and possibly 1.
                if (nlLen == 2) {
                    chars[vLen] = CoreNewLine[0];
                    chars[vLen+1] = CoreNewLine[1];
                }
                else if (nlLen == 1)
                    chars[vLen] = CoreNewLine[0];
                else
                    Buffer.BlockCopy(CoreNewLine, 0, chars, vLen * 2, nlLen * 2);
                Write(chars, 0, vLen + nlLen);
            }
            /*
            Write(value);  // We could call Write(String) on StreamWriter...
            WriteLine();
            */
        }

        // Writes the text representation of an object followed by a line
        // terminator to the text stream.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine13"]/*' />
        public virtual void WriteLine(Object value) {
            if (value==null) {
                WriteLine();
            }
            else {
                WriteLine(value.ToString());
            }
        }

    //      // Converts the wchar * to a string and writes this to the stream.
    //      //
    //      __attribute NonCLSCompliantAttribute()
    //      public void WriteLine(wchar *value) {
    //          Write(value);
    //          WriteLine();
    //      }

    //      // Treats the byte* as a LPCSTR, converts it to a string, and writes it to the stream.
    //      //
    //      __attribute NonCLSCompliantAttribute()
    //      public void WriteLine(byte *value) {
    //          Write(value);
    //          WriteLine();
    //      }

        // Writes out a formatted string and a new line.  Uses the same
        // semantics as String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine14"]/*' />
        public virtual void WriteLine(String format, Object arg0)
        {
            WriteLine(String.Format(format, arg0));
        }

        // Writes out a formatted string and a new line.  Uses the same
        // semantics as String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine15"]/*' />
        public virtual void WriteLine (String format, Object arg0, Object arg1)
        {
            WriteLine(String.Format(format, arg0, arg1));
        }

        // Writes out a formatted string and a new line.  Uses the same
        // semantics as String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine16"]/*' />
        public virtual void WriteLine (String format, Object arg0, Object arg1, Object arg2)
        {
            WriteLine(String.Format(format, arg0, arg1, arg2));
        }

        // Writes out a formatted string and a new line.  Uses the same
        // semantics as String.Format.
        //
        //| <include file='doc\TextWriter.uex' path='docs/doc[@for="TextWriter.WriteLine17"]/*' />
        public virtual void WriteLine (String format, params Object[] arg)
        {
            WriteLine(String.Format(format, arg));
        }

        // No data, no need to serialize
        private sealed class NullTextWriter : TextWriter
        {
            public override Encoding Encoding {
                get { return Encoding.Default;  }
            }

            public override void Write(char[] buffer, int index, int count) {
            }

            public override void Write(String value) {
            }
        }

        internal sealed class SyncTextWriter : TextWriter
        {
            private TextWriter _out;

            internal SyncTextWriter(TextWriter t) {
                _out = t;
            }

            public override Encoding Encoding {
                get { return _out.Encoding;  }
            }

            public override  String NewLine {
                [MethodImpl(MethodImplOptions.Synchronized)]
                get { return _out.NewLine; }
                [MethodImpl(MethodImplOptions.Synchronized)]
                set { _out.NewLine = value; }
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Close() {
                _out.Close();
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Flush() {
                _out.Flush();
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(char value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(char[] buffer) {
                _out.Write(buffer);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(char[] buffer, int index, int count) {
                _out.Write(buffer, index, count);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(bool value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(int value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized), CLSCompliant(false)]
            public override void Write(uint value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(long value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized), CLSCompliant(false)]
            public override void Write(ulong value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(float value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(double value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(String value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(Object value) {
                _out.Write(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(String format, Object arg0) {
                _out.Write(format, arg0);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(String format, Object arg0, Object arg1) {
                _out.Write(format, arg0, arg1);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(String format, Object arg0, Object arg1, Object arg2) {
                _out.Write(format, arg0, arg1, arg2);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void Write(String format, Object[] arg) {
                _out.Write(format, arg);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(char value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(char[] buffer) {
                _out.WriteLine(buffer);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(char[] buffer, int index, int count) {
                _out.WriteLine(buffer, index, count);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(bool value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(int value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized), CLSCompliant(false)]
            public override void WriteLine(uint value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(long value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized), CLSCompliant(false)]
            public override void WriteLine(ulong value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(float value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(double value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(String value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(Object value) {
                _out.WriteLine(value);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(String format, Object arg0) {
                _out.WriteLine(format, arg0);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(String format, Object arg0, Object arg1) {
                _out.WriteLine(format, arg0, arg1);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(String format, Object arg0, Object arg1, Object arg2) {
                _out.WriteLine(format, arg0, arg1, arg2);
            }

            [MethodImpl(MethodImplOptions.Synchronized)]
            public override void WriteLine(String format, Object[] arg) {
                _out.WriteLine(format, arg);
            }
        }
    }
}