Ini-Datei-Klasse

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

/// <summary>
/// Klasse, um Dateien im Ini-Format
/// zu verwalten.
/// </summary>
public class CfgFile
{
	/// <summary>
	/// Inhalt der Datei
	/// </summary>
	private List<String> lines = new List<string>();
	
	/// <summary>
	/// Voller Pfad und Name der Datei
	/// </summary>
	private String FileName = "";

	/// <summary>
	/// Gibt an, welche Zeichen als Kommentarbeginn
	/// gewertet werden sollen. Dabei wird das erste 
	/// Zeichen defaultmäßig für neue Kommentare
	/// verwendet.
	/// </summary>
	private String CommentCharacters = "#;";

	/// <summary>
	/// Regulärer Ausdruck für einen Kommentar in einer Zeile
	/// </summary>
	private String regCommentStr = "";

	/// <summary>
	/// Regulärer Ausdruck für einen Eintrag
	/// </summary>
	private Regex regEntry = null;

	/// <summary>
	/// Regulärer Ausdruck für einen Bereichskopf
	/// </summary>
	private Regex regCaption = null;

	/// <summary>
	/// Leerer Standard-Konstruktor
	/// </summary>
	public CfgFile()
	{
		regCommentStr = @"(\s*[" + CommentCharacters + "](?<comment>.*))?";
		regEntry = new Regex(@"^[ \t]*(?<entry>([^=])+)=(?<value>([^=" + CommentCharacters + "])+)" + regCommentStr + "$");
		regCaption = new Regex(@"^[ \t]*(\[(?<caption>([^\]])+)\]){1}" + regCommentStr + "$");
	}

	/// <summary>
	/// Konstruktor, welcher sofort eine Datei einliest
	/// </summary>
	/// <param name="filename">Name der einzulesenden Datei</param>
	public CfgFile(string filename) : this ()
	{
		if (!File.Exists(filename)) throw new IOException("File " + filename + "  not found");
		FileName = filename;
		using (StreamReader sr = new StreamReader(FileName))
			while (!sr.EndOfStream) lines.Add(sr.ReadLine().TrimEnd());
	}

	/// <summary>
	/// Datei sichern
	/// </summary>
	/// <returns></returns>
	public Boolean Save()
	{
		if (FileName == "") return false;
		try
		{
			using (StreamWriter sw = new StreamWriter(FileName))
				foreach (String line in lines)
					sw.WriteLine(line);
		}
		catch (IOException ex)
		{
			throw new IOException("Fehler beim Schreiben der Datei " + fileName, ex);
		}
		catch
		{
			throw new IOException("Fehler beim Schreiben der Datei " + fileName);
		}
		return true;
	}

	/// <summary>
	/// Voller Name der Datei
	/// </summary>
	/// <returns></returns>
	public String fileName
	{
		get { return FileName; }
		set { FileName = value; }
	}

	/// <summary>
	/// Verzeichnis der Datei
	/// </summary>
	/// <returns></returns>
	public String getDirectory()
	{
		return Path.GetDirectoryName(FileName);
	}

	/// <summary>
	/// Sucht die Zeilennummer (nullbasiert) 
	/// eines gewünschten Eintrages
	/// </summary>
	/// <param name="Caption">Name des Bereiches</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>Nummer der Zeile, sonst -1</returns>
	private int SearchCaptionLine(String Caption, Boolean CaseSensitive)
	{
		if (!CaseSensitive) Caption = Caption.ToLower();
		for (int i = 0; i < lines.Count; i++)
		{
			String line = lines[i].Trim();
			if (line == "") continue;
			if (!CaseSensitive) line = line.ToLower();
			// Erst den gewünschten Abschnitt suchen
			if (line == "[" + Caption + "]")
				return i;
		}
		return -1;// Bereich nicht gefunden
	}

