Merge: Update build/install process

Author: vain0x

.gitattributes

@@ -3,6 +3,9 @@
 *.milone    linguist-language=fsharp
 *.c         linguist-detectable=false
 
+*.ps1       text eol=crlf
+*.sh        text eol=lf
+
 # <https://github.com/github/linguist#generated-code>
 boot/MiloneLang/Records.fs      linguist-generated
 boot/scripts/**/*.c             linguist-generated

Makefile

@@ -7,24 +7,14 @@
 
 default: test
 
-.PHONY: build clean default install install-dev test uninstall
-
-# ------------------------------------------------
-# entrypoints
-# ------------------------------------------------
+.PHONY: build clean default install install-dev pack test uninstall
 
 clean:
 	scripts/clean
 
-install:
-	scripts/install
-
 install-dev:
 	scripts/install-dev
 
-uninstall:
-	scripts/uninstall
-
 # ------------------------------------------------
 # misc
 # ------------------------------------------------
@@ -52,6 +42,15 @@ ${MY_BUILD_TIMESTAMP}: target/.timestamp/dotnet_restore \
 
 my_build: ${MY_BUILD_TIMESTAMP}
 
+install: ${MY_BUILD_TIMESTAMP}
+	${MY_BUILD} self-install
+
+uninstall: ${MY_BUILD_TIMESTAMP}
+	${MY_BUILD} self-uninstall
+
+pack: ${MY_BUILD_TIMESTAMP}
+	${MY_BUILD} pack
+
 target/milone: bin/ninja ${MY_BUILD_TIMESTAMP} \
 		runtime/milone.h \
 		runtime/milone.c \

README.md

