From 44f39b628c487af77c0a503d622d57b99748e1e1 Mon Sep 17 00:00:00 2001 From: Michele Calgaro Date: Wed, 31 May 2023 19:27:38 +0900 Subject: Added UiGuiErrorMessage, UiGuiIniFileParse and some code related to them. Added indenter .ini files. Signed-off-by: Michele Calgaro --- indenters/CMakeLists.txt | 24 + indenters/__TODO/uigui_CblBeau.ini | 543 ----- indenters/__TODO/uigui_astyle.ini | 321 --- indenters/__TODO/uigui_bcpp.ini | 144 -- indenters/__TODO/uigui_csstidy.ini | 119 - indenters/__TODO/uigui_f90ppr.ini | 17 - indenters/__TODO/uigui_gnuindent.ini | 527 ---- indenters/__TODO/uigui_greatcode.ini | 1363 ----------- indenters/__TODO/uigui_hindent.ini | 66 - indenters/__TODO/uigui_htb.ini | 147 -- indenters/__TODO/uigui_jsdecoder.ini | 17 - indenters/__TODO/uigui_jsppp.ini | 81 - indenters/__TODO/uigui_perltidy.ini | 1040 -------- indenters/__TODO/uigui_phpCB.ini | 151 -- indenters/__TODO/uigui_phpStylist.ini | 258 -- indenters/__TODO/uigui_php_Beautifier.ini | 108 - indenters/__TODO/uigui_pindent.ini | 54 - indenters/__TODO/uigui_psti.ini | 196 -- indenters/__TODO/uigui_rbeautify.ini | 17 - indenters/__TODO/uigui_rubyformatter.ini | 27 - indenters/__TODO/uigui_shellindent.ini | 17 - indenters/__TODO/uigui_tidy.ini | 612 ----- indenters/__TODO/uigui_uncrustify.ini | 3691 ----------------------------- indenters/__TODO/uigui_vbsbeaut.ini | 45 - indenters/__TODO/uigui_xmlindent.ini | 61 - indenters/uigui_CblBeau.ini | 543 +++++ indenters/uigui_astyle.ini | 321 +++ indenters/uigui_bcpp.ini | 144 ++ indenters/uigui_csstidy.ini | 119 + indenters/uigui_f90ppr.ini | 17 + indenters/uigui_gnuindent.ini | 527 ++++ indenters/uigui_greatcode.ini | 1363 +++++++++++ indenters/uigui_hindent.ini | 66 + indenters/uigui_htb.ini | 147 ++ indenters/uigui_jsdecoder.ini | 17 + indenters/uigui_jsppp.ini | 81 + indenters/uigui_perltidy.ini | 1040 ++++++++ indenters/uigui_phpCB.ini | 151 ++ indenters/uigui_phpStylist.ini | 258 ++ indenters/uigui_php_Beautifier.ini | 108 + indenters/uigui_pindent.ini | 54 + indenters/uigui_psti.ini | 196 ++ indenters/uigui_rbeautify.ini | 17 + indenters/uigui_rubyformatter.ini | 27 + indenters/uigui_shellindent.ini | 17 + indenters/uigui_tidy.ini | 612 +++++ indenters/uigui_uncrustify.ini | 3691 +++++++++++++++++++++++++++++ indenters/uigui_vbsbeaut.ini | 45 + indenters/uigui_xmlindent.ini | 61 + src/CMakeLists.txt | 2 + src/IndentHandler.cpp | 537 ++--- src/IndentHandler.h | 40 +- src/MainWindow.cpp | 26 +- src/MainWindow.h | 2 +- src/UiGuiErrorMessage.cpp | 93 + src/UiGuiErrorMessage.h | 45 + src/UiGuiIniFileParser.cpp | 151 ++ src/UiGuiIniFileParser.h | 52 + src/__TODO/UiGuiErrorMessage.cpp | 93 - src/__TODO/UiGuiErrorMessage.h | 44 - src/__TODO/UiGuiIniFileParser.cpp | 160 -- src/__TODO/UiGuiIniFileParser.h | 53 - 62 files changed, 10293 insertions(+), 10273 deletions(-) delete mode 100755 indenters/__TODO/uigui_CblBeau.ini delete mode 100755 indenters/__TODO/uigui_astyle.ini delete mode 100755 indenters/__TODO/uigui_bcpp.ini delete mode 100755 indenters/__TODO/uigui_csstidy.ini delete mode 100755 indenters/__TODO/uigui_f90ppr.ini delete mode 100755 indenters/__TODO/uigui_gnuindent.ini delete mode 100755 indenters/__TODO/uigui_greatcode.ini delete mode 100755 indenters/__TODO/uigui_hindent.ini delete mode 100755 indenters/__TODO/uigui_htb.ini delete mode 100755 indenters/__TODO/uigui_jsdecoder.ini delete mode 100755 indenters/__TODO/uigui_jsppp.ini delete mode 100755 indenters/__TODO/uigui_perltidy.ini delete mode 100755 indenters/__TODO/uigui_phpCB.ini delete mode 100755 indenters/__TODO/uigui_phpStylist.ini delete mode 100755 indenters/__TODO/uigui_php_Beautifier.ini delete mode 100755 indenters/__TODO/uigui_pindent.ini delete mode 100755 indenters/__TODO/uigui_psti.ini delete mode 100755 indenters/__TODO/uigui_rbeautify.ini delete mode 100755 indenters/__TODO/uigui_rubyformatter.ini delete mode 100755 indenters/__TODO/uigui_shellindent.ini delete mode 100755 indenters/__TODO/uigui_tidy.ini delete mode 100755 indenters/__TODO/uigui_uncrustify.ini delete mode 100755 indenters/__TODO/uigui_vbsbeaut.ini delete mode 100755 indenters/__TODO/uigui_xmlindent.ini create mode 100755 indenters/uigui_CblBeau.ini create mode 100755 indenters/uigui_astyle.ini create mode 100755 indenters/uigui_bcpp.ini create mode 100755 indenters/uigui_csstidy.ini create mode 100755 indenters/uigui_f90ppr.ini create mode 100755 indenters/uigui_gnuindent.ini create mode 100755 indenters/uigui_greatcode.ini create mode 100755 indenters/uigui_hindent.ini create mode 100755 indenters/uigui_htb.ini create mode 100755 indenters/uigui_jsdecoder.ini create mode 100755 indenters/uigui_jsppp.ini create mode 100755 indenters/uigui_perltidy.ini create mode 100755 indenters/uigui_phpCB.ini create mode 100755 indenters/uigui_phpStylist.ini create mode 100755 indenters/uigui_php_Beautifier.ini create mode 100755 indenters/uigui_pindent.ini create mode 100755 indenters/uigui_psti.ini create mode 100755 indenters/uigui_rbeautify.ini create mode 100755 indenters/uigui_rubyformatter.ini create mode 100755 indenters/uigui_shellindent.ini create mode 100755 indenters/uigui_tidy.ini create mode 100755 indenters/uigui_uncrustify.ini create mode 100755 indenters/uigui_vbsbeaut.ini create mode 100755 indenters/uigui_xmlindent.ini create mode 100644 src/UiGuiErrorMessage.cpp create mode 100644 src/UiGuiErrorMessage.h create mode 100644 src/UiGuiIniFileParser.cpp create mode 100644 src/UiGuiIniFileParser.h delete mode 100644 src/__TODO/UiGuiErrorMessage.cpp delete mode 100644 src/__TODO/UiGuiErrorMessage.h delete mode 100644 src/__TODO/UiGuiIniFileParser.cpp delete mode 100644 src/__TODO/UiGuiIniFileParser.h diff --git a/indenters/CMakeLists.txt b/indenters/CMakeLists.txt index c0ae4b6..2fc3cb0 100644 --- a/indenters/CMakeLists.txt +++ b/indenters/CMakeLists.txt @@ -1,5 +1,29 @@ install( FILES example.cpp + uigui_astyle.ini + uigui_bcpp.ini + uigui_CblBeau.ini + uigui_csstidy.ini + uigui_f90ppr.ini + uigui_gnuindent.ini + uigui_greatcode.ini + uigui_hindent.ini + uigui_htb.ini + uigui_jsdecoder.ini + uigui_jsppp.ini + uigui_perltidy.ini + uigui_php_Beautifier.ini + uigui_phpCB.ini + uigui_phpStylist.ini + uigui_pindent.ini + uigui_psti.ini + uigui_rbeautify.ini + uigui_rubyformatter.ini + uigui_shellindent.ini + uigui_tidy.ini + uigui_uncrustify.ini + uigui_vbsbeaut.ini + uigui_xmlindent.ini DESTINATION ${SHARE_INSTALL_PREFIX}/universal-indent-gui-tqt/indenters ) diff --git a/indenters/__TODO/uigui_CblBeau.ini b/indenters/__TODO/uigui_CblBeau.ini deleted file mode 100755 index 069f429..0000000 --- a/indenters/__TODO/uigui_CblBeau.ini +++ /dev/null @@ -1,543 +0,0 @@ -[header] -categories="Cobol Beautifier|Renumbering|Generic Reporting|Cobol Dialects|Extra Features|Copy Libraries|Parser Messages|Length and Offset|PrettyPrint Basics|PrettyPrint Indentation|Output Comments|Line Identification" -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.cbl|*.cob -indenterFileName=cbl-beau.exe -indenterName=Cobol Beautifier (Cobol) -inputFileName=indentinput -inputFileParameter=" " -manual=http://www.siber.com/sct/tools/cbl-beau.html -outputFileName=indentoutput -outputFileParameter="-gen-file=" -parameterOrder=ipo -showHelpParameter="-help" -stringparaminquotes=false -useCfgFileParameter= -version=1.0 - - -[Add value clause] -Category=0 -Description="Add VALUE clauses to WS data items that have no VALUE clause" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-add-value-clause|" - -[Norm dd levels] -Category=0 -Description="Normalize data item level numbers" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-norm-dd-levels|" - -[Add end stmts] -Category=0 -Description="Add END-IF, END-SEARCH, END-EVALUATE, END-PERFORM closing statements" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-add-end-stmts|" - -[Section name fmt] -CallName="-section-name-fmt=" -Category=1 -Description="Section name format, smth like T1%dT2%sT3" -EditorType=string -Enabled=false -ValueDefault="T1%dT2%sT3" - -[Section name start] -CallName="-section-name-start=" -Category=1 -Description="Start value for number in section name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Section name step] -CallName="-section-name-step=" -Category=1 -Description="Step for number in section name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Para name fmt] -CallName="-para-name-fmt=" -Category=1 -Description="Paragraph name format, smth like T1%dT2%sT3" -EditorType=string -Enabled=false -ValueDefault="T1%dT2%sT3" - -[Para name start] -CallName="-para-name-start=" -Category=1 -Description="Start value for counter in paragraph name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Para name step] -CallName="-para-name-step=" -Category=1 -Description="Step for counter in paragraph name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Data name fmt] -CallName="-data-name-fmt=" -Category=1 -Description="Data name format, smth like T1%dT2%sT3" -EditorType=string -Enabled=false -ValueDefault="T1%dT2%sT3" - -[Data name start] -CallName="-data-name-start=" -Category=1 -Description="Start value for number in data name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Data name step] -CallName="-data-name-step=" -Category=1 -Description="Step for number in data name" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Conv warn] -Category=2 -Description="Warn about transformation problems" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-conv-warn|-no-conv-warn" - -[Conv info] -Category=2 -Description="Inform about every transformation performed" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-conv-info|-no-conv-info" - -[Conv list] -Category=2 -Description="List all transformations applied" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-conv-list|-no-conv-list" - -[Find only] -Category=2 -Description="Only list potential transformations, do not execute them" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-find-only|-no-find-only" - -[Silent] -Category=2 -Description="Do not print short summary of the conversion" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-silent|-no-silent" - -[Primary Cobol dialect] -Category=3 -Description="Set the primary Cobol dialect" -ValueDefault=1 -Enabled=false -EditorType=multiple -Choices="-lang=ansi74|-lang=ansi85|-lang=osvs|-lang=vsii|-lang=saa|-lang=xopen|-lang=mf|-lang=ms|-lang=rm|-lang=rm85|-lang=dosvs|-lang=univac|-lang=wang|-lang=fsc|-lang=net|-lang=fscnet|-lang=icobol|-lang=acu|-lang=dml|-lang=idms" -ChoicesReadable="Ansi 74|Ansi 85|OSVS|VSII|SAA|XOpen|MF|MS|RM|RM 85|DOSVS|UniVAC|Wang|FSC|Net|FSCnet|iCobol|ACU|DML|IDMS" - -[Secondary Cobol dialect] -Category=3 -Description="Set the secondary Cobol dialect" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-lang2=ansi74|-lang2=ansi85|-lang2=osvs|-lang2=vsii|-lang2=saa|-lang2=xopen|-lang2=mf|-lang2=ms|-lang2=rm|-lang2=rm85|-lang2=dosvs|-lang2=univac|-lang2=wang|-lang2=fsc|-lang2=net|-lang2=fscnet|-lang2=icobol|-lang2=acu|-lang2=dml|-lang2=idms" -ChoicesReadable="Ansi 74|Ansi 85|OSVS|VSII|SAA|XOpen|MF|MS|RM|RM 85|DOSVS|UniVAC|Wang|FSC|Net|FSCnet|iCobol|ACU|DML|IDMS" - -[Line format] -Category=3 -Description="Set the secondary Cobol dialect" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-line-format=dial|-line-format=fixed|-line-format=free|-line-format=fsc-free|-line-format=var" -ChoicesReadable="Dial|fixed|free|FSC free|var" - -[Progid comments] -Category=3 -Description="Allow Program-Id line comments" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-progid-comments|-no-progid-comments" - -[Separators follow spaces] -Category=3 -Description="Separators must be followed by spaces" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-sep-space-reqd=dial|-sep-space-reqd=no|-sep-space-reqd=yes" -ChoicesReadable="Dial|No|Yes" - -[Exclude keywords] -CallName="-exclude-keywords=" -Category=3 -Description="Excluded keywords (separated by spaces?)" -EditorType=string -Enabled=false -ValueDefault="" - -[Set constants] -CallName="-set-constants=" -Category=4 -Description="78 constant settings, strings: name'value', numbers: name(value)" -EditorType=string -Enabled=false -ValueDefault="" - -[Assign external] -Category=4 -Description="Assume that undefined data items in ASSIGN TO are external" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-assign-external|-no-assign-external" - -[SQL] -Category=4 -Description="Parse SQL in EXEC SQL" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-sql|-no-sql" - -[CICS] -Category=4 -Description="Parse CICS statements embedded in EXEC CICS ... END-EXEC" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-cics|-no-cics" - -[CICS EIB] -Category=4 -Description="Add CICS EIB data block to LINKAGE SECTION" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-cics-eib=auto|-cics-eib=no|-cics-eib=yes" -ChoicesReadable="Auto|No|Yes" - -[Copylib dir] -CallName="-copylib-dir=" -Category=5 -Description="Copylib directories path" -EditorType=string -Enabled=false -ValueDefault="." - -[Copylib suffix] -CallName="-copylib-sfx=" -Category=5 -Description="Copylib files default suffix(es)" -EditorType=string -Enabled=false -ValueDefault=".cpy" - -[Copylib names] -Category=5 -Description="Add CICS EIB data block to LINKAGE SECTION" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-copynames-case=exact|-copynames-case=lower|-copynames-case=upper" -ChoicesReadable="Exact|Lower|Upper" - -[Copylib old] -Category=5 -Description="Allow old 1968 Copy statements" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-old-copy|-no-old-copy" - -[Copylib irreversibly] -Category=5 -Description="Inline copybooks irreversibly" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-irrev-inline|-no-irrev-inline" - -[Warnings] -Category=6 -Description="Display Warnings" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-warnings|-no-warnings" - -[Muli undef errors] -Category=6 -Description="Error message for every (OFF: only first) use of undefined name" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-multi-undefd-errs|-no-multi-undefd-errs" - -[Same para data name] -Category=6 -Description="One name can be used both as paragraph-name and data-name" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-same-para-data-name=dial|-same-para-data-name=no|-same-para-data-name=yes" -ChoicesReadable="Dial|No|Yes" - -[Lengths and offsets] -Category=7 -Description="Compute data item lengths and offsets" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-leng-offs|-no-leng-offs" - -[Storage mode] -Category=7 -Description="Is Numeric Sign a Trailing Separate Character" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-lo-stor-mode=dial|-lo-stor-mode=no|-lo-stor-mode=yes" -ChoicesReadable="Dial|No|Yes" - -[Numeric sign trailing separate] -Category=7 -Description="Is Numeric Sign a Trailing Separate Character" -ValueDefault=0 -Enabled=false -EditorType=multiple -Choices="-num-sign-trail-sep=dial|-num-sign-trail-sep=no|-num-sign-trail-sep=yes" -ChoicesReadable="Dial|No|Yes" - -[Num sign EBCDIC] -Category=7 -Description="Is Numeric Sign an EBCDIC character" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-num-sign-ebcdic|-no-num-sign-ebcdic" - -[Lo pointer size] -CallName="-lo-pointer-size=" -Category=7 -Description="Memory model: Pointer size" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=4 - -[Lo proc pointer size] -CallName="-lo-proc-pointer-size=" -Category=7 -Description="Memory model: Procedure-Pointer size" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=4 - -[Lo index size] -CallName="-lo-index-size=" -Category=7 -Description="Memory model: Index size" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=4 - -[Lo unfold flex arrays] -Category=7 -Description="Compute length of table with OCCURS DEPENDING ON based on upper bounds" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-lo-unfold-flex-arrays|-no-lo-unfold-flex-arrays" - -[Progress] -Category=7 -Description="Display Parsing Progress Indicator" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-progress|-no-progress" - -[Bailout level] -Category=7 -Description="Level of parser messages that cause bailout" -ValueDefault=2 -Enabled=false -EditorType=multiple -Choices="-bailout-level=warnings|-bailout-level=errors|-bailout-level=severe" -ChoicesReadable="Warnings|Errors|Severe" - -[Stats] -Category=7 -Description="Print short source program statistics" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-stat|-no-stat" - -[Genereate SourcePrint] -Category=8 -Description="Generate Cobol in SourcePrint (ON) / PrettyPrint(OFF) mode" -ValueDefault=0 -Enabled=false -EditorType=boolean -TrueFalse="-gen-src|-no-gen-src" - -[Copybook dir] -CallName="-gen-copy-dir=" -Category=8 -Description="Write copybooks to this directory" -EditorType=string -Enabled=false -ValueDefault="" - -[Indent size] -CallName="-gen-indent-step=" -Category=9 -Description="Indentation step" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=2 - -[Indent max] -CallName="-gen-max-indent=" -Category=9 -Description="Maximum starting position for indented text" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=40 - -[Tabs] -CallName="-gen-tabs=" -Category=9 -Description="Tabulation Positions" -EditorType=string -Enabled=false -ValueDefault="12,24,32,42,44,54" - -[Line format] -Category=9 -Description="Generated line format" -ValueDefault=1 -Enabled=false -EditorType=multiple -Choices="-gen-line-format=na|-gen-line-format=fixed|-gen-line-format=free|-gen-line-format=fsc-free|-gen-line-format=var" -ChoicesReadable="Na|Fixed|Free|FSC-free|Var" - -[Observe rules] -Category=9 -Description="Observe Area A/B rules in generated code" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-gen-observe-ab-rules |-no-gen-observe-ab-rules " - -[Preserve comments] -Category=10 -Description="Preserve comments" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-gen-print-comments |-no-gen-print-comments " - -[Enter Exit comments] -Category=10 -Description="Generate Enter/Exit comments around inlined copybooks" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-gen-enter-exit-copy-comments|-no-gen-enter-exit-copy-comments" - -[Preserve line IDs] -Category=11 -Description="Preserve original Line IDs (cols 1-6, 73-80)" -ValueDefault=1 -Enabled=true -EditorType=boolean -TrueFalse="-gen-line-id-comments|-no-gen-line-id-comments" - -[Put text 73-80] -CallName="-gen-73to80-fmt=" -Category=11 -Description="Put text of this format into columns 73 to 80" -EditorType=string -Enabled=false -ValueDefault="" - -[Start number 73-80] -CallName="-gen-73to80-start=" -Category=11 -Description="Start value for number put into columns 73 to 80" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=1 - -[Step number 73-80] -CallName="-gen-73to80-step=" -Category=11 -Description="Step for number put into columns 73 to 80" -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=1 -ValueDefault=1 - -[Convert comments] -CallName="-gen-mark-conv=" -Category=11 -Description="Add comment in columns 73 and up that show that line was changed or generated" -EditorType=string -Enabled=false -ValueDefault="" diff --git a/indenters/__TODO/uigui_astyle.ini b/indenters/__TODO/uigui_astyle.ini deleted file mode 100755 index 7d312b8..0000000 --- a/indenters/__TODO/uigui_astyle.ini +++ /dev/null @@ -1,321 +0,0 @@ -[header] -categories=Predefined Style|Tab and Bracket|Indentation|Padding|Formatting|Other -cfgFileParameterEnding=cr -configFilename=.astylerc -fileTypes=*.cpp|*.c|*.cu|*.h|*.hpp|*.inl|*.hh|*.cs|*.java -indenterFileName=astyle -indenterName=Artistic Style (C, C++, C#, JAVA) -inputFileName=indentinput -inputFileParameter= -manual=http://astyle.sourceforge.net/astyle.html -outputFileName=indentinput -outputFileParameter=none -parameterOrder=ipo -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter="--options=" -version=2.02.1 - -[predefined style] -Category=0 -Choices="-A1|-A2|-A3|-A4|-A5|-A6|-A7|-A8|-A9|-A10|-A11|-A12" -ChoicesReadable="Allman/Ansi/BSD/break style|Java/attach style|Kernighan & Ritchie style|Stroustrup style|Whitesmith style|Banner style|GNU style|Linux style|Horstmann style|One True Brace Style|Pico style|Lisp/Python style" -Description=Sets the general style. -EditorType=multiple -Enabled=false -ValueDefault=2 - -[indent spaces] -CallName="--indent=spaces=" -Category=1 -Description=Indent using # spaces per indent -EditorType=numeric -Enabled=false -MaxVal=20 -MinVal=2 -ValueDefault=4 - -[indent tab] -CallName="--indent=tab=" -Category=1 -Description=Indent using tab characters. Treat each tab as # spaces -EditorType=numeric -Enabled=false -MaxVal=20 -MinVal=2 -ValueDefault=4 - -[force indent tab] -CallName="--indent=force-tab=" -Category=1 -Description="Indent using tab characters. Treat each tab as # spaces. Uses tabs as indents where --indent=tab prefers to use spaces such as inside multi-line statements. " -EditorType=numeric -Enabled=false -MaxVal=20 -MinVal=2 -ValueDefault=4 - -[bracket style] -Category=1 -Choices="--brackets=break|--brackets=attach|--brackets=linux|--brackets=stroustrup|--brackets=horstmann" -ChoicesReadable=Break brackets|Attach brackets|Break brackets Linux like -Description=Sets the bracket style. -EditorType=multiple -Enabled=false -ValueDefault=0 - -[indent classes] -Category=2 -Description=Indent 'class' and 'struct' blocks so that the blocks 'public:', 'protected:' and 'private:' are indented. The struct blocks are indented only if an access modifier is declared somewhere in the struct. The entire block is indented. This option is effective for C++ files only. -EditorType=boolean -TrueFalse=--indent-classes| -ValueDefault=0 - -[indent switches] -Category=2 -Description=Indent 'switch' blocks so that the 'case X:' statements are indented in the switch block. The entire case block is indented. -EditorType=boolean -TrueFalse=--indent-switches| -ValueDefault=0 - -[indent cases] -Category=2 -Description=Indent 'case X:' blocks from the 'case X:' headers. Case statements not enclosed in blocks are NOT indented. -EditorType=boolean -TrueFalse=--indent-cases| -ValueDefault=0 - -[indent brackets] -Category=2 -Description=Add extra indentation to brackets. This is the option used for Whitesmith and Banner style formatting/indenting. If both ‑‑indent‑brackets and ‑‑indent‑blocks are used the result will be ‑‑indent‑blocks. This option will be ignored if used with a predefined style. -EditorType=boolean -TrueFalse=--indent-brackets| -ValueDefault=0 - -[indent blocks] -Category=2 -Description=Add extra indentation to blocks within a function. The opening bracket for namespaces, classes, and functions is not indented. This is the option used for GNU style formatting/indenting. This option will be ignored if used with a predefined style. -EditorType=boolean -TrueFalse=--indent-blocks| -ValueDefault=0 - -[indent namespaces] -Category=2 -Description=Add extra indentation to namespaces. -EditorType=boolean -TrueFalse=--indent-namespaces| -ValueDefault=0 - -[indent labels] -Category=2 -Description=Add extra indentation to labels so they appear 1 indent less than the current indentation, rather than being flushed to the left (the default). -EditorType=boolean -TrueFalse=--indent-labels| -ValueDefault=0 - -[indent preprocessor] -Category=2 -Description=Indent multi-line preprocessor definitions. Should be used with --convert-tabs for proper results. Does a pretty good job but can not perform miracles in obfuscated preprocessor definitions. Without this option the preprocessor statements remain unchanged. -EditorType=boolean -TrueFalse=--indent-preprocessor| -ValueDefault=0 - -[indent comments] -Category=2 -Description=Indent C++ comments beginning in column one. By default C++ comments beginning in column one are not indented. This option will allow the comments to be indented with the code. -EditorType=boolean -TrueFalse=--indent-col1-comments| -ValueDefault=0 - -[max-instatement-indent] -CallName="--max-instatement-indent=" -Category=2 -Description=Indent a maximum of # spaces in a continuous statement, relative to the previous line (e.g. ‑‑max‑instatement‑indent=40). # must be less than 80. If no # is set, the default value of 40 will be used. A maximum of less than two indent lengths will be ignored. -EditorType=numeric -Enabled=false -MaxVal=79 -MinVal=0 -ValueDefault=40 - -[min-conditional-indent] -CallName="--min-conditional-indent=" -Category=2 -Description=Set the minimal indent that is added when a header is built of multiple-lines. This indent makes helps to easily separate the header from the command statements that follow. The value for # must be less than 40. The default setting for this option is twice the current indent (e.g. --min-conditional-indent=8). -EditorType=numeric -Enabled=false -MaxVal=39 -MinVal=0 -ValueDefault=8 - -[break-blocks] -Category=3 -Description=Pad empty lines around header blocks (e.g. 'if' 'while'...). Be sure to read the Supplemental Documentation before using this option. -EditorType=boolean -TrueFalse=--break-blocks| -ValueDefault=0 - -[break-blocks-all] -Category=3 -Description=Pad empty lines around header blocks (e.g. 'if' 'while'...). Treat closing header blocks (e.g. 'else' 'catch') as stand-alone blocks. Be sure to read the Supplemental Documentation before using this option. -EditorType=boolean -TrueFalse="--break-blocks=all|" -ValueDefault=0 - -[pad-oper] -Category=3 -Description=Insert space padding around operators. Operators inside brackets [] are not padded. Note that there is no option to unpad. Once padded they stay padded. -EditorType=boolean -TrueFalse="--pad-oper|" -ValueDefault=0 - -[pad-paren] -Category=3 -Description=Insert space padding around parenthesis on both the outside and the inside. Any end of line comments will remain in the original column, if possible. -EditorType=boolean -TrueFalse="--pad-paren|" -ValueDefault=0 - -[pad-paren-out] -Category=3 -Description=Insert space padding around parenthesis on the outside only. Any end of line comments will remain in the original column, if possible. This can be used with unpad-paren below to remove unwanted spaces. -EditorType=boolean -TrueFalse="--pad-paren-out|" -ValueDefault=0 - -[pad-paren-in] -Category=3 -Description="Insert space padding around parenthesis on the inside only. Any end of line comments will remain in the original column, if possible. This can be used with unpad-paren below to remove unwanted spaces." -EditorType=boolean -TrueFalse="--pad-paren-in|" -ValueDefault=0 - -[pad-header] -Category=3 -Description=Insert space padding after paren headers only (e.g. 'if', 'for', 'while'...). Any end of line comments will remain in the original column, if possible. This can be used with unpad-paren to remove unwanted spaces. -EditorType=boolean -TrueFalse=--pad-header| -ValueDefault=0 - -[unpad-paren] -Category=3 -Description="Remove extra space padding around parenthesis on the inside and outside. Any end of line comments will remain in the original column, if possible. This option can be used in combination with the paren padding options pad‑paren, pad‑paren‑out, pad‑paren‑in, and pad‑header above. Only padding that has not been requested by other options will be removed." -EditorType=boolean -TrueFalse="--unpad-paren|" -ValueDefault=0 - -[delete-empty-lines] -Category=3 -Description=Delete empty lines within a function or method. Empty lines outside of functions or methods are NOT deleted. If used with break-blocks or break-blocks=all it will delete all lines EXCEPT the lines added by the break-blocks options. -EditorType=boolean -TrueFalse=--delete-empty-lines| -ValueDefault=0 - -[fill-empty-lines] -Category=3 -Description=Fill empty lines with the white space of the previous line -EditorType=boolean -TrueFalse=--fill-empty-lines| -ValueDefault=0 - -[brackets-break-closing] -Category=4 -Description=When used with --brackets=attach, --brackets=linux, or --brackets=stroustrup, this breaks closing headers (e.g. 'else', 'catch', ...) from their immediately preceding closing brackets. Closing header brackets are always broken with broken brackets, horstmann brackets, indented blocks, and indented brackets. -EditorType=boolean -TrueFalse="-y|" -ValueDefault=0 - -[break-elseifs] -Category=4 -Description=Break "else if" header combinations into separate lines. This option has no effect if keep-one-line-statements is used, the "else if" statements will remain as they are. If this option is NOT used, "else if" header combinations will be placed on a single line. -EditorType=boolean -TrueFalse=--break-elseifs| -ValueDefault=0 - -[add-brackets] -Category=4 -Description=Add brackets to unbracketed one line conditional statements (e.g. 'if', 'for', 'while'...). The statement must be on a single line. The brackets will be added according to the currently requested predefined style or bracket type. If no style or bracket type is requested the brackets will be attached. If --add-one-line-brackets is also used the result will be one line brackets. -EditorType=boolean -TrueFalse=--add-brackets| -ValueDefault=0 - -[add-one-line-brackets] -Category=4 -Description=Add one line brackets to unbracketed one line conditional statements (e.g. 'if', 'for', 'while'...). The statement must be on a single line. The option implies --keep-one-line-blocks and will not break the one line blocks. -EditorType=boolean -TrueFalse=--add-one-line-brackets| -ValueDefault=0 - -[one-line-keep-blocks] -Category=4 -Description=Don't break one-line blocks -EditorType=boolean -TrueFalse="--keep-one-line-blocks|" -ValueDefault=0 - -[one-line-keep-statements] -Category=4 -Description=Dont break complex statements and multiple statements residing on a single line. -EditorType=boolean -TrueFalse="--keep-one-line-statements|" -ValueDefault=0 - -[convert-tabs] -Category=4 -Description=Converts tabs into spaces in the non-indentation part of the line. The number of spaces inserted will maintain the spacing of the tab. The current setting for spaces per tab is used. It may not produce the expected results if convert-tabs is used when changing spaces per tab. Tabs are not replaced in quotes. -EditorType=boolean -TrueFalse=--convert-tabs| -ValueDefault=0 - -[align-pointer] -Category=4 -Choices="--align-pointer=type|--align-pointer=middle|--align-pointer=name" -Description=Attach a pointer or reference operator (* or &) to either the variable type (left) or variable name (right), or place it between the type and name. The spacing between the type and name will be preserved, if possible. This option is effective for C/C++ files only. -EditorType=multiple -Enabled=false -ValueDefault=0 - -[align-reference] -Category=4 -Choices="--align-reference=type|--align-reference=middle|--align-reference=name" -Description=This option will align references separate from pointers. Pointers are not changed by this option. If pointers and references are to be aligned the same, use the previous align-pointer option. The option align-reference=none will not change the reference alignment. The other options are the same as for align-pointer. In the case of a reference to a pointer (*&) with conflicting alignments, the align-pointer value will be used. -EditorType=multiple -Enabled=false -ValueDefault=0 - -[override-language] -Category=4 -Choices="--mode=c|--mode=java|--mode=cs" -Description=Indent a C or C++ or Java or CSharp file. The option is set from the file extension for each file. You can override the setting with this entry. It allows the formatter to identify language specific syntax such as C classes and C templates. -EditorType=multiple -Enabled=false -ValueDefault=0 - -[nosuffix] -Category=5 -Description=Do not retain a backup of the original file. The original file is purged after it is formatted. -EditorType=boolean -TrueFalse=--suffix=none| -ValueDefault=0 - -[errors-to-stdout] -Category=5 -Description=Print errors to standard-output rather than to standard-error. -This option should be helpful for systems/shells that do not have this option, such as in Windows95. -EditorType=boolean -TrueFalse=--errors-to-stdout| -ValueDefault=0 - -[preserve-date] -Category=5 -Description=Preserve the original file's date and time modified. The date and time modified will not be changed in the formatted file. This option is not effective if redirection is used to rename the input file. -EditorType=boolean -TrueFalse=--preserve-date| -ValueDefault=0 - -[lineend] -Category=5 -Choices="--lineend=windows|--lineend=linux|--lineend=macold" -Description=orce use of the specified line end style. Valid options are windows (CRLF), linux (LF), and macold (CR). MacOld style is the format for OS 9 and earlier. Mac OS X uses the Linux style. If one of these options is not used the line ends will be determined automatically from the input file. -EditorType=multiple -Enabled=false -ValueDefault=0 diff --git a/indenters/__TODO/uigui_bcpp.ini b/indenters/__TODO/uigui_bcpp.ini deleted file mode 100755 index c094f97..0000000 --- a/indenters/__TODO/uigui_bcpp.ini +++ /dev/null @@ -1,144 +0,0 @@ -[header] -categories=Indentation|Comments|General -cfgFileParameterEnding=cr -configFilename=bcpp.cfg -fileTypes=*.cpp|*.c|*.h|*.hpp -indenterFileName=bcpp -indenterName=BCPP (C, C++) -inputFileName=indentinput -inputFileParameter="-fi " -manual=http://universalindent.sf.net/indentermanuals/bcpp.txt -outputFileName=indentoutput -outputFileParameter="-fo " -parameterOrder=ipo -showHelpParameter=qxyz -stringparaminquotes=false -useCfgFileParameter="-fnc " -version=2009-06-30 - -[Ascii_Chars_Only] -Category=2 -Description=Setting this parameter to yes will strip any non-printable non-ASCII characters from the input file. Any non-printable characters that lie within quotes will be transformed into octal/character notation if NonAscii_Quotes_To_Octal is set to True. Comment out this parameter if you are using Leave_Graphic_Chars parameter as this parameter will override it. -EditorType=boolean -TrueFalse="ascii_chars_only=yes|ascii_chars_only=no" -ValueDefault=1 - -[Backup_File] -Category=2 -Description=This option will backup the input file to a file with the extension .bac and overwrite the input file with the reformatted version. -EditorType=boolean -TrueFalse="backup_file=yes|backup_file=no" -ValueDefault=0 - -[Comments_With_Code] -CallName="comments_with_code=" -Category=1 -Description=Defines the column in which comments that appear after code on a line will be placed. -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=50 - -[Comments_With_Nocode] -CallName="comments_with_nocode=" -Category=1 -Description=Defines the column in which comments that appear in a line will be placed. -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=0 - -[Function_Spacing] -CallName="function_spacing=" -Category=0 -Description=This parameter specifies how many lines separate two functions. -EditorType=numeric -Enabled=false -MaxVal=99 -MinVal=0 -ValueDefault=2 - -[Indent_Exec_Sql] -Category=0 -Description=If true bcpp looks for embedded SQL statements (e.g. EXEC SQL) and formats them specially. -EditorType=boolean -TrueFalse="indent_exec_sql=yes|indent_exec_sql=no" -ValueDefault=0 - -[Indent_Preprocessor] -Category=0 -Description=If true bcpp will indent preprocessor lines to the indention of the C(++) code. If false preprocessor lines will be in the first column. Unrecognized (i.e. nonstandard) preprocessor lines are always put into the first column. -EditorType=boolean -TrueFalse="indent_preprocessor=yes|indent_preprocessor=no" -ValueDefault=0 - -[Indent_Spacing] -CallName="indent_spacing=" -Category=0 -Description=Specifies how many spaces to indent. This parameter also sets the width of tabs. Bcpp considers the width of a tab to be the same as the width of an indent. -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=4 - -[Keep_Comments_With_Code] -Category=1 -Description=This option overrides the "Comments_With_Code" option. Setting this option On will make comments which do not fit as inline comments append to the code anyway. -EditorType=boolean -TrueFalse="keep_comments_with_code=yes|keep_comments_with_code=no" -ValueDefault=0 - -[Leave_Comments_NoCode] -Category=1 -Description=This options overrides the Comments_With_Nocodeoption. Setting this option On will indent comments that do not occur on the same line as code to the same indention as code. -EditorType=boolean -TrueFalse="leave_comments_nocode=yes|leave_comments_nocode=no" -ValueDefault=0 - -[Leave_Graphic_Chars] -Category=2 -Description=Setting this parameter to yes will strip non-printable characters from the source file but leave any characters that are IBM graphics alone. Any non-printable characters that lie within quotes will be transformed into octal/character notation if NonAscii_Quotes_To_Octal parameter is set to True. -EditorType=boolean -TrueFalse="leave_graphic_chars=yes|leave_graphic_chars=no" -ValueDefault=1 - -[NonAscii_Quotes_To_Octal] -Category=2 -Description=se this option to change non-ASCII (non-printable) chars to octal notation if they lie within quotes. This parameter doesn't take effect unless either the Ascii_Chars_Only or Leave_Graphic_Chars parameters have been set. -EditorType=boolean -TrueFalse="nonascii_quotes_to_octal=yes|nonascii_quotes_to_octal=no" -ValueDefault=0 - -[Place_Brace_On_New_Line] -Category=0 -Description=When set to 'on' bcpp will place opening braces on new lines (Pascalstyle C coding) when set to 'off' bcpp will use K&Rstyle C coding. -EditorType=boolean -TrueFalse="place_brace_on_new_line=yes|place_brace_on_new_line=no" -ValueDefault=1 - -[Program_Output] -Category=2 -Description=This parameter will stop output from the program corrupting output that may exit from the program via the standard output. If this parameter is set to off/no then no output is generated from the program unless an error is encountered. The standard error is used to display any errors encountered while processing. -EditorType=boolean -TrueFalse="program_output=yes|program_output=no" -ValueDefault=0 - -[Queue_Buffer] -CallName="queue_buffer=" -Category=2 -Description=Specifies what the internal memory requires will be in size of the line processing buffer. This is used for open brace relocation in Kernighan/Ritchie style. Extending this buffer to large amounts of memory will slow processing on small machines. -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=2 - -[Use_Tabs] -Category=0 -Description=Specifies whether to use tabs in indenting code. -EditorType=boolean -TrueFalse="use_tabs=yes|use_tabs=no" -ValueDefault=0 diff --git a/indenters/__TODO/uigui_csstidy.ini b/indenters/__TODO/uigui_csstidy.ini deleted file mode 100755 index 2cca15a..0000000 --- a/indenters/__TODO/uigui_csstidy.ini +++ /dev/null @@ -1,119 +0,0 @@ -[header] -categories=General -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.css -indenterFileName=csstidy -indenterName=CSSTidy (CSS) -inputFileName=indentinput -inputFileParameter= -manual=http://csstidy.sourceforge.net/usage.php -outputFileName=indentoutput -outputFileParameter= -parameterOrder=ipo -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version=1.3 - -[Add Timestamp] -Category=0 -Description=Add Timestamp. -EditorType=boolean -TrueFalse="--timestamp=true|--timestamp=false" -ValueDefault=0 - -[Allow HTML in templates] -Category=0 -Description=Allow HTML in templates. -EditorType=boolean -TrueFalse="--allow_html_in_templates=true|--allow_html_in_templates=false" -ValueDefault=1 - -[Case for properties] -Category=0 -Choices="--case_properties=0|--case_properties=1|--case_properties=2" -Description=
  0 - None.
  1 - Lowercase.
  2 - Uppercase.
