Phoenixml.Platform

Foundation library for the Phoenixml family of XML-aware tools — Editor, Workbench, Studio. Apache-2.0.

What it is

The shared, vocabulary-agnostic substrate every Phoenixml app builds on:

• Document model — IDocument, dirty tracking, command-based undo/redo with merge support, multi-document services.
• Editor primitives — TreeEditorView, TextEditorView, ProblemsView, BreadcrumbView, FindReplaceView. Vocabulary-agnostic; vocabulary packages (e.g. Phoenixml.Platform.Editor.Xml) supply concrete ITreeNodeProvider implementations.
• Shell — MainWindow with custom chrome, composable StatusBar, SplitView for two-pane layouts.
• Theming — semantic color/spacing/typography tokens; Fluent Light/Dark + HighContrast.
• Hosting — PhoenixmlAppBuilder, settings persistence, single-instance coordination, command registry.
• Account (interfaces) — license, registration, update channel. Implementations consume the licensing API documented separately.
• Diagnostics — structured logging + crash capture + rotating log file.
• Localization — IStringLocalizer seam from day one; English-only ships in v1, expansion is demand-driven.

Why one package

We deliberately ship the foundation as a single rolled-up NuGet rather than 8+ thin packages. Reasoning lives in the design spec §2.5: every foundation namespace is a transitive dependency of every other anyway, and we already manage plenty of NuGet artifacts in the family. Internal modularity is preserved at the namespace level and enforced via architecture tests.

Quick start

Document model

using Phoenixml.Platform.Abstractions.Documents;
using Phoenixml.Platform.Documents;

// Define a concrete document by deriving from Document.
public sealed class MyDocument : Document
{
    public MyDocument(Uri source)
        : base(DocumentId.New(), source, displayName: "MyDoc", DocumentKind.Xml) { }

    public override ValueTask SaveAsync(CancellationToken ct)
    {
        // …persist…
        MarkClean();
        return default;
    }
}

// Edits happen via commands on the undo stack.
var doc = new MyDocument(new Uri("file:///tmp/foo.xml"));
doc.Undo.Execute(new MyEditCommand(...));
doc.Undo.Undo();

Tree + text dual-view layout (XmlNotepad's signature ergonomic)

using Avalonia.Layout;
using Phoenixml.Platform.Editing;
using Phoenixml.Platform.Shell;

// Build a side-by-side tree + text editor inside a SplitView.
var tree = new TreeEditorView();
tree.SetProvider(myTreeProvider);   // ITreeNodeProvider supplied by your vocabulary package

var text = new TextEditorView { Text = currentDocumentText };

var split = new SplitView
{
    Orientation = Orientation.Horizontal,
    Pane1Size = 320,
    Pane1Content = tree,
    Pane2Content = text,
};

mainWindow.SetContent(split);

Vocabulary bindings

The foundation is vocabulary-agnostic — the editor primitives take provider interfaces. Vocabulary-specific NuGet packages supply concrete providers:

• Phoenixml.Platform.Editor.Xml (0.1.0) — XML/XSD binding. XmlDocument backed by PhoenixmlDb.Core's XDM; XmlTreeNodeProvider adapts the XDM tree to ITreeNodeProvider; XmlSchemaValidator surfaces XSD validation errors as IDiagnostic for the Problems pane.
• (Future) Phoenixml.Platform.Editor.Xslt, Phoenixml.Platform.Editor.XQuery — Workbench's bindings. Live in the Workbench repo, consume Phoenixml.Platform from NuGet, prove the boundary works without colocation.

using Phoenixml.Platform.Editor.Xml;

var doc = await XmlDocument.LoadAsync("/tmp/orders.xml", ct);
documentService.Add(doc);

treeView.SetProvider(doc.TreeNodes);  // wire the tree view to the document

Used by

• Phoenixml.Editor (forthcoming) — XML/XSD authoring app.
• Phoenixml.Workbench (forthcoming) — XSLT/XQuery authoring app.

Contributing

Pull requests welcome. By submitting a contribution you agree it is licensed under Apache-2.0 and that you have the right to do so (DCO: include a Signed-off-by: line in commit messages, or use git commit --signoff).

License

Apache-2.0. See LICENSE and NOTICE.