compilationfile Class Reference

Hold state of file in building a Makefile process. More...

#include <compilationfile.h>

Collaboration diagram for compilationfile:

List of all members.

Public Types
enum	filetype { unknown = 0, header, source, obj }
Public Member Functions
stringc	filenamefull () const
	e.g.
boolc	isheader () const
	Is this file a header?
boolc	issource () const
	Is this file a cpp file?
boolc	isobj () const
	Is this file an object file?
	compilationfile (stringc &fullfilename)
	Interpret the string extracting path and type.
	compilationfile (stringc &path_, stringc &filename_)
	Interpret the string extracting type.
	compilationfile (stringc &path_, stringc &filename_, filetype ft_)
	Not all headers have .h, this lets construction explicitly pass that information in.
stringc	extension () const
	Filename extension.
stringc	component () const
	Filename without the extension.
void	determinefiletype ()
	Set ft based on extension.
void	print () const
	Print to standard output info.
void	clear ()
	Clears all data fields.
boolc	includesvalid () const
	Verify unique list of elements.
boolc	includesadd (compilationfile *cf)
	Add the file if it is not already contained in includes.
Public Attributes
string	filename
	Primary id e.g.
string	path
	Relative to a directory inside proj.
filetype	ft
compilationfile *	linkheader
	Link to header file if it exists.
compilationfile *	linksource
	Link to cpp/source file if it exists.
compilationfile *	linkobj
	Link to obj file if this is a header, cpp pair.
vector< compilationfile * >	includes
	For source file - a list of files from include directive.
Static Public Attributes
static uint	filenamelengthmax = 40
	Restriction so hash algorithm has a maximum length.

---

Detailed Description

Hold state of file in building a Makefile process.

Definition at line 15 of file compilationfile.h.

---

Member Enumeration Documentation

enum compilationfile::filetype

Enumerator:

unknown
header
source
obj

Definition at line 31 of file compilationfile.h.

{ unknown=0, header, source, obj };

---

Constructor & Destructor Documentation

compilationfile::compilationfile

(

stringc &

fullfilename

)

Interpret the string extracting path and type.

Definition at line 43 of file compilationfile.cpp.

References clear(), determinefiletype(), filename, filenamelengthmax, and path.

{
  clear();

  assert( fullfilename.length()>0 );

  string::size_type pos2 = fullfilename.rfind("/");
  filename = fullfilename.substr(pos2+1);

  path = fullfilename.substr(0,pos2+1);

  determinefiletype();

  // Maximum number of characters for hash.
  assert(filename.length() <= filenamelengthmax);
}

compilationfile::compilationfile	(	stringc &	path_,
		stringc &	filename_
	)

Interpret the string extracting type.

Definition at line 61 of file compilationfile.cpp.

{
  clear();

  filename=filename_;
  path=path_;

  determinefiletype();

  // Maximum number of characters for hash.
  assert(filename.length() <= filenamelengthmax);
}

compilationfile::compilationfile	(	stringc &	path_,
		stringc &	filename_,
		filetype	ft_
	)

Not all headers have .h, this lets construction explicitly pass that information in.

Definition at line 78 of file compilationfile.cpp.

{
  clear();

  filename=filename_;
  path=path_;
  ft=ft_;

  // Maximum number of characters for hash.
  assert(filename.length() <= filenamelengthmax);
}

---

Member Function Documentation

void compilationfile::clear

(

)

Clears all data fields.

Definition at line 32 of file compilationfile.cpp.

References filename, ft, linkheader, linkobj, linksource, path, and unknown.

Referenced by compilationfile().

{
  filename="";
  path="";
  ft=unknown;

  linkheader=0;
  linksource=0;
  linkobj=0;
}

stringc compilationfile::component

(

)

const

Filename without the extension.

Definition at line 104 of file compilationfile.cpp.

References filename.

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

{
  assert( filename.length()>0 );

  string::size_type pos3 = filename.rfind(".");
  string s1 = filename.substr(0,pos3);

  return s1;
}

void compilationfile::determinefiletype

(

)

Set ft based on extension.

Definition at line 114 of file compilationfile.cpp.

References extension(), ft, header, obj, and source.

Referenced by compilationfile().

{
  string ext=extension();

  if (ext==".h")
    ft=header;
  if (ext==".cpp")
    ft=source;
  if (ext==".o")
    ft=obj;
}

stringc compilationfile::extension

(

)

const

Filename extension.

Definition at line 94 of file compilationfile.cpp.

References filename.

Referenced by determinefiletype(), and print().

{
  assert( filename.length()>0 );

  string::size_type pos = filename.rfind(".");
  string s1 = filename.substr(pos);

  return s1;
}

stringc compilationfile::filenamefull

(

)

const [inline]

e.g.

../vrml/vrmlshapeparse.h

Definition at line 28 of file compilationfile.h.

References filename, and path.

    { return path + filename; }

boolc compilationfile::includesadd

(

compilationfile *

cf

)

Add the file if it is not already contained in includes.

Definition at line 182 of file compilationfile.cpp.

