Add StringExtras and KeyState class

Author: florianbecker

README.md

@@ -11,9 +11,11 @@ make -j`nproc`
 
 ## Classes
 - **CPU** - Get CPU informations.
-- **Double** - Less, Greater, Equal, Between, Round, Split.
+- **DoubleExtras** - Less, Greater, Equal, Between, Round, Split.
 - **Exec** - Run command and return stdout or mixed (stdout and stderr) and result code.
+- **KeyState** - Check for caps lock state.
 - **Serial** - Serial communication class.
+- **StringExtras** - LeftTrim, RightTrim, Trim.
 - **Timing** - Measering time, cpu and real time.
 
 ## Template classes

examples/double/main.cpp

@@ -32,7 +32,7 @@
 #include <iostream>
 
 /* modern.cpp.core header */
-#include <Double.h>
+#include <DoubleExtras.h>
 
 int main() {
 

source/CMakeLists.txt

@@ -34,12 +34,16 @@ add_library(${PROJECT_NAME}
   ../README.md
   CPU.cpp
   CPU.h
-  Double.cpp
-  Double.h
+  DoubleExtras.cpp
+  DoubleExtras.h
   Exec.cpp
   Exec.h
+  KeyState.cpp
+  KeyState.h
   Serial.cpp
   Serial.h
+  StringExtras.cpp
+  StringExtras.h
   Timing.cpp
   Timing.h
   templates/CSVWriter.h

source/Double.cpp source/DoubleExtras.cppsource/Double.cpp renamed to source/DoubleExtras.cpp

@@ -36,7 +36,7 @@
 #include <vector>
 
 /* local header */
-#include "Double.h"
+#include "DoubleExtras.h"
 
 namespace vx {
 

source/Double.h source/DoubleExtras.hsource/Double.h renamed to source/DoubleExtras.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifdef _WIN32
+  #include <Windows.h>
+#elif defined(__APPLE__)
+  #include <Carbon/Carbon.h>
+#endif
+
+/* local header */
+#include "KeyState.h"
+
+namespace vx {
+
+  bool KeyState::isCapsLockActive() {
+
+    bool isActive = false;
+
+#ifdef _WIN32
+    if ( GetKeyState( VK_CAPITAL ) & 0x0001 ) {
+
+      isActive = true;
+    }
+#elif __APPLE__
+
+#if 1
+    /* Variant 1 Carbon.framework */
+    KeyMap keyMap;
+    GetKeys( keyMap );
+
+    int index = kVK_CapsLock >> 5;
+    int shift = kVK_CapsLock & 31;
+
+    isActive = ( ( keyMap[ index ].bigEndianValue >> shift ) & 1 ) != 0;
+#else
+    /* Variant 2 CoreGraphics.framework */
+    isActive = CGEventSourceKeyState( kCGEventSourceStateHIDSystemState, kVK_CapsLock );
+#endif
+
+#endif
+    return isActive;
+  }
+}

source/KeyState.cpp

@@ -0,0 +1,40 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#pragma once
+
+namespace vx {
+
+  class KeyState {
+
+  public:
+    static bool isCapsLockActive();
+  };
+}

source/KeyState.h

@@ -0,0 +1,57 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* local header */
+#include "StringExtras.h"
+
+namespace vx {
+
+  constexpr auto trimmed = " \t\n\r\f\v";
+
+  std::string &stringRightTrim( std::string &_string,
+                                const std::string &_trim ) {
+
+    _string.erase( _string.find_last_not_of( _trim.empty() ? trimmed : _trim ) + 1 );
+    return _string;
+  }
+
+  std::string &stringLeftTrim( std::string &_string,
+                               const std::string &_trim ) {
+
+    _string.erase( 0, _string.find_first_not_of( _trim.empty() ? trimmed : _trim ) );
+    return _string;
+  }
+
+  std::string &stringTrim( std::string &_string,
+                           const std::string &_trim ) {
+
+    return stringLeftTrim( stringRightTrim( _string, _trim.empty() ? trimmed : _trim ), _trim.empty() ? trimmed : _trim );
+  }
+}

source/StringExtras.cpp

@@ -0,0 +1,47 @@
+/*
+ * Copyright (c) 2020 Florian Becker <[email protected]> (VX APPS).
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * 3. Neither the name of the copyright holder nor the names of its
+ *    contributors may be used to endorse or promote products derived from
+ *    this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+ * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+/* stl header */
+#include <string>
+
+namespace vx {
+
+  // trim from end of string (right)
+  std::string &stringRightTrim( std::string &_string,
+                                const std::string &_trim = {} );
+
+  // trim from beginning of string (left)
+  std::string &stringLeftTrim( std::string &_string,
+                               const std::string &_trim = {} );
+
+  // trim from both ends of string (right then left)
+  std::string &stringTrim( std::string &_string,
+                           const std::string &_trim = {} );
+}