	/// <summary>
	/// Sucht die Zeilennummer (nullbasiert) 
	/// eines gewünschten Eintrages
	/// </summary>
	/// <param name="Caption">Name des Bereiches</param>
	/// <param name="Entry">Name des Eintrages</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>Nummer der Zeile, sonst -1</returns>
	private int SearchEntryLine(String Caption, String Entry, Boolean CaseSensitive)
	{
		Caption = Caption.ToLower();
		if (!CaseSensitive) Entry = Entry.ToLower();
		int CaptionStart = SearchCaptionLine(Caption, false);
		if (CaptionStart < 0) return -1;
		for (int i = CaptionStart + 1; i < lines.Count; i++)
		{
			String line = lines[i].Trim();
			if (line == "") continue;
			if (!CaseSensitive) line = line.ToLower();
			if (line.StartsWith("[")) 
				return -1;// Ende, wenn der nächste Abschnitt beginnt
			if (Regex.IsMatch(line, @"^[ \t]*[" + CommentCharacters + "]"))
				continue; // Kommentar
			if (line.StartsWith(Entry)) 
				return i;// Eintrag gefunden
		}
		return -1;// Eintrag nicht gefunden
	}

	/// <summary>
	/// Kommentiert einen Wert aus
	/// </summary>
	/// <param name="Caption">Name des Bereiches</param>
	/// <param name="Entry">Name des Eintrages</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>true = Eintrag gefunden und auskommentiert</returns>
	public Boolean commentValue(String Caption, String Entry, Boolean CaseSensitive)
	{
		int line = SearchEntryLine(Caption, Entry, CaseSensitive);
		if (line < 0) return false;
		lines[line] = CommentCharacters[0] + lines[line];
		return true;
	}

	/// <summary>
	/// Löscht einen Wert
	/// </summary>
	/// <param name="Caption">Name des Bereiches</param>
	/// <param name="Entry">Name des Eintrages</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>true = Eintrag gefunden und gelöscht</returns>
	public Boolean deleteValue(String Caption, String Entry, Boolean CaseSensitive)
	{
		int line = SearchEntryLine(Caption, Entry, CaseSensitive);
		if (line < 0) return false;
		lines.RemoveAt(line);
		return true;
	}

	/// <summary>
	/// Liest den Wert eines Eintrages aus
	/// (Erweiterung: case sensitive)
	/// </summary>
	/// <param name="Caption">Name des Bereiches</param>
	/// <param name="Entry">Name des Eintrages</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>Wert des Eintrags oder leer</returns>
	public String getValue(String Caption, String Entry, Boolean CaseSensitive)
	{
		int line = SearchEntryLine(Caption, Entry, CaseSensitive);
		if (line < 0) return "";
		int pos = lines[line].IndexOf("=");
		if (pos < 0) return "";
		return lines[line].Substring(pos + 1).Trim();
		// Evtl. noch abschliessende Kommentarbereiche entfernen
	}

	/// <summary>
	/// Setzt einen Wert in einem Bereich. Wenn der Wert
	/// (und der Bereich) noch nicht existiert, werden die
	/// entsprechenden Einträge erstellt.
	/// </summary>
	/// <param name="Caption">Name des Bereichs</param>
	/// <param name="Entry">name des Eintrags</param>
	/// <param name="Value">Wert des Eintrags</param>
	/// <param name="CaseSensitive">true = Gross-/Kleinschreibung beachten</param>
	/// <returns>true = Eintrag erfolgreich gesetzt</returns>
	public Boolean setValue(String Caption, String Entry, String Value, Boolean CaseSensitive)
	{
		Caption = Caption.ToLower();
		if (!CaseSensitive) Entry = Entry.ToLower();
		int lastCommentedFound = -1;
		int CaptionStart = SearchCaptionLine(Caption, false);
		if (CaptionStart < 0)
		{
			lines.Add("[" + Caption + "]");
			lines.Add(Entry + "=" + Value);
			return true;
		}
		int EntryLine = SearchEntryLine(Caption, Entry, CaseSensitive);
		for (int i = CaptionStart + 1; i < lines.Count; i++)
		{
			String line = lines[i].Trim();
			if (!CaseSensitive) line = line.ToLower();
			if (line == "") continue;
			// Ende, wenn der nächste Abschnitt beginnt
			if (line.StartsWith("["))
			{
				lines.Insert(i, Entry + "=" + Value);
				return true;
			}
			// Suche aukommentierte, aber gesuchte Einträge
			// (evtl. per Parameter bestimmen können?), falls
			// der Eintrag noch nicht existiert.
			if (EntryLine<0)
				if (Regex.IsMatch(line, @"^[ \t]*[" + CommentCharacters + "]"))
				{
					String tmpLine = line.Substring(1).Trim();
					if (tmpLine.StartsWith(Entry))
					{
						// Werte vergleichen, wenn gleich,
						// nur Kommentarzeichen löschen
						int pos = tmpLine.IndexOf("=");
						if (pos > 0)
						{
							if (Value == tmpLine.Substring(pos + 1).Trim())
							{
								lines[i] = tmpLine;
								return true;
							}
						}
						lastCommentedFound = i;
					}
					continue;// Kommentar
				}
			if (line.StartsWith(Entry))
			{
				lines[i] = Entry + "=" + Value;
				return true;
			}
		}
		if (lastCommentedFound > 0)
			lines.Insert(lastCommentedFound + 1, Entry + "=" + Value);
		else
			lines.Insert(CaptionStart + 1, Entry + "=" + Value);
		return true;
	}

