nits

Author: amarcu

src/BaseCodeBuilder.php

@@ -99,10 +99,11 @@ final public function addIf(bool $condition, string $code, ...): this {
     return $this;
   }
 
-  final protected function addLineImpl(?string $code, array<mixed> $args): this {
-    return $this
-      ->addv($code, $args)
-      ->newLine();
+  final protected function addLineImpl(
+    ?string $code,
+    array<mixed> $args,
+  ): this {
+    return $this->addv($code, $args)->newLine();
   }
 
   /**
@@ -135,6 +136,10 @@ final public function addLines(ConstVector<string> $lines): this {
     return $this;
   }
 
+  /**
+   * Indicate that the code that will follow will be inside a function, so that
+   * the indentation is taken into account for the max line length.
+   */
   final public function setIsInsideFunction(): this {
     $this->isInsideFunction = true;
     return $this;
@@ -208,6 +213,10 @@ final public function addWithSuggestedLineBreaks(
     return $this->add(implode("\n  ", $final_lines->toArray()));
   }
 
+  /**
+   * Similar to addWithSuggestedLineBreaks but allows to add more than one
+   * line at a time.  See that method for more information.
+   */
   final public function addLinesWithSuggestedLineBreaks(
     Vector<string> $lines,
   ): this {

src/CodegenClass.php

@@ -30,8 +30,8 @@ final class CodegenClass
   private bool $isAbstract = false;
   private ?CodegenConstructor $constructor = null;
 
-  public function setIsFinal(): this {
-    $this->isFinal = true;
+  public function setIsFinal(bool $value = true): this {
+    $this->isFinal = $value;
     return $this;
   }
 
@@ -41,7 +41,6 @@ public function setIsAbstract(bool $value = true): this {
   }
 
   public function setExtends(string $name): this {
-    invariant($this->extendsClass === null, 'extends has already been set');
     $this->extendsClass = $name;
     return $this;
   }
@@ -50,48 +49,34 @@ public function getExtends(): ?string {
     return $this->extendsClass;
   }
 
-  public function getInheritedMethods(): Set<string> {
-    $classname_to_methods = $classname ==> {
-      try {
-        return (new Vector((new ReflectionClass($classname))->getMethods()))
-          ->filter($m ==> !$m->isPrivate())
-          ->map($m ==> $m->getName());
-      } catch (ReflectionException $e) {
-        // The class doesn't exist (often seen in unit tests).
-        // Well, I guess it doesn't have any methods then.
-        return Set {};
-      }
-    };
-
-    $methods = Set {};
-
-    $methods->addAll($classname_to_methods($this->getExtends()));
-    foreach ($this->getImplements() as $interface) {
-      $methods->addAll($classname_to_methods($interface));
-    }
-    foreach ($this->getUses() as $trait) {
-      $methods->addAll($classname_to_methods($trait));
-    }
-
-    $dynamic_yield_methods = $methods->filter(
-      $method_name ==> Str::startsWith($method_name, 'gen')
-    )->map($gen_method_name ==>
-      'get' . Str::substr($gen_method_name, 3, Str::len($gen_method_name)-3)
-    );
-
-    return $methods->addAll($dynamic_yield_methods);
-  }
 
   public function setConstructor(CodegenConstructor $constructor): this {
     $this->constructor = $constructor;
     return $this;
   }
 
+  /**
+   * Add a comment before the class.  Notice that you need to pass the
+   * comment characters.  Use this just for HH_FIXME or other ad-hoc uses.
+   * For commenting the class, use method setDocBlock.
+   * Example (a fake space was included between / and * to avoid a hack error
+   * in this comment, but normally you won't have it):
+   *
+   * $class->addDeclComment('/ * HH_FIXME[4040] * /');
+   */
   final public function addDeclComment(string $comment): this {
     $this->declComment .= $comment."\n";
     return $this;
   }
 
+  /**
+   * Add a function to wrap calls to the class.  E.g., for MyClass accepting
+   * a string parameter it would generate:
+   *
+   * function MyClass(string $s): MyClass {
+   *   return new MyClass($s);
+   * }
+   */
   public function addConstructorWrapperFunc(
     ?Vector<string> $params = null,
   ): this {

src/CodegenClassBase.php

@@ -43,6 +43,13 @@ public function getName(): string {
     return $this->name;
   }
 
+  /**
+   * E.g.
+   * $class->setGenericsDecl(Map {'TRead' => null, 'TWrite' => 'T'})
+   *
+   * Will generate:
+   * class MyClass<TRead, TWrite as T> {
+   */
   public function setGenericsDecl(Map<string, ?string> $generics_decl): this {
     $this->genericsDecl = $generics_decl;
     return $this;
@@ -66,14 +73,12 @@ public function setDocBlock(string $comment): this {
     return $this;
   }
 
-  public function setGeneratedFrom(
-    CodegenGeneratedFrom $from
-  ): this {
+  public function setGeneratedFrom(CodegenGeneratedFrom $from): this {
     $this->generatedFrom = $from;
     return $this;
   }
 
-  public function getUses(): Vector<string> {
+  protected function getTraits(): Vector<string> {
     // Trait<T> becomes Trait
     return $this->traits
       ->map($trait ==> {
@@ -135,17 +140,27 @@ public function addAbstractTypeConst(
   public function addClassNameConst(
     string $type,
     string $name,
-    string $value,
     ?string $comment = null,
   ): this {
     return $this->addConst(
-      'classname<'.$type.'> '.$name,
-      $value,
+      sprintf('classname<%s> %s', $type, $name),
+      sprintf('%s::class', $type),
       $comment,
       HackBuilderValues::LITERAL,
     );
   }
 
+  public function addAbstractClassNameConst(
+    string $type,
+    string $name,
+    ?string $comment = null,
+  ): this {
+    return $this->addAbstractConst(
+      sprintf('classname<%s> %s', $type, $name),
+      $comment,
+    );
+  }
+
   public function addConst(
     string $name,
     mixed $value,
@@ -172,6 +187,13 @@ public function addVar(CodegenMemberVar $var): this {
     return $this;
   }
 
+  /**
+   * If value is set to true, the class will have a section for manually adding
+   * methods.  You may specify a name for the section, which will appear in
+   * the comment and is used to merge the code when re-generating it.
+   * You may also specify a default content for the manual section, e.g.
+   * a comment indicating that additional methods should be placed there.
+   */
   public function setHasManualMethodSection(
     bool $value = true,
     ?string $name = null,
@@ -183,6 +205,13 @@ public function setHasManualMethodSection(
     return $this;
   }
 
+  /**
+   * If value is set to true, the class will have a section for manually adding
+   * declarations.  You may specify a name for the section, which will appear in
+   * the comment and is used to merge the code when re-generating it.
+   * You may also specify a default content for the manual section, e.g.
+   * a comment indicating that additional declarations should be placed there.
+   */
   public function setHasManualDeclarations(
     bool $value = true,
     ?string $name = null,

src/CodegenFunctionBase.php

@@ -9,7 +9,7 @@
  */
 
 /**
- * Base class to generate a function
+ * Base class to generate a function or a method.
  */
 abstract class CodegenFunctionBase
   implements ICodeBuilderRenderer {
@@ -104,9 +104,7 @@ public function setDocBlock(string $comment): this {
     return $this;
   }
 
-  public function setGeneratedFrom(
-    CodegenGeneratedFrom $from
-  ): this {
+  public function setGeneratedFrom(CodegenGeneratedFrom $from): this {
     $this->generatedFrom = $from;
     return $this;
   }

src/CodegenImplementsInterface.php

@@ -40,9 +40,7 @@ public function setComment(string $format, ...): this {
     return $this;
   }
 
-  public function setGeneratedFrom(
-    CodegenGeneratedFrom $from
-  ): this {
+  public function setGeneratedFrom(CodegenGeneratedFrom $from): this {
     $this->setComment($from->render());
     return $this;
   }

src/CodegenTrait.php

@@ -34,7 +34,8 @@ public function addRequireInterface(string $interface): this {
   }
 
   protected function buildDeclaration(HackBuilder $builder): void {
-    $builder->add('trait ' . $this->name);
+    $generics_dec = $this->buildGenericsDeclaration();
+    $builder->add('trait ' . $this->name.$generics_dec);
     $this->renderInterfaceList($builder, 'implements');
   }
 

src/HackBuilder.php

@@ -511,7 +511,7 @@ public function endForeachLoop(): this {
    *
    * example:
    *
-   * php_builder()
+   * hack_builder()
    *   ->startSwitch('$soccer_player')
    *   ->addCaseBlocks(
    *     $players,
@@ -759,6 +759,6 @@ private function assertIsVariable(string $name): void {
   }
 }
 
-function hack_builder() : HackBuilder {
+function hack_builder(): HackBuilder {
   return new HackBuilder(HackCodegenConfig::getInstance());
 }