From eff9d4204880535f821827e5aece5068402358f6 Mon Sep 17 00:00:00 2001 From: Rob Mensching Date: Wed, 6 Dec 2023 19:48:54 -0800 Subject: Introducing the WiX Standard Library Completes 7914 --- src/api/wix/WixToolset.Data/Intermediate.cs | 4 +- src/api/wix/WixToolset.Data/IntermediateSection.cs | 4 +- .../WindowsInstaller/WindowsInstallerStandard.cs | 115 +++++++++------- src/api/wix/WixToolset.Data/WixStandardLibrary.cs | 152 +++++++++++++++++++++ .../WixStandardLibraryIdentifiers.cs | 20 +++ .../WixToolset.Extensibility/Data/ILinkContext.cs | 10 ++ 6 files changed, 257 insertions(+), 48 deletions(-) create mode 100644 src/api/wix/WixToolset.Data/WixStandardLibrary.cs create mode 100644 src/api/wix/WixToolset.Data/WixStandardLibraryIdentifiers.cs (limited to 'src/api') diff --git a/src/api/wix/WixToolset.Data/Intermediate.cs b/src/api/wix/WixToolset.Data/Intermediate.cs index 64f9810d..977f894a 100644 --- a/src/api/wix/WixToolset.Data/Intermediate.cs +++ b/src/api/wix/WixToolset.Data/Intermediate.cs @@ -215,9 +215,11 @@ namespace WixToolset.Data /// Updates the intermediate level to the specified level. /// /// Intermediate level. - public void UpdateLevel(string level) + public Intermediate UpdateLevel(string level) { this.Level = String.IsNullOrEmpty(this.Level) ? level : String.Concat(this.Level, ";", level); + + return this; } /// diff --git a/src/api/wix/WixToolset.Data/IntermediateSection.cs b/src/api/wix/WixToolset.Data/IntermediateSection.cs index b9157875..16d63a4c 100644 --- a/src/api/wix/WixToolset.Data/IntermediateSection.cs +++ b/src/api/wix/WixToolset.Data/IntermediateSection.cs @@ -70,9 +70,11 @@ namespace WixToolset.Data /// Assigns the section to a library. /// /// Identifier of the library. - public void AssignToLibrary(string libraryId) + public IntermediateSection AssignToLibrary(string libraryId) { this.LibraryId = libraryId; + + return this; } /// diff --git a/src/api/wix/WixToolset.Data/WindowsInstaller/WindowsInstallerStandard.cs b/src/api/wix/WixToolset.Data/WindowsInstaller/WindowsInstallerStandard.cs index 17267cf7..971a0416 100644 --- a/src/api/wix/WixToolset.Data/WindowsInstaller/WindowsInstallerStandard.cs +++ b/src/api/wix/WixToolset.Data/WindowsInstaller/WindowsInstallerStandard.cs @@ -11,7 +11,6 @@ namespace WixToolset.Data.WindowsInstaller { private static readonly Dictionary standardActionsById; private static readonly HashSet standardActionNames; - private static readonly Dictionary standardDirectoriesById; /// /// References: @@ -208,6 +207,41 @@ namespace WixToolset.Data.WindowsInstaller "WindowsVolume", }; + private static readonly Dictionary standardDirectoryNamesById = new Dictionary + { + ["TARGETDIR"] = "SourceDir", + ["AdminToolsFolder"] = "Admin", + ["AppDataFolder"] = "AppData", + ["CommonAppDataFolder"] = "CommApp", + ["CommonFilesFolder"] = "CFiles", + ["CommonFiles64Folder"] = "CFiles64", + ["CommonFiles6432Folder"] = ".", + ["DesktopFolder"] = "Desktop", + ["FavoritesFolder"] = "Favs", + ["FontsFolder"] = "Fonts", + ["LocalAppDataFolder"] = "LocalApp", + ["MyPicturesFolder"] = "Pictures", + ["NetHoodFolder"] = "NetHood", + ["PersonalFolder"] = "Personal", + ["PrintHoodFolder"] = "Printers", + ["ProgramFilesFolder"] = "PFiles", + ["ProgramFiles64Folder"] = "PFiles64", + ["ProgramFiles6432Folder"] = ".", + ["ProgramMenuFolder"] = "PMenu", + ["RecentFolder"] = "Recent", + ["SendToFolder"] = "SendTo", + ["StartMenuFolder"] = "StrtMenu", + ["StartupFolder"] = "StartUp", + ["SystemFolder"] = "System", + ["System16Folder"] = "System16", + ["System64Folder"] = "System64", + ["System6432Folder"] = ".", + ["TempFolder"] = "Temp", + ["TemplateFolder"] = "Template", + ["WindowsFolder"] = "Windows", + }; + + static WindowsInstallerStandard() { var standardActions = new[] @@ -332,43 +366,8 @@ namespace WixToolset.Data.WindowsInstaller new WixActionSymbol(null, new Identifier(AccessModifier.Virtual, "InstallExecuteSequence/InstallFinalize")) { Action="InstallFinalize", Sequence=6600, SequenceTable=SequenceTable.InstallExecuteSequence }, }; - var standardDirectories = new[] - { - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "TARGETDIR")) { Name = "SourceDir" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "AdminToolsFolder")) { Name = "Admin" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "AppDataFolder")) { Name = "AppData" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "CommonAppDataFolder")) { Name = "CommApp" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "CommonFilesFolder")) { Name = "CFiles" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "CommonFiles64Folder")) { Name = "CFiles64" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "CommonFiles6432Folder")) { Name = "." }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "DesktopFolder")) { Name = "Desktop" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "FavoritesFolder")) { Name = "Favs" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "FontsFolder")) { Name = "Fonts" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "LocalAppDataFolder")) { Name = "LocalApp" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "MyPicturesFolder")) { Name = "Pictures" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "NetHoodFolder")) { Name = "NetHood" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "PersonalFolder")) { Name = "Personal" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "PrintHoodFolder")) { Name = "Printers" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "ProgramFilesFolder")) { Name = "PFiles" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "ProgramFiles64Folder")) { Name = "PFiles64" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "ProgramFiles6432Folder")) { Name = "." }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "ProgramMenuFolder")) { Name = "PMenu" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "RecentFolder")) { Name = "Recent" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "SendToFolder")) { Name = "SendTo" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "StartMenuFolder")) { Name = "StrtMenu" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "StartupFolder")) { Name = "StartUp" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "SystemFolder")) { Name = "System" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "System16Folder")) { Name = "System16" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "System64Folder")) { Name = "System64" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "System6432Folder")) { Name = "." }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "TempFolder")) { Name = "Temp" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "TemplateFolder")) { Name = "Template" }, - new DirectorySymbol(null, new Identifier(AccessModifier.Virtual, "WindowsFolder")) { Name = "Windows" }, - }; - standardActionNames = new HashSet(standardActions.Select(a => a.Action)); standardActionsById = standardActions.ToDictionary(a => a.Id.Id); - standardDirectoriesById = standardDirectories.ToDictionary(d => d.Id.Id); } /// @@ -376,17 +375,26 @@ namespace WixToolset.Data.WindowsInstaller /// /// Name of the action. /// true if the action is standard, false otherwise. - public static bool IsStandardAction(string actionName) => standardActionNames.Contains(actionName); + public static bool IsStandardAction(string actionName) + { + return standardActionNames.Contains(actionName); + } /// /// Standard actions. /// - public static IReadOnlyCollection StandardActions() => standardActionsById.Values; + public static IReadOnlyCollection StandardActions() + { + return standardActionsById.Values; + } /// - /// Standard directories. + /// Standard directory identifiers. /// - public static IReadOnlyCollection StandardDirectories() => standardDirectoriesById.Values; + public static IReadOnlyCollection StandardDirectoryIds() + { + return standardDirectoryNamesById.Keys; + } /// /// Gets the platform specific directory id for a directory. Most directories are not platform @@ -418,28 +426,43 @@ namespace WixToolset.Data.WindowsInstaller /// /// Name of the directory. /// true if the directory is standard, false otherwise. - public static bool IsStandardDirectory(string directoryId) => standardDirectoriesById.ContainsKey(directoryId); + public static bool IsStandardDirectory(string directoryId) + { + return standardDirectoryNamesById.ContainsKey(directoryId); + } /// /// Find out if a property is a standard property. /// /// Name of the property. /// true if a property is standard, false otherwise. - public static bool IsStandardProperty(string propertyName) => standardProperties.Contains(propertyName); + public static bool IsStandardProperty(string propertyName) + { + return standardProperties.Contains(propertyName); + } /// /// Try to get standard action by id. /// - public static bool TryGetStandardAction(string id, out WixActionSymbol standardAction) => standardActionsById.TryGetValue(id, out standardAction); + public static bool TryGetStandardAction(string id, out WixActionSymbol standardAction) + { + return standardActionsById.TryGetValue(id, out standardAction); + } /// /// Try to get standard action by sequence and action name. /// - public static bool TryGetStandardAction(string sequenceName, string actioname, out WixActionSymbol standardAction) => standardActionsById.TryGetValue(String.Concat(sequenceName, "/", actioname), out standardAction); + public static bool TryGetStandardAction(string sequenceName, string actioname, out WixActionSymbol standardAction) + { + return standardActionsById.TryGetValue(String.Concat(sequenceName, "/", actioname), out standardAction); + } /// - /// Try to get standard directory symbol by id. + /// Try to get standard directory name by id. /// - public static bool TryGetStandardDirectory(string directoryId, out DirectorySymbol symbol) => standardDirectoriesById.TryGetValue(directoryId, out symbol); + public static bool TryGetStandardDirectoryName(string directoryId, out string name) + { + return standardDirectoryNamesById.TryGetValue(directoryId, out name); + } } } diff --git a/src/api/wix/WixToolset.Data/WixStandardLibrary.cs b/src/api/wix/WixToolset.Data/WixStandardLibrary.cs new file mode 100644 index 00000000..c5c9d8d4 --- /dev/null +++ b/src/api/wix/WixToolset.Data/WixStandardLibrary.cs @@ -0,0 +1,152 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.Data +{ + using System; + using System.Collections.Generic; + using System.Linq; + using WixToolset.Data.Bind; + using WixToolset.Data.Symbols; + using WixToolset.Data.WindowsInstaller; + + /// + /// WiX Standard Library implementation. + /// + public static class WixStandardLibrary + { + private const string WixStandardLibraryId = "wixstd"; + + /// + /// Build the wixstd.wixlib Intermediate. + /// + /// Target platform for the wixstd.wixlib + /// Intermediate containing the wixstd.wixlib. + public static Intermediate Build(Platform platform) + { + var localizations = YieldLocalizations(); + + var sections = YieldSections(platform); + + return new Intermediate(WixStandardLibraryId, IntermediateLevels.Combined, sections, localizations.ToDictionary(l => l.Culture, StringComparer.OrdinalIgnoreCase)); + } + + private static IEnumerable YieldLocalizations() + { + var strings = new BindVariable[0]; + + var localizedControls = new LocalizedControl[0]; + + yield return new Localization(LocalizationLocation.Library, null, null, String.Empty, strings.ToDictionary(s => s.Id), localizedControls.ToDictionary(l => l.GetKey())); + } + + private static IEnumerable YieldSections(Platform platform) + { + var sourceLineNumber = new SourceLineNumber("wixstd.wixlib"); + + // Actions. + foreach (var actionSymbol in WindowsInstallerStandard.StandardActions()) + { + var symbol = new WixActionSymbol(sourceLineNumber, new Identifier(actionSymbol.Id.Access, actionSymbol.Id.Id)) + { + Action = actionSymbol.Action, + SequenceTable = actionSymbol.SequenceTable, + Sequence = actionSymbol.Sequence, + Condition = actionSymbol.Condition, + }; + + var section = CreateSectionAroundSymbol(symbol); + + yield return section; + } + + // Directories. + foreach (var id in WindowsInstallerStandard.StandardDirectoryIds()) + { + var symbol = new DirectorySymbol(sourceLineNumber, new Identifier(AccessModifier.Virtual, id)) + { + ParentDirectoryRef = GetStandardDirectoryParent(id, platform), + Name = WindowsInstallerStandard.TryGetStandardDirectoryName(id, out var name) ? name : throw new InvalidOperationException("Standard directories must have a default name") + }; + + var section = CreateSectionAroundSymbol(symbol); + + // Add a reference for the more complicated parent directory references. + if (symbol.ParentDirectoryRef != null && symbol.ParentDirectoryRef != "TARGEDIR") + { + section.AddSymbol(new WixSimpleReferenceSymbol(sourceLineNumber) + { + Table = "Directory", + PrimaryKeys = symbol.ParentDirectoryRef + }); + } + + yield return section; + } + + // Package References. + { + var section = CreateSection(WixStandardLibraryIdentifiers.WixStandardPackageReferences); + + section.AddSymbol(new WixFragmentSymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardLibraryIdentifiers.WixStandardPackageReferences))); + + section.AddSymbol(new WixSimpleReferenceSymbol(sourceLineNumber) + { + Table = SymbolDefinitions.Directory.Name, + PrimaryKeys = "TARGETDIR" + }); + + yield return section; + } + + // Module References. + { + var section = CreateSection(WixStandardLibraryIdentifiers.WixStandardModuleReferences); + + section.AddSymbol(new WixFragmentSymbol(sourceLineNumber, new Identifier(AccessModifier.Global, WixStandardLibraryIdentifiers.WixStandardModuleReferences))); + + section.AddSymbol(new WixSimpleReferenceSymbol(sourceLineNumber) + { + Table = SymbolDefinitions.Directory.Name, + PrimaryKeys = "TARGETDIR" + }); + + yield return section; + } + } + + private static IntermediateSection CreateSection(string sectionId) + { + return new IntermediateSection(sectionId, SectionType.Fragment, WixStandardLibraryId).AssignToLibrary(WixStandardLibraryId); + } + + private static IntermediateSection CreateSectionAroundSymbol(IntermediateSymbol symbol) + { + var section = CreateSection(symbol.Id.Id); + + section.AddSymbol(symbol); + + return section; + } + + private static string GetStandardDirectoryParent(string directoryId, Platform platform) + { + switch (directoryId) + { + case "TARGETDIR": + return null; + + case "CommonFiles6432Folder": + return platform == Platform.X86 ? "CommonFilesFolder" : "CommonFiles64Folder"; + + case "ProgramFiles6432Folder": + return platform == Platform.X86 ? "ProgramFilesFolder" : "ProgramFiles64Folder"; + + case "System6432Folder": + return platform == Platform.X86 ? "SystemFolder" : "System64Folder"; + + default: + return "TARGETDIR"; + } + } + } +} diff --git a/src/api/wix/WixToolset.Data/WixStandardLibraryIdentifiers.cs b/src/api/wix/WixToolset.Data/WixStandardLibraryIdentifiers.cs new file mode 100644 index 00000000..8c4ac08e --- /dev/null +++ b/src/api/wix/WixToolset.Data/WixStandardLibraryIdentifiers.cs @@ -0,0 +1,20 @@ +// Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. + +namespace WixToolset.Data +{ + /// + /// Well-known identifier names from the wixstd.wixlib. + /// + public static class WixStandardLibraryIdentifiers + { + /// + /// WiX Standard references for packages. + /// + public static readonly string WixStandardPackageReferences = "WixStandardPackageReferences"; + + /// + /// WiX Standard references for modules. + /// + public static readonly string WixStandardModuleReferences = "WixStandardModuleReferences"; + } +} diff --git a/src/api/wix/WixToolset.Extensibility/Data/ILinkContext.cs b/src/api/wix/WixToolset.Extensibility/Data/ILinkContext.cs index 8556d9eb..402d78fe 100644 --- a/src/api/wix/WixToolset.Extensibility/Data/ILinkContext.cs +++ b/src/api/wix/WixToolset.Extensibility/Data/ILinkContext.cs @@ -47,6 +47,16 @@ namespace WixToolset.Extensibility.Data /// string OutputPath { get; set; } + /// + /// Gets or sets the platform for the output. + /// + Platform Platform { get; set; } + + /// + /// Gets or sets whether to skip the standard wixlib. + /// + bool SkipStdWixlib { get; set; } + /// /// Symbol definition creator used to load extension data. /// -- cgit v1.2.3-55-g6feb