]> git.tdb.fi Git - gldbg.git/blobdiff - source/commandinterpreter.cpp
Track vertex array state
[gldbg.git] / source / commandinterpreter.cpp
index 71e8ee7a001b7eafc14b1ec4f014ff47a48bac84..e73494c1e013790e0b7d209c24d36d90e6f31f28 100644 (file)
@@ -1,15 +1,19 @@
 /* $Id$
 
 This file is part of gldbg
-Copyright © 2009  Mikko Rasa, Mikkosoft Productions
+Copyright © 2009-2010  Mikko Rasa, Mikkosoft Productions
 Distributed under the GPL
 */
 
+#include <signal.h>
+#include <readline/readline.h>
 #include <msp/core/except.h>
 #include <msp/io/file.h>
 #include <msp/io/print.h>
 #include <msp/strings/lexicalcast.h>
+#include <msp/strings/utils.h>
 #include "commandinterpreter.h"
+#include "enums.h"
 #include "gldbg.h"
 #include "tracer.h"
 
@@ -19,14 +23,66 @@ using namespace Msp;
 CommandInterpreter::CommandInterpreter(GlDbg &d):
        gldbg(d)
 {
-       commands["run"] = &CommandInterpreter::cmd_run;
-       commands["continue"] = &CommandInterpreter::cmd_continue;
-       commands["c"] = &CommandInterpreter::cmd_continue;
-       commands["kill"] = &CommandInterpreter::cmd_kill;
-       commands["signal"] = &CommandInterpreter::cmd_signal;
-       commands["exit"] = &CommandInterpreter::cmd_exit;
-       commands["quit"] = &CommandInterpreter::cmd_exit;
-       commands["trace"] = &CommandInterpreter::cmd_trace;
+       commands["help"] = Command(&CommandInterpreter::cmd_help,
+               "Provides help on commands",
+               "help\n"
+               "  Displays a list of commands\n\n"
+               "help COMMAND\n"
+               "  Gives detailed information on a command\n");
+       commands["exit"] = Command(&CommandInterpreter::cmd_exit,
+               "Ends the debugging session");
+       commands["quit"] = Command(&commands["exit"]);
+
+       commands["run"] = Command(&CommandInterpreter::cmd_run,
+               "Starts the program");
+       commands["continue"] = Command(&CommandInterpreter::cmd_continue,
+               "Resumes program execution");
+       commands["kill"] = Command(&CommandInterpreter::cmd_kill,
+               "Terminates the program immediately");
+       commands["signal"] = Command(&CommandInterpreter::cmd_signal,
+               "Resumes execution with a signal",
+               "signal NUM\n"
+               "signal NAME\n"
+               "  Sends the signal identified by NUM or NAME to the program and resumes\n"
+               "  execution.  Currently recognized signal names are HUP, INT, TERM, SEGV\n"
+               "  and TERM.\n");
+
+       commands["trace"] = Command(&CommandInterpreter::cmd_trace,
+               "Traces GL function calls",
+               "trace\n"
+               "  Send trace output to stdout.\n\n"
+               "trace FILE\n"
+               "  Send trace output to FILE (- for stdout).\n\n"
+               "trace {off|on}\n"
+               "  Temporarily suspend or resume trace without closing the file.\n\n"
+               "trace end\n"
+               "  Terminate trace, closing the file.\n");
+
+       commands["profile"] = Command(&CommandInterpreter::cmd_profile,
+               "Profiles GL usage and performance",
+               "profile {on|off}\n"
+               "  Enables or disables profiling\n");
+
+       commands["state"] = Command(&CommandInterpreter::cmd_state,
+               "Inspects general GL state",
+               "state vertex\n"
+               "  Print current vertex attributes\n\n"
+               "state bind\n"
+               "  Show current bindings\n");
+
+       commands["texture"] = Command(&CommandInterpreter::cmd_texture,
+               "Inspect texture state",
+               "texture\n"
+               "  Lists texture objects\n\n"
+               "texture ID\n"
+               "  Print information about a texture object\n");
+
+       commands["buffer"] = Command(&CommandInterpreter::cmd_buffer,
+               "Inspect buffer object state",
+               "buffer\n"
+               "  Lists buffer objects\n\n"
+               "buffer ID\n"
+               "  Print information about a buffer object\n");
 }
 
 void CommandInterpreter::execute(const string &cmd)
