source: trunk/gsdl/src/recpt/action.h@ 146

/**********************************************************************
 *
 * action.h -- 
 * Copyright (C) 1999  The New Zealand Digital Library Project
 *
 * PUT COPYRIGHT NOTICE HERE
 *
 * $Id: action.h 146 1999-02-04 10:00:57Z rjmcnab $
 *
 *********************************************************************/


#ifndef ACTION_H
#define ACTION_H

#include "gsdlconf.h"
#include "text_t.h"
#include "cgiargs.h"

#if defined(GSDL_USE_OBJECTSPACE)
#  include <ospace\std\iostream>
#elif defined(GSDL_USE_IOS_H)
#  include <iostream.h>
#else
#  include <iostream>
#endif


class action {
protected:
  cgiargsinfoclass argsinfo;

public:
  action ();
  virtual ~action ();

  // returns the "a" argument value that will specify this action
  // this name should be short but does not have to be one character
  // long
  virtual text_t get_action_name ();

  // response_t is used to inform the calling code what type of
  // cgi header it should produce
  // eventually this should reside in cgiutils.h
  enum response_t {location, content};

  // get_cgihead_info determines the cgi header information for
  // a set of cgi arguments. If response contains location then
  // response_data contains the redirect address. If reponse
  // contains content then reponse_data contains the content-type.
  // Note that images can now be produced by the receptionist.
  virtual void get_cgihead_info (cgiargsclass &args, response_t &response,
                 text_t &response_data, ostream &logout);
  
  // returns false if there was an error which prevented the action
  // from outputing anything.
  virtual bool do_action (cgiargsclass &args, outconvertclass &outconvert, 
              ostream &textout, ostream &logout);

  // configure should be called once for each configuration line
  virtual void configure (const text_tarray &cfgline);

  // getargsinfo should be called after all configuration files
  // have been read
  cgiargsinfoclass getargsinfo () {return argsinfo;};
};


// actionptr is used to keep track of pointers to actions
// sub classes of action might not be the same size so
// you probably don't want to treat a sub class as a standard
// "action" class when it comes to copying etc -- anyone got
// a better way to do this ????
class actionptr {
public:
  action *a;

  actionptr () {a=NULL;}
  ~actionptr () {if (a!=NULL) delete a; a=NULL;}
};

typedef map<text_t, actionptr, lttext_t> actionptrmap;

// contains a list of actions indexed by their name
class actionmapclass {
protected:
  actionptrmap actionptrs;

public:
  // type support for actionptrmap
  typedef actionptrmap::iterator iterator;
  typedef actionptrmap::const_iterator const_iterator;
  typedef actionptrmap::reference reference;
  typedef actionptrmap::const_reference const_reference;
  typedef actionptrmap::size_type size_type;

  typedef actionptrmap::difference_type difference_type;
  typedef actionptrmap::const_reverse_iterator const_reverse_iterator;
  typedef actionptrmap::reverse_iterator reverse_iterator;
  
  // constructors
  actionmapclass ();

  // basic container support
  iterator begin () {return actionptrs.begin();}
  const_iterator begin () const {return actionptrs.begin();}
  iterator end () {return actionptrs.end();}
  const_iterator end () const {return actionptrs.end();}

  void erase(iterator pos) {actionptrs.erase(pos);}
  void erase(iterator first, iterator last) {actionptrs.erase(first, last);}
  actionmapclass &operator=(const actionmapclass &x) {actionptrs=x.actionptrs;return *this;}

  bool empty () const {return actionptrs.empty();}
  size_type size() const {return actionptrs.size();}


  // added functionality
  void clear () {actionptrs.erase(actionptrs.begin(),actionptrs.end());}

  // theaction becomes the property of this class after addaction
  // therefore theaction should always be created using new but
  // not deleted after the call to addaction.
  void addaction (action *theaction);

  // getaction will return NULL if the action could not be found
  action *getaction (const text_t &key);
};


#endif