gudusoft.gsqlparser.pp.stmtformatter

Class FormatterFactory

Object

gudusoft.gsqlparser.pp.stmtformatter.FormatterFactory

public class FormatterFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	FormatterFactory.IFormatterBuilderCreator<E extends AbstractStmtFormatter> the callback interface to achieve the formatter builder

Constructor Summary

Constructors

Constructor and Description
FormatterFactory()

Method Summary

Modifier and Type	Method and Description
static void	clear(String sessionId)
static void	clearAllObject(String sessionId)
static AllStmtsFormatter	createAllStmtsFormatter(GFmtOpt option)
static AlterTableStmtFormatter	createAlterTableStatement(GFmtOpt opt)
static CompactModeStmtFormatter	createCompactModeStmtFormatter(GFmtOpt opt)
static CreateMaterializedViewStmtFormatter	createCreateMaterializedViewStmtFormatter(GFmtOpt opt)
static CreateTableStmtFormatter	createCreateTableStmtFormatter(GFmtOpt opt)
static CreateViewStmtFormatter	createCreateViewStmtFormatter(GFmtOpt opt)
static DeclareStmtFormatter	createDeclareStmtFormatter(GFmtOpt opt)
static DeleteStmtFormatter	createDeleteStmtFormatter(GFmtOpt opt)
static ExecuteStmtFormatter	createExecuteStmtFormatter(GFmtOpt opt)
static <E extends AbstractStmtFormatter> E	createFormatter(GFmtOpt opt, Class<E> clazz, FormatterFactory.IFormatterBuilderCreator<E> creater) create the formatter
static GoStmtFormatter	createGoStmtFormatter(GFmtOpt opt)
static IfStmtFormatter	createIfStmtFormatter(GFmtOpt opt)
static InsertStmtFormatter	createInsertStmtFormatter(GFmtOpt opt)
static PlsqlIfStmtFormatter	createPlsqlIfStmtFormatter(GFmtOpt opt)
static PlsqlStmtFormatter	createPlsqlStmtFormatter(GFmtOpt opt)
static ReturnStmtFormatter	createReturnStmtFormatter(GFmtOpt opt)
static SelectStmtFormatter	createSelectStmtFormatter(GFmtOpt opt) create select statment formatter
static SetStmtFormatter	createSetStmtFormatter(GFmtOpt opt)
static UpdateStmtFormatter	createUpdateStmtFormatter(GFmtOpt opt)
static OutputConfig	getOutputConfig() The output config set with setOutputConfig(gudusoft.gsqlparser.pp.output.OutputConfig), or null.
static boolean	isNotNeedFormat(TCustomSqlStatement sql)
static boolean	isNotNeedFormat(TSourceToken t)
static String	pp(TGSqlParser parser, GFmtOpt option)
static String	pp2(TGSqlParser parser, GFmtOpt opt) Convenience overload mirroring the pp(TGSqlParser, GFmtOpt) signature: returns the formatted text directly, so it is a drop-in replacement for a pp() call.
static Pp2FormatResult	pp2(TGSqlParser parser, Pp2FormatOptions opts) Fault-tolerant formatter entry point (pp2).
static void	processBlockStmt(GFmtOpt opt, TMssqlBlock stmt, TSourceToken ifToken)
static void	processStatement(GFmtOpt option, TCustomSqlStatement sql)
static void	setOutputConfig(OutputConfig outputConfig) Makes every later pp(TGSqlParser, GFmtOpt) and SqlFormatter.format(gudusoft.gsqlparser.TGSqlParser, gudusoft.gsqlparser.pp.para.GFmtOpt) call, in every thread, print with this config whatever its option's outputFmt says, until it is set back to null (the default), after which each call prints as its own option says again.

Methods inherited from class Object

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

Constructor Detail

FormatterFactory

public FormatterFactory()

Method Detail

createSelectStmtFormatter

public static SelectStmtFormatter createSelectStmtFormatter(GFmtOpt opt)

create select statment formatter

Parameters:

opt - options

Returns:

instance

createInsertStmtFormatter

public static InsertStmtFormatter createInsertStmtFormatter(GFmtOpt opt)

