makestate< CFC > Class Template Reference

Build a makefile. More...

#include <makestate.h>

Collaboration diagram for makestate< CFC >:

List of all members.

Public Member Functions
void	processqueueadd (compilationfile *cf)
	Add to both proessqueue's.
void	standardbuild ()
	Populate the standard container.
	~makestate ()
	Cleanup.
void	print ()
	Print containers.
	makestate ()
	Constructor sets default printing.
void	printdefaults ()
	Set default toggle options on printing.
void	printafterbuild ()
	After the makefile is built print the following as the building of the makefile is not 100%, the programmer should look at the unknown files.
void	eval (compilationfile &cf)
	Processes the compilation file by parsing it and building the includes, adding it to the process queue, if h cpp pair then adding the cpp to the process queue, if cpp then adding the obj to objs.
void	evaldriver ()
	The driver program's cpp has no header and is treated separately.
void	objseval (compilationfile &cf)
	First pass build the dependency list in includes.
void	objseval (compilationfile &cf, compilationfile &h)
	First pass recursive descent into header file.
void	objsdependenciesPass1 ()
	Parse the objs recursively descending to construct dependencies.
void	objsdependenciesPass2 ()
	Remove circular dependencies from Pass1.
compilationfile *	isinprocesschain (stringc &filename) const
	Looks at the containers for the file.
boolc	valid ()
	Some error checking on processqueue.
Public Attributes
CFC	processed
	Unique list of all past in compilationfile's that have been linked to each other.
CFC	standard
	Standard C++ header names.
CFC	unknown
	Unknown files that are not standard and not under proj directory.
CFC	processqueue2
	For searching.
deque< compilationfile * >	processqueue
	For evaluating.
CFC	objs
	Object files.
bool	printobjs
	Toggle objs output.
bool	printprocessed
	Toggle processed output.
bool	printprocessqueue
	Toggle processqueue output.
bool	printstandard
	Toggle standard output.
bool	printunknown
	Toggle unknown output.
bool	printobjsdependencies
	Toggle objs dependencies output.
projfiles< CFC >	proj
	Holds a list of all the files.
string	driver
	Driver cpp file component, by default "main".

---

Detailed Description

template<typename CFC>
class makestate< CFC >

Build a makefile.

All includes added through compilationfile::includesadd( ) to guarantee includes[] is unique.

Definition at line 22 of file makestate.h.

---

Constructor & Destructor Documentation

template<typename CFC >

makestate< CFC >::~makestate

(

)

[inline]

Cleanup.

Definition at line 229 of file makestate.h.

References makestate< CFC >::objs.

{
  // Cleanup as created separately
  for ( objs.reset(); !objs; ++objs)
    delete objs();
}

template<typename CFC >

makestate< CFC >::makestate

(

)

[inline]

Constructor sets default printing.

Definition at line 404 of file makestate.h.

References makestate< CFC >::objs, makestate< CFC >::printdefaults(), makestate< CFC >::processed, makestate< CFC >::processqueue2, makestate< CFC >::standard, and makestate< CFC >::unknown.

  : driver("main")
{
  // I have chosen this on my current project size, for example
  //  I may have about 50 files being in a container realistically,
  //  by making the default much larger it should handle more code
  //  that has many more files.
  uintc size=500;
  processed.construct(size);
  standard.construct(size);
  unknown.construct(size);
  processqueue2.construct(size);
  objs.construct(size);
  
  printdefaults();
}

---

Member Function Documentation

template<typename CFC >

void makestate< CFC >::eval

(

compilationfile &

cf

)

[inline]

Processes the compilation file by parsing it and building the includes, adding it to the process queue, if h cpp pair then adding the cpp to the process queue, if cpp then adding the obj to objs.

Definition at line 293 of file makestate.h.

References compilationfile::component(), compilationfile::filename, compilationfile::ft, compilationfile::header, compilationfile::includes, compilationfile::includesadd(), makestate< CFC >::isinprocesschain(), compilationfile::linkheader, compilationfile::linkobj, compilationfile::linksource, makestate< CFC >::objs, compilationfile::path, makestate< CFC >::processqueueadd(), makestate< CFC >::proj, compilationfile::source, makestate< CFC >::standard, makefilebtglobals::tempheaders, and makestate< CFC >::unknown.

