change method name 'post' to 'onSucceed', which is used in Java version

Author: paulzfm

src/main/scala/decaf/backend/asm/Asm.scala

@@ -42,7 +42,7 @@ class Asm(val emitter: AsmEmitter, val regAlloc: RegAlloc) extends Phase[TacProg
     emitter.emitEnd()
   }
 
-  override def post(code: String)(implicit config: Config): Unit = {
+  override def onSucceed(code: String)(implicit config: Config): Unit = {
     if (config.target.equals(Config.Target.PA5)) {
       val path = config.dstDir / config.sourceBaseName + ".s"
       val printer = new PrintWriter(path)

src/main/scala/decaf/backend/opt/Optimizer.scala

@@ -14,7 +14,7 @@ class Optimizer extends Phase[TacProg, TacProg]("optimizer") {
 
   override def transform(input: TacProg): TacProg = input
 
-  override def post(program: TacProg)(implicit config: Config): Unit = {
+  override def onSucceed(program: TacProg)(implicit config: Config): Unit = {
     if (config.target.equals(Config.Target.PA4)) { // First dump the tac program to file,
       val path = config.dstDir / config.sourceBaseName + ".tac"
       val printer = new PrintWriter(path)

src/main/scala/decaf/driver/Phase.scala

@@ -4,11 +4,39 @@ import java.io.PrintStream
 
 import decaf.driver.error.ErrorIssuer
 
+/**
+  * Compilation of a Decaf program is processed phase-by-phase. Each phase transforms a kind of language representation
+  * into another.
+  *
+  * @tparam In  type of input
+  * @tparam Out type of output
+  * @param name phase name
+  * @see [[decaf.driver.Tasks]]
+  * @see [[ErrorIssuer]]
+  */
 abstract class Phase[In, Out](val name: String) extends ErrorIssuer {
+  /**
+    * Entry of the actual transformation.
+    *
+    * @param input input
+    * @return output
+    */
   def transform(input: In): Out
 
-  def post(output: Out)(implicit config: Config): Unit = {}
+  /**
+    * A phase is said to be ''successful'', if and only if no errors occur (i.e. `!hasError()`).
+    * When a phase is successful, this method will be executed.
+    *
+    * @param output output of the transformation
+    */
+  def onSucceed(output: Out)(implicit config: Config): Unit = {}
 
+  /**
+    * Entry of the phase.
+    *
+    * @param input input
+    * @return output (if succeeds)
+    */
   def apply(input: In)(implicit config: Config): Option[Out] = {
     val out = transform(input)
     if (hasError) {
@@ -18,7 +46,7 @@ abstract class Phase[In, Out](val name: String) extends ErrorIssuer {
       }
       None
     } else {
-      post(out)
+      onSucceed(out)
       Some(out)
     }
   }

src/main/scala/decaf/frontend/parsing/Parser.scala

@@ -49,7 +49,7 @@ class Parser extends Phase[InputStream, Tree]("parser") {
     * @param tree   the syntax tree
     * @param config the compiler configuration
     */
-  override def post(tree: Tree)(implicit config: Config): Unit = {
+  override def onSucceed(tree: Tree)(implicit config: Config): Unit = {
     if (config.target == Config.Target.PA1) { // pretty only when the target is PA1
       val printer = new PrettyTree(new IndentPrinter(config.output))
       printer.pretty(tree)

src/main/scala/decaf/frontend/tac/TacGen.scala

@@ -46,7 +46,7 @@ class TacGen extends Phase[Tree, TacProg]("tacgen") with TacEmitter {
     pw.visitEnd()
   }
 
-  override def post(program: TacProg)(implicit config: Config): Unit = {
+  override def onSucceed(program: TacProg)(implicit config: Config): Unit = {
     if (config.target.equals(Config.Target.PA3)) { // First dump the tac program to file,
       val path = config.dstDir / config.sourceBaseName + ".tac"
       val printer = new PrintWriter(path)

src/main/scala/decaf/frontend/typecheck/Typer.scala

@@ -85,7 +85,7 @@ class Typer extends Phase[Tree, Tree]("typer") with Util {
     * @param tree   the typed tree
     * @param config the compiler configuration
     */
-  override def post(tree: Tree)(implicit config: Config): Unit = {
+  override def onSucceed(tree: Tree)(implicit config: Config): Unit = {
     if (config.target == Config.Target.PA2) {
       val printer = new PrettyScope(new IndentPrinter(config.output))
       printer.pretty(tree.scope)

src/main/scala/decaf/jvm/JVMGen.scala

@@ -253,7 +253,7 @@ class JVMGen extends Phase[Tree, List[JVMClass]]("jvm") with Util {
       mv.visitTypeInsn(Opcodes.CHECKCAST, internalName(clazz))
   }
 
-  override def post(output: List[JVMClass])(implicit config: Config): Unit = {
+  override def onSucceed(output: List[JVMClass])(implicit config: Config): Unit = {
     if (config.target == Config.Target.PA3_JVM) {
       output.foreach { _.writeFile(config.dstDir) }
     }