// Copyright (c) 2005-2009 Jay Berkenbilt
//
// This file is part of qpdf.  This software may be distributed under
// the terms of version 2 of the Artistic License which may be found
// in the source distribution.  It is provided "as is" without express
// or implied warranty.

#ifndef __QUTIL_HH__
#define __QUTIL_HH__

#include <qpdf/DLL.hh>
#include <string>
#include <list>
#include <stdexcept>
#include <stdio.h>
#include <sys/stat.h>

namespace QUtil
{
    // This is a collection of useful utility functions that don't
    // really go anywhere else.
    DLL_EXPORT
    std::string int_to_string(int, int length = 0);
    DLL_EXPORT
    std::string double_to_string(double, int decimal_places = 0);

    // Throw std::runtime_error with a string formed by appending to
    // "description: " the standard string corresponding to the
    // current value of errno.
    DLL_EXPORT
    void throw_system_error(std::string const& description);

    // The status argument is assumed to be the return value of a
    // standard library call that sets errno when it fails.  If status
    // is -1, convert the current value of errno to a
    // std::runtime_error that includes the standard error string.
    // Otherwise, return status.
    DLL_EXPORT
    int os_wrapper(std::string const& description, int status);

    // The FILE* argument is assumed to be the return of fopen.  If
    // null, throw std::runtime_error.  Otherwise, return the FILE*
    // argument.
    DLL_EXPORT
    FILE* fopen_wrapper(std::string const&, FILE*);

    DLL_EXPORT
    char* copy_string(std::string const&);

    // Set stdin, stdout to binary mode
    DLL_EXPORT
    void binary_stdout();
    DLL_EXPORT
    void binary_stdin();

    // May modify argv0
    DLL_EXPORT
    char* getWhoami(char* argv0);

    // Get the value of an environment variable in a portable fashion.
    // Returns true iff the variable is defined.  If `value' is
    // non-null, initializes it with the value of the variable.
    DLL_EXPORT
    bool get_env(std::string const& var, std::string* value = 0);

    DLL_EXPORT
    time_t get_current_time();

    // Return a string containing the byte representation of the UTF-8
    // encoding for the unicode value passed in.
    DLL_EXPORT
    std::string toUTF8(unsigned long uval);
};

#endif // __QUTIL_HH__