@@ -47,9 +103,32 @@ void CommandInterpreter::execute(const string &cmd)
        if(space!=string::npos)
                args = cmd.substr(space+1);
 
-       (this->*(i->second))(args);
+       (this->*(i->second.func))(args);
 }
 
+void CommandInterpreter::cmd_help(const string &args)
+{
+       if(args.empty())
+       {
+               for(map<string, Command>::const_iterator i=commands.begin(); i!=commands.end(); ++i)
+                       if(!i->second.alias_for)
+                               IO::print("%-10s : %s\n", i->first, i->second.description);
+       }
+       else
+       {
+               map<string, Command>::const_iterator i = commands.find(args);
+               if(i==commands.end())
+                       throw KeyError("Unknown command", args);
+
+               const Command *cmd = &i->second;
+               while(cmd->alias_for)
+                       cmd = cmd->alias_for;
+
+               IO::print("%s : %s\n", i->first, cmd->description);
+               if(!i->second.help.empty())
+                       IO::print("\n%s", cmd->help);
+       }
+}
 
 void CommandInterpreter::cmd_run(const string &)
 {
@@ -58,12 +137,28 @@ void CommandInterpreter::cmd_run(const string &)
 
 void CommandInterpreter::cmd_continue(const string &)
 {
+       IO::print("Continuing.\n");
        gldbg.get_process().resume();
 }
 
 void CommandInterpreter::cmd_signal(const string &args)
 {
-       gldbg.get_process().resume(lexical_cast<unsigned>(args));
+       unsigned sig = 0;
+       if(args=="HUP" || args=="SIGHUP")
+               sig = SIGHUP;
+       else if(args=="INT" || args=="SIGINT")
+               sig = SIGINT;
+       else if(args=="ILL" || args=="SIGILL")
+               sig = SIGILL;
+       else if(args=="SEGV" || args=="SIGSEGV")
+               sig = SIGSEGV;
+       else if(args=="TERM" || args=="SIGTERM")
+               sig = SIGTERM;
+       else if(isnumrc(args))
+               sig = lexical_cast<unsigned>(args);
+       else
+               throw InvalidParameterValue("Invalid signal specification");
+       gldbg.get_process().resume(sig);
 }
 
 void CommandInterpreter::cmd_kill(const string &)
@@ -73,42 +168,254 @@ void CommandInterpreter::cmd_kill(const string &)
 
 void CommandInterpreter::cmd_exit(const string &)
 {
-       gldbg.quit();
+       if(gldbg.get_process().get_state()!=Process::INACTIVE)
+       {
+               IO::print("Program is still running.  Kill it?\n");
+               char *answer = readline("[y/n] ");
+               if(answer[0]=='y')
+               {
+                       gldbg.get_process().kill();
+                       gldbg.quit(true);
+               }
+               else
+                       IO::print("Not confirmed.\n");
+       }
+       else
+               gldbg.quit(false);
 }
 
 void CommandInterpreter::cmd_trace(const string &args)
 {
        Tracer &tracer = gldbg.get_tracer();
-       if(args[0]=='>')
+       if(args.empty() || args=="-")
+       {
+               tracer.set_output(IO::cout);
+               IO::print("Tracing to stdout\n");
+       }
+       else if(args=="on")
+       {
+               tracer.enable();
+               IO::print("Tracing enabled\n");
+       }
+       else if(args=="off")
+       {
+               tracer.disable();
+               IO::print("Tracing disabled\n");
+       }
+       else if(args=="end")
        {
-               string fn = args.substr(1);
-               if(fn=="-")
+               tracer.set_output(0);
+               IO::print("Tracing terminated\n");
+       }
+       else
+       {
+               tracer.set_output(new IO::File(args, IO::M_WRITE));
+               IO::print("Tracing to %s\n", args);
+       }
+}
+
+void CommandInterpreter::cmd_profile(const string &args)
+{
+       Profiler &profiler = gldbg.get_profiler();
+       if(args.empty() || args=="on")
+               profiler.enable();
+       else if(args=="off")
+               profiler.disable();
+       else
+               throw InvalidParameterValue("Invalid argument");
+}
+
+void CommandInterpreter::cmd_state(const string &args)
+{
+       const GlState &glstate = gldbg.get_glstate();
+       if(args=="vertex")
+       {
+               IO::print("Current vertex attributes:\n");
+               const Vector4 &color = glstate.get_color();
+               IO::print("  Color:     [%05.3f, %05.3f, %05.3f, %05.3f]\n", color.r, color.g, color.b, color.a);
+               for(unsigned i=0; i<8; ++i)
                {
-                       tracer.set_output(IO::cout);
-                       IO::print("Tracing to stdout\n");
+                       const Vector4 &texcoord = glstate.get_texcoord(i);
+                       IO::print("  TexCoord%d: [%05.3f, %05.3f, %05.3f, %05.3f]\n", i, texcoord.s, texcoord.t, texcoord.p, texcoord.q);
                }
-               else
+               const Vector3 &normal = glstate.get_normal();
+               IO::print("  Normal:    [%05.3f, %05.3f, %05.3f]\n", normal.x, normal.y, normal.z);
+       }
+       else if(args=="bind")
+       {
+               IO::print("Current bindings:\n");
+               for(unsigned i=0; i<8; ++i)
                {
-                       tracer.set_output(new IO::File(fn, IO::M_WRITE));
-                       IO::print("Tracing to %s\n", fn);
+                       IO::print("  Texture unit %d:\n", i);
+                       const TexUnitState &unit = glstate.get_texture_unit(i);
+                       IO::print("    GL_TEXTURE_2D: %s\n", unit.describe_binding(GL_TEXTURE_2D));
+                       IO::print("    GL_TEXTURE_3D: %s\n", unit.describe_binding(GL_TEXTURE_3D));
                }
+               IO::print("  Buffers:\n");
+               const BufferState *buf = glstate.get_current_buffer(GL_ARRAY_BUFFER);
+               IO::print("    GL_ARRAY_BUFFER:         %d\n", (buf ? buf->id : 0));
+               buf = glstate.get_current_buffer(GL_ELEMENT_ARRAY_BUFFER);
+               IO::print("    GL_ELEMENT_ARRAY_BUFFER: %d\n", (buf ? buf->id : 0));
        }
        else
+               throw InvalidParameterValue("Invalid or missing argument");
+}
+
+void CommandInterpreter::cmd_texture(const string &args)
+{
+       if(args.empty())
        {
-               if(args=="on")
+               const map<unsigned, TextureState> &textures = gldbg.get_glstate().get_textures();
+               IO::print("%d texture objects:\n", textures.size());
+               for(map<unsigned, TextureState>::const_iterator i = textures.begin(); i!=textures.end(); ++i)
                {
-                       tracer.enable();
-                       IO::print("Tracing enabled\n");
+                       const TextureState &tex = i->second;
+                       IO::print("  %d: %s, %d images\n", i->first, tex.describe(), tex.images.size());
                }
-               else if(args=="off")
+       }
+       else
+       {
+               unsigned id = lexical_cast<unsigned>(args);
+               const TextureState &tex = gldbg.get_glstate().get_texture(id);
+               IO::print("Texture object %d\n", id);
+               IO::print("  Target:          %s\n", describe_enum(tex.target, "TextureTarget"));
+               IO::print("  Images:\n");
+               for(unsigned i=0; i<tex.images.size(); ++i)
                {
-                       tracer.disable();
-                       IO::print("Tracing disabled\n");
+                       const TexImageState &img = tex.images[i];
+                       IO::print("    Level %2d:      %s\n", i, img.describe());
                }
-               else if(args=="end")
+               IO::print("  Min. filter:     %s\n", describe_enum(tex.min_filter, "TextureMinFilter"));
+               IO::print("  Mag. filter:     %s\n", describe_enum(tex.mag_filter, "TextureMagFilter"));
+               IO::print("  Wrap modes:      S=%s / T=%s / R=%s\n", describe_enum(tex.wrap_s, "TextureWrapMode"),
+                       describe_enum(tex.wrap_t, "TextureWrapMode"), describe_enum(tex.wrap_r, "TextureWrapMode"));
+               IO::print("  Compare mode:    %s\n", describe_enum(tex.compare_mode, ""));
+               IO::print("  Compare func:    %s\n", describe_enum(tex.compare_func, "DepthFunction"));
+               IO::print("  Generate mipmap: %s\n", tex.generate_mipmap);
+       }
+}
+
+void CommandInterpreter::cmd_buffer(const string &args)
+{
+       if(args.empty())
+       {
+               const GlState::BufferMap &buffers = gldbg.get_glstate().get_buffers();
+               IO::print("%d buffers:\n", buffers.size());
+               for(GlState::BufferMap::const_iterator i=buffers.begin(); i!=buffers.end(); ++i)
+                       IO::print("  %d: %s\n", i->first, i->second.describe());
+       }
+       else
+       {
+               unsigned id = lexical_cast<unsigned>(args);
+               const BufferState &buf = gldbg.get_glstate().get_buffer(id);
+               IO::print("Buffer %d:\n", id);
+               IO::print("  Size:  %d bytes\n", buf.size);
+               IO::print("  Usage: %s\n", describe_enum(buf.usage, ""));
+               if(buf.content.stride)
                {
-                       tracer.set_output(0);
-                       IO::print("Tracing terminated\n");
+                       IO::print("  Stride: %d bytes\n", buf.content.stride);
+
+                       IO::print("  Arrays:\n");
+                       const vector<BufferContent::Array> &arrays = buf.content.arrays;
+                       for(vector<BufferContent::Array>::const_iterator i=arrays.begin(); i!=arrays.end(); ++i)
+                       {
+                               if(i->kind)
+                                       IO::print("    %2d: %s, %d %s\n", i->offset,
+                                               describe_enum(i->kind, ""), i->size, describe_enum(i->type, "DataType"));
+                               else
+                                       IO::print("    %2d: Attrib %d, %d %s\n", i->offset,
+                                               i->index, i->size, describe_enum(i->type, "DataType"));
+                       }
+
+                       IO::print("  Data:\n");
+                       string header;
+                       for(vector<BufferContent::Array>::const_iterator i=arrays.begin(); i!=arrays.end(); ++i)
+                       {
+                               if(!header.empty())
+                                       header += " | ";
+
+                               string label;
+                               if(i->kind==GL_VERTEX_ARRAY)
+                                       label = "Vertex";
+                               else if(i->kind==GL_NORMAL_ARRAY)
+                                       label = "Normal";
+                               else if(i->kind==GL_COLOR_ARRAY)
+                                       label = "Color";
+                               else if(i->kind==GL_TEXTURE_COORD_ARRAY)
+                               {
+                                       if(i->size==1)
+                                               label = "TexC";
+                                       else
+                                               label = "TexCoord";
+                               }
+                               else if(!i->kind)
+                               {
+                                       if(i->size==1)
+                                               label = format("A %d", i->index);
+                                       else
+                                               label = format("Attrib %d", i->index);
+                               }
+
+                               unsigned width = i->size;
+                               if(i->type==GL_FLOAT)
+                                       width *= 5;
+                               else if(i->type==GL_UNSIGNED_BYTE)
+                                       width *= 3;
+                               width += i->size-1;
+
+                               header.append((width-label.size())/2, ' ');
+                               header += label;
+                               header.append((width-label.size()+1)/2, ' ');
+                       }
+                       IO::print("     %s\n", header);
+
+                       unsigned n_verts = buf.size/buf.content.stride;
+                       for(unsigned i=0; i<n_verts; ++i)
+                       {
+                               const char *vertex = buf.data+i*buf.content.stride;
+
+                               string line;
+                               for(vector<BufferContent::Array>::const_iterator j=arrays.begin(); j!=arrays.end(); ++j)
+                               {
+                                       if(!line.empty())
+                                               line += " |";
+
+                                       const char *base = vertex+j->offset;
+                                       for(unsigned k=0; k<j->size; ++k)
+                                       {
+                                               if(j->type==GL_FLOAT)
+                                                       line += format(" %5.2f", *(reinterpret_cast<const float *>(base)+k));
+                                               else if(j->type==GL_UNSIGNED_BYTE)
+                                                       line += format(" %3u", *(reinterpret_cast<const unsigned char *>(base)+k));
+                                       }
+                               }
+
+                               IO::print("%3d:%s\n", i, line);
+                       }
                }
        }
 }
+
+
+CommandInterpreter::Command::Command():
+       func(0),
+       alias_for(0)
+{ }
+
+CommandInterpreter::Command::Command(Command *cmd):
+       func(cmd->func),
+       alias_for(cmd)
+{ }
+
+CommandInterpreter::Command::Command(Func f, const string &d):
+       func(f),
+       description(d),
+       alias_for(0)
+{ }
+
+CommandInterpreter::Command::Command(Func f, const string &d, const string &h):
+       func(f),
+       description(d),
+       help(h),
+       alias_for(0)
+{ }