libsheepyCSmallInt.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 <stdint.h>

// Class smallInt
typedef struct smallInt smallIntt;

#define helpTextSmallInt "TODO smallInt help brief, class description /*, definitions,*/ methods, examples"

// for object inheriting smallInt, cast to smallInt to be able to use this class functions and generics
#define cIn(self) ( (smallIntt*) self )

typedef void   (*freeSmallIntFt)      (smallIntt *self);
typedef void   (*terminateSmallIntFt) (smallIntt **self);
typedef char*  (*toStringSmallIntFt)  (smallIntt *self);
typedef smallIntt* (*duplicateSmallIntFt) (smallIntt *self);

// smallInt functions
typedef void     (*smashSmallIntFt)     (smallIntt **self);

typedef void     (*finishSmallIntFt)    (smallIntt **self);

typedef const char* (*helpSmallIntFt)   (smallIntt *self);

typedef int64_t  (*getSmallIntFt)       (smallIntt *self);

typedef smallIntt*     (*setSmallIntFt)       (smallIntt *self, int64_t value);

typedef smallIntt*     (*setBoolSmallIntFt)       (smallIntt* self, bool p2);
typedef smallIntt*     (*setDoubleSmallIntFt)     (smallIntt* self, double p2);
typedef smallIntt*     (*setInt32SmallIntFt)      (smallIntt* self, int32_t p2);
typedef smallIntt*     (*setUint32SmallIntFt)     (smallIntt* self, uint32_t p2);
typedef smallIntt*     (*setUint64SmallIntFt)     (smallIntt* self, uint64_t p2);
typedef smallIntt*     (*setSSmallIntFt)          (smallIntt* self, const char* p2);
typedef smallIntt*     (*setSmallBoolSmallIntFt)  (smallIntt* self, smallBoolt* p2);
typedef smallIntt*     (*setSmallDoubleSmallIntFt)(smallIntt* self, smallDoublet* p2);
typedef smallIntt*     (*setSmallIntSmallIntFt)   (smallIntt* self, smallIntt* p2);
typedef smallIntt*     (*setSmallJsonSmallIntFt)  (smallIntt* self, smallJsont* p2);
typedef smallIntt*     (*setSmallStringSmallIntFt)(smallIntt* self, smallStringt* p2);

typedef int64_t* (*getPSmallIntFt)          (smallIntt *self);

typedef bool     (*equalSmallIntChaFt)        (smallIntt* self, char p2);
typedef bool     (*equalSmallIntCharFt)       (smallIntt* self, const char * p2);
typedef bool     (*equalSmallIntBaseFt)       (smallIntt* self, baset* p2);
typedef bool     (*equalSmallIntBoolFt)       (smallIntt* self, bool p2);
typedef bool     (*equalSmallIntDoubleFt)     (smallIntt* self, double p2);
typedef bool     (*equalSmallIntInt64Ft)      (smallIntt* self, int64_t p2);
typedef bool     (*equalSmallIntInt32Ft)      (smallIntt* self, int32_t p2);
typedef bool     (*equalSmallIntUint32Ft)     (smallIntt* self, uint32_t p2);
typedef bool     (*equalSmallIntUint64Ft)     (smallIntt* self, uint64_t p2);
typedef bool     (*equalSmallIntSmallBoolFt)  (smallIntt* self, smallBoolt* p2);
typedef bool     (*equalSmallIntSmallBytesFt) (smallIntt* self, smallBytest* p2);
typedef bool     (*equalSmallIntSmallDoubleFt)(smallIntt* self, smallDoublet* p2);
typedef bool     (*equalSmallIntFt)           (smallIntt* self, smallIntt* p2);
typedef bool     (*equalSmallIntSmallJsonFt)  (smallIntt* self, smallJsont* p2);
typedef bool     (*equalSmallIntSmallStringFt)(smallIntt* self, smallStringt* p2);

typedef smallIntt* (*readFileSmallIntFt)           (smallIntt *self, const char *filePath);
typedef smallIntt* (*readFileSmallJsonSmallIntFt)  (smallIntt *self, smallJsont *filePath);
typedef smallIntt* (*readFileSmallStringSmallIntFt)(smallIntt *self, smallStringt *filePath);
typedef smallIntt* (*readStreamSmallIntFt)         (smallIntt *self, FILE *fp);

typedef int (*writeFileSmallIntFt)           (smallIntt *self, const char *filePath);
typedef int (*writeFileSmallJsonSmallIntFt)  (smallIntt *self, smallJsont *filePath);
typedef int (*writeFileSmallStringSmallIntFt)(smallIntt *self, smallStringt *filePath);
typedef int (*writeStreamSmallIntFt)         (smallIntt *self, FILE *fp);

