private Stream GenerateDiff(Stream oldApiXml, Stream newApiXml, string assemblyName)
{
var config = new ApiDiffFormattedConfig
{
Formatter = ApiDiffFormatter.Markdown,
IgnoreNonbreaking = IgnoreNonbreaking,
IgnoreParameterNameChanges = IgnoreParameterNames,
IgnoreVirtualChanges = IgnoreVirtualChanges,
};
var diff = new MemoryStream();
using (var writer = new StreamWriter(diff, UTF8NoBOM, DefaultSaveBufferSize, true))
{
ApiDiffFormatted.Generate(oldApiXml, newApiXml, writer, config);
}
if (diff.Length == 0)
{
using var writer = new StreamWriter(diff, UTF8NoBOM, DefaultSaveBufferSize, true);
writer.WriteLine($"# API diff: {assemblyName}.dll");
writer.WriteLine();
writer.WriteLine($"## {assemblyName}.dll");
writer.WriteLine();
writer.WriteLine($"> No changes.");
}
oldApiXml.Position = 0;
newApiXml.Position = 0;
diff.Position = 0;
return(diff);
}
static State CreateState(ApiDiffFormattedConfig config)
{
if (config == null)
{
config = new ApiDiffFormattedConfig();
}
var state = new State {
Colorize = config.Colorize,
Formatter = null,
IgnoreAddedPropertySetters = config.IgnoreAddedPropertySetters,
IgnoreVirtualChanges = config.IgnoreVirtualChanges,
IgnoreNonbreaking = config.IgnoreNonbreaking,
IgnoreParameterNameChanges = config.IgnoreParameterNameChanges,
Lax = config.IgnoreDuplicateXml,
Verbosity = config.Verbosity
};
state.IgnoreAdded.AddRange(config.IgnoreAdded);
state.IgnoreNew.AddRange(config.IgnoreNew);
state.IgnoreRemoved.AddRange(config.IgnoreRemoved);
switch (config.Formatter)
{
case ApiDiffFormatter.Html:
state.Formatter = new HtmlFormatter(state);
break;
case ApiDiffFormatter.Markdown:
state.Formatter = new MarkdownFormatter(state);
break;
default:
throw new ArgumentException("Invlid formatter specified.");
}
// unless specified default to HTML
if (state.Formatter == null)
{
state.Formatter = new HtmlFormatter(state);
}
if (state.IgnoreNonbreaking)
{
state.IgnoreAddedPropertySetters = true;
state.IgnoreVirtualChanges = true;
state.IgnoreNew.Add(new Regex(".*"));
state.IgnoreAdded.Add(new Regex(".*"));
}
return(state);
}
public static void Generate(string firstInfo, string secondInfo, TextWriter outStream, ApiDiffFormattedConfig config = null)
{
var state = CreateState(config);
Generate(firstInfo, secondInfo, outStream, state);
}
public static int Main(string[] args)
{
var showHelp = false;
string diff = null;
List <string> extra = null;
var config = new ApiDiffFormattedConfig();
var options = new Mono.Options.OptionSet {
{ "h|help", "Show this help", v => showHelp = true },
{ "d|o|out=|output=|diff=", "HTML diff file out output (omit for stdout)", v => diff = v },
{ "i|ignore=", "Ignore new, added, and removed members whose description matches a given C# regular expression (see below).",
v => {
var r = new Regex(v);
config.IgnoreAdded.Add(r);
config.IgnoreRemoved.Add(r);
config.IgnoreNew.Add(r);
} },
{ "a|ignore-added=", "Ignore added members whose description matches a given C# regular expression (see below).",
v => config.IgnoreAdded.Add(new Regex(v)) },
{ "r|ignore-removed=", "Ignore removed members whose description matches a given C# regular expression (see below).",
v => config.IgnoreRemoved.Add(new Regex(v)) },
{ "n|ignore-new=", "Ignore new namespaces and types whose description matches a given C# regular expression (see below).",
v => config.IgnoreNew.Add(new Regex(v)) },
{ "ignore-changes-parameter-names", "Ignore changes to parameter names for identically prototyped methods.",
v => config.IgnoreParameterNameChanges = v != null },
{ "ignore-changes-property-setters", "Ignore adding setters to properties.",
v => config.IgnoreAddedPropertySetters = v != null },
{ "ignore-changes-virtual", "Ignore changing non-`virtual` to `virtual` or adding `override`.",
v => config.IgnoreVirtualChanges = v != null },
{ "c|colorize:", "Colorize HTML output", v => config.Colorize = string.IsNullOrEmpty(v) ? true : bool.Parse(v) },
{ "x|lax", "Ignore duplicate XML entries", v => config.IgnoreDuplicateXml = true },
{ "ignore-nonbreaking", "Ignore all nonbreaking changes", v => config.IgnoreNonbreaking = true },
{ "v|verbose:", "Verbosity level; when set, will print debug messages",
(int?v) => config.Verbosity = v ?? (config.Verbosity + 1) },
{ "md|markdown", "Output markdown instead of HTML", v => config.Formatter = ApiDiffFormatter.Markdown },
new Mono.Options.ResponseFileSource(),
};
try {
extra = options.Parse(args);
} catch (Mono.Options.OptionException e) {
Console.WriteLine("Option error: {0}", e.Message);
extra = null;
}
if (showHelp || extra == null || extra.Count < 2 || extra.Count > 3)
{
Console.WriteLine(@"Usage: mono-api-html [options] <reference.xml> <assembly.xml> [diff.html]");
Console.WriteLine();
Console.WriteLine("Available options:");
options.WriteOptionDescriptions(Console.Out);
Console.WriteLine();
Console.WriteLine("Ignoring Members:");
Console.WriteLine();
Console.WriteLine(" Members that were added can be filtered out of the diff by using the");
Console.WriteLine(" -i, --ignore-added option. The option takes a C# regular expression");
Console.WriteLine(" to match against member descriptions. For example, to ignore the");
Console.WriteLine(" introduction of the interfaces 'INSCopying' and 'INSCoding' on types");
Console.WriteLine(" pass the following to mono-api-html:");
Console.WriteLine();
Console.WriteLine(" mono-api-html ... -i 'INSCopying$' -i 'INSCoding$'");
Console.WriteLine();
Console.WriteLine(" The regular expressions will match any member description ending with");
Console.WriteLine(" 'INSCopying' or 'INSCoding'.");
Console.WriteLine();
return(showHelp ? 0 : 1);
}
var input = extra [0];
var output = extra [1];
if (extra.Count == 3 && diff == null)
{
diff = extra [2];
}
TextWriter outputStream = null;
try {
if (!string.IsNullOrEmpty(diff))
{
outputStream = new StreamWriter(diff);
}
ApiDiffFormatted.Generate(input, output, outputStream ?? Console.Out, config);
} catch (Exception e) {
Console.WriteLine(e);
return(1);
} finally {
outputStream?.Dispose();
}
return(0);
}