Referenced by makestatetest::test02().

{
//cout << SHOW(cf.filename) << endl;
//cout << SHOW(cf.linkheader) << endl;
//cout << SHOW(cf.linksource) << endl;
//cout << SHOW(cf.linkobj) << endl;
  // Has this object been evaluated before?
  if (cf.linkheader || cf.linksource || cf.linkobj)
    return;

  assert(cf.includes.empty());

  assert(!cf.path.empty());  

  systemcalls sys01
  (
    "perl ../makefilebuildtool/extractheaders.pl " + cf.path + cf.filename,
//    "tempheaders.txt"
    makefilebtglobals::tempheaders
  );
  sys01.eval();

  compilationfile* x;
  string filename;
  
  for (uint i=0; i<sys01.lines.size(); ++i)
  {
    filename=sys01.lines[i];
    if (standard[filename])
       continue;

    // Assume the headers have a .h extension.
    filename += ".h";

    x = isinprocesschain(filename);
    if (x)
    {
//      cf.includes.push_back(x);
        cf.includesadd(x);
      continue;
    }

    assert(!x); //make sure continue works.
//cout << "Not in process chain." << endl;
//cout << SHOW(filename) << endl;

    x = proj.files[filename];
    if (!x)
    {
      unknown.add(new compilationfile("",filename));
      continue;
    }

    processqueueadd(x);

    //cf.includes.push_back(x);
    cf.includesadd(x);

//cout << sys01.lines[i] << endl;;    
  }


  if (cf.ft==compilationfile::header)
  {
    // Headers are included before cpp,

    cf.linkheader= &cf;
    x = proj.files[cf.component()+".cpp"];
    if (x)
    {
      cf.linksource = x;
      processqueueadd(x);
    }
  }

  if (cf.ft==compilationfile::source)
  {
    cf.linksource = &cf;

    x = proj.files[cf.component()+".h"];
    assert(x);
    cf.linkheader = x;

    assert(cf.component() == x->linkheader->component());

    x = new compilationfile(cf.path,cf.component()+".o");
    x->linkobj = x;
    x->linksource = &cf;
    x->linkheader = cf.linkheader;

//cout << "*11*" << cf.filename << endl;
    cf.linkheader->linkobj = x;
    cf.linkobj = x;

    objs.add(x);
  }

}

template<typename CFC >

void makestate< CFC >::evaldriver

(

)

[inline]

The driver program's cpp has no header and is treated separately.

This puts the driver cpp onto the process stack and created a virtual driver header.

Definition at line 280 of file makestate.h.

References makestate< CFC >::processed, makestate< CFC >::processqueueadd(), and makestate< CFC >::proj.

{
  assert(!proj.driver.empty());

  compilationfile* x = proj.files[proj.driverh()];
  processed.add(x); 
  compilationfile* x2 = proj.files[proj.drivercpp()];
  processqueueadd(x2);
  x->linkheader = x;
  x->linksource = x2;
}

template<typename CFC >

compilationfile * makestate< CFC >::isinprocesschain

(

stringc &

filename

)

const [inline]

Looks at the containers for the file.

Definition at line 120 of file makestate.h.

References makestate< CFC >::processed, makestate< CFC >::processqueue2, makestate< CFC >::standard, and makestate< CFC >::unknown.

Referenced by makestate< CFC >::eval().

{
  compilationfile* x;

  x = standard[filename];
  if (x)
    return x;
  
  x = processed[filename];
  if (x)
    return x;

  x = unknown[filename];
  if (x)
    return x;

  x = processqueue2[filename];
  if (x)
    return x;

  return 0;
}

template<typename CFC >

void makestate< CFC >::objsdependenciesPass1

(

)

[inline]

Parse the objs recursively descending to construct dependencies.

Definition at line 422 of file makestate.h.

References makestate< CFC >::objs, and makestate< CFC >::objseval().

Referenced by makestatetest::test06().

{
//  assert(objs.size()!=0);

  for (objs.reset(); !objs; ++objs)
    objseval(*objs());

  // The driver programs virtual .h file is to be deleted.
  objs.reset();
  if (!objs)
    objs()->includes.pop_back();
}

template<typename CFC >

void makestate< CFC >::objsdependenciesPass2

(

)

[inline]

Remove circular dependencies from Pass1.

