Skip to content

PP V3 format options

Jump to bottom Edit New page
Tako Lee edited this page Mar 1, 2024 · 37 revisions

THIS PAGE IS NOT USED, PLEASE USE THIS PAGE INSTEAD.

Overview of current supported format options:

Alignments

  • gfmtopt.Select_keywords_alignOption, type of TAlignOption
  • gfmtopt.TrueLeft, type of boolean

BlankLines

  • gfmtopt.EmptyLines, type of TEmptyLinesOption
  • gfmtopt.InsertBlankLineInBatchSqls, type of boolean
  • gfmtopt.NoEmptyLinesBetweenMultiSetStmts, type of boolean
  • gfmtopt.OnlyInsertBlankAfterGo, type of boolean

Capitalisation

  • gfmtopt.case_keywords, type of TCaseOption

  • gfmtopt.case_identifier, type of TCaseOption

  • gfmtopt.case_quoted_identifier, type of TCaseOption

  • gfmtopt.case_funcname, type of TCaseOption

  • gfmtopt.case_builtinfunc, type of TCaseOption

  • gfmtopt.case_datatype, type of TCaseOption

  • gfmtopt.case_table_name, type of TCaseOption

  • gfmtopt.case_column_name, type of TCaseOption

  • gfmtopt.case_alias_name, type of TCaseOption

  • gfmtopt.case_column_alias, type of TCaseOption

  • gfmtopt.case_variable_name, type of TCaseOption

  • gfmtopt.case_prefix_identitfer, type of TCaseOption

  • gfmtopt.identifier_prefix_list, type of String

  • gfmtopt.DictionaryFile, type of String

  • gfmtopt.tableOrColumnCaseMappingFile, type of String

  • gFmtOpt.wordSeparator, type of String

Case Expression

  • gfmtopt.CaseWhenThenInSameLine, type of boolean
  • gfmtopt.Indent_CaseFromSwitch, type of integer,default is 2
  • gfmtopt.Indent_Case_Then, type of integer, default is 0
  • gfmtopt.CaseElseExprInNewline, type of boolean
  • gfmtopt.CaseThenExprInNewline, type of boolean
  • gfmtopt.CaseWhenInSamelineAsCase, type of boolean

Comments

  • gfmtopt.WSGap_EndLineComment, type of integer,default is 2
  • gfmtopt.CMT_AlignContinuouslyEndOfLineComment, type of boolean
  • gfmtopt.remove_comment, type of boolean

Create table, ref

  • gfmtopt.BEStyle_createtable_leftBEOnNewline, type of boolean

  • gfmtopt.BEStyle_createtable_leftBEIndentSize, type of integer,default is 0

  • gfmtopt.BEStyle_createtable_rightBEOnNewline, type of boolean

  • gfmtopt.BEStyle_createtable_rightBEIndentSize, type of integer,default is 0

  • gfmtopt.Createtable_ListitemInNewLine, type of boolean

  • gFmtOpt.Createtable_fields_alignWithCreateKeyword, type of boolean

  • gfmtopt.Createtable_Fieldlist_Align_option, type of TAlignOption

  • gFmtOpt.Createtable_Fieldlist_Style, type of TAlignStyle

  • gFmtOpt.Createtable_Fieldlist_Comma_option, type of TLinefeedsCommaOption

CTE

  • gfmtopt.CTE_NewlineBeforeAs, type of boolean
  • gfmtopt.CTEComma, type of TLinefeedsCommaOption
  • gfmtopt.CTE_StackColumnList, type of boolean

Declare

  • gfmtopt.LinebreakAfterDeclare, type of boolean
  • gfmtopt.declare_list_style, type of TAlignStyle
  • gfmtopt.declare_comma_option, type of TLinefeedsCommaOption

Default option

  • gfmtopt.DefaultAlignType, type of TAlignStyle
  • gfmtopt.DefaultCommaOption, type of TLinefeedsCommaOption

Execute

  • gfmtopt.exec_first_paramater_in_newline, type of boolean
  • gfmtopt.exec_parameters_align_value, type of boolean
  • gfmtopt.exec_parameters_style, type of TAlignStyle
  • gfmtopt.exec_parameters_comma_option, type of TLinefeedsCommaOption

Expression

  • gfmtopt.expr_remove_redundant_brackets, type of boolean
  • gfmtopt.expr_parenthesis_innewline, type of boolean
  • gfmtopt.expr_concat_string_max_length, type of integer, default is 40

Identation

  • gfmtopt.IndentLen, type of integer, default is 2

  • gfmtopt.UseTab, type if boolean

  • gfmtopt.TabSize, type of integer, default is 2

  • gfmtopt.InputTabSize, type of integer, default is 2

  • gfmtopt.BEStyle_Function_BodyIndent, type of integer, default is 2

  • gfmtopt.BEStyle_Block_leftBEOnNewline, type if boolean

  • gfmtopt.BEStyle_Block_leftBEIndentSize, type of integer, default is 2

  • gfmtopt.BEStyle_Block_rightBEIndentSize , type of integer, default is 2

  • gfmtopt.BEStyle_BlockIndentSize, type of integer, default is 2

  • gfmtopt.BEStyle_IfElseSingleStmtIndentSize, type of integer, default is 2

Insert

  • gFmtOpt.Insert_Columnlist_Style, type of TAlignStyle
  • gFmtOpt.Insert_Valuelist_Style, type of TAlignStyle
  • gFmtOpt.DefaultCommaOption, type of TLinefeedsCommaOption
  • gfmtopt.Insert_Parenthesis_in_separate_line, type of boolean
  • gfmtopt.Insert_Indent_Select, type of boolean
  • gfmtopt.Insert_Columns_Per_line, type of integer, default is 0

