From e7185ca741dea2cb2e4aa2d9b6064931776405de Mon Sep 17 00:00:00 2001
From: Andreas Neiser <neiser@kph.uni-mainz.de>
Date: Fri, 28 Jun 2013 14:41:13 +0200
Subject: [PATCH] Added comments to schema, fixed its indentation, xml-db.pl
 checks now validity

---
 xml-db/database/TrbNet.xsd  | 356 ++++++++++++++++++------------------
 xml-db/database/testing.xml |   4 +-
 xml-db/xml-db.pl            |   6 +-
 3 files changed, 190 insertions(+), 176 deletions(-)

diff --git a/xml-db/database/TrbNet.xsd b/xml-db/database/TrbNet.xsd
index 6c95a82..d634573 100644
--- a/xml-db/database/TrbNet.xsd
+++ b/xml-db/database/TrbNet.xsd
@@ -1,184 +1,194 @@
 <?xml version="1.0" encoding="utf-8" ?>
 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
 
-<!--==============================
-    Type Definitions
-==============================-->
-<xs:simpleType name="nametype">
-  <xs:restriction base="xs:string">
-    <xs:pattern value="[0-9a-zA-Z_]+"/>
-  </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="addresstype">
-  <xs:restriction base="xs:string">
-    <xs:pattern value="[0-9a-fA-F]{4}"/>
-  </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="valuetype">
-  <xs:restriction base="xs:string">
-    <xs:pattern value="[0-9a-fA-F]+"/>
-  </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="modetype">
-  <xs:restriction base="xs:string">
-    <xs:pattern value="[rwb]+"/>
-    <!-- (r)ead and /or (w)rite, plus maybe (b)lock, if a no-more-data from this registers transports some vital information-->
-  </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="functiontype">
- <xs:restriction base="xs:string">
+  <!--==============================
+      Type Definitions
+      ==============================-->
+  <xs:simpleType name="nametype">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[0-9a-zA-Z_]+"/>
+    </xs:restriction>
+  </xs:simpleType> 
+
+  <xs:simpleType name="addresstype">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[0-9a-fA-F]{4}"/>
+    </xs:restriction>
+  </xs:simpleType> 
+
+  <xs:simpleType name="valuetype">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="[0-9a-fA-F]+"/>
+    </xs:restriction>
+  </xs:simpleType> 
+
+  <xs:simpleType name="modetype">
+    <xs:restriction base="xs:string">
+      <xs:pattern value="r|w|rw|b"/>
+      <!-- (r)ead and /or (w)rite, plus maybe (b)lock, if a no-more-data from this registers transports some vital information-->
+    </xs:restriction>
+  </xs:simpleType> 
+
+  <xs:simpleType name="functiontype">
+    <!-- config: setup some behaviour
+         trigger: register which starts some kind of operation of the hardware
+         status: slowly changing information
+         statistics: quickly changing information
+  
+         Note: The difference between "status" and "statistics" is not sharp,
+         they both give some information about the system. Usually, statistics
+         is updated every event (e.g. number of read-out triggers received),
+         whereas status contains more "constant" stuff (e.g. temperature)   
+    -->
+    <xs:restriction base="xs:string">
       <xs:enumeration value="config"/>
       <xs:enumeration value="trigger"/>
       <xs:enumeration value="status"/>
       <xs:enumeration value="statistics"/>
     </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="bittype">
