Code specification (#3463)

* format , logger point

* classname toupper

* fix tests

* fix tests [2]

Author: matyhtf

.clang-format

@@ -1,7 +1,7 @@
 ---
 Language:        Cpp
 # BasedOnStyle:  Google
-AccessModifierOffset: -1
+AccessModifierOffset: -2
 AlignAfterOpenBracket: Align
 AlignConsecutiveAssignments: false
 AlignConsecutiveDeclarations: false
@@ -11,7 +11,7 @@ AlignTrailingComments: true
 AllowAllParametersOfDeclarationOnNextLine: true
 AllowShortBlocksOnASingleLine: false
 AllowShortCaseLabelsOnASingleLine: false
-AllowShortFunctionsOnASingleLine: Inline
+AllowShortFunctionsOnASingleLine: Empty
 AllowShortIfStatementsOnASingleLine: true
 AllowShortLoopsOnASingleLine: true
 AlwaysBreakAfterDefinitionReturnType: None

.editorconfig

@@ -0,0 +1,31 @@
+# https://editorconfig.org/
+
+root = true
+
+[*]
+trim_trailing_whitespace = true
+insert_final_newline     = true
+end_of_line              = lf
+charset                  = utf-8
+indent_style             = space
+tab_width                = 4
+
+[{*.{awk,sh},Makefile*}]
+indent_size              = 4
+indent_style             = table
+max_line_length          = 80
+
+[*.{c,cc,cpp,h,html,inc,php,phpt}]
+indent_size              = 4
+indent_style             = space
+max_line_length          = 120
+
+[*.md]
+indent_style             = space
+max_line_length          = 120
+
+[COMMIT_EDITMSG]
+indent_size              = 4
+indent_style             = space
+max_line_length          = 80
+

core-tests/src/core/log.cpp

@@ -7,17 +7,17 @@ using namespace swoole;
 const char *file = "/tmp/swoole_log_test.log";
 
 TEST(log, level) {
-    sw_logger().reset();
-    sw_logger().set_level(SW_LOG_NOTICE);
-    sw_logger().open(file);
+    sw_logger()->reset();
+    sw_logger()->set_level(SW_LOG_NOTICE);
+    sw_logger()->open(file);
 
-    sw_logger().put(SW_LOG_INFO, SW_STRL("hello info"));
-    sw_logger().put(SW_LOG_NOTICE, SW_STRL("hello notice"));
-    sw_logger().put(SW_LOG_WARNING, SW_STRL("hello warning"));
+    sw_logger()->put(SW_LOG_INFO, SW_STRL("hello info"));
+    sw_logger()->put(SW_LOG_NOTICE, SW_STRL("hello notice"));
+    sw_logger()->put(SW_LOG_WARNING, SW_STRL("hello warning"));
 
     swoole::String content(swoole_file_get_contents(file));
 
-    sw_logger().close();
+    sw_logger()->close();
     unlink(file);
 
     ASSERT_FALSE(swString_contains(content.get(), SW_STRL("hello info")));
@@ -26,14 +26,14 @@ TEST(log, level) {
 }
 
 TEST(log, date_format) {
-    sw_logger().reset();
-    sw_logger().set_date_format("day %d of %B in the year %Y. Time: %I:%S %p");
-    sw_logger().open(file);
+    sw_logger()->reset();
+    sw_logger()->set_date_format("day %d of %B in the year %Y. Time: %I:%S %p");
+    sw_logger()->open(file);
 
-    sw_logger().put(SW_LOG_WARNING, SW_STRL("hello world"));
+    sw_logger()->put(SW_LOG_WARNING, SW_STRL("hello world"));
     swoole::String content(swoole_file_get_contents(file));
 
-    sw_logger().close();
+    sw_logger()->close();
     unlink(file);
 
     int data[16];
@@ -55,48 +55,48 @@ TEST(log, date_format) {
 }
 
 TEST(log, date_format_long_string) {
-    sw_logger().reset();
-    sw_logger().set_level(SW_LOG_ERROR);
+    sw_logger()->reset();
+    sw_logger()->set_level(SW_LOG_ERROR);
     swoole::String content(swString_new(256));
     auto str = content.get();
 
     swString_repeat(str, "x", 1, 120);
     swString_append_ptr(str, SW_STRL("day %d of %B in the year %Y. Time: %I:%S %p"));
 
-    int retval = sw_logger().set_date_format(str->str);
+    int retval = sw_logger()->set_date_format(str->str);
 
     ASSERT_EQ(retval, SW_ERR);
     ASSERT_EQ(swoole_get_last_error(), SW_ERROR_INVALID_PARAMS);
 }
 
 TEST(log, date_with_microseconds) {
-    sw_logger().reset();
-    sw_logger().set_date_with_microseconds(true);
-    sw_logger().open(file);
+    sw_logger()->reset();
+    sw_logger()->set_date_with_microseconds(true);
+    sw_logger()->open(file);
 
-    sw_logger().put(SW_LOG_WARNING, SW_STRL("hello world"));
+    sw_logger()->put(SW_LOG_WARNING, SW_STRL("hello world"));
     swoole::String content(swoole_file_get_contents(file));
 
-    sw_logger().close();
+    sw_logger()->close();
     unlink(file);
 
     std::regex e("\\[\\S+\\s\\d{2}:\\d{2}:\\d{2}\\<\\.(\\d+)\\>\\s@\\d+\\.\\d+\\]\tWARNING\thello world");
     ASSERT_TRUE(std::regex_search(content.value(), e));
 }
 
 TEST(log, rotation) {
-    sw_logger().reset();
-    sw_logger().set_rotation(SW_LOG_ROTATION_DAILY);
-    sw_logger().open(file);
+    sw_logger()->reset();
+    sw_logger()->set_rotation(SW_LOG_ROTATION_DAILY);
+    sw_logger()->open(file);
 
-    sw_logger().put(SW_LOG_WARNING, SW_STRL("hello world"));
+    sw_logger()->put(SW_LOG_WARNING, SW_STRL("hello world"));
 
-    ASSERT_EQ(access(sw_logger().get_file(), R_OK), -1);
+    ASSERT_EQ(access(sw_logger()->get_file(), R_OK), -1);
     ASSERT_EQ(errno, ENOENT);
-    ASSERT_EQ(access(sw_logger().get_real_file(), R_OK), 0);
+    ASSERT_EQ(access(sw_logger()->get_real_file(), R_OK), 0);
 
-    sw_logger().close();
-    unlink(sw_logger().get_real_file());
+    sw_logger()->close();
+    unlink(sw_logger()->get_real_file());
 }
 
 TEST(log, redirect) {
@@ -106,20 +106,20 @@ TEST(log, redirect) {
         return;
     }
 
-    sw_logger().reset();
-    retval = sw_logger().open(file);
+    sw_logger()->reset();
+    retval = sw_logger()->open(file);
     ASSERT_EQ(retval, SW_OK);
 
-    retval = sw_logger().redirect_stdout_and_stderr(1);
+    retval = sw_logger()->redirect_stdout_and_stderr(1);
     ASSERT_EQ(retval, SW_OK);
     printf("hello world\n");
     swoole::String content(swoole_file_get_contents(file));
     ASSERT_NE(content.get(), nullptr);
 
-    sw_logger().close();
-    retval = sw_logger().redirect_stdout_and_stderr(0);
+    sw_logger()->close();
+    retval = sw_logger()->redirect_stdout_and_stderr(0);
     ASSERT_EQ(retval, SW_OK);
-    unlink(sw_logger().get_real_file());
+    unlink(sw_logger()->get_real_file());
 
     ASSERT_TRUE(swString_contains(content.get(), SW_STRL("hello world\n")));
 }

core-tests/src/memory/lru_cache.cpp

@@ -13,7 +13,7 @@ LRUCache cache(2);
 
 int dtor_num = 0;
 class lru_cache_test_class {
-   public:
+  public:
     lru_cache_test_class() {}
 
     ~lru_cache_test_class() { ++dtor_num; }

core-tests/src/memory/table.cpp

@@ -39,26 +39,26 @@ struct row_t {
 };
 
 class table_t {
-   private:
+  private:
     swTableColumn *column_id;
     swTableColumn *column_name;
     swTableColumn *column_score;
 
     swTable *table;
 
-   public:
+  public:
     table_t(uint32_t rows_size, float conflict_proportion = 0.2) {
         table = swTable_new(rows_size, conflict_proportion);
         if (swTable_create(table), 0) {
-            throw exception_t("alloc failed", SwooleG.error);
+            throw exception_t("alloc failed", swoole_get_last_error());
         }
 
         swTableColumn_add(table, "id", SW_TABLE_INT, 0);
         swTableColumn_add(table, "name", SW_TABLE_STRING, 32);
         swTableColumn_add(table, "score", SW_TABLE_FLOAT, 0);
 
         if (swTable_create(table) < 0) {
-            throw exception_t("create failed", SwooleG.error);
+            throw exception_t("create failed", swoole_get_last_error());
         }
         column_id = swTableColumn_get(table, std::string("id"));
         column_name = swTableColumn_get(table, std::string("name"));

core-tests/src/network/stream.cpp

@@ -27,8 +27,8 @@ TEST(stream, send) {
     swServer serv;
     serv.worker_num = 1;
     serv.factory_mode = SW_MODE_BASE;
-    int ori_log_level = sw_logger().get_level();
-    sw_logger().set_level(SW_LOG_ERROR);
+    int ori_log_level = sw_logger()->get_level();
+    sw_logger()->set_level(SW_LOG_ERROR);
 
     swListenPort *port = serv.add_port(SW_SOCK_TCP, TEST_HOST, TEST_PORT);
     if (!port) {
@@ -104,5 +104,5 @@ TEST(stream, send) {
     serv.start();
     t1.join();
 
-    sw_logger().set_level(ori_log_level);
+    sw_logger()->set_level(ori_log_level);
 }

core-tests/src/os/timer.cpp

@@ -31,18 +31,20 @@ TEST(timer, sys) {
 
     uint64_t ms1 = swoole::time<std::chrono::milliseconds>();
 
-    swoole_timer_add(20, 0, [](swTimer *, swTimer_node *) { timer1_count++; }, nullptr);
-
-    swoole_timer_add(100,
-                     1,
-                     [](swTimer *, swTimer_node *tnode) {
-                         timer2_count++;
-                         if (timer2_count == 5) {
-                             swoole_timer_del(tnode);
-                             timer_running = false;
-                         }
-                     },
-                     nullptr);
+    swoole_timer_add(
+        20, 0, [](swTimer *, swTimer_node *) { timer1_count++; }, nullptr);
+
+    swoole_timer_add(
+        100,
+        1,
+        [](swTimer *, swTimer_node *tnode) {
+            timer2_count++;
+            if (timer2_count == 5) {
+                swoole_timer_del(tnode);
+                timer_running = false;
+            }
+        },
+        nullptr);
 
     while (1) {
         sleep(10);

core-tests/src/server/buffer.cpp

@@ -30,7 +30,7 @@ TEST(server, send_buffer) {
     swServer serv(SW_MODE_BASE);
     serv.worker_num = 1;
 
-    sw_logger().set_level(SW_LOG_WARNING);
+    sw_logger()->set_level(SW_LOG_WARNING);
 
     swListenPort *port = serv.add_port(SW_SOCK_TCP, TEST_HOST, 0);
     if (!port) {

core-tests/src/server/http.cpp

@@ -35,7 +35,7 @@ static void test_run_server(function<void(swServer *)> fn) {
     serv.set_document_root(test::get_root_path());
     serv.add_static_handler_location("/examples");
 
-    sw_logger().set_level(SW_LOG_WARNING);
+    sw_logger()->set_level(SW_LOG_WARNING);
 
     swListenPort *port = serv.add_port(SW_SOCK_TCP, TEST_HOST, 0);
     if (!port) {

core-tests/src/server/server.cpp

@@ -54,7 +54,7 @@ TEST(server, base) {
     serv.worker_num = 1;
     serv.factory_mode = SW_MODE_BASE;
 
-    sw_logger().set_level(SW_LOG_WARNING);
+    sw_logger()->set_level(SW_LOG_WARNING);
 
     swListenPort *port = serv.add_port(SW_SOCK_TCP, TEST_HOST, 0);
     if (!port) {
@@ -106,7 +106,7 @@ TEST(server, process) {
 
     SwooleG.running = 1;
 
-    sw_logger().set_level(SW_LOG_WARNING);
+    sw_logger()->set_level(SW_LOG_WARNING);
 
     swLock *lock = (swLock *) SwooleG.memory_pool->alloc(SwooleG.memory_pool, sizeof(*lock));
     swMutex_create(lock, 1);

examples/cpp/test_server.cc

@@ -22,8 +22,8 @@ static int g_receive_count = 0;
 int main(int argc, char **argv) {
     swoole_init();
 
-    sw_logger().set_date_format("%F %T");
-    sw_logger().set_date_with_microseconds(true);
+    sw_logger()->set_date_format("%F %T");
+    sw_logger()->set_date_with_microseconds(true);
 
     swServer serv;
 

include/channel.h

@@ -31,7 +31,7 @@ enum Channel_flag {
 };
 
 class Channel {
-   private:
+  private:
     off_t head;
     off_t tail;
     size_t size;
@@ -52,7 +52,7 @@ class Channel {
     swLock lock;
     swPipe *notify_pipe;
 
-   public:
+  public:
     inline bool empty() { return num == 0; }
     inline bool full() { return ((head == tail && tail_tag != head_tag) || (bytes + sizeof(int) * num == size)); }
     int pop(void *out_buf, int buffer_length);
@@ -66,7 +66,7 @@ class Channel {
     void print();
     static Channel *make(size_t size, size_t maxlen, int flags);
 
-   private:
+  private:
     Channel();
     ~Channel();
 };

include/context.h

@@ -46,7 +46,7 @@ typedef void (*coroutine_func_t)(void *);
 
 namespace swoole {
 class Context {
-   public:
+  public:
     Context(size_t stack_size, coroutine_func_t fn, void *private_data);
     ~Context();
     bool swap_in();
@@ -57,7 +57,7 @@ class Context {
     inline bool is_end() { return end_; }
     static void context_func(void *arg);
 
-   protected:
+  protected:
     coroutine_func_t fn_;
 #ifdef SW_USE_THREAD_CONTEXT
     std::thread thread_;

include/coroutine.h

@@ -69,7 +69,7 @@ struct socket_poll_fd {
 };
 
 class Coroutine {
-   public:
+  public:
     void resume();
     void yield();
 
@@ -144,7 +144,7 @@ class Coroutine {
 
     static void print_list();
 
-   protected:
+  protected:
     static Coroutine *current;
     static long last_cid;
     static uint64_t peak_num;