feat(code): add ncdu v2.3 source code

https://dev.yorhel.nl/ncdu/changes2

Author: konosubakonoakua

ChangeLog

@@ -0,0 +1,77 @@
+# SPDX-FileCopyrightText: 2021-2023 Yoran Heling <[email protected]>
+# SPDX-License-Identifier: MIT
+
+2.3 - 2023-08-04
+	- Now requires Zig 0.11
+	- Add --(enable|disable)-natsort options
+	- Add indicator to apparent size/disk usage selection in the footer
+	- Fix build on armv7l (hopefully)
+	- Minor build system additions
+
+2.2.2 - 2023-01-19
+	- Now requires Zig 0.10 or 0.10.1
+	- That's it, pretty much.
+
+2.2.1 - 2022-10-25
+	- Still requires Zig 0.9.0 or 0.9.1
+	- Fix bug with 'dark' and 'off' color themes on FreeBSD and MacOS
+
+2.2 - 2022-10-17
+	- Still requires Zig 0.9.0 or 0.9.1
+	- (breaking) Wildcards in exclude patterns don't cross directory boundary anymore
+	- Improve exclude pattern matching performance
+	- Set full background in default dark-bg color scheme
+	- Fix broken JSON export when a filename contains control characters below 0x10
+
+2.1.2 - 2022-04-28
+	- Still requires Zig 0.9.0 or 0.9.1
+	- Fix possible crash on shortening file names with unicode variation
+	  selectors or combining marks
+
+2.1.1 - 2022-03-25
+	- Still requires Zig 0.9.0 or 0.9.1
+	- Fix potential crash when refreshing
+	- Fix typo in --graph-style=eighth-block
+	- Revert default --graph-style to hash characters
+
+2.1 - 2022-02-07
+	- Still requires Zig 0.9.0
+	- Use natural sort order when sorting by file name
+	- Use Unicode box drawing characters for the file size bar
+	- Add --graph-style option to change drawing style for the file size bar
+	- Fix early exit if a configuration directory does not exist
+	- Fix display glitch for long file names
+	- Fix display glitch with drawing unique/shared size column
+
+2.0.1 - 2022-01-01
+	- Still requires Zig 0.9.0
+	- Fix build failure to find 'wcwidth' on some systems
+	- Add ZIG_FLAGS option to Makefile
+
+2.0 - 2021-12-21
+	- Requires Zig 0.9.0
+	- That's the only change.
+
+2.0-beta3 - 2021-11-09
+	- Requires Zig 0.8 or 0.8.1
+	- Add lots of new CLI flags to configure ncdu
+	- Add configuration file support
+	- Add 'dark-bg' color scheme and use that by default
+	- Fix not enabling -x by default
+	- Fix export feature
+	- Fix import of "special" dirs and files
+	- Fix double-slash display in file browser
+
+2.0-beta2 - 2021-07-31
+	- Requires Zig 0.8
+	- Significantly reduce memory usage for hard links
+	- Slightly increase memory usage for directory entries
+	- Fix reporting of fatal errors in the -0 and -1 scanning UIs
+
+2.0-beta1 - 2021-07-22
+	- Full release announcement: https://dev.yorhel.nl/doc/ncdu2
+	- Requires Zig 0.8
+	- Features and UI based on ncdu 1.16
+	- Lower memory use in most scenarios (except with many hard links)
+	- Improved performance of hard link counting
+	- Extra column for shared/unique directory sizes

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Makefile