-EditorType=multiple -Enabled=false -ValueDefault=1 - -[Compress colors] -Category=0 -Description=Compress colors. -EditorType=boolean -TrueFalse="--compress_colors=true|--compress_colors=false" -ValueDefault=1 - -[Compress font-weight] -Category=0 -Description=Compress font weight. -EditorType=boolean -TrueFalse="--compress_font=true|--compress_font=false" -ValueDefault=1 - -[Lowercase selectors] -Category=0 -Description=Lowercase selectors names needed for XHTML. -EditorType=boolean -TrueFalse="--lowercase_s=true|--lowercase_s=false" -ValueDefault=0 - -[Optimise shorthands] -Category=0 -Choices="--optimise_shorthands=0|--optimise_shorthands=1|--optimise_shorthands=2" -Description=
  0 - Do not optimise.
  1 - Safe optimisations.
  2 - All optimisations.
-EditorType=multiple -Enabled=false -ValueDefault=1 - -[Preserve CSS] -Category=0 -Description="Save comments, hacks, etc.
Most optimisations can NOT be applied if this is enabled." -EditorType=boolean -TrueFalse="--preserve_css=true|--preserve_css=false" -ValueDefault=0 - -[Regroup selectors] -Category=0 -Choices="--merge_selectors=0|--merge_selectors=1|--merge_selectors=2" -Description="
  0 - Do not change anything
  1 - Only seperate selectors (split at , )
  2 - Merge selectors with the same properties (fast)
" -EditorType=multiple -Enabled=false -ValueDefault=2 - -[Remove last semikolon] -Category=0 -Description="Remove last ;" -EditorType=boolean -TrueFalse="--remove_last_;=true|--remove_last_;=false" -ValueDefault=0 - -[Remove unnecessary backslashes] -Category=0 -Description=Remove backslashes. -EditorType=boolean -TrueFalse="--remove_bslash=true|--remove_bslash=false" -ValueDefault=1 - -[Sort properties] -Category=0 -Description=Sort properties. -EditorType=boolean -TrueFalse="--sort_properties=true|--sort_properties=false" -ValueDefault=0 - -[Sort selectors %28caution%29] -Category=0 -Description=Attention: This may change the behavior of your CSS code! -EditorType=boolean -TrueFalse="--sort_selectors=true|--sort_selectors=false" -ValueDefault=0 - -[Template] -Category=0 -Choices="--template=highest|--template=high|--template=default|--template=low" -Description="
  Highest - No readability, smallest size.
  High - Moderate readability, smaller size.
  Default - balance between readability and size.
  Low - Higher readability.
" -EditorType=multiple -Enabled=false -ValueDefault=2 diff --git a/indenters/__TODO/uigui_f90ppr.ini b/indenters/__TODO/uigui_f90ppr.ini deleted file mode 100755 index 9d3dc3c..0000000 --- a/indenters/__TODO/uigui_f90ppr.ini +++ /dev/null @@ -1,17 +0,0 @@ -[header] -categories= -cfgFileParameterEnding= -configFilename= -fileTypes=*.f90 -indenterFileName=f90ppr.exe -indenterName=Fortran 90 PPR (Fortran) -inputFileName=indentinput -inputFileParameter="< " -manual=ftp://ftp.ifremer.fr/ifremer/fortran90 -outputFileName= -outputFileParameter=stdout -parameterOrder=pio -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version=1.3 diff --git a/indenters/__TODO/uigui_gnuindent.ini b/indenters/__TODO/uigui_gnuindent.ini deleted file mode 100755 index 53ac520..0000000 --- a/indenters/__TODO/uigui_gnuindent.ini +++ /dev/null @@ -1,527 +0,0 @@ -[header] -categories=General|Blank lines|Comments|Statements|Declarations|Indentation|Breaking long lines -cfgFileParameterEnding=cr -configFilename=.indent.pro -fileTypes=*.c|*.h -indenterFileName=indent -indenterName=GNU Indent (C) -inputFileName=indentinput -inputFileParameter= -manual=http://universalindent.sf.net/indentermanuals/indent.html -outputFileName=indentoutput -outputFileParameter="-o " -parameterOrder=ipo -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter=none -version=2.2.9 - -[ANSI style formatting] -Category=0 -Description=original Berkeley indent -EditorType=boolean -TrueFalse=-orig| -ValueDefault=0 - -[GNU style formatting] -Category=0 -Description=GNU style formatting/indenting. -EditorType=boolean -TrueFalse=-gnu| -ValueDefault=0 - -[KR style formatting] -Category=0 -Description=Kernighan&Ritchie style formatting/indenting. -EditorType=boolean -TrueFalse=-kr| -ValueDefault=0 - -[blank-before-sizeof] -Category=3 -Description=Put a space between sizeof and its argument. -EditorType=boolean -TrueFalse=-bs| -ValueDefault=0 - -[blank-lines-after-commas] -Category=4 -Description=Force newline after comma in declaration. -EditorType=boolean -TrueFalse=-bc| -ValueDefault=0 - -[blank-lines-after-declarations] -Category=1 -Description=The -bad option forces a blank line after every block of declarations. -EditorType=boolean -TrueFalse=-bad| -ValueDefault=0 - -[blank-lines-after-procedures] -Category=1 -Description=The -bap option forces a blank line after every procedure body. -EditorType=boolean -TrueFalse=-bap| -ValueDefault=0 - -[blank-lines-before-block-comments] -Category=1 -Description=Force blank lines before block comments. -EditorType=boolean -TrueFalse=-bbb| -ValueDefault=0 - -[brace-indentn] -CallName=-bli -Category=3 -Description=Indent braces n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=3 - -[braces-after-if-line] -Category=3 -Description="Put braces on line after if, etc." -EditorType=boolean -TrueFalse=-bl| -ValueDefault=0 - -[braces-after-struct-decl-line] -Category=4 -Description=Put braces on the line after struct declaration lines. -EditorType=boolean -TrueFalse=-bls| -ValueDefault=0 - -[braces-on-if-line] -Category=3 -Description="Put braces on line with if, etc." -EditorType=boolean -TrueFalse=-br| -ValueDefault=0 - -[braces-on-struct-decl-line] -Category=4 -Description=Put braces on struct declaration line. -EditorType=boolean -TrueFalse=-brs| -ValueDefault=0 - -[break-after-boolean-operator] -Category=6 -Description=Do not prefer to break long lines before boolean operators. -EditorType=boolean -TrueFalse=-nbbo| -ValueDefault=0 - -[break-before-boolean-operator] -Category=6 -Description=Prefer to break long lines before boolean operators. -EditorType=boolean -TrueFalse=-bbo| -ValueDefault=0 - -[break-function-decl-args] -Category=4 -Description=Break the line after the last argument in a declaration. -EditorType=boolean -TrueFalse=-bfde| -ValueDefault=0 - -[case-brace-indentationn] -CallName=-cbi -Category=3 -Description=Indent braces after a case label N spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[case-indentationn] -CallName=-cli -Category=3 -Description=Case label indent of n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[comment-delimiters-on-blank-lines] -Category=2 -Description=Put comment delimiters on blank lines. -EditorType=boolean -TrueFalse=-cdb| -ValueDefault=0 - -[comment-indentationn] -CallName=-c -Category=2 -Description=Put comments to the right of code in column n. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=33 - -[comment-line-lengthn] -CallName=-lc -Category=2 -Description=Set maximum line length for comment formatting to n. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=1 -ValueDefault=78 - -[continuation-indentationn] -CallName=-ci -Category=3 -Description=Continuation indent of n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[continue-at-parentheses] -Category=5 -Description=Line up continued lines at parentheses. -EditorType=boolean -TrueFalse=-lp| -ValueDefault=0 - -[cuddle-do-while] -Category=2 -Description="Cuddle while of do {} while; and preceeding `}'." -EditorType=boolean -TrueFalse=-cdw| -ValueDefault=0 - -[cuddle-else] -Category=2 -Description=Cuddle else and preceeding `}'. -EditorType=boolean -TrueFalse=-ce| -ValueDefault=0 - -[declaration-comment-columnn] -CallName=-cd -Category=2 -Description=Put comments to the right of the declarations in column n. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=33 - -[declaration-indentationn] -CallName=-di -Category=4 -Description=Put variables in column n. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[dont-break-function-decl-args] -Category=4 -Description=Don't put each argument in a function declaration on a seperate line. -EditorType=boolean -TrueFalse=-nbfda| -ValueDefault=0 - -[dont-break-procedure-type] -Category=4 -Description=Put the type of a procedure on the same line as its name. -EditorType=boolean -TrueFalse=-npsl| -ValueDefault=0 - -[dont-cuddle-do-while] -Category=3 -Description="Do not cuddle } and the while of a do {} while;." -EditorType=boolean -TrueFalse=-ncdw| -ValueDefault=0 - -[dont-cuddle-else] -Category=3 -Description=Do not cuddle } and else. -EditorType=boolean -TrueFalse=-nce| -ValueDefault=0 - -[dont-line-up-parentheses] -Category=3 -Description=Do not line up parentheses. -EditorType=boolean -TrueFalse=-nlp| -ValueDefault=0 - -[dont-space-special-semicolon] -Category=3 -Description=Do not force a space before the semicolon after certain statements. Disables `-ss'. -EditorType=boolean -TrueFalse=-nss| -ValueDefault=0 - -[else-endif-columnn] -CallName=-cp -Category=2 -Description=Put comments to the right of #else and #endif statements in column n. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=33 - -[format-all-comments] -Category=2 -Description=Do not disable all formatting of comments. -EditorType=boolean -TrueFalse=-fca| -ValueDefault=0 - -[format-first-column-comments] -Category=2 -Description=Format comments in the first column. -EditorType=boolean -TrueFalse=-fc1| -ValueDefault=0 - -[honour-newlines] -Category=6 -Description=Prefer to break long lines at the position of newlines in the input. -EditorType=boolean -TrueFalse=-hnl| -ValueDefault=0 - -[ignore-newlines] -Category=6 -Description=Do not prefer to break long lines at the position of newlines in the input. -EditorType=boolean -TrueFalse=-nhnl| -ValueDefault=0 - -[indent-leveln] -CallName=-i -Category=5 -Description=Set indentation level to n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[leave-preprocessor-space] -Category=5 -Description=Leave space between `#' and preprocessor directive. -EditorType=boolean -TrueFalse=-lps| -ValueDefault=0 - -[line-comments-indentationn] -CallName=-d -Category=2 -Description=Set indentation of comments not to the right of code to n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=33 - -[line-lengthn] -CallName=-l -Category=6 -Description=Set maximum line length for non-comment lines to n. -EditorType=numeric -Enabled=false -MaxVal=220 -MinVal=1 -ValueDefault=120 - -[no-blank-lines-after-commas] -Category=4 -Description=Do not force newlines after commas in declarations. -EditorType=boolean -TrueFalse=-nbc| -ValueDefault=0 - -[no-parameter-indentation] -Category=5 -Description=Zero width indentation for parameters. -EditorType=boolean -TrueFalse=-nip| -ValueDefault=0 - -[no-space-after-casts] -Category=3 -Description=Do not put a space after cast operators. -EditorType=boolean -TrueFalse=-ncs| -ValueDefault=0 - -[no-space-after-for] -Category=3 -Description=Do not put a space after every for. -EditorType=boolean -TrueFalse=-nsaf| -ValueDefault=0 - -[no-space-after-function-call-names] -Category=3 -Description=Do not put space after the function in function calls. -EditorType=boolean -TrueFalse=-npcs| -ValueDefault=0 - -[no-space-after-if] -Category=3 -Description=Do not put a space after every if. -EditorType=boolean -TrueFalse=-nsai| -ValueDefault=0 - -[no-space-after-parentheses] -Category=3 -Description=Do not put a space after every '(' and before every ')'. -EditorType=boolean -TrueFalse=-nprs| -ValueDefault=0 - -[no-space-after-while] -Category=3 -Description=Do not put a space after every while. -EditorType=boolean -TrueFalse=-nsaw| -ValueDefault=0 - -[no-tabs] -Category=5 -Description=Use spaces instead of tabs. -EditorType=boolean -TrueFalse=-nut| -ValueDefault=1 - -[parameter-indentationn] -CallName=-ip -Category=5 -Description=Indent parameter types in old-style function definitions by n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[paren-indentationn] -CallName=-pi -Category=3 -Description=Specify the extra indentation per open parentheses '(' when a statement is broken. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[procnames-start-lines] -Category=4 -Description=Put the type of a procedure on the line before its name. -EditorType=boolean -TrueFalse=-psl| -ValueDefault=0 - -[space-after-cast] -Category=3 -Description=Put a space after a cast operator. -EditorType=boolean -TrueFalse=-cs| -ValueDefault=0 - -[space-after-for] -Category=3 -Description=Put a space after each for. -EditorType=boolean -TrueFalse=-saf| -ValueDefault=0 - -[space-after-if] -Category=3 -Description=Put a space after each if. -EditorType=boolean -TrueFalse=-sai| -ValueDefault=0 - -[space-after-parentheses] -Category=3 -Description=Put a space after every '(' and before every ')'. -EditorType=boolean -TrueFalse=-prs| -ValueDefault=0 - -[space-after-procedure-calls] -Category=3 -Description=Insert a space between the name of the procedure being called and the `('. -EditorType=boolean -TrueFalse=-pcs| -ValueDefault=0 - -[space-after-while] -Category=3 -Description=Put a space after each while. -EditorType=boolean -TrueFalse=-saw| -ValueDefault=0 - -[space-special-semicolon] -Category=3 -Description="On one-line for and while statements, force a blank before the semicolon." -EditorType=boolean -TrueFalse=-ss| -ValueDefault=0 - -[start-left-side-of-comments] -Category=2 -Description=Put the `*' character at the left of comments. -EditorType=boolean -TrueFalse=-sc| -ValueDefault=0 - -[struct-brace-indentationn] -CallName=-sbi -Category=3 -Description="Indent braces of a struct, union or enum N spaces." -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[swallow-optional-blank-lines] -Category=1 -Description=The -sob option causes indent to swallow optional blank lines. -EditorType=boolean -TrueFalse=-sob| -ValueDefault=0 - -[tab-sizen] -CallName=-ts -Category=5 -Description=Set tab size to n spaces. -EditorType=numeric -Enabled=false -MaxVal=120 -MinVal=0 -ValueDefault=4 - -[use-tabs] -Category=5 -Description=Use tabs. -EditorType=boolean -TrueFalse=-ut| -ValueDefault=0 diff --git a/indenters/__TODO/uigui_greatcode.ini b/indenters/__TODO/uigui_greatcode.ini deleted file mode 100755 index 24c7a58..0000000 --- a/indenters/__TODO/uigui_greatcode.ini +++ /dev/null @@ -1,1363 +0,0 @@ -[header] -categories=General|Space|Code|Statements|Pre-Processor|Comments|Miscellaneous -cfgFileParameterEnding=cr -configFilename=gc.cfg -fileTypes=*.cpp|*.c|*.h|*.hpp -indenterFileName=greatcode -indenterName=GreatCode (C, C++) -inputFileName=indentinput -inputFileParameter=-file- -manual=http://universalindent.sf.net/indentermanuals/gc.txt -outputFileName=indentinput -outputFileParameter=none -parameterOrder=ipo -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter=none -version=1.140 - -[overwrite_read_only] -Category=0 -Description=Process read only files (change status) -EditorType=boolean -TrueFalse=-overwrite_read_only-|-no-overwrite_read_only- -ValueDefault=0 - -[tab_size] -CallName=-tab_size- -Category=0 -Description="Set the level (number of blanks) of an indentation level.
Example :
        -tab_size-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
            a++
        }

        -tab_size-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
          a++
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=1 -ValueDefault=4 - -[tab_out] -Category=0 -Description=Output tab characters instead of spaces -EditorType=boolean -TrueFalse=-tab_out-|-no-tab_out- -ValueDefault=1 - -[eol_unix] -Category=0 -Description=Unix format for carriage returns -EditorType=boolean -TrueFalse=-eol_unix-|-no-eol_unix- -ValueDefault=0 - -[space_if] -Category=1 -Description="Output a blank character after if. while. for and switch keywords.
Example :
        -space_if-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if (a)
        {
            while (a--)
            {
            }
        }

        -no-space_if-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
            while(a--)
            {
            }
        }
" -EditorType=boolean -TrueFalse=-space_if-|-no-space_if- -ValueDefault=0 - -[space_return] -Category=1 -Description="Output a blank character after return if return is followed by an open
parenthesis.
Example :
        -space_return-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        return (6)

        -no-space_return-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        return(6)
" -EditorType=boolean -TrueFalse=-space_return-|-no-space_return- -ValueDefault=0 - -[space_fctcall] -Category=1 -Description="Output a blank character before the open parenthese of a function call.
Example :
        -space_fctcall-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call (out)
        loop (100)

        -no-space_fctcall-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100)
" -EditorType=boolean -TrueFalse=-space_fctcall-|-no-space_fctcall- -ValueDefault=0 - -[space_fctcall_firstparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctcall_firstparam-|-no-space_fctcall_firstparam- -ValueDefault=0 - -[space_fctcall_inparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctcall_inparam-|-no-space_fctcall_inparam- -ValueDefault=1 - -[space_fctcall_lastparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctcall_lastparam-|-no-space_fctcall_lastparam- -ValueDefault=0 - -[space_fctdef_firstparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctdef_firstparam-|-no-space_fctdef_firstparam- -ValueDefault=0 - -[space_fctdef_lastparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctdef_lastparam-|-no-space_fctdef_lastparam- -ValueDefault=0 - -[space_fctdecl_firstparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctdecl_firstparam-|-no-space_fctdecl_firstparam- -ValueDefault=0 - -[space_fctdecl_lastparam] -Category=1 -Description="Output a blank character before the first/last/inside parameter of a function
\t\tcall. definition or declaration.
Example :
        -space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1. 2. 3. 4)

        -no-space_fctcall_inparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(1.2.3.4)

        -space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call( out)
        loop( 100. 200)

        -no-space_fctcall_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        main_call(out)
        loop(100. 200)

        -space_fctdef_firstparam-
        -space_fctdef_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out )
        {
        }

        -space_fctdecl_firstparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call( int out. int in)

        -space_fctdecl_lastparam-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main_call(int out. int in )
" -EditorType=boolean -TrueFalse=-space_fctdecl_lastparam-|-no-space_fctdecl_lastparam- -ValueDefault=0 - -[space_fctdecl] -Category=1 -Description="Output a blank character before the open parenthese of a function
definition / declaration.
Example :
        -space_fctdecl-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        extern func (a)

        -space_fctdef-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int func (a)
        {
        }

        -no-space_fctdef-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int func(a)
        {
        }
" -EditorType=boolean -TrueFalse=-space_fctdecl-|-no-space_fctdecl- -ValueDefault=0 - -[space_fctdef] -Category=1 -Description="Output a blank character before the open parenthese of a function
definition / declaration.
Example :
        -space_fctdecl-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        extern func (a)

        -space_fctdef-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int func (a)
        {
        }

        -no-space_fctdef-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int func(a)
        {
        }
" -EditorType=boolean -TrueFalse=-space_fctdef-|-no-space_fctdef- -ValueDefault=0 - -[space_paren] -CallName=-space_paren- -Category=1 -Description="Add spaces after '(' and before ')' if the nested level of the
parenthese is lower than the argument.
Example :
        -space_paren-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if((a < 5) && (b > 2))
        {
        }

        -space_paren-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if( (a < 5) && (b > 2) )
        {
        }

        -space_paren-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if( ( a < 5 ) && ( b > 2 ) )
        {
        }

        See option(s) :
        [-no]-space_cast-

        Note(s) :
        - Empty expressions () are not modified.
        - Casts are not modified.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[space_cast] -Category=1 -Description="Add spaces after '(' and before ')' for cast operators.
Example :
        -space_cast-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(( int * ) b)
        {
        }

        return ( int * ) b

        -no-space_cast-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if((int *) b)
        {
        }

        return (int *) b

        See option(s) :
        -space_paren-
" -EditorType=boolean -TrueFalse=-space_cast-|-no-space_cast- -ValueDefault=0 - -[space_cast_after] -Category=1 -Description="Add a space after a cast expression.
Example :
        -space_cast_after-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if((int *) b)
        {
        }

        return ( int * ) b

        -no-space_cast_after-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if((int *)b)
        {
        }

        return (int *)b

        See option(s) :
        [-no]-space_cast-
" -EditorType=boolean -TrueFalse=-space_cast_after-|-no-space_cast_after- -ValueDefault=1 - -[space_scope_def] -Category=1 -Description="Add a space before and after the scope resolution operator '::' in the
function definition.
Example :
        -space_scope_def-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void func :: Ping(void)
        {
        }

        -no-space_scope_def-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void func::Ping(void)
        {
        }

        See option(s) :
        [-no]-space_scope_access-
" -EditorType=boolean -TrueFalse=-space_scope_def-|-no-space_scope_def- -ValueDefault=0 - -[space_scope_access] -Category=1 -Description="Add a space before and after the scope resolution operator '::' when
accessing a static method.
Example :
        -space_scope_access-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void func::Ping(void)
        {
            Base :: Ping()
            Base :: Pong()
        }

        -no-space_scope_access-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void func::Ping(void)
        {
            Base::Ping()
            Base::Pong()
        }

        See option(s) :
        [-no]-space_scope_def-
