Merge pull request #43 from patrislav1/wip-border

Add margin/border support

README.md

@@ -31,6 +31,7 @@ Example usage:
 --grid              Grid mode (sets position for each character)
 --help, -h          Show help
 --listcolorschemes  List color schemes
+--marginsize WxH    Margin size (in either pixel or font units)
 --transparent       Transparent background
 --version, -v       Show version
 --width, -w NUMBER  Terminal width (auto if not set)
@@ -75,6 +76,11 @@ By default, `ansisvg` uses font-relative `ch`/`em` coordinates. This should make
 
 Inkscape currently [cannot deal with SVG size expressed in font-relative units](https://gitlab.com/inkscape/inkscape/-/issues/4737), a quick workaround is Ctrl-Shift-R (resize page to content).
 
+## Margin size
+
+With `--marginsize` a margin can be defined, so there is a bit of empty space (or "border") around the image. Default is zero margin size, i.e. the terminal characters are touching the edge of the image.
+`--marginsize` is interpreted as X/Y in the currently selected units, i.e. `ch`/`em` by default, and `px` if `--charboxsize` is used.
+
 ## Consolidated text vs. grid mode
 
 By default, `ansisvg` consolidates text to `<tspan>` chunks, leaving the X positioning of characters to the SVG renderer. This usually works well for monospace fonts. However if not all glyphs involved are monospace (e.g. when exotic characters are used, making the SVG renderer fall back to a different font for those characters) then the alignment will be off; this can be worked around with `-grid` mode which will make `ansisvg` put each character to explicit positions, making the SVG bigger and less readable but ensuring proper positioning/alignment for all characters.

ansitosvg/ansisvg.go

@@ -7,6 +7,7 @@ import (
 	"github.com/wader/ansisvg/ansidecoder"
 	"github.com/wader/ansisvg/colorscheme/schemes"
 	"github.com/wader/ansisvg/svgscreen"
+	"github.com/wader/ansisvg/svgscreen/xydim"
 )
 
 type Options struct {
@@ -15,7 +16,8 @@ type Options struct {
 	FontRef       string
 	FontSize      int
 	TerminalWidth int
-	CharBoxSize   svgscreen.BoxSize
+	CharBoxSize   xydim.XyDimInt
+	MarginSize    xydim.XyDimFloat
 	ColorScheme   string
 	Transparent   bool
 	GridMode      bool
@@ -24,7 +26,8 @@ type Options struct {
 var DefaultOptions = Options{
 	FontName:    "Courier",
 	FontSize:    14,
-	CharBoxSize: svgscreen.BoxSize{Width: 0, Height: 0},
+	CharBoxSize: xydim.XyDimInt{X: 0, Y: 0},
+	MarginSize:  xydim.XyDimFloat{X: 0, Y: 0},
 	ColorScheme: "Builtin Dark",
 	Transparent: false,
 }
@@ -129,15 +132,13 @@ func Convert(r io.Reader, w io.Writer, opts Options) error {
 			FontRef:      opts.FontRef,
 			FontSize:     opts.FontSize,
 		},
-		CharacterBoxSize: svgscreen.BoxSize{
-			Width:  opts.CharBoxSize.Width,
-			Height: opts.CharBoxSize.Height,
-		},
-		TerminalWidth: terminalWidth,
-		Columns:       ad.MaxX + 1,
-		NrLines:       ad.MaxY + 1,
-		Lines:         lines,
-		GridMode:      opts.GridMode,
+		CharacterBoxSize: opts.CharBoxSize,
+		MarginSize:       opts.MarginSize,
+		TerminalWidth:    terminalWidth,
+		Columns:          ad.MaxX + 1,
+		NrLines:          ad.MaxY + 1,
+		Lines:            lines,
+		GridMode:         opts.GridMode,
 	}
 	return s.Render(w)
 }

cli/cli.go

@@ -4,33 +4,12 @@ import (
 	"flag"
 	"fmt"
 	"io"
-	"strconv"
 	"strings"
 
 	"github.com/wader/ansisvg/ansitosvg"
 	"github.com/wader/ansisvg/colorscheme/schemes"
-	"github.com/wader/ansisvg/svgscreen"
 )
 
-type boxSize struct {
-	Width  int
-	Height int
-}
-
-func (d *boxSize) String() string {
-	return fmt.Sprintf("%dx%d", d.Width, d.Height)
-}
-
-func (d *boxSize) Set(s string) error {
-	parts := strings.Split(s, "x")
-	if len(parts) != 2 {
-		return fmt.Errorf("must be WxH")
-	}
-	d.Width, _ = strconv.Atoi(parts[0])
-	d.Height, _ = strconv.Atoi(parts[1])
-	return nil
-}
-
 type Env struct {
 	Version  string
 	ReadFile func(string) ([]byte, error)
@@ -59,11 +38,10 @@ func Main(env Env) error {
 	var helpFlag bool
 	fs.BoolVar(&helpFlag, "h", false, "")
 	fs.BoolVar(&helpFlag, "help", false, "Show help")
-	var charBoxSize = boxSize{
-		Width:  ansitosvg.DefaultOptions.CharBoxSize.Width,
-		Height: ansitosvg.DefaultOptions.CharBoxSize.Height,
-	}
+	charBoxSize := ansitosvg.DefaultOptions.CharBoxSize
 	fs.Var(&charBoxSize, "charboxsize", "WxH|Character box size (use pixel units instead of font units)")
+	marginSize := ansitosvg.DefaultOptions.MarginSize
+	fs.Var(&marginSize, "marginsize", "WxH|Margin size (in either pixel or font units)")
 	// handle error and usage output ourself
 	fs.Usage = func() {}
 	fs.SetOutput(io.Discard)
@@ -159,13 +137,11 @@ Example usage:
 			FontRef:       *fontRefFlag,
 			FontSize:      *fontSizeFlag,
 			TerminalWidth: terminalWidthFlag,
-			CharBoxSize: svgscreen.BoxSize{
-				Width:  charBoxSize.Width,
-				Height: charBoxSize.Height,
-			},
-			ColorScheme: *colorSchemeFlag,
-			Transparent: *transparentFlag,
-			GridMode:    *gridModeFlag,
+			CharBoxSize:   charBoxSize,
+			MarginSize:    marginSize,
+			ColorScheme:   *colorSchemeFlag,
+			Transparent:   *transparentFlag,
+			GridMode:      *gridModeFlag,
 		},
 	)
 }