diff options
author | Rob Mensching <rob@firegiant.com> | 2021-02-13 07:20:13 -0800 |
---|---|---|
committer | Rob Mensching <rob@firegiant.com> | 2021-02-27 07:41:18 -0800 |
commit | 36011e4e6c37139684dcfe982e7d4390c0a1d1d2 (patch) | |
tree | 74a898a7425c9b5cc9fe5a0c547bfdc30bc6111b /src | |
parent | 09007408ffb6c3af9fbb556d0fb34e80aede52ee (diff) | |
download | wix-36011e4e6c37139684dcfe982e7d4390c0a1d1d2.tar.gz wix-36011e4e6c37139684dcfe982e7d4390c0a1d1d2.tar.bz2 wix-36011e4e6c37139684dcfe982e7d4390c0a1d1d2.zip |
Add IWindowsInstallerBackendBinder.FullyResolved plus documentation
Diffstat (limited to 'src')
-rw-r--r-- | src/WixToolset.Extensibility/BaseWindowsInstallerBackendBinderExtension.cs | 7 | ||||
-rw-r--r-- | src/WixToolset.Extensibility/IWindowsInstallerBackendBinderExtension.cs | 37 |
2 files changed, 39 insertions, 5 deletions
diff --git a/src/WixToolset.Extensibility/BaseWindowsInstallerBackendBinderExtension.cs b/src/WixToolset.Extensibility/BaseWindowsInstallerBackendBinderExtension.cs index e2be63bf..c0086aed 100644 --- a/src/WixToolset.Extensibility/BaseWindowsInstallerBackendBinderExtension.cs +++ b/src/WixToolset.Extensibility/BaseWindowsInstallerBackendBinderExtension.cs | |||
@@ -53,6 +53,13 @@ namespace WixToolset.Extensibility | |||
53 | } | 53 | } |
54 | 54 | ||
55 | /// <summary> | 55 | /// <summary> |
56 | /// See <see cref="IWindowsInstallerBackendBinderExtension.FullyResolved(IntermediateSection)"/> | ||
57 | /// </summary> | ||
58 | public virtual void FullyResolved(IntermediateSection section) | ||
59 | { | ||
60 | } | ||
61 | |||
62 | /// <summary> | ||
56 | /// See <see cref="IWindowsInstallerBackendBinderExtension.PreBackendBind(IBindContext)"/> | 63 | /// See <see cref="IWindowsInstallerBackendBinderExtension.PreBackendBind(IBindContext)"/> |
57 | /// </summary> | 64 | /// </summary> |
58 | public virtual IResolvedCabinet ResolveCabinet(string cabinetPath, IEnumerable<IBindFileWithPath> files) => null; | 65 | public virtual IResolvedCabinet ResolveCabinet(string cabinetPath, IEnumerable<IBindFileWithPath> files) => null; |
diff --git a/src/WixToolset.Extensibility/IWindowsInstallerBackendBinderExtension.cs b/src/WixToolset.Extensibility/IWindowsInstallerBackendBinderExtension.cs index f257f1ec..b913dadc 100644 --- a/src/WixToolset.Extensibility/IWindowsInstallerBackendBinderExtension.cs +++ b/src/WixToolset.Extensibility/IWindowsInstallerBackendBinderExtension.cs | |||
@@ -13,26 +13,53 @@ namespace WixToolset.Extensibility | |||
13 | /// </summary> | 13 | /// </summary> |
14 | public interface IWindowsInstallerBackendBinderExtension | 14 | public interface IWindowsInstallerBackendBinderExtension |
15 | { | 15 | { |
16 | #pragma warning disable 1591 // TODO: add documentation | 16 | /// <summary> |
17 | /// Table definitions provided by the extension. | ||
18 | /// </summary> | ||
17 | IEnumerable<TableDefinition> TableDefinitions { get; } | 19 | IEnumerable<TableDefinition> TableDefinitions { get; } |
18 | #pragma warning restore 1591 | ||
19 | 20 | ||
20 | /// <summary> | 21 | /// <summary> |
21 | /// Called before binding occurs. | 22 | /// Called before binding occurs. |
22 | /// </summary> | 23 | /// </summary> |
23 | void PreBackendBind(IBindContext context); | 24 | void PreBackendBind(IBindContext context); |
24 | 25 | ||
25 | #pragma warning disable 1591 // TODO: add documentation | 26 | /// <summary> |
27 | /// | ||
28 | /// </summary> | ||
29 | /// <param name="section">The resolved intermedate section.</param> | ||
30 | void FullyResolved(IntermediateSection section); | ||
31 | |||
32 | /// <summary> | ||
33 | /// Finds an existing cabinet that contains the provided files. | ||
34 | /// </summary> | ||
35 | /// <param name="cabinetPath">Path to the cabinet.</param> | ||
36 | /// <param name="files">Files contained in the cabinet.</param> | ||
37 | /// <returns>Resolved cabinet options or null if the cabinet could not be found.</returns> | ||
26 | IResolvedCabinet ResolveCabinet(string cabinetPath, IEnumerable<IBindFileWithPath> files); | 38 | IResolvedCabinet ResolveCabinet(string cabinetPath, IEnumerable<IBindFileWithPath> files); |
27 | 39 | ||
28 | string ResolveMedia(MediaSymbol mediaRow, string mediaLayoutDirectory, string layoutDirectory); | 40 | /// <summary> |
41 | /// Override layout location for a media. | ||
42 | /// </summary> | ||
43 | /// <param name="mediaSymbol">Media symbol.</param> | ||
44 | /// <param name="mediaLayoutDirectory">Default media layout directory.</param> | ||
45 | /// <param name="layoutDirectory">Default layout directory.</param> | ||
46 | /// <returns>Layout location or null to use the default processing.</returns> | ||
47 | string ResolveMedia(MediaSymbol mediaSymbol, string mediaLayoutDirectory, string layoutDirectory); | ||
29 | 48 | ||
49 | /// <summary> | ||
50 | /// | ||
51 | /// </summary> | ||
52 | /// <param name="section"></param> | ||
53 | /// <param name="symbol"></param> | ||
54 | /// <param name="output">Windows Installer data </param> | ||
55 | /// <param name="tableDefinitions">Collection of table definitions available for the output.</param> | ||
56 | /// <returns>True if the symbol was added to the output, or false if not.</returns> | ||
30 | bool TryAddSymbolToOutput(IntermediateSection section, IntermediateSymbol symbol, WindowsInstallerData output, TableDefinitionCollection tableDefinitions); | 57 | bool TryAddSymbolToOutput(IntermediateSection section, IntermediateSymbol symbol, WindowsInstallerData output, TableDefinitionCollection tableDefinitions); |
31 | #pragma warning restore 1591 | ||
32 | 58 | ||
33 | /// <summary> | 59 | /// <summary> |
34 | /// Called after all output changes occur and right before the output is bound into its final format. | 60 | /// Called after all output changes occur and right before the output is bound into its final format. |
35 | /// </summary> | 61 | /// </summary> |
62 | /// <param name="result">Bind result to process.</param> | ||
36 | void PostBackendBind(IBindResult result); | 63 | void PostBackendBind(IBindResult result); |
37 | } | 64 | } |
38 | } | 65 | } |