include/cinder/Utilities.h

Go to the documentation of this file.

/*
 Copyright (c) 2010, The Barbarian Group
 All rights reserved.

 Redistribution and use in source and binary forms, with or without modification, are permitted provided that
 the following conditions are met:

    * Redistributions of source code must retain the above copyright notice, this list of conditions and
    the following disclaimer.
    * 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.

 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.
*/

#pragma once

#include <string>
#include <vector>
#include "cinder/Cinder.h"
#include "cinder/Url.h"
#include "cinder/DataSource.h"
#undef check
#include <boost/lexical_cast.hpp>

namespace cinder {

fs::path expandPath( const fs::path &path );
fs::path getHomeDirectory();
fs::path getDocumentsDirectory();
fs::path getTemporaryDirectory();
fs::path getTemporaryFilePath( const std::string &prefix = "" );
std::string getPathDirectory( const std::string &path );
std::string getPathFileName( const std::string &path );
std::string getPathExtension( const std::string &path );
bool createDirectories( const fs::path &path, bool createParents = true );

void launchWebBrowser( const Url &url );
    
void deleteFile( const fs::path &path );

std::vector<std::string> split( const std::string &str, char separator, bool compress = true );
std::vector<std::string> split( const std::string &str, const std::string &separators, bool compress = true );

std::string loadString( DataSourceRef dataSource );

std::wstring toUtf16( const std::string &utf8 );
std::string toUtf8( const std::wstring &utf16 );

void sleep( float milliseconds );

#if defined( CINDER_MSW )
inline char getPathSeparator() { return '\\'; }
#else
inline char getPathSeparator() { return '/'; }
#endif

template<typename T>
inline std::string toString( const T &t ) { return boost::lexical_cast<std::string>( t ); }
template<typename T>
inline T fromString( const std::string &s ) { return boost::lexical_cast<T>( s ); }
// This specialization seems to only be necessary with more recent versions of Boost
template<>
inline Url fromString( const std::string &s ) { return Url( s ); }

std::vector<std::string> stackTrace();

// ENDIANNESS
inline int8_t   swapEndian( int8_t val ) { return val; }
inline uint8_t  swapEndian( uint8_t val ) { return val; }
extern int16_t  swapEndian( int16_t val );
extern uint16_t swapEndian( uint16_t val );
extern int32_t  swapEndian( int32_t val );
extern uint32_t swapEndian( uint32_t val );
extern float    swapEndian( float val );
extern double   swapEndian( double val );

extern void swapEndianBlock( uint16_t *blockPtr, size_t blockSizeInBytes );
extern void swapEndianBlock( float *blockPtr, size_t blockSizeInBytes );

} // namespace cinder