mca/pinstalldirs/pinstalldirs.h

0001 /* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
0002 /*
0003  * Copyright (c) 2006-2015 Los Alamos National Security, LLC.  All rights
0004  *                         reserved.
0005  * Copyright (c) 2016-2020 Intel, Inc.  All rights reserved.
0006  * Copyright (c) 2021-2022 Nanook Consulting.  All rights reserved.
0007  * $COPYRIGHT$
0008  *
0009  * Additional copyrights may follow
0010  *
0011  * $HEADER$
0012  */
0013
0014 #ifndef PMIX_MCA_PINSTALLDIRS_PINSTALLDIRS_H
0015 #define PMIX_MCA_PINSTALLDIRS_PINSTALLDIRS_H
0016
0017 #include "src/include/pmix_config.h"
0018
0019 #include "pmix_common.h"
0020
0021 #include "src/mca/base/pmix_base.h"
0022 #include "src/mca/mca.h"
0023 #include "src/mca/pinstalldirs/pinstalldirs_types.h"
0024
0025 BEGIN_C_DECLS
0026 /**
0027  * Expand out path variables (such as ${prefix}) in the input string
0028  * using the current pmix_pinstall_dirs structure */
0029 PMIX_EXPORT char *pmix_pinstall_dirs_expand(const char *input);
0030
0031 /* optional initialization function */
0032 typedef void (*pmix_install_dirs_init_fn_t)(pmix_info_t info[], size_t ninfo);
0033
0034 /**
0035  * Structure for pinstalldirs components.
0036  */
0037 struct pmix_pinstalldirs_base_component_2_0_0_t {
0038     /** MCA base component */
0039     pmix_mca_base_component_t component;
0040     /** install directories provided by the given component */
0041     pmix_pinstall_dirs_t install_dirs_data;
0042     /* optional init function */
0043     pmix_install_dirs_init_fn_t init;
0044 };
0045 /**
0046  * Convenience typedef
0047  */
0048 typedef struct pmix_pinstalldirs_base_component_2_0_0_t pmix_pinstalldirs_base_component_t;
0049
0050 /*
0051  * Macro for use in components that are of type pinstalldirs
0052  */
0053 #define PMIX_PINSTALLDIRS_BASE_VERSION_1_0_0 PMIX_MCA_BASE_VERSION_1_0_0("pinstalldirs", 1, 0, 0)
0054
0055 END_C_DECLS
0056
0057 #endif /* PMIX_MCA_PINSTALLDIRS_PINSTALLDIRS_H */