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)
type = Type.fromJson(mustGetMember(json, 'type', [dict, unicode],
description),
'type of %s' % description)
- ephemeral = getMember(json, 'ephemeral', [True,False], description)
+ ephemeral = getMember(json, 'ephemeral', [bool], description)
persistent = ephemeral != True
return ColumnSchema(comment, type, persistent)
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 = ""
'boolean': 'bool ',
'string': 'char *'}[type]
-def cCopyType(dst, src, type, refTable=None):
+def cCopyType(indent, dstVar, dst, src, type, refTable=None):
+ args = {'indent': indent,
+ 'dstVar': dstVar,
+ 'dst': dst,
+ 'src': src}
if type == 'uuid' and refTable:
- return "%s = %s->header_.uuid;" % (dst, src)
+ return ("%(indent)s%(dstVar)s = %(src)s;\n" +
+ "%(indent)s%(dst)s = %(src)s->header_.uuid;") % args
elif type == 'string':
- return "%s = xstrdup(%s);" % (dst, src)
+ return "%(indent)s%(dstVar)s = %(dst)s = xstrdup(%(src)s);" % args
else:
- return "%s = %s;" % (dst, src)
+ return "%(dstVar)s = %(dst)s = %(src)s;" % args
def typeIsOptionalPointer(type):
return (type.min == 0 and type.max == 1 and not type.value
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
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]
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 '''\
};
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
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
print
print " datum.n = 1;"
print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+ print cCopyType(" ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
if type.value:
print " datum.values = xmalloc(sizeof *datum.values);"
- print " %s" % cCopyType("datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable)
+ print cCopyType(" ", "row->%s" % valueVar, "datum.values[0].%s" % type.value, valueVar, type.value, type.valueRefTable)
else:
print " datum.values = NULL;"
elif typeIsOptionalPointer(type):
print " if (%s) {" % keyVar
print " datum.n = 1;"
print " datum.keys = xmalloc(sizeof *datum.keys);"
- print " %s" % cCopyType("datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
+ print cCopyType(" ", "row->%s" % keyVar, "datum.keys[0].%s" % type.key, keyVar, type.key, type.keyRefTable)
print " } else {"
print " datum.n = 0;"
print " datum.keys = NULL;"
+ print " row->%s = NULL;" % keyVar
print " }"
print " datum.values = NULL;"
else:
print " size_t i;"
print
+ print " free(row->%s);" % keyVar
+ print " row->%s = %s ? xmalloc(%s * sizeof *row->%s) : NULL;" % (keyVar, nVar, nVar, keyVar)
+ print " row->%s = %s;" % (nVar, nVar)
+ if type.value:
+ print " free(row->%s);" % valueVar
+ print " row->%s = xmalloc(%s * sizeof *row->%s);" % (valueVar, nVar, valueVar)
print " datum.n = %s;" % nVar
print " datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
if type.value:
else:
print " datum.values = NULL;"
print " for (i = 0; i < %s; i++) {" % nVar
- print " %s" % cCopyType("datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable)
+ print cCopyType(" ", "row->%s[i]" % keyVar, "datum.keys[i].%s" % type.key, "%s[i]" % keyVar, type.key, type.keyRefTable)
if type.value:
- print " %s" % cCopyType("datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable)
+ print cCopyType(" ", "row->%s[i]" % valueVar, "datum.values[i].%s" % type.value, "%s[i]" % valueVar, type.value, type.valueRefTable)
print " }"
print " ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
% {'s': structName,
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
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
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" %
projects / openvswitch / blobdiff