Added PermissionIDSet to APIPermissions

extensions/common/permissions/api_permission_set.h

 // Copyright 2013 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.
 
 #ifndef EXTENSIONS_COMMON_PERMISSIONS_API_PERMISSION_SET_H_
 #define EXTENSIONS_COMMON_PERMISSIONS_API_PERMISSION_SET_H_
 
 
 #include "extensions/common/permissions/api_permission.h"
 #include "extensions/common/permissions/base_set_operators.h"
 
 namespace base {
 class ListValue;
 }  // namespace base
 
 namespace extensions {
 
+class APIPermissionSet;
 class Extension;
-class APIPermissionSet;
+class PermissionIDSet;
 
 template<>
 struct BaseSetOperatorsTraits<APIPermissionSet> {
   typedef APIPermission ElementType;
   typedef APIPermission::ID ElementIDType;
 };
 
 class APIPermissionSet : public BaseSetOperators<APIPermissionSet> {
  public:
   enum ParseSource {
@@ skipping 23 matching lines @@
   static bool ParseFromJSON(
       const base::ListValue* permissions,
       ParseSource source,
       APIPermissionSet* api_permissions,
       base::string16* error,
       std::vector<std::string>* unhandled_permissions);
 
   void AddImpliedPermissions();
 };
 
+// An ID representing a single permission that belongs to an app or extension.
+//
+// Each PermissionID has a required ID to identify the permission. For most
+// permissions, this is all.

[Yoyo Zhou, 2014/12/11 00:54:11]

nit: "this is all" is easy to misread. Maybe "there is nothing more"?

[sashab, 2014/12/11 04:15:36]

Yeah... Couldn't think of a better way to say this. Changed to 'For most
permissions, this is all they have.'

+//
+// Some more complex permissions have a parameter, which acts like an argument
+// for the permission. For example, host permissions might have the ID
+// kReadOnlyHost and the argument 'www.google.com' (the host which is
+// read-only). Parameters are passed to the permission message rules for this
+// permission, so they can affect the displayed message.
+//
+// TODO(sashab): Move this to the same file as PermissionIDSet once that moves
+// to its own file.
+class PermissionID : public std::pair<APIPermission::ID, base::string16> {
+ public:
+  PermissionID(APIPermission::ID id);
+  PermissionID(APIPermission::ID id, const base::string16& parameter);
+  virtual ~PermissionID();
+
+  const APIPermission::ID& id() const { return this->first; }
+  const base::string16& parameter() const { return this->second; }
+};
+
 // A set of permissions for an app or extension. Used for passing around groups
 // of permissions, such as required or optional permissions. Has convenience
 // constructors so that it can be constructed inline.
 //
 // Each permission can also store a string, such as a hostname or device number,
 // as a parameter that helps identify the permission. This parameter can then
 // be used when the permission message is generated. For example, the permission
 // kHostReadOnly might have the parameter "google.com", which means that the app
 // or extension has the permission to read the host google.com. This parameter
 // may then be included in the permission message when it is generated later.
 //
 // Example:
 //   // Create a PermissionIDSet.
 //   PermissionIDSet p(APIPermission::kBluetooth, APIPermission::kFavicon);
 //   // Add a permission to the set.
 //   p.insertPermission(APIPermission::kNetworkState);
 //   // Add a permission with a detail to the set.
 //   p.insertPermission(APIPermission::kHostReadOnly,
 //           base::ASCIIToUTF16("http://www.google.com"));
 //
 // TODO(sashab): Move this to its own file and rename it to PermissionSet after
 // APIPermission is removed, the current PermissionSet is no longer used, and
 // APIPermission::ID is the only type of Permission ID.
-typedef std::pair<APIPermission::ID, base::string16> PermissionID;
+// TODO(sashab): Change BaseSetOperators to support storing plain objects
+// instead of pointers and change this to extend BaseSetOperators<PermissionID>.
 class PermissionIDSet {
  public:
   PermissionIDSet();
   virtual ~PermissionIDSet();
 
   // Convenience constructors for inline initialization.
   PermissionIDSet(APIPermission::ID permission_one);
   PermissionIDSet(APIPermission::ID permission_one,
                   APIPermission::ID permission_two);
   PermissionIDSet(APIPermission::ID permission_one,
                   APIPermission::ID permission_two,
                   APIPermission::ID permission_three);
   PermissionIDSet(APIPermission::ID permission_one,
                   APIPermission::ID permission_two,
                   APIPermission::ID permission_three,
                   APIPermission::ID permission_four);
+  PermissionIDSet(APIPermission::ID permission_one,
+                  APIPermission::ID permission_two,
+                  APIPermission::ID permission_three,
+                  APIPermission::ID permission_four,
+                  APIPermission::ID permission_five);
+  PermissionIDSet(APIPermission::ID permission_one,
+                  APIPermission::ID permission_two,
+                  APIPermission::ID permission_three,
+                  APIPermission::ID permission_four,
+                  APIPermission::ID permission_five,
+                  APIPermission::ID permission_six);
 
   // Adds the given permission, and an optional permission detail, to the set.
-  void insert(APIPermission::ID permission);
-  void insert(APIPermission::ID permission, base::string16 permission_detail);
+  void insert(APIPermission::ID permission_id);
+  void insert(APIPermission::ID permission_id,
+              base::string16 permission_parameter);

[Yoyo Zhou, 2014/12/11 00:54:11]

nit: Why rename this from detail? "detail" still appears in the comments for
this class/function, so make them consistent.

[sashab, 2014/12/11 04:15:36]

'parameter' now matches the name in PermissionID, which is exactly what its used
for. Changed the comments; good find.

 
  private:
-  std::set<PermissionID> permissions;
+  std::set<PermissionID> permissions_;
 };
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_COMMON_PERMISSIONS_API_PERMISSION_SET_H_