JEncoder.h

Go to the documentation of this file.

/*
 *     ____             _________                __                _     
 *    / __ \___  ____ _/ /_  __(_)___ ___  ___  / /   ____  ____ _(_)____
 *   / /_/ / _ \/ __ `/ / / / / / __ `__ \/ _ \/ /   / __ \/ __ `/ / ___/
 *  / _, _/  __/ /_/ / / / / / / / / / / /  __/ /___/ /_/ / /_/ / / /__  
 * /_/ |_|\___/\__,_/_/ /_/ /_/_/ /_/ /_/\___/_____/\____/\__, /_/\___/  
 *                                                       /____/          
 *
 *                  Barracuda Application Server
 *
 ****************************************************************************
 *                            HEADER
 *
 *   $Id: JEncoder.h 6657 2026-10-28 18:19:39Z wini $
 *
 *   COPYRIGHT:  Real Time Logic LLC, 2006-2026
 *
 *   This software is copyrighted by and is the sole property of Real
 *   Time Logic LLC.  All rights, title, ownership, or other interests in
 *   the software remain the property of Real Time Logic LLC.  This
 *   software may only be used in accordance with the terms and
 *   conditions stipulated in the corresponding license agreement under
 *   which the software has been supplied.  Any unauthorized use,
 *   duplication, transmission, distribution, or disclosure of this
 *   software is expressly forbidden.
 *                                                                        
 *   This Copyright notice may not be removed or modified without prior
 *   written consent of Real Time Logic LLC.
 *                                                                         
 *   Real Time Logic LLC. reserves the right to modify this software
 *   without notice.
 *
 *               http://realtimelogic.com
 ****************************************************************************
 *
 */
 
#ifndef __JEncoder_h
#define __JEncoder_h
 
#include "JVal.h"
#include "BufPrint.h"
 
typedef struct JEncoder
{
#ifdef __cplusplus
      JEncoder(JErr* err, BufPrint* out);
      ~JEncoder();
 
      int setInt(S32 val);
 
      int setLong(S64 val);
 
      int setDouble(double val);
 
      int setString(const char* val, size_t len);
 
      int b64enc(const void* source, S32 slen);
 
      int fmtString(const char* fmt,...);
 
      int vFmtString(const char* fmt,va_list argList);
 
      int setBoolean(bool val);
 
      int setNull();
 
/* Expose the optional API to Doxygen without selecting it in product builds. */
#if BA_ENABLE_JENCODER_JVAL || defined(__DOXYGEN__)
      int setJV(struct JVal* val, bool iterateNext=false);
#endif
 
      int set(const char* fmt, ...);
 
      int setName(const char* name);
 
      int beginObject();
 
      int endObject();
 
      int beginArray();
 
      int endArray();
 
      JErr* getErr();
 
      int flush();
 
      int commit();
 
      BufPrint* getBufPrint();
 
#endif
      JErr* err;
      struct
      {
            S32 level;
            U8 data[64];
      }objectStack;
      BufPrint* out;
      BaBool objectMember;
      BaBool startNewObj;
} JEncoder;
#ifdef __cplusplus
extern "C" {
#endif
BA_API void JEncoder_constructor(JEncoder* o, JErr* err, BufPrint* out);
#define JEncoder_destructor(o) JEncoder_flush(o)
BA_API int JEncoder_flush(JEncoder* o);
BA_API int JEncoder_commit(JEncoder* o);
#define JEncoder_getErr(o) (o)->err
BA_API int JEncoder_setInt(JEncoder* o, S32 val);
BA_API int JEncoder_setLong(JEncoder* o, S64 val);
BA_API int JEncoder_setDouble(JEncoder* o, double val);
 
BA_API int JEncoder_fmtString(JEncoder* o, const char* fmt,...);
BA_API int JEncoder_vFmtString(
   JEncoder* o, const char* fmt,va_list argList);
BA_API int JEncoder_setString(JEncoder* o, const char* val, size_t len);
BA_API int JEncoder_b64enc(JEncoder* o, const void* source, S32 slen);
BA_API int JEncoder_setBoolean(JEncoder* o, BaBool val);
BA_API int JEncoder_setNull(JEncoder* o);
#if BA_ENABLE_JENCODER_JVAL || defined(__DOXYGEN__)
BA_API int JEncoder_setJV(
   JEncoder* o, struct JVal* val, BaBool iterateNext);
#endif
BA_API int JEncoder_vSetJV(
   JEncoder* o,const char** fmt,va_list* argList);
BA_API int JEncoder_set(JEncoder* o, const char* fmt, ...);
BA_API int JEncoder_setName(JEncoder* o, const char* name);
BA_API int JEncoder_beginObject(JEncoder* o);
BA_API int JEncoder_endObject(JEncoder* o);
BA_API int JEncoder_beginArray(JEncoder* o);
BA_API int JEncoder_endArray(JEncoder* o);
#define JEncoder_getBufPrint(o) (o)->out
#ifdef __cplusplus
}
inline JEncoder::JEncoder(JErr* err, BufPrint* out) {
   JEncoder_constructor(this,err, out); }
inline JEncoder::~JEncoder() {
   JEncoder_destructor(this); }
inline int JEncoder::setInt(S32 val) {
   return  JEncoder_setInt(this, val); }
inline int JEncoder::setLong(S64 val) {
   return  JEncoder_setLong(this, val); }
inline int JEncoder::setDouble(double val) {
   return  JEncoder_setDouble(this, val); }
inline int JEncoder::fmtString(const char* fmt,...) {
   int retv; va_list argList;
   va_start(argList, fmt); 
   retv = JEncoder_fmtString(this, fmt, argList);
   va_end(argList);
   return retv;
}
inline int JEncoder::vFmtString(const char* fmt,va_list argList) {
   return JEncoder_vFmtString(this, fmt, argList); }
inline int JEncoder::setString(const char* val, size_t len) {
   return  JEncoder_setString(this, val, len); }
inline int JEncoder::b64enc(const void* source, S32 slen) {
   return  JEncoder_b64enc(this, source, slen); }
inline int JEncoder::setBoolean(bool val) {
   return  JEncoder_setBoolean(this, val ? TRUE : FALSE); }
inline int JEncoder::setNull() {
   return  JEncoder_setNull(this); }
#if BA_ENABLE_JENCODER_JVAL
inline int JEncoder::setJV(struct JVal* val, bool iterateNext) {
   return  JEncoder_setJV(this,val,iterateNext?TRUE:FALSE); }
#endif
inline int JEncoder::set(const char* fmt, ...) {
   int retv; va_list argList;
   va_start(argList, fmt); 
   retv=JEncoder_vSetJV(this,&fmt,&argList);
   va_end(argList);
   return retv;
}
inline int JEncoder::setName(const char* name) {
   return  JEncoder_setName(this, name); }
inline int JEncoder::beginObject() {
   return  JEncoder_beginObject(this); }
inline int JEncoder::endObject() {
   return  JEncoder_endObject(this); }
inline int JEncoder::beginArray() {
   return  JEncoder_beginArray(this); }
inline int JEncoder::endArray() {
   return  JEncoder_endArray(this); }
inline JErr* JEncoder::getErr() {
   return JEncoder_getErr(this); }
inline int JEncoder::flush() {
   return JEncoder_flush(this); }
inline int JEncoder::commit() {
   return JEncoder_commit(this); }
inline BufPrint* JEncoder::getBufPrint() {
   return JEncoder_getBufPrint(this); }
#endif
 
#define JE_MEMBER(o, m) #m, (o)->m
 
 /* end of JSONRef */ 
 
#endif