debug_stack.h

Go to the documentation of this file.

/*
**  Command & Conquer Generals Zero Hour(tm)
**  Copyright 2025 Electronic Arts Inc.
**
**  This program is free software: you can redistribute it and/or modify
**  it under the terms of the GNU General Public License as published by
**  the Free Software Foundation, either version 3 of the License, or
**  (at your option) any later version.
**
**  This program is distributed in the hope that it will be useful,
**  but WITHOUT ANY WARRANTY; without even the implied warranty of
**  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
**  GNU General Public License for more details.
**
**  You should have received a copy of the GNU General Public License
**  along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

// $File: //depot/GeneralsMD/Staging/code/Libraries/Source/debug/debug_stack.h $
// $Author: mhoffe $
// $Revision: #1 $
// $DateTime: 2003/07/03 11:55:26 $
//
// ©2003 Electronic Arts
//
// Stack walker
#ifdef _MSC_VER
#  pragma once
#endif
#ifndef DEBUG_STACK_H // Include guard
#define DEBUG_STACK_H

class DebugStackwalk
{
  friend class Debug;
  
  DebugStackwalk(const DebugStackwalk&);
  DebugStackwalk& operator=(DebugStackwalk&);
 
  // private so that only Debug can create and destroy us
  DebugStackwalk(void);
  ~DebugStackwalk();
 
public:

  class Signature
  {
    // makes life easier :)
    friend class DebugStackwalk;

    enum { MAX_ADDR = 256 };

    unsigned m_numAddr;

    unsigned m_addr[MAX_ADDR];
 
  public:
    explicit Signature(void): m_numAddr(0) {}
    Signature(const Signature &src);
    Signature& operator=(const Signature& src);

    unsigned Size(void) const { return m_numAddr; }

    unsigned GetAddress(int n) const;

    bool operator<(const Signature &other) const
    {
      unsigned m=m_numAddr<other.m_numAddr?m_numAddr:other.m_numAddr;
      for (unsigned k=0;k<m;k++)
      {
        if (m_addr[m_numAddr-k-1]<other.m_addr[other.m_numAddr-k-1])
          return true;
        if (m_addr[m_numAddr-k-1]>other.m_addr[other.m_numAddr-k-1])
          return false;
      }
      return m_numAddr<other.m_numAddr;
    }

    static void GetSymbol(unsigned addr, char *buf, unsigned bufSize);
    
    static void GetSymbol(unsigned addr,
                          char *bufMod, unsigned sizeMod, unsigned *relMod,
                          char *bufSym, unsigned sizeSym, unsigned *relSym,
                          char *bufFile, unsigned sizeFile, unsigned *line, unsigned *relLine);
  };

  static void *GetDbghelpHandle(void);

  static bool IsOldDbghelp(void);

  static int StackWalk(Signature &sig, struct _CONTEXT *ctx=0);
};

Debug& operator<<(Debug &dbg, const DebugStackwalk::Signature &sig);
 
#endif // DEBUG_STACK_H