summaryrefslogtreecommitdiff
path: root/ThirdParty/CsvHelper-master/src/CsvHelper/CsvHelperException.cs
blob: 10e0cdc452488436054dc28cab525ca392947ba5 (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
// Copyright 2009-2022 Josh Close
// This file is a part of CsvHelper and is dual licensed under MS-PL and Apache 2.0.
// See LICENSE.txt for details or visit http://www.opensource.org/licenses/ms-pl.html for MS-PL and http://opensource.org/licenses/Apache-2.0 for Apache 2.0.
// https://github.com/JoshClose/CsvHelper
using CsvHelper.Configuration;
using System;
using System.Text;

namespace CsvHelper
{
	/// <summary>
	/// Represents errors that occur in CsvHelper.
	/// </summary>
	[Serializable]
	public class CsvHelperException : Exception
	{
		[NonSerialized]
		private readonly CsvContext context;

		/// <summary>
		/// Gets the context.
		/// </summary>
		public CsvContext Context => context;

		/// <summary>
		/// Initializes a new instance of the CsvHelperException class.
		/// </summary>
		internal protected CsvHelperException() : base() { }

		/// <summary>
		/// Initializes a new instance of the CsvHelperException class.
		/// </summary>
		/// <param name="message">The message that describes the error.</param>
		internal protected CsvHelperException(string message) : base(message) { }

		/// <summary>
		/// Initializes a new instance of the CsvHelperException class.
		/// </summary>
		/// <param name="message">The error message that explains the reason for the exception.</param>
		/// <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
		internal protected CsvHelperException(string message, Exception innerException) : base(message, innerException) { }

		/// <summary>
		/// Initializes a new instance of the <see cref="CsvHelperException"/> class.
		/// </summary>
		public CsvHelperException(CsvContext context)
		{
			this.context = context;
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="CsvHelperException"/> class
		/// with a specified error message.
		/// </summary>
		/// <param name="context">The context.</param>
		/// <param name="message">The message that describes the error.</param>
		public CsvHelperException(CsvContext context, string message) : base(AddDetails(message, context))
		{
			this.context = context;
		}

		/// <summary>
		/// Initializes a new instance of the <see cref="CsvHelperException"/> class
		/// with a specified error message and a reference to the inner exception that 
		/// is the cause of this exception.
		/// </summary>
		/// <param name="context">The context.</param>
		/// <param name="message">The error message that explains the reason for the exception.</param>
		/// <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
		public CsvHelperException(CsvContext context, string message, Exception innerException) : base(AddDetails(message, context), innerException)
		{
			this.context = context;
		}

		private static string AddDetails(string message, CsvContext context)
		{
			var indent = new string(' ', 3);

			var details = new StringBuilder();

			if (context.Reader != null)
			{
				details.AppendLine($"{nameof(IReader)} state:");
				details.AppendLine($"{indent}{nameof(IReader.ColumnCount)}: {context.Reader.ColumnCount}");
				details.AppendLine($"{indent}{nameof(IReader.CurrentIndex)}: {context.Reader.CurrentIndex}");
				try
				{
					var record = new StringBuilder();
					if (context.Reader.HeaderRecord != null)
					{
						record.Append("[\"");
						record.Append(string.Join("\",\"", context.Reader.HeaderRecord));
						record.Append("\"]");
					}

					details.AppendLine($"{indent}{nameof(IReader.HeaderRecord)}:{Environment.NewLine}{record}");
				}
				catch { }
			}

			if (context.Parser != null)
			{
				details.AppendLine($"{nameof(IParser)} state:");
				details.AppendLine($"{indent}{nameof(IParser.ByteCount)}: {context.Parser.ByteCount}");
				details.AppendLine($"{indent}{nameof(IParser.CharCount)}: {context.Parser.CharCount}");
				details.AppendLine($"{indent}{nameof(IParser.Row)}: {context.Parser.Row}");
				details.AppendLine($"{indent}{nameof(IParser.RawRow)}: {context.Parser.RawRow}");
				details.AppendLine($"{indent}{nameof(IParser.Count)}: {context.Parser.Count}");

				try
				{
					var rawRecord = context.Configuration.ExceptionMessagesContainRawData
						? context.Parser.RawRecord
						: $"Hidden because {nameof(IParserConfiguration.ExceptionMessagesContainRawData)} is false.";
					details.AppendLine($"{indent}{nameof(IParser.RawRecord)}:{Environment.NewLine}{rawRecord}");
				}
				catch { }
			}

			if (context.Writer != null)
			{
				details.AppendLine($"{nameof(IWriter)} state:");
				details.AppendLine($"{indent}{nameof(IWriter.Row)}: {context.Writer.Row}");
				details.AppendLine($"{indent}{nameof(IWriter.Index)}: {context.Writer.Index}");

				var record = new StringBuilder();
				if (context.Writer.HeaderRecord != null)
				{
					record.Append("[");
					if (context.Writer.HeaderRecord.Length > 0)
					{
						record.Append("\"");
						record.Append(string.Join("\",\"", context.Writer.HeaderRecord));
						record.Append("\"");
					}
					record.Append("]");
				}
				details.AppendLine($"{indent}{nameof(IWriter.HeaderRecord)}:{Environment.NewLine}{context.Writer.Row}");
			}

			return $"{message}{Environment.NewLine}{details}";
		}
	}
}