pystring.h

// Copyright (c) 2012 The Foundry Visionmongers Ltd. All Rights Reserved.

#ifndef INCLUDED_GEOLIB_PYSTRING_V1_H
#define INCLUDED_GEOLIB_PYSTRING_V1_H

#include <string>
#include <vector>

#include "pystring/ns.h"
#include "pystring/pystringAPI.h"

GEOLIB3_PYSTRING_NAMESPACE_ENTER
{




    #define MAX_32BIT_INT 2147483647

    PYSTRING_API std::string capitalize( const std::string & str );

    PYSTRING_API std::string center( const std::string & str, int width );

    PYSTRING_API int count( const std::string & str, const std::string & substr, int start = 0, int end = MAX_32BIT_INT);

    PYSTRING_API bool endswith( const std::string & str, const std::string & suffix, int start = 0, int end = MAX_32BIT_INT );

    PYSTRING_API std::string expandtabs( const std::string & str, int tabsize = 8);

    PYSTRING_API int find( const std::string & str, const std::string & sub, int start = 0, int end = MAX_32BIT_INT  );

    PYSTRING_API int index( const std::string & str, const std::string & sub, int start = 0, int end = MAX_32BIT_INT  );

    PYSTRING_API bool isalnum( const std::string & str );

    PYSTRING_API bool isalpha( const std::string & str );

    PYSTRING_API bool isdigit( const std::string & str );

    PYSTRING_API bool islower( const std::string & str );

    PYSTRING_API bool isspace( const std::string & str );

    PYSTRING_API bool istitle( const std::string & str );

    PYSTRING_API bool isupper( const std::string & str );

    PYSTRING_API std::string join( const std::string & str, const std::vector< std::string > & seq );

    PYSTRING_API std::string ljust( const std::string & str, int width );

    PYSTRING_API std::string lower( const std::string & str );

    PYSTRING_API std::string lstrip( const std::string & str, const std::string & chars = "" );

    PYSTRING_API std::string mul( const std::string & str, int n);

    PYSTRING_API void partition( const std::string & str, const std::string & sep, std::vector< std::string > & result );

    PYSTRING_API std::string replace( const std::string & str, const std::string & oldstr, const std::string & newstr, int count = -1);

    PYSTRING_API int rfind( const std::string & str, const std::string & sub, int start = 0, int end = MAX_32BIT_INT );

    PYSTRING_API int rindex( const std::string & str, const std::string & sub, int start = 0, int end = MAX_32BIT_INT );

    PYSTRING_API std::string rjust( const std::string & str, int width);

    PYSTRING_API void rpartition( const std::string & str, const std::string & sep, std::vector< std::string > & result );

    PYSTRING_API std::string rstrip( const std::string & str, const std::string & chars = "" );

    PYSTRING_API void split( const std::string & str, std::vector< std::string > & result, const std::string & sep = "", int maxsplit = -1);

    PYSTRING_API void rsplit( const std::string & str, std::vector< std::string > & result, const std::string & sep = "", int maxsplit = -1);

    PYSTRING_API void splitlines(  const std::string & str, std::vector< std::string > & result, bool keepends = false );

    PYSTRING_API bool startswith( const std::string & str, const std::string & prefix, int start = 0, int end = MAX_32BIT_INT );

    PYSTRING_API std::string strip( const std::string & str, const std::string & chars = "" );

    PYSTRING_API std::string swapcase( const std::string & str );

    PYSTRING_API std::string title( const std::string & str );

    PYSTRING_API std::string translate( const std::string & str, const std::string & table, const std::string & deletechars = "");

    PYSTRING_API std::string upper( const std::string & str );

    PYSTRING_API std::string zfill( const std::string & str, int width );

    PYSTRING_API std::string slice( const std::string & str, int start = 0, int end = MAX_32BIT_INT);



namespace os
{
#if defined(_WIN32)
    static const char* const sep = "\\";
    static const char* const pathsep = ";";
#else
    static const char* const sep = "/";
    static const char* const pathsep = ":";
#endif  // _WIN32

namespace path
{
    using os::sep;
    using os::pathsep;

    // The path manipulation function below have three versions.
    // Example:
    //   join(...)
    //   join_nt(...)
    //   join_posix(...)
    //
    // The regular function dispatches to the other versions - based on the OS
    // at compile time - to match the result you'd get from the python
    // interpreter on the same operating system
    //
    // Should you want to 'lock off' to a particular version of the string
    // manipulation across *all* operating systems, use the version with the
    // _OS you are interested in.  I.e., you can use posix style path joining,
    // even on Windows, with join_posix.
    //
    // The naming, (nt, posix) matches the cpython source implementation.



    PYSTRING_API std::string basename(const std::string & path);
    PYSTRING_API std::string basename_nt(const std::string & path);
    PYSTRING_API std::string basename_posix(const std::string & path);


    PYSTRING_API std::string dirname(const std::string & path);
    PYSTRING_API std::string dirname_nt(const std::string & path);
    PYSTRING_API std::string dirname_posix(const std::string & path);


    PYSTRING_API bool isabs(const std::string & path);
    PYSTRING_API bool isabs_nt(const std::string & path);
    PYSTRING_API bool isabs_posix(const std::string & s);


    PYSTRING_API std::string abspath(const std::string & path, const std::string & cwd);
    PYSTRING_API std::string abspath_nt(const std::string & path, const std::string & cwd);
    PYSTRING_API std::string abspath_posix(const std::string & path, const std::string & cwd);



    PYSTRING_API std::string join(const std::string & path1, const std::string & path2);
    PYSTRING_API std::string join_nt(const std::string & path1, const std::string & path2);
    PYSTRING_API std::string join_posix(const std::string & path1, const std::string & path2);

    PYSTRING_API std::string join(const std::vector< std::string > & paths);
    PYSTRING_API std::string join_nt(const std::vector< std::string > & paths);
    PYSTRING_API std::string join_posix(const std::vector< std::string > & paths);


    PYSTRING_API std::string normpath(const std::string & path);
    PYSTRING_API std::string normpath_nt(const std::string & path);
    PYSTRING_API std::string normpath_posix(const std::string & path);


    PYSTRING_API void split(std::string & head, std::string & tail, const std::string & path);
    PYSTRING_API void split_nt(std::string & head, std::string & tail, const std::string & path);
    PYSTRING_API void split_posix(std::string & head, std::string & tail, const std::string & path);


    PYSTRING_API void splitdrive(std::string & drivespec, std::string & pathspec, const std::string & path);
    PYSTRING_API void splitdrive_nt(std::string & drivespec, std::string & pathspec, const std::string & p);
    PYSTRING_API void splitdrive_posix(std::string & drivespec, std::string & pathspec, const std::string & path);


    PYSTRING_API void splitext(std::string & root, std::string & ext, const std::string & path);
    PYSTRING_API void splitext_nt(std::string & root, std::string & ext, const std::string & path);
    PYSTRING_API void splitext_posix(std::string & root, std::string & ext, const std::string & path);

    PYSTRING_API std::string expanduser(const std::string & path);

    class EnvironmentInterface;

    PYSTRING_API std::string expandvars(
        const std::string& path,
        EnvironmentInterface* environment = NULL);

    class PYSTRING_API EnvironmentInterface
    {
    public:
        virtual ~EnvironmentInterface()
        {
        }
        virtual bool getenv(const std::string& key,
                            std::string& result) const = 0;
    };

} // namespace path
} // namespace os

}
GEOLIB3_PYSTRING_NAMESPACE_EXIT

#endif  // INCLUDED_GEOLIB_PYSTRING_V1_H