FormatToken.cpp revision 451f1e0e5040db6a114217e7bd9767bf751d5bd3
1d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper//===--- FormatToken.cpp - Format C++ code --------------------------------===// 2d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// 3d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// The LLVM Compiler Infrastructure 4d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// 5d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// This file is distributed under the University of Illinois Open Source 6d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// License. See LICENSE.TXT for details. 7d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// 8d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper//===----------------------------------------------------------------------===// 9d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper/// 10d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper/// \file 11d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper/// \brief This file implements specific functions of \c FormatTokens and their 12d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper/// roles. 13d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper/// 14d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper//===----------------------------------------------------------------------===// 15d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 16d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper#include "FormatToken.h" 17d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper#include "ContinuationIndenter.h" 18d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper#include "clang/Format/Format.h" 19d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper#include "llvm/ADT/SmallVector.h" 20d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper#include "llvm/Support/Debug.h" 21d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 22d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jaspernamespace clang { 23d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jaspernamespace format { 24d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 25d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel JasperTokenRole::~TokenRole() {} 26d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 27d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jaspervoid TokenRole::precomputeFormattingInfos(const FormatToken *Token) {} 28d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 29d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasperunsigned CommaSeparatedList::format(LineState &State, 30d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ContinuationIndenter *Indenter, 31d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper bool DryRun) { 32d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (!State.NextToken->Previous || !State.NextToken->Previous->Previous || 33d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Commas.size() <= 2) 34d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return 0; 35d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 36d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Ensure that we start on the opening brace. 37d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper const FormatToken *LBrace = State.NextToken->Previous->Previous; 38d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (LBrace->isNot(tok::l_brace) || 39d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper LBrace->Next->Type == TT_DesignatedInitializerPeriod) 40d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return 0; 41d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 42451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper // Calculate the number of code points we have to format this list. As the 43451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper // first token is already placed, we have to subtract it. 44451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper unsigned RemainingCodePoints = Style.ColumnLimit - State.Column + 45451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper State.NextToken->Previous->CodePointCount; 46451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper 47d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Find the best ColumnFormat, i.e. the best number of columns to use. 48451f1e0e5040db6a114217e7bd9767bf751d5bd3Daniel Jasper const ColumnFormat *Format = getColumnFormat(RemainingCodePoints); 49d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (!Format) 50d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return 0; 51d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 52d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Format the entire list. 53d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned Penalty = 0; 54d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned Column = 0; 55d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned Item = 0; 56d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper while (State.NextToken != LBrace->MatchingParen) { 57d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper bool NewLine = false; 58d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned ExtraSpaces = 0; 59d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 60d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // If the previous token was one of our commas, we are now on the next item. 61d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (Item < Commas.size() && State.NextToken->Previous == Commas[Item]) { 62d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (!State.NextToken->isTrailingComment()) { 63d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ExtraSpaces += Format->ColumnSizes[Column] - ItemLengths[Item]; 64d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ++Column; 65d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 66d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ++Item; 67d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 68d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 69d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (Column == Format->Columns || State.NextToken->MustBreakBefore) { 70d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Column = 0; 71d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper NewLine = true; 72d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 73d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 74d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Place token using the continuation indenter and store the penalty. 75d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Penalty += Indenter->addTokenToState(State, NewLine, DryRun, ExtraSpaces); 76d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 77d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return Penalty; 78d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} 79d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 80d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// Returns the lengths in code points between Begin and End (both included), 81d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper// assuming that the entire sequence is put on a single line. 82d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasperstatic unsigned CodePointsBetween(const FormatToken *Begin, 83d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper const FormatToken *End) { 84332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper assert(End->TotalLength >= Begin->TotalLength); 85d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return End->TotalLength - Begin->TotalLength + Begin->CodePointCount; 86d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} 87d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 88d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jaspervoid CommaSeparatedList::precomputeFormattingInfos(const FormatToken *Token) { 89332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper // FIXME: At some point we might want to do this for other lists, too. 90332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper if (!Token->MatchingParen || Token->isNot(tok::l_brace)) 91d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return; 92d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 93d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper FormatToken *ItemBegin = Token->Next; 94d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper SmallVector<bool, 8> MustBreakBeforeItem; 95d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 96d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // The lengths of an item if it is put at the end of the line. This includes 97d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // trailing comments which are otherwise ignored for column alignment. 98d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper SmallVector<unsigned, 8> EndOfLineItemLength; 99d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 100d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper for (unsigned i = 0, e = Commas.size() + 1; i != e; ++i) { 101d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Skip comments on their own line. 102d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper while (ItemBegin->HasUnescapedNewline && ItemBegin->isTrailingComment()) 103d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemBegin = ItemBegin->Next; 104d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 105d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper MustBreakBeforeItem.push_back(ItemBegin->MustBreakBefore); 106d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper const FormatToken *ItemEnd = NULL; 107d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (i == Commas.size()) { 108d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd = Token->MatchingParen; 109d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper const FormatToken *NonCommentEnd = ItemEnd->getPreviousNonComment(); 110d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemLengths.push_back(CodePointsBetween(ItemBegin, NonCommentEnd)); 111d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (Style.Cpp11BracedListStyle) { 112d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // In Cpp11 braced list style, the } and possibly other subsequent 113d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // tokens will need to stay on a line with the last element. 114d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper while (ItemEnd->Next && !ItemEnd->Next->CanBreakBefore) 115d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd = ItemEnd->Next; 116d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } else { 117d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // In other braced lists styles, the "}" can be wrapped to the new line. 118d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd = Token->MatchingParen->Previous; 119d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 120d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } else { 121d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd = Commas[i]; 122d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // The comma is counted as part of the item when calculating the length. 123332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper ItemLengths.push_back(CodePointsBetween(ItemBegin, ItemEnd)); 124d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Consume trailing comments so the are included in EndOfLineItemLength. 125d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (ItemEnd->Next && !ItemEnd->Next->HasUnescapedNewline && 126d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd->Next->isTrailingComment()) 127d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemEnd = ItemEnd->Next; 128d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 129d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper EndOfLineItemLength.push_back(CodePointsBetween(ItemBegin, ItemEnd)); 130332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper // If there is a trailing comma in the list, the next item will start at the 131332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper // closing brace. Don't create an extra item for this. 132332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper if (ItemEnd->getNextNonComment() == Token->MatchingParen) 133332c67703f63fafd26cf88fc31faeb80c1523725Daniel Jasper break; 134d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ItemBegin = ItemEnd->Next; 135d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 136d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 137d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // We can never place more than ColumnLimit / 3 items in a row (because of the 138d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // spaces and the comma). 139d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper for (unsigned Columns = 1; Columns <= Style.ColumnLimit / 3; ++Columns) { 140d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ColumnFormat Format; 141d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.Columns = Columns; 142d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.ColumnSizes.resize(Columns); 143d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.LineCount = 0; 144d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper bool HasRowWithSufficientColumns = false; 145d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned Column = 0; 146d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper for (unsigned i = 0, e = ItemLengths.size(); i != e; ++i) { 147d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (MustBreakBeforeItem[i] || Column == Columns) { 148d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ++Format.LineCount; 149d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Column = 0; 150d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 151d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (Column == Columns - 1) 152d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper HasRowWithSufficientColumns = true; 153d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper unsigned length = 154d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper (Column == Columns - 1) ? EndOfLineItemLength[i] : ItemLengths[i]; 155d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.ColumnSizes[Column] = 156d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper std::max(Format.ColumnSizes[Column], length); 157d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper ++Column; 158d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 159d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // If all rows are terminated early (e.g. by trailing comments), we don't 160d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // need to look further. 161d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (!HasRowWithSufficientColumns) 162d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper break; 163d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.TotalWidth = Columns - 1; // Width of the N-1 spaces. 164d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper for (unsigned i = 0; i < Columns; ++i) { 165d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Format.TotalWidth += Format.ColumnSizes[i]; 166d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 167d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 168d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper // Ignore layouts that are bound to violate the column limit. 169d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (Format.TotalWidth > Style.ColumnLimit) 170d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper continue; 171d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 172d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper Formats.push_back(Format); 173d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 174d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} 175d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 176d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasperconst CommaSeparatedList::ColumnFormat * 177d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel JasperCommaSeparatedList::getColumnFormat(unsigned RemainingCharacters) const { 178d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper const ColumnFormat *BestFormat = NULL; 179d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper for (SmallVector<ColumnFormat, 4>::const_reverse_iterator 180d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper I = Formats.rbegin(), 181d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper E = Formats.rend(); 182d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper I != E; ++I) { 183d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (I->TotalWidth <= RemainingCharacters) { 184d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper if (BestFormat && I->LineCount > BestFormat->LineCount) 185d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper break; 186d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper BestFormat = &*I; 187d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 188d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper } 189d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper return BestFormat; 190d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} 191d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper 192d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} // namespace format 193d4a03dbb0bdbd4908375306283cb61813bd8f454Daniel Jasper} // namespace clang 194