Sway::Config is a module for parsing L<Sway|https://swaywm.org/> window manager's config,
and getting the raw C<Match>, configs, variables, modes and key bindings, either as Raku data structures or as
JSON.


use v6.d;

use JSON::Fast;

use Sway::Config::Utils:auth($?DISTRIBUTION.meta<auth>) :config, :match;
use Sway::Config::Grammar:auth($?DISTRIBUTION.meta<auth>);
use Sway::Config::Actions:auth($?DISTRIBUTION.meta<auth>);



Sway::Config - a L<Raku|https://www.raku-lang.ir/en> module for parsing L<Sway|https://swaywm.org/> window manager's config.


NAME

DESCRIPTION

code

=begin code :lang<raku>
use Sway::Config:auth<zef:CIAvash>;

# By default Sway::Config gets the config from Sway
my $config = Sway::Config.new;

# Giving the config content to Sway::Config
my $config2 = Sway::Config.new: :config('Your Config Here');

# Giving path of a config file to Sway::Config
my $config3 = Sway::Config.new: :config_path<Path to config file>;

put $config.match;

put $config.mode<resize>;

put $config.configs: :json;

=end code


SYNOPSIS

You need to have L<Raku|https://www.raku-lang.ir/en> and L<zef|https://github.com/ugexe/zef>,
then run:


=begin code :lang<console>

zef install --/test "Sway::Config:auth<zef:CIAvash>"

=end code


=begin code :lang<console>

zef install .

=end code


INSTALLATION

=begin code :lang<console>

prove -ve 'raku -I.' --ext rakutest

=end code


TESTING


unit class Sway::Config:auth($?DISTRIBUTION.meta<auth>):ver($?DISTRIBUTION.meta<version>);



ATTRIBUTES


has Str   $.config;      #= Content of the config to parse
has IO()  $.config_path; #= Path to the config file

has Match $!match;       #= The raw match object



METHODS


submethod TWEAK {
    my $config_dir;

    $!config_path //= get_config_path;

    with $!config_path {
        $config_dir = .parent;
        $!config //= .slurp;
    }

    unless $!config or ($!config_path and $!config_path.f) {
        note 'Sway::Config: Need at least a config or/and a config path' and exit 1;
    }

    $!match = Sway::Config::Grammar.subparse: $!config, actions => Sway::Config::Actions.new: :$config_dir;
}

#| Returns the raw match object
multi method match returns Match {
    $!match;
}

#| Returns the raw C<Match> object as JSON
multi method match (Bool:D :json($) --> Str) {
    to-json :sorted-keys, match_to_strs $!match;
}

#| Returns the parsed confis as an C<Array>
multi method configs returns Array {
    $!match.made;
}

#| Returns the parsed confis as JSON
multi method configs (Bool:D :json($) --> Str) {
    to-json callsame;
}

#| Returns the parsed variables as a C<Hash>
multi method variable returns Hash {
    $!match.actions.variable;
}

#| Returns the parsed variables as JSON
multi method variable (Bool:D :json($) --> Str) {
    to-json :sorted-keys, callsame;
}

#| Returns the parsed modes as a C<Hash>
multi method mode returns Hash {
    $!match.actions.mode;
}

#| Returns the parsed modes as JSON
multi method mode (Bool:D :json($) --> Str) {
    to-json :sorted-keys, callsame;
}

#| Returns the parsed key bindings as a C<Hash>
multi method key_binding returns Hash {
    $!match.actions.key_binding;
}

#| Returns the parsed key bindings as JSON (Object/Hash)
multi method key_binding (Bool:D :json($) --> Str) {
    to-json :sorted-keys, callsame;
}

#| Returns the parsed key bindings as a C<List>
multi method key_bindings returns List {
    $!match.actions.key_bindings;
}

#| Returns the parsed key bindings as JSON (Array)
multi method key_bindings (Bool:D :json($) --> Str) {
    to-json :sorted-keys, callsame;
}

#| Returns the parsed configs, variables, modes and key bindings as a C<Hash>
multi method all returns Hash {
    {
        configs => self.configs,
        variable => self.variable,
        mode => self.mode,
        key_binding => self.key_binding,
        key_bindings => self.key_bindings,
    };
}

#| Returns the parsed configs, variables, modes and key bindings as JSON
multi method all (Bool:D :json($) --> Str) {
    to-json :sorted-keys, callsame;
}



L<https://github.com/CIAvash/Sway-Config/>


REPOSITORY

L<https://github.com/CIAvash/Sway-Config/issues>


Siavash Askari Nasr - L<https://www.ciavash.name>


AUTHOR

COPYRIGHT

Sway::Config is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.


Sway::Config is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.


You should have received a copy of the GNU Lesser General Public License
along with Sway::Config.  If not, see <http://www.gnu.org/licenses/>.


LICENSE

root

Actions

README

React

=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


=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


Sway::Config - a Raku module for parsing Sway window manager's config.

NAME

SYNOPSIS

INSTALLATION

TESTING

ATTRIBUTES

METHODS

REPOSITORY

BUG

AUTHOR

COPYRIGHT

LICENSE

Sway::Config v0.1.0

Authors

License

Dependencies

Test Dependencies

Provides

Documentation