Welcome to mirror list, hosted at ThFree Co, Russian Federation.

ProjectItem.cs « MonoDevelop.Projects « MonoDevelop.Core « core « src « main - github.com/mono/monodevelop.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 62fcb98017fd5023d40a25801b5e9b530db46e50 (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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
// 
// ProjectItem.cs
//  
// Author:
//       Lluis Sanchez Gual <lluis@novell.com>
// 
// Copyright (c) 2009 Novell, Inc (http://www.novell.com)
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

using System;
using System.Collections;
using System.Collections.Generic;
using MonoDevelop.Core.Serialization;
using MonoDevelop.Projects.MSBuild;
using System.Linq;

namespace MonoDevelop.Projects
{
	public class ProjectItem: IExtendedDataItem
	{
		Project project;
		Hashtable extendedProperties;
		ProjectItemMetadata metadata;
		static Dictionary<Type,HashSet<string>> knownMetadataCache = new Dictionary<Type, HashSet<string>> ();

		public ProjectItem ()
		{
			ItemName = MSBuildProjectService.GetNameForProjectItem (GetType());
		}

		public Project Project {
			get {
				return project;
			}
			// HACK: internal
			set {
				project = value;
				OnProjectSet ();
			}
		}

		public IDictionary ExtendedProperties {
			get {
				if (extendedProperties == null)
					extendedProperties = new Hashtable ();
				return extendedProperties;
			}
		}

		MSBuildItem backingItem;
		internal MSBuildItem BackingItem {
			get {
				return backingItem;
			}
			set {
				backingItem = value;
				UnevaluatedInclude = backingItem?.Include;
			}
		}

		IMSBuildItemEvaluated backingEvalItem;
		internal IMSBuildItemEvaluated BackingEvalItem {
			get { return backingEvalItem; }
			set {
				backingEvalItem = value;
				var source = backingEvalItem?.SourceItems.FirstOrDefault ();
				IsFromWildcardItem = source != null && source.IsWildcardItem;
			}
		}

		internal bool IsFromWildcardItem { get; private set; }

		internal MSBuildItem WildcardItem {
			get {
				return backingEvalItem?.SourceItems.FirstOrDefault ();
			}
		}

		internal string Condition { get; set; }

		public string ItemName { get; protected set; }

		public virtual string Include { get; protected set; }

		public string UnevaluatedInclude { get; protected set; }

		public ProjectItemFlags Flags { get; set; }

		public ProjectItemMetadata Metadata {
			get {
				if (metadata == null)
					metadata = new ProjectItemMetadata ();
				return metadata;
			}
		}

		public bool IsHidden {
			get { return (Flags & ProjectItemFlags.Hidden) == ProjectItemFlags.Hidden; }
		}

		public bool IsImported {
			get { return backingEvalItem?.IsImported == true; }
		}

		internal protected virtual void Read (Project project, IMSBuildItemEvaluated buildItem)
		{
			ItemName = buildItem.Name;
			Include = buildItem.Include;
			UnevaluatedInclude = buildItem.UnevaluatedInclude;
			Condition = buildItem.Condition;
			metadata = null;

			if (buildItem.SourceItem != null) {
				HashSet<string> knownProps = GetKnownMetadata ();
				foreach (var prop in buildItem.Metadata.GetProperties ()) {
					if (!knownProps.Contains (prop.Name)) {
						if (metadata == null)
							metadata = new ProjectItemMetadata (project.MSBuildProject);
						// Get the evaluated value for the original metadata property
						var p = new ItemMetadataProperty (prop.Name, buildItem.Metadata.GetValue (prop.Name), prop.UnevaluatedValue) { Condition = prop.Condition };
						p.ParentProject = project.MSBuildProject;
						metadata.AddProperty (p);
					}
				}
				if (metadata != null)
					metadata.OnLoaded ();
			}
			buildItem.Metadata.ReadObjectProperties (this, GetType (), true);
		}

		internal protected virtual void Write (Project project, MSBuildItem buildItem)
		{
			buildItem.Condition = Condition;
			buildItem.Metadata.WriteObjectProperties (this, GetType(), true);

			if (metadata != null) {
				metadata.SetProject (buildItem.ParentProject);
				foreach (MSBuildProperty prop in metadata.GetProperties ()) {
					// Use the UnevaluatedValue because if the property has changed, UnevaluatedValue will contain
					// the new value, and if not, it will contain the old unevaluated value
					buildItem.Metadata.SetValue (prop.Name, prop.UnevaluatedValue, condition:prop.Condition);
				}
			}
		}

		/// <summary>
		/// Gets a list of metadata properties which are read and written by this item, so they don't
		/// have to be stored in the generic Metadata dictionary
		/// </summary>
		/// <returns>The known metadata properties.</returns>
		protected virtual IEnumerable<string> GetKnownMetadataProperties ()
		{
			DataSerializer ser = new DataSerializer (Services.ProjectService.DataContext);
			var props = Services.ProjectService.DataContext.GetProperties (ser.SerializationContext, this);
			foreach (var prop in props)
				if (!prop.IsExternal)
					yield return prop.Name;
		}

		HashSet<string> GetKnownMetadata ()
		{
			HashSet<string> mset;
			lock (knownMetadataCache) {
				if (!knownMetadataCache.TryGetValue (GetType (), out mset))
					knownMetadataCache [GetType()] = mset = new HashSet<string> (GetKnownMetadataProperties ());
			}
			return mset;
		}

		/// <summary>
		/// Invoked when the project to which the item belongs changes.
		/// </summary>
		protected virtual void OnProjectSet ()
		{
		}
	}
	
	public class UnknownProjectItem: ProjectItem
	{
		public UnknownProjectItem (string name, string include)
		{
			this.ItemName = name;
			this.Include = include;
		}
	}

	[Flags]
	public enum ProjectItemFlags
	{
		None = 0,

		/// <summary>
		/// The item is for internal use and will not be shown to the user
		/// </summary>
		Hidden = 1,

		/// <summary>
		/// The item will not be saved to the project file
		/// </summary>
		DontPersist = 2
	}
}