FS_StaleUSDFiles.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * NAME:        FS_StaleUSDFiles.h (FS Library, C++)
 *
 * COMMENTS:
 */

#ifndef __FS_StaleUSDFiles__
#define __FS_StaleUSDFiles__

#include "FS_API.h"
#include "FS_Info.h"
#include <UT/UT_StringHolder.h>
#include <UT/UT_StringArray.h>

/// Houdini generates temporary files in $HOUDINI_TEMP/usd_renders.  If a
/// process crashes or doesn't clean up properly, there can be stale files left
/// dangling.
///
/// These are convenience functions for dealing with these temporary files.
namespace FS_StaleUSDFiles
{
    /// Clean up any stale USD files, returning the list of files in the
    /// removed array.  If the function fails to remove a file, the filename
    /// will be added to the @c error_files.
    ///
    /// The @c dry_run boolean lets you call the function without actually
    /// making changes to the file system.  Files which would be removed are
    /// returned in the @c removed list.
    ///
    /// The file returns @c true if there were stale files detected.
    FS_API bool cleanup(UT_StringArray &removed,
                        UT_StringArray &error_files,
                        exint &memory_freed,
                        bool dry_run,
                        const char *override_path = nullptr);
};

#endif