" -EditorType=boolean -TrueFalse=-space_scope_access-|-no-space_scope_access- -ValueDefault=0 - -[space_affect_style] -CallName=-space_affect_style- -Category=1 -Description="Set the indent style for affect and auto-affectoperators.
Example :
        -space_affect_style-0
        -space_autoaffect_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a = b = c      <== Affect
        a *= 6         <== Auto-Affect

        -space_affect_style-1
        -space_autoaffect_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a= b= c
        a*= 6

        -space_affect_style-2
        -space_autoaffect_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a=b=c
        a*=6
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[space_autoaffect_style] -CallName=-space_autoaffect_style- -Category=1 -Description="Set the indent style for affect and auto-affectoperators.
Example :
        -space_affect_style-0
        -space_autoaffect_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a = b = c      <== Affect
        a *= 6         <== Auto-Affect

        -space_affect_style-1
        -space_autoaffect_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a= b= c
        a*= 6

        -space_affect_style-2
        -space_autoaffect_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        a=b=c
        a*=6
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[code_len] -CallName=-code_len- -Category=2 -Description=Maximum length of a line of code -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=8 -ValueDefault=120 - -[code_keep_empty_lines] -Category=2 -Description=Keep empty lines in original file -EditorType=boolean -TrueFalse=-code_keep_empty_lines-|-no-code_keep_empty_lines- -ValueDefault=1 - -[code_keep_more_empty_lines] -Category=2 -Description=Make more effort to preserve empty lines in the original file - even in the face of other reformatting -EditorType=boolean -TrueFalse=-code_keep_more_empty_lines-|-no-code_keep_more_empty_lines- -ValueDefault=0 - -[code_remove_empty_lines] -CallName=-code_remove_empty_lines- -Category=2 -Description="Remove all excedent empty lines. If num is 1. then only one single
blank line is authorized.
Example :
        -code_remove_empty_lines-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a
        
        
        int a

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a
        
        int a
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=1 -ValueDefault=2 - -[code_split_bool_before] -Category=2 -Description="Determine the aspect of boolean expressions when they must be split
because they are too long.
Example :
        -code_split_bool_before-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if
        (
            (A + main(func) + 6 > 60)
        &&  (B - 50 > 10)
        ||  var
        )
        {
        }

        -no-code_split_bool_before-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if
        (
            (A + main(func) + 6 > 60) &&
            (B - 50 > 10) ||
            var
        )
        {
        }
" -EditorType=boolean -TrueFalse=-code_split_bool_before-|-no-code_split_bool_before- -ValueDefault=1 - -[code_split_fctcall_style] -CallName=-code_split_fctcall_style- -Category=2 -Description="Set the style when GC must break a function call/def/decl. a for
statement or an if statement if the line is too long.
The resulting style is the same for all options.
Example :
        -code_split_fctcall_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function
        (
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
        )

        -code_split_fctcall_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter. parameter. parameter.
                 parameter. parameter. parameter.
                 parameter)

        -code_split_fctcall_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter)

        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter)
        {
        }

        -code_split_fctdef_style-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter)
        {
        }

        -code_split_fctdef_style-5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter. parameter. parameter. parameter.
            parameter. parameter. parameter)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[code_split_fctdef_style] -CallName=-code_split_fctdef_style- -Category=2 -Description="Set the style when GC must break a function call/def/decl. a for
statement or an if statement if the line is too long.
The resulting style is the same for all options.
Example :
        -code_split_fctcall_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function
        (
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
        )

        -code_split_fctcall_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter. parameter. parameter.
                 parameter. parameter. parameter.
                 parameter)

        -code_split_fctcall_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter)

        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter)
        {
        }

        -code_split_fctdef_style-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter)
        {
        }

        -code_split_fctdef_style-5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter. parameter. parameter. parameter.
            parameter. parameter. parameter)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[code_split_fctdecl_style] -CallName=-code_split_fctdecl_style- -Category=2 -Description="Set the style when GC must break a function call/def/decl. a for
statement or an if statement if the line is too long.
The resulting style is the same for all options.
Example :
        -code_split_fctcall_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function
        (
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
        )

        -code_split_fctcall_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter. parameter. parameter.
                 parameter. parameter. parameter.
                 parameter)

        -code_split_fctcall_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter)

        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter)
        {
        }

        -code_split_fctdef_style-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter)
        {
        }

        -code_split_fctdef_style-5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter. parameter. parameter. parameter.
            parameter. parameter. parameter)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[code_split_for_style] -CallName=-code_split_for_style- -Category=2 -Description="Set the style when GC must break a function call/def/decl. a for
statement or an if statement if the line is too long.
The resulting style is the same for all options.
Example :
        -code_split_fctcall_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function
        (
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
        )

        -code_split_fctcall_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter. parameter. parameter.
                 parameter. parameter. parameter.
                 parameter)

        -code_split_fctcall_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter)

        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter)
        {
        }

        -code_split_fctdef_style-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter)
        {
        }

        -code_split_fctdef_style-5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter. parameter. parameter. parameter.
            parameter. parameter. parameter)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[code_split_if_style] -CallName=-code_split_if_style- -Category=2 -Description="Set the style when GC must break a function call/def/decl. a for
statement or an if statement if the line is too long.
The resulting style is the same for all options.
Example :
        -code_split_fctcall_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function
        (
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
        )

        -code_split_fctcall_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter. parameter. parameter.
                 parameter. parameter. parameter.
                 parameter)

        -code_split_fctcall_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        function(parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter.
                 parameter)

        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter.
            parameter)
        {
        }

        -code_split_fctdef_style-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter.
        parameter)
        {
        }

        -code_split_fctdef_style-5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void function(
            parameter. parameter. parameter. parameter.
            parameter. parameter. parameter)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[code_split_decl_style] -CallName=-code_split_decl_style- -Category=2 -Description="Set style of indentation for declaration of variables.
Example :
        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a. b. c = 10
\t\tint d

        -code_split_decl_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a.
            b.
            c = 10
\t\tint d

        -code_split_decl_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a
        int b
        int c = 10
\t\tint d
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[code_constructor_style] -CallName=-code_constructor_style- -Category=2 -Description="Set style of indentation for constructors.
Example :
        -code_constructor_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        cons::cons(void) :
            set(0).
            reset(0)
        {
        }

        -code_constructor_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        cons::cons(void) : set(0). reset(0)
        {
        }

        -code_constructor_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        cons::cons(void) :
        set(0).
        reset(0)
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[code_decl_move_affect] -Category=2 -Description="Move initialization in local variables declaration just after the
declaration.
Example :
        -code_decl_move_affect-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a = 0
            int     c = a + 1
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a
            int     c

            a = 0      <= initializations has been moved
            c = a + 1
        }

        Note(s) :
        - Be careful because this option sometimes does not work well. That's
          why it's set to FALSE by default.
" -EditorType=boolean -TrueFalse=-code_decl_move_affect-|-no-code_decl_move_affect- -ValueDefault=0 - -[code_decl_move_top] -Category=2 -Description="Move all local variables declaration to the top of the corresponding
statement.
Example :
        -code_decl_move_top-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a. b

            a = b = 0
            while(a)
            {
            }

            int c          <= declaration
            c = 10
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a. b
            int c          <= declaration has been moved

            a = b = 0
            while(a)
            {
            }

            c = 10
        }
" -EditorType=boolean -TrueFalse=-code_decl_move_top-|-no-code_decl_move_top- -ValueDefault=0 - -[code_decl_access_to_type] -Category=2 -Description="Move * and & access specifier just after the type if TRUE. or
just before the name if FALSE.
Example :
        -code_decl_access_to_type-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int**   p
        int function(int* b. int& ref)
        {
        }

        -no-code_decl_access_to_type-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int     **p
        int function(int *b. int &ref)
        {
        }
" -EditorType=boolean -TrueFalse=-code_decl_access_to_type-|-no-code_decl_access_to_type- -ValueDefault=0 - -[code_decl_break_template] -Category=2 -Description="Force an EOL after a template declaration.
Example :
        -code_decl_break_template-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        template    <= EOL
        class TestClass
        {
        public:
            char    buffer[i]
            T\t\ttestFunc(T *p1)
        }

        -no-code_decl_break_template-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        template class TestClass
        {
        public:
            char    buffer[i]
            T\t\ttestFunc(T *p1)
        }
" -EditorType=boolean -TrueFalse=-code_decl_break_template-|-no-code_decl_break_template- -ValueDefault=1 - -[code_decl_add_void] -Category=2 -Description="Force the voidkeyword in a function declaration if nothing is
specified.
Example :
        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int function()
        {
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int function(void)
        {
        }
" -EditorType=boolean -TrueFalse=-code_decl_add_void-|-no-code_decl_add_void- -ValueDefault=0 - -[code_wizard_indent] -Category=2 -Description="Indent code between to devstudio appwizard special comments.
Example :
        -code_wizard_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class   a
        {
        protected:
        //{{AFX_MSG(CDocument)
        enum a              <= has been touched
        {
            id = 0
        }
        afx_msg void    OnFileClose(void)
        afx_msg void    OnFileSave(void)
        afx_msg void    OnFileSaveAs(void)
        //}}AFX_MSG
        DECLARE_MESSAGE_MAP()
        }

        -no-code_wizard_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class   a
        {
        protected:
        //{{AFX_MSG(CDocument)
        enum a { id = 0 }          <= same as original file
        afx_msg void    OnFileClose(void)
        afx_msg void    OnFileSave(void)
        afx_msg void    OnFileSaveAs(void)
        //}}AFX_MSG
        DECLARE_MESSAGE_MAP()
        }

        Note(s) :
        - This option must be set to FALSE if you want to indent special
          appwizard headers with auto generated code. This is because touching
          that code can make appwizard fail to recognize its special marks.
        - This option can't be set in a source file with special comment
          /*$O */
" -EditorType=boolean -TrueFalse=-code_wizard_indent-|-no-code_wizard_indent- -ValueDefault=1 - -[code_force_return_paren] -Category=2 -Description="Force parentheses around a returnexpression.
Example :
        -code_force_return_paren-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a()
        {
            return 0
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a()
        {
            return(0)
        }

        See option(s) :
        [-no]-code_remove_return_paren-

        Note(s) :
        - This option can't be set in a source file with special comment
          /*$O */
        - Can't be used with -code_remove_return_paren- option.
" -EditorType=boolean -TrueFalse=-code_force_return_paren-|-no-code_force_return_paren- -ValueDefault=0 - -[code_remove_return_paren] -Category=2 -Description=Remove all parentheses around a return parameter -EditorType=boolean -TrueFalse=-code_remove_return_paren-|-no-code_remove_return_paren- -ValueDefault=0 - -[code_align_max_blanks] -CallName=-code_align_max_blanks- -Category=2 -Description="Set the maximum number of blank characters that can be added by GC to
align declarations of variables or functions.
Example :
        -code_align_max_blanks-10
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int     a
        un_int  b
        unsigned int    coucou
        unsigned int    bg

        -code_align_max_blanks-20
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int         a
        un_int      b
        unsigned int    coucou
        unsigned int    bg
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=1 -ValueDefault=1000 - -[code_def_fct_break_return_type] -Category=2 -Description="Force a line break after the return type in a function definition.
Example :
        -code_def_fct_break_return_type-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int
        function(void)
        {
        }

        int 
        class::func(void)
        {
        }

        -no-code_def_fct_break_return_type-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int function(void)
        {
        }

        int class::func(void)
        {
        }
" -EditorType=boolean -TrueFalse=-code_def_fct_break_return_type-|-no-code_def_fct_break_return_type- -ValueDefault=0 - -[code_concat_strings] -Category=2 -Description="Concat adjacent string constants.
Example :
        -no-code_concat_strings-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        printf(coucoulafoule)

        -code_concat_strings-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        printf(coucoulafoule)
" -EditorType=boolean -TrueFalse=-code_concat_strings-|-no-code_concat_strings- -ValueDefault=0 - -[code_empty_fct_blanks] -CallName=-code_empty_fct_blanks- -Category=2 -Description="Add empty lines between { and } for empty functions. Empty function
must have no code between { and }.
Example :
        -code_empty_fct_blanks-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void empty(void)
        { }

        -code_empty_fct_blanks-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void empty(void)
        {
        }

        -code_empty_fct_blanks-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void empty(void)
        {

        }
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[catch_eol_before] -CallName=-catch_eol_before- -Category=2 -Description=Number of EOL before catch -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[code_class_access_eol_before] -CallName=-code_class_access_eol_before- -Category=2 -Description="Number of EOL before/after class access specifiers.
Example :
        -code_class_access_eol_after-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        public:             
            void a(void)

        private:            
            void ab(void)
        }


        -code_class_access_eol_before-2
        -code_class_access_eol_after-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        
        public:             
                            
                            
            void a(void)
        
        
        private:            
                            
                            
            void ab(void)
        }

        See option(s) :
        -code_remove_empty_lines-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[code_class_access_eol_after] -CallName=-code_class_access_eol_after- -Category=2 -Description="Number of EOL before/after class access specifiers.
Example :
        -code_class_access_eol_after-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        public:             
            void a(void)

        private:            
            void ab(void)
        }


        -code_class_access_eol_before-2
        -code_class_access_eol_after-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        
        public:             
                            
                            
            void a(void)
        
        
        private:            
                            
                            
            void ab(void)
        }

        See option(s) :
        -code_remove_empty_lines-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[code_labels_eol_after] -CallName=-code_labels_eol_after- -Category=2 -Description="Number of EOL after labels.
Example :
        -code_labels_eol_after-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            goto label
        label:              
            a++

        -code_labels_eol_after-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            goto label
        label:              
                            
            a++

        See option(s) :
        -code_remove_empty_lines-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[stmt_break_alone] -Category=3 -Description="Force an empty statement to be alone on its line.
Example :
        -stmt_break_alone-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        for(a = 0 a < 10 a++)
            

        -no-stmt_break_alone-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        for(a = 0 a < 10 a++)

        Note(s) :
        - Concerns if. while. for and switch statements.
" -EditorType=boolean -TrueFalse=-stmt_break_alone-|-no-stmt_break_alone- -ValueDefault=0 - -[stmt_break_dowhile] -Category=3 -Description="Force a break line before the while of a do...while statement.
Example :
\t\t-stmt_break_dowhile-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\tdo
\t\t{
\t\t\t...
\t\t} 
\t\twhile(1)

\t\t-no-stmt_break_dowhile-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\tdo
\t\t{
\t\t\t...
\t\t} while(1)
" -EditorType=boolean -TrueFalse=-stmt_break_dowhile-|-no-stmt_break_dowhile- -ValueDefault=0 - -[stmt_force_brace] -CallName=-stmt_force_brace- -Category=3 -Description="Force a statement to be enclosed with { } if its length exceeded the
given parameter.
Example :
        -stmt_force_brace-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a) a++

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
            a++
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=100 - -[code_eol_after_close_brace] -CallName=-code_eol_after_close_brace- -Category=3 -Description="Nu
mber of blank lines after every close brace -
        except ones followed by else. while. and those around typedef
        statements...

        -stmt_force_brace-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if foo) {
          bar()
        }
        if foo) {
          bar()
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if foo) {
          bar()
        }

        if foo) {
          bar()
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[stmt_concat_if] -Category=3 -Description="Try to output if. while or for expression on a single line if the
length of the statement is not too long.
Example :
        -stmt_concat_if-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        while(a && b)
            a = b + 6
        if(a)
            a++
        if(b)
        {
            b++
        }


        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        while(a && b) a = b + 6
        if(a) a++
        if(b)
        {
            b++
        }

        See options(s) :
        -code_len-

        Note(s) :
        - This option does not modify statements with { }.
" -EditorType=boolean -TrueFalse=-stmt_concat_if-|-no-stmt_concat_if- -ValueDefault=1 - -[stmt_concat_if_and_else] -Category=3 -Description="Try to output if ... else expression on two lines - if possible...
Example :
        -stmt_concat_if_and_else-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
            a++
        else
            b++

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a) a++
        else b++

        See options(s) :
        -code_len-

        Note(s) :
        - This option does not modify statements with { }.
" -EditorType=boolean -TrueFalse=-stmt_concat_if_and_else-|-no-stmt_concat_if_and_else- -ValueDefault=0 - -[stmt_concat_else_2_stmt] -Category=3 -Description="Put the else on the same line as the previous statement.
Example :
        -stmt_concat_else_2_stmt-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
        } else
        {
        }

        -no-stmt_concat_else_2_stmt-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a)
        {
        } 
        else
        {
        }
" -EditorType=boolean -TrueFalse=-stmt_concat_else_2_stmt-|-no-stmt_concat_else_2_stmt- -ValueDefault=0 - -[stmt_concat_else_if] -Category=3 -Description="Close up any gap between else and if in else ... ifstructures.
Example :
        -stmt_concat_else_if-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(foo) 
\t\t{
        } 
\t\telse if(bar) 
\t\t{
        }

        -no-stmt_concat_else_if-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(foo) 
\t\t{
        } else
        if(bar) 
\t\t{
        }
" -EditorType=boolean -TrueFalse=-stmt_concat_else_if-|-no-stmt_concat_else_if- -ValueDefault=1 - -[stmt_concat_inline_class] -Category=3 -Description="Concat if possible inline function body inside a class.
Example :
        -stmt_concat_inline_class-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
            int previous(int a)
            {
                return a - 1
            }
            int next(int a)
            {
                return a + 1
            }
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class   a
        {
            int previous(int a) { return a - 1 }
            int next(int a)     { return a + 1 }
        }

        See options(s) :
        -code_len-
" -EditorType=boolean -TrueFalse=-stmt_concat_inline_class-|-no-stmt_concat_inline_class- -ValueDefault=1 - -[stmt_concat_switch] -Category=3 -Description="Concat all cases of a switch if possible. Empty lines are removed if
\t\tconcatenation is done.
Example :
        -stmt_concat_switch-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
        case 10:
            break

        case 11:
            a = a + 6 return a

        case 12:
            if(a) a++
            break
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
        case 10:    break
        case 11:    a = a + 6 return a
        case 12:    if(a) a++ break
        }
" -EditorType=boolean -TrueFalse=-stmt_concat_switch-|-no-stmt_concat_switch- -ValueDefault=1 - -[stmt_concat_macros] -Category=3 -Description="Concat a macro body if possible.
Example :
        -stmt_concat_macros-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #define macro()
        {
            a = a + 18 - b
            if(!a) return 10
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #define macro() { a = a + 18 - b if(!a) return 10 }
" -EditorType=boolean -TrueFalse=-stmt_concat_macros-|-no-stmt_concat_macros- -ValueDefault=1 - -[stmt_concat_enum] -Category=3 -Description="Concat content of enum if possible.
Example :
        -stmt_concat_enum-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        enum a
        {
            id1.
            id2
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        enum a { id1. id2 }
" -EditorType=boolean -TrueFalse=-stmt_concat_enum-|-no-stmt_concat_enum- -ValueDefault=1 - -[stmt_decl_remove_empty] -Category=3 -Description="Remove empty lines in declaration statements.
Example :
        -stmt_decl_remove_empty-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a
                        <= Empty line
            int b
            int c

            a = b = c = 0
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            int a
            int b
            int c

            a = b = c = 0
        }
" -EditorType=boolean -TrueFalse=-stmt_decl_remove_empty-|-no-stmt_decl_remove_empty- -ValueDefault=1 - -[stmt_concat_if_remove_empty] -Category=3 -Description="Remove empty lines between concat if/while/for.
Example :
        -stmt_concat_if_remove_empty-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a) a++
                        <= Empty line
                        <= Empty line
        if(b) b = b + a

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        if(a) a++
        if(b) b = b + a

        See option(s) :
        [-no]-stmt_concat_if- to concat if/while/for expressions if possible.
" -EditorType=boolean -TrueFalse=-stmt_concat_if_remove_empty-|-no-stmt_concat_if_remove_empty- -ValueDefault=1 - -[stmt_brace_style_class] -CallName=-stmt_brace_style_class- -Category=3 -Description="Change the indentation style of braces.
-stmt_brace_style_class- for a class declaration.
-stmt_brace_style_fct- for a function body.
-stmt_brace_style_decl- for declarations (struct. enum).
-stmt_brace_style- for all other statements (if. while...).
Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
            {
                a = a + func(a)
            }
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
            {
            while(a)
                {
                a = a + func(a)
                }
            }

        Style 2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
            }
        }

        Style 3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
                }
            }

        Style 4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {   while(a)
            {   a = a + func(a)
            }
        }

        Style 5 offset brace by 1/2 tab width
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
              {
                a = a + func(a)
              }
        }

        Note(s) :
        - Valid values are only 0. 1. 2. 3. 4 or 5.
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[stmt_brace_style_fct] -CallName=-stmt_brace_style_fct- -Category=3 -Description="Change the indentation style of braces.
-stmt_brace_style_class- for a class declaration.
-stmt_brace_style_fct- for a function body.
-stmt_brace_style_decl- for declarations (struct. enum).
-stmt_brace_style- for all other statements (if. while...).
Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
            {
                a = a + func(a)
            }
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
            {
            while(a)
                {
                a = a + func(a)
                }
            }

        Style 2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
            }
        }

        Style 3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
                }
            }

        Style 4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {   while(a)
            {   a = a + func(a)
            }
        }

        Style 5 offset brace by 1/2 tab width
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
              {
                a = a + func(a)
              }
        }

        Note(s) :
        - Valid values are only 0. 1. 2. 3. 4 or 5.
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[stmt_brace_style_decl] -CallName=-stmt_brace_style_decl- -Category=3 -Description="Change the indentation style of braces.
-stmt_brace_style_class- for a class declaration.
-stmt_brace_style_fct- for a function body.
-stmt_brace_style_decl- for declarations (struct. enum).
-stmt_brace_style- for all other statements (if. while...).
Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
            {
                a = a + func(a)
            }
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
            {
            while(a)
                {
                a = a + func(a)
                }
            }

        Style 2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
            }
        }

        Style 3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
                }
            }

        Style 4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {   while(a)
            {   a = a + func(a)
            }
        }

        Style 5 offset brace by 1/2 tab width
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
              {
                a = a + func(a)
              }
        }

        Note(s) :
        - Valid values are only 0. 1. 2. 3. 4 or 5.
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[stmt_brace_style] -CallName=-stmt_brace_style- -Category=3 -Description="Change the indentation style of braces.
-stmt_brace_style_class- for a class declaration.
-stmt_brace_style_fct- for a function body.
-stmt_brace_style_decl- for declarations (struct. enum).
-stmt_brace_style- for all other statements (if. while...).
Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
            {
                a = a + func(a)
            }
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
            {
            while(a)
                {
                a = a + func(a)
                }
            }

        Style 2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
            }
        }

        Style 3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void) {
            while(a) {
                a = a + func(a)
                }
            }

        Style 4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {   while(a)
            {   a = a + func(a)
            }
        }

        Style 5 offset brace by 1/2 tab width
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void main(void)
        {
            while(a)
              {
                a = a + func(a)
              }
        }

        Note(s) :
        - Valid values are only 0. 1. 2. 3. 4 or 5.
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[stmt_switch_style] -CallName=-stmt_switch_style- -Category=3 -Description="Change the indentation style of switch.
Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
        case 0:
            a++
            break
        case 1:
            break
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
            case 0:
                a++
                break
            case 1:
                break
        }

        Style 2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
            {
            case 0:
                a++
                break
            case 1:
                break
            }

        Style 3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a) {
        case 0:
            a++
            break
        case 1:
            break
        }

        Style 4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a) {
            case 0:
                a++
                break
            case 1:
                break
        }

        Style 5
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
          {
        case 0:
            a++
            break
        case 1:
            break
          }
" -EditorType=numeric -Enabled=true -MaxVal=5 -MinVal=0 -ValueDefault=0 - -[stmt_switch_eol] -CallName=-stmt_switch_eol- -Category=3 -Description="Is there an empty line before the casekeyword ?

Example :
        Style 0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
        case 0:
\t\tcase 3:
            a++
            break

        case 1:
            break

        case 4:
            break
        }

        Style 1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        switch(a)
        {
        case 0:
\t\tcase 3:
            a++
            break
        case 1:
            break
        case 4:
            break
        }
" -EditorType=numeric -Enabled=true -MaxVal=1 -MinVal=0 -ValueDefault=0 - -[stmt_class_indent] -CallName=-stmt_class_indent- -Category=3 -Description="Set the number of additional indentation levels in a class declaration.
Example :
        -stmt_class_indent-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        public:
            void a(void)
        }

        -stmt_class_indent-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
            public:
                void a(void)
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[stmt_namespace_indent] -Category=3 -Description="Indent one level a namespace statement.
Example :
        -no-stmt_namespace_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        namespace com
        {
        int a(void)
        {
        }
        }

        -stmt_namespace_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        namespace com
        {
            int a(void)
            {
            }
        }
" -EditorType=boolean -TrueFalse=-stmt_namespace_indent-|-no-stmt_namespace_indent- -ValueDefault=0 - -[stmt_extern_c_indent] -Category=3 -Description="Indent one level an extern Cstatement.
Example :
        -no-stmt_extern_c_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        extern C
        {
        int a(void)
        {
        }
        }

        -stmt_extern_c_indent-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        extern C
        {
            int a(void)
            {
            }
        }
" -EditorType=boolean -TrueFalse=-stmt_extern_c_indent-|-no-stmt_extern_c_indent- -ValueDefault=0 - -[stmt_static_init_style] -CallName=-stmt_static_init_style- -Category=3 -Description="De
fines indent style for static initialisations.

\t\t-stmt_static_init_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\tchar *d[] = 
\t\t{ 
\t\t\tNULL. 
\t\t\tROM. 
\t\t\tOTPROM. 
\t\t\tEPROM. 
\t\t\tEEPROM. 
\t\t\tFLASH
\t\t}

\t\t-stmt_static_init_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\tchar *d[] = { NULL. ROM. OTPROM. EPROM. EEPROM. FLASH}

\t\t-stmt_static_init_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\tchar *d[] = 
\t\t{ 
\t\t\tNULL. ROM. OTPROM. 
\t\t\tEPROM. EEPROM. FLASH
\t\t}

        Note(s) :
        - Option -stmt_static_init_style-1 let the original indentation 
\t\t  unchanged.
        - The max length of the line in the initialisation statement for option
\t\t  -stmt_static_init_style-3 is defined by the -stmt_static_init_len-
\t\t  option.

        See option(s) :
\t\t-stmt_static_init_len-
" -EditorType=numeric -Enabled=true -MaxVal=3 -MinVal=0 -ValueDefault=0 - -[stmt_static_init_len] -CallName=-stmt_static_init_len- -Category=3 -Description="To
 be used with -stmt_static_init_style-3. Defined the max length of
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=80 - -[pp_align_to_code] -Category=4 -Description="Align or not PP directive to the code just below.
Example :
        -pp_align_to_code-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #define a   0
        void main(void)
        {
            #define a       0
            #define coucou  0
            #define coucou() 
                while(a) 
                { 
                    a = a + func(a) 
                }

            #if 0
            if(a) a++
            #endif
        }

        -no-pp_align_to_code-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #define a   0
        void main(void)
        {
        #define a       0
        #define coucou  0
        #define coucou() 
            while(a) 
            { 
                a = a + func(a) 
            }

        #if 0
            if(a) a++
        #endif
        }

        Note(s) :
        - This option can't be used in source file file special comment /*$O*/.
" -EditorType=boolean -TrueFalse=-pp_align_to_code-|-no-pp_align_to_code- -ValueDefault=0 - -[pp_style] -CallName=-pp_style- -Category=4 -Description="Set the indentation style of PP directives.
Example :
        -pp_style-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #ifdef a
            a++
        #else
        #if 0
        #ifdef a
        #elif b
            a--
        #endif
        #endif
        #endif

        -pp_style-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #ifdef a
            a++
        #else
            #if 0
                #ifdef a
                #elif b
            a--
                #endif
            #endif
        #endif

        -pp_style-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #ifdef a
            a++
        #else
        #   if 0
        #      ifdef a
        #      elif b
            a--
        #      endif
        #   endif
        #endif
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[pp_include_unix] -Category=4 -Description="Change '' to '/' in an include expression.
Example :
        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #include gll.h
        #include 

        -pp_include_unix-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #include gl/gl.h
        #include 

        -no-pp_include_unix-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        #include gll.h
        #include
" -EditorType=boolean -TrueFalse=-pp_include_unix-|-no-pp_include_unix- -ValueDefault=1 - -[pp_align_breakline] -Category=4 -Description="Al
ign (or not) breakline characters '' in macros.

        -pp_align_breakline-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\t#define a(A)         
\t\t\tA += 2\t\t\t 
\t\t\tA = c(fonc) + 3 

        -no-pp_align_breakline-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

\t\t#define a(A) 
\t\t\tA += 2\t
\t\t\tA = c(fonc) + 3
" -EditorType=boolean -TrueFalse=-pp_align_breakline-|-no-pp_align_breakline- -ValueDefault=0 - -[cmt_fixme] -CallName=-cmt_fixme- -Category=5 -Description="Specify the string for FIXME comment the default is /* FIXME: Comment */
Example :
        -cmt_fixme-/* TODO: add comment */
" -EditorType=string -Enabled=false -ValueDefault=/* */ - -[cmt_align_max_blanks] -CallName=-cmt_align_max_blanks- -Category=5 -Description="Set the max number of blank characters to add to align last line
comments.
Example :
        -cmt_align_max_blanks-20
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int         coucou     /* comment */
        unsigned int    b      /* comment */
        unsigned int    long_long_variable_variables   /* comment */

        -cmt_align_max_blanks-30
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int         coucou             /* comment */
        unsigned int    b                  /* comment */
        unsigned int    long_long_variable_variables   /* comment */
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=1 -ValueDefault=10 - -[cmt_first_space_cpp] -Category=5 -Description="Force a space after the opening comment delimiter.
Example :
        -cmt_first_space_cpp-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        // coucou

        -no-cmt_first_space_cpp-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        //coucou
" -EditorType=boolean -TrueFalse=-cmt_first_space_cpp-|-no-cmt_first_space_cpp- -ValueDefault=1 - -[cmt_dont_modify] -Category=5 -Description="Pr
ocess or not all the comments of the file.
" -EditorType=boolean -TrueFalse=-cmt_dont_modify-|-no-cmt_dont_modify- -ValueDefault=0 - -[cmt_add_gc_tag] -Category=5 -Description=Add the GC mark at the beginning of the file.

/*$T test.c GC 1.102 01/06/01 16:47:25 */ -EditorType=boolean -TrueFalse=-cmt_add_gc_tag-|-no-cmt_add_gc_tag- -ValueDefault=1 - -[cmt_add_file] -Category=5 -Description=Add a special comment at the beginning of file (if not already
present). The type of the comment is set by -cmt_add_file_style-.

-cmt_add_file-
-cmt_add_file_style-0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

** file.c **
/*$6
++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++
*/
...
** EOF **

-cmt_add_file-
-cmt_add_file_style-1
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

** file.c **
/*$I0
...
*/
...
** EOF **

See option(s) :
-cmt_sep_char_6-
-cmt_sep_len-
-cmt_add_file_style- -EditorType=boolean -TrueFalse=-cmt_add_file-|-no-cmt_add_file- -ValueDefault=1 - -[cmt_add_file_style] -CallName=-cmt_add_file_style- -Category=5 -Description="Special comment style for -cmt_add_file- option.
0 = special comment level 6 /*$6
1 = special comment external insertion file /*$I0

-cmt_add_file_style-0
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

** file.c **
/*$6
++++++++++++++++++++++++++++++++++++++++++
++++++++++++++++++++++++++++++++++++++++++
*/

-cmt_add_file_style-1
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

** file.c **
/*$I0
...
*/

See option(s) :
[no]-cmt_add_file-
Special comment /*$I*/" -EditorType=numeric -Enabled=true -MaxVal=1 -MinVal=0 -ValueDefault=0 - -[cmt_add_fct_def] -Category=5 -Description="Add an empty comment before function definition (if not already
present).
Comment is level is set by -cmt_sep_force_fct_def- option.

** file.c **

/*
==========================================
==========================================
*/
int a(void)
{
}

** EOF **

See option(s) :
-cmt_sep_char_3-
-cmt_sep_len-
-cmt_sep_force_fct_def-

