contrib/lutok/exceptions.hpp

   1 // Copyright 2011 Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 // * Redistributions of source code must retain the above copyright
   9 //   notice, this list of conditions and the following disclaimer.
  10 // * Redistributions in binary form must reproduce the above copyright
  11 //   notice, this list of conditions and the following disclaimer in the
  12 //   documentation and/or other materials provided with the distribution.
  13 // * Neither the name of Google Inc. nor the names of its contributors
  14 //   may be used to endorse or promote products derived from this software
  15 //   without specific prior written permission.
  16 //
  17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 /// \file exceptions.hpp
  30 /// Exception types raised by lutok.
  31
  32 #if !defined(LUTOK_EXCEPTIONS_HPP)
  33 #define LUTOK_EXCEPTIONS_HPP
  34
  35 #include <stdexcept>
  36 #include <string>
  37
  38 namespace lutok {
  39
  40
  41 class state;
  42
  43
  44 /// Base exception for lua errors.
  45 class error : public std::runtime_error {
  46 public:
  47     explicit error(const std::string&);
  48     virtual ~error(void) throw();
  49 };
  50
  51
  52 /// Exception for errors raised by the Lua API library.
  53 class api_error : public error {
  54     /// Name of the Lua C API function that caused the error.
  55     std::string _api_function;
  56
  57 public:
  58     explicit api_error(const std::string&, const std::string&);
  59     virtual ~api_error(void) throw();
  60
  61     static api_error from_stack(state&, const std::string&);
  62
  63     const std::string& api_function(void) const;
  64 };
  65
  66
  67 /// File not found error.
  68 class file_not_found_error : public error {
  69     /// Name of the not-found file.
  70     std::string _filename;
  71
  72 public:
  73     explicit file_not_found_error(const std::string&);
  74     virtual ~file_not_found_error(void) throw();
  75
  76     const std::string& filename(void) const;
  77 };
  78
  79
  80 }  // namespace lutok
  81
  82
  83 #endif  // !defined(LUTOK_EXCEPTIONS_HPP)