modulereport Class Reference

Generate report on module. More...

#include <modulereport.h>

Inheritance diagram for modulereport:

Collaboration diagram for modulereport:

List of all members.

Public Member Functions
	modulereport ()
	Does nothing.
boolc	reset ()
	Read files into the tokenizers.
int	update ()
	Read the generated files and write the report.
int	update01 ()
	Basic update test.
void	statecalc ()
	Calculate the state.
int	compile_exitstatus ()
	Extract from xml the compilers exit status.
int	unittests_exitstatus ()
	Extract from xml the unit tests exit status.
stringc	compilerhtmldetailed ()
	Extracts from the modules compilers xml file.
stringc	unittestshtmldetailed ()
	Extracts from the modules unit tests xml file.
stringc	summary01 ()
	Status of module, compilation and unit testing.
Public Attributes
tokenizer	ureport
	Read in unit tests report.
tokenizer	creport
	Read in compiler report.
bool	errorssilent
	If true do not print error messages.
string	filepathfront
	Add path to front when accessing files.
Static Public Attributes
static string	fileout_html = "modulereport.html"
	html file output.

---

Detailed Description

Generate report on module.

Document view architecture.

Assumes in the proj/xxx directory.

Definition at line 44 of file modulereport.h.

---

Constructor & Destructor Documentation

modulereport::modulereport

(

)

Does nothing.

Definition at line 92 of file modulereport.cpp.

  : errorssilent(false)
{
}

---

Member Function Documentation

int modulereport::compile_exitstatus

(

)

Extract from xml the compilers exit status.

Definition at line 138 of file modulereport.cpp.

References creport, tokenizerlocal::read(), tokenizer::reset(), and stringfrom().

Referenced by statecalc(), summary01(), and update01().

{
  tokenizerlocal tkl(creport);
  string s1;
  creport.reset();
  bool res=true;
  res &= tkl.read(s1,"exitstatus");
//cout << SHOW(res) << " " << SHOW(s1) << endl;

  int exitstatus=1;
  stringfrom(exitstatus,s1);

  return exitstatus;
}

stringc modulereport::compilerhtmldetailed

(

)

Extracts from the modules compilers xml file.

Definition at line 183 of file modulereport.cpp.

References creport, tokenizerlocal::read(), tokenizerlocal::reset(), htmlstring::serializeInverse(), and stringtag().

Referenced by update().

{
// id: 
// compilertag id
// command:
// compilertag command
// libraries: 
// compilertag libraries

// time: time

// head
// output in <pre> tags.

  tokenizerlocal tkl(creport);
  string s1;
  string s0; 

  //tkl.reset_start=true;

  //s0 += "<h2>Compilation</h2>\n";

  s0 += "<p>\n";

  tkl.reset();
  if (tkl.read(s1,"compiletag","id"))
    s0 += ("id: " + s1 + "<br />\n");
/*
  {
    s0 += ("id: " + s1 + "<br />");
  }
*/

/*
  tkl.reset();
  bool res=tkl.read(s1,"compiletag","command");
cout << SHOW(res) << endl;
tkl.ref.printdelimiter="*\n";
cout << tkl.ref << endl;
*/
/*
  if (tkl.read(s1,"compiletag","command"))
  {
    s0 += ("command: " + s1 + "<br />");
  }
*/

  tkl.reset();
  if (tkl.read(s1,"compiletag","command"))
    s0 += ("command: " + s1 + "<br />\n");

  tkl.reset();
  if (tkl.read(s1,"compiletag","libraries"))
    s0 += ("libraries: " + s1 + "<br />\n");

  tkl.reset();
  if (tkl.read(s1,"time"))
    s0 += ("time: " + s1 + "\n</p>\n");

  tkl.reset();
  if (tkl.read(s1,"head"))
  {
    string s2;
    htmlstring::serializeInverse(s2,s1);
    s0 += stringtag(s2,"pre");
  }

  s0 += "\n";

  return s0;
}

boolc modulereport::reset

(

)

Read files into the tokenizers.

Definition at line 61 of file modulereport.cpp.

