098617b25754e49d0c9c07b96e9afdf691622207
[platform/upstream/freetype2.git] / src / psaux / psarrst.h
1 /****************************************************************************
2  *
3  * psarrst.h
4  *
5  *   Adobe's code for Array Stacks (specification).
6  *
7  * Copyright 2007-2013 Adobe Systems Incorporated.
8  *
9  * This software, and all works of authorship, whether in source or
10  * object code form as indicated by the copyright notice(s) included
11  * herein (collectively, the "Work") is made available, and may only be
12  * used, modified, and distributed under the FreeType Project License,
13  * LICENSE.TXT.  Additionally, subject to the terms and conditions of the
14  * FreeType Project License, each contributor to the Work hereby grants
15  * to any individual or legal entity exercising permissions granted by
16  * the FreeType Project License and this section (hereafter, "You" or
17  * "Your") a perpetual, worldwide, non-exclusive, no-charge,
18  * royalty-free, irrevocable (except as stated in this section) patent
19  * license to make, have made, use, offer to sell, sell, import, and
20  * otherwise transfer the Work, where such license applies only to those
21  * patent claims licensable by such contributor that are necessarily
22  * infringed by their contribution(s) alone or by combination of their
23  * contribution(s) with the Work to which such contribution(s) was
24  * submitted.  If You institute patent litigation against any entity
25  * (including a cross-claim or counterclaim in a lawsuit) alleging that
26  * the Work or a contribution incorporated within the Work constitutes
27  * direct or contributory patent infringement, then any patent licenses
28  * granted to You under this License for that Work shall terminate as of
29  * the date such litigation is filed.
30  *
31  * By using, modifying, or distributing the Work you indicate that you
32  * have read and understood the terms and conditions of the
33  * FreeType Project License as well as those provided in this section,
34  * and you accept them fully.
35  *
36  */
37
38
39 #ifndef PSARRST_H_
40 #define PSARRST_H_
41
42
43 #include "pserror.h"
44
45
46 FT_BEGIN_HEADER
47
48
49   /* need to define the struct here (not opaque) so it can be allocated by */
50   /* clients                                                               */
51   typedef struct  CF2_ArrStackRec_
52   {
53     FT_Memory  memory;
54     FT_Error*  error;
55
56     size_t  sizeItem;       /* bytes per element             */
57     size_t  allocated;      /* items allocated               */
58     size_t  chunk;          /* allocation increment in items */
59     size_t  count;          /* number of elements allocated  */
60     size_t  totalSize;      /* total bytes allocated         */
61
62     void*  ptr;             /* ptr to data                   */
63
64   } CF2_ArrStackRec, *CF2_ArrStack;
65
66
67   FT_LOCAL( void )
68   cf2_arrstack_init( CF2_ArrStack  arrstack,
69                      FT_Memory     memory,
70                      FT_Error*     error,
71                      size_t        sizeItem );
72   FT_LOCAL( void )
73   cf2_arrstack_finalize( CF2_ArrStack  arrstack );
74
75   FT_LOCAL( void )
76   cf2_arrstack_setCount( CF2_ArrStack  arrstack,
77                          size_t        numElements );
78   FT_LOCAL( void )
79   cf2_arrstack_clear( CF2_ArrStack  arrstack );
80   FT_LOCAL( size_t )
81   cf2_arrstack_size( const CF2_ArrStack  arrstack );
82
83   FT_LOCAL( void* )
84   cf2_arrstack_getBuffer( const CF2_ArrStack  arrstack );
85   FT_LOCAL( void* )
86   cf2_arrstack_getPointer( const CF2_ArrStack  arrstack,
87                            size_t              idx );
88
89   FT_LOCAL( void )
90   cf2_arrstack_push( CF2_ArrStack  arrstack,
91                      const void*   ptr );
92
93
94 FT_END_HEADER
95
96
97 #endif /* PSARRST_H_ */
98
99
100 /* END */