Move configuration to $HOME/.config/gospeccy, reduce the number of snapshot paths, add 'setDownloadPath(string)' script function

Author: atomsymbol-notifications

ChangeLog

@@ -7,7 +7,7 @@
 	  option, wos* script functions). Info about a WorldOfSpectrum file
 	  includes publication type, machine type, and rating.
 
-	* New script functions: vars(), wosFind(string), wosDowload(WOS),
+	* New script functions: vars(), wosFind(string), wosDownload(WOS),
 	  wosLoad(WOS)
 
 	* Evaluating an expression in the console prints the result of the

README.md

@@ -135,21 +135,23 @@ Configuration approach. To enjoy it, you should create the following
 folder structure:
 
 <pre>
-mkdir -p $HOME/.gospeccy/sna		# Snapshots folder
-mkdir -p $HOME/.gospeccy/roms		# System roms folder
-mkdir -p $HOME/.gospeccy/scripts	# Scripts folder
+mkdir -p $HOME/.config/gospeccy/roms	# System roms folder
+mkdir -p $HOME/.config/gospeccy/scripts	# Scripts folder
 </pre>
 
-Then put your snapshots, system rom or scripts in the
-corresponding folder. After this, to load
-`$HOME/.gospeccy/sna/somegame.z80` simply execute:
+In the scripts folder, create file `config_local.go` with the following
+contents:
 
 <pre>
-gospeccy somegame.z80
+// Search path for snapshots, scripts, etc
+addSearchPath("/home/user/gospeccy")
 </pre>
 
-The same applies to `load()` and `script()` functions in the
-interactive console.
+After this, to load `/home/user/gospeccy/somegame.z80` simply execute:
+
+<pre>
+gospeccy somegame.z80
+</pre>
 
 # Screenshots
 

src/interpreter/functions.go

@@ -131,6 +131,12 @@ func wrapper_addSearchPath(t *eval.Thread, in []eval.Value, out []eval.Value) {
 	spectrum.AddCustomSearchPath(path)
 }
 
