Add optional mandatory policy setting for template generation

grit/format/policy_templates/writers/doc_writer.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.
 
 
 import json
 from xml.dom import minidom
 from grit import lazy_re
 from grit.format.policy_templates.writers import xml_formatted_writer
@@ skipping 162 matching lines @@
     Args:
       parent: The DOM node for which the example will be added.
       policy: A policy of type 'list', for which the Windows example value
         is generated.
     '''
     example_value = policy['example_value']
     self.AddElement(parent, 'dt', {}, 'Windows:')
     win = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
     win_text = []
     cnt = 1
-    key_name = self.config['win_reg_mandatory_key_name']
+    if self.CanBeRecommended(policy) and not self.CanBeMandatory(policy):
+      key_name = self.config['win_reg_recommended_key_name']
+    else:
+      key_name = self.config['win_reg_mandatory_key_name']
     for item in example_value:
       win_text.append(
           '%s\\%s\\%d = "%s"' %
           (key_name, policy['name'], cnt, item))
       cnt = cnt + 1
     self.AddText(win, '\n'.join(win_text))
 
   def _AddListExampleLinux(self, parent, policy):
     '''Adds an example value for Linux of a 'list' policy to a DOM node.
 
@@ skipping 86 matching lines @@
   def _AddDictionaryExampleWindows(self, parent, policy):
     '''Adds an example value for Windows of a 'dict' policy to a DOM node.
 
     Args:
       parent: The DOM node for which the example will be added.
       policy: A policy of type 'dict', for which the Windows example value
         is generated.
     '''
     self.AddElement(parent, 'dt', {}, 'Windows:')
     win = self._AddStyledElement(parent, 'dd', ['.monospace', '.pre'])
-    key_name = self.config['win_reg_mandatory_key_name']
+    if self.CanBeRecommended(policy) and not self.CanBeMandatory(policy):
+      key_name = self.config['win_reg_recommended_key_name']
+    else:
+      key_name = self.config['win_reg_mandatory_key_name']
     example = json.dumps(policy['example_value'])
     self.AddText(win, '%s\\%s = %s' % (key_name, policy['name'], example))
 
   def _AddDictionaryExampleLinux(self, parent, policy):
     '''Adds an example value for Linux of a 'dict' policy to a DOM node.
 
     Args:
       parent: The DOM node for which the example will be added.
       policy: A policy of type 'dict', for which the Linux example value
         is generated.
@@ skipping 151 matching lines @@
 
     dl = self.AddElement(parent, 'dl')
     data_type = self._TYPE_MAP[policy['type']]
     if (self.IsPolicySupportedOnPlatform(policy, 'win') and
         self._REG_TYPE_MAP.get(policy['type'], None)):
       data_type += ' (%s)' % self._REG_TYPE_MAP[policy['type']]
     self._AddPolicyAttribute(dl, 'data_type', data_type)
     if policy['type'] != 'external':
       # All types except 'external' can be set through platform policy.
       if self.IsPolicySupportedOnPlatform(policy, 'win'):
+        if self.CanBeRecommended(policy) and not self.CanBeMandatory(policy):
+          key_name = self.config['win_reg_recommended_key_name']
+        else:
+          key_name = self.config['win_reg_mandatory_key_name']
         self._AddPolicyAttribute(
             dl,
             'win_reg_loc',
-            self.config['win_reg_mandatory_key_name'] + '\\' + policy['name'],
+            key_name + '\\' + policy['name'],
             ['.monospace'])
       if (self.IsPolicySupportedOnPlatform(policy, 'linux') or
           self.IsPolicySupportedOnPlatform(policy, 'mac')):
         self._AddPolicyAttribute(
             dl,
             'mac_linux_pref_name',
             policy['name'],
             ['.monospace'])
     dd = self._AddPolicyAttribute(dl, 'supported_on')
     self._AddSupportedOnList(dd, policy['supported_on'])
@@ skipping 201 matching lines @@
     }
 
     # A simple regexp to search for URLs. It is enough for now.
     self._url_matcher = lazy_re.compile('(http://[^\\s]*[^\\s\\.])')
 
   def GetTemplateText(self):
     # Return the text representation of the main <div> tag.
     return self._main_div.toxml()
     # To get a complete HTML file, use the following.
     # return self._doc.toxml()