cx documentation

.appveyor.yml

@@ -42,8 +42,8 @@ install:
 
 # scripts to run before build
 before_build:
-  - goyacc -o %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo0\cxgo0.go %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo0\cxgo0.y
-  - goyacc -o %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo.go %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo.y
+  - goyacc -o %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo0\parser.go %GOPATH%\src\github.com\skycoin\cx\cxgo\cxgo0\grammer.y
+  - goyacc -o %GOPATH%\src\github.com\skycoin\cx\cxgo\lexer.go %GOPATH%\src\github.com\skycoin\cx\cxgo\lexer.y
 
 # use custom build_script
 build_script:

Makefile

@@ -101,8 +101,12 @@ build-goyacc: ## Builds goyacc into /bin/goyacc
 
 build-parser: ## Generate lexer and parser for CX grammar
 	#go build -o ./bin/goyacc ./cmd/goyacc/main.go
-	./bin/goyacc -o cxgo/cxgo0/cxgo0.go cxgo/cxgo0/cxgo0.y
-	./bin/goyacc -o cxgo/cxgo/cxgo.go cxgo/cxgo/cxgo.y
+
+	##Generate  parser from CX grammar
+	./bin/goyacc -o cxgo/cxgo0/parser.go cxgo/cxgo0/grammer.y
+
+	##Generate  lexer from CX lexer.y
+	./bin/goyacc -o cxgo/cxgo/lexer.go cxgo/cxgo/lexer.y
 
 token-fuzzer:
 	go build $(GO_OPTS) -o ./bin/cx-token-fuzzer $(PWD)/development/token-fuzzer/main.go

cmd/cx/constant.go

@@ -0,0 +1,3 @@
+package main
+
+const VERSION = "0.8.0"

cmd/cx/helpers.go

