toolkit/components/telemetry/build_scripts/gen_scalar_enum.py

   1 # This Source Code Form is subject to the terms of the Mozilla Public
   2 # License, v. 2.0. If a copy of the MPL was not distributed with this
   3 # file, You can obtain one at http://mozilla.org/MPL/2.0/.
   4
   5 # Write out a C++ enum definition whose members are the names of
   6 # scalar types.
   7 #
   8 # The scalars are defined in files provided as command-line arguments.
   9
  10 import sys
  11
  12 import buildconfig
  13 from mozparsers import parse_scalars
  14 from mozparsers.shared_telemetry_utils import ParserError
  15
  16 banner = """/* This file is auto-generated, see gen_scalar_enum.py.  */
  17 """
  18
  19 file_header = """\
  20 #ifndef mozilla_TelemetryScalarEnums_h
  21 #define mozilla_TelemetryScalarEnums_h
  22 namespace mozilla {
  23 namespace Telemetry {
  24 enum class ScalarID : uint32_t {\
  25 """
  26
  27 file_footer = """\
  28 };
  29 } // namespace mozilla
  30 } // namespace Telemetry
  31 #endif // mozilla_TelemetryScalarEnums_h
  32 """
  33
  34
  35 def main(output, *filenames):
  36     # Load the scalars first.
  37     scalars = []
  38     for filename in filenames:
  39         try:
  40             batch = parse_scalars.load_scalars(filename)
  41             scalars.extend(batch)
  42         except ParserError as ex:
  43             print("\nError processing %s:\n%s\n" % (filename, str(ex)), file=sys.stderr)
  44             sys.exit(1)
  45
  46     # Write the enum file.
  47     print(banner, file=output)
  48     print(file_header, file=output)
  49
  50     for s in scalars:
  51         if s.record_on_os(buildconfig.substs["OS_TARGET"]):
  52             print("  %s," % s.enum_label, file=output)
  53
  54     print("  ScalarCount,", file=output)
  55
  56     print(file_footer, file=output)
  57
  58
  59 if __name__ == "__main__":
  60     main(sys.stdout, *sys.argv[1:])