scripttool.go

//
// scripttool is a package focused on converting to/from different
// file formats used in working with scripts,screenplays and other
// creative writing.
//
// @author R. S. Doiel, <rsdoiel@gmail.com>
//
// BSD 2-Clause License
//
// Copyright (c) 2019, R. S. Doiel
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
//   list of conditions and the following disclaimer.
//
// * Redistributions in binary form must reproduce the above copyright notice,
//   this list of conditions and the following disclaimer in the documentation
//   and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
// OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
package scripttool

import (
	"archive/zip"
	"bytes"
	"fmt"
	"io"
	"io/ioutil"

	// My packages
	"github.com/rsdoiel/fdx"
	"github.com/rsdoiel/fountain"
	"github.com/rsdoiel/osf"
)

const (
	Version = `v0.0.4`
)

// FdxToFountain converts the an input buffer from .fdx to a .fountain format.
func FdxToFountain(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}

	document, err := fdx.Parse(src)
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", document.String())
	return nil
}

// OSFToFountain converts the input buffer from .osf to .fountain format.
func OSFToFountain(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	document, err := osf.Parse(src)
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", document.String())
	return nil
}

// Fountain2Fountain reads a input buffer as .fountain and pretty prints output as .fountain
func FountainToFountain(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	document, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", document.String())
	return nil
}

// Fountain2Fdx converts an input buffer in .fountain format to output buffer in .fdx
func FountainToFdx(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	document, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	newDoc := fountainToFdx(document)
	src, err = newDoc.ToXML()
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", src)
	return nil
}

// FountainToOSF converts an input buffer in .fountain format to output buffer in .osf
func FountainToOSF(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	document, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	newDoc := fountainToOSF(document)
	src, err = newDoc.ToXML()
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", src)
	return nil
}

// FadeInToFountain converts the input buffer from .fadein to .fountain format.
func FadeInToFountain(inputFName string, out io.Writer) error {
	// NOTE: Need to unzip, extract document.xml then pass the source
	// of document.xml to osf.Parse()
	r, err := zip.OpenReader(inputFName)
	if err != nil {
		return err
	}
	defer r.Close()
	src := []byte{}
	for _, f := range r.File {
		if f.Name == "document.xml" {
			rc, err := f.Open()
			if err != nil {
				return err
			}
			src, err = ioutil.ReadAll(rc)
			if err != nil {
				return err
			}
			rc.Close()
			break
		}
	}
	document, err := osf.Parse(src)
	if err != nil {
		return err
	}
	fmt.Fprintf(out, "%s", document.String())
	return nil
}

// FountainToFadeIn converts an input buffer in .fountain format to output buffer in .fadein
func FountainToFadeIn(in io.Reader, outFName string) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	document, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	newDoc := fountainToOSF(document)
	src, err = newDoc.ToXML()
	if err != nil {
		return err
	}
	buf := new(bytes.Buffer)
	w := zip.NewWriter(buf)
	f, err := w.Create("document.xml")
	if err != nil {
		return err
	}
	_, err = f.Write(src)
	if err != nil {
		return err
	}
	w.Close()
	//NOTE: How do we set the Zipfile's name by write our
	// buf out to disc.
	err = ioutil.WriteFile(outFName, buf.Bytes(), 0664)
	if err != nil {
		return err
	}
	return nil
}

// CharacterList lists character in a screenplay
func CharacterList(in io.Reader, out io.Writer) error {
	// What format do we have?
	// Convert to Fountain
	// collect character names
	return fmt.Errorf("CharacterList(in, out) error, not implemented")
}

// FountainToHTML takes a fountain script and formats it in
// the fountain scrippets HTML markup that can be used
// with the scrippets CSS, see https://fountain.io/scrippets
// and https://johnaugust.com/2004/screenbox.
// FIXME: Write wrapping functioHTMLon and add appropriate writer
// method to fountain package.
func FountainToHTML(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	src, err = fountain.Run(src)
	if err != nil {
		return err
	}
	_, err = out.Write(src)
	return err
}

// FountainFmt pretty prints a fountain document, optionally
// passing on sections, synopsis and notes.
func FountainFmt(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	screenplay, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	_, err = out.Write([]byte(screenplay.String()))
	return err
}

// FountainToJSON convert .fountain file to JSON
func FountainToJSON(in io.Reader, out io.Writer) error {
	src, err := ioutil.ReadAll(in)
	if err != nil {
		return err
	}
	screenplay, err := fountain.Parse(src)
	if err != nil {
		return err
	}
	src, err = screenplay.ToJSON()
	if err != nil {
		return err
	}
	_, err = out.Write(src)
	return err
}