@@ -0,0 +1,181 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"os/user"
+	"path/filepath"
+	"strconv"
+
+	repl "github.com/skycoin/cx/cmd/cxrepl"
+	cxcore "github.com/skycoin/cx/cx"
+	"github.com/skycoin/cx/cx/ast"
+	"github.com/skycoin/cx/cx/constants"
+	"github.com/skycoin/cx/cx/globals"
+	"github.com/skycoin/cx/cx/util"
+	"github.com/skycoin/cx/cxgo/actions"
+	"github.com/skycoin/cx/cxgo/cxgo"
+	"github.com/skycoin/cx/cxgo/util/profiling"
+)
+
+func printProgramAST(options cxCmdFlags, cxArgs []string, sourceCode []*os.File) {
+	profiling.StartProfile("run")
+	defer profiling.StopProfile("run")
+
+	if options.replMode || len(sourceCode) == 0 {
+		actions.AST.SetCurrentCxProgram()
+		repl.Repl()
+		return
+	}
+
+	// Print CX program.
+	actions.AST.PrintProgram()
+
+	if cxcore.AssertFailed() {
+		os.Exit(constants.CX_ASSERT)
+	}
+}
+
+// Used for the -heap-initial, -heap-max and -stack-size flags.
+// This function parses, for example, "1M" to 1048576 (the corresponding number of bytes)
+// Possible suffixes are: G or g (gigabytes), M or m (megabytes), K or k (kilobytes)
+func parseMemoryString(s string) int {
+	suffix := s[len(s)-1]
+	_, notSuffix := strconv.ParseFloat(string(suffix), 64)
+
+	if notSuffix == nil {
+		// then we don't have a suffix
+		num, err := strconv.ParseInt(s, 10, 64)
+
+		if err != nil {
+			// malformed size
+			return -1
+		}
+
+		return int(num)
+	} else {
+		// then we have a suffix
+		num, err := strconv.ParseFloat(s[:len(s)-1], 64)
+
+		if err != nil {
+			// malformed size
+			return -1
+		}
+
+		// The user can use suffixes to give as input gigabytes, megabytes or kilobytes.
+		switch suffix {
+		case 'G', 'g':
+			return int(num * 1073741824)
+		case 'M', 'm':
+			return int(num * 1048576)
+		case 'K', 'k':
+			return int(num * 1024)
+		default:
+			return -1
+		}
+	}
+}
+
+type SourceCode struct {
+	Code string //Unused?
+}
+
+// GetCXPath checks if the user has set the environment variable
+// `CXPATH`. If not, CX creates a workspace at $HOME/cx, along with $HOME/cx/bin,
+// $HOME/cx/pkg and $HOME/cx/src
+func GetCXPath(options cxCmdFlags) {
+	// Determining the filepath of the directory where the user
+	// started the `cx` command.
+	_, err := os.Executable()
+	if err != nil {
+		panic(err)
+	}
+
+	CXPATH := ""
+	if os.Getenv("CXPATH") != "" {
+		CXPATH = os.Getenv("CXPATH")
+	}
+	// `options.cxpath` overrides `os.Getenv("CXPATH")`
+	if options.cxpath != "" {
+		CXPATH, err = filepath.Abs(options.cxpath)
+		if err != nil {
+			panic(err)
+		}
+	}
+	if os.Getenv("CXPATH") == "" && options.cxpath == "" {
+		usr, err := user.Current()
+		if err != nil {
+			panic(err)
+		}
+
+		CXPATH = usr.HomeDir + "/cx/"
+	}
+	globals.BINPATH = filepath.Join(CXPATH, "bin/")
+	globals.PKGPATH = filepath.Join(CXPATH, "pkg/")
+	globals.SRCPATH = filepath.Join(CXPATH, "src/")
+	//why would we create directories on executing every CX program?
+	//directory creation should be on installation
+	//CreateCxDirectories(CXPATH)
+}
+
+/*
+func CreateCxDirectories(CXPATH string) {
+		// Creating directories in case they do not exist.
+		if _, err := cxcore.CXStatFile(CXPATH); os.IsNotExist(err) {
+			cxcore.CXMkdirAll(CXPATH, 0755)
+		}
+		if _, err := cxcore.CXStatFile(cxcore.BINPATH); os.IsNotExist(err) {
+			cxcore.CXMkdirAll(cxcore.BINPATH, 0755)
+		}
+		if _, err := cxcore.CXStatFile(cxcore.PKGPATH); os.IsNotExist(err) {
+			cxcore.CXMkdirAll(cxcore.PKGPATH, 0755)
+		}
+		if _, err := cxcore.CXStatFile(cxcore.SRCPATH); os.IsNotExist(err) {
+			cxcore.CXMkdirAll(cxcore.SRCPATH, 0755)
+		}
+	}
+*/
+
+// initMainPkg adds a `main` package with an empty `main` function to `prgrm`.
+func initMainPkg(prgrm *ast.CXProgram) {
+	mod := ast.MakePackage(constants.MAIN_PKG)
+	prgrm.AddPackage(mod)
+	fn := ast.MakeFunction(constants.MAIN_FUNC, actions.CurrentFile, actions.LineNo)
+	mod.AddFunction(fn)
+}
+
+// optionTokenize checks if the user wants to use CX to generate the lexer tokens
+func printTokenize(options cxCmdFlags, fileNames []string) {
+	var r *os.File
+	var w *os.File
+	var err error
+
+	if len(fileNames) == 0 {
+		r = os.Stdin
+	} else {
+		sourceFilename := fileNames[0]
+		if len(fileNames) > 1 {
+			fmt.Fprintln(os.Stderr, "Multiple source files detected. Ignoring all except", sourceFilename)
+		}
+		r, err = util.CXOpenFile(sourceFilename)
+		if err != nil {
+			fmt.Fprintln(os.Stderr, "ProgramError reading:", sourceFilename, err)
+			return
+		}
+		defer r.Close()
+	}
+
+	if options.compileOutput == "" {
+		w = os.Stdout
+	} else {
+		tokenFilename := options.compileOutput
+		w, err = util.CXCreateFile(tokenFilename)
+		if err != nil {
+			fmt.Fprintln(os.Stderr, "ProgramError writing:", tokenFilename, err)
+			return
+		}
+		defer w.Close()
+	}
+
+	cxgo.Tokenize(r, w)
+}