<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: m_jvmdebug.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>m_jvmdebug.h</h1><a href="m__jvmdebug_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file m_jvmdebug.h</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// Mode class for the JVMDebug mode</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2010, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"> Copyright (C) 2008-2009, Nicolas VIVIEN</span>
<a name="l00009"></a>00009 <span class="comment"></span>
<a name="l00010"></a>00010 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00011"></a>00011 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00012"></a>00012 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00013"></a>00013 <span class="comment"> (at your option) any later version.</span>
<a name="l00014"></a>00014 <span class="comment"></span>
<a name="l00015"></a>00015 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00016"></a>00016 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00017"></a>00017 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00018"></a>00018 <span class="comment"></span>
<a name="l00019"></a>00019 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00020"></a>00020 <span class="comment"> root directory of this project for more details.</span>
<a name="l00021"></a>00021 <span class="comment">*/</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef __BARRY_M_JVMDEBUG_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_M_JVMDEBUG_H__</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="m__mode__base_8h.html" title="Base for mode classes.">m_mode_base.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="record_8h.html" title="Blackberry database record classes.">record.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Barry {
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="comment">// forward declarations</span>
<a name="l00035"></a>00035 <span class="keyword">class </span>Parser;
<a name="l00036"></a>00036 <span class="keyword">class </span>Builder;
<a name="l00037"></a>00037 <span class="keyword">class </span>Controller;
<a name="l00038"></a>00038
<a name="l00039"></a>00039 <span class="keyword">class </span>JVMModulesEntry;
<a name="l00040"></a>00040 <span class="keyword">class </span>JVMThreadsEntry;
<a name="l00041"></a>00041
<a name="l00042"></a>00042
<a name="l00043"></a><a class="code" href="classBarry_1_1JVMModulesList.html">00043</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1JVMModulesList.html">JVMModulesList</a> : <span class="keyword">public</span> std::vector<JVMModulesEntry>
<a name="l00044"></a>00044 {
<a name="l00045"></a>00045 <span class="keyword">public</span>:
<a name="l00046"></a>00046 <span class="keyword">typedef</span> std::vector<JVMModulesEntry> base_type;
<a name="l00047"></a>00047 <span class="keyword">typedef</span> base_type::iterator iterator;
<a name="l00048"></a>00048 <span class="keyword">typedef</span> base_type::const_iterator const_iterator;
<a name="l00049"></a>00049
<a name="l00050"></a>00050 <span class="keyword">public</span>:
<a name="l00051"></a>00051 <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &entry_packet);
<a name="l00052"></a>00052
<a name="l00053"></a>00053 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00054"></a>00054 };
<a name="l00055"></a>00055 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1JVMModulesList.html">JVMModulesList</a> &list) {
<a name="l00056"></a>00056 list.Dump(os);
<a name="l00057"></a>00057 <span class="keywordflow">return</span> os;
<a name="l00058"></a>00058 }
<a name="l00059"></a>00059
<a name="l00060"></a>00060
<a name="l00061"></a><a class="code" href="classBarry_1_1JVMModulesEntry.html">00061</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1JVMModulesEntry.html">JVMModulesEntry</a>
<a name="l00062"></a>00062 {
<a name="l00063"></a>00063 <span class="keyword">public</span>:
<a name="l00064"></a>00064 uint32_t Id;
<a name="l00065"></a>00065 uint32_t UniqueID;
<a name="l00066"></a>00066 std::string Name;
<a name="l00067"></a>00067
<a name="l00068"></a>00068 <span class="keyword">public</span>:
<a name="l00069"></a>00069 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00070"></a>00070 };
<a name="l00071"></a>00071
<a name="l00072"></a>00072
<a name="l00073"></a><a class="code" href="classBarry_1_1JVMThreadsList.html">00073</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1JVMThreadsList.html">JVMThreadsList</a> : <span class="keyword">public</span> std::vector<JVMThreadsEntry>
<a name="l00074"></a>00074 {
<a name="l00075"></a>00075 <span class="keyword">public</span>:
<a name="l00076"></a>00076 <span class="keyword">typedef</span> std::vector<JVMThreadsEntry> base_type;
<a name="l00077"></a>00077 <span class="keyword">typedef</span> base_type::iterator iterator;
<a name="l00078"></a>00078 <span class="keyword">typedef</span> base_type::const_iterator const_iterator;
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keyword">public</span>:
<a name="l00081"></a>00081 <span class="keywordtype">void</span> Parse(<span class="keyword">const</span> <a class="code" href="classBarry_1_1Data.html">Data</a> &entry_packet);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">void</span> Dump(std::ostream &os) <span class="keyword">const</span>;
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085 BXEXPORT <span class="keyword">inline</span> std::ostream& operator<<(std::ostream &os, <span class="keyword">const</span> <a class="code" href="classBarry_1_1JVMThreadsList.html">JVMThreadsList</a> &list) {
<a name="l00086"></a>00086 list.Dump(os);
<a name="l00087"></a>00087 <span class="keywordflow">return</span> os;
<a name="l00088"></a>00088 }
<a name="l00089"></a>00089
<a name="l00090"></a>00090
<a name="l00091"></a><a class="code" href="classBarry_1_1JVMThreadsEntry.html">00091</a> <span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1JVMThreadsEntry.html">JVMThreadsEntry</a>
<a name="l00092"></a>00092 {
<a name="l00093"></a>00093 <span class="keyword">public</span>:
<a name="l00094"></a>00094 uint32_t Id;
<a name="l00095"></a>00095 uint8_t Byte;
<a name="l00096"></a>00096 uint32_t Address;
<a name="l00097"></a>00097 uint32_t Unknown01; <span class="comment">// FIXME - perhaps should not expose</span>
<a name="l00098"></a>00098 <span class="comment">// these to the app level, until we</span>
<a name="l00099"></a>00099 <span class="comment">// have a name for them, since they</span>
<a name="l00100"></a>00100 <span class="comment">// might change without notice</span>
<a name="l00101"></a>00101 uint32_t Unknown02;
<a name="l00102"></a>00102 uint32_t Unknown03;
<a name="l00103"></a>00103 uint32_t Unknown04;
<a name="l00104"></a>00104 uint32_t Unknown05;
<a name="l00105"></a>00105 uint32_t Unknown06;
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">public</span>:
<a name="l00108"></a>00108 <span class="keywordtype">void</span> Dump(std::ostream &os, <span class="keywordtype">int</span> num) <span class="keyword">const</span>;
<a name="l00109"></a>00109 };
<a name="l00110"></a>00110
<a name="l00111"></a>00111
<a name="l00112"></a>00112 <span class="keyword">namespace </span>Mode {
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">//</span>
<a name="l00115"></a>00115 <span class="comment">// JVMDebug class</span>
<a name="l00116"></a>00116 <span class="comment">//</span><span class="comment"></span>
<a name="l00117"></a>00117 <span class="comment">/// The main interface class to the java program debugger protocol</span>
<a name="l00118"></a>00118 <span class="comment">///</span>
<a name="l00119"></a>00119 <span class="comment">/// To use this class, use the following steps:</span>
<a name="l00120"></a>00120 <span class="comment">///</span>
<a name="l00121"></a>00121 <span class="comment">/// - Create a Controller object (see Controller class for more details)</span>
<a name="l00122"></a>00122 <span class="comment">/// - Create this Mode::JVMDebug object, passing in the Controller</span>
<a name="l00123"></a>00123 <span class="comment">/// object during construction</span>
<a name="l00124"></a>00124 <span class="comment">/// - Call Open() to open database socket and finish constructing.</span>
<a name="l00125"></a>00125 <span class="comment">///</span>
<a name="l00126"></a><a class="code" href="classBarry_1_1Mode_1_1JVMDebug.html">00126</a> <span class="comment"></span><span class="keyword">class </span>BXEXPORT <a class="code" href="classBarry_1_1Mode_1_1JVMDebug.html" title="The main interface class to the java program debugger protocol.">JVMDebug</a> : <span class="keyword">public</span> <a class="code" href="classBarry_1_1Mode_1_1Mode.html" title="Base class for simple mode classes.">Mode</a>
<a name="l00127"></a>00127 {
<a name="l00128"></a>00128 <span class="keyword">private</span>:
<a name="l00129"></a>00129 <span class="keywordtype">bool</span> m_Attached;
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="keyword">protected</span>:
<a name="l00132"></a>00132 <span class="keywordtype">void</span> ThrowJVMError(<span class="keyword">const</span> std::string &msg, uint8_t cmd);
<a name="l00133"></a>00133 <span class="comment"></span>
<a name="l00134"></a>00134 <span class="comment"> //////////////////////////////////</span>
<a name="l00135"></a>00135 <span class="comment"></span> <span class="comment">// overrides</span>
<a name="l00136"></a>00136
<a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnOpen();
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="keyword">public</span>:
<a name="l00140"></a>00140 <a class="code" href="classBarry_1_1Mode_1_1JVMDebug.html" title="The main interface class to the java program debugger protocol.">JVMDebug</a>(<a class="code" href="classBarry_1_1Controller.html" title="The main interface class.">Controller</a> &con);
<a name="l00141"></a>00141 ~<a class="code" href="classBarry_1_1Mode_1_1JVMDebug.html" title="The main interface class to the java program debugger protocol.">JVMDebug</a>();
<a name="l00142"></a>00142 <span class="comment"></span>
<a name="l00143"></a>00143 <span class="comment"> //////////////////////////////////</span>
<a name="l00144"></a>00144 <span class="comment"></span> <span class="comment">// API</span>
<a name="l00145"></a>00145 <span class="keywordtype">void</span> Close();
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keywordtype">void</span> Attach();
<a name="l00148"></a>00148 <span class="keywordtype">void</span> Detach();
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <span class="comment">// mid-attachment operations</span>
<a name="l00151"></a>00151 <span class="keywordtype">void</span> Unknown01(); <span class="comment">// FIXME - make these into a proper API, or</span>
<a name="l00152"></a>00152 <span class="comment">// hide under protected:</span>
<a name="l00153"></a>00153 <span class="keywordtype">void</span> Unknown02();
<a name="l00154"></a>00154 <span class="keywordtype">void</span> Unknown03();
<a name="l00155"></a>00155 <span class="keywordtype">void</span> Unknown04();
<a name="l00156"></a>00156 <span class="keywordtype">void</span> Unknown05();
<a name="l00157"></a>00157 <span class="keywordtype">void</span> Unknown06();
<a name="l00158"></a>00158 <span class="keywordtype">void</span> Unknown07();
<a name="l00159"></a>00159 <span class="keywordtype">void</span> Unknown08();
<a name="l00160"></a>00160 <span class="keywordtype">void</span> Unknown09();
<a name="l00161"></a>00161 <span class="keywordtype">void</span> Unknown10();
<a name="l00162"></a>00162 <span class="keywordtype">void</span> GetModulesList(<a class="code" href="classBarry_1_1JVMModulesList.html">JVMModulesList</a> &mylist);
<a name="l00163"></a>00163 <span class="keywordtype">void</span> GetThreadsList(<a class="code" href="classBarry_1_1JVMThreadsList.html">JVMThreadsList</a> &mylist);
<a name="l00164"></a>00164 <span class="keywordtype">int</span> GetConsoleMessage(std::string &msg);
<a name="l00165"></a>00165 <span class="keywordtype">bool</span> GetStatus(<span class="keywordtype">int</span> &status);
<a name="l00166"></a>00166 <span class="keywordtype">bool</span> WaitStatus(<span class="keywordtype">int</span> &status);
<a name="l00167"></a>00167 <span class="keywordtype">void</span> Go();
<a name="l00168"></a>00168 <span class="keywordtype">void</span> Stop();
<a name="l00169"></a>00169 };
<a name="l00170"></a>00170
<a name="l00171"></a>00171 }} <span class="comment">// namespace Barry::Mode</span>
<a name="l00172"></a>00172
<a name="l00173"></a>00173 <span class="preprocessor">#endif</span>
<a name="l00174"></a>00174 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
