feat: implement wrappers for GUI APIs

crates/Cargo.toml

@@ -18,12 +18,18 @@ repository = "https://github.com/dcoles/flipperzero-rs"
 readme = "../README.md"
 license = "MIT"
 
+[workspace.metadata.docs.rs]
+default-target = "thumbv7em-none-eabihf"
+targets = []
+all-features = true
+
 [workspace.dependencies]
 flipperzero-sys = { path = "sys", version = "0.10.0" }
 flipperzero-rt = { path = "rt", version = "0.10.0" }
 flipperzero-alloc = { path = "alloc", version = "0.10.0" }
 flipperzero-test = { path = "test", version = "0.10.0" }
 ufmt = "0.2.0"
+document-features = { version = "0.2.0" }
 
 [profile.dev]
 opt-level = "z"

crates/alloc/Cargo.toml

@@ -12,11 +12,6 @@ autoexamples = false
 autotests = false
 autobenches = false
 
-[package.metadata.docs.rs]
-default-target = "thumbv7em-none-eabihf"
-targets = []
-all-features = true
-
 [lib]
 bench = false
 test = false

crates/alloc/src/lib.rs

@@ -6,6 +6,10 @@
 use core::alloc::{GlobalAlloc, Layout};
 use core::ffi::c_void;
 
+extern crate alloc;
+// re-export all items from `alloc` so that the API user can only extern this crate
+pub use alloc::*;
+
 use flipperzero_sys as sys;
 
 pub struct FuriAlloc;

crates/build-examples.py

@@ -10,7 +10,7 @@
 PYTHON = 'python'
 TOOLS_PATH = '../tools'
 INSTALL_PATH = PurePosixPath('/ext/apps/Examples')
-EXAMPLES = ["dialog", "example_images", "gpio", "gui", "hello-rust", "notification", "storage"]
+EXAMPLES = ["dialog", "images", "gpio", "gui", "hello-rust", "notification", "storage"]
 
 
 def parse_args():
@@ -27,15 +27,22 @@ def main():
 
     for example in EXAMPLES:
         logging.info('Building %s', example)
-        run(['cargo', 'build', '--package', 'flipperzero', '--example', example, '--all-features', '--release'], check=True)
+        run(
+            ['cargo', 'build', '--package', 'flipperzero', '--example', example, '--all-features', '--release'],
+            check=True
+        )
 
         if args.install:
             # Assume that the binary has the name as the 
             binary = Path.cwd() / 'target' / 'thumbv7em-none-eabihf' / 'release' / 'examples' / example
             target = INSTALL_PATH / f'{example}.fap'
 
             logging.info('Copying %s to %s', binary, target)
-            run(['cargo', 'run', '--release', '--bin', 'storage', '--', 'send', os.fspath(binary), os.fspath(target)], cwd=TOOLS_PATH, check=True)
+            run(
+                ['cargo', 'run', '--release', '--bin', 'storage', '--', 'send', os.fspath(binary), os.fspath(target)],
+                cwd=TOOLS_PATH,
+                check=True
+            )
 
 
 if __name__ == '__main__':

crates/flipperzero/Cargo.toml

@@ -8,14 +8,8 @@ license.workspace = true
 edition.workspace = true
 rust-version.workspace = true
 autobins = false
-autotests = false
 autobenches = false
 
-[package.metadata.docs.rs]
-default-target = "thumbv7em-none-eabihf"
-targets = []
-all-features = true
-
 [lib]
 bench = false
 harness = false
@@ -35,6 +29,9 @@ lock_api = "0.4"
 digest = "0.10"
 bitflags = "1.0"
 
+# Docs
+document-features = { workspace = true, optional = true }
+
 [dev-dependencies]
 flipperzero-alloc.workspace = true
 flipperzero-rt.workspace = true
@@ -45,20 +42,101 @@ md-5 = { version = "0.10", default-features = false }
 sha2 = { version = "0.10", default-features = false }
 
 [features]
-# enables features requiring an allocator
+
+## Default features.
+default = []
+
+## Enables features requiring an allocator.
+##
+## This will require you to set up an allocator such as by the following:
+##
+## ```
+## extern crate flipperzero_alloc as alloc;
+## ```
+##
+## Note that the `as alloc` part is optional but is helpful
+## if you want to reference items from `alloc` crate all of which are re-exported by `flipperzero_alloc`
+## such as `alloc::string::ToString` instead of `flipperzero_alloc::string::ToString`.
 alloc = []
 
+#! ## Service features.
+#!
+#! These enables specific Flipper Service APIs.
+
+## enables all Service APIs
+all-services = [
+    "service-storage",
+    "service-notification",
+    "service-input",
+    "service-toolbox",
+    "service-gui",
+    "service-dialogs",
+    "service-dolphin",
+]
+## Enables Storage Service APIs.
+service-storage = []
+## Enables Notification Service APIs.
+service-notification = []
+## Enables Input Service APIs.
+service-input = []
+## Enables Toolbox APIs.
+service-toolbox = []
+## Enables GUI APIs of Flipper.
+service-gui = ["alloc", "service-input"]
+## Enables Dialogs APIs of Flipper.
+service-dialogs = ["service-gui"]
+## Enables Dolphin APIs of Flipper.
+service-dolphin = []
+
+#! ## Unstable features
+#!
+#! This features are unstable and are yet a subject to drastic changes.
+#! They may provide experimental APIs, nightly-only features and optimizations etc.
+
+## Enables unstable Rust intrinsics. This requires `nightly` compiler version.
+unstable_intrinsics = []
+## Enables unstable Rust lints on types provided by this crate.
+## This requires `nightly` compiler version.
+unstable_lints = []
+
+# Internal features.
+
+# Enables unstable documentation features.
+# This is only intended to be used by `cargo doc`.
+unstable_docs = []
+
 [[test]]
 name = "dolphin"
+required-features = ["service-dolphin"]
 harness = false
 
 [[test]]
 name = "string"
 harness = false
 
+[[example]]
+name = "storage"
+required-features = ["service-storage"]
+
+[[example]]
+name = "notification"
+required-features = ["service-notification"]
+
+[[example]]
+name = "gui"
+required-features = ["service-gui"]
+
+[[example]]
+name = "images"
+required-features = ["service-gui"]
+
+[[example]]
+name = "view_dispatcher"
+required-features = ["service-gui"]
+
 [[example]]
 name = "dialog"
-required-features = ["alloc"]
+required-features = ["service-dialogs", "service-input"]
 
 [[example]]
 name = "threads"