contrib/lutok/debug.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 debug.hpp
  30 /// Provides the debug wrapper class for the Lua C debug state.
  31
  32 #if !defined(LUTOK_DEBUG_HPP)
  33 #define LUTOK_DEBUG_HPP
  34
  35 #include <string>
  36 #if defined(_LIBCPP_VERSION) || __cplusplus >= 201103L
  37 #include <memory>
  38 #else
  39 #include <tr1/memory>
  40 #endif
  41
  42 namespace lutok {
  43
  44
  45 class state;
  46
  47
  48 /// A model for the Lua debug state.
  49 ///
  50 /// This extremely-simple class provides a mechanism to hide the internals of
  51 /// the C native lua_Debug type, exposing its internal fields using friendlier
  52 /// C++ types.
  53 ///
  54 /// This class also acts as a complement to the state class by exposing any
  55 /// state-related functions as methods of this function.  For example, while it
  56 /// might seem that get_info() belongs in state, we expose it from here because
  57 /// its result is really mutating a debug object, not the state object.
  58 class debug {
  59     struct impl;
  60
  61     /// Pointer to the shared internal implementation.
  62 #if defined(_LIBCPP_VERSION) || __cplusplus >= 201103L
  63     std::shared_ptr< impl > _pimpl;
  64 #else
  65     std::tr1::shared_ptr< impl > _pimpl;
  66 #endif
  67
  68 public:
  69     debug(void);
  70     ~debug(void);
  71
  72     void get_info(state&, const std::string&);
  73     void get_stack(state&, const int);
  74
  75     int event(void) const;
  76     std::string name(void) const;
  77     std::string name_what(void) const;
  78     std::string what(void) const;
  79     std::string source(void) const;
  80     int current_line(void) const;
  81     int n_ups(void) const;
  82     int line_defined(void) const;
  83     int last_line_defined(void) const;
  84     std::string short_src(void) const;
  85 };
  86
  87
  88 }  // namespace lutok
  89
  90 #endif  // !defined(LUTOK_DEBUG_HPP)