File: LuaListTable.h

package info (click to toggle)
arkrpg 0.1.4b-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 6,104 kB
  • ctags: 5,445
  • sloc: cpp: 28,145; sh: 9,006; ansic: 3,259; makefile: 344
file content (107 lines) | stat: -rw-r--r-- 2,867 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
/* $Id: LuaListTable.h,v 1.1 2002/12/18 20:10:46 tharibo Exp $
**
** Ark - Libraries, Tools & Programs for MMORPG developpements.
** Copyright (C) 1999-2000 The Contributors of the Ark Project
** Please see the file "AUTHORS" for a list of contributors
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/

#ifndef LUA_LISTTABLE_H
#define LUA_LISTTABLE_H

extern "C"
{
#include <lua.h>
}

#include "LuaTable.h"

namespace Ark
{

  /**
   * \brief Simple table which is a simple list of elements
   * \author tharibo tharibo@nekeme.net
   *
   * This class is used to handle simple lists of elements in Lua. This is done
   * with a table whith no explicit key. In fact, the keys are numbers, but this
   * is handled automatically by Lua.
   *
   * It should be destroyed at the end of the function.
   */
  class ARKLUA_DLL_API LuaListTable : public LuaTable
  {
    public:
      
      /**
       * Construct a LuaTable, the table being at the given index.
       */
      LuaListTable(lua_State* L, int index = -1);

      /**
       * Destructor
       */
      virtual ~LuaListTable();

      /**
       * Add an element to the list
       *
       * \param element The element to add.
       */
      void addElement(double element);

      /**
       * Add an element to the list
       *
       * \param element The element to add.
       */
      void addElement(const char* element);

      /**
       * Add an element to the list
       *
       * \param element The element to add.
       */
      void addElement(void* element);

      /**
       * Add an element to the list
       *
       * \param element The element to add.
       */
      void addElement(const LuaTable& element);

      // TODO: add the functions to destroy elements of the list...
      
      /**
       * Constructs a LuaListTable from scratch. This creates a new table on the
       * stack.
       *
       * \param L The lua state where we are going to create the table.
       */
      static LuaListTable* createTable(lua_State* L);

    protected:
      /**
       * Index (key) of the last element in the list.
       *
       * -1 means there is no element in the list.
       */
      int m_LastIndex;
  };
}

#endif