DevTools: pass title when creating settings

third_party/WebKit/Source/devtools/front_end/common/Settings.js

 /*
  * Copyright (C) 2009 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 35 matching lines @@
     /** @type {!Map<string, !Common.Setting>} */
     this._moduleSettings = new Map();
     self.runtime.extensions('setting').forEach(this._registerModuleSetting.bind(this));
   }
 
   /**
    * @param {!Runtime.Extension} extension
    */
   _registerModuleSetting(extension) {
     var descriptor = extension.descriptor();
+    var title = descriptor['title'];
     var settingName = descriptor['settingName'];
     var settingType = descriptor['settingType'];
     var defaultValue = descriptor['defaultValue'];
     var isLocal = !!descriptor['local'];
-    var setting = settingType === 'regex' ? this.createRegExpSetting(settingName, defaultValue, undefined, isLocal) :
-                                            this.createSetting(settingName, defaultValue, isLocal);
+    var isRegex = settingType === 'regex';
+    var setting = isRegex ? this.createRegExpSetting(settingName, defaultValue, undefined, isLocal, title) :
+                            this.createSetting(settingName, defaultValue, isLocal, title);
     this._moduleSettings.set(settingName, setting);
   }
 
   /**
    * @param {string} settingName
    * @return {!Common.Setting}
    */
   moduleSetting(settingName) {
     var setting = this._moduleSettings.get(settingName);
     if (!setting)
       throw new Error('No setting registered: ' + settingName);
     return setting;
   }
 
   /**
    * @param {string} settingName
    * @return {!Common.Setting}
    */
   settingForTest(settingName) {
     var setting = this._registry.get(settingName);
     if (!setting)
       throw new Error('No setting registered: ' + settingName);
     return setting;
   }
 
   /**
    * @param {string} key
    * @param {*} defaultValue
    * @param {boolean=} isLocal
+   * @param {string=} title
    * @return {!Common.Setting}
    */
-  createSetting(key, defaultValue, isLocal) {
+  createSetting(key, defaultValue, isLocal, title) {

[pfeldman, 2017/02/07 20:10:28]

Unfortunately, this makes all the users that want to use title think about
whether it should be local. Let's add setTitle to the setting.

[luoe, 2017/02/13 06:27:19]

Done.

     if (!this._registry.get(key)) {
-      this._registry.set(
-          key, new Common.Setting(
-                   this, key, defaultValue, this._eventSupport, isLocal ? this._localStorage : this._settingsStorage));
+      var setting = new Common.Setting(
+          this, key, defaultValue, this._eventSupport, isLocal ? this._localStorage : this._settingsStorage, title);
+      this._registry.set(key, setting);
     }
     return /** @type {!Common.Setting} */ (this._registry.get(key));
   }
 
   /**
    * @param {string} key
    * @param {*} defaultValue
+   * @param {string=} title
    * @return {!Common.Setting}
    */
-  createLocalSetting(key, defaultValue) {
-    return this.createSetting(key, defaultValue, true);
+  createLocalSetting(key, defaultValue, title) {
+    return this.createSetting(key, defaultValue, true, title);
   }
 
   /**
    * @param {string} key
    * @param {string} defaultValue
    * @param {string=} regexFlags
    * @param {boolean=} isLocal
+   * @param {string=} title
    * @return {!Common.RegExpSetting}
    */
-  createRegExpSetting(key, defaultValue, regexFlags, isLocal) {
+  createRegExpSetting(key, defaultValue, regexFlags, isLocal, title) {
     if (!this._registry.get(key)) {
-      this._registry.set(
-          key, new Common.RegExpSetting(
-                   this, key, defaultValue, this._eventSupport, isLocal ? this._localStorage : this._settingsStorage,
-                   regexFlags));
+      var setting = new Common.RegExpSetting(
+          this, key, defaultValue, this._eventSupport, isLocal ? this._localStorage : this._settingsStorage, regexFlags,
+          title);
+      this._registry.set(key, setting);
     }
     return /** @type {!Common.RegExpSetting} */ (this._registry.get(key));
   }
 
   clearAll() {
     this._settingsStorage.removeAll();
     this._localStorage.removeAll();
     var versionSetting = Common.settings.createSetting(Common.VersionController._currentVersionName, 0);
     versionSetting.set(Common.VersionController.currentVersion);
   }
@@ skipping 83 matching lines @@
  * @template V
  * @unrestricted
  */
 Common.Setting = class {
   /**
    * @param {!Common.Settings} settings
    * @param {string} name
    * @param {V} defaultValue
    * @param {!Common.Object} eventSupport
    * @param {!Common.SettingsStorage} storage
+   * @param {string=} title
    */
-  constructor(settings, name, defaultValue, eventSupport, storage) {
+  constructor(settings, name, defaultValue, eventSupport, storage, title) {
     this._settings = settings;
     this._name = name;
     this._defaultValue = defaultValue;
     this._eventSupport = eventSupport;
     this._storage = storage;
+    this._title = title;
   }
 
   /**
    * @param {function(!Common.Event)} listener
    * @param {!Object=} thisObject
    */
   addChangeListener(listener, thisObject) {
     this._eventSupport.addEventListener(this._name, listener, thisObject);
   }
 
   /**
    * @param {function(!Common.Event)} listener
    * @param {!Object=} thisObject
    */
   removeChangeListener(listener, thisObject) {
     this._eventSupport.removeEventListener(this._name, listener, thisObject);
   }
 
   get name() {
     return this._name;
   }
 
   /**
+   * @return {string|undefined}
+   */
+  title() {
+    return this._title;
+  }
+
+  /**
    * @return {V}
    */
   get() {
     if (typeof this._value !== 'undefined')
       return this._value;
 
     this._value = this._defaultValue;
     if (this._storage.has(this._name)) {
       try {
         this._value = JSON.parse(this._storage.get(this._name));
@@ skipping 46 matching lines @@
  * @unrestricted
  */
 Common.RegExpSetting = class extends Common.Setting {
   /**
    * @param {!Common.Settings} settings
    * @param {string} name
    * @param {string} defaultValue
    * @param {!Common.Object} eventSupport
    * @param {!Common.SettingsStorage} storage
    * @param {string=} regexFlags
+   * @param {string=} title
    */
-  constructor(settings, name, defaultValue, eventSupport, storage, regexFlags) {
-    super(settings, name, defaultValue ? [{pattern: defaultValue}] : [], eventSupport, storage);
+  constructor(settings, name, defaultValue, eventSupport, storage, regexFlags, title) {
+    super(settings, name, defaultValue ? [{pattern: defaultValue}] : [], eventSupport, storage, title);
     this._regexFlags = regexFlags;
   }
 
   /**
    * @override
    * @return {string}
    */
   get() {
     var result = [];
     var items = this.getAsArray();
@@ skipping 429 matching lines @@
   return Common.settings.moduleSetting(settingName);
 };
 
 /**
  * @param {string} settingName
  * @return {!Common.Setting}
  */
 Common.settingForTest = function(settingName) {
   return Common.settings.settingForTest(settingName);
 };