document_properties.cpp

Go to the documentation of this file.

/*******************************************************************\
 
Module: Subgoal Documentation
 
Author: Daniel Kroening, kroening@kroening.com
 
\*******************************************************************/
 
 
#include "document_properties.h"
 
#include <fstream>
 
#include <util/string2int.h>
 
#include <goto-programs/goto_model.h>
 
#define MAXWIDTH 62
 
class document_propertiest
{
public:
  document_propertiest(
    const goto_functionst &_goto_functions,
    std::ostream &_out):
    goto_functions(_goto_functions),
    out(_out),
    format(HTML)
  {
  }
 
  void html()
  {
    format=HTML;
    doit();
  }
 
  void latex()
  {
    format=LATEX;
    doit();
  }
 
private:
  const goto_functionst &goto_functions;
  std::ostream &out;
 
  struct linet
  {
    std::string text;
    int line_number;
  };
 
  static void strip_space(std::list<linet> &lines);
 
  std::string get_code(const source_locationt &source_location);
 
  struct doc_claimt
  {
    std::set<irep_idt> comment_set;
  };
 
  enum { HTML, LATEX } format;
 
  void doit();
};
 
void document_propertiest::strip_space(std::list<linet> &lines)
{
  unsigned strip=50;
 
  for(std::list<linet>::const_iterator it=lines.begin();
      it!=lines.end(); it++)
  {
    for(std::size_t j=0; j<strip && j<it->text.size(); j++)
      if(it->text[j]!=' ')
      {
        strip=j;
        break;
      }
  }
 
  if(strip!=0)
  {
    for(std::list<linet>::iterator it=lines.begin();
        it!=lines.end(); it++)
    {
      if(it->text.size()>=strip)
        it->text=std::string(it->text, strip, std::string::npos);
 
      if(it->text.size()>=MAXWIDTH)
        it->text=std::string(it->text, 0, MAXWIDTH);
    }
  }
}
 
std::string escape_latex(const std::string &s, bool alltt)
{
  std::string dest;
 
  for(std::size_t i=0; i<s.size(); i++)
  {
    if(s[i]=='\\' || s[i]=='{' || s[i]=='}')
      dest+="\\";
 
    if(!alltt &&
       (s[i]=='_' || s[i]=='$' || s[i]=='~' ||
        s[i]=='^' || s[i]=='%' || s[i]=='#' ||
        s[i]=='&'))
      dest+="\\";
 
    dest+=s[i];
  }
 
  return dest;
}
 
std::string escape_html(const std::string &s)
{
  std::string dest;
 
  for(std::size_t i=0; i<s.size(); i++)
  {
    switch(s[i])
    {
    case '&': dest+="&amp;"; break;
    case '<': dest+="&lt;"; break;
    case '>': dest+="&gt;"; break;
    default: dest+=s[i];
    }
  }
 
  return dest;
}
 
bool is_empty(const std::string &s)
{
  for(std::size_t i=0; i<s.size(); i++)
    if(isgraph(s[i]))
      return false;
 
  return true;
}
 
