Add 'addVerbatim' to BaseCodeBuilder

fredemmott · fredemmott · commit e40ff6cceb7c · 2018-11-02T11:04:08.000-07:00
fixes hhvm#107
diff --git a/src/BaseCodeBuilder.php b/src/BaseCodeBuilder.php
@@ -81,9 +81,42 @@ final public function add(?string $code): this {
     return $this->addf('%s', $code);
   }
 
+  /**
+   * Add the specified code with no additional processing.
+   *
+   * For example, if there is a newline, any following characters will not be
+   * indented. This is useful for heredocs.
+   *
+   * @see addVerbatimf
+   */
+  final public function addVerbatim(string $code): this {
+    $this->code->append($code);
+    return $this;
+  }
+
+	/**
+	 * Add the specified code with a %-placeholder format string, but no further
+   * processing.
+	 *
+	 * For example, if there is a newline, any following characters will not be
+	 * indented. This is useful for heredocs.
+	 *
+	 * @see addVerbatim
+	 */
+  final public function addVerbatimf(
+    Str\SprintfFormatString $code,
+    mixed ...$args
+  ): this {
+    $this->code->append(\vsprintf($code, $args));
+    return $this;
+  }
+
   /** Add code to the buffer, using a % placeholder format string. */
-  final public function addf(Str\SprintfFormatString $code, mixed ...$args): this {
-    return $this->addvf((string) $code, $args);
+  final public function addf(
+    Str\SprintfFormatString $code,
+    mixed ...$args
+  ): this {
+    return $this->addvf((string)$code, $args);
   }
 
   /** Add code to the buffer, using a % placeholder format string and
@@ -111,10 +144,11 @@ final protected function addvf(string $code, array<mixed> $args): this {
     // if we're in a new line, insert indentation
     if ($this->isNewLine) {
       if ($this->indentationLevel !== 0) {
-        if ($this->config->shouldUseTabs()){
+        if ($this->config->shouldUseTabs()) {
           $this->code->append(Str\repeat("\t", $this->indentationLevel));
         } else {
-          $n = $this->config->getSpacesPerIndentation() * $this->indentationLevel;
+          $n =
+            $this->config->getSpacesPerIndentation() * $this->indentationLevel;
           $this->code->append(Str\repeat(' ', $n));
         }
       }
@@ -129,10 +163,7 @@ final protected function addvf(string $code, array<mixed> $args): this {
   /**
    * If the condition is true, add code to the buffer; otherwise, do nothing.
    */
-  final public function addIf(
-    bool $condition,
-    string $code,
-  ): this {
+  final public function addIf(bool $condition, string $code): this {
     if ($condition) {
       $this->add($code);
     }
@@ -149,7 +180,7 @@ final public function addIff(
     mixed ...$args
   ): this {
     if ($condition) {
-      $this->addvf((string) $code, $args);
+      $this->addvf((string)$code, $args);
     }
     return $this;
   }
@@ -161,18 +192,15 @@ final protected function addLineImplvf(
     ?string $code,
     array<mixed> $args,
   ): this {
-    return $this->addvf((string) $code, $args)->newLine();
+    return $this->addvf((string)$code, $args)->newLine();
   }
 
   /**
    * If the condition is true, append the code followed by a newline.
    *
    * @see addLineIff
    */
-  final public function addLineIf(
-    bool $condition,
-    string $code,
-  ): this {
+  final public function addLineIf(bool $condition, string $code): this {
     return $this->addLineIff($condition, '%s', $code);
   }
 
@@ -186,7 +214,7 @@ final public function addLineIff(
     mixed ...$args
   ): this {
     if ($condition) {
-      $this->addLineImplvf((string) $code, $args);
+      $this->addLineImplvf((string)$code, $args);
     }
     return $this;
   }
diff --git a/tests/HackBuilderTest.codegen b/tests/HackBuilderTest.codegen
@@ -235,6 +235,14 @@ $foo = Vector {
   },
 };
 
+!@#$%codegentest:testVerbatimString
+function foo(): void {
+  $x = <<<EOF
+foo bar
+EOF;
+  return $x;
+}
+
 !@#$%codegentest:testWrappedStringDoNotIndent
 $this->callMethod(
   'This string is quite long so will spread across three lines but the user '.
diff --git a/tests/HackBuilderTest.php b/tests/HackBuilderTest.php
@@ -155,6 +155,23 @@ public function testWrappedStringMulti(): void {
     )->toBeUnchanged();
   }
 
+  public function testVerbatimString(): void {
+    expect_with_context(
+      static::class,
+      $this
+        ->getHackBuilder()
+        ->addLine('function foo(): void {')
+        ->indent()
+        ->add('$x = ')
+        ->addVerbatim("<<<EOF\nfoo bar\nEOF;")
+        ->ensureNewLine()
+        ->addLine('return $x;')
+        ->unindent()
+        ->addLine('}')
+        ->getCode(),
+    )->toBeUnchanged();
+  }
+
   public function testWrappedStringDoNotIndent(): void {
     expect_with_context(static::class,
       $this
