bsod 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ee3f47fca59ed812c893b1782ccaec0220ed3e6c
-  data.tar.gz: 54bb24834166e361b54b27af9e78a6baede5ca5d
+  metadata.gz: f56d2e58602a897f414aaadab80f80e9f7bca4cd
+  data.tar.gz: 3f0fd0d0bb317de06ba43d8e3e55f6a0ebf67154
 SHA512:
-  metadata.gz: b019f93776d8cbcf56ffeb22a3995d26330ec3c817a8dfdf166910a7056db45da6f4933250eaa0061bd59da39a230215c20fb2929d59bcebec2bb18acc0d5c7f
-  data.tar.gz: c1f89d815ec11d12c5725d168a1ac63a53592d9cdbd830cb8707e883011638d6252abe71ebccbcf23eb81aa158515de7d3d6bab43f77a7d7323277168afd0f0c
+  metadata.gz: b2f7b96d7cb7bdd0645c6f4a54774ce027a533860de20d987d9dbadc6afa16db27962df2e92f2bc4b0f8d69db15874e651b75a6ef355150e6aea84ce27524b32
+  data.tar.gz: 0fe0d86c1419ddedcdbc0ce903d7d423eaba2a477e1571754c7a182ea3131fa97150726c5d0e7e2409f80986401179c19bc0bab0e2ee6d84ad78e4817e5e37f9

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 <!-- My awesome changelog -->
 
+## 1.1.0 (Oct 30, 2013)
+
+* Can show BSODs on terminals via Curses stdlib.
+
 ## 1.0.0 (Oct 20, 2013)
 
 * Changed library API and executable commandline flags.

data/README.md

@@ -2,14 +2,14 @@
 
 ![bsod](images/bsod.png)
 
