lumberyard-employee-dm
99d0c39273
* The O3DE.exe Open Editor button now attempts to open the Editor in the build directory of the project being opened. If their is no Editor within the build directory of the Project, it uses the Editor.exe in the current O3DE.exe executable directory if it exists Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Engine .gitignore now ignores the build directory if placed in the AutomatedTesting project Previously it was just ignoring a `[Bb]uild` directory if it was directly within the engine root. This change matches the behavior of the project templates. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Renamed the ProjectUtils GetEditorDirectory function to GetEditorExecutablePath Added a platform specific implementation for retrieving the path to the Editor executable in the GetEditorExectuablePath function. It first attempts to locate the Editor via checking the project build directory for an Editor executable before falling back to checking the binary directory of the currently running O3DE executable. Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com> * Correct the MacOS GetEditorExecutablePath to return the Editor path Signed-off-by: lumberyard-employee-dm <56135373+lumberyard-employee-dm@users.noreply.github.com>
103 lines
4.7 KiB
C++
103 lines
4.7 KiB
C++
/*
|
|
* Copyright (c) Contributors to the Open 3D Engine Project.
|
|
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0 OR MIT
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <ScreenDefs.h>
|
|
#include <ProjectInfo.h>
|
|
#include <ProjectManagerDefs.h>
|
|
|
|
#include <QWidget>
|
|
#include <QProcessEnvironment>
|
|
|
|
#include <AzCore/IO/Path/Path_fwd.h>
|
|
#include <AzCore/Outcome/Outcome.h>
|
|
|
|
namespace O3DE::ProjectManager
|
|
{
|
|
namespace ProjectUtils
|
|
{
|
|
bool AddProjectDialog(QWidget* parent = nullptr);
|
|
bool RegisterProject(const QString& path);
|
|
bool UnregisterProject(const QString& path);
|
|
bool CopyProjectDialog(const QString& origPath, ProjectInfo& newProjectInfo, QWidget* parent = nullptr);
|
|
bool CopyProject(const QString& origPath, const QString& newPath, QWidget* parent, bool skipRegister = false);
|
|
bool DeleteProjectFiles(const QString& path, bool force = false);
|
|
bool MoveProject(QString origPath, QString newPath, QWidget* parent, bool skipRegister = false);
|
|
|
|
bool ReplaceProjectFile(const QString& origFile, const QString& newFile, QWidget* parent = nullptr, bool interactive = true);
|
|
|
|
bool FindSupportedCompiler(QWidget* parent = nullptr);
|
|
AZ::Outcome<QString, QString> FindSupportedCompilerForPlatform();
|
|
|
|
ProjectManagerScreen GetProjectManagerScreen(const QString& screen);
|
|
|
|
/**
|
|
* Execute a console command and return the result.
|
|
* @param cmd the command
|
|
* @param arguments the command argument list
|
|
* @param processEnv the environment
|
|
* @param commandTimeoutSeconds the amount of time in seconds to let the command run before terminating it
|
|
* @return AZ::Outcome with the command result on success
|
|
*/
|
|
AZ::Outcome<QString, QString> ExecuteCommandResult(
|
|
const QString& cmd,
|
|
const QStringList& arguments,
|
|
int commandTimeoutSeconds = ProjectCommandLineTimeoutSeconds);
|
|
|
|
/**
|
|
* Execute a console command, display the progress in a modal dialog and return the result.
|
|
* @param cmd the command
|
|
* @param arguments the command argument list
|
|
* @param processEnv the environment
|
|
* @param commandTimeoutSeconds the amount of time in seconds to let the command run before terminating it
|
|
* @return AZ::Outcome with the command result on success
|
|
*/
|
|
AZ::Outcome<QString, QString> ExecuteCommandResultModalDialog(
|
|
const QString& cmd,
|
|
const QStringList& arguments,
|
|
const QString& title);
|
|
|
|
AZ::Outcome<void, QString> SetupCommandLineProcessEnvironment();
|
|
AZ::Outcome<QString, QString> GetProjectBuildPath(const QString& projectPath);
|
|
AZ::Outcome<void, QString> OpenCMakeGUI(const QString& projectPath);
|
|
AZ::Outcome<QString, QString> RunGetPythonScript(const QString& enginePath);
|
|
|
|
/**
|
|
* Create a desktop shortcut.
|
|
* @param filename the name of the desktop shorcut file
|
|
* @param target the path to the target to run
|
|
* @param arguments the argument list to provide to the target
|
|
* @return AZ::Outcome with the command result on success
|
|
*/
|
|
AZ::Outcome<QString, QString> CreateDesktopShortcut(const QString& filename, const QString& targetPath, const QStringList& arguments);
|
|
|
|
/**
|
|
* Lookup the location of an Editor executable executable that can be used with the
|
|
* supplied project path
|
|
* First the method attempts to locate a build directory with the project path
|
|
* via querying the <project-path>/user/Registry/Platform/<platform>/build_path.setreg
|
|
* Once that is done a path is formed to locate the Editor executable within the that build
|
|
* directory.
|
|
* Two paths will checked for the existence of an Editor
|
|
* - "<project-build-directory>/bin/$<CONFIG>/Editor"
|
|
* - "<project-build-directory>/bin/<platform>/$<CONFIG>/Editor"
|
|
* Where <platform> is the current platform the O3DE executable is running on and $<CONFIG> is the
|
|
* current build configuration the O3DE executable
|
|
*
|
|
* If neiether of the above paths contain an Editor application, then a path to the Editor
|
|
* is formed by combinding the O3DE executable directory with the filename of Editor
|
|
* - "<executable-directory>/Editor"
|
|
*
|
|
* @param projectPath Path to the root of the project
|
|
* @return path of the Editor Executable if found or an empty path if not
|
|
*/
|
|
AZ::IO::FixedMaxPath GetEditorExecutablePath(const AZ::IO::PathView& projectPath);
|
|
|
|
} // namespace ProjectUtils
|
|
} // namespace O3DE::ProjectManager
|