forks
/
dfmt
mirror of https://github.com/dlang-community/dfmt.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Better enum formatting and whitespace cleanup

This commit is contained in:
Hackerpilot 2015-01-13 01:47:06 -08:00
parent b82ef4ad60
commit 9c8abe55fa
1 changed files with 90 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

154
src/dfmt.d
View File

@ -1,28 +1,28 @@
/******************************************************************************* /*******************************************************************************
* Boost Software License - Version 1.0 - August 17th, 2003 * Boost Software License - Version 1.0 - August 17th, 2003
* *
* Permission is hereby granted, free of charge, to any person or organization * Permission is hereby granted, free of charge, to any person or organization
* obtaining a copy of the software and accompanying documentation covered by * obtaining a copy of the software and accompanying documentation covered by
* this license (the "Software") to use, reproduce, display, distribute, * this license (the "Software") to use, reproduce, display, distribute,
* execute, and transmit the Software, and to prepare derivative works of the * execute, and transmit the Software, and to prepare derivative works of the
* Software, and to permit third-parties to whom the Software is furnished to * Software, and to permit third-parties to whom the Software is furnished to
* do so, all subject to the following: * do so, all subject to the following:
* *
* The copyright notices in the Software and this entire statement, including * The copyright notices in the Software and this entire statement, including
* the above license grant, this restriction and the following disclaimer, * the above license grant, this restriction and the following disclaimer,
* must be included in all copies of the Software, in whole or in part, and * must be included in all copies of the Software, in whole or in part, and
* all derivative works of the Software, unless such copies or derivative * all derivative works of the Software, unless such copies or derivative
* works are solely in the form of machine-executable object code generated by * works are solely in the form of machine-executable object code generated by
* a source language processor. * a source language processor.
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT * FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
* SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE * SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
* FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, * FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE. * DEALINGS IN THE SOFTWARE.
******************************************************************************/ ******************************************************************************/
module dfmt; module dfmt;
@ -36,14 +36,26 @@ import std.array;
int main(string[] args) int main(string[] args)
{ {
if (args.length < 2) ubyte[] buffer;
if (args.length == 1)
{ {
writeln("File name is a required argument"); ubyte[4096] inputBuffer;
return 1; ubyte[] b;
while (true)
{
b = stdin.rawRead(inputBuffer);
if (b.length)
buffer ~= b;
else
break;
}
}
else
{
File f = File(args[1]);
buffer = new ubyte[](f.size);
f.rawRead(buffer);
} }
File f = File(args[1]);
ubyte[] buffer = new ubyte[](f.size);
f.rawRead(buffer);
LexerConfig config; LexerConfig config;
config.stringBehavior = StringBehavior.source; config.stringBehavior = StringBehavior.source;
config.whitespaceBehavior = WhitespaceBehavior.skip; config.whitespaceBehavior = WhitespaceBehavior.skip;
@ -52,15 +64,15 @@ int main(string[] args)
parseConfig.whitespaceBehavior = WhitespaceBehavior.skip; parseConfig.whitespaceBehavior = WhitespaceBehavior.skip;
StringCache cache = StringCache(StringCache.defaultBucketCount); StringCache cache = StringCache(StringCache.defaultBucketCount);
ASTInformation astInformation; ASTInformation astInformation;
FormatterConfig formatterConfig; FormatterConfig formatterConfig;
auto parseTokens = getTokensForParser(buffer, parseConfig, &cache); auto parseTokens = getTokensForParser(buffer, parseConfig, &cache);
auto mod = parseModule(parseTokens, args[1]); auto mod = parseModule(parseTokens, args.length > 1 ? args[1] : "stdin");
auto visitor = new FormatVisitor(&astInformation); auto visitor = new FormatVisitor(&astInformation);
visitor.visit(mod); visitor.visit(mod);
astInformation.cleanup(); astInformation.cleanup();
auto tokens = byToken(buffer, config, &cache).array(); auto tokens = byToken(buffer, config, &cache).array();
auto tokenFormatter = TokenFormatter(tokens, stdout, &astInformation, auto tokenFormatter = TokenFormatter(tokens, stdout, &astInformation,
&formatterConfig); &formatterConfig);
tokenFormatter.format(); tokenFormatter.format();
return 0; return 0;
} }
@ -68,12 +80,12 @@ int main(string[] args)
struct TokenFormatter struct TokenFormatter
{ {
this(const(Token)[] tokens, File output, ASTInformation* astInformation, this(const(Token)[] tokens, File output, ASTInformation* astInformation,
FormatterConfig* config) FormatterConfig* config)
{ {
this.tokens = tokens; this.tokens = tokens;
this.output = output; this.output = output;
this.astInformation = astInformation; this.astInformation = astInformation;
this.config = config; this.config = config;
} }
void format() void format()
@ -87,6 +99,8 @@ struct TokenFormatter
assert (indentLevel >= 0); assert (indentLevel >= 0);
} }
private:
void formatStep() void formatStep()
{ {
import std.range:assumeSorted; import std.range:assumeSorted;
@ -144,20 +158,20 @@ struct TokenFormatter
case tok!"cast": case tok!"cast":
writeToken(); writeToken();
break; break;
case tok!"mixin": case tok!"mixin":
writeToken(); writeToken();
write(" "); write(" ");
break; break;
default: default:
if (index + 1 < tokens.length) if (index + 1 < tokens.length)
{ {
auto next = tokens[index + 1]; auto next = tokens[index + 1];
if (next.type == tok!";" || next.type == tok!"(" if (next.type == tok!";" || next.type == tok!"("
|| next.type == tok!")" || next.type == tok!"," || next.type == tok!")" || next.type == tok!","
|| next.type == tok!"{") || next.type == tok!"{")
{ {
writeToken(); writeToken();
} }
else else
{ {
writeToken(); writeToken();
@ -312,18 +326,21 @@ struct TokenFormatter
assert (false, str(current.type)); assert (false, str(current.type));
} }
/// Pushes a temporary indent level
void pushIndent() void pushIndent()
{ {
if (tempIndent == 0) if (tempIndent == 0)
tempIndent++; tempIndent++;
} }
/// Pops a temporary indent level
void popIndent() void popIndent()
{ {
if (tempIndent > 0) if (tempIndent > 0)
tempIndent--; tempIndent--;
} }
/// Writes balanced braces
void writeBraces() void writeBraces()
{ {
import std.range : assumeSorted; import std.range : assumeSorted;
@ -349,29 +366,32 @@ struct TokenFormatter
} }
else if (current.type == tok!"}") else if (current.type == tok!"}")
{ {
// Silly hack to format enums better.
if (peekBackIs(tok!"identifier"))
newline();
write("}"); write("}");
depth--; depth--;
if (index < tokens.length && if (index < tokens.length &&
assumeSorted(astInformation.doubleNewlineLocations) assumeSorted(astInformation.doubleNewlineLocations)
.equalRange(tokens[index].index).length) .equalRange(tokens[index].index).length)
{ {
output.write("\n"); output.write("\n");
} }
if (config.braceStyle == BraceStyle.otbs) if (config.braceStyle == BraceStyle.otbs)
{ {
index++; index++;
if (index < tokens.length && current.type == tok!"else") if (index < tokens.length && current.type == tok!"else")
write(" "); write(" ");
else else
{ {
if (peekIs(tok!"case") || peekIs(tok!"default")) if (peekIs(tok!"case") || peekIs(tok!"default"))
indentLevel--; indentLevel--;
newline(); newline();
} }
} }
else else
{ {
index++; index++;
if (peekIs(tok!"case") || peekIs(tok!"default")) if (peekIs(tok!"case") || peekIs(tok!"default"))
indentLevel--; indentLevel--;
newline(); newline();
@ -411,7 +431,7 @@ struct TokenFormatter
else if (current.type == tok!")") else if (current.type == tok!")")
{ {
if (peekIs(tok!"identifier") || (index + 1 < tokens.length if (peekIs(tok!"identifier") || (index + 1 < tokens.length
&& isKeyword(tokens[index + 1].type))) && isKeyword(tokens[index + 1].type)))
{ {
writeToken(); writeToken();
write(" "); write(" ");
@ -623,21 +643,21 @@ struct TokenFormatter
/// Information about the AST /// Information about the AST
ASTInformation* astInformation; ASTInformation* astInformation;
/// Configuration /// Configuration
FormatterConfig* config; FormatterConfig* config;
} }
/// The only good brace styles /// The only good brace styles
enum BraceStyle enum BraceStyle
{ {
allman, allman,
otbs otbs
} }
/// Configuration options for formatting /// Configuration options for formatting
struct FormatterConfig struct FormatterConfig
{ {
/// Number of spaces used for indentation /// Number of spaces used for indentation
uint indentSize = 4; uint indentSize = 4;
/// Use tabs or spaces /// Use tabs or spaces
@ -652,8 +672,8 @@ struct FormatterConfig
/// Hard line wrap limit /// Hard line wrap limit
uint columnHardLimit = 120; uint columnHardLimit = 120;
/// Use the One True Brace Style /// Use the One True Brace Style
BraceStyle braceStyle = BraceStyle.otbs; BraceStyle braceStyle = BraceStyle.allman;
} }
/// ///
@ -700,6 +720,12 @@ final class FormatVisitor : ASTVisitor
functionBody.accept(this); functionBody.accept(this);
} }
override void visit(const EnumBody enumBody)
{
astInformation.doubleNewlineLocations ~= enumBody.endLocation;
enumBody.accept(this);
}
override void visit(const Unittest unittest_) override void visit(const Unittest unittest_)
{ {
astInformation.doubleNewlineLocations ~= unittest_.blockStatement.endLocation; astInformation.doubleNewlineLocations ~= unittest_.blockStatement.endLocation;
@ -718,7 +744,7 @@ final class FormatVisitor : ASTVisitor
structBody.accept(this); structBody.accept(this);
} }
override void visit(const TemplateDeclaration templateDeclaration) override void visit(const TemplateDeclaration templateDeclaration)
{ {
astInformation.doubleNewlineLocations ~= templateDeclaration.endLocation; astInformation.doubleNewlineLocations ~= templateDeclaration.endLocation;
templateDeclaration.accept(this); templateDeclaration.accept(this);