Function PrintEnumFor

validator/validator_gen_js.py:456–502

Prints a Javascript enum for the given enum descriptor. Args: enum_desc: The descriptor for a particular enum type. out: a list of lines to output (without the newline characters) wrapped as an OutputFormatter instance, to which this function will append.

(enum_desc, out)

def PrintEnumFor(enum_desc, out):
  """Prints a Javascript enum for the given enum descriptor.

  Args:
    enum_desc: The descriptor for a particular enum type.
    out: a list of lines to output (without the newline characters) wrapped as
        an OutputFormatter instance, to which this function will append.
  """
  out.Line('/**')
  out.Line(' * @enum {string}')
  out.Line(' */')
  out.Line('%s = {' % LocalModuleName(enum_desc.full_name))
  out.PushIndent(2)
  names = []
  for v in enum_desc.values:
    names.append('%s' % v.name)
    out.Line("%s: '%s'," % (v.name, v.name))
  out.PopIndent()
  out.Line('};')

  out.Line('exports.%s = %s;' % (LocalModuleName(
      enum_desc.full_name), LocalModuleName(enum_desc.full_name)))
  out.Line('/** @type {!Array<string>} */')
  out.Line('%s_NamesByIndex = ["%s"];' %
           (LocalModuleName(enum_desc.full_name), '","'.join(names)))
  out.Line('/** @type {!Array<!%s>} */' % LocalModuleName(enum_desc.full_name))
  out.Line(
      '%s_ValuesByIndex = [%s];' %
      (LocalModuleName(enum_desc.full_name), ','.join([
          '%s.%s' % (LocalModuleName(enum_desc.full_name), n) for n in names
      ])))
  out.Line('/** @type (!Object<%s, number>) */' %
           LocalModuleName(enum_desc.full_name))
  out.Line('%s_NumberByName = {' % LocalModuleName(enum_desc.full_name))
  out.PushIndent(2)
  for v in enum_desc.values:
    out.Line("'%s': %s," % (v.name, v.number))
  out.PopIndent()
  out.Line('};')
  out.Line('/** @type (!Object<number, %s>) */' %
           LocalModuleName(enum_desc.full_name))
  out.Line('%s_NameByNumber = {' % LocalModuleName(enum_desc.full_name))
  out.PushIndent(2)
  for v in enum_desc.values:
    out.Line("%s: '%s'," % (v.number, v.name))
  out.PopIndent()
  out.Line('};')


def TagSpecName(tag_spec):