Move most C++ library code to common/ and include/ (#177)

* Move most C++ library code to common/ and include/

This is a preperatory change for Windows using all of this code. Since
it will be shared between multiple platforms, it should live in a shared
location.

Because the GN build flattens the headers in the generated out/include/,
some files have #if/#else branches for #includes. Once there is a final
decision on whether to use GN, this can be re-evaluated.

* Update header guards for new paths

Author: stuartmorgan

example/linux/Makefile

@@ -37,7 +37,7 @@ ALL_LIBS=$(FLUTTER_EMBEDDER_LIB) $(FLUTTER_ENGINE_LIB) $(PLUGIN_LIBS)
 # Headers
 PLUGIN_DIRS=$(patsubst %,$(PLUGINS_DIR)/%/linux,$(PLUGIN_NAMES))
 LIBRARY_DIRS=$(FLUTTER_EMBEDDER_LIB_DIR) $(PLUGIN_DIRS)
-INCLUDE_DIRS=$(patsubst %,%/include,$(LIBRARY_DIRS))
+INCLUDE_DIRS=$(patsubst %,%/include,$(LIBRARY_DIRS)) $(PROJECT_ROOT)/library/include
 
 # Tools
 BUILD_ASSETS_BIN=$(TOOLS_DIR)/build_flutter_assets
@@ -85,6 +85,9 @@ endif
 CXX=g++ -std=c++14
 CXXFLAGS=-Wall -Werror $(shell pkg-config --cflags jsoncpp)
 CPPFLAGS=$(patsubst %,-I%,$(INCLUDE_DIRS))
+ifdef USE_GN
+CPPFLAGS+=-DUSE_FLATTENED_INCLUDES
+endif
 LDFLAGS=-L$(OUT_LIB_DIR) \
 	-lglfw \
 	$(shell pkg-config --libs jsoncpp) \

example/linux/flutter_embedder_example.cc

@@ -21,9 +21,14 @@
 
 #include <color_panel/color_panel_plugin.h>
 #include <file_chooser/file_chooser_plugin.h>
-#include <flutter_desktop_embedding/embedder.h>
 #include <menubar/menubar_plugin.h>
 
+#ifdef USE_FLATTENED_INCLUDES
+#include <flutter_desktop_embedding/embedder.h>
+#else
+#include <flutter_desktop_embedding/linux/embedder.h>
+#endif
+
 namespace {
 
 // Returns the path of the directory containing this executable, or an empty

library/BUILD.gn

@@ -19,40 +19,51 @@ import("//library/engine.gni")
 published_shared_library("flutter_embedder") {
   if (is_linux) {
     sources = [
-      "linux/src/internal/engine_method_result.cc",
-      "linux/src/internal/engine_method_result.h",
-      "linux/src/internal/json_message_codec.cc",
-      "linux/src/internal/json_message_codec.h",
-      "linux/src/internal/key_event_handler.cc",
-      "linux/src/internal/key_event_handler.h",
-      "linux/src/internal/keyboard_hook_handler.h",
-      "linux/src/internal/plugin_handler.cc",
-      "linux/src/internal/plugin_handler.h",
-      "linux/src/internal/text_input_model.cc",
-      "linux/src/internal/text_input_model.h",
-      "linux/src/internal/text_input_plugin.cc",
-      "linux/src/internal/text_input_plugin.h",
       "linux/src/embedder.cc",
-      "linux/src/json_method_call.cc",
-      "linux/src/json_method_codec.cc",
-      "linux/src/json_plugin.cc",
-      "linux/src/method_call.cc",
-      "linux/src/method_channel.cc",
-      "linux/src/method_codec.cc",
-      "linux/src/method_result.cc",
-      "linux/src/plugin.cc",
     ]
     public = [
-      "linux/include/flutter_desktop_embedding/binary_messenger.h",
-      "linux/include/flutter_desktop_embedding/embedder.h",
-      "linux/include/flutter_desktop_embedding/json_method_call.h",
-      "linux/include/flutter_desktop_embedding/json_method_codec.h",
-      "linux/include/flutter_desktop_embedding/json_plugin.h",
-      "linux/include/flutter_desktop_embedding/method_call.h",
-      "linux/include/flutter_desktop_embedding/method_channel.h",
-      "linux/include/flutter_desktop_embedding/method_codec.h",
-      "linux/include/flutter_desktop_embedding/method_result.h",
-      "linux/include/flutter_desktop_embedding/plugin.h",
+      "include/flutter_desktop_embedding/linux/embedder.h",
+    ]
+  }
+  if (is_linux || is_win) {
+    sources += [
+      "common/internal/engine_method_result.cc",
+      "common/internal/engine_method_result.h",
+      "common/internal/json_message_codec.cc",
+      "common/internal/json_message_codec.h",
+      "common/internal/plugin_handler.cc",
+      "common/internal/plugin_handler.h",
+      "common/internal/text_input_model.cc",
+      "common/internal/text_input_model.h",
+      "common/json_method_call.cc",
+      "common/json_method_codec.cc",
+      "common/json_plugin.cc",
+      "common/method_call.cc",
+      "common/method_channel.cc",
+      "common/method_codec.cc",
+      "common/method_result.cc",
+      "common/plugin.cc",
+    ]
+    public += [
+      "include/flutter_desktop_embedding/binary_messenger.h",
+      "include/flutter_desktop_embedding/json_method_call.h",
+      "include/flutter_desktop_embedding/json_method_codec.h",
+      "include/flutter_desktop_embedding/json_plugin.h",
+      "include/flutter_desktop_embedding/method_call.h",
+      "include/flutter_desktop_embedding/method_channel.h",
+      "include/flutter_desktop_embedding/method_codec.h",
+      "include/flutter_desktop_embedding/method_result.h",
+      "include/flutter_desktop_embedding/plugin.h",
+    ]
+  }
+  # GLFW-specific code.
+  if (is_linux || is_win) {
+    sources += [
+      "common/glfw/key_event_handler.cc",
+      "common/glfw/key_event_handler.h",
+      "common/glfw/keyboard_hook_handler.h",
+      "common/glfw/text_input_plugin.cc",
+      "common/glfw/text_input_plugin.h",
     ]
   }
 

library/GN.md

@@ -24,7 +24,11 @@ $ tools/gn_dart gen out
 $ ninja -C out flutter_embedder
 ```
 
-The build results will be in the top-level `out/` directory.
+The build results will be in the top-level `out/` directory. `out/include/` will
+have the public headers for all build libraries, so you can point dependent
+builds at that single location rather than the `include/` directories in the
+source tree. You will need to set USE\_FLATTENED\_INCLUDES in your build, since
+the embedding header library layout is slightly different under `out/include/`.
 
 Subsequent builds only require the `ninja` step, as the build will automatically
 re-run GN generation if necessary.

library/linux/src/internal/key_event_handler.cc renamed to library/common/glfw/key_event_handler.cc

@@ -11,12 +11,12 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/key_event_handler.h"
+#include "library/common/glfw/key_event_handler.h"
 
 #include <json/json.h>
 #include <iostream>
 
-#include "library/linux/src/internal/json_message_codec.h"
+#include "library/common/internal/json_message_codec.h"
 
 static constexpr char kChannelName[] = "flutter/keyevent";
 

library/linux/src/internal/key_event_handler.h renamed to library/common/glfw/key_event_handler.h

@@ -11,11 +11,11 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_KEY_EVENT_HANDLER_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_kEY_EVENT_HANDLER_H_
+#ifndef LIBRARY_COMMON_GLFW_KEY_EVENT_HANDLER_H_
+#define LIBRARY_COMMON_GLFW_kEY_EVENT_HANDLER_H_
 
-#include "library/linux/include/flutter_desktop_embedding/binary_messenger.h"
-#include "library/linux/src/internal/keyboard_hook_handler.h"
+#include "library/common/glfw/keyboard_hook_handler.h"
+#include "library/include/flutter_desktop_embedding/binary_messenger.h"
 
 namespace flutter_desktop_embedding {
 
@@ -41,4 +41,4 @@ class KeyEventHandler : public KeyboardHookHandler {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_KEY_EVENT_HANDLER_H_
+#endif  // LIBRARY_COMMON_GLFW_KEY_EVENT_HANDLER_H_

library/linux/src/internal/keyboard_hook_handler.h renamed to library/common/glfw/keyboard_hook_handler.h

@@ -11,8 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_INPUT_KEYBOARD_HOOK_HANDLER_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_INPUT_KEYBOARD_HOOK_HANDLER_H_
+#ifndef LIBRARY_COMMON_GLFW_KEYBOARD_HOOK_HANDLER_H_
+#define LIBRARY_COMMON_GLFW_KEYBOARD_HOOK_HANDLER_H_
 
 #include <GLFW/glfw3.h>
 
@@ -31,4 +31,4 @@ class KeyboardHookHandler {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_INPUT_KEYBOARD_HOOK_HANDLER_H_
+#endif  // LIBRARY_COMMON_GLFW_KEYBOARD_HOOK_HANDLER_H_

library/linux/src/internal/text_input_plugin.cc renamed to library/common/glfw/text_input_plugin.cc

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/text_input_plugin.h"
+#include "library/common/glfw/text_input_plugin.h"
 
 #include <cstdint>
 #include <iostream>

library/linux/src/internal/text_input_plugin.h renamed to library/common/glfw/text_input_plugin.h

@@ -11,15 +11,15 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_PLUGIN_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_PLUGIN_H_
+#ifndef LIBRARY_COMMON_GLFW_TEXT_INPUT_PLUGIN_H_
+#define LIBRARY_COMMON_GLFW_TEXT_INPUT_PLUGIN_H_
 
 #include <map>
 #include <memory>
 
-#include "library/linux/include/flutter_desktop_embedding/json_plugin.h"
-#include "library/linux/src/internal/keyboard_hook_handler.h"
-#include "library/linux/src/internal/text_input_model.h"
+#include "library/common/glfw/keyboard_hook_handler.h"
+#include "library/common/internal/text_input_model.h"
+#include "library/include/flutter_desktop_embedding/json_plugin.h"
 
 namespace flutter_desktop_embedding {
 
@@ -58,4 +58,4 @@ class TextInputPlugin : public KeyboardHookHandler, public JsonPlugin {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_PLUGIN_H_
+#endif  // LIBRARY_COMMON_GLFW_TEXT_INPUT_PLUGIN_H_

library/linux/src/internal/engine_method_result.cc renamed to library/common/internal/engine_method_result.cc

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/engine_method_result.h"
+#include "library/common/internal/engine_method_result.h"
 
 #include <iostream>
 

library/linux/src/internal/engine_method_result.h renamed to library/common/internal/engine_method_result.h

@@ -11,15 +11,15 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_ENGINE_METHOD_RESULT_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_ENGINE_METHOD_RESULT_H_
+#ifndef LIBRARY_COMMON_INTERNAL_ENGINE_METHOD_RESULT_H_
+#define LIBRARY_COMMON_INTERNAL_ENGINE_METHOD_RESULT_H_
 
 #include <string>
 #include <vector>
 
-#include "library/linux/include/flutter_desktop_embedding/binary_messenger.h"
-#include "library/linux/include/flutter_desktop_embedding/method_codec.h"
-#include "library/linux/include/flutter_desktop_embedding/method_result.h"
+#include "library/include/flutter_desktop_embedding/binary_messenger.h"
+#include "library/include/flutter_desktop_embedding/method_codec.h"
+#include "library/include/flutter_desktop_embedding/method_result.h"
 
 namespace flutter_desktop_embedding {
 
@@ -54,4 +54,4 @@ class EngineMethodResult : public MethodResult {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_ENGINE_METHOD_RESULT_H_
+#endif  // LIBRARY_COMMON_INTERNAL_ENGINE_METHOD_RESULT_H_

library/linux/src/internal/json_message_codec.cc renamed to library/common/internal/json_message_codec.cc

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/json_message_codec.h"
+#include "library/common/internal/json_message_codec.h"
 
 #include <iostream>
 #include <string>

library/linux/src/internal/json_message_codec.h renamed to library/common/internal/json_message_codec.h

@@ -11,8 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_INCLUDE_FLUTTER_DESKTOP_EMBEDDING_JSON_MESSAGE_CODEC_H_
-#define LIBRARY_LINUX_INCLUDE_FLUTTER_DESKTOP_EMBEDDING_JSON_MESSAGE_CODEC_H_
+#ifndef LIBRARY_COMMON_INTERNAL_JSON_MESSAGE_CODEC_H_
+#define LIBRARY_COMMON_INTERNAL_JSON_MESSAGE_CODEC_H_
 
 #include <memory>
 #include <vector>
@@ -56,4 +56,4 @@ class JsonMessageCodec {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_INCLUDE_FLUTTER_DESKTOP_EMBEDDING_JSON_MESSAGE_CODEC_H_
+#endif  // LIBRARY_COMMON_INTERNAL_JSON_MESSAGE_CODEC_H_

library/linux/src/internal/plugin_handler.cc renamed to library/common/internal/plugin_handler.cc

@@ -11,10 +11,10 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/plugin_handler.h"
+#include "library/common/internal/plugin_handler.h"
 
-#include "library/linux/include/flutter_desktop_embedding/method_channel.h"
-#include "library/linux/src/internal/engine_method_result.h"
+#include "library/common/internal/engine_method_result.h"
+#include "library/include/flutter_desktop_embedding/method_channel.h"
 
 #include <iostream>
 
@@ -81,10 +81,10 @@ void PluginHandler::HandleMethodCallMessage(
 void PluginHandler::Send(const std::string &channel, const uint8_t *message,
                          const size_t message_size) const {
   FlutterPlatformMessage platform_message = {
-      .struct_size = sizeof(FlutterPlatformMessage),
-      .channel = channel.c_str(),
-      .message = message,
-      .message_size = message_size,
+      sizeof(FlutterPlatformMessage),
+      channel.c_str(),
+      message,
+      message_size,
   };
   FlutterEngineSendPlatformMessage(engine_, &platform_message);
 }

library/linux/src/internal/plugin_handler.h renamed to library/common/internal/plugin_handler.h

@@ -11,17 +11,17 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_PLUGIN_HANDLER_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_PLUGIN_HANDLER_H_
+#ifndef LIBRARY_COMMON_INTERNAL_PLUGIN_HANDLER_H_
+#define LIBRARY_COMMON_INTERNAL_PLUGIN_HANDLER_H_
 
 #include <map>
 #include <memory>
 #include <string>
 
 #include <flutter_embedder.h>
 
-#include "library/linux/include/flutter_desktop_embedding/binary_messenger.h"
-#include "library/linux/include/flutter_desktop_embedding/plugin.h"
+#include "library/include/flutter_desktop_embedding/binary_messenger.h"
+#include "library/include/flutter_desktop_embedding/plugin.h"
 
 namespace flutter_desktop_embedding {
 
@@ -74,4 +74,4 @@ class PluginHandler : public BinaryMessenger {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_PLUGIN_HANDLER_H_
+#endif  // LIBRARY_COMMON_INTERNAL_PLUGIN_HANDLER_H_

library/linux/src/internal/text_input_model.cc renamed to library/common/internal/text_input_model.cc

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/src/internal/text_input_model.h"
+#include "library/common/internal/text_input_model.h"
 
 #include <iostream>
 

library/linux/src/internal/text_input_model.h renamed to library/common/internal/text_input_model.h

@@ -11,8 +11,8 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#ifndef LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_MODEL_H_
-#define LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_MODEL_H_
+#ifndef LIBRARY_COMMON_INTERNAL_TEXT_INPUT_MODEL_H_
+#define LIBRARY_COMMON_INTERNAL_TEXT_INPUT_MODEL_H_
 
 #include <string>
 
@@ -95,4 +95,4 @@ class TextInputModel {
 
 }  // namespace flutter_desktop_embedding
 
-#endif  // LIBRARY_LINUX_SRC_INTERNAL_TEXT_INPUT_MODEL_H_
+#endif  // LIBRARY_COMMON_INTERNAL_TEXT_INPUT_MODEL_H_

library/linux/src/json_method_call.cc renamed to library/common/json_method_call.cc

@@ -11,7 +11,7 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/include/flutter_desktop_embedding/json_method_call.h"
+#include "library/include/flutter_desktop_embedding/json_method_call.h"
 
 namespace flutter_desktop_embedding {
 

library/linux/src/json_method_codec.cc renamed to library/common/json_method_codec.cc

@@ -11,10 +11,10 @@
 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 // See the License for the specific language governing permissions and
 // limitations under the License.
-#include "library/linux/include/flutter_desktop_embedding/json_method_codec.h"
+#include "library/include/flutter_desktop_embedding/json_method_codec.h"
 
-#include "library/linux/include/flutter_desktop_embedding/json_method_call.h"
-#include "library/linux/src/internal/json_message_codec.h"
+#include "library/common/internal/json_message_codec.h"
+#include "library/include/flutter_desktop_embedding/json_method_call.h"
 
 namespace flutter_desktop_embedding {