Add sharp for layout decl to make it consistent

book/src/call_rust_from_cpp/layout_policy.md

@@ -18,7 +18,7 @@ using Zngur with explicit data layout annotations for unstable types is usually
 
 These are the layout policies Zngur currently supports:
 
-## `layout(size = X, align = Y)`
+## `#layout(size = X, align = Y)`
 
 This is the normal mode, which you should provide exact value of size and align for your type, which enables storing
 them by value in the stack of C++. This mode has the best performance, but it has problems mentioned above.
@@ -34,7 +34,7 @@ size and align, such as:
 - `[T; N]` where `T` has stable layout
 - primitives
 
-## `layout_conservative(size = X, align = Y)`
+## `#layout_conservative(size = X, align = Y)`
 
 {{#include ../unimplemented_begin.md}}1{{#include ../unimplemented_end.md}}
 

book/src/tutorial.md

@@ -58,7 +58,7 @@ Copy it into `src/lib.rs`. Now we need to declare things that we need to access
 
 ```
 type crate::Inventory {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
 
     fn new_empty(u32) -> crate::Inventory;
 }
@@ -96,7 +96,7 @@ To ensure that everything works, let's add a `#[derive(Debug)]` to `Inventory` a
 
 ```
 type crate::Inventory {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
     wellknown_traits(Debug);
 
     fn new_empty(u32) -> crate::Inventory;
@@ -144,11 +144,11 @@ impl Inventory {
 
 ```
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
 }
 
 type crate::Inventory {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
     wellknown_traits(Debug);
 
     fn new_empty(u32) -> crate::Inventory;
@@ -195,7 +195,7 @@ of that function:
 // ...
 
 type crate::Item {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
 }
 
 type crate::Inventory {
@@ -209,11 +209,11 @@ need to add the constructor for the `Item`:
 
 ```
 type ::std::string::String {
-    layout(size = 24, align = 8);
+    #layout(size = 24, align = 8);
 }
 
 type crate::Item {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
 
     constructor { name: ::std::string::String, size: u32 };
 }
@@ -231,7 +231,7 @@ type str {
 ```
 
 There are some new things here. First, since `str` is a primitive it doesn't need full path. Then there is `wellknown_traits(?Sized)` instead
-of `layout(size = X, align = Y)` which tells Zngur that this type is unsized and it should consider its references as fat and prevent storing it
+of `#layout(size = X, align = Y)` which tells Zngur that this type is unsized and it should consider its references as fat and prevent storing it
 by value.
 
 Now you may wonder how we can obtain a `&str` to make a `String` from it? Fortunately, Zngur has some special support for primitive types and it
@@ -290,7 +290,7 @@ impl Inventory {
 
 ```
 type ::std::vec::Vec<crate::Item> {
-    layout(size = 24, align = 8);
+    #layout(size = 24, align = 8);
     wellknown_traits(Debug);
 }
 

examples/cxx_demo/main.zng

@@ -1,5 +1,5 @@
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
@@ -19,13 +19,13 @@ type ::core::primitive::str {
 
 mod crate {
     type MultiBuf {
-        layout(size = 32, align = 8);
+        #layout(size = 32, align = 8);
 
         fn next_chunk(&mut self) -> &[u8];
     }
 
     type BlobMetadata {
-        layout(size = 32, align = 8);
+        #layout(size = 32, align = 8);
 
         fn default() -> BlobMetadata;  
         fn set_size(&mut self, usize);
@@ -39,7 +39,7 @@ mod crate {
     }
 
     type Box<dyn BlobStoreTrait> {
-        layout(size = 16, align = 8);
+        #layout(size = 16, align = 8);
     }
 }
 

examples/memory_management/main.zng

@@ -1,12 +1,12 @@
 #convert_panic_to_exception
 
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
 type bool {
-    layout(size = 1, align = 1);
+    #layout(size = 1, align = 1);
     wellknown_traits(Copy);
 }
 
@@ -16,13 +16,13 @@ type str {
 
 mod crate {
     type PrintOnDropPair {
-        layout(size = 32, align = 8);
+        #layout(size = 32, align = 8);
 
         constructor { first: PrintOnDrop, second: PrintOnDrop };
     }
 
     type PrintOnDrop {
-        layout(size = 16, align = 8);
+        #layout(size = 16, align = 8);
         constructor(&str);
 
         fn clone(&self) -> PrintOnDrop;
@@ -39,7 +39,7 @@ mod crate {
     }
 
     type Box<dyn PrintOnDropConsumer> {
-        layout(size = 16, align = 8);
+        #layout(size = 16, align = 8);
 
         fn deref_mut(&mut self) -> &mut dyn PrintOnDropConsumer use ::std::ops::DerefMut;
     }
@@ -55,15 +55,15 @@ mod crate {
 mod ::std {
     mod option {
         type Option<&crate::PrintOnDrop> {
-            layout(size = 8, align = 8);
+            #layout(size = 8, align = 8);
 
             fn unwrap(self) -> &crate::PrintOnDrop;
         }
     }
 
     mod vec {
         type Vec<crate::PrintOnDrop> {
-            layout(size = 24, align = 8);
+            #layout(size = 24, align = 8);
 
             fn new() -> Vec<crate::PrintOnDrop>;
             fn push(&mut self, crate::PrintOnDrop);

examples/osmium/main.zng

@@ -9,7 +9,7 @@
 "
 
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
@@ -21,21 +21,21 @@ type str {
 }
 
 type ::std::option::Option<&str> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 
     constructor None;
     constructor Some(&str);
 }
 
 type ::std::string::String {
-    layout(size = 24, align = 8);
+    #layout(size = 24, align = 8);
 
     fn new() -> ::std::string::String;
     fn push_str(&mut self, &str);
 }
 
 type crate::Reader {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 
     constructor(ZngurCppOpaqueOwnedObject);
 
@@ -59,13 +59,13 @@ type crate::Node {
 }
 
 type crate::BendHandler {
-    layout(size = 8, align = 8);
+    #layout(size = 8, align = 8);
 
     fn way(&mut self, &crate::Way) use crate::Handler;
 }
 
 type crate::Flags {
-    layout(size = 1, align = 1);
+    #layout(size = 1, align = 1);
 
     fn bits(&self) -> u8;
 }

examples/rayon/main.zng

@@ -1,39 +1,39 @@
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
 type bool {
-    layout(size = 1, align = 1);
+    #layout(size = 1, align = 1);
     wellknown_traits(Copy);
 }
 
 type ::std::option::Option<&u64> {
-    layout(size = 8, align = 8);
+    #layout(size = 8, align = 8);
     wellknown_traits(Debug, Copy);
 
     fn unwrap(self) -> &u64;
 }
 
 type Box<dyn Fn(&u64) -> bool + Sync + Send> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 }
 
 type ::rayon::iter::Filter<::rayon::iter::Copied<::rayon::slice::Iter<u64>>, Box<dyn Fn(&u64) -> bool + Sync + Send>> {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
 
     fn count(self) -> usize use ::rayon::iter::ParallelIterator;
 }
 
 type ::rayon::slice::Iter<u64> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 
     fn sum<u64>(self) -> u64 use ::rayon::iter::ParallelIterator;
     fn copied<u64>(self) -> ::rayon::iter::Copied<::rayon::slice::Iter<u64>> use ::rayon::iter::ParallelIterator;
 }
 
 type ::rayon::iter::Copied<::rayon::slice::Iter<u64>> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 
     fn filter<Box<dyn Fn(&u64) -> bool + Sync + Send>>(self, Box<dyn Fn(&u64) -> bool + Sync + Send>)
                 -> ::rayon::iter::Filter<::rayon::iter::Copied<::rayon::slice::Iter<u64>>, Box<dyn Fn(&u64) -> bool + Sync + Send>>

examples/rustyline/main.zng

@@ -1,7 +1,7 @@
 // This example uses various layout policies to demonstrate them. See https://hkalbasi.github.io/zngur/call_rust_from_cpp/layout_policy.html
 
 type () {
-    layout(size = 0, align = 1); // Unit type has stable layout
+    #layout(size = 0, align = 1); // Unit type has stable layout
     wellknown_traits(Copy);
 }
 
@@ -13,7 +13,7 @@ type str {
 }
 
 type bool {
-    layout(size = 1, align = 1); // primitives like bool have stable layout
+    #layout(size = 1, align = 1); // primitives like bool have stable layout
     wellknown_traits(Copy);
 }
 

examples/simple/main.zng

@@ -1,17 +1,17 @@
 #convert_panic_to_exception
 
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
 type Box<dyn Fn(i32) -> i32> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 }
 
 mod ::std {
     type option::Option<i32> {
-        layout(size = 8, align = 4);
+        #layout(size = 8, align = 4);
         wellknown_traits(Copy);
 
         constructor None;
@@ -21,29 +21,29 @@ mod ::std {
     }
 
     type option::Option<&i32> {
-        layout(size = 8, align = 8);
+        #layout(size = 8, align = 8);
         wellknown_traits(Copy);
 
         fn unwrap(self) -> &i32;
     }
 
     type iter::Map<::std::vec::IntoIter<i32>, Box<dyn Fn(i32) -> i32>> {
-        layout(size = 48, align = 8);
+        #layout(size = 48, align = 8);
 
         fn sum<i32>(self) -> i32;
     }
 
     mod vec {
         type IntoIter<i32> {
-            layout(size = 32, align = 8);
+            #layout(size = 32, align = 8);
 
             fn sum<i32>(self) -> i32;
             fn map<i32, Box<dyn Fn(i32) -> i32>>(self, Box<dyn Fn(i32) -> i32>)
                 -> ::std::iter::Map<::std::vec::IntoIter<i32>, Box<dyn Fn(i32) -> i32>>;
         }
 
         type Vec<i32> {
-            layout(size = 24, align = 8);
+            #layout(size = 24, align = 8);
             wellknown_traits(Debug);
 
             fn new() -> Vec<i32>;
@@ -60,7 +60,7 @@ mod ::std {
 }
 
 type Box<dyn ::std::iter::Iterator<Item = i32>> {
-    layout(size = 16, align = 8);
+    #layout(size = 16, align = 8);
 
     fn collect<::std::vec::Vec<i32>>(self) -> ::std::vec::Vec<i32>;
 }

examples/tutorial/main.zng

@@ -1,10 +1,10 @@
 type () {
-    layout(size = 0, align = 1);
+    #layout(size = 0, align = 1);
     wellknown_traits(Copy);
 }
 
 type ::std::vec::Vec<crate::Item> {
-    layout(size = 24, align = 8);
+    #layout(size = 24, align = 8);
     wellknown_traits(Debug);
 }
 
@@ -15,17 +15,17 @@ type str {
 }
 
 type ::std::string::String {
-    layout(size = 24, align = 8);
+    #layout(size = 24, align = 8);
 }
 
 type crate::Item {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
 
     constructor { name: ::std::string::String, size: u32 };
 }
 
 type crate::Inventory {
-    layout(size = 32, align = 8);
+    #layout(size = 32, align = 8);
     wellknown_traits(Debug);
 
     fn new_empty(u32) -> crate::Inventory;