Definition at line 436 of file makestate.h.

References compilationfile::ft, compilationfile::includes, compilationfile::includesadd(), compilationfile::obj, and makestate< CFC >::objs.

Referenced by makestatetest::test06().

{

  compilationfile *x;
  compilationfile *y;
  for (objs.reset(); !objs; ++objs)
  {
    x=objs();   
    uint imax = x->includes.size();
    for (uint i=0; i<imax; ++i)
    {
      y = x->includes[i];
      if (y->ft!=compilationfile::obj)
        continue;

      uint kmax = y->includes.size();
      for (uint k=0; k<kmax; ++k)
      {
        if (x!=y->includes[k])
          continue;
        
        // Searched and found circular dependency
        //cout << SHOW(i) << "  " << SHOW(k) << endl;
        x->includes[i] = x->includes[i]->linkheader;
        //x->includes.push_back( x->includes[i]->linksource );
        x->includesadd(x->includes[i]->linksource );
        y->includes[k] = y->includes[k]->linkheader;
        //y->includes.push_back( y->includes[k]->linksource );
        y->includesadd( y->includes[k]->linksource );
      }
    }
  }
}

template<typename CFC >

void makestate< CFC >::objseval	(	compilationfile &	cf,
		compilationfile &	h
	)			[inline]

First pass recursive descent into header file.

Definition at line 472 of file makestate.h.

References compilationfile::filename, compilationfile::ft, compilationfile::header, compilationfile::includes, compilationfile::includesadd(), compilationfile::linkobj, compilationfile::linksource, compilationfile::obj, makestate< CFC >::objseval(), and makestate< CFC >::unknown.

{
  assert(cf.ft==compilationfile::obj);
  assert(h.ft==compilationfile::header);
  assert(h.linksource==0);
  assert(h.linkobj==0);

  // Unknown files are assumed to work, often part of a library,
  //  which I assume is constant.  e.g. GL/gl.h GL/glut.h
  if (unknown[h.filename])
    return;

  // Stop infinite recursion, case already handled.
  if (cf.includesadd(&h)==false)
    return;

  uint imax=h.includes.size();
  compilationfile* y;
  for (uint i=0; i<imax; ++i)
  {
    y = h.includes[i];
    if (y->linkobj)
      cf.includesadd(y->linkobj);
    else
      objseval(cf,*y);
  }
}

template<typename CFC >

void makestate< CFC >::objseval

(

compilationfile &

cf

)

[inline]

First pass build the dependency list in includes.

Definition at line 501 of file makestate.h.

References compilationfile::ft, compilationfile::includes, compilationfile::includesadd(), compilationfile::includesvalid(), compilationfile::linkheader, compilationfile::linkobj, compilationfile::linksource, and compilationfile::obj.

Referenced by makestate< CFC >::objsdependenciesPass1(), and makestate< CFC >::objseval().

{
  assert(cf.ft==compilationfile::obj);

//cout << SHOW(cf.filename) << endl;

  compilationfile* x; 

  // Descend into the header first.
  x = cf.linkheader;
  assert(x);
  assert(x->includesvalid());
  assert(cf.includes.size()==0);

  uint imax;
  compilationfile* y;

  imax = x->includes.size();
  for (uint i=0; i<imax; ++i)
  {
    y = x->includes[i];
assert(y!=0);
    if (y->linkobj)
      cf.includesadd(y->linkobj);
    else
      objseval(cf,*y);
  }

  // Now descend into the cpp
  x = cf.linksource;
  assert(x);
  assert(x->includesvalid());
  imax = x->includes.size();
  for (uint i=0; i<imax; ++i)
  {
    y = x->includes[i];
    if (y->linkobj)
      cf.includesadd(y->linkobj);
    else
      objseval(cf,*y);
  }

  // Add the cpp and headers
  cf.includesadd(cf.linksource);
  cf.includesadd(cf.linkheader);
}

template<typename CFC >

void makestate< CFC >::print

(

)

[inline]

Print containers.

Definition at line 157 of file makestate.h.

References compilationfile::filename, compilationfile::includes, makestate< CFC >::objs, makestate< CFC >::printobjs, makestate< CFC >::printobjsdependencies, makestate< CFC >::printprocessed, makestate< CFC >::printprocessqueue, makestate< CFC >::printstandard, makestate< CFC >::printunknown, makestate< CFC >::processed, makestate< CFC >::processqueue, makestate< CFC >::standard, makestate< CFC >::unknown, and makestate< CFC >::valid().