-Simulates [Blue Screens of Death](https://en.wikipedia.org/wiki/Blue_screen_of_death) from
-several systems, primarily Micro$oftWindow$. It's made in a way that eases
-adding new BSODs.
+Simulates [Blue Screens of Death](https://en.wikipedia.org/wiki/Blue_screen_of_death)
+from several systems, primarily Micro$oftWindow$.
+Shows BSODs both on graphical displays (via SDL) and terminal windows (via Curses).
 
 As an executable, has optional flag to sleep before BSODing so you can surprise
 your friends!
 
-As a library, you can integrate a BSOD on any SDL surface.
+As a library, you can integrate a BSOD on any SDL surface or Curses window.
 
 ## Usage
 
@@ -19,11 +19,14 @@ As a library, you can integrate a BSOD on any SDL surface.
     $ bsod --wait 3.1415       # waits seconds before BSODing
     $ bsod --style windowsxp   # explicitly selects BSOD style
     $ bsod --list              # show supported systems
+    $ bsod --style linux-sparc --curses # show on the terminal
 
 For more see `bsod --help`.
 
 ### Library
 
+Over SDL
+
     require 'bsod'
     # after initializing sdl properly
     screen = SDL::Screen.get
@@ -31,6 +34,14 @@ For more see `bsod --help`.
     bsod.draw(screen, screen.w, screen.h)
     BSOD::wait_for_sdl_key # defaults to F8
 
+Over Curses
+
+    require 'bsod'
+    # after initializing curses properly
+    bsod = BSOD::LinuxSPARC.new
+    bsod.draw_curses(Curses.stdscr, Curses.cols, Curses.lines)
+    BSOD::wait_for_curses_key # defaults to F8
+
 ## Install
 
     $ gem install bsod

data/bin/bsod

@@ -25,7 +25,7 @@ $settings = nil
 # Note: This initializes `SDL` based on the global
 #       `$settings` parsed by `Settings` module.
 #
-def self.init_sdl
+def init_sdl
   SDL::init(SDL::INIT_VIDEO)
   SDL::TTF.init
 
@@ -51,6 +51,26 @@ def self.init_sdl
   return screen
 end
 
+# Starts all things related to the `Curses` terminal-handling
+# thingy, returning the main window.
+#
+# Note: This method is only required if you don't do
+#       this manually. For most of your custom projects,
+#       ignore this.
+def init_curses
+  Curses::init_screen        # all hail Curses
+  Curses::curs_set 0         # invisible cursor
+  Curses::start_color        # dem colors
+  Curses::stdscr.keypad true # extra keys!
+  Curses::noecho             # wont show keys typed by the user
+
+  return Curses::stdscr      # main window
+end
+
+def exit_curses
+  Curses::close_screen
+end
+
 begin
   $settings = Settings.new
   $settings.parse ARGV
@@ -59,7 +79,11 @@ begin
   time = $settings[:sleep_time]
   sleep time if time
 
-  screen = init_sdl
+  if not BSOD::ALL.include? $settings[:bsod_type]
+    puts "Unknown BSOD '#{$settings[:bsod_type]}'."
+    puts "Use --list to show all known types."
+    exit 666
+  end
 
   bsod = nil
   case $settings[:bsod_type]
@@ -69,9 +93,21 @@ begin
   when "linux-sparc" then bsod = BSOD::LinuxSPARC.new
   end
 
-  bsod.draw(screen, screen.w, screen.h)
-  BSOD::wait_for_sdl_key $settings[:exit_key]
+  if $settings[:curses]
+    window = init_curses
+
+    bsod.draw_curses(window, Curses.cols, Curses.lines)
+    BSOD::wait_for_curses_key $settings[:exit_key]
+  else
+    screen = init_sdl
+
+    bsod.draw(screen, screen.w, screen.h)
+    BSOD::wait_for_sdl_key $settings[:exit_key]
+  end
 
   # It automatically ends SDL on exit
+  #
+  # ...but not Curses
+  exit_curses if $settings[:curses]
 end
 

data/lib/bsod.rb

@@ -1,5 +1,5 @@
-
 require 'sdl'
+require 'curses'
 
 # This is a great container over all Blue Screens
 # of Death (BSOD).
@@ -9,6 +9,11 @@ require 'sdl'
 #
 module BSOD
 
+  # All currently supported BSODs.
+  ALL = ["windowsnt",
+         "windows2000",
+         "windowsxp",
+         "linux-sparc"]
 
   # Tells if SDL has been initialized already, both
   # by us (`init_sdl`) or by the user.
@@ -45,8 +50,29 @@ module BSOD
     end
   end
 
-  def self.init_curses
+  # TODO Figure out how to actually see if Curses is initialized.
+  def self.curses_inited?
+    return true
+  end
 
+  # Waits for a keypress of `Curses::Key` `key`, ignoring
+  # anything else.
+  #
+  # Defaults to F8.
+  #
+  # TODO Somehow mix this with `wait_for_sdl_key`.
+  def self.wait_for_curses_key(key=Curses::KEY_F8)
+    loop = true
+    while loop
+
+      case Curses::getch
+      when key
+        loop = false
+      end
+      # Sleeping a little to avoid high-CPU rates.
+      sleep 0.05
+    end
   end
+
 end
 

data/lib/bsod/linux-sparc.rb

@@ -1,12 +1,12 @@
-
 require 'bsod'
 
 module BSOD
 
-  # Remember Window$ 2000?
+  # Linux sparc kernel paging fault.
   #
-  # This is the same as WindowsNT, the only thing that
-  # changes is the default message.
+  # TODO Somehow merge with WindowsText, because it follows the
+  #      same drawing rules (except that it's a white over black
+  #      text and it's shown on the bottom of the screen).
   class LinuxSPARC
 
     BSODTEXT = <<END_OF_TEXT
@@ -39,8 +39,7 @@ END_OF_TEXT
     # is acceptable too.
     def draw(screen, width, height)
 
-      # Should I break the program's flow here?
-      BSOD::init_sdl if not BSOD::sdl_inited?
+      return if not BSOD::sdl_inited?
 
       black = screen.format.map_rgb(0, 0, 0)
       screen.fill_rect(0, 0, width, height, black)
@@ -73,6 +72,39 @@ END_OF_TEXT
       # @note Maybe update only the bounded rectangle?
       SDL::Screen.get.update_rect(0, 0, 0, 0)
     end
+
+    # Draws the BSOD on a Curses' `window`, bounded by `width` and
+    # `height`.
+    def draw_curses(window, width, height)
+
+      return if not BSOD::curses_inited?
+
+      # Initializing colors (3 is any number)
+      Curses::init_pair(3, Curses::COLOR_WHITE, Curses::COLOR_BLACK)
+
+      window.attrset(Curses::color_pair(3) | Curses::A_BOLD)
+
+      # Clears the screen with spaces
+      0.upto(height) { window.addstr(" " * width) }
+
+      # need to print at the bottom of the screen
+      lines_ammount = height
+
+      i = (lines_ammount - BSODTEXT.lines.size)
+      BSODTEXT.each_line do |line|
+        # This is a little hack to allow printing empty lines.
+        # First I remove the '\n' at the end to avoid nasty things
+        # and then I append a space, to prevent nil strings.
+        line.chomp!
+        line += " "
+
+        window.setpos(i, 0)
+        window.addstr line
+
+        i += 1
+      end
+    end
+
   end
 end
 

data/lib/bsod/settings.rb

@@ -1,5 +1,5 @@
-
 require 'optparse'
+require 'bsod'
 require 'bsod/version'
 
 # Global configurations of the program, along with a commandline
@@ -15,13 +15,13 @@ class Settings
     # Makes possible to sleep for a while before BSODing
     @settings[:sleep_time] = nil
 
-    # Which BSOD we'll show by default?
-    @settings[:bsod_type] = "windowsnt"
+    # Default BSOD
+    @settings[:bsod_type] = BSOD::ALL.first
 
     # This doesn't matter because it will go fullscreen anyways.
     # Just change it if looks ugly
-    @settings[:width]  = 800
-    @settings[:height] = 600
+    @settings[:width]      = 800
+    @settings[:height]     = 600
     @settings[:fullscreen] = true
 
     # SDL-specific key to exit BSOD
@@ -35,6 +35,11 @@ class Settings
     @settings[:font_filename] = fontname
     @settings[:font_size] = 14
     @settings[:font_bold] = false
+
+    # Curses mode for consoles!
+    # Most of the settings above won't make any sense if this
+    # is true
+    @settings[:curses] = false
   end
 
   # Sets options based on commandline arguments `args`.
@@ -62,18 +67,16 @@ class Settings
         @settings[:fullscreen] = f
       end
 
+      parser.on("-c", "--[no-]curses", "Runs on the terminal, without a graphical window") do |f|
+        @settings[:curses] = f
+      end
+
       # parser.on("-r", "--random", "Select a random BSOD") do
       # DO SOMETHING ABOUT IT
       # end
 
       parser.on("-l", "--list", "Show all possible BSODs") do
-        puts "Usage: bsod -t [type]"
-        puts "       where [type] can be:"
-        puts
-        puts "windowsnt [default]"
-        puts "windows2000"
-        puts "windowsxp"
-        puts "linux-sparc"
+        self.show_list
         exit
       end
 
@@ -84,7 +87,23 @@ class Settings
       end
 
       parser.on("--version", "Show version and license info") do
-        puts <<END_OF_VERSION
+        self.show_version
+        exit
+      end
+
+    end
+    opts.parse! args
+
+    return @settings
+  end
+
+  # Returns a specific setting previously set.
+  def [] name
+    return @settings[name]
+  end
+
+  def show_version
+    puts <<END_OF_VERSION
  _   __  _   _
 |_) (_  / \\ | \\
 |_) __) \\_/ |_/ #{BSOD::VERSION}  (http://alexdantas.net/projects/bsod)
