string_utilities.h

Go to the documentation of this file.

// *****************************************************************************
//
// © Copyright 2020, Septentrio NV/SA.
// 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.
//
// *****************************************************************************

#ifndef STRING_UTILITIES_H
#define STRING_UTILITIES_H

// C and C++ library includes
#include <cstdint>
#include <locale> // Merely for "isdigit()" function, also available in <cctype.h> C header..
#include <string>

#ifdef __cplusplus
extern "C" {
#endif

namespace string_utilities {
    bool toDouble(const std::string& string, double& value);

    bool toFloat(const std::string& string, float& value);

    bool toInt32(const std::string& string, int32_t& value, int32_t base = 10);

    bool toUInt32(const std::string& string, uint32_t& value, int32_t base = 10);

    int8_t toInt8(const std::string& string, int8_t& value, int32_t base = 10);

    uint8_t toUInt8(const std::string& string, uint8_t& value, int32_t base = 10);

    std::string trimDecimalPlaces(double num);

    bool containsSpace(const std::string str);
} // namespace string_utilities

#ifdef __cplusplus
}
#endif

#endif // STRING_UTILITIES_H