summaryrefslogtreecommitdiffstats
path: root/tools/Sandcastle/Source/BuildAssembler/BuildAssemblerLibrary/BuildComponent.cs
blob: bb211b9c303525fbf506ce2a43969e628a80bf3a (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
63
64
65
66
67
68
69
70
71
72
73
74
75
// Copyright (c) Microsoft Corporation.  All rights reserved.
//
using System;
using System.Collections.Generic;
using System.Configuration;
using System.IO;
using System.Reflection;
using System.Xml;
using System.Xml.XPath;

namespace Microsoft.Ddue.Tools {

	public abstract class BuildComponent : IDisposable {

		protected BuildComponent (BuildAssembler assembler, XPathNavigator configuration) {
            this.assembler = assembler;
			WriteMessage(MessageLevel.Info, "Instantiating component.");
		}

		public abstract void Apply (XmlDocument document, string key);

		public virtual void Apply (XmlDocument document) {
			Apply(document, null);
		}

        public virtual void Dispose () {
            // override to do something
        }

		// shared data

        private BuildAssembler assembler;

        public BuildAssembler BuildAssembler {
            get {
                return(assembler);
            }
        }

        //private MessageHandler handler;

		private static Dictionary<string,object> data = new Dictionary<string,object>();

		protected static Dictionary<string,object> Data {
			get {
				return(data);
			}
		}

        // component messaging facility

        protected void OnComponentEvent (EventArgs e) {
            assembler.OnComponentEvent(this.GetType(), e);
        }

		protected void WriteMessage (MessageLevel level, string message) {
            if (level == MessageLevel.Ignore) return;
            MessageHandler handler = assembler.MessageHandler;
			if (handler != null) handler(this.GetType(), level, message);			
		}

	}

	public enum MessageLevel {
        Ignore,     // don't show at all
		Info,		// informational message
		Warn,		// a minor problem occured
		Error		// a major problem occured
	}


	public delegate void MessageHandler (Type component, MessageLevel level, string message);


}