Allow substitution of messages as variables in other messages.

grit/node/base.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.
 
 '''Base types for nodes in a GRIT resource tree.
 '''
 
 import os
 import sys
@@ skipping 204 matching lines @@
     return ''.join([c for c in self.mixed_content
                     if isinstance(c, types.StringTypes)])
 
   def __unicode__(self):
     '''Returns this node and all nodes below it as an XML document in a Unicode
     string.'''
     header = u'<?xml version="1.0" encoding="UTF-8"?>\n'
     return header + self.FormatXml()
 
   # Compliance with ItemFormatter interface.
-  def Format(self, item, lang_re = None, begin_item=True):
-    if not begin_item:
-      return ''
-    else:
-      return item.FormatXml()
+  def Format(self, item, lang_re = None):
+    return item.FormatXml()
 
   def FormatXml(self, indent = u'', one_line = False):
     '''Returns this node and all nodes below it as an XML
     element in a Unicode string.  This differs from __unicode__ in that it does
     not include the <?xml> stuff at the top of the string.  If one_line is true,
     children and CDATA are layed out in a way that preserves internal
     whitespace.
     '''
     assert isinstance(indent, types.StringTypes)
 
@@ skipping 75 matching lines @@
     if recursive:
       process_last = []
       for child in self.children:
         if child.name == 'translations':
           process_last.append(child)
         else:
           child.RunGatherers(recursive=recursive, debug=debug)
       for child in process_last:
         child.RunGatherers(recursive=recursive, debug=debug)
 
+  def SubstituteMessages(self, substituter):
+    '''Applies substitutions to all messages in the tree.
+
+    Called as a final step of RunGatherers.
+
+    Args:
+      substituter: a grit.util.Substituter object.
+    '''
+    for child in self.children:
+      child.SubstituteMessages(substituter)
+
   def ItemFormatter(self, type):
     '''Returns an instance of the item formatter for this object of the
     specified type, or None if not supported.
 
     Args:
       type: 'rc-header'
 
     Return:
       (object RcHeaderItemFormatter)
     '''
     if type == 'xml':
       return self
     else:
       return None
 
   def SatisfiesOutputCondition(self):
-    '''Returns true if this node is either not a child of an <if> element
-    or if it is a child of an <if> element and the conditions for it being
-    output are satisfied.
+    '''Returns true if this node is either not a descendant of an <if> element,
+    or if all conditions on its <if> element ancestors are satisfied.
 
     Used to determine whether to return item formatters for formats that
     obey conditional output of resources (e.g. the RC formatters).
     '''
     from grit.node import misc
-    if not self.parent or not isinstance(self.parent, misc.IfNode):
+    if self.parent:
+      return self.parent.SatisfiesOutputCondition()
+    else:
       return True
-    else:
-      return self.parent.IsConditionSatisfied()
 
   def _IsValidChild(self, child):
     '''Returns true if 'child' is a valid child of this node.
     Overridden by subclasses.'''
     return False
 
   def _IsValidAttribute(self, name, value):
     '''Returns true if 'name' is the name of a valid attribute of this element
     and 'value' is a valid value for that attribute.  Overriden by
     subclasses unless they have only mandatory attributes.'''
@@ skipping 183 matching lines @@
     '''Returns true if the node is marked to be skipped in the output by a
     whitelist.
     '''
     return self._whitelist_marked_as_skip
 
   def SetWhitelistMarkedAsSkip(self, mark_skipped):
     '''Sets WhitelistMarkedAsSkip.
     '''
     self._whitelist_marked_as_skip = mark_skipped
 
+  def ExpandVariables(self):
+    '''Whether we need to expand variables on a given node.'''
+    return False
+
 
 class ContentNode(Node):
   '''Convenience baseclass for nodes that can have content.'''
   def _ContentType(self):
     return self._CONTENT_TYPE_MIXED