CodeWriter

Wrapper around StringBuilder that provides formatting and utility methods for code writing.

C# Signature

internal sealed class CodeWriter : System.IDisposable

Examples

The following example demonstrates how to write a simple type declaration with a namespace, fields, and a method.

C#

using Hertzole.SourceGen;

public class SourceGenerator
{
    public string Generate()
    {
        // Must dispose when the writer is no longer needed.
        using CodeWriter writer = new CodeWriter();

        writer.AppendLine("using System;").AppendLine();
        writer.AppendNamespace("My.Namespace");
        writer.AppendLine("public class MyClass");
        // Creates a new indented block surrounded by two brackets.
        using (writer.WithBlock())
        {
            // Now inside the class scope

            // Create a new field and a new line below that to add some space.
            writer.AppendLine("public int myField;").AppendLine();

            writer.AppendLine("public void MyMethod()");
            using (writer.WithBlock())
            {
                writer.AppendLine("Console.WriteLine(\"Hello World!\");");
            }
        }

        // Call ToString to get the final string.
        return writer.ToString();
    }
}

The returning string from the writer would output this:

C#

using System;

namespace My.Namespace
{
    public class MyClass
    {
        public int myField;

        public void MyMethod()
        {
            Console.WriteLine("Hello World!");
        }
    }
}

Constructors

CodeWriter()

Creates a new instance of a CodeWriter.

C# Signature

public CodeWriter();

Properties

Indent

The current indent. Each indent is 4 spaces (equivalent to one tab).

C# Signature

public int Indent { get; set; }

Methods

Append(string?)

Appends string to the current line without creating a new line.

C# Signature

public CodeWriter Append(string? value);

value

The string to insert.

Returns

The current code writer instance after the append operation.

Append(ITypeSymbol, bool, bool)

Appends the string representation of the specified ITypeSymbol, along with its required declarations, without creating a newline.

Optionally inserts the partial keyword in the declaration if isPartial is true.

Optionally inserts the namespace if appendNamespace is true.

C# Signature

public CodeWriter Append(ITypeSymbol value, bool isPartial = true, bool appendNamespace = true);

value

The type to append.

isPartial

Whether to append the partial keyword in the declaration.

appendNamespace

Whether to append the namespace.

Returns

The current code writer instance after the append operation.

Append(object)

Appends the string representation of the specified object to the current line without creating a new line.

C# Signature

public CodeWriter Append(object value);

value

The object to append.

Returns

The current code writer instance after the append operation.

Append(bool)

Appends bool to the current line without creating a new line.

C# Signature

public CodeWriter Append(bool value);

value

The bool to insert.

Returns

The current code writer instance after the append operation.

Append(decimal, string, IFormatProvider?)

Appends decimal with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(decimal value, string format, IFormatProvider? provider = null);

value

The decimal to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(decimal)

Appends decimal to the current line without creating a new line.

C# Signature

public CodeWriter Append(decimal value);

value

The decimal to insert.

Returns

The current code writer instance after the append operation.

Append(double, string, IFormatProvider?)

Appends double with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(double value, string format, IFormatProvider? provider = null);

value

The double to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(float, string, IFormatProvider?)

Appends float with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(float value, string format, IFormatProvider? provider = null);

value

The float to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(float)

Appends float to the current line without creating a new line.

C# Signature

public CodeWriter Append(float value);

value

The float to insert.

Returns

The current code writer instance after the append operation.

Append(ulong, string, IFormatProvider?)

Appends ulong with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(ulong value, string format, IFormatProvider? provider = null);

value

The ulong to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(ulong)

Appends ulong to the current line without creating a new line.

C# Signature

public CodeWriter Append(ulong value);

value

The ulong to insert.

Returns

The current code writer instance after the append operation.

Append(long, string, IFormatProvider?)

Appends long with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(long value, string format, IFormatProvider? provider = null);

value

The long to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(long)

Appends long to the current line without creating a new line.

C# Signature

public CodeWriter Append(long value);

value

The long to insert.

Returns

The current code writer instance after the append operation.

Append(uint, string, IFormatProvider?)

Appends uint with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(uint value, string format, IFormatProvider? provider = null);

value

The uint to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(uint)

Appends uint to the current line without creating a new line.

C# Signature

public CodeWriter Append(uint value);

value

The uint to insert.

Returns

The current code writer instance after the append operation.

Append(int, string, IFormatProvider?)

