Subj : Re: API docs
To   : netscape.public.mozilla.jseng
From : Sterling Bates <whoelse@sterlingbates.com>
Date : Fri Apr 16 2004 12:14 pm

This is a multi-part message in MIME format.
--------------080206030908050200000105
Content-Type: text/plain; charset=us-ascii; format=flowed
Content-Transfer-Encoding: 7bit

OK, here's a patch for the first 2,000 lines of the jsref.xml file (or 
up to JS_ValueToObject's entry).  It has a bunch of grammar corrections 
and updated #define's.

I need help in the following locations (for correctness, and initial 
documentation where I'm not qualified):

1. JSPROP_SHARED documentation
2. All of the JSFUN_ definitions
3. The new JSCLASS_ properties (_PRIVATE_IS_NSISUPPORTS, 
_SHARE_ALL_PROPERTIES, _NEW_RESOLVE_GETS_START)
4. I'm not sure if all JSPROP_ flags apply to JSConstDoubleSpec.flags, 
but I put them in
5. Should I remove references to HTML pages in the JSErrorReport spec?
6. Anywhere that I used "XXX" as the description for an item :-)

I have real work to do, so I'll do more over the weekend.

Sterling

--------------080206030908050200000105
Content-Type: text/plain;
 name="diff.txt"
Content-Transfer-Encoding: 7bit
Content-Disposition: inline;
 filename="diff.txt"

