SPIRV/Logger.h

   1 //
   2 // Copyright (C) 2016 Google, Inc.
   3 //
   4 // All rights reserved.
   5 //
   6 // Redistribution and use in source and binary forms, with or without
   7 // modification, are permitted provided that the following conditions
   8 // are met:
   9 //
  10 //    Redistributions of source code must retain the above copyright
  11 //    notice, this list of conditions and the following disclaimer.
  12 //
  13 //    Redistributions in binary form must reproduce the above
  14 //    copyright notice, this list of conditions and the following
  15 //    disclaimer in the documentation and/or other materials provided
  16 //    with the distribution.
  17 //
  18 //    Neither the name of Google Inc. nor the names of its
  19 //    contributors may be used to endorse or promote products derived
  20 //    from this software without specific prior written permission.
  21 //
  22 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  23 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  24 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  25 // FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  26 // COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  27 // INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  28 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  29 // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  30 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  31 // LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  32 // ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33 // POSSIBILITY OF SUCH DAMAGE.
  34
  35 #ifndef GLSLANG_SPIRV_LOGGER_H
  36 #define GLSLANG_SPIRV_LOGGER_H
  37
  38 #include <string>
  39 #include <vector>
  40
  41 namespace spv {
  42
  43 // A class for holding all SPIR-V build status messages, including
  44 // missing/TBD functionalities, warnings, and errors.
  45 class SpvBuildLogger {
  46 public:
  47     SpvBuildLogger() {}
  48
  49 #ifdef GLSLANG_WEB
  50     void tbdFunctionality(const std::string& f) { }
  51     void missingFunctionality(const std::string& f) { }
  52     void warning(const std::string& w) { }
  53     void error(const std::string& e) { errors.push_back(e); }
  54     std::string getAllMessages() { return ""; }
  55 #else
  56
  57     // Registers a TBD functionality.
  58     void tbdFunctionality(const std::string& f);
  59     // Registers a missing functionality.
  60     void missingFunctionality(const std::string& f);
  61
  62     // Logs a warning.
  63     void warning(const std::string& w) { warnings.push_back(w); }
  64     // Logs an error.
  65     void error(const std::string& e) { errors.push_back(e); }
  66
  67     // Returns all messages accumulated in the order of:
  68     // TBD functionalities, missing functionalities, warnings, errors.
  69     std::string getAllMessages() const;
  70 #endif
  71
  72 private:
  73     SpvBuildLogger(const SpvBuildLogger&);
  74
  75     std::vector<std::string> tbdFeatures;
  76     std::vector<std::string> missingFeatures;
  77     std::vector<std::string> warnings;
  78     std::vector<std::string> errors;
  79 };
  80
  81 } // end spv namespace
  82
  83 #endif // GLSLANG_SPIRV_LOGGER_H