Line number

  • gfmtopt.linenumber_enabled, type of boolean
  • gfmtopt.linenumber_0_based, type of boolean
  • gfmtopt.linenumber_leftmargin, type of integer, default is 0
  • gfmtopt.linenumber_rightmargin, type of integer, default is 2

Line width

  • gfmtopt.LineWidth, type of integer, default is 999
  • gfmtopt.CompactMode, type of TCompactMode

Parameter

  • gfmtopt.BEStyle_Function_leftBEOnNewline, type of boolean
  • gfmtopt.BEStyle_Function_leftBEIndentSize, type of integer, default is 2
  • gfmtopt.BEStyle_Function_rightBEOnNewline, type of boolean
  • gfmtopt.BEStyle_Function_rightBEIndentSize, type of integer, default is 2
  • gfmtopt.BEStyle_Function_FirstParamInNewline, type of boolean
  • gfmtopt.Parameters_Style, type of TAlignStyle
  • gfmtopt.Parameters_Comma, type of TLinefeedsCommaOption
  • gfmtopt.functioncall_Parameters_Style, type of TAlignStyle
  • gfmtopt.functioncall_Parameters_Comma, type of TLinefeedsCommaOption
  • gfmtopt.Parameters_align_datatype, type of boolean

Refactor

  • gFmtOpt.addMissingSemicolon, type of boolean

The following option is not public available yet:

  • gfmtopt.MDF_KeepStmtTerminator, type of integer, 0: No change, 1: Add if possible, 2: Remove is possible
  • gfmtopt.MDF_WrapParenthesisIfCondition, type of boolean
  • gfmtopt.MDF_WrapBeginEndIf, type of boolean

Select

  • gfmtopt.Select_Columnlist_Style, type of TAlignStyle
  • gfmtopt.Select_Columnlist_Comma, type of TLinefeedsCommaOption
  • gfmtopt.SelectItemInNewLine, type of boolean
  • gfmtopt.AlignAliasInSelectList, type of boolean
  • gfmtopt.Select_fromclause_Style, type of TAlignStyle
  • gfmtopt.Select_fromclause_Comma, type of TLinefeedsCommaOption
  • gfmtopt.FromClauseInNewLine, type of boolean
  • gfmtopt.Select_FromclauseJoinOnInNewline, type of boolean
  • gfmtopt.AlignJoinWithFromKeyword, type of boolean
  • gfmtopt.AndOrUnderWhere, type of boolean
  • gfmtopt.TreatDistinctAsVirtualColumn, type of boolean
  • gfmtopt.IntoClauseInNewline, type of boolean
  • gfmtopt.WhereClauseInNewline, type of boolean
  • gfmtopt.HavingClauseInNewline, type of boolean
  • gfmtopt.GroupByClauseInNewline, type of boolean
  • gfmtopt.OrderByClauseInNewline, type of boolean
  • gfmtopt.Select_Groupby_Style, type of TAlignStyle
  • gfmtopt.Select_Orderby_Style, type of TAlignStyle
  • gFmtOpt.LinefeedsAndOr_option, type of TLinefeedsAndOrOption
  • gfmtopt.AlignAndOrWithOnInJoinClause, type of boolean
  • gfmtopt.AlignAliasInFromClause, type of boolean
  • gfmtopt.WhereClauseAlignExpr, type of boolean
  • gfmtopt.Select_FromclauseJoinConditionInNewline, type of boolean
  • gFmtOpt.commaInsideList, type of boolean
  • gFmtOpt.AlignJoinCondition, type of boolean
  • gFmtOpt.keepCommentAfterColumn, type of boolean

Subquery

  • gfmtopt.Subquery_Newline_After_IN, type of boolean
  • gfmtopt.Subquery_Newline_After_EXISTS, type of boolean
  • gfmtopt.Subquery_Newline_After_ComparisonOperator, type of boolean
  • gfmtopt.Subquery_Newline_Before_ComparisonOperator, type of boolean

Syntax highlighting

  • gfmtopt.HighlightingFontname, type of String
  • gfmtopt.HighlightingFontSize, type of Integer, default is 10

Update

  • gfmtopt.Update_Columnlist_Style, type of TAlignStyle
  • gfmtopt.update_set_clause_inNewLine, type of boolean
  • gfmtopt.update_from_clause_inNewLine, type of boolean

Whitespace

  • gfmtopt.WSPadding_OperatorArithmetic, type of boolean
  • gfmtopt.WSPadding_ParenthesesInFunction, type of boolean
  • gfmtopt.WSPadding_ParenthesesInExpression, type of boolean
  • gfmtopt.WSPadding_ParenthesesOfSubQuery, type of boolean
  • gfmtopt.WSPadding_ParenthesesInFunctionCall, type of boolean
  • gfmtopt.WSPadding_ParenthesesOfTypename, type of boolean

Output Type

  • gfmtopt.OutputFmt, type of TOutputFmt
  • gfmtopt.OutputVarname, type of String

Preprocessor

  • gfmtopt.RemoveLinebreakBeforeParse, type of boolean
  • gfmtopt.trimquotedcharofeachLine, type of boolean
  • gfmtopt.QuotedCharOfEachLine, type of character (length = 1)

Format options in prevous version

Here is the previous version of this document: http://www.dpriver.com/ppv3/index.php

PP V3 format options

Add a custom sidebar
Clone this wiki locally