remotedebug.h

Go to the documentation of this file.

/*
 * remotedebug.h by Anders Reggestad <andersr@pvv.org>
 *
 * Copyright (C) 2013 Atomic Blue (info@planeshift.it, http://www.atomicblue.org) 
 *
 *
 * 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 (version 2 of the License)
 * 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, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
#ifndef __REMOTEDEBUG_H__
#define __REMOTEDEBUG_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================

//=============================================================================
// Library Includes
//=============================================================================
#include "psstdint.h"

//=============================================================================
// Local Includes
//=============================================================================

// Forward declarations

#define RDebug(debugEntity,debugLevel,...) \
    { if (debugEntity->IsDebugging()) { debugEntity->Printf(debugLevel, __VA_ARGS__); }}


class RemoteDebug
{
public:
    RemoteDebug();

    virtual ~RemoteDebug();
    
    inline bool IsDebugging()
    {
        return (highestActiveDebugLevel > 0);
    };
    
    bool IsDebugging(int debugLevel)
    {
        return (highestActiveDebugLevel > 0 && debugLevel <= highestActiveDebugLevel);
    };

    bool SwitchDebugging();

    void SetDebugging(int debugLevel);

    int GetDebugging() const;

    void AddDebugClient(uint clientNum, int debugLevel);

    void RemoveDebugClient(uint clientNum);

    csString GetRemoteDebugClientsString() const;
    
    void Printf(int debugLevel, const char* msg,...);
    
protected:
    virtual void LocalDebugReport(const csString& debugString) = 0;
    
    virtual void RemoteDebugReport(uint32_t clientNum, const csString& debugString) = 0;
    
private:
    struct DebugClient
    {
        DebugClient(uint32_t clientNum, int debugLevel):clientNum(clientNum),debugLevel(debugLevel) {};

        bool operator==(const DebugClient& other) const { return clientNum == other.clientNum; }
            
        
        uint32_t clientNum; 
        int debugLevel;     
    };
    
    void VPrintf(int debugLevel, const char* msg, va_list args);

    void CalculateHighestActiveDebugLevel();

    int                  localDebugLevel;         
    csArray<DebugClient> debugClients;            
    int                  highestActiveDebugLevel; 

protected:
    csArray<csString>    debugLog;                
    int                  nextDebugLogEntry;       
};

#endif