cml/libcw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
fe74e41a0d
libcw/cwUi.cpp
kevin 9acb24e9e1 Apply licensing information to project.
2024-12-01 14:35:24 -05:00

2947 lines
87 KiB
C++
Raw Blame History

//| Copyright: (C) 2020-2024 Kevin Larke <contact AT larke DOT org>
//| License: GNU GPL version 3.0 or above. See the accompanying LICENSE file.
#include "cwCommon.h"
#include "cwLog.h"
#include "cwCommonImpl.h"
#include "cwTest.h"
#include "cwMem.h"
#include "cwObject.h"
#include "cwTime.h"
#include "cwFileSys.h"
#include "cwThread.h"
#include "cwObject.h"
#include "cwWebSock.h"
#include "cwWebSockSvr.h"
#include "cwText.h"
#include "cwNumericConvert.h"
#include "cwUi.h"
#define UI_CLICKABLE_LABEL "clickable"
#define UI_SELECT_LABEL "select"
#define UI_VISIBLE_LABEL "visible"
#define UI_ENABLE_LABEL "enable"
#define UI_ORDER_LABEL "order"
#define UI_SCROLL_TOP_LABEL "scroll_top"
namespace cw
{
namespace ui
{
typedef struct ele_type_propery_str
{
const char* label;
bool is_div_fl;
} ele_type_property_t;
ele_type_property_t eleTypePropertyA[] =
{
{ "div", true },
{ "panel", true },
{ "row", true },
{ "col", true },
{ "label", false },
{ "button", false },
{ "check", false },
{ "select", false },
{ "option", false },
{ "str_disp", false },
{ "string", false },
{ "numb_disp", false },
{ "number", false },
{ "progress", false },
{ "log", false },
{ "vlist", false },
{ "hlist", false },
{ nullptr, false },
};
typedef struct appIdMapRecd_str
{
struct appIdMapRecd_str* link;
unsigned parentAppId;
unsigned appId;
char* eleName;
} appIdMapRecd_t;
typedef struct ele_str
{
struct ele_str* phys_parent; // pointer to actual parent ele - or nullptr if this ele is the root ui ele
struct ele_str* logical_parent; // pointer to the nearest ancestor that has a valid appId - this is useful to skip over unnamed containers like rows and columns
unsigned uuId; // UI unique id - automatically generated and unique among all elements that are part of this ui_t object.
unsigned appId; // application assigned id - application assigned id
unsigned chanId; //
char* eleName; // javascript id
object_t* attr; // attribute dictionary object
void* blob; // blob[ blobByteN ] user data
unsigned blobByteN; //
bool destroyFl; // used by the deleteElement() algorithm
} ele_t;
const unsigned hashN = 0xffff;
typedef struct bucket_str
{
ele_t* ele;
struct bucket_str* link;
} bucket_t;
typedef struct ui_str
{
unsigned eleAllocN; // size of eleA[]
unsigned eleN; // count of ele's in use
ele_t** eleA; // eleA[ eleAllocN ]
uiCallback_t uiCbFunc; // app. cb func
void* uiCbArg; // app. cb func arg.
sendCallback_t sendCbFunc;
void* sendCbArg;
appIdMapRecd_t* appIdMap; // map of application parent/child/js id's
char* buf; // buf[bufN] output message formatting buffer
unsigned bufN; //
char* recvBuf;
unsigned recvBufN;
unsigned recvBufIdx;
unsigned recvShiftN;
object_t* uiRsrc;
unsigned* sessA; // sessA[ sessN ] array of wsSessId's
unsigned sessN;
unsigned sessAllocN;
bool msgCacheEnableFl;
unsigned msgCacheSessId;
char* msgCache;
unsigned msgCacheAllocN;
unsigned msgCacheDataN;
unsigned msgCacheN;
unsigned msgCacheMsgN;
unsigned sentMsgN;
unsigned recvMsgN;
bucket_t hashA[ hashN+1 ];
} ui_t;
ui_t* _handleToPtr( handle_t h )
{ return handleToPtr<handle_t,ui_t>(h); }
unsigned short _gen_hash_index( unsigned parentUuId, unsigned appId )
{
assert( parentUuId != kInvalidId && appId != kInvalidId );
unsigned hc = parentUuId + cwSwap32(appId);
unsigned short hash_idx = (unsigned short)(((hc & 0xffff0000)>>16) + (hc & 0x0000ffff));
assert( hash_idx <= hashN );
return hash_idx;
}
void _store_ele_in_hash_table( ui_t* p, ele_t* e )
{
unsigned parentUuId = e->logical_parent == nullptr ? kInvalidId : e->logical_parent->uuId;
if( parentUuId == kInvalidId || e->appId == kInvalidId )
return;
unsigned short hash_idx = _gen_hash_index( parentUuId, e->appId );
// if the first bucket is empty ...
if( p->hashA[ hash_idx ].ele == nullptr )
p->hashA[ hash_idx ].ele = e; // ... then fill it
else
{
// otherwise look for an empty bucket
bucket_t* b = p->hashA[ hash_idx ].link;
for(; b!=nullptr; b=b->link)
if( b->ele == nullptr )
{
b->ele = e; // an empty bucket was found - fill it
return;
}
// create a new bucket
b = mem::allocZ<bucket_t>();
// and insert it as the second bucket
b->link = p->hashA[ hash_idx ].link;
b->ele = e;
p->hashA[hash_idx].link = b;
}
}
unsigned _find_ele_in_hash_table( ui_t* p, unsigned parentUuId, unsigned appId, unsigned chanId )
{
if( parentUuId != kInvalidId && appId != kInvalidId )
{
unsigned hash_idx = _gen_hash_index(parentUuId,appId);
bucket_t* b = p->hashA + hash_idx;
for(; b!=nullptr; b=b->link)
if( b->ele != nullptr && b->ele->logical_parent!=nullptr && b->ele->appId==appId && b->ele->logical_parent->uuId==parentUuId && (chanId==kInvalidId || b->ele->chanId==chanId) )
return b->ele->uuId;
}
return kInvalidId;
}
void _remove_ele_from_hash_table_0( ui_t* p, const ele_t* e )
{
// Note: hashA[] has hashN+1 elements
for(unsigned i=0; i<=hashN; ++i)
{
bucket_t* b = p->hashA + i;
for(; b!= nullptr; b=b->link)
if( b->ele == e )
{
b->ele = nullptr;
break;
}
}
}
void _remove_ele_from_hash_table( ui_t* p, const ele_t* e )
{
if( e == nullptr )
return;
unsigned parentUuId = e->logical_parent == nullptr ? kInvalidId : e->logical_parent->uuId;
unsigned appId = e->appId;
if( parentUuId == kInvalidId || appId == kInvalidId )
{
//_remove_ele_from_hash_table_0(p,e);
return;
}
unsigned hash_idx = _gen_hash_index(parentUuId,appId);
bucket_t* b = p->hashA + hash_idx;
// locate the bucket to delete
for(; b!=nullptr; b=b->link)
{
if( b->ele == e )
{
b->ele = nullptr;
return;
}
}
_remove_ele_from_hash_table_0(p,e);
}
void _print_eles( ui_t* p )
{
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr )
{
ele_t* e = p->eleA[i];
printf("%15s u:%i : u:%i a:%i %s\n",e->phys_parent==nullptr?"<null>" : e->phys_parent->eleName,e->phys_parent==nullptr? -1 :e->phys_parent->uuId,e->uuId,e->appId,e->eleName);
}
}
// Return true if 'parent' is an ancestor of 'ele' (or 'ele' is a child of 'parent')
bool _is_child_of( const ele_t* parent, const ele_t* ele )
{
if( ele == nullptr )
return false;
if( ele->phys_parent == parent || ele->logical_parent == parent )
return true;
// go up the tree - are 'ele' parents children of 'parent'?
return _is_child_of( parent, ele->phys_parent ) || _is_child_of( parent, ele->logical_parent );
}
void _destroy_element( ui_t* p, ele_t* e )
{
if( e == nullptr )
return;
if( e->attr != nullptr )
e->attr->free();
mem::release(e->eleName);
mem::release(e->blob);
mem::release(e);
}
rc_t _destroy( ui_t* p )
{
rc_t rc = kOkRC;
// free each element
if( p->eleA != nullptr )
for(unsigned i=0; i<p->eleN; ++i)
{
_destroy_element( p, p->eleA[i] );
p->eleA[i] = nullptr;
}
appIdMapRecd_t* m = p->appIdMap;
while( m!=nullptr )
{
appIdMapRecd_t* m0 = m->link;
mem::release(m->eleName);
mem::release(m);
m = m0;
}
// Note: hashA[] has hashN+1 elements
for(unsigned i=0; i<=hashN; ++i)
{
bucket_t* b = p->hashA[i].link;
while( b!=nullptr )
{
bucket_t* b0 = b->link;
mem::release(b);
b = b0;
}
}
mem::release(p->sessA);
mem::release(p->eleA);
mem::release(p->buf);
mem::release(p->recvBuf);
if( p->uiRsrc != nullptr )
p->uiRsrc->free();
mem::release(p);
return rc;
}
ele_type_property_t* _labelToEleTypeProperty( const char* label )
{
for(unsigned i=0; eleTypePropertyA[i].label != nullptr; ++i)
if( textIsEqual(eleTypePropertyA[i].label,label) )
return eleTypePropertyA + i;
return nullptr;
}
bool _isEleTypeDiv( const char* label )
{
ele_type_property_t* etp;
if((etp = _labelToEleTypeProperty(label)) == nullptr )
return false;
return etp->is_div_fl;
}
bool _isEleTypeLabel( const char* label )
{ return _labelToEleTypeProperty(label) != nullptr; }
appIdMapRecd_t* _findAppIdMap( ui_t* p, unsigned parentAppId, const char* eleName )
{
appIdMapRecd_t* m = p->appIdMap;
for(; m != nullptr; m=m->link)
if( m->parentAppId==parentAppId && textCompare(eleName,m->eleName)==0 )
return m;
return nullptr;
}
appIdMapRecd_t* _findAppIdMap( ui_t* p, unsigned parentAppId, unsigned appId )
{
appIdMapRecd_t* m = p->appIdMap;
for(; m != nullptr; m=m->link)
if( m->parentAppId==parentAppId && m->appId==appId )
return m;
return nullptr;
}
rc_t _allocAppIdMap( ui_t* p, unsigned parentAppId, unsigned appId, const char* eleName )
{
rc_t rc = kOkRC;
// The 'eleName' must be valid (or there is no reason to create the map.
// (since it will ultimately be used to locate the appId give the parentAppId and eleName)
if( eleName == nullptr || strlen(eleName) == 0 )
return cwLogError(kInvalidIdRC,"Registered parent/child app id's must have a valid 'eleName'.");
// verify that the parent/child pair is unique
if( _findAppIdMap(p,parentAppId,appId) != nullptr )
return cwLogError(kDuplicateRC,"An attempt was made to register a duplicate parent/child appid pair. parentId:%i appId:%i eleName:'%s'.",parentAppId,appId,cwStringNullGuard(eleName));
// verify that the parent/js pair is unique
if( _findAppIdMap(p,parentAppId,eleName) != nullptr )
return cwLogError(kDuplicateRC,"An attempt was made to register a duplicate parent app id/js id pair. parentId:%i appId:%i eleName:'%s'.",parentAppId,appId,cwStringNullGuard(eleName));
// allocate and link in a new appId map record
appIdMapRecd_t* m = mem::allocZ<appIdMapRecd_t>();
m->parentAppId = parentAppId;
m->appId = appId;
m->eleName = eleName==nullptr ? nullptr : mem::duplStr(eleName);
m->link = p->appIdMap;
p->appIdMap = m;
return rc;
}
rc_t _registerAppIdMap( ui_t* p, const appIdMap_t* map, unsigned mapN )
{
rc_t rc = kOkRC;
if( map != nullptr )
for(unsigned i=0; i<mapN; ++i)
if((rc = _allocAppIdMap( p, map[i].parentAppId, map[i].appId, map[i].eleName )) != kOkRC )
return rc;
return rc;
}
// Given a uuId return a pointer to the associated element.
ele_t* _uuIdToEle( ui_t* p, unsigned uuId, bool errorFl=true )
{
if( uuId >= p->eleN )
{
cwLogError(kInvalidIdRC,"The element uuid:%i is not valid.",uuId);
return nullptr;
}
return p->eleA[ uuId ];
}
ele_t* _eleNameToEle( ui_t* p, const char* eleName, bool errorFl=true )
{
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr )
if( textCompare(p->eleA[i]->eleName,eleName) == 0 )
return p->eleA[i];
if( errorFl )
cwLogError(kInvalidIdRC,"The element with eleName:%s not found.",cwStringNullGuard(eleName));
return nullptr;
}
unsigned _findElementUuId( ui_t* p, unsigned parentUuId, const char* eleName, unsigned chanId=kInvalidId )
{
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] !=nullptr && p->eleA[i]->logical_parent != nullptr ) // skip the root
{
if(( parentUuId == kInvalidId || p->eleA[i]->logical_parent->uuId == parentUuId) &&
( chanId == kInvalidId || p->eleA[i]->chanId == chanId) &&
( textCompare(p->eleA[i]->eleName,eleName) == 0))
{
return p->eleA[i]->uuId;
}
}
return kInvalidId;
}
unsigned _findElementUuId( ui_t* p, unsigned parentUuId, unsigned appId, unsigned chanId=kInvalidId )
{
if( appId == kRootAppId )
return kRootUuId;
// try looking up the result in the hash table
unsigned uuid;
if((uuid = _find_ele_in_hash_table(p,parentUuId,appId,chanId)) != kInvalidId )
return uuid;
// if the result could not be found in the hash table (possibly because parentUuId is set to the wildcard i.e. kInvalidId)
// then do an exhaustive search
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr
&& p->eleA[i]->appId == appId
&& ( parentUuId == kInvalidId || (p->eleA[i]->logical_parent!=nullptr && p->eleA[i]->logical_parent->uuId == parentUuId) )
&& ( chanId == kInvalidId || p->eleA[i]->chanId == chanId ) )
{
return p->eleA[i]->uuId;
}
return kInvalidId;
}
const char* _findEleEleName( ui_t* p, unsigned uuId )
{
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->uuId == uuId )
return p->eleA[i]->eleName;
return nullptr;
}
rc_t _send_callback( ui_t* p, unsigned wsSessId, const void* msg, unsigned msgByteN )
{
p->sentMsgN += 1;
rc_t rc = p->sendCbFunc( p->sendCbArg, wsSessId, msg, msgByteN );
return rc;
}
rc_t _cache_flush( ui_t* p )
{
rc_t rc = kOkRC;
if( p->msgCacheMsgN > 0 )
{
assert( p->msgCacheN <= p->msgCacheDataN );
p->msgCache[ p->msgCacheN+0 ] = ']';
p->msgCache[ p->msgCacheN+1 ] = '}';
p->msgCache[ p->msgCacheN+2 ] = 0;
rc = _send_callback(p, p->msgCacheSessId, p->msgCache, strlen(p->msgCache) );
p->msgCacheN = snprintf(p->msgCache,p->msgCacheAllocN,"{\"op\":\"cache\", \"array\": [");
p->msgCacheSessId = kInvalidId;
p->msgCacheMsgN = 0;
}
return rc;
}
rc_t _cache_send( ui_t* p, unsigned wsSessId, const char* msg, unsigned msgByteN )
{
rc_t rc = kOkRC;
unsigned msgByteCommaN = msgByteN + 1;
// if the cache buffer has not yet been allocated
if( p->msgCache == nullptr && p->msgCacheAllocN>0 )
{
p->msgCacheDataN = p->msgCacheAllocN - 3; // "]}/0" three char's must be reserved to terminate the cache message (See _cache_flush().)
p->msgCache = mem::allocZ<char>( p->msgCacheAllocN );
p->msgCacheSessId = kInvalidId;
p->msgCacheN = snprintf(p->msgCache,p->msgCacheDataN,"{\"op\":\"cache\", \"array\": [");
p->msgCacheMsgN = 0;
}
if( wsSessId != p->msgCacheSessId || p->msgCacheN + msgByteCommaN > p->msgCacheDataN || msgByteN > p->msgCacheDataN )
rc = _cache_flush(p);
if( msgByteN > p->msgCacheDataN )
rc = _send_callback(p, wsSessId, msg, msgByteN );
else
{
assert( p->msgCacheN + msgByteCommaN <= p->msgCacheDataN );
// if this isn't the first msg is the buffer then prepend a ','
if( p->msgCacheMsgN != 0 )
strncat(p->msgCache,",",2);
else
msgByteCommaN -= 1; // otherwise the msgByteCommaN is the same as msgByteN
strncat(p->msgCache,msg,msgByteN);
p->msgCacheN += msgByteCommaN;
p->msgCacheSessId = wsSessId;
p->msgCacheMsgN += 1;
}
return rc;
}
rc_t _send_or_cache( ui_t* p, unsigned sessId, const char* msg, unsigned msgByteCnt )
{
rc_t rc = kOkRC;
if( p->msgCacheEnableFl )
rc = _cache_send( p, sessId, msg, msgByteCnt );
else
rc = _send_callback(p, sessId, msg, msgByteCnt );
return rc;
}
rc_t _websockSend( ui_t* p, unsigned wsSessId, const char* msg )
{
rc_t rc = kOkRC;
if( p->sendCbFunc != nullptr )
{
unsigned msgByteN = msg==nullptr ? 0 : strlen(msg);
if( wsSessId != kInvalidId )
rc = _send_or_cache( p, wsSessId, msg, msgByteN );
else
{
for(unsigned i=0; i<p->sessN; ++i)
rc = _send_or_cache( p, p->sessA[i], msg, msgByteN );
}
}
return rc;
}
// terminating condition for format_attributes()
void _create_attributes( ele_t* e )
{ }
template<typename T, typename... ARGS>
void _create_attributes(ele_t* e, const char* label, T value, ARGS&&... args)
{
e->attr->insert_pair(label,value);
_create_attributes(e,std::forward<ARGS>(args)...);
}
bool _has_attribute( ele_t* e, const char* label )
{ return e->attr->find_child(label) != nullptr; }
template< typename T >
rc_t _set_attribute( ele_t* e, const char* label, const T& value )
{
object_t* pair_value;
if((pair_value = e->attr->find(label)) == nullptr )
_create_attributes(e,label,value);
else
pair_value->set_value(value);
return kOkRC;
}
template< typename T >
rc_t _get_attribute( ele_t* e, const char* label, T& valueRef )
{
rc_t rc = kOkRC;
const object_t* pair_value;
if((pair_value = e->attr->find(label)) == nullptr )
{
rc = cwLogError(kInvalidIdRC,"Unable to locate the UI element attribute '%s' on uuid:%i.",cwStringNullGuard(label),e->uuId);
goto errLabel;
}
rc = pair_value->value(valueRef);
errLabel:
return rc;
}
// Convert the ele_t 'attr' object into the attributes for a JSON message.
unsigned _format_attributes( char* buf, unsigned n, unsigned i, ele_t* ele )
{
assert( ele->attr != nullptr );
for(unsigned j=0; j<ele->attr->child_count() && i<n; ++j)
{
object_t* ch = ele->attr->child_ele(j);
i += toText(buf+i, n-i, ",\"" );
i += toText(buf+i, n-i, ch->pair_label() );
i += toText(buf+i, n-i, "\":" );
i += ch->pair_value()->to_string( buf+i, n-i );
}
return i;
}
rc_t _transmitOneEle( ui_t* p, unsigned wsSessId, ele_t* ele )
{
rc_t rc = kOkRC;
assert( ele != nullptr );
assert( ele->phys_parent != nullptr );
unsigned i = snprintf( p->buf, p->bufN,
"{ \"op\":\"create\", \"parentUuId\":\"%i\", \"eleName\":\"%s\", \"appId\":\"%i\", \"uuId\":%i ",
ele->phys_parent->uuId,
ele->eleName==nullptr ? "" : ele->eleName,
ele->appId,
ele->uuId );
// add the UI specific attributes
i += _format_attributes(p->buf+i, p->bufN-i, 0, ele);
// terminate the message
i += toText(p->buf+i, p->bufN-i, "}");
if( i >= p->bufN )
return cwLogError(kBufTooSmallRC,"The UI message formatting buffer is too small. (size:%i bytes)", p->bufN);
//printf("%s\n",p->buf);
// send the message
rc = _websockSend( p, wsSessId, p->buf );
return rc;
}
rc_t _transmitTree( ui_t* p, unsigned wsSessId, ele_t* ele )
{
rc_t rc;
// transmit the parent (unelss 'ele' is the root
if(ele->uuId == kRootUuId || (rc = _transmitOneEle(p,wsSessId,ele)) == kOkRC )
{
// Transmit each of the children to the remote UI's.
// Note that this requires going through all the nodes and picking out the ones whose
// parent uuid matches the current ele's uuid
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->uuId != kRootUuId && p->eleA[i]->uuId != ele->uuId && p->eleA[i]->phys_parent->uuId == ele->uuId )
if((rc = _transmitTree(p,wsSessId,p->eleA[i]))!=kOkRC )
break;
}
return rc;
}
unsigned _find_and_available_element_slot( ui_t* p )
{
if( p->eleN < p->eleAllocN && p->eleA[ p->eleN ] == nullptr )
return p->eleN;
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] == nullptr )
return i;
return p->eleN;
}
// Create the base element record. The attributes mut be filled in by the calling function.
// Note that if 'appId' is kInvalidId then this function will attempt to lookup the appId in p->appIdMap[].
ele_t* _createBaseEle( ui_t* p, ele_t* parent, unsigned appId, unsigned chanId, const char* eleName, const char* eleTypeStr=nullptr, const char* eleClass=nullptr, const char* eleTitle=nullptr )
{
ele_t* e = mem::allocZ<ele_t>();
ele_t* logical_parent = nullptr;
// Go up the tree looking for the first parent with a valid appId.
// The logical parent is the first ancestor element that has a valid 'appId'.
// This is useful to cover the situation where the parent is an unamed div (e.g. row, col, panel)
// and the appIdMap gives the panel name as the parent.
if( parent != nullptr )
{
for(ele_t* par=parent; par!=nullptr; par=par->phys_parent)
if( par->appId != kInvalidId )
{
logical_parent = par;
break;
}
}
assert( appId == kRootAppId || logical_parent != nullptr ); // because the root always has a valid appid
e->phys_parent = parent;
e->logical_parent = logical_parent;
e->appId = appId;
e->chanId = chanId;
e->eleName = eleName==nullptr ? nullptr : mem::duplStr(eleName);
e->attr = newDictObject();
if( eleTypeStr != nullptr )
e->attr->insert_pair("type",eleTypeStr);
if( eleClass != nullptr )
e->attr->insert_pair("className",eleClass);
if( eleTitle != nullptr )
e->attr->insert_pair("title",eleTitle);
// elements default to visible and enabled
e->attr->insert_pair("visible",true);
e->attr->insert_pair("enable",true);
// locate the next available element in p->eleA[]
unsigned avail_ele_idx = _find_and_available_element_slot(p);
// if there are no available slots
if( avail_ele_idx == p->eleAllocN )
{
p->eleAllocN *= 2;
p->eleA = mem::resizeZ<ele_t*>(p->eleA,p->eleAllocN);
}
assert( avail_ele_idx <= p->eleN && p->eleAllocN > avail_ele_idx );
// assign the new element to a slot in p->eleA[]
p->eleA[ avail_ele_idx ] = e;
// the ele uuid is the same as it's index in p->eleA[]
e->uuId = avail_ele_idx;
// track the count of elements in p->eleA[]
if( avail_ele_idx == p->eleN )
p->eleN += 1;
// if the given appId was not valid ...
if( appId == kInvalidId && parent != nullptr && eleName != nullptr )
{
appIdMapRecd_t* m;
// ... then try to look it up from the appIdMap.
if((m = _findAppIdMap(p, e->logical_parent->appId, eleName)) != nullptr )
e->appId = m->appId;
}
_store_ele_in_hash_table(p, e );
//printf("uuid:%i appId:%i par-uuid:%i %s\n", e->uuId,e->appId,e->parent==nullptr ? -1 : e->parent->uuId, cwStringNullGuard(e->eleName));
return e;
}
template< typename... ARGS>
rc_t _createOneEle( ui_t* p, unsigned& uuIdRef, const char* eleTypeStr, unsigned wsSessId, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, ARGS&&... args )
{
rc_t rc = kOkRC;
ele_t* newEle = nullptr;
ele_t* parentEle = nullptr;
uuIdRef = kInvalidId;
if( parentUuId == kInvalidId )
parentUuId = kRootUuId;
// get the parent element
if(( parentEle = _uuIdToEle(p, parentUuId )) == nullptr )
return cwLogError( kInvalidArgRC, "Unable to locate the parent element (id:%i).", parentUuId );
// create the base element
newEle = _createBaseEle(p, parentEle, appId, chanId, eleName, eleTypeStr, clas, title );
// create the attributes
_create_attributes(newEle, std::forward<ARGS>(args)...);
uuIdRef = newEle->uuId;
rc = _transmitOneEle(p, wsSessId, newEle);
return rc;
}
rc_t _createElementsFromChildList( ui_t* p, const object_t* po, unsigned wsSessId, ele_t* parentEle, unsigned chanId );
rc_t _createEleFromRsrsc( ui_t* p, ele_t* parentEle, const char* eleType, unsigned chanId, const object_t* srcObj, unsigned wsSessId )
{
rc_t rc = kOkRC;
object_t* co = nullptr;
ele_t* ele = nullptr;
char* eleName = nullptr;
object_t* o = srcObj->duplicate(); // duplicate the rsrc object so that we can modify it.
bool divAliasFl = false;
if( !o->is_dict() )
return cwLogError(kSyntaxErrorRC,"All ui element resource records must be dictionaries.");
// if this object has a 'children' list then unlink it and save it for later
if((co = o->find("children", kOptionalFl)) != nullptr )
{
co = co->parent;
co->unlink();
}
divAliasFl = _isEleTypeDiv(eleType);
// get the ui ele name
if((rc = o->get("name",eleName, cw::kOptionalFl)) != kOkRC )
{
// div's and titles don't need a 'name'
if( rc == kEleNotFoundRC && (divAliasFl || textCompare(eleType,"label")==0) )
rc = kOkRC;
else
{
rc = cwLogError(rc,"The UI element 'name' could not be read.");
goto errLabel;
}
}
// get or create the ele record to associate with this ele
if((ele = _createBaseEle(p, parentEle, kInvalidId, chanId, eleName, eleType, nullptr, nullptr)) == nullptr )
{
rc = cwLogError(kOpFailRC,"The local element '%s' could not be created.",cwStringNullGuard(eleName));
goto errLabel;
}
else
{
unsigned childN = o->child_count();
unsigned child_idx = 0;
// transfer the attributes of this resource object to ele->attr
for(unsigned i=0; i<childN; ++i)
{
object_t* child = o->child_ele(child_idx);
const char* pair_label = child->pair_label();
//if( textCompare(eleType,"list")==0 )
// printf("%i list: %s %i\n",i,pair_label,o->child_count());
// skip the 'name' attribute any child notes that refer to child elements
if( textIsEqual(pair_label,"name") || _isEleTypeLabel(pair_label) )
child_idx += 1;
else
{
child->unlink();
ele->attr->append_child(child);
}
}
}
_transmitOneEle(p,wsSessId,ele);
// if this element has a list of children then create them here
if( co != nullptr || divAliasFl )
{
// Note that 'div's need not have an explicit 'children' node.
// Any child node of a 'div' with a dictionary as a value is a child control.
const object_t* childL = co!=nullptr ? co->pair_value() : srcObj;
rc = _createElementsFromChildList(p, childL, wsSessId, ele, chanId );
}
errLabel:
if( co != nullptr )
co->free();
if( o != nullptr )
o->free();
return rc;
}
// 'po' is an object dictionary where each pair in the dictionary has
// the form: 'eleType':{ <object> }
rc_t _createElementsFromChildList( ui_t* p, const object_t* po, unsigned wsSessId, ele_t* parentEle, unsigned chanId )
{
rc_t rc = kOkRC;
if( !po->is_dict() )
return cwLogError(kSyntaxErrorRC,"All UI resource elements must be containers.");
unsigned childN = po->child_count();
for(unsigned i=0; i<childN; ++i)
{
const object_t* o = po->child_ele(i);
if( !o->is_pair() )
return cwLogError(kSyntaxErrorRC,"All object dictionary children must be pairs.");
// skip pairs whose value is not a dict
if( o->pair_value()->is_dict() )
{
if((rc = _createEleFromRsrsc(p, parentEle, o->pair_label(), chanId, o->pair_value(), wsSessId )) != kOkRC )
return rc;
}
}
return rc;
}
// This functions assumes that parentUuId is valid or the cfg object 'o' contains a field named: 'parent'
// which contains the element name of the parent node.
rc_t _createFromObj( ui_t* p, const object_t* o, unsigned wsSessId, unsigned parentUuId, unsigned chanId )
{
rc_t rc = kOkRC;
const object_t* po = nullptr;
ele_t* parentEle = nullptr;
char* eleName = nullptr;
if( parentUuId == kInvalidId )
{
// locate the the 'parent' ele name value object
if((po = o->find("parent",kOptionalFl)) == nullptr )
return cwLogError(kSyntaxErrorRC,"UI resources must have a root 'parent' value.");
// get the parent element name
if((rc = po->value(eleName)) != kOkRC )
return cwLogError(kOpFailRC,"The root 'parent' value could not be accessed.");
// find the parent element
parentEle = _eleNameToEle( p, eleName );
}
else
{
// find the parent element
parentEle = _uuIdToEle(p,parentUuId);
}
if(parentEle == nullptr )
return cwLogError(kSyntaxErrorRC,"A parent UI element named '%s' could not be found.",cwStringNullGuard(eleName));
rc = _createElementsFromChildList( p, o, wsSessId, parentEle, chanId );
return rc;
}
// value message format: 'value' <uuid> <value_data_type> ':' <value>
ele_t* _parse_value_msg( ui_t* p, value_t& valueRef, const char* msg )
{
rc_t rc = kOkRC;
char argType = 0;
ele_t* ele = nullptr;
unsigned eleUuId = kInvalidId;
valueRef.tid = kInvalidTId;
if( msg == nullptr )
{
cwLogWarning("Empty 'value' message received from UI.");
return nullptr;
}
// locate the colon prior to the value
const char* s = strchr(msg,':');
if( s == nullptr || sscanf(msg, "value %i %c ",&eleUuId,&argType) != 2 )
{
cwLogError(kSyntaxErrorRC,"Invalid 'value' message from UI: '%s'.", msg );
goto errLabel;
}
// advance s past the colon
s += 1;
// parse the argument
switch( argType )
{
case 'b':
if((rc = string_to_number<bool>(s,valueRef.u.b)) == kOkRC )
valueRef.tid = kBoolTId;
break;
case 'i':
if((rc = string_to_number<int>(s,valueRef.u.i)) == kOkRC )
valueRef.tid = kIntTId;
break;
case 'u':
if((rc = string_to_number<unsigned>(s,valueRef.u.u)) == kOkRC )
valueRef.tid = kUIntTId;
break;
case 'f':
if((rc = string_to_number<float>(s,valueRef.u.f)) == kOkRC )
valueRef.tid = kFloatTId;
break;
case 'd':
if((rc = string_to_number<double>(s,valueRef.u.d)) == kOkRC )
valueRef.tid = kDoubleTId;
break;
case 's':
if((valueRef.u.s = nextNonWhiteChar(s)) != nullptr )
valueRef.tid = kStringTId;
break;
default:
rc = cwLogError(kInvalidIdRC,"Unknown value type '%c' in message from UI.", argType );
goto errLabel;
}
// locate the element record
if((ele = _uuIdToEle( p, eleUuId )) == nullptr )
{
cwLogError(kInvalidIdRC,"UI message elment not found.");
goto errLabel;
}
errLabel:
return ele;
}
ele_t* _parse_corrupt_msg( ui_t* p, const char* msg )
{
ele_t* ele = nullptr;
unsigned eleUuId = kInvalidId;
if( msg == nullptr )
{
cwLogWarning("Empty 'corrupt' message received from UI.");
return nullptr;
}
//
if( sscanf(msg, "corrupt %i ",&eleUuId) != 1 )
{
cwLogError(kSyntaxErrorRC,"Invalid 'corrupt' message from UI: '%s'.", msg );
goto errLabel;
}
// locate the element record
if((ele = _uuIdToEle( p, eleUuId )) == nullptr )
{
cwLogError(kInvalidIdRC,"UI message elment not found.");
goto errLabel;
}
errLabel:
return ele;
}
ele_t* _parse_click_msg( ui_t* p, const char* msg )
{
ele_t* ele = nullptr;
unsigned eleUuId = kInvalidId;
if( msg == nullptr )
{
cwLogWarning("Empty click message received from UI.");
return nullptr;
}
//
if( sscanf(msg, "click %i ",&eleUuId) != 1 )
{
cwLogError(kSyntaxErrorRC,"Invalid 'click' message from UI: '%s'.", msg );
goto errLabel;
}
// locate the element record
if((ele = _uuIdToEle( p, eleUuId )) == nullptr )
{
cwLogError(kInvalidIdRC,"UI message elment not found.");
goto errLabel;
}
errLabel:
return ele;
}
ele_t* _parse_select_msg( ui_t* p, value_t& valueRef, const char* msg )
{
ele_t* ele = nullptr;
unsigned eleUuId = kInvalidId;
unsigned selectFl = 0;
if( msg == nullptr )
{
cwLogWarning("Empty select message received from UI.");
return nullptr;
}
//
if( sscanf(msg, "select %i %i",&eleUuId,&selectFl) != 2 )
{
cwLogError(kSyntaxErrorRC,"Invalid 'select' message from UI: '%s'.", msg );
goto errLabel;
}
// locate the element record
if((ele = _uuIdToEle( p, eleUuId )) == nullptr )
{
cwLogError(kInvalidIdRC,"UI message elment not found.");
goto errLabel;
}
valueRef.u.b = selectFl ? true : false;
errLabel:
return ele;
}
ele_t* _parse_echo_msg( ui_t* p, const char* msg )
{
unsigned eleUuId = kInvalidId;
ele_t* ele = nullptr;
if( sscanf(msg, "echo %i",&eleUuId) != 1 )
{
cwLogError(kSyntaxErrorRC,"Invalid message from UI: '%s'.", msg );
goto errLabel;
}
// locate the element record
if((ele = _uuIdToEle( p, eleUuId )) == nullptr )
{
cwLogError(kInvalidIdRC,"UI message elment not found.");
goto errLabel;
}
errLabel:
return ele;
}
opId_t _labelToOpId( const char* label )
{
typedef struct
{
opId_t id;
const char* label;
} map_t;
map_t mapA[] =
{
{ kConnectOpId, "connect" },
{ kInitOpId, "init" },
{ kValueOpId, "value" },
{ kCorruptOpId, "corrupt" },
{ kClickOpId, "click" },
{ kSelectOpId, "select" },
{ kEchoOpId, "echo" },
{ kIdleOpId, "idle" },
{ kDisconnectOpId, "disconnect" },
{ kInvalidOpId, "<invalid>" },
};
for(unsigned i=0; mapA[i].id != kInvalidOpId; ++i)
if( textCompare(label,mapA[i].label,strlen(mapA[i].label)) == 0 )
return mapA[i].id;
return kInvalidOpId;
}
template< typename T >
rc_t _sendValue( ui_t* p, unsigned wsSessId, unsigned uuId, const char* vFmt, const T& value, const char* opStr="value", int vbufN=32 )
{
rc_t rc = kOkRC;
if( p->sendCbFunc != nullptr )
{
const char* mFmt = "{ \"op\":\"%s\", \"uuId\":%i, \"value\":%s }";
const int mbufN = 1024;
char vbuf[vbufN];
char mbuf[mbufN];
if( snprintf(vbuf,vbufN,vFmt,value) >= vbufN-1 )
return cwLogError(kBufTooSmallRC,"The value msg buffer is too small.");
if( snprintf(mbuf,mbufN,mFmt,opStr,uuId,vbuf) >= mbufN-1 )
return cwLogError(kBufTooSmallRC,"The msg buffer is too small.");
_websockSend(p,wsSessId,mbuf);
}
return rc;
}
rc_t _sendValue( ui_t* p, unsigned wsSessId, unsigned uuId, const value_t& value )
{
rc_t rc = kOkRC;
switch( value.tid )
{
case kBoolTId:
rc = _sendValue<int>(p,wsSessId,uuId,"%i",value.u.b?1:0);
break;
case kIntTId:
rc = _sendValue<int>(p,wsSessId,uuId,"%i",value.u.i);
break;
case kUIntTId:
rc = _sendValue<unsigned>(p,wsSessId,uuId,"%i",value.u.u);
break;
case kFloatTId:
rc = _sendValue<float>(p,wsSessId,uuId,"%f",value.u.f);
break;
case kDoubleTId:
rc = _sendValue<double>(p,wsSessId,uuId,"%f",value.u.d);
break;
case kStringTId:
rc = _sendValue<const char*>(p,kInvalidId,uuId,"\"%s\"",value.u.s,"value",strlen(value.u.s)+10);
break;
default:
assert(0);
}
return rc;
}
void _reflect_value_msg( ui_t* p, unsigned wsSessId, ele_t* ele, const value_t& value )
{
// send a 'value' message to all sessions except 'wsSessId'.
for(unsigned i=0; i<p->sessN; ++i)
if( p->sessA[i] != wsSessId )
_sendValue(p,p->sessA[i],ele->uuId, value );
}
rc_t _onNewRemoteUi( ui_t* p, unsigned wsSessId )
{
rc_t rc = kOkRC;
ele_t* rootEle;
if((rootEle = _uuIdToEle(p, kRootUuId)) == nullptr )
{
rc = cwLogError(kInvalidStateRC,"Unable to locate the UI root element.");
goto errLabel;
}
_transmitTree(p,wsSessId,rootEle);
errLabel:
return rc;
}
template< typename T >
rc_t _setPropertyValue( handle_t h, const char* propertyStr, unsigned uuId, const T& value )
{
ui_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
ele_t* ele = nullptr;
const char* mFmt = "{ \"op\":\"set\", \"type\":\"%s\", \"uuId\":%i, \"value\":%i }";
const int mbufN = 256;
char mbuf[mbufN];
if( snprintf(mbuf,mbufN,mFmt,propertyStr,uuId,value) >= mbufN-1 )
{
rc = cwLogError(kBufTooSmallRC,"The msg buffer is too small.");
goto errLabel;
}
if((ele = _uuIdToEle(p,uuId)) == nullptr )
{
rc = kInvalidIdRC;
goto errLabel;
}
if((rc = _set_attribute(ele,propertyStr,value)) != kOkRC )
{
cwLogError(rc,"Property assignment failed.");
goto errLabel;
}
if((rc = _websockSend(p,kInvalidId,mbuf)) != kOkRC )
{
cwLogError(rc,"'%s' msg transmit failed.",propertyStr);
goto errLabel;
}
errLabel:
if( rc != kOkRC )
rc = cwLogError(rc,"Set '%s' failed.",propertyStr);
return rc;
}
rc_t _setPropertyFlag( handle_t h, const char* propertyStr, unsigned uuId, bool enableFl )
{
return _setPropertyValue( h, propertyStr,uuId,enableFl ? 1 : 0 );
}
rc_t _copy_msg_to_recv_buffer( ui_t* p, const void* msg, unsigned msgByteN )
{
if( msg == nullptr || msgByteN == 0)
return kOkRC;
if( p->recvBufIdx + msgByteN > p->recvBufN )
return cwLogError(kBufTooSmallRC,"The UI input buffer (%i) is too small.", p->recvBufN);
memcpy(p->recvBuf + p->recvBufIdx, msg, msgByteN );
p->recvBufIdx += msgByteN;
return kOkRC;
}
const char* _get_msg_from_recv_buffer( ui_t* p )
{
const char* msg = nullptr;
unsigned i;
// shift off the previous msg
if( p->recvShiftN > 0 )
{
assert( p->recvBufIdx >= p->recvShiftN );
memmove(p->recvBuf, p->recvBuf+p->recvShiftN, p->recvBufIdx - p->recvShiftN );
p->recvBufIdx -= p->recvShiftN;
p->recvShiftN = 0;
}
// locate the end of the next msg.
if( p->recvBufIdx > 0 )
{
for(i=0; p->recvBuf[i]!=0 and i<p->recvBufIdx; ++i)
{}
// if the end of the next msg was found
if( i<p->recvBufIdx && p->recvBuf[i] == 0 )
{
p->recvShiftN = i+1;
msg = p->recvBuf;
}
}
return msg;
}
}
}
cw::rc_t cw::ui::create(
handle_t& h,
sendCallback_t sendCbFunc,
void* sendCbArg,
uiCallback_t uiCbFunc,
void* uiCbArg,
const object_t* uiRsrc,
const appIdMap_t* appIdMapA,
unsigned appIdMapN,
unsigned fmtBufByteN )
{
rc_t rc = kOkRC;
ele_t* ele;
if((rc = destroy(h)) != kOkRC )
return rc;
if( sendCbFunc == nullptr )
return cwLogError(kInvalidArgRC,"The UI send callback function must be a valid pointer.");
if( uiCbFunc == nullptr )
return cwLogError(kInvalidArgRC,"The UI callback function must be a valid pointer.");
ui_t* p = mem::allocZ<ui_t>();
p->eleAllocN = 1024;
p->eleA = mem::allocZ<ele_t*>( p->eleAllocN );
p->eleN = 0;
p->uiCbFunc = uiCbFunc;
p->uiCbArg = uiCbArg;
p->sendCbFunc = sendCbFunc;
p->sendCbArg = sendCbArg;
p->buf = mem::allocZ<char>(fmtBufByteN);
p->bufN = fmtBufByteN;
p->recvBuf = mem::allocZ<char>(fmtBufByteN);
p->recvBufN = fmtBufByteN;
p->recvBufIdx = 0;
p->recvShiftN = 0;
p->uiRsrc = uiRsrc->duplicate();
p->msgCacheSessId = kInvalidId;
// create the root element
if((ele = _createBaseEle(p, nullptr, kRootAppId, kInvalidId, "uiDivId" )) == nullptr || ele->uuId != kRootUuId )
{
cwLogError(kOpFailRC,"The UI root element creation failed.");
goto errLabel;
}
// register any supplied appId maps
if((rc = _registerAppIdMap(p,appIdMapA,appIdMapN)) != kOkRC )
goto errLabel;
if( uiRsrc != nullptr )
{
const object_t* main_obj = nullptr;
if((main_obj = uiRsrc->find( "main")) == nullptr )
cwLogWarning("The UI resource does not have a 'main' element.");
else
if((rc = _createFromObj( p, main_obj, kInvalidId, kRootUuId, kInvalidId )) != kOkRC )
{
rc = cwLogError(rc,"Create from UI resource failed.");
goto errLabel;
}
}
h.set(p);
errLabel:
if( rc != kOkRC )
{
_destroy(p);
}
return rc;
}
cw::rc_t cw::ui::destroy( handle_t& h )
{
rc_t rc = kOkRC;
if( !h.isValid() )
return rc;
ui_t* p = _handleToPtr(h);
if((rc = _destroy(p)) != kOkRC )
return rc;
h.clear();
return rc;
}
cw::rc_t cw::ui::enableCache( handle_t h, unsigned cacheByteCnt )
{
ui_t* p = _handleToPtr(h);
p->msgCacheEnableFl = true;
p->msgCacheAllocN = cacheByteCnt;
return kOkRC;
}
cw::rc_t cw::ui::flushCache( handle_t h )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
if( p->msgCacheEnableFl && p->msgCache != nullptr )
rc =_cache_flush(p);
return rc;
}
unsigned cw::ui::sessionIdCount(handle_t h)
{
ui_t* p = _handleToPtr(h);
return p->sessN;
}
const unsigned* cw::ui::sessionIdArray(handle_t h)
{
ui_t* p = _handleToPtr(h);
return p->sessA;
}
cw::rc_t cw::ui::onConnect( handle_t h, unsigned wsSessId )
{
ui_t* p = _handleToPtr(h);
// if the session id array is full ...
if( p->sessN == p->sessAllocN )
{
// ... then expand it
p->sessAllocN += 16;
p->sessA = mem::resizeZ<unsigned>(p->sessA,p->sessAllocN);
}
// append the new session id
p->sessA[p->sessN++] = wsSessId;
p->uiCbFunc( p->uiCbArg, wsSessId, kConnectOpId, kInvalidId, kInvalidId, kInvalidId, kInvalidId, nullptr );
return kOkRC;
}
cw::rc_t cw::ui::onDisconnect( handle_t h, unsigned wsSessId )
{
ui_t* p = _handleToPtr(h);
p->uiCbFunc( p->uiCbArg, wsSessId, kDisconnectOpId, kInvalidId, kInvalidId, kInvalidId, kInvalidId, nullptr );
// erase the disconnected session id by shrinking the array
for(unsigned i=0; i<p->sessN; ++i)
if( p->sessA[i] == wsSessId )
{
for(; i+1<p->sessN; ++i)
p->sessA[i] = p->sessA[i+1];
p->sessN -= 1;
break;
}
return kOkRC;
}
cw::rc_t cw::ui::onReceive( handle_t h, unsigned wsSessId, const void* void_msg, unsigned msgByteN )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
opId_t opId = kInvalidOpId;
ele_t* ele = nullptr;
const char* msg = nullptr;
value_t value;
/*
const char* src_msg = (const char*)void_msg;
const char* msg = src_msg;
// if the incoming message is valid
if( msgByteN > 0 and src_msg != nullptr )
{
// if there is a partial msg in the recv buffer (recvBufIdx!=0)
// or the incoming message is a partial mesg - then buffer the message
// (Note: incoming messages that are not zero terminated are partial.")
if( p->recvBufIdx != 0 || src_msg[msgByteN-1] != 0 )
{
// verify the buffer is large enough to hold the msg
if(p->recvBufIdx + msgByteN > p->recvBufN )
{
rc = cwLogError(kOpFailRC,"The UI input buffer (%i) is too small.", p->recvBufN);
p->recvBufIdx = 0;
}
else
{
// update it with the incoming text
strncpy( p->recvBuf + p->recvBufIdx, src_msg, msgByteN );
p->recvBufIdx += msgByteN;
msg = p->recvBuf;
}
}
// if the incoming message is not zero terminated then it was a partial
// message it was buffered and there is nothing else to do.
if( src_msg[msgByteN-1] != 0)
return rc;
}
// the message is being processed so the buffer will end up empty
// (if it was being used)
p->recvBufIdx = 0;
*/
// buffer the incoming msg
if((rc = _copy_msg_to_recv_buffer( p, void_msg, msgByteN )) != kOkRC )
goto errLabel;
// remove and and act on each buffered msg
while( (msg = _get_msg_from_recv_buffer(p)) != NULL )
{
p->recvMsgN += 1;
// parse the 'opId' from the message
opId = _labelToOpId(msg);
switch( opId )
{
case kInitOpId:
// if the app cfg included a reference to a UI resource file then instantiate it here
_onNewRemoteUi( p, wsSessId );
// Pass on the 'init' msg to the app.
p->uiCbFunc( p->uiCbArg, wsSessId, opId, kInvalidId, kInvalidId, kInvalidId, kInvalidId, nullptr );
break;
case kValueOpId:
if((ele = _parse_value_msg(p, value, (const char*)msg )) == nullptr )
cwLogError(kOpFailRC,"UI 'value' message parse failed.");
else
{
p->uiCbFunc( p->uiCbArg, wsSessId, opId, ele->logical_parent->appId, ele->uuId, ele->appId, ele->chanId, &value );
// reflect the UI element value state to other wsSessions
_reflect_value_msg( p, wsSessId, ele, value );
}
break;
case kCorruptOpId:
if((ele = _parse_corrupt_msg(p, (const char*)msg )) == nullptr )
cwLogError(kOpFailRC,"UI 'corrupt' message parse failed.");
else
p->uiCbFunc( p->uiCbArg, wsSessId, opId, ele->logical_parent->appId, ele->uuId, ele->appId, ele->chanId, &value );
break;
case kClickOpId:
if((ele = _parse_click_msg(p, (const char*)msg )) == nullptr )
cwLogError(kOpFailRC,"UI 'click' message parse failed.");
else
{
p->uiCbFunc( p->uiCbArg, wsSessId, opId, ele->logical_parent->appId, ele->uuId, ele->appId, ele->chanId, &value );
}
break;
case kSelectOpId:
if((ele = _parse_select_msg(p, value, (const char*)msg )) == nullptr )
cwLogError(kOpFailRC,"UI 'select' message parse failed.");
else
{
p->uiCbFunc( p->uiCbArg, wsSessId, opId, ele->logical_parent->appId, ele->uuId, ele->appId, ele->chanId, &value );
}
break;
case kEchoOpId:
if((ele = _parse_echo_msg(p,(const char*)msg)) == nullptr )
cwLogError(kOpFailRC,"UI Echo message parse failed.");
else
{
p->uiCbFunc( p->uiCbArg, wsSessId, opId, ele->logical_parent->appId, ele->uuId, ele->appId, ele->chanId,nullptr );
}
break;
case kIdleOpId:
p->uiCbFunc( p->uiCbArg, kInvalidId, opId, kInvalidId, kInvalidId, kInvalidId, kInvalidId, nullptr );
break;
case kInvalidOpId:
cwLogError(kInvalidIdRC,"The UI received a NULL op. id.");
break;
default:
cwLogError(kInvalidIdRC,"The UI received an unknown op. id.");
break;
} // switch opId
}
errLabel:
return rc;
}
unsigned cw::ui::parentAndNameToAppId( handle_t h, unsigned parentAppId, const char* eleName )
{
ui_t* p = _handleToPtr(h);
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->logical_parent->appId==parentAppId && strcmp(p->eleA[i]->eleName,eleName) == 0 )
return p->eleA[i]->appId;
return kInvalidId;
}
unsigned cw::ui::parentAndNameToUuId( handle_t h, unsigned parentAppId, const char* eleName )
{
ui_t* p = _handleToPtr(h);
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->logical_parent->appId==parentAppId && strcmp(p->eleA[i]->eleName,eleName) == 0 )
return p->eleA[i]->uuId;
return kInvalidId;
}
unsigned cw::ui::parentAndAppIdToUuId( handle_t h, unsigned parentAppId, unsigned appId )
{
ui_t* p = _handleToPtr(h);
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr )
if(((p->eleA[i]->phys_parent==nullptr && parentAppId==kRootAppId) ||
(p->eleA[i]->logical_parent!=nullptr && p->eleA[i]->logical_parent->appId==parentAppId))
&& p->eleA[i]->appId == appId )
return p->eleA[i]->uuId;
return kInvalidId;
}
const char* cw::ui::findElementName( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
return _findEleEleName(p,uuId);
}
unsigned cw::ui::findElementAppId( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele = _uuIdToEle( p, uuId );
return ele==nullptr ? kInvalidId : ele->uuId;
}
unsigned cw::ui::findElementUuId( handle_t h, const char* eleName, unsigned chanId )
{
ui_t* p = _handleToPtr(h);
return _findElementUuId(p,kInvalidId,eleName,chanId);
}
unsigned cw::ui::findElementUuId( handle_t h, unsigned appId, unsigned chanId )
{
ui_t* p = _handleToPtr(h);
return _findElementUuId(p,kInvalidId,appId,chanId);
}
unsigned cw::ui::findElementUuId( handle_t h, unsigned parentUuId, const char* eleName, unsigned chanId )
{
ui_t* p = _handleToPtr(h);
return _findElementUuId(p,parentUuId, eleName,chanId);
}
unsigned cw::ui::findElementUuId( handle_t h, unsigned parentUuId, unsigned appId, unsigned chanId )
{
ui_t* p = _handleToPtr(h);
return _findElementUuId(p,parentUuId,appId,chanId);
}
cw::rc_t cw::ui::createFromObject( handle_t h, const object_t* o, unsigned parentUuId, unsigned chanId, const char* cfgFieldName )
{
ui_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
//ele_t* parentEle = nullptr;
if( cfgFieldName != nullptr )
if((o = o->find(cfgFieldName)) == nullptr )
{
rc = cwLogError(kSyntaxErrorRC,"Unable to locate the '%s' sub-configuration.",cwStringNullGuard(cfgFieldName));
goto errLabel;
}
if((rc = _createFromObj( p, o, kInvalidId, parentUuId, chanId )) != kOkRC )
goto errLabel;
errLabel:
if(rc != kOkRC )
rc = cwLogError(rc,"UI instantiation from object failed.");
return rc;
}
cw::rc_t cw::ui::createFromFile( handle_t h, const char* fn, unsigned parentUuId, unsigned chanId)
{
ui_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
object_t* o = nullptr;
if((rc = objectFromFile( fn, o )) != kOkRC )
goto errLabel;
if((rc = _createFromObj( p, o, kInvalidId, parentUuId, chanId )) != kOkRC )
goto errLabel;
errLabel:
if(rc != kOkRC )
rc = cwLogError(rc,"UI instantiation from the configuration file '%s' failed.", cwStringNullGuard(fn));
if( o != nullptr )
o->free();
return rc;
}
cw::rc_t cw::ui::createFromText( handle_t h, const char* text, unsigned parentUuId, unsigned chanId )
{
ui_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
object_t* o = nullptr;
if((rc = objectFromString( text, o )) != kOkRC )
goto errLabel;
if((rc = _createFromObj( p, o, kInvalidId, parentUuId, chanId )) != kOkRC )
goto errLabel;
errLabel:
if(rc != kOkRC )
rc = cwLogError(rc,"UI instantiation failed from the configuration from string: '%s'.", cwStringNullGuard(text));
if( o != nullptr )
o->free();
return rc;
}
cw::rc_t cw::ui::createFromRsrc( handle_t h, const char* label, unsigned parentUuId, unsigned chanId)
{
ui_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
if( p->uiRsrc == nullptr )
rc = cwLogError(kInvalidStateRC,"The UI resource '%s' was not found because the UI sub-system was not given a resource file.",cwStringNullGuard(label));
else
rc = createFromObject( h, p->uiRsrc, parentUuId, chanId, label );
return rc;
}
cw::rc_t cw::ui::createDiv( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "div", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createLabel( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "label", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createButton( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "button", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createCheck( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "check", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createCheck( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, bool value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "check", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "value", value ); }
cw::rc_t cw::ui::createSelect( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "select", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createOption( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "option", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createStrDisplay( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "str_disp", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createStrDisplay( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, const char* value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "str_disp", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "value", value ); }
cw::rc_t cw::ui::createStr( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "string", kInvalidId, parentUuId, eleName, appId, chanId, clas, title ); }
cw::rc_t cw::ui::createStr( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, const char* value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "string", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "value", value ); }
cw::rc_t cw::ui::createNumbDisplay( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, unsigned decpl )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "numb_disp", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "decpl", decpl ); }
cw::rc_t cw::ui::createNumbDisplay( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, unsigned decpl, double value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "numb_disp", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "decpl", decpl, "value", value ); }
cw::rc_t cw::ui::createNumb( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, double minValue, double maxValue, double stepValue, unsigned decpl )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "number", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "min", minValue, "max", maxValue, "step", stepValue, "decpl", decpl ); }
cw::rc_t cw::ui::createNumb( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, double minValue, double maxValue, double stepValue, unsigned decpl, double value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "number", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "min", minValue, "max", maxValue, "step", stepValue, "decpl", decpl, "value", value ); }
cw::rc_t cw::ui::createProg( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, double minValue, double maxValue )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "progress", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "min", minValue, "max", maxValue ); }
cw::rc_t cw::ui::createProg( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title, double minValue, double maxValue, double value )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "progress", kInvalidId, parentUuId, eleName, appId, chanId, clas, title, "value", value, "min", minValue, "max", maxValue ); }
cw::rc_t cw::ui::createLog( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "log", kInvalidId, parentUuId, eleName, appId, chanId, clas, title); }
cw::rc_t cw::ui::createVList( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "list", kInvalidId, parentUuId, eleName, appId, chanId, clas, title); }
cw::rc_t cw::ui::createHList( handle_t h, unsigned& uuIdRef, unsigned parentUuId, const char* eleName, unsigned appId, unsigned chanId, const char* clas, const char* title )
{ return _createOneEle( _handleToPtr(h), uuIdRef, "hlist", kInvalidId, parentUuId, eleName, appId, chanId, clas, title); }
cw::rc_t cw::ui::setTitle( handle_t h, unsigned uuId, const char* title )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
const char* mFmt = "{ \"op\":\"set\", \"type\":\"title\", \"uuId\":%i, \"value\":\"%s\" }";
const int mbufN = 256;
char mbuf[mbufN];
if( snprintf(mbuf,mbufN,mFmt,uuId,title) >= mbufN-1 )
return cwLogError(kBufTooSmallRC,"The msg buffer is too small.");
rc = _websockSend(p,kInvalidId,mbuf);
return rc;
}
cw::rc_t cw::ui::setNumbRange( handle_t h, unsigned uuId, double minValue, double maxValue, double stepValue, unsigned decPl, double value )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
const char* mFmt = "{ \"op\":\"set\", \"type\":\"number_range\", \"uuId\":%i, \"min\":%f, \"max\":%f, \"step\":%f, \"decpl\":%i, \"value\":%f }";
const int mbufN = 256;
char mbuf[mbufN];
if( snprintf(mbuf,mbufN,mFmt,uuId,minValue,maxValue,stepValue,decPl,value) >= mbufN-1 )
return cwLogError(kBufTooSmallRC,"The msg buffer is too small.");
rc = _websockSend(p,kInvalidId,mbuf);
return rc;
}
cw::rc_t cw::ui::setProgRange( handle_t h, unsigned uuId, double minValue, double maxValue, double value )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
const char* mFmt = "{ \"op\":\"set\", \"type\":\"progress_range\", \"uuId\":%i, \"min\":%f, \"max\":%f, \"value\":%f }";
const int mbufN = 256;
char mbuf[mbufN];
if( snprintf(mbuf,mbufN,mFmt,uuId,minValue,maxValue,value) >= mbufN-1 )
return cwLogError(kBufTooSmallRC,"The msg buffer is too small.");
rc = _websockSend(p,kInvalidId,mbuf);
return rc;
}
cw::rc_t cw::ui::setLogLine( handle_t h, unsigned uuId, const char* text )
{
rc_t rc = kOkRC;
unsigned n = 0;
const char* c = text;
for(; *c; ++c )
if( *c == '\n')
++n;
if( n == 0 )
rc = sendValueString(h,uuId,text);
else
{
unsigned sn = textLength(text);
sn += n + 1;
// alloc. a lot of extra space to cover the space need for the '\' escape character
char s[ sn*2 ];
unsigned i,j;
for( i=0,j=0; text[i] && j<sn; ++i,++j)
{
char ch = text[i];
bool escape_fl = true;
switch( ch )
{
case '\\': ch='\\'; break;
case '\b': ch='b'; break;
case '\f': ch='f'; break;
case '\n': ch='n'; break;
case '\r': ch='r'; break;
case '\t': ch='t'; break;
default:
escape_fl = false;
break;
}
if( escape_fl )
s[j++] = '\\';
if( j < sn )
s[j] = ch;
}
s[sn-1] = 0;
//printf("%s %s\n",text,s);
rc = sendValueString(h,uuId,s);
}
return rc;
}
cw::rc_t cw::ui::emptyParent( handle_t h, unsigned uuId )
{
rc_t rc = kOkRC;
unsigned childN = elementPhysChildCount(h,uuId);
unsigned* childUuIdA = nullptr;
if( childN > 0 )
{
childUuIdA = mem::alloc<unsigned>(childN);
unsigned actualChildN = 0;
if((rc = elementPhysChildUuId(h,uuId,childUuIdA,childN,actualChildN)) != kOkRC )
goto errLabel;
assert( actualChildN == childN );
for(unsigned i=0; i<childN; ++i)
if((rc = destroyElement(h,childUuIdA[i])) != kOkRC )
{
rc = cwLogError(rc,"Child element destroy failed.");
goto errLabel;
}
}
/*
const char* mFmt = "{ \"op\":\"empty\", \"uuId\":%i }";
const int mbufN = 256;
char mbuf[mbufN];
if( snprintf(mbuf,mbufN,mFmt,uuId) >= mbufN-1 )
{
rc = cwLogError(kBufTooSmallRC,"The msg buffer is too small for 'empty' msg.");
goto errLabel;
}
if((rc = _websockSend(p,kInvalidId,mbuf)) != kOkRC )
{
cwLogError(rc,"'empty' msg transmit failed.");
goto errLabel;
}
*/
errLabel:
mem::release(childUuIdA);
return rc;
}
cw::rc_t cw::ui::setClickable( handle_t h, unsigned uuId, bool clickableFl )
{ return _setPropertyFlag( h, UI_CLICKABLE_LABEL, uuId, clickableFl ); }
cw::rc_t cw::ui::clearClickable( handle_t h, unsigned uuId )
{ return setClickable(h,uuId,false); }
bool cw::ui::isClickable( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele = nullptr;
bool clickableFl = false;
if((ele = _uuIdToEle(p,uuId)) != nullptr )
_get_attribute(ele,UI_CLICKABLE_LABEL,clickableFl);
return clickableFl;
}
cw::rc_t cw::ui::setSelect( handle_t h, unsigned uuId, bool enableFl )
{ return _setPropertyFlag( h, UI_SELECT_LABEL, uuId, enableFl ); }
cw::rc_t cw::ui::clearSelect( handle_t h, unsigned uuId )
{ return setSelect(h,uuId,false); }
bool cw::ui::isSelected( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele = nullptr;
bool selectFl = false;
if((ele = _uuIdToEle(p,uuId)) != nullptr )
_get_attribute(ele,UI_SELECT_LABEL,selectFl);
return selectFl;
}
cw::rc_t cw::ui::setVisible( handle_t h, unsigned uuId, bool enableFl )
{ return _setPropertyFlag( h, UI_VISIBLE_LABEL, uuId, enableFl ); }
cw::rc_t cw::ui::clearVisible( handle_t h, unsigned uuId )
{ return setVisible(h,uuId,false); }
bool cw::ui::isVisible( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele = nullptr;
bool visibleFl = false;
if((ele = _uuIdToEle(p,uuId)) != nullptr )
_get_attribute(ele,UI_VISIBLE_LABEL,visibleFl);
return visibleFl;
}
cw::rc_t cw::ui::setEnable( handle_t h, unsigned uuId, bool enableFl )
{ return _setPropertyFlag( h, UI_ENABLE_LABEL, uuId, enableFl ); }
cw::rc_t cw::ui::clearEnable( handle_t h, unsigned uuId )
{ return setEnable(h,uuId,false); }
bool cw::ui::isEnabled( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele = nullptr;
bool enableFl = false;
if((ele = _uuIdToEle(p,uuId)) != nullptr )
enableFl = _get_attribute(ele,UI_ENABLE_LABEL,enableFl);
return enableFl;
}
cw::rc_t cw::ui::setOrderKey( handle_t h, unsigned uuId, int orderKey )
{ return _setPropertyValue( h, UI_ORDER_LABEL,uuId, orderKey ); }
int cw::ui::getOrderKey( handle_t h, unsigned uuId )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
ele_t* ele = nullptr;
int orderKey = 0;
if((ele = _uuIdToEle(p,uuId)) != nullptr)
rc = _get_attribute(ele,UI_ORDER_LABEL,orderKey);
return rc;
}
cw::rc_t cw::ui::setScrollTop( handle_t h, unsigned uuId )
{ return _setPropertyValue( h, UI_SCROLL_TOP_LABEL,uuId,0); }
cw::rc_t cw::ui::setBlob( handle_t h, unsigned uuId, const void* blob, unsigned blobByteN )
{
ui_t* p = _handleToPtr(h);
ele_t* ele;
if((ele = _uuIdToEle(p,uuId)) == nullptr )
return cwLogError(kInvalidIdRC,"Invalid uuId (%i) blob not set.",uuId);
ele->blob = (void*)mem::resize<unsigned char>((unsigned char*)ele->blob,blobByteN);
ele->blobByteN = blobByteN;
memcpy(ele->blob,blob,blobByteN);
return kOkRC;
}
const void* cw::ui::getBlob( handle_t h, unsigned uuId, unsigned& blobByteN )
{
ui_t* p = _handleToPtr(h);
ele_t* ele;
if((ele = _uuIdToEle(p,uuId)) != nullptr )
{
blobByteN = ele->blobByteN;
return ele->blob;
}
blobByteN = 0;
return nullptr;
}
cw::rc_t cw::ui::clearBlob( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
ele_t* ele;
if((ele = _uuIdToEle(p,uuId)) == nullptr )
return cwLogError(kInvalidIdRC,"Invalid uuId (%i) blob not cleared.",uuId);
mem::release(ele->blob);
ele->blobByteN = 0;
return kOkRC;
}
unsigned cw::ui::elementChildCount( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
unsigned n = 0;
ele_t* ele;
if((ele = _uuIdToEle( p, uuId)) != nullptr )
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && _is_child_of(ele, p->eleA[i] ))
++n;
return n;
}
cw::rc_t cw::ui::elementChildUuId( handle_t h, unsigned uuId, unsigned* bufA, unsigned bufN, unsigned& actualN )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
unsigned n = 0;
ele_t* ele;
if((ele = _uuIdToEle( p, uuId)) != nullptr )
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && _is_child_of(ele, p->eleA[i] ))
{
if( n >= bufN )
{
rc = cwLogError(kBufTooSmallRC,"The child ele. id buffer is too small.");
goto errLabel;
}
bufA[n++] = p->eleA[i]->uuId;
}
actualN = n;
errLabel:
return rc;
}
unsigned cw::ui::elementPhysChildCount( handle_t h, unsigned uuId )
{
ui_t* p = _handleToPtr(h);
unsigned n = 0;
ele_t* ele;
if((ele = _uuIdToEle( p, uuId)) != nullptr )
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->phys_parent == ele )
++n;
return n;
}
cw::rc_t cw::ui::elementPhysChildUuId( handle_t h, unsigned uuId, unsigned* bufA, unsigned bufN, unsigned& actualN )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
unsigned n = 0;
ele_t* ele;
actualN = 0;
if((ele = _uuIdToEle( p, uuId)) != nullptr )
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->phys_parent == ele )
{
if( n >= bufN )
{
rc = cwLogError(kBufTooSmallRC,"The child ele. id buffer is too small.");
goto errLabel;
}
bufA[n++] = p->eleA[i]->uuId;
}
actualN = n;
errLabel:
return rc;
}
cw::rc_t cw::ui::destroyElement( handle_t h, unsigned uuId )
{
rc_t rc = kOkRC;
ui_t* p = _handleToPtr(h);
ele_t* del_ele = nullptr;
const int mbufN = 256;
char mbuf[mbufN];
// locate the element to delete
if((del_ele = _uuIdToEle( p, uuId)) == nullptr )
{
rc = kInvalidIdRC;
goto errLabel;
}
// mark the element for deletion
del_ele->destroyFl = true;
_remove_ele_from_hash_table(p, del_ele);
// mark all child elements of 'del_ele' for deletion and remove them from the hash table
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i] != del_ele )
if((p->eleA[i]->destroyFl = _is_child_of(del_ele, p->eleA[i] )) == true )
_remove_ele_from_hash_table(p, p->eleA[i]);
// Note that all ele's that are going to be deleted
// must be first removed from the hash table.
// The ele's can't be removed from the hash table
// as they are deleted because the removal fromo the hash table
// requires accessing the logical parent - which may have already been deleted.
// release all elements that are marked for deletion
for(unsigned i=0; i<p->eleN; ++i)
if( p->eleA[i] != nullptr && p->eleA[i]->destroyFl )
{
_destroy_element( p, p->eleA[i] );
p->eleA[i] = nullptr;
}
snprintf(mbuf,mbufN, "{ \"op\":\"destroy\", \"uuId\":%i }", uuId );
_websockSend(p,kInvalidId,mbuf);
errLabel:
if(rc != kOkRC )
rc = cwLogError(rc,"Element delete failed: uuid:%i.",uuId);
return rc;
}
cw::rc_t cw::ui::registerAppIdMap( handle_t h, const appIdMap_t* map, unsigned mapN )
{
return _registerAppIdMap( _handleToPtr(h), map, mapN);
}
cw::rc_t cw::ui::sendValueBool( handle_t h, unsigned uuId, bool value )
{
ui_t* p = _handleToPtr(h);
value_t v = {};
v.tid = kBoolTId;
v.u.b = value;
return _sendValue(p,kInvalidId,uuId,v);
//return _sendValue<int>(p,kInvalidId,uuId,"%i",value?1:0);
}
cw::rc_t cw::ui::sendValueInt( handle_t h, unsigned uuId, int value )
{
ui_t* p = _handleToPtr(h);
value_t v = {};
v.tid = kIntTId;
v.u.i = value;
return _sendValue(p,kInvalidId,uuId,v);
//return _sendValue<int>(p,kInvalidId,uuId,"%i",value);
}
cw::rc_t cw::ui::sendValueUInt( handle_t h, unsigned uuId, unsigned value )
{
ui_t* p = _handleToPtr(h);
value_t v = {};
v.tid = kUIntTId;
v.u.u = value;
return _sendValue(p,kInvalidId,uuId,v);
//return _sendValue<unsigned>(p,kInvalidId,uuId,"%i",value);
}
cw::rc_t cw::ui::sendValueFloat( handle_t h, unsigned uuId, float value )
{
ui_t* p = _handleToPtr(h);
value_t v = { };
v.tid = kFloatTId;
v.u.f = value;
return _sendValue(p,kInvalidId,uuId,v);
//return _sendValue<float>(p,kInvalidId,uuId,"%f",value);
}
cw::rc_t cw::ui::sendValueDouble( handle_t h, unsigned uuId, double value )
{
ui_t* p = _handleToPtr(h);
value_t v = {};
v.tid=kDoubleTId;
v.u.d = value;
return _sendValue(p,kInvalidId,uuId,v);
//return _sendValue<double>(p,kInvalidId,uuId,"%f",value);
}
cw::rc_t cw::ui::sendValueString( handle_t h, unsigned uuId, const char* value )
{
ui_t* p = _handleToPtr(h);
value_t v = {};
v.tid = kStringTId;
v.u.s = value;
return _sendValue(p,kInvalidId,uuId,v);
// +10 allows for extra value buffer space for double quotes and slashed
//return _sendValue<const char*>(p,kInvalidId,uuId,"\"%s\"",value,"value",strlen(value)+10);
}
cw::rc_t cw::ui::sendMsg( handle_t h, const char* msg )
{
ui_t* p = _handleToPtr(h);
return _websockSend(p,kInvalidId,msg);
}
void cw::ui::report( handle_t h )
{
ui_t* p = _handleToPtr(h);
for(unsigned i=0; i<p->eleN; ++i)
if(p->eleA[i] != nullptr )
{
const ele_t* e = p->eleA[i];
unsigned parUuId = e->phys_parent==NULL ? kInvalidId : e->phys_parent->uuId;
const char* parEleName = e->phys_parent==NULL || e->phys_parent->eleName == NULL ? "" : e->phys_parent->eleName;
unsigned logParentAppId = e->logical_parent==NULL ? kInvalidId : e->logical_parent->appId;
printf("uu:%5i app:%5i chan:%5i %20s : parent uu:%5i app:%5i %20s ", e->uuId, e->appId, e->chanId, e->eleName == NULL ? "" : e->eleName, parUuId, logParentAppId, parEleName );
for(unsigned i=0; i<e->attr->child_count(); ++i)
{
e->attr->child_ele(i)->to_string(p->buf,p->bufN);
printf("%s, ", p->buf );
}
printf("\n");
}
}
void cw::ui::realTimeReport( handle_t h )
{
ui_t* p = _handleToPtr(h);
printf("UI msg count: recv:%i send:%i\n",p->recvMsgN,p->sentMsgN);
}
namespace cw
{
namespace ui
{
namespace ws
{
typedef struct ui_ws_str
{
websock::handle_t wsH;
ui::handle_t uiH;
void* cbArg;
uiCallback_t uiCbFunc;
websock::cbFunc_t wsCbFunc;
unsigned idleMsgPeriodMs;
time::spec_t lastRecvMsgTimeStamp;
} ui_ws_t;
ui_ws_t* _handleToPtr( handle_t h )
{ return handleToPtr<handle_t,ui_ws_t>(h); }
rc_t _destroy( ui_ws_t* p )
{
rc_t rc;
if((rc = websock::destroy(p->wsH)) != kOkRC )
return rc;
if((rc = ui::destroy(p->uiH)) != kOkRC )
return rc;
mem::release(p);
return rc;
}
void _webSockCb( void* cbArg, unsigned protocolId, unsigned sessionId, websock::msgTypeId_t msg_type, const void* msg, unsigned byteN )
{
ui_ws_t* p = static_cast<ui_ws_t*>(cbArg);
switch( msg_type )
{
case websock::kConnectTId:
ui::onConnect(p->uiH,sessionId);
break;
case websock::kDisconnectTId:
ui::onDisconnect(p->uiH,sessionId);
break;
case websock::kMessageTId:
ui::onReceive(p->uiH,sessionId,msg,byteN);
break;
default:
cwLogError(kInvalidIdRC,"An invalid websock msgTypeId (%i) was encountered",msg_type);
}
time::get(p->lastRecvMsgTimeStamp);
}
rc_t _webSockSend( void* cbArg, unsigned wsSessId, const void* msg, unsigned msgByteN )
{
ui_ws_t* p = static_cast<ui_ws_t*>(cbArg);
return websock::send( p->wsH, kUiProtocolId, wsSessId, msg, msgByteN );
}
}
}
}
cw::rc_t cw::ui::ws::parseArgs( const object_t& o, args_t& args, const char* object_label )
{
rc_t rc = kOkRC;
const object_t* op = &o;
char* uiCfgFn = nullptr;
char* physRootDir = nullptr;
memset(&args,0,sizeof(args));
// if no 'ui' cfg record was given then skip
if( object_label == nullptr )
op = &o;
else
if((op = o.find(object_label)) == nullptr )
return cwLogError(kEleNotFoundRC,"The ui configuration label '%s' was not found.", cwStringNullGuard(object_label));
if((rc = op->getv(
"physRootDir", args.physRootDir,
"dfltPageFn", args.dfltPageFn,
"port", args.port,
"rcvBufByteN", args.rcvBufByteN,
"xmtBufByteN", args.xmtBufByteN,
"fmtBufByteN", args.fmtBufByteN,
"idleMsgPeriodMs", args.idleMsgPeriodMs,
"queueBlkCnt", args.queueBlkCnt,
"queueBlkByteCnt", args.queueBlkByteCnt,
"extraLogsFl", args.extraLogsFl,
"uiCfgFn", uiCfgFn )) != kOkRC )
{
rc = cwLogError(rc,"'ui' cfg. parse failed.");
}
if( op->find_child("websockTimeOutMs") != nullptr )
cwLogWarning("The UI parameter 'websockTimeOutMs' is obsolete and ignored.");
// expand the physical root directory
if((physRootDir = filesys::expandPath( args.physRootDir)) == nullptr )
{
rc = cwLogError(kInvalidArgRC,"The physical root directory of the UI cfg. is invalid.");
goto errLabel;
}
// if a default UI resource script was given then convert it into an object
if( uiCfgFn != nullptr )
{
char* fn = filesys::makeFn( physRootDir, uiCfgFn, nullptr, nullptr );
if((rc = objectFromFile(fn,args.uiRsrc)) != kOkRC )
rc = cwLogError(rc,"An error occurred while parsing the UI resource script in '%s'.", cwStringNullGuard(uiCfgFn));
mem::release(fn);
}
errLabel:
mem::release(physRootDir);
return rc;
}
cw::rc_t cw::ui::ws::releaseArgs( args_t& args )
{
if( args.uiRsrc != nullptr )
args.uiRsrc->free();
return kOkRC;
}
cw::rc_t cw::ui::ws::create( handle_t& h,
const args_t& args,
void* cbArg,
uiCallback_t uiCbFunc,
const object_t* uiRsrc,
const appIdMap_t* appIdMapA,
unsigned appIdMapN,
websock::cbFunc_t wsCbFunc )
{
return create(h,
args.port,
args.physRootDir,
cbArg,
uiCbFunc,
uiRsrc,
appIdMapA,
appIdMapN,
wsCbFunc,
args.dfltPageFn,
args.idleMsgPeriodMs,
args.rcvBufByteN,
args.xmtBufByteN,
args.fmtBufByteN,
args.queueBlkCnt,
args.queueBlkByteCnt,
args.extraLogsFl);
}
cw::rc_t cw::ui::ws::create( handle_t& h,
unsigned port,
const char* physRootDir,
void* cbArg,
uiCallback_t uiCbFunc,
const object_t* uiRsrc,
const appIdMap_t* appIdMapA,
unsigned appIdMapN,
websock::cbFunc_t wsCbFunc,
const char* dfltPageFn,
unsigned idleMsgPeriodMs,
unsigned rcvBufByteN,
unsigned xmtBufByteN,
unsigned fmtBufByteN,
unsigned queueBlkCnt,
unsigned queueBlkByteCnt,
bool extraLogsFl)
{
rc_t rc = kOkRC;
if((rc = destroy(h)) != kOkRC )
return rc;
ui_ws_t* p = mem::allocZ<ui_ws_t>();
websock::protocol_t protocolA[] =
{
{ "http", kHttpProtocolId, 0, 0 },
{ "ui_protocol", kUiProtocolId, rcvBufByteN, xmtBufByteN }
};
unsigned protocolN = sizeof(protocolA)/sizeof(protocolA[0]);
websock::cbFunc_t wsCbF = wsCbFunc==nullptr ? _webSockCb : wsCbFunc;
void* wsCbA = wsCbFunc==nullptr ? p : cbArg;
// create the websocket
if((rc = websock::create(p->wsH, wsCbF, wsCbA, physRootDir, dfltPageFn, port, protocolA, protocolN, queueBlkCnt, queueBlkByteCnt, extraLogsFl )) != kOkRC )
{
cwLogError(rc,"UI Websock create failed.");
goto errLabel;
}
// create the ui
if((rc = ui::create(p->uiH, _webSockSend, p, uiCbFunc, cbArg, uiRsrc, appIdMapA, appIdMapN, fmtBufByteN )) != kOkRC )
{
cwLogError(rc,"UI object create failed.");
goto errLabel;
}
p->cbArg = cbArg;
p->uiCbFunc = uiCbFunc;
p->wsCbFunc = wsCbFunc;
p->idleMsgPeriodMs = idleMsgPeriodMs;
// initialize the last received msg
time::get(p->lastRecvMsgTimeStamp);
h.set(p);
errLabel:
if( rc != kOkRC )
_destroy(p);
return rc;
}
cw::rc_t cw::ui::ws::destroy( handle_t& h )
{
rc_t rc = kOkRC;
ui_ws_t* p = nullptr;
if( !h.isValid() )
return rc;
p = _handleToPtr(h);
if((rc = _destroy(p)) != kOkRC )
return rc;
h.clear();
return rc;
}
cw::rc_t cw::ui::ws::exec( handle_t h, unsigned wsTimeOutMs )
{
ui_ws_t* p = _handleToPtr(h);
rc_t rc = kOkRC;
time::spec_t t;
if((rc = websock::exec( p->wsH, wsTimeOutMs )) != kOkRC)
cwLogError(rc,"The UI websock execution failed.");
// make the idle callback
time::get(t);
if( time::elapsedMs(p->lastRecvMsgTimeStamp,t) > p->idleMsgPeriodMs )
{
ui::onReceive( p->uiH, kInvalidId, "idle", strlen("idle")+1 );
p->lastRecvMsgTimeStamp = t;
}
return rc;
}
cw::rc_t cw::ui::ws::onReceive( handle_t h, unsigned protocolId, unsigned sessionId, websock::msgTypeId_t msg_type, const void* msg, unsigned byteN )
{
ui_ws_t* p = _handleToPtr(h);
_webSockCb( p, protocolId, sessionId, msg_type, msg, byteN );
return kOkRC;
}
cw::websock::handle_t cw::ui::ws::websockHandle( handle_t h )
{
ui_ws_t* p = _handleToPtr(h);
return p->wsH;
}
cw::ui::handle_t cw::ui::ws::uiHandle( handle_t h )
{
ui_ws_t* p = _handleToPtr(h);
return p->uiH;
}
void cw::ui::ws::realTimeReport( handle_t h )
{
ui_ws_t* p = _handleToPtr(h);
report(p->wsH);
realTimeReport(p->uiH);
}
namespace cw
{
namespace ui
{
namespace srv
{
typedef struct ui_ws_srv_str
{
ws::handle_t wsUiH;
thread::handle_t thH;
unsigned wsTimeOutMs;
} ui_ws_srv_t;
ui_ws_srv_t* _handleToPtr(handle_t h )
{ return handleToPtr<handle_t,ui_ws_srv_t>(h); }
rc_t _destroy( ui_ws_srv_t* p )
{
rc_t rc;
if((rc = thread::destroy(p->thH)) != kOkRC )
return rc;
if((rc = ws::destroy(p->wsUiH)) != kOkRC )
return rc;
mem::release(p);
return rc;
}
bool _threadCallback( void* arg )
{
ui_ws_srv_t* p = static_cast<ui_ws_srv_t*>(arg);
rc_t rc;
if((rc = ws::exec(p->wsUiH,p->wsTimeOutMs)) != kOkRC )
{
cwLogError(rc,"Websocket UI exec failed.");
}
return true;
}
}
}
}
cw::rc_t cw::ui::srv::create( handle_t& h,
const ws::args_t& args,
void* cbArg,
uiCallback_t uiCbFunc,
const appIdMap_t* appIdMapA,
unsigned appIdMapN,
unsigned wsTimeOutMs,
websock::cbFunc_t wsCbFunc )
{
return create(h,
args.port,
args.physRootDir,
cbArg,
uiCbFunc,
args.uiRsrc,
appIdMapA,
appIdMapN,
wsTimeOutMs,
wsCbFunc,
args.dfltPageFn,
args.idleMsgPeriodMs,
args.rcvBufByteN,
args.xmtBufByteN,
args.fmtBufByteN,
args.queueBlkCnt,
args.queueBlkByteCnt );
}
cw::rc_t cw::ui::srv::create( handle_t& h,
unsigned port,
const char* physRootDir,
void* cbArg,
uiCallback_t uiCbFunc,
const object_t* uiRsrc,
const appIdMap_t* appIdMapA,
unsigned appIdMapN,
unsigned wsTimeOutMs,
websock::cbFunc_t wsCbFunc,
const char* dfltPageFn,
unsigned idleMsgPeriodMs,
unsigned rcvBufByteN,
unsigned xmtBufByteN,
unsigned fmtBufByteN,
unsigned queueBlkCnt,
unsigned queueBlkByteCnt,
bool extraLogsFl )
{
rc_t rc = kOkRC;
if((rc = destroy(h)) != kOkRC )
return rc;
ui_ws_srv_t* p = mem::allocZ<ui_ws_srv_t>();
if((rc = ws::create(p->wsUiH, port, physRootDir, cbArg, uiCbFunc, uiRsrc,appIdMapA, appIdMapN, wsCbFunc, dfltPageFn, idleMsgPeriodMs, rcvBufByteN, xmtBufByteN, fmtBufByteN, queueBlkCnt, queueBlkByteCnt )) != kOkRC )
{
cwLogError(rc,"The websock UI creationg failed.");
goto errLabel;
}
if((rc = thread::create( p->thH, _threadCallback, p, "ui", thread::kDefaultStateTimeOutMicros, thread::kDefaultPauseMicros )) != kOkRC )
{
cwLogError(rc,"The websock UI server thread create failed.");
goto errLabel;
}
p->wsTimeOutMs = wsTimeOutMs;
h.set(p);
errLabel:
if( rc != kOkRC )
_destroy(p);
return rc;
}
cw::rc_t cw::ui::srv::destroy( handle_t& h )
{
rc_t rc = kOkRC;
if( !h.isValid() )
return rc;
ui_ws_srv_t* p = _handleToPtr(h);
if((rc = _destroy(p)) != kOkRC )
return rc;
h.clear();
return rc;
}
cw::rc_t cw::ui::srv::start( handle_t h )
{
ui_ws_srv_t* p = _handleToPtr(h);
rc_t rc;
if((rc = thread::unpause(p->thH)) != kOkRC )
cwLogError(rc,"WebockUI server thread start failed.");
return rc;
}
cw::rc_t cw::ui::srv::stop( handle_t h )
{
ui_ws_srv_t* p = _handleToPtr(h);
rc_t rc;
if((rc = thread::pause(p->thH, thread::kPauseFl | thread::kWaitFl )) != kOkRC )
cwLogError(rc,"WebockUI server thread stop failed.");
return rc;
}
cw::thread::handle_t cw::ui::srv::threadHandle( handle_t h )
{
ui_ws_srv_t* p = _handleToPtr(h);
return p->thH;
}
cw::websock::handle_t cw::ui::srv::websockHandle( handle_t h )
{
ui_ws_srv_t* p = _handleToPtr(h);
return ws::websockHandle(p->wsUiH);
}
cw::ui::handle_t cw::ui::srv::uiHandle( handle_t h )
{
ui_ws_srv_t* p = _handleToPtr(h);
return ws::uiHandle(p->wsUiH);
}
Reference in New Issue View Git Blame Copy Permalink