vim-crosoft: scripts/vsutil.py comparison

comparison scripts/vsutil.py @ 15:cfcac4ed7d21 default tip

Improve loading of solution files - New argument to force a rebuild of the cache - Gracefully handle missing projects in a solution - Handle more different xml namespaces - Support more edge cases

author	Ludovic Chabant <ludovic@chabant.com>
date	Tue, 29 Aug 2023 12:59:54 -0700
parents	4ba6df1b2f97
children

comparison

equal deleted inserted replaced

-:0aa61944e518
+:cfcac4ed7d21
 self.path = path
 self.guid = guid
 self._itemgroups = None
 self._propgroups = None
 self._sln = None
+self._missing = False
 @property
 def is_folder(self):
 """ Returns whether this project is actually just a solution
 folder, used as a container for other projects.
 tree = etree.parse(abspath)
 except (FileNotFoundError, OSError) as ex:
 logger.debug(f"Error loading project {self.name}: " + str(ex))
 self._itemgroups = {}
 self._propgroups= {}
+self._missing = True
 return
 root = tree.getroot()
 if _strip_ns(root.tag) != 'Project':
 raise Exception(f"Expected root node 'Project', got '{root.tag}'")
+# Load ItemGroups and PropertyGroups via both namespaced names and raw
+# names because not all types of VS projects use the MS namespaces.
 self._itemgroups = {}
+for itemgroupnode in root.iterfind('ItemGroup', ns):
+self._load_item_group(itemgroupnode)
 for itemgroupnode in root.iterfind('ms:ItemGroup', ns):
-label = itemgroupnode.attrib.get('Label')
+self._load_item_group(itemgroupnode)
-itemgroup = self._itemgroups.get(label)
-if not itemgroup:
-itemgroup = VSProjectItemGroup(label)
-self._itemgroups[label] = itemgroup
-logger.debug(f"Adding itemgroup '{label}'")
-condition = itemgroupnode.attrib.get('Condition')
-if condition:
-itemgroup = itemgroup.get_or_create_conditional(condition)
-for itemnode in itemgroupnode:
-incval = itemnode.attrib.get('Include')
-item = VSProjectItem(incval, _strip_ns(itemnode.tag))
-itemgroup.items.append(item)
-for metanode in itemnode:
-item.metadata[_strip_ns(metanode.tag)] = metanode.text
 self._propgroups = {}
+for propgroupnode in root.iterfind('PropertyGroup', ns):
+self._load_property_group(propgroupnode)
 for propgroupnode in root.iterfind('ms:PropertyGroup', ns):
-label = propgroupnode.attrib.get('Label')
+self._load_property_group(propgroupnode)
-propgroup = self._propgroups.get(label)
-if not propgroup:
+def _load_item_group(self, itemgroupnode):
-propgroup = VSProjectPropertyGroup(label)
+label = itemgroupnode.attrib.get('Label')
-self._propgroups[label] = propgroup
+itemgroup = self._itemgroups.get(label)
-logger.debug(f"Adding propertygroup '{label}'")
+if not itemgroup:
+itemgroup = VSProjectItemGroup(label)
-condition = propgroupnode.attrib.get('Condition')
+self._itemgroups[label] = itemgroup
-if condition:
+logger.debug(f"Adding itemgroup '{label}'")
-propgroup = propgroup.get_or_create_conditional(condition)
+condition = itemgroupnode.attrib.get('Condition')
-for propnode in propgroupnode:
+if condition:
-propgroup.properties.append(VSProjectProperty(
+itemgroup = itemgroup.get_or_create_conditional(condition)
-_strip_ns(propnode.tag),
-propnode.text))
+for itemnode in itemgroupnode:
+incval = itemnode.attrib.get('Include')
+item = VSProjectItem(incval, _strip_ns(itemnode.tag))
+itemgroup.items.append(item)
+for metanode in itemnode:
+item.metadata[_strip_ns(metanode.tag)] = metanode.text
+def _load_property_group(self, propgroupnode):
+label = propgroupnode.attrib.get('Label')
+propgroup = self._propgroups.get(label)
+if not propgroup:
+propgroup = VSProjectPropertyGroup(label)
+self._propgroups[label] = propgroup
+logger.debug(f"Adding propertygroup '{label}'")
+condition = propgroupnode.attrib.get('Condition')
+if condition:
+propgroup = propgroup.get_or_create_conditional(condition)
+for propnode in propgroupnode:
+propgroup.properties.append(VSProjectProperty(
+_strip_ns(propnode.tag),
+propnode.text))
 class MissingVSProjectError(Exception):
 pass
 m = _re_sln_global_section_start.search(line)
 if m:
 # Found the start of a new section.
 in_global_section = VSGlobalSection(m.group('name'))
-logging.debug(f"   Adding global section {in_global_section.name}")
+logging.debug(f"   Adding global section {in_global_section.name} (line {i})")
 slnobj.sections.append(in_global_section)
 continue
 m = _re_sln_global_end.search(line)
 if m:
 slnobj,
 m.group('type'), m.group('name'), m.group('path'),
 m.group('guid'))
 except:
 raise Exception(f"Error line {i}: unexpected project syntax.")
-logging.debug(f"  Adding project {p.name}")
+logging.debug(f"  Adding project {p.name} (line {i})")
 slnobj.projects.append(p)
 p._sln = slnobj
 until = _re_sln_project_decl_end
 continue
 class SolutionCache:
 """ A class that contains a VS solution object, along with pre-indexed
 lists of items. It's meant to be saved on disk.
 """
-VERSION = 4
+VERSION = 5
 def __init__(self, slnobj):
 self.slnobj = slnobj
 self.index = None
 self._saved_version = SolutionCache.VERSION
 item_cache = set()
 self.index[proj.abspath] = item_cache
 for item in itemgroup.get_source_items():
-item_path = proj.get_abs_item_include(item).lower()
+if item.include:
-item_cache.add(item_path)
+item_path = proj.get_abs_item_include(item).lower()
+item_cache.add(item_path)
+# else: it's an item from our shortlist (cpp, cs, etc files)
+# but it somehow doesn't have a path, which can happen with
+# some obscure VS features.
 def save(self, path):
 pathdir = os.path.dirname(path)
 if not os.path.exists(pathdir):
 os.makedirs(pathdir)
 with open(path, 'wb') as fp:
 pickle.dump(self, fp)
 @staticmethod
-def load_or_rebuild(slnpath, cachepath):
+def load_or_rebuild(slnpath, cachepath, force_rebuild=False):
-if cachepath:
+if cachepath and not force_rebuild:
 res = _try_load_from_cache(slnpath, cachepath)
 if res is not None:
 return res
 slnobj = parse_sln_file(slnpath)
 # Our cache is at least valid for the solution stuff. Some of our
 # projects might be out of date, but at least there can't be any
 # added or removed projects from the solution (otherwise the solution
 # file would have been touched). Let's load the cache.
-with open(cachepath, 'rb') as fp:
+try:
-cache = pickle.load(fp)
+with open(cachepath, 'rb') as fp:
+cache = pickle.load(fp)
+except Exception as ex:
+logger.debug("Error loading solution cache: %s" % ex)
+logger.debug("Deleting cache: %s" % cachepath)
+os.remove(cachepath)
+return None
 # Check that the cache version is up-to-date with this code.
 loaded_ver = getattr(cache, '_saved_version', 0)
 if loaded_ver != SolutionCache.VERSION:
 logger.debug(f"Cache was saved with older format: {cachepath} "
 proj_dts = []
 for p in slnobj.projects:
 if not p.is_folder:
 try:
 proj_dts.append(os.path.getmtime(p.abspath))
+# The project was missing last time we built the cache,
+# but now it exists. Force a rebuild.
+if p._missing:
+return None
 except OSError:
-logger.debug(f"Found missing project: {p.abspath}")
+if not p._missing:
-return None
+logger.debug(f"Found missing project: {p.abspath}")
+return None
+# else: it was already missing last time we built the
+# cache, so nothing has changed.
 if all([cache_dt > pdt for pdt in proj_dts]):
 logger.debug(f"Cache is up to date: {cachepath}")
 return (cache, True)

Mercurial > vim-crosoft

comparison scripts/vsutil.py @ 15:cfcac4ed7d21 default tip