typedef int (*appendFileSmallIntFt)(smallIntt *self, const char *filePath);
typedef int (*appendFileSmallStringSmallIntFt)(smallIntt *self, smallStringt *filePath);

#define SMALLINTFUNCTIONST \
  helpSmallIntFt             help;\
  getSmallIntFt              get;\
  setSmallIntFt              set;\
  setBoolSmallIntFt          setBool;\
  setDoubleSmallIntFt        setDouble;\
  setInt32SmallIntFt         setInt32;\
  setUint32SmallIntFt        setUint32;\
  setUint64SmallIntFt        setUint64;\
  setSSmallIntFt             setS;\
  setSmallBoolSmallIntFt     setSmallBool;\
  setSmallDoubleSmallIntFt   setSmallDouble;\
  setSmallIntSmallIntFt      setSmallInt;\
  setSmallJsonSmallIntFt     setSmallJson;\
  setSmallStringSmallIntFt   setSmallString;\
  getPSmallIntFt             getP;\
  equalSmallIntChaFt         equalCha;\
  equalSmallIntCharFt        equalChar;\
  equalSmallIntBaseFt        equalBase;\
  equalSmallIntBoolFt        equalBool;\
  equalSmallIntDoubleFt      equalDouble;\
  equalSmallIntInt64Ft       equalInt64;\
  equalSmallIntInt32Ft       equalInt32;\
  equalSmallIntUint32Ft      equalUint32;\
  equalSmallIntUint64Ft      equalUint64;\
  equalSmallIntSmallBoolFt   equalSmallBool;\
  equalSmallIntSmallBytesFt  equalSmallBytes;\
  equalSmallIntSmallDoubleFt equalSmallDouble;\
  equalSmallIntFt            equal;\
  equalSmallIntSmallJsonFt   equalSmallJson;\
  equalSmallIntSmallStringFt equalSmallString;\
  readFileSmallIntFt              readFile;\
  readFileSmallJsonSmallIntFt     readFileSmallJson;\
  readFileSmallStringSmallIntFt   readFileSmallString;\
  readStreamSmallIntFt            readStream;\
  writeFileSmallIntFt             writeFile;\
  writeFileSmallJsonSmallIntFt    writeFileSmallJson;\
  writeFileSmallStringSmallIntFt  writeFileSmallString;\
  writeStreamSmallIntFt           writeStream;\
  appendFileSmallIntFt            appendFile;\
  appendFileSmallStringSmallIntFt appendFileSmallString


typedef struct {
  freeSmallIntFt             free;
  terminateSmallIntFt        terminate;
  toStringSmallIntFt         toString;
  duplicateSmallIntFt        duplicate;
  smashSmallIntFt            smash;
  finishSmallIntFt           finish;
  SMALLINTFUNCTIONST;
} smallIntFunctionst;

struct smallInt {
  const char *type;
  smallIntFunctionst *f;

  sIntt      *value;
};

// smallInt

#define createSmallInt(obj) ;smallIntt obj; initiateSmallInt(&obj)
#define createAllocateSmallInt(obj) ;smallIntt *obj; initiateAllocateSmallInt(&obj)

void initiateSmallInt(smallIntt *self);
void initiateAllocateSmallInt(smallIntt **self);
void finalizeRecycleSmallInt(void *arg UNUSED);
void finalizeSmallInt(void);

// initialize class methods, call registerMethodsSmallInt from classes inheriting this class
void registerMethodsSmallInt(smallIntFunctionst *f);

smallIntt* allocSmallInt(int64_t value);

// terminate smallIntt val when it is out of scope
void cleanUpSmallIntTerminateG(smallIntt **val);

// free smallIntt local val when it is out of scope
void cleanUpSmallIntFreeLocalG(smallIntt *val);

// free smallIntt val when it is out of scope
void cleanUpSmallIntFreeG(smallIntt **val);

// finish smallIntt val when it is out of scope
void cleanUpSmallIntFinishG(smallIntt **val);

#define cleanSmallIntP(name) smallIntt *name CLEANUP(cleanUpSmallIntTerminateG)

#define cleanAllocateSmallInt(obj) ;cleanSmallIntP(obj); initiateAllocateSmallInt(&obj)

#define cleanSmallInt(name) smallIntt name CLEANUP(cleanUpSmallIntFreeLocalG); initiateSmallInt(&name)

#define cleanFreeSmallInt(name) smallIntt *name CLEANUP(cleanUpSmallIntFreeG)

