StatsRenderer.h

Go to the documentation of this file.

/*                                              -*- mode:C++ -*-
  StatsRenderer.h SDL_Surface MFM statistics renderer
  Copyright (C) 2014 The Regents of the University of New Mexico.  All rights reserved.

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library 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
  Lesser General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  USA
*/

#ifndef STATSRENDERER_H
#define STATSRENDERER_H

#include "AbstractButton.h"
#include "AssetManager.h"
#include "SDL_ttf.h"
#include "Grid.h"
#include "Utils.h"
#include "itype.h"
#include "Point.h"
#include <unistd.h>
#include <sys/types.h>
#include <pwd.h>

namespace MFM {

  template <class GC>
  class StatsRenderer
  {
    // Extract short type names
    typedef typename GC::CORE_CONFIG CC;

   public:
    class DataReporter
    {
    public:
      virtual const char * GetLabel() const = 0;

      virtual void GetValue(ByteSink & bs, bool endOfEpoch) const = 0;

      virtual ~DataReporter()
      { }
    };

    class CapturableStatistic : public DataReporter
    {
     public:
      virtual const char * GetLabel() const = 0;

      virtual s32 GetDecimalPlaces() const = 0;

      virtual double GetValue(bool endOfEpoch) const = 0;

      virtual void GetValue(ByteSink & bs, bool endOfEpoch) const
      {
        const u32 FMT_BUFFER_SIZE = 32;
        char fmtBuffer[FMT_BUFFER_SIZE];

        const u32 STR_BUFFER_SIZE = 128;
        char strBuffer[STR_BUFFER_SIZE];

        s32 places = GetDecimalPlaces();
        if (places >= 0)
        {
          snprintf(fmtBuffer, FMT_BUFFER_SIZE, "%%8.%df",places);
          snprintf(strBuffer, STR_BUFFER_SIZE, fmtBuffer, GetValue(endOfEpoch));
        }
        bs.Print(strBuffer);
      }

      virtual ~CapturableStatistic()
      { }
    };

    class ElementCount : public DataReporter
    {
     private:
      const Element<CC> * m_element;
      const Grid<GC> * m_grid;

     public:
      ElementCount() :
        m_element(0),
        m_grid(0)
      { }

      void Set(const Grid<GC> * grid, const Element<CC> * elt)
      {
        m_element = elt;
        m_grid = grid;
      }

      virtual const char * GetLabel() const
      {
        if (m_element)
        {
          return m_element->GetUUID().GetLabel();
        }
        return "<unset>";
      }

      virtual void GetValue(ByteSink & bs, bool endOfEpoch) const
      {
        if (!m_element || !m_grid)
        {
          return;
        }
        u32 type = m_element->GetType();
        u32 allSites = m_grid->CountActiveSites();
        u32 count = m_grid->GetAtomCount(type);
        double pct = 100.0 * count / allSites;

        if (pct == 0 || pct >= 1)
        {
          bs.Printf("%d %2d", count, (int) pct);
        }
        else
        {
          bs.Printf("%d .%d", count, (int) (10 * pct));
        }
      }
    };

    class ElementDataSlotSum : public CapturableStatistic
    {
     private:
      Grid<GC> * m_grid;
      const char * m_label;
      u32 m_elementType;
      u32 m_slot;
      u32 m_outOfSlots;
      bool m_resetOnRead;

     public:
      ElementDataSlotSum() :
        m_grid(0),
        m_label(0),
        m_elementType(0),
        m_slot(0),
        m_outOfSlots(0),
        m_resetOnRead(false)
      { }

      void Set(Grid<GC> & grid, const char * label, u32 elementType,
               u32 slot, u32 outOfSlots, bool resetOnRead)
      {
        m_grid = &grid;
        m_label = label;
        m_elementType = elementType;
        m_slot = slot;
        m_outOfSlots = outOfSlots;
        m_resetOnRead = resetOnRead;
      }

      virtual const char * GetLabel() const
      {
        if (m_label)
        {
          return m_label;
        }
        return "<unset>";
      }

