|
From: Arvid N. <ar...@us...> - 2006-01-11 23:33:28
|
Update of /cvsroot/luabind/luabind/luabind/doc In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7891 Modified Files: Tag: luabind_rc_0_7 docs.html docs.rst Log Message: minor documentation updates Index: docs.html =================================================================== RCS file: /cvsroot/luabind/luabind/luabind/doc/docs.html,v retrieving revision 1.54.2.5 retrieving revision 1.54.2.6 diff -u -d -r1.54.2.5 -r1.54.2.6 --- docs.html 11 Jan 2006 00:53:25 -0000 1.54.2.5 +++ docs.html 11 Jan 2006 23:33:14 -0000 1.54.2.6 @@ -7,7 +7,7 @@ <title>luabind</title> <meta name="author" content="Daniel Wallin, Arvid Norberg" /> <meta name="copyright" content="Copyright Daniel Wallin, Arvid Norberg 2003." /> -<meta name="date" content="2006-01-10" /> +<meta name="date" content="2006-01-11" /> <link rel="stylesheet" href="style.css" type="text/css" /> </head> <body> @@ -22,9 +22,9 @@ <tr><th class="docinfo-name">Copyright:</th> <td>Copyright Daniel Wallin, Arvid Norberg 2003.</td></tr> <tr><th class="docinfo-name">Date:</th> -<td>2006-01-10</td></tr> +<td>2006-01-11</td></tr> <tr><th class="docinfo-name">Revision:</th> -<td>1.26.2.4</td></tr> +<td>1.26.2.5</td></tr> <tr class="field"><th class="docinfo-name">License:</th><td class="field-body"><p class="first">Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation @@ -110,7 +110,7 @@ <li><a class="reference" href="#pcall-errorfunc" id="id87" name="id87">14.1 pcall errorfunc</a></li> <li><a class="reference" href="#file-and-line-numbers" id="id88" name="id88">14.2 file and line numbers</a></li> <li><a class="reference" href="#lua-panic" id="id89" name="id89">14.3 lua panic</a></li> -<li><a class="reference" href="#msvc-exceptions" id="id90" name="id90">14.4 msvc exceptions</a></li> +<li><a class="reference" href="#structured-exceptions-msvc" id="id90" name="id90">14.4 structured exceptions (MSVC)</a></li> <li><a class="reference" href="#error-messages" id="id91" name="id91">14.5 Error messages</a></li> </ul> </li> @@ -2706,16 +2706,18 @@ function is to make sure lua is compiled as C++ and throw an exception from the panic function. Throwing an exception instead of using <tt class="docutils literal"><span class="pre">setjmp</span></tt> and <tt class="docutils literal"><span class="pre">longjmp</span></tt> will make sure the stack is correctly unwound.</p> +<p>When the panic function is called, the lua state is invalid, and the only +allowed operation on it is to close it.</p> <p>For more information, see the <a class="reference" href="http://www.lua.org/manual/5.0/manual.html#3.19">lua manual section 3.19</a>.</p> </div> -<div class="section" id="msvc-exceptions"> -<h2><a name="msvc-exceptions">14.4 msvc exceptions</a></h2> +<div class="section" id="structured-exceptions-msvc"> +<h2><a name="structured-exceptions-msvc">14.4 structured exceptions (MSVC)</a></h2> <p>Since lua is generally built as a C library, any callbacks called from lua cannot under any circumstance throw an exception. Because of that, luabind has to catch all exceptions and translate them into proper lua errors (by calling <tt class="docutils literal"><span class="pre">lua_error()</span></tt>). This means we have a <tt class="docutils literal"><span class="pre">catch(...)</span> <span class="pre">{}</span></tt> in there.</p> -<p>In VisualStudio, <tt class="docutils literal"><span class="pre">catch</span> <span class="pre">(...)</span></tt> will not only catch C++ exceptions, it will -also catch hardware exceptions like Segmentation fault. This means that if +<p>In Visual Studio, <tt class="docutils literal"><span class="pre">catch</span> <span class="pre">(...)</span></tt> will not only catch C++ exceptions, it will +also catch structured exceptions, such as segmentation fault. This means that if your function, that gets called from luabind, makes an invalid memory adressing, you won't notice it. All that will happen is that lua will return an error message saying "unknown exception".</p> @@ -2728,7 +2730,7 @@ ::_set_se_translator(straight_to_debugger); #endif </pre> -<p>This will make hardware exceptions, like segmentation fault, to actually get +<p>This will make structured exceptions, like segmentation fault, to actually get caught by the debugger.</p> </div> <div class="section" id="error-messages"> @@ -2836,11 +2838,11 @@ </dd> <dt>LUA_API</dt> <dd>If you want to link dynamically against Lua, you can set this define to -the import-keyword on your compiler and platform. On windows in VisualStudio +the import-keyword on your compiler and platform. On Windows in Visual Studio this should be <tt class="docutils literal"><span class="pre">__declspec(dllimport)</span></tt> if you want to link against Lua as a dll.</dd> <dt>LUABIND_EXPORT, LUABIND_IMPORT</dt> -<dd>If you want to link against luabind as a dll (in VisualStudio), you can +<dd>If you want to link against luabind as a dll (in Visual Studio), you can define <tt class="docutils literal"><span class="pre">LUABIND_EXPORT</span></tt> to <tt class="docutils literal"><span class="pre">__declspec(dllexport)</span></tt> and <tt class="docutils literal"><span class="pre">LUABIND_IMPORT</span></tt> to <tt class="docutils literal"><span class="pre">__declspec(dllimport)</span></tt> or <tt class="docutils literal"><span class="pre">__attribute__</span> <span class="pre">((visibility("default")))</span></tt> on GCC 4. @@ -2995,7 +2997,7 @@ <dd>VC6.5 chokes on warnings, if you are getting alot of warnings from your code try suppressing them with a pragma directive, this should solve the problem.</dd> -<dt>Crashes when linking against luabind as a dll in windows</dt> +<dt>Crashes when linking against luabind as a dll in Windows</dt> <dd>When you build luabind, Lua and you project, make sure you link against the runtime dynamically (as a dll).</dd> <dt>I cannot register a function with a non-const parameter</dt> Index: docs.rst =================================================================== RCS file: /cvsroot/luabind/luabind/luabind/doc/docs.rst,v retrieving revision 1.26.2.5 retrieving revision 1.26.2.6 diff -u -d -r1.26.2.5 -r1.26.2.6 --- docs.rst 11 Jan 2006 00:53:27 -0000 1.26.2.5 +++ docs.rst 11 Jan 2006 23:33:14 -0000 1.26.2.6 @@ -2204,20 +2204,23 @@ the panic function. Throwing an exception instead of using ``setjmp`` and ``longjmp`` will make sure the stack is correctly unwound. +When the panic function is called, the lua state is invalid, and the only +allowed operation on it is to close it. + For more information, see the `lua manual section 3.19`_. .. _`lua manual section 3.19`: http://www.lua.org/manual/5.0/manual.html#3.19 -msvc exceptions ---------------- +structured exceptions (MSVC) +---------------------------- Since lua is generally built as a C library, any callbacks called from lua cannot under any circumstance throw an exception. Because of that, luabind has to catch all exceptions and translate them into proper lua errors (by calling ``lua_error()``). This means we have a ``catch(...) {}`` in there. -In VisualStudio, ``catch (...)`` will not only catch C++ exceptions, it will -also catch hardware exceptions like Segmentation fault. This means that if +In Visual Studio, ``catch (...)`` will not only catch C++ exceptions, it will +also catch structured exceptions, such as segmentation fault. This means that if your function, that gets called from luabind, makes an invalid memory adressing, you won't notice it. All that will happen is that lua will return an error message saying "unknown exception". @@ -2231,7 +2234,7 @@ ::_set_se_translator(straight_to_debugger); #endif -This will make hardware exceptions, like segmentation fault, to actually get +This will make structured exceptions, like segmentation fault, to actually get caught by the debugger. @@ -2353,12 +2356,12 @@ LUA_API If you want to link dynamically against Lua, you can set this define to - the import-keyword on your compiler and platform. On windows in VisualStudio + the import-keyword on your compiler and platform. On Windows in Visual Studio this should be ``__declspec(dllimport)`` if you want to link against Lua as a dll. LUABIND_EXPORT, LUABIND_IMPORT - If you want to link against luabind as a dll (in VisualStudio), you can + If you want to link against luabind as a dll (in Visual Studio), you can define ``LUABIND_EXPORT`` to ``__declspec(dllexport)`` and ``LUABIND_IMPORT`` to ``__declspec(dllimport)`` or ``__attribute__ ((visibility("default")))`` on GCC 4. @@ -2527,7 +2530,7 @@ code try suppressing them with a pragma directive, this should solve the problem. -Crashes when linking against luabind as a dll in windows +Crashes when linking against luabind as a dll in Windows When you build luabind, Lua and you project, make sure you link against the runtime dynamically (as a dll). |