References assertreturnfalse, filename, includes, and includesvalid().

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

{
  assertreturnfalse(cf);
  //assert(cf);

//  if (cf==this)
//    return false;

  uint imax=includes.size();
  for ( uint i=0; i<imax; ++i)
  {
    if (includes[i]==cf)
      return false;
    if (includes[i]->filename==cf->filename)
      return false;
  }

  includes.push_back(cf);
includesvalid();
  return true;
}

boolc compilationfile::includesvalid

(

)

const

Verify unique list of elements.

Definition at line 141 of file compilationfile.cpp.

References filename, includes, print(), SHOW, and SHOW3.

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

{

//cout << SHOW(this) << " " << filename << endl;

/*
{
for (uint i=0; i<includes.size(); ++i)
  //cout << i << ":" <<  includes[i] << " " << includes[i]->filename << endl;
  cout << i << ":" <<  includes[i] << " "; 
cout << endl;
}
*/


  uint imax=includes.size();
  for (uint i=0; i<imax; ++i)
  {
    if (includes[i]==0)
      return false;

    for (uint k=i+1; k<imax; ++k)
    {
      if (includes[i]==includes[k])
      {
cout << SHOW(this) << " " << filename << endl;
cout << i << "," << k << ":" << SHOW3(includes[i]);
cout << endl;
this->print();

//cout << " " << includes[i]->filename << endl;
//for (uint i=0; i<includes.size(); ++i)
//  { cout << includes[i]->print(); }
        return false;
      }
    }
  }

  return true;
}

boolc compilationfile::isheader

(

)

const

Is this file a header?

Definition at line 126 of file compilationfile.cpp.

References ft, and header.

Referenced by print().

{
  return (ft==header);
};

boolc compilationfile::isobj

(

)

const

Is this file an object file?

Definition at line 136 of file compilationfile.cpp.

References ft, and obj.

Referenced by print().

{
  return (ft==obj);
};

boolc compilationfile::issource

(

)

const

Is this file a cpp file?

Definition at line 131 of file compilationfile.cpp.

References ft, and source.

Referenced by print().

{
  return (ft==source);
};

void compilationfile::print

(

)

const

Print to standard output info.

Definition at line 9 of file compilationfile.cpp.

References component(), extension(), filename, ft, includes, isheader(), isobj(), issource(), path, and SHOW.

Referenced by includesvalid(), compilationfiletest::test01(), compilationfiletest::test03(), and makestatetest::test05().

{
  cout << SHOW(filename) << endl;
  cout << SHOW(path) << endl;
  cout << SHOW(ft) << endl;
  cout << SHOW(component()) << endl;
  cout << SHOW(extension()) << endl;

  cout << SHOW(isheader()) << endl;
  cout << SHOW(issource()) << endl;
  cout << SHOW(isobj()) << endl;

  cout << "includes: ";
  for (uint i=0; i<includes.size(); ++i)
  {
    if (includes[i]==0)
      continue;

    cout << " " << includes[i]->filename;
  }
  cout << endl;
}

---

Member Data Documentation

string compilationfile::filename

Primary id e.g.

myfile.h.

Definition at line 23 of file compilationfile.h.

Referenced by cfcontainervec::add(), cfcontainerhash::add(), clear(), compilationfile(), component(), makestate< CFC >::eval(), extension(), filenamefull(), includesadd(), includesvalid(), makestate< CFC >::objseval(), projfiles< CFC >::print(), makestate< CFC >::print(), and print().

uint compilationfile::filenamelengthmax = 40 [static]

Restriction so hash algorithm has a maximum length.

Definition at line 20 of file compilationfile.h.

Referenced by compilationfile().

filetype compilationfile::ft

Definition at line 32 of file compilationfile.h.

Referenced by clear(), determinefiletype(), makestate< CFC >::eval(), isheader(), isobj(), issource(), makestate< CFC >::objsdependenciesPass2(), makestate< CFC >::objseval(), and print().

vector<compilationfile*> compilationfile::includes

For source file - a list of files from include directive.

For an obj file - a list of dependencies for the Makefile.

Definition at line 69 of file compilationfile.h.

Referenced by makestate< CFC >::eval(), includesadd(), includesvalid(), makestate< CFC >::objsdependenciesPass2(), makestate< CFC >::objseval(), createmakefile< CFC >::pathsbuild(), makestate< CFC >::print(), and print().

compilationfile* compilationfile::linkheader

Link to header file if it exists.

Definition at line 61 of file compilationfile.h.

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

compilationfile* compilationfile::linkobj

Link to obj file if this is a header, cpp pair.

Definition at line 65 of file compilationfile.h.

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

compilationfile* compilationfile::linksource

Link to cpp/source file if it exists.

Definition at line 63 of file compilationfile.h.

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

string compilationfile::path

Relative to a directory inside proj.

Definition at line 25 of file compilationfile.h.

Referenced by clear(), compilationfile(), makestate< CFC >::eval(), filenamefull(), projfiles< CFC >::print(), and print().

---

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

• makefilebuildtool/compilationfile.h
• makefilebuildtool/compilationfile.cpp