Note(s) :
- Actual comments before function are included in the separator." -EditorType=boolean -TrueFalse=-cmt_add_fct_def-|-no-cmt_add_fct_def- -ValueDefault=1 - -[cmt_add_fct_def_class] -Category=5 -Description=Same as -cmt_add_fct_def-. but for functions defined inside a class
\t\t(inline functions).

See option(s) :
\t\t-cmt_add_fct_def- -EditorType=boolean -TrueFalse=-cmt_add_fct_def_class-|-no-cmt_add_fct_def_class- -ValueDefault=1 - -[cmt_trailing_style] -CallName=-cmt_trailing_style- -Category=5 -Description="Co
ntrol style of trailing comments and an empty comment is added to
        function parameters if not already present. 
        This also causes -cmt_force_fct_def_decl_split-
        and -code_split_fctdef_style-3. The content of
        empty comment is defined by -cmt_fixme-.

        -cmt_trailing_style-1
        -cmt_force_fct_def_decl_split-
        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        before:

        int a(int param1. int param2)                   ## No comments
        {
        }

        after:

        int a(
            int param1. /* FIXME: add a comment */      ## Added automatically
            int param2) /* FIXME: add a comment */      ## Added automatically
        {
        }


        -cmt_trailing_style-2
        -cmt_force_fct_def_decl_split-
        -code_split_fctdef_style-3
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        before:

        int a(
            int param1. /* IN: parameter 1 */
            int param2) /* IN: parameter 2 */
        {
        }

        after:

        int a(
            int param1. ///< IN: parameter 1            ## Changed to cpp
            int param2) ///< IN: parameter 2            ## Changed to cpp
        {
        }
" -EditorType=numeric -Enabled=true -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[cmt_split_before_@_in_fct_cmts] -Category=5 -Description=Split lines in fucntion comments before @ -EditorType=boolean -TrueFalse=-cmt_split_before_@_in_fct_cmts-|-no-cmt_split_before_@_in_fct_cmts- -ValueDefault=0 - -[cmt_force_fct_def_decl_split] -Category=5 -Description="Fo
rce function definitions to split at each paramenter according
        to the sytle defined by -code_split_fctdef_style-
" -EditorType=boolean -TrueFalse=-cmt_force_fct_def_decl_split-|-no-cmt_force_fct_def_decl_split- -ValueDefault=0 - -[cmt_java_doc] -Category=5 -Description=Enable the java doc type comments for all comments. Also enables -cmt_sep_fill_star- and -cmt_fct_java_doc- -EditorType=boolean -TrueFalse=-cmt_java_doc-|-no-cmt_java_doc- -ValueDefault=0 - -[cmt_fct_java_doc] -Category=5 -Description=Enable the java doc type comments for functions only. Also enables -cmt_sep_fill_star-. -EditorType=boolean -TrueFalse=-cmt_fct_java_doc-|-no-cmt_fct_java_doc- -ValueDefault=0 - -[cmt_add_class_access] -Category=5 -Description="Add an empty comment before class access (if not already present).
Comment level is set by -cmt_sep_force_class_access- option.
Example :
        -cmt_add_class_access-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        public:
            void v(void)
        protected:
            int c
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        class a
        {
        /*      <= by default. cmt level is 2
         ==========================================
         ==========================================
         */
        public:
            void v(void)

        /*
         ==========================================
         ==========================================
         */
        protected:
            int c
        }

        See option(s) :
        -cmt_sep_char_2-
        -cmt_sep_len-
        -cmt_sep_force_class_access-
" -EditorType=boolean -TrueFalse=-cmt_add_class_access-|-no-cmt_add_class_access- -ValueDefault=1 - -[cmt_keep_cpp] -Category=5 -Description="Keep C++ comments. and do not change them to the C form.
Example :
        -no-cmt_keep_cpp-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        // this is a comment
        // this is another comment

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * this is a comment 
         * this is another comment
         */

        See option(s) :
        [no]-cmt_cpp2c_keep_eol-
        -cmt_sep_char_split-

        Note(s) :
        - This option can't be set in a source file with special comment
          /*$O */
" -EditorType=boolean -TrueFalse=-cmt_keep_cpp-|-no-cmt_keep_cpp- -ValueDefault=0 - -[cmt_c2cpp] -Category=5 -Description=Convert all C comments to the C++ form. Only end of lines comments are
converted.
See option(s) :
-cmt_keep_cpp-

Note(s) :
- This option set the -cmt_keep_cpp- to true. -EditorType=boolean -TrueFalse=-cmt_c2cpp-|-no-cmt_c2cpp- -ValueDefault=0 - -[cmt_cpp2c_keep_eol] -Category=5 -Description="Keep trace of EOL characters when converting C++ comments to C
comment. -cmt_keep_cpp- must be enabled.
Example :
        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        // this is a comment
        // this is another comment

        -cmt_cpp2c_keep_eol-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * this is a comment           <=  is the default break character
         * this is another comment
         */

        -no-cmt_cpp2c_keep_eol-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* this is a comment this is another comment */

        See option(s) :
        [no]-cmt_keep_cpp-
        -cmt_sep_char_split-
" -EditorType=boolean -TrueFalse=-cmt_cpp2c_keep_eol-|-no-cmt_cpp2c_keep_eol- -ValueDefault=1 - -[cmt_fct_categ] -CallName=-cmt_fct_categ- -Category=5 -Description="-cmt_fct_categ- Define a special word when indenting function
comments.
-cmt_fct_categ_in- This word is a special category to describe
function parameters.

GC can indent function definition comments in a special form
depending of special words defined with those options.
Example :
        options
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        -cmt_fct_categ-main
        -cmt_fct_categ-output
        -cmt_fct_categ_in-parameters


        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Description: Description of the function. Return: none
        Parameters: a - entering value b - increment value */
        int function(int a. int b)
        {
        }


        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ==========================================
         Description:\tDescription of the function.

         Return:\tnone

         Parameters:    a   - entering value
                        b   - increment value
         ==========================================
         */
        int function(int a. int b)
        {
        }

        See option(s) :
        [-no]-cmt_add_fct_def-
\t\t-cmt_fct_categ_style-

        Note(s) :
        - In comment. special words must be followed by ':'.
        - A parameter must be followed by '-'. and then by the comment.
        - This option can't be set in a source file with special comment
          /*$O */
" -EditorType=string -Enabled=false -ValueDefault= - -[cmt_fct_categ_in] -CallName=-cmt_fct_categ_in- -Category=5 -Description="-cmt_fct_categ- Define a special word when indenting function
comments.
-cmt_fct_categ_in- This word is a special category to describe
function parameters.

GC can indent function definition comments in a special form
depending of special words defined with those options.
Example :
        options
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        -cmt_fct_categ-main
        -cmt_fct_categ-output
        -cmt_fct_categ_in-parameters


        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Description: Description of the function. Return: none
        Parameters: a - entering value b - increment value */
        int function(int a. int b)
        {
        }


        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ==========================================
         Description:\tDescription of the function.

         Return:\tnone

         Parameters:    a   - entering value
                        b   - increment value
         ==========================================
         */
        int function(int a. int b)
        {
        }

        See option(s) :
        [-no]-cmt_add_fct_def-
\t\t-cmt_fct_categ_style-

        Note(s) :
        - In comment. special words must be followed by ':'.
        - A parameter must be followed by '-'. and then by the comment.
        - This option can't be set in a source file with special comment
          /*$O */
" -EditorType=string -Enabled=false -ValueDefault= - -[cmt_fct_categ_style] -CallName=-cmt_fct_categ_style- -Category=5 -Description=Set indentation style for special keywords in comments -EditorType=numeric -Enabled=true -MaxVal=1 -MinVal=0 -ValueDefault=0 - -[cmt_decl] -Category=5 -Description="Add separators in local variable declaration (before and/or after).
Separators are by default level 1.
Example :
        -cmt_decl-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            unsigned int    var
            long b
            var = 0
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~~~~~~~*/
            unsigned int    var
            long            b
            /*~~~~~~~~~~~~~~~~~~*/

            var = 0
        }

        See options(s) :
        -cmt_decl_max_level-
        [-no]-cmt_decl_before-
        -cmt_decl_len-
        [-no]-cmt_decl_auto_len-
        -cmt_decl_auto_len_add-

        Note(s) :
        - Can't be used with -cmt_dont_modify- option.
" -EditorType=boolean -TrueFalse=-cmt_decl-|-no-cmt_decl- -ValueDefault=1 - -[cmt_decl_max_level] -CallName=-cmt_decl_max_level- -Category=5 -Description="-cmt_decl- option is valid for declaration in a statement level lesser
than that value.
Example :
        -cmt_decl_max_level-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~*/
            int b
            /*~~*/

            b = 0
            if(b)
            {
                unsigned int    var    <= stmt level is 2. so is not touched
                long            c

                var = c = 0
            }
        }

        -cmt_decl_max_level-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~*/
            int b
            /*~~*/

            b = 0
            if(b)
            {
                /*~~~~~~~~~~~~~~~~~~*/  <= stmt level 2 is now converned
                unsigned int    var
                long            c
                /*~~~~~~~~~~~~~~~~~~*/

                var = c = 0
            }
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=100 - -[cmt_decl_before] -Category=5 -Description="Add a separator before local declarations.
-cmt_decl- must be enabled.
Example :
        -cmt_decl_before-

        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~~~~~~~*/
            unsigned int    var
            long            b
            /*~~~~~~~~~~~~~~~~~~*/

            var = 0
        }

        -no-cmt_decl_before-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            unsigned int    var
            long            b
            /*~~~~~~~~~~~~~~~~~~*/

            var = 0
        }
" -EditorType=boolean -TrueFalse=-cmt_decl_before-|-no-cmt_decl_before- -ValueDefault=1 - -[cmt_decl_len] -CallName=-cmt_decl_len- -Category=5 -Description="Se
t the maximum column of the declaration separator.
        -cmt_decl- must be enabled.
        -cmt_decl_auto_len- must be disabled.

        -cmt_decl_len-20
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~*/        <= column 20
            int b
            /*~~~~~~~~~~~~*/
            {
                /*~~~~~~*/
                unsigned int    var
                long            b
                /*~~~~~~*/
            }

            var = 0
        }

        -cmt_decl_len-50
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/      <= column 50
            int b
            /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
            {
                /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
                unsigned int    var
                long            b
                /*~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~*/
            }

            var = 0
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=120 - -[cmt_decl_auto_len] -Category=5 -Description="Co
mpute the length of the decl separator depending on code.
        Is disabled. the length is set by -cmt_decl_len- option.
" -EditorType=boolean -TrueFalse=-cmt_decl_auto_len-|-no-cmt_decl_auto_len- -ValueDefault=1 - -[cmt_decl_auto_len_add] -CallName=-cmt_decl_auto_len_add- -Category=5 -Description="Wh
en -cmt_decl_auto_len- and -cmt_decl- are both enabled. add 
        characters to the length of the separator.

        -cmt_decl_auto_len_add-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~~~~~~~*/  <= exact size of the code below
            unsigned int    var
            long            b
            /*~~~~~~~~~~~~~~~~~~*/

            {
                /*~~*/      <= idem
                int c
                /*~~*/
            }

            var = 0
        }

        -cmt_decl_auto_len_add-4
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a(void)
        {
            /*~~~~~~~~~~~~~~~~~~~~~~*/  <= size + 4
            unsigned int    var
            long            b
            /*~~~~~~~~~~~~~~~~~~~~~~*/

            {
            /*~~~~~~*/              <= size + 4
            int c
            /*~~~~~~*/
            }

            var = 0
        }
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[cmt_first_line_break_first] -Category=5 -Description="Add an EOL after /* of first line comments.
Add an EOL before */ of first line comments.
Example :
        -cmt_first_line_break_first-
        -cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * Comment 
         * Comment
         */

        -no-cmt_first_line_break_first-
        -cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Comment 
         * Comment
         */

        -no-cmt_first_line_break_first-
        -no-cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Comment 
         * Comment */
" -EditorType=boolean -TrueFalse=-cmt_first_line_break_first-|-no-cmt_first_line_break_first- -ValueDefault=1 - -[cmt_first_line_break_last] -Category=5 -Description="Add an EOL after /* of first line comments.
Add an EOL before */ of first line comments.
Example :
        -cmt_first_line_break_first-
        -cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * Comment 
         * Comment
         */

        -no-cmt_first_line_break_first-
        -cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Comment 
         * Comment
         */

        -no-cmt_first_line_break_first-
        -no-cmt_first_line_break_last-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* Comment 
         * Comment */
" -EditorType=boolean -TrueFalse=-cmt_first_line_break_last-|-no-cmt_first_line_break_last- -ValueDefault=1 - -[cmt_first_line_fill_star] -Category=5 -Description="Add a '*' character at the beginning of lines of first line comments.
Example :
        -cmt_first_line_fill_star-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * Comment 
         * Comment
         */

        -no-cmt_first_line_fill_star-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
           Comment 
           Comment
         */

        See options(s) :
        [-no]-cmt_sep_fill_star-

        Note(s) :
        - Separators are not concerned.
" -EditorType=boolean -TrueFalse=-cmt_first_line_fill_star-|-no-cmt_first_line_fill_star- -ValueDefault=1 - -[cmt_first_line_len] -CallName=-cmt_first_line_len- -Category=5 -Description="Set the maximum length of first line comments.
Example :
        -cmt_first_line_len-100
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* this is a comment that should be split */

        -cmt_first_line_len-40
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * this is a comment that should be
         * split
         */

        -cmt_first_line_len-10
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * this is a
         * comment
         * that
         * should be
         * split
         */

        Note(s) :
        - Separators are not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=8 -ValueDefault=80 - -[cmt_first_line_concat] -Category=5 -Description="Concat adjacent first line comments.
Example :
        -cmt_first_line_concat-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* first line comment */
        /* another first line comment */

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * first line comment 
         * another first line comment
         */
" -EditorType=boolean -TrueFalse=-cmt_first_line_concat-|-no-cmt_first_line_concat- -ValueDefault=1 - -[cmt_first_line_blank] -Category=5 -Description="Add an empty line between two adjacent first line comments.
-cmt_first_line_concat- must be disabled.
Example :
        -cmt_first_line_blank-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* comment1 */
        /* comment2 */
        /* comment3 */
        if(a)
        {
        }

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* comment1 */
        
        /* comment2 */
        
        /* comment3 */
        if(a)
        {
        }

        See options(s) :
        [-no]-cmt_first_line_concat-
" -EditorType=boolean -TrueFalse=-cmt_first_line_blank-|-no-cmt_first_line_blank- -ValueDefault=1 - -[cmt_sep_len] -CallName=-cmt_sep_len- -Category=5 -Description="Set the maximum length for separators. First line comments are not
concerned.
Example :
        -cmt_sep_len-10
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2
         ---------
         ---------
         */

        -cmt_sep_len-20
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$4
         *******************
         *******************
         */
        /*$5-#############*/
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=8 -ValueDefault=120 - -[cmt_sep_fill_star] -Category=5 -Description="Add a star at the beginning of all lines of a separator.
Example :
        -cmt_sep_fill_star-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$4
         *******************
         *    comment 
         *    comment
         *******************
         */

        -no-cmt_sep_fill_star-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$4
         *******************
           comment 
           comment
         *******************
         */

        See option(s) :
        -cmt_sep_char_4-
        -cmt_sep_char_split-
        [-no]-cmt_first_line_fill_star-
" -EditorType=boolean -TrueFalse=-cmt_sep_fill_star-|-no-cmt_sep_fill_star- -ValueDefault=0 - -[cmt_sep_break] -Category=5 -Description="Force /* and */ to be alone on their lines for separators.
Example :
        -cmt_sep_break-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ===================
           comment 
           comment
         ===================
         */

        //
        // =================
        // comment
        // =================
        //

        -no-cmt_sep_break-
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* =================
           comment 
           comment
         =================== */

        // =================
        // comment
        // =================
" -EditorType=boolean -TrueFalse=-cmt_sep_break-|-no-cmt_sep_break- -ValueDefault=1 - -[cmt_keep-char_1] -CallName=-cmt_keep-char_1- -Category=5 -Description=(1) Keep the comment identical to /*$F but apply to the character next to the * in /* -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_2] -CallName=-cmt_keep-char_2- -Category=5 -Description=(2) Keep the comment identical to /*$F but apply to the character next to the * in /* -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_3] -CallName=-cmt_keep-char_3- -Category=5 -Description=(3) Keep the comment identical to /*$F but apply to the character next to the * in /* -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_4] -CallName=-cmt_keep-char_4- -Category=5 -Description=(4) Keep the comment identical to /*$F but apply to the character next to the * in /* -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_cpp_1] -CallName=-cmt_keep-char_cpp_1- -Category=5 -Description=(1) Keep the cpp comment as is character after the //. -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_cpp_2] -CallName=-cmt_keep-char_cpp_2- -Category=5 -Description=(2) Keep the cpp comment as is character after the //. -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_cpp_3] -CallName=-cmt_keep-char_cpp_3- -Category=5 -Description=(3) Keep the cpp comment as is character after the //. -EditorType=string -Enabled=false -ValueDefault= - -[cmt_keep-char_cpp_4] -CallName=-cmt_keep-char_cpp_4- -Category=5 -Description=(4) Keep the cpp comment as is character after the //. -EditorType=string -Enabled=false -ValueDefault= - -[cmt_sep_char_1] -CallName=-cmt_sep_char_1- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault=~ - -[cmt_sep_char_2] -CallName=-cmt_sep_char_2- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault=- - -[cmt_sep_char_3] -CallName=-cmt_sep_char_3- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault="=" - -[cmt_sep_char_4] -CallName=-cmt_sep_char_4- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault=* - -[cmt_sep_char_5] -CallName=-cmt_sep_char_5- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault=# - -[cmt_sep_char_6] -CallName=-cmt_sep_char_6- -Category=5 -Description="Set the special character to fill automatic comments.
Example :
        -cmt_sep_char_1-O
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$1-OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO*/
        /*$1
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         OOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOOO
         */

        -cmt_sep_char_2-#
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*$2-####################################*/
        /*$2
         ##########################################
         ##########################################
         */

        Note(s) :
        - /*$- */ is a special form comment recognized by GC.
          This is a single line comment.
        - /*$ */ is a special form comment recognized by GC.
          This is a multiline comment.
" -EditorType=string -Enabled=true -ValueDefault=+ - -[cmt_sep_char_split] -CallName=-cmt_sep_char_split- -Category=5 -Description="Define the special break line character in comments.
        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* coucou  salut */

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         * coucou 
         * salut
         */

        See option(s) :
        [-no]-cmt_first_line_concat-
        [-no]-cmt_cpp2c_keep_eol-

        Note(s) :
        - GC uses this special character to keep trace of EOL when converting
          C++ comments to C comments. or to concat first line comments.
" -EditorType=string -Enabled=true -ValueDefault= - -[cmt_sep_eol_before] -CallName=-cmt_sep_eol_before- -Category=5 -Description="Set the number of blank lines before and after single-line comments.

Example :
        -cmt_sep_eol_before-1
        -cmt_sep_eol_after-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            foo()

            // Single line comment...

            bar()

        -cmt_sep_eol_before-0
        -cmt_sep_eol_after-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

            foo()
            // Single line comment...
            bar()
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after] -CallName=-cmt_sep_eol_after- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[cmt_sep_eol_before_1] -CallName=-cmt_sep_eol_before_1- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_before_2] -CallName=-cmt_sep_eol_before_2- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_before_3] -CallName=-cmt_sep_eol_before_3- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_before_4] -CallName=-cmt_sep_eol_before_4- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_before_5] -CallName=-cmt_sep_eol_before_5- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_before_6] -CallName=-cmt_sep_eol_before_6- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=2 - -[cmt_sep_eol_after_1] -CallName=-cmt_sep_eol_after_1- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after_2] -CallName=-cmt_sep_eol_after_2- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after_3] -CallName=-cmt_sep_eol_after_3- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after_4] -CallName=-cmt_sep_eol_after_4- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after_5] -CallName=-cmt_sep_eol_after_5- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[cmt_sep_eol_after_6] -CallName=-cmt_sep_eol_after_6- -Category=5 -Description="Set the number of EOL before and after special first line comments.
depending on the level.
Example :
        -cmt_sep_eol_before_2-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        
        /*$2
          ==========================================
          ==========================================
          */
        
        
        ...

        -cmt_sep_eol_before_2-1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        ...
        
        /*$2
          ==========================================
          ==========================================
          */
        
        ...

        Note(s) :
        - Only automatic comments and /*$ */ comments are concerned.
          The /*$- */ comment is not concerned.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=2 - -[cmt_sep_eol_before_fct_def] -CallName=-cmt_sep_eol_before_fct_def- -Category=5 -Description="Set the number of blank lines before a function defintion comment.
Example :
        -cmt_sep_eol_before_fct_def-0
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ==========================================
            proto
         ==========================================
         */
        void fct(void)
        {
        }
        /*
         ==========================================
            proto
         ==========================================
         */
        void fct1(void)
        {
        }

        -cmt_sep_eol_before_fct_def-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ==========================================
            proto
         ==========================================
         */
        void fct(void)
        {
        }
        
        
        /*
         ==========================================
            proto
         ==========================================
         */
        void fct1(void)
        {
        }

        See option(s) :
        -code_remove_empty_lines-

        Note(s) :
        -code_remove_empty_lines- has a highter priority.
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[cmt_sep_force_fct_proto] -CallName=-cmt_sep_force_fct_proto- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=0 - -[cmt_sep_force_fct_macro] -CallName=-cmt_sep_force_fct_macro- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=3 - -[cmt_sep_force_fct_def] -CallName=-cmt_sep_force_fct_def- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=3 - -[cmt_sep_force_class_access] -CallName=-cmt_sep_force_class_access- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=2 - -[cmt_sep_force_struct] -CallName=-cmt_sep_force_struct- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=2 - -[cmt_sep_force_class] -CallName=-cmt_sep_force_class- -Category=5 -Description="Set the comment level for comments found in a given position :

- Before a function prototype (except if protoype is inside a function
body).
- Before a macro.
- Before a function definition.
- Before a class access specifier (public. protected...).
- Before a struct declaration.
- Before a class declaration.

A comment must already exist. If 0 is specified. the comment is not
modified by GC.
Example :
        -cmt_sep_force_fct_proto-2
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /* proto */
        extern int func(void)

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        /*
         ------------------------------------------
            proto
         ------------------------------------------
         */
        extern int func(void)

        See option(s) :
        [-no]-cmt_add_fct_def-
        [-no]-cmt_add_class_access-
" -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=3 - -[file_end_eol] -CallName=-file_end_eol- -Category=6 -Description=Set the number of EOL after the last token of the file. -EditorType=numeric -Enabled=true -MaxVal=2000 -MinVal=0 -ValueDefault=1 - -[token_ext] -CallName=-token_ext- -Category=6 -Description="Tell GC to consider the user keyword as the given C/C++ keyword.
Example :
        -token_ext-typedef$tt
        => tt has the same meaning as typedef

        -token_ext-extern$extern_all
        => extern_all has the same meaning as extern

        -token_ext-int$uint8
        -token_ext-int$uint16
        => uint8 and uint16 are some types (same as int).

        GC knows special keywordsyou can specify as a C/C++ keyword.
        GC will indent the corresponding source file word depending of the
        special word :

        -token_ext-single_word$tt
            tt will be alone on a line. Indent at the correct indentation
            level.

        -token_ext-single_word_0$tt
            tt will be alone on a line. and at column 0.

        Example :        -token_ext-single_word_0$WORD
        -token_ext-single_word_0$WORD1
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        void a(int b)
        {
            if(b)
            {
        WORD
                b++
        WORD1
            }
        }
" -EditorType=string -Enabled=false -ValueDefault= - -[replace_on] -Category=6 -Description="Ac
tivate/disactivate the word replacement mode.

        See options(s) :
        -replace-$
" -EditorType=boolean -TrueFalse=-replace_on-|-no-replace_on- -ValueDefault=1 - -[replace] -CallName=-replace- -Category=6 -Description="GC will replace all occurrences of by
.
-replace_on- option must be enabled.
Example :
        -replace-int$uint
        -replace-a$variable

        before
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        int a
        int     b

        after
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

        uint    variable
        uint    b

        See options(s) :
        [-no]-replace_on-
" -EditorType=string -Enabled=false -ValueDefault=$ - -[dependencies] -Category=6 -Description="-d
ependencies- Activate/Deactivate the output of file dependencies.
        With -dependencies_all- Real dependencies will be computed (instead of
        just includes dependencies). This option takes much longer. but does a
        better job.

        -dependencies- is ignored if -dependencies_all- is set to TRUE.

        typical report
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Processing C:oulotCourcesndent.c   (136 lines. 3360 characters)
Processing ctype.h
** Warning: Unable to open source file ==> ctype.h
Processing malloc.h
** Warning: Unable to open source file ==> malloc.h
Processing stdlib.h
** Warning: Unable to open source file ==> stdlib.h
Processing string.h
** Warning: Unable to open source file ==> string.h
Processing config.h
Processing in.h
Processing grammar.h
Processing lexi.h
Processing error.h
Processing tools.h
Processing indent.h
Processing assert.h
** Warning: Unable to open source file ==> assert.h
- Includes files --------------------------------------------------------
(     1) #include config.h
(     2) #include in.h
(     1) #include grammar.h
(     2) #include lexi.h
(     1) #include error.h
(     1) #include tools.h
(     1) #include indent.h
******** Unresolved 5 Total 12
- Scanning   1 ----------------------------------------------------------
.
- Direct dependencies ---------------------------------------------------
(     1) #include config.h
(     3) #include in.h
(     8) #include lexi.h
(     5) #include tools.h
(    21) #include indent.h
******** Total 5
- No dependencies -------------------------------------------------------
(     1) #include grammar.h
Included by C:oulotCourcesndent.c
(     1) #include error.h
Included by C:oulotCourcesndent.c
******** Total 2
-------------------------------------------------------------------------
" -EditorType=boolean -TrueFalse=-dependencies-|-no-dependencies- -ValueDefault=0 - -[dependencies_all] -Category=6 -Description="-d
ependencies- Activate/Deactivate the output of file dependencies.
        With -dependencies_all- Real dependencies will be computed (instead of
        just includes dependencies). This option takes much longer. but does a
        better job.

        -dependencies- is ignored if -dependencies_all- is set to TRUE.

        typical report
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Processing C:oulotCourcesndent.c   (136 lines. 3360 characters)
Processing ctype.h
** Warning: Unable to open source file ==> ctype.h
Processing malloc.h
** Warning: Unable to open source file ==> malloc.h
Processing stdlib.h
** Warning: Unable to open source file ==> stdlib.h
Processing string.h
** Warning: Unable to open source file ==> string.h
Processing config.h
Processing in.h
Processing grammar.h
Processing lexi.h
Processing error.h
Processing tools.h
Processing indent.h
Processing assert.h
** Warning: Unable to open source file ==> assert.h
- Includes files --------------------------------------------------------
(     1) #include config.h
(     2) #include in.h
(     1) #include grammar.h
(     2) #include lexi.h
(     1) #include error.h
(     1) #include tools.h
(     1) #include indent.h
******** Unresolved 5 Total 12
- Scanning   1 ----------------------------------------------------------
.
- Direct dependencies ---------------------------------------------------
(     1) #include config.h
(     3) #include in.h
(     8) #include lexi.h
(     5) #include tools.h
(    21) #include indent.h
******** Total 5
- No dependencies -------------------------------------------------------
(     1) #include grammar.h
Included by C:oulotCourcesndent.c
(     1) #include error.h
Included by C:oulotCourcesndent.c
******** Total 2
-------------------------------------------------------------------------
" -EditorType=boolean -TrueFalse=-dependencies_all-|-no-dependencies_all- -ValueDefault=0 - -[dependencies_dir] -CallName=-dependencies_dir- -Category=6 -Description="When -dependencies- option is activated. defines a path where GC
will find includes.
Example :
        -dependencies_dir-c:/system/includes
        -dependencies_dir-c:/GC/sources
" -EditorType=string -Enabled=false -ValueDefault=./ - -[dependencies_dir_rec] -Category=6 -Description="Al
l directories set with -dependencies_dir- are recurs scan.

        See options(s) :
        [-no]-dependencies_dir-
" -EditorType=boolean -TrueFalse=-dependencies_dir_rec-|-no-dependencies_dir_rec- -ValueDefault=0 - - - - - - - - - - - - - - - - - - - diff --git a/indenters/__TODO/uigui_hindent.ini b/indenters/__TODO/uigui_hindent.ini deleted file mode 100755 index d9767b2..0000000 --- a/indenters/__TODO/uigui_hindent.ini +++ /dev/null @@ -1,66 +0,0 @@ -[header] -categories=Basic Options -cfgFileParameterEnding=cr -configFilename= -fileTypes=*.htm|*.html|*.xhtml -indenterFileName=hindent -indenterName=hindent (HTML) -inputFileName=indentinput -inputFileParameter= -manual=http://www.linuxdriver.co.il/man/1/H/hindent -outputFileName= -outputFileParameter=stdout -parameterOrder=pio -showHelpParameter=-v -stringparaminquotes=false -useCfgFileParameter= -version=1.1.2-7 - -[Case] -Category=0 -Description="Forces all tags to lowercase. By default, hindent forces all tags to uppercase." -EditorType=boolean -TrueFalse=-c| -ValueDefault=0 - - -[Flow] -Category=0 -Description="Prints just tags without any data between the tags. Damages the HTML in a big way, so save a copy of your original HTML. This option helps you follow the HTML code flow visually." -EditorType=boolean -TrueFalse=-f| -ValueDefault=0 - -[Indent level] -CallName="-i " -Category=0 -Description="Set indentation to this many character spaces per code nesting level. If set to 0, no indentation is done (all output is left-justified)." -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=4 - -[List tags] -Category=0 -Description="Causes hindent to print a complete list of tags that it recognizes to stdout, and exits." -EditorType=boolean -TrueFalse=-l| -ValueDefault=0 - -[Strict] -Category=0 -Description="Multiple tags per line are broken out onto separate lines. Can damage the HTML in minor ways by drawing an extra space character in certain parts of the web page, so save a copy of your original HTML. This option helps you follow the HTML code flow visually, especially with computer-generated HTML that comes out all on one line." -EditorType=boolean -TrueFalse=-s| -ValueDefault=0 - -[Tab stop] -CallName="-t " -Category=0 -Description="Set the number of spaces that a tab character occupies on your system. Defaults to 8, but some people prefer expanding tabs to 4 spaces instead. If set to 0, no tabs are output (spaces used to indent lines)." -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=8 diff --git a/indenters/__TODO/uigui_htb.ini b/indenters/__TODO/uigui_htb.ini deleted file mode 100755 index c6227c0..0000000 --- a/indenters/__TODO/uigui_htb.ini +++ /dev/null @@ -1,147 +0,0 @@ -[header] -categories=Basic Options -cfgFileParameterEnding=cr -configFilename= -fileTypes=*.htm|*.html|*.xhtml|*.xml|*.xlst -indenterFileName=htb -indenterName=HTB (HTML, XML, XSL) -inputFileName=indentinput -inputFileParameter= -manual=http://www.digital-mines.com/htb/htb_docs.html -outputFileName=indentoutput -outputFileParameter= -parameterOrder=pio -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter= -version=2.0 - -[Multi-Attribute Tag Break] -Category=0 -Description="