@@ -106,18 +125,23 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 The Droid Sans font family is licensed under the Apache license.
 END_OF_VERSION
-        exit
+  end
+
+  def show_list
+    puts "Usage: bsod -t [type]"
+    puts "       where [type] can be:"
+    puts
+
+    # Kinda ugly, right?
+    BSOD::ALL.each_with_index do |type, i|
+      if i == 0
+        puts "#{type} [default]"
+        next
       end
 
+      puts "#{type}"
     end
-    opts.parse! args
-
-    return @settings
   end
 
-  # Returns a specific setting previously set.
-  def [] name
-    return @settings[name]
-  end
 end
 

data/lib/bsod/version.rb

@@ -1,5 +1,5 @@
 
 module BSOD
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end
 

data/lib/bsod/windows2000.rb

@@ -1,14 +1,14 @@
 
-require 'bsod'
+require 'bsod/windowstext'
 
 module BSOD
 
   # Remember Window$ 2000?
   #
-  # This is the same as WindowsNT, the only thing that
-  # changes is the default message.
-  class Windows2000
+  # This contains the text, see WindowsText for drawing rules.
+  class Windows2000 < WindowsText
 
+    # The text that will appear over the blue background.
     BSODTEXT = <<END_OF_TEXT
 A problem has been detected and windows has been shut down to prevent damage
 to your computer.
@@ -41,47 +41,6 @@ Contact your system administrator or technical support group for further
 assistance.
 END_OF_TEXT
 
