laika.io.ops.TextOutputOps.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2012-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package laika.io.ops

import java.io.File
import cats.effect.Sync
import laika.io.model.{DirectoryOutput, FilePath, TreeOutput}

import scala.io.Codec

/** API for specifying the tree of character outputs for a rendering operation.
  *
  * It allows any class merging in this trait to define all input related operations
  * in terms of the only abstract method `toOutput`.
  *
  * @author Jens Halm
  */
trait TextOutputOps[F[_]] {

  def F: Sync[F]

  type Result

  /** Builder step that instructs the runtime to render the document tree to files
    * in the specified directory and its subdirectories.
    * 
    * The virtual paths of the document tree will be translated to a directory structure,
    * with the root of the virtual path being the directory specified with this method.
    * 
    * @param name the name of the directory to write to
    * @param codec the character encoding of the files, if not specified the platform default will be used.
    */
  def toDirectory (name: String)(implicit codec: Codec): Result = toDirectory(FilePath.parse(name))

  /** Builder step that instructs the runtime to render the document tree to files
    * in the specified directory and its subdirectories.
    *
    * The virtual paths of the document tree will be translated to a directory structure,
    * with the root of the virtual path being the directory specified with this method.
    *
    * @param dir the directory to write to
    * @param codec the character encoding of the files, if not specified the platform default will be used.
    */
  def toDirectory (dir: FilePath)(implicit codec: Codec): Result = toOutput(DirectoryOutput(dir, codec))

  @deprecated("use toDirectory(String) or toDirectory(FilePath)", "0.19.0")
  def toDirectory (dir: File)(implicit codec: Codec): Result = toDirectory(FilePath.fromJavaFile(dir))

  @deprecated("use toDirectory(String) or toDirectory(FilePath) using a relative path", "0.19.0")
  def toWorkingDirectory (implicit codec: Codec): Result = 
    toOutput(DirectoryOutput(FilePath.parse(System.getProperty("user.dir")), codec))

  /** Builder step that instructs the runtime to render
    * to the specified tree output.
    *
    * This is a generic method based on Laika's IO model that concrete
    * methods delegate to.
    */
  def toOutput (tree: TreeOutput): Result

}