1 /*
2  * Python object wrapper of libcreg_key_t
3  *
4  * Copyright (C) 2013-2021, Joachim Metz <joachim.metz@gmail.com>
5  *
6  * Refer to AUTHORS for acknowledgements.
7  *
8  * This program is free software: you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation, either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public License
19  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
20  */
21 
22 #if !defined( _PYCREG_KEY_H )
23 #define _PYCREG_KEY_H
24 
25 #include <common.h>
26 #include <types.h>
27 
28 #include "pycreg_libcreg.h"
29 #include "pycreg_python.h"
30 
31 #if defined( __cplusplus )
32 extern "C" {
33 #endif
34 
35 typedef struct pycreg_key pycreg_key_t;
36 
37 struct pycreg_key
38 {
39 	/* Python object initialization
40 	 */
41 	PyObject_HEAD
42 
43 	/* The libcreg key
44 	 */
45 	libcreg_key_t *key;
46 
47 	/* The parent object
48 	 */
49 	PyObject *parent_object;
50 };
51 
52 extern PyMethodDef pycreg_key_object_methods[];
53 extern PyTypeObject pycreg_key_type_object;
54 
55 PyObject *pycreg_key_new(
56            libcreg_key_t *key,
57            PyObject *parent_object );
58 
59 int pycreg_key_init(
60      pycreg_key_t *pycreg_key );
61 
62 void pycreg_key_free(
63       pycreg_key_t *pycreg_key );
64 
65 PyObject *pycreg_key_is_corrupted(
66            pycreg_key_t *pycreg_key,
67            PyObject *arguments );
68 
69 PyObject *pycreg_key_get_offset(
70            pycreg_key_t *pycreg_key,
71            PyObject *arguments );
72 
73 PyObject *pycreg_key_get_name(
74            pycreg_key_t *pycreg_key,
75            PyObject *arguments );
76 
77 PyObject *pycreg_key_get_number_of_values(
78            pycreg_key_t *pycreg_key,
79            PyObject *arguments );
80 
81 PyObject *pycreg_key_get_value_by_index(
82            PyObject *pycreg_key,
83            int value_index );
84 
85 PyObject *pycreg_key_get_value(
86            pycreg_key_t *pycreg_key,
87            PyObject *arguments,
88            PyObject *keywords );
89 
90 PyObject *pycreg_key_get_values(
91            pycreg_key_t *pycreg_key,
92            PyObject *arguments );
93 
94 PyObject *pycreg_key_get_value_by_name(
95            pycreg_key_t *pycreg_key,
96            PyObject *arguments,
97            PyObject *keywords );
98 
99 PyObject *pycreg_key_get_number_of_sub_keys(
100            pycreg_key_t *pycreg_key,
101            PyObject *arguments );
102 
103 PyObject *pycreg_key_get_sub_key_by_index(
104            PyObject *pycreg_key,
105            int sub_key_index );
106 
107 PyObject *pycreg_key_get_sub_key(
108            pycreg_key_t *pycreg_key,
109            PyObject *arguments,
110            PyObject *keywords );
111 
112 PyObject *pycreg_key_get_sub_keys(
113            pycreg_key_t *pycreg_key,
114            PyObject *arguments );
115 
116 PyObject *pycreg_key_get_sub_key_by_name(
117            pycreg_key_t *pycreg_key,
118            PyObject *arguments,
119            PyObject *keywords );
120 
121 PyObject *pycreg_key_get_sub_key_by_path(
122            pycreg_key_t *pycreg_key,
123            PyObject *arguments,
124            PyObject *keywords );
125 
126 #if defined( __cplusplus )
127 }
128 #endif
129 
130 #endif /* !defined( _PYCREG_KEY_H ) */
131 
132