1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
|
#include "PHPFormatterBuffer.h"
#include "PHPScannerTokens.h"
#include <wx/tokenzr.h>
struct PHPScannerCollectWhitespace {
phpLexerUserData* m_userdata;
bool m_oldState;
PHPScannerCollectWhitespace(PHPScanner_t scanner)
: m_userdata(NULL)
, m_oldState(false)
{
m_userdata = ::phpLexerGetUserData(scanner);
if(m_userdata) {
m_oldState = m_userdata->IsCollectingWhitespace();
m_userdata->SetCollectingWhitespace(true);
}
}
~PHPScannerCollectWhitespace()
{
if(m_userdata) {
m_userdata->SetCollectingWhitespace(m_oldState);
}
}
};
PHPFormatterBuffer::PHPFormatterBuffer(const wxString& buffer, const PHPFormatterOptions& options)
: m_scanner(NULL)
, m_options(options)
, m_openTagWithEcho(false)
, m_forDepth(0)
, m_insideForStatement(false)
, m_insideHereDoc(false)
, m_depth(0)
, m_lastCommentLine(-1)
, m_parenDepth(0)
{
m_scanner = ::phpLexerNew(buffer, kPhpLexerOpt_ReturnComments | kPhpLexerOpt_ReturnAllNonPhp);
}
PHPFormatterBuffer::~PHPFormatterBuffer()
{
if(m_scanner) {
::phpLexerDestroy(&m_scanner);
}
}
PHPFormatterBuffer& PHPFormatterBuffer::ProcessToken(const phpLexerToken& token)
{
if(::phpLexerIsPHPCode(m_scanner)) {
// Inside PHP tags
if(m_insideHereDoc) {
m_buffer << token.Text();
if(token.type == kPHP_T_END_HEREDOC) {
AppendEOL();
if(m_options.flags & kPFF_BreakAfterHeredoc) {
AppendEOL();
}
m_insideHereDoc = false;
}
} else if(token.type == kPHP_T_OPEN_TAG) {
m_openTagWithEcho = false;
m_buffer << token.Text();
AppendEOL();
} else if(token.type == kPHP_T_OPEN_TAG_WITH_ECHO) {
m_openTagWithEcho = true;
m_buffer << token.Text() << " ";
} else if(token.type == '{') {
HandleOpenCurlyBrace();
} else if(token.type == kPHP_T_VARIABLE) {
m_buffer << token.Text() << " ";
} else if(token.type == kPHP_T_FOREACH) {
m_buffer << token.Text() << " ";
if(m_options.flags & kPFF_BreakBeforeForeach) {
InsertSeparatorLine();
}
} else if(token.type == kPHP_T_ELSE || token.type == kPHP_T_ELSEIF) {
if(m_options.flags & kPFF_ElseOnSameLineAsClosingCurlyBrace && m_lastToken.type == '}') {
ReverseClearUntilFind("}");
m_buffer << " " << token.Text() << " ";
} else {
m_buffer << token.Text() << " ";
}
} else if(token.type == kPHP_T_WHILE) {
m_buffer << token.Text() << " ";
if(m_options.flags & kPFF_BreakBeforeWhile) {
InsertSeparatorLine();
}
} else if(token.type == kPHP_T_CLASS) {
if(m_options.flags & kPFF_BreakBeforeClass) {
InsertSeparatorLine();
}
m_buffer << token.Text() << " ";
} else if(token.type == kPHP_T_FUNCTION) {
// Found a function
m_buffer << token.Text() << " ";
if(m_lastCommentLine != token.lineNumber) {
// this function has no comment associated with it
if(m_options.flags & kPFF_BreakBeforeFunction) {
// But don't insert new line separator if this keyword
// was found in a statement like:
// use function A as B;
if(m_lastToken.type != kPHP_T_USE) {
// Look backward until we find the last EOL
// and insert another one...
InsertSeparatorLine();
}
}
}
} else if(token.type == kPHP_T_START_HEREDOC) {
RemoveLastSpace();
m_buffer << token.Text();
m_insideHereDoc = true;
} else if(token.type == kPHP_T_FOR) {
// for(;;) is a special case where
// we don't insert new line after semi-colon
m_insideForStatement = true;
m_buffer << token.Text();
} else if(token.type == '(' && m_insideForStatement) {
m_forDepth++;
m_buffer << token.Text();
} else if(token.type == ')' && m_insideForStatement) {
m_forDepth--;
if(m_forDepth == 0) {
m_insideForStatement = false;
}
m_buffer << token.Text();
} else if(token.type == '(' || token.type == '[') {
RemoveLastSpace();
m_buffer << token.Text();
if(m_options.flags & kPFF_VerticalArrays && token.type == '(' && m_lastToken.type == kPHP_T_ARRAY &&
m_parenDepth == 1) {
ProcessArray('(', ')');
}
} else if(token.type == ')') {
RemoveLastSpace();
m_buffer << token.Text();
} else if(token.type == ']') {
RemoveLastSpace();
m_buffer << token.Text() << " ";
} else if(token.type == ';') {
RemoveLastSpace();
m_buffer << token.Text();
AppendEOL();
} else if(token.type == '}') {
UnIndent();
m_buffer << token.Text();
AppendEOL(kDepthDec);
} else if(token.type == ',') {
RemoveLastSpace();
m_buffer << token.Text() << " ";
} else if(token.type == '.') {
m_buffer << token.Text() << " ";
if(m_options.flags & kPFF_BreakAfterStringConcatentation && (m_parenDepth == 1)) {
// inside a function call
wxString whitepace = GetIndentationToLast('(');
if(!whitepace.IsEmpty()) {
m_buffer << m_options.eol;
m_buffer << whitepace;
}
}
} else if(token.type == '&') {
// attach reference to the next token
m_buffer << token.Text();
} else if(token.type == kPHP_T_CXX_COMMENT) {
// C++ style comment ("//")
// AppendEOL();
m_buffer << token.Text();
AppendEOL();
m_lastCommentLine = token.lineNumber + 1;
} else if(token.type == kPHP_T_C_COMMENT) {
// Doxygen style comment: we first format it to match
// the current indentation + line ending before adding
// it to the current buffer
if(m_parenDepth == 0) {
AppendEOL();
m_buffer << FormatDoxyComment(token.Text());
AppendEOL();
m_lastCommentLine = token.endLineNumber + 1;
} else {
m_buffer << token.Text() << " ";
}
} else if(token.type == kPHP_T_OBJECT_OPERATOR || token.type == kPHP_T_PAAMAYIM_NEKUDOTAYIM) {
// -> operator or ::
RemoveLastSpace();
m_buffer << token.Text();
} else if(token.type == '!') {
// dont add extrace space after the NOT operator
m_buffer << token.Text();
} else if(token.type == kPHP_T_NS_SEPARATOR) {
if(m_lastToken.type == kPHP_T_IDENTIFIER) {
RemoveLastSpace();
}
m_buffer << token.Text();
} else {
// by default, add the token text and a space after it
m_buffer << token.Text() << " ";
}
m_lastToken = token;
} else {
if(token.type == kPHP_T_CLOSE_TAG && !m_openTagWithEcho) {
AppendEOL();
}
m_buffer << token.Text();
}
return *this;
}
void PHPFormatterBuffer::HandleOpenCurlyBrace()
{
RemoveLastSpace();
m_buffer << " {";
AppendEOL(kDepthInc);
}
void PHPFormatterBuffer::AppendEOL(eDepthCommand depth)
{
m_buffer << m_options.eol;
switch(depth) {
case kDepthDec:
--m_depth;
if(m_depth < 0)
m_depth = 0;
break;
case kDepthIncTemporarily:
case kDepthInc:
++m_depth;
break;
default:
break;
}
m_buffer << GetIndent();
if(kDepthIncTemporarily == depth) {
--m_depth;
if(m_depth < 0)
m_depth = 0;
}
}
void PHPFormatterBuffer::UnIndent()
{
if(IsUseTabs() && !m_buffer.IsEmpty() && m_buffer.Last() == '\t') {
m_buffer.RemoveLast();
} else if(!IsUseTabs() && (m_buffer.length() >= m_options.indentSize) &&
m_buffer.Mid(m_buffer.length() - m_options.indentSize) == wxString(' ', m_options.indentSize)) {
m_buffer.RemoveLast(m_options.indentSize);
}
}
void PHPFormatterBuffer::RemoveLastSpace()
{
if(!m_buffer.IsEmpty() && m_buffer.Last() == ' ') {
m_buffer.RemoveLast();
}
}
wxString PHPFormatterBuffer::FormatDoxyComment(const wxString& comment)
{
if(m_parenDepth == 0) {
wxString formattedBlock;
wxString indent = GetIndent();
wxArrayString lines = ::wxStringTokenize(comment, "\n", wxTOKEN_STRTOK);
for(size_t i = 0; i < lines.GetCount(); ++i) {
lines.Item(i).Trim().Trim(false);
if(i) {
// preprend space + the indent string for every line except for the first line
lines.Item(i).Prepend(" ");
lines.Item(i).Prepend(indent);
}
formattedBlock << lines.Item(i) << m_options.eol;
}
formattedBlock.RemoveLast(m_options.eol.length());
return formattedBlock;
} else {
return comment;
}
}
wxString& PHPFormatterBuffer::GetIndent()
{
if(IsUseTabs()) {
m_indentString = wxString('\t', m_depth);
} else {
m_indentString = wxString(' ', m_depth * m_options.indentSize);
}
return m_indentString;
}
void PHPFormatterBuffer::InsertSeparatorLine()
{
size_t where = m_buffer.rfind(m_options.eol);
if(where != wxString::npos) {
m_buffer.insert(where, m_options.eol);
}
}
void PHPFormatterBuffer::ReverseClearUntilFind(const wxString& delim)
{
size_t where = m_buffer.rfind(delim);
if(where != wxString::npos) {
m_buffer = m_buffer.Mid(0, where + delim.length());
}
}
void PHPFormatterBuffer::format()
{
phpLexerToken token;
phpLexerToken::Vet_t sequence;
m_stack.push(sequence);
m_sequence = &m_stack.top();
while(NextToken(token)) {
phpLexerToken nextToken;
if(::phpLexerIsPHPCode(m_scanner)) {
ProcessToken(token);
//
// Special indentation cases
// Handle the following:
// for(..) <statement> -> for(..)
// <statement>
// if(..) <statement> -> if(..)
// <statement>
// etc.
// In addtion, we also handle here the following:
// if(something) {} else <statement> =>
// if(something) {
// } else
// <statement>
//
if(token.type == '(') {
// Create new stack
m_stack.push(phpLexerToken::Vet_t());
m_sequence = &m_stack.top();
}
if(token.type == ')') {
// switch back to the previous sequence
if(m_stack.size() >= 2) {
m_stack.pop();
m_sequence = &m_stack.top();
}
if(!m_sequence->empty()) {
phpLexerToken lastToken = m_sequence->at(m_sequence->size() - 1);
// The following tokens are usually followed by an open brace
if(lastToken.type == kPHP_T_IF || lastToken.type == kPHP_T_FOR || lastToken.type == kPHP_T_ELSEIF ||
lastToken.type == kPHP_T_FOREACH || lastToken.type == kPHP_T_WHILE) {
// Peek at the next char
if(PeekToken(nextToken)) {
if(nextToken.type != '{' && !nextToken.IsAnyComment()) {
// Increase the depth but only temporarily for the next statement
AppendEOL(kDepthIncTemporarily);
}
}
}
}
} else if(token.type == kPHP_T_ELSE) {
// Check for 'else <statement>' (without an open curly braces)
if(PeekToken(nextToken) && nextToken.type != '{' && nextToken.type != kPHP_T_IF) {
AppendEOL(kDepthIncTemporarily);
}
} else {
m_sequence->push_back(token);
}
} else {
ProcessToken(token);
}
}
}
bool PHPFormatterBuffer::NextToken(phpLexerToken& token)
{
if(m_tokensBuffer.empty()) {
bool res = ::phpLexerNext(m_scanner, token);
if(token.type == '(') {
++m_parenDepth;
} else if(token.type == ')') {
--m_parenDepth;
}
return res;
} else {
token = *m_tokensBuffer.begin();
m_tokensBuffer.erase(m_tokensBuffer.begin());
return true;
}
}
bool PHPFormatterBuffer::PeekToken(phpLexerToken& token)
{
if(!::phpLexerNext(m_scanner, token))
return false;
m_tokensBuffer.push_back(token);
return true;
}
wxString PHPFormatterBuffer::GetIndentationToLast(wxChar ch)
{
wxString whitespace;
wxString workingBuffer = m_buffer;
if(ch != '\n') {
int startPos = m_buffer.Find(ch, true);
if(startPos != wxNOT_FOUND) {
workingBuffer = m_buffer.Mid(0, startPos + 1);
} else {
return GetIndent();
}
}
int where = workingBuffer.Find('\n', true);
// did we find our match on the previous line?
if(where != wxNOT_FOUND) {
// Build the whitespace
wxString buff = workingBuffer.Mid(where + 1);
while(!buff.IsEmpty()) {
if(buff.at(0) == '\t') {
// replace tab with 4 spaces
whitespace << wxString(' ', m_options.indentSize);
} else {
whitespace << " ";
}
buff.Remove(0, 1);
}
}
if(m_options.flags & kPFF_UseTabs) {
int tabsCount = (whitespace.length() / m_options.indentSize);
int extraSpaces = (whitespace.length() % m_options.indentSize);
whitespace.clear();
whitespace << wxString('\t', tabsCount);
whitespace << wxString(' ', extraSpaces);
}
return whitespace;
}
#define SQUEEZE_WHITESPACE() m_buffer.erase(m_buffer.find_last_not_of(" \t") + 1);
void PHPFormatterBuffer::ProcessArray(int openParen, int closingChar)
{
wxString whitespace = GetIndentationToLast('\n');
int depth = 1;
// we exit at depth 0
phpLexerToken token;
// PHPScannerCollectWhitespace whitespaceCollector(m_scanner);
while(NextToken(token)) {
if(::phpLexerIsPHPCode(m_scanner)) {
// inside PHP block
if(token.type == openParen) {
++depth;
RemoveLastSpace();
m_buffer << token.Text();
} else if(token.type == closingChar) {
--depth;
RemoveLastSpace();
m_buffer << token.Text();
if(depth == 0)
break;
} else if(token.type == ',') {
// New line
RemoveLastSpace();
m_buffer << token.Text();
m_buffer << m_options.eol;
m_buffer << whitespace;
} else if(token.type == '(' || token.type == ')' || token.type == kPHP_T_OBJECT_OPERATOR ||
token.type == kPHP_T_PAAMAYIM_NEKUDOTAYIM || token.type == kPHP_T_NS_SEPARATOR ||
token.type == kPHP_T_VARIABLE || token.type == '[' || token.type == ']') {
RemoveLastSpace();
m_buffer << token.Text();
} else {
m_buffer << token.Text() << " ";
}
} else {
// Non PHP code, copy text as is
if(token.type == kPHP_T_CLOSE_TAG && !m_openTagWithEcho) {
AppendEOL();
}
m_buffer << token.Text();
}
}
}
|