Make first_ids_file an optional attribute of the .grd file.

grit/node/misc.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.
 
 '''Miscellaneous node types.
 '''
 
 import os.path
 import re
@@ skipping 11 matching lines @@
 
 def _ReadFirstIdsFromFile(filename, defines):
   '''Read the starting resource id values from |filename|.  We also
   expand variables of the form <(FOO) based on defines passed in on
   the command line.
 
   Returns a tuple, the absolute path of SRCDIR followed by the
   first_ids dictionary.
   '''
   first_ids_dict = eval(open(filename).read())
-
-  # TODO(joi@chromium.org): It might make sense to make this a
-  # parameter of the .grd file rather than of the resource_ids file.
   src_root_dir = os.path.abspath(os.path.join(os.path.dirname(filename),
                                               first_ids_dict['SRCDIR']))
 
   def ReplaceVariable(matchobj):
     for key, value in defines.iteritems():
       if matchobj.group(1) == key:
         value = os.path.abspath(value)[len(src_root_dir) + 1:]
         return value
     return ''
 
@@ skipping 85 matching lines @@
     base.Node.__init__(self)
     self.output_language = ''
     self.defines = {}
 
   def _IsValidChild(self, child):
     from grit.node import empty
     return isinstance(child, (ReleaseNode, empty.TranslationsNode,
                               empty.OutputsNode))
 
   def _IsValidAttribute(self, name, value):