      virtual s32 GetDecimalPlaces() const
      {
        return 0;
      }
      virtual double GetValue(bool endOfEpoch) const
      {
        if (!m_grid)
        {
          return -1;
        }
        if (m_slot >= m_outOfSlots)
        {
          return -1;
        }

        u64 sum = 0;
        for (typename Grid<GC>::iterator_type i = m_grid->begin(); i != m_grid->end(); ++i)
        {
          Tile<CC> * t = *i;
          ElementTable<CC> & et = t->GetElementTable();
          u64 * eds = et.GetElementDataSlotsFromType(m_elementType,m_outOfSlots);
          if (!eds)
          {
            continue;
          }
          sum += eds[m_slot];
          if (endOfEpoch && m_resetOnRead)
          {
            eds[m_slot] = 0;
          }
        }

        return (double) sum;
      }
    };

  private:
    UPoint m_dimensions;
    SPoint m_drawPoint;

    static const u32 MAX_TYPES = 32;
    const DataReporter *(m_reporters[MAX_TYPES]);
    u32 m_reportersInUse;

    ElementCount m_displayElements[MAX_TYPES];
    u32 m_displayElementsInUse;

    u32 m_displayAER;
    u32 m_maxDisplayAER;

    static const u32 MAX_BUTTONS = 16;
    AbstractButton* m_buttons[MAX_BUTTONS];
    u32 m_registeredButtons;

  public:
    StatsRenderer() :
      m_reportersInUse(0),
      m_displayElementsInUse(0),
      m_displayAER(0),
      m_maxDisplayAER(5),
      m_registeredButtons(0)
    { }

    void ClearButtons()
    {
      m_registeredButtons = 0;
    }

    enum {
      BUTTON_HEIGHT_PIXELS = 20,
      LINE_HEIGHT_PIXELS = 32,
      DETAIL_LINE_HEIGHT_PIXELS = 32
    };
    void ReassignButtonLocations()
    {
      SPoint loc(4, m_reportersInUse * BUTTON_HEIGHT_PIXELS);
      loc.SetY(loc.GetY() + m_displayAER*LINE_HEIGHT_PIXELS);
      for(u32 i = 0; i < m_registeredButtons; i++)
      {
        m_buttons[i]->SetLocation(loc);
        loc.SetY(loc.GetY() + BUTTON_HEIGHT_PIXELS);
      }
    }

    void AddButton(AbstractButton* b)
    {
      if (m_registeredButtons >= MAX_BUTTONS)
        FAIL(OUT_OF_ROOM);

      SPoint dimensions(268, BUTTON_HEIGHT_PIXELS - 2);
      SPoint location(4, (m_reportersInUse + m_registeredButtons) * BUTTON_HEIGHT_PIXELS);
      b->SetDimensions(dimensions);
      b->SetLocation(location);

      m_buttons[m_registeredButtons++] = b;
    }

    void OnceOnly()
    { }

    u32 GetDisplayAER() const
    {
      return m_displayAER;
    }

    u32 GetMaxDisplayAER() const
    {
      return m_maxDisplayAER;
    }

    void SetDisplayAER(u32 displayAER)
    {
      m_displayAER = displayAER % (m_maxDisplayAER + 1);
      ReassignButtonLocations();
    }

    bool DisplayDataReporter(const DataReporter * cs)
    {
      if (m_reportersInUse >= MAX_TYPES)
      {
        return false;
      }
      u32 index = m_reportersInUse++;
      m_reporters[index] = cs;
      return true;
    }

    bool DisplayStatsForElement(const Grid<GC>  & grd, const Element<CC> & elt)
    {
      if (m_displayElementsInUse >= MAX_TYPES)
      {
        return false;
      }
      u32 index = m_displayElementsInUse++;
      m_displayElements[index].Set(&grd,&elt);
      return DisplayDataReporter(&m_displayElements[index]);
    }

    void SetDrawPoint(Point<s32> drawPoint)
    {
      m_drawPoint = drawPoint;
    }

    void SetDimensions(Point<u32> dimensions)
    {
      m_dimensions = dimensions;
    }

    void RenderGridStatistics(Drawing & drawing, Grid<GC>& grid, double aeps, double aer, u32 AEPSperFrame, double overhead, bool endOfEpoch);

    void WriteRegisteredCounts(ByteSink & fp, bool writeHeader, Grid<GC>& grid, double aeps, double aer, u32 AEPSperFrame, double overhead, bool doResets);
  };
} /* namespace MFM */
#include "StatsRenderer.tcc"

#endif /*STATSRENDERER_H*/