-  <xs:restriction base="xs:integer">
-    <xs:minInclusive value="0"/>
-    <xs:maxInclusive value="31"/>
-  </xs:restriction>
-</xs:simpleType> 
-
-<xs:simpleType name="formattype">
- <xs:restriction base="xs:string">
-    <xs:enumeration value="raw"/>
-    <xs:enumeration value="integer"/>
-    <xs:enumeration value="signed"/>
-    <xs:enumeration value="unsigned"/>
-    <xs:enumeration value="hex"/>
-    <xs:enumeration value="bitmask"/>
-    <xs:enumeration value="boolean"/>
-    <xs:enumeration value="time"/>
-    <xs:enumeration value="string"/>
-  </xs:restriction>
-</xs:simpleType> 
-
-
-<!--==============================
-    Attribute Definition
-==============================-->
-<xs:attribute name="name"         type="nametype" />
-<xs:attribute name="address"      type="addresstype" />
-<xs:attribute name="offset"       type="addresstype" />
-<xs:attribute name="mode"         type="modetype"  />
-<xs:attribute name="type"         type="functiontype" />
-<xs:attribute name="function"     type="functiontype" />
-<xs:attribute name="start"        type="bittype" />
-<xs:attribute name="size"         type="xs:positiveInteger" />
-<xs:attribute name="defaultValue" type="valuetype" />
-<xs:attribute name="value"        type="valuetype" />
-<xs:attribute name="format"       type="formattype" />
-<xs:attribute name="continuous"   type="xs:boolean" />
-<xs:attribute name="repeat"       type="xs:positiveInteger" default="1" />
-
-
-<!--==============================
-    Simple Elements
-==============================-->
-<xs:element name="description" type="xs:string" />
-
-<!--==============================
-    Complex Elements
-==============================-->
-<xs:element name="TrbNet">
-  <xs:complexType>
-    <xs:choice maxOccurs="unbounded">
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-      <xs:element   ref="group"       maxOccurs="unbounded" />
-      <xs:element   ref="register"    maxOccurs="unbounded" />
-      <xs:element   ref="memory"      maxOccurs="unbounded" />
-      <xs:element   ref="fifo"        maxOccurs="unbounded" />
-    </xs:choice>
-    <xs:attribute ref="name" />
-    <xs:attribute ref="address" />
-  </xs:complexType>
-</xs:element>
-
-<xs:element name="group">
-  <xs:complexType>
-    <xs:choice maxOccurs="unbounded">
-      <xs:element   ref="group"       maxOccurs="unbounded" />
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-      <xs:element   ref="register"    maxOccurs="unbounded" />
-      <xs:element   ref="memory"      maxOccurs="unbounded" />
-      <xs:element   ref="fifo"        maxOccurs="unbounded" />
-    </xs:choice>
-    <xs:attribute ref="name" use="required" />
-    <xs:attribute ref="address" />
-    <xs:attribute ref="size" />
-    <xs:attribute ref="function" />
-    <xs:attribute ref="continuous" />
-    <xs:attribute ref="mode" />
-    <xs:attribute ref="format" />
-    <xs:attribute ref="repeat" />
-  </xs:complexType>
-</xs:element> 
-
-
-<xs:element name="field">
-  <xs:complexType>
-    <xs:all>
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-    </xs:all>
-    <xs:attribute ref="name" />
-    <xs:attribute ref="start" />
-    <xs:attribute ref="size" />
-    <xs:attribute ref="type" />
-    <xs:attribute ref="mode" />
-    <xs:attribute ref="defaultValue" />
-    <xs:attribute ref="format" />
-    <xs:attribute ref="repeat" />
-  </xs:complexType>
-</xs:element> 
-
-
-<xs:element name="register">
-  <xs:complexType>
-    <xs:choice maxOccurs="unbounded">
-      <xs:element   ref="field" />
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-    </xs:choice>
-    <xs:attribute ref="name" />
-    <xs:attribute ref="address" />
-    <xs:attribute ref="mode" />
-    <xs:attribute ref="function" />
-    <xs:attribute ref="repeat" />
-  </xs:complexType>
-</xs:element> 
-
-<xs:element name="memory">
-  <xs:complexType>
-    <xs:choice maxOccurs="unbounded">
-      <xs:element   ref="field" />
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-    </xs:choice>
-    <xs:attribute ref="name" />
-    <xs:attribute ref="address" />
-    <xs:attribute ref="size" />
-    <xs:attribute ref="mode" />
-    <xs:attribute ref="function" />
-  </xs:complexType>
-</xs:element> 
-
-<xs:element name="fifo">
-  <xs:complexType>
-    <xs:choice maxOccurs="unbounded">
-      <xs:element   ref="field" />
-      <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
-    </xs:choice>
-    <xs:attribute ref="name" />
-    <xs:attribute ref="address" />
-    <xs:attribute ref="mode" />
-    <xs:attribute ref="function" />
-  </xs:complexType>
-</xs:element> 
+  </xs:simpleType> 
+
+  <xs:simpleType name="bittype">
+    <xs:restriction base="xs:integer">
+      <xs:minInclusive value="0"/>
+      <xs:maxInclusive value="31"/>
+    </xs:restriction>
+  </xs:simpleType> 
+
+  <xs:simpleType name="formattype">
+    <xs:restriction base="xs:string">
+      <xs:enumeration value="raw"/>
+      <xs:enumeration value="integer"/>
+      <xs:enumeration value="signed"/>
+      <xs:enumeration value="unsigned"/>
+      <xs:enumeration value="hex"/>
+      <xs:enumeration value="bitmask"/>
+      <xs:enumeration value="boolean"/>
+      <xs:enumeration value="time"/>
+      <xs:enumeration value="string"/>
+    </xs:restriction>
+  </xs:simpleType> 
+
+
+  <!--==============================
+      Attribute Definition
+      ==============================-->
+  <xs:attribute name="name"         type="nametype" />
+  <xs:attribute name="address"      type="addresstype" />
+  <xs:attribute name="offset"       type="addresstype" />
+  <xs:attribute name="mode"         type="modetype"  />
+  <xs:attribute name="type"         type="functiontype" />
+  <xs:attribute name="function"     type="functiontype" />
+  <xs:attribute name="start"        type="bittype" />
+  <xs:attribute name="size"         type="xs:positiveInteger" />
+  <xs:attribute name="defaultValue" type="valuetype" />
+  <xs:attribute name="value"        type="valuetype" />
+  <xs:attribute name="format"       type="formattype" />
+  <xs:attribute name="continuous"   type="xs:boolean" />
+  <xs:attribute name="repeat"       type="xs:positiveInteger" default="1" />
+
+
+  <!--==============================
+      Simple Elements
+      ==============================-->
+  <xs:element name="description" type="xs:string" />
+
+  <!--==============================
+      Complex Elements
+      ==============================-->
+  <xs:element name="TrbNet">
+    <xs:complexType>
+      <xs:choice maxOccurs="unbounded">
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+        <xs:element   ref="group"       maxOccurs="unbounded" />
+        <xs:element   ref="register"    maxOccurs="unbounded" />
+        <xs:element   ref="memory"      maxOccurs="unbounded" />
+        <xs:element   ref="fifo"        maxOccurs="unbounded" />
+      </xs:choice>
+      <xs:attribute ref="name" />
+      <xs:attribute ref="address" />
+    </xs:complexType>
+  </xs:element>
+
+  <xs:element name="group">
+    <xs:complexType>
+      <xs:choice maxOccurs="unbounded">
+        <xs:element   ref="group"       maxOccurs="unbounded" />
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+        <xs:element   ref="register"    maxOccurs="unbounded" />
+        <xs:element   ref="memory"      maxOccurs="unbounded" />
+        <xs:element   ref="fifo"        maxOccurs="unbounded" />
+      </xs:choice>
+      <xs:attribute ref="name" use="required" />
+      <xs:attribute ref="address" />
+      <xs:attribute ref="size" />
+      <xs:attribute ref="function" />
+      <xs:attribute ref="continuous" />
+      <xs:attribute ref="mode" />
+      <xs:attribute ref="format" />
+      <xs:attribute ref="repeat" />
+    </xs:complexType>
+  </xs:element> 
+
+
+  <xs:element name="field">
+    <xs:complexType>
+      <xs:all>
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+      </xs:all>
+      <xs:attribute ref="name" />
+      <xs:attribute ref="start" />
+      <xs:attribute ref="size" />
+      <xs:attribute ref="type" />
+      <xs:attribute ref="mode" />
+      <xs:attribute ref="defaultValue" />
+      <xs:attribute ref="format" />
+      <xs:attribute ref="repeat" />
+    </xs:complexType>
+  </xs:element> 
+
+
+  <xs:element name="register">
+    <xs:complexType>
+      <xs:choice maxOccurs="unbounded">
+        <xs:element   ref="field" />
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+      </xs:choice>
+      <xs:attribute ref="name" />
+      <xs:attribute ref="address" />
+      <xs:attribute ref="mode" />
+      <xs:attribute ref="function" />
+      <xs:attribute ref="repeat" />
+    </xs:complexType>
+  </xs:element> 
+
+  <xs:element name="memory">
+    <xs:complexType>
+      <xs:choice maxOccurs="unbounded">
+        <xs:element   ref="field" />
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+      </xs:choice>
+      <xs:attribute ref="name" />
+      <xs:attribute ref="address" />
+      <xs:attribute ref="size" />
+      <xs:attribute ref="mode" />
+      <xs:attribute ref="function" />
+    </xs:complexType>
+  </xs:element> 
+
+  <xs:element name="fifo">
+    <xs:complexType>
+      <xs:choice maxOccurs="unbounded">
+        <xs:element   ref="field" />
+        <xs:element   ref="description" minOccurs="1" maxOccurs="1" />
+      </xs:choice>
+      <xs:attribute ref="name" />
+      <xs:attribute ref="address" />
+      <xs:attribute ref="mode" />
+      <xs:attribute ref="function" />
+    </xs:complexType>
+  </xs:element> 
 
 
 </xs:schema> 
