amorph.h

Go to the documentation of this file.

#ifndef AMORPH_CLASS
#define AMORPH_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : amorph                                                            *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 1989-$now By Author.  This program is free software; 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.  This is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include <basis/array.h>


template <class contents>
class amorph : private array<contents *>
{
public:
  amorph(int elements = 0);

  ~amorph();

  inline int elements() const { return this->length(); }

  inline int valid_fields() const { return _fields_used; }

  void adjust(int new_max);

  void reset(int new_maximum = 0);

  outcome put(int field, const contents *data);

  outcome append(const contents *data);

  inline outcome operator += (const contents *data) { return append(data); }


  const contents *get(int field) const;

  contents *borrow(int field);

  inline const contents *operator [] (int field) const { return get(field); }
  inline contents *operator [] (int field) { return borrow(field); }

  contents *acquire(int field);

  outcome clear(int field);

  void clear_all();

  outcome zap(int start, int end);

  outcome insert(int position, int lines_to_add);

  int find_empty(outcome &outcome) const;

  const contents *next_valid(int &field) const;

  int find(const contents *to_locate, outcome &outcome);

  void swap_contents(amorph<contents> &other);

private:
  int _fields_used;  

  void check_fields(const char *where) const;

  void set_nil(int start, int end);
    // Puts NIL in the indices between start and end.
  // not to be used: amorphs should not be copied because it is intended that
  // they support storing heavyweight objects that either have no copy
  // constructors or have high-cost copy constructors.
  inline amorph(const amorph &to_copy) {}  
  inline amorph &operator = (const amorph &to_copy) { return *this; }
};


// these extensions are phrased as macros to avoid including the headers
// necessary for compiling them.  to use them, just put the macro name in
// the file where the template is needed.



template <class contents>
void amorph_assign(amorph<contents> &to_assign,
    const amorph<contents> &to_copy);



template <class contents>
void amorph_pack(byte_array &packed_form, const amorph<contents> &to_pack);

template <class contents>
bool amorph_unpack(byte_array &packed_form, amorph<contents> &to_unpack);

#endif

---