File: ProtClas.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 (296 lines) | stat: -rwxr-xr-x 7,853 bytes parent folder | download
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/*---------------------------------------------------------------------------*\

    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 _PROTCLAS_H_
#define _PROTCLAS_H_

#include "Protect.h"

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

#define UNIQUE_INIT_VALUE       0

typedef tBool (*tProtectUniqueFunc) (void *);

class CProtectUniqueClass {
public:
    CProtectUniqueClass (void) : m_Counter (UNIQUE_INIT_VALUE) {}
    virtual tBool SynchronFunc (void) = 0;

private:
    tUInt m_Counter;

    friend class CProtectClass;
    friend void basicUniqueCall (CProtectUniqueClass *pPUC);
};


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

inline tBool basicTestAndSet (tUInt *pVar, tUInt testVal, tUInt setVal) {
    if (*pVar != testVal) {
        return vFalse;
    }
    *pVar = setVal;
    return vTrue;
}

inline tUInt basicInc (tUInt *pVar) {
    tUInt fret = *pVar;
    (*pVar)++;
    return fret;
}

inline tUInt basicDec (tUInt *pVar) {
    tUInt fret = *pVar;
    (*pVar)--;
    return fret;
}

inline tBool basicUniqueStart (tUInt *pCounter) {
    return ((*pCounter)++) == UNIQUE_INIT_VALUE;
}

inline tBool basicUniqueStop (tUInt *pCounter) {
    return ((*pCounter)--) == UNIQUE_INIT_VALUE + 1;
}

inline void basicUniqueClear (tUInt *pCounter) {
    *pCounter = UNIQUE_INIT_VALUE;
}

inline void basicUniqueCall (tUInt *pCounter, tProtectUniqueFunc Func, void *Handle) {
    if (basicUniqueStart (pCounter)) {
        do {
            if (Func (Handle) == vFalse) {
                basicUniqueClear (pCounter);
                return;
            }
        } while (basicUniqueStop (pCounter) == vFalse);
    }
}

inline void basicUniqueCall (CProtectUniqueClass *pPUC) {
    if (basicUniqueStart (&pPUC->m_Counter)) {
        do {
            if (pPUC->SynchronFunc() == vFalse) {
                basicUniqueClear (&pPUC->m_Counter);
                return;
            }
        } while (basicUniqueStop (&pPUC->m_Counter) == vFalse);
    }
}


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

class CProtectClass {
public:
    CProtectClass (void);
    virtual ~CProtectClass (void);
    tBool Init (void);          // Init can be called multiple times!!
    tBool IsInitialized (void); // Mainly for debuging purpose

    void BeginRead (void);
    void EndRead (void);
    void BeginWrite (void);
    void EndWrite (void);

    // Set, Add, Sub, Inc & Dec return always the old/previous value of pVar!!
    tUInt Get (tUInt *pVar);
    tBool Get (tBool *pVar);
    tUInt Set (tUInt *pVar, tUInt value);
    tBool Set (tBool *pVar, tBool value);
    tBool TestAndSet (tUInt *pVar, tUInt testVal, tUInt setVal);

    tUInt Add (tUInt *pVar, tUInt value);
    tUInt Sub (tUInt *pVar, tUInt value);

    tUInt Inc (tUInt *pVar);
    tUInt Dec (tUInt *pVar);

    tBool UniqueStart (tUInt *pCounter);
    tBool UniqueStop (tUInt *pCounter);
    void  UniqueClear (tUInt *pCounter);
    void  UniqueCall (tUInt *pCounter, tProtectUniqueFunc Func, void *Handle);
    void  UniqueCall (CProtectUniqueClass *pPUC);

private:
    Protect_Define (m_hProtect);
};


/*===========================================================================*\
    CProtectClass - inline functions
\*===========================================================================*/

inline CProtectClass::CProtectClass (void) {
    Protect_InitHandle (&m_hProtect);
    (void)Protect_Create (&m_hProtect);
}

