[compile] Bazel compile , add compile.md (#382)

* feat(bazel-compile)
ChunelFeng · Jun 1, 2024 · decb62e · decb62e
1 parent 7fa2234
commit decb62e
Show file tree

Hide file tree

Showing 52 changed files with 68 additions and 75 deletions.
diff --git a/COMPILE.md b/COMPILE.md
@@ -38,3 +38,11 @@
   $ ./CGraph-build.sh                      # 编译CGraph工程，生成的内容在同级/build/文件夹中
   $ ./build/tutorial/T00-HelloCGraph       # 运行第一个实例程序，并且在终端输出 Hello, CGraph.
   ```
+
+* Bazel编译方式(Linux/MacOS/Windows)
+  ```shell
+  $ git clone https://github.com/ChunelFeng/CGraph.git
+  $ cd CGraph
+  $ bazel build //tutorial:T01-Simple -c dbg && bazel run //tutorial:T01-Simple  # 编译并运行tutorial路径下的T01-Simple（debug版本）
+  $ bazel build //tutorial/... -c opt      # 编译tutorial路径下的所有targets（release版本）
+  ```
diff --git a/README.md b/README.md
@@ -45,7 +45,7 @@
 
 #### MyNode.h
 ```cpp
-#include "../src/CGraph.h"
+#include "CGraph.h"
 
 class MyNode1 : public CGraph::GNode {
 public:

diff --git a/README_en.md b/README_en.md
@@ -67,7 +67,7 @@ You can transfer your params in many scenes. It is also possible to extend the f
 
 #### MyNode.h
 ```cpp
-#include "../src/CGraph.h"
+#include "CGraph.h"
 
 class MyNode1 : public CGraph::GNode {
 public:

diff --git a/cmake/CGraph-env-include.cmake b/cmake/CGraph-env-include.cmake
@@ -30,7 +30,6 @@ ELSEIF(WIN32)
     # 本工程也支持在windows平台上的mingw环境使用
 ENDIF()
 
-include_directories(${CGRAPH_PROJECT_ROOT_DIR})
 include_directories(${CGRAPH_PROJECT_ROOT_DIR}/src/)    # 直接加入"CGraph.h"文件对应的位置
 
 # 以下三选一，本地编译执行，推荐OBJECT方式

diff --git a/example/BUILD b/example/BUILD
@@ -1,40 +1,31 @@
-# NOET: test all the examples at a time
-test_suite(
-    name = "test_all_examples",
-    tests = [":E01-AutoPilot",":E02-MockGUI",":E03-ThirdFlow",":E04-MapReduce"],
-)
-
 # test-1: E01-AutoPilot
-cc_test (
+cc_binary (
     name = "E01-AutoPilot",
     srcs = ["E01-AutoPilot.cpp"],
+    copts = ["-Isrc/"],
     deps = ["//src:CGraph",],
 )
 
 # test-2: E02-MockGUI
-cc_test (
+cc_binary (
     name = "E02-MockGUI",
     srcs = ["E02-MockGUI.cpp"],
+    copts = ["-Isrc/"],
     deps = ["//src:CGraph",],
 )
 
 # test-3: E03-ThirdFlow
-cc_test (
+cc_binary (
     name = "E03-ThirdFlow",
     srcs = ["E03-ThirdFlow.cpp"],
+    copts = ["-Isrc/"],
     deps = ["//src:CGraph",],
 )
 
 # test-4: E04-MapReduce
-cc_test (
+cc_binary (
     name = "E04-MapReduce",
     srcs = ["E04-MapReduce.cpp"],
+    copts = ["-Isrc/"],
     deps = ["//src:CGraph",],
 )
-
-# import the CGraph.h from src dir
-# cc_import(
-#     name = "CGraph_h",
-#     hdrs = ["src/CGraph.h"],
-#     visibility = ["//visibility:public"],
-# )
diff --git a/example/E01-AutoPilot.cpp b/example/E01-AutoPilot.cpp
@@ -12,7 +12,7 @@
 #include <cstring>
 #include <memory>
 
-#include "src/CGraph.h"
+#include "CGraph.h"
 
 using namespace CGraph;
 

diff --git a/example/E02-MockGUI.cpp b/example/E02-MockGUI.cpp
@@ -12,7 +12,7 @@
 #include <cmath>
 #include <set>
 
-#include "src/CGraph.h"
+#include "CGraph.h"
 
 using namespace CGraph;
 

diff --git a/example/E03-ThirdFlow.cpp b/example/E03-ThirdFlow.cpp
@@ -9,7 +9,7 @@
 #include <cmath>
 #include <memory>
 
-#include "src/CGraph.h"
+#include "CGraph.h"
 
 using namespace CGraph;
 

diff --git a/example/E04-MapReduce.cpp b/example/E04-MapReduce.cpp
@@ -9,7 +9,7 @@
 #include <random>
 #include <vector>
 
-#include "src/CGraph.h"
+#include "CGraph.h"
 
 using namespace CGraph;
 

diff --git a/src/BUILD b/src/BUILD
@@ -4,10 +4,5 @@ cc_library(
     name = "CGraph",
     srcs = glob(["**/*.cpp"]),
     hdrs = glob(["**/*.h", "**/*.inl"]),
-    copts = [
-             "-D_CGRAPH_SILENCE",
-             "-D_ENABLE_LIKELY_",
-            ],
-    linkstatic = 0,
     visibility = ["//visibility:public"],
 )
diff --git a/test/Functional/BUILD b/test/Functional/BUILD
@@ -7,10 +7,10 @@ CGRAPH_FUNCTIONAL_LIST = [
         ]
 
 [
-    cc_test(
+    cc_binary(
         name = "%s" % fun_name,
         srcs = ["%s.cpp" % fun_name],
-
+        copts = ["-Isrc/"],
         deps = ["//src:CGraph",
                 "//test/_Materials:test_materials",],
     )

diff --git a/test/Performance/BUILD b/test/Performance/BUILD
@@ -5,9 +5,10 @@ CGRAPH_PERFORMANCE_LIST = [
         ]
 
 [
-    cc_test(
+    cc_binary(
         name = "%s" % perf_name,
         srcs = ["%s.cpp" % perf_name],
+        copts = ["-Isrc/"],
         deps = ["//src:CGraph",
                 "//test/_Materials:test_materials",],
     )

diff --git a/test/_Materials/BUILD b/test/_Materials/BUILD
@@ -1,6 +1,5 @@
 cc_library(
     name = "test_materials",
     hdrs = glob(["**/*.h"]),
-    linkstatic = 0,
     visibility = ["//visibility:public"],
 )
diff --git a/test/_Materials/TestCommonDefine.h b/test/_Materials/TestCommonDefine.h
@@ -11,7 +11,7 @@
 
 #include <atomic>
 
-#include "src/CGraph.h"
+#include "CGraph.h"
 
 std::atomic<unsigned int> g_test_node_cnt = {0};
 static const char* g_test_message_key = "test-message-key";

diff --git a/tutorial/BUILD b/tutorial/BUILD
@@ -1,14 +1,13 @@
 cc_library(
     name = "Tutorial_header",
-    hdrs = glob(["MyGAspect/**/*.h",
+    srcs = glob(["MyGAspect/**/*.h",
                 "MyGCondition/**/*.h",
                 "MyGDaemon/**/*.h",
                 "MyGEvent/**/*.h",
                 "MyGMutable/**/*.h",
                 "MyGNode/**/*.h",
                 "MyParams/**/*.h",
                 "MyUtils/**/*.h",]),
-    linkstatic = 0,
     visibility = ["//visibility:public"],
 )
 
@@ -43,10 +42,11 @@ CGRAPH_TUTORIAL_LIST = [
         ]
 
 [
-    cc_test(
+    cc_binary(
         name = "%s" % tutorial_name,
         srcs = ["%s.cpp" % tutorial_name],
-        deps = [":Tutorial_header","//src:CGraph",],
+        copts = ["-Isrc/"],
+        deps = [":Tutorial_header","//src:CGraph"],
     )
     for tutorial_name in CGRAPH_TUTORIAL_LIST
 ]
diff --git a/tutorial/MyGAspect/MyConnAspect.h b/tutorial/MyGAspect/MyConnAspect.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYCONNASPECT_H
 #define CGRAPH_MYCONNASPECT_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyConnParam.h"
 
 class MyConnAspect : public CGraph::GAspect {

diff --git a/tutorial/MyGAspect/MyPipelineParamAspect.h b/tutorial/MyGAspect/MyPipelineParamAspect.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYPIPELINEPARAMASPECT_H
 #define CGRAPH_MYPIPELINEPARAMASPECT_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyPipelineParamAspect : public CGraph::GAspect {

diff --git a/tutorial/MyGAspect/MyTemplateAspect.h b/tutorial/MyGAspect/MyTemplateAspect.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYTEMPLATEASPECT_H
 #define CGRAPH_MYTEMPLATEASPECT_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 template<class ...Args>
 class MyTemplateAspect : public CGraph::GTemplateAspect<Args...> {

diff --git a/tutorial/MyGAspect/MyTimerAspect.h b/tutorial/MyGAspect/MyTimerAspect.h
@@ -11,7 +11,7 @@
 
 #include <chrono>
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyTimerAspect : public CGraph::GAspect {
 public:

diff --git a/tutorial/MyGAspect/MyTraceAspect.h b/tutorial/MyGAspect/MyTraceAspect.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYTRACEASPECT_H
 #define CGRAPH_MYTRACEASPECT_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyTraceAspect : public CGraph::GAspect {
 public:

diff --git a/tutorial/MyGCondition/MyCondition.h b/tutorial/MyGCondition/MyCondition.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYCONDITION_H
 #define CGRAPH_MYCONDITION_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyCondition : public CGraph::GCondition {
 public:

diff --git a/tutorial/MyGCondition/MyParamCondition.h b/tutorial/MyGCondition/MyParamCondition.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYPARAMCONDITION_H
 #define CGRAPH_MYPARAMCONDITION_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyParamCondition : public CGraph::GCondition {

diff --git a/tutorial/MyGDaemon/MyMonitorDaemon.h b/tutorial/MyGDaemon/MyMonitorDaemon.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYMONITORDAEMON_H
 #define CGRAPH_MYMONITORDAEMON_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyMonitorDaemon : public CGraph::GDaemon {
 public:

diff --git a/tutorial/MyGDaemon/MyParamDaemon.h b/tutorial/MyGDaemon/MyParamDaemon.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYPARAMDAEMON_H
 #define CGRAPH_MYPARAMDAEMON_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 #include "../MyParams/MyConnParam.h"
 

diff --git a/tutorial/MyGDaemon/MyTemplateDaemon.h b/tutorial/MyGDaemon/MyTemplateDaemon.h
@@ -11,7 +11,7 @@
 
 #include <string>
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 template<class ...Args>
 class MyTemplateDaemon : public CGraph::GTemplateDaemon<Args...> {

diff --git a/tutorial/MyGEvent/MyPrintEvent.h b/tutorial/MyGEvent/MyPrintEvent.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYPRINTEVENT_H
 #define CGRAPH_MYPRINTEVENT_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyPrintEvent : public CGraph::GEvent {

diff --git a/tutorial/MyGMutable/MyMutable.h b/tutorial/MyGMutable/MyMutable.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYMUTABLE_H
 #define CGRAPH_MYMUTABLE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyMutable : public CGraph::GMutable {

diff --git a/tutorial/MyGNode/HelloCGraphNode.h b/tutorial/MyGNode/HelloCGraphNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_HELLOCGRAPHNODE_H
 #define CGRAPH_HELLOCGRAPHNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class HelloCGraphNode : public CGraph::GNode {
 public:

diff --git a/tutorial/MyGNode/MyEParamNode.h b/tutorial/MyGNode/MyEParamNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYEPARAMNODE_H
 #define CGRAPH_MYEPARAMNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyVersionParam.h"
 #include "../MyParams/MyConnParam.h"
 

diff --git a/tutorial/MyGNode/MyEventNode.h b/tutorial/MyGNode/MyEventNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYEVENTNODE_H
 #define CGRAPH_MYEVENTNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyEventNode : public CGraph::GNode {
 public:

diff --git a/tutorial/MyGNode/MyHoldNode.h b/tutorial/MyGNode/MyHoldNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYHOLDNODE_H
 #define CGRAPH_MYHOLDNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 static const char* HOLD_PARAM_NAME = "hold-param";

diff --git a/tutorial/MyGNode/MyMatchNode.h b/tutorial/MyGNode/MyMatchNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYMATCHNODE_H
 #define CGRAPH_MYMATCHNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyMatchNode : public CGraph::GNode {

diff --git a/tutorial/MyGNode/MyNode1.h b/tutorial/MyGNode/MyNode1.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYNODE1_H
 #define CGRAPH_MYNODE1_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyNode1 : public CGraph::GNode {
 public:

diff --git a/tutorial/MyGNode/MyNode2.h b/tutorial/MyGNode/MyNode2.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYNODE2_H
 #define CGRAPH_MYNODE2_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 
 class MyNode2 : public CGraph::GNode {
 public:

diff --git a/tutorial/MyGNode/MyPubMessageNode.h b/tutorial/MyGNode/MyPubMessageNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYPUBMESSAGENODE_H
 #define CGRAPH_MYPUBMESSAGENODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyMessageParam.h"
 
 class MyPubMessageNode : public CGraph::GNode {

diff --git a/tutorial/MyGNode/MyReadParamNode.h b/tutorial/MyGNode/MyReadParamNode.h
@@ -9,7 +9,7 @@
 #ifndef CGRAPH_MYREADPARAMNODE_H
 #define CGRAPH_MYREADPARAMNODE_H
 
-#include "../../src/CGraph.h"
+#include "CGraph.h"
 #include "../MyParams/MyParam.h"
 
 class MyReadParamNode : public CGraph::GNode {