info_commands.h

Go to the documentation of this file.

/*
 * Copyright (c) 2010-2015:  G-CSC, Goethe University Frankfurt
 * Author: Martin Rupp
 * 
 * This file is part of UG4.
 * 
 * UG4 is free software: you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License version 3 (as published by the
 * Free Software Foundation) with the following additional attribution
 * requirements (according to LGPL/GPL v3 §7):
 * 
 * (1) The following notice must be displayed in the Appropriate Legal Notices
 * of covered and combined works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (2) The following notice must be displayed at a prominent place in the
 * terminal output of covered works: "Based on UG4 (www.ug4.org/license)".
 * 
 * (3) The following bibliography is recommended for citation and must be
 * preserved in all covered files:
 * "Reiter, S., Vogel, A., Heppner, I., Rupp, M., and Wittum, G. A massively
 *   parallel geometric multigrid solver on hierarchically distributed grids.
 *   Computing and visualization in science 16, 4 (2013), 151-164"
 * "Vogel, A., Reiter, S., Rupp, M., Nägel, A., and Wittum, G. UG4 -- a novel
 *   flexible software system for simulating pde based models on high performance
 *   computers. Computing and visualization in science 16, 4 (2013), 165-179"
 * 
 * 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 Lesser General Public License for more details.
 */
 
#include "externals/lua/lua.h"
#include "registry/registry.h"
#include <string>
 
#ifndef __H__UG_SCRIPT__INFO_COMMANDS__
#define __H__UG_SCRIPT__INFO_COMMANDS__
 
#include "common/ug_config.h"
 
namespace ug
{
namespace bridge
{
 
UG_API bool RegisterInfoCommands(bridge::Registry &reg, const char* grp);
 
UG_API const ClassNameNode* GetClassNameNode(lua_State *L, int index);
 
UG_API const std::vector<const char*> *GetClassNames(lua_State *L, int index);
 
UG_API const std::vector<const char*> *GetClassNames(lua_State* L, const char *name);
 
 
UG_API std::string LuaClassMethodInfo(lua_State *L, int index, const ExportedMethod &thefunc);
 
 
 
UG_API std::string FunctionInfo(lua_State *L, bool bComplete, const char *functionName=NULL);
 
UG_API int UGTypeInfo(const char *p);
 
UG_API bool GetLuaNamespace(lua_State* L, std::string name);
 
UG_API double LuaGetNumber(lua_State *L, const char *name, double notAvailable);
 
UG_API std::string LuaGetString(lua_State *L, const char *name, const char *notAvailable);
 
UG_API bool LuaGetBoolean(lua_State *L, const char *name, bool notAvailable);
 
UG_API std::string LuaCurrentLine(lua_State* L);
 
UG_API void LuaGetLastLine(lua_State* L, lua_Debug entry);
 
UG_API std::string LuaGetScriptFunctionString(lua_State *L, int index=-1);
 
UG_API void LuaPrintTable(lua_State *L, size_t iSpace, int index=-1);
UG_API bool ClassInstantiations(const char *classname);
 
 
UG_API std::string GetLuaTypeString(lua_State* L, int index);
 
 
UG_API std::string LuaStackTraceString(lua_State* L, int fromLevel=0, int toLevel=-1);
 
UG_API std::string LuaStackTraceString();
 
UG_API void LuaStackTrace(int fromlevel);
 
 
UG_API std::string GetLuaFileAndLine(lua_State* L);
 
UG_API std::string GetLuaFileAndLineNumber(lua_State* L);
 
UG_API std::string GetLuaLine(lua_State* L);
 
std::string GetLUAScriptFunctionDefined(const char *functionName);
 
}
}
              
#endif // __H__UG_SCRIPT__INFO_COMMANDS__