blob: 9a6fd10c81673326d07be0e08691c80ac075d168 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
// 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
{
using System;
using System.Diagnostics.CodeAnalysis;
using System.IO;
using WixToolset.Data;
using Wix = WixToolset.Data.Serialize;
/// <summary>
/// The WiX Toolset harvester core.
/// </summary>
public interface IHarvesterCore
{
/// <summary>
/// Gets whether the harvester core encountered an error while processing.
/// </summary>
/// <value>Flag if core encountered an error during processing.</value>
bool EncounteredError { get; }
/// <summary>
/// Gets or sets the value of the extension argument passed to heat.
/// </summary>
/// <value>The extension argument.</value>
string ExtensionArgument { get; set; }
/// <summary>
/// Gets or sets the value of the root directory that is being harvested.
/// </summary>
/// <value>The root directory being harvested.</value>
string RootDirectory { get; set; }
/// <summary>
/// Create an identifier based on passed file name
/// </summary>
/// <param name="name">File name to generate identifer from</param>
/// <returns></returns>
string CreateIdentifierFromFilename(string filename);
/// <summary>
/// Generate an identifier by hashing data from the row.
/// </summary>
/// <param name="prefix">Three letter or less prefix for generated row identifier.</param>
/// <param name="args">Information to hash.</param>
/// <returns>The generated identifier.</returns>
string GenerateIdentifier(string prefix, params string[] args);
/// <summary>
/// Sends a message to the message delegate if there is one.
/// </summary>
/// <param name="mea">Message event arguments.</param>
void OnMessage(MessageEventArgs mea);
/// <summary>
/// Resolves a file's path if the Wix.File.Source value starts with "SourceDir\".
/// </summary>
/// <param name="fileSource">The Wix.File.Source value with "SourceDir\".</param>
/// <returns>The full path of the file.</returns>
string ResolveFilePath(string fileSource);
}
}
|