Appends int with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(int value, string format, IFormatProvider? provider = null);

value

The int to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(double)

Appends double to the current line without creating a new line.

C# Signature

public CodeWriter Append(double value);

value

The double to insert.

Returns

The current code writer instance after the append operation.

Append(ushort, string, IFormatProvider?)

Appends ushort with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(ushort value, string format, IFormatProvider? provider = null);

value

The ushort to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(ReadOnlyMemory<char>)

Appends ReadOnlyMemory<char> to the current line without creating a new line.

C# Signature

public CodeWriter Append(ReadOnlyMemory<char> value);

value

The ReadOnlyMemory<char> to insert.

Returns

The current code writer instance after the append operation.

Append(ArrayBuilder<char>)

Appends ArrayBuilder<char> to the current line without creating a new line.

C# Signature

public CodeWriter Append(ArrayBuilder<char> value);

value

The ArrayBuilder<char> to insert.

Returns

The current code writer instance after the append operation.

Append(char)

Appends char to the current line without creating a new line.

C# Signature

public CodeWriter Append(char value);

value

The char to insert.

Returns

The current code writer instance after the append operation.

Append(char, int)

Appends the specified number of copies of the specified char value to the current line without creating a new line.

C# Signature

public CodeWriter Append(char value, int repeatCount);

value

The char to append.

repeatCount

How many times the char should be inserted.

Returns

The current code writer instance after the append operation.

Append(char[])

Appends the specified char array to the current line without creating a new line.

C# Signature

public CodeWriter Append(char[] value);

value

The char array to append.

Returns

The current code writer instance after the append operation.

Append(int)

Appends int to the current line without creating a new line.

C# Signature

public CodeWriter Append(int value);

value

The int to insert.

Returns

The current code writer instance after the append operation.

Append(ReadOnlySpan<char>)

Appends ReadOnlySpan<char> to the current line without creating a new line.

C# Signature

public CodeWriter Append(ReadOnlySpan<char> value);

value

The ReadOnlySpan<char> to insert.

Returns

The current code writer instance after the append operation.

Append(char[], int, int)

Appends a subarray of characters to the current line without creating a new line.

C# Signature

public CodeWriter Append(char[] value, int startIndex, int charCount);

value

The character array to append.

startIndex

The starting position in the character array.

charCount

The number of characters to append.

Returns

The current code writer instance after the append operation.

Append(byte, string, IFormatProvider?)

Appends byte with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(byte value, string format, IFormatProvider? provider = null);

value

The byte to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(sbyte)

Appends sbyte to the current line without creating a new line.

C# Signature

public CodeWriter Append(sbyte value);

value

The sbyte to insert.

Returns

The current code writer instance after the append operation.

Append(sbyte, string, IFormatProvider?)

Appends sbyte with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(sbyte value, string format, IFormatProvider? provider = null);

value

The sbyte to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(short)

Appends short to the current line without creating a new line.

C# Signature

public CodeWriter Append(short value);

value

The short to insert.

Returns

The current code writer instance after the append operation.

Append(short, string, IFormatProvider?)

Appends short with the specified format to the current line without creating a new line.

C# Signature

public CodeWriter Append(short value, string format, IFormatProvider? provider = null);

value

The short to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

Append(ushort)

Appends ushort to the current line without creating a new line.

C# Signature

public CodeWriter Append(ushort value);

value

The ushort to insert.

Returns

The current code writer instance after the append operation.

Append(byte)

Appends byte to the current line without creating a new line.

C# Signature

public CodeWriter Append(byte value);

value

The byte to insert.

Returns

The current code writer instance after the append operation.

AppendConditionalSymbol(string?)

