path: root/src/main.c

/*
 * Copyright (C) 2012-2025 Robin Haberkorn
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#endif

#include <stdio.h>
#include <string.h>
#include <stdlib.h>
#include <signal.h>
#include <locale.h>
#include <wchar.h>

#include <glib.h>
#include <glib/gprintf.h>
#include <glib/gstdio.h>

#ifdef HAVE_SYS_CAPSICUM_H
#include <sys/capsicum.h>
#endif

#include "sciteco.h"
#include "file-utils.h"
#include "cmdline.h"
#include "interface.h"
#include "parser.h"
#include "goto.h"
#include "qreg.h"
#include "ring.h"
#include "undo.h"
#include "error.h"

/*
 * Define this to pause the program at the beginning
 * of main() (Windows only).
 * This is a useful hack on Windows, where gdbserver
 * sometimes refuses to start SciTECO but attaches
 * to a running process just fine.
 */
//#define DEBUG_PAUSE

#define INI_FILE ".teco_ini"

teco_int_t teco_ed = TECO_ED_AUTOEOL;

/**
 * Whether there was an asyncronous interruption (usually after pressing CTRL+C).
 * However you should always use teco_interface_is_interrupted(),
 * to check for interruptions because of its side effects.
 * This variable is safe to set to TRUE from signal handlers and threads.
 */
volatile sig_atomic_t teco_interrupted = FALSE;

/*
 * FIXME: Move this into file-utils.c?
 */
#ifdef G_OS_WIN32

/*
 * Keep program self-contained under Windows
 * Look for config files (profile and session),
 * as well as standard library macros in the
 * program's directory.
 */
static inline gchar *
teco_get_default_config_path(void)
{
	return teco_file_get_program_path();
}

#elif defined(G_OS_UNIX) && !defined(__HAIKU__)

static inline gchar *
teco_get_default_config_path(void)
{
	return g_strdup(g_get_home_dir());
}

#else /* !G_OS_WIN32 && (!G_OS_UNIX || __HAIKU__) */

/*
 * NOTE: We explicitly do not handle
 * Haiku like UNIX, since it appears to
 * be uncommon on Haiku to clutter the $HOME directory
 * with config files.
 */
static inline gchar *
teco_get_default_config_path(void)
{
	return g_strdup(g_get_user_config_dir());
}

#endif

static gchar *teco_eval_macro = NULL;
static gboolean teco_mung_file = FALSE;
static gboolean teco_mung_profile = TRUE;
static gchar *teco_fake_cmdline = NULL;
static gboolean teco_sandbox = FALSE;
static gboolean teco_8bit_clean = FALSE;

