interface.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_INTERFACE_H_
#define MCR_BASE_INTERFACE_H_

#include "mcr/base/data_member.h"
#include "mcr/base/types.h"

#ifdef __cplusplus
extern "C" {
#endif

struct mcr_Interface {
    size_t id;
    size_t data_size;
    struct mcr_context *context;
    struct mcr_IRegistry *registry;

    void *(*allocate)();
    void (*deallocate)(void *);
    mcr_data_fnc init;
    mcr_data_fnc deinit;
    mcr_compare_fnc compare;
    mcr_copy_fnc copy;
};

/* Interface */
MCR_API void mcr_Interface_init(struct mcr_Interface *interfacePt);
MCR_API void mcr_Interface_ctor(struct mcr_Interface *interfacePt,
                                struct mcr_context *context,
                                size_t dataSize, void *(*allocate)(), void (*deallocate)(void *),
                                mcr_data_fnc init, mcr_data_fnc deinit, mcr_compare_fnc compare,
                                mcr_copy_fnc copy);
MCR_API void mcr_Interface_deinit(struct mcr_Interface *interfacePt);

MCR_API void mcr_Interface_set_all(struct mcr_Interface *interfacePt,
                                   struct mcr_context *context, size_t dataSize,
                                   void *(*allocate)(), void (*deallocate)(void *),
                                   mcr_data_fnc init, mcr_data_fnc deinit,
                                   mcr_compare_fnc compare, mcr_copy_fnc copy);

MCR_API size_t mcr_Interface_id(struct mcr_Interface *interfacePt);

/* Interface functions on data */
MCR_API int mcr_Interface_allocate(const struct mcr_Interface *interfacePt,
                                   struct mcr_DataMember *dataMemberPt);

MCR_API int mcr_Interface_deallocate(const struct mcr_Interface *interfacePt,
                                     struct mcr_DataMember *dataMemberPt);

MCR_API int mcr_Interface_compare(const struct mcr_Interface *interfacePt,
                                  const struct mcr_DataMember *lhs, const struct mcr_DataMember *rhs);

MCR_API int mcr_Interface_copy(const struct mcr_Interface *interfacePt,
                               struct mcr_DataMember *dstPt,
                               const struct mcr_DataMember *srcPt);

MCR_API int mcr_Interface_set_data(const struct mcr_Interface *interfacePt,
                                   struct mcr_DataMember *dataMemberPt, void *data, bool heapFlag);

MCR_API int mcr_Interface_reset(const struct mcr_Interface *interfacePt,
                                struct mcr_DataMember *dataMemberPt);

#ifdef __cplusplus
}
#endif

#endif