WaveformTracer.h

// Copyright (c) 2011, Richard Osborne, All rights reserved
// This software is freely distributable under a derivative of the
// University of Illinois/NCSA Open Source License posted in
// LICENSE.txt and at <http://github.xcore.com/>

#ifndef _WaveformTracer_h_
#define _WaveformTracer_h_

#include <vector>
#include <map>
#include <fstream>
#include <string>
#include <queue>
#include "PortInterface.h"

class Port;
class WaveformTracer;

class WaveformTracerPort : public PortInterface {
  WaveformTracer *parent;
  Port *port;
  std::string identifier;
  Signal prev;
  ticks_t time;
public:
  WaveformTracerPort(WaveformTracer *w, Port *p, const std::string id) :
    parent(w),
    port(p),
    identifier(id),
    prev(0),
    time(0) {}
  void update(ticks_t time);
  void seePinsChange(const Signal &value, ticks_t time);
  Port *getPort() { return port; }
  const std::string &getIdentifier() const { return identifier; }
};

class WaveformTracer {
  struct Event {
    WaveformTracerPort *port;
    ticks_t time;
    Event(WaveformTracerPort *p, ticks_t t) : port(p), time(t) {}
    bool operator<(const Event &other) const {
      return time > other.time;
    }
  };
  std::priority_queue<Event> queue;
  std::fstream out;
  std::vector<WaveformTracerPort> ports;
  typedef std::map<std::string, std::vector<unsigned> > ModuleMap;
  ModuleMap modules;
  bool portsFinalized;
  uint32_t currentTime;
  std::string makeIdentifier(unsigned index);
  void emitDate();
  void emitDeclarations();
  void dumpPortValue(const std::string &identifer, Port *port, uint32_t value);
  void dumpInitialValues();
public:
  WaveformTracer(const std::string &name);
  void schedule(WaveformTracerPort *port, ticks_t time);
  void runUntil(ticks_t time);
  void add(const std::string &module, Port *port);
  void finalizePorts();
  void seePinsChange(WaveformTracerPort *port, uint32_t newValue,
                     ticks_t time);
};

#endif // _WaveformTracer_h_