Allow substitution of messages as variables in other messages.

grit/node/structure.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.
 
 '''The <structure> element.
 '''
 
 import os
 
 from grit.node import base
 from grit.node import variant
 
 from grit import constants
 from grit import exception
 from grit import util
 
 import grit.gather.admin_template
 import grit.gather.igoogle_strings
 import grit.gather.muppet_strings
 import grit.gather.policy_json
 import grit.gather.rc
 import grit.gather.tr_html
 import grit.gather.txt
 
 import grit.format.rc
 import grit.format.rc_header
 
-# RTL languages
-# TODO(jennyz): remove this fixed set of RTL language array
-# when generic expand_variable code is added by grit team.
-_RTL_LANGS = [
-  'ar',
-  'iw',
-  'ur',
-]
-
 # Type of the gatherer to use for each type attribute
 _GATHERERS = {
   'accelerators' : grit.gather.rc.Accelerators,
   'admin_template' : grit.gather.admin_template.AdmGatherer,
   'dialog'  : grit.gather.rc.Dialog,
   'igoogle' : grit.gather.igoogle_strings.IgoogleStrings,
   'menu'    : grit.gather.rc.Menu,
   'muppet'  : grit.gather.muppet_strings.MuppetStrings,
   'rcdata'  : grit.gather.rc.RCData,
   'tr_html' : grit.gather.tr_html.TrHtml,
@@ skipping 130 matching lines @@
         return self.skeletons[expr]
     return None
 
   def GetFilePath(self):
     return self.ToRealPath(self.attrs['file'])
 
   def HasFileForLanguage(self):
     return self.attrs['type'] in [
         'tr_html', 'admin_template', 'txt', 'muppet', 'igoogle']
 
+  def ExpandVariables(self):
+    '''Variable expansion on structures is controlled by an XML attribute.
+
+    However, old files assume that expansion is always on for Rc files.
+
+    Returns:
+      A boolean.
+    '''
+    attrs = self.GetRoot().attrs
+    if 'grit_version' in attrs and attrs['grit_version'] > 1:
+      return self.attrs['expand_variables'] == 'true'
+    else:
+      return (self.attrs['expand_variables'] == 'true' or
+              self.attrs['file'].lower().endswith('.rc'))
+
   def FileForLanguage(self, lang, output_dir, create_file=True,
                       return_if_not_generated=True):
     '''Returns the filename of the file associated with this structure,
     for the specified language.
 
     Args:
       lang: 'fr'
       output_dir: 'c:\temp'
       create_file: True
     '''
@@ skipping 20 matching lines @@
     if create_file:
       text = self.gatherer.Translate(
           lang,
           pseudo_if_not_available=self.PseudoIsAllowed(),
           fallback_to_english=self.ShouldFallbackToEnglish(),
           skeleton_gatherer=self.GetSkeletonGatherer())
 
       file_object = util.WrapOutputStream(file(filename, 'wb'),
                                           self._GetOutputEncoding())
       file_contents = util.FixLineEnd(text, self.GetLineEnd())
-      if self.attrs['expand_variables'] == 'true':
-        file_contents = file_contents.replace('[GRITLANGCODE]', lang)
-        # TODO(jennyz): remove this hard coded logic for expanding
-        # [GRITDIR] variable for RTL languages when the generic
-        # expand_variable code is added by grit team.
-        if lang in _RTL_LANGS :
-          file_contents = file_contents.replace('[GRITDIR]', 'dir="RTL"')
-        else :
-          file_contents = file_contents.replace('[GRITDIR]', 'dir="LTR"')
+      if self.ExpandVariables():
+        # Note that we reapply substitution a second time here.
+        # This is because a) we need to look inside placeholders
+        # b) the substitution values are language-dependent
+        file_contents = self.GetRoot().substituter.Substitute(file_contents)
       if self._ShouldAddBom():
         file_object.write(constants.BOM)
       file_object.write(file_contents)
       file_object.close()
 
       if self.attrs['run_command']:
         # Run arbitrary commands after translation is complete so that it
         # doesn't interfere with what's in translation console.
         command = self.attrs['run_command'] % {'filename': filename}
         result = os.system(command)
@@ skipping 10 matching lines @@
     if enc.endswith('-sig'):
       return enc[0:len(enc) - len('-sig')]
     else:
       return enc
 
   def _ShouldAddBom(self):
     '''Returns true if output files should have the Unicode BOM prepended.
     '''
     return self.attrs['output_encoding'].endswith('-sig')
 
-  # static method
+  @staticmethod
   def Construct(parent, name, type, file, encoding='cp1252'):
     '''Creates a new node which is a child of 'parent', with attributes set
     by parameters of the same name.
     '''
     node = StructureNode()
     node.StartParsing('structure', parent)
     node.HandleAttribute('name', name)
     node.HandleAttribute('type', type)
     node.HandleAttribute('file', file)
     node.HandleAttribute('encoding', encoding)
     node.EndParsing()
     return node
-  Construct = staticmethod(Construct)
 
+  def SubstituteMessages(self, substituter):
+    '''Propagates substitution to gatherer.
+
+    Args:
+      substituter: a grit.util.Substituter object.
+    '''
+    assert self.gatherer
+    if self.ExpandVariables():
+      self.gatherer.SubstituteMessages(substituter)
+