LCD_DocumentImpl.hh

Go to the documentation of this file.

// ----------------------------------------------------------------------------
// $Id: LCD_DocumentImpl.hh,v 1.10 2004/02/03 12:45:21 uid561 Exp $
// ----------------------------------------------------------------------------
//
// LCD_DocumentImpl  -- inherits from near-virtual base class

#ifndef LCD_DOCUMENT_IMPL_H
#define LCD_DOCUMENT_IMPL_H

#include "LCD_DocListener.hh"
#include "LCD_Document.hh"
#include "xercesc/dom/deprecated/DOMParser.hpp"
#include <list>
#include <string>

class LCD_DocErrorReporter;
class LCD_DocManager;

typedef int Timestamp;

class LCD_DocumentImpl : public LCD_Document {
  // Might also add methods of one sort or another to allow this class
  // to know when the underlying DOM_Document has been modified.
  // If so, they should probably come from a different interface.
public:
  void registerListener(LCD_DocListener* ls);
  int deleteListener(LCD_DocListener* ls);
  void notifyListeners();

  XERCES_CPP_NAMESPACE::DOM_Element
  getElement(XERCES_CPP_NAMESPACE::DOMString id,
             XERCES_CPP_NAMESPACE::DOMString elementName
              = XERCES_CPP_NAMESPACE::DOMString("*")) const;

private:
  LCD_DocumentImpl(std::string XMLfilespec); // only for friends..
  void parse();

  friend class LCD_DocManager;     // ..like LCD_DocManager

  // May want something like the following:
  //  Vector<LCD_DocListener> getListeners();

  // Other methods are declared in LCD_Document header.

  // Might want to save more stuff from special attributes of file

private:
  std::string                  filespec;     // ..of root XML file
  std::list<LCD_DocListener*> *listeners;

  Timestamp                    firstRead; // when DOM was created from the file
  Timestamp                    lastMod;

  XERCES_CPP_NAMESPACE::DOMParser  *parser;
  LCD_DocErrorReporter        *errReporter;

  // May also want to keep a list of mods since last notification.
  // items in the list would perhaps have several fields, e.g.
  //    ptr or ref to node modified
  //    node type (e.g. element or attribute)
  //    code for type of modification

  // Another optimization might be to scan the DOM after it is built and
  // form ancillary information such as
  //     - max depth of tree
  //     - hash table to find elements by id (in this case only need
  //       the simplest form of getElement)
  // If so, better sign up to be notified for updates so that the
  // ancillary information can be kept current.
};
#endif

---