• Home
• pl.mareklangiewicz
• kommandline
• 0.0.87
• source code
• GnomeExt.kt

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

commonMain.gnome.GnomeExt.kt Maven / Gradle / Ivy

@file:Suppress("unused", "ClassName")

package pl.mareklangiewicz.kommand.gnome

import pl.mareklangiewicz.kground.*
import pl.mareklangiewicz.kommand.Kommand
import pl.mareklangiewicz.kommand.gnome.GnomeExt.Cmd
import pl.mareklangiewicz.kommand.gnome.GnomeExt.Cmd.*

/** [gnome-extensions ubuntu manpage](http://manpages.ubuntu.com/manpages/impish/man1/gnome-extensions.1.html) */
fun gnomeext(cmd: Cmd, init: GnomeExt.() -> Unit = {}) = GnomeExt(cmd).apply(init)

/** [gnome-extensions ubuntu manpage](http://manpages.ubuntu.com/manpages/impish/man1/gnome-extensions.1.html) */
data class GnomeExt(
  var cmd: Cmd = Help(),
  val options: MutableList = mutableListOf(),
) : Kommand {
  override val name get() = "gnome-extensions"
  override val args get() = cmd.str + options.map { it.str } plusIfNN (cmd as? Install)?.pack

  sealed class Cmd(val name: String, open val uuid: String? = null) {
    open val str get() = listOf(name) plusIfNN uuid

    /** Displays a short synopsis of the available commands or provides detailed help on a specific command. */
    data class Help(val cmdname: String? = null) : Cmd("help") {
      override val str get() = listOf(name) plusIfNN cmdname
    }
    /** Prints the program version. */
    data object Version : Cmd("version")

    /**
     * Enables the extension identified by UUID.
     * The command will not detect any errors from the extension itself,
     * use the info command to confirm that the extension state is ENABLED.
     * If the extension is already enabled, the command will do nothing.
     */
    data class Enable(override val uuid: String) : Cmd("enable", uuid)
    /** Disables the extension identified by UUID. If the extension is not enabled, the command will do nothing. */
    data class Disable(override val uuid: String) : Cmd("disable", uuid)

    /**
     * Reset the extension identified by UUID.
     * The extension will be disabled in GNOME, but may be enabled by other sessions like GNOME Classic.
     */
    data class Reset(override val uuid: String) : Cmd("reset", uuid)

    /** Show details of the extension identified by UUID, including name, description and state. */
    data class Info(override val uuid: String) : Cmd("info", uuid)
    /** Synonym of info. */
    data class Show(override val uuid: String) : Cmd("show", uuid)
    /** Displays a list of installed extensions. */
    data object List : Cmd("list")
    /** Open the preference dialog of the extension identified by UUID. */
    data class Prefs(override val uuid: String) : Cmd("prefs", uuid)
    /** Creates a new extension from a template. */
    data object Create : Cmd("create")

    /**
     * Creates an extension bundle that is suitable for publishing.
     * The bundle will always include the required files extension.js and metadata.json, as well as the optional
     * stylesheet.css and prefs.js if found. Each additional source that should be included must be specified
     * with --extra-source.
     * If the extension includes one or more GSettings schemas, they can either be placed in a schemas/ folder to
     * be picked up automatically, or be specified with --schema.
     * Similarily, translations are included automatically when they are located in a po/ folder, otherwise the
     * --podir option can be used to point to the correct directory. If no gettext domain is provided on the
     * command line, the value of the gettext-domain metadata field is used if it exists, and the extension UUID
     * if not.
     * All files are searched in SOURCE-DIRECTORY if specified, or the current directory otherwise.
     */
    data object Pack : Cmd("pack")

    /**
     * Installs an extension from the bundle PACK.
     * The command unpacks the extension files and moves them to the expected location in the user’s $HOME, so
     * that it will be loaded in the next session.
     * It is mainly intended for testing, not as a replacement for GNOME Software or the extension website. As
     * extensions have privileged access to the user’s session, it is advised to never load extensions from
     * untrusted sources without carefully reviewing their content.
     */
    data class Install(val pack: String) : Cmd("install")
    /** Uninstalls the extension identified by UUID. */
    data class Uninstall(override val uuid: String) : Cmd("uninstall", uuid)
  }

  sealed class Option(val name: String, val arg: String? = null) {
    val str get() = arg?.let { "$name=$arg" } ?: name

    // common options:
    /** Do not print error messages */
    data object Quiet : Option("--quiet")

    // options for list cmd:
    data object User : Option("--user")
    data object System : Option("--system")
    data object Enabled : Option("--enabled")
    data object Disabled : Option("--disabled")
    data object Prefs : Option("--prefs")
    data object Updates : Option("--updates")
    data object Details : Option("--details")

    // options for create cmd:
    data class Extname(val n: String) : Option("--name", n)
    data class Extdesc(val d: String) : Option("--description", d)
    data class Extuuid(val u: String) : Option("--uuid", u)
    data class Template(val t: String) : Option("--template", t)
    data object Interactive : Option("--interactive")

    // options for pack cmd:
    data class Extrasource(val path: String) : Option("--extra-source", path)
    data class Schema(val s: String) : Option("--schema", s)
    data class Podir(val p: String) : Option("--podir", p)
    data class Gettextdomain(val d: String) : Option("--gettext-domain", d)
    data class Outdir(val d: String) : Option("--out-dir", d)
    data object Force : Option("--force") // also for install cmd
  }

  operator fun Option.unaryMinus() = options.add(this)
}