Mercurial > pymonkey

changeset 58:7a3461ccaf1d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added documentation for Context methods get_runtime(), new_object(), and init_standard_classes().
author Atul Varma <varmaa@toolness.com>
date Sun, 19 Jul 2009 19:58:15 -0700
parents a2b617731398
children fb97bed55789
files docs/rendered/_sources/pymonkey.txt docs/rendered/genindex.html docs/rendered/pymonkey.html docs/rendered/searchindex.js docs/src/pymonkey.txt
diffstat 5 files changed, 72 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/docs/rendered/_sources/pymonkey.txt	Fri Jul 10 18:41:14 2009 -0700
+++ b/docs/rendered/_sources/pymonkey.txt	Sun Jul 19 19:58:15 2009 -0700
@@ -56,6 +56,23 @@
      >>> isinstance(cx, pymonkey.Context)
      True
 
+   .. method:: get_runtime()
+
+      Returns the :class:`Runtime` that the context belongs to.
+
+   .. method:: new_object()
+
+      Creates a new :class:`Object` instance and returns it.
+
+   .. method:: init_standard_classes(object)
+
+      Defines the standard JavaScript classes on the given
+      :class:`Object`, such as ``Array``, ``eval``, ``undefined``, and
+      so forth. For more information, see the documentation to
+      `JS_InitStandardClasses()
+      <https://developer.mozilla.org/en/SpiderMonkey/JSAPI_Reference/JS_InitStandardClasses>`_,
+      which this method wraps.
+
 .. class:: Runtime()
 
    Creates a new JavaScript runtime. JS objects created by the runtime
--- a/docs/rendered/genindex.html	Fri Jul 10 18:41:14 2009 -0700
+++ b/docs/rendered/genindex.html	Sun Jul 19 19:58:15 2009 -0700
@@ -43,7 +43,7 @@
 
    <h1 id="index">Index</h1>
 
-   <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#U"><strong>U</strong></a> 
+   <a href="#C"><strong>C</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#O"><strong>O</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#U"><strong>U</strong></a> 
 
    <hr />
 
@@ -62,11 +62,26 @@
 <dt><a href="pymonkey.html#pymonkey.error">error</a></dt></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
