shard-ameba/Ameba/AST/Util.html

1526 lines
53 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Crystal Docs 1.11.2">
<meta name="crystal_docs.project_version" content="master">
<meta name="crystal_docs.project_name" content="ameba">
<link href="../../css/style.css" rel="stylesheet" type="text/css" />
<script type="text/javascript" src="../../js/doc.js"></script>
<meta name="repository-name" content="ameba">
<title>Ameba::AST::Util - ameba master</title>
<script type="text/javascript">
CrystalDocs.base_path = "../../";
</script>
</head>
<body>
<svg class="hidden">
<symbol id="octicon-link" viewBox="0 0 16 16">
<path fill="currentColor" fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path>
</symbol>
</svg>
<input type="checkbox" id="sidebar-btn">
<label for="sidebar-btn" id="sidebar-btn-label">
<svg class="open" xmlns="http://www.w3.org/2000/svg" height="2em" width="2em" viewBox="0 0 512 512"><title>Open Sidebar</title><path fill="currentColor" d="M80 96v64h352V96H80zm0 112v64h352v-64H80zm0 112v64h352v-64H80z"></path></svg>
<svg class="close" xmlns="http://www.w3.org/2000/svg" width="2em" height="2em" viewBox="0 0 512 512"><title>Close Sidebar</title><path fill="currentColor" d="m118.6 73.4-45.2 45.2L210.7 256 73.4 393.4l45.2 45.2L256 301.3l137.4 137.3 45.2-45.2L301.3 256l137.3-137.4-45.2-45.2L256 210.7Z"></path></svg>
</label>
<div class="sidebar">
<div class="sidebar-header">
<div class="search-box">
<input type="search" class="search-input" placeholder="Search..." spellcheck="false" aria-label="Search">
</div>
<div class="project-summary">
<h1 class="project-name">
<a href="../../index.html">
ameba
</a>
</h1>
<span class="project-version">
master
</span>
</div>
</div>
<div class="search-results hidden">
<ul class="search-list"></ul>
</div>
<div class="types-list">
<ul>
<li class="parent open current" data-id="ameba/Ameba" data-name="ameba">
<a href="../../Ameba.html">Ameba</a>
<ul>
<li class="parent open current" data-id="ameba/Ameba/AST" data-name="ameba::ast">
<a href="../../Ameba/AST.html">AST</a>
<ul>
<li class=" " data-id="ameba/Ameba/AST/Argument" data-name="ameba::ast::argument">
<a href="../../Ameba/AST/Argument.html">Argument</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Assignment" data-name="ameba::ast::assignment">
<a href="../../Ameba/AST/Assignment.html">Assignment</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/BaseVisitor" data-name="ameba::ast::basevisitor">
<a href="../../Ameba/AST/BaseVisitor.html">BaseVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Branch" data-name="ameba::ast::branch">
<a href="../../Ameba/AST/Branch.html">Branch</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Branchable" data-name="ameba::ast::branchable">
<a href="../../Ameba/AST/Branchable.html">Branchable</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/CountingVisitor" data-name="ameba::ast::countingvisitor">
<a href="../../Ameba/AST/CountingVisitor.html">CountingVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/FlowExpression" data-name="ameba::ast::flowexpression">
<a href="../../Ameba/AST/FlowExpression.html">FlowExpression</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/FlowExpressionVisitor" data-name="ameba::ast::flowexpressionvisitor">
<a href="../../Ameba/AST/FlowExpressionVisitor.html">FlowExpressionVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/InstanceVariable" data-name="ameba::ast::instancevariable">
<a href="../../Ameba/AST/InstanceVariable.html">InstanceVariable</a>
</li>
<li class="parent " data-id="ameba/Ameba/AST/NodeVisitor" data-name="ameba::ast::nodevisitor">
<a href="../../Ameba/AST/NodeVisitor.html">NodeVisitor</a>
<ul>
<li class=" " data-id="ameba/Ameba/AST/NodeVisitor/Category" data-name="ameba::ast::nodevisitor::category">
<a href="../../Ameba/AST/NodeVisitor/Category.html">Category</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/AST/RedundantControlExpressionVisitor" data-name="ameba::ast::redundantcontrolexpressionvisitor">
<a href="../../Ameba/AST/RedundantControlExpressionVisitor.html">RedundantControlExpressionVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Reference" data-name="ameba::ast::reference">
<a href="../../Ameba/AST/Reference.html">Reference</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Scope" data-name="ameba::ast::scope">
<a href="../../Ameba/AST/Scope.html">Scope</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/ScopeVisitor" data-name="ameba::ast::scopevisitor">
<a href="../../Ameba/AST/ScopeVisitor.html">ScopeVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/TopLevelNodesVisitor" data-name="ameba::ast::toplevelnodesvisitor">
<a href="../../Ameba/AST/TopLevelNodesVisitor.html">TopLevelNodesVisitor</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/TypeDecVariable" data-name="ameba::ast::typedecvariable">
<a href="../../Ameba/AST/TypeDecVariable.html">TypeDecVariable</a>
</li>
<li class=" current" data-id="ameba/Ameba/AST/Util" data-name="ameba::ast::util">
<a href="../../Ameba/AST/Util.html">Util</a>
</li>
<li class=" " data-id="ameba/Ameba/AST/Variable" data-name="ameba::ast::variable">
<a href="../../Ameba/AST/Variable.html">Variable</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Config" data-name="ameba::config">
<a href="../../Ameba/Config.html">Config</a>
</li>
<li class="parent " data-id="ameba/Ameba/Ext" data-name="ameba::ext">
<a href="../../Ameba/Ext.html">Ext</a>
<ul>
<li class=" " data-id="ameba/Ameba/Ext/Location" data-name="ameba::ext::location">
<a href="../../Ameba/Ext/Location.html">Location</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Formatter" data-name="ameba::formatter">
<a href="../../Ameba/Formatter.html">Formatter</a>
<ul>
<li class=" " data-id="ameba/Ameba/Formatter/BaseFormatter" data-name="ameba::formatter::baseformatter">
<a href="../../Ameba/Formatter/BaseFormatter.html">BaseFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/DisabledFormatter" data-name="ameba::formatter::disabledformatter">
<a href="../../Ameba/Formatter/DisabledFormatter.html">DisabledFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/DotFormatter" data-name="ameba::formatter::dotformatter">
<a href="../../Ameba/Formatter/DotFormatter.html">DotFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/ExplainFormatter" data-name="ameba::formatter::explainformatter">
<a href="../../Ameba/Formatter/ExplainFormatter.html">ExplainFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/FlycheckFormatter" data-name="ameba::formatter::flycheckformatter">
<a href="../../Ameba/Formatter/FlycheckFormatter.html">FlycheckFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/JSONFormatter" data-name="ameba::formatter::jsonformatter">
<a href="../../Ameba/Formatter/JSONFormatter.html">JSONFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/TODOFormatter" data-name="ameba::formatter::todoformatter">
<a href="../../Ameba/Formatter/TODOFormatter.html">TODOFormatter</a>
</li>
<li class=" " data-id="ameba/Ameba/Formatter/Util" data-name="ameba::formatter::util">
<a href="../../Ameba/Formatter/Util.html">Util</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/GlobUtils" data-name="ameba::globutils">
<a href="../../Ameba/GlobUtils.html">GlobUtils</a>
</li>
<li class="parent " data-id="ameba/Ameba/InlineComments" data-name="ameba::inlinecomments">
<a href="../../Ameba/InlineComments.html">InlineComments</a>
<ul>
<li class=" " data-id="ameba/Ameba/InlineComments/Action" data-name="ameba::inlinecomments::action">
<a href="../../Ameba/InlineComments/Action.html">Action</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Issue" data-name="ameba::issue">
<a href="../../Ameba/Issue.html">Issue</a>
<ul>
<li class=" " data-id="ameba/Ameba/Issue/Status" data-name="ameba::issue::status">
<a href="../../Ameba/Issue/Status.html">Status</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Presenter" data-name="ameba::presenter">
<a href="../../Ameba/Presenter.html">Presenter</a>
<ul>
<li class=" " data-id="ameba/Ameba/Presenter/BasePresenter" data-name="ameba::presenter::basepresenter">
<a href="../../Ameba/Presenter/BasePresenter.html">BasePresenter</a>
</li>
<li class=" " data-id="ameba/Ameba/Presenter/RuleCollectionPresenter" data-name="ameba::presenter::rulecollectionpresenter">
<a href="../../Ameba/Presenter/RuleCollectionPresenter.html">RuleCollectionPresenter</a>
</li>
<li class=" " data-id="ameba/Ameba/Presenter/RulePresenter" data-name="ameba::presenter::rulepresenter">
<a href="../../Ameba/Presenter/RulePresenter.html">RulePresenter</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Reportable" data-name="ameba::reportable">
<a href="../../Ameba/Reportable.html">Reportable</a>
</li>
<li class="parent " data-id="ameba/Ameba/Rule" data-name="ameba::rule">
<a href="../../Ameba/Rule.html">Rule</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Base" data-name="ameba::rule::base">
<a href="../../Ameba/Rule/Base.html">Base</a>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Documentation" data-name="ameba::rule::documentation">
<a href="../../Ameba/Rule/Documentation.html">Documentation</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Documentation/Documentation" data-name="ameba::rule::documentation::documentation">
<a href="../../Ameba/Rule/Documentation/Documentation.html">Documentation</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Documentation/DocumentationAdmonition" data-name="ameba::rule::documentation::documentationadmonition">
<a href="../../Ameba/Rule/Documentation/DocumentationAdmonition.html">DocumentationAdmonition</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Layout" data-name="ameba::rule::layout">
<a href="../../Ameba/Rule/Layout.html">Layout</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Layout/LineLength" data-name="ameba::rule::layout::linelength">
<a href="../../Ameba/Rule/Layout/LineLength.html">LineLength</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Layout/TrailingBlankLines" data-name="ameba::rule::layout::trailingblanklines">
<a href="../../Ameba/Rule/Layout/TrailingBlankLines.html">TrailingBlankLines</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Layout/TrailingWhitespace" data-name="ameba::rule::layout::trailingwhitespace">
<a href="../../Ameba/Rule/Layout/TrailingWhitespace.html">TrailingWhitespace</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Lint" data-name="ameba::rule::lint">
<a href="../../Ameba/Rule/Lint.html">Lint</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Lint/AmbiguousAssignment" data-name="ameba::rule::lint::ambiguousassignment">
<a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">AmbiguousAssignment</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/BadDirective" data-name="ameba::rule::lint::baddirective">
<a href="../../Ameba/Rule/Lint/BadDirective.html">BadDirective</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ComparisonToBoolean" data-name="ameba::rule::lint::comparisontoboolean">
<a href="../../Ameba/Rule/Lint/ComparisonToBoolean.html">ComparisonToBoolean</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DebugCalls" data-name="ameba::rule::lint::debugcalls">
<a href="../../Ameba/Rule/Lint/DebugCalls.html">DebugCalls</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DebuggerStatement" data-name="ameba::rule::lint::debuggerstatement">
<a href="../../Ameba/Rule/Lint/DebuggerStatement.html">DebuggerStatement</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/DuplicatedRequire" data-name="ameba::rule::lint::duplicatedrequire">
<a href="../../Ameba/Rule/Lint/DuplicatedRequire.html">DuplicatedRequire</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyEnsure" data-name="ameba::rule::lint::emptyensure">
<a href="../../Ameba/Rule/Lint/EmptyEnsure.html">EmptyEnsure</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyExpression" data-name="ameba::rule::lint::emptyexpression">
<a href="../../Ameba/Rule/Lint/EmptyExpression.html">EmptyExpression</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/EmptyLoop" data-name="ameba::rule::lint::emptyloop">
<a href="../../Ameba/Rule/Lint/EmptyLoop.html">EmptyLoop</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Formatting" data-name="ameba::rule::lint::formatting">
<a href="../../Ameba/Rule/Lint/Formatting.html">Formatting</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/HashDuplicatedKey" data-name="ameba::rule::lint::hashduplicatedkey">
<a href="../../Ameba/Rule/Lint/HashDuplicatedKey.html">HashDuplicatedKey</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralAssignmentsInExpressions" data-name="ameba::rule::lint::literalassignmentsinexpressions">
<a href="../../Ameba/Rule/Lint/LiteralAssignmentsInExpressions.html">LiteralAssignmentsInExpressions</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralInCondition" data-name="ameba::rule::lint::literalincondition">
<a href="../../Ameba/Rule/Lint/LiteralInCondition.html">LiteralInCondition</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralInInterpolation" data-name="ameba::rule::lint::literalininterpolation">
<a href="../../Ameba/Rule/Lint/LiteralInInterpolation.html">LiteralInInterpolation</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/LiteralsComparison" data-name="ameba::rule::lint::literalscomparison">
<a href="../../Ameba/Rule/Lint/LiteralsComparison.html">LiteralsComparison</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/MissingBlockArgument" data-name="ameba::rule::lint::missingblockargument">
<a href="../../Ameba/Rule/Lint/MissingBlockArgument.html">MissingBlockArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/NotNil" data-name="ameba::rule::lint::notnil">
<a href="../../Ameba/Rule/Lint/NotNil.html">NotNil</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/NotNilAfterNoBang" data-name="ameba::rule::lint::notnilafternobang">
<a href="../../Ameba/Rule/Lint/NotNilAfterNoBang.html">NotNilAfterNoBang</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/PercentArrays" data-name="ameba::rule::lint::percentarrays">
<a href="../../Ameba/Rule/Lint/PercentArrays.html">PercentArrays</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RandZero" data-name="ameba::rule::lint::randzero">
<a href="../../Ameba/Rule/Lint/RandZero.html">RandZero</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantStringCoercion" data-name="ameba::rule::lint::redundantstringcoercion">
<a href="../../Ameba/Rule/Lint/RedundantStringCoercion.html">RedundantStringCoercion</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantWithIndex" data-name="ameba::rule::lint::redundantwithindex">
<a href="../../Ameba/Rule/Lint/RedundantWithIndex.html">RedundantWithIndex</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/RedundantWithObject" data-name="ameba::rule::lint::redundantwithobject">
<a href="../../Ameba/Rule/Lint/RedundantWithObject.html">RedundantWithObject</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowedArgument" data-name="ameba::rule::lint::shadowedargument">
<a href="../../Ameba/Rule/Lint/ShadowedArgument.html">ShadowedArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowedException" data-name="ameba::rule::lint::shadowedexception">
<a href="../../Ameba/Rule/Lint/ShadowedException.html">ShadowedException</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/ShadowingOuterLocalVar" data-name="ameba::rule::lint::shadowingouterlocalvar">
<a href="../../Ameba/Rule/Lint/ShadowingOuterLocalVar.html">ShadowingOuterLocalVar</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SharedVarInFiber" data-name="ameba::rule::lint::sharedvarinfiber">
<a href="../../Ameba/Rule/Lint/SharedVarInFiber.html">SharedVarInFiber</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SpecFilename" data-name="ameba::rule::lint::specfilename">
<a href="../../Ameba/Rule/Lint/SpecFilename.html">SpecFilename</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/SpecFocus" data-name="ameba::rule::lint::specfocus">
<a href="../../Ameba/Rule/Lint/SpecFocus.html">SpecFocus</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Syntax" data-name="ameba::rule::lint::syntax">
<a href="../../Ameba/Rule/Lint/Syntax.html">Syntax</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/Typos" data-name="ameba::rule::lint::typos">
<a href="../../Ameba/Rule/Lint/Typos.html">Typos</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnneededDisableDirective" data-name="ameba::rule::lint::unneededdisabledirective">
<a href="../../Ameba/Rule/Lint/UnneededDisableDirective.html">UnneededDisableDirective</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnreachableCode" data-name="ameba::rule::lint::unreachablecode">
<a href="../../Ameba/Rule/Lint/UnreachableCode.html">UnreachableCode</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnusedArgument" data-name="ameba::rule::lint::unusedargument">
<a href="../../Ameba/Rule/Lint/UnusedArgument.html">UnusedArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UnusedBlockArgument" data-name="ameba::rule::lint::unusedblockargument">
<a href="../../Ameba/Rule/Lint/UnusedBlockArgument.html">UnusedBlockArgument</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UselessAssign" data-name="ameba::rule::lint::uselessassign">
<a href="../../Ameba/Rule/Lint/UselessAssign.html">UselessAssign</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Lint/UselessConditionInWhen" data-name="ameba::rule::lint::uselessconditioninwhen">
<a href="../../Ameba/Rule/Lint/UselessConditionInWhen.html">UselessConditionInWhen</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Metrics" data-name="ameba::rule::metrics">
<a href="../../Ameba/Rule/Metrics.html">Metrics</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Metrics/CyclomaticComplexity" data-name="ameba::rule::metrics::cyclomaticcomplexity">
<a href="../../Ameba/Rule/Metrics/CyclomaticComplexity.html">CyclomaticComplexity</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Naming" data-name="ameba::rule::naming">
<a href="../../Ameba/Rule/Naming.html">Naming</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Naming/AccessorMethodName" data-name="ameba::rule::naming::accessormethodname">
<a href="../../Ameba/Rule/Naming/AccessorMethodName.html">AccessorMethodName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/AsciiIdentifiers" data-name="ameba::rule::naming::asciiidentifiers">
<a href="../../Ameba/Rule/Naming/AsciiIdentifiers.html">AsciiIdentifiers</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/BinaryOperatorParameterName" data-name="ameba::rule::naming::binaryoperatorparametername">
<a href="../../Ameba/Rule/Naming/BinaryOperatorParameterName.html">BinaryOperatorParameterName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/BlockParameterName" data-name="ameba::rule::naming::blockparametername">
<a href="../../Ameba/Rule/Naming/BlockParameterName.html">BlockParameterName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/ConstantNames" data-name="ameba::rule::naming::constantnames">
<a href="../../Ameba/Rule/Naming/ConstantNames.html">ConstantNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/Filename" data-name="ameba::rule::naming::filename">
<a href="../../Ameba/Rule/Naming/Filename.html">Filename</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/MethodNames" data-name="ameba::rule::naming::methodnames">
<a href="../../Ameba/Rule/Naming/MethodNames.html">MethodNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/PredicateName" data-name="ameba::rule::naming::predicatename">
<a href="../../Ameba/Rule/Naming/PredicateName.html">PredicateName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/QueryBoolMethods" data-name="ameba::rule::naming::queryboolmethods">
<a href="../../Ameba/Rule/Naming/QueryBoolMethods.html">QueryBoolMethods</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/RescuedExceptionsVariableName" data-name="ameba::rule::naming::rescuedexceptionsvariablename">
<a href="../../Ameba/Rule/Naming/RescuedExceptionsVariableName.html">RescuedExceptionsVariableName</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/TypeNames" data-name="ameba::rule::naming::typenames">
<a href="../../Ameba/Rule/Naming/TypeNames.html">TypeNames</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Naming/VariableNames" data-name="ameba::rule::naming::variablenames">
<a href="../../Ameba/Rule/Naming/VariableNames.html">VariableNames</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Performance" data-name="ameba::rule::performance">
<a href="../../Ameba/Rule/Performance.html">Performance</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Performance/AnyAfterFilter" data-name="ameba::rule::performance::anyafterfilter">
<a href="../../Ameba/Rule/Performance/AnyAfterFilter.html">AnyAfterFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/AnyInsteadOfEmpty" data-name="ameba::rule::performance::anyinsteadofempty">
<a href="../../Ameba/Rule/Performance/AnyInsteadOfEmpty.html">AnyInsteadOfEmpty</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/Base" data-name="ameba::rule::performance::base">
<a href="../../Ameba/Rule/Performance/Base.html">Base</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/ChainedCallWithNoBang" data-name="ameba::rule::performance::chainedcallwithnobang">
<a href="../../Ameba/Rule/Performance/ChainedCallWithNoBang.html">ChainedCallWithNoBang</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/CompactAfterMap" data-name="ameba::rule::performance::compactaftermap">
<a href="../../Ameba/Rule/Performance/CompactAfterMap.html">CompactAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/ExcessiveAllocations" data-name="ameba::rule::performance::excessiveallocations">
<a href="../../Ameba/Rule/Performance/ExcessiveAllocations.html">ExcessiveAllocations</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FirstLastAfterFilter" data-name="ameba::rule::performance::firstlastafterfilter">
<a href="../../Ameba/Rule/Performance/FirstLastAfterFilter.html">FirstLastAfterFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/FlattenAfterMap" data-name="ameba::rule::performance::flattenaftermap">
<a href="../../Ameba/Rule/Performance/FlattenAfterMap.html">FlattenAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/MapInsteadOfBlock" data-name="ameba::rule::performance::mapinsteadofblock">
<a href="../../Ameba/Rule/Performance/MapInsteadOfBlock.html">MapInsteadOfBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/MinMaxAfterMap" data-name="ameba::rule::performance::minmaxaftermap">
<a href="../../Ameba/Rule/Performance/MinMaxAfterMap.html">MinMaxAfterMap</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Performance/SizeAfterFilter" data-name="ameba::rule::performance::sizeafterfilter">
<a href="../../Ameba/Rule/Performance/SizeAfterFilter.html">SizeAfterFilter</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Rule/Style" data-name="ameba::rule::style">
<a href="../../Ameba/Rule/Style.html">Style</a>
<ul>
<li class=" " data-id="ameba/Ameba/Rule/Style/GuardClause" data-name="ameba::rule::style::guardclause">
<a href="../../Ameba/Rule/Style/GuardClause.html">GuardClause</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsAFilter" data-name="ameba::rule::style::isafilter">
<a href="../../Ameba/Rule/Style/IsAFilter.html">IsAFilter</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/IsANil" data-name="ameba::rule::style::isanil">
<a href="../../Ameba/Rule/Style/IsANil.html">IsANil</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/LargeNumbers" data-name="ameba::rule::style::largenumbers">
<a href="../../Ameba/Rule/Style/LargeNumbers.html">LargeNumbers</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/NegatedConditionsInUnless" data-name="ameba::rule::style::negatedconditionsinunless">
<a href="../../Ameba/Rule/Style/NegatedConditionsInUnless.html">NegatedConditionsInUnless</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/ParenthesesAroundCondition" data-name="ameba::rule::style::parenthesesaroundcondition">
<a href="../../Ameba/Rule/Style/ParenthesesAroundCondition.html">ParenthesesAroundCondition</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantBegin" data-name="ameba::rule::style::redundantbegin">
<a href="../../Ameba/Rule/Style/RedundantBegin.html">RedundantBegin</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantNext" data-name="ameba::rule::style::redundantnext">
<a href="../../Ameba/Rule/Style/RedundantNext.html">RedundantNext</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/RedundantReturn" data-name="ameba::rule::style::redundantreturn">
<a href="../../Ameba/Rule/Style/RedundantReturn.html">RedundantReturn</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/UnlessElse" data-name="ameba::rule::style::unlesselse">
<a href="../../Ameba/Rule/Style/UnlessElse.html">UnlessElse</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/VerboseBlock" data-name="ameba::rule::style::verboseblock">
<a href="../../Ameba/Rule/Style/VerboseBlock.html">VerboseBlock</a>
</li>
<li class=" " data-id="ameba/Ameba/Rule/Style/WhileTrue" data-name="ameba::rule::style::whiletrue">
<a href="../../Ameba/Rule/Style/WhileTrue.html">WhileTrue</a>
</li>
</ul>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Runner" data-name="ameba::runner">
<a href="../../Ameba/Runner.html">Runner</a>
<ul>
<li class=" " data-id="ameba/Ameba/Runner/InfiniteCorrectionLoopError" data-name="ameba::runner::infinitecorrectionlooperror">
<a href="../../Ameba/Runner/InfiniteCorrectionLoopError.html">InfiniteCorrectionLoopError</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Severity" data-name="ameba::severity">
<a href="../../Ameba/Severity.html">Severity</a>
</li>
<li class=" " data-id="ameba/Ameba/SeverityYamlConverter" data-name="ameba::severityyamlconverter">
<a href="../../Ameba/SeverityYamlConverter.html">SeverityYamlConverter</a>
</li>
<li class="parent " data-id="ameba/Ameba/Source" data-name="ameba::source">
<a href="../../Ameba/Source.html">Source</a>
<ul>
<li class=" " data-id="ameba/Ameba/Source/Corrector" data-name="ameba::source::corrector">
<a href="../../Ameba/Source/Corrector.html">Corrector</a>
</li>
<li class=" " data-id="ameba/Ameba/Source/Rewriter" data-name="ameba::source::rewriter">
<a href="../../Ameba/Source/Rewriter.html">Rewriter</a>
</li>
</ul>
</li>
<li class="parent " data-id="ameba/Ameba/Spec" data-name="ameba::spec">
<a href="../../Ameba/Spec.html">Spec</a>
<ul>
<li class=" " data-id="ameba/Ameba/Spec/AnnotatedSource" data-name="ameba::spec::annotatedsource">
<a href="../../Ameba/Spec/AnnotatedSource.html">AnnotatedSource</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/BeValid" data-name="ameba::spec::bevalid">
<a href="../../Ameba/Spec/BeValid.html">BeValid</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/BeValidExpectation" data-name="ameba::spec::bevalidexpectation">
<a href="../../Ameba/Spec/BeValidExpectation.html">BeValidExpectation</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/ExpectIssue" data-name="ameba::spec::expectissue">
<a href="../../Ameba/Spec/ExpectIssue.html">ExpectIssue</a>
</li>
<li class=" " data-id="ameba/Ameba/Spec/Util" data-name="ameba::spec::util">
<a href="../../Ameba/Spec/Util.html">Util</a>
</li>
</ul>
</li>
<li class=" " data-id="ameba/Ameba/Tokenizer" data-name="ameba::tokenizer">
<a href="../../Ameba/Tokenizer.html">Tokenizer</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="main-content">
<h1 class="type-name">
<span class="kind">module</span> Ameba::<wbr>AST::<wbr>Util
</h1>
<h2>
<a id="overview" class="anchor" href="#overview">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Overview
</h2>
<p>Utility module for Ameba's rules.</p>
<h2>
<a id="direct-including-types" class="anchor" href="#direct-including-types">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Direct including types
</h2>
<ul class="other-types-list">
<li class="other-type"><a href="../../Ameba/AST/Branchable.html">Ameba::AST::Branchable</a></li>
<li class="other-type"><a href="../../Ameba/AST/FlowExpression.html">Ameba::AST::FlowExpression</a></li>
<li class="other-type"><a href="../../Ameba/AST/FlowExpressionVisitor.html">Ameba::AST::FlowExpressionVisitor</a></li>
<li class="other-type"><a href="../../Ameba/Reportable.html">Ameba::Reportable</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/AmbiguousAssignment.html">Ameba::Rule::Lint::AmbiguousAssignment</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/ComparisonToBoolean.html">Ameba::Rule::Lint::ComparisonToBoolean</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/EmptyLoop.html">Ameba::Rule::Lint::EmptyLoop</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralAssignmentsInExpressions.html">Ameba::Rule::Lint::LiteralAssignmentsInExpressions</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralInCondition.html">Ameba::Rule::Lint::LiteralInCondition</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralInInterpolation.html">Ameba::Rule::Lint::LiteralInInterpolation</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/LiteralsComparison.html">Ameba::Rule::Lint::LiteralsComparison</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/NotNilAfterNoBang.html">Ameba::Rule::Lint::NotNilAfterNoBang</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Lint/RedundantStringCoercion.html">Ameba::Rule::Lint::RedundantStringCoercion</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Naming/QueryBoolMethods.html">Ameba::Rule::Naming::QueryBoolMethods</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/AnyAfterFilter.html">Ameba::Rule::Performance::AnyAfterFilter</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/ChainedCallWithNoBang.html">Ameba::Rule::Performance::ChainedCallWithNoBang</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/CompactAfterMap.html">Ameba::Rule::Performance::CompactAfterMap</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/ExcessiveAllocations.html">Ameba::Rule::Performance::ExcessiveAllocations</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/FirstLastAfterFilter.html">Ameba::Rule::Performance::FirstLastAfterFilter</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/FlattenAfterMap.html">Ameba::Rule::Performance::FlattenAfterMap</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/MapInsteadOfBlock.html">Ameba::Rule::Performance::MapInsteadOfBlock</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/MinMaxAfterMap.html">Ameba::Rule::Performance::MinMaxAfterMap</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Performance/SizeAfterFilter.html">Ameba::Rule::Performance::SizeAfterFilter</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/GuardClause.html">Ameba::Rule::Style::GuardClause</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/IsAFilter.html">Ameba::Rule::Style::IsAFilter</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/IsANil.html">Ameba::Rule::Style::IsANil</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantBegin.html">Ameba::Rule::Style::RedundantBegin</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantNext.html">Ameba::Rule::Style::RedundantNext</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/RedundantReturn.html">Ameba::Rule::Style::RedundantReturn</a></li>
<li class="other-type"><a href="../../Ameba/Rule/Style/VerboseBlock.html">Ameba::Rule::Style::VerboseBlock</a></li>
</ul>
<h2>
<a id="defined-in" class="anchor" href="#defined-in">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Defined in:
</h2>
<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L2" target="_blank">
ameba/ast/util.cr
</a>
<br/>
<h2>
<a id="instance-method-summary" class="anchor" href="#instance-method-summary">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Instance Method Summary
</h2>
<ul class="list-summary">
<li class="entry-summary">
<a href="#abort%3F%28node%29-instance-method" class="signature"><strong>#abort?</strong>(node)</a>
<div class="summary"><p>Returns <code>true</code> if node represents <code>abort</code> method call.</p></div>
</li>
<li class="entry-summary">
<a href="#control_exp_code%28node%3ACrystal%3A%3AControlExpression%2Ccode_lines%29-instance-method" class="signature"><strong>#control_exp_code</strong>(node : Crystal::ControlExpression, code_lines)</a>
<div class="summary"><p>Returns the exp code of a control expression.</p></div>
</li>
<li class="entry-summary">
<a href="#dynamic_literal%3F%28node%29%3ABool-instance-method" class="signature"><strong>#dynamic_literal?</strong>(node) : Bool</a>
<div class="summary"><p>Returns <code>true</code> if current <code>node</code> is a dynamic literal, <code>false</code> otherwise.</p></div>
</li>
<li class="entry-summary">
<a href="#exit%3F%28node%29-instance-method" class="signature"><strong>#exit?</strong>(node)</a>
<div class="summary"><p>Returns <code>true</code> if node represents <code>exit</code> method call.</p></div>
</li>
<li class="entry-summary">
<a href="#flow_command%3F%28node%2Cin_loop%29-instance-method" class="signature"><strong>#flow_command?</strong>(node, in_loop)</a>
<div class="summary"><p>Returns <code>true</code> if node is a flow command, <code>false</code> otherwise.</p></div>
</li>
<li class="entry-summary">
<a href="#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method" class="signature"><strong>#flow_expression?</strong>(node, in_loop = <span class="n">false</span>)</a>
<div class="summary"><p>Returns <code>true</code> if node is a flow expression, <code>false</code> if not.</p></div>
</li>
<li class="entry-summary">
<a href="#literal%3F%28node%29%3ABool-instance-method" class="signature"><strong>#literal?</strong>(node) : Bool</a>
<div class="summary"><p>Returns <code>true</code> if current <code>node</code> is a literal, <code>false</code> otherwise.</p></div>
</li>
<li class="entry-summary">
<a href="#loop%3F%28node%29-instance-method" class="signature"><strong>#loop?</strong>(node)</a>
<div class="summary"><p>Returns <code>true</code> if node represents a loop.</p></div>
</li>
<li class="entry-summary">
<a href="#name_end_location%28node%29-instance-method" class="signature"><strong>#name_end_location</strong>(node)</a>
<div class="summary"><p>Returns <code>nil</code> if <em>node</em> does not contain a name.</p></div>
</li>
<li class="entry-summary">
<a href="#name_location%28node%29-instance-method" class="signature"><strong>#name_location</strong>(node)</a>
<div class="summary"><p>Returns <code>nil</code> if <em>node</em> does not contain a name.</p></div>
</li>
<li class="entry-summary">
<a href="#name_size%28node%29-instance-method" class="signature"><strong>#name_size</strong>(node)</a>
<div class="summary"><p>Returns zero if <em>node</em> does not contain a name.</p></div>
</li>
<li class="entry-summary">
<a href="#node_source%28node%2Ccode_lines%29-instance-method" class="signature"><strong>#node_source</strong>(node, code_lines)</a>
<div class="summary"><p>Returns a source code for the current node.</p></div>
</li>
<li class="entry-summary">
<a href="#path_named%3F%28node%2Cname%29%3ABool-instance-method" class="signature"><strong>#path_named?</strong>(node, name) : Bool</a>
<div class="summary"><p>Returns <code>true</code> if current <code>node</code> is a <code>Crystal::Path</code> matching given <em>name</em>, <code>false</code> otherwise.</p></div>
</li>
<li class="entry-summary">
<a href="#raise%3F%28node%29-instance-method" class="signature"><strong>#raise?</strong>(node)</a>
<div class="summary"><p>Returns <code>true</code> if node represents <code>raise</code> method call.</p></div>
</li>
<li class="entry-summary">
<a href="#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%7CNil-instance-method" class="signature"><strong>#source_between</strong>(loc, end_loc, code_lines) : String | Nil</a>
<div class="summary"><p>Returns the source code from <em>loc</em> to <em>end_loc</em> (inclusive).</p></div>
</li>
<li class="entry-summary">
<a href="#static_literal%3F%28node%29%3ABool-instance-method" class="signature"><strong>#static_literal?</strong>(node) : Bool</a>
<div class="summary"><p>Returns <code>true</code> if current <code>node</code> is a static literal, <code>false</code> otherwise.</p></div>
</li>
</ul>
<div class="methods-inherited">
</div>
<h2>
<a id="instance-method-detail" class="anchor" href="#instance-method-detail">
<svg class="octicon-link" aria-hidden="true">
<use href="#octicon-link"/>
</svg>
</a>
Instance Method Detail
</h2>
<div class="entry-detail" id="abort?(node)-instance-method">
<div class="signature">
def <strong>abort?</strong>(node)
<a class="method-permalink" href="#abort%3F%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node represents <code>abort</code> method call.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L180" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="control_exp_code(node:Crystal::ControlExpression,code_lines)-instance-method">
<div class="signature">
def <strong>control_exp_code</strong>(node : Crystal::ControlExpression, code_lines)
<a class="method-permalink" href="#control_exp_code%28node%3ACrystal%3A%3AControlExpression%2Ccode_lines%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns the exp code of a control expression.
Wraps implicit tuple literal with curly brackets (e.g. multi-return).</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L199" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="dynamic_literal?(node):Bool-instance-method">
<div class="signature">
def <strong>dynamic_literal?</strong>(node) : Bool
<a class="method-permalink" href="#dynamic_literal%3F%28node%29%3ABool-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if current <code>node</code> is a dynamic literal, <code>false</code> otherwise.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L48" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="exit?(node)-instance-method">
<div class="signature">
def <strong>exit?</strong>(node)
<a class="method-permalink" href="#exit%3F%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node represents <code>exit</code> method call.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L174" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="flow_command?(node,in_loop)-instance-method">
<div class="signature">
def <strong>flow_command?</strong>(node, in_loop)
<a class="method-permalink" href="#flow_command%3F%28node%2Cin_loop%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node is a flow command, <code>false</code> otherwise.
Node represents a flow command if it is a control expression,
or special call node that interrupts execution (i.e. raise, exit, abort).</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L102" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="flow_expression?(node,in_loop=false)-instance-method">
<div class="signature">
def <strong>flow_expression?</strong>(node, in_loop = <span class="n">false</span>)
<a class="method-permalink" href="#flow_expression%3F%28node%2Cin_loop%3Dfalse%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node is a flow expression, <code>false</code> if not.
Node represents a flow expression if it is full-filled by a flow command.</p>
<p>For example, this node is a flow expression, because each branch contains
a flow command <code>return</code>:</p>
<pre><code class="language-crystal"><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:positive</span>
<span class="k">elsif</span> a <span class="o">&lt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:negative</span>
<span class="k">else</span>
<span class="k">return</span> <span class="n">:zero</span>
<span class="k">end</span></code></pre>
<p>This node is a not a flow expression:</p>
<pre><code class="language-crystal"><span class="k">if</span> a <span class="o">&gt;</span> <span class="n">0</span>
<span class="k">return</span> <span class="n">:positive</span>
<span class="k">end</span></code></pre>
<p>That's because not all branches return(i.e. <code>else</code> is missing).</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L140" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="literal?(node):Bool-instance-method">
<div class="signature">
def <strong>literal?</strong>(node) : Bool
<a class="method-permalink" href="#literal%3F%28node%29%3ABool-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if current <code>node</code> is a literal, <code>false</code> otherwise.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L54" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="loop?(node)-instance-method">
<div class="signature">
def <strong>loop?</strong>(node)
<a class="method-permalink" href="#loop%3F%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node represents a loop.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L186" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="name_end_location(node)-instance-method">
<div class="signature">
def <strong>name_end_location</strong>(node)
<a class="method-permalink" href="#name_end_location%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>nil</code> if <em>node</em> does not contain a name.</p>
<p><span class="flag purple">NOTE</span> Use this instead of <code>Crystal::Call#name_end_location</code> to avoid an
off-by-one error.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L242" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="name_location(node)-instance-method">
<div class="signature">
def <strong>name_location</strong>(node)
<a class="method-permalink" href="#name_location%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>nil</code> if <em>node</em> does not contain a name.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L210" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="name_size(node)-instance-method">
<div class="signature">
def <strong>name_size</strong>(node)
<a class="method-permalink" href="#name_size%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns zero if <em>node</em> does not contain a name.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L224" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="node_source(node,code_lines)-instance-method">
<div class="signature">
def <strong>node_source</strong>(node, code_lines)
<a class="method-permalink" href="#node_source%28node%2Ccode_lines%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns a source code for the current node.
This method uses <code>node.location</code> and <code>node.end_location</code>
to determine and cut a piece of source of the node.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L69" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="path_named?(node,name):Bool-instance-method">
<div class="signature">
def <strong>path_named?</strong>(node, name) : Bool
<a class="method-permalink" href="#path_named%3F%28node%2Cname%29%3ABool-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if current <code>node</code> is a <code>Crystal::Path</code>
matching given <em>name</em>, <code>false</code> otherwise.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L61" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="raise?(node)-instance-method">
<div class="signature">
def <strong>raise?</strong>(node)
<a class="method-permalink" href="#raise%3F%28node%29-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if node represents <code>raise</code> method call.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L168" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="source_between(loc,end_loc,code_lines):String|Nil-instance-method">
<div class="signature">
def <strong>source_between</strong>(loc, end_loc, code_lines) : String | Nil
<a class="method-permalink" href="#source_between%28loc%2Cend_loc%2Ccode_lines%29%3AString%7CNil-instance-method">#</a>
</div>
<div class="doc">
<p>Returns the source code from <em>loc</em> to <em>end_loc</em> (inclusive).</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L77" target="_blank">View source</a>]
</div>
</div>
<div class="entry-detail" id="static_literal?(node):Bool-instance-method">
<div class="signature">
def <strong>static_literal?</strong>(node) : Bool
<a class="method-permalink" href="#static_literal%3F%28node%29%3ABool-instance-method">#</a>
</div>
<div class="doc">
<p>Returns <code>true</code> if current <code>node</code> is a static literal, <code>false</code> otherwise.</p>
</div>
<br/>
<div>
[<a href="https://github.com/crystal-ameba/ameba/blob/e6a5fa9/src/ameba/ast/util.cr#L42" target="_blank">View source</a>]
</div>
</div>
</div>
</body>
</html>