CCCC_UseRelationship Class Reference

#include <cccc_use.h>

Inheritance diagram for CCCC_UseRelationship:

Collaboration diagram for CCCC_UseRelationship:

Public Member Functions
string	name (int index) const
	CCCC_UseRelationship (CCCC_Item &is)
int	FromFile (ifstream &infile)
int	ToFile (ofstream &outfile)
void	add_extent (CCCC_Item &)
int	get_count (const char *count_tag)
UseType	get_usetype () const
AugmentedBool	is_visible () const
AugmentedBool	is_concrete () const
void	generate_report (ostream &os)
CCCC_Module *	supplier_module_ptr (CCCC_Project *prj)
CCCC_Module *	client_module_ptr (CCCC_Project *prj)
Public Member Functions inherited from CCCC_Record
virtual	~CCCC_Record ()
virtual string	key () const
AugmentedBool	get_flag (PSFlag psf)
virtual void	sort ()

Private Member Functions
	CCCC_UseRelationship ()

Private Attributes
string	supplier
string	client
string	member
UseType	ut
AugmentedBool	visible
AugmentedBool	concrete

Friends
class	CCCC_Project

Additional Inherited Members
Static Public Member Functions inherited from CCCC_Record
static CCCC_Project *	get_active_project ()
static void	set_active_project (CCCC_Project *prj)
Protected Types inherited from CCCC_Record
typedef CCCC_Table< CCCC_Extent >	Extent_Table
Protected Member Functions inherited from CCCC_Record
virtual void	merge_flags (string &new_flags)
Protected Attributes inherited from CCCC_Record
Extent_Table	extent_table
string	flags

Detailed Description

Definition at line 34 of file cccc_use.h.

Constructor & Destructor Documentation

CCCC_UseRelationship::CCCC_UseRelationship ( )

inlineprivate

Definition at line 40 of file cccc_use.h.

{ ut=utDONTKNOW; }

CCCC_UseRelationship::CCCC_UseRelationship

(

CCCC_Item &

is

)

Definition at line 30 of file cccc_use.cc.

{
  is.Extract(client);
  is.Extract(member);
  is.Extract(supplier);
  visible=abDONTKNOW;
  concrete=abDONTKNOW;
  ut=utDONTKNOW;
}

Here is the call graph for this function:

Member Function Documentation

void CCCC_UseRelationship::add_extent ( CCCC_Item &  is )

virtual

Reimplemented from CCCC_Record.

Definition at line 68 of file cccc_use.cc.

