mirror of
https://github.com/KhronosGroup/SPIRV-Tools
synced 2024-10-18 19:20:05 +00:00
131 lines
4.6 KiB
C++
131 lines
4.6 KiB
C++
// Copyright (c) 2015-2016 The Khronos Group Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and/or associated documentation files (the
|
|
// "Materials"), to deal in the Materials without restriction, including
|
|
// without limitation the rights to use, copy, modify, merge, publish,
|
|
// distribute, sublicense, and/or sell copies of the Materials, and to
|
|
// permit persons to whom the Materials are furnished to do so, subject to
|
|
// the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included
|
|
// in all copies or substantial portions of the Materials.
|
|
//
|
|
// MODIFICATIONS TO THIS FILE MAY MEAN IT NO LONGER ACCURATELY REFLECTS
|
|
// KHRONOS STANDARDS. THE UNMODIFIED, NORMATIVE VERSIONS OF KHRONOS
|
|
// SPECIFICATIONS AND HEADER INFORMATION ARE LOCATED AT
|
|
// https://www.khronos.org/registry/
|
|
//
|
|
// THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
// IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
// CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
// TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
// MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
|
|
|
|
#ifndef LIBSPIRV_DIAGNOSTIC_H_
|
|
#define LIBSPIRV_DIAGNOSTIC_H_
|
|
|
|
#include <iostream>
|
|
#include <sstream>
|
|
#include <utility>
|
|
|
|
#include "spirv-tools/libspirv.h"
|
|
|
|
/// For debugging purposes only
|
|
/// Prints the string to stdout
|
|
#define MSG(msg) \
|
|
do { \
|
|
libspirv::message(__FILE__, size_t(__LINE__), msg); \
|
|
} while (0)
|
|
|
|
/// For debugging purposes only
|
|
/// prints the variable value/location/and name to stdout
|
|
#define SHOW(exp) \
|
|
do { \
|
|
libspirv::message(__FILE__, size_t(__LINE__), #exp, (exp)); \
|
|
} while (0)
|
|
|
|
namespace libspirv {
|
|
class diagnostic_helper {
|
|
public:
|
|
diagnostic_helper(spv_position_t& position, spv_diagnostic* diagnostic)
|
|
: position_(&position), diagnostic_(diagnostic) {}
|
|
|
|
diagnostic_helper(spv_position position, spv_diagnostic* diagnostic)
|
|
: position_(position), diagnostic_(diagnostic) {}
|
|
|
|
~diagnostic_helper() {
|
|
*diagnostic_ = spvDiagnosticCreate(position_, stream().str().c_str());
|
|
}
|
|
|
|
std::stringstream& stream() { return stream_; }
|
|
|
|
private:
|
|
std::stringstream stream_;
|
|
spv_position position_;
|
|
spv_diagnostic* diagnostic_;
|
|
};
|
|
|
|
// A DiagnosticStream remembers the current position of the input and an error
|
|
// code, and captures diagnostic messages via the left-shift operator.
|
|
// If the error code is not SPV_FAILED_MATCH, then captured messages are
|
|
// emitted during the destructor.
|
|
// TODO(awoloszyn): This is very similar to diagnostic_helper, and hides
|
|
// the data more easily. Replace diagnostic_helper elsewhere
|
|
// eventually.
|
|
class DiagnosticStream {
|
|
public:
|
|
DiagnosticStream(spv_position_t position, spv_diagnostic* pDiagnostic,
|
|
spv_result_t error)
|
|
: position_(position), pDiagnostic_(pDiagnostic), error_(error) {}
|
|
|
|
DiagnosticStream(DiagnosticStream&& other)
|
|
: stream_(other.stream_.str()),
|
|
position_(other.position_),
|
|
pDiagnostic_(other.pDiagnostic_),
|
|
error_(other.error_) {
|
|
// The other object's destructor will emit the text in its stream_
|
|
// member if its pDiagnostic_ member is non-null. Prevent that,
|
|
// since emitting that text is now the responsibility of *this.
|
|
other.pDiagnostic_ = nullptr;
|
|
}
|
|
|
|
~DiagnosticStream();
|
|
|
|
// Adds the given value to the diagnostic message to be written.
|
|
template <typename T>
|
|
DiagnosticStream& operator<<(const T& val) {
|
|
stream_ << val;
|
|
return *this;
|
|
}
|
|
|
|
// Conversion operator to spv_result, returning the error code.
|
|
operator spv_result_t() { return error_; }
|
|
|
|
private:
|
|
std::stringstream stream_;
|
|
spv_position_t position_;
|
|
spv_diagnostic* pDiagnostic_;
|
|
spv_result_t error_;
|
|
};
|
|
|
|
#define DIAGNOSTIC \
|
|
libspirv::diagnostic_helper helper(position, pDiagnostic); \
|
|
helper.stream()
|
|
|
|
std::string spvResultToString(spv_result_t res);
|
|
|
|
/// Helper functions for printing debugging information
|
|
void message(std::string file, size_t line, std::string name);
|
|
|
|
template <typename T>
|
|
void message(std::string file, size_t line, std::string name, T val) {
|
|
std::cout << file << ":" << line << ": " << name << " " << val << std::endl;
|
|
}
|
|
|
|
} // namespace libspirv
|
|
|
|
#endif // LIBSPIRV_DIAGNOSTIC_H_
|