/*
    Copyright (C) 2014-2019 de4dot@gmail.com

    This file is part of dnSpy

    dnSpy is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    dnSpy is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with dnSpy.  If not, see <http://www.gnu.org/licenses/>.
*/

using VSUTIL = Microsoft.VisualStudio.Utilities;

namespace dnSpy.Contracts.Hex.Files {
	/// <summary>
	/// Creates <see cref="StructureProvider"/>s. Export an instance with
	/// a <see cref="VSUTIL.NameAttribute"/> and a <see cref="VSUTIL.OrderAttribute"/>,
	/// see also <see cref="PredefinedStructureProviderFactoryNames"/>
	/// </summary>
	public abstract class StructureProviderFactory {
		/// <summary>
		/// Constructor
		/// </summary>
		protected StructureProviderFactory() { }

		/// <summary>
		/// Creates a <see cref="StructureProvider"/> or returns null
		/// </summary>
		/// <param name="file">Buffer file</param>
		/// <returns></returns>
		public abstract StructureProvider? Create(HexBufferFile file);
	}
}