References creport, errorssilent, mkerrorscompile::fileout_txt, filepathfront, projunittests::fileresults, tokenizer::read(), tokenizer::seq, filestring::serialize(), and ureport.

Referenced by update(), and update01().

{
  bool res=true;

  ureport.seq.clear();
  string unittestsreport;
  string file1=filepathfront+projunittests::fileresults;
  if (!filestring::serialize(unittestsreport,file1))
  {
    res=false;

    if (!errorssilent)
      cout << "error:  could not read file " << file1 << endl;
  }
  ureport.read(unittestsreport);
  
  creport.seq.clear();
  string compilationreport;
  string file2=filepathfront+mkerrorscompile::fileout_txt;
  if (!filestring::serialize(compilationreport,file2))
  {
    res=false;

    if (!errorssilent)
      cout << "error:  could not read file " << file2 << endl;
  }
  creport.read(compilationreport);

  return res;
}

void modulereport::statecalc

(

)

Calculate the state.

Definition at line 153 of file modulereport.cpp.

References modulestate::amber, compile_exitstatus(), modulestate::green, modulestate::red, modulestate::state, and unittests_exitstatus().

Referenced by update(), and update01().

{
  int compilestatus=compile_exitstatus();
  int unittestsstatus=unittests_exitstatus();

  state=red;

  if ((compilestatus==0)&&(unittestsstatus==0))
    state=green;
  if ((compilestatus==0)&&(unittestsstatus!=0))
    state=amber;
}

stringc modulereport::summary01

(

)

Status of module, compilation and unit testing.

Definition at line 371 of file modulereport.cpp.

References compile_exitstatus(), modulestate::statestring(), and unittests_exitstatus().

Referenced by update().

{
  string s1;
  s1 += "<p>Module Status &nbsp; ";
  s1 += (statestring() + "<br />");
  
  s1 += "Compilation Status &nbsp; ";
  s1 += (exitint( compile_exitstatus() ).isvalidtext() + "<br />");

  s1 += "Unit Tests &nbsp; ";
  s1 += (exitint( unittests_exitstatus() ).isvalidtext() );

  s1 += "</p>";

  return s1;
}

int modulereport::unittests_exitstatus

(

)

Extract from xml the unit tests exit status.

Definition at line 123 of file modulereport.cpp.

References tokenizerlocal::read(), tokenizer::reset(), stringfrom(), and ureport.

Referenced by statecalc(), summary01(), and update01().

{
  tokenizerlocal tkl(ureport);
  string s1;
  ureport.reset();

  int exitstatus=1;
  if (tkl.read(s1,"status","exitstatus")==false)
    return exitstatus;

  stringfrom(exitstatus,s1);

  return exitstatus;
}

stringc modulereport::unittestshtmldetailed

(

)

Extracts from the modules unit tests xml file.

Definition at line 270 of file modulereport.cpp.

References tokenizerlocal::boundscope(), tokenizerlocal::read(), tokenizerlocal::scope(), htmlstring::serializeInverse(), stringtag(), and ureport.

Referenced by update().

