# Copyright (C) 2020-present MongoDB, Inc. # # This program is free software: you can redistribute it and/or modify # it under the terms of the Server Side Public License, version 1, # as published by MongoDB, Inc. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # Server Side Public License for more details. # # You should have received a copy of the Server Side Public License # along with this program. If not, see # . # # As a special exception, the copyright holders give permission to link the # code of portions of this program with the OpenSSL library under certain # conditions as described in each individual source file and distribute # linked combinations including the program with the OpenSSL library. You # must comply with the Server Side Public License in all respects for # all of the code used other than as permitted herein. If you modify file(s) # with this exception, you may extend this exception to your version of the # file(s), but you are not obligated to do so. If you do not wish to do so, # delete this exception statement from your version. If you delete this # exception statement from all source files in the program, then also delete # it in the license file. """Library functions and utility methods used across user-facing IDL scripts.""" import os from typing import List, Set from buildscripts.idl.idl import parser, syntax from buildscripts.idl.idl.compiler import CompilerImportResolver def list_idls(directory: str) -> Set[str]: """Find all IDL files in the current directory.""" return { os.path.join(dirpath, filename) for dirpath, dirnames, filenames in os.walk(directory) for filename in filenames if not filename.startswith(".") and filename.endswith(".idl") } def parse_idl(idl_path: str, import_directories: List[str]) -> syntax.IDLParsedSpec: """Parse an IDL file or throw an error.""" parsed_doc = parser.parse(open(idl_path), idl_path, CompilerImportResolver(import_directories)) if parsed_doc.errors: parsed_doc.errors.dump_errors() raise ValueError(f"Cannot parse {idl_path}") return parsed_doc def is_third_party_idl(idl_path: str) -> bool: """Check if an IDL file is under a third party directory.""" third_party_idl_subpaths = [os.path.join("third_party", "mozjs"), "win32com"] for file_name in third_party_idl_subpaths: if file_name in idl_path: return True return False def get_all_feature_flags(idl_dirs: List[str] = None): """Generate a dict of all feature flags with their default value.""" default_idl_dirs = ["src", "buildscripts"] if not idl_dirs: idl_dirs = default_idl_dirs all_flags = {} for idl_dir in idl_dirs: for idl_path in sorted(list_idls(idl_dir)): if is_third_party_idl(idl_path): continue # Most IDL files do not contain feature flags. # We can discard these quickly without expensive YAML parsing. with open(idl_path) as idl_file: if "feature_flags" not in idl_file.read(): continue with open(idl_path) as idl_file: doc = parser.parse_file(idl_file, idl_path) for feature_flag in doc.spec.feature_flags: all_flags[feature_flag.name] = feature_flag return all_flags