aboutsummaryrefslogtreecommitdiff
path: root/src/WixToolset.Extensibility/BaseLayoutExtension.cs
blob: 21b932fffd5388d3e698b255a84ce824360f7a5a (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.Extensibility
{
    using WixToolset.Extensibility.Data;
    using WixToolset.Extensibility.Services;

    /// <summary>
    /// Base class for creating a resolver extension.
    /// </summary>
    public abstract class BaseLayoutExtension : ILayoutExtension
    {
        /// <summary>
        /// Context for use by the extension.
        /// </summary>
        protected ILayoutContext Context { get; private set; }

        /// <summary>
        /// Messaging for use by the extension.
        /// </summary>
        protected IMessaging Messaging { get; private set; }

        /// <summary>
        /// Called at the beginning of layout.
        /// </summary>
        public virtual void PreLayout(ILayoutContext context)
        {
            this.Context = context;

            this.Messaging = context.ServiceProvider.GetService<IMessaging>();
        }

        /// <summary>
        /// See <see cref="ILayoutExtension.CopyFile(string, string)"/>
        /// </summary>
        /// <param name="source"></param>
        /// <param name="destination"></param>
        /// <returns></returns>
        public virtual bool CopyFile(string source, string destination)
        {
            return false;
        }

        /// <summary>
        /// See <see cref="ILayoutExtension.MoveFile(string, string)"/>
        /// </summary>
        /// <param name="source"></param>
        /// <param name="destination"></param>
        /// <returns></returns>
        public virtual bool MoveFile(string source, string destination)
        {
            return false;
        }

        /// <summary>
        /// Called at the end of ayout.
        /// </summary>
        public virtual void PostLayout()
        {
        }
    }
}