aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Extensibility/IBurnBackendExtension.cs
diff options
context:
space:
mode:
Diffstat (limited to 'src/WixToolset.Extensibility/IBurnBackendExtension.cs')
-rw-r--r--src/WixToolset.Extensibility/IBurnBackendExtension.cs45
1 files changed, 23 insertions, 22 deletions
diff --git a/src/WixToolset.Extensibility/IBurnBackendExtension.cs b/src/WixToolset.Extensibility/IBurnBackendExtension.cs
index 769c2457..07f5cd1b 100644
--- a/src/WixToolset.Extensibility/IBurnBackendExtension.cs
+++ b/src/WixToolset.Extensibility/IBurnBackendExtension.cs
@@ -16,30 +16,36 @@ namespace WixToolset.Extensibility
16 void PreBackendBind(IBindContext context); 16 void PreBackendBind(IBindContext context);
17 17
18 /// <summary> 18 /// <summary>
19 /// 19 /// Called to find a file related to another source in the authoring. For example, most often used
20 /// to find cabinets and uncompressed files for an MSI package.
20 /// </summary> 21 /// </summary>
21 /// <param name="source"></param> 22 /// <param name="source">Path to the source package.</param>
22 /// <param name="relatedSource"></param> 23 /// <param name="relatedSource">Expected path to the related file.</param>
23 /// <param name="type"></param> 24 /// <param name="type">Type of related file, such as "File" or "Cabinet"</param>
24 /// <param name="sourceLineNumbers"></param> 25 /// <param name="sourceLineNumbers">Source line number of source package.</param>
25 /// <param name="bindStage"></param> 26 /// <returns><c>IResolveFileResult</c> if the related file was found, or null for default handling.</returns>
26 /// <returns></returns> 27 IResolveFileResult ResolveRelatedFile(string source, string relatedSource, string type, SourceLineNumber sourceLineNumbers);
27 IResolveFileResult ResolveRelatedFile(string source, string relatedSource, string type, SourceLineNumber sourceLineNumbers, BindStage bindStage);
28 28
29 /// <summary> 29 /// <summary>
30 /// 30 /// Called right before the output is bound into its final format.
31 /// </summary> 31 /// </summary>
32 /// <param name="url"></param> 32 /// <param name="section">The finalized intermediate section.</param>
33 /// <param name="fallbackUrl"></param> 33 void SymbolsFinalized(IntermediateSection section);
34 /// <param name="packageId"></param> 34
35 /// <param name="payloadId"></param> 35 /// <summary>
36 /// <param name="fileName"></param> 36 /// Called to customize the DownloadUrl provided in source cde.
37 /// <returns></returns> 37 /// </summary>
38 /// <param name="url">The value from the source code. May not actually be a URL.</param>
39 /// <param name="fallbackUrl">The default URL if the extension does not return a value.</param>
40 /// <param name="packageId">Identifier of the package.</param>
41 /// <param name="payloadId">Identifier of the payload.</param>
42 /// <param name="fileName">Filename of the payload.</param>
43 /// <returns>Url to override, or null to use default value.</returns>
38 string ResolveUrl(string url, string fallbackUrl, string packageId, string payloadId, string fileName); 44 string ResolveUrl(string url, string fallbackUrl, string packageId, string payloadId, string fileName);
39 45
40 /// <summary> 46 /// <summary>
41 /// Called for each extension symbol that hasn't been handled yet. 47 /// Called for each extension symbol that hasn't been handled yet.
42 /// Use IBurnBackendHelper to add data to the appropriate data manifest. 48 /// Use IBurnBackendHelper to add data.
43 /// </summary> 49 /// </summary>
44 /// <param name="section">The linked section.</param> 50 /// <param name="section">The linked section.</param>
45 /// <param name="symbol">The current symbol.</param> 51 /// <param name="symbol">The current symbol.</param>
@@ -47,12 +53,7 @@ namespace WixToolset.Extensibility
47 /// True if the extension handled the symbol, false otherwise. 53 /// True if the extension handled the symbol, false otherwise.
48 /// The Burn backend will warn on all unhandled symbols. 54 /// The Burn backend will warn on all unhandled symbols.
49 /// </returns> 55 /// </returns>
50 bool TryAddSymbolToDataManifest(IntermediateSection section, IntermediateSymbol symbol); 56 bool TryProcessSymbol(IntermediateSection section, IntermediateSymbol symbol);
51
52 /// <summary>
53 /// Called after all output changes occur and right before the output is bound into its final format.
54 /// </summary>
55 void BundleFinalize();
56 57
57 /// <summary> 58 /// <summary>
58 /// Called after output is bound into its final format. 59 /// Called after output is bound into its final format.