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
|
//
// System.Diagnostics.Switch.cs
//
// Comments from John R. Hicks <angryjohn69@nc.rr.com> original implementation
// can be found at: /mcs/docs/apidocs/xml/en/System.Diagnostics
//
// Author:
// John R. Hicks (angryjohn69@nc.rr.com)
// Jonathan Pryor (jonpryor@vt.edu)
//
// (C) 2001-2002
//
//
// 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.Collections;
using System.Collections.Specialized;
#if NET_2_0 && CONFIGURATION_DEP
using System.Configuration;
#endif
namespace System.Diagnostics
{
public abstract class Switch
{
private string name;
private string description;
private int switchSetting;
#if NET_2_0
private string value;
private string defaultSwitchValue;
#endif
// MS Behavior is that (quoting from MSDN for OnSwitchSettingChanged()):
// "...It is invoked the first time a switch reads its value from the
// configuration file..."
// The docs + testing implies two things:
// 1. The value of the switch is not read in from the constructor
// 2. The value is instead read in on the first time get_SwitchSetting is
// invoked
// Assuming that OnSwitchSettingChanged() is invoked on a .config file
// read and on all changes
//
// Thus, we need to keep track of whether or not switchSetting has been
// initialized. Using `switchSetting=-1' seems logical, but if someone
// actually wants to use -1 as a switch value that would cause problems.
private bool initialized;
protected Switch(string displayName, string description)
{
this.name = displayName;
this.description = description;
}
#if NET_2_0
protected Switch(string displayName, string description, string defaultSwitchValue)
: this (displayName, description)
{
this.defaultSwitchValue = defaultSwitchValue;
}
#endif
public string Description {
get {return description;}
}
public string DisplayName {
get {return name;}
}
protected int SwitchSetting {
get {
if (!initialized) {
initialized = true;
GetConfigFileSetting ();
OnSwitchSettingChanged ();
}
return switchSetting;
}
set {
if(switchSetting != value) {
switchSetting = value;
OnSwitchSettingChanged();
}
initialized = true;
}
}
#if NET_2_0
StringDictionary attributes = new StringDictionary ();
#if XML_DEP
[System.Xml.Serialization.XmlIgnore]
#endif
public StringDictionary Attributes {
get { return attributes; }
}
protected string Value {
get { return value; }
set {
this.value = value;
#if NET_2_0 && CONFIGURATION_DEP
try {
OnValueChanged ();
} catch (Exception ex) {
string msg = string.Format ("The config "
+ "value for Switch '{0}' was "
+ "invalid.", DisplayName);
throw new ConfigurationErrorsException (
msg, ex);
}
#else
OnValueChanged ();
#endif
}
}
protected internal virtual string [] GetSupportedAttributes ()
{
return null;
}
protected virtual void OnValueChanged ()
{
}
#endif
private void GetConfigFileSetting ()
{
IDictionary d = (IDictionary) DiagnosticsConfiguration.Settings ["switches"];
// Load up the specified switch
if (d != null) {
if (d.Contains (name)) {
#if NET_2_0 && CONFIGURATION_DEP
Value = d [name] as string;
#else
switchSetting = (int) d [name];
#endif
return;
}
}
#if NET_2_0
if (defaultSwitchValue != null) {
value = defaultSwitchValue;
OnValueChanged ();
}
#endif
}
protected virtual void OnSwitchSettingChanged()
{
// Do nothing. This is merely provided for derived classes to know when
// the value of SwitchSetting has changed.
}
}
}
|