libsheepyCUndefined.h

Go to the documentation of this file.

// MIT License
//
// Copyright (c) 2023 Remy Noulin
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
#pragma once

#include "string.h"

// Class undefined
typedef struct undefined undefinedt;

typedef void        (*freeUndefinedFt)      (undefinedt *self);
typedef void        (*terminateUndefinedFt) (undefinedt **self);
typedef char*       (*toStringUndefinedFt)  (undefinedt *self);
typedef undefinedt* (*duplicateUndefinedFt) (undefinedt *self);

typedef void        (*finishUndefinedFt)    (undefinedt **self);

typedef struct {
  freeUndefinedFt      free;
  terminateUndefinedFt terminate;
  toStringUndefinedFt  toString;
  duplicateUndefinedFt duplicate;
  terminateUndefinedFt smash;
  finishUndefinedFt    finish;
} undefinedFunctionst;

struct undefined {
  const char *type;
  undefinedFunctionst *f;
};

// base

#define createUndefined(obj) ;undefinedt obj; initiateUndefined(&obj)
#define createAllocateUndefined(obj) ;undefinedt *obj; initiateAllocateUndefined(&obj)

void initiateUndefined(undefinedt *self);
void initiateAllocateUndefined(undefinedt **self);
void finalizeRecycleUndefined(void *arg UNUSED);
void finalizeUndefined(void);

undefinedt* allocUndefined(void);

// terminate undefinedt val when it is out of scope
void cleanUpUndefinedTerminateG(undefinedt **val);

// free undefinedt local val when it is out of scope
void cleanUpUndefinedFreeLocalG(undefinedt *val);

// free undefinedt val when it is out of scope
void cleanUpUndefinedFreeG(undefinedt **val);

// finish undefinedt val when it is out of scope
void cleanUpUndefinedFinishG(undefinedt **val);

// smash undefinedt val when it is out of scope
void cleanUpUndefinedSmashG(undefinedt **val);

#define cleanUndefinedP(name) undefinedt *name CLEANUP(cleanUpUndefinedTerminateG)

#define cleanAllocateUndefined(obj) ;cleanUndefinedP(obj); initiateAllocateUndefined(&obj)

#define cleanUndefined(name) undefinedt name CLEANUP(cleanUpUndefinedFreeLocalG); initiateUndefined(&name)

#define cleanFreeUndefined(name) undefinedt *name CLEANUP(cleanUpUndefinedFreeG)

#define cleanFinishUndefinedP(name) undefinedt *name CLEANUP(cleanUpUndefinedFinishG)

#define cleanSmashUndefinedP(name) undefinedt *name CLEANUP(cleanUpUndefinedSmashG)


undefinedt* duplicateUndefinedG (undefinedt *self);

void        freeUndefinedG      (undefinedt *self);

// end class undefined