2023-12-13 14:35:04 +03:00
|
|
|
mod alias;
|
2023-11-28 19:28:51 +03:00
|
|
|
mod bulk;
|
2023-11-23 16:34:12 +03:00
|
|
|
mod comment;
|
2023-12-26 16:24:07 +03:00
|
|
|
mod markdown;
|
2023-11-25 19:30:43 +03:00
|
|
|
mod pasta;
|
2023-11-23 16:34:12 +03:00
|
|
|
mod position;
|
|
|
|
mod tests;
|
|
|
|
|
2023-12-13 14:35:04 +03:00
|
|
|
use clap::{Parser, ValueEnum};
|
2023-12-26 16:24:07 +03:00
|
|
|
use markdown::find_type;
|
2023-12-13 14:35:04 +03:00
|
|
|
use pasta::{AliasList, ContentSource, Docs, Lookups, PositionType, SourceOrigin, ValuePath};
|
|
|
|
use position::FilePosition;
|
|
|
|
use serde::Serialize;
|
|
|
|
use std::{
|
|
|
|
collections::HashMap,
|
|
|
|
fs::{create_dir_all, File},
|
|
|
|
io::Write,
|
|
|
|
path::PathBuf,
|
|
|
|
println,
|
|
|
|
process::exit,
|
|
|
|
rc::Rc,
|
|
|
|
};
|
|
|
|
use textwrap::dedent;
|
2023-11-23 16:34:12 +03:00
|
|
|
|
2023-11-25 19:30:43 +03:00
|
|
|
use crate::{
|
2023-11-29 14:53:29 +03:00
|
|
|
bulk::BulkProcessing,
|
|
|
|
pasta::Pasta,
|
2023-11-25 19:30:43 +03:00
|
|
|
position::{DocComment, DocIndex},
|
|
|
|
};
|
2023-11-23 16:34:12 +03:00
|
|
|
|
2023-12-13 14:35:04 +03:00
|
|
|
#[derive(ValueEnum, Clone, Debug, PartialEq, Eq)]
|
|
|
|
enum Format {
|
|
|
|
JSON,
|
|
|
|
DIR,
|
|
|
|
}
|
|
|
|
|
2023-11-23 16:34:12 +03:00
|
|
|
#[derive(Debug, Parser)]
|
|
|
|
#[command(author, version, about)]
|
|
|
|
struct Options {
|
|
|
|
/// Json file containing a list of file positions.
|
|
|
|
/// Format: [{ file: String, line: Number, column: Number }]
|
|
|
|
#[arg(long, conflicts_with_all=["line", "column", "file"])]
|
|
|
|
pos_file: Option<PathBuf>,
|
|
|
|
|
2023-12-13 14:35:04 +03:00
|
|
|
#[arg(long)]
|
|
|
|
format: Format,
|
|
|
|
/// Path to a directory for the output file(s).
|
|
|
|
out: String,
|
|
|
|
|
2023-11-23 16:34:12 +03:00
|
|
|
/// Path to the *.nix file that should be inspected.
|
|
|
|
/// If provided, --line and --column must also be set.
|
|
|
|
#[arg(long, requires_all=["line", "column", "file"])]
|
|
|
|
file: Option<PathBuf>,
|
|
|
|
/// Line of the expression.
|
|
|
|
#[arg(short, long, requires_all=["line", "column", "file"])]
|
|
|
|
line: Option<usize>,
|
|
|
|
/// Column of the expression.
|
|
|
|
#[arg(short, long, requires_all=["line", "column", "file"])]
|
|
|
|
column: Option<usize>,
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn main() {
|
|
|
|
// let mut output = io::stdout();
|
|
|
|
let opts = Options::parse();
|
|
|
|
|
|
|
|
if let Some(nix_file) = opts.file {
|
2023-12-13 14:35:04 +03:00
|
|
|
if !nix_file.exists() {
|
|
|
|
println!("file does not exist: {:?}", nix_file);
|
|
|
|
exit(1);
|
|
|
|
}
|
2023-11-28 19:28:51 +03:00
|
|
|
let mut positions = HashMap::new();
|
|
|
|
positions.insert(opts.line.unwrap(), vec![opts.column.unwrap()]);
|
|
|
|
|
|
|
|
let pos = DocIndex::new(&nix_file, positions);
|
|
|
|
|
2023-11-23 16:34:12 +03:00
|
|
|
if let Some(docs) = pos.get_docs(opts.line.unwrap(), opts.column.unwrap()) {
|
|
|
|
println!("{:?}", docs);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
if let Some(pos_file) = opts.pos_file {
|
2023-11-29 14:53:29 +03:00
|
|
|
let data = Pasta::new(&pos_file);
|
2023-12-13 14:35:04 +03:00
|
|
|
// data.doc_map
|
|
|
|
|
2023-12-17 12:51:08 +03:00
|
|
|
let mut json_list: Vec<Document> = vec![];
|
2023-12-13 14:35:04 +03:00
|
|
|
for item in data.docs.iter() {
|
|
|
|
let document = Document::new(&item, &data.doc_map);
|
2023-12-17 12:51:08 +03:00
|
|
|
let matter = &document.meta;
|
|
|
|
let content = &document.content;
|
2023-12-26 16:24:07 +03:00
|
|
|
|
|
|
|
let signature = content
|
|
|
|
.as_ref()
|
|
|
|
.map(|c| c.content.as_ref().map(|s| find_type(&s)))
|
|
|
|
.flatten();
|
|
|
|
|
2023-12-13 14:35:04 +03:00
|
|
|
match opts.format {
|
|
|
|
Format::DIR => {
|
|
|
|
if let Some((_, dir)) = item.path.split_last() {
|
|
|
|
let dir_dest = format!("{}/{}", opts.out, dir.join("/"));
|
2023-12-17 12:51:08 +03:00
|
|
|
let file_dest = format!(
|
|
|
|
"{}/{}.md",
|
|
|
|
opts.out,
|
|
|
|
item.path.join("/").replace("'", "' (Prime)")
|
|
|
|
);
|
2023-12-13 14:35:04 +03:00
|
|
|
create_dir_all(dir_dest).unwrap();
|
|
|
|
let mut file = File::create(file_dest).unwrap();
|
|
|
|
|
|
|
|
file.write_all("---\n".as_bytes()).unwrap();
|
|
|
|
file.write_all(serde_yaml::to_string(&matter).unwrap().as_bytes())
|
|
|
|
.unwrap();
|
|
|
|
file.write_all("---\n".as_bytes()).unwrap();
|
|
|
|
|
2023-12-17 12:51:08 +03:00
|
|
|
if let Some(content) =
|
|
|
|
content.as_ref().map(|ref i| i.content.as_ref()).flatten()
|
|
|
|
{
|
|
|
|
// let fmt = dedent(content.strip_prefix("\n").unwrap_or(&content));
|
|
|
|
file.write_all(content.as_bytes()).unwrap();
|
2023-12-13 14:35:04 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
2023-12-17 12:51:08 +03:00
|
|
|
Format::JSON => json_list.push(document.clone()),
|
2023-12-13 14:35:04 +03:00
|
|
|
}
|
|
|
|
}
|
|
|
|
if opts.format == Format::JSON {
|
|
|
|
let mut file = File::create(opts.out).unwrap();
|
|
|
|
file.write_all(serde_json::to_string(&json_list).unwrap().as_bytes())
|
|
|
|
.unwrap();
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Find the content which should be displayed.
|
|
|
|
/// The own attribute content is the correct one usually.
|
|
|
|
/// Sometimes there is no attribute content.
|
|
|
|
/// The we search all the aliases for their attribute content.
|
|
|
|
/// As a fallback we can display the own lambda content.
|
|
|
|
fn find_document_content<'a>(
|
|
|
|
item: &'a Docs,
|
|
|
|
all: &'a HashMap<Rc<ValuePath>, Docs>,
|
|
|
|
) -> Option<ContentSource<'a>> {
|
2023-12-17 12:51:08 +03:00
|
|
|
let content = match &item.docs.attr.content {
|
2023-12-13 14:35:04 +03:00
|
|
|
Some(ref c) if !c.is_empty() => Some(ContentSource {
|
2023-12-17 12:51:08 +03:00
|
|
|
content: Some(dedent(c)),
|
2023-12-13 14:35:04 +03:00
|
|
|
source: Some(SourceOrigin {
|
|
|
|
position: item.docs.attr.position.as_ref(),
|
|
|
|
path: Some(&item.path),
|
|
|
|
pos_type: Some(PositionType::Attribute),
|
|
|
|
}),
|
|
|
|
}),
|
2023-12-17 12:51:08 +03:00
|
|
|
// _ if item. item.lambda_content().is_some() => item.lambda_content(),
|
2023-12-13 14:35:04 +03:00
|
|
|
_ => match item.fst_alias_content(&all) {
|
|
|
|
Some(d) => Some(d),
|
|
|
|
None => item.lambda_content(),
|
|
|
|
},
|
2023-12-17 12:51:08 +03:00
|
|
|
};
|
|
|
|
return content;
|
2023-12-13 14:35:04 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct Document<'a> {
|
|
|
|
meta: DocumentFrontmatter<'a>,
|
|
|
|
content: Option<ContentSource<'a>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct DocumentFrontmatter<'a> {
|
2023-12-17 12:51:08 +03:00
|
|
|
title: String,
|
2023-12-13 14:35:04 +03:00
|
|
|
path: &'a Rc<ValuePath>,
|
|
|
|
aliases: Option<&'a AliasList>,
|
2023-12-26 16:24:07 +03:00
|
|
|
signature: Option<String>,
|
2023-12-13 14:35:04 +03:00
|
|
|
/// If an item is primop then it should have the PrimopMeta field.
|
|
|
|
is_primop: Option<bool>,
|
|
|
|
primop_meta: Option<PrimopMatter<'a>>,
|
2024-01-07 18:42:51 +03:00
|
|
|
/// is functor
|
|
|
|
is_functor: Option<bool>,
|
2023-12-13 14:35:04 +03:00
|
|
|
/// Where the attribute is defined at.
|
|
|
|
attr_position: Option<&'a FilePosition>,
|
|
|
|
/// Where the original lambda is defined at.
|
|
|
|
lambda_position: Option<&'a FilePosition>,
|
|
|
|
/// How many times the function is applied.
|
|
|
|
count_applied: Option<usize>,
|
|
|
|
content_meta: Option<SourceOrigin<'a>>,
|
|
|
|
// content_position: Option<&'a FilePosition>,
|
|
|
|
}
|
|
|
|
|
|
|
|
pub trait FromDocs<'a> {
|
|
|
|
fn new(docs: &'a Docs, data: &'a HashMap<Rc<ValuePath>, Docs>) -> Self;
|
|
|
|
}
|
|
|
|
|
|
|
|
impl<'a> FromDocs<'a> for Document<'a> {
|
|
|
|
fn new(item: &'a Docs, data: &'a HashMap<Rc<ValuePath>, Docs>) -> Self {
|
|
|
|
let content = find_document_content(item, &data);
|
|
|
|
Self {
|
|
|
|
meta: DocumentFrontmatter {
|
2023-12-26 16:24:07 +03:00
|
|
|
signature: content
|
|
|
|
.as_ref()
|
|
|
|
.map(|c| c.content.as_ref().map(|s| find_type(s)))
|
|
|
|
.flatten()
|
|
|
|
.flatten(),
|
2023-12-13 14:35:04 +03:00
|
|
|
content_meta: content.as_ref().map(|inner| inner.source.clone()).flatten(),
|
2023-12-17 12:51:08 +03:00
|
|
|
title: item.path.join(".").replace("'", "' (Prime)"),
|
2023-12-13 14:35:04 +03:00
|
|
|
path: &item.path,
|
|
|
|
aliases: item.aliases.as_ref(),
|
|
|
|
attr_position: item.docs.attr.position.as_ref(),
|
|
|
|
lambda_position: item
|
|
|
|
.docs
|
|
|
|
.lambda
|
|
|
|
.as_ref()
|
|
|
|
.map(|i| i.position.as_ref())
|
|
|
|
.flatten(),
|
|
|
|
is_primop: item.docs.lambda.as_ref().map(|i| i.isPrimop),
|
2024-01-07 18:42:51 +03:00
|
|
|
is_functor: item.docs.lambda.as_ref().map(|i| i.isFunctor).flatten(),
|
2023-12-13 14:35:04 +03:00
|
|
|
count_applied: item.docs.lambda.as_ref().map(|i| i.countApplied).flatten(),
|
|
|
|
primop_meta: match &item.docs.lambda {
|
|
|
|
None => None,
|
|
|
|
Some(lambda) if lambda.isPrimop => Some(PrimopMatter {
|
|
|
|
name: lambda.name.as_ref(),
|
|
|
|
args: lambda.args.as_ref(),
|
|
|
|
experimental: lambda.experimental,
|
|
|
|
arity: lambda.arity,
|
|
|
|
}),
|
|
|
|
_ => None,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
content,
|
|
|
|
}
|
2023-11-23 16:34:12 +03:00
|
|
|
}
|
|
|
|
}
|
2023-12-13 14:35:04 +03:00
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct PrimopMatter<'a> {
|
|
|
|
pub name: Option<&'a String>,
|
|
|
|
pub args: Option<&'a Vec<String>>,
|
|
|
|
pub experimental: Option<bool>,
|
|
|
|
pub arity: Option<usize>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct CompressedDocument<'a> {
|
|
|
|
/// meta
|
|
|
|
m: CompressedDocumentFrontmatter<'a>,
|
|
|
|
/// content
|
|
|
|
c: Option<ContentSource<'a>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct CompressedDocumentFrontmatter<'a> {
|
|
|
|
/// path
|
|
|
|
pa: &'a Rc<ValuePath>,
|
|
|
|
// aliases
|
|
|
|
al: Option<&'a AliasList>,
|
|
|
|
/// If an item is primop then it should have the PrimopMeta field.
|
|
|
|
ip: Option<bool>,
|
|
|
|
/// primop meta
|
|
|
|
pm: Option<CompressedPrimopMatter<'a>>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct CompressedContentSource<'a> {
|
|
|
|
// content
|
|
|
|
c: Option<&'a String>,
|
|
|
|
// position
|
|
|
|
p: Option<&'a FilePosition>,
|
|
|
|
}
|
|
|
|
|
|
|
|
#[derive(Serialize, Debug, Clone)]
|
|
|
|
struct CompressedPrimopMatter<'a> {
|
|
|
|
// arguments
|
|
|
|
pub ar: Option<&'a Vec<String>>,
|
|
|
|
// arity
|
|
|
|
pub ay: Option<usize>,
|
|
|
|
}
|
|
|
|
|
|
|
|
// Translation matrix
|
|
|
|
// m: meta
|
|
|
|
// c: content
|
|
|
|
// p: position
|
|
|
|
//
|
|
|
|
// al: aliases
|
|
|
|
// ar: arguments
|
|
|
|
// ay: arity
|
|
|
|
//
|
|
|
|
// ip: is primop
|
|
|
|
//
|
|
|
|
// pa: path
|
|
|
|
// pm: primop meta
|