NLGEORGES::CForm Class Reference

#include <form.h>

Inheritance diagram for NLGEORGES::CForm:

---

Detailed Description

This class implement a georges form.

Definition at line 44 of file form.h.

Public Types
enum	{ HeldElementCount = 4 }
Public Member Functions
	CForm ()
void	clean ()
void	clearParents ()
const std::string &	getComment () const
void	getDependencies (std::set< std::string > &dependencies) const
const std::string &	getFilename () const
uint	getNumParent () const
	Get a mutable pointer on the root element of the form. It is a struct node.
CForm *	getParent (uint parent) const
uint	getParentCount () const
const std::string &	getParentFilename (uint parent) const
UForm *	getParentForm (uint parent) const
	Get a mutable pointer on the root element of the form. It is a struct node.
const sint &	getRefCount () const
const UFormElm &	getRootNode () const
	Get a const pointer on the root element of the form. It is a struct node.
UFormElm &	getRootNode ()
	Get a mutable pointer on the root element of the form. It is a struct node.
bool	insertParent (uint before, const char *filename, CForm *parent)
void	removeParent (uint parent)
void	warning (bool exception, const char *function, const char *format,...) const
void	write (xmlDocPtr doc, const char *filename, bool georges4CVS)
void	write (class NLMISC::IStream &stream, bool georges4CVS)
	~CForm ()
Data Fields
sint	crefs
CFormElmStruct	Elements
	Vector of CFormElm*.
CFileHeader	Header
CFormElmStruct *	HeldElements [HeldElementCount]
	Backup slots.
CPtrInfo *	pinfo
Static Public Attributes
CPtrInfo	NullPtrInfo
Private Member Functions
void	read (xmlNodePtr node, CFormLoader &loader, CFormDfn *dfn, const char *filename)
void	readParent (const char *parent, CFormLoader &loader)
Private Attributes
std::string	_Filename
std::vector< CParent >	ParentList
	Pointer on the parent.
Friends
class	CFormLoader
bool	convertFormFile (const char *oldFileName, const char *newFileName)
struct	CPtrInfo

---

Member Enumeration Documentation

anonymous enum

Enumeration values: HeldElementCount  Definition at line 50 of file form.h. { HeldElementCount = 4 };

---

Constructor & Destructor Documentation

NLGEORGES::CForm::CForm (   )

Definition at line 94 of file form.cpp. References HeldElementCount, HeldElements, and uint. : Elements (this, NULL, NULL, 0xffffffff) { uint i; for (i=0; i<HeldElementCount; i++) { HeldElements[i] = new CFormElmStruct (this, NULL, NULL, 0xffffffff); } }

NLGEORGES::CForm::~CForm (   )

Definition at line 105 of file form.cpp. References HeldElementCount, HeldElements, and uint. { uint i; for (i=0; i<HeldElementCount; i++) { delete HeldElements[i]; } }

---

Member Function Documentation

void NLGEORGES::CForm::clean (   )

Definition at line 337 of file form.cpp. References clearParents(). Referenced by read(). { clearParents (); }

void NLGEORGES::CForm::clearParents (   )

Definition at line 344 of file form.cpp. References ParentList. Referenced by clean(). { ParentList.clear (); }

const std::string & NLGEORGES::CForm::getComment (   )  const [virtual]

Get the comment Implements NLGEORGES::UForm. Definition at line 264 of file form.cpp. References NLGEORGES::CFileHeader::Comments, and Header. { return Header.Comments; }

void NLGEORGES::CForm::getDependencies (  std::set< std::string > &  dependencies  )  const [virtual]

