TexBuilder.h

Go to the documentation of this file.

typedef struct Table Table;
struct Table {
  std::string name;
  std::string title;
  std::string caption;
  std::vector< std::string > header;
  std::vector< std::vector< std::string > > rows;
  // Always make a csv for the table as well
  std::string csvname;
  std::string csvdir;
};


class TexBuilder{

public:

  TexBuilder( std::string filename,
              std::string title,
              std::string authors,
              std::string abstract  );
  ~TexBuilder();

  void AddText( std::string text);

  void Section   ( std::string secname    );
  void SubSection( std::string subsecname );
  void SectionNoNum   ( std::string secname    );
  void SubSectionNoNum( std::string subsecname );

  void AddFigureRow( std::vector<std::string> figure, 
                     std::vector<std::string> caption, 
                     std::vector<std::string> label);

  void WriteHeader();
  void NewPage();

  void AddTable( Table table, bool drawnow=false, bool makecsv=true );
  void DrawTable( std::string tabname );

  void Close();

private:
  std::string fFileName;
  std::string fTitle;
  std::string fAuthors;
  std::string fAbstract;
  std::ofstream fTex;

  std::map< std::string, Table > fTables;
};


//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
TexBuilder::TexBuilder( std::string filename,
                        std::string title,
                        std::string authors,
                        std::string abstract )
  : fFileName(filename)
  , fTitle(title)
  , fAuthors(authors)
  , fAbstract(abstract)
{
  fTex.open(filename);

  if(!fTex.is_open())
    std::cout << "\nFailed to open " << filename << std::endl;
  else
    std::cout << "\nBuilding Tex in "     << filename << std::endl;

  WriteHeader();

  fTex << "\n\\newpage\n";  
}

TexBuilder::~TexBuilder()
{
  // doesn't always work here?
  //fTex << "\\end{document}\n";
  //fTex.close();
}

//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::Close()
{
  fTex << "\\end{document}\n";
  fTex.close();
}

//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::AddText( std::string text)
{
  fTex << text;
}

//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::AddFigureRow( std::vector<std::string> figure, 
                               std::vector<std::string> caption, 
                               std::vector<std::string> label)
{  
  unsigned short nfig = figure.size();
  if( nfig!= caption.size() ){ 
    std::cout << "Bad number of captions, skipping " << figure[0] << std::endl; return; }
  if( nfig!= label.size() ){ 
    std::cout << "Bad number of labels, skipping " << figure[0] << std::endl; return; }

  float size;
  if     (nfig==1) size = 0.2;  // height
  else if(nfig==2) size = 0.49; // width
  else if(nfig==3) size = 0.32; // width
  else if(nfig==4) size = 0.24; // width


  fTex << "\\begin{figure}[h!]\n";

  // set single figures by height
  if(nfig==1){
    fTex << "\\centering\n";
    fTex << "  \\includegraphics[height="<<size<<"\\linewidth]{" << figure[0] <<".pdf}\n";
    if(caption[0]!="") 
      fTex << "    \\caption{"  << caption[0] << "}\n";
    if(label[0]!="") 
      fTex << "    \\label{fig:"<< label[0]   << "}\n";
  } else {
    
    // set multiple subfigures by width
    for( unsigned short f=0; f<nfig; f++){
      fTex << "  \\begin{subfigure}{"<<size<<"\\textwidth}\n";    
      fTex << "    \\includegraphics[width=\\linewidth]{" << figure[f] <<".pdf}\n";
      if(caption[f]!="") 
        fTex << "    \\caption{"  << caption[f] << "}\n";
      if(label[f]!="") 
        fTex << "    \\label{fig:"<< label[f]   << "}\n";
      fTex << "  \\end{subfigure}\n";
      if(f<nfig-1)
        fTex << "  \\quad\n";
     
    } // each figure
  }
  
  fTex << "\\end{figure}\n";  

  return;
}


//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::Section( std::string name )
{
  fTex << "\\section{"+name+"}\n\n";
}
void TexBuilder::SectionNoNum( std::string name )
{
  fTex << "\\section*{"+name+"}\n\n";
}
void TexBuilder::SubSection( std::string name )
{
  fTex << "\\subsection{"+name+"}\n\n";
}
void TexBuilder::SubSectionNoNum( std::string name )
{
  fTex << "\\subsection*{"+name+"}\n\n";
}
void TexBuilder::NewPage()
{
  fTex << "\n\\newpage\n";
}