Appends a conditional preprocessor directive (e.g. #if DEBUG). Does nothing if the condition is null or whitespace.

C# Signature

public CodeWriter AppendConditionalSymbol(string? condition);

condition

The condition for the preprocessor directive.

Returns

The current code writer instance after the append operation.

AppendEmbeddedAttribute()

Appends an [Embedded] attribute to the current line. You should only use this if you’ve added Microsoft.CodeAnalysis.EmbeddedAttribute.

C# Signature

public CodeWriter AppendEmbeddedAttribute();

Returns

The current code writer instance after the append operation.

AppendExcludeFromCodeCoverageAttribute()

Appends an ExcludeFromCodeCoverage attribute to the current line, followed by a newline.

C# Signature

public CodeWriter AppendExcludeFromCodeCoverageAttribute();

Returns

The current code writer instance after the append operation.

AppendGeneratedCodeAttribute(string, string)

Appends a GeneratedCode attribute to the current line, followed by a newline.

C# Signature

public CodeWriter AppendGeneratedCodeAttribute(string generator, string version);

generator

The name of the code generator.

version

The version of the code generator.

Returns

The current code writer instance after the append operation.

AppendIndentedSource(ReadOnlySpan<char>)

Appends an entire multi-line string to the writer and handles the indentation.

C# Signature

public CodeWriter AppendIndentedSource(ReadOnlySpan<char> value);

value

The value to append.

Examples

The following example demonstrates how to use AppendIndentedSource to insert a multi-line string.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static void AppendDisposedBlock(CodeWriter writer)
    {
        writer.AppendIndentedSource(
            """
            if (isDisposed)
            {
                throw new System.ObjectDisposedException("This object is disposed.");
            }
            """
        );
    }
}

Remarks

This method automatically indents each line of the string according to the current indentation level. It normalizes line endings and replaces tabs with spaces.

Returns

The current code writer instance after the append operation.

AppendIndentedSource(string)

Appends an entire multi-line string to the writer and handles the indentation.

C# Signature

public CodeWriter AppendIndentedSource(string value);

value

The value to append.

Examples

The following example demonstrates how to use AppendIndentedSource to insert a multi-line string.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static void AppendDisposedBlock(CodeWriter writer)
    {
        writer.AppendIndentedSource(
            """
            if (isDisposed)
            {
                throw new System.ObjectDisposedException("This object is disposed.");
            }
            """
        );
    }
}

Remarks

This method automatically indents each line of the string according to the current indentation level. It normalizes line endings and replaces tabs with spaces.

Returns

The current code writer instance after the append operation.

AppendLine(long, string, IFormatProvider?)

Appends long with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(long value, string format, IFormatProvider? provider = null);

value

The long to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(ulong)

Appends ulong followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ulong value);

value

The ulong to insert.

Returns

The current code writer instance after the append operation.

AppendLine(ulong, string, IFormatProvider?)

Appends ulong with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ulong value, string format, IFormatProvider? provider = null);

value

The ulong to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(float)

Appends float followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(float value);

value

The float to insert.

Returns

The current code writer instance after the append operation.

AppendLine(float, string, IFormatProvider?)

Appends float with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(float value, string format, IFormatProvider? provider = null);

value

The float to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(double)

Appends double followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(double value);

value

The double to insert.

Returns

The current code writer instance after the append operation.

AppendLine(decimal)

Appends decimal followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(decimal value);

value

The decimal to insert.

Returns

The current code writer instance after the append operation.

AppendLine(long)

Appends long followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(long value);

value

The long to insert.

Returns

The current code writer instance after the append operation.

AppendLine(decimal, string, IFormatProvider?)

Appends decimal with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(decimal value, string format, IFormatProvider? provider = null);

value

The decimal to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(bool)

Appends bool followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(bool value);

value

The bool to insert.

Returns

The current code writer instance after the append operation.

AppendLine(object)

Appends the string representation of the specified object followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(object value);

value

The object to append.

Returns

The current code writer instance after the append operation.

AppendLine(ITypeSymbol, bool, bool)

Appends the string representation of the specified ITypeSymbol, along with its required declarations, followed by a newline.

Optionally inserts the partial keyword in the declaration if isPartial is true.

Optionally inserts the namespace if appendNamespace is true.

C# Signature

public CodeWriter AppendLine(ITypeSymbol value, bool isPartial = true, bool appendNamespace = true);

value

The type to append.

isPartial

Whether to append the partial keyword in the declaration.

appendNamespace

Whether to append the namespace.

Returns

The current code writer instance after the append operation.

AppendLine(double, string, IFormatProvider?)

Appends double with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(double value, string format, IFormatProvider? provider = null);

value

The double to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(uint, string, IFormatProvider?)

Appends uint with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(uint value, string format, IFormatProvider? provider = null);

value

The uint to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(char[], int, int)

Appends a subarray of characters followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(char[] value, int startIndex, int charCount);

value

The character array to append.

startIndex

The starting position in the character array.

charCount

The number of characters to append.

Returns

The current code writer instance after the append operation.

AppendLine(int, string, IFormatProvider?)

Appends int with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(int value, string format, IFormatProvider? provider = null);

