Allow substitution of messages as variables in other messages.

grit/gather/tr_html.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.
 
 '''A gatherer for the TotalRecall brand of HTML templates with replaceable
 portions.  We wanted to reuse extern.tclib.api.handlers.html.TCHTMLParser
 but this proved impossible due to the fact that the TotalRecall HTML templates
 are in general quite far from parseable HTML and the TCHTMLParser derives
 from HTMLParser.HTMLParser which requires relatively well-formed HTML.  Some
@@ skipping 675 matching lines @@
         msg = self.skeleton_[ix].GetMessage()
         for item in msg.GetContent():
           if (isinstance(item, types.StringTypes) and _NON_WHITESPACE.search(item)
               and item != ' '):
             got_text = True
             break
         if not got_text:
           self.skeleton_[ix] = msg.GetRealContent()
 
 
-  # Static method
+  @staticmethod
   def FromFile(html, extkey=None, encoding = 'utf-8'):
     '''Creates a TrHtml object from the contents of 'html' which are decoded
     using 'encoding'.  Returns a new TrHtml object, upon which Parse() has not
     been called.
 
     Args:
       html: file('') | 'filename.html'
       extkey: ignored
       encoding: 'utf-8' (note that encoding is ignored if 'html' is not a file
                          name but instead an open file or file-like object)
 
     Return:
       TrHtml(text_of_file)
     '''
     if isinstance(html, types.StringTypes):
       html = util.WrapInputStream(file(html, 'r'), encoding)
     doc = html.read()
 
     # Ignore the BOM character if the document starts with one.
     if len(doc) and doc[0] == u'\ufeff':
       doc = doc[1:]
 
     return TrHtml(doc)
-  FromFile = staticmethod(FromFile)
 
+  def SubstituteMessages(self, substituter):
+    '''Applies substitutions to all messages in the tree.
+
+    Goes through the skeleton and finds all MessageCliques.
+
+    Args:
+      substituter: a grit.util.Substituter object.
+    '''
+    new_skel = []
+    for chunk in self.skeleton_:
+      if isinstance(chunk, clique.MessageClique):
+        old_message = chunk.GetMessage()
+        new_message = substituter.SubstituteMessage(old_message)
+        if new_message is not old_message:
+          new_skel.append(self.uberclique.MakeClique(new_message))
+          continue
+      new_skel.append(chunk)
+    self.skeleton_ = new_skel
+