Add option to GRIT to provide a resource ordering input file.

tools/grit/grit/format/rc_header.py

 #!/usr/bin/env python
 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 '''Item formatters for RC headers.
 '''
 
 from grit import exception
 from grit import util
@@ skipping 59 matching lines @@
   for item in root.ActiveDescendants():
     if isinstance(item, message.MessageNode):
       with item:
         for tid in item.GetTextualIds():
           if tid in tids and tid not in seen:
             seen.add(tid)
             yield rc_header_format.format(textual_id=tid,numeric_id=tids[tid])
 
 
 _cached_ids = {}
+_predetermined_tids = {}

[Nico, 2017/02/17 21:44:08]

nit: python style guide says 2 blank lines between toplevels

[Alexei Svitkine (slow), 2017/02/17 22:07:51]

Done.

+
+def SetPredeterminedIdsFile(predetermined_ids_file):
+  global _predetermined_tids
+  if predetermined_ids_file:
+    _predetermined_tids = _ReadIdsFromFile(predetermined_ids_file)
+  else:
+    _predetermined_tids = {}
+
+
+def _ReadIdsFromFile(path):
+  with open(path, "r") as f:
+    content = f.readlines()
+  tids = {}  # Maps textual id to numeric id
+  for line in content:
+    tid, id = line.split()
+    tids[tid] = int(id)
+  return tids
 
 
 def GetIds(root):
   '''Return a dictionary mapping textual ids to numeric ids for the given tree.
 
   Args:
     root: A GritNode.
   '''
+  global _cached_ids
+  global _predetermined_tids
   # TODO(benrg): Since other formatters use this, it might make sense to move it
   # and _ComputeIds to GritNode and store the cached ids as an attribute. On the
   # other hand, GritNode has too much random stuff already.
   if root not in _cached_ids:
-    _cached_ids[root] = _ComputeIds(root)
+    _cached_ids[root] = _ComputeIds(root, _predetermined_tids)
   return _cached_ids[root]
 
 
-def _ComputeIds(root):
+def _ComputeIds(root, predetermined_tids):
   from grit.node import empty, include, message, misc, structure
 
   ids = {}  # Maps numeric id to textual id
   tids = {}  # Maps textual id to numeric id
   id_reasons = {}  # Maps numeric id to text id and a human-readable explanation
   group = None
   last_id = None
 
+  predetermined_ids = {}
+  if predetermined_ids:

[Nico, 2017/02/17 21:44:08]

given the previous lien, won't predetermined_ids always be false-y? (it's always
an empty dict now)

[Alexei Svitkine (slow), 2017/02/17 22:07:51]

Woops, this is meant to be predetermined_tids originally.

But actually even that wasn't needed - since predetermined_tids is also always
initialized to at least an empty dict. So the if wasn't needed - removed.

+    for tid, id in predetermined_tids.iteritems():
+      predetermined_ids[id] = tid
+
   for item in root:
     if isinstance(item, empty.GroupingNode):
       # Note: this won't work if any GroupingNode can be contained inside
       # another.
       group = item
       last_id = None
       continue
 
     assert not item.GetTextualIds() or isinstance(item,
         (include.IncludeNode, message.MessageNode,
          misc.IdentifierNode, structure.StructureNode))
 
     # Resources that use the RES protocol don't need
     # any numerical ids generated, so we skip them altogether.
     # This is accomplished by setting the flag 'generateid' to false
     # in the GRD file.
     if item.attrs.get('generateid', 'true') == 'false':
       continue
 
     for tid in item.GetTextualIds():
       if util.SYSTEM_IDENTIFIERS.match(tid):
         # Don't emit a new ID for predefined IDs
         continue
 
       if tid in tids:
         continue
 
+      if predetermined_tids and tid in predetermined_tids:
+        id = predetermined_tids[tid]
+        reason = "from predetermined_tids map"
+
       # Some identifier nodes can provide their own id,
       # and we use that id in the generated header in that case.
-      if hasattr(item, 'GetId') and item.GetId():
+      elif hasattr(item, 'GetId') and item.GetId():
         id = long(item.GetId())
         reason = 'returned by GetId() method'
 
       elif ('offset' in item.attrs and group and
             group.attrs.get('first_id', '') != ''):
          offset_text = item.attrs['offset']
          parent_text = group.attrs['first_id']
 
          try:
           offset_id = long(offset_text)
@@ skipping 45 matching lines @@
       # Don't fail when 'offset' is specified, as the base and the 0th
       # offset will have the same ID.
       if id in id_reasons and not 'offset' in item.attrs:
         raise exception.IdRangeOverlap('ID %d was assigned to both %s and %s.'
                                        % (id, id_reasons[id], reason))
 
       if id < 101:
         print ('WARNING: Numeric resource IDs should be greater than 100 to\n'
                'avoid conflicts with system-defined resource IDs.')
 
+      if tid not in predetermined_tids and id in predetermined_ids:
+        raise exception.IdRangeOverlap('ID %d overlaps between %s and %s'
+                                       % (id, tid, predetermined_ids[tid]))
+
       ids[id] = tid
       tids[tid] = id
       id_reasons[id] = reason
 
   return tids