Skip to content

Commit

Permalink
Deploying to gh-pages from @ 09be5e1 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
oxisto committed Nov 6, 2024
1 parent 33c6844 commit 9a46445
Show file tree
Hide file tree
Showing 21 changed files with 597 additions and 662 deletions.
81 changes: 38 additions & 43 deletions dokka/main/cpg-analysis/navigation.html

Large diffs are not rendered by default.

81 changes: 38 additions & 43 deletions dokka/main/cpg-console/navigation.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="cpg-core::de.fraunhofer.aisec.cpg.graph//codeAndLocationFromChildren/TypeParam(bounds=[de.fraunhofer.aisec.cpg.graph.Node])#TypeParam(bounds=[kotlin.Any?])/PointingToDeclaration//1556141526">
<div class="main-content" data-page-type="member" id="content" pageids="cpg-core::de.fraunhofer.aisec.cpg.graph//codeAndLocationFromChildren/TypeParam(bounds=[de.fraunhofer.aisec.cpg.graph.Node])#TypeParam(bounds=[kotlin.Any?])#kotlin.CharSequence/PointingToDeclaration//1556141526">
<div class="breadcrumbs"><a href="../index.html">cpg-core</a><span class="delimiter">/</span><a href="index.html">de.fraunhofer.aisec.cpg.graph</a><span class="delimiter">/</span><span class="current">codeAndLocationFromChildren</span></div>
<div class="cover ">
<h1 class="cover"><span>code</span><wbr><span>And</span><wbr><span>Location</span><wbr><span>From</span><wbr><span><span>Children</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="code-and-location-from-children.html">T</a><span class="token operator"> : </span><a href="-node/index.html">Node</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="code-and-location-from-children.html">AstNode</a><span class="token operator">&gt; </span><a href="code-and-location-from-children.html">T</a><span class="token punctuation">.</span><a href="code-and-location-from-children.html"><span class="token function">codeAndLocationFromChildren</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">parentNode<span class="token operator">: </span><a href="code-and-location-from-children.html">AstNode</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="code-and-location-from-children.html">T</a></div><p class="paragraph">This function allows the setting of a node's code and location region as the code and location of its children. Sometimes, when we translate a parent node in the language-specific AST with its children into the CPG AST, we have to set a specific intermediate Node between, that has no language-specific AST that can give it a proper code and location.</p><p class="paragraph">While the location of the node is determined by the start and end of the child locations, the code is extracted from the parent node to catch separators and auxiliary syntactic elements that are between the child nodes.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":cpg-core:dokkaHtmlPartial/main" data-filterable-set=":cpg-core:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>parent</span><wbr><span><span>Node</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Used to extract the code for this node</p></div></div></div></div></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="code-and-location-from-children.html">T</a><span class="token operator"> : </span><a href="-node/index.html">Node</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="code-and-location-from-children.html">AstNode</a><span class="token operator">&gt; </span><a href="code-and-location-from-children.html">T</a><span class="token punctuation">.</span><a href="code-and-location-from-children.html"><span class="token function">codeAndLocationFromChildren</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">parentNode<span class="token operator">: </span><a href="code-and-location-from-children.html">AstNode</a><span class="token punctuation">, </span></span><span class="parameter ">lineBreakSequence<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html">CharSequence</a><span class="token operator"> = </span><span class="token string">""</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="code-and-location-from-children.html">T</a></div><p class="paragraph">This function allows the setting of a node's code and location region as the code and location of its children. Sometimes, when we translate a parent node in the language-specific AST with its children into the CPG AST, we have to set a specific intermediate Node between, that has no language-specific AST that can give it a proper code and location.</p><p class="paragraph">While the location of the node is determined by the start and end of the child locations, the code is extracted from the parent node to catch separators and auxiliary syntactic elements that are between the child nodes.</p><h4 class="">Parameters</h4><div class="table"><div class="table-row" data-filterable-current=":cpg-core:dokkaHtmlPartial/main" data-filterable-set=":cpg-core:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>parent</span><wbr><span><span>Node</span></span></u></div></span></div><div><div class="title"><p class="paragraph">Used to extract the code for this node.</p></div></div></div></div><div class="table-row" data-filterable-current=":cpg-core:dokkaHtmlPartial/main" data-filterable-set=":cpg-core:dokkaHtmlPartial/main"><div class="main-subrow keyValue "><div class=""><span class="inline-flex"><div><u><span>new</span><wbr><span>Line</span><wbr><span><span>Type</span></span></u></div></span></div><div><div class="title"><p class="paragraph">The char(s) used to describe a new line, usually either "\n" or "\r\n". This is needed because the location block spanning the children usually comprises more than one line.</p></div></div></div></div></div></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
6 changes: 3 additions & 3 deletions dokka/main/cpg-core/de.fraunhofer.aisec.cpg.graph/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1382,17 +1382,17 @@ <h2 class="">Functions</h2>
</div>
</div>
</div>
<a data-name="1234531461%2FFunctions%2F1556141526" anchor-label="codeAndLocationFromChildren" id="1234531461%2FFunctions%2F1556141526" data-filterable-set=":cpg-core:dokkaHtmlPartial/main"></a>
<a data-name="-960543420%2FFunctions%2F1556141526" anchor-label="codeAndLocationFromChildren" id="-960543420%2FFunctions%2F1556141526" data-filterable-set=":cpg-core:dokkaHtmlPartial/main"></a>
<div class="table-row" data-togglable="EXTENSION_FUNCTION" data-filterable-current=":cpg-core:dokkaHtmlPartial/main" data-filterable-set=":cpg-core:dokkaHtmlPartial/main">
<div class="main-subrow keyValue ">
<div class=""><span class="inline-flex">
<div><a href="code-and-location-from-children.html"><span>code</span><wbr><span>And</span><wbr><span>Location</span><wbr><span>From</span><wbr><span><span>Children</span></span></a></div>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1234531461%2FFunctions%2F1556141526"></span>
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-960543420%2FFunctions%2F1556141526"></span>
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
</span></span></div>
<div>
<div class="title">
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="code-and-location-from-children.html">T</a><span class="token operator"> : </span><a href="-node/index.html">Node</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="code-and-location-from-children.html">AstNode</a><span class="token operator">&gt; </span><a href="code-and-location-from-children.html">T</a><span class="token punctuation">.</span><a href="code-and-location-from-children.html"><span class="token function">codeAndLocationFromChildren</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">parentNode<span class="token operator">: </span><a href="code-and-location-from-children.html">AstNode</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="code-and-location-from-children.html">T</a></div><div class="brief "><p class="paragraph">This function allows the setting of a node's code and location region as the code and location of its children. Sometimes, when we translate a parent node in the language-specific AST with its children into the CPG AST, we have to set a specific intermediate Node between, that has no language-specific AST that can give it a proper code and location.</p></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><span class="token operator">&lt;</span><span class="token keyword"></span><a href="code-and-location-from-children.html">T</a><span class="token operator"> : </span><a href="-node/index.html">Node</a><span class="token punctuation">, </span><span class="token keyword"></span><a href="code-and-location-from-children.html">AstNode</a><span class="token operator">&gt; </span><a href="code-and-location-from-children.html">T</a><span class="token punctuation">.</span><a href="code-and-location-from-children.html"><span class="token function">codeAndLocationFromChildren</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">parentNode<span class="token operator">: </span><a href="code-and-location-from-children.html">AstNode</a><span class="token punctuation">, </span></span><span class="parameter ">lineBreakSequence<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html">CharSequence</a><span class="token operator"> = </span><span class="token string">""</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="code-and-location-from-children.html">T</a></div><div class="brief "><p class="paragraph">This function allows the setting of a node's code and location region as the code and location of its children. Sometimes, when we translate a parent node in the language-specific AST with its children into the CPG AST, we have to set a specific intermediate Node between, that has no language-specific AST that can give it a proper code and location.</p></div></div></div>
</div>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,12 +59,12 @@
<div class="sidebar--inner" id="sideMenu"></div>
</div>
<div id="main">
<div class="main-content" data-page-type="member" id="content" pageids="cpg-core::de.fraunhofer.aisec.cpg.helpers//getCodeOfSubregion/#kotlin.String#de.fraunhofer.aisec.cpg.sarif.Region#de.fraunhofer.aisec.cpg.sarif.Region/PointingToDeclaration//1556141526">
<div class="main-content" data-page-type="member" id="content" pageids="cpg-core::de.fraunhofer.aisec.cpg.helpers//getCodeOfSubregion/#kotlin.String#de.fraunhofer.aisec.cpg.sarif.Region#de.fraunhofer.aisec.cpg.sarif.Region#kotlin.CharSequence/PointingToDeclaration//1556141526">
<div class="breadcrumbs"><a href="../index.html">cpg-core</a><span class="delimiter">/</span><a href="index.html">de.fraunhofer.aisec.cpg.helpers</a><span class="delimiter">/</span><span class="current">getCodeOfSubregion</span></div>
<div class="cover ">
<h1 class="cover"><span>get</span><wbr><span>Code</span><wbr><span>Of</span><wbr><span><span>Subregion</span></span></h1>
</div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-code-of-subregion.html"><span class="token function">getCodeOfSubregion</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">code<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">nodeRegion<span class="token operator">: </span><a href="../de.fraunhofer.aisec.cpg.sarif/-region/index.html">Region</a><span class="token punctuation">, </span></span><span class="parameter ">subRegion<span class="token operator">: </span><a href="../de.fraunhofer.aisec.cpg.sarif/-region/index.html">Region</a></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div></div></div>
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":cpg-core:dokkaHtmlPartial/main"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="get-code-of-subregion.html"><span class="token function">getCodeOfSubregion</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter ">code<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token punctuation">, </span></span><span class="parameter ">nodeRegion<span class="token operator">: </span><a href="../de.fraunhofer.aisec.cpg.sarif/-region/index.html">Region</a><span class="token punctuation">, </span></span><span class="parameter ">subRegion<span class="token operator">: </span><a href="../de.fraunhofer.aisec.cpg.sarif/-region/index.html">Region</a><span class="token punctuation">, </span></span><span class="parameter ">lineBreakSequence<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-char-sequence/index.html">CharSequence</a><span class="token operator"> = </span><span class="token string">""</span></span></span><span class="token punctuation">)</span><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a></div><p class="paragraph">Returns the part of the <a href="get-code-of-subregion.html">code</a> described by <a href="get-code-of-subregion.html">subRegion</a>, embedded in <a href="get-code-of-subregion.html">nodeRegion</a>. newLineType can be used to specify the type of new-line char(s) used on the platform.</p></div></div>
</div>
<div class="footer">
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2024 Copyright</span><span class="pull-right"><span>Generated by </span><a href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
Expand Down
Loading

0 comments on commit 9a46445

Please sign in to comment.