TITLE

Raku port of Perl's __FILE__ and associated functionality


SUBTITLE

data

=begin data
{"type":"page","file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","sources":[],"node":{"type":"block","id":"j-UVlv0MH9Pzco6JOYAAE","margin":"","name":"root","content":[{"type":"para","id":"Qgg4rLGQWs50pAvn0pU9L","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":129,"offset":128}},"text":"text","content":[{"meta":"https://github.com/lizmat/P5__FILE__/actions","type":"fcode","name":"L","content":[{"type":"block","id":"LdcLlAtJ8mrKeoEPsSr2f","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":82,"offset":81}},"content":[{"type":"image","src":"https://github.com/lizmat/P5__FILE__/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"aQJTaimUAjlBcmuG-sZrU","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":130},"end":{"line":3,"column":7,"offset":136}},"content":["NAME"]},{"type":"para","id":"Ps3MSFT9-_myiVCWl2qlo","margin":"","location":{"start":{"line":5,"column":1,"offset":138},"end":{"line":5,"column":58,"offset":195}},"text":"text","content":["Raku port of Perl's ",{"type":"fcode","name":"B","content":["FILE"]}," and associated functionality"]},{"type":"block","id":"-tkilkDhkKaf98JbvS6X0","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":197},"end":{"line":7,"column":11,"offset":207}},"content":["SYNOPSIS"]},{"type":"block","id":"-Gh0QmE-h05HIlFRDQZ2S","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":209},"end":{"line":9,"column":72,"offset":280}},"content":[{"type":"verbatim","value":"use P5__FILE__;  # exports __FILE__, __LINE__, __PACKAGE__, __SUB__"}]},{"type":"block","id":"XccdTal0EPHwQ6WfG0cnJ","margin":"","level":1,"name":"head","location":{"start":{"line":11,"column":1,"offset":282},"end":{"line":11,"column":14,"offset":295}},"content":["DESCRIPTION"]},{"type":"para","id":"xAoF2LFgzW0XB5ObNfzct","margin":"","location":{"start":{"line":13,"column":1,"offset":297},"end":{"line":13,"column":149,"offset":445}},"text":"text","content":["This module tries to mimic the behaviour of Perl's ",{"type":"fcode","name":"C","content":["__FILE__"]},", ",{"type":"fcode","name":"C","content":["__LINE__"]},", ",{"type":"fcode","name":"C","content":["__PACKAGE__"]}," and ",{"type":"fcode","name":"C","content":["__SUB__"]}," functionality as closely as possible in Raku."]},{"type":"block","id":"10JX6w5bJvPEDX_SQs5B0","margin":"","level":1,"name":"head","location":{"start":{"line":15,"column":1,"offset":447},"end":{"line":15,"column":8,"offset":454}},"content":["TERMS"]},{"type":"block","id":"hNqS-dKnifbEkxVZrZZGK","margin":"","level":2,"name":"head","location":{"start":{"line":17,"column":1,"offset":456},"end":{"line":17,"column":15,"offset":470}},"content":[{"type":"fcode","name":"B","content":["PACKAGE"]}]},{"type":"para","id":"T10guHf1j91EFju7sc2QA","margin":"","location":{"start":{"line":19,"column":1,"offset":472},"end":{"line":19,"column":73,"offset":544}},"text":"text","content":["A special token that returns the name of the package in which it occurs."]},{"type":"block","id":"r9Vv3xocTlK68KGf7KQOC","margin":"","level":3,"name":"head","location":{"start":{"line":21,"column":1,"offset":546},"end":{"line":21,"column":9,"offset":554}},"content":["Raku"]},{"type":"block","id":"w45f3Ra6QoiCUwTpcgNDx","margin":"","name":"code","config":[],"location":{"start":{"line":23,"column":1,"offset":556},"end":{"line":23,"column":20,"offset":575}},"content":[{"type":"verbatim","value":"$?PACKAGE.^name"}]},{"type":"para","id":"SYWj9JDC1ZShDUj7vivMa","margin":"","location":{"start":{"line":25,"column":1,"offset":577},"end":{"line":25,"column":180,"offset":756}},"text":"text","content":["Because ",{"type":"fcode","name":"C","content":["$?PACKAGE"]}," gives you the actual ",{"type":"fcode","name":"C","content":["Package"]}," object (which can be used for introspection), you need to call the ",{"type":"fcode","name":"C","content":[".^name"]}," method to get a string with the name of the package."]},{"type":"block","id":"DH-961nmJ7HRBHKDIpNWx","margin":"","level":2,"name":"head","location":{"start":{"line":27,"column":1,"offset":758},"end":{"line":27,"column":12,"offset":769}},"content":[{"type":"fcode","name":"B","content":["FILE"]}]},{"type":"para","id":"Zzdkxrdan2MLJieZkw_N-","margin":"","location":{"start":{"line":29,"column":1,"offset":771},"end":{"line":29,"column":70,"offset":840}},"text":"text","content":["A special token that returns the name of the file in which it occurs."]},{"type":"block","id":"uPBa_qeCxm44_28mZ8keJ","margin":"","level":3,"name":"head","location":{"start":{"line":31,"column":1,"offset":842},"end":{"line":31,"column":9,"offset":850}},"content":["Raku"]},{"type":"block","id":"6jR7QKiSOZxKOxqBKtj2h","margin":"","name":"code","config":[],"location":{"start":{"line":33,"column":1,"offset":852},"end":{"line":33,"column":11,"offset":862}},"content":[{"type":"verbatim","value":"$?FILE"}]},{"type":"block","id":"OabeHDSyaEuJTFaUNi8E_","margin":"","level":2,"name":"head","location":{"start":{"line":35,"column":1,"offset":864},"end":{"line":35,"column":12,"offset":875}},"content":[{"type":"fcode","name":"B","content":["LINE"]}]},{"type":"para","id":"-DQRHwGBCzmCFgInqaB6-","margin":"","location":{"start":{"line":37,"column":1,"offset":877},"end":{"line":37,"column":58,"offset":934}},"text":"text","content":["A special token that compiles to the current line number."]},{"type":"block","id":"L6YnkmaCUnHTj6_otQglw","margin":"","level":3,"name":"head","location":{"start":{"line":39,"column":1,"offset":936},"end":{"line":39,"column":9,"offset":944}},"content":["Raku"]},{"type":"block","id":"3Bv9Sene3j1sBO7jLABh7","margin":"","name":"code","config":[],"location":{"start":{"line":41,"column":1,"offset":946},"end":{"line":41,"column":11,"offset":956}},"content":[{"type":"verbatim","value":"$?LINE"}]},{"type":"block","id":"i8yWWaxvONURO2pHTgsG6","margin":"","level":2,"name":"head","location":{"start":{"line":43,"column":1,"offset":958},"end":{"line":43,"column":11,"offset":968}},"content":[{"type":"fcode","name":"B","content":["SUB"]}]},{"type":"para","id":"9-EndNrniJfSaWCgc9wIq","margin":"","location":{"start":{"line":45,"column":1,"offset":970},"end":{"line":45,"column":104,"offset":1073}},"text":"text","content":["A special token that returns a reference to the current subroutine, or \"undef\" outside of a subroutine."]},{"type":"block","id":"AK75-FSNOrvZSsFiVF5cq","margin":"","level":3,"name":"head","location":{"start":{"line":47,"column":1,"offset":1075},"end":{"line":47,"column":9,"offset":1083}},"content":["Raku"]},{"type":"block","id":"EtqyscGEBd0EhG1CCVOyZ","margin":"","name":"code","config":[],"location":{"start":{"line":49,"column":1,"offset":1085},"end":{"line":49,"column":14,"offset":1098}},"content":[{"type":"verbatim","value":"&?ROUTINE"}]},{"type":"para","id":"DDYkT842QT6GyRnWMY9ue","margin":"","location":{"start":{"line":51,"column":1,"offset":1100},"end":{"line":51,"column":182,"offset":1281}},"text":"text","content":["Because ",{"type":"fcode","name":"C","content":["&?ROUTINE"]}," gives you the actual ",{"type":"fcode","name":"C","content":["Routine"]}," object (which can be used for introspection), you need to call the ",{"type":"fcode","name":"C","content":[".name"]}," method to get a string with the name of the subroutine."]},{"type":"block","id":"CBLDV2QmykW27iE_I7kS6","margin":"","level":1,"name":"head","location":{"start":{"line":53,"column":1,"offset":1283},"end":{"line":53,"column":9,"offset":1291}},"content":["AUTHOR"]},{"type":"para","id":"y6_RUFKusEy4o6T7TLn0d","margin":"","location":{"start":{"line":55,"column":1,"offset":1293},"end":{"line":55,"column":37,"offset":1329}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"para","id":"6OI8yu1v_Lk1cJzSSpf1A","margin":"","location":{"start":{"line":57,"column":1,"offset":1331},"end":{"line":57,"column":105,"offset":1435}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/P5__FILE","type":"fcode","name":"L","content":["https://github.com/lizmat/P5__FILE"]},"__ . Comments and Pull Requests are welcome."]},{"type":"block","id":"DNjBhQJUEvGN9pVAS3Y4G","margin":"","level":1,"name":"head","location":{"start":{"line":59,"column":1,"offset":1437},"end":{"line":59,"column":24,"offset":1460}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"t-Wtcvflt6w_uQ4cmLrZ4","margin":"","location":{"start":{"line":61,"column":1,"offset":1462},"end":{"line":61,"column":53,"offset":1514}},"text":"text","content":["Copyright 2018, 2019, 2020, 2021 Elizabeth Mattijsen"]},{"type":"para","id":"SI3mnOk1s4iQIPyGoHy5D","margin":"","location":{"start":{"line":63,"column":1,"offset":1516},"end":{"line":63,"column":58,"offset":1573}},"text":"text","content":["Re-imagined from Perl as part of the CPAN Butterfly Plan."]},{"type":"para","id":"dGq58m5knfy6DyfE-zsEe","margin":"","location":{"start":{"line":65,"column":1,"offset":1575},"end":{"line":65,"column":104,"offset":1678}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Raku port of Perl's __FILE__ and associated functionality","dist":"P5__FILE__:ver<0.0.6>:auth<zef:lizmat>","license":"Artistic-2.0","name":"P5__FILE__","path":"P/5_/P5__FILE__/351a4fe20823126a669f4a417ce8d2407f837d35.tar.gz","perl":"6.c","provides":{"P5__FILE__":"lib/P5__FILE__.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/P5__FILE__.git","tags":["PERL5","CPAN5"],"test-depends":[],"version":"0.0.6"},"files":[{"file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md"},{"file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/lib/P5__FILE__.rakumod","publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/lib/P5__FILE__.rakumod"}],"src":"zef","url":"/mods/zef/P5__FILE__"}}}
=end data


React

    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","sources":[],"node":{"type":"block","id":"j-UVlv0MH9Pzco6JOYAAE","margin":"","name":"root","content":[{"type":"para","id":"Qgg4rLGQWs50pAvn0pU9L","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":129,"offset":128}},"text":"text","content":[{"meta":"https://github.com/lizmat/P5__FILE__/actions","type":"fcode","name":"L","content":[{"type":"block","id":"LdcLlAtJ8mrKeoEPsSr2f","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":82,"offset":81}},"content":[{"type":"image","src":"https://github.com/lizmat/P5__FILE__/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"aQJTaimUAjlBcmuG-sZrU","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":130},"end":{"line":3,"column":7,"offset":136}},"content":["NAME"]},{"type":"para","id":"Ps3MSFT9-_myiVCWl2qlo","margin":"","location":{"start":{"line":5,"column":1,"offset":138},"end":{"line":5,"column":58,"offset":195}},"text":"text","content":["Raku port of Perl's ",{"type":"fcode","name":"B","content":["FILE"]}," and associated functionality"]},{"type":"block","id":"-tkilkDhkKaf98JbvS6X0","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":197},"end":{"line":7,"column":11,"offset":207}},"content":["SYNOPSIS"]},{"type":"block","id":"-Gh0QmE-h05HIlFRDQZ2S","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":209},"end":{"line":9,"column":72,"offset":280}},"content":[{"type":"verbatim","value":"use P5__FILE__;  # exports __FILE__, __LINE__, __PACKAGE__, __SUB__"}]},{"type":"block","id":"XccdTal0EPHwQ6WfG0cnJ","margin":"","level":1,"name":"head","location":{"start":{"line":11,"column":1,"offset":282},"end":{"line":11,"column":14,"offset":295}},"content":["DESCRIPTION"]},{"type":"para","id":"xAoF2LFgzW0XB5ObNfzct","margin":"","location":{"start":{"line":13,"column":1,"offset":297},"end":{"line":13,"column":149,"offset":445}},"text":"text","content":["This module tries to mimic the behaviour of Perl's ",{"type":"fcode","name":"C","content":["__FILE__"]},", ",{"type":"fcode","name":"C","content":["__LINE__"]},", ",{"type":"fcode","name":"C","content":["__PACKAGE__"]}," and ",{"type":"fcode","name":"C","content":["__SUB__"]}," functionality as closely as possible in Raku."]},{"type":"block","id":"10JX6w5bJvPEDX_SQs5B0","margin":"","level":1,"name":"head","location":{"start":{"line":15,"column":1,"offset":447},"end":{"line":15,"column":8,"offset":454}},"content":["TERMS"]},{"type":"block","id":"hNqS-dKnifbEkxVZrZZGK","margin":"","level":2,"name":"head","location":{"start":{"line":17,"column":1,"offset":456},"end":{"line":17,"column":15,"offset":470}},"content":[{"type":"fcode","name":"B","content":["PACKAGE"]}]},{"type":"para","id":"T10guHf1j91EFju7sc2QA","margin":"","location":{"start":{"line":19,"column":1,"offset":472},"end":{"line":19,"column":73,"offset":544}},"text":"text","content":["A special token that returns the name of the package in which it occurs."]},{"type":"block","id":"r9Vv3xocTlK68KGf7KQOC","margin":"","level":3,"name":"head","location":{"start":{"line":21,"column":1,"offset":546},"end":{"line":21,"column":9,"offset":554}},"content":["Raku"]},{"type":"block","id":"w45f3Ra6QoiCUwTpcgNDx","margin":"","name":"code","config":[],"location":{"start":{"line":23,"column":1,"offset":556},"end":{"line":23,"column":20,"offset":575}},"content":[{"type":"verbatim","value":"$?PACKAGE.^name"}]},{"type":"para","id":"SYWj9JDC1ZShDUj7vivMa","margin":"","location":{"start":{"line":25,"column":1,"offset":577},"end":{"line":25,"column":180,"offset":756}},"text":"text","content":["Because ",{"type":"fcode","name":"C","content":["$?PACKAGE"]}," gives you the actual ",{"type":"fcode","name":"C","content":["Package"]}," object (which can be used for introspection), you need to call the ",{"type":"fcode","name":"C","content":[".^name"]}," method to get a string with the name of the package."]},{"type":"block","id":"DH-961nmJ7HRBHKDIpNWx","margin":"","level":2,"name":"head","location":{"start":{"line":27,"column":1,"offset":758},"end":{"line":27,"column":12,"offset":769}},"content":[{"type":"fcode","name":"B","content":["FILE"]}]},{"type":"para","id":"Zzdkxrdan2MLJieZkw_N-","margin":"","location":{"start":{"line":29,"column":1,"offset":771},"end":{"line":29,"column":70,"offset":840}},"text":"text","content":["A special token that returns the name of the file in which it occurs."]},{"type":"block","id":"uPBa_qeCxm44_28mZ8keJ","margin":"","level":3,"name":"head","location":{"start":{"line":31,"column":1,"offset":842},"end":{"line":31,"column":9,"offset":850}},"content":["Raku"]},{"type":"block","id":"6jR7QKiSOZxKOxqBKtj2h","margin":"","name":"code","config":[],"location":{"start":{"line":33,"column":1,"offset":852},"end":{"line":33,"column":11,"offset":862}},"content":[{"type":"verbatim","value":"$?FILE"}]},{"type":"block","id":"OabeHDSyaEuJTFaUNi8E_","margin":"","level":2,"name":"head","location":{"start":{"line":35,"column":1,"offset":864},"end":{"line":35,"column":12,"offset":875}},"content":[{"type":"fcode","name":"B","content":["LINE"]}]},{"type":"para","id":"-DQRHwGBCzmCFgInqaB6-","margin":"","location":{"start":{"line":37,"column":1,"offset":877},"end":{"line":37,"column":58,"offset":934}},"text":"text","content":["A special token that compiles to the current line number."]},{"type":"block","id":"L6YnkmaCUnHTj6_otQglw","margin":"","level":3,"name":"head","location":{"start":{"line":39,"column":1,"offset":936},"end":{"line":39,"column":9,"offset":944}},"content":["Raku"]},{"type":"block","id":"3Bv9Sene3j1sBO7jLABh7","margin":"","name":"code","config":[],"location":{"start":{"line":41,"column":1,"offset":946},"end":{"line":41,"column":11,"offset":956}},"content":[{"type":"verbatim","value":"$?LINE"}]},{"type":"block","id":"i8yWWaxvONURO2pHTgsG6","margin":"","level":2,"name":"head","location":{"start":{"line":43,"column":1,"offset":958},"end":{"line":43,"column":11,"offset":968}},"content":[{"type":"fcode","name":"B","content":["SUB"]}]},{"type":"para","id":"9-EndNrniJfSaWCgc9wIq","margin":"","location":{"start":{"line":45,"column":1,"offset":970},"end":{"line":45,"column":104,"offset":1073}},"text":"text","content":["A special token that returns a reference to the current subroutine, or \"undef\" outside of a subroutine."]},{"type":"block","id":"AK75-FSNOrvZSsFiVF5cq","margin":"","level":3,"name":"head","location":{"start":{"line":47,"column":1,"offset":1075},"end":{"line":47,"column":9,"offset":1083}},"content":["Raku"]},{"type":"block","id":"EtqyscGEBd0EhG1CCVOyZ","margin":"","name":"code","config":[],"location":{"start":{"line":49,"column":1,"offset":1085},"end":{"line":49,"column":14,"offset":1098}},"content":[{"type":"verbatim","value":"&?ROUTINE"}]},{"type":"para","id":"DDYkT842QT6GyRnWMY9ue","margin":"","location":{"start":{"line":51,"column":1,"offset":1100},"end":{"line":51,"column":182,"offset":1281}},"text":"text","content":["Because ",{"type":"fcode","name":"C","content":["&?ROUTINE"]}," gives you the actual ",{"type":"fcode","name":"C","content":["Routine"]}," object (which can be used for introspection), you need to call the ",{"type":"fcode","name":"C","content":[".name"]}," method to get a string with the name of the subroutine."]},{"type":"block","id":"CBLDV2QmykW27iE_I7kS6","margin":"","level":1,"name":"head","location":{"start":{"line":53,"column":1,"offset":1283},"end":{"line":53,"column":9,"offset":1291}},"content":["AUTHOR"]},{"type":"para","id":"y6_RUFKusEy4o6T7TLn0d","margin":"","location":{"start":{"line":55,"column":1,"offset":1293},"end":{"line":55,"column":37,"offset":1329}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"para","id":"6OI8yu1v_Lk1cJzSSpf1A","margin":"","location":{"start":{"line":57,"column":1,"offset":1331},"end":{"line":57,"column":105,"offset":1435}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/P5__FILE","type":"fcode","name":"L","content":["https://github.com/lizmat/P5__FILE"]},"__ . Comments and Pull Requests are welcome."]},{"type":"block","id":"DNjBhQJUEvGN9pVAS3Y4G","margin":"","level":1,"name":"head","location":{"start":{"line":59,"column":1,"offset":1437},"end":{"line":59,"column":24,"offset":1460}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"t-Wtcvflt6w_uQ4cmLrZ4","margin":"","location":{"start":{"line":61,"column":1,"offset":1462},"end":{"line":61,"column":53,"offset":1514}},"text":"text","content":["Copyright 2018, 2019, 2020, 2021 Elizabeth Mattijsen"]},{"type":"para","id":"SI3mnOk1s4iQIPyGoHy5D","margin":"","location":{"start":{"line":63,"column":1,"offset":1516},"end":{"line":63,"column":58,"offset":1573}},"text":"text","content":["Re-imagined from Perl as part of the CPAN Butterfly Plan."]},{"type":"para","id":"dGq58m5knfy6DyfE-zsEe","margin":"","location":{"start":{"line":65,"column":1,"offset":1575},"end":{"line":65,"column":104,"offset":1678}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Raku port of Perl's __FILE__ and associated functionality","dist":"P5__FILE__:ver<0.0.6>:auth<zef:lizmat>","license":"Artistic-2.0","name":"P5__FILE__","path":"P/5_/P5__FILE__/351a4fe20823126a669f4a417ce8d2407f837d35.tar.gz","perl":"6.c","provides":{"P5__FILE__":"lib/P5__FILE__.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/P5__FILE__.git","tags":["PERL5","CPAN5"],"test-depends":[],"version":"0.0.6"},"files":[{"file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md","publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/README.md"},{"file":"work_mods/zef/P5__FILE__/P5__FILE__-0.0.6/lib/P5__FILE__.rakumod","publishUrl":"/mods/zef/P5__FILE__/P5__FILE__-0.0.6/lib/P5__FILE__.rakumod"}],"src":"zef","url":"/mods/zef/P5__FILE__"}}}
    =end data
    =end React


root

para

L<Examples| file:../examples/index.podlite>


L<Download |file:../download/index.podlite>


=begin React :component<HeaderCol> :id<menu> 
=para L<Documentation|/doc/introduction>
=para L<Modules| /mods>
=para L<Examples| file:../examples/index.podlite>
=para L<Download |file:../download/index.podlite>
=para L<About|file:../about/index.podlite>
=para 🔍 K<⌘K>/K<ctrl-K>
=end React


HEADER

FOOTER

P5__FILE__


=begin data
{"type":"page","file":"work_mods/zef/P5-X/P5-X-0.0.9/README.md","sources":[],"node":{"type":"block","id":"HiUCts_FANgZxXWrdQv59","margin":"","name":"root","content":[{"type":"para","id":"bDxmjc0-lZKwwAaGvJaKi","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":117,"offset":116}},"text":"text","content":[{"meta":"https://github.com/lizmat/P5-X/actions","type":"fcode","name":"L","content":[{"type":"block","id":"2UYR3D1FInVg1xWbOs5AU","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":76,"offset":75}},"content":[{"type":"image","src":"https://github.com/lizmat/P5-X/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"T2K67AfK4xykdLgH3aC7B","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":118},"end":{"line":3,"column":7,"offset":124}},"content":["NAME"]},{"type":"para","id":"i3GA1t6FcgrDfORHrVHB9","margin":"","location":{"start":{"line":5,"column":1,"offset":126},"end":{"line":5,"column":33,"offset":158}},"text":"text","content":["Raku port of Perl's -X built-ins"]},{"type":"block","id":"RQeYWTpKG2JpxqxqOr5VM","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":160},"end":{"line":7,"column":11,"offset":170}},"content":["SYNOPSIS"]},{"type":"block","id":"2W37mB2v22GF21j0B_mOJ","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":172},"end":{"line":9,"column":51,"offset":222}},"content":[{"type":"verbatim","value":"use P5-X; # exports -r -w -x -e -d -f -l -s -z"}]},{"type":"block","id":"TGdNu6518KX_NDRvYTuE_","margin":"","level":1,"name":"head","location":{"start":{"line":11,"column":1,"offset":224},"end":{"line":11,"column":14,"offset":237}},"content":["DESCRIPTION"]},{"type":"para","id":"zGlpyxDyU5L1qfq6XJrrO","margin":"","location":{"start":{"line":13,"column":1,"offset":239},"end":{"line":13,"column":123,"offset":361}},"text":"text","content":["This module tries to mimic the behaviour of Perl's ",{"type":"fcode","name":"C","content":["-X"]}," built-ins as closely as possible in the Raku Programming Language."]},{"type":"block","id":"R8z1_HsjPdA5MDFsTqpOn","margin":"","level":1,"name":"head","location":{"start":{"line":15,"column":1,"offset":363},"end":{"line":15,"column":18,"offset":380}},"content":["PORTING CAVEATS"]},{"type":"para","id":"vZG4k7xlNuwVZx6K_3hsS","margin":"","location":{"start":{"line":17,"column":1,"offset":382},"end":{"line":17,"column":203,"offset":584}},"text":"text","content":["In future language versions of Raku, it will become impossible to access the ",{"type":"fcode","name":"C","content":["$_"]}," variable of the caller's scope, because it will not have been marked as a dynamic variable. So please consider changing:"]},{"type":"block","id":"fu_IQwfwPbadNrvyBVexR","margin":"","name":"code","config":[],"location":{"start":{"line":19,"column":1,"offset":586},"end":{"line":19,"column":8,"offset":593}},"content":[{"type":"verbatim","value":"-f;"}]},{"type":"para","id":"p4li2n2EQWZ6fcQ_HPr8v","margin":"","location":{"start":{"line":21,"column":1,"offset":595},"end":{"line":21,"column":4,"offset":598}},"text":"text","content":["to:"]},{"type":"block","id":"9GDgcFd1-SLhHe8A06zaa","margin":"","name":"code","config":[],"location":{"start":{"line":23,"column":1,"offset":600},"end":{"line":23,"column":11,"offset":610}},"content":[{"type":"verbatim","value":"-f $_;"}]},{"type":"block","id":"ehwdtFj2EGhCvakAS0aUM","margin":"","level":1,"name":"head","location":{"start":{"line":25,"column":1,"offset":612},"end":{"line":25,"column":9,"offset":620}},"content":["AUTHOR"]},{"type":"para","id":"Q4SCYMjGbgGnGlz096FCp","margin":"","location":{"start":{"line":27,"column":1,"offset":622},"end":{"line":27,"column":37,"offset":658}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"para","id":"WM9LvXOVR-rHl1Jq-UREo","margin":"","location":{"start":{"line":29,"column":1,"offset":660},"end":{"line":29,"column":99,"offset":758}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/P5-X","type":"fcode","name":"L","content":["https://github.com/lizmat/P5-X"]}," . Comments and Pull Requests are welcome."]},{"type":"block","id":"yGHY0AHhkOJG2uFJWwgjR","margin":"","level":1,"name":"head","location":{"start":{"line":31,"column":1,"offset":760},"end":{"line":31,"column":24,"offset":783}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"lJsOQfvxlft74NNPcScaP","margin":"","location":{"start":{"line":33,"column":1,"offset":785},"end":{"line":33,"column":53,"offset":837}},"text":"text","content":["Copyright 2018, 2019, 2020, 2021 Elizabeth Mattijsen"]},{"type":"para","id":"HD1M9RRZCBCboZxWtZyzk","margin":"","location":{"start":{"line":35,"column":1,"offset":839},"end":{"line":35,"column":58,"offset":896}},"text":"text","content":["Re-imagined from Perl as part of the CPAN Butterfly Plan."]},{"type":"para","id":"_Pb52_8CKiP9-MoLnruFO","margin":"","location":{"start":{"line":37,"column":1,"offset":898},"end":{"line":37,"column":104,"offset":1001}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Raku port of Perl's -X built-ins","dist":"P5-X:ver<0.0.9>:auth<zef:lizmat>","license":"Artistic-2.0","name":"P5-X","path":"P/5X/P5X/ba9b894c09d2bdd1e983f3740a7ff4add8e692e0.tar.gz","perl":"6.c","provides":{"P5-X":"lib/P5-X.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/P5-X.git","tags":["PERL5","CPAN5"],"test-depends":[],"version":"0.0.9"},"files":[{"file":"work_mods/zef/P5-X/P5-X-0.0.9/README.md","publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/README.md"},{"file":"work_mods/zef/P5-X/P5-X-0.0.9/lib/P5-X.rakumod","publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/lib/P5-X.rakumod"}],"src":"zef","url":"/mods/zef/P5-X"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/P5-X/P5-X-0.0.9/README.md","sources":[],"node":{"type":"block","id":"HiUCts_FANgZxXWrdQv59","margin":"","name":"root","content":[{"type":"para","id":"bDxmjc0-lZKwwAaGvJaKi","margin":"","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":117,"offset":116}},"text":"text","content":[{"meta":"https://github.com/lizmat/P5-X/actions","type":"fcode","name":"L","content":[{"type":"block","id":"2UYR3D1FInVg1xWbOs5AU","margin":"","name":"Image","config":[],"location":{"start":{"line":1,"column":2,"offset":1},"end":{"line":1,"column":76,"offset":75}},"content":[{"type":"image","src":"https://github.com/lizmat/P5-X/workflows/test/badge.svg","alt":"Actions Status"}]}]}]},{"type":"block","id":"T2K67AfK4xykdLgH3aC7B","margin":"","level":1,"name":"head","location":{"start":{"line":3,"column":1,"offset":118},"end":{"line":3,"column":7,"offset":124}},"content":["NAME"]},{"type":"para","id":"i3GA1t6FcgrDfORHrVHB9","margin":"","location":{"start":{"line":5,"column":1,"offset":126},"end":{"line":5,"column":33,"offset":158}},"text":"text","content":["Raku port of Perl's -X built-ins"]},{"type":"block","id":"RQeYWTpKG2JpxqxqOr5VM","margin":"","level":1,"name":"head","location":{"start":{"line":7,"column":1,"offset":160},"end":{"line":7,"column":11,"offset":170}},"content":["SYNOPSIS"]},{"type":"block","id":"2W37mB2v22GF21j0B_mOJ","margin":"","name":"code","config":[],"location":{"start":{"line":9,"column":1,"offset":172},"end":{"line":9,"column":51,"offset":222}},"content":[{"type":"verbatim","value":"use P5-X; # exports -r -w -x -e -d -f -l -s -z"}]},{"type":"block","id":"TGdNu6518KX_NDRvYTuE_","margin":"","level":1,"name":"head","location":{"start":{"line":11,"column":1,"offset":224},"end":{"line":11,"column":14,"offset":237}},"content":["DESCRIPTION"]},{"type":"para","id":"zGlpyxDyU5L1qfq6XJrrO","margin":"","location":{"start":{"line":13,"column":1,"offset":239},"end":{"line":13,"column":123,"offset":361}},"text":"text","content":["This module tries to mimic the behaviour of Perl's ",{"type":"fcode","name":"C","content":["-X"]}," built-ins as closely as possible in the Raku Programming Language."]},{"type":"block","id":"R8z1_HsjPdA5MDFsTqpOn","margin":"","level":1,"name":"head","location":{"start":{"line":15,"column":1,"offset":363},"end":{"line":15,"column":18,"offset":380}},"content":["PORTING CAVEATS"]},{"type":"para","id":"vZG4k7xlNuwVZx6K_3hsS","margin":"","location":{"start":{"line":17,"column":1,"offset":382},"end":{"line":17,"column":203,"offset":584}},"text":"text","content":["In future language versions of Raku, it will become impossible to access the ",{"type":"fcode","name":"C","content":["$_"]}," variable of the caller's scope, because it will not have been marked as a dynamic variable. So please consider changing:"]},{"type":"block","id":"fu_IQwfwPbadNrvyBVexR","margin":"","name":"code","config":[],"location":{"start":{"line":19,"column":1,"offset":586},"end":{"line":19,"column":8,"offset":593}},"content":[{"type":"verbatim","value":"-f;"}]},{"type":"para","id":"p4li2n2EQWZ6fcQ_HPr8v","margin":"","location":{"start":{"line":21,"column":1,"offset":595},"end":{"line":21,"column":4,"offset":598}},"text":"text","content":["to:"]},{"type":"block","id":"9GDgcFd1-SLhHe8A06zaa","margin":"","name":"code","config":[],"location":{"start":{"line":23,"column":1,"offset":600},"end":{"line":23,"column":11,"offset":610}},"content":[{"type":"verbatim","value":"-f $_;"}]},{"type":"block","id":"ehwdtFj2EGhCvakAS0aUM","margin":"","level":1,"name":"head","location":{"start":{"line":25,"column":1,"offset":612},"end":{"line":25,"column":9,"offset":620}},"content":["AUTHOR"]},{"type":"para","id":"Q4SCYMjGbgGnGlz096FCp","margin":"","location":{"start":{"line":27,"column":1,"offset":622},"end":{"line":27,"column":37,"offset":658}},"text":"text","content":["Elizabeth Mattijsen ",{"meta":"mailto:liz@raku.rocks","type":"fcode","name":"L","content":["liz@raku.rocks"]}]},{"type":"para","id":"WM9LvXOVR-rHl1Jq-UREo","margin":"","location":{"start":{"line":29,"column":1,"offset":660},"end":{"line":29,"column":99,"offset":758}},"text":"text","content":["Source can be located at: ",{"meta":"https://github.com/lizmat/P5-X","type":"fcode","name":"L","content":["https://github.com/lizmat/P5-X"]}," . Comments and Pull Requests are welcome."]},{"type":"block","id":"yGHY0AHhkOJG2uFJWwgjR","margin":"","level":1,"name":"head","location":{"start":{"line":31,"column":1,"offset":760},"end":{"line":31,"column":24,"offset":783}},"content":["COPYRIGHT AND LICENSE"]},{"type":"para","id":"lJsOQfvxlft74NNPcScaP","margin":"","location":{"start":{"line":33,"column":1,"offset":785},"end":{"line":33,"column":53,"offset":837}},"text":"text","content":["Copyright 2018, 2019, 2020, 2021 Elizabeth Mattijsen"]},{"type":"para","id":"HD1M9RRZCBCboZxWtZyzk","margin":"","location":{"start":{"line":35,"column":1,"offset":839},"end":{"line":35,"column":58,"offset":896}},"text":"text","content":["Re-imagined from Perl as part of the CPAN Butterfly Plan."]},{"type":"para","id":"_Pb52_8CKiP9-MoLnruFO","margin":"","location":{"start":{"line":37,"column":1,"offset":898},"end":{"line":37,"column":104,"offset":1001}},"text":"text","content":["This library is free software; you can redistribute it and/or modify it under the Artistic License 2.0."]}]},"publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"","auth":"zef:lizmat","authors":["Elizabeth Mattijsen"],"build-depends":[],"depends":[],"description":"Raku port of Perl's -X built-ins","dist":"P5-X:ver<0.0.9>:auth<zef:lizmat>","license":"Artistic-2.0","name":"P5-X","path":"P/5X/P5X/ba9b894c09d2bdd1e983f3740a7ff4add8e692e0.tar.gz","perl":"6.c","provides":{"P5-X":"lib/P5-X.rakumod"},"resources":[],"source-url":"https://github.com/lizmat/P5-X.git","tags":["PERL5","CPAN5"],"test-depends":[],"version":"0.0.9"},"files":[{"file":"work_mods/zef/P5-X/P5-X-0.0.9/README.md","publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/README.md"},{"file":"work_mods/zef/P5-X/P5-X-0.0.9/lib/P5-X.rakumod","publishUrl":"/mods/zef/P5-X/P5-X-0.0.9/lib/P5-X.rakumod"}],"src":"zef","url":"/mods/zef/P5-X"}}}
    =end data
    =end React


Raku port of Perl's -X built-ins


P5-X


Abstract representation of a filesystem layout


=begin data
{"type":"page","file":"work_mods/zef/Oyatul/Oyatul-0.0.8/README.md","sources":[],"node":{"type":"block","id":"uT0IFB7wX-F2ByWgftr1z","margin":"","name":"root","content":[{"type":"block","id":"o6AXK3zxomA4ckFblSjdU","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":9,"offset":8}},"content":["Oyatul"]},{"type":"para","id":"2t-aJ2OTNT59utpfPCjUg","margin":"","location":{"start":{"line":3,"column":1,"offset":10},"end":{"line":3,"column":47,"offset":56}},"text":"text","content":["Abstract representation of a filesystem layout"]},{"type":"para","id":"ZAoUCvncZL_Vi3iVI_quN","margin":"","location":{"start":{"line":5,"column":1,"offset":58},"end":{"line":5,"column":79,"offset":136}},"text":"text","content":[{"type":"block","id":"EX4NrX1AsDVUbSiigp63j","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":58},"end":{"line":5,"column":79,"offset":136}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/Tinky/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"WJ6srht-doqzuFo4ah38h","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":138},"end":{"line":7,"column":12,"offset":149}},"content":["Synopsis"]},{"type":"para","id":"nkQhxSVwgapQK5CFZqEUS","margin":"","location":{"start":{"line":9,"column":1,"offset":151},"end":{"line":11,"column":16,"offset":303}},"text":"text","content":["This runs the tests identified by 'purpose' test which can be in any\nlocation in the layout with the library directory identified by the\npurpose 'lib' :"]},{"type":"block","id":"FBo6wXsgccLIgJMwaKkli","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":13,"column":1,"offset":305},"end":{"line":54,"column":4,"offset":1234}},"content":[{"type":"verbatim","value":"use Oyatul;\n\nmy $description = q:to/LAY/;\n{\n   \"type\" : \"layout\",\n   \"children\" : [\n      {\n         \"name\" : \"t\",\n         \"purpose\" : \"tests\",\n         \"type\" : \"directory\",\n         \"children\" : [\n            {\n               \"type\" : \"file\",\n               \"purpose\" : \"test\",\n               \"template\" : true\n            }\n         ]\n      },\n      {\n         \"type\" : \"directory\",\n         \"purpose\" : \"lib\",\n         \"name\" : \"lib\",\n         \"children\" : []\n      }\n   ]\n}\nLAY\n\n# the :real adverb causes instance nodes to be inserted\n# for any templates if they exist.\nmy $layout = Oyatul::Layout.from-json($description, root => $*CWD.Str, :real);\n\n# get the directory that stands in for 'lib'\nmy $lib = $layout.nodes-for-purpose('lib').first.path;\n\n# get all the instances for 'test' excluding the template\nfor $layout.nodes-for-purpose('test', :real) -> $test {\n\trun($*EXECUTABLE, '-I', $lib, $test.path);\n}\n"}]},{"type":"block","id":"2D_saoXtysyipOAjBzhlz","margin":"","level":2,"name":"head","location":{"start":{"line":56,"column":1,"offset":1236},"end":{"line":56,"column":15,"offset":1250}},"content":["Description"]},{"type":"para","id":"t6MwVXv-KPAvkcGEBWxCB","margin":"","location":{"start":{"line":58,"column":1,"offset":1252},"end":{"line":59,"column":8,"offset":1331}},"text":"text","content":["This provides a method of describing a filesystem layout in an abstract\nmanner."]},{"type":"para","id":"AfJHtOGhcKi6_YAKjc3Q5","margin":"","location":{"start":{"line":61,"column":1,"offset":1333},"end":{"line":64,"column":45,"offset":1582}},"text":"text","content":["It can be used in the deployment of applications which might need\nthe creation of a directory tree for data or configuration, or for\napplications which may need to locate files and directory that it needs\nbut can allow the user to define their own ."]},{"type":"para","id":"HYzCYLp50cxtyycBKM30Q","margin":"","location":{"start":{"line":66,"column":1,"offset":1584},"end":{"line":67,"column":57,"offset":1712}},"text":"text","content":["The file layout descriptions can be stored as JSON or they can be built\nprogrammatically (thus allowing other forms of storage.)"]},{"type":"para","id":"7pOX6QlaoZnvbWOH8IIf0","margin":"","location":{"start":{"line":69,"column":1,"offset":1714},"end":{"line":76,"column":27,"offset":2235}},"text":"text","content":["The description can define directories and files in an aribitrary tree\nstructure, each can optionally define a 'purpose' which can be used to\nlocate a node irrespective of its location in the tree and name, a node\nobject can also be given a role with the 'does' key which can give the\nnode additional behaviours (e.g. create a file of a specific format,\ncreate an object based on a file or directory etc.) Template nodes can\nbe defined which can stand in for real files or directories which can\nbe discovered at run-time."]},{"type":"para","id":"sMq0VsH6eSL8vgClsmkd3","margin":"","location":{"start":{"line":78,"column":1,"offset":2237},"end":{"line":85,"column":51,"offset":2779}},"text":"text","content":["This is based on a design that I used in a large application that relied\nheavily on file storage for its data, but is somewhat more simplified\nand abstracted as well as preferring JSON over the original XML for the\nstorage of the layout description. The features are designed to allow\n",{"meta":"https://github.com/jonathanstowe/Sofa","type":"fcode","name":"L","content":["Sofa"]}," to load a CouchDB design\ndocument from an arbitrary (possibly user defined) file hierarchy unlike\n",{"type":"fcode","name":"C","content":["couchapp"]}," which requires a fixed directory structure. However\nhopefully it will be useful in other applications."]},{"type":"block","id":"WTDEDdCDs-qQVHgoLkEog","margin":"","level":2,"name":"head","location":{"start":{"line":87,"column":1,"offset":2781},"end":{"line":87,"column":16,"offset":2796}},"content":["Installation"]},{"type":"para","id":"AIRnCMKosAe6alEHzEQX2","margin":"","location":{"start":{"line":89,"column":1,"offset":2798},"end":{"line":89,"column":96,"offset":2893}},"text":"text","content":["Assuming you have a working Rakudo installation you should be able to install this with ",{"type":"fcode","name":"I","content":["zef"]}," :"]},{"type":"block","id":"eLzJlzZwVpe2BqRAwGX1R","margin":"","name":"code","config":[],"location":{"start":{"line":91,"column":1,"offset":2895},"end":{"line":97,"column":23,"offset":2996}},"content":[{"type":"verbatim","value":"# From the source directory\n\nzef install .\n\n# Remote installation\n\nzef install Oyatul"}]},{"type":"block","id":"fqU5T_bd9ij7gPgxzjQaD","margin":"","level":2,"name":"head","location":{"start":{"line":99,"column":1,"offset":2998},"end":{"line":99,"column":11,"offset":3008}},"content":["Support"]},{"type":"para","id":"u1aq1pk4XxOmVHg-TiMVE","margin":"","location":{"start":{"line":101,"column":1,"offset":3010},"end":{"line":101,"column":98,"offset":3107}},"text":"text","content":["Suggestions and patches that may make it more useful in your software are welcomed via github at:"]},{"type":"para","id":"olYF2EdmDtxmyy0KrtZbn","margin":"","location":{"start":{"line":103,"column":1,"offset":3109},"end":{"line":103,"column":47,"offset":3155}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/Oyatul/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/Oyatul/issues"]}]},{"type":"block","id":"yZ7Dr63GIKeEAmK1vM5xj","margin":"","level":2,"name":"head","location":{"start":{"line":105,"column":1,"offset":3157},"end":{"line":105,"column":11,"offset":3167}},"content":["Licence"]},{"type":"para","id":"6U0diyXu5DnTlLiSClg7l","margin":"","location":{"start":{"line":107,"column":1,"offset":3169},"end":{"line":107,"column":23,"offset":3191}},"text":"text","content":["This is free software."]},{"type":"para","id":"XSWf0WYqJFOdO2g60eaXO","margin":"","location":{"start":{"line":109,"column":1,"offset":3193},"end":{"line":109,"column":59,"offset":3251}},"text":"text","content":["Please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution"]},{"type":"para","id":"aLlCcakh1paQoU_UqyXf_","margin":"","location":{"start":{"line":111,"column":1,"offset":3253},"end":{"line":111,"column":29,"offset":3281}},"text":"text","content":["© Jonathan Stowe 2016 - 2021"]}]},"publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk>"],"build-depends":[],"depends":["JSON::Fast"],"description":"Abstract representation of a filesystem layout","dist":"Oyatul:ver<0.0.8>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"Oyatul","path":"O/YA/OYATUL/a4f78bb1fdda2e3f71688245370f81ef8a9ec49f.tar.gz","provides":{"Oyatul":"lib/Oyatul.pm"},"raku":"6.*","resources":[],"source-url":"git://github.com/jonathanstowe/Oyatul.git","support":{"bugtracker":"http://github.com/jonathanstowe/Oyatul/issues","email":"jns+git@gellyfish.co.uk","source":"git://github.com/jonathanstowe/Oyatul.git"},"tags":["filesystem","layout","util"],"test-depends":["Test"],"version":"0.0.8"},"files":[{"file":"work_mods/zef/Oyatul/Oyatul-0.0.8/README.md","publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/README.md"},{"file":"work_mods/zef/Oyatul/Oyatul-0.0.8/lib/Oyatul.pm","publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/lib/Oyatul.pm"}],"src":"zef","url":"/mods/zef/Oyatul"}}}
=end data


    =begin React :component<RenderItem>
    =begin data
    {"type":"page","file":"work_mods/zef/Oyatul/Oyatul-0.0.8/README.md","sources":[],"node":{"type":"block","id":"uT0IFB7wX-F2ByWgftr1z","margin":"","name":"root","content":[{"type":"block","id":"o6AXK3zxomA4ckFblSjdU","margin":"","level":1,"name":"head","location":{"start":{"line":1,"column":1,"offset":0},"end":{"line":1,"column":9,"offset":8}},"content":["Oyatul"]},{"type":"para","id":"2t-aJ2OTNT59utpfPCjUg","margin":"","location":{"start":{"line":3,"column":1,"offset":10},"end":{"line":3,"column":47,"offset":56}},"text":"text","content":["Abstract representation of a filesystem layout"]},{"type":"para","id":"ZAoUCvncZL_Vi3iVI_quN","margin":"","location":{"start":{"line":5,"column":1,"offset":58},"end":{"line":5,"column":79,"offset":136}},"text":"text","content":[{"type":"block","id":"EX4NrX1AsDVUbSiigp63j","margin":"","name":"Image","config":[],"location":{"start":{"line":5,"column":1,"offset":58},"end":{"line":5,"column":79,"offset":136}},"content":[{"type":"image","src":"https://github.com/jonathanstowe/Tinky/workflows/CI/badge.svg","alt":"Build Status"}]}]},{"type":"block","id":"WJ6srht-doqzuFo4ah38h","margin":"","level":2,"name":"head","location":{"start":{"line":7,"column":1,"offset":138},"end":{"line":7,"column":12,"offset":149}},"content":["Synopsis"]},{"type":"para","id":"nkQhxSVwgapQK5CFZqEUS","margin":"","location":{"start":{"line":9,"column":1,"offset":151},"end":{"line":11,"column":16,"offset":303}},"text":"text","content":["This runs the tests identified by 'purpose' test which can be in any\nlocation in the layout with the library directory identified by the\npurpose 'lib' :"]},{"type":"block","id":"FBo6wXsgccLIgJMwaKkli","margin":"","name":"code","config":[{"name":"lang","value":"raku","type":"string"}],"location":{"start":{"line":13,"column":1,"offset":305},"end":{"line":54,"column":4,"offset":1234}},"content":[{"type":"verbatim","value":"use Oyatul;\n\nmy $description = q:to/LAY/;\n{\n   \"type\" : \"layout\",\n   \"children\" : [\n      {\n         \"name\" : \"t\",\n         \"purpose\" : \"tests\",\n         \"type\" : \"directory\",\n         \"children\" : [\n            {\n               \"type\" : \"file\",\n               \"purpose\" : \"test\",\n               \"template\" : true\n            }\n         ]\n      },\n      {\n         \"type\" : \"directory\",\n         \"purpose\" : \"lib\",\n         \"name\" : \"lib\",\n         \"children\" : []\n      }\n   ]\n}\nLAY\n\n# the :real adverb causes instance nodes to be inserted\n# for any templates if they exist.\nmy $layout = Oyatul::Layout.from-json($description, root => $*CWD.Str, :real);\n\n# get the directory that stands in for 'lib'\nmy $lib = $layout.nodes-for-purpose('lib').first.path;\n\n# get all the instances for 'test' excluding the template\nfor $layout.nodes-for-purpose('test', :real) -> $test {\n\trun($*EXECUTABLE, '-I', $lib, $test.path);\n}\n"}]},{"type":"block","id":"2D_saoXtysyipOAjBzhlz","margin":"","level":2,"name":"head","location":{"start":{"line":56,"column":1,"offset":1236},"end":{"line":56,"column":15,"offset":1250}},"content":["Description"]},{"type":"para","id":"t6MwVXv-KPAvkcGEBWxCB","margin":"","location":{"start":{"line":58,"column":1,"offset":1252},"end":{"line":59,"column":8,"offset":1331}},"text":"text","content":["This provides a method of describing a filesystem layout in an abstract\nmanner."]},{"type":"para","id":"AfJHtOGhcKi6_YAKjc3Q5","margin":"","location":{"start":{"line":61,"column":1,"offset":1333},"end":{"line":64,"column":45,"offset":1582}},"text":"text","content":["It can be used in the deployment of applications which might need\nthe creation of a directory tree for data or configuration, or for\napplications which may need to locate files and directory that it needs\nbut can allow the user to define their own ."]},{"type":"para","id":"HYzCYLp50cxtyycBKM30Q","margin":"","location":{"start":{"line":66,"column":1,"offset":1584},"end":{"line":67,"column":57,"offset":1712}},"text":"text","content":["The file layout descriptions can be stored as JSON or they can be built\nprogrammatically (thus allowing other forms of storage.)"]},{"type":"para","id":"7pOX6QlaoZnvbWOH8IIf0","margin":"","location":{"start":{"line":69,"column":1,"offset":1714},"end":{"line":76,"column":27,"offset":2235}},"text":"text","content":["The description can define directories and files in an aribitrary tree\nstructure, each can optionally define a 'purpose' which can be used to\nlocate a node irrespective of its location in the tree and name, a node\nobject can also be given a role with the 'does' key which can give the\nnode additional behaviours (e.g. create a file of a specific format,\ncreate an object based on a file or directory etc.) Template nodes can\nbe defined which can stand in for real files or directories which can\nbe discovered at run-time."]},{"type":"para","id":"sMq0VsH6eSL8vgClsmkd3","margin":"","location":{"start":{"line":78,"column":1,"offset":2237},"end":{"line":85,"column":51,"offset":2779}},"text":"text","content":["This is based on a design that I used in a large application that relied\nheavily on file storage for its data, but is somewhat more simplified\nand abstracted as well as preferring JSON over the original XML for the\nstorage of the layout description. The features are designed to allow\n",{"meta":"https://github.com/jonathanstowe/Sofa","type":"fcode","name":"L","content":["Sofa"]}," to load a CouchDB design\ndocument from an arbitrary (possibly user defined) file hierarchy unlike\n",{"type":"fcode","name":"C","content":["couchapp"]}," which requires a fixed directory structure. However\nhopefully it will be useful in other applications."]},{"type":"block","id":"WTDEDdCDs-qQVHgoLkEog","margin":"","level":2,"name":"head","location":{"start":{"line":87,"column":1,"offset":2781},"end":{"line":87,"column":16,"offset":2796}},"content":["Installation"]},{"type":"para","id":"AIRnCMKosAe6alEHzEQX2","margin":"","location":{"start":{"line":89,"column":1,"offset":2798},"end":{"line":89,"column":96,"offset":2893}},"text":"text","content":["Assuming you have a working Rakudo installation you should be able to install this with ",{"type":"fcode","name":"I","content":["zef"]}," :"]},{"type":"block","id":"eLzJlzZwVpe2BqRAwGX1R","margin":"","name":"code","config":[],"location":{"start":{"line":91,"column":1,"offset":2895},"end":{"line":97,"column":23,"offset":2996}},"content":[{"type":"verbatim","value":"# From the source directory\n\nzef install .\n\n# Remote installation\n\nzef install Oyatul"}]},{"type":"block","id":"fqU5T_bd9ij7gPgxzjQaD","margin":"","level":2,"name":"head","location":{"start":{"line":99,"column":1,"offset":2998},"end":{"line":99,"column":11,"offset":3008}},"content":["Support"]},{"type":"para","id":"u1aq1pk4XxOmVHg-TiMVE","margin":"","location":{"start":{"line":101,"column":1,"offset":3010},"end":{"line":101,"column":98,"offset":3107}},"text":"text","content":["Suggestions and patches that may make it more useful in your software are welcomed via github at:"]},{"type":"para","id":"olYF2EdmDtxmyy0KrtZbn","margin":"","location":{"start":{"line":103,"column":1,"offset":3109},"end":{"line":103,"column":47,"offset":3155}},"text":"text","content":[{"meta":"https://github.com/jonathanstowe/Oyatul/issues","type":"fcode","name":"L","content":["https://github.com/jonathanstowe/Oyatul/issues"]}]},{"type":"block","id":"yZ7Dr63GIKeEAmK1vM5xj","margin":"","level":2,"name":"head","location":{"start":{"line":105,"column":1,"offset":3157},"end":{"line":105,"column":11,"offset":3167}},"content":["Licence"]},{"type":"para","id":"6U0diyXu5DnTlLiSClg7l","margin":"","location":{"start":{"line":107,"column":1,"offset":3169},"end":{"line":107,"column":23,"offset":3191}},"text":"text","content":["This is free software."]},{"type":"para","id":"XSWf0WYqJFOdO2g60eaXO","margin":"","location":{"start":{"line":109,"column":1,"offset":3193},"end":{"line":109,"column":59,"offset":3251}},"text":"text","content":["Please see the ",{"meta":"LICENCE","type":"fcode","name":"L","content":["LICENCE"]}," file in the distribution"]},{"type":"para","id":"aLlCcakh1paQoU_UqyXf_","margin":"","location":{"start":{"line":111,"column":1,"offset":3253},"end":{"line":111,"column":29,"offset":3281}},"text":"text","content":["© Jonathan Stowe 2016 - 2021"]}]},"publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/README.md","pluginsData":{"moduleInfo":{"meta":{"api":"1.0","auth":"zef:jonathanstowe","authors":["Jonathan Stowe <jns+git@gellyfish.co.uk>"],"build-depends":[],"depends":["JSON::Fast"],"description":"Abstract representation of a filesystem layout","dist":"Oyatul:ver<0.0.8>:auth<zef:jonathanstowe>","license":"Artistic-2.0","meta-version":"1","name":"Oyatul","path":"O/YA/OYATUL/a4f78bb1fdda2e3f71688245370f81ef8a9ec49f.tar.gz","provides":{"Oyatul":"lib/Oyatul.pm"},"raku":"6.*","resources":[],"source-url":"git://github.com/jonathanstowe/Oyatul.git","support":{"bugtracker":"http://github.com/jonathanstowe/Oyatul/issues","email":"jns+git@gellyfish.co.uk","source":"git://github.com/jonathanstowe/Oyatul.git"},"tags":["filesystem","layout","util"],"test-depends":["Test"],"version":"0.0.8"},"files":[{"file":"work_mods/zef/Oyatul/Oyatul-0.0.8/README.md","publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/README.md"},{"file":"work_mods/zef/Oyatul/Oyatul-0.0.8/lib/Oyatul.pm","publishUrl":"/mods/zef/Oyatul/Oyatul-0.0.8/lib/Oyatul.pm"}],"src":"zef","url":"/mods/zef/Oyatul"}}}
    =end data
    =end React


Oyatul


The Raku Knowledge Base


=begin React :component<HeaderCol> :id<footer>  
=begin nested :!nested
=item1 B<Language>
    =item2 L<Get started|file:../getting-started/getting-started.podlite>
    =item2 L<Why Raku?|/doc/language/faq#Why-should-I-learn-Raku-What's-so-great-about-it>
    =item2 L<Try Raku|https://glot.io/new/raku>
    =item2 L<Raku cheat sheet|https://github.com/Raku/mu/blob/master/docs/Perl6/Cheatsheet/cheatsheet.txt>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<Raku on Exercism|https://exercism.org/tracks/raku>
    =item2 L<Wikipedia|https://en.wikipedia.org/wiki/Raku_(programming_language)>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=begin nested :!nested

=item1 B<L<Documentation|/doc>>
    =item2 L<Getting started, Migration guides from other languages, & Tutorials | file:../doc/introduction.podlite>
    =item2 L<Language References|file:../doc/reference.podlite>
    =item2 L<Type Reference| file:../doc/types.podlite>
    =item2 L<Miscellaneous| file:../doc/miscellaneous.podlite>
    =item2 L<FAQs (Frequently Asked Questions)|/doc/language/faq>
    =item2 L<Community|/doc/language/community>
    =item2 L<The list of all documents|file:../doc/index.podlite>

=item1 B<Resources>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>

=end nested
=begin nested :!nested

=item1 B<Resoures>
    =item2 L<Download | file:../download/index.podlite>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=item1 B<Learning>
    =item2 L<The Raku Guide|https://raku.guide/>
    =item2 L<Wikibook |https://en.wikibooks.org/wiki/Raku_Programming>
    =item2 L<Books |https://perl6book.com/>
    =item2 L<Rosetta Code | https://www.raku.org/community/rosettacode>
    =item2 L<Learn Raku in Y minutes|https://learnxinyminutes.com/docs/raku/>
    =item2 L<Golfing |https://github.com/AlexDaniel/raku-golf-cheatsheet>
=end nested
=begin nested :!nested

=item1 B<Explore>
    =item2 L<Raku Blog Aggregator|https://planet.raku.org/>
    =item2 L<Rakudo Weekly|https://rakudoweekly.blog/>
    =item2 L<The Weekly Challenge |https://perlweeklychallenge.org/>
    =item2 L<Raku Advent Calendar|https://raku-advent.blog/>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>
    =item2 L<empty|#>

=end nested
=end React


=begin React :component<CookieConsent> :id<CookieConsent> :buttonCaption("Got it!")
=para
This website uses cookies for analytics.
=end React


P5FILE

NAME

SYNOPSIS

DESCRIPTION

TERMS

PACKAGE

Raku

FILE

Raku

LINE

Raku

SUB

Raku

AUTHOR

COPYRIGHT AND LICENSE

P5FILE v0.0.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation

NAME

SYNOPSIS

DESCRIPTION

TERMS

PACKAGE

Raku

FILE

Raku

LINE

Raku

SUB

Raku

AUTHOR

COPYRIGHT AND LICENSE

P5__FILE__ v0.0.6

Authors

License

Dependencies

Test Dependencies

Provides

Documentation

P5FILE v0.0.6