value

The int to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine()

Appends a newline to the current line.

C# Signature

public CodeWriter AppendLine();

Returns

The current code writer instance after the append operation.

AppendLine(string?)

Appends string followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(string? value);

value

The string to insert.

Returns

The current code writer instance after the append operation.

AppendLine(ReadOnlySpan<char>)

Appends ReadOnlySpan<char> followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ReadOnlySpan<char> value);

value

The ReadOnlySpan<char> to insert.

Returns

The current code writer instance after the append operation.

AppendLine(ReadOnlyMemory<char>)

Appends ReadOnlyMemory<char> followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ReadOnlyMemory<char> value);

value

The ReadOnlyMemory<char> to insert.

Returns

The current code writer instance after the append operation.

AppendLine(uint)

Appends uint followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(uint value);

value

The uint to insert.

Returns

The current code writer instance after the append operation.

AppendLine(char)

Appends char followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(char value);

value

The char to insert.

Returns

The current code writer instance after the append operation.

AppendLine(char, int)

Appends the specified number of copies of the specified char followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(char value, int repeatCount);

value

The char to append.

repeatCount

How many times the char should be inserted.

Returns

The current code writer instance after the append operation.

AppendLine(char[])

Appends the specified char array followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(char[] value);

value

The char array to append.

Returns

The current code writer instance after the append operation.

AppendLine(ArrayBuilder<char>)

Appends ArrayBuilder<char> followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ArrayBuilder<char> value);

value

The ArrayBuilder<char> to insert.

Returns

The current code writer instance after the append operation.

AppendLine(ushort)

Appends ushort followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ushort value);

value

The ushort to insert.

Returns

The current code writer instance after the append operation.

AppendLine(int)

Appends int followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(int value);

value

The int to insert.

Returns

The current code writer instance after the append operation.

AppendLine(ushort, string, IFormatProvider?)

Appends ushort with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(ushort value, string format, IFormatProvider? provider = null);

value

The ushort to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(byte)

Appends byte followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(byte value);

value

The byte to insert.

Returns

The current code writer instance after the append operation.

AppendLine(short, string, IFormatProvider?)

Appends short with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(short value, string format, IFormatProvider? provider = null);

value

The short to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(sbyte, string, IFormatProvider?)

Appends sbyte with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(sbyte value, string format, IFormatProvider? provider = null);

value

The sbyte to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(sbyte)

Appends sbyte followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(sbyte value);

value

The sbyte to insert.

Returns

The current code writer instance after the append operation.

AppendLine(byte, string, IFormatProvider?)

Appends byte with the specified format followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(byte value, string format, IFormatProvider? provider = null);

value

The byte to insert.

format

A standard or custom numeric format string.

provider

A optional object that supplies culture-specific formatting information.

Returns

The current code writer instance after the append operation.

AppendLine(short)

Appends short followed by a newline to the current line.

C# Signature

public CodeWriter AppendLine(short value);

value

The short to insert.

Returns

The current code writer instance after the append operation.

AppendNamespace(INamespaceSymbol?)

Appends a namespace declaration for the specified symbol. Does nothing if the symbol is null or a global namespace.

C# Signature

public CodeWriter AppendNamespace(INamespaceSymbol? symbol);

symbol

The namespace symbol to append.

Returns

The current code writer instance after the append operation.

AppendNamespace(string)

Appends a namespace declaration. Does nothing if the value is null or empty.

C# Signature

public CodeWriter AppendNamespace(string value);

value

The namespace name to append.

Returns

The current code writer instance after the append operation.

AppendNullable()

Appends #nullable enable. If appended, #nullable restore will be appended at the end of the file.

C# Signature

public CodeWriter AppendNullable();

Returns

The current code writer instance after the append operation.

AppendPreprocessorSymbol(string?)

Appends a preprocessor symbol. Prepends # if the value does not already start with it. Does nothing if the value is null or whitespace.

C# Signature

public CodeWriter AppendPreprocessorSymbol(string? value);

value

