Allow ADM(X) templates to manage both MACHINE and USER policies

tools/grit/grit/format/policy_templates/writers/adm_writer.py

 # Copyright (c) 2011 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.
 
 
 from grit.format.policy_templates.writers import template_writer
 
 
 def GetWriter(config):
   '''Factory method for creating AdmWriter objects.
@@ skipping 13 matching lines @@
     'int': 'NUMERIC',
     'string-enum': 'DROPDOWNLIST',
     'int-enum': 'DROPDOWNLIST',
     'list': 'LISTBOX'}
   NEWLINE = '\r\n'
 
   def _AddGuiString(self, name, value):
     # Escape newlines in the value.
     value = value.replace('\n', '\\n')
     line = '%s="%s"' % (name, value)
-    self.str_list.append(line)
+    self.strings.append(line)
 
   def _PrintLine(self, string='', indent_diff=0):
     '''Prints a string with indents and a linebreak to the output.

[Jakob Kummerow, 2011/01/24 16:52:28]

More accurate would be: "Appends a string with indentation to |self.lines|." or
something like that.
The same goes for the argument comment for "string" below ("The string to append
to self.lines").

 
     Args:
       string: The string to print.
       indent_diff: the difference of indentation of the printed line,
         compared to the next/previous printed line. Increment occurs
         after printing the line, while decrement occurs before that.
     '''
     indent_diff *= 2
     if indent_diff < 0:
       self.indent = self.indent[(-indent_diff):]
     if string != '':
-      self.policy_list.append(self.indent + string)
+      self.lines.append(self.indent + string)
     else:
-      self.policy_list.append('')
+      self.lines.append('')
     if indent_diff > 0:
       self.indent += ''.ljust(indent_diff)
 
   def _WriteSupported(self):
     self._PrintLine('#if version >= 4', 1)
     self._PrintLine('SUPPORTED !!SUPPORTED_WINXPSP2')
     self._PrintLine('#endif', -1)
 
   def _WritePart(self, policy):
     '''Writes the PART ... END PART section of a policy.
@@ skipping 52 matching lines @@
     # Open a category for the policies if there is more than one in the
     # group.
     if self._open_category:
       category_name = group['name'] + '_Category'
       self._AddGuiString(category_name, group['caption'])
       self._PrintLine('CATEGORY !!' + category_name, 1)
 
   def EndPolicyGroup(self):
     if self._open_category:
       self._PrintLine('END CATEGORY', -1)
+      self._PrintLine('')
 
-  def BeginTemplate(self):
+  def _WriteTemplateForClass(self, policy_class, policies):
+    '''Writes the whole ADM template except for the [strings] section.
+    The output is self.lines.
+
+    Args:
+      policy_class: USER or MACHINE
+      policies: ADM code for all the policies in the form of list of
+          strings.
+    '''
     category_path = self.config['win_category_path']
-    self._AddGuiString(self.config['win_supported_os'],
-                       self.messages['win_supported_winxpsp2']['text'])
-    self._PrintLine(
-        'CLASS ' + self.config['win_group_policy_class'].upper(),
-        1)
+
+    self._PrintLine('CLASS ' + policy_class, 1)
     if self.config['build'] == 'chrome':
-      self._AddGuiString(category_path[0], 'Google')
-      self._AddGuiString(category_path[1], self.config['app_name'])
       self._PrintLine('CATEGORY !!' + category_path[0], 1)
       self._PrintLine('CATEGORY !!' + category_path[1], 1)
     elif self.config['build'] == 'chromium':
-      self._AddGuiString(category_path[0], self.config['app_name'])
       self._PrintLine('CATEGORY !!' + category_path[0], 1)
     self._PrintLine('KEYNAME "%s"' % self.config['win_reg_key_name'])
     self._PrintLine()
 
-  def EndTemplate(self):
+    self.lines += policies
+
     if self.config['build'] == 'chrome':
       self._PrintLine('END CATEGORY', -1)
       self._PrintLine('END CATEGORY', -1)
       self._PrintLine('', -1)
     elif self.config['build'] == 'chromium':
       self._PrintLine('END CATEGORY', -1)
       self._PrintLine('', -1)
 
+  def BeginTemplate(self):
+    category_path = self.config['win_category_path']
+    self._AddGuiString(self.config['win_supported_os'],
+                       self.messages['win_supported_winxpsp2']['text'])
+    if self.config['build'] == 'chrome':
+      self._AddGuiString(category_path[0], 'Google')
+      self._AddGuiString(category_path[1], self.config['app_name'])
+      self.indent = '      '
+    elif self.config['build'] == 'chromium':
+      self._AddGuiString(category_path[0], self.config['app_name'])
+      self.indent = '    '
+    # After this, all the policies will be written into self.lines. The header
+    # and footer of the template will be added in self.EndTemplates().

[Jakob Kummerow, 2011/01/24 16:52:28]

nit: self.EndTemplate()

[gfeher, 2011/01/25 10:42:21]

Done.

+
+  def EndTemplate(self):
+    # Save the list of policies.
+    policies = self.lines
+    self.lines = []
+    self.indent = ''
+    policy_class = self.config['win_group_policy_class'].upper()
+    if policy_class in ('BOTH', 'MACHINE'):
+      self._WriteTemplateForClass('MACHINE', policies)
+    if policy_class in ('BOTH', 'USER'):
+      self._WriteTemplateForClass('USER', policies)
+
   def Init(self):
-    self.policy_list = []
-    self.str_list = ['[Strings]']
+    self.lines = []
+    self.strings = ['[Strings]']
     self.indent = ''
 
   def GetTemplateText(self):
-    lines = self.policy_list + self.str_list
+    lines = self.lines + self.strings
     return self.NEWLINE.join(lines)