File: ConfigBase.cs

package info (click to toggle)
nini 1.1.0%2Bdfsg.3-2
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 880 kB
  • sloc: cs: 7,649; xml: 2,945; makefile: 28; ansic: 7
file content (422 lines) | stat: -rw-r--r-- 11,157 bytes parent folder | download | duplicates (7)
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
#region Copyright
//
// Nini Configuration Project.
// Copyright (C) 2006 Brent R. Matzelle.  All rights reserved.
//
// This software is published under the terms of the MIT X11 license, a copy of 
// which has been included with this distribution in the LICENSE.txt file.
// 
#endregion

using System;
using System.Collections;
using System.Globalization;
using Nini.Util;

namespace Nini.Config
{
	#region ConfigKeyEventArgs class
	/// <include file='ConfigKeyEventArgs.xml' path='//Delegate[@name="ConfigKeyEventHandler"]/docs/*' />
	public delegate void ConfigKeyEventHandler (object sender, ConfigKeyEventArgs e);

	/// <include file='ConfigEventArgs.xml' path='//Class[@name="ConfigEventArgs"]/docs/*' />
	public class ConfigKeyEventArgs : EventArgs
	{
		string keyName = null;
		string keyValue = null;

		/// <include file='ConfigEventArgs.xml' path='//Constructor[@name="Constructor"]/docs/*' />
		public ConfigKeyEventArgs (string keyName, string keyValue)
		{
			this.keyName = keyName;
			this.keyValue = keyValue;
		}

		/// <include file='ConfigEventArgs.xml' path='//Property[@name="KeyName"]/docs/*' />
		public string KeyName
		{
			get { return keyName; }
		}

		/// <include file='ConfigEventArgs.xml' path='//Property[@name="KeyValue"]/docs/*' />
		public string KeyValue
		{
			get { return keyValue; }
		}
	}
	#endregion

	/// <include file='IConfig.xml' path='//Interface[@name="IConfig"]/docs/*' />
	public class ConfigBase : IConfig
	{
		#region Private variables
		string configName = null;
		IConfigSource configSource = null;
		AliasText aliasText = null;
		IFormatProvider format = NumberFormatInfo.CurrentInfo;
		#endregion

		#region Protected variables
		protected OrderedList keys = new OrderedList ();
		#endregion
		
		#region Constructors
		/// <include file='ConfigBase.xml' path='//Constructor[@name="ConfigBase"]/docs/*' />
		public ConfigBase (string name, IConfigSource source)
		{
			configName = name;
			configSource = source;
			aliasText = new AliasText ();
		}
		#endregion

		#region Public properties
		/// <include file='IConfig.xml' path='//Property[@name="Name"]/docs/*' />
		public string Name
		{
			get { return configName; }
			set {
				if (configName != value) {
					Rename (value);
				}
			}
		}
		
		/// <include file='IConfig.xml' path='//Property[@name="ConfigSource"]/docs/*' />
		public IConfigSource ConfigSource
		{
			get { return configSource; }
		}
		
		/// <include file='IConfig.xml' path='//Property[@name="Alias"]/docs/*' />
		public AliasText Alias
		{
			get { return aliasText; }
		}
		#endregion

		#region Public methods
		/// <include file='IConfig.xml' path='//Method[@name="Contains"]/docs/*' />
		public bool Contains (string key)
		{
			return (Get (key) != null);
		}

