cstdotnet/CSTNet/CST.cs

// This project is licensed under the BSD 3-Clause license.
// See the LICENSE file in the project root for more information.

namespace CSTNet;

[Obsolete("Use CST class instead.")]
public class CaretSeparatedText : CST { }

public class CST
{
    const char CARET = '^';
    const string LF = "\u000A";
    const string CR = "\u000D";
    const string CRLF = "\u000D\u000A";
    const string LS = "\u2028";

    /// <summary>
    /// Gets the value from the digit-based key.
    /// </summary>
    /// <returns>Returns the entry</returns>
    public static string Parse(string content, int key) => Parse(content, key.ToString());

    /// <summary>
    /// Gets the value from the string-based key.
    /// </summary>
    /// <returns>Returns the entry</returns>
    public static string Parse(string content, string key)
    {
        var entries = NormalizeEntries(content);
        return GetEntry(entries, key);
    }

    /// <summary>
    /// Replaces the document's line endings with the native system line endings.
    /// </summary>
    /// <remarks>This stage ensures there are no crashes during parsing.</remarks>
    /// <param name="content">The content of the document.</param>
    /// <returns>The document's content with native system line endings.</returns>
    static IEnumerable<string> NormalizeEntries(string content)
    {
        // Check if the document already uses native system line endings.
        if (!content.Contains(Environment.NewLine))
        {
            // If not, check for and replace other line ending types.
            if (content.Contains(LF))
                content = content.Replace(LF, Environment.NewLine);

            if (content.Contains(CR))
                content = content.Replace(CR, Environment.NewLine);

            if (content.Contains(CRLF))
                content = content.Replace(CRLF, Environment.NewLine);

            if (content.Contains(LS))
                content = content.Replace(LS, Environment.NewLine);
        }

        // Split the content by the caret and newline characters.
        var lines = content.Split(new[] { $"{CARET}{Environment.NewLine}" },
            StringSplitOptions.RemoveEmptyEntries);

        // Filter out any lines that start with "//", "#", "/*", or end with "*/".
        return lines.Where(line =>
            !line.StartsWith("//") &&
            !line.StartsWith("#") &&
            !line.StartsWith("/*") &&
            !line.EndsWith("*/"))
            .AsEnumerable();
    }

    /// <summary>
    /// Retrieves the value for the specified key from the given entries.
    /// </summary>
    /// <param name="entries">The entries to search through.</param>
    /// <param name="key">The key to search for.</param>
    /// <returns>The value for the specified key, or a default string if not found.</returns>
    static string GetEntry(IEnumerable<string> entries, string key)
    {
        // Iterate through the entries.
        foreach (var entry in entries)
        {
            // If the line doesn't start with the key, keep searching.
            if (!entry.StartsWith(key))
                continue;

            // Locate the index of the caret character.
            var startIndex = entry.IndexOf(CARET);
            // Get the line from the caret character to the end of the string.
            var line = entry[startIndex..];

            // Return the line with the caret characters trimmed.
            return line.TrimStart(CARET).TrimEnd(CARET);
        }

        // If no entry is found, return a default string.
        return "***MISSING***";
    }

}