/usr/share/SuperCollider/HelpSource/Classes/Quark.schelp is in supercollider-common 1:3.8.0~repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 | TITLE:: Quark
summary:: Object for managing a Quark - a package of source code
categories:: Quarks
related:: Guides/UsingQuarks, Classes/Quarks
DESCRIPTION::
A Quark is a folder of source code, a package. It may be cloned from a git repository, or maybe not.
This class is used by the Quarks class and you will not usually want to use it directly.
CLASSMETHODS::
METHOD:: new
ARGUMENT:: name
Quark name, git url or local path (absolute or relative)
ARGUMENT:: refspec
returns:: this
METHOD:: fromLocalPath
alternate constructor
ARGUMENT:: path
returns:: this
METHOD:: fromDirectoryEntry
alternate constructor
ARGUMENT:: name
ARGUMENT:: quarkUrl
returns:: this
METHOD:: parseQuarkName
ARGUMENT:: name
ARGUMENT:: refspec
returns:: this
INSTANCEMETHODS::
METHOD:: name
returns:: String
METHOD:: dependencies
Based on the dependencies list in the quark file, returns an array of Quarks.
returns:: Array of Quark
METHOD:: deepDependencies
Declared dependencies of this Quark and those of each dependency.
This will check out all dependencies.
returns:: Array of Quarks
METHOD:: data
Lazily parses the quark file (if found) and caches it
returns:: Dictionary - the contents of the quark file
METHOD:: refspec
Git refspec (tag or sha hash)
returns:: this
METHOD:: localPath
Absolute path where the Quark is located
returns:: this
METHOD:: summary
Summary text from the quark file
returns:: this
METHOD:: url
Git repository url. If not declared when creating, it will examine the checked out git source
and get the origin.
returns:: this
METHOD:: isDownloaded
returns:: Boolean
METHOD:: isInstalled
returns:: Boolean
METHOD:: git
Quarks that have git repos have a Git object that can be used for checking out, listing tags etc.
returns:: a Git object
METHOD:: init
private
ARGUMENT:: argName
ARGUMENT:: argUrl
ARGUMENT:: argRefspec
ARGUMENT:: argLocalPath
returns:: this
METHOD:: install
returns:: this
METHOD:: uninstall
returns:: this
METHOD:: checkout
Clone and checkout the url and refspec.
Used by install and for switching versions.
returns:: this
METHOD:: version
returns:: String
METHOD:: tags
returns:: Array of Strings
METHOD:: isCompatible
Evaluates the 'isCompatible' function in the quarkfile, if there is one.
This allows a quarkfile to check its environment and raise an alarm before it gets installed and breaks something.
returns:: Boolean
METHOD:: definesClasses
Classes that are defined by this Quark
returns:: Array of Classes
METHOD:: definesExtensionMethods
Methods that this Quark defines that overwrite implementations in other packages including in Common.
returns:: Array of Methods
METHOD:: help
Open the help file. Either as specified in the quark file as 'schelp' or searches by the name of the quark.
returns:: this
METHOD:: changed
After un/installing or checking out, state is set to changed.
code smell: this is for the gui
returns:: Boolean
METHOD:: parseDependency
private
ARGUMENT:: dep
returns:: this
METHOD:: printOn
ARGUMENT:: stream
returns:: this
METHOD:: parseQuarkFile
private
returns:: this
|