Improving nested reporting

Author: grendello

tools/apput/src/Reporters/ApplicationPackageReporter.cs

@@ -16,7 +16,7 @@ public ApplicationPackageReporter (ApplicationPackage package, MarkdownDocument
 		this.package = package;
 	}
 
-	protected override void DoReport ()
+	protected override void DoReport (ReportForm form)
 	{
 		AddAspectDesc (package.PackageFormat);
 
@@ -56,12 +56,8 @@ protected override void DoReport ()
 				// Markdown renderer has a bug where it won't render the first item of the sub-list
 				// properly if the item line ends with a formatting character (or whitespace)
 				AddText (":  ", addIndent: false);
-				ReportDoc.BeginList ()
-				         .AddLabeledListItem ("Alignment", $"{lib.Alignment}")
-				         .AddLabeledListItem ("Debug info", $"{YesNo (lib.HasDebugInfo)}")
-				         .AddLabeledListItem ("Size", $"{lib.Size}", appendLine: false)
-				         .EndList ()
-				         .EndListItem ();
+				var libReporter = new SharedLibraryReporter (lib, ReportDoc);
+				libReporter.Report (ReportForm.SimpleList);
 			}
 			ReportDoc.AddNewline ();
 			ReportDoc.EndList ();

tools/apput/src/Reporters/BaseReporter.cs

@@ -48,14 +48,22 @@ protected BaseReporter (MarkdownDocument doc)
 		ReportDoc = doc;
 	}
 
-	public void Report ()
+	public void Report (ReportForm form)
 	{
-		WriteLine (BannerColor, $"# {AspectName} ({ShortDescription})");
-		DoReport ();
-		WriteLine ();
+		bool standalone = form == ReportForm.Standalone;
+
+		if (standalone) {
+			WriteLine (BannerColor, $"# {AspectName} ({ShortDescription})");
+		}
+
+		DoReport (form);
+
+		if (standalone) {
+			WriteLine ();
+		}
 	}
 
-	protected abstract void DoReport ();
+	protected abstract void DoReport (ReportForm form);
 
 	protected MarkdownDocument AddSection (string text, uint level = 1) => ReportDoc.AddHeading (level, text).AddNewline ();
 
@@ -96,6 +104,12 @@ protected void WriteNativeArch (NativeArchitecture arch)
 		WriteItem (NativeArchitectureLabel, arch.ToString ());
 	}
 
+	protected MarkdownDocument AddNativeArchListItem (NativeArchitecture arch)
+	{
+		ReportDoc.AddLabeledListItem (NativeArchitectureLabel, arch.ToString ());
+		return ReportDoc;
+	}
+
 	protected void WriteNativeArch (AndroidTargetArch arch)
 	{
 		WriteItem (NativeArchitectureLabel, arch.ToString ());

tools/apput/src/Reporters/IReporter.cs

@@ -2,5 +2,5 @@ namespace ApplicationUtility;
 
 interface IReporter
 {
-	void Report ();
+	void Report (ReportForm form = ReportForm.Standalone);
 }

tools/apput/src/Reporters/ReportForm.cs

@@ -0,0 +1,21 @@
+namespace ApplicationUtility;
+
+/// <summary>
+/// Form in which the object report should be generated.
+/// </summary>
+enum ReportForm
+{
+	/// <summary>
+	/// Standalone format means the reporter can generate the document in
+	/// an shape or form it wants as it's not part of a larger (outer)
+	/// report.
+	/// </summary>
+	Standalone,
+
+	/// <summary>
+	/// Report should be rendered as a simple list, one bit of information
+	/// per list item. It is meant to be part of a larger (outer)
+	/// report.
+	/// </summary>
+	SimpleList,
+}

tools/apput/src/Reporters/SharedLibraryReporter.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Text;
 
 namespace ApplicationUtility;
@@ -17,7 +18,24 @@ public SharedLibraryReporter (SharedLibrary library, MarkdownDocument doc)
 		this.library = library;
 	}
 
-	protected override void DoReport ()
+	protected override void DoReport (ReportForm form)
+	{
+		switch (form) {
+			case ReportForm.Standalone:
+				DoStandaloneReport ();
+				break;
+
+			case ReportForm.SimpleList:
+				DoListReport ();
+				break;
+
+			default:
+				throw new NotSupportedException ($"Unsupported report form '{form}'");
+		}
+	}
+
+	// TODO: migrate to Markdown
+	void DoStandaloneReport ()
 	{
 		WriteAspectDesc (LibraryKind);
 
@@ -37,6 +55,61 @@ protected override void DoReport ()
 		}
 	}
 
+	void DoListReport ()
+	{
+		ReportDoc.BeginList ();
+		AddNativeArchListItem (library.TargetArchitecture);
+		if (library.HasSoname) {
+			ReportDoc.AddLabeledListItem ("Soname", ValueOrNone (library.Soname));
+		}
+		AddBuildId ();
+		AddSize ();
+		AddAlignment ();
+		AddDebugInfo ();
+		AddAndroidIdent (appendLine: false);
+
+		ReportDoc.EndList ().EndListItem ();
+	}
+
+	void AddSoname ()
+	{
+		if (!library.HasSoname) {
+			return;
+		}
+
+		ReportDoc.AddLabeledListItem ("Soname", ValueOrNone (library.Soname));
+	}
+
+	void AddBuildId (bool appendLine = true)
+	{
+		ReportDoc.AddLabeledListItem ("Build ID", ValueOrNone (library.BuildID), appendLine: appendLine);
+	}
+
+	void AddAlignment (bool appendLine = true)
+	{
+		ReportDoc.AddLabeledListItem ("Alignment", $"{library.Alignment}", appendLine: appendLine);
+	}
+
+	void AddDebugInfo (bool appendLine = true)
+	{
+		ReportDoc.AddLabeledListItem ("Debug info", $"{YesNo (library.HasDebugInfo)}", appendLine: appendLine);
+	}
+
+	void AddSize (bool appendLine = true)
+	{
+		ReportDoc.AddLabeledListItem ("Size", $"{library.Size}", appendLine: appendLine);
+	}
+
+	void AddAndroidIdent (bool appendLine = true)
+	{
+		if (!library.HasAndroidIdent) {
+			return;
+		}
+
+		// TODO: fix output, currently produces gibberish
+		ReportDoc.AddLabeledListItem ("Android ident", "FIXME" /* ValueOrNone (library.AndroidIdent) */);
+	}
+
 	protected void WriteDebugInfoDesc ()
 	{
 		WriteItem ("Has debug info", YesNo (library.HasDebugInfo));

tools/apput/src/Reporters/XamarinAppSharedLibraryReporter.cs

@@ -14,9 +14,9 @@ public XamarinAppSharedLibraryReporter (XamarinAppSharedLibrary library, Markdow
 		this.library = library;
 	}
 
-	protected override void DoReport ()
+	protected override void DoReport (ReportForm form)
 	{
-		base.DoReport ();
+		base.DoReport (form);
 		WriteSubsectionBanner ("Xamarin.Android app library info");
 		WriteItem ("Format tag", $"0x{library.FormatTag:x}");
 	}