Index: jsref.xml
===================================================================
RCS file: /cvsroot/mozilla/js/docs/jsref.xml,v
retrieving revision 1.7
diff -r1.7 jsref.xml
402,403c402
<       <C>JSVAL_LOCK</C> locks a JS value, <C>v</C>, to prevent the value from being garbage collected. <C>v </C>is a JS object, string, or double value.<P/>
<       <C>JSVAL_LOCK</C> determines if <C>v</C> is an object, string, or double value, and if it is, it locks the value. If locking is successful, or <C>v</C> already cannot be garbage collected because it is not an object, string, or double value, <C>JSVAL_LOCK</C> evaluates to <I><C>true</C></I>. Otherwise <C>JSVAL_LOCK</C> evaluates to <I><C>false</C></I>.<P/>
---
>       <C>JSVAL_LOCK</C> locks a JS value, <C>v</C>, to prevent the value from being garbage collected. <C>JSVAL_LOCK</C> determines if <C>v</C> is an object, string, or double value, and if it is, it locks the value. If locking is successful, or <C>v</C> already cannot be garbage collected because it is not an object, string, or double value, <C>JSVAL_LOCK</C> evaluates to <I><C>true</C></I>. Otherwise <C>JSVAL_LOCK</C> evaluates to <I><C>false</C></I>.<P/>
422,423c421
<       <C>JSVAL_UNLOCK</C> unlocks a previously locked JS value, <C>v</C>, so it can be garbage collected. <C>v</C> is a JS object, string, or double value.<P/>
<       <C>JSVAL_UNLOCK</C> determine if <C>v</C> is an object, string, or double value, and if it is, it unlocks the value. If unlocking is successful, or <C>v</C> is not affected by garbage collection because it is not an object, string, or double value, <C>JSVAL_UNLOCK</C> evaluates to <I><C>true</C></I>. Otherwise <C>JSVAL_UNLOCK</C> evaluates to <I><C>false</C></I>.<P/>
---
>       <C>JSVAL_UNLOCK</C> unlocks a previously locked JS value, <C>v</C>, so it can be garbage collected. <C>JSVAL_UNLOCK</C> determines if <C>v</C> is an object, string, or double value, and if it is, it unlocks the value. If unlocking is successful, or <C>v</C> is not affected by garbage collection because it is not an object, string, or double value, <C>JSVAL_UNLOCK</C> evaluates to <I><C>true</C></I>. Otherwise <C>JSVAL_UNLOCK</C> evaluates to <I><C>false</C></I>.<P/>
463c461
<       <C>JSVAL_TO_INT</C> converts a specified JS integer value, <C>v</C>, to a C integer value by performing a bitwise right shift operation. <C>JSVAL_TO_INT</C> assumes that it was passed a JS value of type <C>JSVAL_INT</C>, and returns that JS value's corresponding C integer value. Note that because of the bit-shifting operation, that a C comparison of <C>JSVAL_TO_INT(v)</C> to <C>v</C> always results in nonequality.<P/>
---
>       <C>JSVAL_TO_INT</C> converts a specified JS integer value, <C>v</C>, to a C integer value by performing a bitwise right shift operation. <C>JSVAL_TO_INT</C> assumes that it was passed a JS value of type <C>JSVAL_INT</C>, and returns that JS value's corresponding C integer value. Note that, because of the bit-shifting operation, a C comparison of <C>JSVAL_TO_INT(v)</C> to <C>v</C> always results in nonequality.<P/>
478c476
<       <C>INT_TO_JSVAL</C> converts a C integer, <C>i</C>, to a JS integer value type using a bitwise left shift operation and <C>OR</C>'ing the result with the <C>JSVAL_INT</C> macro.<P/>
---
>       <C>INT_TO_JSVAL</C> converts a C integer, <C>i</C>, to a JS integer value type using a bitwise left shift operation and setting the data type flag to <C>JSVAL_INT</C>.<P/>
523c521
<       <C>JSVAL_TO_PRIVATE</C> casts a JS value, <C>v</C>, to a void pointer to private data. Private data is associated with an JS class on which the <C>JSCLASS_HAS_PRIVATE</C> attribute is set. Private data is user-allocated, defined, and maintained. Private pointers must be word aligned.<P/>
---
>       <C>JSVAL_TO_PRIVATE</C> casts a JS value, <C>v</C>, to a void pointer to private data. Private data is associated with a JS class for which the <C>JSCLASS_HAS_PRIVATE</C> attribute is set. Private data is user-allocated, defined, and maintained. Private pointers must be word aligned.<P/>
538,539c536,537
<       <C>PRIVATE_TO_JSVAL</C> enables you to store a private data pointer, <C>p</C>, as a JS value. The private pointer must be word-aligned. Before passing a pointer to <C>PRIVATE_TO_JSVAL</C>, test it with <C>INT_FITS_IN_JSVAL</C> to be verify that the pointer can be cast to a legal JS integer value.<P/>
<       <C>PRIVATE_TO_JSVAL</C> casts a pointer to a JS integer value and sets the <C>JSVAL_INT</C> type tag on it. <P/>
---
>       <C>PRIVATE_TO_JSVAL</C> enables you to store a private data pointer, <C>p</C>, as a JS value. The private pointer must be word-aligned. Before passing a pointer to <C>PRIVATE_TO_JSVAL</C>, test it with <C>INT_FITS_IN_JSVAL</C> to verify that the pointer can be cast to a legal JS integer value.<P/>
>       <C>PRIVATE_TO_JSVAL</C> casts a pointer to a JS integer value and sets the <C>JSVAL_INT</C> type tag on it.<P/>
547c545
<       Public.Flag that indicates a property is visible to <B>for</B> and <B>in</B> loops.
---
>       Flag that indicates a property is visible to <B>for..in</B> loops.
553c551
<       <C>JSPROP_ENUMERATE</C> is a flag value that indicates a property belonging to a JS object is visible to <B>for</B> and <B>in</B> loops. <C>JSPROP_ENUMERATE</C> is used to set or clear the <C>flags</C> field in a <C>JSPropertySpec</C> structure so that a property can be made visible or invisible to loops.<P/>
---
>       <C>JSPROP_ENUMERATE</C> is a flag value that indicates a property belonging to a JS object is visible to <B>for..in</B> loops. <C>JSPROP_ENUMERATE</C> is an attribute set in the <C>flags</C> field of a <C>JSPropertySpec</C> structure so that a property can be made visible or invisible to loops.<P/>
572a571,573
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
587c588
<       JSPROP_READONLY is a flag value that indicates that the value for a property belonging to a JS object cannot be set at run time. For JavaScript 1.2 and lower, it is an error to attempt to assign a value to a property marked with the <C>JSPROP_READONLY</C> flag. In JavaScript 1.3 and ECMA-Script, attempts to set a value on a read-only property are ignored. You can, however, always check the <C>flags</C> fields to determine if a property is read only.<P/>
---
>       JSPROP_READONLY is a flag value that indicates that the value for a property belonging to a JS object cannot be set at run time. For JavaScript 1.2 and lower, it is an error to attempt to assign a value to a property marked with the <C>JSPROP_READONLY</C> flag. In JavaScript 1.3 and ECMA-Script, attempts to set a value on a read-only property are ignored. You can, however, always check the <C>flags</C> field to determine if a property is read only.<P/>
599a601,603
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
614c618
<       JSPROP_PERMANENT is a flag value that indicates that the property belonging to a JS object is a "permanent" property, one that cannot be deleted from the object at run time. Attempting to delete a permanent property is JavaScript 1.2 or lower results in an error. In JavaScript 1.3 and ECMA-Script, such deletion attempts are ignored. You can, however, always check the <C>flags</C> fields to determine if a property is permanent.<P/>
---
>       JSPROP_PERMANENT is a flag value that indicates that the property belonging to a JS object cannot be deleted from the object at run time. Attempting to delete a permanent property is JavaScript 1.2 or lower results in an error. In JavaScript 1.3 and ECMA-Script, such deletion attempts are ignored. You can, however, always check the <C>flags</C> field to determine if a property is permanent.<P/>
626a631,633
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
653a661,663
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
659c669
<   <ENTRY id='JSPROP_INDEX'>
---
>   <ENTRY id='JSPROP_GETTER'>
662c672
<       Flag that indicates a property's name is actually an index number into an array.
---
>       Flag that indicates the property has a getter function.
665c675
< JSPROP_INDEX
---
> JSPROP_GETTER
668c678
<       JSPROP_INDEX is a flag value that indicates a property's name will automatically be cast to an integer value to use as an index into an array of property values (elements).<P/>
---
>       JSPROP_GETTER is a flag value that indicates the property has a custom getter function. This custom function overrides the default property getter.<P/>
681a692,694
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
>     <SEEALSO value='JSPROP_INDEX'/>
686c699
<   <ENTRY id='JSFUN_BOUND_METHOD'>
---
>   <ENTRY id='JSPROP_SETTER'>
689c702
<       Flag that indicates a function nominally associated with an object is bound, instead, to that object's parent.
---
>       Flag that indicates the property has a setter function.
692c705
< JSFUN_BOUND_METHOD
---
> JSPROP_SETTER
695c708
<       This macro is deprecated. <C>JSFUN_BOUND_METHOD</C> is a flag that indicates a method associated with an object is bound to the method's parent, the object on which the method is called.<P/>
---
>       JSPROP_SETTER is a flag value that indicates the property has a custom setter function. This custom function overrides the default property setter.<P/>
698,700c711,715
<       This macro exists only for backward compatibility with existing applications. Its 
<       use is deprecated. Future versions of the JavaScript engine may not support or 
<       recognize this macro. 
---
>       Property flags cannot be changed at run time. Instead, you either pass a set of 
>       flags as an argument to <C>JS_DefineProperty</C> to create a single property with 
>       fixed flag values, or you set property flags in a <C>JSPropertySpec</C> struct which is 
>       then passed to the <C>JS_DefineProperties</C> function to create multiple 
>       properties on a single object.
703,704c718,727
<     <SEEALSO value='JSFUN_GLOBAL_PARENT'/>
<     <DEPRECATED/>
---
>     <SEEALSO value='JSPROP_ENUMERATE'/>
>     <SEEALSO value='JSPROP_READONLY'/>
>     <SEEALSO value='JSPROP_PERMANENT'/>
>     <SEEALSO value='JSPROP_EXPORTED'/>
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
>     <SEEALSO value='JSPROP_INDEX'/>
>     <SEEALSO value='JSPropertySpec'/>
>     <SEEALSO value='JS_DefineProperty'/>
>     <SEEALSO value='JS_DefineProperties'/>
706c729
<   <ENTRY id='JSFUN_GLOBAL_PARENT'>
---
>   <ENTRY id='JSPROP_SHARED'>
709c732
<       Flag that indicates a call to a function nominally associated with an object is called with the global object as its scope chain, rather than with the parent of the function.
---
>       XXX
712c735
< JSFUN_GLOBAL_PARENT
---
> JSPROP_SHARED
715c738,798
<       This macro is deprecated. Instead of using it, use <C>JS_CloneFunctionObject</C>. <C>JSFUN_GLOBAL_PARENT</C> is a flag that indicates a call to a function nominally associated with an object is called with the global object as its scope chain, rather than with the parent of the function. This permits the function to operate on free variables in the larger scope when they are found through prototype lookups.<P/>
---
>       <P/>
>     </DESCRIPTION>
>     <NOTE>
>       Property flags cannot be changed at run time. Instead, you either pass a set of 
>       flags as an argument to <C>JS_DefineProperty</C> to create a single property with 
>       fixed flag values, or you set property flags in a <C>JSPropertySpec</C> struct which is 
>       then passed to the <C>JS_DefineProperties</C> function to create multiple 
>       properties on a single object.
>       <P/>
>     </NOTE>
>     <SEEALSO value='JSPROP_ENUMERATE'/>
>     <SEEALSO value='JSPROP_READONLY'/>
>     <SEEALSO value='JSPROP_PERMANENT'/>
>     <SEEALSO value='JSPROP_EXPORTED'/>
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_INDEX'/>
>     <SEEALSO value='JSPropertySpec'/>
>     <SEEALSO value='JS_DefineProperty'/>
>     <SEEALSO value='JS_DefineProperties'/>
>   </ENTRY>
>   <ENTRY id='JSPROP_INDEX'>
>     <TYPE value='Macro'/>
>     <SUMMARY>
>       Flag that indicates a property's name is actually an index number into an array.
>     </SUMMARY>
>     <SYNTAX>
> JSPROP_INDEX
>     </SYNTAX>
>     <DESCRIPTION>
>       JSPROP_INDEX is a flag value that indicates a property's name will automatically be cast to an integer value to use as an index into an array of property values (elements).<P/>
>     </DESCRIPTION>
>     <NOTE>
>       Property flags cannot be changed at run time. Instead, you either pass a set of 
>       flags as an argument to <C>JS_DefineProperty</C> to create a single property with 
>       fixed flag values, or you set property flags in a <C>JSPropertySpec</C> struct which is 
>       then passed to the <C>JS_DefineProperties</C> function to create multiple 
>       properties on a single object.
>       <P/>
>     </NOTE>
>     <SEEALSO value='JSPROP_ENUMERATE'/>
>     <SEEALSO value='JSPROP_READONLY'/>
>     <SEEALSO value='JSPROP_PERMANENT'/>
>     <SEEALSO value='JSPROP_EXPORTED'/>
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
>     <SEEALSO value='JSPropertySpec'/>
>     <SEEALSO value='JS_DefineProperty'/>
>     <SEEALSO value='JS_DefineProperties'/>
>   </ENTRY>
>   <ENTRY id='JSFUN_BOUND_METHOD'>
>     <TYPE value='Macro'/>
>     <SUMMARY>
>       Flag that indicates a function nominally associated with an object is bound, instead, to that object's parent.
>     </SUMMARY>
>     <SYNTAX>
> JSFUN_BOUND_METHOD
>     </SYNTAX>
>     <DESCRIPTION>
>       This macro is deprecated. <C>JSFUN_BOUND_METHOD</C> is a flag that indicates a method associated with an object is bound to the method's parent, the object on which the method is called.<P/>
723c806,810
<     <SEEALSO value='JSFUN_BOUND_METHOD'/>
---
>     <SEEALSO value='JSFUN_LAMBDA'/>
>     <SEEALSO value='JSFUN_GETTER'/>
>     <SEEALSO value='JSFUN_SETTER'/>
>     <SEEALSO value='JSFUN_HEAVYWEIGHT'/>
>     <SEEALSO value='JSFUN_FLAGS_MASK'/>
791c878
<       <C>JSVAL_ZERO</C> defines a JS value of 1. Currently this value is defined as <C>INT_TO_JSVAL(1)</C>. <P/>
---
>       <C>JSVAL_ONE</C> defines a JS value of 1. Currently this value is defined as <C>INT_TO_JSVAL(1)</C>. <P/>
804c891
<       Defines a false JS Boolean value.
---
>       Defines a false JS boolean value.
810c897
<       <C>JSVAL_FALSE</C> defines a false JS Boolean value. Currently this value is defined as <C>BOOLEAN_TO_JSVAL(JS_FALSE)</C>. <P/>
---
>       <C>JSVAL_FALSE</C> defines a false JS boolean value. Currently this value is defined as <C>BOOLEAN_TO_JSVAL(JS_FALSE)</C>. <P/>
828c915
<       Defines a true JS Boolean value.
---
>       Defines a true JS boolean value.
834c921
<       <C>JSVAL_TRUE</C> defines a true JS Boolean value. Currently this value is defined as <C>BOOLEAN_TO_JSVAL(JS_TRUE)</C>. <P/>
---
>       <C>JSVAL_TRUE</C> defines a true JS boolean value. Currently this value is defined as <C>BOOLEAN_TO_JSVAL(JS_TRUE)</C>. <P/>
859a947,951
> 	<SEEALSO value='JSCLASS_NEW_ENUMERATE'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE'/>
> 	<SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
> 	<SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
874c966,969
<     <SEEALSO value='JSCLASS_NEW_RESOLVE'/>
---
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE'/>
> 	<SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
> 	<SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
890a986,1045
> 	<SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
> 	<SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
>     <SEEALSO value='JSClass'/>
>     <SEEALSO value='JSObjectOps'/>
>   </ENTRY>
>   <ENTRY id='JSCLASS_PRIVATE_IS_NSISUPPORTS'>
>     <TYPE value='Macro'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> JSCLASS_PRIVATE_IS_NSISUPPORTS
>     </SYNTAX>
>     <DESCRIPTION>
>       <P/>
>     </DESCRIPTION>
>     <SEEALSO value='JSCLASS_HAS_PRIVATE'/>
>     <SEEALSO value='JSCLASS_NEW_ENUMERATE'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE'/>
> 	<SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
>     <SEEALSO value='JSClass'/>
>     <SEEALSO value='JSObjectOps'/>
>   </ENTRY>
>   <ENTRY id='JSCLASS_SHARE_ALL_PROPERTIES'>
>     <TYPE value='Macro'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> JSCLASS_SHARE_ALL_PROPERTIES
>     </SYNTAX>
>     <DESCRIPTION>
>       <P/>
>     </DESCRIPTION>
>     <SEEALSO value='JSCLASS_HAS_PRIVATE'/>
>     <SEEALSO value='JSCLASS_NEW_ENUMERATE'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE'/>
> 	<SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
>     <SEEALSO value='JSClass'/>
>     <SEEALSO value='JSObjectOps'/>
>   </ENTRY>
>   <ENTRY id='JSCLASS_NEW_RESOLVE_GETS_START'>
>     <TYPE value='Macro'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> JSCLASS_NEW_RESOLVE_GETS_START
>     </SYNTAX>
>     <DESCRIPTION>
>       <P/>
>     </DESCRIPTION>
>     <SEEALSO value='JSCLASS_HAS_PRIVATE'/>
>     <SEEALSO value='JSCLASS_NEW_ENUMERATE'/>
> 	<SEEALSO value='JSCLASS_NEW_RESOLVE'/>
> 	<SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
> 	<SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
964c1119
< JS_NewRuntime(maxbytes);
---
> JS_NewRuntime(uint32 maxbytes);
979c1134
< JS_DestroyRuntime(rt);
---
> JS_DestroyRuntime(JSRuntime *rt);
989c1144
<       Flag that specifies that a function's identify can be uniquely resolved without examining the function prototype chain.
---
>       Flag that specifies that a function's identity can be uniquely resolved without examining the function prototype chain.
995c1150
<       <C>JSRESOLVE_QUALIFIED</C> is flag that, if included in a function's <C>flags</C> field, indicates that its identify can be uniquely resolved without reference to its full prototype chain.<P/>
---
>       <C>JSRESOLVE_QUALIFIED</C> is flag that, if included in a function's <C>flags</C> field, indicates that its identity can be uniquely resolved without reference to its full prototype chain.<P/>
998d1152
<     <SEEALSO value='JSFUN_GLOBAL_PARENT'/>
1004c1158
<       Flag that specifies that a function's identify can be uniquely resolved by examining the left side of an assignment statement.
---
>       Flag that specifies that a function's identity can be uniquely resolved by examining the left side of an assignment statement.
1010c1164
<       <C>JSRESOLVE_ASSIGNING</C> is a flag that, if included in a function's flags field, indicates that its identity can be uniquely resolved simply by examing the left side of an assignment statement.<P/>
---
>       <C>JSRESOLVE_ASSIGNING</C> is a flag that, if included in a function's flags field, indicates that its identity can be uniquely resolved simply by examining the left side of an assignment statement.<P/>
1013d1166
<     <SEEALSO value='JSFUN_GLOBAL_PARENT'/>
1023c1176
<    char *name;
---
>    const char *name;
1041c1194,1195
<    prword spare[2];
---
>    JSMarkOp mark;
>    JSReserveSlotsOp reserveSlots;
1050a1205,1207
> <C>JSCLASS_PRIVATE_IS_NSISUPPORTS</C>: class private is (nsISupports *).<BR/>
> <C>JSCLASS_SHARE_ALL_PROPERTIES</C>: class shares all properties.<BR/>
> <C>JSCLASS_NEW_RESOLVE_GETS_START</C>: JSNewResolveOp gets the starting object in the prototype chain passed in via the *objp in/out parameter.<BR/>
1086c1243
<         Pointer to the constructor for the object that represents this <C>class</C><BR/>
---
>         Pointer to the constructor for the object that represents this <C>class</C>.<BR/>
1094,1095c1251,1255
<       <PARAM name='spare' type='prword'>
<         Reserved for future use.<BR/>
---
>       <PARAM name='mark' type='JSMarkOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSMarkOp">http://lxr.mozilla.org/mozilla/search?string=JSMarkOp</a><BR/>
>       </PARAM>
>       <PARAM name='reserveSlots' type='JSReserveSlotsOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSReserveSlotsOp">http://lxr.mozilla.org/mozilla/search?string=JSReserveSlotsOp</a><BR/>
1103a1264,1268
>     <SEEALSO value='JSCLASS_NEW_ENUMERATE'/>
>     <SEEALSO value='JSCLASS_NEW_RESOLVE'/>
>     <SEEALSO value='JSCLASS_PRIVATE_IS_NSISUPPORTS'/>
>     <SEEALSO value='JSCLASS_SHARE_ALL_PROPERTIES'/>
>     <SEEALSO value='JSCLASS_NEW_RESOLVE_GETS_START'/>
1141c1306,1311
<    prword spare[2];
---
>    JSSetObjectSlotOp setProto;
>    JSSetObjectSlotOp setParent;
>    JSMarkOp mark;
>    JSFinalizeOp clear;
>    JSGetRequiredSlotOp getRequiredSlot;
>    JSSetRequiredSlotOp setRequiredSlot;
1197,1198c1367,1383
<       <PARAM name='spare' type='prword'>
<         Reserved for future use.<BR/>
---
>       <PARAM name='setProto' type='JSSetObjectSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSSetObjectSlotOp">http://lxr.mozilla.org/mozilla/search?string=JSSetObjectSlotOp</a><BR/>
>       </PARAM>
>       <PARAM name='setParent' type='JSSetObjectSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSSetObjectSlotOp">http://lxr.mozilla.org/mozilla/search?string=JSSetObjectSlotOp</a><BR/>
>       </PARAM>
>       <PARAM name='mark' type='JSMarkOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSMarkOp">http://lxr.mozilla.org/mozilla/search?string=JSMarkOp</a><BR/>
>       </PARAM>
>       <PARAM name='clear' type='JSFinalizeOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSFinalizeOp">http://lxr.mozilla.org/mozilla/search?string=JSFinalizeOp</a><BR/>
>       </PARAM>
>       <PARAM name='getRequiredSlot' type='JSGetRequiredSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSGetRequiredSlotOp">http://lxr.mozilla.org/mozilla/search?string=JSGetRequiredSlotOp</a><BR/>
>       </PARAM>
>       <PARAM name='setRequiredSlot' type='JSSetRequiredSlotOp'>
>         See <a href="http://lxr.mozilla.org/mozilla/search?string=JSSetRequiredSlotOp">http://lxr.mozilla.org/mozilla/search?string=JSSetRequiredSlotOp</a><BR/>
1231a1417,1419
> <C>JSPROP_GETTER</C>: property has a defined getter function.<BR/>
> <C>JSPROP_SETTER</C>: property has a defined setter function.<BR/>
> <C>JSPROP_SHARED</C>: property is shared.<BR/>
1247a1436,1438
>     <SEEALSO value='JSPROP_GETTER'/>
>     <SEEALSO value='JSPROP_SETTER'/>
>     <SEEALSO value='JSPROP_SHARED'/>
1284,1287c1475,1481
<         Function attributes. If set to <C>0</C> the function has no attributes. Otherwise, existing applications can set <C>flags</C> to either or both of the following attributes <C>OR</C>'d:<BR/>
< <C>JSFUN_BOUND_METHOD</C><BR/>
< <C>JSFUN_GLOBAL_PARENT</C><BR/>
< Note that these attributes are deprecated, and continue to be supported only for backward compatibility with existing applications. New applications should not use these attributes.<BR/>
---
>         Function attributes. If set to <C>0</C> the function has no attributes. Otherwise, existing applications can set <C>flags</C> to any of the following attributes <C>OR</C>'d:<BR/>
> <C>JSFUN_LAMBDA</C>: the function is expressed but not declared.<BR/>
> <C>JSFUN_GETTER</C>: function holds a getter function.<BR/>
> <C>JSFUN_SETTER</C>: function holds a setter function.<BR/>
> <C>JSFUN_BOUND_METHOD</C>: function is bound to the function object's parent.<BR/>
> <C>JSFUN_HEAVYWEIGHT</C>: a Call object is required to activate this function.<BR/>
> <C>JSFUN_FLAGS_MASK</C>: equivalent of all JSFUN_* attributes<BR/>
1294c1488
<       <C>JSFuctionSpec</C> defines the attributes for a single JS function to associate with an object. Generally, you populate an array of <C>JSFunctionSpec</C> to define all the functions for an object, and then call <C>JS_DefineFunctions</C> to create the functions and assign them to an object.<P/>
---
>       <C>JSFuctionSpec</C> defines the attributes for a single JS function to associate with an object. Generally, you populate an array of <C>JSFunctionSpec</C> elements to define all the functions for an object, and then call <C>JS_DefineFunctions</C> to create the functions and assign them to an object.<P/>
1296a1491,1493
>     <SEEALSO value='JSFUN_LAMBDA'/>
>     <SEEALSO value='JSFUN_GETTER'/>
>     <SEEALSO value='JSFUN_SETTER'/>
1298c1495,1496
<     <SEEALSO value='JSFUN_GLOBAL_PARENT'/>
---
>     <SEEALSO value='JSFUN_HEAVYWEIGHT'/>
>     <SEEALSO value='JSFUN_FLAGS_MASK'/>
1327c1525
<       <PARAM name='name' type='const char *'>
---
>       <PARAM name='*name' type='const char'>
1331c1529
<         Attributes for the double. Currently these can be 0 or more of the following values <C>OR</C>'d:<BR/>
---
>         Attributes for the double. This can be 0 or any of the following values <C>OR</C>'d:<BR/>
1336c1534,1537
< <C>JSPROP_INDEX</C>: property is actually an array element.<BR/>
---
> <C>JSPROP_GETTER</C>: property has a defined getter function.<BR/>
> <C>JSPROP_SETTER</C>: property has a defined setter function.<BR/>
> <C>JSPROP_SHARED</C>: property is shared.<BR/>
> <C>JSPROP_INDEX</C>: property is actual an array element.<BR/>
1338c1539
<       <PARAM name='spare' type='uint8'>
---
>       <PARAM name='spare[3]' type='uint8'>
1343,1344c1544,1545
<       <C>JSConstDoubleSpecs</C> is typically used to define a set of double values that are assigned as properties to an object using <C>JS_DefineConstDoubles</C>. <C>JS_DefineConstDoubles</C> creates one or more double properties for a specified object.<P/>
<       <C>JS_DefineConstDoubles</C> takes an argument that is a pointer to an array of <C>JSConstDoubleSpecs</C>. Each array element defines a single property name and property value to create. The last element of the array must contain zero-valued values. <C>JS_DefineConstDoubles</C> creates one property for each non-zero element in the array.<P/>
---
>       <C>JSConstDoubleSpec</C> is typically used to define a set of double values that are assigned as properties to an object using <C>JS_DefineConstDoubles</C>. <C>JS_DefineConstDoubles</C> creates one or more double properties for a specified object.<P/>
>       <C>JS_DefineConstDoubles</C> takes an argument that is a pointer to an array of <C>JSConstDoubleSpec</C>s. Each array element defines a single property name and property value to create. The last element of the array must contain zero-valued values. <C>JS_DefineConstDoubles</C> creates one property for each non-zero element in the array.<P/>
1360c1561
< typedef struct JSPrincipals {
---
> struct JSPrincipals {
1362,1368c1563,1567
<    void *(*getPrincipalArray)(JSContext *cx,
<       struct JSPrincipals *);
<    JSBool (*globalPrivilegesEnabled)(JSContext *cx,
<       struct JSPrincipals *);
<    uintN refcount;
<    void (*destroy)(JSContext *cx, struct JSPrincipals *);
< } JSPrincipals;
---
>    void *(* JS_DLL_CALLBACK getPrincipalArray)(JSContext *cx, JSPrincipals *);
>    JSBool (* JS_DLL_CALLBACK globalPrivilegesEnabled)(JSContext *cx, JSPrincipals *);
>    jsrefcount refcount;
>    void (* JS_DLL_CALLBACK destroy)(JSContext *cx, struct JSPrincipals *);
> };
1378,1379c1577,1578
<       <PARAM name='refcount' type='uintN'>
<         Reference count for the principals. Each reference to a principal increments refcount by one. As principals references are dropped, call the <C>destroy</C> method to decrement the reference count and free the principals if they are no longer needed.<BR/>
---
>       <PARAM name='refcount' type='jsrefcount'>
>         Reference count for the principals. Each reference to a principal increments refcount by one. As principal references are dropped, call the <C>destroy</C> method to decrement the reference count and free the principals if they are no longer needed.<BR/>
1412a1612,1615
>    uintN flags;
>    uintN errorNumber;
>    const jschar *ucmessage;
>    const jschar **messageArgs;
1431a1635,1650
>       <PARAM name='flags' type='uintN'>
>         Error description attributes. The default is <C>0</C>. This property may be any of the following attributes <C>OR</C>'d:<BR/>
> <C>JSREPORT_ERROR</C> (default)<BR/>
> <C>JSREPORT_WARNING</C><BR/>
> <C>JSREPORT_EXCEPTION</C><BR/>
> <C>JSREPORT_STRICT</C><BR/>
>       </PARAM>
>       <PARAM name='errorNumber' type='uintN'>
>         The error number. See js.msg for predefined errors.<BR/>
>       </PARAM>
>       <PARAM name='*ucmessage' type='const jschar'>
>         Unicode error message.<BR/>
>       </PARAM>
>       <PARAM name='**messageArgs' type='const jschar'>
>         Pointer to the arguments for the error message <C>*ucmessage</C>.<BR/>
>       </PARAM>
1440,1441c1659,1660
<       <C>uctokenptr</C> is a pointer into <C>uclinebuf</C> that identifies the precise location line of the problem within the offending Unicode (original) version of the offending line.<P/>
<       To use <C>JSErrorReport</C>, your application must define a variable of type <C>JSErrorReport</C> and allocate a buffer to hold the text that generated the error condition. Set <C>linebuf</C> to point at the buffer before your application executes a script. For Unicode scripts, define a second buffer that holds the Unicode version of the text the generated the error. For application that do not use Unicode, set <C>uclinebuf</C> and <C>uctokenptr</C> to <C>NULL</C>.<P/>
---
>       <C>uctokenptr</C> is a pointer into <C>uclinebuf</C> that identifies the precise location line of the problem within the Unicode (original) version of the offending line.<P/>
>       To use <C>JSErrorReport</C>, your application must define a variable of type <C>JSErrorReport</C> and allocate a buffer to hold the text that generated the error condition. Set <C>linebuf</C> to point at the buffer before your application executes a script. For Unicode scripts, define a second buffer that holds the Unicode version of the text the generated the error. For applications that do not use Unicode, set <C>uclinebuf</C> and <C>uctokenptr</C> to <C>NULL</C>.<P/>
1450c1669
<       Internal use only. Describes an array of property IDs to associated with an object.
---
>       Internal use only. Describes an array of property IDs associated with an object.
1523c1742
<       As a value in mathematical calculations infinite values behaves like infinity. For example, anything multiplied by infinity is infinity, and anything divided by infinity is zero.<P/>
---
>       As a value in mathematical calculations infinite values behave like infinity. For example, anything multiplied by infinity is infinity, and anything divided by infinity is zero.<P/>
1550,1552c1769,1770
< JSBool JS_ConvertArguments(JSContext *cx, uintN argc,
<    jsval *argv, const char *format, ...);
<       <PARAM name='cx' type='JSContext *'>
---
> JSBool JS_ConvertArguments(JSContext *cx, uintN argc, jsval *argv, const char *format, ...);
>       <PARAM name='*cx' type='JSContext'>
1558c1776
<       <PARAM name='argv' type='jsval *'>
---
>       <PARAM name='*argv' type='jsval'>
1561c1779
<       <PARAM name='format' type='char *'>
---
>       <PARAM name='*format' type='const char'>
1564c1782
<       <PARAM name='...' type='void *'>
---
>       <PARAM name='* ...' type='void'>
1590c1808
<       <CODE>uint32 (32-bit, ECMA-compliant, unsigned integer)</CODE></P>
---
>       <CODE>uint32 (32-bit, ECMA-compliant unsigned integer)</CODE></P>
1623c1841
<       <C>JS_ConvertArguments</C> expects to be passed an argument vector that belongs to a native JS function, such that every argument passed is already a JS value. By default, when you first call <C>JS_ConvertArguments</C>, it automatically provides built-in error checking to guarantee that the proper number of arguments has been passed. If an improper number of arguments is passed in, <C>JS_ConvertArguments</C> reports an error and terminates. You can turn off this error-checking at any time by passing
 a slash (/) as a character any place in format where you no longer desire the argument number check to be made.<P/>
