profile_funclevel.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/profile/profile_funclevel.h $
// $Author: mhoffe $
// $Revision: #3 $
// $DateTime: 2003/07/09 10:57:23 $
//
// ©2003 Electronic Arts
//
// Function level profiling
#ifdef _MSC_VER
#  pragma once
#endif
#ifndef PROFILE_FUNCLEVEL_H // Include guard
#define PROFILE_FUNCLEVEL_H

class ProfileFuncLevel
{
  friend class Profile;
 
  // no, no copying allowed!
  ProfileFuncLevel(const ProfileFuncLevel&);
  ProfileFuncLevel& operator=(const ProfileFuncLevel&);
 
public:
  class Id;
  class Thread;

  class IdList
  {
    friend Id;
 
  public:
    IdList(void): m_ptr(0) {}

    bool Enum(unsigned index, Id &id, unsigned *countPtr=0) const;
 
  private:

    void *m_ptr;
  };

  class Id
  {
    friend IdList;
    friend Thread;
 
  public:
    Id(void): m_funcPtr(0) {}
    
    enum
    {
      Total = 0xffffffff
    };

    const char *GetSource(void) const;

    const char *GetFunction(void) const;

    unsigned GetAddress(void) const;

    unsigned GetLine(void) const; 

    unsigned _int64 GetCalls(unsigned frame) const;

    unsigned _int64 GetTime(unsigned frame) const;

    unsigned _int64 GetFunctionTime(unsigned frame) const;

    IdList GetCaller(unsigned frame) const;
 
  private:
    void *m_funcPtr;
  };

  class Thread
  {
    friend ProfileFuncLevel;
 
  public:
    Thread(void): m_threadID(0) {}

    bool EnumProfile(unsigned index, Id &id) const;

    unsigned GetId(void) const
    {
      return unsigned(m_threadID);
    }
 
  private:
    class ProfileFuncLevelTracer *m_threadID;
  };

  static bool EnumThreads(unsigned index, Thread &thread);
 
private:

  ProfileFuncLevel(void);

  static ProfileFuncLevel Instance;
};
 
#endif // PROFILE_FUNCLEVEL_H