{
  string s0;
//  string s0="<h2>Unit tests</h2>";
//cout << "modulereport::unittestshtmldetailed()" << endl;

  string exitstatus;
  string file;

  tokenizerlocal tl1(ureport);
  tl1.boundscope("vi");

  string s1;

  tokenizerlocal tl2(tl1);
  for ( ; tl2.scope("unittest"); ++tl2)
  {
    tokenizerlocal tl3(tl2);
    if (tl3.read(exitstatus,"exitstatus")==false)
      continue;
// cout << SHOW3(exitstatus) << endl;
    if (tl3.read(file,"file")==false)
      continue;
// cout << SHOW3(file) << endl;

    s1 += ("<p>exitstatus: "+exitstatus);
    s1 += "<br />";
    s1 += ("file: " + file);
    s1 += "</p>";
   
    s0 += s1;

    s1.clear();

    if (tl3.scope("commandlines")==false)
      continue;

    tokenizerlocal tl4(tl3);
    for ( ; tl4.scope("cmd"); ++tl4)
    {
      tokenizerlocal tl5(tl4);
      string exitstatus;
      if (tl5.read(exitstatus,"exitstatus")==false)
        continue;
      string line;
      if (tl5.read(line,"line")==false)
        continue;
      string output;
      if (tl5.read(output,"output")==false)
        continue;

      //cout << SHOW3(exitstatus) << endl;
      //cout << SHOW3(line) << endl;
      //cout << SHOW3(output) << endl;

      s1 += ("<p>exitstatus: " + exitstatus);
      s1 += "<br />";
      s1 += ("line: " + line);
      s1 += "</p>\n";
      {
        string output2;
        htmlstring::serializeInverse(output2,output);
        s1 += (stringtag(output2,"pre")+"\n");
      }
      //s1 += ("<pre>"+output+"</pre>\n");
    }
//    s1 += "</p>";

    s0 += s1;
  }

//cout << SHOW3(exitstatus) << endl;
  
  return s0;
}

int modulereport::update

(

)

Read the generated files and write the report.

Definition at line 388 of file modulereport.cpp.

References compilerhtmldetailed(), fileout_html, modulestate::htmlimg(), reset(), filestring::serializeInverse(), statecalc(), stringtag(), summary01(), and unittestshtmldetailed().

Referenced by mkerrorstest::test05().

{
  reset();
  statecalc();

  string s1="\n";
  s1 += "<h1>Module Report";
  s1 += htmlimg("../"); 
  s1 += "</h1>\n";

  s1 += (summary01()+"\n");

  s1 += "<h2>Compilation</h2>\n";
  s1 += compilerhtmldetailed();
  s1 += "<h2>Unit tests</h2>\n";
  s1 += unittestshtmldetailed();

  string s2 = stringtag(s1,"body");
  string s3 = stringtag(s2,"html");

  
  filestring::serializeInverse(fileout_html,s3);

  return 0;
}

int modulereport::update01

(

)

Basic update test.

Definition at line 27 of file modulereport.cpp.

References compile_exitstatus(), fileout_html, modulestate::htmlimg(), reset(), filestring::serializeInverse(), statecalc(), modulestate::statestring(), stringtag(), and unittests_exitstatus().

Referenced by mkerrorstest::test04().

{
  reset();
  statecalc();

  string s1="\n";
  s1 += "<h1>Module Report";
  s1 += htmlimg("../"); 
  s1 += "</h1>\n";

// Spec
// Module Status  Failure
// Compilation Status  Success
// Unit Tests  Failure

  s1 += "Module Status &nbsp; ";
  s1 += (statestring() + "<br />");
  
  s1 += "Compilation Status &nbsp; ";
  s1 += (exitint( compile_exitstatus() ).isvalidtext() + "<br />");


  s1 += "Unit Tests &nbsp; ";
  s1 += (exitint( unittests_exitstatus() ).isvalidtext() + "<br />");


  string s2 = stringtag(s1,"body");
  string s3 = stringtag(s2,"html");

  filestring::serializeInverse(fileout_html,s3);

  return 0;
}

---

Member Data Documentation

tokenizer modulereport::creport

Read in compiler report.

Definition at line 57 of file modulereport.h.

Referenced by compile_exitstatus(), compilerhtmldetailed(), and reset().

bool modulereport::errorssilent

If true do not print error messages.

Definition at line 60 of file modulereport.h.

Referenced by reset().

string modulereport::fileout_html = "modulereport.html" [static]

html file output.

Definition at line 49 of file modulereport.h.

Referenced by update(), and update01().

string modulereport::filepathfront

Add path to front when accessing files.

Definition at line 63 of file modulereport.h.

Referenced by reset(), and cireport::reset().

tokenizer modulereport::ureport

Read in unit tests report.

Definition at line 55 of file modulereport.h.

Referenced by reset(), unittests_exitstatus(), and unittestshtmldetailed().

---

The documentation for this class was generated from the following files:

• makefilebuildtool/modulereport.h
• makefilebuildtool/modulereport.cpp