UnrealEngineUWP/Engine/Source/Runtime/Projects/Public/PluginDescriptor.h

// Copyright Epic Games, Inc. All Rights Reserved.

#pragma once

#include "CoreMinimal.h"
#include "ModuleDescriptor.h"
#include "CustomBuildSteps.h"
#include "LocalizationDescriptor.h"
#include "PluginReferenceDescriptor.h"
#include "VerseScope.h"

class FJsonObject;
class FJsonValue;

/**
 * Setting for whether a plugin is enabled by default
 */ 
enum class EPluginEnabledByDefault : uint8
{
	Unspecified,
	Enabled,
	Disabled,
};

/**
 * Descriptor for plugins. Contains all the information contained within a .uplugin file.
 */
struct PROJECTS_API FPluginDescriptor
{
	/** Version number for the plugin.  The version number must increase with every version of the plugin, so that the system 
	    can determine whether one version of a plugin is newer than another, or to enforce other requirements.  This version
		number is not displayed in front-facing UI.  Use the VersionName for that. */
	int32 Version;

	/** Name of the version for this plugin.  This is the front-facing part of the version number.  It doesn't need to match
	    the version number numerically, but should be updated when the version number is increased accordingly. */
	FString VersionName;

	/** Friendly name of the plugin */
	FString FriendlyName;

	/** Description of the plugin */
	FString Description;

	/** The name of the category this plugin */
	FString Category;

	/** The company or individual who created this plugin.  This is an optional field that may be displayed in the user interface. */
	FString CreatedBy;

	/** Hyperlink URL string for the company or individual who created this plugin.  This is optional. */
	FString CreatedByURL;

	/** Documentation URL string. */
	FString DocsURL;

	/** Marketplace URL for this plugin. This URL will be embedded into projects that enable this plugin, so we can redirect to the marketplace if a user doesn't have it installed. */
	FString MarketplaceURL;

	/** Support URL/email for this plugin. */
	FString SupportURL;

	/** Version of the engine that this plugin is compatible with */
	FString EngineVersion;

	/** Optional custom virtual path to display in editor to better organize. Inserted just before this plugin's directory in the path: /All/Plugins/EditorCustomVirtualPath/PluginName */
	FString EditorCustomVirtualPath;

	/** Controls a subset of platforms that can use this plugin, and which ones will stage the .uplugin file and content files. 
	Generally, for code plugins, it should be the union of platforms that the modules in the plugin are compiled for. */
	TArray<FString> SupportedTargetPlatforms;

	/** List of programs that are supported by this plugin. */
	TArray<FString> SupportedPrograms;

	/** If specified, this is the real plugin that this one is just extending */
	FString ParentPluginName;

	/** List of all modules associated with this plugin */
	TArray<FModuleDescriptor> Modules;

	/** List of all localization targets associated with this plugin */
	TArray<FLocalizationTargetDescriptor> LocalizationTargets;

	/** The Verse path to the root of this plugin's content directory */
	FString VersePath;

	/** Origin/visibility of Verse code in this plugin's Content/Verse folder */
	EVerseScope::Type VerseScope = EVerseScope::User;

	/** Whether this plugin should be enabled by default for all projects */
	EPluginEnabledByDefault EnabledByDefault;

	/** Can this plugin contain content? */
	bool bCanContainContent;

	/** Can this plugin contain Verse code? */
	bool bCanContainVerse;

	/** Marks the plugin as beta in the UI */
	bool bIsBetaVersion;

	/** Marks the plugin as experimental in the UI */
	bool bIsExperimentalVersion;

	/** Signifies that the plugin was installed on top of the engine */
	bool bInstalled;

	/** For plugins that are under a platform folder (eg. /PS4/), determines whether compiling the plugin requires the build platform and/or SDK to be available */
	bool bRequiresBuildPlatform;

	/** For auto-generated plugins that should not be listed in the plugin browser for users to disable freely. */
	bool bIsHidden;

	/** When true, this plugin's modules will not be loaded automatically nor will it's content be mounted automatically. It will load/mount when explicitly requested and LoadingPhases will be ignored */
	bool bExplicitlyLoaded;

	/** When true, an empty SupportedTargetPlatforms is interpreted as 'no platforms' with the expectation that explicit platforms will be added in plugin platform extensions */
	bool bHasExplicitPlatforms;

	/** If true, this plugin from a platform extension extending another plugin */
	bool bIsPluginExtension;

	/** Pre-build steps for each host platform */
	FCustomBuildSteps PreBuildSteps;

	/** Post-build steps for each host platform */
	FCustomBuildSteps PostBuildSteps;

	/** Plugins used by this plugin */
	TArray<FPluginReferenceDescriptor> Plugins;

#if WITH_EDITOR
	/** Cached json for custom data */
	mutable TSharedPtr<FJsonObject> CachedJson;

	/** Additional fields to write */
	TMap<FString, TSharedPtr<FJsonValue>> AdditionalFieldsToWrite;
#endif

	/** Return the .uplugin extension (with dot) */
	static const FString& GetFileExtension();

	/** Constructor. */
	FPluginDescriptor();

	/** Loads the descriptor from the given file. */
	bool Load(const FString& FileName, FText* OutFailReason = nullptr);

	/** Loads the descriptor from the given file. */
	bool Load(const FString& FileName, FText& OutFailReason);

	/** Reads the descriptor from the given string */
	bool Read(const FString& Text, FText* OutFailReason = nullptr);

	/** Reads the descriptor from the given string */
	bool Read(const FString& Text, FText& OutFailReason);

	/** Reads the descriptor from the given JSON object */
	bool Read(const FJsonObject& Object, FText* OutFailReason = nullptr);

	/** Reads the descriptor from the given JSON object */
	bool Read(const FJsonObject& Object, FText& OutFailReason);

	/** Saves the descriptor from the given file. */
	bool Save(const FString& FileName, FText* OutFailReason = nullptr) const;

	/** Saves the descriptor from the given file. */
	bool Save(const FString& FileName, FText& OutFailReason) const;

	/** Writes a descriptor to JSON */
	void Write(FString& Text) const;

	/** Writes a descriptor to JSON */
	void Write(TJsonWriter<>& Writer) const;

	/** Updates the given json object with values in this descriptor */
	void UpdateJson(FJsonObject& JsonObject) const;

	/**
	 * Updates the content of the specified plugin file with values in this descriptor
	 * (hence preserving json fields that the plugin descriptor doesn't know about)
	 */
	bool UpdatePluginFile(const FString& FileName, FText* OutFailReason = nullptr) const;

	/**
	 * Updates the content of the specified plugin file with values in this descriptor
	 * (hence preserving json fields that the plugin descriptor doesn't know about)
	 */
	bool UpdatePluginFile(const FString& FileName, FText& OutFailReason) const;

	/** Determines whether the plugin supports the given platform */
	bool SupportsTargetPlatform(const FString& Platform) const;
};