enum.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2017-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_XCODE_ENUM_H__
#define __MOTR_XCODE_ENUM_H__

struct m0_xcode_enum_val;

struct m0_xcode_enum {
        const char                     *xe_name;
        uint32_t                        xe_nr;
        const struct m0_xcode_enum_val *xe_val;
        int                             xe_maxlen;
};

struct m0_xcode_enum_val {
        int         xev_idx;
        uint64_t    xev_val;
        const char *xev_name;
};

bool        m0_xcode_enum_is_valid   (const struct m0_xcode_enum *en,
                                      uint64_t val);
const char *m0_xcode_enum_print      (const struct m0_xcode_enum *en,
                                      uint64_t val, char *buf);
int         m0_xcode_enum_read       (const struct m0_xcode_enum *en,
                                      const char *buf, int nr, uint64_t *val);
bool        m0_xcode_bitmask_is_valid(const struct m0_xcode_enum *en,
                                      uint64_t val);
int         m0_xcode_bitmask_print   (const struct m0_xcode_enum *en,
                                      uint64_t val, char *buf, int nr);
int         m0_xcode_bitmask_read    (const struct m0_xcode_enum *en,
                                      const char *buf, int nr, uint64_t *val);
struct m0_xcode_obj;
struct m0_xcode_cursor;

M0_INTERNAL int m0_xcode_enum_field_read(const struct m0_xcode_cursor *it,
                                         struct m0_xcode_obj *obj,
                                         const char *str);

M0_INTERNAL int m0_xcode_bitmask_field_read(const struct m0_xcode_cursor *it,
                                            struct m0_xcode_obj *obj,
                                            const char *str);

#endif /* __MOTR_XCODE_ENUM_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */