goskew.go

// Copyright 2021 Oliver Strik
// This project includes code derived from gSkewer (https://github.com/MechanizedMedic/gskewer),
// which is licensed under the GNU General Public License version 3.0 (GPLv3).
// For the terms of the GPLv3 license, please see the LICENSE file included in this distribution.

package main

import (
	"fmt"
	"log"
	"math"
	"os"
	"path/filepath"
	"regexp"
	"strconv"
	"strings"

	"github.com/docopt/docopt-go"
	"github.com/schollz/progressbar"
)

func sq(val float64) float64 {
	return val * val
}

func triangleError(base float64, left float64, right float64) float64 {
	// calclate the height of the reference equilateral
	height := math.Sin(math.Pi/3) * 1000

	// calculate the left angle of the printed triangle
	alpha := math.Acos((sq(left) + sq(base) - sq(right)) / (2 * left * base))

	// calculate the X distance to the point at <height> along the projected left side.
	delta := height / math.Tan(alpha)

	// calculate the error in x.
	xerr := delta - 1000/2

	// return the xytan error.
	return xerr / height
}

func getCoord(in *float64, reg *regexp.Regexp, line string) {
	search := reg.FindStringSubmatch(line)

	if len(search) > 0 {
		*in, _ = strconv.ParseFloat(search[1], 64)
	}
}

func skew(input []byte, xytan float64, xztan float64, yztan float64) string {
	lines := strings.Split(string(input), "\n")

	progress := progressbar.New(len(lines))
	progress.SetWriter(os.Stderr)

	// init the coords
	xin, yin, zin := 0.0, 0.0, 0.0

	// init the regular expressions
	xreg, _ := regexp.Compile(`[xX](-?\d*\.?\d*)`)
	yreg, _ := regexp.Compile(`[yY](-?\d*\.?\d*)`)
	zreg, _ := regexp.Compile(`[zZ](-?\d*\.?\d*)`)
	g01, _ := regexp.Compile(`^\s*G[0-1]`)
	cmd, _ := regexp.Compile(`^\s*;\s*goskew\s+([^\s;]+).*$`)

	enabled := true

	for i, line := range lines {
		if enabled && g01.MatchString(line) {
			// find X, Y, and Y coords in line
			getCoord(&xin, xreg, line)
			getCoord(&yin, yreg, line)
			getCoord(&zin, zreg, line)

			// skew the X and Y. Z is unchanged to avoid squishing layers.
			xout := fmt.Sprintf("%.3f", (xin-yin*xytan)-zin*xztan)
			yout := fmt.Sprintf("%.3f", yin-zin*yztan)

			// replace the X and Y coords
			line = xreg.ReplaceAllString(line, "X"+xout)
			line = yreg.ReplaceAllString(line, "Y"+yout)

			lines[i] = line
		}

		cmatches := cmd.FindStringSubmatch(strings.ToLower(line))
		if len(cmatches) > 1 {
			switch cmatches[1] {
			case "on":
				enabled = true
			case "enable":
				enabled = true
			case "off":
				enabled = false
			case "disable":
				enabled = false
			}
		}

		progress.Add(1)
	}
	fmt.Printf("\n")
	return strings.Join(lines, "\n")
}

func main() {
	usage := `Go Skew.

Usage:
  %basename% err (--xy=<xy> | <xy>) (--xz=<xz> | <xz>) (--yz=<yz> | <yz>) [--output=FILE] <file>
  %basename% tri <base> <left> <right> [--xz=<xz> --yz=<yz> --output=FILE] [<file>]
  %basename% -h | --help

Options:
  -o FILE, --output=FILE    The file name to write out to, by default Go Skew overwrites the original file.
  --xy=ERROR                The error tangent in the XY axis.
  --xz=ERROR                The error tangent in the XZ axis.
  --yz=ERROR                The error tangent in the YZ axis.
  -h, --help
`
	basename := filepath.Base(os.Args[0])

	usage = strings.ReplaceAll(usage, "%basename%", basename)

	opts, _ := docopt.ParseDoc(usage)
	// fmt.Println(opts)

	// The tan error in all planes
	xy, xz, yz := 0.0, 0.0, 0.0

	// are we in triangle mode?
	triangle, _ := opts.Bool("tri")

	if triangle {
		fmt.Println("calculating xytan from given triangle")
		// extract options
		base, _ := opts.Float64("<base>")
		left, _ := opts.Float64("<left>")
		right, _ := opts.Float64("<right>")

		// calculate the xytan
		xy = triangleError(base, left, right)

		// get the xz and yz errors if given
		xz, _ = opts.Float64("--xz")
		yz, _ = opts.Float64("--yz")
	} else {
		var err error
		// get the tan errors.
		xy, err = opts.Float64("<xy>")
		if err != nil {
			xy, _ = opts.Float64("--xy")
		}

		xz, err = opts.Float64("<xz>")
		if err != nil {
			xz, _ = opts.Float64("--xz")
		}

		yz, err = opts.Float64("<yz>")
		if err != nil {
			yz, _ = opts.Float64("--yz")
		}
	}

	fmt.Printf("Error tangents:\nxytan: %0.7f, xztan: %0.7f, yztan: %0.7f\n", xy, xz, yz)

	iFile, _ := opts.String("<file>")
	oFile, _ := opts.String("--output")

	if iFile == "" {
		return
	}

	if oFile == "" {
		oFile = iFile
	}

	input, err := os.ReadFile(iFile)

	if err != nil {
		log.Fatalln(err)
	}

	fmt.Printf("skewing")

	output := skew(input, xy, xz, yz)

	err = os.WriteFile(oFile, []byte(output), 0644)

	if err != nil {
		log.Fatalln(err)
	}

	fmt.Println("Done!")
}