urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-12-30 07:35:19 +03:00
Code Issues Packages Projects Releases Wiki Activity
f4a84caf30
shrub/pkg/arvo/lib/dprint.hoon

633 lines
17 KiB
Plaintext
Raw Normal View History

dprint: add styled text first run mostly just to get something working, next i will clean up syntax
2022-06-30 18:39:06 +03:00
/- *sole
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: a library for printing doccords
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
::
dprint: add missing doccords
2022-06-30 23:58:45 +03:00
=/ debug |
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
=>
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: types used by doccords
hoon, dprint: remove |% and |@ core names partial revert of 3d3ea61d53, which introduced core names by completing an unimplemented feature that was already present in hoon.hoon. we've decided to remove this for the initial launch since it violates the principle of least surprise for the name of a core to end up in its $garb and yet only be used for doccords, as opposed to something like a wing resolution. it was also confusing that this only worked for |% and |@. this breaks two of the tests for the dprint library, which have been commented out. these tests ought to be restored once dprint is rewritten in order to implement a different way to refer to cores not built by arms
2022-11-16 01:48:07 +03:00
|%
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: $overview: an overview of all named things in the type.
::
:: each element in the overview list is either a documentation for a sublist
:: or an association betwen a term and documentation for it
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
+$ overview (list overview-item)
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: $overview-item: an element of an overview
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
+$ overview-item
$% [%header doc=what children=overview]
[%item name=tape doc=what]
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: $item: the part of a type being inspected
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
+$ item
$%
:: overview of a type
::
[%view items=overview]
:: inspecting a full core
$: %core
name=tape
docs=what
sut=type
con=coil
children=(unit item)
==
:: inspecting a single arm on a core
$: %arm
name=tape
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
adoc=what
pdoc=what
cdoc=what
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
gen=hoon
sut=type
==
:: inspecting a face and what's behind it
$: %face
name=tape
docs=what
children=(unit item)
==
:: inspecting a single chapter on a core
$: %chapter
name=tape
docs=what
sut=type
con=coil
==
==
::
--
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: core containing doccords search and printing utilities
hoon, dprint: remove |% and |@ core names partial revert of 3d3ea61d53, which introduced core names by completing an unimplemented feature that was already present in hoon.hoon. we've decided to remove this for the initial launch since it violates the principle of least surprise for the name of a core to end up in its $garb and yet only be used for doccords, as opposed to something like a wing resolution. it was also confusing that this only worked for |% and |@. this breaks two of the tests for the dprint library, which have been commented out. these tests ought to be restored once dprint is rewritten in order to implement a different way to refer to cores not built by arms
2022-11-16 01:48:07 +03:00
|%
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: contains arms used for looking for docs inside of a type
::
:: the entrypoint for finding docs within a type is +find-item-in-type.
doccords: dprint core and chapter items adds the ability to find cores and chapters and produce an item from them
2022-04-04 23:23:27 +03:00
+| %searching
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +find-item-in-type: returns the item to print while searching through topic
::
:: this gate is optionally called recursively to find the path (topic) in the
:: type (sut). once it finds the correct part of the type, it switches to
:: +signify to describe that part of the type. recursion is turned off (for some
:: cases) when a hint type is found, in case it is wrapping a match.
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
++ find-item-in-type
dprint: simplify type to item interface shouldn't need to surface recursion to the developer
2022-06-30 23:56:04 +03:00
|= [topics=(list term) sut=type]
=/ rec=? %.y
dprint: missed |^ in last commit
2022-06-09 18:18:10 +03:00
|^
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
^- (unit item)
doccords: dprint debug printfs
2022-04-07 20:05:58 +03:00
~? > debug topics
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?~ topics
:: we have no more search paths, return an overview of what remains
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
::
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
(signify sut)
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
?- sut
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
%noun ~
%void ~
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
[%atom *] ~
::
[%cell *]
=+ lhs=$(sut p.sut)
?~ lhs
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
:: not sure if this should recurse when rec=%.n
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
$(sut q.sut)
lhs
::
[%core *]
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
:: checks for a core name match, then tries to find a chapter, arm, or
:: arm in a chapter depending on how many topics remain. will still work
:: if core is unnamed
doccords: dprint core and chapter items adds the ability to find cores and chapters and produce an item from them
2022-04-04 23:23:27 +03:00
=+ core-name=p.p.q.sut
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?: !=(`i.topics core-name)
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
=+ arm=(make-arm i.topics sut ~)
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?~ arm
?:(rec $(sut p.sut) ~)
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
arm
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?~ t.topics
dprint: deduplicate role of +signify some of the functionality of +signify was being done elsewhere, this moves it into +signify
2022-06-09 18:33:29 +03:00
(signify sut)
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
=/ tom=(unit tome) (~(get by q.r.q.sut) i.t.topics)
?~ tom
(make-arm i.t.topics sut ~)
?~ t.t.topics
dprint: remove chapter-id from %chapter item redundant with the name
2022-06-09 22:19:39 +03:00
`[%chapter (trip i.t.topics) p.u.tom sut q.sut]
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
(make-arm i.t.t.topics sut tom)
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
[%face *]
?. ?=(term p.sut)
dprint: deduplicate role of +signify some of the functionality of +signify was being done elsewhere, this moves it into +signify
2022-06-09 18:33:29 +03:00
~ :: TODO: handle tune case
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?. =(i.topics p.sut)
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
~
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?~ t.topics
dprint: deduplicate role of +signify some of the functionality of +signify was being done elsewhere, this moves it into +signify
2022-06-09 18:33:29 +03:00
(signify sut)
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
?:(rec $(topics t.topics, sut q.sut) ~)
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
[%fork *]
=/ types=(list type) ~(tap in p.sut)
|-
?~ types
~
=+ res=^$(sut i.types)
?~ res
$(types t.types)
res
::
[%hint *]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
:: If we found a help hint, it is wrapping a type for which we might want to
:: produce an item, so we should peek inside of it to see what type it is
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
:: and grab the docs from the hint if so
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
::
=/ shallow-match=(unit item) $(sut q.sut, rec %.n)
?~ shallow-match
:: hint isn't wrapping a match, so step through it
dprint: simplify type to item interface shouldn't need to surface recursion to the developer
2022-06-30 23:56:04 +03:00
^$(sut q.sut)
dojo, doccords: dprint library can take list term this allows you to search for foo:bar instead of just foo
2022-04-07 00:37:55 +03:00
`(emblazon u.shallow-match (unwrap-hint sut))
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
[%hold *] $(sut (~(play ut p.sut) q.sut))
::
==
dprint: deduplicate role of +signify some of the functionality of +signify was being done elsewhere, this moves it into +signify
2022-06-09 18:33:29 +03:00
::
dprint: simplify and fix core/chapter/arm search the main issue fixed was with looking inside of chapters for arms didn't work
2022-06-09 18:04:09 +03:00
++ make-arm
|= [name=term sut=type tom=(unit tome)]
^- (unit item)
?> ?=([%core *] sut)
=+ arm=(find-arm-in-coil name q.sut)
?~ arm
~
=+ [adoc pdoc cdoc]=(all-arm-docs u.arm sut (trip name))
?~ tom
`[%arm (trip name) adoc pdoc cdoc u.arm p.sut]
?. (~(has by q.u.tom) name)
~
`[%arm (trip name) adoc pdoc cdoc u.arm p.sut]
--
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +signify: changes a type into a item without docs
::
:: this does not actually assign the docs, since they usually come from a hint
:: wrapping the type.
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
++ signify
|= sut=type
^- (unit item)
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
?- sut
dprint: deduplicate role of +signify some of the functionality of +signify was being done elsewhere, this moves it into +signify
2022-06-09 18:33:29 +03:00
::
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
[%atom *] ~
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
::
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
[%cell *]
%+ join-items
$(sut p.sut)
$(sut q.sut)
::
[%core *]
doccords: dprint core and chapter items adds the ability to find cores and chapters and produce an item from them
2022-04-04 23:23:27 +03:00
=/ name=(unit term) p.p.q.sut :: should check if core is built with an arm and use that name?
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
=* compiled-against $(sut p.sut)
doccords: dprint core and chapter items adds the ability to find cores and chapters and produce an item from them
2022-04-04 23:23:27 +03:00
?~ name
dprint: fix issues with core types not actually sure this is correct yet, but it fixed the issue where there would be a crash when looking for docs in an arm like +bar in |% ++ foo 'foo' ++ bar foo --
2022-06-08 19:43:01 +03:00
`[%core ~ *what sut q.sut compiled-against]
`[%core (trip u.name) *what sut q.sut compiled-against]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
[%face *]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
?. ?=(term p.sut)
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
~ :: TODO: handle tune case
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
=* compiled-against $(sut q.sut)
`[%face (trip p.sut) *what compiled-against]
::
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
[%fork *]
=* types ~(tap in p.sut)
=* items (turn types signify)
(roll items join-items)
::
[%hint *]
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
~? >> debug %hint-signify
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
=* rest-type $(sut q.sut)
:: check to see if it is a help hint
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
?. ?=(%help -.q.p.sut)
~
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
`[%view [%header `crib.p.q.p.sut (item-as-overview rest-type)]~]
::
[%hold *] $(sut (~(play ut p.sut) q.sut))
%noun ~
%void ~
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
==
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +unwrap-hint: checks if a hint type is a help hint and returns the docs if so
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
++ unwrap-hint
|= sut=type
^- what
?. ?=([%hint *] sut)
~? > debug %not-hint-type
~
?>(?=(%help -.q.p.sut) `crib.p.q.p.sut)
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +emblazon: inserts docs into an item
::
:: when matching for a core or a face type, the docs for that type will be in
:: a hint that wraps it. thus we end up producing an item for that type, then
:: need to add the docs to it.
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
++ emblazon
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
|= [=item =what]
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
~? >> debug %emblazon
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
^+ item
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
?+ item item :: no-op on %chapter, %arm, $view
?([%core *] [%face *]) item(docs what)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +find-arm-in-coil: looks for an arm in a coil and returns its hoon
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
++ find-arm-in-coil
|= [arm-name=term con=coil]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
~? >> debug %find-arm-in-coil
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
^- (unit hoon)
=/ tomes=(list [p=term q=tome]) ~(tap by q.r.con)
|-
?~ tomes
~
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
=+ gen=(~(get by q.q.i.tomes) arm-name)
?~ gen
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
$(tomes t.tomes)
doccords: dprint fix default core arm printing if the product had its own docs, it wouldn't also get the docs for a the default arm produced by the core. this fixes that. also misc style fixes
2022-04-01 00:33:59 +03:00
`u.gen
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +help-from-hint: gets the help from a %help $hint and returns it as a unit
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
++ help-from-hint
|= sut=type
^- (unit help)
?+ sut ~
[%hold *]
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
~? >> debug %help-from-hold
$(sut (~(play ut p.sut) q.sut))
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
::
[%hint *]
~? >> debug %help-from-hint
?. ?=(%help -.q.p.sut)
~
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
`p.q.p.sut
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
==
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +arm-product-docs: returns 0, 1, or 2 whats for an arm
::
:: this arm should be handed the compiled type of the hoon of an arm, as well
:: as the name of that arm. it checks for up to 2 nested hints on the outermost
:: layer of the type. if you have 2, it is presumed to be arm-doc followed by
:: product-doc. if you only have one, we check .cuff in the $help of the hint
:: to determine whether it is an arm doc or product doc.
::
:: this returns ~ if there are no docs. if there are docs, the first one is the
:: arm-doc, and the second one is the product-doc.
::
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
++ arm-product-docs
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
|= [sut=type name=term]
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
^- (unit [what what])
=/ doc-one=(unit help)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
(help-from-hint sut)
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
?~ doc-one
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
~? > debug %doc-one-empty
~ :: no need to look for a second doc if there is no first one
dprint: links -> cuff
2022-07-06 23:31:07 +03:00
?: =(~ cuff.u.doc-one)
dprint: arms calling other arms dont steal doccord i thought this would be a neat feature but ted called it too clever and probably not what you really want. this code is atrocious though and needs some serious cleanup
2022-06-08 22:39:40 +03:00
:: doc-one is a product-doc
[~ [~ `crib.u.doc-one]]
dprint: links -> cuff
2022-07-06 23:31:07 +03:00
?: !=(name ->.cuff.u.doc-one)
dprint: arms calling other arms dont steal doccord i thought this would be a neat feature but ted called it too clever and probably not what you really want. this code is atrocious though and needs some serious cleanup
2022-06-08 22:39:40 +03:00
:: link on doc-one doesnt match arm name, so that means its calling a
:: different arm and trying to use its docs. don't let it
~
~? > debug :- %doc-one doc-one
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
=/ doc-two=(unit help)
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
?. ?=([%hint *] sut)
dprint: arms calling other arms dont steal doccord i thought this would be a neat feature but ted called it too clever and probably not what you really want. this code is atrocious though and needs some serious cleanup
2022-06-08 22:39:40 +03:00
~
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
(help-from-hint q.sut)
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
?~ doc-two
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
~? > debug %doc-two-empty
dprint: links -> cuff
2022-07-06 23:31:07 +03:00
:: if .cuff is non-empty, check that the link is for the arm
?: =(name ->.cuff.u.doc-one)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
~? > debug %link-match
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
[~ [`crib.u.doc-one ~]]
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
~? > debug %link-doesnt-match-arm
dprint: arms calling other arms dont steal doccord i thought this would be a neat feature but ted called it too clever and probably not what you really want. this code is atrocious though and needs some serious cleanup
2022-06-08 22:39:40 +03:00
:: this can happen if +bar calls +foo which has doccords
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
[~ [`crib.u.doc-one ~]]
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
:: doc-two is non-empty. make sure that doc-one is an arm-doc for this arm
dprint: links -> cuff
2022-07-06 23:31:07 +03:00
?> =(name ->.cuff.u.doc-one)
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
[~ [`crib.u.doc-one `crib.u.doc-two]]
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +all-arm-docs: grabs the docs for an arm.
::
:: there are three possible places with relevant docs for an arm:
:: docs for the arm itself, docs for the product of the arm, and
:: if the arm builds a core, docs for the default arm of that core.
::
:: arm-doc: docs written above the the arm
:: product-doc: docs for the product of the arm
:: core-doc: docs for the default arm of the core produced by the arm
:: this will be the first of the arm-doc or product-doc on the default
:: arm. maybe this should be recursive and/or give both but its a decision
:: ill leave for later
::
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
++ all-arm-docs
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
|= [gen=hoon sut=type name=tape]
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
~? > debug %all-arm-docs
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
^- [what what what]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
=+ hoon-type=(~(play ut sut) gen)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
=+ arm-prod=(arm-product-docs hoon-type `@tas`(crip name))
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
|^
doccords: dprint fix depth calculation stupid loobeans tripping me up
2022-04-05 21:44:47 +03:00
:: check arm-prod to determine how many layers to look into the type
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
:: for core docs
doccords: dprint fix depth calculation stupid loobeans tripping me up
2022-04-05 21:44:47 +03:00
=/ depth=@ ?~ arm-prod 0
(add =(~ +<.arm-prod) =(~ +>.arm-prod))
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
?+ depth ``~
%0 ``(extract hoon-type)
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
%1 :+ +<.arm-prod
+>.arm-prod
?> ?=([%hint *] hoon-type)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
(extract q.hoon-type)
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
%2 :+ +<.arm-prod
+>.arm-prod
?> ?=([%hint *] hoon-type)
?> ?=([%hint *] q.hoon-type)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
(extract q.q.hoon-type)
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
==
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +extract: grabs the first doc for the default arm of a core
::
:: this could end up being an arm doc or a product doc.
::
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
++ extract
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
|= sut=type
^- what
doccords: dprint improve default arm core docs the logic for getting the docs on the default arm of a core is now more similar to how other arm docs are gotten, rather than having its own system. there is still more room for improvement
2022-04-06 23:34:02 +03:00
?. ?=([%core *] sut)
~? > debug %no-nested-core ~
~? > debug %found-nested-core
=+ carm=(find-arm-in-coil %$ q.sut)
?~ carm ~? > debug %empty-carm ~
~? > debug %found-default-arm
dprint: compile default arm in core against core previously it was only compiling against the context, which meant it broke if an arm referred to another arm
2022-06-08 22:41:04 +03:00
=+ carm-type=(~(play ut sut) u.carm)
dprint: cleanup some logic around %hint types deduplicating some code and making it a bit easier to understand. still kind of a mess, but its progress and all tests are passing
2022-06-09 21:40:45 +03:00
=/ hel=(unit help) (help-from-hint carm-type)
?~ hel
~
`what``crib.u.hel
doccords: dprint can dist. arm-doc and prod-doc rewrites select-arm-docs so that it checks for nested hint types and sees if the outermost help hint has a %funk link with the name of the arm in order to tell that its an arm-doc
2022-04-05 19:38:02 +03:00
--
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +arm-and-chapter-overviews: returns an overview of a cores contents
::
:: returns an overview for arms which are part of unnamed chapters, and
:: an overview of the named chapters
::
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
++ arm-and-chapter-overviews
|= [sut=type con=coil core-name=tape]
^- [overview overview]
=| arm-docs=overview
=| chapter-docs=overview
=/ tomes ~(tap by q.r.con)
|-
?~ tomes
[(sort-overview arm-docs) (sort-overview chapter-docs)]
=* current i.tomes ::[term tome]
?~ p.current
:: chapter has no name. add documentation for its arms to arm-docs
=. arm-docs (weld arm-docs (arms-as-overview q.q.current sut))
$(tomes t.tomes)
:: chapter has a name. add to list of chapters
=. chapter-docs
%+ weld chapter-docs
^- overview
dprint: fix syntax and test suite for new parser
2022-07-06 23:21:13 +03:00
[%item :(weld "^" core-name "|" (trip -.current)) p.q.current]~
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
$(tomes t.tomes)
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +arms-in-chapter: returns an overview of the arms in a specific chapter
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ arms-in-chapter
dprint: remove chapter-id from %chapter item redundant with the name
2022-06-09 22:19:39 +03:00
|= [sut=type con=coil name=tape]
doccords: more printing tools
2022-03-30 22:36:30 +03:00
^- overview
dprint: remove chapter-id from %chapter item redundant with the name
2022-06-09 22:19:39 +03:00
=/ tom=tome (~(got by q.r.con) (crip name))
(sort-overview (arms-as-overview q.tom sut))
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +sort-overview: sort items in an overview in alphabetical order
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ sort-overview
|= ovr=overview
^- overview
%+ sort ovr
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
|= [lhs=overview-item rhs=overview-item]
(aor (get-overview-name lhs) (get-overview-name rhs))
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +get-overview-name: returns the name of an overview
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ get-overview-name
|= ovr=overview-item
?- ovr
[%header *] ""
[%item *] name.ovr
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +arms-as-overview: translate a tome into an overview
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ arms-as-overview
|= [a=(map term hoon) sut=type]
^- overview
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
%+ turn ~(tap by a)
|= ar=(pair term hoon)
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
=+ [adoc pdoc cdoc]=(all-arm-docs q.ar sut (trip p.ar))
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%item (weld "+" (trip p.ar)) adoc]
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +item-as-overview: changes an item into an overview
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
++ item-as-overview
|= uit=(unit item)
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
~? >> debug %item-as-overview
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
^- overview
?~ uit ~
=+ itm=(need uit)
?- itm
[%view *] items.itm
::
[%core *]
?~ name.itm
(item-as-overview children.itm)
dprint: fix syntax and test suite for new parser
2022-07-06 23:21:13 +03:00
:- [%item (weld "^" name.itm) docs.itm]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
(item-as-overview children.itm)
::
[%arm *]
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%item (weld "+" name.itm) adoc.itm]~
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
[%chapter *]
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%item (weld "|" name.itm) docs.itm]~
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
[%face *]
?~ name.itm
~
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%item (weld "." name.itm) docs.itm]~
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +join-items: combines two (unit items) together
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
++ join-items
|= [lhs=(unit item) rhs=(unit item)]
^- (unit item)
?~ lhs rhs
?~ rhs lhs
`[%view (weld (item-as-overview lhs) (item-as-overview rhs))]
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: contains arms using for printing doccords items
doccords: dprint core and chapter items adds the ability to find cores and chapters and produce an item from them
2022-04-04 23:23:27 +03:00
+| %printing
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-item: prints a doccords item
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-item
|= =item
doccords: dprint debug printfs
2022-04-07 20:05:58 +03:00
~? >> debug %print-item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
?- item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
[%view *] (print-overview items.item *(pair styl styl))
doccords: more printing tools
2022-03-30 22:36:30 +03:00
[%core *] (print-core +.item)
[%arm *] (print-arm +.item)
[%chapter *] (print-chapter +.item)
[%face *] (print-face +.item)
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-core: renders documentation for a full core
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-core
|= [name=tape docs=what sut=type con=coil uit=(unit item)]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
=+ [arms chapters]=(arm-and-chapter-overviews sut con name)
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
=/ styles=(pair styl styl) [[`%br ~ `%b] [`%br ~ `%m]]
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
;: weld
dprint: fix syntax and test suite for new parser
2022-07-06 23:21:13 +03:00
(print-header (weld "^" name) docs)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
?~ arms
~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(print-overview [%header `['arms:' ~] arms]~ styles)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
?~ chapters
~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(print-overview [%header `['chapters:' ~] chapters]~ styles)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
=+ compiled=(item-as-overview uit)
?~ compiled
~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(print-overview [%header `['compiled against: ' ~] compiled]~ styles)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
==
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-chapter: renders documentation for a single chapter
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-chapter
dprint: remove chapter-id from %chapter item redundant with the name
2022-06-09 22:19:39 +03:00
|= [name=tape doc=what sut=type con=coil]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: dprint chapter and overview print tweak printing an overview only gives the summary now, not the details. also fixed chapter printing so that it doesn't print the details twice
2022-04-07 19:55:30 +03:00
~? > debug %print-chapter
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
=/ styles=(pair styl styl) [[`%br ~ `%b] [`%br ~ `%m]]
doccords: more printing tools
2022-03-30 22:36:30 +03:00
;: weld
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
(print-header (weld "|" name) doc)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
dprint: remove chapter-id from %chapter item redundant with the name
2022-06-09 22:19:39 +03:00
=+ arms=(arms-in-chapter sut con name)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
?~ arms
~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(print-overview [%header `['arms:' ~] arms]~ styles)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
==
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-arm: renders documentation for a single arm in a core
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-arm
doccords: dprint all docs in %arm items from type before this, it was grabbing the initial arm-doc from the AST rather than the type. now %arm items have all 3 types of docs available. the interface has been degraded somewhat though, as %arm items no longer have a single docs field. more refactoring will be needed to figure out the best way to do this.
2022-04-05 22:52:35 +03:00
|= [name=tape adoc=what pdoc=what cdoc=what gen=hoon sut=type]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
~? >> debug %print-arm
doccords: dprint fix crash on non-help %hint
2022-04-01 00:59:45 +03:00
;: weld
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
(print-header (weld "+" name) adoc)
[%txt ""]~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(styled [[`%br ~ `%b] 'product:']~)
(print-header "" pdoc)
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%txt ""]~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(styled [[`%br ~ `%b] 'default arm in core:']~)
(print-header "" cdoc)
doccords: dprint fix crash on non-help %hint
2022-04-01 00:59:45 +03:00
==
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-face: renders documentation for a face
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-face
|= [name=tape doc=what children=(unit item)]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: dprint debug printfs
2022-04-07 20:05:58 +03:00
~? >> debug %print-face
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
;: weld
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
(print-header (weld "." name) doc)
[%txt ""]~
doccords: more printing tools
2022-03-30 22:36:30 +03:00
?~ children
~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(print-item u.children)
==
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-header: prints name and docs only
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-header
|= [name=tape doc=what]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
doccords: dprint debug printfs
2022-04-07 20:05:58 +03:00
~? >> debug %print-header
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
;: weld
(styled [[`%br ~ `%g] (crip name)]~)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
?~ doc
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(styled [[`%br ~ `%r] '(undocumented)']~)
:~ :- %tan
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
%- flop
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
;: weld
[%leaf "{(trip p.u.doc)}"]~
(print-sections q.u.doc)
== ==
==
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-overview: prints summaries of several items
::
:: the (list styl) provides styles for each generation of child
:: items
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-overview
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
|= [=overview styles=(pair styl styl)]
doccords: dprint debug printfs
2022-04-07 20:05:58 +03:00
~? >> debug %print-overview
dprint: add styled text first run mostly just to get something working, next i will clean up syntax
2022-06-30 18:39:06 +03:00
=| out=(list sole-effect)
|- ^- (list sole-effect)
doccords: dprint print overview also adds another mule to a play:ut call to avoid another crash that i'm not sure yet why it is happening
2022-04-01 01:45:28 +03:00
?~ overview out
=/ oitem i.overview
?- oitem
[%header *]
%= $
overview t.overview
out ;: weld
out
?~ doc.oitem ~
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(styled [p.styles (crip "{(trip p.u.doc.oitem)}")]~)
^$(overview children.oitem)
==
doccords: dprint print overview also adds another mule to a play:ut call to avoid another crash that i'm not sure yet why it is happening
2022-04-01 01:45:28 +03:00
==
::
[%item *]
%= $
overview t.overview
out ;: weld
out
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
(styled [q.styles (crip name.oitem)]~)
?~ doc.oitem
%- styled
:~ [[`%br ~ `%r] '(undocumented)']
[[~ ~ ~] '']
==
^- (list sole-effect)
[%tan [[%leaf ""] [%leaf "{(trip p.u.doc.oitem)}"] ~]]~
doccords: dprint print overview also adds another mule to a play:ut call to avoid another crash that i'm not sure yet why it is happening
2022-04-01 01:45:28 +03:00
==
==
==
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-sections: renders a list of sections as tang
::
:: prints the longform documentation
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
++ print-sections
|= sections=(list sect)
^- tang
=| out=tang
|-
?~ sections out
=. out
;: weld
out
`tang`[%leaf ""]~
(print-section i.sections)
==
$(sections t.sections)
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +print-section: renders a sect as a tang
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
++ print-section
|= section=sect
^- tang
%+ turn section
|= =pica
^- tank
?: p.pica
[%leaf (trip q.pica)]
[%leaf " {(trip q.pica)}"]
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
::
hoon, dprint: change doccords syntax to :: this constitutes a pretty major rework of how whitespace is handled in hoon in order to change the doccords syntax from :> and :< to ::. in summary: throughout the hoon parser (+vast) many instances of +gap have been replaced by +jump, which first tries to remove whitespace (+leap) until it arrives at something that can be parsed as a prefix doccord (+apex:docs:vast). if it does not encounter a doccord, it instead uses +gap as normal. if you follow along with the parser, you will notice that every time jump is called, it then tries to call +apex:docs via +scye or +seam. if apex:docs succeeds, it will end up consuming a newline at the end, hiding the fact that there was valid whitespace from the parser. thus +apex:docs then inserts a newline after successfully parsing a prefix doccord, which will then be consumed by a subsequent invocation of +gap, ensuring that there was proper whitespace if the doccord would have been consumed by +gap instead of +leap. there are a few other changes: +hint in the compiler throws out doccords attached to %noun types. this was already the behavior before doccords, and the change was made before i understood what i was doing. similarly for commenting out the %note case in +open:ap - this was an earlier mistake postfix comments for chapters are now enabled. +expx was unused and removed in order to be rid of the convention-defying +exp1. other unused +ex(p/q)* were commented out. arms that handle batch comments (+glow and +whap) were refactored +toad, which was used to change between tall and wide form, tries to +jump before +gap. since +jump is ;~(pose leap:docs gap), i would have thought that just using +jump there would be fine, but it fails for some reason. some parsers built with |@ were rewritten to use |* |$ was made so that any doccords put on the spec are converted into hoon doccords on the $ arm. it wouldn't compile otherwise. there's probably a more principled way to do this but it works fine for now.
2022-07-19 21:57:36 +03:00
:: +styled: makes $sole-effects out of $styls and $cords
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
++ styled
|= [in=(list (pair styl cord))]
^- (list sole-effect)
=| out=(list sole-effect)
|-
?~ in out
=/ eff=styx [p.i.in [q.i.in]~]~
%= $
in t.in
out (snoc out [%klr eff])
==
doccords: finding and print doccords library initial commit for library for finding and printing doccords. has some basic functionality for looking through a type and finding the docs within it and printing them, but is mostly unfinished
2022-03-30 21:51:40 +03:00
--
Reference in New Issue Copy Permalink