File: StdArray.h

package info (click to toggle)
capi4hylafax 1%3A01.02.03-10sarge2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 2,856 kB
  • ctags: 2,966
  • sloc: cpp: 20,126; sh: 7,703; makefile: 215; perl: 36
file content (164 lines) | stat: -rw-r--r-- 6,124 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
/*---------------------------------------------------------------------------*\

    Copyright (C) 2000 AVM GmbH. All rights reserved.

    This program is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    as published by the Free Software Foundation; either version 2
    of the License, or (at your option) any later version.

    This program 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, and WITHOUT
    ANY LIABILITY FOR ANY DAMAGES arising out of or in connection
    with the use or performance of this software. See the
    GNU General Public License for further details.

\*---------------------------------------------------------------------------*/

#ifndef _STDARRAY_H_
#define _STDARRAY_H_

#include "aTypes.h"
#include "Protect.h"

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

typedef tResult (*tArrayCompFunc) (const void *data, const void *ItemFrag);

/*===========================================================================*\
\*===========================================================================*/

class CStandardArray {
public:
    CStandardArray (tUInt MaxCountOfItems, tUInt SizeOfItem);
    virtual ~CStandardArray (void);

    // return: 0 = error, 1 == success but no dataOut, 2 == success and dataOut valid
    tUInt Set (tUInt pos, void *dataIn, void *dataOut = 0);
    tUInt SetEmpty (void *dataIn, tUInt *pPos = 0);         // Set an item in an empty place

    virtual tBool AppendEmpty (tUInt *pPos = 0);            // Append an empty item
    virtual tBool Append (void *dataIn, tUInt *pPos = 0);
    virtual tBool Ins (tUInt pos, void *dataIn);

    tBool Get (tUInt pos, void *dataOut);
    const void *Get_Direct (tUInt pos);
    tBool GetNext (void *dataOut, tUInt *FindPos = 0, tUInt StartPos = 0);
    const void *GetNext_Direct (tUInt *FindPos = 0, tUInt StartPos = 0);

    // del removes the item from the array, all greater items will be shift one pos lower
    // for return value see above
    tUInt Del (tUInt pos, void *dataOut = 0);
    tUInt DelLast (void *dataOut = 0);
    void DelAll (void);

    // clear makes the item invalid, but the pos still exists
    // for return value see above
    tUInt Clear (tUInt pos, void *dataOut = 0);
    tUInt ClearLast (void *dataOut = 0);
    void ClearAll (void);

    tResult Find (tArrayCompFunc CompFunc, void *ItemFrag, void *dataOut = 0, tUInt *FindPos = 0, tUInt StartPos = 0);
    void *Find_Direct (tArrayCompFunc CompFunc, void *ItemFrag, tUInt StartPos = 0);  // Return: CompFunc == vYes

    tBool IsItemEmpty (tUInt pos);
    tBool IsArrayEmpty (void);
    tBool IsArrayFull (void);
    tBool ExistUsedItems (void);
    tBool ExistEmptyItems (void);
    tUInt CountUsedItems (void);
    tUInt CountEmptyItems (void);
    tUInt CountAllItems (void);
    tUInt MaxCountItems (void);
    tUInt ItemSize (void);

    tBool Resize (tUInt newMaxItemCount);

private:
    Protect_Define (hProtect);
    tUChar *Array;
    tUChar *ArrayEmpty;
    tUInt   count;
    tUInt   emptyCount;
    tUInt   maxCount;
    tUInt   sizeCopy;       // size of the item == size needed to copy
    tUInt   sizeItem;       // real used, alligned size
};

/*===========================================================================*\
\*===========================================================================*/

inline tBool CStandardArray::IsItemEmpty (tUInt pos) {
    return (tBool)(ArrayEmpty[pos] == 1);
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tBool CStandardArray::IsArrayEmpty (void) {
    return (count) ? vFalse : vTrue;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tBool CStandardArray::IsArrayFull (void) {
    return (count == maxCount) ? vTrue : vFalse;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tBool CStandardArray::ExistUsedItems (void) {
    return (count > emptyCount) ? vTrue : vFalse;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tBool CStandardArray::ExistEmptyItems (void) {
    return (emptyCount) ? vTrue : vFalse;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tUInt CStandardArray::CountUsedItems (void) {
    return count - emptyCount;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tUInt CStandardArray::CountEmptyItems (void) {
    return emptyCount;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tUInt CStandardArray::CountAllItems (void) {
    return count;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tUInt CStandardArray::MaxCountItems (void) {
    return maxCount;
}

/*---------------------------------------------------------------------------*\
\*---------------------------------------------------------------------------*/

inline tUInt CStandardArray::ItemSize (void) {
    return sizeItem - 1;
}


/*===========================================================================*\
\*===========================================================================*/

#endif