Dev/define cmd (#1312)

* basic ctb config api for register and bit names

* tests for define and definelist pass. yet to implement using them for reg, setbit, clearbit and getbit

* improved autocomplete for getbit,setbit, clearbit

* validate autocomplete

* definelist has no put

* updating help

* converting char array+int in runtimeerror compiles but throws at runtime.Fixed.Tested for it. Also check if string or int before using getregisterdefinitonbyvalue to see if it threw to call the other function. because both of it can throw and we should differentiate the issues for both

* removed std::vector<std::pair<string,int> to std::map<string, int> for defiitions list

* Dev/define cmd tie bit to reg (#1328)

* strong type

* moved everythign to bit_utils class

* pybindings

* added tests for python

* removed duplicates

* removed bit names in reg

* changed BitPosition to BitAddress

* Using define reg/bit from python (#1344)

* define_bit, define_addr in python. 
* setBit/clearBit takes int or addr

* added example using bits

* split define into 2 commands define_reg and define_bit, definelist into 2: definelist_reg and definelist_bit

* allow string for register and bit names in c++ api

* refactor from github comments

* naming refactoring (getRegisterDefnition to retunr name and address specifically

* added marker for 8 cmd tests connected to define, changed macro to static constexpr

* changed bitPosition from int to uint32_t

* got rid of setbitposition and setaddress, instead overloaded constructor to take in strings so that the conversion from string to bit address members, takes place within the class for easy maintainance in case type changes

* Removing implicit conversions:
RegisterAddresss and RegisterValue: Removed the implicit conversions.
RegisterAddress: Changed member name from address_ to value_ and method as well to value().
RegisterValue: Also added | operator to be able to concatenate with uint32_t. Same in python bindings (but could not find the tests to modify

* Allowed concatenation with other RegisterValue, made them all constexpr

* fix a ctbConfig test

* Maponstack works with integration tests, but need unit tests

* tests on mapstack

* fixed ctb tests and FixedString being initialized with gibberish

* removing parsing from string inside the class RegisterAddress, BitAddress and RegisterValue

* updated python bindings

* fixed bit utils test

* renaming getRegisterDefintiionAddress/Name=>getRegisterAddress/Name and similary for getBitDefinitionAddress/Name

* updated python bindings

* fix tests (format)

* a few python tests added and python bindings corrected

* replaceing str with __str__ for bit.cpp

* repr reimplemented for bit.cpp

* removed make with registerAddress etc

* starting server for tests per session and nor module

* killprocess throws if no process found-> github runs fails, changed to pkill and not throw

* clean shm shouldnt raise, in ci binary not found

* ignoring these tests for CI, which fail on CI because simulators are not generated in CI. This is in another PR, where it should work

---------

Co-authored-by: Erik Fröjdh <erik.frojdh@gmail.com>
Co-authored-by: froejdh_e <erik.frojdh@psi.ch>

slsSupportLib/src/bit_utils.cpp

@@ -0,0 +1,42 @@
+// SPDX-License-Identifier: LGPL-3.0-or-other
+// Copyright (C) 2021 Contributors to the SLS Detector Package
+#include "sls/bit_utils.h"
+#include "sls/ToString.h"
+#include "sls/sls_detector_exceptions.h"
+
+namespace sls {
+
+std::string RegisterAddress::str() const { return ToStringHex(value_); }
+
+BitAddress::BitAddress(RegisterAddress address, uint32_t bitPosition)
+    : addr_(address) {
+    if (bitPosition > 31) {
+        throw RuntimeError("Bit position must be between 0 and 31.");
+    }
+    bitPos_ = bitPosition;
+}
+
+std::string BitAddress::str() const {
+    std::ostringstream os;
+    os << '[' << addr_.str() << ", " << ToString(bitPos_) << ']';
+    return os.str();
+}
+
+std::string RegisterValue::str() const { return ToStringHex(value_); }
+
+std::ostream &operator<<(std::ostream &os, const RegisterAddress &r) {
+    os << r.str();
+    return os;
+}
+
+std::ostream &operator<<(std::ostream &os, const BitAddress &r) {
+    os << r.str();
+    return os;
+}
+
+std::ostream &operator<<(std::ostream &os, const RegisterValue &r) {
+    os << r.str();
+    return os;
+}
+
+} // namespace sls

slsSupportLib/src/file_utils.cpp

@@ -256,24 +256,22 @@ std::string getAbsolutePathFromCurrentProcess(const std::string &fname) {
         return fname;
     }
 
-    //in case PATH_MAX defines the longest possible path on linux and macOS
-    //use string instead of char array to avoid overflow
-    std::string path(PATH_MAX, '\0'); 
+    // in case PATH_MAX defines the longest possible path on linux and macOS
+    // use string instead of char array to avoid overflow
+    std::string path(PATH_MAX, '\0');
 
-
-    #if defined(__APPLE__)
+#if defined(__APPLE__)
     uint32_t size = PATH_MAX;
     if (_NSGetExecutablePath(path.data(), &size) != 0) {
         throw std::runtime_error("Failed to get executable path");
     }
     // Resolve any symlinks and .. components
-    std::string resolved(PATH_MAX, '\0'); 
+    std::string resolved(PATH_MAX, '\0');
     if (!realpath(path.data(), resolved.data())) {
         throw std::runtime_error("realpath failed for executable");
     }
     path = resolved;
-    #else
-
+#else
 
     ssize_t len = readlink("/proc/self/exe", path.data(), PATH_MAX - 1);
     if (len < 0) {
@@ -281,7 +279,7 @@ std::string getAbsolutePathFromCurrentProcess(const std::string &fname) {
     }
     path[len] = '\0';
 
-    #endif
+#endif
 
     // get dir path and attach file name
     std::string absPath = (std::string(dirname(path.data())) + '/' + fname);

slsSupportLib/src/network_utils.cpp

@@ -179,8 +179,7 @@ IpAddr InterfaceNameToIp(const std::string &ifn) {
 MacAddr InterfaceNameToMac(const std::string &inf) {
 
 #ifdef __APPLE__
-    throw RuntimeError(
-        "InterfaceNameToMac not implemented on macOS yet");
+    throw RuntimeError("InterfaceNameToMac not implemented on macOS yet");
 #else
 
     // TODO! Copied from genericSocket needs to be refactored!

slsSupportLib/src/string_utils.cpp

@@ -43,6 +43,15 @@ bool is_int(const std::string &s) {
                          }) == s.end();
 }
 
+bool is_hex_or_dec_uint(const std::string &s) {
+    try {
+        StringTo<uint32_t>(s);
+        return true;
+    } catch (...) {
+    }
+    return false;
+}
+
 bool replace_first(std::string *s, const std::string &substr,
                    const std::string &repl) {
     auto pos = s->find(substr);