	/// <summary>
	/// Liest alle Einträge uns deren Werte eines Bereiches aus
	/// </summary>
	/// <param name="Caption">Name des Bereichs</param>
	/// <returns>Sortierte Liste mit Einträgen und Werten</returns>
	public SortedList<String, String> getCaption(String Caption)
	{
		SortedList<String, String> result = new SortedList<string,string>();
		Boolean CaptionFound = false;
		for (int i = 0; i < lines.Count; i++)
		{
			String line = lines[i].Trim();
			if (line == "") continue;
			// Erst den gewünschten Abschnitt suchen
			if (!CaptionFound)
				if (line.ToLower() != "[" + Caption + "]") continue;
				else
				{
					CaptionFound = true;
					continue;
				}
			// Ende, wenn der nächste Abschnitt beginnt
			if (line.StartsWith("[")) break;
			if (Regex.IsMatch(line, @"^[ \t]*[" + CommentCharacters + "]")) continue; // Kommentar
			int pos = line.IndexOf("=");
			if (pos < 0)
				result.Add(line, "");
			else
				result.Add(line.Substring(0,pos).Trim(),line.Substring(pos + 1).Trim());
		}
		return result;
	}

	/// <summary>
	/// Erstellt eine Liste aller enthaltenen Bereiche
	/// </summary>
	/// <returns>Liste mit gefundenen Bereichen</returns>
	public List<string> getAllCaptions()
	{
		List<string> result = new List<string>();
		for (int i = 0; i < lines.Count; i++)
		{
			String line = lines[i];
			Match mCaption = regCaption.Match(lines[i]);
			if (mCaption.Success)
				result.Add(mCaption.Groups["caption"].Value.Trim());
		}
		return result;
	}

	/// <summary>
	/// Exportiert sämtliche Bereiche und deren Werte
	/// in ein XML-Dokument
	/// </summary>
	/// <returns>XML-Dokument</returns>
	public XmlDocument exportToXml()
	{
		XmlDocument doc = new XmlDocument();
		XmlElement root = doc.CreateElement(
			Path.GetFileNameWithoutExtension(this.fileName));
		doc.AppendChild(root);
		XmlElement Caption = null;
		for (int i = 0; i < lines.Count; i++)
		{
			Match mEntry = regEntry.Match(lines[i]);
			Match mCaption = regCaption.Match(lines[i]);
			if (mCaption.Success)
			{
				Caption = doc.CreateElement(mCaption.Groups["caption"].Value.Trim());
				root.AppendChild(Caption);
				continue;
			}
			if (mEntry.Success)
			{
				XmlElement xe = doc.CreateElement(mEntry.Groups["entry"].Value.Trim());
				xe.InnerXml = mEntry.Groups["value"].Value.Trim();
				if (Caption == null)
					root.AppendChild(xe);
				else
					Caption.AppendChild(xe);
			}
		}
		return doc;
	}
}