{
  // processing is similar to the CCCC_Record method, except that we update
  // the visibility and concreteness data members
  // but do not do merge_flags
  CCCC_Extent *new_extent=new CCCC_Extent(is);
  CCCC_Extent *inserted_extent=extent_table.find_or_insert(new_extent);

  switch(new_extent->get_visibility())
    {
    case vPUBLIC:
    case vPROTECTED:
      visible=abTRUE;
      break;
    case vPRIVATE:
    case vIMPLEMENTATION:
      visible=abFALSE;
      break;

    default:
      // nothing required
      ;;
    }

  // a single relationship record represents all connections between two
  // modules, hence it may have multiple extents which are of different use
  // types
  // the use type attached to the relationship record is used only to identify
  // inheritance relationships
  UseType new_ut=new_extent->get_usetype();
  if(new_ut==utINHERITS)
    {
      ut=utINHERITS;
    }

  switch(new_ut)
    {
    case utINHERITS:
    case utHASBYVAL:
    case utPARBYVAL:
    case utVARBYVAL:
      concrete=abTRUE;
      break;
    default:
      // no change required
      ;;
    }

  if(new_extent != inserted_extent)
    {
      delete new_extent;
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

CCCC_Module * CCCC_UseRelationship::client_module_ptr

(

CCCC_Project *

prj

)

Definition at line 169 of file cccc_use.cc.

{
  return prj->module_table.find(client.c_str());
}

Here is the call graph for this function:

int CCCC_UseRelationship::FromFile

(

ifstream &

infile

)

Definition at line 206 of file cccc_use.cc.

{
  int retval;
  CCCC_Item next_line;
  next_line.FromFile(ifstr);
  ifstr_line++;
  
  string line_keyword_dummy;

  CCCC_UseRelationship *found_uptr=NULL;

  if(
     next_line.Extract(line_keyword_dummy) &&
     next_line.Extract(this->supplier) &&
     next_line.Extract(this->client) 
     ) 
    {
      found_uptr=
    current_loading_project->userel_table.find_or_insert(this);
      if(found_uptr==this)
    {
      // the newly created instance of the module is the first
      // and has taken its place in the database, so we protect
      // it from deletion
      retval=RECORD_ADDED;
    }
      else
    {
      retval=RECORD_TRANSCRIBED;
    }
 
      // process extent records
      while(PeekAtNextLinePrefix(ifstr,USEEXT_PREFIX))
    {
      CCCC_Extent *new_extent=new CCCC_Extent;
      next_line.FromFile(ifstr);
      ifstr_line++;
      string supplier_dummy, client_dummy;

      if(
         next_line.Extract(line_keyword_dummy) &&
         next_line.Extract(supplier_dummy) &&
         next_line.Extract(client_dummy) &&
         new_extent->GetFromItem(next_line)
         )
        {
          // We don't ever expect to find duplicated extent records
          // but just in case... 
          CCCC_Extent *found_eptr=
        found_uptr->extent_table.find_or_insert(new_extent);
          if(found_eptr!=new_extent)
        {
          cerr << "Failed to add extent for relationship "
               << found_uptr->key() << " at line " << ifstr_line 
               << endl;
          delete new_extent;
        }
        }
    }

    } 
  else // extraction of module intial line failed
    {
      // unexpected problem with the input
      retval=RECORD_ERROR;
    }

  // If the import was successful, we will also have imported all dependent
  // extent records following the main record.
  // If not, we must skip them.
  while(PeekAtNextLinePrefix(ifstr,USEEXT_PREFIX))
    {
      CCCC_Item next_line;
      next_line.FromFile(ifstr);
      ifstr_line++;
      cerr << "Ignoring userel extent on line " << ifstr_line << endl;
    }
 
  return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

void CCCC_UseRelationship::generate_report

(

ostream &

os

)

int CCCC_UseRelationship::get_count ( const char *  count_tag )

virtual

Implements CCCC_Record.

Definition at line 122 of file cccc_use.cc.

{
  int retval=0;

  if( (strncmp(count_tag,"FI",2)==0) || (strncmp(count_tag,"FO",2)==0) )
    {
      char suffix=count_tag[2];
      switch(suffix)
    {
    case 0:
      retval=1;
      break;

    case 'v':
      if(visible!=abFALSE)
        {
          retval=1;
        }
      break;

    case 'c':
      if(concrete!=abFALSE)
        { 
          retval=1;
        }
      break;

    default:
      cerr << "Unexpected count tag suffix" << count_tag << endl;
    }
    }
  else
    {
      cerr << "Unexpected count tag " << count_tag << endl;
    }

        
  return retval;
}

UseType CCCC_UseRelationship::get_usetype ( ) const

inline

Definition at line 49 of file cccc_use.h.

{ return ut; }

AugmentedBool CCCC_UseRelationship::is_concrete ( ) const

inline

Definition at line 51 of file cccc_use.h.

{ return concrete; }

Here is the caller graph for this function:

AugmentedBool CCCC_UseRelationship::is_visible ( ) const

inline

Definition at line 50 of file cccc_use.h.

{ return visible; }

Here is the caller graph for this function:

string CCCC_UseRelationship::name ( int  index ) const

virtual

Reimplemented from CCCC_Record.

Definition at line 40 of file cccc_use.cc.

{ 
  string namestr;

  switch(name_level)
    {
    case nlRANK:
    case nlSIMPLE:
      namestr.append(client);
      namestr.append(" uses ");
      namestr.append(supplier);
      break;
      
    case nlSUPPLIER:
      namestr=supplier;
      break;

    case nlCLIENT:
      namestr=client;
      break;

    default:
      cerr << "unexpected name level" << endl;
    }

  return namestr.c_str();
}   

Here is the caller graph for this function:

CCCC_Module * CCCC_UseRelationship::supplier_module_ptr

(

CCCC_Project *

prj

)

Definition at line 164 of file cccc_use.cc.

{
  return prj->module_table.find(supplier.c_str());
}

Here is the call graph for this function:

int CCCC_UseRelationship::ToFile

(

ofstream &

outfile

)

Definition at line 175 of file cccc_use.cc.

{
  int retval=FALSE;

  CCCC_Item line;
  line.Insert(USEREL_PREFIX);
  line.Insert(supplier);
  line.Insert(client);
  line.ToFile(ofstr);

  CCCC_Extent *extent_ptr=extent_table.first_item();
  while(extent_ptr!=NULL)
    {
      CCCC_Item extent_line;
      extent_line.Insert(USEEXT_PREFIX);
      extent_line.Insert(supplier);
      extent_line.Insert(client);
      extent_ptr->AddToItem(extent_line);
      extent_line.ToFile(ofstr);
     
      extent_ptr=extent_table.next_item();
    }
  
  if(ofstr.good())
    {
      retval=TRUE;
    } 

  return retval;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class CCCC_Project

friend

Definition at line 36 of file cccc_use.h.

Member Data Documentation

string CCCC_UseRelationship::client

private

Definition at line 37 of file cccc_use.h.

AugmentedBool CCCC_UseRelationship::concrete

private

Definition at line 39 of file cccc_use.h.

string CCCC_UseRelationship::member

private

Definition at line 37 of file cccc_use.h.

string CCCC_UseRelationship::supplier

private

Definition at line 37 of file cccc_use.h.

UseType CCCC_UseRelationship::ut

private

Definition at line 38 of file cccc_use.h.

AugmentedBool CCCC_UseRelationship::visible

private

Definition at line 39 of file cccc_use.h.

---

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

• cccc_use.h
• cccc_use.cc