+<h2 id="G">G</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="pymonkey.html#pymonkey.Context.get_runtime">get_runtime() (pymonkey.Context method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
+<h2 id="I">I</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="pymonkey.html#pymonkey.Context.init_standard_classes">init_standard_classes() (pymonkey.Context method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
 <h2 id="N">N</h2>
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
 
-<dt><a href="pymonkey.html#pymonkey.Runtime.new_context">new_context() (pymonkey.Runtime method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="pymonkey.html#pymonkey.Runtime.new_context">new_context() (pymonkey.Runtime method)</a></dt>
+<dt><a href="pymonkey.html#pymonkey.Context.new_object">new_object() (pymonkey.Context method)</a></dt></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
 <h2 id="O">O</h2>
--- a/docs/rendered/pymonkey.html	Fri Jul 10 18:41:14 2009 -0700
+++ b/docs/rendered/pymonkey.html	Sun Jul 19 19:58:15 2009 -0700
@@ -79,7 +79,7 @@
 <em class="property">
 class </em><tt class="descclassname">pymonkey.</tt><tt class="descname">Object</tt><a class="headerlink" href="#pymonkey.Object" title="Permalink to this definition">¶</a></dt>
 <dd><p>This is the type of JavaScript objects. Such objects can only be
-created via Pymonkey calls like <tt class="xref docutils literal"><span class="pre">Context.new_object()</span></tt> or
+created via Pymonkey calls like <a title="pymonkey.Context.new_object" class="reference" href="#pymonkey.Context.new_object"><tt class="xref docutils literal"><span class="pre">Context.new_object()</span></tt></a> or
 through the execution of JS code, but this type object can be used
 with Python&#8217;s built-in <tt class="xref docutils literal"><span class="pre">isinstance()</span></tt> to verify that an
 object is a JS object, like so:</p>
@@ -103,6 +103,25 @@
 <span class="go">True</span>
 </pre></div>
 </div>
+<dl class="method">
+<dt id="pymonkey.Context.get_runtime">
+<tt class="descname">get_runtime</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Context.get_runtime" title="Permalink to this definition">¶</a></dt>
+<dd>Returns the <a title="pymonkey.Runtime" class="reference" href="#pymonkey.Runtime"><tt class="xref docutils literal"><span class="pre">Runtime</span></tt></a> that the context belongs to.</dd></dl>
+
+<dl class="method">
+<dt id="pymonkey.Context.new_object">
+<tt class="descname">new_object</tt><big>(</big><big>)</big><a class="headerlink" href="#pymonkey.Context.new_object" title="Permalink to this definition">¶</a></dt>
+<dd>Creates a new <a title="pymonkey.Object" class="reference" href="#pymonkey.Object"><tt class="xref docutils literal"><span class="pre">Object</span></tt></a> instance and returns it.</dd></dl>
+
+<dl class="method">
+<dt id="pymonkey.Context.init_standard_classes">
+<tt class="descname">init_standard_classes</tt><big>(</big><em>object</em><big>)</big><a class="headerlink" href="#pymonkey.Context.init_standard_classes" title="Permalink to this definition">¶</a></dt>
+<dd>Defines the standard JavaScript classes on the given
+<a title="pymonkey.Object" class="reference" href="#pymonkey.Object"><tt class="xref docutils literal"><span class="pre">Object</span></tt></a>, such as <tt class="docutils literal"><span class="pre">Array</span></tt>, <tt class="docutils literal"><span class="pre">eval</span></tt>, <tt class="docutils literal"><span class="pre">undefined</span></tt>, and
+so forth. For more information, see the documentation to
+<a class="reference" href="https://developer.mozilla.org/en/SpiderMonkey/JSAPI_Reference/JS_InitStandardClasses">JS_InitStandardClasses()</a>,
+which this method wraps.</dd></dl>
+
 </dd></dl>
 
 <dl class="class">
--- a/docs/rendered/searchindex.js	Fri Jul 10 18:41:14 2009 -0700
+++ b/docs/rendered/searchindex.js	Sun Jul 19 19:58:15 2009 -0700
@@ -1,1 +1,1 @@
-Search.setIndex({desctypes:{"0":"exception","1":"method","2":"class","3":"data"},terms:{spidermonkei:[0,1],represent:1,all:0,code:[0,1],execut:[0,1],less:0,abl:0,untrust:0,lack:0,becaus:0,cross:0,veri:0,concept:0,particularli:0,matur:0,languag:0,involv:0,web:0,onli:[0,1],depend:0,just:0,expos:0,how:0,readabl:0,except:1,should:0,platform:0,add:[],busi:0,requir:0,easier:0,isinst:1,build:0,them:0,liter:1,"return":1,around:0,thei:[],python:[0,1],swig:0,kind:[],pave:0,obtain:0,print:1,envis:0,capi:0,increas:0,world:0,now:[],"class":1,vast:0,enabl:0,xpcom:0,like:[0,1],anyth:0,vibrant:0,level:1,probabl:0,resolv:0,server:0,"try":0,easili:0,either:0,have:0,each:1,debug:0,through:1,refer:0,where:0,manag:0,mean:0,right:[],new_context:1,some:0,back:0,realli:0,see:1,"static":0,mirror:0,disadvantag:0,collector:0,casual:0,librari:0,out:0,even:[],index:0,detect:0,string:1,collect:0,facil:0,someth:0,path_to_objdir:0,rhino:0,access:[0,1],state:1,outstand:0,dynam:0,rational:0,between:0,atul:0,"new":1,objdir:0,forth:1,sphinx:0,challeng:0,trap:0,docutil:1,full:0,run:0,garbag:0,javascript:[0,1],situat:0,new_object:1,here:0,standard:0,objcec:[],extens:0,reason:[],base:0,preprocessor:0,repositori:0,complementari:0,path:0,come:0,don:0,valu:1,thrown:1,about:0,actual:0,easi:0,thread:1,fairli:0,root:0,current:[0,1],plai:0,page:0,blargh:[],instanc:[0,1],doctest:0,context:1,logic:0,freeli:1,chang:1,com:0,other:[0,1],tremend:0,singleton:1,via:[0,1],simpli:[],obviou:0,pyrex:0,feel:[],solut:0,modul:[0,1],runtm:1,number:0,header:0,instruct:0,api:0,serverj:0,contributor:0,side:0,custom:0,test_pymonkei:[],your:0,duplic:0,quit:0,span:1,creat:[0,1],wai:0,script:0,ergonom:0,interact:1,due:0,mark:0,avail:0,falsi:1,program:1,call:1,low:1,lot:0,suit:[],interfac:1,type:1,"final":0,too:0,free:[],field:0,from:[0,1],relationship:0,offer:1,tool:0,mozilla:[0,1],huh:[],search:0,ctype:0,doesn:0,known:0,central:0,eas:0,"true":1,than:0,must:0,count:0,wide:0,none:1,made:0,obj:1,possibl:[],provid:0,straight:0,work:0,exampl:[],conceptu:1,can:[0,1],learn:0,akin:0,more:0,similar:0,browser:0,pre:1,would:0,traceback:0,file:0,advantag:0,give:0,process:0,unintuit:[],readm:0,ani:[0,1],indic:0,repres:1,blah:[],exist:0,want:0,tabl:0,need:0,unfortun:[],featur:0,check:[],contribut:0,packag:0,alwai:0,sweep:0,"null":1,engin:[0,1],goal:0,equival:1,secur:0,boop:[],parti:0,make:0,intermediari:0,same:1,client:0,note:0,also:[0,1],ideal:0,complex:0,best:1,which:0,evaluate_script:1,test:0,verifi:1,you:0,document:0,noth:0,boof:[],runtim:1,map:1,product:0,relat:1,http:0,clone:0,object:[0,1],wherea:0,usabl:0,hand:0,befor:0,moment:0,never:0,mai:1,develop:0,defin:0,associ:1,stack:0,pymonkei:[0,1],built:1,directori:0,memori:0,todo:[],land:0,off:0,write:0,third:0,java:0,read:0,macro:0,cycl:0,counter:1,doe:[],sandbox:0,without:0,environ:0,error:1,thi:[0,1],undefin:1,programm:0,model:0,profil:0,latter:0,awesom:0,know:[]},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,1]},pymonkey:{Object:[1,2],Runtime:[1,2],undefined:[1,3],Context:[1,2],error:[1,0]}},filenames:["index","pymonkey"]})
\ No newline at end of file
+Search.setIndex({desctypes:{"0":"method","1":"exception","2":"class","3":"data"},terms:{spidermonkei:[0,1],represent:1,all:0,code:[0,1],execut:[0,1],less:0,also:[0,1],abl:0,untrust:0,lack:0,becaus:0,cross:0,veri:0,concept:0,particularli:0,falsi:1,matur:0,environ:0,languag:0,involv:0,web:0,onli:[0,1],depend:0,just:0,expos:0,field:0,readabl:0,except:1,should:0,platform:0,add:[],busi:0,requir:0,easier:0,isinst:1,build:0,them:0,liter:1,"return":1,around:0,thei:[],python:[0,1],swig:0,kind:[],pave:0,obtain:0,print:1,envis:0,capi:0,increas:0,world:0,now:[],"class":1,vast:0,enabl:0,xpcom:0,like:[0,1],anyth:0,vibrant:0,get_runtim:1,level:1,probabl:0,resolv:0,server:0,"try":0,easili:0,either:0,each:1,debug:0,through:1,where:0,manag:0,mean:0,right:[],new_context:1,clone:0,some:0,back:0,realli:0,contributor:0,see:1,"static":0,mirror:0,disadvantag:0,collector:0,casual:0,librari:0,out:0,even:[],index:0,detect:0,string:1,collect:0,facil:0,someth:0,path_to_objdir:0,rhino:0,access:[0,1],state:1,outstand:0,dynam:0,rational:0,between:0,atul:0,"new":1,objdir:0,forth:1,method:1,challeng:0,refer:0,docutil:1,full:0,run:0,garbag:0,javascript:[0,1],situat:0,new_object:1,here:0,standard:[0,1],objcec:[],extens:0,reason:[],base:0,preprocessor:0,repositori:0,complementari:0,path:0,come:0,don:0,valu:1,thrown:1,about:0,actual:0,easi:0,thread:1,fairli:0,root:0,current:[0,1],plai:0,page:0,blargh:[],instanc:[0,1],doctest:0,context:1,logic:0,freeli:1,chang:1,sphinx:0,com:0,other:[0,1],tremend:0,singleton:1,via:[0,1],simpli:[],obviou:0,pyrex:0,feel:[],solut:0,arrai:1,js_initstandardclass:1,number:0,header:0,instruct:0,api:0,serverj:0,wrap:1,side:0,custom:0,test_pymonkei:[],your:0,duplic:0,quit:0,given:1,span:1,creat:[0,1],wai:0,script:0,ergonom:0,interact:1,init_standard_class:1,due:0,mark:0,avail:0,process:0,program:1,call:1,low:1,lot:0,suit:[],interfac:1,type:1,"final":0,too:0,free:[],from:[0,1],relationship:0,offer:1,tool:0,mozilla:[0,1],huh:[],search:0,ctype:0,doesn:0,known:0,central:0,eas:0,"true":1,than:0,must:0,count:0,wide:0,none:1,made:0,obj:1,possibl:[],provid:0,straight:0,work:0,never:0,exampl:[],conceptu:1,can:[0,1],learn:0,akin:0,modul:[0,1],more:[0,1],similar:0,browser:0,pre:1,would:0,traceback:0,have:0,advantag:0,give:0,runtm:1,unintuit:[],readm:0,ani:[0,1],indic:0,repres:1,blah:[],exist:0,file:0,tabl:0,need:0,unfortun:[],featur:0,check:[],contribut:0,packag:0,alwai:0,sweep:0,"null":1,engin:[0,1],goal:0,want:0,secur:0,boop:[],parti:0,latter:0,belong:1,intermediari:0,same:1,client:0,note:0,how:0,ideal:0,complex:0,best:1,which:[0,1],evaluate_script:1,test:0,verifi:1,you:0,document:[0,1],noth:0,boof:[],runtim:1,map:1,product:0,relat:1,http:0,trap:0,object:[0,1],wherea:0,usabl:0,hand:0,befor:0,moment:0,eval:1,mai:1,develop:0,defin:[0,1],associ:1,stack:0,pymonkei:[0,1],built:1,directori:0,memori:0,todo:[],land:0,off:0,equival:1,third:0,java:0,read:0,macro:0,cycl:0,counter:1,doe:[],inform:1,sandbox:0,without:0,write:0,error:1,thi:[0,1],undefin:1,programm:0,model:0,profil:0,make:0,awesom:0,know:[]},titles:["Pymonkey Documentation","<tt class=\"docutils literal docutils literal\"><span class=\"pre\">pymonkey</span></tt> &#8212; Access SpiderMonkey from Python"],modules:{pymonkey:1},descrefs:{"pymonkey.Runtime":{new_context:[1,0]},"pymonkey.Context":{new_object:[1,0],init_standard_classes:[1,0],get_runtime:[1,0]},pymonkey:{Object:[1,2],Runtime:[1,2],undefined:[1,3],Context:[1,2],error:[1,1]}},filenames:["index","pymonkey"]})
\ No newline at end of file
--- a/docs/src/pymonkey.txt	Fri Jul 10 18:41:14 2009 -0700
+++ b/docs/src/pymonkey.txt	Sun Jul 19 19:58:15 2009 -0700
@@ -56,6 +56,23 @@
      >>> isinstance(cx, pymonkey.Context)
      True
 
+   .. method:: get_runtime()
+
+      Returns the :class:`Runtime` that the context belongs to.
+
+   .. method:: new_object()
+
+      Creates a new :class:`Object` instance and returns it.
+
+   .. method:: init_standard_classes(object)
+
+      Defines the standard JavaScript classes on the given
+      :class:`Object`, such as ``Array``, ``eval``, ``undefined``, and
+      so forth. For more information, see the documentation to
+      `JS_InitStandardClasses()
+      <https://developer.mozilla.org/en/SpiderMonkey/JSAPI_Reference/JS_InitStandardClasses>`_,
+      which this method wraps.
+
 .. class:: Runtime()
 
    Creates a new JavaScript runtime. JS objects created by the runtime