The -a command-line option causes all tags containing more that one attribute to be broken over multiple lines, each with a single attribute. The attributes are aligned vertically with the first attribute. A similar attribute break will occur by default, but only on tags exceeding the column 80 limit, and each line may contain more than one attribute.

Before:

<BODY BGCOLOR="#FFFFFF" MARGINWIDTH="0" MARGINHEIGHT="0" LINK="#666666" VLINK="#666666" ALINK="#000000">\n<TABLE WIDTH="800" BORDER="0" CELLPADDING="0" CELLSPACING="0">\n<TR>\n<TD COLSPAN="2" WIDTH="196" BGCOLOR="cccccc" VALIGN="top"><IMG SRC="/images/homepage/rev/logo_06.gif" WIDTH="196" HEIGHT="63"></TD>\n<TD BGCOLOR="cccccc" WIDTH="600" VALIGN="top">\n<TABLE WIDTH="600" BORDER="0" CELLPADDING="0" CELLSPACING="0" VALIGN="top">\n<TR>\n<TD VALIGN="top" HEIGHT="17" BGCOLOR="#CCCCCC"><IMG SRC="/images/homepage/rev/comp8_07.gif" WIDTH="600" HEIGHT="17"></TD>\n</TR>
After: 
<BODY ALINK="#000000"\n      BGCOLOR="#FFFFFF"\n      LINK="#666666"\n      MARGINHEIGHT="0"\n      MARGINWIDTH="0"\n      VLINK="#666666">\n<TABLE BORDER="0"\n       CELLPADDING="0"\n       CELLSPACING="0"\n       WIDTH="800">\n   <TR>\n      <TD BGCOLOR="cccccc"\n          COLSPAN="2"\n          VALIGN="top"\n          WIDTH="196"><IMG HEIGHT="63"\n                           SRC="/images/homepage/rev/logo_06.gif"\n                           WIDTH="196"></TD>\n      <TD BGCOLOR="cccccc"\n          VALIGN="top"\n          WIDTH="600"> \n         <TABLE BORDER="0"\n                CELLPADDING="0"\n                CELLSPACING="0"\n                VALIGN="top"\n                WIDTH="600">\n            <TR>\n               <TD BGCOLOR="#CCCCCC"\n                   HEIGHT="17"\n                   VALIGN="top"><IMG HEIGHT="17"\n                                    SRC="/images/homepage/rev/comp8_07.gif"\n                                    WIDTH="600"></TD>\n            </TR>
" -EditorType=boolean -TrueFalse=-a| -ValueDefault=0 - - -[All Attribute Tag Break] -Category=0 -Description="

The -b command-line option causes all tag attributes to be broken on succeeding lines. The attributes are aligned vertically with the last character in the tag name.

Before:

<BODY BGCOLOR="#FFFFFF" MARGINWIDTH="0" MARGINHEIGHT="0" LINK="#666666" VLINK="#666666" ALINK="#000000">\n<TABLE WIDTH="800" BORDER="0" CELLPADDING="0" CELLSPACING="0">\n<TR>\n<TD COLSPAN="2" WIDTH="196" BGCOLOR="cccccc" VALIGN="top"><IMG SRC="/images/homepage/rev/logo_06.gif" WIDTH="196" HEIGHT="63"></TD>\n<TD BGCOLOR="cccccc" WIDTH="600" VALIGN="top">\n<TABLE WIDTH="600" BORDER="0" CELLPADDING="0" CELLSPACING="0" VALIGN="top">\n<TR>\n<TD VALIGN="top" HEIGHT="17" BGCOLOR="#CCCCCC"><IMG SRC="/images/homepage/rev/comp8_07.gif" WIDTH="600" HEIGHT="17"></TD>\n</TR>
After:
<BODY\n    ALINK="#000000"\n    BGCOLOR="#FFFFFF"\n    BOTMARGIN="0"\n    MARGINHEIGHT="0"\n    MARGINWIDTH="0"\n    LEFTMARGIN="0"\n    LINK="#666666"\n    TOPMARGIN="0"\n    VLINK="#666666">\n<TABLE\n     BORDER="0"\n     CELLPADDING="0"\n     CELLSPACING="0"\n     WIDTH="800">\n   <TR>\n      <TD\n        BGCOLOR="cccccc"\n        COLSPAN="2"\n        VALIGN="top"\n        WIDTH="196"><IMG\n                       HEIGHT="63"\n                       SRC="/images/homepage/rev/logo_06.gif"\n                       WIDTH="196"></TD>\n      <TD\n        BGCOLOR="cccccc"\n        VALIGN="top"\n        WIDTH="600"> \n         <TABLE\n              BORDER="0"\n              VALIGN="top"\n              CELLPADDING="0"\n              CELLSPACING="0"\n              WIDTH="600">\n            <TR>\n               <TD\n                 BGCOLOR="#CCCCCC"\n                 HEIGHT="17"\n                 VALIGN="top"><IMG\n                                HEIGHT="17"\n                                SRC="/images/homepage/rev/comp8_07.gif"\n                                WIDTH="600"></TD>\n            </TR>\n
" -EditorType=boolean -TrueFalse=-b| -ValueDefault=0 - -[Add Carriage Returns] -Category=0 -Description="The -c command-line option adds an extra carriage return character to each output line of reformatted data. This allows Unix versions of HTB to create a DOS/Windows compatible text files directly." -EditorType=boolean -TrueFalse=-c| -ValueDefault=0 - -[Omit Carriage Returns] -Category=0 -Description="The -d command-line option inhibits extra carriage return character output even if present in the source data. This allows the Windows version of HTB to create a Unix compatible text file directly. This is the default behavior and correctly creates a natively compatible format whether Unix or Windows." -EditorType=boolean -TrueFalse=-d| -ValueDefault=0 - -[Escaped Tag Conversion] -Category=0 -Description="The -e command-line option replaces the special markup characters '<', '>', and '&' with escape strings '<', '>', and '&' respectively. Also, the tag sequence '
' is added to the beginning of the output data and the sequence '
' is appended to the end of the data. This creates an entirely new HTML document, which when viewed with a Web Browser, will appear as source instead of normal rendering. This is useful in creating markup tag documentation and is the mechanism used to create the examples in this document. Use in combination with the -k option to do the conversion without applying other reformatting options." -EditorType=boolean -TrueFalse=-e| -ValueDefault=0 - -[Join Lines - Compress Output] -Category=0 -Description="The -j command-line option removes all unnecessary whitespace & comments and joins the output lines together whenever possible. The result is totally 'unbeautified' output, but the size will be reduced from 10-40% for quicker transfer over the network. Use this option whenever performance is more important than readability." -EditorType=boolean -TrueFalse=-j| -ValueDefault=0 - -[Keep Layout - Case Changes Only] -Category=0 -Description="

When the current indenting and appearance of your tagged document is acceptable, the -k command-line option may be used to change only the case of the tag names and attributes with no other changes applied.

Example:

- Keep the current layout of an HTML document, but change the tag attribute names to lower case (-m option, opposite of tag name case which by default is upper)...

htb -km myfile.html

Before:
<FORM ENCTYPE="multipart/form-data" NAME="coreform" METHOD="POST">\n<INPUT TYPE="submit" VALUE="Submit Request"> \n<INPUT NAME="cgi" TYPE="button" VALUE="cgi2xml">cgi2xml \n<TABLE BORDER="5" CELLPADDING="5">\n   <TR>\n      <TD> <FONT COLOR="purple"> \n         <H4>Output formatting:</H4> </FONT>Debug: \n         <INPUT NAME="debug"><BR> \n         <BR> Filter: \n         <INPUT NAME="filter"><BR> Output: \n         <INPUT NAME="output"><BR> \n         <BR> Pagestart: \n         <INPUT SIZE="4" NAME="pagestart"><BR> Pagesize: \n         <INPUT SIZE="4" NAME="pagesize"><BR> \n      </TD>\n   </TR>\n</TABLE>\n</FORM>
After:
<FORM enctype="multipart/form-data" name="coreform" method="POST">\n<INPUT type="submit" value="Submit Request"> \n<INPUT name="cgi" type="button" value="cgi2xml">cgi2xml \n<TABLE border="5" cellpadding="5">\n   <TR>\n      <TD> <FONT color="purple"> \n         <H4>Output formatting:</H4> </FONT>Debug: \n         <INPUT name="debug"><BR> \n         <BR> Filter: \n         <INPUT name="filter"><BR> Output: \n         <INPUT name="output"><BR> \n         <BR> Pagestart: \n         <INPUT size="4" name="pagestart"><BR> Pagesize: \n         <INPUT size="4" name="pagesize"><BR> \n      </TD>\n   </TR>\n</TABLE>\n</FORM>
" -EditorType=boolean -TrueFalse=-k| -ValueDefault=0 - -[Tag Names Lower Case] -Category=0 -Description="

The -l command-line option changes all HTML tag names and their attributes to lower case. Combine with the -m (mixed case) option to keep the tag names lower case, but make the attribute names upper case.

Before:

<FORM ENCTYPE="multipart/form-data" NAME="coreform" METHOD="POST">\n<INPUT TYPE="submit" VALUE="Submit Request"> \n<INPUT NAME="cgi" TYPE="button" VALUE="cgi2xml">cgi2xml \n<TABLE BORDER="5" CELLPADDING="5">\n   <TR>\n      <TD> <FONT COLOR="purple"> \n         <H4>Output formatting:</H4> </FONT>Debug: \n         <INPUT NAME="debug"><BR> \n         <BR> Filter: \n         <INPUT NAME="filter"><BR> Output: \n         <INPUT NAME="output"><BR> \n         <BR> Pagestart: \n         <INPUT SIZE="4" NAME="pagestart"><BR> Pagesize: \n         <INPUT SIZE="4" NAME="pagesize"><BR> \n      </TD>\n   </TR>\n</TABLE>\n</FORM>
After:
<form enctype="multipart/form-data" method="post" name="coreform">\n<input type="submit" value="Submit Request"> \n<input name="cgi" type="button" value="cgi2xml">cgi2xml \n<table border="5" cellpadding="5">\n   <tr>\n      <td> <font color="purple"> \n         <h4>Output formatting:</h4> </font>Debug: \n         <input name="debug"><br> \n         <br> Filter: \n         <input name="filter"><br> Output: \n         <input name="output"><br> \n         <br> Pagestart: \n         <input name="pagestart" size="4"><br> Pagesize: \n         <input name="pagesize size="4"><br> \n      </td>\n   </tr>\n</table>\n</form>\n
" -EditorType=boolean -TrueFalse=-l| -ValueDefault=0 - -[Tag Attributes Opposite Case] -Category=0 -Description="The -m command-line option makes the tag attribute case the opposite of the tag name. Since the HTB default is to make tag names upper case, the addition of this option will make the tag attributes lower case. If combined with the -l option (lower case) the tag names will be lower case, and the tag attributes will be upper case. See the -k option for an example." -EditorType=boolean -TrueFalse=-m| -ValueDefault=0 - -[Never Break Tags Between Lines] -Category=0 -Description="The -n command-line option cancels the default behavior of breaking tags which exceed the 80 column limit and keeps tags intact within a single line of output regardless of their length. This is often desirable, especially on XSL files." -EditorType=boolean -TrueFalse=-n| -ValueDefault=0 - -[Remove Non-HTML Tags] -Category=0 -Description="

The -r command-line option strips any tag which is not part of the HTML 4.01 specification (and a group of widely recognized, commonly used legacy tags) from the output. Its a convenient way to separate HTML from hybrid files like ASP, JSP, XSL or files containing custom tags. The stripped tags are reported along with any errors to "standard error".

Example:

- Remove all non-HTML tags from an XSL/XHTML file...

htb -r myfile.xsl

Before:
\n   <xsl:for-each select="ELEMENT/NODE1"> \n      <xsl:variable select="position()-1" name="vpos" /> \n      <TR VALIGN="top">\n         <TD ALIGN="center"><FONT SIZE="1" FACE="Helvetica"><xsl:value-of select="$vpos" /></FONT> \n         </TD>\n         <TD ALIGN="center"><FONT FACE="Helvetica"> \n            <INPUT NAME="ELEM{$vpos}" TYPE="text" VALUE="Element {$vpos}" /></FONT> \n         </TD>\n         <TD ALIGN="center"><FONT FACE="Helvetica"> \n            <INPUT NAME="NUMB{$vpos}" TYPE="text" VALUE="2" /></FONT> \n         </TD>\n         <TD ALIGN="center"><FONT FACE="Helvetica"> \n            <xsl:variable select="count(//NODE1[@id &gt; -1)" name="pcnt" /> \n            <xsl:variable name="selsize"> \n               <xsl:choose><xsl:when test="$pcnt &lt; 5"> \n                  <xsl:value-of select="$pcnt" /> \n               </xsl:when><xsl:otherwise> \n                  <xsl:value-of select="'5'" /> \n               </xsl:otherwise></xsl:choose> \n            </xsl:variable> \n            <SELECT SIZE="{$selsize}" NAME="VALU{$vpos}">\n               <xsl:for-each select="//VALUE[@id &gt; -1]"> \n                  <OPTION VALUE="{@id}">\n                  <xsl:value-of select="NAME" /></OPTION> \n               </xsl:for-each> \n            </SELECT></FONT> \n         </TD>\n      </TR>\n   </xsl:for-each>
After: 
\n   <TR VALIGN="top">\n      <TD ALIGN="center"><FONT FACE="Helvetica" SIZE="1"></FONT> \n      </TD>\n      <TD ALIGN="center"><FONT FACE="Helvetica"> \n         <INPUT NAME="ELEM{$vpos}" TYPE="text" VALUE="Element {$vpos}" /></FONT> \n      </TD>\n      <TD ALIGN="center"><FONT FACE="Helvetica"> \n         <INPUT NAME="NUMB{$vpos}" TYPE="text" VALUE="2" /></FONT> \n      </TD>\n      <TD ALIGN="center"><FONT FACE="Helvetica"> \n         <SELECT NAME="VALU{$vpos}" SIZE="{$selsize}">\n            <OPTION VALUE="{@id}"></OPTION>\n         </SELECT></FONT> \n      </TD>\n   </TR>
" -EditorType=boolean -TrueFalse=-r| -ValueDefault=0 - -[Remove Tabs from SCRIPTs] -Category=0 -Description="HTB automatically removes any tab characters found in the source document during the indenting process, but by default SCRIPTs are kept intact. To completely remove all tabs, specify the -s option and tab characters found within SCRIPT elements will be replaced with sets if of indented spaces. This could make the indented script statements look slightly worse and may require minor editing, but the beautified output is clear of any tab characters." -EditorType=boolean -TrueFalse=-r| -ValueDefault=0 - -[Convert to Plain Text] -Category=0 -Description="The -t command-line option strips all markup tags, comments and converts the input to plain text. All ASCII and ISO8859-1 HTML escape strings are converted back to the characters they represent. An attempt is made to compress extra whitespace, but in general the text will require additional re-formatting to be made presentable. Use this option to isolate the textual content within tagged documents (not necessarily HTML) for use in other documentation." -EditorType=boolean -TrueFalse=-t| -ValueDefault=0 - -[Tag Names Upper Case] -Category=0 -Description="

The -u command-line option changes all HTML tag names and their attributes to upper case. Since this is the default behavior of HTB, it is not required. Use the -m (mixed case) option to keep the tag names upper case, but make the attribute names lower case.

Before:

<form enctype="multipart/form-data" name="coreform" method="POST">\n<input type="submit" value="Submit Request"> \n<input name="cgi" type="button" value="cgi2xml">cgi2xml \n<table border="5" cellpadding="5">\n   <tr>\n      <td> <font color="purple"> \n         <h4>Output formatting:</h4> </font>Debug: \n         <input name="debug"><br> \n         <br> Filter: \n         <input name="filter"><br> Output: \n         <input name="output"><br> \n         <br> Pagestart: \n         <input size="4" name="pagestart"><br> Pagesize: \n         <input size="4" name="pagesize"><br> \n      </td>\n   </tr>\n</table>\n</form>
After:
<FORM ENCTYPE="multipart/form-data" METHOD="POST" NAME="coreform">\n<INPUT TYPE="submit" VALUE="Submit Request"> \n<INPUT NAME="cgi" TYPE="button" VALUE="cgi2xml">cgi2xml \n<TABLE BORDER="5" CELLPADDING="5">\n   <TR>\n      <TD> <FONT COLOR="purple"> \n         <H4>Output formatting:</H4> </FONT>Debug: \n         <INPUT NAME="debug"><BR> \n         <BR> Filter: \n         <INPUT NAME="filter"><BR> Output: \n         <INPUT NAME="output"><BR> \n         <BR> Pagestart: \n         <INPUT NAME="pagestart" SIZE="4"><BR> Pagesize: \n         <INPUT NAME="pagesize" SIZE="4"><BR> \n      </TD>\n   </TR>\n</TABLE>\n</FORM>
" -EditorType=boolean -TrueFalse=-u| -ValueDefault=0 - -[Unknown Tags are XML] -Category=0 -Description="

HTB automatically detects XML compliant files and is able to apply reformatting to unknown tags since they meet the predictable behavior of the XML specification. If the input document is not strictly XML compliant, but does contain custom tagging which may be considered "well-formed" XML, the -x option may be used to apply XML handling on these otherwise ignored tags. If XML is detected, either automatically, or with the -x option, the tag case is NOT changed for these non-HTML tags, since they are often case-sensitive. Also, the attributes of unknown tags will remain in original order instead of being sorted as with HTML attributes. To turn off XML auto-detection and apply case changes and attribute sorting to all tags known and unknown, use the -y option.

Example:

- Make tag names and attributes lower case, never break tags, and treat unknown tags in an HTML file as well formed XML...

htb -lnx myfile.html

Before:
<TR><TD WIDTH=182 ALIGN=left BGCOLOR="#ffffff">\n<NYT_HEADLINE>\n<A\n\nHREF="/onthisday/20020619.html"><FONT SIZE="3" FACE="times"><B>On June 19 ...<BR></B></FONT></A>\n</NYT_HEADLINE>\n<NYT_BYLINE>\n<FONT SIZE="-1"></FONT>\n</NYT_BYLINE>\n<NYT_SUMMARY>\n<FONT SIZE="-1">\n<B>1964:</B> The Civil Rights Act of 1964 was approved.   (<A \nHREF="/onthisday/big/0619.html">See this front page.</A>) <BR>\n<B>1903:</B> Lou Gehrig was born.  <A \nHREF="/onthisday/bday/0619.html">(Read about his life.)</A> <BR>\n<B>1886:</B> Harper's Weekly featured a cartoon about the proposed annexation of Nova Scotia. <A \nHREF="/onthisday/harp/0619.html">(See the cartoon.)</A></FONT>\n</TD></TR>
After:
<tr>\n   <td align="left" bgcolor="#ffffff" width="182"> \n      <NYT_HEADLINE> \n         <a href="/onthisday/20020619.html"><font face="times" size="3"><b>On June 19 ...<br></b></font></a> \n      </NYT_HEADLINE> \n      <NYT_BYLINE> <font size="-1"></font> \n      </NYT_BYLINE> \n      <NYT_SUMMARY> <font size="-1"> <b>1964:</b> The Civil Rights Act of 1964 was approved. (<a href="/onthisday/big/0619.html">See this front page.</a>) \n         <br> <b>1903:</b> Lou Gehrig was born. \n         <a href="/onthisday/bday/0619.html">(Read about his life.)</a> \n         <br> <b>1886:</b> Harper's Weekly featured a cartoon about the proposed annexation of Nova Scotia. \n         <a href="/onthisday/harp/0619.html">(See the cartoon.)</a></font> \n   </td>\n</tr>
" -EditorType=boolean -TrueFalse=-x| -ValueDefault=0 - -[Turn off XML detection] -Category=0 -Description="

HTB automatically detects XML compliant files and treats the unknown tags differently than HTML tags. XML tags are indented as whitespace permits and case changes & attribute sorting are not applied. To turn off this default behavior and apply case changes & sorting to all tags known and unknown, specify the -y option.

Example:

- Never break tags, make all tags lower case whether HTML or not, and do not change indenting for unknown tags...

htb -lny myfile.html

Before: 
<TR><TD WIDTH=182 ALIGN=left BGCOLOR="#ffffff">\n<NYT_HEADLINE>\n<A\n\nHREF="/onthisday/20020619.html"><FONT SIZE="3" FACE="times"><B>On June 19 ...<BR></B></FONT></A>\n</NYT_HEADLINE>\n<NYT_BYLINE>\n<FONT SIZE="-1"></FONT>\n</NYT_BYLINE>\n<NYT_SUMMARY>\n<FONT SIZE="-1">\n<B>1964:</B> The Civil Rights Act of 1964 was approved.   (<A \nHREF="/onthisday/big/0619.html">See this front page.</A>) <BR>\n<B>1903:</B> Lou Gehrig was born.  <A \nHREF="/onthisday/bday/0619.html">(Read about his life.)</A> <BR>\n<B>1886:</B> Harper's Weekly featured a cartoon about the proposed annexation of Nova Scotia. <A \nHREF="/onthisday/harp/0619.html">(See the cartoon.)</A></FONT>\n</TD></TR>
After:
<tr>\n   <td align="left" bgcolor="#ffffff" width="182"> \n      <nyt_headline> \n      <a href="/onthisday/20020619.html"><font face="times" size="3"><b>On June 19 ...<br></b></font></a> \n      </nyt_headline> \n      <nyt_byline> <font size="-1"></font> \n      </nyt_byline> \n      <nyt_summary> <font size="-1"> <b>1964:</b> The Civil Rights Act of 1964 was approved. (<a href="/onthisday/big/0619.html">See this front page.</a>) \n      <br> <b>1903:</b> Lou Gehrig was born. \n      <a href="/onthisday/bday/0619.html">(Read about his life.)</a> \n      <br> <b>1886:</b> Harper's Weekly featured a cartoon about the proposed annexation of Nova Scotia. \n      <a href="/onthisday/harp/0619.html">(See the cartoon.)</a></font> \n   </td>\n</tr>
" -EditorType=boolean -TrueFalse=-y| -ValueDefault=0 - -[Remove Comments] -Category=0 -Description="The -z command-line option removes all stand-alone comments from the input data. This does not include JavaScript comments or comment blocks within APPLET, OBJECT, SCRIPT, and STYLE tags used to hide text from browsers. The revised output should render and function as the original. The -z option is useful in reducing tagged file sizes when the comment blocks are no longer needed, or in removing dead, commented-out sections within documents which tend to collect over time. The stripped comments are not lost, however. These are sent to the 'standard error' stream and may be collected in another file for reference or for use in documentation by 'standard error' redirection ('2>' or '2>>'). If 'standard error' is not redirected, the stripped comments will be seen scrolling by on the screen. Use in combination with the -k option to strip comments without otherwise changing the document layout." -EditorType=boolean -TrueFalse=-z| -ValueDefault=0 - -[Spaces for Indenting] -CallName="-" -Category=0 -Description="A command-line option from 0 to 9 represents the number of spaces used for increments of indenting. Specifying 0 will cause all indenting to be removed and the tags will shifted to the left. If not specified, the default is to indent by 3." -EditorType=numeric -Enabled=false -MaxVal=9 -MinVal=0 -ValueDefault=3 diff --git a/indenters/__TODO/uigui_jsdecoder.ini b/indenters/__TODO/uigui_jsdecoder.ini deleted file mode 100755 index f22ea7b..0000000 --- a/indenters/__TODO/uigui_jsdecoder.ini +++ /dev/null @@ -1,17 +0,0 @@ -[header] -categories= -cfgFileParameterEnding=cr -configFilename= -fileTypes=*.js -indenterFileName=JsDecoder -indenterName=JsDecoder (JavaScript) -inputFileName= -inputFileParameter= -manual="http://www.gosu.pl/decoder/" -outputFileName= -outputFileParameter= -parameterOrder= -showHelpParameter= -stringparaminquotes= -useCfgFileParameter= -version=1.1.0 diff --git a/indenters/__TODO/uigui_jsppp.ini b/indenters/__TODO/uigui_jsppp.ini deleted file mode 100755 index 53c886c..0000000 --- a/indenters/__TODO/uigui_jsppp.ini +++ /dev/null @@ -1,81 +0,0 @@ -[header] -categories=General options -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.jsp|*.html|*.xml -indenterFileName=jsppp -indenterName=JSPPP (JSP) -inputFileName=indentinput -inputFileParameter= -manual=http://jsppp.sourceforge.net/ -outputFileName=indentinput -outputFileParameter=none -stringparaminquotes=false -parameterOrder=pio -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter= -version=0.5.2a - -[Spaces] -Category=0 -Description="If spaces is true, spaces, not tabs, will be used to indent the lines." -EditorType=boolean -TrueFalse=|--tabs -ValueDefault=1 - -[Number of spaces] -Category=0 -Description="If spaces are used for indenting, NUMSPACES is the number of spaces to use per indent level." -Enabled=true -EditorType=numeric -CallName="--spaces=" -MinVal=0 -MaxVal=999 -ValueDefault=2 - -[Line length] -Category=0 -Description="The length, in bytes (JSPPP does not yet support Unicode input, no one has asked for it yet) of the soft line length limit. JavaScript, long element names, attributes, etc., that cannot be broken up will end up over the limit if they have already been indented too far." -Enabled=false -EditorType=numeric -CallName="--length=" -MinVal=1 -MaxVal=9999 -ValueDefault=120 - -[Tabsize] -Category=0 -Description="The default number of spaces per tab is 8. This number is used to determine how much of the line has been used by a tab." -Enabled=false -EditorType=numeric -CallName="--tab-size=" -MinVal=0 -MaxVal=999 -ValueDefault=8 - -[Punctuation] -Category=0 -Description="PUNCTUATION is a list of characters which should be handled specially after an anchor tag. If there is whitespace after a link tag but before one of these characters then the whitespace is removed. To have no special characters, use the line "PUNCTUATION="." -Enabled=false -CallName=PUNCTUATION= -EditorType=string -ValueDefault=",.!?" - -[Loose or tight spacing] -Category=0 -Description="Use loose or tight spacing." -Enabled=true -EditorType=multiple -Choices="--loose-spacing|--tight-spacing" -ChoicesReadable="Loose spacing|Tight spacing" -ValueDefault=0 - -[Backup file] -Category=0 -Description="Leave a backup file, which will be overwritten on a second run, or leave no backup file at all." -Enabled=true -EditorType=multiple -Choices="--engage-safety|--disengage-safety" -ChoicesReadable="Leave backup file|Leave NO backup file" -ValueDefault=1 diff --git a/indenters/__TODO/uigui_perltidy.ini b/indenters/__TODO/uigui_perltidy.ini deleted file mode 100755 index bf2587b..0000000 --- a/indenters/__TODO/uigui_perltidy.ini +++ /dev/null @@ -1,1040 +0,0 @@ -[header] -categories=Styles|Basic Options|Code Indentation Control|Whitespace Control|Comment Controls|Skip Selected Codesections|Line Break Control|Controlling List Formatting|Retaining or Ignoring Existing Line Breaks|Blank Line Control|Other Controls -cfgFileParameterEnding=cr -configFilename=perltidy.cfg -fileTypes=*.pl|*.pm -indenterFileName=perltidy -indenterName=Perltidy (Perl) -inputFileName=indentinput -inputFileParameter= -manual=http://perltidy.sourceforge.net/perltidy.html -outputFileName=indentoutput -outputFileParameter="-o=" -parameterOrder=pio -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter="-pro=" -version=1.74 2010/12/17 - -[Iterations] -CallName="--iterations=" -Category=1 -Description="This flag causes perltidy to do n complete iterations. For most purposes the default of n=1 should be satisfactory. However n=2 can be useful when a major style change is being made, or when code is being beautified on check-in to a source code control system. The run time will be approximately proportional to n, and it should seldom be necessary to use a value greater than n=2." -EditorType=numeric -Enabled=false -MaxVal=10 -MinVal=1 -ValueDefault=1 - -[Add newlines] -Category=6 -Description="

By default, perltidy will add line breaks when necessary to create continuations of long lines and to improve the script appearance. Use -nanl or --noadd-newlines to prevent any new line breaks.

This flag does not prevent perltidy from eliminating existing line breaks; see --freeze-newlines to completely prevent changes to line break points.

" -EditorType=boolean -TrueFalse=-anl|-nanl -ValueDefault=0 - -[Add semicolons] -Category=3 -Description="

Setting -asc allows perltidy to add any missing optional semicolon at the end of a line which is followed by a closing curly brace on the next line. This is the default, and may be deactivated with -nasc or --noadd-semicolons.

" -EditorType=boolean -TrueFalse=--add-semicolons| -ValueDefault=0 - -[Add whitespace] -Category=3 -Description="

Setting this option allows perltidy to add certain whitespace improve code readability. This is the default. If you do not want any whitespace added, but are willing to have some whitespace deleted, use -naws. (Use -fws to leave whitespace completely unchanged).

" -EditorType=boolean -TrueFalse=--add-whitespace| -ValueDefault=0 - -[Block brace tightness] -CallName="--block-brace-tightness=" -Category=3 -Description="

And finally, curly braces which contain blocks of code are controlled by the parameter -bbt=n or --block-brace-tightness=n as illustrated in the example below.

\n %bf = map { $_ => -M $_ } grep { /deb$/ } dirents '.'; # -bbt=0 (default)\n %bf = map { $_ => -M $_ } grep {/deb$/} dirents '.';   # -bbt=1\n %bf = map {$_ => -M $_} grep {/deb$/} dirents '.';     # -bbt=2
" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=1 - -[Block brace vertical tightness] -CallName="--block-brace-vertical-tightness=" -Category=6 -Description="

The -bbvt=n flag is just like the -vt=n flag but applies to opening code block braces.

\n -bbvt=0 break after opening block brace (default). \n -bbvt=1 do not break unless this would produce more than one \n         step in indentation in a line.\n -bbvt=2 do not break after opening block brace.

It is necessary to also use either -bl or -bli for this to work, because, as with other vertical tightness controls, it is implemented by simply overwriting a line ending with an opening block brace with the subsequent line. For example:

\n    # perltidy -bli -bbvt=0\n    if ( open( FILE, "< $File" ) )\n      {\n        while ( $File = <FILE> )\n          {\n            $In .= $File;\n            $count++;\n          }\n        close(FILE);\n      }
\n    # perltidy -bli -bbvt=1\n    if ( open( FILE, "< $File" ) )\n      { while ( $File = <FILE> )\n          { $In .= $File;\n            $count++;\n          }\n        close(FILE);\n      }

By default this applies to blocks associated with keywords if, elsif, else, unless, for, foreach, sub, while, until, and also with a preceding label. This can be changed with the parameter -bbvtl=string, or --block-brace-vertical-tightness-list=string, where string is a space-separated list of block types. For more information on the possible values of this string, see Specifying Block Types

For example, if we want to just apply this style to if, elsif, and else blocks, we could use perltidy -bli -bbvt=1 -bbvtl='if elsif else'.

There is no vertical tightness control for closing block braces; with the exception of one-line blocks, they will normally remain on a separate line.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Brace left and indent] -Category=6 -Description="

The flag -bli is the same as -bl but in addition it causes one unit of continuation indentation ( see -ci ) to be placed before an opening and closing block braces.

For example,