createDeleteStmtFormatter

public static DeleteStmtFormatter createDeleteStmtFormatter(GFmtOpt opt)

createUpdateStmtFormatter

public static UpdateStmtFormatter createUpdateStmtFormatter(GFmtOpt opt)

createCreateTableStmtFormatter

public static CreateTableStmtFormatter createCreateTableStmtFormatter(GFmtOpt opt)

createDeclareStmtFormatter

public static DeclareStmtFormatter createDeclareStmtFormatter(GFmtOpt opt)

createExecuteStmtFormatter

public static ExecuteStmtFormatter createExecuteStmtFormatter(GFmtOpt opt)

createSetStmtFormatter

public static SetStmtFormatter createSetStmtFormatter(GFmtOpt opt)

createIfStmtFormatter

public static IfStmtFormatter createIfStmtFormatter(GFmtOpt opt)

createPlsqlIfStmtFormatter

public static PlsqlIfStmtFormatter createPlsqlIfStmtFormatter(GFmtOpt opt)

createPlsqlStmtFormatter

public static PlsqlStmtFormatter createPlsqlStmtFormatter(GFmtOpt opt)

createGoStmtFormatter

public static GoStmtFormatter createGoStmtFormatter(GFmtOpt opt)

createCompactModeStmtFormatter

public static CompactModeStmtFormatter createCompactModeStmtFormatter(GFmtOpt opt)

createReturnStmtFormatter

public static ReturnStmtFormatter createReturnStmtFormatter(GFmtOpt opt)

createCreateViewStmtFormatter

public static CreateViewStmtFormatter createCreateViewStmtFormatter(GFmtOpt opt)

createCreateMaterializedViewStmtFormatter

public static CreateMaterializedViewStmtFormatter createCreateMaterializedViewStmtFormatter(GFmtOpt opt)

createAlterTableStatement

public static AlterTableStmtFormatter createAlterTableStatement(GFmtOpt opt)

createFormatter

public static <E extends AbstractStmtFormatter> E createFormatter(GFmtOpt opt,
                                                                  Class<E> clazz,
                                                                  FormatterFactory.IFormatterBuilderCreator<E> creater)

create the formatter

Type Parameters:

E -

Parameters:

opt -

clazz -

creater -

Returns:

processStatement

public static void processStatement(GFmtOpt option,
                                    TCustomSqlStatement sql)

isNotNeedFormat

public static boolean isNotNeedFormat(TCustomSqlStatement sql)

isNotNeedFormat

public static boolean isNotNeedFormat(TSourceToken t)

processBlockStmt

public static void processBlockStmt(GFmtOpt opt,
                                    TMssqlBlock stmt,
                                    TSourceToken ifToken)

pp

public static String pp(TGSqlParser parser,
                        GFmtOpt option)

pp2

public static Pp2FormatResult pp2(TGSqlParser parser,
                                  Pp2FormatOptions opts)

Fault-tolerant formatter entry point (pp2).

On parseable SQL, pp2 is pp

This is the first thing to know about pp2: it is not a second, competing layout engine, and it has no layout style of its own for SQL that parses. When the whole of parser.sqltext parses, pp2 calls pp(TGSqlParser, GFmtOpt) on the whole document with these same options and returns pp's own output, byte for byte. Changing a working pp() call to pp2() therefore does not change how already-formattable SQL comes out; it only changes what happens to SQL that pp() could not format at all.

Precisely, each call walks this ladder and stops at the first rung that succeeds:

1. Whole-document pp. pp2 parses the whole text itself. If that parse succeeds, it runs FormatterFactory.pp over the whole document and checks the output with a token-equivalence guard (same solid and comment tokens, same order, ignoring whitespace and keyword case). If the guard passes, that text is the answer: status OK, every region reported as GUARDED_AST. This rung is governed by Pp2FormatOptions.wholeDocumentFastPath (default true); set it to false to force the regional pipeline below.
2. Per-region pp. Otherwise — the document did not parse, or pp threw, or pp's output failed the guard — pp2 re-tokenizes the text, splits it into statement regions, and parses each region on its own. Every region that parses is still formatted by FormatterFactory.pp, behind the same guard. One broken statement therefore costs pp-quality layout for that statement only, not for the whole script.
3. pp2's own renderers. A region that does not parse, or whose pp output failed the guard, is laid out by pp2's lexical-island renderer, and failing that by its conservative token renderer. Neither consults an AST, so neither can fail on malformed input; the trade-off is plainer layout. Such a region is reported as LEXICAL_ISLAND or CONSERVATIVE, and lifts the overall status to OK_WITH_RECOVERY.

