//
// IFormatStringError.cs
//
// Author:
//       Simon Lindgren <simon.n.lindgren@gmail.com>
//
// Copyright (c) 2012 Simon Lindgren
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

namespace ICSharpCode.NRefactory.Utils
{
	public interface IFormatStringError
	{
		int StartLocation { get; }

		int EndLocation { get; }

		string Message { get; }

		string OriginalText { get; }

		string SuggestedReplacementText { get; }
	}

	public class DefaultFormatStringError : IFormatStringError
	{
		public DefaultFormatStringError()
		{
			Message = "";
			OriginalText = "";
			SuggestedReplacementText = "";
		}

		#region IFormatStringError implementation
		public int StartLocation { get; set; }
		
		public int EndLocation { get; set; }
		
		public string Message { get; set; }
		
		public string OriginalText { get; set; }
		
		public string SuggestedReplacementText { get; set; }
		#endregion

		public override string ToString ()
		{
			return string.Format ("[DefaultFormatStringError: StartLocation={0}, EndLocation={1}, Message={2}, OriginalText={3}, SuggestedReplacementText={4}]", StartLocation, EndLocation, Message, OriginalText, SuggestedReplacementText);
		}
	}
}