usdaFileFormat.h

//
// Copyright 2016 Pixar
//
// Licensed under the terms set forth in the LICENSE.txt file available at
// https://openusd.org/license.
//
#ifndef PXR_USD_SDF_USDA_FILE_FORMAT_H
#define PXR_USD_SDF_USDA_FILE_FORMAT_H
 
#include "pxr/pxr.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/envSetting.h"
#include "pxr/base/tf/staticTokens.h"
#include "pxr/usd/sdf/api.h"
#include "pxr/usd/sdf/declareHandles.h" 
#include "pxr/usd/sdf/fileFormat.h"
#include "pxr/usd/sdf/fileVersion.h"
 
#include <iosfwd>
#include <string>
 
PXR_NAMESPACE_OPEN_SCOPE
 
SDF_API
extern TfEnvSetting<std::string> USD_WRITE_NEW_USDA_FILES_AS_VERSION;
 
#define SDF_USDA_FILE_FORMAT_TOKENS \
    ((Id,      "usda"))             \
    ((Version, "1.0"))
 
TF_DECLARE_PUBLIC_TOKENS(SdfUsdaFileFormatTokens, SDF_API, SDF_USDA_FILE_FORMAT_TOKENS);
 
TF_DECLARE_WEAK_AND_REF_PTRS(SdfUsdaFileFormat);
 
SDF_DECLARE_HANDLES(SdfSpec);
 
class ArAsset;
 
SDF_API
extern TfEnvSetting<int> SDF_TEXTFILE_SIZE_WARNING_MB;
 
class SdfUsdaFileFormat : public SdfFileFormat
{
public:
    // SdfFileFormat overrides.
    SDF_API
    virtual SdfAbstractDataRefPtr InitData(
        const FileFormatArguments& args) const override;
 
    SDF_API
    virtual bool CanRead(const std::string &file) const override;
 
    SDF_API
    virtual bool Read(
        SdfLayer* layer,
        const std::string& resolvedPath,
        bool metadataOnly) const override;
 
    SDF_API
    virtual bool WriteToFile(
        const SdfLayer& layer,
        const std::string& filePath,
        const std::string& comment = std::string(),
        const FileFormatArguments& args = FileFormatArguments()) const override;
 
    SDF_API
    virtual bool SaveToFile(
        const SdfLayer& layer,
        const std::string& filePath,
        const std::string& comment = std::string(),
        const FileFormatArguments& args = FileFormatArguments()) const override;
 
    SDF_API
    virtual bool ReadFromString(
        SdfLayer* layer,
        const std::string& str) const override;
 
    SDF_API
    virtual bool WriteToString(
        const SdfLayer& layer,
        std::string* str,
        const std::string& comment = std::string()) const override;
 
    SDF_API
    virtual bool WriteToStream(
        const SdfSpecHandle &spec,
        std::ostream& out,
        size_t indent) const override;
 
public:
 
    static SdfFileVersion GetMinInputVersion();
 
    static SdfFileVersion GetMinOutputVersion();
 
    static SdfFileVersion GetMaxInputVersion();
 
    static SdfFileVersion GetMaxOutputVersion();
 
    static SdfFileVersion GetDefaultOutputVersion();
 
 
protected:
    SDF_FILE_FORMAT_FACTORY_ACCESS;
 
    SDF_API
    virtual ~SdfUsdaFileFormat();
 
    SDF_API
    SdfUsdaFileFormat();
 
    SDF_API
    explicit SdfUsdaFileFormat(const TfToken& formatId,
                               const TfToken& versionString = TfToken(),
                               const TfToken& target = TfToken());
 
    SDF_API
    bool _CanReadFromAsset(
        const std::string& resolvedPath,
        const std::shared_ptr<ArAsset>& asset) const;
 
    SDF_API 
    bool _ReadFromAsset(
        SdfLayer* layer, 
        const std::string& resolvedPath,
        const std::shared_ptr<ArAsset>& asset,
        bool metadataOnly) const;
 
private:
    // Override to return false.  Reloading anonymous text layers clears their
    // content.
    SDF_API virtual bool _ShouldSkipAnonymousReload() const override;
 
    friend class SdfUsdFileFormat;
};
 
PXR_NAMESPACE_CLOSE_SCOPE
 
#endif // PXR_USD_SDF_USDA_FILE_FORMAT_H