util/statetrace/printer.hh

   1 /*
   2  * Copyright (c) 2006 The Regents of The University of Michigan
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions are
   7  * met: redistributions of source code must retain the above copyright
   8  * notice, this list of conditions and the following disclaimer;
   9  * redistributions in binary form must reproduce the above copyright
  10  * notice, this list of conditions and the following disclaimer in the
  11  * documentation and/or other materials provided with the distribution;
  12  * neither the name of the copyright holders nor the names of its
  13  * contributors may be used to endorse or promote products derived from
  14  * this software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  20  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *
  28  * Authors: Gabe Black
  29  */
  30
  31 #ifndef PRINTER_HH
  32 #define PRINTER_HH
  33
  34 #include <iostream>
  35 #include <string>
  36 #include <vector>
  37
  38 #include "refcnt.hh"
  39
  40 class TraceChild;
  41 class PrinterObject;
  42
  43 typedef RefCountingPtr<PrinterObject> PrinterPointer;
  44
  45 class PrinterObject : public RefCounted
  46 {
  47   protected:
  48     TraceChild * child;
  49   public:
  50     PrinterObject(TraceChild * newChild) : child(newChild)
  51     {;}
  52     virtual std::ostream & writeOut(std::ostream & os) = 0;
  53     virtual bool configure(std::string) = 0;
  54 };
  55
  56 class NestingPrinter : public PrinterObject
  57 {
  58   private:
  59     std::vector<std::string> constStrings;
  60     std::vector<PrinterPointer> printers;
  61     int switchVar;
  62     int numPrinters;
  63   public:
  64     NestingPrinter(TraceChild * newChild) :
  65         PrinterObject(newChild), numPrinters(0), switchVar(-1)
  66     {;}
  67
  68     bool configure(std::string);
  69
  70     std::ostream & writeOut(std::ostream & os);
  71 };
  72
  73 class RegPrinter : public PrinterObject
  74 {
  75   private:
  76     int intRegNum;
  77   public:
  78     RegPrinter(TraceChild * newChild, int num = 0) :
  79         PrinterObject(newChild), intRegNum(num)
  80     {;}
  81
  82     void regNum(int num)
  83     {
  84         intRegNum = num;
  85     }
  86
  87     int regNum()
  88     {
  89         return intRegNum;
  90     }
  91
  92     bool configure(std::string);
  93
  94     std::ostream & writeOut(std::ostream & os);
  95 };
  96
  97 static inline std::ostream & operator << (std::ostream & os,
  98         PrinterObject & printer)
  99 {
 100     return printer.writeOut(os);
 101 }
 102
 103 static inline std::ostream & operator << (std::ostream & os,
 104         PrinterPointer & printer)
 105 {
 106     return printer->writeOut(os);
 107 }
 108
 109 #endif