+// Signature: func setDownloadPath(path string)
+func wrapper_setDownloadPath(t *eval.Thread, in []eval.Value, out []eval.Value) {
+	path := in[0].(eval.StringValue).Get(t)
+	spectrum.SetDownloadPath(path)
+}
+
 func load(path string) {
 	var program interface{}
 	program, err := formats.ReadProgram(path)
@@ -457,7 +463,14 @@ func defineFunctions(w *eval.World) {
 		funcType, funcValue := eval.FuncFromNativeTyped(wrapper_addSearchPath, functionSignature)
 		defineFunction("addSearchPath", funcType, funcValue)
 		help_keys = append(help_keys, "addSearchPath(path string)")
-		help_vals = append(help_vals, "Append to the paths searched when loading snapshots")
+		help_vals = append(help_vals, "Append to the paths searched when loading snapshots, scripts, etc")
+	}
+	{
+		var functionSignature func(string)
+		funcType, funcValue := eval.FuncFromNativeTyped(wrapper_setDownloadPath, functionSignature)
+		defineFunction("setDownloadPath", funcType, funcValue)
+		help_keys = append(help_keys, "setDownloadPath(path string)")
+		help_vals = append(help_vals, `Set path where to download files (""=default path)`)
 	}
 	{
 		var functionSignature func() string

src/spectrum/helpers.go

@@ -44,32 +44,48 @@ import (
 	"sync"
 )
 
-var DefaultUserDir = path.Join(os.Getenv("HOME"), ".gospeccy")
-var distDir string
+var DefaultUserDir = path.Join(os.Getenv("HOME"), ".config", "gospeccy")
+var srcDir string
 
 func init() {
 	gopaths := os.Getenv("GOPATH")
 	gopath0 := strings.Split(gopaths, string(os.PathListSeparator))[0]
-	distDir = path.Join(gopath0, "src", "github.com", "remogatto", "gospeccy")
+	srcDir = path.Join(gopath0, "src", "github.com", "remogatto", "gospeccy")
 }
 
 var customSearchPaths []string
-var customSearchPaths_mutex sync.RWMutex
+var downloadPath string
+var mutex sync.RWMutex
 
 func AddCustomSearchPath(path string) {
-	customSearchPaths_mutex.Lock()
-	{
-		customSearchPaths = append(customSearchPaths, path)
+	mutex.Lock()
+	customSearchPaths = append(customSearchPaths, path)
+	mutex.Unlock()
+}
+
+func DownloadPath() string {
+	mutex.RLock()
+	p := downloadPath
+	mutex.RUnlock()
+
+	if p == "" {
+		p = path.Join(DefaultUserDir, "snapshots")
 	}
-	customSearchPaths_mutex.Unlock()
+	return p
+}
+
+func SetDownloadPath(path string) {
+	mutex.Lock()
+	downloadPath = path
+	mutex.Unlock()
 }
 
 func searchForValidPath(paths []string, fileName string) (string, error) {
 	for _, dir := range paths {
 		if _, err := os.Lstat(dir); err == nil {
 			_, err = filepath.EvalSymlinks(dir)
 			if err != nil {
-				return "", errors.New("path \"" + dir + "\" contains one or more invalid symbolic links")
+				return "", errors.New("path \"" + dir + "\" contains an invalid symbolic link")
 			}
 		}
 
@@ -83,115 +99,49 @@ func searchForValidPath(paths []string, fileName string) (string, error) {
 }
 
 func appendCustomSearchPaths(paths *[]string) {
-	customSearchPaths_mutex.RLock()
-	{
-		*paths = append(*paths, customSearchPaths...)
-	}
-	customSearchPaths_mutex.RUnlock()
-}
-
-// Return a valid path for the specified snapshot,
-// or the original filename if the search did not find anything.
-//
-// An error is returned if the search could not proceed.
-//
-// The search is performed in this order:
-// 1. ./
-// 2. $HOME/.gospeccy/sna/
-func SnaPath(fileName string) (string, error) {
-	var (
-		currDir = ""
-		userDir = path.Join(DefaultUserDir, "sna")
-	)
-
-	var paths []string
-	paths = append(paths, currDir, userDir)
-	appendCustomSearchPaths(&paths)
-
-	return searchForValidPath(paths, fileName)
+	mutex.RLock()
+	*paths = append(*paths, customSearchPaths...)
+	mutex.RUnlock()
 }
 
-// Return a valid path for the specified tape file,
-// or the original filename if the search did not find anything.
-//
-// An error is returned if the search could not proceed.
-//
-// The search is performed in this order:
-// 1. ./
-// 2. $HOME/.gospeccy/tape/
-func TapePath(fileName string) (string, error) {
-	var (
-		currDir = ""
-		userDir = path.Join(DefaultUserDir, "tape")
-	)
-
-	var paths []string
-	paths = append(paths, currDir, userDir)
-	appendCustomSearchPaths(&paths)
-
-	return searchForValidPath(paths, fileName)
-}
-
-// Return a valid path for the specified zip file,
+// Return a valid path for the file based on its extension,
 // or the original filename if the search did not find anything.
 //
 // An error is returned if the search could not proceed.
 //
 // The search is performed in this order:
 // 1. ./
-// 2. $HOME/.gospeccy/zip/
-func ZipPath(fileName string) (string, error) {
-	var (
-		currDir = ""
-		userDir = path.Join(DefaultUserDir, "zip")
-	)
-
+// 2. $GOPATH/src/github.com/remogatto/gospeccy/snapshots/
+// 3. Custom search paths
+// 4. Download path
+func ProgramPath(fileName string) (string, error) {
 	var paths []string
-	paths = append(paths, currDir, userDir)
+	paths = append(paths, "")
+	paths = append(paths, path.Join(srcDir, "snapshots"))
 	appendCustomSearchPaths(&paths)
-
+	paths = append(paths, DownloadPath())
 	return searchForValidPath(paths, fileName)
 }
 
-// Return a valid path for the file based on its extension,
-// or the original filename if the search did not find anything.
-//
-// An error is returned if the search could not proceed.
-func ProgramPath(fileName string) (string, error) {
-	ext := strings.ToLower(path.Ext(fileName))
-
-	switch ext {
-	case ".sna", ".z80":
-		return SnaPath(fileName)
-
-	case ".tap":
-		return TapePath(fileName)
-
-	case ".zip":
-		return ZipPath(fileName)
-	}
-
-	return fileName, nil
-}
-
 // Returns a valid path for the 48k system ROM,
 // or the original filename if the search did not find anything.
 //
 // An error is returned if the search could not proceed.
 //
 // The search is performed in this order:
 // 1. ./roms/
-// 2. $HOME/.gospeccy/roms/
+// 2. $HOME/.config/gospeccy/roms/
 // 3. $GOPATH/src/github.com/remogatto/gospeccy/roms/
+// 4. Custom search paths
 func SystemRomPath(fileName string) (string, error) {
 	var (
 		currDir = "roms"
 		userDir = path.Join(DefaultUserDir, "roms")
-		distDir = path.Join(distDir, "roms")
+		srcDir = path.Join(srcDir, "roms")
 	)
 
 	var paths []string
-	paths = append(paths, currDir, userDir, distDir)
+	paths = append(paths, currDir, userDir, srcDir)
 	appendCustomSearchPaths(&paths)
 
 	return searchForValidPath(paths, fileName)
@@ -204,17 +154,18 @@ func SystemRomPath(fileName string) (string, error) {
 //
 // The search is performed in this order:
 // 1. ./scripts/
-// 2. $HOME/.gospeccy/scripts/
+// 2. $HOME/.config/gospeccy/scripts/
 // 3. $GOPATH/src/github.com/remogatto/gospeccy/scripts/
+// 4. Custom search paths
 func ScriptPath(fileName string) (string, error) {
 	var (
 		currDir = "scripts"
 		userDir = path.Join(DefaultUserDir, "scripts")
-		distDir = path.Join(distDir, "scripts")
+		srcDir = path.Join(srcDir, "scripts")
 	)
 
 	var paths []string
-	paths = append(paths, currDir, userDir, distDir)
+	paths = append(paths, currDir, userDir, srcDir)
 	appendCustomSearchPaths(&paths)
 
 	return searchForValidPath(paths, fileName)
@@ -227,17 +178,18 @@ func ScriptPath(fileName string) (string, error) {
 //
 // The search is performed in this order:
 // 1. ./fonts/
-// 2. $HOME/.gospeccy/fonts/
+// 2. $HOME/.config/gospeccy/fonts/
 // 3. $GOPATH/src/github.com/remogatto/gospeccy/fonts/
+// 4. Custom search paths
 func FontPath(fileName string) (string, error) {
 	var (
 		currDir = "fonts"
 		userDir = path.Join(DefaultUserDir, "fonts")
-		distDir = path.Join(distDir, "fonts")
+		srcDir = path.Join(srcDir, "fonts")
 	)
 
 	var paths []string
-	paths = append(paths, currDir, userDir, distDir)
+	paths = append(paths, currDir, userDir, srcDir)
 	appendCustomSearchPaths(&paths)
 
 	return searchForValidPath(paths, fileName)

src/spectrum/wos.go

@@ -181,7 +181,7 @@ func WosQuery(app *Application, query string) ([]WosRecord, error) {
 // An URL can be obtained by calling function WosQuery.
 func WosGet(app *Application, stdout io.Writer, url string) (string, error) {
 	filename := path.Base(url)
-	dir := path.Join(DefaultUserDir, "zip")
+	dir := DownloadPath()
 	filePath := path.Join(dir, filename)
 	ftpURL := url[6:len(url)]