libsmbconf: add get_includes() and set_includes() to the API.
[jra/samba/.git] / source3 / lib / smbconf / smbconf_private.h
1 /*
2  *  Unix SMB/CIFS implementation.
3  *  libsmbconf - Samba configuration library
4  *  Copyright (C) Michael Adam 2008
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 3 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #ifndef __LIBSMBCONF_PRIVATE_H__
21 #define __LIBSMBCONF_PRIVATE_H__
22
23 struct smbconf_ops {
24         WERROR (*init)(struct smbconf_ctx *ctx, const char *path);
25         int (*shutdown)(struct smbconf_ctx *ctx);
26         WERROR (*open_conf)(struct smbconf_ctx *ctx);
27         int (*close_conf)(struct smbconf_ctx *ctx);
28         void (*get_csn)(struct smbconf_ctx *ctx, struct smbconf_csn *csn,
29                         const char *service, const char *param);
30         WERROR (*drop)(struct smbconf_ctx *ctx);
31         WERROR (*get_share_names)(struct smbconf_ctx *ctx,
32                                   TALLOC_CTX *mem_ctx,
33                                   uint32_t *num_shares,
34                                   char ***share_names);
35         bool (*share_exists)(struct smbconf_ctx *ctx, const char *service);
36         WERROR (*create_share)(struct smbconf_ctx *ctx, const char *service);
37         WERROR (*get_share)(struct smbconf_ctx *ctx,
38                             TALLOC_CTX *mem_ctx,
39                             const char *servicename, uint32_t *num_params,
40                             char ***param_names, char ***param_values);
41         WERROR (*delete_share)(struct smbconf_ctx *ctx,
42                                     const char *servicename);
43         WERROR (*set_parameter)(struct smbconf_ctx *ctx,
44                                 const char *service,
45                                 const char *param,
46                                 const char *valstr);
47         WERROR (*get_parameter)(struct smbconf_ctx *ctx,
48                                 TALLOC_CTX *mem_ctx,
49                                 const char *service,
50                                 const char *param,
51                                 char **valstr);
52         WERROR (*delete_parameter)(struct smbconf_ctx *ctx,
53                                    const char *service, const char *param);
54         WERROR (*get_includes)(struct smbconf_ctx *ctx,
55                                const char *service,
56                                uint32_t *num_includes, char ***includes);
57         WERROR (*set_includes)(struct smbconf_ctx *ctx,
58                                const char *service,
59                                uint32_t num_includes, const char **includes);
60 };
61
62 struct smbconf_ctx {
63         const char *path;
64         struct smbconf_ops *ops;
65         void *data; /* private data for use in backends */
66 };
67
68 WERROR smbconf_init(TALLOC_CTX *mem_ctx, struct smbconf_ctx **conf_ctx,
69                     const char *path, struct smbconf_ops *ops);
70
71 WERROR smbconf_add_string_to_array(TALLOC_CTX *mem_ctx,
72                                    char ***array,
73                                    uint32_t count,
74                                    const char *string);
75
76 bool smbconf_find_in_array(const char *string, char **list,
77                            uint32_t num_entries, uint32_t *entry);
78
79 bool smbconf_reverse_find_in_array(const char *string, char **list,
80                                    uint32_t num_entries, uint32_t *entry);
81
82 #endif