Special INI Lib v1.0

    • Release

    Es gibt 11 Antworten in diesem Thema. Der letzte Beitrag () ist von ~blaze~.

      Special INI Lib v1.0

      SpecialINILib

      Beschreibung:
      Direkt von Vornherein: Das ist keine "normale" 0815-INI Lib! Häufig hat man diverse Einstellungen, die das eigene Programm in Funktion und Aussehen beeinflussen (=> Farben, zahlreiche "Trigger" - also Boolean-Variablen, Zahlenwerte, etc). Natürlich gibt es tausend (bessere) Wege diese zu speichern und zu laden (serialisieren, my.settings,...) als auf eine INI-Datei zurückzugreifen - manchmal tut man das aber doch, nur um sich an die "alten Zeiten" zu erinnern xD Und mal ehrlich: INI-Dateien sind schon praktisch um dem fortgeschrittenen Nutzer mehr Freiheiten zu geben.

      Wie auch immer, wer sich für das INI-System entscheidet hat gleich viele Probleme - Das einlesen birgt so einige Hürden: statt einer Zahl wird "haxx0r" einem Schlüssel zugeordnet, das Programm muss auf diese Ausnahme reagieren. Bei mehreren Einstellungen verliert der Programmierer schnell die Lust, da er jedes Paar einzeln behandeln muss... genau da setzt meine Lib an!

      Wie ich schon irgendwo geschrieben habe: Jede Instanz, ganz gleich welchen Types, kann mit der Lib verarbeitet werden. Einzige Voraussetzung: Sie enthält Properties (=> siehe unterstützte Datentypen). Die Lib "klinkt" sich per Extension an Object ein und ist somit Teil jedes Datentyps in .NET

      Benutzung:
      Der Nachteil meiner Lib ist, dass man für seine Einstellungen zwangsläufig eine Klasse (mit entsprechenden Properties) erstellen muss. Das ist aber gleichzeitig der große Vorteil: Man hat während der Entwicklungszeit die Unterstütztung von IntelliSense und muss sich nicht mit Konstrukten wie "cint(INI_Read("Sektion","IeinSchlüssel"))" rummschlagen. Ebenfalls braucht man sich nicht selbst um die TypUnwandlungen kümmern - die Varibalen in der Klasse haben ja ihren fest zugeordneten Typ!
      Meine Lib übernimmt das Speichern und Laden der Einstellungen in und aus einer INI-Datei - und das vollautomatisiert:

      Zu Beginn steht:

      VB.NET-Quellcode

      1. Imports SpecialINILib.PropertyToINI


      Als erstes benötigt man eine Klasse welche die Einstellungen "kapselt"
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Public Class MeineTesteinstellungen
      3. Dim _bool As Boolean = False
      4. Dim _str As String = "Hier steht etwas..."
      5. Dim _Color As Color = Color.Black
      6. Dim _zahl As Integer = 42
      8. Public Property EinBoolean() As Boolean
      9. Get
      10. Return _bool
      11. End Get
      12. Set(ByVal value As Boolean)
      13. _bool = value
      14. End Set
      15. End Property
      16. Public Property EinText() As String
      17. Get
      18. Return _str
      19. End Get
      20. Set(ByVal value As String)
      21. _str = value
      22. End Set
      23. End Property
      24. <NoINIProperty()> Public Property EineZahl() As Integer
      25. Get
      26. Return _zahl
      27. End Get
      28. Set(ByVal value As Integer)
      29. _zahl = value
      30. End Set
      31. End Property
      32. Public Property EineFarbe() As Color
      33. Get
      34. Return _Color
      35. End Get
      36. Set(ByVal value As Color)
      37. _Color = value
      38. End Set
      39. End Property
      41. End Class


      Speichern in eine INI-Datei
      Diese Einstellungen können automatisiert in eine Sektion gespeichert werden (im tmpINI_Datei String befindet sich der Inhalt der INI-Sektion. Wie dieser in eine Datei geschrieben wird bzw ausgelesen wird soll Problem des Programmieres sein^^)
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Dim Einstellungen As New MeineTesteinstellungen
      3. '..Einstellungen verändern sich...
      4. With Einstellungen
      5. .EinBoolean = True
      6. .EineFarbe = Color.Red
      7. .EineZahl = 13
      8. .EinText = "Mal schauen ob es klappt.."
      9. End With
      11. Dim tmpINI_Datei As String = ""'<= Das ist unsere "INI-Datei". Der String muss natürlich in eine echte Datei geschrieben/gelesen werden!
      13. tmpINI_Datei = Einstellungen.ExportINISettings("TestSektion", True) '=> ALLE (möglichen) Properties werden in die INI geschrieben
      14. 'tmpINI_Datei = Einstellungen.ExportINISettings("TestSektion", False) ' => nur per Attribut "markierte" Properties werden (wenn möglich) in die INI geschreiben


      Laden aus einer INI-Datei
      Mit diesem "Einzeiler" kann man die INI-Datei - unter Angabe einer Sektion - einlesen
      Spoiler anzeigen

      VB.NET-Quellcode

      1. Dim Einstellungen As New MeineTesteinstellungen
      2. Einstellungen.ImportINISettings(tmpINI_Datei, "TestSektion")


      Für den Fall, dass die EinstellungenKlasse Properties enthält, die nicht in die INI-Datei gelangen sollen ist auch vorgesorgt - für den umgekehrten Fall, dass nur einige wenige gespeichert und geladen werden sollen ebenfalls:
      Mit den Attributen <INIProperty()> und <NoINIProperty()> kann man genau festlegen welche Properties in die INI-File geschrieben werden dürfen. Eine Überladung von <INIProperty()> ermöglicht es darüber hinaus einen Hinweis (per Kommentar) in die INI-Datei schreiben zu lassen. (Tipp: man kann eine Klasse per Attribut markieren. Tipp2: Die Markierungen sind nicht erforderlich, jede Klasse die gültige Variablen enthält kann ihre Einstellungen in das INI-Format bringen und umgekehrt)



      Wie man sieht, werden nur "markierte" Properties gespeichert. Un-Markierte bzw als NoINIProperty markierte werden nicht gespeichert. Diesen Mechanismus kann man beeinflussen - .ExportINISettings hat mehrere Überladungen. Schaltet man AllPossibleProperties auf true, so werden alle (möglichen) Properties gespeichert, egal ob sie markiert sind oder nicht. Nur NoINIProperty-Markierte entkommen dem.

      Unterstütze Datentypen:
      Boolean, String, Color, Rectangle, Point, Date
      Zahlenwerte: Integer, Single, Decimal, Double, Byte, Long

      Hinweis:
      INI-Dateien sind natürlich sehr Fehleranfällig (bsp: "Haxx0r" statt Zahlenwert). Diese "Lesefehler" werden einfach übergangen, d.h. der Wert der betreffenden Variable bleibt unverändert. Auf Userwunsch (SpecialINILib.ThrowReadErrors = True) wird in solchen Fällen eine Exception geworfen. Aus diesem Grund ist davon abzuraten INI-Dateien als "Dateiformat" zu missbrauchen denn bei Programmeinstellungen (ob AntiAliasing verwendet wird oder nicht, etc) ist die Tragweite solcher fehlinterpretationen eher gering.

      Verwendete Programmiersprache:
      Visual Basic .NET (IDE: VB 2008 Express)

      Systemanforderungen:
      .NET Framework 3.5

      Lizenz/Weitergabe:
      Freeware, Namensnennung wäre nett^^
      Dateien

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „FreakJNS“ ()

      Nach Wunsch gibts hier den Source^^

      Spoiler anzeigen

      VB.NET-Quellcode

      1. Imports System.ComponentModel
      2. Imports System.drawing
      3. Imports System.Runtime.CompilerServices
      6. Public Module PropertyToINI
      8. Public CommentsPräfix As Char = ";"c 'Präfix für eine Kommentar-zeile
      9. Public ThrowReadErrors As Boolean = False 'Soll eine Exception geworfen werden, wenn ein Schlüssel-Wert-Paar nicht eingelesen werden kann.
      11. <Extension()> Function ExportINISettings(ByVal obj As Object, ByVal Sektion As String, Optional ByVal AllPossibleProperties As Boolean = False) As String
      13. Dim x() As Reflection.PropertyInfo = obj.GetType.GetProperties
      14. Dim tmp As String = "[" & Sektion & "]" & vbCrLf
      16. For Each pi As Reflection.PropertyInfo In x
      17. Dim attr() As Object = pi.GetCustomAttributes(True)
      19. Dim isNoINIProperty As Boolean = False : If attr.Contains(New NoINIPropertyAttribute) Or obj.GetType.GetCustomAttributes(True).Contains(New NoINIPropertyAttribute) Then isNoINIProperty = True
      20. Dim isINIProperty As Boolean = False : If (attr.Contains(New INIPropertyAttribute) Or obj.GetType.GetCustomAttributes(True).Contains(New INIPropertyAttribute)) Then isINIProperty = True
      22. If (Not isNoINIProperty) And (AllPossibleProperties Or isINIProperty) Then
      24. 'Name und Wert bestimmen...
      25. Dim n As String = pi.Name
      26. Dim vo As Object = pi.GetValue(obj, Nothing)
      28. 'Beschreibung abrufen...
      29. Dim desc As String = ""
      30. For Each a As Object In attr
      31. If a.GetType Is GetType(INIPropertyAttribute) Then
      32. Dim ca As INIPropertyAttribute = DirectCast(a, INIPropertyAttribute)
      33. desc = Trim(ca.Description)
      34. End If
      35. Next
      37. 'Den Wert in einen String konvertieren, das Paar in den INI-String schreiben
      38. If vo IsNot Nothing Then
      39. Dim v As String = ValueToString(vo)
      40. If v IsNot Nothing Then
      41. If desc <> "" Then tmp &= CommentsPräfix & n & ": " & desc & vbCrLf
      42. tmp &= n & " = " & v & vbCrLf
      43. End If
      44. End If
      46. End If
      47. Next
      49. tmp &= vbCrLf
      50. Return tmp
      52. End Function
      53. <Extension()> Sub ImportINISettings(ByVal obj As Object, ByVal INIString As String, ByVal Sektion As String)
      55. Dim x() As Reflection.PropertyInfo = obj.GetType.GetProperties()
      56. Dim tmp As Dictionary(Of String, String) = GetSektionMembers(INIString, Sektion)
      58. If tmp IsNot Nothing Then
      59. For Each pi As Reflection.PropertyInfo In x
      61. If pi.CanWrite Then 'Wenn die Property beschrieben werden darf..
      63. Dim n As String = pi.Name
      64. Dim vo As String = Nothing
      65. Dim vType As Object = pi.GetValue(obj, Nothing) '
      67. If tmp.Keys.Contains(n) Then 'Liest den Wert zum Key aus der INI ein
      68. vo = tmp.Item(n)
      69. End If
      71. 'Den aus der INI ausgelesenen String in den entsprechenden Property-Typ konvertieren und zuweisen...
      72. If Not vo Is Nothing Then
      73. Try
      74. Select Case True
      76. Case vType.GetType Is GetType(Color) : pi.SetValue(obj, DirectCast((New ColorConverter).ConvertFromString(vo), Color), Nothing)
      77. Case vType.GetType Is GetType(Boolean) : pi.SetValue(obj, DirectCast((New BooleanConverter).ConvertFromInvariantString(vo), Boolean), Nothing)
      78. Case vType.GetType Is GetType(Rectangle) : pi.SetValue(obj, DirectCast((New RectangleConverter).ConvertFromInvariantString(vo), Rectangle), Nothing)
      79. Case vType.GetType Is GetType(Point) : pi.SetValue(obj, DirectCast((New PointConverter).ConvertFromInvariantString(vo), Point), Nothing)
      80. Case vType.GetType Is GetType(String) : pi.SetValue(obj, vo.ToString, Nothing)
      81. Case vType.GetType Is GetType(Date) : pi.SetValue(obj, Date.Parse(vo), Nothing)
      83. Case vType.GetType Is GetType(Integer) : pi.SetValue(obj, CInt(vo), Nothing)
      84. Case vType.GetType Is GetType(Single) : pi.SetValue(obj, CSng(vo), Nothing)
      85. Case vType.GetType Is GetType(Decimal) : pi.SetValue(obj, CDec(vo), Nothing)
      86. Case vType.GetType Is GetType(Double) : pi.SetValue(obj, CDbl(vo), Nothing)
      87. Case vType.GetType Is GetType(Byte) : pi.SetValue(obj, CSByte(vo), Nothing)
      88. Case vType.GetType Is GetType(Long) : pi.SetValue(obj, CLng(vo), Nothing)
      90. End Select
      91. Catch ex As Exception
      92. 'Kann ein wert nicht in den entsprechenden Typ konvertiert werden..
      93. If ThrowReadErrors Then Throw New Exception("Fehler beim Convertieren der Property: " & n)
      94. End Try
      97. End If
      98. End If
      99. Next
      100. End If
      102. End Sub
      104. 'Internes INI-System..
      105. Private Function GetSektionMembers(ByVal INI As String, ByVal Sektion As String) As Dictionary(Of String, String)
      107. Dim Sektions As Dictionary(Of String, Dictionary(Of String, String)) = ParseINI(INI)
      109. If Sektions.Keys.Contains(Sektion) Then
      110. Return Sektions(Sektion)
      111. Else
      112. Return Nothing
      113. End If
      115. End Function
      116. Private Function GetSektions(ByVal INI As String) As String()
      117. Dim Sektions As Dictionary(Of String, Dictionary(Of String, String)) = ParseINI(INI)
      118. Return Sektions.Keys.ToArray
      119. End Function
      120. Private Function ParseINI(ByVal INI As String) As Dictionary(Of String, Dictionary(Of String, String))
      121. Dim Sektions As New Dictionary(Of String, Dictionary(Of String, String))
      123. Dim tmpsektionName As String = ""
      124. For Each l As String In Split(INI, vbCrLf)
      126. Dim Line As String = Trim(l)
      128. If Line.Count > 0 Then
      130. If Line.First = "["c And Line.Last = "]"c Then
      131. tmpsektionName = Line
      132. tmpsektionName = tmpsektionName.Replace("["c, "")
      133. tmpsektionName = tmpsektionName.Replace("]"c, "")
      134. End If
      136. If l.Count > 0 AndAlso Not l.First = CommentsPräfix Then
      137. Dim splited() As String = Split(l, " = ", 2)
      138. If splited.Count = 2 Then
      139. Dim Key As String = splited(0)
      140. Dim Val As String = splited(1)
      142. If Sektions.Keys.Contains(tmpsektionName) Then
      143. If Not Sektions(tmpsektionName).Keys.Contains(Key) Then
      144. Sektions(tmpsektionName).Add(Key, Val)
      145. Else
      146. Sektions(tmpsektionName)(Key) = Val
      147. End If
      148. Else
      149. Sektions.Add(tmpsektionName, New Dictionary(Of String, String))
      150. Sektions(tmpsektionName).Add(Key, Val)
      151. End If
      153. End If
      155. End If
      156. End If
      158. Next
      159. Return Sektions
      160. End Function
      162. 'wandelt unterstützte Typen in Strings
      163. Private Function ValueToString(ByVal p As Object) As String
      165. Select Case True
      166. Case p.GetType Is GetType(String) : Return p.ToString
      167. Case p.GetType Is GetType(Color) : Return (New ColorConverter).ConvertToString(p)
      168. Case p.GetType Is GetType(Boolean) : Return p.ToString
      169. Case p.GetType Is GetType(Date) : Return p.ToString
      170. Case p.GetType Is GetType(Rectangle) : Return (New RectangleConverter).ConvertToInvariantString(p)
      171. Case p.GetType Is GetType(Point) : Return (New PointConverter).ConvertToInvariantString(p)
      174. Case IsNumeric(p.ToString) : Return p.ToString
      176. End Select
      178. Return Nothing
      179. End Function
      181. Public Class INIPropertyAttribute
      182. Inherits Attribute
      183. Public Sub New()
      184. End Sub
      185. Public Sub New(ByVal Beschreibung As String)
      186. Description = Beschreibung
      187. End Sub
      188. Public Description As String = ""
      189. Public Overrides Function Equals(ByVal obj As Object) As Boolean
      190. If TypeOf (obj) Is INIPropertyAttribute Then
      191. Return True
      192. Else
      193. Return False
      194. End If
      195. End Function
      196. End Class
      197. Public Class NoINIPropertyAttribute
      198. Inherits Attribute
      199. Public Sub New()
      200. End Sub
      201. End Class
      203. End Module


      (das ganze habe ich btw nicht mehr weiterentwicket und würde es in keinem eigenen Projekt mehr einsetzten wollen. Veraltet, teilweise nicht perfekt gecodet, etc. Zum Lernen aber ganz gut)

      Interessante Idee!
      Mfg: Gather
      Private Nachrichten bezüglich VB-Fragen werden Ignoriert!

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Gather“ ()

      --Entfernt--
      Mfg: Gather
      Private Nachrichten bezüglich VB-Fragen werden Ignoriert!

      Dieser Beitrag wurde bereits 1 mal editiert, zuletzt von „Gather“ ()

      Wenn ich das richtig verstanden habe soll das so eine Art INISerializer sein?
      Dann hätte ich eine Frage wieso sollte man dies benutzen und nicht die vorhandenen, welche auch noch mehr Möglichkeiten bieten.
      z.B.: wieso Xml und nicht Binary: Weil man Xml noch anständig lesen kann
      oder wieso Binary und nicht Xml: weil Binary flexibler ist und mehr Datentypen kann.


      Opensource Audio-Bibliothek auf github: KLICK, im Showroom oder auf NuGet.

      Was mir aufgefallen ist, da du sie schon Special nennst :P
      Und ich vermute mal Aufgrund der Möglichkeit zur Serialisierung:
      [VB.NET] IniLib - 08.11.2011

      da ist kein Special dabei und es wird auch Serialisierung unterstützt. Nunja, vlt. wird das Special gar nicht erwartet, weil ~blaze~ schon "Speziell" ist :D

      Wollte zwar keine korinthen kacken, habs jetzt aber trotzdem gemacht... :P
      Ich wollte auch mal ne total überflüssige Signatur:
      ---Leer---

      @thefiloe
      Richtig, ein stinknormaler Serializer kann mehr und ist besser. Das Teil hier verarbeitet aber automatisiert INI-Dateien - ich kenne keinen Serializer der Daten im INI-Format speichern/lesen kann - und zwar aus und in Klassen. Vorteil vom INI-Format ist, dass es sehr leicht von handzufuß bearbeitet werden kann, wer also seinen Usern mehr Einstellmöglichkeiten bieten will, dabei aber keinen workaround hinlegen will könnte auf das zurückgreifen. IMO ist es besser sowas zu verwenden als sich die Finger wundzuschreiben um INIs zu lesen/schreiben. Vor allem wenn man OptionStrict ON verwendet kann da jede Menge Code entstehen - fällt bei mir alles weg.

      @jvbsl
      Eine Speichern/Lade-Möglichkeit ist ja nicht alles, was meine Lib bietet^^ Der Punkt ist, dass meine Lib automatisiert Daten aus einer Klasse in eine INI-Datei schreibt bzw wieder ausliest. Man arbeitet also nichtmehr mit "GetValue("Sektion","Key")" oder dergleichen sonder mit etwas viel mächtigerem: InteliSense. Die Informationen liegen ja immer in einer Klasseninstanz vor und somit ist die Lib quasie ein Interface zwischen den rohen Ini-Einträgen und echten Klassen. Genau das ist der extreme Vorteil: Man kümmert sich vorranging nichtmehr um das Speichern/Laden (dass passiert weitestgehend automatisch), sondern kann das wesentliche (das Programm) programmieren^^

      Vergleiche mal vieviel Code nötig ist um nur 4 Einstellungen aus einer INI-Datei zu lesen bzw in sie zu schreiben - und dann schau dir das an:



      Die Einstellungen-Klasse kann beliebig viele Properties enthalten. Diese werden automatisch gelesen/geschrieben und stehen dann in einer Klasseninstanz zur verfügung und können mittels IntelliSense eingesehen werden. Wenn man nun einen INI-Eintrag hinzufügen will muss man nur eine Property adden. Im Save/Load-Part ändert sich garnichts! Besser kann man mit INI-Files nur arbeiten, wenn man sie nicht benutzt^^



      @BeefyX
      Da schause was? xD
      Das Try ist imo nötig, da es immer zu "falschen" Angaben kommen kann - INIs sind eben Fehleranfällig.
      Wenn du auf das "Select Case True" hinauswillst, dann kann ich versichern, dass es so seine Richtigkeit hat.


      lg^^

      Hi
      mein Programm unterstützt seit Version 2.3 auch Serialisierung, auch wenn die etwas komplizierter ist und vor Allem hierarchische Strukturen bildet, sodass auch Klassen in Klassen korrekt serialisiert werden (sollten).
      Wenn du Lust hast, kannst du sie oder den Source dir ja mal anschauen.

      Gruß
      ~blaze~

    Facebook
    Telefonspende