---
>       <C>JS_ConvertArguments</C> expects to be passed an argument vector that belongs to a native JS function, such that every argument passed is already a JS value. By default, when you first call <C>JS_ConvertArguments</C>, it automatically provides built-in error checking to guarantee that the proper number of arguments has been passed. If an improper number of arguments is passed in, <C>JS_ConvertArguments</C> reports an error and terminates. You can turn off this error-checking at any time by passing
 a slash (/) as a character any place in <C>format</C> where you no longer desire the argument number check to be made.<P/>
1627a1846
> 	<SEEALSO value='JS_PushArguments'/>
1638a1858,1967
>   <ENTRY id='JS_PushArguments'>
>     <TYPE value='Function'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> jsval * JS_PushArguments(JSContext *cx, void **markp, const char *format, ...);
>       <PARAM name='*cx' type='JSContext'>
>         Pointer to a JS context from which to derive runtime information.<BR/>
>       </PARAM>
>       <PARAM name='**markp' type='void'>
>         <BR/>
>       </PARAM>
>       <PARAM name='*format' type='const char'>
>         <BR/>
>       </PARAM>
>       <PARAM name='* ...' type='void'>
>         <BR/>
>       </PARAM>
>     </SYNTAX>
>     <DESCRIPTION>
> 		<P/>
>     </DESCRIPTION>
>     <SEEALSO value='JS_ConvertArguments'/>
>     <SEEALSO value='JS_ConvertValue'/>
> 	<SEEALSO value='JS_PopArguments'/>
>     <SEEALSO value='JS_ValueToObject'/>
>     <SEEALSO value='JS_ValueToFunction'/>
>     <SEEALSO value='JS_ValueToString'/>
>     <SEEALSO value='JS_ValueToNumber'/>
>     <SEEALSO value='JS_ValueToInt32'/>
>     <SEEALSO value='JS_ValueToECMAInt32'/>
>     <SEEALSO value='JS_ValueToECMAUint32'/>
>     <SEEALSO value='JS_ValueToUint16'/>
>     <SEEALSO value='JS_ValueToBoolean'/>
>     <SEEALSO value='JS_ValueToId'/>
>   </ENTRY>
>   <ENTRY id='JS_PopArguments'>
>     <TYPE value='Function'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> void JS_PopArguments(JSContext *cx, void *mark);
>       <PARAM name='*cx' type='JSContext'>
>         Pointer to a JS context from which to derive runtime information.<BR/>
>       </PARAM>
>       <PARAM name='*mark' type='void'>
>         <BR/>
>       </PARAM>
>     </SYNTAX>
>     <DESCRIPTION>
> 		<P/>
>     </DESCRIPTION>
>     <SEEALSO value='JS_PushArguments'/>
>     <SEEALSO value='JS_ConvertArguments'/>
>     <SEEALSO value='JS_ConvertValue'/>
> 	<SEEALSO value='JS_PopArguments'/>
>     <SEEALSO value='JS_ValueToObject'/>
>     <SEEALSO value='JS_ValueToFunction'/>
>     <SEEALSO value='JS_ValueToString'/>
>     <SEEALSO value='JS_ValueToNumber'/>
>     <SEEALSO value='JS_ValueToInt32'/>
>     <SEEALSO value='JS_ValueToECMAInt32'/>
>     <SEEALSO value='JS_ValueToECMAUint32'/>
>     <SEEALSO value='JS_ValueToUint16'/>
>     <SEEALSO value='JS_ValueToBoolean'/>
>     <SEEALSO value='JS_ValueToId'/>
>   </ENTRY>
>   <ENTRY id='JS_AddArgumentFormatter'>
>     <TYPE value='Function'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> JSBool JS_AddArgumentFormatter(JSContext *cx, const char *format, JSArgumentFormatter formatter);
>       <PARAM name='*cx' type='JSContext'>
>         Pointer to a JS context from which to derive runtime information.<BR/>
>       </PARAM>
>       <PARAM name='*format' type='const char'>
>         <BR/>
>       </PARAM>
>       <PARAM name='formatter' type='JSArgumentFormatter'>
>         <BR/>
>       </PARAM>
>     </SYNTAX>
>     <DESCRIPTION>
> 		<P/>
>     </DESCRIPTION>
>     <SEEALSO value='JS_RemoveArgumentFormatter'/>
>   </ENTRY>
>   <ENTRY id='JS_RemoveArgumentFormatter'>
>     <TYPE value='Function'/>
>     <SUMMARY>
>       XXX
>     </SUMMARY>
>     <SYNTAX>
> void JS_AddArgumentFormatter(JSContext *cx, const char *format);
>       <PARAM name='*cx' type='JSContext'>
>         Pointer to a JS context from which to derive runtime information.<BR/>
>       </PARAM>
>       <PARAM name='*format' type='const char'>
>         <BR/>
>       </PARAM>
>     </SYNTAX>
>     <DESCRIPTION>
> 		<P/>
>     </DESCRIPTION>
>     <SEEALSO value='JS_AddArgumentFormatter'/>
>   </ENTRY>
1642c1971
<       Converts a JS value to a value of a specific JS type.
---
>       Converts a JS value to a specific JS type.
1645,1647c1974,1975
< JSBool JS_ConvertValue(JSContext *cx, jsval v, JSType type,
<    jsval *vp);
<       <PARAM name='cx' type='JSContext *'>
---
> JSBool JS_ConvertValue(JSContext *cx, jsval v, JSType type, jsval *vp);
>       <PARAM name='*cx' type='JSContext'>
1654c1982
<         The type to which to convert the value. type must be one of <C>JSTYPE_VOID</C>, <C>JSTYPE_OBJECT</C>, <C>JSTYPE_FUNCTION</C>, <C>JSTYPE_STRING</C>, <C>JSTYPE_NUMBER</C>, or <C>JSTYPE_BOOLEAN</C>. Otherwise <C>JS_ConvertValue</C> reports an error.<BR/>
---
>         The type to which to convert the value. <C>type</C> must be one of <C>JSTYPE_VOID</C>, <C>JSTYPE_OBJECT</C>, <C>JSTYPE_FUNCTION</C>, <C>JSTYPE_STRING</C>, <C>JSTYPE_NUMBER</C>, or <C>JSTYPE_BOOLEAN</C>. Otherwise <C>JS_ConvertValue</C> reports an error.<BR/>
1656c1984
<       <PARAM name='vp' type='jsval *'>
---
>       <PARAM name='*vp' type='jsval'>
4647c4975
<    jsint *lengthp);
---
>    jsuint *lengthp);

--------------080206030908050200000105--

.