pintos-os.org Git - openvswitch/blob - ovsdb/ovsdb-idlc.in

   1 #! @PYTHON@
   2
   3 import getopt
   4 import os
   5 import re
   6 import sys
   7
   8 import ovs.json
   9 import ovs.db.error
  10 import ovs.db.schema
  11
  12 argv0 = sys.argv[0]
  13
  14 def parseSchema(filename):
  15     return ovs.db.schema.IdlSchema.from_json(ovs.json.from_file(filename))
  16
  17 def annotateSchema(schemaFile, annotationFile):
  18     schemaJson = ovs.json.from_file(schemaFile)
  19     execfile(annotationFile, globals(), {"s": schemaJson})
  20     ovs.json.to_stream(schemaJson, sys.stdout)
  21
  22 def constify(cType, const):
  23     if (const and cType.endswith('*') and not cType.endswith('**')):
  24         return 'const %s' % cType
  25     else:
  26         return cType
  27
  28 def cMembers(prefix, columnName, column, const):
  29     type = column.type
  30     if is_optional_bool(type):
  31         const = True
  32     if type.n_min == 1 and type.n_max == 1:
  33         singleton = True
  34         pointer = ''
  35     else:
  36         singleton = False
  37         if type.is_optional_pointer():
  38             pointer = ''
  39         else:
  40             pointer = '*'
  41
  42     if type.value:
  43         key = {'name': "key_%s" % columnName,
  44                'type': constify(type.key.toCType(prefix) + pointer, const),
  45                'comment': ''}
  46         value = {'name': "value_%s" % columnName,
  47                  'type': constify(type.value.toCType(prefix) + pointer, const),
  48                  'comment': ''}
  49         members = [key, value]
  50     else:
  51         m = {'name': columnName,
  52              'type': constify(type.key.toCType(prefix) + pointer, const),
  53              'comment': type.cDeclComment()}
  54         members = [m]
  55
  56     if not singleton and not type.is_optional_pointer():
  57         members.append({'name': 'n_%s' % columnName,
  58                         'type': 'size_t ',
  59                         'comment': ''})
  60     return members
  61
  62 def printCIDLHeader(schemaFile):
  63     schema = parseSchema(schemaFile)
  64     prefix = schema.idlPrefix
  65     print '''\
  66 /* Generated automatically -- do not modify!    -*- buffer-read-only: t -*- */
  67
  68 #ifndef %(prefix)sIDL_HEADER
  69 #define %(prefix)sIDL_HEADER 1
  70
  71 #include <stdbool.h>
  72 #include <stddef.h>
  73 #include <stdint.h>
  74 #include "ovsdb-data.h"
  75 #include "ovsdb-idl-provider.h"
  76 #include "uuid.h"''' % {'prefix': prefix.upper()}
  77
  78     for tableName, table in sorted(schema.tables.iteritems()):
  79         structName = "%s%s" % (prefix, tableName.lower())
  80
  81         print "\f"
  82         print "/* %s table. */" % tableName
  83         print "struct %s {" % structName
  84         print "\tstruct ovsdb_idl_row header_;"
  85         for columnName, column in sorted(table.columns.iteritems()):
  86             print "\n\t/* %s column. */" % columnName
  87             for member in cMembers(prefix, columnName, column, False):
  88                 print "\t%(type)s%(name)s;%(comment)s" % member
  89         print "};"
  90
  91         # Column indexes.
  92         printEnum(["%s_COL_%s" % (structName.upper(), columnName.upper())
  93                    for columnName in sorted(table.columns)]
  94                   + ["%s_N_COLUMNS" % structName.upper()])
  95
  96         print
  97         for columnName in table.columns:
  98             print "#define %(s)s_col_%(c)s (%(s)s_columns[%(S)s_COL_%(C)s])" % {
  99                 's': structName,
 100                 'S': structName.upper(),
 101                 'c': columnName,
 102                 'C': columnName.upper()}
 103
 104         print "\nextern struct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (structName, structName.upper())
 105
 106         print '''
 107 const struct %(s)s *%(s)s_first(const struct ovsdb_idl *);
 108 const struct %(s)s *%(s)s_next(const struct %(s)s *);
 109 #define %(S)s_FOR_EACH(ROW, IDL) \\
 110         for ((ROW) = %(s)s_first(IDL); \\
 111              (ROW); \\
 112              (ROW) = %(s)s_next(ROW))
 113 #define %(S)s_FOR_EACH_SAFE(ROW, NEXT, IDL) \\
 114         for ((ROW) = %(s)s_first(IDL); \\
 115              (ROW) ? ((NEXT) = %(s)s_next(ROW), 1) : 0; \\
 116              (ROW) = (NEXT))
 117
 118 void %(s)s_delete(const struct %(s)s *);
 119 struct %(s)s *%(s)s_insert(struct ovsdb_idl_txn *);
 120 ''' % {'s': structName, 'S': structName.upper()}
 121
 122         for columnName, column in sorted(table.columns.iteritems()):
 123             print 'void %(s)s_verify_%(c)s(const struct %(s)s *);' % {'s': structName, 'c': columnName}
 124
 125         print """
 126 /* Functions for fetching columns as \"struct ovsdb_datum\"s.  (This is
 127    rarely useful.  More often, it is easier to access columns by using
 128    the members of %(s)s directly.) */""" % {'s': structName}
 129         for columnName, column in sorted(table.columns.iteritems()):
 130             if column.type.value:
 131                 valueParam = ', enum ovsdb_atomic_type value_type'
 132             else:
 133                 valueParam = ''
 134             print 'const struct ovsdb_datum *%(s)s_get_%(c)s(const struct %(s)s *, enum ovsdb_atomic_type key_type%(v)s);' % {
 135                 's': structName, 'c': columnName, 'v': valueParam}
 136
 137         print
 138         for columnName, column in sorted(table.columns.iteritems()):
 139
 140             print 'void %(s)s_set_%(c)s(const struct %(s)s *,' % {'s': structName, 'c': columnName},
 141             args = ['%(type)s%(name)s' % member for member
 142                     in cMembers(prefix, columnName, column, True)]
 143             print '%s);' % ', '.join(args)
 144
 145     # Table indexes.
 146     printEnum(["%sTABLE_%s" % (prefix.upper(), tableName.upper()) for tableName in sorted(schema.tables)] + ["%sN_TABLES" % prefix.upper()])
 147     print
 148     for tableName in schema.tables:
 149         print "#define %(p)stable_%(t)s (%(p)stable_classes[%(P)sTABLE_%(T)s])" % {
 150             'p': prefix,
 151             'P': prefix.upper(),
 152             't': tableName.lower(),
 153             'T': tableName.upper()}
 154     print "\nextern struct ovsdb_idl_table_class %stable_classes[%sN_TABLES];" % (prefix, prefix.upper())
 155
 156     print "\nextern struct ovsdb_idl_class %sidl_class;" % prefix
 157     print "\nvoid %sinit(void);" % prefix
 158     print "\n#endif /* %(prefix)sIDL_HEADER */" % {'prefix': prefix.upper()}
 159
 160 def printEnum(members):
 161     if len(members) == 0:
 162         return
 163
 164     print "\nenum {";
 165     for member in members[:-1]:
 166         print "    %s," % member
 167     print "    %s" % members[-1]
 168     print "};"
 169
 170 def is_optional_bool(type):
 171     return (type.key.type == ovs.db.types.BooleanType and not type.value
 172             and type.n_min == 0 and type.n_max == 1)
 173
 174 def printCIDLSource(schemaFile):
 175     schema = parseSchema(schemaFile)
 176     prefix = schema.idlPrefix
 177     print '''\
 178 /* Generated automatically -- do not modify!    -*- buffer-read-only: t -*- */
 179
 180 #include <config.h>
 181 #include %s
 182 #include <assert.h>
 183 #include <limits.h>
 184 #include "ovsdb-data.h"
 185 #include "ovsdb-error.h"
 186
 187 static bool inited;
 188 ''' % schema.idlHeader
 189
 190     # Cast functions.
 191     for tableName, table in sorted(schema.tables.iteritems()):
 192         structName = "%s%s" % (prefix, tableName.lower())
 193         print '''
 194 static struct %(s)s *
 195 %(s)s_cast(const struct ovsdb_idl_row *row)
 196 {
 197     return row ? CONTAINER_OF(row, struct %(s)s, header_) : NULL;
 198 }\
 199 ''' % {'s': structName}
 200
 201
 202     for tableName, table in sorted(schema.tables.iteritems()):
 203         structName = "%s%s" % (prefix, tableName.lower())
 204         print "\f"
 205         print "/* %s table. */" % (tableName)
 206
 207         # Parse functions.
 208         for columnName, column in sorted(table.columns.iteritems()):
 209             print '''
 210 static void
 211 %(s)s_parse_%(c)s(struct ovsdb_idl_row *row_, const struct ovsdb_datum *datum)
 212 {
 213     struct %(s)s *row = %(s)s_cast(row_);''' % {'s': structName,
 214                                                 'c': columnName}
 215
 216             type = column.type
 217             if type.value:
 218                 keyVar = "row->key_%s" % columnName
 219                 valueVar = "row->value_%s" % columnName
 220             else:
 221                 keyVar = "row->%s" % columnName
 222                 valueVar = None
 223
 224             if is_optional_bool(type):
 225                 # Special case for an optional bool.  This is only here because
 226                 # sparse does not like the "normal" case below ("warning:
 227                 # expression using sizeof bool").
 228                 print
 229                 print "    assert(inited);"
 230                 print "    if (datum->n >= 1) {"
 231                 print "        static const bool false_value = false;"
 232                 print "        static const bool true_value = true;"
 233                 print
 234                 print "        row->n_%s = 1;" % columnName
 235                 print "        %s = datum->keys[0].boolean ? &true_value : &false_value;" % keyVar
 236                 print "    } else {"
 237                 print "        row->n_%s = 0;" % columnName
 238                 print "        %s = NULL;" % keyVar
 239                 print "    }"
 240             elif (type.n_min == 1 and type.n_max == 1) or type.is_optional_pointer():
 241                 print
 242                 print "    assert(inited);"
 243                 print "    if (datum->n >= 1) {"
 244                 if not type.key.ref_table:
 245                     print "        %s = datum->keys[0].%s;" % (keyVar, type.key.type.to_string())
 246                 else:
 247                     print "        %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[0].uuid));" % (keyVar, prefix, type.key.ref_table.lower(), prefix, prefix.upper(), type.key.ref_table.upper())
 248
 249                 if valueVar:
 250                     if type.value.ref_table:
 251                         print "        %s = datum->values[0].%s;" % (valueVar, type.value.type.to_string())
 252                     else:
 253                         print "        %s = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[0].uuid));" % (valueVar, prefix, type.value.ref_table.lower(), prefix, prefix.upper(), type.value.ref_table.upper())
 254                 print "    } else {"
 255                 print "        %s" % type.key.initCDefault(keyVar, type.n_min == 0)
 256                 if valueVar:
 257                     print "        %s" % type.value.initCDefault(valueVar, type.n_min == 0)
 258                 print "    }"
 259             else:
 260                 if type.n_max != sys.maxint:
 261                     print "    size_t n = MIN(%d, datum->n);" % type.n_max
 262                     nMax = "n"
 263                 else:
 264                     nMax = "datum->n"
 265                 print "    size_t i;"
 266                 print
 267                 print "    assert(inited);"
 268                 print "    %s = NULL;" % keyVar
 269                 if valueVar:
 270                     print "    %s = NULL;" % valueVar
 271                 print "    row->n_%s = 0;" % columnName
 272                 print "    for (i = 0; i < %s; i++) {" % nMax
 273                 refs = []
 274                 if type.key.ref_table:
 275                     print "        struct %s%s *keyRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->keys[i].uuid));" % (prefix, type.key.ref_table.lower(), prefix, type.key.ref_table.lower(), prefix, prefix.upper(), type.key.ref_table.upper())
 276                     keySrc = "keyRow"
 277                     refs.append('keyRow')
 278                 else:
 279                     keySrc = "datum->keys[i].%s" % type.key.type.to_string()
 280                 if type.value and type.value.ref_table:
 281                     print "        struct %s%s *valueRow = %s%s_cast(ovsdb_idl_get_row_arc(row_, &%stable_classes[%sTABLE_%s], &datum->values[i].uuid));" % (prefix, type.value.ref_table.lower(), prefix, type.value.ref_table.lower(), prefix, prefix.upper(), type.value.ref_table.upper())
 282                     valueSrc = "valueRow"
 283                     refs.append('valueRow')
 284                 elif valueVar:
 285                     valueSrc = "datum->values[i].%s" % type.value.type.to_string()
 286                 if refs:
 287                     print "        if (%s) {" % ' && '.join(refs)
 288                     indent = "            "
 289                 else:
 290                     indent = "        "
 291                 print "%sif (!row->n_%s) {" % (indent, columnName)
 292                 print "%s    %s = xmalloc(%s * sizeof *%s);" % (indent, keyVar, nMax, keyVar)
 293                 if valueVar:
 294                     print "%s    %s = xmalloc(%s * sizeof *%s);" % (indent, valueVar, nMax, valueVar)
 295                 print "%s}" % indent
 296                 print "%s%s[row->n_%s] = %s;" % (indent, keyVar, columnName, keySrc)
 297                 if valueVar:
 298                     print "%s%s[row->n_%s] = %s;" % (indent, valueVar, columnName, valueSrc)
 299                 print "%srow->n_%s++;" % (indent, columnName)
 300                 if refs:
 301                     print "        }"
 302                 print "    }"
 303             print "}"
 304
 305         # Unparse functions.
 306         for columnName, column in sorted(table.columns.iteritems()):
 307             type = column.type
 308             if (type.key.type == ovs.db.types.BooleanType and not type.value
 309                 and type.n_min == 0 and type.n_max == 1):
 310                 print '''
 311 static void
 312 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
 313 {
 314     /* Nothing to do. */
 315 }''' % {'s': structName, 'c': columnName}
 316             elif (type.n_min != 1 or type.n_max != 1) and not type.is_optional_pointer():
 317                 print '''
 318 static void
 319 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row_)
 320 {
 321     struct %(s)s *row = %(s)s_cast(row_);
 322
 323     assert(inited);''' % {'s': structName, 'c': columnName}
 324                 if type.value:
 325                     keyVar = "row->key_%s" % columnName
 326                     valueVar = "row->value_%s" % columnName
 327                 else:
 328                     keyVar = "row->%s" % columnName
 329                     valueVar = None
 330                 print "    free(%s);" % keyVar
 331                 if valueVar:
 332                     print "    free(%s);" % valueVar
 333                 print '}'
 334             else:
 335                 print '''
 336 static void
 337 %(s)s_unparse_%(c)s(struct ovsdb_idl_row *row OVS_UNUSED)
 338 {
 339     /* Nothing to do. */
 340 }''' % {'s': structName, 'c': columnName}
 341
 342         # First, next functions.
 343         print '''
 344 const struct %(s)s *
 345 %(s)s_first(const struct ovsdb_idl *idl)
 346 {
 347     return %(s)s_cast(ovsdb_idl_first_row(idl, &%(p)stable_classes[%(P)sTABLE_%(T)s]));
 348 }
 349
 350 const struct %(s)s *
 351 %(s)s_next(const struct %(s)s *row)
 352 {
 353     return %(s)s_cast(ovsdb_idl_next_row(&row->header_));
 354 }''' % {'s': structName,
 355         'p': prefix,
 356         'P': prefix.upper(),
 357         'T': tableName.upper()}
 358
 359         print '''
 360 void
 361 %(s)s_delete(const struct %(s)s *row)
 362 {
 363     ovsdb_idl_txn_delete(&row->header_);
 364 }
 365
 366 struct %(s)s *
 367 %(s)s_insert(struct ovsdb_idl_txn *txn)
 368 {
 369     return %(s)s_cast(ovsdb_idl_txn_insert(txn, &%(p)stable_classes[%(P)sTABLE_%(T)s], NULL));
 370 }
 371 ''' % {'s': structName,
 372        'p': prefix,
 373        'P': prefix.upper(),
 374        'T': tableName.upper()}
 375
 376         # Verify functions.
 377         for columnName, column in sorted(table.columns.iteritems()):
 378             print '''
 379 void
 380 %(s)s_verify_%(c)s(const struct %(s)s *row)
 381 {
 382     assert(inited);
 383     ovsdb_idl_txn_verify(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s]);
 384 }''' % {'s': structName,
 385         'S': structName.upper(),
 386         'c': columnName,
 387         'C': columnName.upper()}
 388
 389         # Get functions.
 390         for columnName, column in sorted(table.columns.iteritems()):
 391             if column.type.value:
 392                 valueParam = ',\n\tenum ovsdb_atomic_type value_type OVS_UNUSED'
 393                 valueType = '\n    assert(value_type == %s);' % column.type.value.toAtomicType()
 394                 valueComment = "\n * 'value_type' must be %s." % column.type.value.toAtomicType()
 395             else:
 396                 valueParam = ''
 397                 valueType = ''
 398                 valueComment = ''
 399             print """
 400 /* Returns the %(c)s column's value in 'row' as a struct ovsdb_datum.
 401  * This is useful occasionally: for example, ovsdb_datum_find_key() is an
 402  * easier and more efficient way to search for a given key than implementing
 403  * the same operation on the "cooked" form in 'row'.
 404  *
 405  * 'key_type' must be %(kt)s.%(vc)s
 406  * (This helps to avoid silent bugs if someone changes %(c)s's
 407  * type without updating the caller.)
 408  *
 409  * The caller must not modify or free the returned value.
 410  *
 411  * Various kinds of changes can invalidate the returned value: modifying
 412  * 'column' within 'row', deleting 'row', or completing an ongoing transaction.
 413  * If the returned value is needed for a long time, it is best to make a copy
 414  * of it with ovsdb_datum_clone(). */
 415 const struct ovsdb_datum *
 416 %(s)s_get_%(c)s(const struct %(s)s *row,
 417 \tenum ovsdb_atomic_type key_type OVS_UNUSED%(v)s)
 418 {
 419     assert(key_type == %(kt)s);%(vt)s
 420     return ovsdb_idl_read(&row->header_, &%(s)s_col_%(c)s);
 421 }""" % {'s': structName, 'c': columnName,
 422        'kt': column.type.key.toAtomicType(),
 423        'v': valueParam, 'vt': valueType, 'vc': valueComment}
 424
 425         # Set functions.
 426         for columnName, column in sorted(table.columns.iteritems()):
 427             type = column.type
 428             print '\nvoid'
 429             members = cMembers(prefix, columnName, column, True)
 430             keyVar = members[0]['name']
 431             nVar = None
 432             valueVar = None
 433             if type.value:
 434                 valueVar = members[1]['name']
 435                 if len(members) > 2:
 436                     nVar = members[2]['name']
 437             else:
 438                 if len(members) > 1:
 439                     nVar = members[1]['name']
 440             print '%(s)s_set_%(c)s(const struct %(s)s *row, %(args)s)' % \
 441                 {'s': structName, 'c': columnName,
 442                  'args': ', '.join(['%(type)s%(name)s' % m for m in members])}
 443             print "{"
 444             print "    struct ovsdb_datum datum;"
 445             if type.n_min == 1 and type.n_max == 1:
 446                 print
 447                 print "    assert(inited);"
 448                 print "    datum.n = 1;"
 449                 print "    datum.keys = xmalloc(sizeof *datum.keys);"
 450                 print "    " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
 451                 if type.value:
 452                     print "    datum.values = xmalloc(sizeof *datum.values);"
 453                     print "    "+ type.value.copyCValue("datum.values[0].%s" % type.value.type.to_string(), valueVar)
 454                 else:
 455                     print "    datum.values = NULL;"
 456             elif type.is_optional_pointer():
 457                 print
 458                 print "    assert(inited);"
 459                 print "    if (%s) {" % keyVar
 460                 print "        datum.n = 1;"
 461                 print "        datum.keys = xmalloc(sizeof *datum.keys);"
 462                 print "        " + type.key.copyCValue("datum.keys[0].%s" % type.key.type.to_string(), keyVar)
 463                 print "    } else {"
 464                 print "        datum.n = 0;"
 465                 print "        datum.keys = NULL;"
 466                 print "    }"
 467                 print "    datum.values = NULL;"
 468             else:
 469                 print "    size_t i;"
 470                 print
 471                 print "    assert(inited);"
 472                 print "    datum.n = %s;" % nVar
 473                 print "    datum.keys = xmalloc(%s * sizeof *datum.keys);" % nVar
 474                 if type.value:
 475                     print "    datum.values = xmalloc(%s * sizeof *datum.values);" % nVar
 476                 else:
 477                     print "    datum.values = NULL;"
 478                 print "    for (i = 0; i < %s; i++) {" % nVar
 479                 print "        " + type.key.copyCValue("datum.keys[i].%s" % type.key.type.to_string(), "%s[i]" % keyVar)
 480                 if type.value:
 481                     print "        " + type.value.copyCValue("datum.values[i].%s" % type.value.type.to_string(), "%s[i]" % valueVar)
 482                 print "    }"
 483                 if type.value:
 484                     valueType = type.value.toAtomicType()
 485                 else:
 486                     valueType = "OVSDB_TYPE_VOID"
 487                 print "    ovsdb_datum_sort_unique(&datum, %s, %s);" % (
 488                     type.key.toAtomicType(), valueType)
 489             print "    ovsdb_idl_txn_write(&row->header_, &%(s)s_columns[%(S)s_COL_%(C)s], &datum);" \
 490                 % {'s': structName,
 491                    'S': structName.upper(),
 492                    'C': columnName.upper()}
 493             print "}"
 494
 495         # Table columns.
 496         print "\nstruct ovsdb_idl_column %s_columns[%s_N_COLUMNS];" % (
 497             structName, structName.upper())
 498         print """
 499 static void\n%s_columns_init(void)
 500 {
 501     struct ovsdb_idl_column *c;\
 502 """ % structName
 503         for columnName, column in sorted(table.columns.iteritems()):
 504             cs = "%s_col_%s" % (structName, columnName)
 505             d = {'cs': cs, 'c': columnName, 's': structName}
 506             print
 507             print "    /* Initialize %(cs)s. */" % d
 508             print "    c = &%(cs)s;" % d
 509             print "    c->name = \"%(c)s\";" % d
 510             print column.type.cInitType("    ", "c->type")
 511             print "    c->parse = %(s)s_parse_%(c)s;" % d
 512             print "    c->unparse = %(s)s_unparse_%(c)s;" % d
 513         print "}"
 514
 515     # Table classes.
 516     print "\f"
 517     print "struct ovsdb_idl_table_class %stable_classes[%sN_TABLES] = {" % (prefix, prefix.upper())
 518     for tableName, table in sorted(schema.tables.iteritems()):
 519         structName = "%s%s" % (prefix, tableName.lower())
 520         if table.is_root:
 521             is_root = "true"
 522         else:
 523             is_root = "false"
 524         print "    {\"%s\", %s," % (tableName, is_root)
 525         print "     %s_columns, ARRAY_SIZE(%s_columns)," % (
 526             structName, structName)
 527         print "     sizeof(struct %s)}," % structName
 528     print "};"
 529
 530     # IDL class.
 531     print "\nstruct ovsdb_idl_class %sidl_class = {" % prefix
 532     print "    \"%s\", %stable_classes, ARRAY_SIZE(%stable_classes)" % (
 533         schema.name, prefix, prefix)
 534     print "};"
 535
 536     # global init function
 537     print """
 538 void
 539 %sinit(void)
 540 {
 541     if (inited) {
 542         return;
 543     }
 544     inited = true;
 545 """ % prefix
 546     for tableName, table in sorted(schema.tables.iteritems()):
 547         structName = "%s%s" % (prefix, tableName.lower())
 548         print "    %s_columns_init();" % structName
 549     print "}"
 550
 551 def ovsdb_escape(string):
 552     def escape(match):
 553         c = match.group(0)
 554         if c == '\0':
 555             raise ovs.db.error.Error("strings may not contain null bytes")
 556         elif c == '\\':
 557             return '\\\\'
 558         elif c == '\n':
 559             return '\\n'
 560         elif c == '\r':
 561             return '\\r'
 562         elif c == '\t':
 563             return '\\t'
 564         elif c == '\b':
 565             return '\\b'
 566         elif c == '\a':
 567             return '\\a'
 568         else:
 569             return '\\x%02x' % ord(c)
 570     return re.sub(r'["\\\000-\037]', escape, string)
 571
 572
 573
 574 def usage():
 575     print """\
 576 %(argv0)s: ovsdb schema compiler
 577 usage: %(argv0)s [OPTIONS] COMMAND ARG...
 578
 579 The following commands are supported:
 580   annotate SCHEMA ANNOTATIONS print SCHEMA combined with ANNOTATIONS
 581   c-idl-header IDL            print C header file for IDL
 582   c-idl-source IDL            print C source file for IDL implementation
 583   nroff IDL                   print schema documentation in nroff format
 584
 585 The following options are also available:
 586   -h, --help                  display this help message
 587   -V, --version               display version information\
 588 """ % {'argv0': argv0}
 589     sys.exit(0)
 590
 591 if __name__ == "__main__":
 592     try:
 593         try:
 594             options, args = getopt.gnu_getopt(sys.argv[1:], 'C:hV',
 595                                               ['directory',
 596                                                'help',
 597                                                'version'])
 598         except getopt.GetoptError, geo:
 599             sys.stderr.write("%s: %s\n" % (argv0, geo.msg))
 600             sys.exit(1)
 601
 602         for key, value in options:
 603             if key in ['-h', '--help']:
 604                 usage()
 605             elif key in ['-V', '--version']:
 606                 print "ovsdb-idlc (Open vSwitch) @VERSION@"
 607             elif key in ['-C', '--directory']:
 608                 os.chdir(value)
 609             else:
 610                 sys.exit(0)
 611
 612         optKeys = [key for key, value in options]
 613
 614         if not args:
 615             sys.stderr.write("%s: missing command argument "
 616                              "(use --help for help)\n" % argv0)
 617             sys.exit(1)
 618
 619         commands = {"annotate": (annotateSchema, 2),
 620                     "c-idl-header": (printCIDLHeader, 1),
 621                     "c-idl-source": (printCIDLSource, 1)}
 622
 623         if not args[0] in commands:
 624             sys.stderr.write("%s: unknown command \"%s\" "
 625                              "(use --help for help)\n" % (argv0, args[0]))
 626             sys.exit(1)
 627
 628         func, n_args = commands[args[0]]
 629         if len(args) - 1 != n_args:
 630             sys.stderr.write("%s: \"%s\" requires %d arguments but %d "
 631                              "provided\n"
 632                              % (argv0, args[0], n_args, len(args) - 1))
 633             sys.exit(1)
 634
 635         func(*args[1:])
 636     except ovs.db.error.Error, e:
 637         sys.stderr.write("%s: %s\n" % (argv0, e))
 638         sys.exit(1)
 639
 640 # Local variables:
 641 # mode: python
 642 # End: