Ensure that all entries in .sln files are sorted.

pylib/gyp/MSVSNew.py

 # Copyright (c) 2012 Google Inc. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """New implementation of Visual Studio project generation for SCons."""
 
 import os
 import random
 
 import gyp.common
@@ skipping 41 matching lines @@
   # Calculate a MD5 signature for the seed and name.
   d = _new_md5(str(seed) + str(name)).hexdigest().upper()
   # Convert most of the signature to GUID form (discard the rest)
   guid = ('{' + d[:8] + '-' + d[8:12] + '-' + d[12:16] + '-' + d[16:20]
           + '-' + d[20:32] + '}')
   return guid
 
 #------------------------------------------------------------------------------
 
 
-class MSVSFolder(object):
+class MSVSSolutionEntry(object):
+  def __cmp__(self, other):
+    # Sort by name then guid (so things are in order on vs2008).
+    return cmp((self.name, self.get_guid()), (other.name, other.get_guid()))
+
+
+class MSVSFolder(MSVSSolutionEntry):
   """Folder in a Visual Studio project or solution."""
 
   def __init__(self, path, name = None, entries = None,
                guid = None, items = None):
     """Initializes the folder.
 
     Args:
       path: Full path to the folder.
       name: Name of the folder.
       entries: List of folder entries to nest inside this folder.  May contain
           Folder or Project objects.  May be None, if the folder is empty.
       guid: GUID to use for folder, if not None.
       items: List of solution items to include in the folder project.  May be
           None, if the folder does not directly contain items.
     """
     if name:
       self.name = name
     else:
       # Use last layer.
       self.name = os.path.basename(path)
 
     self.path = path
     self.guid = guid
 
     # Copy passed lists (or set to empty lists)
-    self.entries = list(entries or [])
+    self.entries = sorted(list(entries or []))
     self.items = list(items or [])
 
     self.entry_type_guid = ENTRY_TYPE_GUIDS['folder']
 
   def get_guid(self):
     if self.guid is None:
       # Use consistent guids for folders (so things don't regenerate).
       self.guid = MakeGuid(self.path, seed='msvs_folder')
     return self.guid
 
 
 #------------------------------------------------------------------------------
 
 
-class MSVSProject(object):
+class MSVSProject(MSVSSolutionEntry):
   """Visual Studio project."""
 
   def __init__(self, path, name = None, dependencies = None, guid = None,
                spec = None, build_file = None, config_platform_overrides = None,
                fixpath_prefix = None):
     """Initializes the project.
 
     Args:
       path: Absolute path to the project file.
       name: Name of project.  If None, the name will be the same as the base
@@ skipping 108 matching lines @@
       # If this entry has been visited, nothing to do.
       if e in all_entries:
         continue
 
       all_entries.add(e)
 
       # If this is a folder, check its entries too.
       if isinstance(e, MSVSFolder):
         entries_to_check += e.entries
 
-    # Sort by name then guid (so things are in order on vs2008).
-    def NameThenGuid(a, b):
-      if a.name < b.name: return -1
-      if a.name > b.name: return 1
-      if a.get_guid() < b.get_guid(): return -1
-      if a.get_guid() > b.get_guid(): return 1
-      return 0
-
-    all_entries = sorted(all_entries, NameThenGuid)
+    all_entries = sorted(all_entries)
 
     # Open file and print header
     f = writer(self.path)
     f.write('Microsoft Visual Studio Solution File, '
             'Format Version %s\r\n' % self.version.SolutionVersion())
     f.write('# %s\r\n' % self.version.Description())
 
     # Project entries
     sln_root = os.path.split(self.path)[0]
     for e in all_entries:
@@ skipping 81 matching lines @@
     for e in all_entries:
       if not isinstance(e, MSVSFolder):
         continue        # Does not apply to projects, only folders
       for subentry in e.entries:
         f.write('\t\t%s = %s\r\n' % (subentry.get_guid(), e.get_guid()))
     f.write('\tEndGlobalSection\r\n')
 
     f.write('EndGlobal\r\n')
 
     f.close()