x2c 0.1

data/x2c/plug/info.rb

@@ -0,0 +1,86 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+require 'plug/format.rb'
+
+module Xmms
+    # The info calls is used to show stats about Colelctions
+    # and search inside of them
+    #
+    # You can futher select only a certain field for information
+    # by typing info.field
+    class Info
+        include Format
+        def initialize coll = Collection.universe, *info
+            info=[:artist, :album, :title] if info.empty?
+            @coll = coll
+            @info = info
+        end
+        # search str the information object
+        def search str=nil
+            str ||= Readline.readline('search << ')
+            ids = []
+            @info.map do |i|
+                list = xmms.coll_query_info(@coll,[i.to_s,'id']).val.each do |h|
+                    ids << h[:id] if h[i] =~ /#{str}/
+                end
+            end
+            Songlist.new(ids)
+        end
+        def to_s
+            ' '+format('    ', 1337)
+        end
+        def inspect
+            ' '+format('    ', 1337)
+        end
+        # count of infos available
+        def count
+            xmms.coll_query_info(@coll, @info.last.to_s).length
+        end
+        # show the stats
+        def format idt='    ', show=3
+            @info.map do |i|
+                l = xmms.coll_query_info(@coll,i.to_s)
+                return '' if l.length.zero?
+                while l.respond_to?(:val)
+                    l = l.val
+                end
+                min  = [l.length, show].min
+                all  = (min == l.length)
+                "#{l.length} #{i}s:\n#{idt}  #{(l[0...min].map{|a| a.values}+(all ? [] : ['...'])).format(idt+'  ')}"
+            end.join("\n#{idt}")
+        end
+        def method_missing id
+            Info.new @coll, id
+        end
+    end
+    class Collection
+        # the info plugin shows nice stats and makes a collections searchable
+        # * info creates the default info object
+        # * artists, albums, titles, ids and urls show only the specified field
+        # * search will search the collection
+        module Info
+            # creates the info object to show stats
+            def info
+                Xmms::Info.new(self)
+            end
+            alias_forward :artists, :info, :artist
+            alias_forward :albums,  :info, :album
+            alias_forward :titles,  :info, :tilte
+            alias_forward :ids,     :info, :id
+            alias_forward :urls,    :info, :url
+            alias_forward :search,  :info
+
+            alias_method :__inspect, :inspect
+            def inspect
+                __inspect+"\n    "+info.format
+            end
+        end
+        include Info
+    end
+    class Client
+        # you can serach the media library with the s/search command
+        module Search
+            alias_forward :search, :universe
+        end
+        include Search
+    end
+end

data/x2c/plug/iplayback.rb

@@ -0,0 +1,49 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+require 'plug/chains.rb'
+
+module Xmms
+    class Client
+        # the Inteligent Playback module is used to extend the play, pause and skip commands
+        module IPlayback
+            # skip n tracks
+            def skip n=1
+                playlist_set_next_rel n
+                playback_tickle
+            end
+            # pause/unpase
+            def pause
+                if playback_status.val != Xmms::Client::PAUSE
+                    playback_pause
+                else 
+                    playback_start
+                end
+            end
+            # play the last result 
+            def play arg=nil
+                val = case  arg
+                when Collection ; arg.play
+                when Playlist   ; arg.play
+                when Songlist   ; arg.idlist.play
+                when String     ; 
+                    begin
+                        playlist(arg).play
+                    rescue Result::ValueError => e
+                        coll_get(arg).play
+                    rescue Result::ValueError => e
+                        raise Result::ValueError, "can't find valid list or collection #{arg} (#{e})"
+                    end
+                when nil
+                    begin
+                        last ? last.play : current
+                    rescue
+                        nil
+                    end
+                else
+                    raise(Result::ValueError,"Can't play a #{arg.class}")
+                end
+                playback_start.val; ls
+            end
+        end
+        include IPlayback
+    end
+end

data/x2c/plug/listnames.rb

@@ -0,0 +1,43 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+module Xmms
+    class Client
+        # the ListNames plugin gives esay access to saved Collection.
+        # it will create Constances or functions for the name of all collection,
+        # so you can access them by typing there names
+        module ListNames
+            # set up a list
+            def setup_list n
+                s = catch(:warn) do
+                    begin
+                        c = coll_get(n).val
+                        c.name = n
+                        throw(:warn, "constant #{n} already exists") if Client.const_defined?(n)
+                        Client.const_set(n,c)
+                    rescue NameError
+                        throw(:warn, "method #{n} already exists") if self.respond_to?(n)
+                        Client.send :define_method, n.to_sym do
+                            c
+                        end
+                    rescue NameError
+                        throw(:warn,"consider renaming it")
+                    rescue
+                        throw(:warn,"perhaps something is inconsistent")
+                    end;nil
+                end 
+                s && puts("can't create shortcut for #{n}, #{s}")
+            end
+            # sets up constances and methods according to collection names
+            def setup_lists
+                coll_list.each do |n|
+                    setup_list n
+                end
+            end
+        end
+        include ListNames
+    end
+    class Collection
+        after_method_hook :save do |v|
+            xmms.setup_list v.name
+        end rescue nil
+    end
+end