The preprocessor symbol to append (e.g. #endif or endif).

Returns

The current code writer instance after the append operation.

Clear()

Clears all written content and resets the writer state.

C# Signature

public CodeWriter Clear();

Returns

The current code writer instance after the append operation.

Dispose()

Disposes the code writer and returns the underlying StringBuilder to the pool.

C# Signature

public void Dispose();

ToString()

Returns the written content as a string. Closes any open namespace block and appends #nullable restore if needed.

C# Signature

public override string ToString();

Returns

The written content as a string.

WithBlock(bool)

Opens a new code block. Returns a disposable scope that closes the block and restores indentation when disposed.

C# Signature

public BlockScope WithBlock(bool newLineOnDispose = false);

newLineOnDispose

If true, a newline will be inserted when the block scope is disposed.

Examples

The following example demonstrates how to use WithBlock.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static string Write()
    {
        using CodeWriter writer = new CodeWriter();
        AppendMethod(writer, "Method1", true);
        AppendMethod(writer, "Method2", false);

        return writer.ToString();
    }

    public static void AppendMethod(CodeWriter writer, string methodName, bool isPublic)
    {
        writer.Append(isPublic ? "public " : "private ")
              .Append("void ").Append(methodName).AppendLine("()");

        // Must dispose the scope to close the block and restore indentation.
        using (writer.WithBlock())
        {
            writer.AppendLine("Console.WriteLine(\"Hello World!\");");
        }
    }
}

The output from the writer would be:

C#

public void Method1()
{
    Console.WriteLine("Hello World!");
}
public void Method2()
{
    Console.WriteLine("Hello World!");
}

The following examples demonstrates the output when newLineOnDispose is set to true.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static string Write()
    {
        using CodeWriter writer = new CodeWriter();
        AppendMethod(writer, "Method1", true);
        AppendMethod(writer, "Method2", false);

        return writer.ToString();
    }

    public static void AppendMethod(CodeWriter writer, string methodName, bool isPublic)
    {
        writer.Append(isPublic ? "public " : "private ")
              .Append("void ").Append(methodName).AppendLine("()");

        // Must dispose the scope to close the block and restore indentation.
        //  This will add a new line when closing the block.
        using (writer.WithBlock(true))
        {
            writer.AppendLine("Console.WriteLine(\"Hello World!\");");
        }
    }
}

The output from the writer would be:

C#

public void Method1()
{
    Console.WriteLine("Hello World!");
}

public void Method2()
{
    Console.WriteLine("Hello World!");
}

Returns

A disposable scope that closes the block when disposed.

WithCondition(string?)

Creates a scope in a preprocessor conditional block (#if CONDITION). Returns a disposable scope that closes the conditional block (#endif) when disposed.

C# Signature

public ConditionalScope WithCondition(string? condition);

condition

The condition.

Examples

The following example demonstrates how to use WithCondition to wrap the content in a preprocessor conditional block.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static void Write()
    {
        using CodeWriter writer = new CodeWriter();
        writer.AppendLine("public void Method()");
        using (writer.WithBlock())
        {
            AppendDebugLog(writer, "Calling method!");
            writer.AppendLine("// TODO: Method stuff");
        }
    }

    public static void AppendDebugLog(CodeWriter writer, string message)
    {
        using (writer.WithCondition("DEBUG"))
        {
            writer.AppendLine($"System.Diagnostics.Debug.WriteLine(\"{message}\");");
        }
    }
}

The output from the writer would be:

C#

public void Method()
{
#if DEBUG
    System.Diagnostics.Debug.WriteLine("Calling method!");
#endif
    // TODO: Method stuff
}

Remarks

You can write #if CONDITION, if CONDITION or just CONDITION and the condition will be wrapped in #if and #endif, as long as the provided string isn’t null or empty/whitespace.

Returns

A disposable scope that closes the conditional block when disposed.

WithIndent(int)

Temporarily changes the indentation level. Returns a disposable scope that restores the original indentation when disposed.

C# Signature

public IndentScope WithIndent(int newIndent);

newIndent

The indentation level to use within the scope.

Examples

The following example demonstrates how to use WithIndent to change indentation.

C#

using Hertzole.SourceGen;

internal static class CodeHelper
{
    public static void Write()
    {
        using CodeWriter writer = new CodeWriter();
        writer.Indent = 1;
        writer.AppendLine("// Stairs");
        AppendStairs(writer, 5);
    }

    public static void AppendStairs(CodeWriter writer, int length)
    {
        using (writer.WithIndent(0))
        {
            for (int i = 0; i < length; i++)
            {
                writer.Append(' ', i).AppendLine('_');
            }
        }
    }
}

The output from the writer would be:

C#

    // Stairs
_
 _
  _
   _
    _

Returns

A disposable scope that restores the original indentation when disposed.