protobuf plugin

Author: Peng Hu

Plugins/ue4-protobuf/.gitignore

@@ -0,0 +1,2 @@
+Binaries/
+Intermediate/

Plugins/ue4-protobuf/Protobuf.uplugin

@@ -0,0 +1,28 @@
+{
+	"FileVersion": 3,
+	"Version": 1,
+	"VersionName": "1.0",
+	"FriendlyName": "Protobuf",
+	"Description": "",
+	"Category": "Other",
+	"CreatedBy": "",
+	"CreatedByURL": "",
+	"DocsURL": "",
+	"MarketplaceURL": "",
+	"SupportURL": "",
+	"CanContainContent": true,
+	"IsBetaVersion": false,
+	"Installed": false,
+	"Modules": [
+		{
+			"Name": "Protobuf",
+			"Type": "Runtime",
+			"LoadingPhase": "PreDefault"
+		},
+		{
+			"Name": "ProtobufEditor",
+			"Type": "Editor",
+			"LoadingPhase": "Default"
+		}
+	]
+}

Plugins/ue4-protobuf/README.md

@@ -0,0 +1,22 @@
+### What is this?
+
+This is an Unreal Engine 4 plugin that integrates [Protobuf](https://github.com/protocolbuffers/protobuf) into the project without requiring you to add system PATH or anything else.
+
+### How do use?
+
+1. add the plugin to the project and enable it.
+2. add the following property to `build.cs` of the project :
+
+```csharp
+PublicDependencyModuleNames.Add("Protobuf");
+bEnableUndefinedIdentifierWarnings = false;
+bEnableExceptions = true;
+```
+
+4. Create `.proto` file into project source code folder 
+5. Launch the Project in Editor, Click the `Protoc` button.
+
+### Protobuf Version
+
+- Protobuf v3.5.1
+

Plugins/ue4-protobuf/Resources/ButtonIcon_40x.png

@@ -0,0 +1,20 @@
+// Copyright 1998-2018 Epic Games, Inc. All Rights Reserved.
+
+#include "Protobuf.h"
+
+#define LOCTEXT_NAMESPACE "FProtobufModule"
+
+void FProtobufModule::StartupModule()
+{
+	// This code will execute after your module is loaded into memory; the exact timing is specified in the .uplugin file per-module
+}
+
+void FProtobufModule::ShutdownModule()
+{
+	// This function may be called during shutdown to clean up your module.  For modules that support dynamic reloading,
+	// we call this function before unloading the module.
+}
+
+#undef LOCTEXT_NAMESPACE
+	
+IMPLEMENT_MODULE(FProtobufModule, Protobuf)

Plugins/ue4-protobuf/Resources/Icon128.png

@@ -0,0 +1,93 @@
+// Copyright 1998-2018 Epic Games, Inc. All Rights Reserved.
+
+using UnrealBuildTool;
+using System.IO;
+public class Protobuf : ModuleRules
+{
+    private string ModulePath
+    {
+        get { return ModuleDirectory; }
+    }
+
+    private string ThridPartyPath
+    {
+        get { return Path.Combine(ModulePath, "ThirdParty/"); }
+    }
+
+    public Protobuf(ReadOnlyTargetRules Target) : base(Target)
+	{
+		PCHUsage = ModuleRules.PCHUsageMode.UseExplicitOrSharedPCHs;
+		
+		PublicIncludePaths.AddRange(
+			new string[] {
+				// ... add public include paths required here ...
+			}
+			);
+				
+		
+		PrivateIncludePaths.AddRange(
+			new string[] {
+				// ... add other private include paths required here ...
+			}
+			);
+			
+		
+		PublicDependencyModuleNames.AddRange(
+			new string[]
+			{
+				"Core",
+				// ... add other public dependencies that you statically link with here ...
+			}
+			);
+			
+		
+		PrivateDependencyModuleNames.AddRange(
+			new string[]
+			{
+				// ... add private dependencies that you statically link with here ...	
+			}
+			);
+		
+		
+		DynamicallyLoadedModuleNames.AddRange(
+			new string[]
+			{
+				// ... add any modules that your module loads dynamically here ...
+			}
+			);
+
+        PublicSystemIncludePaths.AddRange(
+            new string[]
+            {
+                Path.Combine(ThridPartyPath,"protobuf/include")
+            }
+            );
+
+        PublicAdditionalLibraries.AddRange(
+            new string[]
+            {
+            }
+            );
+
+        if(Target.bForceEnableRTTI)
+        {
+            bUseRTTI = true;
+            PublicDefinitions.Add("GOOGLE_PROTOBUF_NO_RTTI=0");
+        }
+        else
+        {
+            bUseRTTI = false;
+            PublicDefinitions.Add("GOOGLE_PROTOBUF_NO_RTTI=1");
+        }
+        if(Target.Platform != UnrealTargetPlatform.Win32 && Target.Platform != UnrealTargetPlatform.Win64)
+        {
+            PublicDefinitions.Add("HAVE_PTHREAD");
+        }
+
+        PublicDefinitions.Add("_CRT_SECURE_NO_WARNINGS");
+
+        bEnableShadowVariableWarnings = false;
+        bEnableUndefinedIdentifierWarnings = false;
+        bEnableExceptions = true;
+    }
+}

Plugins/ue4-protobuf/Source/Protobuf/Private/Protobuf.cpp

@@ -0,0 +1,15 @@
+// Copyright 1998-2018 Epic Games, Inc. All Rights Reserved.
+
+#pragma once
+
+#include "CoreMinimal.h"
+#include "Modules/ModuleManager.h"
+
+class FProtobufModule : public IModuleInterface
+{
+public:
+
+	/** IModuleInterface implementation */
+	virtual void StartupModule() override;
+	virtual void ShutdownModule() override;
+};

Plugins/ue4-protobuf/Source/Protobuf/Protobuf.Build.cs

@@ -0,0 +1,60 @@
+set(PACKAGE_VERSION "3.5.1")
+set(${PACKAGE_FIND_NAME}_VERSION_PRERELEASE "" PARENT_SCOPE)
+
+# Prerelease versions cannot be passed in directly via the find_package command,
+# so we allow users to specify it in a variable
+if(NOT DEFINED "${PACKAGE_FIND_NAME}_FIND_VERSION_PRERELEASE")
+  set("${${PACKAGE_FIND_NAME}_FIND_VERSION_PRERELEASE}" "")
+else()
+  set(PACKAGE_FIND_VERSION ${PACKAGE_FIND_VERSION}-${${PACKAGE_FIND_NAME}_FIND_VERSION_PRERELEASE})
+endif()
+set(PACKAGE_FIND_VERSION_PRERELEASE "${${PACKAGE_FIND_NAME}_FIND_VERSION_PRERELEASE}")
+
+# VERSION_EQUAL ignores the prerelease strings, so we use STREQUAL.
+if(PACKAGE_FIND_VERSION STREQUAL PACKAGE_VERSION)
+  set(PACKAGE_VERSION_EXACT TRUE)
+endif()
+
+set(PACKAGE_VERSION_COMPATIBLE TRUE) #Assume true until shown otherwise
+
+if(PACKAGE_FIND_VERSION) #Only perform version checks if one is given
+  if(NOT PACKAGE_FIND_VERSION_MAJOR EQUAL "3")
+    set(PACKAGE_VERSION_COMPATIBLE FALSE)
+  elseif(PACKAGE_FIND_VERSION VERSION_GREATER PACKAGE_VERSION)
+    set(PACKAGE_VERSION_COMPATIBLE FALSE)
+  elseif(PACKAGE_FIND_VERSION VERSION_EQUAL PACKAGE_VERSION)
+    # Do not match prerelease versions to non-prerelease version requests.
+      if(NOT "" STREQUAL "" AND PACKAGE_FIND_VERSION_PRERELEASE STREQUAL "")
+      message(AUTHOR_WARNING "To use this prerelease version of ${PACKAGE_FIND_NAME}, set ${PACKAGE_FIND_NAME}_FIND_VERSION_PRERELEASE to '' or greater.")
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+
+    # Not robustly SemVer compliant, but protobuf never uses '.' separated prerelease identifiers.
+    if(PACKAGE_FIND_VERSION_PRERELEASE STRGREATER "")
+      set(PACKAGE_VERSION_COMPATIBLE FALSE)
+    endif()
+  endif()
+endif()
+
+# Check and save build options used to create this package
+macro(_check_and_save_build_option OPTION VALUE)
+  if(DEFINED ${PACKAGE_FIND_NAME}_${OPTION} AND
+    NOT ${PACKAGE_FIND_NAME}_${OPTION} STREQUAL ${VALUE})
+    set(PACKAGE_VERSION_UNSUITABLE TRUE)
+  endif()
+  set(${PACKAGE_FIND_NAME}_${OPTION} ${VALUE} PARENT_SCOPE)
+endmacro()
+_check_and_save_build_option(WITH_ZLIB OFF)
+_check_and_save_build_option(MSVC_STATIC_RUNTIME ON)
+_check_and_save_build_option(BUILD_SHARED_LIBS OFF)
+
+# if the installed or the using project don't have CMAKE_SIZEOF_VOID_P set, ignore it:
+if(CMAKE_SIZEOF_VOID_P AND "4")
+  # check that the installed version has the same 32/64bit-ness as the one which is currently searching:
+  if(NOT CMAKE_SIZEOF_VOID_P EQUAL "4")
+    math(EXPR installedBits "4 * 8")
+    set(PACKAGE_VERSION "${PACKAGE_VERSION} (${installedBits}bit)")
+    set(PACKAGE_VERSION_UNSUITABLE TRUE)
+  endif()
+endif()
+