urbit/shrub
1
1
Fork 0
mirror of https://github.com/urbit/shrub.git synced 2024-12-11 11:02:25 +03:00
Code Issues Packages Projects Releases Wiki Activity
16cfd7d8d5
shrub/pkg/arvo/lib/dprint.hoon

783 lines
20 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
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
/+ easy-print=language-server-easy-print
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 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
=>
dprint: +find-item-in-type core name=summary since cores can't be given names in v0 doccords, this changes the main search function in lib/dprint to check if the summary of a core description matches the search term, along with other appropriate changes downstream of this. still to be done: use .name in a %core item for either this summary name or the name of the arm that built the core, if appropriate
2022-11-22 00:04:25 +03:00
:: dprint-types
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
|%
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: $overview: an overview of all named things in the type.
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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: 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
$%
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: overview of a type
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
::
[%view items=overview]
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: inspecting a full core
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
$: %core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
name=tape :: arm that built it
docs=what ::
sut=type :: [%core *]
children=(unit item) :: compiled against
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
==
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: inspecting a single arm on a core
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
$: %arm
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
name=tape :: arm name
adoc=what :: arm doc
pdoc=what :: product doc
cdoc=what :: $ arm/prod doc
gen=hoon :: arm hoon AST
sut=type :: subject of arm
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
==
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: inspecting a face and what's behind 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
$: %face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
name=tape :: name of face
docs=what ::
children=(unit item) :: face referent
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
==
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: inspecting a single chapter on a core
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
$: %chapter
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
name=tape :: name of chapter
docs=what ::
sut=type :: [%core *]
tom=tome :: tome of chapter
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
==
==
::
--
dprint: +find-item-in-type core name=summary since cores can't be given names in v0 doccords, this changes the main search function in lib/dprint to check if the summary of a core description matches the search term, along with other appropriate changes downstream of this. still to be done: use .name in a %core item for either this summary name or the name of the arm that built the core, if appropriate
2022-11-22 00:04:25 +03:00
:: dprint
::
:: 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
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +find-item-in-type: returns the item to print while searching through topic
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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: this gate is a thin wrapper around _hunt for usability, since the only entry
:: point most users should care about is find-item:hunt
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +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
++ 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]
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?~ topics !!
=/ top=(lest term) topics
~(find-item hunt [top sut])
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +hunt: door used for refining the type while searching for doccords
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ hunt
dprint: add (set type) for +return-item check
2023-12-08 11:21:05 +03:00
=| gil=(set type)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
|_ [topics=(lest term) sut=type]
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
+* this .
dprint: uncomment chapter names in _hunt
2022-12-08 22:39:41 +03:00
::
+| %find
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-item
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-item
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?- sut
%noun ~
%void ~
[%atom *] ~
[%cell *] find-cell
[%core *] find-core
[%face *] find-face
[%fork *] find-fork
[%hint *] find-hint
[%hold *] find-item:this(sut (~(play ut p.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
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-cell
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-cell
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%cell *] sut)
=/ lhs find-item:this(sut 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
?~ lhs
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
find-item:this(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
lhs
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-core
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%core *] sut)
?: check-arm
?: check-search
?: check-arm-core
return-arm-core
return-arm
recurse-arm-core
?: check-chap
?: check-search
return-chap
recurse-chap
recurse-core
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
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-face
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%face *] 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
?. ?=(term p.sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::TODO: handle $tune case
find-item:this(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
?. =(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: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
return-face
find-item:this(sut q.sut, topics t.topics)
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
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-fork
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-fork
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%fork *] 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
=/ types=(list type) ~(tap in p.sut)
|-
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?~ types ~
=+ res=find-item:this(sut i.types)
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
?~ res
$(types t.types)
res
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ find-hint
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-hint
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
|^
?> ?=([%hint *] sut)
?. ?=([%help *] q.p.sut)
find-item:this(sut q.sut)
?+ q.sut ~
[%cell *] find-cell:this(sut q.sut)
[%core *] find-hint-core
[%face *] find-hint-face
[%fork *] find-fork:this(sut q.sut)
[%hint *] find-hint:this(sut q.sut)
[%hold *] find-hint:this(q.sut (~(play ut p.q.sut) q.q.sut))
==
::
++ find-hint-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-hint-core
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> &(?=([%hint *] sut) ?=([%help *] q.p.sut) ?=([%core *] q.sut))
::
?. ?& ((sane %tas) summary.crib.p.q.p.sut)
=(summary.crib.p.q.p.sut i.topics)
==
find-core:this(sut q.sut)
?~ t.topics
return-hint-core
find-item:this(sut q.sut, topics t.topics)
::
++ find-hint-face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %find-hint-face
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> &(?=([%hint *] sut) ?=([%help *] q.p.sut) ?=([%face *] q.sut))
?: check-face:this(sut q.sut)
?~ t.topics
return-hint-face
find-item:this(sut q.q.sut, topics t.topics)
find-item:this(sut q.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
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::+| %recurse
++ recurse-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %recurse-core
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%core *] sut)
find-item:this(sut p.sut)
++ recurse-chap
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %recurse-chap
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%core *] sut)
?~ t.topics !!
find-item:this(topics t.topics)
++ recurse-arm-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %recurse-arm-core
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- (unit item)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%core *] sut)
?~ t.topics !!
find-item:this(sut arm-type, topics 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
::
dprint: uncomment chapter names in _hunt
2022-12-08 22:39:41 +03:00
+| %check
::
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
++ check-arm
~? >> debug %recurse-core
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- ?
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
!=(~ (find ~[i.topics] (sloe sut)))
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ check-chap
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %check-chap
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- ?
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%core *] sut)
(~(has by q.r.q.sut) i.topics)
++ check-face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %check-face
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- ?
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
?> ?=([%face *] sut)
?. ?=(term p.sut)
::TODO: handle $tune case
%.n
=(p.sut i.topics)
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
++ check-search
~? >> debug %check-search
dprint: add casting to some _hunt arms
2022-12-07 23:20:23 +03:00
^- ?
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
=(~ t.topics)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ check-arm-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %check-arm-core
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- ?
=+ arm-list=(sloe (~(play ut sut) arm-hoon))
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
&(!=(arm-list ~) !=(arm-list ~[%$]) ?=([%core *] arm-type))
dprint: arms that build cores return core items this makes it so that when an arm matches a search query in +find-item-in-type, it checks to see if the arm builds a core with an arm other than %$. if so, a %core item is returned rather than an %arm item. the name of the core will then be considered to be the name of the arm that builds it
2022-11-22 01:20:28 +03:00
::
dprint: uncomment chapter names in _hunt
2022-12-08 22:39:41 +03:00
+| %return
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
::
++ return-cell
~? >>> debug %return-cell
^- (unit item)
?> ?=([%cell *] sut)
(join-items return-item:this(sut p.sut) return-item:this(sut q.sut))
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ return-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-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
^- (unit item)
?> ?=([%core *] sut)
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
=* compiled-against return-item:this(sut p.sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
`[%core (trip i.topics) *what sut compiled-against]
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ return-face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-face
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%face *] sut)
:: TODO: handle tune case
dprint: bugfix for %hold and $tune cases in +return-item
2023-12-04 06:02:50 +03:00
?. ?=(term p.sut)
return-item:this(sut q.sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
=* compiled-against return-item:this(sut q.sut)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
`[%face (trip p.sut) *what compiled-against]
::
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ return-fork
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-fork
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%fork *] 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
=* types ~(tap in p.sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
=* items (turn types |=(a=type return-item:this(sut a)))
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
(roll items join-items)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ return-hint
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-hint
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%hint *] sut)
=* res return-item:this(sut q.sut)
?. ?=([%help *] q.p.sut)
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
~
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
?: ?=([%core *] q.sut)
return-hint-core
?: ?=([%face *] q.sut)
return-hint-face
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
`[%view [%header `crib.p.q.p.sut (item-as-overview res)]~]
::
++ return-arm
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-arm
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%core *] sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
=+ [adoc pdoc cdoc]=(arm-docs i.topics sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::TODO: should this p.sut be sut? or the compiled type of the arm?
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
`[%arm (trip i.topics) adoc pdoc cdoc arm-hoon sut]
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ return-chap
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-chap
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%core *] sut)
=/ tom=tome (~(got by q.r.q.sut) i.topics)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
`[%chapter (trip i.topics) p.tom sut (~(got by q.r.q.sut) i.topics)]
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ return-arm-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-arm-core
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> ?=([%core *] sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
=+ [adoc pdoc cdoc]=(arm-docs i.topics sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
=/ dox=what ?~(adoc ?~(pdoc ~ pdoc) adoc)
=/ at arm-type
?> ?=([%core *] at)
=* compiled-against return-item:this(sut p.sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
`[%core (trip i.topics) dox at compiled-against]
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ return-item
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-item
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?- sut
%noun ~
%void ~
[%atom *] ~
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
[%cell *] return-cell
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
[%core *] return-core
[%face *] return-face
[%fork *] return-fork
[%hint *] return-hint
dprint: bugfix for %hold and $tune cases in +return-item
2023-12-04 06:02:50 +03:00
[%hold *]
?: (~(has in gil) sut)
~
=< return-item
%= this
gil (~(put in gil) sut)
sut (~(play ut p.sut) q.sut)
==
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
==
::
++ return-hint-core
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-hint-core
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> &(?=([%hint *] sut) ?=([%core *] q.sut))
(apply-hint return-core:this(sut q.sut))
::
++ return-hint-face
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >>> debug %return-hint-face
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
^- (unit item)
?> &(?=([%hint *] sut) ?=([%face *] q.sut))
(apply-hint return-face:this(sut q.sut))
::
++ apply-hint
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
~? >> debug %apply-hint
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
|= uit=(unit item)
^- (unit item)
?~ uit ~
?> &(?=([%hint *] sut) ?=([%help *] q.p.sut))
?+ u.uit ~
?([%core *] [%face *]) (some u.uit(docs `crib.p.q.p.sut))
==
::
dprint: uncomment chapter names in _hunt
2022-12-08 22:39:41 +03:00
+| %misc
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ arm-hoon
^- hoon
?> ?=([%core *] sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(^arm-hoon i.topics sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
::
++ arm-type
^- type
?> ?=([%core *] sut)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(^arm-type i.topics sut)
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
--
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +arm-hoon: looks for an arm in a core type and returns its hoon
dprint: refactor +find-item-in-type &co +find-item-in-type and everything it called was pretty bad spaghetti and it wasn't clear that it was doing this right thing besides that it passed tests. this refactors most of that functionality into a door that has the type and search terms as the sample, and should be much easier to follow. the remaining functionality related to arm docs ought to be refactored as well
2022-11-23 00:26:16 +03:00
++ arm-hoon
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= [nom=term sut=type]
^- hoon
?> ?=([%core *] sut)
=/ tomes=(list [p=term q=tome]) ~(tap by q.r.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
|-
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?~ tomes !!
=+ gen=(~(get by q.q.i.tomes) nom)
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
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)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
u.gen
::
:: +arm-type: looks for an arm in a core type and returns its type
++ arm-type
|= [nom=term sut=type]
^- type
?> ?=([%core *] sut)
(~(play ut sut) (arm-hoon nom sut))
::
:: +hint-doc: returns docs if type is %help $hint w/ matching cuff
++ hint-doc
|= [=cuff sut=type]
^- what
?. &(?=([%hint *] sut) ?=([%help *] q.p.sut) =(cuff cuff.p.q.p.sut))
~
`crib.p.q.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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +arm-doc: returns arm doc of an arm
::
:: we just check if the $cuff is from a ++ or +$ arm but this will
:: probably need to be revisited once more sophisticated cuffs are used
++ arm-doc
|= [nom=term sut=type]
^- what
?~ (hint-doc [%funk nom]~ sut)
(hint-doc [%plan nom]~ sut)
(hint-doc [%funk nom]~ sut)
::
:: +prod-doc: wrapper for +hint-doc with empty cuff
++ prod-doc
doccords: dprint refactoring and renaming
2022-04-05 22:17:57 +03:00
|= sut=type
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
^- what
(hint-doc ~ sut)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +buc-doc: checks if type is core and returns docs on $ arm if it exists
++ buc-doc
|= sut=type
^- what
?. ?=([%core *] 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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?~ (find [%$]~ (sloe sut))
~
=/ sat=type (arm-type %$ sut)
?~ (arm-doc %$ sat)
(prod-doc sat)
(arm-doc %$ sat)
::
:: +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.
::
:: .adoc: docs written above the the arm
:: .pdoc: docs for the product of the arm
:: .cdoc: docs for the default arm of the core produced by the arm
++ arm-docs
|= [nom=term sut=type]
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]
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> ?=([%core *] sut)
=/ sat=type (~(play ut sut) (arm-hoon nom sut))
=/ adoc=what (arm-doc nom sat)
=/ pdoc=what
?~ adoc
(prod-doc sat)
?> ?=([%hint *] sat)
(prod-doc q.sat)
=/ cdoc=what
?~ adoc
?~ pdoc
(buc-doc sat)
?> ?=([%hint *] sat)
(buc-doc q.sat)
?~ pdoc
?> ?=([%hint *] sat)
(buc-doc q.sat)
?> &(?=([%hint *] sat) ?=([%hint *] q.sat))
(buc-doc q.q.sat)
[adoc pdoc cdoc]
::
:: +arm-and-chapter-overviews: returns an overview of a core's contents
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
::
:: 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
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= =item
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
^- [overview overview]
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> &(?=([%core *] item) ?=([%core *] sut.item))
=| [adocs=overview cdocs=overview]
=/ tomes ~(tap by q.r.q.sut.item)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
|-
?~ tomes
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
[(sort-overview adocs) (sort-overview cdocs)]
?~ p.i.tomes
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
:: chapter has no name. add documentation for its arms to arm-docs
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
=. adocs (weld adocs (tome-as-overview q.i.tomes sut.item))
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
$(tomes t.tomes)
:: chapter has a name. add to list of chapters
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
=. cdocs
%+ weld cdocs
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
^- overview
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
[%item :(weld "^" name.item "|" (trip -.i.tomes)) p.q.i.tomes]~
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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= [sut=type tom=tome]
doccords: more printing tools
2022-03-30 22:36:30 +03:00
^- overview
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(sort-overview (tome-as-overview 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
==
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +tome-as-overview: translate a tome into an overview
++ tome-as-overview
|= [tom=tome sut=type]
doccords: more printing tools
2022-03-30 22:36:30 +03:00
^- overview
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
%+ turn ~(tap by q.tom)
doccords: dprint library unwrapping hints doesn't totally work yet
2022-03-31 21:39:09 +03:00
|= ar=(pair term hoon)
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:* %item
::TODO make this distinguish between ++ and +$ arms
(weld "+" (trip p.ar))
=/ adoc (arm-doc p.ar (~(play ut sut) q.ar))
=/ pdoc (prod-doc (~(play ut sut) q.ar))
?~ adoc
pdoc
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: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:_ ~
::TODO make this distinguish between ++ and +$ arms
:* %item (weld "+" name.itm)
?~ adoc.itm
?~ pdoc.itm
cdoc.itm
pdoc.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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
[%view *] (print-overview item *(pair styl styl))
[%core *] (print-core item)
[%arm *] (print-arm item)
[%chapter *] (print-chapter item)
[%face *] (print-face item)
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-core: renders documentation for a full core
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-core
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= =item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> ?=([%core *] item)
=+ [arms chapters]=(arm-and-chapter-overviews item)
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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-header (weld "^" name.item) docs.item)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
[%txt ""]~
::
(print-signature ~(duck easy-print sut.item))
::
[%txt ""]~
::
?~ arms
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
~
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-overview [%view [%header `['arms:' ~] arms]~] styles)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
?~ chapters
~
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-overview [%view [%header `['chapters:' ~] chapters]~] styles)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
::
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
?~ children.item
~
=/ child ?: ?=([%core *] u.children.item)
u.children.item(children ~)
?: ?=([%face *] u.children.item)
u.children.item(children ~)
u.children.item
=+ compiled=(item-as-overview `child)
doccords: dprint print core routine
2022-04-01 00:35:50 +03:00
?~ compiled
~
dprint: uncomment chapter names in _hunt
2022-12-08 22:39:41 +03:00
(print-overview [%view [%header `['compiled against: ' ~] [i.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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= =item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> ?=([%chapter *] item)
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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-header (weld "|" name.item) docs.item)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
=+ arms=(arms-in-chapter sut.item tom.item)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
?~ arms
~
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-overview [%view [%header `['arms:' ~] arms]~] styles)
doccords: more printing tools
2022-03-30 22:36:30 +03:00
==
::
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
:: +print-signature: turns product of duck:easy-print into a (list sole-effect)
++ print-signature
|= =tank
^- (list sole-effect)
dprint: cut off signatures of length >= 3 anytime a gate prints with a complicated sample or product type it is frequently extremely long. 3 is probably too low of a cutoff number, but ideally a future version will have verbosity settings that will help control this.
2022-12-15 23:04:33 +03:00
=/ tan (wash [3 80] tank)
?. (gte (lent tan) 3)
(turn tan |=(a=tape [%txt a]))
%+ weld
(turn (scag 3 tan) |=(a=tape [%txt a]))
(styled [[`%br ~ `%g] ' ...']~)
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +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
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= =item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> ?=([%arm *] item)
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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-header (weld "+" name.item) adoc.item)
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%txt ""]~
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
::
(print-signature ~(duck easy-print (~(play ut sut.item) gen.item)))
::
[%txt ""]~
::
dprint: dont print (undocumented) on arms style reasons
2022-11-29 23:22:34 +03:00
?~ pdoc.item
*(list sole-effect)
%- zing :~ (styled [[`%br ~ `%b] 'product:']~)
(print-header "" pdoc.item)
[%txt ""]~
==
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
::
dprint: dont print (undocumented) on arms style reasons
2022-11-29 23:22:34 +03:00
?~ cdoc.item
*(list sole-effect)
dprint: call $ arms $ arms
2022-12-15 23:06:02 +03:00
%- zing :~ (styled [[`%br ~ `%b] '$:']~)
dprint: dont print (undocumented) on arms style reasons
2022-11-29 23:22:34 +03:00
(print-header "" cdoc.item)
==
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
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= =item
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
^- (list sole-effect)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?> ?=([%face *] item)
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: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-header (weld "." name.item) docs.item)
dprint: add identifying glyphs to various items
2022-06-30 23:27:06 +03:00
[%txt ""]~
dprint: fixes and refactoring of _hunt, signatures some small issues and debugging tools. also puts some more doccords on dprint types. also adds use the language server pretty printer to print the types of arms
2022-12-06 01:33:20 +03:00
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?~ children.item
doccords: more printing tools
2022-03-30 22:36:30 +03:00
~
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
(print-item u.children.item)
dprint: easier to read style changes
2022-06-30 22:14:56 +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-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)]~)
dprint: dont print (undocumented) on arms style reasons
2022-11-29 23:22:34 +03:00
?~ doc *(list sole-effect)
:: (styled [[`%br ~ `%r] '(undocumented)']~)
dprint: easier to read style changes
2022-06-30 22:14:56 +03:00
:~ :- %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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +print-overview: prints summaries of several items
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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: the (pair styl styl) provides styles for each generation of child items
doccords: more printing tools
2022-03-30 22:36:30 +03:00
++ print-overview
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
|= [view=item styles=(pair styl styl)]
?> ?=([%view *] view)
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)
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
?~ items.view out
=/ oitem i.items.view
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
?- oitem
[%header *]
%= $
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
items.view t.items.view
out ;: weld
out
?~ doc.oitem ~
(styled [p.styles (crip "{(trip p.u.doc.oitem)}")]~)
^$(view [%view 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 *]
%= $
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
items.view t.items.view
out ;: weld
out
(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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: +print-sections: renders a list of sections as tang
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
::
dprint: refactor some printing logic for maintainability
2022-11-29 21:59:06 +03:00
:: 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