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/intrusive_ptr.hpp>
#include <string>
 // 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 bool try_directory(const std::string& path, const std::string& subdir="");

        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();
    };

    void finish_tempfile();

    namespace bits {
    
    class temp_file_inner {
    public:
        temp_file_inner();
        temp_file_inner(const temp_file_inner & o) = delete;
        temp_file_inner(temp_file_inner && o) = delete;
        temp_file_inner & operator=(const temp_file_inner & o) = delete;
        temp_file_inner & operator=(temp_file_inner && o) = delete;
        
        temp_file_inner(const std::string & path, bool persist);
        ~temp_file_inner();

        const std::string & path();
        void update_recorded_size(stream_size_type size);

        bool is_persistent() const {
            return m_persist;
        }

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

        friend void intrusive_ptr_add_ref(temp_file_inner * p);
        friend void intrusive_ptr_release(temp_file_inner * p);

    private:
        std::string m_path;
        bool m_persist;
        stream_size_type m_recordedSize;
        memory_size_type m_count;           
    };

    void intrusive_ptr_add_ref(temp_file_inner * p);
    void intrusive_ptr_release(temp_file_inner * p);

    } // namespace bits

    class temp_file {
    public:
        temp_file() {
            m_inner = new bits::temp_file_inner();
        }

        temp_file(const std::string & path, bool persist=false) {
            m_inner = new bits::temp_file_inner(path, persist);
        }

        bool is_persistent() const {
            return m_inner->is_persistent();
        }

        void set_persistent(bool p) {
            m_inner->set_persistent(p);
        }

        void set_path(const std::string & path, bool persist=false) {
            m_inner = new bits::temp_file_inner(path, persist);
        }

        const std::string & path() {
            return m_inner->path();
        }

        void free() {
            m_inner = new bits::temp_file_inner();
        }

        void update_recorded_size(stream_size_type size) {
            m_inner->update_recorded_size(size);
        }
    private:
        boost::intrusive_ptr<bits::temp_file_inner> m_inner;
    };
    
}

#endif // _TPIE_TEMPNAM_H