Method Init

source/script.cpp:676–823

ResultType Script::Init(global_struct &g, LPTSTR aScriptFilename, bool aIsRestart)
// Returns OK or FAIL.
// Caller has provided an empty string for aScriptFilename if this is a compiled script.
// Otherwise, aScriptFilename can be NULL if caller hasn't determined the filename of the script yet.
{
	mIsRestart = aIsRestart;
	TCHAR buf[UorA(T_MAX_PATH, 2048)]; // Just to make sure we have plenty of room to do things with.
	size_t buf_length;

	// It may be better to get the module name this way rather than reading it from the registry
	// in case the user has moved it to a folder other than the install folder, hasn't installed it,
	// or has renamed the EXE file itself.
	if (buf_length = GetModuleFileName(NULL, buf, _countof(buf)))
	{
		// Any path longer than MAX_PATH is probably impossible as of 2018 since testing indicates
		// the program can't start if its path is longer than MAX_PATH-1 even with Windows 10 long
		// path awareness enabled.
		if (buf_length == _countof(buf)) // It was truncated.
			return FAIL; // Seems the safest option for this unlikely case.
		mOurEXE = SimpleHeap::Alloc(buf, buf_length);
		LPTSTR last_backslash = _tcsrchr(buf, '\\');
		if (last_backslash) // Probably always true due to the nature of GetModuleFileName().
			mOurEXEDir = SimpleHeap::Alloc(buf, last_backslash - buf);
	}

#ifdef AUTOHOTKEYSC
	mKind = ScriptKindResource;
	// Fix for v1.0.29: Override the caller's use of __argv[0] by using GetModuleFileName(),
	// so that when the script is started from the command line but the user didn't type the
	// extension, the extension will be included.  This necessary because otherwise
	// #SingleInstance wouldn't be able to detect duplicate versions in every case.
	// It also provides more consistency.
	aScriptFilename = buf;
#else
	TCHAR def_buf[513]; // Enough for max Documents path (256 chars, according to testing on 20H2), slash and max NTFS filename (255 chars).
#ifdef _DEBUG
	if (!aScriptFilename)
		aScriptFilename = _T("Test\\Test.ahk");
#endif
	if (!aScriptFilename) // v1.0.46.08: Change in policy: store the default script in the My Documents directory rather than in Program Files.  It's more correct and solves issues that occur due to Vista's file-protection scheme.
	{
		// Since no script-file was specified on the command line, use the default name.
		// For portability, first check if there's an <EXENAME>.ahk file in the current directory.
		LPTSTR suffix, dot;
		if (  (suffix = _tcsrchr(buf, '\\')) // Find name part of path.
			&& (dot = _tcsrchr(suffix, '.')) // Find extension part of name.
			&& dot - buf + 5 < _countof(buf)  ) // Enough space in buffer?
		{
			_tcscpy(dot, EXT_AUTOHOTKEY);
		}
		else // Very unlikely.
			return FAIL;

		aScriptFilename = buf; // Use the entire path, including the exe's directory.
		if (GetFileAttributes(aScriptFilename) == 0xFFFFFFFF) // File doesn't exist, so fall back to new method.
		{
			// The only known cause of failure for SHGetKnownFolderPath is having a path longer than
			// 256 characters; i.e. by sabotaging the "...\User Shell Folders\Personal" registry value.