-    # No `def initialize` on purpose
-
-    # Draws the BSOD on a SDL's `screen`, bounded by `width` and
-    # `height`.
-    #
-    # It must be a `SDL::Surface` (consequently, a `SDL::Screen`
-    # is acceptable too.
-    def draw(screen, width, height)
-
-      # Should I break the program's flow here?
-      BSOD::init_sdl if not BSOD::sdl_inited?
-
-      # Filling screen with that sweet, sweet blue tone
-      blue = screen.format.map_rgb(0, 0, 255)
-      screen.fill_rect(0, 0, width, height, blue)
-
-      # Printing that bizarre text
-      font = SDL::TTF.open($settings[:font_filename],
-                           $settings[:font_size])
-
-      font.style = SDL::TTF::STYLE_BOLD if $settings[:font_bold]
-
-      i = 0
-      BSODTEXT.each_line do |line|
-        # This is a little hack to allow printing empty lines.
-        # First I remove the '\n' at the end to avoid nasty things
-        # and then I append a space, to prevent nil strings.
-        line.chomp!
-        line += " "
-
-        font.draw_solid_utf8(screen, line,
-                             3, (i * font.height),
-                             255, 255, 255)
-        i += 1
-      end
-
-      font.close
-
-      # @note Maybe update only the bounded rectangle?
-      SDL::Screen.get.update_rect(0, 0, 0, 0)
-    end
   end
 end
 

data/lib/bsod/windowsnt.rb

@@ -1,10 +1,9 @@
-
-require 'bsod'
+require 'bsod/windowstext'
 
 module BSOD
 
   # Ye olde Window$ NT.
-  class WindowsNT
+  class WindowsNT < WindowsText
 
     # The default white text that will appear over the
     # blue background.
@@ -38,47 +37,6 @@ or the /CRASHDEBUG system start option. If this message reappears,
 contact your system administrator or technical support group.
 END_OF_TEXT
 
-    # No `def initialize` on purpose
-
-    # Draws the BSOD on a SDL's `screen`, bounded by `width` and
-    # `height`.
-    #
-    # It must be a `SDL::Surface` (consequently, a `SDL::Screen`
-    # is acceptable too.
-    def draw(screen, width, height)
-
-      # Should I break the program's flow here?
-      BSOD::init_sdl if not BSOD::sdl_inited?
-
-      # Filling screen with that sweet, sweet blue tone
-      blue = screen.format.map_rgb(0, 0, 255)
-      screen.fill_rect(0, 0, width, height, blue)
-
-      # Printing that bizarre text
-      font = SDL::TTF.open($settings[:font_filename],
-                           $settings[:font_size])
-
-      font.style = SDL::TTF::STYLE_BOLD if $settings[:font_bold]
-
-      i = 0
-      BSODTEXT.each_line do |line|
-        # This is a little hack to allow printing empty lines.
-        # First I remove the '\n' at the end to avoid nasty things
-        # and then I append a space, to prevent nil strings.
-        line.chomp!
-        line += " "
-
-        font.draw_solid_utf8(screen, line,
-                             3, (i * font.height),
-                             255, 255, 255)
-        i += 1
-      end
-
-      font.close
-
-      # @note Maybe update only the bounded rectangle?
-      SDL::Screen.get.update_rect(0, 0, 0, 0)
-    end
   end
 end
 

data/lib/bsod/windowstext.rb

