instance.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_INSTANCE_H_
#define MCR_BASE_INSTANCE_H_

#include "mcr/base/interface.h"

#ifdef __cplusplus
extern "C" {
#endif

struct mcr_Instance {
    struct mcr_Interface *interface;
    struct mcr_DataMember data_member;
};

MCR_API void mcr_Instance_init(struct mcr_Instance *instancePt);

MCR_API void mcr_Instance_deinit(struct mcr_Instance *instancePt);

MCR_API size_t mcr_Instance_id(struct mcr_Instance *instancePt);

static MCR_INLINE void *mcr_Instance_data(struct mcr_Instance *instancePt)
{
    return instancePt ? instancePt->data_member.data : NULL;
}

MCR_API bool mcr_Instance_heap(struct mcr_Instance *instancePt);

MCR_API int mcr_Instance_set_interface(struct mcr_Instance *instancePt,
                                       struct mcr_Interface *interfacePt);
MCR_API int mcr_Instance_clear(struct mcr_Instance *instancePt);
MCR_API int mcr_Instance_reset(struct mcr_Instance *instancePt);
MCR_API int mcr_Instance_compare(const struct mcr_Instance *lhsPt,
                                 const struct mcr_Instance *rhsPt);
MCR_API int mcr_Instance_copy(struct mcr_Instance *dstPt,
                              const struct mcr_Instance *srcPt);

#ifdef __cplusplus
}
#endif

#endif