Rework vswhere executable filter/seen handling.

Author: jcbrill

SCons/Tool/MSCommon/MSVC/Kind.py

@@ -177,7 +177,6 @@ def msvc_version_register_kind(msvc_version, kind_t) -> None:
     global _cache_vcver_kind_map
     if kind_t is None:
         kind_t = _VCVER_DETECT_KIND_UNKNOWN
-    # print('register_kind: msvc_version=%s, kind=%s' % (repr(msvc_version), repr(VCVER_KIND_STR[kind_t.kind])))
     debug('msvc_version=%s, kind=%s', repr(msvc_version), repr(VCVER_KIND_STR[kind_t.kind]))
     _cache_vcver_kind_map[msvc_version] = kind_t
 

SCons/Tool/MSCommon/vc.py

@@ -1272,8 +1272,6 @@ def reset(cls):
         cls.seen_vswhere = set()
         cls.seen_root = set()
 
-        cls.vswhere_executables = []
-
         cls.msvc_instances = []
         cls.msvc_map = {}
 
@@ -1283,20 +1281,20 @@ def _initialize(cls):
         cls.reset()
 
     @classmethod
-    def _new_roots_discovered(cls):
-        # TODO(JCB) should not happen due to freezing vswhere.exe
-        # need sanity check?
-        pass
+    def _filter_vswhere_binary(cls, vswhere_binary):
 
-    @classmethod
-    def _filter_vswhere_paths(cls, vswhere_exe):
+        vswhere_norm = None
 
-        vswhere_paths = []
+        if vswhere_binary.vswhere_norm not in cls.seen_vswhere:
+            cls.seen_vswhere.add(vswhere_binary.vswhere_norm)
+            vswhere_norm = vswhere_binary.vswhere_norm
 
-        if vswhere_exe and vswhere_exe not in cls.seen_vswhere:
-            vswhere_paths.append(vswhere_exe)
+        return vswhere_norm
 
-        return vswhere_paths
+    @classmethod
+    def _new_roots_discovered(cls):
+        if len(cls.seen_vswhere) > 1:
+            raise MSVCInternalError(f'vswhere discovered new msvc installations after initial detection')
 
     @classmethod
     def _vswhere_query_json_output(cls, vswhere_exe, vswhere_args):
@@ -1352,95 +1350,85 @@ def vswhere_update_msvc_map(cls, vswhere_exe):
 
         frozen_binary, vswhere_binary = _VSWhereExecutable.vswhere_freeze_executable(vswhere_exe)
 
-        vswhere_exe = frozen_binary.vswhere_exe
-
-        vswhere_paths = cls._filter_vswhere_paths(vswhere_exe)
-        if not vswhere_paths:
+        vswhere_norm = cls._filter_vswhere_binary(frozen_binary)
+        if not vswhere_norm:
             return cls.msvc_map
 
-        n_instances = len(cls.msvc_instances)
+        debug('vswhere_norm=%s', repr(vswhere_norm), extra=cls.debug_extra)
 
-        for vswhere_exe in vswhere_paths:
+        vswhere_json = cls._vswhere_query_json_output(
+            vswhere_norm,
+            ['-all', '-products', '*']
+        )
 
-            if vswhere_exe in cls.seen_vswhere:
-                continue
+        if not vswhere_json:
+            return cls.msvc_map
 
-            cls.seen_vswhere.add(vswhere_exe)
-            cls.vswhere_executables.append(vswhere_exe)
+        n_instances = len(cls.msvc_instances)
 
-            debug('vswhere_exe=%s', repr(vswhere_exe), extra=cls.debug_extra)
+        for instance in vswhere_json:
 
-            vswhere_json = cls._vswhere_query_json_output(
-                vswhere_exe,
-                ['-all', '-products', '*']
-            )
+            #print(json.dumps(instance, indent=4, sort_keys=True))
 
-            if not vswhere_json:
+            installation_path = instance.get('installationPath')
+            if not installation_path or not os.path.exists(installation_path):
                 continue
 
-            for instance in vswhere_json:
-
-                #print(json.dumps(instance, indent=4, sort_keys=True))
-
-                installation_path = instance.get('installationPath')
-                if not installation_path or not os.path.exists(installation_path):
-                    continue
-
-                vc_path = os.path.join(installation_path, 'VC')
-                if not os.path.exists(vc_path):
-                    continue
+            vc_path = os.path.join(installation_path, 'VC')
+            if not os.path.exists(vc_path):
+                continue
 
