safeOutputFile.h

Go to the documentation of this file.

//
// Copyright 2017 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_BASE_TF_SAFE_OUTPUT_FILE_H
#define PXR_BASE_TF_SAFE_OUTPUT_FILE_H
 
 
#include "pxr/pxr.h"
#include "pxr/base/tf/api.h"
 
#include <cstdio>
#include <memory>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
class TfSafeOutputFile
{
    TfSafeOutputFile(TfSafeOutputFile const &) = delete;
    TfSafeOutputFile &operator=(TfSafeOutputFile const &) = delete;
public:
    TfSafeOutputFile() = default;
 
    TfSafeOutputFile(TfSafeOutputFile &&other)
        : _file(other._file)
        , _targetFileName(std::move(other._targetFileName))
        , _tempFileName(std::move(other._tempFileName))
        { other._file = nullptr; }
 
    TfSafeOutputFile &operator=(TfSafeOutputFile &&other) {
        _file = other._file;
        _targetFileName = std::move(other._targetFileName);
        _tempFileName = std::move(other._tempFileName);
        other._file = nullptr;
        return *this;
    }
 
    TF_API ~TfSafeOutputFile();
 
    TF_API static TfSafeOutputFile Update(std::string const &fileName);
 
    TF_API static TfSafeOutputFile Replace(std::string const &fileName);
 
    TF_API void Close();
 
    TF_API void Discard();
 
    FILE *Get() const { return _file; }
    
    TF_API FILE *ReleaseUpdatedFile();
 
    TF_API bool IsOpenForUpdate() const;
 
private:
    FILE *_file = nullptr;
    std::string _targetFileName;
    std::string _tempFileName;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_BASE_TF_SAFE_OUTPUT_FILE_H