Do a cpplint and clang-tidy pass

This only touches files in src/ but not its subdirectories.

README.md

@@ -30,7 +30,7 @@
 
 ```bash
 sudo apt install \
-    pkg-config fcitx5 libfcitx5core-dev libfcitx5config-dev libfcitx5utils-dev fcitx5-modules-dev\
+    pkg-config fcitx5 libfcitx5core-dev libfcitx5config-dev libfcitx5utils-dev fcitx5-modules-dev \
     cmake extra-cmake-modules gettext libfmt-dev libicu-dev libjson-c-dev
 ```
 

src/CMakeLists.txt

@@ -4,7 +4,7 @@ project(mcbopomofo VERSION 2.5.2)
 find_package(PkgConfig REQUIRED)
 find_package(Fcitx5Core REQUIRED)
 find_package(Fcitx5Utils REQUIRED)
-#find_package(Fcitx5Module REQUIRED COMPONENTS Notifications)
+find_package(Fcitx5Module REQUIRED COMPONENTS Notifications)
 find_package(fmt REQUIRED)
 find_package(Gettext REQUIRED)
 find_package(ICU COMPONENTS uc i18n REQUIRED)

src/DictionaryService.cpp

@@ -1,3 +1,26 @@
+// Copyright (c) 2024 and onwards The McBopomofo Authors.
+//
+// Permission is hereby granted, free of charge, to any person
+// obtaining a copy of this software and associated documentation
+// files (the "Software"), to deal in the Software without
+// restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following
+// conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
 #include "DictionaryService.h"
 
 #include <fcitx-utils/i18n.h>

src/DictionaryService.h

@@ -1,10 +1,34 @@
 
-#ifndef FCITX5_MCBOPOMOFO_DICTIONARYSERVICE_H
-#define FCITX5_MCBOPOMOFO_DICTIONARYSERVICE_H
+// Copyright (c) 2024 and onwards The McBopomofo Authors.
+//
+// Permission is hereby granted, free of charge, to any person
+// obtaining a copy of this software and associated documentation
+// files (the "Software"), to deal in the Software without
+// restriction, including without limitation the rights to use,
+// copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the
+// Software is furnished to do so, subject to the following
+// conditions:
+//
+// The above copyright notice and this permission notice shall be
+// included in all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+// OTHER DEALINGS IN THE SOFTWARE.
+
+#ifndef SRC_DICTIONARYSERVICE_H_
+#define SRC_DICTIONARYSERVICE_H_
 
 #include <functional>
 #include <memory>
 #include <string>
+#include <vector>
 
 #include "InputState.h"
 
@@ -18,7 +42,7 @@ using StateCallback =
  */
 class DictionaryService {
  public:
-  virtual ~DictionaryService(){};
+  virtual ~DictionaryService() = default;
 
   virtual std::string name() const = 0;
   virtual void lookup(std::string phrase, InputState* state,
@@ -58,4 +82,4 @@ class DictionaryServices {
 
 }  // namespace McBopomofo
 
-#endif  // FCITX5_MCBOPOMOFO_DICTIONARYSERVICE_H
+#endif  // SRC_DICTIONARYSERVICE_H_

src/InputMacro.cpp

@@ -45,6 +45,9 @@ std::string FormatTimeZone(icu::TimeZone::EDisplayType type);
 int GetCurrentYear();
 std::string GetGanzhi(int year);
 std::string GetChineseZodiac(int year);
+std::string ConvertWeekdayUnit(std::string original);
+void AddMacro(std::unordered_map<std::string, std::unique_ptr<InputMacro>>& m,
+              std::unique_ptr<InputMacro> p);
 }  // namespace
 
 class InputMacroDate : public InputMacro {
@@ -353,13 +356,6 @@ class InputMacroNextYearJapanese : public InputMacroYear {
       : InputMacroYear("MACRO@NEXT_YEAR_JAPANESE", "japanese", 1, "Gy") {}
 };
 
-std::string convertWeekdayUnit(std::string& original) {
-  // s/星期/禮拜/
-  std::string src = "星期";
-  std::string dst = "禮拜";
-  return original.replace(original.find(src), src.length(), dst);
-}
-
 class InputMacroWeekdayTodayShort : public InputMacroDayOfTheWeek {
  public:
   InputMacroWeekdayTodayShort()
@@ -378,7 +374,7 @@ class InputMacroWeekdayToday2 : public InputMacroDayOfTheWeek {
       : InputMacroDayOfTheWeek("MACRO@DATE_TODAY2_WEEKDAY", "", 0, "EEEE") {}
   [[nodiscard]] std::string replacement() const override {
     std::string original(InputMacroDayOfTheWeek::replacement());
-    return convertWeekdayUnit(original);
+    return ConvertWeekdayUnit(original);
   }
 };
 
@@ -410,7 +406,7 @@ class InputMacroWeekdayYesterday2 : public InputMacroDayOfTheWeek {
                                "EEEE") {}
   [[nodiscard]] std::string replacement() const override {
     std::string original(InputMacroDayOfTheWeek::replacement());
-    return convertWeekdayUnit(original);
+    return ConvertWeekdayUnit(original);
   }
 };
 
@@ -440,7 +436,7 @@ class InputMacroWeekdayTomorrow2 : public InputMacroDayOfTheWeek {
       : InputMacroDayOfTheWeek("MACRO@DATE_TOMORROW2_WEEKDAY", "", 1, "EEEE") {}
   [[nodiscard]] std::string replacement() const override {
     std::string original(InputMacroDayOfTheWeek::replacement());
-    return convertWeekdayUnit(original);
+    return ConvertWeekdayUnit(original);
   }
 };
 
@@ -512,12 +508,6 @@ class InputMacroNextYearChineseZodiac : public InputMacroZodiac {
       : InputMacroZodiac("MACRO@NEXT_YEAR_CHINESE_ZODIAC", 1) {}
 };
 
-static void AddMacro(
-    std::unordered_map<std::string, std::unique_ptr<InputMacro>>& m,
-    std::unique_ptr<InputMacro> p) {
-  m.insert({p->name(), std::move(p)});
-}
-
 InputMacroController::InputMacroController() {
   AddMacro(macros_, std::make_unique<InputMacroDateTodayShort>());
   AddMacro(macros_, std::make_unique<InputMacroDateTodayMedium>());
@@ -702,6 +692,18 @@ std::string GetChineseZodiac(int year) {
   return gan[ganIndex] + zhi[zhiIndex] + "年";
 }
 
+std::string ConvertWeekdayUnit(std::string original) {
+  // s/星期/禮拜/
+  std::string src = "星期";
+  std::string dst = "禮拜";
+  return original.replace(original.find(src), src.length(), dst);
+}
+
+void AddMacro(std::unordered_map<std::string, std::unique_ptr<InputMacro>>& m,
+              std::unique_ptr<InputMacro> p) {
+  m.insert({p->name(), std::move(p)});
+}
+
 }  // namespace
 
 }  // namespace McBopomofo

src/InputMode.h

@@ -30,4 +30,4 @@ enum class InputMode { McBopomofo, PlainBopomofo };
 
 }
 
