Feedback

C# - Ini-Datei-Klasse

Veröffentlicht von am 15.11.2007
(6 Bewertungen)
Mit der Ini-Datei-Klasse kann man rel. einfach Dateien im Ini-Format erstellen/bearbeiten, da ja doch noch in vielen Fällen von anderen Programmen Daten in dieser Form gespeichert werden.

Eine Konfiguration kann entweder komplett neu mit dem Standard-Konstruktor erstellt oder von einer vorhandenen Datei eingelesen werden.

Mit getValue kann man Werte auslesen, mit setValue setzen. getCaption gibt alle Einträge eines Bereiches zurück, mit Save kann man die Änderungen speichern und getAllCaptions gibt alle Bereichsnamen zurück.

Unterstützt Groß-/Kleinschreibung, XML-Export ist möglich

Folgende Namespaces werden benötigt:
System, System.Collections.Generic, System.Text, System.IO, System.Xml, System.Text.RegularExpressions;
/// <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;
	}
}
Abgelegt unter Ini, Xml, Caption, Konfiguration.

5 Kommentare zum Snippet

Edgar Pützer schrieb am 14.11.2008:
Super Klasse! Sie hat mir sehr viel Arbeit abgenommen.
Dennoch waren für meine Applikation kleine Anpassungen notwendig die sicherlich allgemein interessant sind:

1) Abfrage Anzahl der Elemente
public long Count()
{
return lines.Count();
}

2) Konstruktor CfgFile Um ANSI zu lesen (Umlaute)
...

StreamReader(FileName, Encoding.Default)

3) Funktion Save: Um ANSI zu schreiben (Umlaute)
...
using (StreamWriter sw = new StreamWriter(FileName,false, Encoding.Default))


4) Um ähnliche Key's zu lesen MeinKey =... MeinKeyZweiter=
Vorher wurden diese Key als ein Key (Tritt dann doppelt auf) identifiziert
Funktion SearchEntryLine:
....
Alt:
if (line.StartsWith(Entry))

Neu:
if (line.StartsWith(Entry+"="))


Thomas Fritsch schrieb am 22.12.2010:
Schöne Klasse, nur habe ich das CaseSensitive auch auf die 'Caption' erweitert, denn nur dann hat es mit ener bestehenden INI-Datei funktioniert auf die ich zugreifen musste.
Maurice schrieb am 31.08.2017:
Moin,

ich verzweifel hier gerade etwas, wie kann ich den das result von getAllCaptions ausgeben lassen?

LG

Maurice
Koopakiller schrieb am 31.08.2017:
@Maurice
Woran scheitert es denn genau? getAllCaptions liefert dir eine Liste zurück, die könntest du beispielsweise in eine MessaageBox packen:

var captions = instance.getAllCaptions();
var joinedString = string.Join("\n", captions); // Alle Listen-Einträge mit je einem Zeilenunbruch ("\n") dazwischen zu einem String verketten
MessageBox.Show(joinedString);

Genauso kannst du natürlich auch alles in eine Konsole oder eine ListBox o.ä. ausgeben.
Maurice schrieb am 01.09.2017:
Hallo Koopakiller,

DAS hat mir den Tag und das WE, gerettet!!

Merci

LG

Maurice
 

Logge dich ein, um hier zu kommentieren!