gudusoft.gsqlparser.pp2.zone

Class ProtectedZoneDetector

Object

gudusoft.gsqlparser.pp2.zone.ProtectedZoneDetector

public final class ProtectedZoneDetector
extends Object

Detects protected zones in a Pp2TokenStream and annotates the affected tokens with the relevant TokenRole flags.

"Protected" here means: pp2 must emit the token's text verbatim. The layout rules in S24–S29 may re-space around a protected token but never alter its contents.

What this detector recognizes

• Line comments (ttsimplecomment, ttCPPComment) → TokenRole.COMMENT_LINE.
• Block comments (ttbracketedcomment) → TokenRole.COMMENT_BLOCK.
• Hint comments (block comment whose text begins with "/*+") → TokenRole.HINT in addition to COMMENT_BLOCK.
• String literals (ttsqstring) → TokenRole.LITERAL.
• Quoted identifiers (ttdqstring, ttdbstring, ttbrstring) → TokenRole.QUOTED_IDENTIFIER.
• No-format blocks: every token whose source position lies between a --BEGIN_NO_FORMAT line comment and a matching --END_NO_FORMAT line comment is flagged with TokenRole.NO_FORMAT_ZONE. The markers themselves carry the flag too.
• Template placeholders: tokens whose text matches the shapes ${name}, {{name}}, or #{name} are flagged TokenRole.TEMPLATE_PLACEHOLDER and TokenRole.NO_FORMAT_ZONE so layout never reflows inside them. ${name} arrives from the lexer as a single identifier-style token and is matched in the per-token pass; {{name}} and #{name} are tokenized as multiple tokens (e.g., "{" "{" name "}" "}") and a second pass walks the stream looking for those sequences. The second-pass body check rejects shapes whose interior does not look like a placeholder body, so SQL fragments that happen to contain isolated braces (e.g., JSON path literals) are not misflagged.

The detector does not consume or produce tokens; it only adds roles to existing Pp2Tokens. Repeated invocations are idempotent (the underlying EnumSet is set-typed).

Plan reference: §7.3/S9, §7.4/S9.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_FORMAT_BEGIN Marker comment text that opens a no-format block.
static String	NO_FORMAT_END Marker comment text that closes a no-format block.

Constructor Summary

Constructors

Constructor and Description
ProtectedZoneDetector()

Method Summary

Modifier and Type	Method and Description
void	annotate(Pp2TokenStream stream) Annotate the supplied stream in place.
static boolean	isHintText(String text) True if the given text is a hint-style block comment, i.e., starts with "/*+".
static boolean	isNoFormatBeginMarker(ETokenType type, String text) True if the given line-comment text opens a no-format block.
static boolean	isNoFormatEndMarker(ETokenType type, String text) True if the given line-comment text closes a no-format block.
static boolean	isTemplatePlaceholder(String text) True if the given text matches a single-token template-placeholder shape: ${name}, {{name}}, or #{name}.

Methods inherited from class Object

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

Field Detail

NO_FORMAT_BEGIN

public static final String NO_FORMAT_BEGIN

Marker comment text that opens a no-format block.

See Also:

Constant Field Values

NO_FORMAT_END

public static final String NO_FORMAT_END

Marker comment text that closes a no-format block.

See Also:

Constant Field Values

Constructor Detail

ProtectedZoneDetector

public ProtectedZoneDetector()

Method Detail

annotate

public void annotate(Pp2TokenStream stream)

Annotate the supplied stream in place. The stream's structural immutability is not violated — only the per-token role sets are touched.

Performed in two passes:

1. Per-token classification (comments, literals, quoted ids, single-token placeholders) and the no-format block state machine.
2. Multi-token template placeholders {{name}} and #{name}, detected by scanning consecutive token text.

Idempotent: repeated invocations don't double-flag because the underlying role set is set-typed.

Throws:

NullPointerException - if stream is null

isHintText

public static boolean isHintText(String text)

True if the given text is a hint-style block comment, i.e., starts with "/*+".

isTemplatePlaceholder

public static boolean isTemplatePlaceholder(String text)

True if the given text matches a single-token template-placeholder shape: ${name}, {{name}}, or #{name}.

isNoFormatBeginMarker

public static boolean isNoFormatBeginMarker(ETokenType type,
                                            String text)

True if the given line-comment text opens a no-format block. The match is case-sensitive and ignores trailing whitespace; the comment may include trailing characters as long as the prefix matches the documented marker.

isNoFormatEndMarker

public static boolean isNoFormatEndMarker(ETokenType type,
                                          String text)

True if the given line-comment text closes a no-format block.