infoton.h

Go to the documentation of this file.

#ifndef INFOTON_CLASS
#define INFOTON_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : infoton                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*******************************************************************************
* Copyright (c) 2002-$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/contracts.h>
#include <structures/string_array.h>

namespace octopi {


class infoton
: public virtual basis::packable,
  public virtual basis::clonable,
  public virtual basis::text_formable
{
public:
  infoton(const structures::string_array &classifier);

  // takes care of the most common cases of 1, 2 & 3 level classifiers.
  infoton(const basis::astring &class_1);
  infoton(const basis::astring &class_1, const basis::astring &class_2);
  infoton(const basis::astring &class_1, const basis::astring &class_2, const basis::astring &cl_3);

  infoton(const infoton &to_copy);

  virtual ~infoton();

  DEFINE_CLASS_NAME("infoton");

  infoton &operator =(const infoton &to_copy);

  const structures::string_array &classifier() const;

  void set_classifier(const structures::string_array &new_classifier);

  // these are also dangerous if you're not careful; they mimic the
  // string constructors.
  void set_classifier(const basis::astring &class_1);
  void set_classifier(const basis::astring &class_1, const basis::astring &class_2);
  void set_classifier(const basis::astring &class_1, const basis::astring &class_2,
          const basis::astring &cl_3);

  bool check_classifier(const basis::astring &class_name, const basis::astring &caller);

  virtual void pack(basis::byte_array &packed_form) const = 0;

  virtual bool unpack(basis::byte_array &packed_form) = 0;

  virtual void text_form(basis::base_string &state_fill) const = 0;

  virtual clonable *clone() const = 0;

  virtual int packed_size() const = 0;


  virtual basis::astring text_form() const { basis::astring fill; text_form(fill); return fill; }


  // This defines the wire format for a flattened infoton.  It is in essence
  // a packet header format which all infotons must adhere to to ensure that
  // they can be successfully unflattened when appropriate item managers are
  // available.
  static void fast_pack(basis::byte_array &packed_form, const infoton &to_pack);

  static bool fast_unpack(basis::byte_array &packed_form, structures::string_array &classifier,
          basis::byte_array &info);

  static bool test_fast_unpack(const basis::byte_array &packed_form,
          int &packed_length);

  static int fast_pack_overhead(const structures::string_array &classifier);

private:
  structures::string_array *_classifier;  
};



template <class contents>
basis::clonable *cloner(const contents &this_obj) { return new contents(this_obj); }

} //namespace.

#endif