//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::WriteHeader()
{

  fTex << "\\documentclass[12pt]{article}\n";

  fTex << "\\usepackage[utf8]{inputenc}\n";
  fTex << "\\usepackage{graphicx}\n";
  fTex << "\\usepackage{caption}\n";
  fTex << "\\usepackage{subcaption}\n";
  fTex << "\\usepackage[dvipsnames,table]{xcolor}\n";
  fTex << "\\usepackage[a4paper, margin=1.5cm]{geometry}\n";
  fTex << "\\usepackage{fancyhdr}\n";
  fTex << "\\usepackage[colorlinks=true]{hyperref}\n";

  fTex << "\\newcommand{\\mycolor}{WildStrawberry}\n";
  fTex << "\\newcommand{\\myhighlightA}{Goldenrod!30!white}\n";
  fTex << "\\newcommand{\\myhighlightB}{Apricot!50!white}\n";
  fTex << "\\newcommand{\\myhighlightC}{Rhodamine!30!white}\n";

  fTex << "\\pagestyle{fancy}\n";
  fTex << "\\rhead{\\nouppercase{\\leftmark}}\n";

  fTex << "\\usepackage{etoolbox}\n";
  fTex << "\\renewcommand{\\headrulewidth}{1pt}\n";
  fTex << "\\fancyhead[CO,CE]{\\hyperlink{toc}{Back To Top}}\n";
  fTex << "%\\fancyhead[LO,LE]{\\hyperlink{sec}{Section Top}}\n";

  fTex << "\\makeatletter";
  fTex << "\\patchcmd{\\@fancyhead}{\\rlap}{\\color{\\mycolor!60!white}\\rlap}{}{}\n";
  fTex << "\\patchcmd{\\headrule}{\\hrule}{\\color{\\mycolor!60!white}\\hrule}{}{}\n";
  fTex << "\\patchcmd{\\@fancyfoot}{\\rlap}{\\color{\\mycolor!60!white}\\rlap}{}{}\n";
  fTex << "\\patchcmd{\\footrule}{\\hrule}{\\color{\\mycolor!60!white}\\hrule}{}{}\n";
  fTex << "\\makeatother";
  fTex << "\\usepackage{sectsty}\n";
  fTex << "\\allsectionsfont{\\color{\\mycolor}\\bfseries}\n";
  fTex << "\\usepackage{longtable}\n";

  fTex << "\\hypersetup{linkcolor=black}\n";

  fTex << "\\usepackage{geometry}\n";
  fTex << "\\geometry{headheight=15pt}\n";

  fTex << "\\setlength{\\intextsep}{0.005\\textheight}\n";

  fTex << std::endl;
  fTex << "\\begin{document}\n\n";
  fTex << std::endl;

  fTex << "\\title{\\textcolor{\\mycolor}{\\bf " << fTitle << "}}\n";
  fTex << "\\author{" << fAuthors << "}\n";
  fTex << "\\date{\\today}\n\n";

  fTex << "\\maketitle\n\n";

  fTex << "\\begin{abstract}\n";
  fTex << fAbstract;
  fTex << "\\end{abstract}\n\n";

  fTex << "\\tableofcontents\n\n";

} // WriteHeader()


//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::AddTable( Table table, bool addnow, bool makecsv )
{ 
  if(fTables.count(table.name)){
    std::cout << "Table " << table.name << " already exists, skip" << std::endl;
    return;
  }
  // Rester the new table
  fTables[table.name] = table;

  // Immediately make CSV
  if(makecsv){
    ofstream csv (Form("%s/%s",
          table.csvdir.c_str(),
          table.csvname.c_str()) );
    if(!csv.is_open()) std::cout << "File not found" << std::endl;

    csv << "#";
    for(size_t i=0; i<table.header.size(); i++){
      csv << table.header[i];
      if(i!=table.header.size()-1) csv << ",";
    }
    csv << std::endl;

    for( auto& row: table.rows ){
      for( size_t c=0; c<row.size(); c++ ){
        csv << row[c]; 
        if(c!=row.size()-1) csv << ",";
      }
      csv << std::endl;
    }
    csv.close();
  }

  // Maybe add to Tex now
  if(addnow) DrawTable(table.name);
}


//^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^~^
void TexBuilder::DrawTable( std::string tabname )
{ 
  if(!fTables.count(tabname)){ 
    std::cout << "no table for " << tabname << ", skip" << std::endl; 
    for(auto& t : fTables) std::cout << "  " << t.first << std::endl;
    return;
  } 
  const Table &tab = fTables[tabname];

  // center all for now
  std::string tabulararg = "|";
  for(auto& cell : tab.header) tabulararg += "c|";

  fTex << "\\begin{center}\n";
  fTex << "\\begin{table}[h!]\n";
  fTex << "\\begin{tabular}{ " << tabulararg << "}\n\n";
  
  fTex << "\\hline" << std::endl;
  for( size_t c=0; c<tab.header.size(); c++ ){
    std::string head = tab.header[c];
    std::replace( head.begin(), head.end(), '_', ' ');
    if( c<tab.header.size()-1 )
      fTex << head << " & ";
    else        
      fTex << head << "\\\\ \\hline" << std::endl;
  }

  for( auto& row: tab.rows ){ 
    for( size_t c=0; c<row.size(); c++ ){
      std::string cell = row[c];
      std::replace( cell.begin(), cell.end(), '_', ' ');      
      if( c<row.size()-1 )
        fTex << cell << " & ";
      else      
        fTex << cell;
    }
    fTex << "\\\\ \\hline" << std::endl;
  }

  fTex << "\\end{tabular}\n";
  if( tab.caption!="" )
    fTex << "\\caption{" << tab.caption << "}\n";
  fTex << "\\label{tab:" << tab.name << "}\n";
  fTex << "\\end{table}\n";
  fTex << "\\end{center}\n\n";

}