jack
/
cocorobolx


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500
							<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Namespace: Sk</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Namespace: Sk</h1>

    
<section>

<header>
    
        <h2>
        Sk
        </h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line1">line 1</a>
    </li></ul></dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Namespaces</h3>

        <dl>
            <dt><a href="Sk.abstr.html">abstr</a></dt>
            <dd></dd>
        
            <dt><a href="Sk.builtin.html">builtin</a></dt>
            <dd></dd>
        
            <dt><a href="Sk.builtin.html">builtin</a></dt>
            <dd></dd>
        
            <dt><a href="Sk.builtin.html">builtin</a></dt>
            <dd></dd>
        
            <dt><a href="Sk.ffi.html">ffi</a></dt>
            <dd></dd>
        
            <dt><a href="Sk.misceval.html">misceval</a></dt>
            <dd></dd>
        </dl>
    

        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id=".doOneTimeInitialization"><span class="type-signature">(static) </span>doOneTimeInitialization<span class="signature">()</span><span class="type-signature"> &rarr; {undefined}</span></h4>

    
<div class="description">
    <p>Complete any initialization of Python classes which relies on internal
dependencies.</p>
<p>This includes making Python classes subclassable and ensuring that the
<a href="Sk.builtin.object.html">Sk.builtin.object</a> magic methods are wrapped inside Python functions.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line187">line 187</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">undefined</span>


    </dd>
</dl>

    
    <h4 class="name" id=".importMainWithBody"><span class="type-signature">(static) </span>importMainWithBody<span class="signature">(name, dumpJS, body, canSuspend)</span><span class="type-signature"></span></h4>

    
<div class="description">
    <p><strong>Run Python Code in Skulpt</strong></p>
<p>When you want to hand Skulpt a string corresponding to a Python program this is the function.</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>File name to use for messages related to this run</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>dumpJS</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>print out the compiled javascript</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>body</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>Python Code</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>canSuspend</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
            <td class="description last"><p>Use Suspensions for async execution</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line512">line 512</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".importModule"><span class="type-signature">(static) </span>importModule<span class="signature">(name, dumpJS<span class="signature-attributes">opt</span>, canSuspend<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>the module name</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>dumpJS</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>print out the js code after compilation for debugging</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>canSuspend</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>can this function suspend and return a Suspension object?</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line485">line 485</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".importModuleInternal_"><span class="type-signature">(static) </span>importModuleInternal_<span class="signature">(name, dumpJS<span class="signature-attributes">opt</span>, modname<span class="signature-attributes">opt</span>, suppliedPyBody<span class="signature-attributes">opt</span>, canSuspend<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>name of module to import</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>dumpJS</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>whether to output the generated js code</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>modname</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>what to call the module after it's imported if
it's to be renamed (i.e. <strong>main</strong>)</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>suppliedPyBody</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>use as the body of the text for the module
rather than Sk.read'ing it.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>canSuspend</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>whether we may return a Suspension object</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line274">line 274</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".importSearchPathForName"><span class="type-signature">(static) </span>importSearchPathForName<span class="signature">(name, ext, failok<span class="signature-attributes">opt</span>, canSuspend<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>

    
    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th>Attributes</th>
        

        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>name</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>to look for</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>ext</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
                <td class="attributes">
                

                </td>
            

            <td class="description last"><p>extension to use (.py or .js)</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>failok</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>will throw if not true</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>canSuspend</code></td>
            

            <td class="type">
            
                
<span class="param-type">boolean</span>


            </td>

            
                <td class="attributes">
                
                    &lt;optional><br>
                

                </td>
            

            <td class="description last"><p>can we suspend?</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line117">line 117</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".importSetUpPath"><span class="type-signature">(static) </span>importSetUpPath<span class="signature">()</span><span class="type-signature"></span></h4>

    
<div class="description">
    <p>currently only pull once from Sk.syspath. User might want to change
from js or from py.</p>
</div>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="import.js.html">import.js</a>, <a href="import.js.html#line240">line 240</a>
    </li></ul></dd>
    

</dl>


    <h4 class="name" id=".str2number"><span class="type-signature">(static) </span>str2number<span class="signature">(s, base, parser, negater, fname)</span><span class="type-signature"> &rarr; {number}</span></h4>

    
<div class="description">
    <p>Takes a JavaScript string and returns a number using the parser and negater
 functions (for int/long right now)</p>
</div>


    <h5>Parameters:</h5>
    

<table class="params">
    <thead>
    <tr>
        
        <th>Name</th>
        

        <th>Type</th>

        
        <th class="last">Description</th>
    </tr>
    </thead>

    <tbody>
    

        <tr>
            
                <td class="name"><code>s</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>Javascript string to convert to a number.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>base</code></td>
            

            <td class="type">
            
                
<span class="param-type">number</span>


            </td>

            
            <td class="description last"><p>The base of the number.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>parser</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>Function which should take
 a string that is a postive number which only contains characters that are
 valid in the given base and a base and return a number.</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>negater</code></td>
            

            <td class="type">
            
                
<span class="param-type">function</span>


            </td>

            
            <td class="description last"><p>Function which should take a
 number and return its negation</p></td>
        </tr>

    
        <tr>
            
                <td class="name"><code>fname</code></td>
            

            <td class="type">
            
                
<span class="param-type">string</span>


            </td>

            
            <td class="description last"><p>The name of the calling function, to be used in error messages</p></td>
        </tr>

    
    </tbody>
</table>


<dl class="details">

    
    <dt class="tag-source">Source:</dt>
    <dd class="tag-source"><ul class="dummy"><li>
        <a href="int.js.html">int.js</a>, <a href="int.js.html#line1030">line 1030</a>
    </li></ul></dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    <p>The number equivalent of the string in the given base</p>
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">number</span>


    </dd>
</dl>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Sk.abstr.iter-seqIter.html">seqIter</a></li><li><a href="Sk.builtin.bool.html">bool</a></li><li><a href="Sk.builtin.float_.html">float_</a></li><li><a href="Sk.builtin.func.html">func</a></li><li><a href="Sk.builtin.int_.html">int_</a></li><li><a href="Sk.builtin.none.html">none</a></li><li><a href="Sk.builtin.NotImplemented.html">NotImplemented</a></li><li><a href="Sk.builtin.numtype.html">numtype</a></li><li><a href="Sk.builtin.object.html">object</a></li><li><a href="Sk.builtin.seqtype.html">seqtype</a></li><li><a href="Sk.misceval.Suspension.html">Suspension</a></li></ul><h3>Namespaces</h3><ul><li><a href="Sk.html">Sk</a></li><li><a href="Sk.abstr.html">abstr</a></li><li><a href="Sk.builtin.html">builtin</a></li><li><a href="Sk.ffi.html">ffi</a></li><li><a href="Sk.misceval.html">misceval</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0</a> on Thu Aug 13 2015 08:14:27 GMT-0500 (CDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>