@@ -0,0 +1,103 @@
+# SPDX-FileCopyrightText: 2021-2023 Yoran Heling <[email protected]>
+# SPDX-License-Identifier: MIT
+
+# Optional semi-standard Makefile with some handy tools.
+# Ncdu itself can be built with just the zig build system.
+
+ZIG ?= zig
+
+PREFIX ?= /usr/local
+BINDIR ?= ${PREFIX}/bin
+MANDIR ?= ${PREFIX}/share/man/man1
+ZIG_FLAGS ?= -Doptimize=ReleaseFast
+
+NCDU_VERSION=$(shell grep 'program_version = "' src/main.zig | sed -e 's/^.*"\(.\+\)".*$$/\1/')
+
+.PHONY: build
+build: release doc
+
+release:
+	$(ZIG) build ${ZIG_FLAGS}
+
+debug:
+	$(ZIG) build
+
+clean:
+	rm -rf zig-cache zig-out
+
+distclean: clean
+	rm -f ncdu.1
+
+doc: ncdu.1
+
+ncdu.1: ncdu.pod src/main.zig
+	pod2man --center "ncdu manual" --release "ncdu-${NCDU_VERSION}" ncdu.pod >ncdu.1
+
+install: install-bin install-doc
+
+install-bin: release
+	mkdir -p ${BINDIR}
+	install -m0755 zig-out/bin/ncdu ${BINDIR}/
+
+install-doc: doc
+	mkdir -p ${MANDIR}
+	install -m0644 ncdu.1 ${MANDIR}/
+
+uninstall: uninstall-bin uninstall-doc
+
+# XXX: Ideally, these would also remove the directories created by 'install' if they are empty.
+uninstall-bin:
+	rm -f ${BINDIR}/ncdu
+
+uninstall-doc:
+	rm -f ${MANDIR}/ncdu.1
+
+dist: doc
+	rm -f ncdu-${NCDU_VERSION}.tar.gz
+	mkdir ncdu-${NCDU_VERSION}
+	for f in ncdu.1 `git ls-files | grep -v ^\.gitignore`; do mkdir -p ncdu-${NCDU_VERSION}/`dirname $$f`; ln -s "`pwd`/$$f" ncdu-${NCDU_VERSION}/$$f; done
+	tar -cophzf ncdu-${NCDU_VERSION}.tar.gz --sort=name ncdu-${NCDU_VERSION}
+	rm -rf ncdu-${NCDU_VERSION}
+
+
+# ASSUMPTION: the ncurses source tree has been extracted into ncurses/
+static-%.tar.gz:
+	mkdir -p static-$*/nc static-$*/inst/pkg
+	cd static-$*/nc && ../../ncurses/configure --prefix="`pwd`/../inst"\
+		--with-pkg-config-libdir="`pwd`/../inst/pkg"\
+		--without-cxx --without-cxx-binding --without-ada --without-manpages --without-progs\
+		--without-tests --enable-pc-files --without-pkg-config --without-shared --without-debug\
+		--without-gpm --without-sysmouse --enable-widec --with-default-terminfo-dir=/usr/share/terminfo\
+		--with-terminfo-dirs=/usr/share/terminfo:/lib/terminfo:/usr/local/share/terminfo\
+		--with-fallbacks="screen linux vt100 xterm xterm-256color" --host=$*\
+		CC="${ZIG} cc --target=$*"\
+		LD="${ZIG} cc --target=$*"\
+		AR="${ZIG} ar" RANLIB="${ZIG} ranlib"\
+		CPPFLAGS=-D_GNU_SOURCE && make && make install.libs
+	@# zig-build - cleaner approach but doesn't work, results in a dynamically linked binary.
+	@#cd static-$* && PKG_CONFIG_LIBDIR="`pwd`/inst/pkg" zig build -Dtarget=$*
+	@#	--build-file ../build.zig --search-prefix inst/ --cache-dir zig -Drelease-fast=true
+	@# Alternative approach, bypassing zig-build
+	cd static-$* && ${ZIG} build-exe -target $*\
+		-Iinst/include -Iinst/include/ncursesw -lc inst/lib/libncursesw.a\
+		--cache-dir zig-cache -static -fstrip -O ReleaseFast ../src/main.zig ../src/ncurses_refs.c
+	cd static-$* && mv main ncdu && tar -czf ../static-$*.tar.gz ncdu
+	rm -rf static-$*
+
+static-linux-x86_64: static-x86_64-linux-musl.tar.gz
+	mv $< ncdu-${NCDU_VERSION}-linux-x86_64.tar.gz
+
+static-linux-x86: static-x86-linux-musl.tar.gz
+	mv $< ncdu-${NCDU_VERSION}-linux-x86.tar.gz
+
+static-linux-aarch64: static-aarch64-linux-musl.tar.gz
+	mv $< ncdu-${NCDU_VERSION}-linux-aarch64.tar.gz
+
+static-linux-arm: static-arm-linux-musleabi.tar.gz
+	mv $< ncdu-${NCDU_VERSION}-linux-arm.tar.gz
+
+static:\
+	static-linux-x86_64 \
+	static-linux-x86 \
+	static-linux-aarch64 \
+	static-linux-arm

