Comments & Indentation bugfix

[jvcoutinho]

This PR fixes #42.

Comments

• Fixed a bug where orphan comments were typically lost after a merge.
  • The start and final tokens of a class declaration body ("{" and "}" brackets, respectively), are now both FSTTerminals. This allows the orphan comments of a class to be addressed as prefixes (and we can indent them properly).
• Fixed a bug where renaming handlers did not take account prefixes.
• Added more tests for comments.
• Prefix merge avoids two-way merges to prevent false positives, performing fast-forward merges instead.

Indentation

• The program does preserve the indentation now, including tabs/spaces difference and with conflict scenarios.
• Created a new PrettyPrinter (with the feeling of Suggestion: extend FST classes to S3M classes #92). The generator automatically changes the inheritance of the generated pretty-printer to this one.
• New feature (debatable): if left and right add the exact same comment but at different lines, we don't textual merge them (this would lead to a duplicate at the end). Instead, we choose the contribution with more blank lines after the comment to fast-forward.

[jvcoutinho]

O erro do Travis, aparentemente, é um bug do lado deles.

[pauloborba]

@guilhermejccavalcanti have you checked this? is there a better approach for handling comments at the end of class declarations?

[guilhermejccavalcanti]

I couldn't think of a better solution.

[guilhermejccavalcanti]

até entendo a necessidade da gambiarra, mas esse loop, com essas constantes hardcoded fica complicado de entender. eheheh qual o significado?

[guilhermejccavalcanti]

@jvcoutinho falta o comentário ainda?

[jvcoutinho]

@guilhermejccavalcanti pronto, tinha esquecido de dar push

[jvcoutinho]

Cê tem razão, posso comentar ou extrair uma constante. A ideia é encontrar a linha que começa a classe. Quando achar, muda a herança, coloca um import na linha anterior e apaga as 6 linhas seguintes (onde ficam os construtores). Em ter, 20 de ago de 2019 11:32, Guilherme Cavalcanti < [email protected]> escreveu:

…

***@***.**** commented on this pull request. ------------------------------ In src/main/java/br/ufpe/cin/generator/Generator.java <#89 (comment)> : > }catch(Exception e){ System.err.println("Refresh the root project folder (F5). Try again."); e.printStackTrace(); } } + + private static void alterInherits() throws IOException { + Path path = Paths.get("src/main/java/br/ufpe/cin/generated/SimplePrintVisitor.java"); + List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8); + + for (int i = 0; i < lines.size(); i++) { + if (lines.get(i).contains("extends AbstractFSTPrintVisitor")) { + lines.set(i, "public class SimplePrintVisitor extends S3MPrettyPrinter {"); + lines.set(i - 1, "import br.ufpe.cin.printers.S3MPrettyPrinter;"); + for (int j = 1; j <= 6; j++) { até entendo a necessidade da gambiarra, mas esse loop, com essas constantes hardcoded fica complicado de entender. eheheh qual o significado? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#89>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AGS5LZSHELTMGQJSLK2W4PDQFP56BANCNFSM4IGRSICQ> .

[guilhermejccavalcanti]

Entendi! Em ter, 20 de ago de 2019 às 11:37, João Victor <[email protected]> escreveu:

…

Cê tem razão, posso comentar ou extrair uma constante. A ideia é encontrar a linha que começa a classe. Quando achar, muda a herança, coloca um import na linha anterior e apaga as 6 linhas seguintes (onde ficam os construtores). Em ter, 20 de ago de 2019 11:32, Guilherme Cavalcanti < ***@***.***> escreveu: > ***@***.**** commented on this pull request. > ------------------------------ > > In src/main/java/br/ufpe/cin/generator/Generator.java > < #89 (comment) > > : > > > }catch(Exception e){ > > System.err.println("Refresh the root project folder (F5). Try again."); > > e.printStackTrace(); > > } > > } > > + > > + private static void alterInherits() throws IOException { > > + Path path = Paths.get("src/main/java/br/ufpe/cin/generated/SimplePrintVisitor.java"); > > + List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8); > > + > > + for (int i = 0; i < lines.size(); i++) { > > + if (lines.get(i).contains("extends AbstractFSTPrintVisitor")) { > > + lines.set(i, "public class SimplePrintVisitor extends S3MPrettyPrinter {"); > > + lines.set(i - 1, "import br.ufpe.cin.printers.S3MPrettyPrinter;"); > > + for (int j = 1; j <= 6; j++) { > > > até entendo a necessidade da gambiarra, mas esse loop, com essas > constantes hardcoded fica complicado de entender. eheheh qual o significado? > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > < #89 >, > or mute the thread > < https://github.com/notifications/unsubscribe-auth/AGS5LZSHELTMGQJSLK2W4PDQFP56BANCNFSM4IGRSICQ > > . > — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#89>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAZN6XLNCAYJPRJCYBHODM3QFP6RPANCNFSM4IGRSICQ> .

[pauloborba]

Faz isso. E adiciona um comentário no método explicando o propósito disto.

…

On 20 Aug 2019 11:37 -0300, João Victor ***@***.***>, wrote: Cê tem razão, posso comentar ou extrair uma constante. A ideia é encontrar a linha que começa a classe. Quando achar, muda a herança, coloca um import na linha anterior e apaga as 6 linhas seguintes (onde ficam os construtores). Em ter, 20 de ago de 2019 11:32, Guilherme Cavalcanti < ***@***.***> escreveu: > ***@***.**** commented on this pull request. > ------------------------------ > > In src/main/java/br/ufpe/cin/generator/Generator.java > <#89 (comment)> > : > > > }catch(Exception e){ > > System.err.println("Refresh the root project folder (F5). Try again."); > > e.printStackTrace(); > > } > > } > > + > > + private static void alterInherits() throws IOException { > > + Path path = Paths.get("src/main/java/br/ufpe/cin/generated/SimplePrintVisitor.java"); > > + List<String> lines = Files.readAllLines(path, StandardCharsets.UTF_8); > > + > > + for (int i = 0; i < lines.size(); i++) { > > + if (lines.get(i).contains("extends AbstractFSTPrintVisitor")) { > > + lines.set(i, "public class SimplePrintVisitor extends S3MPrettyPrinter {"); > > + lines.set(i - 1, "import br.ufpe.cin.printers.S3MPrettyPrinter;"); > > + for (int j = 1; j <= 6; j++) { > > > até entendo a necessidade da gambiarra, mas esse loop, com essas > constantes hardcoded fica complicado de entender. eheheh qual o significado? > > — > You are receiving this because you authored the thread. > Reply to this email directly, view it on GitHub > <#89>, > or mute the thread > <https://github.com/notifications/unsubscribe-auth/AGS5LZSHELTMGQJSLK2W4PDQFP56BANCNFSM4IGRSICQ> > . > — You are receiving this because your review was requested. Reply to this email directly, view it on GitHub, or mute the thread.