@@ -5,9 +5,8 @@
 - [#About](#about)
 - [#Install](#install)
     - ~~With package manager~~ (yet)
-    - From binary -> [install_from_binary.md](install_from_binary.md)
     - [#From sources on Linux](#install-from-sources-on-linux)
-    - [#From sources on Windows](#install-from-sources-on-windows)
+    - [#From binary package on Windows](#install-from-binary-package-on-windows)
 - [#How it works](#how-it-works)
 - Documentation
     - Language -> [docs/refs](docs/refs)
@@ -39,6 +38,7 @@ Prerequisites:
 
 - Ubuntu 18.04 (or similar platform)
 - Install [.NET SDK 5](https://dotnet.microsoft.com/download/dotnet/5.0)
+- Install GNU make
 - Install GCC 7.5.0
 - Install `busybox`, which is likely pre-installed, by:
     `apt install -y busybox-static`
@@ -51,42 +51,27 @@ git clone 'https://github.com/vain0x/milone-lang' --filter=blob:none
 
 # Build and install.
 cd milone-lang
-scripts/install
+make install
 ```
 
-- To uninstall, do `scripts/uninstall`.
+- To uninstall, do `make uninstall`.
 
-### Install from sources on Windows
+### Install from binary package on Windows
 
 Prerequisites:
 
 - Windows 10
-- Install [Git for Windows](https://gitforwindows.org/)
-- Install [.NET SDK 5](https://dotnet.microsoft.com/download/dotnet/5.0)
-- Install [Visual Studio 2019](https://visualstudio.microsoft.com/ja/downloads/) with "Desktop development with C++" option
-
-Do with Git Bash:
-
-```sh
-# Download the source code.
-git clone 'https://github.com/vain0x/milone-lang' --filter=blob:none
-cd milone-lang
-
-# ---- BUILD ----
+- Install `MSBuild.exe` in some way:
+    - install Visual Studio 2019 with "Desktop development with C++" option, *OR*
+    - install [Visual Studio 2019 Build Tools](https://visualstudio.microsoft.com/ja/downloads/?q=build+tools#build-tools-for-visual-studio-2019).
 
-scripts/build-milone-windows
+Instructions:
 
-# ---- INSTALL ----
+- Download a binary package from [GitHub Releases](https://github.com/vain0x/milone-lang/releases)
+- Unarchive it somewhere
+- Follow instructions written in [INSTALL.md](scripts/MyBuildTool/assets/INSTALL.md)
 
-# Copy the generated executable to some directory as you want.
-mkdir -p $USERPROFILE/bin
-cp 'target/MiloneCli/target/x64-Release-bin/MiloneCli.exe' $USERPROFILE/bin/milone.exe
-
-# Create '.milone' directory in user directory.
-# Copy libraries to it.
-mkdir -p $USERPROFILE/.milone
-cp milone_libs $USERPROFILE/.milone
-```
+See also [docs/binary_package.md](docs/binary_package.md).
 
 ## Install VSCode Extension
 

docs/binary_package.md

@@ -0,0 +1,39 @@
+# Binary package
+
+Binary packages are distributed in [GitHub Releases](https://github.com/vain0x/milone-lang/releases).
+Package file extension is either `.tar.gz` or `.zip`.
+
+## Usage
+
+- Download and unarchive a package file
+- Follow instruction written in `INSTALL.md`
+
+----
+
+## Package structure
+
+Package should consist of these files.
+
+- `milone-X.Y.Z/` (root of package)
+    - `.milone/`
+    - `bin/`
+    - `INSTALL.md` (this)
+    - `install.sh`
+    - `install.ps1`
+    - `LICENSE`
+    - `README.md`
+
+## Generated files by installation
+
+Installation script should place these files (and these files only):
+
+- `$HOME/bin/`
+    - `milone.exe` (or `milone`)
+- `$HOME/.milone/`
+    - `bin/`
+        - `milone_dotnet/`
+        - `milone_lsp/`
+    - `milone_libs/`
+    - `version`
+
+where `$HOME` is your home directory.

docs/cli.md

@@ -45,6 +45,8 @@ Options:
 - `-- ARGS...`
     - Arguments for generated executable.
     - Note that `--` is required to pass some args.
+- `--release`
+    - Compile in release mode.
 - `--target-dir <DIR>` (defaults to `target/<PROJECT-NAME>`)
     - Specify target directory.
     - That directory contains intermediate files and output files.
@@ -74,11 +76,13 @@ milone build ./MiloneProject
 ```
 
 ```sh
-milone build ./MiloneProject --target-dir ../build
+milone build ./MiloneProject --release --target-dir ../build
 ```
 
 Options:
 
+- `--release`
+    - Compile in release mode.
 - `--target-dir <DIR>` (defaults to `target/<PROJECT-NAME>`)
     - Specify target directory.
     - That directory contains intermediate files and output files.
@@ -93,7 +97,7 @@ Output:
     - `<TARGET-DIR>/<PROJECT-NAME>.exe`: Executable (if success)
     - where `TARGET-DIR` is specified by `--target-dir` option
     - On linux:
-        - `<TARGET-DIR>/build.ninja` 
+        - `<TARGET-DIR>/build.ninja`
     - On windows:
         - `<TARGET-DIR>/<PROJECT-NAME>.sln`
         - `<TARGET-DIR>/<PROJECT-NAME>/<PROJECT-NAME>.vcxproj`
@@ -248,6 +252,15 @@ Notes:
 
 ----
 
+## Less Important Features
+
+- `-p <PROJECT-DIR>`, `--project-dir <PROJECT-DIR>`
+    - Subcommands that take `<PROJECT-DIR>` as positional argument also support `-p`/`--project-dir` option instead.
+    - That's to match behavior with `dotnet run`.
+- `--release` and `--target-dir`
+    - `check` and `compile` subcommands accept these flags but ignore. (So that you can replace `build` subcommand with `check` without changing other args.)
+- `--debug` (inversion of `--release`) is accepted but ignored.
+
 ## Misc notes
 
 - I'm NOT familiar with external tools; please teach me.

install_from_binary.md

@@ -10,6 +10,8 @@ Notes for milone-lang developers.
 
 Scripts are written for `bash` because I use a Ubuntu desktop for development.
 
+TODO: prepare scripts/unused/.devcontainer
+
 ### Dev: Prerequisites
 
 See the "install from sources" section in README.
@@ -19,20 +21,18 @@ For incremental building and testing, `ninja` command is also used.
 `git` command is used in tests to generate diff.
 
 - Install Git 2.30.0
+- Install GNU make
 - Install [ninja 1.10.2](https://github.com/ninja-build/ninja) (build tool)
     with `scripts/install-ninja`
 
 ### Dev: Build
 
 ```sh
-# If you have make:
 make
-
-# Otherwise:
-scripts/build-ninja-gen
-bin/ninja
 ```
 
+See also Makefile.
+
 ### Dev: Testing
 
 ```
@@ -77,13 +77,12 @@ In tests, there are some categories of test cases:
 - Merge to master branch
 
 ```sh
-# Make a git tag.
-make target/milone
-git tag v$(target/milone --version)
+# Make Git tag.
+git tag v0.0.0
 git push --tags
 
 # Create package.
-scripts/pack
+make pack
 ```
 
 - Make a release in GitHub

internals.md

@@ -668,7 +668,7 @@ void file_write_all_text(struct String file_name, struct String content) {
 }
 
 // -----------------------------------------------
-// environemnt
+// environment
 // -----------------------------------------------
 
 struct String milone_get_env(struct String name) {

runtime/milone.c

@@ -155,6 +155,34 @@ struct String milone_get_platform(void) {
 #endif
 }
 
+// -----------------------------------------------
+// environment
+// -----------------------------------------------
+
+struct String milone_get_cwd(void) {
+#if defined(MILONE_PLATFORM_UNIX)
+    char buf[FILENAME_MAX + 1];
+    bool ok = getcwd(buf, sizeof buf) != NULL;
+    if (!ok) {
+        perror("getcwd");
+        exit(1);
+    }
+
+    return str_of_c_str(buf);
+#elif defined(MILONE_PLATFORM_WINDOWS)
+    TCHAR buf[MAX_PATH + 1] = {0};
+    DWORD len = GetCurrentDirectory(sizeof(buf), buf);
+    if (len == 0 || len >= sizeof(buf)) {
+        failwith("GetCurrentDirectory");
+        exit(1);
+    }
+
+    return os_string_to((struct OsString){.str = buf, .len = len});
+#else
+#error no platform
+#endif
+}
+
 // -----------------------------------------------
 // file IO
 // -----------------------------------------------