PageRenderTime 213ms CodeModel.GetById 100ms app.highlight 5ms RepoModel.GetById 56ms app.codeStats 0ms

/gecko_api/include/secitem.h

http://firefox-mac-pdf.googlecode.com/
C++ Header | 128 lines | 23 code | 19 blank | 86 comment | 0 complexity | 3c963443cd5aec179d265d8f9851cd50 MD5 | raw file
  1/* ***** BEGIN LICENSE BLOCK *****
  2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3 *
  4 * The contents of this file are subject to the Mozilla Public License Version
  5 * 1.1 (the "License"); you may not use this file except in compliance with
  6 * the License. You may obtain a copy of the License at
  7 * http://www.mozilla.org/MPL/
  8 *
  9 * Software distributed under the License is distributed on an "AS IS" basis,
 10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 11 * for the specific language governing rights and limitations under the
 12 * License.
 13 *
 14 * The Original Code is the Netscape security libraries.
 15 *
 16 * The Initial Developer of the Original Code is
 17 * Netscape Communications Corporation.
 18 * Portions created by the Initial Developer are Copyright (C) 1994-2000
 19 * the Initial Developer. All Rights Reserved.
 20 *
 21 * Contributor(s):
 22 *
 23 * Alternatively, the contents of this file may be used under the terms of
 24 * either the GNU General Public License Version 2 or later (the "GPL"), or
 25 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 26 * in which case the provisions of the GPL or the LGPL are applicable instead
 27 * of those above. If you wish to allow use of your version of this file only
 28 * under the terms of either the GPL or the LGPL, and not to allow others to
 29 * use your version of this file under the terms of the MPL, indicate your
 30 * decision by deleting the provisions above and replace them with the notice
 31 * and other provisions required by the GPL or the LGPL. If you do not delete
 32 * the provisions above, a recipient may use your version of this file under
 33 * the terms of any one of the MPL, the GPL or the LGPL.
 34 *
 35 * ***** END LICENSE BLOCK ***** */
 36
 37#ifndef _SECITEM_H_
 38#define _SECITEM_H_
 39
 40#include "utilrename.h"
 41
 42/*
 43 * secitem.h - public data structures and prototypes for handling
 44 *	       SECItems
 45 *
 46 * $Id: secitem.h,v 1.7 2007/10/12 01:44:51 julien.pierre.boogz%sun.com Exp $
 47 */
 48
 49#include "plarena.h"
 50#include "plhash.h"
 51#include "seccomon.h"
 52
 53SEC_BEGIN_PROTOS
 54
 55/*
 56** Allocate an item.  If "arena" is not NULL, then allocate from there,
 57** otherwise allocate from the heap.  If "item" is not NULL, allocate
 58** only the data buffer for the item, not the item itself.  If "len" is
 59** 0, do not allocate the data buffer for the item; simply set the data
 60** field to NULL and the len field to 0.  The item structure is allocated
 61** zero-filled; the data buffer is not zeroed.  The caller is responsible
 62** for initializing the type field of the item.
 63**
 64** The resulting item is returned; NULL if any error occurs.
 65**
 66** XXX This probably should take a SECItemType, but since that is mostly
 67** unused and our improved APIs (aka Stan) are looming, I left it out.
 68*/
 69extern SECItem *SECITEM_AllocItem(PRArenaPool *arena, SECItem *item,
 70				  unsigned int len);
 71
 72/*
 73** Reallocate the data for the specified "item".  If "arena" is not NULL,
 74** then reallocate from there, otherwise reallocate from the heap.
 75** In the case where oldlen is 0, the data is allocated (not reallocated).
 76** In any case, "item" is expected to be a valid SECItem pointer;
 77** SECFailure is returned if it is not.  If the allocation succeeds,
 78** SECSuccess is returned.
 79*/
 80extern SECStatus SECITEM_ReallocItem(PRArenaPool *arena, SECItem *item,
 81				     unsigned int oldlen, unsigned int newlen);
 82
 83/*
 84** Compare two items returning the difference between them.
 85*/
 86extern SECComparison SECITEM_CompareItem(const SECItem *a, const SECItem *b);
 87
 88/*
 89** Compare two items -- if they are the same, return true; otherwise false.
 90*/
 91extern PRBool SECITEM_ItemsAreEqual(const SECItem *a, const SECItem *b);
 92
 93/*
 94** Copy "from" to "to"
 95*/
 96extern SECStatus SECITEM_CopyItem(PRArenaPool *arena, SECItem *to, 
 97                                  const SECItem *from);
 98
 99/*
100** Allocate an item and copy "from" into it.
101*/
102extern SECItem *SECITEM_DupItem(const SECItem *from);
103
104/*
105** Allocate an item and copy "from" into it.  The item itself and the 
106** data it points to are both allocated from the arena.  If arena is
107** NULL, this function is equivalent to SECITEM_DupItem.
108*/
109extern SECItem *SECITEM_ArenaDupItem(PRArenaPool *arena, const SECItem *from);
110
111/*
112** Free "zap". If freeit is PR_TRUE then "zap" itself is freed.
113*/
114extern void SECITEM_FreeItem(SECItem *zap, PRBool freeit);
115
116/*
117** Zero and then free "zap". If freeit is PR_TRUE then "zap" itself is freed.
118*/
119extern void SECITEM_ZfreeItem(SECItem *zap, PRBool freeit);
120
121PLHashNumber PR_CALLBACK SECITEM_Hash ( const void *key);
122
123PRIntn PR_CALLBACK SECITEM_HashCompare ( const void *k1, const void *k2);
124
125
126SEC_END_PROTOS
127
128#endif /* _SECITEM_H_ */