Diffpack Documentation

---

              Search  

---

Reporter.h

Go to the documentation of this file.

enum ReporterEnvir {
  TextEnvir = 0,
  TabularEnvir = 1,
  TableEnvir = 2,
  ItemEnvir  = 3,
  EnumEnvir  = 4,
  FigureEnvir = 5,
  DispmathEnvir = 6,
  CenterEnvir = 7
};


enum TextStyle {
  PLAIN = 0,
  BOLD = 1,
  ITALICS = 2,
  TYPEWRITER = 3,
  MATHTEXT = 4
};


#define Type ReporterEnvir
#include <Stack_Type.h>
#undef Type

#define Type TextStyle
#include <Stack_Type.h>
#undef Type




class Reporter : public HandleId

{
private:

  void constructor (Os os);

protected:

  String currPlotDir;        
  int    plotSecCount;

  void preparePlots ();
  String        filename;    
  String        extension;   
  Os            os;          

  ReporterEnvir envir;       
  TextStyle     style;       

  Stack(ReporterEnvir) envirStack;  
  Stack(TextStyle)     styleStack;  

  bool          singlefile;  
  String        purpose;     

  int           tb_ncols;    
  String        cell_delim;

  Reporter (Os os);
  Reporter (const String& filename, const String& extension);

  virtual void putTextline     (const String& txt) =0;
  virtual void putTabularline  (const String& txt) =0;
  virtual void putTableline    (const String& txt) =0;
  virtual void putItemline     (const String& txt) =0;
  virtual void putEnumline     (const String& txt) =0;
  virtual void putFigureline   (const String& txt) =0;
  virtual void putDispmathline (const String& txt) =0;
  virtual void putCenterline   (const String& txt) =0;

  virtual bool copyFile     (const String& file, const String& format);

public:

  virtual ~Reporter ();


  

  virtual Reporter& header      (const String& title, const String& author,
                                 bool fullpage = true,
                                 bool singlefile = true,
                                 const char* purpose = NULL);

  virtual Reporter& trailer     ();

  virtual String getSectionRef () = 0;

  virtual Reporter& section        (const String& txt);
  virtual Reporter& section        (const String& txt, const String& label);
  virtual Reporter& subsection     (const String& txt) =0;
  virtual Reporter& subsection     (const String& txt, const String& label) =0;
  virtual Reporter& subsubsection  (const String& txt) =0;
  virtual Reporter& subsubsection  (const String& txt, const String& label) =0;

  virtual Reporter& pagebreak   ()                  =0;
  virtual Reporter& linebreak   ()                  =0;
  virtual Reporter& eject       (int n = 1)         =0;
  virtual Reporter& drawline    ()                  =0;
  virtual Reporter& putLabel    (const String& /*label*/)    { return *this; }
  virtual Reporter& putReference(const String& /*label*/)    { return *this; }
  virtual Reporter& putReference(const String& /*label*/, 
                                 const String& /*document*/) { return *this; }
          Reporter& flush       ();

  virtual Reporter& beginGroup (TextStyle style);
  virtual Reporter& endGroup   ();

  virtual String    getGroup   (const String& txt, TextStyle style);

      

  virtual String cellpad (const String& s) =0;


      

  virtual String adaptString (const String& txt);


      

          Reporter& insert      (const String& txt);

          Reporter& put         (const String& txt);
  virtual Reporter& putmathline (const String& txt);
  virtual Reporter& centerline  (const String& txt) =0;

      

  virtual Reporter& put (ArrayGenSimple(String)& tb);
  virtual Reporter& put (ArrayGenSimple(real)& tb);
  virtual Reporter& put (ArrayGenSimple(real)& tb,
                         const String& cell_format);
  virtual Reporter& put (ArrayGenSimple(real)& tb,
                         ArrayGenSimple(String)& cell_format);

  virtual Reporter& insertDocument (const String& basename) =0;
  virtual Reporter& insertVerbatim (const String& file) =0;

      

  virtual Reporter& beginCenter ();
  virtual Reporter& endCenter   ();

  virtual Reporter& beginTabular  (int ncols, const String& col_format);
  virtual Reporter& endTabular    ();

  virtual Reporter& beginTable  (int ncols, const String& col_format);
  virtual Reporter& endTable    (const String& caption, const String& label);

  virtual Reporter& beginItemize  ();
  virtual Reporter& endItemize    ();

  virtual Reporter& beginEnumerate ();
  virtual Reporter& endEnumerate   ();

  virtual Reporter& beginFigure (const String& psfilename,
                                 real cmWidth = 10.0);
  virtual Reporter& endFigure   (const String& caption, const String& label);

  virtual Reporter& beginDispmath ();
  virtual Reporter& endDispmath   ();


  virtual String makeLabelRef (const String& label) = 0;
          String getCurrPlotDir ();


      

  virtual Reporter& figure (const String& psfilename, const String& caption,
                            const String& label, real cmWidth = 10.0);

  virtual Reporter& figure (const Strings& psfilename, 
                            const Strings& caption,
                            const String&  common_caption,
                            const Strings& label, 
                                  real     cmWidth = 10.0);

  Reporter& displaymath (const String& txt);


      

  virtual void process (bool postscript = true) =0;
  virtual void print   (bool postscript = true) =0;
  virtual void preview (bool postscript = true) =0;


  CLASS_INFO
};

) 
       Put a label in current position. For example, in `\`LaTeX`\`
       documents, this will be an ordinary label that can be referred
       to later using the ref command (coded in class "Reporter" by
       the function "putReference"), while in HTML documents a label
       will result in an anchor (similary, the hyperlink to an anchor
       is coded using the "putReference" function).

*/
) 
       Makes a reference to a label. See documentation of the
       "puLabel" function. The function with only one argument is
       useful for `\`LaTeX`\` documents only. HTML documents usually
       require a document-label and a highlighted text. The overloaded
       version of "putReference" is aimed at both `\`LaTeX`\` and HTML
       reports. The "label" argument is the `\`LaTeX`\` label and the
       highlighted text in HTML while the "document" argument is the
       document-label in HTML.

*/
, const String& /*document*/) 
See documentation of one of the overloaded functions.
*/

---