From 2f7d42087ccf3f7ca3742bf088b9e77f87f1e04c Mon Sep 17 00:00:00 2001 From: Hackerpilot Date: Wed, 29 Apr 2015 12:19:29 -0700 Subject: [PATCH] Fix #125 --- README.md | 22 ++++++++++++++++++ dub.json | 2 +- src/dfmt/formatter.d | 45 +++++++++++++++++++++++++++++++++--- src/dfmt/main.d | 2 +- tests/allman/issue0125.d.ref | 11 +++++++++ tests/issue0125.d | 11 +++++++++ tests/otbs/issue0125.d.ref | 10 ++++++++ 7 files changed, 98 insertions(+), 5 deletions(-) create mode 100644 tests/allman/issue0125.d.ref create mode 100644 tests/issue0125.d create mode 100644 tests/otbs/issue0125.d.ref diff --git a/README.md b/README.md index fc53863..6efecfa 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,28 @@ dfmt --inplace --space_after_cast=false --max_line_length=80 \ --soft_max_line_length=70 --brace_style=otbs file.d ``` +## Disabling formatting +Formatting can be temporarily disabled by placing the comments ```// dfmt off``` +and ```// dfmt on``` around code that you do not want formatted. + +```d +void main(string[] args) +{ + bool optionOne, optionTwo, optionThree; + + // dfmt has no way of knowing that "getopt" is special, so it wraps the + // argument list normally + getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree); + + // dfmt off + getopt(args, + "optionOne", &optionOne, + "optionTwo", &optionTwo, + "optionThree", &optionThree); + // dfmt on +} +``` + ## Configuration **dfmt** uses [EditorConfig](http://editorconfig.org/) configuration files. **dfmt**-specific properties are prefixed with *dfmt_*. diff --git a/dub.json b/dub.json index 9bf59b5..d151905 100644 --- a/dub.json +++ b/dub.json @@ -1,7 +1,7 @@ { "name": "dfmt", "description": "Dfmt is a formatter for D source code", - "version": "0.3.4", + "version": "0.4.0-alpha", "targetType": "executable", "license": "BSL-1.0", "dependencies": { diff --git a/src/dfmt/formatter.d b/src/dfmt/formatter.d index ffb4328..4ca0c31 100644 --- a/src/dfmt/formatter.d +++ b/src/dfmt/formatter.d @@ -32,7 +32,7 @@ void format(OutputRange)(string source_desc, ubyte[] buffer, OutputRange output, astInformation.cleanup(); auto tokens = byToken(buffer, config, &cache).array(); auto depths = generateDepthInfo(tokens); - auto tokenFormatter = TokenFormatter!OutputRange(tokens, depths, output, + auto tokenFormatter = TokenFormatter!OutputRange(buffer, tokens, depths, output, &astInformation, formatterConfig); tokenFormatter.format(); } @@ -74,9 +74,10 @@ struct TokenFormatter(OutputRange) * astInformation = information about the AST used to inform formatting * decisions. */ - this(const(Token)[] tokens, immutable short[] depths, OutputRange output, - ASTInformation* astInformation, Config* config) + this(const ubyte[] rawSource, const(Token)[] tokens, immutable short[] depths, + OutputRange output, ASTInformation* astInformation, Config* config) { + this.rawSource = rawSource; this.tokens = tokens; this.depths = depths; this.output = output; @@ -105,6 +106,9 @@ private: /// Output to write output to OutputRange output; + /// Used for skipping parts of the file with `dfmt off` and `dfmt on` comments + const ubyte[] rawSource; + /// Tokens being formatted const Token[] tokens; @@ -234,8 +238,43 @@ private: writeToken(); } + string commentText(size_t i) + { + import std.string : strip; + assert(tokens[i].type == tok!"comment"); + string commentText = tokens[i].text; + if (commentText[0 ..2] == "//") + commentText = commentText[2 .. $]; + else + commentText = commentText[2 .. $ - 2]; + return commentText.strip(); + } + + void skipFormatting() + { + size_t dfmtOff = index; + size_t dfmtOn = index; + foreach (i; dfmtOff + 1.. tokens.length) + { + dfmtOn = i; + if (tokens[i].type != tok!"comment") + continue; + immutable string commentText = commentText(i); + if (commentText == "dfmt on") + break; + } + write(cast(string) rawSource[tokens[dfmtOff].index .. tokens[dfmtOn].index]); + index = dfmtOn; + } + void formatComment() { + if (commentText(index) == "dfmt off") + { + skipFormatting(); + return; + } + immutable bool currIsSlashSlash = tokens[index].text[0 .. 2] == "//"; immutable prevTokenEndLine = index == 0 ? size_t.max : tokenEndLine(tokens[index - 1]); immutable size_t currTokenLine = tokens[index].line; diff --git a/src/dfmt/main.d b/src/dfmt/main.d index 4141f9a..dd92ddb 100644 --- a/src/dfmt/main.d +++ b/src/dfmt/main.d @@ -144,7 +144,7 @@ else private void printHelp() { - writeln(`dfmt 0.3.4 + writeln(`dfmt 0.4.0-alpha Options: --help | -h Print this help message diff --git a/tests/allman/issue0125.d.ref b/tests/allman/issue0125.d.ref new file mode 100644 index 0000000..ce47f77 --- /dev/null +++ b/tests/allman/issue0125.d.ref @@ -0,0 +1,11 @@ +void main(string[] args) +{ + // dfmt off + getopt(args, + "optionOne", &optionOne, + "optionTwo", &optionTwo, + "optionThree", &optionThree); + // dfmt on + + getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree); +} diff --git a/tests/issue0125.d b/tests/issue0125.d new file mode 100644 index 0000000..c22a975 --- /dev/null +++ b/tests/issue0125.d @@ -0,0 +1,11 @@ +void main(string[] args) +{ + // dfmt off + getopt(args, + "optionOne", &optionOne, + "optionTwo", &optionTwo, + "optionThree", &optionThree); + // dfmt on + + getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree); +} diff --git a/tests/otbs/issue0125.d.ref b/tests/otbs/issue0125.d.ref new file mode 100644 index 0000000..ddc369e --- /dev/null +++ b/tests/otbs/issue0125.d.ref @@ -0,0 +1,10 @@ +void main(string[] args) { + // dfmt off + getopt(args, + "optionOne", &optionOne, + "optionTwo", &optionTwo, + "optionThree", &optionThree); + // dfmt on + + getopt(args, "optionOne", &optionOne, "optionTwo", &optionTwo, "optionThree", &optionThree); +}