Referenced by makestate< CFC >::printafterbuild(), makestatetest::test01(), makestatetest::test02(), makestatetest::test03(), makestatetest::test04(), makestatetest::test05(), and makestatetest::test06().

{
  if (printprocessed)
    printcontainer(processed,"processed");
  if (printstandard)
    printcontainer(standard,"standard");
  if (printunknown)
    printcontainer(unknown,"unknown");
  if (printobjs)
    printcontainer(objs,"objs");
  //printcontainer(processqueue2,"processqueue2");

  if (printprocessqueue)
  {
    cout << "processqueue: ";
    if (!processqueue.empty()) 
    {
      for (deque<compilationfile*>::const_iterator i=processqueue.begin();
        i != processqueue.end(); i++)
        cout << " " << (*i)->filename;
      cout << endl;
    }
    else
      cout << endl;
  }

  if (printobjsdependencies)
  {
    cout << "objsdependencies:" << endl;
    compilationfile* x;
    for ( objs.reset(); !objs; ++objs )
    {
      x = objs();
      assert(x);
      cout << x->filename << ": ";
      uint imax=x->includes.size();
      for (uint i=0; i<imax; ++i)
      {
        assert(x->includes[i]);
        cout << " " << x->includes[i]->filename;
      }
      cout << endl;
    }
  }

  assert(valid());
  cout << endl;
}

template<typename CFC >

void makestate< CFC >::printafterbuild

(

)

[inline]

After the makefile is built print the following as the building of the makefile is not 100%, the programmer should look at the unknown files.

Definition at line 144 of file makestate.h.

References makestate< CFC >::print(), makestate< CFC >::printobjs, makestate< CFC >::printobjsdependencies, makestate< CFC >::printprocessed, makestate< CFC >::printprocessqueue, makestate< CFC >::printstandard, and makestate< CFC >::printunknown.

{
  printprocessed=true;
  printstandard=false;
  printunknown=true;
  printobjs=false;
  printprocessqueue=false;
  printobjsdependencies=false;

  print();
}

template<typename CFC >

void makestate< CFC >::printdefaults

(

)

[inline]

Set default toggle options on printing.

Definition at line 393 of file makestate.h.

References makestate< CFC >::printobjs, makestate< CFC >::printobjsdependencies, makestate< CFC >::printprocessed, makestate< CFC >::printprocessqueue, makestate< CFC >::printstandard, and makestate< CFC >::printunknown.

Referenced by makestate< CFC >::makestate().

{
  printobjs=true;
  printprocessqueue=true;
  printprocessed=true;
  printstandard=false;
  printunknown=true;
  printobjsdependencies=false;
}

template<typename CFC >

void makestate< CFC >::processqueueadd

(

compilationfile *

cf

)

[inline]

Add to both proessqueue's.

Definition at line 273 of file makestate.h.

References makestate< CFC >::processqueue, and makestate< CFC >::processqueue2.

Referenced by makestate< CFC >::eval(), makestate< CFC >::evaldriver(), and makestatetest::test03().

{
  processqueue2.add(cf);
  processqueue.push_back(cf);
} 

template<typename CFC >

void makestate< CFC >::standardbuild

(

)

[inline]

Populate the standard container.

Definition at line 237 of file makestate.h.

References compilationfile::header, tokenizer::reset(), makestate< CFC >::standard, and tokenizer::subtract().

Referenced by makestatetest::test01(), makestatetest::test02(), and makestatetest::test03().

{
  string standardstring="algorithm bitset cassert cctype cfloat climits cmath complex cstddef cstdlib cstring ctime deque exception fstream functional iomanip ios iosfwd iostream istream iterator limits list local map memory new numeric ostream queue set sstream stack stdexcept streambuf string strstream typeinfo utility valarray vector";

  tokenizer ss(standardstring);
  ss.subtract(" ");

  compilationfile* x;
  for (ss.reset(); !ss; ++ss)
  {
    x = new compilationfile("",ss(),compilationfile::header); 
    standard.add(x);
    //cout << ss() << endl;
  }
}

template<typename CFC >

boolc makestate< CFC >::valid