static gchar *
teco_process_options(gchar ***argv)
{
	static const GOptionEntry option_entries[] = {
		{"eval", 'e', 0, G_OPTION_ARG_STRING, &teco_eval_macro,
		 "Evaluate macro", "macro"},
		{"mung", 'm', 0, G_OPTION_ARG_NONE, &teco_mung_file,
		 "Mung script file (first non-option argument) instead of "
		 "$SCITECOCONFIG" G_DIR_SEPARATOR_S INI_FILE},
		{"no-profile", 0, G_OPTION_FLAG_REVERSE,
		 G_OPTION_ARG_NONE, &teco_mung_profile,
		 "Do not mung "
		 "$SCITECOCONFIG" G_DIR_SEPARATOR_S INI_FILE " "
		 "even if it exists"},
		{"fake-cmdline", 0, G_OPTION_FLAG_HIDDEN,
		 G_OPTION_ARG_STRING, &teco_fake_cmdline,
		 "Emulate key presses in batch mode (for debugging)", "keys"},
		{"sandbox", 0, G_OPTION_FLAG_HIDDEN,
		 G_OPTION_ARG_NONE, &teco_sandbox,
		 "Sandbox application (for debugging)"},
		{"8bit", '8', 0, G_OPTION_ARG_NONE, &teco_8bit_clean,
		 "Use ANSI encoding by default and disable automatic EOL conversion"},
		{NULL}
	};

	g_autoptr(GError) error = NULL;

	g_autoptr(GOptionContext) options = g_option_context_new("[--|-S] [SCRIPT] [ARGUMENT...]");

	g_option_context_set_summary(
		options,
		PACKAGE_STRING " -- Scintilla-based Text Editor and COrrector"
	);
	g_option_context_set_description(
		options,
		"Bug reports should go to <" PACKAGE_BUGREPORT "> or "
		"<" PACKAGE_URL ">."
	);

	g_option_context_add_main_entries(options, option_entries, NULL);

	GOptionGroup *interface_group = teco_interface_get_options();
	if (interface_group)
		g_option_context_add_group(options, interface_group);

	/*
	 * We parse in POSIX mode, which means that
	 * the first non-option argument terminates option parsing.
	 * SciTECO considers all non-option arguments to be script
	 * arguments and it makes little sense to mix script arguments
	 * with SciTECO options, so this lets the user avoid "--"
	 * in many situations.
	 * It is also strictly required to make hash-bang lines like
	 * #!/usr/bin/sciteco -m
	 * work (without additional --).
	 */
	g_option_context_set_strict_posix(options, TRUE);

	/*
	 * The first unknown parameter will be left in argv and
	 * terminates option parsing (see above).
	 * This means we can use "-S" as an alternative to "--",
	 * that is always preserved and passed down to the macro.
	 */
	g_option_context_set_ignore_unknown_options(options, TRUE);

	if (!g_option_context_parse_strv(options, argv, &error)) {
		g_fprintf(stderr, "Option parsing failed: %s\n",
			  error->message);
		exit(EXIT_FAILURE);
	}

	if ((*argv)[0] && !g_strcmp0((*argv)[1], "-S")) {
		/* translate -S to --, this is always passed down */
		(*argv)[1][1] = '-';
	} else if ((*argv)[0] && !g_strcmp0((*argv)[1], "--")) {
		/*
		 * GOption will NOT remove "--" if followed by an
		 * option-argument, which may interfer with scripts
		 * doing their own option handling and interpreting "--".
		 * Otherwise, GOption will always remove "--".
		 *
		 * NOTE: This is still true if we're parsing in GNU-mode
		 * and "--" is not the first non-option argument as in
		 * sciteco foo -- -C bar.
		 */
		g_free(teco_strv_remove(*argv, 1));
	} else if ((*argv)[0] && (*argv)[1] && *(*argv)[1] == '-') {
		/*
		 * GOption does not remove "--" if it is followed by "-",
		 * so if the first parameter starts with "-", we know it's
		 * not a known built-in parameter.
		 */
		g_fprintf(stderr, "Unknown option \"%s\"\n", (*argv)[1]);
		exit(EXIT_FAILURE);
	}

	gchar *mung_filename = NULL;

	if (teco_mung_file) {
		if (!(*argv)[0] || !(*argv)[1]) {
			g_fprintf(stderr, "Script to mung expected!\n");
			exit(EXIT_FAILURE);
		}

		if (!g_file_test((*argv)[1], G_FILE_TEST_IS_REGULAR)) {
			g_fprintf(stderr, "Cannot mung \"%s\". File does not exist!\n",
			          (*argv)[1]);
			exit(EXIT_FAILURE);
		}

		mung_filename = teco_strv_remove(*argv, 1);
	}

	return mung_filename;
}

