microsoft-visualbasic-runtime/Text/Xml/Xmlns.vb

#Region "Microsoft.VisualBasic::f102d5b8bfab1c9bab600e58f1abd72e, Microsoft.VisualBasic.Core\Text\Xml\Xmlns.vb"

    ' Author:
    ' 
    '       asuka (amethyst.asuka@gcmodeller.org)
    '       xie (genetics@smrucc.org)
    '       xieguigang (xie.guigang@live.com)
    ' 
    ' Copyright (c) 2018 GPL3 Licensed
    ' 
    ' 
    ' GNU GENERAL PUBLIC LICENSE (GPL3)
    ' 
    ' 
    ' This program is free software: you can redistribute it and/or modify
    ' it under the terms of the GNU General Public License as published by
    ' the Free Software Foundation, either version 3 of the License, or
    ' (at your option) any later version.
    ' 
    ' This program is distributed in the hope that it will be useful,
    ' but WITHOUT ANY WARRANTY; without even the implied warranty of
    ' MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    ' GNU General Public License for more details.
    ' 
    ' You should have received a copy of the GNU General Public License
    ' along with this program. If not, see <http://www.gnu.org/licenses/>.



    ' /********************************************************************************/

    ' Summaries:

    '     Class Xmlns
    ' 
    '         Properties: [namespace], xmlns, xsd, xsi
    ' 
    '         Constructor: (+1 Overloads) Sub New
    ' 
    '         Function: RootParser, ToString
    ' 
    '         Sub: [Set], __replace, Clear, WriteNamespace
    ' 
    ' 
    ' /********************************************************************************/

#End Region

Imports System.Text
Imports System.Text.RegularExpressions
Imports Microsoft.VisualBasic.ComponentModel.Collection
Imports Microsoft.VisualBasic.ComponentModel.DataSourceModel
Imports Microsoft.VisualBasic.Linq
Imports Microsoft.VisualBasic.Serialization.JSON
Imports r = System.Text.RegularExpressions.Regex

Namespace Text.Xml

    ''' <summary>
    ''' Xml namespace
    ''' </summary>
    Public Class Xmlns

        ''' <summary>
        ''' ``xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"``
        ''' </summary>
        Public Const DefaultXmlns As String = "xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" xmlns:xsi=""http://www.w3.org/2001/XMLSchema-instance"""

        ''' <summary>
        ''' ``xmlns=...``
        ''' </summary>
        ''' <returns></returns>
        Public Property xmlns As String
        ''' <summary>
        ''' 枚举所有``xmlns:&lt;type>``开始的属性
        ''' </summary>
        ''' <returns></returns>
        Public Property [namespace] As Dictionary(Of NamedValue(Of String))

        Public Property xsd As String
            Get
                Return Me(xmlns_xsd)
            End Get
            Set(value As String)
                [namespace](xmlns_xsd) = New NamedValue(Of String)(xmlns_xsd, value)
            End Set
        End Property

        Public Property xsi As String
            Get
                Return Me(xmlns_xsi)
            End Get
            Set(value As String)
                [namespace](xmlns_xsi) = New NamedValue(Of String)(xmlns_xsi, value)
            End Set
        End Property

        Default Public ReadOnly Property ns(name As String) As String
            Get
                If [namespace].ContainsKey(name) Then
                    Return [namespace](name).Value
                Else
                    Return ""
                End If
            End Get
        End Property

        Const xmlnsRegex As String = "\sxmlns:\S+="".+?"""
        Const xmlns_xsd As String = "xmlns:xsd"
        Const xmlns_xsi As String = "xmlns:xsi"

        Sub New(root As String)
            Dim s As String

            [namespace] = New Dictionary(Of NamedValue(Of String))
            s = r.Match(root, "xmlns="".+?""", RegexICSng).Value
            xmlns = s.GetStackValue("""", """")

            Dim nsList As String() = r _
                .Matches(root, xmlnsRegex, RegexICSng) _
                .ToArray(AddressOf Trim)

            For Each ns As String In nsList
                [namespace] += ns _
                    .GetTagValue("=") _
                    .FixValue(Function(x)
                                  Return x.GetStackValue("""", """")
                              End Function)
            Next
        End Sub

        ''' <summary>
        ''' Set the value of a new xml namespace.(<paramref name="ns"/>命名空间参数不需要添加 xmlns: 前缀)
        ''' </summary>
        ''' <param name="ns"></param>
        ''' <param name="value"></param>
        Public Sub [Set](ns As String, value As String)
            ns = $"xmlns:{ns}"
            [namespace](ns) = New NamedValue(Of String)(ns, value)
        End Sub

        Public Sub Clear(ns$)
            Call [Set](ns, "")
        End Sub

        ''' <summary>
        ''' The parser for the xml root node.
        ''' </summary>
        ''' <param name="root"></param>
        ''' <returns></returns>
        Public Shared Function RootParser(root As String) As NamedValue(Of Xmlns)
            Dim ns As New Xmlns(root)
            Dim name As String = root.Split.First
            name = Mid(name, 2)
            Return New NamedValue(Of Xmlns)(name, ns)
        End Function

        Public Overrides Function ToString() As String
            Return Me.GetJson
        End Function

        ''' <summary>
        ''' 
        ''' </summary>
        ''' <param name="xml"></param>
        ''' <remarks>当前的这个对象是新值，需要替换掉文档里面的旧值</remarks>
        Public Sub WriteNamespace(xml As StringBuilder, Optional usingDefault_xmlns As Boolean = False)
            Dim rs As String = XmlDoc.__rootString(xml.ToString)
            Dim root As Xmlns = New Xmlns(rs) ' old xmlns value
            Dim ns As New StringBuilder(rs)  ' 可能还有其他的属性，所以在这里还不可以直接拼接字符串然后直接进行替换

            For Each nsValue As NamedValue(Of String) In [namespace].Values.SafeQuery
                Dim rootNs As String = root(nsValue.Name)

                If Not String.IsNullOrEmpty(rootNs) Then
                    Dim s As String =
                        If(String.IsNullOrEmpty(nsValue.Value),
                        "",
                        $"{nsValue.Name}=""{nsValue.Value}""")
                    Call ns.Replace($"{nsValue.Name}=""{rootNs}""", s)
                Else
                    If Not String.IsNullOrEmpty(nsValue.Value) Then
                        Call __replace(ns, $"{nsValue.Name}=""{nsValue.Value}""")
                    End If
                End If
            Next

            If Not String.IsNullOrEmpty(root.xmlns) Then
                Call ns.Replace($"xmlns=""{root.xmlns}""", "")
            End If

            If Not String.IsNullOrEmpty(xmlns) Then  ' 当前的xmlns值不为空值 ，则设置xmlns
                Call __replace(ns, $"xmlns=""{xmlns}""")
            End If

            If usingDefault_xmlns Then
                Call __replace(ns, DefaultXmlns)
            End If

            Call xml.Replace(rs, ns.ToString)
        End Sub

        Private Shared Sub __replace(ByRef sb As StringBuilder, value$)
            Dim s$ = sb.ToString.TrimEnd(">"c).Trim
            s &= " " & value & ">"
            sb = New StringBuilder(s)
        End Sub
    End Class
End Namespace