std::string
document_propertiest::get_code(const source_locationt &source_location)
{
  const irep_idt &file=source_location.get_file();
  const irep_idt &source_line = source_location.get_line();
 
  if(file.empty() || source_line.empty())
    return "";
 
  std::ifstream in(id2string(file));
 
  std::string dest;
 
  if(!in)
  {
    dest+="ERROR: unable to open ";
    dest+=id2string(file);
    dest+="\n";
    return dest;
  }
 
  int line_int = unsafe_string2int(id2string(source_line));
 
  int line_start=line_int-3,
      line_end=line_int+3;
 
  if(line_start<=1)
    line_start=1;
 
  // skip line_start-1 lines
 
  for(int l=0; l<line_start-1; l++)
  {
    std::string tmp;
    std::getline(in, tmp);
  }
 
  // read till line_end
 
  std::list<linet> lines;
 
  for(int l=line_start; l<=line_end && in; l++)
  {
    lines.push_back(linet());
 
    std::string &line=lines.back().text;
    std::getline(in, line);
 
    if(!line.empty() && line[line.size()-1]=='\r')
      line.resize(line.size()-1);
 
    lines.back().line_number=l;
  }
 
  // remove empty lines at the end and at the beginning
 
  for(std::list<linet>::iterator it=lines.begin();
      it!=lines.end();)
  {
    if(is_empty(it->text))
      it=lines.erase(it);
    else
      break;
  }
 
  for(std::list<linet>::iterator it=lines.end();
      it!=lines.begin();)
  {
    it--;
 
    if(is_empty(it->text))
      it=lines.erase(it);
    else
      break;
  }
 
  // strip space
  strip_space(lines);
 
  // build dest
 
  std::size_t max_line_number_width = 0;
  if(!lines.empty())
  {
    max_line_number_width = std::to_string(lines.back().line_number).size();
  }
  for(std::list<linet>::iterator it=lines.begin();
      it!=lines.end(); it++)
  {
    std::string line_no=std::to_string(it->line_number);
 
    std::string tmp;
 
    switch(format)
    {
    case LATEX:
      while(line_no.size() < max_line_number_width)
        line_no=" "+line_no;
 
      line_no += "  ";
 
      tmp+=escape_latex(it->text, true);
 
      if(it->line_number==line_int)
        tmp="{\\ttb{}"+tmp+"}";
 
      break;
 
    case HTML:
      while(line_no.size() < max_line_number_width)
        line_no="&nbsp;"+line_no;
 
      line_no += "&nbsp;&nbsp;";
 
      tmp+=escape_html(it->text);
 
      if(it->line_number==line_int)
        tmp="<em>"+tmp+"</em>";
 
      break;
    }
 
    dest += line_no + tmp + "\n";
  }
 
  return dest;
}
 
void document_propertiest::doit()
{
  typedef std::map<source_locationt, doc_claimt> claim_sett;
  claim_sett claim_set;
 
  for(const auto &gf_entry : goto_functions.function_map)
  {
    const goto_programt &goto_program = gf_entry.second.body;
 
    for(const auto &instruction : goto_program.instructions)
    {
      if(instruction.is_assert())
      {
        const auto &source_location = instruction.source_location();
        source_locationt new_source_location;
 
        new_source_location.set_file(source_location.get_file());
        new_source_location.set_line(source_location.get_line());
        new_source_location.set_function(source_location.get_function());
 
        claim_set[new_source_location].comment_set.insert(
          source_location.get_comment());
      }
    }
  }
 
  for(claim_sett::const_iterator it=claim_set.begin();
      it!=claim_set.end(); it++)
  {
    const source_locationt &source_location=it->first;
 
    std::string code = get_code(source_location);
 
    switch(format)
    {
    case LATEX:
      out << "\\claimlocation{File "
          << escape_latex(source_location.get_string("file"), false)
          << " function "
          << escape_latex(source_location.get_string("function"), false)
          << "}\n";
 
      out << '\n';
 
      for(std::set<irep_idt>::const_iterator
          s_it=it->second.comment_set.begin();
          s_it!=it->second.comment_set.end();
          s_it++)
        out << "\\claim{" << escape_latex(id2string(*s_it), false)
            << "}\n";
 
      out << '\n';
 
      out << "\\begin{alltt}\\claimcode\n"
          << code
          << "\\end{alltt}\n";
 
      out << '\n';
      out << '\n';
      break;
 
    case HTML:
      out << "<div class=\"claim\">\n"
          << "<div class=\"location\">File "
          << escape_html(source_location.get_string("file"))
          << " function "
          << escape_html(source_location.get_string("function"))
          << "</div>\n";
 
      out << '\n';
 
      for(std::set<irep_idt>::const_iterator
          s_it=it->second.comment_set.begin();
          s_it!=it->second.comment_set.end();
          s_it++)
        out << "<div class=\"description\">\n"
            << escape_html(id2string(*s_it)) << '\n'
            << "</div>\n";
 
      out << '\n';
 
      out << "<div class=\"code\">\n"
          << code
          << "</div> <!-- code -->\n";
 
      out << "</div> <!-- claim -->\n";
      out << '\n';
      break;
    }
  }
}
 
void document_properties_html(
  const goto_modelt &goto_model,
  std::ostream &out)
{
  document_propertiest(goto_model.goto_functions, out).html();
}
 
void document_properties_latex(
  const goto_modelt &goto_model,
  std::ostream &out)
{
  document_propertiest(goto_model.goto_functions, out).latex();
}