cireport Class Reference

Generate html continuous integration report. More...

#include <cireport.h>

Collaboration diagram for cireport:

List of all members.

Public Member Functions
	cireport ()
	Constructor.
void	reset ()
	Constructor.
stringc	summaryblock1 ()
	Local references.
stringc	summaryblock2 ()
	References in proj/report.html.
stringc	summaryblock3 ()
	References in proj/doc.html.
stringc	report01 ()
void	test01 ()
	Output summaryblock1.
int	reportfile_update ()
	Updates the html report file.
int	docfile_update ()
	Updates the html doc file.
Public Attributes
modulelist	ml
	List of modules.
vector< modulereport >	mr
	List of reports associated with ml[].
Static Public Attributes
static string	reportfile = "report.html"
	html written to file ${projdirectory}/<reportfile>
static string	docfile = "doc.html"
	html written to file ${projdirectory}/<docfile>

---

Detailed Description

Generate html continuous integration report.

Document view architecture. Looks for module's compiler and unit test reports and updates the html page.

Run in proj/ directory.

Definition at line 19 of file cireport.h.

---

Constructor & Destructor Documentation

cireport::cireport

(

)

Constructor.

Definition at line 83 of file cireport.cpp.

References reset().

{
  reset();
}

---

Member Function Documentation

int cireport::docfile_update

(

)

Updates the html doc file.

Definition at line 134 of file cireport.cpp.

References docfile, html::insert(), and summaryblock3().

Referenced by cireporttest::test03().

{
  int res=0;

  if (html::insert
  (
    docfile,  
    "<!--B01_UPDATE_REPORT_BEGIN-->",
    "<!--B01_UPDATE_REPORT_END-->",
    summaryblock3()
  ) != 0)
    res=1;

  return res;
}

stringc cireport::report01

(

)

Definition at line 51 of file cireport.cpp.

References modulelist::doc, ml, modulelist::modules, mr, and stringtag().

Referenced by reportfile_update(), and cireporttest::test01().

{
  string s0;

  for (uint i=0; i<ml.doc.size(); ++i)
  {
    s0 += "<a id=\"";
    s0 += ml.modules[i];
    s0 += "\"></a>\n";
    s0 += "<h3>";
    s0 += "<a class=\"reflocal\" href=\"";
    s0 += (ml.modules[i]+"/"+ml.doc[i]);
    s0 += "\">";
    s0 += ml.modules[i];
    s0 += mr[i].htmlimg();
    s0 += "</a>\n";
    s0 += "</h3>\n";

    s0 += mr[i].summary01();

    s0 += mr[i].compilerhtmldetailed();

    s0 += mr[i].unittestshtmldetailed();

  }

  string s1(stringtag(s0,"div"));

  return s1;
}

int cireport::reportfile_update

(

)

Updates the html report file.

Definition at line 108 of file cireport.cpp.

References html::insert(), report01(), reportfile, and summaryblock1().

Referenced by cireporttest::test02(), and cireporttest::test03().

{
  int res=0;

  if (html::insert
  (
    reportfile,  
    "<!--B01_UPDATE_REPORT_BEGIN-->",
    "<!--B01_UPDATE_REPORT_END-->",
    summaryblock1()
  ) != 0)
    res=1;


  if (html::insert
  (
    reportfile,  
    "<!--B02_UPDATE_REPORT_BEGIN-->",
    "<!--B02_UPDATE_REPORT_END-->",
    report01()
  ) != 0)
    res=1;

  return res;
}

void cireport::reset

(

)

Constructor.

Definition at line 88 of file cireport.cpp.

References modulelist::buildlist(), modulereport::filepathfront, ml, modulelist::modules, and mr.

Referenced by cireport().

{
  ml.buildlist();

  // Creating and setting up the modulereport's.
  for (uint i=0; i<ml.modules.size(); ++i)
  {
    modulereport mri;
    mri.filepathfront=ml.modules[i]+"/";
    mr.push_back(mri);
  }

  // Read and calculate the module's state
  for (uint i=0; i<ml.modules.size(); ++i)
  {
    mr[i].reset();
    mr[i].statecalc();
  }
}

stringc cireport::summaryblock1

(

)

Local references.

Definition at line 31 of file cireport.cpp.

References modulelist::doc, ml, modulelist::modules, and mr.

Referenced by reportfile_update(), and cireporttest::test01().

{
  string s0;
  s0 += "<p>\n";

  for (uint i=0; i<ml.doc.size(); ++i)
  {
    s0 += "<a class=\"reflocal2\" href=\"#";
    s0 += ml.modules[i];
    s0 += ("\">"+ml.modules[i]);
    s0 += mr[i].htmlimg();
    s0 += "</a> &nbsp;";
    s0 += "\n";
  }

  s0 += "</p>\n";

  return s0;
}

stringc cireport::summaryblock2

(

)

References in proj/report.html.

Definition at line 13 of file cireport.cpp.

References modulelist::doc, ml, modulelist::modules, and mr.

Referenced by cireporttest::test01().

{
  string s0;
  s0 += "<p>\n";

  for (uint i=0; i<ml.doc.size(); ++i)
  {
    s0 += "<a class=\"reflocal\" href=\"";
    s0 += (ml.modules[i]+"/"+ml.doc[i]);
    s0 += ("\">"+ml.modules[i]);
    s0 += mr[i].htmlimg();
    s0 += "</a> &nbsp;";
    s0 += "\n";
  }

  return s0;
}

stringc cireport::summaryblock3

(

)

References in proj/doc.html.

Definition at line 150 of file cireport.cpp.

References modulelist::doc, ml, modulelist::modules, and mr.

Referenced by docfile_update().

{
  string s0;
  s0 += "<p>\n";

  for (uint i=0; i<ml.doc.size(); ++i)
  {
    s0 += "<a class=\"reflocal\" href=\"";
    s0 += ml.modules[i];
    s0 += "/";
    s0 += ml.doc[i];
    s0 += ("\">"+ml.modules[i]);
    s0 += mr[i].htmlimg();
    s0 += "</a> &nbsp;";
    s0 += "\n";
  }

  s0 += "</p>\n";

  return s0;
}

void cireport::test01

(

)

Output summaryblock1.

---

Member Data Documentation

string cireport::docfile = "doc.html" [static]

html written to file ${projdirectory}/<docfile>

Definition at line 26 of file cireport.h.

Referenced by docfile_update().

modulelist cireport::ml

List of modules.

Definition at line 29 of file cireport.h.

Referenced by report01(), reset(), summaryblock1(), summaryblock2(), and summaryblock3().

vector<modulereport> cireport::mr

List of reports associated with ml[].

Definition at line 32 of file cireport.h.

Referenced by report01(), reset(), summaryblock1(), summaryblock2(), and summaryblock3().

string cireport::reportfile = "report.html" [static]

html written to file ${projdirectory}/<reportfile>

Definition at line 24 of file cireport.h.

Referenced by reportfile_update().

---

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

• makefilebuildtool/cireport.h
• makefilebuildtool/cireport.cpp