Pp2FormatResult.getRegions() tells you which rung ran where, and Pp2FormatResult.getDiagnostics() carries the per-region parser errors. A result whose regions are all GUARDED_AST is pp output; anything else marks the part of the input pp could not reach.

What pp2 gives you over pp(TGSqlParser, GFmtOpt)

• pp() requires the caller to have run parser.parse() and got 0 back. pp2 does not: it parses internally and ignores whatever parse state the caller left behind, so a TGSqlParser carrying only sqltext and a vendor is enough.
• pp() on malformed SQL yields nothing usable. pp2 always returns text and never throws for non-null inputs.
• pp2 preserves every solid input token and every comment, in input order, on every path — including the fallback renderers. Nothing is dropped, reordered, or rewritten.

This is the single additive pp2 bridge (plan §4.1/S17). It does not change the behavior of pp(TGSqlParser, GFmtOpt) or any other existing method. The heavy lifting lives in gudusoft.gsqlparser.pp2.engine.Pp2Engine.

Parameters:

parser - carries the SQL text (parser.sqltext) and dialect (parser.getDbVendor()); need not be parsed first

opts - pp2 formatting options; must not be null

Returns:

a structured Pp2FormatResult with per-region renderer choice, status, and diagnostics; never null

Throws:

NullPointerException - if parser or opts is null

pp2

public static String pp2(TGSqlParser parser,
                         GFmtOpt opt)

Convenience overload mirroring the pp(TGSqlParser, GFmtOpt) signature: returns the formatted text directly, so it is a drop-in replacement for a pp() call.

The caller's GFmtOpt is copied into a Pp2FormatOptions via Pp2FormatOptions.from(GFmtOpt) so casing / comma / indent options carry over. Byte-parity with pp() on parseable input is not an approximation of pp's style — on that input pp2 calls pp() and returns its output unchanged; see pp2(TGSqlParser, Pp2FormatOptions) for the full ladder.

 TGSqlParser parser = new TGSqlParser(EDbVendor.dbvoracle);
 parser.sqltext = sql;                  // no parse() call needed
 String formatted = FormatterFactory.pp2(parser, GFmtOptFactory.newInstance());
 

This overload discards the per-region detail. Call pp2(TGSqlParser, Pp2FormatOptions) instead when you need to know whether any part of the input fell back to pp2's own renderers (i.e. was not formatted by pp).

Parameters:

parser - carries the SQL text and dialect; need not be parsed first

opt - existing formatter options; must not be null

Returns:

the formatted SQL text; never null

Throws:

NullPointerException - if parser or opt is null

getOutputConfig

public static OutputConfig getOutputConfig()

The output config set with setOutputConfig(gudusoft.gsqlparser.pp.output.OutputConfig), or null. Formatting never sets it.

Returns:

the output config every call prints with, or null when each call follows its own GFmtOpt.outputFmt

setOutputConfig

public static void setOutputConfig(OutputConfig outputConfig)

Makes every later pp(TGSqlParser, GFmtOpt) and SqlFormatter.format(gudusoft.gsqlparser.TGSqlParser, gudusoft.gsqlparser.pp.para.GFmtOpt) call, in every thread, print with this config whatever its option's outputFmt says, until it is set back to null (the default), after which each call prints as its own option says again. Customise the config before setting it, not while calls may be printing with it.

Parameters:

outputConfig - the config to print every call with, for example an HtmlOutputConfig with custom colors; null to let each call follow its option

createAllStmtsFormatter

public static AllStmtsFormatter createAllStmtsFormatter(GFmtOpt option)

clearAllObject

public static void clearAllObject(String sessionId)

clear

public static void clear(String sessionId)