StringUtils.H

Go to the documentation of this file.

//========================================================================
// MinVR
// Platform:    Any
// API version: 1.0
//------------------------------------------------------------------------
// The MIT License (MIT)
//
// Copyright (c) 2013 Regents of the University of Minnesota
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
//========================================================================


#ifndef STRINGUTILS_H
#define STRINGUTILS_H

#include <glm/glm.hpp>
#include <vector>
#include <boost/log/trivial.hpp>
#include <boost/filesystem.hpp>
#include <boost/filesystem/fstream.hpp>
#define BOOST_ASSERT_MSG_OSTREAM std::cout
#include <boost/assert.hpp>

// Can be used to get a quoted version of the value of a particular #define
#define DEFINE_TO_QUOTED_STR( d ) #d

namespace MinVR {


std::vector<std::string> splitStringIntoArray(const std::string &in);

std::string decygifyPath(const std::string &in);


std::string replaceEnvVars(const std::string &in);

unsigned int hashCode(const double d);

// Vector2
std::ostream & operator<< ( std::ostream &os, const glm::vec2 &vec2);
std::istream & operator>> ( std::istream &is, glm::vec2 &vec2);
// Vector3
std::ostream & operator<< ( std::ostream &os, const glm::vec3 &vec3);
std::istream & operator>> ( std::istream &is, glm::vec3 &vec3);
// Vector4
std::ostream & operator<< ( std::ostream &os, const glm::vec4 &vec4);
std::istream & operator<< ( std::istream &is, glm::vec4 &vec4);

// Matrix3
std::ostream & operator<< ( std::ostream &os, const glm::mat3 &m);
std::istream & operator>> ( std::istream &is, glm::mat3 &m);
// Matrix4
std::ostream & operator<< ( std::ostream &os, const glm::mat4 &m);
std::istream & operator>> ( std::istream &is, glm::mat4 &m);
// etc.. add on as necessary..

std::string  intToString(int i);
int          stringToInt(const std::string &in);

std::string  realToString(double r);
double       stringToReal(const std::string &in);



bool  popNextToken(std::string &in, std::string &token, 
                   bool returnFalseOnSemiColon = false);


bool  popUntilSemicolon(std::string &in, std::string &popped);

std::vector< std::vector< std::string > >  readDelimitedData(const std::string &csvString,
                                                 const std::string &delimiter,
                                                 bool removeQuotes=true);

std::string   joinIntoString(const std::vector<std::string>& in,
                             const std::string& delimiter=std::string(" ")); 

std::string  convertNewlinesAndTabsToSpaces(std::string input);

int  iMinNonNeg(int i1, int i2);


template <class T>
static inline bool retypeString(const std::string &str, T &val) {
  std::istringstream is(str.c_str());
  is >> val;
  if (!is) {
          BOOST_LOG_TRIVIAL(error) << "Error retyping string: " <<str
          return false;
  }
  else return true;
}


std::string spacesString(int num);

int numSubstringOccurances(const std::string &str, const std::string &substr);

int findNth(const std::string &str, const std::string &substr, const int n);

template <class T>
std::vector<T> insertIntoArray(std::vector<T> inputArray, T newElement, 
                         int insertBeforeElementNum) 
{
        debugAssert(insertBeforeElementNum >= 0);
        debugAssert(insertBeforeElementNum <= inputArray.size());

        std::vector<T> anew;
  
        for (int i=0;i<insertBeforeElementNum;i++)
        anew.push_back(inputArray[i]);
  
        anew.push_back(newElement);

        for (int i=insertBeforeElementNum;i<inputArray.size();i++)
        anew.push_back(inputArray[i]);
  
        debugAssert(anew.size() == (inputArray.size() + 1));
        return anew;
}

std::string trimWhitespace(const std::string& s);

std::string readWholeFile(const std::string& filename);

} // end namespace
#endif