futils.hpp

Go to the documentation of this file.

// ********************************************************* -*- C++ -*-
/*
 * Copyright (C) 2004-2018 Exiv2 authors
 * This program is part of the Exiv2 distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
 */
#ifndef FUTILS_HPP_
#define FUTILS_HPP_

#include "exiv2lib_export.h"
#include "config.h"

#include <string>

// namespace extensions
namespace Exiv2
{
    enum EnVar
    {
        envHTTPPOST = 0,
        envTIMEOUT = 1
    };
    enum Protocol
    {
        pFile = 0,
        pHttp,
        pFtp,
        pHttps,
        pSftp,
        pSsh,
        pFileUri,
        pDataUri,
        pStdin
    };
    // *********************************************************************
    // free functions
    EXIV2API std::string getEnv(int env_var);

    EXIV2API std::string urlencode(const char* str);

    EXIV2API char* urldecode(const char* str);

    EXIV2API void urldecode(std::string& str);

    EXIV2API int base64encode(const void* data_buf, size_t dataLength, char* result, size_t resultSize);

    EXIV2API long base64decode(const char* in, char* out, size_t out_size);

    EXIV2API Protocol fileProtocol(const std::string& path);

#ifdef EXV_UNICODE_PATH

    EXIV2API Protocol fileProtocol(const std::wstring& wpath);
#endif

    EXIV2API bool fileExists(const std::string& path, bool ct = false);

#ifdef EXV_UNICODE_PATH

    EXIV2API bool fileExists(const std::wstring& wpath, bool ct = false);
#endif

    EXIV2API std::string pathOfFileUrl(const std::string& url);

#ifdef EXV_UNICODE_PATH

    EXIV2API std::wstring pathOfFileUrl(const std::wstring& wurl);
#endif

    EXIV2API std::string strError();

    EXIV2API std::string getProcessPath();

    class Uri
    {
    public:
        // DATA
        std::string QueryString;  
        std::string Path;         
        std::string Protocol;     
        std::string Host;         
        std::string Port;         
        std::string Username;     
        std::string Password;     

        static Uri EXIV2API Parse(const std::string& uri);

        static void EXIV2API Decode(Uri& uri);
    };

}  // namespace Exiv2

#endif // #ifndef FUTILS_HPP_