RexxEnvelope.hpp

Go to the documentation of this file.

/*----------------------------------------------------------------------------*/
/*                                                                            */
/* Copyright (c) 1995, 2004 IBM Corporation. All rights reserved.             */
/* Copyright (c) 2005-2009 Rexx Language Association. All rights reserved.    */
/*                                                                            */
/* This program and the accompanying materials are made available under       */
/* the terms of the Common Public License v1.0 which accompanies this         */
/* distribution. A copy is also available at the following address:           */
/* http://www.oorexx.org/license.html                          */
/*                                                                            */
/* Redistribution and use in source and binary forms, with or                 */
/* without modification, are permitted provided that the following            */
/* conditions are met:                                                        */
/*                                                                            */
/* Redistributions of source code must retain the above copyright             */
/* notice, this list of conditions and the following disclaimer.              */
/* Redistributions in binary form must reproduce the above copyright          */
/* notice, this list of conditions and the following disclaimer in            */
/* the documentation and/or other materials provided with the distribution.   */
/*                                                                            */
/* Neither the name of Rexx Language Association nor the names                */
/* of its contributors may be used to endorse or promote products             */
/* derived from this software without specific prior written permission.      */
/*                                                                            */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS        */
/* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT          */
/* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS          */
/* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT   */
/* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,      */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED   */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,        */
/* OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY     */
/* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING    */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS         */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.               */
/*                                                                            */
/*----------------------------------------------------------------------------*/
/******************************************************************************/
/* REXX Kernel                                             RexxEnvelope.hpp   */
/*                                                                            */
/* Primitive Envelope Class Definitions                                       */
/*                                                                            */
/******************************************************************************/
#ifndef Included_RexxEnvelope
#define Included_RexxEnvelope
 
class RexxSmartBuffer;
class RexxBuffer;
 
// default size of the buffer used for flatten operations
#define DEFAULT_ENVELOPE_BUFFER (64*1024)
 
class RexxEnvelope : public RexxInternalObject
{
  public:
   void *operator new(size_t);
   inline void *operator new(size_t size, void *ptr) {return ptr;}
   RexxEnvelope();
   inline RexxEnvelope(RESTORETYPE restoreType) { ; };
   void live(size_t);
   void liveGeneral(int reason);
 
   void flattenReference(void *, size_t, void *);
   RexxBuffer *pack(RexxObject *);
   void        puff(RexxBuffer *, char *, size_t length);
   size_t queryObj(RexxObject *);
   size_t copyBuffer(RexxObject *);
   void rehash();
   char  *bufferStart();
   void   associateObject(RexxObject *, size_t);
   void   addTable(RexxObject *obj);
 
   inline RexxSmartBuffer *getBuffer() {return this->buffer;}
   inline RexxObject *getReceiver() {return this->receiver;}
   inline size_t      getCurrentOffset() { return this->currentOffset; }
   inline RexxIdentityTable *getDuptable() {return this->duptable;}
   inline RexxIdentityTable *getRehashtable() {return this->rehashtable;}
 
   size_t      currentOffset;          /* current flattening offset         */
 
protected:
   RexxObject *home;
   RexxObject *receiver;               /* object to receive the message     */
   RexxIdentityTable  *duptable;         /* table of duplicates               */
   RexxIdentityTable  *savetable;        /* table of protected objects created during flattening */
   RexxSmartBuffer *buffer;            /* smart buffer wrapper              */
   RexxIdentityTable  *rehashtable;      /* table to rehash                   */
   RexxStack  *flattenStack;           /* the flattening stack              */
};
#endif