Add log apis and example log.

jmjoy · jmjoy · commit 00caa8e2356d · 2021-04-25T13:47:29.000+08:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -9,5 +9,6 @@ members = [
 
     # internal
     "examples/hello",
+    "examples/log",
 #    "examples/mini-curl",
 ]
diff --git a/examples/hello/LICENSE b/examples/hello/LICENSE
@@ -0,0 +1 @@
+../../LICENSE
diff --git a/examples/log/Cargo.toml b/examples/log/Cargo.toml
@@ -0,0 +1,21 @@
+[package]
+name = "log"
+version = "0.0.0"
+authors = ["jmjoy <918734043@qq.com>"]
+edition = "2018"
+publish = false
+license = "Unlicense"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+phper = { version = "0.2.0-alpha.2", path = "../../phper" }
+
+[dev-dependencies]
+phper-test = { version = "0.2.0-alpha.2", path = "../../phper-test" }
+
+[build-dependencies]
+phper-build = { version = "0.2.0-alpha.2", path = "../../phper-build" }
diff --git a/examples/log/LICENSE b/examples/log/LICENSE
@@ -0,0 +1 @@
+../../LICENSE
diff --git a/examples/log/README.md b/examples/log/README.md
@@ -0,0 +1,28 @@
+# hello
+
+Log example.
+
+## Environment
+
+```bash
+# Specify if php isn't installed globally.
+export PHP_CONFIG = <Your path of php-config>
+```
+
+## Build
+
+```bash
+cargo build --release
+```
+
+## Test
+
+```bash
+cargo test --release
+```
+
+## Install
+
+```bash
+cargo run --release -- install
+```
diff --git a/examples/log/src/lib.rs b/examples/log/src/lib.rs
@@ -0,0 +1,48 @@
+use phper::{
+    deprecated, error, functions::Argument, modules::Module, notice, php_get_module, values::Val,
+    warning,
+};
+
+#[php_get_module]
+pub fn get_module(module: &mut Module) {
+    // set module metadata
+    module.set_name(env!("CARGO_PKG_NAME"));
+    module.set_version(env!("CARGO_PKG_VERSION"));
+    module.set_author(env!("CARGO_PKG_AUTHORS"));
+
+    module.add_function(
+        "log_notice",
+        |params: &mut [Val]| {
+            let message = params[0].as_string();
+            notice!("Something happened: {}", message);
+        },
+        vec![Argument::by_val("message")],
+    );
+
+    module.add_function(
+        "log_warning",
+        |params: &mut [Val]| {
+            let message = params[0].as_string();
+            warning!("Something warning: {}", message);
+        },
+        vec![Argument::by_val("message")],
+    );
+
+    module.add_function(
+        "log_error",
+        |params: &mut [Val]| {
+            let message = params[0].as_string();
+            error!("Something gone failed: {}", message);
+        },
+        vec![Argument::by_val("message")],
+    );
+
+    module.add_function(
+        "log_deprecated",
+        |params: &mut [Val]| {
+            let message = params[0].as_string();
+            deprecated!("Something deprecated: {}", message);
+        },
+        vec![Argument::by_val("message")],
+    );
+}
diff --git a/examples/log/src/main.rs b/examples/log/src/main.rs
@@ -0,0 +1,5 @@
+use phper::cmd::make;
+
+fn main() {
+    make();
+}
diff --git a/examples/log/tests/integration.rs b/examples/log/tests/integration.rs
@@ -0,0 +1,60 @@
+use phper_test::test_php_scripts_with_condition;
+use std::{env, path::Path, str};
+
+#[test]
+fn test_php() {
+    test_php_scripts_with_condition(
+        env!("CARGO_BIN_EXE_log"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test_php_notice.php")],
+        |output| {
+            let stdout = str::from_utf8(&output.stdout).unwrap();
+            stdout.contains("Notice:")
+                && stdout.contains("Something happened: just for test")
+                && output.status.success()
+        },
+    );
+
+    test_php_scripts_with_condition(
+        env!("CARGO_BIN_EXE_log"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test_php_warning.php")],
+        |output| {
+            let stdout = str::from_utf8(&output.stdout).unwrap();
+            stdout.contains("Warning:")
+                && stdout.contains("Something warning: just for test")
+                && output.status.success()
+        },
+    );
+
+    test_php_scripts_with_condition(
+        env!("CARGO_BIN_EXE_log"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test_php_error.php")],
+        |output| {
+            let stdout = str::from_utf8(&output.stdout).unwrap();
+            stdout.contains("Fatal error:")
+                && stdout.contains("Something gone failed: just for test")
+        },
+    );
+
+    test_php_scripts_with_condition(
+        env!("CARGO_BIN_EXE_log"),
+        &[Path::new(env!("CARGO_MANIFEST_DIR"))
+            .join("tests")
+            .join("php")
+            .join("test_php_deprecated.php")],
+        |output| {
+            let stdout = str::from_utf8(&output.stdout).unwrap();
+            stdout.contains("Deprecated:")
+                && stdout.contains("Something deprecated: just for test")
+                && output.status.success()
+        },
+    );
+}
diff --git a/examples/log/tests/php/test_php_deprecated.php b/examples/log/tests/php/test_php_deprecated.php
@@ -0,0 +1,7 @@
+<?php
+
+ini_set("display_errors", "On");
+ini_set("display_startup_errors", "On");
+error_reporting(E_ALL);
+
+log_deprecated("just for test");
diff --git a/examples/log/tests/php/test_php_error.php b/examples/log/tests/php/test_php_error.php
@@ -0,0 +1,7 @@
+<?php
+
+ini_set("display_errors", "On");
+ini_set("display_startup_errors", "On");
+error_reporting(E_ALL);
+
+log_error("just for test");
diff --git a/examples/log/tests/php/test_php_notice.php b/examples/log/tests/php/test_php_notice.php
@@ -0,0 +1,7 @@
+<?php
+
+ini_set("display_errors", "On");
+ini_set("display_startup_errors", "On");
+error_reporting(E_ALL);
+
+log_notice("just for test");
diff --git a/examples/log/tests/php/test_php_warning.php b/examples/log/tests/php/test_php_warning.php
@@ -0,0 +1,7 @@
+<?php
+
+ini_set("display_errors", "On");
+ini_set("display_startup_errors", "On");
+error_reporting(E_ALL);
+
+log_warning("just for test");
diff --git a/phper-macros/src/lib.rs b/phper-macros/src/lib.rs
@@ -1,5 +1,6 @@
 mod alloc;
 mod inner;
+mod log;
 mod utils;
 
 use proc_macro::TokenStream;
diff --git a/phper-macros/src/log.rs b/phper-macros/src/log.rs
@@ -0,0 +1 @@
+
diff --git a/phper-macros/tests/integration.rs b/phper-macros/tests/integration.rs
@@ -1,4 +1,4 @@
-use phper_macros::{c_str, c_str_ptr};
+use phper_macros::*;
 use std::ffi::CStr;
 
 #[test]
diff --git a/phper-test/src/lib.rs b/phper-test/src/lib.rs
@@ -6,11 +6,19 @@ use std::{
     fs::read_to_string,
     io::Write,
     path::{Path, PathBuf},
-    process::Command,
+    process::{Command, Output},
 };
 use tempfile::NamedTempFile;
 
 pub fn test_php_scripts(exe_path: impl AsRef<Path>, scripts: &[impl AsRef<Path>]) {
+    test_php_scripts_with_condition(exe_path, scripts, |output| output.status.success());
+}
+
+pub fn test_php_scripts_with_condition(
+    exe_path: impl AsRef<Path>,
+    scripts: &[impl AsRef<Path>],
+    condition: impl Fn(Output) -> bool,
+) {
     let context = php_context();
 
     let lib_path = get_lib_path(exe_path);
@@ -38,12 +46,12 @@ pub fn test_php_scripts(exe_path: impl AsRef<Path>, scripts: &[impl AsRef<Path>]
         let output = cmd.output().unwrap();
         let path = script.to_str().unwrap();
 
-        let mut stdout = String::from_utf8(output.stdout).unwrap();
+        let mut stdout = String::from_utf8(output.stdout.clone()).unwrap();
         if stdout.is_empty() {
             stdout.push_str("<empty>");
         }
 
-        let mut stderr = String::from_utf8(output.stderr).unwrap();
+        let mut stderr = String::from_utf8(output.stderr.clone()).unwrap();
         if stderr.is_empty() {
             stderr.push_str("<empty>");
         }
@@ -55,7 +63,7 @@ pub fn test_php_scripts(exe_path: impl AsRef<Path>, scripts: &[impl AsRef<Path>]
             stdout,
             stderr,
         );
-        if !output.status.success() {
+        if !condition(output) {
             panic!("test php file `{}` failed", path);
         }
     }
diff --git a/phper/src/lib.rs b/phper/src/lib.rs
@@ -122,6 +122,9 @@ See [examples](https://github.com/jmjoy/phper/tree/master/examples).
 [Unlicense](https://github.com/jmjoy/phper/blob/master/LICENSE).
 */
 
+#[macro_use]
+mod macros;
+
 pub mod arrays;
 pub mod classes;
 pub mod cmd;
diff --git a/phper/src/logs.rs b/phper/src/logs.rs
@@ -1,9 +1,23 @@
-use crate::sys::{E_ERROR, E_NOTICE, E_WARNING};
+use crate::{sys::*, utils::ensure_end_with_zero};
+use std::ptr::null;
 
 #[repr(u32)]
 #[derive(Copy, Clone, PartialEq)]
 pub enum Level {
     Error = E_ERROR,
     Warning = E_WARNING,
     Notice = E_NOTICE,
+    Deprecated = E_DEPRECATED,
+}
+
+pub fn log(level: Level, message: impl ToString) {
+    let message = ensure_end_with_zero(message);
+    unsafe {
+        php_error_docref1(
+            null(),
+            "\0".as_ptr().cast(),
+            level as i32,
+            message.as_ptr().cast(),
+        );
+    }
 }
diff --git a/phper/src/macros.rs b/phper/src/macros.rs
@@ -0,0 +1,27 @@
+#[macro_export]
+macro_rules! error {
+    ($($arg:tt)*) => ({
+        phper::logs::log(phper::logs::Level::Error, std::format!($($arg)*))
+    })
+}
+
+#[macro_export]
+macro_rules! warning {
+    ($($arg:tt)*) => ({
+        phper::logs::log(phper::logs::Level::Warning, std::format!($($arg)*))
+    })
+}
+
+#[macro_export]
+macro_rules! notice {
+    ($($arg:tt)*) => ({
+        phper::logs::log(phper::logs::Level::Notice, std::format!($($arg)*))
+    })
+}
+
+#[macro_export]
+macro_rules! deprecated {
+    ($($arg:tt)*) => ({
+        phper::logs::log(phper::logs::Level::Deprecated, std::format!($($arg)*))
+    })
+}
diff --git a/phper/src/utils.rs b/phper/src/utils.rs
@@ -1 +1,7 @@
-
+pub(crate) fn ensure_end_with_zero(s: impl ToString) -> String {
+    let mut s = s.to_string();
+    if !s.ends_with('\0') {
+        s.push('\0');
+    }
+    s
+}

Original file line number	Diff line number	Diff line change
`@@ -9,5 +9,6 @@ members = [`
`9`	`9`
`10`	`10`	`# internal`
`11`	`11`	`"examples/hello",`
	`12`	`+ "examples/log",`
`12`	`13`	`# "examples/mini-curl",`
`13`	`14`	`]`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +use phper::cmd::make;
++
 +fn main() {
 +    make();
 +}