static void
teco_initialize_environment(void)
{
	g_autoptr(GError) error = NULL;
	gchar *abs_path;

	/*
	 * Initialize some "special" environment variables.
	 * For ease of use and because there are no threads yet,
	 * we modify the process environment directly.
	 * Later it is imported into the global Q-Register table
	 * and the process environment should no longer be accessed
	 * directly.
	 *
	 * Initialize and canonicalize $HOME.
	 * Therefore we can refer to $HOME as the
	 * current user's home directory on any platform
	 * and you can even start SciTECO with $HOME set to a relative
	 * path (sometimes useful for testing).
	 */
	g_setenv("HOME", g_get_home_dir(), FALSE);
	abs_path = teco_file_get_absolute_path(g_getenv("HOME"));
	g_setenv("HOME", abs_path, TRUE);
	g_free(abs_path);

#ifdef G_OS_WIN32
	/*
	 * NOTE: Environment variables are case-insensitive on Windows
	 * and there may be either a $COMSPEC or $ComSpec variable.
	 * By unsetting and resetting $COMSPEC, we make sure that
	 * it exists with defined case in the environment and therefore
	 * as a Q-Register.
	 */
	g_autofree gchar *comspec = g_strdup(g_getenv("COMSPEC") ? : "cmd.exe");
	g_unsetenv("COMSPEC");
	g_setenv("COMSPEC", comspec, TRUE);
#elif defined(G_OS_UNIX)
	g_setenv("SHELL", "/bin/sh", FALSE);
#endif

	/*
	 * Initialize $SCITECOCONFIG and $SCITECOPATH
	 */
	g_autofree gchar *default_configpath = teco_get_default_config_path();
	g_setenv("SCITECOCONFIG", default_configpath, FALSE);
	g_autofree gchar *datadir = teco_file_get_datadir();
	g_autofree gchar *default_libdir = g_build_filename(datadir, "lib", NULL);
	g_setenv("SCITECOPATH", default_libdir, FALSE);

	/*
	 * $SCITECOCONFIG and $SCITECOPATH may still be relative.
	 * They are canonicalized, so macros can use them even
	 * if the current working directory changes.
	 */
	abs_path = teco_file_get_absolute_path(g_getenv("SCITECOCONFIG"));
	g_setenv("SCITECOCONFIG", abs_path, TRUE);
	g_free(abs_path);
	abs_path = teco_file_get_absolute_path(g_getenv("SCITECOPATH"));
	g_setenv("SCITECOPATH", abs_path, TRUE);
	g_free(abs_path);

	/*
	 * Import process environment into global Q-Register
	 * table. While it is safe to use g_setenv() early
	 * on at startup, it might be problematic later on
	 * (e.g. it's non-thread-safe).
	 * Therefore the environment registers in the global
	 * table should be used from now on to set and get
	 * environment variables.
	 * When spawning external processes that should inherit
	 * the environment variables, the environment should
	 * be exported via QRegisters::globals.get_environ().
	 */
	if (!teco_qreg_table_set_environ(&teco_qreg_table_globals, &error)) {
		g_fprintf(stderr, "Error intializing environment: %s\n",
		          error->message);
		exit(EXIT_FAILURE);
	}
}

/*
 * Callbacks
 */

static void
teco_sigint_handler(int signal)
{
	teco_interrupted = TRUE;
}

#ifdef G_OS_WIN32
/*
 * We are linking with -municode, since MinGW could otherwise
 * fail trying to convert Unicode command lines into the system locale.
 * We still don't use argv since g_win32_get_command_line() returns
 * an UTF-8 version.
 * The alternative would be compiling in a manifest.
 */
