include/ignition/common/Util.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Open Source Robotics Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
*/
#ifndef IGNITION_COMMON_UTIL_HH_
#define IGNITION_COMMON_UTIL_HH_

#include <cassert>
#include <chrono>
#include <future>
#include <memory>
#include <string>
#include <thread>
#include <vector>

#include <ignition/common/Export.hh>
#include <ignition/common/Filesystem.hh>
#include <ignition/common/SystemPaths.hh>
#include <ignition/common/URI.hh>

// Defines

#ifdef _WIN32
# define IGN_HOMEDIR "USERPROFILE"
#else
# define IGN_HOMEDIR "HOME"
#endif

#define IGN_NANO_TO_SEC 1e-9

#define IGN_SEC_TO_NANO 1000000000

#define IGN_MS_TO_NANO 1000000

#define IGN_US_TO_NANO 1000

#define IGN_SPEED_OF_LIGHT = 299792458.0

#define IGN_SLEEP_S(_s) (std::this_thread::sleep_for(\
                         std::chrono::seconds(_s)))

#define IGN_SLEEP_US(_us) (std::this_thread::sleep_for(\
                           std::chrono::microseconds(_us)))

#define IGN_SLEEP_MS(_ms) (std::this_thread::sleep_for(\
                           std::chrono::milliseconds(_ms)))

#define IGN_SLEEP_NS(_ns) (std::this_thread::sleep_for(\
                           std::chrono::nanoseconds(_ns)))

#define IGN_SYSTEM_TIME() (std::chrono::system_clock::now())

#define IGN_SYSTEM_TIME_S() (std::chrono::duration_cast<std::chrono::seconds>(\
      std::chrono::system_clock::now().time_since_epoch()).count())

#define IGN_SYSTEM_TIME_US() (\
    std::chrono::duration_cast<std::chrono::microseconds>(\
      std::chrono::system_clock::now().time_since_epoch()).count())

#define IGN_SYSTEM_TIME_MS() (\
    std::chrono::duration_cast<std::chrono::milliseconds>(\
      std::chrono::system_clock::now().time_since_epoch()).count())

#define IGN_SYSTEM_TIME_NS() (\
    std::chrono::duration_cast<std::chrono::nanoseconds>(\
      std::chrono::system_clock::now().time_since_epoch()).count())

#define IGN_ASSERT(_expr, _msg) assert((_msg, _expr))

namespace ignition
{
  namespace common
  {
    enum NodeTransformType {TRANSLATE, ROTATE, SCALE, MATRIX};

    typedef std::runtime_error exception;

    std::string IGNITION_COMMON_VISIBLE systemTimeISO();

    std::string IGNITION_COMMON_VISIBLE systemTimeIso();

    std::string IGNITION_COMMON_VISIBLE timeToIso(
        const std::chrono::time_point<std::chrono::system_clock> &_time);

    std::string IGNITION_COMMON_VISIBLE logPath();

    void IGNITION_COMMON_VISIBLE addSearchPathSuffix(
        const std::string &_suffix);

    std::string IGNITION_COMMON_VISIBLE findFile(const std::string &_file);

    std::string IGNITION_COMMON_VISIBLE findFile(const std::string &_file,
                         bool _searchLocalPath);

    std::string IGNITION_COMMON_VISIBLE findFilePath(const std::string &_file);

    void IGNITION_COMMON_VISIBLE addFindFileURICallback(
        std::function<std::string(const URI &)> _cb);

    common::SystemPaths IGNITION_COMMON_VISIBLE *systemPaths();

    template<typename T>
    std::string sha1(const T &_buffer);

    std::string IGNITION_COMMON_VISIBLE sha1(
        void const *_buffer, std::size_t _byteCount);

    constexpr uint64_t IGNITION_COMMON_VISIBLE hash64(std::string_view _key)
    {
      const char *data = _key.data();
      const auto len = _key.size();
      const uint64_t prime = 0x100000001b3;
      uint64_t hash = 0xcbf29ce484222325;

      for (auto i = 0u; i < len; ++i)
      {
        uint8_t value = static_cast<uint8_t>(data[i]);
        hash = hash ^ value;
        hash *= prime;
      }

      return hash;
    }

    bool IGNITION_COMMON_VISIBLE env(
        const std::string &_name, std::string &_value);

    bool IGNITION_COMMON_VISIBLE env(
        const std::string &_name, std::string &_value,
        bool _allowEmpty);

    bool IGNITION_COMMON_VISIBLE setenv(
        const std::string &_name, const std::string &_value);

    bool IGNITION_COMMON_VISIBLE unsetenv(const std::string &_name);

    std::string IGNITION_COMMON_VISIBLE uuid();

    std::vector<std::string> IGNITION_COMMON_VISIBLE split(
        const std::string &_str, const std::string &_delim);

    void IGNITION_COMMON_VISIBLE ltrim(std::string &_s);

    void IGNITION_COMMON_VISIBLE rtrim(std::string &_s);

    void IGNITION_COMMON_VISIBLE trim(std::string &_s);

    std::string IGNITION_COMMON_VISIBLE ltrimmed(std::string _s);

    std::string IGNITION_COMMON_VISIBLE rtrimmed(std::string _s);

    std::string IGNITION_COMMON_VISIBLE trimmed(std::string _s);

    std::string IGNITION_COMMON_VISIBLE lowercase(const std::string &_in);

    std::string IGNITION_COMMON_VISIBLE lowercase(const char *_in);

    void IGNITION_COMMON_VISIBLE replaceAll(std::string &_result,
        const std::string &_orig,
        const std::string &_key,
        const std::string &_replacement);

    std::string IGNITION_COMMON_VISIBLE replaceAll(const std::string &_orig,
        const std::string &_key,
        const std::string &_replacement);
  }
}

// Implementation of get_sha1
template<typename T>
std::string ignition::common::sha1(const T &_buffer)
{
  if (_buffer.size() == 0)
    return ignition::common::sha1(NULL, 0);
  else
  {
    return ignition::common::sha1(
        &(_buffer[0]), _buffer.size() * sizeof(_buffer[0]));
  }
}
#endif