src/Npgsql/NameTranslation/NpgsqlSnakeCaseNameTranslator.cs - main - dev-npgsql/npgsql

src/Npgsql/NameTranslation/NpgsqlSnakeCaseNameTranslator.cs
138 строк5 KB
Nino Floris
Remove obsolete UTF-8 BOMs (#6542)
13 апр 2026, 17:13
13 апр 2026, 17:135225216
using System;
using System.Collections.Generic;
using System.Globalization;
using System.Text;

namespace Npgsql.NameTranslation;

/// <summary>
/// A name translator which converts standard CLR names (e.g. SomeClass) to snake-case database
/// names (some_class)
/// </summary>
public sealed class NpgsqlSnakeCaseNameTranslator : INpgsqlNameTranslator
{
    internal static NpgsqlSnakeCaseNameTranslator Instance { get; } = new();

    readonly CultureInfo _culture;

    /// <summary>
    /// Creates a new <see cref="NpgsqlSnakeCaseNameTranslator"/>.
    /// </summary>
    /// <param name="culture">
    /// An object that supplies culture-specific casing rules.
    /// This will be used when converting names to lower case.
    /// If <see langword="null"/> then <see cref="CultureInfo.InvariantCulture"/> will be used.
    /// </param>
    public NpgsqlSnakeCaseNameTranslator(CultureInfo? culture = null)
        : this(false, culture) { }

    /// <summary>
    /// Creates a new <see cref="NpgsqlSnakeCaseNameTranslator"/>.
    /// </summary>
    /// <param name="legacyMode">
    /// Uses the legacy naming convention if <see langword="true"/>, otherwise it uses the new naming convention.
    /// </param>
    /// <param name="culture">
    /// An object that supplies culture-specific casing rules.
    /// This will be used when converting names to lower case.
    /// If <see langword="null"/> then <see cref="CultureInfo.InvariantCulture"/> will be used.
    /// </param>
    public NpgsqlSnakeCaseNameTranslator(bool legacyMode, CultureInfo? culture = null)
    {
        LegacyMode = legacyMode;
        _culture = culture ?? CultureInfo.InvariantCulture;
    }

    bool LegacyMode { get; }

    /// <summary>
    /// Given a CLR type name (e.g class, struct, enum), translates its name to a database type name.
    /// </summary>
    public string TranslateTypeName(string clrName) => TranslateMemberName(clrName);

    /// <summary>
    /// Given a CLR member name (property or field), translates its name to a database type name.
    /// </summary>
    public string TranslateMemberName(string clrName)
    {
        ArgumentNullException.ThrowIfNull(clrName);

        return LegacyMode
            ? string.Concat(LegacyModeMap(clrName)).ToLower(_culture)
            : ConvertToSnakeCase(clrName, _culture);

        IEnumerable<string> LegacyModeMap(string clrName)
        {
            for (var i = 0; i < clrName.Length; i++)
            {
                var c = clrName[i];
                yield return i > 0 && char.IsUpper(c) ? "_" + c.ToString() : c.ToString();
            }
        }
    }

    /// <summary>
    /// Converts a string to its snake_case equivalent.
    /// </summary>
    /// <param name="name">The value to convert.</param>
    /// <param name="culture">
    /// An object that supplies culture-specific casing rules.
    /// This will be used when converting names to lower case.
    /// If <see langword="null"/> then <see cref="CultureInfo.InvariantCulture"/> will be used.
    /// </param>
    public static string ConvertToSnakeCase(string name, CultureInfo? culture = null)
    {
        if (string.IsNullOrEmpty(name))
            return name;

        var builder = new StringBuilder(name.Length + Math.Min(2, name.Length / 5));
        var previousCategory = default(UnicodeCategory?);

        for (var currentIndex = 0; currentIndex < name.Length; currentIndex++)
        {
            var currentChar = name[currentIndex];
            if (currentChar == '_')
            {
                builder.Append('_');
                previousCategory = null;
                continue;
            }

            var currentCategory = char.GetUnicodeCategory(currentChar);
            switch (currentCategory)
            {
            case UnicodeCategory.UppercaseLetter:
            case UnicodeCategory.TitlecaseLetter:
                if (previousCategory == UnicodeCategory.SpaceSeparator ||
                    previousCategory == UnicodeCategory.LowercaseLetter ||
                    previousCategory != UnicodeCategory.DecimalDigitNumber &&
                    previousCategory != null &&
                    currentIndex > 0 &&
                    currentIndex + 1 < name.Length &&
                    char.IsLower(name[currentIndex + 1]))
                {
                    builder.Append('_');
                }

                currentChar = char.ToLower(currentChar, culture ?? CultureInfo.InvariantCulture);
                break;

            case UnicodeCategory.LowercaseLetter:
            case UnicodeCategory.DecimalDigitNumber:
                if (previousCategory == UnicodeCategory.SpaceSeparator)
                    builder.Append('_');
                break;

            default:
                if (previousCategory != null)
                    previousCategory = UnicodeCategory.SpaceSeparator;
                continue;
            }

            builder.Append(currentChar);
            previousCategory = currentCategory;
        }

        return builder.ToString();
    }
}