int
wmain(int argc, wchar_t **argv)
#else
int
main(int argc, char **argv)
#endif
{
	g_autoptr(GError) error = NULL;

#ifdef DEBUG_PAUSE
	/* Windows debugging hack (see above) */
	system("pause");
#endif

	signal(SIGINT, teco_sigint_handler);
	signal(SIGTERM, teco_sigint_handler);

	/*
	 * Important for Unicode handling in curses and glib.
	 * In particular, in order to accept Unicode characters
	 * in option strings.
	 *
	 * NOTE: Windows 10 accepts ".UTF8" here, so the "ANSI"
	 * versions of win32 API functions accept UTF-8.
	 * We want to support older versions, though and
	 * glib happily converts to Windows' native UTF-16.
	 */
	setlocale(LC_ALL, "");

#ifdef G_OS_WIN32
	/*
	 * main()'s argv is in the system locale, so we might loose
	 * information when passing it to g_option_context_parse().
	 * The remaining strings are also not guaranteed to be in
	 * UTF-8.
	 */
	g_auto(GStrv) argv_utf8 = g_win32_get_command_line();
#else
	g_auto(GStrv) argv_utf8 = g_strdupv(argv);
#endif
	g_autofree gchar *mung_filename = teco_process_options(&argv_utf8);
	/*
	 * All remaining arguments in argv are arguments
	 * to the macro or munged file.
	 */

#ifdef HAVE_CAP_ENTER
	/*
	 * In the sandbox, we cannot access files or execute external processes.
	 * Effectively, munging won't work, so you can pass macros only via
	 * --eval or --fake-cmdline.
	 */
	if (G_UNLIKELY(teco_sandbox))
		cap_enter();
#endif

	if (teco_8bit_clean)
		/* equivalent to 16,4ED but executed earlier */
		teco_ed = (teco_ed & ~TECO_ED_AUTOEOL) | TECO_ED_DEFAULT_ANSI;

	/*
	 * Theoretically, QReg tables should only be initialized
	 * after the interface, since they contain Scintilla documents.
	 * However, this would prevent the inialization of clipboard QRegs
	 * in teco_interface_init() and those should be available in batch mode
	 * as well.
	 * As long as the string parts are not accessed, that should be OK.
	 *
	 * FIXME: Perhaps it would be better to introduce something like
	 * teco_interface_init_clipboard()?
	 */
	teco_qreg_table_init(&teco_qreg_table_globals, TRUE);

	teco_interface_init();

	/*
	 * QRegister view must be initialized only now
	 * (e.g. after Curses/GTK initialization).
	 */
	teco_qreg_view = teco_view_new();
	teco_view_setup(teco_qreg_view);

	/*
	 * FIXME: "_" and "-" should perhaps be in the local Q-Reg table, so you don't
	 * have to back them up on the Q-Reg stack in portable macros.
	 * DEC TECO has them in the global table, though.
	 */
	/* search string and status register */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_plain_new("_", 1));
	/* replacement string register */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_plain_new("-", 1));
	/* current document's dot (":") */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_dot_new());
	/* current buffer name and number ("*") */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_bufferinfo_new());
	/* current working directory ("$") */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_workingdir_new());
	/* environment defaults and registers */
	teco_initialize_environment();

	teco_qreg_table_t local_qregs;
	teco_qreg_table_init_locals(&local_qregs, TRUE);

	if (!teco_ring_edit_by_name(NULL, &error)) {
		g_prefix_error(&error, "Error editing unnamed file: ");
		goto cleanup;
	}

	/*
	 * Add remaining arguments to unnamed buffer.
	 *
	 * FIXME: This is not really robust since filenames may contain linefeeds.
	 * Also, the Unnamed Buffer should be kept empty for piping.
	 * Therefore, it would be best to store the arguments in Q-Regs, e.g. $0,$1,$2...
	 */
	for (gint i = 1; argv_utf8[i]; i++) {
		teco_interface_ssm(SCI_APPENDTEXT, strlen(argv_utf8[i]), (sptr_t)argv_utf8[i]);
		teco_interface_ssm(SCI_APPENDTEXT, 1, (sptr_t)"\n");
	}

	/*
	 * Execute macro or mung file
	 */
	if (teco_eval_macro) {
		if (!teco_execute_macro(teco_eval_macro, strlen(teco_eval_macro),
		                        &local_qregs, &error) &&
		    !g_error_matches(error, TECO_ERROR, TECO_ERROR_QUIT)) {
			teco_error_add_frame_toplevel();
			goto cleanup;
		}
		g_clear_error(&error);

		if (!teco_ed_hook(TECO_ED_HOOK_QUIT, &error))
			goto cleanup;
		goto cleanup;
	}

	if (!mung_filename && teco_mung_profile) {
		/* NOTE: Still safe to use g_getenv() */
		mung_filename = g_build_filename(g_getenv("SCITECOCONFIG"), INI_FILE, NULL);
		if (!g_file_test(mung_filename, G_FILE_TEST_IS_REGULAR)) {
			g_autofree gchar *datadir = teco_file_get_datadir();
			gchar *fallback = g_build_filename(datadir, "fallback.teco_ini", NULL);
			if (g_file_test(fallback, G_FILE_TEST_IS_REGULAR)) {
				teco_interface_msg(TECO_MSG_WARNING,
				                   "Profile \"%s\" not found: Falling back to \"%s\".",
				                   mung_filename, fallback);
				g_free(mung_filename);
				mung_filename = fallback;
			} else {
				teco_interface_msg(TECO_MSG_WARNING,
				                   "No profile found to mung.");
				g_free(mung_filename);
				g_free(fallback);
				mung_filename = NULL;
			}
		}
	}

	if (mung_filename) {
		/*
		 * NOTE: Theoretically there is a small timeframe when the file could
		 * disappear, in which case there will be an error.
		 */
		if (!teco_execute_file(mung_filename, &local_qregs, &error) &&
		    !g_error_matches(error, TECO_ERROR, TECO_ERROR_QUIT))
			goto cleanup;
		g_clear_error(&error);

		if (teco_quit_requested) {
			if (!teco_ed_hook(TECO_ED_HOOK_QUIT, &error))
				goto cleanup;
			goto cleanup;
		}
	}

	/*
	 * If munged file didn't quit, switch into interactive mode
	 */
	/* commandline replacement string register */
	teco_qreg_table_insert(&teco_qreg_table_globals, teco_qreg_plain_new("\e", 1));

	teco_undo_enabled = TRUE;
	teco_ring_set_scintilla_undo(TRUE);
	teco_view_set_scintilla_undo(teco_qreg_view, TRUE);

	/*
	 * FIXME: Perhaps we should simply call teco_cmdline_init() and
	 * teco_cmdline_cleanup() here.
	 */
	teco_machine_main_init(&teco_cmdline.machine, &local_qregs, TRUE);

	if (G_UNLIKELY(teco_fake_cmdline != NULL)) {
		/*
		 * NOTE: Most errors are already catched at a higher level,
		 * so you cannot rely on the exit code to detect them.
		 */
		if (!teco_cmdline_keypress(teco_fake_cmdline, strlen(teco_fake_cmdline), &error) &&
		    !g_error_matches(error, TECO_ERROR, TECO_ERROR_QUIT)) {
			teco_error_add_frame_toplevel();
			goto cleanup;
		}
	} else if (!teco_interface_event_loop(&error)) {
		goto cleanup;
	}

	teco_machine_main_clear(&teco_cmdline.machine);
	memset(&teco_cmdline.machine, 0, sizeof(teco_cmdline.machine));

	/*
	 * Ordinary application termination:
	 * Interface is shut down, so we are
	 * in non-interactive mode again.
	 */
	teco_undo_enabled = FALSE;
	teco_undo_clear();
	/* also empties all Scintilla undo buffers */
	teco_ring_set_scintilla_undo(FALSE);
	teco_view_set_scintilla_undo(teco_qreg_view, FALSE);

	if (!teco_ed_hook(TECO_ED_HOOK_QUIT, &error))
		goto cleanup;

cleanup:
	if (error != NULL)
		teco_error_display_full(error);

#ifndef NDEBUG
	teco_ring_cleanup();
	teco_qreg_table_clear(&local_qregs);
	teco_qreg_table_clear(&teco_qreg_table_globals);
	teco_qreg_stack_clear();
	teco_view_free(teco_qreg_view);
#endif
	teco_interface_cleanup();

	return error ? EXIT_FAILURE : EXIT_SUCCESS;
}