-                vc_root = MSVC.Util.normalize_path(vc_path)
-                if vc_root in cls.seen_root:
-                    continue
-                cls.seen_root.add(vc_root)
+            vc_root = MSVC.Util.normalize_path(vc_path)
+            if vc_root in cls.seen_root:
+                continue
+            cls.seen_root.add(vc_root)
 
-                installation_version = instance.get('installationVersion')
-                if not installation_version:
-                    continue
+            installation_version = instance.get('installationVersion')
+            if not installation_version:
+                continue
 
-                vs_major = installation_version.split('.')[0]
-                if not vs_major in _VSWHERE_VSMAJOR_TO_VCVERSION:
-                    debug('ignore vs_major: %s', vs_major, extra=cls.debug_extra)
-                    continue
+            vs_major = installation_version.split('.')[0]
+            if not vs_major in _VSWHERE_VSMAJOR_TO_VCVERSION:
+                debug('ignore vs_major: %s', vs_major, extra=cls.debug_extra)
+                continue
 
-                vc_version = _VSWHERE_VSMAJOR_TO_VCVERSION[vs_major]
+            vc_version = _VSWHERE_VSMAJOR_TO_VCVERSION[vs_major]
 
-                product_id = instance.get('productId')
-                if not product_id:
-                    continue
+            product_id = instance.get('productId')
+            if not product_id:
+                continue
 
-                component_id = product_id.split('.')[-1]
-                if component_id not in _VSWHERE_COMPONENTID_CANDIDATES:
-                    debug('ignore component_id: %s', component_id, extra=cls.debug_extra)
-                    continue
+            component_id = product_id.split('.')[-1]
+            if component_id not in _VSWHERE_COMPONENTID_CANDIDATES:
+                debug('ignore component_id: %s', component_id, extra=cls.debug_extra)
+                continue
 
-                component_rank = _VSWHERE_COMPONENTID_RANKING.get(component_id,0)
-                if component_rank == 0:
-                    raise MSVCInternalError(f'unknown component_rank for component_id: {component_id!r}')
+            component_rank = _VSWHERE_COMPONENTID_RANKING.get(component_id,0)
+            if component_rank == 0:
+                raise MSVCInternalError(f'unknown component_rank for component_id: {component_id!r}')
 
-                scons_suffix = _VSWHERE_COMPONENTID_SCONS_SUFFIX[component_id]
+            scons_suffix = _VSWHERE_COMPONENTID_SCONS_SUFFIX[component_id]
 
-                if scons_suffix:
-                    vc_version_scons = vc_version + scons_suffix
-                else:
-                    vc_version_scons = vc_version
-
-                is_prerelease = True if instance.get('isPrerelease', False) else False
-                is_release = False if is_prerelease else True
-
-                msvc_instance = MSVCInstance(
-                    vc_path = vc_path,
-                    vc_version = vc_version,
-                    vc_version_numeric = float(vc_version),
-                    vc_version_scons = vc_version_scons,
-                    vc_release = is_release,
-                    vc_component_id = component_id,
-                    vc_component_rank = component_rank,
-                    vc_component_suffix = component_suffix,
-                )
+            if scons_suffix:
+                vc_version_scons = vc_version + scons_suffix
+            else:
+                vc_version_scons = vc_version
+
+            is_prerelease = True if instance.get('isPrerelease', False) else False
+            is_release = False if is_prerelease else True
+
+            msvc_instance = MSVCInstance(
+                vc_path = vc_path,
+                vc_version = vc_version,
+                vc_version_numeric = float(vc_version),
+                vc_version_scons = vc_version_scons,
+                vc_release = is_release,
+                vc_component_id = component_id,
+                vc_component_rank = component_rank,
+                vc_component_suffix = component_suffix,
+            )
 
-                cls.msvc_instances.append(msvc_instance)
+            cls.msvc_instances.append(msvc_instance)
 
         new_roots = bool(len(cls.msvc_instances) > n_instances)
         if new_roots:

SCons/Tool/MSCommon/vs.py

@@ -426,12 +426,8 @@ def reset(self) -> None:
     ),
 ]
 
-SupportedVSWhereList = []
 SupportedVSMap = {}
 for vs in SupportedVSList:
-    if vs.vernum >= 14.1:
-        # VS2017 and later detected via vswhere.exe
-        SupportedVSWhereList.append(vs)
     SupportedVSMap[vs.version] = vs