dawn-cmake/src/backend/Builder.cpp

// Copyright 2017 The NXT Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "backend/Builder.h"

#include "backend/Device.h"
#include "common/Assert.h"

namespace backend {

    bool BuilderBase::CanBeUsed() const {
        return !mIsConsumed && !mGotStatus;
    }

    DeviceBase* BuilderBase::GetDevice() {
        return mDevice;
    }

    void BuilderBase::HandleError(const char* message) {
        SetStatus(nxt::BuilderErrorStatus::Error, message);
    }

    void BuilderBase::SetErrorCallback(nxt::BuilderErrorCallback callback,
                                   nxt::CallbackUserdata userdata1,
                                   nxt::CallbackUserdata userdata2) {
        mCallback = callback;
        mUserdata1 = userdata1;
        mUserdata2 = userdata2;
    }

    BuilderBase::BuilderBase(DeviceBase* device) : mDevice(device) {
    }

    BuilderBase::~BuilderBase() {
        if (!mIsConsumed && mCallback != nullptr) {
            mCallback(NXT_BUILDER_ERROR_STATUS_UNKNOWN, "Builder destroyed before GetResult", mUserdata1, mUserdata2);
        }
    }

    void BuilderBase::SetStatus(nxt::BuilderErrorStatus status, const char* message) {
        ASSERT(status != nxt::BuilderErrorStatus::Success);
        ASSERT(status != nxt::BuilderErrorStatus::Unknown);
        ASSERT(!mGotStatus); // This is not strictly necessary but something to strive for.
        mGotStatus = true;

        mStoredStatus = status;
        mStoredMessage = message;
    }

    bool BuilderBase::HandleResult(RefCounted* result) {
        // GetResult can only be called once.
        ASSERT(!mIsConsumed);
        mIsConsumed = true;

        // result == nullptr implies there was an error which implies we should have a status set.
        ASSERT(result != nullptr || mGotStatus);

        // If we have any error, then we have to return nullptr
        if (mGotStatus) {
            ASSERT(mStoredStatus != nxt::BuilderErrorStatus::Success);

            // The application will never see "result" so we need to remove the
            // external ref here.
            if (result != nullptr) {
                result->Release();
                result = nullptr;
            }

            // Unhandled builder errors are promoted to device errors
            if (!mCallback) mDevice->HandleError(("Unhandled builder error: " + mStoredMessage).c_str());
        } else {
            ASSERT(mStoredStatus == nxt::BuilderErrorStatus::Success);
            ASSERT(mStoredMessage.empty());
        }

        if (mCallback != nullptr) {
            mCallback(static_cast<nxtBuilderErrorStatus>(mStoredStatus), mStoredMessage.c_str(), mUserdata1, mUserdata2);
        }

        return result != nullptr;
    }

}