summaryrefslogtreecommitdiff
path: root/src/SMAPI.Web/Framework/LogParsing/LogMessageBuilder.cs
blob: a1384b8fffdb47c3c80617f8f3d60138c87cd0d3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
using System;
using System.Diagnostics.CodeAnalysis;
using System.Text;
using StardewModdingAPI.Web.Framework.LogParsing.Models;

namespace StardewModdingAPI.Web.Framework.LogParsing
{
    /// <summary>Handles constructing log message instances with minimal memory allocation.</summary>
    internal class LogMessageBuilder
    {
        /*********
        ** Fields
        *********/
        /// <summary>The local time when the next log was posted.</summary>
        public string? Time { get; set; }

        /// <summary>The log level for the next log message.</summary>
        public LogLevel Level { get; set; }

        /// <summary>The screen ID in split-screen mode.</summary>
        public int ScreenId { get; set; }

        /// <summary>The mod name for the next log message.</summary>
        public string? Mod { get; set; }

        /// <summary>The text for the next log message.</summary>
        private readonly StringBuilder Text = new();


        /*********
        ** Accessors
        *********/
        /// <summary>Whether the next log message has been started.</summary>
        [MemberNotNullWhen(true, nameof(LogMessageBuilder.Time), nameof(LogMessageBuilder.Mod))]
        public bool Started { get; private set; }


        /*********
        ** Public methods
        *********/
        /// <summary>Start accumulating values for a new log message.</summary>
        /// <param name="time">The local time when the log was posted.</param>
        /// <param name="level">The log level.</param>
        /// <param name="screenId">The screen ID in split-screen mode.</param>
        /// <param name="mod">The mod name.</param>
        /// <param name="text">The initial log text.</param>
        /// <exception cref="InvalidOperationException">A log message is already started; call <see cref="Clear"/> before starting a new message.</exception>
        public void Start(string time, LogLevel level, int screenId, string mod, string text)
        {
            if (this.Started)
                throw new InvalidOperationException("Can't start new message, previous log message isn't done yet.");

            this.Started = true;

            this.Time = time;
            this.Level = level;
            this.ScreenId = screenId;
            this.Mod = mod;
            this.Text.Append(text);
        }

        /// <summary>Add a new line to the next log message being built.</summary>
        /// <param name="text">The line to add.</param>
        /// <exception cref="InvalidOperationException">A log message hasn't been started yet.</exception>
        public void AddLine(string text)
        {
            if (!this.Started)
                throw new InvalidOperationException("Can't add text, no log message started yet.");

            this.Text.Append("\n");
            this.Text.Append(text);
        }

        /// <summary>Get a log message for the accumulated values.</summary>
        public LogMessage? Build()
        {
            if (!this.Started)
                return null;

            return new LogMessage(
                time: this.Time,
                level: this.Level,
                screenId: this.ScreenId,
                mod: this.Mod,
                text: this.Text.ToString()
            );
        }

        /// <summary>Reset to start a new log message.</summary>
        public void Clear()
        {
            this.Started = false;
            this.Text.Clear();
        }
    }
}