udoc.hpp

/* ==================================================== ======== ======= *
 *
 *  udoc.hpp
 *  Ubit Project
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2005 Eric Lecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * YOU CAN REDISTRIBUTE IT AND/OR MODIFY IT UNDER THE TERMS OF THE GNU 
 * GENERAL PUBLIC LICENSE AS PUBLISHED BY THE FREE SOFTWARE FOUNDATION; 
 * EITHER VERSION 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************
 * ==================================================== [-c-Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _udoc_hpp_
#define _udoc_hpp_
//pragma ident  "@(#)udoc.hpp   ubit:05.05.00"
#include <list>
#include <map>
#include <ubit/uprop.hpp>
#include <ubit/ustr.hpp>
#include <ubit/uboxes.hpp>
namespace ubit {

class UDocCreator;
class UDocAttachment;

typedef std::list<UDocAttachment*> UDocAttachments;

/* ==================================================== ====== ======= */
class UDocFactory {
public:
  UDocFactory();
  virtual ~UDocFactory();

  static UDocFactory& getDefaultFactory();
  virtual UDoc* create(const UStr& name);
  virtual UDoc* load(const UStr& name, const UStr& buffer);
  virtual UDoc* read(const UStr& filename);
  virtual int getStatus() const;
  virtual void saveErrors(bool);
  virtual UStr* getErrors() const; 
  virtual UDocCreator* getCreator(const UStr& type);
  virtual UDocCreator* getDefaultCreator();

  virtual void addCreator(const UStr& type, UDocCreator&);

  virtual void setDefaultCreator(UDocCreator&);

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
protected:
  struct Comp {
    bool operator()(const UStr* s1, const UStr* s2) const;
  };
  typedef std::map<const UStr*, UDocCreator*, Comp> Map;
  Map rmap;
  UDocCreator* default_creator;
  int stat;
  uptr<UStr> errors;
};

/* ==================================================== [Elc:] ======= */
/* ==================================================== ====== ======= */
class UDoc : public UVbox {
public:
  UBIT_ELEMENT_CLASS(UDoc, UVbox)

  static UDocFactory& getDefaultFactory();

  virtual ~UDoc();
    
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual bool isEditable() const;
  virtual void setEditable(bool state = true);
 
  virtual const UStr& getPath() const {return *ppath;}
  
  virtual void setPath(const UStr& path);
  virtual void makePath(UStr& fullpath, const UStr& url);
  virtual const UDocAttachments* getAttachments() const {return null;}

  virtual int loadAttachments(bool reload = false) {return 0;}
  virtual bool loadAttachment(UDocAttachment*, bool reload = false) {return false;}
   
  virtual void onElementEvent(const UArgs&);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // impl.

  virtual void dispatchEvent(UEvent&, const UStr* path);
  
protected:
  friend class UDoc::Class;
  UDoc();
  UDoc(const UStr& path);

private:
  uptr<UStr> ppath;
  uptr<UGroup> call_list;
  UDoc(const UDoc&);             // these operators are forbidden
  UDoc& operator=(const UDoc&);
};

/* ==================================================== ======== ======= */
class UDocAttachment {
public:
  virtual ~UDocAttachment() {}
  virtual const UStr* getUrl() const = 0;
  virtual const UStr* getType() const = 0;
  virtual bool isLoaded() const = 0;
  virtual int  load(UDoc*) = 0;
};

/* ==================================================== ======== ======= */
struct UDocSource {
  enum From {PATHNAME, BUFFER, SCRATCH};

  UDocSource(int from, const UStr* path, UStr* errors,
             const UStr* buffer = null);
  int from;
  int stat;
  uptr<const UStr> path, fullpath;
  const UStr* buffer;
  UStr* errors;
};

/* ==================================================== ======== ======= */
class UDocCreator {
public:
  virtual ~UDocCreator() {}
  virtual UDoc* create(UDocSource&) = 0;
};

/* ==================================================== ======== ======= */
class UFlatDoc : public UDoc {
public:
  UFlatDoc(const UStr& _pathname);
  virtual bool isEditable() const;
  virtual void setEditable(bool state = true);
  uptr<class UEdit> edit;
};

/* ==================================================== ======== ======= */
class UPluginDoc : public UDoc {
public:
  UPluginDoc(const UStr& _pathname);
  //virtual void setEditable(bool state = true) {}
};

}
#endif
/* ==================================================== [TheEnd] ======= */

---