-    if name not in ['base_dir', 'source_lang_id',
+    if name not in ['base_dir', 'first_ids_file', 'source_lang_id',
                     'latest_public_release', 'current_release',
                     'enc_check', 'tc_project']:
       return False
     if name in ['latest_public_release', 'current_release'] and value.strip(
       '0123456789') != '':
       return False
     return True
 
   def MandatoryAttributes(self):
     return ['latest_public_release', 'current_release']
 
   def DefaultAttributes(self):
     return {
       'base_dir' : '.',
+      'first_ids_file': '',
       'source_lang_id' : 'en',
       'enc_check' : constants.ENCODING_CHECK,
       'tc_project' : 'NEED_TO_SET_tc_project_ATTRIBUTE',
     }
 
   def EndParsing(self):
     base.Node.EndParsing(self)
     if (int(self.attrs['latest_public_release'])
         > int(self.attrs['current_release'])):
       raise exception.Parsing('latest_public_release cannot have a greater '
@@ skipping 75 matching lines @@
     if hasattr(self, 'base_dir'):
       return self.base_dir
     else:
       return self.GetOriginalBaseDir()
 
   def GetOriginalBaseDir(self):
     '''Returns the base directory, as set in the .grd file.
     '''
     return self.attrs['base_dir']
 
+  def GetFirstIdsFile(self):
+    '''Returns a usable path to the first_ids file, if set, otherwise
+    returns None.
+
+    The first_ids_file attribute is by default relative to the
+    base_dir of the .grd file, but may be prefixed by GRIT_DIR/,
+    which makes it relative to the directory of grit.py
+    (e.g. GRIT_DIR/../gritsettings/resource_ids).
+    '''
+    if not self.attrs['first_ids_file']:
+      return None
+    else:

[tony, 2012/03/28 17:31:56]

Nit: Remove the 'else' and unindent the rest of this method?

[Jói, 2012/03/29 11:36:15]

Done.

+      path = self.attrs['first_ids_file']
+      GRIT_DIR_PREFIX = 'GRIT_DIR/'
+      if path.startswith(GRIT_DIR_PREFIX):
+        return util.PathFromRoot(path[len(GRIT_DIR_PREFIX):])
+      else:
+        return self.ToRealPath(path)
+
   def _CollectOutputFiles(self, nodes, output_files):
     '''Recursively filters the list of nodes that may contain other lists
     in <if> nodes, and collects all the nodes that are not enclosed by
     unsatisfied <if> conditionals and not <if> nodes themselves.
 
     Args:
       nodes: The list of nodes to filter.
       output_files: The list of satisfying nodes.
     '''
     for node in nodes:
@@ skipping 37 matching lines @@
     else:
       return super(type(self), self).ItemFormatter(t)
 
   def SetOutputContext(self, output_language, defines):
     self.output_language = output_language
     self.defines = defines
 
   def SetDefines(self, defines):
     self.defines = defines
 
-  def AssignFirstIds(self, filename_or_stream, first_id_filename, defines):
-    '''Assign first ids to each grouping node based on values from
-    tools/grit/resource_ids.'''
+  def AssignFirstIds(self, filename_or_stream, defines):
+    '''Assign first ids to each grouping node based on values from the
+    first_ids file (if specified on the <grit> node).
+    '''
     # If the input is a stream, then we're probably in a unit test and
     # should skip this step.
     if type(filename_or_stream) not in (str, unicode):
       return
 
-    # TODO(joi@chromium.org): Get rid of this hack by making it
-    # possible to specify the resource_ids file to use as an attribute
-    # of the <grit> node in the .grd file, and doing so in all Chrome
-    # .grd files.
-    #
-    # For now, by default, we use the the file
-    # ../gritsettings/resource_ids relative to grit.py.
-    if not first_id_filename:
-      first_id_filename = os.path.join(
-          os.path.dirname(__file__),
-          '..', '..', '..',
-          'gritsettings', 'resource_ids')
+    # Nothing to do if the first_ids_filename attribute isn't set.
+    first_ids_filename = self.GetFirstIdsFile()
+    if not first_ids_filename:
+      return
 
-    first_ids = None
+    src_root_dir, first_ids = _ReadFirstIdsFromFile(first_ids_filename,
+                                                    defines)
     from grit.node import empty
     for node in self.inorder():
       if isinstance(node, empty.GroupingNode):
-        if not first_ids:
-          src_root_dir, first_ids = _ReadFirstIdsFromFile(first_id_filename,
-                                                          defines)
         filename = os.path.abspath(filename_or_stream)[
-            len(src_root_dir) + 1:]
+          len(src_root_dir) + 1:]
         filename = filename.replace('\\', '/')
 
-        # TODO(joi@chromium.org): Generalize this; users other than
-        # Chrome might want to use the first_id attribute; could check
-        # for first_ids == None to indicate not loaded, first_ids ==
-        # {} to indicate tried to load but found no resource_ids file.
         if node.attrs['first_id'] != '':
-          raise Exception("Don't set the first_id attribute, update "
-              "%s instead." % first_id_filename)
+          raise Exception(
+              "Don't set the first_id attribute when using the first_ids_file "
+              "attribute on the <grit> node, update %s instead." %
+              first_ids_filename)
 
         try:
           id_list = first_ids[filename][node.name]
         except KeyError, e:
           print '-' * 78
           print 'Resource id not set for %s (%s)!' % (filename, node.name)
           print ('Please update %s to include an entry for %s.  See the '
-              'comments in resource_ids for information on why you need to '
-              'update that file.' % (first_id_filename, filename))
+                 'comments in resource_ids for information on why you need to '
+                 'update that file.' % (first_ids_filename, filename))
           print '-' * 78
           raise e
 
         try:
           node.attrs['first_id'] = str(id_list.pop(0))
         except IndexError, e:
           raise Exception('Please update %s and add a first id for %s (%s).'
-              % (first_id_filename, filename, node.name))
+                          % (first_ids_filename, filename, node.name))
 
 
 class IdentifierNode(base.Node):
   '''A node for specifying identifiers that should appear in the resource
   header file, and be unique amongst all other resource identifiers, but don't
   have any other attributes or reference any resources.
   '''
 
   def MandatoryAttributes(self):
     return ['name']
@@ skipping 18 matching lines @@
     by parameters of the same name.
     '''
     node = IdentifierNode()
     node.StartParsing('identifier', parent)
     node.HandleAttribute('name', name)
     node.HandleAttribute('id', id)
     node.HandleAttribute('comment', comment)
     node.EndParsing()
     return node
   Construct = staticmethod(Construct)