oBaseComponent.h

/*
 *  omnis.xcomp.framework
 *  =====================
 *
 *  oBaseComponent.h
 *  Base class to subclass components from. These classes implement alot of the basics that each component shares
 *
 *  Our framework will instantiate your objects when it needs to obtain meta data or when the component is actually used.
 *  The init function is only called when the component is actualy used so put your heavy lifting stuff in here and keep your
 *  constructors simple (or just rely on the default constructor).
 *
 *  Bastiaan Olij
 *
 *  https://github.com/BastiaanOlij/omnis.xcomp.framework
 *
 *  Todos:
 *  - Change from using qArray to std::vector for objects and components
 *
 */

#include "qArray.h"
#include "qString.h"
#include "xCompStandardIncludes.h"

#ifndef obasecomponenth
#define obasecomponenth

// Made a type for non-visual objects...
const int cObjType_NVObject = 255; // Omnis reserved 1-9, assume they won't reach 255 any time soon...

// Some handy arrays
typedef qArray<ECOproperty> qProperties;
typedef qArray<ECOmethodEvent> qMethods;
typedef qArray<ECOmethodEvent> qEvents;

// std::vector versions of the above arrays, we'll slowly be switching over to using these
typedef std::vector<ECOmethodEvent> vMethods; // vector containing methods

/* our base class for all component objects */
class oBaseComponent {
private:
protected:
	qapp mApp; // our application (assuming this is static)

	/*** Parameters ***/
	char *newCStringFromParam(int pParamNo, EXTCompInfo *pECI, char *pBuffer = NULL, int pBufLen = 0); // get string from parameter, if no buffer is given we limit our return value to 1024 bytes
	const std::string getStringFromParam(int pParamNo, EXTCompInfo *pECI); // get standard string from parameter
	const std::vector<qbyte> getBinaryFromParam(int pParamNo, EXTCompInfo *pECI); // get binary buffer from parameter
	qstring *newStringFromParam(int pParamNo, EXTCompInfo *pECI); // get string from parameter, call needs to delete returned object
	long getLongFromParam(int pParamNo, EXTCompInfo *pECI); // get long from parameter
	bool getBoolFromParam(int pParamNo, EXTCompInfo *pECI); // get boolean from parameter
	EXTqlist *newQListFromParam(int pParamNo, EXTCompInfo *pECI); // get qlist from parameter, caller needs to delete return object
	char *newBinfromParam(int pParamNo, size_t *pLen, EXTCompInfo *pECI); // get binary buffer, returns NULL if the buffer is empty

	EXTqlist *getNamedList(qstring &pName, EXTCompInfo *pECI); // get list variable by name

public:
	oBaseComponent(void); // constructor
	virtual ~oBaseComponent(void); // destructor
	qbool init(qapp pApp); // initialize object

	/*** some nice support function ***/
	static void addToTraceLog(qstring &pData); // Add string to trace log
	static void vAddToTraceLog(const char *pData, va_list pArgList); // Add formatted string to trace log
	static void addToTraceLog(const char *pData, ...); // Add formatted string to trace log
#ifdef isunicode
	static void addToTraceLog(const qoschar *pData, ...); // Add formatted string to trace log
#endif
	static qlong HexToLong(const qchar *pText); // Convert a string of up to 8 characters from hex to qlong
	qbool copyFldVal(EXTfldval &pSource, EXTfldval &pDest); // Copy the contents of one EXTFLDVAL into another EXTFLDVAL
	EXTfldval *newCalculation(qstring &pCalculation, EXTCompInfo *pECI); // initialize calculation
	const qoschar *fldTypeName(ffttype pType); // get our type

	/*** Properties ***/
	static qProperties *properties(void); // return array of property meta data
	virtual qbool canAssign(qlong pPropID); // return true/false if a property can be written too
	virtual qbool setProperty(qlong pPropID, EXTfldval &pNewValue, EXTCompInfo *pECI); // set the value of a property (return true if property was handled, false if Omnis needs to do its thing..)
	virtual qbool getProperty(qlong pPropID, EXTfldval &pGetValue, EXTCompInfo *pECI); // get the value of a property (return true if property was handled, false if Omnis needs to do its thing..)

	/*** Methods ***/
	static qMethods *methods(void); // return an array of method meta data
	virtual int invokeMethod(qlong pMethodId, EXTCompInfo *pECI); // invoke a method

	/*** Events ***/
	static qEvents *events(void); // return an array of events meta data
};

#endif