inline CProtectClass::~CProtectClass (void) {
    Protect_Destroy (&m_hProtect);
}

inline tBool CProtectClass::Init (void) {
    return Protect_IsCreated (m_hProtect) ? vTrue : Protect_Create (&m_hProtect);
}

inline tBool CProtectClass::IsInitialized (void) {
    return Protect_IsCreated (m_hProtect) ? vTrue : vFalse;
}

inline void CProtectClass::BeginRead (void) {
    Protect_BeginRead (m_hProtect);
}

inline void CProtectClass::EndRead (void) {
    Protect_EndRead (m_hProtect);
}

inline void CProtectClass::BeginWrite (void) {
    Protect_BeginWrite (m_hProtect);
}

inline void CProtectClass::EndWrite (void) {
    Protect_EndWrite (m_hProtect);
}


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

inline tUInt CProtectClass::Get (tUInt *pVar) {
    BeginRead();
    tUInt fret = *pVar;
    EndRead();
    return fret;
}

inline tBool CProtectClass::Get (tBool *pVar) {
    BeginRead();
    tBool fret = *pVar;
    EndRead();
    return fret;
}

inline tUInt CProtectClass::Set (tUInt *pVar, tUInt value) {
    BeginWrite();
    tUInt fret = *pVar;
    *pVar  = value;
    EndWrite();
    return fret;
}

inline tBool CProtectClass::Set (tBool *pVar, tBool value) {
    BeginWrite();
    tBool fret = *pVar;
    *pVar  = value;
    EndWrite();
    return fret;
}

inline tBool CProtectClass::TestAndSet (tUInt *pVar, tUInt testVal, tUInt setVal) {
    tBool fret = vFalse;
    BeginWrite();
    if (*pVar == testVal) {
        *pVar = setVal;
        fret  = vTrue;
    }
    EndWrite();
    return fret;
}

inline tUInt CProtectClass::Add (tUInt *pVar, tUInt value) {
    BeginWrite();
    tUInt fret = *pVar;
    *pVar += value;
    EndWrite();
    return fret;
}

inline tUInt CProtectClass::Sub (tUInt *pVar, tUInt value) {
    BeginWrite();
    tUInt fret = *pVar;
    *pVar -= value;
    EndWrite();
    return fret;
}

inline tUInt CProtectClass::Inc (tUInt *pVar) {
    BeginWrite();
    tUInt fret = *pVar;
    (*pVar)++;
    EndWrite();
    return fret;
}

inline tUInt CProtectClass::Dec (tUInt *pVar) {
    BeginWrite();
    tUInt fret = *pVar;
    (*pVar)--;
    EndWrite();
    return fret;
}

inline tBool CProtectClass::UniqueStart (tUInt *pCounter) {
    return Inc (pCounter) == UNIQUE_INIT_VALUE;
}

inline tBool CProtectClass::UniqueStop (tUInt *pCounter) {
    return Dec (pCounter) == UNIQUE_INIT_VALUE + 1;
}

inline void CProtectClass::UniqueClear (tUInt *pCounter) {
    Set (pCounter, UNIQUE_INIT_VALUE);
}

inline void CProtectClass::UniqueCall (tUInt *pCounter, tProtectUniqueFunc Func, void *Handle) {
    if (UniqueStart (pCounter)) {
        do {
            if (Func (Handle) == vFalse) {
                UniqueClear (pCounter);
                return;
            }
        } while (UniqueStop (pCounter) == vFalse);
    }
}

inline void CProtectClass::UniqueCall (CProtectUniqueClass *pPUC) {
    if (UniqueStart (&pPUC->m_Counter)) {
        do {
            if (pPUC->SynchronFunc() == vFalse) {
                UniqueClear (&pPUC->m_Counter);
                return;
            }
        } while (UniqueStop (&pPUC->m_Counter) == vFalse);
    }
}


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

#endif