\n        if ( $input_file eq '-' )    # -bli\n          {\n            important_function();\n          }

By default, this extra indentation occurs for blocks of type:if, elsif, else, unless, for, foreach, sub, while, until, and also with a preceding label. The next item shows how to change this.

" -EditorType=boolean -TrueFalse=-bli| -ValueDefault=0 - -[Brace left and indent list] -CallName="--brace-left-and-indent-list=" -Category=6 -Description="

Use this parameter to change the types of block braces for which the -bli flag applies; see Specifying Block Types. For example, -blil='if elsif else' would apply it to only if/elsif/else blocks.

" -EditorType=string -Enabled=false -ValueDefault= - -[Brace tightness] -CallName="--brace-tightness=" -Category=3 -Description="

Curly braces which do not contain code blocks are controlled by the parameter -bt=n or --brace-tightness=n.

\n $obj->{ $parsed_sql->{ 'table' }[0] };    # -bt=0\n $obj->{ $parsed_sql->{'table'}[0] };      # -bt=1 (default)\n $obj->{$parsed_sql->{'table'}[0]};        # -bt=2
" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=1 - -[Brace vertical tightness] -CallName="--brace-vertical-tightness=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Brace vertical tightness closing] -CallName="--brace-vertical-tightness-closing=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Break after all operators] -Category=6 -Description="

The -baao sets the default to be to break after all of the following operators:

\n    % + - * / x != == >= <= =~ !~ < > | & \n    = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=\n    . : ? && || and or err xor

and the -bbao flag sets the default to break before all of these operators. These can be used to define an initial break preference which can be fine-tuned with the -wba and -wbb flags. For example, to break before all operators except an = one could use --bbao -wba='=' rather than listing every single perl operator except = on a -wbb flag.

" -EditorType=boolean -TrueFalse=-baao| -ValueDefault=0 - -[Break before all operators] -Category=6 -Description="

The -baao sets the default to be to break after all of the following operators:

\n    % + - * / x != == >= <= =~ !~ < > | & \n    = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=\n    . : ? && || and or err xor

and the -bbao flag sets the default to break before all of these operators. These can be used to define an initial break preference which can be fine-tuned with the -wba and -wbb flags. For example, to break before all operators except an = one could use --bbao -wba='=' rather than listing every single perl operator except = on a -wbb flag.

" -EditorType=boolean -TrueFalse=-bbao| -ValueDefault=0 - -[Check syntax] -Category=1 -Description="This flag causes perltidy to run perl -c -T to check syntax of input and output. (To change the flags passed to perl, see the next item, -pscf). The results are written to the .LOG file, which will be saved if an error is detected in the output script. The output script is not checked if the input script has a syntax error. Perltidy does its own checking, but this option employs perl to get a ``second opinion''.

If perl reports errors in the input file, they will not be reported in the error output unless the --warning-output flag is given.

The default is not to do this type of syntax checking (although perltidy will still do as much self-checking as possible). The reason is that it causes all code in BEGIN blocks to be executed, for all modules being used, and this opens the door to security issues and infinite loops when running perltidy." -EditorType=boolean -Enabled=false -TrueFalse=--check-syntax| -ValueDefault=0 - -[Closing Side Comment Else Flag] -CallName="--closing-side-comment-else-flag=" -Category=4 -Description="

The default, n=0, places the text of the opening if statement after any terminal else.

If n=2 is used, then each elsif is also given the text of the opening if statement. Also, an else will include the text of a preceding elsif statement. Note that this may result some long closing side comments.

If n=1 is used, the results will be the same as n=2 whenever the resulting line length is less than the maximum allowed.

" -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=0 - -[Closing Side Comment Interval] -CallName="--closing-side-comment-interval=" -Category=4 -Description="

where n is the minimum number of lines that a block must have in order for a closing side comment to be added. The default value is n=6. To illustrate:

\n        # perltidy -csci=2 -csc\n        sub message {\n            if ( !defined( $_[0] ) ) {\n                print("Hello, World\n");\n            } ## end if ( !defined( $_[0] ))\n            else {\n                print( $_[0], "\n" );\n            } ## end else [ if ( !defined( $_[0] ))\n        } ## end sub message

Now the if and else blocks are commented. However, now this has become very cluttered.

" -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=6 - -[Closing Side Comment List] -CallName="--closing-side-comment-list=" -Category=4 -Description="

where string is a list of block types to be tagged with closing side comments. By default, all code block types preceded by a keyword or label (such as if, sub, and so on) will be tagged. The -cscl command changes the default list to be any selected block types; see Specifying Block Types. For example, the following command requests that only sub's, labels, BEGIN, and END blocks be affected by any -csc or -dcsc operation:

\n   -cscl="sub : BEGIN END"
" -EditorType=string -Enabled=false -ValueDefault= - -[Closing Side Comment Maximum Text] -CallName="--closing-side-comment-maximum-text=" -Category=4 -Description="

The text appended to certain block types, such as an if block, is whatever lies between the keyword introducing the block, such as if, and the opening brace. Since this might be too much text for a side comment, there needs to be a limit, and that is the purpose of this parameter. The default value is n=20, meaning that no additional tokens will be appended to this text after its length reaches 20 characters. Omitted text is indicated with .... (Tokens, including sub names, are never truncated, however, so actual lengths may exceed this). To illustrate, in the above example, the appended text of the first block is ( !defined( $_[0] ).... The existing limit of n=20 caused this text to be truncated, as indicated by the ....

" -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=20 - -[Closing Side Comments Balanced] -Category=4 -Description="

As discussed in the previous item, when the closing-side-comment-maximum-text limit is exceeded the comment text must be truncated. Older versions of perltidy terminated with three dots, and this can still be achieved with -ncscb:

\n  perltidy -csc -ncscb\n  } ## end foreach my $foo (sort { $b cmp $a ...

However this causes a problem with editors editors which cannot recognize comments or are not configured to do so because they cannot "bounce" around in the text correctly. The -cscb flag has been added to help them by appending appropriate balancing structure:

\n  perltidy -csc -cscb\n  } ## end foreach my $foo (sort { $b cmp $a ... })

The default is -cscb.

" -EditorType=boolean -TrueFalse=--closing-side-comments-balanced|-ncscb -ValueDefault=1 - -[Closing Side Comment Prefix] -CallName="--closing-side-comment-prefix=" -Category=4 -Description="

where string is the prefix used before the name of the block type. The default prefix, shown above, is ## end. This string will be added to closing side comments, and it will also be used to recognize them in order to update, delete, and format them. Any comment identified as a closing side comment will be placed just a single space to the right of its closing brace.

" -EditorType=string -Enabled=false -ValueDefault=## end - -[Closing Side Comment Warnings] -Category=4 -Description="

This parameter is intended to help make the initial transition to the use of closing side comments. It causes two things to happen if a closing side comment replaces an existing, different closing side comment: first, an error message will be issued, and second, the original side comment will be placed alone on a new specially marked comment line for later attention.

The intent is to avoid clobbering existing hand-written side comments which happen to match the pattern of closing side comments. This flag should only be needed on the first run with -csc.

" -EditorType=boolean -TrueFalse=--closing-side-comment-warnings| -ValueDefault=0 - -[Closing Side Comments] -Category=4 -Choices=-csc|-dcsc -ChoicesReadable=Add Closing Side Comments|Delete Closing Side Comments -Description="

A closing side comment is a special comment which perltidy can automatically create and place after the closing brace of a code block. They can be useful for code maintenance and debugging. The command -csc (or --closing-side-comments) adds or updates closing side comments. For example, here is a small code snippet

\n        sub message {\n            if ( !defined( $_[0] ) ) {\n                print("Hello, World\n");\n            }\n            else {\n                print( $_[0], "\n" );\n            }\n        }

And here is the result of processing with perltidy -csc:

\n        sub message {\n            if ( !defined( $_[0] ) ) {\n                print("Hello, World\n");\n            }\n            else {\n                print( $_[0], "\n" );\n            }\n        } ## end sub message

A closing side comment was added for sub message in this case, but not for the if and else blocks, because they were below the 6 line cutoff limit for adding closing side comments. This limit may be changed with the -csci command, described below.

The command -dcsc (or --delete-closing-side-comments) reverses this process and removes these comments.

Several commands are available to modify the behavior of these two basic commands, -csc and -dcsc:

" -EditorType=multiple -Enabled=false -ValueDefault=0 - -[Closing token indentation] -CallName="--closing-token-indentation=" -Category=2 -Description="The -cti=n flag controls the indentation of a line beginning with a ), ], or a non-block }. Such a line receives:

\n -cti = 0 no extra indentation (default)\n -cti = 1 extra indentation such that the closing token\n        aligns with its opening token.\n -cti = 2 one extra indentation level if the line looks like:\n        );  or  ];  or  };\n -cti = 3 one extra indentation level always

The flags -cti=1 and -cti=2 work well with the -lp flag (previous section).

\n    # perltidy -lp -cti=1\n    @month_of_year = (\n                       'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n                       'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n                     );
\n    # perltidy -lp -cti=2\n    @month_of_year = (\n                       'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n                       'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n                       );

These flags are merely hints to the formatter and they may not always be followed. In particular, if -lp is not being used, the indentation forcti=1 is constrained to be no more than one indentation level.

If desired, this control can be applied independently to each of theclosing container token types. In fact, -cti=n is merely anabbreviation for -cpi=n -csbi=n -cbi=n, where: -cpi or --closing-paren-indentation controls )'s,-csbi or --closing-square-bracket-indentation controls ]'s, -cbi or --closing-brace-indentation controls non-block }'s." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=0 - -[Continuation indentation] -CallName="--continuation-indentation=" -Category=2 -Description="Continuation indentation is extra indentation spaces applied whena long line is broken. The default is n=2, illustrated here:

 my $level =   # -ci=2   ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;

The same example, with n=0, is a little harder to read:

 my $level =   # -ci=0 ( $max_index_to_go >= 0 ) ? $levels_to_go[0] : $last_output_level;

The value given to -ci is also used by some commands when a small space is required. Examples are commands for outdenting labels, -ola, and control keywords, -okw.

When default values are not used, it is suggested that the value n given with -ci=n be no more than about one-half of the number of spaces assigned to a full indentation level on the -i=n command." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=2 - -[Cuddled else] -Category=6 -Description="

Enable the ``cuddled else'' style, in which else and elsif are follow immediately after the curly brace closing the previous block. The default is not to use cuddled elses, and is indicated with the flag -nce or --nocuddled-else. Here is a comparison of the alternatives:

\n  if ($task) {\n      yyy();\n  } else {    # -ce\n      zzz();\n  }
\n  if ($task) {\n        yyy();\n  }\n  else {    # -nce  (default)\n        zzz();\n  }
" -EditorType=boolean -TrueFalse=-ce|-nce -ValueDefault=0 - -[Delete old newlines] -Category=6 -Description="

By default, perltidy first deletes all old line break locations, and then it looks for good break points to match the desired line length. Use -ndnl or --nodelete-old-newlines to force perltidy to retain all old line break points.

" -EditorType=boolean -TrueFalse=-dnl|-ndnl -ValueDefault=0 - -[Delete old whitespace] -Category=3 -Description="

Setting this option allows perltidy to remove some old whitespace between characters, if necessary. This is the default. If you do not want any old whitespace removed, use -ndws or --nodelete-old-whitespace.

" -EditorType=boolean -TrueFalse=--delete-old-whitespace| -ValueDefault=0 - -[Delete semicolons] -Category=3 -Description="

Setting -dsm allows perltidy to delete extra semicolons which are simply empty statements. This is the default, and may be deactivated with -ndsm or --nodelete-semicolons. (Such semicolons are not deleted, however, if they would promote a side comment to a block comment).

" -EditorType=boolean -TrueFalse=--delete-semicolons| -ValueDefault=0 - -[Entab leading whitespace] -CallName="--entab-leading-whitespace=" -Category=1 -Description="This flag causes each n initial space characters to be replaced by one tab character. Note that the integer n is completely independent of the integer specified for indentation parameter, -i=n." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=4 - -[Feeze newlines] -Category=6 -Description="

If you do not want any changes to the line breaks in your script, set -fnl, and they will remain fixed, and the rest of the commands in this section and sections Controlling List Formatting, Retaining or Ignoring Existing Line Breaks, and Blank Line Control will be ignored. You may want to use -noll with this.

" -EditorType=boolean -TrueFalse=-fnl| -ValueDefault=0 - -[Fixed position side comment] -CallName="--fixed-position-side-comment=" -Category=4 -Description="

This parameter tells perltidy to line up side comments in column number n whenever possible. The default, n=0, is not do do this.

" -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=0 - -[Format skipping] -Category=5 -Description="

Selected lines of code may be passed verbatim to the output without any formatting. This feature is enabled by default but can be disabled with the --noformat-skipping or -nfs flag. It should be used sparingly to avoid littering code with markers, but it might be helpful for working around occasional problems. For example it might be useful for keeping the indentation of old commented code unchanged, keeping indentation of long blocks of aligned comments unchanged, keeping certain list formatting unchanged, or working around a glitch in perltidy.

-fs, --format-skipping

This flag, which is enabled by default, causes any code between special beginning and ending comment markers to be passed to the output without formatting. The default beginning marker is #<<< and the default ending marker is #>>> but they may be changed (see next items below). Additional text may appear on these special comment lines provided that it is separated from the marker by at least one space. For example

\n #<<<  do not let perltidy touch this\n    my @list = (1,\n                1, 1,\n                1, 2, 1,\n                1, 3, 3, 1,\n                1, 4, 6, 4, 1,);\n #>>>

The comment markers may be placed at any location that a block comment may appear. If they do not appear to be working, use the -log flag and examine the .LOG file. Use -nfs to disable this feature.

" -EditorType=boolean -TrueFalse=-fs|-nfs -ValueDefault=1 - -[Format skipping begin] -CallName="--format-skipping-begin=" -Category=5 -Description="

The -fsb=string parameter may be used to change the beginning marker for format skipping. The default is equivalent to -fsb='#<<<'. The string that you enter must begin with a # and should be in quotes as necessary to get past the command shell of your system. It is actually the leading text of a pattern that is constructed by appending a '', so you must also include backslashes for characters to be taken literally rather than as patterns.

Some examples show how example strings become patterns:

\n -fsb='#' becomes /^#/  which matches  #{{{ but not #{{{{\n -fsb='#'   becomes /^#/    which matches  #** but not #***\n -fsb='#{2,}' becomes /^#{2,}/  which matches  #** and #*****
" -EditorType=string -Enabled=false -ValueDefault=#<<< - -[Format skipping end] -CallName="--format-skipping-end=" -Category=5 -Description="

The -fsb=string is the corresponding parameter used to change the ending marker for format skipping. The default is equivalent to -fse='#<<<'.

" -EditorType=string -Enabled=false -ValueDefault=#<<< - -[Freeze whitespace] -Category=3 -Description="This flag causes your original whitespace to remain unchanged, and causes the rest of the whitespace commands in this section, the Code Indentation section, and the Comment Control section to be ignored." -EditorType=boolean -TrueFalse=--freeze-whitespace| -ValueDefault=0 - -[Gnu style] -Category=0 -Description="

-gnu gives an approximation to the GNU Coding Standards (which do not apply to perl) as they are sometimes implemented. At present, this style overrides the default style with the following parameters:

\n    -lp -bl -noll -pt=2 -bt=2 -sbt=2 -icp
" -EditorType=boolean -Enabled=false -TrueFalse=--gnu-style| -ValueDefault=0 - -[Hanging side comments] -Category=4 -Description="

By default, perltidy tries to identify and align ``hanging side comments'', which are something like this:

\n        my $IGNORE = 0;    # This is a side comment\n                           # This is a hanging side comment\n                           # And so is this

A comment is considered to be a hanging side comment if (1) it immediately follows a line with a side comment, or another hanging side comment, and (2) there is some leading whitespace on the line. To deactivate this feature, use -nhsc or --nohanging-side-comments. If block comments are preceded by a blank line, or have no leading whitespace, they will not be mistaken as hanging side comments.

" -EditorType=boolean -TrueFalse=-hsc|-nhsc -ValueDefault=0 - -[Indent block comments] -Category=4 -Description="

Block comments normally look best when they are indented to the same level as the code which follows them. This is the default behavior, but you may use -nibc to keep block comments left-justified. Here is an example:

\n             # this comment is indented      (-ibc, default)\n             if ($task) { yyy(); }

The alternative is -nibc:

\n # this comment is not indented              (-nibc)\n             if ($task) { yyy(); }

See also the next item, -isbc, as well as -sbc, for other ways to have some indented and some outdented block comments.

" -EditorType=boolean -TrueFalse=-ibc|-nibc -ValueDefault=1 - -[Indent closing brace] -Category=2 -Description="The -icb option gives one extra level of indentation to a brace which terminates a code block . For example,

\n        if ($task) {\n            yyy();\n            }    # -icb\n        else {\n            zzz();\n            }

The default is not to do this, indicated by -nicb." -EditorType=boolean -TrueFalse=--indent-closing-brace| -ValueDefault=0 - -[Indent closing paren] -Category=2 -Description="The -icp flag is equivalent to-cti=2, described in the previous section. The -nicp flag is equivalent -cti=0. They are included for backwards compatability." -EditorType=boolean -TrueFalse=--indent-closing-paren| -ValueDefault=0 - -[Indent columns] -CallName="--indent-columns=" -Category=1 -Description="Use n columns per indentation level (default n=4)." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=4 - -[Indent only] -Category=1 -Description="This flag is used to deactivate all formatting and line break changes. When it is in effect, the only change to the script will be indentation. And any flags controlling whitespace and newlines will be ignored. You might want to use this if you are perfectly happy with your whitespace and line breaks, and merely want perltidy to handle the indentation. (This also speeds up perltidy by well over a factor of two, so it might be useful when perltidy is merely being used to help find a brace error in a large script).

Setting this flag is equivalent to setting --freeze-newlines and--freeze-whitespace." -EditorType=boolean -Enabled=false -TrueFalse=--indent-only| -ValueDefault=0 - -[Indent spaced block comments] -Category=4 -Description="

If there is no leading space on the line, then the comment will not be indented, and otherwise it may be.

If both -ibc and -isbc are set, then -isbc takes priority.

" -EditorType=boolean -TrueFalse=-isbc| -ValueDefault=0 - -[List indentation] -Category=2 -Description="By default, perltidy indents lists with 4 spaces, or whatever value is specified with -i=n. Here is a small list formatted in this way:

\n    # perltidy (default)\n    @month_of_year = (\n        'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n        'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n    );

Use the -lp flag to add extra indentation to cause the data to begin past the opening parentheses of a sub call or list, or opening square bracket of an anonymous array, or opening curly brace of an anonymous hash. With this option, the above list would become:

\n    # perltidy -lp\n    @month_of_year = (\n                       'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',\n                       'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'\n    );

If the available line length (see -l=n ) does not permit this much space, perltidy will use less. For alternate placement of the closing paren, see the next section.

This option has no effect on code BLOCKS, such as if/then/else blocks, which always use whatever is specified with -i=n. Also, the existence of line breaks and/or block comments between the opening and closing parens may cause perltidy to temporarily revert to its default method.

Note: The -lp option may not be used together with the -t tabs option. It may, however, be used with the -et=n tab method.

In addition, any parameter which significantly restricts the ability of perltidy to choose newlines will conflict with -lp and will cause -lp to be deactivated. These include -io, -fnl, -nanl, and -ndnl. The reason is that the -lp indentation style can require the careful coordination of an arbitrary number of break points in hierarchical lists, and these flags may prevent that." -EditorType=boolean -TrueFalse=--line-up-parentheses| -ValueDefault=0 - -[Maximum line length] -CallName="--maximum-line-length=" -Category=1 -Description="The default maximum line length is n=80 characters. Perltidy will try to find line break points to keep lines below this length. However, long quotes and side comments may cause lines to exceed this length. Setting -l=0 is equivalent to setting -l=(a large number)." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=80 - -[Minimum space to comment] -CallName="--minimum-space-to-comment=" -Category=4 -Description="

Side comments look best when lined up several spaces to the right of code. Perltidy will try to keep comments at least n spaces to the right. The default is n=4 spaces.

" -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=4 - -[Nospace after keyword] -CallName="--nospace-after-keyword=" -Category=3 -Description="

When an opening paren follows a Perl keyword, no space is introduced after the keyword, unless it is (by default) one of these:

\n   my local our and or eq ne if else elsif until unless \n   while for foreach return switch case given when

These defaults can be modified with two commands:

-sak=s or --space-after-keyword=s adds keywords.

-nsak=s or --nospace-after-keyword=s removes keywords.

where s is a list of keywords (in quotes if necessary). For example,

\n  my ( $a, $b, $c ) = @_;    # default\n  my( $a, $b, $c ) = @_;     # -nsak="my local our"
" -EditorType=string -Enabled=false -ValueDefault= - -[Nowant left space] -CallName="--nowant-left-space=" -Category=3 -Description="

For those who want more detailed control over the whitespace around tokens, there are four parameters which can directly modify the default whitespace rules built into perltidy for any token. They are:

-wls=s or --want-left-space=s,

-nwls=s or --nowant-left-space=s,

-wrs=s or --want-right-space=s,

-nwrs=s or --nowant-right-space=s.

These parameters are each followed by a quoted string, s, containing a list of token types. No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

To illustrate how these are used, suppose it is desired that there be no space on either side of the token types = + - / *. The following two parameters would specify this desire:

\n  -nwls="= + - / *"    -nwrs="= + - / *"

(Note that the token types are in quotes, and that they are separated by spaces). With these modified whitespace rules, the following line of math:

\n  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );

becomes this:

\n  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );

These parameters should be considered to be hints to perltidy rather than fixed rules, because perltidy must try to resolve conflicts that arise between them and all of the other rules that it uses. One conflict that can arise is if, between two tokens, the left token wants a space and the right one doesn't. In this case, the token not wanting a space takes priority.

It is necessary to have a list of all token types in order to create this type of input. Such a list can be obtained by the command --dump-token-types. Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization.

WARNING Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.

" -EditorType=string -Enabled=false -ValueDefault= - -[Nowant right space] -CallName="--nowant-right-space=" -Category=3 -Description="

For those who want more detailed control over the whitespace around tokens, there are four parameters which can directly modify the default whitespace rules built into perltidy for any token. They are:

-wls=s or --want-left-space=s,

-nwls=s or --nowant-left-space=s,

-wrs=s or --want-right-space=s,

-nwrs=s or --nowant-right-space=s.

These parameters are each followed by a quoted string, s, containing a list of token types. No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

To illustrate how these are used, suppose it is desired that there be no space on either side of the token types = + - / *. The following two parameters would specify this desire:

\n  -nwls="= + - / *"    -nwrs="= + - / *"

(Note that the token types are in quotes, and that they are separated by spaces). With these modified whitespace rules, the following line of math:

\n  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );

becomes this:

\n  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );

These parameters should be considered to be hints to perltidy rather than fixed rules, because perltidy must try to resolve conflicts that arise between them and all of the other rules that it uses. One conflict that can arise is if, between two tokens, the left token wants a space and the right one doesn't. In this case, the token not wanting a space takes priority.

It is necessary to have a list of all token types in order to create this type of input. Such a list can be obtained by the command --dump-token-types. Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization.

WARNING Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.

" -EditorType=string -Enabled=false -ValueDefault= - -[Opening brace always on right] -Category=6 -Description="

The default style, -nbl places the opening code block brace on a new line if it does not fit on the same line as the opening keyword, like this:

\n        if ( $bigwasteofspace1 && $bigwasteofspace2\n          || $bigwasteofspace3 && $bigwasteofspace4 )\n        {\n            big_waste_of_time();\n        }

To force the opening brace to always be on the right, use the -bar flag. In this case, the above example becomes

\n        if ( $bigwasteofspace1 && $bigwasteofspace2\n          || $bigwasteofspace3 && $bigwasteofspace4 ) {\n            big_waste_of_time();\n        }

A conflict occurs if both -bl and -bar are specified.

" -EditorType=boolean -TrueFalse=-bar| -ValueDefault=0 - -[Opening brace on new line] -Category=6 -Description="

Use the flag -bl to place the opening brace on a new line:

\n  if ( $input_file eq '-' )    # -bl \n  {                          \n      important_function();\n  }

This flag applies to all structural blocks, including sub's (unless the -sbl flag is set -- see next item).

The default style, -nbl, places an opening brace on the same line as the keyword introducing it. For example,

\n  if ( $input_file eq '-' ) {   # -nbl (default)
" -EditorType=boolean -TrueFalse=-bl|-nbl -ValueDefault=0 - -[Opening hash brace right] -Category=6 -Description="

The -otr flag is a hint that perltidy should not place a break between a comma and an opening token. For example:

\n    # default formatting\n    push @{ $self->{$module}{$key} },\n      {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };
\n    # perltidy -otr\n    push @{ $self->{$module}{$key} }, {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };

The flag -otr is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:

\n  -opr  or --opening-paren-right\n  -ohbr or --opening-hash-brace-right\n  -osbr or --opening-square-bracket-right
" -EditorType=boolean -TrueFalse=-ohbr| -ValueDefault=0 - -[Opening paren right] -Category=6 -Description="

The -otr flag is a hint that perltidy should not place a break between a comma and an opening token. For example:

\n    # default formatting\n    push @{ $self->{$module}{$key} },\n      {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };
\n    # perltidy -otr\n    push @{ $self->{$module}{$key} }, {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };

The flag -otr is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:

\n  -opr  or --opening-paren-right\n  -ohbr or --opening-hash-brace-right\n  -osbr or --opening-square-bracket-right
" -EditorType=boolean -TrueFalse=-opr| -ValueDefault=0 - -[Opening square bracket right] -Category=6 -Description="

The -otr flag is a hint that perltidy should not place a break between a comma and an opening token. For example:

\n    # default formatting\n    push @{ $self->{$module}{$key} },\n      {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };
\n    # perltidy -otr\n    push @{ $self->{$module}{$key} }, {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };

The flag -otr is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:

\n  -opr  or --opening-paren-right\n  -ohbr or --opening-hash-brace-right\n  -osbr or --opening-square-bracket-right
" -EditorType=boolean -TrueFalse=-osbr| -ValueDefault=0 - -[Opening sub brace on new line] -Category=6 -Description="

The flag -sbl can be used to override the value of -bl for opening sub braces. For example,

\n perltidy -sbl

produces this result:

\n sub message\n {\n    if (!defined($_[0])) {\n        print("Hello, World\n");\n    }\n    else {\n        print($_[0], "\n");\n    }\n }

This flag is negated with -nsbl. If -sbl is not specified, the value of -bl is used.

" -EditorType=boolean -TrueFalse=-sbl|-nsbl -ValueDefault=0 - -[Opening anonymous sub brace on new line] -Category=6 -Description="

The flag -asbl is like the -sbl flag except that it applies to anonymous sub's instead of named subs. For example

\n perltidy -asbl

produces this result:

\n $a = sub\n {\n     if ( !defined( $_[0] ) ) {\n         print("Hello, World\n");\n     }\n     else {\n         print( $_[0], "\n" );\n     }\n };

This flag is negated with -nasbl, and the default is -nasbl.

" -EditorType=boolean -TrueFalse=-asbl|-nasbl -ValueDefault=0 - -[Opening token right] -Category=6 -Description="

The -otr flag is a hint that perltidy should not place a break between a comma and an opening token. For example:

\n    # default formatting\n    push @{ $self->{$module}{$key} },\n      {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };
\n    # perltidy -otr\n    push @{ $self->{$module}{$key} }, {\n        accno       => $ref->{accno},\n        description => $ref->{description}\n      };

The flag -otr is actually a synonym for three other flags which can be used to control parens, hash braces, and square brackets separately if desired:

\n  -opr  or --opening-paren-right\n  -ohbr or --opening-hash-brace-right\n  -osbr or --opening-square-bracket-right
" -EditorType=boolean -TrueFalse=-otr| -ValueDefault=0 - -[Outdent keyword list] -CallName="--outdent-keyword-list=" -Category=2 -Description="This command can be used to change the keywords which are outdented with the -okw command. The parameter string is a required list of perl keywords, which should be placed in quotes if there are more than one. By itself, it does not cause any outdenting to occur, so the -okw command is still required.

For example, the commands -okwl="next last redo goto" -okw will cause those four keywords to be outdented. It is probably simplest to place any -okwl command in a .perltidyrc file." -EditorType=string -Enabled=false -ValueDefault= - -[Outdent long comments] -Category=4 -Description="

When -olc is set, lines which are full-line (block) comments longer than the value maximum-line-length will have their indentation removed. This is the default; use -nolc to prevent outdenting.

" -EditorType=boolean -TrueFalse=-olc|-nolc -ValueDefault=1 - -[Outdent long lines] -Category=2 -Description="This command is equivalent to --outdent-long-quotes and --outdent-long-comments, and it is included for compatibility with previous versions of perltidy. The negation of this also works, -noll or --nooutdent-long-lines, and is equivalent to setting -nolq and -nolc." -EditorType=boolean -TrueFalse=--outdent-long-lines| -ValueDefault=0 - -[Outdent long quotes] -Category=2 -Description="When -olq is set, lines which is a quoted string longer than the value maximum-line-length will have their indentation removed to make them more readable. This is the default. To prevent such out-denting, use -nolq or --nooutdent-long-lines." -EditorType=boolean -TrueFalse=--outdent-long-quotes| -ValueDefault=0 - -[Outdenting Keywords] -Category=2 -Description="The command -okw will will cause certain leading control keywords to be outdented by 2 spaces (or whatever -ci has been set to), if possible. By default, these keywords are redo, next, last, goto, and return. The intention is to make these control keywords easier to see. To change this list of keywords being outdented, see the next section.

For example, using perltidy -okw on the previous example gives:

\n        my $i;\n      LOOP: while ( $i = <FOTOS> ) {\n            chomp($i);\n          next unless $i;\n            fixit($i);\n        }

The default is not to do this." -EditorType=boolean -TrueFalse=--outdent-keywords| -ValueDefault=0 - -[Outdenting Labels] -Category=2 -Description="This command will cause labels to be outdented by 2 spaces (or whatever -ci has been set to), if possible. This is the default. For example:

\n        my $i;\n      LOOP: while ( $i = <FOTOS> ) {\n            chomp($i);\n            next unless $i;\n            fixit($i);\n        }

Use -nola to not outdent labels." -EditorType=boolean -TrueFalse=--outdent-labels| -ValueDefault=0 - -[Output line ending] -Category=1 -Choices="--output-line-ending=win|--output-line-ending=dos|--output-line-ending=unix|--output-line-ending=mac" -ChoicesReadable=Output line ending Windows|Output line ending Dos|Output line ending Unix|Output line ending Mac -Description="where s=win, dos, unix, or mac. This flag tells perltidy to output line endings for a specific system. Normally, perltidy writes files with the line separator character of the host system. The win and dos flags have an identical result." -EditorType=multiple -Enabled=false -ValueDefault=1 - -[Paren tightness] -CallName="--paren-tightness=" -Category=3 -Description="

The -pt=n or --paren-tightness=n parameter controls the space within parens. The example below shows the effect of the three possible values, 0, 1, and 2:

\n if ( ( my $len_tab = length( $tabstr ) ) > 0 ) {  # -pt=0\n if ( ( my $len_tab = length($tabstr) ) > 0 ) {    # -pt=1 (default)\n if ((my $len_tab = length($tabstr)) > 0) {        # -pt=2

When n is 0, there is always a space to the right of a '(' and to the left of a ')'. For n=2 there is never a space. For n=1, the default, there is a space unless the quantity within the parens is a single token, such as an identifier or quoted string." -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=1 - -[Paren vertical tightness] -CallName="--paren-vertical-tightness=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Paren vertical tightness closing] -CallName="--paren-vertical-tightness-closing=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Perl best practices] -Category=0 -Description="

-pbp is an abbreviation for the parameters in the book Perl Best Practices by Damian Conway:

\n    -l=78 -i=4 -ci=4 -st -se -vt=2 -cti=0 -pt=1 -bt=1 -sbt=1 -bbt=1 -nsfs -nolq\n    -wbb="% + - * / x != == >= <= =~ !~ < > | & = \n          **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x="

Note that the -st and -se flags make perltidy act as a filter on one file only. These can be overridden with -nst and -nse if necessary.

" -EditorType=boolean -Enabled=false -TrueFalse=--perl-best-practices --nostandard-output| -ValueDefault=0 - -[Perl syntax check flags] -CallName="--perl-syntax-check-flags=" -Category=1 -Description="When perl is invoked to check syntax, the normal flags are -c -T. In addition, if the -x flag is given to perltidy, then perl will also be passed a -x flag. It should not normally be necessary to change these flags, but it can be done with the -pscf=s flag. For example, if the taint flag, -T, is not wanted, the flag could be set to be just -pscf=-c.

Perltidy will pass your string to perl with the exception that it willadd a -c and -x if appropriate. The .LOG file will show exactly what flags were passed to perl." -EditorType=string -Enabled=false -ValueDefault= - -[Preserve line endings] -Category=1 -Description="This flag tells perltidy to write its output files with the same line endings as the input file, if possible. It should work for dos, unix, and mac line endings. It will only work if perltidy input comes from a filename (rather than stdin, for example). If perltidy has trouble determining the input file line ending, it will revert to the default behavior of using the line ending of the host system." -EditorType=boolean -Enabled=false -TrueFalse=--preserve-line-endings| -ValueDefault=0 - -[Space after keyword] -CallName="--space-after-keyword=" -Category=3 -Description="

When an opening paren follows a Perl keyword, no space is introduced after the keyword, unless it is (by default) one of these:

\n   my local our and or eq ne if else elsif until unless \n   while for foreach return switch case given when

These defaults can be modified with two commands:

-sak=s or --space-after-keyword=s adds keywords.

-nsak=s or --nospace-after-keyword=s removes keywords.

where s is a list of keywords (in quotes if necessary). For example,

\n  my ( $a, $b, $c ) = @_;    # default\n  my( $a, $b, $c ) = @_;     # -nsak="my local our"
" -EditorType=string -Enabled=false -ValueDefault= - -[Space for semicolon] -Category=3 -Description="

Semicolons within for loops may sometimes be hard to see, particularly when commas are also present. This option places spaces on both sides of these special semicolons, and is the default. Use -nsfs or --nospace-for-semicolon to deactivate it.

\n for ( @a = @$ap, $u = shift @a ; @a ; $u = $v ) {  # -sfs (default)\n for ( @a = @$ap, $u = shift @a; @a; $u = $v ) {    # -nsfs
" -EditorType=boolean -TrueFalse=--space-for-semicolon| -ValueDefault=0 - -[Space function paren] -Category=3 -Description="

When an opening paren follows a function the default is not to introduce a space. To cause a space to be introduced use:

-sfp or --space-function-paren

\n  myfunc( $a, $b, $c );    # default \n  myfunc ( $a, $b, $c );   # -sfp

You will probably also want to use the flag -skp (previous item) too.

" -EditorType=boolean -TrueFalse=--space-function-paren| -ValueDefault=0 - -[Space keyword paren] -Category=3 -Description="

When an opening paren follows a function or keyword, no space is introduced after the keyword except for the keywords noted in the previous item. To always put a space between a function or keyword and its opening paren, use the command:

-skp or --space-keyword-paren

You will probably also want to use the flag -sfp (next item) too.

" -EditorType=boolean -TrueFalse=--space-keyword-paren| -ValueDefault=0 - -[Space terminal semicolon] -Category=3 -Description="

Some programmers prefer a space before all terminal semicolons. The default is for no such space, and is indicated with -nsts or --nospace-terminal-semicolon.

\n        $i = 1 ;     #  -sts\n        $i = 1;      #  -nsts   (default)
" -EditorType=boolean -TrueFalse=--space-terminal-semicolon| -ValueDefault=0 - -[Square bracket tightness] -CallName="--square-bracket-tightness=" -Category=3 -Description="

Likewise, the parameter -sbt=n or --square-bracket-tightness=n controls the space within square brackets, as illustrated below.

\n $width = $col[ $j + $k ] - $col[ $j ];  # -sbt=0\n $width = $col[ $j + $k ] - $col[$j];    # -sbt=1 (default)\n $width = $col[$j + $k] - $col[$j];      # -sbt=2
" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=1 - -[Square bracket vertical tightness] -CallName="--square-bracket-vertical-tightness=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Square bracket vertical tightness closing] -CallName="--square-bracket-vertical-tightness-closing=" -Category=6 -Description="

The -vt=n and -vtc=n parameters apply to each type of container token. If desired, vertical tightness controls can be applied independently to each of the closing container token types.

In fact, the parameter -vt=n is actually just an abbreviation for -pvt=n -bvt=n sbvt=n, and likewise -vtc=n is an abbreviation for -pvtc=n -bvtc=n sbvtc=n.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Stack closing hash brace] -Category=6 -Description="