(

)

[inline]

Some error checking on processqueue.

Definition at line 254 of file makestate.h.

References makestate< CFC >::processqueue, and makestate< CFC >::processqueue2.

Referenced by makestate< CFC >::print().

{
  // The processqueue is contained in processqueue2
  //   They should have the same elements exactly, but I am not
  //   testing in the other direction.
  if (!processqueue.empty()) 
  {
    for (deque<compilationfile*>::const_iterator i=processqueue.begin();
      i != processqueue.end(); i++)
    {
      if ( processqueue2[ (*i)->filename ] == 0 )
        return false;
    }
  }

  return true;
}

---

Member Data Documentation

template<typename CFC>

string makestate< CFC >::driver

Driver cpp file component, by default "main".

Definition at line 105 of file makestate.h.

Referenced by makestatetest::test06().

template<typename CFC>

CFC makestate< CFC >::objs

Object files.

Definition at line 42 of file makestate.h.

Referenced by makestate< CFC >::eval(), makestate< CFC >::makestate(), makestate< CFC >::objsdependenciesPass1(), makestate< CFC >::objsdependenciesPass2(), makestate< CFC >::print(), makestatetest::test05(), and makestate< CFC >::~makestate().

template<typename CFC>

bool makestate< CFC >::printobjs

Toggle objs output.

Definition at line 57 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), makestatetest::test04(), and makestatetest::test06().

template<typename CFC>

bool makestate< CFC >::printobjsdependencies

Toggle objs dependencies output.

Definition at line 67 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), and makestatetest::test06().

template<typename CFC>

bool makestate< CFC >::printprocessed

Toggle processed output.

Definition at line 59 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), makestatetest::test04(), and makestatetest::test06().

template<typename CFC>

bool makestate< CFC >::printprocessqueue

Toggle processqueue output.

Definition at line 61 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), makestatetest::test04(), and makestatetest::test06().

template<typename CFC>

bool makestate< CFC >::printstandard

Toggle standard output.

Definition at line 63 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), and makestatetest::test01().

template<typename CFC>

bool makestate< CFC >::printunknown

Toggle unknown output.

Definition at line 65 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::printafterbuild(), makestate< CFC >::printdefaults(), makestatetest::test04(), and makestatetest::test06().

template<typename CFC>

CFC makestate< CFC >::processed

Unique list of all past in compilationfile's that have been linked to each other.

Definition at line 28 of file makestate.h.

Referenced by makestate< CFC >::evaldriver(), makestate< CFC >::isinprocesschain(), makestate< CFC >::makestate(), and makestate< CFC >::print().

template<typename CFC>

deque<compilationfile*> makestate< CFC >::processqueue

For evaluating.

processqueue and processque2 are mirrored data.

Definition at line 37 of file makestate.h.

Referenced by makestate< CFC >::print(), makestate< CFC >::processqueueadd(), and makestate< CFC >::valid().

template<typename CFC>

CFC makestate< CFC >::processqueue2

For searching.

processqueue and processque2 are mirrored data.

Definition at line 35 of file makestate.h.

Referenced by makestate< CFC >::isinprocesschain(), makestate< CFC >::makestate(), makestate< CFC >::processqueueadd(), and makestate< CFC >::valid().

template<typename CFC>

projfiles<CFC> makestate< CFC >::proj

Holds a list of all the files.

Definition at line 102 of file makestate.h.

Referenced by makestate< CFC >::eval(), makestate< CFC >::evaldriver(), makestatetest::test02(), makestatetest::test03(), and makestatetest::test05().

template<typename CFC>

CFC makestate< CFC >::standard

Standard C++ header names.

Definition at line 30 of file makestate.h.

Referenced by makestate< CFC >::eval(), makestate< CFC >::isinprocesschain(), makestate< CFC >::makestate(), makestate< CFC >::print(), makestate< CFC >::standardbuild(), and makestatetest::test01().

template<typename CFC>

CFC makestate< CFC >::unknown

Unknown files that are not standard and not under proj directory.

Definition at line 32 of file makestate.h.

Referenced by makestate< CFC >::eval(), makestate< CFC >::isinprocesschain(), makestate< CFC >::makestate(), makestate< CFC >::objseval(), and makestate< CFC >::print().

---

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

• makefilebuildtool/makestate.h