#define cleanFinishSmallIntP(name) smallIntt *name CLEANUP(cleanUpSmallIntFinishG)

smallIntt*          duplicateSmallIntG       (smallIntt *self);

void                freeSmallIntG            (smallIntt *self);

int64_t             getIntSmallIntG          (smallIntt *self, int64_t retType UNUSED, int64_t index UNUSED);
int64_t*            getIntPSmallIntG         (smallIntt *self, int64_t* retType UNUSED, int64_t index UNUSED);
int32_t             getInt32SmallIntG        (smallIntt *self, int32_t retType UNUSED, int64_t index UNUSED);
int32_t*            getInt32PSmallIntG       (smallIntt *self, int32_t* retType UNUSED, int64_t index UNUSED);
uint64_t            getUintSmallIntG         (smallIntt *self, uint64_t retType UNUSED, int64_t index UNUSED);
uint64_t*           getUintPSmallIntG        (smallIntt *self, uint64_t* retType UNUSED, int64_t index UNUSED);
uint32_t            getUint32SmallIntG       (smallIntt *self, uint32_t retType UNUSED, int64_t index UNUSED);
uint32_t*           getUint32PSmallIntG      (smallIntt *self, uint32_t* retType UNUSED, int64_t index UNUSED);

smallIntt*                setBoolSmallIntG         (smallIntt* self, bool p2);
smallIntt*                setDoubleSmallIntG       (smallIntt* self, double p2);
smallIntt*                setSmallIntG             (smallIntt* self, int64_t p2);
smallIntt*                setInt32SmallIntG        (smallIntt* self, int32_t p2);
smallIntt*                setUint32SmallIntG       (smallIntt* self, uint32_t p2);
smallIntt*                setUint64SmallIntG       (smallIntt* self, uint64_t p2);
smallIntt*                setSSmallIntG            (smallIntt* self, const char* p2);
smallIntt*                setSmallBoolSmallIntG    (smallIntt* self, smallBoolt* p2);
smallIntt*                setSmallDoubleSmallIntG  (smallIntt* self, smallDoublet* p2);
smallIntt*                setSmallIntSmallIntG     (smallIntt* self, smallIntt* p2);
smallIntt*                setSmallJsonSmallIntG    (smallIntt* self, smallJsont* p2);
smallIntt*                setSmallStringSmallIntG  (smallIntt* self, smallStringt* p2);

bool                equalSmallIntChaG        (smallIntt* self, char p2);
bool                equalSmallIntCharG       (smallIntt* self, const char * p2);
bool                equalSmallIntBaseG       (smallIntt* self, baset* p2);
bool                equalSmallIntBoolG       (smallIntt* self, bool p2);
bool                equalSmallIntDoubleG     (smallIntt* self, double p2);
bool                equalSmallIntInt64G      (smallIntt* self, int64_t p2);
bool                equalSmallIntInt32G      (smallIntt* self, int32_t p2);
bool                equalSmallIntUint32G     (smallIntt* self, uint32_t p2);
bool                equalSmallIntUint64G     (smallIntt* self, uint64_t p2);
bool                equalSmallIntSmallBoolG  (smallIntt* self, smallBoolt* p2);
bool                equalSmallIntSmallBytesG (smallIntt* self, smallBytest* p2);
bool                equalSmallIntSmallDoubleG(smallIntt* self, smallDoublet* p2);
bool                equalSmallIntFG          (smallIntt* self, smallIntt* p2);
bool                equalSmallIntSmallJsonG  (smallIntt* self, smallJsont* p2);
bool                equalSmallIntSmallStringG(smallIntt* self, smallStringt* p2);

smallIntt* readFileSmallIntG           (smallIntt *self, const char *filePath);
smallIntt* readFileSmallJsonSmallIntG  (smallIntt *self, smallJsont *filePath);
smallIntt* readFileSmallStringSmallIntG(smallIntt *self, smallStringt *filePath);
smallIntt* readStreamSmallIntG         (smallIntt *self, FILE *fp);
int writeFileSmallIntG           (smallIntt *self, const char *filePath);
int writeFileSmallJsonSmallIntG  (smallIntt *self, smallJsont *filePath);
int writeFileSmallStringSmallIntG(smallIntt *self, smallStringt *filePath);
int writeStreamSmallIntG         (smallIntt *self, FILE *fp);
int appendFileSmallIntFG           (smallIntt *self, const char *filePath); //TODO remove F - oGMacros generates a macro making the compilation fail
int appendFileSmallStringSmallIntG(smallIntt *self, smallStringt *filePath);
// end class smallInt