The -sct flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sct\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        } );

The -sct flag is somewhat similar to the -vtc flags, and in some cases it can give a similar result. The difference is that the -vtc flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the -sct flag merely tries to reduce the number of lines with isolated closing tokens by stacking them but does not try to hide them. For example:

\n    # -vtc=2\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1, } );

The flag -sct is a synonym for -scp -schb -scsb.

" -EditorType=boolean -TrueFalse=-schb| -ValueDefault=0 - -[Stack closing paren] -Category=6 -Description="

The -sct flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sct\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        } );

The -sct flag is somewhat similar to the -vtc flags, and in some cases it can give a similar result. The difference is that the -vtc flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the -sct flag merely tries to reduce the number of lines with isolated closing tokens by stacking them but does not try to hide them. For example:

\n    # -vtc=2\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1, } );

The flag -sct is a synonym for -scp -schb -scsb.

" -EditorType=boolean -TrueFalse=-scp| -ValueDefault=0 - -[Stack closing square bracket] -Category=6 -Description="

The -sct flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sct\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        } );

The -sct flag is somewhat similar to the -vtc flags, and in some cases it can give a similar result. The difference is that the -vtc flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the -sct flag merely tries to reduce the number of lines with isolated closing tokens by stacking them but does not try to hide them. For example:

\n    # -vtc=2\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1, } );

The flag -sct is a synonym for -scp -schb -scsb.

" -EditorType=boolean -TrueFalse=-scsb| -ValueDefault=0 - -[Stack closing tokens] -Category=6 -Description="

The -sct flag tells perltidy to ``stack'' closing tokens when possible to avoid lines with isolated closing tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sct\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        } );

The -sct flag is somewhat similar to the -vtc flags, and in some cases it can give a similar result. The difference is that the -vtc flags try to avoid lines with leading opening tokens by ``hiding'' them at the end of a previous line, whereas the -sct flag merely tries to reduce the number of lines with isolated closing tokens by stacking them but does not try to hide them. For example:

\n    # -vtc=2\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1, } );

For detailed control of the stacking of individual closing tokens the following controls can be used:

\n  -scp  or --stack-closing-paren\n  -schb or --stack-closing-hash-brace\n  -scsb or --stack-closing-square-bracket

The flag -sct is a synonym for -scp -schb -scsb.

" -EditorType=boolean -TrueFalse=-sct| -ValueDefault=0 - -[Stack opening hash brace] -Category=6 -Description="

