Allow substitution of messages as variables in other messages.

grit/node/message.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.
 
 '''Handling of the <message> element.
 '''
 
 import re
 import types
@@ skipping 38 matching lines @@
     # A list of "shortcut groups" this message is in.  We check to make sure
     # that shortcut keys (e.g. &J) within each shortcut group are unique.
     self.shortcut_groups_ = []
 
   def _IsValidChild(self, child):
     return isinstance(child, (PhNode))
 
   def _IsValidAttribute(self, name, value):
     if name not in ['name', 'offset', 'translateable', 'desc', 'meaning',
                     'internal_comment', 'shortcut_groups', 'custom_type',
-                    'validation_expr', 'use_name_for_id']:
+                    'validation_expr', 'use_name_for_id', 'sub_variable']:
       return False
-    if name == 'translateable' and value not in ['true', 'false']:
+    if (name in ('translateable', 'sub_variable') and
+        value not in ['true', 'false']):
       return False
     return True
 
   def MandatoryAttributes(self):
     return ['name|offset']
 
   def DefaultAttributes(self):
     return {
+      'custom_type' : '',
+      'desc' : '',
+      'internal_comment' : '',
+      'meaning' : '',
+      'shortcut_groups' : '',
+      'sub_variable' : 'false',
       'translateable' : 'true',
-      'desc' : '',
-      'meaning' : '',
-      'internal_comment' : '',
-      'shortcut_groups' : '',
-      'custom_type' : '',
+      'use_name_for_id' : 'false',
       'validation_expr' : '',
-      'use_name_for_id' : 'false',
     }
 
   def GetTextualIds(self):
     '''
     Returns the concatenation of the parent's node first_id and
     this node's offset if it has one, otherwise just call the
     superclass' implementation
     '''
     if 'offset' in self.attrs:
       # we search for the first grouping node in the parents' list
@@ skipping 63 matching lines @@
       description_or_id = 'ID: %s' % self.attrs['name']
 
     assigned_id = None
     if (self.attrs['use_name_for_id'] == 'true' and
         self.SatisfiesOutputCondition()):
       assigned_id = self.attrs['name']
     message = tclib.Message(text=text, placeholders=placeholders,
                             description=description_or_id,
                             meaning=self.attrs['meaning'],
                             assigned_id=assigned_id)
+    self.InstallMessage(message)
+
+  def InstallMessage(self, message):
+    '''Sets this node's clique from a tclib.Message instance.
+
+    Args:
+      message: A tclib.Message.
+    '''
     self.clique = self.UberClique().MakeClique(message, self.IsTranslateable())
     for group in self.shortcut_groups_:
       self.clique.AddToShortcutGroup(group)
     if self.attrs['custom_type'] != '':
       self.clique.SetCustomType(util.NewClassInstance(self.attrs['custom_type'],
                                                       clique.CustomType))
     elif self.attrs['validation_expr'] != '':
       self.clique.SetCustomType(
         clique.OneOffCustomType(self.attrs['validation_expr']))
 
+  def SubstituteMessages(self, substituter):
+    '''Applies substitution to this message.
+
+    Args:
+      substituter: a grit.util.Substituter object.
+    '''
+    message = substituter.SubstituteMessage(self.clique.GetMessage())
+    if message is not self.clique.GetMessage():
+      self.InstallMessage(message)
+
   def GetCliques(self):
     if self.clique:
       return [self.clique]
     else:
       return []
 
   def Translate(self, lang):
     '''Returns a translated version of this message.
     '''
     assert self.clique
     msg = self.clique.MessageForLanguage(lang,
                                          self.PseudoIsAllowed(),
                                          self.ShouldFallbackToEnglish()
                                          ).GetRealContent()
     return msg.replace('[GRITLANGCODE]', lang)
 
   def NameOrOffset(self):
     if 'name' in self.attrs:
       return self.attrs['name']
     else:
       return self.attrs['offset']
 
+  def ExpandVariables(self):
+    '''We always expand variables on Messages.'''
+    return True
+
   def GetDataPackPair(self, lang, encoding):
     '''Returns a (id, string) pair that represents the string id and the string
     in utf8.  This is used to generate the data pack data file.
     '''
     from grit.format import rc_header
     id_map = rc_header.Item.tids_
     id = id_map[self.GetTextualIds()[0]]
 
     message = self.ws_at_start + self.Translate(lang) + self.ws_at_end
 
@@ skipping 70 matching lines @@
   def EndParsing(self):
     super(type(self), self).EndParsing()
     # We only allow a single example for each placeholder
     if len(self.children) > 1:
       raise exception.TooManyExamples()
 
 
 class ExNode(base.ContentNode):
   '''An <ex> element.'''
   pass