aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Logging/LogItemBase.cs
blob: 01d520f6ad5915077baffd0874b8c6ceb7d9bc38 (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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.IO;
using System.Linq;
using System.Runtime.Serialization.Formatters.Binary;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Logging
{
    /// <summary>
    /// Represents a base class for log items.
    /// </summary>
    [Serializable]
    public abstract class LogItemBase : INotifyPropertyChanged
    {
        private static String base_path;

        [NonSerialized]
        private Object _logObject;
        /// <summary>
        /// Gets or sets an optional log object.
        /// </summary>
        public Object LogObject
        {
            get { return _logObject; }
            set { _logObject = value; }
        }

        /// <summary>
        /// Gets or sets the caller method adding the exception.
        /// </summary>
        public String CallerMethodName { get; set; }

        /// <summary>
        /// Gets or sets the caller file.
        /// </summary>
        public String CallerFile { get; set; }

        /// <summary>
        /// Gets the relative caller file.
        /// </summary>
        public String RelativeCallerFile
        {
            get { return GetRelativeCallerFilePath(); }
        }

        /// <summary>
        /// Gets the name of the caller file class.
        /// </summary>
        public String ClassName
        {
            get { return RelativeCallerFile.Split('\\').LastOrDefault()?.Split('.').FirstOrDefault(); }
        }

        /// <summary>
        /// Gets or sets the caller line number.
        /// </summary>
        public int CallerLineNumber { get; set; }

        /// <summary>
        /// Gets or sets the DateTime for the log.
        /// </summary>
        public DateTime TimeStamp { get; set; }

        /// <summary>
        /// Gets or sets the log category.
        /// </summary>
        public LogCategory Category { get; set; }

        /// <summary>
        /// Gets the log message.
        /// </summary>
        public abstract String Message { get; set; }

        /// <summary>
        /// Returns a formatted string of the log item.
        /// </summary>
        public abstract override String ToString();

        /// <summary>
        /// Gets the relative caller file path.
        /// </summary>
        /// <returns></returns>
        protected virtual String GetRelativeCallerFilePath()
        {
            if (base_path == null)
            {
                int index = CallerFile.IndexOf("Visual_Studio") + "Visual_Studio".Length + 1;
                String relative = CallerFile.Substring(index, CallerFile.Length - index);
                base_path = CallerFile.Replace(relative, "");
            }

            if (Path.IsPathRooted(CallerFile))
            {
                return CallerFile.Remove(0, base_path.Length);
            }
            else
            {
                return CallerFile;
            }
        }

        /// <summary>
        /// Serializes this log item using <see cref="BinaryFormatter"/>.
        /// </summary>
        /// <returns></returns>
        public byte[] Serialize()
        {
            using (MemoryStream ms = new MemoryStream())
            {
                BinaryFormatter f = new BinaryFormatter();
                f.Serialize(ms, this);
                return ms.ToArray();
            }
        }

        /// <summary>
        /// Deserializes the specified data using <see cref="BinaryFormatter"/> to create a log item.
        /// </summary>
        /// <param name="data">The data.</param>
        /// <returns></returns>
        public static LogItemBase Deserialize(byte[] data)
        {
            using (MemoryStream ms = new MemoryStream(data))
            {
                ms.Position = 0;
                BinaryFormatter f = new BinaryFormatter();
                return f.Deserialize(ms) as LogItemBase;
            }
        }

        /// <summary>
        /// Raises the property changed event.
        /// </summary>
        /// <param name="propName">Name of the property.</param>
        protected virtual void RaisePropertyChanged(String propName)
        {
            PropertyChanged?.Invoke(this, new PropertyChangedEventArgs(propName));
        }

        /// <summary>
        /// Occurs when a property value changes.
        /// </summary>
        public event PropertyChangedEventHandler PropertyChanged;
    }
}