/*
 * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
 * 
 * The contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License. Please obtain
 * a copy of the License at http://www.apple.com/publicsource and read it before
 * using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
 * specific language governing rights and limitations under the License.
 */


// file: .../c++-lib/inc/asn-octs.h - ASN.1 OCTET STRING type
//
//  Mike Sample
//  92/07/02
// Copyright (C) 1992 Michael Sample and the University of British Columbia
//
// This library is free software; you can redistribute it and/or
// modify it provided that this copyright/license information is retained
// in original form.
//
// If you modify this file, you must clearly indicate your changes.
//
// This source code is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
//
//
// ------------------------------------------------------------------------
// -  J.G. Van Dyke & Associates, Inc. Modification History of SNACC 1.3  -
// ------------------------------------------------------------------------
// 
// All modification are relative to the v1.3 of SNACC.  We used SunOS 4.1.3's 
// SCCS.  The revision #'s start at 1.1,  which is the original version from 
// SNACC 1.3.
// 
// 
// ../SCCS/s.asn-octs.h:
// 
// D 1.3	98/04/24 22:46:51 pleonber	3 2	00002/00000/00129
// added INSERT_VDA_COMMENTS for script that adds SCCS history to file
// 
// D 1.2	97/11/11 15:53:59 dharris	2 1	00004/00000/00125
// changed == operator overide to remove warning
// 
// D 1.1	97/11/11 15:50:52 cmmaster	1 0	00125/00000/00000
// date and time created 97/11/11 15:50:52 by cmmaster
// 
// ----------------------- End of VDA Modifications ---------------------------
// 
// 
// 
// $Header: /cvs/Darwin/src/live/Security/SecuritySNACCRuntime/c++-lib/inc/asn-octs.h,v 1.2 2002/04/18 18:58:08 dmitch Exp $
// $Log: asn-octs.h,v $
// Revision 1.2  2002/04/18 18:58:08  dmitch
// Radar 2904404 - avoid deprecated iostream.h
//
// Revision 1.1.1.1.70.1  2002/04/17 00:48:53  dmitch
// Radar 2904404 - avoid deprecated iostream.h.
//
// Revision 1.1.1.1  2001/05/18 23:14:06  mb
// Move from private repository to open source repository
//
// Revision 1.3  2001/05/05 00:59:18  rmurphy
// Adding darwin license headers
//
// Revision 1.2  2000/06/15 18:48:24  dmitch
// Snacc-generated source files, now part of CVS tree to allow for cross-platform build of snaccRuntime.
//
// Revision 1.1.1.1  2000/03/09 01:00:05  rmurphy
// Base Fortissimo Tree
//
// Revision 1.3  1999/03/21 02:07:33  mb
// Added Copy to every AsnType.
//
// Revision 1.2  1999/03/18 22:35:27  mb
// Made all destructors virtual.
//
// Revision 1.1  1999/02/25 05:21:44  mb
// Added snacc c++ library
//
// Revision 1.5  1997/02/16 20:25:40  rj
// check-in of a few cosmetic changes
//
// Revision 1.4  1995/07/24  17:46:52  rj
// operator == and != return bool instead of int.
//
// #if TCL ... #endif wrapped into #if META ... #endif
//
// changed `_' to `-' in file names.
//
// Revision 1.3  1994/10/08  04:18:07  rj
// code for meta structures added (provides information about the generated code itself).
//
// code for Tcl interface added (makes use of the above mentioned meta code).
//
// virtual inline functions (the destructor, the Clone() function, BEnc(), BDec() and Print()) moved from inc/*.h to src/*.C because g++ turns every one of them into a static non-inline function in every file where the .h file gets included.
//
// made Print() const (and some other, mainly comparison functions).
//
// several `unsigned long int' turned into `size_t'.
//
// Revision 1.2  1994/08/28  10:00:53  rj
// comment leader fixed.
//
// Revision 1.1  1994/08/28  09:20:39  rj
// first check-in. for a list of changes to the snacc-1.1 distribution please refer to the ChangeLog.

#ifndef _asn_octs_h_
#define _asn_octs_h_

#include <string.h>

class AsnOcts: public AsnType
{
private:
  int				OctsEquiv (const AsnOcts &o) const;

  void				FillBitStringStk (BUF_TYPE b, AsnLen elmtLen0, AsnLen& bytesDecoded, ENV_TYPE env);

  void				BDecConsOcts (BUF_TYPE b, AsnLen elmtLen, AsnLen &bytesDecoded, ENV_TYPE env);

protected:
  size_t			octetLen;
  char				*octs;

public:

  // constructor and Set alway copy strings so destructor can always delete
				AsnOcts():
				  octetLen (0),
				  octs (NULL)
				{}
				AsnOcts (const char *str)		{ Set (str); }
				AsnOcts (const char *str, const size_t len)
									{ Set (str, len); }
				AsnOcts (const AsnOcts &o)		{ Set (o); }
#ifndef _IBM_ENC_
  virtual		~AsnOcts();
#else
  virtual		~AsnOcts()				{ mem_mgr_ptr->Put ((void *)octs); }	// Guido Grassel, 11.8.93
#endif /* _IBM_ENC_ */

  virtual AsnType	*Clone() const;
  virtual AsnType	*Copy() const;

  AsnOcts			&operator = (const AsnOcts &o)		{ ReSet (o); return *this; }
  AsnOcts			&operator = (const char *str)		{ ReSet (str); return *this; }

  // these set the octs and octetLen values
  void				Set (const char *str, size_t len);
  void				Set (const AsnOcts &o);
  void				Set (const char *str);

  // these free the old octs value and
  // then reset the octs and octetLen values
  void				ReSet (const char *str, size_t len);
  void				ReSet (const AsnOcts &o);
  void				ReSet (const char *str);

  size_t			Len() const				{ return octetLen; }
				operator const char* () const		{ return octs; }
				operator char* ()			{ return octs; }
				
  const char *		Octs() const	{ return octs; }

#ifdef VDADER_RULES
  bool operator == (const AsnOcts &o) const { if (OctsEquiv(o)) return true; else return false; }
#else
  bool				operator == (const AsnOcts &o) const	{ return OctsEquiv (o); }
#endif
  bool				operator != (const AsnOcts &o) const	{ return !OctsEquiv (o); }

  AsnLen			BEncContent (BUF_TYPE b);
  void				BDecContent (BUF_TYPE b, AsnTag tagId, AsnLen elmtLen, AsnLen &bytesDecoded, ENV_TYPE env);
  AsnLen			BEnc (BUF_TYPE b);
  void				BDec (BUF_TYPE b, AsnLen &bytesDecoded, ENV_TYPE env);

  PDU_MEMBER_MACROS

  void				Print (ostream &os) const;

#if META
  static const AsnOctsTypeDesc	_desc;

  const AsnTypeDesc		*_getdesc() const;

#if TCL
  int				TclGetVal (Tcl_Interp *) const;
  int				TclSetVal (Tcl_Interp *, const char *val);
#endif /* TCL */
#endif /* META */
};

#endif /* conditional include */