		/// <include file='IConfig.xml' path='//Method[@name="Get"]/docs/*' />
		public virtual string Get (string key)
		{
			string result = null;
			
			if (keys.Contains (key)) {
				result = keys[key].ToString ();
			}

			return result;
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetDefault"]/docs/*' />
		public string Get (string key, string defaultValue)
		{
			string result = Get (key);
			
			return (result == null) ? defaultValue : result;
		}

		/// <include file='IConfig.xml' path='//Method[@name="GetExpanded"]/docs/*' />
		public string GetExpanded (string key)
		{
			return this.ConfigSource.GetExpanded(this, key);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="Get"]/docs/*' />
		public string GetString (string key)
		{
			return Get (key);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetDefault"]/docs/*' />
		public string GetString (string key, string defaultValue)
		{
			return Get (key, defaultValue);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetInt"]/docs/*' />
		public int GetInt (string key)
		{
			string text = Get (key);
			
			if (text == null) {
				throw new ArgumentException ("Value not found: " + key);
			}

			return Convert.ToInt32 (text, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetIntAlias"]/docs/*' />
		public int GetInt (string key, bool fromAlias)
		{
			if (!fromAlias) {
				return GetInt (key);
			}

			string result = Get (key);
			
			if (result == null) {
				throw new ArgumentException ("Value not found: " + key);
			}

			return GetIntAlias (key, result);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetIntDefault"]/docs/*' />
		public int GetInt (string key, int defaultValue)
		{
			string result = Get (key);
			
			return (result == null)
					? defaultValue
					: Convert.ToInt32 (result, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetIntDefaultAlias"]/docs/*' />
		public int GetInt (string key, int defaultValue, bool fromAlias)
		{
			if (!fromAlias) {
				return GetInt (key, defaultValue);
			}

			string result = Get (key);
			
			return (result == null) ? defaultValue : GetIntAlias (key, result);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetLong"]/docs/*' />
		public long GetLong (string key)
		{
			string text = Get (key);
			
			if (text == null) {
				throw new ArgumentException ("Value not found: " + key);
			}
			
			return Convert.ToInt64 (text, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetLongDefault"]/docs/*' />
		public long GetLong (string key, long defaultValue)
		{
			string result = Get (key);
			
			return (result == null)
					? defaultValue
					: Convert.ToInt64 (result, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetBoolean"]/docs/*' />
		public bool GetBoolean (string key)
		{
			string text = Get (key);
			
			if (text == null) {
				throw new ArgumentException ("Value not found: " + key);
			}
			
			return GetBooleanAlias (text);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetBooleanDefault"]/docs/*' />
		public bool GetBoolean (string key, bool defaultValue)
		{
			string text = Get (key);
			
			return (text == null) ? defaultValue : GetBooleanAlias (text);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetFloat"]/docs/*' />
		public float GetFloat (string key)
		{
			string text = Get (key);
			
			if (text == null) {
				throw new ArgumentException ("Value not found: " + key);
			}
			
			return Convert.ToSingle (text, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetFloatDefault"]/docs/*' />
		public float GetFloat (string key, float defaultValue)
		{
			string result = Get (key);
			
			return (result == null)
					? defaultValue
					: Convert.ToSingle (result, format);
		}

		/// <include file='IConfig.xml' path='//Method[@name="GetDouble"]/docs/*' />
		public double GetDouble (string key)
		{
			string text = Get (key);
			
			if (text == null) {
				throw new ArgumentException ("Value not found: " + key);
			}
			
			return Convert.ToDouble (text, format);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="GetDoubleDefault"]/docs/*' />
		public double GetDouble (string key, double defaultValue)
		{
			string result = Get (key);
			
			return (result == null)
					? defaultValue
					: Convert.ToDouble (result, format);
		}

		/// <include file='IConfig.xml' path='//Method[@name="GetKeys"]/docs/*' />
		public string[] GetKeys ()
		{
			string[] result = new string[keys.Keys.Count];
			
			keys.Keys.CopyTo (result, 0);
			
			return result;
		}

		/// <include file='IConfig.xml' path='//Method[@name="GetValues"]/docs/*' />
		public string[] GetValues ()
		{
			string[] result = new string[keys.Values.Count];
			
			keys.Values.CopyTo (result, 0);
			
			return result;
		}
		
		/// <include file='ConfigBase.xml' path='//Method[@name="Add"]/docs/*' />
		public void Add (string key, string value)
		{
			keys.Add (key, value);
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="Set"]/docs/*' />
		public virtual void Set (string key, object value)
		{
			if (value == null) {
				throw new ArgumentNullException ("Value cannot be null");
			}

			if (Get (key) == null) {
				this.Add (key, value.ToString ());
			} else {
				keys[key] = value.ToString ();
			}

			if (ConfigSource.AutoSave) {
				ConfigSource.Save ();
			}

			OnKeySet (new ConfigKeyEventArgs (key, value.ToString ()));
		}
		
		/// <include file='IConfig.xml' path='//Method[@name="Remove"]/docs/*' />
		public virtual void Remove (string key)
		{
			if (key == null) {
				throw new ArgumentNullException ("Key cannot be null");
			}
			
			if (Get (key) != null) {
				string keyValue = null;
				if (KeySet != null) {
					keyValue = Get (key);
				}
				keys.Remove (key);

				OnKeyRemoved (new ConfigKeyEventArgs (key, keyValue));
			}
		}
		#endregion

		#region Public events
		/// <include file='IConfig.xml' path='//Event[@name="KeySet"]/docs/*' />
		public event ConfigKeyEventHandler KeySet;

		/// <include file='IConfig.xml' path='//Event[@name="KeyRemoved"]/docs/*' />
		public event ConfigKeyEventHandler KeyRemoved;
		#endregion

		#region Protected methods
		/// <include file='ConfigBase.xml' path='//Method[@name="OnKeySet"]/docs/*' />
		protected void OnKeySet (ConfigKeyEventArgs e)
		{
			if (KeySet != null) {
				KeySet (this, e);
			}
		}

		/// <include file='ConfigBase.xml' path='//Method[@name="OnKeyRemoved"]/docs/*' />
		protected void OnKeyRemoved (ConfigKeyEventArgs e)
		{
			if (KeyRemoved != null) {
				KeyRemoved (this, e);
			}
		}
		#endregion

		#region Private methods
		/// <summary>
		/// Renames the config to the new name. 
		/// </summary>
		private void Rename (string name)
		{
			this.ConfigSource.Configs.Remove (this);
			configName = name;
			this.ConfigSource.Configs.Add (this);
		}
		
		/// <summary>
		/// Returns the integer alias first from this IConfig then 
		/// the parent if there is none.
		/// </summary>
		private int GetIntAlias (string key, string alias)
		{
			int result = -1;
			
			if (aliasText.ContainsInt (key, alias)) {
				result = aliasText.GetInt (key, alias);
			} else {
				result = ConfigSource.Alias.GetInt (key, alias);
			}			
			
			return result;
		}
		
		/// <summary>
		/// Returns the boolean alias first from this IConfig then 
		/// the parent if there is none.
		/// </summary>
		private bool GetBooleanAlias (string key)
		{
			bool result = false;
			
			if (aliasText.ContainsBoolean (key)) {
				result = aliasText.GetBoolean (key);
			} else {
				if (ConfigSource.Alias.ContainsBoolean (key)) {
					result = ConfigSource.Alias.GetBoolean (key);
				} else {
					throw new ArgumentException 
								("Alias value not found: " + key
								+ ". Add it to the Alias property.");
				}
			}	
			
			return result;
		}
		#endregion
	}
}