1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef OHOS_UTILS_MEMORY_LIBPURGEABLEMEM_C_INCLUDE_PURGEABLE_MEM_BUILDER_C_H
17 #define OHOS_UTILS_MEMORY_LIBPURGEABLEMEM_C_INCLUDE_PURGEABLE_MEM_BUILDER_C_H
18 
19 #include <stdbool.h>
20 
21 #ifdef __cplusplus
22 #if __cplusplus
23 extern "C" {
24 #endif /* End of #if __cplusplus */
25 #endif /* End of #ifdef __cplusplus */
26 
27 /* purgeable mem builder */
28 struct PurgMemBuilder;
29 
30 typedef bool (*PurgMemBuilderFunc)(void *, size_t, void *);
31 
32 
33 struct PurgMemBuilder *PurgMemBuilderCreate(PurgMemBuilderFunc func, void *param, const char *name);
34 
35 /* If return true, @builder will be set to NULL to avoid Use-After-Free */
36 bool PurgMemBuilderDestroy(struct PurgMemBuilder *builder);
37 
38 bool PurgMemBuilderAppendFunc(struct PurgMemBuilder *builder, PurgMemBuilderFunc func, void *param,
39                               const char *name);
40 
41 bool PurgMemBuilderAppendBuilder(struct PurgMemBuilder *builder, struct PurgMemBuilder *newcomer);
42 
43 /* build @data content from @builder */
44 bool PurgMemBuilderBuildAll(struct PurgMemBuilder *builder, void *data, size_t size);
45 
46 #ifdef __cplusplus
47 #if __cplusplus
48 }
49 #endif /* End of #if __cplusplus */
50 #endif /* End of #ifdef __cplusplus */
51 
52 #endif /* OHOS_UTILS_MEMORY_LIBPURGEABLEMEM_C_INCLUDE_PURGEABLE_MEM_BUILDER_C_H */
53