X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=ovsdb%2Fovsdb-idlc.in;h=d70e5ebb618770a51a411b157f579129b309a053;hb=0b0544d706d10516d3122fbcce8f1dc1dec6cb92;hp=5a6d81c118c0f9d53cd1b45317d514aff4d02738;hpb=1264cb08bfcc5cd9372decb53d3e3a7d07cc3a2b;p=openvswitch

diff --git a/ovsdb/ovsdb-idlc.in b/ovsdb/ovsdb-idlc.in
index 5a6d81c1..d70e5ebb 100755
--- a/ovsdb/ovsdb-idlc.in
+++ b/ovsdb/ovsdb-idlc.in
@@ -43,8 +43,9 @@ class DbSchema:
         comment = getMember(json, 'comment', [unicode], 'database')
         tablesJson = mustGetMember(json, 'tables', [dict], 'database')
         tables = {}
-        for name, tableJson in tablesJson.iteritems():
-            tables[name] = TableSchema.fromJson(tableJson, "%s table" % name)
+        for tableName, tableJson in tablesJson.iteritems():
+            tables[tableName] = TableSchema.fromJson(tableJson,
+                                                     "%s table" % tableName)
         idlPrefix = mustGetMember(json, 'idlPrefix', [unicode], 'database')
         idlHeader = mustGetMember(json, 'idlHeader', [unicode], 'database')
         return DbSchema(name, comment, tables, idlPrefix, idlHeader)
@@ -141,6 +142,47 @@ class Type:
                 d["max"] = self.max
             return d
 
+    def isScalar(self):
+        return self.min == 1 and self.max == 1 and not self.value
+
+    def isOptional(self):
+        return self.min == 0 and self.max == 1
+
+    def toEnglish(self):
+        keyName = atomicTypeToEnglish(self.key, self.keyRefTable)
+        if self.value:
+            valueName = atomicTypeToEnglish(self.value, self.valueRefTable)
+
+        if self.isScalar():
+            return atomicTypeToEnglish(self.key, self.keyRefTable)
+        elif self.isOptional():
+            if self.value:
+                return "optional %s-%s pair" % (keyName, valueName)
+            else:
+                return "optional %s" % keyName
+        else:
+            if self.max == "unlimited":
+                if self.min:
+                    quantity = "%d or more " % self.min
+                else:
+                    quantity = ""
+            elif self.min:
+                quantity = "%d to %d " % (self.min, self.max)
+            else:
+                quantity = "up to %d " % self.max
+
+            if self.value:
+                return "map of %s%s-%s pairs" % (quantity, keyName, valueName)
+            else:
+                return "set of %s%s" % (quantity, keyName)
+                
+
+def atomicTypeToEnglish(base, refTable):
+    if base == 'uuid' and refTable:
+        return refTable
+    else:
+        return base
+
 def parseSchema(filename):
     file = open(filename, "r")
     s = ""
@@ -183,7 +225,15 @@ def cDeclComment(type):
     else:
         return ""
 
-def cMembers(prefix, columnName, column):
+def constify(cType, const):
+    if (const
+        and cType.endswith('*') and not cType.endswith('**')
+        and (cType.startswith('struct uuid') or cType.startswith('char'))):
+        return 'const %s' % cType
+    else:
+        return cType
+
+def cMembers(prefix, columnName, column, const):
     type = column.type
     if type.min == 1 and type.max == 1:
         singleton = True
@@ -197,16 +247,15 @@ def cMembers(prefix, columnName, column):
 
     if type.value:
         key = {'name': "key_%s" % columnName,
-               'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
+               'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const),
                'comment': ''}
         value = {'name': "value_%s" % columnName,
-                 'type': (cBaseType(prefix, type.value, type.valueRefTable)
-                          + pointer),
+                 'type': constify(cBaseType(prefix, type.value, type.valueRefTable) + pointer, const),
                  'comment': ''}
         members = [key, value]
     else:
         m = {'name': columnName,
-             'type': cBaseType(prefix, type.key, type.keyRefTable) + pointer,
+             'type': constify(cBaseType(prefix, type.key, type.keyRefTable) + pointer, const),
              'comment': cDeclComment(type)}
         members = [m]
 
@@ -237,7 +286,7 @@ def printCIDLHeader(schema):
         print "\tstruct ovsdb_idl_row header_;"
         for columnName, column in table.columns.iteritems():
             print "\n\t/* %s column. */" % columnName
-            for member in cMembers(prefix, columnName, column):
+            for member in cMembers(prefix, columnName, column, False):
                 print "\t%(type)s%(name)s;%(comment)s" % member
         print '''\
 };
@@ -258,7 +307,7 @@ struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
 
             print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
             args = ['%(type)s%(name)s' % member for member
-                    in cMembers(prefix, columnName, column)]
+                    in cMembers(prefix, columnName, column, True)]
             print '%s);' % ', '.join(args)
 
     print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
@@ -479,7 +528,7 @@ void
         for columnName, column in table.columns.iteritems():
             type = column.type
             print '\nvoid'
-            members = cMembers(prefix, columnName, column)
+            members = cMembers(prefix, columnName, column, True)
             keyVar = members[0]['name']
             nVar = None
             valueVar = None
@@ -605,6 +654,25 @@ def ovsdb_escape(string):
 def printOVSDBSchema(schema):
     json.dump(schema.toJson(), sys.stdout, sort_keys=True, indent=2)
 
+def printDoc(schema):
+    print schema.name
+    if schema.comment:
+        print schema.comment
+
+    for tableName, table in schema.tables.iteritems():
+        title = "%s table" % tableName
+        print
+        print title
+        print '-' * len(title)
+        if table.comment:
+            print table.comment
+
+        for columnName, column in table.columns.iteritems():
+            print
+            print "%s (%s)" % (columnName, column.type.toEnglish())
+            if column.comment:
+                print "\t%s" % column.comment
+
 def usage():
     print """\
 %(argv0)s: ovsdb schema compiler
@@ -616,6 +684,7 @@ One of the following actions must specified:
   c-idl-header                print C header file for IDL
   c-idl-source                print C source file for IDL implementation
   ovsdb-schema                print ovsdb parseable schema
+  doc                         print schema documentation
 
 The following options are also available:
   -h, --help                  display this help message
@@ -655,6 +724,8 @@ if __name__ == "__main__":
             printCIDLHeader(schema)
         elif action == 'c-idl-source':
             printCIDLSource(schema)
+        elif action == 'doc':
+            printDoc(schema)
         else:
             sys.stderr.write(
                 "%s: unknown action '%s' (use --help for help)\n" %