1
/* ***** BEGIN LICENSE BLOCK *****
2
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
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/
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
14
* The Original Code is the Netscape security libraries.
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.
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.
35
* ***** END LICENSE BLOCK ***** */
40
* secitem.h - public data structures and prototypes for handling
43
* $Id: secitem.h,v 1.4.28.1 2006/04/24 23:48:05 wtchang%redhat.com Exp $
53
** Allocate an item. If "arena" is not NULL, then allocate from there,
54
** otherwise allocate from the heap. If "item" is not NULL, allocate
55
** only the data for the item, not the item itself. The item structure
56
** is allocated zero-filled; the data buffer is not zeroed. The caller
57
** is responsible for initializing the type field of the item.
59
** The resulting item is returned; NULL if any error occurs.
61
** XXX This probably should take a SECItemType, but since that is mostly
62
** unused and our improved APIs (aka Stan) are looming, I left it out.
64
extern SECItem *SECITEM_AllocItem(PRArenaPool *arena, SECItem *item,
68
** Reallocate the data for the specified "item". If "arena" is not NULL,
69
** then reallocate from there, otherwise reallocate from the heap.
70
** In the case where oldlen is 0, the data is allocated (not reallocated).
71
** In any case, "item" is expected to be a valid SECItem pointer;
72
** SECFailure is returned if it is not. If the allocation succeeds,
73
** SECSuccess is returned.
75
extern SECStatus SECITEM_ReallocItem(PRArenaPool *arena, SECItem *item,
76
unsigned int oldlen, unsigned int newlen);
79
** Compare two items returning the difference between them.
81
extern SECComparison SECITEM_CompareItem(const SECItem *a, const SECItem *b);
84
** Compare two items -- if they are the same, return true; otherwise false.
86
extern PRBool SECITEM_ItemsAreEqual(const SECItem *a, const SECItem *b);
89
** Copy "from" to "to"
91
extern SECStatus SECITEM_CopyItem(PRArenaPool *arena, SECItem *to,
95
** Allocate an item and copy "from" into it.
97
extern SECItem *SECITEM_DupItem(const SECItem *from);
100
** Allocate an item and copy "from" into it. The item itself and the
101
** data it points to are both allocated from the arena. If arena is
102
** NULL, this function is equivalent to SECITEM_DupItem.
104
extern SECItem *SECITEM_ArenaDupItem(PRArenaPool *arena, const SECItem *from);
107
** Free "zap". If freeit is PR_TRUE then "zap" itself is freed.
109
extern void SECITEM_FreeItem(SECItem *zap, PRBool freeit);
112
** Zero and then free "zap". If freeit is PR_TRUE then "zap" itself is freed.
114
extern void SECITEM_ZfreeItem(SECItem *zap, PRBool freeit);
116
PLHashNumber PR_CALLBACK SECITEM_Hash ( const void *key);
118
PRIntn PR_CALLBACK SECITEM_HashCompare ( const void *k1, const void *k2);
123
#endif /* _SECITEM_H_ */