colours 0.5.55

data/lib/colours/colour_methods/sfancy.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sfancy.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sfancy
+  #
+  # Invocation example:
+  #   Colours.sfancy('Hello world!')
+  # ========================================================================= #
+  def self.sfancy(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Colours.efancy
+  #
+  # This simply will output the result from sfancy(), defined above.
+  # ========================================================================= #
+  def self.efancy(
+      i            = '',
+      make_newline = false
+    )
+    e sfancy(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === efancy
+  # ========================================================================= #
+  def efancy(
+      i            = '',
+      make_newline = false
+    )
+    Colours.efancy(i, make_newline)
+  end; alias f efancy # === f (f tag)
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    ::Colours.sfancy(i)
+  end
+
+  # ========================================================================= #
+  # === cif
+  #
+  # This is efancy, but we won't use newlines.
+  # ========================================================================= #
+  def cif(i)
+    efancy(i, false)
+  end; alias ff cif # === ff (alias to the above ^^^)
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sfancy('Hello world!')
+end

data/lib/colours/colour_methods/sfile.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/sfile.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_256_colours.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.sfile
+  #
+  # This method can be explicitely used to colour files, such as
+  # '/opt/foobar.rb'.
+  #
+  # Invocation examples:
+  #
+  #   Colours.sfile('/opt/foobar.rb')
+  #   Colours.sfile('/tmp/test.md')
+  #   Colours.sfile('Hello world!')
+  #
+  # ========================================================================= #
+  def self.sfile(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    ::Colours.sfile(i)
+  end
+
+  # ========================================================================= #
+  # === efile
+  # ========================================================================= #
+  def efile(
+      i            = '',
+      make_newline = false
+    )
+    e sfile(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.sfile('Hello world!')+' And this should appear in another colour.'
+end # 

data/lib/colours/colour_methods/simportant.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/simportant.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.simportant
+  #
+  #This method is the one to denote "important" text components.
+  #
+  # Invocation examples:
+  #
+  #   Colours.simportant('Hello world!')
+  #   Colours.simportant('yo there')
+  #
+  # ========================================================================= #
+  def self.simportant(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias simp simportant } # === Colours.simp
+
+  # ========================================================================= #
+  # === simportant
+  #
+  # Delegate towards Colours.simportant() here.
+  # ========================================================================= #
+  def simportant(
+      i            = '',
+      make_newline = false
+    )
+    Colours.simportant(i, make_newline)
+  end; alias simp simportant # === simp
+       alias si   simportant # === si
+
+  # ========================================================================= #
+  # === ciif
+  # ========================================================================= #
+  def ciif(i)
+    eimportant(i, false)
+  end # Alias to the above, basically.
+
+  # ========================================================================= #
+  # === Colours.eimp
+  # ========================================================================= #
+  def self.eimp(
+      i            = '',
+      make_newline = false
+    )
+    e simp(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === eimportant
+  # ========================================================================= #
+  def eimportant(
+      i            = '',
+      make_newline = false
+    )
+    Colours.eimp(i, make_newline)
+  end; alias eimp eimportant # === eimp
+       alias cii  eimportant # === cii
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.simportant('Hello world!')
+end

data/lib/colours/colour_methods/snormal.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/snormal.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.snormal
+  #
+  # Invocation example:
+  #   Colours.snormal('Hello world!')
+  # ========================================================================= #
+  def self.snormal(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === snormal
+  # ========================================================================= #
+  def snormal(
+      i            = '',
+      make_newline = false
+    )
+    Colours.snormal(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === enormal
+  # ========================================================================= #
+  def enormal(
+      i            = '',
+      make_newline = false
+    )
+    e snormal(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.snormal('Hello world!')
+end # 

data/lib/colours/colour_methods/ssymlink.rb

@@ -0,0 +1,102 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/ssymlink.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.ssymlink
+  #
+  # Invocation example:
+  #   Colours.ssymlink('Hello world!')
+  # ========================================================================= #
+  def self.ssymlink(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end; self.instance_eval { alias sym  ssymlink } # === Colours.sym
+       self.instance_eval { alias ssym ssymlink } # === Colours.ssym
+
+  # ========================================================================= #
+  # === Colours.colour_for_symlinks
+  #
+  # This method will simply return the colour for symlinks.
+  # ========================================================================= #
+  def self.colour_for_symlinks
+    result = ''.dup
+    if @use_colours
+      if @use_html_colours
+        result = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[:ssymlink])
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        result = SupportFor256Colours.send(use_this_colour)
+      else
+        result = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"
+      end
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === ssymlink
+  #
+  # Note that a symlink called symlink() exists to this method, but it
+  # is not exactly clear whether this alias will be kept, as it may
+  # interfere with some other methods when we do an include-action.
+  # ========================================================================= #
+  def ssymlink(i = '')
+    ::Colours.ssymlink(i)
+  end; alias symlink ssymlink # === symlink
+       alias ssym    ssymlink # === ssym
+       alias slink   ssymlink # === slink
+
+  # ========================================================================= #
+  # === Colours.esymlink
+  # ========================================================================= #
+  def self.esymlink(
+      i            = '',
+      make_newline = false
+    )
+    e Colours.ssymlink(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === esymlink
+  # ========================================================================= #
+  def esymlink(
+      i            = '',
+      make_newline = false
+    )
+    Colours.esymlink(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.ssymlink('Hello world!')
+end

data/lib/colours/colour_methods/swarn.rb

@@ -0,0 +1,76 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'colours/colour_methods/swarn.rb'
+# =========================================================================== #
+require 'colours/revert/revert.rb'
+require 'colours/colour_table/colour_table.rb'
+require 'colours/toplevel_methods/use_colours.rb'
+require 'colours/toplevel_methods/prefer_this_colour_schemata.rb'
+require 'colours/autogenerated/support_for_html_colours.rb'
+
+module Colours
+
+  # ========================================================================= #
+  # === Colours.swarn
+  #
+  # Invocation example:
+  #   Colours.swarn('Hello world!')
+  # ========================================================================= #
+  def self.swarn(
+      i            = '',
+      make_newline = false
+    )
+    if @use_colours
+      if @use_html_colours
+        i = SupportForHTMLColours.send(
+          map_this_symbol_to_that_html_colour(@colour_table[__method__.to_sym]), i
+        )
+      elsif @use_256_colours
+        use_this_colour = map_this_symbol_to_that_256_colour(@colour_table[__method__.to_sym])
+        i = SupportFor256Colours.send(use_this_colour, i)
+      else
+        i = "#{corresponding_colour?(@colour_table[__method__.to_sym])}"\
+            "#{i}"\
+            "#{rev}"
+      end
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === swarn
+  # ========================================================================= #
+  def swarn(
+      i            = '',
+      make_newline = false
+    )
+    Colours.swarn(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === Colours.ewarn
+  # ========================================================================= #
+  def self.ewarn(
+      i            = '',
+      make_newline = false
+    )
+    e swarn(i, make_newline)
+  end
+
+  # ========================================================================= #
+  # === ewarn
+  # ========================================================================= #
+  def ewarn(
+      i            = '',
+      make_newline = false
+    )
+    Colours.ewarn(i, make_newline)
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Colours.swarn('Hello world!')
+end

data/lib/colours/colour_table/README.md

@@ -0,0 +1,3 @@
+This directory will contain code for the colour-table, that
+is a table that maps from e. g. sfancy() to the corresponding
+colour at hand.