Wed, 25 Apr 2012 14:50:19 +0000
changeset 10313 008b1ff2736b6eb1af210a57c0bb84c2a58e8547
parent 9173 fe9f52c5fc599eaa1cd2514120abbcc02e48f18e
permissions -rw-r--r--
Bug 716563 - update license to MPL 2. r=rrelyea.

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at */

#ifndef NSSBASET_H
#define NSSBASET_H

#ifdef DEBUG
static const char NSSBASET_CVS_ID[] = "@(#) $RCSfile$ $Revision$ $Date$";
#endif /* DEBUG */

 * nssbaset.h
 * This file contains the most low-level, fundamental public types.

#include "nspr.h"
#include "nssilock.h"

 * NSS has its own versions of these NSPR macros, in a form which
 * does not confuse ctags and other related utilities.  NSPR 
 * defines these macros to take the type as an argument, because
 * of certain OS requirements on platforms not supported by NSS.

#define DUMMY	/* dummy */
#define NSS_EXTERN         extern
#define NSS_EXTERN_DATA    extern
#define NSS_IMPLEMENT      


 * NSSError
 * Calls to NSS routines may result in one or more errors being placed
 * on the calling thread's "error stack."  Every possible error that
 * may be returned from a function is declared where the function is 
 * prototyped.  All errors are of the following type.

typedef PRInt32 NSSError;

 * NSSArena
 * Arenas are logical sets of heap memory, from which memory may be
 * allocated.  When an arena is destroyed, all memory allocated within
 * that arena is implicitly freed.  These arenas are thread-safe: 
 * an arena pointer may be used by multiple threads simultaneously.
 * However, as they are not backed by shared memory, they may only be
 * used within one process.

struct NSSArenaStr;
typedef struct NSSArenaStr NSSArena;

 * NSSItem
 * This is the basic type used to refer to an unconstrained datum of
 * arbitrary size.

struct NSSItemStr {
  void *data;
  PRUint32 size;
typedef struct NSSItemStr NSSItem;

 * Data packed according to the Basic Encoding Rules of ASN.1.

typedef NSSItem NSSBER;

 * Data packed according to the Distinguished Encoding Rules of ASN.1;
 * this form is also known as the Canonical Encoding Rules form (CER).


 * NSSBitString
 * Some ASN.1 types use "bit strings," which are passed around as
 * octet strings but whose length is counted in bits.  We use this
 * typedef of NSSItem to point out the occasions when the length
 * is counted in bits, not octets.

typedef NSSItem NSSBitString;

 * Character strings encoded in UTF-8, as defined by RFC 2279.

typedef char NSSUTF8;

 * Character strings guaranteed to be 7-bit ASCII.

typedef char NSSASCII7;


#endif /* NSSBASET_H */