summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html')
-rw-r--r--Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html106
1 files changed, 106 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html
new file mode 100644
index 00000000000..514134fd520
--- /dev/null
+++ b/Master/texmf-dist/doc/support/lua2dox/examples/lua/docs/html/class_8lua-source.html
@@ -0,0 +1,106 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+<title>Sample Code: class.lua Source File</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+<link href="tabs.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.5.6 -->
+<div class="navigation" id="top">
+ <div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
+ <li><a href="annotated.html"><span>Classes</span></a></li>
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
+ </ul>
+ </div>
+<h1>class.lua</h1><a href="class_8lua.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 ---- Copyright 2011 Simon Dales
+<a name="l00002"></a>00002 --
+<a name="l00003"></a>00003 -- This work may be distributed and/or modified under the
+<a name="l00004"></a>00004 -- conditions of the LaTeX Project Public License, either version 1.3
+<a name="l00005"></a>00005 -- of <span class="keyword">this</span> license or (at your option) any later version.
+<a name="l00006"></a>00006 -- The latest version of <span class="keyword">this</span> license is in
+<a name="l00007"></a>00007 -- http:<span class="comment">//www.latex-project.org/lppl.txt</span>
+<a name="l00008"></a>00008 --
+<a name="l00009"></a>00009 -- This work has the LPPL maintenance status `maintained<span class="stringliteral">'.</span>
+<a name="l00010"></a>00010 <span class="stringliteral">-- </span>
+<a name="l00011"></a>00011 <span class="stringliteral">-- The Current Maintainer of this work is Simon Dales.</span>
+<a name="l00012"></a>00012 <span class="stringliteral">--</span>
+<a name="l00013"></a>00013 <span class="stringliteral"></span>
+<a name="l00014"></a>00014 <span class="stringliteral">--[[!</span>
+<a name="l00015"></a>00015 <span class="stringliteral"> \file </span>
+<a name="l00016"></a>00016 <span class="stringliteral"> \brief enables classes in lua</span>
+<a name="l00017"></a>00017 <span class="stringliteral"> ]]</span>
+<a name="l00018"></a>00018 <span class="stringliteral"> </span>
+<a name="l00019"></a>00019 <span class="stringliteral">--[[ class.lua</span>
+<a name="l00020"></a>00020 <span class="stringliteral">-- Compatible with Lua 5.1 (not 5.0).</span>
+<a name="l00021"></a>00021 <span class="stringliteral"></span>
+<a name="l00022"></a>00022 <span class="stringliteral"> ---------------------</span>
+<a name="l00023"></a>00023 <span class="stringliteral"> </span>
+<a name="l00024"></a>00024 <span class="stringliteral"> ]]--</span>
+<a name="l00025"></a>00025 <span class="stringliteral">--! \brief ``declare'</span><span class="stringliteral">' as class</span>
+<a name="l00026"></a>00026 <span class="stringliteral">--! </span>
+<a name="l00027"></a>00027 <span class="stringliteral">--! use as:</span>
+<a name="l00028"></a>00028 <span class="stringliteral">--! \code{lua}</span>
+<a name="l00029"></a>00029 <span class="stringliteral">--! TWibble = class()</span>
+<a name="l00030"></a>00030 <span class="stringliteral">--! function TWibble:init(instance)</span>
+<a name="l00031"></a>00031 <span class="stringliteral">--! self.instance = instance</span>
+<a name="l00032"></a>00032 <span class="stringliteral">--! -- more stuff here</span>
+<a name="l00033"></a>00033 <span class="stringliteral">--! end</span>
+<a name="l00034"></a>00034 <span class="stringliteral">--! \endcode</span>
+<a name="l00035"></a>00035 <span class="stringliteral">--! </span>
+<a name="l00036"></a><a class="code" href="class_8lua.html#a054d3d223ac0f3f6f0ec350708f9361">00036</a> <span class="stringliteral">function class(BaseClass, ClassInitialiser)</span>
+<a name="l00037"></a>00037 <span class="stringliteral"> local newClass = {} -- a new class newClass</span>
+<a name="l00038"></a>00038 <span class="stringliteral"> if not ClassInitialiser and type(BaseClass) == '</span>function<span class="stringliteral">' then</span>
+<a name="l00039"></a>00039 <span class="stringliteral"> ClassInitialiser = BaseClass</span>
+<a name="l00040"></a>00040 <span class="stringliteral"> BaseClass = nil</span>
+<a name="l00041"></a>00041 <span class="stringliteral"> elseif type(BaseClass) == '</span>table<span class="stringliteral">' then</span>
+<a name="l00042"></a>00042 <span class="stringliteral"> -- our new class is a shallow copy of the base class!</span>
+<a name="l00043"></a>00043 <span class="stringliteral"> for i,v in pairs(BaseClass) do</span>
+<a name="l00044"></a>00044 <span class="stringliteral"> newClass[i] = v</span>
+<a name="l00045"></a>00045 <span class="stringliteral"> end</span>
+<a name="l00046"></a>00046 <span class="stringliteral"> newClass._base = BaseClass</span>
+<a name="l00047"></a>00047 <span class="stringliteral"> end</span>
+<a name="l00048"></a>00048 <span class="stringliteral"> -- the class will be the metatable for all its newInstanceects,</span>
+<a name="l00049"></a>00049 <span class="stringliteral"> -- and they will look up their methods in it.</span>
+<a name="l00050"></a>00050 <span class="stringliteral"> newClass.__index = newClass</span>
+<a name="l00051"></a>00051 <span class="stringliteral"></span>
+<a name="l00052"></a>00052 <span class="stringliteral"> -- expose a constructor which can be called by &lt;classname&gt;(&lt;args&gt;)</span>
+<a name="l00053"></a>00053 <span class="stringliteral"> local classMetatable = {}</span>
+<a name="l00054"></a>00054 <span class="stringliteral"> classMetatable.__call = </span>
+<a name="l00055"></a>00055 <span class="stringliteral"> function(class_tbl, ...)</span>
+<a name="l00056"></a>00056 <span class="stringliteral"> local newInstance = {}</span>
+<a name="l00057"></a>00057 <span class="stringliteral"> setmetatable(newInstance,newClass)</span>
+<a name="l00058"></a>00058 <span class="stringliteral"> --if init then</span>
+<a name="l00059"></a>00059 <span class="stringliteral"> -- init(newInstance,...)</span>
+<a name="l00060"></a>00060 <span class="stringliteral"> if class_tbl.init then</span>
+<a name="l00061"></a>00061 <span class="stringliteral"> class_tbl.init(newInstance,...)</span>
+<a name="l00062"></a>00062 <span class="stringliteral"> else </span>
+<a name="l00063"></a>00063 <span class="stringliteral"> -- make sure that any stuff from the base class is initialized!</span>
+<a name="l00064"></a>00064 <span class="stringliteral"> if BaseClass and BaseClass.init then</span>
+<a name="l00065"></a>00065 <span class="stringliteral"> BaseClass.init(newInstance, ...)</span>
+<a name="l00066"></a>00066 <span class="stringliteral"> end</span>
+<a name="l00067"></a>00067 <span class="stringliteral"> end</span>
+<a name="l00068"></a>00068 <span class="stringliteral"> return newInstance</span>
+<a name="l00069"></a>00069 <span class="stringliteral"> end</span>
+<a name="l00070"></a>00070 <span class="stringliteral"> newClass.init = ClassInitialiser</span>
+<a name="l00071"></a>00071 <span class="stringliteral"> newClass.is_a = </span>
+<a name="l00072"></a>00072 <span class="stringliteral"> function(this, klass)</span>
+<a name="l00073"></a>00073 <span class="stringliteral"> local thisMetabable = getmetatable(this)</span>
+<a name="l00074"></a>00074 <span class="stringliteral"> while thisMetabable do </span>
+<a name="l00075"></a>00075 <span class="stringliteral"> if thisMetabable == klass then</span>
+<a name="l00076"></a>00076 <span class="stringliteral"> return true</span>
+<a name="l00077"></a>00077 <span class="stringliteral"> end</span>
+<a name="l00078"></a>00078 <span class="stringliteral"> thisMetabable = thisMetabable._base</span>
+<a name="l00079"></a>00079 <span class="stringliteral"> end</span>
+<a name="l00080"></a>00080 <span class="stringliteral"> return false</span>
+<a name="l00081"></a>00081 <span class="stringliteral"> end</span>
+<a name="l00082"></a>00082 <span class="stringliteral"> setmetatable(newClass, classMetatable)</span>
+<a name="l00083"></a>00083 <span class="stringliteral"> return newClass</span>
+<a name="l00084"></a>00084 <span class="stringliteral">end</span>
+<a name="l00085"></a>00085 <span class="stringliteral">--eof</span>
+</pre></div></div>
+<hr size="1"><address style="text-align: right;"><small>Generated on Mon Jun 11 16:15:30 2012 for Sample Code by&nbsp;
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
+</body>
+</html>