<doc, refactor>(ci): Tidy up code in gpg/function

1. Rename related entities.
2. Add a comments.

1 files changed, 84 insertions, 0 deletions

diff --git a/src/gpg/function/UIDOperator.h b/src/gpg/function/UIDOperator.h
new file mode 100644
index 00000000..a68fb0e9
--- /dev/null
+++ b/src/gpg/function/UIDOperator.h
@@ -0,0 +1,84 @@
+/**
+ * This file is part of GpgFrontend.
+ *
+ * GpgFrontend is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Foobar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Foobar.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ * The initial version of the source code is inherited from gpg4usb-team.
+ * Their source code version also complies with GNU General Public License.
+ *
+ * The source code version of this software was modified and released
+ * by Saturneric<[email protected]> starting on May 12, 2021.
+ *
+ */
+
+#ifndef GPGFRONTEND_ZH_CN_TS_UIDOPERATOR_H
+#define GPGFRONTEND_ZH_CN_TS_UIDOPERATOR_H
+
+#include "gpg/GpgContext.h"
+#include "gpg/GpgModel.h"
+
+namespace GpgFrontend {
+/**
+ * @brief
+ *
+ */
+class UIDOperator : public SingletonFunctionObject<UIDOperator> {
+ public:
+  explicit UIDOperator(
+      int channel = SingletonFunctionObject::GetDefaultChannel())
+      : SingletonFunctionObject<UIDOperator>(channel) {}
+
+  /**
+   * create a new uid in certain key pair
+   * @param key target key pair
+   * @param uid uid args(combine name&comment&email)
+   * @return if successful
+   */
+  bool AddUID(const GpgKey& key, const std::string& uid);
+
+  /**
+   * create a new uid in certain key pair
+   * @param key target key pair
+   * @param name
+   * @param comment
+   * @param email
+   * @return
+   */
+  bool AddUID(const GpgKey& key, const std::string& name,
+              const std::string& comment, const std::string& email);
+
+  /**
+   * Revoke(Delete) UID from certain key pair
+   * @param key target key pair
+   * @param uid target uid
+   * @return if successful
+   */
+  bool RevUID(const GpgKey& key, const std::string& uid);
+
+  /**
+   * Set one of a uid of a key pair as primary
+   * @param key target key pair
+   * @param uid target uid
+   * @return if successful
+   */
+  bool SetPrimaryUID(const GpgKey& key, const std::string& uid);
+
+ private:
+  GpgContext& ctx_ =
+      GpgContext::GetInstance(SingletonFunctionObject::GetChannel());  ///<
+};
+
+}  // namespace GpgFrontend
+
+#endif  // GPGFRONTEND_ZH_CN_TS_UIDOPERATOR_H