simObject.cpp 103 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305
  1. //-----------------------------------------------------------------------------
  2. // Copyright (c) 2012 GarageGames, LLC
  3. //
  4. // Permission is hereby granted, free of charge, to any person obtaining a copy
  5. // of this software and associated documentation files (the "Software"), to
  6. // deal in the Software without restriction, including without limitation the
  7. // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
  8. // sell copies of the Software, and to permit persons to whom the Software is
  9. // furnished to do so, subject to the following conditions:
  10. //
  11. // The above copyright notice and this permission notice shall be included in
  12. // all copies or substantial portions of the Software.
  13. //
  14. // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15. // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16. // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17. // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18. // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19. // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20. // IN THE SOFTWARE.
  21. //-----------------------------------------------------------------------------
  22. //~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
  23. // Arcane-FX for MIT Licensed Open Source version of Torque 3D from GarageGames
  24. // Copyright (C) 2015 Faust Logic, Inc.
  25. //~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~//~~~~~~~~~~~~~~~~~~~~~//
  26. #include "platform/platform.h"
  27. #include "platform/platformMemory.h"
  28. #include "console/simObject.h"
  29. #include "console/console.h"
  30. #include "console/consoleInternal.h"
  31. #include "console/engineAPI.h"
  32. #include "console/simFieldDictionary.h"
  33. #include "console/simPersistID.h"
  34. #include "console/typeValidators.h"
  35. #include "console/arrayObject.h"
  36. #include "console/codeBlock.h"
  37. #include "core/frameAllocator.h"
  38. #include "core/stream/fileStream.h"
  39. #include "core/fileObject.h"
  40. #include "persistence/taml/tamlCustom.h"
  41. #include "sim/netObject.h"
  42. #include "cinterface/cinterface.h"
  43. IMPLEMENT_CONOBJECT( SimObject );
  44. // See full description in the new CHM manual
  45. ConsoleDocClass( SimObject,
  46. "@brief Base class for almost all objects involved in the simulation.\n\n"
  47. "@ingroup Console\n"
  48. );
  49. bool SimObject::smForceId = false;
  50. SimObjectId SimObject::smForcedId = 0;
  51. bool SimObject::preventNameChanging = false;
  52. IMPLEMENT_CALLBACK(SimObject, onInspectPostApply, void, (SimObject* obj), (obj), "Generic callback for when an object is edited");
  53. namespace Sim
  54. {
  55. // Defined in simManager.cpp
  56. extern SimGroup *gRootGroup;
  57. extern SimManagerNameDictionary *gNameDictionary;
  58. extern SimIdDictionary *gIdDictionary;
  59. extern U32 gNextObjectId;
  60. }
  61. //-----------------------------------------------------------------------------
  62. SimObject::SimObject()
  63. {
  64. mObjectName = NULL;
  65. mOriginalName = NULL;
  66. mInternalName = NULL;
  67. mInheritFrom = NULL;
  68. nextNameObject = nullptr;
  69. nextManagerNameObject = nullptr;
  70. nextIdObject = NULL;
  71. mFilename = NULL;
  72. mDeclarationLine = -1;
  73. mId = 0;
  74. mIdString[ 0 ] = '\0';
  75. mGroup = 0;
  76. mNameSpace = NULL;
  77. mNotifyList = NULL;
  78. mFlags.set( ModStaticFields | ModDynamicFields );
  79. mProgenitorFile = StringTable->EmptyString();
  80. mFieldDictionary = NULL;
  81. mCanSaveFieldDictionary = true;
  82. mClassName = NULL;
  83. mSuperClassName = NULL;
  84. mCopySource = NULL;
  85. mPersistentId = NULL;
  86. is_temp_clone = false;
  87. }
  88. //-----------------------------------------------------------------------------
  89. SimObject::~SimObject()
  90. {
  91. // if this is a temp-clone, we don't delete any members that were shallow-copied
  92. // over from the source datablock.
  93. if (is_temp_clone)
  94. return;
  95. if( mFieldDictionary )
  96. {
  97. delete mFieldDictionary;
  98. mFieldDictionary = NULL;
  99. }
  100. // Release persistent ID.
  101. if( mPersistentId )
  102. {
  103. mPersistentId->unresolve();
  104. mPersistentId->decRefCount();
  105. mPersistentId = NULL;
  106. }
  107. if( mCopySource )
  108. mCopySource->unregisterReference( &mCopySource );
  109. AssertFatal(nextNameObject == nullptr,avar(
  110. "SimObject::~SimObject: Not removed from dictionary: name %s, id %i",
  111. mObjectName, mId));
  112. AssertFatal(nextManagerNameObject == nullptr,avar(
  113. "SimObject::~SimObject: Not removed from manager dictionary: name %s, id %i",
  114. mObjectName,mId));
  115. AssertFatal(mFlags.test(Added) == 0, "SimObject::object "
  116. "missing call to SimObject::onRemove");
  117. }
  118. //-----------------------------------------------------------------------------
  119. bool SimObject::processArguments(S32 argc, ConsoleValue *argv)
  120. {
  121. return argc == 0;
  122. }
  123. //-----------------------------------------------------------------------------
  124. void SimObject::initPersistFields()
  125. {
  126. addGroup( "Ungrouped" );
  127. addProtectedField( "name", TypeName, Offset(mObjectName, SimObject), &setProtectedName, &defaultProtectedGetFn,
  128. "Optional global name of this object." );
  129. addProtectedField("inheritFrom", TypeString, Offset(mInheritFrom, SimObject), &setInheritFrom, &defaultProtectedGetFn,
  130. "Optional Name of object to inherit from as a parent.");
  131. endGroup( "Ungrouped" );
  132. addGroup( "Object" );
  133. addField( "internalName", TypeString, Offset(mInternalName, SimObject),
  134. "Optional name that may be used to lookup this object within a SimSet.");
  135. addProtectedField( "parentGroup", TYPEID< SimObject >(), Offset(mGroup, SimObject), &setProtectedParent, &defaultProtectedGetFn,
  136. "Group hierarchy parent of the object." );
  137. addProtectedField( "class", TypeString, Offset(mClassName, SimObject), &setClass, &defaultProtectedGetFn,
  138. "Script class of object." );
  139. addProtectedField( "superClass", TypeString, Offset(mSuperClassName, SimObject), &setSuperClass, &defaultProtectedGetFn,
  140. "Script super-class of object." );
  141. // For legacy support
  142. addProtectedField( "className", TypeString, Offset(mClassName, SimObject), &setClass, &defaultProtectedGetFn,
  143. "Script class of object.", AbstractClassRep::FIELD_HideInInspectors );
  144. endGroup( "Object" );
  145. addGroup( "Editing" );
  146. addProtectedField( "hidden", TypeBool, 0,
  147. &_setHidden, &_getHidden,
  148. "Whether the object is visible." );
  149. addProtectedField( "locked", TypeBool, 0,
  150. &_setLocked, &_getLocked,
  151. "Whether the object can be edited." );
  152. endGroup( "Editing" );
  153. addGroup( "Persistence" );
  154. addProtectedField( "canSave", TypeBool, Offset( mFlags, SimObject ),
  155. &_setCanSave, &_getCanSave,
  156. "Whether the object can be saved out. If false, the object is purely transient in nature." );
  157. addField( "canSaveDynamicFields", TypeBool, Offset(mCanSaveFieldDictionary, SimObject),
  158. "True if dynamic fields (added at runtime) should be saved. Defaults to true." );
  159. addProtectedField( "persistentId", TypePID, Offset( mPersistentId, SimObject ),
  160. &_setPersistentID, &defaultProtectedGetFn,
  161. "The universally unique identifier for the object." );
  162. endGroup( "Persistence" );
  163. Parent::initPersistFields();
  164. }
  165. //-----------------------------------------------------------------------------
  166. String SimObject::describeSelf() const
  167. {
  168. String desc = Parent::describeSelf();
  169. if( mId != 0 )
  170. desc = avar( "%s|id: %i", desc.c_str(), mId );
  171. if(mObjectName)
  172. desc = avar( "%s|name: %s", desc.c_str(), mObjectName);
  173. if( mInternalName )
  174. desc = avar( "%s|internal: %s", desc.c_str(), mInternalName );
  175. if( mNameSpace )
  176. desc = avar( "%s|nspace: %s", desc.c_str(), mNameSpace->mName );
  177. if( mGroup )
  178. desc = avar( "%s|group: %s", desc.c_str(), mGroup->getName() );
  179. if( mCopySource )
  180. desc = avar( "%s|copy: %s", desc.c_str(), mCopySource->getName() );
  181. if( mPersistentId )
  182. desc = avar( "%s|pid: %s", desc.c_str(), mPersistentId->getUUID().toString().c_str() );
  183. return desc;
  184. }
  185. // Copies dynamic fields from one object to another, optionally limited by the settings for
  186. // <filter> and <no_replace>. When true, <no_replace> prohibits the replacement of fields that
  187. // already have a value. When <filter> is specified, only fields with leading characters that
  188. // exactly match the characters in <filter> are copied.
  189. void SimObject::assignDynamicFieldsFrom(SimObject* from, const char* filter, bool no_replace)
  190. {
  191. if (from->mFieldDictionary)
  192. {
  193. if( mFieldDictionary == NULL )
  194. mFieldDictionary = new SimFieldDictionary;
  195. mFieldDictionary->assignFrom(from->mFieldDictionary, filter, no_replace);
  196. }
  197. }
  198. //=============================================================================
  199. // Persistence.
  200. //=============================================================================
  201. // MARK: ---- Persistence ----
  202. //-----------------------------------------------------------------------------
  203. bool SimObject::writeField(StringTableEntry fieldname, const char* value)
  204. {
  205. // Don't write empty fields.
  206. if (!value || !*value)
  207. return false;
  208. // Don't write owner field for components
  209. static StringTableEntry sOwner = StringTable->insert( "owner" );
  210. if( fieldname == sOwner )
  211. return false;
  212. // Don't write ParentGroup
  213. static StringTableEntry sParentGroup = StringTable->insert( "parentGroup" );
  214. if( fieldname == sParentGroup )
  215. return false;
  216. // Don't write name, is within the parenthesis already
  217. static StringTableEntry sName = StringTable->insert( "name" );
  218. if( fieldname == sName )
  219. return false;
  220. // Don't write className, it is read for legacy support but we
  221. // write it out as class.
  222. static StringTableEntry sClassName = StringTable->insert( "className" );
  223. if( fieldname == sClassName )
  224. return false;
  225. // Write persistent ID only if present.
  226. static StringTableEntry sPersistentId = StringTable->insert( "persistentId" );
  227. if( fieldname == sPersistentId && ( !value || !value[ 0 ] ) )
  228. return false;
  229. // Don't write hidden and locked flags if they are at their default value.
  230. static StringTableEntry sHidden = StringTable->insert( "hidden" );
  231. static StringTableEntry sLocked = StringTable->insert( "locked" );
  232. if( fieldname == sHidden && !dAtob( value ) )
  233. return false;
  234. if( fieldname == sLocked && !dAtob( value ) )
  235. return false;
  236. return true;
  237. }
  238. //-----------------------------------------------------------------------------
  239. void SimObject::writeFields(Stream &stream, U32 tabStop)
  240. {
  241. // Write static fields.
  242. // Create a default object of the same type
  243. ConsoleObject* defaultConObject = ConsoleObject::create(getClassName());
  244. SimObject* defaultObject = dynamic_cast<SimObject*>(defaultConObject);
  245. const AbstractClassRep::FieldList &list = getFieldList();
  246. for(U32 i = 0; i < list.size(); i++)
  247. {
  248. const AbstractClassRep::Field* f = &list[i];
  249. // Skip the special field types.
  250. if ( f->type >= AbstractClassRep::ARCFirstCustomField )
  251. continue;
  252. for(U32 j = 0; S32(j) < f->elementCount; j++)
  253. {
  254. char array[8];
  255. dSprintf( array, 8, "%d", j );
  256. const char *val = getDataField(StringTable->insert( f->pFieldname ), array );
  257. // Make a copy for the field check.
  258. if (!val)
  259. continue;
  260. U32 nBufferSize = dStrlen( val ) + 1;
  261. FrameTemp<char> valCopy( nBufferSize );
  262. dStrcpy( (char *)valCopy, val, nBufferSize );
  263. if (!writeField(f->pFieldname, valCopy))
  264. continue;
  265. //If the field hasn't been changed from the default value, then don't bother writing it out
  266. const char* defaultValueCheck = defaultObject->getDataField(f->pFieldname, array);
  267. if (defaultValueCheck && defaultValueCheck[0] != '\0' && dStricmp(defaultValueCheck, valCopy) == 0)
  268. continue;
  269. val = valCopy;
  270. U32 expandedBufferSize = ( nBufferSize * 2 ) + dStrlen(f->pFieldname) + 32;
  271. FrameTemp<char> expandedBuffer( expandedBufferSize );
  272. if(f->elementCount == 1)
  273. dSprintf(expandedBuffer, expandedBufferSize, "%s = \"", f->pFieldname);
  274. else
  275. dSprintf(expandedBuffer, expandedBufferSize, "%s[%d] = \"", f->pFieldname, j);
  276. // detect and collapse relative path information
  277. char fnBuf[1024];
  278. if (f->type == TypeFilename ||
  279. f->type == TypeStringFilename ||
  280. f->type == TypeImageFilename ||
  281. f->type == TypePrefabFilename ||
  282. f->type == TypeShapeFilename ||
  283. f->type == TypeSoundFilename )
  284. {
  285. Con::collapseScriptFilename(fnBuf, 1024, val);
  286. val = fnBuf;
  287. }
  288. expandEscape((char*)expandedBuffer + dStrlen(expandedBuffer), val);
  289. dStrcat(expandedBuffer, "\";\r\n", expandedBufferSize);
  290. stream.writeTabs(tabStop);
  291. stream.write(dStrlen(expandedBuffer),expandedBuffer);
  292. }
  293. }
  294. // Write dynamic fields, if enabled.
  295. if(mFieldDictionary && mCanSaveFieldDictionary)
  296. mFieldDictionary->writeFields(this, stream, tabStop);
  297. // Cleanup our created default object
  298. delete defaultConObject;
  299. }
  300. //-----------------------------------------------------------------------------
  301. void SimObject::write(Stream &stream, U32 tabStop, U32 flags)
  302. {
  303. if( !getCanSave() && !( flags & IgnoreCanSave ) )
  304. return;
  305. // Only output selected objects if they want that.
  306. if((flags & SelectedOnly) && !isSelected())
  307. return;
  308. stream.writeTabs(tabStop);
  309. char buffer[1024];
  310. dSprintf(buffer, sizeof(buffer), "new %s(%s) {\r\n", getClassName(), getName() && !(flags & NoName) ? getName() : "");
  311. stream.write(dStrlen(buffer), buffer);
  312. writeFields(stream, tabStop + 1);
  313. stream.writeTabs(tabStop);
  314. stream.write(4, "};\r\n");
  315. }
  316. //-----------------------------------------------------------------------------
  317. bool SimObject::save(const char *pcFileName, bool bOnlySelected, const char *preappend)
  318. {
  319. static const char *beginMessage = "//--- OBJECT WRITE BEGIN ---";
  320. static const char *endMessage = "//--- OBJECT WRITE END ---";
  321. FileStream *stream;
  322. FileObject f;
  323. f.readMemory(pcFileName);
  324. // check for flags <selected, ...>
  325. U32 writeFlags = 0;
  326. if(bOnlySelected)
  327. writeFlags |= SimObject::SelectedOnly;
  328. if((stream = FileStream::createAndOpen( pcFileName, Torque::FS::File::Write )) == NULL)
  329. return false;
  330. char docRoot[256];
  331. char modRoot[256];
  332. dStrcpy(docRoot, pcFileName, 256);
  333. char *p = dStrrchr(docRoot, '/');
  334. if (p) *++p = '\0';
  335. else docRoot[0] = '\0';
  336. dStrcpy(modRoot, pcFileName, 256);
  337. p = dStrchr(modRoot, '/');
  338. if (p) *++p = '\0';
  339. else modRoot[0] = '\0';
  340. Con::setVariable("$DocRoot", docRoot);
  341. Con::setVariable("$ModRoot", modRoot);
  342. const char *buffer;
  343. while(!f.isEOF())
  344. {
  345. buffer = (const char *) f.readLine();
  346. if(!String::compare(buffer, beginMessage))
  347. break;
  348. stream->write(dStrlen(buffer), buffer);
  349. stream->write(2, "\r\n");
  350. }
  351. stream->write(dStrlen(beginMessage), beginMessage);
  352. stream->write(2, "\r\n");
  353. if ( preappend != NULL )
  354. stream->write(dStrlen(preappend),preappend);
  355. write(*stream, 0, writeFlags);
  356. stream->write(dStrlen(endMessage), endMessage);
  357. stream->write(2, "\r\n");
  358. while(!f.isEOF())
  359. {
  360. buffer = (const char *) f.readLine();
  361. if(!String::compare(buffer, endMessage))
  362. break;
  363. }
  364. while(!f.isEOF())
  365. {
  366. buffer = (const char *) f.readLine();
  367. stream->write(dStrlen(buffer), buffer);
  368. stream->write(2, "\r\n");
  369. }
  370. Con::setVariable("$DocRoot", NULL);
  371. Con::setVariable("$ModRoot", NULL);
  372. delete stream;
  373. return true;
  374. }
  375. //-----------------------------------------------------------------------------
  376. SimPersistID* SimObject::getOrCreatePersistentId()
  377. {
  378. if( !mPersistentId )
  379. {
  380. mPersistentId = SimPersistID::create( this );
  381. mPersistentId->incRefCount();
  382. }
  383. return mPersistentId;
  384. }
  385. void SimObject::onTamlCustomRead(TamlCustomNodes const& customNodes)
  386. {
  387. // Debug Profiling.
  388. //PROFILE_SCOPE(SimObject_OnTamlCustomRead);
  389. // Fetch field list.
  390. const AbstractClassRep::FieldList& fieldList = getFieldList();
  391. const U32 fieldCount = fieldList.size();
  392. for (U32 index = 0; index < fieldCount; ++index)
  393. {
  394. // Fetch field.
  395. const AbstractClassRep::Field* pField = &fieldList[index];
  396. // Ignore if field not appropriate.
  397. if (pField->type == AbstractClassRep::StartArrayFieldType || pField->elementCount > 1)
  398. {
  399. // Find cell custom node.
  400. const TamlCustomNode* pCustomCellNodes = NULL;
  401. if (pField->pGroupname != NULL)
  402. pCustomCellNodes = customNodes.findNode(pField->pGroupname);
  403. if (!pCustomCellNodes)
  404. {
  405. char* niceFieldName = const_cast<char *>(pField->pFieldname);
  406. niceFieldName[0] = dToupper(niceFieldName[0]);
  407. String str_niceFieldName = String(niceFieldName);
  408. pCustomCellNodes = customNodes.findNode(str_niceFieldName + "s");
  409. }
  410. // Continue if we have explicit cells.
  411. if (pCustomCellNodes != NULL)
  412. {
  413. // Fetch children cell nodes.
  414. const TamlCustomNodeVector& cellNodes = pCustomCellNodes->getChildren();
  415. U8 idx = 0;
  416. // Iterate cells.
  417. for (TamlCustomNodeVector::const_iterator cellNodeItr = cellNodes.begin(); cellNodeItr != cellNodes.end(); ++cellNodeItr)
  418. {
  419. char buf[5];
  420. dSprintf(buf, 5, "%d", idx);
  421. // Fetch cell node.
  422. TamlCustomNode* pCellNode = *cellNodeItr;
  423. // Fetch node name.
  424. StringTableEntry nodeName = pCellNode->getNodeName();
  425. // Is this a valid alias?
  426. if (nodeName != pField->pFieldname)
  427. {
  428. // No, so warn.
  429. Con::warnf("SimObject::onTamlCustomRead() - Encountered an unknown custom name of '%s'. Only '%s' is valid.", nodeName, pField->pFieldname);
  430. continue;
  431. }
  432. // Fetch fields.
  433. const TamlCustomFieldVector& fields = pCellNode->getFields();
  434. // Iterate property fields.
  435. for (TamlCustomFieldVector::const_iterator fieldItr = fields.begin(); fieldItr != fields.end(); ++fieldItr)
  436. {
  437. // Fetch field.
  438. const TamlCustomField* cField = *fieldItr;
  439. // Fetch field name.
  440. StringTableEntry fieldName = cField->getFieldName();
  441. const AbstractClassRep::Field* field = findField(fieldName);
  442. // Check common fields.
  443. if (field)
  444. {
  445. setDataField(fieldName, buf, cField->getFieldValue());
  446. }
  447. else
  448. {
  449. // Unknown name so warn.
  450. Con::warnf("SimObject::onTamlCustomRead() - Encountered an unknown custom field name of '%s'.", fieldName);
  451. continue;
  452. }
  453. }
  454. idx++;
  455. }
  456. }
  457. }
  458. }
  459. }
  460. //-----------------------------------------------------------------------------
  461. bool SimObject::_setPersistentID( void* object, const char* index, const char* data )
  462. {
  463. SimObject* simObject = reinterpret_cast< SimObject* >( object );
  464. // Make sure we don't already have a PID.
  465. if( simObject->getPersistentId() )
  466. {
  467. Con::errorf( "SimObject::_setPersistentID - cannot set a persistent ID on an object that already has a persistent ID assigned." );
  468. return false;
  469. }
  470. SimPersistID* pid;
  471. Con::setData( TypePID, &pid, 0, 1, &data );
  472. if ( !pid )
  473. return false;
  474. // Make sure it's not already bound to an object.
  475. if( pid->getObject() )
  476. {
  477. AssertWarn( pid->getObject() != simObject, "Sim::_setPersistentID - PID is bound to this object yet not assigned to it!" );
  478. SimObject* otherObj = pid->getObject();
  479. Con::errorf( "SimObject::_setPersistentID - UUID is already used by another object: '%s' -> %i:%s (%s)",
  480. data, otherObj->getId(), otherObj->getClassName(), otherObj->getName() );
  481. return false;
  482. }
  483. pid->resolve( simObject );
  484. pid->incRefCount();
  485. simObject->mPersistentId = pid;
  486. return false;
  487. }
  488. //-----------------------------------------------------------------------------
  489. void SimObject::setFilename( const char* file )
  490. {
  491. if( file )
  492. mFilename = StringTable->insert( file );
  493. else
  494. mFilename = StringTable->EmptyString();
  495. }
  496. //-----------------------------------------------------------------------------
  497. void SimObject::setDeclarationLine(U32 lineNumber)
  498. {
  499. mDeclarationLine = lineNumber;
  500. }
  501. //=============================================================================
  502. // Management.
  503. //=============================================================================
  504. // MARK: ---- Management ----
  505. //-----------------------------------------------------------------------------
  506. bool SimObject::registerObject()
  507. {
  508. AssertFatal( !mFlags.test( Added ), "reigsterObject - Object already registered!");
  509. mFlags.clear(Deleted | Removed);
  510. if(smForceId)
  511. {
  512. setId(smForcedId);
  513. smForceId = false;
  514. }
  515. if( !mId )
  516. {
  517. mId = Sim::gNextObjectId++;
  518. dSprintf( mIdString, sizeof( mIdString ), "%u", mId );
  519. }
  520. AssertFatal(Sim::gIdDictionary && Sim::gNameDictionary,
  521. "SimObject::registerObject - tried to register an object before Sim::init()!");
  522. Sim::gIdDictionary->insert(this);
  523. Sim::gNameDictionary->insert(this);
  524. // Notify object
  525. bool ret = onAdd();
  526. if(!ret)
  527. unregisterObject();
  528. AssertFatal(!ret || isProperlyAdded(), "Object did not call SimObject::onAdd()");
  529. return ret;
  530. }
  531. //-----------------------------------------------------------------------------
  532. void SimObject::unregisterObject()
  533. {
  534. mFlags.set(Removed);
  535. // Notify object first
  536. onRemove();
  537. // Clear out any pending notifications before
  538. // we call our own, just in case they delete
  539. // something that we have referenced.
  540. clearAllNotifications();
  541. // Notify all objects that are waiting for delete
  542. // messages
  543. if (getGroup())
  544. getGroup()->removeObject(this);
  545. processDeleteNotifies();
  546. // Do removals from the Sim.
  547. Sim::gNameDictionary->remove(this);
  548. Sim::gIdDictionary->remove(this);
  549. Sim::cancelPendingEvents(this);
  550. }
  551. //-----------------------------------------------------------------------------
  552. void SimObject::deleteObject()
  553. {
  554. Parent::destroySelf();
  555. }
  556. //-----------------------------------------------------------------------------
  557. void SimObject::_destroySelf()
  558. {
  559. AssertFatal( !isDeleted(), "SimObject::destroySelf - Object has already been deleted" );
  560. AssertFatal( !isRemoved(), "SimObject::destroySelf - Object in the process of being removed" );
  561. mFlags.set( Deleted );
  562. if( mFlags.test( Added ) )
  563. unregisterObject();
  564. Parent::_destroySelf();
  565. }
  566. //-----------------------------------------------------------------------------
  567. void SimObject::destroySelf()
  568. {
  569. // When using the legacy console interop, we don't delete objects
  570. // when their reference count drops to zero but rather defer their
  571. // deletion until deleteObject() is called.
  572. if( engineAPI::gUseConsoleInterop )
  573. return;
  574. Parent::destroySelf();
  575. }
  576. //-----------------------------------------------------------------------------
  577. class SimObjectDeleteEvent : public SimEvent
  578. {
  579. public:
  580. void process(SimObject *object)
  581. {
  582. object->deleteObject();
  583. }
  584. };
  585. void SimObject::safeDeleteObject()
  586. {
  587. Sim::postEvent( this, new SimObjectDeleteEvent, Sim::getCurrentTime() + 1 );
  588. }
  589. //-----------------------------------------------------------------------------
  590. void SimObject::setId(SimObjectId newId)
  591. {
  592. if(!mFlags.test(Added))
  593. mId = newId;
  594. else
  595. {
  596. // get this object out of the id dictionary if it's in it
  597. Sim::gIdDictionary->remove(this);
  598. // Free current Id.
  599. // Assign new one.
  600. mId = newId ? newId : Sim::gNextObjectId++;
  601. Sim::gIdDictionary->insert(this);
  602. }
  603. dSprintf( mIdString, sizeof( mIdString ), "%u", mId );
  604. }
  605. //-----------------------------------------------------------------------------
  606. void SimObject::assignName(const char *name)
  607. {
  608. if(mObjectName && !isNameChangeAllowed() )
  609. {
  610. Con::errorf( "SimObject::assignName - not allowed to change name of object '%s'", mObjectName);
  611. return;
  612. }
  613. // Added this assert 3/30/2007 because it is dumb to try to name
  614. // a SimObject the same thing as it's class name -patw
  615. //AssertFatal( dStricmp( getClassName(), name ), "Attempted to assign a name to a SimObject which matches it's type name." );
  616. if( dStricmp( getClassName(), name ) == 0 )
  617. Con::errorf( "SimObject::assignName - Assigning name '%s' to instance of object with type '%s'."
  618. " This can cause namespace linking issues.", getClassName(), name );
  619. StringTableEntry newName = NULL;
  620. if(name[0])
  621. newName = StringTable->insert(name);
  622. onNameChange( newName );
  623. if( mGroup )
  624. mGroup->mNameDictionary.remove( this );
  625. if( isProperlyAdded() )
  626. {
  627. unlinkNamespaces();
  628. Sim::gNameDictionary->remove( this );
  629. }
  630. mObjectName = newName;
  631. if( mGroup )
  632. mGroup->mNameDictionary.insert( this );
  633. if( isProperlyAdded() )
  634. {
  635. Sim::gNameDictionary->insert( this );
  636. linkNamespaces();
  637. }
  638. }
  639. //-----------------------------------------------------------------------------
  640. bool SimObject::registerObject(U32 id)
  641. {
  642. setId(id);
  643. return registerObject();
  644. }
  645. //-----------------------------------------------------------------------------
  646. bool SimObject::registerObject(const char *name)
  647. {
  648. assignName(name);
  649. return registerObject();
  650. }
  651. //-----------------------------------------------------------------------------
  652. bool SimObject::registerObject(const String& name)
  653. {
  654. assignName(name.c_str());
  655. return registerObject();
  656. }
  657. //-----------------------------------------------------------------------------
  658. bool SimObject::registerObject(const char *name, U32 id)
  659. {
  660. setId(id);
  661. assignName(name);
  662. return registerObject();
  663. }
  664. //=============================================================================
  665. // Introspection.
  666. //=============================================================================
  667. // MARK: ---- Introspection ----
  668. //-----------------------------------------------------------------------------
  669. bool SimObject::isMethod( const char* methodName )
  670. {
  671. if( !methodName || !methodName[0] )
  672. return false;
  673. if (CInterface::isMethod(this->getName(), methodName) || CInterface::isMethod(this->getClassName(), methodName)) {
  674. return true;
  675. }
  676. StringTableEntry stname = StringTable->insert( methodName );
  677. if( getNamespace() )
  678. return ( getNamespace()->lookup( stname ) != NULL );
  679. return false;
  680. }
  681. //-----------------------------------------------------------------------------
  682. bool SimObject::isField( const char* fieldName, bool includeStatic, bool includeDynamic )
  683. {
  684. const char* strFieldName = StringTable->insert( fieldName );
  685. if( includeStatic && getClassRep()->findField( strFieldName ) )
  686. return true;
  687. if( includeDynamic && getFieldDictionary() && getFieldDictionary()->findDynamicField( strFieldName ) )
  688. return true;
  689. return false;
  690. }
  691. //-----------------------------------------------------------------------------
  692. void SimObject::assignDynamicFieldsFrom(SimObject* parent)
  693. {
  694. if(parent->mFieldDictionary)
  695. {
  696. if( mFieldDictionary == NULL )
  697. mFieldDictionary = new SimFieldDictionary;
  698. mFieldDictionary->assignFrom(parent->mFieldDictionary);
  699. }
  700. }
  701. //-----------------------------------------------------------------------------
  702. void SimObject::assignFieldsFrom(SimObject *parent)
  703. {
  704. // Only allow field assigns from objects of the same class or
  705. // a superclass.
  706. if( getClassRep()->isClass( parent->getClassRep() ) )
  707. {
  708. const AbstractClassRep::FieldList &list = parent->getFieldList();
  709. // copy out all the fields:
  710. for(U32 i = 0; i < list.size(); i++)
  711. {
  712. const AbstractClassRep::Field* f = &list[i];
  713. // Skip the special field types.
  714. if ( f->type >= AbstractClassRep::ARCFirstCustomField )
  715. continue;
  716. // Skip certain fields that we don't want to see copied so we don't
  717. // get error messages from their setters.
  718. static StringTableEntry sName = StringTable->insert( "name" );
  719. static StringTableEntry sPersistentId = StringTable->insert( "persistentId" );
  720. if( f->pFieldname == sName || f->pFieldname == sPersistentId )
  721. continue;
  722. S32 lastField = f->elementCount - 1;
  723. for(S32 j = 0; j <= lastField; j++)
  724. {
  725. const char* fieldVal = (*f->getDataFn)( parent, Con::getData(f->type, (void *) (((const char *)parent) + f->offset), j, f->table, f->flag));
  726. // Don't assign the field is the pointer is null or if
  727. // the field is not empty and writing it was disallowed.
  728. if ( !fieldVal || ( fieldVal[0] && !writeField( f->pFieldname, fieldVal ) ) )
  729. continue;
  730. // code copied from SimObject::setDataField().
  731. // TODO: paxorr: abstract this into a better setData / getData that considers prot fields.
  732. FrameTemp<char> buffer(2048);
  733. FrameTemp<char> bufferSecure(2048); // This buffer is used to make a copy of the data
  734. ConsoleBaseType *cbt = ConsoleBaseType::getType( f->type );
  735. const char* szBuffer = cbt->prepData( fieldVal, buffer, 2048 );
  736. dMemset( bufferSecure, 0, 2048 );
  737. dMemcpy( bufferSecure, szBuffer, dStrlen( szBuffer ) );
  738. //If we have an index worth mentioning, process it for pass-along as well to ensure we set stuff correctly
  739. char* elementIdxBuffer = nullptr;
  740. if (f->elementCount > 1)
  741. {
  742. elementIdxBuffer = Con::getArgBuffer(256);
  743. dSprintf(elementIdxBuffer, 256, "%i", j);
  744. }
  745. if((*f->setDataFn)( this, elementIdxBuffer, bufferSecure ) )
  746. Con::setData(f->type, (void *) (((const char *)this) + f->offset), j, 1, &fieldVal, f->table);
  747. if (f->networkMask != 0)
  748. {
  749. NetObject* netObj = static_cast<NetObject*>(this);
  750. netObj->setMaskBits(f->networkMask);
  751. }
  752. }
  753. }
  754. }
  755. else
  756. {
  757. Con::errorf( "SimObject::assignFieldsFrom() - cannot assigned fields from object of type '%s' to object of type '%s'",
  758. parent->getClassName(), getClassName()
  759. );
  760. }
  761. assignDynamicFieldsFrom(parent);
  762. }
  763. //-----------------------------------------------------------------------------
  764. void SimObject::setDataField(StringTableEntry slotName, const char *array, const char *value)
  765. {
  766. // first search the static fields if enabled
  767. if(mFlags.test(ModStaticFields))
  768. {
  769. const AbstractClassRep::Field *fld = findField(slotName);
  770. if(fld)
  771. {
  772. // Skip the special field types as they are not data.
  773. if ( fld->type >= AbstractClassRep::ARCFirstCustomField )
  774. return;
  775. S32 array1 = array ? dAtoi(array) : 0;
  776. // Here we check to see if <this> is a datablock and if <value>
  777. // starts with "$$". If both true than save value as a runtime substitution.
  778. if (dynamic_cast<SimDataBlock*>(this) && value[0] == '$' && value[1] == '$')
  779. {
  780. if (!this->allowSubstitutions())
  781. {
  782. Con::errorf("Substitution Error: %s datablocks do not allow \"$$\" field substitutions. [%s]",
  783. this->getClassName(), this->getName());
  784. return;
  785. }
  786. if (fld->doNotSubstitute)
  787. {
  788. Con::errorf("Substitution Error: field \"%s\" of datablock %s prohibits \"$$\" field substitutions. [%s]",
  789. slotName, this->getClassName(), this->getName());
  790. return;
  791. }
  792. // add the substitution
  793. ((SimDataBlock*)this)->addSubstitution(slotName, array1, value);
  794. return;
  795. }
  796. if(array1 >= 0 && array1 < fld->elementCount && fld->elementCount >= 1)
  797. {
  798. // If the set data notify callback returns true, then go ahead and
  799. // set the data, otherwise, assume the set notify callback has either
  800. // already set the data, or has deemed that the data should not
  801. // be set at all.
  802. FrameTemp<char> buffer(2048);
  803. FrameTemp<char> bufferSecure(2048); // This buffer is used to make a copy of the data
  804. // so that if the prep functions or any other functions use the string stack, the data
  805. // is not corrupted.
  806. ConsoleBaseType *cbt = ConsoleBaseType::getType( fld->type );
  807. AssertFatal( cbt != NULL, "Could not resolve Type Id." );
  808. const char* szBuffer = cbt->prepData( value, buffer, 2048 );
  809. dMemset( bufferSecure, 0, 2048 );
  810. dMemcpy( bufferSecure, szBuffer, dStrlen( szBuffer ) );
  811. if( (*fld->setDataFn)( this, array, bufferSecure ) )
  812. Con::setData(fld->type, (void *) (((const char *)this) + fld->offset), array1, 1, &value, fld->table);
  813. if(fld->validator)
  814. fld->validator->validateType(this, (void *) (((const char *)this) + fld->offset));
  815. if (fld->networkMask != 0)
  816. {
  817. NetObject* netObj = static_cast<NetObject*>(this);
  818. netObj->setMaskBits(fld->networkMask);
  819. }
  820. onStaticModified( slotName, value );
  821. return;
  822. }
  823. if(fld->validator)
  824. fld->validator->validateType(this, (void *) (((const char *)this) + fld->offset));
  825. onStaticModified( slotName, value );
  826. return;
  827. }
  828. }
  829. if(mFlags.test(ModDynamicFields))
  830. {
  831. if(!mFieldDictionary)
  832. mFieldDictionary = new SimFieldDictionary;
  833. if(!array)
  834. {
  835. mFieldDictionary->setFieldValue(slotName, value);
  836. onDynamicModified( slotName, value );
  837. }
  838. else
  839. {
  840. char buf[256];
  841. dStrcpy(buf, slotName, 256);
  842. dStrcat(buf, array, 256);
  843. StringTableEntry permanentSlotName = StringTable->insert(buf);
  844. mFieldDictionary->setFieldValue(permanentSlotName, value);
  845. onDynamicModified( permanentSlotName, value );
  846. }
  847. }
  848. }
  849. //-----------------------------------------------------------------------------
  850. const char *SimObject::getDataField(StringTableEntry slotName, const char *array)
  851. {
  852. if(mFlags.test(ModStaticFields))
  853. {
  854. S32 array1 = array ? dAtoi(array) : -1;
  855. const AbstractClassRep::Field *fld = findField(slotName);
  856. if(fld)
  857. {
  858. if(array1 == -1 && fld->elementCount == 1)
  859. return (*fld->getDataFn)( this, Con::getData(fld->type, (void *) (((const char *)this) + fld->offset), 0, fld->table, fld->flag) );
  860. if(array1 >= 0 && array1 < fld->elementCount)
  861. return (*fld->getDataFn)( this, Con::getData(fld->type, (void *) (((const char *)this) + fld->offset), array1, fld->table, fld->flag) );// + typeSizes[fld.type] * array1));
  862. return "";
  863. }
  864. }
  865. if(mFlags.test(ModDynamicFields))
  866. {
  867. if(!mFieldDictionary)
  868. return "";
  869. if(!array)
  870. {
  871. if (const char* val = mFieldDictionary->getFieldValue(slotName))
  872. return val;
  873. }
  874. else
  875. {
  876. static char buf[256];
  877. dStrcpy(buf, slotName, 256);
  878. dStrcat(buf, array, 256);
  879. if (const char* val = mFieldDictionary->getFieldValue(StringTable->insert(buf)))
  880. return val;
  881. }
  882. }
  883. return "";
  884. }
  885. const char *SimObject::getPrefixedDataField(StringTableEntry fieldName, const char *array)
  886. {
  887. // Sanity!
  888. AssertFatal(fieldName != NULL, "Cannot get field value with NULL field name.");
  889. // Fetch field value.
  890. const char* pFieldValue = getDataField(fieldName, array);
  891. // Sanity.
  892. //AssertFatal(pFieldValue != NULL, "Field value cannot be NULL.");
  893. if (!pFieldValue)
  894. return NULL;
  895. // Return without the prefix if there's no value.
  896. if (*pFieldValue == 0)
  897. return StringTable->EmptyString();
  898. // Fetch the field prefix.
  899. StringTableEntry fieldPrefix = getDataFieldPrefix(fieldName);
  900. // Sanity!
  901. AssertFatal(fieldPrefix != NULL, "Field prefix cannot be NULL.");
  902. // Calculate a buffer size including prefix.
  903. const U32 valueBufferSize = dStrlen(fieldPrefix) + dStrlen(pFieldValue) + 1;
  904. // Fetch a buffer.
  905. char* pValueBuffer = Con::getReturnBuffer(valueBufferSize);
  906. // Format the value buffer.
  907. dSprintf(pValueBuffer, valueBufferSize, "%s%s", fieldPrefix, pFieldValue);
  908. return pValueBuffer;
  909. }
  910. //-----------------------------------------------------------------------------
  911. void SimObject::setPrefixedDataField(StringTableEntry fieldName, const char *_array, const char *value)
  912. {
  913. // Sanity!
  914. AssertFatal(fieldName != NULL, "Cannot set object field value with NULL field name.");
  915. AssertFatal(value != NULL, "Field value cannot be NULL.");
  916. // Set value without prefix if there's no value.
  917. if (*value == 0)
  918. {
  919. setDataField(fieldName, _array, value);
  920. return;
  921. }
  922. // Fetch the field prefix.
  923. StringTableEntry fieldPrefix = getDataFieldPrefix(fieldName);
  924. // Sanity.
  925. AssertFatal(fieldPrefix != NULL, "Field prefix cannot be NULL.");
  926. // Do we have a field prefix?
  927. if (fieldPrefix == StringTable->EmptyString())
  928. {
  929. // No, so set the data field in the usual way.
  930. setDataField(fieldName, _array, value);
  931. return;
  932. }
  933. // Yes, so fetch the length of the field prefix.
  934. const U32 fieldPrefixLength = dStrlen(fieldPrefix);
  935. // Yes, so does it start with the object field prefix?
  936. if (dStrnicmp(value, fieldPrefix, fieldPrefixLength) != 0)
  937. {
  938. // No, so set the data field in the usual way.
  939. setDataField(fieldName, _array, value);
  940. return;
  941. }
  942. // Yes, so set the data excluding the prefix.
  943. setDataField(fieldName, _array, value + fieldPrefixLength);
  944. }
  945. //-----------------------------------------------------------------------------
  946. const char *SimObject::getPrefixedDynamicDataField(StringTableEntry fieldName, const char *_array, const S32 fieldType)
  947. {
  948. // Sanity!
  949. AssertFatal(fieldName != NULL, "Cannot get field value with NULL field name.");
  950. // Fetch field value.
  951. const char* pFieldValue = getDataField(fieldName, _array);
  952. // Sanity.
  953. AssertFatal(pFieldValue != NULL, "Field value cannot be NULL.");
  954. // Return the field if no field type is specified.
  955. if (fieldType == -1)
  956. return pFieldValue;
  957. // Return without the prefix if there's no value.
  958. if (*pFieldValue == 0)
  959. return StringTable->EmptyString();
  960. // Fetch the console base type.
  961. ConsoleBaseType* pConsoleBaseType = ConsoleBaseType::getType(fieldType);
  962. // Did we find the console base type?
  963. if (pConsoleBaseType == NULL)
  964. {
  965. // No, so warn.
  966. Con::warnf("getPrefixedDynamicDataField() - Invalid field type '%d' specified for field '%s' with value '%s'.",
  967. fieldType, fieldName, pFieldValue);
  968. }
  969. // Fetch the field prefix.
  970. StringTableEntry fieldPrefix = pConsoleBaseType->getTypePrefix();
  971. // Sanity!
  972. AssertFatal(fieldPrefix != NULL, "Field prefix cannot be NULL.");
  973. // Calculate a buffer size including prefix.
  974. const U32 valueBufferSize = dStrlen(fieldPrefix) + dStrlen(pFieldValue) + 1;
  975. // Fetch a buffer.
  976. char* pValueBuffer = Con::getReturnBuffer(valueBufferSize);
  977. // Format the value buffer.
  978. dSprintf(pValueBuffer, valueBufferSize, "%s%s", fieldPrefix, pFieldValue);
  979. return pValueBuffer;
  980. }
  981. //-----------------------------------------------------------------------------
  982. void SimObject::setPrefixedDynamicDataField(StringTableEntry fieldName, const char *array, const char *value, const S32 fieldType)
  983. {
  984. // Sanity!
  985. AssertFatal(fieldName != NULL, "Cannot set object field value with NULL field name.");
  986. AssertFatal(value != NULL, "Field value cannot be NULL.");
  987. // Set value without prefix if no field type was specified.
  988. if (fieldType == -1)
  989. {
  990. setDataField(fieldName, NULL, value);
  991. return;
  992. }
  993. // Fetch the console base type.
  994. ConsoleBaseType* pConsoleBaseType = ConsoleBaseType::getType(fieldType);
  995. // Did we find the console base type?
  996. if (pConsoleBaseType == NULL)
  997. {
  998. // No, so warn.
  999. Con::warnf("setPrefixedDynamicDataField() - Invalid field type '%d' specified for field '%s' with value '%s'.",
  1000. fieldType, fieldName, value);
  1001. }
  1002. // Set value without prefix if there's no value or we didn't find the console base type.
  1003. if (*value == 0 || pConsoleBaseType == NULL)
  1004. {
  1005. setDataField(fieldName, NULL, value);
  1006. return;
  1007. }
  1008. // Fetch the field prefix.
  1009. StringTableEntry fieldPrefix = pConsoleBaseType->getTypePrefix();
  1010. // Sanity.
  1011. AssertFatal(fieldPrefix != NULL, "Field prefix cannot be NULL.");
  1012. // Do we have a field prefix?
  1013. if (fieldPrefix == StringTable->EmptyString())
  1014. {
  1015. // No, so set the data field in the usual way.
  1016. setDataField(fieldName, NULL, value);
  1017. return;
  1018. }
  1019. // Yes, so fetch the length of the field prefix.
  1020. const U32 fieldPrefixLength = dStrlen(fieldPrefix);
  1021. // Yes, so does it start with the object field prefix?
  1022. if (dStrnicmp(value, fieldPrefix, fieldPrefixLength) != 0)
  1023. {
  1024. // No, so set the data field in the usual way.
  1025. setDataField(fieldName, NULL, value);
  1026. return;
  1027. }
  1028. // Yes, so set the data excluding the prefix.
  1029. setDataField(fieldName, NULL, value + fieldPrefixLength);
  1030. }
  1031. //-----------------------------------------------------------------------------
  1032. StringTableEntry SimObject::getDataFieldPrefix(StringTableEntry fieldName)
  1033. {
  1034. // Sanity!
  1035. AssertFatal(fieldName != NULL, "Cannot get field prefix with NULL field name.");
  1036. // Find the field.
  1037. const AbstractClassRep::Field* pField = findField(fieldName);
  1038. // Return nothing if field was not found.
  1039. if (pField == NULL)
  1040. return StringTable->EmptyString();
  1041. // Yes, so fetch the console base type.
  1042. ConsoleBaseType* pConsoleBaseType = ConsoleBaseType::getType(pField->type);
  1043. // Fetch the type prefix.
  1044. return pConsoleBaseType->getTypePrefix();
  1045. }
  1046. //-----------------------------------------------------------------------------
  1047. U32 SimObject::getDataFieldType( StringTableEntry slotName, const char* array )
  1048. {
  1049. const AbstractClassRep::Field* field = findField( slotName );
  1050. if(field)
  1051. return field->type;
  1052. // Check dynamic fields
  1053. if(!mFieldDictionary)
  1054. return 0;
  1055. if(array == NULL || *array == 0)
  1056. return mFieldDictionary->getFieldType( slotName );
  1057. else
  1058. {
  1059. static char buf[256];
  1060. dStrcpy( buf, slotName, 256 );
  1061. dStrcat( buf, array, 256 );
  1062. return mFieldDictionary->getFieldType( StringTable->insert( buf ) );
  1063. }
  1064. }
  1065. //-----------------------------------------------------------------------------
  1066. void SimObject::setDataFieldType(const U32 fieldTypeId, StringTableEntry slotName, const char *array)
  1067. {
  1068. // This only works on dynamic fields, bail if we have no field dictionary
  1069. if(!mFieldDictionary)
  1070. return;
  1071. if(array == NULL || *array == 0)
  1072. {
  1073. mFieldDictionary->setFieldType( slotName, fieldTypeId );
  1074. onDynamicModified( slotName, mFieldDictionary->getFieldValue(slotName) );
  1075. }
  1076. else
  1077. {
  1078. static char buf[256];
  1079. dStrcpy( buf, slotName, 256 );
  1080. dStrcat( buf, array, 256 );
  1081. mFieldDictionary->setFieldType( StringTable->insert( buf ), fieldTypeId );
  1082. onDynamicModified( slotName, mFieldDictionary->getFieldValue(slotName) );
  1083. }
  1084. }
  1085. //-----------------------------------------------------------------------------
  1086. void SimObject::setDataFieldType(const char *typeName, StringTableEntry slotName, const char *array)
  1087. {
  1088. // This only works on dynamic fields, bail if we have no field dictionary
  1089. if(!mFieldDictionary)
  1090. return;
  1091. if(array == NULL || *array == 0)
  1092. mFieldDictionary->setFieldType( slotName, typeName );
  1093. else
  1094. {
  1095. static char buf[256];
  1096. dStrcpy( buf, slotName, 256 );
  1097. dStrcat( buf, array, 256 );
  1098. StringTableEntry permanentSlotName = StringTable->insert(buf);
  1099. mFieldDictionary->setFieldType( permanentSlotName, typeName );
  1100. onDynamicModified( permanentSlotName, mFieldDictionary->getFieldValue(permanentSlotName) );
  1101. }
  1102. }
  1103. // This is the copy-constructor used to create temporary datablock clones.
  1104. // The <temp_clone> argument is added to distinguish this copy-constructor
  1105. // from any general-purpose copy-constructor that might be needed in the
  1106. // future. <temp_clone> should always be true when creating temporary
  1107. // datablock clones.
  1108. //
  1109. SimObject::SimObject(const SimObject& other, bool temp_clone)
  1110. {
  1111. is_temp_clone = temp_clone;
  1112. mObjectName = other.mObjectName;
  1113. mOriginalName = other.mOriginalName;
  1114. nextNameObject = other.nextNameObject;
  1115. nextManagerNameObject = other.nextManagerNameObject;
  1116. nextIdObject = other.nextIdObject;
  1117. mGroup = other.mGroup;
  1118. mFlags = other.mFlags;
  1119. mProgenitorFile = other.mProgenitorFile;
  1120. mCopySource = other.mCopySource;
  1121. mFieldDictionary = other.mFieldDictionary;
  1122. //mIdString = other.mIdString; // special treatment (see below)
  1123. mFilename = other.mFilename;
  1124. mDeclarationLine = other.mDeclarationLine;
  1125. mNotifyList = other.mNotifyList;
  1126. mId = other.mId;
  1127. mInternalName = other.mInternalName;
  1128. mCanSaveFieldDictionary = other.mCanSaveFieldDictionary;
  1129. mPersistentId = other.mPersistentId;
  1130. mNameSpace = other.mNameSpace;
  1131. mClassName = other.mClassName;
  1132. mSuperClassName = other.mSuperClassName;
  1133. preventNameChanging = other.preventNameChanging;
  1134. if (mId)
  1135. dSprintf( mIdString, sizeof( mIdString ), "%u", mId );
  1136. else
  1137. mIdString[ 0 ] = '\0';
  1138. }
  1139. //-----------------------------------------------------------------------------
  1140. void SimObject::dumpClassHierarchy()
  1141. {
  1142. AbstractClassRep* pRep = getClassRep();
  1143. while(pRep)
  1144. {
  1145. Con::warnf("%s ->", pRep->getClassName());
  1146. pRep = pRep->getParentClass();
  1147. }
  1148. }
  1149. //-----------------------------------------------------------------------------
  1150. SimObject* SimObject::clone()
  1151. {
  1152. if( !getClassRep() )
  1153. return NULL;
  1154. ConsoleObject* conObject = getClassRep()->create();
  1155. if( !conObject )
  1156. return NULL;
  1157. SimObject* simObject = dynamic_cast< SimObject* >( conObject );
  1158. if( !simObject )
  1159. {
  1160. delete conObject;
  1161. return NULL;
  1162. }
  1163. simObject->assignFieldsFrom( this );
  1164. String name = Sim::getUniqueName( getName() );
  1165. if( !simObject->registerObject( name.c_str() ) )
  1166. {
  1167. delete simObject;
  1168. return NULL;
  1169. }
  1170. if( getGroup() )
  1171. getGroup()->addObject( simObject );
  1172. return simObject;
  1173. }
  1174. //-----------------------------------------------------------------------------
  1175. SimObject* SimObject::deepClone()
  1176. {
  1177. return clone();
  1178. }
  1179. //=============================================================================
  1180. // Grouping.
  1181. //=============================================================================
  1182. // MARK: ---- Grouping ----
  1183. //-----------------------------------------------------------------------------
  1184. SimObject* SimObject::findObject( const char* )
  1185. {
  1186. return NULL;
  1187. }
  1188. //-----------------------------------------------------------------------------
  1189. bool SimObject::isChildOfGroup(SimGroup* pGroup)
  1190. {
  1191. if(!pGroup)
  1192. return false;
  1193. //if we *are* the group in question,
  1194. //return true:
  1195. if(pGroup == dynamic_cast<SimGroup*>(this))
  1196. return true;
  1197. SimGroup* temp = mGroup;
  1198. while(temp)
  1199. {
  1200. if(temp == pGroup)
  1201. return true;
  1202. temp = temp->mGroup;
  1203. }
  1204. return false;
  1205. }
  1206. //-----------------------------------------------------------------------------
  1207. bool SimObject::addToSet(SimObjectId spid)
  1208. {
  1209. if (mFlags.test(Added) == false)
  1210. return false;
  1211. SimObject* ptr = Sim::findObject(spid);
  1212. if (ptr)
  1213. {
  1214. SimSet* sp = dynamic_cast<SimSet*>(ptr);
  1215. AssertFatal(sp != 0,
  1216. "SimObject::addToSet: "
  1217. "ObjectId does not refer to a set object");
  1218. sp->addObject(this);
  1219. return true;
  1220. }
  1221. return false;
  1222. }
  1223. //-----------------------------------------------------------------------------
  1224. bool SimObject::addToSet(const char *ObjectName)
  1225. {
  1226. if (mFlags.test(Added) == false)
  1227. return false;
  1228. SimObject* ptr = Sim::findObject(ObjectName);
  1229. if (ptr)
  1230. {
  1231. SimSet* sp = dynamic_cast<SimSet*>(ptr);
  1232. AssertFatal(sp != 0,
  1233. "SimObject::addToSet: "
  1234. "ObjectName does not refer to a set object");
  1235. sp->addObject(this);
  1236. return true;
  1237. }
  1238. return false;
  1239. }
  1240. //-----------------------------------------------------------------------------
  1241. bool SimObject::removeFromSet(SimObjectId sid)
  1242. {
  1243. if (mFlags.test(Added) == false)
  1244. return false;
  1245. SimSet *set;
  1246. if(Sim::findObject(sid, set))
  1247. {
  1248. set->removeObject(this);
  1249. return true;
  1250. }
  1251. return false;
  1252. }
  1253. //-----------------------------------------------------------------------------
  1254. bool SimObject::removeFromSet(const char *objectName)
  1255. {
  1256. if (mFlags.test(Added) == false)
  1257. return false;
  1258. SimSet *set;
  1259. if(Sim::findObject(objectName, set))
  1260. {
  1261. set->removeObject(this);
  1262. return true;
  1263. }
  1264. return false;
  1265. }
  1266. //-----------------------------------------------------------------------------
  1267. void SimObject::dumpGroupHierarchy()
  1268. {
  1269. String className( getClassName() );
  1270. String objectName( getName() );
  1271. Con::warnf( "[%i] %s - %s ->", getId(), className.c_str(), objectName.c_str() );
  1272. if ( mGroup )
  1273. mGroup->dumpGroupHierarchy();
  1274. }
  1275. //=============================================================================
  1276. // Events.
  1277. //=============================================================================
  1278. // MARK: ---- Events ----
  1279. //-----------------------------------------------------------------------------
  1280. bool SimObject::onAdd()
  1281. {
  1282. mFlags.set(Added);
  1283. linkNamespaces();
  1284. return true;
  1285. }
  1286. //-----------------------------------------------------------------------------
  1287. void SimObject::onRemove()
  1288. {
  1289. mFlags.clear(Added);
  1290. unlinkNamespaces();
  1291. }
  1292. //-----------------------------------------------------------------------------
  1293. void SimObject::onGroupAdd()
  1294. {
  1295. }
  1296. //-----------------------------------------------------------------------------
  1297. void SimObject::onGroupRemove()
  1298. {
  1299. }
  1300. //-----------------------------------------------------------------------------
  1301. void SimObject::onDeleteNotify(SimObject*)
  1302. {
  1303. }
  1304. //-----------------------------------------------------------------------------
  1305. void SimObject::onNameChange(const char*)
  1306. {
  1307. }
  1308. //-----------------------------------------------------------------------------
  1309. void SimObject::onStaticModified(const char* slotName, const char* newValue)
  1310. {
  1311. }
  1312. //-----------------------------------------------------------------------------
  1313. void SimObject::onDynamicModified(const char* slotName, const char* newValue)
  1314. {
  1315. }
  1316. //=============================================================================
  1317. // Notifications.
  1318. //=============================================================================
  1319. // MARK: ---- Notifications ----
  1320. static Chunker<SimObject::Notify> notifyChunker(128000);
  1321. SimObject::Notify *SimObject::mNotifyFreeList = NULL;
  1322. //-----------------------------------------------------------------------------
  1323. SimObject::Notify *SimObject::allocNotify()
  1324. {
  1325. if(mNotifyFreeList)
  1326. {
  1327. SimObject::Notify *ret = mNotifyFreeList;
  1328. mNotifyFreeList = ret->next;
  1329. return ret;
  1330. }
  1331. return notifyChunker.alloc();
  1332. }
  1333. //-----------------------------------------------------------------------------
  1334. void SimObject::freeNotify(SimObject::Notify* note)
  1335. {
  1336. AssertFatal(note->type != SimObject::Notify::Invalid, "Invalid notify");
  1337. note->type = SimObject::Notify::Invalid;
  1338. note->next = mNotifyFreeList;
  1339. mNotifyFreeList = note;
  1340. }
  1341. //-----------------------------------------------------------------------------
  1342. SimObject::Notify* SimObject::removeNotify(void *ptr, SimObject::Notify::Type type)
  1343. {
  1344. Notify **list = &mNotifyList;
  1345. while(*list)
  1346. {
  1347. if((*list)->ptr == ptr && (*list)->type == type)
  1348. {
  1349. SimObject::Notify *ret = *list;
  1350. *list = ret->next;
  1351. return ret;
  1352. }
  1353. list = &((*list)->next);
  1354. }
  1355. return NULL;
  1356. }
  1357. //-----------------------------------------------------------------------------
  1358. void SimObject::deleteNotify(SimObject* obj)
  1359. {
  1360. AssertFatal(!obj->isDeleted(),
  1361. "SimManager::deleteNotify: Object is being deleted");
  1362. Notify *note = allocNotify();
  1363. note->ptr = (void *) this;
  1364. note->next = obj->mNotifyList;
  1365. note->type = Notify::DeleteNotify;
  1366. obj->mNotifyList = note;
  1367. note = allocNotify();
  1368. note->ptr = (void *) obj;
  1369. note->next = mNotifyList;
  1370. note->type = Notify::ClearNotify;
  1371. mNotifyList = note;
  1372. //obj->deleteNotifyList.pushBack(this);
  1373. //clearNotifyList.pushBack(obj);
  1374. }
  1375. //-----------------------------------------------------------------------------
  1376. void SimObject::registerReference(SimObject **ptr)
  1377. {
  1378. Notify *note = allocNotify();
  1379. note->ptr = (void *) ptr;
  1380. note->next = mNotifyList;
  1381. note->type = Notify::ObjectRef;
  1382. mNotifyList = note;
  1383. }
  1384. //-----------------------------------------------------------------------------
  1385. void SimObject::unregisterReference(SimObject **ptr)
  1386. {
  1387. Notify *note = removeNotify((void *) ptr, Notify::ObjectRef);
  1388. if(note)
  1389. {
  1390. freeNotify(note);
  1391. if( mFlags.test( AutoDelete ) )
  1392. {
  1393. for( Notify* n = mNotifyList; n != NULL; n = n->next )
  1394. if( n->type == Notify::ObjectRef )
  1395. return;
  1396. deleteObject();
  1397. }
  1398. }
  1399. }
  1400. //-----------------------------------------------------------------------------
  1401. void SimObject::clearNotify(SimObject* obj)
  1402. {
  1403. Notify *note = obj->removeNotify((void *) this, Notify::DeleteNotify);
  1404. if(note)
  1405. freeNotify(note);
  1406. note = removeNotify((void *) obj, Notify::ClearNotify);
  1407. if(note)
  1408. freeNotify(note);
  1409. }
  1410. //-----------------------------------------------------------------------------
  1411. void SimObject::processDeleteNotifies()
  1412. {
  1413. // clear out any delete notifies and
  1414. // object refs.
  1415. while(mNotifyList)
  1416. {
  1417. Notify *note = mNotifyList;
  1418. mNotifyList = note->next;
  1419. AssertFatal(note->type != Notify::ClearNotify, "Clear notes should be all gone.");
  1420. if(note->type == Notify::DeleteNotify)
  1421. {
  1422. SimObject *obj = (SimObject *) note->ptr;
  1423. Notify *cnote = obj->removeNotify((void *)this, Notify::ClearNotify);
  1424. obj->onDeleteNotify(this);
  1425. freeNotify(cnote);
  1426. }
  1427. else
  1428. {
  1429. // it must be an object ref - a pointer refs this object
  1430. *((SimObject **) note->ptr) = NULL;
  1431. }
  1432. freeNotify(note);
  1433. }
  1434. }
  1435. //-----------------------------------------------------------------------------
  1436. void SimObject::clearAllNotifications()
  1437. {
  1438. for(Notify **cnote = &mNotifyList; *cnote; )
  1439. {
  1440. Notify *temp = *cnote;
  1441. if(temp->type == Notify::ClearNotify)
  1442. {
  1443. *cnote = temp->next;
  1444. Notify *note = ((SimObject *) temp->ptr)->removeNotify((void *) this, Notify::DeleteNotify);
  1445. freeNotify(temp);
  1446. if ( note )
  1447. freeNotify(note);
  1448. }
  1449. else
  1450. cnote = &(temp->next);
  1451. }
  1452. }
  1453. //=============================================================================
  1454. // Namespaces.
  1455. //=============================================================================
  1456. // MARK: ---- Namespaces ----
  1457. //-----------------------------------------------------------------------------
  1458. void SimObject::linkNamespaces()
  1459. {
  1460. // Don't link if we already have a namespace linkage in place.
  1461. // If you want to change namespace linking, first call unlinkNamespaces()
  1462. // while still having the class namespace fields matching the current
  1463. // setup.
  1464. if (mNameSpace)
  1465. {
  1466. Con::warnf("SimObject::linkNamespaces -- Namespace linkage already in place %s", mNameSpace->getName());
  1467. return;
  1468. }
  1469. // Get the namespace for the C++ class.
  1470. Namespace* cppNamespace = getClassRep()->getNameSpace();
  1471. // Parent namespace defaults to namespace of C++ class.
  1472. Namespace* parentNamespace = cppNamespace;
  1473. // Perform superclass linking, if requested.
  1474. if( mSuperClassName && mSuperClassName[ 0 ] )
  1475. {
  1476. // Look up the superclass namespace.
  1477. Namespace* superClassNamespace = Con::lookupNamespace( mSuperClassName );
  1478. // If packages are active and adding to the superclass namespace, then we will
  1479. // have multiple packages in a parent chain that all have the same name.
  1480. // Con::lookupNamespace returns the bottom-most package in the chain to us so
  1481. // in order to properly link namespace here without conflicting with the package
  1482. // mechanism, we need to properly link child namespaces to the bottom-most namespace
  1483. // while linking parent namespaces to the topmost namespace. To find the latter
  1484. // one, we walk up the hierarchy here.
  1485. Namespace* superClassNamespacePackageRoot = superClassNamespace->getPackageRoot();
  1486. // Link the superclass namespace to the C++ class namespace.
  1487. if( superClassNamespacePackageRoot->getParent() == NULL )
  1488. {
  1489. // The superclass namespace isn't linked yet so we just
  1490. // link it to the C++ class namespace and make that our parent.
  1491. // No increasing parent reference counts is needed in this case.
  1492. bool ok = superClassNamespacePackageRoot->classLinkTo( cppNamespace );
  1493. AssertFatal( ok, "SimObject::linkNamespaces - failed to link new namespace to c++ class name" );
  1494. parentNamespace = superClassNamespace;
  1495. }
  1496. else
  1497. {
  1498. // In debug builds, make sure the namespace hierarchy that's been
  1499. // put into place actually makes sense and leads back to the C++
  1500. // class namespace.
  1501. #ifdef TORQUE_DEBUG
  1502. bool foundClassNameNS = false;
  1503. for( Namespace* linkWalk = superClassNamespacePackageRoot->getParent(); linkWalk != NULL;
  1504. linkWalk = linkWalk->getParent() )
  1505. {
  1506. if( linkWalk == cppNamespace )
  1507. {
  1508. foundClassNameNS = true;
  1509. break;
  1510. }
  1511. }
  1512. if( !foundClassNameNS )
  1513. {
  1514. // C++ class namespace not in parent link chain. Warn about it.
  1515. Con::errorf(
  1516. "SimObject::linkNamespaces - cannot link object to superclass %s because c++ class %s is not in the parent namespace chain. Linking object to c++ class.",
  1517. mSuperClassName,
  1518. getClassName()
  1519. );
  1520. // Clear out superclass name so we don't come across it during
  1521. // unlinking.
  1522. mSuperClassName = NULL;
  1523. }
  1524. else
  1525. #endif
  1526. {
  1527. // Super link is ok.
  1528. parentNamespace = superClassNamespace;
  1529. // Now increase the reference count of all namespaces in the parent hierarchy
  1530. // (up to the C++ class).
  1531. for( Namespace* linkWalk = parentNamespace;
  1532. linkWalk != NULL && linkWalk != cppNamespace && linkWalk->getParent() != NULL;
  1533. linkWalk = linkWalk->getParent() )
  1534. {
  1535. // Skip namespaces coming from packages.
  1536. if( linkWalk->getPackage() != NULL )
  1537. continue;
  1538. linkWalk->incRefCountToParent();
  1539. }
  1540. }
  1541. }
  1542. }
  1543. // If class name is set, link it in as the new parent
  1544. // which itself inherits from the current parent.
  1545. if( mClassName && mClassName[ 0 ] )
  1546. {
  1547. Namespace* classNamespace = Con::lookupNamespace( mClassName );
  1548. if( classNamespace && classNamespace->classLinkTo( parentNamespace ) )
  1549. {
  1550. parentNamespace = classNamespace;
  1551. }
  1552. else
  1553. {
  1554. // Clear out class name so we don't perform a bogus unlink
  1555. // in unlinkNamespaces().
  1556. mClassName = NULL;
  1557. }
  1558. }
  1559. // Finally, if we have an object name, link its namespace
  1560. // as the child to the current parent namespace and let it
  1561. // become the final namespace of this object.
  1562. StringTableEntry objectName = getName();
  1563. if( objectName && objectName[ 0 ] )
  1564. {
  1565. Namespace* objectNamespace = Con::lookupNamespace( objectName );
  1566. if( objectNamespace && objectNamespace->classLinkTo( parentNamespace ) )
  1567. {
  1568. parentNamespace = objectNamespace;
  1569. }
  1570. }
  1571. // Store our namespace.
  1572. mNameSpace = parentNamespace;
  1573. }
  1574. //-----------------------------------------------------------------------------
  1575. void SimObject::unlinkNamespaces()
  1576. {
  1577. if( !mNameSpace )
  1578. return;
  1579. Namespace* cppNamespace = getClassRep()->getNameSpace();
  1580. Namespace* parentNamespace = cppNamespace;
  1581. // Handle superclass.
  1582. if( mSuperClassName && mSuperClassName[ 0 ] )
  1583. {
  1584. // Get the superclass namespace.
  1585. Namespace* superClassNamespace = Con::lookupNamespace( mSuperClassName );
  1586. // Make it the parent namespace.
  1587. parentNamespace = superClassNamespace;
  1588. // Decrease parent refcounts on the superclass hierarchy.
  1589. for( Namespace* linkWalk = superClassNamespace;
  1590. linkWalk != NULL && linkWalk != cppNamespace && linkWalk->getParent() != NULL; )
  1591. {
  1592. // Store the parent link since it may disappear once we
  1593. // decrease the reference count.
  1594. Namespace* parent = linkWalk->getParent();
  1595. // Decrease the refcount.
  1596. if( linkWalk->getPackage() == NULL ) // Skip namespaces coming from packages.
  1597. linkWalk->decRefCountToParent();
  1598. // Walk up.
  1599. linkWalk = parent;
  1600. }
  1601. }
  1602. // Handle class.
  1603. if( mClassName && mClassName[ 0 ] )
  1604. {
  1605. Namespace* classNamespace = Con::lookupNamespace( mClassName );
  1606. if( classNamespace )
  1607. {
  1608. classNamespace->decRefCountToParent();
  1609. parentNamespace = classNamespace;
  1610. }
  1611. }
  1612. // Handle object name.
  1613. StringTableEntry objectName = getName();
  1614. if( objectName && objectName[ 0 ] )
  1615. mNameSpace->decRefCountToParent();
  1616. mNameSpace = NULL;
  1617. }
  1618. //-----------------------------------------------------------------------------
  1619. void SimObject::setClassNamespace( const char *classNamespace )
  1620. {
  1621. StringTableEntry oldClassNamespace = mClassName;
  1622. StringTableEntry newClassNamespace = StringTable->insert( classNamespace );
  1623. if( oldClassNamespace == newClassNamespace )
  1624. return;
  1625. if( isProperlyAdded() )
  1626. unlinkNamespaces();
  1627. mClassName = newClassNamespace;
  1628. if( isProperlyAdded() )
  1629. {
  1630. linkNamespaces();
  1631. // Restore old namespace setup if linkage failed.
  1632. if( mClassName != newClassNamespace )
  1633. {
  1634. mClassName = oldClassNamespace;
  1635. linkNamespaces();
  1636. }
  1637. }
  1638. }
  1639. //-----------------------------------------------------------------------------
  1640. void SimObject::setSuperClassNamespace( const char *superClassNamespace )
  1641. {
  1642. StringTableEntry oldSuperClassNamespace = mSuperClassName;
  1643. StringTableEntry newSuperClassNamespace = StringTable->insert( superClassNamespace );
  1644. if( oldSuperClassNamespace == newSuperClassNamespace )
  1645. return;
  1646. if( isProperlyAdded() )
  1647. unlinkNamespaces();
  1648. mSuperClassName = newSuperClassNamespace;
  1649. if( isProperlyAdded() )
  1650. {
  1651. linkNamespaces();
  1652. // Restore old setup if linkage failed.
  1653. if( mSuperClassName != newSuperClassNamespace )
  1654. {
  1655. mSuperClassName = oldSuperClassNamespace;
  1656. linkNamespaces();
  1657. }
  1658. }
  1659. }
  1660. //=============================================================================
  1661. // Misc.
  1662. //=============================================================================
  1663. // MARK: ---- Misc ----
  1664. //-----------------------------------------------------------------------------
  1665. void SimObject::setInternalName( const char* newname )
  1666. {
  1667. if( newname )
  1668. mInternalName = StringTable->insert( newname );
  1669. else
  1670. mInternalName = StringTable->EmptyString();
  1671. }
  1672. //-----------------------------------------------------------------------------
  1673. void SimObject::setOriginalName( const char* originalName )
  1674. {
  1675. if( originalName )
  1676. mOriginalName = StringTable->insert( originalName );
  1677. else
  1678. mOriginalName = StringTable->EmptyString();
  1679. }
  1680. //-----------------------------------------------------------------------------
  1681. const char *SimObject::tabComplete(const char *prevText, S32 baseLen, bool fForward)
  1682. {
  1683. return mNameSpace->tabComplete(prevText, baseLen, fForward);
  1684. }
  1685. //-----------------------------------------------------------------------------
  1686. void SimObject::setSelected( bool sel )
  1687. {
  1688. if( mFlags.test( Selected ) == sel )
  1689. return; // No change.
  1690. if( sel )
  1691. {
  1692. mFlags.set( Selected );
  1693. _onSelected();
  1694. }
  1695. else
  1696. {
  1697. mFlags.clear( Selected );
  1698. _onUnselected();
  1699. }
  1700. }
  1701. //-----------------------------------------------------------------------------
  1702. bool SimObject::isSelectedRecursive() const
  1703. {
  1704. const SimObject *walk = this;
  1705. while ( walk )
  1706. {
  1707. if ( walk->isSelected() )
  1708. return true;
  1709. walk = walk->getGroup();
  1710. }
  1711. return false;
  1712. }
  1713. //-----------------------------------------------------------------------------
  1714. void SimObject::setLocked( bool b )
  1715. {
  1716. if( b )
  1717. mFlags.set( Locked );
  1718. else
  1719. mFlags.clear( Locked );
  1720. }
  1721. //-----------------------------------------------------------------------------
  1722. void SimObject::setHidden( bool b )
  1723. {
  1724. if( b )
  1725. mFlags.set( Hidden );
  1726. else
  1727. mFlags.clear( Hidden );
  1728. }
  1729. //-----------------------------------------------------------------------------
  1730. void SimObject::setCopySource( SimObject* object )
  1731. {
  1732. if( mCopySource )
  1733. mCopySource->unregisterReference( &mCopySource );
  1734. mCopySource = object;
  1735. if( mCopySource )
  1736. mCopySource->registerReference( &mCopySource );
  1737. }
  1738. //---------------------------------------------------------------------------
  1739. bool SimObject::_setCanSave( void* object, const char* index, const char* data )
  1740. {
  1741. SimObject* obj = reinterpret_cast< SimObject* >( object );
  1742. obj->setCanSave( dAtob( data ) );
  1743. return false;
  1744. }
  1745. //-----------------------------------------------------------------------------
  1746. const char* SimObject::_getCanSave( void* object, const char* data )
  1747. {
  1748. SimObject* obj = reinterpret_cast< SimObject* >( object );
  1749. if( obj->getCanSave() )
  1750. return "1";
  1751. else
  1752. return "0";
  1753. }
  1754. //---------------------------------------------------------------------------
  1755. // Copy SimObject to another SimObject (Originally designed for T2D).
  1756. void SimObject::copyTo( SimObject* object )
  1757. {
  1758. object->mClassName = mClassName;
  1759. object->mSuperClassName = mSuperClassName;
  1760. linkNamespaces();
  1761. }
  1762. //-----------------------------------------------------------------------------
  1763. bool SimObject::setProtectedParent( void *obj, const char *index, const char *data )
  1764. {
  1765. SimGroup *parent = NULL;
  1766. SimObject *object = static_cast<SimObject*>(obj);
  1767. if(Sim::findObject(data, parent))
  1768. parent->addObject(object);
  1769. // always return false, because we've set mGroup when we called addObject
  1770. return false;
  1771. }
  1772. //-----------------------------------------------------------------------------
  1773. bool SimObject::setProtectedName(void *obj, const char *index, const char *data)
  1774. {
  1775. if (preventNameChanging)
  1776. return false;
  1777. SimObject* object = static_cast<SimObject*>(obj);
  1778. if (object->isProperlyAdded())
  1779. object->assignName(data);
  1780. // always return false because we assign the name here
  1781. return false;
  1782. }
  1783. //-----------------------------------------------------------------------------
  1784. bool SimObject::setInheritFrom(void* obj, const char* index, const char* data)
  1785. {
  1786. SimObject* object = static_cast<SimObject*>(obj);
  1787. SimObject* parent;
  1788. if (Sim::findObject(data, parent))
  1789. {
  1790. object->setCopySource(parent);
  1791. object->assignFieldsFrom(parent);
  1792. // copy any substitution statements
  1793. SimDataBlock* parent_db = dynamic_cast<SimDataBlock*>(parent);
  1794. if (parent_db)
  1795. {
  1796. SimDataBlock* currentNewObject_db = dynamic_cast<SimDataBlock*>(object);
  1797. if (currentNewObject_db)
  1798. currentNewObject_db->copySubstitutionsFrom(parent_db);
  1799. }
  1800. }
  1801. return true;
  1802. }
  1803. //-----------------------------------------------------------------------------
  1804. void SimObject::inspectPreApply()
  1805. {
  1806. }
  1807. //-----------------------------------------------------------------------------
  1808. void SimObject::inspectPostApply()
  1809. {
  1810. onInspectPostApply_callback(this);
  1811. }
  1812. //-----------------------------------------------------------------------------
  1813. String SimObject::_getLogMessage(const char* fmt, va_list args) const
  1814. {
  1815. String objClass = "UnknownClass";
  1816. if(getClassRep())
  1817. objClass = getClassRep()->getClassName();
  1818. String objName = getName();
  1819. if(objName.isEmpty())
  1820. objName = "Unnamed";
  1821. String formattedMessage = String::VToString(fmt, args);
  1822. return String::ToString("%s - %s(%i) - %s",
  1823. objClass.c_str(), objName.c_str(), getId(), formattedMessage.c_str());
  1824. }
  1825. //=============================================================================
  1826. // API.
  1827. //=============================================================================
  1828. // MARK: ---- API ----
  1829. //-----------------------------------------------------------------------------
  1830. DefineEngineMethod( SimObject, dumpGroupHierarchy, void, (),,
  1831. "Dump the hierarchy of this object up to RootGroup to the console." )
  1832. {
  1833. object->dumpGroupHierarchy();
  1834. }
  1835. //-----------------------------------------------------------------------------
  1836. DefineEngineMethod( SimObject, isMethod, bool, ( const char* methodName ),,
  1837. "Test whether the given method is defined on this object.\n"
  1838. "@param The name of the method.\n"
  1839. "@return True if the object implements the given method." )
  1840. {
  1841. return object->isMethod( methodName );
  1842. }
  1843. //-----------------------------------------------------------------------------
  1844. DefineEngineMethod( SimObject, isChildOfGroup, bool, ( SimGroup* group ),,
  1845. "Test whether the object belongs directly or indirectly to the given group.\n"
  1846. "@param group The SimGroup object.\n"
  1847. "@return True if the object is a child of the given group or a child of a group that the given group is directly or indirectly a child to." )
  1848. {
  1849. return object->isChildOfGroup( group );
  1850. }
  1851. //-----------------------------------------------------------------------------
  1852. DefineEngineMethod( SimObject, getClassNamespace, const char*, (),,
  1853. "Get the name of the class namespace assigned to this object.\n"
  1854. "@return The name of the 'class' namespace." )
  1855. {
  1856. return object->getClassNamespace();
  1857. }
  1858. //-----------------------------------------------------------------------------
  1859. DefineEngineMethod( SimObject, getSuperClassNamespace, const char*, (),,
  1860. "Get the name of the superclass namespace assigned to this object.\n"
  1861. "@return The name of the 'superClass' namespace." )
  1862. {
  1863. return object->getSuperClassNamespace();
  1864. }
  1865. //-----------------------------------------------------------------------------
  1866. DefineEngineMethod( SimObject, setClassNamespace, void, ( const char* name ),,
  1867. "Assign a class namespace to this object.\n"
  1868. "@param name The name of the 'class' namespace for this object." )
  1869. {
  1870. object->setClassNamespace( name );
  1871. }
  1872. //-----------------------------------------------------------------------------
  1873. DefineEngineMethod( SimObject, setSuperClassNamespace, void, ( const char* name ),,
  1874. "Assign a superclass namespace to this object.\n"
  1875. "@param name The name of the 'superClass' namespace for this object." )
  1876. {
  1877. object->setSuperClassNamespace( name );
  1878. }
  1879. //-----------------------------------------------------------------------------
  1880. DefineEngineMethod( SimObject, isSelected, bool, (),,
  1881. "Get whether the object has been marked as selected. (in editor)\n"
  1882. "@return True if the object is currently selected." )
  1883. {
  1884. return object->isSelected();
  1885. }
  1886. //-----------------------------------------------------------------------------
  1887. DefineEngineMethod( SimObject, setIsSelected, void, ( bool state ), ( true ),
  1888. "Set whether the object has been marked as selected. (in editor)\n"
  1889. "@param state True if object is to be marked selected; false if not." )
  1890. {
  1891. object->setSelected( state );
  1892. }
  1893. //-----------------------------------------------------------------------------
  1894. DefineEngineMethod( SimObject, isExpanded, bool, (),,
  1895. "Get whether the object has been marked as expanded. (in editor)\n"
  1896. "@return True if the object is marked expanded." )
  1897. {
  1898. return object->isExpanded();
  1899. }
  1900. //-----------------------------------------------------------------------------
  1901. DefineEngineMethod( SimObject, setIsExpanded, void, ( bool state ), ( true ),
  1902. "Set whether the object has been marked as expanded. (in editor)\n"
  1903. "@param state True if the object is to be marked expanded; false if not." )
  1904. {
  1905. object->setExpanded( state );
  1906. }
  1907. //-----------------------------------------------------------------------------
  1908. DefineEngineMethod( SimObject, getFilename, const char*, (),,
  1909. "Returns the filename the object is attached to.\n"
  1910. "@return The name of the file the object is associated with; usually the file the object was loaded from." )
  1911. {
  1912. return object->getFilename();
  1913. }
  1914. //-----------------------------------------------------------------------------
  1915. DefineEngineMethod( SimObject, setFilename, void, ( const char* fileName ),,
  1916. "Sets the object's file name and path\n"
  1917. "@param fileName The name of the file to associate this object with." )
  1918. {
  1919. return object->setFilename( fileName );
  1920. }
  1921. //-----------------------------------------------------------------------------
  1922. DefineEngineMethod( SimObject, getDeclarationLine, S32, (),,
  1923. "Get the line number at which the object is defined in its file.\n\n"
  1924. "@return The line number of the object's definition in script.\n"
  1925. "@see getFilename()")
  1926. {
  1927. return object->getDeclarationLine();
  1928. }
  1929. //-----------------------------------------------------------------------------
  1930. #ifdef TORQUE_DEBUG
  1931. static const char* sEnumCallbackFunction;
  1932. static void sEnumCallback( EngineObject* object )
  1933. {
  1934. SimObject* simObject = dynamic_cast< SimObject* >( object );
  1935. if( !simObject )
  1936. return;
  1937. Con::evaluatef( "%s( %i );", sEnumCallbackFunction, simObject->getId() );
  1938. }
  1939. DefineEngineFunction( debugEnumInstances, void, ( const char* className, const char* functionName ),,
  1940. "Call the given function for each instance of the given class.\n"
  1941. "@param className Name of the class for which to enumerate instances.\n"
  1942. "@param functionName Name of function to call and pass each instance of the given class.\n"
  1943. "@note This function is only available in debug builds and primarily meant as an aid in debugging."
  1944. "@ingroup Console")
  1945. {
  1946. sEnumCallbackFunction = functionName;
  1947. ConsoleObject::debugEnumInstances( className, sEnumCallback );
  1948. }
  1949. #endif
  1950. //-----------------------------------------------------------------------------
  1951. DefineEngineMethod( SimObject, assignFieldsFrom, void, ( SimObject* fromObject ),,
  1952. "Copy fields from another object onto this one. The objects must "
  1953. "be of same type. Everything from the object will overwrite what's "
  1954. "in this object; extra fields in this object will remain. This "
  1955. "includes dynamic fields.\n"
  1956. "@param fromObject The object from which to copy fields." )
  1957. {
  1958. if( fromObject )
  1959. object->assignFieldsFrom( fromObject );
  1960. }
  1961. //-----------------------------------------------------------------------------
  1962. DefineEngineMethod( SimObject, assignPersistentId, void, (),,
  1963. "Assign a persistent ID to the object if it does not already have one." )
  1964. {
  1965. object->getOrCreatePersistentId();
  1966. }
  1967. //-----------------------------------------------------------------------------
  1968. DefineEngineMethod( SimObject, getCanSave, bool, (),,
  1969. "Get whether the object will be included in saves.\n"
  1970. "@return True if the object will be saved; false otherwise." )
  1971. {
  1972. return object->getCanSave();
  1973. }
  1974. //-----------------------------------------------------------------------------
  1975. DefineEngineMethod( SimObject, setCanSave, void, ( bool value ), ( true ),
  1976. "Set whether the object will be included in saves.\n"
  1977. "@param value If true, the object will be included in saves; if false, it will be excluded." )
  1978. {
  1979. object->setCanSave( value );
  1980. }
  1981. //-----------------------------------------------------------------------------
  1982. DefineEngineMethod( SimObject, isEditorOnly, bool, (),,
  1983. "Return true if the object is only used by the editor.\n"
  1984. "@return True if this object exists only for the sake of editing." )
  1985. {
  1986. return object->isEditorOnly();
  1987. }
  1988. //-----------------------------------------------------------------------------
  1989. DefineEngineMethod( SimObject, setEditorOnly, void, ( bool value ), ( true ),
  1990. "Set/clear the editor-only flag on this object.\n"
  1991. "@param value If true, the object is marked as existing only for the editor." )
  1992. {
  1993. object->setEditorOnly( value );
  1994. }
  1995. //-----------------------------------------------------------------------------
  1996. DefineEngineMethod( SimObject, isNameChangeAllowed, bool, (),,
  1997. "Get whether this object may be renamed.\n"
  1998. "@return True if this object can be renamed; false otherwise." )
  1999. {
  2000. return object->isNameChangeAllowed();
  2001. }
  2002. //-----------------------------------------------------------------------------
  2003. DefineEngineMethod( SimObject, setNameChangeAllowed, void, ( bool value ), ( true ),
  2004. "Set whether this object can be renamed from its first name.\n"
  2005. "@param value If true, renaming is allowed for this object; if false, trying to change the name of the object will generate a console error." )
  2006. {
  2007. object->setNameChangeAllowed( value );
  2008. }
  2009. //-----------------------------------------------------------------------------
  2010. DefineEngineMethod( SimObject, clone, SimObject*, (),,
  2011. "Create a copy of this object.\n"
  2012. "@return An exact duplicate of this object." )
  2013. {
  2014. return object->clone();
  2015. }
  2016. //-----------------------------------------------------------------------------
  2017. DefineEngineMethod( SimObject, deepClone, SimObject*, (),,
  2018. "Create a copy of this object and all its subobjects.\n"
  2019. "@return An exact duplicate of this object and all objects it references." )
  2020. {
  2021. return object->deepClone();
  2022. }
  2023. //-----------------------------------------------------------------------------
  2024. DefineEngineMethod( SimObject, setLocked, void, ( bool value ), ( true ),
  2025. "Lock/unlock the object in the editor.\n"
  2026. "@param value If true, the object will be locked; if false, the object will be unlocked." )
  2027. {
  2028. object->setLocked( value );
  2029. }
  2030. //-----------------------------------------------------------------------------
  2031. DefineEngineMethod( SimObject, setHidden, void, ( bool value ), ( true ),
  2032. "Hide/unhide the object.\n"
  2033. "@param value If true, the object will be hidden; if false, the object will be unhidden." )
  2034. {
  2035. object->setHidden( value );
  2036. }
  2037. //-----------------------------------------------------------------------------
  2038. DefineEngineMethod( SimObject, dumpMethods, ArrayObject*, (),,
  2039. "List the methods defined on this object.\n\n"
  2040. "Each description is a newline-separated vector with the following elements:\n"
  2041. "- Minimum number of arguments.\n"
  2042. "- Maximum number of arguments.\n"
  2043. "- Prototype string.\n"
  2044. "- Full script file path (if script method).\n"
  2045. "- Line number of method definition in script (if script method).\n\n"
  2046. "- Documentation string (not including prototype). This takes up the remainder of the vector.\n"
  2047. "@return An ArrayObject populated with (name,description) pairs of all methods defined on the object." )
  2048. {
  2049. Namespace *ns = object->getNamespace();
  2050. if( !ns )
  2051. return 0;
  2052. ArrayObject* dictionary = new ArrayObject();
  2053. dictionary->registerObject();
  2054. VectorPtr<Namespace::Entry *> vec(__FILE__, __LINE__);
  2055. ns->getEntryList(&vec);
  2056. for(Vector< Namespace::Entry* >::iterator j = vec.begin(); j != vec.end(); j++)
  2057. {
  2058. Namespace::Entry* e = *j;
  2059. if( e->mType < 0 )
  2060. continue;
  2061. StringBuilder str;
  2062. str.append( String::ToString( e->mMinArgs ) );
  2063. str.append( '\n' );
  2064. str.append( String::ToString( e->mMaxArgs ) );
  2065. str.append( '\n' );
  2066. str.append( e->getPrototypeString() );
  2067. str.append( '\n' );
  2068. if( e->mCode && e->mCode->fullPath )
  2069. str.append( e->mCode->fullPath );
  2070. str.append( '\n' );
  2071. if( e->mCode )
  2072. str.append( String::ToString( e->mFunctionLineNumber ) );
  2073. str.append( '\n' );
  2074. String docs = e->getDocString();
  2075. if( !docs.isEmpty() )
  2076. str.append( docs );
  2077. dictionary->push_back( e->mFunctionName, str.end() );
  2078. }
  2079. return dictionary;
  2080. }
  2081. //-----------------------------------------------------------------------------
  2082. namespace {
  2083. S32 QSORT_CALLBACK compareFields( const void* a,const void* b )
  2084. {
  2085. const AbstractClassRep::Field* fa = *((const AbstractClassRep::Field**)a);
  2086. const AbstractClassRep::Field* fb = *((const AbstractClassRep::Field**)b);
  2087. return dStricmp(fa->pFieldname, fb->pFieldname);
  2088. }
  2089. struct DocString
  2090. {
  2091. char mPadding[ 8 ];
  2092. String mPrototype;
  2093. String mDescription;
  2094. const char* mReturnType;
  2095. DocString( Namespace::Entry* entry )
  2096. : mPrototype( entry->getArgumentsString() ),
  2097. mDescription( entry->getBriefDescription() )
  2098. {
  2099. mReturnType = " ";
  2100. mPadding[ 0 ] = 0;
  2101. if( entry->mType == -4 )
  2102. {
  2103. //TODO: need to have script callbacks set up proper return type info
  2104. }
  2105. else
  2106. {
  2107. switch( entry->mType )
  2108. {
  2109. case Namespace::Entry::StringCallbackType:
  2110. mReturnType = "string";
  2111. mPadding[ 0 ] = ' ';
  2112. mPadding[ 1 ] = ' ';
  2113. mPadding[ 2 ] = 0;
  2114. break;
  2115. case Namespace::Entry::IntCallbackType:
  2116. mReturnType = "int";
  2117. mPadding[ 0 ] = ' ';
  2118. mPadding[ 1 ] = ' ';
  2119. mPadding[ 2 ] = ' ';
  2120. mPadding[ 3 ] = ' ';
  2121. mPadding[ 4 ] = ' ';
  2122. mPadding[ 5 ] = 0;
  2123. break;
  2124. case Namespace::Entry::FloatCallbackType:
  2125. mReturnType = "float";
  2126. mPadding[ 0 ] = ' ';
  2127. mPadding[ 1 ] = ' ';
  2128. mPadding[ 2 ] = ' ';
  2129. mPadding[ 3 ] = 0;
  2130. break;
  2131. case Namespace::Entry::VoidCallbackType:
  2132. mReturnType = "void";
  2133. mPadding[ 0 ] = ' ';
  2134. mPadding[ 1 ] = ' ';
  2135. mPadding[ 2 ] = ' ';
  2136. mPadding[ 3 ] = ' ';
  2137. mPadding[ 4 ] = 0;
  2138. break;
  2139. case Namespace::Entry::BoolCallbackType:
  2140. mReturnType = "bool";
  2141. mPadding[ 0 ] = ' ';
  2142. mPadding[ 1 ] = ' ';
  2143. mPadding[ 2 ] = ' ';
  2144. mPadding[ 3 ] = ' ';
  2145. mPadding[ 4 ] = 0;
  2146. break;
  2147. }
  2148. }
  2149. }
  2150. };
  2151. }
  2152. DefineEngineMethod( SimObject, dump, void, ( bool detailed ), ( false ),
  2153. "Dump a description of all fields and methods defined on this object to the console.\n"
  2154. "@param detailed Whether to print detailed information about members." )
  2155. {
  2156. Con::printf( "Class: %s", object->getClassName() );
  2157. const AbstractClassRep::FieldList &list = object->getFieldList();
  2158. char expandedBuffer[4096];
  2159. Con::printf( "Static Fields:" );
  2160. Vector<const AbstractClassRep::Field *> flist(__FILE__, __LINE__);
  2161. for(U32 i = 0; i < list.size(); i++)
  2162. flist.push_back(&list[i]);
  2163. dQsort(flist.address(),flist.size(),sizeof(AbstractClassRep::Field *),compareFields);
  2164. for(Vector<const AbstractClassRep::Field *>::iterator itr = flist.begin(); itr != flist.end(); itr++)
  2165. {
  2166. const AbstractClassRep::Field* f = *itr;
  2167. // The special field types can be skipped.
  2168. if ( f->type >= AbstractClassRep::ARCFirstCustomField )
  2169. continue;
  2170. for(U32 j = 0; S32(j) < f->elementCount; j++)
  2171. {
  2172. // [neo, 07/05/2007 - #3000]
  2173. // Some objects use dummy vars and projected fields so make sure we call the get functions
  2174. //const char *val = Con::getData(f->type, (void *) (((const char *)object) + f->offset), j, f->table, f->flag);
  2175. const char *val = (*f->getDataFn)( object, Con::getData(f->type, (void *) (((const char *)object) + f->offset), j, f->table, f->flag) );// + typeSizes[fld.type] * array1));
  2176. ConsoleBaseType* conType = ConsoleBaseType::getType( f->type );
  2177. const char* conTypeName = "<unknown>";
  2178. if( conType )
  2179. conTypeName = conType->getTypeClassName();
  2180. if( !val /*|| !*val*/ )
  2181. continue;
  2182. if( f->elementCount == 1 )
  2183. dSprintf( expandedBuffer, sizeof( expandedBuffer ), " %s %s = \"", conTypeName, f->pFieldname );
  2184. else
  2185. dSprintf( expandedBuffer, sizeof( expandedBuffer ), " %s %s[ %d ] = \"", conTypeName, f->pFieldname, j );
  2186. expandEscape( expandedBuffer + dStrlen(expandedBuffer), val);
  2187. Con::printf( "%s\"", expandedBuffer );
  2188. if( detailed && f->pFieldDocs && f->pFieldDocs[ 0 ] )
  2189. Con::printf( " %s", f->pFieldDocs );
  2190. }
  2191. }
  2192. // If the object is a datablock with substitution statements,
  2193. // they get printed out as part of the dump.
  2194. if (dynamic_cast<SimDataBlock*>(object))
  2195. {
  2196. if (((SimDataBlock*)object)->getSubstitutionCount() > 0)
  2197. {
  2198. Con::printf("Substitution Fields:");
  2199. ((SimDataBlock*)object)->printSubstitutions();
  2200. }
  2201. }
  2202. Con::printf( "Dynamic Fields:" );
  2203. if(object->getFieldDictionary())
  2204. object->getFieldDictionary()->printFields(object);
  2205. Con::printf( "Methods:" );
  2206. Namespace *ns = object->getNamespace();
  2207. VectorPtr<Namespace::Entry *> vec(__FILE__, __LINE__);
  2208. if(ns)
  2209. ns->getEntryList(&vec);
  2210. bool sawCBs = false;
  2211. for(Vector<Namespace::Entry *>::iterator j = vec.begin(); j != vec.end(); j++)
  2212. {
  2213. Namespace::Entry *e = *j;
  2214. if(e->mType == Namespace::Entry::ScriptCallbackType)
  2215. sawCBs = true;
  2216. if(e->mType < 0)
  2217. continue;
  2218. DocString doc( e );
  2219. Con::printf( " %s%s%s%s", doc.mReturnType, doc.mPadding, e->mFunctionName, doc.mPrototype.c_str() );
  2220. if( detailed && !doc.mDescription.isEmpty() )
  2221. Con::printf( " %s", doc.mDescription.c_str() );
  2222. }
  2223. if( sawCBs )
  2224. {
  2225. Con::printf( "Callbacks:" );
  2226. for(Vector<Namespace::Entry *>::iterator j = vec.begin(); j != vec.end(); j++)
  2227. {
  2228. Namespace::Entry *e = *j;
  2229. if(e->mType != Namespace::Entry::ScriptCallbackType)
  2230. continue;
  2231. DocString doc( e );
  2232. Con::printf( " %s%s%s%s", doc.mReturnType, doc.mPadding, e->cb.mCallbackName, doc.mPrototype.c_str() );
  2233. if( detailed && !doc.mDescription.isEmpty() )
  2234. Con::printf( " %s", doc.mDescription.c_str() );
  2235. }
  2236. }
  2237. }
  2238. //-----------------------------------------------------------------------------
  2239. DefineEngineMethod( SimObject, save, bool, ( const char* fileName, bool selectedOnly, const char* preAppendString ), ( false, "" ),
  2240. "Save out the object to the given file.\n"
  2241. "@param fileName The name of the file to save to."
  2242. "@param selectedOnly If true, only objects marked as selected will be saved out.\n"
  2243. "@param preAppendString Text which will be preprended directly to the object serialization.\n"
  2244. "@param True on success, false on failure." )
  2245. {
  2246. return object->save( fileName, selectedOnly, preAppendString );
  2247. }
  2248. //-----------------------------------------------------------------------------
  2249. DefineEngineMethod( SimObject, setName, void, ( const char* newName ),,
  2250. "Set the global name of the object.\n"
  2251. "@param newName The new global name to assign to the object.\n"
  2252. "@note If name changing is disallowed on the object, the method will fail with a console error." )
  2253. {
  2254. object->assignName( newName );
  2255. }
  2256. //-----------------------------------------------------------------------------
  2257. DefineEngineMethod( SimObject, getName, const char*, (),,
  2258. "Get the global name of the object.\n"
  2259. "@return The global name assigned to the object." )
  2260. {
  2261. const char *ret = object->getName();
  2262. return ret ? ret : "";
  2263. }
  2264. //-----------------------------------------------------------------------------
  2265. DefineEngineMethod( SimObject, getClassName, const char*, (),,
  2266. "Get the name of the C++ class which the object is an instance of.\n"
  2267. "@return The name of the C++ class of the object." )
  2268. {
  2269. const char *ret = object->getClassName();
  2270. return ret ? ret : "";
  2271. }
  2272. //-----------------------------------------------------------------------------
  2273. DefineEngineMethod( SimObject, isField, bool, ( const char* fieldName ),,
  2274. "Test whether the given field is defined on this object.\n"
  2275. "@param fieldName The name of the field.\n"
  2276. "@return True if the object implements the given field." )
  2277. {
  2278. return object->isField( fieldName );
  2279. }
  2280. //-----------------------------------------------------------------------------
  2281. DefineEngineMethod( SimObject, getFieldValue, const char*, ( const char* fieldName, S32 index ), ( -1 ),
  2282. "Return the value of the given field on this object.\n"
  2283. "@param fieldName The name of the field. If it includes a field index, the index is parsed out.\n"
  2284. "@param index Optional parameter to specify the index of an array field separately.\n"
  2285. "@return The value of the given field or \"\" if undefined." )
  2286. {
  2287. const U32 nameLen = dStrlen( fieldName );
  2288. if (nameLen == 0)
  2289. return "";
  2290. char fieldNameBuffer[ 1024 ];
  2291. char arrayIndexBuffer[ 64 ];
  2292. // Parse out index if the field is given in the form of 'name[index]'.
  2293. const char* arrayIndex = NULL;
  2294. if( fieldName[ nameLen - 1 ] == ']' )
  2295. {
  2296. const char* leftBracket = dStrchr( fieldName, '[' );
  2297. const char* rightBracket = &fieldName[ nameLen - 1 ];
  2298. const U32 fieldNameLen = getMin( U32( leftBracket - fieldName ), sizeof( fieldNameBuffer ) - 1 );
  2299. const U32 arrayIndexLen = getMin( U32( rightBracket - leftBracket - 1 ), sizeof( arrayIndexBuffer ) - 1 );
  2300. dMemcpy( fieldNameBuffer, fieldName, fieldNameLen );
  2301. dMemcpy( arrayIndexBuffer, leftBracket + 1, arrayIndexLen );
  2302. fieldNameBuffer[ fieldNameLen ] = '\0';
  2303. arrayIndexBuffer[ arrayIndexLen ] = '\0';
  2304. fieldName = fieldNameBuffer;
  2305. arrayIndex = arrayIndexBuffer;
  2306. }
  2307. fieldName = StringTable->insert( fieldName );
  2308. if( index != -1 )
  2309. {
  2310. dSprintf( arrayIndexBuffer, sizeof( arrayIndexBuffer ), "%i", index );
  2311. arrayIndex = arrayIndexBuffer;
  2312. }
  2313. return object->getDataField( fieldName, arrayIndex );
  2314. }
  2315. //-----------------------------------------------------------------------------
  2316. DefineEngineMethod( SimObject, setFieldValue, bool, ( const char* fieldName, const char* value, S32 index ), ( -1 ),
  2317. "Set the value of the given field on this object.\n"
  2318. "@param fieldName The name of the field to assign to. If it includes an array index, the index will be parsed out.\n"
  2319. "@param value The new value to assign to the field.\n"
  2320. "@param index Optional argument to specify an index for an array field.\n"
  2321. "@return True." )
  2322. {
  2323. char fieldNameBuffer[ 1024 ];
  2324. char arrayIndexBuffer[ 64 ];
  2325. // Parse out index if the field is given in the form of 'name[index]'.
  2326. const char* arrayIndex = NULL;
  2327. const U32 nameLen = dStrlen( fieldName );
  2328. if( fieldName[ nameLen - 1 ] == ']' )
  2329. {
  2330. const char* leftBracket = dStrchr( fieldName, '[' );
  2331. const char* rightBracket = &fieldName[ nameLen - 1 ];
  2332. const U32 fieldNameLen = getMin( U32( leftBracket - fieldName ), sizeof( fieldNameBuffer ) - 1 );
  2333. const U32 arrayIndexLen = getMin( U32( rightBracket - leftBracket - 1 ), sizeof( arrayIndexBuffer ) - 1 );
  2334. dMemcpy( fieldNameBuffer, fieldName, fieldNameLen );
  2335. dMemcpy( arrayIndexBuffer, leftBracket + 1, arrayIndexLen );
  2336. fieldNameBuffer[ fieldNameLen ] = '\0';
  2337. arrayIndexBuffer[ arrayIndexLen ] = '\0';
  2338. fieldName = fieldNameBuffer;
  2339. arrayIndex = arrayIndexBuffer;
  2340. }
  2341. fieldName = StringTable->insert( fieldName );
  2342. if( index != -1 )
  2343. {
  2344. dSprintf( arrayIndexBuffer, sizeof( arrayIndexBuffer ), "%i", index );
  2345. arrayIndex = arrayIndexBuffer;
  2346. }
  2347. object->setDataField( fieldName, arrayIndex, value );
  2348. return true;
  2349. }
  2350. //-----------------------------------------------------------------------------
  2351. DefineEngineMethod( SimObject, getFieldType, const char*, ( const char* fieldName ),,
  2352. "Get the console type code of the given field.\n"
  2353. "@return The numeric type code for the underlying console type of the given field." )
  2354. {
  2355. U32 typeID = object->getDataFieldType( StringTable->insert( fieldName ), NULL );
  2356. ConsoleBaseType* type = ConsoleBaseType::getType( typeID );
  2357. if( type )
  2358. return type->getTypeName();
  2359. return "";
  2360. }
  2361. //-----------------------------------------------------------------------------
  2362. DefineEngineMethod( SimObject, setFieldType, void, ( const char* fieldName, const char* type ),,
  2363. "Set the console type code for the given field.\n"
  2364. "@param fieldName The name of the dynamic field to change to type for.\n"
  2365. "@param type The name of the console type.\n"
  2366. "@note This only works for dynamic fields. Types of static fields cannot be changed." )
  2367. {
  2368. object->setDataFieldType( type, StringTable->insert( fieldName ), NULL );
  2369. }
  2370. //-----------------------------------------------------------------------------
  2371. DefineEngineStringlyVariadicMethod( SimObject, call, const char*, 3, 0, "( string method, string args... ) Dynamically call a method on an object.\n"
  2372. "@param method Name of method to call.\n"
  2373. "@param args Zero or more arguments for the method.\n"
  2374. "@return The result of the method call." )
  2375. {
  2376. argv[1].setString(argv[2].getString());
  2377. ConsoleValue returnValue = Con::execute(object, argc - 1, argv + 1);
  2378. return Con::getReturnBuffer(returnValue.getString());
  2379. }
  2380. //-----------------------------------------------------------------------------
  2381. DefineEngineMethod( SimObject, setInternalName, void, ( const char* newInternalName ),,
  2382. "Set the internal name of the object.\n"
  2383. "@param newInternalName The new internal name for the object." )
  2384. {
  2385. object->setInternalName( newInternalName );
  2386. }
  2387. //-----------------------------------------------------------------------------
  2388. DefineEngineMethod( SimObject, getInternalName, const char*, (),,
  2389. "Get the internal name of the object.\n"
  2390. "@return The internal name of the object." )
  2391. {
  2392. return object->getInternalName();
  2393. }
  2394. //-----------------------------------------------------------------------------
  2395. DefineEngineMethod( SimObject, dumpClassHierarchy, void, (),,
  2396. "Dump the native C++ class hierarchy of this object's C++ class to the console." )
  2397. {
  2398. object->dumpClassHierarchy();
  2399. }
  2400. //-----------------------------------------------------------------------------
  2401. DefineEngineMethod( SimObject, isMemberOfClass, bool, ( const char* className ),,
  2402. "Test whether this object is a member of the specified class.\n"
  2403. "@param className Name of a native C++ class.\n"
  2404. "@return True if this object is an instance of the given C++ class or any of its super classes." )
  2405. {
  2406. AbstractClassRep* pRep = object->getClassRep();
  2407. while(pRep)
  2408. {
  2409. if( !dStricmp(pRep->getClassName(), className ) )
  2410. {
  2411. //matches
  2412. return true;
  2413. }
  2414. pRep = pRep->getParentClass();
  2415. }
  2416. return false;
  2417. }
  2418. //-----------------------------------------------------------------------------
  2419. DefineEngineMethod( SimObject, isInNamespaceHierarchy, bool, ( const char* name ),,
  2420. "Test whether the namespace of this object is a direct or indirect child to the given namespace.\n"
  2421. "@param name The name of a namespace.\n"
  2422. "@return True if the given namespace name is within the namespace hierarchy of this object." )
  2423. {
  2424. Namespace* nspace = object->getNamespace();
  2425. while( nspace && dStricmp( nspace->mName, name ) != 0 )
  2426. nspace = nspace->mParent;
  2427. return ( nspace != NULL );
  2428. }
  2429. //-----------------------------------------------------------------------------
  2430. DefineEngineMethod( SimObject, getId, S32, (),,
  2431. "Get the underlying unique numeric ID of the object.\n"
  2432. "@note Object IDs are unique only during single engine runs.\n"
  2433. "@return The unique numeric ID of the object." )
  2434. {
  2435. return object->getId();
  2436. }
  2437. //-----------------------------------------------------------------------------
  2438. DefineEngineMethod( SimObject, getGroup, SimGroup*, (),,
  2439. "Get the group that this object is contained in.\n"
  2440. "@note If not assigned to particular SimGroup, an object belongs to RootGroup.\n"
  2441. "@return The SimGroup object to which the object belongs." )
  2442. {
  2443. return object->getGroup();
  2444. }
  2445. //-----------------------------------------------------------------------------
  2446. DefineEngineMethod( SimObject, delete, void, (),,
  2447. "Delete and remove the object." )
  2448. {
  2449. object->deleteObject();
  2450. }
  2451. //-----------------------------------------------------------------------------
  2452. DefineEngineStringlyVariadicMethod( SimObject,schedule, S32, 4, 0, "( float time, string method, string args... ) Delay an invocation of a method.\n"
  2453. "@param time The number of milliseconds after which to invoke the method. This is a soft limit.\n"
  2454. "@param method The method to call.\n"
  2455. "@param args The arguments with which to call the method.\n"
  2456. "@return The numeric ID of the created schedule. Can be used to cancel the call.\n" )
  2457. {
  2458. U32 timeDelta = U32(argv[2].getFloat());
  2459. argv[2].setString(argv[3].getString());
  2460. argv[3].setString(argv[1].getString());
  2461. SimConsoleEvent *evt = new SimConsoleEvent(argc - 2, argv + 2, true);
  2462. S32 ret = Sim::postEvent(object, evt, Sim::getCurrentTime() + timeDelta);
  2463. // #ifdef DEBUG
  2464. // Con::printf("obj %s schedule(%s) = %d", argv[3], argv[2], ret);
  2465. // Con::executef( "backtrace");
  2466. // #endif
  2467. return ret;
  2468. }
  2469. //-----------------------------------------------------------------------------
  2470. DefineEngineMethod( SimObject, getDynamicFieldCount, S32, (),,
  2471. "Get the number of dynamic fields defined on the object.\n"
  2472. "@return The number of dynamic fields defined on the object." )
  2473. {
  2474. S32 count = 0;
  2475. SimFieldDictionary* fieldDictionary = object->getFieldDictionary();
  2476. for (SimFieldDictionaryIterator itr(fieldDictionary); *itr; ++itr)
  2477. count++;
  2478. return count;
  2479. }
  2480. //-----------------------------------------------------------------------------
  2481. DefineEngineMethod( SimObject, getDynamicField, const char*, ( S32 index ),,
  2482. "Get a value of a dynamic field by index.\n"
  2483. "@param index The index of the dynamic field.\n"
  2484. "@return The value of the dynamic field at the given index or \"\"." )
  2485. {
  2486. SimFieldDictionary* fieldDictionary = object->getFieldDictionary();
  2487. SimFieldDictionaryIterator itr(fieldDictionary);
  2488. for (S32 i = 0; i < index; i++)
  2489. {
  2490. if (!(*itr))
  2491. {
  2492. Con::warnf("Invalid dynamic field index passed to SimObject::getDynamicField!");
  2493. return NULL;
  2494. }
  2495. ++itr;
  2496. }
  2497. static const U32 bufSize = 256;
  2498. char* buffer = Con::getReturnBuffer(bufSize);
  2499. if (*itr)
  2500. {
  2501. SimFieldDictionary::Entry* entry = *itr;
  2502. dSprintf(buffer, bufSize, "%s\t%s", entry->slotName, entry->value);
  2503. return buffer;
  2504. }
  2505. Con::warnf("Invalid dynamic field index passed to SimObject::getDynamicField!");
  2506. return NULL;
  2507. }
  2508. //-----------------------------------------------------------------------------
  2509. DefineEngineMethod( SimObject, getFieldCount, S32, (),,
  2510. "Get the number of static fields on the object.\n"
  2511. "@return The number of static fields defined on the object." )
  2512. {
  2513. const AbstractClassRep::FieldList &list = object->getFieldList();
  2514. const AbstractClassRep::Field* f;
  2515. U32 numDummyEntries = 0;
  2516. for(S32 i = 0; i < list.size(); i++)
  2517. {
  2518. f = &list[i];
  2519. // The special field types do not need to be counted.
  2520. if ( f->type >= AbstractClassRep::ARCFirstCustomField )
  2521. numDummyEntries++;
  2522. }
  2523. return list.size() - numDummyEntries;
  2524. }
  2525. //-----------------------------------------------------------------------------
  2526. DefineEngineMethod( SimObject, getField, const char*, ( S32 index ),,
  2527. "Retrieve the value of a static field by index.\n"
  2528. "@param index The index of the static field.\n"
  2529. "@return The value of the static field with the given index or \"\"." )
  2530. {
  2531. const AbstractClassRep::FieldList &list = object->getFieldList();
  2532. if( ( index < 0 ) || ( index >= list.size() ) )
  2533. return "";
  2534. const AbstractClassRep::Field* f;
  2535. S32 currentField = 0;
  2536. for ( U32 i = 0; i < list.size() && currentField <= index; i++ )
  2537. {
  2538. f = &list[i];
  2539. // The special field types can be skipped.
  2540. if ( f->type >= AbstractClassRep::ARCFirstCustomField )
  2541. continue;
  2542. if(currentField == index)
  2543. return f->pFieldname;
  2544. currentField++;
  2545. }
  2546. // if we found nada, return nada.
  2547. return "";
  2548. }
  2549. DefineEngineFunction(getClassHierarchy, const char*, (const char* name), ,
  2550. "Returns the inheritance hierarchy for a given class.")
  2551. {
  2552. AbstractClassRep* pRep = AbstractClassRep::findClassRep(name);
  2553. if (!pRep)
  2554. {
  2555. //Con::errorf("%s does not exist", name);
  2556. return StringTable->EmptyString();
  2557. }
  2558. StringBuilder buffer;
  2559. while (pRep != NULL)
  2560. {
  2561. StringTableEntry className = pRep->getClassName();
  2562. buffer.append(className);
  2563. buffer.append(" ");
  2564. pRep = pRep->getParentClass();
  2565. }
  2566. String result = buffer.end().trim();
  2567. //Con::printf("getClassHierarchy for %s=%s", name, result.c_str());
  2568. return Con::getReturnBuffer(result.c_str());
  2569. }
  2570. //-----------------------------------------------------------------------------
  2571. #ifdef TORQUE_DEBUG
  2572. DefineEngineMethod( SimObject, getDebugInfo, ArrayObject*, (),,
  2573. "Return some behind-the-scenes information on the object.\n"
  2574. "@return An ArrayObject filled with internal information about the object." )
  2575. {
  2576. ArrayObject* array = new ArrayObject();
  2577. array->registerObject();
  2578. array->push_back( "C++|Address", String::ToString( "0x%x", object ) );
  2579. array->push_back( "C++|Size", String::ToString( object->getClassRep()->getSizeof() ) );
  2580. array->push_back( "Object|Description", object->describeSelf() );
  2581. array->push_back( "Object|FileName", object->getFilename() );
  2582. array->push_back( "Object|DeclarationLine", String::ToString( object->getDeclarationLine() ) );
  2583. array->push_back( "Object|CopySource", object->getCopySource() ? String::ToString( "%i:%s (%s)", object->getCopySource()->getId(), object->getCopySource()->getClassName(), object->getCopySource()->getName() ) : String("") );
  2584. array->push_back( "Flag|EditorOnly", object->isEditorOnly() ? "true" : "false" );
  2585. array->push_back( "Flag|NameChangeAllowed", object->isNameChangeAllowed() ? "true" : "false" );
  2586. array->push_back( "Flag|AutoDelete", object->isAutoDeleted() ? "true" : "false" );
  2587. array->push_back( "Flag|Selected", object->isSelected() ? "true" : "false" );
  2588. array->push_back( "Flag|Expanded", object->isExpanded() ? "true" : "false" );
  2589. array->push_back( "Flag|ModStaticFields", object->canModStaticFields() ? "true" : "false" );
  2590. array->push_back( "Flag|ModDynamicFields", object->canModDynamicFields() ? "true" : "false" );
  2591. array->push_back( "Flag|CanSave", object->getCanSave() ? "true" : "false" );
  2592. #ifndef TORQUE_DISABLE_MEMORY_MANAGER
  2593. Memory::Info memInfo;
  2594. Memory::getMemoryInfo( object, memInfo );
  2595. array->push_back( "Memory|AllocNumber", String::ToString( memInfo.mAllocNumber ) );
  2596. array->push_back( "Memory|AllocSize", String::ToString( memInfo.mAllocSize ) );
  2597. array->push_back( "Memory|AllocFile", memInfo.mFileName );
  2598. array->push_back( "Memory|AllocLine", String::ToString( memInfo.mLineNumber ) );
  2599. array->push_back( "Memory|IsGlobal", memInfo.mIsGlobal ? "true" : "false" );
  2600. array->push_back( "Memory|IsStatic", memInfo.mIsStatic ? "true" : "false" );
  2601. #endif
  2602. return array;
  2603. }
  2604. #endif