tests/test_common/keyboard_report_util.cpp

   1 /* Copyright 2017 Fred Sundvik
   2  *
   3  * This program is free software: you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation, either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17  #include "keyboard_report_util.hpp"
  18  #include <vector>
  19  #include <algorithm>
  20  using namespace testing;
  21
  22  namespace
  23  {
  24      std::vector<uint8_t> get_keys(const report_keyboard_t& report) {
  25         std::vector<uint8_t> result;
  26         #if defined(NKRO_ENABLE)
  27         #error NKRO support not implemented yet
  28         #elif defined(USB_6KRO_ENABLE)
  29         #error 6KRO support not implemented yet
  30         #else
  31         for(size_t i=0; i<KEYBOARD_REPORT_KEYS; i++) {
  32             if (report.keys[i]) {
  33                 result.emplace_back(report.keys[i]);
  34             }
  35         }
  36         #endif
  37         std::sort(result.begin(), result.end());
  38         return result;
  39      }
  40  }
  41
  42 bool operator==(const report_keyboard_t& lhs, const report_keyboard_t& rhs) {
  43     auto lhskeys = get_keys(lhs);
  44     auto rhskeys = get_keys(rhs);
  45     return lhs.mods == rhs.mods && lhskeys == rhskeys;
  46 }
  47
  48 std::ostream& operator<<(std::ostream& stream, const report_keyboard_t& value) {
  49     stream << "Keyboard report:" << std::endl;
  50     stream << "Mods: " << (uint32_t)value.mods << std::endl;
  51     stream << "Keys: ";
  52     // TODO: This should probably print friendly names for the keys
  53     for (uint32_t k: get_keys(value)) {
  54         stream << k << " ";
  55     }
  56     stream << std::endl;
  57     return stream;
  58 }
  59
  60 KeyboardReportMatcher::KeyboardReportMatcher(const std::vector<uint8_t>& keys) {
  61     memset(m_report.raw, 0, sizeof(m_report.raw));
  62     for (auto k: keys) {
  63         if (IS_MOD(k)) {
  64             m_report.mods |= MOD_BIT(k);
  65         }
  66         else {
  67             add_key_to_report(&m_report, k);
  68         }
  69     }
  70 }
  71
  72 bool KeyboardReportMatcher::MatchAndExplain(report_keyboard_t& report, MatchResultListener* listener) const {
  73     return m_report == report;
  74 }
  75
  76 void KeyboardReportMatcher::DescribeTo(::std::ostream* os) const {
  77     *os << "is equal to " << m_report;
  78 }
  79
  80 void KeyboardReportMatcher::DescribeNegationTo(::std::ostream* os) const {
  81     *os << "is not equal to " << m_report;
  82 }