libs/lua/LuaBridge/detail/Iterator.h

   1 //------------------------------------------------------------------------------
   2 /*
   3   https://github.com/vinniefalco/LuaBridge
   4
   5   Copyright 2012, Vinnie Falco <vinnie.falco@gmail.com>
   6
   7   License: The MIT License (http://www.opensource.org/licenses/mit-license.php)
   8
   9   Permission is hereby granted, free of charge, to any person obtaining a copy
  10   of this software and associated documentation files (the "Software"), to deal
  11   in the Software without restriction, including without limitation the rights
  12   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13   copies of the Software, and to permit persons to whom the Software is
  14   furnished to do so, subject to the following conditions:
  15
  16   The above copyright notice and this permission notice shall be included in all
  17   copies or substantial portions of the Software.
  18
  19   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25   SOFTWARE.
  26 */
  27 //==============================================================================
  28
  29 /** Allows table iteration.
  30 */
  31 class Iterator
  32 {
  33 private:
  34   lua_State* m_L;
  35   LuaRef m_table;
  36   LuaRef m_key;
  37   LuaRef m_value;
  38
  39   void next ()
  40   {
  41     m_table.push(m_L);
  42     m_key.push (m_L);
  43     if (lua_next (m_L, -2))
  44     {
  45       m_value.pop (m_L);
  46       m_key.pop (m_L);
  47     }
  48     else
  49     {
  50       m_key = Nil();
  51       m_value = Nil();
  52     }
  53     lua_pop(m_L, 1);
  54   }
  55
  56 public:
  57   explicit Iterator (LuaRef table)
  58     : m_L (table.state ())
  59     , m_table (table)
  60     , m_key (table.state ()) // m_key is nil
  61     , m_value (table.state ()) // m_value is nil
  62   {
  63     next (); // get the first (key, value) pair from table
  64   }
  65
  66   lua_State* state () const
  67   {
  68     return m_L;
  69   }
  70
  71   LuaRef operator* () const
  72   {
  73     return m_value;
  74   }
  75
  76   LuaRef operator-> () const
  77   {
  78     return m_value;
  79   }
  80
  81   Iterator& operator++ ()
  82   {
  83     if (isNil())
  84     {
  85       // if the iterator reaches the end, do nothing
  86       return *this;
  87     }
  88     else
  89     {
  90       next();
  91       return *this;
  92     }
  93   }
  94
  95   inline bool isNil () const
  96   {
  97     return m_key.isNil ();
  98   }
  99
 100   inline LuaRef key () const
 101   {
 102     return m_key;
 103   }
 104
 105   inline LuaRef value () const
 106   {
 107     return m_value;
 108   }
 109
 110 private:
 111   // Don't use postfix increment, it is less efficient
 112   Iterator operator++ (int);
 113 };
 114