@@ -0,0 +1,99 @@
+require 'bsod'
+
+module BSOD
+
+  # Abstract class that encapsulates common stuff within
+  # some Windows BSODs.
+  #
+  # Some BSODs are simply a blue background with white text, while
+  # others follow more complex rules.
+  # For the simple ones, we inherit from WindowText.
+  #
+  # See WindowsNT, Windows2000 and WindowsXP
+  class WindowsText
+
+    # This is the text to be shown on the screen.
+    # On most subclasses, we simply change this - drawing rules
+    # are common.
+    #
+    # Side-note, referring to `self.class::CONSTANT` makes
+    # possible to override super class constants on subclasses.
+    BSODTEXT = <<END_OF_TEXT
+END_OF_TEXT
+
+    # Draws the BSOD on a SDL's `screen`, bounded by `width` and
+    # `height`.
+    #
+    # It must be a `SDL::Surface` (consequently, a `SDL::Screen`
+    # is acceptable too.
+    #
+    # It's a white text on a blue background.
+    def draw(screen, width, height)
+      return if not BSOD::sdl_inited?
+
+      # Filling screen with that sweet, sweet blue tone
+      blue = screen.format.map_rgb(0, 0, 255)
+      screen.fill_rect(0, 0, width, height, blue)
+
+      # Printing that bizarre text
+      font = SDL::TTF.open($settings[:font_filename],
+                           $settings[:font_size])
+
+      font.style = SDL::TTF::STYLE_BOLD if $settings[:font_bold]
+
+      i = 0
+      self.class::BSODTEXT.each_line do |line|
+        # This is a little hack to allow printing empty lines.
+        # First I remove the '\n' at the end to avoid nasty things
+        # and then I append a space, to prevent nil strings.
+        line.chomp!
+        line += " "
+
+        font.draw_solid_utf8(screen, line,
+                             3, (i * font.height),
+                             255, 255, 255)
+        i += 1
+      end
+
+      font.close
+
+      # @note Maybe update only the bounded rectangle?
+      SDL::Screen.get.update_rect(0, 0, 0, 0)
+    end
+
+    # Draws the BSOD on a Curses' `window`, bounded by `width` and
+    # `height`.
+    #
+    def draw_curses(window, width, height)
+      return if not BSOD::curses_inited?
+
+      # Initializing colors (3 is an arbitrary number)
+      Curses::init_pair(3, Curses::COLOR_WHITE, Curses::COLOR_BLUE)
+
+      window.attrset(Curses::color_pair(3) | Curses::A_BOLD)
+
+      # Clears the screen with spaces
+      0.upto(height) { window.addstr(" " * width) }
+
+      # need to print at the bottom of the screen
+      lines_ammount = height
+
+      i = (lines_ammount - self.class::BSODTEXT.lines.size)
+      self.class::BSODTEXT.each_line do |line|
+        # This is a little hack to allow printing empty lines.
+        # First I remove the '\n' at the end to avoid nasty things
+        # and then I append a space, to prevent nil strings.
+        line.chomp!
+        line += " "
+
+        window.setpos(i, 0)
+        window.addstr line
+
+        i += 1
+      end
+      window.refresh
+    end
+
+  end
+end
+

data/lib/bsod/windowsxp.rb

@@ -1,17 +1,14 @@
 
-require 'bsod'
-require 'bsod/windowsnt'
+require 'bsod/windowstext'
 
 module BSOD
 
   # As seen on Window$ XP.
   #
-  # This is the same as WindowsNT, the only thing that
-  # changes is the default message.
-  class WindowsXP
+  # This contains the text, see WindowsText for drawing rules.
+  class WindowsXP < WindowsText
 
-    # The default white text that will appear over the
-    # blue background.
+    # The text that will appear over the blue background.
     BSODTEXT = <<END_OF_TEXT
 A problem has been detected and windows has been shut down to prvent damage
 to your computer.
@@ -42,47 +39,6 @@ Technical information:
 *** SPCMDCON.SYS - Address FBFE7617 base at FBFE5000, DateStamp 3d6dd67c
 END_OF_TEXT
 
-    # No `def initialize` on purpose
-
-    # Draws the BSOD on a SDL's `screen`, bounded by `width` and
-    # `height`.
-    #
-    # It must be a `SDL::Surface` (consequently, a `SDL::Screen`
-    # is acceptable too.
-    def draw(screen, width, height)
-
-      # Should I break the program's flow here?
-      BSOD::init_sdl if not BSOD::sdl_inited?
-
-      # Filling screen with that sweet, sweet blue tone
-      blue = screen.format.map_rgb(0, 0, 255)
-      screen.fill_rect(0, 0, width, height, blue)
-
-      # Printing that bizarre text
-      font = SDL::TTF.open($settings[:font_filename],
-                           $settings[:font_size])
-
-      font.style = SDL::TTF::STYLE_BOLD if $settings[:font_bold]
-
-      i = 0
-      BSODTEXT.each_line do |line|
-        # This is a little hack to allow printing empty lines.
-        # First I remove the '\n' at the end to avoid nasty things
-        # and then I append a space, to prevent nil strings.
-        line.chomp!
-        line += " "
-
-        font.draw_solid_utf8(screen, line,
-                             3, (i * font.height),
-                             255, 255, 255)
-        i += 1
-      end
-
-      font.close
-
-      # @note Maybe update only the bounded rectangle?
-      SDL::Screen.get.update_rect(0, 0, 0, 0)
-    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bsod
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Alexandre Dantas
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-20 00:00:00.000000000 Z
+date: 2013-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -69,6 +69,7 @@ files:
 - lib/bsod/version.rb
 - lib/bsod/windows2000.rb
 - lib/bsod/windowsnt.rb
+- lib/bsod/windowstext.rb
 - lib/bsod/windowsxp.rb
 homepage: http://www.alexdantas.net/projects/bsod
 licenses: