BasicStringAlg.hpp

//============================================================================
//
// This file is part of the Thea toolkit.
//
// This software is distributed under the BSD license, as detailed in the
// accompanying LICENSE.txt file. Portions are derived from other works:
// their respective licenses and copyright information are reproduced in
// LICENSE.txt and/or in the relevant source files.
//
// Author: Siddhartha Chaudhuri
// First version: 2013
//
//============================================================================

/*
 ORIGINAL HEADER

 @file stringutils.h

 @maintainer Morgan McGuire, http://graphics.cs.williams.edu

 @author  2000-09-09
 @edited  2010-03-05
*/

#ifndef __Thea_BasicStringAlg_hpp_
#define __Thea_BasicStringAlg_hpp_

#include "Platform.hpp"
#include <cctype>
#include <cstdarg>
#include <string>

namespace Thea {

extern THEA_API char const * NEWLINE;

inline std::string
toString(char const * s)
{
  return std::string(s ? s : "");
}

inline intx
findFirstSlash(std::string const & f, intx start = 0)
{
  size_t pos = f.find_first_of("/\\", (size_t)start);
  return (pos == std::string::npos ? -1 : (intx)pos);
}

inline intx
findLastSlash(std::string const & f, intx start = -1)
{
  if (start == -1)
    start = (intx)f.length() - 1;

  size_t pos = f.find_last_of("/\\", (size_t)start);
  return (pos == std::string::npos ? -1 : (intx)pos);
}

THEA_API bool beginsWith(std::string const & test, std::string const & pattern);

THEA_API bool endsWith(std::string const & test, std::string const & pattern);

THEA_API std::string wordWrap(std::string const & input, intx num_cols, char const * newline = NEWLINE);

THEA_API std::string toUpper(std::string const & s);

THEA_API std::string toLower(std::string const & s);

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

inline bool
isWhitespace(char c)
{
  return std::isspace(c) != 0;
}

inline bool
isNewline(char c)
{
  return (c == '\n') || (c == '\r');
}

inline bool
isDigit(char c)
{
  return std::isdigit(c) != 0;
}

inline bool
isAlpha(char c)
{
  return std::isalpha(c) != 0;
}

inline bool
isSlash(char c)
{
  return (c == '\\') || (c == '/');
}

inline bool
isQuote(char c)
{
  return (c == '\'') || (c == '\"');
}

#ifdef __GNUC__
#  define THEA_CHECK_PRINTF_ARGS          __attribute__((__format__(__printf__, 1, 2)))
#  define THEA_CHECK_VPRINTF_ARGS         __attribute__((__format__(__printf__, 1, 0)))
#  define THEA_CHECK_MEMBER_PRINTF_ARGS   __attribute__((__format__(__printf__, 2, 3)))
#  define THEA_CHECK_MEMBER_VPRINTF_ARGS  __attribute__((__format__(__printf__, 2, 0)))
#else
#  define THEA_CHECK_PRINTF_ARGS
#  define THEA_CHECK_VPRINTF_ARGS
#  define THEA_CHECK_MEMBER_PRINTF_ARGS
#  define THEA_CHECK_MEMBER_VPRINTF_ARGS
#endif

THEA_API std::string THEA_CDECL format(char const * fmt, ...) THEA_CHECK_PRINTF_ARGS;

THEA_API std::string vformat(char const * fmt, va_list arg_ptr) THEA_CHECK_VPRINTF_ARGS;

} // namespace Thea

#endif