README.md

@@ -1 +1,35 @@
-# ncdu-zig
+<!--
+SPDX-FileCopyrightText: 2021-2023 Yoran Heling <[email protected]>
+SPDX-License-Identifier: MIT
+-->
+
+# ncdu-zig
+
+## Description
+
+Ncdu is a disk usage analyzer with an ncurses interface. It is designed to find
+space hogs on a remote server where you don't have an entire graphical setup
+available, but it is a useful tool even on regular desktop systems. Ncdu aims
+to be fast, simple and easy to use, and should be able to run in any minimal
+POSIX-like environment with ncurses installed.
+
+See the [ncdu 2 release announcement](https://dev.yorhel.nl/doc/ncdu2) for
+information about the differences between this Zig implementation (2.x) and the
+C version (1.x).
+
+## Requirements
+
+- Zig 0.11.0
+- Some sort of POSIX-like OS
+- ncurses libraries and header files
+
+## Install
+
+You can use the Zig build system if you're familiar with that.
+
+There's also a handy Makefile that supports the typical targets, e.g.:
+
+```
+make
+sudo make install PREFIX=/usr
+```

build.zig

@@ -0,0 +1,55 @@
+// SPDX-FileCopyrightText: 2021-2023 Yoran Heling <[email protected]>
+// SPDX-License-Identifier: MIT
+
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    const pie = b.option(bool, "pie", "Build with PIE support (by default false)") orelse false;
+
+    const exe = b.addExecutable(.{
+        .name = "ncdu",
+        .root_source_file = .{ .path = "src/main.zig" },
+        .target = target,
+        .optimize = optimize,
+    });
+
+    // https://github.com/ziglang/zig/blob/b52be973dfb7d1408218b8e75800a2da3dc69108/build.zig#L551-L554
+    if (exe.target.isDarwin()) {
+        // useful for package maintainers
+        exe.headerpad_max_install_names = true;
+    }
+    linkNcurses(exe);
+    exe.pie = pie;
+    b.installArtifact(exe);
+
+    const run_cmd = b.addRunArtifact(exe);
+    run_cmd.step.dependOn(b.getInstallStep());
+    if (b.args) |args| {
+        run_cmd.addArgs(args);
+    }
+
+    const run_step = b.step("run", "Run the app");
+    run_step.dependOn(&run_cmd.step);
+
+    const unit_tests = b.addTest(.{
+        .root_source_file = .{ .path = "src/main.zig" },
+        .target = target,
+        .optimize = optimize,
+    });
+    linkNcurses(unit_tests);
+    unit_tests.pie = pie;
+
+    const run_unit_tests = b.addRunArtifact(unit_tests);
+
+    const test_step = b.step("test", "Run unit tests");
+    test_step.dependOn(&run_unit_tests.step);
+}
+
+pub fn linkNcurses(compile_step: *std.Build.CompileStep) void {
+    compile_step.linkSystemLibrary("ncursesw");
+    compile_step.linkLibC();
+    compile_step.addCSourceFile(.{ .file = .{ .path = "src/ncurses_refs.c" }, .flags = &.{} });
+}