codeWrapperContext.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/codeWrapperContext.h"
#ifndef _ufeCodeWrapperContext
#define _ufeCodeWrapperContext
// ===========================================================================
// Copyright 2023 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================

#include "codeWrapper.h"

#include <string>
#include <vector>

UFE_NS_DEF {

class Selection;

class UFE_SDK_DECL CodeWrapperContext
{
public:
    CodeWrapperContext(
        const CodeWrapperContainer& container,
        const std::string& subOperation);
    ~CodeWrapperContext();

    // Do not allow copying since the CodeWrapper prelude and cleanup
    // must only be executed once.
    CodeWrapperContext(const CodeWrapperContext&) = delete;
    const CodeWrapperContext& operator=(const CodeWrapperContext&) = delete;

    CodeWrapperContext(CodeWrapperContext&&) = delete;
    const CodeWrapperContext& operator=(CodeWrapperContext&&) = delete;

    void cleanup();

private:
    // This function is called during construction.
    void prelude();

    // The CodeWrapperContext can only be created with a valid container of
    // code wrapper but does not manage the lifetime of that container. The
    // container is held by another class, for example a BatchCompositeCommand,
    // which is also the class that uses the context. See BatchCompositeCommand.cpp
    // for an example.
    //
    // Note: we need to keep it as a pointer so we can clear it out when cleanup()
    //       is explicitly called.
    const CodeWrapperContainer* fContainer;
    std::string                 fSubOperation;
};

}

#endif /* _ufeCodeWrapperContext */