effect-user-code.html

<pre class=metadata>
toc: false
copyright: false
assets: none
</pre>

<emu-clause id="sec-user-code" type="abstract operation">
  <h1>UserCode ( )</h1>
  <dl class="header">
  </dl>
  <emu-alg>
    1. <emu-meta effects="user-code">Call user code</emu-meta>.
  </emu-alg>
</emu-clause>


<emu-clause id="sec-user-code-2" type="abstract operation">
  <h1>UserCode2 ( )</h1>
  <dl class="header">
    <dt>effects</dt>
    <dd>user-code</dd>
  </dl>
  <p>This AO calls user code despite not being defined with an algorithm.</p>
</emu-clause>

<emu-clause id="sec-nop" type="abstract operation">
  <h1>Nop ( )</h1>
  <dl class="header">
  </dl>
  <emu-alg>
    1. Do nothing.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-direct-call" type="abstract operation">
  <h1>DirectCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Calling AOs that can call user code should insert <code>e-user-code</code> as a class into the AO link.</dd>
  </dl>
  <emu-alg>
    1. UserCode().
    1. UserCode2().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-transitive-call" type="abstract operation">
  <h1>TransitiveCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Calling AOs that can transitively call user code should insert <code>e-user-code</code> as a class into the AO link.</dd>
  </dl>
  <emu-alg>
    1. DirectCall().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-suppressed-direct-call" type="abstract operation">
  <h1>SuppressedDirectCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Can-call-user-code callsites that are suppressed do not get <code>e-user-code</code> as a class in the AO link.</dd>
  </dl>
  <emu-alg>
    1. <emu-meta suppress-effects="user-code">TransitiveCall()</emu-meta>.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-suppressed-transitive-call" type="abstract operation">
  <h1>SuppressedTransitiveCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Can-call-user-code callsites that are suppressed do not propagate the effect</dd>
  </dl>
  <emu-alg>
    1. SuppressedDirectCall().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-added-direct-call" type="abstract operation">
  <h1>AddedDirectCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>AOs can have manually added user-code effect at a callsite that propagates.</dd>
  </dl>
  <emu-alg>
    1. <emu-meta effects="user-code">Nop()</emu-meta>.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-added-transitive-call" type="abstract operation">
  <h1>AddedTransitiveCall()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>AOs can have manually added user-code effect at a callsite that propagates.</dd>
  </dl>
  <emu-alg>
    1. AddedDirectCall().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-sdo-invocation" type="abstract operation">
  <h1>SDOInvocations()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>SDO-style invocations of AOs that can call user code also have the <code>e-user-code</code> class in the link.</dd>
  </dl>
  <emu-alg>
    1. UserCode of Bar.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-non-invocations" type="abstract operation">
  <h1>NonInvocations()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Non-invocations (i.e. not followed by () or " of") do not have <code>e-user-code</code> as a class in the AO link.</dd>
  </dl>
  <emu-alg>
    1. UserCode is an abstract operation.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-non-abrupt" type="abstract operation">
  <h1>NonAbrupt()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Invocations that cannot result in abrupt completions suppress the user-code effect by default.</dd>
  </dl>
  <emu-alg>
    1. Let _res_ be ! UserCode().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-non-abrupt-override" type="abstract operation">
  <h1>NonAbruptOverride()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Invocations that cannot result in abrupt completions suppress the user-code effect by default but can still be overridden.</dd>
  </dl>
  <emu-alg>
    1. Let _res_ be ! <emu-meta effects="user-code">UserCode()</emu-meta>.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-static-direct-call" type="sdo">
  <h1>Static Semantics: StaticDirectCall</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Static semantics suppress user-code.</dd>
  </dl>
  <emu-alg>
    1. UserCode().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-static-transitive-call" type="sdo">
  <h1>Static Semantics: StaticTransitiveCall</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Static semantics suppress user-code.</dd>
  </dl>
  <emu-alg>
    1. StaticDirectCall of Baz.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-rendered-meta" type="abstract operation">
  <h1>RenderedMeta()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>emu-meta tags with the effects attribute that aren't surrounding what ecmarkup recognizes as invocations are changed into span tags to be rendered. The effects list is prefixed with e- and changed into class names.</dd>
  </dl>
  <emu-alg>
    1. Perform ? <emu-meta effects="user-code">_O_.[[Call]]()</emu-meta>.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-make-abstract-closure" type="abstract operation">
  <h1>MakeAbstractClosure()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>The user-code effect doesn't propagate through Abstract Closure boundaries by recognizing the "be a new Abstract Closure" substring.</dd>
  </dl>
  <emu-alg>
    1. Let _closure_ be a new Abstract Closure that captures nothing and performs the following steps when called:
      1. UserCode().
    1. Return _closure_.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-call-make-abstract-closure" type="abstract operation">
  <h1>CallMakeAbstractClosure()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>The user-code effect doesn't propagate through Abstract Closure boundaries by recognizing the "be a new Abstract Closure" substring.</dd>
  </dl>
  <emu-alg>
    1. MakeAbstractClosure().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-xref-not-first-child-of-emu-meta" type="abstract operation">
  <h1>XrefNotFirstChildOfEmuMeta()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Effect additions and suppressions via emu-meta only affect xrefs that are the first child of the emu-meta. Below, UserCode() gets autolinked and get an xref. Its parent element is an emu-meta, but since the xref is not the first child, it should not be interpreted to override the effects of the UserCode() call.</dd>
  </dl>
  <emu-alg>
    1. Perform <emu-meta effects="user-code">_map_.[[DefineOwnProperty]](! UserCode())</emu-meta>.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-result-of-evaluating" type="abstract operation">
  <h1>ResultOfEvaluating()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>The phrase "the result of evaluating Foo" is automatically considered as can call user code.</dd>
  </dl>
  <emu-alg>
    1. Let _res_ be the result of evaluating |Foo|.
  </emu-alg>
</emu-clause>

<emu-clause id="sec-fenced-effects" type="abstract operation">
  <h1>FencedEffects()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Effects don't propagate past fences in parent steps. A fence must be at the beginning of a step.</dd>
  </dl>
  <emu-alg>
    1. [fence-effects="user-code"] Fence.
      1. UserCode().
  </emu-alg>
</emu-clause>

<emu-clause id="sec-call-fenced-effects" type="abstract operation">
  <h1>CallFencedEffects()</h1>
  <dl class="header">
    <dt>description</dt>
    <dd>Effects don't propagate past fences in parent steps.</dd>
  </dl>
  <emu-alg>
    1. FencedEffects().
  </emu-alg>
</emu-clause>