net.sourceforge.phpeclipse.debug.core/src/net/sourceforge/phpdt/internal/debug/core/PHPDBGInterface.java

   1 /**********************************************************************
   2 Copyright (c) 2000, 2002 IBM Corp. and others.
   3 All rights reserved. This program and the accompanying materials
   4 are made available under the terms of the Common Public License v1.0
   5 which accompanies this distribution, and is available at
   6 http://www.eclipse.org/legal/cpl-v10.html
   7
   8 Contributors:
   9         Vicente Fernando - www.alfersoft.com.ar - Initial implementation
  10         Christian Perkonig - remote debug
  11 **********************************************************************/
  12 package net.sourceforge.phpdt.internal.debug.core;
  13
  14 import java.io.BufferedReader;
  15 import java.io.IOException;
  16 import java.io.OutputStream;
  17 import java.util.Vector;
  18 import java.util.Collections;
  19
  20 import net.sourceforge.phpdt.internal.debug.core.model.PHPDBGEvalString;
  21 import net.sourceforge.phpdt.internal.debug.core.model.PHPStackFrame;
  22 import net.sourceforge.phpdt.internal.debug.core.model.PHPVariable;
  23 import net.sourceforge.phpdt.internal.debug.core.model.PHPValue;
  24
  25 import org.eclipse.core.runtime.IStatus;
  26 import org.eclipse.core.runtime.Status;
  27 import org.eclipse.debug.core.DebugException;
  28
  29 import java.io.RandomAccessFile;
  30
  31 /**
  32  * The interface object are created by the proxy
  33  *
  34  */
  35 public class PHPDBGInterface {
  36
  37         public boolean                  sessionEnded = false;
  38         public int                              sessType         = -1;
  39         public int                              BPUnderHit       = 0;
  40         public String                   sessID           = new String ();
  41
  42         private int[]                   LastBPRead   = new int[10];
  43         private Vector                  DBGBPList    = new Vector ();
  44         private Vector          DBGVarList   = new Vector ();
  45         private PHPStackFrame[] DBGStackList;
  46         private Vector                  DBGMods          = new Vector ();                       // The module names and their numbers
  47         private Vector          stackListOld = new Vector ();
  48         private BufferedReader  in;
  49         private OutputStream    os;                                                                             // The stream which goes to DBG
  50         private boolean                 shouldStop       = false;
  51         private String                  evalRet          = new String ("");
  52         private String                  serGlobals       = new String ("");
  53         private int                     rawCounter       = 1000;                                        // An rawData frame ID counter
  54         private PHPDBGProxy     proxy            = null;
  55         private int                     lastCmd          = -1;
  56         private int                     sid                      = 0;
  57         private boolean                 stopOnError      = false;
  58         private char[]                  lastCommand      = new char[4];
  59
  60         /**
  61          * @param in    The input stream (communication from DBG).
  62          * @param os    The output stream (communication to DBG).
  63          * @param proxy The proxy to which this interface belongs.
  64          */
  65         public PHPDBGInterface (BufferedReader in, OutputStream os, PHPDBGProxy proxy) {
  66                 DBGBPList.clear ();
  67
  68                 this.in         = in;
  69                 this.os         = os;
  70                 this.proxy      = proxy;
  71         }
  72
  73         /**
  74          *
  75          * @param mod_name The module (source file) to which we add the breakpoint.
  76          * @param line     The line where the breakpoint is set.
  77          * @return         Breakpoint ID ???.
  78          */
  79         public int addBreakpoint (String mod_name, int line) throws IOException {
  80                 return setBreakpoint (mod_name, "", line, PHPDBGBase.BPS_ENABLED + PHPDBGBase.BPS_UNRESOLVED, 0, 0, 0, 0, 0);
  81         }
  82
  83         /**
  84          *
  85          * @param mod_name The module (source file) to which we add the breakpoint.
  86          * @param line     The line where the breakpoint is set.
  87          * @param bpNo     The breakpoint ID ???.
  88          */
  89         public void removeBreakpoint (String mod_name, int line, int bpNo) throws IOException {
  90                 setBreakpoint (mod_name, "", line, PHPDBGBase.BPS_DISABLED, 0, 0, 0, bpNo, 0);
  91         }
  92
  93         /**
  94          * Is this method used anywhere?
  95          *
  96          */
  97         public void requestDBGVersion () throws IOException {
  98                 PHPDBGPacket DBGPacket;                                     // A DBG message packet
  99                 PHPDBGFrame  DBGFrame;                                      // A frame within a DBG packet
 100
 101                 DBGPacket = new PHPDBGPacket (PHPDBGBase.DBGA_REQUEST);     // A request for DBG
 102                 DBGFrame  = new PHPDBGFrame (PHPDBGBase.FRAME_VER);         // We want the version of DBG
 103
 104                 DBGPacket.addFrame (DBGFrame);                              // Add the 'what we want' to the DBG packet
 105
 106                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 107                         return;                                                 //  No
 108                 }
 109
 110                 DBGPacket.sendPacket (os);                                                                      // Send the request to DBG
 111         }
 112
 113         /**
 114          * Called by the proxy
 115          *
 116          */
 117         public void getSourceTree () throws IOException {
 118                 PHPDBGPacket DBGPacket;                                     // A DBG message packet
 119                 PHPDBGFrame  DBGFrame;                                      // A frame within a DBG packet
 120
 121                 DBGPacket = new PHPDBGPacket (PHPDBGBase.DBGA_REQUEST);     // A request for DBG
 122                 DBGFrame  = new PHPDBGFrame (PHPDBGBase.FRAME_SRC_TREE);        // We want a source tree from DBG
 123
 124                 DBGPacket.addFrame (DBGFrame);                              // Add the 'what we want' to the DBG packet
 125
 126                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 127                         return;                                                                                                 //  No
 128                 }
 129
 130                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 131
 132                 waitResponse (1000);                                        // Wait for the DBG response (1 second)
 133                 flushAllPackets ();                                                                             // Read and process the response from DBG
 134         }
 135
 136         /**
 137          * Is this method called from anywhere?
 138          *
 139          * @param modName The modul (filename).
 140          */
 141         public void addDBGModName (String modName) throws IOException {
 142                 PHPDBGPacket DBGPacket;                                     // A DBG message packet
 143                 PHPDBGFrame  DBGFrame;                                      // A frame within a DBG packet
 144
 145                 DBGPacket = new PHPDBGPacket (PHPDBGBase.DBGA_REQUEST);     // A request for DBG
 146                 DBGFrame  = new PHPDBGFrame (PHPDBGBase.FRAME_RAWDATA);     // We want Module name from DBG
 147
 148                 rawCounter++;                                               // Increment the rawData ID counter
 149                 DBGFrame.addInt (rawCounter);                                                           // FRAME_RAWDATA ID
 150                 DBGFrame.addInt (modName.length () + 1);                                        // The length of rawdata string (incl. null char termination)
 151                 DBGFrame.addString (modName);                                                           // The file name (module name)
 152                 DBGFrame.addChar ('\0');                                                                        // Add the C-String null termination
 153
 154                 DBGPacket.addFrame (DBGFrame);
 155
 156                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 157                         return;                                                                                                 //  No
 158                 }
 159
 160                 DBGPacket.sendPacket (os);
 161         }
 162
 163         /**
 164          * This method is called for adding or removing breakpoints.
 165          *
 166          * @param mod_name      The module name (file name).
 167          * @param condition     Info about the condition when to break (not used at the moment).
 168          * @param line          The breakpoints line.
 169          * @param state         Info whether this breakpoint has to be dis- or enabled.
 170          * @param istep         Always 0.
 171          * @param hitcount      Always 0.
 172          * @param skiphits      Always 0.
 173          * @param bpno          The breakpoint ID.
 174          * @param isunderhit    ???
 175          * @return
 176          */
 177         private int setBreakpoint (String mod_name, String condition, int line, int state, int istemp, int hitcount, int skiphits, int bpno, int isunderhit) throws IOException {
 178                 PHPDBGPacket    DBGPacket;
 179                 PHPDBGFrame     DBGFrame1;
 180                 PHPDBGFrame     DBGFrame2;
 181                 int                     modNo;
 182
 183                 DBGPacket       = new PHPDBGPacket (PHPDBGBase.DBGA_REQUEST);
 184                 DBGFrame1       = new PHPDBGFrame (PHPDBGBase.FRAME_BPS);
 185                 DBGFrame2       = new PHPDBGFrame (PHPDBGBase.FRAME_RAWDATA);
 186
 187                 modNo           = getModByName (mod_name);                                              // Get the module ID by name
 188
 189                 if (modNo >= 0) {                                           // Did we find a module ID for the module name?
 190                         DBGFrame1.addInt (modNo);                                                               // Add the module ID to frame 1
 191                 } else {
 192                         DBGFrame1.addInt (0);                                                                   // mod number (0 use file name)
 193                 }
 194
 195                 DBGFrame1.addInt (line);                                                                        // line number
 196
 197                 if (modNo >= 0) {                                           // Did we find a module ID for the module name?
 198                         DBGFrame1.addInt (0);                                                                   // use mod number
 199                 } else {
 200                         rawCounter++;
 201                         DBGFrame1.addInt (rawCounter);                                                  // ID of FRAME_RAWDATA to send file name
 202                 }
 203
 204                 DBGFrame1.addInt (state);                                       // state BPS_*
 205                 DBGFrame1.addInt (istemp);                                      // istep
 206                 DBGFrame1.addInt (hitcount);                                // hit count
 207                 DBGFrame1.addInt (skiphits);                                // skip hits
 208                 DBGFrame1.addInt (0);                                           // ID of condition
 209                 DBGFrame1.addInt (bpno);                                            // breakpoint number
 210                 DBGFrame1.addInt (isunderhit);                                  // is under hit
 211
 212                 if (modNo < 0) {                                            // Did we find a module ID for the module name?
 213                         DBGFrame2.addInt (rawCounter);                                      // FRAME_RAWDATA ID
 214                         DBGFrame2.addInt (mod_name.length() + 1);                   // length of rawdata (+ null char)
 215                         DBGFrame2.addString (mod_name);                                     // file name
 216                         DBGFrame2.addChar ('\0');                                                   // null char
 217
 218                         DBGPacket.addFrame (DBGFrame2);                         // First add file name data
 219                 }
 220
 221                 DBGPacket.addFrame (DBGFrame1);                                                         // Second add command data
 222
 223                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 224                         return 0;                                               //  No
 225                 }
 226
 227                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 228
 229                 clearLastBP ();
 230
 231                 waitResponse (1000);                                        // Wait for the DBG response (1 second)
 232                 flushAllPackets ();                                         // Read and process the response from DBG
 233
 234                 return LastBPRead[8];                                                                           // Return what ???
 235         }
 236
 237         /**
 238          *
 239          */
 240         private void clearLastBP () {
 241                 int i;
 242
 243                 for (i = 0; i < LastBPRead.length; i++) {
 244                         LastBPRead[i] = 0;
 245                 }
 246         }
 247
 248         /**
 249          *
 250          */
 251         private void copyToLastBP (int[] BPBody) {
 252                 int i;
 253
 254                 for (i = 0; i < LastBPRead.length; i++) {
 255                         LastBPRead[i] = BPBody[i];
 256                 }
 257         }
 258
 259         /**
 260          *
 261          */
 262         public void continueExecution () throws IOException {
 263                 PHPDBGPacket DBGPacket;
 264
 265                 BPUnderHit = 0;
 266                 DBGPacket  = new PHPDBGPacket (PHPDBGBase.DBGA_CONTINUE);
 267
 268                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 269                         return;                                                 //  No
 270                 }
 271
 272                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 273
 274                 lastCommand = PHPDBGBase.DBGA_CONTINUE;                     // Store the info about the command we sent
 275         }
 276
 277         /**
 278          *
 279          */
 280         public void pauseExecution () throws IOException {
 281                 PHPDBGPacket DBGPacket;
 282
 283                 DBGPacket = new PHPDBGPacket (PHPDBGBase.IntToChar4 (PHPDBGBase.DBGC_PAUSE));
 284
 285                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 286                          return;                                                //  No
 287                 }
 288
 289                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 290         }
 291
 292         /**
 293          *
 294          */
 295         private int getBPUnderHit () {
 296                 int i;
 297                 int BPUnder             = 0;
 298                 int[] dbg_bpl_body      = new int[10];
 299
 300                 for (i = 0; i < DBGBPList.size (); i++) {                               // look for bp under hit
 301                         dbg_bpl_body = (int[]) DBGBPList.get (i);
 302
 303                         if (dbg_bpl_body[9] == 1) {
 304                                 BPUnder = dbg_bpl_body[8];
 305                         }
 306                 }
 307
 308                 return BPUnder;
 309         }
 310
 311         public int getLastCmd()
 312         {
 313                 return lastCmd;
 314         }
 315
 316         public int getSID()
 317         {
 318           return sid;
 319         }
 320
 321         public void setLastCmd (int cmd)
 322         {
 323                 lastCmd = cmd;
 324         }
 325
 326         /**
 327          *
 328          */
 329         public void stepInto () throws IOException {
 330                 PHPDBGPacket DBGPacket;
 331
 332                 BPUnderHit = 0;
 333                 DBGPacket  = new PHPDBGPacket (PHPDBGBase.DBGA_STEPINTO);
 334
 335                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 336                         return;                                                 //  No
 337                 }
 338
 339                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 340
 341                 lastCommand = PHPDBGBase.DBGA_STEPINTO;                                         // Store the info about the command we sent
 342         }
 343
 344         /**
 345          *
 346          */
 347         public void stepOver () throws IOException {
 348                 PHPDBGPacket DBGPacket;
 349
 350                 BPUnderHit = 0;
 351                 DBGPacket  = new PHPDBGPacket (PHPDBGBase.DBGA_STEPOVER);
 352
 353                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 354                         return;                                                 //  No
 355                 }
 356
 357                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 358
 359                 lastCommand = PHPDBGBase.DBGA_STEPOVER;                     // Store the info about the command we sent
 360         }
 361
 362         /**
 363          *
 364          */
 365         public void stepOut () throws IOException {
 366                 PHPDBGPacket DBGPacket;
 367
 368                 BPUnderHit = 0;
 369                 DBGPacket  = new PHPDBGPacket (PHPDBGBase.DBGA_STEPOUT);
 370
 371                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 372                         return;                                                 //  No
 373                 }
 374
 375                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 376
 377                 lastCommand = PHPDBGBase.DBGA_STEPOUT;                      // Store the info about the command we sent
 378         }
 379
 380         /**
 381          *
 382          */
 383         public void stopExecution () throws IOException {
 384                 PHPDBGPacket DBGPacket;
 385
 386                 BPUnderHit = 0;
 387                 DBGPacket  = new PHPDBGPacket (PHPDBGBase.DBGA_STOP);
 388
 389                 if (proxy.getSocket ().isClosed ()) {                                           // Can we communiate with DBG?
 390                         return;                                                 //  No
 391                 }
 392
 393                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 394         }
 395
 396         /**
 397          * This method is called by the proxy.
 398          * It sends a request to DBG to get the current variables
 399          * with their values. It waits for the response and processes
 400          * the input from DBG.
 401          *
 402          * @param stack The stackframe for which we want the variables.
 403          * @return      The array of variables
 404          */
 405         public Vector getVariables (PHPStackFrame stack) throws IOException, DebugException  {
 406                 PHPDBGPacket            DBGPacket;
 407                 PHPDBGFrame             DBGFrame1;
 408                 PHPDBGEvalString        evalStr;
 409
 410                 DBGPacket = new PHPDBGPacket (PHPDBGBase.DBGA_REQUEST);     //
 411             DBGFrame1 = new PHPDBGFrame (PHPDBGBase.FRAME_EVAL);        //
 412
 413                 DBGFrame1.addInt (0);                                                                           // istr = raw data ID
 414                 DBGFrame1.addInt (1);                                                                           // scope_id = -1 means current location, 0 never used, +1 first depth
 415
 416                 DBGPacket.addFrame (DBGFrame1);                             // Add command data
 417
 418                 if (proxy.getSocket ().isClosed ()) {                       // Do we have a socket for DBG communication?
 419                         return null;                                                                                    //  No, then leave here
 420                 }
 421
 422                 DBGPacket.sendPacket (os);                                  // Send the request to DBG
 423
 424                 waitResponse (1000);                                        // Wait for the DBG response (1 second)
 425                 flushAllPackets ();                                         // Read and process the response from DBG
 426
 427                 evalStr         = new PHPDBGEvalString (stack, serGlobals); // Process serialized variables
 428                 DBGVarList      = evalStr.getVariables ();
 429
 430                 //resetHasChangedInfo (DBGVarList);                                                     // Reset the hasChanged info for all PHPVariables
 431                 //updateVariableList (DBGVarList, evalStr.getVariables ());     // Replicate the 'static' variable list and the via DBG received variable list
 432
 433                 return DBGVarList;                                                                                      // Return the variables as list
 434         }
 435
 436         /**
 437          *
 438          * @param logString
 439          */
 440         public void log(String logString) throws IOException, DebugException  {
 441                 PHPDBGPacket DBGPacket= new PHPDBGPacket(PHPDBGBase.DBGA_REQUEST);
 442                 PHPDBGFrame DBGFrame1= new PHPDBGFrame(PHPDBGBase.FRAME_LOG);
 443                 PHPDBGFrame DBGFrame2= new PHPDBGFrame(PHPDBGBase.FRAME_RAWDATA);
 444
 445                 rawCounter++;
 446                 DBGFrame1.addInt(rawCounter);                           // ilog
 447                 DBGFrame1.addInt(1);                                            // type
 448                 DBGFrame1.addInt(0);                                            // mod_no
 449                 DBGFrame1.addInt(0);                                            // line_no
 450                 DBGFrame1.addInt(0);                                            // imod_name
 451                 DBGFrame1.addInt(0);                                            // ext_info
 452
 453                 DBGFrame2.addInt(rawCounter);                           // FRAME_RAWDATA ID
 454                 DBGFrame2.addInt(logString.length() + 1);       // length of rawdata (+ null char)
 455                 DBGFrame2.addString(logString);                         // log string
 456                 DBGFrame2.addChar('\0');                                        // null char
 457
 458                 // Add raw data first
 459                 DBGPacket.addFrame(DBGFrame2);
 460                 // Add command data
 461                 DBGPacket.addFrame(DBGFrame1);
 462
 463                 if(proxy.getSocket().isClosed()) return;
 464                 DBGPacket.sendPacket(os);
 465
 466                 waitResponse(1000);
 467                 flushAllPackets();
 468         }
 469
 470         public PHPVariable[] evalBlock(PHPStackFrame stack, String evalString) throws IOException, DebugException  {
 471                 PHPDBGPacket DBGPacket= new PHPDBGPacket(PHPDBGBase.DBGA_REQUEST);
 472                 PHPDBGFrame DBGFrame1= new PHPDBGFrame(PHPDBGBase.FRAME_EVAL);
 473                 PHPDBGFrame DBGFrame2= new PHPDBGFrame(PHPDBGBase.FRAME_RAWDATA);
 474
 475                 rawCounter++;
 476                 DBGFrame1.addInt(rawCounter);                           // istr = raw data ID
 477                 DBGFrame1.addInt(1);                                            // scope_id = -1 means current location, 0 never used, +1 first depth
 478
 479                 DBGFrame2.addInt(rawCounter);                           // FRAME_RAWDATA ID
 480                 DBGFrame2.addInt(evalString.length() + 1);      // length of rawdata (+ null char)
 481                 DBGFrame2.addString(evalString);                        // eval block
 482                 DBGFrame2.addChar('\0');                                        // null char
 483
 484                 // Add raw data first
 485                 DBGPacket.addFrame(DBGFrame2);
 486                 // Add command data
 487                 DBGPacket.addFrame(DBGFrame1);
 488
 489                 if(proxy.getSocket().isClosed()) return null;
 490                 DBGPacket.sendPacket(os);
 491
 492                 waitResponse(1000);
 493                 flushAllPackets();
 494
 495                 PHPDBGEvalString evalStr=new PHPDBGEvalString(stack,evalRet);
 496
 497                 return evalStr.getVars();
 498
 499         }
 500
 501         /**
 502          * Read and process everthing we got from DBG
 503          */
 504         public void flushAllPackets () throws IOException {
 505                 while (readResponse() != 0);
 506         }
 507
 508         /**
 509          * Get the modules name by its number
 510          *
 511          * @param modNo The number (id) of the module
 512          * @return      The name of the module
 513          */
 514         public String getModByNo (int modNo) {
 515                 int             i;
 516                 PHPDBGMod       dbg_mod;
 517
 518                 for (i = 0; i < DBGMods.size (); i++) {                         // For all the modules we have within the array
 519                         dbg_mod = (PHPDBGMod) DBGMods.get (i);                      // Get the module
 520
 521                         if (dbg_mod.getNo () == modNo) {                            // Is the module from the array the module we want?
 522                                 return dbg_mod.getName ();                              //  Yes, return the name of the module
 523                         }
 524                 }
 525
 526                 return "";                                                      // If nothing was found return emtpy string
 527         }
 528
 529         /**
 530          *
 531          * @param  modName The name of the module for which we want the ID
 532          * @return
 533          * - The ID of the module
 534          * - -1 if nothing was found
 535          */
 536         private int getModByName (String modName) {
 537                 int             i;
 538                 PHPDBGMod       dbg_mod;
 539
 540                 for (i = 0; i < DBGMods.size (); i++) {                         // For all the modules we have within the array
 541                         dbg_mod = (PHPDBGMod) DBGMods.get (i);                      // Get the module
 542
 543                         if (dbg_mod.getName ().equalsIgnoreCase (modName)) {            // Is the module from the array the module we want?
 544                                 return dbg_mod.getNo ();                                //  Yes, return the name of the module
 545                         }
 546                 }
 547
 548                 return -1;                                                      // If nothing was found return -1
 549         }
 550
 551         /**
 552          * Return the string for the given frame number
 553          *
 554          * @param framesInfo The buffer which is to read
 555          * @param frameNo    The frame number
 556          * @return
 557          */
 558         private String getRawFrameData (char[] framesInfo, int frameNo) {
 559                 int   nextFrame = 0;                                                    // The current read position within the buffer
 560                 int[] dbg_frame = new int[2];                                           // The two frame header numbers
 561
 562                 while (nextFrame < framesInfo.length) {                                 // As long we have something within the buffer
 563                         dbg_frame[0] = PHPDBGBase.Char4ToInt (framesInfo, nextFrame);           // The frame type
 564                         dbg_frame[1] = PHPDBGBase.Char4ToInt (framesInfo, nextFrame + 4);       // The frame size
 565
 566                         nextFrame   += 8;                                                   // The current read position
 567
 568                         if (dbg_frame[1] == 0) {                                            // If frame size is 0
 569                                 return "";                                                      //  return an emtpy string
 570                         }
 571
 572                         switch (dbg_frame[0]) {                                                     // Switch for the frame type
 573                                 case PHPDBGBase.FRAME_RAWDATA:                                                  // The only frame type we are interrested in
 574                                         if (frameNo == PHPDBGBase.Char4ToInt (framesInfo, nextFrame)) {         // Is it correct  number of the frame
 575                                                 int toRead;                                                     //
 576
 577                                                 toRead = PHPDBGBase.Char4ToInt (framesInfo, nextFrame + 4);     // The size of the string
 578
 579                                                 return String.copyValueOf (framesInfo, nextFrame + 8, toRead);  // Copy frame content to String and return
 580                                         }
 581                                         break;
 582                         }
 583
 584                         nextFrame += dbg_frame[1];                                                                      // Go for the next frame (add the length of the current one)
 585                 }
 586
 587                 return "";                                                                                                                                              // We did not found any FRAM_RAWDATA, so return an emtpy strin
 588         }
 589
 590         /**
 591          *
 592          * The stackList contains the currently read stackframes which were sent
 593          * from DBG. The DBG interface holds a list of the active stack frames.
 594          * This method replicates the 'static' stackframe list with the DBG stackframe list
 595          * Replication is done in the following way:
 596          * <ul>
 597          * <li> It looks for new stackframes within the DBG stackframe list and
 598          *      adds them to the 'static' list.
 599          * <li> It looks for stackframes within the 'static' list, and removes them
 600          *              from the 'static' list in case the do not appear within the DBG list.
 601          * <li> It looks for stackframes which are already existent and replicates the
 602          *              line number and the index number.
 603          * <li> At the end the 'static' stackfram list has to be sorted by the stackframes
 604          *              index numbers.
 605          * </ul>
 606          *
 607          * Removes the unused stackframes from the list, or adds stackframes which
 608          * are not yet in the list.
 609          *
 610          *
 611          * @param stackList
 612          */
 613         private void updateStackFrameList (Vector stackList) {
 614                 int                     i;
 615                 int             n;
 616                 PHPStackFrame   stackFrameNew;
 617                 PHPStackFrame   stackFrameOld;
 618                 PHPStackFrame[] newStackList;
 619
 620                 for (i = 0; i < stackList.size (); i++) {                                                               // For all stackList entries
 621                         stackFrameNew = (PHPStackFrame) stackList.get(i);
 622
 623                         for (n = 0; n < stackListOld.size (); n++) {                                    // For all StackFrames in the StackFrame list
 624                                 stackFrameOld = (PHPStackFrame) stackListOld.get (n);                   //
 625
 626                                 if (stackFrameNew.getDescription ().equals (stackFrameOld.getDescription ())) { // Did we find the sent stackframe within the list of old stackframes?
 627                                         stackFrameOld.setLineNumber (stackFrameNew.getLineNumber ());
 628                                         stackFrameOld.setIndex (stackFrameNew.getIndex ());
 629
 630                                         break;                                                                  //  Yes, then break;
 631                                 }
 632                         }
 633
 634                         if (n == stackListOld.size ()) {                                    // Did not find the new stackframe within the list
 635                                  stackListOld.add (stackFrameNew);                              //  then add the new stackframe
 636                         }
 637                 }
 638
 639                 // And now for removing unused stackframes from list
 640
 641                 for (n = 0; n < stackListOld.size (); n++) {                                            // For all StackFrames in the StackFrame list
 642                         stackFrameOld = (PHPStackFrame) stackListOld.get (n);                           //
 643
 644                         for (i = 0; i < stackList.size (); i++) {                                                       // For all stackList entries
 645                                 stackFrameNew = (PHPStackFrame) stackList.get (i);
 646
 647                                 if (stackFrameNew.getDescription ().equals (stackFrameOld.getDescription ())) { // Did we find the sent stackframe within the list of old stackframes?
 648                                         break;                                                                  //  Yes, then break;
 649                                 }
 650                         }
 651
 652                         if (i == stackList.size ()) {                                           // Did not find the old stackframe within the list of new ones
 653                                  stackListOld.remove (n);                                       //  then remove the old stackframe from list
 654                                  n -= 1;                                                        // Adjust the stack list index
 655                         }
 656                 }
 657
 658                 Collections.sort (stackListOld);                                                                                // Sort the 'static' stackframe list by the stackframe index numbers.
 659                                                                                                                                                                 //
 660                 newStackList = new PHPStackFrame[stackListOld.size ()];
 661                 newStackList = (PHPStackFrame[]) stackListOld.toArray (newStackList);
 662                 DBGStackList = newStackList;
 663         }
 664
 665     /**
 666      * Read the response from DBG and process the frame
 667      *
 668          * @return
 669          * - The received command
 670          * - or 0 if something was wrong
 671      */
 672         public int readResponse () throws IOException {
 673         int     bytesToRead            = 0;                         // The number of byte to read for the current DBG block
 674         int     nextFrame              = 0;                         // The current read position within entirePack
 675         int     i                      = 0;
 676         int     cmdReceived            = 0;
 677         int     stackIndex             = 0;
 678         boolean errorStack             = false;
 679         char[]  dbg_header_struct_read = new char[16];              // The buffer for the first 16 bytes of a block
 680         int[]   dbg_header_struct      = new int[4];                // The first four numbers (long) of a block
 681         int[]   dbg_bpl_tmp            = new int[10];
 682         int[]   dbg_frame              = new int[2];
 683         int[]   dbg_eval_tmp           = new int[3];
 684         int[]   dbg_src_tree_tmp       = new int[4];                //
 685         int[]   dbg_error_tmp          = new int[2];
 686         Vector  rawList                = new Vector();
 687         Vector  stackList              = new Vector();              // Intermediate stacklist which is build up in FRAME_STACK frame
 688
 689         rawList.clear ();
 690         stackList.clear ();
 691
 692                 // Read from input
 693         while (readInput (dbg_header_struct_read, 16) != 0) {                               // Read 16 byte from input stream
 694                         dbg_header_struct[0] = PHPDBGBase.Char4ToInt (dbg_header_struct_read, 0);               // Debug sync header
 695             dbg_header_struct[1] = PHPDBGBase.Char4ToInt (dbg_header_struct_read, 4);           // Command
 696             dbg_header_struct[2] = PHPDBGBase.Char4ToInt (dbg_header_struct_read, 8);       //
 697             dbg_header_struct[3] = PHPDBGBase.Char4ToInt (dbg_header_struct_read, 12);      // Bytes within this block
 698
 699             if (dbg_header_struct[0] != 0x5953) {                                           // Check DBG sync bytes
 700                 return 0;                                                                   // Wrong header
 701             }
 702
 703             cmdReceived = dbg_header_struct[1];                                             // Get the command
 704             setLastCmd (cmdReceived);                                                                                                           // Store the info about the current command
 705             bytesToRead = dbg_header_struct[3];                                                                                         // Get the number of bytes to read for this block
 706
 707                         //System.out.println("Response Received: " + cmdReceived);
 708                         char[] entirePack = new char[bytesToRead];                                      // Store the block data into buffer 'entirePack'
 709
 710             if (bytesToRead > 0) {                                                          // If there is something within the frame
 711                 if (readInput (entirePack, bytesToRead) < bytesToRead) {                    // Read the frame into the buffer
 712                     return 0;                                                               // We did not read enough bytes, error
 713                 }
 714                         }
 715
 716                         nextFrame = 0;                                                                  // Start with the first frame
 717
 718                         while (nextFrame < bytesToRead) {                                               // As long as we have something within this block
 719                                 dbg_frame[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame);                           // The name of the frame
 720                                 dbg_frame[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);               // The size of the frame
 721                                 nextFrame   += 8;                                                           // The next read position
 722
 723                                 if (dbg_frame[1] == 0) {                                                    // Something within the frame?
 724                                         return 0;                                                               //  Nothing to read, error
 725                                 }
 726
 727                                 switch (dbg_frame[0]) {
 728                                         case PHPDBGBase.FRAME_STACK:
 729                                                 int[] dbg_stack_new = new int[4];                                       //
 730
 731                                                 dbg_stack_new[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 0);   // Source line number
 732                                                 dbg_stack_new[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);   // Module number
 733                                                 dbg_stack_new[2] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 8);   // Scope id
 734                                                 dbg_stack_new[3] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 12);  // ID of description string
 735
 736                                                 if ((dbg_stack_new[1] != 0) && !errorStack) {
 737                                                         PHPStackFrame newStack;
 738
 739                                                         stackIndex++;
 740                                                         newStack = new PHPStackFrame (null,                                 // The thread
 741                                                                                       getModByNo (dbg_stack_new[1]),        // The name of the module (file)
 742                                                                                       dbg_stack_new[0],                     // The source line number
 743                                                                                                                   stackIndex,
 744                                                                                                                   getRawFrameData (entirePack,          // Get the string from this packet
 745                                                                                                                                    dbg_stack_new[3]),   // The frame ID for which we want the string
 746                                                                                                                   dbg_stack_new[1]);                                    // The module number
 747                                                         stackList.add (newStack);
 748                                                 }
 749
 750                                                 errorStack = false;
 751                                                 break;
 752
 753                                         case PHPDBGBase.FRAME_SOURCE:                                                   // Nothing to be done here
 754                                                 break;                                                                      // TODO: what's with that frame? Something interesting
 755
 756                                         case PHPDBGBase.FRAME_SRC_TREE:                                                 //
 757                                                 dbg_src_tree_tmp[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 0);        // The parent module number
 758                                                 dbg_src_tree_tmp[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);        // The parent line number (not used)
 759                                                 dbg_src_tree_tmp[2] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 8);        // The module number
 760                                                 dbg_src_tree_tmp[3] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 12);       // The filename number
 761
 762                                                 if (getModByNo (dbg_src_tree_tmp[2]).equals ("")) {
 763                                                         String fileName;
 764
 765                                                         fileName = new String (getRawFrameData (entirePack, dbg_src_tree_tmp[3]));      // Get the filename
 766
 767                                                         if (fileName.length () > 0) {                                               // If we have a filename
 768                                                                 fileName = fileName.substring (0, fileName.length () - 1);              // Remove '\0' char
 769                                                         }
 770
 771                                                         if (dbg_src_tree_tmp[2] != 0) {                                             // If there is a module number
 772                                                                 PHPDBGMod modNew;
 773
 774                                                                 modNew = new PHPDBGMod (dbg_src_tree_tmp[2], fileName);                 // Create a module object
 775
 776                                                                 DBGMods.add (modNew);                                                   // And store it to array
 777                                                         }
 778                                                 }
 779                                                 break;
 780
 781                                         case PHPDBGBase.FRAME_RAWDATA:                                                      // Nothing to be done here
 782                                                 break;                                                                          //  FRAME_RAWDATA are processed within getRawFrameData
 783
 784                                         case PHPDBGBase.FRAME_ERROR:                                                                                                            // An error frame
 785                                                 errorStack       = true;                                                                                                                // Yes, we have an error stack
 786                                                 dbg_error_tmp[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 0);                   // Error type
 787                                                 dbg_error_tmp[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);                   // Error message ID
 788
 789                                                 String error = "\n";                                                            //
 790
 791                                                 switch (dbg_error_tmp[0]) {                                                                                                             // Switch on error type
 792                                                         case PHPDBGBase.E_ERROR:                        error += "[Error]";                     break;
 793                                                         case PHPDBGBase.E_WARNING:                      error += "[Warning]";                   break;
 794                                                         case PHPDBGBase.E_PARSE:                        error += "[Parse Error]";               break;
 795                                                         case PHPDBGBase.E_NOTICE:                       error += "[Notice]";                    break;
 796                                                         case PHPDBGBase.E_CORE_ERROR:           error += "[Core Error]";                break;
 797                                                         case PHPDBGBase.E_CORE_WARNING:         error += "[Core Warning]";              break;
 798                                                         case PHPDBGBase.E_COMPILE_ERROR:        error += "[Compile Error]";             break;
 799                                                         case PHPDBGBase.E_COMPILE_WARNING:      error += "[Compile Warning]";   break;
 800                                                         case PHPDBGBase.E_USER_ERROR:           error += "[User Error]";                break;
 801                                                         case PHPDBGBase.E_USER_WARNING:         error += "[User Warning]";              break;
 802                                                         case PHPDBGBase.E_USER_NOTICE:          error += "[User Notice]";               break;
 803                                                         default:                                                        error += "[Unexpected Error]";  break;
 804                                                 }
 805
 806                                                 error += ": ";
 807                                                 error += new String (getRawFrameData (entirePack, dbg_error_tmp[1]));                   // Add the error string for this error message ID
 808
 809                                                 if (error.length () > 0) {                                                                                                              // If we have a error message
 810                                                          error = error.substring (0, error.length () - 1);                                                      //  Remove '\0' char
 811                                                 }
 812
 813                                                 error += "\n";                                                                  // Append a CR
 814
 815                                                 PHPDebugCorePlugin.log (new DebugException (new Status (IStatus.WARNING,
 816                                                                                                         PHPDebugCorePlugin.PLUGIN_ID,
 817                                                                                                                                                                 IStatus.OK,
 818                                                                                                                                                                 error, null)));
 819
 820                                                 // To print errors on the console, I must execute a code in the
 821                                                 // php context, that write the stderr... I didn't found a better way
 822                                                 // TODO: Find a better way????
 823
 824 //                                              String codeExec= "";
 825 //                                              codeExec= "fwrite(fopen('php://stderr', 'w'),\\\"" + error + "\\\");";
 826 //                                              try {
 827 //                                                      evalBlock("eval(\"" + codeExec + "\");");
 828 //                                              } catch (DebugException e) {
 829 //                                                      PHPDebugCorePlugin.log(e);
 830 //                                              }
 831 //
 832                                                 if (!stopOnError) {                                                             // Is always false (Did not see where this is set to true!?)
 833                                                         if (lastCommand.equals (PHPDBGBase.DBGA_CONTINUE)) {                        // If last command for PHP was a 'continue',
 834                                                                 continueExecution ();                                                   //  send continue again
 835                                                         } else if (lastCommand.equals (PHPDBGBase.DBGA_STEPINTO)) {                 // If last command for PHP was a 'step into',
 836                                                                 stepInto ();                                                            //  send 'step into' again
 837                                                         } else if (lastCommand.equals (PHPDBGBase.DBGA_STEPOUT)) {                  // If last command for PHP was a 'step out',
 838                                                                 stepOut ();                                                             //  send 'step out' again
 839                                                         } else if (lastCommand.equals (PHPDBGBase.DBGA_STEPOVER)) {                 // If last command for PHP was a 'step over',
 840                                                                 stepOver ();                                                            //  send 'step over' again
 841                                                         }
 842                                                 }
 843                                                 break;
 844
 845                                         case PHPDBGBase.FRAME_EVAL:
 846                                                 String evalString;
 847
 848                                                 evalString      = new String ("");
 849                                                 dbg_eval_tmp[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 0);                    // istr
 850                                                 dbg_eval_tmp[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);                    // iresult
 851                                                 dbg_eval_tmp[2] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 8);                    // ierror
 852
 853                                                 evalRet                 = getRawFrameData (entirePack, dbg_eval_tmp[1]);                //
 854                                                 evalString              = getRawFrameData (entirePack, dbg_eval_tmp[0]);                //
 855                                                 serGlobals              = evalRet;                                                      //
 856                                                 break;
 857
 858                                         case PHPDBGBase.FRAME_BPS:                                                          //
 859                                                 break;                                                                          //
 860
 861                                         case PHPDBGBase.FRAME_BPL:
 862                                                 int[] dbg_bpl_new;
 863
 864                                                 dbg_bpl_new        = new int[10];
 865                                                 dbg_bpl_new[0] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 0);
 866                                                 dbg_bpl_new[1] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 4);
 867                                                 dbg_bpl_new[2] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 8);
 868                                                 dbg_bpl_new[3] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 12);
 869                                                 dbg_bpl_new[4] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 16);
 870                                                 dbg_bpl_new[5] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 20);
 871                                                 dbg_bpl_new[6] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 24);
 872                                                 dbg_bpl_new[7] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 28);
 873                                                 dbg_bpl_new[8] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 32);
 874                                                 dbg_bpl_new[9] = PHPDBGBase.Char4ToInt (entirePack, nextFrame + 36);
 875
 876                                                 // look if breakpoint already exists in vector
 877                                                 for (i = 0; i < DBGBPList.size (); i++) {
 878                                                         dbg_bpl_tmp = (int[]) DBGBPList.get (i);
 879
 880                                                         if (dbg_bpl_tmp[8] == dbg_bpl_new[8]) {
 881                                                                 DBGBPList.remove (i);
 882
 883                                                                 break;
 884                                                         }
 885                                                 }
 886
 887                                                 // add breakpoint to vector
 888                                                 DBGBPList.add (dbg_bpl_new);
 889                                                 copyToLastBP (dbg_bpl_new);
 890
 891                                                 // mod no returned?
 892                                                 if (getModByNo (dbg_bpl_new[0]).equals ("")) {
 893                                                         String fileName;
 894
 895                                                         fileName = new String (getRawFrameData (entirePack, dbg_bpl_new[2]));
 896
 897                                                         if (fileName.length () > 0) {                                               // If we have filename
 898                                                                 fileName = fileName.substring (0, fileName.length () - 1);                              //  Remove '\0' char
 899                                                         }
 900
 901                                                         if (dbg_bpl_new[0] != 0) {
 902                                                                 PHPDBGMod modNew;
 903
 904                                                                 modNew = new PHPDBGMod (dbg_bpl_new[0], fileName);
 905
 906                                                                 DBGMods.add (modNew);
 907                                                         }
 908                                                 }
 909                                                 break;
 910
 911                                         case PHPDBGBase.FRAME_VER:
 912                                                 break;
 913
 914                                         case PHPDBGBase.FRAME_SID:
 915                                                 sid = PHPDBGBase.Char4ToInt(entirePack, nextFrame + 0);
 916                                                 break;
 917
 918                                         case PHPDBGBase.FRAME_SRCLINESINFO:
 919                                                 break;
 920
 921                                         case PHPDBGBase.FRAME_SRCCTXINFO:
 922                                                 break;
 923
 924                                         case PHPDBGBase.FRAME_LOG:
 925                                                 break;
 926
 927                                         case PHPDBGBase.FRAME_PROF:
 928                                                 break;
 929
 930                                         case PHPDBGBase.FRAME_PROF_C:
 931                                                 break;
 932
 933                                         case PHPDBGBase.FRAME_SET_OPT:
 934                                                 break;
 935                                 }
 936
 937                                 nextFrame += dbg_frame[1];                                                      // go to next frame
 938                         }
 939
 940                         // Now process command
 941                         switch(cmdReceived) {
 942                                 case PHPDBGBase.DBGC_REPLY:
 943                                         break;
 944
 945                                 case PHPDBGBase.DBGC_STARTUP:
 946                                         break;
 947
 948                                 case PHPDBGBase.DBGC_END:
 949                                         sessionEnded = true;
 950                                         break;
 951
 952                                 case PHPDBGBase.DBGC_BREAKPOINT:
 953                                         BPUnderHit   = getBPUnderHit ();
 954                                         updateStackFrameList (stackList);
 955                                         break;
 956
 957                                 case PHPDBGBase.DBGC_STEPINTO_DONE:
 958                                 case PHPDBGBase.DBGC_STEPOVER_DONE:
 959                                 case PHPDBGBase.DBGC_STEPOUT_DONE:
 960                                 case PHPDBGBase.DBGC_EMBEDDED_BREAK:
 961                                 case PHPDBGBase.DBGC_PAUSE:
 962                                         BPUnderHit   = 1;
 963                                         updateStackFrameList (stackList);
 964                                         break;
 965
 966                                 case PHPDBGBase.DBGC_ERROR:
 967                                         stackList.clear ();
 968                                         updateStackFrameList (stackList);
 969                                         break;
 970
 971                                 case PHPDBGBase.DBGC_LOG:
 972                                         break;
 973
 974                                 case PHPDBGBase.DBGC_SID:
 975                                         break;
 976                         }
 977                 }
 978
 979                 return cmdReceived;                                         // Return the command we received with this block
 980         }
 981
 982     /**
 983      *
 984      */
 985
 986         public PHPStackFrame[] getStackList() {
 987                 return DBGStackList;
 988         }
 989
 990         /**
 991          * Reads from input buffer (response sent from DBG) the given number of chars
 992          * into frame buffer.
 993          *
 994          * @param buffer  The frame buffer where to store the read data from DBG.
 995          * @param bytes   The number of bytes (chars) which are to read from input stream.
 996          * @return        The number of bytes actually read.
 997          */
 998         private int readInput (char[] buffer, int bytes) throws IOException {
 999                 int bytesRead = 0;                                                                                      // Reset the bytes read counter
1000
1001                 for (int i = 0; i < bytes; i++) {                           // For the number of bytes we should read
1002                         if (in.ready ()) {                                                                              // If input stream is ready for reading
1003                                 buffer[i] = (char) (in.read () & 0x00FF);           // Read a char and store only the least significant 8-bits
1004                                 bytesRead++;                                        // Increment the bytes read counter
1005                         }
1006                         else {                                                  // Input stream is not ready
1007                                 break;                                              // Break the loop
1008                         }
1009                 }
1010
1011                 return bytesRead;                                                                                       // Return the number of bytes actually read
1012         }
1013
1014         /**
1015          * PHPProxy could stop the waiting for a response with this method.
1016          *
1017          */
1018         public void setShouldStop () {
1019                 this.shouldStop = true;
1020         }
1021
1022         /**
1023          * @param milliseconds The maximum time in milliseconds we wait for something
1024          *                     to be send from DBG.
1025          * @return             - true if something was received from DBG
1026          *                                         - false if nothing was send from DBG within the given time
1027          *
1028          */
1029         public boolean waitResponse (long milliseconds) throws IOException {
1030                 long timeout;
1031
1032                 timeout = System.currentTimeMillis () + milliseconds;           // Calculate the system time till we wait.
1033
1034                 while (System.currentTimeMillis () < timeout) {             // Is waiting time running out?
1035                         if (in.ready () || shouldStop) {                        //  No, so did we get something or should we stop now
1036                                 break;                                              //   Yes, break the waiting
1037                         }
1038                 }
1039
1040                 return in.ready ();                                         // true if we got something from DBG
1041         }
1042 }