The -sot flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sot\n    $opt_c = Text::CSV_XS->new( {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );

For detailed control of individual closing tokens the following controls can be used:

\n  -sop  or --stack-opening-paren\n  -sohb or --stack-opening-hash-brace\n  -sosb or --stack-opening-square-bracket

The flag -sot is a synonym for -sop -sohb -sosb.

" -EditorType=boolean -TrueFalse=-sohb| -ValueDefault=0 - -[Stack opening paren] -Category=6 -Description="

The -sot flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sot\n    $opt_c = Text::CSV_XS->new( {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );

The flag -sot is a synonym for -sop -sohb -sosb.

" -EditorType=boolean -TrueFalse=-sop| -ValueDefault=0 - -[Stack opening square bracket] -Category=6 -Description="

The -sot flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sot\n    $opt_c = Text::CSV_XS->new( {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );

For detailed control of individual closing tokens the following controls can be used:

\n  -sop  or --stack-opening-paren\n  -sohb or --stack-opening-hash-brace\n  -sosb or --stack-opening-square-bracket

The flag -sot is a synonym for -sop -sohb -sosb.

" -EditorType=boolean -TrueFalse=-sosb| -ValueDefault=0 - -[Stack opening tokens] -Category=6 -Description="

The -sot flag tells perltidy to ``stack'' opening tokens when possible to avoid lines with isolated opening tokens.

For example:

\n    # default\n    $opt_c = Text::CSV_XS->new(\n        {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );
\n    # -sot\n    $opt_c = Text::CSV_XS->new( {\n            binary       => 1,\n            sep_char     => $opt_c,\n            always_quote => 1,\n        }\n    );

For detailed control of individual closing tokens the following controls can be used:

\n  -sop  or --stack-opening-paren\n  -sohb or --stack-opening-hash-brace\n  -sosb or --stack-opening-square-bracket

The flag -sot is a synonym for -sop -sohb -sosb.

" -EditorType=boolean -TrueFalse=-sot| -ValueDefault=0 - -[Starting indentation level] -CallName="--starting-indentation-level=" -Category=2 -Description="By default, perltidy examines the input file and tries to determine the starting indentation level. While it is often zero, it may not be zero for a code snippet being sent from an editing session. If the default method does not work correctly, or you want to change the starting level, use -sil=n, to force the starting level to be n." -EditorType=numeric -Enabled=false -MaxVal=1000 -MinVal=0 -ValueDefault=0 - -[Static Block Comment Outdent] -Category=4 -Description="

The command -osbc will will cause static block comments to be outdented by 2 spaces (or whatever -ci=n has been set to), if possible.

" -EditorType=boolean -TrueFalse=-osbc| -ValueDefault=0 - -[Static Block Comment Prefix] -CallName="--static-block-comment-prefix=" -Category=4 -Description="

This parameter defines the prefix used to identify static block comments when the -sbc parameter is set. The default prefix is ##, corresponding to -sbcp=##. The prefix is actually part of a perl pattern used to match lines and it must either begin with # or ^#. In the first case a prefix ^* will be added to match any leading whitespace, while in the second case the pattern will match only comments with no leading whitespace. For example, to identify all comments as static block comments, one would use -sbcp=#. To identify all left-adjusted comments as static block comments, use -sbcp='^#'.

Please note that -sbcp merely defines the pattern used to identify static block comments; it will not be used unless the switch -sbc is set. Also, please be aware that since this string is used in a perl regular expression which identifies these comments, it must enable a valid regular expression to be formed.

A pattern which can be useful is:

\n    -sbcp=^#{2,}[^#]

This pattern requires a static block comment to have at least one character which is neither a # nor a space. It allows a line containing only '#' characters to be rejected as a static block comment. Such lines are often used at the start and end of header information in subroutines and should not be separated from the intervening comments, which typically begin with just a single '#'.

" -EditorType=string -Enabled=false -ValueDefault=## - -[Static Block Comments] -Category=4 -Description="

Static block comments are block comments with a special leading pattern, ## by default, which will be treated slightly differently from other block comments. They effectively behave as if they had glue along their left and top edges, because they stick to the left edge and previous line when there is no blank spaces in those places. This option is particularly useful for controlling how commented code is displayed.

-sbc, --static-block-comments

When -sbc is used, a block comment with a special leading pattern, ## by default, will be treated specially.

Comments so identified are treated as follows:

  • If there is no leading space on the line, then the comment will not be indented, and otherwise it may be,

  • no new blank line will be inserted before such a comment, and

  • such a comment will never become a hanging side comment.

For example, assuming @month_of_year is left-adjusted:

\n    @month_of_year = (    # -sbc (default)\n        'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',\n    ##  'Dec', 'Nov'\n        'Nov', 'Dec');

Without this convention, the above code would become

\n    @month_of_year = (   # -nsbc\n        'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct',\n  \n        ##  'Dec', 'Nov'\n        'Nov', 'Dec'\n    );

which is not as clear. The default is to use -sbc. This may be deactivated with -nsbc.

" -EditorType=boolean -TrueFalse=-sbc|-nsbc -ValueDefault=1 - -[Static Side Comment Prefix] -CallName="--static-side-comment-prefix=" -Category=4 -Description="

This parameter defines the prefix used to identify static side comments when the -ssc parameter is set. The default prefix is ##, corresponding to -sscp=##.

Please note that -sscp merely defines the pattern used to identify static side comments; it will not be used unless the switch -ssc is set. Also, note that this string is used in a perl regular expression which identifies these comments, so it must enable a valid regular expression to be formed.

" -EditorType=string -Enabled=false -ValueDefault=## - -[Static Side Comments] -Category=4 -Description="

Static side comments are side comments with a special leading pattern. This option can be useful for controlling how commented code is displayed when it is a side comment.

-ssc, --static-side-comments

When -ssc is used, a side comment with a static leading pattern, which is ## by default, will be be spaced only a single space from previous character, and it will not be vertically aligned with other side comments.

The default is -nssc.

" -EditorType=boolean -TrueFalse=-ssc|-nssc -ValueDefault=0 - -[Tabs] -Category=1 -Description="This flag causes one leading tab character to be inserted for each level of indentation. Certain other features are incompatible with this option, and if these options are also given, then a warning message will be issued and this flag will be unset. One example is the -lp option." -EditorType=boolean -TrueFalse=--tabs| -ValueDefault=0 - -[Trimming whitespace around qw quotes] -Category=3 -Choices=--trim-qw|--notrim-qw -ChoicesReadable=Trim whitespace|Do not trim whitespace -Description="

-tqw or --trim-qw provide the default behavior of trimming spaces around multi-line qw quotes and indenting them appropriately.

-ntqw or --notrim-qw cause leading and trailing whitespace around multi-line qw quotes to be left unchanged. This option will not normally be necessary, but was added for testing purposes, because in some versions of perl, trimming qw quotes changes the syntax tree.

" -EditorType=multiple -Enabled=false -ValueDefault=0 - -[Vertical tightness] -CallName="--vertical-tightness=" -Category=6 -Description="

Opening tokens (except for block braces) are controlled by -vt=n, or --vertical-tightness=n, where

\n -vt=0 always break a line after opening token (default). \n -vt=1 do not break unless this would produce more than one \n         step in indentation in a line.\n -vt=2 never break a line after opening token

You must also use the -lp flag when you use the -vt flag; the reason is explained below.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Vertical tightness closing] -CallName="--vertical-tightness-closing=" -Category=6 -Description="

Closing tokens (except for block braces) are controlled by -vtc=n, or --vertical-tightness-closing=n, where

\n -vtc=0 always break a line before a closing token (default), \n -vtc=1 do not break before a closing token which is followed \n        by a semicolon or another closing token, and is not in \n        a list environment.\n -vtc=2 never break before a closing token.

The rules for -vtc=1 are designed to maintain a reasonable balance between tightness and readability in complex lists.

" -EditorType=numeric -Enabled=false -MaxVal=2 -MinVal=0 -ValueDefault=0 - -[Want break after] -CallName="--want-break-after=" -Category=6 -Description="

These parameters are each followed by a quoted string, s, containing a list of token types (separated only by spaces). No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

By default, perltidy breaks after these token types: % + - * / x != == >= <= =~ !~ < > | & = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=

And perltidy breaks before these token types by default: . << >> -> && || //

To illustrate, to cause a break after a concatenation operator, '.', rather than before it, the command line would be

\n  -wba="."

As another example, the following command would cause a break before math operators '+', '-', '/', and '*':

\n  -wbb="+ - / *"

These commands should work well for most of the token types that perltidy uses (use --dump-token-types for a list). Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization. However, for a few token types there may be conflicts with hardwired logic which cause unexpected results. One example is curly braces, which should be controlled with the parameter bl provided for that purpose.

" -EditorType=string -Enabled=false -ValueDefault= - -[Want break before] -CallName="--want-break-before=" -Category=6 -Description="

These parameters are each followed by a quoted string, s, containing a list of token types (separated only by spaces). No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

By default, perltidy breaks after these token types: % + - * / x != == >= <= =~ !~ < > | & = **= += *= &= <<= &&= -= /= |= >>= ||= //= .= %= ^= x=

And perltidy breaks before these token types by default: . << >> -> && || //

To illustrate, to cause a break after a concatenation operator, '.', rather than before it, the command line would be

\n  -wba="."

As another example, the following command would cause a break before math operators '+', '-', '/', and '*':

\n  -wbb="+ - / *"

These commands should work well for most of the token types that perltidy uses (use --dump-token-types for a list). Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization. However, for a few token types there may be conflicts with hardwired logic which cause unexpected results. One example is curly braces, which should be controlled with the parameter bl provided for that purpose.

" -EditorType=string -Enabled=false -ValueDefault= - -[Want left space] -CallName="--want-left-space=" -Category=3 -Description="

For those who want more detailed control over the whitespace around tokens, there are four parameters which can directly modify the default whitespace rules built into perltidy for any token. They are:

-wls=s or --want-left-space=s,

-nwls=s or --nowant-left-space=s,

-wrs=s or --want-right-space=s,

-nwrs=s or --nowant-right-space=s.

These parameters are each followed by a quoted string, s, containing a list of token types. No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

To illustrate how these are used, suppose it is desired that there be no space on either side of the token types = + - / *. The following two parameters would specify this desire:

\n  -nwls="= + - / *"    -nwrs="= + - / *"

(Note that the token types are in quotes, and that they are separated by spaces). With these modified whitespace rules, the following line of math:

\n  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );

becomes this:

\n  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );

These parameters should be considered to be hints to perltidy rather than fixed rules, because perltidy must try to resolve conflicts that arise between them and all of the other rules that it uses. One conflict that can arise is if, between two tokens, the left token wants a space and the right one doesn't. In this case, the token not wanting a space takes priority.

It is necessary to have a list of all token types in order to create this type of input. Such a list can be obtained by the command --dump-token-types. Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization.

WARNING Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.

" -EditorType=string -Enabled=false -ValueDefault= - -[Want right space] -CallName="--want-right-space=" -Category=3 -Description="

For those who want more detailed control over the whitespace around tokens, there are four parameters which can directly modify the default whitespace rules built into perltidy for any token. They are:

-wls=s or --want-left-space=s,

-nwls=s or --nowant-left-space=s,

-wrs=s or --want-right-space=s,

-nwrs=s or --nowant-right-space=s.

These parameters are each followed by a quoted string, s, containing a list of token types. No more than one of each of these parameters should be specified, because repeating a command-line parameter always overwrites the previous one before perltidy ever sees it.

To illustrate how these are used, suppose it is desired that there be no space on either side of the token types = + - / *. The following two parameters would specify this desire:

\n  -nwls="= + - / *"    -nwrs="= + - / *"

(Note that the token types are in quotes, and that they are separated by spaces). With these modified whitespace rules, the following line of math:

\n  $root = -$b + sqrt( $b * $b - 4. * $a * $c ) / ( 2. * $a );

becomes this:

\n  $root=-$b+sqrt( $b*$b-4.*$a*$c )/( 2.*$a );

These parameters should be considered to be hints to perltidy rather than fixed rules, because perltidy must try to resolve conflicts that arise between them and all of the other rules that it uses. One conflict that can arise is if, between two tokens, the left token wants a space and the right one doesn't. In this case, the token not wanting a space takes priority.

It is necessary to have a list of all token types in order to create this type of input. Such a list can be obtained by the command --dump-token-types. Also try the -D flag on a short snippet of code and look at the .DEBUG file to see the tokenization.

WARNING Be sure to put these tokens in quotes to avoid having them misinterpreted by your command shell.

" -EditorType=string -Enabled=false -ValueDefault= - -[Break at old comma breakpoints] -Category=7 -Description="

This flag tells perltidy to try to break at all old commas. This is not the default. Normally, perltidy makes a best guess at list formatting, and seldom uses old comma breakpoints. Usually this works well, but consider:

\n    my @list = (1,\n                1, 1,\n                1, 2, 1,\n                1, 3, 3, 1,\n                1, 4, 6, 4, 1,);

The default formatting will flatten this down to one line:

\n    # perltidy (default)\n    my @list = ( 1, 1, 1, 1, 2, 1, 1, 3, 3, 1, 1, 4, 6, 4, 1, );

which hides the structure. Using -boc, plus additional flags to retain the original style, yields

\n    # perltidy -boc -lp -pt=2 -vt=1 -vtc=1\n    my @list = (1,\n                1, 1,\n                1, 2, 1,\n                1, 3, 3, 1,\n                1, 4, 6, 4, 1,);

A disadvantage of this flag is that all tables in the file must already be nicely formatted. For another possibility see the -fs flag in Skipping Selected Sections of Code.

" -EditorType=boolean -TrueFalse=--break-at-old-comma-breakpoints| -ValueDefault=0 - -[Maximum fields per table] -CallName="--maximum-fields-per-table=" -Category=7 -Description="

If the computed number of fields for any table exceeds n, then it will be reduced to n. The default value for n is a large number, 40. While this value should probably be left unchanged as a general rule, it might be used on a small section of code to force a list to have a particular number of fields per line, and then either the -boc flag could be used to retain this formatting, or a single comment could be introduced somewhere to freeze the formatting in future applications of perltidy.

\n    # perltidy -mft=2\n    @month_of_year = (    \n        'Jan', 'Feb',\n        'Mar', 'Apr',\n        'May', 'Jun',\n        'Jul', 'Aug',\n        'Sep', 'Oct',\n        'Nov', 'Dec'\n    );
" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=40 - -[Comma arrow breakpoints] -CallName="--comma-arrow-breakpoints=" -Category=7 -Description="

A comma which follows a comma arrow, '=>', requires special consideration. In a long list, it is common to break at all such commas. This parameter can be used to control how perltidy breaks at these commas. (However, it will have no effect if old comma breaks are being forced because -boc is used). The possible values of n are:

\n n=0 break at all commas after =>  \n n=1 stable: break at all commas after => unless this would break\n     an existing one-line container (default)\n n=2 break at all commas after =>, but try to form the maximum\n     maximum one-line container lengths\n n=3 do not treat commas after => specially at all

For example, given the following single line, perltidy by default will not add any line breaks because it would break the existing one-line container:

\n    bless { B => $B, Root => $Root } => $package;

Using -cab=0 will force a break after each comma-arrow item:

\n    # perltidy -cab=0:\n    bless {\n        B    => $B,\n        Root => $Root\n    } => $package;

If perltidy is subsequently run with this container broken, then by default it will break after each '=>' because the container is now broken. To reform a one-line container, the parameter -cab=2 would be needed.

The flag -cab=3 can be used to prevent these commas from being treated specially. In this case, an item such as ``01'' => 31 is treated as a single item in a table. The number of fields in this table will be determined by the same rules that are used for any other table. Here is an example.

\n    # perltidy -cab=3\n    my %last_day = (\n        "01" => 31, "02" => 29, "03" => 31, "04" => 30,\n        "05" => 31, "06" => 30, "07" => 31, "08" => 31,\n        "09" => 30, "10" => 31, "11" => 30, "12" => 31\n    );
" -EditorType=numeric -Enabled=false -MaxVal=3 -MinVal=0 -ValueDefault=3 - -[Break at old logical breakpoints] -Category=8 -Description="

By default, if a logical expression is broken at a &&, ||, and, or or, then the container will remain broken. Also, breaks at internal keywords if and unless will normally be retained. To prevent this, and thus form longer lines, use -nbol.

" -EditorType=boolean -TrueFalse=--break-at-old-logical-breakpoints| -ValueDefault=0 - -[Break at old keyword breakpoints] -Category=8 -Description="

By default, perltidy will retain a breakpoint before keywords which may return lists, such as sort and <map>. This allows chains of these operators to be displayed one per line. Use -nbok to prevent retaining these breakpoints.

" -EditorType=boolean -TrueFalse=--break-at-old-keyword-breakpoints| -ValueDefault=0 - -[Break at old ternary breakpoints] -Category=8 -Description="

By default, if a conditional (ternary) operator is broken at a :, then it will remain broken. To prevent this, and thereby form longer lines, use -nbot.

" -EditorType=boolean -TrueFalse=--break-at-old-ternary-breakpoints| -ValueDefault=0 - -[Ignore old breakpoints] -Category=8 -Description="

Use this flag to tell perltidy to ignore existing line breaks to the maximum extent possible. This will tend to produce the longest possible containers, regardless of type, which do not exceed the line length limit.

" -EditorType=boolean -TrueFalse=--ignore-old-breakpoints| -ValueDefault=0 - -[Keep interior semicolons] -Category=8 -Description="

Use the -kis flag to prevent breaking at a semicolon if there was no break there in the input file. Normally perltidy places a newline after each semicolon which terminates a statement unless several statements are contained within a one-line brace block. To illustrate, consider the following input lines:

\n    dbmclose(%verb_delim); undef %verb_delim;\n    dbmclose(%expanded); undef %expanded;

The default is to break after each statement, giving

\n    dbmclose(%verb_delim);\n    undef %verb_delim;\n    dbmclose(%expanded);\n    undef %expanded;

With perltidy -kis the multiple statements are retained:

\n    dbmclose(%verb_delim); undef %verb_delim;\n    dbmclose(%expanded);   undef %expanded;

The statements are still subject to the specified value of maximum-line-length and will be broken if this maximum is exceeed.

" -EditorType=boolean -TrueFalse=--keep-interior-semicolons| -ValueDefault=0 - -[Blanks before comments] -Category=9 -Description="

A blank line will be introduced before a full-line comment. This is the default. Use -nbbc or --noblanks-before-comments to prevent such blank lines from being introduced.

" -EditorType=boolean -TrueFalse=--blanks-before-comments| -ValueDefault=0 - -[Blanks before subs] -Category=9 -Description="

A blank line will be introduced before a sub definition, unless it is a one-liner or preceded by a comment. A blank line will also be introduced before a package statement and a BEGIN and END block. This is the default. The intention is to help display the structure of a program by setting off certain key sections of code. This is negated with -nbbs or --noblanks-before-subs.

" -EditorType=boolean -TrueFalse=--blanks-before-subs| -ValueDefault=0 - -[Blanks before blocks] -Category=9 -Description="

A blank line will be introduced before blocks of coding delimited by for, foreach, while, until, and if, unless, in the following circumstances:

  • The block is not preceded by a comment.

  • The block is not a one-line block.

  • The number of consecutive non-blank lines at the current indentation depth is at least -lbl (see next section).

This is the default. The intention of this option is to introduce some space within dense coding. This is negated with -nbbb or --noblanks-before-blocks.

" -EditorType=boolean -TrueFalse=--blanks-before-blocks| -ValueDefault=0 - -[Long block line count] -CallName="--long-block-line-count=" -Category=9 -Description="

This controls how often perltidy is allowed to add blank lines before certain block types (see previous section). The default is 8. Entering a value of 0 is equivalent to entering a very large number.

" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=8 - -[Maximum consecutive blank lines] -CallName="--maximum-consecutive-blank-lines=" -Category=9 -Description="

This parameter specifies the maximum number of consecutive blank lines in the output script. The default is n=1. If the input file has more than n consecutive blank lines, the number will be reduced to n. (This obviously does not apply to pod sections, here-documents, and quotes).

" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Keep old blank lines] -CallName="--keep-old-blank-lines=" -Category=9 -Description="

The -kbl=n flag gives you control over how your existing blank lines are treated.

The possible values of n are:

\n n=0 ignore all old blank lines\n n=1 stable: keep old blanks, but limited by the value of the B<-mbl=n> flag\n n=2 keep all old blank lines, regardless of the value of the B<-mbl=n> flag

The default is n=1.

" -EditorType=numeric -Enabled=false -MaxVal=9999 -MinVal=0 -ValueDefault=1 - -[Swallow optional blank lines] -Category=9 -Description="

All blank lines not required by the above flags, -bbb, -bbs, and -bbc, will be deleted. (But essential blank lines above pod documents will be retained). This is NOT the default.

" -EditorType=boolean -TrueFalse=--swallow-optional-blank-lines| -ValueDefault=0 - -[Noswallow optional blank lines] -Category=9 -Description="

Retain blank lines, including those which do not corresponding to flags -bbb, -bbs, and -bbc. This is the default. The number of blanks retained is subject to the limit imposed by --maximum-consecutive-blank-lines, however.

" -EditorType=boolean -TrueFalse=--noswallow-optional-blank-lines| -ValueDefault=0 - -[Delete all comments] -Category=10 -Description="

Perltidy can selectively delete comments and/or pod documentation. The command -dac or --delete-all-comments will delete all comments and all pod documentation, leaving just code and any leading system control lines.

" -EditorType=boolean -TrueFalse=--delete-all-comments| -ValueDefault=0 - -[Delete pod] -Category=10 -Description="

The command -dp or --delete-pod will remove all pod documentation (but not comments).

" -EditorType=boolean -TrueFalse=--delete-pod| -ValueDefault=0 - -[Delete block comments] -Category=10 -Description="

Two commands which remove comments (but not pod) are: -dbc or --delete-block-comments and -dsc or --delete-side-comments. (Hanging side comments will be deleted with block comments here.)

" -EditorType=boolean -TrueFalse=--delete-block-comments| -ValueDefault=0 - -[Delete side comments] -Category=10 -Description="

Two commands which remove comments (but not pod) are: -dbc or --delete-block-comments and -dsc or --delete-side-comments. (Hanging side comments will be deleted with block comments here.)

" -EditorType=boolean -TrueFalse=--delete-side-comments| -ValueDefault=0 - -[Tee all comments] -Category=10 -Description="

When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a .TEE extension. This text can include comments and pod documentation.

The command -tac or --tee-all-comments will write all comments and all pod documentation.

" -EditorType=boolean -TrueFalse=--tee-all-comments| -ValueDefault=0 - -[Tee pod] -Category=10 -Description="

When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a .TEE extension. This text can include comments and pod documentation.

The command -tp or --tee-pod will write all pod documentation (but not comments).

" -EditorType=boolean -TrueFalse=--tee-pod| -ValueDefault=0 - -[Tee block comments] -Category=10 -Description="

When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a .TEE extension. This text can include comments and pod documentation.

The commands which write comments (but not pod) are: -tbc or --tee-block-comments and -tsc or --tee-side-comments. (Hanging side comments will be written with block comments here.)

" -EditorType=boolean -TrueFalse=--tee-block-comments| -ValueDefault=0 - -[Tee side comments] -Category=10 -Description="

When perltidy writes a formatted text file, it has the ability to also send selected text to a file with a .TEE extension. This text can include comments and pod documentation.

The commands which write comments (but not pod) are: -tbc or --tee-block-comments and -tsc or --tee-side-comments. (Hanging side comments will be written with block comments here.)

" -EditorType=boolean -TrueFalse=--tee-side-comments| -ValueDefault=0 - -[Look for hash bang] -Category=10 -Description="

If your script has leading lines of system commands or other text which are not valid perl code, and which are separated from the start of the perl code by a ``hash-bang'' line, ( a line of the form #!...perl ), you must use the -x flag to tell perltidy not to parse and format any lines before the ``hash-bang'' line. This option also invokes perl with a -x flag when checking the syntax. This option was originally added to allow perltidy to parse interactive VMS scripts, but it should be used for any script which is normally invoked with perl -x.

" -EditorType=boolean -TrueFalse=--look-for-hash-bang| -ValueDefault=0 - -[Making a file unreadable] -Category=10 -Choices=--mangle|--extrude -ChoicesReadable=Mangle|Extrude -Description="

The goal of perltidy is to improve the readability of files, but there are two commands which have the opposite effect, --mangle and --extrude. They are actually merely aliases for combinations of other parameters. Both of these strip all possible whitespace, but leave comments and pod documents, so that they are essentially reversible. The difference between these is that --mangle puts the fewest possible line breaks in a script while --extrude puts the maximum possible. Note that these options do not provided any meaningful obfuscation, because perltidy can be used to reformat the files. They were originally developed to help test the tokenization logic of perltidy, but they have other uses. One use for --mangle is the following:

\n  perltidy --mangle myfile.pl -st | perltidy -o myfile.pl.new

This will form the maximum possible number of one-line blocks (see next section), and can sometimes help clean up a badly formatted script.

A similar technique can be used with --extrude instead of --mangle to make the minimum number of one-line blocks.

Another use for --mangle is to combine it with -dac to reduce the file size of a perl script.

" -EditorType=multiple -Enabled=false -ValueDefault=0 - -[MakeMaker] -Category=10 -Description="

The first $VERSION line of a file which might be eval'd by MakeMaker is passed through unchanged except for indentation. Use --nopass-version-line, or -npvl, to deactivate this feature.

" -EditorType=boolean -TrueFalse=--nopass-version-line| -ValueDefault=0 - -[AutoLoader] -Category=10 -Description="

If the AutoLoader module is used, perltidy will continue formatting code after seeing an __END__ line. Use --nolook-for-autoloader, or -nlal, to deactivate this feature.

" -EditorType=boolean -TrueFalse=--nolook-for-autoloader| -ValueDefault=0 - -[SelfLoader] -Category=10 -Description="

Likewise, if the SelfLoader module is used, perltidy will continue formatting code after seeing a __DATA__ line. Use --nolook-for-selfloader, or -nlsl, to deactivate this feature.

" -EditorType=boolean -TrueFalse=--nolook-for-selfloader| -ValueDefault=0 diff --git a/indenters/__TODO/uigui_phpCB.ini b/indenters/__TODO/uigui_phpCB.ini deleted file mode 100755 index 00dbfc3..0000000 --- a/indenters/__TODO/uigui_phpCB.ini +++ /dev/null @@ -1,151 +0,0 @@ -[header] -categories=General -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.php|*.htm|*.html|*.xhtml -indenterFileName=phpCB -indenterName=PHP Code Beautifier (PHP) -inputFileName=indentinput -inputFileParameter= -manual=http://www.waterproof.fr/products/phpCodeBeautifier/manual.php -outputFileName= -outputFileParameter=stdout -parameterOrder=pio -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter= -version=2007-02-21 - -[Align all assignement statements] -Category=0 -Description=Align all assignement statements -EditorType=boolean -TrueFalse=--align-equal-statements| -ValueDefault=1 - -[Align all assignement statements to a fixed position] -CallName="--align-equal-statements-to-fixed-pos " -Category=0 -Description="Align all assignement statements to a fixed position.
SourceWith --align-equal-statements-to-fixed-pos 40
<?php 
$noError = true; 
$feildEmpty = false; 
$showMessage = false; 
$showMessage = false; 
$anotherVariable[0123] = 'bla bla bla'; 
$showBlaBlaBlaMessage = false; 
?>
<?php 
$noError                               = true; 
$feildEmpty                            = false; 
$showMessage                           = false; 
$showMessage                           = false; 
$anotherVariable[0123]                 = 'bla bla bla'; 
$showBlaBlaBlaMessage                  = false; 
?>
" -EditorType=numeric -Enabled=false -MaxVal=60 -MinVal=4 -ValueDefault=30 - -[Allow to insert a space after '('] -Category=0 -Description=Allow to insert a space after start bracket '(' -EditorType=boolean -TrueFalse=--space-after-start-bracket| -ValueDefault=0 - -[Allow to insert a space after 'if'] -Category=0 -Description=Allow to insert a space after 'if' keyword -EditorType=boolean -TrueFalse=--space-after-if| -ValueDefault=1 - -[Allow to insert a space after 'switch'] -Category=0 -Description=Allow to insert a space after 'switch' keyword -EditorType=boolean -TrueFalse=--space-after-switch| -ValueDefault=1 - -[Allow to insert a space after 'while'] -Category=0 -Description=Allow to insert a space after 'while' keyword -EditorType=boolean -TrueFalse=--space-after-while| -ValueDefault=1 - -[Allow to insert a space after '}'] -Category=0 -Description=Allow to insert a space after starting angle bracket '}' -EditorType=boolean -TrueFalse=--space-after-end-angle-bracket| -ValueDefault=1 - -[Allow to insert a space before ')'] -Category=0 -Description=Allow to insert a space before end bracket ')' -EditorType=boolean -TrueFalse=--space-before-end-bracket| -ValueDefault=0 - -[Allow to insert a space before '{'] -Category=0 -Description=Allow to insert a space before starting angle bracket '{' -EditorType=boolean -TrueFalse=--space-before-start-angle-bracket| -ValueDefault=1 - -[Change comments] -Category=0 -Description="Change '# ...' comments into '// ...' comments
SourceWith --change-shell-comment-to-double-slashes-commentWithout --change-shell-comment-to-double-slashes-comment
<?php

#comment content
//another comment
?>
<?php

// comment content
// another comment
?>
<?php

# comment content
// another comment
?>
" -EditorType=boolean -TrueFalse=--change-shell-comment-to-double-slashes-comment| -ValueDefault=1 - -[Comment render style] -Category=0 -Choices="--comment-rendering-style PEAR|--comment-rendering-style PHPDoc" -ChoicesReadable="PEAR comment rendering style|PHPDoc comment rendering style" -Description="The following style of comment formating are available:
--comment-rendering-style PEAR--comment-rendering-style PHPDoc
<?php

/**
 * bla bla bla
 *
 * @access public
 */
?>
<?php

/**
* bla bla bla
*
* @access public
*/
?>
" -EditorType=multiple -Enabled=true -ValueDefault=0 - -[Force large PHP code tag] -Category=0 -Description="Change '<?' and '<%' tokens into '<?php' and '%>' into '?>'" -EditorType=boolean -TrueFalse=--force-large-php-code-tag| -ValueDefault=1 - -[Glue "&&" to following item] -Category=0 -Description="Glue '&' to following item

With --glue-amperscoreWithout --glue-amperscore
<?php
$value = &$objectInstance;
?>
<?php
$value = & $objectInstance;
?>
" -EditorType=boolean -TrueFalse=--glue-amperscore| -ValueDefault=1 - -[Increase padding before case statements] -Category=0 -Description="Increase padding before case statements:
With --extra-padding-for-case-statementWithout --extra-padding-for-case-statement
<?php

switch($condition){
    case 1:
        action1();
        break;
    case 2:
        action2();
        break;
    default:
        defaultaction();
        break;
}
?>
<?php

switch($condition){
case 1:
    action1();
    break;
case 2:
    action2();
    break;
default:
    defaultaction();
    break;
}
?>
" -EditorType=boolean -TrueFalse=--extra-padding-for-case-statement| -ValueDefault=0 - -[Indent with TAB] -Category=0 -Description="If selected, tabulation (ASCII #9) character is used to indent text, elsewhere space (ASCII #32) character is used" -EditorType=boolean -TrueFalse=--indent-with-tab| -ValueDefault=0 - -[Lowercase for NULL, TRUE and FALSE constants] -Category=0 -Description="Lowercase for NULL, TRUE and FALSE constants as encouraged in PEAR coding standards
With --force-true-false-null-contant-lowercaseWithout --force-true-false-null-contant-lowercase
<?php
if(true){
    if(false){
        $value = null;
    }
}
?>
<?php
if(TRUE){
    if(FALSE){
        $value = NULL;
    }
}
?>
" -EditorType=boolean -TrueFalse=--force-true-false-null-contant-lowercase| -ValueDefault=1 - -[Padding char count] -CallName="--padding-char-count " -Category=0 -Description=Indent using # spaces per indent -EditorType=numeric -Enabled=false -MaxVal=8 -MinVal=0 -ValueDefault=4 - -[Use "One true brace" formating for functions] -Category=0 -Description="Use 'One true brace' formating for functions
With --one-true-brace-function-declarationWithout --one-true-brace-function-declaration
<?php

function aFunction($param)
{
    // function content
}
?>
<?php

function aFunction($param) {
    // function content
}
?>
" -EditorType=boolean -TrueFalse=--one-true-brace-function-declaration| -ValueDefault=1 diff --git a/indenters/__TODO/uigui_phpStylist.ini b/indenters/__TODO/uigui_phpStylist.ini deleted file mode 100755 index 6374906..0000000 --- a/indenters/__TODO/uigui_phpStylist.ini +++ /dev/null @@ -1,258 +0,0 @@ -[header] -categories="General|Operators|Functions, Classes and Objects|Control Structures|Arrays and Concatenation|Comments" -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.php|*.phpt|*.phps -indenterFileName=phpStylist.php -indenterName=phpStylist (PHP) -inputFileName=indentinput -inputFileParameter=" " -manual=http://sourceforge.net/projects/phpstylist/ -outputFileName= -outputFileParameter=stdout -parameterOrder=ipo -showHelpParameter="-- --help" -stringparaminquotes=false -useCfgFileParameter= -version=1.0 - -[Indent size] -CallName="--indent_size " -Category=0 -Description="Indent the code with the set number of spaces." -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=4 - -[Indent with tabs] -Category=0 -Description="Indent with tabs instead of spaces" -EditorType=boolean -TrueFalse="--indent_with_tabs|" -ValueDefault=0 - -[Keep redundant lines] -Category=0 -Description="Keep redundant lines" -EditorType=boolean -TrueFalse="--keep_redundant_lines|" -ValueDefault=0 - -[Space inside parentheses] -Category=0 -Description="Space inside parentheses" -EditorType=boolean -TrueFalse="--space_inside_parentheses|" -ValueDefault=0 - -[Space outside parentheses] -Category=0 -Description="Space outside parentheses" -EditorType=boolean -TrueFalse="--space_outside_parentheses|" -ValueDefault=0 - -[Space after comma] -Category=0 -Description="Space after comma" -EditorType=boolean -TrueFalse="--space_after_comma|" -ValueDefault=0 - -[Space around assignment] -Category=1 -Description="Space around = .= += -= *= /= <<<" -EditorType=boolean -TrueFalse="--space_around_assignment|" -ValueDefault=0 - -[Align block +3 assigned variables] -Category=1 -Description="Align block +3 assigned variables" -EditorType=boolean -TrueFalse="--align_var_assignment|" -ValueDefault=0 - -[Space around comparison] -Category=1 -Description="Space around == === != !== > >= < <=" -EditorType=boolean -TrueFalse="--space_around_comparison|" -ValueDefault=0 - -[Space around arithmetic] -Category=1 -Description="Space around - + * / %" -EditorType=boolean -TrueFalse="--space_around_arithmetic|" -ValueDefault=0 - -[Space around logical] -Category=1 -Description="Space around && || AND OR XOR << >>" -EditorType=boolean -TrueFalse="--space_around_logical|" -ValueDefault=0 - -[Space around colon and question] -Category=1 -Description="Space around ? :" -EditorType=boolean -TrueFalse="--space_around_colon_question|" -ValueDefault=0 - -[Blank line before keyword] -Category=2 -Description="Blank line before keyword" -EditorType=boolean -TrueFalse="--line_before_function|" -ValueDefault=0 - -[Opening bracket on next line] -Category=2 -Description="Opening bracket on next line" -EditorType=boolean -TrueFalse="--line_before_curly_function|" -ValueDefault=0 - -[Blank line below opening bracket] -Category=2 -Description="Blank line below opening bracket" -EditorType=boolean -TrueFalse="--line_after_curly_function|" -ValueDefault=0 - -[Space around ->] -Category=2 -Description="Space around ->" -EditorType=boolean -TrueFalse="--space_around_obj_operator|" -ValueDefault=0 - -[Space around ::] -Category=2 -Description="Space around ::" -EditorType=boolean -TrueFalse="--space_around_double_colon|" -ValueDefault=0 - -[Space before parentheses] -Category=3 -Description="Space between keyword and opening parentheses" -EditorType=boolean -TrueFalse="--space_after_if|" -ValueDefault=0 - -[Keep else/elseif along with bracket] -Category=3 -Description="Keep else/elseif along with bracket" -EditorType=boolean -TrueFalse="--else_along_curly|" -ValueDefault=0 - -[Opening bracket on next line] -Category=3 -Description="Opening bracket on next line" -EditorType=boolean -TrueFalse="--line_before_curly|" -ValueDefault=0 - -[Add missing brackets] -Category=3 -Description="Add missing brackets to single line structs" -EditorType=boolean -TrueFalse="--add_missing_braces|" -ValueDefault=0 - -[Blank line after case "break"] -Category=3 -Description="Blank line after case 'break'" -EditorType=boolean -TrueFalse="--line_after_break|" -ValueDefault=0 - -[Space between "for" elements] -Category=3 -Description="Space between 'for' elements" -EditorType=boolean -TrueFalse="--space_inside_for|" -ValueDefault=0 - -[Extra indent for "Case" and "Default"] -Category=3 -Description="Extra indent for 'Case' and 'Default'" -EditorType=boolean -TrueFalse="--indent_case|" -ValueDefault=0 - -[Opening array parentheses on next line] -Category=4 -Description="Opening array parentheses on next line" -EditorType=boolean -TrueFalse="--line_before_array|" -ValueDefault=0 - -[Non-empty arrays as vertical block] -Category=4 -Description="Non-empty arrays as vertical block" -EditorType=boolean -TrueFalse="--vertical_array|" -ValueDefault=0 - -[Align block +3 assigned array elements] -Category=4 -Description="Align block +3 assigned array elements" -EditorType=boolean -TrueFalse="--align_array_assignment|" -ValueDefault=0 - -[Space around double arrow] -Category=4 -Description="Space around double arrow" -EditorType=boolean -TrueFalse="--space_around_double_arrow|" -ValueDefault=0 - -[Concatenation as vertical block] -Category=4 -Description="Concatenation as vertical block" -EditorType=boolean -TrueFalse="--vertical_concat|" -ValueDefault=0 - -[Space around concat elements] -Category=4 -Description="Space around concat elements" -EditorType=boolean -TrueFalse="--space_around_concat|" -ValueDefault=0 - -[Blank line before multi-line comment] -Category=5 -Description="Blank line before multi-line comment (/*)" -EditorType=boolean -TrueFalse="--line_before_comment_multi|" -ValueDefault=0 - -[Blank line after multi-line comment] -Category=5 -Description="Blank line after multi-line comment (/*)" -EditorType=boolean -TrueFalse="--line_after_comment_multi|" -ValueDefault=0 - -[Blank line before single line comments] -Category=5 -Description="Blank line before single line comments (//)" -EditorType=boolean -TrueFalse="--line_before_comment|" -ValueDefault=0 - -[Blank line after single line comments] -Category=5 -Description="Blank line after single line comments (//)" -EditorType=boolean -TrueFalse="--line_after_comment|" -ValueDefault=0 diff --git a/indenters/__TODO/uigui_php_Beautifier.ini b/indenters/__TODO/uigui_php_Beautifier.ini deleted file mode 100755 index ab5364d..0000000 --- a/indenters/__TODO/uigui_php_Beautifier.ini +++ /dev/null @@ -1,108 +0,0 @@ -[header] -categories=General -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.php|*.phpt|*.phps -indenterFileName=php_beautifier -indenterName=PHP_Beautifier (PHP) -inputFileName=indentinput -inputFileParameter="-f " -manual=http://beautifyphp.sourceforge.net/docs/PHP_Beautifier/tutorial_PHP_Beautifier.howtouse.commandline.pkg.html -outputFileName=indentoutput -outputFileParameter="-o " -parameterOrder=iop -showHelpParameter=--help -stringparaminquotes=false -useCfgFileParameter= -version=0.1.13 - -[Indent With Spaces] -CallName="-s" -Category=1 -Description=Indent the code with the set number of spaces. -EditorType=numeric -Enabled=true -MaxVal=99 -MinVal=0 -ValueDefault=4 - -[Indent With Tabs] -CallName="-t" -Category=1 -Description=Indent the code with the set number of tabs. -EditorType=numeric -Enabled=false -MaxVal=99 -MinVal=0 -ValueDefault=1 - -[Add Header] -Category=0 -Choices="-l \"Pear(add_header=php)\"|-l \"Pear(add_header=bsd)\"|-l \"Pear(add_header=apache)\"|-l \"Pear(add_header=lgpl)\"|-l \"Pear(add_header=pear)\"" -ChoicesReadable="PHP|BSD|Apache|LGPL|PEAR" -Description="Adds header information to a file. These can be Php, BSD, Apache, LGPL or Pear license info." -EditorType=multiple -Enabled=true -ValueDefault=0 - -[Newline Class] -Category=0 -Description=Add a new line after class before opening brace. -EditorType=boolean -TrueFalse="-l \"Pear(newline_class=true)\"|-l \"Pear(newline_class=false)\"" -ValueDefault=1 - -[Newline Function] -Category=0 -Description=Add a new line after function before opening brace. -EditorType=boolean -TrueFalse="-l \"Pear(newline_function=true)\"|-l \"Pear(newline_function=false)\"" -ValueDefault=1 - -[New Lines Before] -CallName="-l \"NewLines(before=" -Category=0 -Description="Add new lines before specific keywords. Keywords are separated by a single colon. Example: if:switch:T_CLASS
The string MUST end with a closing brace and an escaped double quote." -EditorType=string -Enabled=false -ValueDefault="if:switch:T_CLASS)\"" - -[New Lines After] -CallName="-l \"NewLines(after=" -Category=0 -Description="Add new lines after specific keywords. Keywords are separated by a single colon. Example: T_COMMENT:function
The string MUST end with a closing brace and an escaped double quote." -EditorType=string -Enabled=false -ValueDefault="T_COMMENT:function)\"" - -[Arrays Nested] -Category=0 -Description= -EditorType=boolean -TrueFalse="-l \"ArrayNested()\"|" -ValueDefault=0 - -[Lowercase] -Category=0 -Description=Lowercases all control structures. -EditorType=boolean -TrueFalse="-l \"Lowercase()\"|" -ValueDefault=0 - -[List Class And Functions] -Category=0 -Choices="-l \"ListClassFunction(list_classes=true)\"|-l \"ListClassFunction(list_functions=true)\"|-l \"ListClassFunction()\"" -ChoicesReadable="List Classes|List Functions|List Classes And Functions" -Description=Create a list of functions and classes in the script By default, this Filter puts the list at the beggining of the script. If you want it in another position, put a comment like that 
 // Class and Function List
The script lookup for the string 'Class and Function List' in a comment and replace the entire comment with the list. -EditorType=multiple -Enabled=false -ValueDefault=0 - -[Indent Styles] -Category=0 -Choices="-l \"IndentStyles(style=k&r)\"|-l \"IndentStyles(style=allman)\"|-l \"IndentStyles(style=whitesmiths)\"|-l \"IndentStyles(style=gnu)\"" -ChoicesReadable="K&R|Allman|Whitesmiths|GNU" -Description= -EditorType=multiple -Enabled=false -ValueDefault=0 diff --git a/indenters/__TODO/uigui_pindent.ini b/indenters/__TODO/uigui_pindent.ini deleted file mode 100755 index ae17620..0000000 --- a/indenters/__TODO/uigui_pindent.ini +++ /dev/null @@ -1,54 +0,0 @@ -[header] -categories=General options -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.py -indenterFileName=pindent.py -indenterName=PIndent (Python) -inputFileName=indentinput -inputFileParameter= -manual=http://coverage.livinglogic.de/Tools/scripts/pindent.py.html -outputFileName=indentinput -outputFileParameter=none -stringparaminquotes=false -parameterOrder=pio -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version="from Python 2.5.1 package" - -[End directives] -Category=0 -Description="Complete takes a valid Python program as input and outputs a version augmented with block-closing comments (add #end directives).
Or Delete assumes its input is a Python program with block-closing comments and outputs a commentless version(delete #end directives).
Or Reformat assumes its input is a Python program with block-closing comments but with its indentation messed up, and outputs a properly indented version (use #end directives)." -Enabled=true -EditorType=multiple -Choices="-c|-d|-r" -ChoicesReadable="Complete|Delete|Reformat" -ValueDefault=0 - -[Step size] -Category=0 -Description="Sets the indentation step size." -Enabled=true -EditorType=numeric -CallName="-s " -MinVal=0 -MaxVal=999 -ValueDefault=8 - -[Tab size] -Category=0 -Description="Sets the number of spaces a tab character is worth." -Enabled=true -EditorType=numeric -CallName="-t " -MinVal=0 -MaxVal=999 -ValueDefault=8 - -[Convert Tabs] -Category=0 -Description="Expand TABs into spaces." -EditorType=boolean -TrueFalse=-e| -ValueDefault=0 diff --git a/indenters/__TODO/uigui_psti.ini b/indenters/__TODO/uigui_psti.ini deleted file mode 100755 index 9a1acb7..0000000 --- a/indenters/__TODO/uigui_psti.ini +++ /dev/null @@ -1,196 +0,0 @@ -[header] -categories=General options|Spaces|Indentation|Alignments -cfgFileParameterEnding=cr -configFilename=psti.cfg -fileTypes=*.sql -indenterFileName=psti.exe -indenterName=Pl/Sql tidy (Pl/Sql) -inputFileName=indentinput -inputFileParameter="-i " -manual=http://psti.equinoxbase.com/manual.html -outputFileName=indentoutput -outputFileParameter="-o " -stringparaminquotes=false -parameterOrder=iop -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter="-ls " -version=1.2 - -[Disable all switches] -Category=0 -Description="Sets all switches to off." -Enabled=false -EditorType=boolean -TrueFalse=-0| -ValueDefault=0 - -[Uppercase Keywords] -Category=0 -Description="Uppercase Keywords." -Enabled=false -EditorType=boolean -TrueFalse=-uk+|-uk- -ValueDefault=0 - -[Capitalized Keywords] -Category=0 -Description="Capitalized Keywords." -Enabled=false -EditorType=boolean -TrueFalse=-ck+|-ck- -ValueDefault=0 - -[Lowercase Keywords] -Category=0 -Description="Lowercase Keywords." -Enabled=false -EditorType=boolean -TrueFalse=-lk+|-lk- -ValueDefault=0 - -[Uppercase Identifiers] -Category=0 -Description="Uppercase Identifiers." -Enabled=false -EditorType=boolean -TrueFalse=-ui+|-ui- -ValueDefault=0 - -[Lowercase Identifiers] -Category=0 -Description="Lowercase Identifiers." -Enabled=false -EditorType=boolean -TrueFalse=-li+|-li- -ValueDefault=0 - -[Capitalized Identifiers] -Category=0 -Description="Capitalized Identifiers." -Enabled=false -EditorType=boolean -TrueFalse=-ci+|-ci- -ValueDefault=0 - -[Compactify] -Category=1 -Description="Compactify, remove redundant spaces/keep." -Enabled=false -EditorType=boolean -TrueFalse=-c+|-c- -ValueDefault=0 - -[Remove Operation Spaces] -Category=1 -Description="Remove spaces around operations (+,- etcdo nothing/)." -Enabled=false -EditorType=boolean -TrueFalse=-co+|-co- -ValueDefault=0 - -[Add Operation Spaces] -Category=1 -Description="Add space around operations/do nothing." -Enabled=false -EditorType=boolean -TrueFalse=-sao+|-sao- -ValueDefault=0 - -[Remove Space Open Bracket] -Category=1 -Description="Remove spaces after opening brackets/keep." -Enabled=false -EditorType=boolean -TrueFalse=-rsaob+|-rsaob- -ValueDefault=0 - -[Don't Remove Bracket Space] -Category=1 -Description="Don't remove spaces around brackets/do nothing." -Enabled=false -EditorType=boolean -TrueFalse=-ncb+|-ncb- -ValueDefault=0 - -[Indent Size] -Category=2 -Description="Indent size in spaces or in tabs (generally)." -Enabled=true -EditorType=numeric -CallName="-is " -MinVal=0 -MaxVal=1024 -ValueDefault=4 - -[Indent Lines] -Category=2 -Description="Whether to indent strings lines." -Enabled=true -EditorType=boolean -TrueFalse=-in+|-in- -ValueDefault=1 - -[Keep relative indentation] -Category=2 -Description="Keep the relative identation of an allowed sql/do nothing." -Enabled=false -EditorType=boolean -TrueFalse=-rs+|-rs- -ValueDefault=0 - -[Indent after exception] -Category=2 -Description="Extra indentation after exception when yes/no." -Enabled=false -EditorType=boolean -TrueFalse=-iaew+|-iaew- -ValueDefault=0 - -[Indent after case] -Category=2 -Description="Extra indentation after case when yes/no." -Enabled=false -EditorType=boolean -TrueFalse=-iacw+|-iacw- -ValueDefault=0 - -[Indent after cursor] -Category=2 -Description="Extra indentation after cursor yes/no." -Enabled=false -EditorType=boolean -TrueFalse=-iac+|-iac- -ValueDefault=0 - -[Indent comments] -Category=2 -Description="Indent standalone comments." -Enabled=false -EditorType=boolean -TrueFalse=-isc+|-isc- -ValueDefault=0 - -[Indent comments special] -Category=2 -Description="Indent standalone comments in some special cases too." -Enabled=false -EditorType=boolean -TrueFalse=-isc2+|-isc2- -ValueDefault=0 - -[Indent inside comments] -Category=2 -Description="Indent inside comments/do nothing." -Enabled=false -EditorType=boolean -TrueFalse=-iic+|-iic- -ValueDefault=0 - -[Column alignment] -Category=3 -Description="Column like lists inside brackets." -Enabled=false -EditorType=boolean -TrueFalse=-clb+|-clb- -ValueDefault=0 diff --git a/indenters/__TODO/uigui_rbeautify.ini b/indenters/__TODO/uigui_rbeautify.ini deleted file mode 100755 index 38babe1..0000000 --- a/indenters/__TODO/uigui_rbeautify.ini +++ /dev/null @@ -1,17 +0,0 @@ -[header] -categories= -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.rb -indenterFileName=rbeautify.rb -indenterName=Ruby Script Beautifier (Ruby) -inputFileName=indentinput -inputFileParameter= -manual=http://www.arachnoid.com/ruby/rubyBeautifier.html -outputFileName=indentinput -outputFileParameter=none -parameterOrder=pio -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version=2.9 diff --git a/indenters/__TODO/uigui_rubyformatter.ini b/indenters/__TODO/uigui_rubyformatter.ini deleted file mode 100755 index 1afba10..0000000 --- a/indenters/__TODO/uigui_rubyformatter.ini +++ /dev/null @@ -1,27 +0,0 @@ -[header] -categories=General -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.rb -indenterFileName=ruby_formatter.rb -indenterName=Simple Ruby Formatter (Ruby) -inputFileName=indentinput -inputFileParameter= -manual=http://raa.ruby-lang.org/project/ruby_formatter/ -outputFileName=indentinput -outputFileParameter=none -parameterOrder=pio -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version=Rev 0.6.1 - -[indent spaces] -CallName="-s " -Category=0 -Description=Indent using # spaces per indent -EditorType=numeric -Enabled=false -MaxVal=20 -MinVal=2 -ValueDefault=4 \ No newline at end of file diff --git a/indenters/__TODO/uigui_shellindent.ini b/indenters/__TODO/uigui_shellindent.ini deleted file mode 100755 index 2c36958..0000000 --- a/indenters/__TODO/uigui_shellindent.ini +++ /dev/null @@ -1,17 +0,0 @@ -[header] -categories= -cfgFileParameterEnding=" " -configFilename= -fileTypes=*.sh -indenterFileName=shellindent.awk -indenterName=Shell Code Indent (sh) -inputFileName=indentinput -inputFileParameter= -manual=http://www.bolthole.com/AWK.html -outputFileName= -outputFileParameter=stdout -parameterOrder=pio -showHelpParameter= -stringparaminquotes=false -useCfgFileParameter= -version=2008-01-10 diff --git a/indenters/__TODO/uigui_tidy.ini b/indenters/__TODO/uigui_tidy.ini deleted file mode 100755 index 1341d45..0000000 --- a/indenters/__TODO/uigui_tidy.ini +++ /dev/null @@ -1,612 +0,0 @@ -[header] -categories="HTML, XHTML, XML|Diagnostics|Pretty Print|Character Encoding|Miscellaneous" -cfgFileParameterEnding=cr -configFilename=htmltidy.cfg -fileTypes=*.html|*.htm -indenterFileName=tidy -indenterName=(HTML) Tidy -inputFileName=indentinput -inputFileParameter= -manual=http://tidy.sourceforge.net/docs/tidy_man.html -outputFileName=indentoutput -outputFileParameter="-o " -parameterOrder=poi -showHelpParameter=-h -stringparaminquotes=false -useCfgFileParameter="-q -config " -version=2007-05-24 - -[Quiet] -Category=4 -Description="This option specifies if Tidy should output the summary of the numbers of errors and warnings, or the welcome or informational messages." -EditorType=boolean -Enabled=true -TrueFalse=quiet:yes|quiet:no -ValueDefault=1 - -[Uppercase tags] -Category=0 -Description=This option specifies if Tidy should output tag names in upper case. The default is no, which results in lower case tag names, except for XML input, where the original case is preserved. -EditorType=boolean -Enabled=false -TrueFalse=uppercase-tags:yes|uppercase-tags:no -ValueDefault=0 - -[accessibility-check] -CallName=accessibility-check: -Category=1 -Description="This option specifies what level of accessibility checking, if any, that Tidy should do. Level 0 is equivalent to Tidy Classic's accessibility checking. For more information on Tidy's accessibility checking, visit the Adaptive Technology Resource Centre at the University of Toronto." -EditorType=numeric -Enabled=true -MaxVal=3 -MinVal=0 -ValueDefault=0 - -[add-xml-decl] -Category=0 -Description="This option specifies if Tidy should add the XML declaration when outputting XML or XHTML. Note that if the input already includes an declaration then this option will be ignored. If the encoding for the output is different from 'ascii', one of the utf encodings or 'raw', the declaration is always added as required by the XML standard." -EditorType=boolean -Enabled=false -TrueFalse=add-xml-decl:yes|add-xml-decl:no -ValueDefault=0 - -[add-xml-space] -Category=0 -Description="This option specifies if Tidy should add xml:space='preserve' to elements such as 
,