Get dependency files Implements NLGEORGES::UForm. Definition at line 373 of file form.cpp. References _Filename, NLGEORGES::CFormElmStruct::getDependencies(), ParentList, NLMISC::strlwr(), and uint. { // Add me if (dependencies.insert (strlwr(CFile::getFilename (_Filename))).second) { // Add parents uint i; for (i=0; i<ParentList.size (); i++) { if (ParentList[i].Parent) { ParentList[i].Parent->getDependencies (dependencies); } } // Add elements Elements.getDependencies (dependencies); } }

const std::string & NLGEORGES::CForm::getFilename (   )  const

Definition at line 351 of file form.cpp. References _Filename. Referenced by NLGEORGES::CMyEvalNumExpr::evalValue(), NLGEORGES::CFormElm::getIternalNodeByName(), NLGEORGES::CFormElmAtom::warning(), NLGEORGES::CFormElmArray::warning(), NLGEORGES::CFormElmVirtualStruct::warning(), NLGEORGES::CFormElmStruct::warning(), and NLGEORGES::CFormElm::warning(). { return _Filename; }

uint NLGEORGES::CForm::getNumParent (   )  const [virtual]

Get a mutable pointer on the root element of the form. It is a struct node. Access form parents Implements NLGEORGES::UForm. Definition at line 395 of file form.cpp. References getParentCount(), and uint. { return getParentCount(); }

CForm * NLGEORGES::CForm::getParent (  uint  parent  )  const

Definition at line 316 of file form.cpp. References ParentList, and uint. Referenced by NLGEORGES::CFormElm::getIternalNodeByName(), and getParentForm(). { return ParentList[parent].Parent; }

uint NLGEORGES::CForm::getParentCount (   )  const

Definition at line 330 of file form.cpp. References ParentList, and uint. Referenced by NLGEORGES::CFormElm::getIternalNodeByName(), getNumParent(), and readParent(). { return ParentList.size (); }

const std::string & NLGEORGES::CForm::getParentFilename (  uint  parent  )  const

Definition at line 323 of file form.cpp. References ParentList, and uint. { return ParentList[parent].ParentFilename; }

UForm * NLGEORGES::CForm::getParentForm (  uint  parent  )  const [virtual]

Get a mutable pointer on the root element of the form. It is a struct node. Implements NLGEORGES::UForm. Definition at line 402 of file form.cpp. References getParent(), and uint. { CForm *form = getParent (parent); return form; }

const sint& NLMISC::CRefCount::getRefCount (   )  const [inline, inherited]

Definition at line 70 of file smart_ptr.h. References NLMISC::CRefCount::crefs, and sint. { return crefs; }

const UFormElm & NLGEORGES::CForm::getRootNode (   )  const [virtual]

Get a const pointer on the root element of the form. It is a struct node. Implements NLGEORGES::UForm. Definition at line 85 of file form.cpp. { return Elements; }

UFormElm & NLGEORGES::CForm::getRootNode (   )  [virtual]

Get a mutable pointer on the root element of the form. It is a struct node. Access form nodes Implements NLGEORGES::UForm. Definition at line 78 of file form.cpp. Referenced by NLGEORGES::CMyEvalNumExpr::evalValue(), and NLGEORGES::CFormElm::getIternalNodeByName(). { return Elements; }

bool NLGEORGES::CForm::insertParent (  uint  before, const char *  filename, CForm *  parent )

Definition at line 283 of file form.cpp. References Elements, NLGEORGES::CFormElmStruct::FormDfn, nlassert, ParentList, uint, and warning(). Referenced by readParent(). { // Set or reset ? nlassert (parent); // Must have the same DFN if (parent->Elements.FormDfn == Elements.FormDfn) { // Set members std::vector<CParent>::iterator ite = ParentList.insert (ParentList.begin() + before); ite->Parent = parent; ite->ParentFilename = filename; return true; } else { // Output an error warning (false, "insertParent", "Can't insert parent form (%s) that has not the same DFN.", filename); } return false; }

void NLGEORGES::CForm::read (  xmlNodePtr  node, CFormLoader &  loader, CFormDfn *  dfn, const char *  filename )  [private]

Definition at line 188 of file form.cpp. References _Filename, NLGEORGES::CFormElmStruct::build(), clean(), Header, HeldElementCount, HeldElements, index, ParentList, NLGEORGES::CFileHeader::read(), NLGEORGES::CFormElmStruct::read(), readParent(), uint, and warning(). { // Save the filename _Filename = CFile::getFilename (filename); // Reset form clean (); // Check node name if ( ((const char*)node->name == NULL) || (strcmp ((const char*)node->name, "FORM") != 0) ) { // Make an error message warning (true, "read", "XML Syntax error in block line %d, node (%s) should be FORM.", (int)node->content, node->name); } // Get first struct node xmlNodePtr child = CIXml::getFirstChildNode (node, "STRUCT"); if (child == NULL) { // Throw exception warning (true, "read", "Syntax error in block line %d, node (%s) should have a STRUCT child node.", (int)node->content, node->name); } // Read the struct Elements.read (child, loader, dfn, this); // Get next struct node child = CIXml::getNextChildNode (node, "STRUCT"); uint index = 0; while ( (child != NULL) && (index < HeldElementCount)) { HeldElements[index]->read (child, loader, dfn, this); index++; } while (index < HeldElementCount) { // Build the Form HeldElements[index]->build (dfn); index++; } // Get the old parent parameter const char *parent = (const char*)xmlGetProp (node, (xmlChar*)"Parent"); if (parent) { // Add a parent, xmlFree is done by readParent readParent (parent, loader); } // Read the new parent nodes uint parentCount = CIXml::countChildren (node, "PARENT"); // Reserve some parents ParentList.reserve (ParentList.size () + parentCount); // Enum children node child = CIXml::getFirstChildNode (node, "PARENT"); while (child) { parent = (const char*)xmlGetProp (child, (xmlChar*)"Filename"); // Add a parent, xmlFree is done by readParent readParent (parent, loader); // Next node <PARENT> child = CIXml::getNextChildNode (child, "PARENT"); } // Read the header Header.read (node); }

void NLGEORGES::CForm::readParent (  const char *  parent, CFormLoader &  loader )  [private]

Definition at line 154 of file form.cpp. References getParentCount(), insertParent(), NLGEORGES::CFormLoader::loadForm(), and warning(). Referenced by read(). { // Load the parent CForm *theParent = (CForm*)loader.loadForm (parent); if (theParent != NULL) { // Set the parent if (!insertParent (getParentCount (), parent, theParent)) { // Make an error message std::string parentName = parent; // Delete the value xmlFree ((void*)parent); // Throw exception warning (true, "readParent", "Can't set the parent FORM named (%s). Check if it is the same form or if it use a differnt formDfn.", parentName.c_str ()); } } else { // Make an error message std::string parentName = parent; // Delete the value xmlFree ((void*)parent); // Throw exception warning (true, "readParent", "Can't load the parent FORM named (%s).", parentName.c_str ()); } }

void NLGEORGES::CForm::removeParent (  uint  parent  )

Definition at line 309 of file form.cpp. References ParentList, and uint. { ParentList.erase (ParentList.begin() + parent); }

void NLGEORGES::CForm::warning (  bool  exception, const char *  function, const char *  format, ...  )  const

Definition at line 358 of file form.cpp. References _Filename, buffer, format, and NLGEORGES::warning(). Referenced by insertParent(), read(), and readParent(). { // Make a buffer string va_list args; va_start( args, format ); char buffer[1024]; vsnprintf( buffer, 1024, format, args ); va_end( args ); // Set the warning NLGEORGES::warning (exception, "(CForm::%s) in form (%s) : %s", function, _Filename.c_str (), buffer); }

void NLGEORGES::CForm::write (  xmlDocPtr  doc, const char *  filename, bool  georges4CVS )

Definition at line 116 of file form.cpp. References _Filename, Header, HeldElementCount, HeldElements, ParentList, uint, NLGEORGES::CFileHeader::write(), and NLGEORGES::CFormElmStruct::write(). { // Save the filename if (filename) _Filename = CFile::getFilename (filename); // Create the first node xmlNodePtr node = xmlNewDocNode (doc, NULL, (const xmlChar*)"FORM", NULL); xmlDocSetRootElement (doc, node); // List of parent for (uint parent=0; parent<ParentList.size (); parent++) { // Parent name not empty ? if (!(ParentList[parent].ParentFilename.empty())) { // Add a parent node xmlNodePtr parentNode = xmlNewChild ( node, NULL, (const xmlChar*)"PARENT", NULL ); xmlSetProp (parentNode, (const xmlChar*)"Filename", (const xmlChar*)ParentList[parent].ParentFilename.c_str()); } } // Write elements Elements.write (node, this, NULL, true); // Write held elements uint i; for (i=0; i<HeldElementCount; i++) { HeldElements[i]->write (node, this, NULL, true); } // Header Header.write (node, georges4CVS); }

void NLGEORGES::CForm::write (  class NLMISC::IStream &  stream, bool  georges4CVS )  [virtual]

Write the form in a stream. Parameters: stream  is the stream used to write the form georges4CVS  should be true if you use Georges with CVS false else Implements NLGEORGES::UForm. Definition at line 271 of file form.cpp. References NLMISC::COXml::getDocument(), and NLMISC::COXml::init(). { // Xml stream COXml xmlStream; xmlStream.init (&stream); // Write the file write (xmlStream.getDocument (), NULL, georges4CVS); }

---

Friends And Related Function Documentation

friend class CFormLoader [friend]

Definition at line 46 of file form.h.

bool convertFormFile (  const char *  oldFileName, const char *  newFileName )  [friend]

friend struct CPtrInfo [friend, inherited]

Definition at line 67 of file smart_ptr.h.

---

Field Documentation

std::string NLGEORGES::CForm::_Filename [private]

Definition at line 132 of file form.h. Referenced by getDependencies(), getFilename(), read(), warning(), and write().

sint NLMISC::CRefCount::crefs [mutable, inherited]

Definition at line 79 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), NLMISC::CRefCount::getRefCount(), and NLMISC::CRefCount::~CRefCount().

CFormElmStruct NLGEORGES::CForm::Elements

Vector of CFormElm*. Definition at line 78 of file form.h. Referenced by insertParent().

CFileHeader NLGEORGES::CForm::Header

Definition at line 73 of file form.h. Referenced by getComment(), read(), and write().

CFormElmStruct* NLGEORGES::CForm::HeldElements[HeldElementCount]

Backup slots. Definition at line 81 of file form.h. Referenced by CForm(), read(), write(), and ~CForm().

CRefCount::CPtrInfo NLMISC::CRefCount::NullPtrInfo [static, inherited]

Referenced by NLMISC::CRefCount::CRefCount().

std::vector<CParent> NLGEORGES::CForm::ParentList [private]

Pointer on the parent. Definition at line 122 of file form.h. Referenced by clearParents(), getDependencies(), getParent(), getParentCount(), getParentFilename(), insertParent(), read(), removeParent(), and write().

CPtrInfo* NLMISC::CRefCount::pinfo [mutable, inherited]

Definition at line 80 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), and NLMISC::CRefCount::~CRefCount().

---

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

• form.h
• form.cpp

---