tempname.h

Go to the documentation of this file.

// -*- mode: c++; tab-width: 4; indent-tabs-mode: t; c-file-style: "stroustrup"; -*-
// vi:set ts=4 sts=4 sw=4 noet :
// Copyright 2008, 2012, The TPIE development team
// 
// This file is part of TPIE.
// 
// TPIE is free software: you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License as published by the
// Free Software Foundation, either version 3 of the License, or (at your
// option) any later version.
// 
// TPIE 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 Lesser General Public
// License for more details.
// 
// You should have received a copy of the GNU Lesser General Public License
// along with TPIE.  If not, see <http://www.gnu.org/licenses/>


#ifndef _TPIE_TEMPNAM_H
#define _TPIE_TEMPNAM_H

// Get definitions for working with Unix and Windows
#include <tpie/portability.h>
#include <tpie/stats.h>
#include <stdexcept>
#include <boost/utility.hpp>
// The name of the environment variable pointing to a tmp directory.
#define TMPDIR_ENV "TMPDIR"

// The name of the environment variable to consult for default device
// descriptions.
#define AMI_SINGLE_DEVICE_ENV "AMI_SINGLE_DEVICE"

namespace tpie {

    struct tempfile_error: public std::runtime_error {
        explicit tempfile_error(const std::string & what): std::runtime_error(what) {}
    };

    class tempname {
    public:
        static std::string tpie_name(const std::string& post_base = "",
                                     const std::string& dir = "",
                                     const std::string& ext = "");

        static std::string tpie_dir_name(const std::string& post_base = "",
                                         const std::string& dir = "");

        static std::string get_system_path();

        static void set_default_path(const std::string& path, const std::string& subdir="");

        static void set_default_base_name(const std::string& name);

        static void set_default_extension(const std::string& ext);

        static const std::string& get_default_path();

        static const std::string& get_default_base_name();

        static const std::string& get_default_extension();


        static std::string get_actual_path();
    };

    class temp_file : boost::noncopyable {
    private:
        std::string m_path;
        bool m_persist;
        stream_size_type m_recordedSize;
    public:
        inline bool is_persistent() const {return m_persist;}

        inline void set_persistent(bool p) {m_persist=p;}

        temp_file(const std::string & path, bool persist=false);

        void set_path(const std::string & path, bool persist=false);

        void update_recorded_size(stream_size_type size) {
            increment_temp_file_usage(static_cast<stream_offset_type>(size)-
                                      static_cast<stream_offset_type>(m_recordedSize));
            m_recordedSize=size;
            
        }

        temp_file();

        ~temp_file();

        const std::string & path();

        void free();
    };
    
}

#endif // _TPIE_TEMPNAM_H