change function prefix to *sftk_* - which follows common patterns - 3 to 4 chars, all lowercase

Author: gigapod

src/sfeTk/sfeToolkit.cpp

@@ -32,7 +32,7 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 /**
  * @brief C function - Runtime check for system byte order
  */
-sfeTKByteOrder sfeTk_system_byteorder(void)
+sfeTKByteOrder sftk_system_byteorder(void)
 {
     uint16_t i = 1;
     return *((uint8_t *)&i) == 0 ? sfeTKByteOrder::BigEndian : sfeTKByteOrder::LittleEndian;
@@ -43,15 +43,15 @@ sfeTKByteOrder sfeTk_system_byteorder(void)
  * @brief to catch 8 bit calls for byte swap
  *
  */
-uint8_t sfeTk_byte_swap(uint8_t i)
+uint8_t sftk_byte_swap(uint8_t i)
 {
     return i;
 }
 //---------------------------------------------------------------------------------
 /**
  * @brief function - Byte swap a 16 bit value
  */
-uint16_t sfeTk_byte_swap(uint16_t i)
+uint16_t sftk_byte_swap(uint16_t i)
 {
     // Use the fast intrinsic if available
 #if defined(__clang__) || defined(__GNUC__)
@@ -65,7 +65,7 @@ uint16_t sfeTk_byte_swap(uint16_t i)
 /**
  * @brief function - Byte swap a 32 bit value
  */
-uint32_t sfeTk_byte_swap(uint32_t i)
+uint32_t sftk_byte_swap(uint32_t i)
 {
 #if defined(__clang__) || defined(__GNUC__)
     return __builtin_bswap32(i);

src/sfeTk/sfeToolkit.h

@@ -42,21 +42,21 @@ enum class sfeTKByteOrder : uint8_t
     LittleEndian = 0x02
 };
 
-// Use a namespace for the toolkit "utilities and helpers"
+// Note - toolkit *functions* start with sftk_ to avoid name collisions
 
 // Function to determine the byte order of the system
-sfeTKByteOrder sfeTk_system_byteorder(void);
+sfeTKByteOrder sftk_system_byteorder(void);
 
-uint8_t sfeTk_byte_swap(uint8_t i);
-uint16_t sfeTk_byte_swap(uint16_t i);
-uint32_t sfeTk_byte_swap(uint32_t i);
+uint8_t sftk_byte_swap(uint8_t i);
+uint16_t sftk_byte_swap(uint16_t i);
+uint32_t sftk_byte_swap(uint32_t i);
 
 
 // Area for platform specific implementations. The interface/functions are 
 // defined here, with the expectation that the platform provides the implementation.
 
 // delay in milliseconds
-void sfeTk_delay_ms(uint32_t ms);
+void sftk_delay_ms(uint32_t ms);
 
 // ticks in milliseconds
-uint32_t sfeTk_ticks_ms(void);
+uint32_t sftk_ticks_ms(void);

src/sfeTkArdI2C.cpp

@@ -210,7 +210,7 @@ sfeTkError_t sfeTkArdI2C::writeRegisterRegion(uint8_t devReg, const uint8_t *dat
 sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *data, size_t length)
 {
     // devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
-    devReg = sfeTk_byte_swap(devReg);
+    devReg = sftk_byte_swap(devReg);
     return writeRegisterRegionAddress((uint8_t *)&devReg, 2, data, length);
 }
 
@@ -224,11 +224,11 @@ sfeTkError_t sfeTkArdI2C::writeRegister16Region(uint16_t devReg, const uint8_t *
 sfeTkError_t sfeTkArdI2C::writeRegister16Region16(uint16_t devReg, const uint16_t *data, size_t length)
 {
     // if the system byte order is the same as the desired order, just send the buffer
-    if (sfeTk_system_byteorder() == _byteOrder)
+    if (sftk_system_byteorder() == _byteOrder)
         return writeRegisterRegionAddress((uint8_t *)&devReg, 2, (uint8_t *)data, length * 2);
 
     // okay, we need to swap
-    devReg = sfeTk_byte_swap(devReg);
+    devReg = sftk_byte_swap(devReg);
     // devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
     uint16_t data16[length];
     for (size_t i = 0; i < length; i++)
@@ -391,13 +391,13 @@ sfeTkError_t sfeTkArdI2C::readRegister16Region(uint16_t devReg, uint8_t *data, s
 sfeTkError_t sfeTkArdI2C::readRegister16Region16(uint16_t devReg, uint16_t *data, size_t numBytes, size_t &readWords)
 {
     // if the system byte order is the same as the desired order, flip the address
-    if (sfeTk_system_byteorder() != _byteOrder)
+    if (sftk_system_byteorder() != _byteOrder)
         devReg = ((devReg << 8) & 0xff00) | ((devReg >> 8) & 0x00ff);
 
     sfeTkError_t status = readRegisterRegionAnyAddress((uint8_t *)&devReg, 2, (uint8_t *)data, numBytes * 2, readWords);
 
     // Do we need to flip the byte order?
-    if (status == kSTkErrOk && sfeTk_system_byteorder() != _byteOrder)
+    if (status == kSTkErrOk && sftk_system_byteorder() != _byteOrder)
     {
         for (size_t i = 0; i < numBytes; i++)
             data[i] = ((data[i] << 8) & 0xff00) | ((data[i] >> 8) & 0x00ff);

src/sfeTkArduino.cpp

@@ -26,12 +26,12 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 // Implements the sfeToolkit functions for the Arduino platform
 
-void sfeTk_delay_ms(uint32_t ms)
+void sftk_delay_ms(uint32_t ms)
 {
     delay(ms);
 }
 
-uint32_t sfeTk_ticks_ms(void)
+uint32_t sftk_ticks_ms(void)
 {
     return millis();
 }