-  
+
diff --git a/xml-db/database/testing.xml b/xml-db/database/testing.xml
index 2619fb8..183bf34 100644
--- a/xml-db/database/testing.xml
+++ b/xml-db/database/testing.xml
@@ -2,7 +2,7 @@
 <TrbNet xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="TrbNet.xsd"
         name="JtagController"
-        offset="1000"
+        address="1000"
         >
   <group
       name="JtagCommonControl"
@@ -15,7 +15,7 @@
     <register
         name="WaitBeforeStart"
         address="0007"
-        mode="rw"
+        mode="rww"
         function ="config"
         >
       <description>Wait time between write sequence and start signal.</description>
diff --git a/xml-db/xml-db.pl b/xml-db/xml-db.pl
index abc6cb3..eb10576 100755
--- a/xml-db/xml-db.pl
+++ b/xml-db/xml-db.pl
@@ -27,10 +27,14 @@ pod2usage(-exitval => 0, -verbose => 2) if $man;
 print "Database: $db_dir\n" if $verbose;
 
 my $doc = XML::LibXML->new->parse_file("$db_dir/testing.xml");
-my $xmlschema = XML::LibXML::Schema->new( location => "$db_dir/TrbNet.xsd" );
+my $xmlschema = XML::LibXML::Schema->new('location' => "$db_dir/".
+                                         $doc->getDocumentElement->getAttribute('xsi:noNamespaceSchemaLocation'));
 
 $xmlschema->validate($doc);
 
+#print $xsd;
+
+
 __END__
 
 =head1 NAME
-- 
2.43.0