iregistry.h

Go to the documentation of this file.

/* Libmacro - A multi-platform, extendable macro and hotkey C library
  Copyright (C) 2013 Jonathan Pelletier, New Paradigm Software

  This library is free software; you can redistribute it and/or
  modify it under the terms of the GNU Lesser General Public
  License as published by the Free Software Foundation; either
  version 2.1 of the License, or (at your option) any later version.

  This library is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  Lesser General Public License for more details.

  You should have received a copy of the GNU Lesser General Public
  License along with this library; if not, write to the Free Software
  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/

#ifndef MCR_BASE_IREGISTRY_H_
#define MCR_BASE_IREGISTRY_H_

#include "mcr/base/interface.h"

#ifdef __cplusplus
extern "C" {
#endif

struct mcr_IRegistry {
    void (*deinit)(struct mcr_IRegistry *);

    size_t (*id)(const struct mcr_IRegistry *, struct mcr_Interface *);
    struct mcr_Interface *(*from_id)(const struct mcr_IRegistry *, size_t id);
    const char *(*name)(const struct mcr_IRegistry *, struct mcr_Interface *);
    struct mcr_Interface *(*from_name)(const struct mcr_IRegistry *,
                                       const char *name);
    size_t (*set_name)(struct mcr_IRegistry *, struct mcr_Interface *,
                       const char *name);
    int (*add_names)(struct mcr_IRegistry *, struct mcr_Interface *,
                     const char * const*addNames, size_t addNamesCount);
    void (*remove)(struct mcr_IRegistry *, struct mcr_Interface *);
    void (*remove_name)(struct mcr_IRegistry *, const char *removeName);
    size_t (*count)(const struct mcr_IRegistry *);
    void (*trim)(struct mcr_IRegistry *);
    void (*clear)(struct mcr_IRegistry *);
};

MCR_API int mcr_register(struct mcr_IRegistry *iRegPt,
                         struct mcr_Interface *interfacePt, const char *name, const char * const*addNames,
                         size_t addNamesCount);
MCR_API void mcr_unregister(struct mcr_IRegistry *iRegPt,
                            struct mcr_Interface *interfacePt);

MCR_API void mcr_IRegistry_init(struct mcr_IRegistry *iRegPt);
MCR_API void mcr_IRegistry_deinit(struct mcr_IRegistry *iRegPt);
MCR_API size_t mcr_IRegistry_id(const struct mcr_IRegistry *iRegPt,
                                struct mcr_Interface *interfacePt);
MCR_API struct mcr_Interface *mcr_IRegistry_from_id(const struct mcr_IRegistry
        *iRegPt, size_t typeId);
MCR_API const char *mcr_IRegistry_name(const struct mcr_IRegistry *iRegPt,
                                       struct mcr_Interface *interfacePt);
MCR_API struct mcr_Interface *mcr_IRegistry_from_name(const struct mcr_IRegistry
        *iRegPt, const char *name);
MCR_API const char *mcr_IRegistry_id_name(const struct mcr_IRegistry *iRegPt,
        size_t id);
MCR_API size_t mcr_IRegistry_name_id(const struct mcr_IRegistry *iRegPt,
                                     const char *name);
MCR_API int mcr_IRegistry_set_name(struct mcr_IRegistry *iRegPt,
                                   struct mcr_Interface *interfacePt, const char *name);
MCR_API int mcr_IRegistry_add_name(struct mcr_IRegistry *iRegPt,
                                   struct mcr_Interface *interfacePt, const char *name);
MCR_API int mcr_IRegistry_add_names(struct mcr_IRegistry *iRegPt,
                                    struct mcr_Interface *interfacePt, const char * const*addNames, size_t addNamesCount);
MCR_API size_t mcr_IRegistry_count(const struct mcr_IRegistry *iRegPt);
MCR_API void mcr_IRegistry_trim(struct mcr_IRegistry *iRegPt);
MCR_API void mcr_IRegistry_clear(struct mcr_IRegistry *iRegPt);

#ifdef __cplusplus
}
#endif

#endif