com.github.sbaudoin.sonar.plugins.shellcheck.lexer

Class HeredocSharedImpl

java.lang.Object

com.github.sbaudoin.sonar.plugins.shellcheck.lexer.HeredocSharedImpl

public class HeredocSharedImpl
extends Object

Shared code for the Heredoc handling. Based on the work of jansorg with a little bit of cleanup and doc.

Author:

jansorg

See Also:

the IntelliJ IDEA Bash Support plugin

Method Summary

Modifier and Type	Method and Description
static String	cleanMarker(String marker, boolean ignoredLeadingTabs) Returned the marker cleaned out of the meaningless characters suchs as quotes or $
static boolean	isEvaluatingMarker(String marker) Tells if the passed string is an evaluating marker.
static int	startMarkerTextOffset(String markerText, boolean ignoredLeadingTabs) Returns the start offset of the passed marker text
static String	wrapMarker(String newName, String originalMarker) Replaces the marker name in the original marker by the passed new name.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

cleanMarker

public static String cleanMarker(String marker,
                                 boolean ignoredLeadingTabs)

Returned the marker cleaned out of the meaningless characters suchs as quotes or $

Parameters:

marker - the marker to be cleaned

ignoredLeadingTabs - true to ignore possible leading tabs. If false, the returned marker may contain those leading tabs.

Returns:

a cleaned version of the passed marker

startMarkerTextOffset

public static int startMarkerTextOffset(String markerText,
                                        boolean ignoredLeadingTabs)

Returns the start offset of the passed marker text

Parameters:

markerText - a marker text

ignoredLeadingTabs - true to request that leading tabs are ignored. If not, the text fragment identified by the offsets may contain the tabs.

Returns:

the start offset of the passed marker text

isEvaluatingMarker

public static boolean isEvaluatingMarker(String marker)

Tells if the passed string is an evaluating marker. An evaluating marker is a string that does not start with a quote (" or '), a backslash or a $.

Parameters:

marker - a string

Returns:

true if this is an evaluating marker, false if not

wrapMarker

public static String wrapMarker(String newName,
                                String originalMarker)

Replaces the marker name in the original marker by the passed new name. The method will ignore the leading tabs in the determination of the original marker boundaries.

Parameters:

newName - a new name for the marker

originalMarker - the original marker text

Returns:

the original marker with a new name