data/x2c/plug/mlib.rb

@@ -0,0 +1,128 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+module Xmms
+    module Format; end
+    module Remember; end
+    # class for browsing media
+    class Media
+        Options['media-dir'=> ["file://#{Dir.pwd}", "path to the root of you muisc dir"]]
+        include Format
+        include Remember
+        attr_reader :path
+        def initialize path=Options['media-dir']
+            @path = path[/^file:\/\//] ? path : 'file://'+path
+        end
+        def format idt='    '
+            'parent <-' + "\n#{idt}" +
+            @path
+        end
+        # parent of file
+        def parent
+            Browse.new(File.dirname(@path))
+        end
+        # returns a new collection of files under current path
+        def media
+            Collection.new_match(:url => "#{@path}%")
+        end
+        # adds media to mlib
+        def mlib_add
+            xmms.medialib_add_entry(@path).val
+        end
+    end
+    # class for browsing media
+    class Browse < Media
+        # list all
+        def list
+            xmms.xform_media_browse @path
+        end
+        # list dir
+        def dirs
+            list.map{|h| h[:isdir].zero? ? nil : h[:path]}.compact.map{|d| d.sub(/^#{@path}\/*/,'')}
+        end
+        # list files
+        def files
+            list.map{|h| h[:isdir].zero? ? h[:path] : nil}.compact.map{|f| f.sub(/^#{@path}\/*/,'')}
+        end
+        def format idt='    '
+            'parent <-' + "\n#{idt}" +
+            dirs.map{|d| d+' ->'}.format + "\n#{idt}" + 
+            files.map.format
+        end
+        # open sub
+        def cd sub
+            if files.include?(sub)
+                Media.new(File.join(@path,sub))
+            else
+                Browse.new(File.join(@path,sub))
+            end
+        end
+        alias_method :[], :cd
+        alias_method :open, :cd
+        alias_method :get, :cd
+        # adds media in path to mlib
+        def mlib_add
+            xmms.medialib_path_import(@path).val
+        end
+    end
+    class PropDict
+        # the Mlib module can change the info for a certain song:
+        # you can rehash it, set some or remove infos.
+        # 
+        # As all is ruby, you can simple edit a hole branch of songs
+        # with thing like each:
+        #  ls.each{|s| s.artist = 'Bar'}
+        #  (artist == foobar).list.each{|s| s.rehash}
+        module Mlib
+            # rehash the info
+            def rehash
+                xmms.medialib_rehash(self[:id]).val
+            end
+            # remove song form media lib
+            def remove!
+                xmms.medialib_entry_remove(self[:id]).val
+            end
+            alias_method :__respond_to?, :respond_to?
+            alias_method :__methods, :methods
+            def respond_to? id
+                __respond_to?(id) || self[id] || ([?=,?!].include?(id.to_s[-1]) && self[id.to_s.chop.to_sym])
+            end
+            def methods
+                k = to_h.keys.map{|k| k.to_s}
+                __methods + k + k.map{|k| k+'='} + k.map{|k| k+'!'}
+            end
+            def method_missing key, val=nil, *args
+                case key.to_s[-1]
+                when ?= ; xmms.medialib_entry_property_set(self[:id], key.to_s.chop.to_sym, val).val
+                when ?! ; xmms.medialib_entry_property_remove(self[:id], key.to_s.chop.to_sym).val
+                else    ; self[key] || raise(NoMethodError,"unknow field #{key}", caller)
+                end
+            end
+        end
+        include Mlib
+    end
+    class Client
+        # the Mlib module is change thing inside the mlib, you
+        # can browse you file system and add pathes or files
+        # or rehash the media lib. Also have a look at PropDict::Mlib
+        # where you can edit the medialib entry of a song
+        module Mlib
+            # browse for new media:
+            #  browse [path]
+            #  cd 'subdir'
+            #  last['file'].mlib_add     # add singlen file
+            #  cd '..'
+            #  cd '..'
+            #  last.open('otherdir')
+            #  mlib_add                 # add other dir
+            #  cd '..'
+            #  get('jod').mlib_add      # add 'jod'
+            def browse path=Options['media-dir']
+                Browse.new path
+            end
+            # rehash media, arg can be a list, collection or id
+            def rehash arg=nil
+                arg ? Song.new(arg).rehash : medialib_rehash(0).val
+            end
+        end
+        include Mlib
+    end
+end

data/x2c/plug/query.rb

@@ -0,0 +1,51 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+module Xmms
+    class Collection
+        # in the middle class to format querys, eg. ((Collection.field == value).field > num) ...
+        class Query
+            def initialize field, base=Collection.default
+                @field = field.to_s
+                @base = base
+            end
+            # with this equals, match, hash, greater, smaller should work
+            [:equals, :match, :greater, :smaller].each do |id|
+                new = "new_#{id.to_s}".to_sym
+                define_method id do |*val|
+                    Collection.send(new, @base, @field=>val[0])
+                end
+            end
+            def ~
+                ~has
+            end
+            def has
+                Collection.new_has(@base, @field=>nil)
+            end
+            def >= val
+                (self>val) | (self==val)
+            end
+            def <= val
+                (self<val) | (self==val)
+            end
+            alias_method :is    , :equals; alias_method :==, :equals
+            alias_method :about , :match ; alias_method :=~, :match
+            alias_method :> , :greater   ; alias_method :< , :smaller
+            alias_method :exist? , :has  ; alias_method :_ , :has
+        end
+        # the Query plugin will give you access to a powerfull way to form querys on the medialib:
+        # for example the following will create a query:
+        #   universe.((artist =~ '%Foob_r').genre == 'Bla').duration > 10000
+        # All fields can bes used with ==, =~, >, <, >=, <= and a string as argument.
+        # you can write ~field and field._, to get all media, where field is unset/set
+        module FormQuery
+            # creates a new query object, used to form querys.
+            # The field of the query is dynamicalle taken form the name of the function.
+            # The type and value has to be specified later.
+            #  artist           => will create a query with the artist field
+            #  artist == 'Foo'  => will specifiy the query as type equal with value 'Foo'
+            def method_missing id
+                Collection::Query.new(id,self)
+            end
+        end
+        include FormQuery
+    end
+end

data/x2c/plug/remember.rb

@@ -0,0 +1,124 @@
+# Copyright by Daniel Waeber, see the LICENSE file for details
+
+# remembers last results, the Xmms::Remember and Client::Remember for details
+module Prompting
+    include Xmms
+    @@lastval = Collection.default
+    @@stackval = []
+    @@gointo = []
+    # retun the stack
+    def stack
+        @@stackval
+    end
+    # unify all Collections on the stack
+    def union
+        stack.inject{|a,b| b.is_a?(Collection) ? a|b : a}
+    end
+    # intersect all Collections on the stack
+    def intersect
+        stack.inject{|a,b| b.is_a?(Collection) ? a&b : a}
+    end
+    # push self to stack
+    def push
+        @@stackval.push self
+    end
+    # pop value form stack
+    def pop
+        @@stackval.pop
+    end
+    # get the prelast value
+    def lost
+        @@lostval.makelast
+    end
+    # return last rememberd value
+    def last
+        @@lastval
+    end
+    # set rememberd value
+    def last= val
+        @@lostval = @@lastval
+        if @@gointo.last
+            @@lastval = val
+            $prompt.set self
+            return nil
+        else
+            @@lastval = val
+        end
+    end
+    # set self to rememberd value
+    def makelast
+        self.last = self unless last==self
+    end
+
+    # set prompt to self and cascade on subwaluse
+    def gointo
+        @@gointo.push true
+        $prompt.push self
+    end
+    # only set the promt to object
+    def activate
+        @@gointo.push false
+        $prompt.push self
+    end
+    # go back to previous prompt
+    def back
+        @@gointo.pop
+        $prompt.pop
+        $prompt.set(xmms) unless $prompt.main
+        makelast
+    end
+    # new formating
+    def to_s
+        self.makelast
+        ((last==self)?'`':' ') + self.format
+    end
+    # new formating
+    def inspect
+        self.makelast
+        ((last==self)?'`':' ') + self.format
+    end
+end
+
+module Xmms
+    class Client
+        # the Remember module is used to remember last results.
+        # You can push the last result on a stack, pop form it or gointo it
+        # all unkonwn methods will be forwarded to the last result
+        module Remember
+            include Prompting
+            def to_s;   format end
+            def inspect;format end
+            # push last value instead of client
+            def push val=last
+                val.push
+            end
+            # gointo last value instead of client
+            def gointo val=last
+                val.gointo
+            end
+            # forward to last
+        dynamic_forward :last
+        end
+        include Remember
+    end
+
+    # include support for being automaticalley remembered
+    # so if you get a result of a type include Remember,
+    # last will be set to the result. 
+    # For more detail on last, see Client::Remember
+    module Remember
+        include Prompting
+    end
+    class Collection
+        include Remember
+    end
+    class Songlist
+        include Remember
+    end
+    class Song
+        include Remember
+    end
+    class Playlist
+        include Remember
+    end
+end