-#endif  // SRC_INPUTMODE_H_
+#endif  // SRC_INPUTMODE_H_

src/InputState.cpp

@@ -49,4 +49,4 @@ InputStates::SelectingDateMacro::SelectingDateMacro(
   }
 }
 
-}  // namespace McBopomofo
+}  // namespace McBopomofo

src/Key.h

@@ -53,8 +53,8 @@ struct Key {
   const bool shiftPressed;
   const bool ctrlPressed;
 
-  Key(char c = 0, KeyName n = KeyName::UNKNOWN, bool isShift = false,
-      bool isCtrl = false)
+  explicit Key(char c = 0, KeyName n = KeyName::UNKNOWN, bool isShift = false,
+               bool isCtrl = false)
       : ascii(c), name(n), shiftPressed(isShift), ctrlPressed(isCtrl) {}
 
   static Key asciiKey(char c, bool shiftPressed = false,
@@ -65,15 +65,18 @@ struct Key {
   static Key namedKey(KeyName name, bool shiftPressed = false,
                       bool ctrlPressed = false) {
     return Key(0, name, shiftPressed, ctrlPressed);
-  };
+  }
+
   // Regardless of the shift state.
-  bool isCursorKeys() {
+  [[nodiscard]] bool isCursorKeys() const {
     return name == KeyName::LEFT || name == KeyName::RIGHT ||
            name == KeyName::HOME || name == KeyName::END;
   }
 
   // Regardless of the shift state.
-  bool isDeleteKeys() { return ascii == BACKSPACE || ascii == DELETE; }
+  [[nodiscard]] bool isDeleteKeys() const {
+    return ascii == BACKSPACE || ascii == DELETE;
+  }
 };
 
 }  // namespace McBopomofo

src/KeyHandler.cpp

@@ -43,6 +43,7 @@ constexpr char kHalfWidthPunctuationKeyPrefix[] = "_half_punctuation_";
 constexpr char kLetterPrefix[] = "_letter_";
 constexpr size_t kMinValidMarkingReadingCount = 2;
 constexpr size_t kMaxValidMarkingReadingCount = 6;
+constexpr size_t kMaxChineseNumberConversionDigits = 20;
 
 constexpr int kUserOverrideModelCapacity = 500;
 constexpr double kObservedOverrideHalfLife = 5400.0;  // 1.5 hr.
@@ -121,7 +122,7 @@ bool KeyHandler::handle(Key key, McBopomofo::InputState* state,
     return true;
   }
 
-  auto chineseNumber = dynamic_cast<InputStates::ChineseNumber*>(state);
+  auto* chineseNumber = dynamic_cast<InputStates::ChineseNumber*>(state);
   if (chineseNumber != nullptr) {
     return handleChineseNumber(key, chineseNumber, stateCallback,
                                errorCallback);
@@ -953,7 +954,7 @@ bool KeyHandler::handleChineseNumber(
     return true;
   }
   if (key.ascii >= '0' && key.ascii <= '9') {
-    if (state->number.length() > 20) {
+    if (state->number.length() > kMaxChineseNumberConversionDigits) {
       errorCallback();
       return true;
     }
@@ -966,7 +967,8 @@ bool KeyHandler::handleChineseNumber(
       errorCallback();
       return true;
     }
-    if (state->number.empty() || state->number.length() > 20) {
+    if (state->number.empty() ||
+        state->number.length() > kMaxChineseNumberConversionDigits) {
       errorCallback();
       return true;
     }