Dnspy/dnSpy/dnSpy.Contracts.Debugger/Exceptions/DbgExceptionFormatter.cs

74 lines
2.6 KiB
C#
Raw Permalink Normal View History

2021-09-20 18:20:01 +02:00
/*
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 System;
using System.ComponentModel.Composition;
using dnSpy.Contracts.Debugger.Text;
namespace dnSpy.Contracts.Debugger.Exceptions {
/// <summary>
/// Formats exceptions in the Exception Settings window. Use <see cref="ExportDbgExceptionFormatterAttribute"/>
/// to export an instance.
/// </summary>
public abstract class DbgExceptionFormatter {
/// <summary>
/// Writes the exception name. Returns true if it wrote the name.
/// </summary>
/// <param name="writer">Writer</param>
/// <param name="definition">Exception definition</param>
/// <returns></returns>
public virtual bool WriteName(IDbgTextWriter writer, DbgExceptionDefinition definition) => false;
}
/// <summary>Metadata</summary>
public interface IDbgExceptionFormatterMetadata {
/// <summary>See <see cref="ExportDbgExceptionFormatterAttribute.Order"/></summary>
double Order { get; }
/// <summary>See <see cref="ExportDbgExceptionFormatterAttribute.Category"/></summary>
string Category { get; }
}
/// <summary>
/// Exports a <see cref="DbgExceptionFormatter"/> instance
/// </summary>
[MetadataAttribute, AttributeUsage(AttributeTargets.Class, AllowMultiple = false)]
public sealed class ExportDbgExceptionFormatterAttribute : ExportAttribute, IDbgExceptionFormatterMetadata {
/// <summary>
/// Constructor
/// </summary>
/// <param name="category">Category, see <see cref="PredefinedExceptionCategories"/></param>
/// <param name="order">Order</param>
public ExportDbgExceptionFormatterAttribute(string category, double order = double.MaxValue)
: base(typeof(DbgExceptionFormatter)) {
Category = category ?? throw new ArgumentNullException(nameof(category));
Order = order;
}
/// <summary>
/// Category, see <see cref="PredefinedExceptionCategories"/>
/// </summary>
public string Category { get; }
/// <summary>
/// Order
/// </summary>
public double Order { get; }
}
}