From b78b75f006938188a0e393b2631838b4403f3441 Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Mon, 22 Jul 2024 15:00:09 -0700 Subject: [PATCH 1/4] typegen: add module names --- typegen/src/main.rs | 1 + typegen/src/outform.rs | 1 + 2 files changed, 2 insertions(+) diff --git a/typegen/src/main.rs b/typegen/src/main.rs index d1736ab..a14255c 100644 --- a/typegen/src/main.rs +++ b/typegen/src/main.rs @@ -107,6 +107,7 @@ hidetitle = true } let index = outform::ModuleIndex { + name: module.header.name.to_string(), description: module.header.description, details: module.details.to_string(), }; diff --git a/typegen/src/outform.rs b/typegen/src/outform.rs index 185cc5b..a7910f6 100644 --- a/typegen/src/outform.rs +++ b/typegen/src/outform.rs @@ -4,6 +4,7 @@ use serde::Serialize; #[derive(Debug, Serialize)] pub struct ModuleIndex { + pub name: String, pub description: String, pub details: String, } From 997eb9e87643fa3b509b3f8c2c812298c65bea5e Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Mon, 22 Jul 2024 15:24:43 -0700 Subject: [PATCH 2/4] typegen: add module and name fields to type files --- typegen/src/outform.rs | 10 +++++++- typegen/src/resolver.rs | 53 ++++++++++++++++++++++------------------- 2 files changed, 38 insertions(+), 25 deletions(-) diff --git a/typegen/src/outform.rs b/typegen/src/outform.rs index a7910f6..641d64c 100644 --- a/typegen/src/outform.rs +++ b/typegen/src/outform.rs @@ -9,10 +9,18 @@ pub struct ModuleIndex { pub details: String, } +#[derive(Debug, Serialize)] +pub struct TypeInfo { + pub name: String, + pub module: String, + #[serde(flatten)] + pub details: TypeDetails, +} + #[derive(Debug, Serialize)] #[serde(rename_all = "lowercase")] #[serde(tag = "type")] -pub enum TypeInfo { +pub enum TypeDetails { Class(ClassInfo), Enum(EnumInfo), } diff --git a/typegen/src/resolver.rs b/typegen/src/resolver.rs index 8c2f609..984c582 100644 --- a/typegen/src/resolver.rs +++ b/typegen/src/resolver.rs @@ -211,37 +211,42 @@ pub fn resolve_types( None => HashMap::new(), }; - let type_ = outform::ClassInfo { - superclass, - description: class.description.clone(), - details: class.details.clone(), - flags: { - let mut flags = Vec::new(); + let type_ = outform::TypeInfo { + name: mapping.name.clone(), + module: mapping.module.clone().unwrap(), + details: outform::TypeDetails::Class(outform::ClassInfo { + superclass, + description: class.description.clone(), + details: class.details.clone(), + flags: { + let mut flags = Vec::new(); - if coreenum.is_some() { - flags.push(Flag::Enum); - } else if class.singleton { - flags.push(Flag::Singleton); - } else if class.uncreatable { - flags.push(Flag::Uncreatable); - } + if coreenum.is_some() { + flags.push(Flag::Enum); + } else if class.singleton { + flags.push(Flag::Singleton); + } else if class.uncreatable { + flags.push(Flag::Uncreatable); + } - flags - }, - properties, - functions, - signals, - variants, + flags + }, + properties, + functions, + signals, + variants, + }), }; - outtypes.insert(mapping.name.clone(), outform::TypeInfo::Class(type_)); + outtypes.insert(mapping.name.clone(), type_); } for enum_ in typespec.enums { if enum_.module.as_ref().map(|v| v as &str) == Some(module) { - outtypes.insert( - enum_.name, - outform::TypeInfo::Enum(outform::EnumInfo { + outtypes.insert(enum_.name.clone(), outform::TypeInfo { + name: enum_.name, + module: enum_.module.unwrap(), + details: outform::TypeDetails::Enum(outform::EnumInfo { description: enum_.description, details: enum_.details, variants: enum_ @@ -254,7 +259,7 @@ pub fn resolve_types( }) .collect(), }), - ); + }); } } From 593634eb27915e481d3d560573bf3e82d202d9fc Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Mon, 9 Sep 2024 23:17:28 -0700 Subject: [PATCH 3/4] typegen: restructure type links and callouts for new site --- typegen/src/main.rs | 1 + typegen/src/parse.rs | 133 +++------------------------------------- typegen/src/reformat.rs | 127 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 138 insertions(+), 123 deletions(-) create mode 100644 typegen/src/reformat.rs diff --git a/typegen/src/main.rs b/typegen/src/main.rs index a14255c..0e22cc9 100644 --- a/typegen/src/main.rs +++ b/typegen/src/main.rs @@ -4,6 +4,7 @@ use anyhow::{anyhow, Context}; mod outform; mod parse; +mod reformat; mod resolver; mod typespec; diff --git a/typegen/src/parse.rs b/typegen/src/parse.rs index 32337d6..b41a2d1 100644 --- a/typegen/src/parse.rs +++ b/typegen/src/parse.rs @@ -1,10 +1,11 @@ -use std::borrow::Cow; - use anyhow::{anyhow, bail, Context}; use fancy_regex::Regex; use serde::Deserialize; -use crate::typespec; +use crate::{ + reformat::{self, ReformatPass}, + typespec, +}; #[derive(Deserialize, Debug)] pub struct ModuleInfoHeader { @@ -625,7 +626,6 @@ impl From> for typespec::FnParam { fn parse_details(comment: Comment) -> String { let mut seen_content = false; - let mut callout = false; let mut str = comment .text @@ -642,127 +642,14 @@ fn parse_details(comment: Comment) -> String { seen_content |= any; filter }) - .map(|line| match callout { - true => { - if line.starts_with('>') { - Cow::Borrowed(line[1..].strip_prefix(' ').unwrap_or(&line[1..])) - } else { - callout = false; - Cow::Owned(format!("{{{{< /callout >}}}}\n{line}")) - } - }, - false => { - if line.starts_with("> [!") { - let code = line[4..].split_once(']'); - - if let Some((code, line)) = code { - let code = code.to_lowercase(); - callout = true; - return Cow::Owned(format!("{{{{< callout type=\"{code}\" >}}}}\n{line}")) - } - } - - return Cow::Borrowed(line); - }, - }) - .map(|line| { - if line.contains("@@") { - let mut src: &str = &*line; - let mut accum = String::new(); - - while let Some(i) = src.find("@@") { - accum += &src[..i]; - src = &src[i + 2..]; - - let separators = [ - ('$', true), - (' ', false), - (',', false), - (';', false), - (':', false), - ]; - - let (mut end, mut ty) = src.chars().enumerate() - .find_map(|(i, char)| { - separators.iter() - .find(|(sc, _)| char == *sc) - .map(|(_, strip)| (i + if *strip { 1 } else { 0 }, &src[..i])) - }) - .unwrap_or_else(|| (src.len(), src)); - - // special case for . as it is contained in valid types as well - if ty.ends_with('.') { - end -= 1; - ty = &ty[..ty.len() - 1]; - } - - let (ty, member) = match ty.chars().next() { - None => (None, None), - Some(c) if c.is_lowercase() => (None, Some(ty)), - Some(_) => { - let mut split = ty.rsplit_once('.').unwrap_or(("", ty)); - - let member = split - .1 - .chars() - .next() - .unwrap() - .is_lowercase() - .then(|| { - let prop = split.1; - split = split.0.rsplit_once('.').unwrap_or(("", split.0)); - prop - }) - .unwrap_or(""); - - let (mut module, name) = split; - - if module.is_empty() { - module = comment.module; - } - - (Some((module, name)), Some(member)) - }, - }; - - let (membertype, membername) = match member { - None => ("", ""), - Some(name) if name.ends_with("()") => ("func", &name[..name.len() - 2]), - Some(name) if name.ends_with("(s)") => ("signal", &name[..name.len() - 3]), - Some(name) if name.is_empty() => ("", ""), - Some(name) => ("prop", name), - }; - - let ((linktype, module), name) = match ty { - Some((module, name)) => { - let module = match module { - module if module.starts_with("Quickshell") => ("local", module.to_string()), - module => ("qt", format!("qml.{module}")), - }; - - (module, name) - }, - None => (("", String::new()), ""), - }; - - accum += &format!( - r#"{{{{< qmltypelink type="{linktype}" module="{module}" name="{name}" mtype="{membertype}" mname="{membername}" >}}}}"# - ); - src = &src[end..]; - } - - accum += src; - - return Cow::Owned(accum); - } else { - return line; - } - }) .fold(String::new(), |accum, line| accum + line.as_ref() + "\n"); - if callout { - str += "\n{{< /callout >}}"; - } + let reformat_ctx = reformat::Context { + module: comment.module, + }; + + crate::reformat::GfmQuoteBlocks::reformat(&reformat_ctx, &mut str); + crate::reformat::TypeLinks::reformat(&reformat_ctx, &mut str); str } diff --git a/typegen/src/reformat.rs b/typegen/src/reformat.rs new file mode 100644 index 0000000..1a22b93 --- /dev/null +++ b/typegen/src/reformat.rs @@ -0,0 +1,127 @@ +use std::borrow::Cow; + +pub struct Context<'a> { + pub module: &'a str, +} + +pub trait ReformatPass { + fn reformat(context: &Context, text: &mut String); +} + +pub struct GfmQuoteBlocks; + +impl ReformatPass for GfmQuoteBlocks { + fn reformat(_: &Context, text: &mut String) { + *text = text.replace("> [!INFO]", "> [!NOTE]"); + } +} + +pub struct TypeLinks; + +impl ReformatPass for TypeLinks { + fn reformat(context: &Context, text: &mut String) { + let lines = text.lines().map(|line| { + if line.contains("@@") { + let mut src: &str = &*line; + let mut accum = String::new(); + + while let Some(i) = src.find("@@") { + accum += &src[..i]; + src = &src[i + 2..]; + + let separators = [ + ('$', true), + (' ', false), + (',', false), + (';', false), + (':', false), + ]; + + let (mut end, mut ty) = src + .chars() + .enumerate() + .find_map(|(i, char)| { + separators + .iter() + .find(|(sc, _)| char == *sc) + .map(|(_, strip)| (i + if *strip { 1 } else { 0 }, &src[..i])) + }) + .unwrap_or_else(|| (src.len(), src)); + + // special case for . as it is contained in valid types as well + if ty.ends_with('.') { + end -= 1; + ty = &ty[..ty.len() - 1]; + } + + let (ty, member) = match ty.chars().next() { + None => (None, None), + Some(c) if c.is_lowercase() => (None, Some(ty)), + Some(_) => { + let mut split = ty.rsplit_once('.').unwrap_or(("", ty)); + + let member = split + .1 + .chars() + .next() + .unwrap() + .is_lowercase() + .then(|| { + let prop = split.1; + split = split.0.rsplit_once('.').unwrap_or(("", split.0)); + prop + }) + .unwrap_or(""); + + let (mut module, name) = split; + + if module.is_empty() { + module = context.module; + } + + (Some((module, name)), Some(member)) + }, + }; + + let (membertype, membername) = match member { + None => ("", ""), + Some(name) if name.ends_with("()") => ("func", &name[..name.len() - 2]), + Some(name) if name.ends_with("(s)") => ("signal", &name[..name.len() - 3]), + Some(name) if name.is_empty() => ("", ""), + Some(name) => ("prop", name), + }; + + accum += "TYPE"; + + if let Some((module, name)) = ty { + if module.starts_with("Quickshell") { + accum += "99MQS"; + } else { + accum += "99MQT_qml"; + } + + accum = module + .split('.') + .fold(accum, |accum, next| accum + "_" + next) + + "99N" + name; + } + + if !membername.is_empty() { + accum += &format!("99V{membername}99T{membertype}"); + } + + accum += "99TYPE"; + src = &src[end..]; + } + + accum += src; + + return Cow::Owned(accum); + } else { + return Cow::Borrowed(line); + } + }); + + *text = lines.fold(String::new(), |accum, line| accum + line.as_ref() + "\n"); + } +} From 34f0819a76f4fe05b1199eb054f81e2690136ea6 Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Sat, 9 Nov 2024 00:11:49 -0800 Subject: [PATCH 4/4] typegen: insert newlines after callouts to avoid breaking new site --- typegen/src/parse.rs | 4 ++-- typegen/src/reformat.rs | 21 +++++++++++++++++---- 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/typegen/src/parse.rs b/typegen/src/parse.rs index b41a2d1..7354278 100644 --- a/typegen/src/parse.rs +++ b/typegen/src/parse.rs @@ -648,8 +648,8 @@ fn parse_details(comment: Comment) -> String { module: comment.module, }; - crate::reformat::GfmQuoteBlocks::reformat(&reformat_ctx, &mut str); - crate::reformat::TypeLinks::reformat(&reformat_ctx, &mut str); + crate::reformat::GfmQuoteBlocks::new().reformat(&reformat_ctx, &mut str); + crate::reformat::TypeLinks.reformat(&reformat_ctx, &mut str); str } diff --git a/typegen/src/reformat.rs b/typegen/src/reformat.rs index 1a22b93..4bca75a 100644 --- a/typegen/src/reformat.rs +++ b/typegen/src/reformat.rs @@ -1,25 +1,38 @@ use std::borrow::Cow; +use fancy_regex::Regex; + pub struct Context<'a> { pub module: &'a str, } pub trait ReformatPass { - fn reformat(context: &Context, text: &mut String); + fn reformat(&self, context: &Context, text: &mut String); } -pub struct GfmQuoteBlocks; +pub struct GfmQuoteBlocks { + callout_regex: Regex, +} + +impl GfmQuoteBlocks { + pub fn new() -> Self { + Self { + callout_regex: Regex::new(r#">\s+\[!(?\w+)]\s+(?=\w)"#).unwrap() + } + } +} impl ReformatPass for GfmQuoteBlocks { - fn reformat(_: &Context, text: &mut String) { + fn reformat(&self, _: &Context, text: &mut String) { *text = text.replace("> [!INFO]", "> [!NOTE]"); + *text = self.callout_regex.replace_all(text, "> [!$type]\n> ").to_string(); } } pub struct TypeLinks; impl ReformatPass for TypeLinks { - fn reformat(context: &Context, text: &mut String) { + fn reformat(&self ,context: &Context, text: &mut String) { let lines = text.lines().map(|line| { if line.contains("@@") { let mut src: &str = &*line;