Method IsDirective

source/script.cpp:3549–4000

inline ResultType Script::IsDirective(LPTSTR aBuf)
// aBuf must be a modifiable string as it may be temporarily terminated at different points.
// Returns CONDITION_TRUE, CONDITION_FALSE, or FAIL.
// Note: Don't assume that every line in the script that starts with '#' is a directive
// because hotkeys can legitimately start with that as well.  i.e., the following line should
// not be unconditionally ignored, just because it starts with '#', since it is a valid hotkey:
// #y::run, notepad
{
	TCHAR end_flags[] = {' ', '\t', '\0'}; // '\0' must be last.
	LPTSTR directive_end, parameter;
	if (   !(directive_end = StrChrAny(aBuf, end_flags))   )
	{
		directive_end = aBuf + _tcslen(aBuf); // Point it to the zero terminator.
		parameter = NULL;
	}
	else
		if (!*(parameter = omit_leading_whitespace(directive_end)))
			parameter = NULL;

	// Make a null-terminated copy of the potential directive name, if not already terminated,
	// so that overlapping names such as #MaxThreads and #MaxThreadsPerHotkey won't get mixed up.
	// This significantly reduces code size vs. using tcslicmp() in IS_DIRECTIVE_MATCH().
	LPCTSTR directive_name;
	TCHAR directive_name_buf[32];
	if (directive_end - aBuf >= _countof(directive_name_buf))
		return CONDITION_FALSE;
	if (*directive_end)
	{
		tcslcpy(directive_name_buf, aBuf, directive_end - aBuf + 1);
		directive_name = directive_name_buf;
	}
	else
		directive_name = aBuf;
	#define IS_DIRECTIVE_MATCH(directive) (!_tcsicmp(directive_name, directive))

	bool is_include_again = false; // Set default in case of short-circuit boolean.
	if (IS_DIRECTIVE_MATCH(_T("#Include")) || (is_include_again = IS_DIRECTIVE_MATCH(_T("#IncludeAgain"))))
	{
		// Standalone EXEs ignore this directive since the included files were already merged in
		// with the main file when the script was compiled.  These should have been removed
		// or commented out by Ahk2Exe, but just in case, it's safest to ignore them:
#ifdef AUTOHOTKEYSC
		return CONDITION_TRUE;
#else
		if (!parameter)
			return ScriptError(ERR_PARAM1_REQUIRED, aBuf);
		
		// Permit quote marks around the parameter.  In future, quote marks might be required,
		// or the parameter might be evaluated as an expression.
		parameter = strip_quote_marks(parameter);
		if (!*parameter)
			return ScriptError(ERR_PARAM1_INVALID);

		// v1.0.32:
		bool ignore_load_failure = (parameter[0] == '*' && ctoupper(parameter[1]) == 'I' && IS_SPACE_OR_TAB(parameter[2])); // Relies on short-circuit boolean order.
		if (ignore_load_failure)
			parameter += 3; // Skip over at most one space or tab, since others might be a literal part of the filename.