Diagnostic custom kind change

crates/parser/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "as3_parser"
-version = "0.5.20"
+version = "0.5.22"
 edition = "2021"
 authors = ["hydroper <[email protected]>"]
 repository = "https://github.com/hydroper/as3parser"

crates/parser/diagnostics/diagnostics.rs

@@ -1,3 +1,5 @@
+use std::any::Any;
+
 use maplit::hashmap;
 use crate::ns::*;
 
@@ -14,7 +16,7 @@ pub struct Diagnostic {
     pub(crate) is_warning: bool,
     pub(crate) is_verify_error: bool,
     pub(crate) arguments: Vec<DiagnosticArgument>,
-    pub(crate) custom_id: RefCell<Option<String>>,
+    pub(crate) custom_kind: RefCell<Option<Rc<dyn Any>>>,
 }
 
 impl Eq for Diagnostic {}
@@ -46,7 +48,7 @@ impl Diagnostic {
             is_verify_error: false,
             is_warning: false,
             arguments,
-            custom_id: RefCell::new(None),
+            custom_kind: RefCell::new(None),
         }
     }
 
@@ -57,7 +59,7 @@ impl Diagnostic {
             is_verify_error: true,
             is_warning: false,
             arguments,
-            custom_id: RefCell::new(None),
+            custom_kind: RefCell::new(None),
         }
     }
 
@@ -68,7 +70,7 @@ impl Diagnostic {
             is_verify_error: false,
             is_warning: true,
             arguments,
-            custom_id: RefCell::new(None),
+            custom_kind: RefCell::new(None),
         }
     }
 
@@ -104,12 +106,12 @@ impl Diagnostic {
         self.kind.id()
     }
 
-    pub fn custom_id(&self) -> Option<String> {
-        self.custom_id.borrow().clone()
+    pub fn custom_kind(&self) -> Option<Rc<dyn Any>> {
+        self.custom_kind.borrow().clone()
     }
 
-    pub fn set_custom_id(&self, id: Option<&str>) {
-        self.custom_id.replace(id.map(|id| id.to_owned()));
+    pub fn set_custom_kind(&self, id: Option<Rc<dyn Any>>) {
+        self.custom_kind.replace(id);
     }
 
     /// Formats the diagnostic by overriding the message text.

docs/diagnostics.md

@@ -47,16 +47,22 @@ The `diagnostic_arguments![]` literal takes elements in one of the forms:
 * `Token(token)`
 * `String(string)`
 
-## Custom IDs
+## Custom kinds
 
-If you need to support your own messages, set the `custom_id` field:
+If you need to support your own messages, set the `custom_kind` field:
 
 ```rust
-diagnostic.set_custom_id(Some("myMessage"));
+diagnostic.set_custom_kind(Some(Rc::new(kind)));
 ```
 
-Finish formatting your own message by attaching additional information with:
+Where `kind` is an enumeration's variant. You may then later cast the custom kind from `Rc<dyn Any>` to your enumeration through `.downcast::<MyEnum>()`.
 
-```
+If you want, for simple debugging purposes, you may finish formatting your own message with location information by using:
+
+```rust
 diagnostic.format_with_message("My message", Some(custom_id_number))
-```
+```
+
+For real use cases, calling `.format_with_message()` is not preferred if your application is not solely in English, since it will add categories such as `Warning`.
+
+Moreover, argument variants in `as3_parser::ns::Diagnostic` may not be enough. For example, a compiler may want to store a symbol argument; in this case, an extra layer over `as3_parser::ns::Diagnostic` must be provided, supporting more variants.